@trtc/calls-uikit-react 4.1.0

package/src/TUICallService/utils/validate/avoidRepeatedCall.ts

@@ -0,0 +1,39 @@
+import { NAME } from '../../const/index';
+
+/**
+ * 装饰器：阻止函数重复调用
+ * @export
+ * @param {Object} options 入参
+ * @param {Function} options.fn 函数
+ * @param {Object} options.context 上下文对象
+ * @param {String} options.name 函数名
+ * @returns {Function} 封装后的函数
+ */
+export function avoidRepeatedCall() {
+  return function (target: any, name: string, descriptor: any) {
+    const oldFn = descriptor.value;
+    const isCallingSet = new Set();
+    descriptor.value = async function (...args: any[]) {
+      if (isCallingSet.has(this)) {
+        console.warn((`${NAME.PREFIX}previous ${name}() is ongoing, please avoid repeated calls`));
+        // throw new Error(`previous ${name}() is ongoing, please avoid repeated calls`);
+        this?.getTUICallEngineInstance()?.reportLog?.({
+          name: 'TUICallKit.avoidRepeatedCall.fail',
+          data: { name },
+          error: `previous ${name}() is ongoing`,
+        });
+        return;
+      }
+      try {
+        isCallingSet.add(this);
+        const result = await oldFn.apply(this, args);
+        isCallingSet.delete(this);
+        return result;
+      } catch (error) {
+        isCallingSet.delete(this);
+        throw error;
+      }
+    };
+    return descriptor;
+  };
+}

package/src/TUICallService/utils/validate/index.ts

@@ -0,0 +1,7 @@
+import { avoidRepeatedCall } from './avoidRepeatedCall';
+// import { apiCallQueue } from "./apiCallQueue";
+
+export {
+  avoidRepeatedCall,
+  // apiCallQueue,
+};

package/src/TUICallService/utils/validate/validateConfig.ts

@@ -0,0 +1,188 @@
+import { NAME, MAX_NUMBER_ROOM_ID, VideoResolution, VideoDisplayMode } from "../../const/index";
+
+export const VALIDATE_PARAMS = {
+  init: {
+    SDKAppID: {
+      required: true,
+      rules: [NAME.NUMBER],
+      allowEmpty: false,
+    },
+    userID: {
+      required: true,
+      rules: [NAME.STRING],
+      allowEmpty: false,
+    },
+    userSig: {
+      required: true,
+      rules: [NAME.STRING],
+      allowEmpty: false,
+    },
+    tim: {
+      required: false,
+      rules: [NAME.OBJECT],
+    },
+  },
+  call: {
+    userID: {
+      required: true,
+      rules: [NAME.STRING],
+      allowEmpty: false
+    },
+    type: {
+      required: true,
+      rules: [NAME.NUMBER],
+      range: [1, 2],
+      allowEmpty: false
+    },
+    roomID: {
+      required: false,
+      rules: [NAME.NUMBER], // 仅支持数字房间号, 后续会支持字符串房间号
+      range: `1~${MAX_NUMBER_ROOM_ID}`,
+      allowEmpty: false,
+    },
+    userData: {
+      required: false,
+      rules: [NAME.STRING],
+      allowEmpty: false,
+    },
+    timeout: {
+      required: false,
+      rules: [NAME.NUMBER],
+      allowEmpty: false
+    }
+  },
+  groupCall: {
+    userIDList: {
+      required: true,
+      rules: [NAME.ARRAY],
+      allowEmpty: false
+    },
+    type: {
+      required: true,
+      rules: [NAME.NUMBER],
+      range: [1, 2],
+      allowEmpty: false
+    },
+    groupID: {
+      required: true,
+      rules: [NAME.STRING],
+      allowEmpty: false
+    },
+    roomID: {
+      required: false,
+      rules: [NAME.NUMBER], // 仅支持数字房间号, 后续会支持字符串房间号
+      range: `1~${MAX_NUMBER_ROOM_ID}`,
+      allowEmpty: false
+    },
+    timeout: {
+      required: false,
+      rules: [NAME.NUMBER],
+      allowEmpty: false
+    },
+    userData: {
+      required: false,
+      rules: [NAME.STRING],
+      allowEmpty: false,
+    },
+    offlinePushInfo: {
+      required: false,
+      rules: [NAME.OBJECT],
+      allowEmpty: false,
+    },
+  },
+  joinInGroupCall: {
+    type: {
+      required: true,
+      rules: [NAME.NUMBER],
+      range: [1, 2],
+      allowEmpty: false
+    },
+    groupID: {
+      required: true,
+      rules: [NAME.STRING],
+      allowEmpty: false
+    },
+    roomID: {
+      required: true,
+      rules: [NAME.NUMBER],
+      allowEmpty: false,
+    },
+  },
+  inviteUser: {
+    userIDList: {
+      required: true,
+      rules: [NAME.ARRAY],
+      allowEmpty: false
+    },
+  },
+  setSelfInfo: {
+    nickName: {
+      required: false,
+      rules: [NAME.STRING],
+      allowEmpty: false,
+    },
+    avatar: {
+      required: false,
+      rules: [NAME.STRING],
+      allowEmpty: false,
+    }
+  },
+  enableFloatWindow: [
+    {
+      key: "enable",
+      required: false,
+      rules: [NAME.BOOLEAN],
+      allowEmpty: false,
+    }
+  ],
+  enableAIVoice: [
+    {
+      key: "enable",
+      required: true,
+      rules: [NAME.BOOLEAN],
+      allowEmpty: false,
+    }
+  ],
+  enableMuteMode: [
+    {
+      key: "enable",
+      required: true,
+      rules: [NAME.BOOLEAN],
+      allowEmpty: false,
+    }
+  ],
+  setCallingBell: [
+    {
+      key: "filePath",
+      required: false,
+      rules: [NAME.STRING],
+      allowEmpty: true,
+    }
+  ],
+  setLanguage: [
+    {
+      key: "language",
+      required: true,
+      rules: [NAME.STRING],
+      allowEmpty: false
+    }
+  ],
+  setVideoDisplayMode: [
+    {
+      key: "displayMode",
+      required: true,
+      rules: [NAME.STRING],
+      range: [VideoDisplayMode.CONTAIN, VideoDisplayMode.COVER, VideoDisplayMode.FILL],
+      allowEmpty: false
+    }
+  ],
+  setVideoResolution: [
+    {
+      key: "resolution",
+      required: true,
+      rules: [NAME.STRING],
+      range: [VideoResolution.RESOLUTION_1080P, VideoResolution.RESOLUTION_480P, VideoResolution.RESOLUTION_720P],
+      allowEmpty: false
+    }
+  ]
+};

