[PR #8013] [AI] Revive API token support (per-file API keys) #131660

Open
opened 2026-06-16 00:23:08 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/8013
Author: @wksantiago
Created: 5/31/2026
Status: 🔄 Open

Base: masterHead: revive-api-tokens


📝 Commits (6)

  • 83c22f5 [AI] Revive API token support (per-file API keys)
  • 31165ed Merge branch 'actualbudget:master' into revive-api-tokens
  • 365d0fc [AI] Use relative .md links in API token docs to fix docs build
  • 7171709 Merge branch 'actualbudget:master' into revive-api-tokens
  • b0eb25a Merge branch 'actualbudget:master' into revive-api-tokens
  • 8145535 Merge branch 'actualbudget:master' into revive-api-tokens

📊 Changes

41 files changed (+3374 additions, -341 deletions)

View changed files

📝 packages/api/index.ts (+9 -0)
📝 packages/desktop-client/src/components/Modals.tsx (+8 -0)
packages/desktop-client/src/components/settings/ApiTokens/CreateApiTokenModal.tsx (+231 -0)
packages/desktop-client/src/components/settings/ApiTokens/ShowApiTokenModal.tsx (+105 -0)
packages/desktop-client/src/components/settings/ApiTokens/TokenRow.tsx (+118 -0)
packages/desktop-client/src/components/settings/ApiTokens/index.tsx (+140 -0)
packages/desktop-client/src/components/settings/ApiTokens/utils.ts (+50 -0)
📝 packages/desktop-client/src/components/settings/Experimental.tsx (+3 -0)
📝 packages/desktop-client/src/components/settings/index.tsx (+3 -0)
📝 packages/desktop-client/src/hooks/useFeatureFlag.ts (+1 -0)
📝 packages/desktop-client/src/modals/modalsSlice.ts (+13 -0)
📝 packages/docs/docs-sidebar.js (+1 -0)
packages/docs/docs/api/api-tokens.md (+111 -0)
📝 packages/docs/docs/api/index.md (+3 -1)
📝 packages/docs/docs/settings/index.md (+37 -0)
📝 packages/loot-core/src/server/auth/app.ts (+155 -2)
📝 packages/loot-core/src/server/errors.ts (+54 -0)
📝 packages/loot-core/src/server/main.ts (+26 -1)
📝 packages/loot-core/src/types/prefs.ts (+2 -1)
packages/sync-server/migrations/1780320000000-create-api-tokens.js (+52 -0)

...and 21 more files

📄 Description

Description

This PR restores API token support for the sync server.
You can now generate individual tokens for each budget file, so external apps and scripts can connect securely without sharing your main server password.
Each token is scoped to a specific file, can be revoked or disabled at any time, supports expiration dates, and shows last usage — making access much safer and easier to manage.
Added a simple UI to create, disable, set expiration, and revoke tokens.

Checklist

  • Rebased on latest master (v26.6.0)
  • All tests passing: typecheck, lint, and 559 sync-server tests
  • Fully tested token CRUD in the UI (create, reveal, revoke, toggle, expiration)
  • Tested API checks: budget scoping + blocking revoked/disabled/expired tokens
  • Tokens are bcrypt-hashed, least-privilege scoped, and locked out of admin endpoints
  • Security review complete, all fixes applied
  • Follow-ups: prefix uniqueness + dedicated rate limiting

UI Screenshots

Selection_007 Selection_011 Selection_009 Selection_012

AI disclosure: I revived this from #6350, updated it using Claude, and then reviewed and tested it myself.


Bundle Stats

Bundle Files count Total bundle size % Changed
desktop-client 37 13.23 MB → 13.26 MB (+23.5 kB) +0.17%
loot-core 1 4.86 MB → 4.87 MB (+3.53 kB) +0.07%
api 2 3.87 MB → 3.87 MB (+3.79 kB) +0.10%
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 13.23 MB → 13.26 MB (+23.5 kB) +0.17%
Changeset
File Δ Size
src/components/settings/ApiTokens/TokenRow.tsx 🆕 +6.46 kB 0 B → 6.46 kB
src/components/settings/ApiTokens/CreateApiTokenModal.tsx 🆕 +6.27 kB 0 B → 6.27 kB
src/components/settings/ApiTokens/index.tsx 🆕 +5.09 kB 0 B → 5.09 kB
src/components/settings/ApiTokens/ShowApiTokenModal.tsx 🆕 +3.24 kB 0 B → 3.24 kB
src/components/settings/ApiTokens/utils.ts 🆕 +1.57 kB 0 B → 1.57 kB
src/components/settings/index.tsx 📈 +428 B (+3.84%) 10.87 kB → 11.29 kB
src/hooks/useFeatureFlag.ts 📈 +19 B (+3.19%) 596 B → 615 B
src/components/Modals.tsx 📈 +256 B (+1.93%) 12.97 kB → 13.22 kB
src/components/settings/Experimental.tsx 📈 +191 B (+1.60%) 11.65 kB → 11.84 kB
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 1.58 MB → 1.61 MB (+23.48 kB) +1.45%
static/js/Value.js 4.49 MB → 4.49 MB (+19 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 814.39 kB 0%
static/js/ManageRules.js 46.47 kB 0%
static/js/PayeeRuleCountLabel.js 7.1 kB 0%
static/js/ReportRouter.js 1.25 MB 0%
static/js/ScheduleEditForm.js 146.51 kB 0%
static/js/SchedulesTable.js 203.52 kB 0%
static/js/TransactionEdit.js 90.63 kB 0%
static/js/TransactionList.js 82.8 kB 0%
static/js/_baseIsEqual.js 76.76 kB 0%
static/js/ca.js 185.63 kB 0%
static/js/client.js 450.92 kB 0%
static/js/da.js 100.19 kB 0%
static/js/de.js 182.38 kB 0%
static/js/en-GB.js 9.25 kB 0%
static/js/en.js 202.14 kB 0%
static/js/es.js 177.58 kB 0%
static/js/extends.js 473.99 kB 0%
static/js/fr.js 177.35 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.46 kB 0%
static/js/it.js 163.93 kB 0%
static/js/narrow.js 364.55 kB 0%
static/js/nb-NO.js 147.07 kB 0%
static/js/nl.js 119.71 kB 0%
static/js/pt-BR.js 187.34 kB 0%
static/js/resize-observer.js 18.06 kB 0%
static/js/th.js 173.33 kB 0%
static/js/theme.js 31.01 kB 0%
static/js/toString.js 638.95 kB 0%
static/js/uk.js 216.7 kB 0%
static/js/useFormatList.js 2.52 kB 0%
static/js/useTransactionBatchActions.js 9.71 kB 0%
static/js/wide.js 298.23 kB 0%
static/js/workbox-window.prod.es5.js 7.33 kB 0%
static/js/zh-Hans.js 116.44 kB 0%

loot-core

Total

Files count Total bundle size % Changed
1 4.86 MB → 4.87 MB (+3.53 kB) +0.07%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/server/errors.ts 📈 +770 B (+40.31%) 1.87 kB → 2.62 kB
home/runner/work/actual/actual/packages/loot-core/src/server/auth/app.ts 📈 +2.47 kB (+39.81%) 6.19 kB → 8.66 kB
home/runner/work/actual/actual/packages/loot-core/src/server/main.ts 📈 +318 B (+6.70%) 4.63 kB → 4.94 kB
View detailed bundle breakdown

Added

Asset File Size % Changed
kcab.worker.93V-hDVB.js 0 B → 4.87 MB (+4.87 MB) -

Removed

Asset File Size % Changed
kcab.worker.DhLbg59B.js 4.86 MB → 0 B (-4.86 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.87 MB → 3.87 MB (+3.79 kB) +0.10%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/server/errors.ts 📈 +1.08 kB (+77.34%) 1.4 kB → 2.48 kB
home/runner/work/actual/actual/packages/loot-core/src/server/auth/app.ts 📈 +2.41 kB (+40.06%) 6.01 kB → 8.42 kB
home/runner/work/actual/actual/packages/loot-core/src/server/main.ts 📈 +313 B (+8.89%) 3.44 kB → 3.74 kB
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
index.js 3.87 MB → 3.87 MB (+3.79 kB) +0.10%

Smaller
No assets were smaller

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/8013 **Author:** [@wksantiago](https://github.com/wksantiago) **Created:** 5/31/2026 **Status:** 🔄 Open **Base:** `master` ← **Head:** `revive-api-tokens` --- ### 📝 Commits (6) - [`83c22f5`](https://github.com/actualbudget/actual/commit/83c22f5ffaf1d4a4e0789074029d03d1ce7b252c) [AI] Revive API token support (per-file API keys) - [`31165ed`](https://github.com/actualbudget/actual/commit/31165ed1de467fb3381a3a7a3ba54e8daf7c211f) Merge branch 'actualbudget:master' into revive-api-tokens - [`365d0fc`](https://github.com/actualbudget/actual/commit/365d0fc768ed3ce1b86229bc78a24ea37b4a3720) [AI] Use relative .md links in API token docs to fix docs build - [`7171709`](https://github.com/actualbudget/actual/commit/7171709578367c4f7ec0fa0aeac7557eee77a70b) Merge branch 'actualbudget:master' into revive-api-tokens - [`b0eb25a`](https://github.com/actualbudget/actual/commit/b0eb25a470a9a5d4af3e383ff08398890945e2b8) Merge branch 'actualbudget:master' into revive-api-tokens - [`8145535`](https://github.com/actualbudget/actual/commit/81455359b122c01440ca81b233228144325bae99) Merge branch 'actualbudget:master' into revive-api-tokens ### 📊 Changes **41 files changed** (+3374 additions, -341 deletions) <details> <summary>View changed files</summary> 📝 `packages/api/index.ts` (+9 -0) 📝 `packages/desktop-client/src/components/Modals.tsx` (+8 -0) ➕ `packages/desktop-client/src/components/settings/ApiTokens/CreateApiTokenModal.tsx` (+231 -0) ➕ `packages/desktop-client/src/components/settings/ApiTokens/ShowApiTokenModal.tsx` (+105 -0) ➕ `packages/desktop-client/src/components/settings/ApiTokens/TokenRow.tsx` (+118 -0) ➕ `packages/desktop-client/src/components/settings/ApiTokens/index.tsx` (+140 -0) ➕ `packages/desktop-client/src/components/settings/ApiTokens/utils.ts` (+50 -0) 📝 `packages/desktop-client/src/components/settings/Experimental.tsx` (+3 -0) 📝 `packages/desktop-client/src/components/settings/index.tsx` (+3 -0) 📝 `packages/desktop-client/src/hooks/useFeatureFlag.ts` (+1 -0) 📝 `packages/desktop-client/src/modals/modalsSlice.ts` (+13 -0) 📝 `packages/docs/docs-sidebar.js` (+1 -0) ➕ `packages/docs/docs/api/api-tokens.md` (+111 -0) 📝 `packages/docs/docs/api/index.md` (+3 -1) 📝 `packages/docs/docs/settings/index.md` (+37 -0) 📝 `packages/loot-core/src/server/auth/app.ts` (+155 -2) 📝 `packages/loot-core/src/server/errors.ts` (+54 -0) 📝 `packages/loot-core/src/server/main.ts` (+26 -1) 📝 `packages/loot-core/src/types/prefs.ts` (+2 -1) ➕ `packages/sync-server/migrations/1780320000000-create-api-tokens.js` (+52 -0) _...and 21 more files_ </details> ### 📄 Description ## Description This PR restores API token support for the sync server. You can now generate individual tokens for each budget file, so external apps and scripts can connect securely without sharing your main server password. Each token is scoped to a specific file, can be revoked or disabled at any time, supports expiration dates, and shows last usage — making access much safer and easier to manage. Added a simple UI to create, disable, set expiration, and revoke tokens. ## Checklist - [x] Rebased on latest master (v26.6.0) - [x] All tests passing: typecheck, lint, and 559 sync-server tests - [x] Fully tested token CRUD in the UI (create, reveal, revoke, toggle, expiration) - [x] Tested API checks: budget scoping + blocking revoked/disabled/expired tokens - [x] Tokens are bcrypt-hashed, least-privilege scoped, and locked out of admin endpoints - [x] Security review complete, all fixes applied - [ ] Follow-ups: prefix uniqueness + dedicated rate limiting ## UI Screenshots <img width="553" height="177" alt="Selection_007" src="https://github.com/user-attachments/assets/29d7f66e-39b2-4f8b-ad25-d2b908e1db1f" /> <img width="385" height="356" alt="Selection_011" src="https://github.com/user-attachments/assets/1e062e81-d189-40f6-9136-b8059ec00533" /> <img width="438" height="187" alt="Selection_009" src="https://github.com/user-attachments/assets/5b1c685a-a5dc-4355-adca-2f57b74991bb" /> <img width="525" height="231" alt="Selection_012" src="https://github.com/user-attachments/assets/ad76238a-eec9-41d1-99a6-d364b5fc0968" /> ## Related issues - Closes #8010 - Revives the original implementation from #6350 *AI disclosure: I revived this from #6350, updated it using Claude, and then reviewed and tested it myself.* <!--- actual-bot-sections ---> <hr /> <!--- bundlestats-action-comment key:combined start ---> ### Bundle Stats Bundle | Files count | Total bundle size | % Changed ------ | ----------- | ----------------- | --------- desktop-client | 37 | 13.23 MB → 13.26 MB (+23.5 kB) | +0.17% loot-core | 1 | 4.86 MB → 4.87 MB (+3.53 kB) | +0.07% api | 2 | 3.87 MB → 3.87 MB (+3.79 kB) | +0.10% 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 | 13.23 MB → 13.26 MB (+23.5 kB) | +0.17% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `src/components/settings/ApiTokens/TokenRow.tsx` | 🆕 +6.46 kB | 0 B → 6.46 kB `src/components/settings/ApiTokens/CreateApiTokenModal.tsx` | 🆕 +6.27 kB | 0 B → 6.27 kB `src/components/settings/ApiTokens/index.tsx` | 🆕 +5.09 kB | 0 B → 5.09 kB `src/components/settings/ApiTokens/ShowApiTokenModal.tsx` | 🆕 +3.24 kB | 0 B → 3.24 kB `src/components/settings/ApiTokens/utils.ts` | 🆕 +1.57 kB | 0 B → 1.57 kB `src/components/settings/index.tsx` | 📈 +428 B (+3.84%) | 10.87 kB → 11.29 kB `src/hooks/useFeatureFlag.ts` | 📈 +19 B (+3.19%) | 596 B → 615 B `src/components/Modals.tsx` | 📈 +256 B (+1.93%) | 12.97 kB → 13.22 kB `src/components/settings/Experimental.tsx` | 📈 +191 B (+1.60%) | 11.65 kB → 11.84 kB </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.58 MB → 1.61 MB (+23.48 kB) | +1.45% static/js/Value.js | 4.49 MB → 4.49 MB (+19 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 | 814.39 kB | 0% static/js/ManageRules.js | 46.47 kB | 0% static/js/PayeeRuleCountLabel.js | 7.1 kB | 0% static/js/ReportRouter.js | 1.25 MB | 0% static/js/ScheduleEditForm.js | 146.51 kB | 0% static/js/SchedulesTable.js | 203.52 kB | 0% static/js/TransactionEdit.js | 90.63 kB | 0% static/js/TransactionList.js | 82.8 kB | 0% static/js/_baseIsEqual.js | 76.76 kB | 0% static/js/ca.js | 185.63 kB | 0% static/js/client.js | 450.92 kB | 0% static/js/da.js | 100.19 kB | 0% static/js/de.js | 182.38 kB | 0% static/js/en-GB.js | 9.25 kB | 0% static/js/en.js | 202.14 kB | 0% static/js/es.js | 177.58 kB | 0% static/js/extends.js | 473.99 kB | 0% static/js/fr.js | 177.35 kB | 0% static/js/indexeddb-main-thread-worker-e59fee74.js | 13.46 kB | 0% static/js/it.js | 163.93 kB | 0% static/js/narrow.js | 364.55 kB | 0% static/js/nb-NO.js | 147.07 kB | 0% static/js/nl.js | 119.71 kB | 0% static/js/pt-BR.js | 187.34 kB | 0% static/js/resize-observer.js | 18.06 kB | 0% static/js/th.js | 173.33 kB | 0% static/js/theme.js | 31.01 kB | 0% static/js/toString.js | 638.95 kB | 0% static/js/uk.js | 216.7 kB | 0% static/js/useFormatList.js | 2.52 kB | 0% static/js/useTransactionBatchActions.js | 9.71 kB | 0% static/js/wide.js | 298.23 kB | 0% static/js/workbox-window.prod.es5.js | 7.33 kB | 0% static/js/zh-Hans.js | 116.44 kB | 0% </div> </details> --- #### loot-core **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 4.86 MB → 4.87 MB (+3.53 kB) | +0.07% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/loot-core/src/server/errors.ts` | 📈 +770 B (+40.31%) | 1.87 kB → 2.62 kB `home/runner/work/actual/actual/packages/loot-core/src/server/auth/app.ts` | 📈 +2.47 kB (+39.81%) | 6.19 kB → 8.66 kB `home/runner/work/actual/actual/packages/loot-core/src/server/main.ts` | 📈 +318 B (+6.70%) | 4.63 kB → 4.94 kB </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.93V-hDVB.js | 0 B → 4.87 MB (+4.87 MB) | - **Removed** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.DhLbg59B.js | 4.86 MB → 0 B (-4.86 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.87 MB → 3.87 MB (+3.79 kB) | +0.10% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/loot-core/src/server/errors.ts` | 📈 +1.08 kB (+77.34%) | 1.4 kB → 2.48 kB `home/runner/work/actual/actual/packages/loot-core/src/server/auth/app.ts` | 📈 +2.41 kB (+40.06%) | 6.01 kB → 8.42 kB `home/runner/work/actual/actual/packages/loot-core/src/server/main.ts` | 📈 +313 B (+8.89%) | 3.44 kB → 3.74 kB </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** Asset | File Size | % Changed ----- | --------- | --------- index.js | 3.87 MB → 3.87 MB (+3.79 kB) | +0.10% **Smaller** No assets were smaller **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:23:08 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#131660