fix(chat): correctly type thread and channel interface#242
Open
rayhanadev wants to merge 2 commits intovercel:mainfrom
Open
fix(chat): correctly type thread and channel interface#242rayhanadev wants to merge 2 commits intovercel:mainfrom
rayhanadev wants to merge 2 commits intovercel:mainfrom
Conversation
Contributor
|
@rayhanadev is attempting to deploy a commit to the Vercel Labs Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
This PR fixes a TypeScript typing gap in the chat SDK by aligning the public Thread and Channel interfaces with their concrete implementations, which already support serialization via toJSON().
Changes:
- Added
toJSON(): SerializedChannelto theChannelinterface. - Added
toJSON(): SerializedThreadto theThreadinterface. - Added type-only imports for
SerializedChannelandSerializedThreadintypes.ts.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Why
The
ThreadandChannelinterfaces intypes.tsare missingtoJSON()method declarations, even though the implementations (ThreadImpl,ChannelImpl) both implement it. This causes TypeScript errors when code typed against the public interfaces callsthread.toJSON()orchannel.toJSON().Closes #241
What changed?
toJSON(): SerializedThreadto theThreadinterfacetoJSON(): SerializedChannelto theChannelinterfaceSerializedThreadandSerializedChannelintypes.tsTest plan
pnpm validatepasses (typecheck, lint, build, tests across all packages)thread.toJSON()now type-checks correctly against theThreadinterface in sample codeChannel