@contractspec/lib.contracts 1.44.0

package/dist/integrations/openbanking/models.d.ts

@@ -0,0 +1,228 @@
+import * as _contractspec_lib_schema0 from "@contractspec/lib.schema";
+import { SchemaModel } from "@contractspec/lib.schema";
+
+//#region src/integrations/openbanking/models.d.ts
+declare const BankAccountRecord: SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  tenantId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  userId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  connectionId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  externalId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  institutionId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  institutionName: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  institutionLogoUrl: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  iban: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  bic: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  accountType: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  currency: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  displayName: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  accountNumberMasked: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  productCode: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  balance: {
+    type: _contractspec_lib_schema0.FieldType<number, number>;
+    isOptional: true;
+  };
+  availableBalance: {
+    type: _contractspec_lib_schema0.FieldType<number, number>;
+    isOptional: true;
+  };
+  lastSyncedAt: {
+    type: _contractspec_lib_schema0.FieldType<Date, string>;
+    isOptional: false;
+  };
+  createdAt: {
+    type: _contractspec_lib_schema0.FieldType<Date, string>;
+    isOptional: false;
+  };
+  updatedAt: {
+    type: _contractspec_lib_schema0.FieldType<Date, string>;
+    isOptional: false;
+  };
+  metadata: {
+    type: _contractspec_lib_schema0.FieldType<Record<string, unknown>, Record<string, unknown>>;
+    isOptional: true;
+  };
+}>;
+declare const BankTransactionRecord: SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  accountId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  tenantId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  connectionId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  externalId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  amount: {
+    type: _contractspec_lib_schema0.FieldType<number, number>;
+    isOptional: false;
+  };
+  currency: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  date: {
+    type: _contractspec_lib_schema0.FieldType<Date, string>;
+    isOptional: false;
+  };
+  bookingDate: {
+    type: _contractspec_lib_schema0.FieldType<Date, string>;
+    isOptional: true;
+  };
+  valueDate: {
+    type: _contractspec_lib_schema0.FieldType<Date, string>;
+    isOptional: true;
+  };
+  description: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  counterpartyName: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  counterpartyAccount: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  merchantCategoryCode: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  rawCategory: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  standardizedCategory: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: true;
+  };
+  transactionType: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  status: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  runningBalance: {
+    type: _contractspec_lib_schema0.FieldType<number, number>;
+    isOptional: true;
+  };
+  metadata: {
+    type: _contractspec_lib_schema0.FieldType<Record<string, unknown>, Record<string, unknown>>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: _contractspec_lib_schema0.FieldType<Date, string>;
+    isOptional: false;
+  };
+  updatedAt: {
+    type: _contractspec_lib_schema0.FieldType<Date, string>;
+    isOptional: false;
+  };
+}>;
+declare const AccountBalanceRecord: SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  accountId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  tenantId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  connectionId: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  balanceType: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  currentBalance: {
+    type: _contractspec_lib_schema0.FieldType<number, number>;
+    isOptional: false;
+  };
+  availableBalance: {
+    type: _contractspec_lib_schema0.FieldType<number, number>;
+    isOptional: true;
+  };
+  currency: {
+    type: _contractspec_lib_schema0.FieldType<string, string>;
+    isOptional: false;
+  };
+  lastUpdatedAt: {
+    type: _contractspec_lib_schema0.FieldType<Date, string>;
+    isOptional: false;
+  };
+  createdAt: {
+    type: _contractspec_lib_schema0.FieldType<Date, string>;
+    isOptional: false;
+  };
+  metadata: {
+    type: _contractspec_lib_schema0.FieldType<Record<string, unknown>, Record<string, unknown>>;
+    isOptional: true;
+  };
+}>;
+//#endregion
+export { AccountBalanceRecord, BankAccountRecord, BankTransactionRecord };

package/dist/integrations/openbanking/models.js

@@ -0,0 +1,240 @@
+import { ScalarTypeEnum, SchemaModel } from "@contractspec/lib.schema";
+
+//#region src/integrations/openbanking/models.ts
+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/integrations/openbanking/openbanking.feature.d.ts

@@ -0,0 +1,12 @@
+import { FeatureModuleSpec } from "../../features/types.js";
+import "../../features/index.js";
+
+//#region src/integrations/openbanking/openbanking.feature.d.ts
+
+/**
+ * OpenBanking feature module that bundles account, balance,
+ * and transaction synchronization capabilities.
+ */
+declare const OpenBankingFeature: FeatureModuleSpec;
+//#endregion
+export { OpenBankingFeature };

package/dist/integrations/openbanking/openbanking.feature.js

