@agentshouse/mdmodel 0.1.0-c7953b486d946 → 0.1.0-c7d0474d0241e

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 (46) hide show
  1. package/API.md +200 -190
  2. package/README.md +15 -18
  3. package/dist/blocks.d.ts.map +1 -1
  4. package/dist/blocks.js +6 -13
  5. package/dist/condition.d.ts +20 -9
  6. package/dist/condition.d.ts.map +1 -1
  7. package/dist/condition.js +205 -87
  8. package/dist/definition.d.ts +17 -1
  9. package/dist/definition.d.ts.map +1 -1
  10. package/dist/definition.js +259 -32
  11. package/dist/divide.d.ts.map +1 -1
  12. package/dist/divide.js +27 -17
  13. package/dist/document.d.ts +6 -3
  14. package/dist/document.d.ts.map +1 -1
  15. package/dist/document.js +326 -190
  16. package/dist/index.d.ts +13 -9
  17. package/dist/index.d.ts.map +1 -1
  18. package/dist/index.js +7 -6
  19. package/dist/links.d.ts +2 -0
  20. package/dist/links.d.ts.map +1 -1
  21. package/dist/links.js +65 -39
  22. package/dist/paths.d.ts +9 -1
  23. package/dist/paths.d.ts.map +1 -1
  24. package/dist/paths.js +24 -1
  25. package/dist/project.d.ts +1 -0
  26. package/dist/project.d.ts.map +1 -1
  27. package/dist/project.js +38 -15
  28. package/dist/references.d.ts +2 -2
  29. package/dist/references.d.ts.map +1 -1
  30. package/dist/references.js +6 -1
  31. package/dist/types.d.ts +49 -2
  32. package/dist/types.d.ts.map +1 -1
  33. package/dist/validate.d.ts +30 -2
  34. package/dist/validate.d.ts.map +1 -1
  35. package/dist/validate.js +290 -115
  36. package/fixtures/README.md +5 -4
  37. package/fixtures/cases/cross-room-link/context.json +1 -0
  38. package/fixtures/cases/cross-room-link/expected.json +1 -0
  39. package/fixtures/cases/cross-room-link/library/clients/acme.md +6 -0
  40. package/fixtures/cases/cross-room-link/schema.yaml +3 -0
  41. package/fixtures/cases/cross-room-reference/context.json +1 -0
  42. package/fixtures/cases/cross-room-reference/expected.json +1 -0
  43. package/fixtures/cases/cross-room-reference/library/clients/acme.md +9 -0
  44. package/fixtures/cases/cross-room-reference/schema.yaml +9 -0
  45. package/fixtures/division.json +26 -26
  46. package/package.json +1 -1
package/API.md CHANGED
@@ -26,30 +26,32 @@ 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
 
41
39
  `MARKDOWN_SYNTAX_PROFILE` is the Markdown every reader here applies, GitHub Flavored Markdown
42
40
  0.29, and `VERSION` is the MD model version.
43
41
 
44
- `verify(schema)` reads one schema text, the MD Types of one Room or App: one
45
- JSON Schema document (draft 2020-12) in the YAML subset. Every top-level key but
46
- `$defs` names an MD Type holding the JSON Schema of its frontmatter; `$defs`
47
- holds shapes the types reuse, reached by a `$ref` under `#/$defs/` alone. `type`
48
- and the built-in `any` are never declared. The model adds three keywords:
49
- `reference` on a string names one MD Type, several, `any` or `attachment`;
50
- `sections` declares a type's H2 sections, each `{ kind: text }` or `{ kind:
51
- list, items }` over one string, number, integer or boolean, optionally
52
- `required: true`; `member_document: true` marks at most one type.
42
+ `verify(schema)` reads one schema text, the MD Types of one Room or App: one JSON Schema document
43
+ (draft 2020-12) in the YAML subset. Every top-level key but `$defs` names an MD Type holding the
44
+ JSON Schema of its frontmatter; `$defs` holds shapes the types reuse, reached by a `$ref` under
45
+ `#/$defs/` alone. `type` and the built-in `any` are never declared. The model adds its keywords:
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
48
+ type's H2 sections, each `{ kind: text }` or `{ kind: list, items }` over one string, number,
49
+ integer or boolean, optionally `required: true`; `member_document: true` marks at most one type. A
50
+ type alone takes `create_roles` and `delete_roles`, each a list of role names. `verify(schema,
51
+ provided)` holds every type of a model `provided` as its own, named only for those two. On a field of a
52
+ type's own `properties` alone, `change_roles` and `initial_roles` each list role names, and
53
+ `transitions` lists `{ from, to, roles? }`, each end a scalar or `null`, on a field whose `type`,
54
+ `enum`, `const`, `$ref`, `allOf`, `anyOf`, `oneOf`, `if` and `not` admit no list or object.
53
55
 
