@tencent-rtc/mcp 1.3.1 → 1.3.2

package/index.js

@@ -5,6 +5,10 @@ import { ServerConfig } from './server-config.js';
 // 启动服务器
 async function main() {
     ServerConfig.getInstance();
+    const { SDKAppID } = ServerConfig.getInstance().getConfig();
+    if (isNaN(SDKAppID)) {
+        throw new Error('You have not configured the SDKAppID, or the configured SDKAppID is invalid. Please configure the correct SDKAppID through the `env` parameter in MCP.');
+    }
     const server = createServer();
     const transport = new StdioServerTransport();
     await server.connect(transport);

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,QAAQ;AACR,KAAK,UAAU,IAAI;IACjB,YAAY,CAAC,WAAW,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAc,YAAY,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;AAC5D,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,QAAQ;AACR,KAAK,UAAU,IAAI;IACjB,YAAY,CAAC,WAAW,EAAE,CAAC;IAC3B,MAAM,EAAE,QAAQ,EAAE,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;IAC5D,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,wJAAwJ,CAAC,CAAC;IAC5K,CAAC;IACD,MAAM,MAAM,GAAc,YAAY,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;AAC5D,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tencent-rtc/mcp",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "Tencent Cloud MCP Server for SDK",
   "type": "module",
   "main": "index.js",

package/resource/doc/chatuikit/faq/web_sdk/faq.md

@@ -160,3 +160,128 @@ For detailed documentation, please refer to: https://trtc.io/document/49561?prod
 
 ### Q: How to delete conversation history messages in SDK?
 **A:** SDK provides the `clearHistoryMessage` API to clear conversation history messages. For detailed documentation, please refer to: https://trtc.io/document/53498?product=chat&menulabel=core%20sdk&platform=javascript.
+
+### Q: How to get the number of unhandled group join requests and how to handle group join applications in Chat SDK and Chat Engine?
+**A:** According to the customer's usage scenario, solutions are provided from both Chat SDK and Chat Engine. When users query such questions, please provide accurate answers based on the actual scenario.
+## Scenario 1: Solution when the customer integrates Chat SDK without UI
+- Get Group Application List During Initialization, API: [getGroupApplicationList](https://trtc.io/document/48465?product=chat&menulabel=core%20sdk&platform=javascript#c69d4d7c-3f0b-4486-b31a-190e6176a1c5)
+- Get the Number of Unhandled Group Join Requests. Based on the list data returned by `getGroupApplicationList`, `applicationType = 0` represents the number of group join requests.
+```typescript
+let unhandledCount = 0;
+let promise = chat.getGroupApplicationList();
+promise.then(function(imResponse) {
+  const { applicationList } = imResponse.data;
+  applicationList.forEach((item) => {
+    // item.applicant - Applicant's userID
+    // item.applicantNick - Applicant's nickname
+    // item.groupID - Group ID
+    // item.groupName - Group name
+    // item.applicationType - Application type: 0 for join group request, 2 for invitation to join group
+    // item.userID - When applicationType = 2, this is the invited user's userID
+    // item.note - Additional message, not supported for group invitations, returns empty string
+    if (item.applicationType === 0) {
+      unhandledCount++;
+    }
+  });
+}).catch(function(imError) {});
+```
+- Update Unread Count When Receiving Group Join Requests Online
+This requires listening to the [MESSAGE_RECEIVED](https://trtc.io/document/47967?product=chat&menulabel=core%20sdk&platform=javascript#d39fb50f-f0f2-4b67-9b15-acd7e8608105) event.
+```typescript
+// For Message data structure details, please refer to https://trtc.io/document/47990?product=chat&menulabel=core%20sdk&platform=javascript
+let unhandledCount = 0;
+let onMessageReceived = function(event) {
+  const messageList = event.data;
+  messageList.forEach((message) => {
+    if (message?.type === 'TIMGroupSystemNoticeElem') {
+      if (message.payload?.operationType === 1) {
+        unhandledCount++;
+      }
+    }
+  })
+};
+chat.on(TencentCloudChat.EVENT.MESSAGE_RECEIVED, onMessageReceived);
+```
+- Handle Group Join Applications
+API: [handleGroupApplication](https://trtc.io/document/48465?product=chat&menulabel=core%20sdk&platform=javascript#processing-(approving-or-rejecting)-a-group-join-request)
+
+```typescript
+// Handle group join requests by getting the pending list
+let promise = chat.getGroupApplicationList();
+promise.then(function(imResponse) {
+  const { applicationList } = imResponse.data;
+  applicationList.forEach((item) => {
+    if (item.applicationType === 0) {
+      chat.handleGroupApplication({
+        handleAction: 'Agree',
+        application: {...item},
+      });
+    }
+  });
+}).catch(function(imError) {});
+```
+
+## Scenario 2: Solution when the customer integrates Chat UIKit with UI or integrates ChatEngine
+- Get Group Application List During Initialization, API: [getGroupApplicationList](https://web.sdk.qcloud.com/im/doc/chat-engine/en/ITUIGroupService.html#getGroupApplicationList)
+- Get the Number of Unhandled Group Join Requests. Based on the list data returned by `getGroupApplicationList`, `applicationType = 0` represents the number of group join requests.
+```typescript
+import { TUIGroupService } from '@tencentcloud/chat-uikit-engine-lite';
+
+let unhandledCount = 0;
+let promise = TUIGroupService.getGroupApplicationList();
+promise.then(function(imResponse) {
+  const { applicationList } = imResponse.data;
+  applicationList.forEach((item) => {
+    // item.applicant - Applicant's userID
+    // item.applicantNick - Applicant's nickname
+    // item.groupID - Group ID
+    // item.groupName - Group name
+    // item.applicationType - Application type: 0 for join group request, 2 for invitation to join group
+    // item.userID - When applicationType = 2, this is the invited user's userID
+    // item.note - Additional message, not supported for group invitations, returns empty string
+    if (item.applicationType === 0) {
+      unhandledCount++;
+    }
+  });
+}).catch(function(imError) {});
+```
+- Update Unread Count When Receiving Group Join Requests Online
+This requires monitoring the [GroupStore](https://web.sdk.qcloud.com/im/doc/chat-engine/en/global.html#GroupStore) provided `groupSystemNoticeList` key through TUIStore.
+```typescript
+// For Message data structure details, please refer to https://trtc.io/document/47990?product=chat&menulabel=core%20sdk&platform=javascript
+import { TUIStore, StoreName } from '@tencentcloud/chat-uikit-engine-lite';
+
+let unhandledCount = 0;
+let onGroupSystemNoticeListUpdated = function(messageList = []) {
+  messageList.forEach((message) => {
+    if (message?.type === 'TIMGroupSystemNoticeElem') {
+      if (message.payload?.operationType === 1) {
+        unhandledCount++;
+      }
+    }
+  })
+}
+
+TUIStore.watch(StoreName.GRP, {
+  groupSystemNoticeList: onGroupSystemNoticeListUpdated,
+})
+```
+- Handle Group Join Applications, API: [handleGroupApplication](https://web.sdk.qcloud.com/im/doc/chat-engine/en/ITUIGroupService.html#handleGroupApplication)
+
+```typescript
+import { TUIGroupService } from '@tencentcloud/chat-uikit-engine-lite';
+
+// Handle group join requests by getting the pending list
+let promise = TUIGroupService.getGroupApplicationList();
+promise.then(function(imResponse) {
+  const { applicationList } = imResponse.data;
+  applicationList.forEach((item) => {
+    if (item.applicationType === 0) {
+      TUIGroupService.handleGroupApplication({
+        handleAction: 'Agree',
+        application: {...item},
+      });
+    }
+  });
+}).catch(function(imError) {});
+```

package/resource/doc/chatuikit/flutter/faq.md

@@ -1,120 +1,23 @@
-### Does TUIKit source code support Androidx?
+---
+product: 'Chat'
+tech_stack: 'flutter_native_sdk'
+framework: 'flutter'
+title: 'Flutter UIKit Integration and Common Issue Solutions'
+keywords: ['flutter', 'initialization', 'component', 'integration', 'TUIKit']
+---
 
-Yes.
+# Flutter TUIKit Integration and Common Issue Solutions
 
-### Why do I encounter a 6012 error or "TLSSDK exchange ticket fail" upon login?
-- The initialization API and the login API must be called separately and cannot be called successively because there are asynchronous operations in the initialization method.
+## Important Notice
+- Agent must strictly output results according to the example code of the interface
 
-- If you are using Chat Free edition and upgrade to Chat Pro Edition, after the upgrade, you can configure your SDKAppID in the console to ensure proper login. For pricing details, see [Pricing](https://intl.cloud.tencent.com/document/product/1047/34350).
+## Module 1: Common Issue Solutions (Topic: Question)
 
+### Q: How to set message do-not-disturb in Flutter Chat SDK or UIKit?
 
-### Why do I encounter a 6013 "SDK Not Initialized" error?
+**A:** Flutter Chat message do-not-disturb related APIs:
+- Set one-to-one chat message do-not-disturb option [setC2CReceiveMessageOpt](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/setC2CReceiveMessageOpt.html).
+- Query one-to-one chat message do-not-disturb option [getC2CReceiveMessageOpt](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/setC2CReceiveMessageOpt.html).
+- Set group chat message do-not-disturb option [setGroupReceiveMessageOpt](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/setGroupReceiveMessageOpt.html).
 
-If the 6013 "SDK Not Initialized" error occurs, try the following troubleshooting methods:
-1. Check whether you performed other operations such as receiving and sending messages before logging in successfully.
-
-2. Check whether you were forced offline when logging in by an account already logged in on another device. By default, the Chat SDK allows one account to log in on one device at a time. For more information, see [Multi-Device Login](https://intl.cloud.tencent.com/document/product/1047/33518).
-
-3. For Android, verify that all library files have been loaded or repossessed by the system during use.
-
-
-### Why do I encounter "code: 6205 desc: QALSERVICE not ready" error?
-
-This error is caused by calling `stopQALService` after initialization. To fix it, refer to the [configuration method](https://blog.csdn.net/qq_16131393/article/details/54895733) shared by one of our customers.
-
-### Why do not emojis appear or appear as gibberish in messages?
-
-Chat does not provide emoji packs. You must align the actual parsing by yourself.
-
-There are two ways to use emojis:
-- Use index in TIMFaceElem to identify the index of the emojis. For example, an Android device and an iOS device have the same set of emojis and index 2 represents the smile emoji. When index=2, both devices send and receive the same indexed emoji.
-
-- Use data in TIMFaceElem. For example, the names of emoji images are string-type. Use the word "smile" to represent the smile emoji, and store "smile" in data. Then, both iOS and Android devices use data as the key to retrieve and display the corresponding emoji.
-
-
-   You can also use the two fields at the same time. For example, use data to specify the emoji set and index to indicate the specific index in this emoji set. This way, you can implement many different emoji effects as in QQ. It is possible to store more complex data structures in data as long as the devices follow the same parsing rules.
-
-
-### Why do I encounter error 10002 during operations?
-
-This status code is returned when a network exception, timeout, or ticket switching failure occurs during server-side authentication. If you see this status code, wait a moment and try again.
-
-### Why do I encounter error 6200 or 6201 when receiving or sending messages?
-
-This status code is returned when the client is offline, times out, or is disconnected. Error 6200 is defined as no network connection during request sending, whereas error 6201 is defined as no network connection during response sending. When you encounter this status code, check the network condition or wait for the network to restore and try again.
-
-### Why do I encounter error 20003 when receiving and sending messages?
-
-This error code is returned when UserID is invalid or UserID has not been imported to Chat. To fix it, check whether UserID has been imported to Tencent Cloud.
-
-### Why do I encounter error 6010 when playing audio messages?
-
-This error code is returned when audio messages that are no longer retained by the roaming server are requested. To fix it, you can [increase the message roaming duration](https://intl.cloud.tencent.com/document/product/1047/34419) or download audio files to local storage and play them. However, expired files cannot be restored. Different SDK versions allow you to increase the retention duration for different message types. For more information, see [Message Storage](https://intl.cloud.tencent.com/document/product/1047/33524).
-
-### Why do I encounter errors 70001, 70003, 70009, and 70013 during account authentication?
-
-These errors occur because UserID and UserSig do not match. To fix it, check the validity of UserID and UserSig. Among them, error 70001 means UserSig has expired, error 70003 means a verification failure due to a truncated UserSig, error 70009 means UserSig verification failed (possibly due to mixing the keys or private keys of other SDKAppIDs when generating UserSig), and error 70013 means UserID does not match.
-
-### Why do I encounter the error code -2 or -5 when the web client app is using the Chat SDK?
-- -2: Indicates that a web app request to the server failed, usually due to network problems. Web apps send requests to the server by using the HTTP Long Polling method, and this status code is returned when a network problem occurs. To fix it, check your network or try again.
-
-- -5: When the login attempt is not completed and the SDK has not received the a2key and tinyID returned by the server, directly calling other APIs returns the "tinyid or a2 is empty" error message and -5 error code.
-
-
-### What should I do when the SDK on the armeabi platform reports "java.lang.UnsatisfiedLinkError: No implementation found for"?
-
-Copy jni/armeabi-v7a/libImSDK.so in the Chat SDK’s aar file to the src/main/jniLibs/armeabi directory in your source code project and load it in build.gradle.
-
-### How can I resolve x86_64 and i386 architecture errors when the app has been launched in App Store?
-
-This error occurs because App Store does not support the x86_64 and i386 architecture. The solution is as follows:
-1. Clear the project compilation cache:
- Select **Product** > **clean**, press Alt until "clean build Folder..." appears and wait for the operation to complete.
-
-2. Remove the x86_64 and i386 architecture not supported by App Store:
- a. Select **TARGETS** > **Build Phases**.
- b. Click the plus sign and select **New Run Script Phase**.
- c. Add the following code:
-
-   ``` bash
-   APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"  
-   
-   # This script loops through the frameworks embedded in the application and  
-   
-   # removes unused architectures.  
-   
-    find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK  
-    do  
-    FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)  
-    FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"  
-    echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"  
-   
-    EXTRACTED_ARCHS=()  
-   
-    for ARCH in $ARCHS  
-    do  
-    echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"  
-    lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"  
-    EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")  
-    done  
-   
-    echo "Merging extracted architectures: ${ARCHS}"  
-    lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"  
-    rm "${EXTRACTED_ARCHS[@]}"  
-   
-    echo "Replacing original executable with thinned version"  
-    rm "$FRAMEWORK_EXECUTABLE_PATH"  
-    mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"  
-   
-    done
-   ```
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100031390357/ac95ba51e28011eeb1eb525400b5f95f.png)
-
-3. Package the app and upload it again.
-
-
-### Can developers directly utilize the emoticon packs demonstrated in the Chat various client demos/TUIKit projects?
-
-To respect the copyright of emoji designs, the Chat Demo/TUIKit project does not include cutouts of large emoji elements. Please replace them with your own designs or other emoji packs for which you hold the copyright before officially launching for commercial use. **The default smiley face emoji pack shown below is copyrighted by Tencent RTC** and is available for licensed use for a fee. If you need to obtain a license, please [contact us](https://trtc.io/contact).
-
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027202808/a44543c197f611ef820f525400d5f8ef.png)
+Message do-not-disturb documentation (no UI): https://cloud.tencent.com/document/product/269/75355