@agentshouse/mdmodel 0.1.0-ce29d61d6f303 → 0.1.0-ce8ce7ff57e88

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 (44) hide show
  1. package/API.md +185 -184
  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 +0 -1
  6. package/dist/condition.d.ts.map +1 -1
  7. package/dist/condition.js +13 -9
  8. package/dist/definition.d.ts +15 -0
  9. package/dist/definition.d.ts.map +1 -1
  10. package/dist/definition.js +224 -24
  11. package/dist/divide.d.ts.map +1 -1
  12. package/dist/divide.js +18 -8
  13. package/dist/document.d.ts +5 -2
  14. package/dist/document.d.ts.map +1 -1
  15. package/dist/document.js +318 -168
  16. package/dist/index.d.ts +9 -6
  17. package/dist/index.d.ts.map +1 -1
  18. package/dist/index.js +5 -4
  19. package/dist/links.d.ts +2 -0
  20. package/dist/links.d.ts.map +1 -1
  21. package/dist/links.js +23 -12
  22. package/dist/paths.d.ts +10 -1
  23. package/dist/paths.d.ts.map +1 -1
  24. package/dist/paths.js +115 -12
  25. package/dist/project.d.ts +1 -0
  26. package/dist/project.d.ts.map +1 -1
  27. package/dist/project.js +35 -10
  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 +44 -1
  32. package/dist/types.d.ts.map +1 -1
  33. package/dist/validate.d.ts +8 -1
  34. package/dist/validate.d.ts.map +1 -1
  35. package/dist/validate.js +205 -100
  36. package/fixtures/cases/cross-room-link/context.json +1 -0
  37. package/fixtures/cases/cross-room-link/expected.json +1 -0
  38. package/fixtures/cases/cross-room-link/library/clients/acme.md +6 -0
  39. package/fixtures/cases/cross-room-link/schema.yaml +3 -0
  40. package/fixtures/cases/cross-room-reference/context.json +1 -0
  41. package/fixtures/cases/cross-room-reference/expected.json +1 -0
  42. package/fixtures/cases/cross-room-reference/library/clients/acme.md +9 -0
  43. package/fixtures/cases/cross-room-reference/schema.yaml +9 -0
  44. package/package.json +4 -2
package/API.md CHANGED
@@ -26,30 +26,31 @@ 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. On a field of a
51
+ type's own `properties` alone, `change_roles` and `initial_roles` each list role names, and
52
+ `transitions` lists `{ from, to, roles? }`, each end a scalar or `null`, on a field whose `type`,
53
+ `enum`, `const`, `$ref`, `allOf`, `anyOf`, `oneOf`, `if` and `not` admit no list or object.
53
54
 
54
55
  ```yaml
55
56
  $defs:
@@ -64,69 +65,70 @@ plan:
64
65
  contact: { member_document: true }
65
66
  ```
