@agentshouse/mdmodel 0.1.0-alpha.8 → 0.1.0-c68e2039f1ca8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (323) hide show
  1. package/API.md +300 -0
  2. package/README.md +34 -175
  3. package/dist/blocks.d.ts +11 -0
  4. package/dist/blocks.d.ts.map +1 -0
  5. package/dist/blocks.js +62 -0
  6. package/dist/condition.d.ts +137 -0
  7. package/dist/condition.d.ts.map +1 -0
  8. package/dist/condition.js +394 -0
  9. package/dist/definition.d.ts +42 -25
  10. package/dist/definition.d.ts.map +1 -1
  11. package/dist/definition.js +473 -146
  12. package/dist/divide.d.ts +3 -0
  13. package/dist/divide.d.ts.map +1 -0
  14. package/dist/divide.js +310 -0
  15. package/dist/document.d.ts +2 -0
  16. package/dist/document.d.ts.map +1 -1
  17. package/dist/document.js +89 -120
  18. package/dist/fields.d.ts +4 -0
  19. package/dist/fields.d.ts.map +1 -0
  20. package/dist/fields.js +3 -0
  21. package/dist/index.d.ts +9 -2
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index.js +6 -3
  24. package/dist/links.d.ts +1 -0
  25. package/dist/links.d.ts.map +1 -1
  26. package/dist/links.js +618 -224
  27. package/dist/paths.d.ts +2 -3
  28. package/dist/paths.d.ts.map +1 -1
  29. package/dist/paths.js +27 -37
  30. package/dist/profile.js +1 -3
  31. package/dist/project.d.ts +19 -1
  32. package/dist/project.d.ts.map +1 -1
  33. package/dist/project.js +82 -73
  34. package/dist/refuse.d.ts.map +1 -1
  35. package/dist/refuse.js +2 -10
  36. package/dist/schema.d.ts +7 -5
  37. package/dist/schema.d.ts.map +1 -1
  38. package/dist/schema.js +156 -41
  39. package/dist/sections.d.ts +2 -1
  40. package/dist/sections.d.ts.map +1 -1
  41. package/dist/sections.js +45 -67
  42. package/dist/types.d.ts +30 -2
  43. package/dist/types.d.ts.map +1 -1
  44. package/dist/types.js +1 -3
  45. package/dist/validate.d.ts +3 -2
  46. package/dist/validate.d.ts.map +1 -1
  47. package/dist/validate.js +138 -136
  48. package/dist/version.d.ts +1 -1
  49. package/dist/version.d.ts.map +1 -1
  50. package/dist/version.js +1 -3
  51. package/dist/yaml.d.ts +2 -0
  52. package/dist/yaml.d.ts.map +1 -1
  53. package/dist/yaml.js +255 -191
  54. package/fixtures/README.md +85 -55
  55. package/fixtures/cases/absent-optional-field/library/companies/acme.md +4 -0
  56. package/fixtures/cases/absent-optional-field/library/deals/lead.md +6 -0
  57. package/fixtures/cases/absent-optional-field/schema.yaml +56 -0
  58. package/fixtures/cases/binary-any-reference/expected.json +1 -2
  59. package/fixtures/cases/binary-any-reference/schema.yaml +4 -0
  60. package/fixtures/cases/binary-document-collision/expected.json +1 -2
  61. package/fixtures/cases/binary-document-collision/schema.yaml +1 -0
  62. package/fixtures/cases/binary-link-outside-collection/expected.json +1 -2
  63. package/fixtures/cases/binary-link-outside-collection/schema.yaml +1 -0
  64. package/fixtures/cases/binary-prototype-reference/expected.json +1 -2
  65. package/fixtures/cases/binary-prototype-reference/schema.yaml +4 -0
  66. package/fixtures/cases/binary-typed-reference/expected.json +1 -2
  67. package/fixtures/cases/binary-typed-reference/schema.yaml +5 -0
  68. package/fixtures/cases/boolean-field/context.json +1 -0
  69. package/fixtures/cases/boolean-field/expected.json +6 -0
  70. package/fixtures/cases/boolean-field/library/companies/acme.md +4 -0
  71. package/fixtures/cases/boolean-field/library/deals/renewal.md +31 -0
  72. package/fixtures/cases/boolean-field/schema.yaml +56 -0
  73. package/fixtures/cases/bracketed-link-definition/schema.yaml +6 -0
  74. package/fixtures/cases/closed-nested-object/context.json +1 -0
  75. package/fixtures/cases/closed-nested-object/expected.json +6 -0
  76. package/fixtures/cases/closed-nested-object/library/companies/acme.md +4 -0
  77. package/fixtures/cases/closed-nested-object/library/deals/renewal.md +32 -0
  78. package/fixtures/cases/closed-nested-object/schema.yaml +56 -0
  79. package/fixtures/cases/composed-root-reference/context.json +1 -0
  80. package/fixtures/cases/composed-root-reference/expected.json +6 -0
  81. package/fixtures/cases/composed-root-reference/library/a.md +5 -0
  82. package/fixtures/cases/composed-root-reference/schema.yaml +13 -0
  83. package/fixtures/cases/date-time-format/context.json +1 -0
  84. package/fixtures/cases/date-time-format/expected.json +6 -0
  85. package/fixtures/cases/date-time-format/library/companies/acme.md +4 -0
  86. package/fixtures/cases/date-time-format/library/deals/renewal.md +31 -0
  87. package/fixtures/cases/date-time-format/schema.yaml +56 -0
  88. package/fixtures/cases/declared-binary-links/schema.yaml +1 -0
  89. package/fixtures/cases/default-unfilled/context.json +1 -0
  90. package/fixtures/cases/default-unfilled/expected.json +6 -0
  91. package/fixtures/cases/default-unfilled/library/companies/acme.md +4 -0
  92. package/fixtures/cases/default-unfilled/library/deals/renewal.md +29 -0
  93. package/fixtures/cases/default-unfilled/schema.yaml +56 -0
  94. package/fixtures/cases/defs-pattern/context.json +1 -0
  95. package/fixtures/cases/defs-pattern/expected.json +6 -0
  96. package/fixtures/cases/defs-pattern/library/companies/acme.md +4 -0
  97. package/fixtures/cases/defs-pattern/library/deals/renewal.md +31 -0
  98. package/fixtures/cases/defs-pattern/schema.yaml +56 -0
  99. package/fixtures/cases/dependent-rule/context.json +1 -0
  100. package/fixtures/cases/dependent-rule/expected.json +6 -0
  101. package/fixtures/cases/dependent-rule/library/companies/acme.md +4 -0
  102. package/fixtures/cases/dependent-rule/library/deals/renewal.md +30 -0
  103. package/fixtures/cases/dependent-rule/schema.yaml +56 -0
  104. package/fixtures/cases/duplicate-link-definition/schema.yaml +6 -0
  105. package/fixtures/cases/email-format/context.json +1 -0
  106. package/fixtures/cases/email-format/expected.json +6 -0
  107. package/fixtures/cases/email-format/library/companies/acme.md +4 -0
  108. package/fixtures/cases/email-format/library/deals/renewal.md +31 -0
  109. package/fixtures/cases/email-format/schema.yaml +56 -0
  110. package/fixtures/cases/fenced-link-definition/schema.yaml +6 -0
  111. package/fixtures/cases/field-enum/expected.json +2 -3
  112. package/fixtures/cases/field-enum/schema.yaml +7 -0
  113. package/fixtures/cases/frontmatter-schema/context.json +1 -0
  114. package/fixtures/cases/frontmatter-schema/expected.json +5 -0
  115. package/fixtures/cases/frontmatter-schema/schema.yaml +5 -0
  116. package/fixtures/cases/integer-field/context.json +1 -0
  117. package/fixtures/cases/integer-field/expected.json +6 -0
  118. package/fixtures/cases/integer-field/library/companies/acme.md +4 -0
  119. package/fixtures/cases/integer-field/library/deals/renewal.md +31 -0
  120. package/fixtures/cases/integer-field/schema.yaml +56 -0
  121. package/fixtures/cases/interrupted-link-definition/schema.yaml +1 -0
  122. package/fixtures/cases/json-schema-constructs/context.json +1 -0
  123. package/fixtures/cases/json-schema-constructs/expected.json +1 -0
  124. package/fixtures/cases/json-schema-constructs/library/companies/acme.md +4 -0
  125. package/fixtures/cases/json-schema-constructs/library/deals/renewal.md +31 -0
  126. package/fixtures/cases/json-schema-constructs/schema.yaml +56 -0
  127. package/fixtures/cases/list-of-objects-closed/context.json +1 -0
  128. package/fixtures/cases/list-of-objects-closed/expected.json +6 -0
  129. package/fixtures/cases/list-of-objects-closed/library/companies/acme.md +4 -0
  130. package/fixtures/cases/list-of-objects-closed/library/deals/renewal.md +32 -0
  131. package/fixtures/cases/list-of-objects-closed/schema.yaml +56 -0
  132. package/fixtures/cases/list-of-objects-item/context.json +1 -0
  133. package/fixtures/cases/list-of-objects-item/expected.json +6 -0
  134. package/fixtures/cases/list-of-objects-item/library/companies/acme.md +4 -0
  135. package/fixtures/cases/list-of-objects-item/library/deals/renewal.md +31 -0
  136. package/fixtures/cases/list-of-objects-item/schema.yaml +56 -0
  137. package/fixtures/cases/list-size/context.json +1 -0
  138. package/fixtures/cases/list-size/expected.json +6 -0
  139. package/fixtures/cases/list-size/library/companies/acme.md +4 -0
  140. package/fixtures/cases/list-size/library/deals/renewal.md +31 -0
  141. package/fixtures/cases/list-size/schema.yaml +56 -0
  142. package/fixtures/cases/long-fence-link-definition/schema.yaml +1 -0
  143. package/fixtures/cases/malformed-definition/expected.json +2 -4
  144. package/fixtures/cases/malformed-definition/schema.yaml +3 -0
  145. package/fixtures/cases/member-document/context.json +1 -0
  146. package/fixtures/cases/member-document/expected.json +1 -0
  147. package/fixtures/cases/member-document/library/people/ana.md +5 -0
  148. package/fixtures/cases/member-document/schema.yaml +5 -0
  149. package/fixtures/cases/missing-binary-image/expected.json +1 -2
  150. package/fixtures/cases/missing-binary-image/schema.yaml +1 -0
  151. package/fixtures/cases/missing-binary-link/expected.json +1 -2
  152. package/fixtures/cases/missing-binary-link/schema.yaml +1 -0
  153. package/fixtures/cases/missing-required-field/expected.json +2 -3
  154. package/fixtures/cases/missing-required-field/schema.yaml +7 -0
  155. package/fixtures/cases/missing-section-item-kind/context.json +1 -0
  156. package/fixtures/cases/missing-section-item-kind/expected.json +5 -0
  157. package/fixtures/cases/missing-section-item-kind/schema.yaml +6 -0
  158. package/fixtures/cases/misspelled-key/context.json +1 -0
  159. package/fixtures/cases/misspelled-key/expected.json +6 -0
  160. package/fixtures/cases/misspelled-key/library/companies/acme.md +4 -0
  161. package/fixtures/cases/misspelled-key/library/deals/renewal.md +32 -0
  162. package/fixtures/cases/misspelled-key/schema.yaml +56 -0
  163. package/fixtures/cases/nested-defs/context.json +1 -0
  164. package/fixtures/cases/nested-defs/expected.json +6 -0
  165. package/fixtures/cases/nested-defs/library/deal.md +6 -0
  166. package/fixtures/cases/nested-defs/schema.yaml +11 -0
  167. package/fixtures/cases/nested-required-field/context.json +1 -0
  168. package/fixtures/cases/nested-required-field/expected.json +6 -0
  169. package/fixtures/cases/nested-required-field/library/companies/acme.md +4 -0
  170. package/fixtures/cases/nested-required-field/library/deals/renewal.md +30 -0
  171. package/fixtures/cases/nested-required-field/schema.yaml +56 -0
  172. package/fixtures/cases/null-refused/context.json +1 -0
  173. package/fixtures/cases/null-refused/expected.json +6 -0
  174. package/fixtures/cases/null-refused/library/companies/acme.md +4 -0
  175. package/fixtures/cases/null-refused/library/deals/renewal.md +31 -0
  176. package/fixtures/cases/null-refused/schema.yaml +56 -0
  177. package/fixtures/cases/numeric-range/context.json +1 -0
  178. package/fixtures/cases/numeric-range/expected.json +6 -0
  179. package/fixtures/cases/numeric-range/library/companies/acme.md +4 -0
  180. package/fixtures/cases/numeric-range/library/deals/renewal.md +31 -0
  181. package/fixtures/cases/numeric-range/schema.yaml +56 -0
  182. package/fixtures/cases/one-of-variant/context.json +1 -0
  183. package/fixtures/cases/one-of-variant/expected.json +6 -0
  184. package/fixtures/cases/one-of-variant/library/companies/acme.md +4 -0
  185. package/fixtures/cases/one-of-variant/library/deals/renewal.md +31 -0
  186. package/fixtures/cases/one-of-variant/schema.yaml +56 -0
  187. package/fixtures/cases/open-map-value/context.json +1 -0
  188. package/fixtures/cases/open-map-value/expected.json +6 -0
  189. package/fixtures/cases/open-map-value/library/companies/acme.md +4 -0
  190. package/fixtures/cases/open-map-value/library/deals/renewal.md +31 -0
  191. package/fixtures/cases/open-map-value/schema.yaml +56 -0
  192. package/fixtures/cases/paragraph-link-definition/schema.yaml +1 -0
  193. package/fixtures/cases/prototype-field/context.json +1 -0
  194. package/fixtures/cases/prototype-field/expected.json +6 -0
  195. package/fixtures/cases/prototype-field/library/item.md +9 -0
  196. package/fixtures/cases/prototype-field/schema.yaml +6 -0
  197. package/fixtures/cases/quoted-link-definition/expected.json +1 -2
  198. package/fixtures/cases/quoted-link-definition/schema.yaml +1 -0
  199. package/fixtures/cases/referenced-missing-file/expected.json +0 -1
  200. package/fixtures/cases/referenced-missing-file/schema.yaml +11 -0
  201. package/fixtures/cases/remote-ref/context.json +1 -0
  202. package/fixtures/cases/remote-ref/expected.json +5 -0
  203. package/fixtures/cases/remote-ref/schema.yaml +3 -0
  204. package/fixtures/cases/second-member-document/context.json +1 -0
  205. package/fixtures/cases/second-member-document/expected.json +5 -0
  206. package/fixtures/cases/second-member-document/schema.yaml +4 -0
  207. package/fixtures/cases/section-item-enum/context.json +1 -0
  208. package/fixtures/cases/section-item-enum/expected.json +6 -0
  209. package/fixtures/cases/section-item-enum/library/task.md +8 -0
  210. package/fixtures/cases/section-item-enum/schema.yaml +3 -0
  211. package/fixtures/cases/section-item-kind/context.json +1 -0
  212. package/fixtures/cases/section-item-kind/expected.json +6 -0
  213. package/fixtures/cases/section-item-kind/library/task.md +8 -0
  214. package/fixtures/cases/section-item-kind/schema.yaml +3 -0
  215. package/fixtures/cases/section-items/context.json +1 -0
  216. package/fixtures/cases/section-items/expected.json +1 -0
  217. package/fixtures/cases/section-items/library/other.md +3 -0
  218. package/fixtures/cases/section-items/library/page.md +42 -0
  219. package/fixtures/cases/section-items/schema.yaml +10 -0
  220. package/fixtures/cases/section-reference-path/context.json +1 -0
  221. package/fixtures/cases/section-reference-path/expected.json +6 -0
  222. package/fixtures/cases/section-reference-path/library/other.md +3 -0
  223. package/fixtures/cases/section-reference-path/library/page.md +7 -0
  224. package/fixtures/cases/section-reference-path/schema.yaml +3 -0
  225. package/fixtures/cases/section-reference-type/context.json +1 -0
  226. package/fixtures/cases/section-reference-type/expected.json +6 -0
  227. package/fixtures/cases/section-reference-type/library/note.md +1 -0
  228. package/fixtures/cases/section-reference-type/library/page.md +7 -0
  229. package/fixtures/cases/section-reference-type/schema.yaml +3 -0
  230. package/fixtures/cases/shortcut-reference-link/context.json +1 -0
  231. package/fixtures/cases/shortcut-reference-link/expected.json +5 -0
  232. package/fixtures/cases/shortcut-reference-link/library/item.md +10 -0
  233. package/fixtures/cases/shortcut-reference-link/schema.yaml +6 -0
  234. package/fixtures/cases/string-length/context.json +1 -0
  235. package/fixtures/cases/string-length/expected.json +6 -0
  236. package/fixtures/cases/string-length/library/companies/acme.md +4 -0
  237. package/fixtures/cases/string-length/library/deals/renewal.md +31 -0
  238. package/fixtures/cases/string-length/schema.yaml +56 -0
  239. package/fixtures/cases/structured-section/expected.json +1 -2
  240. package/fixtures/cases/structured-section/schema.yaml +7 -0
  241. package/fixtures/cases/submission-keys/context.json +1 -0
  242. package/fixtures/cases/submission-keys/expected.json +1 -0
  243. package/fixtures/cases/submission-keys/library/notes/visitor.md +8 -0
  244. package/fixtures/cases/submission-keys/schema.yaml +4 -0
  245. package/fixtures/cases/text-field-kind/context.json +1 -0
  246. package/fixtures/cases/text-field-kind/expected.json +6 -0
  247. package/fixtures/cases/text-field-kind/library/page.md +4 -0
  248. package/fixtures/cases/text-field-kind/schema.yaml +4 -0
  249. package/fixtures/cases/truncated-link-definition/expected.json +1 -2
  250. package/fixtures/cases/truncated-link-definition/schema.yaml +1 -0
  251. package/fixtures/cases/types-folder-content/context.json +1 -0
  252. package/fixtures/cases/types-folder-content/expected.json +1 -0
  253. package/fixtures/cases/types-folder-content/library/types/task.md +4 -0
  254. package/fixtures/cases/types-folder-content/schema.yaml +4 -0
  255. package/fixtures/cases/unclosed-frontmatter/expected.json +1 -2
  256. package/fixtures/cases/undeclared-field/context.json +1 -0
  257. package/fixtures/cases/undeclared-field/expected.json +6 -0
  258. package/fixtures/cases/undeclared-field/library/item.md +9 -0
  259. package/fixtures/cases/undeclared-field/schema.yaml +6 -0
  260. package/fixtures/cases/unevaluated-items-closed/context.json +1 -0
  261. package/fixtures/cases/unevaluated-items-closed/expected.json +6 -0
  262. package/fixtures/cases/unevaluated-items-closed/library/trip.md +6 -0
  263. package/fixtures/cases/unevaluated-items-closed/schema.yaml +10 -0
  264. package/fixtures/cases/unknown-type/context.json +1 -0
  265. package/fixtures/cases/unknown-type/expected.json +6 -0
  266. package/fixtures/cases/unknown-type/library/item.md +3 -0
  267. package/fixtures/cases/unknown-type/schema.yaml +3 -0
  268. package/fixtures/cases/unlisted-reference-type/context.json +1 -0
  269. package/fixtures/cases/unlisted-reference-type/expected.json +5 -0
  270. package/fixtures/cases/unlisted-reference-type/schema.yaml +3 -0
  271. package/fixtures/cases/unresolved-link/expected.json +1 -2
  272. package/fixtures/cases/unresolved-link/schema.yaml +6 -0
  273. package/fixtures/cases/valid-typed-document/library/tasks/one.md +1 -0
  274. package/fixtures/cases/valid-typed-document/schema.yaml +16 -0
  275. package/fixtures/cases/wide-item-fence-link/schema.yaml +1 -0
  276. package/fixtures/division.json +409 -0
  277. package/fixtures/projection.json +109 -28
  278. package/package.json +3 -12
  279. package/dist/definition.js.map +0 -1
  280. package/dist/document.js.map +0 -1
  281. package/dist/index.js.map +0 -1
  282. package/dist/links.js.map +0 -1
  283. package/dist/paths.js.map +0 -1
  284. package/dist/profile.js.map +0 -1
  285. package/dist/project.js.map +0 -1
  286. package/dist/refuse.js.map +0 -1
  287. package/dist/schema.js.map +0 -1
  288. package/dist/sections.js.map +0 -1
  289. package/dist/types.js.map +0 -1
  290. package/dist/validate.js.map +0 -1
  291. package/dist/version.js.map +0 -1
  292. package/dist/yaml.js.map +0 -1
  293. package/fixtures/cases/binary-any-reference/library/types/note.md +0 -5
  294. package/fixtures/cases/binary-document-collision/library/types/note.md +0 -3
  295. package/fixtures/cases/binary-link-outside-collection/library/types/note.md +0 -3
  296. package/fixtures/cases/binary-prototype-reference/library/types/note.md +0 -5
  297. package/fixtures/cases/binary-typed-reference/library/types/note.md +0 -5
  298. package/fixtures/cases/binary-typed-reference/library/types/person.md +0 -3
  299. package/fixtures/cases/bracketed-link-definition/library/types/task.md +0 -7
  300. package/fixtures/cases/declared-binary-links/library/types/note.md +0 -3
  301. package/fixtures/cases/duplicate-link-definition/library/types/task.md +0 -7
  302. package/fixtures/cases/fenced-link-definition/library/types/task.md +0 -7
  303. package/fixtures/cases/field-enum/library/types/task.md +0 -8
  304. package/fixtures/cases/interrupted-link-definition/library/types/note.md +0 -3
  305. package/fixtures/cases/long-fence-link-definition/library/types/note.md +0 -3
  306. package/fixtures/cases/malformed-definition/library/types/task.md +0 -5
  307. package/fixtures/cases/missing-binary-image/library/types/note.md +0 -3
  308. package/fixtures/cases/missing-binary-link/library/types/note.md +0 -3
  309. package/fixtures/cases/missing-required-field/library/types/task.md +0 -8
  310. package/fixtures/cases/paragraph-link-definition/library/types/note.md +0 -3
  311. package/fixtures/cases/prd-definition/library/types/task.md +0 -15
  312. package/fixtures/cases/quoted-link-definition/library/types/note.md +0 -3
  313. package/fixtures/cases/referenced-missing-file/library/types/person.md +0 -5
  314. package/fixtures/cases/referenced-missing-file/library/types/task.md +0 -8
  315. package/fixtures/cases/structured-section/library/types/task.md +0 -8
  316. package/fixtures/cases/truncated-link-definition/library/types/note.md +0 -3
  317. package/fixtures/cases/unresolved-link/library/types/task.md +0 -7
  318. package/fixtures/cases/valid-typed-document/library/types/person.md +0 -5
  319. package/fixtures/cases/valid-typed-document/library/types/task.md +0 -12
  320. package/fixtures/cases/wide-item-fence-link/library/types/note.md +0 -3
  321. package/markdown-syntax-profile.md +0 -9
  322. /package/fixtures/cases/{prd-definition → absent-optional-field}/context.json +0 -0
  323. /package/fixtures/cases/{prd-definition → absent-optional-field}/expected.json +0 -0
