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

package/dist/notabene.js

@@ -1,167 +1,343 @@
-var d = Object.defineProperty;
-var c = (r, e, t) => e in r ? d(r, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : r[e] = t;
-var n = (r, e, t) => c(r, typeof e != "symbol" ? e + "" : e, t);
-var h = /* @__PURE__ */ ((r) => (r.COMPLETE = "complete", r.RESIZE = "resize", r.RESULT = "result", r.READY = "ready", r.INVALID = "invalid", r.MODAL = "openModal", r.ERROR = "error", r.CLOSE = "closeModal", r.CANCEL = "cancel", r))(h || {}), l = /* @__PURE__ */ ((r) => (r.UPDATE = "update", r.REQUEST_RESPONSE = "requestResponse", r))(l || {});
-class m {
+var c = Object.defineProperty;
+var m = (e, t, r) => t in e ? c(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
+var o = (e, t, r) => m(e, typeof t != "symbol" ? t + "" : t, r);
+var u = /* @__PURE__ */ ((e) => (e.PRIVATE = "WALLET", e.VASP = "VASP", e))(u || {}), E = /* @__PURE__ */ ((e) => (e.NATURAL = "natural", e.LEGAL = "legal", e.SELF = "self", e))(E || {}), f = /* @__PURE__ */ ((e) => (e.EMPTY = "empty", e.VERIFY = "verify", e.PENDING = "pending", e.VERIFIED = "verified", e.BANNED = "banned", e))(f || {}), p = /* @__PURE__ */ ((e) => (e.ASSET = "asset", e.DESTINATION = "destination", e.COUNTERPARTY = "counterparty", e.AGENT = "agent", e))(p || {}), h = /* @__PURE__ */ ((e) => (e.COMPLETE = "complete", e.RESIZE = "resize", e.RESULT = "result", e.READY = "ready", e.INVALID = "invalid", e.ERROR = "error", e.CANCEL = "cancel", e))(h || {}), d = /* @__PURE__ */ ((e) => (e.UPDATE = "update", e.REQUEST_RESPONSE = "requestResponse", e))(d || {}), v = /* @__PURE__ */ ((e) => (e.PENDING = "pending", e.FAILED = "rejected", e.FLAGGED = "flagged", e.VERIFIED = "verified", e))(v || {}), g = /* @__PURE__ */ ((e) => (e.SelfDeclaration = "self-declaration", e.SIWE = "siwe", e.SIWX = "siwx", e.EIP191 = "eip-191", e.EIP712 = "eip-712", e.EIP1271 = "eip-1271", e.BIP137 = "bip-137", e.BIP137_XPUB = "xpub", e.ED25519 = "ed25519", e.MicroTransfer = "microtransfer", e.Screenshot = "screenshot", e.Connect = "connect", e))(g || {});
+class I {
   constructor() {
-    n(this, "listeners", /* @__PURE__ */ new Map());
-    n(this, "port");
+    o(this, "listeners", /* @__PURE__ */ new Map());
+    o(this, "port");
     this.handleMessage = this.handleMessage.bind(this);
   }
-  setPort(e) {
-    this.port = e, this.port.onmessage = this.handleMessage, this.port.start();
+  /**
+   * 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(t) {
+    this.port = t, 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(t, r) {
+    return this.listeners.has(t) || this.listeners.set(t, /* @__PURE__ */ new Set()), this.listeners.get(t).add(r), () => this.off(t, r);
   }
-  off(e, t) {
-    const s = this.listeners.get(e);
-    s && (s.delete(t), s.size === 0 && this.listeners.delete(e));
+  /**
+   * 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(t, r) {
+    const i = this.listeners.get(t);
+    i && (i.delete(r), i.size === 0 && this.listeners.delete(t));
   }
-  handleMessage(e) {
-    console.log("received message", e.data);
-    const t = e.data;
-    if (typeof t == "object" && t !== null && "type" in t) {
-      const s = t.type, o = this.listeners.get(s);
-      o && o.forEach((i) => i(t));
+  /**
+   * 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(t) {
+    const r = t.data;
+    if (typeof r == "object" && r !== null && "type" in r) {
+      const i = r.type, s = this.listeners.get(i);
+      s && s.forEach((n) => n(r));
     }
   }
-  // Method to send messages through the port
-  send(e) {
-    this.port && this.port.postMessage(e);
+  /**
+   * Sends a message through the message port
+   * @param message The host message to send
+   */
+  send(t) {
+    this.port && this.port.postMessage(t);
   }
 }
-class u {
-  // private popup?: HTMLElement;
-  constructor(e, t) {
-    n(this, "_url");
-    n(this, "_value");
-    n(this, "_errors", []);
-    n(this, "iframe");
-    n(this, "eventManager");
-    n(this, "ready", !1);
-    n(this, "modal");
-    this._url = e, this._value = t, this.eventManager = new m(), this.on(h.INVALID, (s) => {
+class w {
+  /**
+   * Creates an instance of EmbeddedComponent.
+   * @param url - The URL of the embedded component
+   * @param value - The initial transaction value
+   */
+  constructor(t, r, i) {
+    o(this, "_url");
+    o(this, "_value");
+    o(this, "_options");
+    o(this, "_errors", []);
+    o(this, "iframe");
+    o(this, "eventManager");
+    o(this, "modal");
+    this._url = t, this._value = r, this._options = i, this.eventManager = new I(), this.on(h.INVALID, (s) => {
       s.type === h.INVALID && (this._errors = s.errors, this._value = s.value);
     }), this.on(h.RESIZE, (s) => {
       s.type === h.RESIZE && this.iframe && (this.iframe.style.height = `${s.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;
   }
-  mount(e) {
-    const t = document.querySelector(e);
-    if (!t) throw new Error(`parentID ${e} not found`);
-    this.embed(t);
+  /**
+   * 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(t) {
+    const r = document.querySelector(t);
+    if (!r) throw new Error(`parentID ${t} not found`);
+    this.embed(r);
+  }
+  /**
+   * Embeds the component into a parent element
+   * @param parent - The parent element to embed the component into
+   */
+  embed(t, r = !1) {
+    var i, s;
+    this.removeEmbed(), this.iframe = document.createElement("iframe"), this.iframe.src = this.url + (r ? "" : "&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", t.appendChild(this.iframe), window.addEventListener("message", (n) => {
+      var a, l;
+      n.source === ((a = this.iframe) == null ? void 0 : a.contentWindow) && ((l = this.eventManager) == null || l.setPort(n.ports[0]));
+    }), (s = (i = this.iframe) == null ? void 0 : i.contentWindow) == null || s.focus();
   }
-  embed(e) {
-    var t, s;
-    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", this.iframe.setAttribute("allowtransparency", "true"), this.iframe.style.backgroundColor = "transparent", e.appendChild(this.iframe), window.addEventListener("message", (o) => {
-      var i, a;
-      o.source === ((i = this.iframe) == null ? void 0 : i.contentWindow) && (console.log("received message from iframe", o.data), (a = this.eventManager) == null || a.setPort(o.ports[0]), this.ready = !0);
-    }), (s = (t = this.iframe) == null ? void 0 : t.contentWindow) == null || s.focus();
+  removeEmbed() {
+    this.iframe && this.iframe.remove();
   }
-  send(e) {
-    this.eventManager.send(e);
+  /**
+   * Sends a message to the embedded component
+   * @param message - The message to send
+   */
+  send(t) {
+    this.eventManager.send(t);
   }
-  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(t, r) {
+    return this.eventManager.on(t, r);
   }
-  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(t, r) {
+    this.eventManager.off(t, r);
   }
-  update(e) {
-    this._value = e, this.send({ type: l.UPDATE, value: e });
+  /**
+   * Updates the transaction value and sends an update message to the component
+   * @param value - The new transaction value
+   */
+  update(t, r) {
+    this._value = t, r && (this._options = r), this.send({ type: d.UPDATE, value: t, 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.closeModal(), this.on(h.COMPLETE, (s) => {
-        e(s.response);
-      }), this.on("error", (s) => {
-        t(new Error(s.message));
+    return new Promise((t, r) => {
+      let i, s;
+      function n() {
+        i && i(), s && s();
+      }
+      i = this.on(h.COMPLETE, (a) => {
+        t(a.response), n();
+      }), s = this.on("error", (a) => {
+        r(new Error(a.message)), n();
       });
     });
   }
-  // popup(): void {
-  //   this.popup = document.createElement('div');
-  //   this.popup.style;
-  // }
+  /**
+   * Opens the component in a modal dialog
+   */
   openModal() {
-    this.modal && this.closeModal(), this.modal = document.createElement("dialog"), document.body.appendChild(this.modal), this.embed(this.modal), this.modal.showModal(), this.modal.addEventListener("click", () => {
+    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(h.CANCEL, () => {
       this.closeModal();
-    });
+    }), this.on(h.COMPLETE, () => {
+      this.closeModal();
+    }), this.modal.showModal(), this.modal.addEventListener("click", () => {
+      this.closeModal();
+    }), this.completion();
   }
+  /**
+   * Closes the modal dialog
+   *
+   */
   closeModal() {
-    var e;
-    this.modal && (console.log("closeModal"), (e = this.modal) == null || e.close(), this.modal.remove(), this.modal = void 0);
+    var t;
+    this.modal && ((t = this.modal) == null || t.close(), this.modal.remove(), this.modal = void 0);
   }
 }
-function f(r) {
-  return Object.entries(r).map(([e, t]) => {
-    if (!(e && t)) return;
-    const s = encodeURIComponent(e), o = encodeURIComponent(
-      typeof t == "object" ? JSON.stringify(t) : t
+function U(e) {
+  return Object.entries(e).map(([t, r]) => {
+    if (r == null) return;
+    const i = encodeURIComponent(t), s = encodeURIComponent(
+      typeof r == "object" ? JSON.stringify(r) : String(r)
+      // Use String() to handle all primitive types
     );
-    return `${s}=${o}`;
-  }).filter((e) => !!e).join("&");
+    return `${i}=${s}`;
+  }).filter((t) => t !== void 0).join("&");
+}
+function b(e) {
+  const t = e.slice(1);
+  return t ? t.split("&").filter(Boolean).reduce(
+    (i, s) => {
+      const [n, a] = s.split("=");
+      return n && (i[decodeURIComponent(n)] = a ? decodeURIComponent(a) : ""), i;
+    },
+    {}
+  ) : {};
 }
-class E {
-  constructor(e) {
-    n(this, "nodeUrl");
-    n(this, "authToken");
-    n(this, "uxUrl");
-    n(this, "theme");
-    n(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, s, o) {
-    const i = new URL(this.uxUrl);
-    i.pathname = e;
-    const a = f({
+class A {
+  /**
+   * Creates a new instance of the Notabene SDK
+   *
+   * @param config - Configuration options for the Notabene SDK
+   */
+  constructor(t) {
+    o(this, "nodeUrl");
+    o(this, "authToken");
+    o(this, "uxUrl");
+    o(this, "theme");
+    o(this, "locale");
+    this.uxUrl = t.uxUrl || "https://connect.notabene.id", this.nodeUrl = t.nodeUrl, this.authToken = t.authToken, this.theme = t.theme, this.locale = t.locale;
+  }
+  /**
+   * 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(t, r, i, s) {
+    const n = new URL(this.uxUrl);
+    n.pathname = t;
+    const a = U({
       authToken: this.authToken,
-      value: t,
-      configuration: s
+      value: r,
+      configuration: i
     });
-    return i.hash = a, this.nodeUrl && i.searchParams.set("nodeUrl", this.nodeUrl), this.theme && i.searchParams.set("theme", JSON.stringify(this.theme)), this.locale && i.searchParams.set("locale", this.locale), o && (o.callback && i.searchParams.set("callback_url", o.callback), o.redirectUri && i.searchParams.set("redirect_uri", o.redirectUri)), i.toString();
+    return n.hash = a, 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), s && (s.callback && n.searchParams.set("callback_url", s.callback), s.redirectUri && n.searchParams.set("redirect_uri", s.redirectUri)), n.toString();
   }
-  createComponent(e, t, s, o) {
-    return new u(
-      this.componentUrl(e, t, s, o),
-      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(t, r, i, s) {
+    return new w(
+      this.componentUrl(t, r, i, s),
+      r,
+      i
     );
   }
-  createWithdrawalAssist(e, t, s) {
-    return this.createComponent("withdrawal-assist", e, t, s);
-  }
-  createDepositAssist(e, t, s) {
-    return this.createComponent("deposit-assist", e, t, s);
-  }
-  createConnect(e, t, s) {
-    return this.createComponent("connect", e, t, s);
+  /**
+   * 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(t, r, i) {
+    return this.createComponent(
+      "withdrawal-assist",
+      t,
+      r,
+      i
+    );
   }
-  createDepositRequest(e, t, s) {
-    return this.createComponent("deposit-request", e, t, s);
+  /**
+   * 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(t, r, i) {
+    return this.createComponent(
+      "connect",
+      t,
+      r,
+      i
+    );
   }
-  decodeFragmentToObject(e) {
-    return e.slice(1).split("&").reduce(
-      (s, o) => {
-        const [i, a] = o.split("=");
-        return s[decodeURIComponent(i)] = decodeURIComponent(a), s;
-      },
-      {}
+  /**
+   * 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(t, r, i) {
+    return this.createComponent(
+      "deposit-request",
+      t,
+      r,
+      i
     );
   }
 }
 export {
-  E as default
+  u as AgentType,
+  h as CMType,
+  w as EmbeddedComponent,
+  d as HMType,
+  E as PersonType,
+  v as ProofStatus,
+  g as ProofTypes,
+  f as Status,
+  p as ValidationSections,
+  b as decodeFragmentToObject,
+  A as default
 };

package/package.json

@@ -9,7 +9,8 @@
   },
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
-  "version": "2.0.0-next.9",
+  "packageManager": "yarn@3.2.2",
+  "version": "2.0.1",
   "source": "src/notabene.ts",
   "main": "dist/notabene.js",
   "types": "dist/notabene.d.ts",
@@ -21,44 +22,52 @@
     "README.md"
   ],
   "scripts": {
-    "prepare": "husky install",
+    "docs": "typedoc --options typedoc.json",
+    "prepare": "husky",
     "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:clean": "rimraf dist/ ts-out coverage temp etc",
+    "build": "yarn lint && vite build && yarn typecheck && yarn docs",
     "lint": "eslint .",
+    "format": "prettier --write .",
     "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "coverage": "vitest run --coverage --coverage.extension=.ts",
     "release": "semantic-release",
-    "publish": "yarn build && npm publish --tag next"
+    "publish": "yarn build && npm publish"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.4.0",
-    "@commitlint/config-conventional": "^19.2.2",
-    "@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.4",
+    "@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",
+    "@vitest/coverage-v8": "2.1.3",
+    "eslint": "^9.14.0",
     "eslint-config-prettier": "^9.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.23.1",
+    "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",
     "rimraf": "^6.0.1",
-    "semantic-release": "^24.1.0",
-    "typescript": "^5.5.4",
-    "typescript-eslint": "^8.2.0",
-    "vite": "^5.4.2",
-    "vitest": "^2.0.5"
+    "semantic-release": "^24.2.0",
+    "typedoc": "^0.26.11",
+    "typedoc-plugin-markdown": "^4.2.10",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.12.2",
+    "vite": "^5.4.10",
+    "vitest": "^2.1.3"
   },
   "lint-staged": {
     "*.ts": [