tuikit-atomicx-vue3 4.4.0 → 4.5.0

package/dist/states/LiveSeatState/store.d.ts

@@ -14,13 +14,11 @@ export declare function useSeatStore(): {
     seatList: Ref<SeatInfo[], SeatInfo[]>;
     speakingUsers: Ref<Map<string, number> & Omit<Map<string, number>, keyof Map<any, any>>, Map<string, number> | (Map<string, number> & Omit<Map<string, number>, keyof Map<any, any>>)>;
     networkQualities: Ref<Map<string, {
-        userId: string;
         quality: import('../..').NetworkQuality;
         upLoss: number;
         downLoss: number;
         delay: number;
     }> & Omit<Map<string, NetworkInfo>, keyof Map<any, any>>, Map<string, NetworkInfo> | (Map<string, {
-        userId: string;
         quality: import('../..').NetworkQuality;
         upLoss: number;
         downLoss: number;

package/dist/states/LiveSeatState/usePlayStream/RTCStreamManager.js

@@ -1,16 +1,16 @@
 var v = Object.defineProperty;
 var I = (c, a, t) => a in c ? v(c, a, { enumerable: !0, configurable: !0, writable: !0, value: t }) : c[a] = t;
-var o = (c, a, t) => I(c, typeof a != "symbol" ? a + "" : a, t);
+var l = (c, a, t) => I(c, typeof a != "symbol" ? a + "" : a, t);
 import { TUIVideoStreamType as y } from "@tencentcloud/tuiroom-engine-js";
+import { useLoginState as g } from "../../LoginState.js";
 import M from "./RTCStreamPlayer.js";
-import { useLoginState as S } from "../../LoginState.js";
-import { useVideoMixerState as g } from "../../VideoMixerState/VideoMixerState.js";
-import { DeviceStatus as l } from "../../../types/device.js";
-const { loginUserInfo: m } = S(), { isVideoMixerEnabled: f } = g(), n = class n {
+import { isVideoMixerEnabled as m } from "../../VideoMixerState/VideoMixerState.js";
+import { DeviceStatus as o } from "../../../types/device.js";
+const { loginUserInfo: f } = g(), n = class n {
   constructor() {
-    o(this, "containerView", null);
-    o(this, "view", null);
-    o(this, "playerMap", /* @__PURE__ */ new Map());
+    l(this, "containerView", null);
+    l(this, "view", null);
+    l(this, "playerMap", /* @__PURE__ */ new Map());
     if (n.rtcStreamManager)
       return n.rtcStreamManager;
     n.rtcStreamManager = this;
@@ -26,9 +26,9 @@ const { loginUserInfo: m } = S(), { isVideoMixerEnabled: f } = g(), n = class n
     }
     r.forEach(async (e) => {
       var u, p;
-      if (e.userId === ((u = m.value) == null ? void 0 : u.userId) && f.value)
+      if (e.userId === ((u = f.value) == null ? void 0 : u.userId) && m.value)
         return;
-      if (e.cameraStatus === l.On) {
+      if (e.cameraStatus === o.On) {
         if (this.playerMap.has(e.userId)) {
           (p = this.playerMap.get(e.userId)) == null || p.updateRect(e.rect);
           return;
@@ -48,7 +48,7 @@ const { loginUserInfo: m } = S(), { isVideoMixerEnabled: f } = g(), n = class n
     const { userList: t } = a;
     t.forEach(async (r) => {
       var e;
-      if (!(r.userId === ((e = m.value) == null ? void 0 : e.userId) && f.value) && r.cameraStatus === l.On && !this.playerMap.has(r.userId)) {
+      if (!(r.userId === ((e = f.value) == null ? void 0 : e.userId) && m.value) && r.cameraStatus === o.On && !this.playerMap.has(r.userId)) {
         const i = new M({
           userId: r.userId,
           streamType: y.kCameraStream,
@@ -60,7 +60,7 @@ const { loginUserInfo: m } = S(), { isVideoMixerEnabled: f } = g(), n = class n
     }), [...this.playerMap.keys()].forEach((r) => {
       var e, i;
       const s = t.find((d) => d.userId === r);
-      (!s || s.cameraStatus === l.Off) && ((e = this.playerMap.get(r)) == null || e.destroy(), this.playerMap.delete(r)), (i = this.playerMap.get(r)) == null || i.updateRect(s == null ? void 0 : s.rect);
+      (!s || s.cameraStatus === o.Off) && ((e = this.playerMap.get(r)) == null || e.destroy(), this.playerMap.delete(r)), (i = this.playerMap.get(r)) == null || i.updateRect(s == null ? void 0 : s.rect);
     });
   }
   async stop() {
@@ -70,7 +70,7 @@ const { loginUserInfo: m } = S(), { isVideoMixerEnabled: f } = g(), n = class n
     }), this.playerMap.clear(), this.view = null, this.containerView = null;
   }
 };
-o(n, "rtcStreamManager", null);
+l(n, "rtcStreamManager", null);
 let w = n;
 export {
   w as RTCStreamManager

package/dist/states/LiveSeatState/usePlayStream/RTCStreamPlayer.js

@@ -1,12 +1,12 @@
 var y = Object.defineProperty;
 var m = (r, e, t) => e in r ? y(r, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : r[e] = t;
 var s = (r, e, t) => m(r, typeof e != "symbol" ? e + "" : e, t);
-import { TUIVideoStreamType as u, TRTCVideoFillMode as p, TRTCVideoRotation as T, TRTCVideoMirrorType as w } from "@tencentcloud/tuiroom-engine-js";
+import { TUIVideoStreamType as p, TRTCVideoFillMode as u, TRTCVideoRotation as T, TRTCVideoMirrorType as w } from "@tencentcloud/tuiroom-engine-js";
 import { useRoomEngine as V } from "../../../hooks/useRoomEngine.js";
 import { useLoginState as v } from "../../LoginState.js";
-import { useVideoMixerState as I } from "../../VideoMixerState/VideoMixerState.js";
-const a = V(), { loginUserInfo: h } = v(), { isVideoMixerEnabled: c } = I();
-class S {
+import { isVideoMixerEnabled as c } from "../../VideoMixerState/VideoMixerState.js";
+const a = V(), { loginUserInfo: h } = v();
+class P {
   constructor(e) {
     s(this, "userId");
     s(this, "streamType");
@@ -27,7 +27,7 @@ class S {
   async play() {
     var e, t, i, n, o, d;
     if (console.log("RTCStreamPlayer.play", this.isVideoPlaying, this.view), !this.isVideoPlaying && !(this.userId === ((e = h.value) == null ? void 0 : e.userId) && c.value))
-      if (this.userId === ((t = h.value) == null ? void 0 : t.userId) && this.streamType === u.kCameraStream)
+      if (this.userId === ((t = h.value) == null ? void 0 : t.userId) && this.streamType === p.kCameraStream)
         await ((i = a.instance) == null ? void 0 : i.setLocalVideoView({
           streamType: this.streamType,
           view: this.view.id
@@ -42,7 +42,7 @@ class S {
         await (l == null ? void 0 : l.setRemoteRenderParams(this.userId, this.streamType, {
           mirrorType: w.TRTCVideoMirrorType_Disable,
           rotation: T.TRTCVideoRotation0,
-          fillMode: p.TRTCVideoFillMode_Fill
+          fillMode: u.TRTCVideoFillMode_Fill
         })), await ((d = a.instance) == null ? void 0 : d.startPlayRemoteVideo({
           userId: this.userId,
           streamType: this.streamType
@@ -69,5 +69,5 @@ class S {
   }
 }
 export {
-  S as default
+  P as default
 };

package/dist/states/LiveSeatState/usePlayStream/index.d.ts

@@ -1,9 +1,6 @@
-declare function startPlayStream({ view }: {
-    view: string;
-}): Promise<void>;
-declare function stopPlayStream(): Promise<void>;
 export declare function usePlayStream(): {
-    startPlayStream: typeof startPlayStream;
-    stopPlayStream: typeof stopPlayStream;
+    startPlayStream: ({ view }: {
+        view: string;
+    }) => Promise<void>;
+    stopPlayStream: () => void;
 };
-export {};

package/dist/states/LiveSeatState/usePlayStream/index.js

@@ -1,61 +1,72 @@
-import { ref as i, watch as r } from "vue";
-import p, { TUIRoomEvents as I } from "@tencentcloud/tuiroom-engine-js";
-import { useRoomEngine as m } from "../../../hooks/useRoomEngine.js";
-import { MixStreamPlayer as h } from "./MixStreamPlayer.js";
-import { RTCStreamManager as y } from "./RTCStreamManager.js";
-import { useStreamPosition as O } from "./useStreamPostion.js";
-import { useLiveListState as R } from "../../LiveListState/LiveListState.js";
-import { DeviceStatus as d } from "../../../types/device.js";
-const E = m(), { positionList: c, createResizeObserver: C, deleteResizeObserver: S } = O(), { currentLive: U } = R(), a = i(!1), L = i(null), n = new h(), s = new y();
-let f = "";
-const l = i(null), u = i([]);
-async function T({ view: e }) {
-  var t, o;
-  f = e, a.value = !0, C({ view: e }), (t = l.value) != null && t.userId && ((o = l.value) == null ? void 0 : o.cameraStatus) === d.On ? await (n == null ? void 0 : n.start({ view: e, userInfo: l.value })) : u.value.length > 0 && await (s == null ? void 0 : s.start({ view: e, userList: u.value }));
-}
-r(c, (e) => {
-  u.value.forEach((t) => {
-    e.find((o) => o.userId === t.userId) && (t.rect = e.find((o) => o.userId === t.userId));
-  }), a.value && u.value.length > 0 && s.update({ userList: u.value });
-});
-async function V() {
-  n == null || n.stop(), s == null || s.stop(), L.value = null, a.value = !1, f = "", S();
-}
-function b(e) {
-  const { userId: t, hasVideo: o } = e;
-  t.indexOf("livekit_") === 0 ? l.value = o ? {
-    userId: t,
-    cameraStatus: d.On
-  } : null : o ? u.value.push({ userId: t, cameraStatus: d.On, rect: c.value.find((v) => v.userId === t) }) : u.value = u.value.filter((v) => v.userId !== t);
-}
-r(() => l.value, (e) => {
-  a.value && (e ? n.start({ view: f, userInfo: l.value }) : n.stop());
-});
-r(
-  () => u.value.length,
-  (e, t) => {
-    a.value && (t === 0 && e > 0 && (s == null || s.start({ view: f, userList: u.value })), t > 0 && e === 0 && (s == null || s.stop()));
-  }
-);
-r(
-  () => {
-    var e;
-    return (e = U.value) == null ? void 0 : e.liveId;
+import { ref as v, watch as c } from "vue";
+import C, { TUIRoomEvents as U } from "@tencentcloud/tuiroom-engine-js";
+import { useRoomEngine as w } from "../../../hooks/useRoomEngine.js";
+import { MixStreamPlayer as L } from "./MixStreamPlayer.js";
+import { RTCStreamManager as T } from "./RTCStreamManager.js";
+import { useStreamPosition as V } from "./useStreamPostion.js";
+import { useLiveListState as b } from "../../LiveListState/LiveListState.js";
+import { DeviceStatus as m } from "../../../types/device.js";
+let I = !1, p = {
+  startPlayStream: async ({ view: i }) => {
   },
-  (e) => {
-    e || (l.value = null, u.value = []);
+  stopPlayStream: () => {
   }
-);
-p.once("ready", () => {
-  var e;
-  (e = E.instance) == null || e.on(I.onUserVideoStateChanged, b);
-});
-function g() {
+};
+function z() {
+  if (I)
+    return p;
+  const i = w(), { positionList: r, createResizeObserver: y, deleteResizeObserver: h } = V(), { currentLive: S } = b(), o = v(!1), P = v(null), n = new L(), s = new T();
+  let f = "";
+  const l = v(null), u = v([]);
+  async function R({ view: e }) {
+    var t, a;
+    f = e, o.value = !0, y({ view: e }), (t = l.value) != null && t.userId && ((a = l.value) == null ? void 0 : a.cameraStatus) === m.On ? await (n == null ? void 0 : n.start({ view: e, userInfo: l.value })) : u.value.length > 0 && await (s == null ? void 0 : s.start({ view: e, userList: u.value }));
+  }
+  c(r, (e) => {
+    u.value.forEach((t) => {
+      e.find((a) => a.userId === t.userId) && (t.rect = e.find((a) => a.userId === t.userId));
+    }), o.value && u.value.length > 0 && s.update({ userList: u.value });
+  });
+  async function O() {
+    n == null || n.stop(), s == null || s.stop(), P.value = null, o.value = !1, f = "", h();
+  }
+  function E(e) {
+    const { userId: t, hasVideo: a } = e;
+    t.indexOf("livekit_") === 0 ? l.value = a ? {
+      userId: t,
+      cameraStatus: m.On
+    } : null : a ? u.value.push({ userId: t, cameraStatus: m.On, rect: r.value.find((d) => d.userId === t) }) : u.value = u.value.filter((d) => d.userId !== t);
+  }
+  return c(() => l.value, (e) => {
+    o.value && (e ? n.start({ view: f, userInfo: l.value }) : n.stop());
+  }), c(
+    () => u.value.length,
+    (e, t) => {
+      o.value && (t === 0 && e > 0 && (s == null || s.start({ view: f, userList: u.value })), t > 0 && e === 0 && (s == null || s.stop()));
+    }
+  ), c(
+    () => {
+      var e;
+      return (e = S.value) == null ? void 0 : e.liveId;
+    },
+    (e) => {
+      e || (l.value = null, u.value = []);
+    }
+  ), C.once("ready", () => {
+    var e;
+    (e = i.instance) == null || e.on(U.onUserVideoStateChanged, E);
+  }), I = !0, p = {
+    startPlayStream: R,
+    stopPlayStream: O
+  }, p;
+}
+function A() {
+  const { startPlayStream: i, stopPlayStream: r } = z();
   return {
-    startPlayStream: T,
-    stopPlayStream: V
+    startPlayStream: i,
+    stopPlayStream: r
   };
 }
 export {
-  g as usePlayStream
+  A as usePlayStream
 };

package/dist/states/LoginState.d.ts

@@ -1,7 +1,52 @@
 import { LoginParams, LoginUserInfo, SetSelfInfoParams } from '../types/login';
 
+/**
+ * 用户登录函数
+ * @memberof module:LoginState
+ * @description 使用提供的参数登录到 TUI 系统
+ * @param {LoginParams} options - 登录参数
+ * @param {string} options.userId - 用户ID
+ * @param {string} options.userSig - 用户签名
+ * @param {number} options.sdkAppId - SDK应用ID
+ * @throws {Error} 当参数不完整时抛出错误
+ * @example
+ * ```typescript
+ * await login({
+ *   userId: 'user123',
+ *   userSig: 'signature',
+ *   sdkAppId: 123456
+ * });
+ * ```
+ */
 declare function login(options: LoginParams): Promise<void>;
+/**
+ * 设置用户个人信息
+ * @memberof module:LoginState
+ * @description 更新当前登录用户的个人资料信息
+ * @param {SetSelfInfoParams} options - 用户信息参数
+ * @param {string} [options.nick] - 用户昵称
+ * @param {string} [options.avatar] - 用户头像URL
+ * @param {Record<string, any>} [options.customInfo] - 自定义信息
+ * @throws {Error} 当用户未登录时抛出错误
+ * @example
+ * ```typescript
+ * await setSelfInfo({
+ *   nick: '新昵称',
+ *   avatar: 'https://example.com/avatar.jpg',
+ *   customInfo: { level: 5 }
+ * });
+ * ```
+ */
 declare function setSelfInfo(options: SetSelfInfoParams): Promise<void>;
+/**
+ * 用户登出函数
+ * @memberof module:LoginState
+ * @description 退出当前用户的登录状态，清空用户信息
+ * @example
+ * ```typescript
+ * await logout();
+ * ```
+ */
 declare function logout(): Promise<void>;
 /**
  * 用户登录状态管理 Hook

package/dist/states/MessageActionState/MessageActionState.d.ts

@@ -88,8 +88,42 @@ interface IForwardMessageParams {
     useOfflinePush?: boolean;
 }
 /**
- * Use message action store
- * For managing message-related operations such as forwarding, quoting, copying, etc.
+ * 消息操作状态管理 Hook
+ * @memberof module:MessageActionState
+ * @description 提供消息相关的操作功能，包括转发、引用、复制、删除、撤回等
+ * @returns {IMessageActionState & IMessageActionAction} 返回消息操作状态管理对象
+ * @returns {Ref<string[]>} returns.forwardMessageIDList - 待转发的消息ID列表
+ * @returns {Ref<boolean>} returns.isForwardMessageSelectionDone - 转发消息选择是否完成
+ * @returns {Ref<string[]>} returns.forwardConversationIDList - 转发目标会话ID列表
+ * @returns {Ref<MessageModel | undefined>} returns.quotedMessage - 被引用的消息
+ * @returns {Function} returns.setForwardMessageIDList - 设置转发消息ID列表函数
+ * @returns {Function} returns.forwardMessage - 转发消息函数
+ * @returns {Function} returns.quoteMessage - 引用消息函数
+ * @returns {Function} returns.copyTextMessage - 复制文本消息函数
+ * @returns {Function} returns.deleteMessage - 删除消息函数
+ * @returns {Function} returns.recallMessage - 撤回消息函数
+ * @example
+ * ```typescript
+ * const {
+ *   forwardMessageIDList,
+ *   quotedMessage,
+ *   forwardMessage,
+ *   quoteMessage,
+ *   copyTextMessage
+ * } = useMessageActionState();
+ *
+ * // 引用消息
+ * quoteMessage(message);
+ *
+ * // 转发消息
+ * await forwardMessage({
+ *   messageIDList: ['msg1', 'msg2'],
+ *   conversationIDList: ['conv1', 'conv2']
+ * });
+ *
+ * // 复制消息文本
+ * copyTextMessage(message);
+ * ```
  */
 declare function useMessageActionState(): IMessageActionState & IMessageActionAction;
 export { useMessageActionState };

package/dist/states/MessageActionState/MessageActionState.js

@@ -31,8 +31,17 @@ function C() {
     quotedMessage: i,
     // Action methods
     /**
-     * Set forward message ID list
-     * @param messageIDList - Message IDs to forward
+     * 设置转发消息ID列表
+     * @memberof module:MessageActionState
+     * @description 设置要转发的消息ID列表，会与现有列表合并去重
+     * @param {string[]} messageIDList - 要转发的消息ID数组
+     * @example
+     * ```typescript
+     * const { setForwardMessageIDList } = useMessageActionState();
+     * 
+     * // 设置要转发的消息ID
+     * setForwardMessageIDList(['msg1', 'msg2', 'msg3']);
+     * ```
      */
     setForwardMessageIDList(e) {
       t.value = [
@@ -40,15 +49,33 @@ function C() {
       ];
     },
     /**
-     * Set message selection completion status
-     * @param isSelectionDone - Boolean indicating whether message selection is complete
+     * 设置消息选择完成状态
+     * @memberof module:MessageActionState
+     * @description 设置转发消息选择是否完成的状态
+     * @param {boolean} isSelectionDone - 是否完成消息选择
+     * @example
+     * ```typescript
+     * const { setIsForwardMessageSelectionDone } = useMessageActionState();
+     * 
+     * // 标记消息选择完成
+     * setIsForwardMessageSelectionDone(true);
+     * ```
      */
     setIsForwardMessageSelectionDone(e) {
       n.value = e;
     },
     /**
-     * Set forward target conversation ID list
-     * @param conversationIDList - Conversation IDs to forward to
+     * 设置转发目标会话ID列表
+     * @memberof module:MessageActionState
+     * @description 设置消息转发的目标会话ID列表，会与现有列表合并去重
+     * @param {string[]} conversationIDList - 目标会话ID数组
+     * @example
+     * ```typescript
+     * const { setForwardConversationIDList } = useMessageActionState();
+     * 
+     * // 设置转发目标会话
+     * setForwardConversationIDList(['conv1', 'conv2']);
+     * ```
      */
     setForwardConversationIDList(e) {
       o.value = [
@@ -56,16 +83,44 @@ function C() {
       ];
     },
     /**
-     * Forward messages to specified conversations
-     * @param params - Forward message parameters
-     * @returns Results of the forward operation
+     * 转发消息到指定会话
+     * @memberof module:MessageActionState
+     * @description 将选中的消息转发到指定的会话中，支持合并转发和逐条转发
+     * @param {IForwardMessageParams} params - 转发消息参数
+     * @param {string[]} params.messageIDList - 要转发的消息ID列表
+     * @param {string[]} params.conversationIDList - 目标会话ID列表
+     * @param {boolean} params.isMergeForward - 是否合并转发
+     * @returns {Promise<Array<PromiseSettledResult<unknown>>>} 转发操作的结果数组
+     * @example
+     * ```typescript
+     * const { forwardMessage } = useMessageActionState();
+     * 
+     * // 合并转发消息
+     * const results = await forwardMessage({
+     *   messageIDList: ['msg1', 'msg2'],
+     *   conversationIDList: ['conv1', 'conv2'],
+     *   isMergeForward: true
+     * });
+     * ```
      */
     forwardMessage(e) {
       return I(e);
     },
     /**
-     * Quote a message
-     * @param message - Message to quote
+     * 引用消息
+     * @memberof module:MessageActionState
+     * @description 设置要引用的消息，引用后可以在发送新消息时显示被引用的消息内容
+     * @param {MessageModel | undefined} message - 要引用的消息对象，传入undefined表示取消引用
+     * @example
+     * ```typescript
+     * const { quoteMessage } = useMessageActionState();
+     * 
+     * // 引用一条消息
+     * quoteMessage(messageModel);
+     * 
+     * // 取消引用
+     * quoteMessage(undefined);
+     * ```
      */
     quoteMessage(e) {
       a.update(u.CHAT, "quoteMessage", {
@@ -74,7 +129,16 @@ function C() {
       }), i.value = e;
     },
     /**
-     * Clear quoted message
+     * 清除引用消息
+     * @memberof module:MessageActionState
+     * @description 清除当前引用的消息，取消引用状态
+     * @example
+     * ```typescript
+     * const { clearQuotedMessage } = useMessageActionState();
+     * 
+     * // 清除引用消息
+     * clearQuotedMessage();
+     * ```
      */
     clearQuotedMessage() {
       a.update(u.CHAT, "quoteMessage", {
@@ -83,9 +147,26 @@ function C() {
       }), i.value = void 0;
     },
     /**
-     * Copy text message content to clipboard
-     * @param message - Message to copy
-     * @returns Result of the copy operation
+     * 复制文本消息内容到剪贴板
+     * @memberof module:MessageActionState
+     * @description 将文本消息的内容复制到系统剪贴板，会自动处理表情符号转换
+     * @param {MessageModel} message - 要复制的消息对象
+     * @returns {Promise<boolean>} 复制操作的结果，成功返回true，失败返回false
+     * @throws {Error} 当消息不是文本类型或复制失败时抛出错误
+     * @example
+     * ```typescript
+     * const { copyTextMessage } = useMessageActionState();
+     * 
+     * // 复制文本消息
+     * try {
+     *   const success = await copyTextMessage(textMessage);
+     *   if (success) {
+     *     console.log('消息已复制到剪贴板');
+     *   }
+     * } catch (error) {
+     *   console.error('复制失败:', error);
+     * }
+     * ```
      */
     copyTextMessage(e) {
       return w(
@@ -93,23 +174,62 @@ function C() {
       );
     },
     /**
-     * Delete a message
-     * @param message - Message to delete
-     * @returns Result of the delete operation
+     * 删除消息
+     * @memberof module:MessageActionState
+     * @description 删除指定的消息，删除后消息将从会话中移除
+     * @param {MessageModel} message - 要删除的消息对象
+     * @returns {Promise<unknown>} 删除操作的结果Promise
+     * @throws {Error} 当删除操作失败时抛出错误
+     * @example
+     * ```typescript
+     * const { deleteMessage } = useMessageActionState();
+     * 
+     * // 删除消息
+     * try {
+     *   await deleteMessage(messageModel);
+     *   console.log('消息删除成功');
+     * } catch (error) {
+     *   console.error('删除消息失败:', error);
+     * }
+     * ```
      */
     deleteMessage(e) {
       return e.deleteMessage();
     },
     /**
-     * Revoke a message
-     * @param message - Message to revoke
-     * @returns Result of the revoke operation
+     * 撤回消息
+     * @memberof module:MessageActionState
+     * @description 撤回已发送的消息，撤回后消息将显示为"已撤回"状态
+     * @param {MessageModel} message - 要撤回的消息对象
+     * @returns {Promise<unknown>} 撤回操作的结果Promise
+     * @throws {Error} 当撤回操作失败时抛出错误（如超过撤回时限）
+     * @example
+     * ```typescript
+     * const { recallMessage } = useMessageActionState();
+     * 
+     * // 撤回消息
+     * try {
+     *   await recallMessage(messageModel);
+     *   console.log('消息撤回成功');
+     * } catch (error) {
+     *   console.error('撤回消息失败:', error);
+     * }
+     * ```
      */
     recallMessage(e) {
       return e.revokeMessage();
     },
     /**
-     * Reset message action state
+     * 重置消息操作状态
+     * @memberof module:MessageActionState
+     * @description 重置所有消息操作相关的状态，包括清除引用消息、转发消息列表等
+     * @example
+     * ```typescript
+     * const { resetMessageActionState } = useMessageActionState();
+     * 
+     * // 重置所有消息操作状态
+     * resetMessageActionState();
+     * ```
      */
     resetMessageActionState() {
       this.clearQuotedMessage(), t.value = [], n.value = !1, o.value = [];

package/dist/states/MessageListState/MessageListState.d.ts

@@ -20,5 +20,44 @@ interface MessageListBusinessAction {
         duration: number;
     }) => void;
 }
+/**
+ * 消息列表状态管理 Hook
+ * @memberof module:MessageListState
+ * @description 提供消息列表的状态管理和操作功能，包括消息加载、滚动控制、高亮显示等
+ * @returns {MessageListState & MessageListBusinessAction} 返回消息列表状态管理对象
+ * @returns {Ref<string>} returns.activeConversationID - 当前活跃会话ID
+ * @returns {Ref<MessageModel[]>} returns.messageList - 消息列表
+ * @returns {Ref<boolean>} returns.hasMoreOlderMessage - 是否有更多历史消息
+ * @returns {Ref<boolean>} returns.hasMoreNewerMessage - 是否有更多新消息
+ * @returns {Ref<boolean>} returns.enableReadReceipt - 是否启用已读回执
+ * @returns {Ref<boolean>} returns.isDisableScroll - 是否禁用滚动
+ * @returns {Ref<Set<string>>} returns.recalledMessageIDSet - 已撤回消息ID集合
+ * @returns {Ref<Set<string>>} returns.highlightMessageIDSet - 高亮消息ID集合
+ * @returns {Function} returns.loadMoreOlderMessage - 加载更多历史消息函数
+ * @returns {Function} returns.setEnableReadReceipt - 设置已读回执函数
+ * @returns {Function} returns.setIsDisableScroll - 设置滚动禁用函数
+ * @returns {Function} returns.highlightMessage - 高亮消息函数
+ * @example
+ * ```typescript
+ * const {
+ *   messageList,
+ *   hasMoreOlderMessage,
+ *   loadMoreOlderMessage,
+ *   highlightMessage,
+ *   setEnableReadReceipt
+ * } = useMessageListState();
+ *
+ * // 加载更多历史消息
+ * if (hasMoreOlderMessage.value) {
+ *   await loadMoreOlderMessage();
+ * }
+ *
+ * // 高亮消息
+ * highlightMessage({ messageID: 'msg123', duration: 3000 });
+ *
+ * // 启用已读回执
+ * setEnableReadReceipt(true);
+ * ```
+ */
 declare function useMessageListState(): MessageListState & MessageListBusinessAction;
 export { useMessageListState };

package/dist/states/RoomParticipantState/callEventManager.d.ts

@@ -0,0 +1,10 @@
+declare class CallEventManager {
+    static instance: CallEventManager;
+    constructor();
+    static getInstance(): CallEventManager;
+    private onInvitationAdded;
+    private onInvitationRemoved;
+    private onInvitationStatusChanged;
+    bindEvent(): void;
+}
+export default CallEventManager;