@helpai/elements 0.21.1 → 0.23.0

package/schema.d.ts

@@ -1,4 +1,4 @@
-export { A as Asset, B as BlocksConfig, C as ConnectionConfig, a as ConnectionConfigPartial, E as Endpoints, L as Link, P as PAGE_AREA_SUGGESTIONS, g as PageContext, S as ServerConfig, b as SiteConfig, c as StartConversationResponse, U as UserContext, W as WidgetConfig, d as WidgetConfigPartial, e as WidgetSettings, f as WidgetSettingsPartial, h as assetSchema, i as blocksConfigSchema, j as connectionConfigPartialSchema, k as connectionConfigSchema, l as cssColorSchema, m as cssLengthSchema, n as endpointsSchema, o as linkSchema, p as localeSchema, q as pageContextSchema, s as serverConfigSchema, r as siteConfigSchema, t as startConversationResponseSchema, u as userContextSchema, v as uuid7Schema, w as widgetConfigPartialSchema, x as widgetConfigSchema, y as widgetSettingsPartialSchema, z as widgetSettingsSchema } from './deployment-B8UxV4b5.js';
+export { A as Asset, B as BlocksConfig, C as ConnectionConfig, a as ConnectionConfigPartial, E as Endpoints, L as Link, P as PAGE_AREA_SUGGESTIONS, g as PageContext, S as ServerConfig, b as SiteConfig, c as StartConversationResponse, U as UserContext, W as WidgetConfig, d as WidgetConfigPartial, e as WidgetSettings, f as WidgetSettingsPartial, h as assetSchema, i as blocksConfigSchema, j as connectionConfigPartialSchema, k as connectionConfigSchema, l as cssColorSchema, m as cssLengthSchema, n as endpointsSchema, o as linkSchema, p as localeSchema, q as pageContextSchema, s as serverConfigSchema, r as siteConfigSchema, t as startConversationResponseSchema, u as userContextSchema, v as uuid7Schema, w as widgetConfigPartialSchema, x as widgetConfigSchema, y as widgetSettingsPartialSchema, z as widgetSettingsSchema } from './deployment-D7_pjSGq.js';
 import { z } from 'zod';
 
 /**
@@ -56,9 +56,9 @@ declare const presentationSchema: z.ZodObject<{
         inset: z.ZodOptional<z.ZodString>;
         initialSize: z.ZodDefault<z.ZodEnum<{
             fullscreen: "fullscreen";
+            normal: "normal";
             expanded: "expanded";
             auto: "auto";
-            normal: "normal";
         }>>;
         autoSizeBreakpoint: z.ZodDefault<z.ZodNumber>;
     }, z.core.$loose>>;
@@ -148,9 +148,9 @@ declare const launcherSizeSchema: z.ZodEnum<{
 }>;
 type LauncherSize = z.infer<typeof launcherSizeSchema>;
 declare const calloutShapeSchema: z.ZodEnum<{
-    callout: "callout";
     pill: "pill";
     bubble: "bubble";
+    callout: "callout";
 }>;
 type CalloutShape = z.infer<typeof calloutShapeSchema>;
 declare const calloutPositionSchema: z.ZodEnum<{
@@ -162,9 +162,9 @@ type CalloutPosition = z.infer<typeof calloutPositionSchema>;
 declare const launcherCalloutSchema: z.ZodObject<{
     text: z.ZodDefault<z.ZodString>;
     shape: z.ZodDefault<z.ZodEnum<{
-        callout: "callout";
         pill: "pill";
         bubble: "bubble";
+        callout: "callout";
     }>>;
     position: z.ZodDefault<z.ZodEnum<{
         auto: "auto";
@@ -195,9 +195,9 @@ declare const launcherOptionsSchema: z.ZodObject<{
     callout: z.ZodOptional<z.ZodObject<{
         text: z.ZodDefault<z.ZodString>;
         shape: z.ZodDefault<z.ZodEnum<{
-            callout: "callout";
             pill: "pill";
             bubble: "bubble";
+            callout: "callout";
         }>>;
         position: z.ZodDefault<z.ZodEnum<{
             auto: "auto";
@@ -240,9 +240,9 @@ type LauncherOptions = z.infer<typeof launcherOptionsSchema>;
 
 declare const initialSizeSchema: z.ZodEnum<{
     fullscreen: "fullscreen";
+    normal: "normal";
     expanded: "expanded";
     auto: "auto";
-    normal: "normal";
 }>;
 declare const resizeOptionsSchema: z.ZodObject<{
     enabled: z.ZodDefault<z.ZodBoolean>;
@@ -269,9 +269,9 @@ declare const sizeOptionsSchema: z.ZodObject<{
     inset: z.ZodOptional<z.ZodString>;
     initialSize: z.ZodDefault<z.ZodEnum<{
         fullscreen: "fullscreen";
+        normal: "normal";
         expanded: "expanded";
         auto: "auto";
-        normal: "normal";
     }>>;
     autoSizeBreakpoint: z.ZodDefault<z.ZodNumber>;
 }, z.core.$loose>;
@@ -323,43 +323,43 @@ type FeatureFlags = z.infer<typeof featureFlagsSchema>;
  */
 
 declare const actionNameSchema: z.ZodEnum<{
-    close: "close";
     expand: "expand";
     fullscreen: "fullscreen";
     popOut: "popOut";
-    clear: "clear";
-    theme: "theme";
+    close: "close";
     language: "language";
+    theme: "theme";
     textSize: "textSize";
     history: "history";
+    clear: "clear";
     sound: "sound";
 }>;
 type ActionName = z.infer<typeof actionNameSchema>;
 declare const headerActionsSchema: z.ZodArray<z.ZodEnum<{
-    close: "close";
     expand: "expand";
     fullscreen: "fullscreen";
     popOut: "popOut";
-    clear: "clear";
-    theme: "theme";
+    close: "close";
     language: "language";
+    theme: "theme";
     textSize: "textSize";
     history: "history";
+    clear: "clear";
     sound: "sound";
 }>>;
 type HeaderActions = z.infer<typeof headerActionsSchema>;
 /** Section wrapper — `actions` list wrapped under `header` in the dashboard form. */
 declare const headerSchema: z.ZodObject<{
     actions: z.ZodOptional<z.ZodArray<z.ZodEnum<{
-        close: "close";
         expand: "expand";
         fullscreen: "fullscreen";
         popOut: "popOut";
-        clear: "clear";
-        theme: "theme";
+        close: "close";
         language: "language";
+        theme: "theme";
         textSize: "textSize";
         history: "history";
+        clear: "clear";
         sound: "sound";
     }>>>;
 }, z.core.$loose>;
