@actual-app/api 24.12.0 → 25.2.0

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

@@ -1,3 +1,5 @@
+import { UsersWithAccess } from '../server/cloud-storage';
+
 import { Budget } from './budget';
 
 export type FileState =
@@ -18,6 +20,7 @@ export type SyncableLocalFile = Budget & {
   groupId: string;
   state: 'broken' | 'unknown';
   hasKey: boolean;
+  owner: string;
 };
 
 export type SyncedLocalFile = Budget & {
@@ -26,6 +29,8 @@ export type SyncedLocalFile = Budget & {
   encryptKeyId?: string;
   hasKey: boolean;
   state: 'synced' | 'detached';
+  owner: string;
+  usersWithAccess: UsersWithAccess[];
 };
 
 export type RemoteFile = {
@@ -35,6 +40,8 @@ export type RemoteFile = {
   encryptKeyId?: string;
   hasKey: boolean;
   state: 'remote';
+  owner: string;
+  usersWithAccess: UsersWithAccess[];
 };
 
 export type File = LocalFile | SyncableLocalFile | SyncedLocalFile | RemoteFile;

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

@@ -1,3 +1,4 @@
+import type { AdminHandlers } from '../server/admin/types/handlers';
 import type { BudgetHandlers } from '../server/budget/types/handlers';
 import type { DashboardHandlers } from '../server/dashboard/types/handlers';
 import type { FiltersHandlers } from '../server/filters/types/handlers';
@@ -22,6 +23,7 @@ export interface Handlers
     ReportsHandlers,
     RulesHandlers,
     SchedulesHandlers,
+    AdminHandlers,
     ToolsHandlers {}
 
 export type HandlerFunctions = Handlers[keyof Handlers];

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

@@ -4,7 +4,7 @@ import { type RuleConditionEntity } from './rule';
 export type TimeFrame = {
   start: string;
   end: string;
-  mode: 'sliding-window' | 'static' | 'full';
+  mode: 'sliding-window' | 'static' | 'full' | 'lastYear' | 'yearToDate';
 };
 
 type AbstractWidget<
@@ -66,7 +66,8 @@ type SpecializedWidget =
   | CashFlowWidget
   | SpendingWidget
   | MarkdownWidget
-  | SummaryWidget;
+  | SummaryWidget
+  | CalendarWidget;
 export type Widget = SpecializedWidget | CustomReportWidget;
 export type NewWidget = Omit<Widget, 'id' | 'tombstone'>;
 
@@ -115,3 +116,13 @@ export type PercentageSummaryContent = {
 };
 
 export type SummaryContent = BaseSummaryContent | PercentageSummaryContent;
+
+export type CalendarWidget = AbstractWidget<
+  'calendar-card',
+  {
+    name?: string;
+    conditions?: RuleConditionEntity[];
+    conditionsOp?: 'and' | 'or';
+    timeFrame?: TimeFrame;
+  } | null
+>;

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

@@ -12,3 +12,4 @@ export type * from './rule';
 export type * from './schedule';
 export type * from './transaction';
 export type * from './transaction-filter';
+export type * from './user';

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

@@ -0,0 +1,7 @@
+export type OpenIdConfig = {
+  selectedProvider: string;
+  issuer: string;
+  client_id: string;
+  client_secret: string;
+  server_hostname: string;
+};

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

@@ -5,5 +5,6 @@ export interface PayeeEntity {
   name: string;
   transfer_acct?: AccountEntity['id'];
   favorite?: 1 | 0;
+  learn_categories?: 1 | 0;
   tombstone?: boolean;
 }

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

@@ -11,6 +11,7 @@ export interface CustomReportEntity {
   groupBy: string;
   interval: string;
   balanceType: string;
+  sortBy?: sortByOpType;
   showEmpty: boolean;
   showOffBudget: boolean;
   showHiddenCategories: boolean;
@@ -30,6 +31,8 @@ export type balanceTypeOpType =
   | 'netAssets'
   | 'netDebts';
 
+export type sortByOpType = 'asc' | 'desc' | 'name' | 'budget';
+
 export type SpendingMonthEntity = Record<
   string | number,
   {
@@ -122,6 +125,7 @@ export interface CustomReportData {
   date_range: string;
   mode: string;
   group_by: string;
+  sort_by: sortByOpType;
   balance_type: string;
   show_empty: number;
   show_offbudget: number;

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

@@ -1,4 +1,4 @@
-import { type ScheduleEntity } from './schedule';
+import { type RecurConfig, type ScheduleEntity } from './schedule';
 
 export interface NewRuleEntity {
   stage: 'pre' | null | 'post';
@@ -27,13 +27,15 @@ export type RuleConditionOp =
   | 'doesNotContain'
   | 'hasTags'
   | 'and'
-  | 'matches';
+  | 'matches'
+  | 'onBudget'
+  | 'offBudget';
 
-type FieldValueTypes = {
+export type FieldValueTypes = {
   account: string;
   amount: number;
   category: string;
-  date: string;
+  date: string | RecurConfig;
   notes: string;
   payee: string;
   payee_name: string;
@@ -53,7 +55,9 @@ type BaseConditionEntity<
   op: Op;
   value: Op extends 'oneOf' | 'notOneOf'
     ? Array<FieldValueTypes[Field]>
-    : FieldValueTypes[Field];
+    : Op extends 'isbetween'
+      ? { num1: number; num2: number }
+      : FieldValueTypes[Field];
   options?: {
     inflow?: boolean;
     outflow?: boolean;
@@ -76,6 +80,8 @@ export type RuleConditionEntity =
       | 'contains'
       | 'doesNotContain'
       | 'matches'
+      | 'onBudget'
+      | 'offBudget'
     >
   | BaseConditionEntity<
       'category',

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

@@ -1,6 +1,6 @@
 import type { AccountEntity } from './account';
 import type { PayeeEntity } from './payee';
-import type { RuleEntity } from './rule';
+import type { RuleConditionEntity, RuleEntity } from './rule';
 
 export interface RecurPattern {
   value: number;
@@ -9,7 +9,7 @@ export interface RecurPattern {
 
 export interface RecurConfig {
   frequency: 'daily' | 'weekly' | 'monthly' | 'yearly';
-  interval: number;
+  interval?: number;
   patterns?: RecurPattern[];
   skipWeekend?: boolean;
   start: string;
@@ -35,8 +35,8 @@ export interface ScheduleEntity {
   _amount: number | { num1: number; num2: number };
   _amountOp: string;
   _date: RecurConfig;
-  _conditions: unknown;
-  _actions: unknown;
+  _conditions: RuleConditionEntity[];
+  _actions: Array<{ op: unknown }>;
 }
 
 export type DiscoverScheduleEntity = {
@@ -45,18 +45,5 @@ export type DiscoverScheduleEntity = {
   payee: PayeeEntity['id'];
   date: ScheduleEntity['_date'];
   amount: ScheduleEntity['_amount'];
-  _conditions: Array<
-    | { op: 'is'; field: 'account'; value: AccountEntity['id'] }
-    | { op: 'is'; field: 'payee'; value: PayeeEntity['id'] }
-    | {
-        op: 'is' | 'isapprox';
-        field: 'date';
-        value: ScheduleEntity['_date'];
-      }
-    | {
-        op: 'is' | 'isapprox';
-        field: 'amount';
-        value: ScheduleEntity['_amount'];
-      }
-  >;
+  _conditions: ScheduleEntity['_conditions'];
 };

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

@@ -2,6 +2,7 @@ import { AccountEntity } from './account';
 import { BankSyncResponse } from './bank-sync';
 
 export type SimpleFinOrganization = {
+  id: string;
   name: string;
   domain: string;
 };
@@ -9,6 +10,7 @@ export type SimpleFinOrganization = {
 export type SimpleFinAccount = {
   id: string;
   name: string;
+  balance: number;
   org: SimpleFinOrganization;
 };
 

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

@@ -22,8 +22,14 @@ export interface TransactionEntity {
   cleared?: boolean;
   reconciled?: boolean;
   tombstone?: boolean;
+  forceUpcoming?: boolean;
   schedule?: ScheduleEntity['id'];
   subtransactions?: TransactionEntity[];
   _unmatched?: boolean;
   _deleted?: boolean;
+  error?: {
+    type: 'SplitTransactionError';
+    version: 1;
+    difference: number;
+  } | null;
 }

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

@@ -0,0 +1,26 @@
+export interface NewUserEntity {
+    userName: string;
+    displayName: string;
+    role: string;
+    enabled: boolean;
+}
+export interface UserEntity extends NewUserEntity {
+    id: string;
+    owner: boolean;
+}
+export interface UserEntityDropdown {
+    userId: string;
+    userName: string;
+    displayName?: string;
+}
+export interface UserAvailable {
+    userId: string;
+    displayName?: string;
+    userName: string;
+    haveAccess?: number;
+    owner?: number;
+}
+export declare const PossibleRoles: {
+    ADMIN: string;
+    BASIC: string;
+};

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

@@ -0,0 +1,9 @@
+export interface NewUserAccessEntity {
+    fileId: string;
+    userId: string;
+}
+export interface UserAccessEntity extends NewUserAccessEntity {
+    displayName: string;
+    userName: string;
+    fileName: string;
+}

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

@@ -1,8 +1,8 @@
 export type FeatureFlag =
   | 'goalTemplatesEnabled'
   | 'actionTemplating'
-  | 'upcomingLengthAdjustment'
-  | 'contextMenus';
+  | 'contextMenus'
+  | 'openidAuth';
 
 /**
  * Cross-device preferences. These sync across devices when they are changed.
@@ -30,7 +30,8 @@ export type SyncedPrefs = Partial<
     | `csv-has-header-${string}`
     | `ofx-fallback-missing-payee-${string}`
     | `flip-amount-${string}-${'csv' | 'qif'}`
-    | `flags.${FeatureFlag}`,
+    | `flags.${FeatureFlag}`
+    | `learn-categories`,
     string
   >
 >;
@@ -76,8 +77,11 @@ export type GlobalPrefs = Partial<{
   floatingSidebar: boolean;
   maxMonths: number;
   keyId?: string;
+  language: string;
   theme: Theme;
   preferredDarkTheme: DarkTheme;
   documentDir: string; // Electron only
   serverSelfSignedCert: string; // Electron only
 }>;
+
+export type AuthMethods = 'password' | 'openid';

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

@@ -1,23 +1,86 @@
 import { type Backup } from '../server/backups';
 import { type UndoState } from '../server/undo';
 
+type SyncSubtype =
+  | 'out-of-sync'
+  | 'apply-failure'
+  | 'decrypt-failure'
+  | 'encrypt-failure'
+  | 'invalid-schema'
+  | 'network'
+  | 'file-old-version'
+  | 'file-key-mismatch'
+  | 'file-not-found'
+  | 'file-needs-upload'
+  | 'file-has-reset'
+  | 'file-has-new-key'
+  | 'token-expired'
+  | string;
+
+type SyncEvent = {
+  meta?: Record<string, unknown>;
+} & (
+  | {
+      type: 'applied';
+      tables: string[];
+      data?: Map<string, unknown>;
+      prevData?: Map<string, unknown>;
+    }
+  | {
+      type: 'success';
+      tables: string[];
+      syncDisabled?: boolean;
+    }
+  | {
+      type: 'error';
+      subtype?: SyncSubtype;
+    }
+  | {
+      type: 'start';
+    }
+  | {
+      type: 'unauthorized';
+    }
+);
+
+type BackupUpdatedEvent = Backup[];
+
+type CellsChangedEvent = Array<{
+  name: string;
+  value: string | number | boolean;
+}>;
+
+type FallbackWriteErrorEvent = undefined;
+type FinishImportEvent = undefined;
+type FinishLoadEvent = undefined;
+
+type OrphanedPayeesEvent = {
+  orphanedIds: string[];
+  updatedPayeeIds: string[];
+};
+
+type PrefsUpdatedEvent = undefined;
+type SchedulesOfflineEvent = undefined;
+type ServerErrorEvent = undefined;
+type ShowBudgetsEvent = undefined;
+type StartImportEvent = { budgetName: string };
+type StartLoadEvent = undefined;
+type ApiFetchRedirectedEvent = undefined;
+
 export interface ServerEvents {
-  'backups-updated': Backup[];
-  'cells-changed': Array<{ name }>;
-  'fallback-write-error': unknown;
-  'finish-import': unknown;
-  'finish-load': unknown;
-  'orphaned-payees': {
-    orphanedIds: string[];
-    updatedPayeeIds: string[];
-  };
-  'prefs-updated': unknown;
-  'schedules-offline': { payees: unknown[] };
-  'server-error': unknown;
-  'show-budgets': unknown;
-  'start-import': unknown;
-  'start-load': unknown;
-  'sync-event': { type; subtype; meta; tables; syncDisabled };
+  'backups-updated': BackupUpdatedEvent;
+  'cells-changed': CellsChangedEvent;
+  'fallback-write-error': FallbackWriteErrorEvent;
+  'finish-import': FinishImportEvent;
+  'finish-load': FinishLoadEvent;
+  'orphaned-payees': OrphanedPayeesEvent;
+  'prefs-updated': PrefsUpdatedEvent;
+  'schedules-offline': SchedulesOfflineEvent;
+  'server-error': ServerErrorEvent;
+  'show-budgets': ShowBudgetsEvent;
+  'start-import': StartImportEvent;
+  'start-load': StartLoadEvent;
+  'sync-event': SyncEvent;
   'undo-event': UndoState;
-  'api-fetch-redirected': unknown;
+  'api-fetch-redirected': ApiFetchRedirectedEvent;
 }

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

@@ -1,3 +1,5 @@
+import { ImportTransactionsOpts } from '@actual-app/api';
+
 import { ParseFileResult } from '../server/accounts/parse-file';
 import { batchUpdateTransactions } from '../server/accounts/transactions';
 import { Backup } from '../server/backups';
@@ -17,7 +19,9 @@ import {
   RuleEntity,
   PayeeEntity,
 } from './models';
+import { OpenIdConfig } from './models/openid';
 import { GlobalPrefs, MetadataPrefs } from './prefs';
+// eslint-disable-next-line import/no-unresolved
 import { Query } from './query';
 import { EmptyObject } from './util';
 
@@ -48,7 +52,7 @@ export interface ServerHandlers {
     payees;
   }) => Promise<unknown>;
 
-  'transactions-export-query': (arg: { query: QueryState }) => Promise<unknown>;
+  'transactions-export-query': (arg: { query: QueryState }) => Promise<string>;
 
   'get-categories': () => Promise<{
     grouped: Array<CategoryGroupEntity>;
@@ -105,7 +109,7 @@ export interface ServerHandlers {
 
   'payees-get': () => Promise<PayeeEntity[]>;
 
-  'payees-get-rule-counts': () => Promise<unknown>;
+  'payees-get-rule-counts': () => Promise<Record<PayeeEntity['id'], number>>;
 
   'payees-merge': (arg: { targetId; mergeIds }) => Promise<void>;
 
@@ -121,7 +125,7 @@ export interface ServerHandlers {
   'payees-get-rules': (arg: { id: string }) => Promise<RuleEntity[]>;
 
   'make-filters-from-conditions': (arg: {
-    conditions;
+    conditions: unknown;
   }) => Promise<{ filters: unknown[] }>;
 
   getCell: (arg: {
@@ -137,7 +141,8 @@ export interface ServerHandlers {
 
   'create-query': (arg: { sheetName; name; query }) => Promise<unknown>;
 
-  query: (query: Query) => Promise<{ data: unknown; dependencies }>;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  query: (query: Query) => Promise<{ data: any; dependencies: string[] }>;
 
   'account-update': (arg: { id; name }) => Promise<unknown>;
 
@@ -178,7 +183,10 @@ export interface ServerHandlers {
 
   'account-move': (arg: { id; targetId }) => Promise<unknown>;
 
-  'secret-set': (arg: { name: string; value: string }) => Promise<null>;
+  'secret-set': (arg: {
+    name: string;
+    value: string | null;
+  }) => Promise<{ error?: string; reason?: string }>;
   'secret-check': (arg: string) => Promise<string | { error?: string }>;
 
   'gocardless-poll-web-token': (arg: {
@@ -192,7 +200,11 @@ export interface ServerHandlers {
 
   'simplefin-status': () => Promise<{ configured: boolean }>;
 
-  'simplefin-accounts': () => Promise<{ accounts: SimpleFinAccount[] }>;
+  'simplefin-accounts': () => Promise<{
+    accounts?: SimpleFinAccount[];
+    error_code?: string;
+    reason?: string;
+  }>;
 
   'simplefin-batch-sync': ({ ids }: { ids: string[] }) => Promise<
     {
@@ -237,6 +249,7 @@ export interface ServerHandlers {
     accountId;
     transactions;
     isPreview;
+    opts?: ImportTransactionsOpts;
   }) => Promise<{
     errors?: { message: string }[];
     added;
@@ -269,27 +282,64 @@ export interface ServerHandlers {
 
   'get-did-bootstrap': () => Promise<boolean>;
 
-  'subscribe-needs-bootstrap': (args: {
-    url;
-  }) => Promise<
-    { error: string } | { bootstrapped: unknown; hasServer: boolean }
+  'subscribe-needs-bootstrap': (args: { url }) => Promise<
+    | { error: string }
+    | {
+        bootstrapped: boolean;
+        hasServer: false;
+      }
+    | {
+        bootstrapped: boolean;
+        hasServer: true;
+        availableLoginMethods: {
+          method: string;
+          displayName: string;
+          active: boolean;
+        }[];
+        multiuser: boolean;
+      }
   >;
 
-  'subscribe-bootstrap': (arg: { password }) => Promise<{ error?: string }>;
+  'subscribe-get-login-methods': () => Promise<{
+    methods?: { method: string; displayName: string; active: boolean }[];
+    error?: string;
+  }>;
+
+  'subscribe-bootstrap': (arg: {
+    password?: string;
+    openId?: OpenIdConfig;
+  }) => Promise<{ error?: string }>;
 
-  'subscribe-get-user': () => Promise<{ offline: boolean } | null>;
+  'subscribe-get-user': () => Promise<{
+    offline: boolean;
+    userName?: string;
+    userId?: string;
+    displayName?: string;
+    permission?: string;
+    loginMethod?: string;
+    tokenExpired?: boolean;
+  } | null>;
 
   'subscribe-change-password': (arg: {
     password;
   }) => Promise<{ error?: string }>;
 
-  'subscribe-sign-in': (arg: {
-    password;
-    loginMethod?: string;
-  }) => Promise<{ error?: string }>;
+  'subscribe-sign-in': (
+    arg:
+      | {
+          password;
+          loginMethod?: string;
+        }
+      | {
+          return_url;
+          loginMethod?: 'openid';
+        },
+  ) => Promise<{ error?: string; redirect_url?: string }>;
 
   'subscribe-sign-out': () => Promise<'ok'>;
 
+  'subscribe-set-token': (arg: { token: string }) => Promise<void>;
+
   'get-server-version': () => Promise<{ error?: string } | { version: string }>;
 
   'get-server-url': () => Promise<string | null>;
@@ -304,10 +354,18 @@ export interface ServerHandlers {
     | { messages: Message[] }
   >;
 
+  'validate-budget-name': (arg: {
+    name: string;
+  }) => Promise<{ valid: boolean; message?: string }>;
+
+  'unique-budget-name': (arg: { name: string }) => Promise<string>;
+
   'get-budgets': () => Promise<Budget[]>;
 
   'get-remote-files': () => Promise<RemoteFile[]>;
 
+  'get-user-file-info': (fileId: string) => Promise<RemoteFile | null>;
+
   'reset-budget-cache': () => Promise<unknown>;
 
   'upload-budget': (arg: { id }) => Promise<{ error?: string }>;
@@ -327,7 +385,24 @@ export interface ServerHandlers {
   'delete-budget': (arg: {
     id?: string;
     cloudFileId?: string;
-  }) => Promise<'ok'>;
+  }) => Promise<'ok' | 'fail'>;
+
+  /**
+   * Duplicates a budget file.
+   * @param {Object} arg - The arguments for duplicating a budget.
+   * @param {string} [arg.id] - The ID of the local budget to duplicate.
+   * @param {string} [arg.cloudId] - The ID of the cloud-synced budget to duplicate.
+   * @param {string} arg.newName - The name for the duplicated budget.
+   * @param {boolean} [arg.cloudSync] - Whether to sync the duplicated budget to the cloud.
+   * @returns {Promise<string>} The ID of the newly created budget.
+   */
+  'duplicate-budget': (arg: {
+    id?: string;
+    cloudId?: string;
+    newName: string;
+    cloudSync?: boolean;
+    open: 'none' | 'original' | 'copy';
+  }) => Promise<string>;
 
   'create-budget': (arg: {
     budgetName?;
@@ -357,4 +432,18 @@ export interface ServerHandlers {
   'get-last-opened-backup': () => Promise<string | null>;
 
   'app-focused': () => Promise<void>;
+
+  'enable-openid': (arg: {
+    openId?: OpenIdConfig;
+  }) => Promise<{ error?: string }>;
+
+  'enable-password': (arg: { password: string }) => Promise<{ error?: string }>;
+
+  'get-openid-config': () => Promise<
+    | {
+        openId: OpenIdConfig;
+      }
+    | { error: string }
+    | null
+  >;
 }

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

@@ -9,3 +9,8 @@ export type EverythingButIdOptional<T> = { id: T['id'] } & Partial<
 >;
 
 export type WithRequired<T, K extends keyof T> = T & Required<Pick<T, K>>;
+
+// Allows use of object literals inside child elements of `Trans` tags
+// see https://github.com/i18next/react-i18next/issues/1483
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type TransObjectLiteral = any;

package/@types/methods.d.ts

@@ -31,7 +31,10 @@ export declare function addTransactions(accountId: any, transactions: any, { lea
     learnCategories?: boolean;
     runTransfers?: boolean;
 }): Promise<"ok">;
-export declare function importTransactions(accountId: any, transactions: any): Promise<{
+export interface ImportTransactionsOpts {
+    defaultCleared?: boolean;
+}
+export declare function importTransactions(accountId: any, transactions: any, opts?: ImportTransactionsOpts): Promise<{
     errors?: {
         message: string;
     }[];
@@ -42,9 +45,6 @@ export declare function getTransactions(accountId: any, startDate: any, endDate:
 export declare function updateTransaction(id: any, fields: any): Promise<import("./loot-core/types/models").TransactionEntity[] | ({
     id: any;
     transfer_id: any;
-} | {
-    id: any;
-    payee: any;
 } | {
     id: any;
     category: any;