@trtc/calls-uikit-react 4.1.0

package/types/TUICallService/interface/ITUIGlobal.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @interface TUIGlobal
+ * @property {Object} global 根据运行环境代理 wx、uni、window
+ * @property {Boolean} isPC true 标识是 pc 网页
+ * @property {Boolean} isH5 true 标识是 手机 H5
+ * @property {Boolean} isWeChat true 标识是 微信小程序
+ * @property {Boolean} isApp true 标识是 uniapp 打包的 native app
+ * @property {Boolean} isUniPlatform true 标识当前应用是通过 uniapp 平台打包的产物
+ * @property {Boolean} isOfficial true 标识是腾讯云官网 Demo 应用
+ * @property {Boolean} isWIN true 标识是window系统pc
+ * @property {Boolean} isMAC true 标识是mac os系统pc
+*/
+export interface ITUIGlobal {
+    global: any;
+    isPC: boolean;
+    isH5: boolean;
+    isWeChat: boolean;
+    isApp: boolean;
+    isUniPlatform: boolean;
+    isOfficial: boolean;
+    isWIN: boolean;
+    isMAC: boolean;
+    /**
+     * 初始化 TUIGlobal 环境变量
+     * @function
+     * @private
+     */
+    initEnv(): void;
+    /**
+     * 初始化 isOfficial
+     * @function
+     * @param {number} SDKAppID 当前实例的应用 SDKAppID
+     * @private
+     */
+    initOfficial(SDKAppID: number): void;
+}

package/types/TUICallService/interface/ITUIStore.d.ts

@@ -0,0 +1,83 @@
+import { StoreName } from '../const/index';
+export type Task = Record<StoreName, Record<string, Map<(data?: unknown) => void, 1>>>;
+export interface IOptions {
+    [key: string]: (newData?: any) => void;
+}
+/**
+ * @class TUIStore
+ * @property {ICustomStore} customStore 自定义 store，可根据业务需要通过以下 API 进行数据操作。
+*/
+export interface ITUIStore {
+    task: Task;
+    /**
+     * UI 组件注册监听
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {IOptions} options UI 组件注册的监听信息
+     * @param {Object} params 扩展参数
+     * @param {String} params.notifyRangeWhenWatch 注册时监听时的通知范围
+     * @example
+     * // UI 层监听会话列表更新通知
+     * let onConversationListUpdated = function(conversationList) {
+     *   console.warn(conversationList);
+     * }
+     * TUIStore.watch(StoreName.CONV, {
+     *   conversationList: onConversationListUpdated,
+     * })
+     */
+    watch(storeName: StoreName, options: IOptions, params?: any): void;
+    /**
+     * UI 组件取消监听回调
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {IOptions} options 监听信息，包含需要取消的回调等
+     * @example
+     * // UI 层取消监听会话列表更新通知
+     * TUIStore.unwatch(StoreName.CONV, {
+     *   conversationList: onConversationListUpdated,
+     * })
+     */
+    unwatch(storeName: StoreName, options: IOptions | string): void;
+    /**
+     * 获取 store 中的上一个状态
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {String} key 需要获取的 key
+     * @private
+     */
+    getPrevData(storeName: StoreName, key: string): any;
+    /**
+     * 获取 store 中的数据
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {String} key 需要获取的 key
+     * @private
+     */
+    getData(storeName: StoreName, key: string): any;
+    /**
+     * 更新 store
+     * - 需要使用自定义 store 时可以用此 API 更新自定义数据
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {String} key 需要更新的 key
+     * @example
+     * // UI 层更新自定义 Store 数据
+     * TUIStore.update(StoreName.CUSTOM, 'customKey', 'customData')
+     */
+    update(storeName: StoreName, key: string, data: unknown): void;
+    /**
+     * 重置 store 内数据
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {Array<string>} keyList 需要 reset 的 keyList
+     * @param {boolean} isNotificationNeeded 是否需要触发更新
+     * @private
+     */
+    reset: (storeName: StoreName, keyList?: Array<string>, isNotificationNeeded?: boolean) => void;
+    /**
+     * 修改多个 key-value
+     * @param {Object} params 多个 key-value 组成的 object
+     * @param {StoreName} storeName store 名称
+     */
+    updateStore: (params: any, name?: StoreName) => void;
+}

package/types/TUICallService/interface/index.d.ts

@@ -0,0 +1,4 @@
+export * from './ICallService';
+export * from './ICallStore';
+export * from './ITUIGlobal';
+export * from './ITUIStore';

package/types/TUICallService/locales/en.d.ts

