@cometchat/skills-cli 2.4.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/README.md +45 -37
  2. package/dist/index.js +1821 -13090
  3. package/dist/utils/error-dictionary.js +0 -69
  4. package/package.json +10 -12
  5. package/dist/registry/schemas/config.schema.json +0 -119
  6. package/dist/registry/schemas/template.schema.json +0 -142
  7. package/dist/registry/v6/experiences/1-conversation-list/astro.template.json +0 -89
  8. package/dist/registry/v6/experiences/1-conversation-list/nextjs-pages.template.json +0 -83
  9. package/dist/registry/v6/experiences/1-conversation-list/nextjs.template.json +0 -83
  10. package/dist/registry/v6/experiences/1-conversation-list/react-router.template.json +0 -102
  11. package/dist/registry/v6/experiences/1-conversation-list/reactjs-dedicated-route.template.json +0 -81
  12. package/dist/registry/v6/experiences/1-conversation-list/reactjs.template.json +0 -86
  13. package/dist/registry/v6/experiences/1-conversation-list/templates/astro/ChatApp.css.tpl +0 -43
  14. package/dist/registry/v6/experiences/1-conversation-list/templates/astro/ChatApp.tsx.tpl +0 -86
  15. package/dist/registry/v6/experiences/1-conversation-list/templates/astro/CometChatSelector.tsx.tpl +0 -40
  16. package/dist/registry/v6/experiences/1-conversation-list/templates/astro/chat.astro.tpl +0 -17
  17. package/dist/registry/v6/experiences/1-conversation-list/templates/nextjs/CometChatNoSSR.css.tpl +0 -43
  18. package/dist/registry/v6/experiences/1-conversation-list/templates/nextjs/CometChatNoSSR.tsx.tpl +0 -86
  19. package/dist/registry/v6/experiences/1-conversation-list/templates/nextjs/CometChatSelector.tsx.tpl +0 -41
  20. package/dist/registry/v6/experiences/1-conversation-list/templates/nextjs/chat-page.tsx.tpl +0 -11
  21. package/dist/registry/v6/experiences/1-conversation-list/templates/nextjs-pages/CometChatNoSSR.css.tpl +0 -43
  22. package/dist/registry/v6/experiences/1-conversation-list/templates/nextjs-pages/CometChatNoSSR.tsx.tpl +0 -88
  23. package/dist/registry/v6/experiences/1-conversation-list/templates/nextjs-pages/CometChatSelector.tsx.tpl +0 -41
  24. package/dist/registry/v6/experiences/1-conversation-list/templates/nextjs-pages/chat-page.tsx.tpl +0 -15
  25. package/dist/registry/v6/experiences/1-conversation-list/templates/react-router/CometChat-route.tsx.tpl +0 -22
  26. package/dist/registry/v6/experiences/1-conversation-list/templates/react-router/CometChatNoSSR.css.tpl +0 -43
  27. package/dist/registry/v6/experiences/1-conversation-list/templates/react-router/CometChatNoSSR.tsx.tpl +0 -87
  28. package/dist/registry/v6/experiences/1-conversation-list/templates/react-router/CometChatSelector.tsx.tpl +0 -40
  29. package/dist/registry/v6/experiences/1-conversation-list/templates/reactjs/App.css.tpl +0 -40
  30. package/dist/registry/v6/experiences/1-conversation-list/templates/reactjs/App.tsx.tpl +0 -55
  31. package/dist/registry/v6/experiences/1-conversation-list/templates/reactjs/CometChatSelector.tsx.tpl +0 -40
  32. package/dist/registry/v6/experiences/1-conversation-list/templates/reactjs/main.tsx.tpl +0 -46
  33. package/dist/registry/v6/experiences/1-conversation-list/templates/reactjs-dedicated-route/ChatPage.tsx.tpl +0 -87
  34. package/dist/registry/v6/experiences/1-conversation-list/templates/reactjs-dedicated-route/CometChatMessenger.css.tpl +0 -20
  35. package/dist/registry/v6/experiences/1-conversation-list/templates/reactjs-dedicated-route/CometChatMessenger.tsx.tpl +0 -54
  36. package/dist/registry/v6/experiences/1-conversation-list/templates/reactjs-dedicated-route/CometChatSelector.tsx.tpl +0 -40
  37. package/dist/registry/v6/experiences/2-one-to-one/astro.template.json +0 -81
  38. package/dist/registry/v6/experiences/2-one-to-one/nextjs.template.json +0 -77
  39. package/dist/registry/v6/experiences/2-one-to-one/react-router.template.json +0 -93
  40. package/dist/registry/v6/experiences/2-one-to-one/reactjs-dedicated-route.template.json +0 -75
  41. package/dist/registry/v6/experiences/2-one-to-one/reactjs.template.json +0 -80
  42. package/dist/registry/v6/experiences/2-one-to-one/templates/astro/ChatApp.css.tpl +0 -21
  43. package/dist/registry/v6/experiences/2-one-to-one/templates/astro/ChatApp.tsx.tpl +0 -66
  44. package/dist/registry/v6/experiences/2-one-to-one/templates/astro/chat.astro.tpl +0 -17
  45. package/dist/registry/v6/experiences/2-one-to-one/templates/nextjs/CometChatNoSSR.css.tpl +0 -21
  46. package/dist/registry/v6/experiences/2-one-to-one/templates/nextjs/CometChatNoSSR.tsx.tpl +0 -66
  47. package/dist/registry/v6/experiences/2-one-to-one/templates/nextjs/chat-page.tsx.tpl +0 -11
  48. package/dist/registry/v6/experiences/2-one-to-one/templates/react-router/CometChat-route.tsx.tpl +0 -21
  49. package/dist/registry/v6/experiences/2-one-to-one/templates/react-router/CometChatNoSSR.css.tpl +0 -21
  50. package/dist/registry/v6/experiences/2-one-to-one/templates/react-router/CometChatNoSSR.tsx.tpl +0 -67
  51. package/dist/registry/v6/experiences/2-one-to-one/templates/reactjs/App.css.tpl +0 -4
  52. package/dist/registry/v6/experiences/2-one-to-one/templates/reactjs/App.tsx.tpl +0 -44
  53. package/dist/registry/v6/experiences/2-one-to-one/templates/reactjs/main.tsx.tpl +0 -46
  54. package/dist/registry/v6/experiences/2-one-to-one/templates/reactjs-dedicated-route/ChatPage.tsx.tpl +0 -84
  55. package/dist/registry/v6/experiences/2-one-to-one/templates/reactjs-dedicated-route/CometChatMessenger.css.tpl +0 -9
  56. package/dist/registry/v6/experiences/2-one-to-one/templates/reactjs-dedicated-route/CometChatMessenger.tsx.tpl +0 -43
  57. package/dist/registry/v6/experiences/3-tab-based/astro.template.json +0 -93
  58. package/dist/registry/v6/experiences/3-tab-based/nextjs.template.json +0 -90
  59. package/dist/registry/v6/experiences/3-tab-based/react-router.template.json +0 -105
  60. package/dist/registry/v6/experiences/3-tab-based/reactjs-dedicated-route.template.json +0 -89
  61. package/dist/registry/v6/experiences/3-tab-based/reactjs.template.json +0 -93
  62. package/dist/registry/v6/experiences/3-tab-based/templates/astro/ChatApp.css.tpl +0 -39
  63. package/dist/registry/v6/experiences/3-tab-based/templates/astro/ChatApp.tsx.tpl +0 -93
  64. package/dist/registry/v6/experiences/3-tab-based/templates/astro/CometChatTabs.css.tpl +0 -43
  65. package/dist/registry/v6/experiences/3-tab-based/templates/astro/CometChatTabs.tsx.tpl +0 -72
  66. package/dist/registry/v6/experiences/3-tab-based/templates/astro/chat.astro.tpl +0 -17
  67. package/dist/registry/v6/experiences/3-tab-based/templates/nextjs/CometChatNoSSR.css.tpl +0 -39
  68. package/dist/registry/v6/experiences/3-tab-based/templates/nextjs/CometChatNoSSR.tsx.tpl +0 -93
  69. package/dist/registry/v6/experiences/3-tab-based/templates/nextjs/CometChatTabs.css.tpl +0 -43
  70. package/dist/registry/v6/experiences/3-tab-based/templates/nextjs/CometChatTabs.tsx.tpl +0 -73
  71. package/dist/registry/v6/experiences/3-tab-based/templates/nextjs/chat-page.tsx.tpl +0 -11
  72. package/dist/registry/v6/experiences/3-tab-based/templates/react-router/CometChat-route.tsx.tpl +0 -21
  73. package/dist/registry/v6/experiences/3-tab-based/templates/react-router/CometChatNoSSR.css.tpl +0 -39
  74. package/dist/registry/v6/experiences/3-tab-based/templates/react-router/CometChatNoSSR.tsx.tpl +0 -94
  75. package/dist/registry/v6/experiences/3-tab-based/templates/react-router/CometChatTabs.css.tpl +0 -43
  76. package/dist/registry/v6/experiences/3-tab-based/templates/react-router/CometChatTabs.tsx.tpl +0 -72
  77. package/dist/registry/v6/experiences/3-tab-based/templates/reactjs/App.css.tpl +0 -7
  78. package/dist/registry/v6/experiences/3-tab-based/templates/reactjs/App.tsx.tpl +0 -62
  79. package/dist/registry/v6/experiences/3-tab-based/templates/reactjs/CometChatTabs.css.tpl +0 -43
  80. package/dist/registry/v6/experiences/3-tab-based/templates/reactjs/CometChatTabs.tsx.tpl +0 -72
  81. package/dist/registry/v6/experiences/3-tab-based/templates/reactjs/main.tsx.tpl +0 -46
  82. package/dist/registry/v6/experiences/3-tab-based/templates/reactjs-dedicated-route/ChatPage.tsx.tpl +0 -84
  83. package/dist/registry/v6/experiences/3-tab-based/templates/reactjs-dedicated-route/CometChatMessenger.css.tpl +0 -11
  84. package/dist/registry/v6/experiences/3-tab-based/templates/reactjs-dedicated-route/CometChatMessenger.tsx.tpl +0 -61
  85. package/dist/registry/v6/experiences/3-tab-based/templates/reactjs-dedicated-route/CometChatTabs.css.tpl +0 -43
  86. package/dist/registry/v6/experiences/3-tab-based/templates/reactjs-dedicated-route/CometChatTabs.tsx.tpl +0 -72
  87. package/dist/registry/v6/features/catalog.json +0 -990
  88. package/dist/registry/v6/production/astro/cometchat-token.ts.tpl +0 -86
  89. package/dist/registry/v6/production/astro.template.json +0 -51
  90. package/dist/registry/v6/production/nextjs/route.ts.tpl +0 -79
  91. package/dist/registry/v6/production/nextjs.template.json +0 -50
  92. package/dist/registry/v6/production/react-router/api.cometchat-token.ts.tpl +0 -73
  93. package/dist/registry/v6/production/react-router.template.json +0 -58
  94. package/dist/registry/v6/user-mgmt/astro/cometchat-user.ts.tpl +0 -164
  95. package/dist/registry/v6/user-mgmt/astro.template.json +0 -33
  96. package/dist/registry/v6/user-mgmt/nextjs/route.ts.tpl +0 -212
  97. package/dist/registry/v6/user-mgmt/nextjs.template.json +0 -57
  98. package/dist/registry/v6/user-mgmt/react-router/api.cometchat-user.ts.tpl +0 -176
  99. package/dist/registry/v6/user-mgmt/react-router.template.json +0 -40
  100. package/dist/registry/v6/widget/astro/CometChatWidget.css.tpl +0 -105
  101. package/dist/registry/v6/widget/astro/CometChatWidget.tsx.tpl +0 -88
  102. package/dist/registry/v6/widget/astro.template.json +0 -38
  103. package/dist/registry/v6/widget/nextjs/CometChatWidget.css.tpl +0 -105
  104. package/dist/registry/v6/widget/nextjs/CometChatWidget.tsx.tpl +0 -88
  105. package/dist/registry/v6/widget/nextjs.template.json +0 -40
  106. package/dist/registry/v6/widget/react-router/CometChatWidget.css.tpl +0 -105
  107. package/dist/registry/v6/widget/react-router/CometChatWidget.tsx.tpl +0 -98
  108. package/dist/registry/v6/widget/react-router.template.json +0 -36
  109. package/dist/registry/v6/widget/reactjs/CometChatWidget.css.tpl +0 -105
  110. package/dist/registry/v6/widget/reactjs/CometChatWidget.tsx.tpl +0 -89
  111. package/dist/registry/v6/widget/reactjs.template.json +0 -36
