@actual-app/core 26.3.0

package/src/types/models/templates.ts

@@ -0,0 +1,135 @@
+type BaseTemplate = {
+  type: string;
+  directive: 'template' | 'goal' | 'error';
+};
+type BaseTemplateWithPriority = {
+  priority: number;
+  directive: 'template';
+} & BaseTemplate;
+
+export type PercentageTemplate = {
+  type: 'percentage';
+  percent: number;
+  previous: boolean;
+  category: string;
+} & BaseTemplateWithPriority;
+
+export type PeriodicTemplate = {
+  type: 'periodic';
+  amount: number;
+  period: {
+    period: 'day' | 'week' | 'month' | 'year';
+    amount: number;
+  };
+  starting: string;
+  limit?: {
+    amount: number;
+    hold: boolean;
+    period: 'daily' | 'weekly' | 'monthly';
+    start?: string;
+  };
+} & BaseTemplateWithPriority;
+
+export type ByTemplate = {
+  type: 'by';
+  amount: number;
+  month: string;
+  annual?: boolean;
+  repeat?: number;
+  from?: string;
+} & BaseTemplateWithPriority;
+
+export type SpendTemplate = {
+  type: 'spend';
+  amount: number;
+  month: string;
+  from: string;
+  annual?: boolean;
+  repeat?: number;
+} & BaseTemplateWithPriority;
+
+export type SimpleTemplate = {
+  type: 'simple';
+  monthly?: number;
+  limit?: {
+    amount: number;
+    hold: boolean;
+    period: 'daily' | 'weekly' | 'monthly';
+    start?: string;
+  };
+} & BaseTemplateWithPriority;
+
+export type ScheduleTemplate = {
+  type: 'schedule';
+  name: string;
+  full?: boolean;
+  adjustment?: number;
+  adjustmentType?: 'percent' | 'fixed';
+} & BaseTemplateWithPriority;
+
+export type AverageTemplate = {
+  type: 'average';
+  numMonths: number;
+  adjustment?: number;
+  adjustmentType?: 'percent' | 'fixed';
+} & BaseTemplateWithPriority;
+
+export type CopyTemplate = {
+  type: 'copy';
+  lookBack: number;
+} & BaseTemplateWithPriority;
+
+export type RemainderTemplate = {
+  type: 'remainder';
+  weight: number;
+  limit?: {
+    amount: number;
+    hold: boolean;
+    period: 'daily' | 'weekly' | 'monthly';
+    start?: string;
+  };
+  directive: 'template';
+  priority: null;
+} & BaseTemplate;
+
+export type RefillTemplate = {
+  type: 'refill';
+} & BaseTemplateWithPriority;
+
+export type GoalTemplate = {
+  type: 'goal';
+  amount: number;
+  directive: 'goal';
+} & BaseTemplate;
+
+export type LimitTemplate = {
+  type: 'limit';
+  amount: number;
+  hold: boolean;
+  period: 'daily' | 'weekly' | 'monthly';
+  start?: string;
+  directive: 'template';
+  priority: null;
+} & BaseTemplate;
+
+type ErrorTemplate = {
+  type: 'error';
+  line: string;
+  error: string;
+  directive: 'error';
+} & BaseTemplate;
+
+export type Template =
+  | PercentageTemplate
+  | PeriodicTemplate
+  | ByTemplate
+  | SpendTemplate
+  | SimpleTemplate
+  | ScheduleTemplate
+  | RemainderTemplate
+  | AverageTemplate
+  | GoalTemplate
+  | CopyTemplate
+  | RefillTemplate
+  | LimitTemplate
+  | ErrorTemplate;

package/src/types/models/transaction-filter.ts

@@ -0,0 +1,9 @@
+import type { RuleConditionEntity } from './rule';
+
+export type TransactionFilterEntity = {
+  id: string;
+  name: string;
+  conditionsOp: 'and' | 'or';
+  conditions: RuleConditionEntity[];
+  tombstone: boolean;
+};

package/src/types/models/transaction.ts

