@agentshouse/mdmodel 0.1.0-c83456e1cebfb → 0.1.0-cad192ab63d5f
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/API.md +216 -155
- package/README.md +4 -2
- package/dist/blocks.d.ts.map +1 -1
- package/dist/blocks.js +31 -17
- package/dist/condition.d.ts +150 -0
- package/dist/condition.d.ts.map +1 -0
- package/dist/condition.js +502 -0
- package/dist/definition.d.ts +48 -24
- package/dist/definition.d.ts.map +1 -1
- package/dist/definition.js +571 -138
- package/dist/document.d.ts +9 -1
- package/dist/document.d.ts.map +1 -1
- package/dist/document.js +196 -57
- package/dist/fields.d.ts +2 -0
- package/dist/fields.d.ts.map +1 -1
- package/dist/fields.js +7 -0
- package/dist/index.d.ts +14 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +9 -4
- package/dist/links.d.ts +1 -0
- package/dist/links.d.ts.map +1 -1
- package/dist/links.js +1 -1
- package/dist/paths.d.ts +4 -0
- package/dist/paths.d.ts.map +1 -1
- package/dist/paths.js +110 -10
- package/dist/project.d.ts.map +1 -1
- package/dist/project.js +20 -21
- package/dist/references.d.ts +4 -0
- package/dist/references.d.ts.map +1 -0
- package/dist/references.js +25 -0
- package/dist/schema.d.ts +7 -6
- package/dist/schema.d.ts.map +1 -1
- package/dist/schema.js +157 -31
- package/dist/types.d.ts +42 -1
- package/dist/types.d.ts.map +1 -1
- package/dist/validate.d.ts +5 -1
- package/dist/validate.d.ts.map +1 -1
- package/dist/validate.js +157 -138
- package/dist/yaml.d.ts +8 -3
- package/dist/yaml.d.ts.map +1 -1
- package/dist/yaml.js +133 -43
- package/fixtures/README.md +49 -38
- package/fixtures/cases/absent-link-dangles/context.json +1 -0
- package/fixtures/cases/absent-link-dangles/expected.json +1 -0
- package/fixtures/cases/absent-link-dangles/library/item.md +8 -0
- package/fixtures/cases/absent-link-dangles/schema.yaml +6 -0
- package/fixtures/cases/absent-optional-field/context.json +1 -0
- package/fixtures/cases/absent-optional-field/expected.json +1 -0
- package/fixtures/cases/absent-optional-field/library/companies/acme.md +4 -0
- package/fixtures/cases/absent-optional-field/library/deals/lead.md +6 -0
- package/fixtures/cases/absent-optional-field/schema.yaml +56 -0
- package/fixtures/cases/absolute-link/context.json +1 -0
- package/fixtures/cases/{missing-binary-image → absolute-link}/expected.json +1 -1
- package/fixtures/cases/absolute-link/library/item.md +8 -0
- package/fixtures/cases/absolute-link/schema.yaml +6 -0
- package/fixtures/cases/attachment-reference-any-file/context.json +1 -0
- package/fixtures/cases/attachment-reference-any-file/expected.json +1 -0
- package/fixtures/cases/attachment-reference-any-file/library/companies/acme.md +4 -0
- package/fixtures/cases/attachment-reference-any-file/library/deals/renewal.md +15 -0
- package/fixtures/cases/attachment-reference-any-file/library/places/depot.md +4 -0
- package/fixtures/cases/attachment-reference-any-file/library/products/seats.md +4 -0
- package/fixtures/cases/attachment-reference-any-file/library/products/support.md +4 -0
- package/fixtures/cases/attachment-reference-any-file/schema.yaml +32 -0
- package/fixtures/cases/attachment-reference-dangles/context.json +1 -0
- package/fixtures/cases/attachment-reference-dangles/expected.json +1 -0
- package/fixtures/cases/attachment-reference-dangles/library/companies/acme.md +4 -0
- package/fixtures/cases/attachment-reference-dangles/library/deals/renewal.md +15 -0
- package/fixtures/cases/attachment-reference-dangles/library/places/depot.md +4 -0
- package/fixtures/cases/attachment-reference-dangles/library/products/seats.md +4 -0
- package/fixtures/cases/attachment-reference-dangles/library/products/support.md +4 -0
- package/fixtures/cases/attachment-reference-dangles/schema.yaml +32 -0
- package/fixtures/cases/attachment-reference-outside/context.json +1 -0
- package/fixtures/cases/attachment-reference-outside/expected.json +6 -0
- package/fixtures/cases/attachment-reference-outside/library/companies/acme.md +4 -0
- package/fixtures/cases/attachment-reference-outside/library/deals/renewal.md +15 -0
- package/fixtures/cases/attachment-reference-outside/library/places/depot.md +4 -0
- package/fixtures/cases/attachment-reference-outside/library/products/seats.md +4 -0
- package/fixtures/cases/attachment-reference-outside/library/products/support.md +4 -0
- package/fixtures/cases/attachment-reference-outside/schema.yaml +32 -0
- package/fixtures/cases/binary-any-reference/expected.json +1 -1
- package/fixtures/cases/binary-any-reference/schema.yaml +4 -4
- package/fixtures/cases/binary-document-collision/schema.yaml +1 -2
- package/fixtures/cases/binary-image-dangles/expected.json +1 -0
- package/fixtures/cases/binary-image-dangles/schema.yaml +1 -0
- package/fixtures/cases/binary-link-dangles/expected.json +1 -0
- package/fixtures/cases/binary-link-dangles/schema.yaml +1 -0
- package/fixtures/cases/binary-link-outside-collection/schema.yaml +1 -2
- package/fixtures/cases/binary-prototype-reference/expected.json +1 -1
- package/fixtures/cases/binary-prototype-reference/schema.yaml +4 -4
- package/fixtures/cases/binary-typed-reference/expected.json +1 -1
- package/fixtures/cases/binary-typed-reference/schema.yaml +5 -5
- package/fixtures/cases/boolean-field/context.json +1 -0
- package/fixtures/cases/boolean-field/expected.json +6 -0
- package/fixtures/cases/boolean-field/library/companies/acme.md +4 -0
- package/fixtures/cases/boolean-field/library/deals/renewal.md +31 -0
- package/fixtures/cases/boolean-field/schema.yaml +56 -0
- package/fixtures/cases/bracketed-link-definition/schema.yaml +6 -6
- package/fixtures/cases/closed-nested-object/context.json +1 -0
- package/fixtures/cases/closed-nested-object/expected.json +6 -0
- package/fixtures/cases/closed-nested-object/library/companies/acme.md +4 -0
- package/fixtures/cases/closed-nested-object/library/deals/renewal.md +32 -0
- package/fixtures/cases/closed-nested-object/schema.yaml +56 -0
- package/fixtures/cases/composed-root-reference/context.json +1 -0
- package/fixtures/cases/composed-root-reference/expected.json +6 -0
- package/fixtures/cases/composed-root-reference/library/a.md +5 -0
- package/fixtures/cases/composed-root-reference/schema.yaml +13 -0
- package/fixtures/cases/date-time-format/context.json +1 -0
- package/fixtures/cases/date-time-format/expected.json +6 -0
- package/fixtures/cases/date-time-format/library/companies/acme.md +4 -0
- package/fixtures/cases/date-time-format/library/deals/renewal.md +31 -0
- package/fixtures/cases/date-time-format/schema.yaml +56 -0
- package/fixtures/cases/declared-binary-links/schema.yaml +1 -2
- package/fixtures/cases/default-unfilled/context.json +1 -0
- package/fixtures/cases/default-unfilled/expected.json +6 -0
- package/fixtures/cases/default-unfilled/library/companies/acme.md +4 -0
- package/fixtures/cases/default-unfilled/library/deals/renewal.md +29 -0
- package/fixtures/cases/default-unfilled/schema.yaml +56 -0
- package/fixtures/cases/defs-pattern/context.json +1 -0
- package/fixtures/cases/defs-pattern/expected.json +6 -0
- package/fixtures/cases/defs-pattern/library/companies/acme.md +4 -0
- package/fixtures/cases/defs-pattern/library/deals/renewal.md +31 -0
- package/fixtures/cases/defs-pattern/schema.yaml +56 -0
- package/fixtures/cases/dependent-rule/context.json +1 -0
- package/fixtures/cases/dependent-rule/expected.json +6 -0
- package/fixtures/cases/dependent-rule/library/companies/acme.md +4 -0
- package/fixtures/cases/dependent-rule/library/deals/renewal.md +30 -0
- package/fixtures/cases/dependent-rule/schema.yaml +56 -0
- package/fixtures/cases/duplicate-link-definition/schema.yaml +6 -6
- package/fixtures/cases/email-format/context.json +1 -0
- package/fixtures/cases/email-format/expected.json +6 -0
- package/fixtures/cases/email-format/library/companies/acme.md +4 -0
- package/fixtures/cases/email-format/library/deals/renewal.md +31 -0
- package/fixtures/cases/email-format/schema.yaml +56 -0
- package/fixtures/cases/fenced-link-definition/schema.yaml +6 -6
- package/fixtures/cases/field-enum/expected.json +2 -2
- package/fixtures/cases/field-enum/schema.yaml +7 -7
- package/fixtures/cases/frontmatter-schema/schema.yaml +3 -4
- package/fixtures/cases/integer-field/context.json +1 -0
- package/fixtures/cases/integer-field/expected.json +6 -0
- package/fixtures/cases/integer-field/library/companies/acme.md +4 -0
- package/fixtures/cases/integer-field/library/deals/renewal.md +31 -0
- package/fixtures/cases/integer-field/schema.yaml +56 -0
- package/fixtures/cases/interrupted-link-definition/schema.yaml +1 -2
- package/fixtures/cases/json-schema-constructs/context.json +1 -0
- package/fixtures/cases/json-schema-constructs/expected.json +1 -0
- package/fixtures/cases/json-schema-constructs/library/companies/acme.md +4 -0
- package/fixtures/cases/json-schema-constructs/library/deals/renewal.md +31 -0
- package/fixtures/cases/json-schema-constructs/schema.yaml +56 -0
- package/fixtures/cases/list-of-objects-closed/context.json +1 -0
- package/fixtures/cases/list-of-objects-closed/expected.json +6 -0
- package/fixtures/cases/list-of-objects-closed/library/companies/acme.md +4 -0
- package/fixtures/cases/list-of-objects-closed/library/deals/renewal.md +32 -0
- package/fixtures/cases/list-of-objects-closed/schema.yaml +56 -0
- package/fixtures/cases/list-of-objects-item/context.json +1 -0
- package/fixtures/cases/list-of-objects-item/expected.json +6 -0
- package/fixtures/cases/list-of-objects-item/library/companies/acme.md +4 -0
- package/fixtures/cases/list-of-objects-item/library/deals/renewal.md +31 -0
- package/fixtures/cases/list-of-objects-item/schema.yaml +56 -0
- package/fixtures/cases/list-of-objects-reference/context.json +1 -0
- package/fixtures/cases/list-of-objects-reference/expected.json +6 -0
- package/fixtures/cases/list-of-objects-reference/library/companies/acme.md +4 -0
- package/fixtures/cases/list-of-objects-reference/library/deals/renewal.md +14 -0
- package/fixtures/cases/list-of-objects-reference/library/places/depot.md +4 -0
- package/fixtures/cases/list-of-objects-reference/library/products/seats.md +4 -0
- package/fixtures/cases/list-of-objects-reference/library/products/support.md +4 -0
- package/fixtures/cases/list-of-objects-reference/schema.yaml +32 -0
- package/fixtures/cases/list-size/context.json +1 -0
- package/fixtures/cases/list-size/expected.json +6 -0
- package/fixtures/cases/list-size/library/companies/acme.md +4 -0
- package/fixtures/cases/list-size/library/deals/renewal.md +31 -0
- package/fixtures/cases/list-size/schema.yaml +56 -0
- package/fixtures/cases/long-fence-link-definition/schema.yaml +1 -2
- package/fixtures/cases/malformed-definition/expected.json +2 -2
- package/fixtures/cases/malformed-definition/schema.yaml +3 -4
- package/fixtures/cases/member-document/schema.yaml +5 -5
- package/fixtures/cases/missing-required-field/expected.json +2 -2
- package/fixtures/cases/missing-required-field/schema.yaml +7 -7
- package/fixtures/cases/missing-section-item-kind/expected.json +2 -2
- package/fixtures/cases/missing-section-item-kind/schema.yaml +6 -6
- package/fixtures/cases/misspelled-key/context.json +1 -0
- package/fixtures/cases/misspelled-key/expected.json +6 -0
- package/fixtures/cases/misspelled-key/library/companies/acme.md +4 -0
- package/fixtures/cases/misspelled-key/library/deals/renewal.md +32 -0
- package/fixtures/cases/misspelled-key/schema.yaml +56 -0
- package/fixtures/cases/nested-defs/context.json +1 -0
- package/fixtures/cases/nested-defs/expected.json +6 -0
- package/fixtures/cases/nested-defs/library/deal.md +6 -0
- package/fixtures/cases/nested-defs/schema.yaml +11 -0
- package/fixtures/cases/nested-object-reference/context.json +1 -0
- package/fixtures/cases/nested-object-reference/expected.json +6 -0
- package/fixtures/cases/nested-object-reference/library/companies/acme.md +4 -0
- package/fixtures/cases/nested-object-reference/library/deals/renewal.md +14 -0
- package/fixtures/cases/nested-object-reference/library/places/depot.md +4 -0
- package/fixtures/cases/nested-object-reference/library/products/seats.md +4 -0
- package/fixtures/cases/nested-object-reference/library/products/support.md +4 -0
- package/fixtures/cases/nested-object-reference/schema.yaml +32 -0
- package/fixtures/cases/nested-reference/context.json +1 -0
- package/fixtures/cases/nested-reference/expected.json +1 -0
- package/fixtures/cases/nested-reference/library/companies/acme.md +4 -0
- package/fixtures/cases/nested-reference/library/deals/renewal.md +15 -0
- package/fixtures/cases/nested-reference/library/places/depot.md +4 -0
- package/fixtures/cases/nested-reference/library/products/seats.md +4 -0
- package/fixtures/cases/nested-reference/library/products/support.md +4 -0
- package/fixtures/cases/nested-reference/schema.yaml +32 -0
- package/fixtures/cases/nested-required-field/context.json +1 -0
- package/fixtures/cases/nested-required-field/expected.json +6 -0
- package/fixtures/cases/nested-required-field/library/companies/acme.md +4 -0
- package/fixtures/cases/nested-required-field/library/deals/renewal.md +30 -0
- package/fixtures/cases/nested-required-field/schema.yaml +56 -0
- package/fixtures/cases/null-refused/context.json +1 -0
- package/fixtures/cases/null-refused/expected.json +6 -0
- package/fixtures/cases/null-refused/library/companies/acme.md +4 -0
- package/fixtures/cases/null-refused/library/deals/renewal.md +31 -0
- package/fixtures/cases/null-refused/schema.yaml +56 -0
- package/fixtures/cases/numeric-range/context.json +1 -0
- package/fixtures/cases/numeric-range/expected.json +6 -0
- package/fixtures/cases/numeric-range/library/companies/acme.md +4 -0
- package/fixtures/cases/numeric-range/library/deals/renewal.md +31 -0
- package/fixtures/cases/numeric-range/schema.yaml +56 -0
- package/fixtures/cases/one-of-variant/context.json +1 -0
- package/fixtures/cases/one-of-variant/expected.json +6 -0
- package/fixtures/cases/one-of-variant/library/companies/acme.md +4 -0
- package/fixtures/cases/one-of-variant/library/deals/renewal.md +31 -0
- package/fixtures/cases/one-of-variant/schema.yaml +56 -0
- package/fixtures/cases/open-map-value/context.json +1 -0
- package/fixtures/cases/open-map-value/expected.json +6 -0
- package/fixtures/cases/open-map-value/library/companies/acme.md +4 -0
- package/fixtures/cases/open-map-value/library/deals/renewal.md +31 -0
- package/fixtures/cases/open-map-value/schema.yaml +56 -0
- package/fixtures/cases/other-room-reference/context.json +1 -0
- package/fixtures/cases/other-room-reference/expected.json +6 -0
- package/fixtures/cases/other-room-reference/library/companies/acme.md +4 -0
- package/fixtures/cases/other-room-reference/library/deals/renewal.md +14 -0
- package/fixtures/cases/other-room-reference/library/places/depot.md +4 -0
- package/fixtures/cases/other-room-reference/library/products/seats.md +4 -0
- package/fixtures/cases/other-room-reference/library/products/support.md +4 -0
- package/fixtures/cases/other-room-reference/schema.yaml +32 -0
- package/fixtures/cases/paragraph-link-definition/schema.yaml +1 -2
- package/fixtures/cases/prototype-field/expected.json +1 -1
- package/fixtures/cases/prototype-field/schema.yaml +6 -6
- package/fixtures/cases/quoted-link-definition/library/notes/draft.md +1 -1
- package/fixtures/cases/quoted-link-definition/schema.yaml +1 -2
- package/fixtures/cases/referenced-missing-file/schema.yaml +11 -10
- package/fixtures/cases/remote-ref/context.json +1 -0
- package/fixtures/cases/remote-ref/expected.json +5 -0
- package/fixtures/cases/remote-ref/schema.yaml +3 -0
- package/fixtures/cases/second-member-document/expected.json +2 -2
- package/fixtures/cases/second-member-document/schema.yaml +4 -5
- package/fixtures/cases/section-item-enum/schema.yaml +3 -4
- package/fixtures/cases/section-item-kind/schema.yaml +3 -4
- package/fixtures/cases/section-items/library/page.md +14 -0
- package/fixtures/cases/section-items/schema.yaml +10 -8
- package/fixtures/cases/section-reference-path/schema.yaml +3 -4
- package/fixtures/cases/section-reference-type/schema.yaml +3 -4
- package/fixtures/cases/shortcut-reference-link/library/item.md +1 -1
- package/fixtures/cases/shortcut-reference-link/schema.yaml +6 -6
- package/fixtures/cases/string-length/context.json +1 -0
- package/fixtures/cases/string-length/expected.json +6 -0
- package/fixtures/cases/string-length/library/companies/acme.md +4 -0
- package/fixtures/cases/string-length/library/deals/renewal.md +31 -0
- package/fixtures/cases/string-length/schema.yaml +56 -0
- package/fixtures/cases/structured-section/schema.yaml +7 -7
- package/fixtures/cases/submission-keys/schema.yaml +4 -4
- package/fixtures/cases/text-field-kind/expected.json +2 -2
- package/fixtures/cases/text-field-kind/schema.yaml +4 -4
- package/fixtures/cases/truncated-link-definition/library/notes/draft.md +1 -1
- package/fixtures/cases/truncated-link-definition/schema.yaml +1 -2
- package/fixtures/cases/types-folder-content/schema.yaml +4 -4
- package/fixtures/cases/undeclared-field/expected.json +1 -1
- package/fixtures/cases/undeclared-field/schema.yaml +6 -6
- package/fixtures/cases/unevaluated-items-closed/context.json +1 -0
- package/fixtures/cases/unevaluated-items-closed/expected.json +6 -0
- package/fixtures/cases/unevaluated-items-closed/library/trip.md +6 -0
- package/fixtures/cases/unevaluated-items-closed/schema.yaml +10 -0
- package/fixtures/cases/unknown-type/expected.json +1 -1
- package/fixtures/cases/unknown-type/schema.yaml +3 -4
- package/fixtures/cases/unlisted-reference-type/expected.json +2 -2
- package/fixtures/cases/unlisted-reference-type/schema.yaml +3 -4
- package/fixtures/cases/unresolved-link/library/item.md +1 -1
- package/fixtures/cases/unresolved-link/schema.yaml +6 -6
- package/fixtures/cases/valid-typed-document/schema.yaml +16 -15
- package/fixtures/cases/wide-item-fence-link/schema.yaml +1 -2
- package/fixtures/division.json +1 -1
- package/fixtures/projection.json +33 -1
- package/package.json +4 -2
- package/fixtures/cases/missing-binary-image/schema.yaml +0 -2
- package/fixtures/cases/missing-binary-link/expected.json +0 -5
- package/fixtures/cases/missing-binary-link/schema.yaml +0 -2
- /package/fixtures/cases/{missing-binary-image → binary-image-dangles}/context.json +0 -0
- /package/fixtures/cases/{missing-binary-image → binary-image-dangles}/library/notes/draft.md +0 -0
- /package/fixtures/cases/{missing-binary-link → binary-link-dangles}/context.json +0 -0
- /package/fixtures/cases/{missing-binary-link → binary-link-dangles}/library/notes/draft.md +0 -0
package/API.md
CHANGED
|
@@ -16,26 +16,16 @@ import {
|
|
|
16
16
|
VERSION,
|
|
17
17
|
} from '@agentshouse/mdmodel';
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
const checked = verify('types:\n task:\n fields:\n title: { kind: string }\n');
|
|
19
|
+
const checked = verify('task:\n properties:\n title: { type: string }\n');
|
|
21
20
|
if (checked.verdict === 'accept') {
|
|
22
21
|
validate(
|
|
23
22
|
{ 'tasks/one.md': '---\ntype: task\ntitle: Ship\n---\n\n' },
|
|
24
23
|
{ binaryTargets: ['assets/figure.png'] },
|
|
25
24
|
checked.model,
|
|
26
25
|
);
|
|
27
|
-
const task = checked.model.types.task;
|
|
28
|
-
const titleKind = task?.fields.title?.kind;
|
|
29
26
|
}
|
|
30
27
|
const parsed = parse(content);
|
|
31
28
|
if (parsed.ok) {
|
|
32
|
-
const next = apply(parsed.document, {
|
|
33
|
-
kind: 'field',
|
|
34
|
-
name: 'title',
|
|
35
|
-
value: 'World',
|
|
36
|
-
prior: 'Hello',
|
|
37
|
-
});
|
|
38
|
-
if (next.outcome === 'applied') serialize(next.document);
|
|
39
29
|
for (const link of links(parsed.document, 'tasks/two.md')) {
|
|
40
30
|
if (link.target !== 'data/export.csv') continue;
|
|
41
31
|
const moved = apply(parsed.document, {
|
|
@@ -48,71 +38,88 @@ if (parsed.ok) {
|
|
|
48
38
|
}
|
|
49
39
|
```
|
|
50
40
|
|
|
51
|
-
`
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
41
|
+
`MARKDOWN_SYNTAX_PROFILE` is the Markdown every reader here applies, GitHub Flavored Markdown
|
|
42
|
+
0.29, and `VERSION` is the MD model version.
|
|
43
|
+
|
|
44
|
+
`verify(schema)` reads one schema text, the MD Types of one Room or App: one JSON Schema document
|
|
45
|
+
(draft 2020-12) in the YAML subset. Every top-level key but `$defs` names an MD Type holding the
|
|
46
|
+
JSON Schema of its frontmatter; `$defs` holds shapes the types reuse, reached by a `$ref` under
|
|
47
|
+
`#/$defs/` alone. `type` and the built-in `any` are never declared. The model adds three keywords:
|
|
48
|
+
`reference` on a string names one MD Type, several, `any` or `attachment`; `sections` declares a
|
|
49
|
+
type's H2 sections, each `{ kind: text }` or `{ kind: list, items }` over one string, number,
|
|
50
|
+
integer or boolean, optionally `required: true`; `member_document: true` marks at most one type.
|
|
56
51
|
|
|
57
52
|
```yaml
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
fields:
|
|
69
|
-
name: { kind: string, required: true }
|
|
53
|
+
$defs:
|
|
54
|
+
address: { type: object, properties: { city: { type: string } }, required: [city] }
|
|
55
|
+
plan:
|
|
56
|
+
properties:
|
|
57
|
+
status: { enum: [active, done] }
|
|
58
|
+
owner: { type: string, reference: contact }
|
|
59
|
+
shipping: { $ref: '#/$defs/address' }
|
|
60
|
+
required: [status]
|
|
61
|
+
sections: { Goals: { kind: text, required: true } }
|
|
62
|
+
contact: { member_document: true }
|
|
70
63
|
```
|
|
71
64
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
`
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
a
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
65
|
+
The model's `types` expose each MD Type's `name`, `memberDocument`, `sections`, `shape` (the type as
|
|
66
|
+
written with every `$defs` shape it reaches), the facts of its `frontmatter` and `fields`, its
|
|
67
|
+
top-level ones: JSON `type`, `format`, `values`, `reference` targets, `items`, `properties`, an open
|
|
68
|
+
map's `patterns` and `additional`, and `prose`, a string with no `enum`, `const`, `format`,
|
|
69
|
+
`pattern` or `reference`. Facts join `$ref` and `allOf` to their siblings and the variants of
|
|
70
|
+
`anyOf`, `oneOf`, `then`, `else` and `dependentSchemas`, a variant's own keys `conditional`; a path
|
|
71
|
+
without one `type`, `null` aside, has none. A malformed schema is refused whole, naming its `rule`,
|
|
72
|
+
the keyword or the model's own, and the JSON Pointer `location` it concerns, such as
|
|
73
|
+
`/plan/properties/status/enum`, or `line <n>` outside the YAML subset. `pointerFacts(definition,
|
|
74
|
+
pointer)` reads the facts a frontmatter pointer reaches, `itemFacts` and `memberFacts` take one step
|
|
75
|
+
and `crossedFacts` reads a list's item facts; `pointerSegments` and `escapePointer` split and write
|
|
76
|
+
a pointer, `ARRAY_INDEX` matches an index segment, and `ATTACHMENT` is the `reference` that admits
|
|
77
|
+
any path.
|
|
78
|
+
|
|
79
|
+
`validate(library, context?, model?)` takes the resulting text Library and one `ValidationContext`
|
|
80
|
+
of `binaryTargets: readonly string[]`, none when omitted. Library keys and binary targets share one
|
|
81
|
+
canonical collection-relative path namespace; a path declared text and binary is refused. House
|
|
82
|
+
declares every binary file of the Room as a binary target, and the model reads no bytes. Ordinary
|
|
83
|
+
links and images in typed Documents may resolve to either membership, relative to the source
|
|
84
|
+
Document, and one to a path neither holds is not refused: it dangles, as a deleted file's links do.
|
|
85
|
+
A destination that is an absolute path or leaves the collection is `unresolved-link`. A binary
|
|
86
|
+
target supplies no Document or MD Type. `model` is the verified schema that types the Library, and
|
|
87
|
+
every Library member is content, whatever its Path. Without `model` the Library declares no type.
|
|
88
|
+
|
|
89
|
+
A typed Document's frontmatter satisfies its type's schema, every keyword with its JSON Schema
|
|
90
|
+
meaning, formats asserted and defaults never filled, except that an object schema declaring neither
|
|
91
|
+
`additionalProperties` nor `unevaluatedProperties` is closed: an undeclared key is refused as
|
|
92
|
+
`undeclared- field`. `TYPE_FIELD`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every
|
|
93
|
+
type, and the string `MEMBER_FIELD` on the `member_document` type; `HOUSE_FIELDS` lists the four. A
|
|
94
|
+
refusal names the keyword, such as `required`, and the value's JSON Pointer, such as
|
|
95
|
+
`/shipping/city`. Every occurrence of a declared list section is a list of values of its item
|
|
96
|
+
schema, else `structured-section`; a reference item is one ordinary link alone, such as
|
|
97
|
+
`- [Ada](ada.md)`. A reference, at any depth or a section item, reaching a URL, a binary target, or a
|
|
98
|
+
Document of a type it does not name is `unresolved-reference`, and a frontmatter one reaching no
|
|
99
|
+
member is `referenced-missing-file` naming its `referrers`; `attachment` admits any path, and no
|
|
100
|
+
body link is a referrer.
|
|
101
|
+
|
|
102
|
+
Validation returns acceptance or one refusal naming the file, the field or section, and the violated
|
|
103
|
+
rule. `parse`, `apply`, and `serialize` operate on a single text Document; they do not validate
|
|
104
|
+
collection membership or consume binary bytes. `apply` sets one typed field, including a list or an
|
|
105
|
+
object as a whole, replaces one existing section body or the preamble against that value's prior
|
|
106
|
+
content, or rewrites one Markdown link destination. A section need not be declared by the Document's
|
|
107
|
+
MD Type to be replaced. A section or preamble replacement that would hide a section the Document
|
|
108
|
+
carried behind a repeated, merged or fenced heading is refused as `overlapping-section` naming that
|
|
109
|
+
section. A field change does not reformat the rest of the file: an inline value is replaced where it
|
|
110
|
+
stands, and a value written after the key's line, an empty one or a block mapping or list, is
|
|
111
|
+
written after the key's colon in its place. A field holds a `FrontmatterValue`: null, a string, a
|
|
112
|
+
boolean, a finite number, a list without holes or a plain object of them, holding no cycle.
|
|
113
|
+
`frontmatterValue(value)` is that test, and `apply` refuses any other value as `frontmatter-fence`;
|
|
114
|
+
`equalValue(left, right)` compares two by value, whatever their key order, as `apply` compares a
|
|
115
|
+
field with its prior.
|
|
116
|
+
|
|
117
|
+
`Document.preamble` is a readonly string containing the exact source after frontmatter and before
|
|
118
|
+
the first section heading recognized by the existing section parser. Without a section it is the
|
|
119
|
+
entire post-frontmatter body; without frontmatter it starts at the beginning of the Document. An
|
|
120
|
+
empty span is `''`. It includes whitespace, newlines, a leading H1, and any fenced text before the
|
|
121
|
+
first section. The closing frontmatter delimiter and its line ending belong to frontmatter.
|
|
122
|
+
`headingLines(content, from, to)` reads each ATX heading outside a fence, by `level` and `name`.
|
|
116
123
|
|
|
117
124
|
```ts
|
|
118
125
|
const parsed = parse(content);
|
|
@@ -127,77 +134,84 @@ if (parsed.ok) {
|
|
|
127
134
|
}
|
|
128
135
|
```
|
|
129
136
|
|
|
130
|
-
`apply(document, { kind: 'preamble', prior, value })` compares `prior` to the
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
and
|
|
135
|
-
and
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
`
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
137
|
+
`apply(document, { kind: 'preamble', prior, value })` compares `prior` to the current preamble
|
|
138
|
+
exactly. A mismatch returns `{ outcome: 'stale', document }` with the unchanged current Document. A
|
|
139
|
+
match replaces only that source span, then parses a new immutable Document; the original is
|
|
140
|
+
unchanged. Frontmatter and section source outside the span retain their exact bytes, including
|
|
141
|
+
newline and heading syntax. As with section replacement, `value` is literal source: no newline or
|
|
142
|
+
separator is inserted, and the resulting source is parsed again. An invalid frontmatter result
|
|
143
|
+
receives the existing parse refusal. Independent field, section, and preamble edits keep their own
|
|
144
|
+
prior values valid.
|
|
145
|
+
|
|
146
|
+
For a moved link, use `links` and the `link` change below to obtain the rewritten Document, then
|
|
147
|
+
compare its public `preamble` and `sections` to the original. Submit the changed values with their
|
|
148
|
+
original priors. Consumers need no source span calculation or private Model import. Collection
|
|
149
|
+
validation remains a separate call against the resulting Library.
|
|
150
|
+
|
|
151
|
+
`links(document, file)` is the inventory of that Document's ordinary link and image destinations
|
|
152
|
+
that resolve to a collection Path, each with the destination `href` exactly as written and the
|
|
153
|
+
`target` Path it resolves to relative to `file`. A `?query` or `#fragment` the destination carries
|
|
154
|
+
is part of `href` and not part of `target`. Entries are ordered by the position of the destination
|
|
155
|
+
text a rewrite would change, and one destination written the same way appears once however many
|
|
156
|
+
times it occurs. A destination that the syntax profile does not read as a link, one that is empty, a
|
|
157
|
+
bare fragment, or carries a URL scheme, and one that leaves the collection are not in the inventory.
|
|
158
|
+
Frontmatter values are never link destinations. `linkOccurrences(document, file)` places each
|
|
159
|
+
occurrence by its `start` in `content`, and `fieldStart(document, pointer)` a frontmatter value.
|
|
160
|
+
|
|
161
|
+
`target(file, href)` is the collection Path one written destination resolves to relative to `file`,
|
|
162
|
+
by the rule `links` and `validate` read: surrounding spaces and the `?query` or `#fragment` it
|
|
163
|
+
carries are not part of that Path. It reads backslash escapes and character references, strips as a
|
|
164
|
+
URL does, then percent-encodings, so `plan\.md`, `plan.md` and `pl%61n.md` all name `plan.md`;
|
|
165
|
+
an escaped or referenced `?` or `#` starts the suffix. A destination that is empty, a bare fragment,
|
|
166
|
+
carries a URL scheme, starts at `/` once read, encodes no UTF-8 text, or leaves the collection
|
|
167
|
+
resolves to `null`. It reads a destination written anywhere, such as a typed reference field value,
|
|
168
|
+
which `links` never enumerates. `retarget(href, to)` is that destination rewritten to `to`, keeping
|
|
169
|
+
the `?query` or `#fragment` it carried, which is the destination the `link` change below writes. It
|
|
170
|
+
percent-encodes in `to` what `target` would decode, so it resolves to `to` again.
|
|
171
|
+
|
|
172
|
+
`checkDocument(file, content, model)` reads one Document alone by the same rules: `ok: false` where
|
|
173
|
+
`validate` refuses it, else its `type`, whether it is `typed`, and each reference's `target` and
|
|
174
|
+
`to`, which `resolves(reference, typeOf, binary)` says reaches a member `validate` accepts.
|
|
175
|
+
`sectionReferences(file, content, definition)` reads only the references of its `list` sections.
|
|
176
|
+
`parseFrontmatter(content, file?)` is `parse` without the body: `content`, `type` and `fields`.
|
|
177
|
+
|
|
178
|
+
`references(document, definition)` lists each frontmatter `reference` string at any depth as
|
|
179
|
+
`pointer`, `value` and `to`; `apply(document, { kind: 'reference', pointer, value, prior })`
|
|
180
|
+
rewrites one in place, keeping its quotes, or is `stale`. `relativize(document, file, handle,
|
|
181
|
+
definition?)` rewrites each link destination and reference written `/rooms/<handle>/<path>` to
|
|
182
|
+
`relative(file, path)`, keeping its `?query` or `#fragment`. A text without frontmatter, such as
|
|
183
|
+
a captured body, is read from its first character: `relativizeBody(body, file, handle)` converts
|
|
184
|
+
it so, refusing a destination left under `/rooms/` as `unresolved-link`; `bodyLinks(body, file)`
|
|
185
|
+
is its `links`; `relinkBody(body, file, moves)` writes, in one pass, each destination whose Path
|
|
186
|
+
is a key of `moves` as relative to its value, in the form the `link` change below writes.
|
|
166
187
|
|
|
167
188
|
```ts
|
|
168
189
|
target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
|
|
169
190
|
retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
|
|
170
191
|
```
|
|
171
192
|
|
|
172
|
-
`apply(document, { kind: 'link', href, to })` rewrites every body occurrence of
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
inside angle brackets, which the original form is kept in when it still fits. A
|
|
182
|
-
destination that neither form can carry is refused as `unwritable-link`.
|
|
193
|
+
`apply(document, { kind: 'link', href, to })` rewrites every body occurrence of that written
|
|
194
|
+
destination and changes nothing else, so a caller that moves a Path rewrites its referring
|
|
195
|
+
Documents without a second Markdown parser. `to` is the Path the destination must resolve to
|
|
196
|
+
instead; the `?query` or `#fragment` the written destination carried is not part of that Path and
|
|
197
|
+
is kept. A Document that does not carry the destination is `stale`. A reference definition is
|
|
198
|
+
rewritten once however many uses name it. The destination is written in the form the syntax
|
|
199
|
+
profile reads back: bare when it carries no whitespace, does not open with `<`, and balances its
|
|
200
|
+
parentheses, otherwise inside angle brackets, which the original form is kept in when it still
|
|
201
|
+
fits. A destination that neither form can carry is refused as `unwritable-link`.
|
|
183
202
|
|
|
184
203
|
`project(document, file, context?)` is the Embedding projection input of one
|
|
185
204
|
Document: the prose a consumer embeds, with every internal Markdown-document
|
|
186
205
|
link reduced to the label a reader sees. A Document that declares no MD type
|
|
187
|
-
contributes its body after the frontmatter fence. A
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
followed by a blank line, in the order the MD Type declares its fields, and
|
|
197
|
-
every item of a free-text list field is one such value, projected as the author
|
|
198
|
-
wrote it: the link inventory reads the body, so link syntax inside a
|
|
199
|
-
frontmatter value is text like any other. The Document's Path and its typed
|
|
200
|
-
fields of every other kind stay outside that input.
|
|
206
|
+
contributes its body after the frontmatter fence. A typed one contributes its
|
|
207
|
+
prose values, its preamble, and every H2 section its MD type does not declare as
|
|
208
|
+
structure, each with its own heading line and every occurrence of a repeated
|
|
209
|
+
name, in Document order: a declared text section, a list section of prose items
|
|
210
|
+
and an undeclared section are in; a list section of any other item schema is
|
|
211
|
+
not. A prose value is a frontmatter string at any depth whose schema is prose,
|
|
212
|
+
projected bare and followed by a blank line, in the order the Document writes
|
|
213
|
+
them, exactly as written. The Path and every other value stay outside, so
|
|
214
|
+
changing them alone leaves the projection unchanged.
|
|
201
215
|
|
|
202
216
|
```ts
|
|
203
217
|
const parsed = parse(content);
|
|
@@ -216,7 +230,7 @@ Document's `type` names, taken from the model `verify` returned. A Document that
|
|
|
216
230
|
declares a type the caller supplies no definition for is refused as
|
|
217
231
|
`unknown-type`. `documentTargets` is what makes a destination internal: a
|
|
218
232
|
destination resolving to a supplied Path is internal, and every other
|
|
219
|
-
destination stays authored text, a
|
|
233
|
+
destination stays authored text, a binary target and a Path nobody
|
|
220
234
|
supplied alike. The caller supplies that membership, as it does for `validate`;
|
|
221
235
|
the model reads no bytes, resolves no authority, and classifies nothing it was
|
|
222
236
|
not given.
|
|
@@ -226,14 +240,13 @@ title, in the inline `[label](path)`, full `[label][id]`, collapsed
|
|
|
226
240
|
`[label][]`, and shortcut `[label]` forms, and the link reference definition an
|
|
227
241
|
enumerated use resolves through leaves the projection with it. An image at a
|
|
228
242
|
supplied document target contributes its alt text the same way, because a move
|
|
229
|
-
rewrites that destination too. External URLs,
|
|
243
|
+
rewrites that destination too. External URLs, binary targets,
|
|
230
244
|
unsupplied destinations, bare fragments, code spans, fenced code, and escaped
|
|
231
245
|
syntax stay exactly as authored, read through the same syntax profile `links`
|
|
232
246
|
and `validate` read. `project` returns text and never rewrites the Document.
|
|
233
247
|
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
visible label changes it.
|
|
248
|
+
A `link` change leaves the projection of every Document it rewrites
|
|
249
|
+
byte-identical, while a changed visible label changes it.
|
|
237
250
|
|
|
238
251
|
`divide(document, file, context)` divides that same Embedding projection input
|
|
239
252
|
into ordered Spans under the budget the caller supplies. Each Span carries the
|
|
@@ -268,23 +281,19 @@ caller's number alone: the model holds no tokenizer, counts nothing else, and
|
|
|
268
281
|
refuses no input for being too long. A Document the caller supplies no
|
|
269
282
|
definition for carries the same `unknown-type` refusal `project` returns.
|
|
270
283
|
|
|
271
|
-
The division descends one level at a time, and only into the piece that does not
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
inside a single
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
heading
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
sentence level alone, where each Span after the first repeats its predecessor's
|
|
285
|
-
last sentence whenever the budget holds both; when it cannot hold both, the
|
|
286
|
-
Span carries its own sentence alone. An untyped input arrives without a
|
|
287
|
-
definition and descends the same ladder.
|
|
284
|
+
The division descends one level at a time, and only into the piece that does not fit: the whole
|
|
285
|
+
input, a heading node, adjacent sibling nodes packed under one parent, adjacent blocks inside a
|
|
286
|
+
node, sentences inside a block, and a bound cut inside a single sentence. A Span covers whole
|
|
287
|
+
heading nodes or one contiguous piece inside a single node, never a partial node beside another. A
|
|
288
|
+
Span that continues a node repeats that node's own heading line, projected like any other text and
|
|
289
|
+
so carrying an internal link's label rather than its destination, and never an ancestor's heading,
|
|
290
|
+
so renaming a heading costs what editing that heading's own body costs. A heading the budget cannot
|
|
291
|
+
hold beside any text is not repeated, a continuation piece that begins with an astral character the
|
|
292
|
+
room beside its heading cannot hold is carried without the heading, and a heading with no body of
|
|
293
|
+
its own leads its first child node rather than standing as a Span of nothing but itself. Overlap
|
|
294
|
+
exists at the sentence level alone, where each Span after the first repeats its predecessor's last
|
|
295
|
+
sentence whenever the budget holds both; when it cannot hold both, the Span carries its own sentence
|
|
296
|
+
alone. An untyped input arrives without a definition and descends the same ladder.
|
|
288
297
|
|
|
289
298
|
Division is total: every authored character of the input belongs to at least one
|
|
290
299
|
Span, and an input carrying no authored text divides into no Span at all. A
|
|
@@ -296,3 +305,55 @@ author quoted. A Span divided out of one free-text field value addresses that
|
|
|
296
305
|
whole value, because a YAML scalar's own positions are the only ones its source
|
|
297
306
|
has, and a Span carrying part of one internal link's label addresses that whole
|
|
298
307
|
link, because a cut never falls inside link syntax.
|
|
308
|
+
|
|
309
|
+
## Conditions
|
|
310
|
+
|
|
311
|
+
`facts(document, { id, path }, model, resolve)` reads one Document as the `DocumentFacts` a
|
|
312
|
+
condition tests: its `id`, its `path` with a leading `/`, its `type` or `null`, its `sections`, and
|
|
313
|
+
a `Fact` for each frontmatter field it writes that its MD Type declares. `factKind(facts)` names
|
|
314
|
+
the kind a declared value compares as: `reference`, `enum`, `number`, `boolean`, `date`, `time`
|
|
315
|
+
(a `date-time`) or `string`, else `null`. A prose value, or one of no kind, is `prose`, a list or
|
|
316
|
+
an object holds the facts of its members, and a value written `null` is `null`. A value that does
|
|
317
|
+
not fit its kind, such as a string in a number field, a value outside its `enum` or a reference
|
|
318
|
+
`resolve` maps to no `{ id, member? }`, is `unreadable`; a readable reference compares as that `id`.
|
|
319
|
+
|
|
320
|
+
`holds(test, facts, owner)` is `true`, `false` or `undefined`, unknown; a Trigger fires on `true`
|
|
321
|
+
alone. A test's `path` is `/path`, `/type`, `/sections/<heading>`, `/fields/<pointer>`, or
|
|
322
|
+
`/members/<pointer>`, the member of the Document a reference field reaches. A pointer segment that
|
|
323
|
+
is not an index reads every item of a list, an item lacking it unknown, and a test over several
|
|
324
|
+
values holds as `any` does. The value `{ owner: true }` stands for `owner`, a User id.
|
|
325
|
+
|
|
326
|
+
| The path reaches | `exists` | `contains` | any other test |
|
|
327
|
+
| --------------------------------------- | ----------- | -------------- | -------------- |
|
|
328
|
+
| a value | present | `undefined` | compared |
|
|
329
|
+
| `null`, prose or a section | present | `undefined` | `undefined` |
|
|
330
|
+
| a list | present | `any` of items | `undefined` |
|
|
331
|
+
| no item, through an empty list | absent | `false` | `false` |
|
|
332
|
+
| nothing: no such field, section or type | absent | `undefined` | `undefined` |
|
|
333
|
+
| only unreadable values | `undefined` | `undefined` | `undefined` |
|
|
334
|
+
|
|
335
|
+
`exists: true` holds where present and fails where absent, `exists: false` the reverse. `all` is
|
|
336
|
+
`false` if a part is, else `undefined` if a part is; `any` is `true` if a part is, else `undefined`
|
|
337
|
+
if a part is; `not` keeps `undefined`, so absence is tested with `exists`, never with `not`. `eq`
|
|
338
|
+
and `in` are `undefined` against a value of another JSON type and compare a `time` as an instant;
|
|
339
|
+
`prefix` reads only a string, never a reference or a member; `gt`, `gte`, `lt` and `lte` order
|
|
340
|
+
numbers, dates and times alone.
|
|
341
|
+
|
|
342
|
+
`fires(condition, event, owner)` reads one change, `{ before, after, changed, by }`: the facts of
|
|
343
|
+
each side, `null` on the side a creation or a deletion lacks, the `changed` paths whose prose
|
|
344
|
+
changed, and the actor whose `/user`, `/site` and `/door`, one of `WRITE_DOORS`, a `by` test reads.
|
|
345
|
+
`starts_matching` fires when the Document is in `scope` and holds `match` after the change and did
|
|
346
|
+
not before; a creation fires only with `new_documents: true`, and a deletion never fires.
|
|
347
|
+
`field_changes` fires when the side the Document has, after or for a deletion before, is in `scope`
|
|
348
|
+
and holds `match`, and `field` changed: its facts differ, or with neither `from` nor `to` `changed`
|
|
349
|
+
names it. A field absent on both sides never fires; `from: 'new'` admits only a creation and
|
|
350
|
+
`to: 'deleted'` only a deletion, and listed values need that side to hold `field` `in` them.
|
|
351
|
+
|
|
352
|
+
`itemFires(condition, item, owner)` compares `source` and `address` where given and holds `match`
|
|
353
|
+
over `/delivery`, `/source`, `/provider`, `/container`, `/author`, `/has_attachment`,
|
|
354
|
+
`/headers/<name>` and `/json/<pointer>`, unknown for an item with no JSON. `prosePaths(facts)` lists
|
|
355
|
+
the prose and section paths whose text builds `changed`; `pointed(value, pointer)` reads a JSON
|
|
356
|
+
Pointer, `undefined` where nothing is; `dated(value)` checks a `YYYY-MM-DD` date, and
|
|
357
|
+
`instant(value)` reads an RFC 3339 time with its offset as epoch nanoseconds, a `bigint`.
|
|
358
|
+
`datePointers(fields)` lists, sorted, the `/fields/<name>` pointers of a type's date fields, the
|
|
359
|
+
only values a `DateCondition`'s `date` takes.
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# `@agentshouse/mdmodel`
|
|
2
2
|
|
|
3
|
-
Typed Markdown documents:
|
|
3
|
+
Typed Markdown documents: MD Types declared in JSON Schema, a parser, a validator, and the
|
|
4
4
|
deterministic application of one structured change to a Document, plus a
|
|
5
5
|
conformance fixture corpus.
|
|
6
6
|
|
|
@@ -19,7 +19,7 @@ npm install @agentshouse/mdmodel
|
|
|
19
19
|
```ts
|
|
20
20
|
import { apply, parse, serialize, validate, verify } from '@agentshouse/mdmodel';
|
|
21
21
|
|
|
22
|
-
const checked = verify('
|
|
22
|
+
const checked = verify('task:\n properties:\n title: { type: string }\n');
|
|
23
23
|
if (checked.verdict === 'accept') {
|
|
24
24
|
validate({ 'tasks/one.md': '---\ntype: task\ntitle: Ship\n---\n' }, undefined, checked.model);
|
|
25
25
|
}
|
|
@@ -45,7 +45,9 @@ if (parsed.ok) {
|
|
|
45
45
|
| `parse`, `serialize` | Read and write one Document |
|
|
46
46
|
| `apply` | Apply one field, section, preamble, or link change |
|
|
47
47
|
| `links`, `target`, `retarget` | Inventory and rewrite link destinations |
|
|
48
|
+
| `escapePointer` | Write one key as a JSON Pointer token |
|
|
48
49
|
| `project`, `divide` | Embedding projection input and its division into Spans |
|
|
50
|
+
| `facts`, `factKind`, `holds`, `fires` | A condition over a Document and over one of its changes |
|
|
49
51
|
| `MARKDOWN_SYNTAX_PROFILE`, `VERSION` | The pinned Markdown profile (GFM 0.29) and MD model version |
|
|
50
52
|
| `MEMBER_FIELD`, `SITE_FIELD`, `RECEIVED_FIELD` | The field names validation counts as declared beyond a type's own |
|
|
51
53
|
|
package/dist/blocks.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../src/blocks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,CAAC;
|
|
1
|
+
{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../src/blocks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,CAAC;AAqCF,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW,EAAE,CA+BrF;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAe/E"}
|
package/dist/blocks.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { fenceSpans } from './links.js';
|
|
2
|
-
const HEADING = /^(#{1,6})(?!#)[ \t]+(.+?)[ \t]
|
|
2
|
+
const HEADING = /^(#{1,6})(?!#)[ \t]+(.+?)(?:[ \t]+#+)?[ \t]*$/;
|
|
3
3
|
function lineAt(content, from, to) {
|
|
4
4
|
const nl = content.indexOf('\n', from);
|
|
5
5
|
const end = nl === -1 || nl >= to ? to : nl;
|
|
@@ -23,24 +23,38 @@ function scan(content, from, to, visit) {
|
|
|
23
23
|
i = next;
|
|
24
24
|
}
|
|
25
25
|
}
|
|
26
|
+
const HASH = 0x23;
|
|
26
27
|
export function headingLines(content, from, to) {
|
|
27
28
|
const found = [];
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
const
|
|
32
|
-
const
|
|
33
|
-
const
|
|
34
|
-
if (
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
29
|
+
let fences = null;
|
|
30
|
+
let i = from;
|
|
31
|
+
while (i < to) {
|
|
32
|
+
const nl = content.indexOf('\n', i);
|
|
33
|
+
const end = nl === -1 || nl >= to ? to : nl;
|
|
34
|
+
const next = end === to ? to : end + 1;
|
|
35
|
+
if (content.charCodeAt(i) === HASH) {
|
|
36
|
+
fences ??= fenceSpans(content.slice(from, to));
|
|
37
|
+
const at = i - from;
|
|
38
|
+
if (!fences.some(([start, stop]) => at >= start && at < stop)) {
|
|
39
|
+
const { text } = lineAt(content, i, to);
|
|
40
|
+
const match = HEADING.exec(text);
|
|
41
|
+
const hashes = match?.[1];
|
|
42
|
+
const name = match?.[2];
|
|
43
|
+
if (hashes !== undefined && name !== undefined) {
|
|
44
|
+
found.push({
|
|
45
|
+
level: hashes.length,
|
|
46
|
+
name: name.trim(),
|
|
47
|
+
start: i,
|
|
48
|
+
textEnd: i + text.length,
|
|
49
|
+
next,
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
if (next === i)
|
|
55
|
+
break;
|
|
56
|
+
i = next;
|
|
57
|
+
}
|
|
44
58
|
return found;
|
|
45
59
|
}
|
|
46
60
|
export function blockRanges(content, from, to) {
|