@hyperscale0/adl 1.0.0-alpha.1

package/dist/index.d.ts

@@ -0,0 +1,219 @@
+import { statementAvailabilities, type ChargePosting, type ChargeVatMode, type FinancialAddressMechanism, type FinancialAddressPricing, type FinancialAddressQuota, type FxRateReadBack, type LimitAccessMode, type LimitDimension, type PartnerBankDedupeKey, type PartnerBankLifecycleState, type PartnerBankSigning, type PartnerBankStatementFormat, type PartnerBankWireCodec, type ProviderAuthEnvelope, type ProviderEgressMode, type ProviderNotificationMechanism, type ProviderOperationDirection, type ProviderResourceBinding, type ProviderResponseEnvelope, type ProviderTimestampField, type RailSubstitution, type StatementAvailability, type StatementDebitReference, type StatusEnquiryKey, type ValueDateOffset } from "./vocabulary.js";
+export { certifyPartnerBankAdapter, partnerBankConformanceCodes, partnerBankConformanceFindings, type PartnerBankConformanceCode, type PartnerBankConformanceFinding, } from "./conformance.js";
+export { statementAvailabilities };
+export type { ProviderEgressMode, ProviderOperationDirection, ProviderResourceBinding, ProviderResponseEnvelope, };
+export interface ProviderAdapterVocabulary {
+    readonly capability: string;
+    readonly domain: string;
+    readonly meter: string;
+    readonly obligation: string;
+    readonly operation: string;
+    readonly resource: string;
+    readonly webhookOperation: string;
+    readonly webhookResource: string;
+    readonly webhookResourceId: string;
+}
+export interface ProviderAdapter<Vocabulary extends ProviderAdapterVocabulary = ProviderAdapterVocabulary> {
+    readonly bindings: Partial<Record<Vocabulary["resource"], ProviderResourceBinding>>;
+    readonly capability: Vocabulary["capability"];
+    readonly config: ProviderConfig;
+    readonly domain?: Vocabulary["domain"];
+    readonly egress: ProviderEgressMode;
+    readonly operationMap: Partial<Record<Vocabulary["operation"], ProviderOperationBinding<Vocabulary>>>;
+    readonly profile?: PartnerBankAdapterProfile;
+    readonly provider: string;
+    readonly webhookMap: Readonly<Record<string, ProviderWebhookTransitionPlan<Vocabulary>>>;
+}
+export interface ProviderOperationBinding<Vocabulary extends ProviderAdapterVocabulary = ProviderAdapterVocabulary> {
+    /**
+     * Authoritative read-after-write status enquiry for a command whose response
+     * may have been lost. Presence is an explicit provider-readiness commitment;
+     * runtimes must never infer enquiry support from the command URL.
+     */
+    readonly statusEnquiry?: {
+        readonly keys: StatusEnquiryKey;
+        readonly pathTemplate: string;
+    };
+    /**
+     * How THIS operation's response carries its outcome. Per operation, never
+     * per provider and never inherited from another provider's class: one real
+     * provider answers two ways, wrapping six of seven endpoints in
+     * `{status, message, data}` while the seventh returns a bare object. Absent
+     * means the class is not established yet -- an unclassified operation, not
+     * a silent `http_200_body_status`.
+     */
+    readonly envelope?: ProviderResponseEnvelope;
+    readonly operation: Vocabulary["operation"];
+    readonly direction: ProviderOperationDirection;
+    readonly meter?: Vocabulary["meter"];
+    readonly obligationKind: Vocabulary["obligation"];
+    readonly resourceIdPath: string;
+    readonly resourceKind: Vocabulary["resource"];
+}
+export interface ProviderWebhookTransitionPlan<Vocabulary extends ProviderAdapterVocabulary = ProviderAdapterVocabulary> {
+    readonly eventKind: string;
+    readonly operationName: Vocabulary["webhookOperation"];
+    readonly optionalPayloadFields: readonly string[];
+    readonly requiredFieldGroups: readonly (readonly string[])[];
+    readonly requiredPayloadFields: readonly string[];
+    readonly resourceIdField: Vocabulary["webhookResourceId"];
+    readonly resourceKind: Vocabulary["webhookResource"];
+    readonly timestampField: ProviderTimestampField;
+}
+export type ProviderCredentialReference = {
+    readonly name: string;
+    readonly source: "environment";
+} | {
+    readonly account: string;
+    readonly service: string;
+    readonly source: "keychain";
+};
+export interface ProviderConfig {
+    readonly baseUrl?: string;
+    readonly credentialRef?: ProviderCredentialReference;
+}
+/**
+ * The fetch window facts for one declared statement format. The paging fields
+ * are required for an end-of-day format (`availability: "T-1"` pages over
+ * history) and absent for an intraday one; conformance enforces that split.
+ */
+export interface PartnerBankStatementWindow {
+    readonly availability: StatementAvailability;
+    readonly lookbackDays?: number;
+    readonly statementDaysPerRequest?: number;
+}
+export interface PartnerBankAdapterProfile {
+    readonly auth: {
+        readonly envelope: ProviderAuthEnvelope;
+        readonly signing: PartnerBankSigning;
+    };
+    /**
+     * How the bank bills its own charges. `posting` says when the charge lands
+     * (debited separately after the payment, or netted out of the instructed
+     * amount); `vat` says whether the tax arrives as its own ledger line or
+     * folded into the charge. Absent when a bank's charge behavior is not
+     * established -- an unmodeled dimension, not a claim of post-hoc billing.
+     */
+    readonly charges?: {
+        /**
+         * The text this bank prints on its own charge lines, as prefixes: the
+         * trailing part names the charged thing. Recognizing a charge is Executor
+         * knowledge, so it is declared per bank and never inferred downstream, and
+         * a bank whose charge wording is not established leaves this absent rather
+         * than borrowing another bank's words.
+         */
+        readonly narratives?: {
+            readonly charge: readonly string[];
+            readonly vat: readonly string[];
+        };
+        readonly posting: ChargePosting;
+        readonly vat: ChargeVatMode;
+    };
+    readonly executedReadBack: {
+        readonly fxRate: FxRateReadBack;
+        readonly railSubstitution: RailSubstitution;
+    };
+    readonly idempotencySpine: {
+        readonly dedupeKeys: readonly PartnerBankDedupeKey[];
+        readonly endToEndId: {
+            readonly maxLength: number;
+        };
+        readonly instructionId: {
+            readonly maxLength: number;
+        };
+        readonly paymentReference: {
+            readonly maxLength: number;
+        };
+    };
+    readonly kind: "partner_bank";
+    readonly lifecycleVocabulary: Readonly<Record<string, PartnerBankLifecycleState>>;
+    readonly limitFacts: {
+        readonly access: LimitAccessMode;
+        readonly dimensions: readonly LimitDimension[];
+    };
+    readonly notificationMechanisms: readonly ProviderNotificationMechanism[];
+    /**
+     * Which reference on a statement debit line names the instruction behind it.
+     * A statement entry carries two: the bank's own entry reference and the
+     * client reference the instruction was sent with. Banks disagree about which
+     * one comes back on the statement, and picking the wrong one makes every
+     * payout the platform instructed look like an unexplained debit. Absent when
+     * a bank's statement reference identity is not established.
+     */
+    readonly statementDebitReference?: StatementDebitReference;
+    readonly statementFormats: readonly PartnerBankStatementFormat[];
+    readonly financialAddressProvisioning: {
+        readonly mechanism: FinancialAddressMechanism;
+        readonly pricing: FinancialAddressPricing;
+        readonly quota: FinancialAddressQuota;
+    };
+    readonly windows: {
+        readonly paymentCutoff: {
+            readonly afterCutoffValueDate: ValueDateOffset;
+            readonly beforeCutoffValueDate: ValueDateOffset;
+            /** Bank-local wall-clock time, HH:MM. */
+            readonly time: string;
+            /** The IANA time zone the cutoff time is read in (e.g. Europe/Dublin). */
+            readonly timeZone: string;
+        };
+        /** One window per declared statement format, keyed by that format. */
+        readonly statements: Partial<Readonly<Record<PartnerBankStatementFormat, PartnerBankStatementWindow>>>;
+        readonly valueDateMaxDaysAhead: number;
+    };
+    readonly wireCodec: PartnerBankWireCodec;
+}
+/**
+ * The insurance-distribution marketplace class, the partner bank's opposite
+ * number: an aggregator API whose whole truth arrives in the command
+ * response. Every field below is a recorded observation of one such surface,
+ * not a reading of a standard.
+ *
+ * What makes the class distinct from `partner_bank`, and why each field exists:
+ *
+ *   - **Nothing to poll.** No status enquiry, no list, no read-back, no
+ *     webhook, on any line. `notificationMechanisms` is empty by evidence, and
+ *     the issuance response is the ONLY carrier of the policy identity -- so
+ *     the transport must capture it durably BEFORE acknowledging the caller.
+ *   - **No idempotency header exists anywhere in the corpus.** Dedupe runs on
+ *     caller-minted business reference numbers replayed verbatim at each step,
+ *     which is why the spine is a reference chain rather than a key.
+ *   - **Auth is a bespoke credential exchange**, not OAuth2 client
+ *     credentials: username/password against the provider's own login route
+ *     yields a bearer with no documented lifetime, refresh, or scope.
+ *   - **Errors are prose.** No machine error code appears anywhere, so an
+ *     adapter cannot build a decline taxonomy from the docs alone.
+ */
+export interface InsuranceDistributorAdapterProfile {
+    readonly kind: "insurance_distributor";
+    readonly wireCodec: "rest_json";
+    readonly auth: {
+        readonly envelope: ProviderAuthEnvelope;
+        /** How the bearer is obtained, when the provider documents it at all. */
+        readonly acquisition: "password_login" | "out_of_band";
+        readonly signing: "none";
+    };
+    /**
+     * Envelope class per DOCUMENTED operation name, because one provider answers
+     * in more than one shape. Keys are the provider's own operation names, not
+     * platform operations -- this profile describes a surface no adapter has
+     * integrated yet.
+     */
+    readonly envelopes: Readonly<Record<string, ProviderResponseEnvelope>>;
+    /**
+     * The correlation chain that stands in for an idempotency key: which
+     * references the CALLER mints and which the provider mints, in the order the
+     * exchange replays them.
+     */
+    readonly referenceChain: {
+        readonly clientMinted: readonly string[];
+        readonly providerMinted: readonly string[];
+    };
+    readonly notificationMechanisms: readonly ProviderNotificationMechanism[];
+    /** Whether the provider publishes machine-readable failure codes. */
+    readonly errorModel: "prose_only" | "coded";
+    /** True when the command response is the only carrier of the created fact. */
+    readonly captureBeforeAcknowledge: boolean;
+}
+/** Bind a product vocabulary once, then retain literal adapter registry types. */
+export declare function createProviderAdapterRegistry<Vocabulary extends ProviderAdapterVocabulary>(): <const Adapters extends readonly ProviderAdapter<Vocabulary>[]>(adapters: Adapters) => Adapters;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,uBAAuB,EACvB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACrB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,8BAA8B,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,6BAA6B,GACnC,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,uBAAuB,EAAE,CAAC;AACnC,YAAY,EACV,kBAAkB,EAClB,0BAA0B,EAC1B,uBAAuB,EACvB,wBAAwB,GACzB,CAAC;AAEF,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,WAAW,eAAe,CAC9B,UAAU,SAAS,yBAAyB,GAAG,yBAAyB;IAExE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CACxB,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,uBAAuB,CAAC,CACxD,CAAC;IACF,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC;IAC9C,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;IACpC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAC5B,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,wBAAwB,CAAC,UAAU,CAAC,CAAC,CACtE,CAAC;IACF,QAAQ,CAAC,OAAO,CAAC,EAAE,yBAAyB,CAAC;IAC7C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAC3B,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,UAAU,CAAC,CAAC,CAC1D,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB,CACvC,UAAU,SAAS,yBAAyB,GAAG,yBAAyB;IAExE;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE;QACvB,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;QAChC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;KAC/B,CAAC;IACF;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAC7C,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAC5C,QAAQ,CAAC,SAAS,EAAE,0BAA0B,CAAC;IAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IACrC,QAAQ,CAAC,cAAc,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC;IAClD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;CAC/C;AAED,MAAM,WAAW,6BAA6B,CAC5C,UAAU,SAAS,yBAAyB,GAAG,yBAAyB;IAExE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACvD,QAAQ,CAAC,qBAAqB,EAAE,SAAS,MAAM,EAAE,CAAC;IAClD,QAAQ,CAAC,mBAAmB,EAAE,SAAS,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC;IAC7D,QAAQ,CAAC,qBAAqB,EAAE,SAAS,MAAM,EAAE,CAAC;IAClD,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAC1D,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAC;IACrD,QAAQ,CAAC,cAAc,EAAE,sBAAsB,CAAC;CACjD;AAED,MAAM,MAAM,2BAA2B,GACnC;IACE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;CAChC,GACD;IACE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;CAC7B,CAAC;AAEN,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,aAAa,CAAC,EAAE,2BAA2B,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,YAAY,EAAE,qBAAqB,CAAC;IAC7C,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAC3C;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,EAAE;QACb,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,CAAC;QACxC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC;KACtC,CAAC;IACF;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB;;;;;;WAMG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;YACnC,QAAQ,CAAC,GAAG,EAAE,SAAS,MAAM,EAAE,CAAC;SACjC,CAAC;QACF,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;QAChC,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;KAC7B,CAAC;IACF,QAAQ,CAAC,gBAAgB,EAAE;QACzB,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;KAC7C,CAAC;IACF,QAAQ,CAAC,gBAAgB,EAAE;QACzB,QAAQ,CAAC,UAAU,EAAE,SAAS,oBAAoB,EAAE,CAAC;QACrD,QAAQ,CAAC,UAAU,EAAE;YAAE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;SAAE,CAAC;QACpD,QAAQ,CAAC,aAAa,EAAE;YAAE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;SAAE,CAAC;QACvD,QAAQ,CAAC,gBAAgB,EAAE;YAAE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;SAAE,CAAC;KAC3D,CAAC;IACF,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAC9B,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,CACpC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAC1C,CAAC;IACF,QAAQ,CAAC,UAAU,EAAE;QACnB,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;QACjC,QAAQ,CAAC,UAAU,EAAE,SAAS,cAAc,EAAE,CAAC;KAChD,CAAC;IACF,QAAQ,CAAC,sBAAsB,EAAE,SAAS,6BAA6B,EAAE,CAAC;IAC1E;;;;;;;OAOG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;IAC3D,QAAQ,CAAC,gBAAgB,EAAE,SAAS,0BAA0B,EAAE,CAAC;IACjE,QAAQ,CAAC,4BAA4B,EAAE;QACrC,QAAQ,CAAC,SAAS,EAAE,yBAAyB,CAAC;QAC9C,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;QAC1C,QAAQ,CAAC,KAAK,EAAE,qBAAqB,CAAC;KACvC,CAAC;IACF,QAAQ,CAAC,OAAO,EAAE;QAChB,QAAQ,CAAC,aAAa,EAAE;YACtB,QAAQ,CAAC,oBAAoB,EAAE,eAAe,CAAC;YAC/C,QAAQ,CAAC,qBAAqB,EAAE,eAAe,CAAC;YAChD,yCAAyC;YACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;YACtB,0EAA0E;YAC1E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;SAC3B,CAAC;QACF,sEAAsE;QACtE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAC1B,QAAQ,CAAC,MAAM,CAAC,0BAA0B,EAAE,0BAA0B,CAAC,CAAC,CACzE,CAAC;QACF,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;KACxC,CAAC;IACF,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,kCAAkC;IACjD,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;IAChC,QAAQ,CAAC,IAAI,EAAE;QACb,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,CAAC;QACxC,yEAAyE;QACzE,QAAQ,CAAC,WAAW,EAAE,gBAAgB,GAAG,aAAa,CAAC;QACvD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC,CAAC;IACvE;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE;QACvB,QAAQ,CAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;QACzC,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;KAC5C,CAAC;IACF,QAAQ,CAAC,sBAAsB,EAAE,SAAS,6BAA6B,EAAE,CAAC;IAC1E,qEAAqE;IACrE,QAAQ,CAAC,UAAU,EAAE,YAAY,GAAG,OAAO,CAAC;IAC5C,8EAA8E;IAC9E,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC;CAC5C;AA2BD,kFAAkF;AAClF,wBAAgB,6BAA6B,CAC3C,UAAU,SAAS,yBAAyB,KACzC,CAAC,KAAK,CAAC,QAAQ,SAAS,SAAS,eAAe,CAAC,UAAU,CAAC,EAAE,EACjE,QAAQ,EAAE,QAAQ,KACf,QAAQ,CAGZ"}

