@agentshouse/mdmodel 0.1.0-c669bdbad8a03 → 0.1.0-c679f403bf3fb

package/dist/validate.js

@@ -60,8 +60,8 @@ function itemHrefs(content, items, uses) {
     }
     return hrefs;
 }
-export function verify(schema) {
-    const read = readSchema(schema);
+export function verify(schema, provided) {
+    const read = readSchema(schema, provided);
     if ('types' in read)
         return { verdict: 'accept', model: read };
     return {
@@ -120,7 +120,8 @@ function definitionOf(document, model) {
     const kind = instanceType(document);
     return kind === null || !Object.hasOwn(model.types, kind) ? undefined : model.types[kind];
 }
-export function checkDocument(file, content, model) {
+export function checkDocument(file, content, model, context = {}) {
+    const anyRoom = context.anyRoom === true;
     const parsed = parse(content, file);
     if (!parsed.ok)
         return { ok: false };
@@ -137,8 +138,8 @@ export function checkDocument(file, content, model) {
         type,
         typed: true,
         references: [
-            ...references(document, definition).flatMap(({ value, to, crossRoom }) => crossing(file, value, crossRoom) ? [] : [reached(file, value, to)]),
-            ...read.sections.flatMap(({ to, crossRoom, hrefs }) => hrefs.flatMap((href) => (crossing(file, href, crossRoom) ? [] : [reached(file, href, to)]))),
+            ...references(document, definition).flatMap(({ value, to, crossRoom }) => crossing(file, value, anyRoom || crossRoom) ? [] : [reached(file, value, to)]),
+            ...read.sections.flatMap(({ to, crossRoom, hrefs }) => hrefs.flatMap((href) => crossing(file, href, anyRoom || crossRoom) ? [] : [reached(file, href, to)])),
         ],
     };
 }
@@ -180,90 +181,159 @@ export function roomReferences(file, content, definition) {
     if (!parsed.ok)
         return found;
     for (const { pointer, value, to, crossRoom } of references(parsed.document, definition)) {
-        const room = crossRoom === true ? roomTarget(value) : null;
+        const room = roomTarget(value);
         if (room !== null)
-            found.push({ kind: 'field', pointer, value, to, ...room });
+            found.push({
+                kind: 'field',
+                pointer,
+                value,
+                to,
+                ...room,
+                ...(crossRoom ? { crossRoom } : {}),
+            });
     }
     const uses = usesIn(content);
     for (const span of headingSpans(content, bodyStartOf(content))) {
         const spec = Object.hasOwn(definition.sections, span.name)
             ? definition.sections[span.name]
             : undefined;
-        if (spec?.kind !== 'list' || spec.items.reference === undefined || !spec.items.crossRoom)
+        if (spec?.kind !== 'list' || spec.items.reference === undefined)
             continue;
         const listed = listItems(content, span.bodyStart, span.bodyEnd);
         for (const href of (listed === null ? null : itemHrefs(content, listed, uses)) ?? []) {
             const room = roomTarget(href);
             if (room !== null)
-                found.push({ kind: 'item', section: span.name, href, to: spec.items.reference, ...room });
+                found.push({
+                    kind: 'item',
+                    section: span.name,
+                    href,
+                    to: spec.items.reference,
+                    ...room,
+                    ...(spec.items.crossRoom === true ? { crossRoom: true } : {}),
+                });
         }
     }
     return found;
 }
+function least(refused, file, verdict) {
+    return refused === undefined || file < refused.file ? { file, verdict } : refused;
+}
+export function assess(file, content, binary, model = { types: {} }, context = {}) {
+    const unread = { file, type: undefined, targets: [], structured: null, fields: [], sections: [] };
+    if (binary)
+        return { ...unread, read: refuse(file, 'binary-target-document'), linked: true };
+    const parsed = parse(content, file);
+    if (!parsed.ok)
+        return { ...unread, read: { verdict: 'refuse', ...parsed.refusal }, linked: true };
+    const document = parsed.document;
+    const type = document.type ?? BUILT_IN_TYPE;
+    const typed = { file, type, read: null, structured: null };
+    if (instanceType(document) === BUILT_IN_TYPE) {
+        return { ...typed, targets: [], fields: [], linked: true, sections: [] };
+    }
+    const definition = definitionOf(document, model);
+    const read = structure(file, content, document, definition);
+    if ('refusal' in read || definition === undefined) {
+        return {
+            ...typed,
+            targets: [],
+            structured: 'refusal' in read ? read.refusal : null,
+            fields: [],
+            linked: true,
+            sections: [],
+        };
+    }
+    const anyRoom = context.anyRoom === true;
+    const fields = references(document, definition).flatMap(({ pointer, value, to, crossRoom }) => crossing(file, value, anyRoom || crossRoom)
+        ? []
+        : [{ reference: reached(file, value, to), location: pointer }]);
+    const sections = read.sections.flatMap(({ section, to, crossRoom, hrefs }) => hrefs.flatMap((href) => crossing(file, href, anyRoom || crossRoom)
+        ? []
+        : [{ reference: reached(file, href, to), location: section }]));
+    const targets = new Set();
+    for (const { reference } of [...fields, ...sections]) {
+        if (reference.target !== null)
+            targets.add(reference.target);
+    }
+    return { ...typed, targets: [...targets], fields, linked: linked(file, content), sections };
+}
+export function verdicts() {
+    let read;
+    let structured;
+    let referred;
+    let missed;
+    const unreached = (placed, typeOf, binary) => placed.find(({ reference }) => !reaches(reference, typeOf, binary));
+    return {
+        add(assessment, typeOf, binary) {
+            const { file } = assessment;
+            if (assessment.read !== null) {
+                read = least(read, file, assessment.read);
+                return 0;
+            }
+            if (assessment.structured !== null) {
+                structured = least(structured, file, assessment.structured);
+                return 0;
+            }
+            const field = unreached(assessment.fields, typeOf, binary);
+            if (field !== undefined) {
+                referred = least(referred, file, refuse(file, 'unresolved-reference', { location: field.location }));
+                return 0;
+            }
+            if (!assessment.linked) {
+                referred = least(referred, file, refuse(file, 'unresolved-link'));
+                return 0;
+            }
+            const section = unreached(assessment.sections, typeOf, binary);
+            if (section !== undefined) {
+                referred = least(referred, file, refuse(file, 'unresolved-reference', { location: section.location }));
+                return 0;
+            }
+            const all = [...assessment.fields, ...assessment.sections];
+            for (const { reference } of all) {
+                if (!missing(reference, typeOf, binary))
+                    continue;
+                const path = reference.target;
+                if (missed === undefined || path < missed.path)
+                    missed = { path, referrers: [] };
+                if (path === missed.path && missed.referrers.at(-1) !== file)
+                    missed.referrers.push(file);
+            }
+            return all.length;
+        },
+        verdict() {
+            const refused = read ?? structured ?? referred;
+            if (refused !== undefined)
+                return refused.verdict;
+            if (missed !== undefined) {
+                return refuse(missed.path, 'referenced-missing-file', {
+                    referrers: [...missed.referrers].sort(),
+                });
+            }
+            return { verdict: 'accept' };
+        },
+    };
+}
 export function* validating(library, context = { binaryTargets: [] }, model = { types: {} }) {
     const binaryTargets = new Set(context.binaryTargets);
     const binary = (path) => binaryTargets.has(path);
-    const files = Object.keys(library).sort();
     const types = new Map();
-    const typeOf = (path) => types.get(path);
-    const documents = new Map();
-    for (const file of files) {
-        if (binaryTargets.has(file))
-            return refuse(file, 'binary-target-document');
-        const parsed = parse(library[file], file);
-        if (!parsed.ok)
-            return { verdict: 'refuse', ...parsed.refusal };
-        types.set(file, parsed.document.type ?? BUILT_IN_TYPE);
-        if (instanceType(parsed.document) !== BUILT_IN_TYPE)
-            documents.set(file, parsed.document);
-        yield file;
+    const assessments = [];
+    for (const [file, content] of library) {
+        const assessment = assess(file, content, binary(file), model, context);
+        if (assessment.type !== undefined)
+            types.set(file, assessment.type);
+        assessments.push(assessment);
+        yield { path: file, resolved: 0 };
     }
-    const sectionReferences = new Map();
-    for (const [file, document] of documents) {
-        const read = structure(file, library[file], document, definitionOf(document, model));
-        if ('refusal' in read)
-            return read.refusal;
-        sectionReferences.set(file, read.sections);
-        yield file;
-    }
-    let least;
-    for (const [file, document] of documents) {
-        const definition = definitionOf(document, model);
-        const fields = references(document, definition).flatMap(({ pointer, value, to, crossRoom }) => crossing(file, value, crossRoom)
-            ? []
-            : [{ reference: reached(file, value, to), location: pointer }]);
-        for (const { reference, location } of fields) {
-            if (!reaches(reference, typeOf, binary))
-                return refuse(file, 'unresolved-reference', { location });
-        }
-        if (!linked(file, library[file]))
-            return refuse(file, 'unresolved-link');
-        const sections = sectionReferences
-            .get(file)
-            .flatMap(({ section, to, crossRoom, hrefs }) => hrefs.flatMap((href) => crossing(file, href, crossRoom)
-            ? []
-            : [{ reference: reached(file, href, to), location: section }]));
-        for (const { reference, location } of sections) {
-            if (!reaches(reference, typeOf, binary))
-                return refuse(file, 'unresolved-reference', { location });
-        }
-        for (const { reference } of [...fields, ...sections]) {
-            if (!missing(reference, typeOf, binary))
-                continue;
-            const path = reference.target;
-            if (least === undefined || path < least.path)
-                least = { path, referrers: [] };
-            if (path === least.path && least.referrers.at(-1) !== file)
-                least.referrers.push(file);
-        }
-        yield file;
+    const judged = verdicts();
+    for (const assessment of assessments) {
+        const resolved = judged.add(assessment, (path) => types.get(path), binary);
+        yield { path: assessment.file, resolved };
     }
-    if (least !== undefined)
-        return refuse(least.path, 'referenced-missing-file', { referrers: least.referrers });
-    return { verdict: 'accept' };
+    return judged.verdict();
 }
 export function validate(library, context = { binaryTargets: [] }, model = { types: {} }) {
-    const steps = validating(library, context, model);
+    const steps = validating(new Map(Object.entries(library)), context, model);
     let step = steps.next();
     while (step.done !== true)
         step = steps.next();

package/fixtures/README.md

@@ -51,8 +51,8 @@ change to a value that is not prose leaves the projection alone.
 
 `division.json` exercises the public `divide` seam separately from the
 validation Libraries. It carries `schema` and `cases` like `projection.json`,
-and each case adds the `budget` the division runs under. Parse the source, call
-`divide(document, file, context)` with `{ documentTargets, definition, budget }`,
+and each case adds the `bound` the division runs under. Parse the source, call
+`divide(document, file, context)` with `{ documentTargets, definition, bound }`,
 and compare against `expected`: either `{ "ok": true, "spans": [...] }`, where
 each span carries the exact `text` to embed and the exact `source` the returned
 `start` and `end` address in that case's source, or `{ "ok": false, "refusal": ... }`. Then
@@ -107,6 +107,7 @@ schema text. The model's own rules:
 | `frontmatter-fence`       | A present frontmatter fence does not parse as the accepted YAML subset            |
 | `schema-yaml`             | A schema text is not a mapping in the accepted YAML subset                        |
 | `schema-type-name`        | A type name is empty, starts with `$`, or is `any` or `attachment`                |
+| `provided-type`           | A schema names a type its caller provides with a key but its two role keywords    |
 | `schema`                  | A type or subschema is neither a mapping nor a boolean                            |
 | `schema-keyword`          | A schema carries a key that is no JSON Schema 2020-12 keyword the model admits    |
 | `$defs`                   | `$defs` is not a mapping                                                          |
@@ -122,9 +123,9 @@ schema text. The model's own rules:
 | `structured-section`      | A declared list section is not a list of values of its item schema                |
 | `referenced-missing-file` | Remaining files still reference an absent path                                    |
 | `unwritable-link`         | No Markdown destination form can carry a new link destination                     |
-| `division-budget`         | A division budget is not a whole number of at least 2                             |
+| `division-bound`         | A division bound is not a whole number of at least 2                             |
 
-`unwritable-link` is refused by `apply` and `division-budget` by `divide`, not
+`unwritable-link` is refused by `apply` and `division-bound` by `divide`, not
 by `validate`, so no case under `cases/` carries either.
 
 A reference that admits `attachment` reaches any path in the same Library, so

package/fixtures/division.json

@@ -2,12 +2,12 @@
   "schema": "task:\n  type: object\n  properties:\n    name: { type: string }\n    status: { enum: [open, done] }\n  required: [status]\n  sections:\n    Description: { kind: text, required: true }\n    Acceptance: { kind: list, items: { type: string, reference: person } }\nperson: {}\n",
   "cases": [
     {
-      "name": "a Document whose whole input fits the budget is one Span carrying its projection",
+      "name": "a Document whose whole input fits the bound is one Span carrying its projection",
       "file": "tasks/one.md",
       "source": "---\ntype: task\nname: Ship the release\nstatus: open\n---\n\nPreamble prose.\n\n## Description\n\nBody of the description.\n\n## Acceptance\n\n- people/ana.md\n",
       "documentTargets": [],
       "definition": "task",
-      "budget": 4096,
+      "bound": 4096,
       "expected": {
         "ok": true,
         "spans": [
@@ -19,12 +19,12 @@
       }
     },
     {
-      "name": "an input over the budget descends to whole heading nodes and packs adjacent siblings",
+      "name": "an input over the bound descends to whole heading nodes and packs adjacent siblings",
       "file": "tasks/one.md",
       "source": "---\ntype: task\nname: Ship the release\nstatus: open\n---\n\nPreamble prose.\n\n## Description\n\nBody of the description.\n\n## Notes\n\nNotes prose.\n\n## Acceptance\n\n- people/ana.md\n",
       "documentTargets": [],
       "definition": "task",
-      "budget": 45,
+      "bound": 45,
       "expected": {
         "ok": true,
         "spans": [
@@ -44,12 +44,12 @@
       }
     },
     {
-      "name": "a heading node over the budget divides into adjacent blocks carrying its own heading",
+      "name": "a heading node over the bound divides into adjacent blocks carrying its own heading",
       "file": "tasks/one.md",
       "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\nFirst paragraph of the overview.\n\nSecond paragraph of the overview.\n\n## Notes\n\nShort note.\n",
       "documentTargets": [],
       "definition": "task",
-      "budget": 50,
+      "bound": 50,
       "expected": {
         "ok": true,
         "spans": [
@@ -78,7 +78,7 @@
       "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\nFirst paragraph of the overview.\n\nSecond paragraph of the overview.\n\n## Notes\n\nShort note.\n",
       "documentTargets": [],
       "definition": "task",
-      "budget": 75,
+      "bound": 75,
       "expected": {
         "ok": true,
         "spans": [
@@ -107,7 +107,7 @@
       "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\nIntro line.\n\n### Detail\n\nDetail paragraph one.\n\nDetail paragraph two.\n",
       "documentTargets": [],
       "definition": "task",
-      "budget": 40,
+      "bound": 40,
       "expected": {
         "ok": true,
         "spans": [
@@ -131,12 +131,12 @@
       }
     },
     {
-      "name": "a block over the budget divides into sentences that repeat their predecessor",
+      "name": "a block over the bound divides into sentences that repeat their predecessor",
       "file": "tasks/one.md",
       "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\nOne. Two. Three. Four.\n",
       "documentTargets": [],
       "definition": "task",
-      "budget": 30,
+      "bound": 30,
       "expected": {
         "ok": true,
         "spans": [
@@ -156,12 +156,12 @@
       }
     },
     {
-      "name": "a single sentence over the budget divides at a bound cut inside it",
+      "name": "a single sentence over the bound divides at a bound cut inside it",
       "file": "tasks/one.md",
       "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\naaaa bbbb cccc dddd eeee\n",
       "documentTargets": [],
       "definition": "task",
-      "budget": 20,
+      "bound": 20,
       "expected": {
         "ok": true,
         "spans": [
@@ -198,7 +198,7 @@
       "source": "# Title\n\nIntro paragraph about the whole thing.\n\n## Alpha\n\nAlpha one. Alpha two.\n\n### Deep\n\nDeep prose here.\n\n## Beta\n\nBeta prose.\n",
       "documentTargets": [],
       "definition": null,
-      "budget": 60,
+      "bound": 60,
       "expected": {
         "ok": true,
         "spans": [
@@ -227,7 +227,7 @@
       "source": "---\ntype: any\ntitle: Note\n---\n\n## Notes\n\nRead it.\n",
       "documentTargets": [],
       "definition": null,
-      "budget": 4096,
+      "bound": 4096,
       "expected": {
         "ok": true,
         "spans": [
@@ -246,7 +246,7 @@
         "plans/q3.md"
       ],
       "definition": "task",
-      "budget": 50,
+      "bound": 50,
       "expected": {
         "ok": true,
         "spans": [
@@ -271,7 +271,7 @@
       "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\nPreamble prose.\n\n## Acceptance\n\n- people/ana.md\n\n## Notes\n\nShort note.\n",
       "documentTargets": [],
       "definition": "task",
-      "budget": 4096,
+      "bound": 4096,
       "expected": {
         "ok": true,
         "spans": [
@@ -288,7 +288,7 @@
       "source": "---\ntype: task\nname: Ship the release\nstatus: open\n---\n\nPreamble prose.\n\n## Description\n\nBody of the description.\n\n## Acceptance\n\n- people/ana.md\n",
       "documentTargets": [],
       "definition": null,
-      "budget": 4096,
+      "bound": 4096,
       "expected": {
         "ok": false,
         "refusal": {
@@ -299,17 +299,17 @@
       }
     },
     {
-      "name": "a budget that cannot hold one whole character is refused before any division",
+      "name": "a bound that cannot hold one whole character is refused before any division",
       "file": "notes/one.md",
       "source": "## Notes\n\nShort note.\n",
       "documentTargets": [],
       "definition": null,
-      "budget": 1,
+      "bound": 1,
       "expected": {
         "ok": false,
         "refusal": {
           "file": "notes/one.md",
-          "rule": "division-budget"
+          "rule": "division-bound"
         }
       }
     },
@@ -319,7 +319,7 @@
       "source": "---\ntype: task\nname: \"Ship: the release\"\nstatus: open\n---\n\nBody prose.\n",
       "documentTargets": [],
       "definition": "task",
-      "budget": 4096,
+      "bound": 4096,
       "expected": {
         "ok": true,
         "spans": [
@@ -331,12 +331,12 @@
       }
     },
     {
-      "name": "sentence division reads every terminator and closer and drops a carry the budget cannot hold",
+      "name": "sentence division reads every terminator and closer and drops a carry the bound cannot hold",
       "file": "notes/three.md",
       "source": "## Ask\n\nReady? Go! He said \"no.\" Then (silence.) Done.\n",
       "documentTargets": [],
       "definition": null,
-      "budget": 30,
+      "bound": 30,
       "expected": {
         "ok": true,
         "spans": [
@@ -361,7 +361,7 @@
       "source": "## Part\n\n### Alpha\n\nAlpha prose that is long enough to matter.\n\n### Beta\n\nBeta prose.\n",
       "documentTargets": [],
       "definition": null,
-      "budget": 70,
+      "bound": 70,
       "expected": {
         "ok": true,
         "spans": [
@@ -377,12 +377,12 @@
       }
     },
     {
-      "name": "a heading the budget cannot hold beside any text is not repeated",
+      "name": "a heading the bound cannot hold beside any text is not repeated",
       "file": "notes/five.md",
       "source": "## An overview of the release\n\nFirst paragraph here.\n\nSecond paragraph here.\n",
       "documentTargets": [],
       "definition": null,
-      "budget": 25,
+      "bound": 25,
       "expected": {
         "ok": true,
         "spans": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentshouse/mdmodel",
-  "version": "0.1.0-c669bdbad8a03",
+  "version": "0.1.0-c679f403bf3fb",
   "description": "MD Type language, parser, validator, structured change application, Markdown syntax profile, and conformance fixtures",
   "license": "MIT",
   "type": "module",