@notabene/javascript-sdk 2.9.1-next.1 → 2.9.3-next.3

package/README.md

@@ -43,6 +43,11 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
     - [Parameters](#parameters-2)
   - [Deposit Assist](#deposit-assist)
     - [Parameters](#parameters-3)
+  - [Counterparty Assist](#counterparty-assist)
+    - [Use Cases](#use-cases)
+    - [Counterparty Assist Configuration](#counterparty-assist-configuration)
+    - [Component Response](#component-response)
+    - [Retrieving Completed Data](#retrieving-completed-data)
   - [Error handling](#error-handling)
       - [Error reference](#error-reference)
   - [Transaction parameters](#transaction-parameters)
@@ -63,6 +68,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
     - [Counterparty Field Properties](#counterparty-field-properties)
       - [Full Example](#full-example)
       - [Field reference](#field-reference)
+    - [Configure Counterparty Assist](#counterparty-assist-configuration)
   - [Locales](#locales)
   - [Theming](#theming)
   - [License](#license)
@@ -297,6 +303,10 @@ const withdrawal = notabene.createWithdrawalAssist({
     currency: 'USD', // ISO currency code
     price: 1700.12, // Asset price
   },
+  customer: {
+    name: 'John Smith',
+    email: "john.smith@domain.com",
+  },
 });
 ```
 
@@ -306,6 +316,7 @@ const withdrawal = notabene.createWithdrawalAssist({
 - `destination`: The destination or blockchain address for the withdrawal. See [Destination](#destination)
 - `amountDecimal`: The amount to transfer in decimal format. See [Transaction Amount](#transaction-amount)
 - `assetPrice`: Optional price information in a fiat currency. See [Asset Price](#asset-price)
+- `customer`: Optional Customer object containing their name and email
 
 If any of the required parameters are missing the component will just show the Notabene badge.
 
@@ -323,6 +334,10 @@ const withdrawal = notabene.createWithdrawalAssist(
       currency: 'USD', // ISO currency code
       price: 1700.12, // Asset price
     },
+    customer: {
+      name: 'John Smith',
+      email: "john.smith@domain.com",
+    },
   },
   {
     proofs: {
@@ -342,6 +357,10 @@ See [Transaction Options](#transaction-options)
 
 The Connect Wallet component helps you collect and verify the address of your users self-hosted wallet in one go.
 
+### Parameters
+
+- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
+
 ```js
 const connect = notabene.createConnectWallet({
   asset: 'ETH',
@@ -350,31 +369,6 @@ const connect = notabene.createConnectWallet({
 const { proof, txCreate } = await connect.openModal();
 ```
 
-### Parameters
-
-- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
-
-### Configuration Options
-
-Include configuration Options as a second optional parameter:
-
-```js
-const connect = notabene.createConnectWallet(
-  {
-    asset: 'ETH',
-  },
-  {
-    proofs: {
-      microTransfer: {
-        destination: '0x...',
-        amountSubunits: '12344',
-        timeout: 86440,
-      },
-    },
-  },
-);
-```
-
 ## Deposit Request
 
 The Deposit Request lets your customers request deposits that are fully Travel Rule compliant.
@@ -430,6 +424,188 @@ If any of the required parameters are missing the component will just show the N
 
 ---
 
+## Counterparty Handoff
+
+**Counterparty Assist** is a feature built into the existing **Withdrawal** and **Deposit Assist** components. When enabled, it allows users to hand off data collection to a counterparty — or to another device — by sharing a secure link. This helps ensure more accurate and complete information, especially when the counterparty is best suited to provide the required data.
+
+This feature does not function as a standalone component. Instead, it augments the Withdrawal and Deposit flows when configured.
+
+### Use Cases
+
+#### Third Parties (`natural`, `legal`)
+
+During the counterparty data collection step, users can generate and share a link to allow third-party counterparties (individuals or organizations) to enter their own data. This ensures data accuracy and supports robust address verification by allowing the rightful owner to provide the necessary information.
+
+#### First Parties (`self`)
+
+During the address verification step, users can share a link to complete self-hosted wallet proof submissions on another device. This is especially useful if the original device used to initiate the process doesn't support signing or wallet access.
+
+### Counterparty Assist Configuration
+
+You can enable **Counterparty Assist** by specifying the counterparty types you want the feature to apply to using the counterpartyAssist configuration field.
+
+- `false`: Disable the feature explicitly
+- `undefined` (not configured): Feature is disabled by default
+- `{ counterpartyTypes: [PersonType.SELF, PersonType.NATURAL, PersonType.LEGAL] }`: Enable for specific counterparty types
+
+**Example Config**
+
+```js
+import Notabene, {
+  PersonType,
+} from '@notabene/javascript-sdk';
+
+// Counterparty assist is enabled for specific counterparty types
+const options: TransactionOptions = {
+  ...
+  counterpartyAssist: {
+    counterpartyTypes: [
+      PersonType.LEGAL,   // JS: 'legal'
+      PersonType.NATURAL, // JS: 'natural'
+      PersonType.SELF,    // JS: 'self'
+    ],
+  }
+};
+```
+
+### Component Response
+
+The component emits a response once a participant has completed their portion of the process. Depending on the party type — **Third Party** (`natural`, `legal`) or **First Party** (`self`) — the behavior and expectations differ slightly.
+
+#### Third Parties (`natural`, `legal`)
+
+When a third party completes their step after following the shared link, the host application will receive a **`COMPLETE`** message from the component. However, because not all required data may be available at this point, the `response` object will include the information gathered so far, along with a `refreshSource` field. This allows the host to fetch the latest encrypted data once it's available.
+
+##### Refresh Source Fields
+
+| Field | Type   | Description                                                                                      |
+|-------|--------|--------------------------------------------------------------------------------------------------|
+| `url` | URI    | The endpoint where the host can retrieve the encrypted data.                                     |
+| `key` | string | The encryption key used to decrypt the PII (Personally Identifiable Information). Not stored by Notabene. |
+
+**Example Response**
+
+```js
+{
+  type: CMType.COMPLETE, // 'complete'
+  response: { // transaciton data + refresh source
+    destination: "0xFf9A04788972C3803959454ECAE1ed327826a216",
+    asset: "eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+      customer: {
+        type: "natural",
+        name: "sdfsd",
+        email: "sdjlf@sdlfj.com"
+      },
+    amountDecimal: 100,
+    counterparty: {
+      type: "natural"
+    },
+    account: {
+      caip10: "eip155:1:0xFf9A04788972C3803959454ECAE1ed327826a216",
+      blockchainAddress: "0xFf9A04788972C3803959454ECAE1ed327826a216",
+      chain: "eip155:1",
+      did: "did:pkh:eip155:1:0xFf9A04788972C3803959454ECAE1ed327826a216",
+      valid: true
+    },
+    refreshSource: {
+      url: "https://safe-connections.notabene.id/17f76e4c-9a2a-4c34-afcb-b4868e609a96", // endpoint to retreive data
+      key: "1Lcp5SFhaMHH7CAEILrS8IWA6BXS4tFZunPx08WU5Ok=" // key that can be used to decrypt data
+    }
+  }
+}
+```
+
+#### First Parties (`self`)
+
+When the user is the originator (i.e., acting on their own behalf), they complete the verification process via a shared link and are then prompted to return to the original page to continue.
+
+Upon completion, the component emits a **`COMPLETE`** response. In this case, the component handles all necessary data updates internally, so **no additional action is required from the host** to retrieve updated data. The host can directly proceed to submit the transfer to the Notabene API.
+
+### Retrieving Completed Data  
+**(Third Parties Only: `natural`, `legal`)**
+
+When data submission is handed off to third parties, we cannot predict how long it will take them to complete the process. For this reason, we provide the host with all the information needed to retrieve the data and allow them to design how the user experiences this flow.
+
+To simplify retrieval and decryption, we provide an asynchronous [`getRefreshResult`](./docs/notabene/functions/getRefreshResult.md) function. It accepts a `refreshSource` and returns information about the associated transaction. 
+
+
+**Example**
+
+```js
+import { getRefreshResult } from "@notabene/javascript-sdk";
+
+const transaction = await getRefreshResult({
+  url: "https://safe-connections.notabene.id/17f76e4c-9a2a-4c34-afcb-b4868e609a96",
+  key: "1Lcp5SFhaMHH7CAEILrS8IWA6BXS4tFZunPx08WU5Ok="
+})
+```
+
+#### Response from `getRefreshResult`
+
+| **Property** | **Type**                              | **Optional?** | **Description**                                                                 |
+|--------------|---------------------------------------|---------------|---------------------------------------------------------------------------------|
+| `id`         | `UUID`                                | No            | Unique identifier for the transaction.                                          |
+| `metadata`   | `ConnectionMetadata`                  | No            | Metadata associated with the transaction.                                       |
+| `status`     | `'active'` \| `'completed'` \| `'closed'` | No         | Current status of the transaction’s data collection.                           |
+| `tx`         | `T`                                   | Yes           | Ongoing transaction data (available when status is `active`).                   |
+| `result`     | `TransactionResponse<T>`              | Yes           | Finalized transaction data (available when status is `completed`).             |
+
+
+**Example Active Transaction Data**
+
+```js
+{
+  "id": "17f76e4c-9a2a-4c34-afcb-b4868e609a96",
+  "metadata": {
+    "participants": [
+      "did:ethr:0x54b75d2a0925508682e65194cccb6f1e8eaafb2c"
+    ],
+    "nodeUrl": "https://api-qa.eu.notabene.id",
+    "transactionType": "withdraw"
+  },
+  "status": "active",
+  "tx": {
+    //...
+  }
+}
+```
+
+**Example Completed Transaction Data**
+
+```js
+{
+  "id": "17f76e4c-9a2a-4c34-afcb-b4868e609a96",
+  "metadata": {
+    "participants": [
+      "did:ethr:0x54b75d2a0925508682e65194cccb6f1e8eaafb2c" // DID of transaction participants
+    ],
+    "nodeUrl": "https://api-qa.eu.notabene.dev",
+    "transactionType": "withdraw"
+  },
+  "status": "completed",
+  "result": { // the response returned from the embedded component when all information is successfully collected
+    "proof": {
+      //...
+    },
+    "txCreate": {
+      //...
+    },
+    "errors": [],
+    "status": "pending",
+    "valid": true,
+    "value": {
+      //...
+    },
+    "ivms101": {
+      //...
+    }
+  }
+}
+
+```
+
+Once the host has retrieved the completed data, they can finalize the transaction by submitting it to the Notabene API.
+
 ## Error handling
 
 If any error occurs, the `error` event is passed containing a message.
@@ -584,6 +760,13 @@ const options: TransactionOptions = {
       VASPSearchControl.PENDING, // JS: 'pending'
     ], // Control searches for VASPs - Defaults to undefined
   },
+  counterpartyAssist: { // Allows users to share a link to collect counterparty data
+    counterpartyTypes: [
+      PersonType.LEGAL, // JS: 'legal'
+      PersonType.NATURAL, // JS: 'natural'
+      PersonType.SELF, // JS: 'self'
+    ],
+  }
 };
 const withdrawal = notabene.createWithdrawalAssist(tx, options);
 ```

package/dist/cjs/notabene.d.ts

@@ -303,10 +303,10 @@ export declare interface ComponentResponse {
 }
 
 export declare interface ConnectionData<T extends ComponentRequest> {
-    tx: T;
-    authToken?: string;
-    txOptions?: TransactionOptions;
-    result?: TransactionResponse<T>;
+    readonly tx: T;
+    readonly authToken?: string;
+    readonly txOptions?: TransactionOptions;
+    readonly result?: TransactionResponse<T>;
 }
 
 /**
@@ -317,21 +317,26 @@ export declare class ConnectionManager {
     constructor(endpoint: string);
     /**
      * Creates a new encrypted connection
+     * @template T Type of component request
      * @param data The component request data to encrypt and store
-     * @param participants Array of participant identifiers
+     * @param metadata Connection metadata including participants and transaction type
      * @returns Promise resolving to connection details including ID, version, and encryption key
      */
     create<T extends ComponentRequest>(data: ConnectionData<T>, metadata: ConnectionMetadata): Promise<ConnectionResponse<T>>;
     /**
      * Updates an existing connection with new encrypted data
+     * @template T Type of component request
      * @param id Connection ID
      * @param data New data to encrypt and store
      * @param version Current version number
+     * @param status New connection status
+     * @param key Current encryption key
      * @returns Promise resolving to updated connection details including new encryption key
      */
     update<T extends ComponentRequest>(id: UUID, data: ConnectionData<T>, version: number, status: ConnectionStatus, key: string): Promise<ConnectionResponse<T>>;
     /**
      * Retrieves and decrypts connection data
+     * @template T Type of component request
      * @param id Connection ID
      * @param key Encryption key from previous create/update operation
      * @returns Promise resolving to connection details including decrypted data
@@ -340,14 +345,15 @@ export declare class ConnectionManager {
     /**
      * Closes a connection
      * @param id Connection ID
+     * @returns Promise resolving when the connection is closed
      */
     close(id: UUID): Promise<void>;
 }
 
 export declare interface ConnectionMetadata {
-    nodeUrl?: string;
-    participants: string[];
-    transactionType: TransactionType;
+    readonly nodeUrl?: string;
+    readonly participants: readonly string[];
+    readonly transactionType: TransactionType;
 }
 
 /**
@@ -365,21 +371,29 @@ export declare interface ConnectionRequest extends ComponentRequest {
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {
-    id: UUID;
-    version: number;
-    status: ConnectionStatus;
-    metadata: ConnectionMetadata;
-    data: ConnectionData<T>;
-    key: string;
+    readonly id: UUID;
+    readonly version: number;
+    readonly status: ConnectionStatus;
+    readonly metadata: ConnectionMetadata;
+    readonly data: ConnectionData<T>;
+    readonly key: string;
 }
 
-export declare interface ConnectionResult<T extends ComponentRequest> {
-    id: UUID;
-    metadata: ConnectionMetadata;
-    status: ConnectionStatus;
-    tx?: T;
-    result?: TransactionResponse<T>;
-}
+export declare type ConnectionResult<T extends ComponentRequest> = {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'closed';
+} | {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'completed';
+    readonly result: TransactionResponse<T>;
+} | {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'active';
+    readonly tx: T;
+};
 
 export declare type ConnectionStatus = 'active' | 'completed' | 'closed';
 
@@ -666,7 +680,6 @@ export declare enum ErrorIdentifierCode {
  */
 export declare type FieldOptions = boolean | string[] | {
     optional: boolean;
-    transmit: boolean;
 };
 
 /**
@@ -678,6 +691,12 @@ export declare type FieldTypes = {
     legalPerson?: LegalPersonFields;
 };
 
+/**
+ * Retrieves and processes connection refresh data
+ * @template T Type of component request
+ * @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>>;
 
 /**
@@ -1547,6 +1566,7 @@ export declare interface TransactionOptions {
         fallbacks?: ProofTypes[];
         deminimis?: ThresholdOptions;
     };
+    jurisdiction?: string;
     allowedAgentTypes?: AgentType[];
     allowedCounterpartyTypes?: PersonType[];
     fields?: FieldTypes;
@@ -1727,6 +1747,7 @@ export declare interface VASP extends Agent {
     logo?: URI;
     website?: URI;
     countryOfRegistration?: ISOCountryCode;
+    jurisdictions?: string;
 }
 
 /**

package/dist/cjs/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.9.1-next.1",
+  "version": "2.9.3-next.3",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",
@@ -53,6 +53,7 @@
     "build:dev": "yarn build && yarn dev",
     "build:clean": "rimraf dist ts-out coverage temp",
     "build": "vite build && yarn typecheck && api-extractor run --local && node scripts/copy-types.mjs && yarn docs",
+    "build:no-docs": "vite build && yarn typecheck && api-extractor run --local && node scripts/copy-types.mjs",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "yarn lint --fix --cache --no-warn-ignored",
     "format": "prettier --write --cache .",

package/dist/esm/notabene.d.ts

@@ -303,10 +303,10 @@ export declare interface ComponentResponse {
 }
 
 export declare interface ConnectionData<T extends ComponentRequest> {
-    tx: T;
-    authToken?: string;
-    txOptions?: TransactionOptions;
-    result?: TransactionResponse<T>;
+    readonly tx: T;
+    readonly authToken?: string;
+    readonly txOptions?: TransactionOptions;
+    readonly result?: TransactionResponse<T>;
 }
 
 /**
@@ -317,21 +317,26 @@ export declare class ConnectionManager {
     constructor(endpoint: string);
     /**
      * Creates a new encrypted connection
+     * @template T Type of component request
      * @param data The component request data to encrypt and store
-     * @param participants Array of participant identifiers
+     * @param metadata Connection metadata including participants and transaction type
      * @returns Promise resolving to connection details including ID, version, and encryption key
      */
     create<T extends ComponentRequest>(data: ConnectionData<T>, metadata: ConnectionMetadata): Promise<ConnectionResponse<T>>;
     /**
      * Updates an existing connection with new encrypted data
+     * @template T Type of component request
      * @param id Connection ID
      * @param data New data to encrypt and store
      * @param version Current version number
+     * @param status New connection status
+     * @param key Current encryption key
      * @returns Promise resolving to updated connection details including new encryption key
      */
     update<T extends ComponentRequest>(id: UUID, data: ConnectionData<T>, version: number, status: ConnectionStatus, key: string): Promise<ConnectionResponse<T>>;
     /**
      * Retrieves and decrypts connection data
+     * @template T Type of component request
      * @param id Connection ID
      * @param key Encryption key from previous create/update operation
      * @returns Promise resolving to connection details including decrypted data
@@ -340,14 +345,15 @@ export declare class ConnectionManager {
     /**
      * Closes a connection
      * @param id Connection ID
+     * @returns Promise resolving when the connection is closed
      */
     close(id: UUID): Promise<void>;
 }
 
 export declare interface ConnectionMetadata {
-    nodeUrl?: string;
-    participants: string[];
-    transactionType: TransactionType;
+    readonly nodeUrl?: string;
+    readonly participants: readonly string[];
+    readonly transactionType: TransactionType;
 }
 
 /**
@@ -365,21 +371,29 @@ export declare interface ConnectionRequest extends ComponentRequest {
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {
-    id: UUID;
-    version: number;
-    status: ConnectionStatus;
-    metadata: ConnectionMetadata;
-    data: ConnectionData<T>;
-    key: string;
+    readonly id: UUID;
+    readonly version: number;
+    readonly status: ConnectionStatus;
+    readonly metadata: ConnectionMetadata;
+    readonly data: ConnectionData<T>;
+    readonly key: string;
 }
 
-export declare interface ConnectionResult<T extends ComponentRequest> {
-    id: UUID;
-    metadata: ConnectionMetadata;
-    status: ConnectionStatus;
-    tx?: T;
-    result?: TransactionResponse<T>;
-}
+export declare type ConnectionResult<T extends ComponentRequest> = {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'closed';
+} | {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'completed';
+    readonly result: TransactionResponse<T>;
+} | {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'active';
+    readonly tx: T;
+};
 
 export declare type ConnectionStatus = 'active' | 'completed' | 'closed';
 
@@ -666,7 +680,6 @@ export declare enum ErrorIdentifierCode {
  */
 export declare type FieldOptions = boolean | string[] | {
     optional: boolean;
-    transmit: boolean;
 };
 
 /**
@@ -678,6 +691,12 @@ export declare type FieldTypes = {
     legalPerson?: LegalPersonFields;
 };
 
+/**
+ * Retrieves and processes connection refresh data
+ * @template T Type of component request
+ * @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>>;
 
 /**
@@ -1547,6 +1566,7 @@ export declare interface TransactionOptions {
         fallbacks?: ProofTypes[];
         deminimis?: ThresholdOptions;
     };
+    jurisdiction?: string;
     allowedAgentTypes?: AgentType[];
     allowedCounterpartyTypes?: PersonType[];
     fields?: FieldTypes;
@@ -1727,6 +1747,7 @@ export declare interface VASP extends Agent {
     logo?: URI;
     website?: URI;
     countryOfRegistration?: ISOCountryCode;
+    jurisdictions?: string;
 }
 
 /**

package/dist/esm/notabene.js

@@ -338,8 +338,9 @@ class S {
   }
   /**
    * Creates a new encrypted connection
+   * @template T Type of component request
    * @param data The component request data to encrypt and store
-   * @param participants Array of participant identifiers
+   * @param metadata Connection metadata including participants and transaction type
    * @returns Promise resolving to connection details including ID, version, and encryption key
    */
   async create(e, n) {
@@ -367,9 +368,12 @@ class S {
   }
   /**
    * Updates an existing connection with new encrypted data
+   * @template T Type of component request
    * @param id Connection ID
    * @param data New data to encrypt and store
    * @param version Current version number
+   * @param status New connection status
+   * @param key Current encryption key
    * @returns Promise resolving to updated connection details including new encryption key
    */
   async update(e, n, s, r, i) {
@@ -398,6 +402,7 @@ class S {
   }
   /**
    * Retrieves and decrypts connection data
+   * @template T Type of component request
    * @param id Connection ID
    * @param key Encryption key from previous create/update operation
    * @returns Promise resolving to connection details including decrypted data
@@ -424,6 +429,7 @@ class S {
   /**
    * Closes a connection
    * @param id Connection ID
+   * @returns Promise resolving when the connection is closed
    */
   async close(e) {
     const n = await fetch(`${this.endpoint}/${e}`, {

package/dist/esm/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.9.1-next.1",
+  "version": "2.9.3-next.3",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",
@@ -53,6 +53,7 @@
     "build:dev": "yarn build && yarn dev",
     "build:clean": "rimraf dist ts-out coverage temp",
     "build": "vite build && yarn typecheck && api-extractor run --local && node scripts/copy-types.mjs && yarn docs",
+    "build:no-docs": "vite build && yarn typecheck && api-extractor run --local && node scripts/copy-types.mjs",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "yarn lint --fix --cache --no-warn-ignored",
     "format": "prettier --write --cache .",

package/dist/notabene.d.ts

@@ -303,10 +303,10 @@ export declare interface ComponentResponse {
 }
 
 export declare interface ConnectionData<T extends ComponentRequest> {
-    tx: T;
-    authToken?: string;
-    txOptions?: TransactionOptions;
-    result?: TransactionResponse<T>;
+    readonly tx: T;
+    readonly authToken?: string;
+    readonly txOptions?: TransactionOptions;
+    readonly result?: TransactionResponse<T>;
 }
 
 /**
@@ -317,21 +317,26 @@ export declare class ConnectionManager {
     constructor(endpoint: string);
     /**
      * Creates a new encrypted connection
+     * @template T Type of component request
      * @param data The component request data to encrypt and store
-     * @param participants Array of participant identifiers
+     * @param metadata Connection metadata including participants and transaction type
      * @returns Promise resolving to connection details including ID, version, and encryption key
      */
     create<T extends ComponentRequest>(data: ConnectionData<T>, metadata: ConnectionMetadata): Promise<ConnectionResponse<T>>;
     /**
      * Updates an existing connection with new encrypted data
+     * @template T Type of component request
      * @param id Connection ID
      * @param data New data to encrypt and store
      * @param version Current version number
+     * @param status New connection status
+     * @param key Current encryption key
      * @returns Promise resolving to updated connection details including new encryption key
      */
     update<T extends ComponentRequest>(id: UUID, data: ConnectionData<T>, version: number, status: ConnectionStatus, key: string): Promise<ConnectionResponse<T>>;
     /**
      * Retrieves and decrypts connection data
+     * @template T Type of component request
      * @param id Connection ID
      * @param key Encryption key from previous create/update operation
      * @returns Promise resolving to connection details including decrypted data
@@ -340,14 +345,15 @@ export declare class ConnectionManager {
     /**
      * Closes a connection
      * @param id Connection ID
+     * @returns Promise resolving when the connection is closed
      */
     close(id: UUID): Promise<void>;
 }
 
 export declare interface ConnectionMetadata {
-    nodeUrl?: string;
-    participants: string[];
-    transactionType: TransactionType;
+    readonly nodeUrl?: string;
+    readonly participants: readonly string[];
+    readonly transactionType: TransactionType;
 }
 
 /**
@@ -365,21 +371,29 @@ export declare interface ConnectionRequest extends ComponentRequest {
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {
-    id: UUID;
-    version: number;
-    status: ConnectionStatus;
-    metadata: ConnectionMetadata;
-    data: ConnectionData<T>;
-    key: string;
+    readonly id: UUID;
+    readonly version: number;
+    readonly status: ConnectionStatus;
+    readonly metadata: ConnectionMetadata;
+    readonly data: ConnectionData<T>;
+    readonly key: string;
 }
 
-export declare interface ConnectionResult<T extends ComponentRequest> {
-    id: UUID;
-    metadata: ConnectionMetadata;
-    status: ConnectionStatus;
-    tx?: T;
-    result?: TransactionResponse<T>;
-}
+export declare type ConnectionResult<T extends ComponentRequest> = {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'closed';
+} | {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'completed';
+    readonly result: TransactionResponse<T>;
+} | {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'active';
+    readonly tx: T;
+};
 
 export declare type ConnectionStatus = 'active' | 'completed' | 'closed';
 
@@ -666,7 +680,6 @@ export declare enum ErrorIdentifierCode {
  */
 export declare type FieldOptions = boolean | string[] | {
     optional: boolean;
-    transmit: boolean;
 };
 
 /**
@@ -678,6 +691,12 @@ export declare type FieldTypes = {
     legalPerson?: LegalPersonFields;
 };
 
+/**
+ * Retrieves and processes connection refresh data
+ * @template T Type of component request
+ * @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>>;
 
 /**
@@ -1547,6 +1566,7 @@ export declare interface TransactionOptions {
         fallbacks?: ProofTypes[];
         deminimis?: ThresholdOptions;
     };
+    jurisdiction?: string;
     allowedAgentTypes?: AgentType[];
     allowedCounterpartyTypes?: PersonType[];
     fields?: FieldTypes;
@@ -1727,6 +1747,7 @@ export declare interface VASP extends Agent {
     logo?: URI;
     website?: URI;
     countryOfRegistration?: ISOCountryCode;
+    jurisdictions?: string;
 }
 
 /**

package/dist/notabene.js

@@ -338,8 +338,9 @@ class S {
   }
   /**
    * Creates a new encrypted connection
+   * @template T Type of component request
    * @param data The component request data to encrypt and store
-   * @param participants Array of participant identifiers
+   * @param metadata Connection metadata including participants and transaction type
    * @returns Promise resolving to connection details including ID, version, and encryption key
    */
   async create(e, n) {
@@ -367,9 +368,12 @@ class S {
   }
   /**
    * Updates an existing connection with new encrypted data
+   * @template T Type of component request
    * @param id Connection ID
    * @param data New data to encrypt and store
    * @param version Current version number
+   * @param status New connection status
+   * @param key Current encryption key
    * @returns Promise resolving to updated connection details including new encryption key
    */
   async update(e, n, s, r, i) {
@@ -398,6 +402,7 @@ class S {
   }
   /**
    * Retrieves and decrypts connection data
+   * @template T Type of component request
    * @param id Connection ID
    * @param key Encryption key from previous create/update operation
    * @returns Promise resolving to connection details including decrypted data
@@ -424,6 +429,7 @@ class S {
   /**
    * Closes a connection
    * @param id Connection ID
+   * @returns Promise resolving when the connection is closed
    */
   async close(e) {
     const n = await fetch(`${this.endpoint}/${e}`, {

package/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.9.1-next.1",
+  "version": "2.9.3-next.3",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",
@@ -53,6 +53,7 @@
     "build:dev": "yarn build && yarn dev",
     "build:clean": "rimraf dist ts-out coverage temp",
     "build": "vite build && yarn typecheck && api-extractor run --local && node scripts/copy-types.mjs && yarn docs",
+    "build:no-docs": "vite build && yarn typecheck && api-extractor run --local && node scripts/copy-types.mjs",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "yarn lint --fix --cache --no-warn-ignored",
     "format": "prettier --write --cache .",

package/src/types.ts

@@ -301,6 +301,7 @@ export interface VASP extends Agent {
   logo?: URI;
   website?: URI;
   countryOfRegistration?: ISOCountryCode;
+  jurisdictions?: string;
 }
 
 /**
@@ -757,7 +758,6 @@ export type FieldOptions =
   | string[] // fields to show
   | {
       optional: boolean; // Shown but optional
-      transmit: boolean; // Transmit as part of IVMS 101 to counterparty
     };
 
 /**
@@ -850,6 +850,7 @@ export interface TransactionOptions {
     fallbacks?: ProofTypes[];
     deminimis?: ThresholdOptions;
   };
+  jurisdiction?: string;
   allowedAgentTypes?: AgentType[]; // Defaults to All
   allowedCounterpartyTypes?: PersonType[]; // Defaults to All
   fields?: FieldTypes;

package/src/utils/connections.ts

@@ -9,35 +9,54 @@ import { seal, unseal } from './encryption';
 
 export type TransactionType = 'withdraw' | 'deposit';
 export type ConnectionStatus = 'active' | 'completed' | 'closed';
+
 export interface ConnectionData<T extends ComponentRequest> {
-  tx: T;
-  authToken?: string;
-  txOptions?: TransactionOptions;
-  result?: TransactionResponse<T>;
+  readonly tx: T;
+  readonly authToken?: string;
+  readonly txOptions?: TransactionOptions;
+  readonly result?: TransactionResponse<T>;
 }
 
 export interface ConnectionMetadata {
-  nodeUrl?: string;
-  participants: string[];
-  transactionType: TransactionType;
+  readonly nodeUrl?: string;
+  readonly participants: readonly string[];
+  readonly transactionType: TransactionType;
 }
+
 export interface ConnectionResponse<T extends ComponentRequest> {
-  id: UUID;
-  version: number;
-  status: ConnectionStatus;
-  metadata: ConnectionMetadata;
-  data: ConnectionData<T>;
-  key: string;
+  readonly id: UUID;
+  readonly version: number;
+  readonly status: ConnectionStatus;
+  readonly metadata: ConnectionMetadata;
+  readonly data: ConnectionData<T>;
+  readonly key: string;
 }
 
-export interface ConnectionResult<T extends ComponentRequest> {
-  id: UUID;
-  metadata: ConnectionMetadata;
-  status: ConnectionStatus;
-  tx?: T;
-  result?: TransactionResponse<T>;
-}
+export type ConnectionResult<T extends ComponentRequest> =
+  | {
+      readonly id: UUID;
+      readonly metadata: ConnectionMetadata;
+      readonly status: 'closed';
+    }
+  | {
+      readonly id: UUID;
+      readonly metadata: ConnectionMetadata;
+      readonly status: 'completed';
+      readonly result: TransactionResponse<T>;
+    }
+  | {
+      readonly id: UUID;
+      readonly metadata: ConnectionMetadata;
+      readonly status: 'active';
+      readonly tx: T;
+    };
 
+/**
+ * Retrieves and processes connection refresh data
+ * @template T Type of component request
+ * @param refreshSource Source information for the refresh operation
+ * @returns Promise resolving to connection result with decrypted data
+ */
 export async function getRefreshResult<T extends ComponentRequest>(
   refreshSource: RefreshSource,
 ): Promise<ConnectionResult<T>> {
@@ -99,8 +118,9 @@ export class ConnectionManager {
 
   /**
    * Creates a new encrypted connection
+   * @template T Type of component request
    * @param data The component request data to encrypt and store
-   * @param participants Array of participant identifiers
+   * @param metadata Connection metadata including participants and transaction type
    * @returns Promise resolving to connection details including ID, version, and encryption key
    */
   async create<T extends ComponentRequest>(
@@ -143,9 +163,12 @@ export class ConnectionManager {
 
   /**
    * Updates an existing connection with new encrypted data
+   * @template T Type of component request
    * @param id Connection ID
    * @param data New data to encrypt and store
    * @param version Current version number
+   * @param status New connection status
+   * @param key Current encryption key
    * @returns Promise resolving to updated connection details including new encryption key
    */
   async update<T extends ComponentRequest>(
@@ -192,6 +215,7 @@ export class ConnectionManager {
 
   /**
    * Retrieves and decrypts connection data
+   * @template T Type of component request
    * @param id Connection ID
    * @param key Encryption key from previous create/update operation
    * @returns Promise resolving to connection details including decrypted data
@@ -233,6 +257,7 @@ export class ConnectionManager {
   /**
    * Closes a connection
    * @param id Connection ID
+   * @returns Promise resolving when the connection is closed
    */
   async close(id: UUID): Promise<void> {
     const response = await fetch(`${this.endpoint}/${id}`, {

package/src/utils/encryption.ts

@@ -3,15 +3,16 @@
  */
 export interface Sealed {
   /** Base64-encoded ciphertext combined with initialization vector (IV) */
-  ciphertext: string;
+  readonly ciphertext: string;
   /** Base64-encoded encryption key */
-  key: string;
+  readonly key: string;
 }
 
 /**
  * Encrypts an object using AES-GCM encryption.
  * @template T Type of data to encrypt
  * @param data Data to encrypt
+ * @param existingKey Optional existing key to use for encryption
  * @returns Promise resolving to a Sealed object containing ciphertext and key
  */
 export async function seal<T>(data: T, existingKey?: string): Promise<Sealed> {
@@ -56,7 +57,6 @@ export async function seal<T>(data: T, existingKey?: string): Promise<Sealed> {
  * @param sealed Sealed object containing ciphertext and key
  * @returns Promise resolving to the original decrypted data
  */
-
 export async function unseal<T>({ ciphertext, key }: Sealed): Promise<T> {
   // Split the IV and the ciphertext
   const [ivBase64, ciphertextBase64] = ciphertext.split('-');
@@ -91,7 +91,11 @@ export async function unseal<T>({ ciphertext, key }: Sealed): Promise<T> {
   return JSON.parse(decoder.decode(plaintextBuffer));
 }
 
-// Utility function to convert ArrayBuffer to Base64
+/**
+ * Converts an ArrayBuffer to a Base64 string
+ * @param buffer The ArrayBuffer to convert
+ * @returns Base64 encoded string
+ */
 function arrayBufferToBase64(buffer: ArrayBuffer): string {
   const uint8Array = new Uint8Array(buffer);
   let binary = '';
@@ -101,8 +105,11 @@ function arrayBufferToBase64(buffer: ArrayBuffer): string {
   return btoa(binary);
 }
 
-// Utility function to convert Base64 to ArrayBuffer
-
+/**
+ * Converts a Base64 string to a Uint8Array
+ * @param base64 The Base64 string to convert
+ * @returns Uint8Array containing the decoded data
+ */
 function base64ToUint8Array(base64: string): Uint8Array {
   const binary = atob(base64);
   const buffer = new Uint8Array(binary.length);