@tencent-rtc/mcp 1.3.9 → 1.4.0

package/resource/doc/tuicallkit/flutter/workflow.md

@@ -1,331 +0,0 @@
-# Flutter TUICallKit Audio/Video Call Application Code Generation Workflow Instructions
-
-## 📋 Purpose
-
-To provide Agents with a **code generation blueprint for implementing Flutter TUICallKit core audio/video call features**, and guide Agents to **prioritize using the latest documentation content retrieved in real-time by tools**, specifically for Flutter audio/video call application scenarios.
-
----
-
-## 🛑 Agent Execution Hard Constraints (Guardrails)
-
-Agents must strictly follow these instructions when generating code:
-
-### 0. 🚨 Core Principles (Highest Priority)
-
-- ✅ Strictly generate code according to the sample code in the integration documentation, do not modify arbitrarily
-- ✅ Fully implement login, one-on-one call, and group call features
-- ✅ Use the `get_usersig` tool to generate UserSig for test accounts
-- ✅ Use the latest version of the `tencent_calls_uikit` package (use `any` for version number)
-
-### 1. Documentation-Driven Integration
-- Strictly follow the steps in `llm_code_generation_instructions_md` returned by the tool
-- Follow best practices and sample code from the integration documentation
-
-### 2. Package Import Method
-- **Configure pubspec.yaml**: Directly edit the file to add dependencies (avoid issues with flutter command not found)
-  ```yaml
-  dependencies:
-    tencent_calls_uikit: any  # ⚠️ Use any by default to automatically get the latest version
-  ```
-- Import statement: `import 'package:tencent_calls_uikit/tencent_calls_uikit.dart';`
-- **⚠️ Prohibited**: `latest`, `^latest` and similar notations (not supported by Flutter, will cause installation failure)
-
-### 3. Silent Integration Execution
-- After all code writing is complete, automatically install dependencies and start the project in the final step
-- **Dependency Installation Method**: Directly edit `pubspec.yaml` to add `tencent_calls_uikit: any`
-- **Do not use `flutter pub add` command** (avoid failure due to flutter command not found)
-- **Flutter Command Execution Strategy (Multi-level Degradation to Ensure Success)**:
-  1. **First Priority**: Try to execute `flutter pub get` directly
-  2. **Second Priority**: If failed, use `which flutter` to get the full path and execute
-  3. **Third Priority**: If still failed, try common paths:
-     - macOS/Linux: `$HOME/flutter/bin/flutter`
-     - macOS (Homebrew): `/opt/homebrew/bin/flutter`
-  4. **Final Degradation**: If all fail, **guide user to execute manually** (see guidance below)
-- After successful startup, prompt the user to run the app on simulator or physical device
-
-#### 📋 Manual Execution Degradation Guidance
-
-**When automatic execution fails, guide the user to execute manually**:
-
-```bash
-# 1. Install dependencies
-flutter pub get
-
-# 2. iOS project additional execution
-cd ios && pod install && cd ..
-
-# 3. Start project
-flutter run
-```
-
-**Common Issues**: flutter command not found → Check PATH environment variable; pod install failed → Execute `pod repo update`
-
-### 4. Authentication Credentials Configuration (Important)
-- Call the `get_usersig` tool to get SDKAppID, UserID, and UserSig
-- Generate UserSig for 4 test accounts (user001/002/003/004)
-- Authentication information can be hardcoded during testing, but must be annotated as test-only
-- ⚠️ Security Warning: Inform users that UserSig must be generated on the server side in production environment
-
-### 5. LoginPage Implementation Constraints 🔴
-
-**⚠️ Priority Check: Whether Login Page Already Exists in Project**:
-- Before implementing the login page, **must first check whether a login page already exists in the project**
-- If a login page already exists, **must ask the user whether to execute default behavior**:
-  - **Option 1**: Use default behavior (create new LoginPage with dropdown, 3 test accounts, etc.)
-  - **Option 2**: Modify based on existing login page (keep user's UI and interaction logic, only add necessary TUICallKit login logic)
-- If user chooses Option 2, should:
-  - Keep user's existing login page UI and interaction logic
-  - Only call `TUICallKit.instance.login` for secondary login after successful login
-  - Do not force use of dropdown and 3 test accounts
-- If no login page exists in the project, or user chooses Option 1, implement according to default behavior below
-
-**Default Login Page Implementation Requirements**:
-- **Must implement login page**, including the following features:
-  1. **Dropdown to select UserID**: Provide four options: user001, user002, user003, user004
-  2. **Display SDKAppID**: Get from `get_usersig` and display (read-only, not editable)
-  3. **Auto-generate UserSig**: Automatically match from pre-generated UserSig based on selected UserID
-  4. **Login button**: Call `TUICallKit.instance.login` to login
-- **Login interface must call `TUICallKit.instance.login`**, passing complete credentials obtained from `get_usersig`
-- Automatically navigate to home page (HomePage) after successful login
-
-**LoginPage Core Implementation Points**:
-
-```dart
-// 1. Define test account mapping table (obtained from get_usersig)
-final Map<String, String> userSigMap = {
-  'user001': 'xxx', 'user002': 'xxx', 'user003': 'xxx', 'user004': 'xxx'
-};
-
-// 2. UI Components
-// - SDKAppID display (read-only TextField)
-// - UserID dropdown (DropdownButtonFormField, options generated from userSigMap.keys)
-// - Login button
-
-// 3. Login logic see integration documentation
-```
-
-### 6. HomePage Implementation Constraints 🔴
-
-**Must implement home page**, including the following features:
-
-1. **Display current logged-in UserID**
-2. **Audio/Video call features** (unified user selection):
-   - **User list (multi-select)**: Display selectable users (user002, user003, user004, excluding current logged-in user)
-   - **Smart call type determination**:
-     - Select **1 user** → Automatically initiate **one-on-one call**
-     - Select **multiple users** → Automatically initiate **group call**
-   - **Voice call button**: Call `TUICallKit.instance.calls` to initiate voice call
-   - **Video call button**: Call `TUICallKit.instance.calls` to initiate video call
-   - **Implementation method**: Use `CheckboxListTile` for multi-select, supporting single and multiple selection
-3. **Logout button**: Call `TUICallKit.instance.logout` to logout
-
-**HomePage Core Implementation Points**:
-
-```dart
-// 1. Display current logged-in user (Card + ListTile)
-
-// 2. User selection area (unified one-on-one/group calls)
-// - User list: List<String> availableUsers = ['user002', 'user003', 'user004'].where((u) => u != currentUserId).toList();
-// - Multi-select checkbox: CheckboxListTile (supports selecting 1 or multiple users)
-// - Selected users: List<String> selectedUsers = [];
-
-// 3. Call button area
-// - Voice call button: ElevatedButton
-// - Video call button: ElevatedButton
-
-// 4. Initiate call and logout logic see integration documentation
-```
-
-### 7. MaterialApp Configuration Constraints 🔴
-
-**Must add TUICallKit.navigatorObserver in MaterialApp**:
-
-```dart
-MaterialApp(
-  navigatorObservers: [TUICallKit.navigatorObserver], // ⚠️ Must be added
-  home: const LoginPage(),
-)
-```
-
-### 8. Platform Configuration 🔴
-
-**Android and iOS platform configuration please refer to integration documentation**:
-- Android obfuscation rules and Multidex configuration see integration documentation "Step 2: Project Configuration - Android" section
-- iOS permissions configuration (camera, microphone) see integration documentation "Step 2: Project Configuration - iOS" section
-
-**⚠️ Android Obfuscation Configuration Syntax Check (Important)**:
-Before configuring Android obfuscation rules, **must first check the build script type used in the project**, and choose the correct syntax based on actual situation:
-
-| Build Script File | Syntax Type | Obfuscation Configuration Syntax |
-|-------------------|-------------|----------------------------------|
-| `android/app/build.gradle` | Groovy DSL | `minifyEnabled true` |
-| `android/app/build.gradle.kts` | Kotlin DSL | `isMinifyEnabled = true` |
-
-**Check Steps**:
-1. Check the build script file name in `android/app/` directory
-2. If it's `build.gradle` → Use Groovy syntax: `minifyEnabled true`
-3. If it's `build.gradle.kts` → Use Kotlin DSL syntax: `isMinifyEnabled = true`
-
-**⚠️ iOS Podfile Platform Version Configuration (Important)**:
-When configuring iOS project, **must set minimum platform version to iOS 14.0 in `ios/Podfile`**:
-
-```ruby
-platform :ios, '14.0'
-```
-
-**Configuration Location**: Add this line at the top of Podfile, before the target configuration
-
-### 9. Flutter Project Specifications
-- Use Flutter >= 3.24.0, Dart >= 3.5.0 versions
-- Follow Flutter official code style and best practices
-
-### 10. Environment Dependency Preparation
-- Ensure user has installed Flutter SDK
-- **Flutter command execution follows multi-level degradation strategy in Section 3**
-- iOS platform requires additional execution of `cd ios && pod install && cd ..` to install Pods dependencies
-- **If automatic execution fails, must generate degradation script for user to execute manually**
-
----
-
-## 📦 Core Version Requirements
-
-| Tool/Platform | Minimum Version Requirement |
-|---------------|----------------------------|
-| **Flutter** | >= 3.24.0 |
-| **Dart** | >= 3.5.0 |
-
-**For detailed tool version requirements (Android Studio, Gradle, JDK, Xcode, etc.), please refer to integration documentation "Preparation - Environment Requirements" section**
-
----
-
-## 📦 Automated Execution Commands
-
-After Agent code generation is complete, execute in order:
-
-```bash
-FLUTTER_PATH=$(which flutter)  # Get actual path
-$FLUTTER_PATH pub get          # Get dependencies (based on edited pubspec.yaml)
-cd ios && pod install && cd .. # iOS dependencies (macOS)
-$FLUTTER_PATH run              # Start project
-```
-
-**Dependency Addition Method**: Directly edit `pubspec.yaml` to add `tencent_calls_uikit: any`, avoid executing `flutter pub add` command
-
-**Degradation Strategy**: `which flutter` fails → Try `$HOME/flutter/bin/flutter` → Guide user to execute manually
-
----
-
-## 📱 Physical Device Debugging Guide (User Instructions)
-
-### iOS Physical Device Debugging
-1. Connect device via USB, trust computer
-2. **Open `ios/Runner.xcworkspace`** (not .xcodeproj)
-3. Xcode configure signing (Automatically manage signing + Apple ID + modify Bundle ID)
-4. Execute `flutter run -d ios` or `flutter devices` to view device then specify run
-5. First run requires trusting developer on device: Settings → General → VPN & Device Management → Trust
-
-### Android Physical Device Debugging
-1. Connect device via USB
-2. Enable developer mode (tap build number 7 times) + USB debugging
-3. Device authorize USB debugging (allow)
-4. Execute `adb devices` to verify connection, then `flutter run -d android`
-
----
-
-## 🔄 Complete Automation Workflow
-
-```mermaid
-graph TD
-    A[Receive user requirements] --> B[Get Flutter actual path: which flutter]
-    B --> C[Check Flutter environment]
-    C --> D[Edit pubspec.yaml to add tencent_calls_uikit: any]
-    D --> E[Configure Android platform: obfuscation rules, Multidex]
-    E --> F[Configure iOS platform: Info.plist permissions]
-    F --> G[Configure main.dart: add navigatorObserver]
-    G --> H[Call get_usersig tool to generate UserSig for 3 accounts]
-    H --> I[Implement LoginPage: dropdown to select UserID]
-    I --> J[Implement HomePage: one-on-one and group calls]
-    J --> K[Call record_result to record integration results]
-    K --> L[Execute with full path: $FLUTTER_PATH pub get]
-    L --> M{iOS platform?}
-    M -->|Yes| N[Execute pod install]
-    M -->|No| O[Skip pod install]
-    N --> P[Guide user to connect physical device for debugging]
-    O --> P
-    P --> Q{Choose run method}
-    Q -->|Simulator| R[Execute: $FLUTTER_PATH run]
-    Q -->|iOS physical device| S[Execute: $FLUTTER_PATH run -d ios]
-    Q -->|Android physical device| T[Execute: $FLUTTER_PATH run -d android]
-    R --> U[Project startup successful]
-    S --> U
-    T --> U
-```
-
----
-
-## 📝 Key Points Summary
-
-| Category | Requirement |
-|----------|------------|
-| **Framework Version** | Flutter >= 3.24.0, Dart >= 3.5.0 |
-| **Integration Method** | pub package method (edit `pubspec.yaml` to add `tencent_calls_uikit: any`) |
-| **Documentation Priority** | ⚠️ Strictly follow sample code in integration documentation, do not modify arbitrarily |
-| **Silent Integration** | Automatically install dependencies and start project after code writing is complete, **must use `which flutter` to get actual path** |
-| **Credential Acquisition** | ⚠️ Must use `get_usersig` tool to generate UserSig for 4 test accounts (user001/002/003/004) |
-| **Login Page** | ⚠️ Must implement dropdown to select UserID, automatically match UserSig, prohibit manual input |
-| **Home Page** | ⚠️ Must support unified user list, selecting 1 user automatically initiates one-on-one call, selecting multiple users automatically initiates group call |
-| **Security Reminder** | ⚠️ Must inform user: Client-generated UserSig is only suitable for testing, production environment must generate on server side |
-| **Result Recording** | ⚠️ Must call `record_result` tool to record results after integration is complete |
-| **Platform Configuration** | ⚠️ Android and iOS platform configuration see integration documentation "Step 2: Project Configuration" section |
-| **Navigator Observer** | ⚠️ Must add `TUICallKit.navigatorObserver` in MaterialApp |
-
----
-
-## 🎯 Agent Execution Checklist
-
-After completing code generation, Agent must confirm all the following items:
-
-### Project Initialization
-- [ ] Edited `pubspec.yaml` to add `tencent_calls_uikit: any` dependency
-- [ ] Configured Android and iOS platforms according to integration documentation (see "Step 2: Project Configuration")
-
-### Code Generation
-- [ ] Configured `main.dart`, added `TUICallKit.navigatorObserver`
-- [ ] Called `get_usersig` tool to generate UserSig for 4 accounts
-- [ ] Implemented LoginPage (dropdown to select UserID, no manual input fields)
-- [ ] Implemented HomePage (unified user list, select 1 for one-on-one call, select multiple for group call)
-
-### Final Check
-- [ ] Called `record_result` tool to record integration results
-- [ ] Executed `flutter pub get` and `pod install` (iOS)
-- [ ] Started project, prompted user to choose device
-- [ ] Informed user: Production environment must generate UserSig on server side
-
----
-
-## 🔗 Required Tools
-
-### `get_usersig` - Get Test Authentication Information
-Get SDKAppID, UserID (user001/002/003/004), UserSig.
-- LoginPage: Dropdown to select UserID
-- HomePage: Display selectable user list (excluding current logged-in user)
-- Prohibit manual input of SDKAppID/SecretKey/UserSig
-
-### `record_result` - Record Integration Results
-Call after completing all integration steps and successfully starting project
-
----
-
-## 📚 Related Resource Links
-
-- **TUICallKit Flutter Pub Package**: https://pub.dev/packages/tencent_calls_uikit
-- **Tencent Cloud Real-Time Communication TRTC Console**: https://console.cloud.tencent.com/trtc
-- **Server-side UserSig Generation**: https://cloud.tencent.com/document/product/647/17275
-- **Activate TRTC Service**: https://cloud.tencent.com/document/product/647/16788
-- **Flutter Official Documentation**: https://flutter.dev/docs
-
----
-
-**Applicable Platforms**: Flutter (Android & iOS)  
-**TUICallKit Version**: tencent_calls_uikit (latest version)  
-**Minimum Requirements**: Flutter >= 3.24.0, Dart >= 3.5.0