@agentshouse/mdmodel 0.1.0-c896b3d9398b1 → 0.1.0-cabd61587647f

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