@notabene/javascript-sdk 2.0.0-next.9 → 2.0.1

package/src/notabene.ts

@@ -1,65 +1,133 @@
 import EmbeddedComponent from './components/EmbeddedComponent';
 import type {
   Agent,
-  AgentType,
+  BlockchainAddress,
+  CAIP10,
+  CAIP19,
+  CAIP2,
   CallbackOptions,
+  Cancel,
+  Completed,
   ComponentMessage,
+  ComponentResponse,
+  ConnectionOptions,
+  ConnectionRequest,
   Counterparty,
+  CryptoCredential,
   DeclarationProof,
   Deposit,
   DepositRequest,
+  DepositRequestOptions,
   Destination,
+  DID,
+  DTI,
+  Error,
+  FieldTypes,
   HostMessage,
+  InvalidValue,
   IVMS101,
+  LegalPerson,
+  LEI,
   MicroTransferProof,
+  NationalIdentification,
+  NaturalPerson,
+  NotabeneAsset,
   OwnershipProof,
-  PersonType,
-  ProofStatus,
-  ProofTypes,
+  Ready,
+  ResizeRequest,
   ScreenshotProof,
   SignatureProof,
-  Status,
   Theme,
+  ThresholdOptions,
   Transaction,
   TransactionAsset,
   TransactionOptions,
+  TransactionResponse,
+  TravelAddress,
+  UpdateValue,
+  V1Transaction,
+  ValidationError,
   VASP,
+  VASPOptions,
   Wallet,
   Withdrawal,
 } from './types';
