@ably/ai-transport 0.0.1

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,426 @@
+# Ably AI Transport SDK
+
+A durable transport layer between AI agents and users. Streams AI responses over [Ably](https://ably.com/) channels - responses resume after disconnections, conversations persist across page reloads and devices, with support for cancellation, branching conversations, and multi-user sync.
+
+> **Status:** Pre-release (`0.x`). The API is evolving. Feedback and contributions are welcome.
+
+## The problem
+
+Most AI frameworks stream tokens over HTTP response bodies or SSE. That works until it doesn't: connections drop through corporate proxies, responses vanish on page refresh, and sessions are stuck on a single device or tab. Once an agent starts a long-running task, the user has no way to interrupt it, check if it's still running, or continue the conversation from another device. If a human needs to take over from the agent, the session context is lost.
+
+Ably AI Transport replaces the HTTP stream with an Ably channel. The server publishes tokens to the channel as they arrive from the LLM; the response accumulates on the channel and persists, so partial responses survive disconnection. Any client can subscribe to the same channel from any device. Cancel signals, turn lifecycle events, and conversation history all flow through the channel rather than depending on a single HTTP connection.
+
+```mermaid
+sequenceDiagram
+    participant U as User
+    participant CT as Client Transport
+    participant AC as Ably Channel
+    participant ST as Server Transport
+    participant LLM
+
+    U->>CT: type message
+    CT->>ST: HTTP POST (messages)
+    ST->>LLM: prompt
+    LLM-->>ST: token stream
+    ST->>AC: publish chunks
+    AC->>CT: subscribe (decode)
+    CT->>U: render tokens
+```
+
+Ably AI Transport SDK is not an agent framework or orchestration layer - it works alongside whatever agent framework/model provider you choose, through a pluggable codec architecture (Vercel AI SDK supported now, more frameworks and models coming soon). It can be used in a serverless architecture (e.g. Next.js), with a durable execution framework (e.g. Temporal, Vercel Workflow DevKit) or in a traditional client-server architecture.
+
+## What this gives you
+
+- **Resumable streaming** - If a connection drops mid-response, client reconnects and picks up where it left off. The response persists on the channel, so nothing is lost.
+- **Session continuity across surfaces** - The session belongs to the channel, not the connection. A user can change tab or device and pick up at the same point.
+- **Multi-client sync** - Multiple users, agents, or operators subscribe to the same channel. Human-AI handover is a channel operation, not a session migration.
+- **Cancellation** - Cancel signals travel over the Ably channel, not the HTTP connection, and the server turn's `abortSignal` fires automatically.
+- **Interruption** - Users send new messages while the AI is still responding, with composable primitives for cancel-and-resend or queue-until-complete.
+- **Concurrent turns** - Multiple request-response cycles run in parallel on the same channel. Each turn 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.
+- **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
+
+- AI products where connection reliability and session durability are non-negotiable
+- Multi-surface experiences where a user needs to see the session in multiple tabs or devices
+- Collaborative AI where multiple users or agents interact in the same conversation
+- Customer support products where AI conversations are handed to human agents
+
+---
+
+## Getting started
+
+### Installation
+
+```sh
+npm install @ably/ai-transport ably
+```
+
+For Vercel AI SDK projects, also install the `ai` package:
+
+```sh
+npm install @ably/ai-transport ably ai
+```
+
+### Supported platforms
+
+| Platform      | Support                                            |
+| ------------- | -------------------------------------------------- |
+| Node.js       | 20+                                                |
+| Browsers      | All major browsers (Chrome, Firefox, Edge, Safari) |
+| TypeScript    | Written in TypeScript, ships with types            |
+| React         | 18+ and 19+ via dedicated hooks                    |
+| Vercel AI SDK | v6 via dedicated codec and transport adapters      |
+
+---
+
+## Usage with Vercel AI SDK
+
+AI Transport is complementary to the Vercel AI SDK, not a replacement. The Vercel AI SDK handles model calls, message formatting, and React hooks. AI Transport replaces the transport layer underneath, so tokens stream over Ably instead of an HTTP response body. You keep `useChat`, `streamText`, and everything else you're used to.
+
+### Server - Next.js API route
+
+```typescript
+import { after } from 'next/server';
+import { streamText, convertToModelMessages } from 'ai';
+import type { UIMessage } from 'ai';
+import { anthropic } from '@ai-sdk/anthropic';
+import Ably from 'ably';
+import { createServerTransport } from '@ably/ai-transport/vercel';
+import type { MessageWithHeaders } from '@ably/ai-transport';
+
+interface ChatRequestBody {
+  turnId: string;
+  clientId: string;
+  messages: MessageWithHeaders<UIMessage>[];
+  history?: MessageWithHeaders<UIMessage>[];
+  id: string;
+  forkOf?: string;
+  parent?: string | null;
+}
+
+const ably = new Ably.Realtime({ key: process.env.ABLY_API_KEY });
+
+export async function POST(req: Request) {
+  const { messages, history, id, turnId, clientId, forkOf, parent } = (await req.json()) as ChatRequestBody;
+
+  const channel = ably.channels.get(id);
+  const transport = createServerTransport({ channel });
+  const turn = transport.newTurn({ turnId, clientId, parent, forkOf });
+
+  await turn.start();
+
+  if (messages.length > 0) {
+    await turn.addMessages(messages, { clientId });
+  }
+
+  const historyMsgs = (history ?? []).map((h) => h.message);
+  const newMsgs = messages.map((m) => m.message);
+
+  const result = streamText({
+    model: anthropic('claude-sonnet-4-20250514'),
+    system: 'You are a helpful assistant.',
+    messages: await convertToModelMessages([...historyMsgs, ...newMsgs]),
+    abortSignal: turn.abortSignal,
+  });
+
+  // Stream the response over Ably in the background
+  after(async () => {
+    const { reason } = await turn.streamResponse(result.toUIMessageStream());
+    await turn.end(reason);
+    transport.close();
+  });
+
+  return new Response(null, { status: 200 });
+}
+```
+
+### Client - React with `useChat`
+
+```tsx
+'use client';
+
+import { useChat } from '@ai-sdk/react';
+import { useChannel } from 'ably/react';
+import { useClientTransport, useActiveTurns, useHistory } from '@ably/ai-transport/react';
+import { useChatTransport, useMessageSync } from '@ably/ai-transport/vercel/react';
+import { UIMessageCodec } from '@ably/ai-transport/vercel';
+
+function Chat({ chatId, clientId }: { chatId: string; clientId?: string }) {
+  const { channel } = useChannel({ channelName: chatId });
+
+  const transport = useClientTransport({ channel, codec: UIMessageCodec, clientId });
+  const chatTransport = useChatTransport(transport);
+
+  const { messages, setMessages, sendMessage, stop } = useChat({
+    id: chatId,
+    transport: chatTransport,
+  });
+
+  useMessageSync(transport, setMessages);
+
+  const activeTurns = useActiveTurns(transport);
+  const history = useHistory(transport, { limit: 30 });
+
+  return (
+    <div>
+      {messages.map((msg) => (
+        <div key={msg.id}>{msg.parts.map((part, i) => (part.type === 'text' ? <p key={i}>{part.text}</p> : null))}</div>
+      ))}
+      <form
+        onSubmit={(e) => {
+          e.preventDefault();
+          sendMessage({ text: 'Hello' });
+        }}
+      >
+        {activeTurns.size > 0 ? (
+          <button
+            type="button"
+            onClick={stop}
+          >
+            Stop
+          </button>
+        ) : (
+          <button type="submit">Send</button>
+        )}
+      </form>
+    </div>
+  );
+}
+```
+
+### Authentication
+
+The Ably client authenticates via token auth. Create an endpoint that issues token requests:
+
+```typescript
+// app/api/auth/ably-token/route.ts
+import Ably from 'ably';
+
+const ably = new Ably.Rest({ key: process.env.ABLY_API_KEY });
+
+export async function GET(req: Request) {
+  const { searchParams } = new URL(req.url);
+  const clientId = searchParams.get('clientId') ?? 'anonymous';
+  const token = await ably.auth.createTokenRequest({ clientId });
+  return Response.json(token);
+}
+```
+
+```typescript
+// Client-side Ably setup
+const ably = new Ably.Realtime({
+  authCallback: async (_params, callback) => {
+    const response = await fetch('/api/auth/ably-token');
+    const token = await response.json();
+    callback(null, token);
+  },
+});
+```
+
+---
+
+## Core usage with a custom codec
+
+The core entry point is framework-agnostic. Bring your own `Codec` to map between your AI framework's event/message types and the Ably wire format.
+
+### Client
+
+```typescript
+import { createClientTransport } from '@ably/ai-transport';
+import { myCodec } from './my-codec';
+
+const transport = createClientTransport({
+  channel, // Ably RealtimeChannel
+  codec: myCodec,
+  clientId: 'user-123',
+  api: '/api/chat',
+});
+
+const turn = await transport.send(messages);
+
+// Read the stream
+const reader = turn.stream.getReader();
+while (true) {
+  const { done, value } = await reader.read();
+  if (done) break;
+  console.log(value); // Your codec's event type
+}
+```
+
+### Server
+
+```typescript
+import { createServerTransport } from '@ably/ai-transport';
+import { myCodec } from './my-codec';
+
+const transport = createServerTransport({ channel, codec: myCodec });
+const turn = transport.newTurn({ turnId, clientId, parent, forkOf });
+
+await turn.start();
+await turn.addMessages(messages, { clientId });
+
+const { reason } = await turn.streamResponse(aiStream);
+await turn.end(reason);
+transport.close();
+```
+
+---
+
+## Package exports
+
+| Export path                               | Purpose                                     | Peer dependencies     |
+| ----------------------------------------- | ------------------------------------------- | --------------------- |
+| `@ably/ai-transport`              | Core transport, codec interfaces, utilities | `ably`                |
+| `@ably/ai-transport/react`        | React hooks for any codec                   | `ably`, `react`       |
+| `@ably/ai-transport/vercel`       | Vercel AI SDK codec, transport factories    | `ably`, `ai`          |
+| `@ably/ai-transport/vercel/react` | React hooks for Vercel's `useChat`          | `ably`, `ai`, `react` |
+
+### React hooks
+
+| Hook                  | Entry point     | Description                                         |
+| --------------------- | --------------- | --------------------------------------------------- |
+| `useClientTransport`  | `/react`        | Create and memoize a client transport instance      |
+| `useMessages`         | `/react`        | Subscribe to decoded messages                       |
+| `useSend`             | `/react`        | Stable send callback                                |
+| `useRegenerate`       | `/react`        | Regenerate a message (fork the conversation)        |
+| `useEdit`             | `/react`        | Edit a message and regenerate from that point       |
+| `useActiveTurns`      | `/react`        | Track active turns by client ID                     |
+| `useHistory`          | `/react`        | Paginate through conversation history               |
+| `useConversationTree` | `/react`        | Navigate branches in a forked conversation          |
+| `useAblyMessages`     | `/react`        | Access raw Ably messages                            |
+| `useChatTransport`    | `/vercel/react` | Wrap transport for Vercel's `useChat`               |
+| `useMessageSync`      | `/vercel/react` | Sync transport state with `useChat`'s `setMessages` |
+
+---
+
+## Key features
+
+### Connection recovery
+
+Two mechanisms cover different failure modes:
+
+- **Network blips** - Ably's connection protocol automatically reconnects and delivers any messages published while the client was disconnected. No application code required.
+- **Resumable streams** - A client that joins or rejoins a channel mid-response (after a page refresh, on a new device, or as a second participant) receives the in-progress stream immediately on subscribing. Load previous conversation history from the channel via `history()`, or from your own database.
+
+### Cancellation
+
+```typescript
+// Client: cancel your own active turns
+await transport.cancel();
+
+// Cancel a specific turn
+await transport.cancel({ turnId: 'turn-abc' });
+
+// Server: the turn's abortSignal fires automatically
+const result = streamText({
+  model: anthropic('claude-sonnet-4-20250514'),
+  messages,
+  abortSignal: turn.abortSignal, // Aborted when client cancels
+});
+```
+
+### Branching conversations
+
+Regenerate or edit messages to create forks in the conversation tree. The SDK tracks parent/child relationships and exposes a navigable tree.
+
+```typescript
+// Regenerate the last assistant message
+const turn = await transport.regenerate(assistantMessageId);
+
+// Edit a user message and regenerate from that point
+const turn = await transport.edit(userMessageId, [newMessage]);
+
+// Navigate branches
+const tree = transport.getTree();
+const siblings = tree.getSiblings(messageId);
+tree.select(messageId, 1); // Switch to second branch
+```
+
+### History and hydration
+
+Load previous conversation state when a client joins or returns to a session.
+
+```typescript
+const page = await transport.history({ limit: 50 });
+console.log(page.items); // Decoded messages
+
+if (page.hasNext()) {
+  const older = await page.next();
+}
+```
+
+### Events
+
+```typescript
+transport.on('message', () => {
+  console.log(transport.getMessages());
+});
+
+transport.on('turn', (event) => {
+  console.log(event.turnId, event.type); // 'x-ably-turn-start' | 'x-ably-turn-end'
+});
+
+transport.on('error', (error) => {
+  console.error(error.code, error.message);
+});
+```
+
+---
+
+## Documentation
+
+Detailed documentation lives in the [`docs/`](./docs/) directory:
+
+- **[Concepts](./docs/concepts/)** - [Transport architecture](./docs/concepts/transport.md), [Turns](./docs/concepts/turns.md)
+- **[Get started](./docs/get-started/)** - [Vercel AI SDK with useChat](./docs/get-started/vercel-use-chat.md), [Vercel AI SDK with useClientTransport](./docs/get-started/vercel-use-client-transport.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), [Barge-in](./docs/features/barge-in.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), [Tool calls](./docs/features/tool-calls.md), [Concurrent turns](./docs/features/concurrent-turns.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
+
+---
+
+## Demo apps
+
+Working demo applications live in the [`demo/`](./demo/) directory:
+
+- **[`demo/vercel/react/use-chat/`](./demo/vercel/react/use-chat/)** - Vercel AI SDK with `useChat` integration
+- **[`demo/vercel/react/use-client-transport/`](./demo/vercel/react/use-client-transport/)** - Vercel AI SDK with direct `useClientTransport` hooks
+
+---
+
+## Development
+
+```bash
+npm install
+npm run build             # Build all entry points (ESM + UMD/CJS + .d.ts)
+npm run typecheck         # Type check
+npm run lint              # Lint
+npm test                  # Unit tests (mocks only)
+npm run test:integration  # Integration tests (needs ABLY_API_KEY)
+npm run precommit         # format:check + lint + typecheck
+```
+
+### Project structure
+
+```
+src/
+├── core/               # Generic transport and codec (no framework deps)
+│   ├── codec/          # Codec interfaces and core encoder/decoder
+│   └── transport/      # ClientTransport, ServerTransport, ConversationTree
+├── react/              # React hooks for any codec
+├── vercel/             # Vercel AI SDK codec and transport adapters
+│   ├── codec/          # UIMessageCodec
+│   ├── transport/      # Vercel-specific factories, ChatTransport
+│   └── react/          # useChatTransport, useMessageSync
+└── index.ts            # Core entry point
+```
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md). [Open an issue](https://github.com/ably/ably-ai-transport-js/issues) to share feedback or request a feature.