npm - @lvble/core - Versions diffs - 2.0.0 - Mend

@lvble/core 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) [2023] [Ignacio Andrés Miranda Figueroa]
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,115 @@
+# @lvble/core
+**@lvble/core** is a JavaScript package that provides a set of core functionalities for building interactive web applications with the lvble platform. It includes widgets and popups.
+## ⚡️ Quick start
+### NPM
+You can install **@lvble/core** using npm (Node Package Manager). Make sure you have Node.js and npm installed on your machine. Open your terminal or command prompt and run the following command:
+```bash
+npm install @lvble/core
+```
+In your `index.html`:
+```html
+<html>
+  <head>
+    <title>PMS</title>
+  </head>
+  <body>
+    <h1>Welcome to the best PMS ever!</h1>
+    <table style="width: 50%; margin: 0 auto;">
+      <tr>
+        <th>Lvble</th>
+      </tr>
+      <tr>
+        <td><button onclick="openLvbleExperience()">Lvble</button></td>
+      </tr>
+      <tr>
+        <td>Status</td>
+      </tr>
+    </table>
+    <script type="module" src="/main.js"></script>
+  </body>
+</html>
+```
+And in your `main.js` file:
+```javascript
+import { Lvble } from "@lvble/core";
+// Widgets
+const l = Lvble({
+  environment: "sandbox",
+  token: "token.",
+});
+const lvbleWidget = l.createWidget({
+  mode: "onboarding",
+  onEvent: function (eventType: string, data: any) {
+      switch (eventType) {
+        case "EXPERIENCE_OPENED":
+          ...
+          break;
+        case "EXPERIENCE_CLOSED":
+          ...
+          break;
+          ...
+        default:
+          break;
+      }
+  }
+});
+document
+  .getElementById("lvble-widget")
+  .appendChild(lvbleWidget);
+// Lvble experience
+const lvbleExperience = Lvble({
+  environment: "sandbox",
+  token: "token",
+});
+const openLvbleExperience = () =>
+  lvbleExperience.open({
+    mode: "onboarding",
+    onEvent: function (eventType: string, data: any) {
+      switch (eventType) {
+        case "EXPERIENCE_OPENED":
+          ...
+          break;
+        case "EXPERIENCE_CLOSED":
+          ...
+          break;
+          ...
+        default:
+          break;
+      }
+    }
+  });
+```
+### `<script>` tag
+Alternatively, you can include **@lvble/core** directly in your HTML file using a script tag like it's 1997 😎
+Add the following line inside the `<head>` or at the end of the `<body>` tag:
+```html
+<script src="https://unpkg.com/@lvble/core"></script>
+```
+Please refer to the documentation of **@lvble/core** for a complete list of available functionalities and their usage instructions.
+## Kudos
+[This template](https://github.com/IgnacioNMiranda/vite-component-library-template)
+[Ignacio Miranda Figueroa](https://www.linkedin.com/in/ignacio-miranda-figueroa/)
+## License
+[MIT](LICENSE)

package/dist/@lvble/core.es.js ADDED Viewed

@@ -0,0 +1,119 @@
+var f = Object.defineProperty;
+var p = (e, o, t) => o in e ? f(e, o, { enumerable: !0, configurable: !0, writable: !0, value: t }) : e[o] = t;
+var l = (e, o, t) => (p(e, typeof o != "symbol" ? o + "" : o, t), t);
+var k = /* @__PURE__ */ ((e) => (e.Local = "local", e.Sandbox = "sandbox", e.Production = "production", e))(k || {});
+const h = {
+  local: "http://localhost:3001",
+  sandbox: "https://widget.sandbox.pms.nowlvble.com",
+  production: "https://api.production.partners.nowlvble.com"
+}, d = {
+  local: "http://localhost:3001",
+  sandbox: "https://experience.sandbox.pms.nowlvble.com",
+  production: "https://api.production.partners.nowlvble.com"
+};
+class y extends HTMLElement {
+  constructor() {
+    super();
+    l(this, "_typeToEvent", {
+      onboarding: "finishOnboarding",
+      offboarding: "finishOffboarding",
+      split: "finishSplit",
+      repay: "finishRepay"
+      /* FinishRepay */
+    });
+    l(this, "_iframe");
+    this.attachShadow({ mode: "open" });
+  }
+  get mode() {
+    return this.getAttribute("mode");
+  }
+  set mode(t) {
+    t ? this.setAttribute("mode", t) : this.removeAttribute("mode");
+  }
+  get environment() {
+    return this.getAttribute("environment");
+  }
+  set environment(t) {
+    t ? this.setAttribute("environment", t) : this.removeAttribute("environment");
+  }
+  get token() {
+    return this.getAttribute("token");
+  }
+  set token(t) {
+    t ? this.setAttribute("token", t) : this.removeAttribute("token");
+  }
+  connectedCallback() {
+    var r;
+    const t = `${h[this.environment]}?token=${this.token}&environment=${this.environment}`, n = document.createElement("iframe");
+    n.src = t, n.width = "100%", n.height = "100%", n.style.borderStyle = "solid", n.style.borderRadius = "10px", n.style.borderColor = "transparent", this._iframe = n, (r = this.shadowRoot) == null || r.appendChild(n);
+  }
+  disconnectedCallback() {
+    this.shadowRoot && (this.shadowRoot.innerHTML = "");
+  }
+}
+customElements.get("lvble-widget") ?? customElements.define("lvble-widget", y);
+const $ = {
+  onboarding: customElements.get("lvble-widget"),
+  repay: customElements.get("lvble-widget")
+}, E = (e) => ({
+  /**
+   * This function creates a widget that can be embedded in your website.
+   *
+   * @param createOptions  The options for creating the widget. See CreateWidgetOptions for more information.
+   * @returns The widget.
+   */
+  // TODO: Add support for no mode
+  createWidget: (o) => {
+    const t = o.mode ? new $[o.mode]() : new (customElements.get(
+      "lvble-widget"
+    ))();
+    t.environment = e.environment, t.token = e.token, t.mode = o.mode;
+    const n = (r) => {
+      if (r.origin != h[e.environment]) {
+        console.debug(
+          `Received message from unknown origin: ${r.origin}`
+        );
+        return;
+      }
+      const s = r.data;
+      o.onEvent(s.eventType, s);
+    };
+    return window.addEventListener("message", n), t;
+  },
+  /**
+   * This function opens a popup with the relevant mode.
+   * @param openOptions The options for opening the widget. See OpenOptions for more information.
+   * @returns undefined.
+   */
+  open: (o) => {
+    const t = {
+      onboarding: `${d[e.environment]}?token=${e.token}`,
+      offboarding: `${d[e.environment]}?token=${e.token}`,
+      split: `${d[e.environment]}?token=${e.token}`,
+      repay: `${d[e.environment]}?token=${e.token}`
+    }, n = o.mode ? t[o.mode] : "", r = 450, s = 800, b = screen.width / 2 - r / 2, g = screen.height / 2 - s / 2;
+    window.open(
+      n,
+      "LvblePopup",
+      "width=" + r + ",height=" + s + ",location=no,left=" + b + ",top=" + g
+    );
+    const v = (i) => {
+      if (i.origin != d[e.environment]) {
+        console.debug(
+          `Received message from unknown origin: ${i.origin}`
+        );
+        return;
+      }
+      const a = i.data, u = document.querySelectorAll("lvble-widget");
+      i = JSON.parse(JSON.stringify(i)), u.forEach((w) => {
+        var c, m;
+        (m = ((c = w.shadowRoot) == null ? void 0 : c.querySelector("iframe")).contentWindow) == null || m.postMessage(i, "*");
+      }), o.onEvent(a.eventType, a);
+    };
+    window.addEventListener("message", v);
+  }
+}), A = E;
+export {
+  k as Environment,
+  A as Lvble
+};

package/dist/@lvble/core.umd.js ADDED Viewed

@@ -0,0 +1 @@

package/dist/index.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export * from './lib/index'

package/dist/lib/index.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export * from './lvble';
2	+ //# sourceMappingURL=index.d.ts.map

package/dist/lib/index.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA"}

package/dist/lib/lvble.d.ts ADDED Viewed

@@ -0,0 +1,93 @@
+export declare enum Environment {
+    Local = "local",
+    Sandbox = "sandbox",
+    Production = "production"
+}
+export declare type Mode = "onboarding" | "offboarding" | "split" | "repay";
+export declare type ErrorData = {
+    type: "error";
+    reason: string;
+};
+export declare type OnboardingData = ErrorData | {
+    type: "success";
+    status: string;
+};
+export declare type SplitData = ErrorData | {
+    type: "success";
+    external_id: string;
+    settlement_id: string;
+    amount: number;
+};
+export declare type CloseData = ErrorData | {
+    type: "close";
+};
+export declare type EventData = OnboardingData | SplitData | CloseData;
+declare enum EventType {
+    FinishOnboarding = "finishOnboarding",
+    FinishOffboarding = "finishOffboarding",
+    FinishSplit = "finishSplit",
+    FinishRepay = "finishRepay"
+}
+export interface InitOptions {
+    environment: Environment;
+    token: string;
+}
+export interface OpenOptions {
+    mode?: Mode;
+    onEvent: (eventType: string, data: any) => void;
+}
+export interface CreateWidgetOptions extends OpenOptions {
+    mode?: Extract<Mode, "onboarding" | "repay">;
+    onEvent: (eventType: string, data: any) => void;
+}
+declare class LvbleWidget extends HTMLElement {
+    _typeToEvent: {
+        onboarding: EventType;
+        offboarding: EventType;
+        split: EventType;
+        repay: EventType;
+    };
+    _iframe?: HTMLIFrameElement;
+    constructor();
+    get mode(): Mode;
+    set mode(val: Mode | undefined);
+    get environment(): Environment;
+    set environment(val: Environment);
+    get token(): string;
+    set token(val: string);
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+}
+declare const lvble: (initOptions: InitOptions) => {
+    /**
+     * This function creates a widget that can be embedded in your website.
+     *
+     * @param createOptions  The options for creating the widget. See CreateWidgetOptions for more information.
+     * @returns The widget.
+     */
+    createWidget: (createOptions: CreateWidgetOptions) => LvbleWidget;
+    /**
+     * This function opens a popup with the relevant mode.
+     * @param openOptions The options for opening the widget. See OpenOptions for more information.
+     * @returns undefined.
+     */
+    open: (openOptions: OpenOptions) => void;
+};
+export declare type LvbleType = ReturnType<typeof lvble>;
+export declare const Lvble: (initOptions: InitOptions) => {
+    /**
+     * This function creates a widget that can be embedded in your website.
+     *
+     * @param createOptions  The options for creating the widget. See CreateWidgetOptions for more information.
+     * @returns The widget.
+     */
+    createWidget: (createOptions: CreateWidgetOptions) => LvbleWidget;
+    /**
+     * This function opens a popup with the relevant mode.
+     * @param openOptions The options for opening the widget. See OpenOptions for more information.
+     * @returns undefined.
+     */
+    open: (openOptions: OpenOptions) => void;
+};
+export {};
+//# sourceMappingURL=lvble.d.ts.map

package/dist/lib/lvble.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"lvble.d.ts","sourceRoot":"","sources":["lvble.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW;IACrB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,UAAU,eAAe;CAC1B;AAaD,oBAAY,IAAI,GAAG,YAAY,GAAG,aAAa,GAAG,OAAO,GAAG,OAAO,CAAC;AACpE,oBAAY,SAAS,GAAG;IACtB,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AACF,oBAAY,cAAc,GACtB,SAAS,GACT;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AACN,oBAAY,SAAS,GACjB,SAAS,GACT;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AACN,oBAAY,SAAS,GACjB,SAAS,GACT;IACE,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEN,oBAAY,SAAS,GAAG,cAAc,GAAG,SAAS,GAAG,SAAS,CAAC;AAE/D,aAAK,SAAS;IACZ,gBAAgB,qBAAqB;IACrC,iBAAiB,sBAAsB;IACvC,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;CAC5B;AASD,MAAM,WAAW,WAAW;IAE1B,WAAW,EAAE,WAAW,CAAC;IAEzB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAE1B,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ,OAAO,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC;IAE7C,OAAO,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;CACjD;AAED,cAAM,WAAY,SAAQ,WAAW;IACnC,YAAY;;;;;MAKV;IACF,OAAO,CAAC,EAAE,iBAAiB,CAAC;;IAO5B,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,GAAG,SAAS,EAM7B;IAED,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,IAAI,WAAW,CAAC,GAAG,EAJA,WAIA,EAMlB;IAED,IAAI,KAAK,IAIM,MAAM,CAFpB;IAED,IAAI,KAAK,CAAC,GAAG,EAAE,MAAM,EAMpB;IAED,iBAAiB;IAiBjB,oBAAoB;CAGrB;AAeD,QAAA,MAAM,KAAK,gBAAiB,WAAW;IAEnC;;;;;OAKG;kCAE2B,mBAAmB;IA0BjD;;;;OAIG;wBACiB,WAAW;CAsDlC,CAAC;AAEF,oBAAY,SAAS,GAAG,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC;AAEjD,eAAO,MAAM,KAAK,gBAlGU,WAAW;IAEnC;;;;;OAKG;kCAE2B,mBAAmB;IA0BjD;;;;OAIG;wBACiB,WAAW;CA0DT,CAAC"}

package/dist/vite-env.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ /// <reference types="vite/client" />

package/package.json ADDED Viewed

@@ -0,0 +1,37 @@
+{
+  "name": "@lvble/core",
+  "private": false,
+  "version": "2.0.0",
+  "main": "./dist/@lvble/core.umd.js",
+  "module": "./dist/@lvble/core.es.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/@lvble/core.es.js",
+      "require": "./dist/@lvble/core.umd.js"
+    },
+    "./dist/style.css": "./dist/style.css"
+  },
+  "engines": {
+    "node": "16.18.1"
+  },
+  "scripts": {
+    "dev": "start-storybook -p 6006",
+    "build": "build-storybook",
+    "build:lib": "tsc && vite build --watch",
+    "lint:fix": "eslint --ext .js,.jsx,.ts,.tsx --fix",
+    "format:prettier": "prettier --write \"src/**/*.{ts,tsx,js,mdx}\"",
+    "test": "vitest",
+    "test:cov": "vitest run --coverage",
+    "prepack": "json -f package.json -I -e \"delete this.devDependencies; delete this.dependencies\""
+  },
+  "peerDependencies": {},
+  "files": [
+    "dist"
+  ],
+  "lint-staged": {
+    "*.{ts,tsx,js,jsx,json,css,md}": [
+      "prettier -w"
+    ]
+  }
+}