@agentshouse/mdmodel 0.1.0-ce9295da1c4c9 → 0.1.0-cf26f43c2e4d9

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.
Files changed (58) hide show
  1. package/API.md +164 -154
  2. package/README.md +16 -19
  3. package/dist/blocks.d.ts.map +1 -1
  4. package/dist/blocks.js +35 -20
  5. package/dist/condition.d.ts +23 -10
  6. package/dist/condition.d.ts.map +1 -1
  7. package/dist/condition.js +203 -88
  8. package/dist/definition.d.ts +5 -1
  9. package/dist/definition.d.ts.map +1 -1
  10. package/dist/definition.js +114 -23
  11. package/dist/divide.d.ts.map +1 -1
  12. package/dist/divide.js +27 -17
  13. package/dist/document.d.ts +5 -5
  14. package/dist/document.d.ts.map +1 -1
  15. package/dist/document.js +304 -187
  16. package/dist/index.d.ts +9 -7
  17. package/dist/index.d.ts.map +1 -1
  18. package/dist/index.js +5 -5
  19. package/dist/links.d.ts +2 -0
  20. package/dist/links.d.ts.map +1 -1
  21. package/dist/links.js +107 -50
  22. package/dist/paths.d.ts +9 -1
  23. package/dist/paths.d.ts.map +1 -1
  24. package/dist/paths.js +28 -2
  25. package/dist/pattern.d.ts +10 -0
  26. package/dist/pattern.d.ts.map +1 -0
  27. package/dist/pattern.js +355 -0
  28. package/dist/project.d.ts +1 -0
  29. package/dist/project.d.ts.map +1 -1
  30. package/dist/project.js +38 -15
  31. package/dist/references.d.ts.map +1 -1
  32. package/dist/references.js +6 -1
  33. package/dist/schema.d.ts +1 -0
  34. package/dist/schema.d.ts.map +1 -1
  35. package/dist/schema.js +55 -4
  36. package/dist/types.d.ts +28 -4
  37. package/dist/types.d.ts.map +1 -1
  38. package/dist/validate.d.ts +27 -3
  39. package/dist/validate.d.ts.map +1 -1
  40. package/dist/validate.js +219 -70
  41. package/dist/yaml.d.ts.map +1 -1
  42. package/dist/yaml.js +27 -1
  43. package/fixtures/README.md +9 -4
  44. package/fixtures/cases/conditional-section/context.json +1 -0
  45. package/fixtures/cases/conditional-section/expected.json +6 -0
  46. package/fixtures/cases/conditional-section/library/questions/hosting.md +9 -0
  47. package/fixtures/cases/conditional-section/library/questions/payments.md +12 -0
  48. package/fixtures/cases/conditional-section/schema.yaml +14 -0
  49. package/fixtures/cases/cross-room-link/context.json +1 -0
  50. package/fixtures/cases/cross-room-link/expected.json +1 -0
  51. package/fixtures/cases/cross-room-link/library/clients/acme.md +6 -0
  52. package/fixtures/cases/cross-room-link/schema.yaml +3 -0
  53. package/fixtures/cases/cross-room-reference/context.json +1 -0
  54. package/fixtures/cases/cross-room-reference/expected.json +1 -0
  55. package/fixtures/cases/cross-room-reference/library/clients/acme.md +9 -0
  56. package/fixtures/cases/cross-room-reference/schema.yaml +9 -0
  57. package/fixtures/division.json +26 -26
  58. package/package.json +7 -2
package/API.md CHANGED
@@ -26,15 +26,13 @@ if (checked.verdict === 'accept') {
26
26
  }
27
27
  const parsed = parse(content);
28
28
  if (parsed.ok) {
29
- for (const link of links(parsed.document, 'tasks/two.md')) {
30
- if (link.target !== 'data/export.csv') continue;
31
- const moved = apply(parsed.document, {
32
- kind: 'link',
33
- href: link.href,
34
- to: '../files/export.csv',
35
- });
36
- if (moved.outcome === 'applied') serialize(moved.document);
37
- }
29
+ const moved = apply(
30
+ parsed.document,
31
+ links(parsed.document, 'tasks/two.md')
32
+ .filter((link) => link.target === 'data/export.csv')
33
+ .map((link) => ({ kind: 'link' as const, href: link.href, to: '../files/export.csv' })),
34
+ );
35
+ if (moved.outcome === 'applied') serialize(moved.document);
38
36
  }
39
37
  ```
40
38
 
@@ -45,12 +43,17 @@ if (parsed.ok) {
45
43
  (draft 2020-12) in the YAML subset. Every top-level key but `$defs` names an MD Type holding the
46
44
  JSON Schema of its frontmatter; `$defs` holds shapes the types reuse, reached by a `$ref` under
47
45
  `#/$defs/` alone. `type` and the built-in `any` are never declared. The model adds its keywords:
