@agentshouse/mdmodel 0.1.0-c5a71fe539a49 → 0.1.0-c5f7707614979

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/API.md +220 -164
  2. package/dist/blocks.d.ts.map +1 -1
  3. package/dist/blocks.js +31 -17
  4. package/dist/condition.d.ts +19 -6
  5. package/dist/condition.d.ts.map +1 -1
  6. package/dist/condition.js +218 -110
  7. package/dist/definition.d.ts +23 -0
  8. package/dist/definition.d.ts.map +1 -1
  9. package/dist/definition.js +266 -25
  10. package/dist/document.d.ts +7 -8
  11. package/dist/document.d.ts.map +1 -1
  12. package/dist/document.js +105 -49
  13. package/dist/fields.d.ts +2 -0
  14. package/dist/fields.d.ts.map +1 -1
  15. package/dist/fields.js +7 -0
  16. package/dist/index.d.ts +11 -7
  17. package/dist/index.d.ts.map +1 -1
  18. package/dist/index.js +7 -5
  19. package/dist/links.d.ts +1 -0
  20. package/dist/links.d.ts.map +1 -1
  21. package/dist/links.js +1 -1
  22. package/dist/paths.d.ts +1 -0
  23. package/dist/paths.d.ts.map +1 -1
  24. package/dist/paths.js +92 -12
  25. package/dist/references.d.ts +2 -2
  26. package/dist/references.d.ts.map +1 -1
  27. package/dist/schema.js +2 -2
  28. package/dist/types.d.ts +32 -1
  29. package/dist/types.d.ts.map +1 -1
  30. package/dist/validate.d.ts +5 -1
  31. package/dist/validate.d.ts.map +1 -1
  32. package/dist/validate.js +152 -102
  33. package/dist/yaml.d.ts +7 -3
  34. package/dist/yaml.d.ts.map +1 -1
  35. package/dist/yaml.js +72 -43
  36. package/fixtures/README.md +1 -1
  37. package/fixtures/cases/absent-link-dangles/context.json +1 -0
  38. package/fixtures/cases/absent-link-dangles/expected.json +1 -0
  39. package/fixtures/cases/absent-link-dangles/library/item.md +8 -0
  40. package/fixtures/cases/absent-link-dangles/schema.yaml +6 -0
  41. package/fixtures/cases/absolute-link/context.json +1 -0
  42. package/fixtures/cases/{missing-binary-image → absolute-link}/expected.json +1 -1
  43. package/fixtures/cases/absolute-link/library/item.md +8 -0
  44. package/fixtures/cases/absolute-link/schema.yaml +6 -0
  45. package/fixtures/cases/binary-image-dangles/expected.json +1 -0
  46. package/fixtures/cases/binary-link-dangles/expected.json +1 -0
  47. package/fixtures/cases/quoted-link-definition/library/notes/draft.md +1 -1
  48. package/fixtures/cases/shortcut-reference-link/library/item.md +1 -1
  49. package/fixtures/cases/truncated-link-definition/library/notes/draft.md +1 -1
  50. package/fixtures/cases/unresolved-link/library/item.md +1 -1
  51. package/package.json +4 -2
  52. package/fixtures/cases/missing-binary-link/expected.json +0 -5
  53. /package/fixtures/cases/{missing-binary-image → binary-image-dangles}/context.json +0 -0
  54. /package/fixtures/cases/{missing-binary-image → binary-image-dangles}/library/notes/draft.md +0 -0
  55. /package/fixtures/cases/{missing-binary-image → binary-image-dangles}/schema.yaml +0 -0
  56. /package/fixtures/cases/{missing-binary-link → binary-link-dangles}/context.json +0 -0
  57. /package/fixtures/cases/{missing-binary-link → binary-link-dangles}/library/notes/draft.md +0 -0
  58. /package/fixtures/cases/{missing-binary-link → binary-link-dangles}/schema.yaml +0 -0
