[PR #7468] [MERGED] [AI] Fix type errors for API consumers by shipping .d.ts declarations #21550

Closed
opened 2026-04-14 22:08:44 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/7468
Author: @MatissJanis
Created: 4/11/2026
Status: Merged
Merged: 4/14/2026
Merged by: @MatissJanis

Base: masterHead: worktree-api-types


📝 Commits (10+)

  • bda838c [AI] Fix type errors for API consumers by shipping .d.ts declarations from loot-core
  • 6c72f71 [AI] Use prepack/postpack scripts instead of inflating package.json
  • f2f0a41 [AI] Convert prepack/postpack scripts to TypeScript
  • 27eef59 [AI] Add release notes for #7468
  • 27e4db5 [AI] Fix recursive ExportValue type and remove redundant comment
  • affc864 [AI] Rename scripts to .mts and inline types conditions
  • 158b573 [AI] Make backup/restore scripts safer
  • 7379a1c Merge branch 'master' into worktree-api-types
  • 2514fb5 [AI] Type api-handlers.ts fields to drop implicit any
  • dc094b0 [AI] Replace vite-plugin-dts with tsgo for api types

📊 Changes

19 files changed (+206 additions, -447 deletions)

View changed files

📝 .github/actions/docs-spelling/expect.txt (+1 -0)
📝 .github/workflows/build.yml (+1 -1)
📝 lage.config.js (+4 -2)
📝 package.json (+1 -1)
📝 packages/api/README.md (+4 -0)
📝 packages/api/app/query.js (+1 -1)
📝 packages/api/package.json (+1 -2)
📝 packages/api/vite.config.ts (+0 -6)
📝 packages/docs/docs/api/index.md (+14 -0)
📝 packages/loot-core/.gitignore (+2 -1)
📝 packages/loot-core/package.json (+15 -8)
packages/loot-core/scripts/add-types-conditions.mts (+93 -0)
packages/loot-core/scripts/restore-package-json.mts (+19 -0)
📝 packages/loot-core/src/server/api.ts (+5 -0)
📝 packages/loot-core/src/types/api-handlers.ts (+12 -19)
📝 packages/loot-core/tsconfig.json (+5 -3)
📝 tsconfig.json (+1 -1)
upcoming-release-notes/7468.md (+6 -0)
📝 yarn.lock (+21 -402)

📄 Description

Description

Adding a prepack and postpack script that runs before/after publishing the core package.

It adds the "types" field to the imports so that consumers could use that and wouldn't have strict type issues.

Not a great solution though.. but should work until loot-core is 100% strict TS.

Also cleaning up some things while I'm working at the changes to the core pkg publishing..

Fixes https://github.com/actualbudget/actual/issues/7410

Testing

n/a

Checklist

  • Release notes added (see link above)
  • No obvious regressions in affected areas
  • Self-review has been performed - I understand what each change in the code does and why it is needed

Bundle Stats

Bundle Files count Total bundle size % Changed
desktop-client 28 12.91 MB 0%
loot-core 1 4.84 MB 0%
api 1 3.88 MB → 3.88 MB (+7 B) +0.00%
cli 1 7.89 MB 0%
View detailed bundle stats

desktop-client

Total

Files count Total bundle size % Changed
28 12.91 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
static/js/index.js 3.32 MB 0%
static/js/BackgroundImage.js 121.09 kB 0%
static/js/FormulaEditor.js 852.77 kB 0%
static/js/ReportRouter.js 1.18 MB 0%
static/js/TransactionList.js 82.49 kB 0%
static/js/Value.js 4.33 MB 0%
static/js/ca.js 191.98 kB 0%
static/js/da.js 104.66 kB 0%
static/js/de.js 174.38 kB 0%
static/js/en-GB.js 8.2 kB 0%
static/js/en.js 175.89 kB 0%
static/js/es.js 181.8 kB 0%
static/js/extends.js 485.17 kB 0%
static/js/fr.js 177.08 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.46 kB 0%
static/js/it.js 165.95 kB 0%
static/js/narrow.js 363.02 kB 0%
static/js/nb-NO.js 151.85 kB 0%
static/js/nl.js 108.93 kB 0%
static/js/pl.js 88.34 kB 0%
static/js/pt-BR.js 177.44 kB 0%
static/js/resize-observer.js 18.06 kB 0%
static/js/th.js 179.3 kB 0%
static/js/theme.js 30.79 kB 0%
static/js/uk.js 212.6 kB 0%
static/js/wide.js 295 B 0%
static/js/workbox-window.prod.es5.js 7.33 kB 0%
static/js/zh-Hans.js 110.19 kB 0%

loot-core

Total

Files count Total bundle size % Changed
1 4.84 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
kcab.worker.DZcmk4OR.js 4.84 MB 0%

api

Total

Files count Total bundle size % Changed
1 3.88 MB → 3.88 MB (+7 B) +0.00%
Changeset
File Δ Size
app/query.js 📈 +7 B (+0.32%) 2.17 kB → 2.17 kB
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
index.js 3.88 MB → 3.88 MB (+7 B) +0.00%

Smaller
No assets were smaller

Unchanged
No assets were unchanged


cli

Total

Files count Total bundle size % Changed
1 7.89 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.89 MB 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/7468 **Author:** [@MatissJanis](https://github.com/MatissJanis) **Created:** 4/11/2026 **Status:** ✅ Merged **Merged:** 4/14/2026 **Merged by:** [@MatissJanis](https://github.com/MatissJanis) **Base:** `master` ← **Head:** `worktree-api-types` --- ### 📝 Commits (10+) - [`bda838c`](https://github.com/actualbudget/actual/commit/bda838c88a1c4494827671be931befe2ed395f0e) [AI] Fix type errors for API consumers by shipping .d.ts declarations from loot-core - [`6c72f71`](https://github.com/actualbudget/actual/commit/6c72f71b603597906dcabb75df4a8ca23e8e3471) [AI] Use prepack/postpack scripts instead of inflating package.json - [`f2f0a41`](https://github.com/actualbudget/actual/commit/f2f0a415d7a42dca3bf6f65b83b331c49bc3adcd) [AI] Convert prepack/postpack scripts to TypeScript - [`27eef59`](https://github.com/actualbudget/actual/commit/27eef594ea3d554469330f7e3b86d64d3763f071) [AI] Add release notes for #7468 - [`27e4db5`](https://github.com/actualbudget/actual/commit/27e4db5cf213a02dbf2ac9e28f63f11639ab9e5c) [AI] Fix recursive ExportValue type and remove redundant comment - [`affc864`](https://github.com/actualbudget/actual/commit/affc864759f14b6c48fbf0a1dc01f567d4725870) [AI] Rename scripts to .mts and inline types conditions - [`158b573`](https://github.com/actualbudget/actual/commit/158b57309061410d990b75040f134c54c1818534) [AI] Make backup/restore scripts safer - [`7379a1c`](https://github.com/actualbudget/actual/commit/7379a1cfc1b0d70bc2676b7cc187acd0e726f1a6) Merge branch 'master' into worktree-api-types - [`2514fb5`](https://github.com/actualbudget/actual/commit/2514fb5de6a42b67f207b90203e52192ca736c13) [AI] Type api-handlers.ts fields to drop implicit any - [`dc094b0`](https://github.com/actualbudget/actual/commit/dc094b01ff07407fee16a74f95dd0dcf63180de8) [AI] Replace vite-plugin-dts with tsgo for api types ### 📊 Changes **19 files changed** (+206 additions, -447 deletions) <details> <summary>View changed files</summary> 📝 `.github/actions/docs-spelling/expect.txt` (+1 -0) 📝 `.github/workflows/build.yml` (+1 -1) 📝 `lage.config.js` (+4 -2) 📝 `package.json` (+1 -1) 📝 `packages/api/README.md` (+4 -0) 📝 `packages/api/app/query.js` (+1 -1) 📝 `packages/api/package.json` (+1 -2) 📝 `packages/api/vite.config.ts` (+0 -6) 📝 `packages/docs/docs/api/index.md` (+14 -0) 📝 `packages/loot-core/.gitignore` (+2 -1) 📝 `packages/loot-core/package.json` (+15 -8) ➕ `packages/loot-core/scripts/add-types-conditions.mts` (+93 -0) ➕ `packages/loot-core/scripts/restore-package-json.mts` (+19 -0) 📝 `packages/loot-core/src/server/api.ts` (+5 -0) 📝 `packages/loot-core/src/types/api-handlers.ts` (+12 -19) 📝 `packages/loot-core/tsconfig.json` (+5 -3) 📝 `tsconfig.json` (+1 -1) ➕ `upcoming-release-notes/7468.md` (+6 -0) 📝 `yarn.lock` (+21 -402) </details> ### 📄 Description <!-- Thank you for submitting a pull request! Make sure to follow the instructions to write release notes for your PR — it should only take a minute or two: https://github.com/actualbudget/docs#writing-good-release-notes. Try running yarn generate:release-notes *before* pushing your PR for an interactive experience. --> ## Description <!-- What does this PR do? Why is it needed? Please give context on the "why?": why do we need this change? What problem is it solving for you?--> Adding a prepack and postpack script that runs before/after publishing the core package. It adds the "types" field to the imports so that consumers could use that and wouldn't have strict type issues. Not a _great_ solution though.. but should work until loot-core is 100% strict TS. Also cleaning up some things while I'm working at the changes to the core pkg publishing.. ## Related issue(s) <!-- e.g. Fixes #123, Relates to #456 --> Fixes https://github.com/actualbudget/actual/issues/7410 ## Testing <!-- What did you test? How can we reproduce the issue you are fixing or how can we test the feature you built? --> n/a ## Checklist - [x] Release notes added (see link above) - [x] No obvious regressions in affected areas - [x] Self-review has been performed - I understand what each change in the code does and why it is needed <!--- actual-bot-sections ---> <!--- bundlestats-action-comment key:combined start ---> ### Bundle Stats Bundle | Files count | Total bundle size | % Changed ------ | ----------- | ----------------- | --------- desktop-client | 28 | 12.91 MB | 0% loot-core | 1 | 4.84 MB | 0% api | 1 | 3.88 MB → 3.88 MB (+7 B) | +0.00% cli | 1 | 7.89 MB | 0% <details> <summary>View detailed bundle stats</summary> #### desktop-client **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 28 | 12.91 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 ----- | --------- | --------- static/js/index.js | 3.32 MB | 0% static/js/BackgroundImage.js | 121.09 kB | 0% static/js/FormulaEditor.js | 852.77 kB | 0% static/js/ReportRouter.js | 1.18 MB | 0% static/js/TransactionList.js | 82.49 kB | 0% static/js/Value.js | 4.33 MB | 0% static/js/ca.js | 191.98 kB | 0% static/js/da.js | 104.66 kB | 0% static/js/de.js | 174.38 kB | 0% static/js/en-GB.js | 8.2 kB | 0% static/js/en.js | 175.89 kB | 0% static/js/es.js | 181.8 kB | 0% static/js/extends.js | 485.17 kB | 0% static/js/fr.js | 177.08 kB | 0% static/js/indexeddb-main-thread-worker-e59fee74.js | 13.46 kB | 0% static/js/it.js | 165.95 kB | 0% static/js/narrow.js | 363.02 kB | 0% static/js/nb-NO.js | 151.85 kB | 0% static/js/nl.js | 108.93 kB | 0% static/js/pl.js | 88.34 kB | 0% static/js/pt-BR.js | 177.44 kB | 0% static/js/resize-observer.js | 18.06 kB | 0% static/js/th.js | 179.3 kB | 0% static/js/theme.js | 30.79 kB | 0% static/js/uk.js | 212.6 kB | 0% static/js/wide.js | 295 B | 0% static/js/workbox-window.prod.es5.js | 7.33 kB | 0% static/js/zh-Hans.js | 110.19 kB | 0% </div> </details> --- #### loot-core **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 4.84 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 ----- | --------- | --------- kcab.worker.DZcmk4OR.js | 4.84 MB | 0% </div> </details> --- #### api **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 3.88 MB → 3.88 MB (+7 B) | +0.00% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `app/query.js` | 📈 +7 B (+0.32%) | 2.17 kB → 2.17 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.88 MB → 3.88 MB (+7 B) | +0.00% **Smaller** No assets were smaller **Unchanged** No assets were unchanged </div> </details> --- #### cli **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 7.89 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.89 MB | 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-04-14 22:08:44 -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#21550