54
56
  ```yaml
55
57
  $defs:
@@ -64,68 +66,72 @@ plan:
64
66
  contact: { member_document: true }
65
67
  ```
66
68
 
67
- The model's `types` expose each MD Type's `name`, `memberDocument`, `sections`,
68
- `shape` (the type as written with every `$defs` shape it reaches), the facts of
69
- its `frontmatter` and `fields`, its top-level ones: JSON `type`, `format`,
70
- `values`, `reference` targets, `items`, `properties`, an open map's `patterns`
71
- and `additional`, and `prose`, a string with no `enum`, `const`, `format`,
72
- `pattern` or `reference`. Facts join `$ref` and `allOf` to their siblings and
73
- the variants of `anyOf`, `oneOf`, `then`, `else` and `dependentSchemas`, a
74
- variant's own keys `conditional`; a path without one `type`, `null` aside, has
75
- none. A malformed schema is refused whole, naming its `rule`, the keyword or the
76
- model's own, and the JSON Pointer `location` it concerns, such as
77
- `/plan/properties/status/enum`, or `line <n>` outside the YAML subset.
78
- `pointerFacts(definition, pointer)` reads the facts a frontmatter pointer reaches,
79
- `itemFacts` and `memberFacts` take one step and `crossedFacts` reads a list's item
80
- facts; `pointerSegments` and `escapePointer` split and write a pointer, `ARRAY_INDEX`
81
- matches an index segment, and `ATTACHMENT` is the `reference` that admits any path.
82
-
83
- `validate(library, context?, model?)` takes the resulting text Library and one
84
- `ValidationContext` of `binaryTargets: readonly string[]`, none when omitted.
85
- Library keys and binary targets share one canonical collection-relative path
86
- namespace; a path declared text and binary is refused. House declares every
87
- binary file of the Room as a binary target, and the model reads no bytes. Ordinary links and images
88
- in typed Documents may resolve to either membership, relative to the source
89
- Document, and one to a path neither holds is not refused: it dangles, as a
90
- deleted file's links do. A destination that is an absolute path or leaves the
91
- collection is `unresolved-link`. A binary target supplies no Document or MD Type. `model` is the
92
- verified schema that types the Library, and every Library member is content,
93
- whatever its Path. Without `model` the Library declares no type.
69
+ The model's `types` expose each MD Type's `name`, `memberDocument`, `sections`, `shape` (the type as
70
+ written, its rule keywords left out, with every `$defs` shape it reaches), `createRoles` and
71
+ `deleteRoles` when written, its `rules` by field as `changeRoles`, `initialRoles` and `transitions`,
72
+ the facts of its `frontmatter` and `fields`, its top-level ones: JSON `type`, `format`, `values`,
73
+ `reference` targets, `items`, `properties`, an open map's `patterns` and `additional`, and `prose`,
74
+ a string with no `enum`, `const`, `format`, `pattern` or `reference`. Facts join `$ref` and `allOf`
75
+ to their siblings and the variants of `anyOf`, `oneOf`, `then`, `else` and `dependentSchemas`, a
76
+ variant's own keys `conditional`; a path without one `type`, `null` aside, has none. A malformed
77
+ schema is refused whole, naming its `rule`, the keyword or the model's own, and the JSON Pointer
78
+ `location` it concerns, such as `/plan/properties/status/enum`, or `line <n>` outside the YAML
79
+ subset. `pointerFacts(definition, pointer)` reads the facts a frontmatter pointer reaches, `itemFacts`
80
+ and `memberFacts` take one step and `crossedFacts` reads a list's item facts; `JSON_POINTER` matches the
81
+ JSON Pointer grammar, `''` included, `pointerSegments` and `escapePointer` split and write a pointer,
82
+ `ARRAY_INDEX` matches an index segment, and `ATTACHMENT` is the `reference` that admits any path.
83
+
84
+ `validate(library, context?, model?)` takes the resulting text Library and one `ValidationContext`
85
+ of `binaryTargets: readonly string[]`, none when omitted. Library keys and binary targets share one
86
+ canonical collection-relative path namespace; a path declared text and binary is refused. House
87
+ declares every binary file of the Room as a binary target, and the model reads no bytes. Ordinary
88
+ links and images in typed Documents may resolve to either membership, relative to the source
89
+ Document, and one to a path neither holds is not refused: it dangles, as a deleted file's links do.
90
+ One written `/rooms/<handle>/<path>` names a file in another Room, which the caller checks; any
91
+ other absolute path, or one that leaves the collection, is `unresolved-link`. A binary target
92
+ supplies no Document or MD Type. `model` is the verified schema that types the Library, and every
93
+ Library member is content, whatever its Path. Without `model` the Library declares no type.
94
94
 
