@agentshouse/mdmodel 0.1.0-c4fe1bc82bc55 → 0.1.0-c5808814f72d9

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 (53) hide show
  1. package/API.md +228 -218
  2. package/README.md +15 -18
  3. package/dist/blocks.d.ts.map +1 -1
  4. package/dist/blocks.js +7 -14
  5. package/dist/condition.d.ts +21 -8
  6. package/dist/condition.d.ts.map +1 -1
  7. package/dist/condition.js +209 -84
  8. package/dist/definition.d.ts +16 -1
  9. package/dist/definition.d.ts.map +1 -1
  10. package/dist/definition.js +255 -29
  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 +318 -165
  16. package/dist/fields.d.ts +2 -0
  17. package/dist/fields.d.ts.map +1 -1
  18. package/dist/fields.js +7 -0
  19. package/dist/index.d.ts +12 -9
  20. package/dist/index.d.ts.map +1 -1
  21. package/dist/index.js +7 -6
  22. package/dist/links.d.ts +3 -0
  23. package/dist/links.d.ts.map +1 -1
  24. package/dist/links.js +28 -14
  25. package/dist/paths.d.ts +10 -1
  26. package/dist/paths.d.ts.map +1 -1
  27. package/dist/paths.js +115 -12
  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 +2 -2
  32. package/dist/references.d.ts.map +1 -1
  33. package/dist/references.js +6 -1
  34. package/dist/schema.js +2 -2
  35. package/dist/types.d.ts +49 -2
  36. package/dist/types.d.ts.map +1 -1
  37. package/dist/validate.d.ts +9 -2
  38. package/dist/validate.d.ts.map +1 -1
  39. package/dist/validate.js +253 -112
  40. package/dist/yaml.d.ts +1 -2
  41. package/dist/yaml.d.ts.map +1 -1
  42. package/dist/yaml.js +39 -29
  43. package/fixtures/README.md +6 -5
  44. package/fixtures/cases/cross-room-link/context.json +1 -0
  45. package/fixtures/cases/cross-room-link/expected.json +1 -0
  46. package/fixtures/cases/cross-room-link/library/clients/acme.md +6 -0
  47. package/fixtures/cases/cross-room-link/schema.yaml +3 -0
  48. package/fixtures/cases/cross-room-reference/context.json +1 -0
  49. package/fixtures/cases/cross-room-reference/expected.json +1 -0
  50. package/fixtures/cases/cross-room-reference/library/clients/acme.md +9 -0
  51. package/fixtures/cases/cross-room-reference/schema.yaml +9 -0
  52. package/fixtures/division.json +26 -26
  53. package/package.json +4 -2
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,70 @@ 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.
94
-
95
- A typed Document's frontmatter satisfies its type's schema, every keyword with
96
- its JSON Schema meaning, formats asserted and defaults never filled, except that
97
- an object schema declaring neither `additionalProperties` nor
98
- `unevaluatedProperties` is closed: an undeclared key is refused as `undeclared-
99
- field`. `type`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every
100
- type, and the string `MEMBER_FIELD` on the `member_document` type. A refusal
101
- names the keyword, such as `required`, and the value's JSON Pointer, such as
102
- `/shipping/city`. Every occurrence of a declared list section is a list of
103
- values of its item schema, else `structured-section`; a reference item is one
104
- ordinary link alone, such as `- [Ada](ada.md)`. A reference, at any depth or a
105
- section item, reaching a URL, a binary target, or a Document of a type it does
106
- not name is `unresolved-reference`, and a frontmatter one reaching no member is
107
- `referenced-missing-file` naming its `referrers`; `attachment` admits any path,
108
- and no body link is a referrer.
109
-
110
- Validation returns acceptance or one refusal naming the file, the field or
111
- section, and the violated rule. `parse`, `apply`, and `serialize` operate on a single text
112
- Document; they do not validate collection membership or consume binary bytes.
113
- `apply` sets one typed field, including a list or an object as a whole, replaces
114
- one existing section body or the preamble against that value's prior content,
115
- or rewrites one Markdown link destination. A section need not be declared by
116
- the Document's MD Type to be replaced. A field change does not reformat the rest of the file.
117
- A field holds a `FrontmatterValue`: null, a string, a boolean, a finite number, a list
118
- without holes or a plain object of them, holding no cycle. `frontmatterValue(value)` is that test, and
119
- `apply` refuses any other value as `frontmatter-fence`; `equalValue(left, right)` compares
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,
80
+ `itemFacts` and `memberFacts` take one step and `crossedFacts` reads a list's item facts;
81
+ `pointerSegments` and `escapePointer` split and write a pointer, `ARRAY_INDEX` matches an index
82
+ 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
+
95
+ A typed Document's frontmatter satisfies its type's schema, every keyword with its JSON Schema
96
+ meaning, formats asserted and defaults never filled, except that an object schema declaring neither
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 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
+
109
+ Validation returns acceptance or one refusal naming the file, the field or section, and the violated
110
+ rule. `parse`, `apply`, and `serialize` operate on a single text Document; they do not validate
111
+ collection membership or consume binary bytes. `apply(document, changes)` applies a list of changes
112
+ in one pass however many: each sets one typed field, a list or an object as a whole included,
113
+ replaces one existing section body or the preamble against its prior content, or rewrites one link
114
+ destination or one reference, as the given Document holds it. All apply or none: one refused refuses
115
+ all, and `{ outcome: 'stale', document, stale }` keeps the Document and lists the positions of each
116
+ change it does not hold and of each later change of a part an earlier one changes, such as a link
117
+ inside a replaced section. A section need not be declared by the Document's MD Type to be replaced.
118
+ A section or preamble replacement that would hide a section the Document carried behind a repeated,
119
+ merged or fenced heading is refused as `overlapping-section` naming that section. A field change
120
+ does not reformat the rest of the file: an inline value is replaced where it stands, and a value
121
+ written after the key's line, an empty one or a block mapping or list, is written after the key's
122
+ colon in its place. A field holds a `FrontmatterValue`: null, a string, a boolean, a finite number,
123
+ a list without holes or a plain object of them, holding no cycle. `frontmatterValue(value)` is that
124
+ test, and `apply` refuses any other value as `frontmatter-fence`; `equalValue(left, right)` compares
120
125
  two by value, whatever their key order, as `apply` compares a field with its prior.
