@actual-app/api 6.7.0 → 6.8.0

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

@@ -0,0 +1,21 @@
+export type AccountEntity = {
+  id: string;
+  name: string;
+  offbudget: 0 | 1;
+  closed: 0 | 1;
+  sort_order: number;
+  tombstone: 0 | 1;
+} & (_SyncFields<true> | _SyncFields<false>);
+
+type _SyncFields<T> = {
+  account_id: T extends true ? string : null;
+  bank: T extends true ? string : null;
+  mask: T extends true ? string : null; // end of bank account number
+  official_name: T extends true ? string : null;
+  balance_current: T extends true ? number : null;
+  balance_available: T extends true ? number : null;
+  balance_limit: T extends true ? number : null;
+  account_sync_source: T extends true ? AccountSyncSource : null;
+};
+
+export type AccountSyncSource = 'simpleFin' | 'goCardless';

package/@types/loot-core/types/models/category-group.d.ts

@@ -0,0 +1,11 @@
+import { CategoryEntity } from './category';
+
+export interface CategoryGroupEntity {
+  id?: string;
+  name: string;
+  is_income?: boolean;
+  sort_order?: number;
+  tombstone?: boolean;
+  hidden?: boolean;
+  categories?: CategoryEntity[];
+}

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

@@ -0,0 +1,9 @@
+export interface CategoryEntity {
+  id?: string;
+  name: string;
+  is_income?: boolean;
+  cat_group?: string;
+  sort_order?: number;
+  tombstone?: boolean;
+  hidden?: boolean;
+}

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

@@ -0,0 +1,14 @@
+export type GoCardlessToken = {
+  id: string;
+  accounts: unknown[];
+};
+
+export type GoCardlessInstitution = {
+  id: string;
+  name: string;
+  bic?: string;
+  transaction_total_days?: string;
+  countries: string[];
+  logo: string;
+  identification_codes: string[];
+};

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

@@ -0,0 +1,12 @@
+export type * from './account';
+export type * from './category';
+export type * from './category-group';
+export type * from './gocardless';
+export type * from './simplefin';
+export type * from './note';
+export type * from './payee';
+export type * from './reports';
+export type * from './rule';
+export type * from './schedule';
+export type * from './transaction';
+export type * from './transaction-filter';

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

@@ -0,0 +1,4 @@
+export type NoteEntity = {
+  id: string;
+  note: string;
+};

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

@@ -0,0 +1,10 @@
+export interface NewPayeeEntity {
+  id?: string;
+  name: string;
+  transfer_acct?: string;
+  tombstone?: boolean;
+}
+
+export interface PayeeEntity extends NewPayeeEntity {
+  id: string;
+}

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

@@ -0,0 +1,123 @@
+import { CategoryEntity } from './category';
+import { type RuleConditionEntity } from './rule';
+
+export interface CustomReportEntity {
+  id: string;
+  name: string;
+  startDate: string;
+  endDate: string;
+  isDateStatic: boolean;
+  dateRange: string;
+  mode: string;
+  groupBy: string;
+  interval: string;
+  balanceType: string;
+  showEmpty: boolean;
+  showOffBudget: boolean;
+  showHiddenCategories: boolean;
+  showUncategorized: boolean;
+  selectedCategories?: CategoryEntity[];
+  graphType: string;
+  conditions?: RuleConditionEntity[];
+  conditionsOp: string;
+  data?: GroupedEntity;
+  tombstone?: boolean;
+}
+
+export type SpendingMonthEntity = Record<
+  string | number,
+  {
+    cumulative: number;
+    daily: number;
+    date: string;
+    month: string;
+  }
+>;
+
+export interface SpendingDataEntity {
+  date: string;
+  totalAssets: number;
+  totalDebts: number;
+  totalTotals: number;
+  cumulative: number;
+}
+
+export interface SpendingEntity {
+  intervalData: {
+    months: SpendingMonthEntity;
+    day: string;
+    average: number;
+    thisMonth: number;
+    lastMonth: number;
+  }[];
+  startDate?: string;
+  endDate?: string;
+  totalDebts: number;
+  totalAssets: number;
+  totalTotals: number;
+}
+
+export interface DataEntity {
+  data?: GroupedEntity[];
+  intervalData: IntervalEntity[];
+  groupedData?: GroupedEntity[] | null;
+  legend?: LegendEntity[];
+  startDate?: string;
+  endDate?: string;
+  totalDebts: number;
+  totalAssets: number;
+  totalTotals: number;
+}
+
+type LegendEntity = {
+  name: string;
+  id: string | null;
+  color: string;
+};
+
+export type IntervalEntity = {
+  date?: string;
+  change?: number;
+  intervalStartDate?: string;
+  totalAssets: number;
+  totalDebts: number;
+  totalTotals: number;
+};
+
+export interface GroupedEntity {
+  id: string;
+  name: string;
+  date?: string;
+  intervalData: IntervalEntity[];
+  totalAssets: number;
+  totalDebts: number;
+  totalTotals: number;
+  categories?: GroupedEntity[];
+}
+
+export type Interval = {
+  interval: string;
+};
+
+export interface CustomReportData {
+  id: string;
+  name: string;
+  start_date: string;
+  end_date: string;
+  date_static: number;
+  date_range: string;
+  mode: string;
+  group_by: string;
+  balance_type: string;
+  show_empty: number;
+  show_offbudget: number;
+  show_hidden: number;
+  show_uncategorized: number;
+  selected_categories?: CategoryEntity[];
+  graph_type: string;
+  conditions?: RuleConditionEntity[];
+  conditions_op: string;
+  metadata?: GroupedEntity;
+  interval: string;
+  color_scheme?: string;
+}

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