66
67
 
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_FIELD`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every
100
- type, and the string `MEMBER_FIELD` on the `member_document` type; `HOUSE_FIELDS`
101
- lists the four. A refusal names the keyword, such as `required`, and the
102
- value's JSON Pointer, such as `/shipping/city`. Every occurrence of a declared
103
- list section is a list of values of its item schema, else `structured-section`;
104
- a reference item is one ordinary link alone, such as `- [Ada](ada.md)`. A
105
- reference, at any depth or a section item, reaching a URL, a binary target, or a
106
- Document of a type it does not name is `unresolved-reference`, and a frontmatter
107
- one reaching no member is `referenced-missing-file` naming its `referrers`;
108
- `attachment` admits any path, and no body link is a referrer.
68
+ The model's `types` expose each MD Type's `name`, `memberDocument`, `sections`, `shape` (the type as
69
+ written, its rule keywords left out, with every `$defs` shape it reaches), `createRoles` and
70
+ `deleteRoles` when written, its `rules` by field as `changeRoles`, `initialRoles` and `transitions`,
71
+ the facts of its `frontmatter` and `fields`, its top-level ones: JSON `type`, `format`, `values`,
72
+ `reference` targets, `items`, `properties`, an open map's `patterns` and `additional`, and `prose`,
73
+ a string with no `enum`, `const`, `format`, `pattern` or `reference`. Facts join `$ref` and `allOf`
74
+ to their siblings and the variants of `anyOf`, `oneOf`, `then`, `else` and `dependentSchemas`, a
75
+ variant's own keys `conditional`; a path without one `type`, `null` aside, has none. A malformed
76
+ schema is refused whole, naming its `rule`, the keyword or the model's own, and the JSON Pointer
77
+ `location` it concerns, such as `/plan/properties/status/enum`, or `line <n>` outside the YAML
78
+ subset. `pointerFacts(definition, pointer)` reads the facts a frontmatter pointer reaches,
79
+ `itemFacts` and `memberFacts` take one step and `crossedFacts` reads a list's item facts;
80
+ `pointerSegments` and `escapePointer` split and write a pointer, `ARRAY_INDEX` matches an index
81
+ segment, and `ATTACHMENT` is the `reference` that admits any path.
82
+
83
+ `validate(library, context?, model?)` takes the resulting text Library and one `ValidationContext`
84
+ of `binaryTargets: readonly string[]`, none when omitted. Library keys and binary targets share one
85
+ canonical collection-relative path namespace; a path declared text and binary is refused. House
86
+ declares every binary file of the Room as a binary target, and the model reads no bytes. Ordinary
87
+ links and images in typed Documents may resolve to either membership, relative to the source
88
+ Document, and one to a path neither holds is not refused: it dangles, as a deleted file's links do.
89
+ One written `/rooms/<handle>/<path>` names a file in another Room, which the caller checks; any
90
+ other absolute path, or one that leaves the collection, is `unresolved-link`. A binary target
91
+ supplies no Document or MD Type. `model` is the verified schema that types the Library, and every
92
+ Library member is content, whatever its Path. Without `model` the Library declares no type.
93
+
94
+ A typed Document's frontmatter satisfies its type's schema, every keyword with its JSON Schema
95
+ meaning, formats asserted and defaults never filled, except that an object schema declaring neither
96
+ `additionalProperties` nor `unevaluatedProperties` is closed: an undeclared key is refused as
97
+ `undeclared- field`. `TYPE_FIELD`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every
98
+ type, and the string `MEMBER_FIELD` on the `member_document` type; `HOUSE_FIELDS` lists the four. A
99
+ refusal names the keyword, such as `required`, and the value's JSON Pointer, such as
100
+ `/shipping/city`. Every occurrence of a declared list section is a list of values of its item
101
+ schema, else `structured-section`; a reference item is one ordinary link alone, such as
102
+ `- [Ada](ada.md)`. A reference, at any depth or a section item, reaching a URL, a binary target,
103
+ another Room without `cross_room`, or a Document of a type it does not name is
104
+ `unresolved-reference`, and a frontmatter one reaching no member is `referenced-missing-file` naming
105
+ its `referrers`; `attachment` admits any path, and no body link is a referrer. `validating` yields
106
+ each path `validate` reads, then returns its verdict.
109
107
 
110
108
  Validation returns acceptance or one refusal naming the file, the field or section, and the violated
111
109
  rule. `parse`, `apply`, and `serialize` operate on a single text Document; they do not validate
112
- collection membership or consume binary bytes. `apply` sets one typed field, including a list or an
113
- object as a whole, replaces one existing section body or the preamble against that value's prior
114
- content, or rewrites one Markdown link destination. A section need not be declared by the Document's
115
- MD Type to be replaced. A field change does not reformat the rest of the file: an inline value is
116
- replaced where it stands, and a value written after the key's line, an empty one or a block mapping
117
- or list, is written after the key's colon in its place. A field holds a `FrontmatterValue`: null, a
118
- string, a boolean, a finite number, a list without holes or a plain object of them, holding no
119
- cycle. `frontmatterValue(value)` is that test, and `apply` refuses any other value as
120
- `frontmatter-fence`; `equalValue(left, right)` compares two by value, whatever their key order, as
121
- `apply` compares a field with its prior.
122
-
123
- `Document.preamble` is a readonly string containing the exact source after
124
- frontmatter and before the first section heading recognized by the existing
125
- section parser. Without a section it is the entire post-frontmatter body;
126
- without frontmatter it starts at the beginning of the Document. An empty span
127
- is `''`. It includes whitespace, newlines, a leading H1, and any fenced text
128
- before the first section. The closing frontmatter delimiter and its line ending
129
- belong to frontmatter. Section recognition and the syntax profile are unchanged.
110
+ collection membership or consume binary bytes. `apply(document, changes)` applies a list of changes
111
+ in one pass however many: each sets one typed field, a list or an object as a whole included,
112
+ replaces one existing section body or the preamble against its prior content, or rewrites one link
113
+ destination or one reference, as the given Document holds it. All apply or none: one refused refuses
114
+ all, and `{ outcome: 'stale', document, stale }` keeps the Document and lists the positions of each
115
+ change it does not hold and of each later change of a part an earlier one changes, such as a link
116
+ inside a replaced section. A section need not be declared by the Document's MD Type to be replaced.
117
+ A section or preamble replacement that would hide a section the Document carried behind a repeated,
118
+ merged or fenced heading is refused as `overlapping-section` naming that section. A field change
119
+ does not reformat the rest of the file: an inline value is replaced where it stands, and a value
120
+ written after the key's line, an empty one or a block mapping or list, is written after the key's
121
+ colon in its place. A field holds a `FrontmatterValue`: null, a string, a boolean, a finite number,
122
+ a list without holes or a plain object of them, holding no cycle. `frontmatterValue(value)` is that
123
+ test, and `apply` refuses any other value as `frontmatter-fence`; `equalValue(left, right)` compares
124
+ two by value, whatever their key order, as `apply` compares a field with its prior.
125
+
126
+ `Document.preamble` is a readonly string holding the exact source after frontmatter and before the
127
+ first section heading the section parser recognizes, `''` when empty, whitespace, newlines, a
128
+ leading H1 and any fenced text before the first section included. The closing frontmatter
129
+ delimiter and its line ending belong to frontmatter: `bodyAfterFrontmatter(content)` is the exact
130
+ source after them, the whole text when it opens no closed fence, and the preamble begins it.
131
+ `headingLines(content, from, to)` reads each ATX heading outside a fence, by `level` and `name`.
130
132
 
131
133
  ```ts
