@ably/ai-transport 0.2.0 → 0.3.0

package/README.md

@@ -39,6 +39,8 @@ Ably AI Transport SDK is not an agent framework or orchestration layer - it work
 - **Concurrent runs** - Multiple request-response cycles run in parallel on the same channel. Each run has its own stream and abort signal.
 - **History** - The Ably channel is the conversation record. Clients hydrate from channel history on load - no separate database query needed.
 - **Branching** - Regenerate or edit messages to fork the conversation. The SDK tracks parent/child relationships and exposes a navigable tree.
+- **Presence** - The session channel carries Ably Presence. `session.presence` exposes it directly, and ably-js's presence hooks work inside the React providers - see which clients are connected to a session.
+- **LiveObjects** - The session channel can carry Ably LiveObjects: synchronized shared state (maps, counters) alongside the conversation. `session.object` exposes it directly - opt in with the LiveObjects plugin and `channelModes`.
 - **Framework-agnostic** - A codec interface decouples transport from the AI framework. Ships with a Vercel AI SDK codec; bring your own for any other stack.
 
 ### When you need this
@@ -103,25 +105,19 @@ export async function POST(req: Request) {
   const run = session.createRun(invocation, { signal: req.signal });
 
   await run.start();
-
-  if (invocation.messages.length > 0) {
-    await run.addMessages(invocation.messages, { clientId: invocation.clientId });
-  }
-
-  const historyMsgs = invocation.history.map((h) => h.message);
-  const newMsgs = invocation.messages.map((m) => m.message);
+  await run.loadConversation();
 
   const result = streamText({
     model: anthropic('claude-sonnet-4-6'),
     system: 'You are a helpful assistant.',
-    messages: await convertToModelMessages([...historyMsgs, ...newMsgs]),
+    messages: await convertToModelMessages(run.messages),
     abortSignal: run.abortSignal,
   });
 
   // Stream the response over Ably in the background
   after(async () => {
     const { reason } = await run.pipe(result.toUIMessageStream());
-    await run.end(reason);
+    await run.end({ reason });
     session.close();
   });
 
@@ -176,12 +172,9 @@ function ChatInner({ chatId }: { chatId: string }) {
   );
 }
 
-function Chat({ chatId, clientId }: { chatId: string; clientId?: string }) {
+function Chat({ chatId }: { chatId: string }) {
   return (
-    <ChatTransportProvider
-      channelName={chatId}
-      clientId={clientId}
-    >
+    <ChatTransportProvider channelName={chatId}>
       <ChatInner chatId={chatId} />
     </ChatTransportProvider>
   );
@@ -233,8 +226,6 @@ const session = createClientSession({
   client: ably, // Ably.Realtime
   channelName: 'ai:demo',
   codec: myCodec,
-  clientId: 'user-123',
-  api: '/api/chat',
 });
 await session.connect();
 
@@ -260,10 +251,10 @@ await session.connect();
 const run = session.createRun(invocation);
 
 await run.start();
-await run.addMessages(invocation.messages, { clientId: invocation.clientId });
+await run.loadConversation();
 
 const { reason } = await run.pipe(aiStream);
-await run.end(reason);
+await run.end({ reason });
 session.close();
 ```
 
@@ -373,7 +364,7 @@ Detailed documentation lives in the [`docs/`](./docs/) directory:
 - **[Concepts](./docs/concepts/)** - [Sessions](./docs/concepts/sessions.md), [Runs](./docs/concepts/runs.md)
 - **[Get started](./docs/get-started/)** - [Vercel AI SDK with useChat](./docs/get-started/vercel-use-chat.md), [Vercel AI SDK with useClientSession](./docs/get-started/vercel-use-client-session.md)
 - **[Frameworks](./docs/frameworks/)** - [Vercel AI SDK](./docs/frameworks/vercel-ai-sdk.md)
-- **[Features](./docs/features/)** - [Streaming](./docs/features/streaming.md), [Cancellation](./docs/features/cancel.md), [Interruption](./docs/features/interruption.md), [Optimistic updates](./docs/features/optimistic-updates.md), [History](./docs/features/history.md), [Branching](./docs/features/branching.md), [Multi-client sync](./docs/features/multi-client.md), [Concurrent runs](./docs/features/concurrent-runs.md)
+- **[Features](./docs/features/)** - [Streaming](./docs/features/streaming.md), [Cancellation](./docs/features/cancel.md), [Interruption](./docs/features/interruption.md), [Optimistic updates](./docs/features/optimistic-updates.md), [History](./docs/features/history.md), [Branching](./docs/features/branching.md), [Multi-client sync](./docs/features/multi-client.md), [Concurrent runs](./docs/features/concurrent-runs.md), [Presence](./docs/features/presence.md), [LiveObjects](./docs/features/liveobjects.md)
 - **[Reference](./docs/reference/)** - [React hooks](./docs/reference/react-hooks.md), [Error codes](./docs/reference/error-codes.md)
 - **[Internals](./docs/internals/)** - Architecture details for contributors