@actual-app/api 25.1.0 → 25.2.0

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';
@@ -19,6 +21,7 @@ import {
 } 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';
 
@@ -49,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>;
@@ -106,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>;
 
@@ -122,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: {
@@ -138,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>;
 
@@ -179,7 +183,10 @@ export interface ServerHandlers {
 
   'account-move': (arg: { id; targetId }) => Promise<unknown>;
 
-  'secret-set': (arg: { name: string; value: string | null }) => 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: {
@@ -193,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<
     {
@@ -238,6 +249,7 @@ export interface ServerHandlers {
     accountId;
     transactions;
     isPreview;
+    opts?: ImportTransactionsOpts;
   }) => Promise<{
     errors?: { message: string }[];
     added;
@@ -322,7 +334,7 @@ export interface ServerHandlers {
           return_url;
           loginMethod?: 'openid';
         },
-  ) => Promise<{ error?: string }>;
+  ) => Promise<{ error?: string; redirect_url?: string }>;
 
   'subscribe-sign-out': () => Promise<'ok'>;
 

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;