Repository navigation
Add properties for messages in chat client sdk. - #1246
Merged
Merged
Conversation
Zhenghui Yan (vwxyzh)
requested review from
Liangying.Wei (vicancy) and
xingsy97 (xingsy97)
October 28, 2026 07:35
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block approval of the optional message-properties changes.
No open issues 🎉
What changed in this PR
Adds optional message properties to the chat client SDK, carrying mentions, reply targets, and metadata through sendToRoom requests and sender-local message events.
Changes:
- Adds nullable
mentions,replyTo, andmetadatasend options. - Aligns message models, schemas, and the public API with the updated properties, including renaming
refMessageIdtoreplyTo. - Documents usage and adds tests for omitted, null, and empty properties alongside cancellation forwarding.
| File | Description |
|---|---|
sdk/webpubsub-chat-client/tests/lifecycle.test.ts |
Tests property forwarding and local message events. |
sdk/webpubsub-chat-client/swagger/openapi.yaml |
Updates message schemas and replaces legacy fields. |
sdk/webpubsub-chat-client/src/options.ts |
Defines optional message properties for sending. |
sdk/webpubsub-chat-client/src/models.ts |
Adds mentions and renames the reply reference. |
sdk/webpubsub-chat-client/src/generatedTypes.ts |
Synchronizes generated types with schema changes. |
sdk/webpubsub-chat-client/src/chatClient.ts |
Includes properties in outgoing messages and local events. |
sdk/webpubsub-chat-client/review/web-pubsub-chat-client.api.md |
Updates the public API snapshot. |
sdk/webpubsub-chat-client/README.md |
Documents options, examples, and nullable values. |
Review effort: Balanced
xingsy97 (xingsy97)
approved these changes
Oct 28, 2026
Liangying.Wei (vicancy)
approved these changes
Oct 30, 2026
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.
No description provided.