fcr-ui-scene 3.8.1 → 3.8.2

package/lib-es/utilities/tools.js

@@ -0,0 +1,252 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import "core-js/modules/es.array.concat.js";
+import "core-js/modules/es.array.reduce.js";
+import "core-js/modules/es.array.slice.js";
+import "core-js/modules/es.date.now.js";
+import "core-js/modules/es.number.constructor.js";
+import "core-js/modules/es.number.to-fixed.js";
+import "core-js/modules/es.object.to-string.js";
+import "core-js/modules/es.promise.js";
+import "core-js/modules/es.regexp.exec.js";
+import "core-js/modules/es.regexp.test.js";
+import "core-js/modules/es.string.ends-with.js";
+import "core-js/modules/es.string.match.js";
+import "core-js/modules/es.string.replace.js";
+import "core-js/modules/es.string.starts-with.js";
+import { AgoraScheduler } from 'agora-foundation/lib/schedule';
+import { getLogger } from 'agora-foundation/lib/logger';
+import { isWindows } from './platform';
+export var uint8ArrayToImageData = function uint8ArrayToImageData(target) {
+  var _target$buffer;
+  if (!target || !(target !== null && target !== void 0 && (_target$buffer = target.buffer) !== null && _target$buffer !== void 0 && _target$buffer.length)) {
+    return '';
+  }
+  var canvas = document.createElement('canvas');
+  var ctx = canvas.getContext('2d');
+  if (!ctx) return '';
+  var width = canvas.width = target.width;
+  var height = canvas.height = target.height;
+  var rowBytes = width * 4;
+  for (var row = 0; row < height; row++) {
+    var srow = row;
+    var imageData = ctx.createImageData(width, 1);
+    var start = srow * width * 4;
+    if (isWindows()) {
+      for (var i = 0; i < rowBytes; i += 4) {
+        imageData.data[i] = target.buffer[start + i + 2];
+        imageData.data[i + 1] = target.buffer[start + i + 1];
+        imageData.data[i + 2] = target.buffer[start + i];
+        imageData.data[i + 3] = target.buffer[start + i + 3];
+      }
+    } else {
+      for (var _i = 0; _i < rowBytes; ++_i) {
+        imageData.data[_i] = target.buffer[start + _i];
+      }
+    }
+    ctx.putImageData(imageData, 0, row);
+  }
+  return canvas.toDataURL('image/png');
+};
+var LocalStorage = /*#__PURE__*/function () {
+  function LocalStorage() {
+    _classCallCheck(this, LocalStorage);
+  }
+  return _createClass(LocalStorage, [{
+    key: "set",
+    value: function set(key, value) {
+      localStorage.setItem(key, value);
+    }
+  }, {
+    key: "get",
+    value: function get(key) {
+      return localStorage.getItem(key);
+    }
+  }, {
+    key: "remove",
+    value: function remove(key) {
+      localStorage.removeItem(key);
+    }
+  }, {
+    key: "clear",
+    value: function clear() {
+      localStorage.clear();
+    }
+  }]);
+}();
+export var storage = new LocalStorage();
+export var ASIDE_WIDTH = 'aside_width';
+export var PARTICIPANT_POSITION = 'participant_position';
+export var convertToFixedNumber = function convertToFixedNumber(value) {
+  var divisor = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 100;
+  var fractionDigits = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 2;
+  return Number((value / divisor).toFixed(fractionDigits));
+};
+var virtualSoundCardPatternList = [/BlackHole/i, /SoundFlower/i, /AgoraALD/i];
+export var matchVirtualSoundCardPattern = function matchVirtualSoundCardPattern(deviceName) {
+  return virtualSoundCardPatternList.reduce(function (prev, pattern) {
+    pattern.test(deviceName) && (prev = true);
+    return prev;
+  }, false);
+};
+export var isZipUrl = function isZipUrl(url) {
+  if (!url || typeof url !== 'string') return false;
+  var regex = /^https?:\/\/.+\.(zip)(\?.*)?$/i;
+  return regex.test(url);
+};
+export var isMp3OrWavUrl = function isMp3OrWavUrl(url) {
+  if (!url || typeof url !== 'string') return false;
+  var regex = /^https?:\/\/.+\.(mp3|wav)(\?.*)?$/i;
+  return regex.test(url);
+};
+export var isPngOrJpg = function isPngOrJpg(path) {
+  if (!path || typeof path !== 'string') return false;
+  return path.endsWith('.png') || path.endsWith('.jpg');
+};
+export var isMp4 = function isMp4(path) {
+  if (!path || typeof path !== 'string') return false;
+  return path.endsWith('.mp4');
+};
+export var isMp3OrWav = function isMp3OrWav(path) {
+  if (!path || typeof path !== 'string') return false;
+  return path.endsWith('.mp3') || path.endsWith('.wav');
+};
+export function getFileNameWithoutExtension(filePath) {
+  var match = filePath.match(/([^\\/]+)(?=\.\w+$)/);
+  return match ? match[1] : '';
+}
+export var setLanguage = function setLanguage(language) {
+  storage.set('$$fcr_language', language);
+};
+export var getLanguage = function getLanguage() {
+  return storage.get('$$fcr_language');
+};
+export var waitUntil = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee2(prediction, memo) {
+    var intervalMs,
+      timeout,
+      logger,
+      startTs,
+      _args2 = arguments;
+    return _regeneratorRuntime.wrap(function (_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          intervalMs = _args2.length > 2 && _args2[2] !== undefined ? _args2[2] : 100;
+          timeout = _args2.length > 3 && _args2[3] !== undefined ? _args2[3] : 3000;
+          logger = getLogger();
+          startTs = Date.now();
+          return _context2.abrupt("return", new Promise(function (resolve) {
+            var task = AgoraScheduler.shared.addPollingTask(/*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+              var isTrue;
+              return _regeneratorRuntime.wrap(function (_context) {
+                while (1) switch (_context.prev = _context.next) {
+                  case 0:
+                    if (!(Date.now() - startTs > timeout)) {
+                      _context.next = 1;
+                      break;
+                    }
+                    logger.warn("[wait-until] predict ".concat(memo, ": timeout"));
+                    task.stop();
+                    resolve();
+                    return _context.abrupt("return");
+                  case 1:
+                    isTrue = prediction();
+                    logger.info("[wait-until] predict ".concat(memo, ": ").concat(isTrue));
+                    if (isTrue) {
+                      task.stop();
+                      resolve();
+                    }
+                  case 2:
+                  case "end":
+                    return _context.stop();
+                }
+              }, _callee);
+            })), intervalMs, false);
+          }));
+        case 1:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  }));
+  return function waitUntil(_x, _x2) {
+    return _ref.apply(this, arguments);
+  };
+}();
+export var renderMeetingName = function renderMeetingName(meetingName) {
+  if (meetingName.length <= 20) return meetingName;
+  return meetingName.slice(0, 20) + '...';
+};
+export var renderMeetingId = function renderMeetingId(meetingId, roomId) {
+  var renderMeetingId = '';
+  if (meetingId) {
+    // 检查meetingId是否为纯数字
+    var isNumeric = /^\d+$/.test(meetingId);
+    if (!isNumeric) {
+      renderMeetingId = meetingId;
+    } else {
+      renderMeetingId = meetingId.replace(/(.{3})/g, '$1 ');
+    }
+  } else {
+    if (roomId.endsWith('-waiting')) {
+      renderMeetingId = roomId.slice(0, -8).replace(/(.{3})/g, '$1 ');
+    } else {
+      renderMeetingId = roomId.replace(/(.{3})/g, '$1 ');
+    }
+  }
+  return renderMeetingId;
+};
+export function calcAnnotationAreaSize(
+/**
+ * @param boardView {HTMLElement} 白板容器的 dom
+ */
+boardView,
+/**
+ * @param width {number} 分享容器的宽度
+ */
+width,
+/**
+ * @param height {number} 分享容器的高度
+ */
+height) {
+  var isProvider = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : true;
+  var logger = getLogger();
+  /**
+   * 如果宽大于高, 则把 boardView 的高度设置为 100vh, 然后获取 boardView 最新的高度
+   * 用新的高度计算宽高比为 16:9 的比例下的宽度是否大于原宽度，如果大于等于原宽度，则把 boardView 的高度设置为当前高度
+   * 以新的高度计算出宽高比为 16:9 的宽度，设置为当前宽度
+   * 否则，把 boardView 的宽度设置为100vw，并重新获取 boardView 的最新宽度，用新的宽度计算宽高比为 16:9 的高度
+   * 并分别设置 boardView 的高度和宽度
+   * 如果宽小于高，则把 boardView 的高度设置为 100vh, 然后获取 boardView 最新的高度
+   * 用新的高度计算宽高比为 16:9 的比例下宽度是否大于宽度，如果大于等于宽度，则把 boardView 的尺寸设置为当前宽度和高度
+   * */
+  if (width > height) {
+    boardView.style.height = isProvider ? "100vh" : "".concat(boardView.getBoundingClientRect().height, "px");
+    var newHeight = boardView.offsetHeight;
+    var ratioWidth = newHeight / 9 * 16;
+    if (ratioWidth >= width) {
+      boardView.style.width = "".concat(ratioWidth, "px");
+      boardView.style.height = "".concat(newHeight, "px");
+    } else {
+      boardView.style.width = isProvider ? "100vw" : "".concat(width, "px");
+      var newWidth = boardView.offsetWidth;
+      boardView.style.width = "".concat(newWidth, "px");
+      boardView.style.height = "".concat(newWidth / 16 * 9, "px");
+    }
+  } else {
+    boardView.style.height = isProvider ? "100vh" : "".concat(boardView.getBoundingClientRect().height, "px");
+    var _newHeight = boardView.offsetHeight;
+    boardView.style.width = "".concat(_newHeight / 9 * 16, "px");
+    boardView.style.height = "".concat(_newHeight, "px");
+  }
+  logger.info('annotation compute area size: ', boardView.style.width, '=====', boardView.style.height);
+}
+export var getBrowserLanguage = function getBrowserLanguage() {
+  var usrlang = navigator.language;
+  if (usrlang.startsWith('zh')) {
+    return 'zh';
+  }
+  return 'en';
+};

package/lib-es/utilities/ui-resources.js

@@ -0,0 +1,84 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import "core-js/modules/es.symbol.js";
+import "core-js/modules/es.array.concat.js";
+import "core-js/modules/es.array.filter.js";
+import "core-js/modules/es.array.for-each.js";
+import "core-js/modules/es.array.push.js";
+import "core-js/modules/es.object.define-properties.js";
+import "core-js/modules/es.object.define-property.js";
+import "core-js/modules/es.object.get-own-property-descriptor.js";
+import "core-js/modules/es.object.get-own-property-descriptors.js";
+import "core-js/modules/es.object.keys.js";
+import "core-js/modules/es.object.to-string.js";
+import "core-js/modules/esnext.iterator.constructor.js";
+import "core-js/modules/esnext.iterator.filter.js";
+import "core-js/modules/esnext.iterator.for-each.js";
+import "core-js/modules/web.dom-collections.for-each.js";
+// Asset types:
+// Electron
+// 1. Built-in assets: packaged with the app, no need to download
+// 2. Built-in asset URLs: which will be downloaded when the app starts
+// 3. User-defined assets: which will be downloaded when the app starts
+// Browser
+// 1. User-defined assets: asset URLs need to be in the same domain as the app
+
+export var BUILTIN_VIRTUAL_BACKGROUND_IMAGE_URL_LIST = [
+// Built-in assets URL
+// 'https://solutions-apaas.agora.io/fcr-ui-scene/picture/common/virtual_background_images.zip',
+'https://solutions-apaas.agora.io/fcr-ui-scene/picture/common/virtual_background_images_202505231623.zip'
+
+// in browser, images need to be in the same domain as the app
+// 'https://solutions-apaas.agora.io/fcr-ui-scene/picture/common/default1.jpg',
+// 'https://solutions-apaas.agora.io/fcr-ui-scene/picture/common/default2.jpg',
+// 'https://solutions-apaas.agora.io/fcr-ui-scene/picture/common/default3.jpg',
+// 'https://solutions-apaas.agora.io/fcr-ui-scene/picture/common/default4.jpg',
+// 'https://solutions-apaas.agora.io/fcr-ui-scene/picture/common/default5.jpg',
+// 'https://solutions-apaas.agora.io/fcr-ui-scene/picture/common/default6.jpg',
+// 'https://solutions-apaas.agora.io/fcr-ui-scene/picture/common/default7.jpg',
+];
+export var BUILTIN_VIRTUAL_BACKGROUND_VIDEO_URL_LIST = [
+// Built-in assets URL
+'https://solutions-apaas.agora.io/fcr-ui-scene/video/common/virtual_background_videos_202505231623.zip'
+// in browser, videos need to be in the same domain as the app
+// 'https://solutions-apaas.agora.io/fcr-ui-scene/video/common/default8.mp4',
+// 'https://solutions-apaas.agora.io/fcr-ui-scene/video/common/default9.mp4',
+];
+export var BUILTIN_SOUND_EFFECT_URL_MAP = {
+  // Built-in assets URL
+  cloudRecording: 'https://solutions-apaas.agora.io/fcr-ui-scene/audio/common/sound_effect_audios.zip',
+  userJoin: 'https://solutions-apaas.agora.io/fcr-ui-scene/audio/common/sound_effect_audios.zip'
+  // Use built-in mp3 for speaker test
+  // speakerTest: 'https://solutions-apaas.agora.io/fcr-ui-scene/audio/common/sound_effect_audios.zip',
+
+  // browser mp3
+  // cloudRecording:
+  //   'https://solutions-apaas.agora.io/fcr-ui-scene/audio/common/recording_started.mp3',
+  // userJoin: 'https://solutions-apaas.agora.io/fcr-ui-scene/audio/common/remote_user_joined.mp3',
+  // speakerTest: 'https://solutions-apaas.agora.io/fcr-ui-scene/audio/common/speaker_test.mp3',
+};
+export var getNormalDownloadResources = function getNormalDownloadResources(customResource) {
+  var _ref = customResource !== null && customResource !== void 0 ? customResource : {
+      virtualBackgroundImages: [],
+      virtualBackgroundVideos: [],
+      soundEffectAudios: {}
+    },
+    _ref$virtualBackgroun = _ref.virtualBackgroundImages,
+    virtualBackgroundImages = _ref$virtualBackgroun === void 0 ? [] : _ref$virtualBackgroun,
+    _ref$virtualBackgroun2 = _ref.virtualBackgroundVideos,
+    virtualBackgroundVideos = _ref$virtualBackgroun2 === void 0 ? [] : _ref$virtualBackgroun2,
+    _ref$soundEffectAudio = _ref.soundEffectAudios,
+    soundEffectAudios = _ref$soundEffectAudio === void 0 ? {} : _ref$soundEffectAudio;
+  var uiResources = {
+    virtualBackgroundImages: [].concat(BUILTIN_VIRTUAL_BACKGROUND_IMAGE_URL_LIST, _toConsumableArray(virtualBackgroundImages)),
+    virtualBackgroundVideos: [].concat(BUILTIN_VIRTUAL_BACKGROUND_VIDEO_URL_LIST, _toConsumableArray(virtualBackgroundVideos)),
+    soundEffectAudios: _objectSpread({
+      userJoin: BUILTIN_SOUND_EFFECT_URL_MAP.userJoin,
+      // speakerTest: BUILTIN_SOUND_EFFECT_URL_MAP.speakerTest,
+      cloudRecording: BUILTIN_SOUND_EFFECT_URL_MAP.cloudRecording
+    }, soundEffectAudios)
+  };
+  return uiResources;
+};

package/lib-es/utilities/useNamespace.js

@@ -0,0 +1,59 @@
+import "core-js/modules/es.array.concat.js";
+var defaultNamespace = 'fcr';
+var statePrefix = 'is-';
+var _bem = function _bem(namespace, block, blockSuffix, element, modifier) {
+  var cls = "".concat(namespace, "-").concat(block);
+  if (blockSuffix) {
+    cls += "-".concat(blockSuffix);
+  }
+  if (element) {
+    cls += "__".concat(element);
+  }
+  if (modifier) {
+    cls += "--".concat(modifier);
+  }
+  return cls;
+};
+export var useNamespace = function useNamespace(block) {
+  var namespace = defaultNamespace;
+  var b = function b() {
+    var blockSuffix = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+    return _bem(namespace, block, blockSuffix, '', '');
+  };
+  var e = function e(element) {
+    return element ? _bem(namespace, block, '', element, '') : '';
+  };
+  var m = function m(modifier) {
+    return modifier ? _bem(namespace, block, '', '', modifier) : '';
+  };
+  var be = function be(blockSuffix, element) {
+    return blockSuffix && element ? _bem(namespace, block, blockSuffix, element, '') : '';
+  };
+  var em = function em(element, modifier) {
+    return element && modifier ? _bem(namespace, block, '', element, modifier) : '';
+  };
+  var bm = function bm(blockSuffix, modifier) {
+    return blockSuffix && modifier ? _bem(namespace, block, blockSuffix, '', modifier) : '';
+  };
+  var bem = function bem(blockSuffix, element, modifier) {
+    return blockSuffix && element && modifier ? _bem(namespace, block, blockSuffix, element, modifier) : '';
+  };
+  var is = function is(name) {
+    for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+      args[_key - 1] = arguments[_key];
+    }
+    var state = args.length >= 1 ? args[0] : true;
+    return name && state ? "".concat(statePrefix).concat(name) : '';
+  };
+  return {
+    namespace: namespace,
+    b: b,
+    e: e,
+    m: m,
+    be: be,
+    em: em,
+    bm: bm,
+    bem: bem,
+    is: is
+  };
+};

package/lib-es/utilities/validate-params.js

@@ -0,0 +1,9 @@
+import "core-js/modules/es.error.cause.js";
+import "core-js/modules/es.error.to-string.js";
+import { generateFcrCoreClientError, FcrErrorCode } from 'fcr-core/lib/utilities/error';
+import { validateParams } from 'agora-foundation/lib/decorator';
+export default validateParams(function (error) {
+  var message = "invalid params: ".concat(error.message);
+  var fcrErrorModuleCode = '00';
+  generateFcrCoreClientError(fcrErrorModuleCode, FcrErrorCode.INVALID_PARAMS, message, new Error(message));
+});

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "fcr-ui-scene",
-  "version": "3.8.1",
+  "version": "3.8.2",
   "main": "lib/index.js",
   "repository": "ssh://git@git.agoralab.co/aduc/fcr-ui-scene-desktop.git",
   "author": "agora.io",
   "license": "MIT",
   "files": [
     "lib",
+    "lib-es",
     "public"
   ],
   "scripts": {
@@ -15,7 +16,7 @@
     "dev-electron": "agora-tc-dev-server --electron --main lib/electron/bootstrap-dev",
     "test-browser": "agora-tc-test-karma-browser",
     "test-electron": "agora-tc-test-karma-electron",
-    "build": "agora-tc-transpile",
+    "build": "agora-tc-transpile --esm",
     "bundle": "agora-tc-bundle --entry src/index && agora-tc-transpile --src ./src/electron --out dist/electron --transpile-only",
     "bundle-vite": "agora-tc-bundle-vite --main src/electron/bootstrap-sdk.ts --preload src/electron/preload.ts --renderer public/index.vite.html",
     "build-electron-mac-x64": "CSC_IDENTITY_AUTO_DISCOVERY=false agora-tc-pack-sdk --platform darwin --arch x64",
@@ -30,13 +31,14 @@
     "@react-spring/web": "^9.7.3",
     "@use-gesture/react": "^10.3.1",
     "agora-electron-sdk": "4.3.2-build.163-rc.3",
-    "agora-foundation": "3.8.1",
-    "agora-ui-foundation": "3.8.1",
+    "agora-foundation": "3.8.2",
+    "agora-ui-foundation": "3.8.2",
     "classnames": "^2.5.1",
     "core-js": "^3.33.3",
     "dayjs": "^1.10.4",
     "electron-screenshots": "^0.5.26",
-    "fcr-core": "3.8.1",
+    "fcr-core": "3.8.2",
+    "fcr-ui-widget-sdk": "3.8.0",
     "js-md5": "^0.8.3",
     "jszip": "^3.10.1",
     "lodash": "^4.17.21",
@@ -52,8 +54,7 @@
     "react-virtualized": "^9.22.5",
     "tinycolor2": "^1.6.0",
     "winston": "^3.16.0",
-    "winston-daily-rotate-file": "^4.7.1",
-    "fcr-ui-widget-sdk": "3.8.0"
+    "winston-daily-rotate-file": "^4.7.1"
   },
   "devDependencies": {
     "@babel/core": "^7.23.5",
@@ -64,11 +65,12 @@
     "@babel/preset-typescript": "^7.23.3",
     "@types/jasmine": "^5.1.4",
     "@types/lodash": "^4.17.0",
+    "@types/node": "^20.10.3",
     "@types/react": "^17.0.2",
     "@types/react-dom": "^17.0.11",
     "@types/react-virtualized": "^9.21.30",
     "@types/tinycolor2": "^1.4.6",
-    "agora-toolchain": "3.8.1",
+    "agora-toolchain": "3.8.2",
     "core-js": "^3.33.3",
     "electron": "22.3.27",
     "husky": "^9.0.11",
@@ -80,4 +82,4 @@
   "lint-staged": {
     "*.{ts,tsx,html,css}": "prettier --write"
   }
-}
+}