tuikit-atomicx-vue3 4.4.0 → 4.5.1

package/dist/states/ASRState/ASRState.d.ts

@@ -0,0 +1,61 @@
+import { Transcript } from '../../types/asr';
+
+/**
+ * ASR状态管理组合式函数
+ * @memberof module:ASRState
+ * @description 提供ASR语音识别状态管理的所有功能，包括转录消息的获取、历史记录管理和导出功能
+ * @returns {Object} ASR状态管理对象
+ * @returns {ComputedRef<Transcript[]>} returns.recentTranscripts - 最近的转录消息列表
+ * @returns {ComputedRef<Transcript[]>} returns.transcriptHistory - 完整的转录历史记录
+ * @returns {Function} returns.setRecentTranscriptsDuration - 设置最近消息时间窗口
+ * @returns {Function} returns.clearHistory - 清空转录历史记录
+ * @returns {Function} returns.exportTranscripts - 导出转录记录为文本
+ * @example
+ * ```typescript
+ * import { useASRState } from '@/states/ASRState';
+ *
+ * // 在Vue组件中使用
+ * export default {
+ *   setup() {
+ *     const {
+ *       recentTranscripts,
+ *       transcriptHistory,
+ *       setRecentTranscriptsDuration,
+ *       clearHistory,
+ *       exportTranscripts
+ *     } = useASRState();
+ *
+ *     // 设置最近消息窗口为5秒
+ *     setRecentTranscriptsDuration(5000);
+ *
+ *     // 监听转录消息变化
+ *     watch(recentTranscripts, (messages) => {
+ *       console.log('收到新的转录消息:', messages);
+ *     });
+ *
+ *     // 导出转录记录
+ *     const handleExport = () => {
+ *       const content = exportTranscripts();
+ *       if (content) {
+ *         // 下载文件逻辑
+ *         console.log('导出成功');
+ *       }
+ *     };
+ *
+ *     return {
+ *       recentTranscripts,
+ *       transcriptHistory,
+ *       clearHistory,
+ *       handleExport
+ *     };
+ *   }
+ * };
+ * ```
+ */
+export declare function useASRState(): {
+    recentTranscripts: import('vue').ComputedRef<Transcript[]>;
+    transcriptHistory: import('vue').ComputedRef<Transcript[]>;
+    setRecentTranscriptsDuration: (duration: number) => void;
+    clearHistory: () => void;
+    exportTranscripts: () => string;
+};

package/dist/states/ASRState/ASRState.js

@@ -0,0 +1,79 @@
+import { ref as c, computed as m } from "vue";
+import p from "@tencentcloud/tuiroom-engine-js";
+import { useRoomEngine as f } from "../../hooks/useRoomEngine.js";
+import { dataReport as v } from "../../report/dataReport.js";
+import { MetricsKey as E } from "../../report/MetricsKey.js";
+const C = f(), S = 1e4, u = c(3e3), i = c(/* @__PURE__ */ new Map()), D = (e) => {
+  const { sender: t, start_ms_ts: r, end_ms_ts: s, payload: n } = e, { end: o, text: a } = n;
+  return {
+    userId: t,
+    userName: "",
+    avatarUrl: "",
+    text: a,
+    startTime: r,
+    endTime: s,
+    end: o,
+    rawData: e
+  };
+}, _ = m(() => {
+  if (i.value.size === 0)
+    return [];
+  const e = Date.now(), r = Array.from(i.value.values()).filter((s) => e - s.endTime <= u.value);
+  return r.sort((s, n) => n.endTime - s.endTime), r;
+}), T = m(() => {
+  const e = Array.from(i.value.values());
+  return e.sort((t, r) => t.startTime !== r.startTime ? t.startTime - r.startTime : t.endTime - r.endTime), e;
+}), h = (e) => {
+  u.value = e;
+}, y = () => {
+  i.value.clear();
+}, R = () => {
+  const e = T.value;
+  if (e.length === 0)
+    return "";
+  const t = (/* @__PURE__ */ new Date()).toLocaleDateString("zh-CN", {
+    year: "numeric",
+    month: "long",
+    day: "numeric",
+    weekday: "long"
+  }), r = e.length > 0 ? new Date(e[0].startTime).toLocaleTimeString("zh-CN", { hour12: !1 }) : (/* @__PURE__ */ new Date()).toLocaleTimeString("zh-CN", { hour12: !1 });
+  let s = `${t} ${r}
+
+`;
+  return e.forEach((n) => {
+    const o = new Date(n.startTime).toLocaleTimeString("zh-CN", {
+      hour12: !1,
+      hour: "2-digit",
+      minute: "2-digit",
+      second: "2-digit"
+    }), a = n.userName || n.userId;
+    s += `[${o}] ${a}: ${n.text}
+`;
+  }), s;
+}, N = (e, t, r, s) => {
+  if (t !== 1)
+    return;
+  const n = JSON.parse(new TextDecoder().decode(s)), { type: o, payload: a } = n, { roundid: d, taskid: l } = a;
+  if (o !== S)
+    return;
+  const g = D(n);
+  i.value.set(d + l, g);
+}, w = () => {
+  var t;
+  ((t = C.instance) == null ? void 0 : t.getTRTCCloud()).on("onRecvCustomCmdMsg", N);
+};
+p.once("ready", () => {
+  w();
+});
+function $() {
+  return v.reportCount(E.T_METRICS_STATE_ASR_STATE_COUNT), {
+    recentTranscripts: _,
+    transcriptHistory: T,
+    setRecentTranscriptsDuration: h,
+    clearHistory: y,
+    exportTranscripts: R
+  };
+}
+export {
+  $ as useASRState
+};