package/API.md ADDED
@@ -0,0 +1,300 @@
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
+ VERSION,
17
+ } from '@agentshouse/mdmodel';
18
+
19
+ validate({ 'note.md': '# Hello\n' });
20
+ const checked = verify('task:\n properties:\n title: { type: string }\n');
21
+ if (checked.verdict === 'accept') {
22
+ validate(
23
+ { 'tasks/one.md': '---\ntype: task\ntitle: Ship\n---\n![Figure](assets/figure.png)\n' },
24
+ { binaryTargets: ['assets/figure.png'] },
25
+ checked.model,
26
+ );
27
+ const titleType = checked.model.types.task?.fields.title?.type;
28
+ }
29
+ const parsed = parse(content);
30
+ if (parsed.ok) {
31
+ const next = apply(parsed.document, {
32
+ kind: 'field',
33
+ name: 'title',
34
+ value: 'World',
35
+ prior: 'Hello',
36
+ });
37
+ if (next.outcome === 'applied') serialize(next.document);
38
+ for (const link of links(parsed.document, 'tasks/two.md')) {
39
+ if (link.target !== 'data/export.csv') continue;
40
+ const moved = apply(parsed.document, {
41
+ kind: 'link',
42
+ href: link.href,
43
+ to: '../files/export.csv',
44
+ });
45
+ if (moved.outcome === 'applied') serialize(moved.document);
46
+ }
47
+ }
48
+ ```
49
+
50
+ `verify(schema)` reads one schema text, the MD Types of one Room or App: one
51
+ JSON Schema document (draft 2020-12) in the YAML subset. Every top-level key but
52
+ `$defs` names an MD Type holding the JSON Schema of its frontmatter; `$defs`
53
+ holds shapes the types reuse, reached by a `$ref` under `#/$defs/` alone. `type`
54
+ and the built-in `any` are never declared. The model adds three keywords:
55
+ `reference` on a string names one MD Type, several, `any` or `attachment`;
56
+ `sections` declares a type's H2 sections, each `{ kind: text }` or `{ kind:
57
+ list, items }` over one string, number, integer or boolean, optionally
58
+ `required: true`; `member_document: true` marks at most one type.
59
+
60
+ ```yaml
61
+ $defs:
62
+ address: { type: object, properties: { city: { type: string } }, required: [city] }
63
+ plan:
64
+ properties:
65
+ status: { enum: [active, done] }
66
+ owner: { type: string, reference: contact }
67
+ shipping: { $ref: '#/$defs/address' }
68
+ required: [status]
69
+ sections: { Goals: { kind: text, required: true } }
70
+ contact: { member_document: true }
71
+ ```
72
+
73
+ The model's `types` expose each MD Type's `name`, `memberDocument`, `sections`,
74
+ `shape` (the type as written with every `$defs` shape it reaches), the facts of
75
+ its `frontmatter` and `fields`, its top-level ones: JSON `type`, `format`,
76
+ `values`, `reference` targets, `items`, `properties`, an open map's `patterns`
77
+ and `additional`, and `prose`, a string with no `enum`, `const`, `format`,
78
+ `pattern` or `reference`. Facts join `$ref` and `allOf` to their siblings and
79
+ the variants of `anyOf`, `oneOf`, `then`, `else` and `dependentSchemas`; a path
80
+ without one `type`, `null` aside, has none. A malformed schema is refused
81
+ whole, naming its `rule`, the keyword or the model's own, and the JSON Pointer
82
+ `location` it concerns, such as `/plan/properties/status/enum`, or `line <n>`
83
+ outside the YAML subset.
84
+
85
+ `validate(library, context?, model?)` takes the resulting text Library and one
86
+ `ValidationContext` of `binaryTargets: readonly string[]`, none when omitted.
87
+ Library keys and binary targets share one collection-relative path namespace;
88
+ callers supply canonical paths; a path declared text and binary is refused. Ordinary links and images
89
+ in typed Documents may resolve to either membership, including relative
90
+ normalization from the source Document. A binary target supplies no Document
91
+ or MD Type and cannot satisfy a typed reference, including one to `any`.
92
+ `model` is the verified schema that types the Library, and every Library member
93
+ is content, whatever its Path. Without `model` the Library declares no type.
94
+
95
+ A typed Document's frontmatter satisfies its type's schema, every keyword with
96
+ its JSON Schema meaning, formats asserted and defaults never filled, except that
97
+ an object schema declaring neither `additionalProperties` nor
98
+ `unevaluatedProperties` is closed: an undeclared key is refused as `undeclared-
99
+ field`. `type`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every
100
+ type, and the string `MEMBER_FIELD` on the `member_document` type. A refusal
101
+ names the keyword, such as `required`, and the value's JSON Pointer, such as
102
+ `/shipping/city`. Every occurrence of a declared list section is a list of
103
+ values of its item schema, else `structured-section`; a reference item is one
104
+ ordinary link alone, such as `- [Ada](ada.md)`. A reference, a field's, a list
105
+ item's or a section item's, reaching a binary target, a URL, or a Document of a
106
+ type it does not name is `unresolved-reference`.
107
+
108
+ Validation returns acceptance or one refusal naming the file, the field or
109
+ section, and the violated rule. `parse`, `apply`, and `serialize` operate on a single text
110
+ Document; they do not validate collection membership or consume binary bytes.
111
+ `apply` sets one typed field, including a list field as a whole, replaces
112
+ one existing section body or the preamble against that value's prior content,
113
+ or rewrites one Markdown link destination. A section need not be declared by
114
+ the Document's MD Type to be replaced. A field change does not reformat the rest of the file.
115
+
116
+ `Document.preamble` is a readonly string containing the exact source after
117
+ frontmatter and before the first section heading recognized by the existing
118
+ section parser. Without a section it is the entire post-frontmatter body;
119
+ without frontmatter it starts at the beginning of the Document. An empty span
120
+ is `''`. It includes whitespace, newlines, a leading H1, and any fenced text
121
+ before the first section. The closing frontmatter delimiter and its line ending
122
+ belong to frontmatter. Section recognition and the syntax profile are unchanged.
123
+
124
+ ```ts
125
+ const parsed = parse(content);
126
+ if (parsed.ok) {
127
+ const change = {
128
+ kind: 'preamble' as const,
129
+ prior: parsed.document.preamble,
130
+ value: 'Updated introduction.\n\n',
131
+ };
132
+ const result = apply(parsed.document, change);
133
+ if (result.outcome === 'applied') serialize(result.document);
134
+ }
135
+ ```
136
+
137
+ `apply(document, { kind: 'preamble', prior, value })` compares `prior` to the
138
+ current preamble exactly. A mismatch returns `{ outcome: 'stale', document }`
139
+ with the unchanged current Document. A match replaces only that source span,
140
+ then parses a new immutable Document; the original is unchanged. Frontmatter
141
+ and section source outside the span retain their exact bytes, including newline
142
+ and heading syntax. As with section replacement, `value` is literal source:
143
+ no newline or separator is inserted, and the resulting source is parsed again.
144
+ An invalid frontmatter result receives the existing parse refusal. Independent
145
+ field, section, and preamble edits keep their own prior values valid.
146
+
147
+ For a moved link, use `links` and the `link` change below to obtain the rewritten
148
+ Document, then compare its public `preamble` and `sections` to the original.
149
+ Submit the changed values with their original priors. Consumers need no source
150
+ span calculation or private Model import. Collection validation remains a
151
+ separate call against the resulting Library.
152
+
153
+ `links(document, file)` is the inventory of that Document's ordinary link and
154
+ image destinations that resolve to a collection Path, each with the destination
155
+ `href` exactly as written and the `target` Path it resolves to relative to
156
+ `file`. A `?query` or `#fragment` the destination carries is part of `href` and
157
+ not part of `target`. Entries are ordered by the position of the destination
158
+ text a rewrite would change, and one destination written the same way appears
159
+ once however many times it occurs. A destination that the syntax profile does not read as a
160
+ link, one that is empty, a bare fragment, or carries a URL scheme, and one that
161
+ leaves the collection are not in the inventory. Frontmatter field values,
162
+ including typed references, are not link destinations and are never enumerated.
163
+
164
+ `target(file, href)` is the collection Path one written destination resolves to
165
+ relative to `file`, by the rule `links` and `validate` read: surrounding spaces
166
+ and the `?query` or `#fragment` it carries are not part of that Path. A
167
+ destination that is empty, a bare fragment, carries a URL scheme, starts at `/`,
168
+ or leaves the collection resolves to `null`. It reads a destination written
169
+ anywhere, such as a typed reference field value, which `links` never
170
+ enumerates. `retarget(href, to)` is that destination rewritten to `to`, keeping
171
+ the `?query` or `#fragment` it carried, which is the destination the `link`
172
+ change below writes.
173
+
174
+ ```ts
175
+ target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
176
+ retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
177
+ ```
178
+
179
+ `apply(document, { kind: 'link', href, to })` rewrites every body occurrence of
180
+ that written destination and changes nothing else, so a caller that moves a Path
181
+ rewrites its referring Documents without a second Markdown parser. `to` is the
182
+ Path the destination must resolve to instead; the `?query` or `#fragment` the
183
+ written destination carried is not part of that Path and is kept. A Document
184
+ that does not carry the destination is `stale`. A reference definition is
185
+ rewritten once however many uses name it. The destination is
186
+ written in the form the syntax profile reads back: bare when it carries no
187
+ whitespace, does not open with `<`, and balances its parentheses, otherwise
188
+ inside angle brackets, which the original form is kept in when it still fits. A
189
+ destination that neither form can carry is refused as `unwritable-link`.
190
+
191
+ `project(document, file, context?)` is the Embedding projection input of one
192
+ Document: the prose a consumer embeds, with every internal Markdown-document
193
+ link reduced to the label a reader sees. A Document that declares no MD type
194
+ contributes its body after the frontmatter fence. A typed one contributes its
195
+ prose values, its preamble, and every H2 section its MD type does not declare as
196
+ structure, each with its own heading line and every occurrence of a repeated
197
+ name, in Document order: a declared text section, a list section of prose items
198
+ and an undeclared section are in; a list section of any other item schema is
199
+ not. A prose value is a frontmatter string at any depth whose schema is prose,
200
+ projected bare and followed by a blank line, in the order the Document writes
201
+ them, exactly as written. The Path and every other value stay outside, so
202
+ changing them alone leaves the projection unchanged.
203
+
204
+ ```ts
205
+ const parsed = parse(content);
206
+ if (parsed.ok) {
207
+ const projected = project(parsed.document, 'tasks/two.md', {
208
+ documentTargets: ['plans/q3.md', 'people/ana.md'],
209
+ definition: model.types.task,
210
+ });
211
+ if (projected.ok) embed(projected.text);
212
+ }
213
+ ```
214
+
215
+ `ProjectionContext` carries `documentTargets`, the collection-relative Paths the
216
+ caller holds as Markdown documents, and `definition`, the verified MD Type the
217
+ Document's `type` names, taken from the model `verify` returned. A Document that
218
+ declares a type the caller supplies no definition for is refused as
219
+ `unknown-type`. `documentTargets` is what makes a destination internal: a
220
+ destination resolving to a supplied Path is internal, and every other
221
+ destination stays authored text, a retained binary target and a Path nobody
222
+ supplied alike. The caller supplies that membership, as it does for `validate`;
223
+ the model reads no bytes, resolves no authority, and classifies nothing it was
224
+ not given.
225
+
226
+ An internal link contributes its visible label and no destination, fragment, or
227
+ title, in the inline `[label](path)`, full `[label][id]`, collapsed
228
+ `[label][]`, and shortcut `[label]` forms, and the link reference definition an
229
+ enumerated use resolves through leaves the projection with it. An image at a
230
+ supplied document target contributes its alt text the same way, because a move
231
+ rewrites that destination too. External URLs, retained binary targets,
232
+ unsupplied destinations, bare fragments, code spans, fenced code, and escaped
233
+ syntax stay exactly as authored, read through the same syntax profile `links`
234
+ and `validate` read. `project` returns text and never rewrites the Document.
235
+
236
+ Because a moved Path changes destinations alone, applying a `link` change leaves
237
+ the projection of every Document it rewrites byte-identical, while a changed
238
+ visible label changes it.
239
+
240
+ `divide(document, file, context)` divides that same Embedding projection input
241
+ into ordered Spans under the budget the caller supplies. Each Span carries the
242
+ `text` to embed and the `start` and `end` of the extent it addresses in the
243
+ Document's own source, as UTF-8 byte offsets into that source and never string
244
+ positions, so a caller stores the extent and hydrates the text it shows from
245
+ the Document itself.
246
+
247
+ ```ts
248
+ const parsed = parse(content);
249
+ if (parsed.ok) {
250
+ const divided = divide(parsed.document, 'tasks/two.md', {
251
+ documentTargets: ['plans/q3.md', 'people/ana.md'],
252
+ definition: model.types.task,
253
+ budget: 2000,
254
+ });
255
+ if (divided.ok) for (const span of divided.spans) embed(span.text);
256
+ }
257
+ ```
258
+
259
+ `DivisionContext` is a `ProjectionContext` and one `budget`, the greatest number
260
+ of characters a Span's embedded text may carry, counted the way JavaScript
261
+ counts a string's length and not in the bytes the extent is measured in. No
262
+ Span's text is ever longer than the budget. A bound cut never divides a
263
+ character: where the budget ends between the two halves of a surrogate pair,
264
+ the cut falls before the pair. A cut never falls inside link syntax either: it
265
+ falls before an internal link, and a label longer than a whole piece's room is
266
+ divided at the bound like any other text. The smallest budget is `2`, the
267
+ length of one astral character; a budget that is not a whole number of at least
268
+ `2` is refused with `division-budget` before any division. The budget is the
269
+ caller's number alone: the model holds no tokenizer, counts nothing else, and
270
+ refuses no input for being too long. A Document the caller supplies no
271
+ definition for carries the same `unknown-type` refusal `project` returns.
272
+
273
+ The division descends one level at a time, and only into the piece that does not
274
+ fit: the whole input, a heading node, adjacent sibling nodes packed under one
275
+ parent, adjacent blocks inside a node, sentences inside a block, and a bound cut
276
+ inside a single sentence. A Span covers whole heading nodes or one contiguous
277
+ piece inside a single node, never a partial node beside another. A Span that
278
+ continues a node repeats that node's own heading line, projected like any other
279
+ text and so carrying an internal link's label rather than its destination, and
280
+ never an ancestor's heading, so renaming a heading costs what editing that
281
+ heading's own body costs. A heading the budget cannot hold beside any text is
282
+ not repeated, a continuation piece that begins with an astral character the
283
+ room beside its heading cannot hold is carried without the heading, and a
284
+ heading with no body of its own leads its first child node rather than standing
285
+ as a Span of nothing but itself. Overlap exists at the
286
+ sentence level alone, where each Span after the first repeats its predecessor's
287
+ last sentence whenever the budget holds both; when it cannot hold both, the
288
+ Span carries its own sentence alone. An untyped input arrives without a
289
+ definition and descends the same ladder.
290
+
291
+ Division is total: every authored character of the input belongs to at least one
292
+ Span, and an input carrying no authored text divides into no Span at all. A
293
+ Span's extent is the smallest range of the source that contains everything the
294
+ Span covers, so it spans what the input excludes between two eligible pieces,
295
+ and the extent addresses the authored source where the embedded text carries a
296
+ repeated heading, an internal link's visible label, or a frontmatter value the
297
+ author quoted. A Span divided out of one free-text field value addresses that
298
+ whole value, because a YAML scalar's own positions are the only ones its source
299
+ has, and a Span carrying part of one internal link's label addresses that whole
300
+ 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: MD Types declared in JSON Schema, 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,31 +14,17 @@ through either `import` or `require`; browser bundlers consume the same artifact
16
14
  npm install @agentshouse/mdmodel
