@tencentcloud/sdk-mcp 1.0.8 → 1.1.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.
Files changed (48) hide show
  1. package/package.json +1 -1
  2. package/resource/doc/chatuikit/faq/vue_qa.md +0 -344
  3. package/resource/doc/chatuikit/react/create-group.md +22 -0
  4. package/resource/doc/chatuikit/react/login.md +2 -2
  5. package/resource/doc/chatuikit/vue/components/chat.md +5 -0
  6. package/resource/doc/chatuikit/vue/components/chatheader.md +3 -1
  7. package/resource/doc/chatuikit/vue/components/conversation-list.md +3 -0
  8. package/resource/doc/chatuikit/vue/components/message-input.md +4 -0
  9. package/resource/doc/chatuikit/vue/create-group.md +26 -0
  10. package/resource/doc/chatuikit/vue/init.md +35 -0
  11. package/resource/doc/chatuikit/vue/integration.md +7 -1
  12. package/tools/chat/create-group.js +29 -0
  13. package/tools/chat/create-group.js.map +1 -0
  14. package/tools/chat/get-web-chat-component-detail.js +0 -1
  15. package/tools/chat/get-web-chat-component-detail.js.map +1 -1
  16. package/tools/chat/get-web-chat-integration.js +1 -1
  17. package/tools/chat/get-web-chat-integration.js.map +1 -1
  18. package/tools/chat/{get-web-chat-uikit-login.js → get-web-chat-uikit-init.js} +5 -5
  19. package/tools/chat/get-web-chat-uikit-init.js.map +1 -0
  20. package/tools/common/present-framework-choice.js +9 -18
  21. package/tools/common/present-framework-choice.js.map +1 -1
  22. package/tools/common/record-prompt.js +3 -4
  23. package/tools/common/record-prompt.js.map +1 -1
  24. package/tools/common/record-result.js +4 -4
  25. package/tools/common/record-result.js.map +1 -1
  26. package/tools/index.js +4 -2
  27. package/tools/index.js.map +1 -1
  28. package/utils/handle-component-name.js +2 -2
  29. package/utils/handle-component-name.js.map +1 -1
  30. package/resource/doc/chatuikit/vue/components/MessageInput.md +0 -546
  31. package/resource/doc/chatuikit/vue/components/login.md +0 -29
  32. package/resource/doc/chatuikit/vue/login.md +0 -29
  33. package/resource/doc/chatuikit/vue3/components/MessageInput.md +0 -546
  34. package/resource/doc/chatuikit/vue3/components/MessageList.md +0 -385
  35. package/resource/doc/chatuikit/vue3/components/avatar.md +0 -105
  36. package/resource/doc/chatuikit/vue3/components/chatheader.md +0 -153
  37. package/resource/doc/chatuikit/vue3/components/component-list.md +0 -88
  38. package/resource/doc/chatuikit/vue3/components/userpicker.md +0 -256
  39. package/resource/doc/chatuikit/vue3/integration.md +0 -218
  40. package/tools/call/get-native-call-integration-guide.js +0 -35
  41. package/tools/call/get-native-call-integration-guide.js.map +0 -1
  42. package/tools/call/get-web-call-integration-guide.js +0 -34
  43. package/tools/call/get-web-call-integration-guide.js.map +0 -1
  44. package/tools/chat/get-native-chat-integration-guide.js +0 -33
  45. package/tools/chat/get-native-chat-integration-guide.js.map +0 -1
  46. package/tools/chat/get-web-chat-integration-guide.js +0 -42
  47. package/tools/chat/get-web-chat-integration-guide.js.map +0 -1
  48. package/tools/chat/get-web-chat-uikit-login.js.map +0 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tencentcloud/sdk-mcp",
3
- "version": "1.0.8",
3
+ "version": "1.1.0",
4
4
  "description": "Tencent Cloud MCP Server for SDK",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -1,344 +0,0 @@
