@cruba/crubal 0.0.0-stage → 0.2.0

package/dist/src/review.js

@@ -0,0 +1,198 @@
+// review.ts: review decisions as writes (spec 9.5, 10.4, 11.9, 14.7; docs/design/completion.md A). A
+// decision is one entry: the `review` write that records it, and the writes it causes: a `define` of the
+// facet, contract or units extension it changed, a value made current from a suggestion or a held bag, a
+// suggestion denied. Nothing here replays or runs; a store does that after the entry lands.
+import { contractJson } from "./bundle.js";
+import { facetJson } from "./dictionary.js";
+import { split } from "./lifecycle.js";
+import { CrubalError } from "./tree.js";
+import { extendUnits } from "./units.js";
+const isObj = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
+/** The units extension as text, for the units table (11.9). */
+export function unitsExtensionText(measures) {
+    return measures
+        .map((m) => {
+        const lines = [`measure: ${m.measure}`];
+        for (const k of ["dimension", "factor", "offset", "rounding", "uncefact"])
+            if (m[k] !== undefined)
+                lines.push(`  ${k}: ${m[k]}`);
+        if (Array.isArray(m.spellings) && m.spellings.length)
+            lines.push(`  spellings: ${m.spellings.join(", ")}`);
+        return lines.join("\n");
+    })
+        .join("\n");
+}
+/**
+ * Apply a decision to the draft and return the writes the entry carries beyond what the draft shows:
+ * the review write and any define. Throws a CrubalError for a decision that can't be made.
+ */
+export function decide(d, store, defs) {
+    const review = { ...d };
+    const key = d.key;
+    if (key.startsWith("facet:")) {
+        const f = defs.dict.facets.get(key.slice(6));
+        if (!f)
+            throw new CrubalError(`${key}: no such facet`);
+        const next = { ...f, values: f.values ? f.values.map((v) => ({ ...v, aliases: [...v.aliases] })) : f.values, aliases: [...f.aliases] };
+        if (d.decision === "add value") {
+            if (!next.values)
+                throw new CrubalError(`${key} isn't a choice`);
+            if (next.values.some((v) => v.value === d.value))
+                throw new CrubalError(`${d.value} is already a value of ${f.key}`);
+            next.values.push({ value: String(d.value), aliases: [] });
+        }
+        else if (d.decision === "add alias") {
+            if (!next.values)
+                throw new CrubalError(`${key} isn't a choice`);
+            const v = next.values.find((x) => x.value === d.value);
+            if (!v)
+                throw new CrubalError(`${d.value} is not a value of ${f.key}`);
+            v.aliases.push(String(d.alias));
+        }
+        else if (d.decision !== "reject")
+            throw new CrubalError(`${key}: ${d.decision} isn't a decision`);
+        if (d.decision === "reject")
+            return [{ review }];
+        defs.dict.facets.set(f.key, next);
+        return [{ review }, { define: facetJson(next) }];
+    }
+    if (key.startsWith("contract:")) {
+        const c = defs.contracts.get(key.slice(9));
+        if (!c)
+            throw new CrubalError(`${key}: no such contract`);
+        const next = { ...c, reads: c.reads.map((m) => ({ ...m, values: [...m.values] })), ignore: [...c.ignore] };
+        const field = String(d.field);
+        if (d.decision === "map") {
+            if (!defs.dict.facets.has(String(d.to)) && !String(d.to).includes(":"))
+                throw new CrubalError(`${d.to} isn't a facet`);
+            next.reads.push({ from: field, to: String(d.to), values: [], line: c.line, valueLines: [] });
+        }
+        else if (d.decision === "map value") {
+            const m = next.reads.find((x) => x.from === field);
+            if (!m)
+                throw new CrubalError(`${c.name} doesn't read ${field}`);
+            m.values.push([String(d.theirs), String(d.ours)]);
+        }
+        else if (d.decision === "ignore")
+            next.ignore.push(field);
+        else
+            throw new CrubalError(`${key}: ${d.decision} isn't a decision`);
+        defs.contracts.set(c.name, next);
+        return [{ review }, { define: contractJson(next) }];
+    }
+    if (key.startsWith("unit:")) {
+        const spelling = key.slice(5);
+        const measures = [...(defs.units ?? [])];
+        if (d.decision === "alias") {
+            const have = measures.find((m) => m.measure === d.unit);
+            if (have)
+                have.spellings = [...(have.spellings ?? []), spelling];
+            else
+                measures.push({ measure: String(d.unit), spellings: [spelling] });
+        }
+        else if (d.decision === "new unit") {
+            const m = { measure: String(d.unit), dimension: String(d.dimension), factor: String(d.factor), spellings: [spelling] };
+            if (d.offset !== undefined)
+                m.offset = String(d.offset);
+            measures.push(m);
+        }
+        else if (d.decision === "not a unit")
+            return [{ review }];
+        else
+            throw new CrubalError(`${key}: ${d.decision} isn't a decision`);
+        defs.units = measures;
+        extendUnits(unitsExtensionText(measures));
+        const writes = [{ review }, { define: { units: "extension", measures } }];
+        // The facets that accept the unit from now on (4.2 `accepts`), each a define of its own.
+        for (const key of Array.isArray(d.accepts) ? d.accepts : []) {
+            const f = defs.dict.facets.get(key);
+            if (!f)
+                throw new CrubalError(`${key} isn't a facet`);
+            if (!f.unit)
+                throw new CrubalError(`${key} has no unit to accept ${d.unit} into`);
+            const unit = String(d.unit);
+            if (f.accepts.includes(unit))
+                continue;
+            const next = { ...f, accepts: [...f.accepts, unit] };
+            defs.dict.facets.set(key, next);
+            writes.push({ define: facetJson(next) });
+        }
+        return writes;
+    }
+    if (key === "suggestion") {
+        const r = store.records.get(String(d.record));
+        if (!r)
+            throw new CrubalError(`no record ${d.record}`);
+        const address = String(d.address);
+        const list = r.suggestions?.[address] ?? [];
+        const pick = d.value === undefined ? list[0] : list.find((s) => JSON.stringify(s.value) === JSON.stringify(d.value));
+        if (!pick)
+            throw new CrubalError(`${r.id} has no suggestion at ${address}${d.value !== undefined ? ` with that value` : ""}`);
+        const rest = list.filter((s) => s !== pick);
+        const suggestions = { ...(r.suggestions ?? {}) };
+        if (rest.length)
+            suggestions[address] = rest;
+        else
+            delete suggestions[address];
+        const next = { ...r, suggestions };
+        if (!Object.keys(suggestions).length)
+            delete next.suggestions;
+        if (d.decision === "accept") {
+            // The value with its original source (14.7).
+            const source = { origin: String(pick.origin ?? "reported"), via: String(pick.via ?? "") };
+            if (typeof pick.owner === "string")
+                source.owner = pick.owner;
+            next.values = { ...r.values, [address]: pick.value };
+            next.sources = { ...(r.sources ?? {}), [address]: source };
+        }
+        else if (d.decision !== "deny")
+            throw new CrubalError(`suggestion: ${d.decision} isn't a decision`);
+        store.records.set(r.id, next);
+        return [{ review: { ...review, value: pick.value, ...(d.decision === "deny" ? { denied: true } : {}) } }];
+    }
+    if (key === "held") {
+        const r = store.records.get(String(d.record));
+        if (!r)
+            throw new CrubalError(`no record ${d.record}`);
+        const address = String(d.address);
+        const h = r.held?.[address];
+        if (!h)
+            throw new CrubalError(`${r.id} holds nothing at ${address}`);
+        const held = { ...(r.held ?? {}) };
+        delete held[address];
+        const next = { ...r, held };
+        if (!Object.keys(held).length)
+            delete next.held;
+        if (d.decision === "value") {
+            const value = d.value === undefined ? h.value : d.value;
+            next.values = { ...r.values, [address]: value };
+            next.sources = { ...(r.sources ?? {}), [address]: (isObj(h.source) ? h.source : { origin: "declared", via: "review" }) };
+        }
+        else if (d.decision !== "drop")
+            throw new CrubalError(`held: ${d.decision} isn't a decision`);
+        store.records.set(r.id, next);
+        return [{ review }];
+    }
+    if (key.startsWith("split:")) {
+        const record = key.slice(6);
+        // The decision closes the item it answers: the same record, address and value (openItems).
+        if (review.record === undefined)
+            review.record = record;
+        if (d.decision === "not a version")
+            return [{ review }];
+        if (d.decision !== "split")
+            throw new CrubalError(`${key}: ${d.decision} isn't a decision`);
+        const instances = Array.isArray(d.instances) ? d.instances : [];
+        const values = typeof d.address === "string" && d.value !== undefined ? { [d.address]: d.value } : {};
+        split(store, record, String(d.into), { children: instances, values }, { origin: "observed", via: String(d.via ?? "review") });
+        return [{ review }];
+    }
+    throw new CrubalError(`${key}: not a review item kind a decision applies to here`);
+}
+/** The review items still open: every item without a decision that no later decision names. */
+export function openItems(items) {
+    const identity = (it) => JSON.stringify(["key", "record", "address", "run", "ref", "field", "value", "step"].map((k) => it[k] ?? null));
+    const decided = new Set(items.filter((it) => it.decision !== undefined).map(identity));
+    return items.filter((it) => it.decision === undefined && !decided.has(identity(it)));
+}
+//# sourceMappingURL=review.js.map