48
- `reference` on a string names one MD Type, several, `any` or `attachment`; `sections` declares a
46
+ `reference` on a string names one MD Type, several, `any` or `attachment`, and `cross_room: true`
47
+ beside it admits a Document in another Room, of a type that Room declares; `sections` declares a
49
48
  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.
51
- On a field of a type's own `properties` alone, `change_roles` and `initial_roles` each list role
52
- names, and `transitions` lists `{ from, to, roles? }`, each end a scalar or `null`, on a field whose
53
- `type`, `enum`, `const`, `$ref`, `allOf`, `anyOf`, `oneOf`, `if` and `not` admit no list or object.
49
+ integer or boolean, optionally `required: true`, which the `then` or `else` of an `if` on the type,
50
+ in its `allOf` or in such a branch may repeat to ask a section for text, else `conditional-section`;
51
+ `member_document: true` marks at most one type. A type alone takes `create_roles` and
52
+ `delete_roles`, each a list of role names. `verify(schema, provided)` holds every type of a model
53
+ `provided` as its own, named only for those two and only if `provided.nameable` lists it. On a field
54
+ of a type's own `properties` alone, `change_roles` and `initial_roles` each list role names, and
55
+ `transitions` lists `{ from, to, roles? }`, each end a scalar or `null`, on a field whose `type`,
56
+ `enum`, `const`, `$ref`, `allOf`, `anyOf`, `oneOf`, `if` and `not` admit no list or object.
54
57
 
55
58
  ```yaml
56
59
  $defs:
@@ -66,19 +69,19 @@ contact: { member_document: true }
66
69
  ```
67
70
 
68
71
  The model's `types` expose each MD Type's `name`, `memberDocument`, `sections`, `shape` (the type as
69
- written, its rule keywords left out, with every `$defs` shape it reaches), its `rules` by field as
70
- `changeRoles`, `initialRoles` and `transitions`, the facts of its `frontmatter` and `fields`, its
71
- top-level ones: JSON `type`, `format`, `values`, `reference` targets, `items`, `properties`, an open
72
- map's `patterns` and `additional`, and `prose`, a string with no `enum`, `const`, `format`,
73
- `pattern` or `reference`. Facts join `$ref` and `allOf` to their siblings and the variants of
74
- `anyOf`, `oneOf`, `then`, `else` and `dependentSchemas`, a variant's own keys `conditional`; a path
75
- without one `type`, `null` aside, has none. A malformed schema is refused whole, naming its `rule`,
76
- the keyword or the model's own, and the JSON Pointer `location` it concerns, such as
77
- `/plan/properties/status/enum`, or `line <n>` outside the YAML subset. `pointerFacts(definition,
78
- pointer)` reads the facts a frontmatter pointer reaches, `itemFacts` and `memberFacts` take one step
79
- and `crossedFacts` reads a list's item facts; `pointerSegments` and `escapePointer` split and write
80
- a pointer, `ARRAY_INDEX` matches an index segment, and `ATTACHMENT` is the `reference` that admits
81
- any path.
72
+ written, its rule keywords left out, with every `$defs` shape it reaches), `createRoles` and
73
+ `deleteRoles` when written, its `rules` by field as `changeRoles`, `initialRoles` and `transitions`,
74
+ the facts of its `frontmatter` and `fields`, its top-level ones: JSON `type`, `format`, `values`,
75
+ `reference` targets, `items`, `properties`, an open map's `patterns` and `additional`, and `prose`,
76
+ a string with no `enum`, `const`, `format`, `pattern` or `reference`. Facts join `$ref` and `allOf`
77
+ to their siblings and the variants of `anyOf`, `oneOf`, `then`, `else` and `dependentSchemas`, a
78
+ variant's own keys `conditional`; a path without one `type`, `null` aside, has none. A malformed
79
+ schema is refused whole, naming its `rule`, the keyword or the model's own, and the JSON Pointer
80
+ `location` it concerns, such as `/plan/properties/status/enum`, or `line <n>` outside the YAML
81
+ subset. `pointerFacts(definition, pointer)` reads the facts a frontmatter pointer reaches, `itemFacts`
82
+ and `memberFacts` take one step and `crossedFacts` reads a list's item facts; `JSON_POINTER` matches the
83
+ JSON Pointer grammar, `''` included, `pointerSegments` and `escapePointer` split and write a pointer,
84
+ `ARRAY_INDEX` matches an index segment, and `ATTACHMENT` is the `reference` that admits any path.
82
85
 
83
86
  `validate(library, context?, model?)` takes the resulting text Library and one `ValidationContext`
84
87
  of `binaryTargets: readonly string[]`, none when omitted. Library keys and binary targets share one
@@ -86,37 +89,44 @@ canonical collection-relative path namespace; a path declared text and binary is
86
89
  declares every binary file of the Room as a binary target, and the model reads no bytes. Ordinary