@@ -0,0 +1,128 @@
+export declare const en: {
+    hangup: string;
+    reject: string;
+    accept: string;
+    camera: string;
+    microphone: string;
+    speaker: string;
+    'open camera': string;
+    'close camera': string;
+    'open microphone': string;
+    'close microphone': string;
+    'video-to-audio': string;
+    'virtual-background': string;
+    'other side reject call': string;
+    'reject call': string;
+    cancel: string;
+    'other side line busy': string;
+    'in busy': string;
+    'call timeout': string;
+    'no response from the other side': string;
+    'end call': string;
+    'caller calling message': string;
+    'callee calling video message': string;
+    'callee calling audio message': string;
+    'no microphone access': string;
+    'no camera access': string;
+    'invite member': string;
+    'Invited group call': string;
+    waiting: string;
+    me: string;
+    'browser-authorization': string;
+    'mac-privacy': string;
+    'win-privacy': string;
+    'mac-preferences': string;
+    'win-preferences': string;
+    'Please enter userID': string;
+    'View more': string;
+    'people selected': string;
+    'Select all': string;
+    Cancel: string;
+    Done: string;
+    'exist group call': string;
+    'camera enabled': string;
+    'camera disabled': string;
+    'microphone enabled': string;
+    'microphone disabled': string;
+    'speaker enabled': string;
+    'speaker disabled': string;
+    'open speaker': string;
+    'close speaker': string;
+    'wait to be called': string;
+    answered: string;
+    'people in the call': string;
+    'failed to obtain speakers': string;
+    'you have a new call': string;
+    'switch camera': string;
+    join: string;
+    'people on the call': string;
+    "Supports a maximum of 9 people for simultaneous calls": string;
+    you: string;
+    "The network is poor during your current call": string;
+    "The other user network is poor during the current call": string;
+    "TUICallKit init is not complete": string;
+    "Video call": string;
+    "Voice call": string;
+    "Call End": string;
+    "Switch voice call": string;
+    "Switch video call": string;
+    "Call duration": string;
+    "Call Cancel": string;
+    "Other Side Cancel": string;
+    Decline: string;
+    "Other Side Decline": string;
+    "No answer": string;
+    "Other Side No Answer": string;
+    Answered: string;
+    "Other Side Line Busy": string;
+    "Line Busy": string;
+    'Those involved': string;
+    call: string;
+    'video-call': string;
+    'audio-call': string;
+    search: string;
+    'search-result': string;
+    'no-user': string;
+    'member-not-added': string;
+    'input-phone-userID': string;
+    'not-login': string;
+    'login-status-expire': string;
+    'experience-multi-call': string;
+    'not-support-multi-call': string;
+    userID: string;
+    'already-enter': string;
+    'camera-opened': string;
+    'camera-closed': string;
+    'microphone-opened': string;
+    'microphone-closed': string;
+    timeout: string;
+    'kick out': string;
+    'image-resolution': string;
+    'default-image-resolution': string;
+    'invited-person': string;
+    'be-rejected': string;
+    'be-no-response': string;
+    'be-line-busy': string;
+    'be-canceled': string;
+    'voice-call-end': string;
+    'video-call-end': string;
+    'method-call-failed': string;
+    'failed-to-obtain-permission': string;
+    'environment-detection-failed': string;
+    'switchToAudioCall-call-failed': string;
+    'switchToVideoCall-call-failed': string;
+    'microphone-unavailable': string;
+    'camera-unavailable': string;
+    'ban-device': string;
+    'not-supported-webrtc': string;
+    'blacklist-user-tips': string;
+    'is-already-calling': string;
+    'need-init': string;
+    "can't call yourself": string;
+    'Use-phone-and-computer': string;
+    'Wechat scan right QR code': string;
+    'Scan the QR code above': string;
+    'accept-error': string;
+    'accept-device-error': string;
+    'call-error': string;
+};

package/types/TUICallService/locales/index.d.ts

@@ -0,0 +1,10 @@
+export declare const CallTips: any;
+export declare const languageData: languageDataType;
+export declare function t(args: any): string;
+interface languageItemType {
+    [key: string]: string;
+}
+interface languageDataType {
+    [key: string]: languageItemType;
+}
+export {};

package/types/TUICallService/locales/ja_JP.d.ts

