@cudoment/cudoc 0.1.0 → 0.3.0

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 (101) hide show
  1. package/README.md +20 -47
  2. package/dist/dataset.d.ts +10 -0
  3. package/dist/dataset.d.ts.map +1 -0
  4. package/dist/dataset.js +44 -0
  5. package/dist/dataset.js.map +1 -0
  6. package/dist/document.d.ts +80 -0
  7. package/dist/document.d.ts.map +1 -0
  8. package/dist/document.js +436 -0
  9. package/dist/document.js.map +1 -0
  10. package/dist/internal/core/ast/validate.d.ts.map +1 -1
  11. package/dist/internal/core/ast/validate.js +9 -2
  12. package/dist/internal/core/ast/validate.js.map +1 -1
  13. package/dist/internal/core/query/nodes.d.ts.map +1 -1
  14. package/dist/internal/core/query/nodes.js +3 -1
  15. package/dist/internal/core/query/nodes.js.map +1 -1
  16. package/dist/internal/core/query/sections.d.ts.map +1 -1
  17. package/dist/internal/core/query/sections.js +2 -1
  18. package/dist/internal/core/query/sections.js.map +1 -1
  19. package/dist/internal/core/syntax/heading-metadata.js +1 -1
  20. package/dist/internal/core/syntax/heading-metadata.js.map +1 -1
  21. package/dist/internal/transforms/table-cell-list/build-table-cell-children.d.ts +5 -0
  22. package/dist/internal/transforms/table-cell-list/build-table-cell-children.d.ts.map +1 -0
  23. package/dist/internal/transforms/table-cell-list/build-table-cell-children.js +169 -0
  24. package/dist/internal/transforms/table-cell-list/build-table-cell-children.js.map +1 -0
  25. package/dist/internal/transforms/table-cell-list/elements.d.ts +15 -0
  26. package/dist/internal/transforms/table-cell-list/elements.d.ts.map +1 -0
  27. package/dist/internal/transforms/table-cell-list/elements.js +16 -0
  28. package/dist/internal/transforms/table-cell-list/elements.js.map +1 -0
  29. package/dist/internal/transforms/table-cell-list/index.d.ts +18 -0
  30. package/dist/internal/transforms/table-cell-list/index.d.ts.map +1 -0
  31. package/dist/internal/transforms/table-cell-list/index.js +45 -0
  32. package/dist/internal/transforms/table-cell-list/index.js.map +1 -0
  33. package/dist/internal/transforms/table-cell-list/nodes.d.ts +9 -0
  34. package/dist/internal/transforms/table-cell-list/nodes.d.ts.map +1 -0
  35. package/dist/internal/transforms/table-cell-list/nodes.js +24 -0
  36. package/dist/internal/transforms/table-cell-list/nodes.js.map +1 -0
  37. package/dist/internal/transforms/table-cell-list/parse-inline-markdown.d.ts +6 -0
  38. package/dist/internal/transforms/table-cell-list/parse-inline-markdown.d.ts.map +1 -0
  39. package/dist/internal/transforms/table-cell-list/parse-inline-markdown.js +101 -0
  40. package/dist/internal/transforms/table-cell-list/parse-inline-markdown.js.map +1 -0
  41. package/dist/internal/transforms/table-cell-list/parse-table-cell-list.d.ts +22 -0
  42. package/dist/internal/transforms/table-cell-list/parse-table-cell-list.d.ts.map +1 -0
  43. package/dist/internal/transforms/table-cell-list/parse-table-cell-list.js +315 -0
  44. package/dist/internal/transforms/table-cell-list/parse-table-cell-list.js.map +1 -0
  45. package/dist/internal/transforms/table-column-layout/create-table.d.ts +45 -0
  46. package/dist/internal/transforms/table-column-layout/create-table.d.ts.map +1 -0
  47. package/dist/internal/transforms/table-column-layout/create-table.js +121 -0
  48. package/dist/internal/transforms/table-column-layout/create-table.js.map +1 -0
  49. package/dist/internal/transforms/table-column-layout/index.d.ts +51 -0
  50. package/dist/internal/transforms/table-column-layout/index.d.ts.map +1 -0
  51. package/dist/internal/transforms/table-column-layout/index.js +100 -0
  52. package/dist/internal/transforms/table-column-layout/index.js.map +1 -0
  53. package/dist/internal/transforms/table-column-layout/split-cell.d.ts +24 -0
  54. package/dist/internal/transforms/table-column-layout/split-cell.d.ts.map +1 -0
  55. package/dist/internal/transforms/table-column-layout/split-cell.js +219 -0
  56. package/dist/internal/transforms/table-column-layout/split-cell.js.map +1 -0
  57. package/dist/markdown.d.ts +10 -0
  58. package/dist/markdown.d.ts.map +1 -0
  59. package/dist/markdown.js +47 -0
  60. package/dist/markdown.js.map +1 -0
  61. package/dist/node/cli.d.ts +3 -0
  62. package/dist/node/cli.d.ts.map +1 -0
  63. package/dist/node/cli.js +37 -0
  64. package/dist/node/cli.js.map +1 -0
  65. package/dist/node/dataset.d.ts +19 -0
  66. package/dist/node/dataset.d.ts.map +1 -0
  67. package/dist/node/dataset.js +51 -0
  68. package/dist/node/dataset.js.map +1 -0
  69. package/dist/node/library.d.ts +56 -0
  70. package/dist/node/library.d.ts.map +1 -0
  71. package/dist/node/library.js +163 -0
  72. package/dist/node/library.js.map +1 -0
  73. package/dist/node/paths.d.ts.map +1 -1
  74. package/dist/node/paths.js +1 -1
  75. package/dist/node/paths.js.map +1 -1
  76. package/dist/node/prepare-embeds.d.ts +13 -0
  77. package/dist/node/prepare-embeds.d.ts.map +1 -0
  78. package/dist/node/prepare-embeds.js +54 -0
  79. package/dist/node/prepare-embeds.js.map +1 -0
  80. package/dist/node/resolve-embed.d.ts +33 -0
  81. package/dist/node/resolve-embed.d.ts.map +1 -0
  82. package/dist/node/resolve-embed.js +386 -0
  83. package/dist/node/resolve-embed.js.map +1 -0
  84. package/dist/node/storage.d.ts +10 -0
  85. package/dist/node/storage.d.ts.map +1 -0
  86. package/dist/node/storage.js +85 -0
  87. package/dist/node/storage.js.map +1 -0
  88. package/dist/query.d.ts +1 -0
  89. package/dist/query.d.ts.map +1 -1
  90. package/dist/query.js +1 -0
  91. package/dist/query.js.map +1 -1
  92. package/dist/render.d.ts +11 -0
  93. package/dist/render.d.ts.map +1 -0
  94. package/dist/render.js +63 -0
  95. package/dist/render.js.map +1 -0
  96. package/dist/sections.d.ts +15 -0
  97. package/dist/sections.d.ts.map +1 -0
  98. package/dist/sections.js +40 -0
  99. package/dist/sections.js.map +1 -0
  100. package/package.json +66 -5
  101. package/styles.css +90 -0
