@actual-app/core 26.3.0

package/src/types/models/gocardless.ts

@@ -0,0 +1,84 @@
+export type GoCardlessToken = {
+  id: string;
+  accounts: SyncServerGoCardlessAccount[];
+};
+
+export type GoCardlessInstitution = {
+  id: string;
+  name: string;
+  bic?: string;
+  transaction_total_days?: string;
+  countries: string[];
+  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;
+};
+
+export type SyncServerGoCardlessAccount = {
+  balance: number;
+  institution: string | { name: string };
+  account_id: string;
+  mask: string;
+  name: string;
+  official_name: string;
+};

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

@@ -0,0 +1,56 @@
+/**
+ * Represents a transaction object specifically for import operations.
+ * This type is used when importing transactions from external sources.
+ */
+export type ImportTransactionEntity = {
+  /** Required. The ID of the account this transaction belongs to */
+  account: string;
+
+  /** Required. Transaction date in YYYY-MM-DD format */
+  date: string;
+
+  /** A currency amount as an integer representing the value without decimal places.
+   * For example, USD amount of $120.30 would be 12030 */
+  amount?: number;
+
+  /** In a create/import request, this overrides payee_name.
+   * Should be an existing payee ID */
+  payee?: string | null;
+
+  /** If given, a payee will be created with this name.
+   * If this matches an already existing payee, that payee will be used.
+   * Only available in create/import requests */
+  payee_name?: string;
+
+  /** This can be anything. Meant to represent the raw description when importing,
+   * allowing the user to see the original value */
+  imported_payee?: string;
+
+  /** The ID of the category to assign to this transaction */
+  category?: string;
+
+  /** Any additional notes for the transaction */
+  notes?: string;
+
+  /** A unique id usually given by the bank, if importing.
+   * Use this to avoid duplicate transactions */
+  imported_id?: string;
+
+  /** If a transfer, the id of the corresponding transaction in the other account.
+   * You should not change this for existing transfers.
+   * Only set this when importing */
+  transfer_id?: string;
+
+  /** A flag indicating if the transaction has cleared or not */
+  cleared?: boolean;
+
+  /** An array of subtransactions for a split transaction.
+   * Only available in get or create/import requests.
+   * If amounts don't equal total amount, API call will succeed but error will show in app */
+  subtransactions?: Array<{
+    /** The only required field for subtransactions */
+    amount: number;
+    category?: string;
+    notes?: string;
+  }>;
+};

package/src/types/models/index.ts

@@ -0,0 +1,23 @@
+export type * from './account';
+export type * from './bank';
+export type * from './bank-sync';
+export type * from './category';
+export type * from './category-group';
+export type * from './dashboard';
+export type * from './gocardless';
+export type * from './import-transaction';
+export type * from './nearby-payee';
+export type * from './note';
+export type * from './openid';
+export type * from './payee';
+export type * from './payee-location';
+export type * from './pluggyai';
+export type * from './reports';
+export type * from './rule';
+export type * from './schedule';
+export type * from './simplefin';
+export type * from './transaction';
+export type * from './transaction-filter';
+export type * from './user';
+export type * from './user-access';
+export type * from './tags';

package/src/types/models/nearby-payee.ts

@@ -0,0 +1,7 @@
+import type { PayeeEntity } from './payee';
+import type { PayeeLocationEntity } from './payee-location';
+
+export type NearbyPayeeEntity = {
+  payee: PayeeEntity;
+  location: PayeeLocationEntity;
+};

package/src/types/models/note.ts

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

package/src/types/models/openid.ts

@@ -0,0 +1,8 @@
+export type OpenIdConfig = {
+  selectedProvider: string;
+  issuer?: string;
+  client_id: string;
+  client_secret: string;
+  server_hostname: string;
+  discoveryURL: string;
+};

package/src/types/models/payee-location.ts

@@ -0,0 +1,8 @@
+export type PayeeLocationEntity = {
+  id: string;
+  payee_id: string;
+  latitude: number;
+  longitude: number;
+  created_at: number;
+  distance?: number;
+};