87
90
  links and images in typed Documents may resolve to either membership, relative to the source
88
91
  Document, and one to a path neither holds is not refused: it dangles, as a deleted file's links do.
89
- A destination that is an absolute path or leaves the collection is `unresolved-link`. A binary
90
- target supplies no Document or MD Type. `model` is the verified schema that types the Library, and
91
- every Library member is content, whatever its Path. Without `model` the Library declares no type.
92
+ One written `/rooms/<handle>/<path>` names a file in another Room, which the caller checks; any
93
+ other absolute path, or one that leaves the collection, is `unresolved-link`. A binary target
94
+ supplies no Document or MD Type. `model` is the verified schema that types the Library, and every
95
+ Library member is content, whatever its Path. Without `model` the Library declares no type.
92
96
 
93
97
  A typed Document's frontmatter satisfies its type's schema, every keyword with its JSON Schema
94
98
  meaning, formats asserted and defaults never filled, except that an object schema declaring neither
95
99
  `additionalProperties` nor `unevaluatedProperties` is closed: an undeclared key is refused as
96
- `undeclared- field`. `TYPE_FIELD`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every
97
- type, and the string `MEMBER_FIELD` on the `member_document` type; `HOUSE_FIELDS` lists the four. A
98
- refusal names the keyword, such as `required`, and the value's JSON Pointer, such as
99
- `/shipping/city`. Every occurrence of a declared list section is a list of values of its item
100
- schema, else `structured-section`; a reference item is one ordinary link alone, such as
101
- `- [Ada](ada.md)`. A reference, at any depth or a section item, reaching a URL, a binary target, or a
102
- Document of a type it does not name is `unresolved-reference`, and a frontmatter one reaching no
103
- member is `referenced-missing-file` naming its `referrers`; `attachment` admits any path, and no
104
- body link is a referrer.
100
+ `undeclared-field`. `TYPE_FIELD`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every type,
101
+ and the string `MEMBER_FIELD` on the `member_document` type; `HOUSE_FIELDS` lists the four. A refusal
102
+ names the keyword, such as `required`, and the value's JSON Pointer, such as `/shipping/city`. Every
103
+ occurrence of a declared list section is a list of values of its item schema, else
104
+ `structured-section`; a reference item is one ordinary link alone, such as `- [Ada](ada.md)`. A
105
+ reference, at any depth or a section item, reaching a URL, a binary target, another Room without
106
+ `cross_room` or the context's `anyRoom: true`, or a Document of a type it does not name is
107
+ `unresolved-reference`, and a frontmatter one reaching no member is `referenced-missing-file` naming
108
+ its `referrers`; `attachment` admits any path, and no body link is a referrer. `validating` is
109
+ `validate` over a `ReadonlyMap` Library, yielding each path read with the references it `resolved`;
110
+ `assess(file, content, binary, model?, context?)` reads one member, naming its `type` and `targets`,
111
+ and `verdicts()` `add`s assessments in any order, its `verdict()` the one `validate` gives.
105
112
 
106
113
  Validation returns acceptance or one refusal naming the file, the field or section, and the violated
107
114
  rule. `parse`, `apply`, and `serialize` operate on a single text Document; they do not validate
108
- collection membership or consume binary bytes. `apply` sets one typed field, including a list or an
109
- object as a whole, replaces one existing section body or the preamble against that value's prior
110
- content, or rewrites one Markdown link destination. A section need not be declared by the Document's
111
- MD Type to be replaced. A section or preamble replacement that would hide a section the Document
112
- carried behind a repeated, merged or fenced heading is refused as `overlapping-section` naming that
113
- section. A field change does not reformat the rest of the file: an inline value is replaced where it
114
- stands, and a value written after the key's line, an empty one or a block mapping or list, is
115
- written after the key's colon in its place. A field holds a `FrontmatterValue`: null, a string, a
116
- boolean, a finite number, a list without holes or a plain object of them, holding no cycle.
117
- `frontmatterValue(value)` is that test, and `apply` refuses any other value as `frontmatter-fence`;
118
- `equalValue(left, right)` compares two by value, whatever their key order, as `apply` compares a
119
- field with its prior.
115
+ collection membership or consume binary bytes. `apply(document, changes)` applies a list of changes
116
+ in one pass however many: each sets one typed field, a list or an object as a whole included,
117
+ replaces one existing section body or the preamble against its prior content, or rewrites one link
118
+ destination or one reference, as the given Document holds it. All apply or none: one refused refuses
119
+ all, and `{ outcome: 'stale', document, stale }` keeps the Document and lists the positions of each
120
+ change it does not hold and of each later change of a part an earlier one changes, such as a link
121
+ inside a replaced section. A section need not be declared by the Document's MD Type to be replaced.
122
+ A section or preamble replacement that would hide a section the Document carried behind a repeated,
123
+ merged or fenced heading is refused as `overlapping-section` naming that section. A field change
124
+ does not reformat the rest of the file: an inline value is replaced where it stands, and a value
125
+ written after the key's line, an empty one or a block mapping or list, is written after the key's
126
+ colon in its place. A field holds a `FrontmatterValue`: null, a string, a boolean, a finite number,
127
+ a list without holes or a plain object of them, no cycle, at most 63 deep. `frontmatterValue(value)`
128
+ is that test; `apply` refuses any other value and `parse` a frontmatter past 64 deep as
129
+ `frontmatter-fence`. `equalValue` compares two by value, whatever their key order, as `apply` does.
120
130
 