132
134
  const parsed = parse(content);
@@ -136,81 +138,90 @@ if (parsed.ok) {
136
138
  prior: parsed.document.preamble,
137
139
  value: 'Updated introduction.\n\n',
138
140
  };
139
- const result = apply(parsed.document, change);
141
+ const result = apply(parsed.document, [change]);
140
142
  if (result.outcome === 'applied') serialize(result.document);
141
143
  }
142
144
  ```
143
145
 
144
- `apply(document, { kind: 'preamble', prior, value })` compares `prior` to the
145
- current preamble exactly. A mismatch returns `{ outcome: 'stale', document }`
146
- with the unchanged current Document. A match replaces only that source span,
147
- then parses a new immutable Document; the original is unchanged. Frontmatter
148
- and section source outside the span retain their exact bytes, including newline
149
- and heading syntax. As with section replacement, `value` is literal source:
150
- no newline or separator is inserted, and the resulting source is parsed again.
151
- An invalid frontmatter result receives the existing parse refusal. Independent
152
- field, section, and preamble edits keep their own prior values valid.
153
-
154
- For a moved link, use `links` and the `link` change below to obtain the rewritten Document, then
155
- compare its public `preamble` and `sections` to the original. Submit the changed values with their
156
- original priors. Consumers need no source span calculation or private Model import. Collection
157
- validation remains a separate call against the resulting Library.
146
+ A `{ kind: 'preamble', prior, value }` change compares `prior` to the current preamble exactly. A
147
+ mismatch is stale and leaves the current Document unchanged. A match replaces only that source span,
148
+ then parses a new immutable Document; the original is unchanged. Frontmatter and section source
149
+ outside the span retain their exact bytes, including newline and heading syntax. As with section
150
+ replacement, `value` is literal source: no newline or separator is inserted, and the resulting
151
+ source is parsed again. An invalid frontmatter result receives the existing parse refusal.
152
+ Independent field, section, and preamble edits keep their own prior values valid.
153
+
154
+ For moved links, use `links` and one `link` change per destination below, then compare the rewritten
155
+ Document's `preamble` and `sections` to the original and submit the changed values with their
156
+ original priors, with no source span or private Model import. Collection validation remains a
157
+ separate call against the resulting Library.
158
158
 
159
159
  `links(document, file)` is the inventory of that Document's ordinary link and image destinations
160
160
  that resolve to a collection Path, each with the destination `href` exactly as written and the
161
161
  `target` Path it resolves to relative to `file`. A `?query` or `#fragment` the destination carries
162
162
  is part of `href` and not part of `target`. Entries are ordered by the position of the destination
163
163
  text a rewrite would change, and one destination written the same way appears once however many
