@actual-app/api 25.2.1 → 25.3.1

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

@@ -73,3 +73,11 @@ export type GoCardlessTransaction = {
   valueDate?: string;
   valueDateTime?: string;
 };
+
+export type SyncServerGoCardlessAccount = {
+  institution: string;
+  account_id: string;
+  mask: string;
+  name: string;
+  official_name: string;
+};

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

@@ -17,3 +17,11 @@ export type SimpleFinAccount = {
 export interface SimpleFinBatchSyncResponse {
   [accountId: AccountEntity['account_id']]: BankSyncResponse;
 }
+
+export type SyncServerSimpleFinAccount = {
+  account_id: string;
+  institution?: string;
+  orgDomain?: string;
+  orgId?: string;
+  name: string;
+};

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

@@ -32,4 +32,5 @@ export interface TransactionEntity {
     version: 1;
     difference: number;
   } | null;
+  raw_synced_data?: string | undefined;
 }

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

@@ -1,5 +1,6 @@
 export type FeatureFlag =
   | 'goalTemplatesEnabled'
+  | 'goalTemplatesUIEnabled'
   | 'actionTemplating'
   | 'contextMenus'
   | 'openidAuth';
@@ -28,6 +29,9 @@ export type SyncedPrefs = Partial<
     | `csv-in-out-mode-${string}`
     | `csv-out-value-${string}`
     | `csv-has-header-${string}`
+    | `custom-sync-mappings-${string}`
+    | `sync-import-pending-${string}`
+    | `sync-import-notes-${string}`
     | `ofx-fallback-missing-payee-${string}`
     | `flip-amount-${string}-${'csv' | 'qif'}`
     | `flags.${FeatureFlag}`