121
131
  `Document.preamble` is a readonly string holding the exact source after frontmatter and before the
122
132
  first section heading the section parser recognizes, `''` when empty, whitespace, newlines, a
@@ -133,24 +143,22 @@ if (parsed.ok) {
133
143
  prior: parsed.document.preamble,
134
144
  value: 'Updated introduction.\n\n',
135
145
  };
136
- const result = apply(parsed.document, change);
146
+ const result = apply(parsed.document, [change]);
137
147
  if (result.outcome === 'applied') serialize(result.document);
138
148
  }
139
149
  ```
140
150
 
141
- `apply(document, { kind: 'preamble', prior, value })` compares `prior` to the current preamble
142
- exactly. A mismatch returns `{ outcome: 'stale', document }` with the unchanged current Document. A
143
- match replaces only that source span, then parses a new immutable Document; the original is
144
- unchanged. Frontmatter and section source outside the span retain their exact bytes, including
145
- newline and heading syntax. As with section replacement, `value` is literal source: no newline or
146
- separator is inserted, and the resulting source is parsed again. An invalid frontmatter result
147
- receives the existing parse refusal. Independent field, section, and preamble edits keep their own
148
- prior values valid.
151
+ A `{ kind: 'preamble', prior, value }` change compares `prior` to the current preamble exactly. A
152
+ mismatch is stale and leaves the current Document unchanged. A match replaces only that source span,
153
+ then parses a new immutable Document; the original is unchanged. Frontmatter and section source
154
+ outside the span retain their exact bytes, including newline and heading syntax. As with section
155
+ replacement, `value` is literal source: no newline or separator is inserted, and the resulting
156
+ source is parsed again. An invalid frontmatter result receives the existing parse refusal.
157
+ Independent field, section, and preamble edits keep their own prior values valid.
149
158
 
150
- For a moved link, use `links` and the `link` change below to obtain the rewritten Document, then
151
- compare its public `preamble` and `sections` to the original. Submit the changed values with their
152
- original priors. Consumers need no source span calculation or private Model import. Collection
153
- validation remains a separate call against the resulting Library.
159
+ For moved links, use `links` and one `link` change per destination below, then compare the rewritten
160
+ Document's `preamble` and `sections` to the original and submit the changed values with their
161
+ original priors. Collection validation remains a separate call against the resulting Library.
154
162
 
155
163
  `links(document, file)` is the inventory of that Document's ordinary link and image destinations
156
164
  that resolve to a collection Path, each with the destination `href` exactly as written and the
@@ -159,8 +167,7 @@ is part of `href` and not part of `target`. Entries are ordered by the position
159
167
  text a rewrite would change, and one destination written the same way appears once however many
160
168
  times it occurs. A destination that the syntax profile does not read as a link, one that is empty, a
161
169
  bare fragment, or carries a URL scheme, and one that leaves the collection are not in the inventory.
162
- Frontmatter values are never link destinations. `linkOccurrences(document, file)` places each
163
- occurrence by its `start` in `content`, and `fieldStart(document, pointer)` a frontmatter value.
170
+ Frontmatter values are never link destinations.
164
171
 
165
172
  `target(file, href)` is the collection Path one written destination resolves to relative to `file`,
166
173
  by the rule `links` and `validate` read: surrounding spaces and the `?query` or `#fragment` it
@@ -169,36 +176,40 @@ URL does, then percent-encodings, so `plan\.md`, `pl&#97;n.md` and `pl%61n.md` a
169
176
  an escaped or referenced `?` or `#` starts the suffix. A destination that is empty, a bare fragment,
170
177
  carries a URL scheme, starts at `/` once read, encodes no UTF-8 text, or leaves the collection
171
178
  resolves to `null`. It reads a destination written anywhere, such as a typed reference field value,
172
- which `links` never enumerates. `retarget(href, to)` is that destination rewritten to `to`, keeping
173
- the `?query` or `#fragment` it carried, which is the destination the `link` change below writes. It
179
+ which `links` never enumerates. `roomTarget(href)` reads `/rooms/<handle>/<path>` as its `handle`
180
+ and `path`, else `null`, and `roomPath(href)` is its canonical text, the target `facts` resolves for
181
+ any reference written so. `retarget(href, to)` is that destination rewritten to `to`, keeping the
182
+ `?query` or `#fragment` it carried, which is the destination the `link` change below writes. It
174
183
  percent-encodes in `to` what `target` would decode, so it resolves to `to` again.
