@dobrodesk/widget 0.1.0

package/README.md

@@ -0,0 +1,33 @@
+# @dobrodesk/widget
+
+Browser SDK for the [DobroDesk](https://dobrodesk.com) website support widget.
+
+## Install
+
+```bash
+npm install @dobrodesk/widget
+```
+
+## Get the Widget ID
+
+In DobroDesk open **Admin > Channels > Website widget**. Create a widget or select an existing one,
+then copy its **Widget ID**.
+
+## Initialize
+
+```ts
+import { createDobroDeskWidget } from "@dobrodesk/widget";
+
+const widget = createDobroDeskWidget({
+  integrationId: "acme-support",
+  locale: "auto",
+});
+
+await widget.ready;
+widget.open();
+```
+
+`integrationId` is the Widget ID from DobroDesk Admin. Initialize the SDK in browser-side code.
+
+Full setup, API and localization instructions:
+[dobrodesk.com/help/initialize-dobrodesk-widget-programmatically](https://dobrodesk.com/help/initialize-dobrodesk-widget-programmatically).

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import type { DobroDeskWidgetClient, DobroDeskWidgetCommandFunction, DobroDeskWidgetErrorDetail, DobroDeskWidgetOptions, DobroDeskWidgetReadyDetail } from "./types";
+declare global {
+    interface Window {
+        DobroDeskWidget?: DobroDeskWidgetCommandFunction | unknown[][];
+    }
+    interface WindowEventMap {
+        "dobrodesk:error": CustomEvent<DobroDeskWidgetErrorDetail>;
+        "dobrodesk:ready": CustomEvent<DobroDeskWidgetReadyDetail>;
+    }
+}
+export declare const createDobroDeskWidget: (options: DobroDeskWidgetOptions) => DobroDeskWidgetClient;
+export type { DobroDeskWidgetClient, DobroDeskWidgetCommand, DobroDeskWidgetOptions, DobroDeskWidgetPrefill, } from "./types";

package/dist/index.js

@@ -0,0 +1,91 @@
+// packages/widget-sdk/src/index.ts
+var DEFAULT_LOADER_URL = "https://dobrodesk.com/widget/loader/v1.min.js";
+var activeClient = null;
+var requireBrowser = () => {
+  if (typeof window === "undefined" || typeof document === "undefined") {
+    throw new Error("DobroDesk widget initialization requires a browser document.");
+  }
+};
+var requireIntegrationId = (integrationId) => {
+  const normalizedIntegrationId = integrationId.trim();
+  if (!normalizedIntegrationId) {
+    throw new Error("DobroDesk integrationId is required.");
+  }
+  return normalizedIntegrationId;
+};
+var queueCommand = (command, value) => {
+  if (typeof window.DobroDeskWidget === "function") {
+    window.DobroDeskWidget(command, value);
+    return;
+  }
+  const queue = Array.isArray(window.DobroDeskWidget) ? window.DobroDeskWidget : [];
+  queue.push(value === undefined ? [command] : [command, value]);
+  window.DobroDeskWidget = queue;
+};
+var createDobroDeskWidget = (options) => {
+  requireBrowser();
+  if (activeClient) {
+    throw new Error("DobroDesk widget has already been initialized on this page.");
+  }
+  const integrationId = requireIntegrationId(options.integrationId);
+  const locale = options.locale?.trim() || "auto";
+  const loaderUrl = options.loaderUrl?.trim() || DEFAULT_LOADER_URL;
+  const script = document.createElement("script");
+  script.async = true;
+  script.src = loaderUrl;
+  script.dataset.dobrodeskIntegration = integrationId;
+  script.dataset.dobrodeskLocale = locale;
+  script.dataset.dobrodeskLoader = "true";
+  if (options.prefill) {
+    queueCommand("prefill", options.prefill);
+  }
+  if (options.openOnReady) {
+    queueCommand("open");
+  }
+  const ready = new Promise((resolve, reject) => {
+    const cleanup = () => {
+      window.removeEventListener("dobrodesk:ready", handleReady);
+      window.removeEventListener("dobrodesk:error", handleError);
+      script.removeEventListener("error", handleScriptError);
+    };
+    const handleReady = (event) => {
+      if (event.detail.integrationId !== integrationId)
+        return;
+      cleanup();
+      resolve();
+    };
+    const handleError = (event) => {
+      if (event.detail.integrationId !== integrationId)
+        return;
+      cleanup();
+      reject(event.detail.error);
+    };
+    const handleScriptError = () => {
+      cleanup();
+      reject(new Error(`DobroDesk widget loader could not be loaded from ${loaderUrl}.`));
+    };
+    window.addEventListener("dobrodesk:ready", handleReady);
+    window.addEventListener("dobrodesk:error", handleError);
+    script.addEventListener("error", handleScriptError, { once: true });
+  });
+  const client = {
+    ready,
+    open: () => queueCommand("open"),
+    close: () => queueCommand("close"),
+    toggle: () => queueCommand("toggle"),
+    hide: () => queueCommand("hide"),
+    show: () => queueCommand("show"),
+    prefill: (value) => queueCommand("prefill", value),
+    setLocale: (value) => queueCommand("setLocale", value),
+    destroy: () => {
+      queueCommand("destroy");
+      script.remove();
+    }
+  };
+  activeClient = client;
+  document.head.append(script);
+  return client;
+};
+export {
+  createDobroDeskWidget
+};

package/dist/types.d.ts

@@ -0,0 +1,35 @@
+export type DobroDeskWidgetPrefill = {
+    readonly name?: string;
+    readonly email?: string;
+    readonly subject?: string;
+    readonly message?: string;
+    readonly fields?: Readonly<Record<string, string | boolean>>;
+};
+export type DobroDeskWidgetOptions = {
+    readonly integrationId: string;
+    readonly locale?: string;
+    readonly loaderUrl?: string;
+    readonly prefill?: DobroDeskWidgetPrefill;
+    readonly openOnReady?: boolean;
+};
+export type DobroDeskWidgetCommand = "open" | "close" | "toggle" | "hide" | "show" | "prefill" | "setLocale" | "destroy";
+export type DobroDeskWidgetCommandFunction = (command: DobroDeskWidgetCommand, value?: DobroDeskWidgetPrefill | string) => void;
+export type DobroDeskWidgetClient = {
+    readonly ready: Promise<void>;
+    readonly open: () => void;
+    readonly close: () => void;
+    readonly toggle: () => void;
+    readonly hide: () => void;
+    readonly show: () => void;
+    readonly prefill: (value: DobroDeskWidgetPrefill) => void;
+    readonly setLocale: (locale: string) => void;
+    readonly destroy: () => void;
+};
+export type DobroDeskWidgetReadyDetail = {
+    readonly integrationId: string;
+    readonly locale: string;
+};
+export type DobroDeskWidgetErrorDetail = {
+    readonly integrationId: string;
+    readonly error: unknown;
+};

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@dobrodesk/widget",
+  "version": "0.1.0",
+  "description": "Programmatic browser SDK for the DobroDesk website support widget.",
+  "keywords": [
+    "customer-support",
+    "support-widget",
+    "website-widget"
+  ],
+  "homepage": "https://dobrodesk.com",
+  "author": "Comstudio",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/comstud-io/dobrodesk.git",
+    "directory": "packages/widget-sdk"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}