docs(js-sdk): document card message support (ENG-36071) by aanshisingh-cometchat · Pull Request #420 · cometchat/docs

aanshisingh-cometchat · 2026-07-02T15:50:23Z

Add a dedicated JavaScript SDK "Card Messages" page covering the three receive-only card mechanisms: standalone CardMessage (onCardMessageReceived), inline cards on AIAssistantMessage via getElements()/AIAssistantElement, and real-time card streaming events (card_start/card/card_end) on the AIAssistantListener.

Add sdk/javascript/card-messages.mdx with TS + JS receive/render examples
Add reference entries for CardMessage, AIAssistantElement, the elements accessor on AIAssistantMessage, and the three card events (messages.mdx)
Add onCardMessageReceived + card-events note to all-real-time-listeners.mdx
Add the card category to message-structure-and-hierarchy.mdx
Cross-link card handling from ai-agents.mdx
Register the new page in the Messaging nav group (docs.json)

Description

Related Issue(s)

Type of Change

Checklist

I have read the CONTRIBUTING document
My branch name follows the naming convention
My changes follow the documentation style guide
I have checked for spelling and grammar errors
All links in my changes are valid and working
My changes are accurately described in this pull request

Additional Information

Screenshots (if applicable)

Add a dedicated JavaScript SDK "Card Messages" page covering the three receive-only card mechanisms: standalone CardMessage (onCardMessageReceived), inline cards on AIAssistantMessage via getElements()/AIAssistantElement, and real-time card streaming events (card_start/card/card_end) on the AIAssistantListener. - Add sdk/javascript/card-messages.mdx with TS + JS receive/render examples - Add reference entries for CardMessage, AIAssistantElement, the elements accessor on AIAssistantMessage, and the three card events (messages.mdx) - Add onCardMessageReceived + card-events note to all-real-time-listeners.mdx - Add the card category to message-structure-and-hierarchy.mdx - Cross-link card handling from ai-agents.mdx - Register the new page in the Messaging nav group (docs.json) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

mintlify · 2026-07-02T16:08:56Z

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
cometchat	🟢 Ready	View Preview	Jul 2, 2026, 4:12 PM

…verability Align the JS SDK card-message docs with the parallel React Native card docs after cross-referencing that branch: - Explain cards are authored server-side via the Platform (REST) API or Dashboard Bubble Builder (receive-only), with a link to the REST reference - Point to the CometChat Cards renderer (@cometchat/cards-react → CometChatCardView) and Campaigns "Rendering Cards" / "Supported Card Actions"; adopt the shared "Card Schema JSON" terminology - Document getTags() on CardMessage (page + reference) - Add a receive-only "Card Message" section to send-message.mdx so devs looking to send a card learn it must be created server-side - Note that a card-only assistant reply may have empty getText(), so prefer getElements() Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

jitvarpatil · 2026-07-06T07:03:42Z

Docs review — ✅ Approve

JavaScript SDK card-messages docs — a new card-messages.mdx (385 lines) + SDK reference additions + listener/hierarchy updates (7 files, +504/-1). Nearly all-new content, no deletions → no redirect risk. I verified the entire JS card API against the matching SDK branch (ENG-36071-implement-card-messages-receive-only-support) — all correct. Introduces 0 new broken links.

✅ Verified against the ENG-36071 SDK branch

CardMessage — extends BaseMessage, with getCard(): Object|undefined, getText(): string, getFallbackText(): string, getTags(): Array<String> — all match the docs.
onCardMessageReceived(message: CometChat.CardMessage) — real MessageListener callback (dispatched in WSConnectionHelper.ts:843); added correctly to the listener table and examples in all-real-time-listeners.mdx.
Card streaming events — AIAssistantCardStartedEvent, AIAssistantCardReceivedEvent, AIAssistantCardEndedEvent, and AIAssistantElement are each real exported classes; the reference-page accessors (getCard, getCardId, getExecutionText, streamMessageId, getType/getData) follow the SDK's getter convention and align with source (AIAssistantElement.getData() → { card, cardId }).
Content correctness: card-messages.mdx correctly states JS card support is receive-only; the sdk/reference/messages.mdx reference is comprehensive and consistent.
Structure: new card-messages.mdx wired into nav; 0 build breaks, 0 orphans. No placeholders/TODOs.

🟡 Note — pre-existing broken links (out of scope, not introduced here)

