@marktiderman/genesis-forms 0.2.0 → 0.3.0

package/dist/server.cjs

@@ -1,5 +1,187 @@
 'use strict';
 
+// src/structured.ts
+var isObject = (v) => !!v && typeof v === "object" && !Array.isArray(v);
+function intProp(field, name, fallback, floor = 1) {
+  const v = field.props?.[name];
+  return typeof v === "number" && Number.isInteger(v) && v >= floor ? v : fallback;
+}
+function optionalIntProp(field, name, floor = 0) {
+  const v = field.props?.[name];
+  return typeof v === "number" && Number.isInteger(v) && v >= floor ? v : void 0;
+}
+var blank = (v) => typeof v !== "string" || v.trim() === "";
+var blankText = (v) => typeof v === "string" && v.trim() === "";
+var emptyList = (value, isBlank) => value === void 0 || value === null || Array.isArray(value) && value.every(isBlank);
+var plural = (n, one, many = `${one}s`) => `${n} ${n === 1 ? one : many}`;
+function listLimits(field) {
+  return { min: optionalIntProp(field, "min") ?? 0, max: intProp(field, "max", 10), itemMaxLength: intProp(field, "itemMaxLength", 500) };
+}
+var listItems = (value) => Array.isArray(value) ? value.filter((v) => typeof v === "string" && v.trim() !== "") : [];
+var MAX_TABLE_COLUMNS = 6;
+var MAX_TABLE_CELL_LENGTH = 2e3;
+function tableColumns(field) {
+  const raw = field.props?.columns;
+  if (!Array.isArray(raw)) return [];
+  const seen = /* @__PURE__ */ new Set();
+  const out = [];
+  for (const c of raw) {
+    if (!isObject(c) || typeof c.key !== "string" || !c.key || seen.has(c.key)) continue;
+    seen.add(c.key);
+    const column = { key: c.key, label: typeof c.label === "string" ? c.label : c.key };
+    if (c.long === true) column.long = true;
+    out.push(column);
+  }
+  return out;
+}
+function tableLimits(field) {
+  return { minRows: optionalIntProp(field, "minRows") ?? 0, maxRows: intProp(field, "maxRows", 3) };
+}
+var filledRows = (value) => Array.isArray(value) ? value.filter((r) => isObject(r) && Object.values(r).some((c) => !blank(c))) : [];
+var MAX_TIMESTAMP_SECONDS = 86400;
+function formatTimestamp(seconds) {
+  const total = Number.isFinite(seconds) && seconds > 0 ? Math.floor(seconds) : 0;
+  const h = Math.floor(total / 3600);
+  const m = Math.floor(total % 3600 / 60);
+  const s = String(total % 60).padStart(2, "0");
+  return h ? `${h}:${String(m).padStart(2, "0")}:${s}` : `${m}:${s}`;
+}
+var isTimestamp = (v) => typeof v === "number" && Number.isFinite(v) && v >= 0 && v <= MAX_TIMESTAMP_SECONDS;
+var notesWithText = (value) => Array.isArray(value) ? value.filter((n) => isObject(n) && !blank(n.text)) : [];
+var MAX_HIGHLIGHT_NOTE_LENGTH = 1e3;
+var MAX_HIGHLIGHT_QUOTE_LENGTH = 2e3;
+var HIGHLIGHT_NOTE_MESSAGE = "Add a note to each highlight.";
+var sourceText = (field) => typeof field.props?.text === "string" && field.props.text ? field.props.text : void 0;
+var structuredFieldTypes = [
+  {
+    type: "list",
+    label: "List",
+    category: "text",
+    value: { json: true },
+    // logic.ts `contains` on an array is exact item equality, same as multi-choice, so it is offered.
+    operators: ["contains", "answered", "empty"],
+    a11y: { semantics: "group" },
+    isEmpty: (value) => emptyList(value, blankText),
+    validate: (value, field) => {
+      if (!Array.isArray(value) || !value.every((v) => typeof v === "string")) return "Enter a list of answers.";
+      const { min, max, itemMaxLength } = listLimits(field);
+      if (value.some((v) => v.trim().length > itemMaxLength)) return `Keep each item under ${itemMaxLength} characters.`;
+      const count = listItems(value).length;
+      if (count < min) return `Add at least ${plural(min, "item")}.`;
+      if (count > max) return `Add at most ${plural(max, "item")}.`;
+      return null;
+    },
+    normalize: (value) => Array.isArray(value) ? listItems(value).map((v) => v.trim()) : value,
+    summarize: (value) => listItems(value).map((v) => v.trim()).join("; "),
+    samples: (field) => {
+      const { min, max } = listLimits(field);
+      return [Array.from({ length: Math.min(Math.max(1, min), max) }, (_, i) => `Item ${i + 1}`)];
+    }
+  },
+  {
+    type: "table",
+    label: "Table",
+    category: "advanced",
+    value: { json: true },
+    operators: ["answered", "empty"],
+    a11y: { semantics: "group" },
+    isEmpty: (value) => emptyList(value, (r) => isObject(r) && Object.values(r).every(blankText)),
+    validate: (value, field) => {
+      const columns = tableColumns(field);
+      if (!columns.length) return "This question has no columns.";
+      if (!Array.isArray(value) || !value.every(isObject)) return "Fill in the rows.";
+      const keys = new Set(columns.map((c) => c.key));
+      for (const row of value) {
+        for (const [key, cell] of Object.entries(row)) {
+          if (!keys.has(key)) return "An answer names a column this question doesn't have.";
+          if (typeof cell !== "string") return "Fill in the rows with text.";
+          if (cell.trim().length > MAX_TABLE_CELL_LENGTH) return `Keep each answer under ${MAX_TABLE_CELL_LENGTH} characters.`;
+        }
+      }
+      const { minRows, maxRows } = tableLimits(field);
+      const count = filledRows(value).length;
+      if (count < minRows) return `Fill in at least ${plural(minRows, "row")}.`;
+      if (count > maxRows) return `Fill in at most ${plural(maxRows, "row")}.`;
+      return null;
+    },
+    normalize: (value) => Array.isArray(value) ? filledRows(value).map((row) => {
+      const out = {};
+      for (const [key, cell] of Object.entries(row)) if (typeof cell === "string") out[key] = cell.trim();
+      return out;
+    }) : value,
+    summarize: (value, field) => {
+      const columns = tableColumns(field);
+      return filledRows(value).map((row) => columns.filter((c) => !blank(row[c.key])).map((c) => `${c.label}: ${row[c.key].trim()}`).join(" \xB7 ")).join(" / ");
+    },
+    samples: (field) => {
+      const columns = tableColumns(field);
+      if (!columns.length) return [];
+      const { minRows, maxRows } = tableLimits(field);
+      const row = Object.fromEntries(columns.map((c) => [c.key, "sample"]));
+      return [Array.from({ length: Math.min(Math.max(1, minRows), maxRows) }, () => ({ ...row }))];
+    }
+  },
+  {
+    type: "media-notes",
+    label: "Notes at moments",
+    category: "media",
+    value: { json: true },
+    operators: ["answered", "empty"],
+    a11y: { semantics: "group" },
+    isEmpty: (value) => emptyList(value, (n) => isObject(n) && blankText(n.text)),
+    validate: (value, field) => {
+      if (!Array.isArray(value)) return "Add notes.";
+      const textMaxLength = intProp(field, "textMaxLength", 1e3);
+      for (const note of value) {
+        if (!isObject(note) || typeof note.text !== "string") return "Add notes.";
+        if (!isTimestamp(note.at)) return "Each note needs a time.";
+        if (note.text.trim().length > textMaxLength) return `Keep each note under ${textMaxLength} characters.`;
+      }
+      const maxNotes = intProp(field, "maxNotes", 20);
+      return notesWithText(value).length > maxNotes ? `Add at most ${plural(maxNotes, "note")}.` : null;
+    },
+    normalize: (value) => Array.isArray(value) ? notesWithText(value).map((n) => ({ at: n.at, text: n.text.trim() })).sort((a, b) => a.at - b.at) : value,
+    summarize: (value) => notesWithText(value).map((n) => ({ at: typeof n.at === "number" ? n.at : 0, text: n.text.trim() })).sort((a, b) => a.at - b.at).map((n) => `${formatTimestamp(n.at)} ${n.text}`).join("; "),
+    samples: () => [[{ at: 0, text: "sample" }]]
+  },
+  {
+    type: "text-highlights",
+    label: "Highlights",
+    category: "media",
+    value: { json: true },
+    operators: ["answered", "empty"],
+    a11y: { semantics: "group" },
+    isEmpty: (value) => emptyList(value, () => false),
+    validate: (value, field) => {
+      if (!Array.isArray(value)) return "Highlight a passage.";
+      const maxHighlights = intProp(field, "maxHighlights", 20);
+      if (value.length > maxHighlights) return `Add at most ${plural(maxHighlights, "highlight")}.`;
+      const text = sourceText(field);
+      for (const h of value) {
+        if (!isObject(h) || !Number.isInteger(h.start) || !Number.isInteger(h.end) || typeof h.quote !== "string" || typeof h.note !== "string") {
+          return "Highlight a passage of the text.";
+        }
+        const start = h.start;
+        const end = h.end;
+        if (start < 0 || end <= start || h.quote.length !== end - start) return "Highlight a passage of the text.";
+        if (end - start > MAX_HIGHLIGHT_QUOTE_LENGTH) return `Highlight under ${MAX_HIGHLIGHT_QUOTE_LENGTH} characters at a time.`;
+        if (text !== void 0 && (end > text.length || text.slice(start, end) !== h.quote)) return "A highlight doesn't match the text.";
+        if (h.note.trim() === "") return HIGHLIGHT_NOTE_MESSAGE;
+        if (h.note.trim().length > MAX_HIGHLIGHT_NOTE_LENGTH) return `Keep each note under ${MAX_HIGHLIGHT_NOTE_LENGTH} characters.`;
+      }
+      return null;
+    },
+    normalize: (value) => Array.isArray(value) ? value.filter(isObject).map((h) => ({ start: h.start, end: h.end, quote: h.quote, note: String(h.note).trim() })).sort((a, b) => a.start - b.start || a.end - b.end) : value,
+    summarize: (value) => Array.isArray(value) ? value.filter(isObject).map((h) => `"${String(h.quote)}" \u2014 ${String(h.note).trim()}`).join("; ") : "",
+    samples: (field) => {
+      const text = sourceText(field);
+      if (text === void 0) return [[{ start: 0, end: 6, quote: "sample", note: "sample" }]];
+      const end = Math.min(text.length, 20);
+      return [[{ start: 0, end, quote: text.slice(0, end), note: "sample" }]];
+    }
+  }
+];
+
 // src/fields.ts
 var REGISTRY = /* @__PURE__ */ Symbol.for("@marktiderman/genesis-forms/field-types");
 var globalScope = globalThis;
