@helpai/elements 0.39.0 → 0.41.0

package/index.d.ts

@@ -1,4 +1,4 @@
-export { A as Asset, B as BlocksConfig, C as ConnectionConfig, a as ConnectionConfigPartial, H as HandshakeResponse, L as Link, S as ServerConfig, b as SiteConfig, W as WidgetConfig, c as WidgetConfigPartial, d as WidgetSettings, e as WidgetSettingsPartial } from './deployment-CrsbcoCF.js';
+export { A as Asset, B as BlocksConfig, C as ConnectionConfig, a as ConnectionConfigPartial, H as HandshakeResponse, L as Link, S as ServerConfig, b as SiteConfig, W as WidgetConfig, c as WidgetConfigPartial, d as WidgetSettings, e as WidgetSettingsPartial } from './deployment-CB6xjMr0.js';
 import 'zod';
 
 /**
@@ -40,7 +40,7 @@ interface ClientStorage {
  * populated {@link Strings} map. UI components then read `strings.send` as a
  * normal property access — no per-render lookup, no per-render allocation.
  */
-type StringKey = "launcherOpen" | "launcherLabel" | "panelTitle" | "composerPlaceholder" | "send" | "stop" | "attach" | "micStart" | "micStop" | "micUnsupported" | "expand" | "collapse" | "fullscreen" | "exitFullscreen" | "resizeHandle" | "scrollToBottom" | "popOut" | "close" | "moreActions" | "soundOn" | "soundOff" | "language" | "theme" | "themeAuto" | "themeLight" | "themeDark" | "textSize" | "textSizeSmall" | "textSizeNormal" | "textSizeLarge" | "history" | "historyTitle" | "historyEmpty" | "historyLoading" | "historyBack" | "historyContinue" | "conversationLoading" | "conversationClosed" | "startNewConversation" | "dateToday" | "dateYesterday" | "dateLastWeek" | "dateOlder" | "newConversation" | "dropZone" | "attachmentTooLarge" | "attachmentTooMany" | "attachmentMimeRejected" | "errorRetry" | "errorGeneric" | "errorRateLimited" | "loading" | "thinking" | "thoughts" | "usedTool" | "collapseSidebar" | "expandSidebar" | "formSubmit" | "formSkip" | "formSubmitted" | "formSkipped" | "formFillOut" | "formRequired" | "formInvalidEmail" | "formInvalidTel" | "formInvalidUrl" | "formInvalidNumber" | "formTooShort" | "formTooLong" | "formNumberTooSmall" | "formNumberTooLarge" | "formPatternMismatch" | "formChooseAtLeast" | "formChooseAtMost" | "formOther" | "formOtherPlaceholder" | "inputRequired" | "inputSubmit" | "inputSkip" | "inputSubmitted" | "approvalRequired" | "approve" | "reject" | "approved" | "rejected" | "approvalReason" | "stepNoLongerActive" | "tabHome" | "tabConversations" | "tabHelp" | "tabNews" | "modulesEmpty" | "moduleBack" | "contentLoading" | "homeGreeting" | "homeGreetingNamed" | "homeGreetingLead" | "homeSearchPlaceholder" | "homeContentTitle" | "homeStatus" | "helpTitle" | "helpSearchPlaceholder" | "helpEmpty" | "helpLoading" | "helpSearchEmpty" | "newsTitle" | "newsEmpty" | "newsLoading" | "newsBack" | "newsPublishedAt";
+type StringKey = "launcherOpen" | "launcherLabel" | "panelTitle" | "composerPlaceholder" | "send" | "stop" | "attach" | "micStart" | "micStop" | "micUnsupported" | "expand" | "collapse" | "fullscreen" | "exitFullscreen" | "resizeHandle" | "scrollToBottom" | "close" | "moreActions" | "soundOn" | "soundOff" | "language" | "theme" | "themeAuto" | "themeLight" | "themeDark" | "textSize" | "textSizeSmall" | "textSizeNormal" | "textSizeLarge" | "history" | "historyTitle" | "historyEmpty" | "historyLoading" | "historyBack" | "historyContinue" | "conversationLoading" | "conversationClosed" | "startNewConversation" | "dateToday" | "dateYesterday" | "dateLastWeek" | "dateOlder" | "newConversation" | "dropZone" | "attachmentTooLarge" | "attachmentTooMany" | "attachmentMimeRejected" | "errorRetry" | "errorGeneric" | "errorRateLimited" | "loading" | "thinking" | "thoughts" | "usedTool" | "collapseSidebar" | "expandSidebar" | "formSubmit" | "formSkip" | "formSubmitted" | "formSkipped" | "formFillOut" | "formRequired" | "formInvalidEmail" | "formInvalidTel" | "formInvalidUrl" | "formInvalidNumber" | "formTooShort" | "formTooLong" | "formNumberTooSmall" | "formNumberTooLarge" | "formPatternMismatch" | "formChooseAtLeast" | "formChooseAtMost" | "formOther" | "formOtherPlaceholder" | "inputRequired" | "inputSubmit" | "inputSkip" | "inputSubmitted" | "approvalRequired" | "approve" | "reject" | "approved" | "rejected" | "approvalReason" | "stepNoLongerActive" | "tabHome" | "tabConversations" | "tabHelp" | "tabNews" | "modulesEmpty" | "moduleBack" | "contentLoading" | "homeGreeting" | "homeGreetingNamed" | "homeGreetingLead" | "homeSearchPlaceholder" | "homeContentTitle" | "homeStatus" | "helpTitle" | "helpSearchPlaceholder" | "helpEmpty" | "helpLoading" | "helpSearchEmpty" | "newsTitle" | "newsEmpty" | "newsLoading" | "newsBack" | "newsPublishedAt";
 /** A partial map for one locale — what overrides look like on the wire. */
 type LocaleStrings = Partial<Record<StringKey, string>>;
 /**
@@ -89,6 +89,11 @@ type StringsOverride = LocaleStrings | Partial<Record<string, LocaleStrings>>;
  * `visitorId` is the deliberate exception: it stays global so the same browser
  * is one anonymous visitor everywhere (`${brand.cssPrefix}.visitorId`).
  *
+ * A `storageVersion` (when set) folds a `.v<version>` segment into EVERY key —
+ * including the global `visitorId` — so bumping it force-resets the entire
+ * client-side namespace for all users (a full fresh start: new visitor id,
+ * conversation, prefs, panel state). Unset → the unversioned keys.
+ *
  * Storage is pluggable via {@link ClientStorage} — pass a custom adapter
  * to add encryption, logging, or use a non-localStorage backend.
  */
