@factory/droid-sdk 0.9.1 → 0.10.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 CHANGED
@@ -55,6 +55,28 @@ the canonical user-facing guide to:
55
55
  Runnable examples are available under [`examples/node`](./examples/node) and
56
56
  [`examples/browser`](./examples/browser).
57
57
 
58
+ ### Custom transport migration
59
+
60
+ - **Breaking agent-client change:** `DroidClientOptions.transport` and custom
61
+ session transports now require `DroidClientTransport`, which exchanges
62
+ `JsonRpcMessage` objects through `send` and `onMessage`. No format marker or
63
+ runtime detection is needed.
64
+ - Built-in `ProcessTransport` owns its stdio JSON codec. Its direct `send` and
65
+ `onMessage` callers must now pass and receive objects rather than strings.
66
+ In-process implementations exchange snapshots without codecs.
67
+ - For an existing custom `StringFramedDroidClientTransport`, explicitly pass
68
+ `withJsonRpcCodec(stringTransport)` to `DroidClient` or session options.
69
+ The adapter and both interfaces are exported from `@factory/droid-sdk/node`.
70
+ Do not wrap an already typed transport.
71
+ - **Breaking daemon-client change:** replace `DaemonClient.onMessage` with
72
+ `onTransportMessage` and remove `JSON.parse` from callbacks. Custom
73
+ `DaemonClientTransport.send` and `message` listeners now exchange
74
+ `JsonRpcMessage` objects. Put codecs inside transports that cross a serialized
75
+ boundary. External wire formats are unchanged.
76
+
77
+ The [canonical SDK guide](https://docs.factory.ai/sdk/typescript) remains the
78
+ full API reference.
79
+
58
80
  ## Browser security
59
81
 
60
82
  The daemon client currently authenticates with a Factory API key. Browser