@helpai/elements 1.9.0 → 1.11.0

package/index.d.ts

@@ -38,7 +38,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' | 'queueMessage' | 'removeQueuedMessage' | 'compactingContext' | 'attach' | 'micStart' | 'micStop' | 'micUnsupported' | 'expand' | 'collapse' | 'fullscreen' | 'exitFullscreen' | 'popOut' | 'resizeHandle' | 'scrollToBottom' | 'close' | 'moreActions' | 'soundOn' | 'soundOff' | 'language' | 'theme' | 'themeAuto' | 'themeLight' | 'themeDark' | 'textSize' | 'textSizeSmall' | 'textSizeNormal' | 'textSizeLarge' | 'history' | 'historyTitle' | 'historyEmpty' | 'historyLoading' | 'historyBack' | 'historyContinue' | 'loadMoreConversations' | 'conversationLoading' | 'loadPreviousMessages' | 'conversationClosed' | 'startNewConversation' | 'talkToOperator' | 'connectingOperator' | 'noOperatorAvailable' | 'chattingWithOperator' | 'cancelOperatorRequest' | 'dateToday' | 'dateYesterday' | 'dateLastWeek' | 'dateOlder' | 'newConversation' | 'dropZone' | 'attachmentTooLarge' | 'attachmentTooMany' | 'attachmentMimeRejected' | 'errorRetry' | 'errorGeneric' | 'errorRateLimited' | 'loading' | 'visualPreparing' | 'visualError' | 'visualPartial' | 'thinking' | 'thoughts' | 'toolResult' | 'sources' | 'feedbackUp' | 'feedbackDown' | 'feedbackThanks' | 'copy' | 'copied' | 'collapseSidebar' | 'expandSidebar' | 'formSubmit' | 'formSkip' | 'formSubmitted' | 'formSkipped' | 'formFillOut' | 'formRequired' | 'formInvalidEmail' | 'formInvalidTel' | 'formInvalidUrl' | 'formInvalidNumber' | 'formTooShort' | 'formTooLong' | 'formNumberTooSmall' | 'formNumberTooLarge' | 'formPatternMismatch' | 'formChooseAtLeast' | 'formChooseAtMost' | 'formOther' | 'formOtherPlaceholder' | 'inputRequired' | 'inputBadge' | 'inputAnswered' | 'inputSkipped' | 'inputSubmit' | 'inputSubmitHint' | 'inputSkip' | 'showOptions' | 'hideOptions' | 'qtypeText' | 'qtypeEmail' | 'qtypePhone' | 'qtypeNumber' | 'qtypeDate' | 'qtypeChooseOne' | 'qtypeChooseAny' | 'qtypeBoolean' | 'confirmYes' | 'confirmNo' | 'approve' | 'reject' | 'approvalPrompt' | 'approvalBody' | 'approvalYourResponse' | 'approvalEditHint' | 'approvalSubmitting' | 'edit' | 'toolParameters' | 'statusAwaiting' | 'statusResponded' | 'statusCompleted' | 'statusDenied' | 'statusError' | 'statusRunning' | 'statusSuperseded' | 'tabHome' | 'tabConversations' | 'tabHelp' | 'tabNews' | 'modulesEmpty' | 'moduleBack' | 'contentLoading' | 'contentHelpful' | 'homeGreeting' | 'homeGreetingNamed' | 'homeGreetingLead' | 'homeSearchPlaceholder' | 'homeAskPlaceholder' | 'homeWhatsNew' | 'homeContentTitle' | 'homeStatus' | 'helpTitle' | 'helpSearchPlaceholder' | 'helpEmpty' | 'helpLoading' | 'helpSearchEmpty' | 'helpShowMore' | 'newsTitle' | 'newsEmpty' | 'newsLoading' | 'newsBack' | 'newsPublishedAt' | 'newsShowMore' | 'newsUnseen';
+type StringKey = 'launcherOpen' | 'launcherLabel' | 'panelTitle' | 'composerPlaceholder' | 'send' | 'stop' | 'queueMessage' | 'removeQueuedMessage' | 'compactingContext' | 'attach' | 'micStart' | 'micStop' | 'micUnsupported' | 'expand' | 'collapse' | 'fullscreen' | 'exitFullscreen' | 'popOut' | 'resizeHandle' | 'scrollToBottom' | 'close' | 'moreActions' | 'soundOn' | 'soundOff' | 'language' | 'theme' | 'themeAuto' | 'themeLight' | 'themeDark' | 'textSize' | 'textSizeSmall' | 'textSizeNormal' | 'textSizeLarge' | 'history' | 'historyTitle' | 'historyEmpty' | 'historyLoading' | 'historyBack' | 'historyContinue' | 'loadMoreConversations' | 'conversationLoading' | 'loadPreviousMessages' | 'conversationClosed' | 'startNewConversation' | 'talkToOperator' | 'connectingOperator' | 'noOperatorAvailable' | 'chattingWithOperator' | 'cancelOperatorRequest' | 'dateToday' | 'dateYesterday' | 'dateLastWeek' | 'dateOlder' | 'newConversation' | 'dropZone' | 'attachmentTooLarge' | 'attachmentTooMany' | 'attachmentMimeRejected' | 'errorRetry' | 'errorGeneric' | 'errorRateLimited' | 'loading' | 'visualPreparing' | 'visualError' | 'visualPartial' | 'thinking' | 'thoughts' | 'toolResult' | 'sources' | 'feedbackUp' | 'feedbackDown' | 'feedbackThanks' | 'copy' | 'copied' | 'collapseSidebar' | 'expandSidebar' | 'formSubmit' | 'formSkip' | 'formSubmitted' | 'formSkipped' | 'formFillOut' | 'formRequired' | 'formInvalidEmail' | 'formInvalidTel' | 'formInvalidUrl' | 'formInvalidNumber' | 'formTooShort' | 'formTooLong' | 'formNumberTooSmall' | 'formNumberTooLarge' | 'formPatternMismatch' | 'formChooseAtLeast' | 'formChooseAtMost' | 'formOther' | 'formOtherPlaceholder' | 'inputRequired' | 'inputBadge' | 'inputAnswered' | 'inputSkipped' | 'inputSubmit' | 'inputSubmitHint' | 'inputSkip' | 'showOptions' | 'hideOptions' | 'qtypeText' | 'qtypeEmail' | 'qtypePhone' | 'qtypeNumber' | 'qtypeDate' | 'qtypeChooseOne' | 'qtypeChooseAny' | 'qtypeBoolean' | 'confirmYes' | 'confirmNo' | 'approve' | 'reject' | 'approvalPrompt' | 'approvalBody' | 'approvalYourResponse' | 'approvalEditHint' | 'approvalSubmitting' | 'edit' | 'toolParameters' | 'statusAwaiting' | 'statusResponded' | 'statusCompleted' | 'statusDenied' | 'statusError' | 'statusRunning' | 'statusSuperseded' | 'statusIncomplete' | 'tabHome' | 'tabConversations' | 'tabHelp' | 'tabNews' | 'modulesEmpty' | 'moduleBack' | 'contentLoading' | 'contentHelpful' | 'homeGreeting' | 'homeGreetingNamed' | 'homeGreetingLead' | 'homeSearchPlaceholder' | 'homeAskPlaceholder' | 'homeWhatsNew' | 'homeContentTitle' | 'homeStatus' | 'helpTitle' | 'helpSearchPlaceholder' | 'helpEmpty' | 'helpLoading' | 'helpSearchEmpty' | 'helpShowMore' | 'newsTitle' | 'newsEmpty' | 'newsLoading' | 'newsBack' | 'newsPublishedAt' | 'newsShowMore' | 'newsUnseen';
 /** A partial map for one locale — what overrides look like on the wire. */
 type LocaleStrings = Partial<Record<StringKey, string>>;
 /**
@@ -898,6 +898,38 @@ 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>);
+/** WebMCP `ToolAnnotations`: hints about what a tool does. */
+interface ToolAnnotations {
+  /** It only reads; it changes nothing. */
+  readOnlyHint?: boolean;
+  /** Its result holds content the site doesn't vouch for, such as reviews. */
+  untrustedContentHint?: boolean;
+  /** A significant or irreversible action (booking, paying, deleting): the visitor approves each call first. */
+  consequentialHint?: boolean;
+  /** Built for developers, not visitors. */
+  debugging?: boolean;
+}
+/**
+ * A tool the AI agent can use on your page, in the WebMCP `ModelContextTool` shape: the same object works with
+ * `document.modelContext.registerTool()`. The agent sees `name`, `description` and `inputSchema`; `execute` runs here,
+ * in the visitor's browser, and what it returns goes back to the agent.
+ */
+interface ModelContextTool<TInput = unknown> {
+  /** Letters, digits, `_` and `-` (58 at most; others become `_`). A name registered again replaces the earlier tool. */
+  name: string;
+  title?: string;
+  /** When the agent should use it and what it does (1024 characters at most). */
+  description: string;
+  /** JSON Schema of the input (`type: "object"`); none means the tool takes no input. */
+  inputSchema?: Record<string, unknown>;
+  annotations?: ToolAnnotations;
+  /** Runs the tool: return a JSON value (or a promise of one) for the agent; throw to report a failure. `signal` aborts when the visitor moves on first. */
+  execute(input: TInput, options: {
+    signal: AbortSignal;
+  }): unknown;
+}
 interface ChatWidgetOptions {
   /**
    * Stable identifier for this widget instance. Use when mounting more
@@ -973,6 +1005,20 @@ 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;
+  /**
+   * Tools the AI agent can use on your page (open a booking form, read the cart, jump to a section), WebMCP
+   * `ModelContextTool`s. Sent with each message as definitions only; the agent's call runs `execute` here, in the
+   * visitor's browser. `registerTool()` adds one from anywhere, for example a single-page app's route.
+   */
+  tools?: readonly ModelContextTool[];
   onMessage?: (msg: {
     role: string;
     text: string;
@@ -1083,12 +1129,16 @@ interface ResolvedOptions {
   tracking: ResolvedTracking;
   /** Resolved storage adapter — defaults to `LocalStorageAdapter`. */
   storage: ClientStorage;
+  userToken?: UserTokenSource;
+  tools?: readonly ModelContextTool[];
   onMessage?: ChatWidgetOptions['onMessage'];
   onOpen?: ChatWidgetOptions['onOpen'];
   onClose?: ChatWidgetOptions['onClose'];
   onError?: ChatWidgetOptions['onError'];
 }
 type HostMode = 'page' | 'standalone' | 'inline' | 'modal' | 'drawer' | 'fullscreen' | 'expanded' | 'open' | 'closed';
+/** How a call this page ran (or found cut short) ended, for the `toolResult` event. */
+type PageToolCallStatus = 'completed' | 'failed' | 'interrupted';
 /** A single image asset (logo, hero, icon). */
 declare const assetSchema: z.ZodObject<{
   url: z.ZodString;
@@ -3134,15 +3184,27 @@ interface EventMap {
     values: Record<string, string>;
     skipped: boolean;
   };
-  /** User answered an ask-questions tool request (re-POST follows). */
+  /**
+   * A tool call settled on the page: the visitor answered an ask-questions request (`toolCallId` only), or a page
+   * tool's call ended — `completed`, `failed`, `declined` or `stopped` by the visitor, or `interrupted` by a reload —
+   * after `durationMs`. Never its input or result.
+   */
   toolResult: {
     toolCallId: string;
+    name?: string;
+    status?: PageToolCallStatus | 'declined' | 'stopped';
+    durationMs?: number;
   };
   /** User approved / rejected a gated tool call (re-POST follows). */
   toolDecision: {
     toolCallId: string;
     approved: boolean;
   };
+  /** Your page reported its own event with `track(name, data)`: sent to analytics, and to the agent with the next message. */
+  hostEvent: {
+    name: string;
+    data?: Record<string, string | number | boolean>;
+  };
   /**
    * User gave feedback on a rateable reply (AI or operator). `value` is `"up"` / `"down"`, or
    * `null` when they cleared a prior choice. `messageId` is the backend message
@@ -3289,6 +3351,8 @@ interface AskOptions {
   /** Send the text as the visitor's message instead of filling the composer with it. Default `false`. */
   send?: boolean;
 }
+/** Flat data about a host event: strings, numbers and booleans only. */
+type HostEventData = Record<string, string | number | boolean>;
 /**
  * Comprehensive logger for the widget runtime.
  *
@@ -3383,6 +3447,47 @@ 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;
+  /**
+   * Report something the visitor did on your site, outside the chat. Sends a `hostEvent` hit to analytics (not when
+   * tracking is off), and the agent reads your last 10 events with the visitor's next message. `name` is 1–64
+   * characters; `data` is flat (strings, numbers, booleans), 256 characters of JSON at most.
+   *
+   * @example
+   * ```ts
+   * chat.track('plan_viewed', { plan: 'pro' });
+   * ```
+   */
+  track: (name: string, data?: HostEventData) => void;
+  /**
+   * Add a tool the agent can use on this page, in the WebMCP tool shape — for every widget on the page, not only this
+   * one. The latest registration of a name wins; aborting `options.signal` removes it. `annotations.consequentialHint`
+   * asks the visitor before each call. See `docs/sdk/page-tools.md`.
+   *
+   * @example
+   * ```ts
+   * chat.registerTool({
+   *   name: 'open_booking',
+   *   description: 'Open the booking form for a meeting type.',
+   *   inputSchema: { type: 'object', properties: { meetingType: { type: 'string', enum: ['sales', 'support'] } }, required: ['meetingType'] },
+   *   execute: ({ meetingType }) => booking.open(meetingType),
+   * });
+   * ```
+   */
+  registerTool: (tool: ModelContextTool, options?: {
+    signal?: AbortSignal;
+  }) => void;
   /**
    * Subscribe to a lifecycle event. Returns an `off` function. See
    * {@link EventMap} for the full set + payload shapes — currently
@@ -3526,4 +3631,4 @@ export declare const brand: {
   readonly domain: string;
   readonly siteUrl: string;
 };
-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, HostEventData, Link, LogEntry, LogLevel, ModelContextTool, OpenTarget, ResolvedOptions, ServerConfig, SiteConfig, ToolAnnotations, UserTokenSource, WidgetConfig, WidgetConfigPartial, WidgetSettings, WidgetSettingsPartial, WidgetState };