@realsee/live 0.4.0-beta.8 → 0.5.0-alpha.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@realsee/live",
-  "version": "0.4.0-beta.8",
+  "version": "0.5.0-alpha.3",
   "description": "如视 Live SDK：基于如视 WebSocket 长链双工通信能力的前端封装，借助此 SDK 您可以快捷地实现具备同屏连线、实时语音的 VR 带看业务能力。",
   "main": "dist/realsee-live.cjs.js",
   "module": "dist/realsee-live.esm.js",
@@ -20,7 +20,7 @@
     "typescript": "^4.7.2"
   },
   "dependencies": {
-    "@realsee/jsbridge-x": "0.2.1-beta.3",
+    "@realsee/jsbridge-x": "0.2.2-alpha.2",
     "amazon-chime-sdk-js": "^2.26.1",
     "react": "^17.0.2",
     "trtc-js-sdk": "^4.12.5"

package/dist/typings/live/Live.d.ts

@@ -1,128 +0,0 @@
-import { UserInfo } from './UserInfo';
-import { LiveOptions } from './LiveOptions';
-import { EventType, KeyframeTypes } from './EventType';
-import { WebSocketState } from './WebSocket';
-import { BuiltinActionType, BuiltinEventType, MicroStatus } from './LiveMsg';
-import { Subscribe } from '../../utils/subscribe';
-import { RTCProtocol } from '../rtc/protocol';
-import { JSBridgeProtocol } from '@realsee/jsbridge-x';
-/**
- * Live 实例。
- */
-export interface Live<Snapshot extends Record<string, any>> extends Subscribe<EventType<Snapshot>> {
-    get options(): LiveOptions;
-    /**
-     * 更新本地用户信息
-     * @param userInfo
-     */
-    setSelfInfo(userInfo: Partial<UserInfo>): Promise<boolean | Error>;
-    /**
-     * 获取本地用户信息
-     */
-    get selfInfo(): UserInfo | undefined;
-    /**
-     * 获取当前WebSocket的连接状态。
-     * @deprecated 带看不需要关注底层ws的状态，未来将移除
-     */
-    get readyState(): WebSocketState;
-    /**
-     * 获取当前会话房间内用户列表。
-     */
-    get userList(): UserInfo[];
-    /**
-     * 获取当前帧数据快照。
-     */
-    get snapshot(): Partial<Snapshot>;
-    /**
-     * 获取当前WebSocket连接的URL。(注意：这个是WebSocket连接的完整连接，附带一些query参数)。
-     * @deprecated 带看不需要关注底层ws的相关信息，未来将移除
-     */
-    get url(): string;
-    /**
-     * 获取当前live使用的RTC实例
-     */
-    get $RTC(): RTCProtocol;
-    /**
-     * 获取当前live使用的jsBridge实例
-     */
-    get jsBridge(): JSBridgeProtocol;
-    /**
-     * 帧数据监听
-     */
-    keyframes: Subscribe<KeyframeTypes<Snapshot>>;
-    /**
-     * 根据某条 key 获取某条帧数据
-     * @param keys
-     * @returns 帧数据
-     */
-    getFramesByKey<Key extends keyof Snapshot>(key: Key): Partial<Snapshot>[Key] | undefined;
-    /**
-     * 发送帧数据
-     * @param key
-     * @param frame
-     * @returns
-     */
-    sendKeyframe<Key extends keyof Snapshot>(key: Key, frame: Snapshot[Key]): boolean | Error;
-    /**
-     * 自定义广播事件
-     * @param data 广播数据：这个数据需要自定义格式，此处不做任何约束。
-     * @param toUserIds 希望收到此广播事件的用户，为空时则向所有用户广播。
-     * @param timeout 等待广播结果的超时设置；默认为"0"，表示一直等结果。
-     * @returns
-     */
-    broadcast<D, R>(data: D, toUserIds: string | string[], timeout: number): Promise<R> | Error;
-    /**
-     * 更新用户或房间状态。
-     * @param eventType 事件枚举
-     * @param actionType 行为枚举
-     * @param status 状态值
-     * @param toUserIds 面向的用户。
-     */
-    updateStatus(eventType: BuiltinEventType, actionType: BuiltinActionType, status: Record<string, any>, toUserIds?: string | string[]): Promise<boolean>;
-    /**
-     * 执行WebSocket连接
-     * @param force 为true时则强制重连
-     * @returns
-     */
-    connect(options?: {
-        url?: string;
-        force?: boolean;
-    }): Promise<boolean | Error>;
-    /**
-     * 开启/关闭自己的麦克风
-     * @param microStatus true 开启麦克风；false 关闭麦克风
-     * @return
-     * */
-    toggleMicro(microStatus: boolean): Promise<boolean>;
-    /**
-     * 关闭/开启某个或某些用户的麦克风
-     * @param micro true 开启麦克风；false 关闭麦克风
-     * @param toUserIds 希望关闭/开启麦克风的用户，为空时则面向所有用户。
-     * @returns
-     */
-    forbidMicro(micro: MicroStatus, toUserIds?: string[] | string): Promise<boolean>;
-    /**
-     * 限制/开启某个或某些用户同步帧数据
-     * @param sync true 开启同步；false 限制同步
-     * @param toUserIds 希望限制/开启同步能力的用户，为空时则面向所有用户。
-     * @deprecated 暂不支持
-     * @returns
-     *
-     */
-    /**
-     * "踢人"：强制让某个用户离开附近。
-     * @param toUserIds 被"踢"的用户。
-     * @returns
-     */
-    kick(toUserIds: string[] | string): Promise<boolean>;
-    /**
-     * 退出带看
-     * @returns
-     */
-    exit(): Promise<boolean>;
-    /**
-     * 废弃掉当前实例依赖。
-     */
-    revoke(): Promise<boolean>;
-}
-export declare type LiveActionReactCallback<Snapshot extends Record<string, any>> = Pick<Live<Snapshot>, 'broadcast' | 'exit' | 'kick' | 'toggleMicro' | 'forbidMicro' | 'sendKeyframe' | 'getFramesByKey' | 'setSelfInfo' | 'updateStatus'>;

package/dist/typings/react/LiveReact.d.ts

@@ -1,164 +0,0 @@
-import { JSBridgeProtocol } from '@realsee/jsbridge-x';
-import React from 'react';
-import { KeyframeTypes, LiveEventType, WebSocketEventType } from '../live/EventType';
-import { Live, LiveActionReactCallback } from '../live/Live';
-import { UserInfo } from '../live/UserInfo';
-import { WebSocketState } from '../live/WebSocket';
-import { RTCEventType } from '../rtc/eventType';
-import { RTCProtocol } from '../rtc/protocol';
-import { RTCActionReactCallback } from './RTCActionReactCallback';
-export declare type LiveProviderPropTypes<Snapshot> = {
-    children?: React.ReactNode;
-    live?: Live<Snapshot>;
-};
-/**
- * @example
- *
- * 新建文件`LiveReact.ts` 创建一个 {@link LiveReact} 实例对象:
- *
- * ```js
- * import { createLiveReact } from '@realsee/live'
- * const LiveReact = createLiveReact({ getTicket: async () => '' })
- * export default LiveReact
- * ```
- *
- *
- */
-export interface LiveReact</* 帧数据 */ Snapshot> {
-    live: Live<Snapshot>;
-    jsBridge: JSBridgeProtocol;
-    /**
-     * @description **LiveProvider** 基于 [React Context](https://reactjs.org/docs/context.html) 对 {@link Live }进行封装，你可以以 [React Hooks](https://reactjs.org/docs/hooks-intro.html) 的方式对 {@link Live } 实例进行操作、数据监听等。
-     *
-     * 在 `React` 环境中使用 {@link LiveReact.LiveProvider} 组件:
-     *
-     * ```ts
-     * import { LiveProvider } from './LiveReact'
-     * ReactDOM.render(<LiveProvider><App></LiveProvider>, containter)
-     * ```
-     */
-    LiveProvider: (props: LiveProviderPropTypes<Snapshot>) => JSX.Element;
-    /**
-     * @deprecated 获取 `live` 实例，**不鼓励使用**
-     */
-    unsafe__useLiveInstance: () => Live<Snapshot>;
-    /**
-     * @deprecated 获取 `RTC` 实例，**不鼓励使用**
-     */
-    unsafe__useRTCInstance: () => RTCProtocol;
-    /**
-     *
-     * @description 获取当前 WebSocket 连接的 URL，如果尚未创建 WebSocket 实例，则值为 `undefined`。
-     * 如果有重连等事件发生 URL 值会发生更新。
-     *
-     * ```ts
-     * import { useCurrentWebSocketUrl } from './LiveReact'
-     * function ReactComponent() {
-     *   const url = useCurrentWebSocketUrl()
-     *   return <div>当前URL: {url}.</div>
-     * }
-     * ```
-     */
-    useCurrentWebSocketUrl: () => string | undefined;
-    /**
-     * @description 连接 WebSocket 服务。如果 WebSocket 已经连接则什么都不做，若提供 `{force: true}` 则会强制重连。
-     *
-     *
-     * ```jsx
-     * import { useConnect } from './LiveReact'
-     * function ReactComponent() {
-     *   const connect = useConnect()
-     *   return <button onClick={() => connect()}>点击连接</button>
-     * }
-     * ```
-     *
-     */
-    useConnect: () => (options?: {
-        force?: boolean;
-        url?: string;
-        getTicket?: () => Promise<string>;
-    }) => Promise<boolean | Error>;
-    /**
-     *
-     * @description 帧数据状态值。如果执行 `setKeyframe()` 则会传递 WebSocket 帧同步指令；若通过 WebSocket 收到新帧数据则会更新当前状态值。
-     *
-     * ```typescript
-     * function LocalFiveState() {
-     *   const [keyframe, setKeyframe] = LiveReact.useKeyframe('five')
-     *   return (<div>{JSON.stringify(keyframe)}</div>)
-     * }
-     * ```
-     */
-    useKeyframe: <K extends keyof Snapshot>(frameName: K) => [
-        frame: Snapshot[K] | undefined,
-        setFrame: (frame: Snapshot[K]) => boolean | Error
-    ];
-    /**
-     *
-     */
-    useKeyframeUpdateCallback: <K extends keyof KeyframeTypes<Snapshot>>(name: K, callback: (...args: Parameters<KeyframeTypes<Snapshot>[K]>) => ReturnType<KeyframeTypes<Snapshot>[K]>, deps?: React.DependencyList) => () => void;
-    /**
-     *
-     * @function broadcast 广播消息，详见 {@link Live.broadcast}。
-     * @function exit 退出带看，详见 {@link Live.exit}。
-     * @function kick 踢出带看，详见 {@link Live.kick}。
-     * @function toggleMicro 打开/关闭自己的麦克风，详见 {@link Live.toggleMicro}。
-     * @function forbidMicro 禁止麦克风，详见 {@link Live.forbidMicro}。
-     * @function sendKeyframe 发送帧数据，详见 {@link Live.sendKeyframe}。
-     * @function getFramesByKey 根据`key`从帧快照中获取某条帧数据，详见 {@link Live.getFramesByKey}。
-     * @function setSelfInfo 设置当前用户信息，详见 {@link Live.setSelfInfo}。
-     * @function updateStatus 更新用户或房间状态，详见 {@link Live.updateStatus}。
-     *
-     * @description 提供一些函数直接调用。
-     *
-     * ```ts
-     * function ReactComponent() {
-     *   const { exit } = useLiveAction()
-     *   return (<button onClick={() => exit()}>退出带看</button>)
-     * }
-     * ```
-     */
-    useLiveAction: () => LiveActionReactCallback<Snapshot>;
-    /**
-     * 监听带看相关的异步 Hooks 事件。详情见 {@link LiveEventType}。
-     */
-    useLiveEventCallback: <K extends keyof LiveEventType<Snapshot>>(name: K, callback: (...args: Parameters<LiveEventType<Snapshot>[K]>) => ReturnType<LiveEventType<Snapshot>[K]>, deps?: React.DependencyList) => () => void;
-    /**
-     * 获取当前 WebSocket 状态 {@link WebSocketState}。
-     */
-    useReadyState: () => WebSocketState;
-    /**
-     * RTC 函数。
-     */
-    useRTCAction: () => RTCActionReactCallback;
-    /**
-     * RTC 事件回调监听。
-     */
-    useRTCEventCallback: <K extends keyof RTCEventType>(name: K, callback: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>, deps?: React.DependencyList) => () => void;
-    /**
-     * 获取\更改 当前用户信息。
-     * ```
-     * const [userInfo, setUserInfo] = useSelfInfo()
-     * ```
-     */
-    useSelfInfo: () => [
-        Partial<UserInfo>,
-        (userInfo: Partial<UserInfo>) => Promise<boolean | Error>
-    ];
-    /**
-     * 当前帧数据快照。
-     */
-    useSnapshot: () => Partial<Snapshot> | undefined;
-    /**
-     * 获取房间用户列表。
-     *
-     * ```
-     * const userList = useUserList()
-     * ```
-     */
-    useUserList: () => UserInfo[] | undefined;
-    /**
-     * WebSocket 异步事件回调监听。
-     */
-    useWebSocketEventCallback: <K extends keyof WebSocketEventType>(name: K, callback: (...args: Parameters<WebSocketEventType[K]>) => ReturnType<WebSocketEventType[K]>, deps?: React.DependencyList) => () => void;
-}