package/API.md CHANGED
@@ -38,15 +38,20 @@ if (parsed.ok) {
38
38
  }
39
39
  ```
40
40
 
41
- `verify(schema)` reads one schema text, the MD Types of one Room or App: one
42
- JSON Schema document (draft 2020-12) in the YAML subset. Every top-level key but
43
- `$defs` names an MD Type holding the JSON Schema of its frontmatter; `$defs`
44
- holds shapes the types reuse, reached by a `$ref` under `#/$defs/` alone. `type`
45
- and the built-in `any` are never declared. The model adds three keywords:
46
- `reference` on a string names one MD Type, several, `any` or `attachment`;
47
- `sections` declares a type's H2 sections, each `{ kind: text }` or `{ kind:
48
- list, items }` over one string, number, integer or boolean, optionally
49
- `required: true`; `member_document: true` marks at most one type.
41
+ `MARKDOWN_SYNTAX_PROFILE` is the Markdown every reader here applies, GitHub Flavored Markdown
42
+ 0.29, and `VERSION` is the MD model version.
43
+
44
+ `verify(schema)` reads one schema text, the MD Types of one Room or App: one JSON Schema document
45
+ (draft 2020-12) in the YAML subset. Every top-level key but `$defs` names an MD Type holding the
46
+ JSON Schema of its frontmatter; `$defs` holds shapes the types reuse, reached by a `$ref` under
47
+ `#/$defs/` alone. `type` and the built-in `any` are never declared. The model adds its keywords:
48
+ `reference` on a string names one MD Type, several, `any` or `attachment`; `sections` declares a
49
+ type's H2 sections, each `{ kind: text }` or `{ kind: list, items }` over one string, number,
50
+ integer or boolean, optionally `required: true`; `member_document: true` marks at most one type. A
51
+ type alone takes `create_roles` and `delete_roles`, each a list of role names. 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.
50
55
 
51
56
  ```yaml
52
57
  $defs:
@@ -61,60 +66,65 @@ plan:
61
66
  contact: { member_document: true }
62
67
  ```
63
68
 
