@getbee/widget-loader 0.1.0

package/README.md

@@ -0,0 +1,80 @@
+# Getbee Widget Loader
+
+Typed NPM package for adding the Getbee iframe widget script with one init function.
+
+## Install
+
+```bash
+npm install @getbee/widget-loader
+```
+
+## Usage
+
+```ts
+import { init } from "@getbee/widget-loader";
+
+init({
+  tenant: "TENANT_NAME",
+  infoBox: {
+    isEnabled: true,
+    text: "Chat with one of our experts",
+    timer: 5000
+  },
+  cta: {
+    type: "image",
+    image: {
+      imageUrl: "https://testbeestorage.blob.core.windows.net/devwidget/oRPL4JQ3.png"
+    }
+  },
+  showCta: true,
+  position: "right",
+  spacing: "16px",
+  bottomSpacing: "16px",
+  sectionIds: "SHOPIFY_SECTION_IDS"
+});
+```
+
+`tenant` is required. All other widget configuration fields are optional.
+
+## React example
+
+```tsx
+import { useEffect } from "react";
+import { initGetbeeWidget } from "@getbee/widget-loader";
+
+export function GetbeeWidget() {
+  useEffect(() => {
+    initGetbeeWidget({
+      tenant: "TENANT_NAME",
+      position: "right",
+      spacing: "16px",
+      bottomSpacing: "16px"
+    }).catch(console.error);
+  }, []);
+
+  return null;
+}
+```
+
+## Behavior
+
+- Sets `window.getbeeWidgetConf` from the provided config.
+- Appends `https://iframe.getbee.com/dist/getbee.js` to the end of the page.
+- If `init` is called before the page is ready, the script is appended after `DOMContentLoaded`.
+- If `init` is called multiple times, the script is not duplicated.
+- Returns a `Promise<HTMLScriptElement>` that resolves when the script loads.
+
+## Optional loader settings
+
+```ts
+init(
+  { tenant: "TENANT_NAME" },
+  {
+    scriptUrl: "https://iframe.getbee.com/dist/getbee.js",
+    scriptId: "getbee-widget-loader-script",
+    forceReload: false,
+    onLoad: (script) => console.log("Getbee loaded", script),
+    onError: (event) => console.error("Getbee failed to load", event)
+  }
+);
+```

package/dist/index.d.ts

