@refrakt-md/cli 0.34.0 → 0.36.0

package/dist/lib/schema-row.js

@@ -0,0 +1,149 @@
+import { findByName } from '@refrakt-md/runes';
+/**
+ * Find sources the rune's rendered output does not provide.
+ *
+ * Mechanically checkable, unlike a wrong schema.org type — which is exactly why
+ * it is worth a tool. A table naming a `data-name` the rune never emits is the
+ * failure mode WORK-561 exists to prevent and that every later migration can
+ * reintroduce, and it fails *silently*: the property is simply absent from the
+ * published graph.
+ *
+ * A source resolves if a node carries the name, or if the field bag has it —
+ * the same two routes the applier has, checked the same way.
+ */
+export function auditSchemaSources(row, tree, declaredAttributes = []) {
+    const bag = collectBags(tree);
+    // A source is resolvable if the rune *can* emit it, not merely if this one
+    // fixture did. An optional attribute the fixture leaves unset — `rating` on
+    // `testimonial` — produces no node and no bag entry, and flagging that would
+    // report the table as broken when it is correct and the input is simply
+    // minimal. Matching the rune's declared attributes is what separates "this
+    // input did not exercise it" from the failure mode actually worth catching:
+    // a source name that is a typo or a rename, which resolves to nothing ever.
+    const declared = new Set();
+    for (const name of declaredAttributes) {
+        declared.add(name);
+        declared.add(kebab(name));
+    }
+    // The child keys this row retypes. A parent source must not be judged
+    // resolved by a stamp that a *child* row produced: `playlist` maps `headline`
+    // and its items map `track-name`, both to `name`, and looking at the whole
+    // tree would let either cover for the other's typo.
+    const childNames = new Set(row.children.map((c) => c.rune));
+    const unresolved = [];
+    for (const entry of row.properties) {
+        // A generated value has no source to resolve — that is what makes it
+        // generated.
+        if (entry.kind === 'generated')
+            continue;
+        // A `children:` mapping names sources on nodes *another rune* emitted, with
+        // their own attributes and their own bag. Auditing those against this
+        // rune's tree and this rune's declared attributes reports every one of them
+        // as broken — which is how a check stops being read. Resolve them against
+        // the children themselves, and say nothing when the input contains none:
+        // that is "this fixture did not exercise it", not "this row is wrong".
+        if (entry.scope === 'child' && entry.entity) {
+            const children = findChildren(tree, entry.entity);
+            if (children.length === 0)
+                continue;
+            // The most direct evidence there is: the property this row maps to is
+            // stamped on the child, so the source resolved to *something*. The
+            // applier clears a retyped child's stamps before re-applying, so
+            // anything present came from this row.
+            if (children.some((c) => hasProperty(c, entry.property, childNames)))
+                continue;
+            if (children.some((c) => findByName(c, entry.source)))
+                continue;
+            if (children.some((c) => Object.hasOwn(collectBags(c), entry.source)))
+                continue;
+            unresolved.push({ source: entry.source, property: entry.property, entity: entry.entity });
+            continue;
+        }
+        // The same evidence for the rune's own sources, and for a rebuilt one it is
+        // the only evidence left: the identity transform consumes
+        // `data-rune-fields`, and this audit reads the rendered tree, so a source
+        // the applier recovered from the bag leaves no trace of the bag behind —
+        // only the carrier it built. Children are excluded, per `childNames`.
+        if (hasProperty(tree, entry.property, childNames))
+            continue;
+        if (findByName(tree, entry.source))
+            continue;
+        if (Object.hasOwn(bag, entry.source))
+            continue;
+        if (declared.has(entry.source) || declared.has(kebab(entry.source)))
+            continue;
+        unresolved.push({ source: entry.source, property: entry.property, entity: entry.entity });
+    }
+    return unresolved;
+}
+/**
+ * Does any node in this subtree carry `property="<name>"`?
+ *
+ * `skip` names child keys whose subtrees are somebody else's row to answer for;
+ * a node matching one is not descended into, and is itself skipped unless it is
+ * the subtree being asked about.
+ */
+function hasProperty(node, property, skip = new Set(), top = true) {
+    if (Array.isArray(node))
+        return node.some((c) => hasProperty(c, property, skip, top));
+    if (!node || typeof node !== 'object')
+        return false;
+    const attrs = node.attributes ?? {};
+    if (!top && skip.size > 0 && isChildOf(attrs, skip))
+        return false;
+    if (attrs.property === property)
+        return true;
+    return (node.children ?? []).some((c) => hasProperty(c, property, skip, false));
+}
+const isChildOf = (attrs, names) => names.has(attrs['data-rune']) ||
+    names.has(attrs['data-name']) ||
+    names.has(attrs['data-field']);
+/**
+ * The nodes a `children:` row applies to — the same match the applier makes.
+ *
+ * Kept in step with `findChildren` in the applier deliberately: an audit that
+ * looked in different nodes than the mechanism does would report on a population
+ * nobody maps.
+ */
+function findChildren(node, name, out = []) {
+    if (Array.isArray(node)) {
+        for (const c of node)
+            findChildren(c, name, out);
+        return out;
+    }
+    if (!node || typeof node !== 'object')
+        return out;
+    const attrs = node.attributes ?? {};
+    if (attrs['data-rune'] === name || attrs['data-name'] === name || attrs['data-field'] === name) {
+        out.push(node);
+    }
+    for (const c of node.children ?? [])
+        findChildren(c, name, out);
+    return out;
+}
+const kebab = (s) => s.replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase();
+/** Every `data-rune-fields` bag in the tree, merged. */
+function collectBags(node, into = {}) {
+    if (Array.isArray(node)) {
+        for (const child of node)
+            collectBags(child, into);
+        return into;
+    }
+    if (!node || typeof node !== 'object')
+        return into;
+    const attrs = node.attributes;
+    const raw = attrs?.['data-rune-fields'];
+    if (typeof raw === 'string') {
+        try {
+            Object.assign(into, JSON.parse(raw));
+        }
+        catch {
+            // A malformed bag is a defect elsewhere; the audit reports the sources
+            // it could not resolve either way.
+        }
+    }
+    for (const child of node.children ?? [])
+        collectBags(child, into);
+    return into;
+}
+//# sourceMappingURL=schema-row.js.map