95
95
  A typed Document's frontmatter satisfies its type's schema, every keyword with its JSON Schema
96
96
  meaning, formats asserted and defaults never filled, except that an object schema declaring neither
97
97
  `additionalProperties` nor `unevaluatedProperties` is closed: an undeclared key is refused as
98
- `undeclared- field`. `TYPE_FIELD`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every
99
- type, and the string `MEMBER_FIELD` on the `member_document` type; `HOUSE_FIELDS` lists the four. A
100
- refusal names the keyword, such as `required`, and the value's JSON Pointer, such as
101
- `/shipping/city`. Every occurrence of a declared list section is a list of values of its item
102
- schema, else `structured-section`; a reference item is one ordinary link alone, such as
103
- `- [Ada](ada.md)`. A reference, at any depth or a section item, reaching a URL, a binary target, or a
104
- Document of a type it does not name is `unresolved-reference`, and a frontmatter one reaching no
105
- member is `referenced-missing-file` naming its `referrers`; `attachment` admits any path, and no
106
- body link is a referrer.
98
+ `undeclared-field`. `TYPE_FIELD`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every type,
99
+ and the string `MEMBER_FIELD` on the `member_document` type; `HOUSE_FIELDS` lists the four. A refusal
100
+ names the keyword, such as `required`, and the value's JSON Pointer, such as `/shipping/city`. Every
101
+ occurrence of a declared list section is a list of values of its item schema, else
102
+ `structured-section`; a reference item is one ordinary link alone, such as `- [Ada](ada.md)`. A
103
+ reference, at any depth or a section item, reaching a URL, a binary target, another Room without
104
+ `cross_room` or the context's `anyRoom: true`, or a Document of a type it does not name is
105
+ `unresolved-reference`, and a frontmatter one reaching no member is `referenced-missing-file` naming
106
+ its `referrers`; `attachment` admits any path, and no body link is a referrer. `validating` is
107
+ `validate` over a `ReadonlyMap` Library, yielding each path read with the references it `resolved`;
108
+ `assess(file, content, binary, model?, context?)` reads one member, naming its `type` and `targets`,
109
+ and `verdicts()` `add`s assessments in any order, its `verdict()` the one `validate` gives.
107
110
 
108
111
  Validation returns acceptance or one refusal naming the file, the field or section, and the violated
109
112
  rule. `parse`, `apply`, and `serialize` operate on a single text Document; they do not validate