@@ -0,0 +1,39 @@
+import type { IntegerAmount } from '../../shared/util';
+
+import type { AccountEntity } from './account';
+import type { CategoryEntity } from './category';
+import type { PayeeEntity } from './payee';
+import type { ScheduleEntity } from './schedule';
+
+export type TransactionEntity = {
+  id: string;
+  is_parent?: boolean;
+  is_child?: boolean;
+  parent_id?: TransactionEntity['id'];
+  account: AccountEntity['id'];
+  category?: CategoryEntity['id'];
+  amount: IntegerAmount;
+  payee?: PayeeEntity['id'] | null;
+  notes?: string;
+  date: string;
+  imported_id?: string;
+  imported_payee?: string;
+  starting_balance_flag?: boolean;
+  transfer_id?: TransactionEntity['id'];
+  sort_order?: number;
+  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;
+  raw_synced_data?: string | undefined;
+  _ruleErrors?: string[];
+};

package/src/types/models/user-access.ts

@@ -0,0 +1,10 @@
+export type NewUserAccessEntity = {
+  fileId: string;
+  userId: string;
+};
+
+export type UserAccessEntity = {
+  displayName: string;
+  userName: string;
+  fileName: string;
+} & NewUserAccessEntity;

package/src/types/models/user.ts

@@ -0,0 +1,25 @@
+export type NewUserEntity = {
+  userName: string;
+  displayName: string;
+  role: string;
+  enabled: boolean;
+};
+
+export type UserEntity = {
+  id: string;
+  owner: boolean;
+} & NewUserEntity;
+
+export type UserEntityDropdown = {
+  userId: string;
+  userName: string;
+  displayName?: string;
+};
+
+export type UserAvailable = {
+  userId: string;
+  displayName?: string;
+  userName: string;
+  haveAccess?: number;
+  owner?: number;
+};

package/src/types/prefs.ts

@@ -0,0 +1,167 @@
+export type FeatureFlag =
+  | 'goalTemplatesEnabled'
+  | 'goalTemplatesUIEnabled'
+  | 'actionTemplating'
+  | 'formulaMode'
+  | 'currency'
+  | 'crossoverReport'
+  | 'customThemes'
+  | 'budgetAnalysisReport'
+  | 'payeeLocations';
+
+/**
+ * Cross-device preferences. These sync across devices when they are changed.
+ */
+export type SyncedPrefs = Partial<
+  Record<
+    | 'budgetType'
+    | 'upcomingScheduledTransactionLength'
+    | 'firstDayOfWeekIdx'
+    | 'dateFormat'
+    | 'numberFormat'
+    | 'hideFraction'
+    | 'isPrivacyEnabled'
+    | 'currencySymbolPosition'
+    | 'currencySpaceBetweenAmountAndSymbol'
+    | 'defaultCurrencyCode'
+    | `show-account-${string}-net-worth-chart`
+    | `side-nav.show-balance-history-${string}`
+    | `show-balances-${string}`
+    | `show-extra-balances-${string}`
+    | `hide-cleared-${string}`
+    | `hide-reconciled-${string}`
+    // TODO: pull from src/components/modals/ImportTransactions.js
+    | `parse-date-${string}-${'csv' | 'qif'}`
+    | `csv-mappings-${string}`
+    | `csv-delimiter-${string}`
+    | `csv-skip-start-lines-${string}`
+    | `csv-skip-end-lines-${string}`
+    | `csv-in-out-mode-${string}`
+    | `csv-out-value-${string}`
+    | `csv-has-header-${string}`
+    | `custom-sync-mappings-${string}`
+    | `sync-import-pending-${string}`
+    | `sync-reimport-deleted-${string}`
+    | `sync-import-notes-${string}`
+    | `sync-import-transactions-${string}`
+    | `sync-update-dates-${string}`
+    | `ofx-fallback-missing-payee-${string}`
+    | `ofx-swap-payee-memo-${string}`
+    | `qif-swap-payee-memo-${string}`
+    | `camt-swap-payee-memo-${string}`
+    | `flip-amount-${string}-${'csv' | 'qif'}`
+    | `flags.${FeatureFlag}`
+    | `learn-categories`,
+    string
+  >
+>;
+
+/**
+ * Preferences that are stored in the `metadata.json` file along with the
+ * core database.
+ */
+export type MetadataPrefs = Partial<{
+  budgetName: string;
+  id: string;
+  lastUploaded: string;
+  cloudFileId: string;
+  groupId: string;
+  encryptKeyId: string;
+  lastSyncedTimestamp: string;
+  resetClock: boolean;
+  lastScheduleRun: string;
+  userId: string; // TODO: delete this (unused)
+}>;
+
+/**
+ * Local preferences applicable to a single device. Stored in local storage.
+ */
+export type LocalPrefs = Partial<{
+  'ui.showClosedAccounts': boolean;
+  'expand-splits': boolean;
+  'budget.collapsed': string[];
+  'budget.summaryCollapsed': boolean;
+  'budget.showHiddenCategories': boolean;
+  'budget.startMonth': string;
+  'flags.updateNotificationShownForVersion': string;
+  'schedules.showCompleted': boolean;
+  reportsViewLegend: boolean;
+  reportsViewSummary: boolean;
+  reportsViewLabel: boolean;
+  sidebarWidth: number;
+  'mobile.showSpentColumn': boolean;
+}>;
+
+export type Theme =
+  | 'light'
+  | 'dark'
+  | 'auto'
+  | 'midnight'
+  | 'development'
+  | string;
+export type DarkTheme = 'dark' | 'midnight';
+
+// GlobalPrefs are the parsed global-store.json values
+export type GlobalPrefs = Partial<{
+  floatingSidebar: boolean;
+  maxMonths: number;
+  categoryExpandedState: number;
+  keyId?: string;
+  language: string;
+  theme: Theme;
+  preferredDarkTheme: DarkTheme;
+  plugins: boolean;
+  pluginThemes: Record<
+    string,
+    {
+      id: string;
+      displayName: string;
+      description?: string;
+      baseTheme?: 'light' | 'dark' | 'midnight';
+      colors: Record<string, string>;
+    }
+  >; // Complete plugin theme metadata
+  installedCustomLightTheme?: string; // JSON of InstalledTheme for light custom theme (also used as single custom theme in non-auto mode)
+  installedCustomDarkTheme?: string; // JSON of InstalledTheme for auto-mode dark custom theme
+  documentDir: string; // Electron only
+  serverSelfSignedCert: string; // Electron only
+  syncServerConfig?: {
+    // Electron only
+    autoStart?: boolean;
+    port?: number;
+  };
+  notifyWhenUpdateIsAvailable: boolean;
+}>;
+
+// 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"
+  'category-expanded-state'?: string; // "0" or "1" or "2"
+  'document-dir'?: GlobalPrefs['documentDir'];
+  'encrypt-key'?: string;
+  language?: GlobalPrefs['language'];
+  theme?: GlobalPrefs['theme'];
+  'preferred-dark-theme'?: GlobalPrefs['preferredDarkTheme'];
+  'installed-custom-theme'?: GlobalPrefs['installedCustomLightTheme'];
+  'installed-custom-dark-theme'?: GlobalPrefs['installedCustomDarkTheme'];
+  plugins?: string; // "true" or "false"
+  'plugin-theme'?: string; // JSON string of complete plugin theme (current selected plugin theme)
+  'server-self-signed-cert'?: GlobalPrefs['serverSelfSignedCert'];
+  syncServerConfig?: GlobalPrefs['syncServerConfig'];
+  notifyWhenUpdateIsAvailable?: GlobalPrefs['notifyWhenUpdateIsAvailable'];
+}>;
+
+export type AuthMethods = 'password' | 'openid';
+
+export type ServerPrefs = Partial<{
+  'flags.plugins': 'true' | 'false';
+}>;

