@actual-app/api 6.9.0 → 24.10.0

package/@types/jest.config.d.ts

@@ -1,9 +1,9 @@
-export const moduleFileExtensions: string[];
-export const testEnvironment: string;
-export const testPathIgnorePatterns: string[];
-export const watchPathIgnorePatterns: string[];
-export const setupFilesAfterEnv: string[];
-export const transformIgnorePatterns: string[];
-export const transform: {
+export let moduleFileExtensions: string[];
+export let testEnvironment: string;
+export let testPathIgnorePatterns: string[];
+export let watchPathIgnorePatterns: string[];
+export let setupFilesAfterEnv: string[];
+export let transformIgnorePatterns: string[];
+export let transform: {
     '^.+\\.(t|j)sx?$': string;
 };

package/@types/loot-core/client/constants.d.ts

@@ -22,6 +22,7 @@ export declare const COLLAPSE_MODALS = "COLLAPSE_MODALS";
 export declare const POP_MODAL = "POP_MODAL";
 export declare const ADD_NOTIFICATION = "ADD_NOTIFICATION";
 export declare const REMOVE_NOTIFICATION = "REMOVE_NOTIFICATION";
+export declare const SET_NOTIFICATION_INSET = "SET_NOTIFICATION_INSET";
 export declare const GET_USER_DATA = "GET_USER_DATA";
 export declare const SET_LAST_UNDO_STATE = "SET_LAST_UNDO_STATE";
 export declare const SET_LAST_SPLIT_STATE = "SET_LAST_SPLIT_STATE";

package/@types/loot-core/client/state-types/index.d.ts

@@ -36,6 +36,6 @@ export type State = {
 };
 
 declare module 'react-redux' {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions, @typescript-eslint/no-empty-interface
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/consistent-type-definitions
   export interface DefaultRootState extends State {}
 }

package/@types/loot-core/client/state-types/modals.d.ts

@@ -4,6 +4,7 @@ import type {
   CategoryEntity,
   CategoryGroupEntity,
   GoCardlessToken,
+  ScheduleEntity,
   TransactionEntity,
 } from '../../types/models';
 import type { NewRuleEntity, RuleEntity } from '../../types/models/rule';
@@ -38,7 +39,7 @@ type FinanceModals = {
   };
   'select-linked-accounts': {
     accounts: unknown[];
-    requisitionId: string;
+    requisitionId?: string;
     upgradingAccountId?: string;
     syncSource?: AccountSyncSource;
   };
@@ -53,7 +54,7 @@ type FinanceModals = {
   'manage-rules': { payeeId?: string };
   'edit-rule': {
     rule: RuleEntity | NewRuleEntity;
-    onSave: (rule: RuleEntity) => void;
+    onSave?: (rule: RuleEntity) => void;
   };
   'merge-unused-payees': {
     payeeIds: string[];
@@ -93,14 +94,17 @@ type FinanceModals = {
   };
 
   'edit-field': {
-    name: string;
-    month: string;
-    onSubmit: (name: string, value: string) => void;
-    onClose: () => void;
+    name: keyof Pick<TransactionEntity, 'date' | 'amount' | 'notes'>;
+    onSubmit: (
+      name: keyof Pick<TransactionEntity, 'date' | 'amount' | 'notes'>,
+      value: string | number,
+      mode?: 'prepend' | 'append' | 'replace' | null,
+    ) => void;
+    onClose?: () => void;
   };
 
   'category-autocomplete': {
-    categoryGroups: CategoryGroupEntity[];
+    categoryGroups?: CategoryGroupEntity[];
     onSelect: (categoryId: string, categoryName: string) => void;
     month?: string;
     showHiddenCategories?: boolean;
@@ -124,7 +128,14 @@ type FinanceModals = {
 
   'schedule-edit': { id: string; transaction?: TransactionEntity } | null;
 
-  'schedule-link': { transactionIds: string[] } | null;
+  'schedule-link': {
+    transactionIds: string[];
+    getTransaction: (
+      transactionId: TransactionEntity['id'],
+    ) => TransactionEntity;
+    accountName?: string;
+    onScheduleLinked?: (schedule: ScheduleEntity) => void;
+  };
 
   'schedules-discover': null;
 
@@ -146,7 +157,7 @@ type FinanceModals = {
     onBudgetAction: (month: string, action: string, args?: unknown) => void;
     onClose?: () => void;
   };
-  'rollover-budget-menu': {
+  'envelope-budget-menu': {
     categoryId: string;
     month: string;
     onUpdateBudget: (amount: number) => void;
@@ -154,7 +165,7 @@ type FinanceModals = {
     onSetMonthsAverage: (numberOfMonths: number) => void;
     onApplyBudgetTemplate: () => void;
   };
-  'report-budget-menu': {
+  'tracking-budget-menu': {
     categoryId: string;
     month: string;
     onUpdateBudget: (amount: number) => void;
@@ -176,8 +187,8 @@ type FinanceModals = {
     name: string;
     onSave: (id: string, notes: string) => void;
   };
-  'report-budget-summary': { month: string };
-  'rollover-budget-summary': {
+  'tracking-budget-summary': { month: string };
+  'envelope-budget-summary': {
     month: string;
     onBudgetAction: (
       month: string,
@@ -193,27 +204,28 @@ type FinanceModals = {
     onValidate?: (value: string) => string;
     onSubmit: (value: string) => Promise<void>;
   };
-  'rollover-balance-menu': {
+  'envelope-balance-menu': {
     categoryId: string;
     month: string;
     onCarryover: (carryover: boolean) => void;
     onTransfer: () => void;
     onCover: () => void;
   };
-  'rollover-summary-to-budget-menu': {
+  'envelope-summary-to-budget-menu': {
     month: string;
     onTransfer: () => void;
     onCover: () => void;
     onHoldBuffer: () => void;
     onResetHoldBuffer: () => void;
   };
-  'report-balance-menu': {
+  'tracking-balance-menu': {
     categoryId: string;
     month: string;
     onCarryover: (carryover: boolean) => void;
   };
   transfer: {
     title: string;
+    categoryId?: CategoryEntity['id'];
     month: string;
     amount: number;
     onSubmit: (amount: number, toCategoryId: string) => void;
@@ -221,6 +233,7 @@ type FinanceModals = {
   };
   cover: {
     title: string;
+    categoryId?: CategoryEntity['id'];
     month: string;
     showToBeBudgeted?: boolean;
     onSubmit: (fromCategoryId: string) => void;
@@ -239,12 +252,12 @@ type FinanceModals = {
     onToggleHiddenCategories: () => void;
     onSwitchBudgetFile: () => void;
   };
-  'rollover-budget-month-menu': {
+  'envelope-budget-month-menu': {
     month: string;
     onBudgetAction: (month: string, action: string, arg?: unknown) => void;
     onEditNotes: (month: string) => void;
   };
-  'report-budget-month-menu': {
+  'tracking-budget-month-menu': {
     month: string;
     onBudgetAction: (month: string, action: string, arg?: unknown) => void;
     onEditNotes: (month: string) => void;
@@ -256,8 +269,13 @@ type FinanceModals = {
     confirmReason: string;
   };
   'confirm-transaction-delete': {
+    message?: string;
     onConfirm: () => void;
   };
+  'confirm-unlink-account': {
+    accountName: string;
+    onUnlink: () => void;
+  };
 };
 
 export type PushModalAction = {

package/@types/loot-core/client/state-types/notifications.d.ts

@@ -21,6 +21,12 @@ type NotificationWithId = Notification & { id: string };
 
 export type NotificationsState = {
   notifications: NotificationWithId[];
+  inset?: {
+    bottom?: number;
+    top?: number;
+    right?: number;
+    left?: number;
+  };
 };
 
 type AddNotificationAction = {
@@ -33,6 +39,17 @@ type RemoveNotificationAction = {
   id: string;
 };
 
+type SetNotificationInsetAction = {
+  type: typeof constants.SET_NOTIFICATION_INSET;
+  inset: {
+    bottom?: number;
+    top?: number;
+    right?: number;
+    left?: number;
+  };
+};
+
 export type NotificationsActions =
   | AddNotificationAction
-  | RemoveNotificationAction;
+  | RemoveNotificationAction
+  | SetNotificationInsetAction;

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

@@ -1,20 +1,20 @@
-import type { LocalPrefs, GlobalPrefs } from '../../types/prefs';
+import type { GlobalPrefs, MetadataPrefs } from '../../types/prefs';
 import type * as constants from '../constants';
 
 export type PrefsState = {
-  local: LocalPrefs;
+  local: MetadataPrefs;
   global: GlobalPrefs;
 };
 
 export type SetPrefsAction = {
   type: typeof constants.SET_PREFS;
-  prefs: LocalPrefs;
+  prefs: MetadataPrefs;
   globalPrefs: GlobalPrefs;
 };
 
 export type MergeLocalPrefsAction = {
   type: typeof constants.MERGE_LOCAL_PREFS;
-  prefs: LocalPrefs;
+  prefs: MetadataPrefs;
 };
 
 export type MergeGlobalPrefsAction = {

package/@types/loot-core/client/state-types/queries.d.ts

@@ -3,8 +3,8 @@ import { type AccountEntity } from '../../types/models';
 import type * as constants from '../constants';
 
 export type QueriesState = {
-  newTransactions: unknown[];
-  matchedTransactions: unknown[];
+  newTransactions: string[];
+  matchedTransactions: string[];
   lastTransaction: unknown | null;
   updatedAccounts: string[];
   accounts: AccountEntity[];
@@ -20,8 +20,8 @@ export type QueriesState = {
 
 type SetNewTransactionsAction = {
   type: typeof constants.SET_NEW_TRANSACTIONS;
-  newTransactions?: unknown[];
-  matchedTransactions?: unknown[];
+  newTransactions?: string[];
+  matchedTransactions?: string[];
   updatedAccounts?: string[];
 };
 

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

@@ -1,12 +1,7 @@
-export declare function generateAccount(name: any, isConnected: any, offbudget: any): {
-    id: string;
-    name: any;
-    balance_current: number;
-    bank: number;
+import type { AccountEntity } from '../types/models';
+export declare function generateAccount(name: any, isConnected: any, offbudget: any): AccountEntity & {
     bankId: number;
     bankName: string;
-    offbudget: number;
-    closed: number;
 };
 export declare function generateCategory(name: any, group: any, isIncome?: boolean): {
     id: string;

package/@types/loot-core/server/accounts/parse-file.d.ts

@@ -10,6 +10,7 @@ type ParseFileOptions = {
     hasHeaderRow?: boolean;
     delimiter?: string;
     fallbackMissingPayeeToMemo?: boolean;
+    skipLines?: number;
 };
 export declare function parseFile(filepath: string, options?: ParseFileOptions): Promise<ParseFileResult>;
 export {};

package/@types/loot-core/server/accounts/rules.d.ts

@@ -10,7 +10,7 @@ export declare class Condition {
     type: any;
     unparsedValue: any;
     value: any;
-    constructor(op: any, field: any, value: any, options: any, fieldTypes: any);
+    constructor(op: any, field: any, value: any, options: any);
     eval(object: any): any;
     getValue(): any;
     serialize(): {
@@ -21,7 +21,7 @@ export declare class Condition {
         type: any;
     };
 }
-declare const ACTION_OPS: readonly ["set", "set-split-amount", "link-schedule"];
+declare const ACTION_OPS: readonly ["set", "set-split-amount", "link-schedule", "prepend-notes", "append-notes"];
 type ActionOperator = (typeof ACTION_OPS)[number];
 export declare class Action {
     field: any;
@@ -30,11 +30,11 @@ export declare class Action {
     rawValue: any;
     type: any;
     value: any;
-    constructor(op: ActionOperator, field: any, value: any, options: any, fieldTypes: any);
+    constructor(op: ActionOperator, field: any, value: any, options: any);
     exec(object: any): void;
     serialize(): {
         options: any;
-        op: "set" | "set-split-amount" | "link-schedule";
+        op: "set" | "set-split-amount" | "link-schedule" | "prepend-notes" | "append-notes";
         field: any;
         value: any;
         type: any;
@@ -47,13 +47,12 @@ export declare class Rule {
     conditionsOp: any;
     id: any;
     stage: any;
-    constructor({ id, stage, conditionsOp, conditions, actions, fieldTypes, }: {
+    constructor({ id, stage, conditionsOp, conditions, actions, }: {
         id?: string;
         stage?: any;
         conditionsOp: any;
         conditions: any;
         actions: any;
-        fieldTypes: any;
     });
     evalConditions(object: any): any;
     execActions<T>(object: T): Partial<T>;

package/@types/loot-core/server/accounts/sync.d.ts

@@ -1,10 +1,10 @@
 export declare function getGoCardlessAccounts(userId: any, userKey: any, id: any): Promise<any>;
-export declare function reconcileTransactions(acctId: any, transactions: any, isBankSyncAccount?: boolean, isPreview?: boolean): Promise<{
+export declare function reconcileTransactions(acctId: any, transactions: any, isBankSyncAccount?: boolean, strictIdChecking?: boolean, isPreview?: boolean): Promise<{
     added: any[];
     updated: any[];
     updatedPreview: any[];
 }>;
-export declare function matchTransactions(acctId: any, transactions: any, isBankSyncAccount?: boolean): Promise<{
+export declare function matchTransactions(acctId: any, transactions: any, isBankSyncAccount?: boolean, strictIdChecking?: boolean): Promise<{
     payeesToCreate: Map<any, any>;
     transactionsStep1: any[];
     transactionsStep2: any[];

package/@types/loot-core/server/accounts/transaction-rules.d.ts

@@ -18,9 +18,7 @@ export declare function insertRule(rule: Omit<RuleEntity, 'id'> & {
     id?: string;
 }): Promise<any>;
 export declare function updateRule(rule: any): Promise<void>;
-export declare function deleteRule<T extends {
-    id: string;
-}>(rule: T): Promise<false | void>;
+export declare function deleteRule(id: string): Promise<boolean>;
 export declare function runRules(trans: any): any;
 export declare function conditionsToAQL(conditions: any, { recurDateBounds }?: {
     recurDateBounds?: number;

package/@types/loot-core/server/accounts/transactions.d.ts

@@ -1,8 +1,6 @@
-import { NewTransactionEntity, TransactionEntity } from '../../types/models';
-export declare function batchUpdateTransactions({ added, deleted, updated, learnCategories, detectOrphanPayees, runTransfers, }: {
-    added?: Array<Partial<NewTransactionEntity | TransactionEntity>>;
-    deleted?: Array<Partial<NewTransactionEntity | TransactionEntity>>;
-    updated?: Array<Partial<NewTransactionEntity | TransactionEntity>>;
+import { Diff } from '../../shared/util';
+import { TransactionEntity } from '../../types/models';
+export declare function batchUpdateTransactions({ added, deleted, updated, learnCategories, detectOrphanPayees, runTransfers, }: Partial<Diff<TransactionEntity>> & {
     learnCategories?: boolean;
     detectOrphanPayees?: boolean;
     runTransfers?: boolean;

package/@types/loot-core/server/api-models.d.ts

@@ -18,10 +18,10 @@ export type APICategoryEntity = Pick<CategoryEntity, 'id' | 'name' | 'is_income'
 export declare const categoryModel: {
     toExternal(category: CategoryEntity): APICategoryEntity;
     fromExternal(category: APICategoryEntity): {
-        id?: string;
+        id: string;
         name: string;
         is_income?: boolean;
-        cat_group?: string;
+        cat_group?: CategoryGroupEntity["id"];
         sort_order?: number;
         tombstone?: boolean;
         hidden?: boolean;
@@ -30,10 +30,10 @@ export declare const categoryModel: {
         update?: boolean;
     }): {
         hidden: number;
-        id?: string;
+        id: string;
         name: string;
         is_income?: boolean;
-        cat_group?: string;
+        cat_group?: CategoryGroupEntity["id"];
         tombstone?: boolean;
     };
 };
@@ -47,11 +47,11 @@ export declare const categoryGroupModel: {
         update?: boolean;
     }): {
         hidden: number;
-        id?: string;
+        id: string;
+        categories?: CategoryEntity[];
         name: string;
         is_income?: boolean;
         tombstone?: boolean;
-        categories?: CategoryEntity[];
     };
 };
 export type APIPayeeEntity = Pick<PayeeEntity, 'id' | 'name' | 'transfer_acct'>;

package/@types/loot-core/server/aql/schema/index.d.ts

@@ -223,6 +223,14 @@ export declare const schema: {
             type: string;
         };
     };
+    preferences: {
+        id: {
+            type: string;
+        };
+        value: {
+            type: string;
+        };
+    };
     transaction_filters: {
         id: {
             type: string;
@@ -283,9 +291,6 @@ export declare const schema: {
         include_current: {
             type: string;
         };
-        selected_categories: {
-            type: string;
-        };
         graph_type: {
             type: string;
         };
@@ -354,5 +359,31 @@ export declare const schema: {
             type: string;
         };
     };
+    dashboard: {
+        id: {
+            type: string;
+        };
+        type: {
+            type: string;
+        };
+        width: {
+            type: string;
+        };
+        height: {
+            type: string;
+        };
+        x: {
+            type: string;
+        };
+        y: {
+            type: string;
+        };
+        meta: {
+            type: string;
+        };
+        tombstone: {
+            type: string;
+        };
+    };
 };
 export declare const schemaConfig: SchemaConfig;

package/@types/loot-core/server/budget/statements.d.ts

@@ -0,0 +1,9 @@
+import { Schedule } from '../db/types';
+export declare function resetCategoryGoalDefsWithNoTemplates(): Promise<void>;
+export type CategoryWithTemplateNote = {
+    id: string;
+    name: string;
+    note: string;
+};
+export declare function getCategoriesWithTemplateNotes(): Promise<CategoryWithTemplateNote[]>;
+export declare function getActiveSchedules(): Promise<Schedule[]>;

package/@types/loot-core/server/budget/template-notes.d.ts

@@ -0,0 +1,5 @@
+import { Notification } from '../../client/state-types/notifications';
+export declare const TEMPLATE_PREFIX = "#template";
+export declare const GOAL_PREFIX = "#goal";
+export declare function storeTemplates(): Promise<void>;
+export declare function checkTemplates(): Promise<Notification>;

package/@types/loot-core/server/budget/types/templates.d.ts

@@ -0,0 +1,82 @@
+interface BaseTemplate {
+  type: string;
+  priority?: number;
+  directive: string;
+}
+
+interface PercentageTemplate extends BaseTemplate {
+  type: 'percentage';
+  percent: number;
+  previous: boolean;
+  category: string;
+}
+
+interface WeekTemplate extends BaseTemplate {
+  type: 'week';
+  amount: number;
+  weeks: number | null;
+  starting: string;
+  limit?: { amount: number; hold: boolean };
+}
+
+interface ByTemplate extends BaseTemplate {
+  type: 'by';
+  amount: number;
+  month: string;
+  repeat?: { annual: boolean; repeat?: number };
+  from?: string;
+}
+
+interface SpendTemplate extends BaseTemplate {
+  type: 'spend';
+  amount: number;
+  month: string;
+  from: string;
+  repeat?: { annual: boolean; repeat?: number };
+}
+
+interface SimpleTemplate extends BaseTemplate {
+  type: 'simple';
+  monthly?: number;
+  limit?: { amount: number; hold: boolean };
+}
+
+interface ScheduleTemplate extends BaseTemplate {
+  type: 'schedule';
+  name: string;
+  full?: boolean;
+}
+
+interface RemainderTemplate extends BaseTemplate {
+  type: 'remainder';
+  weight: number;
+  limit?: { amount: number; hold: boolean };
+}
+
+interface AverageTemplate extends BaseTemplate {
+  type: 'average';
+  amount: number;
+}
+
+interface GoalTemplate extends BaseTemplate {
+  type: 'simple';
+  amount: number;
+}
+
+interface ErrorTemplate extends BaseTemplate {
+  type: 'error';
+  line: string;
+  error: string;
+}
+
+export type Template =
+  | PercentageTemplate
+  | WeekTemplate
+  | ByTemplate
+  | SpendTemplate
+  | SimpleTemplate
+  | ScheduleTemplate
+  | RemainderTemplate
+  | AverageTemplate
+  | GoalTemplate
+  | ErrorTemplate;

package/@types/loot-core/server/cloud-storage.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export interface RemoteFile {
     deleted: boolean;
     fileId: string;

package/@types/loot-core/server/dashboard/app.d.ts

@@ -0,0 +1,12 @@
+import { DashboardHandlers } from './types/handlers';
+export declare const app: {
+    events: any;
+    handlers: DashboardHandlers;
+    services: any;
+    unlistenServices: any;
+    method<Name extends "dashboard-update" | "dashboard-update-widget" | "dashboard-reset" | "dashboard-add-widget" | "dashboard-remove-widget" | "dashboard-import">(name: Name, func: DashboardHandlers[Name]): void;
+    service(func: any): void;
+    combine(...apps: any[]): void;
+    startServices(): void;
+    stopServices(): void;
+};

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

@@ -0,0 +1,24 @@
+import { type Widget } from '../../../types/models';
+import { type EverythingButIdOptional } from '../../../types/util';
+
+export interface DashboardHandlers {
+  'dashboard-update': (
+    widgets: EverythingButIdOptional<Omit<Widget, 'tombstone'>>[],
+  ) => Promise<void>;
+  'dashboard-update-widget': (
+    widget: EverythingButIdOptional<Omit<Widget, 'tombstone'>>,
+  ) => Promise<void>;
+  'dashboard-reset': () => Promise<void>;
+  'dashboard-add-widget': (
+    widget: Omit<Widget, 'id' | 'x' | 'y' | 'tombstone'> &
+      Partial<Pick<Widget, 'x' | 'y'>>,
+  ) => Promise<void>;
+  'dashboard-remove-widget': (widgetId: string) => Promise<void>;
+  'dashboard-import': (args: {
+    filepath: string;
+  }) => Promise<
+    | { status: 'ok' }
+    | { error: 'json-parse-error' | 'internal-error' }
+    | { error: 'validation-error'; message: string }
+  >;
+}

package/@types/loot-core/server/db/index.d.ts

@@ -13,7 +13,7 @@ export declare function getDatabase(): {
     exec(sql: string, params?: import("@jlongster/sql.js").BindParams): import("@jlongster/sql.js").QueryExecResult[];
     export(): Uint8Array;
     getRowsModified(): number;
-    handleError(): null;
+    handleError(): null | never;
     iterateStatements(sql: string): {
         getRemainingSql(): string;
         next(): import("@jlongster/sql.js").StatementIteratorResult;
@@ -29,7 +29,7 @@ export declare function getDatabase(): {
             reset(): void;
             run(values?: import("@jlongster/sql.js").BindParams): void;
             step(): boolean;
-        }, any, undefined>;
+        }>;
     };
     prepare(sql: string, params?: import("@jlongster/sql.js").BindParams): {
         bind(values?: import("@jlongster/sql.js").BindParams): boolean;
@@ -62,12 +62,13 @@ export declare function update(table: any, params: any): Promise<void>;
 export declare function insertWithUUID(table: any, row: any): Promise<any>;
 export declare function insert(table: any, row: any): Promise<void>;
 export declare function delete_(table: any, id: any): Promise<void>;
+export declare function deleteAll(table: string): Promise<void>;
 export declare function selectWithSchema(table: any, sql: any, params: any): Promise<any>;
 export declare function selectFirstWithSchema(table: any, sql: any, params: any): Promise<any>;
 export declare function insertWithSchema(table: any, row: any): Promise<any>;
 export declare function updateWithSchema(table: any, fields: any): Promise<void>;
-export declare function getCategories(): Promise<CategoryEntity[]>;
-export declare function getCategoriesGrouped(): Promise<Array<CategoryGroupEntity>>;
+export declare function getCategories(ids?: Array<CategoryEntity['id']>): Promise<CategoryEntity[]>;
+export declare function getCategoriesGrouped(ids?: Array<CategoryGroupEntity['id']>): Promise<Array<CategoryGroupEntity>>;
 export declare function insertCategoryGroup(group: any): Promise<any>;
 export declare function updateCategoryGroup(group: any): Promise<void>;
 export declare function moveCategoryGroup(id: any, targetId: any): Promise<void>;