@helpai/elements 0.13.1 → 0.14.0

package/package.json

@@ -80,5 +80,5 @@
   ],
   "type": "module",
   "types": "./index.d.ts",
-  "version": "0.13.1"
+  "version": "0.14.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 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-Big98MYV.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 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';
 import { z } from 'zod';
 
 /**
@@ -548,50 +548,30 @@ declare const footerSchema: z.ZodObject<{
 type FooterOptions = z.infer<typeof footerSchema>;
 
 /**
- * i18n section schemas — locale resolution + per-instance string
- * overrides.
+ * 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`).
  *
- * The runtime layers three sources to pick the active locale (highest
- * wins): user picker → server-pushed → `locale` field → `defaultLocale`
- * (or `"auto"` → `navigator.language`). `availableLocales` controls the
- * runtime language switcher's option list.
- */
-
-declare const stringsOverrideSchema: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodString>, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>]>;
-type StringsOverride = z.infer<typeof stringsOverrideSchema>;
-declare const i18nSchema: z.ZodObject<{
-    locale: z.ZodOptional<z.ZodString>;
-    defaultLocale: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"auto">, z.ZodString]>>;
-    availableLocales: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    strings: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodString>, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>]>>;
-}, z.core.$loose>;
-type I18nOptions = z.infer<typeof i18nSchema>;
-
-/**
- * Intake section — the pre-chat **lead/sales capture form**, modeled as a
- * deterministic array of typed fields with validation. When enabled it renders
- * as a **blocking gate**: the visitor completes (or skips, if `skippable`) the
- * form before the composer unlocks.
- *
- * The same {@link formFieldSchema} shape is reused at runtime by the AI-driven
- * **ask-input tool** (`src/ui/tool-ask-input.tsx`), so a sales/support/lead
- * agent can both capture a lead up-front and ask for more structured info
- * mid-conversation through one form engine.
- *
- * Off by default — existing deployments are unchanged. See
- * `docs/api/hitl-and-forms.md` for the wire contract + agent presets.
+ * Generic across verticals (healthcare, insurance, dealerships, clinics) — the
+ * widget has NO industry logic; a clinic triage intake, an insurance claim form,
+ * a CSAT survey, and a sales lead capture are all just different `forms` config.
+ * The same field shape powers the AI ask-input tool. See
+ * `docs/api/hitl-and-forms.md` + `docs/features/forms-and-hitl.md`.
  */
 
 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";
     multiselect: "multiselect";
 }>;
 type FieldType = z.infer<typeof fieldTypeSchema>;
@@ -618,12 +598,14 @@ declare const formFieldSchema: z.ZodObject<{
         number: "number";
         select: "select";
         textarea: "textarea";
+        time: "time";
         text: "text";
         checkbox: "checkbox";
         radio: "radio";
         url: "url";
         email: "email";
         tel: "tel";
+        date: "date";
         multiselect: "multiselect";
     }>;
     placeholder: z.ZodOptional<z.ZodString>;
@@ -647,10 +629,87 @@ declare const formFieldSchema: z.ZodObject<{
     validationHint: z.ZodOptional<z.ZodString>;
 }, z.core.$loose>;
 type FormField = z.infer<typeof formFieldSchema>;
