@realsee/live 0.5.0-alpha.9 → 0.5.2-dev.2

package/dist/live/controller.d.ts

@@ -2,7 +2,7 @@ import { LiveMsg } from '../typings';
 import { LiveState } from '../typings/live/LiveState';
 import { RobustWebSocketEventDetail } from '../utils/RobustWebSocket';
 import { Subscribe } from '../utils/subscribe';
-export declare type LiveControllerEventMap = {
+export type LiveControllerEventMap = {
     stateChange: (state: LiveState, prevState: LiveState) => void;
     message: (message: LiveMsg) => void;
     reconnected: (detail: RobustWebSocketEventDetail) => void;

package/dist/live/createLive.d.ts

@@ -5,4 +5,4 @@ import { Live } from './live';
  * @param opts
  * @returns
  */
-export declare const createLive: <KeyframesSnapshot>(opts: LiveOptions) => Live<KeyframesSnapshot>;
+export declare const createLive: <KeyframesSnapshot extends Record<string, any>>(opts: LiveOptions) => Live<KeyframesSnapshot>;

package/dist/live/createLiveReact.d.ts

@@ -2,25 +2,25 @@ import React from 'react';
 import { BuiltinActionType, BuiltinEventType, KeyframeTypes, LiveConnectOptions, LiveEventType, LiveOptions, MicroStatus, RTCEventType, RTCType, UserInfo } from '../typings';
 import { LiveState } from '../typings/live/LiveState';
 import { Live } from './live';
-export declare type LiveProviderPropTypes<KeyframesSnapshot> = {
+export type LiveProviderPropTypes<KeyframesSnapshot extends Record<string, any>> = {
     children?: React.ReactNode;
     live?: Live<KeyframesSnapshot>;
 };
 /**
  * 创建 {@link LiveReact} 实例，并提供 `React` 技术栈相关工具链。
  */
-export declare function createLiveReact<KeyframesSnapshot>(options: LiveOptions): {
+export declare function createLiveReact<KeyframesSnapshot extends Record<string, any>>(options: LiveOptions): {
     live: Live<KeyframesSnapshot>;
     jsBridge: import("@realsee/jsbridge-x").JSBridgeProtocol;
     LiveProvider: (props: LiveProviderPropTypes<KeyframesSnapshot>) => JSX.Element;
     unsafe__useLiveInstance: () => Live<KeyframesSnapshot>;
     unsafe__useRTCInstance: () => import("../typings").RTCProtocol;
-    useConnect: (options: LiveConnectOptions) => Promise<boolean | Error>;
+    useConnect: () => (options: LiveConnectOptions) => Promise<boolean | Error>;
     useKeyframe: <K extends keyof KeyframesSnapshot>(key: K) => [frame: KeyframesSnapshot[K] | undefined, setFrame: (frame: KeyframesSnapshot[K]) => boolean | Error];
     useKeyframeUpdateCallback: <KeyOfKeyframe extends keyof KeyframeTypes<KeyframesSnapshot>>(key: KeyOfKeyframe, callback: (...args: Parameters<KeyframeTypes<KeyframesSnapshot>[KeyOfKeyframe]>) => ReturnType<KeyframeTypes<KeyframesSnapshot>[KeyOfKeyframe]>, deps?: React.DependencyList) => () => void;
     useLiveAction: () => {
         connect: (options: LiveConnectOptions) => Promise<boolean | Error>;
-        broadcast: (data: Record<string, any>, toUserIds: string | string[], timeout?: any) => Promise<unknown>;
+        broadcast: (data: Record<string, any>, toUserIds: string | string[], timeout?: number) => Promise<unknown>;
         exit: () => Promise<boolean>;
         kick: (toUserIds: string | string[]) => Promise<boolean>;
         toggleMicro: (microStatus: boolean) => Promise<boolean>;

package/dist/live/live.d.ts

@@ -3,7 +3,7 @@ import { RTCProtocol } from '../rtc';
 import { EventType, KeyframeTypes, LiveOptions, RoomInfo, RTCType, UserInfo, BuiltinEventType, BuiltinActionType, MicroStatus, LiveConnectOptions } from '../typings';
 import { LiveState } from '../typings/live/LiveState';
 import { Subscribe } from '../utils/subscribe';
-export declare type LiveBuiltInData<KeyframesSnapshot> = {
+export type LiveBuiltInData<KeyframesSnapshot> = {
     selfInfo?: UserInfo;
     userList?: UserInfo[];
     roomInfo?: RoomInfo;
@@ -145,7 +145,7 @@ export declare class Live<KeyframesSnapshot extends Record<string, any>> extends
      * @param timeout
      * @returns
      */
-    broadcast<Request, Response>(request: Request, toUserIds: string | string[], timeout: number): Promise<Response> | Error | false;
+    broadcast<Request extends Record<string, any>, Response>(request: Request, toUserIds: string | string[], timeout: number): Promise<Response> | Error | false;
     toggleMicro: (microStatus: boolean) => Promise<boolean>;
     /**
      * 控制别人的麦

package/dist/realsee-live.cjs.development.js

@@ -171,6 +171,54 @@ exports.BuiltInRTCType = void 0;
     BuiltInRTCType["RealseeXChimeRTC"] = "chime";
 })(exports.BuiltInRTCType || (exports.BuiltInRTCType = {}));
 
+/**
+ * 输出格式化日志
+ */
+// 获取当前时间
+const getTime = () => {
+    const date = new Date();
+    const year = date.getFullYear();
+    const month = (date.getMonth() + 1).toString().padStart(2, '0'); //月份是从0开始的
+    const day = date.getDate().toString().padStart(2, '0');
+    const hour = date.getHours().toString().padStart(2, '0');
+    const min = date.getMinutes().toString().padStart(2, '0');
+    const sec = date.getSeconds().toString().padStart(2, '0');
+    const ms = date.getMilliseconds();
+    return `[${year}-${month}-${day} ${hour}:${min}:${sec}.${ms}]`;
+};
+var LOG_LEVEL;
+(function (LOG_LEVEL) {
+    LOG_LEVEL["info"] = "INFO";
+    LOG_LEVEL["log"] = "LOG";
+    LOG_LEVEL["error"] = "ERROR";
+    LOG_LEVEL["warn"] = "WARN";
+})(LOG_LEVEL || (LOG_LEVEL = {}));
+// 输出日志
+const echo = (logLevel, args = []) => {
+    args.unshift(`Realsee Live ${getTime()} <${logLevel}> `);
+    switch (logLevel) {
+        case LOG_LEVEL.info:
+            return console.info(...args);
+        case LOG_LEVEL.error:
+            return console.error(...args);
+        case LOG_LEVEL.warn:
+            return console.warn(...args);
+        default:
+            return console.log(...args);
+    }
+};
+const log = (...args) => echo(LOG_LEVEL.log, args);
+const info = (...args) => echo(LOG_LEVEL.info, args);
+const error = (...args) => echo(LOG_LEVEL.error, args);
+const warn = (...args) => echo(LOG_LEVEL.warn, args);
+const logger = {
+    log,
+    info,
+    error,
+    warn,
+};
+var logger$1 = logger;
+
 // uuid
 function S4() {
     return (((1 + Math.random()) * 0x10000) | 0).toString(16).substring(1);
@@ -204,6 +252,7 @@ class BrowserRTC extends CoreRTC {
         this._getVoiceSign = () => {
             throw new Error('方法 getVoiceSign 未实现');
         };
+        this.checkRequirement = () => TRTC__default["default"].checkSystemRequirements();
         this.$dom = document.createElement('div');
         this._trtc = {
             client: null,
@@ -297,7 +346,10 @@ class BrowserRTC extends CoreRTC {
                 navigator.mediaDevices
                     .getUserMedia(rule)
                     .then(() => resolve(true))
-                    .catch(() => resolve(false));
+                    .catch((e) => {
+                    logger$1.error(e.message);
+                    resolve(false);
+                });
             }
             catch (e) {
                 console.error(e);
@@ -318,9 +370,10 @@ class BrowserRTC extends CoreRTC {
         var _a, _b, _c, _d;
         (_a = this._trtc.client) === null || _a === void 0 ? void 0 : _a.on('stream-added', this._handleStreamAdded);
         (_b = this._trtc.client) === null || _b === void 0 ? void 0 : _b.on('stream-subscribed', this._handleStreamSubscribed);
-        (_c = this._trtc.client) === null || _c === void 0 ? void 0 : _c.on('audio-volume', (event) => this.emit('userVolumes', [
-            { userId: event.userId, audioVolume: event.audioVolume },
-        ]));
+        (_c = this._trtc.client) === null || _c === void 0 ? void 0 : _c.on('audio-volume', (event) => this.emit('userVolumes', event.result.map(({ userId, audioVolume }) => ({
+            userId,
+            audioVolume,
+        }))));
         (_d = this._trtc.client) === null || _d === void 0 ? void 0 : _d.on('error', (event) => this.emit('error', event));
     }
 }
@@ -611,6 +664,9 @@ exports.RTCJoinedInfoCodeEnum = void 0;
 })(exports.RTCJoinedInfoCodeEnum || (exports.RTCJoinedInfoCodeEnum = {}));
 
 class VRWebViewRTC extends CoreRTC {
+    get jsBridge() {
+        return this.options.jsBridge;
+    }
     constructor({ jsBridge, getVoiceSign }) {
         super();
         this.type = exports.RTCType.RealseeVRWebViewRTC;
@@ -629,9 +685,6 @@ class VRWebViewRTC extends CoreRTC {
                 this.emit('weakNetwork');
         });
     }
-    get jsBridge() {
-        return this.options.jsBridge;
-    }
     join(options) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
@@ -984,7 +1037,7 @@ exports.default = LogLevel;
 
 var LogLevel = /*@__PURE__*/getDefaultExportFromCjs(LogLevel_1);
 
-function appendUri(uri, query) {
+function appendUri(uri, query = {}) {
     const hasQuery = uri.indexOf('?') !== -1;
     const newQuery = Object.keys(query).reduce((accu, curr, idx) => `${accu}${(idx === 0 && !hasQuery) ? '?' : '&'}${curr}=${query[curr]}`, '');
     return uri + newQuery;
@@ -1122,66 +1175,21 @@ function objEqualDeep(value, other) {
  * @param options 可选参数，可选项：`deep` 是否深比较。
  * @returns {boolean} 是否相等。
  */
-function equal(value, other, opt) {
+function equal(value, other, opt = { deep: false }) {
     if (!opt.deep)
         return isShallowEqual(value, other);
     return isDeepEqual(value, other);
 }
 
-/**
- * 输出格式化日志
- */
-// 获取当前时间
-const getTime = () => {
-    const date = new Date();
-    const year = date.getFullYear();
-    const month = (date.getMonth() + 1).toString().padStart(2, '0'); //月份是从0开始的
-    const day = date.getDate().toString().padStart(2, '0');
-    const hour = date.getHours().toString().padStart(2, '0');
-    const min = date.getMinutes().toString().padStart(2, '0');
-    const sec = date.getSeconds().toString().padStart(2, '0');
-    const ms = date.getMilliseconds();
-    return `[${year}-${month}-${day} ${hour}:${min}:${sec}.${ms}]`;
-};
-var LOG_LEVEL;
-(function (LOG_LEVEL) {
-    LOG_LEVEL["info"] = "INFO";
-    LOG_LEVEL["log"] = "LOG";
-    LOG_LEVEL["error"] = "ERROR";
-    LOG_LEVEL["warn"] = "WARN";
-})(LOG_LEVEL || (LOG_LEVEL = {}));
-// 输出日志
-const echo = (logLevel, args = []) => {
-    args.unshift(`Realsee Live ${getTime()} <${logLevel}> `);
-    switch (logLevel) {
-        case LOG_LEVEL.info:
-            return console.info(...args);
-        case LOG_LEVEL.error:
-            return console.error(...args);
-        case LOG_LEVEL.warn:
-            return console.warn(...args);
-        default:
-            return console.log(...args);
-    }
-};
-const log = (...args) => echo(LOG_LEVEL.log, args);
-const info = (...args) => echo(LOG_LEVEL.info, args);
-const error = (...args) => echo(LOG_LEVEL.error, args);
-const warn = (...args) => echo(LOG_LEVEL.warn, args);
-const logger = {
-    log,
-    info,
-    error,
-    warn,
-};
-var logger$1 = logger;
-
 /**
  * 具有鲁棒性的WebSocket封装
  * 1、自动重连
  * 2、可根据网络情况进行重连
  */
 class RobustWebSocket extends Subscribe {
+    get attempts() {
+        return this._attempts;
+    }
     constructor(options) {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-call
         super();
@@ -1429,9 +1437,6 @@ class RobustWebSocket extends Subscribe {
         }
         this._startHealthCheck();
     }
-    get attempts() {
-        return this._attempts;
-    }
     setOptions(options) {
         if (!options)
             return;
@@ -1473,6 +1478,14 @@ class RobustWebSocket extends Subscribe {
 }
 
 class LiveController extends Subscribe {
+    set state(state) {
+        const prevState = JSON.parse(JSON.stringify(this._state));
+        this._state = state;
+        this.emit('stateChange', this.state, prevState);
+    }
+    get state() {
+        return this._state;
+    }
     constructor() {
         super();
         /**
@@ -1602,14 +1615,6 @@ class LiveController extends Subscribe {
         });
         this._addWebSocketEventListeners();
     }
-    set state(state) {
-        const prevState = JSON.parse(JSON.stringify(this._state));
-        this._state = state;
-        this.emit('stateChange', this.state, prevState);
-    }
-    get state() {
-        return this._state;
-    }
     /**
      * 发送数据
      * @param data
@@ -1641,6 +1646,65 @@ const _clearLiveInstanceIfNeed = () => {
     }
 };
 class Live extends Subscribe {
+    get options() {
+        return Object.freeze(this._options || {});
+    }
+    /**
+     * 带看状态
+     */
+    get state() {
+        return this._controller.state;
+    }
+    /**
+     * 兼容老逻辑
+     * @deprecated 请直接读取 state 属性字段，未来将移除该属性
+     */
+    get readyState() {
+        return this._controller.state;
+    }
+    /**
+     * 获取当前WebSocket连接的URL。(注意：这个是WebSocket连接的完整连接，附带一些query参数)。
+     * @deprecated 带看不需要关注底层ws的相关信息，未来将移除
+     */
+    get url() {
+        return this.options.url;
+    }
+    /**
+     * 获取当前live使用的RTC实例
+     */
+    get $RTC() {
+        return this._options.rtc;
+    }
+    /**
+     * 获取当前live使用的jsBridge实例
+     */
+    get jsBridge() {
+        return this._options.jsBridge;
+    }
+    /**
+     * 当前帧数据快照
+     */
+    get snapshot() {
+        return this._buildInData.keyframes;
+    }
+    /**
+     * 当前用户信息
+     */
+    get selfInfo() {
+        return this._buildInData.selfInfo;
+    }
+    /**
+     * 当前用户列表
+     */
+    get userList() {
+        return this._buildInData.userList || [];
+    }
+    /**
+     * 当前带看房间信息
+     */
+    get roomInfo() {
+        return this._buildInData.roomInfo;
+    }
     constructor(opts) {
         var _a;
         super();
@@ -1715,7 +1779,7 @@ class Live extends Subscribe {
         this._handleMessage = (liveMsg) => __awaiter(this, void 0, void 0, function* () {
             var _b, _c, _d, _e, _f, _g;
             if (typeof liveMsg === 'object') {
-                const { command, data, frontRequestId, code, message } = liveMsg;
+                const { command, data = {}, frontRequestId, code, message } = liveMsg;
                 if (code === 'SUCCESS') {
                     switch (command) {
                         /**
@@ -1885,8 +1949,8 @@ class Live extends Subscribe {
             }
             const { force = false } = options;
             // 检测一下麦克风权限，hack
-            if (this._options.rtc && this._options.jsBridge) {
-                const res = yield this._options.jsBridge.detectMicro();
+            if (this._options.rtc) {
+                const res = yield this._options.rtc.detectMicro();
                 if (!res) {
                     return new Error('Failed to obtain microphone authorization');
                 }
@@ -2111,65 +2175,6 @@ class Live extends Subscribe {
             Object.assign(window, { $liveController: this._controller, $live: this });
         }
     }
-    get options() {
-        return Object.freeze(this._options || {});
-    }
-    /**
-     * 带看状态
-     */
-    get state() {
-        return this._controller.state;
-    }
-    /**
-     * 兼容老逻辑
-     * @deprecated 请直接读取 state 属性字段，未来将移除该属性
-     */
-    get readyState() {
-        return this._controller.state;
-    }
-    /**
-     * 获取当前WebSocket连接的URL。(注意：这个是WebSocket连接的完整连接，附带一些query参数)。
-     * @deprecated 带看不需要关注底层ws的相关信息，未来将移除
-     */
-    get url() {
-        return this.options.url;
-    }
-    /**
-     * 获取当前live使用的RTC实例
-     */
-    get $RTC() {
-        return this._options.rtc;
-    }
-    /**
-     * 获取当前live使用的jsBridge实例
-     */
-    get jsBridge() {
-        return this._options.jsBridge;
-    }
-    /**
-     * 当前帧数据快照
-     */
-    get snapshot() {
-        return this._buildInData.keyframes;
-    }
-    /**
-     * 当前用户信息
-     */
-    get selfInfo() {
-        return this._buildInData.selfInfo;
-    }
-    /**
-     * 当前用户列表
-     */
-    get userList() {
-        return this._buildInData.userList || [];
-    }
-    /**
-     * 当前带看房间信息
-     */
-    get roomInfo() {
-        return this._buildInData.roomInfo;
-    }
     /**
      * 修改状态
      * @param evtType
@@ -2265,21 +2270,21 @@ function createLiveReact(options) {
      * @deprecated
      * @returns
      */
-    const unsafe__useLiveInstance = React.useCallback(() => useLiveInstance(), [useLiveInstance]);
+    const unsafe__useLiveInstance = () => live;
     /**
      * 使用rtc实例
      */
-    const useRTCInstance = React.useCallback(() => useLiveInstance().$RTC, [useLiveInstance]);
+    const useRTCInstance = () => live.$RTC;
     /**
      * 不建议这样使用
      * @deprecated
      * @returns
      */
-    const unsafe__useRTCInstance = React.useCallback(() => useRTCInstance(), [useRTCInstance]);
+    const unsafe__useRTCInstance = () => useRTCInstance();
     /**
      * 带看连接操作
      */
-    const useConnect = React.useCallback((options) => __awaiter(this, void 0, void 0, function* () { return yield useLiveInstance().connect(options); }), []);
+    const useConnect = () => (options) => __awaiter(this, void 0, void 0, function* () { return yield live.connect(options); });
     /**
      *
      * @param name
@@ -2303,17 +2308,17 @@ function createLiveReact(options) {
      */
     function useLiveAction() {
         const live = useLiveInstance();
-        const connect = React__default["default"].useCallback((options) => __awaiter(this, void 0, void 0, function* () { return yield live.connect(options); }), [live]);
-        const toggleMicro = React__default["default"].useCallback((microStatus) => live.toggleMicro(microStatus), [live]);
-        const broadcast = React__default["default"].useCallback((data, toUserIds, timeout = 0) => __awaiter(this, void 0, void 0, function* () { return yield live.broadcast(data, toUserIds, timeout); }), [live]);
-        const exit = React__default["default"].useCallback(() => __awaiter(this, void 0, void 0, function* () { return yield live.exit(); }), [live]);
-        const kick = React__default["default"].useCallback((toUserIds) => __awaiter(this, void 0, void 0, function* () { return yield live.kick(toUserIds); }), [live]);
-        const forbidMicro = React__default["default"].useCallback((micro, toUserIds = []) => __awaiter(this, void 0, void 0, function* () { return yield live.forbidMicro(micro, toUserIds); }), [live]);
-        const forbidSync = React__default["default"].useCallback((sync, toUserIds = []) => live.forbidSync(sync, toUserIds), [live]);
-        const getFramesByKey = React__default["default"].useCallback((key) => live.getFramesByKey(key), [live]);
-        const sendKeyframe = React__default["default"].useCallback((key, frame) => live.sendKeyframe(key, frame), [live]);
-        const setSelfInfo = React__default["default"].useCallback((userInfo) => live.setSelfInfo(userInfo), [live]);
-        const updateStatus = React__default["default"].useCallback((evtType, atnType, status, toUserIds) => live.updateStatus(evtType, atnType, status, toUserIds), [live]);
+        const connect = (options) => __awaiter(this, void 0, void 0, function* () { return yield live.connect(options); });
+        const toggleMicro = (microStatus) => live.toggleMicro(microStatus);
+        const broadcast = (data, toUserIds, timeout = 0) => __awaiter(this, void 0, void 0, function* () { return yield live.broadcast(data, toUserIds, timeout); });
+        const exit = () => __awaiter(this, void 0, void 0, function* () { return yield live.exit(); });
+        const kick = (toUserIds) => __awaiter(this, void 0, void 0, function* () { return yield live.kick(toUserIds); });
+        const forbidMicro = (micro, toUserIds = []) => __awaiter(this, void 0, void 0, function* () { return yield live.forbidMicro(micro, toUserIds); });
+        const forbidSync = (sync, toUserIds = []) => live.forbidSync(sync, toUserIds);
+        const getFramesByKey = (key) => live.getFramesByKey(key);
+        const sendKeyframe = (key, frame) => live.sendKeyframe(key, frame);
+        const setSelfInfo = (userInfo) => live.setSelfInfo(userInfo);
+        const updateStatus = (evtType, atnType, status, toUserIds) => live.updateStatus(evtType, atnType, status, toUserIds);
         return {
             connect,
             broadcast,
@@ -2367,11 +2372,11 @@ function createLiveReact(options) {
     }
     function useRTCAction() {
         const live = useLiveInstance();
-        const join = React__default["default"].useCallback((options) => live.$RTC.join(options), [live]);
-        const quit = React__default["default"].useCallback(() => live.$RTC.quit(), [live]);
-        const shock = React__default["default"].useCallback(() => { var _a, _b; return (_b = (_a = live.$RTC).shock) === null || _b === void 0 ? void 0 : _b.call(_a); }, [live]);
-        const toggleMicro = React__default["default"].useCallback((flag) => live.$RTC.toggleMicro(flag), [live]);
-        const detectMicro = React__default["default"].useCallback(() => live.$RTC.detectMicro(), [live]);
+        const join = (options) => live.$RTC.join(options);
+        const quit = () => live.$RTC.quit();
+        const shock = () => { var _a, _b; return (_b = (_a = live.$RTC).shock) === null || _b === void 0 ? void 0 : _b.call(_a); };
+        const toggleMicro = (flag) => live.$RTC.toggleMicro(flag);
+        const detectMicro = () => live.$RTC.detectMicro();
         return {
             join,
             quit,