@lssm/example.wealth-snapshot 0.0.0-canary-20251217060834 → 0.0.0-canary-20251217072406

package/dist/libs/contracts/dist/integrations/openbanking/contracts/balances.js

@@ -0,0 +1,159 @@
+import { SchemaModel } from "../../../schema/dist/SchemaModel.js";
+import { ScalarTypeEnum } from "../../../schema/dist/ScalarTypeEnum.js";
+import "../../../schema/dist/index.js";
+import { defineCommand, defineQuery } from "../../../spec.js";
+import { AccountBalanceRecord } from "../models.js";
+import { OPENBANKING_TELEMETRY_EVENTS } from "../telemetry.js";
+
+//#region ../../libs/contracts/dist/integrations/openbanking/contracts/balances.js
+const OpenBankingGetBalancesInput = new SchemaModel({
+	name: "OpenBankingGetBalancesInput",
+	description: "Parameters for retrieving bank account balances from the canonical ledger.",
+	fields: {
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		accountId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		balanceTypes: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isArray: true,
+			isOptional: true
+		}
+	}
+});
+const OpenBankingGetBalancesOutput = new SchemaModel({
+	name: "OpenBankingGetBalancesOutput",
+	description: "Canonical balances for a bank account.",
+	fields: {
+		balances: {
+			type: AccountBalanceRecord,
+			isOptional: false,
+			isArray: true
+		},
+		asOf: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		}
+	}
+});
+const OpenBankingRefreshBalancesInput = new SchemaModel({
+	name: "OpenBankingRefreshBalancesInput",
+	description: "Command payload to refresh balances for a bank account via the open banking provider.",
+	fields: {
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		accountId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		connectionId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: true
+		},
+		balanceTypes: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isArray: true,
+			isOptional: true
+		},
+		forceRefresh: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		}
+	}
+});
+const OpenBankingRefreshBalancesOutput = new SchemaModel({
+	name: "OpenBankingRefreshBalancesOutput",
+	description: "Result of a balance refresh against the open banking provider.",
+	fields: {
+		balances: {
+			type: AccountBalanceRecord,
+			isOptional: false,
+			isArray: true
+		},
+		refreshedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: false
+		},
+		errors: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isArray: true,
+			isOptional: true
+		}
+	}
+});
+const OpenBankingGetBalances = defineQuery({
+	meta: {
+		name: "openbanking.balances.get",
+		version: 1,
+		description: "Retrieve the latest cached balances for a bank account.",
+		goal: "Expose current and available balances required by dashboards and analytics.",
+		context: "Used by Pocket Family Office UI surfaces and automation steps that require balance totals prior to generating summaries.",
+		owners: ["platform.finance"],
+		tags: [
+			"open-banking",
+			"powens",
+			"balances"
+		],
+		stability: "experimental"
+	},
+	io: {
+		input: OpenBankingGetBalancesInput,
+		output: OpenBankingGetBalancesOutput
+	},
+	policy: { auth: "user" }
+});
+const OpenBankingRefreshBalances = defineCommand({
+	meta: {
+		name: "openbanking.balances.refresh",
+		version: 1,
+		description: "Refresh balances for a bank account via the configured open banking provider.",
+		goal: "Ensure canonical balance records reflect the latest values from Powens.",
+		context: "Triggered by scheduled workflows before generating summaries or forecasting cashflow.",
+		owners: ["platform.finance"],
+		tags: [
+			"open-banking",
+			"powens",
+			"balances"
+		],
+		stability: "experimental"
+	},
+	io: {
+		input: OpenBankingRefreshBalancesInput,
+		output: OpenBankingRefreshBalancesOutput
+	},
+	policy: { auth: "admin" },
+	telemetry: {
+		success: {
+			event: { name: OPENBANKING_TELEMETRY_EVENTS.balancesRefreshed },
+			properties: ({ input, output }) => {
+				const payload = input;
+				const result = output;
+				return {
+					tenantId: payload?.tenantId,
+					accountId: payload?.accountId,
+					refreshedAt: result?.refreshedAt,
+					balanceCount: Array.isArray(result?.balances) ? result?.balances.length : void 0
+				};
+			}
+		},
+		failure: {
+			event: { name: OPENBANKING_TELEMETRY_EVENTS.balancesRefreshFailed },
+			properties: ({ input, error }) => {
+				const payload = input;
+				return {
+					tenantId: payload?.tenantId,
+					accountId: payload?.accountId,
+					error: error instanceof Error ? error.message : String(error ?? "unknown")
+				};
+			}
+		}
+	}
+});
+
+//#endregion

