@helpai/elements 0.30.1 → 0.32.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-rva7dkso.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-By1iOOzQ.js';
 import 'zod';
 
 /**
@@ -505,6 +505,46 @@ interface FormDef {
      * `/activity` records for such forms).
      */
     reviewable?: boolean;
+    /** BCP-47 locale the top-level strings (title / fields copy) are authored in. */
+    defaultLocale?: string;
+    /**
+     * Per-locale string overrides. The data module trims this to the requested
+     * `?locale=` (≤1 entry); the widget overlays it onto the default copy at
+     * resolve time (`overlayFormDef`). Absent strings fall back to the default.
+     */
+    translations?: FormTranslation[];
+}
+/**
+ * Per-locale overrides of a form's HUMAN-FACING strings only. Structure (field
+ * `name` / `type` / `validation`, option `value`) is shared across locales and
+ * stays canonical, so submissions + validation are locale-independent — a
+ * translation matches the canonical form by the stable `name` (field) / `value`
+ * (option) keys. Absent strings fall back to the top-level (defaultLocale) copy.
+ *
+ * The data module trims `FormDef.translations` to the requested `?locale=` (≤1
+ * entry) on read; the widget overlays that entry onto the default fields. Mirror
+ * of `module-help-ai-data-api` `DynamicFormTranslation`.
+ */
+interface FieldOptionTranslation {
+    /** The canonical option `value` this localizes. */
+    value: string;
+    label?: string;
+    description?: string;
+}
+interface FormFieldTranslation {
+    /** The canonical field `name` this localizes. */
+    name: string;
+    label?: string;
+    placeholder?: string;
+    validationHint?: string;
+    options?: FieldOptionTranslation[];
+}
+interface FormTranslation {
+    locale: string;
+    title?: string;
+    description?: string;
+    submitLabel?: string;
+    fields?: FormFieldTranslation[];
 }
 /** The `forms` block is an ordered list (max 20); order = priority. */
 type FormsOptions = FormDef[];