64
- The model's `types` expose each MD Type's `name`, `memberDocument`, `sections`,
65
- `shape` (the type as written with every `$defs` shape it reaches), the facts of
66
- its `frontmatter` and `fields`, its top-level ones: JSON `type`, `format`,
67
- `values`, `reference` targets, `items`, `properties`, an open map's `patterns`
68
- and `additional`, and `prose`, a string with no `enum`, `const`, `format`,
69
- `pattern` or `reference`. Facts join `$ref` and `allOf` to their siblings and
70
- the variants of `anyOf`, `oneOf`, `then`, `else` and `dependentSchemas`; a path
71
- without one `type`, `null` aside, has none. A malformed schema is refused
72
- whole, naming its `rule`, the keyword or the model's own, and the JSON Pointer
73
- `location` it concerns, such as `/plan/properties/status/enum`, or `line <n>`
74
- outside the YAML subset.
75
-
76
- `validate(library, context?, model?)` takes the resulting text Library and one
77
- `ValidationContext` of `binaryTargets: readonly string[]`, none when omitted.
78
- Library keys and binary targets share one canonical collection-relative path
79
- namespace; a path declared text and binary is refused. House declares every
80
- binary file of the Room as a binary target, and the model reads no bytes. Ordinary links and images
81
- in typed Documents may resolve to either membership, relative to the source
82
- Document, and one to a path neither holds is not refused: it dangles, as a
83
- deleted file's links do. A destination that is an absolute path or leaves the
84
- collection is `unresolved-link`. A binary target supplies no Document or MD Type. `model` is the
85
- verified schema that types the Library, and every Library member is content,
86
- whatever its Path. Without `model` the Library declares no type.
87
-
88
- A typed Document's frontmatter satisfies its type's schema, every keyword with
89
- its JSON Schema meaning, formats asserted and defaults never filled, except that
90
- an object schema declaring neither `additionalProperties` nor
91
- `unevaluatedProperties` is closed: an undeclared key is refused as `undeclared-
92
- field`. `type`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every
93
- type, and the string `MEMBER_FIELD` on the `member_document` type. A refusal
94
- names the keyword, such as `required`, and the value's JSON Pointer, such as
95
- `/shipping/city`. Every occurrence of a declared list section is a list of
96
- values of its item schema, else `structured-section`; a reference item is one
97
- ordinary link alone, such as `- [Ada](ada.md)`. A reference, at any depth or a
98
- section item, reaching a URL, a binary target, or a Document of a type it does
99
- not name is `unresolved-reference`, and a frontmatter one reaching no member is
100
- `referenced-missing-file` naming its `referrers`; `attachment` admits any path,
101
- and no body link is a referrer.
102
-
103
- Validation returns acceptance or one refusal naming the file, the field or
104
- section, and the violated rule. `parse`, `apply`, and `serialize` operate on a single text
105
- Document; they do not validate collection membership or consume binary bytes.
106
- `apply` sets one typed field, including a list field as a whole, replaces
107
- one existing section body or the preamble against that value's prior content,
108
- or rewrites one Markdown link destination. A section need not be declared by
109
- the Document's MD Type to be replaced. A field change does not reformat the rest of the file.
110
-
111
- `Document.preamble` is a readonly string containing the exact source after
112
- frontmatter and before the first section heading recognized by the existing
113
- section parser. Without a section it is the entire post-frontmatter body;
114
- without frontmatter it starts at the beginning of the Document. An empty span
115
- is `''`. It includes whitespace, newlines, a leading H1, and any fenced text
116
- before the first section. The closing frontmatter delimiter and its line ending
117
- belong to frontmatter. Section recognition and the syntax profile are unchanged.
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
+ A destination that is an absolute path or leaves the collection is `unresolved-link`. A binary
91
+ target supplies no Document or MD Type. `model` is the verified schema that types the Library, and
92
+ every 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, or a
103
+ Document of a type it does not name is `unresolved-reference`, and a frontmatter one reaching no
104
+ member is `referenced-missing-file` naming its `referrers`; `attachment` admits any path, and no
105
+ body link is a referrer.
106
+
107
+ Validation returns acceptance or one refusal naming the file, the field or section, and the violated
108
+ rule. `parse`, `apply`, and `serialize` operate on a single text Document; they do not validate
109
+ collection membership or consume binary bytes. `apply` sets one typed field, including a list or an
110
+ object as a whole, replaces one existing section body or the preamble against that value's prior
111
+ content, or rewrites one Markdown link destination. A section need not be declared by the Document's
112
+ MD Type to be replaced. A section or preamble replacement that would hide a section the Document
113
+ carried behind a repeated, merged or fenced heading is refused as `overlapping-section` naming that
114
+ section. A field change does not reformat the rest of the file: an inline value is replaced where it
115
+ stands, and a value written after the key's line, an empty one or a block mapping or list, is
116
+ written after the key's colon in its place. A field holds a `FrontmatterValue`: null, a string, a
117
+ boolean, a finite number, a list without holes or a plain object of them, holding no cycle.
118
+ `frontmatterValue(value)` is that test, and `apply` refuses any other value as `frontmatter-fence`;
119
+ `equalValue(left, right)` compares two by value, whatever their key order, as `apply` compares a
120
+ field with its prior.
121
+
122
+ `Document.preamble` is a readonly string holding the exact source after frontmatter and before the
123
+ first section heading the section parser recognizes, `''` when empty, whitespace, newlines, a
124
+ leading H1 and any fenced text before the first section included. The closing frontmatter
125
+ delimiter and its line ending belong to frontmatter: `bodyAfterFrontmatter(content)` is the exact
126
+ source after them, the whole text when it opens no closed fence, and the preamble begins it.
127
+ `headingLines(content, from, to)` reads each ATX heading outside a fence, by `level` and `name`.
118
128
 