@@ -375,33 +375,33 @@ type HeaderOptions = z.infer<typeof headerSchema>;
  */
 
 declare const feedbackEventSchema: z.ZodEnum<{
-    voiceStart: "voiceStart";
-    voiceStop: "voiceStop";
     error: "error";
     messageReceived: "messageReceived";
     messageSent: "messageSent";
+    voiceStart: "voiceStart";
+    voiceStop: "voiceStop";
 }>;
 type FeedbackEvent = z.infer<typeof feedbackEventSchema>;
 declare const soundOptionsSchema: z.ZodObject<{
     enabled: z.ZodDefault<z.ZodBoolean>;
     volume: z.ZodDefault<z.ZodNumber>;
     events: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
-        voiceStart: "voiceStart";
-        voiceStop: "voiceStop";
         error: "error";
         messageReceived: "messageReceived";
         messageSent: "messageSent";
+        voiceStart: "voiceStart";
+        voiceStop: "voiceStop";
     }> & z.core.$partial, z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>;
 }, z.core.$loose>;
 type SoundOptions = z.infer<typeof soundOptionsSchema>;
 declare const hapticsOptionsSchema: z.ZodObject<{
     enabled: z.ZodDefault<z.ZodBoolean>;
     events: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
-        voiceStart: "voiceStart";
-        voiceStop: "voiceStop";
         error: "error";
         messageReceived: "messageReceived";
         messageSent: "messageSent";
+        voiceStart: "voiceStart";
+        voiceStop: "voiceStop";
     }> & z.core.$partial, z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber, z.ZodArray<z.ZodNumber>]>>>;
 }, z.core.$loose>;
 type HapticsOptions = z.infer<typeof hapticsOptionsSchema>;
