@cometchat/skills 4.3.0 → 4.4.1

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 (233) hide show
  1. package/LICENSE +21 -0
  2. package/bin/install.js +27 -0
  3. package/package.json +14 -1
  4. package/skills/cometchat/SKILL.md +233 -69
  5. package/skills/cometchat/references/asking-questions.md +48 -0
  6. package/skills/cometchat-a11y/SKILL.md +3 -2
  7. package/skills/cometchat-android-v5/SKILL.md +2 -1
  8. package/skills/cometchat-android-v5-calls/SKILL.md +36 -22
  9. package/skills/cometchat-android-v5-calls/references/README.md +1 -1
  10. package/skills/cometchat-android-v5-calls/references/add-calls-to-existing-chat.md +7 -5
  11. package/skills/cometchat-android-v5-calls/references/audio-controls.md +4 -4
  12. package/skills/cometchat-android-v5-calls/references/call-layouts.md +33 -25
  13. package/skills/cometchat-android-v5-calls/references/call-session.md +2 -2
  14. package/skills/cometchat-android-v5-calls/references/custom-ui.md +5 -5
  15. package/skills/cometchat-android-v5-calls/references/event-listeners.md +2 -2
  16. package/skills/cometchat-android-v5-calls/references/idle-timeout.md +20 -14
  17. package/skills/cometchat-android-v5-calls/references/in-call-chat.md +1 -1
  18. package/skills/cometchat-android-v5-calls/references/migration-v4-to-v5.md +43 -27
  19. package/skills/cometchat-android-v5-calls/references/participant-management.md +3 -3
  20. package/skills/cometchat-android-v5-calls/references/raise-hand.md +25 -19
  21. package/skills/cometchat-android-v5-calls/references/recording.md +2 -2
  22. package/skills/cometchat-android-v5-calls/references/ringing-integration.md +1 -1
  23. package/skills/cometchat-android-v5-calls/references/screen-sharing.md +5 -9
  24. package/skills/cometchat-android-v5-calls/references/session-settings.md +3 -3
  25. package/skills/cometchat-android-v5-calls/references/setup.md +1 -1
  26. package/skills/cometchat-android-v5-calls/references/share-invite.md +9 -4
  27. package/skills/cometchat-android-v5-calls/references/video-controls.md +4 -4
  28. package/skills/cometchat-android-v5-calls/references/voip-calling.md +2 -2
  29. package/skills/cometchat-android-v5-components/SKILL.md +4 -3
  30. package/skills/cometchat-android-v5-core/SKILL.md +5 -3
  31. package/skills/cometchat-android-v5-customization/SKILL.md +171 -7
  32. package/skills/cometchat-android-v5-extensions/SKILL.md +7 -4
  33. package/skills/cometchat-android-v5-features/SKILL.md +5 -4
  34. package/skills/cometchat-android-v5-placement/SKILL.md +2 -1
  35. package/skills/cometchat-android-v5-production/SKILL.md +2 -1
  36. package/skills/cometchat-android-v5-push/SKILL.md +2 -3
  37. package/skills/cometchat-android-v5-testing/SKILL.md +2 -1
  38. package/skills/cometchat-android-v5-theming/SKILL.md +2 -1
  39. package/skills/cometchat-android-v5-troubleshooting/SKILL.md +3 -2
  40. package/skills/cometchat-android-v6/SKILL.md +2 -1
  41. package/skills/cometchat-android-v6-builder-settings/SKILL.md +11 -7
  42. package/skills/cometchat-android-v6-calls/SKILL.md +79 -18
  43. package/skills/cometchat-android-v6-calls/references/advanced-features.md +87 -0
  44. package/skills/cometchat-android-v6-calls/references/call-layouts.md +24 -15
  45. package/skills/cometchat-android-v6-calls/references/call-session.md +2 -2
  46. package/skills/cometchat-android-v6-calls/references/device-management.md +17 -16
  47. package/skills/cometchat-android-v6-calls/references/idle-timeout.md +7 -4
  48. package/skills/cometchat-android-v6-calls/references/in-call-chat.md +13 -8
  49. package/skills/cometchat-android-v6-calls/references/raise-hand.md +6 -4
  50. package/skills/cometchat-android-v6-compose-components/SKILL.md +52 -29
  51. package/skills/cometchat-android-v6-compose-customization/SKILL.md +156 -1
  52. package/skills/cometchat-android-v6-compose-placement/SKILL.md +129 -40
  53. package/skills/cometchat-android-v6-compose-theming/SKILL.md +27 -1
  54. package/skills/cometchat-android-v6-core/SKILL.md +208 -28
  55. package/skills/cometchat-android-v6-events/SKILL.md +4 -1
  56. package/skills/cometchat-android-v6-extensions/SKILL.md +2 -1
  57. package/skills/cometchat-android-v6-features/SKILL.md +26 -2
  58. package/skills/cometchat-android-v6-kotlin-components/SKILL.md +31 -1
  59. package/skills/cometchat-android-v6-kotlin-customization/SKILL.md +172 -1
  60. package/skills/cometchat-android-v6-kotlin-placement/SKILL.md +20 -5
  61. package/skills/cometchat-android-v6-kotlin-theming/SKILL.md +36 -5
  62. package/skills/cometchat-android-v6-migration/SKILL.md +44 -42
  63. package/skills/cometchat-android-v6-production/SKILL.md +6 -3
  64. package/skills/cometchat-android-v6-push/SKILL.md +43 -2
  65. package/skills/cometchat-android-v6-testing/SKILL.md +11 -8
  66. package/skills/cometchat-android-v6-troubleshooting/SKILL.md +26 -5
  67. package/skills/cometchat-angular-calls/SKILL.md +256 -389
  68. package/skills/cometchat-angular-calls/references/add-calls-to-existing-chat.md +3 -2
  69. package/skills/cometchat-angular-calls/references/call-layouts.md +29 -12
  70. package/skills/cometchat-angular-calls/references/call-session.md +2 -2
  71. package/skills/cometchat-angular-calls/references/custom-ui.md +18 -10
  72. package/skills/cometchat-angular-calls/references/device-management.md +53 -34
  73. package/skills/cometchat-angular-calls/references/group-calls.md +45 -24
  74. package/skills/cometchat-angular-calls/references/idle-timeout.md +31 -15
  75. package/skills/cometchat-angular-calls/references/ngzone-and-async-callbacks.md +7 -6
  76. package/skills/cometchat-angular-calls/references/raise-hand.md +9 -4
  77. package/skills/cometchat-angular-calls/references/recording-screen-share.md +32 -39
  78. package/skills/cometchat-angular-calls/references/ringing-integration.md +3 -1
  79. package/skills/cometchat-angular-calls/references/share-invite.md +11 -5
  80. package/skills/cometchat-angular-calls/references/virtual-background.md +29 -0
  81. package/skills/cometchat-angular-components/SKILL.md +149 -620
  82. package/skills/cometchat-angular-core/SKILL.md +232 -312
  83. package/skills/cometchat-angular-customization/SKILL.md +415 -223
  84. package/skills/cometchat-angular-features/SKILL.md +216 -334
  85. package/skills/cometchat-angular-patterns/SKILL.md +168 -359
  86. package/skills/cometchat-angular-placement/SKILL.md +189 -560
  87. package/skills/cometchat-angular-production/SKILL.md +241 -92
  88. package/skills/cometchat-angular-push/SKILL.md +280 -294
  89. package/skills/cometchat-angular-testing/SKILL.md +430 -158
  90. package/skills/cometchat-angular-theming/SKILL.md +190 -265
  91. package/skills/cometchat-angular-troubleshooting/SKILL.md +192 -157
  92. package/skills/cometchat-astro-patterns/SKILL.md +3 -2
  93. package/skills/cometchat-calls/SKILL.md +25 -19
  94. package/skills/cometchat-calls/references/use-case-broadcast.md +15 -10
  95. package/skills/cometchat-calls/references/use-case-marketplace.md +2 -3
  96. package/skills/cometchat-calls/references/use-case-support.md +3 -4
  97. package/skills/cometchat-calls/references/use-case-team.md +23 -12
  98. package/skills/cometchat-calls/references/use-case-telehealth.md +3 -4
  99. package/skills/cometchat-components/SKILL.md +163 -25
  100. package/skills/cometchat-core/SKILL.md +258 -20
  101. package/skills/cometchat-customization/SKILL.md +50 -25
  102. package/skills/cometchat-features/SKILL.md +314 -35
  103. package/skills/cometchat-flutter-v5/SKILL.md +10 -4
  104. package/skills/cometchat-flutter-v5-calls/SKILL.md +188 -158
  105. package/skills/cometchat-flutter-v5-calls/references/add-calls-to-existing-chat.md +48 -24
  106. package/skills/cometchat-flutter-v5-calls/references/call-layouts.md +20 -15
  107. package/skills/cometchat-flutter-v5-calls/references/call-session.md +100 -145
  108. package/skills/cometchat-flutter-v5-calls/references/device-management.md +12 -8
  109. package/skills/cometchat-flutter-v5-calls/references/group-calls.md +30 -36
  110. package/skills/cometchat-flutter-v5-calls/references/idle-timeout.md +15 -13
  111. package/skills/cometchat-flutter-v5-calls/references/in-call-chat.md +12 -9
  112. package/skills/cometchat-flutter-v5-calls/references/migration-v4-to-v5.md +115 -65
  113. package/skills/cometchat-flutter-v5-calls/references/raise-hand.md +41 -30
  114. package/skills/cometchat-flutter-v5-calls/references/ringing-integration.md +17 -14
  115. package/skills/cometchat-flutter-v5-calls/references/share-invite.md +8 -2
  116. package/skills/cometchat-flutter-v5-conversations/SKILL.md +2 -1
  117. package/skills/cometchat-flutter-v5-core/SKILL.md +5 -4
  118. package/skills/cometchat-flutter-v5-customization/SKILL.md +136 -5
  119. package/skills/cometchat-flutter-v5-events/SKILL.md +2 -1
  120. package/skills/cometchat-flutter-v5-messages/SKILL.md +2 -1
  121. package/skills/cometchat-flutter-v5-production/SKILL.md +15 -6
  122. package/skills/cometchat-flutter-v5-push/SKILL.md +2 -1
  123. package/skills/cometchat-flutter-v5-testing/SKILL.md +17 -6
  124. package/skills/cometchat-flutter-v5-theming/SKILL.md +2 -1
  125. package/skills/cometchat-flutter-v5-troubleshooting/SKILL.md +7 -6
  126. package/skills/cometchat-flutter-v5-users-groups/SKILL.md +3 -2
  127. package/skills/cometchat-flutter-v6/SKILL.md +17 -16
  128. package/skills/cometchat-flutter-v6-calls/SKILL.md +72 -57
  129. package/skills/cometchat-flutter-v6-calls/references/add-calls-to-existing-chat.md +5 -3
  130. package/skills/cometchat-flutter-v6-calls/references/advanced-features.md +89 -0
  131. package/skills/cometchat-flutter-v6-calls/references/call-layouts.md +15 -12
  132. package/skills/cometchat-flutter-v6-calls/references/call-session.md +2 -2
  133. package/skills/cometchat-flutter-v6-calls/references/device-management.md +9 -3
  134. package/skills/cometchat-flutter-v6-calls/references/group-calls.md +10 -10
  135. package/skills/cometchat-flutter-v6-calls/references/idle-timeout.md +15 -7
  136. package/skills/cometchat-flutter-v6-calls/references/in-call-chat.md +6 -3
  137. package/skills/cometchat-flutter-v6-calls/references/raise-hand.md +23 -16
  138. package/skills/cometchat-flutter-v6-components/SKILL.md +32 -11
  139. package/skills/cometchat-flutter-v6-conversations/SKILL.md +39 -11
  140. package/skills/cometchat-flutter-v6-core/SKILL.md +182 -21
  141. package/skills/cometchat-flutter-v6-customization/SKILL.md +97 -25
  142. package/skills/cometchat-flutter-v6-events/SKILL.md +3 -2
  143. package/skills/cometchat-flutter-v6-features/SKILL.md +15 -6
  144. package/skills/cometchat-flutter-v6-messages/SKILL.md +111 -60
  145. package/skills/cometchat-flutter-v6-migration/SKILL.md +18 -25
  146. package/skills/cometchat-flutter-v6-placement/SKILL.md +79 -50
  147. package/skills/cometchat-flutter-v6-production/SKILL.md +13 -12
  148. package/skills/cometchat-flutter-v6-push/SKILL.md +41 -19
  149. package/skills/cometchat-flutter-v6-testing/SKILL.md +4 -4
  150. package/skills/cometchat-flutter-v6-theming/SKILL.md +38 -5
  151. package/skills/cometchat-flutter-v6-troubleshooting/SKILL.md +182 -17
  152. package/skills/cometchat-flutter-v6-users-groups/SKILL.md +12 -4
  153. package/skills/cometchat-i18n/SKILL.md +140 -79
  154. package/skills/cometchat-ios/SKILL.md +4 -2
  155. package/skills/cometchat-ios-calls/SKILL.md +225 -95
  156. package/skills/cometchat-ios-calls/references/add-calls-to-existing-chat.md +11 -9
  157. package/skills/cometchat-ios-calls/references/audio-modes-and-controls.md +45 -0
  158. package/skills/cometchat-ios-calls/references/avaudiosession-routing.md +6 -7
  159. package/skills/cometchat-ios-calls/references/call-layouts.md +31 -91
  160. package/skills/cometchat-ios-calls/references/call-session.md +51 -54
  161. package/skills/cometchat-ios-calls/references/callkit-and-pushkit.md +33 -29
  162. package/skills/cometchat-ios-calls/references/custom-ui.md +38 -38
  163. package/skills/cometchat-ios-calls/references/group-calls.md +33 -70
  164. package/skills/cometchat-ios-calls/references/idle-timeout.md +24 -25
  165. package/skills/cometchat-ios-calls/references/in-call-chat.md +19 -23
  166. package/skills/cometchat-ios-calls/references/migration-v4-to-v5.md +128 -70
  167. package/skills/cometchat-ios-calls/references/picture-in-picture.md +20 -20
  168. package/skills/cometchat-ios-calls/references/raise-hand.md +14 -227
  169. package/skills/cometchat-ios-calls/references/recording-screen-share.md +35 -122
  170. package/skills/cometchat-ios-calls/references/ringing-integration.md +17 -16
  171. package/skills/cometchat-ios-calls/references/share-invite.md +8 -12
  172. package/skills/cometchat-ios-calls/references/swiftui-uikit-hosting.md +4 -4
  173. package/skills/cometchat-ios-components/SKILL.md +200 -12
  174. package/skills/cometchat-ios-core/SKILL.md +173 -45
  175. package/skills/cometchat-ios-customization/SKILL.md +276 -110
  176. package/skills/cometchat-ios-features/SKILL.md +64 -36
  177. package/skills/cometchat-ios-placement/SKILL.md +15 -12
  178. package/skills/cometchat-ios-production/SKILL.md +12 -4
  179. package/skills/cometchat-ios-push/SKILL.md +53 -19
  180. package/skills/cometchat-ios-testing/SKILL.md +14 -9
  181. package/skills/cometchat-ios-theming/SKILL.md +39 -3
  182. package/skills/cometchat-ios-troubleshooting/SKILL.md +41 -21
  183. package/skills/cometchat-native-bare-patterns/SKILL.md +36 -19
  184. package/skills/cometchat-native-calls/SKILL.md +29 -17
  185. package/skills/cometchat-native-calls/references/add-calls-to-existing-chat.md +2 -2
  186. package/skills/cometchat-native-calls/references/call-layouts.md +15 -14
  187. package/skills/cometchat-native-calls/references/call-session.md +2 -2
  188. package/skills/cometchat-native-calls/references/custom-ui.md +12 -8
  189. package/skills/cometchat-native-calls/references/device-management.md +53 -30
  190. package/skills/cometchat-native-calls/references/group-calls.md +35 -30
  191. package/skills/cometchat-native-calls/references/idle-timeout.md +6 -6
  192. package/skills/cometchat-native-calls/references/in-call-chat.md +10 -8
  193. package/skills/cometchat-native-calls/references/migration-v4-to-v5.md +2 -2
  194. package/skills/cometchat-native-calls/references/raise-hand.md +15 -13
  195. package/skills/cometchat-native-calls/references/recording-screen-share.md +49 -170
  196. package/skills/cometchat-native-calls/references/share-invite.md +7 -5
  197. package/skills/cometchat-native-calls/references/voip-push-end-to-end.md +4 -2
  198. package/skills/cometchat-native-components/SKILL.md +84 -52
  199. package/skills/cometchat-native-core/SKILL.md +102 -33
  200. package/skills/cometchat-native-customization/SKILL.md +150 -28
  201. package/skills/cometchat-native-expo-patterns/SKILL.md +60 -29
  202. package/skills/cometchat-native-features/SKILL.md +24 -17
  203. package/skills/cometchat-native-placement/SKILL.md +19 -10
  204. package/skills/cometchat-native-production/SKILL.md +9 -3
  205. package/skills/cometchat-native-push/SKILL.md +2 -1
  206. package/skills/cometchat-native-testing/SKILL.md +1 -2
  207. package/skills/cometchat-native-theming/SKILL.md +54 -29
  208. package/skills/cometchat-native-troubleshooting/SKILL.md +11 -5
  209. package/skills/cometchat-nextjs-patterns/SKILL.md +22 -8
  210. package/skills/cometchat-placement/SKILL.md +42 -3
  211. package/skills/cometchat-production/SKILL.md +12 -5
  212. package/skills/cometchat-react-calls/SKILL.md +220 -10
  213. package/skills/cometchat-react-calls/references/add-calls-to-existing-chat.md +4 -3
  214. package/skills/cometchat-react-calls/references/call-layouts.md +5 -6
  215. package/skills/cometchat-react-calls/references/call-session.md +1 -1
  216. package/skills/cometchat-react-calls/references/custom-ui.md +61 -15
  217. package/skills/cometchat-react-calls/references/device-management.md +55 -51
  218. package/skills/cometchat-react-calls/references/group-calls.md +18 -23
  219. package/skills/cometchat-react-calls/references/idle-timeout.md +25 -12
  220. package/skills/cometchat-react-calls/references/in-call-chat.md +7 -7
  221. package/skills/cometchat-react-calls/references/migration-v4-to-v5.md +9 -11
  222. package/skills/cometchat-react-calls/references/raise-hand.md +14 -14
  223. package/skills/cometchat-react-calls/references/recording-screen-share.md +39 -38
  224. package/skills/cometchat-react-calls/references/ringing-integration.md +2 -2
  225. package/skills/cometchat-react-calls/references/share-invite.md +4 -5
  226. package/skills/cometchat-react-calls/references/testing-calls-on-web.md +20 -2
  227. package/skills/cometchat-react-calls/references/virtual-background.md +32 -0
  228. package/skills/cometchat-react-patterns/SKILL.md +45 -5
  229. package/skills/cometchat-react-push/SKILL.md +258 -72
  230. package/skills/cometchat-react-router-patterns/SKILL.md +12 -6
  231. package/skills/cometchat-react-testing/SKILL.md +14 -5
  232. package/skills/cometchat-theming/SKILL.md +181 -18
  233. package/skills/cometchat-troubleshooting/SKILL.md +40 -20