119
129
  ```ts
120
130
  const parsed = parse(content);
@@ -129,81 +139,82 @@ if (parsed.ok) {
129
139
  }
130
140
  ```
131
141
 
132
- `apply(document, { kind: 'preamble', prior, value })` compares `prior` to the
133
- current preamble exactly. A mismatch returns `{ outcome: 'stale', document }`
134
- with the unchanged current Document. A match replaces only that source span,
135
- then parses a new immutable Document; the original is unchanged. Frontmatter
136
- and section source outside the span retain their exact bytes, including newline
137
- and heading syntax. As with section replacement, `value` is literal source:
138
- no newline or separator is inserted, and the resulting source is parsed again.
139
- An invalid frontmatter result receives the existing parse refusal. Independent
140
- field, section, and preamble edits keep their own prior values valid.
141
-
142
- For a moved link, use `links` and the `link` change below to obtain the rewritten
143
- Document, then compare its public `preamble` and `sections` to the original.
144
- Submit the changed values with their original priors. Consumers need no source
145
- span calculation or private Model import. Collection validation remains a
146
- separate call against the resulting Library.
147
-
148
- `links(document, file)` is the inventory of that Document's ordinary link and
149
- image destinations that resolve to a collection Path, each with the destination
150
- `href` exactly as written and the `target` Path it resolves to relative to
151
- `file`. A `?query` or `#fragment` the destination carries is part of `href` and
152
- not part of `target`. Entries are ordered by the position of the destination
153
- text a rewrite would change, and one destination written the same way appears
154
- once however many times it occurs. A destination that the syntax profile does not read as a
155
- link, one that is empty, a bare fragment, or carries a URL scheme, and one that
156
- leaves the collection are not in the inventory. Frontmatter field values,
157
- including typed references, are not link destinations and are never enumerated.
158
-
159
- `target(file, href)` is the collection Path one written destination resolves to
160
- relative to `file`, by the rule `links` and `validate` read: surrounding spaces
161
- and the `?query` or `#fragment` it carries are not part of that Path. A
162
- destination that is empty, a bare fragment, carries a URL scheme, starts at `/`,
163
- or leaves the collection resolves to `null`. It reads a destination written
164
- anywhere, such as a typed reference field value, which `links` never
165
- enumerates. `retarget(href, to)` is that destination rewritten to `to`, keeping
166
- the `?query` or `#fragment` it carried, which is the destination the `link`
167
- change below writes.
168
-
169
- `references(document, definition)` lists each frontmatter `reference` string at
170
- any depth as `pointer`, `value` and `to`; `apply(document, { kind: 'reference',
171
- pointer, value, prior })` rewrites one in place, keeping its quotes, or is
172
- `stale`. `relativize(document, file, handle, definition?)` rewrites each link
173
- destination and reference written `/rooms/<handle>/<path>` to `relative(file,
174
- path)`, keeping its `?query` or `#fragment`; `relativizeBody(body, file,
175
- handle)` does so to a text without frontmatter, refusing one left under
176
- `/rooms/` as `unresolved-link`.
142
+ `apply(document, { kind: 'preamble', prior, value })` compares `prior` to the current preamble
143
+ exactly. A mismatch returns `{ outcome: 'stale', document }` with the unchanged current Document. A
144
+ match replaces only that source span, then parses a new immutable Document; the original is
145
+ unchanged. Frontmatter and section source outside the span retain their exact bytes, including
146
+ newline and heading syntax. As with section replacement, `value` is literal source: no newline or
147
+ separator is inserted, and the resulting source is parsed again. An invalid frontmatter result
148
+ receives the existing parse refusal. Independent field, section, and preamble edits keep their own
149
+ prior values valid.
150
+
151
+ For a moved link, use `links` and the `link` change below to obtain the rewritten Document, then
152
+ compare its public `preamble` and `sections` to the original. Submit the changed values with their
153
+ original priors. Consumers need no source span calculation or private Model import. Collection
154
+ validation remains a separate call against the resulting Library.
155
+
156
+ `links(document, file)` is the inventory of that Document's ordinary link and image destinations
157
+ that resolve to a collection Path, each with the destination `href` exactly as written and the
158
+ `target` Path it resolves to relative to `file`. A `?query` or `#fragment` the destination carries
159
+ is part of `href` and not part of `target`. Entries are ordered by the position of the destination
160
+ text a rewrite would change, and one destination written the same way appears once however many
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`.
182
+
183
+ `references(document, definition)` lists each frontmatter `reference` string at any depth as
184
+ `pointer`, `value` and `to`; `apply(document, { kind: 'reference', pointer, value, prior })`
185
+ rewrites one in place, keeping its quotes, or is `stale`. `relativize(document, file, handle,
186
+ definition?)` rewrites each link destination and reference written `/rooms/<handle>/<path>` to
187
+ `relative(file, path)`, keeping its `?query` or `#fragment`. A text without frontmatter, such as
188
+ a captured body, is read from its first character: `relativizeBody(body, file, handle)` converts
189
+ it so, refusing a destination left under `/rooms/` as `unresolved-link`; `bodyLinks(body, file)`
190
+ is its `links`; `relinkBody(body, file, moves)` writes, in one pass, each destination whose Path
191
+ is a key of `moves` as relative to its value, in the form the `link` change below writes.
177
192
 