package/dist/src/review.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"review.js","sourceRoot":"","sources":["../../src/review.ts"],"names":[],"mappings":"AAAA,qGAAqG;AACrG,yGAAyG;AACzG,yGAAyG;AACzG,4FAA4F;AAE5F,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAc,MAAM,gBAAgB,CAAC;AAGnD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,KAAK,GAAG,CAAC,CAAmB,EAAmB,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAQjH,+DAA+D;AAC/D,MAAM,UAAU,kBAAkB,CAAC,QAAsB;IACvD,OAAO,QAAQ;SACZ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACxC,KAAK,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC;YAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS;gBAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACjI,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,MAAM;YAAE,KAAK,CAAC,IAAI,CAAC,gBAAiB,CAAC,CAAC,SAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzH,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAC,CAAW,EAAE,KAAY,EAAE,IAAiB;IACjE,MAAM,MAAM,GAAe,EAAE,GAAG,CAAC,EAAE,CAAC;IACpC,MAAM,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC;IAClB,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,iBAAiB,CAAC,CAAC;QACvD,MAAM,IAAI,GAAU,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9I,IAAI,CAAC,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,iBAAiB,CAAC,CAAC;YACjE,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,CAAC;gBAAE,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,0BAA0B,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;YACrH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC;aAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,iBAAiB,CAAC,CAAC;YACjE,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC;YACvD,IAAI,CAAC,CAAC;gBAAE,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,sBAAsB,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;YACvE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAClC,CAAC;aAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ;YAAE,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,QAAQ,mBAAmB,CAAC,CAAC;QACpG,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ;YAAE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAClC,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAChC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,oBAAoB,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAa,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACrH,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,CAAC,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAE,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;YACvH,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/F,CAAC;aAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC;YACnD,IAAI,CAAC,CAAC;gBAAE,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,iBAAiB,KAAK,EAAE,CAAC,CAAC;YACjE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;aAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ;YAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;YACvD,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,QAAQ,mBAAmB,CAAC,CAAC;QACrE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACjC,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,QAAQ,GAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;YACxD,IAAI,IAAI;gBAAE,IAAI,CAAC,SAAS,GAAG,CAAC,GAAG,CAAE,IAAI,CAAC,SAAsB,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;;gBAC1E,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACzE,CAAC;aAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACrC,MAAM,CAAC,GAAe,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;YACnI,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS;gBAAE,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YACxD,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACnB,CAAC;aAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,YAAY;YAAE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;;YACvD,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,QAAQ,mBAAmB,CAAC,CAAC;QACrE,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;QACtB,WAAW,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QACxF,yFAAyF;QACzF,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,OAAoB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YAC1E,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,CAAC,CAAC;gBAAE,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,gBAAgB,CAAC,CAAC;YACtD,IAAI,CAAC,CAAC,CAAC,IAAI;gBAAE,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,0BAA0B,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC;YAClF,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAAE,SAAS;YACvC,MAAM,IAAI,GAAU,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YAC5D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAsB,CAAC;QACnE,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QACvD,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAC5C,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACrH,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,yBAAyB,OAAO,GAAG,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC9H,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;QAC5C,MAAM,WAAW,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC,EAAE,CAAC;QACjD,IAAI,IAAI,CAAC,MAAM;YAAE,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;;YACxC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;QACjC,MAAM,IAAI,GAAU,EAAE,GAAG,CAAC,EAAE,WAAW,EAAE,CAAC;QAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC;QAC9D,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC5B,6CAA6C;YAC7C,MAAM,MAAM,GAAW,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,CAAC;YAClG,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;gBAAE,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;YAC9D,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,KAAa,EAAE,CAAC;YAC7D,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QAC7D,CAAC;aAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,MAAM;YAAE,MAAM,IAAI,WAAW,CAAC,eAAe,CAAC,CAAC,QAAQ,mBAAmB,CAAC,CAAC;QACtG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAa,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACpH,CAAC;IACD,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;QACnB,MAAM,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAsB,CAAC;QACnE,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QACvD,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,qBAAqB,OAAO,EAAE,CAAC,CAAC;QACrE,MAAM,IAAI,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;QACrB,MAAM,IAAI,GAAU,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,IAAI,CAAC;QAChD,IAAI,CAAC,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAE,CAAC,CAAC,KAAc,CAAC,CAAC,CAAE,CAAC,CAAC,KAAc,CAAC;YAC5E,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC;YAChD,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,MAA4B,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;QAClJ,CAAC;aAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,MAAM;YAAE,MAAM,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC,QAAQ,mBAAmB,CAAC,CAAC;QAChG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACtB,CAAC;IACD,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5B,2FAA2F;QAC3F,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;QACxD,IAAI,CAAC,CAAC,QAAQ,KAAK,eAAe;YAAE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACxD,IAAI,CAAC,CAAC,QAAQ,KAAK,OAAO;YAAE,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,QAAQ,mBAAmB,CAAC,CAAC;QAC5F,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,SAAsB,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9E,MAAM,MAAM,GAAe,OAAO,CAAC,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,KAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1H,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC9H,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACtB,CAAC;IACD,MAAM,IAAI,WAAW,CAAC,GAAG,GAAG,qDAAqD,CAAC,CAAC;AACrF,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,SAAS,CAAC,KAAmB;IAC3C,MAAM,QAAQ,GAAG,CAAC,EAAc,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;IACpJ,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvF,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACvF,CAAC"}

