@tokenoftrust/storefront-runner 2.2.99 → 2.2.100

package/apps/storefront/src/lib/diag/capture.ts

@@ -55,6 +55,7 @@ export const CAPTURABLE_PROBLEM_CODES: readonly string[] = Object.freeze([
   "not-ready",
   "delivery-undeliverable",
   "checks-blocked",
+  "compliance-review",
 ]);
 
 /** A captured event, after the allowlist has had its say. Every variant is closed-vocabulary. */

package/apps/storefront/src/lib/diag/report.ts

@@ -62,6 +62,7 @@ function severityFor(code: string | null | undefined): DiagnosticReport["severit
     case "bundle-unavailable":
       return "critical";
     case "checks-blocked":
+    case "compliance-review":
     case "needs-confirmation":
     case "not-ready":
       return "medium";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tokenoftrust/storefront-runner",
-  "version": "2.2.99",
+  "version": "2.2.100",
   "license": "SEE LICENSE IN LICENSE",
   "description": "World-shareable storefront runner: multi-tenant renderer on Astro/Cloudflare. No control plane.",
   "packageManager": "pnpm@11.9.0",

package/packages/cli/src/declared-config.mjs

@@ -1,12 +1,18 @@
 /**
- * The `.tot/config.json` keys the platform reads, and the refusal of everything
- * else. Shared by `tot validate` (src/validate.mjs) and the monorepo/dev-loop
- * validator (scripts/tenant/validate.mjs), so both refuse the same keys.
+ * The `.tot/config.json` keys the platform reads, and what happens to everything else.
+ * Shared by `tot validate` (src/validate.mjs), the monorepo/dev-loop validator
+ * (scripts/tenant/validate.mjs), the hosted reconcile, and the publication validator
+ * (scripts/publish/validate-bundle.mjs), so every surface says the same thing.
+ *
+ * An unknown key is the store owner's to decide about: it is reported as a WARNING the
+ * owner must approve before publication, naming the nearest key the platform does read
+ * and what will not render because of it. A wrong-shaped value of a known key (a
+ * `siteType` that is not a site type, a `compliance` that is not an object) stays an
+ * error: there is no reading of it the platform could act on.
  *
  * Mirrors packages/public-runtime/src/declared-tenant-config.mjs (this package ships
- * to npm on its own); test/declared-config-parity.test.mjs pins the two together, so
- * a field the platform honors can never be refused here, and a key no surface reads
- * can never pass. Dependency-free: the storefront runner copies this file as-is.
+ * to npm on its own); test/declared-config-parity.test.mjs pins the two together.
+ * Dependency-free: the storefront runner copies this file as-is.
  */
 
 export const TOT_CONFIG_KEYS = [
@@ -24,7 +30,33 @@ export const FEATURE_KEYS = [
 ];
 export const SITE_TYPES = ["commerce", "marketing"];
 
+/** What each compliance key puts on the page — the thing that is missing when it is. */
+export const COMPLIANCE_NOTICES = {
+  ruleProfile: "checkout compliance rules",
+  minAge: "age gate",
+  nicotineWarning: "FDA nicotine warning",
+  shippingRestriction: "shipping-restriction notice",
+  pactAct: "PACT Act notice",
+  adultSignature: "adult-signature notice",
+  prop65: "California Prop 65 warning",
+  purchaseLimit: "purchase-limit notice",
+  stateEligibility: "state-eligibility notice",
+  exciseTax: "excise-tax notice",
+};
+
+/**
+ * The compliance keys that each turn on a mandated duty in the platform's obligation
+ * model (packages/public-runtime/src/compliance-obligations.ts). Dropping one between
+ * the live revision and the one being published removes a mandated notice from the
+ * site — a decision the owner must make explicitly.
+ */
+export const MANDATED_NOTICE_KEYS = [
+  "minAge", "nicotineWarning", "pactAct", "adultSignature", "prop65",
+  "stateEligibility", "shippingRestriction", "exciseTax",
+];
+
 const ERROR = "error";
+const WARN = "warn";
 const isObject = (v) => v !== null && typeof v === "object" && !Array.isArray(v);
 
 /** @typedef {{level:string, rule:string, file:string, message:string, fix?:string}} Finding */
@@ -32,43 +64,150 @@ function mk(level, rule, file, message, fix) {
   return { level, rule, file, message, fix };
 }
 
+/** Case-insensitive edit distance. */
+function distance(a, b) {
+  const s = a.toLowerCase();
+  const t = b.toLowerCase();
+  const row = Array.from({ length: t.length + 1 }, (_, j) => j);
+  for (let i = 1; i <= s.length; i++) {
+    let prev = row[0];
+    row[0] = i;
+    for (let j = 1; j <= t.length; j++) {
+      const cur = row[j];
+      row[j] = Math.min(row[j] + 1, row[j - 1] + 1, prev + (s[i - 1] === t[j - 1] ? 0 : 1));
+      prev = cur;
+    }
+  }
+  return row[t.length];
+}
+
 /**
- * Refuse what the platform would silently ignore: an unknown top-level key, an
- * unknown `compliance`/`features` key, or a declared field of the wrong shape. Each
- * one passes JSON parsing and renders nothing — on a regulated store that is a
- * mandated notice that never appears.
+ * The known key an unknown one most plausibly meant, or null when none is close.
+ * @param {string} key
+ * @param {readonly string[]} known
+ * @returns {string | null}
+ */
+export function nearestKey(key, known) {
+  let best = null;
+  let bestDistance = Infinity;
+  for (const candidate of known) {
+    const d = distance(key, candidate);
+    if (d < bestDistance) {
+      best = candidate;
+      bestDistance = d;
+    }
+  }
+  const lower = key.toLowerCase();
+  const near = best !== null && (bestDistance <= Math.max(2, Math.floor(best.length / 3)) ||
+    best.toLowerCase().startsWith(lower) || lower.startsWith(best.toLowerCase()));
+  return near ? best : null;
+}
+
+/**
+ * Every key in a `.tot/config.json` the platform does not read, with the key it most
+ * plausibly meant and the consequence. `path` is dotted (`compliance.nicotineWarnings`).
+ * @param {Record<string, any>} config
+ * @returns {{ path: string, suggestion: string | null, consequence: string }[]}
+ */
+export function unknownConfigKeys(config) {
+  const out = [];
+  for (const key of Object.keys(config)) {
+    if (TOT_CONFIG_KEYS.includes(key)) continue;
+    const suggestion = RENAMED_CONFIG_KEYS[/** @type {keyof typeof RENAMED_CONFIG_KEYS} */ (key)] ??
+      nearestKey(key, TOT_CONFIG_KEYS);
+    out.push({ path: key, suggestion, consequence: "the platform never reads it" });
+  }
+  /** @type {Array<[string, string[]]>} */
+  const objectFields = [["compliance", COMPLIANCE_KEYS], ["features", FEATURE_KEYS]];
+  for (const [field, known] of objectFields) {
+    const value = config[field];
+    if (!isObject(value)) continue;
+    for (const key of Object.keys(value)) {
+      if (known.includes(key)) continue;
+      const suggestion = nearestKey(key, known);
+      const notice = field === "compliance" && suggestion && !(suggestion in value)
+        ? COMPLIANCE_NOTICES[/** @type {keyof typeof COMPLIANCE_NOTICES} */ (suggestion)]
+        : null;
+      out.push({
+        path: `${field}.${key}`,
+        suggestion: suggestion ? `${field}.${suggestion}` : null,
+        consequence: notice
+          ? `this setting does nothing — your ${notice} will NOT render`
+          : "this setting does nothing",
+      });
+    }
+  }
+  return out;
+}
+
+/** The one-line, owner-facing sentence for an unknown key. */
+function unknownKeyMessage({ path, suggestion, consequence }) {
+  return `\`${path}\` is not a .tot/config.json key${suggestion ? ` — did you mean \`${suggestion}\`?` : ""} ` +
+    `${consequence.charAt(0).toUpperCase()}${consequence.slice(1)}.`;
+}
+
+/**
+ * The mandated notices the live revision declared that this one no longer does.
+ * @param {Record<string, any> | null | undefined} previous the live revision's `.tot/config.json`
+ * @param {Record<string, any> | null | undefined} current this revision's `.tot/config.json`
+ * @returns {{ key: string, notice: string }[]}
+ */
+export function droppedMandatedNotices(previous, current) {
+  const before = isObject(previous?.compliance) ? previous.compliance : {};
+  const now = isObject(current?.compliance) ? current.compliance : {};
+  return MANDATED_NOTICE_KEYS
+    .filter((key) => Boolean(before[key]) && !now[key])
+    .map((key) => ({ key, notice: COMPLIANCE_NOTICES[/** @type {keyof typeof COMPLIANCE_NOTICES} */ (key)] }));
+}
+
+/**
+ * The publication validator's findings for a revision's declaration: an owner-approvable
+ * `CONFIG:` finding per unknown key and a `COMPLIANCE:` finding per mandated notice the
+ * live site shows and this revision drops. Both are QUALITY findings
+ * (scripts/publish/lib/finding-severity.mjs): publication halts until the owner accepts
+ * them through "Accept issue & continue".
+ * @param {Record<string, any> | null | undefined} current
+ * @param {Record<string, any> | null | undefined} previous
+ * @returns {string[]}
+ */
+export function declarationFindings(current, previous) {
+  const out = [];
+  if (isObject(current)) {
+    for (const unknown of unknownConfigKeys(current)) out.push(`CONFIG: ${unknownKeyMessage(unknown)}`);
+  }
+  for (const { key, notice } of droppedMandatedNotices(previous, current)) {
+    out.push(
+      `COMPLIANCE: the live site shows the ${notice} (\`compliance.${key}\`) and this revision no longer ` +
+        `declares it — publishing removes a mandated notice from the store.`,
+    );
+  }
+  return out;
+}
+
+/**
+ * The validator's report on a `.tot/config.json`: a WARNING per unknown key (owner-approved
+ * before publication), an error per wrong-shaped value of a known key.
  * @param {Record<string, any>} config parsed `.tot/config.json` (an object)
  * @param {string} [file]
  * @returns {Finding[]}
  */
 export function validateDeclaredConfig(config, file = ".tot/config.json") {
   const out = [];
-  for (const key of Object.keys(config)) {
-    if (!TOT_CONFIG_KEYS.includes(key)) {
-      const renamed = RENAMED_CONFIG_KEYS[/** @type {keyof typeof RENAMED_CONFIG_KEYS} */ (key)];
-      out.push(mk(ERROR, "config-unknown-key", file,
-        `\`${key}\` is not a .tot/config.json key — the platform never reads it`,
-        renamed ? `use \`${renamed}\`` : `known keys: ${TOT_CONFIG_KEYS.join(", ")}`));
-    }
+  for (const unknown of unknownConfigKeys(config)) {
+    const nested = unknown.path.includes(".");
+    out.push(mk(WARN, nested ? `config-${unknown.path.split(".")[0]}-unknown-key` : "config-unknown-key",
+      nested ? `${file} ${unknown.path.split(".")[0]}` : file,
+      unknownKeyMessage(unknown),
+      unknown.suggestion
+        ? `rename it to \`${unknown.suggestion}\`, or keep it and approve the warning when you publish`
+        : "remove it, or keep it and approve the warning when you publish"));
   }
   if (config.siteType !== undefined && !SITE_TYPES.includes(config.siteType)) {
     out.push(mk(ERROR, "config-site-type", file, `\`siteType\` is "${config.siteType}" — must be one of ${SITE_TYPES.join(", ")}`));
   }
-  /** @type {Array<[string, string[]]>} */
-  const objectFields = [["compliance", COMPLIANCE_KEYS], ["features", FEATURE_KEYS]];
-  for (const [field, known] of objectFields) {
-    const value = config[field];
-    if (value === undefined) continue;
-    if (!isObject(value)) {
+  for (const field of ["compliance", "features"]) {
+    if (config[field] !== undefined && !isObject(config[field])) {
       out.push(mk(ERROR, `config-${field}`, file, `\`${field}\` must be an object`));
-      continue;
-    }
-    for (const key of Object.keys(value)) {
-      if (!known.includes(key)) {
-        out.push(mk(ERROR, `config-${field}-unknown-key`, `${file} ${field}`,
-          `\`${field}.${key}\` is not a ${field} key — nothing renders from it`,
-          `known keys: ${known.join(", ")}`));
-      }
     }
   }
   if (config.capabilities !== undefined && !isObject(config.capabilities)) {

package/scripts/tenant/validate.mjs

@@ -271,6 +271,7 @@ function validateCapabilitiesDoc(doc, file, config) {
     return [mk(ERROR, "capabilities-root", file, "capabilities must be a JSON object")];
   }
   for (const [key, value] of Object.entries(doc)) {
+    if (key === "$schema") continue; // an editor's schema hint, which the devkit tells stores to add
     if (!CAPABILITY_KEYS.has(key)) {
       out.push(mk(ERROR, "capability-unknown", file, `unknown capability "${key}"`));
       continue;