@@ -0,0 +1,127 @@
+export declare const ja_JP: {
+    hangup: string;
+    reject: string;
+    accept: string;
+    camera: string;
+    microphone: string;
+    speaker: string;
+    'virtual-background': string;
+    'other side reject call': string;
+    'reject call': string;
+    cancel: string;
+    'other side line busy': string;
+    'in busy': string;
+    'call timeout': string;
+    'end call': string;
+    'caller calling message': string;
+    'callee calling video message': string;
+    'callee calling audio message': string;
+    'no microphone access': string;
+    'no camera access': string;
+    'invite member': string;
+    'browser-authorization': string;
+    'mac-privacy': string;
+    'win-privacy': string;
+    'mac-preferences': string;
+    'win-preferences': string;
+    'Please enter userID': string;
+    'View more': string;
+    'people selected': string;
+    'Select all': string;
+    Cancel: string;
+    Done: string;
+    'exist group call': string;
+    "Video call": string;
+    "Voice call": string;
+    "Call End": string;
+    "Switch audio call": string;
+    "Switch video call": string;
+    "Call duration": string;
+    "Call Cancel": string;
+    "Other Side Cancel": string;
+    Decline: string;
+    "Other Side Decline": string;
+    "No answer": string;
+    "Other Side No Answer": string;
+    Answered: string;
+    "Other Side Line Busy": string;
+    "Line Busy": string;
+    'open camera': string;
+    'close camera': string;
+    'open microphone': string;
+    'close microphone': string;
+    'camera enabled': string;
+    'camera disabled': string;
+    'microphone enabled': string;
+    'microphone disabled': string;
+    'speaker enabled': string;
+    'speaker disabled': string;
+    'open speaker': string;
+    'close speaker': string;
+    'wait to be called': string;
+    answered: string;
+    'people in the call': string;
+    'failed to obtain speakers': string;
+    'you have a new call': string;
+    'switch camera': string;
+    join: string;
+    'people on the call': string;
+    "Supports a maximum of 9 people for simultaneous calls": string;
+    you: string;
+    "The network is poor during your current call": string;
+    "The other user network is poor during the current call": string;
+    "TUICallKit init is not complete": string;
+    timeout: string;
+    'kick out': string;
+    'Invited group call': string;
+    'Those involved': string;
+    call: string;
+    'video-call': string;
+    'audio-call': string;
+    search: string;
+    'search-result': string;
+    'Wechat scan right QR code': string;
+    'Use-phone-and-computer': string;
+    'Scan the QR code above': string;
+    'no-user': string;
+    'member-not-added': string;
+    'not-login': string;
+    'login-status-expire': string;
+    'experience-multi-call': string;
+    'not-support-multi-call': string;
+    'input-phone-userID': string;
+    userID: string;
+    'already-enter': string;
+    waiting: string;
+    'camera-opened': string;
+    'camera-closed': string;
+    'microphone-opened': string;
+    'microphone-closed': string;
+    'image-resolution': string;
+    'default-image-resolution': string;
+    'invited-person': string;
+    'video-to-audio': string;
+    me: string;
+    'be-rejected': string;
+    'be-no-response': string;
+    'be-line-busy': string;
+    'be-canceled': string;
+    'voice-call-end': string;
+    'video-call-end': string;
+    'method-call-failed': string;
+    'failed-to-obtain-permission': string;
+    'environment-detection-failed': string;
+    'switchToAudioCall-call-failed': string;
+    'switchToVideoCall-call-failed': string;
+    'microphone-unavailable': string;
+    'camera-unavailable': string;
+    'ban-device': string;
+    'not-supported-webrtc': string;
+    'blacklist-user-tips': string;
+    'is-already-calling': string;
+    'need-init': string;
+    "can't call yourself": string;
+    'accept-error': string;
+    'accept-device-error': string;
+    'call-error': string;
+};

package/types/TUICallService/locales/zh-cn.d.ts