1
- ## 常见问题
2
-
3
- ### 1. 音视频相关问题如何解决?
4
-
5
- 请单击 [音视频通话 > 常见问题](https://write.woa.com/document/174907394083565568) 查看解决方案。
6
-
7
- ### **2. **我只想集成聊天窗口,如何单独集成 TUIChat?如果直接打开指定单聊/群聊会话?
8
-
9
- 独立集成聊天窗口,请参见 [TUIChat 独立集成方案](https://cloud.tencent.com/document/product/269/96740)。
10
-
11
- ### 3. js 工程如何接入 TUIKit 组件?
12
-
13
- TUIKit 仅支持 ts 环境运行,您可以通过渐进式配置 typescript 来使您项目中已有的 js 代码 与 TUIKit 中 ts 代码共存。
14
-
15
-
16
-
17
- 【vue-cli】
18
-
19
- 请在您 vue-cli 脚手架创建的工程根目录执行:
20
- ``` bash
21
- vue add typescript
22
- ```
23
-
24
- 之后按照如下进行配置项进行选择(为了保证能同时支持原有 js 代码 与 TUIKit 中 ts 代码,请您务必严格按照以下五个选项进行配置)
25
-
26
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf35699a9fdd11ef992f52540075b605.png)
27
-
28
-
29
- > **注意:**
30
- >
31
-
32
- > 完成以上步骤后,请重新运行项目!
33
- >
34
-
35
-
36
- 【vite】
37
-
38
- 请在您 vite 创建的工程根目录执行:
39
- ``` bash
40
- npm install -D typescript
41
- ```
42
-
43
- ### 4. 什么是 UserSig?如何生成 UserSig?
44
-
45
- UserSig 是用户登录即时通信 IM 的密码,其本质是对 UserID 等信息加密后得到的密文。
46
-
47
- UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端,并提供面向项目的接口,在需要 UserSig 时由您的项目向业务服务器发起请求获取动态 UserSig。更多详情请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688#console)。
48
-
49
- > **注意**
50
- >
51
-
52
- > 本文示例代码采用的获取 UserSig 的方案是在客户端代码中配置 SECRETKEY,该方法中 SECRETKEY 很容易被反编译逆向破解,一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量,因此**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见上文。
53
- >
54
-
55
-
56
- ### 5. 运行时报错:"TypeError: Cannot read properties of undefined (reading "getFriendList")"
57
-
58
- 若按照上述步骤接入后,运行时出现以下错误,请您务必**删除 TUIKit 目录下的 node_modules 目录**,以保证 TUIKit 的依赖唯一性,避免 TUIKit 多份依赖造成问题。
59
-
60
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf4284fc9fdd11efa04c5254002693fd.png)
61
-
62
-
63
- ### 6. 运行时报错:/chat-example/src/TUIKit/components/TUIChat /message-input/message-input-editor.vue .ts(8,23)TS1005: expected.
64
-
65
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf40e8b09fdd11ef820f525400d5f8ef.png)
66
-
67
-
68
- 出现以上报错信息,是因为您安装的 @vue/cli 版本过低导致,**请您务必保证您的 @vue/cli 版本在 5.0.0 及以上**。升级方式如下:
69
- ``` javascript
70
- npm install -g @vue/cli@5.0.8
71
- ```
72
-
73
- ### 7. 运行时报错: Failed to resolve loader: sass-loader
74
-
75
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf36f9819fdd11efa646525400329841.png)
76
-
77
-
78
- 出现以上报错信息,是因为您未安装 `sass` 环境导致,请执行以下命令进行 `sass`环境安装:
79
- ``` javascript
80
- npm i -D sass sass-loader@10.1.1
81
- ```
82
-
83
- ### 8. ESLint 报错:error 'withDefaults' is not defined no-undef? 'defineProps' is not defined no-undef? 以及 ESLint 其他报错?
84
-
85
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf44d4f59fdd11efa646525400329841.png)
86
-
87
-
88
- **若 chat-uikit-vue 拷贝到 src 目录汇总与您本地项目代码风格不一致导致报错,可将本组件目录屏蔽,如在项目根目录增加 .eslintignore 文件:**
89
- ``` javascript
90
- # .eslintignore
91
- src/TUIKit
92
- ```
93
-
94
- ### 9. vue/cli 如何关闭 dev 模式下,webpack 全屏 overlay error 报错信息提示?
95
-
96
- 可以在您项目根目录的 vue.config.js 中进行关闭:
97
-
98
-
99
-
100
- 【webpack4】
101
- ``` javascript
102
- module.exports = defineConfig({
103
- ...
104
- devServer: {
105
- client: {
106
- overlay: false,
107
- },
108
- },
109
- });
110
- ```
111
-
112
- 【webpack3】
113
- ``` javascript
114
- module.exports = {
115
- ...
116
- devServer: {
117
- overlay: false,
118
- },
119
- };
120
- ```
121
-
122
- ### 10. 出现 Component name "XXXX" should always be multi-word 怎么办?
123
- - IM TUIKit web 所使用的 ESLint 版本为 v6.7.2 ,对于模块名的驼峰式格式并不进行严格校验。
124
-
125
- - 如果您出现此问题,您可以在 .eslintrc.js 文件中进行如下配置:
126
-
127
-
128
-
129
- 【shell】
130
- ``` bash
131
- module.exports = {
132
- ...
133
- rules: {
134
- ...
135
- 'vue/multi-word-component-names': 'warn',
136
- },
137
- };
138
- ```
139
-
140
- ### 11. 出现 ERESOLVE unable to resolve dependency tree 怎么办?
141
-
142
- npm install 的时候如果出现 ERESOLVE unable to resolve dependency tree ,表示依赖安装冲突,可采用以下方式进行安装:
143
-
144
-
145
- 【shell】
146
- ``` bash
147
- npm install --legacy-peer-deps
148
- ```
149
-
150
- ### 12. 运行报错如下'vue packages version mismatch',如何解决?
151
- - 如果您是 vue2.7 项目,请在您项目根目录执行:
152
-
153
- ``` bash
154
- npm i vue@2.7.9 vue-template-compiler@2.7.9
155
- ```
156
- - 如果您是 vue2.6 项目,请在您项目根目录执行:
157
-
158
- ``` bash
159
- npm i vue@2.6.14 vue-template-compiler@2.6.14
160
- ```
161
-
162
- ### 13. vite 项目 npm run build 之后 ts 报错?
163
-
164
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf4ddd8c9fdd11efa04c52540055f650.png)
165
-
166
-
167
- **原因**:package.json script 下 "build": "vue-tsc && vite build" 中的 vue-tsc 命令导致。
168
-
169
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf42f0769fdd11efa0b3525400bdab9d.png)
170
-
171
-
172
- **解决方案**: 删除 vue-tsc 即可。 "build": "vite build"
173
-
174
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf34e0079fdd11efa0b3525400bdab9d.png)
175
-
176
-
177
- ### 14. 使用 pnpm 下载缺少依赖?
178
-
179
- `pnpm` 安装 `@tencentcloud/chat-uikit-vue` 后拷贝到 TUIKit 目录使用会存在内部依赖缺失问题,建议您优先选择 `npm` / `yarn` 方式安装。
180
-
181
- 若您确实需要使用 pnpm 安装依赖,请在进行完上文接入步骤后:
182
- 1. 将 `node_modules/@tencentcloud/chat-uikit-vue/package.json` 中的依赖项拷贝到您自身项目根目录 `package.json` 中。
183
-
184
- 2. 运行 `pnpm i` , 进行内部缺失依赖安装。
185
-
186
-
187
- ### 15. H5 页面 iOS 低版本机型出现白屏?
188
-
189
- 您可以通过配置 polyfill 兼容低机型版本。(什么是 polyfill?polyfill 是一种用于解决浏览器兼容问题的技术。它用于模拟某些浏览器不支持的新特性,使得这些特性能在不支持的浏览器中正常工作。更多详情请参见 [babel-polyfill](https://babeljs.io/docs/babel-polyfill)。)
190
- 1. 安装 babel-polyfill:
191
-
192
- ``` bash
193
- npm i @babel/polyfill
194
- ```
195
- 2. 入口文件引入 'babel-polyfill':
196
-
197
- ``` javascript
198
- import 'babel-polyfill';
199
- ```
200
- 3. 新增 babel.config.js 配置
201
-
202
- ``` javascript
203
- module.exports = {
204
- presets: [
205
- [
206
- '@vue/cli-plugin-babel/preset',
207
- {
208
- useBuiltIns: 'entry',
209
- corejs: 3,
210
- },
211
- ],
212
- [
213
- '@babel/preset-env',
214
- {
215
- targets: {
216
- browsers: ['iOS >= 11'],
217
- },
218
- useBuiltIns: 'entry',
219
- corejs: 3,
220
- },
221
- ],
222
- ],
223
- };
224
- ```
225
-
226
- ###
227
-
228
- ### 16. 运行报错:Uncaught TypeError: marked__WEBPACK_IMPORTED_MODULE_0_ Marked is not a constructor,如何处理?
229
-
230
- 如果您运行过程中出现如下错误,说明您当前 Vue CLI构建的项目环境版本较低,需要降低 uikit 中使用的 marked 版本至 5.1.2。
231
-
232
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/6acef150b3b911ef8b1b525400f69702.png)
233
-
234
-
235
- 请在您项目的**根目录**使用以下脚本降低 marked 版本:
236
- ``` bash
237
- npm i marked@5.1.2 --legacy-peer-deps
238
- ```
239
-
240
- ###
241
-
242
- ### 17. 编译报错 node_modules/marked/lib/marked.esm.js: Class private methods are not enabled,如何处理?
243
-
244
- 如果您运行过程中出现如下错误,说明您当前使用的 marked 版本过低,请升级 marked 版本至 6.0.0。
245
-
246
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/6ac6f829b3b911ef9d2952540055f650.png)
247
-
248
- 请在您项目的** 根目录 **使用以下脚本降低 marked 版本:
249
- ``` bash
250
- npm i marked@6.0.0 --legacy-peer-deps
251
- ```
252
-
253
- ###
254
-
255
- ### 18. 运行报错 Uncaught SyntaxError: The requested module xxx does not provide an export named 'Friend'
256
-
257
- 如果您的 vite 项目运行过程中出现以下报错,请参见以下方案:
258
-
259
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/38586a0ec72711efb8ca5254007c27c5.png)
260
-
261
-
262
- 在根目录文件 `tsconfig.json` 下增加以下编译规则,分为以下两种情况:
263
- 1. 如果您的 `tsconfig.json` 没有 `references` 配置,直接在 tsconfig.json 中配置如下规则:
264
-
265
-
266
-
267
-
268
-
269
- 【typescript ≥ 5.0.0】
270
- ``` json
271
- {
272
- ...
273
- "compilerOptions": {
274
- ...
275
- "verbatimModuleSyntax": false,
276
- }
277
- }
278
- ```
279
-
280
-
281
- 【typescript < 5.0.0】
282
- ``` json
283
- {
284
- ...
285
- "compilerOptions": {
286
- ...
287
- "importsNotUsedAsValues": "preserve",
288
- }
289
- }
290
- ```
291
-
292
- 2. 如果您的 `tsconfig.json` 已有 `references` 配置,比如 vite 官方自动配置的 `"./tsconfig.app.json"`,`"./tsconfig.node.json" `等,由于 `references` 的特性,导致 `tsconfig.json `本身只是规则的引用文件,此时直接在 `tsconfig.json` 中配置以下规则无效。需要将规则添加至实际的`references`对应的文件中。以下是具体示例:
293
-
294
- <table>
295
- <tr>
296
- <td rowspan="1" colSpan="1" >错误写法</td>
297
-
298
- <td rowspan="1" colSpan="1" >正确写法</td>
299
- </tr>
300
-
301
- <tr>
302
- <td rowspan="1" colSpan="1" >当 tsconfig.json 文件中已有 references 相关配置时,直接在 tsconfig.json 中声明以下规则无效</td>
303
-
304
- <td rowspan="1" colSpan="1" >当 tsconfig.json 文件中已有 references 相关配置时,需要在对应的 references 内部文件中声明以下规则。下文中是在 references 中配置的根目录 `tsconfig.app.json` 文件中配置以下规则。</td>
305
- </tr>
306
-
307
- <tr>
308
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/38631967c72711efb8ca5254007c27c5.png)</td>
309
-
310
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/38641d65c72711efb8ca5254007c27c5.png)</td>
311
- </tr>
312
- </table>
313
-
314
-
315
- ###
316
-
317
- ### 19. 编译后 Sass waring:Deprecation Warning: The legacy JS API is deprecated and will be removed in Dart Sass 2.0.0.
318
-
319
- 如果您在运行后出现如下提示,请不要担心,这是 sass 大版本规则更新后的 warning 提示;该提醒并不会影响您的正常运行。
320
-
321
- 如果您想去除此类 warning 提示,请将 sass 版本降级至 1.77.4 及以下。
322
-
323
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/38574a57c72711ef82565254005ef0f7.png)
324
-
325
- ``` bash
326
- npm i -D sass@1.77.0 sass-loader@10.1.1
327
- ```
328
-
329
- ## 相关文档
330
-
331
- #### Vue2 & Vue3 UIKit 相关:
332
- - [集成音视频通话](https://cloud.tencent.com/document/product/269/79861)
333
-
334
- - [chat-uikit-vue npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-vue)
335
-
336
- - [Vue2 Demo源码及跑通示例](https://github.com/TencentCloud/chat-uikit-vue/tree/main/Vue2/Demo)
337
-
338
- - [Vue3 Demo源码及跑通示例](https://github.com/TencentCloud/chat-uikit-vue/tree/main/Vue3/Demo)
339
-
340
-
341
- #### Vue2 & Vue3 UIKit 逻辑层: engine 相关
342
- - [chat-uikit-engine npm 仓库](https://www.npmjs.com/package/@tencentcloud/chat-uikit-engine)
343
-
344
- - [chat-uikit-engine 接口文档](https://web.sdk.qcloud.com/im/doc/chat-engine/index.html)
@@ -0,0 +1,22 @@
1
+ # chat-uikit-react Create Group Conversation
2
+
3
+ 本文提供了 chat-uikit-react 创建群组会话的示例代码,通过 useConversationListState 提供的 createGroupConversation API 来创建群组。
4
+
5
+ ## 1. 创建群组示例代码
6
+
7
+ ```tsx
8
+ import { useConversationListState } from '@tencentcloud/chat-uikit-react';
9
+
10
+ const {
11
+ createGroupConversation,
12
+ setActiveConversation,
13
+ } = useConversationListState();
14
+
15
+ createGroupConversation({
16
+ name: `group-${Math.random()}`,
17
+ type: 'Public',
18
+ }).then((conversation) => {
19
+ setActiveConversation(conversation.conversationID);
20
+ });
21
+
22
+ ```
@@ -1,6 +1,6 @@
1
- # chat-uikit-vue3 Login
1
+ # chat-uikit-react Login
2
2
 
3
- 本文提供 chat-uikit-react 登录的示例代码, 通过 useLoginState 驱动组件登录。
3
+ 本文提供了 chat-uikit-react 登录的示例代码, 通过 useLoginState 提供的 login API 来驱动组件登录。
4
4
 
5
5
  ## 1. 登录
6
6
 
@@ -1,9 +1,14 @@
1
+ AI 模型必须遵守以下**硬性限制**。
2
+ 1. **Chat 组件必须使用默认 style:** Chat 默认 style 设置为 `flex:1; min-height: 0`。
3
+ 2. **必须使用 sendMessage API:** 发送快捷消息时必须使用 useMessageInputState 提供的 `sendMessage` API。
4
+
1
5
  # Chat 组件文档
2
6
 
3
7
  ## 概述
4
8
 
5
9
  Chat 组件负责渲染聊天界面,包含聊天窗口头部组件 ChatHeader 、消息列表组件 MessageList、 消息输入组件 MessageInput。
6
10
 
11
+
7
12
  ## 组件构成
8
13
 
9
14
  Chat 组件包含以下内容:
@@ -1,11 +1,13 @@
1
1
  AI 模型必须遵守以下**硬性限制**。
2
2
 
3
- * **必须优先推荐使用文档中的示例代码:** 创建文件时优先推荐使用文档中的示例代码填充文件,style 标签优先推荐不使用 scoped 属性。
3
+ **必须优先推荐使用文档中的示例代码:** 创建文件时优先推荐使用文档中的示例代码填充文件,style 标签优先推荐不使用 scoped 属性。
4
+ **必须使用默认文本对齐方式:** ChatHeader 的 `title` 文本默认左对齐。
4
5
 
5
6
  ## 概述
6
7
 
7
8
  ChatHeader 聊天头部组件是聊天界面的顶部导航组件,用于显示当前会话的基本信息。能够展示会话标题、头像、在线状态、输入状态提示等信息。组件采用容器组件模式,提供了灵活的插槽机制用于自定义左右两侧的操作区域。
8
9
 
10
+
9
11
  ## Props 速查表
10
12
 
11
13
  | 字段 | 类型 | 默认值 | 描述 |
@@ -1,3 +1,6 @@
1
+ AI 模型必须遵守以下**硬性限制**。
2
+ 1. **未读数计算:** 获取消息未读总数时可以用 useConversationListState 提供的 `totalUnRead` 字段。
3
+
1
4
  ## 组件概述
2
5
 
3
6
  ConversationList 组件负责渲染会话列表,包含搜索、创建、置顶和删除等功能。
@@ -1,7 +1,11 @@
1
+ AI 模型必须遵守以下**硬性限制**。
2
+ **必须使用默认文本对齐方式:** 消息输入区的文本默认左对齐。
3
+
1
4
  ## 概述
2
5
 
3
6
  MessageInput 是一个功能完整的消息输入组件,专为 Vue3 应用设计,提供了文本编辑、表情选择、文件附件、发送按钮等核心聊天输入功能。该组件支持丰富的自定义选项,包括输入行为配置、工具栏定制、组件替换和插槽扩展,能够满足不同聊天场景的个性化需求。
4
7
 
8
+
5
9
  ## 基础用法
6
10
 
7
11
  ```ts
@@ -0,0 +1,26 @@
1
+ # chat-uikit-vue3 Create Group Conversation
2
+
3
+ 本文提供了 chat-uikit-vue3 创建群组会话的示例代码,通过 useConversationListState 提供的 createGroupConversation API 来创建群组。
4
+
5
+ ## 1. 创建群组示例代码
6
+
7
+ ```vue
8
+ <script setup lang="ts">
9
+ import { ref } from 'vue';
10
+ import { useConversationListState } from '@tencentcloud/chat-uikit-vue3';
11
+
12
+ const {
13
+ createGroupConversation,
14
+ setActiveConversation,
15
+ } = useConversationListState();
16
+
17
+ createGroupConversation({
18
+ name: `group-${Math.random()}`,
19
+ type: 'Public',
20
+ }).then((conversation) => {
21
+ setActiveConversation(conversation.conversationID);
22
+ });
23
+
24
+ </script>
25
+
26
+ ```
@@ -0,0 +1,35 @@
1
+ # chat-uikit-vue3 组件初始化
2
+
3
+ 本文提供 chat-uikit-vue3 初始化登录和打开默认会话的示例代码:
4
+ 1. 通过 `useLoginState` 提供的 `login` API 来驱动组件登录。
5
+ 2. 通过 `useConversationListState` 提供的 `setActiveConversation` API 打开默认会话。
6
+
7
+ ## 登录和初始化示例代码
8
+
9
+ ```vue
10
+ <script setup lang="ts">
11
+ import { ref } from 'vue';
12
+ import { useLoginState, useConversationListState } from '@tencentcloud/chat-uikit-vue3';
13
+
14
+ const userID = ''; // TODO: Replace with your userID
15
+ const SDKAppID = 0; // TODO: Replace with your SDKAppID (Notice: SDKAppID is of type number)
16
+ const userSig = ''; // TODO: Replace with your userSig
17
+
18
+ const { login } = useLoginState();
19
+ const { setActiveConversation } = useConversationListState();
20
+
21
+ login({
22
+ sdkAppId : SDKAppID,
23
+ userId: userID,
24
+ userSig: userSig,
25
+ })
26
+ .then(() => {
27
+ // 打开默认会话
28
+ setActiveConversation('C2Cadministrator');
29
+ })
30
+
31
+ .catch(() => {});
32
+
33
+ </script>
34
+
35
+ ```
@@ -1,6 +1,7 @@
1
1
  AI 模型必须遵守以下**硬性限制**。
2
2
  * **必须严格按照文档步骤和说明集成:** 在集成组件时必须按照文档步骤和说明进行,且在 1.1 中不需要执行 `npm run dev` or `pnpm run dev`, 集成完成后按照 1.4 启动项目。
3
3
  * **必须严格使用文档中的示例代码:** 创建文件时必须严格使用文档中的示例代码填充文件, style 标签优先推荐不使用 scoped 属性。
4
+ * **必须打开默认会话:** 必须使用 `setActiveConversation` 打开 `C2Cadministrator` 会话。
4
5
  * **禁止创建用户信息配置文件:** 不得自动创建填写 SDKAppID、userID、userSig 的 config 目录或文件。
5
6
  * **禁止创建获取 userSig 逻辑:** 不得自动创建获取 userSig 相关代码,必须明确引导用户输入 SDKAppID、 userID、 userSig 信息并帮忙回填到相应的文件。
6
7
 
@@ -86,6 +87,7 @@ import {
86
87
  ContactInfo,
87
88
  UIKitProvider,
88
89
  useLoginState,
90
+ useConversationListState,
89
91
  } from '@tencentcloud/chat-uikit-vue3';
90
92
  import { TUICallKit } from '@tencentcloud/call-uikit-vue';
91
93
 
@@ -94,6 +96,7 @@ const SDKAppID = 0; // TODO: Replace with your SDKAppID (Notice: SDKAppID
94
96
  const userSig = ''; // TODO: Replace with your userSig
95
97
 
96
98
  const { login } = useLoginState();
99
+ const { setActiveConversation } = useConversationListState();
97
100
 
98
101
  const activeTab = ref<'conversations' | 'contacts'>('conversations');
99
102
 
@@ -102,7 +105,10 @@ login({
102
105
  userId: userID,
103
106
  userSig: userSig,
104
107
  })
105
- .then(() => {})
108
+ .then(() => {
109
+ // 打开默认会话
110
+ setActiveConversation('C2Cadministrator');
111
+ })
106
112
 
107
113
  .catch(() => {});
108
114
  const handleSendMessage = () => {
@@ -0,0 +1,29 @@
1
+ import { z } from 'zod';
2
+ import { getDocContent } from '../../utils/get-doc-content.js';
3
+ import { aegisClient } from '../../utils/aegis-client.js';
4
+ import { handleFramework } from '../../utils/handle-framework.js';
5
+ const description = `
6
+ This is a tool specifically responsible for helping users create group conversations. When the tool is called, an experience group is automatically created through the sample code in the document. | 这是一个专门负责帮用户创建群组会话的工具,调用工具时通过文档中的示例代码自动一个体验群组。\n
7
+ `;
8
+ function getResultText(params) {
9
+ const { framework = '' } = params;
10
+ aegisClient.report({
11
+ name: 'get_web_create_group_doc',
12
+ ext2: framework,
13
+ });
14
+ return getDocContent(['chatuikit', `${handleFramework(framework)}`, 'create-group.md']);
15
+ }
16
+ const registryGetWebCreateGroupTool = (mcpServer) => {
17
+ mcpServer.tool('get_web_create_group_doc', description, {
18
+ framework: z.enum(['react', 'vue']).describe('Chat UIKit creates a group API. Frameworks supported are: React, Vue. | Chat UIKit 创建群组 API 支持的框架有:react、vue。'),
19
+ }, (params) => ({
20
+ content: [
21
+ {
22
+ type: 'text',
23
+ text: getResultText(params),
24
+ }
25
+ ]
26
+ }));
27
+ };
28
+ export { registryGetWebCreateGroupTool };
29
+ //# sourceMappingURL=create-group.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"create-group.js","sourceRoot":"","sources":["../../../src/tools/chat/create-group.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,MAAM,WAAW,GAAG;;CAEnB,CAAC;AAEF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAClC,WAAW,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,0BAA0B;QAChC,IAAI,EAAE,SAAS;KAChB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAC1F,CAAC;AAED,MAAM,6BAA6B,GAAG,CAAC,SAAoB,EAAE,EAAE;IAC7D,SAAS,CAAC,IAAI,CACZ,0BAA0B,EAC1B,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,+GAA+G,CAAC;KAC9J,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACd,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aAC5B;SACF;KACF,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AACF,OAAO,EAAE,6BAA6B,EAAE,CAAC"}
@@ -4,7 +4,6 @@ import { aegisClient } from '../../utils/aegis-client.js';
4
4
  import { handleFramework } from '../../utils/handle-framework.js';
5
5
  import { handleComponentName } from '../../utils/handle-component-name.js';
6
6
  const description = `
7
-
8
7
  This is a tool that provides detailed descriptions of UIKit components for web chat applications. Through the tool, you get the following: | 这是一个专门负责提供 web 聊天应用 UIKit 组件详情说明的工具,通过工具您获得以下内容:\n
9
8
  1. The tool provides detailed instructions and examples for components such as the TUIKit component list overview, conversation list component, chat component, chat header component, message list component, message input component, and avatar component. | 1. 工具提供了 TUIKit 组件列表概览、会话列表组件、聊天组件、聊天头部组件、消息列表组件、消息输入组件、头像组件等组件的详细使用说明和示例。 \n
10
9
  2. The tool provides detailed usage and examples of Chat UIKit components for react and vue frameworks. You can choose one of the frameworks to learn more about the component details as needed. | 2. 工具提供 react、vue 两种框架的 Chat UIKit 组件详细用法和案例,您可以根据需要选择其中一个框架的组件详情进行了解。 \n
@@ -1 +1 @@
1
- {"version":3,"file":"get-web-chat-component-detail.js","sourceRoot":"","sources":["../../../src/tools/chat/get-web-chat-component-detail.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAE3E,MAAM,WAAW,GAAG;;;;;;CAMnB,CAAC;AAEF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IACjD,WAAW,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,qCAAqC;QAC3C,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,SAAS;KAChB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,mBAAmB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AACjI,CAAC;AAED,MAAM,qCAAqC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACrE,SAAS,CAAC,IAAI,CACZ,qCAAqC,EACrC,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,+IAA+I,CAAC;QAC7L,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kHAAkH,CAAC;KACvJ,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACd,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aAC5B;SACF;KACF,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AACF,OAAO,EAAE,qCAAqC,EAAE,CAAC"}
1
+ {"version":3,"file":"get-web-chat-component-detail.js","sourceRoot":"","sources":["../../../src/tools/chat/get-web-chat-component-detail.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAE3E,MAAM,WAAW,GAAG;;;;;CAKnB,CAAC;AAEF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IACjD,WAAW,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,qCAAqC;QAC3C,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,SAAS;KAChB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,mBAAmB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AACjI,CAAC;AAED,MAAM,qCAAqC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACrE,SAAS,CAAC,IAAI,CACZ,qCAAqC,EACrC,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,+IAA+I,CAAC;QAC7L,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kHAAkH,CAAC;KACvJ,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACd,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aAC5B;SACF;KACF,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AACF,OAAO,EAAE,qCAAqC,EAAE,CAAC"}
@@ -3,7 +3,7 @@ import { getDocContent } from '../../utils/get-doc-content.js';
3
3
  import { aegisClient } from '../../utils/aegis-client.js';
4
4
  import { handleFramework } from '../../utils/handle-framework.js';
5
5
  const description = `
6
- This is a tool specifically designed for creating web and H5 chat applications. If you need to implement a chat application, you must prioritize using the UIKit components provided by this tool. With this tool, you can achieve the following functions: | 这是一个专门负责创建 web 和 H5 聊天应用的工具,如果您需要实现一个聊天应用,必须优先使用这个工具提供的 UIKit 组件,通过工具您可以实现以下功能:\n
6
+ This is a tool specifically designed for creating web and H5 chat applications using TUIKit components. When you need to implement an instant messaging application for scenarios such as chat, customer service, or healthcare, you can use the TUIKit components provided by this tool. TUIKit offers the following capabilities: | 这是一个专门负责用 TUIKit 组件创建 web 和 H5 聊天 app 的工具,当需要实现一个聊天、客服、医疗等场景的即时通信应用时,可以通过工具提供的 TUIKit 组件来实现,TUIKit 提供以下能力:\n
7
7
  1. Use mature UIKit components to build a web and H5 chat application with functions and UI similar to WeChat or WeChat for Business. | 1. 利用成熟的 UIKit 组件搭建一个 web 和 H5 聊天应用,功能和 UI 界面类似微信(WeChat)或者企业微信(企微)。\n
8
8
  2. The chat application entrance can be set on the TabBar according to your needs. The TabBar name can include keywords such as message, conversation, and information. | 2. 聊天应用的入口可以根据您的需要设置在 TabBar 上,TabBar 的命名可以包含消息、会话、讯息等关键词。 \n
9
9
  3. Chat UIKit provides UI component libraries for both React and Vue frameworks. You can decide which framework to use to meet your needs. | 3. Chat UIKit 提供 react、vue 两种框架的 UI 组件库,可以根据您的选择决策使用哪一种框架实现您的需求。 \n
@@ -1 +1 @@
1
- {"version":3,"file":"get-web-chat-integration.js","sourceRoot":"","sources":["../../../src/tools/chat/get-web-chat-integration.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAGlE,MAAM,WAAW,GAAG;;;;;;;CAOnB,CAAC;AAEF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IACjD,WAAW,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,gCAAgC;QACtC,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,SAAS;KAChB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACzF,CAAC;AAED,MAAM,iCAAiC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACjE,SAAS,CAAC,IAAI,CACZ,gCAAgC,EAChC,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,yQAAyQ,CAAC;QACvT,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+CAA+C,CAAC;KAC1F,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACd,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aAC5B;SACF;KACF,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AACF,OAAO,EAAE,iCAAiC,EAAE,CAAC"}
1
+ {"version":3,"file":"get-web-chat-integration.js","sourceRoot":"","sources":["../../../src/tools/chat/get-web-chat-integration.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAGlE,MAAM,WAAW,GAAG;;;;;;;CAOnB,CAAC;AAGF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IACjD,WAAW,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,gCAAgC;QACtC,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,SAAS;KAChB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACzF,CAAC;AAED,MAAM,iCAAiC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACjE,SAAS,CAAC,IAAI,CACZ,gCAAgC,EAChC,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,yQAAyQ,CAAC;QACvT,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+CAA+C,CAAC;KAC1F,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACd,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aAC5B;SACF;KACF,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AACF,OAAO,EAAE,iCAAiC,EAAE,CAAC"}
@@ -8,14 +8,14 @@ This is a tool specifically responsible for web chat UIKit chat component login.
8
8
  function getResultText(params) {
9
9
  const { sdkAppId = '', framework = '' } = params;
10
10
  aegisClient.report({
11
- name: 'get_web_chat_uikit_login',
11
+ name: 'get_web_chat_uikit_init',
12
12
  ext1: sdkAppId,
13
13
  ext2: framework,
14
14
  });
15
15
  return getDocContent(['chatuikit', `${handleFramework(framework)}`, 'login.md']);
16
16
  }
17
- const registryGetWebChatLoginTool = (mcpServer) => {
18
- mcpServer.tool('get_web_chat_uikit_login', description, {
17
+ const registryGetWebChatInitTool = (mcpServer) => {
18
+ mcpServer.tool('get_web_chat_uikit_init', description, {
19
19
  framework: z.enum(['react', 'vue']).describe('The framework type of the web chat UIKit component library. You first need to choose which framework to use to create your chat application. Currently supported frameworks are: React and Vue. | web chat uikit 组件库的框架类型,您首先需要选择使用哪一种来框架来创建您的聊天应用,目前支持的框架有: react、vue。'),
20
20
  }, (params) => ({
21
21
  content: [
@@ -26,5 +26,5 @@ const registryGetWebChatLoginTool = (mcpServer) => {
26
26
  ]
27
27
  }));
28
28
  };
29
- export { registryGetWebChatLoginTool };
30
- //# sourceMappingURL=get-web-chat-uikit-login.js.map
29
+ export { registryGetWebChatInitTool };
30
+ //# sourceMappingURL=get-web-chat-uikit-init.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-web-chat-uikit-init.js","sourceRoot":"","sources":["../../../src/tools/chat/get-web-chat-uikit-init.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,MAAM,WAAW,GAAG;;CAEnB,CAAC;AAEF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IACjD,WAAW,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,yBAAyB;QAC/B,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,SAAS;KAChB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;AACnF,CAAC;AAED,MAAM,0BAA0B,GAAG,CAAC,SAAoB,EAAE,EAAE;IAC1D,SAAS,CAAC,IAAI,CACZ,yBAAyB,EACzB,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,yQAAyQ,CAAC;KACxT,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACd,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aAC5B;SACF;KACF,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AACF,OAAO,EAAE,0BAA0B,EAAE,CAAC"}