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