package/src/TUICallService/utils/validate/validateParams.ts

@@ -0,0 +1,88 @@
+import { getType, isArray, isString, isUndefined, isNumber, modifyObjectKey } from "../common-utils";
+import { NAME } from "../../const/index";
+const PREFIX = NAME.PREFIX + "API";
+
+export function paramValidate (config: any) {
+  return function (target, propertyName: string, descriptor: PropertyDescriptor) {
+    let method = descriptor.value;
+	  descriptor.value = function (...args) {
+      doValidate.call(this, config, args, propertyName);
+      return method.apply(this, args);
+	  };
+    return descriptor;
+  };
+}
+function doValidate(config, args, name) {
+  try {
+    // 兼容 init 方法中： SDKAppID sdkAppID 两种写法的参数校验判断
+    if (!args[0].SDKAppID) {
+      config = modifyObjectKey(config, "SDKAppID", "sdkAppID");
+    }
+    if (isArray(config)) {
+      for (let i = 0; i < config.length; i++) {
+        check.call(this, {
+          ...config[i],
+          value: args[i],
+          name,
+        });
+      }
+    } else {
+      for (const key in config) {
+        if (config.hasOwnProperty(key)) { 
+          check.call(this, {
+            ...config[key],
+            value: args[0][key],
+            name,
+            key,
+          });
+        }
+      }
+    }
+  } catch (error) {
+    console.error(error);
+    throw error;
+  }
+}
+function check({ required, rules, range, value, allowEmpty, name, key }) {
+  // 用户没传指定参数
+  if (isUndefined(value)) {
+    // 检查必填参数, 若配置是必填则报错
+    if (required) {
+      throw new Error(`${PREFIX}<${name}>: ${key} is required.`);
+    } else {
+      return;
+    }
+  }
+  // 判断参数类型是否正确
+  const result = rules.some((item)=>item === getType(value));
+  let type  = '';
+  if (!result) {
+    for (let i = 0; i < rules.length; i++) {
+      let str = rules[i];
+      str = str.replace(str[0], str[0].toUpperCase());
+      type += `${str}/`;
+    }
+    type = type.substring(0, type.length - 1);
+    throw new Error(`${PREFIX}<${name}>: ${key} must be ${type}, current ${key} is ${typeof value}.`);
+  }
+  // 不允许传空值, 例如: '', '  '
+  if (allowEmpty === false) {
+    const isEmptyString = isString(value) && value.trim() === '';
+    if (isEmptyString) {
+      throw new Error(`${PREFIX}<${name}>: ${key} is blank.`);
+    }
+  }
+  // 判断是否符合限制条件
+  if (isArray(range)) {
+    if (range && range.indexOf(value) === -1) {
+      throw new Error(`${PREFIX}<${name}>: ${key} error, only be ${range}, current ${key} is ${value}.`);
+    }
+  }
+  // 取值范围, 前闭后闭
+  if (isString(range) && range.indexOf('~') !== -1) {
+    const valueList = range.split('~');
+    if (value < +valueList[0] || value > +valueList[1] || (isNumber(value) && Number.isNaN(value))) {
+      throw new Error(`${PREFIX}<${name}>: ${key} error, only be ${range}, current ${key} is ${value}.`);
+    }
+  }
+}

