@spotto/contract 1.0.70-alpha.11 → 1.0.70-alpha.13

package/dist/forms/[id]/patch/request.d.ts

@@ -1,14 +1,14 @@
-import { FormItem, FormPrefillRow, FormWriteBackRow } from '../../shared';
+import { FormItem, FormSettings } from '../../shared';
 /**
  * Publishes a new version of the form. `{id}` is the version document the
  * editor loaded — the server inserts exactly `that.version + 1` and returns
  * 409 when the head has moved ("form changed — reload"). Version documents
  * themselves are never mutated. Omitted fields carry over from the loaded
- * version; `name` is immutable.
+ * version; `name` is immutable. A present `settings` replaces the loaded
+ * version's wholesale — publish `{}` to clear it.
  */
 export interface UpdateFormRequest {
     label?: string;
     items?: FormItem[];
-    prefill?: FormPrefillRow[];
-    writeBack?: FormWriteBackRow[];
+    settings?: FormSettings;
 }

package/dist/forms/get/response.d.ts

@@ -1,5 +1,5 @@
 import { IEntityMeta } from '../../shared';
-import { FormItem, FormPrefillRow, FormWriteBackRow } from '../shared';
+import { FormItem, FormSettings } from '../shared';
 import { GetFormsQuery } from './query';
 /** One immutable form version document. */
 export interface GetFormResponse {
@@ -12,8 +12,7 @@ export interface GetFormResponse {
     current: boolean;
     archived: boolean;
     items: FormItem[];
-    prefill: FormPrefillRow[];
-    writeBack: FormWriteBackRow[];
+    settings?: FormSettings;
     createdBy: string;
     meta?: IEntityMeta;
 }

package/dist/forms/post/request.d.ts

@@ -1,10 +1,9 @@
-import { FormItem, FormPrefillRow, FormWriteBackRow } from '../shared';
+import { FormItem, FormSettings } from '../shared';
 /** Creates a new form as version 1 (current). */
 export interface PostFormRequest {
     /** Immutable handle; referenced by actions. */
     name: string;
     label: string;
     items: FormItem[];
-    prefill?: FormPrefillRow[];
-    writeBack?: FormWriteBackRow[];
+    settings?: FormSettings;
 }

package/dist/forms/shared.d.ts

@@ -21,12 +21,33 @@ export interface FormFieldItem {
     expression?: string;
     /** Required (and only allowed) when source is CONTEXT. */
     from?: ReservedContextFieldName;
-    /** Must be present to submit — only bites while the item is visible. */
+    /** Must be present to submit — only bites while the item is active. */
     required?: boolean;
-    /** Shown, not editable (e.g. filled by prefill purely for context). */
+    /** Shown, not editable (e.g. a read-in shown purely for context). */
     readonly?: boolean;
-    /** Open-time expression seeding the initial value (prefill wins over it). */
+    /**
+     * Open-time expression seeding the initial value — the one read-in
+     * mechanism. Naming a target field reads it in, including the item's own
+     * name (the form value is still empty at open, so the target shows
+     * through). A CHECKBOXES item's default must be exactly a field name (a
+     * copy — expressions cannot produce a selection).
+     */
     default?: string;
+    /**
+     * Push the item's value to the same-named target field at submit — the
+     * captured value for INPUT, the derived value for COMPUTED. Only bites
+     * while the item is active (`visibleWhen`); written as ordinary authored
+     * data (user-editable afterward) and triggers the standard recompute.
+     */
+    writeBack?: boolean;
+    /**
+     * Never displayed; the item still participates fully — seeded, computed,
+     * required, written back. `visibleWhen`, if any, still gates activity
+     * (which is how a write-back is made conditional).
+     */
+    hidden?: boolean;
+    /** The activity gate: a failing item is not shown, not required, and not
+     * written back. */
     visibleWhen?: string;
     /** Per-form display overrides; identity still comes from the definition. */
     label?: string;
@@ -48,6 +69,27 @@ export interface FormImageItem {
 export interface FormDividerItem {
     kind: 'divider';
 }
+/**
+ * A hyperlink content block — opens `href` (validated http(s)-only at save,
+ * so a stored href is always safe to render as an anchor).
+ */
+export interface FormLinkItem {
+    kind: 'link';
+    href: string;
+    /** Display text; the href itself shows when omitted. */
+    label?: string;
+}
+/**
+ * An embedded YouTube video. The URL is stored as authored (watch, share,
+ * shorts or embed form — validated against the YouTube hosts at save) and
+ * the client derives the embed markup, so only allowlisted hosts ever reach
+ * an iframe.
+ */
+export interface FormVideoItem {
+    kind: 'video';
+    url: string;
+    caption?: string;
+}
 /**
  * A signature/photo capture block. Produces an attachment reference on the
  * submission (never a fieldValue), keyed by the block's `name`.
@@ -59,28 +101,27 @@ export interface FormCaptureItem {
     label?: string;
     help?: string;
 }
-export declare type FormItem = FormFieldItem | FormSectionItem | FormTextItem | FormImageItem | FormDividerItem | FormCaptureItem;
+export declare type FormItem = FormFieldItem | FormSectionItem | FormTextItem | FormImageItem | FormDividerItem | FormLinkItem | FormVideoItem | FormCaptureItem;
 export declare type FormItemKind = FormItem['kind'];
 /**
- * A read-in row: on open, seed form field `to` from the target — either a
- * copy of target field `from` or an `expression` over the target's effective
- * values (exactly one of the two), optionally gated by `when`.
- */
-export interface FormPrefillRow {
-    to: string;
-    from?: string;
-    expression?: string;
-    when?: string;
-}
-/**
- * A write-back row: on submit, set target field `to` — either a copy of
- * captured form value `from` or an `expression` over the merged env (exactly
- * one of the two), optionally gated by `when`. Written as ordinary authored
- * data (user-editable afterward) and triggers the standard recompute.
+ * Runner presentation options — how the form presents its chrome, not what
+ * it collects. Optional as a whole, and PATCH replaces it wholesale, so an
+ * option can be cleared by publishing without it.
  */
-export interface FormWriteBackRow {
-    to: string;
-    from?: string;
-    expression?: string;
-    when?: string;
+export interface FormSettings {
+    /** Overrides the submit button text (e.g. "Confirm"). */
+    submitLabel?: string;
+    /** Show a cancel button that closes the form without submitting. */
+    showCancel?: boolean;
+    /** Cancel button text — only allowed alongside `showCancel`. */
+    cancelLabel?: string;
+    /**
+     * Content-only: completing the form records NOTHING (no submission, no
+     * event, no write-back) — the server rejects a submission against it.
+     * Save-time validation forbids `writeBack: true` items, capture blocks
+     * and required items. For a recorded acknowledgment, use a
+     * non-informational form with a signature block and a "Confirm"
+     * submitLabel instead.
+     */
+    informational?: boolean;
 }

package/dist/submissions/shared.d.ts

@@ -33,13 +33,13 @@ export interface ISubmissionAttachment {
  * DATETIME as a Date, CHECKBOXES as the full option array.
  */
 export declare type SubmissionWriteBackValue = string | number | boolean | string[];
-/** One write-back row's outcome — applied with values, or skipped with why. */
+/** One write-back item's outcome — applied with values, or skipped with why. */
 export interface ISubmissionWriteBackAudit {
     to: string;
     appliedValue?: SubmissionWriteBackValue;
     /** The asset-level value the write replaced; absent when the field had none. */
     previousValue?: SubmissionWriteBackValue;
-    /** Present on expression rows — the formula that produced the value. */
+    /** Present on COMPUTED items — the formula that produced the value. */
     expression?: string;
     skipped?: true;
     reason?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spotto/contract",
   "license": "ISC",
-  "version": "1.0.70-alpha.11",
+  "version": "1.0.70-alpha.13",
   "description": "Spotto's API Contract type definitions",
   "main": "./dist/index.js",
   "files": [
@@ -18,5 +18,5 @@
     "@types/geojson": "^7946.0.11",
     "shx": "^0.3.4"
   },
-  "gitHead": "3bfd5e720157f73503fd29486b6111952e44de5a"
+  "gitHead": "ee164edbac29f51e60ef9c6046399a9e0ac4c316"
 }