@helpai/elements 1.9.0 → 1.10.0

package/llms.txt

@@ -1,36 +1,37 @@
 # 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.9.0.
+> 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.10.0.
 
 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.9.0/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.10.0/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 }`.
+- Logged-in users: your server signs a JWT with the deployment's secret key (HS256; `sub` = your user id, `exp`; optional `name`, `email`), and the widget gets a function that fetches it: `userToken` at init, `login(fn)` after sign-in, `reset()` at sign-out. Their chats then follow them to any device. Never sign tokens in the browser.
 - `theme: 'host'` (`theme="host"`) follows the site's own light/dark switch.
 - Pin the exact version in production, as above; `latest` changes under you.
 - It works when the launcher shows in the bottom corner and `HelpAI.ready()` (or `chat.ready`) resolves.
 
 ## Docs
 
-- [Quickstart](https://cdn.help.ai/sdk/js/elements/1.9.0/docs/quickstart.md): credentials, the install paths and a first check, in five minutes
-- [Installation](https://cdn.help.ai/sdk/js/elements/1.9.0/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.9.0/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.9.0/docs/configuration.md): every option by group, with examples
-- [Option reference](https://cdn.help.ai/sdk/js/elements/1.9.0/docs/options.md): the table of every option, generated from the schemas; authoritative
-- [API reference](https://cdn.help.ai/sdk/js/elements/1.9.0/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.9.0/docs/events-and-hooks.md): every event and its payload, `on()` and `hook()`
-- [Theming](https://cdn.help.ai/sdk/js/elements/1.9.0/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
-- [Recipes](https://cdn.help.ai/sdk/js/elements/1.9.0/docs/recipes.md): copy-paste solutions for common integrations
-- [Analytics](https://cdn.help.ai/sdk/js/elements/1.9.0/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.9.0/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
-- [Browser support](https://cdn.help.ai/sdk/js/elements/1.9.0/docs/browser-support.md): supported browsers and fallbacks
-- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/1.9.0/docs/troubleshooting.md): an install that does not show, connect or answer
-- [FAQ](https://cdn.help.ai/sdk/js/elements/1.9.0/docs/faq.md): short answers to common questions
-- [Overview](https://cdn.help.ai/sdk/js/elements/1.9.0/docs/README.md): the whole SDK on one page
+- [Quickstart](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/quickstart.md): credentials, the install paths and a first check, in five minutes
+- [Installation](https://cdn.help.ai/sdk/js/elements/1.10.0/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.10.0/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.10.0/docs/configuration.md): every option by group, with examples
+- [Option reference](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/options.md): the table of every option, generated from the schemas; authoritative
+- [API reference](https://cdn.help.ai/sdk/js/elements/1.10.0/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.10.0/docs/events-and-hooks.md): every event and its payload, `on()` and `hook()`
+- [Theming](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
+- [Recipes](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/recipes.md): copy-paste solutions for common integrations
+- [Analytics](https://cdn.help.ai/sdk/js/elements/1.10.0/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.10.0/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
+- [Browser support](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/browser-support.md): supported browsers and fallbacks
+- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/troubleshooting.md): an install that does not show, connect or answer
+- [FAQ](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/faq.md): short answers to common questions
+- [Overview](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/README.md): the whole SDK on one page
 
 ## Optional
 
-- [Every doc in one file](https://cdn.help.ai/sdk/js/elements/1.9.0/llms-full.txt): the docs above, concatenated
+- [Every doc in one file](https://cdn.help.ai/sdk/js/elements/1.10.0/llms-full.txt): the docs above, concatenated

package/package.json

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

package/react.d.ts

@@ -899,6 +899,8 @@ interface ResolvedTracking {
  * alongside at the top level — they're function / DOM types that can't be
  * serialised on the wire.
  */
+/** A signed user token, or a function that returns a fresh one (see {@link ChatWidgetOptions.userToken}). */
+type UserTokenSource = string | (() => string | Promise<string>);
 interface ChatWidgetOptions {
   /**
    * Stable identifier for this widget instance. Use when mounting more
@@ -974,6 +976,14 @@ interface ChatWidgetOptions {
    * interface (`get` / `set` / `remove` / `clear`).
    */
   storage?: ClientStorage;
+  /**
+   * Proves who the logged-in visitor is: a JWT your server signs (HS256) with the deployment's secret key, carrying
+   * `sub` (your user id) and `exp`, optionally `name` and `email`. A function is called when a token is first
+   * needed and again when the server rejects the current one as expired, so return a fresh token from it. Their
+   * conversations then follow them to any device; `chat.login(token)` sets it after sign-in, `chat.reset()` on
+   * sign-out. Sent only to the agent API, as `x-user-token`.
+   */
+  userToken?: UserTokenSource;
   onMessage?: (msg: {
     role: string;
     text: string;
@@ -1084,6 +1094,7 @@ interface ResolvedOptions {
   tracking: ResolvedTracking;
   /** Resolved storage adapter — defaults to `LocalStorageAdapter`. */
   storage: ClientStorage;
+  userToken?: UserTokenSource;
   onMessage?: ChatWidgetOptions['onMessage'];
   onOpen?: ChatWidgetOptions['onOpen'];
   onClose?: ChatWidgetOptions['onClose'];
@@ -3384,6 +3395,18 @@ export interface ChatWidgetInstance {
    * Listeners added with `on()` stay.
    */
   reset: () => void;
+  /**
+   * Sign the visitor in as your logged-in user, after they log in to your site: `userToken` is a JWT your server
+   * signs with the deployment's secret key (`sub`, `exp`; optional `name`, `email`), or a function that returns a
+   * fresh one. The widget reconnects as that user: their earlier chats on this browser move to them, and their
+   * conversations follow them to any device. Call `reset()` when they log out.
+   *
+   * @example
+   * ```ts
+   * chat.login(async () => (await fetch('/api/help-ai-token')).text());
+   * ```
+   */
+  login: (userToken: UserTokenSource) => void;
   /**
    * Subscribe to a lifecycle event. Returns an `off` function. See
    * {@link EventMap} for the full set + payload shapes — currently
@@ -3549,4 +3572,4 @@ export interface HelpAIControls {
  * the widget has mounted does nothing; `state.ready` turns true once it takes them.
  */
 export declare function useHelpAI(widgetId?: string): HelpAIControls;
-export type { AskOptions, Asset, BlocksConfig, ChatWidgetOptions, ConnectionConfig, ConnectionConfigPartial, EventMap, EventName, HandshakeResponse, HookListener, Link, LogEntry, LogLevel, OpenTarget, ResolvedOptions, ServerConfig, SiteConfig, WidgetConfig, WidgetConfigPartial, WidgetSettings, WidgetSettingsPartial, WidgetState };
+export type { AskOptions, Asset, BlocksConfig, ChatWidgetOptions, ConnectionConfig, ConnectionConfigPartial, EventMap, EventName, HandshakeResponse, HookListener, Link, LogEntry, LogLevel, OpenTarget, ResolvedOptions, ServerConfig, SiteConfig, UserTokenSource, WidgetConfig, WidgetConfigPartial, WidgetSettings, WidgetSettingsPartial, WidgetState };