package/src/TUICallService/utils/validate/validateStatus.ts

@@ -0,0 +1,26 @@
+import { NAME } from "../../const/index";
+import { t } from '../../locales/index';
+
+interface IStatusValidateParams {
+  engineInstance?: boolean;
+}
+
+export function statusValidate (config: IStatusValidateParams) {
+	return function (target, propertyName: string, descriptor: PropertyDescriptor) {
+    let method = descriptor.value;
+    descriptor.value = function (...args: Array<any>) {
+      doValidate.call(this, config, args, propertyName);
+      return method.apply(this, args);
+		};
+    return descriptor;
+  };
+}
+
+function doValidate(config) {
+  if (config?.engineInstance && !this._tuiCallEngine) {
+    const error = `${NAME.PREFIX} ${t('TUICallKit init is not complete')}`;
+    console.error(error);
+    throw error;
+  }
+}
+

package/src/image.d.ts

@@ -0,0 +1,8 @@
+declare module '*.svg'
+declare module '*.png'
+declare module '*.jpg'
+declare module '*.jpeg'
+declare module '*.gif'
+declare module '*.bmp'
+declare module '*.tiff'
+declare module '*.mp3'

package/src/index.ts

@@ -0,0 +1,63 @@
+import {
+  TUIGlobal,
+  TUIStore,
+  StoreName,
+  TUICallKitAPI,
+  NAME,
+  StatusChange as STATUS,
+  CallRole,
+  CallMediaType,
+  VideoResolution,
+  VideoDisplayMode,
+  t,
+  uiDesign,
+  FeatureButton,
+  LayoutMode,
+} from './TUICallService/index';
+import CallMessage from './Components/components/common/CallMessage/CallMessage.tsx';
+// @ts-ignore
+import TUICallKit from './Components/TUICallKit/TUICallKit.tsx';
+const plugin = (TUICore) => {
+  TUICore.component('TUICallKit', { server: TUICallKitAPI });
+  TUICallKitAPI.bindTUICore(TUICore);
+  return TUICallKit;
+};
+const install = (app) => {
+  app.component('TUICallKit', TUICallKit);
+  console.log('TUICallKit&mini installed', app);
+};
+// @ts-ignore
+TUICallKit.plugin = plugin;
+// @ts-ignore
+TUICallKit.install = install;
+// Web TUICallKit ≤v2.2.1 抛出的字段
+const TUICallType = {
+  AUDIO_CALL: 1,
+  VIDEO_CALL: 2,
+};
+const Version = '4.1.0'; // basic-demo 原来上报使用
+
+// 输出产物
+export {
+  TUIGlobal,
+  TUIStore,
+  StoreName,
+  TUICallKitAPI,
+  // uni-app 打包小程序无法引入 vue 组件, 只能在使用侧单独引入 vue 文件
+  TUICallKit,
+  plugin,
+  install,
+  TUICallType,
+  NAME,
+  STATUS,
+  CallRole,
+  CallMediaType,
+  VideoResolution,
+  VideoDisplayMode,
+  Version,
+  t,
+  uiDesign,
+  FeatureButton,
+  LayoutMode,
+  CallMessage,
+};

package/src/style.d.ts

@@ -0,0 +1 @@
+declare module '*.module.scss'