npm - @leadbot/components - Versions diffs - 2.21.0 - Mend

@leadbot/components 2.21.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 (20) hide show

package/dist/mount.d.ts ADDED Viewed

@@ -0,0 +1,88 @@
+import { type ComponentType } from "preact";
+import { type LeadbotClient } from "@leadbot/core";
+export interface LeadbotComponentsConfig {
+    domainKey?: string;
+    /** API server origin, e.g. "https://collector.example.com" — "/api" is appended. */
+    apiHost?: string;
+    /** Id of the component leadbot these components belong to (dashboard → Settings → Components). */
+    leadbotId?: number;
+    /**
+     * Page path sent to the collector; defaults to location.pathname. The boot
+     * fetch also reads `<html lang>`, so outside a browser pass `language` too
+     * — path alone still touches `document`.
+     */
+    path?: string;
+    /** Page language sent to the collector; defaults to the `<html lang>` attribute. */
+    language?: string;
+    /**
+     * Dashboard preview token, authorizing the unpublished draft flow. Only
+     * honoured together with `preview: true`. Dashboard preview only — never
+     * commit one into a production build: it grants read access to draft flows
+     * to anyone reading the shipped JS.
+     */
+    previewToken?: string;
+    /** Base/primary color for buttons etc. — sets --leadbot-primary on the mount. */
+    baseColor?: string;
+    /**
+     * Test/preview mode. Submissions and chat turns run end-to-end (AI still
+     * responds) but the collector does not persist them to the inbox. Used by
+     * the dashboard preview so test interactions never create real leads.
+     */
+    preview?: boolean;
+}
+/**
+ * Set module-level defaults; every mount accepts the same keys as overrides.
+ * With a domain key and a leadbot id it also runs the boot fetch right away,
+ * so the pageview is billed even on pages that mount no components.
+ *
+ * Note: without a `leadbotId` there is no boot fetch, so `applyFlowGates`
+ * never runs — a first-ever visit to such a page stays dark and no GA events
+ * fire. Pass the leadbot id to get the same tracking as the classic widget.
+ */
+export declare function init(config: LeadbotComponentsConfig): void;
+/** Merge the `init()` defaults under explicitly-set option keys. */
+export declare function withDefaults(options: LeadbotComponentsConfig): LeadbotComponentsConfig;
+export declare function resolveClient(options: LeadbotComponentsConfig): LeadbotClient;
+/**
+ * Boot fetch of the published flow: delivers the steps and bills the pageview.
+ * Bumps the generation, so a response for a route the caller has already left
+ * loses the race and never arms tracking with the stale bot's gates.
+ */
+export declare function loadFlow(options: LeadbotComponentsConfig): Promise<import("@leadbot/core").LeadBotConfig | null>;
+/**
+ * Preview fields for submit/chat calls and the boot fetch, falling back to the
+ * `init()` defaults — without the token the collector rejects draft steps as
+ * unpublished. The token is dropped unless `preview` is set, so one accidentally
+ * hardcoded into a shipped bundle cannot read draft flows on its own.
+ */
+export declare function previewOptions(options: LeadbotComponentsConfig): Pick<LeadbotComponentsConfig, "preview" | "previewToken">;
+export interface BaseMountOptions extends LeadbotComponentsConfig {
+    /** Extra class name(s) added to the mount container. */
+    className?: string;
+    /**
+     * `false` drops the widget chrome — card surface, size caps, scroll region,
+     * and the form's actions bar — leaving only functional styling (field
+     * stacking, focus rings, error states) inside your own layout.
+     */
+    chrome?: boolean;
+}
+export interface MountHandle<O> {
+    update(options: Partial<O>): void;
+    destroy(): void;
+}
+/** Styling root: every rule in `@leadbot/components/styles.css` is scoped to it. */
+export declare const ROOT_CLASS = "leadbot-components";
+/** Added next to ROOT_CLASS when a mount opts out of the widget chrome. */
+export declare const BARE_CLASS = "leadbot-bare";
+/**
+ * Render a Preact component into `el` (light DOM) and return an imperative
+ * handle. `update()` shallow-merges options and re-renders in place, so
+ * component state (chat history, form values) survives updates.
+ */
+export declare function createMount<O extends BaseMountOptions>(Component: ComponentType<O>, el: HTMLElement, options: O): MountHandle<O>;
+/**
+ * Analytics context sent with component submissions and chat turns — the same
+ * builder the classic widget uses, so both produce identical fields.
+ */
+export { buildAnalytics } from "@leadbot/core";
+//# sourceMappingURL=mount.d.ts.map

package/dist/mount.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"mount.d.ts","sourceRoot":"","sources":["../src/mount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,QAAQ,CAAC;AACvD,OAAO,EAKN,KAAK,aAAa,EAIlB,MAAM,eAAe,CAAC;AAEvB,MAAM,WAAW,uBAAuB;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oFAAoF;IACpF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kGAAkG;IAClG,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oFAAoF;IACpF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAKD;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI,CA2B1D;AAID,oEAAoE;AACpE,wBAAgB,YAAY,CAC3B,OAAO,EAAE,uBAAuB,GAC9B,uBAAuB,CAMzB;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,uBAAuB,GAAG,aAAa,CAK7E;AA2BD;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,uBAAuB,yDAExD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC7B,OAAO,EAAE,uBAAuB,GAC9B,IAAI,CAAC,uBAAuB,EAAE,SAAS,GAAG,cAAc,CAAC,CAQ3D;AAED,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;IAChE,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC;IAC7B,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAClC,OAAO,IAAI,IAAI,CAAC;CAChB;AAED,oFAAoF;AACpF,eAAO,MAAM,UAAU,uBAAuB,CAAC;AAE/C,2EAA2E;AAC3E,eAAO,MAAM,UAAU,iBAAiB,CAAC;AAMzC;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,gBAAgB,EACrD,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC,EAC3B,EAAE,EAAE,WAAW,EACf,OAAO,EAAE,CAAC,GACR,WAAW,CAAC,CAAC,CAAC,CA+BhB;AAED;;;GAGG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC"}