@stream-mdx/protocol 0.2.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.
- package/README.md +28 -0
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -5,3 +5,31 @@ Protocol types for StreamMDX JSON/object streaming.
|
|
|
5
5
|
This package defines the event envelope, capability metadata, and token
|
|
6
6
|
structures used by StreamMDX Protocol v1. It is intended for consumers that
|
|
7
7
|
need a stable, versioned contract (e.g., terminal UIs).
|
|
8
|
+
|
|
9
|
+
Most web-only consumers do not need this package directly. Start with `stream-mdx`
|
|
10
|
+
or `@stream-mdx/react` for the React renderer.
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install @stream-mdx/protocol
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## What this provides
|
|
19
|
+
|
|
20
|
+
- Shared protocol types for streaming events and capability negotiation.
|
|
21
|
+
- Token / block payload shapes intended for structured-clone-safe transport.
|
|
22
|
+
|
|
23
|
+
## Typical usage (TUI/CLI)
|
|
24
|
+
|
|
25
|
+
Pair it with `@stream-mdx/tui` for NDJSON helpers + a lightweight snapshot store:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm install @stream-mdx/tui @stream-mdx/protocol @stream-mdx/core
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Docs
|
|
32
|
+
|
|
33
|
+
- Public API: `docs/PUBLIC_API.md`
|
|
34
|
+
- CLI usage: `docs/CLI_USAGE.md`
|
|
35
|
+
- Protocol spec: `docs/STREAMMDX_JSON_DIFF_SPEC.md`
|
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Block, Patch, PatchMetrics } from '@stream-mdx/core';
|
|
2
|
-
export { DiffKind, TokenLineV1, TokenSpan, TokenStyle } from '@stream-mdx/core';
|
|
2
|
+
export { DiffBlock, DiffKind, DiffLine, DiffLineKind, ThemedLine, ThemedToken, TokenLineV1, TokenSpan, TokenStyle } from '@stream-mdx/core';
|
|
3
3
|
|
|
4
4
|
declare const STREAM_MDX_PROTOCOL_ID = "streammdx";
|
|
5
5
|
declare const STREAM_MDX_SCHEMA_VERSION = "1.0";
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Block, Patch, PatchMetrics } from '@stream-mdx/core';
|
|
2
|
-
export { DiffKind, TokenLineV1, TokenSpan, TokenStyle } from '@stream-mdx/core';
|
|
2
|
+
export { DiffBlock, DiffKind, DiffLine, DiffLineKind, ThemedLine, ThemedToken, TokenLineV1, TokenSpan, TokenStyle } from '@stream-mdx/core';
|
|
3
3
|
|
|
4
4
|
declare const STREAM_MDX_PROTOCOL_ID = "streammdx";
|
|
5
5
|
declare const STREAM_MDX_SCHEMA_VERSION = "1.0";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stream-mdx/protocol",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "StreamMDX protocol types and event envelope for JSON/object streaming",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -34,6 +34,6 @@
|
|
|
34
34
|
"prepack": "npm run build"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@stream-mdx/core": "0.
|
|
37
|
+
"@stream-mdx/core": "0.3.0"
|
|
38
38
|
}
|
|
39
39
|
}
|