@notabene/javascript-sdk 1.34.0 → 2.0.0-RC

package/dist/notabene.js

@@ -0,0 +1,343 @@
+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() {
+    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(t) {
+    this.port = t, this.port.onmessage = this.handleMessage, this.port.start();
+  }
+  /**
+     * 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);
+  }
+  /**
+   * 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));
+  }
+  /**
+   * 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));
+    }
+  }
+  /**
+   * Sends a message through the message port
+   * @param message The host message to send
+   */
+  send(t) {
+    this.port && this.port.postMessage(t);
+  }
+}
+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;
+  }
+  /**
+   * 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();
+  }
+  removeEmbed() {
+    this.iframe && this.iframe.remove();
+  }
+  /**
+   * Sends a message to the embedded component
+   * @param message - The message to send
+   */
+  send(t) {
+    this.eventManager.send(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);
+  }
+  /**
+   * 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);
+  }
+  /**
+   * 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((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();
+      });
+    });
+  }
+  /**
+   * 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(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 t;
+    this.modal && ((t = this.modal) == null || t.close(), this.modal.remove(), this.modal = void 0);
+  }
+}
+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 `${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 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: r,
+      configuration: i
+    });
+    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();
+  }
+  /**
+   * 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
+    );
+  }
+  /**
+   * 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
+    );
+  }
+  /**
+   * 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
+    );
+  }
+  /**
+   * 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 {
+  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/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.47.11"
+    }
+  ]
+}

package/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@notabene/javascript-sdk",
+  "type": "module",
   "description": "JavaScript SDK for Notabene",
   "homepage": "https://gitlab.com/notabene/open-source/javascript-sdk",
   "repository": {
@@ -8,74 +9,63 @@
   },
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
-  "version": "1.34.0",
-  "main": "dist/index.js",
-  "packageManager": "yarn@3.2.2",
+  "version": "2.0.0-RC",
+  "source": "src/notabene.ts",
+  "main": "dist/notabene.js",
+  "types": "dist/notabene.d.ts",
   "browserslist": "> 0.5%, last 2 versions, not dead",
-  "targets": {
-    "es": {
-      "source": "src/module/index.ts",
-      "isLibrary": false,
-      "context": "browser",
-      "outputFormat": "esmodule"
-    },
-    "lib": {
-      "source": "src/lib/index.ts",
-      "isLibrary": true,
-      "context": "node",
-      "outputFormat": "commonjs"
-    }
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "alias": {
-    "process": false,
-    "buffer": false
-  },
+  "files": [
+    "dist",
+    "src",
+    "package.json",
+    "README.md"
+  ],
   "scripts": {
+    "docs": "typedoc --options typedoc.json",
     "prepare": "husky install",
+    "dev": "vite",
+    "preview": "vite preview",
     "watch": "parcel watch",
-    "dev": "sirv --dev --port 3002 public",
     "build:dev": "yarn build && yarn dev",
-    "build": "yarn build:clean && yarn build:compile",
-    "build:clean": "rimraf dist/ .parcel-cache/",
-    "build:compile": "parcel build --no-source-maps && cp dist/es/index.js public/js/notabene.js",
+    "build:clean": "rimraf dist/ ts-out",
+    "build": "yarn lint && vite build && tsc && api-extractor run && yarn docs ",
     "lint": "eslint .",
-    "test": "jest --passWithNoTests --runInBand",
-    "release": "semantic-release"
+    "format": "prettier --write .",
+    "test": "vitest",
+    "coverage": "vitest run --coverage --coverage.extension=.ts",
+    "release": "semantic-release",
+    "publish": "yarn build && npm publish --tag next"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.2.1",
-    "@commitlint/config-conventional": "^16.2.1",
-    "@parcel/packager-ts": "^2.5.0",
-    "@parcel/transformer-typescript-types": "^2.5.0",
+    "@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",
-    "@types/jest": "^27.5.1",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^5.26.0",
-    "buffer": "^6.0.3",
-    "eslint": "^8.16.0",
-    "eslint-config-prettier": "^8.4.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-promise": "^6.0.0",
-    "husky": "^7.0.4",
-    "jest": "^28.1.0",
-    "lint-staged": "^12.3.4",
-    "organize-imports-cli": "^0.9.0",
-    "parcel": "^2.5.0",
-    "prettier": "^2.6.2",
-    "process": "^0.11.10",
-    "rimraf": "^3.0.2",
-    "semantic-release": "^19.0.2",
-    "sirv-cli": "^2.0.2",
-    "ts-jest": "^28.0.3",
-    "typescript": "^4.7.2"
+    "@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.13.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "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",
+    "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": [
@@ -87,9 +77,5 @@
     "extends": [
       "@commitlint/config-conventional"
     ]
-  },
-  "dependencies": {
-    "jsx-pragmatic": "^2.0.22",
-    "zoid": "^9.0.86"
   }
-}
+}