@seed-app-studio/sdk 0.1.1-canary.0

package/README.md

@@ -0,0 +1,68 @@
+# @seed-app-studio/sdk
+
+SEED App Client SDK — unified API for interacting with SEED Agent Runtime across all platforms.
+
+## Transport Migration (JSON-RPC 2.0)
+
+All transports have been migrated to **JSON-RPC 2.0** as the wire protocol.
+
+### Available Transports
+
+| Transport            | Function                              | Platform                                  | Wire Format                             |
+| -------------------- | ------------------------------------- | ----------------------------------------- | --------------------------------------- |
+| App Host window      | `createWindowSeedAppTransport()`      | App Studio iframe / browser host          | SDK envelope over `postMessage`         |
+| Electron IPC         | `createSeedAppElectronTransport()`    | Desktop Electron                          | JSON-RPC 2.0 over IPC                   |
+| Endpoint WebSocket   | `createSeedAppEndpointTransport()`    | Web SaaS endpoint / mobile remote runtime | JSON-RPC 2.0 over WebSocket             |
+| Raw WebSocket        | `createSeedAppWebSocketTransport()`   | Web SaaS low-level socket clients         | JSON-RPC 2.0 over WebSocket             |
+| React Native WebView | `createSeedAppReactNativeTransport()` | Mobile embedded App Studio surface        | JSON-RPC 2.0 over WebView `postMessage` |
+
+### Usage
+
+```typescript
+import {
+  createSeedAppClient,
+  createSeedAppElectronTransport,
+  createSeedAppEndpointTransport,
+  createSeedAppReactNativeTransport,
+} from "@seed-app-studio/sdk";
+
+// Electron
+const client = createSeedAppClient({
+  transport: createSeedAppElectronTransport(),
+});
+
+// Web endpoint (SaaS / Mobile remote runtime)
+const client = createSeedAppClient({
+  transport: createSeedAppEndpointTransport({
+    endpoint: "wss://seed.example.com/v1/ws?token=session-token",
+  }),
+});
+
+// React Native WebView
+const client = createSeedAppClient({
+  transport: createSeedAppReactNativeTransport(),
+});
+
+// All transports expose the same API
+const agents = await client.agent.list();
+const result = await client.agent.run({ input: "hello" });
+const unsub = client.agent.subscribe((event) => console.log(event));
+```
+
+### Migration from SeedBridge\* Types
+
+If your code references `SeedBridgeElectronIpcFrame` or `SeedBridgeRequest/Result/Event`:
+
+1. Replace `createSeedBridgeElectronIpcRequestFrame()` → `createJsonRpcRequest()`
+2. Replace `parseSeedBridgeElectronIpcFrame()` → `deserializeJsonRpcFrame()`
+3. Replace `serializeSeedBridgeElectronIpcFrame()` → `serializeJsonRpcFrame()`
+4. Replace `SeedBridgeEvent` handling → `seed.event` notification parsing
+
+The `SeedAppClient` interface is unchanged — only the underlying transport serialization changed.
+
+### Dual-Format Compatibility
+
+During the migration period, all adapters accept both JSON-RPC and legacy SeedBridge frames on ingress.
+New code MUST send JSON-RPC frames. Legacy frame support will be removed in a future release.
+
+See: `openspec/changes/unify-jsonrpc-bridge/` for the full migration plan.