@stream-mdx/protocol 0.4.0 → 0.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 (3) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +27 -20
  3. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,4 +1,23 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.5.0
4
+
5
+ ### Minor Changes
6
+
7
+ - Promote the current hardening and product-surface tranche as `0.5.0`.
8
+
9
+ This release rolls up:
10
+
11
+ - renderer/store correctness hardening
12
+ - seeded smoke and scheduler-parity release discipline
13
+ - benchmark methodology and comparison cleanup
14
+ - docs, showcase, and TUI/product surface maturation
15
+
16
+ ### Patch Changes
17
+
18
+ - Updated dependencies
19
+ - @stream-mdx/core@0.5.0
20
+
3
21
  ## 0.1.1
22
+
4
23
  - Initial protocol types and event envelope for StreamMDX Protocol v1.
package/README.md CHANGED
@@ -1,13 +1,13 @@
1
- # @stream-mdx/protocol
1
+ # `@stream-mdx/protocol`
2
2
 
3
- Protocol types for StreamMDX JSON/object streaming.
3
+ `@stream-mdx/protocol` defines the transport-facing protocol types for structured StreamMDX event/object streaming. It is intended for consumers that need a stable, typed contract outside the React/browser UI layer.
4
4
 
5
- This package defines the event envelope, capability metadata, and token
6
- structures used by StreamMDX Protocol v1. It is intended for consumers that
7
- need a stable, versioned contract (e.g., terminal UIs).
5
+ Typical consumers include:
8
6
 
9
- Most web-only consumers do not need this package directly. Start with `stream-mdx`
10
- or `@stream-mdx/react` for the React renderer.
7
+ - TUIs and CLI tools
8
+ - NDJSON transports
9
+ - service boundaries that want typed event envelopes
10
+ - debugging or replay tooling that records and replays structured patch streams
11
11
 
12
12
  ## Install
13
13
 
@@ -15,21 +15,28 @@ or `@stream-mdx/react` for the React renderer.
15
15
  npm install @stream-mdx/protocol
16
16
  ```
17
17
 
18
- ## What this provides
18
+ ## What This Package Provides
19
19
 
20
- - Shared protocol types for streaming events and capability negotiation.
21
- - Token / block payload shapes intended for structured-clone-safe transport.
20
+ | Surface | Purpose |
21
+ | --- | --- |
22
+ | Event envelope types | Transport-safe event/message contracts |
23
+ | Capability metadata | Describe supported features or modes |
24
+ | Token/block payload types | Structured-clone-safe payload shapes |
22
25
 
23
- ## Typical usage (TUI/CLI)
26
+ ## Typical Pairings
24
27
 
25
- Pair it with `@stream-mdx/tui` for NDJSON helpers + a lightweight snapshot store:
28
+ | Pair with | Why |
29
+ | --- | --- |
30
+ | [`@stream-mdx/tui`](../markdown-v2-tui/README.md) | NDJSON helpers and snapshot store |
31
+ | [`@stream-mdx/core`](../markdown-v2-core/README.md) | Shared low-level types and helpers |
32
+ | [`@stream-mdx/worker`](../markdown-v2-worker/README.md) | Worker-side generation/consumption paths |
26
33
 
27
- ```bash
28
- npm install @stream-mdx/tui @stream-mdx/protocol @stream-mdx/core
29
- ```
30
-
31
- ## Docs
34
+ ## Documentation
32
35
 
33
- - Public API: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/PUBLIC_API.md
34
- - CLI usage: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/CLI_USAGE.md
35
- - Protocol spec: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/STREAMMDX_JSON_DIFF_SPEC.md
36
+ - Start from the runnable example path with `npm run example:tui-minimal` from the repo root.
37
+ - [`../../examples/tui-minimal/README.md`](../../examples/tui-minimal/README.md)
38
+ - [`../../docs/TUI_MINIMAL_EXAMPLE.md`](../../docs/TUI_MINIMAL_EXAMPLE.md)
39
+ - [`../../docs/TUI_GUIDE.md`](../../docs/TUI_GUIDE.md)
40
+ - [`../../docs/STREAMMDX_JSON_DIFF_SPEC.md`](../../docs/STREAMMDX_JSON_DIFF_SPEC.md)
41
+ - [`../../docs/CLI_USAGE.md`](../../docs/CLI_USAGE.md)
42
+ - [`../../docs/PUBLIC_API.md`](../../docs/PUBLIC_API.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stream-mdx/protocol",
3
- "version": "0.4.0",
3
+ "version": "0.5.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.4.0"
37
+ "@stream-mdx/core": "0.5.0"
38
38
  }
39
39
  }