package/dist/libs/contracts/dist/integrations/openbanking/contracts/index.js

@@ -0,0 +1,3 @@
+import "./accounts.js";
+import "./transactions.js";
+import "./balances.js";

package/dist/libs/contracts/dist/integrations/openbanking/contracts/transactions.js

@@ -0,0 +1,210 @@
+import { SchemaModel } from "../../../schema/dist/SchemaModel.js";
+import { ScalarTypeEnum } from "../../../schema/dist/ScalarTypeEnum.js";
+import "../../../schema/dist/index.js";
+import { defineCommand, defineQuery } from "../../../spec.js";
+import { BankTransactionRecord } from "../models.js";
+import { OPENBANKING_TELEMETRY_EVENTS } from "../telemetry.js";
+
+//#region ../../libs/contracts/dist/integrations/openbanking/contracts/transactions.js
+const OpenBankingListTransactionsInput = new SchemaModel({
+	name: "OpenBankingListTransactionsInput",
+	description: "Parameters for listing bank transactions from the canonical ledger.",
+	fields: {
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		accountId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		from: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		to: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		cursor: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		pageSize: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		direction: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		minimumAmount: {
+			type: ScalarTypeEnum.Float_unsecure(),
+			isOptional: true
+		},
+		maximumAmount: {
+			type: ScalarTypeEnum.Float_unsecure(),
+			isOptional: true
+		},
+		category: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		}
+	}
+});
+const OpenBankingListTransactionsOutput = new SchemaModel({
+	name: "OpenBankingListTransactionsOutput",
+	description: "Paginated list of transactions for a bank account.",
+	fields: {
+		transactions: {
+			type: BankTransactionRecord,
+			isOptional: false,
+			isArray: true
+		},
+		nextCursor: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		hasMore: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		}
+	}
+});
+const OpenBankingSyncTransactionsInput = new SchemaModel({
+	name: "OpenBankingSyncTransactionsInput",
+	description: "Command payload to synchronise transactions from the open banking provider into the canonical ledger.",
+	fields: {
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		accountId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		from: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		to: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		connectionId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: true
+		},
+		includePending: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		},
+		backfillDays: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		}
+	}
+});
+const OpenBankingSyncTransactionsOutput = new SchemaModel({
+	name: "OpenBankingSyncTransactionsOutput",
+	description: "Result of a transaction synchronisation run.",
+	fields: {
+		synced: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: false
+		},
+		failed: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: false
+		},
+		earliestSyncedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		latestSyncedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		nextSinceToken: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		errors: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isArray: true,
+			isOptional: true
+		}
+	}
+});
+const OpenBankingListTransactions = defineQuery({
+	meta: {
+		name: "openbanking.transactions.list",
+		version: 1,
+		description: "List bank transactions that have been normalised into the canonical ledger.",
+		goal: "Allow downstream analytics and UI surfaces to page through canonical bank transactions.",
+		context: "Used by Pocket Family Office dashboards, reconciliation workflows, and analytics data views.",
+		owners: ["platform.finance"],
+		tags: [
+			"open-banking",
+			"powens",
+			"transactions"
+		],
+		stability: "experimental"
+	},
+	io: {
+		input: OpenBankingListTransactionsInput,
+		output: OpenBankingListTransactionsOutput
+	},
+	policy: { auth: "user" }
+});
+const OpenBankingSyncTransactions = defineCommand({
+	meta: {
+		name: "openbanking.transactions.sync",
+		version: 1,
+		description: "Synchronise transactions for a bank account by calling the configured open banking provider.",
+		goal: "Ensure the canonical transaction ledger stays aligned with the external provider.",
+		context: "Triggered by scheduled workflows or on-demand actions when activity is expected on an account.",
+		owners: ["platform.finance"],
+		tags: [
+			"open-banking",
+			"powens",
+			"transactions"
+		],
+		stability: "experimental"
+	},
+	io: {
+		input: OpenBankingSyncTransactionsInput,
+		output: OpenBankingSyncTransactionsOutput
+	},
+	policy: { auth: "admin" },
+	telemetry: {
+		success: {
+			event: { name: OPENBANKING_TELEMETRY_EVENTS.transactionsSynced },
+			properties: ({ input, output }) => {
+				const payload = input;
+				const result = output;
+				return {
+					tenantId: payload?.tenantId,
+					accountId: payload?.accountId,
+					synced: result?.synced,
+					failed: result?.failed,
+					earliestSyncedAt: result?.earliestSyncedAt,
+					latestSyncedAt: result?.latestSyncedAt
+				};
+			}
+		},
+		failure: {
+			event: { name: OPENBANKING_TELEMETRY_EVENTS.transactionsSyncFailed },
+			properties: ({ input, error }) => {
+				const payload = input;
+				return {
+					tenantId: payload?.tenantId,
+					accountId: payload?.accountId,
+					error: error instanceof Error ? error.message : String(error ?? "unknown")
+				};
+			}
+		}
+	}
+});
+
+//#endregion

