@cometchat/skills 4.4.1 → 5.0.0

package/skills/cometchat-flutter-v5-messages/SKILL.md

@@ -1,259 +0,0 @@
----
-name: cometchat-flutter-v5-messages
-description: "Use when working with CometChat Flutter UIKit v5 message components. Triggers on CometChatMessageList, CometChatMessageComposer, CometChatCompactMessageComposer, CometChatMessageHeader, threads."
-license: "MIT"
-compatibility: "cometchat_chat_uikit ^5.2.14; cometchat_uikit_shared ^5.2.3"
-metadata:
-  author: "CometChat"
-  version: "3.0.0"
-  tags: "cometchat flutter v5 messages list composer header bubbles threads compact"
----
-
-> **Ground truth:** `cometchat_chat_uikit: ^5.2` (legacy/maintenance-only; calls via raw `cometchat_calls_sdk ^5.0.2`) — pub-cache source + `ui-kit/flutter/v5`. **Official docs:** https://www.cometchat.com/docs/ui-kit/flutter/v5/overview · **Docs MCP:** `claude mcp add --transport http cometchat-docs https://www.cometchat.com/docs/mcp` (or fetch the URL directly without MCP). Verify symbols against the installed package/source before relying on them.
-
-# CometChat Flutter UIKit v5 — Messages
-
-Components for displaying, sending, and managing messages.
-
-## CometChatMessageList
-
-Displays messages in a conversation.
-
-### Key Props
-
-| Prop | Type | Default | Description |
-|------|------|---------|-------------|
-| `user` | `User?` | — | User for 1-on-1 chat (one of user/group required) |
-| `group` | `Group?` | — | Group for group chat |
-| `messagesRequestBuilder` | `MessagesRequestBuilder?` | — | Custom message fetch builder |
-| `style` | `CometChatMessageListStyle?` | — | Visual styling |
-| `alignment` | `ChatAlignment` | `standard` | `standard` or `leftAligned` |
-| `onThreadRepliesClick` | `ThreadRepliesClick?` | — | Thread reply tap callback |
-| `templates` | `List<CometChatMessageTemplate>?` | — | Custom message templates |
-| `textFormatters` | `List<CometChatTextFormatter>?` | — | Custom text formatters |
-| `receiptsVisibility` | `bool` | `true` | Show read receipts |
-| `avatarVisibility` | `bool` | `true` | Show avatars |
-| `disableReactions` | `bool` | `false` | Disable reactions |
-| `disableMentions` | `bool?` | — | Disable @mentions |
-| `messageId` | `int?` | — | Scroll to specific message |
-| `startFromUnreadMessages` | `bool` | `false` | Start from unread |
-| `showMarkAsUnreadOption` | `bool` | `false` | Show mark-as-unread option |
-| `enableSmartReplies` | `bool` | `false` | Enable AI smart replies |
-| `enableConversationStarters` | `bool` | `false` | Enable conversation starters |
-| `generateConversationSummary` | `bool` | `false` | Generate AI summary |
-| `hideEditMessageOption` | `bool` | `false` | Hide edit option |
-| `hideDeleteMessageOption` | `bool` | `false` | Hide delete option |
-| `hideReplyInThreadOption` | `bool` | `false` | Hide reply-in-thread |
-| `hideThreadView` | `bool?` | — | Hide thread view entirely |
-| `hideReactionOption` | `bool` | `false` | Hide reaction option |
-| `hideTranslateMessageOption` | `bool` | `false` | Hide translate option |
-| `hideMessagePrivatelyOption` | `bool` | `false` | Hide private message option |
-| `hideMessageInfoOption` | `bool` | `false` | Hide message info |
-| `hideFlagOption` | `bool` | `false` | Hide flag/report option |
-| `loadingStateView` | `WidgetBuilder?` | — | Custom loading state |
-| `emptyStateView` | `WidgetBuilder?` | — | Custom empty state |
-| `errorStateView` | `WidgetBuilder?` | — | Custom error state |
-
-### Usage
-
-```dart
-CometChatMessageList(
-  user: user,
-  textFormatters: [
-    CometChatEmailFormatter(),
-    CometChatPhoneNumberFormatter(),
-    CometChatUrlFormatter(),
-    CometChatMentionsFormatter(user: user),
-  ],
-  receiptsVisibility: true,
-  hideReplyInThreadOption: false,
-  hideEditMessageOption: false,
-  hideDeleteMessageOption: false,
-)
-```
-
-## CometChatMessageComposer
-
-Full-featured message input with attachments, voice recording, mentions, and AI features.
-
-### Key Props
-
-| Prop | Type | Default | Description |
-|------|------|---------|-------------|
-| `user` | `User?` | — | Target user (one of user/group required) |
-| `group` | `Group?` | — | Target group |
-| `messageComposerStyle` | `CometChatMessageComposerStyle?` | — | Visual styling |
-| `parentMessageId` | `int` | `0` | Thread parent message ID |
-| `placeholderText` | `String?` | — | Input placeholder |
-| `textFormatters` | `List<CometChatTextFormatter>?` | — | Text formatters |
-| `disableTypingEvents` | `bool` | `false` | Disable typing indicators |
-| `disableMentions` | `bool?` | — | Disable @mentions |
-| `disableMentionAll` | `bool` | `false` | Disable @all mentions |
-| `hideVoiceRecordingButton` | `bool?` | — | Hide voice recording |
-| `hideAttachmentButton` | `bool?` | — | Hide attachment button |
-| `hideSendButton` | `bool?` | — | Hide send button |
-| `hideStickersButton` | `bool?` | — | Hide stickers |
-| `hideImageAttachmentOption` | `bool?` | — | Hide image attachment |
-| `hideVideoAttachmentOption` | `bool?` | — | Hide video attachment |
-| `hideAudioAttachmentOption` | `bool?` | — | Hide audio attachment |
-| `hideFileAttachmentOption` | `bool?` | — | Hide file attachment |
-| `hidePollsOption` | `bool?` | — | Hide polls |
-| `hideCollaborativeDocumentOption` | `bool?` | — | Hide collaborative doc |
-| `hideCollaborativeWhiteboardOption` | `bool?` | — | Hide whiteboard |
-| `hideTakePhotoOption` | `bool?` | — | Hide take photo |
-| `onSendButtonTap` | `Function?` | — | Custom send handler |
-| `onError` | `OnError?` | — | Error callback |
-
-## CometChatCompactMessageComposer
-
-Compact variant with rounded pill-shaped input, inline rich text toolbar, and modern minimal aesthetic. Use it explicitly in your widget tree when you want this look — there is no global `Layout` toggle that swaps composers automatically.
-
-### Props unique to Compact (not in regular composer)
-
-| Prop | Type | Default | Description |
-|------|------|---------|-------------|
-| `compactMessageComposerStyle` | `CometChatCompactMessageComposerStyle?` | — | Visual styling |
-| `enableRichTextFormatting` | `bool` | `true` | Enable rich text (master switch) |
-| `showRichTextFormattingOptions` | `bool` | `true` | Show toolbar above composer |
-| `showTextSelectionMenuItems` | `bool` | `true` | Formatting in text selection menu |
-| `hideRichTextFormattingOptions` | `Set<FormatType>?` | — | Hide specific format types |
-| `richTextToolbarStyle` | `CometChatRichTextToolbarStyle?` | — | Toolbar styling |
-| `enterKeyBehavior` | `EnterKeyBehavior` | `newLine` | Enter key: `sendMessage` or `newLine` |
-
-All other props (user, group, parentMessageId, hide* options, textFormatters, etc.) are the same as `CometChatMessageComposer`.
-
-### Usage
-
-```dart
-// ✅ CORRECT — compact composer with thread support
-CometChatCompactMessageComposer(
-  user: user,
-  parentMessageId: parentMessage.id,
-  disableTypingEvents: false,
-  disableMentions: false,
-  hideVoiceRecordingButton: false,
-)
-```
-
-## CometChatMessageHeader
-
-Displays user/group info. Implements `PreferredSizeWidget` for use as `appBar`.
-
-### Key Props
-
-| Prop | Type | Description |
-|------|------|-------------|
-| `user` | `User?` | User to display |
-| `group` | `Group?` | Group to display |
-| `messageHeaderStyle` | `CometChatMessageHeaderStyle?` | Visual styling |
-| `subtitleView` | `Widget? Function(Group?, User?, BuildContext)?` | Custom subtitle |
-| `listItemView` | `Widget Function(Group?, User?, BuildContext)?` | Custom list item |
-| `showBackButton` | `bool?` | Show back button (default: true) |
-| `onBack` | `VoidCallback?` | Back button callback |
-| `hideVideoCallButton` | `bool?` | Hide video call button |
-| `hideVoiceCallButton` | `bool?` | Hide voice call button |
-| `usersStatusVisibility` | `bool` | Show online status (default: true) |
-| `options` | `Function(User?, Group?, BuildContext)?` | Custom header options menu |
-
-## CometChatThreadedHeader
-
-Displays the parent message for threaded conversations.
-
-### Key Props
-
-| Prop | Type | Description |
-|------|------|-------------|
-| `parentMessage` | `BaseMessage` | The parent message (required) |
-| `loggedInUser` | `User` | Current logged-in user (NON-nullable; pass `CometChatUIKit.loggedInUser!`) |
-| `template` | `CometChatMessageTemplate?` | Message template |
-| `receiptsVisibility` | `bool?` | Show receipts |
-| `height` | `double?` | Header height |
-| `width` | `double?` | Header width |
-| `messageActionView` | `Function(BaseMessage, BuildContext)?` | Builder for a custom action view in the header |
-| `style` | `CometChatThreadedHeaderStyle?` | Visual style |
-| `textFormatters` | `List<CometChatTextFormatter>?` | Custom text formatters |
-
-### Threaded Messages Pattern
-
-```dart
-Scaffold(
-  body: Column(
-    children: [
-      CometChatThreadedHeader(
-        parentMessage: parentMessage,
-        loggedInUser: CometChatUIKit.loggedInUser!,
-      ),
-      Expanded(
-        child: CometChatMessageList(
-          user: user,
-          messagesRequestBuilder: MessagesRequestBuilder()
-            ..parentMessageId = parentMessage.id,
-        ),
-      ),
-      CometChatMessageComposer(
-        user: user,
-        parentMessageId: parentMessage.id,
-      ),
-    ],
-  ),
-)
-```
-
-## Sending Messages Programmatically
-
-Use `CometChatUIKit` static methods (not `CometChat` directly) to ensure UIKit events fire:
-
-```dart
-// ✅ CORRECT
-CometChatUIKit.sendTextMessage(message, onSuccess: ..., onError: ...);
-
-// ❌ WRONG — bypasses UIKit events (ccMessageSent won't fire)
-CometChat.sendMessage(message, onSuccess: ...);
-```
-
-## Golden Path — Messages Screen
-
-```dart
-class MessagesScreen extends StatelessWidget {
-  final User? user;
-  final Group? group;
-  const MessagesScreen({super.key, this.user, this.group});
-
-  @override
-  Widget build(BuildContext context) {
-    return Scaffold(
-      appBar: CometChatMessageHeader(
-        user: user,
-        group: group,
-        onBack: () => Navigator.pop(context),
-      ),
-      body: Column(
-        children: [
-          Expanded(child: CometChatMessageList(user: user, group: group)),
-          CometChatMessageComposer(user: user, group: group),
-        ],
-      ),
-    );
-  }
-}
-```
-
-## Anti-Patterns
-
-```dart
-// ❌ WRONG — passing two NON-null targets at the same time
-CometChatMessageList(user: aUser, group: aGroup) // ambiguous — kit ignores group
-// ✅ At any moment, exactly one of user/group must be non-null.
-// Passing both fields with one null (e.g. `user: user, group: null`) is fine
-// and is what the chat-builder sample app does to switch between contexts.
-
-// ❌ WRONG — using CometChat.sendMessage instead of CometChatUIKit
-CometChat.sendMessage(message, onSuccess: ...);
-```
-
-## Checklist — Messages Screen
-
-- [ ] Only one of `user` or `group` passed to each component
-- [ ] Same `user`/`group` passed to Header, List, and Composer
-- [ ] Thread replies use `parentMessageId` on both List and Composer
-- [ ] Messages sent via `CometChatUIKit.sendTextMessage()`

