agora-electron-sdk 4.1.1-rc.1 → 4.2.0-dev.13

package/js/Utils.js

@@ -1,173 +1,168 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AgoraEnv = exports.classMix = exports.getDefaultRendererVideoConfig = exports.formatConfigByVideoSourceType = exports.objsKeysToLowerCase = exports.parseJSON = exports.logDebug = exports.logInfo = exports.logError = exports.logWarn = exports.deprecate = exports.DEBUG_TAG = exports.TAG = void 0;
-const AgoraBase_1 = require("./Private/AgoraBase");
-const AgoraMediaBase_1 = require("./Private/AgoraMediaBase");
-/**
- * @ignore
- */
-exports.TAG = '[Agora]: ';
-/**
- * @ignore
- */
-exports.DEBUG_TAG = '[Agora Debug]: ';
-/**
- * @ignore
- */
-const deprecate = (originApi, replaceApi) => (0, exports.logError)(`${exports.TAG} This method ${originApi} will be deprecated soon. `, replaceApi ? `Please use ${replaceApi} instead` : '');
-exports.deprecate = deprecate;
-/**
- * @ignore
- */
-const logWarn = (msg, ...optParams) => {
-    if (!exports.AgoraEnv.enableLogging) {
-        return;
-    }
-    console.warn(`${exports.TAG} ${msg}`, ...optParams);
-};
-exports.logWarn = logWarn;
-/**
- * @ignore
- */
-const logError = (msg, ...optParams) => {
-    if (!exports.AgoraEnv.enableLogging) {
-        return;
-    }
-    console.error(`${exports.TAG} ${msg}`, ...optParams);
-};
-exports.logError = logError;
-/**
- * @ignore
- */
-const logInfo = (msg, ...optParams) => {
-    if (!exports.AgoraEnv.enableLogging) {
-        return;
-    }
-    console.log(`${exports.TAG} ${msg}`, ...optParams);
-};
-exports.logInfo = logInfo;
-/**
- * @ignore
- */
-const logDebug = (msg, ...optParams) => {
-    if (!exports.AgoraEnv.enableLogging || !exports.AgoraEnv.enableDebugLogging) {
-        return;
-    }
-    console.warn(`${exports.DEBUG_TAG} ${msg}`, ...optParams);
-};
-exports.logDebug = logDebug;
-/**
- * @ignore
- */
-const parseJSON = (jsonString) => {
-    if (jsonString === '') {
-        return jsonString;
-    }
-    let obj;
-    try {
-        obj = JSON.parse(jsonString);
-    }
-    catch (error) {
-        (0, exports.logError)('parseJSON', error);
-    }
-    return obj || jsonString;
-};
-exports.parseJSON = parseJSON;
-/**
- * @ignore
- */
-const objsKeysToLowerCase = (array) => {
-    array.forEach((obj) => {
-        for (const key in obj) {
-            if (Object.prototype.hasOwnProperty.call(obj, key)) {
-                const element = obj[key];
-                obj[key.toLocaleLowerCase()] = element;
-            }
-        }
-    });
-};
-exports.objsKeysToLowerCase = objsKeysToLowerCase;
-/**
- * @ignore
- */
-const formatConfigByVideoSourceType = (videoSourceType, originChannelId = '', originUid = 0) => {
-    if (videoSourceType === undefined || videoSourceType === null) {
-        throw new Error(`must set videoSourceType`);
-    }
-    let uid = originUid;
-    let channelId = originChannelId;
-    switch (videoSourceType) {
-        case AgoraBase_1.VideoSourceType.VideoSourceCamera:
-        case AgoraBase_1.VideoSourceType.VideoSourceCameraPrimary:
-        case AgoraBase_1.VideoSourceType.VideoSourceScreen:
-        case AgoraBase_1.VideoSourceType.VideoSourceScreenSecondary:
-        case AgoraBase_1.VideoSourceType.VideoSourceTranscoded:
-            channelId = '';
-            uid = 0;
-            break;
-        case AgoraBase_1.VideoSourceType.VideoSourceRemote:
-            if (!uid || !channelId) {
-                throw new Error(`must set uid:${uid}} and channelId:${channelId}`);
-            }
-            break;
-        case AgoraBase_1.VideoSourceType.VideoSourceMediaPlayer:
-            channelId = '';
-            if (!uid) {
-                throw new Error(`must set uid(mediaPlayerId):${uid}}}`);
-            }
-            break;
-        default:
-            break;
-    }
-    return { uid, channelId, videoSourceType };
-};
-exports.formatConfigByVideoSourceType = formatConfigByVideoSourceType;
-/**
- * @ignore
- */
-const getDefaultRendererVideoConfig = (config) => {
-    const rendererOptions = Object.assign({
-        contentMode: AgoraMediaBase_1.RenderModeType.RenderModeFit,
-        mirror: false,
-    }, config.rendererOptions);
-    const { uid, channelId, videoSourceType } = (0, exports.formatConfigByVideoSourceType)(config.videoSourceType, config.channelId, config.uid);
-    return Object.assign(Object.assign({}, config), { uid, channelId, videoSourceType, rendererOptions });
-};
-exports.getDefaultRendererVideoConfig = getDefaultRendererVideoConfig;
-/**
- * @ignore
- */
-function classMix(...mixins) {
-    class MixClass {
-        constructor() {
-            for (let mixin of mixins) {
-                copyProperties(this, new mixin()); // 拷贝实例属性
-            }
-        }
-    }
-    for (let mixin of mixins) {
-        copyProperties(MixClass, mixin); // 拷贝静态属性
-        copyProperties(MixClass.prototype, mixin.prototype); // 拷贝原型属性
-    }
-    return MixClass;
-}
-exports.classMix = classMix;
-function copyProperties(target, source) {
-    for (let key of Reflect.ownKeys(source)) {
-        if (key !== 'constructor' && key !== 'prototype' && key !== 'name') {
-            let desc = Object.getOwnPropertyDescriptor(source, key);
-            Object.defineProperty(target, key, desc);
-        }
-    }
-}
-const agora = require('../build/Release/agora_node_ext');
-/**
- * @ignore
- */
-exports.AgoraEnv = {
-    enableLogging: true,
-    enableDebugLogging: false,
-    AgoraElectronBridge: new agora.AgoraElectronBridge(),
-};
-// @ts-ignore
-(window || global).AgoraEnv = exports.AgoraEnv;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgoraEnv = exports.classMix = exports.getDefaultRendererVideoConfig = exports.formatConfigByVideoSourceType = exports.objsKeysToLowerCase = exports.parseJSON = exports.logDebug = exports.logInfo = exports.logError = exports.logWarn = exports.deprecate = exports.DEBUG_TAG = exports.TAG = void 0;
+const AgoraMediaBase_1 = require("./Private/AgoraMediaBase");
+/**
+ * @ignore
+ */
+exports.TAG = '[Agora]: ';
+/**
+ * @ignore
+ */
+exports.DEBUG_TAG = '[Agora Debug]: ';
+/**
+ * @ignore
+ */
+const deprecate = (originApi, replaceApi) => (0, exports.logError)(`${exports.TAG} This method ${originApi} will be deprecated soon. `, replaceApi ? `Please use ${replaceApi} instead` : '');
+exports.deprecate = deprecate;
+/**
+ * @ignore
+ */
+const logWarn = (msg, ...optParams) => {
+    if (!exports.AgoraEnv.enableLogging) {
+        return;
+    }
+    console.warn(`${exports.TAG} ${msg}`, ...optParams);
+};
+exports.logWarn = logWarn;
+/**
+ * @ignore
+ */
+const logError = (msg, ...optParams) => {
+    if (!exports.AgoraEnv.enableLogging) {
+        return;
+    }
+    console.error(`${exports.TAG} ${msg}`, ...optParams);
+};
+exports.logError = logError;
+/**
+ * @ignore
+ */
+const logInfo = (msg, ...optParams) => {
+    if (!exports.AgoraEnv.enableLogging) {
+        return;
+    }
+    console.log(`${exports.TAG} ${msg}`, ...optParams);
+};
+exports.logInfo = logInfo;
+/**
+ * @ignore
+ */
+const logDebug = (msg, ...optParams) => {
+    if (!exports.AgoraEnv.enableLogging || !exports.AgoraEnv.enableDebugLogging) {
+        return;
+    }
+    console.warn(`${exports.DEBUG_TAG} ${msg}`, ...optParams);
+};
+exports.logDebug = logDebug;
+/**
+ * @ignore
+ */
+const parseJSON = (jsonString) => {
+    if (jsonString === '') {
+        return jsonString;
+    }
+    let obj;
+    try {
+        obj = JSON.parse(jsonString);
+    }
+    catch (error) {
+        (0, exports.logError)('parseJSON', error);
+    }
+    return obj || jsonString;
+};
+exports.parseJSON = parseJSON;
+/**
+ * @ignore
+ */
+const objsKeysToLowerCase = (array) => {
+    array.forEach((obj) => {
+        for (const key in obj) {
+            if (Object.prototype.hasOwnProperty.call(obj, key)) {
+                const element = obj[key];
+                obj[key.toLocaleLowerCase()] = element;
+            }
+        }
+    });
+};
+exports.objsKeysToLowerCase = objsKeysToLowerCase;
+/**
+ * @ignore
+ */
+const formatConfigByVideoSourceType = (videoSourceType, originChannelId = '', originUid = 0) => {
+    if (videoSourceType === undefined || videoSourceType === null) {
+        throw new Error(`must set videoSourceType:${videoSourceType}`);
+    }
+    let uid = originUid;
+    let channelId = originChannelId;
+    switch (videoSourceType) {
+        case AgoraMediaBase_1.VideoSourceType.VideoSourceCamera:
+        case AgoraMediaBase_1.VideoSourceType.VideoSourceCameraPrimary:
+        case AgoraMediaBase_1.VideoSourceType.VideoSourceScreen:
+        case AgoraMediaBase_1.VideoSourceType.VideoSourceScreenSecondary:
+        case AgoraMediaBase_1.VideoSourceType.VideoSourceTranscoded:
+            channelId = '';
+            uid = 0;
+            break;
+        case AgoraMediaBase_1.VideoSourceType.VideoSourceRemote:
+            if (!uid || !channelId) {
+                throw new Error(`must set uid:${uid} and channelId:${channelId}`);
+            }
+            break;
+        case AgoraMediaBase_1.VideoSourceType.VideoSourceMediaPlayer:
+            channelId = '';
+            if (!uid) {
+                throw new Error(`must set mediaPlayerId:${uid}`);
+            }
+            break;
+        default:
+            break;
+    }
+    return { uid, channelId, videoSourceType };
+};
+exports.formatConfigByVideoSourceType = formatConfigByVideoSourceType;
+/**
+ * @ignore
+ */
+const getDefaultRendererVideoConfig = (config) => {
+    const rendererOptions = Object.assign({}, exports.AgoraEnv.AgoraRendererManager?.defaultRenderConfig?.rendererOptions, config.rendererOptions);
+    const { uid, channelId, videoSourceType } = (0, exports.formatConfigByVideoSourceType)(config.videoSourceType, config.channelId, config.uid);
+    return { ...config, uid, channelId, videoSourceType, rendererOptions };
+};
+exports.getDefaultRendererVideoConfig = getDefaultRendererVideoConfig;
+/**
+ * @ignore
+ */
+function classMix(...mixins) {
+    class MixClass {
+        constructor() {
+            for (let mixin of mixins) {
+                copyProperties(this, new mixin()); // 拷贝实例属性
+            }
+        }
+    }
+    for (let mixin of mixins) {
+        copyProperties(MixClass, mixin); // 拷贝静态属性
+        copyProperties(MixClass.prototype, mixin.prototype); // 拷贝原型属性
+    }
+    return MixClass;
+}
+exports.classMix = classMix;
+function copyProperties(target, source) {
+    for (let key of Reflect.ownKeys(source)) {
+        if (key !== 'constructor' && key !== 'prototype' && key !== 'name') {
+            let desc = Object.getOwnPropertyDescriptor(source, key);
+            Object.defineProperty(target, key, desc);
+        }
+    }
+}
+const agora = require('../build/Release/agora_node_ext');
+/**
+ * @ignore
+ */
+exports.AgoraEnv = {
+    enableLogging: true,
+    enableDebugLogging: false,
+    webEnvReady: true,
+    AgoraElectronBridge: new agora.AgoraElectronBridge(),
+};

