From 8d39c68bc366359cb0dc165453d9ab0af800da07 Mon Sep 17 00:00:00 2001 From: Andrew Bulat Date: Tue, 21 Jul 2026 15:07:07 +0100 Subject: [PATCH] docs(ai-transport): migrate UIMessageCodec to createUIMessageCodec MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ably-ai-transport-js#267 (AIT-1039) removes the UIMessageCodec value export from @ably/ai-transport/vercel in favour of the createUIMessageCodec() factory, now generic over the AI SDK's UIMessage parameters. The change ships in the SDK 0.6.0 release, so the docs move to the factory across every AI Transport page. Stacked on #3471 (zak/docs-steering), which introduces the steering docs and already bumps the documented AIT SDK version to 0.6; this migrates every UIMessageCodec usage — including the new steering examples and the interruption-and-steering page — to createUIMessageCodec(). React provider props and multi-call snippets hold a stable codec instance; one-off sends and per-request agent handlers call the factory inline. The Vercel codec reference page is reframed around the factory (a fresh, stateless value per call), and a new "Typed messages" section on the Vercel AI SDK UI page documents threading concrete UIMessage types through the imperative path. Co-Authored-By: Claude Opus 4.8 (1M context) --- src/pages/docs/ai-transport/api/index.mdx | 6 ++-- .../api/javascript/core/agent-session.mdx | 12 +++---- .../api/javascript/core/client-session.mdx | 16 ++++----- .../api/javascript/core/codec.mdx | 2 +- .../api/javascript/vercel/chat-transport.mdx | 12 +++---- .../api/javascript/vercel/codec.mdx | 36 +++++++++++-------- .../ai-transport/api/react/core/providers.mdx | 10 +++--- .../react/vercel/chat-transport-provider.mdx | 6 ++-- .../docs/ai-transport/concepts/codecs.mdx | 4 +-- .../ai-transport/concepts/connections.mdx | 4 +-- src/pages/docs/ai-transport/concepts/runs.mdx | 6 ++-- .../docs/ai-transport/concepts/sessions.mdx | 2 +- .../ai-transport/features/agent-presence.mdx | 4 +-- .../features/chain-of-thought.mdx | 2 +- .../features/concurrent-turns.mdx | 16 ++++----- .../ai-transport/features/double-texting.mdx | 10 +++--- .../features/durable-execution.mdx | 4 +-- .../features/interruption-and-steering.mdx | 10 +++--- .../ai-transport/features/liveobjects.mdx | 4 +-- .../ai-transport/features/multi-device.mdx | 4 +-- .../features/push-notifications.mdx | 2 +- .../frameworks/vercel-ai-sdk-core.mdx | 8 ++--- .../frameworks/vercel-ai-sdk-ui.mdx | 23 +++++++++++- .../getting-started/authentication.mdx | 7 ++-- .../ai-transport/getting-started/core-sdk.mdx | 15 ++++---- .../getting-started/vercel-ai-sdk.mdx | 2 +- .../internals/codec-architecture.mdx | 2 +- 27 files changed, 131 insertions(+), 98 deletions(-) diff --git a/src/pages/docs/ai-transport/api/index.mdx b/src/pages/docs/ai-transport/api/index.mdx index 944ad38b70..3a428ce1ae 100644 --- a/src/pages/docs/ai-transport/api/index.mdx +++ b/src/pages/docs/ai-transport/api/index.mdx @@ -37,7 +37,7 @@ See the individual reference pages for the full API. | --- | --- | --- | | Core | `@ably/ai-transport` | `createClientSession`, `createAgentSession`, `Invocation`, `Codec` interface | | React | `@ably/ai-transport/react` | `ClientSessionProvider`, `useClientSession`, `useView`, `useTree`, `useCreateView`, `useMessagesWithSeed`, `useAblyMessages`, `createSessionHooks` | -| Vercel | `@ably/ai-transport/vercel` | `UIMessageCodec`, Vercel-bound `createClientSession` and `createAgentSession`, `createChatTransport`, `vercelRunOutcome` | +| Vercel | `@ably/ai-transport/vercel` | `createUIMessageCodec`, Vercel-bound `createClientSession` and `createAgentSession`, `createChatTransport`, `vercelRunOutcome` | | Vercel React | `@ably/ai-transport/vercel/react` | `ChatTransportProvider`, `useChatTransport`, `useMessageSync`, `useMessagesWithSeed`, plus the Vercel-baked re-exports of `ClientSessionProvider`, `useClientSession`, `useView`, `useCreateView`, `useTree`, and `useAblyMessages` |