@@ -1,990 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "version": "1.0.0",
4
- "sdk_compatibility": ">=6.0.0 <7.0.0",
5
- "description": "Catalog of CometChat features available in the React UI Kit. Categorized by what work is needed to enable each one. NOTE: this catalog stores OUR taxonomy (default vs dashboard-toggle vs package-install vs component-swap) plus a `dashboard_path` HINT for navigation. The hint is short and intentionally fragile — the canonical source is always the docs URL constructed from `docs_topic`. Agents must query the cometchat-docs MCP at runtime for current dashboard navigation, prop signatures, builder methods, and SDK reference. This catalog is for routing, not for SDK reference.",
6
- "feature_types": {
7
- "default": "Already enabled by default in the UI Kit components your integration uses. Zero code changes needed — the skill just shows you which component renders it.",
8
- "extension": "Pure boolean toggle on a backend extension. The CLI's `apply-feature` command calls POST /apps/{appId}/extensions to enable, no further config needed. Some have their UI decorator auto-attached by the UI Kit (auto_wired_in_uikit: true). Others additionally require passing the extension to UIKitSettingsBuilder.setExtensions([...]) before init.",
9
- "ai-feature": "Backend AI feature toggle. Requires an OpenAI API key (PUT /apps/{appId}/ai/settings) before the feature can be enabled (POST /apps/{appId}/features/ai.{ai_key}/enabled). The CLI prompts for the key once, stores it on the app's settings, then enables the feature. The `ai_key` field is the API suffix.",
10
- "dashboard-only": "Requires entering third-party config the user has to fetch themselves (Giphy/Stipop/Tenor API key, Chatwoot webhook URL, Intercom token, etc.) or making a multi-field configuration choice (Disappearing Messages interval, Message Shortcuts list). The CLI cannot automate these — falls back to opening the dashboard. `dashboard_path` is load-bearing for these entries.",
11
- "package-install": "Requires installing an additional npm package. The UI Kit's initiateAfterLogin() auto-calls enableCalling() which detects the calls SDK and wires up call buttons. Currently calls only.",
12
- "component-swap": "Requires replacing one UI Kit component with a drop-in variant. One-line change. The SDK currently ships exactly one such variant (CometChatCompactMessageComposer for rich text formatting); more variants will become catalog entries here as the SDK adds them.",
13
- "moderation": "⚠️ LEGACY moderation extension (config payload: keyword lists, sensitivity, thresholds, quarantine action). The CLI's `apply-feature` POSTs to /apps/{appId}/extensions/{id}/config + enable. **DEPRECATED in favor of Rules Management** — the canonical moderation system (Dashboard → Moderation → Settings → Rules, or the /moderation/rules REST API: rules, keywords, reasons, blocked/flagged/reviewed-messages). Rules auto-apply to all messages with NO client code. CONFLICT: do NOT run a legacy moderation extension AND Rules on the same app — each message gets processed twice (delays + perf issues); disable the legacy extension first. See docs/moderation/overview.",
14
- "calls-feature": "Calls SDK feature configured via CallSettingsBuilder (no backend toggle, no extension). The CLI's `apply-feature` command verifies the calls SDK is installed and points the agent at the matching per-family reference doc (e.g. `cometchat-react-calls/references/raise-hand.md`). The `reference_topic` field maps to the file slug; the `settings_flag` field is the CallSettingsBuilder method involved. Idempotency: persisted in state.applied_features."
15
- },
16
- "tiers": {
17
- "1": "Core Messaging (Zero Setup) — out of the box, no config or code (e.g. Typing Indicators).",
18
- "2": "Builder-Enabled (Config + UI Toggle) — enable via Dashboard API; toggleable/placeable in the UI Kit Builder / Widget Builder (e.g. Polls).",
19
- "3": "Config-Only (Dashboard-Driven) — enable via Dashboard API; works automatically, no UI or code (e.g. Link Preview).",
20
- "4": "Config + Settings (Smart) — enable via Dashboard API + additional dashboard settings (API keys, rules, thresholds); no client code (e.g. Smart Replies).",
21
- "5": "SDK-Integrated (Config + Code) — enable via Dashboard API + custom client code. THE IMPLEMENTATION IS IN THE DOCS (`docs_topic`) — fetch and wire it, do not hand-roll (e.g. Bitly).",
22
- "_comment": "The product's canonical 5-category model (the 'Feature Availability' matrix — columns API Call / Code / Additional Settings are the operative truth, captured per-feature as enable_api(implied by type)/code/dashboard_settings/builder). `feature_types` above is the CLI's enablement MECHANISM; `tier` is the customer-facing WORK-NEEDED category."
23
- },
24
- "code_legend": {
25
- "_comment": "Per-feature `code` field = what client work is needed (from the matrix's Code column).",
26
- "none": "No client code — the UI Kit renders it automatically once enabled (auto_wired_in_uikit:true).",
27
- "stitch-components": "No extension code, but you COMPOSE existing kit components to surface it — see the kit sample apps for the wiring.",
28
- "steps-in-docs": "Follow the documented steps at `docs_topic` to wire it client-side.",
29
- "custom-code": "Substantial custom implementation — the reference code lives at `docs_topic`; fetch and adapt it."
30
- },
31
- "features": [
32
- {
33
- "id": "instant-messaging",
34
- "name": "Instant Messaging",
35
- "type": "default",
36
- "description": "Real-time text messaging via CometChatMessageList + CometChatMessageComposer. The core of every chat experience.",
37
- "components": [
38
- "CometChatMessageList",
39
- "CometChatMessageComposer"
40
- ],
41
- "docs_topic": "core-features#instant-messaging",
42
- "tier": 1,
43
- "code": "none",
44
- "builder": "toggle",
45
- "dashboard_settings": null
46
- },
47
- {
48
- "id": "media-sharing",
49
- "name": "Media Sharing",
50
- "type": "default",
51
- "description": "Send images, videos, audio, and documents within conversations. Built into CometChatMessageComposer's ActionSheet.",
52
- "components": [
53
- "CometChatMessageComposer"
54
- ],
55
- "docs_topic": "core-features#media-sharing",
56
- "tier": 1,
57
- "code": "none",
58
- "builder": "toggle",
59
- "dashboard_settings": null
60
- },
61
- {
62
- "id": "read-receipts",
63
- "name": "Read Receipts",
64
- "type": "default",
65
- "description": "See when messages have been delivered and read. Visible in message bubbles and the Conversations list.",
66
- "components": [
67
- "CometChatMessageList",
68
- "CometChatConversations"
69
- ],
70
- "docs_topic": "core-features#read-receipts",
71
- "tier": 1,
72
- "code": "none",
73
- "builder": "toggle",
74
- "dashboard_settings": null
75
- },
76
- {
77
- "id": "mark-as-unread",
78
- "name": "Mark as Unread",
79
- "type": "default",
80
- "description": "Manually mark conversations or messages as unread.",
81
- "components": [
82
- "CometChatMessageList"
83
- ],
84
- "docs_topic": "core-features#mark-as-unread",
85
- "tier": 1,
86
- "code": "none",
87
- "builder": "toggle",
88
- "dashboard_settings": null
89
- },
90
- {
91
- "id": "typing-indicator",
92
- "name": "Typing Indicator",
93
- "type": "default",
94
- "description": "Real-time typing awareness. Shows in CometChatMessageHeader and CometChatConversations.",
95
- "components": [
96
- "CometChatMessageHeader",
97
- "CometChatConversations"
98
- ],
99
- "docs_topic": "core-features#typing-indicator",
100
- "tier": 1,
101
- "code": "none",
102
- "builder": "toggle",
103
- "dashboard_settings": null
104
- },
105
- {
106
- "id": "user-presence",
107
- "name": "User Presence",
108
- "type": "default",
109
- "description": "Online/offline status across Conversations, Message Header, Users, and Group Members.",
110
- "components": [
111
- "CometChatConversations",
112
- "CometChatMessageHeader",
113
- "CometChatUsers",
114
- "CometChatGroupMembers"
115
- ],
116
- "docs_topic": "core-features#user-presence",
117
- "tier": 1,
118
- "code": "none",
119
- "builder": "toggle",
120
- "dashboard_settings": null
121
- },
122
- {
123
- "id": "reactions",
124
- "name": "Reactions",
125
- "type": "default",
126
- "description": "React to messages with emojis without typing a full response.",
127
- "components": [
128
- "CometChatMessageList"
129
- ],
130
- "docs_topic": "core-features#reactions",
131
- "tier": 1,
132
- "code": "none",
133
- "builder": "toggle",
134
- "dashboard_settings": null
135
- },
136
- {
137
- "id": "mentions",
138
- "name": "Mentions",
139
- "type": "default",
140
- "description": "Address specific users with @username, including @all for groups.",
141
- "components": [
142
- "CometChatMessageComposer",
143
- "CometChatMessageList"
144
- ],
145
- "docs_topic": "core-features#mentions",
146
- "tier": 1,
147
- "code": "none",
148
- "builder": "toggle",
149
- "dashboard_settings": null
150
- },
151
- {
152
- "id": "threaded-conversations",
153
- "name": "Threaded Conversations",
154
- "type": "default",
155
- "description": "Reply to specific messages in a thread, keeping conversations organized.",
156
- "components": [
157
- "CometChatMessageList",
158
- "CometChatThreadHeader"
159
- ],
160
- "docs_topic": "core-features#threaded-conversations",
161
- "tier": 1,
162
- "code": "stitch-components",
163
- "builder": "toggle",
164
- "dashboard_settings": null
165
- },
166
- {
167
- "id": "quoted-replies",
168
- "name": "Quoted Replies",
169
- "type": "default",
170
- "description": "Quote a specific message when replying to maintain context.",
171
- "components": [
172
- "CometChatMessageComposer",
173
- "CometChatMessageList"
174
- ],
175
- "docs_topic": "core-features#quoted-replies",
176
- "tier": 1,
177
- "code": "none",
178
- "builder": "toggle",
179
- "dashboard_settings": null
180
- },
181
- {
182
- "id": "group-chat",
183
- "name": "Group Chat",
184
- "type": "default",
185
- "description": "Multi-participant conversations via CometChatGroups.",
186
- "components": [
187
- "CometChatGroups"
188
- ],
189
- "docs_topic": "core-features#group-chat",
190
- "tier": 1,
191
- "code": "none",
192
- "builder": "toggle",
193
- "dashboard_settings": null
194
- },
195
- {
196
- "id": "report-message",
197
- "name": "Report Message",
198
- "type": "default",
199
- "description": "Users can flag inappropriate messages with predefined reasons.",
200
- "components": [
201
- "CometChatMessageList"
202
- ],
203
- "docs_topic": "core-features#report-message",
204
- "tier": 1,
205
- "code": "none",
206
- "builder": "toggle",
207
- "dashboard_settings": null
208
- },
209
- {
210
- "id": "search",
211
- "name": "Conversation and Advanced Search",
212
- "type": "default",
213
- "description": "Full-text search across conversations, messages, and media.",
214
- "components": [
215
- "CometChatSearch"
216
- ],
217
- "docs_topic": "core-features#search",
218
- "tier": 1,
219
- "code": "stitch-components",
220
- "builder": "toggle",
221
- "dashboard_settings": null
222
- },
223
- {
224
- "id": "moderation",
225
- "name": "Moderation (overview)",
226
- "type": "default",
227
- "description": "Umbrella entry. The CANONICAL moderation system is **Rules Management** — Dashboard → Moderation → Settings → Rules (or the /moderation/rules REST API: rules, keywords, reasons, blocked/flagged/reviewed-messages). Configure rules once; they auto-apply to every message with NO client code (UI Kit/SDK handle it). The seven entries below (profanity-filter, image-moderation, data-masking, sentiment-analysis, xss-filter, slow-mode, virus-malware-scanner) are the **LEGACY extensions** — still toggle-able but deprecated. ⚠️ Never run a legacy extension AND Rules on the same app: each message is processed twice (delays + perf). Prefer Rules; if migrating, disable the legacy extensions first. Docs: moderation/overview + moderation/rules-management.",
228
- "components": [
229
- "CometChatMessageList"
230
- ],
231
- "docs_topic": "core-features#moderation"
232
- },
233
- {
234
- "id": "profanity-filter",
235
- "name": "Profanity Filter",
236
- "type": "moderation",
237
- "extension_id": "profanity-filter",
238
- "description": "Detects and filters profane language from messages. Replaces matched words with asterisks or rejects the message outright.",
239
- "components": [
240
- "CometChatMessageList",
241
- "CometChatMessageComposer"
242
- ],
243
- "config_schema": {
244
- "case_sensitivity": {
245
- "type": "enum",
246
- "values": [
247
- "case-sensitive",
248
- "case-insensitive"
249
- ],
250
- "default": "case-insensitive",
251
- "prompt": "Case sensitivity for keyword matching?"
252
- },
253
- "filter_profanities_for": {
254
- "type": "enum",
255
- "values": [
256
- "all",
257
- "specific-roles"
258
- ],
259
- "default": "all",
260
- "prompt": "Apply filter to all users or specific roles?"
261
- },
262
- "specific_roles": {
263
- "type": "array<string>",
264
- "when": {
265
- "filter_profanities_for": "specific-roles"
266
- },
267
- "prompt": "Comma-separated role names"
268
- },
269
- "profane_words": {
270
- "type": "array<string>",
271
- "default": [],
272
- "prompt": "Custom words to add to the profanity list (comma-separated; empty for default list only)"
273
- },
274
- "white_listed_words": {
275
- "type": "array<string>",
276
- "default": [],
277
- "prompt": "Words to whitelist that would otherwise match (comma-separated)"
278
- },
279
- "rule": {
280
- "type": "enum",
281
- "values": [
282
- "mask",
283
- "drop",
284
- "tag"
285
- ],
286
- "default": "mask",
287
- "prompt": "What to do with matched messages? (mask: replace with ****, drop: reject, tag: deliver but flag)"
288
- }
289
- },
290
- "docs_topic": "moderation/rules-management"
291
- },
292
- {
293
- "id": "image-moderation",
294
- "name": "Image Moderation",
295
- "type": "moderation",
296
- "extension_id": "image-moderation",
297
- "description": "Detects unsafe content in images (NSFW, violence, etc.) using ML-based classification. Configurable confidence thresholds.",
298
- "components": [
299
- "CometChatMessageList"
300
- ],
301
- "config_schema": {
302
- "explicit_threshold": {
303
- "type": "number",
304
- "min": 0,
305
- "max": 100,
306
- "default": 70,
307
- "prompt": "Threshold for explicit content (0-100; lower = stricter)"
308
- },
309
- "suggestive_threshold": {
310
- "type": "number",
311
- "min": 0,
312
- "max": 100,
313
- "default": 70,
314
- "prompt": "Threshold for suggestive content"
315
- },
316
- "violence_threshold": {
317
- "type": "number",
318
- "min": 0,
319
- "max": 100,
320
- "default": 70,
321
- "prompt": "Threshold for violent content"
322
- },
323
- "drugs_threshold": {
324
- "type": "number",
325
- "min": 0,
326
- "max": 100,
327
- "default": 70,
328
- "prompt": "Threshold for drug-related content"
329
- },
330
- "rule": {
331
- "type": "enum",
332
- "values": [
333
- "block",
334
- "blur",
335
- "tag"
336
- ],
337
- "default": "blur",
338
- "prompt": "Action for flagged images?"
339
- }
340
- },
341
- "docs_topic": "moderation/rules-management"
342
- },
343
- {
344
- "id": "data-masking",
345
- "name": "Data Masking",
346
- "type": "moderation",
347
- "extension_id": "data-masking",
348
- "description": "Masks PII (phone numbers, email addresses, credit cards, SSNs) in messages. Critical for healthcare, fintech, marketplace apps.",
349
- "components": [
350
- "CometChatMessageList"
351
- ],
352
- "config_schema": {
353
- "mask_phone": {
354
- "type": "boolean",
355
- "default": true,
356
- "prompt": "Mask phone numbers?"
357
- },
358
- "mask_email": {
359
- "type": "boolean",
360
- "default": true,
361
- "prompt": "Mask email addresses?"
362
- },
363
- "mask_ssn": {
364
- "type": "boolean",
365
- "default": false,
366
- "prompt": "Mask US Social Security Numbers?"
367
- },
368
- "mask_credit_card": {
369
- "type": "boolean",
370
- "default": true,
371
- "prompt": "Mask credit card numbers?"
372
- },
373
- "custom_patterns": {
374
- "type": "array<{name:string,regex:string}>",
375
- "default": [],
376
- "prompt": "Custom regex patterns to mask (e.g. internal IDs)"
377
- },
378
- "rule": {
379
- "type": "enum",
380
- "values": [
381
- "mask",
382
- "drop",
383
- "tag"
384
- ],
385
- "default": "mask",
386
- "prompt": "Action for messages containing matched data?"
387
- }
388
- },
389
- "docs_topic": "moderation/overview"
390
- },
391
- {
392
- "id": "sentiment-analysis",
393
- "name": "Sentiment Analysis",
394
- "type": "moderation",
395
- "extension_id": "sentiment-analysis",
396
- "description": "Detects negative sentiment / toxicity in messages. Optionally surfaces a 'View confidently' confirm dialog before showing flagged messages.",
397
- "components": [
398
- "CometChatMessageList"
399
- ],
400
- "config_schema": {
401
- "threshold": {
402
- "type": "number",
403
- "min": 0,
404
- "max": 100,
405
- "default": 50,
406
- "prompt": "Sentiment threshold (0-100; lower = more aggressive)"
407
- },
408
- "rule": {
409
- "type": "enum",
410
- "values": [
411
- "confirm-view",
412
- "tag",
413
- "drop"
414
- ],
415
- "default": "confirm-view",
416
- "prompt": "Action for flagged messages?"
417
- }
418
- },
419
- "docs_topic": "moderation/rules-management"
420
- },
421
- {
422
- "id": "xss-filter",
423
- "name": "XSS Filter",
424
- "type": "moderation",
425
- "extension_id": "xss-filter",
426
- "description": "Strips HTML/script injection from messages before delivery. Critical for chat surfaces that render rich text.",
427
- "components": [
428
- "CometChatMessageList"
429
- ],
430
- "config_schema": {
431
- "strict_mode": {
432
- "type": "boolean",
433
- "default": true,
434
- "prompt": "Strict mode (blocks all HTML; safer)?"
435
- },
436
- "allowed_tags": {
437
- "type": "array<string>",
438
- "default": [
439
- "b",
440
- "i",
441
- "u",
442
- "strong",
443
- "em"
444
- ],
445
- "when": {
446
- "strict_mode": false
447
- },
448
- "prompt": "Allowed HTML tags (when strict mode off)"
449
- }
450
- },
451
- "docs_topic": "moderation/overview"
452
- },
453
- {
454
- "id": "slow-mode",
455
- "name": "Slow Mode",
456
- "type": "moderation",
457
- "extension_id": "slow-mode",
458
- "description": "Rate-limits how often a user can post in a conversation/group. Reduces spam in busy channels.",
459
- "components": [
460
- "CometChatMessageComposer"
461
- ],
462
- "config_schema": {
463
- "interval_seconds": {
464
- "type": "number",
465
- "min": 1,
466
- "max": 3600,
467
- "default": 5,
468
- "prompt": "Minimum seconds between messages from the same user"
469
- },
470
- "applies_to": {
471
- "type": "enum",
472
- "values": [
473
- "all",
474
- "groups-only",
475
- "specific-groups"
476
- ],
477
- "default": "groups-only",
478
- "prompt": "Apply slow mode where?"
479
- },
480
- "specific_group_ids": {
481
- "type": "array<string>",
482
- "when": {
483
- "applies_to": "specific-groups"
484
- },
485
- "prompt": "Group IDs (comma-separated)"
486
- }
487
- },
488
- "docs_topic": "moderation/overview"
489
- },
490
- {
491
- "id": "virus-malware-scanner",
492
- "name": "Virus / Malware Scanner",
493
- "type": "moderation",
494
- "extension_id": "virus-malware-scanner",
495
- "description": "Scans uploaded files (images, documents, archives) for malware before delivery. Required for healthcare, legal, finance apps.",
496
- "components": [
497
- "CometChatMessageList",
498
- "CometChatMessageComposer"
499
- ],
500
- "config_schema": {
501
- "scan_images": {
502
- "type": "boolean",
503
- "default": true,
504
- "prompt": "Scan image uploads?"
505
- },
506
- "scan_documents": {
507
- "type": "boolean",
508
- "default": true,
509
- "prompt": "Scan document uploads (.pdf, .docx, etc.)?"
510
- },
511
- "scan_archives": {
512
- "type": "boolean",
513
- "default": true,
514
- "prompt": "Scan archive uploads (.zip, .tar.gz)?"
515
- },
516
- "rule": {
517
- "type": "enum",
518
- "values": [
519
- "block",
520
- "quarantine",
521
- "tag"
522
- ],
523
- "default": "block",
524
- "prompt": "Action when malware detected?"
525
- }
526
- },
527
- "docs_topic": "moderation/rules-management"
528
- },
529
- {
530
- "id": "bitly",
531
- "extension_id": "url-shortener-bitly",
532
- "name": "Bitly URL Shortening",
533
- "type": "extension",
534
- "description": "Automatically shorten long URLs in messages using Bitly.",
535
- "dashboard_path": "Chat & Messaging → Features → Bitly → Toggle on",
536
- "docs_topic": "extensions#bitly",
537
- "tier": 5,
538
- "code": "custom-code",
539
- "builder": "code",
540
- "dashboard_settings": "Configure Bitly Key from Dashboard",
541
- "auto_wired_in_uikit": false
542
- },
543
- {
544
- "id": "link-preview",
545
- "name": "Link Preview",
546
- "type": "extension",
547
- "auto_wired_in_uikit": true,
548
- "description": "Show URL previews with title, description, and thumbnail. UI decorator auto-attached by the UI Kit (in defaultExtensions[]).",
549
- "dashboard_path": "Chat & Messaging → Features → Link Preview → Toggle on",
550
- "docs_topic": "extensions#link-preview",
551
- "tier": 2,
552
- "code": "none",
553
- "builder": "toggle",
554
- "dashboard_settings": null
555
- },
556
- {
557
- "id": "message-shortcuts",
558
- "name": "Message Shortcuts",
559
- "type": "dashboard-only",
560
- "description": "Expand predefined short codes into full messages.",
561
- "dashboard_path": "Chat & Messaging → Features → Message Shortcuts → Configure shortcuts",
562
- "docs_topic": "extensions#message-shortcuts",
563
- "tier": 5,
564
- "code": "steps-in-docs",
565
- "builder": "code",
566
- "dashboard_settings": "Configure predefined templates at global level",
567
- "auto_wired_in_uikit": false
568
- },
569
- {
570
- "id": "pin-message",
571
- "name": "Pin Message",
572
- "type": "extension",
573
- "description": "Pin important messages for easy access.",
574
- "dashboard_path": "Chat & Messaging → Features → Pin Message → Toggle on",
575
- "docs_topic": "extensions#pin-message",
576
- "tier": 5,
577
- "code": "steps-in-docs",
578
- "builder": "code",
579
- "dashboard_settings": null,
580
- "auto_wired_in_uikit": false
581
- },
582
- {
583
- "id": "rich-media-preview",
584
- "extension_id": "rich-media",
585
- "name": "Rich Media Preview",
586
- "type": "extension",
587
- "description": "Generate rich preview panels for URLs via iFramely.",
588
- "dashboard_path": "Chat & Messaging → Features → Rich Media Preview → Toggle on",
589
- "docs_topic": "extensions#rich-media-preview",
590
- "tier": 5,
591
- "code": "custom-code",
592
- "builder": "code",
593
- "dashboard_settings": "API Key",
594
- "auto_wired_in_uikit": false
595
- },
596
- {
597
- "id": "save-message",
598
- "name": "Save Message",
599
- "type": "extension",
600
- "description": "Bookmark messages privately for later.",
601
- "dashboard_path": "Chat & Messaging → Features → Save Message → Toggle on",
602
- "docs_topic": "extensions#save-message",
603
- "tier": 5,
604
- "code": "custom-code",
605
- "builder": "code",
606
- "dashboard_settings": null,
607
- "auto_wired_in_uikit": false
608
- },
609
- {
610
- "id": "thumbnail-generation",
611
- "name": "Thumbnail Generation",
612
- "type": "extension",
613
- "auto_wired_in_uikit": true,
614
- "description": "Auto-generate thumbnails for shared media to reduce bandwidth. UI decorator auto-attached by the UI Kit (in defaultExtensions[]).",
615
- "dashboard_path": "Chat & Messaging → Features → Thumbnail Generation → Toggle on",
616
- "docs_topic": "extensions#thumbnail-generation",
617
- "tier": 2,
618
- "code": "none",
619
- "builder": "toggle",
620
- "dashboard_settings": null
621
- },
622
- {
623
- "id": "tinyurl",
624
- "extension_id": "url-shortener-tinyurl",
625
- "name": "TinyURL Shortening",
626
- "type": "extension",
627
- "description": "Shorten URLs using TinyURL service.",
628
- "dashboard_path": "Chat & Messaging → Features → TinyURL → Toggle on",
629
- "docs_topic": "extensions#tinyurl",
630
- "tier": 5,
631
- "code": "custom-code",
632
- "builder": "code",
633
- "dashboard_settings": "Configure Key on Dashboard",
634
- "auto_wired_in_uikit": false
635
- },
636
- {
637
- "id": "voice-transcription",
638
- "name": "Voice Transcription",
639
- "type": "extension",
640
- "description": "Convert audio messages to text automatically.",
641
- "dashboard_path": "Chat & Messaging → Features → Voice Transcription → Toggle on",
642
- "docs_topic": "extensions#voice-transcription",
643
- "tier": 5,
644
- "code": "custom-code",
645
- "builder": "code",
646
- "dashboard_settings": "Configure Key on Dashboard",
647
- "auto_wired_in_uikit": false
648
- },
649
- {
650
- "id": "giphy",
651
- "name": "Giphy GIFs",
652
- "type": "dashboard-only",
653
- "description": "Search and share GIFs from Giphy.",
654
- "dashboard_path": "Chat & Messaging → Features → Giphy → Configure API key",
655
- "docs_topic": "extensions#giphy",
656
- "tier": 5,
657
- "code": "custom-code",
658
- "builder": "code",
659
- "dashboard_settings": "Configure Key on Dashboard",
660
- "auto_wired_in_uikit": false
661
- },
662
- {
663
- "id": "message-translation",
664
- "name": "Message Translation",
665
- "type": "extension",
666
- "auto_wired_in_uikit": true,
667
- "description": "Translate messages into the user's locale. UI decorator auto-attached by the UI Kit (in defaultExtensions[]).",
668
- "dashboard_path": "Chat & Messaging → Features → Message Translation → Toggle on",
669
- "docs_topic": "extensions#message-translation",
670
- "tier": 2,
671
- "code": "none",
672
- "builder": "toggle",
673
- "dashboard_settings": null
674
- },
675
- {
676
- "id": "polls",
677
- "name": "Polls",
678
- "type": "extension",
679
- "auto_wired_in_uikit": true,
680
- "description": "Create polls in group discussions with preset answers. UI decorator auto-attached by the UI Kit (in defaultExtensions[]).",
681
- "dashboard_path": "Chat & Messaging → Features → Polls → Toggle on",
682
- "docs_topic": "extensions#polls",
683
- "tier": 2,
684
- "code": "none",
685
- "builder": "toggle",
686
- "dashboard_settings": null
687
- },
688
- {
689
- "id": "reminders",
690
- "name": "Reminders",
691
- "type": "extension",
692
- "description": "Set message reminders or personal notifications via bot.",
693
- "dashboard_path": "Chat & Messaging → Features → Reminders → Toggle on",
694
- "docs_topic": "extensions#reminders",
695
- "tier": 5,
696
- "code": "steps-in-docs",
697
- "builder": "code",
698
- "dashboard_settings": null,
699
- "auto_wired_in_uikit": false
700
- },
701
- {
702
- "id": "stickers",
703
- "name": "Stickers",
704
- "type": "extension",
705
- "auto_wired_in_uikit": true,
706
- "description": "Send pre-designed stickers in conversations. UI decorator auto-attached by the UI Kit (in defaultExtensions[]).",
707
- "dashboard_path": "Chat & Messaging → Features → Stickers → Toggle on",
708
- "docs_topic": "extensions#stickers",
709
- "tier": 4,
710
- "code": "none",
711
- "builder": "toggle",
712
- "dashboard_settings": "All the sticker need to be enable via API"
713
- },
714
- {
715
- "id": "stipop",
716
- "name": "Stipop Sticker Library",
717
- "type": "dashboard-only",
718
- "description": "Integrates the Stipop sticker library.",
719
- "dashboard_path": "Chat & Messaging → Features → Stipop → Configure API key",
720
- "docs_topic": "extensions#stipop",
721
- "tier": 5,
722
- "code": "custom-code",
723
- "builder": "code",
724
- "dashboard_settings": "Configure Key on Dashboard",
725
- "auto_wired_in_uikit": false
726
- },
727
- {
728
- "id": "tenor",
729
- "name": "Tenor GIFs",
730
- "type": "dashboard-only",
731
- "description": "Search and share GIFs from Tenor.",
732
- "dashboard_path": "Chat & Messaging → Features → Tenor → Configure API key",
733
- "docs_topic": "extensions#tenor",
734
- "tier": 5,
735
- "code": "custom-code",
736
- "builder": "code",
737
- "dashboard_settings": "Configure Key on Dashboard",
738
- "auto_wired_in_uikit": false
739
- },
740
- {
741
- "id": "collaborative-document",
742
- "extension_id": "document",
743
- "name": "Collaborative Document",
744
- "type": "extension",
745
- "auto_wired_in_uikit": true,
746
- "description": "Real-time shared document editing. UI decorator auto-attached by the UI Kit (in defaultExtensions[]).",
747
- "dashboard_path": "Chat & Messaging → Features → Collaborative Document → Toggle on",
748
- "docs_topic": "extensions#collaborative-document",
749
- "tier": 2,
750
- "code": "none",
751
- "builder": "toggle",
752
- "dashboard_settings": null
753
- },
754
- {
755
- "id": "collaborative-whiteboard",
756
- "extension_id": "whiteboard",
757
- "name": "Collaborative Whiteboard",
758
- "type": "extension",
759
- "auto_wired_in_uikit": true,
760
- "description": "Shared whiteboard for drawing and brainstorming. UI decorator auto-attached by the UI Kit (in defaultExtensions[]).",
761
- "dashboard_path": "Chat & Messaging → Features → Collaborative Whiteboard → Toggle on",
762
- "docs_topic": "extensions#collaborative-whiteboard",
763
- "tier": 2,
764
- "code": "none",
765
- "builder": "toggle",
766
- "dashboard_settings": null
767
- },
768
- {
769
- "id": "disappearing-messages",
770
- "name": "Disappearing Messages",
771
- "type": "dashboard-only",
772
- "description": "Messages auto-delete after a specified interval.",
773
- "dashboard_path": "Chat & Messaging → Features → Disappearing Messages → Configure interval",
774
- "docs_topic": "extensions#disappearing-messages",
775
- "tier": 5,
776
- "code": "custom-code",
777
- "builder": "code",
778
- "dashboard_settings": null,
779
- "auto_wired_in_uikit": false
780
- },
781
- {
782
- "id": "chatwoot",
783
- "name": "Chatwoot Integration",
784
- "type": "dashboard-only",
785
- "description": "Route messages to Chatwoot for customer support.",
786
- "dashboard_path": "Chat & Messaging → Features → Chatwoot → Configure webhook",
787
- "docs_topic": "extensions#chatwoot",
788
- "tier": 5,
789
- "code": "custom-code",
790
- "builder": "code",
791
- "dashboard_settings": "Configure Key on Dashboard",
792
- "auto_wired_in_uikit": false
793
- },
794
- {
795
- "id": "intercom",
796
- "name": "Intercom Integration",
797
- "type": "dashboard-only",
798
- "description": "Integrate Intercom for in-app customer support.",
799
- "dashboard_path": "Chat & Messaging → Features → Intercom → Configure API key",
800
- "docs_topic": "extensions#intercom",
801
- "tier": 5,
802
- "code": "custom-code",
803
- "builder": "code",
804
- "dashboard_settings": "Configure Key on Dashboard",
805
- "auto_wired_in_uikit": false
806
- },
807
- {
808
- "id": "conversation-starter",
809
- "name": "AI Conversation Starter",
810
- "type": "ai-feature",
811
- "ai_key": "conversation-starter",
812
- "requires": "openai-key",
813
- "description": "AI-generated opening messages for new chats.",
814
- "dashboard_path": "Chat & Messaging → Features → Conversation Starter → Toggle on",
815
- "docs_topic": "ai-features#conversation-starter",
816
- "tier": 4,
817
- "code": "none",
818
- "builder": "toggle",
819
- "dashboard_settings": "Configure Key on Dashboard"
820
- },
821
- {
822
- "id": "smart-replies",
823
- "name": "AI Smart Replies",
824
- "type": "ai-feature",
825
- "ai_key": "smart-replies",
826
- "requires": "openai-key",
827
- "description": "AI-generated contextual response suggestions.",
828
- "dashboard_path": "Chat & Messaging → Features → Smart Replies → Toggle on",
829
- "docs_topic": "ai-features#smart-replies",
830
- "tier": 4,
831
- "code": "none",
832
- "builder": "toggle",
833
- "dashboard_settings": "Configure Key on Dashboard"
834
- },
835
- {
836
- "id": "conversation-summary",
837
- "name": "AI Conversation Summary",
838
- "type": "ai-feature",
839
- "ai_key": "conversation-summary",
840
- "requires": "openai-key",
841
- "description": "AI-generated recaps of extended conversations.",
842
- "dashboard_path": "Chat & Messaging → Features → Conversation Summary → Toggle on",
843
- "docs_topic": "ai-features#conversation-summary",
844
- "tier": 4,
845
- "code": "none",
846
- "builder": "toggle",
847
- "dashboard_settings": "Configure Key on Dashboard"
848
- },
849
- {
850
- "id": "calls",
851
- "name": "Audio/Video Calls",
852
- "type": "package-install",
853
- "description": "1:1 and group audio/video calling. Includes call buttons in headers, incoming/outgoing call UI, and call logs. Requires installing the calls SDK for your platform.",
854
- "package": "@cometchat/calls-sdk-javascript",
855
- "package_native": "@cometchat/calls-sdk-react-native",
856
- "package_native_peers": [
857
- "react-native-webrtc",
858
- "react-native-incall-manager",
859
- "react-native-background-timer",
860
- "react-native-callstats",
861
- "@react-native-community/netinfo"
862
- ],
863
- "components": [
864
- "CometChatIncomingCall",
865
- "CometChatOutgoingCall",
866
- "CometChatCallLogs"
867
- ],
868
- "docs_topic": "call-features"
869
- },
870
- {
871
- "id": "rich-text-formatting",
872
- "name": "Rich Text Formatting",
873
- "type": "component-swap",
874
- "description": "Bold, italic, underline, code, links, lists in messages. Replace CometChatMessageComposer with CometChatCompactMessageComposer.",
875
- "swap_from": "CometChatMessageComposer",
876
- "swap_to": "CometChatCompactMessageComposer",
877
- "docs_topic": "core-features#rich-text-formatting"
878
- },
879
- {
880
- "id": "call-recording",
881
- "name": "Call Recording",
882
- "type": "calls-feature",
883
- "description": "Server-side call recording to cloud storage. Configured via CallSettingsBuilder (startRecordingOnCallStart, or call startRecording()/stopRecording() at runtime). ENABLEMENT IS NOT SELF-SERVICE: 'Recording must be enabled for your CometChat app — contact CometChat support' (plan add-on). There is no dashboard toggle / API call the CLI can flip. Recordings are then accessed via the Dashboard call logs or the Call Logs API.",
884
- "settings_flag": "startRecordingOnCallStart",
885
- "requires_dashboard_setup": true,
886
- "enablement": "contact-support",
887
- "reference_topic": "recording",
888
- "platforms_supported": [
889
- "web",
890
- "react-native",
891
- "angular",
892
- "ios",
893
- "android-v5",
894
- "android-v6",
895
- "flutter-v5",
896
- "flutter-v6"
897
- ],
898
- "docs_topic": "calls/recording"
899
- },
900
- {
901
- "id": "screen-share",
902
- "name": "Screen Sharing",
903
- "type": "calls-feature",
904
- "description": "Share screen during a call. Built into Calls SDK; the button shows by default — toggle via CallSettingsBuilder showScreenShareButton(bool) (default-mode / CometChatOngoingCall), or the session-settings object field hideScreenSharingButton (joinSession mode). Mobile platforms have OS-level gating (iOS broadcast extension, Android MediaProjection).",
905
- "settings_flag": "showScreenShareButton",
906
- "reference_topic": "screen-sharing",
907
- "platforms_supported": [
908
- "web",
909
- "react-native",
910
- "angular",
911
- "ios",
912
- "android-v5",
913
- "android-v6",
914
- "flutter-v5",
915
- "flutter-v6"
916
- ],
917
- "docs_topic": "calls/screen-sharing"
918
- },
919
- {
920
- "id": "virtual-background",
921
- "name": "Virtual Background",
922
- "type": "calls-feature",
923
- "description": "Blur or replace the user's background during a call. Toggle the control via CallSettingsBuilder showVirtualBackgroundSetting(bool); set a background with setVirtualBackground / enforceBackgroundBlur. JavaScript-only feature — not available on iOS/Android/RN browsers (mobile webviews don't ship the ML Kit needed).",
924
- "settings_flag": "showVirtualBackgroundSetting",
925
- "reference_topic": "virtual-background",
926
- "platforms_supported": [
927
- "web",
928
- "angular"
929
- ],
930
- "docs_topic": "calls/virtual-background"
931
- },
932
- {
933
- "id": "raise-hand",
934
- "name": "Raise Hand",
935
- "type": "calls-feature",
936
- "description": "Participants can raise a hand to signal they want to speak. Built into Calls SDK.",
937
- "settings_flag": "hideRaiseHandButton",
938
- "reference_topic": "raise-hand",
939
- "platforms_supported": [
940
- "web",
941
- "react-native",
942
- "angular",
943
- "ios",
944
- "android-v5",
945
- "android-v6",
946
- "flutter-v5",
947
- "flutter-v6"
948
- ],
949
- "docs_topic": "calls/raise-hand"
950
- },
951
- {
952
- "id": "picture-in-picture",
953
- "name": "Picture-in-Picture",
954
- "type": "calls-feature",
955
- "description": "Minimize an in-progress call into a floating window so the user can keep using the rest of your app (or other apps on mobile). PIP is toggled via the STATIC methods CometChatCalls.enablePictureInPictureLayout() / disablePictureInPictureLayout() — NOT a CallSettingsBuilder/settings-object flag (there is no hidePIPButton). Per-platform constraints — iOS PIP requires a multitasking-capable iPad or iOS 15+ iPhone, Android requires API 26+.",
956
- "settings_flag": "disablePictureInPictureLayout",
957
- "reference_topic": "picture-in-picture",
958
- "platforms_supported": [
959
- "web",
960
- "react-native",
961
- "angular",
962
- "ios",
963
- "android-v5",
964
- "android-v6",
965
- "flutter-v5",
966
- "flutter-v6"
967
- ],
968
- "docs_topic": "calls/picture-in-picture"
969
- },
970
- {
971
- "id": "idle-timeout",
972
- "name": "Idle Timeout",
973
- "type": "calls-feature",
974
- "description": "Auto-end a call after a configurable period of no activity. Prevents zombie calls + unbounded billing. Configured via CallSettingsBuilder setIdleTimeoutPeriod(ms) (single period, default-mode), OR the session-settings object fields idleTimeoutPeriodBeforePrompt / idleTimeoutPeriodAfterPrompt in ms (joinSession mode; AfterPrompt has a 60_000ms minimum). There is NO callIdleTime.",
975
- "settings_flag": "setIdleTimeoutPeriod",
976
- "reference_topic": "idle-timeout",
977
- "platforms_supported": [
978
- "web",
979
- "react-native",
980
- "angular",
981
- "ios",
982
- "android-v5",
983
- "android-v6",
984
- "flutter-v5",
985
- "flutter-v6"
986
- ],
987
- "docs_topic": "calls/idle-timeout"
988
- }
989
- ]
990
- }