178
193
  ```ts
179
194
  target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
180
195
  retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
181
196
  ```
182
197
 
183
- `apply(document, { kind: 'link', href, to })` rewrites every body occurrence of
184
- that written destination and changes nothing else, so a caller that moves a Path
185
- rewrites its referring Documents without a second Markdown parser. `to` is the
186
- Path the destination must resolve to instead; the `?query` or `#fragment` the
187
- written destination carried is not part of that Path and is kept. A Document
188
- that does not carry the destination is `stale`. A reference definition is
189
- rewritten once however many uses name it. The destination is
190
- written in the form the syntax profile reads back: bare when it carries no
191
- whitespace, does not open with `<`, and balances its parentheses, otherwise
192
- inside angle brackets, which the original form is kept in when it still fits. A
193
- destination that neither form can carry is refused as `unwritable-link`.
194
-
195
- `project(document, file, context?)` is the Embedding projection input of one
196
- Document: the prose a consumer embeds, with every internal Markdown-document
197
- link reduced to the label a reader sees. A Document that declares no MD type
198
- contributes its body after the frontmatter fence. A typed one contributes its
199
- prose values, its preamble, and every H2 section its MD type does not declare as
200
- structure, each with its own heading line and every occurrence of a repeated
201
- name, in Document order: a declared text section, a list section of prose items
202
- and an undeclared section are in; a list section of any other item schema is
203
- not. A prose value is a frontmatter string at any depth whose schema is prose,
204
- projected bare and followed by a blank line, in the order the Document writes
205
- them, exactly as written. The Path and every other value stay outside, so
206
- changing them alone leaves the projection unchanged.
198
+ `apply(document, { kind: 'link', href, to })` rewrites every body occurrence of that written
199
+ destination and changes nothing else, so a caller that moves a Path rewrites its referring
200
+ Documents without a second Markdown parser. `to` is the Path the destination must resolve to
201
+ instead; the `?query` or `#fragment` the written destination carried is not part of that Path and
202
+ is kept. A Document that does not carry the destination is `stale`. A reference definition is
203
+ rewritten once however many uses name it. The destination is written in the form the syntax
204
+ profile reads back: bare when it carries no whitespace, does not open with `<`, and balances its
205
+ parentheses, otherwise inside angle brackets, which the original form is kept in when it still
206
+ fits. A destination that neither form can carry is refused as `unwritable-link`.
207
+
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.
207
218
 
