@contractspec/lib.contracts-integrations 2.0.0

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

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

package/dist/integrations/openbanking/models.js

@@ -0,0 +1,110 @@
+// @bun
+// src/integrations/openbanking/models.ts
+import { ScalarTypeEnum, SchemaModel } from "@contractspec/lib.schema";
+var 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 }
+  }
+});
+var 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 }
+  }
+});
+var 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 }
+  }
+});
+export {
+  BankTransactionRecord,
+  BankAccountRecord,
+  AccountBalanceRecord
+};

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

@@ -0,0 +1 @@
+export declare const OpenBankingCapability: import("@contractspec/lib.contracts-spec").CapabilitySpec;

package/dist/integrations/openbanking/openbanking.capability.js

@@ -0,0 +1,18 @@
+// @bun
+// src/integrations/openbanking/openbanking.capability.ts
+import { defineCapability } from "@contractspec/lib.contracts-spec/capabilities";
+import { StabilityEnum } from "@contractspec/lib.contracts-spec/ownership";
+var OpenBankingCapability = defineCapability({
+  meta: {
+    key: "openbanking",
+    version: "1.0.0",
+    kind: "integration",
+    stability: StabilityEnum.Experimental,
+    description: "Open Banking integrations capability",
+    owners: ["@platform.finance"],
+    tags: ["openbanking", "finance", "integrations"]
+  }
+});
+export {
+  OpenBankingCapability
+};

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

@@ -0,0 +1,5 @@
+/**
+ * OpenBanking feature module that bundles account, balance,
+ * and transaction synchronization capabilities.
+ */
+export declare const OpenBankingFeature: import("@contractspec/lib.contracts-spec").FeatureModuleSpec;

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

@@ -0,0 +1,35 @@
+// @bun
+// src/integrations/openbanking/openbanking.feature.ts
+import { defineFeature } from "@contractspec/lib.contracts-spec/features";
+var OpenBankingFeature = defineFeature({
+  meta: {
+    key: "openbanking",
+    version: "1.0.0",
+    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.0.0" },
+    { key: "openbanking.accounts.list", version: "1.0.0" },
+    { key: "openbanking.accounts.get", version: "1.0.0" },
+    { key: "openbanking.balances.refresh", version: "1.0.0" },
+    { key: "openbanking.balances.get", version: "1.0.0" },
+    { key: "openbanking.transactions.sync", version: "1.0.0" },
+    { key: "openbanking.transactions.list", version: "1.0.0" }
+  ],
+  events: [],
+  presentations: [],
+  opToPresentation: [],
+  presentationsTargets: [],
+  capabilities: {
+    provides: [{ key: "openbanking", version: "1.0.0" }],
+    requires: [{ key: "identity", version: "1.0.0" }]
+  }
+});
+export {
+  OpenBankingFeature
+};

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

@@ -0,0 +1,12 @@
+export declare const OPENBANKING_PII_FIELDS: readonly ["iban", "bic", "accountNumberMasked", "accountNumber", "counterpartyName", "counterpartyAccount", "description", "merchantName", "merchantCategoryCode", "reference"];
+export 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";
+};
+export type OpenBankingTelemetryEvent = (typeof OPENBANKING_TELEMETRY_EVENTS)[keyof typeof OPENBANKING_TELEMETRY_EVENTS];
+export declare function redactOpenBankingTelemetryPayload<T extends Record<string, unknown>>(payload: T): T;

package/dist/integrations/openbanking/telemetry.js

@@ -0,0 +1,51 @@
+// @bun
+// src/integrations/openbanking/telemetry.ts
+var OPENBANKING_PII_FIELDS = [
+  "iban",
+  "bic",
+  "accountNumberMasked",
+  "accountNumber",
+  "counterpartyName",
+  "counterpartyAccount",
+  "description",
+  "merchantName",
+  "merchantCategoryCode",
+  "reference"
+];
+var 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)}`;
+}
+export {
+  redactOpenBankingTelemetryPayload,
+  OPENBANKING_TELEMETRY_EVENTS,
+  OPENBANKING_PII_FIELDS
+};