@notabene/javascript-sdk 2.14.1 → 2.14.2-next.2

package/dist/cjs/notabene.d.ts

@@ -82,6 +82,11 @@ export declare enum AgentType {
     VASP = "VASP"
 }
 
+declare interface BaseRequestConfig {
+    originatorId?: DID_2;
+    beneficiaryId?: DID_2;
+}
+
 /**
  * Beneficiary
  * Represents the receiver of the requested VA transfer
@@ -99,7 +104,7 @@ declare type Beneficiary = {
  * @public
  */
 declare type BeneficiaryFields = {
-    destination?: Destination;
+    destination: Destination;
 };
 
 declare type BeneficiaryV2 = {
@@ -331,32 +336,45 @@ export declare interface ComponentResponse {
 /**
  * Transforms a Notabene component response to IVMS101 format
  *
+ * ## IVMS101 Config by Transaction Type
+ *
+ * The `originator` and `beneficiary` config options provide the customer's PII data.
+ * Which one to use depends on the transaction type:
+ *
+ * - **Withdrawals**: Pass `originator` - the customer is sending funds (customer = originator)
+ * - **Deposits**: Pass `beneficiary` - the customer is receiving funds (customer = beneficiary)
+ *
+ * For self-transfers, the provided data is automatically reused for both parties.
+ *
  * @param response - The response from the Notabene Embedded Component
- * @param delegateToken - The JWT delegate token for extracting the originator ID
+ * @param delegateToken - The JWT delegate token for extracting the customer ID
  * @param config - Configuration object with optional IDs
- * @param config.originatorId - Optional originator ID (auto-extracted from delegateToken if not provided)
- * @param config.beneficiaryId - Optional beneficiary ID (auto-generated if not provided)
- * @param config.referenceId - Optional reference ID for the transaction
- * @param config.originator - Optional originator data in V2 format
+ * @param config.originatorId - Optional originator ID (auto-extracted from delegateToken for withdrawals)
+ * @param config.beneficiaryId - Optional beneficiary ID (auto-extracted from delegateToken for deposits)
+ * @param config.originator - Customer's IVMS101 data for withdrawals (customer is the sender)
+ * @param config.beneficiary - Customer's IVMS101 data for deposits (customer is the receiver)
  * @returns The transformed request body in IVMS101 format
  *
  * @example
  * ```typescript
  * import { componentResponseToIVMS101 } from '$lib/notabene-tx-transformer';
  *
- * const requestBody = componentResponseToIVMS101(
- *   result.response,
- *   session.user.token,
- *   { originator: myOriginatorData }
+ * // For withdrawals: pass originator (customer is sending)
+ * const withdrawalIvms = componentResponseToIVMS101(
+ *   withdrawalResponse,
+ *   delegateToken,
+ *   { originator: customerIvmsData }
  * );
  *
- * await fetch('/entity/${vaspDid}/tx/${txId}/append', {
- *   method: 'POST',
- *   body: JSON.stringify(requestBody)
- * });
+ * // For deposits: pass beneficiary (customer is receiving)
+ * const depositIvms = componentResponseToIVMS101(
+ *   depositResponse,
+ *   delegateToken,
+ *   { beneficiary: customerIvmsData }
+ * );
  * ```
  */
-export declare function componentResponseToIVMS101(response: TransactionResponse<Withdrawal>, delegateToken: string, config?: ResponseToTxRequestConfig): TransactionIVMS101Request;
+export declare function componentResponseToIVMS101(response: TransactionResponse<Withdrawal | Deposit>, delegateToken: string, config?: ResponseToIVMS101RequestConfig): TransactionIVMS101Request;
 
 /**
  * Transforms a Notabene component response to a Version 2 transaction create API request body
@@ -373,9 +391,11 @@ export declare function componentResponseToIVMS101(response: TransactionResponse
  * ```typescript
  * import { componentResponseToTxCreateRequest } from '$lib/notabene-tx-transformer';
  *
- * withdrawal.on('complete', async (result) => {
+ * // Works with both withdrawal and deposit responses
+ * transaction.on('complete', async (result) => {
  *   const requestBody = componentResponseToTxCreateRequest(
  *     result.response,
+ *     delegateToken,
  *     {
  *       originatorId: 'mailto:user@example.com',
  *       beneficiaryId: 'urn:beneficiary:recipient',
@@ -390,7 +410,7 @@ export declare function componentResponseToIVMS101(response: TransactionResponse
  * });
  * ```
  */
-export declare function componentResponseToTxCreateRequest(response: TransactionResponse<Withdrawal>, delegateToken: string, config?: Omit<ResponseToTxRequestConfig, 'originator'>): TransactionCreateRequestV2;
+export declare function componentResponseToTxCreateRequest(response: TransactionResponse<Withdrawal | Deposit>, delegateToken: string, config?: ResponseToTxCreateRequestConfig): TransactionCreateRequestV2;
 
 /**
  * Transforms a Notabene component response into txCreate, IVMS101, and confirmRelationship request bodies
@@ -400,50 +420,50 @@ export declare function componentResponseToTxCreateRequest(response: Transaction
  * which is useful for V2 workflows where you need to create a transaction first,
  * then append IVMS101 data to it, and finally confirm the relationship.
  *
+ * ## IVMS101 Config by Transaction Type
+ *
+ * The `originator` and `beneficiary` config options provide the customer's PII data.
+ * Which one to use depends on the transaction type:
+ *
+ * - **Withdrawals**: Pass `originator` - the customer is sending funds (customer = originator)
+ * - **Deposits**: Pass `beneficiary` - the customer is receiving funds (customer = beneficiary)
+ *
+ * For self-transfers, the provided data is automatically reused for both parties.
+ *
  * @param response - The response from the Notabene Embedded Component
- * @param delegateToken - The JWT delegate token for extracting the originator ID
+ * @param delegateToken - The JWT delegate token for extracting the customer ID
  * @param config - Optional configuration for IDs and reference
- * @param config.originatorId - Optional originator ID (auto-extracted from delegateToken if not provided)
- * @param config.beneficiaryId - Optional beneficiary ID (auto-generated if not provided)
+ * @param config.originatorId - Optional originator ID (auto-extracted from delegateToken for withdrawals)
+ * @param config.beneficiaryId - Optional beneficiary ID (auto-extracted from delegateToken for deposits)
  * @param config.referenceId - Optional reference ID (auto-generated if not provided)
- * @param config.originator - Optional originator data in V2 format
+ * @param config.originator - Customer's IVMS101 data for withdrawals (customer is the sender)
+ * @param config.beneficiary - Customer's IVMS101 data for deposits (customer is the receiver)
  * @returns Object with `createTx`, `ivms101`, and optional `confirmRelationship` properties containing the respective request bodies
  *
  * @example
  * ```typescript
  * import { componentResponseToTxRequests } from '$lib/notabene-tx-transformer';
  *
+ * // For withdrawals: pass originator (customer is sending)
  * withdrawal.on('complete', async (result) => {
- *   const { createTx, ivms101, confirmRelationship } = componentResponseToTxRequests(
+ *   const { createTx, ivms101 } = componentResponseToTxRequests(
  *     result.response,
- *     session.user.token,
- *     { originator: originatorData }
+ *     delegateToken,
+ *     { originator: customerIvmsData }
  *   );
+ * });
  *
- *   // First, create the transaction
- *   const txResponse = await fetch('/entity/${vaspDid}/tx', {
- *     method: 'POST',
- *     body: JSON.stringify(createTx)
- *   });
- *
- *   // Then, append IVMS101 data
- *   const txId = txResponse.transfer['@id'];
- *   await fetch(`/entity/${vaspDid}/tx/${txId}/append`, {
- *     method: 'POST',
- *     body: JSON.stringify(ivms101)
- *   });
- *
- *   // Finally, confirm relationship
- *   if (confirmRelationship) {
- *   await fetch(`/entity/${vaspDid}/relationship?to=${to}&from=${from}`, {
- *       method: 'PATCH',
- *       body: JSON.stringify({ proof: confirmRelationship.proof })
- *     });
- *   }
+ * // For deposits: pass beneficiary (customer is receiving)
+ * deposit.on('complete', async (result) => {
+ *   const { createTx, ivms101 } = componentResponseToTxRequests(
+ *     result.response,
+ *     delegateToken,
+ *     { beneficiary: customerIvmsData }
+ *   );
  * });
  * ```
  */
-export declare function componentResponseToTxRequests(response: TransactionResponse<Withdrawal>, delegateToken: string, config?: ResponseToTxRequestConfig): {
+export declare function componentResponseToTxRequests(response: TransactionResponse<Withdrawal | Deposit>, delegateToken: string, config?: ResponseToTxRequestConfig): {
     createTx: TransactionCreateRequestV2;
     ivms101: TransactionIVMS101Request;
     confirmRelationship?: {
@@ -1475,7 +1495,7 @@ declare type Originator = {
  * @public
  */
 declare type OriginatorFields = {
-    source?: Source | Source[];
+    source: Source | Source[];
 };
 
 declare type OriginatorV2 = {
@@ -1672,13 +1692,18 @@ export declare type ResizeRequest = {
     height: number;
 };
 
-export declare interface ResponseToTxRequestConfig {
-    originatorId?: DID_2;
-    beneficiaryId?: DID_2;
-    referenceId?: string;
+declare interface ResponseToIVMS101RequestConfig extends BaseRequestConfig {
     originator?: OriginatorV2;
+    beneficiary?: BeneficiaryV2;
 }
 
+declare interface ResponseToTxCreateRequestConfig extends BaseRequestConfig {
+    referenceId?: string;
+    settlementAddress?: string;
+}
+
+export declare type ResponseToTxRequestConfig = ResponseToTxCreateRequestConfig & ResponseToIVMS101RequestConfig;
+
 /**
  * Ownership Proof using Screenshot
  * @public
@@ -1796,8 +1821,11 @@ export declare enum Status {
  */
 export declare type Theme = {
     mode: 'light' | 'dark';
+    backgroundColor?: string;
     primaryColor?: string;
+    primaryForeground?: string;
     secondaryColor?: string;
+    secondaryForeground?: string;
     fontFamily?: string;
     logo?: string;
 };
@@ -1922,6 +1950,7 @@ export declare interface TransactionOptions {
     hide?: ValidationSections[];
     counterpartyAssist?: CounterpartyAssistConfig;
     autoSubmit?: boolean;
+    supportUrl?: string;
 }
 
 /**

package/dist/cjs/package.json

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

package/dist/esm/notabene.d.ts

@@ -82,6 +82,11 @@ export declare enum AgentType {
     VASP = "VASP"
 }
 
+declare interface BaseRequestConfig {
+    originatorId?: DID_2;
+    beneficiaryId?: DID_2;
+}
+
 /**
  * Beneficiary
  * Represents the receiver of the requested VA transfer
@@ -99,7 +104,7 @@ declare type Beneficiary = {
  * @public
  */
 declare type BeneficiaryFields = {
-    destination?: Destination;
+    destination: Destination;
 };
 
 declare type BeneficiaryV2 = {
@@ -331,32 +336,45 @@ export declare interface ComponentResponse {
 /**
  * Transforms a Notabene component response to IVMS101 format
  *
+ * ## IVMS101 Config by Transaction Type
+ *
+ * The `originator` and `beneficiary` config options provide the customer's PII data.
+ * Which one to use depends on the transaction type:
+ *
+ * - **Withdrawals**: Pass `originator` - the customer is sending funds (customer = originator)
+ * - **Deposits**: Pass `beneficiary` - the customer is receiving funds (customer = beneficiary)
+ *
+ * For self-transfers, the provided data is automatically reused for both parties.
+ *
  * @param response - The response from the Notabene Embedded Component
- * @param delegateToken - The JWT delegate token for extracting the originator ID
+ * @param delegateToken - The JWT delegate token for extracting the customer ID
  * @param config - Configuration object with optional IDs
- * @param config.originatorId - Optional originator ID (auto-extracted from delegateToken if not provided)
- * @param config.beneficiaryId - Optional beneficiary ID (auto-generated if not provided)
- * @param config.referenceId - Optional reference ID for the transaction
- * @param config.originator - Optional originator data in V2 format
+ * @param config.originatorId - Optional originator ID (auto-extracted from delegateToken for withdrawals)
+ * @param config.beneficiaryId - Optional beneficiary ID (auto-extracted from delegateToken for deposits)
+ * @param config.originator - Customer's IVMS101 data for withdrawals (customer is the sender)
+ * @param config.beneficiary - Customer's IVMS101 data for deposits (customer is the receiver)
  * @returns The transformed request body in IVMS101 format
  *
  * @example
  * ```typescript
  * import { componentResponseToIVMS101 } from '$lib/notabene-tx-transformer';
  *
- * const requestBody = componentResponseToIVMS101(
- *   result.response,
- *   session.user.token,
- *   { originator: myOriginatorData }
+ * // For withdrawals: pass originator (customer is sending)
+ * const withdrawalIvms = componentResponseToIVMS101(
+ *   withdrawalResponse,
+ *   delegateToken,
+ *   { originator: customerIvmsData }
  * );
  *
- * await fetch('/entity/${vaspDid}/tx/${txId}/append', {
- *   method: 'POST',
- *   body: JSON.stringify(requestBody)
- * });
+ * // For deposits: pass beneficiary (customer is receiving)
+ * const depositIvms = componentResponseToIVMS101(
+ *   depositResponse,
+ *   delegateToken,
+ *   { beneficiary: customerIvmsData }
+ * );
  * ```
  */
-export declare function componentResponseToIVMS101(response: TransactionResponse<Withdrawal>, delegateToken: string, config?: ResponseToTxRequestConfig): TransactionIVMS101Request;
+export declare function componentResponseToIVMS101(response: TransactionResponse<Withdrawal | Deposit>, delegateToken: string, config?: ResponseToIVMS101RequestConfig): TransactionIVMS101Request;
 
 /**
  * Transforms a Notabene component response to a Version 2 transaction create API request body
@@ -373,9 +391,11 @@ export declare function componentResponseToIVMS101(response: TransactionResponse
  * ```typescript
  * import { componentResponseToTxCreateRequest } from '$lib/notabene-tx-transformer';
  *
- * withdrawal.on('complete', async (result) => {
+ * // Works with both withdrawal and deposit responses
+ * transaction.on('complete', async (result) => {
  *   const requestBody = componentResponseToTxCreateRequest(
  *     result.response,
+ *     delegateToken,
  *     {
  *       originatorId: 'mailto:user@example.com',
  *       beneficiaryId: 'urn:beneficiary:recipient',
@@ -390,7 +410,7 @@ export declare function componentResponseToIVMS101(response: TransactionResponse
  * });
  * ```
  */
-export declare function componentResponseToTxCreateRequest(response: TransactionResponse<Withdrawal>, delegateToken: string, config?: Omit<ResponseToTxRequestConfig, 'originator'>): TransactionCreateRequestV2;
+export declare function componentResponseToTxCreateRequest(response: TransactionResponse<Withdrawal | Deposit>, delegateToken: string, config?: ResponseToTxCreateRequestConfig): TransactionCreateRequestV2;
 
 /**
  * Transforms a Notabene component response into txCreate, IVMS101, and confirmRelationship request bodies
@@ -400,50 +420,50 @@ export declare function componentResponseToTxCreateRequest(response: Transaction
  * which is useful for V2 workflows where you need to create a transaction first,
  * then append IVMS101 data to it, and finally confirm the relationship.
  *
+ * ## IVMS101 Config by Transaction Type
+ *
+ * The `originator` and `beneficiary` config options provide the customer's PII data.
+ * Which one to use depends on the transaction type:
+ *
+ * - **Withdrawals**: Pass `originator` - the customer is sending funds (customer = originator)
+ * - **Deposits**: Pass `beneficiary` - the customer is receiving funds (customer = beneficiary)
+ *
+ * For self-transfers, the provided data is automatically reused for both parties.
+ *
  * @param response - The response from the Notabene Embedded Component
- * @param delegateToken - The JWT delegate token for extracting the originator ID
+ * @param delegateToken - The JWT delegate token for extracting the customer ID
  * @param config - Optional configuration for IDs and reference
- * @param config.originatorId - Optional originator ID (auto-extracted from delegateToken if not provided)
- * @param config.beneficiaryId - Optional beneficiary ID (auto-generated if not provided)
+ * @param config.originatorId - Optional originator ID (auto-extracted from delegateToken for withdrawals)
+ * @param config.beneficiaryId - Optional beneficiary ID (auto-extracted from delegateToken for deposits)
  * @param config.referenceId - Optional reference ID (auto-generated if not provided)
- * @param config.originator - Optional originator data in V2 format
+ * @param config.originator - Customer's IVMS101 data for withdrawals (customer is the sender)
+ * @param config.beneficiary - Customer's IVMS101 data for deposits (customer is the receiver)
  * @returns Object with `createTx`, `ivms101`, and optional `confirmRelationship` properties containing the respective request bodies
  *
  * @example
  * ```typescript
  * import { componentResponseToTxRequests } from '$lib/notabene-tx-transformer';
  *
+ * // For withdrawals: pass originator (customer is sending)
  * withdrawal.on('complete', async (result) => {
- *   const { createTx, ivms101, confirmRelationship } = componentResponseToTxRequests(
+ *   const { createTx, ivms101 } = componentResponseToTxRequests(
  *     result.response,
- *     session.user.token,
- *     { originator: originatorData }
+ *     delegateToken,
+ *     { originator: customerIvmsData }
  *   );
+ * });
  *
- *   // First, create the transaction
- *   const txResponse = await fetch('/entity/${vaspDid}/tx', {
- *     method: 'POST',
- *     body: JSON.stringify(createTx)
- *   });
- *
- *   // Then, append IVMS101 data
- *   const txId = txResponse.transfer['@id'];
- *   await fetch(`/entity/${vaspDid}/tx/${txId}/append`, {
- *     method: 'POST',
- *     body: JSON.stringify(ivms101)
- *   });
- *
- *   // Finally, confirm relationship
- *   if (confirmRelationship) {
- *   await fetch(`/entity/${vaspDid}/relationship?to=${to}&from=${from}`, {
- *       method: 'PATCH',
- *       body: JSON.stringify({ proof: confirmRelationship.proof })
- *     });
- *   }
+ * // For deposits: pass beneficiary (customer is receiving)
+ * deposit.on('complete', async (result) => {
+ *   const { createTx, ivms101 } = componentResponseToTxRequests(
+ *     result.response,
+ *     delegateToken,
+ *     { beneficiary: customerIvmsData }
+ *   );
  * });
  * ```
  */
-export declare function componentResponseToTxRequests(response: TransactionResponse<Withdrawal>, delegateToken: string, config?: ResponseToTxRequestConfig): {
+export declare function componentResponseToTxRequests(response: TransactionResponse<Withdrawal | Deposit>, delegateToken: string, config?: ResponseToTxRequestConfig): {
     createTx: TransactionCreateRequestV2;
     ivms101: TransactionIVMS101Request;
     confirmRelationship?: {
@@ -1475,7 +1495,7 @@ declare type Originator = {
  * @public
  */
 declare type OriginatorFields = {
-    source?: Source | Source[];
+    source: Source | Source[];
 };
 
 declare type OriginatorV2 = {
@@ -1672,13 +1692,18 @@ export declare type ResizeRequest = {
     height: number;
 };
 
-export declare interface ResponseToTxRequestConfig {
-    originatorId?: DID_2;
-    beneficiaryId?: DID_2;
-    referenceId?: string;
+declare interface ResponseToIVMS101RequestConfig extends BaseRequestConfig {
     originator?: OriginatorV2;
+    beneficiary?: BeneficiaryV2;
 }
 
+declare interface ResponseToTxCreateRequestConfig extends BaseRequestConfig {
+    referenceId?: string;
+    settlementAddress?: string;
+}
+
+export declare type ResponseToTxRequestConfig = ResponseToTxCreateRequestConfig & ResponseToIVMS101RequestConfig;
+
 /**
  * Ownership Proof using Screenshot
  * @public
@@ -1796,8 +1821,11 @@ export declare enum Status {
  */
 export declare type Theme = {
     mode: 'light' | 'dark';
+    backgroundColor?: string;
     primaryColor?: string;
+    primaryForeground?: string;
     secondaryColor?: string;
+    secondaryForeground?: string;
     fontFamily?: string;
     logo?: string;
 };
@@ -1922,6 +1950,7 @@ export declare interface TransactionOptions {
     hide?: ValidationSections[];
     counterpartyAssist?: CounterpartyAssistConfig;
     autoSubmit?: boolean;
+    supportUrl?: string;
 }
 
 /**