package/src/types/server-events.ts

@@ -0,0 +1,86 @@
+import type { Backup } from '../server/budgetfiles/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 type ServerEvents = {
+  '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': ApiFetchRedirectedEvent;
+};

package/src/types/server-handlers.ts

@@ -0,0 +1,27 @@
+import type { QueryState } from '../shared/query';
+
+export type ServerHandlers = {
+  undo: () => Promise<void>;
+  redo: () => Promise<void>;
+
+  'make-filters-from-conditions': (arg: {
+    conditions: unknown;
+    applySpecialCases?: boolean;
+  }) => Promise<{ filters: unknown[] }>;
+
+  // oxlint-disable-next-line typescript/no-explicit-any
+  query: (query: QueryState) => Promise<{ data: any; dependencies: string[] }>;
+
+  'get-server-version': () => Promise<
+    { error: 'no-server' } | { error: 'network-failure' } | { version: string }
+  >;
+
+  'get-server-url': () => Promise<string | null>;
+
+  'set-server-url': (arg: {
+    url: string;
+    validate?: boolean;
+  }) => Promise<{ error?: string }>;
+
+  'app-focused': () => Promise<void>;
+};

package/src/types/util.ts

@@ -0,0 +1,26 @@
+export type EmptyObject = Record<never, never>;
+
+export type StripNever<T> = {
+  [K in keyof T as T[K] extends never ? never : K]: T[K];
+};
+
+export type EverythingButIdOptional<T extends { id: unknown }> = {
+  id: T['id'];
+} & Partial<Omit<T, 'id'>>;
+
+export type WithRequired<T, K extends keyof T> = T & Required<Pick<T, K>>;
+
+export type WithOptional<T, K extends keyof T> = Omit<T, K> &
+  Partial<Pick<T, K>>;
+
+// Allows use of object literals inside child elements of `Trans` tags
+// see https://github.com/i18next/react-i18next/issues/1483
+// oxlint-disable-next-line typescript/no-explicit-any
+export type TransObjectLiteral = any;
+
+export type AtLeastOne<T extends Record<string, unknown>> =
+  keyof T extends infer K
+    ? K extends string
+      ? Pick<T, K & keyof T> & Partial<T>
+      : never
+    : never;

