tuikit-atomicx-vue3 4.4.0-beta.1 → 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,8 +1,76 @@
 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
+ * @memberof module:LoginState
+ * @description 提供用户登录、登出、个人信息管理等功能
+ * @returns {Object} 返回登录状态管理对象
+ * @returns {Ref<LoginUserInfo | null>} returns.loginUserInfo - 当前登录用户信息
+ * @returns {Function} returns.login - 登录函数
+ * @returns {Function} returns.logout - 登出函数
+ * @returns {Function} returns.setSelfInfo - 设置个人信息函数
+ * @example
+ * ```typescript
+ * const { loginUserInfo, login, logout, setSelfInfo } = useLoginState();
+ *
+ * // 登录
+ * await login({ userId: 'user123', userSig: 'sig', sdkAppId: 123456 });
+ *
+ * // 设置个人信息
+ * await setSelfInfo({ nick: '新昵称' });
+ *
+ * // 登出
+ * await logout();
+ * ```
+ */
 export declare function useLoginState(): {
     loginUserInfo: import('vue').Ref<{
         userId: string;

package/dist/states/LoginState.js

@@ -1,69 +1,64 @@
 import { ref as c } from "vue";
-import { TUILogin as i } from "@tencentcloud/tui-core";
-import { dataReport as f } from "../report/dataReport.js";
-import { MetricsKey as u } from "../report/MetricsKey.js";
-import { useStatistical as g } from "../statistical/statistical.js";
-import { isMobile as m } from "../utils/env.js";
-const a = c(null), { getChatScene: I } = g();
-async function S(r) {
+import { TUILogin as u } from "@tencentcloud/tui-core";
+import { useStatistical as i } from "../statistical/statistical.js";
+const s = c(null), { getChatScene: f } = i();
+async function g(r) {
   if (!r.userId || !r.userSig || !r.sdkAppId)
     throw new Error("[loginState login] params error");
-  const { userId: l, userSig: e, sdkAppId: n, ...o } = r, s = {
+  const { userId: l, userSig: t, sdkAppId: n, ...e } = r, a = {
     SDKAppID: n,
     userID: l,
-    userSig: e,
+    userSig: t,
     useUploadPlugin: !0,
-    scene: I(),
-    ...o
+    scene: f(),
+    ...e
   };
   try {
-    await i.login(s);
-    const t = m ? u.T_METRICS_STATE_API_LOGIN_MOBILE_COUNT : u.T_METRICS_STATE_API_LOGIN_COUNT;
-    f.reportCount(t);
-  } catch (t) {
-    throw console.error("[loginState login] error", t), t;
+    await u.login(a);
+  } catch (o) {
+    throw console.error("[loginState login] error", o), o;
   }
 }
-async function _(r) {
-  const l = a.value || {}, { chat: e } = i.getContext();
-  if (e) {
+async function m(r) {
+  const l = s.value || {}, { chat: t } = u.getContext();
+  if (t) {
     const n = [];
-    r.customInfo && Object.keys(r.customInfo).forEach((o) => {
-      var t;
-      let s = o;
-      o.includes("Tag_Profile_Custom") || (s = `Tag_Profile_Custom_${o}`), n.push({
-        key: s,
-        value: (t = r.customInfo) == null ? void 0 : t[o]
+    r.customInfo && Object.keys(r.customInfo).forEach((e) => {
+      var o;
+      let a = e;
+      e.includes("Tag_Profile_Custom") || (a = `Tag_Profile_Custom_${e}`), n.push({
+        key: a,
+        value: (o = r.customInfo) == null ? void 0 : o[e]
       });
     });
     try {
-      const o = await e.updateMyProfile({
+      const e = await t.updateMyProfile({
         nick: r.userName,
         avatar: r.avatarUrl,
         profileCustomField: n
       });
-      return a.value = {
+      return s.value = {
         ...l,
         ...r
-      }, o;
-    } catch (o) {
-      throw console.error("[loginState setSelfInfo] error", o), o;
+      }, e;
+    } catch (e) {
+      throw console.error("[loginState setSelfInfo] error", e), e;
     }
   } else
     throw Error("[loginState setSelfInfo] not login");
 }
-async function p() {
-  a.value = null, i.logout();
+async function I() {
+  s.value = null, u.logout();
 }
-function w() {
+function p() {
   return {
-    loginUserInfo: a,
-    login: S,
-    logout: p,
-    setSelfInfo: _
+    loginUserInfo: s,
+    login: g,
+    logout: I,
+    setSelfInfo: m
   };
 }
 export {
-  w as default,
-  w as useLoginState
+  p as default,
+  p as useLoginState
 };

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 };