@tencentcloud/tuiroom-engine-js 3.2.1 → 3.2.2

package/dist/src/utils/validate.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 装饰器：参数校验（用于校验同步方法）
+ * 可传入多个 Rule，位置与 arguments 一一对应，用于校验 arguments
+ * @param {...Rule} configs
+ * @export
+ * @return {Function}
+ * @example
+ * @validate({
+ *   name: 'clientConfig',
+ *   required: true,
+ *   type: BASIC_TYPE.Object,
+ *   properties: {
+ *     sdkAppId: {
+ *       required: true,
+ *       type: BASIC_TYPE.Number,
+ *       allowEmpty: false
+ *     },
+ *     userId: {
+ *       required: true,
+ *       type: BASIC_TYPE.String,
+ *       allowEmpty: false
+ *     },
+ *     ...
+ *   }
+ * })
+ * createClient(clientConfig) {
+ */
+export declare function validate(...configs: any[]): (target: any, fnName: string, descriptor: any) => any;
+/**
+ * 装饰器：参数校验（用于校验异步方法）
+ * 可传入多个 Rule，位置与 arguments 一一对应，用于校验 arguments
+ * @param  {...Rule} configs
+ * @returns {Function}
+ * @example
+ * @validateAsync({
+ *   name: 'stream',
+ *   required: true,
+ *   instanceOf: LocalStream,
+ *   validate: function(stream) {
+ *     if (stream !== this.localStream_) {
+ *       throw new TUIError({
+ *         code: TUIErrorCode.ERR_INVALID_PARAMETER,
+ *         message: 'stream has not been published yet'
+ *       });
+ *     }
+ *   }
+ * })
+ * async unpublish() {...}
+ */
+export declare function validateAsync(...configs: any[]): (target: any, fnName: string, descriptor: any) => any;
+/**
+ * 若传入非箭头函数，则函数内的 this 指向对应的实例。
+ * @callback ValidateFunction
+ * @param {*} paramValue 用户传入的参数值
+ * @param {Object} instace 装饰器所在类的实例
+ */
+/**
+ * 参数校验规则
+ * @typedef {Object} Rule
+ * @property {Boolean} [required=false] 参数是否必填
+ * @property {BASIC_TYPE|BASIC_TYPE[]} [type=] 参数类型
+ * @property {Array} [values=] 参数取值
+ * @property {Function} [instanceOf=] 参数是某个类的实例
+ * @property {Boolean} [allowEmpty=true] 是否允许传空值:  0, NaN, '', '  '
+ * @property {Boolean} [notLessThanZero=] 数值是否可以小于0
+ * @property {ValidateFunction} [validate=] 自定义参数校验。回调函数的第一个参数是待校验的参数值、第二个参数是类的实例
+ * @property {Object.<string, Rule>} [properties=] 非必填，Object 类型的参数的属性校验规则
+ * @property {Object.<string, Rule>} [arrayItem=] 非必填，Array 类型的参数的 item 的属性校验规则
+ */

package/package.json

@@ -1,27 +1,65 @@
 {
   "name": "@tencentcloud/tuiroom-engine-js",
-  "version": "3.2.1",
+  "version": "3.2.2",
   "description": "TUIRoomEngine Web SDK",
-  "main": "index.js",
-  "module": "index.esm.js",
-  "types": "index.d.ts",
-  "keywords": [
-    "tuiroom",
-    "webrtc",
-    "im",
-    "javascript"
+  "main": "./dist/index.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
   ],
-  "homepage": "https://cloud.tencent.com/document/product/647/81970",
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:tencentyun/TUIRoom.git"
+  "scripts": {
+    "dev": "rollup -w -c rollup.config.dev.js",
+    "build": "rimraf -rf dist && rollup -c rollup.config.prod.js && node build/publish-package.js",
+    "build:jsdoc": "tsc && jsdoc -c ./build/jsdoc.json && node ./build/fix-doc.js",
+    "build:typedoc": "typedoc --options ./build/typedoc.json",
+    "test": "karma start karma.config.js"
   },
-  "author": "Tencent Cloud Client R&D Center",
+  "keywords": [],
+  "author": "xinlxinli",
   "license": "ISC",
+  "devDependencies": {
+    "@babel/core": "^7.12.16",
+    "@babel/preset-env": "^7.19.4",
+    "@rollup/plugin-commonjs": "^23.0.4",
+    "@rollup/plugin-json": "^5.0.2",
+    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@typescript-eslint/eslint-plugin": "^5.33.1",
+    "@typescript-eslint/parser": "^5.33.1",
+    "docdash-blue": "^1.1.9",
+    "eslint": "^8.22.0",
+    "eslint-config-tencent": "^1.0.4",
+    "fs-extra": "^11.0.0",
+    "jasmine-core": "^4.4.0",
+    "jsdoc": "^3.6.11",
+    "karma": "^6.4.1",
+    "karma-chrome-launcher": "^3.1.1",
+    "karma-jasmine": "^5.1.0",
+    "pretty": "^2.0.0",
+    "replace": "^1.2.1",
+    "rollup": "^2.78.0",
+    "rollup-plugin-babel": "^4.4.0",
+    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "tslib": "^2.4.0",
+    "typedoc": "^0.23.15",
+    "typescript": "^4.7.4",
+    "rimraf": "^6.0.1"
+  },
   "dependencies": {
-    "rtc-detect": "^0.0.5",
     "@tencentcloud/chat": "^3.5.5",
-    "trtc-cloud-js-sdk": "2.9.3",
-    "tcplayer.js": "5.3.4"
+    "core-js": "^3.8.3",
+    "eventemitter3": "^4.0.7",
+    "rtc-detect": "^0.0.5",
+    "tcplayer.js": "5.3.4",
+    "trtc-cloud-js-sdk": "2.9.3"
+  },
+  "browser": {
+    "fs": false,
+    "path": false,
+    "os": false,
+    "url": false
   }
 }