package/dist/states/ASRState/index.d.ts

@@ -0,0 +1 @@
+export * from './ASRState';

package/dist/states/ASRState/index.js

@@ -0,0 +1,4 @@
+import { useASRState as o } from "./ASRState.js";
+export {
+  o as useASRState
+};

package/dist/states/BarrageState/BarrageState.d.ts

@@ -1,22 +1,71 @@
+import { BarrageType, Barrage } from '../../types/barrage';
 import { TUIUserInfo } from '@tencentcloud/tuiroom-engine-js';
 
-export declare enum BarrageType {
-    text = 0,
-    custom = 1
-}
-interface BaseMessageInfo {
-    liveId: string;
-    sender: TUIUserInfo;
-    sequence: number;
-    timestampInSecond: number;
-}
-export interface Barrage extends BaseMessageInfo {
-    messageType: BarrageType;
-    textContent?: string;
-    extensionInfo?: Record<string, string> | null;
-    businessId?: string;
-    data?: string;
-}
+/**
+ * 弹幕状态管理组合式函数
+ * @memberof module:BarrageState
+ * @description 提供弹幕功能的所有状态和操作方法，包括消息发送、接收和管理
+ * @returns {Object} 弹幕状态管理对象
+ * @returns {Ref<Barrage[]>} returns.messageList - 弹幕消息列表
+ * @returns {Function} returns.sendTextMessage - 发送文本弹幕消息
+ * @returns {Function} returns.sendCustomMessage - 发送自定义弹幕消息
+ * @returns {Function} returns.appendLocalTip - 添加本地提示消息
+ * @example
+ * ```typescript
+ * import { useBarrageState, BarrageType } from '@/states/BarrageState';
+ *
+ * // 在Vue组件中使用
+ * export default {
+ *   setup() {
+ *     const {
+ *       messageList,
+ *       sendTextMessage,
+ *       sendCustomMessage,
+ *       appendLocalTip
+ *     } = useBarrageState();
+ *
+ *     // 发送文本消息
+ *     const handleSendText = async (text: string) => {
+ *       try {
+ *         await sendTextMessage({ text });
+ *         console.log('消息发送成功');
+ *       } catch (error) {
+ *         console.error('消息发送失败:', error);
+ *       }
+ *     };
+ *
+ *     // 发送礼物消息
+ *     const handleSendGift = async (giftId: number, count: number) => {
+ *       await sendCustomMessage({
+ *         businessId: 'gift',
+ *         data: JSON.stringify({ giftId, count })
+ *       });
+ *     };
+ *
+ *     // 监听消息列表变化
+ *     watch(messageList, (messages) => {
+ *       console.log('当前消息数量:', messages.length);
+ *
+ *       // 处理最新消息
+ *       const latestMessage = messages[messages.length - 1];
+ *       if (latestMessage) {
+ *         if (latestMessage.messageType === BarrageType.text) {
+ *           console.log('新文本消息:', latestMessage.textContent);
+ *         } else if (latestMessage.messageType === BarrageType.custom) {
+ *           console.log('新自定义消息:', latestMessage.businessId);
+ *         }
+ *       }
+ *     });
+ *
+ *     return {
+ *       messageList,
+ *       handleSendText,
+ *       handleSendGift
+ *     };
+ *   }
+ * };
+ * ```
+ */
 export declare function useBarrageState(): {
     messageList: import('vue').Ref<{
         messageType: BarrageType;
@@ -25,18 +74,7 @@ export declare function useBarrageState(): {
         businessId?: string | undefined;
         data?: string | undefined;
         liveId: string;
-        sender: {
-            userId: string;
-            userName: string;
-            nameCard: string;
-            avatarUrl: string;
-            userRole: import('@tencentcloud/tuiroom-engine-js').TUIRole;
-            hasAudioStream: boolean;
-            hasVideoStream: boolean;
-            hasScreenStream: boolean;
-            isMessageDisabled: boolean;
-            roomCustomInfo: Record<string, any>;
-        };
+        sender: TUIUserInfo;
         sequence: number;
         timestampInSecond: number;
     }[], Barrage[] | {
@@ -46,29 +84,17 @@ export declare function useBarrageState(): {
         businessId?: string | undefined;
         data?: string | undefined;
         liveId: string;
-        sender: {
-            userId: string;
-            userName: string;
-            nameCard: string;
-            avatarUrl: string;
-            userRole: import('@tencentcloud/tuiroom-engine-js').TUIRole;
-            hasAudioStream: boolean;
-            hasVideoStream: boolean;
-            hasScreenStream: boolean;
-            isMessageDisabled: boolean;
-            roomCustomInfo: Record<string, any>;
-        };
+        sender: TUIUserInfo;
         sequence: number;
         timestampInSecond: number;
     }[]>;
     sendTextMessage: (options: {
         text: string;
         extensionInfo?: Record<string, string>;
-    }) => Promise<void> | undefined;
+    }) => any;
     sendCustomMessage: (options: {
         businessId: string;
         data: string;
-    }) => Promise<void> | undefined;
+    }) => any;
     appendLocalTip: (message: Barrage) => void;
 };
