@notabene/javascript-sdk 2.9.2 → 2.9.3-next.3

package/README.md

@@ -303,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",
+  },
 });
 ```
 
@@ -312,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.
 
@@ -329,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: {
@@ -348,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',
@@ -356,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.
@@ -436,11 +424,11 @@ If any of the required parameters are missing the component will just show the N
 
 ---
 
-## Counterparty Assist
+## Counterparty Handoff
 
-The **Counterparty Assist** feature enables handoff of data collection to a counterparty or to another device by sharing a secure link. This facilitates more accurate and complete data collection, particularly when the counterparty is able to provide the required information directly.
+**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 can be enabled globally for all counterparty types or selectively for specific types.
+This feature does not function as a standalone component. Instead, it augments the Withdrawal and Deposit flows when configured.
 
 ### Use Cases
 
@@ -454,33 +442,27 @@ During the address verification step, users can share a link to complete self-ho
 
 ### Counterparty Assist Configuration
 
-You can enable **Counterparty Assist** via the `counterpartyAssist` configuration field in one of the following ways:
+You can enable **Counterparty Assist** by specifying the counterparty types you want the feature to apply to using the counterpartyAssist configuration field.
 
-- `true`: Enable for all counterparty types (`self`, `natural`, and `legal`)
-- `false`: Disable the feature entirely
+- `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**
 
-```ts
+```js
 import Notabene, {
   PersonType,
 } from '@notabene/javascript-sdk';
 
-// Counterparty assist is enabled for all counterparty types
-const optionsAllEnabled: TransactionOptions = {
-  ...
-  counterpartyAssist: true, // 'self', 'natural', and 'legal' enabled
-};
-
 // Counterparty assist is enabled for specific counterparty types
 const options: TransactionOptions = {
   ...
   counterpartyAssist: {
     counterpartyTypes: [
-      PersonType.LEGAL, // JS: 'legal'
+      PersonType.LEGAL,   // JS: 'legal'
       PersonType.NATURAL, // JS: 'natural'
-      PersonType.SELF, // JS: 'self'
+      PersonType.SELF,    // JS: 'self'
     ],
   }
 };
@@ -503,7 +485,7 @@ When a third party completes their step after following the shared link, the hos
 
 **Example Response**
 
-```json
+```js
 {
   type: CMType.COMPLETE, // 'complete'
   response: { // transaciton data + refresh source
@@ -549,7 +531,7 @@ To simplify retrieval and decryption, we provide an asynchronous [`getRefreshRes
 
 **Example**
 
-```ts
+```js
 import { getRefreshResult } from "@notabene/javascript-sdk";
 
 const transaction = await getRefreshResult({
@@ -571,7 +553,7 @@ const transaction = await getRefreshResult({
 
 **Example Active Transaction Data**
 
-```json
+```js
 {
   "id": "17f76e4c-9a2a-4c34-afcb-b4868e609a96",
   "metadata": {
@@ -583,14 +565,14 @@ const transaction = await getRefreshResult({
   },
   "status": "active",
   "tx": {
-    ...
+    //...
   }
 }
 ```
 
 **Example Completed Transaction Data**
 
-```json
+```js
 {
   "id": "17f76e4c-9a2a-4c34-afcb-b4868e609a96",
   "metadata": {
@@ -603,19 +585,19 @@ const transaction = await getRefreshResult({
   "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": {
-      ...
+      //...
     }
   }
 }

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.2",
+  "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.2",
+  "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.2",
+  "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);