package/skills/cometchat-flutter-v5-production/SKILL.md

@@ -1,216 +0,0 @@
----
-name: cometchat-flutter-v5-production
-description: "Use when preparing a CometChat Flutter UIKit v5 app for production. Covers auth tokens, ProGuard, environment config, security hardening."
-license: "MIT"
-compatibility: "cometchat_chat_uikit ^5.2.14; cometchat_calls_uikit ^5.0.15"
-metadata:
-  author: "CometChat"
-  version: "3.0.0"
-  tags: "cometchat flutter v5 production security auth tokens proguard environment"
----
-
-> **Ground truth:** `cometchat_chat_uikit: ^5.2` (legacy/maintenance-only; calls via raw `cometchat_calls_sdk ^5.0.2`) — pub-cache source + `ui-kit/flutter/v5`. **Official docs:** https://www.cometchat.com/docs/fundamentals/user-auth · **Docs MCP:** `claude mcp add --transport http cometchat-docs https://www.cometchat.com/docs/mcp` (or fetch the URL directly without MCP). Verify symbols against the installed package/source before relying on them.
-
-# CometChat Flutter UIKit v5 — Production
-
-Hardening a CometChat Flutter app for production deployment.
-
-## Auth Tokens vs Auth Key
-
-**Development:** `CometChatUIKit.login(uid)` uses `authKey` from `UIKitSettingsBuilder`. This is convenient but insecure — the authKey is embedded in the app binary.
-
-**Production:** Use server-minted auth tokens via `CometChatUIKit.loginWithAuthToken(authToken)`:
-
-```dart
-// 1. Your backend generates an auth token via CometChat REST API
-// POST https://{appId}.api-{region}.cometchat.io/v3/users/{uid}/auth_tokens
-// Header: apiKey: YOUR_API_KEY
-
-// 2. Your Flutter app receives the token and logs in
-CometChatUIKit.loginWithAuthToken(authToken,
-  onSuccess: (user) { ... },
-  onError: (e) { ... },
-);
-```
-
-This keeps the API key on your server, never in the client.
-
-## Environment Configuration
-
-Store credentials outside source code:
-
-```dart
-class AppCredentials {
-  static String _appId = '';
-  static String _authKey = '';
-  static String _region = '';
-
-  // Load from SharedPreferences, environment, or remote config
-  static String get appId => _appId.isEmpty
-      ? SharedPreferencesClass.getString('appId')
-      : _appId;
-
-  static Future<void> setAppId(String value) async {
-    await SharedPreferencesClass.setString('appId', value);
-    _appId = value;
-  }
-}
-```
-
-The master app supports QR code scanning to load credentials dynamically (`CometChatQRScreen`).
-
-## Android Build Requirements
-
-### gradle.properties
-
-```properties
-android.useAndroidX=true
-android.enableJetifier=true
-```
-
-### minSdk
-
-```groovy
-// android/app/build.gradle
-defaultConfig {
-    minSdk 24  // Matches vendor samples (sample_app + sample_app_push_notifications + calls_uikit android/build.gradle).
-               // Raw calls-sdk docs cite 26; the UI Kit wrapper relaxes to 24 for chat-only apps.
-               // Bump to 26 ONLY if your app uses calls AND fails at runtime with a min-SDK error from the calls plugin.
-}
-```
-
-### ProGuard / R8 Keep Rules
-
-Create `android/app/proguard-rules.pro`:
-
-```
--keep class com.cometchat.** { *; }
--keep interface com.cometchat.** { *; }
--dontwarn com.cometchat.calls.**
-```
-
-Reference in `build.gradle`:
-
-```groovy
-buildTypes {
-    release {
-        minifyEnabled true
-        shrinkResources true
-        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
-    }
-}
-```
-
-### Signing
-
-```groovy
-signingConfigs {
-    release {
-        storeFile file('your_keystore.jks')
-        storePassword 'STORE_PASSWORD'
-        keyAlias 'KEY_ALIAS'
-        keyPassword 'KEY_PASSWORD'
-    }
-}
-```
-
-## iOS Build Requirements
-
-### Info.plist Permissions
-
-```xml
-<key>NSCameraUsageDescription</key>
-<string>Camera access for video calls and photo sharing</string>
-<key>NSMicrophoneUsageDescription</key>
-<string>Microphone access for voice and video calls</string>
-<key>NSPhotoLibraryUsageDescription</key>
-<string>Photo library access for sharing images</string>
-```
-
-### Background Modes (for VoIP)
-
-Enable in Xcode: Background Modes → Voice over IP, Remote notifications, Background fetch.
-
-### Podfile
-
-Ensure minimum iOS deployment target matches CometChat requirements.
-
-## Firebase Setup
-
-```dart
-// In main(), before runApp:
-await Firebase.initializeApp(
-  options: DefaultFirebaseOptions.currentPlatform,
-);
-```
-
-### Crashlytics
-
-```dart
-FlutterError.onError = (errorDetails) {
-  FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
-};
-PlatformDispatcher.instance.onError = (error, stack) {
-  FirebaseCrashlytics.instance.recordError(error, stack, fatal: true);
-  return true;
-};
-```
-
-## Push Notification Provider IDs
-
-Configure provider IDs for FCM and APNs in the CometChat dashboard:
-
-```dart
-static String get fcmProviderId => 'your-fcm-provider-id';
-static String get apnProviderId => 'your-apn-provider-id';
-```
-
-These must match what's configured in the CometChat dashboard under Notifications → Push Notifications.
-
-## Demo Meta Info
-
-For internal tracking (optional):
-
-```dart
-CometChat.setDemoMetaInfo(jsonObject: {
-  "name": "flutter-sample-app",
-  "type": "sample",
-  "version": "5.2.11",
-  "platform": "flutter",
-});
-```
-
-## Logout Flow
-
-```dart
-// 1. Unregister push tokens — real SDK API:
-await CometChatNotifications.unregisterPushToken(
-  onSuccess: (_) {},
-  onError: (e) {},
-);
-// (PNRegistry.unregisterPNService() only works if you copied the v5 sample-app
-//  `extension PNRegistry on CometChatService` helper into your project — it is
-//  NOT importable from any cometchat_* package. See cometchat-flutter-v5-push.)
-
-// 2. Sign out from Firebase/Google (if applicable)
-await FirebaseAuth.instance.signOut();
-await GoogleSignIn().signOut();
-
-// 3. Logout from CometChat
-await CometChatUIKit.logout(
-  onSuccess: (_) { /* navigate to login */ },
-  onError: (e) { /* show error */ },
-);
-```
-
-## Checklist — Production
-
-- [ ] Auth tokens minted server-side, not authKey in client
-- [ ] Credentials not hardcoded in source (use SharedPreferences or remote config)
-- [ ] ProGuard rules added for release builds
-- [ ] minSdk 24 set (or 26 if your app uses calls AND hits min-SDK runtime errors)
-- [ ] iOS permissions in Info.plist
-- [ ] Firebase Crashlytics configured
-- [ ] Push notification provider IDs match CometChat dashboard
-- [ ] Logout unregisters push tokens before CometChat logout
-- [ ] Signing config set for release builds