@@ -0,0 +1,69 @@
+//#region src/integrations/openbanking/openbanking.feature.ts
+/**
+* OpenBanking feature module that bundles account, balance,
+* and transaction synchronization capabilities.
+*/
+const OpenBankingFeature = {
+	meta: {
+		key: "openbanking",
+		version: 1,
+		title: "Open Banking Integration",
+		description: "Open banking account sync, balance refresh, and transaction synchronization",
+		domain: "integrations",
+		owners: ["@platform.finance"],
+		tags: [
+			"open-banking",
+			"powens",
+			"finance",
+			"banking"
+		],
+		stability: "experimental"
+	},
+	operations: [
+		{
+			key: "openbanking.accounts.sync",
+			version: 1
+		},
+		{
+			key: "openbanking.accounts.list",
+			version: 1
+		},
+		{
+			key: "openbanking.accounts.get",
+			version: 1
+		},
+		{
+			key: "openbanking.balances.refresh",
+			version: 1
+		},
+		{
+			key: "openbanking.balances.get",
+			version: 1
+		},
+		{
+			key: "openbanking.transactions.sync",
+			version: 1
+		},
+		{
+			key: "openbanking.transactions.list",
+			version: 1
+		}
+	],
+	events: [],
+	presentations: [],
+	opToPresentation: [],
+	presentationsTargets: [],
+	capabilities: {
+		provides: [{
+			key: "openbanking",
+			version: 1
+		}],
+		requires: [{
+			key: "identity",
+			version: 1
+		}]
+	}
+};
+
+//#endregion
+export { OpenBankingFeature };

package/dist/integrations/openbanking/telemetry.d.ts

@@ -0,0 +1,15 @@
+//#region src/integrations/openbanking/telemetry.d.ts
+declare const OPENBANKING_PII_FIELDS: readonly ["iban", "bic", "accountNumberMasked", "accountNumber", "counterpartyName", "counterpartyAccount", "description", "merchantName", "merchantCategoryCode", "reference"];
+declare const OPENBANKING_TELEMETRY_EVENTS: {
+  readonly accountsSynced: "openbanking.accounts.synced";
+  readonly accountsSyncFailed: "openbanking.accounts.sync_failed";
+  readonly transactionsSynced: "openbanking.transactions.synced";
+  readonly transactionsSyncFailed: "openbanking.transactions.sync_failed";
+  readonly balancesRefreshed: "openbanking.balances.refreshed";
+  readonly balancesRefreshFailed: "openbanking.balances.refresh_failed";
+  readonly overviewGenerated: "openbanking.overview.generated";
+};
+type OpenBankingTelemetryEvent = (typeof OPENBANKING_TELEMETRY_EVENTS)[keyof typeof OPENBANKING_TELEMETRY_EVENTS];
+declare function redactOpenBankingTelemetryPayload<T extends Record<string, unknown>>(payload: T): T;
+//#endregion
+export { OPENBANKING_PII_FIELDS, OPENBANKING_TELEMETRY_EVENTS, OpenBankingTelemetryEvent, redactOpenBankingTelemetryPayload };

package/dist/integrations/openbanking/telemetry.js

@@ -0,0 +1,39 @@
+//#region src/integrations/openbanking/telemetry.ts
+const OPENBANKING_PII_FIELDS = [
+	"iban",
+	"bic",
+	"accountNumberMasked",
+	"accountNumber",
+	"counterpartyName",
+	"counterpartyAccount",
+	"description",
+	"merchantName",
+	"merchantCategoryCode",
+	"reference"
+];
+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"
+};
+function redactOpenBankingTelemetryPayload(payload) {
+	const redacted = {};
+	for (const [key, value] of Object.entries(payload)) if (OPENBANKING_PII_FIELDS.includes(key)) redacted[key] = maskValue(value);
+	else if (Array.isArray(value)) redacted[key] = value.map((item) => typeof item === "object" && item !== null ? redactOpenBankingTelemetryPayload(item) : item);
+	else if (typeof value === "object" && value !== null) redacted[key] = redactOpenBankingTelemetryPayload(value);
+	else redacted[key] = value;
+	return redacted;
+}
+function maskValue(value) {
+	if (value == null) return "";
+	const str = String(value);
+	if (str.length <= 4) return "*".repeat(str.length);
+	return `${"*".repeat(Math.max(str.length - 4, 0))}${str.slice(-4)}`;
+}
+
+//#endregion
+export { OPENBANKING_PII_FIELDS, OPENBANKING_TELEMETRY_EVENTS, redactOpenBankingTelemetryPayload };