@marktiderman/genesis-forms 0.5.0 → 0.6.0

package/dist/testing.cjs

@@ -831,6 +831,65 @@ function summarizeValue(value, field) {
   if (Array.isArray(value)) return value.join(", ");
   return String(value);
 }
+var OPTION_LIMITS = {
+  /** Characters in a description. */
+  description: 500,
+  /** Characters in an image URL. */
+  image: 2048,
+  /** Attributes on one option. */
+  attributes: 20,
+  /** Characters in an attribute's name. */
+  attributeName: 64,
+  /** Characters in one attribute value. */
+  attributeValue: 200,
+  /** Values in one attribute's list. */
+  attributeItems: 50
+};
+function isHttpsUrl(url) {
+  return typeof url === "string" && url.length <= OPTION_LIMITS.image && /^https:\/\/[^\s/?#@\\]+(?:[/?#][^\s]*)?$/i.test(url) && // No control characters anywhere (a line break would end a CSV row or an HTML attribute).
+  ![...url].some((c) => c.charCodeAt(0) < 32 || c.charCodeAt(0) === 127);
+}
+function attributeName(name) {
+  return name.trim() !== "" && name.length <= OPTION_LIMITS.attributeName && !(name in Object.prototype);
+}
+function readAttributes(raw) {
+  if (!raw || typeof raw !== "object" || Array.isArray(raw)) return void 0;
+  const out = {};
+  let count = 0;
+  for (const name of Object.keys(raw)) {
+    if (count >= OPTION_LIMITS.attributes) break;
+    if (!attributeName(name)) continue;
+    const v = raw[name];
+    const fits = (x) => typeof x === "string" && x.length <= OPTION_LIMITS.attributeValue;
+    if (fits(v)) out[name] = v;
+    else if (Array.isArray(v) && v.length <= OPTION_LIMITS.attributeItems && v.every(fits)) out[name] = [...v];
+    else continue;
+    count++;
+  }
+  return count ? out : void 0;
+}
+function readOption(raw) {
+  if (!raw || typeof raw !== "object" || Array.isArray(raw)) return null;
+  const o = raw;
+  if (typeof o.value !== "string") return null;
+  const out = { value: o.value };
+  if (typeof o.label === "string") out.label = o.label;
+  if (typeof o.description === "string" && o.description.trim() && o.description.length <= OPTION_LIMITS.description) {
+    out.description = o.description;
+  }
+  if (isHttpsUrl(o.image)) out.image = o.image;
+  const attributes = readAttributes(o.attributes);
+  if (attributes) out.attributes = attributes;
+  return out;
+}
+function optionJson(option) {
+  const out = { value: option.value };
+  if (option.label !== void 0) out.label = option.label;
+  if (option.description !== void 0) out.description = option.description;
+  if (option.image !== void 0) out.image = option.image;
+  if (option.attributes !== void 0) out.attributes = { ...option.attributes };
+  return out;
+}
 var OTHER_MAX_LENGTH = 200;
 function otherOption(field) {
   const other = field.props?.other;
@@ -848,14 +907,21 @@ var typedOther = (field, value) => isOtherValue(field, value) && value.trim() !=
 function choiceOptions(field) {
   const raw = field.props?.options;
   if (!Array.isArray(raw)) return [];
-  return raw.flatMap(
-    (o) => o && typeof o === "object" && !Array.isArray(o) && typeof o.value === "string" ? [{ value: o.value, label: typeof o.label === "string" ? o.label : void 0 }] : []
-  );
+  return raw.flatMap((o) => {
+    const option = readOption(o);
+    return option ? [option] : [];
+  });
 }
 function optionsSource(field) {
   const raw = field.props?.optionsFrom;
   if (!raw || typeof raw !== "object" || Array.isArray(raw)) return void 0;
-  return raw.source === "host" && typeof raw.key === "string" && raw.key ? { source: "host", key: raw.key } : void 0;
+  if (raw.source !== "host" || typeof raw.key !== "string" || !raw.key) return void 0;
+  const out = { source: "host", key: raw.key };
+  const filter = raw.filter;
+  if (filter && typeof filter === "object" && !Array.isArray(filter) && typeof filter.attribute === "string" && filter.attribute && typeof filter.field === "string" && filter.field) {
+    out.filter = { attribute: filter.attribute, field: filter.field };
+  }
+  return out;
 }
 function hostList(hostOptions, key) {
   if (!hostOptions || !Object.prototype.hasOwnProperty.call(hostOptions, key)) return [];
@@ -864,11 +930,10 @@ function hostList(hostOptions, key) {
   const seen = /* @__PURE__ */ new Set();
   const out = [];
   for (const o of list) {
-    if (!o || typeof o !== "object" || Array.isArray(o)) continue;
-    const { value, label } = o;
-    if (typeof value !== "string" || !value || seen.has(value)) continue;
-    seen.add(value);
-    out.push(typeof label === "string" ? { value, label } : { value });
+    const option = readOption(o);
+    if (!option || !option.value || seen.has(option.value)) continue;
+    seen.add(option.value);
+    out.push(option);
   }
   return out;
 }
@@ -883,7 +948,7 @@ function withHostOptions(definition, hostOptions) {
     const added = hostList(hostOptions, from.key).filter((o) => !taken.has(o.value));
     if (!added.length) return block;
     changed = true;
-    const options = [...own2, ...added].map((o) => o.label === void 0 ? { value: o.value } : { value: o.value, label: o.label });
+    const options = [...own2, ...added].map(optionJson);
     return { ...block, props: { ...block.props, options } };
   });
   return changed ? { ...definition, blocks } : definition;
@@ -1363,6 +1428,150 @@ function fieldMap(def) {
   return map;
 }
 
+// src/options.ts
+var CHOICE_FIELD_TYPES = /* @__PURE__ */ new Set(["single-choice", "multi-choice", "dropdown"]);
+var isChoice = (block) => !!block && block.kind === "field" && CHOICE_FIELD_TYPES.has(block.type);
+function put(record, key, value) {
+  Object.defineProperty(record, key, { value, enumerable: true, writable: true, configurable: true });
+}
+function optionFilter(field) {
+  return optionsSource(field)?.filter;
+}
+function answerValues(answer) {
+  const one = (v) => typeof v === "string" ? [v] : typeof v === "number" || typeof v === "boolean" ? [String(v)] : [];
+  if (answer === void 0 || answer === null) return [];
+  return Array.isArray(answer) ? answer.flatMap(one) : one(answer);
+}
+function optionMatches(option, attribute, answer) {
+  const have = option.attributes && Object.prototype.hasOwnProperty.call(option.attributes, attribute) ? option.attributes[attribute] : void 0;
+  if (have === void 0) return false;
+  const wanted = answerValues(answer);
+  return (Array.isArray(have) ? have : [have]).some((v) => wanted.includes(v));
+}
+function filterSource(definition, key) {
+  return definition.blocks.find((b) => b.kind === "field" && b.key === key);
+}
+function visibleOptions(definition, field, values) {
+  const options = choiceOptions(field);
+  const filter = optionFilter(field);
+  if (!filter) return options;
+  const source = filterSource(definition, filter.field);
+  if (!source || source.id === field.id) return options;
+  const answer = own(values, source.id);
+  if (isEmptyValue(answer, source)) return options;
+  return options.filter((o) => optionMatches(o, filter.attribute, answer));
+}
+function answersOnPath(state) {
+  const out = /* @__PURE__ */ Object.create(null);
+  for (const id of state.path) out[id] = own(state.values, id);
+  return out;
+}
+var OUTSIDE_FILTER = "Choose one of the options.";
+function filteredChoiceError(definition, field, value, values) {
+  if (!optionFilter(field) || isEmptyValue(value, field)) return null;
+  const all = new Set(choiceOptions(field).map((o) => o.value));
+  const shown2 = new Set(visibleOptions(definition, field, values).map((o) => o.value));
+  const picked = answerValues(value);
+  return picked.some((v) => all.has(v) && !shown2.has(v)) ? OUTSIDE_FILTER : null;
+}
+function hasOptionFilters(definition) {
+  return definition.blocks.some((b) => isChoice(b) && optionFilter(b) !== void 0);
+}
+function clearFilteredAnswers(definition, values, changedId) {
+  const changed = definition.blocks.find((b) => b.kind === "field" && b.id === changedId);
+  if (!changed) return values;
+  const keys = /* @__PURE__ */ new Set([changed.key]);
+  let out = values;
+  for (const block of definition.blocks) {
+    if (!isChoice(block)) continue;
+    const filter = optionFilter(block);
+    if (!filter || !keys.has(filter.field)) continue;
+    const value = own(out, block.id);
+    if (value === void 0 || isEmptyValue(value, block)) continue;
+    const all = new Set(choiceOptions(block).map((o) => o.value));
+    const shown2 = new Set(visibleOptions(definition, block, out).map((o) => o.value));
+    const keep = (v) => typeof v !== "string" || !all.has(v) || shown2.has(v);
+    let next = value;
+    if (Array.isArray(value)) {
+      const kept = value.filter(keep);
+      if (kept.length !== value.length) next = kept.length ? kept : void 0;
+    } else if (!keep(value)) next = void 0;
+    if (next === value) continue;
+    if (out === values) out = { ...values };
+    put(out, block.id, next);
+    keys.add(block.key);
+  }
+  return out;
+}
+var MAX_PREFILL_PARAM_LENGTH = 64;
+function isPrefillParam(param) {
+  return typeof param === "string" && param.length <= MAX_PREFILL_PARAM_LENGTH && /^[A-Za-z0-9_.-]+$/.test(param);
+}
+function prefillSetting(field) {
+  if (!CHOICE_FIELD_TYPES.has(field.type)) return void 0;
+  const raw = field.props?.prefill;
+  if (!raw || typeof raw !== "object" || Array.isArray(raw) || !isPrefillParam(raw.param)) return void 0;
+  return { param: raw.param, hideWhenPrefilled: raw.hideWhenPrefilled === true };
+}
+function paramValues(params, name) {
+  let raw;
+  if (typeof params.getAll === "function") {
+    raw = params.getAll(name);
+  } else if (Object.prototype.hasOwnProperty.call(params, name)) {
+    raw = params[name];
+  }
+  const list = Array.isArray(raw) ? raw : raw === void 0 ? [] : [raw];
+  return list.filter((v) => typeof v === "string" && v !== "" && v.length <= MAX_HIDDEN_STRING_LENGTH);
+}
+function prefillFromLink(definition, params, values = {}) {
+  const out = {};
+  if (!params || typeof params !== "object") return out;
+  const seen = {};
+  for (const id of Object.keys(values)) put(seen, id, values[id]);
+  for (const block of definition.blocks) {
+    if (!isChoice(block)) continue;
+    const setting = prefillSetting(block);
+    if (!setting || own(seen, block.id) !== void 0) continue;
+    const raw = paramValues(params, setting.param);
+    if (!raw.length) continue;
+    const shown2 = new Set(visibleOptions(definition, block, seen).map((o) => o.value));
+    let value;
+    if (block.type === "multi-choice") {
+      const picked = [];
+      for (const r of raw) {
+        for (const v of shown2.has(r) ? [r] : r.split(",").map((s) => s.trim())) {
+          if (shown2.has(v) && !picked.includes(v)) picked.push(v);
+        }
+      }
+      if (picked.length) value = picked;
+    } else value = raw.find((v) => shown2.has(v));
+    if (value === void 0) continue;
+    put(out, block.id, value);
+    put(seen, block.id, value);
+  }
+  return out;
+}
+function hiddenByPrefill(definition, state) {
+  const hideable = /* @__PURE__ */ new Set();
+  for (const b of definition.blocks) {
+    if (isChoice(b) && prefillSetting(b)?.hideWhenPrefilled) hideable.add(b.id);
+  }
+  if (!hideable.size) return [];
+  const prefilled = /* @__PURE__ */ new Set();
+  for (const e of state.events) {
+    if (e.type !== "answer" || !hideable.has(e.field)) continue;
+    if (e.source === "prefill") prefilled.add(e.field);
+    else prefilled.delete(e.field);
+  }
+  if (!prefilled.size) return [];
+  const fields = new Map(definition.blocks.map((b) => [b.id, b]));
+  return state.path.filter((id) => {
+    if (!prefilled.has(id) || own(state.errors, id) !== void 0) return false;
+    const field = fields.get(id);
+    return !isEmptyValue(own(state.values, id), field);
+  });
+}
+
 // src/recall.ts
 var TOKEN = /\{\{\s*(field|hidden):([A-Za-z0-9_-]+)\s*(?:\|([^}]*))?\}\}/g;
 function recall(text, scope) {
@@ -1484,16 +1693,34 @@ function build(given, options, replaying = false, budget) {
     return at === void 0 ? event : { ...event, at };
   };
   const isVisibleIn = (s, id) => s.path.includes(id);
+  const filters = hasOptionFilters(definition);
+  const clearFiltered = (values, id) => filters ? clearFilteredAnswers(definition, values, id) : values;
   const errorsFor = (s, ids) => {
     const errors = {};
+    let shown2;
     for (const id of ids) {
       const field = fields.get(id);
       if (!field || !isVisibleIn(s, id)) continue;
-      const message = validateField(field, own(s.values, id), { custom: options.validators?.[id] });
+      const value = own(s.values, id);
+      let message = validateField(field, value, { custom: options.validators?.[id] });
+      if (!message && filters) message = filteredChoiceError(definition, field, value, shown2 ??= answersOnPath(s));
       if (message) errors[id] = message;
     }
     return errors;
   };
+  const skipped = (s) => new Set(hiddenByPrefill(definition, s));
+  const shownFrom = (s, from, skip) => {
+    for (let i = from; i < s.path.length; i++) if (!skip.has(s.path[i])) return s.path[i];
+    return void 0;
+  };
+  const showCurrent = () => {
+    if (!state.current) return;
+    const skip = skipped(state);
+    if (!skip.has(state.current)) return;
+    const at = state.path.indexOf(state.current);
+    const shown2 = at < 0 ? void 0 : shownFrom(state, at, skip);
+    if (shown2) state = { ...state, current: shown2, furthest: state.furthest === state.current ? shown2 : state.furthest };
+  };
   let unsettled = false;
   let formulasStale = false;
   const settleNow = (needValues = true) => {
@@ -1522,13 +1749,13 @@ function build(given, options, replaying = false, budget) {
     const errors = { ...state.errors };
     delete errors[id];
     if (batch) {
-      state.values = { ...state.values, [id]: value };
+      state.values = clearFiltered({ ...state.values, [id]: value }, id);
       state.errors = errors;
       log(event);
       unsettled = true;
       return;
     }
-    const { values, path } = settle({ ...state.values, [id]: value }, state.hidden);
+    const { values, path } = settle(clearFiltered({ ...state.values, [id]: value }, id), state.hidden);
     emit({ ...state, values, path, errors, events: log(event) });
   };
   const engine = {
@@ -1559,7 +1786,7 @@ function build(given, options, replaying = false, budget) {
         return false;
       }
       const at = state.path.indexOf(state.current);
-      const target = state.path[at + 1];
+      const target = shownFrom(state, at + 1, skipped(state));
       if (!target) {
         emit({ ...state, events });
         return true;
@@ -1571,8 +1798,9 @@ function build(given, options, replaying = false, budget) {
     back() {
       if (state.status === "completed") return;
       const history = [...state.history];
+      const skip = skipped(state);
       let previous = history.pop();
-      while (previous && !state.path.includes(previous)) previous = history.pop();
+      while (previous && (!state.path.includes(previous) || skip.has(previous))) previous = history.pop();
       if (!previous) return;
       emit({ ...state, current: previous, history, events: log(stamp({ type: "back" })) });
     },
@@ -1600,15 +1828,18 @@ function build(given, options, replaying = false, budget) {
       return out;
     }
   };
-  if (options.initialValues) {
+  const fromLink = options.linkParams ? prefillFromLink(definition, options.linkParams, options.initialValues) : {};
+  const initialValues = Object.keys(fromLink).length ? { ...fromLink, ...options.initialValues } : options.initialValues;
+  if (initialValues) {
     const wasBatch = batch;
     batch = true;
-    for (const [id, value] of Object.entries(options.initialValues)) {
+    for (const [id, value] of Object.entries(initialValues)) {
       if (!fields.has(id) || value === void 0) continue;
       answer(id, value, stamp({ type: "answer", field: id, value, source: "prefill" }));
     }
     settleNow();
     batch = wasBatch;
+    showCurrent();
   }
   const resumeAt = options.resumeAt;
   if (resumeAt && !replaying && state.path.includes(resumeAt)) {
@@ -1627,18 +1858,22 @@ function build(given, options, replaying = false, budget) {
       }
     } else if (event.type === "next") {
       settleNow(false);
+      showCurrent();
       if (formulasStale && isCalculated(fields.get(state.current ?? ""))) settleNow(true);
       engine.next();
     } else if (event.type === "back") {
       settleNow(false);
+      showCurrent();
       engine.back();
     } else if (event.type === "submit") {
       settleNow();
+      showCurrent();
       engine.submit();
     }
   };
   const finish = () => {
     settleNow();
+    showCurrent();
     batch = false;
     state = { ...state, events: [...state.events] };
   };
@@ -1649,7 +1884,12 @@ function replay(definition, events, options = {}) {
 }
 function replayWithin(definition, events, options, maxWork) {
   const budget = maxWork === void 0 ? void 0 : { used: 0, max: maxWork };
-  const { engine, apply, finish } = build(definition, { ...options, initialValues: void 0, clock: () => void 0 }, true, budget);
+  const { engine, apply, finish } = build(
+    definition,
+    { ...options, initialValues: void 0, linkParams: void 0, clock: () => void 0 },
+    true,
+    budget
+  );
   try {
     for (const event of events) apply(event);
     finish();
@@ -1900,6 +2140,31 @@ function parseForm(input) {
   const optionalBoolean = (v, path) => {
     if (v !== void 0 && typeof v !== "boolean") issue(path, "Must be true or false.");
   };
+  const optionDetails = (o, at) => {
+    if (o.description !== void 0 && (typeof o.description !== "string" || o.description.length > OPTION_LIMITS.description)) {
+      issue(`${at}.description`, `Must be text of at most ${OPTION_LIMITS.description} characters.`);
+    }
+    if (o.image !== void 0 && !isHttpsUrl(o.image)) {
+      issue(`${at}.image`, `Must be an https:// link of at most ${OPTION_LIMITS.image} characters.`);
+    }
+    if (o.attributes === void 0) return;
+    const attributes = o.attributes;
+    if (!isObject2(attributes) || Object.keys(attributes).length > OPTION_LIMITS.attributes) {
+      issue(`${at}.attributes`, `Must be an object of at most ${OPTION_LIMITS.attributes} attributes.`);
+      return;
+    }
+    const fits = (x) => typeof x === "string" && x.length <= OPTION_LIMITS.attributeValue;
+    for (const [name2, v] of Object.entries(attributes)) {
+      if (!name2.trim() || name2.length > OPTION_LIMITS.attributeName || RESERVED.has(name2)) {
+        issue(`${at}.attributes`, `${shown(name2)} isn't a usable attribute name (at most ${OPTION_LIMITS.attributeName} characters).`);
+      } else if (!fits(v) && !(Array.isArray(v) && v.length <= OPTION_LIMITS.attributeItems && v.every(fits))) {
+        issue(
+          `${at}.attributes.${name2}`,
+          `Must be text, or a list of at most ${OPTION_LIMITS.attributeItems} texts, each at most ${OPTION_LIMITS.attributeValue} characters.`
+        );
+      }
+    }
+  };
   const name = (v, path, what) => {
     if (typeof v !== "string" || !v) {
       issue(path, `${what} must be a non-empty string.`);
@@ -2072,7 +2337,31 @@ function parseForm(input) {
           } else if (typeof block.type === "string" && !CHOICE_TYPES.has(block.type)) {
             warnings.push({ path: `${path}.props.optionsFrom`, message: "Only single choice, multiple choice and dropdown questions take options from the app." });
           }
+          const filter = isObject2(from) ? from.filter : void 0;
+          if (filter !== void 0) {
+            const at = `${path}.props.optionsFrom.filter`;
+            if (!isObject2(filter) || typeof filter.attribute !== "string" || !filter.attribute || filter.attribute.length > OPTION_LIMITS.attributeName || typeof filter.field !== "string" || !filter.field) {
+              issue(at, `Must be { attribute, field }: an attribute name (at most ${OPTION_LIMITS.attributeName} characters) and an earlier question's key.`);
+            } else if (!keys.has(filter.field)) {
+              issue(`${at}.field`, `"${filter.field}" must be the key of an earlier question.`);
+            }
+          }
+        }
+        const prefill = isObject2(block.props) ? block.props.prefill : void 0;
+        if (prefill !== void 0) {
+          if (!isObject2(prefill) || !isPrefillParam(prefill.param)) {
+            issue(
+              `${path}.props.prefill`,
+              `Must be { param, hideWhenPrefilled? }: a link parameter of letters, digits, "_", "-" or "." (at most ${MAX_PREFILL_PARAM_LENGTH} characters).`
+            );
+          } else {
+            optionalBoolean(prefill.hideWhenPrefilled, `${path}.props.prefill.hideWhenPrefilled`);
+            if (typeof block.type === "string" && !CHOICE_TYPES.has(block.type)) {
+              warnings.push({ path: `${path}.props.prefill`, message: "Only single choice, multiple choice and dropdown questions are filled in from a link." });
+            }
+          }
         }
+        if (isObject2(block.props)) optionalBoolean(block.props.searchable, `${path}.props.searchable`);
         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;
@@ -2081,7 +2370,10 @@ function parseForm(input) {
             options.forEach((o, j) => {
               const at = `${path}.props.options[${j}]`;
               if (!isObject2(o) || typeof o.value !== "string") issue(at, "Each option needs a string value.");
-              else optionalText(o.label, `${at}.label`);
+              else {
+                optionalText(o.label, `${at}.label`);
+                optionDetails(o, at);
+              }
             });
             if (from === void 0) {
               choices.set(
@@ -2511,11 +2803,12 @@ function validateSubmission(published, submission, options = {}) {
     }
   } else {
     const errors = {};
-    for (const [id, value] of Object.entries(engine.answers())) {
+    const kept = engine.answers();
+    for (const [id, value] of Object.entries(kept)) {
       const message = validateField(fields.get(id), value, {
         requireAnswers: false,
         custom: options.validators?.[id]
-      });
+      }) ?? filteredChoiceError(definition, fields.get(id), value, kept);
       if (message) errors[id] = message;
     }
     if (Object.keys(errors).length) return { ok: false, errors };