164
- times it occurs. A destination that the syntax profile does not read as a link, one that is empty,
165
- a bare fragment, or carries a URL scheme, and one that leaves the collection are not in the
166
- inventory. Frontmatter field values, including typed references, are not link destinations and
167
- are never enumerated.
168
-
169
- `target(file, href)` is the collection Path one written destination resolves to relative to
170
- `file`, by the rule `links` and `validate` read: surrounding spaces and the `?query` or `#fragment`
171
- it carries are not part of that Path. A destination that is empty, a bare fragment, carries a URL
172
- scheme, starts at `/`, or leaves the collection resolves to `null`. It reads a destination written
173
- anywhere, such as a typed reference field value, which `links` never enumerates.
174
- `retarget(href, to)` is that destination rewritten to `to`, keeping the `?query` or `#fragment` it
175
- carried, which is the destination the `link` change below writes.
164
+ times it occurs. A destination that the syntax profile does not read as a link, one that is empty, a
165
+ bare fragment, or carries a URL scheme, and one that leaves the collection are not in the inventory.
166
+ Frontmatter values are never link destinations. `linkOccurrences(document, file)` places each
167
+ occurrence by its `start` in `content`, and `fieldStart(document, pointer)` a frontmatter value.
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
+ `cross_room`. `retarget(href, to)` is that destination rewritten to `to`, keeping the `?query` or
179
+ `#fragment` it carried, which is the destination the `link` change below writes. It percent-encodes
180
+ in `to` what `target` would decode, so it resolves to `to` again.
181
+
182
+ `checkDocument(file, content, model)` reads one Document alone by the same rules: `ok: false` where
183
+ `validate` refuses it, else its `type`, whether it is `typed`, and each reference's `target` and
184
+ `to`, which `resolves(reference, typeOf, binary)` says reaches a member `validate` accepts.
185
+ `sectionReferences(file, content, definition)` reads only the references of its `list` sections;
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` and `fields`.
176
188
 
177
189
  `references(document, definition)` lists each frontmatter `reference` string at any depth as
178
- `pointer`, `value` and `to`; `apply(document, { kind: 'reference', pointer, value, prior })`
179
- rewrites one in place, keeping its quotes, or is `stale`. `relativize(document, file, handle,
180
- definition?)` rewrites each link destination and reference written `/rooms/<handle>/<path>` to
181
- `relative(file, path)`, keeping its `?query` or `#fragment`. A text without frontmatter, such as
182
- a captured body, is read from its first character: `relativizeBody(body, file, handle)` converts
183
- it so, refusing a destination left under `/rooms/` as `unresolved-link`; `bodyLinks(body, file)`
184
- is its `links`; `relinkBody(body, file, moves)` writes, in one pass, each destination whose Path
185
- 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?)` rewrites,
192
+ in one `apply`, each link destination and reference written `/rooms/<handle>/<path>` to
193
+ `relative(file, path)`, keeping its `?query` or `#fragment`. A text without frontmatter, such as a
194
+ 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`, and one whose `roomPath` does as that value.
186
199
 
187
200
  ```ts
188
201
  target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
189
202
  retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
190
203
  ```
191
204
 
192
- `apply(document, { kind: 'link', href, to })` rewrites every body occurrence of that written
193
- destination and changes nothing else, so a caller that moves a Path rewrites its referring
194
- 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
195
208
  instead; the `?query` or `#fragment` the written destination carried is not part of that Path and
196
- 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
197
210
  rewritten once however many uses name it. The destination is written in the form the syntax
198
211
  profile reads back: bare when it carries no whitespace, does not open with `<`, and balances its
199
212
  parentheses, otherwise inside angle brackets, which the original form is kept in when it still
200
213
  fits. A destination that neither form can carry is refused as `unwritable-link`.
201
214
 
202
- `project(document, file, context?)` is the Embedding projection input of one
203
- Document: the prose a consumer embeds, with every internal Markdown-document
204
- link reduced to the label a reader sees. A Document that declares no MD type
205
- contributes its body after the frontmatter fence. A typed one contributes its
206
- prose values, its preamble, and every H2 section its MD type does not declare as
207
- structure, each with its own heading line and every occurrence of a repeated
208
- name, in Document order: a declared text section, a list section of prose items
209
- and an undeclared section are in; a list section of any other item schema is
210
- not. A prose value is a frontmatter string at any depth whose schema is prose,
211
- projected bare and followed by a blank line, in the order the Document writes
212
- them, exactly as written. The Path and every other value stay outside, so
213
- 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.
214
225
 