@@ -1,44 +1,48 @@
1
1
  ---
2
2
  name: cometchat-angular-testing
3
- description: Testing patterns for CometChat Angular UI Kit v4 in Angular 12-15 projects. Covers Karma (default Angular test runner) and Jest (jest-preset-angular alternative), TestBed configuration with CometChatUIKitModule mocking, NgZone-aware async assertions, Cypress for e2e flows with WebSocket waits, and CI configuration. Sister skill of cometchat-angular-calls/references for the calls-specific testing patterns.
3
+ description: Testing patterns for CometChat Angular UI Kit v5 (@cometchat/chat-uikit-angular@5) in Angular 17–21 projects. Covers Jasmine/Karma (default) and Jest, Angular TestBed for STANDALONE components (imports[] not declarations[]), mocking the static CometChatUIKit kit API (init/login/getLoggedInUser/getLoggedinUser/loginWithAuthToken/logout) and the loggedInUser$ observable, fakeAsync/tick for Promise-based login, stubbing the kit's standalone <cometchat-*> components, Playwright/Cypress e2e, and CI. Mirrors cometchat-react-testing for the mocking philosophy.
4
4
  license: "MIT"
5
- compatibility: "Angular 12-15 (LTS focus on 15); Karma + Jasmine (default) OR Jest + jest-preset-angular; Cypress >= 13; @cometchat/chat-uikit-angular ^4.x"
6
- allowed-tools: "shell, file-read, file-search, file-list, ask-user"
5
+ compatibility: "Angular >=17 <22; @cometchat/chat-uikit-angular ^5.0; Jasmine + Karma (default ng test) OR Jest + jest-preset-angular; Playwright >= 1.40 OR Cypress >= 13"
7
6
  metadata:
8
7
  author: "CometChat"
9
8
  version: "4.0.0"
10
- tags: "cometchat angular testing karma jest cypress testbed ngzone async fakeasync changedetection mocking"
9
+ tags: "cometchat angular testing jasmine karma jest testbed standalone fakeasync tick ngzone playwright cypress e2e mocking v5"
11
10
  ---
12
11
 
13
12
  ## Purpose
14
13
 
15
- Test recipes for CometChat Angular UI Kit integrations. Covers both Angular runners (Karmadefault; Jest preferred by many teams), TestBed patterns specific to NgZone-driven components, and Cypress for full e2e.
14
+ Test recipes for CometChat **Angular UI Kit v5** (`@cometchat/chat-uikit-angular@5`) integrations. Three layers unit, component, e2e three different mocking strategies. This skill writes the configuration and the canonical assertions; real test bodies are app-specific.
15
+
16
+ v5 is **standalone-component-based** (Angular 17–21). That changes how you test, versus the old v4 NgModule kit: standalone components go in TestBed's `imports`, **never** `declarations`; and v5 components are real Angular components, so the old `CUSTOM_ELEMENTS_SCHEMA` crutch is **not** how you handle `<cometchat-*>` selectors — you stub the component classes instead.
16
17
 
17
18
  **Read these other skills first:**
18
- - `cometchat-angular-core` — init service, APP_INITIALIZER pattern
19
- - `cometchat-angular-patterns` — module setup, lazy loading
20
- - `cometchat-angular-calls/references/ngzone-and-async-callbacks.md` — NgZone primer (carries over to test patterns)
19
+ - `cometchat-angular-core` — the `init → login → render` order, the static `CometChatUIKit` API, and `loggedInUser$`. The tests below assert against exactly those.
20
+ - `cometchat-angular-patterns` — standalone wiring, NgZone, change detection.
21
+ - `cometchat-angular-calls` — for the calls-specific testing patterns (this skill is for chat).
21
22
 
22
- **Ground truth:**
23
- - Angular testinghttps://angular.io/guide/testing
23
+ **Ground truth:** **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).
24
+ - Installed kit types `node_modules/@cometchat/chat-uikit-angular/types/cometchat-chat-uikit-angular.d.ts`. Verify any non-obvious symbol here before relying on it.
25
+ - Angular testing — https://angular.dev/guide/testing
24
26
  - jest-preset-angular — https://github.com/thymikee/jest-preset-angular