package/package.json

@@ -1,11 +1,20 @@
 {
   "name": "agora-electron-sdk",
-  "version": "4.1.1-rc.1",
+  "version": "4.2.0-dev.13",
   "description": "agora-electron-sdk",
-  "main": "js/AgoraSdk.js",
+  "main": "js/AgoraSdk",
   "types": "types/AgoraSdk.d.ts",
-  "repository": "https://github.com/AgoraIO-Extensions/Electron-SDK",
-  "author": "agora.io",
+  "source": "ts/AgoraSdk",
+  "files": [
+    "js",
+    "ts",
+    "types",
+    "scripts",
+    "gulpfile.*",
+    "agora_node_ext",
+    "common",
+    "extra"
+  ],
   "scripts": {
     "totalBuild": "cross-env-shell gulp totalBuild \\\"--INIT_CWD=$INIT_CWD\\\"",
     "build": "cross-env-shell gulp build \\\"--INIT_CWD=$INIT_CWD\\\"",
@@ -13,7 +22,7 @@
     "syncLib": "cross-env-shell gulp syncLib \\\"--INIT_CWD=$INIT_CWD\\\"",
     "buildJS": "cross-env-shell gulp buildJS \\\"--INIT_CWD=$INIT_CWD\\\"",
     "zipBuild": "cross-env-shell gulp zipBuild \\\"--INIT_CWD=$INIT_CWD\\\"",
-    "prepublishOnly": "cross-env-shell npm run buildJS \\\"--INIT_CWD=$INIT_CWD\\\"",
+    "prepack": "cross-env-shell npm run buildJS \\\"--INIT_CWD=$INIT_CWD\\\"",
     "build_mac_debug": "cmake-js rebuild --CDCMAKE_BUILD_TYPE=Debug --CDCMAKE_OSX_ARCHITECTURES=\"arm64;x86_64\" -G Xcode",
     "build_mac_release": "cmake-js rebuild --CDCMAKE_BUILD_TYPE=Release --CDCMAKE_OSX_ARCHITECTURES=\"arm64;x86_64\" -G Xcode",
     "build_windows_win32_debug": "cmake-js rebuild --arch=ia32 --CDCMAKE_OSX_ARCHITECTURES=\"i386\" --CDCMAKE_BUILD_TYPE=Debug -G \"Visual Studio 16 2019\" ",
@@ -23,7 +32,7 @@
     "build_linux_debug": "cmake-js rebuild --arch=x64 --CDCMAKE_BUILD_TYPE=Debug -G \"Unix Makefiles\"",
     "build_linux_release": "cmake-js rebuild --arch=x64 --CDCMAKE_BUILD_TYPE=Release -G \"Unix Makefiles\"",
     "test": "jest",
-    "typescript": "tsc --noEmit",
+    "typecheck": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
     "install": "cross-env-shell gulp NPM_Install \\\"--INIT_CWD=$INIT_CWD\\\"",
     "release": "release-it",
@@ -31,68 +40,47 @@
     "bootstrap": "yarn config set agora-electron-sdk-pre-built 0 && yarn example && yarn install && yarn patch-package && yarn ts_interface_builder && yarn totalBuild && yarn link && yarn example link agora-electron-sdk && yarn config delete agora-electron-sdk-pre-built",
     "ts_interface_builder": "ts-interface-builder ts/Private/*.ts -o ts/Private/ti/"
   },
-  "agora_electron": {
-    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.1.1-rc.1_DCG_Windows_Video_20230215_1032.zip",
-    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.1.1-rc.1_DCG_Mac_Video_20230215_1034.zip"
-  },
-  "dependencies": {
-    "bindings": "1.2.1",
-    "buffer": "^6.0.3",
-    "cross-env": "^7.0.3",
-    "download": "^8.0.0",
-    "extract-zip": "^2.0.1",
-    "fs-extra": "^9.1.0",
-    "gulp": "^4.0.2",
-    "gulp-cli": "^2.3.0",
-    "gulp-zip": "^5.1.0",
-    "json-bigint": "^1.0.0",
-    "jsonfile": "^6.1.0",
-    "lodash.isequal": "^4.5.0",
-    "minimist": "^1.2.5",
-    "rimraf": "^3.0.0",
-    "shelljs": "^0.8.4",
-    "ts-interface-checker": "^1.0.2",
-    "winston": "^3.3.3",
-    "yuv-buffer": "1.0.0",
-    "yuv-canvas": "1.2.6"
-  },
-  "files": [
-    "js",
-    "ts",
-    "types",
-    "scripts",
-    "gulpfile.*",
-    "agora_node_ext",
-    "common",
-    "extra"
+  "keywords": [
+    "electron",
+    "windows",
+    "mac"
   ],
+  "repository": "https://github.com/AgoraIO-Extensions/Electron-SDK",
+  "author": "Agora.io",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/AgoraIO-Extensions/Electron-SDK/issues"
+  },
+  "homepage": "https://github.com/AgoraIO-Extensions/Electron-SDK#readme",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@arkweid/lefthook": "^0.7.7",
     "@commitlint/config-conventional": "^17.0.2",
+    "@evilmartians/lefthook": "^1.2.2",
     "@release-it/conventional-changelog": "^5.0.0",
-    "@typescript-eslint/parser": "^5.33.0",
+    "@types/json-bigint": "^1.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
     "cmake-js": "6.3.2",
     "commitlint": "^17.0.2",
-    "cz-conventional-changelog": "3.3.0",
     "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^3.1.3",
-    "husky": "4.2.5",
+    "eslint-plugin-auto-import": "^0.1.1",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-react": "^7.30.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
     "patch-package": "^6.5.0",
     "prettier": "^2.0.5",
     "release-it": "^15.0.0",
     "ts-interface-builder": "^0.3.3",
     "typescript": "^4.5.2"
   },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "yarn lint && yarn typescript"