121
126
 
122
- `Document.preamble` is a readonly string containing the exact source after
123
- frontmatter and before the first section heading recognized by the existing
124
- section parser. Without a section it is the entire post-frontmatter body;
125
- without frontmatter it starts at the beginning of the Document. An empty span
126
- is `''`. It includes whitespace, newlines, a leading H1, and any fenced text
127
- before the first section. The closing frontmatter delimiter and its line ending
128
- belong to frontmatter. Section recognition and the syntax profile are unchanged.
127
+ `Document.preamble` is a readonly string holding the exact source after frontmatter and before the
128
+ first section heading the section parser recognizes, `''` when empty, whitespace, newlines, a
129
+ leading H1 and any fenced text before the first section included. The closing frontmatter
130
+ delimiter and its line ending belong to frontmatter: `bodyAfterFrontmatter(content)` is the exact
131
+ source after them, the whole text when it opens no closed fence, and the preamble begins it.
132
+ `headingLines(content, from, to)` reads each ATX heading outside a fence, by `level` and `name`.
129
133
 
130
134
  ```ts
131
135
  const parsed = parse(content);
@@ -135,81 +139,89 @@ if (parsed.ok) {
135
139
  prior: parsed.document.preamble,
136
140
  value: 'Updated introduction.\n\n',
137
141
  };
138
- const result = apply(parsed.document, change);
142
+ const result = apply(parsed.document, [change]);
139
143
  if (result.outcome === 'applied') serialize(result.document);
140
144
  }
141
145
  ```
142
146
 
