@helpai/elements 0.14.0 → 0.14.2

package/package.json

@@ -80,5 +80,5 @@
   ],
   "type": "module",
   "types": "./index.d.ts",
-  "version": "0.14.0"
+  "version": "0.14.2"
 }

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 StartSessionResponse, 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 startSessionResponseSchema, u as userContextSchema, v as uuid7Schema, w as widgetConfigPartialSchema, x as widgetConfigSchema, y as widgetSettingsPartialSchema, z as widgetSettingsSchema } from './deployment-Rtrqo8-b.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-CWyouRob.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,40 +323,40 @@ 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";
     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";
     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";
         history: "history";
+        clear: "clear";
         sound: "sound";
     }>>>;
 }, z.core.$loose>;
@@ -372,33 +372,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>;
@@ -407,21 +407,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>;
@@ -504,7 +504,7 @@ type ComposerOptions = z.infer<typeof composerOptionsSchema>;
 /**
  * Welcome section — how the agent's greeting messages render when
  * the chat opens. Content (the actual message text + suggestions)
- * comes from the server's start-session response; this schema only
+ * comes from the server's start-conversation response; this schema only
  * governs the visual presentation (animation style + speed).
  */
 
@@ -550,8 +550,8 @@ type FooterOptions = z.infer<typeof footerSchema>;
 /**
  * Forms section — an **event-driven forms engine**. A deployment declares an
  * ordered array of form definitions, each bound to trigger event(s), shown as a
- * blocking composer gate or inline in the transcript, deduped by frequency, and
- * recorded via one shared submit endpoint (`endpoints.forms`).
+ * a prompt that replaces the composer (gating chat until submit/skip), deduped
+ * by frequency, and recorded via one shared submit endpoint (`endpoints.submitForm`).
  *
  * Generic across verticals (healthcare, insurance, dealerships, clinics) — the
  * widget has NO industry logic; a clinic triage intake, an insurance claim form,
@@ -562,16 +562,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>;
@@ -596,16 +596,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>;
@@ -656,16 +656,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>;
@@ -692,10 +692,9 @@ declare const formDefSchema: z.ZodObject<{
     description: z.ZodOptional<z.ZodString>;
     submitLabel: z.ZodOptional<z.ZodString>;
     skippable: z.ZodDefault<z.ZodBoolean>;
-    blocking: z.ZodDefault<z.ZodBoolean>;
     frequency: z.ZodDefault<z.ZodEnum<{
         once: "once";
-        session: "session";
+        conversation: "conversation";
         always: "always";
     }>>;
     mirrorToContext: z.ZodDefault<z.ZodBoolean>;
@@ -715,16 +714,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>;
@@ -751,10 +750,9 @@ declare const formsSchema: z.ZodArray<z.ZodObject<{
     description: z.ZodOptional<z.ZodString>;
     submitLabel: z.ZodOptional<z.ZodString>;
     skippable: z.ZodDefault<z.ZodBoolean>;
-    blocking: z.ZodDefault<z.ZodBoolean>;
     frequency: z.ZodDefault<z.ZodEnum<{
         once: "once";
-        session: "session";
+        conversation: "conversation";
         always: "always";
     }>>;
     mirrorToContext: z.ZodDefault<z.ZodBoolean>;
@@ -791,24 +789,24 @@ type I18nOptions = z.infer<typeof i18nSchema>;
  * One tab → no tab bar (just that content). Zero → an empty state. Only
  * meaningful in `floating` / `drawer` / `modal` modes.
  *
- * The list arrives via the start-session (`config.modules`); each non-chat
+ * The list arrives via the start-conversation (`config.modules`); each non-chat
  * tab lazy-fetches its content from `GET /ai/agent/content` scoped by its
  * `category`. See `docs/api/messenger-modules.md` + `docs/api/content.md`.
  */
 
 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>>;
@@ -834,9 +832,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>>;

package/schema.json

@@ -167,7 +167,7 @@
             },
             "submitForm": {
               "default": "/ai/agent/submit-form",
-              "description": "Form submission endpoint. The widget POSTs each completed form's values here (fire-and-forget), keyed by the same visitorId + sessionId as the conversation; the payload carries `formId` + `trigger` so the backend can route. Optional — a 404 is ignored.",
+              "description": "Form submission endpoint. The widget POSTs each completed form's values here (fire-and-forget), keyed by the same visitorId + conversationId as the conversation; the payload carries `formId` + `trigger` so the backend can route. Optional — a 404 is ignored.",
               "type": "string",
               "minLength": 1,
               "maxLength": 2048
@@ -469,7 +469,7 @@
               "type": "boolean"
             },
             "popOutUrl": {
-              "description": "URL the `popOut` action opens in a new tab (carries `?chat=<id>&widgetId=<id>` query params). Falls back to the brand's build-time default. Set this to point at your own dedicated chat page (e.g. `https://app.acme.com/chat`). Server-pushable on `/start-session.widget.behavior.popOutUrl`.",
+              "description": "URL the `popOut` action opens in a new tab (carries `?chat=<id>&widgetId=<id>` query params). Falls back to the brand's build-time default. Set this to point at your own dedicated chat page (e.g. `https://app.acme.com/chat`). Server-pushable on `/start-conversation.widget.behavior.popOutUrl`.",
               "type": "string",
               "minLength": 1,
               "maxLength": 2048
@@ -1586,21 +1586,16 @@
               },
               "skippable": {
                 "default": false,
-                "description": "Show a Skip control.",
-                "type": "boolean"
-              },
-              "blocking": {
-                "default": false,
-                "description": "Gate the composer (honored only for `pre-chat` / `after-messages`); otherwise renders inline.",
+                "description": "Show a Skip control so the visitor can dismiss the form.",
                 "type": "boolean"
               },
               "frequency": {
                 "default": "once",
-                "description": "`once` (persisted per-device), `session`, or `always`.",
+                "description": "`once` (per device, persisted), `conversation` (re-eligible each new conversation), or `always`.",
                 "type": "string",
                 "enum": [
                   "once",
-                  "session",
+                  "conversation",
                   "always"
                 ]
               },