@@ -0,0 +1,123 @@
+export declare const zh: {
+    hangup: string;
+    reject: string;
+    accept: string;
+    camera: string;
+    microphone: string;
+    speaker: string;
+    'open camera': string;
+    'close camera': string;
+    'open microphone': string;
+    'close microphone': string;
+    'video-to-audio': string;
+    'virtual-background': string;
+    'other side reject call': string;
+    'reject call': string;
+    cancel: string;
+    'other side line busy': string;
+    'in busy': string;
+    'call timeout': string;
+    'end call': string;
+    'caller calling message': string;
+    'callee calling video message': string;
+    'callee calling audio message': string;
+    'no microphone access': string;
+    'no camera access': string;
+    'invite member': string;
+    'Invited group call': string;
+    'Those involved': string;
+    waiting: string;
+    me: string;
+    'browser-authorization': string;
+    'mac-privacy': string;
+    'win-privacy': string;
+    'mac-preferences': string;
+    'win-preferences': string;
+    'Please enter userID': string;
+    'View more': string;
+    'people selected': string;
+    'Select all': string;
+    Cancel: string;
+    Done: string;
+    'exist group call': string;
+    'camera enabled': string;
+    'camera disabled': string;
+    'microphone enabled': string;
+    'microphone disabled': string;
+    'speaker enabled': string;
+    'speaker disabled': string;
+    'open speaker': string;
+    'close speaker': string;
+    'wait to be called': string;
+    answered: string;
+    'people in the call': string;
+    'failed to obtain speakers': string;
+    'you have a new call': string;
+    'switch camera': string;
+    join: string;
+    'people on the call': string;
+    "Supports a maximum of 9 people for simultaneous calls": string;
+    you: string;
+    "The network is poor during your current call": string;
+    "The other user network is poor during the current call": string;
+    "TUICallKit init is not complete": string;
+    "Video call": string;
+    "Voice call": string;
+    "Call End": string;
+    "Switch voice call": string;
+    "Switch video call": string;
+    "Call duration": string;
+    "Call Cancel": string;
+    "Other Side Cancel": string;
+    Decline: string;
+    "Other Side Decline": string;
+    "No answer": string;
+    "Other Side No Answer": string;
+    Answered: string;
+    "Other Side Line Busy": string;
+    "Line Busy": string;
+    timeout: string;
+    'kick out': string;
+    call: string;
+    'video-call': string;
+    'audio-call': string;
+    search: string;
+    'search-result': string;
+    'Wechat scan right QR code': string;
+    'Use-phone-and-computer': string;
+    'Scan the QR code above': string;
+    'no-user': string;
+    'member-not-added': string;
+    'not-login': string;
+    'login-status-expire': string;
+    'experience-multi-call': string;
+    'not-support-multi-call': string;
+    'input-phone-userID': string;
+    userID: string;
+    'already-enter': string;
+    'image-resolution': string;
+    'default-image-resolution': string;
+    'invited-person': string;
+    'be-rejected': string;
+    'be-no-response': string;
+    'be-line-busy': string;
+    'be-canceled': string;
+    'voice-call-end': string;
+    'video-call-end': string;
+    'method-call-failed': string;
+    'failed-to-obtain-permission': string;
+    'environment-detection-failed': string;
+    'switchToAudioCall-call-failed': string;
+    'switchToVideoCall-call-failed': string;
+    'microphone-unavailable': string;
+    'camera-unavailable': string;
+    'ban-device': string;
+    'not-supported-webrtc': string;
+    'blacklist-user-tips': string;
+    'is-already-calling': string;
+    'need-init': string;
+    "can't call yourself": string;
+    'accept-error': string;
+    'accept-device-error': string;
+    'call-error': string;
+};

package/types/TUICallService/serve/callManager.d.ts

@@ -0,0 +1,11 @@
+export declare class CallManager {
+    private _globalCallPagePath;
+    init(params: any): Promise<void>;
+    private _watchTUIStore;
+    private _unwatchTUIStore;
+    private _handleCallStatusChange;
+    private _handleCallStatusToCalling;
+    private _handleCallStatusToIdle;
+    getRoute(): any;
+    destroyed(): Promise<void>;
+}

package/types/TUICallService/utils/common-utils.d.ts

@@ -0,0 +1,62 @@
+export declare const isUndefined: (input: any) => boolean;
+export declare const isPlainObject: (input: any) => boolean;
+export declare const isArray: (input: any) => boolean;
+export declare const isPrivateKey: (key: string) => boolean;
+export declare const isUrl: (url: string) => boolean;
+/**
+ * 检测input类型是否为string
+ * @param {*} input 任意类型的输入
+ * @returns {Boolean} true->string / false->not a string
+ */
+export declare const isString: (input: any) => boolean;
+export declare const isBoolean: (input: any) => boolean;
+export declare const isNumber: (input: any) => boolean;
+export declare function formatTime(secondTime: number): string;
+export declare function formatTimeInverse(stringTime: string): number;
+export declare function isJSON(str: string): boolean;
+export declare const JSONToObject: (str: string) => any;
+/**
+ * 重试函数, catch 时，重试
+ * @param {Promise} promise 需重试的函数
+ * @param {number} num 需要重试的次数
+ * @param {number} time 间隔时间（s）
+ * @returns {Promise<any>} im 接口的 response 原样返回
+ */
+export declare const retryPromise: (promise: Promise<any>, num?: number, time?: number) => Promise<any>;
+/**
+ * web call engine 重复调用时的错误, 这种错误在 TUICallKit 应该忽略
+ * @param {any} error 错误信息
+ * @returns {Boolean}
+ */
+export declare function handleRepeatedCallError(error: any): boolean;
+/**
+ * 设备无权限时的错误处理
+ * @param {any} error 错误信息
+ * @returns {Boolean}
+ */
+export declare function handleNoDevicePermissionError(error: any): boolean;
+export declare function performanceNow(): number;
+/**
+ * 检测input类型是否为function
+ * @param {*} input 任意类型的输入
+ * @returns {Boolean} true->input is a function
+ */
+export declare const isFunction: (input: any) => boolean;
+export declare const getLanguage: () => string;
+export declare function noop(e: any): void;
+/**
+ * Get the object type string
+ * @param {*} input 任意类型的输入
+ * @returns {String} the object type string
+ */
+export declare const getType: (input: any) => any;
+export declare function modifyObjectKey(obj: any, oldKey: any, newKey: any): any;
+/**
+ * interpolate function
+ * @param {string} str - 'hello {{name}}'
+ * @param {object} data - { name: 'sam' }
+ * @returns {string} 'hello sam'
+ *
+*/
+export declare function interpolate(str: any, data: any): any;
+export declare function initBrowserCloseDetection(callback: Function): void;