143
- `apply(document, { kind: 'preamble', prior, value })` compares `prior` to the
144
- current preamble exactly. A mismatch returns `{ outcome: 'stale', document }`
145
- with the unchanged current Document. A match replaces only that source span,
146
- then parses a new immutable Document; the original is unchanged. Frontmatter
147
- and section source outside the span retain their exact bytes, including newline
148
- and heading syntax. As with section replacement, `value` is literal source:
149
- no newline or separator is inserted, and the resulting source is parsed again.
150
- An invalid frontmatter result receives the existing parse refusal. Independent
151
- field, section, and preamble edits keep their own prior values valid.
152
-
153
- For a moved link, use `links` and the `link` change below to obtain the rewritten Document, then
154
- compare its public `preamble` and `sections` to the original. Submit the changed values with their
155
- original priors. Consumers need no source span calculation or private Model import. Collection
156
- validation remains a separate call against the resulting Library.
147
+ A `{ kind: 'preamble', prior, value }` change compares `prior` to the current preamble exactly. A
148
+ mismatch is stale and leaves the current Document unchanged. A match replaces only that source span,
149
+ then parses a new immutable Document; the original is unchanged. Frontmatter and section source
150
+ outside the span retain their exact bytes, including newline and heading syntax. As with section
151
+ replacement, `value` is literal source: no newline or separator is inserted, and the resulting
152
+ source is parsed again. An invalid frontmatter result receives the existing parse refusal.
153
+ Independent field, section, and preamble edits keep their own prior values valid.
154
+
155
+ For moved links, use `links` and one `link` change per destination below, then compare the rewritten
156
+ Document's `preamble` and `sections` to the original and submit the changed values with their
157
+ original priors, with no source span or private Model import. Collection validation remains a
158
+ separate call against the resulting Library.
157
159
 
158
160
  `links(document, file)` is the inventory of that Document's ordinary link and image destinations
159
161
  that resolve to a collection Path, each with the destination `href` exactly as written and the
160
162
  `target` Path it resolves to relative to `file`. A `?query` or `#fragment` the destination carries
161
163
  is part of `href` and not part of `target`. Entries are ordered by the position of the destination
162
164
  text a rewrite would change, and one destination written the same way appears once however many
163
- times it occurs. A destination that the syntax profile does not read as a link, one that is empty,
164
- a bare fragment, or carries a URL scheme, and one that leaves the collection are not in the
165
- inventory. Frontmatter field values, including typed references, are not link destinations and
166
- are never enumerated.
167
-
168
- `target(file, href)` is the collection Path one written destination resolves to relative to
169
- `file`, by the rule `links` and `validate` read: surrounding spaces and the `?query` or `#fragment`
170
- it carries are not part of that Path. A destination that is empty, a bare fragment, carries a URL
171
- scheme, starts at `/`, or leaves the collection resolves to `null`. It reads a destination written
172
- anywhere, such as a typed reference field value, which `links` never enumerates.
173
- `retarget(href, to)` is that destination rewritten to `to`, keeping the `?query` or `#fragment` it
174
- carried, which is the destination the `link` change below writes.
165
+ times it occurs. A destination that the syntax profile does not read as a link, one that is empty, a
166
+ bare fragment, or carries a URL scheme, and one that leaves the collection are not in the inventory.
167
+ Frontmatter values are never link destinations.
168
+
169
+ `target(file, href)` is the collection Path one written destination resolves to relative to `file`,
170
+ by the rule `links` and `validate` read: surrounding spaces and the `?query` or `#fragment` it
171
+ carries are not part of that Path. It reads backslash escapes and character references, strips as a
172
+ URL does, then percent-encodings, so `plan\.md`, `pl&#97;n.md` and `pl%61n.md` all name `plan.md`;
173
+ an escaped or referenced `?` or `#` starts the suffix. A destination that is empty, a bare fragment,
174
+ carries a URL scheme, starts at `/` once read, encodes no UTF-8 text, or leaves the collection
175
+ resolves to `null`. It reads a destination written anywhere, such as a typed reference field value,
176
+ which `links` never enumerates. `roomTarget(href)` reads `/rooms/<handle>/<path>` as its `handle`
177
+ and `path`, else `null`, and `roomPath(href)` is its canonical text, the target `facts` resolves for
178
+ any reference written so. `retarget(href, to)` is that destination rewritten to `to`, keeping the
179
+ `?query` or `#fragment` it carried, which is the destination the `link` change below writes. It
180
+ percent-encodes in `to` what `target` would decode, so it resolves to `to` again.
181
+
182
+ `checkDocument(file, content, model, context?)` reads one Document as `validate` does in that
183
+ context: `ok: false` where it refuses, else its `type`, whether it is `typed`, and each reference's
184
+ `target` and `to`, which `resolves(reference, typeOf, binary)` says reaches a member `validate`
185
+ accepts. `sectionReferences(file, content, definition)` reads only its `list` sections' references;
186
+ neither names another Room's, which `roomReferences(file, content, definition?)` lists by `kind`.
187
+ `parseFrontmatter(content, file?)` is `parse` without the body: `content`, `type`, `fields`.
175
188
 