package/src/types/models/payee.ts

@@ -0,0 +1,10 @@
+import type { AccountEntity } from './account';
+
+export type PayeeEntity = {
+  id: string;
+  name: string;
+  transfer_acct?: AccountEntity['id'];
+  favorite?: boolean;
+  learn_categories?: boolean;
+  tombstone?: boolean;
+};

package/src/types/models/pluggyai.ts

@@ -0,0 +1,19 @@
+export type PluggyAiOrganization = {
+  name: string;
+  domain: string;
+};
+
+export type PluggyAiAccount = {
+  id: string;
+  name: string;
+  org: PluggyAiOrganization;
+};
+
+export type SyncServerPluggyAiAccount = {
+  balance: number;
+  account_id: string;
+  institution?: string;
+  orgDomain?: string | null;
+  orgId?: string;
+  name: string;
+};

package/src/types/models/reports.ts

@@ -0,0 +1,144 @@
+import type { RuleConditionEntity } from './rule';
+
+export type CustomReportEntity = {
+  id: string;
+  name: string;
+  startDate: string;
+  endDate: string;
+  isDateStatic: boolean;
+  dateRange: string;
+  mode: string;
+  groupBy: string;
+  interval: string;
+  balanceType: string;
+  sortBy?: sortByOpType;
+  showEmpty: boolean;
+  showOffBudget: boolean;
+  showHiddenCategories: boolean;
+  includeCurrentInterval: boolean;
+  showUncategorized: boolean;
+  trimIntervals: boolean;
+  graphType: string;
+  conditions?: RuleConditionEntity[];
+  conditionsOp: 'and' | 'or';
+  metadata?: GroupedEntity;
+  tombstone?: boolean;
+};
+
+export type balanceTypeOpType =
+  | 'totalAssets'
+  | 'totalDebts'
+  | 'totalTotals'
+  | 'netAssets'
+  | 'netDebts';
+
+export type sortByOpType = 'asc' | 'desc' | 'name' | 'budget';
+
+export type SpendingMonthEntity = Record<
+  string | number,
+  {
+    cumulative: number;
+    daily: number;
+    date: string;
+    month: string;
+  }
+>;
+
+export type SpendingDataEntity = {
+  date: string;
+  totalAssets: number;
+  totalDebts: number;
+  totalTotals: number;
+  cumulative: number;
+};
+
+export type SpendingEntity = {
+  intervalData: {
+    months: SpendingMonthEntity;
+    day: string;
+    average: number;
+    compare: number;
+    compareTo: number;
+    budget: number;
+  }[];
+  startDate?: string;
+  endDate?: string;
+  totalDebts: number;
+  totalAssets: number;
+  totalTotals: number;
+};
+
+export type DataEntity = {
+  data?: GroupedEntity[];
+  intervalData: IntervalEntity[];
+  groupedData?: GroupedEntity[] | null;
+  legend?: LegendEntity[];
+  startDate?: string;
+  endDate?: string;
+  totalDebts: number;
+  totalAssets: number;
+  netAssets: number;
+  netDebts: number;
+  totalTotals: number;
+};
+
+export type LegendEntity = {
+  name: string;
+  id: string | null;
+  color: string;
+  dataKey: string; // Uses id for unique data lookup when categories have same name
+};
+
+export type IntervalEntity = {
+  date?: string;
+  change?: number;
+  intervalStartDate?: string;
+  intervalEndDate?: string;
+  totalAssets: number;
+  totalDebts: number;
+  netAssets: number;
+  netDebts: number;
+  totalTotals: number;
+};
+
+export type GroupedEntity = {
+  id: string;
+  name: string;
+  date?: string;
+  intervalData: IntervalEntity[];
+  totalAssets: number;
+  totalDebts: number;
+  totalTotals: number;
+  netAssets: number;
+  netDebts: number;
+  categories?: GroupedEntity[];
+};
+
+export type Interval = {
+  interval: string;
+};
+
+export type CustomReportData = {
+  id: string;
+  name: string;
+  start_date: string;
+  end_date: string;
+  date_static: number;
+  date_range: string;
+  mode: string;
+  group_by: string;
+  sort_by: sortByOpType;
+  balance_type: string;
+  show_empty: number;
+  show_offbudget: number;
+  show_hidden: number;
+  include_current: number;
+  show_uncategorized: number;
+  trim_intervals: number;
+  graph_type: string;
+  conditions?: RuleConditionEntity[];
+  conditions_op: 'and' | 'or';
+  metadata?: GroupedEntity;
+  interval: string;
+  color_scheme?: string;
+};