@@ -410,21 +410,21 @@ declare const feedbackSchema: z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
         volume: z.ZodDefault<z.ZodNumber>;
         events: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
-            voiceStart: "voiceStart";
-            voiceStop: "voiceStop";
             error: "error";
             messageReceived: "messageReceived";
             messageSent: "messageSent";
+            voiceStart: "voiceStart";
+            voiceStop: "voiceStop";
         }> & z.core.$partial, z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>;
     }, z.core.$loose>>;
     haptics: z.ZodOptional<z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
         events: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
-            voiceStart: "voiceStart";
-            voiceStop: "voiceStop";
             error: "error";
             messageReceived: "messageReceived";
             messageSent: "messageSent";
+            voiceStart: "voiceStart";
+            voiceStop: "voiceStop";
         }> & z.core.$partial, z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber, z.ZodArray<z.ZodNumber>]>>>;
     }, z.core.$loose>>;
 }, z.core.$loose>;
@@ -544,16 +544,16 @@ type FooterOptions = z.infer<typeof footerSchema>;
 
 declare const fieldTypeSchema: z.ZodEnum<{
     number: "number";
-    select: "select";
-    textarea: "textarea";
-    time: "time";
     text: "text";
-    checkbox: "checkbox";
-    radio: "radio";
     url: "url";
     email: "email";
     tel: "tel";
     date: "date";
+    time: "time";
+    textarea: "textarea";
+    select: "select";
+    radio: "radio";
+    checkbox: "checkbox";
     multiselect: "multiselect";
 }>;
 type FieldType = z.infer<typeof fieldTypeSchema>;