176
189
  `references(document, definition)` lists each frontmatter `reference` string at any depth as
177
- `pointer`, `value` and `to`; `apply(document, { kind: 'reference', pointer, value, prior })`
178
- rewrites one in place, keeping its quotes, or is `stale`. `relativize(document, file, handle,
179
- definition?)` rewrites each link destination and reference written `/rooms/<handle>/<path>` to
180
- `relative(file, path)`, keeping its `?query` or `#fragment`. A text without frontmatter, such as
181
- a captured body, is read from its first character: `relativizeBody(body, file, handle)` converts
182
- it so, refusing a destination left under `/rooms/` as `unresolved-link`; `bodyLinks(body, file)`
183
- is its `links`; `relinkBody(body, file, moves)` writes, in one pass, each destination whose Path
184
- is a key of `moves` as relative to its value, in the form the `link` change below writes.
190
+ `pointer`, `value` and `to`; a `{ kind: 'reference', pointer, value, prior }` change rewrites one in
191
+ place, keeping its quotes, or is stale. `relativize(document, file, handle, definition?, kept?)`
192
+ rewrites, in one `apply`, each link destination and reference written `/rooms/<handle>/<path>` and
193
+ not in `kept` to `relative(file, path)`, keeping its `?query` or `#fragment`. A text without
194
+ frontmatter, such as a captured body, is read from its first character: `relativizeBody(body, file, handle)` converts it
195
+ so, refusing a `/rooms/` one naming no Room's file as `unresolved-link`; `bodyLinks(body, file)`
196
+ is its `links` and `bodyRoomLinks(body)` its other Rooms'. `relinkBody(body, file, moves)` writes,
197
+ in the `link` change's form, each destination whose Path keys `moves` as that value relative to
198
+ `file`, or as that value when it is a `/rooms/` path, and one whose `roomPath` does as that value.
185
199
 
186
200
  ```ts
187
201
  target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
188
202
  retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
189
203
  ```
190
204
 
191
- `apply(document, { kind: 'link', href, to })` rewrites every body occurrence of that written
192
- destination and changes nothing else, so a caller that moves a Path rewrites its referring
193
- Documents without a second Markdown parser. `to` is the Path the destination must resolve to
205
+ A `{ kind: 'link', href, to }` change rewrites every body occurrence of that written destination
206
+ and changes nothing else, so a caller that moves Paths rewrites each referring Document in one
207
+ `apply` without a second Markdown parser. `to` is the Path the destination must resolve to
194
208
  instead; the `?query` or `#fragment` the written destination carried is not part of that Path and
195
- is kept. A Document that does not carry the destination is `stale`. A reference definition is
209
+ is kept. A Document that does not carry the destination is stale. A reference definition is
196
210
  rewritten once however many uses name it. The destination is written in the form the syntax
197
211
  profile reads back: bare when it carries no whitespace, does not open with `<`, and balances its
198
212
  parentheses, otherwise inside angle brackets, which the original form is kept in when it still
199
213
  fits. A destination that neither form can carry is refused as `unwritable-link`.
200
214
 