@@ -1615,19 +1610,17 @@
               "on",
               "fields",
               "skippable",
-              "blocking",
               "frequency",
               "mirrorToContext"
             ],
             "additionalProperties": {}
           },
-          "description": "Event-driven forms — an ordered list (order = priority). Each binds to trigger event(s), shows blocking or inline, dedupes by frequency, and records via `endpoints.forms`. Generic across verticals.",
+          "description": "Event-driven forms — an ordered list (order = priority). Each binds to trigger event(s), gates the chat until submit/skip, dedupes by frequency, and records via `endpoints.submitForm`. Generic across verticals.",
           "examples": [
             [
               {
                 "id": "intake",
                 "on": "pre-chat",
-                "blocking": true,
                 "fields": [
                   {
                     "name": "email",
@@ -1641,7 +1634,6 @@
               {
                 "id": "lead",
                 "on": "pre-chat",
-                "blocking": true,
                 "title": "Before we start",
                 "fields": [
                   {
@@ -1883,10 +1875,10 @@
           ]
         },
         "site": {
-          "description": "Site config — applies in `mode: \"page\"`. Comes from the start-session response, not user-edited."
+          "description": "Site config — applies in `mode: \"page\"`. Comes from the start-conversation response, not user-edited."
         },
         "blocks": {
-          "description": "Blocks (nav + link cards) — applies in `mode: \"page\"`. Comes from the start-session response."
+          "description": "Blocks (nav + link cards) — applies in `mode: \"page\"`. Comes from the start-conversation response."
         }
       },
       "required": [
@@ -1917,7 +1909,7 @@
         }
       ]
     },
-    "StartSessionResponse": {
+    "StartConversationResponse": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       "type": "object",
       "properties": {
@@ -2230,7 +2222,7 @@
                   "type": "boolean"
                 },
                 "popOutUrl": {
-                  "description": "URL the `popOut` action opens in a new tab (carries `?chat=<id>&widgetId=<id>` query params). Falls back to the brand's build-time default. Set this to point at your own dedicated chat page (e.g. `https://app.acme.com/chat`). Server-pushable on `/start-session.widget.behavior.popOutUrl`.",
+                  "description": "URL the `popOut` action opens in a new tab (carries `?chat=<id>&widgetId=<id>` query params). Falls back to the brand's build-time default. Set this to point at your own dedicated chat page (e.g. `https://app.acme.com/chat`). Server-pushable on `/start-conversation.widget.behavior.popOutUrl`.",
                   "type": "string",
                   "minLength": 1,
                   "maxLength": 2048
@@ -3347,21 +3339,16 @@
                   },
                   "skippable": {
                     "default": false,
-                    "description": "Show a Skip control.",
-                    "type": "boolean"
-                  },
-                  "blocking": {
-                    "default": false,
-                    "description": "Gate the composer (honored only for `pre-chat` / `after-messages`); otherwise renders inline.",
+                    "description": "Show a Skip control so the visitor can dismiss the form.",
                     "type": "boolean"
                   },
                   "frequency": {
                     "default": "once",
-                    "description": "`once` (persisted per-device), `session`, or `always`.",
+                    "description": "`once` (per device, persisted), `conversation` (re-eligible each new conversation), or `always`.",
                     "type": "string",
                     "enum": [
                       "once",
-                      "session",
+                      "conversation",
                       "always"
                     ]
                   },
@@ -3376,19 +3363,17 @@
                   "on",
                   "fields",
                   "skippable",
-                  "blocking",
                   "frequency",
                   "mirrorToContext"
                 ],
                 "additionalProperties": {}
               },
-              "description": "Event-driven forms — an ordered list (order = priority). Each binds to trigger event(s), shows blocking or inline, dedupes by frequency, and records via `endpoints.forms`. Generic across verticals.",
+              "description": "Event-driven forms — an ordered list (order = priority). Each binds to trigger event(s), gates the chat until submit/skip, dedupes by frequency, and records via `endpoints.submitForm`. Generic across verticals.",
               "examples": [
                 [
                   {
                     "id": "intake",
                     "on": "pre-chat",
-                    "blocking": true,
                     "fields": [
                       {
                         "name": "email",
@@ -3402,7 +3387,6 @@
                   {
                     "id": "lead",
                     "on": "pre-chat",
-                    "blocking": true,
                     "title": "Before we start",
                     "fields": [
                       {
@@ -3856,7 +3840,7 @@
         "visitorId": {
           "type": "string"
         },
-        "sessionId": {
+        "conversationId": {
           "type": "string"
         },
         "canContinue": {
@@ -3884,7 +3868,7 @@
                 "invalid"
               ]
             },
-            "sessionId": {
+            "conversationId": {
               "type": "string",
               "enum": [
                 "conflict",
@@ -3900,7 +3884,7 @@
         "deployment",
         "agent",
         "visitorId",
-        "sessionId",
+        "conversationId",
         "canContinue",
         "messages"
       ],