215
226
  ```ts
216
227
  const parsed = parse(content);
@@ -223,35 +234,30 @@ if (parsed.ok) {
223
234
  }
224
235
  ```
225
236
 
226
- `ProjectionContext` carries `documentTargets`, the collection-relative Paths the
227
- caller holds as Markdown documents, and `definition`, the verified MD Type the
228
- Document's `type` names, taken from the model `verify` returned. A Document that
229
- declares a type the caller supplies no definition for is refused as
230
- `unknown-type`. `documentTargets` is what makes a destination internal: a
231
- destination resolving to a supplied Path is internal, and every other
232
- destination stays authored text, a binary target and a Path nobody
233
- supplied alike. The caller supplies that membership, as it does for `validate`;
234
- the model reads no bytes, resolves no authority, and classifies nothing it was
235
- not given.
236
-
237
- An internal link contributes its visible label and no destination, fragment, or
238
- title, in the inline `[label](path)`, full `[label][id]`, collapsed
239
- `[label][]`, and shortcut `[label]` forms, and the link reference definition an
240
- enumerated use resolves through leaves the projection with it. An image at a
241
- supplied document target contributes its alt text the same way, because a move
242
- rewrites that destination too. External URLs, binary targets,
243
- unsupplied destinations, bare fragments, code spans, fenced code, and escaped
244
- syntax stay exactly as authored, read through the same syntax profile `links`
245
- 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.
246
253
 
247
254
  A `link` change leaves the projection of every Document it rewrites
248
255
  byte-identical, while a changed visible label changes it.
249
256
 
250
- `divide(document, file, context)` divides that same Embedding projection input
251
- into ordered Spans under the budget the caller supplies. Each Span carries the
252
- `text` to embed and the `start` and `end` of the extent it addresses in the
253
- Document's own source, as UTF-8 byte offsets into that source and never string
254
- 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 budget 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
255
261
  the Document itself.
256
262
 
257
263
  ```ts
@@ -266,19 +272,17 @@ if (parsed.ok) {
266
272
  }
267
273
  ```
268
274
 
269
- `DivisionContext` is a `ProjectionContext` and one `budget`, the greatest number
270
- of characters a Span's embedded text may carry, counted the way JavaScript
271
- counts a string's length and not in the bytes the extent is measured in. No
272
- Span's text is ever longer than the budget. A bound cut never divides a
273
- character: where the budget ends between the two halves of a surrogate pair,
274
- the cut falls before the pair. A cut never falls inside link syntax either: it
275
- falls before an internal link, and a label longer than a whole piece's room is
276
- divided at the bound like any other text. The smallest budget is `2`, the
277
- length of one astral character; a budget that is not a whole number of at least
278
- `2` is refused with `division-budget` before any division. The budget is the
279
- caller's number alone: the model holds no tokenizer, counts nothing else, and
280
- refuses no input for being too long. A Document the caller supplies no
281
- definition for carries the same `unknown-type` refusal `project` returns.
275
+ `DivisionContext` is a `ProjectionContext` and one `budget`, 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 budget. A bound cut never
278
+ divides a character: where the budget 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
+ budget is `2`, the length of one astral character; a budget that is not a whole number of at least
282
+ `2` is refused with `division-budget` before any division. The budget 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.
282
286
 
283
287
  The division descends one level at a time, and only into the piece that does not fit: the whole
284
288
  input, a heading node, adjacent sibling nodes packed under one parent, adjacent blocks inside a
@@ -294,16 +298,14 @@ exists at the sentence level alone, where each Span after the first repeats its
294
298
  sentence whenever the budget holds both; when it cannot hold both, the Span carries its own sentence
295
299
  alone. An untyped input arrives without a definition and descends the same ladder.
296
300
 
297
- Division is total: every authored character of the input belongs to at least one
298
- Span, and an input carrying no authored text divides into no Span at all. A
299
- Span's extent is the smallest range of the source that contains everything the
300
- Span covers, so it spans what the input excludes between two eligible pieces,
301
- and the extent addresses the authored source where the embedded text carries a
302
- repeated heading, an internal link's visible label, or a frontmatter value the
303
- author quoted. A Span divided out of one free-text field value addresses that
304
- whole value, because a YAML scalar's own positions are the only ones its source
305
- has, and a Span carrying part of one internal link's label addresses that whole
306
- 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.
307
309
 