package/dist/libs/contracts/dist/integrations/openbanking/models.js

@@ -0,0 +1,242 @@
+import { SchemaModel } from "../../schema/dist/SchemaModel.js";
+import { ScalarTypeEnum } from "../../schema/dist/ScalarTypeEnum.js";
+import "../../schema/dist/index.js";
+
+//#region ../../libs/contracts/dist/integrations/openbanking/models.js
+const BankAccountRecord = new SchemaModel({
+	name: "BankAccountRecord",
+	description: "Canonical representation of a bank account synced from an open banking provider.",
+	fields: {
+		id: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		userId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		connectionId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		externalId: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		institutionId: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		institutionName: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		institutionLogoUrl: {
+			type: ScalarTypeEnum.URL(),
+			isOptional: true
+		},
+		iban: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		bic: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		accountType: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		currency: {
+			type: ScalarTypeEnum.Currency(),
+			isOptional: false
+		},
+		displayName: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		accountNumberMasked: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		productCode: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		balance: {
+			type: ScalarTypeEnum.Float_unsecure(),
+			isOptional: true
+		},
+		availableBalance: {
+			type: ScalarTypeEnum.Float_unsecure(),
+			isOptional: true
+		},
+		lastSyncedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: false
+		},
+		createdAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: false
+		},
+		updatedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: false
+		},
+		metadata: {
+			type: ScalarTypeEnum.JSONObject(),
+			isOptional: true
+		}
+	}
+});
+const BankTransactionRecord = new SchemaModel({
+	name: "BankTransactionRecord",
+	description: "Canonical transaction entry mapped from Powens into the open banking ledger.",
+	fields: {
+		id: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		accountId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		connectionId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		externalId: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		amount: {
+			type: ScalarTypeEnum.Float_unsecure(),
+			isOptional: false
+		},
+		currency: {
+			type: ScalarTypeEnum.Currency(),
+			isOptional: false
+		},
+		date: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: false
+		},
+		bookingDate: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		valueDate: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		description: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		counterpartyName: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		counterpartyAccount: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		merchantCategoryCode: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		rawCategory: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		standardizedCategory: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		transactionType: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		status: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		runningBalance: {
+			type: ScalarTypeEnum.Float_unsecure(),
+			isOptional: true
+		},
+		metadata: {
+			type: ScalarTypeEnum.JSONObject(),
+			isOptional: true
+		},
+		createdAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: false
+		},
+		updatedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: false
+		}
+	}
+});
+const AccountBalanceRecord = new SchemaModel({
+	name: "AccountBalanceRecord",
+	description: "Canonical balance snapshot computed from Powens balance payloads.",
+	fields: {
+		id: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		accountId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		connectionId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		balanceType: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		currentBalance: {
+			type: ScalarTypeEnum.Float_unsecure(),
+			isOptional: false
+		},
+		availableBalance: {
+			type: ScalarTypeEnum.Float_unsecure(),
+			isOptional: true
+		},
+		currency: {
+			type: ScalarTypeEnum.Currency(),
+			isOptional: false
+		},
+		lastUpdatedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: false
+		},
+		createdAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: false
+		},
+		metadata: {
+			type: ScalarTypeEnum.JSONObject(),
+			isOptional: true
+		}
+	}
+});
+
+//#endregion
+export { AccountBalanceRecord, BankAccountRecord, BankTransactionRecord };