package/src/types/models/rule.ts

@@ -0,0 +1,174 @@
+import type { RecurConfig, ScheduleEntity } from './schedule';
+
+export type NewRuleEntity = {
+  stage: 'pre' | null | 'post';
+  conditionsOp: 'or' | 'and';
+  conditions: RuleConditionEntity[];
+  actions: RuleActionEntity[];
+  tombstone?: boolean;
+};
+
+export type RuleEntity = {
+  id: string;
+} & NewRuleEntity;
+
+export type RuleConditionOp = RuleConditionEntity['op'];
+
+export type FieldValueTypes = {
+  account: string;
+  amount: number;
+  category: string;
+  category_group: string;
+  date: string | RecurConfig;
+  notes: string;
+  payee: string;
+  payee_name: string;
+  imported_payee: string;
+  saved: string;
+  transfer: boolean;
+  parent: boolean;
+  cleared: boolean;
+  reconciled: boolean;
+};
+
+type BaseConditionEntity<
+  Field extends keyof FieldValueTypes,
+  Op extends RuleConditionOp,
+> = {
+  field: Field;
+  op: Op;
+  value: Op extends 'oneOf' | 'notOneOf'
+    ? Array<FieldValueTypes[Field]>
+    : Op extends 'isbetween'
+      ? { num1: number; num2: number }
+      : FieldValueTypes[Field];
+  options?: {
+    inflow?: boolean;
+    outflow?: boolean;
+    month?: boolean;
+    year?: boolean;
+  };
+  conditionsOp?: 'and' | 'or';
+  type?: 'id' | 'boolean' | 'date' | 'number' | 'string';
+  customName?: string;
+  queryFilter?: Record<string, { $oneof: string[] }>;
+};
+
+export type RuleConditionEntity =
+  | BaseConditionEntity<
+      'account',
+      | 'is'
+      | 'isNot'
+      | 'oneOf'
+      | 'notOneOf'
+      | 'contains'
+      | 'doesNotContain'
+      | 'matches'
+      | 'onBudget'
+      | 'offBudget'
+    >
+  | BaseConditionEntity<
+      'category',
+      | 'is'
+      | 'isNot'
+      | 'oneOf'
+      | 'notOneOf'
+      | 'contains'
+      | 'doesNotContain'
+      | 'matches'
+    >
+  | BaseConditionEntity<
+      'category_group',
+      | 'is'
+      | 'isNot'
+      | 'oneOf'
+      | 'notOneOf'
+      | 'contains'
+      | 'doesNotContain'
+      | 'matches'
+    >
+  | BaseConditionEntity<
+      'amount',
+      'is' | 'isapprox' | 'isbetween' | 'gt' | 'gte' | 'lt' | 'lte'
+    >
+  | BaseConditionEntity<
+      'date',
+      'is' | 'isapprox' | 'isbetween' | 'gt' | 'gte' | 'lt' | 'lte'
+    >
+  | BaseConditionEntity<
+      'notes',
+      'is' | 'isNot' | 'contains' | 'doesNotContain' | 'matches' | 'hasTags'
+    >
+  | BaseConditionEntity<
+      'payee',
+      | 'is'
+      | 'isNot'
+      | 'oneOf'
+      | 'notOneOf'
+      | 'contains'
+      | 'doesNotContain'
+      | 'matches'
+    >
+  | BaseConditionEntity<
+      'imported_payee',
+      | 'is'
+      | 'isNot'
+      | 'oneOf'
+      | 'notOneOf'
+      | 'contains'
+      | 'doesNotContain'
+      | 'matches'
+    >
+  | BaseConditionEntity<'saved', 'is'>
+  | BaseConditionEntity<'cleared', 'is'>
+  | BaseConditionEntity<'reconciled', 'is'>
+  | BaseConditionEntity<'transfer', 'is'>;
+
+export type RuleActionEntity =
+  | SetRuleActionEntity
+  | SetSplitAmountRuleActionEntity
+  | LinkScheduleRuleActionEntity
+  | PrependNoteRuleActionEntity
+  | AppendNoteRuleActionEntity
+  | DeleteTransactionRuleActionEntity;
+
+export type SetRuleActionEntity = {
+  field: string;
+  op: 'set';
+  value: unknown;
+  options?: {
+    template?: string;
+    formula?: string;
+    splitIndex?: number;
+  };
+  type?: string;
+};
+
+export type SetSplitAmountRuleActionEntity = {
+  op: 'set-split-amount';
+  value: number;
+  options?: {
+    splitIndex?: number;
+    method: 'fixed-amount' | 'fixed-percent' | 'remainder';
+  };
+};
+
+export type LinkScheduleRuleActionEntity = {
+  op: 'link-schedule';
+  value: ScheduleEntity;
+};
+
+export type PrependNoteRuleActionEntity = {
+  op: 'prepend-notes';
+  value: string;
+};
+
+export type AppendNoteRuleActionEntity = {
+  op: 'append-notes';
+  value: string;
+};
+
+export type DeleteTransactionRuleActionEntity = {
+  op: 'delete-transaction';
+  value: string;
+};

