@marktiderman/genesis-forms 0.1.0 → 0.2.0

package/dist/server.d.cts

@@ -1,32 +1,32 @@
-import { J as Json, f as FormEvent, e as FieldValidator, a as FormDefinition } from './validate-j8Z188mF.cjs';
+import { J as Json, f as FormEvent, e as FieldValidator, a as FormDefinition } from './validate-BbackAjB.cjs';
 
 interface SubmissionInput {
     /** Answers keyed by field id. Ignored when `events` is given. */
-    answers?: Record<string, Json>;
+    answers?: Record<string, Json> | undefined;
     /** The respondent's event log. Replayed instead of trusting `answers`. */
-    events?: FormEvent[];
+    events?: FormEvent[] | undefined;
     /** URL and host inputs sent by the client. Server inputs here are ignored. */
-    hidden?: Record<string, Json>;
+    hidden?: Record<string, Json> | undefined;
 }
 interface SubmissionOptions {
     /** Values for `source: "server"` inputs, resolved by the server (class, coach, user id…). */
-    context?: Record<string, Json>;
+    context?: Record<string, Json> | undefined;
     /** `false` checks a draft: formats only, nothing required. Default true. */
-    complete?: boolean;
-    validators?: Record<string, FieldValidator>;
+    complete?: boolean | undefined;
+    validators?: Record<string, FieldValidator> | undefined;
     /** Most events accepted, counted after `compactEvents`. Default 10 000. */
-    maxEvents?: number;
+    maxEvents?: number | undefined;
 }
 interface CheckedSubmission {
     status: "draft" | "completed";
     /** Visible answers only, keyed by field id (kept hidden answers too, with `clearHiddenValues: false`). */
     answers: Record<string, Json>;
-    /** Untrusted URL and host inputs, coerced to their declared types. */
+    /** Untrusted URL and host inputs, coerced to their declared types. Identifying ones are left out on anonymous forms. */
     hidden: Record<string, Json>;
-    /** Trusted server inputs. */
+    /** Trusted server inputs. Identifying ones are left out on anonymous forms. */
     context: Record<string, Json>;
     ending: string | null;
-    /** Client-sent keys that were dropped: unknown fields, server inputs, undeclared hidden names. */
+    /** Client-sent keys that were dropped, each once: unknown fields, server inputs, undeclared or withheld hidden names. */
     ignored: string[];
 }
 type SubmissionResult = {

package/dist/server.d.ts

@@ -1,32 +1,32 @@
-import { J as Json, f as FormEvent, e as FieldValidator, a as FormDefinition } from './validate-j8Z188mF.js';
+import { J as Json, f as FormEvent, e as FieldValidator, a as FormDefinition } from './validate-BbackAjB.js';
 
 interface SubmissionInput {
     /** Answers keyed by field id. Ignored when `events` is given. */
-    answers?: Record<string, Json>;
+    answers?: Record<string, Json> | undefined;
     /** The respondent's event log. Replayed instead of trusting `answers`. */
-    events?: FormEvent[];
+    events?: FormEvent[] | undefined;
     /** URL and host inputs sent by the client. Server inputs here are ignored. */
-    hidden?: Record<string, Json>;
+    hidden?: Record<string, Json> | undefined;
 }
 interface SubmissionOptions {
     /** Values for `source: "server"` inputs, resolved by the server (class, coach, user id…). */
-    context?: Record<string, Json>;
+    context?: Record<string, Json> | undefined;
     /** `false` checks a draft: formats only, nothing required. Default true. */
-    complete?: boolean;
-    validators?: Record<string, FieldValidator>;
+    complete?: boolean | undefined;
+    validators?: Record<string, FieldValidator> | undefined;
     /** Most events accepted, counted after `compactEvents`. Default 10 000. */
-    maxEvents?: number;
+    maxEvents?: number | undefined;
 }
 interface CheckedSubmission {
     status: "draft" | "completed";
     /** Visible answers only, keyed by field id (kept hidden answers too, with `clearHiddenValues: false`). */
     answers: Record<string, Json>;
-    /** Untrusted URL and host inputs, coerced to their declared types. */
+    /** Untrusted URL and host inputs, coerced to their declared types. Identifying ones are left out on anonymous forms. */
     hidden: Record<string, Json>;
-    /** Trusted server inputs. */
+    /** Trusted server inputs. Identifying ones are left out on anonymous forms. */
     context: Record<string, Json>;
     ending: string | null;
-    /** Client-sent keys that were dropped: unknown fields, server inputs, undeclared hidden names. */
+    /** Client-sent keys that were dropped, each once: unknown fields, server inputs, undeclared or withheld hidden names. */
     ignored: string[];
 }
 type SubmissionResult = {

package/dist/server.js

@@ -228,6 +228,7 @@ function compactEvents(events) {
 
 // src/hidden.ts
 var MAX_HIDDEN_STRING_LENGTH = 1e3;
+var DECIMAL = /^-?\d+(\.\d+)?$/;
 function coerceHiddenValue(value, type) {
   if (typeof value === "string" && value.length > MAX_HIDDEN_STRING_LENGTH) return void 0;
   if (type === "string") {
@@ -237,7 +238,7 @@ function coerceHiddenValue(value, type) {
   }
   if (type === "number") {
     if (typeof value === "number") return Number.isFinite(value) ? value : void 0;
-    if (typeof value !== "string" || value.trim() === "") return void 0;
+    if (typeof value !== "string" || !DECIMAL.test(value)) return void 0;
     const n = Number(value);
     return Number.isFinite(n) ? n : void 0;
   }
@@ -562,7 +563,7 @@ function build(definition, options, replaying = false) {
       for (const id of state.path) {
         const field = fields.get(id);
         const value = own(state.values, id);
-        if (field && value !== void 0) out[id] = normalizeValue(value, field);
+        if (field && !isEmptyValue(value, field)) out[id] = normalizeValue(value, field);
       }
       return out;
     }
@@ -597,7 +598,30 @@ function replay(definition, events, options = {}) {
 }
 
 // src/parse.ts
+function shown(v) {
+  let text;
+  try {
+    text = JSON.stringify(v);
+  } catch {
+    text = void 0;
+  }
+  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 isInt = (v) => typeof v === "number" && Number.isInteger(v);
+var LITERAL_TYPE = {
+  "short-text": "string",
+  "long-text": "string",
+  email: "string",
+  phone: "string",
+  rating: "number",
+  nps: "number",
+  "single-choice": "string",
+  "multi-choice": "string",
+  "yes-no": "boolean"
+};
+var ORDERING = /* @__PURE__ */ new Set(["lt", "lte", "gt", "gte"]);
 var OPERATORS = /* @__PURE__ */ new Set([
   "eq",
   "neq",
@@ -670,6 +694,7 @@ function parseForm(input) {
   const keys = /* @__PURE__ */ new Map();
   const fieldTypes = /* @__PURE__ */ new Map();
   const order = /* @__PURE__ */ new Map();
+  const choices = /* @__PURE__ */ new Map();
   input.blocks.forEach((block, i) => {
     const path = `blocks[${i}]`;
     if (!isObject(block) || typeof block.id !== "string" || !block.id) {
@@ -703,8 +728,19 @@ function parseForm(input) {
               if (!isObject(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] : []))
+            );
           }
         }
+        const { max, maxLength: maxLength2 } = isObject(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 (validKey) {
         if (keys.has(block.key)) issue(`${path}.key`, `Duplicate key "${String(block.key)}".`);
@@ -721,6 +757,7 @@ function parseForm(input) {
     }
   });
   const hiddenNames = /* @__PURE__ */ new Set();
+  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) {
@@ -736,7 +773,9 @@ function parseForm(input) {
       issue(`hidden[${i}].type`, "Must be string, number or boolean.");
     }
     optionalBoolean(h.sensitive, `hidden[${i}].sensitive`);
+    optionalBoolean(h.identifying, `hidden[${i}].identifying`);
     hiddenNames.add(h.name);
+    if (typeof h.type === "string") hiddenTypes.set(h.name, h.type);
   });
   const endingIds = /* @__PURE__ */ new Set();
   if (input.endings !== void 0 && !Array.isArray(input.endings)) issue("endings", "Must be an array.");
@@ -785,8 +824,45 @@ function parseForm(input) {
     if (typeof c.left.field === "string") {
       const manifest = getFieldType(fieldTypes.get(c.left.field) ?? "");
       if (manifest && OPERATORS.has(c.op) && !manifest.operators.includes(c.op)) {
-        issue(`${path}.op`, `"${c.op}" does not apply to a ${manifest.type} field.`);
+        return issue(`${path}.op`, `"${c.op}" does not apply to a ${manifest.type} field.`);
+      }
+    }
+    checkLiterals(c.op, c.left, c.right, path);
+  };
+  const checkLiterals = (op, left, right, path) => {
+    if (op === "answered" || op === "empty" || !OPERATORS.has(op)) return;
+    const literal = isObject(right) && "value" in right;
+    if (right !== void 0 && !literal) return;
+    let what = "the left side";
+    let type;
+    let options;
+    if (typeof left.field === "string" && fieldTypes.has(left.field)) {
+      const fieldType = fieldTypes.get(left.field);
+      what = `"${keyOf(left.field)}"`;
+      type = LITERAL_TYPE[fieldType];
+      if (fieldType === "single-choice" || fieldType === "multi-choice") options = choices.get(left.field);
+    } else if (typeof left.hidden === "string" && hiddenTypes.has(left.hidden)) {
+      what = `hidden input "${left.hidden}"`;
+      type = hiddenTypes.get(left.hidden);
+    }
+    const outcome = op === "neq" ? "always true" : "never true";
+    let values;
+    if (op === "in") {
+      if (!literal || !Array.isArray(right.value)) {
+        return void warnings.push({ path: `${path}.right`, message: "`in` needs a list of values; it never matches." });
+      }
+      values = right.value;
+    } else if (!literal) return;
+    else values = [right.value];
+    if (ORDERING.has(op)) {
+      if (type !== void 0 && type !== "number") {
+        return void warnings.push({ path: `${path}.op`, message: `"${op}" compares numbers, but ${what} holds a ${type}; it is never true.` });
       }
+      type = "number";
+    }
+    for (const v of values) {
+      const message = type !== void 0 && typeof v !== type ? `${what} holds a ${type}, but ${shown(v)} is not one; this comparison is ${outcome}.` : options && typeof v === "string" && !options.has(v) ? `${shown(v)} is not an option of ${what}; this comparison is ${outcome}.` : null;
+      if (message) warnings.push({ path: `${path}.right`, message });
     }
   };
   const keyOf = (id) => [...keys].find(([, v]) => v === id)?.[0] ?? id;
@@ -863,6 +939,18 @@ 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]);
+  });
+  for (const [path, t] of extra) {
+    if (typeof t !== "string") continue;
+    for (const ref of recallRefs(t)) {
+      if (ref.kind === "hidden" ? !hiddenNames.has(ref.name) : !keys.has(ref.name)) {
+        warnings.push({ path, message: `Recalls unknown ${ref.kind === "hidden" ? "hidden input" : "field"} "${ref.name}"; it shows its fallback text.` });
+      }
+    }
+  }
   return issues.length ? fail() : { ok: true, form: input, warnings };
 }
 
@@ -899,18 +987,16 @@ function validateSubmission(definition, submission, options = {}) {
   if (invalid) return { ok: false, errors: { "": invalid } };
   const input = wellFormed(submission);
   if (!input) return MALFORMED;
-  const ignored = [];
+  const ignored = /* @__PURE__ */ new Set();
   const client = coerceHidden(definition, input.hidden, { sources: ["url", "host"] });
-  for (const name of client.ignored) ignored.push(`hidden.${name}`);
+  for (const name of client.ignored) ignored.add(`hidden.${name}`);
   const hidden = client.values;
   const context = coerceHidden(definition, options.context, { sources: ["server"] }).values;
   const fields = fieldMap(definition);
-  const dropped = /* @__PURE__ */ new Set();
   const accept = (id) => {
-    if (!fields.has(id)) return void ignored.push(id);
+    if (!fields.has(id)) return void ignored.add(id);
     if (!withheld(definition, fields.get(id))) return true;
-    if (!dropped.has(id)) ignored.push(id);
-    dropped.add(id);
+    ignored.add(id);
     return false;
   };
   const engineHidden = { ...hidden, ...context };
@@ -963,15 +1049,25 @@ function validateSubmission(definition, submission, options = {}) {
       if (message === null) answers[id] = normalizeValue(value, field);
     }
   }
+  const store = (values, report) => {
+    if (definition.settings?.anonymous !== true) return values;
+    const identifying = new Set((definition.hidden ?? []).filter((h) => h.identifying === true).map((h) => h.name));
+    const kept = {};
+    for (const [name, value] of Object.entries(values)) {
+      if (!identifying.has(name)) kept[name] = value;
+      else if (report) ignored.add(`hidden.${name}`);
+    }
+    return kept;
+  };
   return {
     ok: true,
     submission: {
       status: complete ? "completed" : "draft",
       answers,
-      hidden,
-      context,
+      hidden: store(hidden, true),
+      context: store(context, false),
       ending: complete ? state.ending : null,
-      ignored
+      ignored: [...ignored]
     }
   };
 }