25
- - Cypress for Angular — https://docs.cypress.io/guides/component-testing/angular/overview
27
+ - Playwright https://playwright.dev/ · Cypress — https://docs.cypress.io/
26
28
 
27
29
  ---
28
30
 
29
- ## 1. Karma vs Jest — pick one
31
+ ## 1. Jasmine/Karma vs Jest — pick one
30
32
 
31
- | Criterion | Karma (default) | Jest |
33
+ | Criterion | Jasmine + Karma (default) | Jest |
32
34
  |---|---|---|
33
35
  | Comes with `ng new` | ✓ | ✗ (manual setup) |
34
36
  | Speed | Slower (real browser) | Faster (jsdom) |
35
- | Real browser parity | Higher | Lower (no real CSS, no real layout) |
36
- | Snapshot testing | Possible (jasmine-jest-snapshot) | First-class |
37
- | CI complexity | Need ChromeHeadless | Pure Node |
37
+ | Real browser parity | Higher | Lower (no real CSS / layout) |
38
+ | Snapshot testing | Awkward | First-class |
39
+ | CI complexity | Needs ChromeHeadless | Pure Node |
40
+
41
+ Default to Jasmine/Karma if the project already uses it (every `ng new` through Angular 19 scaffolds it); use Jest if the team has already adopted it. The TestBed assertions in this skill are runner-agnostic — only the spy syntax differs (`jasmine.createSpyObj` / `spyOn` vs `jest.fn()` / `jest.spyOn`).
38
42
 
39
- The skill defaults to Karma if the project already uses it, Jest if greenfield.
43
+ > **Note (Angular 20+ / vitest):** Angular 20 ships an experimental **vitest** test runner, and the CometChat Angular kit's own test suite runs on vitest + `@analogjs/vitest-angular` (jsdom). If the consumer project already uses vitest, the same TestBed code below applies verbatim — spies become `vi.fn()` / `vi.spyOn(...).mockResolvedValue(...)`, and module mocks use `vi.mock("@cometchat/chat-uikit-angular", ...)`. The standalone `imports: [Component]` model is identical regardless of runner.
40
44
 
41
- ### Karma setup (default Angular)
45
+ ### Jasmine/Karma setup (default Angular)
42
46
 
43
47
  Already configured by `ng new`. The skill writes test files only.
44
48
 
@@ -54,9 +58,9 @@ ng add @angular-builders/jest
54
58
  ```js
55
59
  module.exports = {
56
60
  preset: "jest-preset-angular",
57
- setupFilesAfterEach: ["<rootDir>/setup-jest.ts"],
61
+ setupFilesAfterEnv: ["<rootDir>/setup-jest.ts"],
58
62
  globalSetup: "jest-preset-angular/global-setup",
59
- testPathIgnorePatterns: ["/node_modules/", "/dist/", "/cypress/"],
63
+ testPathIgnorePatterns: ["/node_modules/", "/dist/", "/cypress/", "/e2e/"],
60
64
  };
61
65
  ```
62
66
 