@@ -265,14 +270,13 @@ type ResponseMode = "streaming" | "buffered";
  * - `clear`       — Start a new conversation (compose icon).
  * - `expand`      — Toggle `normal` ↔ `expanded` (1.5× panel).
  * - `fullscreen`  — Toggle `normal` ↔ `fullscreen` (viewport fill).
- * - `popOut`      — Open the conversation in a new browser tab.
  * - `sound`       — Toggle notification sounds + haptics on/off (switch-style).
  * - `language`    — Switch the UI locale at runtime.
  * - `theme`       — Cycle `auto` / `light` / `dark`.
  * - `textSize`    — Cycle `normal` / `large` / `small`.
  * - `close`       — Close the floating panel.
  */
-type ActionName = "clear" | "expand" | "fullscreen" | "popOut" | "sound" | "history" | "language" | "theme" | "textSize" | "close";
+type ActionName = "clear" | "expand" | "fullscreen" | "sound" | "history" | "language" | "theme" | "textSize" | "close";
 /**
  * The header's enabled actions. Unlisted actions are hidden; order is
  * irrelevant. Per-mode defaults (`DEFAULT_ACTIONS_BY_MODE`) pick a sensible
@@ -837,12 +841,6 @@ interface BehaviorOptions {
     showReasoning?: boolean;
     /** Show tool/function-call chips in the transcript. Default `false`. */
     showToolCalls?: boolean;
-    /**
-     * Override the URL the `popOut` action opens (carries
-     * `?conversation=<id>&widgetId=<id>`). Falls back to the brand's
-     * `BRAND.standaloneUrl` baked at build time. Server-pushable.
-     */
-    popOutUrl?: string;
 }
 /**
  * Section: panel header actions — the enabled set (`history`/`close` buttons +
@@ -1155,12 +1153,6 @@ interface ResolvedOptions {
     showReasoning: boolean;
     /** Show tool-call chips in the transcript. Default `false`. */
     showToolCalls: boolean;
-    /**
-     * Resolved popOut target — `behavior.popOutUrl` if set, else
-     * `BRAND.standaloneUrl`, else `""` (the popOut action is hidden
-     * when the resolved URL is empty).
-     */
-    popOutUrl: string;
     features: Required<Omit<FeatureFlags, "tools">> & {
         tools?: Array<string | ToolRef>;
     };
@@ -1248,6 +1240,14 @@ interface ResolvedOptions {
 interface ServerConfig {
     /** Data-API base override — adopted only when the host didn't set one. */
     dataApiBaseUrl?: string;
+    /**
+     * Storage-schema version — the deployment-owned force-reset lever, pushed ONLY
+     * via the handshake (deliberately not an embed attribute / `init` option).
+     * Pushing a new value abandons every client's prior storage namespace
+     * (visitor id, conversation, prefs, panel state, caches) on next load. The
+     * widget stashes it and the next mount folds `.v<version>` into every key.
+     */
+    storageVersion?: string;
     presentation?: PresentationOptions;
     behavior?: BehaviorOptions;
     theme?: ThemePreference | ThemeOverrides;
@@ -1325,8 +1325,6 @@ interface EventMap {
     expand: boolean;
     /** Fullscreen mode toggled. Payload is the new state. */
     fullscreen: boolean;
-    /** Widget was popped out into a standalone tab. */
-    popOut: void;
     /** End-user dragged the resize grip — payload is the resolved size. */
     resize: {
         width: number;
@@ -1578,14 +1576,6 @@ interface ChatWidgetInstance {
     destroy: () => void;
     /** Toggle fullscreen mode. In `standalone` mode this is a no-op. */
     expand: () => void;
-    /**
-     * Open the widget in a new browser tab at `behavior.popOutUrl`
-     * (mount option / handshake-pushable), or the brand's
-     * `BRAND.standaloneUrl` build-time default. Carries the active
-     * `chat` + `widgetId` as query params. No-ops when the resolved
-     * URL is empty.
-     */
-    popOut: () => void;
     /**
      * Surface a configured form by id (a form with a `manual` trigger). Lets the
      * host open, say, an appointment or feedback form from its own button. No-op
@@ -1595,7 +1585,7 @@ interface ChatWidgetInstance {
     /**
      * Subscribe to a lifecycle event. Returns an `off` function. See
      * {@link EventMap} for the full set + payload shapes — currently
-     * `open | close | message | error | expand | fullscreen | popOut |
+     * `open | close | message | error | expand | fullscreen |
      * handshake | localeChange`.
      */
     on: <E extends EventName>(name: E, fn: (payload: EventMap[E]) => void) => () => void;
@@ -1729,7 +1719,6 @@ declare const brand: {
     readonly tagName: string;
     readonly cssPrefix: string;
     readonly defaultBaseUrl: string;
-    readonly standaloneUrl: string;
     readonly displayName: string;
     readonly domain: string;
     readonly siteUrl: string;