@@ -578,16 +578,16 @@ declare const formFieldSchema: z.ZodObject<{
     label: z.ZodString;
     type: z.ZodEnum<{
         number: "number";
-        select: "select";
-        textarea: "textarea";
-        time: "time";
         text: "text";
-        checkbox: "checkbox";
-        radio: "radio";
         url: "url";
         email: "email";
         tel: "tel";
         date: "date";
+        time: "time";
+        textarea: "textarea";
+        select: "select";
+        radio: "radio";
+        checkbox: "checkbox";
         multiselect: "multiselect";
     }>;
     placeholder: z.ZodOptional<z.ZodString>;
@@ -638,16 +638,16 @@ declare const formDefSchema: z.ZodObject<{
         label: z.ZodString;
         type: z.ZodEnum<{
             number: "number";
-            select: "select";
-            textarea: "textarea";
-            time: "time";
             text: "text";
-            checkbox: "checkbox";
-            radio: "radio";
             url: "url";
             email: "email";
             tel: "tel";
             date: "date";
+            time: "time";
+            textarea: "textarea";
+            select: "select";
+            radio: "radio";
+            checkbox: "checkbox";
             multiselect: "multiselect";
         }>;
         placeholder: z.ZodOptional<z.ZodString>;
@@ -696,16 +696,16 @@ declare const formsSchema: z.ZodArray<z.ZodObject<{
         label: z.ZodString;
         type: z.ZodEnum<{
             number: "number";
-            select: "select";
-            textarea: "textarea";
-            time: "time";
             text: "text";
-            checkbox: "checkbox";
-            radio: "radio";
             url: "url";
             email: "email";
             tel: "tel";
             date: "date";
+            time: "time";
+            textarea: "textarea";
+            select: "select";
+            radio: "radio";
+            checkbox: "checkbox";
             multiselect: "multiselect";
         }>;
         placeholder: z.ZodOptional<z.ZodString>;
@@ -777,18 +777,18 @@ type I18nOptions = z.infer<typeof i18nSchema>;
  */
 
 declare const moduleLayoutSchema: z.ZodEnum<{
-    home: "home";
     chat: "chat";
     help: "help";
+    home: "home";
     news: "news";
 }>;
 type ModuleLayout = z.infer<typeof moduleLayoutSchema>;
 declare const moduleSchema: z.ZodObject<{
     label: z.ZodString;
     layout: z.ZodEnum<{
-        home: "home";
         chat: "chat";
         help: "help";
+        home: "home";
         news: "news";
     }>;
     contentTags: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -814,9 +814,9 @@ type ModuleOptions = z.infer<typeof moduleSchema>;
 declare const modulesSchema: z.ZodArray<z.ZodObject<{
     label: z.ZodString;
     layout: z.ZodEnum<{
-        home: "home";
         chat: "chat";
         help: "help";
+        home: "home";
         news: "news";
     }>;
     contentTags: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -840,6 +840,23 @@ declare const modulesSchema: z.ZodArray<z.ZodObject<{
 }, z.core.$loose>>;
 type ModulesOptions = z.infer<typeof modulesSchema>;
 
+/**
+ * Tracking section schema — built-in anonymous usage analytics for the
+ * widget owner (utm.gif-style pixel hits). Off by default; a deployment
+ * turns it on to get event / page / device / locale insights without
+ * wiring its own analytics. No message content or form values ever ride
+ * a hit — payload fields pass a static per-event allowlist in the
+ * runtime tracker.
+ */
+
+declare const trackingSchema: z.ZodObject<{
+    enabled: z.ZodOptional<z.ZodBoolean>;
+    endpoint: z.ZodOptional<z.ZodURL>;
+    sampleRate: z.ZodOptional<z.ZodNumber>;
+    token: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+type TrackingSettings = z.infer<typeof trackingSchema>;
+
 /**
  * Per-mode widget-settings projection.
  *
@@ -881,4 +898,4 @@ declare const ALL_MODES: readonly Mode[];
  */
 declare function emitJsonSchema(): unknown;
 
-export { ALL_MODES, type ActionName, type AttachmentLimits, type Behavior, type CalloutPosition, type CalloutShape, type ComposerOptions, type FeatureFlags, type FeedbackEvent, type FeedbackOptions, type FieldOption, type FieldType, type FieldValidation, type FooterOptions, type FormCondition, type FormDef, type FormField, type Forms, type HapticsOptions, type HeaderActions, type HeaderOptions, type I18nOptions, type LauncherCallout, type LauncherOptions, type LauncherSize, type LauncherVariant, type Mode, type ModuleLayout, type ModuleOptions, type ModulesOptions, type Position, type PoweredBy, type Presentation, type ResizeOptions, type ResponseMode, type SendButtonOptions, type SizeOptions, type SoundOptions, type StringsOverride, type ThemeOverrides, type ThemePreference, type VoiceMode, actionNameSchema, attachmentLimitsSchema, behaviorSchema, calloutPositionSchema, calloutShapeSchema, composerOptionsSchema, emitJsonSchema, featureFlagsSchema, feedbackEventSchema, feedbackSchema, fieldOptionSchema, fieldTypeSchema, fieldValidationSchema, footerSchema, formConditionSchema, formDefSchema, formFieldSchema, formTriggerSchema, formsSchema, hapticsOptionsSchema, headerActionsSchema, headerSchema, i18nSchema, initialSizeSchema, launcherCalloutSchema, launcherOptionsSchema, launcherSizeSchema, launcherVariantSchema, modeSchema, moduleLayoutSchema, moduleSchema, modulesSchema, positionSchema, poweredBySchema, presentationSchema, resizeOptionsSchema, responseModeSchema, sendButtonIconSchema, sendButtonOptionsSchema, sendButtonShapeSchema, sendButtonVariantSchema, sizeOptionsSchema, soundOptionsSchema, stringsOverrideSchema, themeFieldSchema, themeOverridesSchema, themePreferenceSchema, toolRefSchema, voiceModeSchema, widgetSettingsSchemaForMode };
+export { ALL_MODES, type ActionName, type AttachmentLimits, type Behavior, type CalloutPosition, type CalloutShape, type ComposerOptions, type FeatureFlags, type FeedbackEvent, type FeedbackOptions, type FieldOption, type FieldType, type FieldValidation, type FooterOptions, type FormCondition, type FormDef, type FormField, type Forms, type HapticsOptions, type HeaderActions, type HeaderOptions, type I18nOptions, type LauncherCallout, type LauncherOptions, type LauncherSize, type LauncherVariant, type Mode, type ModuleLayout, type ModuleOptions, type ModulesOptions, type Position, type PoweredBy, type Presentation, type ResizeOptions, type ResponseMode, type SendButtonOptions, type SizeOptions, type SoundOptions, type StringsOverride, type ThemeOverrides, type ThemePreference, type TrackingSettings, type VoiceMode, actionNameSchema, attachmentLimitsSchema, behaviorSchema, calloutPositionSchema, calloutShapeSchema, composerOptionsSchema, emitJsonSchema, featureFlagsSchema, feedbackEventSchema, feedbackSchema, fieldOptionSchema, fieldTypeSchema, fieldValidationSchema, footerSchema, formConditionSchema, formDefSchema, formFieldSchema, formTriggerSchema, formsSchema, hapticsOptionsSchema, headerActionsSchema, headerSchema, i18nSchema, initialSizeSchema, launcherCalloutSchema, launcherOptionsSchema, launcherSizeSchema, launcherVariantSchema, modeSchema, moduleLayoutSchema, moduleSchema, modulesSchema, positionSchema, poweredBySchema, presentationSchema, resizeOptionsSchema, responseModeSchema, sendButtonIconSchema, sendButtonOptionsSchema, sendButtonShapeSchema, sendButtonVariantSchema, sizeOptionsSchema, soundOptionsSchema, stringsOverrideSchema, themeFieldSchema, themeOverridesSchema, themePreferenceSchema, toolRefSchema, trackingSchema, voiceModeSchema, widgetSettingsSchemaForMode };

package/schema.json

@@ -1839,6 +1839,43 @@
             ]
           ]
         },
+        "tracking": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "description": "Master switch. Default `false` — no hits are sent until the deployment turns tracking on.",
+              "type": "boolean"
+            },
+            "endpoint": {
+              "description": "Pixel collector URL. Default: `https://t.<brand domain>/api/ai-elements/px.gif`. Must be a full URL.",
+              "type": "string",
+              "maxLength": 2048,
+              "format": "uri"
+            },
+            "sampleRate": {
+              "description": "Per-visitor sampling 0..1 (decided once per page load, keeping funnels intact). Default `1`.",
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1
+            },
+            "token": {
+              "description": "Anti-forgery token, echoed as `tk=` on every hit. Server-issued in the `/start-conversation` response — never set by hand (see `docs/api/tracking-collector.md`).",
+              "type": "string",
+              "maxLength": 512
+            }
+          },
+          "additionalProperties": {},
+          "description": "Anonymous usage tracking for the widget owner — GA-style pixel events (open, send, form submit, …) with page / device / locale dimensions. Never includes message content; visitors are identified only by the widget's anonymous visitorId.",
+          "examples": [
+            {
+              "enabled": true
+            },
+            {
+              "enabled": true,
+              "sampleRate": 0.5
+            }
+          ]
+        },
         "site": {
           "description": "Site config — applies in `mode: \"page\"`. Comes from the start-conversation response, not user-edited."
         },