175
184
 
176
- `checkDocument(file, content, model)` reads one Document alone by the same rules: `ok: false` where
177
- `validate` refuses it, else its `type`, whether it is `typed`, and each reference's `target` and
178
- `to`, which `resolves(reference, typeOf, binary)` says reaches a member `validate` accepts.
179
- `sectionReferences(file, content, definition)` reads only the references of its `list` sections.
180
- `parseFrontmatter(content, file?)` is `parse` without the body: `content`, `type` and `fields`.
185
+ `checkDocument(file, content, model, context?)` reads one Document as `validate` does in that
186
+ context: `ok: false` where it refuses, else its `type`, whether it is `typed`, and each reference's
187
+ `target` and `to`, which `resolves(reference, typeOf, binary)` says reaches a member `validate`
188
+ accepts. `sectionReferences(file, content, definition)` reads only its `list` sections' references;
189
+ neither names another Room's, which `roomReferences(file, content, definition?)` lists by `kind`.
190
+ `parseFrontmatter(content, file?)` is `parse` without the body: `content`, `type`, `fields`.
181
191
 
182
192
  `references(document, definition)` lists each frontmatter `reference` string at any depth as
183
- `pointer`, `value` and `to`; `apply(document, { kind: 'reference', pointer, value, prior })`
184
- rewrites one in place, keeping its quotes, or is `stale`. `relativize(document, file, handle,
185
- definition?)` rewrites each link destination and reference written `/rooms/<handle>/<path>` to
186
- `relative(file, path)`, keeping its `?query` or `#fragment`. A text without frontmatter, such as
187
- a captured body, is read from its first character: `relativizeBody(body, file, handle)` converts
188
- it so, refusing a destination left under `/rooms/` as `unresolved-link`; `bodyLinks(body, file)`
189
- is its `links`; `relinkBody(body, file, moves)` writes, in one pass, each destination whose Path
190
- is a key of `moves` as relative to its value, in the form the `link` change below writes.
193
+ `pointer`, `value` and `to`; a `{ kind: 'reference', pointer, value, prior }` change rewrites one in
194
+ place, keeping its quotes, or is stale. `relativize(document, file, handle, definition?, kept?)`
195
+ rewrites, in one `apply`, each link destination and reference written `/rooms/<handle>/<path>` and
196
+ not in `kept` to `relative(file, path)`, keeping its `?query` or `#fragment`. A text without
197
+ frontmatter, such as a captured body, is read from its first character: `relativizeBody(body, file, handle)` converts it
198
+ so, refusing a `/rooms/` one naming no Room's file as `unresolved-link`; `bodyLinks(body, file)`
199
+ is its `links` and `bodyRoomLinks(body)` its other Rooms'. `relinkBody(body, file, moves)` writes,
200
+ in the `link` change's form, each destination whose Path keys `moves` as that value relative to
201
+ `file`, or as that value when it is a `/rooms/` path, and one whose `roomPath` does as that value.
191
202
 
192
203
  ```ts
193
204
  target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
194
205
  retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
195
206
  ```
196
207
 
197
- `apply(document, { kind: 'link', href, to })` rewrites every body occurrence of that written
198
- destination and changes nothing else, so a caller that moves a Path rewrites its referring
199
- Documents without a second Markdown parser. `to` is the Path the destination must resolve to
208
+ A `{ kind: 'link', href, to }` change rewrites every body occurrence of that written destination
209
+ and changes nothing else, so a caller that moves Paths rewrites each referring Document in one
210
+ `apply` without a second Markdown parser. `to` is the Path the destination must resolve to
200
211
  instead; the `?query` or `#fragment` the written destination carried is not part of that Path and
201
- is kept. A Document that does not carry the destination is `stale`. A reference definition is
212
+ is kept. A Document that does not carry the destination is stale. A reference definition is
202
213
  rewritten once however many uses name it. The destination is written in the form the syntax
203
214
  profile reads back: bare when it carries no whitespace, does not open with `<`, and balances its
204
215
  parentheses, otherwise inside angle brackets, which the original form is kept in when it still