@@ -66,167 +70,427 @@ module.exports = {
66
70
  import "jest-preset-angular/setup-jest";
67
71
  ```
68
72
 
69
- `angular.json` test command becomes `ng test --code-coverage`.
73
+ ---
74
+
75
+ ## 2. Mocking the kit — `spyOn` the static `CometChatUIKit` methods
76
+
77
+ The cardinal rule (same as the React testing skill): **mock the static kit API; never hit the network in a unit/component test.** `CometChatUIKit.init` / `login` open a real WebSocket and call CometChat's backend — un-mocked, your tests are slow, flaky, and dependent on a live app.
78
+
79
+ The v5 kit surface you mock (verified against the installed `.d.ts`):
80
+
81
+ | Symbol | Shape | Notes |
82
+ |---|---|---|
83
+ | `CometChatUIKit.init(settings)` | `Promise<InitResult> \| undefined` | async — mock with `Promise.resolve(...)` |
84
+ | `CometChatUIKit.login(uid)` | `Promise<CometChat.User>` | **bare string uid**, not `{ uid }` |
85
+ | `CometChatUIKit.loginWithAuthToken(token)` | `Promise<CometChat.User>` | production token path |
86
+ | `CometChatUIKit.getLoggedInUser()` | `CometChat.User \| null` | **sync** getter (capital "In") |
87
+ | `CometChatUIKit.getLoggedinUser()` | `Promise<CometChat.User \| null>` | **async** getter (lowercase "in") |
88
+ | `CometChatUIKit.loggedInUser$` | observable | reactive current-user stream |
89
+ | `CometChatUIKit.logout()` | `Promise<LogoutResult>` | |
90
+
91
+ Get the casing right: `getLoggedInUser()` is synchronous and returns immediately; `getLoggedinUser()` returns a Promise. They are different methods — mocking the wrong one is a silent no-op that masks bugs.
92
+
93
+ ### Jasmine/Karma — `spyOn` the statics
94
+
95
+ ```ts
96
+ import { CometChatUIKit } from "@cometchat/chat-uikit-angular";
97
+ import { of } from "rxjs";
98
+
99
+ export const mockUser = { getUid: () => "cometchat-uid-1", getName: () => "Alice" } as any;
100
+
101
+ export function spyOnCometChatUIKit() {
102
+ spyOn(CometChatUIKit, "init").and.resolveTo({} as any);
103
+ spyOn(CometChatUIKit, "login").and.resolveTo(mockUser);
104
+ spyOn(CometChatUIKit, "loginWithAuthToken").and.resolveTo(mockUser);
105
+ spyOn(CometChatUIKit, "getLoggedInUser").and.returnValue(mockUser); // sync
106
+ spyOn(CometChatUIKit, "getLoggedinUser").and.resolveTo(mockUser); // async
107
+ spyOn(CometChatUIKit, "logout").and.resolveTo({} as any);
108
+ // loggedInUser$ is a static property, not a method — redefine it:
109
+ Object.defineProperty(CometChatUIKit, "loggedInUser$", {
110
+ value: of(mockUser), configurable: true,
111
+ });
112
+ }
113
+ ```
114
+
115
+ `.and.resolveTo(x)` is Jasmine sugar for `.and.returnValue(Promise.resolve(x))`. Call `spyOnCometChatUIKit()` in `beforeEach` **before** `fixture.detectChanges()`.
116
+
117
+ ### Jest — `jest.spyOn`
118
+
119
+ ```ts
120
+ import { CometChatUIKit } from "@cometchat/chat-uikit-angular";
121
+ import { of } from "rxjs";
122
+
123
+ export const mockUser = { getUid: () => "cometchat-uid-1", getName: () => "Alice" } as any;
124
+
125
+ export function spyOnCometChatUIKit() {
126
+ jest.spyOn(CometChatUIKit, "init").mockResolvedValue({} as any);
127
+ jest.spyOn(CometChatUIKit, "login").mockResolvedValue(mockUser);
128
+ jest.spyOn(CometChatUIKit, "loginWithAuthToken").mockResolvedValue(mockUser);
129
+ jest.spyOn(CometChatUIKit, "getLoggedInUser").mockReturnValue(mockUser); // sync
130
+ jest.spyOn(CometChatUIKit, "getLoggedinUser").mockResolvedValue(mockUser); // async
131
+ jest.spyOn(CometChatUIKit, "logout").mockResolvedValue({} as any);
132
+ Object.defineProperty(CometChatUIKit, "loggedInUser$", {
133
+ value: of(mockUser), configurable: true,
134
+ });
135
+ }
136
+ ```
137
+
138
+ ### Per-test override
139
+
140
+ ```ts
141
+ it("shows error when login fails", fakeAsync(() => {
142
+ // Jasmine: re-stub for this test
143
+ (CometChatUIKit.login as jasmine.Spy).and.rejectWith(new Error("401 Unauthorized"));
144
+ // Jest equivalent: .mockRejectedValueOnce(new Error("401 Unauthorized"))
145
+
146
+ fixture.detectChanges();
147
+ tick();
148
+ fixture.detectChanges();
149
+
150
+ expect(fixture.nativeElement.querySelector(".error-message").textContent)
151
+ .toContain("401");
152
+ }));
153
+ ```
154
+
155
+ > If your app wraps the kit in a `CometChatInitService` (the `cometchat-angular-core` `APP_INITIALIZER` pattern), you can instead provide a fake service via `{ provide: CometChatInitService, useValue: spy }` and skip spying the statics. Either is valid — spy the layer your component actually depends on. Don't do both; it's redundant and confusing.
70
156
 
71
157
  ---
72
158
 
73
- ## 2. TestBed setup with CometChat module
159
+ ## 3. TestBed for STANDALONE components — `imports`, not `declarations`
160
+
161
+ v5 integration components are **standalone**. So is the component under test (it imports the kit classes into its own `imports: []`). In TestBed, a standalone component goes in **`imports`**:
74
162
 
75
163
  ```ts
76
164
  // chat.component.spec.ts
77
165
  import { ComponentFixture, TestBed } from "@angular/core/testing";
78
- import { CUSTOM_ELEMENTS_SCHEMA } from "@angular/core";
79
166
  import { ChatComponent } from "./chat.component";
80
- import { CometChatInitService } from "../services/cometchat-init.service";
167
+ import { spyOnCometChatUIKit } from "./testing/cometchat-spies";
81
168
 
82
169
  describe("ChatComponent", () => {
83
170
  let fixture: ComponentFixture<ChatComponent>;
84
171
  let component: ChatComponent;
85
- let initService: jasmine.SpyObj<CometChatInitService>;
86
172
 
87
173
  beforeEach(async () => {
88
- initService = jasmine.createSpyObj("CometChatInitService", ["init", "login"]);
89
- initService.init.and.returnValue(Promise.resolve());
90
- initService.login.and.returnValue(Promise.resolve({ uid: "cometchat-uid-1" }));
174
+ spyOnCometChatUIKit();
91
175
 
92
176
  await TestBed.configureTestingModule({
93
- declarations: [ChatComponent],
94
- providers: [
95
- { provide: CometChatInitService, useValue: initService },
96
- ],
97
- schemas: [CUSTOM_ELEMENTS_SCHEMA], // critical — UI Kit selectors
177
+ imports: [ChatComponent], // ← standalone component goes in imports, NOT declarations
98
178
  }).compileComponents();
99
179
 
100
180
  fixture = TestBed.createComponent(ChatComponent);
101
181
  component = fixture.componentInstance;
102
182
  });
103
183
 
104
- it("calls init on construction", () => {
184
+ it("creates", () => {
105
185
  fixture.detectChanges();
106
- expect(initService.init).toHaveBeenCalled();
186
+ expect(component).toBeTruthy();
107
187
  });
108
188
  });
109
189
  ```
110
190
 
111
- `CUSTOM_ELEMENTS_SCHEMA` makes the test ignore unknown elements (the `<cometchat-*>` selectors in templates). Without it, every test fails with "is not a known element."
191
+ Putting a standalone component in `declarations` throws `Component ... is standalone, and cannot be declared in an NgModule. Use imports instead.` there is no `CUSTOM_ELEMENTS_SCHEMA` workaround here, and you should not reach for one: that was the v4 NgModule mental model.
112
192
 
113
193
  ---
114
194
 
115
- ## 3. NgZone + fakeAsync for SDK callbacks
195
+ ## 4. Stub the kit's `<cometchat-*>` components
116
196
 
117
- The Calls SDK fires callbacks outside Angular's zone (cf. `cometchat-angular-calls/references/ngzone-and-async-callbacks.md`). Tests for components subscribing to those callbacks need `fakeAsync` + `tick`:
197
+ `ChatComponent`'s template renders, say, `<cometchat-conversations>`. The real `CometChatConversationsComponent` reaches into the SDK on init exactly the network access you're mocking away. Replace it with a lightweight stub via `TestBed.overrideComponent`:
198
+
199
+ ```ts
200
+ import { Component } from "@angular/core";
201
+ import {
202
+ CometChatConversationsComponent,
203
+ CometChatMessageListComponent,
204
+ CometChatMessageComposerComponent,
205
+ CometChatMessageHeaderComponent,
206
+ } from "@cometchat/chat-uikit-angular";
207
+
208
+ // A stub that reuses the real selector but renders nothing real.
209
+ @Component({ selector: "cometchat-conversations", standalone: true, template: "" })
210
+ class CometChatConversationsStub {}
211
+
212
+ @Component({ selector: "cometchat-message-list", standalone: true, template: "" })
213
+ class CometChatMessageListStub {}
214
+
215
+ @Component({ selector: "cometchat-message-composer", standalone: true, template: "" })
216
+ class CometChatMessageComposerStub {}
217
+
218
+ @Component({ selector: "cometchat-message-header", standalone: true, template: "" })
219
+ class CometChatMessageHeaderStub {}
220
+
221
+ beforeEach(async () => {
222
+ spyOnCometChatUIKit();
223
+
224
+ await TestBed.configureTestingModule({
225
+ imports: [ChatComponent],
226
+ })
227
+ // swap each real kit component for its stub
228
+ .overrideComponent(ChatComponent, {
229
+ remove: {
230
+ imports: [
231
+ CometChatConversationsComponent,
232
+ CometChatMessageListComponent,
233
+ CometChatMessageComposerComponent,
234
+ CometChatMessageHeaderComponent,
235
+ ],
236
+ },
237
+ add: {
238
+ imports: [
239
+ CometChatConversationsStub,
240
+ CometChatMessageListStub,
241
+ CometChatMessageComposerStub,
242
+ CometChatMessageHeaderStub,
243
+ ],
244
+ },
245
+ })
246
+ .compileComponents();
247
+
248
+ fixture = TestBed.createComponent(ChatComponent);
249
+ });
250
+ ```
251
+
252
+ The stub keeps the same selector (`cometchat-conversations`), so the template still compiles and renders — but nothing hits the SDK. This is the Angular analogue of the React skill's `CometChatConversations: () => null` module mock.
253
+
254
+ Component class names (verified against the v5 `.d.ts`) carry the **`Component`** suffix; the HTML selectors do **not**:
255
+
256
+ | Class (import / override) | Selector (template / stub) |
257
+ |---|---|
258
+ | `CometChatConversationsComponent` | `<cometchat-conversations>` |
259
+ | `CometChatMessageListComponent` | `<cometchat-message-list>` |
260
+ | `CometChatMessageComposerComponent` | `<cometchat-message-composer>` |
261
+ | `CometChatMessageHeaderComponent` | `<cometchat-message-header>` |
262
+ | `CometChatUsersComponent` | `<cometchat-users>` |
263
+ | `CometChatGroupsComponent` | `<cometchat-groups>` |
264
+ | `CometChatIncomingCallComponent` | `<cometchat-incoming-call>` |
265
+
266
+ See `cometchat-angular-components` for the full catalog. Never invent a selector — confirm it in the `.d.ts`.
267
+
268
+ ---
269
+
270
+ ## 5. `fakeAsync` + `tick` for the Promise-based lifecycle
271
+
272
+ `init()` and `login()` are Promises. A component that gates its UI on them (`*ngIf="ready"`) only flips after those resolve. In tests, flush them with `fakeAsync` + `tick()`:
118
273
 
119
274
  ```ts
120
275
  import { fakeAsync, tick } from "@angular/core/testing";
121
276
 
122
- it("renders error when SDK fails", fakeAsync(() => {
123
- initService.login.and.returnValue(Promise.reject(new Error("401 Unauthorized")));
277
+ it("logs in then becomes ready", fakeAsync(() => {
278
+ fixture.detectChanges(); // triggers ngOnInit → init/login Promise chain
279
+ tick(); // flush microtasks (the resolved Promises)
280
+ fixture.detectChanges(); // re-render now that ready === true
281
+
282
+ expect(CometChatUIKit.login).toHaveBeenCalledWith("cometchat-uid-1"); // bare string
283
+ expect(fixture.nativeElement.querySelector("cometchat-conversations")).toBeTruthy();
284
+ }));
285
+ ```
124
286
 
287
+ ### Init resolves before children render (the highest-value test)
288
+
289
+ Mirrors the React skill's "does not render children until login resolves" — catches the single most common production bug, a `<cometchat-*>` mounting before login finishes.
290
+
291
+ ```ts
292
+ it("does not render chat UI until login resolves", fakeAsync(() => {
293
+ let resolveLogin!: (u: unknown) => void;
294
+ (CometChatUIKit.login as jasmine.Spy).and.returnValue(
295
+ new Promise((res) => { resolveLogin = res; })
296
+ );
297
+
298
+ fixture.detectChanges();
299
+ tick();
300
+ fixture.detectChanges();
301
+
302
+ // login still pending → chat UI gated off
303
+ expect(fixture.nativeElement.querySelector("cometchat-conversations")).toBeNull();
304
+
305
+ resolveLogin({ uid: "cometchat-uid-1" });
306
+ tick();
125
307
  fixture.detectChanges();
126
- tick(); // flush pending promises
127
- fixture.detectChanges(); // re-render after state change
128
308
 
129
- const errorEl = fixture.nativeElement.querySelector(".error-message");
130
- expect(errorEl.textContent).toContain("401");
309
+ expect(fixture.nativeElement.querySelector("cometchat-conversations")).toBeTruthy();
131
310
  }));
132
311
  ```
133
312
 
134
- For SDK callbacks dispatched via `setTimeout` or `requestAnimationFrame`, `tick(N)` advances by N ms.
313
+ > If the component's promise chain schedules work via `setTimeout` / `requestAnimationFrame` (common when bridging SDK callbacks back into Angular's zone — see `cometchat-angular-patterns`), advance the virtual clock with `tick(N)` for N ms. As an alternative to `fakeAsync`, an `async` test with `await fixture.whenStable()` works too — but never write an `async` test body whose assertion isn't awaited (it passes trivially).
314
+
315
+ ### Asserting on `loggedInUser$`
316
+
317
+ ```ts
318
+ it("exposes the current user from loggedInUser$", fakeAsync(() => {
319
+ fixture.detectChanges();
320
+ tick();
321
+ expect(component.currentUser?.getUid()).toBe("cometchat-uid-1");
322
+ }));
323
+ ```
135
324
 
136
325
  ---
137
326
 
138
- ## 4. Mocking `@cometchat/chat-uikit-angular`
327
+ ## 6. Meta-tests against source (mirror the React skill)
139
328
 
140
- The UI Kit is heavy — full module imports inflate test bundles and trigger zone-related warnings in jsdom. Mock at the module level:
329
+ ### No Auth Key hardcoded in source
330
+
331
+ The Auth Key belongs in `src/environments/environment.ts` (dev) and never in production builds. A meta-test catches accidental inlining anywhere:
141
332
 
142
333
  ```ts
143
- // __mocks__/cometchat-uikit-angular.ts
144
- import { Component, NgModule, NO_ERRORS_SCHEMA } from "@angular/core";
334
+ import { readFileSync } from "node:fs";
335
+ import { globSync } from "glob"; // glob v9+ named export (NOT `sync as glob`, removed in v10)
336
+
337
+ it("no Auth Key hardcoded outside environment files", () => {
338
+ const files = globSync("src/**/*.{ts,html}");
339
+ const hexKey = /[a-f0-9]{32,}/;
340
+
341
+ for (const file of files) {
342
+ if (/environments\//.test(file)) continue; // env files are the allowed home (dev)
343
+ const offenders = readFileSync(file, "utf8")
344
+ .split("\n")
345
+ .filter((l) => hexKey.test(l) && !l.trim().startsWith("//") && !/AUTH_KEY/i.test(l));
346
+ expect(offenders, `Possible Auth Key in ${file}:\n${offenders.join("\n")}`).toHaveLength(0);
347
+ }
348
+ });
349
+ ```
145
350
 
146
- @Component({ selector: "cometchat-conversations", template: "<div>conversations</div>" })
147
- export class CometChatConversationsStub {}
351
+ ### Kit assets are wired in `angular.json`
148
352
 
149
- @Component({ selector: "cometchat-message-list", template: "<div>message-list</div>" })
150
- export class CometChatMessageListStub {}
353
+ The single most-missed v5 setup step is the assets glob (missing it = broken icons everywhere). Assert it once:
151
354
 
152
- @Component({ selector: "cometchat-message-composer", template: "<div>composer</div>" })
153
- export class CometChatMessageComposerStub {}
355
+ ```ts
356
+ it("angular.json copies the CometChat kit assets", () => {
357
+ const cfg = readFileSync("angular.json", "utf8");
358
+ expect(cfg).toContain("@cometchat/chat-uikit-angular/src/lib/assets");
359
+ });
360
+ ```
154
361
 
155
- @Component({ selector: "cometchat-message-header", template: "<div>header</div>" })
156
- export class CometChatMessageHeaderStub {}
362
+ ### No `CUSTOM_ELEMENTS_SCHEMA` for CometChat (v4 smell)
157
363
 
158
- @NgModule({
159
- declarations: [
160
- CometChatConversationsStub,
161
- CometChatMessageListStub,
162
- CometChatMessageComposerStub,
163
- CometChatMessageHeaderStub,
164
- ],
165
- exports: [
166
- CometChatConversationsStub,
167
- CometChatMessageListStub,
168
- CometChatMessageComposerStub,
169
- CometChatMessageHeaderStub,
170
- ],
171
- })
172
- export class CometChatUIKitModuleStub {}
364
+ ```ts
365
+ it("does not use CUSTOM_ELEMENTS_SCHEMA in component specs/sources", () => {
366
+ const files = globSync("src/**/*.ts");
367
+ for (const file of files) {
368
+ const c = readFileSync(file, "utf8");
369
+ if (c.includes("@cometchat/chat-uikit-angular") && c.includes("CUSTOM_ELEMENTS_SCHEMA")) {
370
+ throw new Error(`${file}: v5 components are standalone — drop CUSTOM_ELEMENTS_SCHEMA`);
371
+ }
372
+ }
373
+ expect(true).toBe(true);
374
+ });
173
375
  ```
174
376
 
175
- In a test:
377
+ ---
378
+
379
+ ## 7. Production token endpoint — `HttpTestingController`
380
+
381
+ Only if your app fetches an auth token from your backend before `loginWithAuthToken`. Test the HTTP call with `HttpTestingController`; still spy `loginWithAuthToken` so nothing hits CometChat:
176
382
 
177
383
  ```ts
178
- await TestBed.configureTestingModule({
179
- declarations: [ChatComponent],
180
- imports: [CometChatUIKitModuleStub],
181
- providers: [/* ... */],
182
- }).compileComponents();
384
+ import { provideHttpClient } from "@angular/common/http";
385
+ import { provideHttpClientTesting, HttpTestingController } from "@angular/common/http/testing";
386
+
387
+ describe("TokenAuthService", () => {
388
+ let http: HttpTestingController;
389
+ let service: TokenAuthService;
390
+
391
+ beforeEach(() => {
392
+ spyOnCometChatUIKit();
393
+ TestBed.configureTestingModule({
394
+ // Angular 17+ : provider functions, NOT the deprecated HttpClientTestingModule
395
+ providers: [
396
+ provideHttpClient(),
397
+ provideHttpClientTesting(),
398
+ TokenAuthService,
399
+ ],
400
+ });
401
+ http = TestBed.inject(HttpTestingController);
402
+ service = TestBed.inject(TokenAuthService);
403
+ });
404
+
405
+ afterEach(() => http.verify());
406
+
407
+ it("fetches a token then logs in with it", fakeAsync(() => {
408
+ service.loginCurrentUser("cometchat-uid-1");
409
+
410
+ const req = http.expectOne("https://api.yourapp.com/cometchat-token");
411
+ expect(req.request.method).toBe("POST");
412
+ req.flush({ authToken: "AUTH_TOKEN_123" });
413
+
414
+ tick();
415
+ expect(CometChatUIKit.loginWithAuthToken).toHaveBeenCalledWith("AUTH_TOKEN_123");
416
+ }));
417
+ });
183
418
  ```
184
419
 
185
- For Jest, alias the module path:
420
+ ---
186
421
 
187
- ```js
188
- // jest.config.js
189
- moduleNameMapper: {
190
- "^@cometchat/chat-uikit-angular$": "<rootDir>/__mocks__/cometchat-uikit-angular.ts",
191
- }
422
+ ## 8. E2E — Playwright (preferred) or Cypress
423
+
424
+ ### Playwright (preferred for two-user flows)
425
+
426
+ ```bash
427
+ npm install -D @playwright/test
428
+ npx playwright install
192
429
  ```
193
430
 
194
- For Karma, less straightforward — typically you import the stub module directly in the test file and let TypeScript's structural typing handle it.
431
+ `playwright.config.ts`:
195
432
 
196
- ---
433
+ ```ts
434
+ import { defineConfig, devices } from "@playwright/test";
435
+
436
+ export default defineConfig({
437
+ testDir: "./e2e",
438
+ use: {
439
+ baseURL: process.env.E2E_BASE_URL ?? "http://localhost:4200",
440
+ trace: "on-first-retry",
441
+ },
442
+ projects: [
443
+ { name: "chromium", use: devices["Desktop Chrome"] },
444
+ { name: "firefox", use: devices["Desktop Firefox"] },
445
+ ],
446
+ webServer: {
447
+ command: "npm start", // ng serve on :4200
448
+ url: "http://localhost:4200",
449
+ reuseExistingServer: !process.env.CI,
450
+ },
451
+ });
452
+ ```
197
453
 
198
- ## 5. Standalone components (Angular 14+)
454
+ Two-page chat smoke (real backend — e2e is the layer where the network IS the thing under test):
199
455
 
200
456
  ```ts
201
- import { ComponentFixture, TestBed } from "@angular/core/testing";
202
- import { ChatComponent } from "./chat.component";
457
+ import { test, expect, type Page } from "@playwright/test";
203
458
 
204
- describe("ChatComponent (standalone)", () => {
205
- let fixture: ComponentFixture<ChatComponent>;
459
+ async function loginAs(page: Page, uid: string) {
460
+ await page.goto("/");
461
+ await page.evaluate((u) => localStorage.setItem("cc-test-uid", u), uid);
462
+ await page.reload();
463
+ await expect(page.getByText(/welcome|conversations/i)).toBeVisible({ timeout: 10_000 });
464
+ }
206
465
 
207
- beforeEach(async () => {
208
- await TestBed.configureTestingModule({
209
- imports: [ChatComponent], // standalone components imported, not declared
210
- providers: [{ provide: CometChatInitService, useValue: { init: () => Promise.resolve() } }],
211
- }).compileComponents();
466
+ test("two users message back and forth", async ({ browser }) => {
467
+ const alice = await (await browser.newContext()).newPage();
468
+ const bob = await (await browser.newContext()).newPage();
212
469
 
213
- fixture = TestBed.createComponent(ChatComponent);
214
- });
470
+ await loginAs(alice, "cometchat-uid-1");
471
+ await loginAs(bob, "cometchat-uid-2");
472
+
473
+ await alice.goto("/messages");
474
+ await alice.getByText("cometchat-uid-2").click();
475
+ await alice.getByPlaceholder(/type a message/i).fill("Hello Bob");
476
+ await alice.getByPlaceholder(/type a message/i).press("Enter");
477
+
478
+ await bob.goto("/messages");
479
+ await bob.getByText("cometchat-uid-1").click();
480
+ await expect(bob.getByText("Hello Bob")).toBeVisible({ timeout: 10_000 });
215
481
  });
216
482
  ```
217
483
 
218
- ---
219
-
220
- ## 6. Cypress e2e
484
+ The 10-second timeout is generous — WebSocket delivery is usually <500ms, but CI hosts have variable latency.
221
485
 
222
- ### Install
486
+ ### Cypress (single-window smoke)
223
487
 
224
488
  ```bash
225
489
  npm install -D cypress
226
- npx cypress open # generates cypress/ scaffold
490
+ npx cypress open
227
491
  ```
228
492
 
229
- ### `cypress.config.ts`
493
+ `cypress.config.ts`:
230
494
 
231
495
  ```ts
232
496
  import { defineConfig } from "cypress";
@@ -234,56 +498,33 @@ import { defineConfig } from "cypress";
234
498
  export default defineConfig({
235
499
  e2e: {
236
500
  baseUrl: process.env.E2E_BASE_URL ?? "http://localhost:4200",
237
- supportFile: "cypress/support/e2e.ts",
238
501
  specPattern: "cypress/e2e/**/*.cy.ts",
239
- defaultCommandTimeout: 10_000, // generous for WebSocket-driven assertions
502
+ defaultCommandTimeout: 10_000, // generous for WebSocket-driven assertions
240
503
  },
241
504
  });
242
505
  ```
243
506
 
244
- ### Two-window chat smoke
245
-
246
- Cypress doesn't natively support multi-window tests. Workaround: open a second browser context via Playwright OR test with two iframes. Most teams use Playwright for cross-window tests — keep Cypress for single-window smoke.
247
-
248
507
  ```ts
249
508
  // cypress/e2e/chat.cy.ts
250
509
  describe("chat smoke", () => {
251
510
  it("logs in and sees the conversation list", () => {
252
511
  cy.visit("/");
253
- cy.window().then((win) => {
254
- win.localStorage.setItem("cc-test-uid", "cometchat-uid-1");
255
- });
512
+ cy.window().then((w) => w.localStorage.setItem("cc-test-uid", "cometchat-uid-1"));
256
513
  cy.reload();
257
-
258
- cy.contains("Welcome").should("be.visible");
259
- cy.visit("/messages");
260
- cy.contains("Conversations", { timeout: 10_000 }).should("be.visible");
261
- });
262
-
263
- it("sends a message and sees it in the thread", () => {
264
- cy.visit("/messages");
265
- cy.contains("cometchat-uid-2").click();
266
- cy.get("input[placeholder='Type a message']").type("Hello");
267
- cy.contains("Send").click();
268
- cy.contains("Hello", { timeout: 5_000 }).should("be.visible");
514
+ cy.contains(/welcome|conversations/i, { timeout: 10_000 }).should("be.visible");
269
515
  });
270
516
  });
271
517
  ```
272
518
 
273
- For two-user tests, prefer Playwrightsee `cometchat-react-testing/SKILL.md`.
519
+ Cypress can't drive two browser contexts in one test for two-user flows use Playwright.
274
520
 
275
- ---
521
+ ### Test users
276
522
 
277
- ## 7. Anti-patterns
523
+ Every CometChat app ships 5 pre-seeded users (`cometchat-uid-1` … `cometchat-uid-5`) — use them in e2e. Never create users via Auth-Key flows that leak credentials into test code.
278
524
 
279
- 1. **Skipping `CUSTOM_ELEMENTS_SCHEMA`** in TestBed. Every test fails with "is not a known element" for `<cometchat-*>` selectors.
280
- 2. **Using `ngOnInit()` directly in tests.** Always go through `fixture.detectChanges()` so Angular's lifecycle runs the way it does in production.
281
- 3. **Mocking `CometChat.init`** with a synchronous return value. Real init returns a Promise; sync mocks mask race conditions in your code.
282
- 4. **`async` test bodies without `await`** on the assertion. The test passes (trivially) because the assertion never ran. Use `fakeAsync` + `tick` or proper `await fixture.whenStable()`.
283
- 5. **Hardcoding test user UIDs** in templates. Use a service injection so tests can override.
284
- 6. **Running Karma in CI without `--watch=false --browsers=ChromeHeadless`.** Default `ng test` watches forever; CI hangs.
525
+ ---
285
526
 
286
- ## 8. CI configuration
527
+ ## 9. CI configuration
287
528
 
288
529
  ```yaml
289
530
  # .github/workflows/test.yml
@@ -291,43 +532,74 @@ name: tests
291
532
  on: [push, pull_request]
292
533
 
293
534
  jobs:
294
- test:
535
+ unit:
295
536
  runs-on: ubuntu-latest
296
537
  steps:
297
538
  - uses: actions/checkout@v4
298
539
  - uses: actions/setup-node@v4
299
540
  with: { node-version: 20, cache: npm }
300
541
  - run: npm ci
542
+ # Jasmine/Karma — MUST disable watch or CI hangs forever:
543
+ - run: npm test -- --watch=false --browsers=ChromeHeadless --code-coverage
544
+ # OR Jest:
545
+ # - run: npm test -- --ci --coverage
301
546
 
302
- # Karma
303
- - run: npm run test -- --watch=false --browsers=ChromeHeadless --code-coverage
304
- # OR Jest
305
- # - run: npm run test -- --ci --coverage
306
-
307
- - run: npx cypress run
547
+ e2e:
548
+ runs-on: ubuntu-latest
549
+ needs: unit
550
+ steps:
551
+ - uses: actions/checkout@v4
552
+ - uses: actions/setup-node@v4
553
+ with: { node-version: 20, cache: npm }
554
+ - run: npm ci
555
+ - run: npx playwright install --with-deps chromium firefox
556
+ - run: npx playwright test # webServer block boots `ng serve`
308
557
  env:
309
558
  E2E_BASE_URL: http://localhost:4200
310
- # ng serve in background:
311
- # - run: npx concurrently "ng serve" "wait-on http://localhost:4200 && npx cypress run"
559
+ - if: failure()
560
+ uses: actions/upload-artifact@v4
561
+ with: { name: playwright-report, path: playwright-report/ }
312
562
  ```
313
563
 
314
- Use a dedicated test CometChat App ID in CI — never share with production.
564
+ **Critical:** use a **dedicated test CometChat app** (Dashboard → New App "ci-tests") for e2e — never share with production. Rotate the Auth Key if a CI log ever captures it. Unit/component tests need no credentials at all (the kit is fully mocked).
315
565
 
316
566
  ---
317
567
 
318
- ## 9. Verification checklist
568
+ ## 10. Anti-patterns (mocks that pass tests but mask production)
319
569
 
320
- - [ ] `karma.conf.js` (Angular default) OR `jest.config.js` (Jest path) configured
321
- - [ ] At least one test using `CUSTOM_ELEMENTS_SCHEMA` for components that render `<cometchat-*>`
322
- - [ ] At least one test asserting "init runs and resolves before component is usable"
323
- - [ ] At least one test asserting "error state renders when SDK throws"
324
- - [ ] `CometChatInitService` mocked, not the real one
325
- - [ ] No hardcoded App ID / Auth Key in test files
326
- - [ ] CI runs unit + e2e separately with dedicated test app credentials
327
- - [ ] `--watch=false` flag in CI Karma command (otherwise hangs)
570
+ 1. **Putting a standalone component in `declarations`.** v5 components (and your component-under-test) are standalone — they go in `imports`. `declarations` throws at compile time.
571
+ 2. **Reaching for `CUSTOM_ELEMENTS_SCHEMA` to silence `<cometchat-*>` "not a known element".** That was the v4 NgModule pattern. In v5 you either import the real component or override it with a stub (§4) — the schema masks genuine template typos.
572
+ 3. **Stubbing a kit component with a *real-ish* implementation.** Your stub passes; the real `CometChatConversationsComponent` behaves differently in prod. Keep stubs inert (`template: ""`) and test the wiring around them — same caution as the React skill's `() => null`.
573
+ 4. **Mocking `CometChatUIKit.init` / `login` with a synchronous value.** They return Promises; a sync mock hides the race conditions in your gating logic. Always resolve a Promise (`.and.resolveTo` / `.mockResolvedValue`).
574
+ 5. **Spying the wrong getter.** `getLoggedInUser()` is sync, `getLoggedinUser()` is async — spy the one your component calls, or the spy is a silent no-op.
575
+ 6. **`async` test body without awaiting the assertion.** Passes trivially. Use `fakeAsync` + `tick`, or `await fixture.whenStable()`.
576
+ 7. **Asserting on internal kit CSS classes** (`.cc-message-list__bubble`). Brittle across kit upgrades assert on text, role, selector presence, or test-id.
577
+ 8. **Calling `ngOnInit()` directly** instead of `fixture.detectChanges()`. Bypasses Angular's lifecycle; tests diverge from production behavior.
578
+ 9. **Running Karma in CI without `--watch=false`.** Default `ng test` watches forever; the job hangs.
579
+ 10. **Hardcoding the Auth Key in test files.** Even a throwaway app's key leaks via code grep. Use environment files / CI secrets.
580
+ 11. **Running e2e against the dev/prod app.** Test data piles up. Separate app.
328
581
 
329
- ## 10. Pointers
582
+ ---
330
583
 
331
- - `cometchat-angular-calls/references/ngzone-and-async-callbacks.md` calls testing
332
- - `cometchat-angular-core` — init service to mock against
333
- - `cometchat-angular-troubleshooting` common test failures
584
+ ## 11. Verification checklist
585
+
586
+ - [ ] Runner chosen: Jasmine/Karma (default) OR Jest (`jest.config.js` + `setup-jest.ts`)
587
+ - [ ] Component-under-test placed in TestBed `imports` (standalone), never `declarations`
588
+ - [ ] `CometChatUIKit` statics spied (`init`/`login`/`getLoggedInUser`/`getLoggedinUser`/`loginWithAuthToken`/`logout`) — Promises resolved, not sync values
589
+ - [ ] Kit `<cometchat-*>` components stubbed via `overrideComponent` (no SDK access in unit tests)
590
+ - [ ] At least one `fakeAsync`/`tick` test for "init+login resolves before chat UI renders"
591
+ - [ ] At least one test for "error state renders when `login` rejects"
592
+ - [ ] No `CUSTOM_ELEMENTS_SCHEMA` anywhere CometChat is imported
593
+ - [ ] Meta-test: no Auth Key hardcoded outside `environment.*`
594
+ - [ ] Meta-test: `angular.json` copies the kit `assets/` glob
595
+ - [ ] Playwright (or Cypress) config + at least one chat smoke; two-user smoke uses Playwright
596
+ - [ ] CI runs unit + e2e separately; Karma uses `--watch=false`; e2e uses a dedicated test app
597
+ - [ ] No `.only` / `fit` / `fdescribe` / `xit` left in committed tests
598
+
599
+ ## 12. Pointers
600
+
601
+ - `cometchat-angular-core` — the init/login order and `CometChatUIKit` API the tests assert against
602
+ - `cometchat-angular-components` — verified selectors + class names for stubs
603
+ - `cometchat-angular-calls` — calls-specific testing (NgZone, getUserMedia, call components)
604
+ - `cometchat-angular-troubleshooting` — when tests pass but the integration is still broken
605
+ - `cometchat-react-testing` — the sister skill; same mocking philosophy