@helpai/elements 0.73.0 → 1.1.0

package/index.d.ts

@@ -41,7 +41,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" | "talkToOperator" | "connectingOperator" | "noOperatorAvailable" | "chattingWithOperator" | "cancelOperatorRequest" | "dateToday" | "dateYesterday" | "dateLastWeek" | "dateOlder" | "newConversation" | "dropZone" | "attachmentTooLarge" | "attachmentTooMany" | "attachmentMimeRejected" | "errorRetry" | "errorGeneric" | "errorRateLimited" | "loading" | "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" | "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" | "loadMoreConversations" | "conversationLoading" | "loadPreviousMessages" | "conversationClosed" | "startNewConversation" | "talkToOperator" | "connectingOperator" | "noOperatorAvailable" | "chattingWithOperator" | "cancelOperatorRequest" | "dateToday" | "dateYesterday" | "dateLastWeek" | "dateOlder" | "newConversation" | "dropZone" | "attachmentTooLarge" | "attachmentTooMany" | "attachmentMimeRejected" | "errorRetry" | "errorGeneric" | "errorRateLimited" | "loading" | "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" | "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>>;
 /**
@@ -849,9 +849,11 @@ interface Endpoints {
  * use the widget: events, pages, devices, locales, funnels.
  *
  * Privacy contract (enforced in `src/core/tracking.ts`):
- *   - never sends message text, form values, or any user content —
+ *   - never sends message text or form values —
  *     event payloads pass through a static per-event allowlist;
- *   - the only identifier is the widget's existing anonymous `visitorId`;
+ *   - the only visitor identifier is the widget's existing anonymous
+ *     `visitorId`; deployment and anonymous conversation ids provide context;
+ *   - page metadata is origin + pathname, with query/hash removed;
  *   - geo + browser are derived server-side (IP + User-Agent header),
  *     never collected client-side;
  *   - `navigator.globalPrivacyControl` / Do-Not-Track force it off
@@ -871,8 +873,9 @@ interface TrackingOptions {
    */
   endpoint?: string;
   /**
-   * Per-visitor sampling 0..1. `0.25` tracks ~a quarter of visitors
-   * (decided once per page load, so funnels stay intact). Default `1`.
+   * Per-widget-runtime sampling 0..1. `0.25` samples roughly a quarter of
+   * mounted runtimes; one decision is reused for that runtime's funnel.
+   * Default `1`.
    */
   sampleRate?: number;
   /**
@@ -1793,9 +1796,9 @@ declare const widgetSettingsSchema: z.ZodObject<{
       type: z.ZodEnum<{
         number: "number";
         url: "url";
+        email: "email";
         date: "date";
         text: "text";
-        email: "email";
         tel: "tel";
         time: "time";
         textarea: "textarea";
@@ -1858,8 +1861,8 @@ declare const widgetSettingsSchema: z.ZodObject<{
   modules: z.ZodOptional<z.ZodArray<z.ZodObject<{
     label: z.ZodString;
     layout: z.ZodEnum<{
-      chat: "chat";
       home: "home";
+      chat: "chat";
       help: "help";
       news: "news";
     }>;
@@ -2128,9 +2131,9 @@ declare const widgetConfigSchema: z.ZodObject<{
       type: z.ZodEnum<{
         number: "number";
         url: "url";
+        email: "email";
         date: "date";
         text: "text";
-        email: "email";
         tel: "tel";
         time: "time";
         textarea: "textarea";
@@ -2193,8 +2196,8 @@ declare const widgetConfigSchema: z.ZodObject<{
   modules: z.ZodOptional<z.ZodArray<z.ZodObject<{
     label: z.ZodString;
     layout: z.ZodEnum<{
-      chat: "chat";
       home: "home";
+      chat: "chat";
       help: "help";
       news: "news";
     }>;
@@ -2462,9 +2465,9 @@ declare const widgetConfigPartialSchema: z.ZodObject<{
       type: z.ZodEnum<{
         number: "number";
         url: "url";
+        email: "email";
         date: "date";
         text: "text";
-        email: "email";
         tel: "tel";
         time: "time";
         textarea: "textarea";
@@ -2527,8 +2530,8 @@ declare const widgetConfigPartialSchema: z.ZodObject<{
   modules: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
     label: z.ZodString;
     layout: z.ZodEnum<{
-      chat: "chat";
       home: "home";
+      chat: "chat";
       help: "help";
       news: "news";
     }>;
@@ -2756,9 +2759,9 @@ declare const widgetSettingsPartialSchema: z.ZodObject<{
       type: z.ZodEnum<{
         number: "number";
         url: "url";
+        email: "email";
         date: "date";
         text: "text";
-        email: "email";
         tel: "tel";
         time: "time";
         textarea: "textarea";
@@ -2821,8 +2824,8 @@ declare const widgetSettingsPartialSchema: z.ZodObject<{
   modules: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
     label: z.ZodString;
     layout: z.ZodEnum<{
-      chat: "chat";
       home: "home";
+      chat: "chat";
       help: "help";
       news: "news";
     }>;
@@ -3096,8 +3099,8 @@ declare const serverConfigSchema: z.ZodObject<{
   modules: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
     label: z.ZodString;
     layout: z.ZodEnum<{
-      chat: "chat";
       home: "home";
+      chat: "chat";
       help: "help";
       news: "news";
     }>;
@@ -3382,8 +3385,8 @@ declare const handshakeResponseSchema: z.ZodObject<{
     modules: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
       label: z.ZodString;
       layout: z.ZodEnum<{
-        chat: "chat";
         home: "home";
+        chat: "chat";
         help: "help";
         news: "news";
       }>;