110
- collection membership or consume binary bytes. `apply` sets one typed field, including a list or an
111
- object as a whole, replaces one existing section body or the preamble against that value's prior
112
- content, or rewrites one Markdown link destination. A section need not be declared by the Document's
113
- MD Type to be replaced. A section or preamble replacement that would hide a section the Document
114
- carried behind a repeated, merged or fenced heading is refused as `overlapping-section` naming that
115
- section. A field change does not reformat the rest of the file: an inline value is replaced where it
116
- stands, and a value written after the key's line, an empty one or a block mapping or list, is
117
- written after the key's colon in its place. A field holds a `FrontmatterValue`: null, a string, a
118
- boolean, a finite number, a list without holes or a plain object of them, holding no cycle.
119
- `frontmatterValue(value)` is that test, and `apply` refuses any other value as `frontmatter-fence`;
120
- `equalValue(left, right)` compares two by value, whatever their key order, as `apply` compares a
121
- field with its prior.
122
-
123
- `Document.preamble` is a readonly string containing the exact source after frontmatter and before
124
- the first section heading recognized by the existing section parser. Without a section it is the
125
- entire post-frontmatter body; without frontmatter it starts at the beginning of the Document. An
126
- empty span is `''`. It includes whitespace, newlines, a leading H1, and any fenced text before the
127
- first section. The closing frontmatter delimiter and its line ending belong to frontmatter. Section
128
- recognition and the syntax profile are unchanged.
113
+ collection membership or consume binary bytes. `apply(document, changes)` applies a list of changes
114
+ in one pass however many: each sets one typed field, a list or an object as a whole included,
115
+ replaces one existing section body or the preamble against its prior content, or rewrites one link
116
+ destination or one reference, as the given Document holds it. All apply or none: one refused refuses
117
+ all, and `{ outcome: 'stale', document, stale }` keeps the Document and lists the positions of each
118
+ change it does not hold and of each later change of a part an earlier one changes, such as a link
119
+ inside a replaced section. A section need not be declared by the Document's MD Type to be replaced.
120
+ A section or preamble replacement that would hide a section the Document carried behind a repeated,
121
+ merged or fenced heading is refused as `overlapping-section` naming that section. A field change
122
+ does not reformat the rest of the file: an inline value is replaced where it stands, and a value
123
+ written after the key's line, an empty one or a block mapping or list, is written after the key's
124
+ colon in its place. A field holds a `FrontmatterValue`: null, a string, a boolean, a finite number,
125
+ a list without holes or a plain object of them, holding no cycle. `frontmatterValue(value)` is that
126
+ test, and `apply` refuses any other value as `frontmatter-fence`; `equalValue(left, right)` compares
127
+ two by value, whatever their key order, as `apply` compares a field with its prior.
128
+
129
+ `Document.preamble` is a readonly string holding the exact source after frontmatter and before the
130
+ first section heading the section parser recognizes, `''` when empty, whitespace, newlines, a
131
+ leading H1 and any fenced text before the first section included. The closing frontmatter
132
+ delimiter and its line ending belong to frontmatter: `bodyAfterFrontmatter(content)` is the exact
133
+ source after them, the whole text when it opens no closed fence, and the preamble begins it.
134
+ `headingLines(content, from, to)` reads each ATX heading outside a fence, by `level` and `name`.
129
135
 
130
136
  ```ts
131
137
  const parsed = parse(content);
@@ -135,34 +141,32 @@ if (parsed.ok) {
135
141
  prior: parsed.document.preamble,
136
142
  value: 'Updated introduction.\n\n',
137
143
  };
138
- const result = apply(parsed.document, change);
144
+ const result = apply(parsed.document, [change]);
139
145
  if (result.outcome === 'applied') serialize(result.document);
140
146
  }
141
147
  ```
142
148
 
143
- `apply(document, { kind: 'preamble', prior, value })` compares `prior` to the current preamble
144
- exactly. A mismatch returns `{ outcome: 'stale', document }` with the unchanged current Document. A
145
- match replaces only that source span, then parses a new immutable Document; the original is
146
- unchanged. Frontmatter and section source outside the span retain their exact bytes, including
147
- newline and heading syntax. As with section replacement, `value` is literal source: no newline or
148
- separator is inserted, and the resulting source is parsed again. An invalid frontmatter result
149
- receives the existing parse refusal. Independent field, section, and preamble edits keep their own
150
- prior values valid.
149
+ A `{ kind: 'preamble', prior, value }` change compares `prior` to the current preamble exactly. A
150
+ mismatch is stale and leaves the current Document unchanged. A match replaces only that source span,
151
+ then parses a new immutable Document; the original is unchanged. Frontmatter and section source
152
+ outside the span retain their exact bytes, including newline and heading syntax. As with section
153
+ replacement, `value` is literal source: no newline or separator is inserted, and the resulting
154
+ source is parsed again. An invalid frontmatter result receives the existing parse refusal.
155
+ Independent field, section, and preamble edits keep their own prior values valid.
151
156
 
152
- For a moved link, use `links` and the `link` change below to obtain the rewritten Document, then
153
- compare its public `preamble` and `sections` to the original. Submit the changed values with their
154
- original priors. Consumers need no source span calculation or private Model import. Collection
155
- validation remains a separate call against the resulting Library.
157
+ For moved links, use `links` and one `link` change per destination below, then compare the rewritten
158
+ Document's `preamble` and `sections` to the original and submit the changed values with their
159
+ original priors, with no source span or private Model import. Collection validation remains a
160
+ separate call against the resulting Library.
156
161
 
