@actual-app/api 24.11.0 → 25.1.0

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/bank-sync.d.ts

@@ -0,0 +1,21 @@
+import {
+  GoCardlessAmount,
+  GoCardlessBalance,
+  GoCardlessTransaction,
+} from './gocardless';
+
+export type BankSyncBalance = GoCardlessBalance;
+export type BankSyncAmount = GoCardlessAmount;
+export type BankSyncTransaction = GoCardlessTransaction;
+
+export type BankSyncResponse = {
+  transactions: {
+    all: BankSyncTransaction[];
+    booked: BankSyncTransaction[];
+    pending: BankSyncTransaction[];
+  };
+  balances: BankSyncBalance[];
+  startingBalance: number;
+  error_type: string;
+  error_code: string;
+};

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

@@ -37,6 +37,7 @@ export type CashFlowWidget = AbstractWidget<
     conditions?: RuleConditionEntity[];
     conditionsOp?: 'and' | 'or';
     timeFrame?: TimeFrame;
+    showBalance?: boolean;
   } | null
 >;
 export type SpendingWidget = AbstractWidget<
@@ -64,7 +65,9 @@ type SpecializedWidget =
   | NetWorthWidget
   | CashFlowWidget
   | SpendingWidget
-  | MarkdownWidget;
+  | MarkdownWidget
+  | SummaryWidget
+  | CalendarWidget;
 export type Widget = SpecializedWidget | CustomReportWidget;
 export type NewWidget = Omit<Widget, 'id' | 'tombstone'>;
 
@@ -87,3 +90,39 @@ export type ExportImportDashboard = {
   version: 1;
   widgets: ExportImportDashboardWidget[];
 };
+
+export type SummaryWidget = AbstractWidget<
+  'summary-card',
+  {
+    name?: string;
+    conditions?: RuleConditionEntity[];
+    conditionsOp?: 'and' | 'or';
+    timeFrame?: TimeFrame;
+    content?: string;
+  } | null
+>;
+
+export type BaseSummaryContent = {
+  type: 'sum' | 'avgPerMonth' | 'avgPerTransact';
+  fontSize?: number;
+};
+
+export type PercentageSummaryContent = {
+  type: 'percentage';
+  divisorConditions: RuleConditionEntity[];
+  divisorConditionsOp: 'and' | 'or';
+  divisorAllTimeDateRange?: boolean;
+  fontSize?: number;
+};
+
+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/gocardless.d.ts

@@ -12,3 +12,64 @@ export type GoCardlessInstitution = {
   logo: string;
   identification_codes: string[];
 };
+
+export type GoCardlessBalance = {
+  balanceAmount: GoCardlessAmount;
+  balanceType:
+    | 'closingBooked'
+    | 'expected'
+    | 'forwardAvailable'
+    | 'interimAvailable'
+    | 'interimBooked'
+    | 'nonInvoiced'
+    | 'openingBooked';
+  creditLimitIncluded?: boolean;
+  lastChangeDateTime?: string;
+  lastCommittedTransaction?: string;
+  referenceDate?: string;
+};
+
+export type GoCardlessAmount = {
+  amount: string;
+  currency: string;
+};
+
+export type GoCardlessTransaction = {
+  additionalInformation?: string;
+  bookingStatus?: string;
+  balanceAfterTransaction?: Pick<
+    GoCardlessBalance,
+    'balanceType' | 'balanceAmount'
+  >;
+  bankTransactionCode?: string;
+  bookingDate?: string;
+  bookingDateTime?: string;
+  checkId?: string;
+  creditorAccount?: string;
+  creditorAgent?: string;
+  creditorId?: string;
+  creditorName?: string;
+  currencyExchange?: string[];
+  debtorAccount?: {
+    iban: string;
+  };
+  debtorAgent?: string;
+  debtorName?: string;
+  endToEndId?: string;
+  entryReference?: string;
+  internalTransactionId?: string;
+  mandateId?: string;
+  merchantCategoryCode?: string;
+  proprietaryBankTransactionCode?: string;
+  purposeCode?: string;
+  remittanceInformationStructured?: string;
+  remittanceInformationStructuredArray?: string[];
+  remittanceInformationUnstructured?: string;
+  remittanceInformationUnstructuredArray?: string[];
+  transactionAmount: GoCardlessAmount;
+  transactionId?: string;
+  ultimateCreditor?: string;
+  ultimateDebtor?: string;
+  valueDate?: string;
+  valueDateTime?: string;
+};

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