package/dist/index.js

@@ -0,0 +1,144 @@
+import { providerKeyPattern, statementAvailabilities, } from "./vocabulary.js";
+export { certifyPartnerBankAdapter, partnerBankConformanceCodes, partnerBankConformanceFindings, } from "./conformance.js";
+export { statementAvailabilities };
+/** Validate an adapter registry once at load, then preserve its exact type. */
+function defineProviderAdapters(adapters) {
+    const identities = new Set();
+    for (const adapter of adapters) {
+        if (!providerKeyPattern.test(adapter.provider)) {
+            throw new Error(`invalid provider key ${adapter.provider}`);
+        }
+        const identity = `${adapter.provider}:${adapter.capability}`;
+        if (identities.has(identity)) {
+            throw new Error(`duplicate provider adapter ${identity}`);
+        }
+        identities.add(identity);
+        validateConfig(adapter.provider, adapter.config);
+        validateOperations(adapter);
+        validateWebhooks(adapter);
+        if (adapter.profile) {
+            validatePartnerBankProfile(adapter.provider, adapter.profile);
+        }
+    }
+    return adapters;
+}
+/** Bind a product vocabulary once, then retain literal adapter registry types. */
+export function createProviderAdapterRegistry() {
+    return (adapters) => defineProviderAdapters(adapters);
+}
+function validateConfig(provider, config) {
+    if (config.baseUrl) {
+        try {
+            new URL(config.baseUrl);
+        }
+        catch {
+            throw new Error(`${provider} config.baseUrl must be an absolute URL`);
+        }
+    }
+    const credential = config.credentialRef;
+    if (!credential)
+        return;
+    if (credential.source === "environment") {
+        assertNonblank(provider, "config.credentialRef.name", credential.name);
+        return;
+    }
+    assertNonblank(provider, "config.credentialRef.account", credential.account);
+    assertNonblank(provider, "config.credentialRef.service", credential.service);
+}
+function validateOperations(adapter) {
+    for (const [operation, binding] of Object.entries(adapter.operationMap)) {
+        if (operation !== binding.operation) {
+            throw new Error(`${adapter.provider} operationMap key ${operation} must match operation ${binding.operation}`);
+        }
+        assertNonblank(adapter.provider, `${operation}.resourceIdPath`, binding.resourceIdPath);
+        if (binding.statusEnquiry) {
+            assertNonblank(adapter.provider, `${operation}.statusEnquiry.pathTemplate`, binding.statusEnquiry.pathTemplate);
+            const placeholder = binding.statusEnquiry.keys === "instruction_id"
+                ? "{instructionId}"
+                : "{providerReference}";
+            if (!binding.statusEnquiry.pathTemplate.includes(placeholder)) {
+                throw new Error(`${adapter.provider} ${operation}.statusEnquiry.pathTemplate must include ${placeholder}`);
+            }
+        }
+    }
+}
+function validateWebhooks(adapter) {
+    for (const [event, plan] of Object.entries(adapter.webhookMap)) {
+        if (event !== plan.eventKind) {
+            throw new Error(`${adapter.provider} webhookMap key ${event} must match eventKind ${plan.eventKind}`);
+        }
+    }
+}
+function validatePartnerBankProfile(provider, profile) {
+    if (!profile.notificationMechanisms.includes("poll")) {
+        throw new Error(`${provider} partner-bank profile must support polling`);
+    }
+    if (Object.keys(profile.lifecycleVocabulary).length === 0) {
+        throw new Error(`${provider} partner-bank profile has no lifecycle vocabulary`);
+    }
+    assertUnique(provider, "statementFormats", profile.statementFormats);
+    assertUnique(provider, "notificationMechanisms", profile.notificationMechanisms);
+    assertUnique(provider, "limitFacts.dimensions", profile.limitFacts.dimensions);
+    const spine = profile.idempotencySpine;
+    // The dedupe keys widened from a fixed triple to a list, so the list now
+    // carries the guarantees the tuple used to give for free.
+    if (spine.dedupeKeys.length === 0) {
+        throw new Error(`${provider} idempotencySpine.dedupeKeys is empty`);
+    }
+    assertUnique(provider, "idempotencySpine.dedupeKeys", spine.dedupeKeys);
+    const spineLimits = {
+        endToEndId: spine.endToEndId,
+        instructionId: spine.instructionId,
+        paymentReference: spine.paymentReference,
+    };
+    for (const [field, limit] of Object.entries(spineLimits)) {
+        assertPositiveInteger(provider, `idempotencySpine.${field}.maxLength`, limit.maxLength);
+    }
+    const windows = profile.windows;
+    if (!/^\d{2}:\d{2}$/.test(windows.paymentCutoff.time)) {
+        throw new Error(`${provider} windows.paymentCutoff.time must be HH:MM`);
+    }
+    // Intl.DateTimeFormat treats an undefined timeZone as the runtime default,
+    // so presence must be checked before validity.
+    const timeZone = windows.paymentCutoff.timeZone;
+    if (typeof timeZone !== "string") {
+        throw new Error(`${provider} windows.paymentCutoff.timeZone must be a valid IANA time zone`);
+    }
+    try {
+        new Intl.DateTimeFormat("en", { timeZone });
+    }
+    catch {
+        throw new Error(`${provider} windows.paymentCutoff.timeZone must be a valid IANA time zone`);
+    }
+    assertPositiveInteger(provider, "windows.valueDateMaxDaysAhead", windows.valueDateMaxDaysAhead);
+    for (const [format, window] of Object.entries(windows.statements)) {
+        // TS requires availability, but a plain-JS consumer can send a window
+        // without one, and an availability-less window is unschedulable.
+        if (!statementAvailabilities.includes(window.availability)) {
+            throw new Error(`${provider} windows.statements.${format}.availability must be one ` +
+                `of ${statementAvailabilities.join(", ")}`);
+        }
+        if (window.lookbackDays !== undefined) {
+            assertPositiveInteger(provider, `windows.statements.${format}.lookbackDays`, window.lookbackDays);
+        }
+        if (window.statementDaysPerRequest !== undefined) {
+            assertPositiveInteger(provider, `windows.statements.${format}.statementDaysPerRequest`, window.statementDaysPerRequest);
+        }
+    }
+}
+function assertPositiveInteger(provider, field, value) {
+    if (!Number.isInteger(value) || value <= 0) {
+        throw new Error(`${provider} ${field} must be a positive integer`);
+    }
+}
+function assertUnique(provider, field, values) {
+    if (new Set(values).size !== values.length) {
+        throw new Error(`${provider} ${field} contains duplicates`);
+    }
+}
+function assertNonblank(provider, field, value) {
+    if (value.trim().length === 0) {
+        throw new Error(`${provider} ${field} must not be blank`);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,uBAAuB,GA0BxB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,8BAA8B,GAG/B,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,uBAAuB,EAAE,CAAC;AAiPnC,+EAA+E;AAC/E,SAAS,sBAAsB,CAG7B,QAAkB;IAClB,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IACrC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,wBAAwB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9D,CAAC;QACD,MAAM,QAAQ,GAAG,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QAC7D,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzB,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACjD,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC5B,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1B,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,6BAA6B;IAK3C,OAAO,CAAC,QAAQ,EAAE,EAAE,CAClB,sBAAsB,CAA8B,QAAQ,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,cAAc,CAAC,QAAgB,EAAE,MAAsB;IAC9D,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,yCAAyC,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC;IACxC,IAAI,CAAC,UAAU;QAAE,OAAO;IACxB,IAAI,UAAU,CAAC,MAAM,KAAK,aAAa,EAAE,CAAC;QACxC,cAAc,CAAC,QAAQ,EAAE,2BAA2B,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QACvE,OAAO;IACT,CAAC;IACD,cAAc,CAAC,QAAQ,EAAE,8BAA8B,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IAC7E,cAAc,CAAC,QAAQ,EAAE,8BAA8B,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;AAC/E,CAAC;AAED,SAAS,kBAAkB,CACzB,OAAoC;IAEpC,KAAK,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAGnE,EAAE,CAAC;QACJ,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,CAAC,QAAQ,qBAAqB,SAAS,yBAAyB,OAAO,CAAC,SAAS,EAAE,CAC9F,CAAC;QACJ,CAAC;QACD,cAAc,CACZ,OAAO,CAAC,QAAQ,EAChB,GAAG,SAAS,iBAAiB,EAC7B,OAAO,CAAC,cAAc,CACvB,CAAC;QACF,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YAC1B,cAAc,CACZ,OAAO,CAAC,QAAQ,EAChB,GAAG,SAAS,6BAA6B,EACzC,OAAO,CAAC,aAAa,CAAC,YAAY,CACnC,CAAC;YACF,MAAM,WAAW,GACf,OAAO,CAAC,aAAa,CAAC,IAAI,KAAK,gBAAgB;gBAC7C,CAAC,CAAC,iBAAiB;gBACnB,CAAC,CAAC,qBAAqB,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC9D,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,CAAC,QAAQ,IAAI,SAAS,4CAA4C,WAAW,EAAE,CAC1F,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CACvB,OAAoC;IAEpC,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/D,IAAI,KAAK,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,CAAC,QAAQ,mBAAmB,KAAK,yBAAyB,IAAI,CAAC,SAAS,EAAE,CACrF,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,0BAA0B,CACjC,QAAgB,EAChB,OAAkC;IAElC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,4CAA4C,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CACb,GAAG,QAAQ,mDAAmD,CAC/D,CAAC;IACJ,CAAC;IACD,YAAY,CAAC,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACrE,YAAY,CACV,QAAQ,EACR,wBAAwB,EACxB,OAAO,CAAC,sBAAsB,CAC/B,CAAC;IACF,YAAY,CACV,QAAQ,EACR,uBAAuB,EACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAC9B,CAAC;IACF,MAAM,KAAK,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACvC,yEAAyE;IACzE,0DAA0D;IAC1D,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,uCAAuC,CAAC,CAAC;IACtE,CAAC;IACD,YAAY,CAAC,QAAQ,EAAE,6BAA6B,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IACxE,MAAM,WAAW,GAAG;QAClB,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,aAAa,EAAE,KAAK,CAAC,aAAa;QAClC,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;KACzC,CAAC;IACF,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QACzD,qBAAqB,CACnB,QAAQ,EACR,oBAAoB,KAAK,YAAY,EACrC,KAAK,CAAC,SAAS,CAChB,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,2CAA2C,CAAC,CAAC;IAC1E,CAAC;IACD,2EAA2E;IAC3E,+CAA+C;IAC/C,MAAM,QAAQ,GAAY,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC;IACzD,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CACb,GAAG,QAAQ,gEAAgE,CAC5E,CAAC;IACJ,CAAC;IACD,IAAI,CAAC;QACH,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC9C,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CACb,GAAG,QAAQ,gEAAgE,CAC5E,CAAC;IACJ,CAAC;IACD,qBAAqB,CACnB,QAAQ,EACR,+BAA+B,EAC/B,OAAO,CAAC,qBAAqB,CAC9B,CAAC;IACF,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAClE,sEAAsE;QACtE,iEAAiE;QACjE,IACE,CAAE,uBAA8C,CAAC,QAAQ,CACvD,MAAM,CAAC,YAAY,CACpB,EACD,CAAC;YACD,MAAM,IAAI,KAAK,CACb,GAAG,QAAQ,uBAAuB,MAAM,4BAA4B;gBAClE,MAAM,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7C,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACtC,qBAAqB,CACnB,QAAQ,EACR,sBAAsB,MAAM,eAAe,EAC3C,MAAM,CAAC,YAAY,CACpB,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,uBAAuB,KAAK,SAAS,EAAE,CAAC;YACjD,qBAAqB,CACnB,QAAQ,EACR,sBAAsB,MAAM,0BAA0B,EACtD,MAAM,CAAC,uBAAuB,CAC/B,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,qBAAqB,CAC5B,QAAgB,EAChB,KAAa,EACb,KAAa;IAEb,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,IAAI,KAAK,6BAA6B,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CACnB,QAAgB,EAChB,KAAa,EACb,MAAyB;IAEzB,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,IAAI,KAAK,sBAAsB,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,QAAgB,EAAE,KAAa,EAAE,KAAa;IACpE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,IAAI,KAAK,oBAAoB,CAAC,CAAC;IAC5D,CAAC;AACH,CAAC"}

package/dist/vocabulary.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Every closed value set an adapter declaration may use, as runtime arrays
+ * with the types derived from them.
+ *
+ * One source of truth: the exported types below are `(typeof array)[number]`,
+ * and `scripts/emit-spec.ts` builds `spec/manifest.schema.json` from the same
+ * arrays. A value added here reaches the type checker and the published JSON
+ * Schema in the same commit, so the two cannot drift.
+ *
+ * This module imports nothing, so both `index.ts` and `conformance.ts` can
+ * read it without a load-order cycle.
+ */
+export declare const providerKeyPattern: RegExp;
+export declare const providerOperationDirections: readonly ["tenant_initiated", "system_settlement"];
+export declare const providerResourceBindings: readonly ["strict", "claim", "confirmation_only", "evidence_only"];
+export declare const providerEgressModes: readonly ["none", "rest", "batch_reconcile", "sync_clearance"];
+export declare const providerCredentialSources: readonly ["environment", "keychain"];
+/** Which reference a read-after-write status enquiry is keyed by. */
+export declare const statusEnquiryKeys: readonly ["instruction_id", "provider_reference"];
+/**
+ * How one provider operation carries its outcome:
+ *
+ *   - `http_200_body_status` -- every response is HTTP 200 and the outcome
+ *     classifies on a body status field, so a rejection can arrive as a
+ *     status token inside a 200;
+ *   - `http_status_error_body` -- the outcome rides the HTTP status and a
+ *     failure carries a thin prose body (`{status, message}`);
+ *   - `unconfirmed_until_live` -- the provider publishes no error sample at
+ *     all, so the class is honestly unknown until first live traffic. An
+ *     adapter must never borrow another provider's class to fill this in.
+ */
+export declare const providerResponseEnvelopes: readonly ["http_200_body_status", "http_status_error_body", "unconfirmed_until_live"];
+/**
+ * How a provider expects to be authenticated. `oauth2_password` is the
+ * resource-owner password grant (username/password against the provider's own
+ * token service) and `bearer_out_of_band` is a static bearer whose issuance
+ * the provider does not document. Both are observed in the wild, neither is
+ * pretty.
+ */
+export declare const providerAuthEnvelopes: readonly ["oauth2_client_credentials", "oauth2_password", "bearer_out_of_band", "mutual_tls", "signed_file"];
+export declare const providerNotificationMechanisms: readonly ["poll", "webhook"];
+export declare const providerTimestampFields: readonly ["activeAt", "completedAt", "failedAt", "returnedAt", "receivedAt", "clearedAt", "expiredAt", "voidedAt", "postedAt", "refundedAt"];
+export declare const partnerBankWireCodecs: readonly ["rest_json", "iso20022_xml", "swift_mt"];
+export declare const partnerBankSignings: readonly ["jws", "detached_signature", "signed_file"];
+/** The canonical states a bank's own status spellings must map onto. */
+export declare const partnerBankLifecycleStates: readonly ["received", "accepted", "processed", "failed", "returned", "duplicate_original_succeeded", "duplicate_original_rejected", "duplicate_suspected_rejected"];
+export declare const partnerBankStatementFormats: readonly ["mt940", "mt942", "camt_052", "camt_053", "obie_json"];
+/** Which reference the bank grades a duplicate instruction against. */
+export declare const partnerBankDedupeKeys: readonly ["client", "instructionId", "endToEndId", "paymentReference"];
+/** When a statement covering a period becomes fetchable. */
+export declare const statementAvailabilities: readonly ["T-1", "today_only"];
+/** Which reference on a statement debit line names the instruction behind it. */
+export declare const statementDebitReferences: readonly ["bank_reference", "customer_reference"];
+export declare const chargePostings: readonly ["post_hoc", "at_instruction"];
+export declare const chargeVatModes: readonly ["separate_line", "included_in_charge"];
+export declare const fxRateReadBacks: readonly ["final_status_only"];
+/**
+ * Whether the executed read-back may name a different rail than the one
+ * instructed. `none` is a real inhabitant: a bank that never substitutes.
+ */
+export declare const railSubstitutions: readonly ["ips_to_sarie", "none"];
+export declare const limitAccessModes: readonly ["read_only"];
+export declare const limitDimensions: readonly ["daily", "per_transaction", "foreign_exchange"];
+export declare const financialAddressMechanisms: readonly ["api", "scheme_file"];
+export declare const financialAddressPricing: readonly ["none", "per_address"];
+export declare const financialAddressQuotas: readonly ["none", "provider_enforced"];
+export type ProviderOperationDirection = (typeof providerOperationDirections)[number];
+export type ProviderResourceBinding = (typeof providerResourceBindings)[number];
+export type ProviderEgressMode = (typeof providerEgressModes)[number];
+export type ProviderCredentialSource = (typeof providerCredentialSources)[number];
+export type StatusEnquiryKey = (typeof statusEnquiryKeys)[number];
+export type ProviderResponseEnvelope = (typeof providerResponseEnvelopes)[number];
+export type ProviderAuthEnvelope = (typeof providerAuthEnvelopes)[number];
+export type ProviderNotificationMechanism = (typeof providerNotificationMechanisms)[number];
+export type ProviderTimestampField = (typeof providerTimestampFields)[number];
+export type PartnerBankWireCodec = (typeof partnerBankWireCodecs)[number];
+export type PartnerBankSigning = (typeof partnerBankSignings)[number];
+export type PartnerBankLifecycleState = (typeof partnerBankLifecycleStates)[number];
+export type PartnerBankStatementFormat = (typeof partnerBankStatementFormats)[number];
+export type PartnerBankDedupeKey = (typeof partnerBankDedupeKeys)[number];
+export type StatementAvailability = (typeof statementAvailabilities)[number];
+export type StatementDebitReference = (typeof statementDebitReferences)[number];
+export type ChargePosting = (typeof chargePostings)[number];
+export type ChargeVatMode = (typeof chargeVatModes)[number];
+export type FxRateReadBack = (typeof fxRateReadBacks)[number];
+export type RailSubstitution = (typeof railSubstitutions)[number];
+export type LimitAccessMode = (typeof limitAccessModes)[number];
+export type LimitDimension = (typeof limitDimensions)[number];
+export type FinancialAddressMechanism = (typeof financialAddressMechanisms)[number];
+export type FinancialAddressPricing = (typeof financialAddressPricing)[number];
+export type FinancialAddressQuota = (typeof financialAddressQuotas)[number];
+/** A value date expressed as banking days after the instruction date. */
+export type ValueDateOffset = `D+${number}`;
+//# sourceMappingURL=vocabulary.d.ts.map

package/dist/vocabulary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocabulary.d.ts","sourceRoot":"","sources":["../src/vocabulary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,kBAAkB,QAA6B,CAAC;AAE7D,eAAO,MAAM,2BAA2B,oDAG9B,CAAC;AAEX,eAAO,MAAM,wBAAwB,oEAK3B,CAAC;AAEX,eAAO,MAAM,mBAAmB,gEAKtB,CAAC;AAEX,eAAO,MAAM,yBAAyB,sCAAuC,CAAC;AAE9E,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,mDAGpB,CAAC;AAEX;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,yBAAyB,uFAI5B,CAAC;AAEX;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,8GAMxB,CAAC;AAEX,eAAO,MAAM,8BAA8B,8BAA+B,CAAC;AAE3E,eAAO,MAAM,uBAAuB,8IAW1B,CAAC;AAEX,eAAO,MAAM,qBAAqB,oDAIxB,CAAC;AAEX,eAAO,MAAM,mBAAmB,uDAItB,CAAC;AAEX,wEAAwE;AACxE,eAAO,MAAM,0BAA0B,qKAS7B,CAAC;AAEX,eAAO,MAAM,2BAA2B,kEAM9B,CAAC;AAEX,uEAAuE;AACvE,eAAO,MAAM,qBAAqB,wEAKxB,CAAC;AAEX,4DAA4D;AAC5D,eAAO,MAAM,uBAAuB,gCAAiC,CAAC;AAEtE,iFAAiF;AACjF,eAAO,MAAM,wBAAwB,mDAG3B,CAAC;AAEX,eAAO,MAAM,cAAc,yCAA0C,CAAC;AAEtE,eAAO,MAAM,cAAc,kDAAmD,CAAC;AAE/E,eAAO,MAAM,eAAe,gCAAiC,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,mCAAoC,CAAC;AAEnE,eAAO,MAAM,gBAAgB,wBAAyB,CAAC;AAEvD,eAAO,MAAM,eAAe,2DAIlB,CAAC;AAEX,eAAO,MAAM,0BAA0B,iCAAkC,CAAC;AAE1E,eAAO,MAAM,uBAAuB,kCAAmC,CAAC;AAExE,eAAO,MAAM,sBAAsB,wCAAyC,CAAC;AAE7E,MAAM,MAAM,0BAA0B,GACpC,CAAC,OAAO,2BAA2B,CAAC,CAAC,MAAM,CAAC,CAAC;AAC/C,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC;AAChF,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AACtE,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC7C,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAClE,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC7C,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC1E,MAAM,MAAM,6BAA6B,GACvC,CAAC,OAAO,8BAA8B,CAAC,CAAC,MAAM,CAAC,CAAC;AAClD,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC9E,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC1E,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AACtE,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC;AAC9C,MAAM,MAAM,0BAA0B,GACpC,CAAC,OAAO,2BAA2B,CAAC,CAAC,MAAM,CAAC,CAAC;AAC/C,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC1E,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC7E,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC;AAChF,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAC5D,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAC5D,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAC9D,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAClE,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAChE,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAC9D,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC;AAC9C,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC/E,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5E,yEAAyE;AACzE,MAAM,MAAM,eAAe,GAAG,KAAK,MAAM,EAAE,CAAC"}

package/dist/vocabulary.js

@@ -0,0 +1,139 @@
+/**
+ * Every closed value set an adapter declaration may use, as runtime arrays
+ * with the types derived from them.
+ *
+ * One source of truth: the exported types below are `(typeof array)[number]`,
+ * and `scripts/emit-spec.ts` builds `spec/manifest.schema.json` from the same
+ * arrays. A value added here reaches the type checker and the published JSON
+ * Schema in the same commit, so the two cannot drift.
+ *
+ * This module imports nothing, so both `index.ts` and `conformance.ts` can
+ * read it without a load-order cycle.
+ */
+export const providerKeyPattern = /^[a-z][a-z0-9_.-]{0,79}$/;
+export const providerOperationDirections = [
+    "tenant_initiated",
+    "system_settlement",
+];
+export const providerResourceBindings = [
+    "strict",
+    "claim",
+    "confirmation_only",
+    "evidence_only",
+];
+export const providerEgressModes = [
+    "none",
+    "rest",
+    "batch_reconcile",
+    "sync_clearance",
+];
+export const providerCredentialSources = ["environment", "keychain"];
+/** Which reference a read-after-write status enquiry is keyed by. */
+export const statusEnquiryKeys = [
+    "instruction_id",
+    "provider_reference",
+];
+/**
+ * How one provider operation carries its outcome:
+ *
+ *   - `http_200_body_status` -- every response is HTTP 200 and the outcome
+ *     classifies on a body status field, so a rejection can arrive as a
+ *     status token inside a 200;
+ *   - `http_status_error_body` -- the outcome rides the HTTP status and a
+ *     failure carries a thin prose body (`{status, message}`);
+ *   - `unconfirmed_until_live` -- the provider publishes no error sample at
+ *     all, so the class is honestly unknown until first live traffic. An
+ *     adapter must never borrow another provider's class to fill this in.
+ */
+export const providerResponseEnvelopes = [
+    "http_200_body_status",
+    "http_status_error_body",
+    "unconfirmed_until_live",
+];
+/**
+ * How a provider expects to be authenticated. `oauth2_password` is the
+ * resource-owner password grant (username/password against the provider's own
+ * token service) and `bearer_out_of_band` is a static bearer whose issuance
+ * the provider does not document. Both are observed in the wild, neither is
+ * pretty.
+ */
+export const providerAuthEnvelopes = [
+    "oauth2_client_credentials",
+    "oauth2_password",
+    "bearer_out_of_band",
+    "mutual_tls",
+    "signed_file",
+];
+export const providerNotificationMechanisms = ["poll", "webhook"];
+export const providerTimestampFields = [
+    "activeAt",
+    "completedAt",
+    "failedAt",
+    "returnedAt",
+    "receivedAt",
+    "clearedAt",
+    "expiredAt",
+    "voidedAt",
+    "postedAt",
+    "refundedAt",
+];
+export const partnerBankWireCodecs = [
+    "rest_json",
+    "iso20022_xml",
+    "swift_mt",
+];
+export const partnerBankSignings = [
+    "jws",
+    "detached_signature",
+    "signed_file",
+];
+/** The canonical states a bank's own status spellings must map onto. */
+export const partnerBankLifecycleStates = [
+    "received",
+    "accepted",
+    "processed",
+    "failed",
+    "returned",
+    "duplicate_original_succeeded",
+    "duplicate_original_rejected",
+    "duplicate_suspected_rejected",
+];
+export const partnerBankStatementFormats = [
+    "mt940",
+    "mt942",
+    "camt_052",
+    "camt_053",
+    "obie_json",
+];
+/** Which reference the bank grades a duplicate instruction against. */
+export const partnerBankDedupeKeys = [
+    "client",
+    "instructionId",
+    "endToEndId",
+    "paymentReference",
+];
+/** When a statement covering a period becomes fetchable. */
+export const statementAvailabilities = ["T-1", "today_only"];
+/** Which reference on a statement debit line names the instruction behind it. */
+export const statementDebitReferences = [
+    "bank_reference",
+    "customer_reference",
+];
+export const chargePostings = ["post_hoc", "at_instruction"];
+export const chargeVatModes = ["separate_line", "included_in_charge"];
+export const fxRateReadBacks = ["final_status_only"];
+/**
+ * Whether the executed read-back may name a different rail than the one
+ * instructed. `none` is a real inhabitant: a bank that never substitutes.
+ */
+export const railSubstitutions = ["ips_to_sarie", "none"];
+export const limitAccessModes = ["read_only"];
+export const limitDimensions = [
+    "daily",
+    "per_transaction",
+    "foreign_exchange",
+];
+export const financialAddressMechanisms = ["api", "scheme_file"];
+export const financialAddressPricing = ["none", "per_address"];
+export const financialAddressQuotas = ["none", "provider_enforced"];
+//# sourceMappingURL=vocabulary.js.map

package/dist/vocabulary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocabulary.js","sourceRoot":"","sources":["../src/vocabulary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,0BAA0B,CAAC;AAE7D,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,kBAAkB;IAClB,mBAAmB;CACX,CAAC;AAEX,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,QAAQ;IACR,OAAO;IACP,mBAAmB;IACnB,eAAe;CACP,CAAC;AAEX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM;IACN,MAAM;IACN,iBAAiB;IACjB,gBAAgB;CACR,CAAC;AAEX,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,aAAa,EAAE,UAAU,CAAU,CAAC;AAE9E,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,gBAAgB;IAChB,oBAAoB;CACZ,CAAC;AAEX;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,sBAAsB;IACtB,wBAAwB;IACxB,wBAAwB;CAChB,CAAC;AAEX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,2BAA2B;IAC3B,iBAAiB;IACjB,oBAAoB;IACpB,YAAY;IACZ,aAAa;CACL,CAAC;AAEX,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,MAAM,EAAE,SAAS,CAAU,CAAC;AAE3E,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,UAAU;IACV,aAAa;IACb,UAAU;IACV,YAAY;IACZ,YAAY;IACZ,WAAW;IACX,WAAW;IACX,UAAU;IACV,UAAU;IACV,YAAY;CACJ,CAAC;AAEX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,WAAW;IACX,cAAc;IACd,UAAU;CACF,CAAC;AAEX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,KAAK;IACL,oBAAoB;IACpB,aAAa;CACL,CAAC;AAEX,wEAAwE;AACxE,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,UAAU;IACV,UAAU;IACV,WAAW;IACX,QAAQ;IACR,UAAU;IACV,8BAA8B;IAC9B,6BAA6B;IAC7B,8BAA8B;CACtB,CAAC;AAEX,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,OAAO;IACP,OAAO;IACP,UAAU;IACV,UAAU;IACV,WAAW;CACH,CAAC;AAEX,uEAAuE;AACvE,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,QAAQ;IACR,eAAe;IACf,YAAY;IACZ,kBAAkB;CACV,CAAC;AAEX,4DAA4D;AAC5D,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,KAAK,EAAE,YAAY,CAAU,CAAC;AAEtE,iFAAiF;AACjF,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,gBAAgB;IAChB,oBAAoB;CACZ,CAAC;AAEX,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,UAAU,EAAE,gBAAgB,CAAU,CAAC;AAEtE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,eAAe,EAAE,oBAAoB,CAAU,CAAC;AAE/E,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,mBAAmB,CAAU,CAAC;AAE9D;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,cAAc,EAAE,MAAM,CAAU,CAAC;AAEnE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,WAAW,CAAU,CAAC;AAEvD,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,OAAO;IACP,iBAAiB;IACjB,kBAAkB;CACV,CAAC;AAEX,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,KAAK,EAAE,aAAa,CAAU,CAAC;AAE1E,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAM,EAAE,aAAa,CAAU,CAAC;AAExE,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAU,CAAC"}