157
162
  `links(document, file)` is the inventory of that Document's ordinary link and image destinations
158
163
  that resolve to a collection Path, each with the destination `href` exactly as written and the
159
164
  `target` Path it resolves to relative to `file`. A `?query` or `#fragment` the destination carries
160
165
  is part of `href` and not part of `target`. Entries are ordered by the position of the destination
161
166
  text a rewrite would change, and one destination written the same way appears once however many
162
- times it occurs. A destination that the syntax profile does not read as a link, one that is empty,
163
- a bare fragment, or carries a URL scheme, and one that leaves the collection are not in the
164
- inventory. Frontmatter field values, including typed references, are not link destinations and
165
- are never enumerated.
167
+ times it occurs. A destination that the syntax profile does not read as a link, one that is empty, a
168
+ bare fragment, or carries a URL scheme, and one that leaves the collection are not in the inventory.
169
+ Frontmatter values are never link destinations.
166
170
 
167
171
  `target(file, href)` is the collection Path one written destination resolves to relative to `file`,
168
172
  by the rule `links` and `validate` read: surrounding spaces and the `?query` or `#fragment` it
@@ -171,47 +175,55 @@ URL does, then percent-encodings, so `plan\.md`, `pl&#97;n.md` and `pl%61n.md` a
171
175
  an escaped or referenced `?` or `#` starts the suffix. A destination that is empty, a bare fragment,
172
176
  carries a URL scheme, starts at `/` once read, encodes no UTF-8 text, or leaves the collection
173
177
  resolves to `null`. It reads a destination written anywhere, such as a typed reference field value,
174
- which `links` never enumerates. `retarget(href, to)` is that destination rewritten to `to`, keeping
175
- the `?query` or `#fragment` it carried, which is the destination the `link` change below writes. It
178
+ which `links` never enumerates. `roomTarget(href)` reads `/rooms/<handle>/<path>` as its `handle`
179
+ and `path`, else `null`, and `roomPath(href)` is its canonical text, the target `facts` resolves for
180
+ any reference written so. `retarget(href, to)` is that destination rewritten to `to`, keeping the
181
+ `?query` or `#fragment` it carried, which is the destination the `link` change below writes. It
176
182
  percent-encodes in `to` what `target` would decode, so it resolves to `to` again.
177
183
 
184
+ `checkDocument(file, content, model, context?)` reads one Document as `validate` does in that
185
+ context: `ok: false` where it refuses, else its `type`, whether it is `typed`, and each reference's
186
+ `target` and `to`, which `resolves(reference, typeOf, binary)` says reaches a member `validate`
187
+ accepts. `sectionReferences(file, content, definition)` reads only its `list` sections' references;
188
+ neither names another Room's, which `roomReferences(file, content, definition?)` lists by `kind`.
189
+ `parseFrontmatter(content, file?)` is `parse` without the body: `content`, `type`, `fields`.
190
+
178
191
  `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.
192
+ `pointer`, `value` and `to`; a `{ kind: 'reference', pointer, value, prior }` change rewrites one in
193
+ place, keeping its quotes, or is stale. `relativize(document, file, handle, definition?, kept?)`
194
+ rewrites, in one `apply`, each link destination and reference written `/rooms/<handle>/<path>` and
195
+ not in `kept` to `relative(file, path)`, keeping its `?query` or `#fragment`. A text without
196
+ frontmatter, such as a captured body, is read from its first character: `relativizeBody(body, file, handle)` converts it
197
+ so, refusing a `/rooms/` one naming no Room's file as `unresolved-link`; `bodyLinks(body, file)`
198
+ is its `links` and `bodyRoomLinks(body)` its other Rooms'. `relinkBody(body, file, moves)` writes,
199
+ in the `link` change's form, each destination whose Path keys `moves` as that value relative to
200
+ `file`, or as that value when it is a `/rooms/` path, and one whose `roomPath` does as that value.
187
201
 
188
202
  ```ts
189
203
  target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
190
204
  retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
191
205
  ```
192
206
 
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
207
+ A `{ kind: 'link', href, to }` change rewrites every body occurrence of that written destination
208
+ and changes nothing else, so a caller that moves Paths rewrites each referring Document in one
209
+ `apply` without a second Markdown parser. `to` is the Path the destination must resolve to
196
210
  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
