@emplorium/sdk 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,157 @@
+type EmploriumUser = {
+    /**
+     * Display name for the visitor (legacy field, prefer firstName/lastName).
+     */
+    name?: string;
+    /**
+     * Visitor's first name. Used for personalized greetings in AI conversations.
+     */
+    firstName?: string;
+    /**
+     * Visitor's last name.
+     */
+    lastName?: string;
+    /**
+     * Visitor's email address.
+     */
+    email?: string;
+    /**
+     * External identifier from host application.
+     */
+    externalId?: string;
+    [key: string]: unknown;
+};
+type WidgetVisibilityState = "unknown" | "open" | "closed";
+type EmploriumEventMap = {
+    ready: void;
+    open: void;
+    close: void;
+    toggle: {
+        open: boolean;
+    };
+    widgetSettingsLoaded: boolean;
+    wsInitiated: boolean;
+    missedMessages: number;
+    launcherProperties: Record<string, unknown>;
+    previewOpen: {
+        url?: string;
+        fileType?: string;
+    };
+    error: Error;
+};
+type EmploriumConfig = {
+    /**
+     * Account/site identifier (the same value used in the snippet path).
+     */
+    accountId: string;
+    /**
+     * Override the loader script URL. Defaults to
+     * https://widget.emplorium.io/widget-script/${accountId}
+     */
+    scriptUrl?: string;
+    /**
+     * Origin of the widget host (used for postMessage targetOrigin).
+     * Derived from scriptUrl if omitted.
+     */
+    widgetOrigin?: string;
+    /**
+     * Additional script attributes to attach to the loader tag.
+     */
+    scriptAttributes?: Record<string, string>;
+    /**
+     * Custom allowed origins for postMessage; the host origin is always allowed.
+     */
+    allowedOrigins?: string[];
+    /**
+     * Whether to auto-load the loader script on init.
+     */
+    autoLoad?: boolean;
+    /**
+     * Whether to automatically open the widget after the loader is ready.
+     */
+    autoOpen?: boolean;
+    /**
+     * Logger implementation. Defaults to console-safe no-ops.
+     */
+    logger?: Logger;
+    /**
+     * User identity information to pre-populate.
+     * These values are passed to the backend as authoritative visitor data.
+     */
+    user?: EmploriumVisitorIdentity;
+    /**
+     * Control widget visibility. When set to false, the widget is completely hidden.
+     * Defaults to true.
+     */
+    enabled?: boolean;
+};
+/**
+ * Visitor identity information that can be provided during SDK initialization.
+ * When provided, these values are treated as authoritative by backend services.
+ */
+type EmploriumVisitorIdentity = {
+    /**
+     * Visitor's first name. Used for personalized AI greetings.
+     */
+    firstName?: string;
+    /**
+     * Visitor's last name.
+     */
+    lastName?: string;
+    /**
+     * Visitor's email address.
+     */
+    email?: string;
+};
+type EmploriumState = {
+    initialized: boolean;
+    loaderLoaded: boolean;
+    widgetReady: boolean;
+    visibility: WidgetVisibilityState;
+};
+type Logger = {
+    debug?: (...args: unknown[]) => void;
+    info?: (...args: unknown[]) => void;
+    warn?: (...args: unknown[]) => void;
+    error?: (...args: unknown[]) => void;
+};
+
+declare class EmploriumClient {
+    private readonly config;
+    private readonly emitter;
+    private readonly logger;
+    private readonly bridge;
+    private state;
+    private initPromise;
+    private readyPromise;
+    private resolveReady;
+    private isEnabled;
+    constructor(config: EmploriumConfig);
+    init: () => Promise<void>;
+    on: <K extends keyof EmploriumEventMap>(event: K, listener: (payload: EmploriumEventMap[K]) => void) => () => void;
+    off: <K extends keyof EmploriumEventMap>(event: K, listener: (payload: EmploriumEventMap[K]) => void) => void;
+    ready: () => Promise<void>;
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+    setUser: (user: EmploriumUser) => void;
+    /**
+     * Enable the widget (show it). Only has effect if widget was previously disabled.
+     */
+    enable: () => void;
+    /**
+     * Disable the widget (hide it completely).
+     */
+    disable: () => void;
+    /**
+     * Check if the widget is currently enabled.
+     */
+    isWidgetEnabled: () => boolean;
+    getState: () => EmploriumState;
+    destroy: () => void;
+    private bindApiMethods;
+    private setVisibility;
+    private bindBridgeEvents;
+}
+
+export { EmploriumClient, type EmploriumConfig, type EmploriumEventMap, type EmploriumState, type EmploriumUser, type EmploriumVisitorIdentity, type WidgetVisibilityState };