-import { CMType, TransactionResponse } from './types';
-import { encodeObjectToFragment } from './utils/urls';
-
-export type {
+import {
+  AgentType,
   CMType,
+  HMType,
+  PersonType,
+  ProofStatus,
+  ProofTypes,
+  Status,
+  ValidationSections,
+} from './types';
+import { type MessageCallback } from './utils/MessageEventManager';
+import { decodeFragmentToObject, encodeObjectToFragment } from './utils/urls';
+// Must be exported for React Native SDK to use
+export { default as EmbeddedComponent } from './components/EmbeddedComponent';
+export type {
+  Agent,
+  BlockchainAddress,
+  CAIP2,
+  CAIP10,
+  CAIP19,
+  CryptoCredential,
+  TravelAddress,
+  NotabeneAsset,
+  DTI,
+  VASPOptions,
+  NationalIdentification,
+  FieldTypes,
+  DID,
+  MessageCallback,
+  CallbackOptions,
+  Cancel,
+  Completed,
   ComponentMessage,
-  EmbeddedComponent,
-  HostMessage,
-  Theme,
+  ComponentResponse,
+  ConnectionRequest,
   Counterparty,
-  Withdrawal,
+  DeclarationProof,
   Deposit,
-  Transaction,
   DepositRequest,
-  TransactionResponse,
-  Destination as destination,
-  TransactionAsset,
-  SignatureProof,
-  ScreenshotProof,
+  Destination,
+  Error,
+  HostMessage,
+  InvalidValue,
+  IVMS101,
+  LegalPerson,
+  LEI,
   MicroTransferProof,
-  DeclarationProof,
-  Notabene,
+  NaturalPerson,
+  OwnershipProof,
+  Ready,
+  ResizeRequest,
+  ScreenshotProof,
+  SignatureProof,
+  Theme,
+  ThresholdOptions,
+  Transaction,
+  TransactionAsset,
+  TransactionOptions,
+  TransactionResponse,
+  UpdateValue,
+  V1Transaction,
+  ValidationError,
+  VASP,
+  Wallet,
+  Withdrawal,
+};
+export {
+  CMType,
+  HMType,
   ProofStatus,
   ProofTypes,
-  IVMS101,
   PersonType,
   Status,
-  VASP,
-  Wallet,
-  Agent,
   AgentType,
-  OwnershipProof,
-  TransactionOptions,
+  ValidationSections,
+  decodeFragmentToObject,
 };
 
 /**
@@ -68,19 +136,40 @@ export type {
  * @public
  */
 export interface NotabeneConfig {
+  /**
+   * The URL of the Notabene API node
+   */
   nodeUrl?: string;
+
+  /**
+   * The authentication token for the Notabene API
+   */
   authToken?: string;
+
+  /**
+   * The URL of the Notabene UX components
+   */
   uxUrl?: string;
+
+  /**
+   * Custom theme configuration for the UX components
+   */
   theme?: Theme;
+
+  /**
+   * The locale to use for the UX components
+   */
   locale?: string;
 }
-
 /**
  * Primary constructor for Notabene UX elements
  *
+ * This class provides methods to create and manage various Notabene components
+ * such as withdrawal assist, deposit assist, connect, and deposit request.
+ * It also handles URL generation and fragment decoding for these components.
+ *
  * @public
  */
-
 export default class Notabene {
   private nodeUrl?: string;
   private authToken?: string;
@@ -88,6 +177,11 @@ export default class Notabene {
   private theme?: Theme;
   private locale?: string;
 
+  /**
+   * Creates a new instance of the Notabene SDK
+   *
+   * @param config - Configuration options for the Notabene SDK
+   */
   constructor(config: NotabeneConfig) {
     this.uxUrl = config.uxUrl || 'https://connect.notabene.id';
     this.nodeUrl = config.nodeUrl;
@@ -96,10 +190,20 @@ export default class Notabene {
     this.locale = config.locale;
   }
 
-  public componentUrl(
+  /**
+   * Generates a URL for a Notabene component
+   *
+   * @param path - The path of the component
+   * @param value - Transaction data
+   * @param configuration - Optional transaction configuration
+   * @param callbacks - Optional callback configuration
+   * @returns component URL
+   * @internal
+   */
+  componentUrl<V, O>(
     path: string,
-    value: Partial<Transaction>,
-    configuration?: TransactionOptions,
+    value: V,
+    configuration?: O,
     callbacks?: CallbackOptions,
   ): string {
     const url = new URL(this.uxUrl);
@@ -128,59 +232,91 @@ export default class Notabene {
     return url.toString();
   }
 
-  public createComponent(
+  /**
+   * Creates a new embedded component
+   *
+   * @param path - The path of the component
+   * @param value - Transaction data
+   * @param options - Optional transaction options
+   * @param callbacks - Optional callback configuration
+   * @returns A new EmbeddedComponent instance
+   * @internal
+   */
+  createComponent<V, O>(
     path: string,
-    value: Partial<Transaction>,
-    options?: TransactionOptions,
+    value: Partial<V>,
+    options?: O,
     callbacks?: CallbackOptions,
   ) {
-    return new EmbeddedComponent(
+    return new EmbeddedComponent<V, O>(
       this.componentUrl(path, value, options, callbacks),
       value,
+      options,
     );
   }
 
+  /**
+   * Creates a withdrawal assist component
+   *
+   * @param value - Withdrawal transaction data
+   * @param options - Optional transaction options
+   * @param callbacks - Optional callback configuration
+   * @returns A new EmbeddedComponent instance for withdrawal assistance
+   */
   public createWithdrawalAssist(
     value: Partial<Withdrawal>,
     options?: TransactionOptions,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent('withdrawal-assist', value, options, callbacks);
+    return this.createComponent<Withdrawal, TransactionOptions>(
+      'withdrawal-assist',
+      value,
+      options,
+      callbacks,
+    );
   }
 
-  public createDepositAssist(
-    value: Partial<Deposit>,
-    options?: any,
+  /**
+   * Creates a connect component
+   *
+   * @param value - Connection request data
+   * @param options - Optional transaction options
+   * @param callbacks - Optional callback configuration
+   * @returns A new EmbeddedComponent instance for connection
+   * @alpha
+   */
+  public createConnectWallet(
+    value: ConnectionRequest,
+    options?: ConnectionOptions,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent('deposit-assist', value, options, callbacks);
-  }
-
-  public createConnect(
-    value: Partial<Withdrawal>,
-    options?: TransactionOptions,
-    callbacks?: CallbackOptions,
-  ) {
-    return this.createComponent('connect', value, options, callbacks);
+    return this.createComponent<ConnectionRequest, ConnectionOptions>(
+      'connect',
+      value,
+      options,
+      callbacks,
+    );
   }
 
+  /**
+   * Creates a deposit request component
+   *
+   * @param value - Deposit request data
+   * @param options - Optional transaction options
+   * @param callbacks - Optional callback configuration
+   * @returns A new EmbeddedComponent instance for deposit requests
+   * @public
+   */
   public createDepositRequest(
-    value: Partial<DepositRequest>,
-    options?: TransactionOptions,
+    value: DepositRequest,
+    options?: DepositRequestOptions,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent('deposit-request', value, options, callbacks);
-  }
-
-  public decodeFragmentToObject(fragment: string): Record<string, string> {
-    const pairs = fragment.slice(1).split('&');
-    return pairs.reduce(
-      (obj, pair) => {
-        const [key, value] = pair.split('=');
-        obj[decodeURIComponent(key)] = decodeURIComponent(value);
-        return obj;
-      },
-      {} as Record<string, string>,
+    return this.createComponent<DepositRequest, DepositRequestOptions>(
+      'deposit-request',
+      value,
+      options,
+      callbacks,
     );
   }
 }