@notabene/javascript-sdk 2.12.0 → 2.13.0-next.2

package/dist/esm/notabene.d.ts

@@ -1,3 +1,6 @@
+import type { Agent as Agent_2 } from '@taprsvp/types';
+import type { DID as DID_2 } from '@taprsvp/types';
+
 /**
  * A blockchain account
  * @public
@@ -99,6 +102,11 @@ declare type BeneficiaryFields = {
     destination?: Destination;
 };
 
+declare type BeneficiaryV2 = {
+    beneficiaryPerson: PersonV2[];
+    customerIdentification?: string;
+};
+
 /**
  * Beneficiary VASP
  * Represents the VASP which receives the VA transfer
@@ -320,6 +328,151 @@ export declare interface ComponentResponse {
     errors: ValidationError[];
 }
 
+/**
+ * Transforms a Notabene component response to IVMS101 format
+ *
+ * @param response - The response from the Notabene Embedded Component
+ * @param delegateToken - The JWT delegate token for extracting the originator 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
+ * @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 }
+ * );
+ *
+ * await fetch('/entity/${vaspDid}/tx/${txId}/append', {
+ *   method: 'POST',
+ *   body: JSON.stringify(requestBody)
+ * });
+ * ```
+ */
+export declare function componentResponseToIVMS101(response: TransactionResponse<Withdrawal>, delegateToken: string, config?: ResponseToTxRequestConfig): TransactionIVMS101Request;
+
+/**
+ * Transforms a Notabene component response to a Version 2 transaction create API request body
+ *
+ * @param response - The response from the Notabene Embedded Component
+ * @param delegateToken - The JWT delegate token for extracting the originator 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
+ * @returns The transformed request body ready for the Version 2 transaction create API
+ *
+ * @example
+ * ```typescript
+ * import { componentResponseToTxCreateRequest } from '$lib/notabene-tx-transformer';
+ *
+ * withdrawal.on('complete', async (result) => {
+ *   const requestBody = componentResponseToTxCreateRequest(
+ *     result.response,
+ *     {
+ *       originatorId: 'mailto:user@example.com',
+ *       beneficiaryId: 'urn:beneficiary:recipient',
+ *       referenceId: 'tx-12345'
+ *     }
+ *   );
+ *
+ *   await fetch('/entity/${vaspDid}/tx', {
+ *     method: 'POST',
+ *     body: JSON.stringify(requestBody)
+ *   });
+ * });
+ * ```
+ */
+export declare function componentResponseToTxCreateRequest(response: TransactionResponse<Withdrawal>, delegateToken: string, config?: Omit<ResponseToTxRequestConfig, 'originator'>): TransactionCreateRequestV2;
+
+/**
+ * Transforms a Notabene component response into txCreate, IVMS101, and confirmRelationship request bodies
+ *
+ * This is a convenience function that generates the transaction creation request,
+ * the IVMS101 data, and optionally the relationship confirmation proof in a single call,
+ * 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.
+ *
+ * @param response - The response from the Notabene Embedded Component
+ * @param delegateToken - The JWT delegate token for extracting the originator 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.referenceId - Optional reference ID (auto-generated if not provided)
+ * @param config.originator - Optional originator data in V2 format
+ * @returns Object with `createTx`, `ivms101`, and optional `confirmRelationship` properties containing the respective request bodies
+ *
+ * @example
+ * ```typescript
+ * import { componentResponseToTxRequests } from '$lib/notabene-tx-transformer';
+ *
+ * withdrawal.on('complete', async (result) => {
+ *   const { createTx, ivms101, confirmRelationship } = componentResponseToTxRequests(
+ *     result.response,
+ *     session.user.token,
+ *     { originator: originatorData }
+ *   );
+ *
+ *   // 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 })
+ *     });
+ *   }
+ * });
+ * ```
+ */
+export declare function componentResponseToTxRequests(response: TransactionResponse<Withdrawal>, delegateToken: string, config?: ResponseToTxRequestConfig): {
+    createTx: TransactionCreateRequestV2;
+    ivms101: TransactionIVMS101Request;
+    confirmRelationship?: {
+        proof: OwnershipProof;
+    };
+};
+
+/**
+ * Transforms a Notabene component response to a Version 1 API request body
+ *
+ * @param response - The response from the Notabene TX Create component
+ * @returns The transformed request body ready for the Version 1 API
+ *
+ * @example
+ * ```typescript
+ * import { componentResponseToV1TxCreateRequest } from '$lib/notabene-tx-transformer';
+ *
+ * withdrawal.on('complete', async (result) => {
+ *   const requestBody = componentResponseToV1TxCreateRequest(result.response);
+ *
+ *   await fetch(endpointUrl, {
+ *     method: 'POST',
+ *     body: JSON.stringify(requestBody)
+ *   });
+ * });
+ * ```
+ */
+export declare function componentResponseToV1TxCreateRequest(response: TransactionResponse<Withdrawal>): TransactionCreateRequest;
+
 export declare interface ConnectionData<T extends ComponentRequest> {
     readonly tx: T;
     readonly authToken?: string;
@@ -1132,6 +1285,12 @@ declare type NaturalPersonNameID = {
     nameIdentifierType?: NaturalPersonNameTypeCode;
 };
 
+declare type NaturalPersonNameIDV2 = {
+    primaryIdentifier?: string;
+    secondaryIdentifier?: string;
+    naturalPersonNameIdentifierType?: NaturalPersonNameTypeCode;
+};
+
 /**
  * Natural Person Name Type Code
  * Specifies the type of name for a natural person
@@ -1140,6 +1299,14 @@ declare type NaturalPersonNameID = {
  */
 declare type NaturalPersonNameTypeCode = 'ALIA' | 'BIRT' | 'MAID' | 'LEGL' | 'MISC';
 
+declare type NaturalPersonNameV2 = Omit<NaturalPersonName, 'nameIdentifier'> & {
+    nameIdentifier?: NaturalPersonNameIDV2[];
+};
+
+declare type NaturalPersonV2 = Omit<NaturalPerson_2, 'name'> & {
+    name: NaturalPersonNameV2;
+};
+
 /**
  * Primary constructor for Notabene UX elements
  *
@@ -1308,7 +1475,12 @@ declare type Originator = {
  * @public
  */
 declare type OriginatorFields = {
-    source?: Source;
+    source?: Source | Source[];
+};
+
+declare type OriginatorV2 = {
+    originatorPerson: PersonV2[];
+    customerIdentification?: string;
 };
 
 /**
@@ -1399,6 +1571,11 @@ export declare enum PersonType {
     SELF = "self"
 }
 
+declare type PersonV2 = Omit<Person, 'naturalPerson'> & {
+    naturalPerson?: NaturalPersonV2;
+    accountNumber?: string[];
+};
+
 /**
  * Status of the ownership proof verification process
  *
@@ -1497,6 +1674,13 @@ export declare type ResizeRequest = {
     height: number;
 };
 
+export declare interface ResponseToTxRequestConfig {
+    originatorId?: DID_2;
+    beneficiaryId?: DID_2;
+    referenceId?: string;
+    originator?: OriginatorV2;
+}
+
 /**
  * Ownership Proof using Screenshot
  * @public
@@ -1680,6 +1864,44 @@ export declare interface Transaction extends ComponentRequest {
  */
 export declare type TransactionAsset = NotabeneAsset | CAIP19 | DTI;
 
+export declare interface TransactionCreateRequest {
+    transactionAsset: any;
+    transactionAmount: string;
+    beneficiaryDid?: string;
+    originatorVASPdid: string;
+    beneficiaryVASPdid?: string;
+    beneficiaryVASPname?: string;
+    beneficiaryVASPwebsite?: string;
+    transactionBlockchainInfo: {
+        origin?: string;
+        destination?: string;
+    };
+    beneficiaryProof?: any;
+    beneficiary?: any;
+    originator?: any;
+    originatorEqualsBeneficiary?: boolean;
+}
+
+export declare interface TransactionCreateRequestV2 {
+    originator: {
+        '@id': string;
+    };
+    beneficiary: {
+        '@id': string;
+    };
+    asset: string;
+    amount: string;
+    agents: Agent_2[];
+    ref: string;
+}
+
+export declare interface TransactionIVMS101Request {
+    ivms101: {
+        originator?: OriginatorV2;
+        beneficiary?: BeneficiaryV2;
+    };
+}
+
 /**
  * Configuration options for Transaction components
  * @public
@@ -1690,7 +1912,6 @@ export declare interface TransactionOptions {
         microTransfer?: {
             destination: BlockchainAddress;
             amountSubunits: string;
-            timeout?: number;
         };
         fallbacks?: ProofTypes[];
         deminimis?: ThresholdOptions;
@@ -1915,14 +2136,28 @@ export declare interface Wallet extends Agent {
  * Represents a warning component message
  * @param message - Warning message
  * @param description - Description of the warning message
+ * @param identifier - Identifier code of the warning message
  * @public
  */
 declare type Warning = {
     type: CMType.WARNING;
     message: string;
     description?: string;
+    identifier?: WarningIdentifierCode;
 };
 
+/**
+ * Identifier codes for warning messages
+ * @public
+ */
+export declare enum WarningIdentifierCode {
+    WALLET_ADDRESS_NOT_CONNECTED = "WALLET_ADDRESS_NOT_CONNECTED",
+    WALLET_LOCKED = "WALLET_LOCKED",
+    WALLET_UNREACHABLE = "WALLET_UNREACHABLE",
+    JURISDICTIONAL_REQUIREMENTS_UNAVAILABLE = "JURISDICTIONAL_REQUIREMENTS_UNAVAILABLE",
+    IDV_UNAVAILABLE = "IDV_UNAVAILABLE"
+}
+
 /**
  * An object representing a withdrawal transaction
  * @public