@cometchat/skills 4.2.1 → 4.4.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 (234) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +33 -12
  3. package/bin/install.js +59 -4
  4. package/package.json +14 -1
  5. package/skills/cometchat/SKILL.md +460 -77
  6. package/skills/cometchat/references/asking-questions.md +48 -0
  7. package/skills/cometchat-a11y/SKILL.md +3 -2
  8. package/skills/cometchat-android-v5/SKILL.md +2 -1
  9. package/skills/cometchat-android-v5-calls/SKILL.md +36 -22
  10. package/skills/cometchat-android-v5-calls/references/README.md +1 -1
  11. package/skills/cometchat-android-v5-calls/references/add-calls-to-existing-chat.md +7 -5
  12. package/skills/cometchat-android-v5-calls/references/audio-controls.md +4 -4
  13. package/skills/cometchat-android-v5-calls/references/call-layouts.md +33 -25
  14. package/skills/cometchat-android-v5-calls/references/call-session.md +2 -2
  15. package/skills/cometchat-android-v5-calls/references/custom-ui.md +5 -5
  16. package/skills/cometchat-android-v5-calls/references/event-listeners.md +2 -2
  17. package/skills/cometchat-android-v5-calls/references/idle-timeout.md +20 -14
  18. package/skills/cometchat-android-v5-calls/references/in-call-chat.md +1 -1
  19. package/skills/cometchat-android-v5-calls/references/migration-v4-to-v5.md +43 -27
  20. package/skills/cometchat-android-v5-calls/references/participant-management.md +3 -3
  21. package/skills/cometchat-android-v5-calls/references/raise-hand.md +25 -19
  22. package/skills/cometchat-android-v5-calls/references/recording.md +2 -2
  23. package/skills/cometchat-android-v5-calls/references/ringing-integration.md +1 -1
  24. package/skills/cometchat-android-v5-calls/references/screen-sharing.md +5 -9
  25. package/skills/cometchat-android-v5-calls/references/session-settings.md +3 -3
  26. package/skills/cometchat-android-v5-calls/references/setup.md +1 -1
  27. package/skills/cometchat-android-v5-calls/references/share-invite.md +9 -4
  28. package/skills/cometchat-android-v5-calls/references/video-controls.md +4 -4
  29. package/skills/cometchat-android-v5-calls/references/voip-calling.md +2 -2
  30. package/skills/cometchat-android-v5-components/SKILL.md +4 -3
  31. package/skills/cometchat-android-v5-core/SKILL.md +20 -2
  32. package/skills/cometchat-android-v5-customization/SKILL.md +171 -7
  33. package/skills/cometchat-android-v5-extensions/SKILL.md +7 -4
  34. package/skills/cometchat-android-v5-features/SKILL.md +5 -4
  35. package/skills/cometchat-android-v5-placement/SKILL.md +2 -1
  36. package/skills/cometchat-android-v5-production/SKILL.md +2 -1
  37. package/skills/cometchat-android-v5-push/SKILL.md +2 -3
  38. package/skills/cometchat-android-v5-testing/SKILL.md +2 -1
  39. package/skills/cometchat-android-v5-theming/SKILL.md +2 -1
  40. package/skills/cometchat-android-v5-troubleshooting/SKILL.md +3 -2
  41. package/skills/cometchat-android-v6/SKILL.md +2 -1
  42. package/skills/cometchat-android-v6-builder-settings/SKILL.md +11 -7
  43. package/skills/cometchat-android-v6-calls/SKILL.md +79 -18
  44. package/skills/cometchat-android-v6-calls/references/advanced-features.md +87 -0
  45. package/skills/cometchat-android-v6-calls/references/call-layouts.md +24 -15
  46. package/skills/cometchat-android-v6-calls/references/call-session.md +2 -2
  47. package/skills/cometchat-android-v6-calls/references/device-management.md +17 -16
  48. package/skills/cometchat-android-v6-calls/references/idle-timeout.md +7 -4
  49. package/skills/cometchat-android-v6-calls/references/in-call-chat.md +13 -8
  50. package/skills/cometchat-android-v6-calls/references/raise-hand.md +6 -4
  51. package/skills/cometchat-android-v6-compose-components/SKILL.md +52 -29
  52. package/skills/cometchat-android-v6-compose-customization/SKILL.md +156 -1
  53. package/skills/cometchat-android-v6-compose-placement/SKILL.md +129 -40
  54. package/skills/cometchat-android-v6-compose-theming/SKILL.md +27 -1
  55. package/skills/cometchat-android-v6-core/SKILL.md +389 -9
  56. package/skills/cometchat-android-v6-events/SKILL.md +4 -1
  57. package/skills/cometchat-android-v6-extensions/SKILL.md +2 -1
  58. package/skills/cometchat-android-v6-features/SKILL.md +26 -2
  59. package/skills/cometchat-android-v6-kotlin-components/SKILL.md +31 -1
  60. package/skills/cometchat-android-v6-kotlin-customization/SKILL.md +172 -1
  61. package/skills/cometchat-android-v6-kotlin-placement/SKILL.md +20 -5
  62. package/skills/cometchat-android-v6-kotlin-theming/SKILL.md +36 -5
  63. package/skills/cometchat-android-v6-migration/SKILL.md +44 -42
  64. package/skills/cometchat-android-v6-production/SKILL.md +6 -3
  65. package/skills/cometchat-android-v6-push/SKILL.md +43 -2
  66. package/skills/cometchat-android-v6-testing/SKILL.md +11 -8
  67. package/skills/cometchat-android-v6-troubleshooting/SKILL.md +26 -5
  68. package/skills/cometchat-angular-calls/SKILL.md +256 -389
  69. package/skills/cometchat-angular-calls/references/add-calls-to-existing-chat.md +3 -2
  70. package/skills/cometchat-angular-calls/references/call-layouts.md +29 -12
  71. package/skills/cometchat-angular-calls/references/call-session.md +2 -2
  72. package/skills/cometchat-angular-calls/references/custom-ui.md +18 -10
  73. package/skills/cometchat-angular-calls/references/device-management.md +53 -34
  74. package/skills/cometchat-angular-calls/references/group-calls.md +45 -24
  75. package/skills/cometchat-angular-calls/references/idle-timeout.md +31 -15
  76. package/skills/cometchat-angular-calls/references/ngzone-and-async-callbacks.md +7 -6
  77. package/skills/cometchat-angular-calls/references/raise-hand.md +9 -4
  78. package/skills/cometchat-angular-calls/references/recording-screen-share.md +32 -39
  79. package/skills/cometchat-angular-calls/references/ringing-integration.md +3 -1
  80. package/skills/cometchat-angular-calls/references/share-invite.md +11 -5
  81. package/skills/cometchat-angular-calls/references/virtual-background.md +29 -0
  82. package/skills/cometchat-angular-components/SKILL.md +149 -620
  83. package/skills/cometchat-angular-core/SKILL.md +235 -293
  84. package/skills/cometchat-angular-customization/SKILL.md +415 -223
  85. package/skills/cometchat-angular-features/SKILL.md +216 -334
  86. package/skills/cometchat-angular-patterns/SKILL.md +168 -359
  87. package/skills/cometchat-angular-placement/SKILL.md +189 -560
  88. package/skills/cometchat-angular-production/SKILL.md +241 -92
  89. package/skills/cometchat-angular-push/SKILL.md +280 -294
  90. package/skills/cometchat-angular-testing/SKILL.md +430 -158
  91. package/skills/cometchat-angular-theming/SKILL.md +190 -265
  92. package/skills/cometchat-angular-troubleshooting/SKILL.md +192 -157
  93. package/skills/cometchat-astro-patterns/SKILL.md +22 -1
  94. package/skills/cometchat-calls/SKILL.md +25 -19
  95. package/skills/cometchat-calls/references/use-case-broadcast.md +15 -10
  96. package/skills/cometchat-calls/references/use-case-marketplace.md +2 -3
  97. package/skills/cometchat-calls/references/use-case-support.md +3 -4
  98. package/skills/cometchat-calls/references/use-case-team.md +23 -12
  99. package/skills/cometchat-calls/references/use-case-telehealth.md +3 -4
  100. package/skills/cometchat-components/SKILL.md +163 -25
  101. package/skills/cometchat-core/SKILL.md +412 -13
  102. package/skills/cometchat-customization/SKILL.md +50 -25
  103. package/skills/cometchat-features/SKILL.md +313 -34
  104. package/skills/cometchat-flutter-v5/SKILL.md +10 -4
  105. package/skills/cometchat-flutter-v5-calls/SKILL.md +188 -158
  106. package/skills/cometchat-flutter-v5-calls/references/add-calls-to-existing-chat.md +48 -24
  107. package/skills/cometchat-flutter-v5-calls/references/call-layouts.md +20 -15
  108. package/skills/cometchat-flutter-v5-calls/references/call-session.md +100 -145
  109. package/skills/cometchat-flutter-v5-calls/references/device-management.md +12 -8
  110. package/skills/cometchat-flutter-v5-calls/references/group-calls.md +30 -36
  111. package/skills/cometchat-flutter-v5-calls/references/idle-timeout.md +15 -13
  112. package/skills/cometchat-flutter-v5-calls/references/in-call-chat.md +12 -9
  113. package/skills/cometchat-flutter-v5-calls/references/migration-v4-to-v5.md +115 -65
  114. package/skills/cometchat-flutter-v5-calls/references/raise-hand.md +41 -30
  115. package/skills/cometchat-flutter-v5-calls/references/ringing-integration.md +17 -14
  116. package/skills/cometchat-flutter-v5-calls/references/share-invite.md +8 -2
  117. package/skills/cometchat-flutter-v5-conversations/SKILL.md +2 -1
  118. package/skills/cometchat-flutter-v5-core/SKILL.md +20 -2
  119. package/skills/cometchat-flutter-v5-customization/SKILL.md +136 -5
  120. package/skills/cometchat-flutter-v5-events/SKILL.md +2 -1
  121. package/skills/cometchat-flutter-v5-messages/SKILL.md +2 -1
  122. package/skills/cometchat-flutter-v5-production/SKILL.md +15 -6
  123. package/skills/cometchat-flutter-v5-push/SKILL.md +2 -1
  124. package/skills/cometchat-flutter-v5-testing/SKILL.md +17 -6
  125. package/skills/cometchat-flutter-v5-theming/SKILL.md +2 -1
  126. package/skills/cometchat-flutter-v5-troubleshooting/SKILL.md +7 -6
  127. package/skills/cometchat-flutter-v5-users-groups/SKILL.md +3 -2
  128. package/skills/cometchat-flutter-v6/SKILL.md +17 -16
  129. package/skills/cometchat-flutter-v6-calls/SKILL.md +78 -63
  130. package/skills/cometchat-flutter-v6-calls/references/add-calls-to-existing-chat.md +8 -6
  131. package/skills/cometchat-flutter-v6-calls/references/advanced-features.md +89 -0
  132. package/skills/cometchat-flutter-v6-calls/references/call-layouts.md +15 -12
  133. package/skills/cometchat-flutter-v6-calls/references/call-session.md +2 -2
  134. package/skills/cometchat-flutter-v6-calls/references/device-management.md +9 -3
  135. package/skills/cometchat-flutter-v6-calls/references/group-calls.md +10 -10
  136. package/skills/cometchat-flutter-v6-calls/references/idle-timeout.md +15 -7
  137. package/skills/cometchat-flutter-v6-calls/references/in-call-chat.md +6 -3
  138. package/skills/cometchat-flutter-v6-calls/references/raise-hand.md +23 -16
  139. package/skills/cometchat-flutter-v6-components/SKILL.md +32 -11
  140. package/skills/cometchat-flutter-v6-conversations/SKILL.md +39 -11
  141. package/skills/cometchat-flutter-v6-core/SKILL.md +348 -10
  142. package/skills/cometchat-flutter-v6-customization/SKILL.md +97 -25
  143. package/skills/cometchat-flutter-v6-events/SKILL.md +3 -2
  144. package/skills/cometchat-flutter-v6-features/SKILL.md +15 -6
  145. package/skills/cometchat-flutter-v6-messages/SKILL.md +111 -60
  146. package/skills/cometchat-flutter-v6-migration/SKILL.md +18 -25
  147. package/skills/cometchat-flutter-v6-placement/SKILL.md +79 -50
  148. package/skills/cometchat-flutter-v6-production/SKILL.md +13 -12
  149. package/skills/cometchat-flutter-v6-push/SKILL.md +43 -21
  150. package/skills/cometchat-flutter-v6-testing/SKILL.md +6 -6
  151. package/skills/cometchat-flutter-v6-theming/SKILL.md +38 -5
  152. package/skills/cometchat-flutter-v6-troubleshooting/SKILL.md +182 -17
  153. package/skills/cometchat-flutter-v6-users-groups/SKILL.md +12 -4
  154. package/skills/cometchat-i18n/SKILL.md +139 -78
  155. package/skills/cometchat-ios/SKILL.md +4 -2
  156. package/skills/cometchat-ios-calls/SKILL.md +225 -95
  157. package/skills/cometchat-ios-calls/references/add-calls-to-existing-chat.md +11 -9
  158. package/skills/cometchat-ios-calls/references/audio-modes-and-controls.md +45 -0
  159. package/skills/cometchat-ios-calls/references/avaudiosession-routing.md +6 -7
  160. package/skills/cometchat-ios-calls/references/call-layouts.md +31 -91
  161. package/skills/cometchat-ios-calls/references/call-session.md +51 -54
  162. package/skills/cometchat-ios-calls/references/callkit-and-pushkit.md +33 -29
  163. package/skills/cometchat-ios-calls/references/custom-ui.md +38 -38
  164. package/skills/cometchat-ios-calls/references/group-calls.md +33 -70
  165. package/skills/cometchat-ios-calls/references/idle-timeout.md +24 -25
  166. package/skills/cometchat-ios-calls/references/in-call-chat.md +19 -23
  167. package/skills/cometchat-ios-calls/references/migration-v4-to-v5.md +128 -70
  168. package/skills/cometchat-ios-calls/references/picture-in-picture.md +20 -20
  169. package/skills/cometchat-ios-calls/references/raise-hand.md +14 -227
  170. package/skills/cometchat-ios-calls/references/recording-screen-share.md +35 -122
  171. package/skills/cometchat-ios-calls/references/ringing-integration.md +17 -16
  172. package/skills/cometchat-ios-calls/references/share-invite.md +8 -12
  173. package/skills/cometchat-ios-calls/references/swiftui-uikit-hosting.md +4 -4
  174. package/skills/cometchat-ios-components/SKILL.md +200 -12
  175. package/skills/cometchat-ios-core/SKILL.md +281 -11
  176. package/skills/cometchat-ios-customization/SKILL.md +276 -110
  177. package/skills/cometchat-ios-features/SKILL.md +64 -36
  178. package/skills/cometchat-ios-placement/SKILL.md +15 -12
  179. package/skills/cometchat-ios-production/SKILL.md +12 -4
  180. package/skills/cometchat-ios-push/SKILL.md +53 -19
  181. package/skills/cometchat-ios-testing/SKILL.md +14 -9
  182. package/skills/cometchat-ios-theming/SKILL.md +39 -3
  183. package/skills/cometchat-ios-troubleshooting/SKILL.md +41 -21
  184. package/skills/cometchat-native-bare-patterns/SKILL.md +56 -18
  185. package/skills/cometchat-native-calls/SKILL.md +89 -19
  186. package/skills/cometchat-native-calls/references/add-calls-to-existing-chat.md +2 -2
  187. package/skills/cometchat-native-calls/references/call-layouts.md +15 -14
  188. package/skills/cometchat-native-calls/references/call-session.md +2 -2
  189. package/skills/cometchat-native-calls/references/custom-ui.md +12 -8
  190. package/skills/cometchat-native-calls/references/device-management.md +53 -30
  191. package/skills/cometchat-native-calls/references/group-calls.md +35 -30
  192. package/skills/cometchat-native-calls/references/idle-timeout.md +6 -6
  193. package/skills/cometchat-native-calls/references/in-call-chat.md +10 -8
  194. package/skills/cometchat-native-calls/references/migration-v4-to-v5.md +2 -2
  195. package/skills/cometchat-native-calls/references/raise-hand.md +15 -13
  196. package/skills/cometchat-native-calls/references/recording-screen-share.md +49 -170
  197. package/skills/cometchat-native-calls/references/share-invite.md +7 -5
  198. package/skills/cometchat-native-calls/references/voip-push-end-to-end.md +4 -2
  199. package/skills/cometchat-native-components/SKILL.md +91 -57
  200. package/skills/cometchat-native-core/SKILL.md +281 -9
  201. package/skills/cometchat-native-customization/SKILL.md +150 -28
  202. package/skills/cometchat-native-expo-patterns/SKILL.md +77 -27
  203. package/skills/cometchat-native-features/SKILL.md +79 -49
  204. package/skills/cometchat-native-placement/SKILL.md +19 -10
  205. package/skills/cometchat-native-production/SKILL.md +9 -3
  206. package/skills/cometchat-native-push/SKILL.md +2 -1
  207. package/skills/cometchat-native-testing/SKILL.md +1 -2
  208. package/skills/cometchat-native-theming/SKILL.md +54 -29
  209. package/skills/cometchat-native-troubleshooting/SKILL.md +71 -3
  210. package/skills/cometchat-nextjs-patterns/SKILL.md +48 -6
  211. package/skills/cometchat-placement/SKILL.md +42 -3
  212. package/skills/cometchat-production/SKILL.md +12 -5
  213. package/skills/cometchat-react-calls/SKILL.md +220 -10
  214. package/skills/cometchat-react-calls/references/add-calls-to-existing-chat.md +4 -3
  215. package/skills/cometchat-react-calls/references/call-layouts.md +5 -6
  216. package/skills/cometchat-react-calls/references/call-session.md +1 -1
  217. package/skills/cometchat-react-calls/references/custom-ui.md +61 -15
  218. package/skills/cometchat-react-calls/references/device-management.md +55 -51
  219. package/skills/cometchat-react-calls/references/group-calls.md +18 -23
  220. package/skills/cometchat-react-calls/references/idle-timeout.md +25 -12
  221. package/skills/cometchat-react-calls/references/in-call-chat.md +7 -7
  222. package/skills/cometchat-react-calls/references/migration-v4-to-v5.md +9 -11
  223. package/skills/cometchat-react-calls/references/raise-hand.md +14 -14
  224. package/skills/cometchat-react-calls/references/recording-screen-share.md +39 -38
  225. package/skills/cometchat-react-calls/references/ringing-integration.md +2 -2
  226. package/skills/cometchat-react-calls/references/share-invite.md +4 -5
  227. package/skills/cometchat-react-calls/references/testing-calls-on-web.md +20 -2
  228. package/skills/cometchat-react-calls/references/virtual-background.md +32 -0
  229. package/skills/cometchat-react-patterns/SKILL.md +57 -4
  230. package/skills/cometchat-react-push/SKILL.md +258 -72
  231. package/skills/cometchat-react-router-patterns/SKILL.md +43 -4
  232. package/skills/cometchat-react-testing/SKILL.md +14 -5
  233. package/skills/cometchat-theming/SKILL.md +181 -18
  234. package/skills/cometchat-troubleshooting/SKILL.md +40 -20
