@tencentcloud/sdk-mcp 1.3.1 → 1.3.3

package/resource/doc/roomkit/vue/states/room-participant-state.md

@@ -1,307 +0,0 @@
-# Room Participant State Documentation
-
-Room 房间列表 State API 文档。
-
-## 安装依赖
-
-您可以选择以下任一方式安装依赖：
-【npm】
-``` bash
-npm install tuikit-atomicx-vue3@latest --save
-```
-【pnpm】
-``` bash
-pnpm add tuikit-atomicx-vue3@latest
-```
-【yarn】
-``` bash
-yarn add tuikit-atomicx-vue3@latest
-```
-
-## Enums
-
-### DeviceType
-设备类型枚举
-
-```typescript
-export enum DeviceType {
-  Microphone = "Microphone",    // 麦克风
-  Camera = "Camera",            // 摄像头
-  ScreenShare = "ScreenShare",  // 屏幕共享
-}
-```
-
-### DeviceStatus
-设备状态枚举
-
-```typescript
-export enum DeviceStatus {
-  On = "On",    // 开启
-  Off = "Off",  // 关闭
-}
-```
-
-### NetworkQuality
-网络质量枚举
-
-```typescript
-export enum NetworkQuality {
-  Unknown = 0,    // 未知
-  Excellent = 1,  // 优秀
-  Good = 2,       // 良好
-  Poor = 3,       // 较差
-  Bad = 4,        // 差
-  VeryBad = 5,    // 很差
-  Down = 6,       // 断开
-}
-```
-
-### ParticipantRole
-参与者角色枚举
-
-```typescript
-export enum ParticipantRole {
-  Owner = 0,        // 房主
-  Admin = 1,        // 管理员
-  GeneralUser = 2,  // 普通用户
-}
-```
-
-### KickedOutOfRoomReason
-被踢出房间原因枚举
-
-```typescript
-export enum KickedOutOfRoomReason {
-  KickedByAdmin = "KickedByAdmin",                          // 被管理员踢出
-  ReplacedByAnotherDevice = "ReplacedByAnotherDevice",      // 被其他设备替换
-  KickedByServer = "KickedByServer",                        // 被服务器踢出
-  ConnectionTimeout = "ConnectionTimeout",                   // 连接超时
-  InvalidStatusOnReconnect = "InvalidStatusOnReconnect",    // 重连时状态无效
-  RoomLimitExceeded = "RoomLimitExceeded",                  // 房间人数超限
-}
-```
-
-## Interfaces
-
-### NetworkInfo
-网络信息接口
-
-```typescript
-export interface NetworkInfo {
-  quality: NetworkQuality;  // 网络质量
-  upLoss: number;          // 上行丢包率
-  downLoss: number;        // 下行丢包率
-  delay: number;           // 延迟
-}
-```
-
-### RoomParticipant
-房间参与者信息（继承自 RoomUser）
-
-```typescript
-export interface RoomParticipant extends RoomUser {
-  nameCard: string;                        // 名片/昵称
-  role: ParticipantRole;                   // 角色
-  microphoneStatus: DeviceStatus;          // 麦克风状态
-  cameraStatus: DeviceStatus;              // 摄像头状态
-  screenShareStatus: DeviceStatus;         // 屏幕共享状态
-  isMessageDisabled: boolean;              // 是否禁用消息
-  metaData: Record<string, string>;        // 元数据
-}
-```
-
-### DeviceRequestInfo
-设备请求信息
-
-```typescript
-export interface DeviceRequestInfo {
-  timestamp: number;          // 时间戳
-  senderUserId: string;       // 发送者用户ID
-  senderUserName: string;     // 发送者用户名
-  senderNameCard: string;     // 发送者名片
-  senderAvatarURL: string;    // 发送者头像URL
-  content: string;            // 请求内容
-  deviceType: DeviceType;     // 设备类型
-}
-```
-
-## IRoomParticipantState Interface
-
-房间参与者状态管理接口
-
-### Properties
-
-```typescript
-export interface IRoomParticipantState {
-  participantList: RoomParticipant[];                    // 参与者列表
-  participantListCursor: string;                         // 参与者列表游标
-  participantListWithVideo: RoomParticipant[];           // 开启视频的参与者列表
-  participantWithScreen: RoomParticipant | null;         // 正在屏幕共享的参与者
-  pendingDeviceApplications: DeviceRequestInfo[];        // 待处理的设备申请
-  pendingDeviceInvitations: DeviceRequestInfo[];         // 待处理的设备邀请
-  speakingUsers: Map<string, number>;                    // 正在说话的用户（用户ID -> 音量）
-  networkQualities: Map<string, NetworkInfo>;            // 网络质量信息（用户ID -> 网络信息）
-  
-  readonly localParticipant: RoomParticipant | null;     // 本地参与者信息（只读）
-}
-```
-
-### Methods
-
-#### 参与者管理
-
-- **getParticipantList(options: { cursor?: string, count?: number }): Promise<RoomParticipant[]>**
-  - 获取参与者列表
-
-#### 角色管理
-
-- **transferOwner(options: { userId: string }): Promise<void>**
-  - 转让房主权限
-
-- **setAdmin(options: { userId: string }): Promise<void>**
-  - 设置管理员
-
-- **revokeAdmin(options: { userId: string }): Promise<void>**
-  - 撤销管理员权限
-
-- **kickParticipant(options: { userId: string }): Promise<void>**
-  - 踢出参与者
-
-#### 参与者信息管理
-
-- **updateParticipantNameCard(options: { userId: string, nameCard: string }): Promise<void>**
-  - 更新参与者名片
-
-- **updateParticipantMetaData(options: { userId: string, metaData: Record<string, string> }): Promise<void>**
-  - 更新参与者元数据
-
-#### 设备控制
-
-- **closeParticipantDevice(options: { userId: string, deviceType: DeviceType }): Promise<void>**
-  - 关闭参与者设备
-
-- **muteParticipantMessage(options: { userId: string, mute: boolean }): Promise<void>**
-  - 禁言/解禁参与者
-
-- **disableAllDevices(options: { deviceType: DeviceType, disable: boolean }): Promise<void>**
-  - 禁用/启用所有设备
-
-- **disableAllMessages(options: { disable: boolean }): Promise<void>**
-  - 禁用/启用所有消息
-
-#### 设备请求管理
-
-- **requestToOpenDevice(options: { device: DeviceType; timeout?: number }): Promise<void>**
-  - 请求开启设备
-
-- **cancelOpenDeviceRequest(options: { device: DeviceType }): Promise<void>**
-  - 取消设备开启请求
-
-- **approveOpenDeviceRequest(options: { device: DeviceType; userId: string }): Promise<void>**
-  - 批准设备开启请求
-
-- **rejectOpenDeviceRequest(options: { device: DeviceType; userId: string; }): Promise<void>**
-  - 拒绝设备开启请求
-
-#### 设备邀请管理
-
-- **inviteToOpenDevice(options: { device: DeviceType; userId: string; timeout?: number }): Promise<void>**
-  - 邀请开启设备
-
-- **cancelOpenDeviceInvitation(options: { device: DeviceType; userId: string }): Promise<void>**
-  - 取消设备开启邀请
-
-- **acceptOpenDeviceInvitation(options: {device: DeviceType; userId: string; }): Promise<void>**
-  - 接受设备开启邀请
-
-- **declineOpenDeviceInvitation(options: {device: DeviceType; userId: string; }): Promise<void>**
-  - 拒绝设备开启邀请
-
-### Event Handlers
-
-#### 参与者状态事件
-
-- **onParticipantJoined: (options: { participant: RoomParticipant }) => void**
-  - 参与者加入时触发
-
-- **onParticipantLeft: (options: { participant: RoomParticipant }) => void**
-  - 参与者离开时触发
-
-#### 角色变更事件
-
-- **onOwnerChanged: (options: { newOwner: RoomParticipant }) => void**
-  - 房主变更时触发
-
-- **onAdminSet: (options: { userInfo: RoomParticipant }) => void**
-  - 设置管理员时触发
-
-- **onAdminRevoked: (options: { userInfo: RoomParticipant }) => void**
-  - 撤销管理员时触发
-
-#### 房间管理事件
-
-- **onKickedFromRoom: (options: { reason: KickedOutOfRoomReason, message: string }) => void**
-  - 被踢出房间时触发
-
-#### 设备控制事件
-
-- **onParticipantDeviceClosed: (options: { userId: string, device: DeviceType, operator: RoomUser }) => void**
-  - 参与者设备被关闭时触发
-
-- **onParticipantMessageMuted: (options: { userId: string, muted: boolean, operator: RoomUser }) => void**
-  - 参与者被禁言/解禁时触发
-
-- **onAllDevicesDisabled: (options: { device: DeviceType, disable: boolean, operator: RoomUser }) => void**
-  - 所有设备被禁用/启用时触发
-
-- **onAllMessagesDisabled: (options: { disable: boolean, operator: RoomUser }) => void**
-  - 所有消息被禁用/启用时触发
-
-#### 设备请求事件
-
-- **onDeviceRequestReceived: (options: { request: DeviceRequestInfo }) => void**
-  - 收到设备请求时触发
-
-- **onDeviceRequestCancelled: (options: { request: DeviceRequestInfo }) => void**
-  - 设备请求被取消时触发
-
-- **onDeviceRequestTimeout: (options: { request: DeviceRequestInfo }) => void**
-  - 设备请求超时时触发
-
-- **onDeviceRequestApproved: (options: { request: DeviceRequestInfo, operator: RoomUser }) => void**
-  - 设备请求被批准时触发
-
-- **onDeviceRequestRejected: (options: { request: DeviceRequestInfo, operator: RoomUser }) => void**
-  - 设备请求被拒绝时触发
-
-- **onDeviceRequestProcessed: (options: { request: DeviceRequestInfo, operator: RoomUser }) => void**
-  - 设备请求被处理时触发
-
-#### 设备邀请事件
-
-- **onDeviceInvitationReceived: (options: { invitation: DeviceRequestInfo }) => void**
-  - 收到设备邀请时触发
-
-- **onDeviceInvitationCancelled: (options: { invitation: DeviceRequestInfo }) => void**
-  - 设备邀请被取消时触发
-
-- **onDeviceInvitationTimeout: (options: { invitation: DeviceRequestInfo }) => void**
-  - 设备邀请超时时触发
-
-- **onDeviceInvitationAccepted: (options: { invitation: DeviceRequestInfo, operator: RoomUser }) => void**
-  - 设备邀请被接受时触发
-
-- **onDeviceInvitationDeclined: (options: { invitation: DeviceRequestInfo, operator: RoomUser }) => void**
-  - 设备邀请被拒绝时触发
-
-### Example
-
-API 和事件使用示例
-```typescript
-import { useRoomParticipantState } from 'tuikit-atomicx-vue3';
-const {
-  getParticipantList,
-    subscribeEvent,
-  unsubscribeEvent
-} = useRoomParticipantState();
-```