package/src/types/models/schedule.ts

@@ -0,0 +1,49 @@
+import type { AccountEntity } from './account';
+import type { PayeeEntity } from './payee';
+import type { RuleConditionEntity, RuleEntity } from './rule';
+
+export type RecurPattern = {
+  value: number;
+  type: 'SU' | 'MO' | 'TU' | 'WE' | 'TH' | 'FR' | 'SA' | 'day';
+};
+
+export type RecurConfig = {
+  frequency: 'daily' | 'weekly' | 'monthly' | 'yearly';
+  interval?: number;
+  patterns?: RecurPattern[];
+  skipWeekend?: boolean;
+  start: string;
+  endMode?: 'never' | 'after_n_occurrences' | 'on_date';
+  endOccurrences?: number;
+  endDate?: string;
+  weekendSolveMode?: 'before' | 'after';
+};
+
+export type 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: number | { num1: number; num2: number };
+  _amountOp: string;
+  _date: RecurConfig | string;
+  _conditions: RuleConditionEntity[];
+  _actions: Array<{ op: unknown }>;
+};
+
+export type DiscoverScheduleEntity = {
+  id: ScheduleEntity['id'];
+  account: AccountEntity['id'];
+  payee: PayeeEntity['id'];
+  date: RecurConfig;
+  amount: ScheduleEntity['_amount'];
+  _conditions: ScheduleEntity['_conditions'];
+};

package/src/types/models/simplefin.ts

@@ -0,0 +1,28 @@
+import type { AccountEntity } from './account';
+import type { BankSyncResponse } from './bank-sync';
+
+export type SimpleFinOrganization = {
+  id: string;
+  name: string;
+  domain: string;
+};
+
+export type SimpleFinAccount = {
+  id: string;
+  name: string;
+  balance: number;
+  org: SimpleFinOrganization;
+};
+
+export type SimpleFinBatchSyncResponse = {
+  [accountId: NonNullable<AccountEntity['account_id']>]: BankSyncResponse;
+};
+
+export type SyncServerSimpleFinAccount = {
+  balance: number;
+  account_id: string;
+  institution?: string;
+  orgDomain?: string;
+  orgId?: string;
+  name: string;
+};

package/src/types/models/tags.ts

@@ -0,0 +1,6 @@
+export type TagEntity = {
+  id: string;
+  tag: string;
+  color?: string | null;
+  description?: string | null;
+};