@brett_lamy/docstream 1.3.0 → 1.5.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 (228) hide show
  1. package/README.md +79 -5
  2. package/dist/assets.d.ts +3 -0
  3. package/dist/assets.d.ts.map +1 -0
  4. package/dist/assets.js +20 -0
  5. package/dist/assets.js.map +1 -0
  6. package/dist/demo/DemoViewer.d.ts +78 -0
  7. package/dist/demo/DemoViewer.d.ts.map +1 -0
  8. package/dist/demo/DemoViewer.js +467 -0
  9. package/dist/demo/DemoViewer.js.map +1 -0
  10. package/dist/demo/clipboard.d.ts +70 -0
  11. package/dist/demo/clipboard.d.ts.map +1 -0
  12. package/dist/demo/clipboard.js +187 -0
  13. package/dist/demo/clipboard.js.map +1 -0
  14. package/dist/demo/context.d.ts +20 -0
  15. package/dist/demo/context.d.ts.map +1 -0
  16. package/dist/demo/context.js +31 -0
  17. package/dist/demo/context.js.map +1 -0
  18. package/dist/demo/copy-demo.d.ts +23 -0
  19. package/dist/demo/copy-demo.d.ts.map +1 -0
  20. package/dist/demo/copy-demo.js +81 -0
  21. package/dist/demo/copy-demo.js.map +1 -0
  22. package/dist/demo/glob.d.ts +60 -0
  23. package/dist/demo/glob.d.ts.map +1 -0
  24. package/dist/demo/glob.js +158 -0
  25. package/dist/demo/glob.js.map +1 -0
  26. package/dist/demo/index.d.ts +16 -0
  27. package/dist/demo/index.d.ts.map +1 -0
  28. package/dist/demo/index.js +9 -0
  29. package/dist/demo/index.js.map +1 -0
  30. package/dist/demo/markdown.d.ts +60 -0
  31. package/dist/demo/markdown.d.ts.map +1 -0
  32. package/dist/demo/markdown.js +181 -0
  33. package/dist/demo/markdown.js.map +1 -0
  34. package/dist/demo/surface.d.ts +11 -0
  35. package/dist/demo/surface.d.ts.map +1 -0
  36. package/dist/demo/surface.js +69 -0
  37. package/dist/demo/surface.js.map +1 -0
  38. package/dist/demo/types.d.ts +91 -0
  39. package/dist/demo/types.d.ts.map +1 -0
  40. package/dist/demo/types.js +2 -0
  41. package/dist/demo/types.js.map +1 -0
  42. package/dist/demo/vfs.d.ts +51 -0
  43. package/dist/demo/vfs.d.ts.map +1 -0
  44. package/dist/demo/vfs.js +156 -0
  45. package/dist/demo/vfs.js.map +1 -0
  46. package/dist/docs/CollapsibleCode.d.ts +14 -0
  47. package/dist/docs/CollapsibleCode.d.ts.map +1 -0
  48. package/dist/docs/CollapsibleCode.js +19 -0
  49. package/dist/docs/CollapsibleCode.js.map +1 -0
  50. package/dist/docs/DocsRenderer.d.ts +55 -0
  51. package/dist/docs/DocsRenderer.d.ts.map +1 -0
  52. package/dist/docs/DocsRenderer.js +279 -0
  53. package/dist/docs/DocsRenderer.js.map +1 -0
  54. package/dist/docs/HighlightedCode.d.ts +6 -0
  55. package/dist/docs/HighlightedCode.d.ts.map +1 -0
  56. package/dist/docs/HighlightedCode.js +40 -0
  57. package/dist/docs/HighlightedCode.js.map +1 -0
  58. package/dist/docs/Mermaid.d.ts +7 -0
  59. package/dist/docs/Mermaid.d.ts.map +1 -0
  60. package/dist/docs/Mermaid.js +39 -0
  61. package/dist/docs/Mermaid.js.map +1 -0
  62. package/dist/docs/PageActions.d.ts +33 -0
  63. package/dist/docs/PageActions.d.ts.map +1 -0
  64. package/dist/docs/PageActions.js +115 -0
  65. package/dist/docs/PageActions.js.map +1 -0
  66. package/dist/docs/controls.d.ts +29 -0
  67. package/dist/docs/controls.d.ts.map +1 -0
  68. package/dist/docs/controls.js +46 -0
  69. package/dist/docs/controls.js.map +1 -0
  70. package/dist/docs/copy.d.ts +24 -0
  71. package/dist/docs/copy.d.ts.map +1 -0
  72. package/dist/docs/copy.js +62 -0
  73. package/dist/docs/copy.js.map +1 -0
  74. package/dist/docs/math.d.ts +3 -0
  75. package/dist/docs/math.d.ts.map +1 -0
  76. package/dist/docs/math.js +12 -0
  77. package/dist/docs/math.js.map +1 -0
  78. package/dist/docs/reference.d.ts +27 -0
  79. package/dist/docs/reference.d.ts.map +1 -0
  80. package/dist/docs/reference.js +73 -0
  81. package/dist/docs/reference.js.map +1 -0
  82. package/dist/docs/tabs-sync.d.ts +5 -0
  83. package/dist/docs/tabs-sync.d.ts.map +1 -0
  84. package/dist/docs/tabs-sync.js +58 -0
  85. package/dist/docs/tabs-sync.js.map +1 -0
  86. package/dist/gitbook/ast.d.ts +506 -0
  87. package/dist/gitbook/ast.d.ts.map +1 -0
  88. package/dist/gitbook/ast.js +8 -0
  89. package/dist/gitbook/ast.js.map +1 -0
  90. package/dist/gitbook/attrs.d.ts +14 -0
  91. package/dist/gitbook/attrs.d.ts.map +1 -0
  92. package/dist/gitbook/attrs.js +36 -0
  93. package/dist/gitbook/attrs.js.map +1 -0
  94. package/dist/gitbook/flatten.d.ts +14 -0
  95. package/dist/gitbook/flatten.d.ts.map +1 -0
  96. package/dist/gitbook/flatten.js +45 -0
  97. package/dist/gitbook/flatten.js.map +1 -0
  98. package/dist/gitbook/index.d.ts +10 -0
  99. package/dist/gitbook/index.d.ts.map +1 -0
  100. package/dist/gitbook/index.js +8 -0
  101. package/dist/gitbook/index.js.map +1 -0
  102. package/dist/gitbook/inline.d.ts +28 -0
  103. package/dist/gitbook/inline.d.ts.map +1 -0
  104. package/dist/gitbook/inline.js +956 -0
  105. package/dist/gitbook/inline.js.map +1 -0
  106. package/dist/gitbook/outline.d.ts +16 -0
  107. package/dist/gitbook/outline.d.ts.map +1 -0
  108. package/dist/gitbook/outline.js +44 -0
  109. package/dist/gitbook/outline.js.map +1 -0
  110. package/dist/gitbook/package-managers.d.ts +12 -0
  111. package/dist/gitbook/package-managers.d.ts.map +1 -0
  112. package/dist/gitbook/package-managers.js +93 -0
  113. package/dist/gitbook/package-managers.js.map +1 -0
  114. package/dist/gitbook/parse.d.ts +44 -0
  115. package/dist/gitbook/parse.d.ts.map +1 -0
  116. package/dist/gitbook/parse.js +1113 -0
  117. package/dist/gitbook/parse.js.map +1 -0
  118. package/dist/gitbook/serialize.d.ts +23 -0
  119. package/dist/gitbook/serialize.d.ts.map +1 -0
  120. package/dist/gitbook/serialize.js +498 -0
  121. package/dist/gitbook/serialize.js.map +1 -0
  122. package/dist/index.d.ts +34 -0
  123. package/dist/index.d.ts.map +1 -0
  124. package/dist/index.js +24 -0
  125. package/dist/index.js.map +1 -0
  126. package/dist/openapi/OpenApiOperation.d.ts +6 -0
  127. package/dist/openapi/OpenApiOperation.d.ts.map +1 -0
  128. package/dist/openapi/OpenApiOperation.js +112 -0
  129. package/dist/openapi/OpenApiOperation.js.map +1 -0
  130. package/dist/playground/InlineDemoPreview.d.ts +24 -0
  131. package/dist/playground/InlineDemoPreview.d.ts.map +1 -0
  132. package/dist/playground/InlineDemoPreview.js +48 -0
  133. package/dist/playground/InlineDemoPreview.js.map +1 -0
  134. package/dist/playground/PlaygroundStreamdown.d.ts +16 -0
  135. package/dist/playground/PlaygroundStreamdown.d.ts.map +1 -0
  136. package/dist/playground/PlaygroundStreamdown.js +22 -0
  137. package/dist/playground/PlaygroundStreamdown.js.map +1 -0
  138. package/dist/playground/ReactCodePreview.d.ts +64 -0
  139. package/dist/playground/ReactCodePreview.d.ts.map +1 -0
  140. package/dist/playground/ReactCodePreview.js +108 -0
  141. package/dist/playground/ReactCodePreview.js.map +1 -0
  142. package/dist/playground/filesystem.d.ts +27 -0
  143. package/dist/playground/filesystem.d.ts.map +1 -0
  144. package/dist/playground/filesystem.js +65 -0
  145. package/dist/playground/filesystem.js.map +1 -0
  146. package/dist/playground/index.d.ts +9 -0
  147. package/dist/playground/index.d.ts.map +1 -0
  148. package/dist/playground/index.js +7 -0
  149. package/dist/playground/index.js.map +1 -0
  150. package/dist/playground/project.d.ts +57 -0
  151. package/dist/playground/project.d.ts.map +1 -0
  152. package/dist/playground/project.js +137 -0
  153. package/dist/playground/project.js.map +1 -0
  154. package/dist/replay/NativeReplay.d.ts +9 -0
  155. package/dist/replay/NativeReplay.d.ts.map +1 -0
  156. package/dist/replay/NativeReplay.js +173 -0
  157. package/dist/replay/NativeReplay.js.map +1 -0
  158. package/dist/replay/ReplayPreview.d.ts +33 -0
  159. package/dist/replay/ReplayPreview.d.ts.map +1 -0
  160. package/dist/replay/ReplayPreview.js +91 -0
  161. package/dist/replay/ReplayPreview.js.map +1 -0
  162. package/dist/replay/index.d.ts +5 -0
  163. package/dist/replay/index.d.ts.map +1 -0
  164. package/dist/replay/index.js +4 -0
  165. package/dist/replay/index.js.map +1 -0
  166. package/dist/replay/sanitize.d.ts +4 -0
  167. package/dist/replay/sanitize.d.ts.map +1 -0
  168. package/dist/replay/sanitize.js +86 -0
  169. package/dist/replay/sanitize.js.map +1 -0
  170. package/dist/replay/url.d.ts +8 -0
  171. package/dist/replay/url.d.ts.map +1 -0
  172. package/dist/replay/url.js +41 -0
  173. package/dist/replay/url.js.map +1 -0
  174. package/dist/source/SourcePreview.d.ts +13 -0
  175. package/dist/source/SourcePreview.d.ts.map +1 -0
  176. package/dist/source/SourcePreview.js +47 -0
  177. package/dist/source/SourcePreview.js.map +1 -0
  178. package/dist/source/client.d.ts +7 -0
  179. package/dist/source/client.d.ts.map +1 -0
  180. package/dist/source/client.js +52 -0
  181. package/dist/source/client.js.map +1 -0
  182. package/dist/source/index.d.ts +6 -0
  183. package/dist/source/index.d.ts.map +1 -0
  184. package/dist/source/index.js +3 -0
  185. package/dist/source/index.js.map +1 -0
  186. package/dist/source/types.d.ts +33 -0
  187. package/dist/source/types.d.ts.map +1 -0
  188. package/dist/source/types.js +2 -0
  189. package/dist/source/types.js.map +1 -0
  190. package/dist/streamdown.d.ts +19 -0
  191. package/dist/streamdown.d.ts.map +1 -0
  192. package/dist/streamdown.js +15 -0
  193. package/dist/streamdown.js.map +1 -0
  194. package/dist/styles.css +2441 -0
  195. package/dist/video/VideoEmbed.d.ts +17 -0
  196. package/dist/video/VideoEmbed.d.ts.map +1 -0
  197. package/dist/video/VideoEmbed.js +12 -0
  198. package/dist/video/VideoEmbed.js.map +1 -0
  199. package/dist/video/index.d.ts +3 -0
  200. package/dist/video/index.d.ts.map +1 -0
  201. package/dist/video/index.js +2 -0
  202. package/dist/video/index.js.map +1 -0
  203. package/dist/vite/index.d.ts +21 -0
  204. package/dist/vite/index.d.ts.map +1 -0
  205. package/dist/vite/index.js +137 -0
  206. package/dist/vite/index.js.map +1 -0
  207. package/dist/viz/VizEmbed.d.ts +18 -0
  208. package/dist/viz/VizEmbed.d.ts.map +1 -0
  209. package/dist/viz/VizEmbed.js +12 -0
  210. package/dist/viz/VizEmbed.js.map +1 -0
  211. package/dist/viz/index.d.ts +4 -0
  212. package/dist/viz/index.d.ts.map +1 -0
  213. package/dist/viz/index.js +3 -0
  214. package/dist/viz/index.js.map +1 -0
  215. package/package.json +65 -32
  216. package/src/demo/DemoViewer.tsx +56 -11
  217. package/src/demo/clipboard.ts +228 -0
  218. package/src/demo/context.ts +7 -0
  219. package/src/demo/copy-demo.tsx +102 -0
  220. package/src/demo/index.ts +29 -2
  221. package/src/demo/vfs.ts +197 -0
  222. package/src/docs/DocsRenderer.tsx +13 -4
  223. package/src/docs/Mermaid.tsx +5 -3
  224. package/src/index.ts +19 -0
  225. package/src/replay/ReplayPreview.tsx +0 -1
  226. package/src/streamdown.tsx +2 -0
  227. package/src/styles.css +91 -0
  228. package/src/replay/styles.css +0 -87