package/tools/definitions/get_web_room_state_detail_def.js

@@ -1,19 +0,0 @@
-const TOOL_DESCRIPTION = `
-【核心用途】：专用于查询 Web Room TUIKit State API，用于提供 Web Room TUIKit 组件中 State API 的详细使用说明和示例代码。\n
-
-【功能】：提供房间列表、房间成员、设备、登录等 State API 的用法和示例。\n
-
-【关键词】：'Web', 'Room', '房间', 'TUIKit', 'State API', '状态管理', 'Vue', '房间列表', '房间成员', '设备', '登录'。\n
-
-【支持框架】：目前仅支持 Vue 框架。
-`;
-const PARAMETER_DESCRIPTIONS = {
-    framework: 'Web Room TUIKit State API 支持的框架类型。目前仅支持 Vue。',
-    componentName: 'Web Room TUIKit 组件的具体 State 名称，例如：room-list-state。'
-};
-export const GET_WEB_ROOM_STATE_DETAIL_DEFINITION = {
-    name: 'get_web_room_state_detail',
-    description: TOOL_DESCRIPTION,
-    parameter_descriptions: PARAMETER_DESCRIPTIONS,
-};
-//# sourceMappingURL=get_web_room_state_detail_def.js.map

package/tools/definitions/get_web_room_state_detail_def.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get_web_room_state_detail_def.js","sourceRoot":"","sources":["../../../src/tools/definitions/get_web_room_state_detail_def.ts"],"names":[],"mappings":"AAAA,MAAM,gBAAgB,GAAG;;;;;;;;CAQxB,CAAC;AAEF,MAAM,sBAAsB,GAAG;IAC7B,SAAS,EAAE,8CAA8C;IACzD,aAAa,EAAE,oDAAoD;CACpE,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG;IAClD,IAAI,EAAE,2BAA2B;IACjC,WAAW,EAAE,gBAAgB;IAC7B,sBAAsB,EAAE,sBAAsB;CAC/C,CAAC"}

