@agentshouse/mdmodel 0.1.0-alpha.15 → 0.1.0-alpha.16

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 ADDED
@@ -0,0 +1,285 @@
1
+ # `@agentshouse/mdmodel` API reference
2
+
3
+ ```ts
4
+ import {
5
+ apply,
6
+ divide,
7
+ links,
8
+ MARKDOWN_SYNTAX_PROFILE,
9
+ parse,
10
+ project,
11
+ retarget,
12
+ serialize,
13
+ target,
14
+ validate,
15
+ verify,
16
+ verifyDocuments,
17
+ VERSION,
18
+ } from '@agentshouse/mdmodel';
19
+
20
+ validate({ 'note.md': '# Hello\n' });
21
+ validate(
22
+ {
23
+ 'types/note.md': '---\ntype: definition\n---\n',
24
+ 'note.md': '---\ntype: note\n---\n![Figure](assets/figure.png)\n',
25
+ },
26
+ { binaryTargets: ['assets/figure.png'] },
27
+ );
28
+ const checked = verify({
29
+ 'model/task.md': '---\ntype: definition\nfields:\n title: { kind: string }\n---\n',
30
+ });
31
+ if (checked.verdict === 'accept') {
32
+ validate({ 'tasks/one.md': '---\ntype: task\ntitle: Ship\n---\n' }, undefined, checked.model);
33
+ const task = checked.model.types.task;
34
+ const titleKind = task?.fields.title?.kind;
35
+ }
36
+ const parsed = parse(content);
37
+ if (parsed.ok) {
38
+ const next = apply(parsed.document, {
39
+ kind: 'field',
40
+ name: 'title',
41
+ value: 'World',
42
+ prior: 'Hello',
43
+ });
44
+ if (next.outcome === 'applied') serialize(next.document);
45
+ for (const link of links(parsed.document, 'tasks/two.md')) {
46
+ if (link.target !== 'data/export.csv') continue;
47
+ const moved = apply(parsed.document, {
48
+ kind: 'link',
49
+ href: link.href,
50
+ to: '../files/export.csv',
51
+ });
52
+ if (moved.outcome === 'applied') serialize(moved.document);
53
+ }
54
+ }
55
+ ```
56
+
57
+ `verify(definitions)` accepts definition text keyed by canonical definition
58
+ address. It returns a verified model whose `types` expose each MD Type's name,
59
+ address, parsed field specs, and declared sections. A field spec names its
60
+ `kind` and `required` flag; a list carries `of`, an enum carries `values`, and a
61
+ reference carries `to`. `verifyDocuments(definitions)` accepts already parsed
62
+ definition Documents keyed by canonical definition address and yields the same
63
+ verified facts without parsing their content again. A verification refusal names
64
+ `source: 'model'` and the definition address.
65
+
66
+ `validate(library, context?, model?)` takes the resulting text Library and one
67
+ `ValidationContext` containing `binaryTargets: readonly string[]`. Omitting the
68
+ context declares no binary targets. Library keys and binary targets use the
69
+ same collection-relative path namespace; callers supply canonical paths, and
70
+ a path declared as both text and binary is refused. Ordinary links and images
71
+ in typed Documents may resolve to either membership, including relative
72
+ normalization from the source Document. A binary target supplies no Document
73
+ or MD Type and cannot satisfy a typed reference, including one to `any`.
74
+ The existing `any` Document rules are unchanged.
75
+ When `model` is supplied, validation uses only its definitions and treats every
76
+ Library member as content, even when its Path equals a definition address. A
77
+ content refusal then names `source: 'content'` and its Library Path. Without
78
+ `model`, definition Documents under `types/` are read from the Library.
79
+
80
+ A typed Document carries the frontmatter fields its MD type declares, plus
81
+ `type`, `site`, and `received`; any other field is refused as
82
+ `undeclared-field` at that field name. A field
83
+ name YAML carries to a record prototype, `__proto__` among them, is an ordinary
84
+ undeclared field and is refused as one. A declared list section is validated as
85
+ a list; its declared item kind governs projection eligibility rather than the
86
+ value of each item, which validation reads no further than that list form.
87
+ Validation returns acceptance or one refusal naming the file, the field or
88
+ section, the violated rule, and `VERSION`. `parse`, `apply`, and `serialize` operate on a single text
89
+ Document; they do not validate collection membership or consume binary bytes.
90
+ `apply` sets one typed field, including a list field as a whole, replaces
91
+ one existing section body or the preamble against that value's prior content,
92
+ or rewrites one Markdown link destination. A section need not be declared by
93
+ the Document's MD Type to be replaced. A field change does not reformat the rest of the file.
94
+
95
+ `Document.preamble` is a readonly string containing the exact source after
96
+ frontmatter and before the first section heading recognized by the existing
97
+ section parser. Without a section it is the entire post-frontmatter body;
98
+ without frontmatter it starts at the beginning of the Document. An empty span
99
+ is `''`. It includes whitespace, newlines, a leading H1, and any fenced text
100
+ before the first section. The closing frontmatter delimiter and its line ending
101
+ belong to frontmatter. Section recognition and the syntax profile are unchanged.
102
+
103
+ ```ts
104
+ const parsed = parse(content);
105
+ if (parsed.ok) {
106
+ const change = {
107
+ kind: 'preamble' as const,
108
+ prior: parsed.document.preamble,
109
+ value: 'Updated introduction.\n\n',
110
+ };
111
+ const result = apply(parsed.document, change);
112
+ if (result.outcome === 'applied') serialize(result.document);
113
+ }
114
+ ```
115
+
116
+ `apply(document, { kind: 'preamble', prior, value })` compares `prior` to the
117
+ current preamble exactly. A mismatch returns `{ outcome: 'stale', document }`
118
+ with the unchanged current Document. A match replaces only that source span,
119
+ then parses a new immutable Document; the original is unchanged. Frontmatter
120
+ and section source outside the span retain their exact bytes, including newline
121
+ and heading syntax. As with section replacement, `value` is literal source:
122
+ no newline or separator is inserted, and the resulting source is parsed again.
123
+ An invalid frontmatter result receives the existing parse refusal. Independent
124
+ field, section, and preamble edits keep their own prior values valid.
125
+
126
+ For a moved link, use `links` and the `link` change below to obtain the rewritten
127
+ Document, then compare its public `preamble` and `sections` to the original.
128
+ Submit the changed values with their original priors. Consumers need no source
129
+ span calculation or private Model import. Collection validation remains a
130
+ separate call against the resulting Library.
131
+
132
+ `links(document, file)` is the inventory of that Document's ordinary link and
133
+ image destinations that resolve to a collection Path, each with the destination
134
+ `href` exactly as written and the `target` Path it resolves to relative to
135
+ `file`. A `?query` or `#fragment` the destination carries is part of `href` and
136
+ not part of `target`. Entries are ordered by the position of the destination
137
+ text a rewrite would change, and one destination written the same way appears
138
+ once however many times it occurs. A destination that the syntax profile does not read as a
139
+ link, one that is empty, a bare fragment, or carries a URL scheme, and one that
140
+ leaves the collection are not in the inventory. Frontmatter field values,
141
+ including typed references, are not link destinations and are never enumerated.
142
+
143
+ `target(file, href)` is the collection Path one written destination resolves to
144
+ relative to `file`, by the rule `links` and `validate` read: surrounding spaces
145
+ and the `?query` or `#fragment` it carries are not part of that Path. A
146
+ destination that is empty, a bare fragment, carries a URL scheme, starts at `/`,
147
+ or leaves the collection resolves to `null`. It reads a destination written
148
+ anywhere, such as a typed reference field value, which `links` never
149
+ enumerates. `retarget(href, to)` is that destination rewritten to `to`, keeping
150
+ the `?query` or `#fragment` it carried, which is the destination the `link`
151
+ change below writes.
152
+
153
+ ```ts
154
+ target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
155
+ retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
156
+ ```
157
+
158
+ `apply(document, { kind: 'link', href, to })` rewrites every body occurrence of
159
+ that written destination and changes nothing else, so a caller that moves a Path
160
+ rewrites its referring Documents without a second Markdown parser. `to` is the
161
+ Path the destination must resolve to instead; the `?query` or `#fragment` the
162
+ written destination carried is not part of that Path and is kept. A Document
163
+ that does not carry the destination is `stale`. A reference definition is
164
+ rewritten once however many uses name it. The destination is
165
+ written in the form the syntax profile reads back: bare when it carries no
166
+ whitespace, does not open with `<`, and balances its parentheses, otherwise
167
+ inside angle brackets, which the original form is kept in when it still fits. A
168
+ destination that neither form can carry is refused as `unwritable-link`.
169
+
170
+ `project(document, file, context?)` is the Embedding projection input of one
171
+ Document: the prose a consumer embeds, with every internal Markdown-document
172
+ link reduced to the label a reader sees. A Document that declares no MD type
173
+ contributes its body after the frontmatter fence. A Document that declares one
174
+ contributes its free-text field values, its preamble, and every H2 section its
175
+ MD type does not declare as structure, each section with its own heading line
176
+ and every occurrence of a repeated name, in the order the Document carries
177
+ them. A declared free-text section, a declared list section whose items are
178
+ free text, and a section the MD type does not declare at all are all inside
179
+ that input; a declared list section of any other item kind is not, so
180
+ eligibility follows the declared kind rather than the form the author wrote.
181
+ Each free-text field value is projected bare, without its field name and
182
+ followed by a blank line, in the order the MD Type declares its fields, and
183
+ every item of a free-text list field is one such value, projected as the author
184
+ wrote it: the link inventory reads the body, so link syntax inside a
185
+ frontmatter value is text like any other. The Document's Path and its typed
186
+ fields of every other kind stay outside that input.
187
+
188
+ ```ts
189
+ const parsed = parse(content);
190
+ if (parsed.ok) {
191
+ const projected = project(parsed.document, 'tasks/two.md', {
192
+ documentTargets: ['plans/q3.md', 'people/ana.md'],
193
+ definition: types['types/task.md'],
194
+ });
195
+ if (projected.ok) embed(projected.text);
196
+ }
197
+ ```
198
+
199
+ `ProjectionContext` carries `documentTargets`, the collection-relative Paths the
200
+ caller holds as Markdown documents, and `definition`, the source of the MD Type
201
+ definition Document the Document's `type` names. A Document that declares a type
202
+ the caller supplies no definition for is refused as `unknown-type`, and a
203
+ definition source the model cannot read carries its own refusal naming
204
+ `types/<type>.md`. `documentTargets` is what makes a destination internal: a
205
+ destination resolving to a supplied Path is internal, and every other
206
+ destination stays authored text, a retained binary target and a Path nobody
207
+ supplied alike. The caller supplies that membership, as it does for `validate`;
208
+ the model reads no bytes, resolves no authority, and classifies nothing it was
209
+ not given.
210
+
211
+ An internal link contributes its visible label and no destination, fragment, or
212
+ title, in the inline `[label](path)`, full `[label][id]`, and collapsed
213
+ `[label][]` forms, and the link reference definition an enumerated use resolves
214
+ through leaves the projection with it. An image at a supplied document target
215
+ contributes its alt text the same way, because a move rewrites that destination
216
+ too. External URLs, retained binary targets, unsupplied destinations, bare
217
+ fragments, code spans, fenced code, and escaped syntax stay exactly as authored,
218
+ read through the same syntax profile `links` and `validate` read. `project`
219
+ returns text and never rewrites the Document.
220
+
221
+ Because a moved Path changes destinations alone, applying a `link` change leaves
222
+ the projection of every Document it rewrites byte-identical, while a changed
223
+ visible label changes it.
224
+
225
+ `divide(document, file, context)` divides that same Embedding projection input
226
+ into ordered Spans under the budget the caller supplies. Each Span carries the
227
+ `text` to embed and the `start` and `end` of the extent it addresses in the
228
+ Document's own source, as UTF-8 byte offsets into that source and never string
229
+ positions, so a caller stores the extent and hydrates the text it shows from
230
+ the Document itself.
231
+
232
+ ```ts
233
+ const parsed = parse(content);
234
+ if (parsed.ok) {
235
+ const divided = divide(parsed.document, 'tasks/two.md', {
236
+ documentTargets: ['plans/q3.md', 'people/ana.md'],
237
+ definition: types['types/task.md'],
238
+ budget: 2000,
239
+ });
240
+ if (divided.ok) for (const span of divided.spans) embed(span.text);
241
+ }
242
+ ```
243
+
244
+ `DivisionContext` is a `ProjectionContext` and one `budget`, the greatest number
245
+ of characters a Span's embedded text may carry, counted the way JavaScript
246
+ counts a string's length and not in the bytes the extent is measured in. No
247
+ Span's text is ever longer than the budget. A bound cut never divides a
248
+ character: where the budget ends between the two halves of a surrogate pair,
249
+ the cut falls before the pair. A cut never falls inside link syntax either: it
250
+ falls before an internal link, and a label longer than a whole piece's room is
251
+ divided at the bound like any other text. The smallest budget is `2`, the
252
+ length of one astral character; a budget that is not a whole number of at least
253
+ `2` is refused with `division-budget` before any division. The budget is the
254
+ caller's number alone: the model holds no tokenizer, counts nothing else, and
255
+ refuses no input for being too long. A Document the caller supplies no
256
+ definition for carries the same `unknown-type` refusal `project` returns.
257
+
258
+ The division descends one level at a time, and only into the piece that does not
259
+ fit: the whole input, a heading node, adjacent sibling nodes packed under one
260
+ parent, adjacent blocks inside a node, sentences inside a block, and a bound cut
261
+ inside a single sentence. A Span covers whole heading nodes or one contiguous
262
+ piece inside a single node, never a partial node beside another. A Span that
263
+ continues a node repeats that node's own heading line, projected like any other
264
+ text and so carrying an internal link's label rather than its destination, and
265
+ never an ancestor's heading, so renaming a heading costs what editing that
266
+ heading's own body costs. A heading the budget cannot hold beside any text is
267
+ not repeated, a continuation piece that begins with an astral character the
268
+ room beside its heading cannot hold is carried without the heading, and a
269
+ heading with no body of its own leads its first child node rather than standing
270
+ as a Span of nothing but itself. Overlap exists at the
271
+ sentence level alone, where each Span after the first repeats its predecessor's
272
+ last sentence whenever the budget holds both; when it cannot hold both, the
273
+ Span carries its own sentence alone. An untyped input arrives without a
274
+ definition and descends the same ladder.
275
+
276
+ Division is total: every authored character of the input belongs to at least one
277
+ Span, and an input carrying no authored text divides into no Span at all. A
278
+ Span's extent is the smallest range of the source that contains everything the
279
+ Span covers, so it spans what the input excludes between two eligible pieces,
280
+ and the extent addresses the authored source where the embedded text carries a
281
+ repeated heading, an internal link's visible label, or a frontmatter value the
282
+ author quoted. A Span divided out of one free-text field value addresses that
283
+ whole value, because a YAML scalar's own positions are the only ones its source
284
+ has, and a Span carrying part of one internal link's label addresses that whole
285
+ link, because a cut never falls inside link syntax.
package/README.md CHANGED
@@ -1,14 +1,12 @@
1
1
  # `@agentshouse/mdmodel`
