@notabene/javascript-sdk 1.34.0 → 2.0.0-next.11

package/src/notabene.ts

@@ -1,318 +1,298 @@
-// @ts-ignore
-import { dom, node } from 'jsx-pragmatic';
-// @ts-ignore
-import zoid, { destroy } from 'zoid';
-import {
-  Fallback,
-  FieldsProps,
-  NonCustodialDeclarationType,
-  OptInFeature,
+import EmbeddedComponent from './components/EmbeddedComponent';
+import type {
+  Agent,
+  AgentType,
+  CallbackOptions,
+  ComponentMessage,
+  ConnectionRequest,
+  ConnectionResponse,
+  Counterparty,
+  DeclarationProof,
+  Deposit,
+  DepositRequest,
+  Destination,
+  HostMessage,
+  IVMS101,
+  MicroTransferProof,
+  OwnershipProof,
+  PersonType,
+  ProofStatus,
+  ProofTypes,
+  ScreenshotProof,
+  SignatureProof,
+  Status,
   Theme,
   Transaction,
-  TransactionTypeAllowed,
-  WidgetType,
+  TransactionAsset,
+  TransactionOptions,
+  VASP,
+  Wallet,
+  Withdrawal,
 } from './types';
-import { popupProps, widgetProps } from './zoidComponentProps';
+import { CMType, TransactionResponse } from './types';
+import { encodeObjectToFragment } from './utils/urls';
 
-interface NotabeneConfig {
-  widget: string;
-  container: string;
-  authToken: string;
-  vaspDID: string;
-  onValidStateChange(isValid: boolean): void;
-  onError(err: any): void;
+export type {
+  CMType,
+  ComponentMessage,
+  EmbeddedComponent,
+  ConnectionRequest,
+  ConnectionResponse,
+  HostMessage,
+  Theme,
+  Counterparty,
+  Withdrawal,
+  Deposit,
+  Transaction,
+  DepositRequest,
+  TransactionResponse,
+  Destination as destination,
+  TransactionAsset,
+  SignatureProof,
+  ScreenshotProof,
+  MicroTransferProof,
+  DeclarationProof,
+  Notabene,
+  ProofStatus,
+  ProofTypes,
+  IVMS101,
+  PersonType,
+  Status,
+  VASP,
+  Wallet,
+  Agent,
+  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;
-  dictionary?: { [key: string]: string };
-  transactionTypeAllowed?: TransactionTypeAllowed;
-  nonCustodialDeclarationType?: NonCustodialDeclarationType;
-  beneficiaryDetails?: string[]; // @deprecated beneficiaryDetails - do not delete yet
-  fieldsProps?: FieldsProps;
-  fallbacks?: Fallback[];
-  optInFeatures?: OptInFeature[];
-}
 
+  /**
+   * 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 widget: zoid.ZoidComponent;
-  private popup: zoid.ZoidComponent;
-  private config: NotabeneConfig;
-  private tx: Transaction | undefined;
-  private error?: Error;
-  private widgetRendered: boolean;
-  private popupRendered: boolean;
-  private shouldBeDestroyed: boolean;
+  private nodeUrl?: string;
+  private authToken?: string;
+  private uxUrl: string;
+  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.config = config;
-    this.config.nonCustodialDeclarationType =
-      config.nonCustodialDeclarationType || 'SIGNATURE';
-    this.config.transactionTypeAllowed = config.transactionTypeAllowed || 'ALL';
-    this.widgetRendered = false;
-    this.shouldBeDestroyed = false;
-    this.popupRendered = false;
-    this.config.fallbacks = this.config.fallbacks || [
-      { flow: 'WALLET_NOT_SUPPORTED', action: 'DECLARATION' },
-    ];
+    this.uxUrl = config.uxUrl || 'https://connect.notabene.id';
+    this.nodeUrl = config.nodeUrl;
+    this.authToken = config.authToken;
+    this.theme = config.theme;
+    this.locale = config.locale;
   }
 
   /**
-   * Renders a new widget
-   * @param type - the type of widget to render
+   * 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
    */
-  public async renderWidget(
-    type: WidgetType = WidgetType.WITHDRAWAL
-  ): Promise<void> {
-    this._renderWidget(type);
-  }
-
-  private async _renderWidget(type: WidgetType): Promise<void> {
-    if (this.widgetRendered) {
-      console.error(
-        'Notabene: Widget already rendered, please destroy it first'
-      );
-      this.config.onError(
-        new Error('Widget already rendered, please destroy it first')
-      );
-      return;
-    }
+  componentUrl<V>(
+    path: string,
+    value: V,
+    configuration?: TransactionOptions,
+    callbacks?: CallbackOptions,
+  ): string {
+    const url = new URL(this.uxUrl);
+    url.pathname = path;
 
-    this.widget = await this.buildWidget();
-    this.popup = await this.buildPopup();
-    this.widget.updateProps({
-      transaction: this.tx,
-      type,
+    const hash = encodeObjectToFragment({
+      authToken: this.authToken,
+      value,
+      configuration,
     });
-    this.popup.updateProps({
-      transaction: this.tx,
-      type,
-    });
-    this.popup.hide();
-    await this.widget.render(this.config.container);
-    await this.renderPopup();
-  }
+    url.hash = hash;
+    if (this.nodeUrl) url.searchParams.set('nodeUrl', this.nodeUrl);
 
-  private async renderPopup(): Promise<void> {
-    if (!this.popup) return;
-
-    if (!this.popupRendered) {
-      await this.popup.render(this.config.container);
-      this.popupRendered = true;
+    if (this.theme) {
+      url.searchParams.set('theme', JSON.stringify(this.theme));
     }
-  }
-
-  public async destroyWidget(): Promise<void> {
-    if (!this.widgetRendered || !this.popupRendered) {
-      this.shouldBeDestroyed = true;
-      return;
+    if (this.locale) {
+      url.searchParams.set('locale', this.locale);
     }
-    await destroy();
-    this.shouldBeDestroyed = false;
-    this.widgetRendered = false;
-    this.popupRendered = false;
-  }
-
-  public setTransaction(tx: Transaction) {
-    this.tx = tx;
-    if (this.widgetRendered) {
-      this.widget.updateProps({
-        transaction: tx,
-      });
-      this.popup.updateProps({
-        transaction: tx,
-      });
+    if (callbacks) {
+      if (callbacks.callback)
+        url.searchParams.set('callback_url', callbacks.callback);
+      if (callbacks.redirectUri)
+        url.searchParams.set('redirect_uri', callbacks.redirectUri);
     }
+    return url.toString();
   }
 
-  private cleanUpDestroyedComponents() {
-    if (!this.shouldBeDestroyed) return;
-    this.destroyWidget();
+  /**
+   * 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: V,
+    options?: TransactionOptions,
+    callbacks?: CallbackOptions,
+  ) {
+    return new EmbeddedComponent<V, R>(
+      this.componentUrl(path, value, options, callbacks),
+      value,
+    );
   }
 
-  private getWidgetUrl(): string {
-    const url = new URL(this.config.widget);
-    url.hash = `authToken=${this.config.authToken}`;
-    return url.toString();
+  /**
+   * 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<
+      Partial<Withdrawal>,
+      TransactionResponse<Withdrawal>
+    >('withdrawal-assist', value, options, callbacks);
   }
 
-  private getAdditionalInfoUrl(): string {
-    const url = new URL(this.config.widget);
-    url.search = 'popup=true';
-    url.hash = `authToken=${this.config.authToken}`;
-
-    return url.toString();
+  /**
+   * 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<Partial<Deposit>, TransactionResponse<Deposit>>(
+      'deposit-assist',
+      value,
+      options,
+      callbacks,
+    );
   }
 
-  private handleError(err: any): void {
-    this.error = err;
-    if (this.widget && this.popup) {
-      this.widget.updateProps({
-        error: err,
-      });
-      this.popup.updateProps({
-        error: err,
-      });
-    }
-    if (!err || !this.config.onError) return;
-    this.config.onError(err);
+  /**
+   * 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<ConnectionRequest, ConnectionResponse>(
+      'connect',
+      value,
+      options,
+      callbacks,
+    );
   }
 
-  private buildWidget(): zoid.ZoidComponent {
-    if (!this.config.authToken) {
-      console.error('Notabene: authToken is required');
-      return;
-    }
-
-    const builtWidget = zoid.create({
-      tag: 'widget',
-      url: this.getWidgetUrl(),
-      dimensions: {
-        width: '100%',
-        height: '280px',
-      },
-      attributes: {
-        iframe: {
-          allow: 'usb *;bluetooth *',
-        },
-      },
-      props: widgetProps,
-    })({
-      vaspDID: this.config.vaspDID,
-      transaction: {},
-      theme: this.config.theme,
-      dictionary: this.config.dictionary,
-      transactionTypeAllowed: this.config.transactionTypeAllowed,
-      nonCustodialDeclarationType: this.config.nonCustodialDeclarationType,
-      beneficiaryDetails: this.config.beneficiaryDetails,
-      fieldsProps: this.config.fieldsProps,
-      fallbacks: this.config.fallbacks,
-      optInFeatures: this.config.optInFeatures,
-      onRequireAdditionalInformation: () => {
-        this.popup.updateProps({
-          popupOpen: true,
-        });
-        this.popup.show();
-      },
-      onValidStateChange: (isValid: boolean) => {
-        this.config.onValidStateChange(isValid);
-      },
-      error: this.error,
-      onError: (err: any) => {
-        this.handleError(err);
-        console.debug('Notabene: Error handler called');
-      },
-      storeTransaction: (tx: Transaction) => {
-        this.setTransaction(tx);
-      },
-    });
-
-    builtWidget.event.on(zoid.EVENT.RENDERED, () => {
-      this.widgetRendered = true;
-      this.cleanUpDestroyedComponents();
-    });
-
-    return builtWidget;
+  /**
+   * 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: DepositRequest,
+    options?: TransactionOptions,
+    callbacks?: CallbackOptions,
+  ) {
+    return this.createComponent<
+      DepositRequest,
+      TransactionResponse<DepositRequest>
+    >('deposit-request', value, options, callbacks);
   }
 
-  private buildPopup(): zoid.ZoidComponent {
-    if (!this.config.authToken) {
-      console.error('Notabene: authToken is required');
-      return;
-    }
-
-    const builtPopup = zoid.create({
-      tag: 'popup',
-      url: this.getAdditionalInfoUrl(),
-      children: () => {
-        return {
-          Transaction: this.tx,
-        };
-      },
-      dimensions: {
-        width: '100%',
-        height: '100%',
-      },
-      attributes: {
-        iframe: {
-          allow: 'usb *;bluetooth *',
-        },
-      },
-      props: popupProps,
-      containerTemplate: ({ uid, doc, frame, prerenderFrame }: any) => {
-        return node(
-          'div',
-          { id: uid, class: 'nb-container' },
-          node(
-            'style',
-            null,
-            `
-            #${uid}.container {
-                border: 5px solid red;
-            }
-            .nb-overlay {
-              position: fixed;
-              width: 100vw;
-              height: 100vh;
-              top: 0;
-              left: 0;
-              display: flex;
-              align-items: center;
-              justify-content: center;
-              background-color: rgba(0,0,0,0.5);
-            }
-            .nb-popup {
-              width: 100%;
-              height: 100%;
-            }
-            .nb-preloader {
-              display: none;
-            }
-          `
-          ),
-          node(
-            'div',
-            { class: 'nb-overlay' },
-            node('node', { el: frame, class: 'nb-popup' }),
-            node('node', { el: prerenderFrame, class: 'nb-preloader' })
-          )
-        ).render(dom({ doc }));
-      },
-    })({
-      vaspDID: this.config.vaspDID,
-      transaction: this.tx,
-      beneficiaryDetails: this.config.beneficiaryDetails,
-      fieldsProps: this.config.fieldsProps,
-      storeTransaction: (tx: Transaction) => {
-        this.setTransaction(tx);
-        console.debug('Notabene: Transaction stored');
-      },
-      close: () => {
-        this.popup.close();
-        console.debug('Notabene: Popup closing');
-      },
-      setPopupOpen: (isOpen: boolean) => {
-        this.popup.updateProps({
-          popupOpen: isOpen,
-        });
-      },
-      error: this.error,
-      onError: (err: any) => {
-        this.handleError(err);
-        console.debug('Notabene: Error handler called');
+  /**
+   * 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(
+      (obj, pair) => {
+        const [key, value] = pair.split('=');
+        obj[decodeURIComponent(key)] = decodeURIComponent(value);
+        return obj;
       },
-      popupOpen: false,
-      theme: this.config.theme,
-      dictionary: this.config.dictionary,
-      transactionTypeAllowed: this.config.transactionTypeAllowed,
-      nonCustodialDeclarationType: this.config.nonCustodialDeclarationType,
-      fallbacks: this.config.fallbacks,
-      optInFeatures: this.config.optInFeatures,
-    });
-
-    builtPopup.event.on(zoid.EVENT.RENDERED, () => {
-      this.popupRendered = true;
-      this.cleanUpDestroyedComponents();
-    });
-    return builtPopup;
+      {} as Record<string, string>,
+    );
   }
 }
-
-if (window) window.Notabene = Notabene;