211
+ is kept. A Document that does not carry the destination is stale. A reference definition is
198
212
  rewritten once however many uses name it. The destination is written in the form the syntax
199
213
  profile reads back: bare when it carries no whitespace, does not open with `<`, and balances its
200
214
  parentheses, otherwise inside angle brackets, which the original form is kept in when it still
201
215
  fits. A destination that neither form can carry is refused as `unwritable-link`.
202
216
 
203
- `project(document, file, context?)` is the Embedding projection input of one
204
- Document: the prose a consumer embeds, with every internal Markdown-document
205
- link reduced to the label a reader sees. A Document that declares no MD type
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.
217
+ `project(document, file, context?)` is the Embedding projection input of one Document: the prose a
218
+ consumer embeds, with every internal Markdown-document link reduced to the label a reader sees. A
219
+ Document that declares no MD type contributes its body after the frontmatter fence. A typed one
220
+ contributes its prose values, its preamble, and every H2 section its MD type does not declare as
221
+ structure, each with its own heading line and every occurrence of a repeated name, in Document
222
+ order: a declared text section, a list section of prose items and an undeclared section are in; a
223
+ list section of any other item schema is not. A prose value is a frontmatter string at any depth
224
+ whose schema is prose, projected bare and followed by a blank line, in the order the Document writes
225
+ them, exactly as written. The Path and every other value stay outside, so changing them alone leaves
226
+ the projection unchanged.
215
227
 
216
228
  ```ts
217
229
  const parsed = parse(content);
@@ -224,35 +236,29 @@ if (parsed.ok) {
224
236
  }
225
237
  ```
226
238
 
227
- `ProjectionContext` carries `documentTargets`, the collection-relative Paths the
228
- caller holds as Markdown documents, and `definition`, the verified MD Type the
229
- Document's `type` names, taken from the model `verify` returned. A Document that
230
- declares a type the caller supplies no definition for is refused as
231
- `unknown-type`. `documentTargets` is what makes a destination internal: a
232
- destination resolving to a supplied Path is internal, and every other
233
- destination stays authored text, a binary target and a Path nobody
234
- supplied alike. The caller supplies that membership, as it does for `validate`;
235
- the model reads no bytes, resolves no authority, and classifies nothing it was
236
- not 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.
239
+ `ProjectionContext` carries `documentTargets`, the collection-relative Paths the caller holds as
240
+ Markdown documents, and `definition`, the verified MD Type the Document's `type` names, taken from
241
+ the model `verify` returned. A Document that declares a type the caller supplies no definition for
242
+ is refused as `unknown-type`. `documentTargets` is what makes a destination internal: a destination
243
+ resolving to a supplied Path is internal, as is one into another Room, and every other stays text, a
244
+ binary target and a Path nobody supplied alike. The caller supplies that membership, as it does for
245
+ `validate`; the model reads no bytes, resolves no authority, and classifies nothing unsupplied.
246
+
247
+ An internal link contributes its visible label and no destination, fragment, or title, in the inline
248
+ `[label](path)`, full `[label][id]`, collapsed `[label][]`, and shortcut `[label]` forms, and the
249
+ link reference definition an enumerated use resolves through leaves the projection with it. An image
250
+ at a supplied document target contributes its alt text the same way, because a move rewrites that
251
+ destination too. External URLs, binary targets, unsupplied destinations, bare fragments, code spans,
252
+ fenced code, and escaped syntax stay exactly as authored, read through the same syntax profile
253
+ `links` and `validate` read. `project` returns text and never rewrites the Document.
247
254
 
248
255
  A `link` change leaves the projection of every Document it rewrites
249
256
  byte-identical, while a changed visible label changes it.
250
257
 
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
258
+ `divide(document, file, context)` divides that same Embedding projection input into ordered Spans
259
+ under the bound the caller supplies. Each Span carries the `text` to embed and the `start` and
260
+ `end` of the extent it addresses in the Document's own source, as UTF-8 byte offsets into that
261
+ source and never string positions, so a caller stores the extent and hydrates the text it shows from
256
262
  the Document itself.
257
263
 
258
264
  ```ts
@@ -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. A field on neither side never fires; `from: 'new'` admits only a
351
+ 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
@@ -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;AA+BF,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW,EAAE,CA8BrF;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAe/E"}