@helpai/elements 0.54.3 → 0.56.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-C0db2AMV.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-CWYT4rBr.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" | "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" | "toolResult" | "sources" | "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" | "confirmYes" | "confirmNo" | "approvalRequired" | "approve" | "reject" | "approved" | "rejected" | "approvalReason" | "approvalPrompt" | "approvalBody" | "approvalYourResponse" | "approvalEditHint" | "approvalSubmitting" | "edit" | "toolParameters" | "statusAwaiting" | "statusResponded" | "statusCompleted" | "statusDenied" | "statusError" | "statusRunning" | "statusSuperseded" | "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" | "toolResult" | "sources" | "feedbackUp" | "feedbackDown" | "feedbackThanks" | "copy" | "copied" | "newMessages" | "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" | "confirmYes" | "confirmNo" | "approvalRequired" | "approve" | "reject" | "approved" | "rejected" | "approvalReason" | "approvalPrompt" | "approvalBody" | "approvalYourResponse" | "approvalEditHint" | "approvalSubmitting" | "edit" | "toolParameters" | "statusAwaiting" | "statusResponded" | "statusCompleted" | "statusDenied" | "statusError" | "statusRunning" | "statusSuperseded" | "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>>;
 /**
@@ -124,6 +124,9 @@ interface UserPrefs {
     textSize?: "small" | "normal" | "large";
 }
 
+/** A 👍/👎 reaction on an assistant message; `null` clears a prior choice. */
+type FeedbackValue = "up" | "down" | null;
+
 /** A tool reference on the wire: `{ code, config }`. `config` is opaque. */
 interface ToolRef {
     code: string;
@@ -260,6 +263,16 @@ type ThemePreference = "auto" | "light" | "dark";
  *   whole.
  */
 type ResponseMode = "streaming" | "buffered";
+/**
+ * How the message list anchors as a new turn arrives.
+ *
+ * - `'bottom'` (default) — classic chat: stick to the newest content at the
+ *   bottom, following the streamed reply while the reader is near the edge.
+ * - `'turn'` — ChatGPT-style: pin the visitor's new question to the TOP of the
+ *   viewport so the answer streams into the empty space below it. The view
+ *   doesn't chase the bottom; the reader stays anchored to where they asked.
+ */
+type ScrollAnchor = "bottom" | "turn";
 /**
  * Identifiers for every header action the widget can render.
  *
@@ -830,7 +843,8 @@ interface PresentationOptions {
  */
 
 /**
- * Section: non-visual runtime behaviour — auto-open, streaming mode.
+ * Section: conversation runtime behaviour — auto-open, streaming mode, and the
+ * transcript surface (what renders, how it scrolls, reaction controls).
  */
 interface BehaviorOptions {
     /** When `true`, don't auto-open the panel on first visit. */
@@ -843,6 +857,12 @@ interface BehaviorOptions {
     showToolCalls?: boolean;
     /** Show citation sources (web links + document references) in the transcript. Default `false`. */
     showSources?: boolean;
+    /** Fade the message list at its scroll edges (gradient mask). Default `true`. */
+    scrollFade?: boolean;
+    /** How the list anchors a new turn: stick to bottom, or pin the question to top. Default `'bottom'`. */
+    scrollAnchor?: ScrollAnchor;
+    /** Show 👍/👎 feedback controls on assistant replies. Default `true`. */
+    enableMessageFeedback?: boolean;
 }
 /**
  * Section: panel header actions — the enabled set (`history`/`close` buttons +
@@ -1157,6 +1177,12 @@ interface ResolvedOptions {
     showToolCalls: boolean;
     /** Show citation sources (web links + document references) in the transcript. Default `false`. */
     showSources: boolean;
+    /** Fade the message list at its scroll edges (gradient mask). Default `true`. */
+    scrollFade: boolean;
+    /** How the list anchors a new turn: stick to bottom, or pin the question to top. Default `'bottom'`. */
+    scrollAnchor: ScrollAnchor;
+    /** Show 👍/👎 feedback controls on assistant replies. Default `true`. */
+    enableMessageFeedback: boolean;
     features: Required<Omit<FeatureFlags, "tools">> & {
         tools?: Array<string | ToolRef>;
     };
@@ -1374,6 +1400,23 @@ interface EventMap {
         toolCallId: string;
         approved: boolean;
     };
+    /**
+     * User gave feedback on an assistant reply. `value` is `"up"` / `"down"`, or
+     * `null` when they cleared a prior choice. `messageId` is the backend message
+     * id. Also POSTed best-effort to `/pai/message-feedback`; a host listener can
+     * mirror it to analytics.
+     */
+    messageFeedback: {
+        messageId: string;
+        value: FeedbackValue;
+    };
+    /**
+     * An assistant message scrolled into view for the first time (read tracking).
+     * Fires once per message id. Anonymous — id only, never the text.
+     */
+    messageSeen: {
+        messageId: string;
+    };
     /** A content list (news / help / home block) rendered. */
     contentView: {
         section: string;