@actual-app/api 6.8.2 → 6.10.0

package/@types/loot-core/types/models/category.d.ts

@@ -1,8 +1,10 @@
+import { CategoryGroupEntity } from './category-group';
+
 export interface CategoryEntity {
-  id?: string;
+  id: string;
   name: string;
   is_income?: boolean;
-  cat_group?: string;
+  cat_group?: CategoryGroupEntity['id'];
   sort_order?: number;
   tombstone?: boolean;
   hidden?: boolean;

package/@types/loot-core/types/models/dashboard.d.ts

@@ -0,0 +1,56 @@
+import { type CustomReportEntity } from './reports';
+
+type AbstractWidget<
+  T extends string,
+  Meta extends Record<string, unknown> = null,
+> = {
+  id: string;
+  type: T;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  meta: Meta;
+  tombstone: boolean;
+};
+
+export type NetWorthWidget = AbstractWidget<
+  'net-worth-card',
+  { name?: string } | null
+>;
+export type CashFlowWidget = AbstractWidget<
+  'cash-flow-card',
+  { name?: string } | null
+>;
+export type SpendingWidget = AbstractWidget<
+  'spending-card',
+  { name?: string } | null
+>;
+export type CustomReportWidget = AbstractWidget<
+  'custom-report',
+  { id: string }
+>;
+
+type SpecializedWidget = NetWorthWidget | CashFlowWidget | SpendingWidget;
+export type Widget = SpecializedWidget | CustomReportWidget;
+export type NewWidget = Omit<Widget, 'id' | 'tombstone'>;
+
+// Exported/imported (json) widget definition
+export type ExportImportCustomReportWidget = Omit<
+  CustomReportWidget,
+  'id' | 'meta' | 'tombstone'
+> & {
+  meta: Omit<CustomReportEntity, 'tombstone'>;
+};
+export type ExportImportDashboardWidget = Omit<
+  ExportImportCustomReportWidget | SpecializedWidget,
+  'tombstone'
+>;
+
+export type ExportImportDashboard = {
+  // Dashboard exports can be versioned; currently we support
+  // only a single version, but lets account for multiple
+  // future versions
+  version: 1;
+  widgets: ExportImportDashboardWidget[];
+};

package/@types/loot-core/types/models/index.d.ts

@@ -1,6 +1,7 @@
 export type * from './account';
 export type * from './category';
 export type * from './category-group';
+export type * from './dashboard';
 export type * from './gocardless';
 export type * from './simplefin';
 export type * from './note';

package/@types/loot-core/types/models/payee.d.ts

@@ -1,10 +1,9 @@
-export interface NewPayeeEntity {
-  id?: string;
-  name: string;
-  transfer_acct?: string;
-  tombstone?: boolean;
-}
+import { AccountEntity } from './account';
 
-export interface PayeeEntity extends NewPayeeEntity {
+export interface PayeeEntity {
   id: string;
+  name: string;
+  transfer_acct?: AccountEntity['id'];
+  favorite?: boolean;
+  tombstone?: boolean;
 }

package/@types/loot-core/types/models/reports.d.ts

@@ -1,4 +1,3 @@
-import { CategoryEntity } from './category';
 import { type RuleConditionEntity } from './rule';
 
 export interface CustomReportEntity {
@@ -17,10 +16,9 @@ export interface CustomReportEntity {
   showHiddenCategories: boolean;
   includeCurrentInterval: boolean;
   showUncategorized: boolean;
-  selectedCategories?: CategoryEntity[];
   graphType: string;
   conditions?: RuleConditionEntity[];
-  conditionsOp: string;
+  conditionsOp: 'and' | 'or';
   data?: GroupedEntity;
   tombstone?: boolean;
 }
@@ -32,6 +30,14 @@ export type balanceTypeOpType =
   | 'netAssets'
   | 'netDebts';
 
+export type spendingReportTimeType =
+  | 'average'
+  | 'thisMonth'
+  | 'lastMonth'
+  | 'twoMonthsPrevious'
+  | 'lastYear'
+  | 'lastYearPrevious';
+
 export type SpendingMonthEntity = Record<
   string | number,
   {
@@ -57,7 +63,9 @@ export interface SpendingEntity {
     average: number;
     thisMonth: number;
     lastMonth: number;
+    twoMonthsPrevious: number;
     lastYear: number;
+    lastYearPrevious: number;
   }[];
   startDate?: string;
   endDate?: string;
@@ -130,10 +138,9 @@ export interface CustomReportData {
   show_hidden: number;
   include_current: number;
   show_uncategorized: number;
-  selected_categories?: CategoryEntity[];
   graph_type: string;
   conditions?: RuleConditionEntity[];
-  conditions_op: string;
+  conditions_op: 'and' | 'or';
   metadata?: GroupedEntity;
   interval: string;
   color_scheme?: string;

package/@types/loot-core/types/models/rule.d.ts

@@ -25,12 +25,29 @@ export type RuleConditionOp =
   | 'lte'
   | 'contains'
   | 'doesNotContain'
+  | 'hasTags'
   | 'matches';
 
-export interface RuleConditionEntity {
-  field?: string;
-  op?: RuleConditionOp;
-  value?: string | string[] | number | boolean;
+type FieldValueTypes = {
+  account: string;
+  amount: number;
+  category: string;
+  date: string;
+  notes: string;
+  payee: string;
+  imported_payee: string;
+  saved: string;
+};
+
+type BaseConditionEntity<
+  Field extends keyof FieldValueTypes,
+  Op extends RuleConditionOp,
+> = {
+  field: Field;
+  op: Op;
+  value: Op extends 'oneOf' | 'notOneOf'
+    ? Array<FieldValueTypes[Field]>
+    : FieldValueTypes[Field];
   options?: {
     inflow?: boolean;
     outflow?: boolean;
@@ -38,14 +55,80 @@ export interface RuleConditionEntity {
     year?: boolean;
   };
   conditionsOp?: string;
-  type?: string;
+  type?: 'id' | 'boolean' | 'date' | 'number';
   customName?: string;
-}
+};
+
+export type RuleConditionEntity =
+  | BaseConditionEntity<
+      'account',
+      | 'is'
+      | 'isNot'
+      | 'oneOf'
+      | 'notOneOf'
+      | 'contains'
+      | 'doesNotContain'
+      | 'matches'
+    >
+  | BaseConditionEntity<
+      'category',
+      | 'is'
+      | 'isNot'
+      | 'oneOf'
+      | 'notOneOf'
+      | 'contains'
+      | 'doesNotContain'
+      | 'matches'
+    >
+  | BaseConditionEntity<
+      'amount',
+      'is' | 'isapprox' | 'isbetween' | 'gt' | 'gte' | 'lt' | 'lte'
+    >
+  | BaseConditionEntity<
+      'date',
+      'is' | 'isapprox' | 'isbetween' | 'gt' | 'gte' | 'lt' | 'lte'
+    >
+  | BaseConditionEntity<
+      'notes',
+      | 'is'
+      | 'isNot'
+      | 'oneOf'
+      | 'notOneOf'
+      | 'contains'
+      | 'doesNotContain'
+      | 'matches'
+      | 'hasTags'
+    >
+  | BaseConditionEntity<
+      'payee',
+      | 'is'
+      | 'isNot'
+      | 'oneOf'
+      | 'notOneOf'
+      | 'contains'
+      | 'doesNotContain'
+      | 'matches'
+    >
+  | BaseConditionEntity<
+      'imported_payee',
+      | 'is'
+      | 'isNot'
+      | 'oneOf'
+      | 'notOneOf'
+      | 'contains'
+      | 'doesNotContain'
+      | 'matches'
+    >
+  | BaseConditionEntity<'saved', 'is'>
+  | BaseConditionEntity<'cleared', 'is'>
+  | BaseConditionEntity<'reconciled', 'is'>;
 
 export type RuleActionEntity =
   | SetRuleActionEntity
   | SetSplitAmountRuleActionEntity
-  | LinkScheduleRuleActionEntity;
+  | LinkScheduleRuleActionEntity
+  | PrependNoteRuleActionEntity
+  | AppendNoteRuleActionEntity;
 
 export interface SetRuleActionEntity {
   field: string;
@@ -70,3 +153,13 @@ export interface LinkScheduleRuleActionEntity {
   op: 'link-schedule';
   value: ScheduleEntity;
 }
+
+export interface PrependNoteRuleActionEntity {
+  op: 'prepend-notes';
+  value: string;
+}
+
+export interface AppendNoteRuleActionEntity {
+  op: 'append-notes';
+  value: string;
+}

package/@types/loot-core/types/models/transaction.d.ts

@@ -1,40 +1,27 @@
-import type { AccountEntity } from './account';
-import type { CategoryEntity } from './category';
-import type { PayeeEntity } from './payee';
-import type { ScheduleEntity } from './schedule';
+import { AccountEntity } from './account';
+import { CategoryEntity } from './category';
+import { PayeeEntity } from './payee';
+import { ScheduleEntity } from './schedule';
 
-export interface NewTransactionEntity {
-  id?: string;
+export interface TransactionEntity {
+  id: string;
   is_parent?: boolean;
   is_child?: boolean;
-  parent_id?: string;
-  account: string;
-  category?: string;
+  parent_id?: TransactionEntity['id'];
+  account: AccountEntity['id'];
+  category?: CategoryEntity['id'];
   amount: number;
-  payee?: string;
+  payee?: PayeeEntity['id'];
   notes?: string;
   date: string;
   imported_id?: string;
   imported_payee?: string;
   starting_balance_flag?: boolean;
-  transfer_id?: string;
+  transfer_id?: TransactionEntity['id'];
   sort_order?: number;
   cleared?: boolean;
   reconciled?: boolean;
   tombstone?: boolean;
-  schedule?: string;
-  subtransactions?: Omit<NewTransactionEntity, 'account' | 'date'>[];
-}
-
-export interface TransactionEntity
-  extends Omit<
-    NewTransactionEntity,
-    'account' | 'category' | 'payee' | 'schedule' | 'subtransactions'
-  > {
-  id: string;
-  account: AccountEntity;
-  category?: CategoryEntity;
-  payee?: PayeeEntity;
-  schedule?: ScheduleEntity;
+  schedule?: ScheduleEntity['id'];
   subtransactions?: TransactionEntity[];
 }

package/@types/loot-core/types/prefs.d.ts

@@ -1,13 +1,18 @@
 import { type numberFormats } from '../shared/util';
 
+import { spendingReportTimeType } from './models/reports';
+
 export type FeatureFlag =
+  | 'dashboards'
   | 'reportBudget'
   | 'goalTemplatesEnabled'
   | 'spendingReport'
-  | 'simpleFinSync'
-  | 'iterableTopologicalSort';
+  | 'simpleFinSync';
 
-export type LocalPrefs = Partial<
+/**
+ * Cross-device preferences. These sync across devices when they are changed.
+ */
+export type SyncedPrefs = Partial<
   {
     firstDayOfWeekIdx: `${0 | 1 | 2 | 3 | 4 | 5 | 6}`;
     dateFormat:
@@ -18,51 +23,70 @@ export type LocalPrefs = Partial<
       | 'dd.MM.yyyy';
     numberFormat: (typeof numberFormats)[number]['value'];
     hideFraction: boolean;
-    hideClosedAccounts: boolean;
-    hideMobileMessage: boolean;
     isPrivacyEnabled: boolean;
-    budgetName: string;
-    'ui.showClosedAccounts': boolean;
-    'expand-splits': boolean;
     [key: `show-extra-balances-${string}`]: boolean;
     [key: `hide-cleared-${string}`]: boolean;
     [key: `hide-reconciled-${string}`]: boolean;
-    'budget.collapsed': string[];
-    'budget.summaryCollapsed': boolean;
-    'budget.showHiddenCategories': boolean;
-    'budget.startMonth': string;
     // TODO: pull from src/components/modals/ImportTransactions.js
     [key: `parse-date-${string}-${'csv' | 'qif'}`]: string;
     [key: `csv-mappings-${string}`]: string;
     [key: `csv-delimiter-${string}`]: ',' | ';' | '\t';
+    [key: `csv-skip-lines-${string}`]: number;
     [key: `csv-has-header-${string}`]: boolean;
     [key: `ofx-fallback-missing-payee-${string}`]: boolean;
     [key: `flip-amount-${string}-${'csv' | 'qif'}`]: boolean;
-    'flags.updateNotificationShownForVersion': string;
-    id: string;
-    isCached: boolean;
-    lastUploaded: string;
-    cloudFileId: string;
-    groupId: string;
     budgetType: 'report' | 'rollover';
-    encryptKeyId: string;
-    lastSyncedTimestamp: string;
-    userId: string;
-    resetClock: boolean;
-    lastScheduleRun: string;
+  } & Record<`flags.${FeatureFlag}`, boolean>
+>;
+
+/**
+ * Preferences that are stored in the `metadata.json` file along with the
+ * core database.
+ */
+export type MetadataPrefs = Partial<{
+  budgetName: string;
+  id: string;
+  lastUploaded: string;
+  cloudFileId: string;
+  groupId: string;
+  encryptKeyId: string;
+  lastSyncedTimestamp: string;
+  resetClock: boolean;
+  lastScheduleRun: string;
+  userId: string; // TODO: delete this (unused)
+}>;
+
+/**
+ * Local preferences applicable to a single device. Stored in local storage.
+ * TODO: eventually `LocalPrefs` type should not use `SyncedPrefs` or `MetadataPrefs`;
+ * this is only a stop-gap solution.
+ */
+export type LocalPrefs = SyncedPrefs &
+  MetadataPrefs &
+  Partial<{
+    'ui.showClosedAccounts': boolean;
+    'expand-splits': boolean;
+    'budget.collapsed': string[];
+    'budget.summaryCollapsed': boolean;
+    'budget.showHiddenCategories': boolean;
+    'budget.startMonth': string;
+    'flags.updateNotificationShownForVersion': string;
     reportsViewLegend: boolean;
     reportsViewSummary: boolean;
     reportsViewLabel: boolean;
+    spendingReportFilter: string;
+    spendingReportTime: spendingReportTimeType;
+    spendingReportCompare: spendingReportTimeType;
+    sidebarWidth: number;
     'mobile.showSpentColumn': boolean;
-  } & Record<`flags.${FeatureFlag}`, boolean>
->;
+  }>;
 
 export type Theme = 'light' | 'dark' | 'auto' | 'midnight' | 'development';
 export type GlobalPrefs = Partial<{
   floatingSidebar: boolean;
   maxMonths: number;
-  autoUpdate: boolean;
   keyId?: string;
   theme: Theme;
   documentDir: string; // Electron only
+  serverSelfSignedCert: string; // Electron only
 }>;

package/@types/loot-core/types/server-handlers.d.ts

@@ -18,6 +18,7 @@ import {
   PayeeEntity,
 } from './models';
 import { GlobalPrefs, LocalPrefs } from './prefs';
+import { Query } from './query';
 import { EmptyObject } from './util';
 
 export interface ServerHandlers {
@@ -28,11 +29,8 @@ export interface ServerHandlers {
   redo: () => Promise<void>;
 
   'transactions-batch-update': (
-    arg: Omit<
-      Parameters<typeof batchUpdateTransactions>[0],
-      'detectOrphanPayees'
-    >,
-  ) => Promise<Awaited<ReturnType<typeof batchUpdateTransactions>>>;
+    ...arg: Parameters<typeof batchUpdateTransactions>
+  ) => ReturnType<typeof batchUpdateTransactions>;
 
   'transaction-add': (transaction) => Promise<EmptyObject>;
 
@@ -105,11 +103,13 @@ export interface ServerHandlers {
 
   'payee-create': (arg: { name }) => Promise<string>;
 
+  'common-payees-get': () => Promise<PayeeEntity[]>;
+
   'payees-get': () => Promise<PayeeEntity[]>;
 
   'payees-get-rule-counts': () => Promise<unknown>;
 
-  'payees-merge': (arg: { targetId; mergeIds }) => Promise<unknown>;
+  'payees-merge': (arg: { targetId; mergeIds }) => Promise<void>;
 
   'payees-batch-change': (arg: {
     added?;
@@ -138,7 +138,7 @@ export interface ServerHandlers {
 
   'create-query': (arg: { sheetName; name; query }) => Promise<unknown>;
 
-  query: (query) => Promise<{ data; dependencies }>;
+  query: (query: Query) => Promise<{ data: unknown; dependencies }>;
 
   'account-update': (arg: { id; name }) => Promise<unknown>;
 
@@ -222,10 +222,15 @@ export interface ServerHandlers {
     updatedAccounts;
   }>;
 
-  'transactions-import': (arg: { accountId; transactions }) => Promise<{
+  'transactions-import': (arg: {
+    accountId;
+    transactions;
+    isPreview;
+  }) => Promise<{
     errors?: { message: string }[];
     added;
     updated;
+    updatedPreview;
   }>;
 
   'account-unlink': (arg: { id }) => Promise<'ok'>;

package/@types/loot-core/types/util.d.ts

@@ -3,3 +3,7 @@ export type EmptyObject = Record<never, never>;
 export type StripNever<T> = {
   [K in keyof T as T[K] extends never ? never : K]: T[K];
 };
+
+export type EverythingButIdOptional<T> = { id: T['id'] } & Partial<
+  Omit<T, 'id'>
+>;

package/@types/methods.d.ts

@@ -4,6 +4,7 @@ export declare function loadBudget(budgetId: any): Promise<void>;
 export declare function downloadBudget(syncId: any, { password }?: {
     password?: any;
 }): Promise<void>;
+export declare function getBudgets(): Promise<import("./loot-core/server/api-models").APIFileEntity[]>;
 export declare function sync(): Promise<void>;
 export declare function runBankSync(args?: {
     accountId: string;
@@ -48,22 +49,14 @@ export declare function updateTransaction(id: any, fields: any): Promise<import(
     id: any;
     category: any;
 })[]>;
-export declare function deleteTransaction(id: any): Promise<import("./loot-core/types/models").TransactionEntity[] | ({
-    id: any;
-    transfer_id: any;
-} | {
-    id: any;
-    payee: any;
-} | {
-    id: any;
-    category: any;
-})[]>;
+export declare function deleteTransaction(id: any): Promise<any>;
 export declare function getAccounts(): Promise<import("./loot-core/server/api-models").APIAccountEntity[]>;
 export declare function createAccount(account: any, initialBalance?: any): Promise<string>;
 export declare function updateAccount(id: any, fields: any): Promise<void>;
 export declare function closeAccount(id: any, transferAccountId?: any, transferCategoryId?: any): Promise<unknown>;
 export declare function reopenAccount(id: any): Promise<unknown>;
 export declare function deleteAccount(id: any): Promise<unknown>;
+export declare function getAccountBalance(id: any, cutoff?: any): Promise<number>;
 export declare function getCategoryGroups(): Promise<import("./loot-core/server/api-models").APICategoryGroupEntity[]>;
 export declare function createCategoryGroup(group: any): Promise<string>;
 export declare function updateCategoryGroup(id: any, fields: any): Promise<unknown>;
@@ -74,12 +67,16 @@ export declare function updateCategory(id: any, fields: any): Promise<unknown>;
 export declare function deleteCategory(id: any, transferCategoryId?: any): Promise<{
     error?: string;
 }>;
+export declare function getCommonPayees(): Promise<import("./loot-core/server/api-models").APIPayeeEntity[]>;
 export declare function getPayees(): Promise<import("./loot-core/server/api-models").APIPayeeEntity[]>;
 export declare function createPayee(payee: any): Promise<string>;
 export declare function updatePayee(id: any, fields: any): Promise<unknown>;
 export declare function deletePayee(id: any): Promise<unknown>;
+export declare function mergePayees(targetId: any, mergeIds: any): Promise<void>;
 export declare function getRules(): Promise<import("./loot-core/types/models").RuleEntity[]>;
 export declare function getPayeeRules(id: any): Promise<import("./loot-core/types/models").RuleEntity[]>;
 export declare function createRule(rule: any): Promise<import("./loot-core/types/models").RuleEntity>;
 export declare function updateRule(rule: any): Promise<import("./loot-core/types/models").RuleEntity>;
-export declare function deleteRule(id: any): Promise<boolean>;
+export declare function deleteRule(id: string): Promise<boolean>;
+export declare function holdBudgetForNextMonth(month: any, amount: any): Promise<boolean>;
+export declare function resetBudgetHold(month: any): Promise<void>;

package/@types/migrations/1722717601000_reports_move_selected_categories.d.ts

@@ -0,0 +1 @@
+export default function runMigration(db: any): Promise<void>;

package/@types/migrations/1722804019000_create_dashboard_table.d.ts

@@ -0,0 +1 @@
+export default function runMigration(db: any): Promise<void>;