-declare const intakeSchema: z.ZodObject<{
-    enabled: z.ZodDefault<z.ZodBoolean>;
+/**
+ * Trigger string: a bare event, or `event:param` for the parameterised ones.
+ * `pre-chat` · `after-messages:N` · `conversation-closed` · `panel-close` ·
+ * `idle:Nseconds` · `page-area:<area>` · `manual`.
+ */
+declare const formTriggerSchema: z.ZodString;
+declare const formConditionSchema: z.ZodObject<{
+    missingContext: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    pageArea: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+    minMessages: z.ZodOptional<z.ZodNumber>;
+    maxMessages: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;
+type FormCondition = z.infer<typeof formConditionSchema>;
+declare const formDefSchema: z.ZodObject<{
+    id: z.ZodString;
+    on: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+    when: z.ZodOptional<z.ZodObject<{
+        missingContext: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        pageArea: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+        minMessages: z.ZodOptional<z.ZodNumber>;
+        maxMessages: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+    fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        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";
+            multiselect: "multiselect";
+        }>;
+        placeholder: z.ZodOptional<z.ZodString>;
+        required: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        defaultValue: z.ZodOptional<z.ZodString>;
+        options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            label: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>>;
+        validation: z.ZodOptional<z.ZodObject<{
+            pattern: z.ZodOptional<z.ZodString>;
+            minLength: z.ZodOptional<z.ZodNumber>;
+            maxLength: z.ZodOptional<z.ZodNumber>;
+            min: z.ZodOptional<z.ZodNumber>;
+            max: z.ZodOptional<z.ZodNumber>;
+            minSelections: z.ZodOptional<z.ZodNumber>;
+            maxSelections: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$loose>>;
+        allowOther: z.ZodOptional<z.ZodBoolean>;
+        validationHint: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>>;
     title: z.ZodOptional<z.ZodString>;
     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";
+        always: "always";
+    }>>;
+    mirrorToContext: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$loose>;
+type FormDef = z.infer<typeof formDefSchema>;
+declare const formsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    on: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+    when: z.ZodOptional<z.ZodObject<{
+        missingContext: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        pageArea: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+        minMessages: z.ZodOptional<z.ZodNumber>;
+        maxMessages: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
     fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         label: z.ZodString;
@@ -658,12 +717,14 @@ declare const intakeSchema: z.ZodObject<{
             number: "number";
             select: "select";
             textarea: "textarea";
+            time: "time";
             text: "text";
             checkbox: "checkbox";
             radio: "radio";
             url: "url";
             email: "email";
             tel: "tel";
+            date: "date";
             multiselect: "multiselect";
         }>;
         placeholder: z.ZodOptional<z.ZodString>;
@@ -686,10 +747,39 @@ declare const intakeSchema: z.ZodObject<{
         allowOther: z.ZodOptional<z.ZodBoolean>;
         validationHint: z.ZodOptional<z.ZodString>;
     }, z.core.$loose>>>;
+    title: z.ZodOptional<z.ZodString>;
+    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";
+        always: "always";
+    }>>;
+    mirrorToContext: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$loose>>;
+type Forms = z.infer<typeof formsSchema>;
+
+/**
+ * i18n section schemas — locale resolution + per-instance string
+ * overrides.
+ *
+ * The runtime layers three sources to pick the active locale (highest
+ * wins): user picker → server-pushed → `locale` field → `defaultLocale`
+ * (or `"auto"` → `navigator.language`). `availableLocales` controls the
+ * runtime language switcher's option list.
+ */
+
+declare const stringsOverrideSchema: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodString>, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>]>;
+type StringsOverride = z.infer<typeof stringsOverrideSchema>;
+declare const i18nSchema: z.ZodObject<{
+    locale: z.ZodOptional<z.ZodString>;
+    defaultLocale: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"auto">, z.ZodString]>>;
+    availableLocales: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    strings: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodString>, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>]>>;
 }, z.core.$loose>;
-type Intake = z.infer<typeof intakeSchema>;
+type I18nOptions = z.infer<typeof i18nSchema>;
 
 /**
  * Modules section — the Intercom-style "messenger" surface, modeled as a
@@ -811,4 +901,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 FormField, type HapticsOptions, type HeaderActions, type HeaderOptions, type I18nOptions, type Intake, 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, type WelcomeAnimation, type WelcomeOptions, actionNameSchema, attachmentLimitsSchema, behaviorSchema, calloutPositionSchema, calloutShapeSchema, composerOptionsSchema, emitJsonSchema, featureFlagsSchema, feedbackEventSchema, feedbackSchema, fieldOptionSchema, fieldTypeSchema, fieldValidationSchema, footerSchema, formFieldSchema, hapticsOptionsSchema, headerActionsSchema, headerSchema, i18nSchema, initialSizeSchema, intakeSchema, 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, welcomeAnimationSchema, welcomeOptionsSchema, 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 VoiceMode, type WelcomeAnimation, type WelcomeOptions, 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, welcomeAnimationSchema, welcomeOptionsSchema, widgetSettingsSchemaForMode };