@contractspec/lib.contracts 0.0.0-canary-20260113162409

package/dist/integrations/openbanking/contracts/accounts.d.ts

@@ -0,0 +1,289 @@
+import { AnyOperationSpec, OperationSpec } from "../../../operations/operation.js";
+import { OperationSpecRegistry } from "../../../operations/registry.js";
+import "../../../operations/index.js";
+import "../../../index.js";
+import * as _contractspec_lib_schema455 from "@contractspec/lib.schema";
+import { SchemaModel } from "@contractspec/lib.schema";
+
+//#region src/integrations/openbanking/contracts/accounts.d.ts
+declare const OpenBankingListAccounts: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  userId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  connectionId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: true;
+  };
+  includeBalances: {
+    type: _contractspec_lib_schema455.FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+  institutionId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: true;
+  };
+  cursor: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: true;
+  };
+  pageSize: {
+    type: _contractspec_lib_schema455.FieldType<number, number>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  accounts: {
+    type: SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: false;
+      };
+      tenantId: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: false;
+      };
+      userId: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: false;
+      };
+      connectionId: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: false;
+      };
+      externalId: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: false;
+      };
+      institutionId: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: false;
+      };
+      institutionName: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: false;
+      };
+      institutionLogoUrl: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: true;
+      };
+      iban: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: true;
+      };
+      bic: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: true;
+      };
+      accountType: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: false;
+      };
+      currency: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: false;
+      };
+      displayName: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: false;
+      };
+      accountNumberMasked: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: true;
+      };
+      productCode: {
+        type: _contractspec_lib_schema455.FieldType<string, string>;
+        isOptional: true;
+      };
+      balance: {
+        type: _contractspec_lib_schema455.FieldType<number, number>;
+        isOptional: true;
+      };
+      availableBalance: {
+        type: _contractspec_lib_schema455.FieldType<number, number>;
+        isOptional: true;
+      };
+      lastSyncedAt: {
+        type: _contractspec_lib_schema455.FieldType<Date, string>;
+        isOptional: false;
+      };
+      createdAt: {
+        type: _contractspec_lib_schema455.FieldType<Date, string>;
+        isOptional: false;
+      };
+      updatedAt: {
+        type: _contractspec_lib_schema455.FieldType<Date, string>;
+        isOptional: false;
+      };
+      metadata: {
+        type: _contractspec_lib_schema455.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: true;
+      };
+    }>;
+    isOptional: false;
+    isArray: true;
+  };
+  nextCursor: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: true;
+  };
+  hasMore: {
+    type: _contractspec_lib_schema455.FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+}>, undefined>;
+declare const OpenBankingGetAccount: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  accountId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  includeBalances: {
+    type: _contractspec_lib_schema455.FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+  includeLatestTransactions: {
+    type: _contractspec_lib_schema455.FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  tenantId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  userId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  connectionId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  externalId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  institutionId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  institutionName: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  institutionLogoUrl: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: true;
+  };
+  iban: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: true;
+  };
+  bic: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: true;
+  };
+  accountType: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  currency: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  displayName: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  accountNumberMasked: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: true;
+  };
+  productCode: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: true;
+  };
+  balance: {
+    type: _contractspec_lib_schema455.FieldType<number, number>;
+    isOptional: true;
+  };
+  availableBalance: {
+    type: _contractspec_lib_schema455.FieldType<number, number>;
+    isOptional: true;
+  };
+  lastSyncedAt: {
+    type: _contractspec_lib_schema455.FieldType<Date, string>;
+    isOptional: false;
+  };
+  createdAt: {
+    type: _contractspec_lib_schema455.FieldType<Date, string>;
+    isOptional: false;
+  };
+  updatedAt: {
+    type: _contractspec_lib_schema455.FieldType<Date, string>;
+    isOptional: false;
+  };
+  metadata: {
+    type: _contractspec_lib_schema455.FieldType<Record<string, unknown>, Record<string, unknown>>;
+    isOptional: true;
+  };
+}>, undefined>;
+declare const OpenBankingSyncAccounts: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  userId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: true;
+  };
+  connectionId: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isOptional: false;
+  };
+  accountIds: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isArray: true;
+    isOptional: true;
+  };
+  forceFullRefresh: {
+    type: _contractspec_lib_schema455.FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+  triggerWorkflows: {
+    type: _contractspec_lib_schema455.FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  synced: {
+    type: _contractspec_lib_schema455.FieldType<number, number>;
+    isOptional: false;
+  };
+  failed: {
+    type: _contractspec_lib_schema455.FieldType<number, number>;
+    isOptional: false;
+  };
+  errors: {
+    type: _contractspec_lib_schema455.FieldType<string, string>;
+    isArray: true;
+    isOptional: true;
+  };
+  nextSyncSuggestedAt: {
+    type: _contractspec_lib_schema455.FieldType<Date, string>;
+    isOptional: true;
+  };
+}>, undefined>;
+declare const openBankingAccountContracts: Record<string, AnyOperationSpec>;
+declare function registerOpenBankingAccountContracts(registry: OperationSpecRegistry): OperationSpecRegistry;
+//#endregion
+export { OpenBankingGetAccount, OpenBankingListAccounts, OpenBankingSyncAccounts, openBankingAccountContracts, registerOpenBankingAccountContracts };

package/dist/integrations/openbanking/contracts/accounts.js

@@ -0,0 +1,236 @@
+import { defineCommand, defineQuery } from "../../../operations/operation.js";
+import "../../../operations/index.js";
+import { BankAccountRecord } from "../models.js";
+import { OPENBANKING_TELEMETRY_EVENTS } from "../telemetry.js";
+import { ScalarTypeEnum, SchemaModel } from "@contractspec/lib.schema";
+
+//#region src/integrations/openbanking/contracts/accounts.ts
+const OpenBankingListAccountsInput = new SchemaModel({
+	name: "OpenBankingListAccountsInput",
+	description: "Parameters for listing bank accounts through the open banking provider.",
+	fields: {
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		userId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		connectionId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: true
+		},
+		includeBalances: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		},
+		institutionId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		cursor: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		pageSize: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		}
+	}
+});
+const OpenBankingListAccountsOutput = new SchemaModel({
+	name: "OpenBankingListAccountsOutput",
+	description: "Paginated list of bank accounts available to the tenant and user.",
+	fields: {
+		accounts: {
+			type: BankAccountRecord,
+			isOptional: false,
+			isArray: true
+		},
+		nextCursor: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		hasMore: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		}
+	}
+});
+const OpenBankingGetAccountInput = new SchemaModel({
+	name: "OpenBankingGetAccountInput",
+	description: "Parameters for retrieving a specific bank account.",
+	fields: {
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		accountId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		includeBalances: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		},
+		includeLatestTransactions: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		}
+	}
+});
+const OpenBankingSyncAccountsInput = new SchemaModel({
+	name: "OpenBankingSyncAccountsInput",
+	description: "Command payload to trigger an account synchronisation against the open banking provider.",
+	fields: {
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		userId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: true
+		},
+		connectionId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		accountIds: {
+			type: ScalarTypeEnum.ID(),
+			isArray: true,
+			isOptional: true
+		},
+		forceFullRefresh: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		},
+		triggerWorkflows: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		}
+	}
+});
+const OpenBankingSyncAccountsOutput = new SchemaModel({
+	name: "OpenBankingSyncAccountsOutput",
+	description: "Result of a bank account synchronisation run.",
+	fields: {
+		synced: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: false
+		},
+		failed: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: false
+		},
+		errors: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isArray: true,
+			isOptional: true
+		},
+		nextSyncSuggestedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		}
+	}
+});
+const OpenBankingListAccounts = defineQuery({
+	meta: {
+		key: "openbanking.accounts.list",
+		version: "1.0.0",
+		description: "List bank accounts available to a tenant/user via Powens Open Banking.",
+		goal: "Provide downstream workflows with the set of accounts accessible via the configured open banking connection.",
+		context: "Used by Pocket Family Office dashboards and sync workflows to enumerate bank accounts prior to syncing balances or transactions.",
+		owners: ["@platform.finance"],
+		tags: [
+			"open-banking",
+			"powens",
+			"accounts"
+		],
+		stability: "experimental"
+	},
+	io: {
+		input: OpenBankingListAccountsInput,
+		output: OpenBankingListAccountsOutput
+	},
+	policy: { auth: "user" }
+});
+const OpenBankingGetAccount = defineQuery({
+	meta: {
+		key: "openbanking.accounts.get",
+		version: "1.0.0",
+		description: "Retrieve the canonical bank account record for the given account identifier.",
+		goal: "Allow user-facing experiences and automations to display up-to-date account metadata.",
+		context: "Invoked by UI surfaces and workflow automation steps that require detailed metadata for a specific bank account.",
+		owners: ["@platform.finance"],
+		tags: [
+			"open-banking",
+			"powens",
+			"accounts"
+		],
+		stability: "experimental"
+	},
+	io: {
+		input: OpenBankingGetAccountInput,
+		output: BankAccountRecord
+	},
+	policy: { auth: "user" }
+});
+const OpenBankingSyncAccounts = defineCommand({
+	meta: {
+		key: "openbanking.accounts.sync",
+		version: "1.0.0",
+		description: "Initiate a synchronisation run to refresh bank account metadata from Powens.",
+		goal: "Keep canonical bank account records aligned with the external open banking provider.",
+		context: "Triggered by scheduled workflows or manual operator actions to reconcile account metadata prior to transaction/balance syncs.",
+		owners: ["@platform.finance"],
+		tags: [
+			"open-banking",
+			"powens",
+			"accounts"
+		],
+		stability: "experimental"
+	},
+	io: {
+		input: OpenBankingSyncAccountsInput,
+		output: OpenBankingSyncAccountsOutput
+	},
+	policy: { auth: "admin" },
+	telemetry: {
+		success: {
+			event: { key: OPENBANKING_TELEMETRY_EVENTS.accountsSynced },
+			properties: ({ input, output }) => {
+				const payload = input;
+				const result = output;
+				return {
+					tenantId: payload?.tenantId,
+					connectionId: payload?.connectionId,
+					synced: result?.synced,
+					failed: result?.failed
+				};
+			}
+		},
+		failure: {
+			event: { key: OPENBANKING_TELEMETRY_EVENTS.accountsSyncFailed },
+			properties: ({ input, error }) => {
+				const payload = input;
+				return {
+					tenantId: payload?.tenantId,
+					connectionId: payload?.connectionId,
+					error: error instanceof Error ? error.message : String(error ?? "unknown")
+				};
+			}
+		}
+	}
+});
+const openBankingAccountContracts = {
+	OpenBankingListAccounts,
+	OpenBankingGetAccount,
+	OpenBankingSyncAccounts
+};
+function registerOpenBankingAccountContracts(registry) {
+	return registry.register(OpenBankingListAccounts).register(OpenBankingGetAccount).register(OpenBankingSyncAccounts);
+}
+
+//#endregion
+export { OpenBankingGetAccount, OpenBankingListAccounts, OpenBankingSyncAccounts, openBankingAccountContracts, registerOpenBankingAccountContracts };