308
310
  ## Conditions
309
311
 
@@ -349,10 +351,9 @@ names it. A field absent on both sides never fires; `from: 'new'` admits only a
349
351
  `to: 'deleted'` only a deletion, and listed values need that side to hold `field` `in` them.
350
352
 
351
353
  `itemFires(condition, item, owner)` compares `source` and `address` where given and holds `match`
352
- over `/delivery`, `/source`, `/provider`, `/container`, `/author`, `/has_attachment`,
353
- `/headers/<name>` and `/json/<pointer>`, unknown for an item with no JSON. `prosePaths(facts)` lists
354
- the prose and section paths whose text builds `changed`; `pointed(value, pointer)` reads a JSON
355
- Pointer, `undefined` where nothing is; `dated(value)` checks a `YYYY-MM-DD` date, and
356
- `instant(value)` reads an RFC 3339 time with its offset as epoch nanoseconds, a `bigint`.
357
- `datePointers(fields)` lists, sorted, the `/fields/<name>` pointers of a type's date fields, the
358
- only values a `DateCondition`'s `date` takes.
354
+ over `/delivery`, `/source`, `/container`, `/author`, `/has_attachment`, `/headers/<name>` and
355
+ `/json/<pointer>`, unknown for an item with no JSON. `prosePaths(facts)` lists the prose and section
356
+ paths whose text builds `changed`; `pointed(value, pointer)` reads a JSON Pointer, `undefined` where
357
+ nothing is; `dated(value)` checks a `YYYY-MM-DD` date, and `instant(value)` reads an RFC 3339 time
358
+ with its offset as epoch nanoseconds, a `bigint`. `datePointers(fields)` lists, sorted, the
359
+ `/fields/<name>` pointers of a type's date fields, the only values a `DateCondition`'s `date` takes.
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"}
package/dist/blocks.js CHANGED
@@ -1,5 +1,5 @@
1
- import { fenceSpans } from './links.js';
2
- const HEADING = /^(#{1,6})(?!#)[ \t]+(.+?)[ \t]*#*[ \t]*$/;
1
+ import { fenceSpans, spanCursor } from './links.js';
2
+ const HEADING = /^(#{1,6})(?!#)[ \t]+(.+?)(?:[ \t]+#+)?[ \t]*$/;
3
3
  function lineAt(content, from, to) {
4
4
  const nl = content.indexOf('\n', from);
5
5
  const end = nl === -1 || nl >= to ? to : nl;
@@ -7,17 +7,11 @@ function lineAt(content, from, to) {
7
7
  return { text: raw.endsWith('\r') ? raw.slice(0, -1) : raw, next: end === to ? to : end + 1 };
8
8
  }
9
9
  function scan(content, from, to, visit) {
10
- const fences = fenceSpans(content.slice(from, to));
10
+ const fenced = spanCursor(fenceSpans(content.slice(from, to)));
11
11
  let i = from;
12
12
  while (i < to) {
13
13
  const { text, next } = lineAt(content, i, to);
14
- const at = i - from;
15
- visit({
16
- text,
17
- start: i,
18
- next,
19
- fenced: fences.some(([start, end]) => at >= start && at < end),
20
- });
14
+ visit({ text, start: i, next, fenced: fenced(i - from) !== undefined });
21
15
  if (next === i)
22
16
  break;
23
17
  i = next;
@@ -26,16 +20,15 @@ function scan(content, from, to, visit) {
26
20
  const HASH = 0x23;
27
21
  export function headingLines(content, from, to) {
28
22
  const found = [];
29
- let fences = null;
23
+ let fenced = null;
30
24
  let i = from;
31
25
  while (i < to) {
32
26
  const nl = content.indexOf('\n', i);
33
27
  const end = nl === -1 || nl >= to ? to : nl;
34
28
  const next = end === to ? to : end + 1;
35
29
  if (content.charCodeAt(i) === HASH) {
36
- fences ??= fenceSpans(content.slice(from, to));
37
- const at = i - from;
38
- if (!fences.some(([start, stop]) => at >= start && at < stop)) {
30
+ fenced ??= spanCursor(fenceSpans(content.slice(from, to)));
31
+ if (fenced(i - from) === undefined) {
39
32
  const { text } = lineAt(content, i, to);
40
33
  const match = HEADING.exec(text);
41
34
  const hashes = match?.[1];