package/dist/index.d.ts

@@ -0,0 +1,157 @@
+type EmploriumUser = {
+    /**
+     * Display name for the visitor (legacy field, prefer firstName/lastName).
+     */
+    name?: string;
+    /**
+     * Visitor's first name. Used for personalized greetings in AI conversations.
+     */
+    firstName?: string;
+    /**
+     * Visitor's last name.
+     */
+    lastName?: string;
+    /**
+     * Visitor's email address.
+     */
+    email?: string;
+    /**
+     * External identifier from host application.
+     */
+    externalId?: string;
+    [key: string]: unknown;
+};
+type WidgetVisibilityState = "unknown" | "open" | "closed";
+type EmploriumEventMap = {
+    ready: void;
+    open: void;
+    close: void;
+    toggle: {
+        open: boolean;
+    };
+    widgetSettingsLoaded: boolean;
+    wsInitiated: boolean;
+    missedMessages: number;
+    launcherProperties: Record<string, unknown>;
+    previewOpen: {
+        url?: string;
+        fileType?: string;
+    };
+    error: Error;
+};
+type EmploriumConfig = {
+    /**
+     * Account/site identifier (the same value used in the snippet path).
+     */
+    accountId: string;
+    /**
+     * Override the loader script URL. Defaults to
+     * https://widget.emplorium.io/widget-script/${accountId}
+     */
+    scriptUrl?: string;
+    /**
+     * Origin of the widget host (used for postMessage targetOrigin).
+     * Derived from scriptUrl if omitted.
+     */
+    widgetOrigin?: string;
+    /**
+     * Additional script attributes to attach to the loader tag.
+     */
+    scriptAttributes?: Record<string, string>;
+    /**
+     * Custom allowed origins for postMessage; the host origin is always allowed.
+     */
+    allowedOrigins?: string[];
+    /**
+     * Whether to auto-load the loader script on init.
+     */
+    autoLoad?: boolean;
+    /**
+     * Whether to automatically open the widget after the loader is ready.
+     */
+    autoOpen?: boolean;
+    /**
+     * Logger implementation. Defaults to console-safe no-ops.
+     */
+    logger?: Logger;
+    /**
+     * User identity information to pre-populate.
+     * These values are passed to the backend as authoritative visitor data.
+     */
+    user?: EmploriumVisitorIdentity;
+    /**
+     * Control widget visibility. When set to false, the widget is completely hidden.
+     * Defaults to true.
+     */
+    enabled?: boolean;
+};
+/**
+ * Visitor identity information that can be provided during SDK initialization.
+ * When provided, these values are treated as authoritative by backend services.
+ */
+type EmploriumVisitorIdentity = {
+    /**
+     * Visitor's first name. Used for personalized AI greetings.
+     */
+    firstName?: string;
+    /**
+     * Visitor's last name.
+     */
+    lastName?: string;
+    /**
+     * Visitor's email address.
+     */
+    email?: string;
+};
+type EmploriumState = {
+    initialized: boolean;
+    loaderLoaded: boolean;
+    widgetReady: boolean;
+    visibility: WidgetVisibilityState;
+};
+type Logger = {
+    debug?: (...args: unknown[]) => void;
+    info?: (...args: unknown[]) => void;
+    warn?: (...args: unknown[]) => void;
+    error?: (...args: unknown[]) => void;
+};
+
+declare class EmploriumClient {
+    private readonly config;
+    private readonly emitter;
+    private readonly logger;
+    private readonly bridge;
+    private state;
+    private initPromise;
+    private readyPromise;
+    private resolveReady;
+    private isEnabled;
+    constructor(config: EmploriumConfig);
+    init: () => Promise<void>;
+    on: <K extends keyof EmploriumEventMap>(event: K, listener: (payload: EmploriumEventMap[K]) => void) => () => void;
+    off: <K extends keyof EmploriumEventMap>(event: K, listener: (payload: EmploriumEventMap[K]) => void) => void;
+    ready: () => Promise<void>;
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+    setUser: (user: EmploriumUser) => void;
+    /**
+     * Enable the widget (show it). Only has effect if widget was previously disabled.
+     */
+    enable: () => void;
+    /**
+     * Disable the widget (hide it completely).
+     */
+    disable: () => void;
+    /**
+     * Check if the widget is currently enabled.
+     */
+    isWidgetEnabled: () => boolean;
+    getState: () => EmploriumState;
+    destroy: () => void;
+    private bindApiMethods;
+    private setVisibility;
+    private bindBridgeEvents;
+}
+
+export { EmploriumClient, type EmploriumConfig, type EmploriumEventMap, type EmploriumState, type EmploriumUser, type EmploriumVisitorIdentity, type WidgetVisibilityState };