2
2
 
3
- The standalone MD Model: the MD Type language, its parser, its validator, the
4
- deterministic application of one structured change to Document content, the
5
- Markdown syntax profile, and the conformance fixtures.
3
+ Typed Markdown documents: the MD Type language, a parser, a validator, and the
4
+ deterministic application of one structured change to a Document, plus a
5
+ conformance fixture corpus.
6
6
 
7
- The package runs in a browser and in Node. It makes no network call and reads
8
- no filesystem on its own. Callers pass text Library state as path-to-content and declare retained binary
9
- link targets separately in a `ValidationContext`.
10
- The public root exposes one ESM artifact. Node 24.21.0 and later can load it
11
- through either `import` or `require`; browser bundlers consume the same artifact.
7
+ It runs in the browser and in Node, makes no network call, and reads no
8
+ filesystem on its own. It ships one ESM artifact that Node 24.21.0 and later
9
+ loads through `import` or `require`.
12
10
 
13
11
  ## Install
14
12
 
@@ -16,44 +14,19 @@ through either `import` or `require`; browser bundlers consume the same artifact
16
14
  npm install @agentshouse/mdmodel
17
15
  ```
18
16
 
19
- Package releases follow the repository release handoff after merge.
20
-
21
- ## API
17
+ ## Usage
22
18
 
23
19
  ```ts
