docs(ai-transport): migrate UIMessageCodec to createUIMessageCodec factory#3480
Open
VeskeR wants to merge 1 commit into
Open
docs(ai-transport): migrate UIMessageCodec to createUIMessageCodec factory#3480VeskeR wants to merge 1 commit into
VeskeR wants to merge 1 commit into
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
VeskeR
force-pushed
the
AIT-1039/forward-uimessage-types
branch
from
July 21, 2026 14:58
b401c90 to
3265c75
Compare
zknill
force-pushed
the
zak/docs-steering
branch
from
July 21, 2026 15:35
bc97c86 to
8b8ad92
Compare
VeskeR
force-pushed
the
AIT-1039/forward-uimessage-types
branch
from
July 21, 2026 15:42
3265c75 to
8244a12
Compare
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 <metadata, data-part, tool> 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) <noreply@anthropic.com>
VeskeR
force-pushed
the
AIT-1039/forward-uimessage-types
branch
from
July 21, 2026 15:52
8244a12 to
86f8213
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The AI Transport SDK PR ably/ably-ai-transport-js#267 (AIT-1039) removes the
UIMessageCodecvalue export from@ably/ai-transport/vercelin favour of thecreateUIMessageCodec()factory, now generic over the AI SDK's threeUIMessagetype parameters (<TMetadata, TDataParts, TTools>). This updates the AI Transport docs to match.What changed
UIMessageCodec→createUIMessageCodec()for imports,codec:options,codec={}provider props, and.createUserMessage()/.steer(...)calls; prose mentions become "the Vercel codec".api/javascript/vercel/codec.mdx) reframed around the factory — it returns a fresh, stateless codec value per call — with a new "Type parameters" section documenting the generics. The page URL and nav label ("Codec") are unchanged, so no redirect is needed.frameworks/vercel-ai-sdk-ui.mdxshowing how to thread concreteUIMessagetypes through the imperative path (createClientSession<…>+createChatTransport<…>+useMessageSync<…>).Conventions
UIMessageCodecstays in the codec page'smeta_keywords(discoverability of the old name) and the internal<Table id>. TheCodec-interfacecreateUserMessage(){}contract method and allUIMessagetype references are intentionally untouched.🤖 Generated with Claude Code