@@ -1,22 +1,21 @@
1
1
  ---
2
2
  name: cometchat-angular-troubleshooting
3
- description: "Diagnose CometChat Angular UI Kit v4 integration failures — init/login, CUSTOM_ELEMENTS_SCHEMA, assets config, module imports, height/layout issues, Angular Universal SSR, v3-to-v4 upgrade, and production auth errors."
3
+ description: "Diagnose CometChat Angular UI Kit v5 (@cometchat/chat-uikit-angular@5) integration failures — peer-dep / Angular-version mismatch, standalone-import 'is not a known element', init-before-render race, assets config, height/layout, NgZone change-detection, CSS-variable theming, SSR 'window is not defined', and production auth-token errors."
4
4
  license: "MIT"
5
- compatibility: "Angular >=12 <=15; @cometchat/chat-uikit-angular ^4; @cometchat/chat-sdk-javascript ^4"
6
- allowed-tools: "shell, file-read, file-search, file-list, ask-user"
5
+ compatibility: "Angular >=17 <22; @cometchat/chat-uikit-angular ^5.0; @cometchat/chat-sdk-javascript ^4.1"
7
6
  metadata:
8
7
  author: "CometChat"
9
- version: "3.0.0"
10
- tags: "cometchat angular troubleshooting schema assets module height ssr upgrade"
8
+ version: "4.0.0"
9
+ tags: "cometchat angular troubleshooting v5 standalone peer-deps assets height ssr ngzone css-variables auth-token"
11
10
  ---
