@cometchat/skills 3.1.0 → 4.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/README.md +35 -17
- package/bin/install.js +389 -43
- package/package.json +17 -8
- package/skills/cometchat/SKILL.md +653 -50
- package/skills/cometchat-android-v5/SKILL.md +120 -0
- package/skills/cometchat-android-v5-components/SKILL.md +430 -0
- package/skills/cometchat-android-v5-core/SKILL.md +468 -0
- package/skills/cometchat-android-v5-customization/SKILL.md +305 -0
- package/skills/cometchat-android-v5-extensions/SKILL.md +124 -0
- package/skills/cometchat-android-v5-features/SKILL.md +130 -0
- package/skills/cometchat-android-v5-placement/SKILL.md +276 -0
- package/skills/cometchat-android-v5-production/SKILL.md +94 -0
- package/skills/cometchat-android-v5-push/SKILL.md +620 -0
- package/skills/cometchat-android-v5-testing/SKILL.md +187 -0
- package/skills/cometchat-android-v5-theming/SKILL.md +166 -0
- package/skills/cometchat-android-v5-troubleshooting/SKILL.md +73 -0
- package/skills/cometchat-android-v6/SKILL.md +107 -0
- package/skills/cometchat-android-v6-builder-settings/SKILL.md +145 -0
- package/skills/cometchat-android-v6-compose-components/SKILL.md +202 -0
- package/skills/cometchat-android-v6-compose-customization/SKILL.md +280 -0
- package/skills/cometchat-android-v6-compose-placement/SKILL.md +213 -0
- package/skills/cometchat-android-v6-compose-theming/SKILL.md +224 -0
- package/skills/cometchat-android-v6-core/SKILL.md +354 -0
- package/skills/cometchat-android-v6-events/SKILL.md +212 -0
- package/skills/cometchat-android-v6-extensions/SKILL.md +191 -0
- package/skills/cometchat-android-v6-features/SKILL.md +130 -0
- package/skills/cometchat-android-v6-kotlin-components/SKILL.md +197 -0
- package/skills/cometchat-android-v6-kotlin-customization/SKILL.md +268 -0
- package/skills/cometchat-android-v6-kotlin-placement/SKILL.md +248 -0
- package/skills/cometchat-android-v6-kotlin-theming/SKILL.md +202 -0
- package/skills/cometchat-android-v6-production/SKILL.md +187 -0
- package/skills/cometchat-android-v6-push/SKILL.md +274 -0
- package/skills/cometchat-android-v6-testing/SKILL.md +279 -0
- package/skills/cometchat-android-v6-troubleshooting/SKILL.md +249 -0
- package/skills/cometchat-angular-components/SKILL.md +706 -0
- package/skills/cometchat-angular-core/SKILL.md +444 -0
- package/skills/cometchat-angular-customization/SKILL.md +424 -0
- package/skills/cometchat-angular-features/SKILL.md +447 -0
- package/skills/cometchat-angular-patterns/SKILL.md +447 -0
- package/skills/cometchat-angular-placement/SKILL.md +685 -0
- package/skills/cometchat-angular-production/SKILL.md +415 -0
- package/skills/cometchat-angular-theming/SKILL.md +365 -0
- package/skills/cometchat-angular-troubleshooting/SKILL.md +329 -0
- package/skills/cometchat-astro-patterns/SKILL.md +3 -3
- package/skills/cometchat-components/SKILL.md +2 -0
- package/skills/cometchat-core/SKILL.md +11 -6
- package/skills/cometchat-customization/references/component-catalog.md +1 -1
- package/skills/cometchat-features/SKILL.md +176 -108
- package/skills/cometchat-flutter-v5/SKILL.md +167 -0
- package/skills/cometchat-flutter-v5-calls/SKILL.md +192 -0
- package/skills/cometchat-flutter-v5-conversations/SKILL.md +117 -0
- package/skills/cometchat-flutter-v5-core/SKILL.md +221 -0
- package/skills/cometchat-flutter-v5-customization/SKILL.md +227 -0
- package/skills/cometchat-flutter-v5-events/SKILL.md +155 -0
- package/skills/cometchat-flutter-v5-messages/SKILL.md +258 -0
- package/skills/cometchat-flutter-v5-production/SKILL.md +207 -0
- package/skills/cometchat-flutter-v5-push/SKILL.md +284 -0
- package/skills/cometchat-flutter-v5-theming/SKILL.md +160 -0
- package/skills/cometchat-flutter-v5-troubleshooting/SKILL.md +129 -0
- package/skills/cometchat-flutter-v5-users-groups/SKILL.md +151 -0
- package/skills/cometchat-flutter-v6/SKILL.md +445 -0
- package/skills/cometchat-flutter-v6-calls/SKILL.md +333 -0
- package/skills/cometchat-flutter-v6-components/SKILL.md +365 -0
- package/skills/cometchat-flutter-v6-conversations/SKILL.md +210 -0
- package/skills/cometchat-flutter-v6-core/SKILL.md +305 -0
- package/skills/cometchat-flutter-v6-customization/SKILL.md +666 -0
- package/skills/cometchat-flutter-v6-events/SKILL.md +216 -0
- package/skills/cometchat-flutter-v6-features/SKILL.md +406 -0
- package/skills/cometchat-flutter-v6-messages/SKILL.md +333 -0
- package/skills/cometchat-flutter-v6-migration/SKILL.md +381 -0
- package/skills/cometchat-flutter-v6-placement/SKILL.md +398 -0
- package/skills/cometchat-flutter-v6-production/SKILL.md +632 -0
- package/skills/cometchat-flutter-v6-theming/SKILL.md +260 -0
- package/skills/cometchat-flutter-v6-troubleshooting/SKILL.md +726 -0
- package/skills/cometchat-flutter-v6-users-groups/SKILL.md +216 -0
- package/skills/cometchat-ios/SKILL.md +323 -0
- package/skills/cometchat-ios-components/SKILL.md +651 -0
- package/skills/cometchat-ios-core/SKILL.md +822 -0
- package/skills/cometchat-ios-customization/SKILL.md +825 -0
- package/skills/cometchat-ios-features/SKILL.md +725 -0
- package/skills/cometchat-ios-placement/SKILL.md +750 -0
- package/skills/cometchat-ios-production/SKILL.md +730 -0
- package/skills/cometchat-ios-push/SKILL.md +582 -0
- package/skills/cometchat-ios-theming/SKILL.md +631 -0
- package/skills/cometchat-ios-troubleshooting/SKILL.md +983 -0
- package/skills/cometchat-native-bare-patterns/SKILL.md +470 -0
- package/skills/cometchat-native-components/SKILL.md +594 -0
- package/skills/cometchat-native-core/SKILL.md +407 -0
- package/skills/cometchat-native-customization/SKILL.md +594 -0
- package/skills/cometchat-native-expo-patterns/SKILL.md +485 -0
- package/skills/cometchat-native-features/SKILL.md +608 -0
- package/skills/cometchat-native-placement/SKILL.md +500 -0
- package/skills/cometchat-native-production/SKILL.md +694 -0
- package/skills/cometchat-native-push/SKILL.md +593 -0
- package/skills/cometchat-native-testing/SKILL.md +583 -0
- package/skills/cometchat-native-theming/SKILL.md +656 -0
- package/skills/cometchat-native-troubleshooting/SKILL.md +433 -0
- package/skills/cometchat-nextjs-patterns/SKILL.md +5 -5
- package/skills/cometchat-react-router-patterns/SKILL.md +23 -21
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: cometchat
|
|
3
|
-
description: Entry-point for CometChat integration in any React project — web (React/Next.js/React Router/Astro)
|
|
3
|
+
description: Entry-point for CometChat integration in any React, React Native, Angular, Android, Flutter, or iOS project — web (React/Next.js/React Router/Astro), React Native (Expo/bare), Angular (12-15), native Android (V5 stable, V6 beta), Flutter (V5 stable, V6 beta), and native iOS (V5 stable). Detects the framework, gathers requirements through an interactive conversation, and writes production-quality integration code.
|
|
4
4
|
license: "MIT"
|
|
5
5
|
allowed-tools: "executeBash, readFile, fileSearch, listDirectory, AskUserQuestion"
|
|
6
6
|
metadata:
|
|
7
7
|
author: "CometChat"
|
|
8
8
|
version: "3.0.0"
|
|
9
|
-
tags: "cometchat dispatcher entry react nextjs react-router astro expo react-native chat"
|
|
9
|
+
tags: "cometchat dispatcher entry react nextjs react-router astro expo react-native angular android flutter ios chat"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
## Use this skill when
|
|
@@ -27,8 +27,12 @@ framework first and routes to the right ones.
|
|
|
27
27
|
|---|---|
|
|
28
28
|
| **Web** | React (Vite/CRA), Next.js, React Router v6/v7, Astro |
|
|
29
29
|
| **React Native** | Expo (managed + Expo Router), bare RN CLI |
|
|
30
|
+
| **Angular** | Angular 12-15 (Angular CLI / NgModule) |
|
|
31
|
+
| **Android** | V5 stable (Java + Kotlin Views) / V6 beta (Compose + Kotlin Views) |
|
|
32
|
+
| **Flutter** | V5 stable (GetX-based, `cometchat_chat_uikit:^5.2`) / V6 beta (Bloc-based, `cometchat_chat_uikit:^6.0.0-beta`) |
|
|
33
|
+
| **iOS** | V5 stable (Swift; SwiftUI + UIKit hosting; `CometChatUIKitSwift:~> 5.1`) |
|
|
30
34
|
|
|
31
|
-
The web family loads `@cometchat/chat-uikit-react` + `@cometchat/chat-sdk-javascript`. The RN family loads `@cometchat/chat-uikit-react-native` + `@cometchat/chat-sdk-react-native`. The dispatcher decides which set after Step 1's detection.
|
|
35
|
+
The web family loads `@cometchat/chat-uikit-react` + `@cometchat/chat-sdk-javascript`. The RN family loads `@cometchat/chat-uikit-react-native` + `@cometchat/chat-sdk-react-native`. The Angular family loads `@cometchat/chat-uikit-angular` + `@cometchat/chat-sdk-javascript`. The Android family loads `com.cometchat:chat-uikit-android:5.x` (V5) or `com.cometchat:chatuikit-{compose,kotlin}-android:6.x` (V6) from Maven Central. The Flutter family loads `cometchat_chat_uikit:^5.2` (V5; pair with `cometchat_calls_uikit:^5.0` for calls) or `cometchat_chat_uikit:^6.0.0-beta` (V6; calls fold into the same package) from the Cloudsmith Dart pub-hosted registry. The dispatcher decides which set after Step 1's detection.
|
|
32
36
|
|
|
33
37
|
## How v3 works
|
|
34
38
|
|
|
@@ -38,10 +42,10 @@ to understand their project, their use case, and exactly where chat
|
|
|
38
42
|
should go — THEN you write code that fits.
|
|
39
43
|
|
|
40
44
|
Pattern skills (loaded from your context, not via `Skill()`):
|
|
41
|
-
- `cometchat-core` (web) / `cometchat-native-core` (RN) — init, login, provider chain, env vars, anti-patterns
|
|
42
|
-
- `cometchat-components` (web) / `cometchat-native-components` (RN) — component catalog, props, composition
|
|
43
|
-
- `cometchat-placement` (web) / `cometchat-native-placement` (RN) — WHERE to put chat
|
|
44
|
-
- One per-framework skill (`cometchat-{react,nextjs,react-router,astro}-patterns
|
|
45
|
+
- `cometchat-core` (web) / `cometchat-native-core` (RN) / `cometchat-angular-core` (Angular) / `cometchat-android-{v5,v6}-core` (Android) / `cometchat-flutter-{v5,v6}-core` (Flutter) — init, login, provider chain, env vars, anti-patterns
|
|
46
|
+
- `cometchat-components` (web) / `cometchat-native-components` (RN) / `cometchat-angular-components` (Angular) / `cometchat-android-v5-components` or `cometchat-android-v6-{compose,kotlin}-components` (Android) / `cometchat-flutter-v6-components` (V6 only — V5 splits into `-conversations`/`-messages`/`-users-groups`) — component catalog, props, composition
|
|
47
|
+
- `cometchat-placement` (web) / `cometchat-native-placement` (RN) / `cometchat-angular-placement` (Angular) / `cometchat-android-v5-placement` or `cometchat-android-v6-{compose,kotlin}-placement` (Android) / `cometchat-flutter-v6-placement` (V6 only) — WHERE to put chat
|
|
48
|
+
- One per-framework skill (`cometchat-{react,nextjs,react-router,astro}-patterns`, `cometchat-native-{expo,bare}-patterns`, `cometchat-angular-patterns`, the v5/v6 Android sub-tree, or the Flutter v5/v6 sub-tree) — framework-specific details
|
|
45
49
|
|
|
46
50
|
**Key principle: ask, don't assume.** Every piece of information you need
|
|
47
51
|
from the user should be asked explicitly. Don't guess the route path,
|
|
@@ -66,7 +70,21 @@ If no config, run detection:
|
|
|
66
70
|
npx @cometchat/skills-cli detect --json
|
|
67
71
|
```
|
|
68
72
|
|
|
69
|
-
The JSON output includes `framework` (one of `reactjs`, `nextjs`, `react-router`, `astro`, `expo`, `react-native`, or `null`), framework-specific fields (`router`, `expo_mode`, `react_native_version`, `env_prefix`), and a `compatibility.supported` flag. If `supported` is `false`, stop and surface the warnings.
|
|
73
|
+
The JSON output includes `framework` (one of `reactjs`, `nextjs`, `react-router`, `astro`, `expo`, `react-native`, `angular`, `android`, `flutter`, `ios`, or `null`), framework-specific fields (`router`, `expo_mode`, `react_native_version`, `android_version`, `flutter_version`, `env_prefix`), and a `compatibility.supported` flag. If `supported` is `false`, stop and surface the warnings.
|
|
74
|
+
|
|
75
|
+
**Android — `android_version` is load-bearing.** When `framework === "android"`, the detect output includes `android_version: "v5" | "v6" | null`. The cohort selects which V5 or V6 pattern set to load — V5 (live, `chat-uikit-android:5.x`, Java + Kotlin Views) and V6 (beta, `chatuikit-{compose,kotlin}-android:6.x`) are different SDKs with different APIs. Treat them as separate routing targets even though both live under `--family android`.
|
|
76
|
+
|
|
77
|
+
If `android_version` is `null`, the project is greenfield (no cometchat dep yet). Ask the user via `AskUserQuestion`:
|
|
78
|
+
> "Which CometChat Android UI Kit do you want to use? V5 is the live SDK (recommended for production today). V6 is beta (Compose + Kotlin Views split, future-facing)."
|
|
79
|
+
|
|
80
|
+
Save the choice into `.cometchat/config.json` under `android_version` so subsequent `/cometchat` runs don't re-ask.
|
|
81
|
+
|
|
82
|
+
**Flutter — `flutter_version` is load-bearing too.** When `framework === "flutter"`, the detect output includes `flutter_version: "v5" | "v6" | null`. V5 is GetX-based (`cometchat_chat_uikit:^5.2`); V6 is Bloc-based (`cometchat_chat_uikit:^6.0.0-beta2`). The two cohorts have different state-management primitives, different barrel exports, and different theme APIs — never mix them. Same `--family flutter` install ships both sets; routing picks the right one.
|
|
83
|
+
|
|
84
|
+
If `flutter_version` is `null`, ask via `AskUserQuestion`:
|
|
85
|
+
> "Which CometChat Flutter UI Kit do you want to use? V5 is the live SDK (GetX-based, recommended for production today). V6 is beta (Bloc-based, future-facing)."
|
|
86
|
+
|
|
87
|
+
Save the choice into `.cometchat/config.json` under `flutter_version`.
|
|
70
88
|
|
|
71
89
|
**Then read the project yourself — this is critical.**
|
|
72
90
|
|
|
@@ -85,35 +103,120 @@ The JSON output includes `framework` (one of `reactjs`, `nextjs`, `react-router`
|
|
|
85
103
|
- Existing screens — list all files under `screens/`, `src/screens/`, `app/`, or wherever routes live
|
|
86
104
|
- Existing nav structure — read the root navigator to see stack vs tab vs drawer layout
|
|
87
105
|
|
|
106
|
+
**For Angular (`angular`):**
|
|
107
|
+
- `package.json` — name, `@angular/core` version (12-15 supported), all `@angular/*` deps
|
|
108
|
+
- `angular.json` — workspace config; identify the project name + `sourceRoot`
|
|
109
|
+
- Root NgModule — usually `src/app/app.module.ts`; check imports + declarations + `schemas`
|
|
110
|
+
- Routing — `src/app/app-routing.module.ts` or root `RouterModule.forRoot([...])`; list all routes
|
|
111
|
+
- Layout — `src/app/app.component.{ts,html}`; identify nav, sidebar, header components
|
|
112
|
+
- Existing pages/components — list under `src/app/pages/`, `src/app/components/`, or wherever the project organizes them
|
|
113
|
+
- Environment files — `src/environments/environment.ts` (and `.prod.ts`); credentials live here, NOT in `.env`
|
|
114
|
+
|
|
115
|
+
**For Android (`android`):**
|
|
116
|
+
- `settings.gradle` (or `.kts`) — module list; usually `:app` plus optional library modules
|
|
117
|
+
- Root `build.gradle` (or `.kts`) — top-level plugins, repositories, classpath versions
|
|
118
|
+
- App `build.gradle` (or `.kts`) — dependencies (this is where the cometchat dep lives), Android plugin, `applicationId`, `minSdk`/`targetSdk`/`compileSdk`, `buildConfigField` entries
|
|
119
|
+
- `AndroidManifest.xml` — root `<application>` class, permissions, `<activity>` entries, deep links
|
|
120
|
+
- Source dirs: `app/src/main/java/<pkg>/` (Java) and/or `app/src/main/kotlin/<pkg>/` (Kotlin)
|
|
121
|
+
- For V6 stack split: presence of `androidx.compose.ui:ui` or `compose.material3` in deps signals Compose; otherwise Kotlin Views (XML layouts under `app/src/main/res/layout/`). Many V6 projects have both — ask the user which surface chat lands in.
|
|
122
|
+
- `gradle.properties` and `local.properties` — credentials live here as `cometchat.appId=...` / `cometchat.region=...` / `cometchat.authKey=...`, exposed to code as `BuildConfig` fields via `buildConfigField` in the app `build.gradle`. NOT in `.env`.
|
|
123
|
+
- `Application` class (e.g. `MyApp extends android.app.Application`) — init goes in `onCreate()`. Note the class FQN; you'll wire `CometChatUIKit.init(this, settings, callback)` here.
|
|
124
|
+
|
|
125
|
+
**For Flutter (`flutter`):**
|
|
126
|
+
- `pubspec.yaml` — package name + Dart SDK constraint + Flutter SDK constraint + `dependencies:` (this is where `cometchat_chat_uikit` lives)
|
|
127
|
+
- For V5: a typical project has BOTH `cometchat_chat_uikit:^5.2` AND `cometchat_calls_uikit:^5.0` if calls are needed. V6 folds calls into the single `cometchat_chat_uikit:^6.0.0-beta2` package (no separate calls package).
|
|
128
|
+
- `lib/` — Dart source. The app entry is `lib/main.dart` (the `void main() => runApp(...)` site); init goes in `main()` or in a top-level `Stateful`/`State.initState()`.
|
|
129
|
+
- `lib/<config>.dart` (or similar) — credentials. There is NO Flutter `.env` convention — credentials are typically defined as `const` Dart values in a config file, OR injected at compile time via `--dart-define=COMETCHAT_APP_ID=...` flags read inside Dart with `String.fromEnvironment`. NOT a `.env` file at runtime.
|
|
130
|
+
- `android/app/build.gradle` and `ios/Runner/Info.plist` — platform-specific config (FCM service registration, Push capabilities, microphone/camera Info.plist entries for calls). Flutter projects DO have these subdirs but they're configured Flutter-side; do not run the native skill flows.
|
|
131
|
+
- For V5 vs V6: V5 uses **GetX** (`get` in deps); V6 uses **flutter_bloc** + `equatable`. Their controllers, observers, and theming are different — match the integration code to the detected cohort.
|
|
132
|
+
|
|
133
|
+
**For iOS (`ios`):**
|
|
134
|
+
- `<App>.xcodeproj` and/or `<App>.xcworkspace` — Xcode project / workspace. The `.xcworkspace` is preferred when CocoaPods is in use (open it, NOT the .xcodeproj).
|
|
135
|
+
- `Podfile` (CocoaPods) — pin `pod 'CometChatUIKitSwift', '~> 5.1'` and run `pod install`. Look for `platform :ios, '13.0'` (or higher) — V5 needs iOS 13+.
|
|
136
|
+
- `Package.swift` (Swift Package Manager) — `dependencies:` block adds `https://github.com/cometchat/cometchat-uikit-ios`. Both SPM and CocoaPods are supported; check which the project uses.
|
|
137
|
+
- App entry — `<App>App.swift` (SwiftUI) or `AppDelegate.swift` + `SceneDelegate.swift` (UIKit). Init goes in `@main struct App.init()` (SwiftUI) or `application(_:didFinishLaunchingWithOptions:)` (UIKit).
|
|
138
|
+
- `Info.plist` — for calls add `NSMicrophoneUsageDescription` + `NSCameraUsageDescription`; for push add the APNs entitlement and a `BackgroundModes` entry with `remote-notification` (and `voip` for VoIP push).
|
|
139
|
+
- Credentials: NO `.env` at runtime. Use a `Secrets.swift` const enum/struct (gitignored) or an `*.xcconfig` file with `COMETCHAT_APP_ID = ...` exposed as Build Settings. The skill teaches both.
|
|
140
|
+
- **Mixed-stack apps (SwiftUI + UIKit):** the kit ships UIKit `UIViewController`s and exposes them via `UIViewControllerRepresentable` for SwiftUI hosting. Identify which surface chat lands in (SwiftUI screen vs UIKit nav stack) and follow the matching pattern.
|
|
141
|
+
|
|
88
142
|
Store this mental map — you'll use it throughout the conversation.
|
|
89
143
|
|
|
90
144
|
**Compatibility baselines (the CLI enforces these):**
|
|
91
145
|
- Web: react@<18 → upgrade required; nextjs@<13 → warning; astro@<4 → warning
|
|
92
146
|
- RN: react-native@<0.70 → upgrade required; expo@<49 → upgrade required
|
|
147
|
+
- Angular: @angular/core@<12 → upgrade required; @angular/core@>=16 → warning (skill is verified against v15)
|
|
148
|
+
- Android V5: minSdk@<21 → upgrade required; minSdk@<24 → warning; AGP@<7.0 → warning
|
|
149
|
+
- Android V6: minSdk@<28 → upgrade required (V6 raised the floor from API 23 to API 28); Kotlin@<1.9 → warning; for Compose stack, Compose BOM@<2024.x → warning
|
|
150
|
+
- Flutter V5: Dart SDK <2.17 → upgrade required; Flutter <2.5 → warning; Android `minSdk 24` (Flutter platform default) when V5 is in use
|
|
151
|
+
- Flutter V6: Dart SDK <2.17 → upgrade required; Flutter <2.5 → warning; Android `minSdk 26` REQUIRED (cometchat_calls_sdk in V6 raised the floor)
|
|
152
|
+
- iOS V5: iOS deployment target <13 → upgrade required; Swift <5.0 → upgrade required; Xcode 15+ requires `ENABLE_USER_SCRIPT_SANDBOXING = NO` in Build Settings (or the `post_install` Podfile hook)
|
|
93
153
|
|
|
94
154
|
#### Pattern skills not installed?
|
|
95
155
|
|
|
96
|
-
The dispatcher routes to
|
|
156
|
+
The dispatcher routes to web pattern skills (`cometchat-{core,components,placement,*-patterns}`), RN pattern skills (`cometchat-native-{core,components,placement,*-patterns}`), or Angular pattern skills (`cometchat-angular-{core,components,placement,patterns}`) based on the detected framework. If the matching set isn't loaded — i.e. the user has only the dispatcher in `.claude/skills/`, OR they installed only `@cometchat/skills` (web) but the project is RN/Angular, OR vice versa — **install the missing package yourself**. Do NOT stop and ask the user to run the npx command manually — that turns a 0-step recovery into a 2-step recovery for no benefit.
|
|
157
|
+
|
|
158
|
+
To check whether the pattern skills are loaded, attempt to read `cometchat-core/SKILL.md` (web), `cometchat-native-core/SKILL.md` (RN), or `cometchat-angular-core/SKILL.md` (Angular) from your loaded skills context. If the read fails, the package isn't installed — run the installer.
|
|
97
159
|
|
|
98
160
|
**If `framework` is `expo` or `react-native` AND `cometchat-native-core` is NOT loaded:**
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
> ```
|
|
104
|
-
> then run `/cometchat` again."
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
npx @cometchat/skills-native add
|
|
164
|
+
```
|
|
105
165
|
|
|
106
166
|
**If `framework` is `reactjs`, `nextjs`, `react-router`, or `astro` AND `cometchat-core` is NOT loaded:**
|
|
107
|
-
> "This is a {framework} project, but the web pattern skills aren't
|
|
108
|
-
> installed in this workspace. Install them with:
|
|
109
|
-
> ```
|
|
110
|
-
> npx @cometchat/skills add
|
|
111
|
-
> ```
|
|
112
|
-
> then run `/cometchat` again."
|
|
113
167
|
|
|
114
|
-
|
|
168
|
+
```bash
|
|
169
|
+
npx @cometchat/skills add
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
**If `framework` is `angular` AND `cometchat-angular-core` is NOT loaded:**
|
|
173
|
+
|
|
174
|
+
```bash
|
|
175
|
+
npx @cometchat/skills add --family angular
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
**If `framework` is `android` AND neither `cometchat-android-v5-core` nor `cometchat-android-v6-core` is loaded:**
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
npx @cometchat/skills add --family android
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
This installs both V5 and V6 skill sets — the dispatcher's Step 4 routing picks the correct one based on `android_version`.
|
|
185
|
+
|
|
186
|
+
**If `framework` is `flutter` AND neither `cometchat-flutter-v5-core` nor `cometchat-flutter-v6-core` is loaded:**
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
npx @cometchat/skills add --family flutter
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
Same shape as Android — installs both V5 and V6 skill sets; routing picks the right one based on `flutter_version`.
|
|
193
|
+
|
|
194
|
+
**If `framework` is `ios` AND `cometchat-ios-core` is NOT loaded:**
|
|
195
|
+
|
|
196
|
+
```bash
|
|
197
|
+
npx @cometchat/skills add --family ios
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
iOS only ships V5 today (no V6 beta yet), so there's no version-detection step — the install command lands the single iOS skill set.
|
|
201
|
+
|
|
202
|
+
After the install completes, tell the user:
|
|
115
203
|
|
|
116
|
-
|
|
204
|
+
> "I just installed the {family} pattern skills into your workspace. Please re-run `/cometchat` to continue — your config is saved in `.cometchat/config.json` and credentials in `.env`, so the next run picks up at code generation without re-asking the questions you've already answered."
|
|
205
|
+
|
|
206
|
+
**Why re-run rather than continue in this session:** Claude Code (and most coding agents) snapshot the skill set at session start and do NOT hot-reload SKILL.md mid-session. Even though the install writes the new skill files into `.claude/skills/`, your in-context skill set is the snapshot. Continuing would mean writing code from training memory — which the skills explicitly forbid (this is the same failure mode that produced the `UIKitSettingsBuilder` and `getLoggedinUser` casing bugs at v2.2.0). The re-run is the only safe path.
|
|
207
|
+
|
|
208
|
+
**Non-default IDE — pass `--ide`.** The default installer target is `claude` (`.claude/skills/`). If the dispatcher's own SKILL.md was loaded from a different location, pass the matching flag:
|
|
209
|
+
|
|
210
|
+
| Dispatcher loaded from | Install command |
|
|
211
|
+
|---|---|
|
|
212
|
+
| `.claude/skills/cometchat/SKILL.md` (default) | `npx @cometchat/skills add` |
|
|
213
|
+
| `.agents/skills/cometchat/SKILL.md` (Replit / Cursor / Copilot / Cline / Codex) | `npx @cometchat/skills add --ide replit` |
|
|
214
|
+
| `.cursor/skills/cometchat/SKILL.md` (legacy Cursor path) | `npx @cometchat/skills add --ide cursor` |
|
|
215
|
+
| `.kiro/skills/cometchat/SKILL.md` | `npx @cometchat/skills add --ide kiro` |
|
|
216
|
+
|
|
217
|
+
You can usually infer the IDE from where the dispatcher itself was loaded. If uncertain, default to `claude`. (Same logic applies to `@cometchat/skills-native` for RN projects.)
|
|
218
|
+
|
|
219
|
+
Do NOT attempt to write web UI Kit code into an RN project (CSS imports + `<a href>` + `document.*` fail at runtime) or RN UI Kit code into a web project (`react-native-gesture-handler`, `@gorhom/bottom-sheet`, native bubble components have no browser equivalents). Likewise, never use the React UI Kit (`@cometchat/chat-uikit-react`) in an Angular project — it's a different package (`@cometchat/chat-uikit-angular`) with NgModule imports, kebab-case selectors, content-projection slots, and no React reconciler. And never mix V5 and V6 skill sets within Android or Flutter — the artifact coordinates, package names, state-management primitives (V5 GetX vs V6 Bloc on Flutter; V5 Java/Views vs V6 Compose+Kotlin on Android), and theme system differ; the skills target one cohort each.
|
|
117
220
|
|
|
118
221
|
### Step 2 — Set up credentials (onboarding)
|
|
119
222
|
|
|
@@ -129,7 +232,7 @@ Otherwise check:
|
|
|
129
232
|
npx @cometchat/skills-cli auth status --json
|
|
130
233
|
```
|
|
131
234
|
|
|
132
|
-
If `status` is `"logged-in"`, skip to **Step
|
|
235
|
+
If `status` is `"logged-in"`, skip to **Step 2b.5** (fetch dashboard profile).
|
|
133
236
|
|
|
134
237
|
If `status` is `"logged-out"`, ask:
|
|
135
238
|
|
|
@@ -167,7 +270,7 @@ Terminal error handling (surface verbatim, stop, do not retry silently):
|
|
|
167
270
|
- `NETWORK` — couldn't reach the auth host.
|
|
168
271
|
- `ALREADY_AUTHENTICATED` — this session was already consumed. Re-run `auth login` to mint a fresh session.
|
|
169
272
|
|
|
170
|
-
After success, verify via `auth status --json` and proceed to **Step
|
|
273
|
+
After success, verify via `auth status --json` and proceed to **Step 2b.5**.
|
|
171
274
|
|
|
172
275
|
#### Step 2b — Sign up (new account, browser flow)
|
|
173
276
|
|
|
@@ -179,7 +282,111 @@ Same polling flow as Step 2a, but the CLI opens the signup URL. The browser hand
|
|
|
179
282
|
|
|
180
283
|
No role / name / verification-code questions in the chat. The dashboard owns that flow now; skipping it keeps the user's password and verification code out of the transcript.
|
|
181
284
|
|
|
182
|
-
Error codes match Step 2a. After success, verify via `auth status --json` and proceed to **Step
|
|
285
|
+
Error codes match Step 2a. After success, verify via `auth status --json` and proceed to **Step 2b.5**.
|
|
286
|
+
|
|
287
|
+
#### Step 2b.5 — Fetch the user's dashboard profile
|
|
288
|
+
|
|
289
|
+
The dashboard's signup flow (`/auth/signup` → `/choose-role` → `/choose-intent`) collects the user's name, email, role, and product intent during browser onboarding — none of those values touch the CLI. Now that the bearer token is in the keychain, fetch them via `cometchat auth me` so the rest of this skill can:
|
|
290
|
+
|
|
291
|
+
- Greet the user by name in subsequent steps
|
|
292
|
+
- Skip the placement-intent question (Step 3a) when `meta.intent === "exploring"` (the user already told the dashboard they're just exploring)
|
|
293
|
+
- Tailor explanation depth by `meta.role` (frontend developer → UI examples; engineering manager → architecture trade-offs)
|
|
294
|
+
|
|
295
|
+
```bash
|
|
296
|
+
npx @cometchat/skills-cli auth me --json
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
Response shape:
|
|
300
|
+
```json
|
|
301
|
+
{
|
|
302
|
+
"status": "logged-in",
|
|
303
|
+
"email": "you@example.com",
|
|
304
|
+
"name": "Your Name",
|
|
305
|
+
"role": "frontend",
|
|
306
|
+
"other_role": null,
|
|
307
|
+
"intent": "building",
|
|
308
|
+
"last_app": {
|
|
309
|
+
"id": "27xxxxx",
|
|
310
|
+
"name": "my-marketplace-chat",
|
|
311
|
+
"region": "us",
|
|
312
|
+
"industry": "online_marketplaces",
|
|
313
|
+
"technology": "react",
|
|
314
|
+
"product": "support"
|
|
315
|
+
}
|
|
316
|
+
}
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
Field meanings (from the dashboard's signup screens — see `/Users/swapnil/Downloads/customer-dashboard-main/src/components/auth/Welcome/`):
|
|
320
|
+
|
|
321
|
+
- `role`: `"frontend"` / `"backend"` / `"fullstack_engineer"` / `"startup_founder"` / `"product_leader/manager"` / `"engineering_leader/manager"` / `"others"` (when `others`, `other_role` carries the freeform value)
|
|
322
|
+
- `intent`: `"building"` / `"evaluating"` / `"exploring"` (this is the **dashboard's** intent — distinct from Step 3a's `placement_intent` which asks about app archetype)
|
|
323
|
+
- `last_app`: most-recently-created app on the user's account (or `null` if they have none). The dashboard's `/create-app` and `/select-product` screens write `industry`, `technology`, `product` into the app's `metadata` — we surface them here so Step 2c can pre-fill region/industry instead of asking again.
|
|
324
|
+
|
|
325
|
+
**Store the response in working memory.** Reference these fields downstream:
|
|
326
|
+
|
|
327
|
+
- **Step 2c (new app):** if `last_app` is non-null, default `--region` and `--industry` to the values from `last_app` and only ask the user to confirm — do NOT re-prompt from scratch.
|
|
328
|
+
- **Step 3a:** if `meta.intent === "exploring"`, skip the placement-intent question and route straight to the "Just exploring" branch (one route/screen with `<CometChatConversations />` and `cometchat-uid-1` pre-logged-in).
|
|
329
|
+
- **Step 5 explanations:** if `meta.role === "frontend"`, lead with concrete component composition + CSS examples; if `meta.role === "engineering_leader/manager"`, lead with placement architecture trade-offs (where state lives, what gets cached, how routing fits the project's pattern).
|
|
330
|
+
- **Greeting:** if `meta.name` is non-null, greet by name in any user-facing message during the rest of the flow ("Got it, Swapnil — let's pick an app").
|
|
331
|
+
|
|
332
|
+
**Failure modes — each is non-blocking; degrade to the original generic flow:**
|
|
333
|
+
|
|
334
|
+
- `status: "logged-out"` → bearer expired between Step 2a/b and now (rare). Re-run `auth login` and retry.
|
|
335
|
+
- `status: "auth-required"` → 401 from server. Same fix.
|
|
336
|
+
- `status: "error"` → network or unexpected. Skip silently, proceed to Step 2b.6 (will ask role + intent there).
|
|
337
|
+
- `name` is `null` → no greeting (don't ask, the dashboard will collect it on next browser visit).
|
|
338
|
+
- `role` is `null` → **ask in Step 2b.6** (this is the case for accounts that signed up via `auth signup` from the CLI — they never saw the dashboard's `/choose-role` screen).
|
|
339
|
+
- `intent` is `null` → **ask in Step 2b.6**.
|
|
340
|
+
- `last_app` is `null` → ask region/industry normally in Step 2c.
|
|
341
|
+
|
|
342
|
+
After this step, proceed to **Step 2b.6**.
|
|
343
|
+
|
|
344
|
+
#### Step 2b.6 — Backfill role + intent if missing
|
|
345
|
+
|
|
346
|
+
The dashboard's `/choose-role` and `/choose-intent` screens collect two profile fields used to tailor the rest of the integration:
|
|
347
|
+
|
|
348
|
+
- `role` shapes the depth and angle of code explanations in Step 5
|
|
349
|
+
- `intent` decides whether Step 3a's placement question is needed (`exploring` short-circuits to a single screen)
|
|
350
|
+
|
|
351
|
+
If `auth me` returned non-null values for both, **skip this step entirely** and go to Step 2c — the dashboard already collected them, do not re-ask.
|
|
352
|
+
|
|
353
|
+
If either is `null` (typical for accounts created via `cometchat auth signup` rather than the dashboard browser flow), ask the user. The options below mirror the dashboard exactly so that anyone who later visits the dashboard sees consistent terminology.
|
|
354
|
+
|
|
355
|
+
**If `role === null`** — `AskUserQuestion`:
|
|
356
|
+
- **question:** "What's your role? (We'll tailor explanations to match.)"
|
|
357
|
+
- **header:** "Role"
|
|
358
|
+
- **multiSelect:** false
|
|
359
|
+
- **options** (label → store as `role` value):
|
|
360
|
+
|
|
361
|
+
| Label | `role` value |
|
|
362
|
+
|---|---|
|
|
363
|
+
| Frontend Developer | `frontend` |
|
|
364
|
+
| Backend Developer | `backend` |
|
|
365
|
+
| Fullstack Developer | `fullstack_engineer` |
|
|
366
|
+
| Founder | `startup_founder` |
|
|
367
|
+
| Product Manager | `product_leader/manager` |
|
|
368
|
+
| Engineering Manager | `engineering_leader/manager` |
|
|
369
|
+
| Other | `others` |
|
|
370
|
+
|
|
371
|
+
If the user picks **Other**, follow up with a free-form `AskUserQuestion` for `other_role` (single short text field; store the freeform value in `other_role`).
|
|
372
|
+
|
|
373
|
+
**If `intent === null`** — `AskUserQuestion`:
|
|
374
|
+
- **question:** "What brings you to CometChat?"
|
|
375
|
+
- **header:** "Intent"
|
|
376
|
+
- **multiSelect:** false
|
|
377
|
+
- **options** (use the dashboard's exact wording):
|
|
378
|
+
|
|
379
|
+
| Label | Description shown under the label | `intent` value |
|
|
380
|
+
|---|---|---|
|
|
381
|
+
| I'm building | Integrating chat into my app now. | `building` |
|
|
382
|
+
| I'm evaluating | Comparing options for my team. | `evaluating` |
|
|
383
|
+
| I'm exploring | Just looking around for now. | `exploring` |
|
|
384
|
+
|
|
385
|
+
**Store the answers in working memory under the same keys** (`role`, `other_role`, `intent`) as if they had come from `auth me`. Downstream steps (3a + 5) treat dashboard-supplied and CLI-collected values identically.
|
|
386
|
+
|
|
387
|
+
> **Note:** These answers are not yet persisted back to the dashboard `/me` endpoint — they only live for the current session. A follow-up will add a `cometchat auth me --update` mode that PATCHes them server-side so the next session won't re-ask. Until then, the user may be asked again in a fresh session.
|
|
388
|
+
|
|
389
|
+
After this step, proceed to **Step 2c**.
|
|
183
390
|
|
|
184
391
|
#### Step 2c — Pick or create an app
|
|
185
392
|
|
|
@@ -205,7 +412,7 @@ This creates/updates the env file with the correct prefix AND writes `.cometchat
|
|
|
205
412
|
|
|
206
413
|
**If no apps exist** (or user wants new), collect:
|
|
207
414
|
1. App name — suggest `<project-name>-chat` from package.json `name`
|
|
208
|
-
2. Region — `AskUserQuestion`:
|
|
415
|
+
2. Region — **if Step 2b.5 returned `last_app.region`**, default to that value and ask only `"Use the same region as your <last_app.name> app (<region>)? [Y/n]"`. Otherwise `AskUserQuestion`:
|
|
209
416
|
- **question:** "Which region for your CometChat app?"
|
|
210
417
|
- **header:** "Region"
|
|
211
418
|
- **options:** US (recommended), EU, India
|
|
@@ -216,7 +423,7 @@ This creates/updates the env file with the correct prefix AND writes `.cometchat
|
|
|
216
423
|
| US | `us` |
|
|
217
424
|
| EU | `eu` |
|
|
218
425
|
| India | `in` |
|
|
219
|
-
3. Industry — `AskUserQuestion`:
|
|
426
|
+
3. Industry — **if Step 2b.5 returned `last_app.industry`**, default to that value and ask only `"Same industry as your previous app (<industry>)? [Y/n]"`. Otherwise `AskUserQuestion`:
|
|
220
427
|
- **options:** SaaS / Business, Marketplace, Social / Community, Other (or finer-grained from the table below)
|
|
221
428
|
|
|
222
429
|
**Industry key mapping:**
|
|
@@ -258,6 +465,10 @@ Tell the user which env vars to set based on the detected framework:
|
|
|
258
465
|
| astro | `.env` | `PUBLIC_COMETCHAT_APP_ID`, `PUBLIC_COMETCHAT_REGION`, `PUBLIC_COMETCHAT_AUTH_KEY` |
|
|
259
466
|
| expo (managed + Expo Router) | `.env` | `EXPO_PUBLIC_COMETCHAT_APP_ID`, `EXPO_PUBLIC_COMETCHAT_REGION`, `EXPO_PUBLIC_COMETCHAT_AUTH_KEY` |
|
|
260
467
|
| react-native (bare CLI) | `.env` | `COMETCHAT_APP_ID`, `COMETCHAT_REGION`, `COMETCHAT_AUTH_KEY` (paired with `react-native-dotenv`) |
|
|
468
|
+
| angular | `src/environments/environment.ts` | `cometchat: { appId, region, authKey }` (TypeScript object — Angular does NOT use `.env`) |
|
|
469
|
+
| android | `local.properties` (gitignored) → `BuildConfig` | `cometchat.appId`, `cometchat.region`, `cometchat.authKey` in `local.properties`; expose to code via `buildConfigField "String", "COMETCHAT_APP_ID", "\"...\""` in `app/build.gradle`. Code reads `BuildConfig.COMETCHAT_APP_ID`. |
|
|
470
|
+
| flutter | `lib/cometchat_config.dart` (or `--dart-define` flags) | A `const` Dart class with `appId`, `region`, `authKey`. Add `lib/cometchat_config.dart` to `.gitignore` so the file isn't committed. For CI, use `--dart-define=COMETCHAT_APP_ID=...` and read via `String.fromEnvironment('COMETCHAT_APP_ID')` instead. Flutter does NOT load `.env` at runtime. |
|
|
471
|
+
| ios | `Secrets.swift` (gitignored) or `*.xcconfig` Build Settings | A const enum/struct in `Secrets.swift`: `enum Secrets { static let appId = "..."; static let region = "..."; static let authKey = "..." }`. Add `Secrets.swift` to `.gitignore`. For CI, define them in an `.xcconfig` file (`COMETCHAT_APP_ID = ...`) and read via `Bundle.main.object(forInfoDictionaryKey: "COMETCHAT_APP_ID")` after exposing them in `Info.plist`. iOS does NOT load `.env` at runtime. |
|
|
261
472
|
|
|
262
473
|
> "Grab your credentials from https://app.cometchat.com → Your App →
|
|
263
474
|
> API & Auth Keys. Create the env file above and tell me when done."
|
|
@@ -275,6 +486,99 @@ module.exports = {
|
|
|
275
486
|
```
|
|
276
487
|
Then `import { COMETCHAT_APP_ID, COMETCHAT_REGION, COMETCHAT_AUTH_KEY } from "@env";` in the provider.
|
|
277
488
|
|
|
489
|
+
**iOS — write to `Secrets.swift` or an `.xcconfig`, NOT `.env`.** iOS has no runtime `.env` lookup. The CLI's `provision setup --framework ios` writes a `.env` only as a credentials handoff. During Step 5, migrate values into one of:
|
|
490
|
+
|
|
491
|
+
1. **`Secrets.swift` const enum** (preferred for local dev):
|
|
492
|
+
```swift
|
|
493
|
+
// Secrets.swift (add to .gitignore)
|
|
494
|
+
enum Secrets {
|
|
495
|
+
static let cometchatAppID = "<APP_ID>"
|
|
496
|
+
static let cometchatRegion = "<REGION>"
|
|
497
|
+
static let cometchatAuthKey = "<AUTH_KEY>" // dev only
|
|
498
|
+
}
|
|
499
|
+
```
|
|
500
|
+
Use as: `UIKitSettings().set(appID: Secrets.cometchatAppID).set(region: Secrets.cometchatRegion).set(authKey: Secrets.cometchatAuthKey).build()`.
|
|
501
|
+
2. **`.xcconfig` Build Settings** (preferred for CI; secrets stay out of source files):
|
|
502
|
+
```
|
|
503
|
+
// Secrets.xcconfig (add to .gitignore; reference from project Build Settings)
|
|
504
|
+
COMETCHAT_APP_ID = <APP_ID>
|
|
505
|
+
COMETCHAT_REGION = <REGION>
|
|
506
|
+
COMETCHAT_AUTH_KEY = <AUTH_KEY>
|
|
507
|
+
```
|
|
508
|
+
Expose as Info.plist entries (`$(COMETCHAT_APP_ID)` etc.) and read via `Bundle.main.object(forInfoDictionaryKey: "COMETCHAT_APP_ID") as? String`.
|
|
509
|
+
|
|
510
|
+
Never read `.env` at runtime in iOS. The handoff `.env` exists only so the integration agent can find the values during initial setup.
|
|
511
|
+
|
|
512
|
+
**Flutter — write to a Dart const file, NOT `.env`.** Flutter has no runtime `.env` lookup. The CLI's `provision setup --framework flutter` writes a `.env` only as a credentials handoff. During Step 5, migrate values into one of:
|
|
513
|
+
|
|
514
|
+
1. **Dart const file** (preferred for local dev, simpler):
|
|
515
|
+
```dart
|
|
516
|
+
// lib/cometchat_config.dart (add to .gitignore)
|
|
517
|
+
class CometChatConfig {
|
|
518
|
+
static const String appId = '<APP_ID>';
|
|
519
|
+
static const String region = '<REGION>';
|
|
520
|
+
static const String authKey = '<AUTH_KEY>'; // dev only
|
|
521
|
+
}
|
|
522
|
+
```
|
|
523
|
+
Then in `main.dart`:
|
|
524
|
+
```dart
|
|
525
|
+
import 'cometchat_config.dart';
|
|
526
|
+
final settings = (UIKitSettingsBuilder()
|
|
527
|
+
..appId = CometChatConfig.appId
|
|
528
|
+
..region = CometChatConfig.region
|
|
529
|
+
..authKey = CometChatConfig.authKey
|
|
530
|
+
..subscriptionType = CometChatSubscriptionType.allUsers)
|
|
531
|
+
.build();
|
|
532
|
+
```
|
|
533
|
+
2. **`--dart-define` flags** (preferred for CI; secrets never hit the repo):
|
|
534
|
+
```dart
|
|
535
|
+
const appId = String.fromEnvironment('COMETCHAT_APP_ID');
|
|
536
|
+
const region = String.fromEnvironment('COMETCHAT_REGION');
|
|
537
|
+
const authKey = String.fromEnvironment('COMETCHAT_AUTH_KEY');
|
|
538
|
+
```
|
|
539
|
+
Run with `flutter run --dart-define=COMETCHAT_APP_ID=... --dart-define=COMETCHAT_REGION=... --dart-define=COMETCHAT_AUTH_KEY=...`.
|
|
540
|
+
|
|
541
|
+
Never read `.env` at runtime in Flutter. The handoff `.env` exists only so the integration agent can find the values during initial setup.
|
|
542
|
+
|
|
543
|
+
**Android — write to `local.properties` + expose via `BuildConfig`.** Android has no runtime `.env` lookup; credentials are injected at compile time as `BuildConfig` fields. The CLI's `provision setup --framework android` writes a `.env` as a credentials handoff — you (the agent) must during Step 5 mirror those values into:
|
|
544
|
+
|
|
545
|
+
1. `local.properties` (project root, gitignored):
|
|
546
|
+
```
|
|
547
|
+
cometchat.appId=<APP_ID>
|
|
548
|
+
cometchat.region=<REGION>
|
|
549
|
+
cometchat.authKey=<AUTH_KEY> # dev only — omit / use auth tokens in production
|
|
550
|
+
```
|
|
551
|
+
2. `app/build.gradle` (or `.kts`) — read those properties and surface them via `buildConfigField`:
|
|
552
|
+
```groovy
|
|
553
|
+
def localProps = new Properties()
|
|
554
|
+
def localPropsFile = rootProject.file('local.properties')
|
|
555
|
+
if (localPropsFile.exists()) localProps.load(new FileInputStream(localPropsFile))
|
|
556
|
+
|
|
557
|
+
android {
|
|
558
|
+
defaultConfig {
|
|
559
|
+
buildConfigField "String", "COMETCHAT_APP_ID", "\"${localProps['cometchat.appId'] ?: ''}\""
|
|
560
|
+
buildConfigField "String", "COMETCHAT_REGION", "\"${localProps['cometchat.region'] ?: ''}\""
|
|
561
|
+
buildConfigField "String", "COMETCHAT_AUTH_KEY", "\"${localProps['cometchat.authKey'] ?: ''}\""
|
|
562
|
+
}
|
|
563
|
+
buildFeatures { buildConfig true }
|
|
564
|
+
}
|
|
565
|
+
```
|
|
566
|
+
3. Application code reads `BuildConfig.COMETCHAT_APP_ID` etc. — never hardcoded strings, never read from `.env` at runtime.
|
|
567
|
+
|
|
568
|
+
**Angular — write to `src/environments/environment.ts`, NOT `.env`.** Angular bundles `environment.ts` into the build at compile time; there is no runtime `.env` lookup. Insert (or extend) the `cometchat` block:
|
|
569
|
+
```typescript
|
|
570
|
+
// src/environments/environment.ts
|
|
571
|
+
export const environment = {
|
|
572
|
+
production: false,
|
|
573
|
+
cometchat: {
|
|
574
|
+
appId: "<APP_ID>",
|
|
575
|
+
region: "<REGION>",
|
|
576
|
+
authKey: "<AUTH_KEY>", // dev only — omit from environment.prod.ts
|
|
577
|
+
},
|
|
578
|
+
};
|
|
579
|
+
```
|
|
580
|
+
Then `import { environment } from "../environments/environment";` and access `environment.cometchat.appId` in the init service. The CLI's `provision setup --framework angular` writes a `.env` as a credentials handoff — you (the agent) must migrate the values into `environment.ts` during Step 5. Never read `.env` from Angular runtime code.
|
|
581
|
+
|
|
278
582
|
After they confirm, verify:
|
|
279
583
|
```bash
|
|
280
584
|
npx @cometchat/skills-cli config init --json
|
|
@@ -292,6 +596,8 @@ This is the core of v3. A multi-step conversation that gathers everything you ne
|
|
|
292
596
|
|
|
293
597
|
If config has `intent` set, confirm it and move on.
|
|
294
598
|
|
|
599
|
+
**If `meta.intent === "exploring"` from Step 2b.5** (the user already told the dashboard during signup that they're just exploring), skip the rest of Step 3 entirely and route to the "Just exploring" branch — scaffold the minimal integration in Step 5 (one route/screen showing `<CometChatConversations />` with `cometchat-uid-1` pre-logged-in). Do not ask the placement-intent question; the user has already said "show me the simplest thing."
|
|
600
|
+
|
|
295
601
|
Otherwise, use `AskUserQuestion`:
|
|
296
602
|
- **question:** "What kind of app are you building?"
|
|
297
603
|
- **header:** "Your app"
|
|
@@ -529,6 +835,68 @@ Wait for explicit confirmation. If the user says no or wants changes, go back to
|
|
|
529
835
|
- `react-native` (bare CLI) → `cometchat-native-bare-patterns`
|
|
530
836
|
4. `cometchat-native-placement` — placement pattern (stack/tab/modal/bottom-sheet/embed)
|
|
531
837
|
|
|
838
|
+
**For Angular:**
|
|
839
|
+
1. `cometchat-angular-core` — init via `UIKitSettingsBuilder`, `APP_INITIALIZER` pattern, `CUSTOM_ELEMENTS_SCHEMA`, env config in `environment.ts`, login order, anti-patterns
|
|
840
|
+
2. `cometchat-angular-components` — component catalog (kebab-case selectors, `[input]` callbacks vs `(output)` events, content-projection slots, NgModule imports)
|
|
841
|
+
3. `angular` → `cometchat-angular-patterns` — module organization, lazy-loading the chat module, environment file editing, providers
|
|
842
|
+
4. `cometchat-angular-placement` — placement pattern (route, modal, drawer, embedded panel)
|
|
843
|
+
|
|
844
|
+
**For Android — branches by `android_version`:**
|
|
845
|
+
|
|
846
|
+
If `android_version === "v5"`:
|
|
847
|
+
1. `cometchat-android-v5-core` — Gradle deps, `UIKitSettings.UIKitSettingsBuilder`, `CometChatUIKit.init()` in `Application.onCreate()`, login, theme requirements (`CometChatTheme.DayNight` → Material 2 parent)
|
|
848
|
+
2. `cometchat-android-v5-components` — View classes (`CometChatConversations`, `CometChatMessageList`, `CometChatMessageComposer`, …), `setUser`/`setGroup`, listener setters (`setOnItemClick`, `setOnSendButtonClick`), thread-mode rule (`setParentMessage(long)` on list, `setParentMessageId(long)` on composer)
|
|
849
|
+
3. `cometchat-android-v5-placement` — Activity, Fragment, BottomSheet placement, navigation
|
|
850
|
+
4. `cometchat-android-v5-customization` — `CometChatTextFormatter`, message templates, `CometChatMessageEvents.addListener`, DataSource decorators
|
|
851
|
+
5. `cometchat-android-v5-extensions` — registrar (`PollsExtension`, `StickerExtension`, `SmartRepliesExtension` extending `ExtensionsDataSource`) vs decorator pattern; never construct decorators directly
|
|
852
|
+
|
|
853
|
+
If `android_version === "v6"`, additionally branch by UI stack (Compose vs Kotlin Views — ask the user if both are present):
|
|
854
|
+
1. `cometchat-android-v6-core` — Gradle deps for `chatuikit-{compose,kotlin}-android:6.x` + `chatuikit-core`, init, login, message sending
|
|
855
|
+
2. `cometchat-android-v6-events` — `CometChatEvents` SharedFlows + sealed event classes
|
|
856
|
+
3. **Compose stack** → `cometchat-android-v6-compose-{components,placement,theming,customization}` — Composables, `CometChatTheme { ... }`, `BubbleFactory`, slot lambdas
|
|
857
|
+
4. **Kotlin Views stack** → `cometchat-android-v6-kotlin-{components,placement,theming,customization}` — custom View classes, `setOnItemClick`, `BubbleFactory` abstract class, `setBubbleFactories`
|
|
858
|
+
5. `cometchat-android-v6-builder-settings` — `UIKitSettingsBuilder` knobs (calling, presence, etc.)
|
|
859
|
+
|
|
860
|
+
Both V5 and V6 share `cometchat-android-{v5,v6}-{features,extensions,push,production,testing,troubleshooting}` for cross-cutting concerns.
|
|
861
|
+
|
|
862
|
+
**For Flutter — branches by `flutter_version`:**
|
|
863
|
+
|
|
864
|
+
If `flutter_version === "v5"`:
|
|
865
|
+
1. `cometchat-flutter-v5-core` — pubspec deps, `UIKitSettings.UIKitSettingsBuilder`, `CometChatUIKit.init()`, login, GetX-based controller pattern, `subscriptionType` requirement, theme caching rule, listener lifecycle
|
|
866
|
+
2. `cometchat-flutter-v5-conversations` / `-messages` / `-users-groups` / `-calls` — widget-by-widget catalog (V5 splits its component catalog across these four skills)
|
|
867
|
+
3. `cometchat-flutter-v5-theming` — `CometChatThemeHelper`, `CometChatColorPalette`, `CometChatSpacing`, `CometChatTypography`, dark mode
|
|
868
|
+
4. `cometchat-flutter-v5-customization` — `DataSource`, `DataSourceDecorator`, `CometChatMessageTemplate`, `CometChatTextFormatter`, slot views
|
|
869
|
+
5. `cometchat-flutter-v5-events` — `CometChatMessageEvents.addListener`, `CometChatGroupEvents`, `CometChatUserEvents`, `CometChatCallEvents`, `CometChatUIEvents`
|
|
870
|
+
6. `cometchat-flutter-v5-push` — FCM/APNs/VoIP setup; `CometChatNotifications.registerPushToken()` is the public surface (sample-app `PNRegistry` is a wrapper users copy)
|
|
871
|
+
7. `cometchat-flutter-v5-production` — server-minted auth tokens, ProGuard, release builds
|
|
872
|
+
8. `cometchat-flutter-v5-troubleshooting` — pubspec resolution, GetX errors, runtime crashes
|
|
873
|
+
|
|
874
|
+
If `flutter_version === "v6"`:
|
|
875
|
+
1. `cometchat-flutter-v6-core` — pubspec deps (single `cometchat_chat_uikit:^6.0.0-beta2` package), `UIKitSettingsBuilder`, init, login, message sending. The `enableCalls`/`CallingConfiguration()` knobs live in `cometchat-flutter-v6-calls`.
|
|
876
|
+
2. `cometchat-flutter-v6-components` — full Bloc-driven widget catalog
|
|
877
|
+
3. `cometchat-flutter-v6-conversations` / `-messages` / `-users-groups` / `-calls` — per-widget deep dives
|
|
878
|
+
4. `cometchat-flutter-v6-features` — feature catalog
|
|
879
|
+
5. `cometchat-flutter-v6-placement` — route, modal sheet, embedded widget — where chat lives in the app
|
|
880
|
+
6. `cometchat-flutter-v6-theming` — `CometChatThemeHelper`, `CometChatColorPalette` (V6 names), `CometChatThemeMode`
|
|
881
|
+
7. `cometchat-flutter-v6-customization` — `BubbleFactory<T>`, `CometChatMessageTemplate`, text formatters, slot widgets
|
|
882
|
+
8. `cometchat-flutter-v6-events` — Bloc-based event streams, listener registration
|
|
883
|
+
9. `cometchat-flutter-v6-production` — server-minted auth tokens, ProGuard
|
|
884
|
+
10. `cometchat-flutter-v6-troubleshooting` — pubspec, Bloc, theme cache
|
|
885
|
+
|
|
886
|
+
For projects migrating from V5 to V6, ALSO load `cometchat-flutter-v6-migration` — V5→V6 breaking changes (GetX → Bloc, theme API rewrite, `BuilderSettings` removal, callMain entry-point removal).
|
|
887
|
+
|
|
888
|
+
**For iOS — single cohort (V5 only today):**
|
|
889
|
+
|
|
890
|
+
1. `cometchat-ios-core` — Installation (CocoaPods + SPM), `UIKitSettings`, `CometChatUIKit(uiKitSettings:)` constructor init, login (`.success` / `.onError` switch — NOT Swift's standard `Result.failure`), AppDelegate vs SwiftUI App-struct init sites, anti-patterns
|
|
891
|
+
2. `cometchat-ios-components` — Component catalog: `CometChatConversations`, `CometChatUsers`, `CometChatGroups`, `CometChatGroupMembers`, `CometChatMessageHeader/List/Composer`, `CometChatIncomingCall/OutgoingCall/OngoingCall/CallButtons/CallLogs`, `CometChatSearch`, `CometChatReactionList`, `CometChatThreadedMessageHeader`. Build a `MessagesVC` by composing header + list + composer (the kit does NOT ship a pre-built `CometChatMessages` UIViewController).
|
|
892
|
+
3. `cometchat-ios-placement` — Navigation controller, modal, tab bar, embedded view — where chat lives. Mixed SwiftUI + UIKit hosting via `UIViewControllerRepresentable`.
|
|
893
|
+
4. `cometchat-ios-customization` — Custom message templates, text formatters, DataSource/Decorator pattern, custom views.
|
|
894
|
+
5. `cometchat-ios-theming` — `CometChatTheme` color tokens, `CometChatTypography.setFont(name:)`, dark mode.
|
|
895
|
+
6. `cometchat-ios-features` — Feature catalog: calls, polls, reactions, AI, extensions.
|
|
896
|
+
7. `cometchat-ios-production` — Server-minted auth tokens, user management.
|
|
897
|
+
8. `cometchat-ios-push` — APNs + VoIP, CallKit integration, token lifecycle.
|
|
898
|
+
9. `cometchat-ios-troubleshooting` — SPM/CocoaPods errors, Xcode build issues, Info.plist gotchas, runtime crashes.
|
|
899
|
+
|
|
532
900
|
### Step 5 — Write the integration
|
|
533
901
|
|
|
534
902
|
Execute the confirmed plan. The order of operations is the same for every framework, but the file names + provider shape differ.
|
|
@@ -591,11 +959,63 @@ Execute the confirmed plan. The order of operations is the same for every framew
|
|
|
591
959
|
9. **Native config (bare RN only):**
|
|
592
960
|
- `ios/<Name>/Info.plist` — add `NSCameraUsageDescription`, `NSPhotoLibraryUsageDescription`, `NSMicrophoneUsageDescription`
|
|
593
961
|
- `android/app/src/main/AndroidManifest.xml` — add `CAMERA`, `RECORD_AUDIO`, `READ_MEDIA_IMAGES`, `READ_EXTERNAL_STORAGE` permissions
|
|
594
|
-
- `ios/<Name>/PrivacyInfo.xcprivacy` — add the
|
|
962
|
+
- `ios/<Name>/PrivacyInfo.xcprivacy` — add the 3 required API codes (C617.1, CA92.1, 35F9.1) — matching the kit's own SampleApp manifest. Add `E174.1` (DiskSpace) only if your app does explicit free-space checks. See `cometchat-native-bare-patterns`.
|
|
595
963
|
- `android/build.gradle` — async-storage Maven repo if v3+
|
|
596
964
|
|
|
597
965
|
**Expo managed** — all of this goes in `app.json` under `plugins` and `ios.infoPlist` / `android.permissions`. See `cometchat-native-expo-patterns`.
|
|
598
966
|
|
|
967
|
+
**iOS — common steps:**
|
|
968
|
+
|
|
969
|
+
1. **Migrate credentials to `Secrets.swift` or an `.xcconfig`** — if `provision setup` wrote a `.env` (iOS handoff), do the migration documented in Step 2d above. Confirm the secrets file is in `.gitignore`.
|
|
970
|
+
2. **Add the kit dep:**
|
|
971
|
+
- **CocoaPods:** add `pod 'CometChatUIKitSwift', '~> 5.1'` to `Podfile` → `pod install`. Open the `.xcworkspace` (NOT `.xcodeproj`). For Xcode 15+, set `ENABLE_USER_SCRIPT_SANDBOXING = NO` in Build Settings (or add the `post_install` Podfile hook that does this for every pod target).
|
|
972
|
+
- **SPM:** in Xcode → File → Add Package Dependencies → `https://github.com/cometchat/cometchat-uikit-ios` (latest 5.x). Or add the package URL to your `Package.swift` if you're an SPM-only app.
|
|
973
|
+
3. **Init in your app entry point** — UIKit: in `AppDelegate.application(_:didFinishLaunchingWithOptions:)`. SwiftUI: in `@main struct App.init()`. The init takes a `UIKitSettings` and a `Result<Bool, Error>` completion: `CometChatUIKit(uiKitSettings: settings) { result in switch result { case .success: ... case .failure(let error): ... } }`. The explicit `.init(...)` form (`CometChatUIKit.init(uiKitSettings: ...) { ... }`) compiles identically in Swift and is what the kit's sample apps use — both are fine. **Note that this completion uses Swift's standard `Result.failure`, NOT the kit's `.onError` enum which only appears in login/logout callbacks (see step 4).**
|
|
974
|
+
4. **Login order** — `CometChatUIKit.login(uid:)` (dev) or `.login(authToken:)` (production). The login callback uses `.success` / `.onError` cases (NOT Swift's standard `Result.failure`).
|
|
975
|
+
5. **Place chat in your app** — for UIKit nav stacks, push your composed `MessagesVC` (header + list + composer). For SwiftUI, wrap each kit `UIViewController` in a `UIViewControllerRepresentable`. The kit does NOT ship a pre-built `CometChatMessages` or `CometChatConversationsWithMessages` — compose your own.
|
|
976
|
+
6. **Info.plist permissions** — for calls add `NSMicrophoneUsageDescription` + `NSCameraUsageDescription`. For push add the APNs entitlement + a `BackgroundModes` entry (`remote-notification`, plus `voip` for VoIP push).
|
|
977
|
+
7. **Verify** — `xcodebuild -workspace <App>.xcworkspace -scheme <App> -configuration Debug build` (CocoaPods) or `-project <App>.xcodeproj -scheme <App> ...` (SPM). Skip `xcodebuild test` and `xcodebuild run-app` — those need a simulator and longer compile time than CI usually permits.
|
|
978
|
+
|
|
979
|
+
**Flutter — common steps:**
|
|
980
|
+
|
|
981
|
+
1. **Migrate credentials to a Dart const file or `--dart-define`** — if `provision setup` wrote a `.env` (Flutter handoff), do the migration documented in Step 2d above. Confirm `lib/cometchat_config.dart` is in `.gitignore` if you go the const-file route.
|
|
982
|
+
2. **Add the cometchat dep** to `pubspec.yaml` and run `flutter pub get`:
|
|
983
|
+
- V5: `cometchat_chat_uikit: ^5.2.14` (and `cometchat_calls_uikit: ^5.0.15` if calls are needed). Both packages live on the Cloudsmith Dart pub registry, so you'll also need a `--hosted-url` flag in your CI scripts: `dart pub add cometchat_chat_uikit:^5.2.14 --hosted-url https://dart.cloudsmith.io/cometchat/cometchat/`.
|
|
984
|
+
- V6: `cometchat_chat_uikit: ^6.0.0-beta2` (single package — calls fold in).
|
|
985
|
+
3. **Imports — V5 has TWO barrels.** For chat-only V5 apps, only the chat barrel is needed: `import 'package:cometchat_chat_uikit/cometchat_chat_uikit.dart';`. For V5 + calls, ADD a second import: `import 'package:cometchat_calls_uikit/cometchat_calls_uikit.dart';` — the calls barrel does NOT re-export the chat barrel, so chat widgets aren't reachable through it alone. V6 has ONE barrel: `import 'package:cometchat_chat_uikit/cometchat_chat_uikit.dart';`.
|
|
986
|
+
4. **Init in `main.dart`** — `CometChatUIKit.init(uiKitSettings: settings, onSuccess: ..., onError: ...)`. V5 and V6 share the same init signature (callback-style); the difference is what comes after — V5 wires GetX controllers; V6 wires `BlocProvider`s. Always set `subscriptionType: CometChatSubscriptionType.allUsers` on the builder.
|
|
987
|
+
5. **Place chat in your app** — Flutter routing is in code (`Navigator.push`/`go_router`/etc.). Wire chat screens into your app's existing navigation. V6 has a dedicated placement skill for route/modal/embed patterns; V5 covers the same ground inside its per-widget skills.
|
|
988
|
+
6. **AndroidManifest + Info.plist** — for calls, add the platform permissions (microphone, camera, modify-audio-settings on Android; `NSMicrophoneUsageDescription` + `NSCameraUsageDescription` on iOS). For push, register the FCM service / configure APNs entitlements per `cometchat-flutter-{v5,v6}-push` (V5) or the troubleshooting skill (V6).
|
|
989
|
+
7. **Verify** — `flutter analyze` first (catches Dart compile + import errors), then `flutter build apk --debug` (Android) or `flutter build ios --debug --no-codesign` (iOS). The build catches dep-resolution / native-config issues.
|
|
990
|
+
|
|
991
|
+
**Android — common steps:**
|
|
992
|
+
|
|
993
|
+
1. **Migrate credentials to `local.properties` + `BuildConfig`** — if `provision setup` wrote a `.env` (Android handoff), do the migration documented in Step 2d above. Confirm `local.properties` is in `.gitignore` (it is by default in `ng new`-style scaffolds and Android Studio templates, but verify).
|
|
994
|
+
2. **Add the cometchat dep** to `app/build.gradle` (or `.kts`):
|
|
995
|
+
- V5: `implementation 'com.cometchat:chat-uikit-android:5.+'`
|
|
996
|
+
- V6 Compose: `implementation 'com.cometchat:chatuikit-compose-android:6.+'` (plus `compose-bom` if not already present)
|
|
997
|
+
- V6 Kotlin Views: `implementation 'com.cometchat:chatuikit-kotlin-android:6.+'`
|
|
998
|
+
- Both V6 stacks: add both `chatuikit-compose-android` AND `chatuikit-kotlin-android` (plus `chatuikit-core` if the kit splits it out)
|
|
999
|
+
3. **Theme parent (V5 only)** — `Application` theme must inherit from `CometChatTheme.DayNight` (which itself parents on `Theme.MaterialComponents.DayNight.NoActionBar`). Inheriting from `Theme.AppCompat.*` or `Theme.Material3.*` causes `UnsupportedOperationException` at inflate time. V6 doesn't share this requirement — Compose has its own `CometChatTheme { }` block; Kotlin Views uses style attrs.
|
|
1000
|
+
4. **Init in `Application.onCreate()`** — `CometChatUIKit.init(this, settings, callback)`. Wire `login(uid, callback)` inside the init success callback. `Application` class must be registered in `AndroidManifest.xml` via `<application android:name=".MyApp" …>`.
|
|
1001
|
+
5. **Place chat in your app** — V5: Activity / Fragment with the View classes (`CometChatConversations` etc.). V6 Compose: Composable screens via NavHost. V6 Kotlin Views: same Activity/Fragment shape as V5 but with V6 View classes.
|
|
1002
|
+
6. **AndroidManifest permissions** — `INTERNET` is mandatory; for calls add `RECORD_AUDIO`, `CAMERA`, `MODIFY_AUDIO_SETTINGS`, `BLUETOOTH_CONNECT` (API 31+).
|
|
1003
|
+
7. **ProGuard/R8** — for release builds, add `-keep class com.cometchat.** { *; }` to `proguard-rules.pro` to prevent stripping.
|
|
1004
|
+
8. **Verify** — `./gradlew :app:assembleDebug` (or `app:assembleDebug` from project root) catches Gradle/AGP/dependency issues; the kit's compile-time annotation processors surface schema errors here.
|
|
1005
|
+
|
|
1006
|
+
**Angular — common steps:**
|
|
1007
|
+
|
|
1008
|
+
1. **Migrate credentials into `environment.ts`** — if `provision setup` wrote a `.env` (Angular fallback), extend `src/environments/environment.ts` with a `cometchat: { appId, region, authKey }` block. Mirror in `environment.prod.ts` WITHOUT the `authKey` (production uses server-minted auth tokens — see `cometchat-angular-production`).
|
|
1009
|
+
2. **Add `CUSTOM_ELEMENTS_SCHEMA`** to the NgModule that hosts CometChat templates — kit atom components (`<cometchat-avatar>`, `<cometchat-status-indicator>`, etc.) are LitElement web components, not Angular standalone modules. Without the schema, Angular throws `Can't bind to '...' since it isn't a known property of 'cometchat-...'`.
|
|
1010
|
+
3. **Init service + APP_INITIALIZER** — follow `cometchat-angular-core` § 1-3. `UIKitSettingsBuilder().setAppId().setRegion().setAuthKey().build()`, then `CometChatUIKit.init(settings)` returns a Promise — chain login. Wire as `APP_INITIALIZER` so init completes before any component renders.
|
|
1011
|
+
4. **Import the right NgModule(s)** — for the chat-hosting module, add the kit modules from `@cometchat/chat-uikit-angular` (e.g. `CometChatConversations`, `CometChatMessages`) to `imports: []`. `cometchat-angular-components` documents the module name vs. component name pairing.
|
|
1012
|
+
5. **Wire chat into existing project** — READ each file before modifying. Add the route, nav link, modal trigger.
|
|
1013
|
+
6. **Theming** — inject `CometChatThemeService` to control palette/typography. See `cometchat-angular-theming`.
|
|
1014
|
+
7. **Install dependencies:**
|
|
1015
|
+
```bash
|
|
1016
|
+
npm install @cometchat/chat-uikit-angular @cometchat/chat-sdk-javascript
|
|
1017
|
+
```
|
|
1018
|
+
|
|
599
1019
|
#### Step 5 — common to ALL frameworks
|
|
600
1020
|
|
|
601
1021
|
After the framework-specific work above, every integration ends the same way:
|
|
@@ -645,7 +1065,15 @@ Run a TypeScript check to verify the code compiles:
|
|
|
645
1065
|
npx tsc --noEmit
|
|
646
1066
|
```
|
|
647
1067
|
|
|
648
|
-
**
|
|
1068
|
+
**Angular projects:** prefer `npx ng build --configuration development` (Angular's compiler validates templates, NgModule shape, and DI graph — `tsc` alone misses template type errors).
|
|
1069
|
+
|
|
1070
|
+
**Android projects:** run `./gradlew :app:assembleDebug` (or `gradlew.bat :app:assembleDebug` on Windows). The Gradle build catches dependency-resolution errors (wrong cometchat coords), Kotlin/Java compile errors (wrong method signatures), `BuildConfig` field errors (missing `buildConfigField` declarations), and AndroidManifest issues. Do NOT start an emulator or run the app — keep verification to the build step.
|
|
1071
|
+
|
|
1072
|
+
**Flutter projects:** run `flutter analyze` (catches Dart compile + null-safety + import errors), then `flutter build apk --debug` for Android-side verification (or `flutter build ios --debug --no-codesign` for iOS-side). Skip `flutter run` — it starts an emulator/device session that can't be observed from CI.
|
|
1073
|
+
|
|
1074
|
+
**iOS projects:** run `xcodebuild -workspace <App>.xcworkspace -scheme <App> -configuration Debug -destination 'generic/platform=iOS' build` (CocoaPods) or the `-project` variant (SPM). The build catches CocoaPods/SPM dep-resolution errors, Swift compile errors, missing `Info.plist` keys, and signing-config issues. Do NOT run `xcodebuild test` or boot a simulator.
|
|
1075
|
+
|
|
1076
|
+
**Do NOT run `npx @cometchat/skills-cli verify`** — it checks for CLI-generated `.cometchat/state.json` that's authored by `cometchat apply`, not by AI integration. Use `tsc` (or `ng build` / `./gradlew :app:assembleDebug` / `flutter analyze` / `xcodebuild build` for Angular / Android / Flutter / iOS) instead.
|
|
649
1077
|
|
|
650
1078
|
**RN extra: do not start Metro automatically** — let the user do that in their own terminal. Metro blocks the terminal and cannot be meaningfully observed from here.
|
|
651
1079
|
|
|
@@ -658,7 +1086,7 @@ Surface any common issues:
|
|
|
658
1086
|
**RN:**
|
|
659
1087
|
- `Cannot find module '@cometchat/chat-uikit-react-native'` → install didn't complete
|
|
660
1088
|
- `JSX element 'GestureHandlerRootView' has no corresponding closing tag` → wrapper chain partially applied
|
|
661
|
-
- `Property 'hideReplyInThreadOption' does not exist on type '...'` →
|
|
1089
|
+
- `Property 'hideReplyInThreadOption' does not exist on type '...'` → older UI Kit types installed; on RN make sure `@cometchat/chat-uikit-react-native@^5` is resolved (the prop exists from v5 onwards)
|
|
662
1090
|
|
|
663
1091
|
Then:
|
|
664
1092
|
|
|
@@ -669,11 +1097,12 @@ Then:
|
|
|
669
1097
|
> - Provider + CSS wired ✓
|
|
670
1098
|
> - Dependencies installed ✓
|
|
671
1099
|
>
|
|
672
|
-
> Run `npm run dev` and open the app:
|
|
1100
|
+
> Run `npm run dev` (or `ng serve` for Angular) and open the app:
|
|
673
1101
|
> - **Vite (reactjs)**: http://localhost:5173
|
|
674
1102
|
> - **Next.js**: http://localhost:3000/chat
|
|
675
1103
|
> - **React Router v7**: http://localhost:5173/chat
|
|
676
|
-
> - **Astro**: http://localhost:4321/chat
|
|
1104
|
+
> - **Astro**: http://localhost:4321/chat
|
|
1105
|
+
> - **Angular**: http://localhost:4200"
|
|
677
1106
|
|
|
678
1107
|
**RN result message:**
|
|
679
1108
|
> "CometChat is integrated! Here's what was set up:
|
|
@@ -694,28 +1123,30 @@ Then:
|
|
|
694
1123
|
> 1. `npm start -- --reset-cache`
|
|
695
1124
|
> 2. In another terminal: `npm run ios` or `npm run android`"
|
|
696
1125
|
|
|
697
|
-
**Common ending —
|
|
1126
|
+
**Common ending — what you'll see on first load (every framework):**
|
|
698
1127
|
|
|
699
1128
|
> ---
|
|
700
1129
|
>
|
|
701
|
-
> **
|
|
1130
|
+
> **Pre-seeded test data — chat works immediately, no dashboard setup needed:**
|
|
702
1131
|
>
|
|
703
|
-
> Every CometChat app ships with **5 pre-created test users
|
|
704
|
-
> `cometchat-uid-1` through `cometchat-uid-5
|
|
705
|
-
>
|
|
706
|
-
>
|
|
707
|
-
>
|
|
1132
|
+
> Every CometChat app ships with **5 pre-created test users**
|
|
1133
|
+
> (`cometchat-uid-1` through `cometchat-uid-5`), a **"Hello" test group**,
|
|
1134
|
+
> and **sample messages between them**. Your integration is logged in
|
|
1135
|
+
> as `cometchat-uid-1` by default, so on first load the conversation
|
|
1136
|
+
> list is already populated — you'll see existing 1:1 threads and the
|
|
1137
|
+
> test group with message history. Open any conversation and reply;
|
|
1138
|
+
> round-trip is ~50ms. Receipts, typing indicators, presence, and
|
|
1139
|
+
> reactions all work out of the box.
|
|
708
1140
|
>
|
|
709
|
-
> **
|
|
710
|
-
>
|
|
711
|
-
>
|
|
712
|
-
>
|
|
713
|
-
>
|
|
714
|
-
> 5. A conversation will appear — open it to see the message and reply
|
|
1141
|
+
> **Want to see real-time delivery between two users?** Open the
|
|
1142
|
+
> integration in two browser windows (or two simulators on RN), and
|
|
1143
|
+
> temporarily change the login UID in your provider — `cometchat-uid-2`
|
|
1144
|
+
> in one window, `cometchat-uid-1` in the other. Messages from one
|
|
1145
|
+
> arrive live in the other without refresh.
|
|
715
1146
|
>
|
|
716
|
-
> The
|
|
717
|
-
>
|
|
718
|
-
>
|
|
1147
|
+
> The dashboard at `https://app.cometchat.com` is useful later for
|
|
1148
|
+
> creating real users, configuring extensions, and viewing analytics
|
|
1149
|
+
> — but you don't need it to confirm the integration is working.
|
|
719
1150
|
>
|
|
720
1151
|
> What would you like to do next?"
|
|
721
1152
|
|
|
@@ -755,7 +1186,16 @@ Use `AskUserQuestion`. The option set differs by family — RN has two extra opt
|
|
|
755
1186
|
|
|
756
1187
|
For **theme customization**: read the framework-appropriate theming skill and write the customization code.
|
|
757
1188
|
|
|
758
|
-
For **adding features**: read the framework-appropriate features skill. Features fall into buckets
|
|
1189
|
+
For **adding features**: read the framework-appropriate features skill. Features fall into six buckets:
|
|
1190
|
+
|
|
1191
|
+
- **default** — already enabled by the UI Kit, no action needed.
|
|
1192
|
+
- **extension** — pure boolean toggle. Run `cometchat apply-feature <id>` (web/RN with `state.json`) or `cometchat apply-feature <id> --app-id <X>` (native cohorts: iOS / Android / Flutter / Angular). Hits the dashboard API; no browser visit required.
|
|
1193
|
+
- **ai-feature** — `smart-replies`, `conversation-summary`, `conversation-starter`. Run `cometchat apply-feature <id> --openai-key sk-...` (add `--app-id <X>` for native). The CLI sets the OpenAI key on the app's AI settings, then flips the toggle in one call.
|
|
1194
|
+
- **dashboard-only** — third-party API keys / multi-field config (Giphy, Stipop, Tenor, Chatwoot, Intercom, Disappearing Messages, Message Shortcuts). The CLI returns `manual-action-required` and prints the dashboard path — these genuinely need the user to configure third-party credentials.
|
|
1195
|
+
- **package-install** — calls. Run `npm install @cometchat/calls-sdk-javascript` (or the framework's calls SDK).
|
|
1196
|
+
- **component-swap** — `rich-text-formatting`. Run `cometchat apply-feature rich-text-formatting`.
|
|
1197
|
+
|
|
1198
|
+
Ask which feature, look it up in `packages/registry/v6/features/catalog.json` (or run `cometchat features info <id>`) to learn its bucket, then execute the right recipe. **Never tell the user to "open the dashboard and flip a toggle" for an extension or ai-feature** — that's what `cometchat apply-feature <id>` does for them.
|
|
759
1199
|
|
|
760
1200
|
For **component customization**: read the customization + components skills, then write the customization code directly. Ask the user what they want to customize, read the relevant component's props from the catalog, propose changes.
|
|
761
1201
|
|
|
@@ -806,6 +1246,61 @@ The iteration loop is the whole point of Phase B. Re-rendering the canonical men
|
|
|
806
1246
|
- **All four wrappers are required, in this order:** `GestureHandlerRootView → SafeAreaProvider → CometChatThemeProvider → CometChatProvider`. Omitting any of them breaks gestures, safe areas, theming, or login state — and it fails silently in dev.
|
|
807
1247
|
- **Login API is `CometChatUIKit.login({ uid })` or `CometChatUIKit.login({ authToken })`** — same method, different object key. There is no `loginWithAuthToken`. Passing a bare string like `login("cometchat-uid-1")` silently fails on RN.
|
|
808
1248
|
|
|
1249
|
+
### Angular only
|
|
1250
|
+
|
|
1251
|
+
- **`CUSTOM_ELEMENTS_SCHEMA` is required** in any NgModule that hosts CometChat components. Kit atom elements (`<cometchat-avatar>`, `<cometchat-status-indicator>`, `<cometchat-badge>`, etc.) are LitElement web components, not Angular standalone modules — without the schema Angular throws `Can't bind to '...'`. The schema goes in the module's `schemas: [CUSTOM_ELEMENTS_SCHEMA]` array, not in `imports`.
|
|
1252
|
+
- **Credentials live in `src/environments/environment.ts`, NOT `.env`.** Angular bundles `environment.ts` at compile time; there is no runtime `.env` lookup. The CLI's `provision setup --framework angular` writes a `.env` only as a credentials handoff — migrate the values into `environment.ts` (and `environment.prod.ts` minus the `authKey`) during integration.
|
|
1253
|
+
- **Init runs through `APP_INITIALIZER`, not a wrapper component.** Angular has no React-style provider tree — `CometChatUIKit.init(settings)` must complete before any chat component renders. Wire it as `{ provide: APP_INITIALIZER, useFactory, deps: [...], multi: true }` in the root module.
|
|
1254
|
+
- **Login API is `CometChatUIKit.login({ uid })` (object form), NOT a bare string.** Same shape as the React Native UI Kit. Calling `CometChatUIKit.login("cometchat-uid-1")` silently fails on Angular too — always pass the credentials object: `login({ uid })` for dev, `login({ authToken })` for production.
|
|
1255
|
+
- **Events are `[onX]` Input callbacks, not `(onX)` Output bindings.** The Angular UI Kit declares almost no `@Output` — events like `onSendButtonClick`, `onAccept`, `onItemClick` are `@Input()` callback functions. Writing `(onAccept)="handleAccept()"` silently no-ops or fails template type checking.
|
|
1256
|
+
- **`[messagesRequestBuilder]` is plural.** `[messageRequestBuilder]` (singular) on `<cometchat-message-list>` silently no-ops — the input doesn't exist.
|
|
1257
|
+
- **Match the kit's `auxilaryButtonView` typo** on `<cometchat-message-composer>` (missing first 'i'). The corrected spelling `auxiliaryButtonView` does not exist in the kit and silently no-ops.
|
|
1258
|
+
- **`CometChatThemeService` is the v4 theme entry point**, NOT the legacy v3 `CometChatTheme` class. Inject the service; access `themeService.theme` for palette/typography control.
|
|
1259
|
+
|
|
1260
|
+
### Android only
|
|
1261
|
+
|
|
1262
|
+
- **Never mix V5 and V6 artifacts.** `chat-uikit-android:5.x` and `chatuikit-{compose,kotlin}-android:6.x` are different SDKs with different package paths, theme systems, and APIs. The dispatcher routes by `android_version`; treat the cohort as a hard switch.
|
|
1263
|
+
- **V5 app theme must inherit from `CometChatTheme.DayNight`** — the kit itself parents on `Theme.MaterialComponents.DayNight.NoActionBar` (Material 2). Using `Theme.AppCompat.*` or `Theme.Material3.*` triggers `UnsupportedOperationException: Failed to resolve attribute` at inflate time. V6 has no equivalent rule — Compose uses `CometChatTheme { … }`, Kotlin Views uses kit-defined style attrs.
|
|
1264
|
+
- **Init in `Application.onCreate()`, not in an Activity.** `CometChatUIKit.init(context, settings, callback)` must complete before any chat View / Composable inflates. Wire `login(...)` inside the init success callback. The `<application android:name=".MyApp">` registration in `AndroidManifest.xml` is non-negotiable.
|
|
1265
|
+
- **Credentials live in `local.properties` + `BuildConfig`, NOT `.env`.** Android has no runtime `.env` lookup; surface secrets via `buildConfigField` and read `BuildConfig.COMETCHAT_APP_ID` etc. in code. The CLI's `provision setup --framework android` writes a `.env` only as a credentials handoff — migrate during integration.
|
|
1266
|
+
- **`INTERNET` permission is mandatory.** Without it, the SDK silently fails to connect — no error, no symptom except missing data.
|
|
1267
|
+
- **V5 thread-mode method asymmetry.** `CometChatMessageList` uses `setParentMessage(long)` (no `Id` suffix). `CometChatMessageComposer` uses `setParentMessageId(long)`. Different methods on different classes — the same value, two names. Never use `setParentMessageId` on the list.
|
|
1268
|
+
- **V5 extensions: registrar vs decorator.** `setExtensions(...)` accepts registrars (`PollsExtension`, `StickerExtension`, `SmartRepliesExtension` — extending `ExtensionsDataSource`). NEVER add `*ExtensionDecorator` instances directly — they extend `DataSourceDecorator` and won't compile in a `List<ExtensionsDataSource>`. The decorator chain is built by the registrar's `enable()` method internally.
|
|
1269
|
+
- **V6 Kotlin Views — `setOnItemClick`, NOT `setOnItemClickListener`.** The kit doesn't expose `*Listener`-suffixed setters; use the bare callback name. Same for other V6 setters — check the actual View class before guessing.
|
|
1270
|
+
- **V6 reaction list takes `baseMessage`, not `message`.** `CometChatReactionList(baseMessage = ...)` (Compose) or `reactionList.setBaseMessage(...)` (Kotlin Views). The bare `message` param/setter doesn't exist in V6.
|
|
1271
|
+
- **Push notifications: `CometChatNotifications.registerPushToken/unregisterPushToken` is the only public surface.** Sample-app helpers like `CometChatVoIP`, `FCMService`, `FCMMessageDTO` are NOT exported from `chatuikit-*` artifacts — they live in the master sample apps. Copy the pattern; don't import them as kit classes.
|
|
1272
|
+
- **R8/ProGuard rule for release.** Add `-keep class com.cometchat.** { *; }` to `proguard-rules.pro`. Without it, release builds strip kit classes and crash with `ClassNotFoundException`.
|
|
1273
|
+
|
|
1274
|
+
### Flutter only
|
|
1275
|
+
|
|
1276
|
+
- **Never mix V5 and V6 packages.** `cometchat_chat_uikit:^5.2` (V5, GetX-based, calls in a separate `cometchat_calls_uikit:^5.0` package) and `cometchat_chat_uikit:^6.0.0-beta2` (V6, Bloc-based, calls bundled in) are different SDKs with different state-management primitives, theme APIs, and barrel exports. The skills target one cohort each — pick V5 for production, V6 for beta evaluation, never both.
|
|
1277
|
+
- **V5 has TWO barrels; V6 has ONE.** V5 chat widgets (`CometChatConversations`, `CometChatMessageList`, `CometChatMessageComposer`) are reachable ONLY through `package:cometchat_chat_uikit/cometchat_chat_uikit.dart`. The calls package barrel re-exports `cometchat_uikit_shared` + `cometchat_sdk` + `cometchat_calls_sdk` but NOT `cometchat_chat_uikit` — using only the calls import will fail to resolve chat widgets. V6 ships a single package, so the chat barrel covers both chat AND calls.
|
|
1278
|
+
- **`subscriptionType` is required on `UIKitSettingsBuilder`.** Omitting it silently disables presence and typing-indicator events — no error is thrown, just no presence updates. Always set `..subscriptionType = CometChatSubscriptionType.allUsers` (or `..forFriends` / `..forRoles`).
|
|
1279
|
+
- **`CometChatUIKit.login(uid)` takes a String, not an object.** Both V5 and V6 use the bare-string form for dev login. For production: `CometChatUIKit.loginWithAuthToken(token, ...)`.
|
|
1280
|
+
- **Cache theme values in `didChangeDependencies()`, not `build()`.** `CometChatThemeHelper.getColorPalette(context)` allocates and resolves tokens on every call — running it in `build()` causes jank during keyboard animations and theme changes.
|
|
1281
|
+
- **Listener IDs must be unique + removed in `dispose()`.** Hardcoded listener IDs collide across screens; missing `dispose()` removal leaks listeners across navigations. Use a per-instance ID and remove it on teardown.
|
|
1282
|
+
- **Credentials live in a Dart const file or `--dart-define`, NOT `.env`.** Flutter doesn't read `.env` at runtime; the CLI's `provision setup --framework flutter` writes a `.env` only as a credentials handoff — migrate during Step 5.
|
|
1283
|
+
- **`ComponentToggles` and `CallScreenOverlay` do not exist in V6.** Per-widget feature flags (e.g. `disableReactions`, `hideReplyInThreadOption`) replace v5's `BuilderSettings`. In-call UI is `CometChatOngoingCall` widget + `CometChatDisplayIncomingCallOverlay`, not an overlay class with `.show()`.
|
|
1284
|
+
- **AI widget availability varies across V6 betas.** Some AI widgets (`CometChatAIAssistantChatHistory`, `CometChatAIConversationSummary`) are exported in `6.0.0-beta2`; others may not be. If an import errors with "undefined name", the symbol isn't in that beta. Drive AI features via dashboard-enabled extensions for the most stable path — the kit surfaces AI replies/summaries inside the existing message list and composer regardless.
|
|
1285
|
+
- **V6 conversations slot signatures are asymmetric.** `subtitleView` / `leadingView` / `titleView` take `(BuildContext, Conversation)` (two-arg). `trailingView` and `listItemView` take just `(Conversation)` (single-arg). Match the source — guessing one shape across all four breaks template type-checking. See `cometchat-flutter-v6-conversations` for the example.
|
|
1286
|
+
- **`PNRegistry` is sample-app code, not a kit API.** The kit's only public push surface is `CometChatNotifications.registerPushToken(token, providerId, platform)` and `unregisterPushToken()`. Use the kit API directly, or copy the sample-app `PNRegistry` helper into your project.
|
|
1287
|
+
|
|
1288
|
+
### iOS only
|
|
1289
|
+
|
|
1290
|
+
- **No `CometChatMessages` / `CometChatConversationsWithMessages` / `CometChatDetails` exist.** These look like "pre-built composite UIViewControllers" but the kit doesn't ship them. Build your own `MessagesVC` by composing `CometChatMessageHeader` + `CometChatMessageList` + `CometChatMessageComposer` (sample app: `SampleApp/View Controllers/CometChat Components/MessagesVC.swift`). Same for details — compose your own.
|
|
1291
|
+
- **Init completion uses Swift's standard `Result<Bool, Error>`** (`case .success` / `case .failure`), NOT the kit's `.success`/`.onError` enum that only appears in login/logout callbacks. The `CometChatUIKit(uiKitSettings:)` and `CometChatUIKit.init(uiKitSettings:)` forms are identical in Swift; both compile and the kit's sample apps use the explicit `.init` form.
|
|
1292
|
+
- **Login result switches on `.success` / `.onError`** — NOT Swift's `.failure`. The kit ships its own `Result`-shaped enum for login callbacks. Add `@unknown default: break` to silence the compiler warning.
|
|
1293
|
+
- **App theme parent is irrelevant on iOS** — but pod-side: Xcode 15+ requires `ENABLE_USER_SCRIPT_SANDBOXING = NO` in Build Settings (or the `post_install` Podfile hook). Without it, the resource-bundle build phase silently fails and assets/strings load empty at runtime.
|
|
1294
|
+
- **`pod 'CometChatUIKitSwift', '~> 5.1'`**, NOT `~> 5.0` — the binary target ships at 5.1.x (5.1.12 at last verification); the older pin would resolve to a stale subrelease.
|
|
1295
|
+
- **`CometChatLocalize.set(key:value:)` does not exist.** Public API is locale-only: `set(locale: Language)` / `set(locale: String)`. Override individual keys via your app's `Localizable.strings` instead.
|
|
1296
|
+
- **`CometChatTypography.setFont(name:)` is a class func**, not a settable `fontFamily` property. `CometChatTypography.fontFamily = "Avenir"` does not compile.
|
|
1297
|
+
- **`CometChatGroupMembers()` takes zero args**; pass the group via `set(group:)`. There is no `CometChatGroupMembers(group:)` initializer.
|
|
1298
|
+
- **`CometChatCallButtons(width:height:)` requires explicit dimensions**; there is no zero-arg initializer.
|
|
1299
|
+
- **`CometChatThreadHeader` does NOT exist** — the real class is `CometChatThreadedMessageHeader`.
|
|
1300
|
+
- **Avatar `cornerRadius` is a `CGFloat` on a `CometChatCornerStyle` struct** — there is no `.circle` enum case. For a circular avatar, set a value larger than half the dimension.
|
|
1301
|
+
- **`hideSearch` defaults to `true`** on `CometChatUsers` / `CometChatGroups` / `CometChatConversations` (inherited from `CometChatListBase`). To SHOW the built-in search bar, set `vc.hideSearch = false` — the search bar is hidden out of the box, which catches developers expecting it to render automatically.
|
|
1302
|
+
- **Open the `.xcworkspace`, not the `.xcodeproj`, when CocoaPods is in use.** Opening the bare project skips the `Pods` workspace and Build Settings will show "no such module 'CometChatUIKitSwift'" at compile time.
|
|
1303
|
+
|
|
809
1304
|
## Error handling
|
|
810
1305
|
|
|
811
1306
|
If the CLI's `--json` output includes `human_message` / `suggestion` fields, show those to the user. Then show the raw `error` in parentheses for debuggability. If `retryable: false`, do NOT offer a retry.
|
|
@@ -858,3 +1353,111 @@ Not required for integration or Phase B CLI flows.
|
|
|
858
1353
|
| `cometchat-native-push` | When setting up push notifications |
|
|
859
1354
|
| `cometchat-native-testing` | When adding tests |
|
|
860
1355
|
| `cometchat-native-troubleshooting` | When diagnosing problems |
|
|
1356
|
+
|
|
1357
|
+
### Angular family
|
|
1358
|
+
|
|
1359
|
+
| Skill | When to load |
|
|
1360
|
+
|---|---|
|
|
1361
|
+
| `cometchat-angular-core` | Always — before any integration code |
|
|
1362
|
+
| `cometchat-angular-components` | Always — before writing component code |
|
|
1363
|
+
| `cometchat-angular-placement` | When integrating — for placement patterns (route, modal, drawer, embed) |
|
|
1364
|
+
| `cometchat-angular-patterns` | framework = angular — module organization, lazy loading, environment files |
|
|
1365
|
+
| `cometchat-angular-theming` | When customizing themes (`CometChatThemeService`) |
|
|
1366
|
+
| `cometchat-angular-features` | When adding features (calls, polls, reactions, AI, extensions) |
|
|
1367
|
+
| `cometchat-angular-customization` | When writing custom views via content projection, `<ng-template>` slots, DataSource decorators |
|
|
1368
|
+
| `cometchat-angular-production` | When setting up production auth (server-minted auth tokens) or user management |
|
|
1369
|
+
| `cometchat-angular-troubleshooting` | When diagnosing problems (build errors, schema errors, Zone.js issues) |
|
|
1370
|
+
|
|
1371
|
+
### Android V5 family (live — `chat-uikit-android:5.x`)
|
|
1372
|
+
|
|
1373
|
+
| Skill | When to load |
|
|
1374
|
+
|---|---|
|
|
1375
|
+
| `cometchat-android-v5` | Dispatcher entry — `android_version === "v5"` |
|
|
1376
|
+
| `cometchat-android-v5-core` | Always — Gradle deps, `UIKitSettings.UIKitSettingsBuilder`, init/login, theme parent |
|
|
1377
|
+
| `cometchat-android-v5-components` | Always — View class catalog (`CometChatConversations`, `CometChatMessageList`, …) |
|
|
1378
|
+
| `cometchat-android-v5-placement` | When integrating — Activity / Fragment / BottomSheet placement |
|
|
1379
|
+
| `cometchat-android-v5-theming` | When customizing themes — colors.xml, theme attrs, dark mode |
|
|
1380
|
+
| `cometchat-android-v5-features` | When adding features — calls, reactions, polls, AI, extensions |
|
|
1381
|
+
| `cometchat-android-v5-customization` | When writing custom Views, message templates, `CometChatTextFormatter`, event listeners |
|
|
1382
|
+
| `cometchat-android-v5-extensions` | When working with extensions (`PollsExtension` / `StickerExtension` registrars + custom decorator pattern) |
|
|
1383
|
+
| `cometchat-android-v5-production` | When setting up production auth (server-minted auth tokens) or user management |
|
|
1384
|
+
| `cometchat-android-v5-push` | When setting up push notifications (FCM, token lifecycle, deep-link) |
|
|
1385
|
+
| `cometchat-android-v5-testing` | When adding tests (Espresso, Robolectric, mocking the kit/SDK) |
|
|
1386
|
+
| `cometchat-android-v5-troubleshooting` | When diagnosing problems (Gradle, manifest, ProGuard, lifecycle) |
|
|
1387
|
+
|
|
1388
|
+
### Android V6 family (beta — `chatuikit-{compose,kotlin}-android:6.x`)
|
|
1389
|
+
|
|
1390
|
+
| Skill | When to load |
|
|
1391
|
+
|---|---|
|
|
1392
|
+
| `cometchat-android-v6` | Dispatcher entry — `android_version === "v6"` |
|
|
1393
|
+
| `cometchat-android-v6-core` | Always — Gradle deps, init, login, message sending |
|
|
1394
|
+
| `cometchat-android-v6-events` | Always — `CometChatEvents` SharedFlows + sealed event classes |
|
|
1395
|
+
| `cometchat-android-v6-builder-settings` | When configuring `UIKitSettingsBuilder` (calling, presence, etc.) |
|
|
1396
|
+
| `cometchat-android-v6-features` | When adding features — calls, reactions, polls, AI agent, extensions |
|
|
1397
|
+
| `cometchat-android-v6-extensions` | When working with extensions / DataSource interfaces |
|
|
1398
|
+
| `cometchat-android-v6-production` | When setting up production auth or user management |
|
|
1399
|
+
| `cometchat-android-v6-push` | When setting up push notifications |
|
|
1400
|
+
| `cometchat-android-v6-testing` | When adding tests (Espresso, Compose UI tests, Robolectric, mocking) |
|
|
1401
|
+
| `cometchat-android-v6-troubleshooting` | When diagnosing problems (Gradle, Compose runtime, R8, BuildConfig) |
|
|
1402
|
+
| `cometchat-android-v6-compose-components` | UI stack = Compose — Composable component catalog |
|
|
1403
|
+
| `cometchat-android-v6-compose-placement` | UI stack = Compose — NavHost, modal, bottom sheet placement |
|
|
1404
|
+
| `cometchat-android-v6-compose-theming` | UI stack = Compose — `CometChatTheme { … }`, `LocalColorScheme`/`LocalTypography` |
|
|
1405
|
+
| `cometchat-android-v6-compose-customization` | UI stack = Compose — `BubbleFactory`, slot lambdas, custom Composables |
|
|
1406
|
+
| `cometchat-android-v6-kotlin-components` | UI stack = Kotlin Views — custom View class catalog |
|
|
1407
|
+
| `cometchat-android-v6-kotlin-placement` | UI stack = Kotlin Views — Activity / Fragment / BottomSheet placement |
|
|
1408
|
+
| `cometchat-android-v6-kotlin-theming` | UI stack = Kotlin Views — style attrs, colors.xml, dark mode |
|
|
1409
|
+
| `cometchat-android-v6-kotlin-customization` | UI stack = Kotlin Views — custom Views, `BubbleFactory` abstract class, `setBubbleFactories` |
|
|
1410
|
+
|
|
1411
|
+
### Flutter V5 family (live — `cometchat_chat_uikit:^5.2`)
|
|
1412
|
+
|
|
1413
|
+
| Skill | When to load |
|
|
1414
|
+
|---|---|
|
|
1415
|
+
| `cometchat-flutter-v5` | Dispatcher entry — `flutter_version === "v5"` |
|
|
1416
|
+
| `cometchat-flutter-v5-core` | Always — pubspec deps, init/login, GetX patterns, theme caching, listener lifecycle |
|
|
1417
|
+
| `cometchat-flutter-v5-conversations` | When integrating — `CometChatConversations` widget |
|
|
1418
|
+
| `cometchat-flutter-v5-messages` | When integrating — `CometChatMessages`, `CometChatMessageList`, `CometChatMessageComposer`, `CometChatMessageHeader`, threads |
|
|
1419
|
+
| `cometchat-flutter-v5-users-groups` | When integrating — `CometChatUsers`, `CometChatGroups`, `CometChatGroupMembers` |
|
|
1420
|
+
| `cometchat-flutter-v5-calls` | When adding voice/video — `CometChatCallButtons`, `CometChatIncomingCall`, `CometChatOutgoingCall`, `CometChatOngoingCall`, `CometChatCallLogs` |
|
|
1421
|
+
| `cometchat-flutter-v5-theming` | When customizing themes — `CometChatThemeHelper`, `CometChatColorPalette`, dark mode |
|
|
1422
|
+
| `cometchat-flutter-v5-customization` | When writing custom bubbles, templates, formatters, slot views, DataSource decorators |
|
|
1423
|
+
| `cometchat-flutter-v5-events` | When subscribing to SDK events (`CometChatMessageEvents`, etc.) |
|
|
1424
|
+
| `cometchat-flutter-v5-production` | When setting up production auth (server-minted tokens) and ProGuard |
|
|
1425
|
+
| `cometchat-flutter-v5-push` | When setting up FCM / APNs / VoIP push |
|
|
1426
|
+
| `cometchat-flutter-v5-troubleshooting` | When diagnosing problems (pubspec, GetX, Pod errors, runtime crashes) |
|
|
1427
|
+
|
|
1428
|
+
### Flutter V6 family (beta — `cometchat_chat_uikit:^6.0.0-beta2`)
|
|
1429
|
+
|
|
1430
|
+
| Skill | When to load |
|
|
1431
|
+
|---|---|
|
|
1432
|
+
| `cometchat-flutter-v6` | Dispatcher entry — `flutter_version === "v6"` |
|
|
1433
|
+
| `cometchat-flutter-v6-core` | Always — pubspec deps, init/login, message sending |
|
|
1434
|
+
| `cometchat-flutter-v6-components` | Always — Bloc-driven widget catalog |
|
|
1435
|
+
| `cometchat-flutter-v6-conversations` | When integrating `CometChatConversations` (Bloc, request builder, callbacks) |
|
|
1436
|
+
| `cometchat-flutter-v6-messages` | When integrating `CometChatMessages`, list/header/composer composition |
|
|
1437
|
+
| `cometchat-flutter-v6-users-groups` | When integrating `CometChatUsers`/`CometChatGroups`/`CometChatGroupMembers` |
|
|
1438
|
+
| `cometchat-flutter-v6-calls` | When adding voice/video — incoming/outgoing/ongoing screens |
|
|
1439
|
+
| `cometchat-flutter-v6-features` | When adding features — calls, polls, reactions, AI, extensions |
|
|
1440
|
+
| `cometchat-flutter-v6-placement` | When deciding placement — route, modal sheet, embedded widget |
|
|
1441
|
+
| `cometchat-flutter-v6-theming` | When customizing themes — `CometChatThemeHelper`, `CometChatColorPalette`, light/dark schemes |
|
|
1442
|
+
| `cometchat-flutter-v6-customization` | When writing bubble factories, message templates, text formatters, slot widgets |
|
|
1443
|
+
| `cometchat-flutter-v6-events` | When subscribing to Bloc-based event streams |
|
|
1444
|
+
| `cometchat-flutter-v6-production` | When setting up production auth and external-backend recipes |
|
|
1445
|
+
| `cometchat-flutter-v6-troubleshooting` | When diagnosing problems (pubspec, Bloc, theme cache, build errors) |
|
|
1446
|
+
| `cometchat-flutter-v6-migration` | When migrating from V5 — GetX → Bloc, theme API rewrite, breaking changes |
|
|
1447
|
+
|
|
1448
|
+
### iOS family (V5 stable — `CometChatUIKitSwift:~> 5.1`)
|
|
1449
|
+
|
|
1450
|
+
iOS only ships V5 today; no V6 beta yet. When V6 lands, this section will fork like Android and Flutter do.
|
|
1451
|
+
|
|
1452
|
+
| Skill | When to load |
|
|
1453
|
+
|---|---|
|
|
1454
|
+
| `cometchat-ios` | Dispatcher entry — `framework === "ios"` |
|
|
1455
|
+
| `cometchat-ios-core` | Always — Installation (CocoaPods + SPM), `UIKitSettings` builder, `CometChatUIKit(uiKitSettings:)` constructor init, login order |
|
|
1456
|
+
| `cometchat-ios-components` | Always — UIViewController + SwiftUI view catalog, custom `MessagesVC` composition pattern |
|
|
1457
|
+
| `cometchat-ios-placement` | When integrating — UINavigationController, modal, tab bar, embedded view, SwiftUI hosting |
|
|
1458
|
+
| `cometchat-ios-theming` | When customizing themes — `CometChatTheme` color tokens, `CometChatTypography.setFont(name:)`, dark mode |
|
|
1459
|
+
| `cometchat-ios-customization` | When writing custom message templates, formatters, DataSource decorators, custom views |
|
|
1460
|
+
| `cometchat-ios-features` | When adding features — calls, polls, reactions, AI, extensions |
|
|
1461
|
+
| `cometchat-ios-production` | When setting up production auth (server-minted auth tokens) and user management |
|
|
1462
|
+
| `cometchat-ios-push` | When setting up APNs + VoIP push, CallKit |
|
|
1463
|
+
| `cometchat-ios-troubleshooting` | When diagnosing problems — SPM/CocoaPods errors, Xcode build issues, Info.plist, runtime crashes |
|