Bundle loot-core types into the API

[twk3]

So we can have loot-core be the source of truth for some types that get passed through between the API and bundle

• Improves downstream development with API by including types (currently just the known return types are wired up)
• Include type output with custom tsconfig for loot-core for the API
  • build loot-core (server focused) types at the same time as the webpack bundle
  • currently copying over existing loot-core handwritten .d.ts files (we may want to rename these to .ts files, so we only pull in the ones the loot-core main.ts actually use)
• Use path aliases for dist vs dev tsconfigs
• Convert api index to typescript as example
• convert the send in mutators.ts to typescript to show mutators return types working
• Permit ts-ignore for issues with our version of typescript

Testing

• confirmed vscode was fine with package/api/index.ts (top level tsconfig alias working properly)
• typecheck and lint pass on clean checkout, but also after api is build and dist and @types is populated
• Ran a yarn build and yarn pack on the api, then installed into a test project (actual_mint_importer).
  • vscode giving the right typehints
  • didn't do any tsc linting from the test project

Future thoughts

tsconfig composite

I took a crack at turning on references and composite for the api, (and moving the tsconfig.dist.json in the api to be just tsconfig.dist.json), but this requires a lot more tuning of the tsconfig files (dropping the extends, fixing the rootDir, and fun with how includes and excludes combine). Wasn't worth it for this

[netlify]

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	d4e1688
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/65ab2619caf6750008d0ae0c
😎 Deploy Preview	https://deploy-preview-2053.demo.actualbudget.org/
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[github-actions]

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
10	5.08 MB	0%

Changeset

No files were changed

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/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/ButtonLink.js	379 B	0%
static/js/narrow.js	82.17 kB	0%
static/js/BalanceTooltip.js	6.07 kB	0%
static/js/FiltersMenu.js	28.92 kB	0%
static/js/wide.js	239.01 kB	0%
static/js/ReportRouter.js	1.95 MB	0%
static/js/index.js	2.63 MB	0%

[github-actions]

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
1	1.23 MB	0%

Changeset

File	Δ	Size
packages/api/methods.ts	🆕 +12.28 kB	0 B → 12.28 kB
packages/loot-core/src/shared/schedules.ts	📈 +182 B (+2.01%)	8.86 kB → 9.04 kB
packages/api/methods.js	🔥 -12.25 kB (-100%)	12.25 kB → 0 B

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.js	1.23 MB	0%

[MatissJanis]

👋 Overall I really like where this is going. Adding proper types to the api package would be amazing.

But I think we're not there yet with this PR. I looked through the output type definitions and they aren't yet pulling through the full type objects. Everything is typed as any.

For example: methods.getBudgetMonth. (red: current; green: what my expectation would have been)

- export function getBudgetMonth(month: any): any;
+ export function getBudgetMonth(month: string): {
+    month: unknown;
+    incomeAvailable: number;
+    lastMonthOverspent: number;
+    forNextMonth: number;
+    totalBudgeted: number;
+    toBudget: number;
+    fromLastMonth: number;
+    totalIncome: number;
+    totalSpent: number;
+    totalBalance: number;
+    categoryGroups: Record<string, unknown>[];
+  };

Is there anything we could do to pull in these full, rich types?

[twk3]

👋 Overall I really like where this is going. Adding proper types to the api package would be amazing.

But I think we're not there yet with this PR. I looked through the output type definitions and they aren't yet pulling through the full type objects. Everything is typed as any.

For example: methods.getBudgetMonth. (red: current; green: what my expectation would have been)

- export function getBudgetMonth(month: any): any;
+ export function getBudgetMonth(month: string): {
+    month: unknown;
+    incomeAvailable: number;
+    lastMonthOverspent: number;
+    forNextMonth: number;
+    totalBudgeted: number;
+    toBudget: number;
+    fromLastMonth: number;
+    totalIncome: number;
+    totalSpent: number;
+    totalBalance: number;
+    categoryGroups: Record<string, unknown>[];
+  };

Is there anything we could do to pull in these full, rich types?

@MatissJanis yep, they are in there now. Needed to bring the handlers types into the mutators and typescripting the send method. I had just initially done the index because it was smaller.

I've moved this back into WIP, as doing the mutators has shown that there is already some fixes needed in loot-core to get runHandler also passing around types. And that the api-handlers and server handlers types have diverged. (it's all working here in this MR, but I want to split those fixes into their own).

I also want to finish more of the mutator api tests before fully moving mutator.js to typescript. As it's hard to catch typescript errors for methods that are never called.

And I need to take a closer loot at the security finding from codeQL.

[MatissJanis]

Amazing! Thank you for all this work here. It's definitely a massive improvement!

Let me know if there's any way I could assist.

[twk3]

Split the loot-core fixes to #2136 which should be ready for review, and is useful in it's own right separate from the api.

[twk3]

@MatissJanis this is ready for another review. Just the already existing return types are wired up, so I've disabled strict for the methods.ts to keep this PR smaller. Will need a few followups to get into useful shape for folks using the api.

[MatissJanis]

Merged master into your branch to see if it still passes CI with strict mode enabled. Hope you don't mind.

[MatissJanis]

We seem to be missing something in the output.