-    }
+  "engines": {
+    "node": ">= 14.0.0"
   },
+  "packageManager": "^yarn@1.22.15",
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
@@ -116,59 +104,29 @@
       }
     }
   },
-  "eslintConfig": {
-    "env": {
-      "node": true,
-      "browser": true,
-      "shared-node-browser": true
-    },
-    "parser": "@typescript-eslint/parser",
-    "extends": [
-      "prettier",
-      "eslint:recommended"
-    ],
-    "plugins": [
-      "prettier"
-    ],
-    "rules": {
-      "no-unused-vars": "off",
-      "@typescript-eslint/no-unused-vars": "off",
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
-        }
-      ]
-    },
-    "globals": {
-      "define": "readonly",
-      "obj_attrib": "readonly",
-      "info": "readonly",
-      "NodeJS": "readonly"
-    }
-  },
-  "eslintIgnore": [
-    "node_modules/",
-    "build/",
-    "dist/",
-    "js/",
-    "types/",
-    "ts/Private/ti/"
-  ],
-  "prettier": {
-    "quoteProps": "consistent",
-    "singleQuote": true,
-    "tabWidth": 2,
-    "trailingComma": "es5",
-    "useTabs": false
+  "dependencies": {
+    "bindings": "1.2.1",
+    "buffer": "^6.0.3",
+    "cross-env": "^7.0.3",
+    "download": "^8.0.0",
+    "extract-zip": "^2.0.1",
+    "fs-extra": "^9.1.0",
+    "gulp": "^4.0.2",
+    "gulp-cli": "^2.3.0",
+    "gulp-zip": "^5.1.0",
+    "json-bigint": "^1.0.0",
+    "jsonfile": "^6.1.0",
+    "lodash.isequal": "^4.5.0",
+    "minimist": "^1.2.5",
+    "rimraf": "^3.0.0",
+    "shelljs": "^0.8.4",
+    "ts-interface-checker": "^1.0.2",
+    "winston": "^3.3.3",
+    "yuv-buffer": "1.0.0",
+    "yuv-canvas": "1.2.6"
   },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
+  "agora_electron": {
+    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.2.0-dev.13_DCG_Windows_Video_20230426_0712.zip",
+    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.2.0-dev.13_DCG_Mac_Video_20230426_0712.zip"
   }
 }

