@helpai/elements 1.12.2 → 1.12.3

package/llms.txt

@@ -1,11 +1,11 @@
 # Help AI Elements
 
-> Help AI's AI chat widget for any website: an AI agent that answers visitors from the customer's own help content, can hand the chat to a person, and shows Help articles and News. Install it with one script tag, the `<web-ai-chat>` element, the npm API or the React kit. These docs match @helpai/elements@1.12.2.
+> Help AI's AI chat widget for any website: an AI agent that answers visitors from the customer's own help content, can hand the chat to a person, and shows Help articles and News. Install it with one script tag, the `<web-ai-chat>` element, the npm API or the React kit. These docs match @helpai/elements@1.12.3.
 
 What a coding agent needs to install it right the first time:
 
 - Two values come from the deployment's Install page in the Help AI dashboard: the public key (`agent_pk_…`) and the AI agent deployment id (a UUID). Both belong in browser code. The deployment's secret key never does.
-- Plain HTML, WordPress or any CMS: `<script src="https://cdn.help.ai/sdk/js/elements/1.12.2/elements.js" data-public-key="agent_pk_…" data-ai-agent-deployment-id="…" defer></script>`.
+- Plain HTML, WordPress or any CMS: `<script src="https://cdn.help.ai/sdk/js/elements/1.12.3/elements.js" data-public-key="agent_pk_…" data-ai-agent-deployment-id="…" defer></script>`.
 - React, Next.js, Remix: install `@helpai/elements` and render `<HelpAI publicKey="…" aiAgentDeploymentId="…" />` from `@helpai/elements/react` once, in the root layout. `useHelpAI()` in any component returns `{ state, ask, open, close, reset }`. It is server-render safe; import everything from `@helpai/elements/react`.
 - Vue, Svelte, Angular and other bundlers: `import '@helpai/elements/web-component'`, then `<web-ai-chat public-key="…" ai-agent-deployment-id="…"></web-ai-chat>`. JSX typings: `@helpai/elements/jsx/react`, `/jsx/vue`, `/jsx/svelte`.
 - Site buttons need no JavaScript: `data-helpai-ask="Which plan fits a team of 10?"` puts the question in the chat, `data-helpai-open="help"` opens a tab (`home`, `chats`, `help`, `news`). In code, `ask(text)` fills the composer and sends only with `{ send: true }`.
@@ -18,23 +18,23 @@ What a coding agent needs to install it right the first time:
 
 ## Docs
 