12
11
 
13
12
  ## Purpose
14
13
 
15
- Teaches Claude how to diagnose and fix CometChat Angular UI Kit v4 integration failures. Covers every category of failure across NgModule and standalone component setups, with an up-front triage flow so Claude asks the right questions before assuming a fix.
14
+ Teaches Claude how to diagnose and fix CometChat **Angular UI Kit v5** (`@cometchat/chat-uikit-angular@5`) integration failures. This is a symptom cause fix reference. v5 is **standalone-component-based, Angular 17–21** there is no NgModule and no `CUSTOM_ELEMENTS_SCHEMA`. If you find yourself reaching for either, you are applying a v4 mental model.
16
15
 
17
- **Read `cometchat-angular-core` first** — most "why doesn't this work" issues trace to the init/login/module setup explained there.
16
+ **Read `cometchat-angular-core` first** — most "why doesn't this work" issues trace to the init / login / standalone-import order explained there.
18
17
 
19
- Ground truth: `docs/ui-kit/angular/troubleshooting`, `docs/ui-kit/angular/getting-started`, and first-hand failure modes from real integrations.
18
+ Ground truth: `@cometchat/chat-uikit-angular@5.0.2` bundled types (`node_modules/@cometchat/chat-uikit-angular/types/cometchat-chat-uikit-angular.d.ts`), `docs/ui-kit/angular`, and first-hand failure modes from real v5 integrations. Verify any non-obvious symbol against the installed `.d.ts` before relying on it. **Official docs:** https://www.cometchat.com/docs/ui-kit/angular/overview · **Docs MCP:** `claude mcp add --transport http cometchat-docs https://www.cometchat.com/docs/mcp` (or fetch the URL directly without MCP).
20
19
 
21
20
  ---
22
21
 
@@ -24,13 +23,14 @@ Ground truth: `docs/ui-kit/angular/troubleshooting`, `docs/ui-kit/angular/gettin
24
23
 
25
24
  When the user reports a problem, gather facts before proposing a fix.
26
25
 
27
- ### 1a. Is `CUSTOM_ELEMENTS_SCHEMA` in every module that uses `<cometchat-*>` tags?
26
+ ### 1a. Does the installed Angular version satisfy the kit's peer range?
28
27
 
29
28
  ```bash
30
- grep -r "CUSTOM_ELEMENTS_SCHEMA" src/
29
+ node -e "console.log(require('@angular/core/package.json').version)"
30
+ npm ls @cometchat/chat-uikit-angular
31
31
  ```
32
32
 
33
- If missing from any module or standalone component that uses `<cometchat-*>` tags, Angular throws "Unknown element" errors. Every module/component needs it independently.
33
+ UI Kit v5 declares `@angular/core` / `@angular/common` peers of `>=17.0.0 <22.0.0`. On Angular ≤16 the install warns (or errors under strict peers) and standalone-component imports fail at build time. Fix: upgrade Angular to 17–21.
34
34
 
35
35
  ### 1b. Are the assets configured in `angular.json`?
36
36
 
@@ -38,172 +38,191 @@ If missing from any module or standalone component that uses `<cometchat-*>` tag
38
38
  grep -A5 '"assets"' angular.json | grep cometchat
39
39
  ```
40
40
 
41
- If missing, icons render as broken images. The required entry:
41
+ If missing, icons render as broken images. The required entry under `projects.<app>.architect.build.options.assets`:
42
42
  ```json
43
- { "glob": "**/*", "input": "./node_modules/@cometchat/chat-uikit-angular/assets/", "output": "assets/" }
43
+ { "glob": "**/*", "input": "./node_modules/@cometchat/chat-uikit-angular/src/lib/assets", "output": "assets/" }
44
44
  ```