17
15
  ```
18
16
 
19
- Package releases are published after the User confirms.
20
-
21
- ## API
17
+ ## Usage
22
18
 
23
19
  ```ts
24
- import {
25
- apply,
26
- links,
27
- MARKDOWN_SYNTAX_PROFILE,
28
- parse,
29
- project,
30
- serialize,
31
- validate,
32
- VERSION,
33
- } from '@agentshouse/mdmodel';
20
+ import { apply, parse, serialize, validate, verify } from '@agentshouse/mdmodel';
21
+
22
+ const checked = verify('task:\n properties:\n title: { type: string }\n');
23
+ if (checked.verdict === 'accept') {
24
+ validate({ 'tasks/one.md': '---\ntype: task\ntitle: Ship\n---\n' }, undefined, checked.model);
25
+ }
34
26
 
35
- validate({ 'note.md': '# Hello\n' });
36
- validate(
37
- {
38
- 'types/note.md': '---\ntype: definition\n---\n',
39
- 'note.md': '---\ntype: note\n---\n![Figure](assets/figure.png)\n',
40
- },
41
- { binaryTargets: ['assets/figure.png'] },
42
- );
43
- const parsed = parse(content);
27
+ const parsed = parse('---\ntype: note\ntitle: Hello\n---\n');
44
28
  if (parsed.ok) {
45
29
  const next = apply(parsed.document, {
46
30
  kind: 'field',
@@ -49,152 +33,27 @@ if (parsed.ok) {
49
33
  prior: 'Hello',
50
34
  });
51
35
  if (next.outcome === 'applied') serialize(next.document);
52
- for (const link of links(parsed.document, 'tasks/two.md')) {
53
- if (link.target !== 'data/export.csv') continue;
54
- const moved = apply(parsed.document, {
55
- kind: 'link',
56
- href: link.href,
57
- to: '../files/export.csv',
58
- });
59
- if (moved.outcome === 'applied') serialize(moved.document);
60
- }
61
36
  }
62
37
  ```
63
38
 
64
- `validate(library, context?)` takes the resulting text Library and one
65
- `ValidationContext` containing `binaryTargets: readonly string[]`. Omitting the
66
- context declares no binary targets. Library keys and binary targets use the
67
- same collection-relative path namespace; callers supply canonical paths, and
68
- a path declared as both text and binary is refused. Ordinary links and images
69
- in typed Documents may resolve to either membership, including relative
70
- normalization from the source Document. A binary target supplies no Document
71
- or MD Type and cannot satisfy a typed reference, including one to `any`.
72
- The existing `any` Document rules are unchanged.
73
-
74
- Validation returns acceptance or one refusal naming the file, the field or
75
- section, the violated rule, and `VERSION`. Every caller operation that validates
76
- a resulting collection supplies that collection's context to this same
77
- `validate` function. `parse`, `apply`, and `serialize` operate on a single text
78
- Document; they do not validate collection membership or consume binary bytes.
79
- `apply` sets one typed field, including a list field as a whole, replaces
80
- one existing section body or the preamble against that value's prior content,
81
- or rewrites one Markdown link destination. A section need not be declared by
82
- the Document's MD Type to be replaced. A field change does not reformat the rest of the file.
83
-
84
- `Document.preamble` is a readonly string containing the exact source after
85
- frontmatter and before the first section heading recognized by the existing
86
- section parser. Without a section it is the entire post-frontmatter body;
87
- without frontmatter it starts at the beginning of the Document. An empty span
88
- is `''`. It includes whitespace, newlines, a leading H1, and any fenced text
89
- before the first section. The closing frontmatter delimiter and its line ending
90
- belong to frontmatter. Section recognition and the syntax profile are unchanged.
91
-
92
- ```ts
93
- const parsed = parse(content);
94
- if (parsed.ok) {
95
- const change = {
96
- kind: 'preamble' as const,
97
- prior: parsed.document.preamble,
98
- value: 'Updated introduction.\n\n',
99
- };
100
- const result = apply(parsed.document, change);
101
- if (result.outcome === 'applied') serialize(result.document);
102
- }
103
- ```
104
-
105
- `apply(document, { kind: 'preamble', prior, value })` compares `prior` to the
106
- current preamble exactly. A mismatch returns `{ outcome: 'stale', document }`
107
- with the unchanged current Document. A match replaces only that source span,
108
- then parses a new immutable Document; the original is unchanged. Frontmatter
109
- and section source outside the span retain their exact bytes, including newline
110
- and heading syntax. As with section replacement, `value` is literal source:
111
- no newline or separator is inserted, and the resulting source is parsed again.
112
- An invalid frontmatter result receives the existing parse refusal. Independent
113
- field, section, and preamble edits keep their own prior values valid.
114
-
115
- For a moved link, use `links` and the `link` change below to obtain the rewritten
116
- Document, then compare its public `preamble` and `sections` to the original.
117
- Submit the changed values with their original priors. Consumers need no source
118
- span calculation or private Model import. Collection validation remains a
119
- separate call against the resulting Library.
120
-
121
- `links(document, file)` is the inventory of that Document's ordinary link and
122
- image destinations that resolve to a collection Path, each with the destination
123
- `href` exactly as written and the `target` Path it resolves to relative to
124
- `file`. A `?query` or `#fragment` the destination carries is part of `href` and
125
- not part of `target`. Entries are ordered by the position of the destination
126
- text a rewrite would change, and one destination written the same way appears
127
- once however many times it occurs. A destination that the syntax profile does not read as a
128
- link, one that is empty, a bare fragment, or carries a URL scheme, and one that
129
- leaves the collection are not in the inventory. Frontmatter field values,
130
- including typed references, are not link destinations and are never enumerated.
131
-
132
- `apply(document, { kind: 'link', href, to })` rewrites every body occurrence of
133
- that written destination and changes nothing else, so a caller that moves a Path
134
- rewrites its referring Documents without a second Markdown parser. `to` is the
135
- Path the destination must resolve to instead; the `?query` or `#fragment` the
136
- written destination carried is not part of that Path and is kept. A Document
137
- that does not carry the destination is `stale`. A reference definition is
138
- rewritten once however many uses name it. The destination is
139
- written in the form the syntax profile reads back: bare when it carries no
140
- whitespace, does not open with `<`, and balances its parentheses, otherwise
141
- inside angle brackets, which the original form is kept in when it still fits. A
142
- destination that neither form can carry is refused as `unwritable-link`.
143
-
144
- `project(document, file, context?)` is the Embedding projection input of one
145
- Document: the prose a consumer embeds, with every internal Markdown-document
146
- link reduced to the label a reader sees. A Document that declares no MD type
147
- contributes its body after the frontmatter fence. A Document that declares one
148
- contributes the H2 sections its MD type declares as free text, each with its own
149
- heading line and every occurrence of a repeated name, in the order the Document
150
- carries them. Its Path, its frontmatter fields, its preamble, the sections it
151
- carries that its MD type does not declare, and the declared structured-list
152
- sections are outside that input.
153
-
154
- ```ts
155
- const parsed = parse(content);
156
- if (parsed.ok) {
157
- const projected = project(parsed.document, 'tasks/two.md', {
158
- documentTargets: ['plans/q3.md', 'people/ana.md'],
159
- definition: types['types/task.md'],
160
- });
161
- if (projected.ok) embed(projected.text);
162
- }
163
- ```
164
-
165
- `ProjectionContext` carries `documentTargets`, the collection-relative Paths the
166
- caller holds as Markdown documents, and `definition`, the source of the MD Type
167
- definition Document the Document's `type` names. A Document that declares a type
168
- the caller supplies no definition for is refused as `unknown-type`, and a
169
- definition source the model cannot read carries its own refusal naming
170
- `types/<type>.md`. `documentTargets` is what makes a destination internal: a
171
- destination resolving to a supplied Path is internal, and every other
172
- destination stays authored text, a retained binary target and a Path nobody
173
- supplied alike. The caller supplies that membership, as it does for `validate`;
174
- the model reads no bytes, resolves no authority, and classifies nothing it was
175
- not given.
176
-
177
- An internal link contributes its visible label and no destination, fragment, or
178
- title, in the inline `[label](path)`, full `[label][id]`, and collapsed
179
- `[label][]` forms, and the link reference definition an enumerated use resolves
180
- through leaves the projection with it. An image at a supplied document target
181
- contributes its alt text the same way, because a move rewrites that destination
182
- too. External URLs, retained binary targets, unsupplied destinations, bare
183
- fragments, code spans, fenced code, and escaped syntax stay exactly as authored,
184
- read through the same syntax profile `links` and `validate` read. `project`
185
- returns text and never rewrites the Document.
186
-
187
- Because a moved Path changes destinations alone, applying a `link` change leaves
188
- the projection of every Document it rewrites byte-identical, while a changed
189
- visible label changes it. `fixtures/projection.json` carries every move row of
190
- that corpus; the label change is proven at this package's own `project` seam.
191
-
192
- ## Fixtures
193
-
194
- The conformance corpus ships in `fixtures/`. Its verdict format and rule ids
195
- are documented in [`fixtures/README.md`](fixtures/README.md).
196
-
197
- ## Markdown syntax profile
39
+ ## API
198
40
 
199
- GitHub Flavored Markdown Spec 0.29, as documentation, not as validation.
200
- See [`markdown-syntax-profile.md`](markdown-syntax-profile.md).
41
+ | Export | Purpose |
42
+ | ---------------------------------------------- | ----------------------------------------------------------------- |
43
+ | `verify` | Verify one schema text into a model of MD Types |
44
+ | `validate` | Validate a text Library; returns acceptance or one refusal |
45
+ | `parse`, `serialize` | Read and write one Document |
46
+ | `apply` | Apply one field, section, preamble, or link change |
47
+ | `links`, `target`, `retarget` | Inventory and rewrite link destinations |
48
+ | `escapePointer` | Write one key as a JSON Pointer token |
49
+ | `project`, `divide` | Embedding projection input and its division into Spans |
50
+ | `facts`, `factKind`, `holds`, `fires` | A condition over a Document and over one of its changes |
51
+ | `MARKDOWN_SYNTAX_PROFILE`, `VERSION` | The pinned Markdown profile (GFM 0.29) and MD model version |
52
+ | `MEMBER_FIELD`, `SITE_FIELD`, `RECEIVED_FIELD` | The field names validation counts as declared beyond a type's own |
53
+
54
+ The full reference is in [`API.md`](API.md). The conformance corpus and its
55
+ verdict format and rule ids are described in [`fixtures/README.md`](fixtures/README.md).
56
+
57
+ ## License
58
+
59
+ MIT
@@ -0,0 +1,11 @@
1
+ import type { Extent } from './types.js';
2
+ export type HeadingLine = {
3
+ readonly level: number;
4
+ readonly name: string;
5
+ readonly start: number;
6
+ readonly textEnd: number;
7
+ readonly next: number;
8
+ };
9
+ export declare function headingLines(content: string, from: number, to: number): HeadingLine[];
10
+ export declare function blockRanges(content: string, from: number, to: number): Extent[];
11
+ //# sourceMappingURL=blocks.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../src/blocks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,CAAC;AAmCF,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW,EAAE,CAiBrF;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAe/E"}
package/dist/blocks.js ADDED
@@ -0,0 +1,62 @@
1
+ import { fenceSpans } from './links.js';
2
+ const HEADING = /^(#{1,6})(?!#)[ \t]+(.+?)[ \t]*#*[ \t]*$/;
3
+ function lineAt(content, from, to) {
4
+ const nl = content.indexOf('\n', from);
5
+ const end = nl === -1 || nl >= to ? to : nl;
6
+ const raw = content.slice(from, end);
7
+ return { text: raw.endsWith('\r') ? raw.slice(0, -1) : raw, next: end === to ? to : end + 1 };
8
+ }
9
+ function scan(content, from, to, visit) {
10
+ const fences = fenceSpans(content.slice(from, to));
11
+ let i = from;
12
+ while (i < to) {
13
+ const { text, next } = lineAt(content, i, to);
14
+ const at = i - from;
15
+ visit({
16
+ text,
17
+ start: i,
18
+ next,
19
+ fenced: fences.some(([start, end]) => at >= start && at < end),
20
+ });
21
+ if (next === i)
22
+ break;
23
+ i = next;
24
+ }
25
+ }
26
+ export function headingLines(content, from, to) {
27
+ const found = [];
28
+ scan(content, from, to, (line) => {
29
+ if (line.fenced)
30
+ return;
31
+ const match = HEADING.exec(line.text);
32
+ const hashes = match?.[1];
33
+ const name = match?.[2];
34
+ if (hashes === undefined || name === undefined)
35
+ return;
36
+ found.push({
37
+ level: hashes.length,
38
+ name: name.trim(),
39
+ start: line.start,
40
+ textEnd: line.start + line.text.length,
41
+ next: line.next,
42
+ });
43
+ });
44
+ return found;
45
+ }
46
+ export function blockRanges(content, from, to) {
47
+ const starts = [];
48
+ let open = false;
49
+ scan(content, from, to, (line) => {
50
+ if (!line.fenced && line.text.trim() === '') {
51
+ open = false;
52
+ return;
53
+ }
54
+ if (!open)
55
+ starts.push(line.start);
56
+ open = true;
57
+ });
58
+ return starts.map((start, index) => ({
59
+ start: index === 0 ? from : start,
60
+ end: starts[index + 1] ?? to,
61
+ }));
62
+ }