@@ -0,0 +1,71 @@
+import { type ScheduleEntity } from './schedule';
+
+export interface NewRuleEntity {
+  stage: string;
+  conditionsOp: 'any' | 'and';
+  conditions: RuleConditionEntity[];
+  actions: RuleActionEntity[];
+  tombstone?: boolean;
+}
+
+export interface RuleEntity extends NewRuleEntity {
+  id: string;
+}
+
+export type RuleConditionOp =
+  | 'is'
+  | 'isNot'
+  | 'oneOf'
+  | 'notOneOf'
+  | 'isapprox'
+  | 'isbetween'
+  | 'gt'
+  | 'gte'
+  | 'lt'
+  | 'lte'
+  | 'contains'
+  | 'doesNotContain';
+
+export interface RuleConditionEntity {
+  field?: string;
+  op?: RuleConditionOp;
+  value?: string | string[] | number | boolean;
+  options?: {
+    inflow?: boolean;
+    outflow?: boolean;
+    month?: boolean;
+    year?: boolean;
+  };
+  conditionsOp?: string;
+  type?: string;
+  customName?: string;
+}
+
+export type RuleActionEntity =
+  | SetRuleActionEntity
+  | SetSplitAmountRuleActionEntity
+  | LinkScheduleRuleActionEntity;
+
+export interface SetRuleActionEntity {
+  field: string;
+  op: 'set';
+  value: unknown;
+  options?: {
+    splitIndex?: number;
+  };
+  type?: string;
+}
+
+export interface SetSplitAmountRuleActionEntity {
+  op: 'set-split-amount';
+  value: number;
+  options?: {
+    splitIndex?: number;
+    method: 'fixed-amount' | 'fixed-percent' | 'remainder';
+  };
+}
+
+export interface LinkScheduleRuleActionEntity {
+  op: 'link-schedule';
+  value: ScheduleEntity;
+}

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

@@ -0,0 +1,58 @@
+import type { AccountEntity } from './account';
+import type { PayeeEntity } from './payee';
+import type { RuleEntity } from './rule';
+
+export interface ScheduleEntity {
+  id: string;
+  name?: string;
+  rule: RuleEntity['id'];
+  next_date: string;
+  completed: boolean;
+  posts_transaction: boolean;
+  tombstone: boolean;
+
+  // These are special fields that are actually pulled from the
+  // underlying rule
+  _payee: PayeeEntity['id'];
+  _account: AccountEntity['id'];
+  _amount: unknown;
+  _amountOp: string;
+  _date: {
+    interval: number;
+    patterns: {
+      value: number;
+      type: 'SU' | 'MO' | 'TU' | 'WE' | 'TH' | 'FR' | 'SA' | 'day';
+    }[];
+    skipWeekend: boolean;
+    start: string;
+    endMode: 'never' | 'after_n_occurrences' | 'on_date';
+    endOccurrences: number;
+    endDate: string;
+    weekendSolveMode: 'before' | 'after';
+    frequency: 'daily' | 'weekly' | 'monthly' | 'yearly';
+  };
+  _conditions: unknown;
+  _actions: unknown;
+}
+
+export type DiscoverScheduleEntity = {
+  id: ScheduleEntity['id'];
+  account: AccountEntity['id'];
+  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'];
+      }
+  >;
+};

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

@@ -0,0 +1,10 @@
+export type SimpleFinOrganization = {
+  name: string;
+  domain: string;
+};
+
+export type SimpleFinAccount = {
+  id: string;
+  name: string;
+  org: SimpleFinOrganization;
+};

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