package/dist/src/rules.d.ts

@@ -0,0 +1,96 @@
+import { type Expr } from "./conditions.ts";
+import type { Dictionary, Facet } from "./defs.ts";
+import type { Json, JsonObject, Record } from "./model.ts";
+import type { RecordSet } from "./records.ts";
+export type Strength = "must" | "should" | "suggest";
+export type Rule = {
+    name: string;
+    line: number;
+    for: string;
+    when: Expr | null;
+    whenText: string;
+    thenText: string;
+    then: Expr | null;
+    strength: Strength;
+    because?: string;
+    version?: string;
+    /** A production: `key is <value | template | aggregate>`. */
+    produces?: {
+        key: string;
+        kind: "fill" | "template" | "rollup";
+        right: string;
+    };
+    /** Where it came from when it was expanded from a shortcut. */
+    shortcut?: boolean;
+};
+/** Read `rule:` blocks from definition text. */
+export declare function readRules(source: string): Rule[];
+/** The rules a facet's shortcut settings expand to (4.4). */
+export declare function shortcutRules(dict: Dictionary): Rule[];
+/** Check a rule set (6.8). Throws the first problem. */
+export declare function checkRules(rules: Rule[], dict: Dictionary): void;
+export type Result = {
+    record: string;
+    result: string;
+    address?: string;
+    value?: Json;
+    rule?: string;
+};
+export declare class Engine {
+    readonly dict: Dictionary;
+    readonly rules: Rule[];
+    /** The moment `now` means in conditions; unset means the clock's. */
+    now?: string;
+    private store;
+    private order;
+    /** The records a global rule reads (6.6), when the engine runs inside a store; else its own cache. */
+    private readonly records?;
+    constructor(dict: Dictionary, rules: Rule[], records?: () => RecordSet);
+    /** The values a record reads: its own over everything above it (1.7). */
+    effective(rec: Record): JsonObject;
+    private applies;
+    /** Whether any rollup here reads a lower level (`count of unit::…`): then a child's write concerns its ancestors. */
+    get readsLowerLevels(): boolean;
+    /** The chain up from a record along `of`, nearest first. */
+    ancestorsOf(id: string): string[];
+    private recordOf;
+    /** The records at a lower level under a record, along `of`, merged ones left out. */
+    private descendants;
+    /**
+     * Run the productions again for a record as it stands (6.4: recomputed whenever what it reads changes):
+     * what a store calls on the ancestors of a changed record, and on a record a plain write touched.
+     */
+    reproduce(id: string): Result[];
+    /** Where a produced key may be stored: the top of its chain, or a level where it varies. */
+    private storesAt;
+    private states;
+    /** A path a check tests, for reporting. */
+    private pathOf;
+    /** `is unique` compares records of the same level, and never one archived as merged (6.6). */
+    private uniqueClash;
+    /** Keep a record as it stands, without running the rules: how a store keeps the engine in step (7.4). */
+    put(rec: Record): void;
+    /** A record as the engine last left it: its values with what the rules produced, and the keys held. */
+    get(id: string): {
+        rec: Record;
+        produced: Set<string>;
+        held: Set<string>;
+    } | undefined;
+    /**
+     * Would this write break a `must` rule on a value it touches (6.2)? Nothing is stored. Intake uses it to
+     * park such a value as a contradiction citing the rule (9.3) instead of landing it.
+     */
+    probe(incoming: Record): Result | null;
+    /** Write a record (a create, or values merged onto one already stored). Returns its results. */
+    write(incoming: Record): Result[];
+    private layered;
+    /** A value's plain text in a template: the value itself, never quoted, without detail. */
+    private text;
+    /** A template (6.4.1): `{a}`, `{a ?? b}`, `{a?}`, `{{`, `}}`. Nothing when a needed value is empty. */
+    template(right: string, vals: JsonObject): string | undefined;
+    /** A rollup over parts (`worst of parts[*].condition`) or over a lower level (`count of unit::cashierfuId`). */
+    rollup(right: string, rec: Record): Json | undefined;
+    /** Completeness (6.9): asked facets with a value ÷ asked facets, per record and per part. */
+    completeness(rec: Record): Result[];
+}
+export type { Facet };