package/scripts/bootstrap.js

@@ -1,6 +1,6 @@
+const child_process = require('child_process');
 const os = require('os');
 const path = require('path');
-const child_process = require('child_process');
 
 const root = path.resolve(__dirname, '..');
 const args = process.argv.slice(2);

package/scripts/build.js

@@ -1,4 +1,5 @@
 const { exec } = require('shelljs');
+
 const getConfig = require('./getConfig');
 const logger = require('./logger');
 const { getOS } = require('./util');

package/scripts/buildJS.js

@@ -1,13 +1,13 @@
 const { exec } = require('shelljs');
-const logger = require('./logger');
+
 const { cleanJSDir, cleanTypesDir } = require('./clean');
+const logger = require('./logger');
 
 const buildJS = async (cb) => {
   logger.info('Build js from typescript');
   await cleanJSDir();
   await cleanTypesDir();
-  await exec('tsc', { silent: false });
-  await exec('tsc -p dtsconfig.json', { silent: false });
+  await exec('tsc -p tsconfig.build.json', { silent: false });
   cb();
 };
 

package/scripts/clean.js

@@ -1,6 +1,7 @@
-const fs = require('fs-extra');
 const path = require('path');
 
+const fs = require('fs-extra');
+
 const destIrisSDKDir = path.join(__dirname, `../iris`);
 const buildDir = path.resolve(__dirname, '../build');
 

package/scripts/downloadPrebuild.js

@@ -1,10 +1,12 @@
 const path = require('path');
+
 const download = require('download');
 const fs = require('fs-extra');
-const { getOS } = require('./util');
-const logger = require('./logger');
+
 const { cleanBuildDir, cleanJSDir, buildDir } = require('./clean');
 const getConfig = require('./getConfig');
+const logger = require('./logger');
+const { getOS } = require('./util');
 
 const { platform, packageVersion, arch, no_symbol } = getConfig();
 
@@ -86,9 +88,7 @@ module.exports = async (cb) => {
       extract: true,
     });
   } catch (error) {
-    logger.error(error);
-    logger.error('Agora sdk download base sdk error');
-    throw new Error(error);
+    logger.error('Agora sdk download base sdk error', error);
   }
 
   if (no_symbol) {

package/scripts/getConfig.js

@@ -1,8 +1,9 @@
-const minimist = require('minimist');
 const path = require('path');
+
+const minimist = require('minimist');
+
 const logger = require('./logger');
 
-//@ts-ignore
 const { INIT_CWD } = minimist(process.argv.slice(2), {
   string: ['INIT_CWD'],
   default: {},