-export {};

package/dist/states/BarrageState/BarrageState.js

@@ -1,16 +1,15 @@
-import { ref as i, watch as d } from "vue";
-import m, { TUIRoomEvents as c } from "@tencentcloud/tuiroom-engine-js";
-import { useRoomEngine as v } from "../../hooks/useRoomEngine.js";
-import { dataReport as I } from "../../report/dataReport.js";
-import { MetricsKey as l } from "../../report/MetricsKey.js";
-import { useLoginState as f } from "../LoginState.js";
-import { useLiveListState as x } from "../LiveListState/LiveListState.js";
-const { loginUserInfo: s } = f();
-var p = /* @__PURE__ */ ((e) => (e[e.text = 0] = "text", e[e.custom = 1] = "custom", e))(p || {});
-const u = v(), { currentLive: T } = x(), a = i([]), E = (e) => {
+import { ref as d, watch as m } from "vue";
+import v, { TUIRoomEvents as i } from "@tencentcloud/tuiroom-engine-js";
+import { useRoomEngine as I } from "../../hooks/useRoomEngine.js";
+import { dataReport as l } from "../../report/dataReport.js";
+import { MetricsKey as f } from "../../report/MetricsKey.js";
+import { BarrageType as c } from "../../types/barrage.js";
+import { useLoginState as p } from "../LoginState.js";
+import { useLiveListState as T } from "../LiveListState/LiveListState.js";
+const { loginUserInfo: s } = p(), u = I(), { currentLive: x } = T(), o = d([]), E = (e) => {
   var n;
-  const t = l.T_METRICS_STATE_API_BARRAGE_SEND_TEXT_MSG_COUNT;
-  return I.reportCount(t), (n = u.instance) == null ? void 0 : n.sendTextMessage({
+  const t = f.T_METRICS_STATE_API_BARRAGE_SEND_TEXT_MSG_COUNT;
+  return l.reportCount(t), (n = u.instance) == null ? void 0 : n.sendTextMessage({
     textContent: e.text,
     extensionInfo: (e == null ? void 0 : e.extensionInfo) || {}
   });
@@ -21,60 +20,59 @@ const u = v(), { currentLive: T } = x(), a = i([]), E = (e) => {
     data: e.data
   });
 }, R = (e) => {
-  a.value.push(e);
+  o.value.push(e);
 }, S = (e) => {
-  var n, o, r;
+  var n, r, a;
   const t = { ...e.sender };
-  t.userId === ((n = s.value) == null ? void 0 : n.userId) && (t.userName = t.userName || ((o = s.value) == null ? void 0 : o.userName), t.avatarUrl = t.avatarUrl || ((r = s.value) == null ? void 0 : r.avatarUrl)), a.value.push({
+  t.userId === ((n = s.value) == null ? void 0 : n.userId) && (t.userName = t.userName || ((r = s.value) == null ? void 0 : r.userName), t.avatarUrl = t.avatarUrl || ((a = s.value) == null ? void 0 : a.avatarUrl)), o.value.push({
     liveId: e.roomId,
     sender: t,
     sequence: e.sequence,
     timestampInSecond: e.timestampInSecond,
-    messageType: 0,
+    messageType: c.text,
     textContent: e.textContent,
     extensionInfo: e.extensionInfo
   });
 }, C = (e) => {
-  var n, o, r;
+  var n, r, a;
   const t = { ...e.sender };
-  t.userId === ((n = s.value) == null ? void 0 : n.userId) && (t.userName = t.userName || ((o = s.value) == null ? void 0 : o.userName), t.avatarUrl = t.avatarUrl || ((r = s.value) == null ? void 0 : r.avatarUrl)), a.value.push({
+  t.userId === ((n = s.value) == null ? void 0 : n.userId) && (t.userName = t.userName || ((r = s.value) == null ? void 0 : r.userName), t.avatarUrl = t.avatarUrl || ((a = s.value) == null ? void 0 : a.avatarUrl)), o.value.push({
     liveId: e.roomId,
     sender: t,
     sequence: e.sequence,
     timestampInSecond: e.timestampInSecond,
-    messageType: 1,
+    messageType: c.custom,
     businessId: e.businessId,
     data: e.data
   });
 }, U = [
-  { event: c.onReceiveTextMessage, handler: S },
-  { event: c.onReceiveCustomMessage, handler: C }
-], N = () => {
+  { event: i.onReceiveTextMessage, handler: S },
+  { event: i.onReceiveCustomMessage, handler: C }
+], g = () => {
   U.forEach(({ event: e, handler: t }) => {
     var n;
     (n = u.instance) == null || n.on(e, t);
   });
-}, _ = () => {
-  a.value = [];
+}, N = () => {
+  o.value = [];
 };
-d(() => {
+m(() => {
   var e;
-  return (e = T.value) == null ? void 0 : e.liveId;
+  return (e = x.value) == null ? void 0 : e.liveId;
 }, (e) => {
-  e || _();
+  e || N();
 });
-m.once("ready", () => {
-  N();
+v.once("ready", () => {
+  g();
 });
 function G() {
   return {
-    messageList: a,
+    messageList: o,
     sendTextMessage: E,
     sendCustomMessage: M,
     appendLocalTip: R
   };
 }
 export {
-  p as BarrageType,
   G as useBarrageState
 };

package/dist/states/BarrageState/index.js

@@ -1,5 +1,4 @@
-import { BarrageType as a, useBarrageState as t } from "./BarrageState.js";
+import { useBarrageState as a } from "./BarrageState.js";
 export {
-  a as BarrageType,
-  t as useBarrageState
+  a as useBarrageState
 };

package/dist/states/BattleState/BattleState.d.ts

@@ -1,5 +1,101 @@
 import { BattleEvent, DeviceStatus, BattleConfig, BattleInfo, SeatUserInfo } from '../../types';
 
+/**
+ * PK状态管理组合式函数
+ * @memberof module:BattleState
+ * @description 提供直播PK功能的所有状态和操作方法，包括PK邀请、接受、拒绝、退出以及事件监听
+ * @returns {Object} PK状态管理对象
+ * @returns {Ref<BattleInfo | undefined>} returns.currentBattleInfo - 当前PK信息
+ * @returns {Ref<SeatUserInfo[]>} returns.battleUsers - PK参与用户列表
+ * @returns {Ref<Map<string, number>>} returns.battleScore - PK积分映射
+ * @returns {Function} returns.subscribeEvent - 订阅PK事件
+ * @returns {Function} returns.unsubscribeEvent - 取消订阅PK事件
+ * @returns {Function} returns.requestBattle - 发起PK邀请
+ * @returns {Function} returns.cancelBattleRequest - 取消PK邀请
+ * @returns {Function} returns.acceptBattle - 接受PK邀请
+ * @returns {Function} returns.rejectBattle - 拒绝PK邀请
+ * @returns {Function} returns.exitBattle - 退出PK
+ * @example
+ * ```typescript
+ * import { useBattleState, BattleEvent } from '@/states/BattleState';
+ *
+ * // 在Vue组件中使用
+ * export default {
+ *   setup() {
+ *     const {
+ *       currentBattleInfo,
+ *       battleUsers,
+ *       battleScore,
+ *       subscribeEvent,
+ *       unsubscribeEvent,
+ *       requestBattle,
+ *       acceptBattle,
+ *       rejectBattle,
+ *       exitBattle
+ *     } = useBattleState();
+ *
+ *     // 监听PK事件
+ *     const handleBattleEvents = () => {
+ *       // PK开始事件
+ *       subscribeEvent(BattleEvent.onBattleStarted, (eventInfo) => {
+ *         console.log('PK开始:', eventInfo.battleInfo);
+ *         console.log('参与者:', eventInfo.inviter, eventInfo.invitees);
+ *       });
+ *
+ *       // PK结束事件
+ *       subscribeEvent(BattleEvent.onBattleEnded, (eventInfo) => {
+ *         console.log('PK结束:', eventInfo.reason);
+ *       });
+ *
+ *       // 积分变化事件
+ *       subscribeEvent(BattleEvent.onBattleScoreChanged, (eventInfo) => {
+ *         console.log('积分更新:', battleScore.value);
+ *       });
+ *     };
+ *
+ *     // 发起PK
+ *     const startBattle = async (targetUserId: string) => {
+ *       try {
+ *         await requestBattle({
+ *           config: {
+ *             duration: 300, // 5分钟
+ *             needResponse: true,
+ *             extensionInfo: { type: 'singing' }
+ *           },
+ *           userIdList: [targetUserId],
+ *           timeout: 30
+ *         });
+ *       } catch (error) {
+ *         console.error('发起PK失败:', error);
+ *       }
+ *     };
+ *
+ *     // 处理PK邀请
+ *     subscribeEvent(BattleEvent.onBattleRequestReceived, async (eventInfo) => {
+ *       const { battleId, inviter } = eventInfo;
+ *       const shouldAccept = confirm(`是否接受来自 ${inviter.userName} 的PK邀请？`);
+ *
+ *       if (shouldAccept) {
+ *         await acceptBattle({ battleId });
+ *       } else {
+ *         await rejectBattle({ battleId });
+ *       }
+ *     });
+ *
+ *     onMounted(() => {
+ *       handleBattleEvents();
+ *     });
+ *
+ *     return {
+ *       currentBattleInfo,
+ *       battleUsers,
+ *       battleScore,
+ *       startBattle
+ *     };
+ *   }
+ * };
+ * ```
+ */
 export declare function useBattleState(): {
     currentBattleInfo: import('vue').Ref<BattleInfo | undefined, BattleInfo | undefined>;
     battleUsers: import('vue').Ref<{
@@ -28,18 +124,18 @@ export declare function useBattleState(): {
         config: BattleConfig;
         userIdList: string[];
         timeout: number;
-    }) => Promise<any> | undefined;
+    }) => any;
     cancelBattleRequest: (options: {
         battleId: string;
         userIdList: string[];
-    }) => Promise<void> | undefined;
+    }) => any;
     acceptBattle: (options: {
         battleId: string;
-    }) => Promise<void> | undefined;
+    }) => any;
     rejectBattle: (options: {
         battleId: string;
-    }) => Promise<void> | undefined;
+    }) => any;
     exitBattle: (options: {
         battleId: string;
-    }) => Promise<void> | undefined;
+    }) => any;
 };