The analyzer flagged 4 broken calling links, all in pre-existing lines (0 in this PR's additions): /sdk/javascript/direct-call, /sdk/javascript/default-call, /sdk/javascript/standalone-calling (in all-real-time-listeners.mdx:629 and message-structure-and-hierarchy.mdx; the real page is /sdk/javascript/calling-overview), and /sdk/javascript/interactive-messages (in send-message.mdx). They don't block this PR, but worth a follow-up cleanup.

Ready to merge. 🚀

_{🤖 Automated docs review (Mintlify link/redirect/content checks + API verification against @cometchat/chat-sdk-javascript ENG-36071 branch).}

jitvarpatil

Docs review — ✅ Approve

JavaScript SDK card-messages docs — a new card-messages.mdx (385 lines) + SDK reference additions + listener/hierarchy updates (7 files, +504/-1). Nearly all-new content, no deletions → no redirect risk. I verified the entire JS card API against the matching SDK branch (ENG-36071-implement-card-messages-receive-only-support) — all correct. Introduces 0 new broken links.

✅ Verified against the ENG-36071 SDK branch

CardMessage — extends BaseMessage, with getCard(): Object|undefined, getText(): string, getFallbackText(): string, getTags(): Array<String> — all match the docs.
onCardMessageReceived(message: CometChat.CardMessage) — real MessageListener callback (dispatched in WSConnectionHelper.ts:843); added correctly to the listener table and examples in all-real-time-listeners.mdx.
Card streaming events — AIAssistantCardStartedEvent, AIAssistantCardReceivedEvent, AIAssistantCardEndedEvent, and AIAssistantElement are each real exported classes; the reference-page accessors (getCard, getCardId, getExecutionText, streamMessageId, getType/getData) follow the SDK's getter convention and align with source (AIAssistantElement.getData() → { card, cardId }).
Content correctness: card-messages.mdx correctly states JS card support is receive-only; the sdk/reference/messages.mdx reference is comprehensive and consistent.
Structure: new card-messages.mdx wired into nav; 0 build breaks, 0 orphans. No placeholders/TODOs.

🟡 Note — pre-existing broken links (out of scope, not introduced here)

The analyzer flagged 4 broken calling links, all in pre-existing lines (0 in this PR's additions): /sdk/javascript/direct-call, /sdk/javascript/default-call, /sdk/javascript/standalone-calling (in all-real-time-listeners.mdx:629 and message-structure-and-hierarchy.mdx; the real page is /sdk/javascript/calling-overview), and /sdk/javascript/interactive-messages (in send-message.mdx). They don't block this PR, but worth a follow-up cleanup.

Ready to merge. 🚀

_{🤖 Automated docs review (Mintlify link/redirect/content checks + API verification against @cometchat/chat-sdk-javascript ENG-36071 branch).}

…howCardUI Replace the undefined showCardUI placeholder (called with an inconsistent 2nd argument) across all six call sites with a single renderCardView helper that returns a real CometChatCardView render. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Keep card render code framework-neutral: examples stop at getCard()/the raw payload with a "pass it to your card renderer" comment, matching the RN SDK guides. Name the CometChat Cards renderer only in prose (React / Angular / vanilla @cometchat/cards) with reference links. Removes the invented renderCardView / showText / showCardPlaceholder / finalizeCard helpers so the snippets use only real SDK getters. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Point the React row in the render note at /ui-kit/react/v6/card-messages, matching the Angular row's /ui-kit/angular/guides/card-messages link so both frameworks reference their own UI Kit Card Messages guide. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Simplify the render note to reference the React and Angular UI Kit Card Messages guides only. Removes the npm package links and the vanilla @cometchat/cards bullet (no docs guide to point to). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Update the React row in the render note to /ui-kit/react/v7/card-messages (current React UI Kit major) instead of v6. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

aanshisingh-cometchat requested a review from raj-dubey1 July 2, 2026 15:50

aanshisingh-cometchat self-assigned this Jul 2, 2026

aanshisingh-cometchat requested a review from jitvarpatil as a code owner July 2, 2026 15:50

mintlify Bot deployed to staging July 2, 2026 16:12 View deployment

mintlify Bot deployed to staging July 3, 2026 06:42 View deployment

aanshisingh-cometchat requested review from adityagokula2210 and ketanyekale July 5, 2026 17:38

jitvarpatil previously approved these changes Jul 6, 2026

View reviewed changes

jitvarpatil mentioned this pull request Jul 6, 2026

docs(react): document Card Message rendering in the v7 UI Kit #421

Merged

11 tasks

aanshisingh-cometchat dismissed jitvarpatil’s stale review via 3d966ac July 6, 2026 09:21

mintlify Bot deployed to staging July 6, 2026 09:22 View deployment

mintlify Bot deployed to staging July 6, 2026 11:17 View deployment

mintlify Bot deployed to staging July 6, 2026 11:33 View deployment

mintlify Bot deployed to staging July 6, 2026 11:37 View deployment

raj-dubey1 previously approved these changes Jul 6, 2026

View reviewed changes

docs(js-sdk): point React card guide link to v7 UI Kit

de138aa

Update the React row in the render note to /ui-kit/react/v7/card-messages (current React UI Kit major) instead of v6. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

aanshisingh-cometchat dismissed raj-dubey1’s stale review via de138aa July 6, 2026 11:46

raj-dubey1 approved these changes Jul 6, 2026

View reviewed changes

mintlify Bot deployed to staging July 6, 2026 11:46 View deployment

adityagokula2210 approved these changes Jul 6, 2026

View reviewed changes

ketanyekale merged commit c381203 into main Jul 6, 2026
4 of 5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(js-sdk): document card message support (ENG-36071)#420

docs(js-sdk): document card message support (ENG-36071)#420
ketanyekale merged 7 commits into
mainfrom
feature/ENG-36071-js-sdk-card-messages-docs

aanshisingh-cometchat commented Jul 2, 2026

Uh oh!

mintlify Bot commented Jul 2, 2026 •

edited

Loading

Uh oh!

jitvarpatil commented Jul 6, 2026

Uh oh!

jitvarpatil left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

aanshisingh-cometchat commented Jul 2, 2026

Description

Related Issue(s)

Type of Change

Checklist

Additional Information

Screenshots (if applicable)

Uh oh!

mintlify Bot commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jitvarpatil commented Jul 6, 2026

Docs review — ✅ Approve

✅ Verified against the ENG-36071 SDK branch

🟡 Note — pre-existing broken links (out of scope, not introduced here)

Uh oh!

jitvarpatil left a comment

Choose a reason for hiding this comment

Docs review — ✅ Approve

✅ Verified against the ENG-36071 SDK branch

🟡 Note — pre-existing broken links (out of scope, not introduced here)

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

mintlify Bot commented Jul 2, 2026 •

edited

Loading