@cimulate/copilot-widget 1.31.0 → 1.32.1

package/dist/messaging.d.ts

@@ -349,6 +349,33 @@ export declare const eventHandlers: {
 
 declare type FacetFilters = Record<string, string[]>;
 
+/**
+ * Retrieve a single-use auth link key for the current conversation.
+ *
+ * The host-page/script-tag counterpart of the `getAuthLinkKey` method on the
+ * messaging context (React hosts use `useMessaging().getAuthLinkKey()`). Hand
+ * the returned key to your own backend, which bridges the shopper's session
+ * (e.g. a SLAS/commerce session) into the conversation so the agent inherits
+ * the shopper's identity — and cart.
+ *
+ * Call after `injectMessagingWidget()` has mounted the widget; rejects if the
+ * widget is not yet ready or the request fails. `async` so the registry's
+ * synchronous "not ready" throw surfaces as a rejected promise (honoring the
+ * contract for `.catch()` callers, not just `await`).
+ *
+ * The key is **single-use**: each call mints a fresh key that the server
+ * invalidates once redeemed. Do not cache it or retry a rejected call with the
+ * same key — request a new one, or you will send the backend a key it already
+ * consumed.
+ *
+ * @example
+ * ```js
+ * const authLinkKey = await window.CimulateMessaging.getAuthLinkKey();
+ * await fetch("/bridge-session", { method: "POST", body: JSON.stringify({ authLinkKey }) });
+ * ```
+ */
+export declare function getAuthLinkKey(): Promise<string>;
+
 declare interface HeaderConfig {
     logoUrl?: string;
     headerText?: string;
@@ -444,6 +471,14 @@ export declare interface MessagingContextType {
     retryLastMessage: () => ReturnType<SendMessage> | undefined;
     retryConnection: () => void;
     downloadTranscript: () => Promise<void>;
+    /**
+     * Retrieve a single-use auth link key for the current conversation. The host
+     * hands the key to its own backend, which bridges the shopper's session (e.g.
+     * a SLAS/commerce session) into this conversation so the agent inherits the
+     * shopper's identity — and cart. Resolves with the key; rejects if the widget
+     * is not connected or the request fails.
+     */
+    getAuthLinkKey: () => Promise<string>;
 }
 
 /**