45
45
 
46
46
  ### 1c. Is init complete before any `<cometchat-*>` component renders?
47
47
 
48
48
  ```bash
49
- grep -n "CometChatUIKit.init\|isReady\|APP_INITIALIZER" src/app/app.component.ts
49
+ grep -rn "CometChatUIKit.init\|APP_INITIALIZER\|isReady" src/
50
50
  ```
51
51
 
52
- Look for the init promise + `isReady` flag or `APP_INITIALIZER`. Components rendered before init completes produce blank output.
52
+ Look for the init Promise resolved in `main.ts` before `bootstrapApplication(...)` (the v5 canonical — see `cometchat-angular-core` §3 / `cometchat-angular-patterns`), or wired into an `APP_INITIALIZER` factory (the alternative), or an `isReady` flag set after the init+login chain resolves. Components rendered before init completes produce blank output or a "CometChat is not initialized" console error.
53
53
 
54
- ### 1d. Is `UIKitSettingsBuilder` used (not a flat object)?
54
+ ### 1d. Is `UIKitSettingsBuilder` used (not a flat object), imported from the right package?
55
55
 
56
56
  ```bash
57
- grep -n "UIKitSettingsBuilder\|CometChatUIKit.init" src/
57
+ grep -rn "UIKitSettingsBuilder\|CometChatUIKit.init\|uikit-shared" src/
58
58
  ```
59
59
 
60
- Angular requires `UIKitSettingsBuilder` from `@cometchat/uikit-shared`. A flat object passed to `init()` fails silently or throws a type error.
60
+ In v5 `UIKitSettingsBuilder` is exported from **`@cometchat/chat-uikit-angular`**. If you see an import from `@cometchat/uikit-shared` / `-elements` / `-resources`, that's a v4 package set that does not exist in v5 — it will fail to resolve. A flat object passed to `init()` (instead of a built `UIKitSettings`) also fails.
61
61
 
62
- ### 1e. Are CometChat components imported in the module?
62
+ ### 1e. Are the CometChat component classes imported into the standalone component that renders them?
63
63
 
64
64
  ```bash
65
- grep -n "CometChatConversations\|CometChatMessages\|CometChatMessageList" src/app/app.module.ts
65
+ # v5 exports class names with the `Component` suffix; selectors do not carry it.
66
+ grep -rnE "CometChat(Conversations|MessageList|MessageHeader|MessageComposer|Users|Groups|GroupMembers|CallButtons|IncomingCall|OutgoingCall|OngoingCall|CallLogs)Component" src/
66
67
  ```
67
68
 
68
- Every `<cometchat-*>` component must be imported in the module (or standalone component) where it's used.
69
+ Every `<cometchat-*>` tag requires its `*Component` class in the host **standalone component's** `imports: []`. There is no module to register them in, and no schema.
69
70
 
70
- ### 1f. Is `BrowserAnimationsModule` imported?
71
+ ### 1f. Are the peer SDKs installed at the right major?
71
72
 
72
73
  ```bash
73
- grep "BrowserAnimationsModule" src/app/app.module.ts
74
+ npm ls @cometchat/chat-sdk-javascript @cometchat/calls-sdk-javascript dompurify
74
75
  ```
75
76
 
76
- Missing `BrowserAnimationsModule` causes runtime errors in components that use Angular animations.
77
+ Chat SDK must be `^4.1`, `dompurify` `^3` (both auto-pulled by npm 7+). Calls features additionally require `@cometchat/calls-sdk-javascript@^5` — installed explicitly.
77
78
 
78
79
  ---
79
80
 
80
- ## 2. Symptom → fix lookup tables
81
+ ## 2. Symptom → cause → fix lookup tables
81
82
 
82
- ### 2a. Initialization + login
83
+ ### 2a. Install / peer-dependency / version
83
84
 
84
85
  | Symptom | Likely cause | Fix |
85
86
  |---|---|---|
86
- | Components render nothing after login | `init()` not awaited before mount | Use `*ngIf="isReady"` on the container; set `isReady = true` after init + login resolve |
87
- | Blank screen, no errors | Component rendered before init completed | Gate with `*ngIf="isReady"` |
88
- | `getLoggedinUser()` returns `null` | Login not called or session expired | Call `CometChatUIKit.login({ uid })` after init resolves |
89
- | Login fails: "UID not found" | User doesn't exist in CometChat | Create via dashboard, SDK, or REST API. For dev, use `cometchat-uid-1` through `cometchat-uid-5` |
90
- | `CometChatUIKit.init()` fails silently | Invalid `APP_ID` / `REGION` / `AUTH_KEY` | Re-verify from dashboard → your app → Credentials |
91
- | `UIKitSettingsBuilder is not a constructor` | Imported from wrong package | Import from `@cometchat/uikit-shared`, not `@cometchat/chat-uikit-angular` |
92
- | Production build exposes Auth Key | Using `authKey` in `environment.prod.ts` | Switch to server-minted auth tokens. See `cometchat-angular-production` |
87
+ | `npm install` warns `ERESOLVE`/peer conflict on `@angular/core` | Angular ≤16 against v5's `>=17 <22` peer range | Upgrade Angular to 17–21 (the kit requires it) |
88
+ | `Cannot find module '@cometchat/uikit-shared'` (or `-elements`/`-resources`) | v4 package set referenced in v5 | Delete those imports — everything is in `@cometchat/chat-uikit-angular`. Import `UIKitSettingsBuilder` from there |
89
+ | Type error: kit components not recognized after install | Angular version too old for the kit's standalone API surface | Confirm Angular 17–21 (§1a) |
90
+ | Calls components present but calling never starts | `@cometchat/calls-sdk-javascript` not installed | `npm install @cometchat/calls-sdk-javascript@^5` + rebuild. See `cometchat-angular-calls` |
93
91
 
94
- ### 2b. Module / schema errors
92
+ ### 2b. "is not a known element" / template binding errors
95
93
 
96
94
  | Symptom | Likely cause | Fix |
97
95
  |---|---|---|
98
- | `'cometchat-conversations' is not a known element` | Missing `CUSTOM_ELEMENTS_SCHEMA` | Add `schemas: [CUSTOM_ELEMENTS_SCHEMA]` to the module or standalone component |
99
- | `'cometchat-conversations' is not a known element` (even with schema) | Component not imported in the module | Import `CometChatConversations` from `@cometchat/chat-uikit-angular` in the module's `imports` array |
100
- | `Can't bind to 'user' since it isn't a known property` | Component not imported | Same fix import the component in the module |
101
- | `NullInjectorError: No provider for CometChatThemeService` | `CometChatThemeService` not available | It's `providedIn: 'root'` ensure `AppModule` is the root module. If using standalone bootstrap, ensure `provideAnimations()` is in providers. |
102
- | `BrowserAnimationsModule` error | Missing animation module | Add `BrowserAnimationsModule` to `AppModule` imports |
96
+ | `'cometchat-conversations' is not a known element` | The `*Component` class isn't in the host standalone component's `imports: []` | Import e.g. `CometChatConversationsComponent` from `@cometchat/chat-uikit-angular` into `imports: []`. (v5 does **not** use `CUSTOM_ELEMENTS_SCHEMA` that was the v4 fix and is wrong here.) |
97
+ | `Can't bind to 'user' since it isn't a known property of 'cometchat-message-list'` | Same root cause class not imported, so Angular treats the tag as an unknown element | Same fix: add the matching `*Component` to `imports: []` |
98
+ | Selector still unknown after adding `CUSTOM_ELEMENTS_SCHEMA` | Schema silences the error but the real component never loads blank render | Remove the schema; import the class instead |
99
+ | `<cometchat-conversations-with-messages>` unknown | Composite removed in v5 | Compose `cometchat-conversations` + `cometchat-message-header`/`-list`/`-composer` yourself see `cometchat-angular-placement` |
103
100
 
104
- ### 2c. Assets / icons
101
+ ### 2c. Initialization + login
105
102
 
106
103
  | Symptom | Likely cause | Fix |
107
104
  |---|---|---|