package/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "noEmit": false,
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "outDir": "lib-dist/decl",
+    "rootDir": ".",
+    "tsBuildInfoFile": "lib-dist/decl/.tsbuildinfo",
+    "types": ["vite/client", "vitest/globals", "node"],
+    "paths": {
+      // Allow importing from hyperformula's internal typings for custom function plugins
+      "hyperformula/typings/*": ["../../node_modules/hyperformula/typings/*"]
+    },
+    "plugins": [{ "name": "typescript-strict-plugin", "paths": ["."] }]
+  },
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.tsx",
+    "typings/**/*.ts",
+    "typings/**/*.d.ts",
+    "migrations/**/*.js",
+    "src/server/tests/mockData.json"
+  ],
+  "exclude": [
+    "node_modules",
+    "build",
+    "lib-dist",
+    "**/*.test.ts",
+    "**/*.spec.ts"
+  ]
+}

package/typings/pegjs.ts

@@ -0,0 +1 @@
+declare module '*.pegjs';

package/typings/process-worker.ts

@@ -0,0 +1,12 @@
+import type { MessagePort } from 'worker_threads';
+
+declare global {
+  namespace NodeJS {
+    // oxlint-disable-next-line typescript/consistent-type-definitions -- global Process augmentation requires interface for declaration merging
+    interface Process {
+      parentPort?: MessagePort;
+    }
+  }
+}
+
+export {};

package/typings/vite-plugin-peggy-loader.ts

@@ -0,0 +1 @@
+declare module 'vite-plugin-peggy-loader';

package/typings/window.ts

@@ -0,0 +1,62 @@
+import type EventEmitter from 'events';
+
+export type IpcClient = {
+  on: EventEmitter['on'];
+  emit: (name: string, data: unknown) => void;
+};
+
+type FileDialogOptions = {
+  properties?: Array<'openFile' | 'openDirectory'>;
+  filters?: {
+    name: string;
+    extensions: string[];
+  }[];
+};
+
+type Actual = {
+  IS_DEV: boolean;
+  ACTUAL_VERSION: string;
+  openURLInBrowser: (url: string) => void;
+  openInFileManager: (filepath: string) => void;
+  saveFile: (
+    contents: string | Buffer,
+    filename: string,
+    dialogTitle?: string,
+  ) => Promise<void>;
+  openFileDialog: (options: FileDialogOptions) => Promise<string[]>;
+  relaunch: () => void;
+  reload: (() => Promise<void>) | undefined;
+  restartElectronServer: () => void;
+  moveBudgetDirectory: (
+    currentBudgetDirectory: string,
+    newDirectory: string,
+  ) => Promise<void>;
+  applyAppUpdate: () => Promise<void>;
+  ipcConnect: (callback: (client: IpcClient) => void) => void;
+  getServerSocket: () => Promise<Worker | null>;
+  setTheme: (theme: string) => void;
+  logToTerminal: (...args: unknown[]) => void;
+  onEventFromMain: (
+    event: string,
+    listener: (...args: unknown[]) => void,
+  ) => void;
+  isUpdateReadyForDownload: () => boolean;
+  waitForUpdateReadyForDownload: () => Promise<void>;
+  startSyncServer: () => Promise<void>;
+  stopSyncServer: () => Promise<void>;
+  isSyncServerRunning: () => Promise<boolean>;
+  startOAuthServer: () => Promise<string>;
+};
+
+declare global {
+  var Actual: Actual;
+
+  // oxlint-disable-next-line typescript/consistent-type-definitions -- global Window augmentation requires interface
+  interface Window {
+    Actual: Actual;
+  }
+
+  var IS_TESTING: boolean;
+
+  var currentMonth: string | null;
+}