github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-07-16 07:04:23 -05:00
Code Issues 3.0k Packages Projects Releases 58 Wiki Activity

[PR #8073] [CLOSED] [WIP] Plugin system - 02 - Plugin core contracts #131699

New Issue
Closed
opened 2026-06-16 00:26:26 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-06-16 00:26:26 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/8073
Author: @lelemm
Created: 6/4/2026
Status: ❌ Closed

Base: master ← Head: feat/plugin-stack-02-core-contracts

📝 Commits (2)

  • 7854524 [AI] Add shared plugin foundation packages
  • 07e5186 [AI] Add plugin core contracts

📊 Changes

79 files changed (+5132 additions, -605 deletions)

View changed files

📝 .gitignore (+9 -1)
📝 .oxlintrc.json (+26 -0)
📝 package.json (+1 -1)
📝 packages/desktop-client/package.json (+1 -0)
📝 packages/desktop-client/src/spreadsheet/index.ts (+15 -110)
📝 packages/desktop-client/tsconfig.json (+3 -0)
📝 packages/eslint-plugin-actual/lib/rules/no-untranslated-strings.js (+0 -3)
📝 packages/loot-core/package.json (+2 -0)
📝 packages/loot-core/src/shared/query.ts (+6 -176)
📝 packages/loot-core/src/types/models/account.ts (+4 -26)
📝 packages/loot-core/src/types/models/bank-sync.ts (+5 -8)
📝 packages/loot-core/src/types/models/category-group.ts (+1 -11)
📝 packages/loot-core/src/types/models/category.ts (+1 -14)
📝 packages/loot-core/src/types/models/payee.ts (+1 -10)
📝 packages/loot-core/src/types/models/rule.ts (+14 -181)
📝 packages/loot-core/src/types/models/schedule.ts (+6 -50)
📝 packages/loot-core/tsconfig.json (+5 -1)
➕ packages/plugins-core-sync-server/.gitignore (+8 -0)
➕ packages/plugins-core-sync-server/README.md (+213 -0)
➕ packages/plugins-core-sync-server/package.json (+31 -0)

...and 59 more files

📄 Description

Part 2 of the plugin/provider split.

This adds the core plugin contracts needed by later runtime work:

  • adds @actual-app/plugins-core
  • defines plugin manifest and entry contracts
  • defines host/plugin runtime context types
  • defines modal and custom page plugin contracts
  • defines bank sync provider setup/render contracts

This PR intentionally avoids sync-server runtime behavior, desktop runtime behavior, and bank sync provider behavior. It should be reviewable as plugin API/type contracts only.

Note:
We can start reviews on this PR before 01 is merged, just select the commit related to it:
image

Note 2: on this PR you will find a bunch of re-exports in plugins-core and plugins-core-sync-server.
They are intentional, so plugin authors don't need to reference a bunch of packages.
For frontend plugins reference plugins-core
For sync-server plugins reference plugins-core-sync-server

Bundle Stats

Bundle Files count Total bundle size % Changed
desktop-client 37 14.04 MB → 14.04 MB (+56 B) +0.00%
loot-core 1 5.28 MB → 5.28 MB (-11 B) -0.00%
api 2 3.86 MB → 3.86 MB (-11 B) -0.00%
cli 1 7.97 MB 0%
crdt 1 11.12 kB 0%
View detailed bundle stats

desktop-client

Total

Files count Total bundle size % Changed
37 14.04 MB → 14.04 MB (+56 B) +0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/query/src/query.ts 🆕 +2.66 kB 0 B → 2.66 kB
home/runner/work/actual/actual/packages/shared-types/src/spreadsheet.ts 🆕 +138 B 0 B → 138 B
node_modules/date-fns/isSameWeek.js 📈 +187 B (+14.01%) 1.3 kB → 1.49 kB
package.json 📈 +44 B (+0.46%) 9.39 kB → 9.43 kB
home/runner/work/actual/actual/packages/loot-core/src/shared/query.ts 🔥 -2.85 kB (-100%) 2.85 kB → 0 B
src/spreadsheet/index.ts 🔥 -115 B (-100%) 115 B → 0 B
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 1.55 MB → 1.55 MB (+44 B) +0.00%
static/js/Value.js 5.09 MB → 5.09 MB (+12 B) +0.00%

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
static/js/BackgroundImage.js 121.09 kB 0%
static/js/FormulaEditor.js 962.55 kB 0%
static/js/ManageRules.js 46.64 kB 0%
static/js/PayeeRuleCountLabel.js 7.33 kB 0%
static/js/ReportRouter.js 1.26 MB 0%
static/js/ScheduleEditForm.js 146.44 kB 0%
static/js/SchedulesTable.js 202.7 kB 0%
static/js/TransactionEdit.js 90.63 kB 0%
static/js/TransactionList.js 85.81 kB 0%
static/js/_baseIsEqual.js 98.38 kB 0%
static/js/ca.js 186.63 kB 0%
static/js/client.js 451.37 kB 0%
static/js/da.js 101.02 kB 0%
static/js/de.js 170.87 kB 0%
static/js/en-GB.js 9.25 kB 0%
static/js/en.js 199.23 kB 0%
static/js/es.js 178.57 kB 0%
static/js/extends.js 501.42 kB 0%
static/js/fr.js 178.44 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.46 kB 0%
static/js/it.js 164.87 kB 0%
static/js/narrow.js 364.5 kB 0%
static/js/nb-NO.js 147.94 kB 0%
static/js/nl.js 107 kB 0%
static/js/pt-BR.js 188.32 kB 0%
static/js/resize-observer.js 18.06 kB 0%
static/js/th.js 174.31 kB 0%
static/js/theme.js 31.88 kB 0%
static/js/toString.js 705.14 kB 0%
static/js/uk.js 207.3 kB 0%
static/js/useFormatList.js 2.52 kB 0%
static/js/useTransactionBatchActions.js 9.71 kB 0%
static/js/wide.js 299.14 kB 0%
static/js/workbox-window.prod.es5.js 7.33 kB 0%
static/js/zh-Hans.js 117.01 kB 0%

loot-core

Total

Files count Total bundle size % Changed
1 5.28 MB → 5.28 MB (-11 B) -0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/query/src/query.ts 🆕 +2.36 kB 0 B → 2.36 kB
home/runner/work/actual/actual/packages/loot-core/src/shared/query.ts 🔥 -2.37 kB (-100%) 2.37 kB → 0 B
View detailed bundle breakdown

Added

Asset File Size % Changed
kcab.worker.CqWomB2j.js 0 B → 5.28 MB (+5.28 MB) -

Removed

Asset File Size % Changed
kcab.worker.DC4epP6P.js 5.28 MB → 0 B (-5.28 MB) -100%

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged
No assets were unchanged

api

Total

Files count Total bundle size % Changed
2 3.86 MB → 3.86 MB (-11 B) -0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/query/src/query.ts 🆕 +2.25 kB 0 B → 2.25 kB
home/runner/work/actual/actual/packages/loot-core/src/shared/query.ts 🔥 -2.26 kB (-100%) 2.26 kB ��� 0 B
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller

Asset File Size % Changed
index.js 3.86 MB → 3.86 MB (-11 B) -0.00%

Unchanged

Asset File Size % Changed
models.js 0 B 0%

cli

Total

Files count Total bundle size % Changed
1 7.97 MB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
cli.js 7.97 MB 0%

crdt

Total

Files count Total bundle size % Changed
1 11.12 kB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
index.js 11.12 kB 0%

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/8073 **Author:** [@lelemm](https://github.com/lelemm) **Created:** 6/4/2026 **Status:** ❌ Closed **Base:** `master` ← **Head:** `feat/plugin-stack-02-core-contracts` --- ### 📝 Commits (2) - [`7854524`](https://github.com/actualbudget/actual/commit/785452409272241f4fc45db1e6d9b9abc0ac845a) [AI] Add shared plugin foundation packages - [`07e5186`](https://github.com/actualbudget/actual/commit/07e51866b9be97d7978947a5c632a0dfe77ab1a2) [AI] Add plugin core contracts ### 📊 Changes **79 files changed** (+5132 additions, -605 deletions) <details> <summary>View changed files</summary> 📝 `.gitignore` (+9 -1) 📝 `.oxlintrc.json` (+26 -0) 📝 `package.json` (+1 -1) 📝 `packages/desktop-client/package.json` (+1 -0) 📝 `packages/desktop-client/src/spreadsheet/index.ts` (+15 -110) 📝 `packages/desktop-client/tsconfig.json` (+3 -0) 📝 `packages/eslint-plugin-actual/lib/rules/no-untranslated-strings.js` (+0 -3) 📝 `packages/loot-core/package.json` (+2 -0) 📝 `packages/loot-core/src/shared/query.ts` (+6 -176) 📝 `packages/loot-core/src/types/models/account.ts` (+4 -26) 📝 `packages/loot-core/src/types/models/bank-sync.ts` (+5 -8) 📝 `packages/loot-core/src/types/models/category-group.ts` (+1 -11) 📝 `packages/loot-core/src/types/models/category.ts` (+1 -14) 📝 `packages/loot-core/src/types/models/payee.ts` (+1 -10) 📝 `packages/loot-core/src/types/models/rule.ts` (+14 -181) 📝 `packages/loot-core/src/types/models/schedule.ts` (+6 -50) 📝 `packages/loot-core/tsconfig.json` (+5 -1) ➕ `packages/plugins-core-sync-server/.gitignore` (+8 -0) ➕ `packages/plugins-core-sync-server/README.md` (+213 -0) ➕ `packages/plugins-core-sync-server/package.json` (+31 -0) _...and 59 more files_ </details> ### 📄 Description Part 2 of the plugin/provider split. This adds the core plugin contracts needed by later runtime work: - adds `@actual-app/plugins-core` - defines plugin manifest and entry contracts - defines host/plugin runtime context types - defines modal and custom page plugin contracts - defines bank sync provider setup/render contracts This PR intentionally avoids sync-server runtime behavior, desktop runtime behavior, and bank sync provider behavior. It should be reviewable as plugin API/type contracts only. Note: We can start reviews on this PR before 01 is merged, just select the commit related to it: <img width="1224" height="812" alt="image" src="https://github.com/user-attachments/assets/0ad1a31c-fb24-4a6f-bc2b-ff77c701d4e3" /> Note 2: on this PR you will find a bunch of re-exports in plugins-core and plugins-core-sync-server. They are intentional, so plugin authors don't need to reference a bunch of packages. For frontend plugins reference plugins-core For sync-server plugins reference plugins-core-sync-server <!--- actual-bot-sections ---> <hr /> <!--- bundlestats-action-comment key:combined start ---> ### Bundle Stats Bundle | Files count | Total bundle size | % Changed ------ | ----------- | ----------------- | --------- desktop-client | 37 | 14.04 MB → 14.04 MB (+56 B) | +0.00% loot-core | 1 | 5.28 MB → 5.28 MB (-11 B) | -0.00% api | 2 | 3.86 MB → 3.86 MB (-11 B) | -0.00% cli | 1 | 7.97 MB | 0% crdt | 1 | 11.12 kB | 0% <details> <summary>View detailed bundle stats</summary> #### desktop-client **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 37 | 14.04 MB → 14.04 MB (+56 B) | +0.00% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/query/src/query.ts` | 🆕 +2.66 kB | 0 B → 2.66 kB `home/runner/work/actual/actual/packages/shared-types/src/spreadsheet.ts` | 🆕 +138 B | 0 B → 138 B `node_modules/date-fns/isSameWeek.js` | 📈 +187 B (+14.01%) | 1.3 kB → 1.49 kB `package.json` | 📈 +44 B (+0.46%) | 9.39 kB → 9.43 kB `home/runner/work/actual/actual/packages/loot-core/src/shared/query.ts` | 🔥 -2.85 kB (-100%) | 2.85 kB → 0 B `src/spreadsheet/index.ts` | 🔥 -115 B (-100%) | 115 B → 0 B </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** Asset | File Size | % Changed ----- | --------- | --------- static/js/index.js | 1.55 MB → 1.55 MB (+44 B) | +0.00% static/js/Value.js | 5.09 MB → 5.09 MB (+12 B) | +0.00% **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- static/js/BackgroundImage.js | 121.09 kB | 0% static/js/FormulaEditor.js | 962.55 kB | 0% static/js/ManageRules.js | 46.64 kB | 0% static/js/PayeeRuleCountLabel.js | 7.33 kB | 0% static/js/ReportRouter.js | 1.26 MB | 0% static/js/ScheduleEditForm.js | 146.44 kB | 0% static/js/SchedulesTable.js | 202.7 kB | 0% static/js/TransactionEdit.js | 90.63 kB | 0% static/js/TransactionList.js | 85.81 kB | 0% static/js/_baseIsEqual.js | 98.38 kB | 0% static/js/ca.js | 186.63 kB | 0% static/js/client.js | 451.37 kB | 0% static/js/da.js | 101.02 kB | 0% static/js/de.js | 170.87 kB | 0% static/js/en-GB.js | 9.25 kB | 0% static/js/en.js | 199.23 kB | 0% static/js/es.js | 178.57 kB | 0% static/js/extends.js | 501.42 kB | 0% static/js/fr.js | 178.44 kB | 0% static/js/indexeddb-main-thread-worker-e59fee74.js | 13.46 kB | 0% static/js/it.js | 164.87 kB | 0% static/js/narrow.js | 364.5 kB | 0% static/js/nb-NO.js | 147.94 kB | 0% static/js/nl.js | 107 kB | 0% static/js/pt-BR.js | 188.32 kB | 0% static/js/resize-observer.js | 18.06 kB | 0% static/js/th.js | 174.31 kB | 0% static/js/theme.js | 31.88 kB | 0% static/js/toString.js | 705.14 kB | 0% static/js/uk.js | 207.3 kB | 0% static/js/useFormatList.js | 2.52 kB | 0% static/js/useTransactionBatchActions.js | 9.71 kB | 0% static/js/wide.js | 299.14 kB | 0% static/js/workbox-window.prod.es5.js | 7.33 kB | 0% static/js/zh-Hans.js | 117.01 kB | 0% </div> </details> --- #### loot-core **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 5.28 MB → 5.28 MB (-11 B) | -0.00% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/query/src/query.ts` | 🆕 +2.36 kB | 0 B → 2.36 kB `home/runner/work/actual/actual/packages/loot-core/src/shared/query.ts` | 🔥 -2.37 kB (-100%) | 2.37 kB → 0 B </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.CqWomB2j.js | 0 B → 5.28 MB (+5.28 MB) | - **Removed** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.DC4epP6P.js | 5.28 MB → 0 B (-5.28 MB) | -100% **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** No assets were unchanged </div> </details> --- #### api **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 2 | 3.86 MB → 3.86 MB (-11 B) | -0.00% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/query/src/query.ts` | 🆕 +2.25 kB | 0 B → 2.25 kB `home/runner/work/actual/actual/packages/loot-core/src/shared/query.ts` | 🔥 -2.26 kB (-100%) | 2.26 kB ��� 0 B </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** Asset | File Size | % Changed ----- | --------- | --------- index.js | 3.86 MB → 3.86 MB (-11 B) | -0.00% **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- models.js | 0 B | 0% </div> </details> --- #### cli **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 7.97 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- cli.js | 7.97 MB | 0% </div> </details> --- #### crdt **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 11.12 kB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- index.js | 11.12 kB | 0% </div> </details> </details> <!--- bundlestats-action-comment key:combined end ---> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-06-16 00:26:27 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
AI generated
API
bank sync
budgeting
bug
can’t replicate
dependencies
docker
documentation
electron
experimental feature
feature
feedback
goal templates
good first issue
help wanted
importers
maintenance
needs info
needs testing
needs triage
needs votes
openid
payees
pull-request
Mirrored from GitHub Pull Request
 regression
reports
responsive
rules
schedules
server
✨ merged
split transactions
tech debt
tech-support
theme
transaction import
transaction reconciliation
transactions
translations
upstream
user interface
✅ approved
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#131699
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?