201
- `project(document, file, context?)` is the Embedding projection input of one
202
- Document: the prose a consumer embeds, with every internal Markdown-document
203
- link reduced to the label a reader sees. A Document that declares no MD type
204
- contributes its body after the frontmatter fence. A typed one contributes its
205
- prose values, its preamble, and every H2 section its MD type does not declare as
206
- structure, each with its own heading line and every occurrence of a repeated
207
- name, in Document order: a declared text section, a list section of prose items
208
- and an undeclared section are in; a list section of any other item schema is
209
- not. A prose value is a frontmatter string at any depth whose schema is prose,
210
- projected bare and followed by a blank line, in the order the Document writes
211
- them, exactly as written. The Path and every other value stay outside, so
212
- changing them alone leaves the projection unchanged.
215
+ `project(document, file, context?)` is the Embedding projection input of one Document: the prose a
216
+ consumer embeds, with every internal Markdown-document link reduced to the label a reader sees. A
217
+ Document that declares no MD type contributes its body after the frontmatter fence. A typed one
218
+ contributes its prose values, its preamble, and every H2 section its MD type does not declare as
219
+ structure, each with its own heading line and every occurrence of a repeated name, in Document
220
+ order: a declared text section, a list section of prose items and an undeclared section are in; a
221
+ list section of any other item schema is not. A prose value is a frontmatter string at any depth
222
+ whose schema is prose, projected bare and followed by a blank line, in the order the Document writes
223
+ them, exactly as written. The Path and every other value stay outside, so changing them alone leaves
224
+ the projection unchanged.
213
225
 
214
226
  ```ts
215
227
  const parsed = parse(content);
@@ -222,35 +234,30 @@ if (parsed.ok) {
222
234
  }
223
235
  ```
224
236
 
225
- `ProjectionContext` carries `documentTargets`, the collection-relative Paths the
226
- caller holds as Markdown documents, and `definition`, the verified MD Type the
227
- Document's `type` names, taken from the model `verify` returned. A Document that
228
- declares a type the caller supplies no definition for is refused as
229
- `unknown-type`. `documentTargets` is what makes a destination internal: a
230
- destination resolving to a supplied Path is internal, and every other
231
- destination stays authored text, a binary target and a Path nobody
232
- supplied alike. The caller supplies that membership, as it does for `validate`;
233
- the model reads no bytes, resolves no authority, and classifies nothing it was
234
- not given.
235
-
236
- An internal link contributes its visible label and no destination, fragment, or
237
- title, in the inline `[label](path)`, full `[label][id]`, collapsed
238
- `[label][]`, and shortcut `[label]` forms, and the link reference definition an
239
- enumerated use resolves through leaves the projection with it. An image at a
240
- supplied document target contributes its alt text the same way, because a move
241
- rewrites that destination too. External URLs, binary targets,
242
- unsupplied destinations, bare fragments, code spans, fenced code, and escaped
243
- syntax stay exactly as authored, read through the same syntax profile `links`
244
- and `validate` read. `project` returns text and never rewrites the Document.
237
+ `ProjectionContext` carries `documentTargets`, the collection-relative Paths the caller holds as
238
+ Markdown documents, and `definition`, the verified MD Type the Document's `type` names, taken from
239
+ the model `verify` returned. A Document that declares a type the caller supplies no definition for
240
+ is refused as `unknown-type`. `documentTargets` is what makes a destination internal: a destination
241
+ resolving to a supplied Path is internal, as is one into another Room, and every other stays text, a
242
+ binary target and a Path nobody supplied alike. The caller supplies that membership, as it does for
243
+ `validate`; the model reads no bytes, resolves no authority, and classifies nothing it was not
244
+ given.
245
+
246
+ An internal link contributes its visible label and no destination, fragment, or title, in the inline
247
+ `[label](path)`, full `[label][id]`, collapsed `[label][]`, and shortcut `[label]` forms, and the
248
+ link reference definition an enumerated use resolves through leaves the projection with it. An image
249
+ at a supplied document target contributes its alt text the same way, because a move rewrites that
250
+ destination too. External URLs, binary targets, unsupplied destinations, bare fragments, code spans,
251
+ fenced code, and escaped syntax stay exactly as authored, read through the same syntax profile
252
+ `links` and `validate` read. `project` returns text and never rewrites the Document.
245
253
 
246
254
  A `link` change leaves the projection of every Document it rewrites
247
255
  byte-identical, while a changed visible label changes it.
248
256
 