@@ -0,0 +1,15 @@
1
+ import type { Heading, Root } from "mdast";
2
+ export type SectionSelection = {
3
+ anchors?: string[];
4
+ titles?: string[];
5
+ depth?: number | number[];
6
+ includeChildren?: boolean;
7
+ };
8
+ export type CollectedSection = {
9
+ anchorId: string;
10
+ title: string;
11
+ tree: Root;
12
+ heading: Heading;
13
+ };
14
+ export declare function collectSections(tree: Root, select?: SectionSelection): CollectedSection[];
15
+ //# sourceMappingURL=sections.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sections.d.ts","sourceRoot":"","sources":["../src/sections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAS1C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AACD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,IAAI,CAAA;IACV,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,wBAAgB,eAAe,CAC7B,IAAI,EAAE,IAAI,EACV,MAAM,GAAE,gBAAqB,GAC5B,gBAAgB,EAAE,CA8CpB"}
@@ -0,0 +1,40 @@
1
+ import { visit } from "unist-util-visit";
2
+ import { getHeadingAnchorId, sliceSectionByAnchorId, } from "./internal/core/query/sections.js";
3
+ import { getNodeText } from "./internal/core/query/nodes.js";
4
+ export function collectSections(tree, select = {}) {
5
+ const result = [];
6
+ const depths = select.depth === undefined
7
+ ? undefined
8
+ : Array.isArray(select.depth)
9
+ ? select.depth
10
+ : [select.depth];
11
+ if (depths?.some((d) => !Number.isInteger(d) || d < 1 || d > 6))
12
+ throw new TypeError("cudoc: section depth must be 1-6");
13
+ visit(tree, "heading", (heading) => {
14
+ const anchorId = getHeadingAnchorId(heading);
15
+ const title = getNodeText(heading.children.filter((n) => !["badge", "permalink"].includes(n.data?.cudoc?.kind ?? ""))).trim();
16
+ if (!anchorId ||
17
+ (select.anchors &&
18
+ !select.anchors.map((id) => id.replace(/^#/, "")).includes(anchorId)) ||
19
+ (select.titles && !select.titles.includes(title)) ||
20
+ (depths && !depths.includes(heading.depth)))
21
+ return;
22
+ const section = structuredClone(sliceSectionByAnchorId(tree, anchorId));
23
+ if (select.includeChildren === false) {
24
+ const end = section.children.findIndex((n, i) => i > 0 && n.type === "heading");
25
+ if (end >= 0)
26
+ section.children = [
27
+ ...section.children.slice(0, end),
28
+ ...section.children
29
+ .slice(end)
30
+ .filter((n) => n.type === "definition" || n.type === "footnoteDefinition"),
31
+ ];
32
+ }
33
+ result.push({ anchorId, title, tree: section, heading });
34
+ });
35
+ for (const id of select.anchors ?? [])
36
+ if (!result.some((s) => s.anchorId === id.replace(/^#/, "")))
37
+ throw new Error(`cudoc: missing section: ${id}`);
38
+ return result;
39
+ }
40
+ //# sourceMappingURL=sections.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sections.js","sourceRoot":"","sources":["../src/sections.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACxC,OAAO,EACL,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAA;AAgB5D,MAAM,UAAU,eAAe,CAC7B,IAAU,EACV,SAA2B,EAAE;IAE7B,MAAM,MAAM,GAAuB,EAAE,CAAA;IACrC,MAAM,MAAM,GACV,MAAM,CAAC,KAAK,KAAK,SAAS;QACxB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;YAC3B,CAAC,CAAC,MAAM,CAAC,KAAK;YACd,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACtB,IAAI,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7D,MAAM,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAAA;IACzD,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;QACjC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;QAC5C,MAAM,KAAK,GAAG,WAAW,CACtB,OAAO,CAAC,QAAsC,CAAC,MAAM,CACpD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,IAAI,EAAE,CAAC,CAC5C,CACzB,CAAC,IAAI,EAAE,CAAA;QACR,IACE,CAAC,QAAQ;YACT,CAAC,MAAM,CAAC,OAAO;gBACb,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACvE,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACjD,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAE3C,OAAM;QACR,MAAM,OAAO,GAAG,eAAe,CAAC,sBAAsB,CAAC,IAAI,EAAE,QAAQ,CAAE,CAAC,CAAA;QACxE,IAAI,MAAM,CAAC,eAAe,KAAK,KAAK,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS,CACpC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CACxC,CAAA;YACD,IAAI,GAAG,IAAI,CAAC;gBACV,OAAO,CAAC,QAAQ,GAAG;oBACjB,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;oBACjC,GAAG,OAAO,CAAC,QAAQ;yBAChB,KAAK,CAAC,GAAG,CAAC;yBACV,MAAM,CACL,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,IAAI,KAAK,oBAAoB,CAClE;iBACJ,CAAA;QACL,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;IAC1D,CAAC,CAAC,CAAA;IACF,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,OAAO,IAAI,EAAE;QACnC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1D,MAAM,IAAI,KAAK,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAA;IACpD,OAAO,MAAM,CAAA;AACf,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cudoment/cudoc",
3
- "version": "0.1.0",
3
+ "version": "0.3.0",
4
4
  "description": "Reusable document ASTs: validation, queries, export and loading for cross-document embedding.",
5
5
  "keywords": [
6
6
  "cudoc",
@@ -63,12 +63,58 @@
63
63
  "./node/paths": {
64
64
  "types": "./dist/node/paths.d.ts",
65
65
  "default": "./dist/node/paths.js"
66
- }
66
+ },
67
+ "./transforms/*": {
68
+ "types": "./dist/internal/transforms/*.d.ts",
69
+ "default": "./dist/internal/transforms/*.js"
70
+ },
71
+ "./document": {
72
+ "types": "./dist/document.d.ts",
73
+ "default": "./dist/document.js"
74
+ },
75
+ "./markdown": {
76
+ "types": "./dist/markdown.d.ts",
77
+ "default": "./dist/markdown.js"
78
+ },
79
+ "./render": {
80
+ "types": "./dist/render.d.ts",
81
+ "default": "./dist/render.js"
82
+ },
83
+ "./sections": {
84
+ "types": "./dist/sections.d.ts",
85
+ "default": "./dist/sections.js"
86
+ },
87
+ "./dataset": {
88
+ "types": "./dist/dataset.d.ts",
89
+ "default": "./dist/dataset.js"
90
+ },
91
+ "./node/library": {
92
+ "types": "./dist/node/library.d.ts",
93
+ "default": "./dist/node/library.js"
94
+ },
95
+ "./node/dataset": {
96
+ "types": "./dist/node/dataset.d.ts",
97
+ "default": "./dist/node/dataset.js"
98
+ },
99
+ "./node/resolve-embed": {
100
+ "types": "./dist/node/resolve-embed.d.ts",
101
+ "default": "./dist/node/resolve-embed.js"
102
+ },
103
+ "./node/storage": {
104
+ "types": "./dist/node/storage.d.ts",
105
+ "default": "./dist/node/storage.js"
106
+ },
107
+ "./node/prepare-embeds": {
108
+ "types": "./dist/node/prepare-embeds.d.ts",
109
+ "default": "./dist/node/prepare-embeds.js"
110
+ },
111
+ "./styles.css": "./styles.css"
67
112
  },
68
113
  "files": [
69
114
  "dist",
70
115
  "README.md",
71
- "LICENSE"
116
+ "LICENSE",
117
+ "styles.css"
72
118
  ],
73
119
  "engines": {
74
120
  "node": ">=20"
@@ -78,10 +124,22 @@
78
124
  "clean": "rm -rf dist *.tsbuildinfo"
79
125
  },
80
126
  "dependencies": {
127
+ "@mdx-js/mdx": "^3.1.1",
128
+ "estree-util-value-to-estree": "^3.5.0",
129
+ "github-slugger": "^2.0.0",
130
+ "hast-util-from-html": "^2.0.3",
131
+ "hast-util-to-html": "^9.0.5",
81
132
  "mdast-util-mdx-jsx": "^3.2.0",
82
- "unist-util-visit": "^5.0.0",
133
+ "mdast-util-to-hast": "^13.2.1",
134
+ "remark-directive": "^4.0.0",
135
+ "remark-frontmatter": "^5.0.0",
136
+ "remark-gfm": "^4.0.1",
137
+ "remark-mdx": "^3.1.1",
138
+ "remark-parse": "^11.0.0",
83
139
  "unified": "^11.0.5",
84
- "vfile": "^6.0.3"
140
+ "unist-util-visit": "^5.0.0",
141
+ "vfile": "^6.0.3",
142
+ "yaml": "^2.9.0"
85
143
  },
86
144
  "peerDependencies": {
87
145
  "@types/mdast": "^4.0.4"
@@ -90,5 +148,8 @@
90
148
  "@types/mdast": {
91
149
  "optional": true
92
150
  }
151
+ },
152
+ "bin": {
153
+ "cudoc": "./dist/node/cli.js"
93
154
  }
94
155
  }
package/styles.css ADDED
@@ -0,0 +1,90 @@
1
+ /**
2
+ * Callout, badge and embed styles for a host site.
3
+ *
4
+ * This stylesheet lives inside someone else's page, so its properties are
5
+ * namespaced and it never sets a text colour: the body colour is inherited from
6
+ * the host's own theme. Only the surfaces and accents flip, which keeps the
7
+ * components readable whether the host renders light or dark.
8
+ *
9
+ * Three theme signals are honoured, because a host may follow the system
10
+ * setting or expose its own toggle: `prefers-color-scheme`, a `dark`/`light`
11
+ * class (VitePress, Nextra) and `data-theme` (Docusaurus).
12
+ */
13
+ :root {
14
+ --cudoc-wash: #f1f5f9;
15
+ --cudoc-line: #e2e8f0;
16
+ --cudoc-accent: #1d4ed8;
17
+ --cudoc-accent-soft: #dbeafe;
18
+ --cudoc-warn: #b45309;
19
+ --cudoc-warn-wash: #fef6e7;
20
+ --cudoc-danger: #b91c1c;
21
+ --cudoc-danger-wash: #fdeeee;
22
+ }
23
+ @media (prefers-color-scheme: dark) {
24
+ :root:not(.light):not([data-theme="light"]) {
25
+ --cudoc-wash: #1b2336;
26
+ --cudoc-line: #334155;
27
+ --cudoc-accent: #7cb0fb;
28
+ --cudoc-accent-soft: #1e3252;
29
+ --cudoc-warn: #fbbf24;
30
+ --cudoc-warn-wash: #2b2110;
31
+ --cudoc-danger: #f87171;
32
+ --cudoc-danger-wash: #2c1618;
33
+ }
34
+ }
35
+ :root.dark,
36
+ :root[data-theme="dark"] {
37
+ --cudoc-wash: #1b2336;
38
+ --cudoc-line: #334155;
39
+ --cudoc-accent: #7cb0fb;
40
+ --cudoc-accent-soft: #1e3252;
41
+ --cudoc-warn: #fbbf24;
42
+ --cudoc-warn-wash: #2b2110;
43
+ --cudoc-danger: #f87171;
44
+ --cudoc-danger-wash: #2c1618;
45
+ }
46
+
47
+ .cudoc-badge {
48
+ display: inline-block;
49
+ margin-left: 0.35em;
50
+ padding: 0.1em 0.5em;
51
+ border-radius: 0.75em;
52
+ background: var(--cudoc-accent-soft);
53
+ color: var(--cudoc-accent);
54
+ font-size: 0.8em;
55
+ font-weight: 600;
56
+ white-space: nowrap;
57
+ vertical-align: 0.08em;
58
+ }
59
+ .cudoc-callout {
60
+ margin: 1.5rem 0;
61
+ padding: 0.75rem 1rem;
62
+ border: 1px solid var(--cudoc-line);
63
+ border-left: 3px solid var(--cudoc-accent);
64
+ border-radius: 0.375rem;
65
+ background: var(--cudoc-wash);
66
+ }
67
+ .cudoc-callout > :first-child {
68
+ margin-top: 0;
69
+ }
70
+ .cudoc-callout > :last-child {
71
+ margin-bottom: 0;
72
+ }
73
+ .cudoc-callout-title {
74
+ display: block;
75
+ margin-bottom: 0.25rem;
76
+ font-weight: 700;
77
+ }
78
+ .cudoc-callout-warning,
79
+ .cudoc-callout-caution {
80
+ border-left-color: var(--cudoc-warn);
81
+ background: var(--cudoc-warn-wash);
82
+ }
83
+ .cudoc-callout-danger,
84
+ .cudoc-callout-error {
85
+ border-left-color: var(--cudoc-danger);
86
+ background: var(--cudoc-danger-wash);
87
+ }
88
+ .cudoc-embed {
89
+ min-width: 0;
90
+ }