package/dist/states/C2CSettingState/C2CSettingState.d.ts

@@ -1,5 +1,19 @@
 import { Ref } from 'vue';
 
+/**
+ * C2C设置状态接口
+ * @memberof module:C2CSettingState
+ * @description 定义C2C聊天设置的状态属性
+ * @interface C2CSettingState
+ * @property {Ref<string | undefined>} userID - 用户ID
+ * @property {Ref<string | undefined>} nick - 用户昵称
+ * @property {Ref<string | undefined>} avatar - 用户头像URL
+ * @property {Ref<string | undefined>} signature - 用户个性签名
+ * @property {Ref<string | undefined>} remark - 好友备注名
+ * @property {Ref<boolean | undefined>} isMuted - 是否静音会话
+ * @property {Ref<boolean | undefined>} isPinned - 是否置顶会话
+ * @property {Ref<boolean | undefined>} isContact - 是否为好友关系
+ */
 interface C2CSettingState {
     userID: Ref<string | undefined>;
     nick: Ref<string | undefined>;
@@ -10,10 +24,103 @@ interface C2CSettingState {
     isPinned: Ref<boolean | undefined>;
     isContact: Ref<boolean | undefined>;
 }
+/**
+ * C2C设置业务操作接口
+ * @memberof module:C2CSettingState
+ * @description 定义C2C聊天设置的业务操作方法
+ * @interface C2CSettingBusinessAction
+ * @property {Function} setChatPinned - 设置会话置顶状态
+ * @property {Function} setChatMuted - 设置会话静音状态
+ * @property {Function} setUserRemark - 设置用户备注名
+ */
 interface C2CSettingBusinessAction {
     setChatPinned: (value: boolean) => void;
     setChatMuted: (value: boolean) => void;
     setUserRemark: (remark: string) => void;
 }
+/**
+ * C2C设置状态管理组合式函数
+ * @memberof module:C2CSettingState
+ * @description 提供C2C聊天设置的所有状态和操作方法，包括用户信息、会话设置和好友关系管理
+ * @returns {C2CSettingState & C2CSettingBusinessAction} C2C设置状态管理对象
+ * @returns {Ref<string | undefined>} returns.userID - 用户ID
+ * @returns {Ref<string | undefined>} returns.nick - 用户昵称
+ * @returns {Ref<string | undefined>} returns.avatar - 用户头像URL
+ * @returns {Ref<string | undefined>} returns.signature - 用户个性签名
+ * @returns {Ref<string | undefined>} returns.remark - 好友备注名
+ * @returns {Ref<boolean | undefined>} returns.isMuted - 会话静音状态
+ * @returns {Ref<boolean | undefined>} returns.isPinned - 会话置顶状态
+ * @returns {Ref<boolean | undefined>} returns.isContact - 好友关系状态
+ * @returns {Function} returns.setChatPinned - 设置会话置顶状态
+ * @returns {Function} returns.setChatMuted - 设置会话静音状态
+ * @returns {Function} returns.setUserRemark - 设置用户备注名
+ * @example
+ * ```typescript
+ * import { useC2CSettingState } from '@/states/C2CSettingState';
+ *
+ * // 在Vue组件中使用
+ * export default {
+ *   setup() {
+ *     const {
+ *       userID,
+ *       nick,
+ *       avatar,
+ *       signature,
+ *       remark,
+ *       isMuted,
+ *       isPinned,
+ *       isContact,
+ *       setChatPinned,
+ *       setChatMuted,
+ *       setUserRemark
+ *     } = useC2CSettingState();
+ *
+ *     // 监听用户信息变化
+ *     watch([userID, nick], ([userID, nick]) => {
+ *       if (userID && nick) {
+ *         console.log(`当前聊天对象: ${nick} (${userID})`);
+ *       }
+ *     });
+ *
+ *     // 切换置顶状态
+ *     const togglePin = () => {
+ *       setChatPinned(!isPinned.value);
+ *     };
+ *
+ *     // 切换静音状态
+ *     const toggleMute = () => {
+ *       setChatMuted(!isMuted.value);
+ *     };
+ *
+ *     // 更新备注名
+ *     const updateRemark = (newRemark: string) => {
+ *       if (isContact.value) {
+ *         setUserRemark(newRemark);
+ *       } else {
+ *         console.log('只能为好友设置备注');
+ *       }
+ *     };
+ *
+ *     // 获取显示名称（优先显示备注，其次昵称，最后用户ID）
+ *     const displayName = computed(() => {
+ *       return remark.value || nick.value || userID.value || '未知用户';
+ *     });
+ *
+ *     return {
+ *       userID,
+ *       displayName,
+ *       avatar,
+ *       signature,
+ *       isMuted,
+ *       isPinned,
+ *       isContact,
+ *       togglePin,
+ *       toggleMute,
+ *       updateRemark
+ *     };
+ *   }
+ * };
+ * ```
+ */
 declare function useC2CSettingState(): C2CSettingState & C2CSettingBusinessAction;
 export { useC2CSettingState, };