package/src/index.ts CHANGED
@@ -16,7 +16,21 @@ export {
16
16
  DemoViewer,
17
17
  DocstreamDemoContext,
18
18
  DocstreamDemoRuntimeContext,
19
+ DocstreamDemoVFSContext,
20
+ DOCSTREAM_CLIPBOARD_TYPE,
21
+ CopyDemoButton,
22
+ createDemoVFS,
23
+ createDocstreamClipboard,
24
+ createDocstreamClipboardFromMarkdown,
19
25
  createGlobDemoResolver,
26
+ docstreamClipboardItems,
27
+ parseDocstreamClipboard,
28
+ peekDemoSource,
29
+ prefetchDemoSources,
30
+ readDocstreamClipboard,
31
+ readDocstreamClipboardItems,
32
+ useDemoVFS,
33
+ useDemoVFSFiles,
20
34
  defaultDemoMarkdown,
21
35
  inlineDemoMarkdown,
22
36
  inlineDemoNode,
@@ -41,6 +55,11 @@ export type {
41
55
  DemoRuntimeOptions,
42
56
  DemoVariant,
43
57
  DemoViewerProps,
58
+ DemoVFS,
59
+ DemoVFSChange,
60
+ DemoVFSEntry,
61
+ DocstreamClipboard,
62
+ DocstreamClipboardPayload,
44
63
  GlobDemoResolverOptions,
45
64
  InlineDemoRuntime,
46
65
  InlineDemoRuntimeProps,
@@ -1,7 +1,6 @@
1
1
  import { Suspense, lazy, useEffect, useState } from 'react';
2
2
  import type { eventWithTime } from 'rrweb';
3
3
  import { normalizeReplayEmbedUrl } from './url';
4
- import './styles.css';
5
4
 
6
5
  export interface ReplayPageSource {
7
6
  kind: 'url';
@@ -33,6 +33,7 @@ export function GitbookStreamdown({
33
33
  demoResolver,
34
34
  demoRuntime,
35
35
  demoDependencies,
36
+ demoVFS,
36
37
  pageActions,
37
38
  }: GitbookStreamdownProps) {
38
39
  const content = markdown ?? children ?? ""
@@ -56,6 +57,7 @@ export function GitbookStreamdown({
56
57
  demoResolver={demoResolver}
57
58
  demoRuntime={demoRuntime}
58
59
  demoDependencies={demoDependencies}
60
+ demoVFS={demoVFS}
59
61
  pageActions={isStreaming ? false : pageActions}
60
62
  />
61
63
  </div>
package/src/styles.css CHANGED
@@ -2343,6 +2343,97 @@
2343
2343
  }
2344
2344
  }
2345
2345
 
2346
+ /* Replay embeds (ReplayPreview / ReplayEmbed). Part of the one package stylesheet so no
2347
+ module imports CSS on the eager path: the root entry stays importable from Node
2348
+ (SSR, vitest) without a CSS loader. */
2349
+ .replay-preview {
2350
+ width: 100%;
2351
+ min-width: 0;
2352
+ color: var(--replay-preview-fg, #e5e7eb);
2353
+ background: var(--replay-preview-bg, #0f172a);
2354
+ border: 1px solid var(--replay-preview-border, rgba(148, 163, 184, 0.28));
2355
+ border-radius: 12px;
2356
+ overflow: hidden;
2357
+ }
2358
+
2359
+ .replay-preview__frame {
2360
+ display: block;
2361
+ width: 100%;
2362
+ aspect-ratio: 16 / 9;
2363
+ border: 0;
2364
+ background: #0f172a;
2365
+ }
2366
+
2367
+ .replay-preview__invalid,
2368
+ .replay-preview__empty,
2369
+ .replay-preview__error {
2370
+ display: flex;
2371
+ align-items: center;
2372
+ justify-content: center;
2373
+ min-height: 140px;
2374
+ padding: 20px;
2375
+ color: var(--replay-preview-muted, #94a3b8);
2376
+ font: 13px/1.5 ui-sans-serif, system-ui, sans-serif;
2377
+ text-align: center;
2378
+ }
2379
+
2380
+ .replay-preview__invalid {
2381
+ color: var(--replay-preview-link, #7dd3fc);
2382
+ }
2383
+
2384
+ .replay-preview__error {
2385
+ color: #fda4af;
2386
+ }
2387
+
2388
+ .replay-preview__native {
2389
+ width: 100%;
2390
+ background: #0f172a;
2391
+ }
2392
+
2393
+ .replay-preview__stage {
2394
+ position: relative;
2395
+ width: 100%;
2396
+ min-height: 160px;
2397
+ overflow: hidden;
2398
+ background: #020617;
2399
+ }
2400
+
2401
+ .replay-preview__scaler {
2402
+ position: absolute;
2403
+ inset: 0 auto auto 0;
2404
+ }
2405
+
2406
+ .replay-preview__player {
2407
+ position: relative;
2408
+ overflow: hidden;
2409
+ }
2410
+
2411
+ .replay-preview__controls {
2412
+ display: flex;
2413
+ align-items: center;
2414
+ gap: 8px;
2415
+ padding: 8px 10px;
2416
+ border-top: 1px solid rgba(148, 163, 184, 0.2);
2417
+ background: #111827;
2418
+ font: 12px/1.2 ui-sans-serif, system-ui, sans-serif;
2419
+ }
2420
+
2421
+ .replay-preview__controls button,
2422
+ .replay-preview__controls select {
2423
+ border: 1px solid rgba(148, 163, 184, 0.3);
2424
+ border-radius: 6px;
2425
+ padding: 5px 8px;
2426
+ color: inherit;
2427
+ background: #1e293b;
2428
+ cursor: pointer;
2429
+ }
2430
+
2431
+ .replay-preview__controls input[type='range'] {
2432
+ min-width: 60px;
2433
+ flex: 1;
2434
+ accent-color: #38bdf8;
2435
+ }
2436
+
2346
2437
  /* Keep every rendered table variant flush, after the shared block spacing rules. */
2347
2438
  :is([data-docstream], .docs-article) [data-docstream-blocks] > :is(.docs-table, table, .docs-cards) {
2348
2439
  margin-block-start: 0;
@@ -1,87 +0,0 @@
1
- .replay-preview {
2
- width: 100%;
3
- min-width: 0;
4
- color: var(--replay-preview-fg, #e5e7eb);
5
- background: var(--replay-preview-bg, #0f172a);
6
- border: 1px solid var(--replay-preview-border, rgba(148, 163, 184, 0.28));
7
- border-radius: 12px;
8
- overflow: hidden;
9
- }
10
-
11
- .replay-preview__frame {
12
- display: block;
13
- width: 100%;
14
- aspect-ratio: 16 / 9;
15
- border: 0;
16
- background: #0f172a;
17
- }
18
-
19
- .replay-preview__invalid,
20
- .replay-preview__empty,
21
- .replay-preview__error {
22
- display: flex;
23
- align-items: center;
24
- justify-content: center;
25
- min-height: 140px;
26
- padding: 20px;
27
- color: var(--replay-preview-muted, #94a3b8);
28
- font: 13px/1.5 ui-sans-serif, system-ui, sans-serif;
29
- text-align: center;
30
- }
31
-
32
- .replay-preview__invalid {
33
- color: var(--replay-preview-link, #7dd3fc);
34
- }
35
-
36
- .replay-preview__error {
37
- color: #fda4af;
38
- }
39
-
40
- .replay-preview__native {
41
- width: 100%;
42
- background: #0f172a;
43
- }
44
-
45
- .replay-preview__stage {
46
- position: relative;
47
- width: 100%;
48
- min-height: 160px;
49
- overflow: hidden;
50
- background: #020617;
51
- }
52
-
53
- .replay-preview__scaler {
54
- position: absolute;
55
- inset: 0 auto auto 0;
56
- }
57
-
58
- .replay-preview__player {
59
- position: relative;
60
- overflow: hidden;
61
- }
62
-
63
- .replay-preview__controls {
64
- display: flex;
65
- align-items: center;
66
- gap: 8px;
67
- padding: 8px 10px;
68
- border-top: 1px solid rgba(148, 163, 184, 0.2);
69
- background: #111827;
70
- font: 12px/1.2 ui-sans-serif, system-ui, sans-serif;
71
- }
72
-
73
- .replay-preview__controls button,
74
- .replay-preview__controls select {
75
- border: 1px solid rgba(148, 163, 184, 0.3);
76
- border-radius: 6px;
77
- padding: 5px 8px;
78
- color: inherit;
79
- background: #1e293b;
80
- cursor: pointer;
81
- }
82
-
83
- .replay-preview__controls input[type='range'] {
84
- min-width: 60px;
85
- flex: 1;
86
- accent-color: #38bdf8;
87
- }