108
- | Icons show as broken images (404) | Missing assets config in `angular.json` | Add the glob entry for `@cometchat/chat-uikit-angular/assets/` to `build.options.assets` |
109
- | Icons broken only in production build | Assets config present but `outputPath` differs | Verify the `output` path in the assets config matches your production output directory |
110
- | Icons broken after `ng build` | Assets not copied during build | Run `ng build` again after adding the assets config; check `dist/assets/` for the icon files |
111
-
112
- ### 2d. Layout / height issues
105
+ | Components render nothing, no error | Rendered before `init()` resolved | Resolve `init()` in `main.ts` before `bootstrapApplication` (canonical), or block with an `APP_INITIALIZER` factory, or gate the container with `*ngIf="isReady"` set after init+login resolve |
106
+ | "CometChat is not initialized" in console | `<cometchat-*>` mounted before `init()` | Same as above init must complete first |
107
+ | `getLoggedInUser()` returns `null` | Login never called, or session expired | Call `CometChatUIKit.login("cometchat-uid-1")` after init resolves |
108
+ | Login fails: "UID not found" | User doesn't exist in this app | Create via dashboard / SDK / REST API. Dev users `cometchat-uid-1` … `cometchat-uid-5` are pre-seeded in every new app |
109
+ | `login({ uid })` rejected / type error | v4 object-form argument | v5 takes a **bare string**: `CometChatUIKit.login("cometchat-uid-1")` |
110
+ | `CometChatUIKit.init()` fails silently | Invalid `appId` / `region` / `authKey` | Re-verify from dashboard → your app → Credentials |
111
+ | `TS2532: Object is possibly 'undefined'` on `CometChatUIKit.init(settings).then(...)` | v5 `init()` returns `Promise<InitResult> \| undefined`, so `.then()` on it fails strict-null type-check | Coalesce before chaining: `(CometChatUIKit.init(settings) ?? Promise.resolve()).then(...).catch(...)`. See `cometchat-angular-core`. |
112
+ | `ERR_ALREADY_LOGGED_IN` after a hot-reload (HMR) in dev | HMR re-runs the init/login effect while a session already exists | **Non-fatal** — guard it: check `CometChatUIKit.getLoggedInUser()` first and skip `login()` if a user is already present. Safe to ignore in dev; doesn't occur on a fresh load. |
113
+ | `CometChatUIKitLoginListener` is undefined / import fails | Phantom in v5 | Use `CometChatUIKit.getLoggedInUser()` (sync), `getLoggedinUser()` (async), or `loggedInUser$` (observable) |
114
+ | Production build ships the Auth Key | `authKey` in `environment.prod.ts` | Drop it; use server-minted auth tokens via `loginWithAuthToken(...)`. See `cometchat-angular-production` |
115
+
116
+ ### 2d. Assets / icons
113
117
 
114
118
  | Symptom | Likely cause | Fix |
115
119
  |---|---|---|
116
- | Conversation list / message list renders empty | Container has no bounded height | Wrap in `<div style="height: 100vh;">` or `<div style="flex: 1; overflow: hidden;">` |
117
- | Components collapse to zero height | Parent is a `display: block` with no height | Use `display: flex; flex-direction: column; height: 100vh` on the parent |
118
- | Message list doesn't scroll | Container doesn't have `overflow: hidden` | Add `overflow: hidden` to the message list's container; the component handles its own internal scroll |
119
- | Chat dialog too small | Angular Material dialog has no explicit size | Set `width` and `height` on the dialog container or pass `{ width: '480px', height: '600px' }` to `MatDialog.open()` |
120
- | Sidebar chat panel has no height | Sidenav content has no height constraint | Add `height: 100%` or `height: 100vh` to the sidenav content |
120
+ | Icons show as broken images (404) | Missing assets glob in `angular.json` | Add the `@cometchat/chat-uikit-angular/src/lib/assets` entry to `build.options.assets` (§1b) |
121
+ | Icons broken only in production build | `output` path doesn't match prod output dir | Verify the `output` value resolves under your production `outputPath` |
122
+ | Icons still 404 after editing `angular.json` | Dev server cached the old config | Restart `ng serve` `angular.json` is read at startup, not hot-reloaded |
121
123
 
122
- ### 2e. Angular Router integration
124
+ ### 2e. Layout / height
123
125
 
124
126
  | Symptom | Likely cause | Fix |
125
127
  |---|---|---|
126
- | Chat route shows blank | CometChat init not complete when route activates | Use `APP_INITIALIZER` or a route guard that waits for init |
127
- | `window.location.reload()` after login breaks routing | Anti-pattern reload destroys Angular state | Use `this.router.navigate(['/chat'])` instead |
128
- | Lazy-loaded chat module fails to init | `CometChatUIKit.init()` called inside the lazy module | Move init to `APP_INITIALIZER` at the root level |
129
- | Route guard `canActivate` always returns false | `getLoggedinUser()` called before init | Ensure init completes before the guard runs (use `APP_INITIALIZER`) |
128
+ | Conversation/message list renders empty | Container has no bounded height **and/or** the `<cometchat-*>` element wasn't made a flex column | The kit's `<cometchat-*>` elements are `display: inline` by default — they won't flex or fill on their own. Give the host a resolvable `height` (set `html, body { height: 100% }` globally so a `height: 100%` chain has a root), make the host `display: flex; flex-direction: column`, and make the element itself `display: flex; flex-direction: column`. See `cometchat-angular-placement` |
129
+ | Components collapse to 0 height | Parent is `display: block` with no height, or the inline custom element wasn't given `flex`/`display` | Use `display: flex; flex-direction: column; height: 100vh` (or `height: 100%`) on the parent; make the `<cometchat-*>` element `display: flex; flex-direction: column` |
130
+ | Message list doesn't scroll (overflows the viewport instead) | `min-height: 0` missing a flex child defaults to `min-height: auto`, so it grows past the parent instead of scrolling inside it | Set `flex: 1; min-height: 0; overflow: hidden` on `cometchat-message-list`. The `min-height: 0` is the load-bearing part that lets the element shrink and scroll internally. See `cometchat-angular-placement` |
131
+ | Chat dialog too small | `MatDialog` opened with no size | Pass `{ width: '480px', height: '600px' }` to `MatDialog.open()` |
132
+ | Sidenav chat panel has no height | Sidenav content unconstrained | Add `height: 100%` / `height: 100vh` to the sidenav content |
130
133
 
131
- ### 2f. Theming
134
+ ### 2f. Change detection / NgZone
132
135
 
133
136
  | Symptom | Likely cause | Fix |
134
137
  |---|---|---|
135
- | Theme overrides don't apply | `setPrimary()` called in `ngOnInit` instead of constructor | Move to constructor palette must be set before first render |
136
- | Dark mode doesn't switch | `setMode()` called once but not reactive | Call `setMode()` again when the user toggles; the service is reactive |
137
- | Custom color shows as default | Color not a valid CSS color string | Use valid CSS color values (`#hex`, `rgb()`, named colors) |
138
- | `[conversationsStyle]` input has no effect | Style object not instantiated with `new ConversationsStyle({...})` | Use `new ConversationsStyle({...})` — don't pass a plain object |
138
+ | View doesn't update after an SDK callback (message arrives, presence flips) | SDK callbacks fire outside Angular's zone, so change detection never runs | Re-enter the zone: inject `NgZone` and wrap the state update in `this.zone.run(() => …)`, or `ChangeDetectorRef.detectChanges()`. See `cometchat-angular-patterns` |
139
+ | `loggedInUser$` subscription updates the field but template is stale | Same — emission may be outside the zone, and `OnPush` won't re-check | Use the `async` pipe (`loggedInUser$ | async`) so Angular tracks the subscription, or `cdr.markForCheck()` in the subscribe callback |
140
+ | `OnPush` component shows stale CometChat state | `OnPush` only re-checks on input change / event / observable | Drive the view from an observable via `async` pipe, or call `markForCheck()` after mutating state |
139
141
 
140
- ### 2g. Components
142
+ ### 2g. Theming — CSS variables
141
143
 
142
144
  | Symptom | Likely cause | Fix |
143
145
  |---|---|---|