208
219
  ```ts
209
220
  const parsed = parse(content);
@@ -216,16 +227,14 @@ if (parsed.ok) {
216
227
  }
217
228
  ```
218
229
 
219
- `ProjectionContext` carries `documentTargets`, the collection-relative Paths the
220
- caller holds as Markdown documents, and `definition`, the verified MD Type the
221
- Document's `type` names, taken from the model `verify` returned. A Document that
222
- declares a type the caller supplies no definition for is refused as
223
- `unknown-type`. `documentTargets` is what makes a destination internal: a
224
- destination resolving to a supplied Path is internal, and every other
225
- destination stays authored text, a binary target and a Path nobody
226
- supplied alike. The caller supplies that membership, as it does for `validate`;
227
- the model reads no bytes, resolves no authority, and classifies nothing it was
228
- 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.
229
238
 
230
239
  An internal link contributes its visible label and no destination, fragment, or
231
240
  title, in the inline `[label](path)`, full `[label][id]`, collapsed
@@ -240,11 +249,10 @@ and `validate` read. `project` returns text and never rewrites the Document.
240
249
  A `link` change leaves the projection of every Document it rewrites
241
250
  byte-identical, while a changed visible label changes it.
242
251
 
243
- `divide(document, file, context)` divides that same Embedding projection input
244
- into ordered Spans under the budget the caller supplies. Each Span carries the
245
- `text` to embed and the `start` and `end` of the extent it addresses in the
246
- Document's own source, as UTF-8 byte offsets into that source and never string
247
- 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
248
256
  the Document itself.
249
257
 
