@tencent-rtc/mcp 1.0.9 → 1.1.8

package/resource/doc/chatuikit/react/generate_UserSig.md

@@ -1,306 +0,0 @@
-This document outlines two authentication methods for Chat services, with a focus on UserSig, a security signature by Tencent Cloud to safeguard against unauthorized access. For basic cloud service usage, provide SDKAppID, UserID, and UserSig during SDK initialization or login.
-- SDKAppID is used to identify your application.
-
-- UserID is used to identify your user.
-
-- UserSig is a security signature calculated based on the first two using the HMAC SHA256 encryption algorithm. As long as attackers cannot forge the UserSig, they cannot steal your cloud service traffic.
-
-
-## Obtaining a Key
-1. Log in to the [Chat console](https://console.trtc.io/chat).
-   
-
-   > **Note: **
-   > 
-
-   > If you do not have any app, [create an app](https://intl.cloud.tencent.com/document/product/1047/45914) and then perform [step 2](https://write.woa.com/#step2).
-   > 
-
-2. Click the target app card to go to its basic configuration page.
-
-3. In the **Basic Information** section, click **Display key** to the right of **Key**.
-
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100026631907/9da6a1d5f4df11efa823525400e889b2.png)
-
-4. Click **Copy** to copy and save the key information.
-   
-
-   > **Note: **
-   > 
-
-   >  Store the key information properly to prevent disclosure.
-   > 
-
-
-## Calculating UserSig on the Client
-
-The `GenerateTestUserSig` open-source module provided in the sample code of the Chat SDK can help you quickly generate a UserSig. You only need to configure three member variables, including SDKAPPID (SDKAppID of the app), EXPIRETIME (UserSig expiration time), and SECRETKEY (key information), and then call the genTestUserSig() function to quickly obtain a UserSig.
-
-To simplify this process, we provide the source code for computing a UserSig for the following languages and platforms. You can directly download and integrate the source code into your client.
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Programing Language</td>
-
-<td rowspan="1" colSpan="1" >Platform</td>
-
-<td rowspan="1" colSpan="1" >GenerateTestUserSig Source Code</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Java</td>
-
-<td rowspan="1" colSpan="1" >Android</td>
-
-<td rowspan="1" colSpan="1" >[GenerateTestUserSig.java](https://github.com/tencentyun/TIMSDK/blob/master/Android/Demo/app/src/main/java/com/tencent/qcloud/tim/demo/signature/GenerateTestUserSig.java)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Objective-C</td>
-
-<td rowspan="1" colSpan="1" >iOS</td>
-
-<td rowspan="1" colSpan="1" >[GenerateTestUserSig.h](https://github.com/tencentyun/TIMSDK/blob/master/iOS/Demo/TUIKitDemo/Private/GenerateTestUserSig.h)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Objective-C</td>
-
-<td rowspan="1" colSpan="1" >Mac</td>
-
-<td rowspan="1" colSpan="1" >[GenerateTestUserSig.h](https://github.com/tencentyun/TIMSDK/blob/master/Mac/Demo/TUIKitDemo/Debug/GenerateTestUserSig.h)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >C++</td>
-
-<td rowspan="1" colSpan="1" >Windows</td>
-
-<td rowspan="1" colSpan="1" >[GenerateTestUserSig.h](https://github.com/tencentyun/TIMSDK/blob/master/Windows/Demo/IMApp/GenerateTestUserSig.h)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Javascript</td>
-
-<td rowspan="1" colSpan="1" >Web</td>
-
-<td rowspan="1" colSpan="1" >[GenerateTestUserSig.js](https://github.com/TencentCloud/chat-uikit-uniapp/blob/main/TUIKit/debug/GenerateTestUserSig.js)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Dart</td>
-
-<td rowspan="1" colSpan="1" >Flutter</td>
-
-<td rowspan="1" colSpan="1" >[GenerateTestUserSig.dart](https://github.com/TencentCloud/chat-demo-flutter/blob/main/lib/utils/GenerateTestUserSig.dart )</td>
-</tr>
-</table>
-
-
-> **Note: **
-> 
-
-> In this method, the `SECRETKEY` is vulnerable to decompilation and reverse engineering. Once your `SECRETKEY` is disclosed, attackers can steal your Tencent Cloud traffic. Therefore, **this method is only suitable for locally running a demo project and feature debugging**.
-The correct way to issue a UserSig is to integrate the UserSig computing code into your server and provide app-oriented APIs. When UserSig is needed, your app will send a request to the business server to obtain a dynamic UserSig. For more information, see [How to Calculate UserSig](https://write.woa.com/#GeneratingdynamicUserSig).
-> 
-
-
-## Calculating UserSig on the Server
-
-Generating a UserSig on the server provides maximum protection against the disclosure of the key used for calculating the UserSig. You only need to deploy the code for calculating the UserSig on your server and provide an app-oriented API. When a UserSig is needed, your app will send a request to the business server to obtain a dynamic UserSig.
-To simplify this process, we provide the source code for calculating a UserSig for the following languages and platforms. You can directly download and integrate the source code into your server.
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Programming Language</td>
-
-<td rowspan="1" colSpan="1" >Key Function</td>
-
-<td rowspan="1" colSpan="1" >Download URL</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Java</td>
-
-<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[genSig](https://github.com/Tencent-RTC/tls-sig-api-v2-java/blob/main/src/main/java/com/tencentcloud/TLSSigAPIv2.java)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >GO</td>
-
-<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[GenSig](https://github.com/Tencent-RTC/tls-sig-api-v2-golang/blob/main/tencentyun/TLSSigAPI.go)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >PHP</td>
-
-<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[genSig](https://github.com/Tencent-RTC/tls-sig-api-v2-php/blob/main/src/TLSSigAPIv2.php)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Nodejs</td>
-
-<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[genSig](https://github.com/Tencent-RTC/tls-sig-api-v2-node/blob/main/TLSSigAPIv2.js)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Python</td>
-
-<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[gen_sig](https://github.com/Tencent-RTC/tls-sig-api-v2-python/blob/main/TLSSigAPIv2.py)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >C#</td>
-
-<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[GenSig](https://github.com/Tencent-RTC/tls-sig-api-v2-cs/blob/main/tls-sig-api-v2-cs/TLSSigAPIv2.cs)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >C++</td>
-
-<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[gen_sig](https://github.com/Tencent-RTC/tls-sig-api-v2-cpp)</td>
-</tr>
-</table>
-
-
-Key fields in a UserSig calculation function include the SDKAppID, UserID, and UserSig validity period, as described in the following table.
-
-> **Note: **
-> 
-
-> The following table uses the field names in the Java source code as an example. The field names may be different in other languages.
-> 
-
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Field Name (Example)</td>
-
-<td rowspan="1" colSpan="1" >Description</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >sdkappid</td>
-
-<td rowspan="1" colSpan="1" >SDKAppID of the app. You can obtain the SDKAppID on the app card in the [Chat console](https://console.trtc.io/chat).</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >userId</td>
-
-<td rowspan="1" colSpan="1" >User ID (former name: `Identifier`).</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >expire</td>
-
-<td rowspan="1" colSpan="1" >UserSig validity period, in seconds.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >userbuf</td>
-
-<td rowspan="1" colSpan="1" >This field is set to `null` by default because APIs without UserBuf are used in Chat by default.APIs with UserBuf may be required in some TRTC use cases, for example, when entering a room. For more information, see [Enabling Advanced Permission Control](https://intl.cloud.tencent.com/document/product/647/35157).</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >key</td>
-
-<td rowspan="1" colSpan="1" >Key. You can obtain a key on the app details page in the [Chat console](https://console.trtc.io/chat). For more information, see [Obtaining a Key](https://write.woa.com/#getkey).</td>
-</tr>
-</table>
-
-
-## Old Version of Algorithm
-
-To simplify signature computing so that customers can conveniently and quickly use Tencent Cloud services, the signature algorithm of the Chat service has been upgraded from ECDSA-SHA256 to HMAC-SHA256 since July 19, 2019. This means that all SDKAppIDs created after July 19, 2019 will use the new HMAC-SHA256 algorithm.
-
-If your SDKAppID was created before July 19, 2019, we recommend that you upgrade the signature algorithm to [HMAC-SHA256](https://write.woa.com/#GeneratingdynamicUserSig). The upgrade will not affect your business. Alternatively, you can still use the signature algorithm of an earlier version. The URLs for downloading the source code for the ECDSA-SHA256 algorithm are as follows:
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Programming Language</td>
-
-<td rowspan="1" colSpan="1" >Signature Algorithm</td>
-
-<td rowspan="1" colSpan="1" >Download Link</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Java</td>
-
-<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-java)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >GO</td>
-
-<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-golang)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >PHP</td>
-
-<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-php)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Nodejs</td>
-
-<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-node)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >Python</td>
-
-<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-python)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >C#</td>
-
-<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-cs)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >C++</td>
-
-<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
-
-<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api)</td>
-</tr>
-</table>
-
-
-## Get UserSig from the console
-- Log in to Tencent-RTC Console, navigate to Development Tools > [UserSig Tools](https://console.trtc.io/usersig).
-
-- Under the UserSig Generation Tool, select the corresponding SDKAppID and UserID.
-
-- Click the Generate button to compute the corresponding UserSig.
-
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100026631907/bf1ed039f4df11ef920e5254005ef0f7.png)
-
-

package/resource/doc/chatuikit/react/integrate_tuichat_only_react.md

@@ -1,202 +0,0 @@
-## Applicable Scenarios
-
-Web & H5 platform, integrate independently private chat (1V1) or Group chat. This scenario is applicable for such as real estate consultancy, e-commerce customer service, remote insurance claims assessment.
-
-You can directly experience the chat below. Meanwhile, you can quickly try online code implementation through [**Experience Sandbox**](https://codesandbox.io/p/sandbox/trtc-chat-only-gmtmfw).
-<iframe src="https://sdk-web-1252463788.cos.ap-hongkong.myqcloud.com/im/demo/docs-example/sample-chat/index.html#/chatbox?page=intergrationchat" style="width:100%;height:700px;border:none" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="no-referrer-when-downgrade" allowfullscreen></iframe>
-
-
-## Development Environment Requirement
-- React version 18
-
-- TypeScript
-
-- [Node.js](https://nodejs.org/en/) version 18+
-
-- npm (version should match node version)
-
-
-## Chat-Uikit-React Integration
-
-### Step 1: Create Project
-
-Create a new React project named **chat-app** (select React 18 during project creation and recommend using the Typescript template), and follow the prompt to run the initial project.
-
-
-【shell】
-``` bash
-npm create rsbuild@latest
-```
-
-### Step 2: Download the Chat-Uikit-React Component
-
-Download [chat-uikit-react](https://www.npmjs.com/package/@tencentcloud/chat-uikit-react) via npm and use it in the project.
-
-
-【shell】
-``` bash
-npm i @tencentcloud/chat-uikit-react
-```
-
-### Step 3: Introduce the Chat-Uikit-React Component, Create and Open a Session to Chat
-
-> **Note:**
-> 
-
-> Note: The following code does not auto-fill `SDKAppID`, `userID`, or `userSig`. Retrieve related information in [procedure 4](https://write.woa.com/#step4) and replace them.
-> 
-
-
-> **Note:**
-> 
-> -   Call API [createC2CConversation](https://write.woa.com/document/155521474134589440) to create a one-to-one chat.
-> - Call API [createGroupConversation](https://write.woa.com/document/155521474134589440) to create a group chat.
-> - Ways to enter a chat:
-> - Call API [setActiveConversation](https://write.woa.com/document/155521474134589440), input conversationID to enter the chat page.
-
-
-Replace the content in App.tsx, or you can create a new component and introduce it. [Experience Sandbox ->](https://codesandbox.io/p/sandbox/trtc-chat-only-gmtmfw?from-embed=)
-``` typescript
-import {
-  UIKitProvider,
-  useLoginState,
-  LoginStatus,
-  useConversationListState,
-  Chat,
-  MessageList,
-  MessageInput,
-  ChatHeader,
-  useUIOpenControlState,
-  ChatSetting,
-  Search,
-  VariantType,
-} from "@tencentcloud/chat-uikit-react"
-
-export default function App() { 
-
-  const { isChatSettingOpen, isChatSearchOpen } = useUIOpenControlState();
-  const { setActiveConversation, createC2CConversation } = useConversationListState();
-  const { status } = useLoginState({
-    SDKAppID: 0, // Your SDKAppID, see procedure 4
-    userID: '',  // Your logged in UserID, see procedure 5
-    userSig: '', // Your userSig, see procedure 5
-    onSuccess() {
-      const userID = ''; // userID: recipient's userID
-      createC2CConversation(userID).then((conversation) => {
-        setActiveConversation(conversation.conversationID);
-      })
-    }
-  });
-
-  if (status !== LoginStatus.SUCCESS) {
-    return <div>loading...</div>;
-  }
-  
-  // Language support en-US(default) / zh-CN / ja-JP / ko-KR / zh-TW
-  // Theme supports light(default) / dark
-  return (
-    <div style={{display: 'flex', height: '100vh'}}>
-      <UIKitProvider language='en-US' theme='light'>
-        <Chat style={{ width: '100vw' }}>
-          <ChatHeader />
-          <MessageList />
-          <MessageInput />
-        </Chat>
-        {isChatSettingOpen && <ChatSetting />}
-        {isChatSearchOpen &&  <Search style={{ minWidth: '300px'}} variant={VariantType.EMBEDDED} />}
-      </UIKitProvider>
-    </div>   
-  );
-}
-```
-
-### Step 4: Creating an Application
-1. Log in to the [Chat Console](https://console.trtc.io/).
-
-2. Click "Create Application", enter your application name, then click "Create".
-
-
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100033438418/327c29cf622711f0a64452540099c741.png)
-
-3. After creation, you can see the application status, service version, SDKAppID, createTime, tag, and expiration time on the console overview page.
-
-
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100033438418/3340d098622711f0ad0f5254005ef0f7.png)
-
-
-### Procedure 5: Obtain UserID and UserSig
-- `userID`
-
-  - Click to enter the [Application](https://console.trtc.io/app) you created above. The `Chat` product entry will be shown in the left sidebar. Click to enter.
-
-  - After entering the Chat product subpage, click `Users` to enter the user management page.
-
-  - Click `Create account`, and a pop-up input box for account information will appear. If you are merely an ordinary member, we recommend you select the `General` data type.
-
-  - For a better experience in message sending and receiving and other features, we recommend creating two userIDs.
-
-
-      ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100033438418/322318b9622711f0ad0f5254005ef0f7.png)
-
-- `userSig`, usable development tools provided by the console to generate in real-time. Please click [Chat Console > Development Tools > UserSig Tools > Signature (UserSig) Generator](https://console.trtc.io/usersig).
-
-
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100033438418/323eb909622711f0a64452540099c741.png)
-
-
-### Step 6: Start Project
-
-Replace the SDKAppID, userID, and userSig in App.tsx, then run the command as follows:
-
-
-【shell】
-``` bash
- npm run start
-```
-
-> **Note:**
-> 
-> 1. Please ensure the [procedure 3](https://write.woa.com/#step3) code has successfully replaced `SDKAppID`, `userID`, and `userSig`. If not replaced, it will lead to abnormal project performance.
-> 2. `userID` and `userSig` have a one-to-one relationship. Refer to [generate UserSig](https://trtc.io/document/39074?product=consoleguide).
-> 3. If the project fails to start, please check whether the [development environment requirement](https://write.woa.com/#required) are met.
-
-
-### Step 7: Send Your First Message
-
-enter the message in the input box and press **enter** to send.
-<iframe src="https://codesandbox.io/embed/gmtmfw?view=split&amp;module=%2Fsrc%2FApp.tsx" style="width:100%;height:750px;border:0;border-radius:4px;overflow:hidden" title="chat-react-test" allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking" sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"></iframe>
-
-
-## FAQs
-
-#### What Is UserSig
-
-UserSig is the password for user login to Chat, which is essentially the encrypted ciphertext of UserID and other information.
-
-#### How to Generate UserSig
-
-The UserSig issuance method involves integrating the UserSig calculation code into your server and providing a project-oriented API. When UserSig is required, your project initiates a request to the business server to obtain a dynamic UserSig. For more details, see [UserSig generation by the server](https://cloud.tencent.com/document/product/269/32688#GeneratingdynamicUserSig).
-
-> **Note:**
-> 
-
-> The example code in this document uses a solution to obtain UserSig by configuring SECRETKEY in client-side code. In this method, SECRETKEY can be easily decompiled and reverse-engineered. Once your key is leaked, attackers can steal your Tencent Cloud traffic. Therefore, **this method is only suitable for local debugging**. For the correct UserSig issuance method, please refer to the context before.
-> 
-
-
-#### Does React 17.X Version Support
-
-Currently does not support version 17.x. Only React ≥ v18.0 is supported.
-
-## Reference Documentation
-
-#### UIKit Related
-- [chat-uikit-react npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-react)
-
-- [Demo source code and running example](https://github.com/TencentCloud/chat-uikit-react)
-
-
-#### Implementing More Features, Refer to ChatEngine API Document
-- [chat-uikit-engine API manual](https://web.sdk.qcloud.com/im/doc/chat-engine/index.html)
-
-- [chat-uikit-engine npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-engine)