144
- | Slot view (`[listItemView]`, `[subtitleView]`, etc.) renders nothing | `@ViewChild` reference not resolved yet | Ensure `@ViewChild` is accessed after `ngAfterViewInit`, not `ngOnInit` |
145
- | `[onItemClick]` callback not firing | Wrong binding syntaxusing round brackets | Use `[onItemClick]="myFn"` (square brackets, Input callback), never `(onItemClick)="myFn($event)"` (round brackets) |
146
- | `[user]` input has no effect | Passing a UID string instead of `CometChat.User` instance | `await CometChat.getUser(uid)` first, pass the resolved object |
147
- | Conversations list empty but data exists | Wrong request builder filters | Check `[conversationsRequestBuilder]` filters (tags, types, limits) |
148
- | "Reply in Thread" option does nothing | Thread panel not wired | Wire `[onThreadRepliesClick]="myFn"` on `<cometchat-message-list>` and render a thread panel see `cometchat-angular-components` § 11 |
149
- | `[onError]` callback fires with "not initialized" | Component rendered before init | Gate with `*ngIf="isReady"` |
146
+ | No CometChat styling at all — components render unstyled / raw | `css-variables.css` never imported | Add it to the **`angular.json` → `build.options.styles` array** with the full path `node_modules/@cometchat/chat-uikit-angular/styles/css-variables.css` — NOT via a package-specifier `@import` in `styles.css` (that form fails the real `ng build` on Angular 17+/esbuild with "the path … is not exported by package", since the `exports` map only exposes `.`). The full `node_modules/...` path bypasses the exports map. See `cometchat-angular-core` §Assets and `cometchat-angular-theming`. |
147
+ | `Cannot find name 'CometChatThemeService'` / no provider | Phantom in v5there is no theme service | Theme with CSS variables; switch mode via `CometChatUIKit.themeMode = 'dark'`. See `cometchat-angular-theming` |
148
+ | `--cometchat-*` overrides have no effect | Declared inside a component with default `ViewEncapsulation` (Emulated) — scoped away from the kit's elements | Put global tokens in `styles.css` under `:root` (or scope under `.cometchat` for kit-only overrides), or use `::ng-deep` / `ViewEncapsulation.None` for component-scoped overrides |
149
+ | Component-level override (e.g. `.cometchat-conversations`) ignored | Selector missing the `.cometchat` parent scope | Scope under `.cometchat` use `.cometchat .cometchat-conversations`, not the bare class. Kit class names aren't version-stable — verify the actual class in DevTools per version rather than memorizing it. |
150
+ | Dark mode doesn't switch | `themeMode` set once and never re-applied, or `data-theme="dark"` not on the wrapper | Re-assign `CometChatUIKit.themeMode` on the user's toggle (and ensure `data-theme="dark"` is set on the `.cometchat` wrapper / document element) |
151
+ | Custom color ignored | Not a valid CSS color string | Use `#hex` / `rgb()` / named colors |
150
152
 
151
- ### 2h. Calling
153
+ ### 2h. Components / bindings
152
154
 
153
155
  | Symptom | Likely cause | Fix |
154
156
  |---|---|---|
155
- | Call buttons missing | `@cometchat/calls-sdk-javascript` not installed | `npm install @cometchat/calls-sdk-javascript` + rebuild |
156
- | Incoming call UI doesn't show | `<cometchat-incoming-call>` not mounted or listener not registered | Register `CometChat.addCallListener(...)` in `AppComponent.ngOnInit` and mount `<cometchat-incoming-call>` at the app root |
157
- | Call listener fires twice | Listener registered in a component that gets destroyed and re-created | Move listener registration to `AppComponent` (root, never destroyed) |
157
+ | Slot template (`[itemView]`, `[subtitleView]`, …) renders nothing | `@ViewChild`/`TemplateRef` accessed too early | Read it in `ngAfterViewInit`, not `ngOnInit` |
158
+ | Click/selection callback never fires | Bound as an `@Output` event when the kit expects an `@Input` callback (or vice-versa) | Match the binding to the kit's declaration — `@Input` callback uses `[onItemClick]="myFn"`; an `@Output` uses `(itemClick)="handler($event)"`. Confirm per-component in `cometchat-angular-components` |
159
+ | Clicking a conversation/user/group does nothing list won't open a chat | `<cometchat-conversations>` auto-wiring expected, but the active chat surface isn't gated on `ChatStateService` (state-service mode), or props were never reassigned (props mode) | With no `(itemClick)` bound, the kit auto-calls `ChatStateService.setActiveConversation` (kit source: `itemClick.observed ? emit : setActiveConversation`) — gate your message pane on `chatState.activeUser()`/`activeGroup()`. If you bind `(itemClick)`, the auto-wiring is **suppressed** and you must drive selection yourself (props / `chatState.setActive*` / routing). See `cometchat-angular-placement` |
160
+ | `[user]` input has no effect | Passed a UID string instead of a `CometChat.User` | `const u = await CometChat.getUser(uid)` then pass `u` |
161
+ | Conversations list empty but data exists | Over-restrictive request builder | Check `[conversationsRequestBuilder]` filters (tags, types, limits) |
158
162
 
159
- ### 2i. Extensions
163
+ ### 2i. Calling
160
164
 
161
165
  | Symptom | Likely cause | Fix |
162
166
  |---|---|---|
163
- | Polls option missing from composer | Extension not enabled in dashboard | `cometchat features enable polls --json` or toggle in dashboard → Features |
164
- | Extension enabled but UI doesn't appear | Cached session hard reload needed | Stop `ng serve`, clear browser cache, restart |
165
- | Extension says enabled but `auto_wired_in_uikit: false` | Needs `.setExtensions([...])` on `UIKitSettingsBuilder` | Add `new PollsExtension()` etc. to the builder see `cometchat-angular-features` § 2 |
167
+ | Call buttons / call UI inert | `@cometchat/calls-sdk-javascript@^5` not installed, or calling not enabled | Install the peer; `new UIKitSettingsBuilder().setCallingEnabled(true)`. See `cometchat-angular-calls` |
168
+ | Incoming-call UI never shows | `<cometchat-incoming-call>` not mounted at app root, or its listener lives in a component that gets destroyed | Mount `<cometchat-incoming-call>` once in `AppComponent` (never destroyed) |
169
+ | Call listener fires twice | Listener registered in a re-created component | Register once at the app root |
170
+ | Camera/mic never prompts | `getUserMedia` blocked — insecure origin or denied permission | Serve over `https://` or `localhost`; check the browser site-permission for camera/mic |
166
171
 
167
172
  ### 2j. Production / auth tokens
168
173
 
169
174
  | Symptom | Likely cause | Fix |
170
175
  |---|---|---|
171
- | `login({ authToken })` fails: "user does not exist" | User not created in CometChat before token mint | Create user server-side via REST API on your signup flow. See `cometchat-angular-production` § 6 |
172
- | Token endpoint returns 401 | Backend auth check failing | Verify `Authorization: Bearer <jwt>` header is attached to the Angular `HttpClient` request |
173
- | 429 rate limit on token endpoint | Minting tokens too often (e.g. per component init) | Cache client-side, reuse until expiry |
174
- | `CometChatUIKit.loginWithAuthToken` not found | Wrong API name | It's `CometChatUIKit.login({ authToken })` same method as dev, different key |
176
+ | `loginWithAuthToken(token)` fails: "user does not exist" | User not created in CometChat before minting the token | Create the user server-side via REST API in your signup flow. See `cometchat-angular-production` |
177
+ | Token endpoint returns 401 | Backend auth failing | Verify `Authorization: Bearer <jwt>` is attached to the `HttpClient` request |
178
+ | 429 on token endpoint | Minting too often (e.g. per component init) | Cache the token client-side, reuse until expiry |
179
+ | `loginWithAuthToken` "not a function" | Wrong API name | The v5 method is `CometChatUIKit.loginWithAuthToken(token)` (bare token string) |
175
180
 
176
181
  ### 2k. SSR / Angular Universal
177
182
 
178
183
  | Symptom | Likely cause | Fix |
179
184
  |---|---|---|