package/dist/lib/schema-row.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-row.js","sourceRoot":"","sources":["../../src/lib/schema-row.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAkB/C;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,kBAAkB,CACjC,GAAsB,EACtB,IAAa,EACb,qBAA+B,EAAE;IAEjC,MAAM,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B,2EAA2E;IAC3E,4EAA4E;IAC5E,6EAA6E;IAC7E,wEAAwE;IACxE,2EAA2E;IAC3E,4EAA4E;IAC5E,4EAA4E;IAC5E,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE,CAAC;QACvC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnB,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED,sEAAsE;IACtE,8EAA8E;IAC9E,2EAA2E;IAC3E,oDAAoD;IACpD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE5D,MAAM,UAAU,GAAuB,EAAE,CAAC;IAC1C,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;QACpC,qEAAqE;QACrE,aAAa;QACb,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW;YAAE,SAAS;QAEzC,4EAA4E;QAC5E,sEAAsE;QACtE,4EAA4E;QAC5E,0EAA0E;QAC1E,yEAAyE;QACzE,uEAAuE;QACvE,IAAI,KAAK,CAAC,KAAK,KAAK,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YAC7C,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAClD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YACpC,sEAAsE;YACtE,mEAAmE;YACnE,iEAAiE;YACjE,uCAAuC;YACvC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;gBAAE,SAAS;YAC/E,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAAE,SAAS;YACzE,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAAE,SAAS;YAChF,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YAC1F,SAAS;QACV,CAAC;QAED,4EAA4E;QAC5E,0DAA0D;QAC1D,0EAA0E;QAC1E,yEAAyE;QACzE,sEAAsE;QACtE,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,UAAU,CAAC;YAAE,SAAS;QAC5D,IAAI,UAAU,CAAC,IAAa,EAAE,KAAK,CAAC,MAAM,CAAC;YAAE,SAAS;QACtD,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;YAAE,SAAS;QAC/C,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAAE,SAAS;QAC9E,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3F,CAAC;IACD,OAAO,UAAU,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CACnB,IAAa,EACb,QAAgB,EAChB,OAAO,IAAI,GAAG,EAAU,EACxB,GAAG,GAAG,IAAI;IAEV,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IACtF,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACpD,MAAM,KAAK,GAAI,IAAiD,CAAC,UAAU,IAAI,EAAE,CAAC;IAClF,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAClE,IAAI,KAAK,CAAC,QAAQ,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC7C,OAAO,CAAE,IAAiC,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACrE,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CACrC,CAAC;AACH,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,KAA8B,EAAE,KAAkB,EAAE,EAAE,CACxE,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAW,CAAC;IACvC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAW,CAAC;IACvC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAW,CAAC,CAAC;AAE1C;;;;;;GAMG;AACH,SAAS,YAAY,CAAC,IAAa,EAAE,IAAY,EAAE,MAAiB,EAAE;IACrE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,CAAC,IAAI,IAAI;YAAE,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACjD,OAAO,GAAG,CAAC;IACZ,CAAC;IACD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC;IAClD,MAAM,KAAK,GAAI,IAAiD,CAAC,UAAU,IAAI,EAAE,CAAC;IAClF,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE,CAAC;QAChG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;IACD,KAAK,MAAM,CAAC,IAAK,IAAiC,CAAC,QAAQ,IAAI,EAAE;QAAE,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IAC9F,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;AAEpF,wDAAwD;AACxD,SAAS,WAAW,CAAC,IAAa,EAAE,OAAgC,EAAE;IACrE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,IAAI;YAAE,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC;IACb,CAAC;IACD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACnD,MAAM,KAAK,GAAI,IAAiD,CAAC,UAAU,CAAC;IAC5E,MAAM,GAAG,GAAG,KAAK,EAAE,CAAC,kBAAkB,CAAC,CAAC;IACxC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC7B,IAAI,CAAC;YACJ,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QACtC,CAAC;QAAC,MAAM,CAAC;YACR,uEAAuE;YACvE,mCAAmC;QACpC,CAAC;IACF,CAAC;IACD,KAAK,MAAM,KAAK,IAAK,IAAiC,CAAC,QAAQ,IAAI,EAAE;QAAE,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAChG,OAAO,IAAI,CAAC;AACb,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@refrakt-md/cli",
   "description": "CLI tools for refrakt.md",
-  "version": "0.34.0",
+  "version": "0.36.0",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -26,6 +26,10 @@
     "./lib/levenshtein.js": {
       "types": "./dist/lib/levenshtein.d.ts",
       "default": "./dist/lib/levenshtein.js"
+    },
+    "./validate.js": {
+      "types": "./dist/commands/validate-core.d.ts",
+      "default": "./dist/commands/validate-core.js"
     }
   },
   "files": [
@@ -36,11 +40,11 @@
   },
   "dependencies": {
     "@markdoc/markdoc": "0.4.0",
-    "@refrakt-md/ai": "0.34.0",
-    "@refrakt-md/editor": "0.34.0",
-    "@refrakt-md/html": "0.34.0",
-    "@refrakt-md/runes": "0.34.0",
-    "@refrakt-md/transform": "0.34.0",
+    "@refrakt-md/ai": "0.36.0",
+    "@refrakt-md/editor": "0.36.0",
+    "@refrakt-md/html": "0.36.0",
+    "@refrakt-md/runes": "0.36.0",
+    "@refrakt-md/transform": "0.36.0",
     "esbuild": "^0.27.5",
     "postcss": "^8.4.0"
   }