@cometchat/skills 4.4.2 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +55 -0
- package/.claude-plugin/plugin.json +14 -0
- package/CHANGELOG.md +36 -0
- package/LICENSE +21 -0
- package/README.md +41 -163
- package/RULES.md +114 -0
- package/bin/cometchat-skills.mjs +1180 -0
- package/bin/legacy-skills.json +95 -0
- package/catalogs/android-v6.json +1646 -0
- package/catalogs/flutter-v6.json +651 -0
- package/catalogs/ios-v5.json +1383 -0
- package/catalogs/rn-calls-v5.json +134 -0
- package/catalogs/rn-calls-v5.symbols.txt +58 -0
- package/catalogs/rn-sdk-v4.json +672 -0
- package/catalogs/rn-v5.json +449 -0
- package/catalogs/rn-v5.symbols.txt +216 -0
- package/catalogs/sdk-android-v5.json +514 -0
- package/contracts.android-calls-v5.json +122 -0
- package/contracts.android-v6.json +135 -0
- package/contracts.angular-v5.json +694 -0
- package/contracts.flutter-calls-v5.json +77 -0
- package/contracts.flutter-v6.json +126 -0
- package/contracts.ios-calls-v5.json +67 -0
- package/contracts.ios-v5.json +436 -0
- package/contracts.json +82 -0
- package/contracts.rn-calls-v5.json +77 -0
- package/contracts.rn-v5.json +727 -0
- package/contracts.sdk-android-v5.json +15 -0
- package/contracts.web-calls-v5.json +45 -0
- package/features.android-calls-v5.json +246 -0
- package/features.android-v6.json +65 -0
- package/features.angular-v5.json +521 -0
- package/features.flutter-calls-v5.json +286 -0
- package/features.flutter-v6.json +484 -0
- package/features.ios-calls-v5.json +236 -0
- package/features.ios-v5.json +573 -0
- package/features.json +61 -0
- package/features.rn-calls-v5.json +187 -0
- package/features.rn-v5.json +614 -0
- package/features.sdk-android-v5.json +40 -0
- package/features.sdk-jsv4.json +24 -0
- package/features.web-calls-v5.json +108 -0
- package/package.json +151 -74
- package/peers.yaml +312 -0
- package/registry/README.md +31 -0
- package/registry/android-calls-v5.json +54 -0
- package/registry/android-v6.json +137 -0
- package/registry/angular-v5.json +114 -0
- package/registry/flutter-calls-v5.json +54 -0
- package/registry/flutter-v6.json +119 -0
- package/registry/ios-calls-v5.json +59 -0
- package/registry/ios-v5.json +97 -0
- package/registry/rn-calls-v5.json +59 -0
- package/registry/rn-v5.json +129 -0
- package/registry/sdk-android-v5.json +53 -0
- package/registry/sdk-jsv4.json +53 -0
- package/registry/web-calls-v5.json +54 -0
- package/registry/web-v7.json +99 -0
- package/skills/cometchat/SKILL.md +42 -2096
- package/skills/cometchat-android-v5-calls-sdk/SKILL.md +206 -0
- package/skills/cometchat-android-v5-calls-sdk/references/build-truth.md +63 -0
- package/skills/cometchat-android-v5-calls-sdk/references/docs-map.md +119 -0
- package/skills/cometchat-android-v5-calls-sdk/references/method-map.md +53 -0
- package/skills/cometchat-android-v5-calls-sdk/references/pitfalls.md +72 -0
- package/skills/cometchat-android-v5-calls-sdk/references/ringing.md +92 -0
- package/skills/cometchat-android-v5-calls-sdk/references/user-switch.md +90 -0
- package/skills/cometchat-android-v5-sdk/SKILL.md +127 -0
- package/skills/cometchat-android-v5-sdk/references/app-surface.md +88 -0
- package/skills/cometchat-android-v5-sdk/references/docs-map.md +91 -0
- package/skills/cometchat-android-v6-builder-settings/SKILL.md +51 -137
- package/skills/cometchat-android-v6-calls/SKILL.md +128 -413
- package/skills/cometchat-android-v6-compose-components/SKILL.md +84 -194
- package/skills/cometchat-android-v6-compose-customization/SKILL.md +66 -411
- package/skills/cometchat-android-v6-compose-placement/SKILL.md +154 -237
- package/skills/cometchat-android-v6-core/SKILL.md +236 -672
- package/skills/cometchat-android-v6-core/references/anti-patterns.md +31 -0
- package/skills/cometchat-android-v6-core/references/component-props.md +168 -0
- package/skills/cometchat-android-v6-core/references/docs-map.md +153 -0
- package/skills/cometchat-android-v6-core/references/layout.md +112 -0
- package/skills/cometchat-android-v6-core/references/lifecycle.md +75 -0
- package/skills/cometchat-android-v6-core/references/setup-credentials.md +105 -0
- package/skills/cometchat-android-v6-core/references/troubleshooting.md +36 -0
- package/skills/cometchat-android-v6-events/SKILL.md +46 -184
- package/skills/cometchat-android-v6-extensions/SKILL.md +39 -179
- package/skills/cometchat-android-v6-features/SKILL.md +74 -143
- package/skills/cometchat-android-v6-kotlin-components/SKILL.md +75 -193
- package/skills/cometchat-android-v6-kotlin-customization/SKILL.md +67 -419
- package/skills/cometchat-android-v6-kotlin-placement/SKILL.md +77 -223
- package/skills/cometchat-android-v6-migration/SKILL.md +67 -378
- package/skills/cometchat-android-v6-production/SKILL.md +40 -179
- package/skills/cometchat-android-v6-push/SKILL.md +39 -289
- package/skills/cometchat-android-v6-testing/SKILL.md +50 -265
- package/skills/cometchat-android-v6-troubleshooting/SKILL.md +70 -254
- package/skills/cometchat-angular-v5-calls/SKILL.md +193 -0
- package/skills/cometchat-angular-v5-components/SKILL.md +131 -0
- package/skills/cometchat-angular-v5-components/references/catalog.md +111 -0
- package/skills/cometchat-angular-v5-components/references/host-composed.md +46 -0
- package/skills/cometchat-angular-v5-core/SKILL.md +300 -0
- package/skills/cometchat-angular-v5-core/references/anti-patterns.md +49 -0
- package/skills/cometchat-angular-v5-core/references/component-props.md +55 -0
- package/skills/cometchat-angular-v5-core/references/dependencies.md +66 -0
- package/skills/cometchat-angular-v5-core/references/docs-map.md +132 -0
- package/skills/cometchat-angular-v5-core/references/layout.md +64 -0
- package/skills/cometchat-angular-v5-core/references/lifecycle.md +202 -0
- package/skills/cometchat-angular-v5-core/references/setup-credentials.md +137 -0
- package/skills/cometchat-angular-v5-core/references/theming.md +70 -0
- package/skills/cometchat-angular-v5-core/references/troubleshooting.md +27 -0
- package/skills/cometchat-angular-v5-customization/SKILL.md +94 -0
- package/skills/cometchat-angular-v5-features/SKILL.md +107 -0
- package/skills/cometchat-angular-v5-features/references/custom-messages.md +133 -0
- package/skills/cometchat-angular-v5-features/references/formatters.md +28 -0
- package/skills/cometchat-angular-v5-features/references/host-composed-extensions.md +85 -0
- package/skills/cometchat-angular-v5-migration/SKILL.md +40 -0
- package/skills/cometchat-angular-v5-migration/references/migration-guide.md +165 -0
- package/skills/cometchat-angular-v5-patterns/SKILL.md +107 -0
- package/skills/cometchat-angular-v5-placement/SKILL.md +133 -0
- package/skills/cometchat-angular-v5-placement/references/combined-app.md +174 -0
- package/skills/cometchat-angular-v5-placement/references/core-surface.md +199 -0
- package/skills/cometchat-angular-v5-production/SKILL.md +101 -0
- package/skills/cometchat-angular-v5-push/SKILL.md +61 -0
- package/skills/cometchat-angular-v5-testing/SKILL.md +112 -0
- package/skills/cometchat-angular-v5-troubleshooting/SKILL.md +96 -0
- package/skills/cometchat-flutter-v5-sdk/SKILL.md +188 -0
- package/skills/cometchat-flutter-v5-sdk/references/doc-corrections.md +55 -0
- package/skills/cometchat-flutter-v5-sdk/references/docs-map.md +211 -0
- package/skills/cometchat-flutter-v5-sdk/references/platform-notes.md +48 -0
- package/skills/cometchat-flutter-v5-sdk/references/transcription.md +87 -0
- package/skills/cometchat-flutter-v6-calls/SKILL.md +75 -389
- package/skills/cometchat-flutter-v6-components/SKILL.md +88 -361
- package/skills/cometchat-flutter-v6-core/SKILL.md +154 -593
- package/skills/cometchat-flutter-v6-core/references/anti-patterns.md +55 -0
- package/skills/cometchat-flutter-v6-core/references/docs-map.md +143 -0
- package/skills/cometchat-flutter-v6-core/references/layout.md +45 -0
- package/skills/cometchat-flutter-v6-core/references/lifecycle.md +87 -0
- package/skills/cometchat-flutter-v6-core/references/setup-credentials.md +84 -0
- package/skills/cometchat-flutter-v6-core/references/troubleshooting.md +26 -0
- package/skills/cometchat-flutter-v6-customization/SKILL.md +70 -712
- package/skills/cometchat-flutter-v6-events/SKILL.md +79 -174
- package/skills/cometchat-flutter-v6-features/SKILL.md +55 -394
- package/skills/cometchat-flutter-v6-migration/SKILL.md +68 -367
- package/skills/cometchat-flutter-v6-migration/references/migration-guide.md +131 -0
- package/skills/cometchat-flutter-v6-patterns/SKILL.md +61 -0
- package/skills/cometchat-flutter-v6-placement/SKILL.md +94 -381
- package/skills/cometchat-flutter-v6-production/SKILL.md +58 -615
- package/skills/cometchat-flutter-v6-push/SKILL.md +46 -455
- package/skills/cometchat-flutter-v6-testing/SKILL.md +68 -299
- package/skills/cometchat-flutter-v6-troubleshooting/SKILL.md +54 -878
- package/skills/cometchat-ios-calls/SKILL.md +112 -563
- package/skills/cometchat-ios-components/SKILL.md +44 -834
- package/skills/cometchat-ios-core/SKILL.md +181 -1068
- package/skills/cometchat-ios-core/references/anti-patterns.md +80 -0
- package/skills/cometchat-ios-core/references/docs-map.md +123 -0
- package/skills/cometchat-ios-core/references/install.md +23 -0
- package/skills/cometchat-ios-core/references/layout.md +186 -0
- package/skills/cometchat-ios-core/references/setup-credentials.md +197 -0
- package/skills/cometchat-ios-core/references/swiftui.md +91 -0
- package/skills/cometchat-ios-core/references/troubleshooting.md +100 -0
- package/skills/cometchat-ios-customization/SKILL.md +33 -968
- package/skills/cometchat-ios-features/SKILL.md +29 -738
- package/skills/cometchat-ios-migration/SKILL.md +39 -0
- package/skills/cometchat-ios-placement/SKILL.md +51 -729
- package/skills/cometchat-ios-push/SKILL.md +24 -602
- package/skills/cometchat-ios-v5-sdk/SKILL.md +161 -0
- package/skills/cometchat-ios-v5-sdk/references/docs-map.md +326 -0
- package/skills/cometchat-js-v5-sdk/SKILL.md +95 -0
- package/skills/cometchat-js-v5-sdk/references/docs-map.md +114 -0
- package/skills/cometchat-onboarding/SKILL.md +89 -0
- package/skills/cometchat-onboarding/references/archetypes.md +51 -0
- package/skills/cometchat-onboarding/references/calling-first.md +77 -0
- package/skills/cometchat-onboarding/references/not-in-this-pack.md +8 -0
- package/skills/cometchat-onboarding/references/plan-artifact.md +133 -0
- package/skills/cometchat-onboarding/references/platforms.md +90 -0
- package/skills/cometchat-react-native-bare-patterns/SKILL.md +120 -0
- package/skills/cometchat-react-native-calls/SKILL.md +200 -0
- package/skills/cometchat-react-native-components/SKILL.md +142 -0
- package/skills/cometchat-react-native-core/SKILL.md +313 -0
- package/skills/cometchat-react-native-core/references/anti-patterns.md +79 -0
- package/skills/cometchat-react-native-core/references/component-props.md +105 -0
- package/skills/cometchat-react-native-core/references/dependencies.md +62 -0
- package/skills/cometchat-react-native-core/references/docs-map.md +126 -0
- package/skills/cometchat-react-native-core/references/layout.md +61 -0
- package/skills/cometchat-react-native-core/references/lifecycle.md +64 -0
- package/skills/cometchat-react-native-core/references/setup-credentials.md +39 -0
- package/skills/cometchat-react-native-customization/SKILL.md +198 -0
- package/skills/cometchat-react-native-expo-patterns/SKILL.md +116 -0
- package/skills/cometchat-react-native-features/SKILL.md +122 -0
- package/skills/cometchat-react-native-migration/SKILL.md +103 -0
- package/skills/cometchat-react-native-placement/SKILL.md +158 -0
- package/skills/cometchat-react-native-production/SKILL.md +78 -0
- package/skills/cometchat-react-native-push/SKILL.md +88 -0
- package/skills/cometchat-react-native-sdk/SKILL.md +126 -0
- package/skills/cometchat-react-native-sdk/references/method-map.md +239 -0
- package/skills/cometchat-react-native-sdk/references/page-map.md +96 -0
- package/skills/cometchat-react-native-testing/SKILL.md +94 -0
- package/skills/cometchat-react-native-troubleshooting/SKILL.md +116 -0
- package/skills/cometchat-react-native-v5-sdk/SKILL.md +150 -0
- package/skills/cometchat-react-native-v5-sdk/references/docs-map.md +127 -0
- package/skills/cometchat-react-native-v5-sdk/references/ringing-voip.md +369 -0
- package/skills/cometchat-react-v7-calls/SKILL.md +75 -0
- package/skills/cometchat-react-v7-components/SKILL.md +72 -0
- package/skills/cometchat-react-v7-core/SKILL.md +101 -0
- package/skills/cometchat-react-v7-core/references/anti-patterns.md +19 -0
- package/skills/cometchat-react-v7-core/references/component-props.md +82 -0
- package/skills/cometchat-react-v7-core/references/dependencies.md +23 -0
- package/skills/cometchat-react-v7-core/references/docs-map.md +117 -0
- package/skills/cometchat-react-v7-core/references/i18n-rtl-a11y.md +22 -0
- package/skills/cometchat-react-v7-core/references/layout.md +158 -0
- package/skills/cometchat-react-v7-core/references/lifecycle.md +74 -0
- package/skills/cometchat-react-v7-core/references/setup-credentials.md +58 -0
- package/skills/cometchat-react-v7-core/references/ssr.md +11 -0
- package/skills/cometchat-react-v7-core/references/theming.md +52 -0
- package/skills/cometchat-react-v7-core/references/troubleshooting.md +28 -0
- package/skills/cometchat-react-v7-customization/SKILL.md +84 -0
- package/skills/cometchat-react-v7-features/SKILL.md +92 -0
- package/skills/cometchat-react-v7-migration/SKILL.md +39 -0
- package/skills/cometchat-react-v7-migration/references/migration-guide.md +119 -0
- package/skills/cometchat-react-v7-patterns/SKILL.md +43 -0
- package/skills/cometchat-react-v7-placement/SKILL.md +106 -0
- package/skills/cometchat-react-v7-placement/references/recipes.md +354 -0
- package/skills/cometchat-react-v7-push/SKILL.md +53 -0
- package/test-suite/README.md +70 -0
- package/test-suite/catalogs/android-calls-v5.json +830 -0
- package/test-suite/catalogs/android-calls-v5.symbols.txt +499 -0
- package/test-suite/catalogs/android-v6.json +1646 -0
- package/test-suite/catalogs/android-v6.symbols.txt +298 -0
- package/test-suite/catalogs/angular-v5.json +7587 -0
- package/test-suite/catalogs/flutter-calls-v5.json +196 -0
- package/test-suite/catalogs/flutter-calls-v5.symbols.txt +59 -0
- package/test-suite/catalogs/flutter-v6.json +651 -0
- package/test-suite/catalogs/ios-calls-v5.json +158 -0
- package/test-suite/catalogs/ios-calls-v5.symbols.txt +70 -0
- package/test-suite/catalogs/ios-v5.json +1383 -0
- package/test-suite/catalogs/ios-v5.symbols.txt +699 -0
- package/test-suite/catalogs/rn-calls-v5.json +134 -0
- package/test-suite/catalogs/rn-sdk-v4.json +672 -0
- package/test-suite/catalogs/rn-v5.json +449 -0
- package/test-suite/catalogs/sdk-android-v5.json +514 -0
- package/test-suite/catalogs/sdk-android-v5.symbols.txt +254 -0
- package/test-suite/catalogs/sdk-jsv4.json +800 -0
- package/test-suite/catalogs/web-calls-v5.json +195 -0
- package/test-suite/catalogs/web-v7.json +1243 -0
- package/test-suite/scripts/build-registry.mjs +113 -0
- package/test-suite/scripts/catalog-refresh-dart.mjs +151 -0
- package/test-suite/scripts/catalog-refresh.mjs +100 -0
- package/test-suite/scripts/lint-skills.mjs +909 -0
- package/test-suite/scripts/measure-tokens.mjs +169 -0
- package/test-suite/scripts/typecheck-fences-dart.mjs +437 -0
- package/test-suite/scripts/typecheck-fences-kotlin.mjs +269 -0
- package/test-suite/scripts/typecheck-fences.mjs +206 -0
- package/test-suite/scripts/verify-catalog.mjs +242 -0
- package/test-suite/scripts/verify-contract-fences.mjs +94 -0
- package/test-suite/scripts/verify-detection.mjs +178 -0
- package/test-suite/scripts/verify-docs-base.mjs +91 -0
- package/test-suite/scripts/verify-family-agnostic.mjs +130 -0
- package/test-suite/scripts/verify-golden-path.mjs +138 -0
- package/test-suite/scripts/verify-oracle-components.mjs +133 -0
- package/test-suite/scripts/verify-template-bindings.mjs +148 -0
- package/test-suite/typecheck/angular-v5/package.json +21 -0
- package/test-suite/typecheck/angular-v5/tsconfig.json +21 -0
- package/test-suite/typecheck/flutter-v6/analysis_options.yaml +25 -0
- package/test-suite/typecheck/flutter-v6/pubspec.yaml +21 -0
- package/test-suite/typecheck/web-v7/package.json +18 -0
- package/test-suite/typecheck/web-v7/tsconfig.json +19 -0
- package/bin/install.js +0 -1003
- package/skills/.claude-plugin/marketplace.json +0 -86
- package/skills/cometchat/references/asking-questions.md +0 -48
- package/skills/cometchat-a11y/SKILL.md +0 -477
- package/skills/cometchat-android-v5/SKILL.md +0 -121
- package/skills/cometchat-android-v5-calls/SKILL.md +0 -429
- package/skills/cometchat-android-v5-calls/references/README.md +0 -53
- package/skills/cometchat-android-v5-calls/references/add-calls-to-existing-chat.md +0 -197
- package/skills/cometchat-android-v5-calls/references/audio-controls.md +0 -91
- package/skills/cometchat-android-v5-calls/references/background-handling.md +0 -168
- package/skills/cometchat-android-v5-calls/references/call-layouts.md +0 -131
- package/skills/cometchat-android-v5-calls/references/call-logs.md +0 -113
- package/skills/cometchat-android-v5-calls/references/call-session.md +0 -274
- package/skills/cometchat-android-v5-calls/references/custom-ui.md +0 -150
- package/skills/cometchat-android-v5-calls/references/event-listeners.md +0 -123
- package/skills/cometchat-android-v5-calls/references/group-calls.md +0 -205
- package/skills/cometchat-android-v5-calls/references/idle-timeout.md +0 -117
- package/skills/cometchat-android-v5-calls/references/in-call-chat.md +0 -134
- package/skills/cometchat-android-v5-calls/references/join-session.md +0 -120
- package/skills/cometchat-android-v5-calls/references/migration-v4-to-v5.md +0 -222
- package/skills/cometchat-android-v5-calls/references/participant-management.md +0 -110
- package/skills/cometchat-android-v5-calls/references/picture-in-picture.md +0 -106
- package/skills/cometchat-android-v5-calls/references/raise-hand.md +0 -248
- package/skills/cometchat-android-v5-calls/references/recording.md +0 -101
- package/skills/cometchat-android-v5-calls/references/ringing-integration.md +0 -152
- package/skills/cometchat-android-v5-calls/references/screen-sharing.md +0 -78
- package/skills/cometchat-android-v5-calls/references/server-fcm-voip.md +0 -215
- package/skills/cometchat-android-v5-calls/references/session-settings.md +0 -121
- package/skills/cometchat-android-v5-calls/references/setup.md +0 -137
- package/skills/cometchat-android-v5-calls/references/share-invite.md +0 -156
- package/skills/cometchat-android-v5-calls/references/video-controls.md +0 -87
- package/skills/cometchat-android-v5-calls/references/voip-calling.md +0 -526
- package/skills/cometchat-android-v5-components/SKILL.md +0 -431
- package/skills/cometchat-android-v5-core/SKILL.md +0 -486
- package/skills/cometchat-android-v5-customization/SKILL.md +0 -469
- package/skills/cometchat-android-v5-extensions/SKILL.md +0 -127
- package/skills/cometchat-android-v5-features/SKILL.md +0 -131
- package/skills/cometchat-android-v5-placement/SKILL.md +0 -277
- package/skills/cometchat-android-v5-production/SKILL.md +0 -95
- package/skills/cometchat-android-v5-push/SKILL.md +0 -619
- package/skills/cometchat-android-v5-testing/SKILL.md +0 -188
- package/skills/cometchat-android-v5-theming/SKILL.md +0 -167
- package/skills/cometchat-android-v5-troubleshooting/SKILL.md +0 -74
- package/skills/cometchat-android-v6/SKILL.md +0 -108
- package/skills/cometchat-android-v6-calls/references/add-calls-to-existing-chat.md +0 -97
- package/skills/cometchat-android-v6-calls/references/advanced-features.md +0 -87
- package/skills/cometchat-android-v6-calls/references/call-layouts.md +0 -100
- package/skills/cometchat-android-v6-calls/references/call-session.md +0 -163
- package/skills/cometchat-android-v6-calls/references/device-management.md +0 -172
- package/skills/cometchat-android-v6-calls/references/group-calls.md +0 -191
- package/skills/cometchat-android-v6-calls/references/idle-timeout.md +0 -110
- package/skills/cometchat-android-v6-calls/references/in-call-chat.md +0 -141
- package/skills/cometchat-android-v6-calls/references/raise-hand.md +0 -188
- package/skills/cometchat-android-v6-calls/references/ringing-integration.md +0 -176
- package/skills/cometchat-android-v6-calls/references/server-fcm-voip.md +0 -127
- package/skills/cometchat-android-v6-calls/references/share-invite.md +0 -105
- package/skills/cometchat-android-v6-compose-theming/SKILL.md +0 -250
- package/skills/cometchat-android-v6-kotlin-theming/SKILL.md +0 -233
- package/skills/cometchat-angular-calls/SKILL.md +0 -380
- package/skills/cometchat-angular-calls/references/add-calls-to-existing-chat.md +0 -96
- package/skills/cometchat-angular-calls/references/call-layouts.md +0 -123
- package/skills/cometchat-angular-calls/references/call-session.md +0 -167
- package/skills/cometchat-angular-calls/references/custom-ui.md +0 -239
- package/skills/cometchat-angular-calls/references/device-management.md +0 -154
- package/skills/cometchat-angular-calls/references/group-calls.md +0 -433
- package/skills/cometchat-angular-calls/references/idle-timeout.md +0 -161
- package/skills/cometchat-angular-calls/references/in-call-chat.md +0 -148
- package/skills/cometchat-angular-calls/references/lazy-loading-pitfalls.md +0 -205
- package/skills/cometchat-angular-calls/references/migration-v4-to-v5.md +0 -53
- package/skills/cometchat-angular-calls/references/ngzone-and-async-callbacks.md +0 -184
- package/skills/cometchat-angular-calls/references/picture-in-picture.md +0 -285
- package/skills/cometchat-angular-calls/references/raise-hand.md +0 -172
- package/skills/cometchat-angular-calls/references/recording-screen-share.md +0 -260
- package/skills/cometchat-angular-calls/references/ringing-integration.md +0 -133
- package/skills/cometchat-angular-calls/references/server-web-push-vapid.md +0 -100
- package/skills/cometchat-angular-calls/references/share-invite.md +0 -122
- package/skills/cometchat-angular-calls/references/virtual-background.md +0 -29
- package/skills/cometchat-angular-components/SKILL.md +0 -235
- package/skills/cometchat-angular-core/SKILL.md +0 -386
- package/skills/cometchat-angular-customization/SKILL.md +0 -616
- package/skills/cometchat-angular-features/SKILL.md +0 -329
- package/skills/cometchat-angular-patterns/SKILL.md +0 -256
- package/skills/cometchat-angular-placement/SKILL.md +0 -314
- package/skills/cometchat-angular-production/SKILL.md +0 -564
- package/skills/cometchat-angular-push/SKILL.md +0 -389
- package/skills/cometchat-angular-testing/SKILL.md +0 -605
- package/skills/cometchat-angular-theming/SKILL.md +0 -290
- package/skills/cometchat-angular-troubleshooting/SKILL.md +0 -364
- package/skills/cometchat-astro-patterns/SKILL.md +0 -708
- package/skills/cometchat-calls/SKILL.md +0 -364
- package/skills/cometchat-calls/references/use-case-broadcast.md +0 -199
- package/skills/cometchat-calls/references/use-case-marketplace.md +0 -157
- package/skills/cometchat-calls/references/use-case-support.md +0 -189
- package/skills/cometchat-calls/references/use-case-team.md +0 -180
- package/skills/cometchat-calls/references/use-case-telehealth.md +0 -153
- package/skills/cometchat-components/SKILL.md +0 -1142
- package/skills/cometchat-core/SKILL.md +0 -1048
- package/skills/cometchat-customization/SKILL.md +0 -580
- package/skills/cometchat-customization/references/component-catalog.md +0 -236
- package/skills/cometchat-features/SKILL.md +0 -861
- package/skills/cometchat-flutter-v5/SKILL.md +0 -173
- package/skills/cometchat-flutter-v5-calls/SKILL.md +0 -455
- package/skills/cometchat-flutter-v5-calls/references/add-calls-to-existing-chat.md +0 -193
- package/skills/cometchat-flutter-v5-calls/references/call-layouts.md +0 -103
- package/skills/cometchat-flutter-v5-calls/references/call-session.md +0 -285
- package/skills/cometchat-flutter-v5-calls/references/device-management.md +0 -124
- package/skills/cometchat-flutter-v5-calls/references/group-calls.md +0 -181
- package/skills/cometchat-flutter-v5-calls/references/idle-timeout.md +0 -99
- package/skills/cometchat-flutter-v5-calls/references/in-call-chat.md +0 -135
- package/skills/cometchat-flutter-v5-calls/references/migration-v4-to-v5.md +0 -210
- package/skills/cometchat-flutter-v5-calls/references/raise-hand.md +0 -255
- package/skills/cometchat-flutter-v5-calls/references/ringing-integration.md +0 -196
- package/skills/cometchat-flutter-v5-calls/references/server-push-bridge.md +0 -101
- package/skills/cometchat-flutter-v5-calls/references/share-invite.md +0 -148
- package/skills/cometchat-flutter-v5-conversations/SKILL.md +0 -118
- package/skills/cometchat-flutter-v5-core/SKILL.md +0 -239
- package/skills/cometchat-flutter-v5-customization/SKILL.md +0 -358
- package/skills/cometchat-flutter-v5-events/SKILL.md +0 -156
- package/skills/cometchat-flutter-v5-messages/SKILL.md +0 -259
- package/skills/cometchat-flutter-v5-production/SKILL.md +0 -216
- package/skills/cometchat-flutter-v5-push/SKILL.md +0 -285
- package/skills/cometchat-flutter-v5-testing/SKILL.md +0 -401
- package/skills/cometchat-flutter-v5-theming/SKILL.md +0 -161
- package/skills/cometchat-flutter-v5-troubleshooting/SKILL.md +0 -130
- package/skills/cometchat-flutter-v5-users-groups/SKILL.md +0 -152
- package/skills/cometchat-flutter-v6/SKILL.md +0 -446
- package/skills/cometchat-flutter-v6-calls/references/add-calls-to-existing-chat.md +0 -136
- package/skills/cometchat-flutter-v6-calls/references/advanced-features.md +0 -89
- package/skills/cometchat-flutter-v6-calls/references/call-layouts.md +0 -105
- package/skills/cometchat-flutter-v6-calls/references/call-session.md +0 -229
- package/skills/cometchat-flutter-v6-calls/references/device-management.md +0 -105
- package/skills/cometchat-flutter-v6-calls/references/group-calls.md +0 -190
- package/skills/cometchat-flutter-v6-calls/references/idle-timeout.md +0 -88
- package/skills/cometchat-flutter-v6-calls/references/in-call-chat.md +0 -125
- package/skills/cometchat-flutter-v6-calls/references/raise-hand.md +0 -275
- package/skills/cometchat-flutter-v6-calls/references/ringing-integration.md +0 -171
- package/skills/cometchat-flutter-v6-calls/references/server-push-bridge.md +0 -93
- package/skills/cometchat-flutter-v6-calls/references/share-invite.md +0 -102
- package/skills/cometchat-flutter-v6-conversations/SKILL.md +0 -238
- package/skills/cometchat-flutter-v6-messages/SKILL.md +0 -384
- package/skills/cometchat-flutter-v6-theming/SKILL.md +0 -293
- package/skills/cometchat-flutter-v6-users-groups/SKILL.md +0 -224
- package/skills/cometchat-i18n/SKILL.md +0 -419
- package/skills/cometchat-ios/SKILL.md +0 -325
- package/skills/cometchat-ios-calls/references/add-calls-to-existing-chat.md +0 -181
- package/skills/cometchat-ios-calls/references/audio-modes-and-controls.md +0 -45
- package/skills/cometchat-ios-calls/references/avaudiosession-routing.md +0 -188
- package/skills/cometchat-ios-calls/references/call-layouts.md +0 -76
- package/skills/cometchat-ios-calls/references/call-session.md +0 -218
- package/skills/cometchat-ios-calls/references/callkit-and-pushkit.md +0 -357
- package/skills/cometchat-ios-calls/references/custom-ui.md +0 -322
- package/skills/cometchat-ios-calls/references/device-management.md +0 -171
- package/skills/cometchat-ios-calls/references/group-calls.md +0 -359
- package/skills/cometchat-ios-calls/references/idle-timeout.md +0 -184
- package/skills/cometchat-ios-calls/references/in-call-chat.md +0 -179
- package/skills/cometchat-ios-calls/references/migration-v4-to-v5.md +0 -196
- package/skills/cometchat-ios-calls/references/picture-in-picture.md +0 -246
- package/skills/cometchat-ios-calls/references/raise-hand.md +0 -26
- package/skills/cometchat-ios-calls/references/recording-screen-share.md +0 -252
- package/skills/cometchat-ios-calls/references/ringing-integration.md +0 -143
- package/skills/cometchat-ios-calls/references/server-apns-pushkit.md +0 -267
- package/skills/cometchat-ios-calls/references/share-invite.md +0 -148
- package/skills/cometchat-ios-calls/references/swiftui-uikit-hosting.md +0 -246
- package/skills/cometchat-ios-calls/references/voip-cert-setup.md +0 -166
- package/skills/cometchat-ios-production/SKILL.md +0 -738
- package/skills/cometchat-ios-testing/SKILL.md +0 -376
- package/skills/cometchat-ios-theming/SKILL.md +0 -667
- package/skills/cometchat-ios-troubleshooting/SKILL.md +0 -1003
- package/skills/cometchat-native-bare-patterns/SKILL.md +0 -550
- package/skills/cometchat-native-calls/SKILL.md +0 -671
- package/skills/cometchat-native-calls/references/add-calls-to-existing-chat.md +0 -203
- package/skills/cometchat-native-calls/references/call-layouts.md +0 -125
- package/skills/cometchat-native-calls/references/call-session.md +0 -182
- package/skills/cometchat-native-calls/references/custom-ui.md +0 -254
- package/skills/cometchat-native-calls/references/device-management.md +0 -158
- package/skills/cometchat-native-calls/references/expo-vs-bare.md +0 -179
- package/skills/cometchat-native-calls/references/group-calls.md +0 -296
- package/skills/cometchat-native-calls/references/idle-timeout.md +0 -128
- package/skills/cometchat-native-calls/references/in-call-chat.md +0 -145
- package/skills/cometchat-native-calls/references/migration-v4-to-v5.md +0 -72
- package/skills/cometchat-native-calls/references/picture-in-picture.md +0 -276
- package/skills/cometchat-native-calls/references/raise-hand.md +0 -205
- package/skills/cometchat-native-calls/references/recording-screen-share.md +0 -169
- package/skills/cometchat-native-calls/references/ringing-integration.md +0 -118
- package/skills/cometchat-native-calls/references/server-push-bridge.md +0 -135
- package/skills/cometchat-native-calls/references/server-push-payloads.md +0 -193
- package/skills/cometchat-native-calls/references/share-invite.md +0 -146
- package/skills/cometchat-native-calls/references/voip-push-end-to-end.md +0 -319
- package/skills/cometchat-native-components/SKILL.md +0 -628
- package/skills/cometchat-native-core/SKILL.md +0 -679
- package/skills/cometchat-native-customization/SKILL.md +0 -716
- package/skills/cometchat-native-expo-patterns/SKILL.md +0 -552
- package/skills/cometchat-native-features/SKILL.md +0 -638
- package/skills/cometchat-native-placement/SKILL.md +0 -509
- package/skills/cometchat-native-production/SKILL.md +0 -700
- package/skills/cometchat-native-push/SKILL.md +0 -594
- package/skills/cometchat-native-testing/SKILL.md +0 -582
- package/skills/cometchat-native-theming/SKILL.md +0 -681
- package/skills/cometchat-native-troubleshooting/SKILL.md +0 -501
- package/skills/cometchat-nextjs-patterns/SKILL.md +0 -899
- package/skills/cometchat-placement/SKILL.md +0 -1360
- package/skills/cometchat-production/SKILL.md +0 -1027
- package/skills/cometchat-react-calls/SKILL.md +0 -752
- package/skills/cometchat-react-calls/references/add-calls-to-existing-chat.md +0 -146
- package/skills/cometchat-react-calls/references/call-layouts.md +0 -160
- package/skills/cometchat-react-calls/references/call-session.md +0 -235
- package/skills/cometchat-react-calls/references/custom-ui.md +0 -247
- package/skills/cometchat-react-calls/references/device-management.md +0 -210
- package/skills/cometchat-react-calls/references/group-calls.md +0 -257
- package/skills/cometchat-react-calls/references/idle-timeout.md +0 -188
- package/skills/cometchat-react-calls/references/in-call-chat.md +0 -212
- package/skills/cometchat-react-calls/references/migration-v4-to-v5.md +0 -170
- package/skills/cometchat-react-calls/references/picture-in-picture.md +0 -245
- package/skills/cometchat-react-calls/references/raise-hand.md +0 -238
- package/skills/cometchat-react-calls/references/recording-screen-share.md +0 -144
- package/skills/cometchat-react-calls/references/ringing-integration.md +0 -255
- package/skills/cometchat-react-calls/references/server-web-push-vapid.md +0 -241
- package/skills/cometchat-react-calls/references/share-invite.md +0 -175
- package/skills/cometchat-react-calls/references/testing-calls-on-web.md +0 -216
- package/skills/cometchat-react-calls/references/virtual-background.md +0 -32
- package/skills/cometchat-react-calls/references/voip-and-web-push.md +0 -165
- package/skills/cometchat-react-patterns/SKILL.md +0 -628
- package/skills/cometchat-react-push/SKILL.md +0 -634
- package/skills/cometchat-react-router-patterns/SKILL.md +0 -758
- package/skills/cometchat-react-testing/SKILL.md +0 -413
- package/skills/cometchat-theming/SKILL.md +0 -498
- package/skills/cometchat-troubleshooting/SKILL.md +0 -294
|
@@ -1,329 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: cometchat-angular-features
|
|
3
|
-
description: "Feature catalog for CometChat Angular UI Kit v5 (@cometchat/chat-uikit-angular@5) — how to enable/configure calls, reactions, mentions, AI (smart replies / conversation starter / summary), polls, stickers, collaborative doc/whiteboard, message translation, link preview. Five-bucket taxonomy: auto-enabled / component-prop / dashboard-extension / AI-with-OpenAI-key / package-install (calls). Verified @Input names against the v5 .d.ts."
|
|
4
|
-
license: "MIT"
|
|
5
|
-
compatibility: "Angular >=17 <22; @cometchat/chat-uikit-angular ^5.0; @cometchat/calls-sdk-javascript ^5.0 (calls)"
|
|
6
|
-
metadata:
|
|
7
|
-
author: "CometChat"
|
|
8
|
-
version: "4.0.0"
|
|
9
|
-
tags: "cometchat angular features calls reactions mentions ai polls stickers extensions v5"
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
## Purpose
|
|
13
|
-
|
|
14
|
-
Teaches Claude how to add features on top of a working CometChat **Angular UI Kit v5** (`@cometchat/chat-uikit-angular@5`) integration. Each feature falls into exactly one of five categories; this skill gives the correct recipe for each and — critically — names the precise component `@Input` you flip, every one of which is **verified against the v5 component catalog / `.d.ts`**.
|
|
15
|
-
|
|
16
|
-
**Read `cometchat-angular-core` + `cometchat-angular-components` first** — a base v5 integration (standalone components, `UIKitSettingsBuilder` init, `login(uid)` bare string, CSS-variable theming) must already exist before features layer on. For the full voice/video call flow, read `cometchat-angular-calls`.
|
|
17
|
-
|
|
18
|
-
Ground truth: `@cometchat/chat-uikit-angular@5.0.2` source (component `@Input`/`@Output` declarations in `projects/cometchat-uikit/src/lib/components/**`) + `docs/ui-kit/angular`. **Never invent a component `@Input`** — every prop cited here is verified against the v5 component source.
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## 1. Feature taxonomy
|
|
23
|
-
|
|
24
|
-
Every CometChat Angular v5 feature falls into exactly one of these five **mechanism** categories — they tell you *how* to wire each feature (the actionable Angular view), and map onto the product's canonical **5-tier "work-needed" model** (Core Zero-Setup → Builder-Enabled → Config-Only → Config+Settings → SDK-Integrated; see `cometchat-features` §3 + `packages/registry/v6/features/catalog.json`; canonical public matrix → [Features & Extensions Guide](https://www.cometchat.com/docs/fundamentals/features-and-extensions-guide), which outranks this snapshot on conflict): Auto-enabled ≈ Core; Component-prop ≈ Core/Config; Dashboard-extension ≈ Config-Only; AI-with-OpenAI-key ≈ Config+Settings; Package-install ≈ SDK-Integrated:
|
|
25
|
-
|
|
26
|
-
| Category | What it means | Example features | How to enable |
|
|
27
|
-
|---|---|---|---|
|
|
28
|
-
| **Auto-enabled** | Already on — shipped compiled into the kit's base components. The only question is whether a hide flag is turning it off. | Instant messaging, typing indicators, read receipts, **reactions**, replies, threads, media upload, edit/delete, message info, presence | Just render `<cometchat-message-header>` + `<cometchat-message-list>` + `<cometchat-message-composer>` |
|
|
29
|
-
| **Component-prop** | Present in the kit but surfaced via a component `@Input` you set. | **@mentions** (`textFormatters`), AI smart replies / conversation starters / summary (`@Input`s on message-list + message-header) | Set the verified `@Input` (§2, §4) |
|
|
30
|
-
| **Dashboard-extension** | Backend toggle enabled in the CometChat dashboard (or via the `cometchat apply-feature` CLI). The kit auto-renders the matching UI once enabled. | Polls, stickers, collaborative doc/whiteboard, message translation, link preview, thumbnail generation | `cometchat apply-feature <id> --app-id <X>` → hard-reload (§3) |
|
|
31
|
-
| **AI-with-OpenAI-key** | Dashboard AI toggle that also needs an OpenAI API key on the app, **then** a component `@Input` to surface it. | Smart replies, conversation starter, conversation summary | `cometchat apply-feature <id> --app-id <X> --openai-key sk-…` → set the message-list / header `@Input` (§4) |
|
|
32
|
-
| **Package-install (calls)** | Install the separate calls SDK + enable calling on the builder. The kit's call components then work. | Voice + video calls, call logs | `npm install @cometchat/calls-sdk-javascript@^5` + `.setCallingEnabled(true)` → see `cometchat-angular-calls` (§5) |
|
|
33
|
-
|
|
34
|
-
> The `cometchat apply-feature <id>` CLI and the dashboard toggles are **not code symbols** — they configure the backend. The code-side work for dashboard-extension features is usually zero; for component-prop and AI features it's a single `@Input`.
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
## 2. Auto-enabled features (no work) + the two component-prop ones
|
|
39
|
-
|
|
40
|
-
### Already on from day 1 — no feature-enabling step
|
|
41
|
-
|
|
42
|
-
Rendering the three messaging components gives you all of these for free:
|
|
43
|
-
|
|
44
|
-
- **Instant messaging** (text, real-time delivery)
|
|
45
|
-
- **Media sharing** (images, video, audio, files)
|
|
46
|
-
- **Read receipts** (sent / delivered / read ticks)
|
|
47
|
-
- **Typing indicators**
|
|
48
|
-
- **Reactions** — on by default in `<cometchat-message-list>`. Click any message → emoji reaction. To turn it off, set `[hideReactionOption]="true"` (verified hide flag on the message list).
|
|
49
|
-
- **Replies** / **threads** (`hideReplyOption`, `hideReplyInThreadOption` to hide)
|
|
50
|
-
- **Edit / delete** own messages (`hideEditMessageOption`, `hideDeleteMessageOption`)
|
|
51
|
-
- **Message info** (`hideMessageInfoOption`)
|
|
52
|
-
- **Voice messages** (record + send from composer; `hideVoiceRecordingButton` to hide)
|
|
53
|
-
- **User presence** (online/offline status indicators render on avatars in `<cometchat-conversations>`, `<cometchat-users>`, `<cometchat-group-members>` by default — there is no per-list presence-hide `@Input` in v5; the only `hideUserStatus` flag lives on `<cometchat-search>`)
|
|
54
|
-
- **Search** — `<cometchat-users>` and `<cometchat-groups>` render a search bar by default; set `[hideSearch]="true"` to remove it (verified hide flag, default `false`). `<cometchat-conversations>` is the inverse: it has a **`[showSearchBar]` `@Input`** (default `false` — search hidden), so set `[showSearchBar]="true"` to show it; it also exposes a `[searchView]` template slot for a fully custom search surface.
|
|
55
|
-
|
|
56
|
-
These need **no install and no toggle**. If a customer reports one "missing," the cause is almost always a `hide*` input set to `true` somewhere — grep the templates first.
|
|
57
|
-
|
|
58
|
-
### Mentions (`@mentions`) — component-prop
|
|
59
|
-
|
|
60
|
-
Mentions are not auto-on; they surface only when you pass a `CometChatMentionsFormatter` into the verified `textFormatters` `@Input` (which exists on `<cometchat-message-list>`, `<cometchat-message-composer>`, and `<cometchat-conversations>`):
|
|
61
|
-
|
|
62
|
-
```typescript
|
|
63
|
-
// chat.component.ts
|
|
64
|
-
import { Component } from "@angular/core";
|
|
65
|
-
import {
|
|
66
|
-
CometChatMessageListComponent,
|
|
67
|
-
CometChatMessageComposerComponent,
|
|
68
|
-
CometChatMentionsFormatter,
|
|
69
|
-
} from "@cometchat/chat-uikit-angular";
|
|
70
|
-
import { CometChat } from "@cometchat/chat-sdk-javascript";
|
|
71
|
-
|
|
72
|
-
@Component({
|
|
73
|
-
selector: "app-chat",
|
|
74
|
-
standalone: true,
|
|
75
|
-
imports: [CometChatMessageListComponent, CometChatMessageComposerComponent],
|
|
76
|
-
template: `
|
|
77
|
-
<cometchat-message-list [user]="user" [textFormatters]="formatters"></cometchat-message-list>
|
|
78
|
-
<cometchat-message-composer [user]="user" [textFormatters]="formatters"></cometchat-message-composer>
|
|
79
|
-
`,
|
|
80
|
-
})
|
|
81
|
-
export class ChatComponent {
|
|
82
|
-
@Input() user!: CometChat.User;
|
|
83
|
-
// Pass the SAME formatter array to list + composer so typed @mentions render consistently
|
|
84
|
-
formatters = [new CometChatMentionsFormatter()];
|
|
85
|
-
}
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
- `@all` mentions: the composer enables mention-all by default; set `[disableMentionAll]="true"` to suppress it (verified composer hide flag).
|
|
89
|
-
- To disable mentions entirely, set `[disableMentions]="true"` on the composer instead of omitting the formatter.
|
|
90
|
-
|
|
91
|
-
> **Why a formatter, not a toggle?** Mentions are a text-rendering concern. `CometChatMentionsFormatter` (verified export) is a `CometChatTextFormatter` subclass; the kit runs it over message text in the list and over input in the composer.
|
|
92
|
-
|
|
93
|
-
---
|
|
94
|
-
|
|
95
|
-
## 3. Dashboard-extension features (polls, stickers, collaborative, translation, link preview)
|
|
96
|
-
|
|
97
|
-
These are backend extensions. Enable each in the **CometChat dashboard**, or via the cross-family CLI. The components auto-render the result — usually **zero code**.
|
|
98
|
-
|
|
99
|
-
### Enable via the CLI (preferred — no browser)
|
|
100
|
-
|
|
101
|
-
Angular projects don't go through `cometchat apply` (no `.cometchat/state.json`), so always pass `--app-id <id>` explicitly. The CLI hits the dashboard API using the bearer from `cometchat auth login`:
|
|
102
|
-
|
|
103
|
-
```bash
|
|
104
|
-
cometchat apply-feature polls --app-id <your-app-id>
|
|
105
|
-
cometchat apply-feature stickers --app-id <your-app-id>
|
|
106
|
-
cometchat apply-feature message-translation --app-id <your-app-id>
|
|
107
|
-
cometchat apply-feature link-preview --app-id <your-app-id>
|
|
108
|
-
cometchat apply-feature collaborative-document --app-id <your-app-id>
|
|
109
|
-
cometchat apply-feature collaborative-whiteboard --app-id <your-app-id>
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
`cometchat apply-feature` and the dashboard toggles configure the **backend**; they are not code symbols.
|
|
113
|
-
|
|
114
|
-
**Response shapes (`--json`):**
|
|
115
|
-
- `"status": "applied"` → done. Hard-reload the Angular dev server (`ng serve` restart or browser refresh).
|
|
116
|
-
- `"status": "already-applied"` → already in the desired state.
|
|
117
|
-
- `"status": "auth-required"` → run `cometchat auth login` first.
|
|
118
|
-
- `"status": "manual-action-required"` → a third-party-config extension (Giphy, Stipop, Tenor, Chatwoot, Intercom, Disappearing Messages, Message Shortcuts). The CLI can't automate these — surface `next_steps` verbatim and walk the user through the dashboard.
|
|
119
|
-
- `"status": "error"` → surface `next_steps`.
|
|
120
|
-
|
|
121
|
-
### Enable via the dashboard (fallback)
|
|
122
|
-
|
|
123
|
-
1. https://app.cometchat.com → your app
|
|
124
|
-
2. Chat & Messaging → Features
|
|
125
|
-
3. Find the extension by name → flip Status ON
|
|
126
|
-
4. Hard-reload the Angular app
|
|
127
|
-
|
|
128
|
-
### Where each toggle surfaces in the v5 UI
|
|
129
|
-
|
|
130
|
-
| Extension | UI surface when enabled | Related verified hide flag (to suppress) |
|
|
131
|
-
|---|---|---|
|
|
132
|
-
| Polls | "Poll" option in `<cometchat-message-composer>`'s attachment menu; poll bubble in the list | `hidePollsOption` (composer) |
|
|
133
|
-
| Stickers | Sticker button in the composer; sticker bubble in the list | `hideStickersButton` (composer) |
|
|
134
|
-
| Collaborative document | Option in the composer attachment menu; opens a shared doc | `hideCollaborativeDocumentOption` (composer) |
|
|
135
|
-
| Collaborative whiteboard | Option in the composer attachment menu; opens a shared canvas | `hideCollaborativeWhiteboardOption` (composer) |
|
|
136
|
-
| Message translation | "Translate" option in the message context menu | `hideTranslateMessageOption` (message list) |
|
|
137
|
-
| Link preview | Rich-card bubble for URLs in the message list | — |
|
|
138
|
-
| Thumbnail generation | Image/video bubbles show thumbnails | — |
|
|
139
|
-
|
|
140
|
-
These are real, verified `@Input` hide flags on the v5 components — the feature *renders by default once the dashboard toggle is on*; you only touch a flag if you want to hide it.
|
|
141
|
-
|
|
142
|
-
After enabling, run `cometchat verify --json` and hard-reload. No code changes are needed for the auto-wired subset above.
|
|
143
|
-
|
|
144
|
-
---
|
|
145
|
-
|
|
146
|
-
## 4. AI features — dashboard toggle + OpenAI key + one component `@Input`
|
|
147
|
-
|
|
148
|
-
`smart-replies`, `conversation-starter`, and `conversation-summary` are AI features. Two steps: (1) enable on the backend with an OpenAI key, (2) surface with the verified component `@Input`.
|
|
149
|
-
|
|
150
|
-
### 4a — Enable on the backend (one CLI call)
|
|
151
|
-
|
|
152
|
-
The CLI sets the OpenAI key on the app and flips the toggle together:
|
|
153
|
-
|
|
154
|
-
```bash
|
|
155
|
-
cometchat apply-feature smart-replies --app-id <your-app-id> --openai-key sk-...
|
|
156
|
-
cometchat apply-feature conversation-starter --app-id <your-app-id> --openai-key sk-...
|
|
157
|
-
cometchat apply-feature conversation-summary --app-id <your-app-id> --openai-key sk-...
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
The key is stored on the app once, so subsequent AI applies don't need `--openai-key` repeated. `"status": "openai-key-required"` → re-run with `--openai-key sk-…`. Get a key: https://platform.openai.com/api-keys.
|
|
161
|
-
|
|
162
|
-
### 4b — Surface smart replies + conversation starters (message-list `@Input`s)
|
|
163
|
-
|
|
164
|
-
These are **verified `@Input`s on `<cometchat-message-list>`** (confirmed in the v5 `.d.ts`):
|
|
165
|
-
|
|
166
|
-
```html
|
|
167
|
-
<cometchat-message-list
|
|
168
|
-
[user]="selectedUser"
|
|
169
|
-
[showSmartReplies]="true"
|
|
170
|
-
[showConversationStarters]="true"
|
|
171
|
-
[smartRepliesKeywords]="['help', 'pricing']"
|
|
172
|
-
[smartRepliesDelayDuration]="2000">
|
|
173
|
-
</cometchat-message-list>
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
- `showSmartReplies` (boolean) — renders smart-reply chips after a recent incoming message.
|
|
177
|
-
- `showConversationStarters` (boolean) — renders starter suggestions when the conversation is empty.
|
|
178
|
-
- `smartRepliesKeywords` (`string[]`) — only show smart replies when the incoming message contains one of these keywords. Defaults to `['what', 'when', 'why', 'who', 'where', 'how', '?']` in v5 — set your own array to narrow it.
|
|
179
|
-
- `smartRepliesDelayDuration` (number, ms) — debounce before chips appear (v5 default `10000`).
|
|
180
|
-
|
|
181
|
-
`<cometchat-message-list>` also exposes the `(smartReplyClick)` and `(conversationStarterClick)` `@Output`s (each emits the selected reply `string`) if you want to observe selection. (There are also standalone `<cometchat-smart-replies>` and `<cometchat-conversation-starter>` components — verified exports under `base-elements/` — but the message-list `@Input`s are the idiomatic path.)
|
|
182
|
-
|
|
183
|
-
### 4c — Surface conversation summary (message-header `@Input`s)
|
|
184
|
-
|
|
185
|
-
Conversation summary is driven by **verified `@Input`s on `<cometchat-message-header>`**:
|
|
186
|
-
|
|
187
|
-
```html
|
|
188
|
-
<cometchat-message-header
|
|
189
|
-
[user]="selectedUser"
|
|
190
|
-
[showConversationSummaryButton]="true"
|
|
191
|
-
[enableAutoSummaryGeneration]="true"
|
|
192
|
-
[summaryGenerationMessageCount]="50"
|
|
193
|
-
(conversationSummaryClick)="onSummary($event)">
|
|
194
|
-
</cometchat-message-header>
|
|
195
|
-
```
|
|
196
|
-
|
|
197
|
-
- `showConversationSummaryButton` (boolean, default `false`) — shows the "Summarize" button in the header.
|
|
198
|
-
- `enableAutoSummaryGeneration` (boolean, default `false`) — auto-generate a summary once the message count crosses the threshold.
|
|
199
|
-
- `summaryGenerationMessageCount` (number, **v5 default `1000`**) — the message-count threshold that triggers auto-summary. Lower it (e.g. `50`) to summarize sooner.
|
|
200
|
-
- `(conversationSummaryClick)` — `@Output` fired when the summary button is clicked; emits `{ messageCount: number }` (type the `$event` accordingly).
|
|
201
|
-
|
|
202
|
-
> The standalone `<cometchat-conversation-summary>` component (verified `@Input`s `getConversationSummary: () => Promise<string>` and `closeCallback: () => void`) is for fully custom summary UIs. For the standard flow, the header `@Input`s above are all you need.
|
|
203
|
-
|
|
204
|
-
### 4d — Reading smart-reply metadata for a fully custom UI
|
|
205
|
-
|
|
206
|
-
If you render your own chips instead of using `showSmartReplies`, read the server-injected metadata off the incoming message (the AI runs on CometChat's backend, not in your code):
|
|
207
|
-
|
|
208
|
-
```typescript
|
|
209
|
-
const metadata = message.getMetadata() as Record<string, any>;
|
|
210
|
-
const smartReply = metadata?.["@injected"]?.["extensions"]?.["smart-reply"];
|
|
211
|
-
if (smartReply) {
|
|
212
|
-
const replies = [
|
|
213
|
-
smartReply.reply_positive,
|
|
214
|
-
smartReply.reply_neutral,
|
|
215
|
-
smartReply.reply_negative,
|
|
216
|
-
].filter(Boolean);
|
|
217
|
-
// render your own reply chips → on click, CometChatUIKit.sendTextMessage(...)
|
|
218
|
-
}
|
|
219
|
-
```
|
|
220
|
-
|
|
221
|
-
---
|
|
222
|
-
|
|
223
|
-
## 5. Calls (package-install) — pointer to the calls skill
|
|
224
|
-
|
|
225
|
-
Voice + video calling is the one package-install feature. Two steps:
|
|
226
|
-
|
|
227
|
-
```bash
|
|
228
|
-
npm install @cometchat/calls-sdk-javascript@^5
|
|
229
|
-
```
|
|
230
|
-
|
|
231
|
-
```typescript
|
|
232
|
-
// in your UIKitSettingsBuilder chain, before CometChatUIKit.init(...)
|
|
233
|
-
const settings = new UIKitSettingsBuilder()
|
|
234
|
-
.setAppId(environment.cometchat.appId)
|
|
235
|
-
.setRegion(environment.cometchat.region)
|
|
236
|
-
.setAuthKey(environment.cometchat.authKey)
|
|
237
|
-
.setCallingEnabled(true) // verified builder method (v5 .d.ts)
|
|
238
|
-
.build();
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
`setCallingEnabled(true)` is a **verified** `UIKitSettingsBuilder` method. Once the calls SDK peer is installed and calling is enabled, the kit's standalone call components work: `<cometchat-call-buttons>`, `<cometchat-incoming-call>`, `<cometchat-outgoing-call>`, `<cometchat-ongoing-call>`, `<cometchat-call-logs>`.
|
|
242
|
-
|
|
243
|
-
**For the full call flow — app-wide incoming-call mounting, the `@Input`-callback-vs-`@Output` binding split (`[onAccept]` input vs `(callAccepted)` output), NgZone correctness, getUserMedia handling, additive-vs-standalone modes — read `cometchat-angular-calls`.** Do not re-derive the call wiring here; that skill is the source of truth.
|
|
244
|
-
|
|
245
|
-
Quick reminder on call-button placement (header `[auxiliaryButtonView]` / `[menuView]` slot):
|
|
246
|
-
|
|
247
|
-
```html
|
|
248
|
-
<cometchat-message-header [user]="selectedUser" [auxiliaryButtonView]="callButtons"></cometchat-message-header>
|
|
249
|
-
<ng-template #callButtons>
|
|
250
|
-
<cometchat-call-buttons
|
|
251
|
-
[user]="selectedUser"
|
|
252
|
-
[onVoiceCallClick]="handleVoiceCall"
|
|
253
|
-
[onVideoCallClick]="handleVideoCall">
|
|
254
|
-
</cometchat-call-buttons>
|
|
255
|
-
</ng-template>
|
|
256
|
-
```
|
|
257
|
-
|
|
258
|
-
`onVoiceCallClick` / `onVideoCallClick` are **`@Input` callback props** (square brackets, function refs) — not `@Output`s. See the components catalog and calls skill.
|
|
259
|
-
|
|
260
|
-
---
|
|
261
|
-
|
|
262
|
-
## 6. AI Agent (dashboard setup, no dedicated v5 component)
|
|
263
|
-
|
|
264
|
-
1. https://app.cometchat.com → your app → AI → Agents
|
|
265
|
-
2. Create an agent (name, system prompt, model) and assign it a UID (e.g. `ai-support-agent`).
|
|
266
|
-
3. Users message the agent like any other user.
|
|
267
|
-
|
|
268
|
-
Angular v5 ships AI-assistant building blocks (`CometChatAIAssistantChat`, `-ChatHistory`, `-MessageBubble` are exported), but the standard, supported path to chat with an agent is the normal message components targeted at the agent's UID:
|
|
269
|
-
|
|
270
|
-
```typescript
|
|
271
|
-
CometChat.getUser("ai-support-agent").then((agent) => { this.aiAgent = agent; });
|
|
272
|
-
```
|
|
273
|
-
|
|
274
|
-
```html
|
|
275
|
-
<cometchat-message-header [user]="aiAgent"></cometchat-message-header>
|
|
276
|
-
<cometchat-message-list [user]="aiAgent"></cometchat-message-list>
|
|
277
|
-
<cometchat-message-composer [user]="aiAgent"></cometchat-message-composer>
|
|
278
|
-
```
|
|
279
|
-
|
|
280
|
-
Smart replies / conversation starter / summary surface through the §4 `@Input`s once enabled.
|
|
281
|
-
|
|
282
|
-
---
|
|
283
|
-
|
|
284
|
-
## 7. Finding a feature's category quickly
|
|
285
|
-
|
|
286
|
-
1. **In the auto-enabled list (§2)?** → Already works. Confirm no `hide*` `@Input` is turning it off.
|
|
287
|
-
2. **@mentions?** → Component-prop: pass `[textFormatters]="[new CometChatMentionsFormatter()]"` (§2).
|
|
288
|
-
3. **Smart replies / conversation starter / summary?** → AI feature: enable with `cometchat apply-feature <id> --app-id <X> --openai-key sk-…`, then set the message-list / message-header `@Input` (§4).
|
|
289
|
-
4. **Polls / stickers / collaborative doc-or-whiteboard / message translation / link preview / thumbnails?** → Dashboard-extension: `cometchat apply-feature <id> --app-id <X>`, then hard-reload (§3).
|
|
290
|
-
5. **Giphy / Stipop / Tenor / Chatwoot / Intercom / Disappearing Messages / Message Shortcuts?** → Dashboard-extension needing third-party config; CLI returns `manual-action-required`. Walk the user through https://app.cometchat.com → Chat & Messaging → Features.
|
|
291
|
-
6. **Voice / video / call logs?** → Package-install: `npm install @cometchat/calls-sdk-javascript@^5` + `.setCallingEnabled(true)` → `cometchat-angular-calls` (§5).
|
|
292
|
-
7. **AI agent?** → §6.
|
|
293
|
-
8. **Custom text formatting / custom message templates / custom slot views / theming?** → That's **customization**, not a feature. Route to `cometchat-angular-customization` / `cometchat-angular-theming`.
|
|
294
|
-
9. **Not on this list?** → Check `docs/ui-kit/angular/guide-overview` + the kit's exports. If still nothing, the feature isn't in the UI Kit; the user may need the raw SDK.
|
|
295
|
-
|
|
296
|
-
---
|
|
297
|
-
|
|
298
|
-
## 8. Anti-patterns
|
|
299
|
-
|
|
300
|
-
1. **Don't invent a component `@Input`.** Every prop in this skill (`showSmartReplies`, `showConversationStarters`, `smartRepliesKeywords`, `smartRepliesDelayDuration`, `showConversationSummaryButton`, `enableAutoSummaryGeneration`, `summaryGenerationMessageCount`, `textFormatters`, the `hide*` flags, `setCallingEnabled`) is verified against the v5 `.d.ts`. If a prop isn't in `cometchat-angular-components` or the `.d.ts`, it doesn't exist — v4 prop names frequently differ.
|
|
301
|
-
2. **Don't treat reactions/mentions as a backend toggle.** Reactions are auto-on (hide via `hideReactionOption`); mentions are a `textFormatters` `@Input`. Neither uses `apply-feature`.
|
|
302
|
-
3. **Don't speculatively install the calls SDK.** Install `@cometchat/calls-sdk-javascript` only after the user asks for calls, and pin `^5`.
|
|
303
|
-
4. **Don't enable extensions the app doesn't use.** Each enabled extension adds data-fetching overhead.
|
|
304
|
-
5. **Don't omit `--app-id`.** Angular has no `.cometchat/state.json`; every `apply-feature` call needs `--app-id <id>`.
|
|
305
|
-
6. **Don't bind a call `@Input` callback as an `@Output`.** `[onVoiceCallClick]="fn"` (input) vs `(voiceCallClick)="fn($event)"` (output) — use the one the catalog lists.
|
|
306
|
-
7. **Don't reference AI streaming APIs from memory.** They change across minor versions — confirm against the docs MCP / `.d.ts` before generating code.
|
|
307
|
-
|
|
308
|
-
---
|
|
309
|
-
|
|
310
|
-
## Skill routing reference
|
|
311
|
-
|
|
312
|
-
| Skill | When to route |
|
|
313
|
-
|---|---|
|
|
314
|
-
| `cometchat-angular-core` | Init / login / standalone setup / `UIKitSettingsBuilder` |
|
|
315
|
-
| `cometchat-angular-components` | Component selector + `@Input`/`@Output` reference |
|
|
316
|
-
| `cometchat-angular-calls` | Full voice/video call flow + incoming-call mounting |
|
|
317
|
-
| `cometchat-angular-placement` | Where the call-logs tab / AI chat route / message panes go |
|
|
318
|
-
| `cometchat-angular-features` | This skill — which features exist + how to enable each |
|
|
319
|
-
| `cometchat-angular-theming` | Theming reaction colors, call buttons, extension UI (CSS variables) |
|
|
320
|
-
| `cometchat-angular-customization` | Custom text formatters, custom message templates, event bus |
|
|
321
|
-
| `cometchat-angular-production` | Server-side auth tokens (prerequisite for AI agent in prod) |
|
|
322
|
-
| `cometchat-angular-troubleshooting` | Extension not showing after enabling, call permission failures |
|
|
323
|
-
|
|
324
|
-
## Sources
|
|
325
|
-
|
|
326
|
-
- [Core features](https://www.cometchat.com/docs/ui-kit/angular/core-features)
|
|
327
|
-
- [Extensions](https://www.cometchat.com/docs/ui-kit/angular/extensions)
|
|
328
|
-
- [AI features](https://www.cometchat.com/docs/ui-kit/angular/ai-features)
|
|
329
|
-
- [Calling integration](https://www.cometchat.com/docs/ui-kit/angular/calling-integration)
|
|
@@ -1,256 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: cometchat-angular-patterns
|
|
3
|
-
description: "Angular-specific integration patterns for CometChat UI Kit v5 (@cometchat/chat-uikit-angular@5) — standalone bootstrap with main.ts init-before-bootstrap, functional route guards (CanActivateFn), lazy standalone routes (loadComponent), NgZone correctness for SDK callbacks, OnPush change detection, and SSR/Angular-Universal considerations."
|
|
4
|
-
license: "MIT"
|
|
5
|
-
compatibility: "Angular 17–21 (standalone APIs); @cometchat/chat-uikit-angular ^5.0"
|
|
6
|
-
metadata:
|
|
7
|
-
author: "CometChat"
|
|
8
|
-
version: "4.0.0"
|
|
9
|
-
tags: "cometchat angular patterns routing lazy guards standalone bootstrap ssr ngzone v5"
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
> **Ground truth:** `@cometchat/chat-uikit-angular@5.x` (+ `@cometchat/calls-sdk-javascript@^5`) — installed package types + `ui-kit/angular`. **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). Verify symbols against the installed package/source before relying on them.
|
|
13
|
-
|
|
14
|
-
## Purpose
|
|
15
|
-
|
|
16
|
-
Angular-specific wiring for CometChat UI Kit **v5** — how to hook init into Angular's standalone bootstrap, lazy-load chat routes, guard them, keep SDK callbacks inside Angular's zone, and handle SSR. Assumes the base integration from `cometchat-angular-core` + components from `cometchat-angular-components`.
|
|
17
|
-
|
|
18
|
-
**v5 is standalone-first (Angular 17–21).** Everything below uses `bootstrapApplication` + `app.config.ts` + functional APIs. There is **no NgModule, no `AppModule`, no `declarations`, no `CUSTOM_ELEMENTS_SCHEMA`** — those are v4 patterns and must not appear in a v5 app.
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## 1. Initialize in `main.ts` — before `bootstrapApplication`
|
|
23
|
-
|
|
24
|
-
The v5 canonical (matches the kit's own sample app and the docs): call `CometChatUIKit.init()` in `main.ts` and bootstrap the Angular app **inside the resolved init promise**. This guarantees the SDK is ready before any `<cometchat-*>` component can mount. `init()` is a static method, so it works fine outside Angular's DI context.
|
|
25
|
-
|
|
26
|
-
```typescript
|
|
27
|
-
// src/main.ts
|
|
28
|
-
import { bootstrapApplication } from "@angular/platform-browser";
|
|
29
|
-
import { CometChatUIKit, UIKitSettingsBuilder } from "@cometchat/chat-uikit-angular";
|
|
30
|
-
import { AppComponent } from "./app/app.component";
|
|
31
|
-
import { appConfig } from "./app/app.config";
|
|
32
|
-
import { environment } from "./environments/environment";
|
|
33
|
-
|
|
34
|
-
const settings = new UIKitSettingsBuilder()
|
|
35
|
-
.setAppId(environment.cometchat.appId)
|
|
36
|
-
.setRegion(environment.cometchat.region)
|
|
37
|
-
.setAuthKey(environment.cometchat.authKey)
|
|
38
|
-
.subscribePresenceForAllUsers()
|
|
39
|
-
// .setCallingEnabled(true) // uncomment + install @cometchat/calls-sdk-javascript for voice/video
|
|
40
|
-
.build();
|
|
41
|
-
|
|
42
|
-
// `init(...)` is `Promise<InitResult> | undefined` (v5.0.2) — coalesce to a Promise so
|
|
43
|
-
// `.then`/`.catch` don't fail `tsc` strict (TS2532) on Angular 21.
|
|
44
|
-
(CometChatUIKit.init(settings) ?? Promise.resolve())
|
|
45
|
-
.then(() => {
|
|
46
|
-
bootstrapApplication(AppComponent, appConfig).catch((err) => console.error(err));
|
|
47
|
-
})
|
|
48
|
-
.catch((error) => {
|
|
49
|
-
console.error("CometChat UIKit init failed:", error);
|
|
50
|
-
// Still bootstrap so the app renders (it can show a "chat unavailable" state).
|
|
51
|
-
bootstrapApplication(AppComponent, appConfig).catch((err) => console.error(err));
|
|
52
|
-
});
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
```typescript
|
|
56
|
-
// src/app/app.config.ts — providers only; init does NOT live here
|
|
57
|
-
import { ApplicationConfig } from "@angular/core";
|
|
58
|
-
import { provideRouter } from "@angular/router";
|
|
59
|
-
import { routes } from "./app.routes";
|
|
60
|
-
|
|
61
|
-
export const appConfig: ApplicationConfig = {
|
|
62
|
-
providers: [provideRouter(routes)],
|
|
63
|
-
};
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
```typescript
|
|
67
|
-
// src/environments/environment.ts
|
|
68
|
-
export const environment = {
|
|
69
|
-
production: false,
|
|
70
|
-
cometchat: {
|
|
71
|
-
appId: "APP_ID", // Dashboard → Your App → Credentials
|
|
72
|
-
region: "REGION", // us | eu | in
|
|
73
|
-
authKey: "AUTH_KEY", // dev/testing only — use Auth Tokens in production
|
|
74
|
-
},
|
|
75
|
-
};
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
> Don't use `APP_INITIALIZER` for this. The kit's sample app and docs both init in `main.ts` and bootstrap inside `.then()` — that's the v5 canonical and avoids the DI-timing edge cases of an init factory provider. Always `.catch()` so a network/credential failure degrades gracefully instead of leaving a blank app.
|
|
79
|
-
|
|
80
|
-
---
|
|
81
|
-
|
|
82
|
-
## 2. Login + functional route guard
|
|
83
|
-
|
|
84
|
-
Init readies the SDK; **login** establishes the session. Guard chat routes with a functional `CanActivateFn` (the v17+ idiom — no class guard, no `Injectable`). This mirrors the sample app's `authGuard`:
|
|
85
|
-
|
|
86
|
-
```typescript
|
|
87
|
-
// src/app/guards/auth.guard.ts
|
|
88
|
-
import { CanActivateFn, Router } from "@angular/router";
|
|
89
|
-
import { inject } from "@angular/core";
|
|
90
|
-
import { CometChat } from "@cometchat/chat-sdk-javascript";
|
|
91
|
-
|
|
92
|
-
export const authGuard: CanActivateFn = async () => {
|
|
93
|
-
const router = inject(Router);
|
|
94
|
-
try {
|
|
95
|
-
const user = await CometChat.getLoggedinUser(); // async; note lowercase 'in'
|
|
96
|
-
if (user) return true;
|
|
97
|
-
return router.createUrlTree(["/login"]);
|
|
98
|
-
} catch {
|
|
99
|
-
return router.createUrlTree(["/login"]);
|
|
100
|
-
}
|
|
101
|
-
};
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
For dev convenience you can auto-login a seeded user instead of redirecting:
|
|
105
|
-
|
|
106
|
-
```typescript
|
|
107
|
-
import { CometChatUIKit } from "@cometchat/chat-uikit-angular";
|
|
108
|
-
// …inside the guard, when no user is found:
|
|
109
|
-
try {
|
|
110
|
-
await CometChatUIKit.login("cometchat-uid-1"); // bare UID string in v5 — NOT login({ uid })
|
|
111
|
-
return true;
|
|
112
|
-
} catch {
|
|
113
|
-
return router.createUrlTree(["/login"]);
|
|
114
|
-
}
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
Two real session-check APIs exist; pick by context:
|
|
118
|
-
- `CometChat.getLoggedinUser()` / `CometChatUIKit.getLoggedinUser()` — **async** (returns `Promise<User | null>`, lowercase `in`). Use in guards/async flows. This is what the sample app guards use.
|
|
119
|
-
- `CometChatUIKit.getLoggedInUser()` — **sync** (returns `User | null`, capital `I`). Use inside components for a synchronous read after the session is known to exist.
|
|
120
|
-
|
|
121
|
-
```typescript
|
|
122
|
-
// src/app/app.routes.ts
|
|
123
|
-
import { Routes } from "@angular/router";
|
|
124
|
-
import { authGuard } from "./guards/auth.guard";
|
|
125
|
-
|
|
126
|
-
export const routes: Routes = [
|
|
127
|
-
{
|
|
128
|
-
path: "chat",
|
|
129
|
-
canActivate: [authGuard],
|
|
130
|
-
// Lazy-load a standalone component — no NgModule, no loadChildren:
|
|
131
|
-
loadComponent: () => import("./chat/chat.component").then((m) => m.ChatComponent),
|
|
132
|
-
},
|
|
133
|
-
{ path: "", redirectTo: "chat", pathMatch: "full" },
|
|
134
|
-
];
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
---
|
|
138
|
-
|
|
139
|
-
## 3. Lazy-loaded standalone chat route
|
|
140
|
-
|
|
141
|
-
The chat surface is a standalone component that imports only the CometChat components it renders.
|
|
142
|
-
|
|
143
|
-
```typescript
|
|
144
|
-
// chat/chat.component.ts
|
|
145
|
-
import { Component } from "@angular/core";
|
|
146
|
-
import {
|
|
147
|
-
CometChatConversationsComponent,
|
|
148
|
-
CometChatMessageHeaderComponent,
|
|
149
|
-
CometChatMessageListComponent,
|
|
150
|
-
CometChatMessageComposerComponent,
|
|
151
|
-
} from "@cometchat/chat-uikit-angular";
|
|
152
|
-
import { CometChat } from "@cometchat/chat-sdk-javascript";
|
|
153
|
-
|
|
154
|
-
@Component({
|
|
155
|
-
selector: "app-chat",
|
|
156
|
-
standalone: true,
|
|
157
|
-
imports: [
|
|
158
|
-
CometChatConversationsComponent,
|
|
159
|
-
CometChatMessageHeaderComponent,
|
|
160
|
-
CometChatMessageListComponent,
|
|
161
|
-
CometChatMessageComposerComponent,
|
|
162
|
-
],
|
|
163
|
-
templateUrl: "./chat.component.html",
|
|
164
|
-
})
|
|
165
|
-
export class ChatComponent {
|
|
166
|
-
selectedUser?: CometChat.User;
|
|
167
|
-
|
|
168
|
-
onConversation(conversation: CometChat.Conversation) {
|
|
169
|
-
const entity = conversation.getConversationWith();
|
|
170
|
-
if (entity instanceof CometChat.User) this.selectedUser = entity;
|
|
171
|
-
}
|
|
172
|
-
}
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
`loadComponent` (not `loadChildren`) is the standalone way to lazy-load — there's no feature NgModule to point at.
|
|
176
|
-
|
|
177
|
-
---
|
|
178
|
-
|
|
179
|
-
## 4. NgZone — keep SDK callbacks inside Angular's zone
|
|
180
|
-
|
|
181
|
-
CometChat SDK callbacks (event listeners, Promise resolutions from non-Angular timers) can fire **outside** Angular's zone, so a view bound to the result won't update until the next tick. If a UI value set inside an SDK callback isn't refreshing, re-enter the zone:
|
|
182
|
-
|
|
183
|
-
```typescript
|
|
184
|
-
import { Component, NgZone } from "@angular/core";
|
|
185
|
-
import { CometChat } from "@cometchat/chat-sdk-javascript";
|
|
186
|
-
|
|
187
|
-
@Component({ /* … */ })
|
|
188
|
-
export class PresenceComponent {
|
|
189
|
-
status = "offline";
|
|
190
|
-
constructor(private zone: NgZone) {}
|
|
191
|
-
|
|
192
|
-
ngOnInit() {
|
|
193
|
-
CometChat.addUserListener("presence", new CometChat.UserListener({
|
|
194
|
-
onUserOnline: (user: CometChat.User) =>
|
|
195
|
-
this.zone.run(() => { this.status = "online"; }), // ← re-enter zone
|
|
196
|
-
onUserOffline: (user: CometChat.User) =>
|
|
197
|
-
this.zone.run(() => { this.status = "offline"; }),
|
|
198
|
-
}));
|
|
199
|
-
}
|
|
200
|
-
}
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
The kit's own `<cometchat-*>` components handle this internally — you only need `zone.run()` for **your own** code that mutates view state inside an SDK callback. Prefer the kit's `@Output`s where they exist (they're already zone-correct). Alternatively, consume `CometChatUIKit.loggedInUser$` (an RxJS observable) with the `async` pipe — observables integrate with change detection cleanly.
|
|
204
|
-
|
|
205
|
-
---
|
|
206
|
-
|
|
207
|
-
## 5. OnPush change detection
|
|
208
|
-
|
|
209
|
-
CometChat components are heavy; if your host component uses `ChangeDetectionStrategy.OnPush`, pass **immutable** references — reassign `selectedUser`/`selectedGroup` (a new object) rather than mutating, so OnPush detects the change. Binding the same mutated object won't trigger a re-render. (This mirrors the React "new reference per update" rule.)
|
|
210
|
-
|
|
211
|
-
---
|
|
212
|
-
|
|
213
|
-
## 6. SSR / Angular Universal
|
|
214
|
-
|
|
215
|
-
CometChat is a **browser-only** SDK (WebSocket + IndexedDB + `window`). It must not run during server-side rendering. The recommended setup is `ng new --ssr false` (per the docs) — but if your app already uses `@angular/ssr`, keep CometChat off the server.
|
|
216
|
-
|
|
217
|
-
- **Don't** call `CometChatUIKit.init()` / render `<cometchat-*>` on the server. Because init lives in `main.ts` (§1), gate it on the platform — `main.ts` runs in both the browser and server entry under SSR:
|
|
218
|
-
|
|
219
|
-
```typescript
|
|
220
|
-
// src/main.ts (SSR-safe)
|
|
221
|
-
import { isPlatformBrowser } from "@angular/common";
|
|
222
|
-
import { PLATFORM_ID } from "@angular/core";
|
|
223
|
-
|
|
224
|
-
// bootstrap once, unconditionally:
|
|
225
|
-
function boot() {
|
|
226
|
-
bootstrapApplication(AppComponent, appConfig).catch((err) => console.error(err));
|
|
227
|
-
}
|
|
228
|
-
|
|
229
|
-
if (typeof window === "undefined") {
|
|
230
|
-
boot(); // server render — skip CometChat init entirely
|
|
231
|
-
} else {
|
|
232
|
-
(CometChatUIKit.init(settings) ?? Promise.resolve()).then(boot).catch((e) => { console.error(e); boot(); });
|
|
233
|
-
}
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
(Inside Angular providers/components, use `isPlatformBrowser(inject(PLATFORM_ID))` for the same guard.)
|
|
237
|
-
- Lazy-load the chat route (`loadComponent`) so the kit's bundle never enters the server build's initial chunk.
|
|
238
|
-
- With `@angular/ssr`, render the chat route client-side only (it's behind the auth guard + browser check above).
|
|
239
|
-
|
|
240
|
-
---
|
|
241
|
-
|
|
242
|
-
## 7. Anti-patterns
|
|
243
|
-
|
|
244
|
-
1. **Don't use NgModule wiring** (`@NgModule`, `AppModule`, `declarations`, `forRoot`, `CUSTOM_ELEMENTS_SCHEMA`) — those are v4. v5 is standalone: `app.config.ts` providers + `imports: []` on standalone components.
|
|
245
|
-
2. **Don't put `CometChatUIKit.init()` in `APP_INITIALIZER`** — the v5 canonical inits in `main.ts` and bootstraps inside the resolved promise. `app.config.ts` carries providers only.
|
|
246
|
-
3. **Don't use a class `CanActivate` guard** when a functional `CanActivateFn` is cleaner (v17+). Match the standalone idiom — no `Injectable` guard class.
|
|
247
|
-
4. **Don't init on the server** — gate `main.ts` init on the platform (`typeof window`/`isPlatformBrowser`).
|
|
248
|
-
5. **Don't forget `zone.run()`** around view-state mutations inside raw SDK listener callbacks — or use `loggedInUser$` + `async` pipe.
|
|
249
|
-
6. **Don't `loadChildren` a chat NgModule** — there isn't one; `loadComponent` a standalone component.
|
|
250
|
-
7. **Don't call `login({ uid })`** — v5 takes a bare UID string (see `cometchat-angular-core`).
|
|
251
|
-
|
|
252
|
-
## Pointers
|
|
253
|
-
- `cometchat-angular-core` — init/login, standalone setup, env
|
|
254
|
-
- `cometchat-angular-components` — the component catalog
|
|
255
|
-
- `cometchat-angular-placement` — where to mount chat (route/modal/drawer)
|
|
256
|
-
- `cometchat-angular-production` — server-minted auth tokens
|