@agentshouse/mdmodel 0.1.0-c4fe1bc82bc55 → 0.1.0-c520180b7a33f

package/dist/yaml.js

@@ -6,6 +6,18 @@ export class YamlError extends Error {
         this.name = 'YamlError';
     }
 }
+const YAML_DEPTH_MAX = 64;
+function nested(c, parse) {
+    if (c.depth >= YAML_DEPTH_MAX)
+        throw new YamlError(c.i);
+    c.depth += 1;
+    try {
+        return parse();
+    }
+    finally {
+        c.depth -= 1;
+    }
+}
 function peek(c) {
     return c.i < c.end ? c.text[c.i] : '';
 }
@@ -70,7 +82,10 @@ function indentAt(c) {
     }
     return n;
 }
+const UNHELD_TEXT = /[\0\ud800-\udfff]/u;
 function scalar(value, start, end) {
+    if (typeof value === 'string' && UNHELD_TEXT.test(value))
+        throw new YamlError(start);
     return { kind: 'scalar', value, start, end };
 }
 export function interpretPlain(text) {
@@ -84,6 +99,30 @@ export function interpretPlain(text) {
         return Number(text);
     return text;
 }
+const ESCAPES = {
+    b: '\b',
+    f: '\f',
+    n: '\n',
+    r: '\r',
+    t: '\t',
+    '"': '"',
+    '/': '/',
+    '\\': '\\',
+};
+function parseEscape(c) {
+    c.i += 1;
+    const escaped = peek(c);
+    const held = ESCAPES[escaped];
+    if (held !== undefined) {
+        c.i += 1;
+        return held;
+    }
+    const hex = c.text.slice(c.i + 1, c.i + 5);
+    if (escaped !== 'u' || c.i + 5 > c.end || !/^[0-9A-Fa-f]{4}$/.test(hex))
+        throw new YamlError(c.i);
+    c.i += 5;
+    return String.fromCharCode(Number.parseInt(hex, 16));
+}
 function parseQuoted(c) {
     const quote = peek(c);
     const start = c.i;
@@ -91,31 +130,19 @@ function parseQuoted(c) {
     let out = '';
     while (c.i < c.end) {
         const ch = peek(c);
+        if (quote === "'" && ch === "'" && c.i + 1 < c.end && c.text[c.i + 1] === "'") {
+            out += "'";
+            c.i += 2;
+            continue;
+        }
         if (ch === quote) {
             c.i += 1;
             return scalar(out, start, c.i);
         }
         if (ch === '\n' || ch === '\r')
             throw new YamlError(c.i);
-        if (quote === "'" && ch === "'" && c.text[c.i + 1] === "'") {
-            out += "'";
-            c.i += 2;
-            continue;
-        }
         if (quote === '"' && ch === '\\') {
-            c.i += 1;
-            const escaped = peek(c);
-            if (escaped === 'n')
-                out += '\n';
-            else if (escaped === 't')
-                out += '\t';
-            else if (escaped === '"')
-                out += '"';
-            else if (escaped === '\\')
-                out += '\\';
-            else
-                throw new YamlError(c.i);
-            c.i += 1;
+            out += parseEscape(c);
             continue;
         }
         out += ch;
@@ -190,6 +217,9 @@ function parseFlowValue(c) {
     return parseScalar(c, true);
 }
 function parseFlowMap(c) {
+    return nested(c, () => flowMap(c));
+}
+function flowMap(c) {
     const start = c.i;
     if (peek(c) !== '{')
         throw new YamlError(c.i);
@@ -208,11 +238,12 @@ function parseFlowMap(c) {
         if (peek(c) !== ':')
             throw new YamlError(c.i);
         c.i += 1;
+        const after = c.i;
         const value = parseFlowValue(c);
         if (seen.has(key.name))
             throw new YamlError(key.start);
         seen.add(key.name);
-        entries.push({ key: key.name, keyStart: key.start, keyEnd: key.end, value });
+        entries.push({ key: key.name, after, value });
         skipFlowSpace(c);
         if (peek(c) === ',') {
             c.i += 1;
@@ -227,6 +258,9 @@ function parseFlowMap(c) {
     throw new YamlError(c.i);
 }
 function parseFlowSeq(c) {
+    return nested(c, () => flowSeq(c));
+}
+function flowSeq(c) {
     const start = c.i;
     if (peek(c) !== '[')
         throw new YamlError(c.i);
@@ -254,6 +288,7 @@ function parseFlowSeq(c) {
     throw new YamlError(c.i);
 }
 function parseValue(c, parentKeyIndent) {
+    const at = c.i;
     skipSpaces(c);
     if (peek(c) === '#')
         skipToEol(c);
@@ -262,12 +297,12 @@ function parseValue(c, parentKeyIndent) {
         skipEol(c);
         skipBlankAndComments(c);
         if (c.i >= c.end)
-            return scalar(null, c.i, c.i);
+            return scalar(null, at, at);
         const nextIndent = indentAt(c);
         if (nextIndent === parentKeyIndent && seqAhead(c))
             return parseBlockSeq(c, nextIndent);
         if (nextIndent <= parentKeyIndent)
-            return scalar(null, c.i, c.i);
+            return scalar(null, at, at);
         if (peek(c) === '-')
             return parseBlockSeq(c, nextIndent);
         if (peek(c) === '[')
@@ -315,9 +350,6 @@ function lineStartOf(c) {
         j -= 1;
     return j;
 }
-function valueEnd(value, marked) {
-    return value.kind === 'scalar' && value.start === value.end ? marked : value.end;
-}
 function parseSeqItem(c, indent) {
     skipSpaces(c);
     if (peek(c) !== '#' && peek(c) !== '\n' && peek(c) !== '\r' && c.i < c.end && mappingAhead(c))
@@ -325,6 +357,9 @@ function parseSeqItem(c, indent) {
     return parseValue(c, indent);
 }
 function parseBlockSeq(c, indent) {
+    return nested(c, () => blockSeq(c, indent));
+}
+function blockSeq(c, indent) {
     const start = c.i;
     const items = [];
     let end = start;
@@ -337,14 +372,16 @@ function parseBlockSeq(c, indent) {
         if (peek(c) !== '-')
             break;
         c.i += 1;
-        const marked = c.i;
         const item = parseSeqItem(c, indent);
         items.push(item);
-        end = valueEnd(item, marked);
+        end = item.end;
     }
     return { kind: 'seq', items, start, end };
 }
 function parseBlockMap(c, indent, inline = false) {
+    return nested(c, () => blockMap(c, indent, inline));
+}
+function blockMap(c, indent, inline) {
     const start = c.i;
     const entries = [];
     const seen = new Set();
@@ -366,18 +403,18 @@ function parseBlockMap(c, indent, inline = false) {
         if (peek(c) !== ':')
             throw new YamlError(c.i);
         c.i += 1;
-        const marked = c.i;
+        const after = c.i;
         const value = parseValue(c, indent);
         if (seen.has(key.name))
             throw new YamlError(key.start);
         seen.add(key.name);
-        entries.push({ key: key.name, keyStart: key.start, keyEnd: key.end, value });
-        end = valueEnd(value, marked);
+        entries.push({ key: key.name, after, value });
+        end = value.end;
     }
     return { kind: 'map', entries, start, end };
 }
 export function parseYamlMapping(text, start, end) {
-    const c = { text, i: start, end };
+    const c = { text, i: start, end, depth: 0 };
     skipBlankAndComments(c);
     if (c.i >= end)
         return { kind: 'map', entries: [], start, end };
@@ -429,17 +466,23 @@ function listed(value) {
     return keys.length === value.length && keys.every((key, index) => key === String(index));
 }
 function heldWithin(value, within) {
-    if (value === null || typeof value === 'string' || typeof value === 'boolean')
+    if (typeof value === 'string')
+        return !UNHELD_TEXT.test(value);
+    if (value === null || typeof value === 'boolean')
         return true;
     if (typeof value === 'number')
         return Number.isFinite(value);
     if (typeof value !== 'object' || within.includes(value))
         return false;
+    if (within.length + 1 >= YAML_DEPTH_MAX)
+        return false;
     const path = [...within, value];
     const held = (item) => heldWithin(item, path);
     if (Array.isArray(value))
         return listed(value) && value.every(held);
-    return plain(value) && Object.values(value).every(held);
+    return (plain(value) &&
+        Object.keys(value).every((key) => !UNHELD_TEXT.test(key)) &&
+        Object.values(value).every(held));
 }
 export function frontmatterValue(value) {
     return heldWithin(value, []);

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
@@ -65,6 +65,19 @@ value one span carries part of. `start` and `end` are UTF-8 byte offsets into th
 source; every source in this corpus is ASCII, so a consumer compares the
 addressed `source` with an ordinary string slice.
 
+## Queries
+
+`queries.json` is the one table of cases both query evaluators answer. It carries `schema`,
+one schema text; `documents`, each named and carrying its `path`, the `type` a collection
+stores for it (`any` for an untyped Markdown Document, `null` for one that is not Markdown),
+its `fileId`, the `text` the device holds or `null`, and its `fields`; and `cases`, each with a
+`name`, a `query` of filter parts, the `document` it names and whether it `matches`. Verify
+the schema and plan `{ ...query, select: {} }` with `planOf` against its types. Then
+`matches(plan, candidate)` over the named Document, given its type's definition, and the
+condition `sql.tests` writes over a collection holding every Document of the table with the
+values `indexed` derives from it must both answer `matches`. A new operator adds its cases
+here first.
+
 ## Verdict format
 
 Acceptance:
@@ -107,6 +120,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                                                          |
@@ -114,17 +128,23 @@ schema text. The model's own rules:
 | `reference`               | `reference` is not on a string or names something but a type, `any`, `attachment` |
 | `sections`                | A section is not `{ kind: text }` or `{ kind: list, items }` over one scalar      |
 | `member_document`         | The mark is not a boolean, or a second type carries it                            |
-| `unknown-type`            | A file declares a type absent from the governing schema                           |
+| `unknown-type`            | A file declares a type absent from the governing schema, or other than its typed path requires it to name |
 | `undeclared-field`        | A closed object carries a key it does not declare                                 |
 | `required-section`        | A required section heading is missing                                             |
+| `conditional-section`     | A section its type's `if` branch requires is absent or holds no text              |
 | `unresolved-reference`    | A reference at any depth or a section item reaches no member it admits            |
-| `unresolved-link`         | A body link is an absolute path or leaves the collection                          |
+| `unresolved-link`         | A body link is an absolute path, leaves the collection or, from a typed Document at a document path, reaches a reserved name |
+| `room-md-type`            | `ROOM.md` declares a type                                                         |
+| `required-body`           | A file at a typed path that requires a body has a body holding no text            |
 | `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                             |
+
+A `then` or `else` of an `if` on a type, in its `allOf` or in such a branch may hold
+`sections`, naming sections the type declares as the type declares them, else `sections`.
 
-`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
@@ -136,6 +156,6 @@ Library is accepted too, so `unresolved-link` never names it and
 ## YAML subset
 
 Frontmatter and a schema text are each a mapping in a closed YAML subset: block and flow mappings,
-block and flow sequences, a block sequence item that opens a mapping, plain and quoted scalars, `true`, `false`, `null`,
+block and flow sequences, a block sequence item that opens a mapping, plain and quoted scalars (a single-quoted scalar doubles its apostrophe, a double-quoted one takes JSON's escapes), `true`, `false`, `null`,
 and decimal numbers. It does not take YAML 1.1 boolean or timestamp aliases,
 octal numbers, anchors, tags, or block scalars. A mapping carries each key once.

package/fixtures/cases/conditional-section/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/conditional-section/expected.json

@@ -0,0 +1,6 @@
+{
+  "verdict": "refuse",
+  "file": "questions/payments.md",
+  "location": "Answer",
+  "rule": "conditional-section"
+}

package/fixtures/cases/conditional-section/library/questions/hosting.md

@@ -0,0 +1,9 @@
+---
+type: question
+title: Where does it run
+status: open
+---
+
+## Question
+
+Which host runs the shop?

package/fixtures/cases/conditional-section/library/questions/payments.md

@@ -0,0 +1,12 @@
+---
+type: question
+title: Who takes payments
+status: answered
+---
+
+## Question
+
+Which provider takes card payments?
+
+## Answer
+

package/fixtures/cases/conditional-section/schema.yaml

@@ -0,0 +1,14 @@
+question:
+  properties:
+    title: { type: string }
+    status: { enum: [open, answered, withdrawn] }
+  required: [title, status]
+  sections:
+    Question: { kind: text, required: true }
+    Answer: { kind: text }
+  if:
+    properties:
+      status: { enum: [answered, withdrawn] }
+  then:
+    sections:
+      Answer: { kind: text, required: true }

package/fixtures/cases/cross-room-link/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/cross-room-link/expected.json

@@ -0,0 +1 @@
+{ "verdict": "accept" }

package/fixtures/cases/cross-room-link/library/clients/acme.md

@@ -0,0 +1,6 @@
+---
+type: client
+name: Acme
+---
+
+Paid by [the March invoice](/rooms/finance/invoices/march.md#total).

package/fixtures/cases/cross-room-link/schema.yaml

@@ -0,0 +1,3 @@
+client:
+  properties:
+    name: { type: string }

package/fixtures/cases/cross-room-reference/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/cross-room-reference/expected.json

@@ -0,0 +1 @@
+{ "verdict": "accept" }

package/fixtures/cases/cross-room-reference/library/clients/acme.md

@@ -0,0 +1,9 @@
+---
+type: client
+name: Acme
+finance: /rooms/finance/invoices/acme.md
+---
+
+## Invoices
+
+- [March](/rooms/finance/invoices/march.md)

package/fixtures/cases/cross-room-reference/schema.yaml

@@ -0,0 +1,9 @@
+client:
+  properties:
+    name: { type: string }
+    finance: { type: string, reference: invoice, cross_room: true }
+  sections:
+    Invoices: { kind: list, items: { type: string, reference: invoice, cross_room: true } }
+invoice:
+  properties:
+    name: { type: string }

package/fixtures/cases/link-into-a-reserved-name/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/link-into-a-reserved-name/expected.json

@@ -0,0 +1,5 @@
+{
+  "verdict": "refuse",
+  "file": "notes/a.md",
+  "rule": "unresolved-link"
+}

package/fixtures/cases/link-into-a-reserved-name/library/notes/a.md

@@ -0,0 +1,6 @@
+---
+type: note
+title: Plan
+---
+
+See [the schema](../settings/schema.yaml).

package/fixtures/cases/link-into-a-reserved-name/schema.yaml

@@ -0,0 +1,3 @@
+note:
+  properties:
+    title: { type: string }

package/fixtures/cases/link-into-a-reserved-name-from-an-untyped-document/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/link-into-a-reserved-name-from-an-untyped-document/expected.json

@@ -0,0 +1,5 @@
+{
+  "verdict": "refuse",
+  "file": "notes/b.md",
+  "rule": "unresolved-link"
+}

package/fixtures/cases/link-into-a-reserved-name-from-an-untyped-document/library/notes/b.md

@@ -0,0 +1,5 @@
+---
+type: any
+---
+
+See [the Room](../Rooms/other/plan.md).

package/fixtures/cases/member-on-an-untyped-document/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/member-on-an-untyped-document/expected.json

@@ -0,0 +1,6 @@
+{
+  "verdict": "refuse",
+  "file": "note.md",
+  "location": "/member",
+  "rule": "undeclared-field"
+}

package/fixtures/cases/member-on-an-untyped-document/library/note.md

@@ -0,0 +1,4 @@
+---
+member: ana@example.com
+---
+# Ana

package/fixtures/cases/member-on-another-type/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/member-on-another-type/expected.json

@@ -0,0 +1,6 @@
+{
+  "verdict": "refuse",
+  "file": "note.md",
+  "location": "/member",
+  "rule": "undeclared-field"
+}

package/fixtures/cases/member-on-another-type/library/note.md

@@ -0,0 +1,4 @@
+---
+type: note
+member: ana@example.com
+---

package/fixtures/cases/member-on-another-type/schema.yaml

@@ -0,0 +1,7 @@
+contact:
+  member_document: true
+  properties:
+    name: { type: string }
+note:
+  properties:
+    member: { type: string }

package/fixtures/cases/reference-into-a-reserved-name/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/reference-into-a-reserved-name/expected.json

@@ -0,0 +1,6 @@
+{
+  "verdict": "refuse",
+  "file": "notes/a.md",
+  "rule": "unresolved-reference",
+  "location": "/brief"
+}

package/fixtures/cases/reference-into-a-reserved-name/library/notes/a.md

@@ -0,0 +1,4 @@
+---
+type: task
+brief: ../settings/brief.md
+---

package/fixtures/cases/reference-into-a-reserved-name/library/settings/brief.md

@@ -0,0 +1 @@
+The brief.

package/fixtures/cases/reference-into-a-reserved-name/schema.yaml

@@ -0,0 +1,3 @@
+task:
+  properties:
+    brief: { type: string, reference: any }

package/fixtures/cases/room-md-declares-a-type/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/room-md-declares-a-type/expected.json

@@ -0,0 +1,6 @@
+{
+  "verdict": "refuse",
+  "file": "ROOM.md",
+  "location": "/type",
+  "rule": "room-md-type"
+}

package/fixtures/cases/room-md-declares-a-type/library/ROOM.md

@@ -0,0 +1,5 @@
+---
+type: any
+---
+
+# Research

package/fixtures/cases/typed-path-names-another-type/context.json

@@ -0,0 +1,11 @@
+{
+  "binaryTargets": [],
+  "typedPaths": [
+    {
+      "path": "settings/prefs/*.md",
+      "type": "prefs",
+      "named": true,
+      "body": false
+    }
+  ]
+}

package/fixtures/cases/typed-path-names-another-type/expected.json

@@ -0,0 +1,6 @@
+{
+  "verdict": "refuse",
+  "file": "settings/prefs/one.md",
+  "rule": "unknown-type",
+  "location": "/type"
+}

package/fixtures/cases/typed-path-names-another-type/library/settings/prefs/one.md

@@ -0,0 +1,3 @@
+---
+type: note
+---

package/fixtures/cases/typed-path-names-another-type/schema.yaml

@@ -0,0 +1,6 @@
+prefs:
+  properties:
+    theme: { type: string }
+note:
+  properties:
+    title: { type: string }

package/fixtures/cases/typed-path-names-its-type/context.json

@@ -0,0 +1,11 @@
+{
+  "binaryTargets": [],
+  "typedPaths": [
+    {
+      "path": "settings/prefs/*.md",
+      "type": "prefs",
+      "named": true,
+      "body": false
+    }
+  ]
+}

package/fixtures/cases/typed-path-names-its-type/expected.json

@@ -0,0 +1,3 @@
+{
+  "verdict": "accept"
+}

package/fixtures/cases/typed-path-names-its-type/library/settings/prefs/deeper/two.md

@@ -0,0 +1 @@
+Dark.

package/fixtures/cases/typed-path-names-its-type/library/settings/prefs/one.md

@@ -0,0 +1,4 @@
+---
+type: prefs
+theme: dark
+---

package/fixtures/cases/typed-path-names-its-type/schema.yaml

@@ -0,0 +1,6 @@
+prefs:
+  properties:
+    theme: { type: string }
+note:
+  properties:
+    title: { type: string }

package/fixtures/cases/typed-path-names-no-type/context.json

@@ -0,0 +1,11 @@
+{
+  "binaryTargets": [],
+  "typedPaths": [
+    {
+      "path": "settings/prefs/*.md",
+      "type": "prefs",
+      "named": true,
+      "body": false
+    }
+  ]
+}

package/fixtures/cases/typed-path-names-no-type/expected.json

@@ -0,0 +1,6 @@
+{
+  "verdict": "refuse",
+  "file": "settings/prefs/one.md",
+  "rule": "unknown-type",
+  "location": "/type"
+}

package/fixtures/cases/typed-path-names-no-type/library/settings/prefs/one.md

@@ -0,0 +1 @@
+Dark.

package/fixtures/cases/typed-path-names-no-type/schema.yaml

@@ -0,0 +1,6 @@
+prefs:
+  properties:
+    theme: { type: string }
+note:
+  properties:
+    title: { type: string }

package/fixtures/cases/unnamed-typed-path-checks-its-fields/context.json

@@ -0,0 +1,11 @@
+{
+  "binaryTargets": [],
+  "typedPaths": [
+    {
+      "path": "rooms/*/tasks/*.md",
+      "type": "task",
+      "named": false,
+      "body": true
+    }
+  ]
+}