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