180
- | `window is not defined` during SSR | CometChat uses browser APIs | Guard with `isPlatformBrowser(platformId)` see `cometchat-angular-patterns` § 7 |
181
- | `document is not defined` during SSR | Same cause | Same fix |
182
- | Components render on server but throw | CometChat components use browser APIs | Wrap `<cometchat-*>` tags with `*ngIf="isBrowser"` |
185
+ | `window is not defined` during SSR / prerender | The kit + SDK use browser-only APIs | Guard init/login with `isPlatformBrowser(this.platformId)`; only run CometChat in the browser. See `cometchat-angular-patterns` |
186
+ | `document is not defined` during SSR | Same cause | Same guard |
187
+ | `<cometchat-*>` errors on the server | Components touch browser APIs at render | Gate the tags with `*ngIf="isBrowser"`, where `isBrowser = isPlatformBrowser(platformId)` |
183
188
 
184
189
  ---
185
190
 
186
191
  ## 3. Deep dives on common failures
187
192
 
188
- ### 3a. "The most common 'why is my chat blank' bug"
193
+ ### 3a. "is not a known element" the v5 standalone-import fix
194
+
195
+ v5 components are **standalone Angular components** (not generic web components). The fix is to import the component **class** into the host standalone component's `imports: []` — never `CUSTOM_ELEMENTS_SCHEMA`:
189
196
 
190
- CometChat components fill 100% of their parent's height. If the parent has no bounded height, the components render at 0px and look empty.
197
+ ```typescript
198
+ import { Component } from "@angular/core";
199
+ import { CometChatConversationsComponent } from "@cometchat/chat-uikit-angular";
200
+
201
+ @Component({
202
+ selector: "app-chat",
203
+ standalone: true,
204
+ imports: [CometChatConversationsComponent], // ← register the class you render
205
+ template: `<cometchat-conversations></cometchat-conversations>`,
206
+ })
207
+ export class ChatComponent {}
208
+ ```
191
209
 
192
- Diagnostic:
210
+ - The class carries the `Component` suffix (`CometChatConversationsComponent`); the selector does not (`<cometchat-conversations>`).
211
+ - Import only the components you actually use.
212
+ - If you add `CUSTOM_ELEMENTS_SCHEMA`, Angular stops complaining but the real component never instantiates — you get a blank render instead of an error. Remove it and import the class.
213
+ - On a not-yet-migrated NgModule app, standalone classes can go into `@NgModule({ imports: [...] })` — still no schema.
214
+
215
+ ### 3b. The most common "why is my chat blank" bug — inline elements + bounded height
216
+
217
+ The kit's `<cometchat-*>` elements are **`display: inline` by default** — they do not flex, fill, or scroll on their own. Two things are load-bearing: (1) the host is a flex column with a resolvable height, and (2) each custom element is itself made a flex column. A parent with no bounded height — or an element left inline — renders the list at 0px or makes it overflow instead of scroll.
193
218
 
194
219
  ```bash
195
- # Check the parent container of the CometChat component
196
- grep -B5 "cometchat-message-list\|cometchat-conversations" src/app/**/*.html
220
+ grep -rB5 "cometchat-message-list\|cometchat-conversations" src/app
197
221
  ```
198
222
 
199
- Look for the component's parent. One of these must be true:
200
- - Parent has `height: 100vh` or `height: 100%`
201
- - Parent is a flex column with the component getting `flex: 1`
202
- - Parent has an explicit `height: Npx`
203
-
204
- Broken example:
223
+ Broken:
205
224
  ```html
206
- <!-- ✗ WRONG — div has no height -->
225
+ <!-- ✗ div has no height; element left inline -->
207
226
  <div>
208
227
  <cometchat-message-list [user]="selectedUser"></cometchat-message-list>
209
228
  </div>
@@ -211,106 +230,121 @@ Broken example:
211
230
 
212
231
  Fixed:
213
232
  ```html
214
- <!-- ✓ RIGHT -->
233
+ <!-- ✓ host is a flex column with height; element made a flex column with min-height: 0 -->
215
234
  <div style="height: 100vh; display: flex; flex-direction: column;">
216
235
  <cometchat-message-list
217
236
  [user]="selectedUser"
218
- style="flex: 1; overflow: hidden;"
237
+ style="flex: 1; min-height: 0; overflow: hidden; display: flex; flex-direction: column;"
219
238
  ></cometchat-message-list>
220
239
  </div>
221
240
  ```
222
241
 
223
- ### 3b. "Unknown element" errors for `<cometchat-*>` tags
242
+ - `min-height: 0` is the part everyone forgets: a flex child defaults to `min-height: auto`, so without it the list grows past the parent and overflows the viewport instead of scrolling internally.
243
+ - The `height: 100%` chain needs a root — set `html, body { height: 100% }` in global styles, otherwise `height: 100%` resolves against an auto-height ancestor and collapses.
244
+ - See `cometchat-angular-placement` for the full sidebar / two-pane / Material-tab host contracts.
224
245
 
225
- Two separate fixes are both required:
246
+ ### 3c. Components render before init completes
226
247
 
227
- 1. **Import the component** in the module's `imports` array:
228
- ```typescript
229
- import { CometChatConversations } from "@cometchat/chat-uikit-angular";
230
- @NgModule({ imports: [CometChatConversations] })
231
- ```
248
+ Most reliable fix — resolve `CometChatUIKit.init(...)` in `main.ts` **before** `bootstrapApplication(...)` so nothing mounts until the SDK is ready (the v5 canonical — see `cometchat-angular-core` §3 and `cometchat-angular-patterns`):
232
249
 
233
- 2. **Add `CUSTOM_ELEMENTS_SCHEMA`** to the module's `schemas`:
234
- ```typescript
235
- import { CUSTOM_ELEMENTS_SCHEMA } from "@angular/core";
236
- @NgModule({ schemas: [CUSTOM_ELEMENTS_SCHEMA] })
237
- ```
250
+ ```typescript
251
+ // main.ts
252
+ import { bootstrapApplication } from "@angular/platform-browser";
253
+ import { UIKitSettingsBuilder, CometChatUIKit } from "@cometchat/chat-uikit-angular";
254
+ import { environment } from "./environments/environment";
255
+ import { App } from "./app/app";
256
+ import { appConfig } from "./app/app.config";
257
+
258
+ const settings = new UIKitSettingsBuilder()
259
+ .setAppId(environment.cometchat.appId)
260
+ .setRegion(environment.cometchat.region)
261
+ .setAuthKey(environment.cometchat.authKey)
262
+ .subscribePresenceForAllUsers()
263
+ .build();
264
+
265
+ CometChatUIKit.init(settings)
266
+ .then(() => bootstrapApplication(App, appConfig))
267
+ .catch((err) => console.error("CometChat init failed:", err));
268
+ ```
238
269
 
239
- Both are required. Missing either one produces the "Unknown element" error.
270
+ Alternative block bootstrap with an `APP_INITIALIZER` factory that returns the init Promise (Angular waits for it before mounting):
240
271
 
241
- ### 3c. Components render before init completes
272
+ ```typescript
273
+ // providers: [{ provide: APP_INITIALIZER, useFactory: () => () => CometChatUIKit.init(settings), multi: true }]
274
+ ```
242
275
 
243
- The most reliable fix is `APP_INITIALIZER` (see `cometchat-angular-patterns` § 1). If not using `APP_INITIALIZER`, use `*ngIf="isReady"`:
276
+ If you don't want to block bootstrap, init in `AppComponent.ngOnInit()` and gate the outlet:
244
277
 
245
278
  ```typescript
246
- // app.component.ts
247
279
  isReady = false;
248
280
 
249
281
  ngOnInit(): void {
282
+ const settings = /* UIKitSettingsBuilder … .build() */;
250
283
  CometChatUIKit.init(settings)
251
284
  .then(() => CometChatUIKit.getLoggedinUser())
252
- .then((user) => user || CometChatUIKit.login({ uid: "cometchat-uid-1" }))
285
+ .then((user) => user || CometChatUIKit.login("cometchat-uid-1")) // bare string
253
286
  .then(() => (this.isReady = true))
254
287
  .catch(console.error);
255
288
  }
256
289
  ```
257
290
 
258
291
  ```html
259
- <!-- app.component.html -->
260
292
  <ng-container *ngIf="isReady">
261
293
  <router-outlet></router-outlet>
262
294
  </ng-container>
