stream-mdx 0.2.0 → 0.4.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 (8) hide show
  1. package/README.md +14 -6
  2. package/dist/core.d.cts +2 -2
  3. package/dist/core.d.ts +2 -2
  4. package/dist/worker/direct.cjs +30 -0
  5. package/dist/worker/direct.d.cts +1 -0
  6. package/dist/worker/direct.d.ts +1 -0
  7. package/dist/worker/direct.mjs +7 -0
  8. package/package.json +10 -5
package/README.md CHANGED
@@ -101,6 +101,7 @@ Scoped equivalents:
101
101
 
102
102
  - `@stream-mdx/mermaid` (optional Mermaid diagram renderer)
103
103
  - `@stream-mdx/theme-tailwind` (optional Tailwind theme CSS)
104
+ - `@stream-mdx/tui` + `@stream-mdx/protocol` (terminal/CLI helpers)
104
105
 
105
106
  Example:
106
107
 
@@ -111,17 +112,24 @@ import { MermaidBlock } from "@stream-mdx/mermaid";
111
112
  <StreamingMarkdown text={content} components={{ mermaid: MermaidBlock }} />;
112
113
  ```
113
114
 
115
+ ## Terminal / TUI
116
+
117
+ If you're building a terminal UI, use:
118
+
119
+ - `@stream-mdx/protocol` for stable event/type contracts
120
+ - `@stream-mdx/tui` for NDJSON helpers and a snapshot store for applying patches
121
+
114
122
  ## Docs
115
123
 
116
124
  - Docs site: https://kmccleary3301.github.io/stream-mdx/
117
125
  - Live demo: https://kmccleary3301.github.io/stream-mdx/demo
118
126
  - Showcase: https://kmccleary3301.github.io/stream-mdx/showcase
119
- - Manual: `docs/COMPREHENSIVE_PROJECT_DOCUMENTATION.md`
120
- - API: `docs/PUBLIC_API.md`
121
- - React integration: `docs/REACT_INTEGRATION_GUIDE.md`
122
- - Plugins cookbook: `docs/STREAMING_MARKDOWN_PLUGINS_COOKBOOK.md`
123
- - Status/architecture notes: `docs/STREAMING_MARKDOWN_V2_STATUS.md`
124
- - Release checklist: `docs/STREAMING_MARKDOWN_RELEASE_CHECKLIST.md`
127
+ - Manual: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/COMPREHENSIVE_PROJECT_DOCUMENTATION.md
128
+ - Public API: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/PUBLIC_API.md
129
+ - React integration: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/REACT_INTEGRATION_GUIDE.md
130
+ - Plugins cookbook: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/STREAMING_MARKDOWN_PLUGINS_COOKBOOK.md
131
+ - Status/architecture: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/STREAMING_MARKDOWN_V2_STATUS.md
132
+ - TUI/CLI protocol guide: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/CLI_USAGE.md
125
133
 
126
134
  ## Package map
127
135
 
package/dist/core.d.cts CHANGED
@@ -2,8 +2,6 @@ export * from '@stream-mdx/core';
2
2
  import '@stream-mdx/react';
3
3
  import '@stream-mdx/plugins';
4
4
  import '@stream-mdx/worker';
5
- import '@stream-mdx/worker/mdx-compile';
6
- import '@stream-mdx/worker/node';
7
5
  import '@stream-mdx/plugins/base';
8
6
  import '@stream-mdx/plugins/callouts';
9
7
  import '@stream-mdx/plugins/document';
@@ -14,3 +12,5 @@ import '@stream-mdx/plugins/mdx';
14
12
  import '@stream-mdx/plugins/registry';
15
13
  import '@stream-mdx/plugins/tables';
16
14
  import '@stream-mdx/plugins/math/renderer';
15
+ import '@stream-mdx/worker/mdx-compile';
16
+ import '@stream-mdx/worker/node';
package/dist/core.d.ts CHANGED
@@ -2,8 +2,6 @@ export * from '@stream-mdx/core';
2
2
  import '@stream-mdx/react';
3
3
  import '@stream-mdx/plugins';
4
4
  import '@stream-mdx/worker';
5
- import '@stream-mdx/worker/mdx-compile';
6
- import '@stream-mdx/worker/node';
7
5
  import '@stream-mdx/plugins/base';
8
6
  import '@stream-mdx/plugins/callouts';
9
7
  import '@stream-mdx/plugins/document';
@@ -14,3 +12,5 @@ import '@stream-mdx/plugins/mdx';
14
12
  import '@stream-mdx/plugins/registry';
15
13
  import '@stream-mdx/plugins/tables';
16
14
  import '@stream-mdx/plugins/math/renderer';
15
+ import '@stream-mdx/worker/mdx-compile';
16
+ import '@stream-mdx/worker/node';
package/dist/worker/direct.cjs ADDED
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __export = (target, all) => {
7
+ for (var name in all)
8
+ __defProp(target, name, { get: all[name], enumerable: true });
9
+ };
10
+ var __copyProps = (to, from, except, desc) => {
11
+ if (from && typeof from === "object" || typeof from === "function") {
12
+ for (let key of __getOwnPropNames(from))
13
+ if (!__hasOwnProp.call(to, key) && key !== except)
14
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
+ }
16
+ return to;
17
+ };
18
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
+
20
+ // src/worker/direct.ts
21
+ var direct_exports = {};
22
+ __export(direct_exports, {
23
+ compileMarkdownSnapshotDirect: () => import_worker.compileMarkdownSnapshotDirect
24
+ });
25
+ module.exports = __toCommonJS(direct_exports);
26
+ var import_worker = require("@stream-mdx/worker");
27
+ // Annotate the CommonJS export names for ESM import in node:
28
+ 0 && (module.exports = {
29
+ compileMarkdownSnapshotDirect
30
+ });
package/dist/worker/direct.d.cts ADDED
@@ -0,0 +1 @@
1
+ export { CompileMarkdownSnapshotDirectOptions, CompileMarkdownSnapshotDirectResult, SnapshotArtifactV1, compileMarkdownSnapshotDirect } from '@stream-mdx/worker';
package/dist/worker/direct.d.ts ADDED
@@ -0,0 +1 @@
1
+ export { CompileMarkdownSnapshotDirectOptions, CompileMarkdownSnapshotDirectResult, SnapshotArtifactV1, compileMarkdownSnapshotDirect } from '@stream-mdx/worker';
package/dist/worker/direct.mjs ADDED
@@ -0,0 +1,7 @@
1
+ // src/worker/direct.ts
2
+ import {
3
+ compileMarkdownSnapshotDirect
4
+ } from "@stream-mdx/worker";
5
+ export {
6
+ compileMarkdownSnapshotDirect
7
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stream-mdx",
3
- "version": "0.2.0",
3
+ "version": "0.4.0",
4
4
  "description": "StreamMDX convenience package (re-exports @stream-mdx/*).",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -41,6 +41,11 @@
41
41
  "import": "./dist/worker/mdx-compile.mjs",
42
42
  "require": "./dist/worker/mdx-compile.cjs"
43
43
  },
44
+ "./worker/direct": {
45
+ "types": "./dist/worker/direct.d.ts",
46
+ "import": "./dist/worker/direct.mjs",
47
+ "require": "./dist/worker/direct.cjs"
48
+ },
44
49
  "./worker/node": {
45
50
  "types": "./dist/worker/node.d.ts",
46
51
  "import": "./dist/worker/node.mjs",
@@ -114,10 +119,10 @@
114
119
  "prepack": "npm run build"
115
120
  },
116
121
  "dependencies": {
117
- "@stream-mdx/core": "0.2.0",
118
- "@stream-mdx/plugins": "0.2.0",
119
- "@stream-mdx/react": "0.2.0",
120
- "@stream-mdx/worker": "0.2.0"
122
+ "@stream-mdx/core": "0.4.0",
123
+ "@stream-mdx/plugins": "0.4.0",
124
+ "@stream-mdx/react": "0.4.0",
125
+ "@stream-mdx/worker": "0.4.0"
121
126
  },
122
127
  "peerDependencies": {
123
128
  "react": ">=18.2.0",