@@ -1,4 +1,5 @@
 export type * from './account';
+export type * from './bank-sync';
 export type * from './category';
 export type * from './category-group';
 export type * from './dashboard';
@@ -11,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/rule.d.ts

@@ -26,7 +26,10 @@ export type RuleConditionOp =
   | 'contains'
   | 'doesNotContain'
   | 'hasTags'
-  | 'matches';
+  | 'and'
+  | 'matches'
+  | 'onBudget'
+  | 'offBudget';
 
 type FieldValueTypes = {
   account: string;
@@ -38,6 +41,8 @@ type FieldValueTypes = {
   payee_name: string;
   imported_payee: string;
   saved: string;
+  transfer: boolean;
+  parent: boolean;
   cleared: boolean;
   reconciled: boolean;
 };
@@ -73,6 +78,8 @@ export type RuleConditionEntity =
       | 'contains'
       | 'doesNotContain'
       | 'matches'
+      | 'onBudget'
+      | 'offBudget'
     >
   | BaseConditionEntity<
       'category',

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

@@ -32,7 +32,7 @@ export interface ScheduleEntity {
   // underlying rule
   _payee: PayeeEntity['id'];
   _account: AccountEntity['id'];
-  _amount: unknown;
+  _amount: number | { num1: number; num2: number };
   _amountOp: string;
   _date: RecurConfig;
   _conditions: unknown;

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

@@ -1,3 +1,6 @@
+import { AccountEntity } from './account';
+import { BankSyncResponse } from './bank-sync';
+
 export type SimpleFinOrganization = {
   name: string;
   domain: string;
@@ -8,3 +11,7 @@ export type SimpleFinAccount = {
   name: string;
   org: SimpleFinOrganization;
 };
+
+export interface SimpleFinBatchSyncResponse {
+  [accountId: AccountEntity['account_id']]: BankSyncResponse;
+}

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,9 +1,9 @@
 export type FeatureFlag =
-  | 'dashboards'
-  | 'reportBudget'
   | 'goalTemplatesEnabled'
   | 'actionTemplating'
-  | 'upcomingLengthAdjustment';
+  | 'upcomingLengthAdjustment'
+  | 'contextMenus'
+  | 'openidAuth';
 
 /**
  * Cross-device preferences. These sync across devices when they are changed.
@@ -82,3 +82,5 @@ export type GlobalPrefs = Partial<{
   documentDir: string; // Electron only
   serverSelfSignedCert: string; // Electron only
 }>;
+
+export type AuthMethods = 'password' | 'openid';

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

@@ -17,6 +17,7 @@ import {
   RuleEntity,
   PayeeEntity,
 } from './models';
+import { OpenIdConfig } from './models/openid';
 import { GlobalPrefs, MetadataPrefs } from './prefs';
 import { Query } from './query';
 import { EmptyObject } from './util';
@@ -116,6 +117,7 @@ export interface ServerHandlers {
   }) => Promise<unknown>;
 
   'payees-check-orphaned': (arg: { ids }) => Promise<unknown>;
+  'payees-get-orphaned': () => Promise<PayeeEntity[]>;
 
   'payees-get-rules': (arg: { id: string }) => Promise<RuleEntity[]>;
 
@@ -177,7 +179,7 @@ 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<null>;
   'secret-check': (arg: string) => Promise<string | { error?: string }>;
 
   'gocardless-poll-web-token': (arg: {
@@ -193,6 +195,18 @@ export interface ServerHandlers {
 
   'simplefin-accounts': () => Promise<{ accounts: SimpleFinAccount[] }>;
 
+  '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 };
@@ -213,7 +227,7 @@ export interface ServerHandlers {
     | { error: 'failed' }
   >;
 
-  'accounts-bank-sync': (arg: { id?: string }) => Promise<{
+  'accounts-bank-sync': (arg: { ids?: AccountEntity['id'][] }) => Promise<{
     errors;
     newTransactions;
     matchedTransactions;
@@ -256,27 +270,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 }>;
 
   '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>;
@@ -291,10 +342,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 }>;
@@ -314,7 +373,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?;
@@ -344,4 +420,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
+  >;
 }