250
258
  ```ts
@@ -273,23 +281,19 @@ caller's number alone: the model holds no tokenizer, counts nothing else, and
273
281
  refuses no input for being too long. A Document the caller supplies no
274
282
  definition for carries the same `unknown-type` refusal `project` returns.
275
283
 
276
- The division descends one level at a time, and only into the piece that does not
277
- fit: the whole input, a heading node, adjacent sibling nodes packed under one
278
- parent, adjacent blocks inside a node, sentences inside a block, and a bound cut
279
- inside a single sentence. A Span covers whole heading nodes or one contiguous
280
- piece inside a single node, never a partial node beside another. A Span that
281
- continues a node repeats that node's own heading line, projected like any other
282
- text and so carrying an internal link's label rather than its destination, and
283
- never an ancestor's heading, so renaming a heading costs what editing that
284
- heading's own body costs. A heading the budget cannot hold beside any text is
285
- not repeated, a continuation piece that begins with an astral character the
286
- room beside its heading cannot hold is carried without the heading, and a
287
- heading with no body of its own leads its first child node rather than standing
288
- as a Span of nothing but itself. Overlap exists at the
289
- sentence level alone, where each Span after the first repeats its predecessor's
290
- last sentence whenever the budget holds both; when it cannot hold both, the
291
- Span carries its own sentence alone. An untyped input arrives without a
292
- 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.
293
297
 
294
298
  Division is total: every authored character of the input belongs to at least one
295
299
  Span, and an input carrying no authored text divides into no Span at all. A
@@ -301,3 +305,55 @@ author quoted. A Span divided out of one free-text field value addresses that
301
305
  whole value, because a YAML scalar's own positions are the only ones its source
302
306
  has, and a Span carrying part of one internal link's label addresses that whole
303
307
  link, because a cut never falls inside link syntax.
308
+
309
+ ## Conditions
310
+
311
+ `facts(document, { id, path }, model, resolve)` reads one Document as the `DocumentFacts` a
312
+ condition tests: its `id`, its `path` with a leading `/`, its `type` or `null`, its `sections`, and
313
+ a `Fact` for each frontmatter field it writes that its MD Type declares. `factKind(facts)` names
314
+ the kind a declared value compares as: `reference`, `enum`, `number`, `boolean`, `date`, `time`
315
+ (a `date-time`) or `string`, else `null`. A prose value, or one of no kind, is `prose`, a list or
316
+ an object holds the facts of its members, and a value written `null` is `null`. A value that does
317
+ not fit its kind, such as a string in a number field, a value outside its `enum` or a reference
318
+ `resolve` maps to no `{ id, member? }`, is `unreadable`; a readable reference compares as that `id`.
319
+
320
+ `holds(test, facts, owner)` is `true`, `false` or `undefined`, unknown; a Trigger fires on `true`
321
+ alone. A test's `path` is `/path`, `/type`, `/sections/<heading>`, `/fields/<pointer>`, or
322
+ `/members/<pointer>`, the member of the Document a reference field reaches. A pointer segment that
323
+ is not an index reads every item of a list, an item lacking it unknown, and a test over several
324
+ values holds as `any` does. The value `{ owner: true }` stands for `owner`, a User id.
325
+
326
+ | The path reaches | `exists` | `contains` | any other test |
327
+ | --------------------------------------- | ----------- | -------------- | -------------- |
328
+ | a value | present | `undefined` | compared |
329
+ | `null`, prose or a section | present | `undefined` | `undefined` |
330
+ | a list | present | `any` of items | `undefined` |
331
+ | no item, through an empty list | absent | `false` | `false` |
332
+ | nothing: no such field, section or type | absent | `undefined` | `undefined` |
333
+ | only unreadable values | `undefined` | `undefined` | `undefined` |
334
+
335
+ `exists: true` holds where present and fails where absent, `exists: false` the reverse. `all` is
336
+ `false` if a part is, else `undefined` if a part is; `any` is `true` if a part is, else `undefined`
337
+ if a part is; `not` keeps `undefined`, so absence is tested with `exists`, never with `not`. `eq`
338
+ and `in` are `undefined` against a value of another JSON type and compare a `time` as an instant;
339
+ `prefix` reads only a string, never a reference or a member; `gt`, `gte`, `lt` and `lte` order
340
+ numbers, dates and times alone.
341
+
342
+ `fires(condition, event, owner)` reads one change, `{ before, after, changed, by }`: the facts of
343
+ each side, `null` on the side a creation or a deletion lacks, the `changed` paths whose prose
344
+ changed, and the actor whose `/user`, `/site` and `/door`, one of `WRITE_DOORS`, a `by` test reads.
345
+ `starts_matching` fires when the Document is in `scope` and holds `match` after the change and did
346
+ not before; a creation fires only with `new_documents: true`, and a deletion never fires.
347
+ `field_changes` fires when the side the Document has, after or for a deletion before, is in `scope`
348
+ and holds `match`, and `field` changed: its facts differ, or with neither `from` nor `to` `changed`
349
+ names it. A field absent on both sides never fires; `from: 'new'` admits only a creation and
350
+ `to: 'deleted'` only a deletion, and listed values need that side to hold `field` `in` them.
351
+
352
+ `itemFires(condition, item, owner)` compares `source` and `address` where given and holds `match`
353
+ over `/delivery`, `/source`, `/provider`, `/container`, `/author`, `/has_attachment`,
354
+ `/headers/<name>` and `/json/<pointer>`, unknown for an item with no JSON. `prosePaths(facts)` lists
355
+ the prose and section paths whose text builds `changed`; `pointed(value, pointer)` reads a JSON
356
+ Pointer, `undefined` where nothing is; `dated(value)` checks a `YYYY-MM-DD` date, and
357
+ `instant(value)` reads an RFC 3339 time with its offset as epoch nanoseconds, a `bigint`.
358
+ `datePointers(fields)` lists, sorted, the `/fields/<name>` pointers of a type's date fields, the
359
+ only values a `DateCondition`'s `date` takes.
@@ -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;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"}
package/dist/blocks.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { fenceSpans } from './links.js';
2
- const HEADING = /^(#{1,6})(?!#)[ \t]+(.+?)[ \t]*#*[ \t]*$/;
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;
@@ -23,24 +23,38 @@ function scan(content, from, to, visit) {
23
23
  i = next;
24
24
  }
25
25
  }
26
+ const HASH = 0x23;
26
27
  export function headingLines(content, from, to) {
27
28
  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
- });
29
+ let fences = null;
30
+ let i = from;
31
+ while (i < to) {
32
+ const nl = content.indexOf('\n', i);
33
+ const end = nl === -1 || nl >= to ? to : nl;
34
+ const next = end === to ? to : end + 1;
35
+ 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)) {
39
+ const { text } = lineAt(content, i, to);
40
+ const match = HEADING.exec(text);
41
+ const hashes = match?.[1];
42
+ const name = match?.[2];
43
+ if (hashes !== undefined && name !== undefined) {
44
+ found.push({
45
+ level: hashes.length,
46
+ name: name.trim(),
47
+ start: i,
48
+ textEnd: i + text.length,
49
+ next,
50
+ });
51
+ }
52
+ }
53
+ }
54
+ if (next === i)
55
+ break;
56
+ i = next;
57
+ }
44
58
  return found;
45
59
  }
46
60
  export function blockRanges(content, from, to) {
@@ -1,4 +1,4 @@
1
- import type { ValueFacts } from './definition.js';
1
+ import { type ValueFacts } from './definition.js';
2
2
  import type { Document, VerifiedModel } from './types.js';
3
3
  export type ConditionValue = string | number | boolean | {
4
4
  readonly owner: true;
@@ -77,18 +77,30 @@ export type DateCondition = {
77
77
  };
78
78
  export type Condition = DocumentCondition | ItemCondition | CronCondition | DateCondition;
79
79
  export type FactKind = 'string' | 'number' | 'boolean' | 'date' | 'time' | 'enum' | 'reference';
80
+ type Scalar = string | number | boolean;
80
81
  export type Fact = {
81
82
  readonly kind: FactKind;
82
- readonly value: Scalar | readonly Scalar[];
83
+ readonly value: Scalar;
84
+ readonly member?: string;
85
+ } | {
86
+ readonly kind: 'prose';
87
+ } | {
88
+ readonly kind: 'null';
89
+ } | {
90
+ readonly kind: 'unreadable';
91
+ } | {
92
+ readonly kind: 'list';
93
+ readonly items: readonly Fact[];
94
+ } | {
95
+ readonly kind: 'object';
96
+ readonly fields: Readonly<Record<string, Fact>>;
83
97
  };
84
98
  export type DocumentFacts = {
85
99
  readonly id: string;
86
100
  readonly path: string;
87
101
  readonly type: string | null;
88
102
  readonly fields: Readonly<Record<string, Fact>>;
89
- readonly members: Readonly<Record<string, string | readonly string[]>>;
90
- readonly prose: readonly string[];
91
- readonly unreadable: readonly string[];
103
+ readonly sections: readonly string[];
92
104
  };
93
105
  export declare const WRITE_DOORS: readonly ['browser', 'agent', 'client'];
94
106
  export type WriteDoor = (typeof WRITE_DOORS)[number];
@@ -121,12 +133,13 @@ export type Resolved = {
121
133
  readonly member?: string;
122
134
  };
123
135
  type Truth = boolean | undefined;
124
- type Scalar = string | number | boolean;
125
136
  export declare function factKind(facts: ValueFacts): FactKind | null;
126
137
  export declare function facts(document: Document, at: {
127
138
  readonly id: string;
128
139
  readonly path: string;
129
140
  }, model: VerifiedModel, resolve: (target: string) => Resolved | undefined): DocumentFacts;
141
+ export declare function prosePaths(facts: DocumentFacts): string[];
142
+ export declare function datePointers(fields: Readonly<Record<string, ValueFacts>>): string[];
130
143
  export declare function dated(value: unknown): value is string;
131
144
  export declare function instant(value: unknown): bigint | undefined;
132
145
  export declare function pointed(value: unknown, pointer: string): unknown;