@notabene/javascript-sdk 2.0.0-next.10 → 2.0.0-next.12

package/src/notabene.ts

@@ -4,6 +4,8 @@ import type {
   AgentType,
   CallbackOptions,
   ComponentMessage,
+  ConnectionRequest,
+  ConnectionResponse,
   Counterparty,
   DeclarationProof,
   Deposit,
@@ -34,6 +36,8 @@ export type {
   CMType,
   ComponentMessage,
   EmbeddedComponent,
+  ConnectionRequest,
+  ConnectionResponse,
   HostMessage,
   Theme,
   Counterparty,
@@ -60,27 +64,54 @@ export type {
   AgentType,
   OwnershipProof,
   TransactionOptions,
+  CallbackOptions,
 };
 
+/**
+ * Configuration for the Notabene SDK
+ *
+ * @public
+ */
 /**
  * Configuration for the Notabene SDK
  *
  * @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 +119,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,9 +132,19 @@ 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>(
     path: string,
-    value: Partial<Transaction>,
+    value: V,
     configuration?: TransactionOptions,
     callbacks?: CallbackOptions,
   ): string {
@@ -128,50 +174,116 @@ 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, R>(
     path: string,
-    value: Partial<Transaction>,
+    value: V,
     options?: TransactionOptions,
     callbacks?: CallbackOptions,
   ) {
-    return new EmbeddedComponent(
+    return new EmbeddedComponent<V, R>(
       this.componentUrl(path, value, options, callbacks),
       value,
     );
   }
 
+  /**
+   * 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<
+      Partial<Withdrawal>,
+      TransactionResponse<Withdrawal>
+    >('withdrawal-assist', value, options, callbacks);
   }
 
+  /**
+   * Creates a deposit assist component
+   *
+   * @param value - Deposit transaction data
+   * @param options - Optional transaction options
+   * @param callbacks - Optional callback configuration
+   * @returns A new EmbeddedComponent instance for deposit assistance
+   * @alpha
+   */
   public createDepositAssist(
     value: Partial<Deposit>,
     options?: any,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent('deposit-assist', value, options, callbacks);
+    return this.createComponent<Partial<Deposit>, TransactionResponse<Deposit>>(
+      'deposit-assist',
+      value,
+      options,
+      callbacks,
+    );
   }
 
-  public createConnect(
-    value: Partial<Withdrawal>,
+  /**
+   * 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
+   */
+  public createConnectWallet(
+    value: ConnectionRequest,
     options?: TransactionOptions,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent('connect', value, options, callbacks);
+    return this.createComponent<ConnectionRequest, ConnectionResponse>(
+      '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
+   * @alpha
+   */
   public createDepositRequest(
-    value: Partial<DepositRequest>,
+    value: DepositRequest,
     options?: TransactionOptions,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent('deposit-request', value, options, callbacks);
+    return this.createComponent<
+      DepositRequest,
+      TransactionResponse<DepositRequest>
+    >('deposit-request', value, options, callbacks);
   }
 
+  /**
+   * Decodes a URL fragment into an object
+   *
+   * @param fragment - The URL fragment to decode
+   * @returns An object containing the decoded key-value pairs
+   */
   public decodeFragmentToObject(fragment: string): Record<string, string> {
     const pairs = fragment.slice(1).split('&');
     return pairs.reduce(