-- [Quickstart](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/quickstart.md): credentials, the install paths and a first check, in five minutes
-- [Installation](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/installation.md): every install path in depth: script tag, async loader, npm, web component, CDN URLs and version pinning
-- [Frameworks](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/frameworks.md): the React kit (`<HelpAI />`, `useHelpAI()`), Next.js, Remix, Vue, Nuxt, Svelte, Astro, Angular, WordPress, Shopify, Webflow
-- [Configuration](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/configuration.md): every option by group, with examples
-- [Option reference](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/options.md): the table of every option, generated from the schemas; authoritative
-- [API reference](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/api-reference.md): exports, instance methods (`ask`, `open`, `state`, `ready`, `reset`, …), the global API, no-script triggers, deep links, JSX typings
-- [Events and hooks](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/events-and-hooks.md): every event and its payload, `on()` and `hook()`
-- [Page tools](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/page-tools.md): WebMCP-shaped tools the AI agent calls on your page (`registerTool`, `tools`, `useHelpAITool`, `<form toolname>`), run once in the browser
-- [Theming](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
-- [Recipes](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/recipes.md): copy-paste solutions for common integrations
-- [Analytics](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/analytics.md): sending widget activity to Google Analytics, Segment, PostHog and other trackers
-- [Security and privacy](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
-- [Browser support](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/browser-support.md): supported browsers and fallbacks
-- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/troubleshooting.md): an install that does not show, connect or answer
-- [FAQ](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/faq.md): short answers to common questions
-- [Overview](https://cdn.help.ai/sdk/js/elements/1.12.2/docs/README.md): the whole SDK on one page
+- [Quickstart](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/quickstart.md): credentials, the install paths and a first check, in five minutes
+- [Installation](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/installation.md): every install path in depth: script tag, async loader, npm, web component, CDN URLs and version pinning
+- [Frameworks](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/frameworks.md): the React kit (`<HelpAI />`, `useHelpAI()`), Next.js, Remix, Vue, Nuxt, Svelte, Astro, Angular, WordPress, Shopify, Webflow
+- [Configuration](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/configuration.md): every option by group, with examples
+- [Option reference](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/options.md): the table of every option, generated from the schemas; authoritative
+- [API reference](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/api-reference.md): exports, instance methods (`ask`, `open`, `state`, `ready`, `reset`, …), the global API, no-script triggers, deep links, JSX typings
+- [Events and hooks](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/events-and-hooks.md): every event and its payload, `on()` and `hook()`
+- [Page tools](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/page-tools.md): WebMCP-shaped tools the AI agent calls on your page (`registerTool`, `tools`, `useHelpAITool`, `<form toolname>`), run once in the browser
+- [Theming](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
+- [Recipes](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/recipes.md): copy-paste solutions for common integrations
+- [Analytics](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/analytics.md): sending widget activity to Google Analytics, Segment, PostHog and other trackers
+- [Security and privacy](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
+- [Browser support](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/browser-support.md): supported browsers and fallbacks
+- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/troubleshooting.md): an install that does not show, connect or answer
+- [FAQ](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/faq.md): short answers to common questions
+- [Overview](https://cdn.help.ai/sdk/js/elements/1.12.3/docs/README.md): the whole SDK on one page
 
 ## Optional
 
-- [Every doc in one file](https://cdn.help.ai/sdk/js/elements/1.12.2/llms-full.txt): the docs above, concatenated
+- [Every doc in one file](https://cdn.help.ai/sdk/js/elements/1.12.3/llms-full.txt): the docs above, concatenated

package/package.json

@@ -117,5 +117,5 @@
   ],
   "type": "module",
   "types": "./index.d.ts",
-  "version": "1.12.2"
+  "version": "1.12.3"
 }

package/react.d.ts

@@ -712,6 +712,14 @@ interface BehaviorOptions {
 interface HeaderOptions {
   actions?: ActionList;
 }
+/**
+ * Section: Keep conversations — the deployment's history switch, pushed on the
+ * handshake as `config.history`.
+ */
+interface HistoryOptions {
+  /** `false` hides the history button and never lists past conversations. Default `true`. */
+  enabled?: boolean;
+}
 /**
  * Section: locale resolution + per-instance string overrides.
  *
@@ -1001,6 +1009,8 @@ interface ChatWidgetOptions {
   modules?: ModulesOptions;
   /** Anonymous owner-facing usage tracking (pixel hits). Server-pushable. */
   tracking?: TrackingOptions;
+  /** Keep conversations. Server-pushed from the deployment's setting. */
+  history?: HistoryOptions;
   /**
    * Custom client-side storage adapter. Implements the {@link ClientStorage}
    * interface (`get` / `set` / `remove` / `clear`).
@@ -1128,6 +1138,8 @@ interface ResolvedOptions {
   modules: ResolvedModules;
   /** Resolved anonymous usage tracking. */
   tracking: ResolvedTracking;
+  /** Keep conversations. Off: no history button and no conversation list requests. */
+  history: Required<HistoryOptions>;
   /** Resolved storage adapter — defaults to `LocalStorageAdapter`. */
   storage: ClientStorage;
   userToken?: UserTokenSource;
@@ -2554,6 +2566,8 @@ type ConnectionConfigPartial = z.infer<typeof connectionConfigPartialSchema>;
  *     embed attribute / `init` option). Bumping it folds a `.v<version>` segment
  *     into every client-storage key on the next load, abandoning the prior
  *     namespace for all visitors.
+ *   - `history` is pushable — the deployment's Keep conversations setting, which the
+ *     dashboard edits outside the widget settings.
  */
 declare const serverConfigSchema: z.ZodObject<{
   presentation: z.ZodOptional<z.ZodOptional<z.ZodObject<{
@@ -2781,6 +2795,9 @@ declare const serverConfigSchema: z.ZodObject<{
   }, z.core.$loose>>>;
   dataApiBaseUrl: z.ZodOptional<z.ZodString>;
   storageVersion: z.ZodOptional<z.ZodString>;
+  history: z.ZodOptional<z.ZodObject<{
+    enabled: z.ZodOptional<z.ZodBoolean>;
+  }, z.core.$loose>>;
 }, z.core.$loose>;
 type ServerConfig = z.infer<typeof serverConfigSchema>;
 /**
@@ -3076,6 +3093,9 @@ declare const handshakeResponseSchema: z.ZodObject<{
     }, z.core.$loose>>>;
     dataApiBaseUrl: z.ZodOptional<z.ZodString>;
     storageVersion: z.ZodOptional<z.ZodString>;
+    history: z.ZodOptional<z.ZodObject<{
+      enabled: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>>;
   }, z.core.$loose>>;
   site: z.ZodOptional<z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;