@notabene/javascript-sdk 2.19.1 → 2.20.0-next.1

package/dist/cjs/notabene.d.ts

@@ -688,6 +688,14 @@ export declare interface ConnectionMetadata {
     readonly participants: readonly string[];
     readonly transactionType: TransactionType;
     readonly locale?: string;
+    /**
+     * Delivery target for Counterparty Assist completion/closure webhooks.
+     * Sent and stored as plaintext so the connection can route the event, so do not
+     * embed secrets (e.g. `?token=`) in this URL. Webhook payloads carry the encrypted
+     * `sealed` blob, whose successful decryption is itself an authenticity check;
+     * signed delivery is provided by the future Svix-backed pipeline.
+     */
+    readonly webhookUrl?: string;
 }
 
 /**
@@ -832,6 +840,17 @@ export declare type CounterpartyAssistConfig = boolean | {
     counterpartyTypes: PersonType[];
     /** @remarks Requires a transactionId to be passed in. */
     identityVerification?: IdentityVerificationConfig;
+    /**
+     * Optional URL that receives an `EC.counterpartyAssist*` webhook when the
+     * counterparty completes or closes their part. MVP-only per-link override;
+     * superseded by Portal-managed subscriptions post-migration.
+     *
+     * Transmitted and stored as plaintext, so do not embed secrets (e.g. `?token=`)
+     * in this URL. Payloads carry the encrypted `sealed` blob (a successful decrypt
+     * is itself an authenticity check); signed delivery is provided by the future
+     * Svix-backed pipeline.
+     */
+    webhookUrl?: string;
 };
 
 declare type CountryCode = "AF" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "CV" | "KH" | "CM" | "CA" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CD" | "CG" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "CI" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "SZ" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MK" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RO" | "RU" | "RW" | "RE" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW" | "AX" | "XX";
@@ -872,6 +891,17 @@ export declare interface DeclarationProof extends OwnershipProof {
  */
 export declare function decodeFragmentToObject(fragment: string): Record<string, string>;
 
+/**
+ * Decrypt a Counterparty Assist webhook payload with the key the VASP captured
+ * at connection creation. Single call, no network fetch (the webhook already
+ * carried the ciphertext).
+ * @public
+ */
+export declare function decryptCounterpartyAssistPayload<T>({ sealed, key, }: {
+    sealed: string;
+    key: string;
+}): Promise<T>;
+
 /**
  * An object representing a deposit transaction
  * @public
@@ -1117,7 +1147,7 @@ export declare type FieldTypes = {
  * @param refreshSource Source information for the refresh operation
  * @returns Promise resolving to connection result with decrypted data
  */
-export declare function getRefreshResult<T extends ComponentRequest>(refreshSource: RefreshSource): Promise<ConnectionResult<T>>;
+export declare function getRefreshResult<T extends ComponentRequest>(refreshSource: Pick<RefreshSource, 'url' | 'key'>): Promise<ConnectionResult<T>>;
 
 /**
  * Host Message Type enum representing different message types that can be sent
@@ -2837,6 +2867,12 @@ declare interface Refreshable {
 export declare interface RefreshSource {
     url: URI;
     key: string;
+    /**
+     * The connection id (also embedded in `url`). Exposed directly so consumers can
+     * correlate a Counterparty Assist webhook event (whose `payload.id` is this id)
+     * without parsing it out of the url.
+     */
+    id: string;
 }
 
 declare type RequestID = UUID;

package/dist/cjs/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.19.1",
+  "version": "2.20.0-next.1",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",

package/dist/esm/notabene.d.ts

@@ -688,6 +688,14 @@ export declare interface ConnectionMetadata {
     readonly participants: readonly string[];
     readonly transactionType: TransactionType;
     readonly locale?: string;
+    /**
+     * Delivery target for Counterparty Assist completion/closure webhooks.
+     * Sent and stored as plaintext so the connection can route the event, so do not
+     * embed secrets (e.g. `?token=`) in this URL. Webhook payloads carry the encrypted
+     * `sealed` blob, whose successful decryption is itself an authenticity check;
+     * signed delivery is provided by the future Svix-backed pipeline.
+     */
+    readonly webhookUrl?: string;
 }
 
 /**
@@ -832,6 +840,17 @@ export declare type CounterpartyAssistConfig = boolean | {
     counterpartyTypes: PersonType[];
     /** @remarks Requires a transactionId to be passed in. */
     identityVerification?: IdentityVerificationConfig;
+    /**
+     * Optional URL that receives an `EC.counterpartyAssist*` webhook when the
+     * counterparty completes or closes their part. MVP-only per-link override;
+     * superseded by Portal-managed subscriptions post-migration.
+     *
+     * Transmitted and stored as plaintext, so do not embed secrets (e.g. `?token=`)
+     * in this URL. Payloads carry the encrypted `sealed` blob (a successful decrypt
+     * is itself an authenticity check); signed delivery is provided by the future
+     * Svix-backed pipeline.
+     */
+    webhookUrl?: string;
 };
 
 declare type CountryCode = "AF" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "CV" | "KH" | "CM" | "CA" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CD" | "CG" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "CI" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "SZ" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MK" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RO" | "RU" | "RW" | "RE" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW" | "AX" | "XX";
@@ -872,6 +891,17 @@ export declare interface DeclarationProof extends OwnershipProof {
  */
 export declare function decodeFragmentToObject(fragment: string): Record<string, string>;
 
+/**
+ * Decrypt a Counterparty Assist webhook payload with the key the VASP captured
+ * at connection creation. Single call, no network fetch (the webhook already
+ * carried the ciphertext).
+ * @public
+ */
+export declare function decryptCounterpartyAssistPayload<T>({ sealed, key, }: {
+    sealed: string;
+    key: string;
+}): Promise<T>;
+
 /**
  * An object representing a deposit transaction
  * @public
@@ -1117,7 +1147,7 @@ export declare type FieldTypes = {
  * @param refreshSource Source information for the refresh operation
  * @returns Promise resolving to connection result with decrypted data
  */
-export declare function getRefreshResult<T extends ComponentRequest>(refreshSource: RefreshSource): Promise<ConnectionResult<T>>;
+export declare function getRefreshResult<T extends ComponentRequest>(refreshSource: Pick<RefreshSource, 'url' | 'key'>): Promise<ConnectionResult<T>>;
 
 /**
  * Host Message Type enum representing different message types that can be sent
@@ -2837,6 +2867,12 @@ declare interface Refreshable {
 export declare interface RefreshSource {
     url: URI;
     key: string;
+    /**
+     * The connection id (also embedded in `url`). Exposed directly so consumers can
+     * correlate a Counterparty Assist webhook event (whose `payload.id` is this id)
+     * without parsing it out of the url.
+     */
+    id: string;
 }
 
 declare type RequestID = UUID;