@@ -181,7 +363,7 @@ var builtins = [
     summarize: (value) => value ? "Yes" : "No"
   }
 ];
-for (const manifest of builtins) registerFieldType(manifest);
+for (const manifest of [...builtins, ...structuredFieldTypes]) registerFieldType(manifest);
 
 // src/events.ts
 function isPlainObject(value) {
@@ -610,7 +792,7 @@ function shown(v) {
   text ??= typeof v === "bigint" ? `${v}n` : typeof v;
   return text.length > 60 ? `${text.slice(0, 57)}...` : text;
 }
-var isObject = (v) => !!v && typeof v === "object" && !Array.isArray(v);
+var isObject2 = (v) => !!v && typeof v === "object" && !Array.isArray(v);
 var isInt = (v) => typeof v === "number" && Number.isInteger(v);
 var LITERAL_TYPE = {
   "short-text": "string",
@@ -621,7 +803,8 @@ var LITERAL_TYPE = {
   nps: "number",
   "single-choice": "string",
   "multi-choice": "string",
-  "yes-no": "boolean"
+  "yes-no": "boolean",
+  list: "string"
 };
 var ORDERING = /* @__PURE__ */ new Set(["lt", "lte", "gt", "gte"]);
 var OPERATORS = /* @__PURE__ */ new Set([
@@ -663,7 +846,48 @@ function parseForm(input) {
     }
     return true;
   };
-  if (!isObject(input)) {
+  const optionalInt = (v, path, floor) => {
+    if (v !== void 0 && !(isInt(v) && v >= floor)) issue(path, `Must be a whole number of ${floor} or more.`);
+  };
+  const ordered = (low, high, path, what) => {
+    if (isInt(low) && isInt(high) && low > high) issue(path, `Can't be more than the ${what}.`);
+  };
+  const structuredProps = (type, props, path) => {
+    if (type === "list") {
+      optionalInt(props.min, `${path}.min`, 0);
+      optionalInt(props.max, `${path}.max`, 1);
+      optionalInt(props.itemMaxLength, `${path}.itemMaxLength`, 1);
+      optionalText(props.placeholder, `${path}.placeholder`);
+      ordered(props.min, props.max ?? 10, `${path}.min`, "most items");
+    } else if (type === "table") {
+      const columns = props.columns;
+      if (!Array.isArray(columns) || columns.length < 1 || columns.length > MAX_TABLE_COLUMNS) {
+        issue(`${path}.columns`, `Must be a list of 1 to ${MAX_TABLE_COLUMNS} columns.`);
+      } else {
+        const seen = /* @__PURE__ */ new Set();
+        columns.forEach((c, j) => {
+          const at = `${path}.columns[${j}]`;
+          if (!isObject2(c)) return issue(at, "Each column needs a key and a label.");
+          if (name(c.key, `${at}.key`, "A column key")) {
+            if (seen.has(c.key)) issue(`${at}.key`, `Duplicate column key "${c.key}".`);
+            seen.add(c.key);
+          }
+          text(c.label, `${at}.label`);
+          optionalBoolean(c.long, `${at}.long`);
+        });
+      }
+      optionalInt(props.minRows, `${path}.minRows`, 0);
+      optionalInt(props.maxRows, `${path}.maxRows`, 1);
+      ordered(props.minRows, props.maxRows ?? 3, `${path}.minRows`, "most rows");
+    } else if (type === "media-notes") {
+      optionalInt(props.maxNotes, `${path}.maxNotes`, 1);
+      optionalInt(props.textMaxLength, `${path}.textMaxLength`, 1);
+    } else if (type === "text-highlights") {
+      optionalText(props.text, `${path}.text`);
+      optionalInt(props.maxHighlights, `${path}.maxHighlights`, 1);
+    }
+  };
+  if (!isObject2(input)) {
     issue("", "A form definition must be an object.");
     return fail();
   }
@@ -672,19 +896,19 @@ function parseForm(input) {
   text(input.title, "title");
   optionalText(input.description, "description");
   if (input.layout !== void 0) {
-    if (!isObject(input.layout)) issue("layout", "Must be an object.");
+    if (!isObject2(input.layout)) issue("layout", "Must be an object.");
     else if (input.layout.mode !== "focus" && input.layout.mode !== "classic") {
       issue("layout.mode", "Must be focus or classic.");
     }
   }
   if (input.settings !== void 0) {
-    if (!isObject(input.settings)) issue("settings", "Must be an object.");
+    if (!isObject2(input.settings)) issue("settings", "Must be an object.");
     else {
       optionalBoolean(input.settings.anonymous, "settings.anonymous");
       optionalBoolean(input.settings.clearHiddenValues, "settings.clearHiddenValues");
     }
   }
-  if (input.meta !== void 0 && (!isObject(input.meta) || !isJson(input.meta))) {
+  if (input.meta !== void 0 && (!isObject2(input.meta) || !isJson(input.meta))) {
     issue("meta", "Must be a JSON object.");
   }
   if (!Array.isArray(input.blocks)) {
@@ -699,7 +923,7 @@ function parseForm(input) {
   const choices = /* @__PURE__ */ new Map();
   input.blocks.forEach((block, i) => {
     const path = `blocks[${i}]`;
-    if (!isObject(block) || typeof block.id !== "string" || !block.id) {
+    if (!isObject2(block) || typeof block.id !== "string" || !block.id) {
       issue(path, "Every block needs a string id.");
       return;
     }
@@ -720,29 +944,30 @@ function parseForm(input) {
         issue(`${path}.type`, `Unknown field type "${String(block.type)}".`);
       }
       if (block.props !== void 0) {
-        if (!isObject(block.props) || !isJson(block.props)) issue(`${path}.props`, "Must be a JSON object.");
+        if (!isObject2(block.props) || !isJson(block.props)) issue(`${path}.props`, "Must be a JSON object.");
         else if (block.props.options !== void 0) {
           const options = block.props.options;
           if (!Array.isArray(options)) issue(`${path}.props.options`, "Must be an array.");
           else {
             options.forEach((o, j) => {
               const at = `${path}.props.options[${j}]`;
-              if (!isObject(o) || typeof o.value !== "string") issue(at, "Each option needs a string value.");
+              if (!isObject2(o) || typeof o.value !== "string") issue(at, "Each option needs a string value.");
               else optionalText(o.label, `${at}.label`);
             });
             choices.set(
               block.id,
-              new Set(options.flatMap((o) => isObject(o) && typeof o.value === "string" ? [o.value] : []))
+              new Set(options.flatMap((o) => isObject2(o) && typeof o.value === "string" ? [o.value] : []))
             );
           }
         }
-        const { max, maxLength: maxLength2 } = isObject(block.props) ? block.props : {};
+        const { max, maxLength: maxLength2 } = isObject2(block.props) ? block.props : {};
         if (block.type === "rating" && max !== void 0 && !(isInt(max) && max >= 2 && max <= 10)) {
           issue(`${path}.props.max`, "Must be a whole number from 2 to 10.");
         }
         if (maxLength2 !== void 0 && !(isInt(maxLength2) && maxLength2 > 0)) {
           issue(`${path}.props.maxLength`, "Must be a whole number above 0.");
         }
+        if (isObject2(block.props) && typeof block.type === "string") structuredProps(block.type, block.props, `${path}.props`);
       }
       if (validKey) {
         if (keys.has(block.key)) issue(`${path}.key`, `Duplicate key "${String(block.key)}".`);
@@ -762,7 +987,7 @@ function parseForm(input) {
   const hiddenTypes = /* @__PURE__ */ new Map();
   if (input.hidden !== void 0 && !Array.isArray(input.hidden)) issue("hidden", "Must be an array.");
   (Array.isArray(input.hidden) ? input.hidden : []).forEach((h, i) => {
-    if (!isObject(h) || typeof h.name !== "string" || !h.name) {
+    if (!isObject2(h) || typeof h.name !== "string" || !h.name) {
       issue(`hidden[${i}]`, "Each hidden input needs a name.");
       return;
     }
@@ -783,7 +1008,7 @@ function parseForm(input) {
   if (input.endings !== void 0 && !Array.isArray(input.endings)) issue("endings", "Must be an array.");
   (Array.isArray(input.endings) ? input.endings : []).forEach((e, i) => {
     const path = `endings[${i}]`;
-    if (!isObject(e)) {
+    if (!isObject2(e)) {
       issue(path, "Each ending must be an object with an id and a title.");
       return;
     }
@@ -795,7 +1020,7 @@ function parseForm(input) {
   });
   const checkOperand = (o, path, reads) => {
     if (o === void 0) return;
-    if (!isObject(o)) return issue(path, "An operand must be an object.");
+    if (!isObject2(o)) return issue(path, "An operand must be an object.");
     if ("field" in o) {
       if (typeof o.field !== "string" || !fieldTypes.has(o.field)) return issue(path, `No field "${String(o.field)}".`);
       reads.push(o.field);
@@ -808,7 +1033,7 @@ function parseForm(input) {
     }
   };
   const checkCondition = (c, path, reads, depth = 0) => {
-    if (!isObject(c)) return issue(path, "A condition must be an object.");
+    if (!isObject2(c)) return issue(path, "A condition must be an object.");
     if (depth > MAX_CONDITION_DEPTH) return issue(path, "The condition is nested too deeply.");
     if ("all" in c || "any" in c) {
       const group = "all" in c ? "all" : "any";
@@ -817,7 +1042,7 @@ function parseForm(input) {
       return list.forEach((x, i) => checkCondition(x, `${path}.${group}[${i}]`, reads, depth + 1));
     }
     if ("not" in c) return checkCondition(c.not, `${path}.not`, reads, depth + 1);
-    if (typeof c.op !== "string" || !isObject(c.left)) {
+    if (typeof c.op !== "string" || !isObject2(c.left)) {
       return issue(path, "A comparison needs an `op` and a `left` operand.");
     }
     if (!OPERATORS.has(c.op)) issue(`${path}.op`, `Unknown operator "${c.op}".`);
@@ -833,7 +1058,7 @@ function parseForm(input) {
   };
   const checkLiterals = (op, left, right, path) => {
     if (op === "answered" || op === "empty" || !OPERATORS.has(op)) return;
-    const literal = isObject(right) && "value" in right;
+    const literal = isObject2(right) && "value" in right;
     if (right !== void 0 && !literal) return;
     let what = "the left side";
     let type;
@@ -872,7 +1097,7 @@ function parseForm(input) {
   if (input.logic !== void 0 && !Array.isArray(input.logic)) issue("logic", "Must be an array.");
   (Array.isArray(input.logic) ? input.logic : []).forEach((rule, i) => {
     const path = `logic[${i}]`;
-    if (!isObject(rule) || typeof rule.id !== "string" || !isObject(rule.when)) {
+    if (!isObject2(rule) || typeof rule.id !== "string" || !isObject2(rule.when)) {
       issue(path, "Each rule needs an id and a `when` condition.");
       return;
     }
@@ -891,7 +1116,7 @@ function parseForm(input) {
         at = rule.from;
         inclusive = true;
       }
-      if (isObject(rule.to)) {
+      if (isObject2(rule.to)) {
         if (typeof rule.to.ending !== "string" || !endingIds.has(rule.to.ending)) {
           issue(`${path}.to`, `No ending "${String(rule.to.ending)}".`);
         }
@@ -923,7 +1148,7 @@ function parseForm(input) {
     }
   });
   input.blocks.forEach((block, i) => {
-    if (!isObject(block)) return;
+    if (!isObject2(block)) return;
     const raw = block.kind === "field" ? [block.label, block.description] : block.kind === "content" ? [block.text] : [];
     const texts = raw.filter((t) => typeof t === "string");
     for (const t of texts) {
@@ -943,7 +1168,7 @@ function parseForm(input) {
   });
   const extra = [["description", input.description]];
   (Array.isArray(input.endings) ? input.endings : []).forEach((e, i) => {
-    if (isObject(e)) extra.push([`endings[${i}]`, e.title], [`endings[${i}]`, e.description]);
+    if (isObject2(e)) extra.push([`endings[${i}]`, e.title], [`endings[${i}]`, e.description]);
   });
   for (const [path, t] of extra) {
     if (typeof t !== "string") continue;