249
- `divide(document, file, context)` divides that same Embedding projection input
250
- into ordered Spans under the budget the caller supplies. Each Span carries the
251
- `text` to embed and the `start` and `end` of the extent it addresses in the
252
- Document's own source, as UTF-8 byte offsets into that source and never string
253
- positions, so a caller stores the extent and hydrates the text it shows from
257
+ `divide(document, file, context)` divides that same Embedding projection input into ordered Spans
258
+ under the bound the caller supplies. Each Span carries the `text` to embed and the `start` and
259
+ `end` of the extent it addresses in the Document's own source, as UTF-8 byte offsets into that
260
+ source and never string positions, so a caller stores the extent and hydrates the text it shows from
254
261
  the Document itself.
255
262
 
256
263
  ```ts
@@ -259,54 +266,46 @@ if (parsed.ok) {
259
266
  const divided = divide(parsed.document, 'tasks/two.md', {
260
267
  documentTargets: ['plans/q3.md', 'people/ana.md'],
261
268
  definition: model.types.task,
262
- budget: 2000,
269
+ bound: 2000,
263
270
  });
264
271
  if (divided.ok) for (const span of divided.spans) embed(span.text);
265
272
  }
266
273
  ```
267
274
 
268
- `DivisionContext` is a `ProjectionContext` and one `budget`, the greatest number
269
- of characters a Span's embedded text may carry, counted the way JavaScript
270
- counts a string's length and not in the bytes the extent is measured in. No
271
- Span's text is ever longer than the budget. A bound cut never divides a
272
- character: where the budget ends between the two halves of a surrogate pair,
273
- the cut falls before the pair. A cut never falls inside link syntax either: it
274
- falls before an internal link, and a label longer than a whole piece's room is
275
- divided at the bound like any other text. The smallest budget is `2`, the
276
- length of one astral character; a budget that is not a whole number of at least
277
- `2` is refused with `division-budget` before any division. The budget is the
278
- caller's number alone: the model holds no tokenizer, counts nothing else, and
279
- refuses no input for being too long. A Document the caller supplies no
280
- definition for carries the same `unknown-type` refusal `project` returns.
281
-
282
- The division descends one level at a time, and only into the piece that does not
283
- fit: the whole input, a heading node, adjacent sibling nodes packed under one
284
- parent, adjacent blocks inside a node, sentences inside a block, and a bound cut
285
- inside a single sentence. A Span covers whole heading nodes or one contiguous
286
- piece inside a single node, never a partial node beside another. A Span that
287
- continues a node repeats that node's own heading line, projected like any other
288
- text and so carrying an internal link's label rather than its destination, and
289
- never an ancestor's heading, so renaming a heading costs what editing that
290
- heading's own body costs. A heading the budget cannot hold beside any text is
291
- not repeated, a continuation piece that begins with an astral character the
292
- room beside its heading cannot hold is carried without the heading, and a
293
- heading with no body of its own leads its first child node rather than standing
294
- as a Span of nothing but itself. Overlap exists at the
295
- sentence level alone, where each Span after the first repeats its predecessor's
296
- last sentence whenever the budget holds both; when it cannot hold both, the
297
- Span carries its own sentence alone. An untyped input arrives without a
298
- definition and descends the same ladder.
299
-
300
- Division is total: every authored character of the input belongs to at least one
301
- Span, and an input carrying no authored text divides into no Span at all. A
302
- Span's extent is the smallest range of the source that contains everything the
303
- Span covers, so it spans what the input excludes between two eligible pieces,
304
- 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
306
- author quoted. A Span divided out of one free-text field value addresses that
307
- whole value, because a YAML scalar's own positions are the only ones its source
308
- has, and a Span carrying part of one internal link's label addresses that whole
309
- link, because a cut never falls inside link syntax.
275
+ `DivisionContext` is a `ProjectionContext` and one `bound`, the greatest number of characters a
276
+ Span's embedded text may carry, counted the way JavaScript counts a string's length and not in the
277
+ bytes the extent is measured in. No Span's text is ever longer than the bound. A bound cut never
278
+ divides a character: where the bound ends between the two halves of a surrogate pair, the cut falls
279
+ before the pair. A cut never falls inside link syntax either: it falls before an internal link, and
280
+ a label longer than a whole piece's room is divided at the bound like any other text. The smallest
281
+ bound is `2`, the length of one astral character; a bound that is not a whole number of at least
282
+ `2` is refused with `division-bound` before any division. The bound is the caller's number alone:
283
+ the model holds no tokenizer, counts nothing else, and refuses no input for being too long. A
284
+ Document the caller supplies no definition for carries the same `unknown-type` refusal `project`
285
+ returns.
286
+
287
+ The division descends one level at a time, and only into the piece that does not fit: the whole
288
+ input, a heading node, adjacent sibling nodes packed under one parent, adjacent blocks inside a
289
+ node, sentences inside a block, and a bound cut inside a single sentence. A Span covers whole
290
+ heading nodes or one contiguous piece inside a single node, never a partial node beside another. A
291
+ Span that continues a node repeats that node's own heading line, projected like any other text and
292
+ so carrying an internal link's label rather than its destination, and never an ancestor's heading,
293
+ so renaming a heading costs what editing that heading's own body costs. A heading the bound cannot
294
+ hold beside any text is not repeated, a continuation piece that begins with an astral character the
295
+ room beside its heading cannot hold is carried without the heading, and a heading with no body of
296
+ its own leads its first child node rather than standing as a Span of nothing but itself. Overlap
297
+ exists at the sentence level alone, where each Span after the first repeats its predecessor's last
298
+ sentence whenever the bound holds both; when it cannot hold both, the Span carries its own sentence
299
+ alone. An untyped input arrives without a definition and descends the same ladder.
300
+
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.
310
309
 