@@ -73,6 +77,8 @@ export type LocalPrefs = Partial<{
 
 export type Theme = 'light' | 'dark' | 'auto' | 'midnight' | 'development';
 export type DarkTheme = 'dark' | 'midnight';
+
+// GlobalPrefs are the parsed global-store.json values
 export type GlobalPrefs = Partial<{
   floatingSidebar: boolean;
   maxMonths: number;
@@ -84,4 +90,24 @@ export type GlobalPrefs = Partial<{
   serverSelfSignedCert: string; // Electron only
 }>;
 
+// GlobalPrefsJson represents what's saved in the global-store.json file
+export type GlobalPrefsJson = Partial<{
+  'user-id'?: string;
+  'user-key'?: string;
+  'encrypt-keys'?: string;
+  lastBudget?: string;
+  readOnly?: string;
+  'server-url'?: string;
+  'did-bootstrap'?: boolean;
+  'user-token'?: string;
+  'floating-sidebar'?: string; // "true" or "false"
+  'max-months'?: string; // e.g. "2" or "3"
+  'document-dir'?: GlobalPrefs['documentDir'];
+  'encrypt-key'?: string;
+  language?: GlobalPrefs['language'];
+  theme?: GlobalPrefs['theme'];
+  'preferred-dark-theme'?: GlobalPrefs['preferredDarkTheme'];
+  'server-self-signed-cert'?: GlobalPrefs['serverSelfSignedCert'];
+}>;
+
 export type AuthMethods = 'password' | 'openid';

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

@@ -1,59 +1,24 @@
-import { ImportTransactionsOpts } from '@actual-app/api';
-
-import { ParseFileResult } from '../server/accounts/parse-file';
-import { batchUpdateTransactions } from '../server/accounts/transactions';
 import { Backup } from '../server/backups';
 import { RemoteFile } from '../server/cloud-storage';
 import { Node as SpreadsheetNode } from '../server/spreadsheet/spreadsheet';
 import { Message } from '../server/sync';
-import { QueryState } from '../shared/query';
 
 import { Budget } from './budget';
 import {
-  AccountEntity,
   CategoryEntity,
   CategoryGroupEntity,
-  GoCardlessToken,
-  GoCardlessInstitution,
-  SimpleFinAccount,
   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';
 
 export interface ServerHandlers {
-  'transaction-update': (transaction: { id: string }) => Promise<EmptyObject>;
-
   undo: () => Promise<void>;
-
   redo: () => Promise<void>;
 
-  'transactions-batch-update': (
-    ...arg: Parameters<typeof batchUpdateTransactions>
-  ) => ReturnType<typeof batchUpdateTransactions>;
-
-  'transaction-add': (transaction) => Promise<EmptyObject>;
-
-  'transaction-delete': (transaction) => Promise<EmptyObject>;
-
-  'transactions-parse-file': (arg: {
-    filepath: string;
-    options;
-  }) => Promise<ParseFileResult>;
-
-  'transactions-export': (arg: {
-    transactions;
-    accounts?;
-    categoryGroups;
-    payees;
-  }) => Promise<unknown>;
-
-  'transactions-export-query': (arg: { query: QueryState }) => Promise<string>;
-
   'get-categories': () => Promise<{
     grouped: Array<CategoryGroupEntity>;
     list: Array<CategoryEntity>;
@@ -93,6 +58,7 @@ export interface ServerHandlers {
   'category-group-create': (arg: {
     name;
     isIncome?: boolean;
+    hidden?: boolean;
   }) => Promise<string>;
 
   'category-group-update': (group) => Promise<unknown>;
@@ -126,146 +92,30 @@ export interface ServerHandlers {
 
   'make-filters-from-conditions': (arg: {
     conditions: unknown;
+    applySpecialCases?: boolean;
   }) => Promise<{ filters: unknown[] }>;
 
-  getCell: (arg: {
-    sheetName;
-    name;
-  }) => Promise<SpreadsheetNode | { value?: SpreadsheetNode['value'] }>;
-
-  getCells: (arg: { names }) => Promise<unknown>;
-
-  getCellNamesInSheet: (arg: { sheetName }) => Promise<unknown>;
-
-  debugCell: (arg: { sheetName; name }) => Promise<unknown>;
-
-  'create-query': (arg: { sheetName; name; query }) => Promise<unknown>;
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  query: (query: Query) => Promise<{ data: any; dependencies: string[] }>;
-
-  'account-update': (arg: { id; name }) => Promise<unknown>;
-
-  'accounts-get': () => Promise<AccountEntity[]>;
-
-  'account-properties': (arg: {
-    id;
-  }) => Promise<{ balance: number; numTransactions: number }>;
-
-  'gocardless-accounts-link': (arg: {
-    requisitionId;
-    account;
-    upgradingId;
-    offBudget;
-  }) => Promise<'ok'>;
-
-  'simplefin-accounts-link': (arg: {
-    externalAccount;
-    upgradingId;
-    offBudget;
-  }) => Promise<'ok'>;
-
-  'account-create': (arg: {
-    name: string;
-    balance?: number;
-    offBudget?: boolean;
-    closed?: 0 | 1;
-  }) => Promise<string>;
-
-  'account-close': (arg: {
-    id;
-    transferAccountId?;
-    categoryId?;
-    forced?;
-  }) => Promise<unknown>;
-
-  'account-reopen': (arg: { id }) => Promise<unknown>;
-
-  'account-move': (arg: { id; targetId }) => Promise<unknown>;
-
-  '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: {
-    upgradingAccountId?: string;
-    requisitionId: string;
-  }) => Promise<
-    { error: 'unknown' } | { error: 'timeout' } | { data: GoCardlessToken }
-  >;
-
-  'gocardless-status': () => Promise<{ configured: boolean }>;
-
-  'simplefin-status': () => Promise<{ configured: boolean }>;
-
-  'simplefin-accounts': () => Promise<{
-    accounts?: SimpleFinAccount[];
-    error_code?: string;
-    reason?: string;
+  getCell: (arg: { sheetName; name }) => Promise<{
+    name: SpreadsheetNode['name'];
+    value: SpreadsheetNode['value'];
   }>;
 
-  'simplefin-batch-sync': ({ ids }: { ids: string[] }) => Promise<
-    {
-      accountId: string;
-      res: {
-        errors;
-        newTransactions;
-        matchedTransactions;
-        updatedAccounts;
-      };
-    }[]
-  >;
-
-  'gocardless-get-banks': (country: string) => Promise<{
-    data: GoCardlessInstitution[];
-    error?: { reason: string };
-  }>;
-
-  'gocardless-poll-web-token-stop': () => Promise<'ok'>;
-
-  'gocardless-create-web-token': (arg: {
-    upgradingAccountId?: string;
-    institutionId: string;
-    accessValidForDays: number;
+  getCells: (arg: {
+    names;
   }) => Promise<
-    | {
-        requisitionId: string;
-        link: string;
-      }
-    | { error: 'unauthorized' }
-    | { error: 'failed' }
+    Array<{ name: SpreadsheetNode['name']; value?: SpreadsheetNode['value'] }>
   >;
 
-  'accounts-bank-sync': (arg: { ids?: AccountEntity['id'][] }) => Promise<{
-    errors;
-    newTransactions;
-    matchedTransactions;
-    updatedAccounts;
-  }>;
-
-  'transactions-import': (arg: {
-    accountId;
-    transactions;
-    isPreview;
-    opts?: ImportTransactionsOpts;
-  }) => Promise<{
-    errors?: { message: string }[];
-    added;
-    updated;
-    updatedPreview;
-  }>;
-
-  'account-unlink': (arg: { id }) => Promise<'ok'>;
-
-  'save-global-prefs': (prefs) => Promise<'ok'>;
+  getCellNamesInSheet: (arg: {
+    sheetName;
+  }) => Promise<Array<SpreadsheetNode['name']>>;
 
-  'load-global-prefs': () => Promise<GlobalPrefs>;
+  debugCell: (arg: { sheetName; name }) => Promise<unknown>;
 
-  'save-prefs': (prefsToSet) => Promise<'ok'>;
+  'create-query': (arg: { sheetName; name; query }) => Promise<'ok'>;
 
-  'load-prefs': () => Promise<MetadataPrefs | null>;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  query: (query: Query) => Promise<{ data: any; dependencies: string[] }>;
 
   'sync-reset': () => Promise<{ error?: { reason: string; meta?: unknown } }>;
 
@@ -383,8 +233,8 @@ export interface ServerHandlers {
   'close-budget': () => Promise<'ok'>;
 
   'delete-budget': (arg: {
-    id?: string;
-    cloudFileId?: string;
+    id?: string | undefined;
+    cloudFileId?: string | undefined;
   }) => Promise<'ok' | 'fail'>;
 
   /**
@@ -397,8 +247,8 @@ export interface ServerHandlers {
    * @returns {Promise<string>} The ID of the newly created budget.
    */
   'duplicate-budget': (arg: {
-    id?: string;
-    cloudId?: string;
+    id?: string | undefined;
+    cloudId?: string | undefined;
     newName: string;
     cloudSync?: boolean;
     open: 'none' | 'original' | 'copy';

package/@types/methods.d.ts

@@ -4,7 +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 getBudgets(): Promise<import("./@types/loot-core/server/api-models").APIFileEntity[]>;
 export declare function sync(): Promise<void>;
 export declare function runBankSync(args?: {
     accountId: string;
@@ -41,8 +41,8 @@ export declare function importTransactions(accountId: any, transactions: any, op
     added: any;
     updated: any;
 }>;
-export declare function getTransactions(accountId: any, startDate: any, endDate: any): Promise<import("./loot-core/types/models").TransactionEntity[]>;
-export declare function updateTransaction(id: any, fields: any): Promise<import("./loot-core/types/models").TransactionEntity[] | ({
+export declare function getTransactions(accountId: any, startDate: any, endDate: any): Promise<import("./@types/loot-core/types/models").TransactionEntity[]>;
+export declare function updateTransaction(id: any, fields: any): Promise<import("./@types/loot-core/types/models").TransactionEntity[] | ({
     id: any;
     transfer_id: any;
 } | {
@@ -50,33 +50,33 @@ export declare function updateTransaction(id: any, fields: any): Promise<import(
     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 getAccounts(): Promise<import("./@types/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 getCategoryGroups(): Promise<import("./@types/loot-core/server/api-models").APICategoryGroupEntity[]>;
 export declare function createCategoryGroup(group: any): Promise<string>;
 export declare function updateCategoryGroup(id: any, fields: any): Promise<unknown>;
 export declare function deleteCategoryGroup(id: any, transferCategoryId?: any): Promise<unknown>;
-export declare function getCategories(): Promise<(import("./loot-core/server/api-models").APICategoryGroupEntity | import("./loot-core/server/api-models").APICategoryEntity)[]>;
+export declare function getCategories(): Promise<(import("./@types/loot-core/server/api-models").APICategoryGroupEntity | import("./@types/loot-core/server/api-models").APICategoryEntity)[]>;
 export declare function createCategory(category: any): Promise<string>;
 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 getCommonPayees(): Promise<import("./@types/loot-core/server/api-models").APIPayeeEntity[]>;
+export declare function getPayees(): Promise<import("./@types/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 getRules(): Promise<import("./@types/loot-core/types/models").RuleEntity[]>;
+export declare function getPayeeRules(id: any): Promise<import("./@types/loot-core/types/models").RuleEntity[]>;
+export declare function createRule(rule: any): Promise<import("./@types/loot-core/types/models").RuleEntity>;
+export declare function updateRule(rule: any): Promise<import("./@types/loot-core/types/models").RuleEntity>;
 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>;