@notabene/javascript-sdk 2.0.0-next.2 → 2.0.0-next.20

package/dist/notabene.js

@@ -1,187 +1,357 @@
-var l = Object.defineProperty;
-var u = (s, e, t) => e in s ? l(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
-var o = (s, e, t) => u(s, typeof e != "symbol" ? e + "" : e, t);
-var h = /* @__PURE__ */ ((s) => (s.COMPLETE = "complete", s.RESIZE = "resize", s.RESULT = "result", s.READY = "ready", s.INVALID = "invalid", s.MODAL = "openModal", s.ERROR = "error", s.CLOSE = "closeModal", s.CANCEL = "cancel", s))(h || {}), c = /* @__PURE__ */ ((s) => (s.UPDATE = "update", s.REQUEST_RESPONSE = "requestResponse", s))(c || {});
-class m {
+var c = Object.defineProperty;
+var m = (t, e, s) => e in t ? c(t, e, { enumerable: !0, configurable: !0, writable: !0, value: s }) : t[e] = s;
+var o = (t, e, s) => m(t, typeof e != "symbol" ? e + "" : e, s);
+var u = /* @__PURE__ */ ((t) => (t.PRIVATE = "WALLET", t.VASP = "VASP", t))(u || {}), f = /* @__PURE__ */ ((t) => (t.NATURAL = "natural", t.LEGAL = "legal", t.SELF = "self", t))(f || {}), E = /* @__PURE__ */ ((t) => (t.EMPTY = "empty", t.VERIFY = "verify", t.PENDING = "pending", t.VERIFIED = "verified", t.BANNED = "banned", t))(E || {}), a = /* @__PURE__ */ ((t) => (t.COMPLETE = "complete", t.RESIZE = "resize", t.RESULT = "result", t.READY = "ready", t.INVALID = "invalid", t.ERROR = "error", t.CANCEL = "cancel", t))(a || {}), d = /* @__PURE__ */ ((t) => (t.UPDATE = "update", t.REQUEST_RESPONSE = "requestResponse", t))(d || {}), p = /* @__PURE__ */ ((t) => (t.PENDING = "pending", t.FAILED = "rejected", t.FLAGGED = "flagged", t.VERIFIED = "verified", t))(p || {}), g = /* @__PURE__ */ ((t) => (t.SelfDeclaration = "self-declaration", t.PersonalSignEIP191 = "eip-191", t.SIWE = "siwe", t.PersonalSignEIP712 = "eip-712", t.PersonalSignBIP137 = "bip-137", t.PersonalSignXPUB = "xpub", t.MicroTransfer = "microtransfer", t.Screenshot = "screenshot", t))(g || {});
+class v {
   constructor() {
     o(this, "listeners", /* @__PURE__ */ new Map());
     o(this, "port");
     this.handleMessage = this.handleMessage.bind(this);
   }
+  /**
+   * Sets up the message port for communication.
+   *
+   * Initializes the MessagePort for receiving messages by setting up the message handler
+   * and starting the port.
+   *
+   * @param port - The MessagePort instance to use for communication
+   */
   setPort(e) {
     this.port = e, this.port.onmessage = this.handleMessage, this.port.start();
   }
-  on(e, t) {
-    this.listeners.has(e) || this.listeners.set(e, /* @__PURE__ */ new Set()), this.listeners.get(e).add(t);
+  /**
+   * Registers a callback for a specific message type.
+   *
+   * When messages of the specified type are received, the callback will be executed
+   * with the message data.
+   *
+   * @param messageType - The type of message to listen for
+   * @param callback - The callback function to execute when matching messages are received
+   */
+  on(e, s) {
+    this.listeners.has(e) || this.listeners.set(e, /* @__PURE__ */ new Set()), this.listeners.get(e).add(s);
   }
-  off(e, t) {
+  /**
+   * Removes a callback for a specific message type.
+   *
+   * If the callback is the last one registered for the message type,
+   * the message type entry will be removed entirely.
+   *
+   * @param messageType - The type of message to remove listener from
+   * @param callback - The callback function to remove
+   */
+  off(e, s) {
     const r = this.listeners.get(e);
-    r && (r.delete(t), r.size === 0 && this.listeners.delete(e));
+    r && (r.delete(s), r.size === 0 && this.listeners.delete(e));
   }
+  /**
+   * Internal message handler for processing received messages.
+   *
+   * Validates incoming messages and dispatches them to registered callbacks
+   * based on the message type.
+   *
+   * @param event - The message event containing the component message
+   */
   handleMessage(e) {
-    console.log("received message", e.data);
-    const t = e.data;
-    if (typeof t == "object" && t !== null && "type" in t) {
-      const r = t.type, i = this.listeners.get(r);
-      i && i.forEach((n) => n(t));
+    const s = e.data;
+    if (typeof s == "object" && s !== null && "type" in s) {
+      const r = s.type, i = this.listeners.get(r);
+      i && i.forEach((n) => n(s));
     }
   }
-  // Method to send messages through the port
+  /**
+   * Sends a message through the message port
+   * @param message The host message to send
+   */
   send(e) {
-    if (!this.port)
-      throw new Error("No port set");
-    this.port.postMessage(e);
+    this.port && this.port.postMessage(e);
   }
 }
-class f {
-  constructor(e, t) {
+class I {
+  /**
+   * Creates an instance of EmbeddedComponent.
+   * @param url - The URL of the embedded component
+   * @param value - The initial transaction value
+   */
+  constructor(e, s, r) {
     o(this, "_url");
     o(this, "_value");
+    o(this, "_options");
     o(this, "_errors", []);
     o(this, "iframe");
     o(this, "eventManager");
-    o(this, "ready", !1);
-    this._url = e, this._value = t, this.eventManager = new m(), this.on(h.INVALID, (r) => {
-      r.type === h.INVALID && (this._errors = r.errors, this._value = r.value);
-    }), this.on(h.RESIZE, (r) => {
-      r.type === h.RESIZE && this.iframe && (this.iframe.style.height = `${r.height}px`);
+    o(this, "modal");
+    this._url = e, this._value = s, this._options = r, this.eventManager = new v(), this.on(a.INVALID, (i) => {
+      i.type === a.INVALID && (this._errors = i.errors, this._value = i.value);
+    }), this.on(a.RESIZE, (i) => {
+      i.type === a.RESIZE && this.iframe && (this.iframe.style.height = `${i.height}px`);
     });
   }
+  /**
+   * Gets the URL of the embedded component
+   * @returns The URL of the embedded component
+   */
   get url() {
     return this._url;
   }
+  /**
+   * Gets the current transaction value
+   * @returns The current transaction value
+   */
   get value() {
     return this._value;
   }
+  get options() {
+    return this._options;
+  }
   get errors() {
     return this._errors;
   }
+  /**
+   * Opens the component URL in the current window
+   */
   open() {
     document.location.href = this.url;
   }
+  /**
+   * Mounts the component to a parent element
+   * @param parentId - The ID of the parent element
+   * @throws Will throw an error if the parent element is not found
+   */
   mount(e) {
+    const s = document.querySelector(e);
+    if (!s) throw new Error(`parentID ${e} not found`);
+    this.embed(s);
+  }
+  /**
+   * Embeds the component into a parent element
+   * @param parent - The parent element to embed the component into
+   */
+  embed(e, s = !1) {
     var r, i;
-    this.iframe = document.createElement("iframe"), this.iframe.src = this.url, this.iframe.style.width = "100%", this.iframe.style.height = "100px", this.iframe.style.border = "none", this.iframe.style.overflow = "hidden", window.addEventListener("message", (n) => {
-      var a, d;
-      n.source === ((a = this.iframe) == null ? void 0 : a.contentWindow) && (console.log("received message from iframe", n.data), (d = this.eventManager) == null || d.setPort(n.ports[0]), this.ready = !0);
-    });
-    const t = document.querySelector(e);
-    if (!t) throw new Error(`parentID ${e} not found`);
-    t.appendChild(this.iframe), (i = (r = this.iframe) == null ? void 0 : r.contentWindow) == null || i.focus();
+    this.removeEmbed(), this.iframe = document.createElement("iframe"), this.iframe.src = this.url + (s ? "" : "&embedded=true"), this.iframe.allow = "web-share", this.iframe.style.width = "100%", this.iframe.style.height = "100px", this.iframe.style.border = "none", this.iframe.style.overflow = "hidden", e.appendChild(this.iframe), window.addEventListener("message", (n) => {
+      var h, l;
+      n.source === ((h = this.iframe) == null ? void 0 : h.contentWindow) && ((l = this.eventManager) == null || l.setPort(n.ports[0]));
+    }), (i = (r = this.iframe) == null ? void 0 : r.contentWindow) == null || i.focus();
+  }
+  removeEmbed() {
+    this.iframe && this.iframe.remove();
   }
+  /**
+   * Sends a message to the embedded component
+   * @param message - The message to send
+   */
   send(e) {
     this.eventManager.send(e);
   }
-  on(e, t) {
-    this.eventManager.on(e, t);
+  /**
+   * Adds an event listener for a specific message type
+   * @param messageType - The type of message to listen for
+   * @param callback - The callback function to execute when the message is received
+   */
+  on(e, s) {
+    this.eventManager.on(e, s);
   }
-  off(e, t) {
-    this.eventManager.off(e, t);
+  /**
+   * Removes an event listener for a specific message type
+   * @param messageType - The type of message to stop listening for
+   * @param callback - The callback function to remove
+   */
+  off(e, s) {
+    this.eventManager.off(e, s);
   }
-  update(e) {
-    this._value = e, this.send({ type: c.UPDATE, value: e });
+  /**
+   * Updates the transaction value and sends an update message to the component
+   * @param value - The new transaction value
+   */
+  update(e, s) {
+    this._value = e, s && (this._options = s), this.send({ type: d.UPDATE, value: e, options: this._options });
   }
+  /**
+   * Waits for the component to complete and returns the transaction response
+   * @returns A promise that resolves with the transaction response
+   */
   completion() {
-    return new Promise((e, t) => {
-      this.on(h.COMPLETE, (r) => {
+    return new Promise((e, s) => {
+      this.on(a.COMPLETE, (r) => {
         e(r.response);
       }), this.on("error", (r) => {
-        t(new Error(r.message));
+        s(new Error(r.message));
       });
     });
   }
+  /**
+   * Opens the component in a modal dialog
+   */
+  openModal() {
+    return this.modal && this.closeModal(), this.modal = document.createElement("dialog"), this.modal.style.border = "none", this.modal.style.backgroundColor = "white", this.modal.style.maxWidth = "100vw", this.modal.style.maxHeight = "100vh", this.modal.style.width = "600px", this.modal.style.height = "600px", document.body.appendChild(this.modal), this.embed(this.modal, !0), this.on(a.CANCEL, () => {
+      this.closeModal();
+    }), this.on(a.COMPLETE, () => {
+      this.closeModal();
+    }), this.modal.showModal(), this.modal.addEventListener("click", () => {
+      this.closeModal();
+    }), this.completion();
+  }
+  /**
+   * Closes the modal dialog
+   *
+   */
+  closeModal() {
+    var e;
+    this.modal && ((e = this.modal) == null || e.close(), this.modal.remove(), this.modal = void 0);
+  }
 }
-function p(s) {
-  return Object.entries(s).map(([e, t]) => {
-    if (!(e && t)) return;
+function w(t) {
+  return Object.entries(t).map(([e, s]) => {
+    if (!(e && s)) return;
     const r = encodeURIComponent(e), i = encodeURIComponent(
-      typeof t == "object" ? JSON.stringify(t) : t
+      typeof s == "object" ? JSON.stringify(s) : s
     );
     return `${r}=${i}`;
   }).filter((e) => !!e).join("&");
 }
-class g {
+class b {
+  /**
+   * Creates a new instance of the Notabene SDK
+   *
+   * @param config - Configuration options for the Notabene SDK
+   */
   constructor(e) {
     o(this, "nodeUrl");
     o(this, "authToken");
     o(this, "uxUrl");
     o(this, "theme");
-    o(this, "dictionary");
-    this.uxUrl = e.uxUrl || "https://ux.notabene.id", this.nodeUrl = e.nodeUrl, this.authToken = e.authToken, this.theme = e.theme, this.dictionary = e.dictionary;
+    o(this, "locale");
+    this.uxUrl = e.uxUrl || "https://connect.notabene.id", this.nodeUrl = e.nodeUrl, this.authToken = e.authToken, this.theme = e.theme, this.locale = e.locale;
   }
-  componentUrl(e, t, r, i) {
+  /**
+   * 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(e, s, r, i) {
     const n = new URL(this.uxUrl);
     n.pathname = e;
-    const a = p({
+    const h = w({
       authToken: this.authToken,
-      value: t,
+      value: s,
       configuration: r
     });
-    return n.hash = a, n.searchParams.set("nodeUrl", this.nodeUrl), this.theme && n.searchParams.set("theme", JSON.stringify(this.theme)), this.dictionary && n.searchParams.set("dictionary", JSON.stringify(this.dictionary)), i && (i.callback && n.searchParams.set("callback_url", i.callback), i.redirectUri && n.searchParams.set("redirect_uri", i.redirectUri)), n.toString();
+    return n.hash = h, this.nodeUrl && n.searchParams.set("nodeUrl", this.nodeUrl), this.theme && n.searchParams.set("theme", JSON.stringify(this.theme)), this.locale && n.searchParams.set("locale", this.locale), i && (i.callback && n.searchParams.set("callback_url", i.callback), i.redirectUri && n.searchParams.set("redirect_uri", i.redirectUri)), n.toString();
   }
-  createComponent(e, t, r, i) {
-    return new f(
-      this.componentUrl(e, t, r, i),
-      t
+  /**
+   * 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(e, s, r, i) {
+    return new I(
+      this.componentUrl(e, s, r, i),
+      s,
+      r
     );
   }
-  createWithdrawalAssist(e, t, r) {
-    return this.createComponent("withdrawal-assist", e, t, r);
+  /**
+   * 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
+   */
+  createWithdrawalAssist(e, s, r) {
+    return this.createComponent(
+      "withdrawal-assist",
+      e,
+      s,
+      r
+    );
+  }
+  /**
+   * 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
+   */
+  createDepositAssist(e, s, r) {
+    return this.createComponent(
+      "deposit-assist",
+      e,
+      s,
+      r
+    );
+  }
+  /**
+   * 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
+   */
+  createConnectWallet(e, s, r) {
+    return this.createComponent(
+      "connect",
+      e,
+      s,
+      r
+    );
+  }
+  /**
+   * 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
+   */
+  createDepositRequest(e, s, r) {
+    return this.createComponent(
+      "deposit-request",
+      e,
+      s,
+      r
+    );
   }
+  /**
+   * Decodes a URL fragment into an object
+   *
+   * @param fragment - The URL fragment to decode
+   * @returns An object containing the decoded key-value pairs
+   */
   decodeFragmentToObject(e) {
     return e.slice(1).split("&").reduce(
       (r, i) => {
-        const [n, a] = i.split("=");
-        return r[decodeURIComponent(n)] = decodeURIComponent(a), r;
+        const [n, h] = i.split("=");
+        return r[decodeURIComponent(n)] = decodeURIComponent(h), r;
       },
       {}
     );
   }
-  // private openModal(url: string): void {
-  //   if (this.modal) {
-  //     this.closeModal();
-  //   }
-  //   this.modal = document.createElement('div');
-  //   this.modal.style.position = 'fixed';
-  //   this.modal.style.top = '0';
-  //   this.modal.style.left = '0';
-  //   this.modal.style.width = '100%';
-  //   this.modal.style.height = '100%';
-  //   this.modal.style.backgroundColor = 'rgba(0, 0, 0, 0.5)';
-  //   this.modal.style.display = 'flex';
-  //   this.modal.style.justifyContent = 'center';
-  //   this.modal.style.alignItems = 'center';
-  //   const iframe = document.createElement('iframe');
-  //   iframe.src = url;
-  //   iframe.setAttribute('allowtransparency', 'true');
-  //   // iframe.allowtransparency = true;
-  //   iframe.style.backgroundColor = 'transparent';
-  //   iframe.style.width = '90%';
-  //   iframe.style.height = '90%';
-  //   iframe.style.border = 'none';
-  //   iframe.style.overflow = 'hidden';
-  //   this.modal.appendChild(iframe);
-  //   document.body.appendChild(this.modal);
-  //   this.modal.addEventListener('click', () => {
-  //     console.log('click');
-  //     this.closeModal();
-  //   });
-  //   document.addEventListener('keydown', ({ key }) => {
-  //     console.log(`key: ${key}`);
-  //     if (key === 'Escape') {
-  //       console.log('esc');
-  //       this.closeModal();
-  //     }
-  //   });
-  // }
-  // private closeModal(): void {
-  //   if (this.modal) {
-  //     console.log('this.closeModal');
-  //     this.modal.remove();
-  //     this.modal = undefined;
-  //   }
-  // }
 }
 export {
-  g as default
+  u as AgentType,
+  a as CMType,
+  I as EmbeddedComponent,
+  d as HMType,
+  f as PersonType,
+  p as ProofStatus,
+  g as ProofTypes,
+  E as Status,
+  b as default
 };

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.7"
+      "packageVersion": "7.47.11"
     }
   ]
 }

package/package.json

@@ -9,51 +9,61 @@
   },
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
-  "version": "2.0.0-next.2",
+  "version": "2.0.0-next.20",
   "source": "src/notabene.ts",
   "main": "dist/notabene.js",
   "types": "dist/notabene.d.ts",
   "browserslist": "> 0.5%, last 2 versions, not dead",
+  "files": [
+    "dist",
+    "src",
+    "package.json",
+    "README.md"
+  ],
   "scripts": {
+    "docs": "typedoc --options typedoc.json",
     "prepare": "husky install",
     "dev": "vite",
     "preview": "vite preview",
     "watch": "parcel watch",
     "build:dev": "yarn build && yarn dev",
     "build:clean": "rimraf dist/ ts-out",
-    "build": "vite build && tsc && api-extractor run",
+    "build": "yarn lint && vite build && tsc && api-extractor run && yarn docs ",
     "lint": "eslint .",
+    "format": "prettier --write .",
     "test": "vitest",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "publish": "yarn build && npm publish --tag next"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.2.1",
-    "@commitlint/config-conventional": "^16.2.1",
-    "@eslint/js": "^9.7.0",
-    "@fast-check/vitest": "^0.1.2",
-    "@microsoft/api-extractor": "^7.47.7",
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "@eslint/js": "^9.13.0",
+    "@fast-check/vitest": "^0.1.3",
+    "@microsoft/api-extractor": "^7.47.11",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/gitlab": "^9.3.0",
-    "@semantic-release/npm": "^9.0.1",
-    "@typescript-eslint/eslint-plugin": "^8.2.0",
-    "@typescript-eslint/parser": "^8.2.0",
-    "eslint": "^9.9.0",
+    "@semantic-release/gitlab": "^13.2.1",
+    "@semantic-release/npm": "^12.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.11.0",
+    "@typescript-eslint/parser": "^8.11.0",
+    "eslint": "^9.13.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^5.2.1",
-    "fast-check": "^3.20.0",
-    "globals": "^15.8.0",
-    "husky": "^7.0.4",
-    "lint-staged": "^12.3.4",
-    "organize-imports-cli": "^0.9.0",
+    "fast-check": "^3.22.0",
+    "globals": "^15.11.0",
+    "husky": "^9.1.6",
+    "jsdom": "^25.0.1",
+    "lint-staged": "^15.2.10",
+    "organize-imports-cli": "^0.10.0",
     "prettier": "^3.3.3",
-    "semantic-release": "^19.0.2",
-    "typescript": "^5.5.4",
-    "typescript-eslint": "^8.2.0",
-    "vite": "^5.4.2",
-    "vitest": "^2.0.5"
+    "rimraf": "^6.0.1",
+    "semantic-release": "^24.1.3",
+    "typedoc": "^0.26.10",
+    "typedoc-plugin-markdown": "^4.2.9",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.11.0",
+    "vite": "^5.4.10",
+    "vitest": "^2.1.3"
   },
   "lint-staged": {
     "*.ts": [

package/src/__tests__/notabene.test.ts

@@ -2,6 +2,7 @@ import { fc, test } from '@fast-check/vitest';
 import { describe } from 'vitest';
 import { abitraryCallbackOptions, arbitraryComponent } from '../arbitraries';
 import Notabene from '../notabene';
+import { arbitraryLocale } from '../utils/arbitraries';
 
 describe('Notabene', () => {
   describe('defaults', () => {
@@ -28,6 +29,48 @@ describe('Notabene', () => {
     );
   });
 
+  describe('locale', () => {
+    test.prop([
+      fc.string({ minLength: 3 }),
+      fc.webUrl(),
+      arbitraryComponent(),
+      fc.object(),
+      arbitraryLocale(),
+    ])(
+      'Should set the correct values',
+      (authToken, nodeUrl, component, value, locale) => {
+        const notabene = new Notabene({
+          nodeUrl,
+          authToken,
+          locale,
+        });
+        const url = new URL(notabene.componentUrl(component, value));
+        return (
+          url.hash ===
+            `#authToken=${encodeURIComponent(authToken)}&value=${encodeURIComponent(JSON.stringify(value))}` &&
+          url.searchParams.get('nodeUrl') === nodeUrl &&
+          url.searchParams.get('locale') === locale &&
+          url.pathname === `/${component}`
+        );
+      },
+    );
+  });
+
+  describe('minimal', () => {
+    test.prop([arbitraryComponent(), fc.object()])(
+      'Should set the correct values',
+      (component, value) => {
+        const notabene = new Notabene({});
+        const url = new URL(notabene.componentUrl(component, value));
+        return (
+          url.hash === `#value=${encodeURIComponent(JSON.stringify(value))}` &&
+          url.hostname === 'connect.notabene.id' &&
+          url.pathname === `/${component}`
+        );
+      },
+    );
+  });
+
   describe('with uxUrl', () => {
     test.prop([
       fc.string({ minLength: 3 }),