311
310
  ## Conditions
312
311
 
@@ -319,11 +318,11 @@ an object holds the facts of its members, and a value written `null` is `null`.
319
318
  not fit its kind, such as a string in a number field, a value outside its `enum` or a reference
320
319
  `resolve` maps to no `{ id, member? }`, is `unreadable`; a readable reference compares as that `id`.
321
320
 
322
- `holds(test, facts, owner)` is `true`, `false` or `undefined`, unknown; a Trigger fires on `true`
323
- alone. A test's `path` is `/path`, `/type`, `/sections/<heading>`, `/fields/<pointer>`, or
324
- `/members/<pointer>`, the member of the Document a reference field reaches. A pointer segment that
325
- is not an index reads every item of a list, an item lacking it unknown, and a test over several
326
- 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.
327
326
 
328
327
  | The path reaches | `exists` | `contains` | any other test |
329
328
  | --------------------------------------- | ----------- | -------------- | -------------- |
@@ -341,19 +340,30 @@ and `in` are `undefined` against a value of another JSON type and compare a `tim
341
340
  `prefix` reads only a string, never a reference or a member; `gt`, `gte`, `lt` and `lte` order
342
341
  numbers, dates and times alone.
343
342
 
344
- `fires(condition, event, owner)` reads one change, `{ before, after, changed, by }`: the facts of
345
- each side, `null` on the side a creation or a deletion lacks, the `changed` paths whose prose
346
- changed, and the actor whose `/user`, `/site` and `/door`, one of `WRITE_DOORS`, a `by` test reads.
347
- `starts_matching` fires when the Document is in `scope` and holds `match` after the change and did
348
- not before; a creation fires only with `new_documents: true`, and a deletion never fires.
349
- `field_changes` fires when the side the Document has, after or for a deletion before, is in `scope`
350
- and holds `match`, and `field` changed: its facts differ, or with neither `from` nor `to` `changed`
351
- names it. A field absent on both sides never fires; `from: 'new'` admits only a creation and
352
- `to: 'deleted'` only a deletion, and listed values need that side to hold `field` `in` them.
353
-
354
- `itemFires(condition, item, owner)` compares `source` and `address` where given and holds `match`
355
- over `/delivery`, `/source`, `/provider`, `/container`, `/author`, `/has_attachment`,
356
- `/headers/<name>` and `/json/<pointer>`, unknown for an item with no JSON. `prosePaths(facts)` lists
357
- the prose and section paths whose text builds `changed`; `pointed(value, pointer)` reads a JSON
358
- Pointer, `undefined` where nothing is; `dated(value)` checks a `YYYY-MM-DD` date, and
359
- `instant(value)` reads an RFC 3339 time with its offset as epoch nanoseconds, a `bigint`.
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/`.