24
- import {
25
- apply,
26
- divide,
27
- links,
28
- MARKDOWN_SYNTAX_PROFILE,
29
- parse,
30
- project,
31
- retarget,
32
- serialize,
33
- target,
34
- validate,
35
- verify,
36
- verifyDocuments,
37
- VERSION,
38
- } from '@agentshouse/mdmodel';
20
+ import { apply, parse, serialize, validate, verify } from '@agentshouse/mdmodel';
39
21
 
40
- validate({ 'note.md': '# Hello\n' });
41
- validate(
42
- {
43
- 'types/note.md': '---\ntype: definition\n---\n',
44
- 'note.md': '---\ntype: note\n---\n![Figure](assets/figure.png)\n',
45
- },
46
- { binaryTargets: ['assets/figure.png'] },
47
- );
48
22
  const checked = verify({
49
23
  'model/task.md': '---\ntype: definition\nfields:\n title: { kind: string }\n---\n',
50
24
  });
51
25
  if (checked.verdict === 'accept') {
52
26
  validate({ 'tasks/one.md': '---\ntype: task\ntitle: Ship\n---\n' }, undefined, checked.model);
53
- const task = checked.model.types.task;
54
- const titleKind = task?.fields.title?.kind;
55
27
  }
56
- const parsed = parse(content);
28
+
29
+ const parsed = parse('---\ntype: note\ntitle: Hello\n---\n');
57
30
  if (parsed.ok) {
58
31
  const next = apply(parsed.document, {
59
32
  kind: 'field',
@@ -62,257 +35,24 @@ if (parsed.ok) {
62
35
  prior: 'Hello',
63
36
  });
64
37
  if (next.outcome === 'applied') serialize(next.document);
65
- for (const link of links(parsed.document, 'tasks/two.md')) {
66
- if (link.target !== 'data/export.csv') continue;
67
- const moved = apply(parsed.document, {
68
- kind: 'link',
69
- href: link.href,
70
- to: '../files/export.csv',
71
- });
72
- if (moved.outcome === 'applied') serialize(moved.document);
73
- }
74
- }
75
- ```
76
-
77
- `verify(definitions)` accepts definition text keyed by canonical definition
78
- address. It returns a verified model whose `types` expose each MD Type's name,
79
- address, parsed field specs, and declared sections. A field spec names its
80
- `kind` and `required` flag; a list carries `of`, an enum carries `values`, and a
81
- reference carries `to`. `verifyDocuments(definitions)` accepts already parsed
82
- definition Documents keyed by canonical definition address and yields the same
83
- verified facts without parsing their content again. A verification refusal names
84
- `source: 'model'` and the definition address.
85
-
86
- `validate(library, context?, model?)` takes the resulting text Library and one
87
- `ValidationContext` containing `binaryTargets: readonly string[]`. Omitting the
88
- context declares no binary targets. Library keys and binary targets use the
89
- same collection-relative path namespace; callers supply canonical paths, and
90
- a path declared as both text and binary is refused. Ordinary links and images
91
- in typed Documents may resolve to either membership, including relative
92
- normalization from the source Document. A binary target supplies no Document
93
- or MD Type and cannot satisfy a typed reference, including one to `any`.
94
- The existing `any` Document rules are unchanged.
95
- When `model` is supplied, validation uses only its definitions and treats every
96
- Library member as content, even when its Path equals a definition address. A
97
- content refusal then names `source: 'content'` and its Library Path. Without
98
- `model`, definition Documents under `types/` are read from the Library.
99
-
100
- A typed Document carries the frontmatter fields its MD type declares, plus
101
- `type`, `site`, and `received`; any other field is refused as
102
- `undeclared-field` at that field name. A field
103
- name YAML carries to a record prototype, `__proto__` among them, is an ordinary
104
- undeclared field and is refused as one. A declared list section is validated as
105
- a list; its declared item kind governs projection eligibility rather than the
106
- value of each item, which validation reads no further than that list form.
107
- Validation returns acceptance or one refusal naming the file, the field or
108
- section, the violated rule, and `VERSION`. Every caller operation that validates
109
- a resulting collection supplies that collection's context to this same
110
- `validate` function. `parse`, `apply`, and `serialize` operate on a single text
111
- Document; they do not validate collection membership or consume binary bytes.
112
- `apply` sets one typed field, including a list field as a whole, replaces
113
- one existing section body or the preamble against that value's prior content,
114
- or rewrites one Markdown link destination. A section need not be declared by
115
- the Document's MD Type to be replaced. A field change does not reformat the rest of the file.
116
-
117
- `Document.preamble` is a readonly string containing the exact source after
118
- frontmatter and before the first section heading recognized by the existing
119
- section parser. Without a section it is the entire post-frontmatter body;
120
- without frontmatter it starts at the beginning of the Document. An empty span
121
- is `''`. It includes whitespace, newlines, a leading H1, and any fenced text
122
- before the first section. The closing frontmatter delimiter and its line ending
123
- belong to frontmatter. Section recognition and the syntax profile are unchanged.
124
-
125
- ```ts
126
- const parsed = parse(content);
127
- if (parsed.ok) {
128
- const change = {
129
- kind: 'preamble' as const,
130
- prior: parsed.document.preamble,
131
- value: 'Updated introduction.\n\n',
132
- };
133
- const result = apply(parsed.document, change);
134
- if (result.outcome === 'applied') serialize(result.document);
135
- }
136
- ```
137
-
138
- `apply(document, { kind: 'preamble', prior, value })` compares `prior` to the
139
- current preamble exactly. A mismatch returns `{ outcome: 'stale', document }`
140
- with the unchanged current Document. A match replaces only that source span,
141
- then parses a new immutable Document; the original is unchanged. Frontmatter
142
- and section source outside the span retain their exact bytes, including newline
143
- and heading syntax. As with section replacement, `value` is literal source:
144
- no newline or separator is inserted, and the resulting source is parsed again.
145
- An invalid frontmatter result receives the existing parse refusal. Independent
146
- field, section, and preamble edits keep their own prior values valid.
147
-
148
- For a moved link, use `links` and the `link` change below to obtain the rewritten
149
- Document, then compare its public `preamble` and `sections` to the original.
150
- Submit the changed values with their original priors. Consumers need no source
151
- span calculation or private Model import. Collection validation remains a
152
- separate call against the resulting Library.
153
-
154
- `links(document, file)` is the inventory of that Document's ordinary link and
155
- image destinations that resolve to a collection Path, each with the destination
156
- `href` exactly as written and the `target` Path it resolves to relative to
157
- `file`. A `?query` or `#fragment` the destination carries is part of `href` and
158
- not part of `target`. Entries are ordered by the position of the destination
159
- text a rewrite would change, and one destination written the same way appears
160
- once however many times it occurs. A destination that the syntax profile does not read as a
161
- link, one that is empty, a bare fragment, or carries a URL scheme, and one that
162
- leaves the collection are not in the inventory. Frontmatter field values,
163
- including typed references, are not link destinations and are never enumerated.
164
-
165
- `target(file, href)` is the collection Path one written destination resolves to
166
- relative to `file`, by the rule `links` and `validate` read: surrounding spaces
167
- and the `?query` or `#fragment` it carries are not part of that Path. A
168
- destination that is empty, a bare fragment, carries a URL scheme, starts at `/`,
169
- or leaves the collection resolves to `null`. It reads a destination written
170
- anywhere, such as a typed reference field value, which `links` never
171
- enumerates. `retarget(href, to)` is that destination rewritten to `to`, keeping
172
- the `?query` or `#fragment` it carried, which is the destination the `link`
173
- change below writes.
174
-
175
- ```ts
176
- target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
177
- retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
178
- ```
179
-
180
- `apply(document, { kind: 'link', href, to })` rewrites every body occurrence of
181
- that written destination and changes nothing else, so a caller that moves a Path
182
- rewrites its referring Documents without a second Markdown parser. `to` is the
183
- Path the destination must resolve to instead; the `?query` or `#fragment` the
184
- written destination carried is not part of that Path and is kept. A Document
185
- that does not carry the destination is `stale`. A reference definition is
186
- rewritten once however many uses name it. The destination is
187
- written in the form the syntax profile reads back: bare when it carries no
188
- whitespace, does not open with `<`, and balances its parentheses, otherwise
189
- inside angle brackets, which the original form is kept in when it still fits. A
190
- destination that neither form can carry is refused as `unwritable-link`.
191
-
192
- `project(document, file, context?)` is the Embedding projection input of one
193
- Document: the prose a consumer embeds, with every internal Markdown-document
194
- link reduced to the label a reader sees. A Document that declares no MD type
195
- contributes its body after the frontmatter fence. A Document that declares one
196
- contributes its free-text field values, its preamble, and every H2 section its
197
- MD type does not declare as structure, each section with its own heading line
198
- and every occurrence of a repeated name, in the order the Document carries
199
- them. A declared free-text section, a declared list section whose items are
200
- free text, and a section the MD type does not declare at all are all inside
201
- that input; a declared list section of any other item kind is not, so
202
- eligibility follows the declared kind rather than the form the author wrote.
203
- Each free-text field value is projected bare, without its field name and
204
- followed by a blank line, in the order the MD Type declares its fields, and
205
- every item of a free-text list field is one such value, projected as the author
206
- wrote it: the link inventory reads the body, so link syntax inside a
207
- frontmatter value is text like any other. The Document's Path and its typed
208
- fields of every other kind stay outside that input.
209
-
210
- ```ts
211
- const parsed = parse(content);
212
- if (parsed.ok) {
213
- const projected = project(parsed.document, 'tasks/two.md', {
214
- documentTargets: ['plans/q3.md', 'people/ana.md'],
215
- definition: types['types/task.md'],
216
- });
217
- if (projected.ok) embed(projected.text);
218
- }
219
- ```
220
-
221
- `ProjectionContext` carries `documentTargets`, the collection-relative Paths the
222
- caller holds as Markdown documents, and `definition`, the source of the MD Type
223
- definition Document the Document's `type` names. A Document that declares a type
224
- the caller supplies no definition for is refused as `unknown-type`, and a
225
- definition source the model cannot read carries its own refusal naming
226
- `types/<type>.md`. `documentTargets` is what makes a destination internal: a
227
- destination resolving to a supplied Path is internal, and every other
228
- destination stays authored text, a retained binary target and a Path nobody
229
- supplied alike. The caller supplies that membership, as it does for `validate`;
230
- the model reads no bytes, resolves no authority, and classifies nothing it was
231
- not given.
232
-
233
- An internal link contributes its visible label and no destination, fragment, or
234
- title, in the inline `[label](path)`, full `[label][id]`, and collapsed
235
- `[label][]` forms, and the link reference definition an enumerated use resolves
236
- through leaves the projection with it. An image at a supplied document target
237
- contributes its alt text the same way, because a move rewrites that destination
238
- too. External URLs, retained binary targets, unsupplied destinations, bare
239
- fragments, code spans, fenced code, and escaped syntax stay exactly as authored,
240
- read through the same syntax profile `links` and `validate` read. `project`
241
- returns text and never rewrites the Document.
242
-
243
- Because a moved Path changes destinations alone, applying a `link` change leaves
244
- the projection of every Document it rewrites byte-identical, while a changed
245
- visible label changes it. `fixtures/projection.json` carries every move row of
246
- that corpus; the label change is proven at this package's own `project` seam.
247
-
248
- `divide(document, file, context)` divides that same Embedding projection input
249
- into ordered Spans under the budget the caller supplies. Each Span carries the
250
- `text` to embed and the `start` and `end` of the extent it addresses in the
251
- Document's own source, as UTF-8 byte offsets into that source and never string
252
- positions, so a caller stores the extent and hydrates the text it shows from
253
- the Document itself.
254
-
255
- ```ts
256
- const parsed = parse(content);
257
- if (parsed.ok) {
258
- const divided = divide(parsed.document, 'tasks/two.md', {
259
- documentTargets: ['plans/q3.md', 'people/ana.md'],
260
- definition: types['types/task.md'],
261
- budget: 2000,
262
- });
263
- if (divided.ok) for (const span of divided.spans) embed(span.text);
264
38
  }
265
39
  ```
266
40
 
267
- `DivisionContext` is a `ProjectionContext` and one `budget`, the greatest number
268
- of characters a Span's embedded text may carry, counted the way JavaScript
269
- counts a string's length and not in the bytes the extent is measured in. No
270
- Span's text is ever longer than the budget. A bound cut never divides a
271
- character: where the budget ends between the two halves of a surrogate pair,
272
- the cut falls before the pair. A cut never falls inside link syntax either: it
273
- falls before an internal link, and a label longer than a whole piece's room is
274
- divided at the bound like any other text. The smallest budget is `2`, the
275
- length of one astral character; a budget that is not a whole number of at least
276
- `2` is refused with `division-budget` before any division. The budget is the
277
- caller's number alone: the model holds no tokenizer, counts nothing else, and
278
- refuses no input for being too long. A Document the caller supplies no
279
- definition for carries the same `unknown-type` refusal `project` returns.
280
-
281
- The division descends one level at a time, and only into the piece that does not
282
- fit: the whole input, a heading node, adjacent sibling nodes packed under one
283
- parent, adjacent blocks inside a node, sentences inside a block, and a bound cut
284
- inside a single sentence. A Span covers whole heading nodes or one contiguous
285
- piece inside a single node, never a partial node beside another. A Span that
286
- continues a node repeats that node's own heading line, projected like any other
287
- text and so carrying an internal link's label rather than its destination, and
288
- never an ancestor's heading, so renaming a heading costs what editing that
289
- heading's own body costs. A heading the budget cannot hold beside any text is
290
- not repeated, a continuation piece that begins with an astral character the
291
- room beside its heading cannot hold is carried without the heading, and a
292
- heading with no body of its own leads its first child node rather than standing
293
- as a Span of nothing but itself. Overlap exists at the
294
- sentence level alone, where each Span after the first repeats its predecessor's
295
- last sentence whenever the budget holds both; when it cannot hold both, the
296
- Span carries its own sentence alone. An untyped input arrives without a
297
- definition and descends the same ladder.
298
-
299
- Division is total: every authored character of the input belongs to at least one
300
- Span, and an input carrying no authored text divides into no Span at all. A
301
- Span's extent is the smallest range of the source that contains everything the
302
- Span covers, so it spans what the input excludes between two eligible pieces,
303
- and the extent addresses the authored source where the embedded text carries a
304
- repeated heading, an internal link's visible label, or a frontmatter value the
305
- author quoted. A Span divided out of one free-text field value addresses that
306
- whole value, because a YAML scalar's own positions are the only ones its source
307
- has, and a Span carrying part of one internal link's label addresses that whole
308
- link, because a cut never falls inside link syntax.
41
+ ## API
309
42
 
310
- ## Fixtures
43
+ | Export | Purpose |
44
+ | ------------------------------------ | ---------------------------------------------------------- |
45
+ | `verify`, `verifyDocuments` | Verify MD Type definitions into a model |
46
+ | `validate` | Validate a text Library; returns acceptance or one refusal |
47
+ | `parse`, `serialize` | Read and write one Document |
48
+ | `apply` | Apply one field, section, preamble, or link change |
49
+ | `links`, `target`, `retarget` | Inventory and rewrite link destinations |
50
+ | `project`, `divide` | Embedding projection input and its division into Spans |
51
+ | `MARKDOWN_SYNTAX_PROFILE`, `VERSION` | The pinned Markdown profile (GFM 0.29) and package version |
311
52
 
312
- The conformance corpus ships in `fixtures/`. Its verdict format and rule ids
313
- are documented in [`fixtures/README.md`](fixtures/README.md).
53
+ The full reference is in [`API.md`](API.md). The conformance corpus and its
54
+ verdict format and rule ids are described in [`fixtures/README.md`](fixtures/README.md).
314
55
 
315
- ## Markdown syntax profile
56
+ ## License
316
57
 
317
- GitHub Flavored Markdown Spec 0.29, as documentation, not as validation.
318
- See [`markdown-syntax-profile.md`](markdown-syntax-profile.md).
58
+ MIT
package/dist/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.1.0-alpha.15";
1
+ export declare const VERSION = "0.1.0-alpha.16";
2
2
  //# sourceMappingURL=version.d.ts.map
package/dist/version.js CHANGED
@@ -1,3 +1,3 @@
1
- export const VERSION = '0.1.0-alpha.15';
1
+ export const VERSION = '0.1.0-alpha.16';
2
2
 
3
3
  //# sourceMappingURL=version.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["/workspace/packages/mdmodel/src/version.ts"],"sourcesContent":["export const VERSION = '0.1.0-alpha.15';\n"],"names":["VERSION"],"mappings":"AAAA,OAAO,MAAMA,UAAU,iBAAiB"}
1
+ {"version":3,"sources":["/workspace/packages/mdmodel/src/version.ts"],"sourcesContent":["export const VERSION = '0.1.0-alpha.16';\n"],"names":["VERSION"],"mappings":"AAAA,OAAO,MAAMA,UAAU,iBAAiB"}
@@ -18,11 +18,7 @@ the validation Libraries. Each row carries `name`, exact `source`, expected
18
18
  the source, compare `Document.preamble`, apply
19
19
  `{ kind: 'preamble', prior: preamble, value }`, and compare the serialized result.
20
20
  These cases cover empty and heading-free Documents, frontmatter boundaries,
21
- fenced headings, newline/source preservation, and the Runtime moved-export
22
- example from its [approved candidate](https://github.com/agentshouse/mdruntime/blob/ed0a6f0b95317d9ade846ec1f2871a3997519bc4/test/rooms.ts).
23
- The package check runs every row in ESM, CommonJS, and the browser-target VM
24
- bundle, also checking stale priors, immutable Documents, and conversion of the
25
- Runtime link rewrite into a preamble operation through public APIs.
21
+ fenced headings, newline/source preservation, and a moved-export link rewrite.
26
22
 
27
23
  ## Projection
28
24
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agentshouse/mdmodel",
3
- "version": "0.1.0-alpha.15",
3
+ "version": "0.1.0-alpha.16",
4
4
  "description": "MD Type language, parser, validator, structured change application, Markdown syntax profile, and conformance fixtures",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -21,19 +21,10 @@
21
21
  "files": [
22
22
  "dist",
23
23
  "fixtures",
24
+ "API.md",
24
25
  "LICENSE",
25
- "README.md",
26
- "markdown-syntax-profile.md"
26
+ "README.md"
27
27
  ],
28
- "repository": {
29
- "type": "git",
30
- "url": "git+https://github.com/agentshouse/mdmodel.git",
31
- "directory": "packages/mdmodel"
32
- },
33
- "homepage": "https://github.com/agentshouse/mdmodel#readme",
34
- "bugs": {
35
- "url": "https://github.com/agentshouse/mdmodel/issues"
36
- },
37
28
  "dependencies": {
38
29
  "@cfworker/json-schema": "4.1.1"
39
30
  }
@@ -1,9 +0,0 @@
1
- # Markdown syntax profile
2
-
3
- The MD Model pins GitHub Flavored Markdown Spec 0.29 as its Markdown syntax
4
- profile:
5
-
6
- https://github.github.com/gfm/
7
-
8
- The profile is a renderer promise. The package never validates Markdown
9
- syntax or free body text against it.