package/dist/integrations/openbanking/contracts/balances.d.ts

@@ -0,0 +1,165 @@
+import { AnyOperationSpec, OperationSpec } from "../../../operations/operation.js";
+import { OperationSpecRegistry } from "../../../operations/registry.js";
+import "../../../operations/index.js";
+import "../../../index.js";
+import * as _contractspec_lib_schema375 from "@contractspec/lib.schema";
+import { SchemaModel } from "@contractspec/lib.schema";
+
+//#region src/integrations/openbanking/contracts/balances.d.ts
+declare const OpenBankingGetBalances: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema375.FieldType<string, string>;
+    isOptional: false;
+  };
+  accountId: {
+    type: _contractspec_lib_schema375.FieldType<string, string>;
+    isOptional: false;
+  };
+  balanceTypes: {
+    type: _contractspec_lib_schema375.FieldType<string, string>;
+    isArray: true;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  balances: {
+    type: SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      accountId: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      tenantId: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      connectionId: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      balanceType: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      currentBalance: {
+        type: _contractspec_lib_schema375.FieldType<number, number>;
+        isOptional: false;
+      };
+      availableBalance: {
+        type: _contractspec_lib_schema375.FieldType<number, number>;
+        isOptional: true;
+      };
+      currency: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      lastUpdatedAt: {
+        type: _contractspec_lib_schema375.FieldType<Date, string>;
+        isOptional: false;
+      };
+      createdAt: {
+        type: _contractspec_lib_schema375.FieldType<Date, string>;
+        isOptional: false;
+      };
+      metadata: {
+        type: _contractspec_lib_schema375.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: true;
+      };
+    }>;
+    isOptional: false;
+    isArray: true;
+  };
+  asOf: {
+    type: _contractspec_lib_schema375.FieldType<Date, string>;
+    isOptional: true;
+  };
+}>, undefined>;
+declare const OpenBankingRefreshBalances: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema375.FieldType<string, string>;
+    isOptional: false;
+  };
+  accountId: {
+    type: _contractspec_lib_schema375.FieldType<string, string>;
+    isOptional: false;
+  };
+  connectionId: {
+    type: _contractspec_lib_schema375.FieldType<string, string>;
+    isOptional: true;
+  };
+  balanceTypes: {
+    type: _contractspec_lib_schema375.FieldType<string, string>;
+    isArray: true;
+    isOptional: true;
+  };
+  forceRefresh: {
+    type: _contractspec_lib_schema375.FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  balances: {
+    type: SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      accountId: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      tenantId: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      connectionId: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      balanceType: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      currentBalance: {
+        type: _contractspec_lib_schema375.FieldType<number, number>;
+        isOptional: false;
+      };
+      availableBalance: {
+        type: _contractspec_lib_schema375.FieldType<number, number>;
+        isOptional: true;
+      };
+      currency: {
+        type: _contractspec_lib_schema375.FieldType<string, string>;
+        isOptional: false;
+      };
+      lastUpdatedAt: {
+        type: _contractspec_lib_schema375.FieldType<Date, string>;
+        isOptional: false;
+      };
+      createdAt: {
+        type: _contractspec_lib_schema375.FieldType<Date, string>;
+        isOptional: false;
+      };
+      metadata: {
+        type: _contractspec_lib_schema375.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: true;
+      };
+    }>;
+    isOptional: false;
+    isArray: true;
+  };
+  refreshedAt: {
+    type: _contractspec_lib_schema375.FieldType<Date, string>;
+    isOptional: false;
+  };
+  errors: {
+    type: _contractspec_lib_schema375.FieldType<string, string>;
+    isArray: true;
+    isOptional: true;
+  };
+}>, undefined>;
+declare const openBankingBalanceContracts: Record<string, AnyOperationSpec>;
+declare function registerOpenBankingBalanceContracts(registry: OperationSpecRegistry): OperationSpecRegistry;
+//#endregion
+export { OpenBankingGetBalances, OpenBankingRefreshBalances, openBankingBalanceContracts, registerOpenBankingBalanceContracts };