263
295
  ```
264
296
 
265
- ---
297
+ ### 3d. View not updating after an SDK callback (NgZone)
266
298
 
267
- ## 4. v3 v4 upgrade gotchas
299
+ CometChat SDK listeners fire outside Angular's zone, so a field you mutate in a callback won't trigger change detection. Re-enter the zone (or prefer the `async` pipe over `loggedInUser$`):
268
300
 
269
- If the user is upgrading from `@cometchat/chat-uikit-angular@3`, these are the common breakages.
301
+ ```typescript
302
+ import { NgZone } from "@angular/core";
270
303
 
271
- | v3 | v4 | Notes |
272
- |---|---|---|
273
- | `CometChatTheme` class | `CometChatThemeService` (Angular DI) | Theme is now an injectable service |
274
- | `CometChatConversationsWithMessages` composite | Still available but configuration API changed | Check `[conversationsConfiguration]` + `[messagesConfiguration]` props |
275
- | `theme` prop on components | Theme via `CometChatThemeService` only | Per-component theme prop removed |
276
- | `onClick` callback names | `onItemClick` callback names | Renamed for consistency |
277
- | `CometChat.login(uid, authKey)` | `CometChatUIKit.login({ uid })` | Object-form argument |
278
- | Flat settings object | `UIKitSettingsBuilder` | Builder pattern required |
304
+ constructor(private zone: NgZone) {}
279
305
 
280
- ### Upgrade sequence
306
+ // inside an SDK listener callback:
307
+ this.zone.run(() => {
308
+ this.latestMessage = message; // now change detection runs
309
+ });
310
+ ```
281
311
 
282
- ```bash
283
- # 1. Update the main kit
284
- npm install @cometchat/chat-uikit-angular@latest
285
-
286
- # 2. Update peer packages
287
- npm install @cometchat/uikit-elements@latest @cometchat/uikit-resources@latest @cometchat/uikit-shared@latest
288
-
289
- # 3. Replace flat settings object with UIKitSettingsBuilder
290
- # 4. Replace CometChatTheme class with CometChatThemeService injection
291
- # 5. Rename onClick → onItemClick throughout templates
292
- # 6. Add CUSTOM_ELEMENTS_SCHEMA to all modules (new requirement in v4)
293
- # 7. Add assets config to angular.json (new requirement in v4)
294
- # 8. Rebuild + test
312
+ Idiomatic alternative — bind the observable directly so Angular owns the subscription:
313
+
314
+ ```html
315
+ <span *ngIf="uiKit.loggedInUser$ | async as user">{{ user.getName() }}</span>
295
316
  ```
296
317
 
318
+ ### 3e. `ng build` warns "Module '@cometchat/chat-sdk-javascript' … is not ESM" — benign
319
+
320
+ A successful `ng build` emits a **CommonJS-interop optimization-bailout WARNING** for `@cometchat/chat-sdk-javascript` (the chat SDK is published as CommonJS, not ESM). This is **harmless** — the build still exits 0 and the kit works. Do NOT try to "fix" it by switching SDK imports around. If you want to silence it, add the package to `angular.json` → `architect.build.options.allowedCommonJsDependencies`:
321
+
322
+ ```json
323
+ "allowedCommonJsDependencies": ["@cometchat/chat-sdk-javascript"]
324
+ ```
325
+
326
+ (Verified 2026-06-14: fresh Angular 21 + `@cometchat/chat-uikit-angular@5.0.2` build succeeds with only this warning.)
327
+
297
328
  ---
298
329
 
299
- ## 5. Escalation — when the above doesn't solve it
330
+ ## 4. Escalation — when the above doesn't solve it
300
331
 
301
- 1. **Read the raw error.** Angular errors are usually specific — "Can't bind to 'user'" is different from "NullInjectorError".
302
- 2. **Check the browser console + Angular DevTools.** Angular DevTools shows the component tree and change detection state.
303
- 3. **Search the upstream docs MCP** (`cometchat-docs` if installed).
304
- 4. **If the issue is a kit bug**, file at https://github.com/cometchat/cometchat-uikit-angular/issues with a minimal repro.
332
+ 1. **Read the raw error.** "is not a known element" (missing standalone import) is a different problem from "NullInjectorError" (DI) or "window is not defined" (SSR).
333
+ 2. **Check the browser console + Angular DevTools.** DevTools shows the component tree and change-detection state — useful for the NgZone class of bugs.
334
+ 3. **Confirm versions:** Angular 17–21, `@cometchat/chat-uikit-angular@^5`, `@cometchat/chat-sdk-javascript@^4.1`, and `@cometchat/calls-sdk-javascript@^5` for calls.
335
+ 4. **Search the upstream docs MCP** (`cometchat-docs` if installed) for prop/event/error meanings.
336
+ 5. **If it's a kit bug**, file at https://github.com/cometchat/cometchat-uikit-angular/issues with a minimal standalone-component repro.
305
337
 
306
338
  ---
307
339
 
308
- ## 6. Hard rules (diagnostic best-practice)
340
+ ## 5. Hard rules (diagnostic best-practice)
309
341
 
310
- 1. **Don't assume — triage first.** § 1 gets the schema, assets, init state, and module imports before proposing a fix.
311
- 2. **Don't suggest "try reinstalling node_modules" as a first step.** Check the schema, assets config, and module imports first.
312
- 3. **When recommending a rebuild, say why + what to rebuild.** "`ng build` after adding assets config" is more useful than "try rebuilding."
313
- 4. **Never guess a fix that requires code changes without first gathering facts.**
342
+ 1. **Triage first (§1):** Angular version, assets config, init/render order, standalone imports, peer SDKs — before proposing a fix.
343
+ 2. **Never suggest `CUSTOM_ELEMENTS_SCHEMA`** for an unknown `<cometchat-*>` element the v5 fix is importing the `*Component` class into `imports: []`.
344
+ 3. **Never suggest `CometChatThemeService`, `CometChatUIKitLoginListener`, `login({ uid })`, or `@cometchat/uikit-shared`** all are v4 and absent in v5.
345
+ 4. **Don't lead with "reinstall node_modules."** Check version/peers, assets, init order, and imports first.
346
+ 5. **When recommending a rebuild/restart, say what and why** — e.g. "restart `ng serve` after editing `angular.json` (read at startup)."
347
+ 6. **Don't propose code changes before gathering facts.**
314
348
 
315
349
  ---
316
350
 
@@ -318,12 +352,13 @@ npm install @cometchat/uikit-elements@latest @cometchat/uikit-resources@latest @
318
352
 
319
353
  | Skill | When to route |
320
354
  |---|---|
321
- | `cometchat-angular-core` | Most "doesn't work" bugs trace back here — init/login/module setup |
322
- | `cometchat-angular-components` | Wrong input / slot view / request builder |
323
- | `cometchat-angular-placement` | Blank chat / bounded-height issues |
324
- | `cometchat-angular-patterns` | Route guard, lazy loading, SSR, APP_INITIALIZER |
325
- | `cometchat-angular-theming` | Theme not applying, dark mode not switching |
326
- | `cometchat-angular-features` | Calls don't work, extension UI missing after enable |
355
+ | `cometchat-angular-core` | Most "doesn't work" bugs trace here — init/login/standalone setup |
356
+ | `cometchat-angular-components` | Wrong input / `@Input`-callback vs `@Output` / slot template / request builder |
357
+ | `cometchat-angular-placement` | Blank chat / bounded-height / two-pane composition |
358
+ | `cometchat-angular-patterns` | Standalone wiring, route guard, lazy loading, SSR guard, NgZone |
359
+ | `cometchat-angular-theming` | CSS variables not applying, dark mode, ViewEncapsulation |
360
+ | `cometchat-angular-features` | Extension UI missing after enable |
361
+ | `cometchat-angular-calls` | Calls don't start, incoming-call UI, calls-sdk peer |
327
362
  | `cometchat-angular-customization` | Formatter not rendering, listener not firing, template not showing |
328
- | `cometchat-angular-production` | 401 on token fetch, user-does-not-exist on login |
329
- | `cometchat-angular-troubleshooting` | This skill — cross-category diagnosis + v3→v4 upgrade |
363
+ | `cometchat-angular-production` | 401 on token fetch, user-does-not-exist on token login |
364
+ | `cometchat-angular-troubleshooting` | This skill — cross-category v5 diagnosis |