@@ -3556,6 +3593,43 @@
                   }
                 ]
               ]
+            },
+            "tracking": {
+              "type": "object",
+              "properties": {
+                "enabled": {
+                  "description": "Master switch. Default `false` — no hits are sent until the deployment turns tracking on.",
+                  "type": "boolean"
+                },
+                "endpoint": {
+                  "description": "Pixel collector URL. Default: `https://t.<brand domain>/api/ai-elements/px.gif`. Must be a full URL.",
+                  "type": "string",
+                  "maxLength": 2048,
+                  "format": "uri"
+                },
+                "sampleRate": {
+                  "description": "Per-visitor sampling 0..1 (decided once per page load, keeping funnels intact). Default `1`.",
+                  "type": "number",
+                  "minimum": 0,
+                  "maximum": 1
+                },
+                "token": {
+                  "description": "Anti-forgery token, echoed as `tk=` on every hit. Server-issued in the `/start-conversation` response — never set by hand (see `docs/api/tracking-collector.md`).",
+                  "type": "string",
+                  "maxLength": 512
+                }
+              },
+              "additionalProperties": {},
+              "description": "Anonymous usage tracking for the widget owner — GA-style pixel events (open, send, form submit, …) with page / device / locale dimensions. Never includes message content; visitors are identified only by the widget's anonymous visitorId.",
+              "examples": [
+                {
+                  "enabled": true
+                },
+                {
+                  "enabled": true,
+                  "sampleRate": 0.5
+                }
+              ]
             }
           },
           "additionalProperties": {}