@@ -0,0 +1,72 @@
+declare const GETBEE_SCRIPT_URLS: {
+    readonly dev: "https://iframe.devbee.me/dist/getbee.js";
+    readonly test: "https://iframe.testbee.me/dist/getbee.js";
+    readonly staging: "https://staging-iframe.getbee.com/dist/getbee.js";
+    readonly prod: "https://iframe.getbee.com/dist/getbee.js";
+};
+export type GetbeeWidgetEnvironment = keyof typeof GETBEE_SCRIPT_URLS;
+export type GetbeeWidgetPosition = "left" | "right";
+export type GetbeeCtaType = "image" | "video";
+export interface GetbeeInfoBoxConfig {
+    isEnabled?: boolean;
+    text?: string;
+    timer?: number;
+    showIcon?: boolean;
+    background?: string;
+}
+export interface GetbeeImageCtaConfig {
+    imageUrl?: string;
+}
+export interface GetbeeVideoPageConfig {
+    heading?: string;
+    descrp?: string;
+    btnText?: string;
+}
+export interface GetbeeVideoCtaConfig {
+    text?: string;
+    videoUrl?: string;
+    videoPage?: GetbeeVideoPageConfig;
+}
+export interface GetbeeCtaConfig {
+    type?: GetbeeCtaType;
+    image?: GetbeeImageCtaConfig;
+    video?: GetbeeVideoCtaConfig;
+}
+export interface GetbeeWidgetConfig {
+    tenant: string;
+    infoBox?: GetbeeInfoBoxConfig;
+    cta?: GetbeeCtaConfig;
+    showCta?: boolean;
+    position?: GetbeeWidgetPosition;
+    spacing?: string;
+    bottomSpacing?: string;
+    sectionIds?: string;
+}
+export interface InitGetbeeWidgetConfig extends GetbeeWidgetConfig {
+    env?: GetbeeWidgetEnvironment;
+}
+export interface InitGetbeeWidgetOptions {
+    /**
+     * Override only for testing or custom deployments.
+     */
+    scriptUrl?: string;
+    /**
+     * DOM id used for the injected script tag.
+     */
+    scriptId?: string;
+    /**
+     * Remove an existing Getbee script tag and append a fresh one.
+     */
+    forceReload?: boolean;
+    onLoad?: (script: HTMLScriptElement) => void;
+    onError?: (event: Event) => void;
+}
+declare global {
+    interface Window {
+        getbeeWidgetConf?: GetbeeWidgetConfig;
+    }
+}
+export declare const initGetbeeWidget: (config: InitGetbeeWidgetConfig, options?: InitGetbeeWidgetOptions) => Promise<HTMLScriptElement>;
+export declare const init: (config: InitGetbeeWidgetConfig, options?: InitGetbeeWidgetOptions) => Promise<HTMLScriptElement>;
+export default initGetbeeWidget;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,kBAAkB;;;;;CAKd,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,MAAM,OAAO,kBAAkB,CAAC;AACtE,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,OAAO,CAAC;AACpD,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,qBAAqB,CAAC;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB;IAChE,GAAG,CAAC,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAC7C,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;KACvC;CACF;AAoGD,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,sBAAsB,EAC9B,UAAS,uBAA4B,+BAuBtC,CAAC;AAEF,eAAO,MAAM,IAAI,WA1BP,sBAAsB,YACrB,uBAAuB,+BAyBE,CAAC;AAErC,eAAe,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,88 @@
+const DEFAULT_SCRIPT_ID = "getbee-widget-loader-script";
+const DEFAULT_ENV = "prod";
+const GETBEE_SCRIPT_URLS = {
+    dev: "https://iframe.devbee.me/dist/getbee.js",
+    test: "https://iframe.testbee.me/dist/getbee.js",
+    staging: "https://staging-iframe.getbee.com/dist/getbee.js",
+    prod: "https://iframe.getbee.com/dist/getbee.js",
+};
+const isBrowser = () => typeof window !== "undefined" && typeof document !== "undefined";
+const validateConfig = (config) => {
+    if (!config || typeof config !== "object") {
+        throw new Error("Getbee widget config is required.");
+    }
+    if (!config.tenant ||
+        typeof config.tenant !== "string" ||
+        !config.tenant.trim()) {
+        throw new Error("Getbee widget tenant is required.");
+    }
+};
+const resolveScriptUrl = (env = DEFAULT_ENV) => {
+    if (!Object.prototype.hasOwnProperty.call(GETBEE_SCRIPT_URLS, env)) {
+        throw new Error(`Unsupported Getbee widget environment: ${env}`);
+    }
+    return GETBEE_SCRIPT_URLS[env];
+};
+const runAfterDocumentReady = (callback) => {
+    if (document.readyState === "loading") {
+        document.addEventListener("DOMContentLoaded", callback, { once: true });
+        return;
+    }
+    callback();
+};
+const getExistingScript = (scriptId, scriptUrl) => {
+    const byId = document.getElementById(scriptId);
+    if (byId instanceof HTMLScriptElement) {
+        return byId;
+    }
+    const absoluteScriptUrl = new URL(scriptUrl, window.location.href).href;
+    const bySrc = Array.from(document.scripts).find((script) => script.src === absoluteScriptUrl || script.getAttribute("src") === scriptUrl);
+    return bySrc !== null && bySrc !== void 0 ? bySrc : null;
+};
+const appendScriptToEndOfPage = (scriptUrl, scriptId, options) => new Promise((resolve, reject) => {
+    runAfterDocumentReady(() => {
+        const existingScript = getExistingScript(scriptId, scriptUrl);
+        if (existingScript && !options.forceReload) {
+            resolve(existingScript);
+            return;
+        }
+        if (existingScript && options.forceReload) {
+            existingScript.remove();
+        }
+        const script = document.createElement("script");
+        script.id = scriptId;
+        script.type = "text/javascript";
+        script.async = true;
+        script.src = scriptUrl;
+        script.dataset.getbeeWidgetLoader = "true";
+        script.addEventListener("load", () => {
+            var _a;
+            (_a = options.onLoad) === null || _a === void 0 ? void 0 : _a.call(options, script);
+            resolve(script);
+        }, { once: true });
+        script.addEventListener("error", (event) => {
+            var _a;
+            (_a = options.onError) === null || _a === void 0 ? void 0 : _a.call(options, event);
+            reject(new Error(`Failed to load Getbee widget script: ${scriptUrl}`));
+        }, { once: true });
+        const parent = document.body || document.documentElement;
+        parent.appendChild(script);
+    });
+});
+export const initGetbeeWidget = (config, options = {}) => {
+    var _a, _b;
+    validateConfig(config);
+    if (!isBrowser()) {
+        return Promise.reject(new Error("Getbee widget can only be initialized in a browser."));
+    }
+    const { env, ...widgetConfig } = config;
+    const scriptUrl = (_a = options.scriptUrl) !== null && _a !== void 0 ? _a : resolveScriptUrl(env);
+    window.getbeeWidgetConf = {
+        ...widgetConfig,
+        tenant: widgetConfig.tenant.trim(),
+    };
+    return appendScriptToEndOfPage(scriptUrl, (_b = options.scriptId) !== null && _b !== void 0 ? _b : DEFAULT_SCRIPT_ID, options);
+};
+export const init = initGetbeeWidget;
+export default initGetbeeWidget;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;AACxD,MAAM,WAAW,GAAG,MAAM,CAAC;AAC3B,MAAM,kBAAkB,GAAG;IACzB,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,0CAA0C;IAChD,OAAO,EAAE,kDAAkD;IAC3D,IAAI,EAAE,0CAA0C;CACxC,CAAC;AA0EX,MAAM,SAAS,GAAG,GAAG,EAAE,CACrB,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,QAAQ,KAAK,WAAW,CAAC;AAEnE,MAAM,cAAc,GAAG,CAAC,MAA0B,EAAE,EAAE;IACpD,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;IAED,IACE,CAAC,MAAM,CAAC,MAAM;QACd,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ;QACjC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EACrB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAA+B,WAAW,EAAE,EAAE;IACtE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,KAAK,CAAC,0CAA0C,GAAG,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,QAAoB,EAAE,EAAE;IACrD,IAAI,QAAQ,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACtC,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,OAAO;IACT,CAAC;IAED,QAAQ,EAAE,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAE,SAAiB,EAAE,EAAE;IAChE,MAAM,IAAI,GAAG,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAE/C,IAAI,IAAI,YAAY,iBAAiB,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;IACxE,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAC7C,CAAC,MAAM,EAAE,EAAE,CACT,MAAM,CAAC,GAAG,KAAK,iBAAiB,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,SAAS,CAC/E,CAAC;IAEF,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,IAAI,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAC9B,SAAiB,EACjB,QAAgB,EAChB,OAAgC,EAChC,EAAE,CACF,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IACjD,qBAAqB,CAAC,GAAG,EAAE;QACzB,MAAM,cAAc,GAAG,iBAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAE9D,IAAI,cAAc,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YAC3C,OAAO,CAAC,cAAc,CAAC,CAAC;YACxB,OAAO;QACT,CAAC;QAED,IAAI,cAAc,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YAC1C,cAAc,CAAC,MAAM,EAAE,CAAC;QAC1B,CAAC;QAED,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC;QACrB,MAAM,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAChC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;QACvB,MAAM,CAAC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC;QAE3C,MAAM,CAAC,gBAAgB,CACrB,MAAM,EACN,GAAG,EAAE;;YACH,MAAA,OAAO,CAAC,MAAM,wDAAG,MAAM,CAAC,CAAC;YACzB,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;QAEF,MAAM,CAAC,gBAAgB,CACrB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE;;YACR,MAAA,OAAO,CAAC,OAAO,wDAAG,KAAK,CAAC,CAAC;YACzB,MAAM,CAAC,IAAI,KAAK,CAAC,wCAAwC,SAAS,EAAE,CAAC,CAAC,CAAC;QACzE,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;QAEF,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,eAAe,CAAC;QACzD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,MAA8B,EAC9B,UAAmC,EAAE,EACrC,EAAE;;IACF,cAAc,CAAC,MAAM,CAAC,CAAC;IAEvB,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;QACjB,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,KAAK,CAAC,qDAAqD,CAAC,CACjE,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,GAAG,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;IACxC,MAAM,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAE7D,MAAM,CAAC,gBAAgB,GAAG;QACxB,GAAG,YAAY;QACf,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE;KACnC,CAAC;IAEF,OAAO,uBAAuB,CAC5B,SAAS,EACT,MAAA,OAAO,CAAC,QAAQ,mCAAI,iBAAiB,EACrC,OAAO,CACR,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,gBAAgB,CAAC;AAErC,eAAe,gBAAgB,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@getbee/widget-loader",
+  "version": "0.1.0",
+  "description": "Typed loader for installing the Getbee widget script with one init function.",
+  "license": "ISC",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "prepack": "npm run build"
+  },
+  "keywords": [
+    "getbee",
+    "widget",
+    "iframe",
+    "loader"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.5"
+  }
+}