@@ -0,0 +1,7 @@
+export interface TransactionFilterEntity {
+  id: string;
+  name: string;
+  conditions_op: string;
+  conditions: unknown;
+  tombstone: boolean;
+}

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

@@ -0,0 +1,40 @@
+import type { AccountEntity } from './account';
+import type { CategoryEntity } from './category';
+import type { PayeeEntity } from './payee';
+import type { ScheduleEntity } from './schedule';
+
+export interface NewTransactionEntity {
+  id?: string;
+  is_parent?: boolean;
+  is_child?: boolean;
+  parent_id?: string;
+  account: string;
+  category?: string;
+  amount: number;
+  payee?: string;
+  notes?: string;
+  date: string;
+  imported_id?: string;
+  imported_payee?: string;
+  starting_balance_flag?: boolean;
+  transfer_id?: string;
+  sort_order?: number;
+  cleared?: boolean;
+  reconciled?: boolean;
+  tombstone?: boolean;
+  schedule?: string;
+  subtransactions?: Omit<NewTransactionEntity, 'account' | 'date'>[];
+}
+
+export interface TransactionEntity
+  extends Omit<
+    NewTransactionEntity,
+    'account' | 'category' | 'payee' | 'schedule' | 'subtransactions'
+  > {
+  id: string;
+  account: AccountEntity;
+  category?: CategoryEntity;
+  payee?: PayeeEntity;
+  schedule?: ScheduleEntity;
+  subtransactions?: TransactionEntity[];
+}

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

@@ -0,0 +1,69 @@
+import { type numberFormats } from '../shared/util';
+
+export type FeatureFlag =
+  | 'reportBudget'
+  | 'goalTemplatesEnabled'
+  | 'customReports'
+  | 'spendingReport'
+  | 'simpleFinSync'
+  | 'splitsInRules';
+
+export type LocalPrefs = Partial<
+  {
+    firstDayOfWeekIdx: `${0 | 1 | 2 | 3 | 4 | 5 | 6}`;
+    dateFormat:
+      | 'MM/dd/yyyy'
+      | 'dd/MM/yyyy'
+      | 'yyyy-MM-dd'
+      | 'MM.dd.yyyy'
+      | 'dd.MM.yyyy';
+    numberFormat: (typeof numberFormats)[number]['value'];
+    hideFraction: boolean;
+    hideClosedAccounts: boolean;
+    hideMobileMessage: boolean;
+    isPrivacyEnabled: boolean;
+    budgetName: string;
+    'ui.showClosedAccounts': boolean;
+    'expand-splits': boolean;
+    [key: `show-extra-balances-${string}`]: boolean;
+    [key: `hide-cleared-${string}`]: boolean;
+    [key: `hide-reconciled-${string}`]: boolean;
+    'budget.collapsed': string[];
+    'budget.summaryCollapsed': boolean;
+    'budget.showHiddenCategories': boolean;
+    'budget.startMonth': string;
+    // TODO: pull from src/components/modals/ImportTransactions.js
+    [key: `parse-date-${string}-${'csv' | 'qif'}`]: string;
+    [key: `csv-mappings-${string}`]: string;
+    [key: `csv-delimiter-${string}`]: ',' | ';' | '\t';
+    [key: `csv-has-header-${string}`]: boolean;
+    [key: `ofx-fallback-missing-payee-${string}`]: boolean;
+    [key: `flip-amount-${string}-${'csv' | 'qif'}`]: boolean;
+    'flags.updateNotificationShownForVersion': string;
+    id: string;
+    isCached: boolean;
+    lastUploaded: string;
+    cloudFileId: string;
+    groupId: string;
+    budgetType: 'report' | 'rollover';
+    encryptKeyId: string;
+    lastSyncedTimestamp: string;
+    userId: string;
+    resetClock: boolean;
+    lastScheduleRun: string;
+    reportsViewLegend: boolean;
+    reportsViewSummary: boolean;
+    reportsViewLabel: boolean;
+    'mobile.showSpentColumn': boolean;
+  } & Record<`flags.${FeatureFlag}`, boolean>
+>;
+
+export type Theme = 'light' | 'dark' | 'auto' | 'midnight' | 'development';
+export type GlobalPrefs = Partial<{
+  floatingSidebar: boolean;
+  maxMonths: number;
+  autoUpdate: boolean;
+  keyId?: string;
+  theme: Theme;
+  documentDir: string; // Electron only
+}>;

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

@@ -0,0 +1,21 @@
+import { type UndoState } from '../server/undo';
+
+export interface ServerEvents {
+  'backups-updated': unknown;
+  '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 };
+  'undo-event': UndoState;
+}