@marktiderman/genesis-forms 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -1,7 +1,9 @@
-import { F as FieldBlock, C as ContentBlock, P as PageBreakBlock, a as FormDefinition, H as HiddenInput, b as FormLayout, L as LogicRule, E as Ending, c as FormSettings, J as Json, d as Condition, B as Block, O as Operator, e as FieldValidator } from './validate-BbackAjB.cjs';
-export { f as FormEvent, g as Operand, R as REQUIRED_MESSAGE, S as StandardSchemaV1, v as validateField } from './validate-BbackAjB.cjs';
-import { F as FormEngine } from './engine-Bj8-mMVb.cjs';
-export { C as CreateFormOptions, a as FormState, c as createForm, i as isFormEvent, b as isJson, r as replay } from './engine-Bj8-mMVb.cjs';
+import { a as FieldBlock, C as ContentBlock, P as PageBreakBlock, F as FormDefinition, H as HiddenInput, b as FormLayout, L as LogicRule, E as Ending, c as FormSettings, J as Json, d as Condition, B as Block, O as Operator } from './types-BBKBQ8sp.cjs';
+export { e as FormEvent, f as Operand } from './types-BBKBQ8sp.cjs';
+import { F as FormEngine } from './engine-CPLtKVew.cjs';
+export { C as CreateFormOptions, a as FormState, c as createForm, i as isFormEvent, b as isJson, r as replay } from './engine-CPLtKVew.cjs';
+import { F as FieldValidator } from './validate-BXXqi0fq.cjs';
+export { R as REQUIRED_MESSAGE, S as StandardSchemaV1, v as validateField } from './validate-BXXqi0fq.cjs';
 
 /** A field block that remembers its key and value type, for answer inference. */
 type FieldSpec<K extends string = string, V = unknown> = FieldBlock & {
@@ -49,6 +51,50 @@ declare const f: {
     singleChoice: <K extends string, O extends string>(key: K, o: ChoiceFieldOptions<O>) => FieldSpec<K, O>;
     multiChoice: <K extends string, O extends string>(key: K, o: ChoiceFieldOptions<O>) => FieldSpec<K, O[]>;
     yesNo: <K extends string>(key: K, o: FieldOptions) => FieldSpec<K, boolean>;
+    /** Several short answers, one per line: goals, action items, three things that went well. */
+    list: <K extends string>(key: K, o: FieldOptions & {
+        min?: number | undefined;
+        max?: number | undefined;
+        itemMaxLength?: number | undefined;
+        itemPlaceholder?: string | undefined;
+    }) => FieldSpec<K, string[]>;
+    /**
+     * A small table each answer fills row by row, one answer per column: an
+     * action plan (What / Who / By when), pros and cons.
+     */
+    table: <K extends string, C extends string>(key: K, o: FieldOptions & {
+        columns: readonly {
+            key: C;
+            label: string;
+            long?: boolean | undefined;
+        }[];
+        minRows?: number | undefined;
+        maxRows?: number | undefined;
+    }) => FieldSpec<K, Partial<Record<C, string>>[]>;
+    /**
+     * Notes pinned to times in a video or audio (lecture notes, a recorded call
+     * review): `at` is seconds from its start.
+     */
+    mediaNotes: <K extends string>(key: K, o: FieldOptions & {
+        maxNotes?: number | undefined;
+        textMaxLength?: number | undefined;
+    }) => FieldSpec<K, {
+        at: number;
+        text: string;
+    }[]>;
+    /**
+     * Highlight passages of a text and note on each (annotating an article, a
+     * policy or a contract): `text` here, or supplied by the host app.
+     */
+    textHighlights: <K extends string>(key: K, o: FieldOptions & {
+        text?: string | undefined;
+        maxHighlights?: number | undefined;
+    }) => FieldSpec<K, {
+        start: number;
+        end: number;
+        quote: string;
+        note: string;
+    }[]>;
     /** Any registered field type, including plugins. */
     custom: <K extends string, V = Json>(type: string, key: K, o: FieldOptions & {
         props?: Record<string, Json>;
@@ -296,6 +342,57 @@ interface ChoiceOption {
 }
 declare function choiceOptions(field: FieldBlock): ChoiceOption[];
 
+declare function listLimits(field: FieldBlock): {
+    min: number;
+    max: number;
+    itemMaxLength: number;
+};
+interface TableColumn {
+    key: string;
+    label: string;
+    long?: boolean;
+}
+declare const MAX_TABLE_COLUMNS = 6;
+declare const MAX_TABLE_CELL_LENGTH = 2000;
+declare function tableColumns(field: FieldBlock): TableColumn[];
+declare function tableLimits(field: FieldBlock): {
+    minRows: number;
+    maxRows: number;
+};
+interface MediaNote {
+    at: number;
+    text: string;
+}
+declare const MAX_TIMESTAMP_SECONDS = 86400;
+declare function formatTimestamp(seconds: number): string;
+declare function parseTimestamp(text: string): number | null;
+interface Highlight {
+    start: number;
+    end: number;
+    quote: string;
+    note: string;
+}
+declare const MAX_HIGHLIGHT_NOTE_LENGTH = 1000;
+/** The longest passage one highlight may quote; also bounds a quote the server can't check against `props.text`. */
+declare const MAX_HIGHLIGHT_QUOTE_LENGTH = 2000;
+declare const HIGHLIGHT_NOTE_MESSAGE = "Add a note to each highlight.";
+/**
+ * The structured field types, whose answers are lists or records rather than one
+ * value:
+ * - `list`: several short answers, e.g. goals, action items, three things that went well.
+ * - `table`: a small table each answer fills row by row, e.g. an action plan
+ *   (What / Who / By when), pros and cons.
+ * - `media-notes`: notes pinned to times in a video or audio, e.g. lecture notes,
+ *   a recorded call review.
+ * - `text-highlights`: highlight passages of a text and note on each, e.g.
+ *   annotating an article, a policy or a contract.
+ *
+ * They are registered like any other, but the builder offers them only to a
+ * host that names them in its palette (`FormBuilder palette`), so forms that
+ * never had them don't change.
+ */
+declare const STRUCTURED_FIELD_TYPES: readonly ["list", "table", "media-notes", "text-highlights"];
+
 interface RecallScope {
     /** Fields by key. */
     fieldsByKey: Map<string, FieldBlock>;
@@ -378,4 +475,4 @@ declare function explain(source: FormEngine | ExplainInput, blockId: string, opt
 /** A condition as a plain-English clause: `contact_me is not Yes`. */
 declare function describeCondition(condition: Condition, def: FormDefinition, fields?: Map<string, FieldBlock>): string;
 
-export { type AnswersOf, Block, type ChoiceFieldOptions, type ChoiceOption, type CoerceHiddenOptions, type CoercedHidden, Condition, ContentBlock, Ending, type ExplainInput, type ExplainOptions, type Explanation, FieldBlock, type FieldOptions, type FieldSpec, type FieldTypeManifest, type FieldValidation, FieldValidator, type Form, FormDefinition, FormEngine, type FormInput, type FormIssue, FormLayout, FormSettings, HiddenInput, Json, type JumpTrace, type KeyResolver, LogicRule, MAX_HIDDEN_STRING_LENGTH, Operator, PageBreakBlock, type ParseResult, type PathResult, type RuleSpec, type RuleTrace, canonicalJson, choiceOptions, coerceHidden, coerceHiddenValue, computePath, defineForm, describeCondition, evaluate, explain, f, fingerprint, getFieldType, isEmptyValue, isSensitive, listFieldTypes, normalizeValue, parseForm, recall, registerFieldType, ruleVisible, steps, summarizeValue, when };
+export { type AnswersOf, Block, type ChoiceFieldOptions, type ChoiceOption, type CoerceHiddenOptions, type CoercedHidden, Condition, ContentBlock, Ending, type ExplainInput, type ExplainOptions, type Explanation, FieldBlock, type FieldOptions, type FieldSpec, type FieldTypeManifest, type FieldValidation, FieldValidator, type Form, FormDefinition, FormEngine, type FormInput, type FormIssue, FormLayout, FormSettings, HIGHLIGHT_NOTE_MESSAGE, HiddenInput, type Highlight, Json, type JumpTrace, type KeyResolver, LogicRule, MAX_HIDDEN_STRING_LENGTH, MAX_HIGHLIGHT_NOTE_LENGTH, MAX_HIGHLIGHT_QUOTE_LENGTH, MAX_TABLE_CELL_LENGTH, MAX_TABLE_COLUMNS, MAX_TIMESTAMP_SECONDS, type MediaNote, Operator, PageBreakBlock, type ParseResult, type PathResult, type RuleSpec, type RuleTrace, STRUCTURED_FIELD_TYPES, type TableColumn, canonicalJson, choiceOptions, coerceHidden, coerceHiddenValue, computePath, defineForm, describeCondition, evaluate, explain, f, fingerprint, formatTimestamp, getFieldType, isEmptyValue, isSensitive, listFieldTypes, listLimits, normalizeValue, parseForm, parseTimestamp, recall, registerFieldType, ruleVisible, steps, summarizeValue, tableColumns, tableLimits, when };

package/dist/index.d.ts

@@ -1,7 +1,9 @@
-import { F as FieldBlock, C as ContentBlock, P as PageBreakBlock, a as FormDefinition, H as HiddenInput, b as FormLayout, L as LogicRule, E as Ending, c as FormSettings, J as Json, d as Condition, B as Block, O as Operator, e as FieldValidator } from './validate-BbackAjB.js';
-export { f as FormEvent, g as Operand, R as REQUIRED_MESSAGE, S as StandardSchemaV1, v as validateField } from './validate-BbackAjB.js';
-import { F as FormEngine } from './engine-Coc-gQIB.js';
-export { C as CreateFormOptions, a as FormState, c as createForm, i as isFormEvent, b as isJson, r as replay } from './engine-Coc-gQIB.js';
+import { a as FieldBlock, C as ContentBlock, P as PageBreakBlock, F as FormDefinition, H as HiddenInput, b as FormLayout, L as LogicRule, E as Ending, c as FormSettings, J as Json, d as Condition, B as Block, O as Operator } from './types-BBKBQ8sp.js';
+export { e as FormEvent, f as Operand } from './types-BBKBQ8sp.js';
+import { F as FormEngine } from './engine-DOrPgFDw.js';
+export { C as CreateFormOptions, a as FormState, c as createForm, i as isFormEvent, b as isJson, r as replay } from './engine-DOrPgFDw.js';
+import { F as FieldValidator } from './validate-BjNwF1UE.js';
+export { R as REQUIRED_MESSAGE, S as StandardSchemaV1, v as validateField } from './validate-BjNwF1UE.js';
 
 /** A field block that remembers its key and value type, for answer inference. */
 type FieldSpec<K extends string = string, V = unknown> = FieldBlock & {
@@ -49,6 +51,50 @@ declare const f: {
     singleChoice: <K extends string, O extends string>(key: K, o: ChoiceFieldOptions<O>) => FieldSpec<K, O>;
     multiChoice: <K extends string, O extends string>(key: K, o: ChoiceFieldOptions<O>) => FieldSpec<K, O[]>;
     yesNo: <K extends string>(key: K, o: FieldOptions) => FieldSpec<K, boolean>;
+    /** Several short answers, one per line: goals, action items, three things that went well. */
+    list: <K extends string>(key: K, o: FieldOptions & {
+        min?: number | undefined;
+        max?: number | undefined;
+        itemMaxLength?: number | undefined;
+        itemPlaceholder?: string | undefined;
+    }) => FieldSpec<K, string[]>;
+    /**
+     * A small table each answer fills row by row, one answer per column: an
+     * action plan (What / Who / By when), pros and cons.
+     */
+    table: <K extends string, C extends string>(key: K, o: FieldOptions & {
+        columns: readonly {
+            key: C;
+            label: string;
+            long?: boolean | undefined;
+        }[];
+        minRows?: number | undefined;
+        maxRows?: number | undefined;
+    }) => FieldSpec<K, Partial<Record<C, string>>[]>;
+    /**
+     * Notes pinned to times in a video or audio (lecture notes, a recorded call
+     * review): `at` is seconds from its start.
+     */
+    mediaNotes: <K extends string>(key: K, o: FieldOptions & {
+        maxNotes?: number | undefined;
+        textMaxLength?: number | undefined;
+    }) => FieldSpec<K, {
+        at: number;
+        text: string;
+    }[]>;
+    /**
+     * Highlight passages of a text and note on each (annotating an article, a
+     * policy or a contract): `text` here, or supplied by the host app.
+     */
+    textHighlights: <K extends string>(key: K, o: FieldOptions & {
+        text?: string | undefined;
+        maxHighlights?: number | undefined;
+    }) => FieldSpec<K, {
+        start: number;
+        end: number;
+        quote: string;
+        note: string;
+    }[]>;
     /** Any registered field type, including plugins. */
     custom: <K extends string, V = Json>(type: string, key: K, o: FieldOptions & {
         props?: Record<string, Json>;
@@ -296,6 +342,57 @@ interface ChoiceOption {
 }
 declare function choiceOptions(field: FieldBlock): ChoiceOption[];
 
+declare function listLimits(field: FieldBlock): {
+    min: number;
+    max: number;
+    itemMaxLength: number;
+};
+interface TableColumn {
+    key: string;
+    label: string;
+    long?: boolean;
+}
+declare const MAX_TABLE_COLUMNS = 6;
+declare const MAX_TABLE_CELL_LENGTH = 2000;
+declare function tableColumns(field: FieldBlock): TableColumn[];
+declare function tableLimits(field: FieldBlock): {
+    minRows: number;
+    maxRows: number;
+};
+interface MediaNote {
+    at: number;
+    text: string;
+}
+declare const MAX_TIMESTAMP_SECONDS = 86400;
+declare function formatTimestamp(seconds: number): string;
+declare function parseTimestamp(text: string): number | null;
+interface Highlight {
+    start: number;
+    end: number;
+    quote: string;
+    note: string;
+}
+declare const MAX_HIGHLIGHT_NOTE_LENGTH = 1000;
+/** The longest passage one highlight may quote; also bounds a quote the server can't check against `props.text`. */
+declare const MAX_HIGHLIGHT_QUOTE_LENGTH = 2000;
+declare const HIGHLIGHT_NOTE_MESSAGE = "Add a note to each highlight.";
+/**
+ * The structured field types, whose answers are lists or records rather than one
+ * value:
+ * - `list`: several short answers, e.g. goals, action items, three things that went well.
+ * - `table`: a small table each answer fills row by row, e.g. an action plan
+ *   (What / Who / By when), pros and cons.
+ * - `media-notes`: notes pinned to times in a video or audio, e.g. lecture notes,
+ *   a recorded call review.
+ * - `text-highlights`: highlight passages of a text and note on each, e.g.
+ *   annotating an article, a policy or a contract.
+ *
+ * They are registered like any other, but the builder offers them only to a
+ * host that names them in its palette (`FormBuilder palette`), so forms that
+ * never had them don't change.
+ */
+declare const STRUCTURED_FIELD_TYPES: readonly ["list", "table", "media-notes", "text-highlights"];
+
 interface RecallScope {
     /** Fields by key. */
     fieldsByKey: Map<string, FieldBlock>;
@@ -378,4 +475,4 @@ declare function explain(source: FormEngine | ExplainInput, blockId: string, opt
 /** A condition as a plain-English clause: `contact_me is not Yes`. */
 declare function describeCondition(condition: Condition, def: FormDefinition, fields?: Map<string, FieldBlock>): string;
 
-export { type AnswersOf, Block, type ChoiceFieldOptions, type ChoiceOption, type CoerceHiddenOptions, type CoercedHidden, Condition, ContentBlock, Ending, type ExplainInput, type ExplainOptions, type Explanation, FieldBlock, type FieldOptions, type FieldSpec, type FieldTypeManifest, type FieldValidation, FieldValidator, type Form, FormDefinition, FormEngine, type FormInput, type FormIssue, FormLayout, FormSettings, HiddenInput, Json, type JumpTrace, type KeyResolver, LogicRule, MAX_HIDDEN_STRING_LENGTH, Operator, PageBreakBlock, type ParseResult, type PathResult, type RuleSpec, type RuleTrace, canonicalJson, choiceOptions, coerceHidden, coerceHiddenValue, computePath, defineForm, describeCondition, evaluate, explain, f, fingerprint, getFieldType, isEmptyValue, isSensitive, listFieldTypes, normalizeValue, parseForm, recall, registerFieldType, ruleVisible, steps, summarizeValue, when };
+export { type AnswersOf, Block, type ChoiceFieldOptions, type ChoiceOption, type CoerceHiddenOptions, type CoercedHidden, Condition, ContentBlock, Ending, type ExplainInput, type ExplainOptions, type Explanation, FieldBlock, type FieldOptions, type FieldSpec, type FieldTypeManifest, type FieldValidation, FieldValidator, type Form, FormDefinition, FormEngine, type FormInput, type FormIssue, FormLayout, FormSettings, HIGHLIGHT_NOTE_MESSAGE, HiddenInput, type Highlight, Json, type JumpTrace, type KeyResolver, LogicRule, MAX_HIDDEN_STRING_LENGTH, MAX_HIGHLIGHT_NOTE_LENGTH, MAX_HIGHLIGHT_QUOTE_LENGTH, MAX_TABLE_CELL_LENGTH, MAX_TABLE_COLUMNS, MAX_TIMESTAMP_SECONDS, type MediaNote, Operator, PageBreakBlock, type ParseResult, type PathResult, type RuleSpec, type RuleTrace, STRUCTURED_FIELD_TYPES, type TableColumn, canonicalJson, choiceOptions, coerceHidden, coerceHiddenValue, computePath, defineForm, describeCondition, evaluate, explain, f, fingerprint, formatTimestamp, getFieldType, isEmptyValue, isSensitive, listFieldTypes, listLimits, normalizeValue, parseForm, parseTimestamp, recall, registerFieldType, ruleVisible, steps, summarizeValue, tableColumns, tableLimits, when };