@@ -230,30 +241,25 @@ if (parsed.ok) {
230
241
  Markdown documents, and `definition`, the verified MD Type the Document's `type` names, taken from
231
242
  the model `verify` returned. A Document that declares a type the caller supplies no definition for
232
243
  is refused as `unknown-type`. `documentTargets` is what makes a destination internal: a destination
233
- resolving to a supplied Path is internal, and every other destination stays authored text, a binary
234
- target and a Path nobody supplied alike. The caller supplies that membership, as it does for
235
- `validate`; the model reads no bytes, resolves no authority, and classifies nothing it was not
236
- given.
237
-
238
- An internal link contributes its visible label and no destination, fragment, or
239
- title, in the inline `[label](path)`, full `[label][id]`, collapsed
240
- `[label][]`, and shortcut `[label]` forms, and the link reference definition an
241
- enumerated use resolves through leaves the projection with it. An image at a
242
- supplied document target contributes its alt text the same way, because a move
243
- rewrites that destination too. External URLs, binary targets,
244
- unsupplied destinations, bare fragments, code spans, fenced code, and escaped
245
- syntax stay exactly as authored, read through the same syntax profile `links`
246
- and `validate` read. `project` returns text and never rewrites the Document.
244
+ resolving to a supplied Path is internal, as is one into another Room, and every other stays text, a
245
+ binary target and a Path nobody supplied alike. The caller supplies that membership, as it does for
246
+ `validate`; the model reads no bytes, resolves no authority, and classifies nothing unsupplied.
247
+
248
+ An internal link contributes its visible label and no destination, fragment, or title, in the inline
249
+ `[label](path)`, full `[label][id]`, collapsed `[label][]`, and shortcut `[label]` forms, and the
250
+ link reference definition an enumerated use resolves through leaves the projection with it. An image
251
+ at a supplied document target contributes its alt text the same way, because a move rewrites that
252
+ destination too. External URLs, binary targets, unsupplied destinations, bare fragments, code spans,
253
+ fenced code, and escaped syntax stay exactly as authored, read through the same syntax profile
254
+ `links` and `validate` read. `project` returns text and never rewrites the Document.
247
255
 
248
256
  A `link` change leaves the projection of every Document it rewrites
249
257
  byte-identical, while a changed visible label changes it.
250
258
 
251
- `divide(document, file, context)` divides that same Embedding projection input
252
- into ordered Spans under the budget the caller supplies. Each Span carries the
253
- `text` to embed and the `start` and `end` of the extent it addresses in the
254
- Document's own source, as UTF-8 byte offsets into that source and never string
255
- positions, so a caller stores the extent and hydrates the text it shows from
256
- the Document itself.
259
+ `divide(document, file, context)` divides that same Embedding projection input into ordered Spans
260
+ under the bound the caller supplies. Each Span carries the `text` to embed and the `start` and `end`
261
+ of the extent it addresses in the Document's own source, as UTF-8 byte offsets and never string
262
+ positions, so a caller stores the extent and hydrates the text it shows from the Document itself.
257
263
 
258
264
  ```ts
259
265
  const parsed = parse(content);
@@ -261,25 +267,22 @@ if (parsed.ok) {
261
267
  const divided = divide(parsed.document, 'tasks/two.md', {
262
268
  documentTargets: ['plans/q3.md', 'people/ana.md'],
263
269
  definition: model.types.task,
264
- budget: 2000,
270
+ bound: 2000,
265
271
  });
266
272
  if (divided.ok) for (const span of divided.spans) embed(span.text);
267
273
  }
268
274
  ```
269
275
 
270
- `DivisionContext` is a `ProjectionContext` and one `budget`, the greatest number
271
- of characters a Span's embedded text may carry, counted the way JavaScript
272
- counts a string's length and not in the bytes the extent is measured in. No
273
- Span's text is ever longer than the budget. A bound cut never divides a
274
- character: where the budget ends between the two halves of a surrogate pair,
275
- the cut falls before the pair. A cut never falls inside link syntax either: it
276
- falls before an internal link, and a label longer than a whole piece's room is
277
- divided at the bound like any other text. The smallest budget is `2`, the
278
- length of one astral character; a budget that is not a whole number of at least
279
- `2` is refused with `division-budget` before any division. The budget is the
280
- caller's number alone: the model holds no tokenizer, counts nothing else, and
281
- refuses no input for being too long. A Document the caller supplies no
282
- definition for carries the same `unknown-type` refusal `project` returns.
276
+ `DivisionContext` is a `ProjectionContext` and one `bound`, the greatest number of characters a
277
+ Span's embedded text may carry, counted the way JavaScript counts a string's length and not in the
278
+ bytes the extent is measured in. No Span's text is ever longer than the bound. A bound cut never
279
+ divides a character: where the bound ends between the two halves of a surrogate pair, the cut falls
280
+ before the pair. A cut never falls inside link syntax either: it falls before an internal link, and
281
+ a label longer than a whole piece's room is divided at the bound like any other text. The smallest
282
+ bound is `2`, the length of one astral character; a bound that is not a whole number of at least
283
+ `2` is refused with `division-bound` before any division. The bound is the caller's number alone:
284
+ the model holds no tokenizer, counts nothing else, and refuses no input for being too long. A
285
+ Document the caller supplies no definition for carries the `unknown-type` refusal of `project`.
283
286
 
284
287
  The division descends one level at a time, and only into the piece that does not fit: the whole
285
288
  input, a heading node, adjacent sibling nodes packed under one parent, adjacent blocks inside a
@@ -287,24 +290,22 @@ node, sentences inside a block, and a bound cut inside a single sentence. A Span
287
290
  heading nodes or one contiguous piece inside a single node, never a partial node beside another. A
288
291
  Span that continues a node repeats that node's own heading line, projected like any other text and
289
292
  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
293
+ so renaming a heading costs what editing that heading's own body costs. A heading the bound cannot
291
294
  hold beside any text is not repeated, a continuation piece that begins with an astral character the
292
295
  room beside its heading cannot hold is carried without the heading, and a heading with no body of
293
296
  its own leads its first child node rather than standing as a Span of nothing but itself. Overlap
294
297
  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
298
+ sentence whenever the bound holds both; when it cannot hold both, the Span carries its own sentence
296
299
  alone. An untyped input arrives without a definition and descends the same ladder.
297
300
 
298
- Division is total: every authored character of the input belongs to at least one
299
- Span, and an input carrying no authored text divides into no Span at all. A
300
- Span's extent is the smallest range of the source that contains everything the
301
- Span covers, so it spans what the input excludes between two eligible pieces,
302
- and the extent addresses the authored source where the embedded text carries a
303
- repeated heading, an internal link's visible label, or a frontmatter value the
304
- author quoted. A Span divided out of one free-text field value addresses that
305
- whole value, because a YAML scalar's own positions are the only ones its source
306
- has, and a Span carrying part of one internal link's label addresses that whole
307
- link, because a cut never falls inside link syntax.
301
+ Division is total: every authored character of the input belongs to at least one Span, and an input
302
+ carrying no authored text divides into no Span at all. A Span's extent is the smallest range of the
303
+ source that contains everything the Span covers, so it spans what the input excludes between two
304
+ eligible pieces, and the extent addresses the authored source where the embedded text carries a
305
+ repeated heading, an internal link's visible label, or a frontmatter value the author quoted. A Span
306
+ divided out of one free-text field value addresses that whole value, because a YAML scalar's own
307
+ positions are the only ones its source has, and a Span carrying part of one internal link's label
308
+ addresses that whole link, because a cut never falls inside link syntax.
308
309
 
309
310
  ## Conditions
310
311
 
@@ -317,11 +318,11 @@ an object holds the facts of its members, and a value written `null` is `null`.
317
318
  not fit its kind, such as a string in a number field, a value outside its `enum` or a reference
318
319
  `resolve` maps to no `{ id, member? }`, is `unreadable`; a readable reference compares as that `id`.
319
320
 
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.
321
+ `holds(test, facts)` is `true`, `false` or `undefined`, unknown; a Trigger fires on `true` alone. A
322
+ test's `path` is one of the `DOCUMENT_PATHS`, `/path` and `/type`, or `/sections/<heading>`,
323
+ `/fields/<pointer>` or `/members/<pointer>`, the members a reference field's Documents bind, which
324
+ `members(facts, path)` lists. A non-index pointer segment reads every item of a list, an item
325
+ lacking it unknown, and a test over several values holds as `any` does.
325
326
 
326
327
  | The path reaches | `exists` | `contains` | any other test |
327
328
  | --------------------------------------- | ----------- | -------------- | -------------- |
@@ -339,21 +340,30 @@ and `in` are `undefined` against a value of another JSON type and compare a `tim
339
340
  `prefix` reads only a string, never a reference or a member; `gt`, `gte`, `lt` and `lte` order
340
341
  numbers, dates and times alone.
341
342
 
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.
343
+ `fires(condition, event)` reads one change, `{ before, after, changed, by, moved_between_rooms }`:
344
+ each side's facts, `null` for a side the change lacks, the `changed` paths whose prose changed, the
345
+ actor a `by` test reads at the `ACTOR_PATHS`, its `/door` one of `WRITE_DOORS`, and whether it
346
+ moved between Rooms, which a set `moved_between_rooms` must match. `starts_matching` fires when the
347
+ Document is in `scope` and holds `match` after the change but not before, a creation only with
348
+ `new_documents: true`. `field_changes` fires when the Document's side, after or for a deletion
349
+ before, is in `scope` and holds `match`, and `field` changed: its facts differ, or with neither
350
+ `from` nor `to` `changed` names it, as it names `TEXT_FIELD`, `/text`, at any change of its text. A field on neither
351
+ side never fires; `from: 'new'` admits only a creation and `to: 'deleted'` only a deletion, and listed values need that side's `field` `in` them.
352
+
353
+ `itemFires(condition, item)` compares `source` and `address` where given and holds `match` over
354
+ the `ITEM_PATHS`, a `/json` test unknown for an item with no JSON. `prosePaths(facts)` lists the
355
+ prose and section paths whose text builds `changed`; `pointed(value, pointer)` reads a JSON Pointer,
356
+ `undefined` where nothing is; `dated(value)` checks a `YYYY-MM-DD` date, and `instant(value)` reads
357
+ an RFC 3339 time with its offset as epoch nanoseconds, a `bigint`.
358
+
359
+ What a condition names of one MD Type: `datePointers(fields)` lists, sorted, its date fields as escaped
360
+ `/fields/` pointers, the only `date`s a `DateCondition` takes; `changeFields(definition)` lists each
361
+ declared field and section as a `field_changes` `field`, and `valuedChange(definition, field)` holds of
362
+ a field read as one value, never prose, a list or reached through one, the only `field` that takes a
363
+ `from` or a `to`; `memberPointers(definition, memberType)` lists the `/members/<name>` paths of the
364
+ fields referring to `memberType`, alone or in a list. `testOperators(definitions, path, memberType)`
365
+ lists the `CONDITION_OPERATORS` a test on a document `path` takes in any of those types, none where none
366
+ declares it or, for a member path, `memberPointers` lacks it: `exists` alone on a section, prose or an
367
+ object, `contains` and `exists` on a list, `prefix` on a string and `/path`, orderings on a number, date
368
+ or time, and `contains` through a list. `actorOperators(path)` and `itemOperators(path)` list the tests
369
+ on a `by` or item path, `itemKind(path)` an item value's kind, or `null`, as on `/json/`.
package/README.md CHANGED
@@ -5,7 +5,7 @@ deterministic application of one structured change to a Document, plus a
5
5
  conformance fixture corpus.
6
6
 
7
7
  It runs in the browser and in Node, makes no network call, and reads no
8
- filesystem on its own. It ships one ESM artifact that Node 24.21.0 and later
8
+ filesystem on its own. It ships one ESM artifact that Node 24.22.1 and later
9
9
  loads through `import` or `require`.
10
10
 
11
11
  ## Install
@@ -26,30 +26,27 @@ if (checked.verdict === 'accept') {
26
26
 
27
27
  const parsed = parse('---\ntype: note\ntitle: Hello\n---\n');
28
28
  if (parsed.ok) {
29
- const next = apply(parsed.document, {
30
- kind: 'field',
31
- name: 'title',
32
- value: 'World',
33
- prior: 'Hello',
34
- });
29
+ const next = apply(parsed.document, [
30
+ { kind: 'field', name: 'title', value: 'World', prior: 'Hello' },
31
+ ]);
35
32
  if (next.outcome === 'applied') serialize(next.document);
36
33
  }
37
34
  ```
38
35
 
39
36
  ## API
40
37
 
41
- | Export | Purpose |
42
- | ---------------------------------------------- | ----------------------------------------------------------------- |
43
- | `verify` | Verify one schema text into a model of MD Types |
44
- | `validate` | Validate a text Library; returns acceptance or one refusal |
45
- | `parse`, `serialize` | Read and write one Document |
46
- | `apply` | Apply one field, section, preamble, or link change |
47
- | `links`, `target`, `retarget` | Inventory and rewrite link destinations |
48
- | `escapePointer` | Write one key as a JSON Pointer token |
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 |
51
- | `MARKDOWN_SYNTAX_PROFILE`, `VERSION` | The pinned Markdown profile (GFM 0.29) and MD model version |
52
- | `MEMBER_FIELD`, `SITE_FIELD`, `RECEIVED_FIELD` | The field names validation counts as declared beyond a type's own |
38
+ | Export | Purpose |
39
+ | ---------------------------------------------- | ------------------------------------------------------------------ |
40
+ | `verify` | Verify one schema text into a model of MD Types |
41
+ | `validate` | Validate a text Library; returns acceptance or one refusal |
42
+ | `parse`, `serialize` | Read and write one Document |
43
+ | `apply` | Apply field, section, preamble, link and reference changes at once |
44
+ | `links`, `target`, `retarget` | Inventory and rewrite link destinations |
45
+ | `escapePointer` | Write one key as a JSON Pointer token |
46
+ | `project`, `divide` | Embedding projection input and its division into Spans |
47
+ | `facts`, `factKind`, `holds`, `fires` | A condition over a Document and over one of its changes |
48
+ | `MARKDOWN_SYNTAX_PROFILE`, `VERSION` | The pinned Markdown profile (GFM 0.29) and MD model version |
49
+ | `MEMBER_FIELD`, `SITE_FIELD`, `RECEIVED_FIELD` | The field names validation counts as declared beyond a type's own |
53
50
 
54
51
  The full reference is in [`API.md`](API.md). The conformance corpus and its
55
52
  verdict format and rule ids are described in [`fixtures/README.md`](fixtures/README.md).
@@ -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;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"}
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;AAoDF,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW,EAAE,CA4BrF;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAe/E"}