package/dist/libs/contracts/dist/integrations/openbanking/telemetry.js

@@ -0,0 +1,13 @@
+//#region ../../libs/contracts/dist/integrations/openbanking/telemetry.js
+const OPENBANKING_TELEMETRY_EVENTS = {
+	accountsSynced: "openbanking.accounts.synced",
+	accountsSyncFailed: "openbanking.accounts.sync_failed",
+	transactionsSynced: "openbanking.transactions.synced",
+	transactionsSyncFailed: "openbanking.transactions.sync_failed",
+	balancesRefreshed: "openbanking.balances.refreshed",
+	balancesRefreshFailed: "openbanking.balances.refresh_failed",
+	overviewGenerated: "openbanking.overview.generated"
+};
+
+//#endregion
+export { OPENBANKING_TELEMETRY_EVENTS };

package/dist/libs/contracts/dist/integrations/providers/elevenlabs.js

@@ -0,0 +1,52 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/integrations/providers/elevenlabs.js
+const elevenLabsIntegrationSpec = {
+	meta: {
+		key: "ai-voice.elevenlabs",
+		version: 1,
+		category: "ai-voice",
+		displayName: "ElevenLabs Voice",
+		title: "ElevenLabs Text-to-Speech",
+		description: "ElevenLabs integration for neural voice synthesis and voice catalog access.",
+		domain: "ai",
+		owners: ["platform.ai"],
+		tags: ["voice", "tts"],
+		stability: StabilityEnum.Beta
+	},
+	supportedModes: ["managed", "byok"],
+	capabilities: { provides: [{
+		key: "ai.voice.synthesis",
+		version: 1
+	}] },
+	configSchema: {
+		schema: {
+			type: "object",
+			properties: { defaultVoiceId: {
+				type: "string",
+				description: "Optional default voice identifier for synthesis requests."
+			} }
+		},
+		example: { defaultVoiceId: "pNInz6obpgDQGcFmaJgB" }
+	},
+	secretSchema: {
+		schema: {
+			type: "object",
+			required: ["apiKey"],
+			properties: { apiKey: {
+				type: "string",
+				description: "ElevenLabs API key with text-to-speech permissions."
+			} }
+		},
+		example: { apiKey: "eleven-***" }
+	},
+	healthCheck: {
+		method: "custom",
+		timeoutMs: 4e3
+	},
+	docsUrl: "https://elevenlabs.io/docs/api-reference/text-to-speech",
+	constraints: { rateLimit: { rpm: 120 } },
+	byokSetup: { setupInstructions: "Create an ElevenLabs API key and ensure the desired voices are accessible to the key scope." }
+};
+
+//#endregion