package/tools/room/get-web-room-state-detail.js

@@ -1,31 +0,0 @@
-import { z } from 'zod';
-import { GET_WEB_ROOM_STATE_DETAIL_DEFINITION } from '../definitions/get_web_room_state_detail_def.js';
-import { getDocContent } from '../../utils/get-doc-content.js';
-import { reportCLSClient } from '../../utils/report-cls-client.js';
-import { handleFramework } from '../../utils/handle-framework.js';
-import { handleStateName } from '../../utils/handle-state-name.js';
-function getResultText(params) {
-    const { framework, componentName = '' } = params;
-    reportCLSClient({
-        method: 'get_web_room_state_detail',
-        info: componentName,
-        framework: framework,
-    });
-    return getDocContent(['roomkit', `${handleFramework(framework)}`, 'states', `${handleStateName(componentName)}.md`]);
-}
-const registryGetWebRoomStateDetailTool = (mcpServer) => {
-    const { name, description, parameter_descriptions } = GET_WEB_ROOM_STATE_DETAIL_DEFINITION;
-    mcpServer.tool(name, description, {
-        framework: z.enum(['vue']).describe(parameter_descriptions.framework),
-        componentName: z.string().describe(parameter_descriptions.componentName),
-    }, (params) => ({
-        content: [
-            {
-                type: 'text',
-                text: getResultText(params),
-            }
-        ]
-    }));
-};
-export { registryGetWebRoomStateDetailTool };
-//# sourceMappingURL=get-web-room-state-detail.js.map

package/tools/room/get-web-room-state-detail.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-web-room-state-detail.js","sourceRoot":"","sources":["../../../src/tools/room/get-web-room-state-detail.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,oCAAoC,EAAE,MAAM,iDAAiD,CAAC;AACvG,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAEnE,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IACjD,eAAe,CAAC;QACd,MAAM,EAAE,2BAA2B;QACnC,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,SAAS,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AACvH,CAAC;AAED,MAAM,iCAAiC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACjE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,sBAAsB,EAAE,GAAG,oCAAoC,CAAC;IAC3F,SAAS,CAAC,IAAI,CACZ,IAAI,EACJ,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC;QACrE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC;KACzE,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"}