package/types/TUICallService/utils/decorators/promise-retry.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 异步函数重试 Interface
+ * @param {number} [retries = 5] 重试次数
+ * @param {number} [timeout = 2000] 重试间隔时间
+ * @param {Function=} onError 重试错误回调
+ * @param {Function=} onRetrying 重试回调
+ * @param {Function=} onRetryFailed 重试失败回调
+ */
+interface IPromiseRetryDecoratorSettings {
+    retries?: number;
+    timeout?: number;
+    onError?: Function;
+    onRetrying?: Function;
+    onRetryFailed?: Function;
+}
+/**
+ * 装饰器函数：给异步函数增加重试
+ * @param {Object} settings 入参
+ * @returns {Function}
+ * @example
+ * class LocalStream {
+ *   @promiseRetryDecorator({
+ *     retries: 10,
+ *     timeout: 3000,
+ *     onRetryFailed: function(error) {
+ *     }
+ *   })
+ *   async recoverCapture(options) {}
+ * }
+ */
+export default function promiseRetryDecorator(settings: IPromiseRetryDecoratorSettings): (target: any, name: any, descriptor: any) => any;
+export {};

package/types/TUICallService/utils/env.d.ts

@@ -0,0 +1,10 @@
+export declare const IN_WX_MINI_APP: boolean;
+export declare const IN_UNI_NATIVE_APP: boolean;
+export declare const IN_MINI_APP: boolean;
+export declare const IN_UNI_APP: boolean;
+export declare const IN_BROWSER: boolean;
+export declare const APP_NAMESPACE: any;
+export declare const IS_H5: boolean;
+export declare const IS_PC: boolean;
+export declare const IS_WIN: any;
+export declare const IS_MAC: any;

package/types/TUICallService/utils/index.d.ts

@@ -0,0 +1,2 @@
+export declare function checkLocalMP3FileExists(src: string): Promise<boolean>;
+export declare function deepClone(obj: any): any;

package/types/TUICallService/utils/is-empty.d.ts

@@ -0,0 +1,2 @@
+declare const isEmpty: (input: any) => boolean;
+export default isEmpty;

package/types/TUICallService/utils/retry.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 给异步函数封装重试逻辑
+ * @param {Object} options 重试逻辑入参
+ * @param {Object} options.retryFunction 需要封装的异步函数
+ * @param {Object} options.settings 重试属性
+ * @param {Number} [options.settings.retries = 5] 重试次数
+ * @param {Number} [options.settings.timeout = 1000] 重试间隔
+ * @param {onErrorCallback} options.onError 重试错误回调
+ * @param {onRetryingCallback} [options.onRetrying] 重试后的回调
+ * @param {Object} options.context 上下文，可选
+ * @returns {Function} 封装后的函数
+ * @example
+ * const getUserMedia = promiseRetry({
+ *   retryFunction: getUserMedia_,
+ *   settings: { retries: 5, timeout: 2000 },
+ *   onError: (error, retry, reject) => {
+ *     if (error.name === 'NotReadableError') {
+ *       retry();
+ *     } else {
+ *       reject(error);
+ *     }
+ *   },
+ *   onRetrying: retryCount => {
+ *     console.warn(`getUserMedia NotReadableError observed, retrying [${retryCount}/5]`);
+ *   }
+ * });
+ */
+declare function promiseRetry({ retryFunction, settings, onError, onRetrying, onRetryFailed, context }: {
+    retryFunction: any;
+    settings: any;
+    onError: any;
+    onRetrying: any;
+    onRetryFailed: any;
+    context: any;
+}): (...args: any[]) => Promise<unknown>;
+export default promiseRetry;