@getorrery/client 0.3.1 → 0.3.3

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 (2) hide show
  1. package/README.md +39 -39
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,39 +1,39 @@
1
- # `@getorrery/client`
2
-
3
- The TypeScript half of the client SDK: `AguiSession` (decode, `seq`, re-attach `since`,
4
- control RPC) and `SurfaceStore`. **Pure data, no drawing** — exactly the same two things
5
- [`../../core/crates/orrery-client`](../../core/crates/orrery-client) gives Rust, built on
6
- stock `@ag-ui/client`'s `HttpAgent` over SSE.
7
-
8
- Types come from [`@getorrery/protocol`](../../protocol), which is generated by
9
- `cargo xtask typegen` and must not be hand-edited.
10
-
11
- ```bash
12
- pnpm -C harness/clients/sdk-ts test # vitest, over ../conformance
13
- ```
14
-
15
- It passes the shared fixtures in [`../conformance`](../conformance) — the same files
16
- `orrery-client` runs in Rust, asserted the same way. If the two ever disagree, one of the
17
- five clients is drawing something the others are not.
18
-
19
- ## The session is stock `@ag-ui/client`
20
-
21
- `AguiSession` wraps `HttpAgent` and hands it back unmodified through `httpAgent()`. That
22
- *is* the "existing AG-UI clients work unmodified" proof: if this package had to patch the
23
- agent, the claim would be false. What it adds is the half AG-UI has no vocabulary for —
24
- `session.attach(since)`, `turn.cancel`, `intent`, `consent.answer`, `query` — over a small
25
- `fetch` client against `POST /control`.
26
-
27
- `run()` parses the SSE stream itself rather than going through the agent's subscriber API,
28
- for one reason: our frames carry a `seq` the stock agent drops, and `seq` is the whole of
29
- the resumption story.
30
-
31
- ## A client never writes state
32
-
33
- AG-UI's shared state is bidirectional by design; ours is not. `StateSnapshot` and
34
- `StateDelta` flow outward only, and an edit a person makes arrives back as an `intent` the
35
- kernel validates. Anyone porting a component that expects to write state directly needs to
36
- know that.
37
-
38
- **Status.** Implemented and `private` until there is something to publish.
39
- Implementation plan: [`harness/docs/plans/08-protocol-transport.md`](../../docs/plans/08-protocol-transport.md).
1
+ # `@getorrery/client`
2
+
3
+ The TypeScript half of the client SDK: `AguiSession` (decode, `seq`, re-attach `since`,
4
+ control RPC) and `SurfaceStore`. **Pure data, no drawing** — exactly the same two things
5
+ [`../../core/crates/orrery-client`](../../core/crates/orrery-client) gives Rust, built on
6
+ stock `@ag-ui/client`'s `HttpAgent` over SSE.
7
+
8
+ Types come from [`@getorrery/protocol`](../../protocol), which is generated by
9
+ `cargo xtask typegen` and must not be hand-edited.
10
+
11
+ ```bash
12
+ pnpm -C harness/clients/sdk-ts test # vitest, over ../conformance
13
+ ```
14
+
15
+ It passes the shared fixtures in [`../conformance`](../conformance) — the same files
16
+ `orrery-client` runs in Rust, asserted the same way. If the two ever disagree, one of the
17
+ five clients is drawing something the others are not.
18
+
19
+ ## The session is stock `@ag-ui/client`
20
+
21
+ `AguiSession` wraps `HttpAgent` and hands it back unmodified through `httpAgent()`. That
22
+ *is* the "existing AG-UI clients work unmodified" proof: if this package had to patch the
23
+ agent, the claim would be false. What it adds is the half AG-UI has no vocabulary for —
24
+ `session.attach(since)`, `turn.cancel`, `intent`, `consent.answer`, `query` — over a small
25
+ `fetch` client against `POST /control`.
26
+
27
+ `run()` parses the SSE stream itself rather than going through the agent's subscriber API,
28
+ for one reason: our frames carry a `seq` the stock agent drops, and `seq` is the whole of
29
+ the resumption story.
30
+
31
+ ## A client never writes state
32
+
33
+ AG-UI's shared state is bidirectional by design; ours is not. `StateSnapshot` and
34
+ `StateDelta` flow outward only, and an edit a person makes arrives back as an `intent` the
35
+ kernel validates. Anyone porting a component that expects to write state directly needs to
36
+ know that.
37
+
38
+ **Status.** Implemented and `private` until there is something to publish.
39
+ Implementation plan: [`harness/docs/plans/08-protocol-transport.md`](../../docs/plans/08-protocol-transport.md).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getorrery/client",
3
- "version": "0.3.1",
3
+ "version": "0.3.3",
4
4
  "description": "The TypeScript Orrery client SDK: an AG-UI session over a pluggable transport (HTTP+SSE, WebSocket) and a SurfaceStore. Pure data, no drawing. Browser-safe; Node-only parts in @getorrery/client/node.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -33,8 +33,8 @@
33
33
  "dependencies": {
34
34
  "@ag-ui/client": "^1.0.0",
35
35
  "@ag-ui/core": "^1.0.0",
36
- "@getorrery/ext": "0.3.1",
37
- "@getorrery/protocol": "0.3.1"
36
+ "@getorrery/ext": "0.3.3",
37
+ "@getorrery/protocol": "0.3.3"
38
38
  },
39
39
  "devDependencies": {
40
40
  "@types/node": "^22.10.0",