fcr-ui-scene 3.4.1 → 3.4.3

package/lib/base.d.ts

@@ -1,12 +1,47 @@
+import React from 'react';
+export interface FcrUINodeEvent {
+    type: string;
+    data: unknown;
+}
+export declare abstract class FcrUINode {
+    protected parentNode: FcrUINode;
+    protected rootNode: FcrUIRootNode;
+    protected subNodes: FcrUINode[];
+    protected isActive: boolean;
+    constructor(parentNode: FcrUINode, rootNode: FcrUIRootNode);
+    addSubNode(node: FcrUINode): void;
+    removeNode(node: FcrUINode): void;
+    removeAllSubNodes(): void;
+    nodeWillActive(): void;
+    nodeWillInactive(): void;
+    sendBroadcastEvent(event: FcrUINodeEvent): void;
+    sendPeerEvent(event: FcrUINodeEvent, node: FcrUINode): void;
+    onNodeWillActive(): void;
+    onNodeWillInactive(): void;
+    onNodeReceivedEvent(event: FcrUINodeEvent): void;
+}
+export declare abstract class FcrUIRootNode extends FcrUINode {
+    constructor();
+}
+export declare abstract class FcrBaseUIScene extends FcrUIRootNode {
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    abstract mount(dom: HTMLElement): void;
+    abstract unmount(dom: HTMLElement): void;
+    protected renderLayers(layers: JSX.Element[]): import("react/jsx-runtime").JSX.Element[];
+    protected renderWithErrorBoundary(layoutComponent: JSX.Element, spaceName: string): import("react/jsx-runtime").JSX.Element;
+    protected logError(error: Error, info: React.ErrorInfo, space: string): void;
+    private _handleUICrash;
+    private _fallbackComponent;
+}
+export declare const registerDependency: (depName: string) => void;
 /**
  * UI Module
  */
-export declare abstract class UIModule {
+export declare abstract class UIModule extends FcrUINode {
     protected readonly logger: import("agora-foundation/lib/logger").Logger;
-    constructor();
-    release(): void;
+    constructor(parentNode: FcrUINode, rootNode: FcrUIRootNode);
+    nodeWillActive(): void;
+    nodeWillInactive(): void;
     getComponent(props?: unknown): null | React.JSX.Element | Promise<React.JSX.Element> | React.ReactNode;
-    protected onLoad(): void;
-    protected onUnload(): void;
     protected onProcessEvent(event: RendererCustomEvent): void;
 }

package/lib/base.js

@@ -6,8 +6,6 @@ require("core-js/modules/es.symbol.to-primitive.js");
 require("core-js/modules/es.error.cause.js");
 require("core-js/modules/es.error.to-string.js");
 require("core-js/modules/es.array.is-array.js");
-require("core-js/modules/es.array.iterator.js");
-require("core-js/modules/es.array.push.js");
 require("core-js/modules/es.date.to-primitive.js");
 require("core-js/modules/es.function.bind.js");
 require("core-js/modules/es.function.name.js");
@@ -16,8 +14,7 @@ require("core-js/modules/es.number.constructor.js");
 require("core-js/modules/es.object.create.js");
 require("core-js/modules/es.object.define-property.js");
 require("core-js/modules/es.object.get-own-property-descriptor.js");
-require("core-js/modules/es.object.to-string.js");
-require("core-js/modules/es.string.iterator.js");
+require("core-js/modules/es.reflect.construct.js");
 require("core-js/modules/esnext.function.metadata.js");
 require("core-js/modules/esnext.map.delete-all.js");
 require("core-js/modules/esnext.map.emplace.js");
@@ -34,61 +31,276 @@ require("core-js/modules/esnext.map.reduce.js");
 require("core-js/modules/esnext.map.some.js");
 require("core-js/modules/esnext.map.update.js");
 require("core-js/modules/esnext.symbol.metadata.js");
-require("core-js/modules/web.dom-collections.iterator.js");
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.UIModule = void 0;
+exports.registerDependency = exports.UIModule = exports.FcrUIRootNode = exports.FcrUINode = exports.FcrBaseUIScene = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _get2 = _interopRequireDefault(require("@babel/runtime/helpers/get"));
+require("core-js/modules/es.array.concat.js");
+require("core-js/modules/es.array.filter.js");
+require("core-js/modules/es.array.for-each.js");
+require("core-js/modules/es.array.iterator.js");
+require("core-js/modules/es.array.map.js");
+require("core-js/modules/es.array.push.js");
+require("core-js/modules/es.object.to-string.js");
+require("core-js/modules/es.reflect.get.js");
+require("core-js/modules/es.reflect.has.js");
+require("core-js/modules/es.reflect.set.js");
+require("core-js/modules/es.set.js");
+require("core-js/modules/es.string.iterator.js");
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.filter.js");
+require("core-js/modules/esnext.iterator.for-each.js");
+require("core-js/modules/esnext.iterator.map.js");
+require("core-js/modules/esnext.set.add-all.js");
+require("core-js/modules/esnext.set.delete-all.js");
+require("core-js/modules/esnext.set.difference.v2.js");
+require("core-js/modules/esnext.set.difference.js");
+require("core-js/modules/esnext.set.every.js");
+require("core-js/modules/esnext.set.filter.js");
+require("core-js/modules/esnext.set.find.js");
+require("core-js/modules/esnext.set.intersection.v2.js");
+require("core-js/modules/esnext.set.intersection.js");
+require("core-js/modules/esnext.set.is-disjoint-from.v2.js");
+require("core-js/modules/esnext.set.is-disjoint-from.js");
+require("core-js/modules/esnext.set.is-subset-of.v2.js");
+require("core-js/modules/esnext.set.is-subset-of.js");
+require("core-js/modules/esnext.set.is-superset-of.v2.js");
+require("core-js/modules/esnext.set.is-superset-of.js");
+require("core-js/modules/esnext.set.join.js");
+require("core-js/modules/esnext.set.map.js");
+require("core-js/modules/esnext.set.reduce.js");
+require("core-js/modules/esnext.set.some.js");
+require("core-js/modules/esnext.set.symmetric-difference.v2.js");
+require("core-js/modules/esnext.set.symmetric-difference.js");
+require("core-js/modules/esnext.set.union.v2.js");
+require("core-js/modules/esnext.set.union.js");
+require("core-js/modules/web.dom-collections.for-each.js");
+require("core-js/modules/web.dom-collections.iterator.js");
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _logger = require("agora-foundation/lib/logger");
 var _rendererEvent = require("./utilities/renderer-event");
 var _decorator = require("agora-foundation/lib/decorator");
+var _react = _interopRequireDefault(require("react"));
+var _reactErrorBoundary = require("react-error-boundary");
+var _env = require("agora-foundation/lib/utilities/env");
+var _crashFallback = require("agora-ui-foundation/lib/components/crash-fallback");
+var _jsxRuntime = require("react/jsx-runtime");
 var _UIModule;
 var _initProto;
+function _superPropGet(t, o, e, r) { var p = (0, _get2["default"])((0, _getPrototypeOf2["default"])(1 & r ? t.prototype : t), o, e); return 2 & r && "function" == typeof p ? function (t) { return p.apply(e, t); } : p; }
 function _applyDecs(e, t, r, n, o, a) { function i(e, t, r) { return function (n, o) { return r && r(n), e[t].call(n, o); }; } function c(e, t) { for (var r = 0; r < e.length; r++) e[r].call(t); return t; } function s(e, t, r, n) { if ("function" != typeof e && (n || void 0 !== e)) throw new TypeError(t + " must " + (r || "be") + " a function" + (n ? "" : " or undefined")); return e; } function applyDec(e, t, r, n, o, a, c, u, l, f, p, d, h) { function m(e) { if (!h(e)) throw new TypeError("Attempted to access private element on non-instance"); } var y, v = t[0], g = t[3], b = !u; if (!b) { r || Array.isArray(v) || (v = [v]); var w = {}, S = [], A = 3 === o ? "get" : 4 === o || d ? "set" : "value"; f ? (p || d ? w = { get: _setFunctionName(function () { return g(this); }, n, "get"), set: function set(e) { t[4](this, e); } } : w[A] = g, p || _setFunctionName(w[A], n, 2 === o ? "" : A)) : p || (w = Object.getOwnPropertyDescriptor(e, n)); } for (var P = e, j = v.length - 1; j >= 0; j -= r ? 2 : 1) { var D = v[j], E = r ? v[j - 1] : void 0, I = {}, O = { kind: ["field", "accessor", "method", "getter", "setter", "class"][o], name: n, metadata: a, addInitializer: function (e, t) { if (e.v) throw Error("attempted to call addInitializer after decoration was finished"); s(t, "An initializer", "be", !0), c.push(t); }.bind(null, I) }; try { if (b) (y = s(D.call(E, P, O), "class decorators", "return")) && (P = y);else { var k, F; O["static"] = l, O["private"] = f, f ? 2 === o ? k = function k(e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function k(e) { return e[n]; }, (o < 2 || 4 === o) && (F = function F(e, t) { e[n] = t; })); var N = O.access = { has: f ? h.bind() : function (e) { return n in e; } }; if (k && (N.get = k), F && (N.set = F), P = D.call(E, d ? { get: w.get, set: w.set } : w[A], O), d) { if ("object" == _typeof(P) && P) (y = s(P.get, "accessor.get")) && (w.get = y), (y = s(P.set, "accessor.set")) && (w.set = y), (y = s(P.init, "accessor.init")) && S.push(y);else if (void 0 !== P) throw new TypeError("accessor decorators must return an object with get, set, or init properties or void 0"); } else s(P, (p ? "field" : "method") + " decorators", "return") && (p ? S.push(P) : w[A] = P); } } finally { I.v = !0; } } return (p || d) && u.push(function (e, t) { for (var r = S.length - 1; r >= 0; r--) t = S[r].call(e, t); return t; }), p || b || (f ? d ? u.push(i(w, "get"), i(w, "set")) : u.push(2 === o ? w[A] : i.call.bind(w[A])) : Object.defineProperty(e, n, w)), P; } function u(e, t) { return Object.defineProperty(e, Symbol.metadata || Symbol["for"]("Symbol.metadata"), { configurable: !0, enumerable: !0, value: t }); } if (arguments.length >= 6) var l = a[Symbol.metadata || Symbol["for"]("Symbol.metadata")]; var f = Object.create(null == l ? null : l), p = function (e, t, r, n) { var o, a, i = [], s = function s(t) { return _checkInRHS(t) === e; }, u = new Map(); function l(e) { e && i.push(c.bind(null, e)); } for (var f = 0; f < t.length; f++) { var p = t[f]; if (Array.isArray(p)) { var d = p[1], h = p[2], m = p.length > 3, y = 16 & d, v = !!(8 & d), g = 0 == (d &= 7), b = h + "/" + v; if (!g && !m) { var w = u.get(b); if (!0 === w || 3 === w && 4 !== d || 4 === w && 3 !== d) throw Error("Attempted to decorate a public method/accessor that has the same name as a previously decorated public method/accessor. This is not currently supported by the decorators plugin. Property name was: " + h); u.set(b, !(d > 2) || d); } applyDec(v ? e : e.prototype, p, y, m ? "#" + h : _toPropertyKey(h), d, n, v ? a = a || [] : o = o || [], i, v, m, g, 1 === d, v && m ? s : r); } } return l(o), l(a), i; }(e, t, o, f); return r.length || u(e, f), { e: p, get c() { var t = []; return r.length && [u(applyDec(e, [r], n, e.name, 5, f, t), f), c.bind(null, t, e)]; } }; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function _setFunctionName(e, t, n) { "symbol" == _typeof(t) && (t = (t = t.description) ? "[" + t + "]" : ""); try { Object.defineProperty(e, "name", { configurable: !0, value: n ? n + " " + t : t }); } catch (e) {} return e; }
 function _checkInRHS(e) { if (Object(e) !== e) throw TypeError("right-hand side of 'in' should be an object, got " + (null !== e ? _typeof(e) : "null")); return e; }
+function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2["default"])(o), (0, _possibleConstructorReturn2["default"])(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2["default"])(t).constructor) : o.apply(t, e)); }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+var FcrUINode = exports.FcrUINode = /*#__PURE__*/function () {
+  function FcrUINode(parentNode, rootNode) {
+    (0, _classCallCheck2["default"])(this, FcrUINode);
+    (0, _defineProperty2["default"])(this, "subNodes", []);
+    (0, _defineProperty2["default"])(this, "isActive", false);
+    this.parentNode = parentNode;
+    this.rootNode = rootNode;
+  }
+  return (0, _createClass2["default"])(FcrUINode, [{
+    key: "addSubNode",
+    value: function addSubNode(node) {
+      this.subNodes.push(node);
+      node.nodeWillActive();
+    }
+  }, {
+    key: "removeNode",
+    value: function removeNode(node) {
+      this.subNodes = this.subNodes.filter(function (subNode) {
+        return subNode !== node;
+      });
+      node.nodeWillInactive();
+    }
+  }, {
+    key: "removeAllSubNodes",
+    value: function removeAllSubNodes() {
+      this.subNodes.forEach(function (subNode) {
+        subNode.onNodeWillInactive();
+      });
+      this.subNodes = [];
+    }
+  }, {
+    key: "nodeWillActive",
+    value: function nodeWillActive() {
+      injectDependencies(this.rootNode, this);
+      this.isActive = true;
+      this.onNodeWillActive();
+      this.subNodes.forEach(function (subNode) {
+        subNode.nodeWillActive();
+      });
+    }
+  }, {
+    key: "nodeWillInactive",
+    value: function nodeWillInactive() {
+      this.isActive = false;
+      this.onNodeWillInactive();
+      this.subNodes.forEach(function (subNode) {
+        subNode.nodeWillInactive();
+      });
+    }
+  }, {
+    key: "sendBroadcastEvent",
+    value: function sendBroadcastEvent(event) {
+      this.rootNode.sendBroadcastEvent(event);
+    }
+  }, {
+    key: "sendPeerEvent",
+    value: function sendPeerEvent(event, node) {
+      node.onNodeReceivedEvent(event);
+    }
+
+    // sub class should override this method when needed
+  }, {
+    key: "onNodeWillActive",
+    value: function onNodeWillActive() {}
+
+    // sub class should override this method when needed
+  }, {
+    key: "onNodeWillInactive",
+    value: function onNodeWillInactive() {}
+
+    // sub class should override this method when needed
+  }, {
+    key: "onNodeReceivedEvent",
+    value: function onNodeReceivedEvent(event) {}
+  }]);
+}();
+var injectDependencies = function injectDependencies(rootNode, node) {
+  if (rootNode !== null) {
+    registeredDependencies.forEach(function (depName) {
+      if (Reflect.has(rootNode, depName)) {
+        Reflect.set(node, depName, Reflect.get(rootNode, depName));
+      }
+    });
+  }
+};
+var FcrUIRootNode = exports.FcrUIRootNode = /*#__PURE__*/function (_FcrUINode2) {
+  function FcrUIRootNode() {
+    (0, _classCallCheck2["default"])(this, FcrUIRootNode);
+    return _callSuper(this, FcrUIRootNode, [null, null]);
+  }
+  (0, _inherits2["default"])(FcrUIRootNode, _FcrUINode2);
+  return (0, _createClass2["default"])(FcrUIRootNode);
+}(FcrUINode);
+var FcrBaseUIScene = exports.FcrBaseUIScene = /*#__PURE__*/function (_FcrUIRootNode) {
+  function FcrBaseUIScene() {
+    var _this;
+    (0, _classCallCheck2["default"])(this, FcrBaseUIScene);
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    _this = _callSuper(this, FcrBaseUIScene, [].concat(args));
+    (0, _defineProperty2["default"])(_this, "logger", (0, _logger.getLogger)());
+    (0, _defineProperty2["default"])(_this, "_fallbackComponent", function () {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_crashFallback.FcrCrashFallback, {
+        handleFallback: _this._handleUICrash
+      });
+    });
+    return _this;
+  }
+  (0, _inherits2["default"])(FcrBaseUIScene, _FcrUIRootNode);
+  return (0, _createClass2["default"])(FcrBaseUIScene, [{
+    key: "renderLayers",
+    value: function renderLayers(layers) {
+      return layers.map(function (el, i) {
+        return /*#__PURE__*/(0, _jsxRuntime.jsx)(_react["default"].Fragment, {
+          children: el
+        }, i);
+      });
+    }
+  }, {
+    key: "renderWithErrorBoundary",
+    value: function renderWithErrorBoundary(layoutComponent, spaceName) {
+      var _this2 = this;
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactErrorBoundary.ErrorBoundary, {
+        FallbackComponent: this._fallbackComponent,
+        onError: function onError(error, info) {
+          return _this2.logError(error, info, spaceName);
+        },
+        children: /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+          style: {
+            width: '100vw',
+            height: '100vh'
+          },
+          children: layoutComponent
+        })
+      });
+    }
+  }, {
+    key: "logError",
+    value: function logError(error, info, space) {
+      var errorMessage = "[UIScene]: ErrorBoundary wrap ".concat(space, " error:");
+      var componentStackMessage = "componentStack: ".concat(info.componentStack);
+      this.logger.error("".concat(errorMessage, "\n") + "  Error: ".concat(error.message, "\n") + "  Stack: ".concat(error.stack, "\n") + "  ".concat(componentStackMessage));
+    }
+  }, {
+    key: "_handleUICrash",
+    value: function _handleUICrash() {
+      if ((0, _env.isElectron)()) {
+        window.runtime.quitApp();
+      } else {
+        window.location.reload();
+      }
+    }
+  }]);
+}(FcrUIRootNode); // Provider registration
+var registeredDependencies = new Set();
+var registerDependency = exports.registerDependency = function registerDependency(depName) {
+  (0, _logger.getLogger)().info("registger dependency: ".concat(depName));
+  registeredDependencies.add(depName);
+};
+
 /**
  * UI Module
  */
-var UIModule = exports.UIModule = /*#__PURE__*/function () {
-  function UIModule() {
+var UIModule = exports.UIModule = /*#__PURE__*/function (_FcrUINode3) {
+  function UIModule(parentNode, rootNode) {
+    var _this3;
     (0, _classCallCheck2["default"])(this, UIModule);
-    (0, _defineProperty2["default"])(this, "logger", (_initProto(this), (0, _logger.getLogger)()));
-    this.onLoad();
-    (0, _rendererEvent.addEventListener)(this.onProcessEvent);
+    _this3 = _callSuper(this, UIModule, [parentNode, rootNode]);
+    (0, _defineProperty2["default"])(_this3, "logger", (_initProto(_this3), (0, _logger.getLogger)()));
+    return _this3;
   }
+  (0, _inherits2["default"])(UIModule, _FcrUINode3);
   return (0, _createClass2["default"])(UIModule, [{
-    key: "release",
-    value: function release() {
+    key: "nodeWillActive",
+    value: function nodeWillActive() {
+      _superPropGet(UIModule, "nodeWillActive", this, 3)([]);
+      (0, _rendererEvent.addEventListener)(this.onProcessEvent);
+    }
+  }, {
+    key: "nodeWillInactive",
+    value: function nodeWillInactive() {
+      _superPropGet(UIModule, "nodeWillInactive", this, 3)([]);
       (0, _rendererEvent.removeEventListener)(this.onProcessEvent);
-      this.onUnload();
     }
   }, {
     key: "getComponent",
     value: function getComponent(props) {
       return null;
     }
-  }, {
-    key: "onLoad",
-    value: function onLoad() {}
-  }, {
-    key: "onUnload",
-    value: function onUnload() {}
   }, {
     key: "onProcessEvent",
     value: function onProcessEvent(event) {}
   }]);
-}();
+}(FcrUINode);
 _UIModule = UIModule;
-var _applyDecs$e = _applyDecs(_UIModule, [[_decorator.bound, 2, "onProcessEvent"]], []).e;
+var _applyDecs$e = _applyDecs(_UIModule, [[_decorator.bound, 2, "onProcessEvent"]], [], 0, void 0, FcrUINode).e;
 var _applyDecs$e2 = (0, _slicedToArray2["default"])(_applyDecs$e, 1);
 _initProto = _applyDecs$e2[0];
 _applyDecs$e;

package/lib/common/device-store.d.ts

@@ -91,7 +91,6 @@ export declare class FcrDeviceStore {
         speakerDeviceId: string;
     };
     constructor(_mediaControl: FcrDesktopMediaControl, _uiEventStore: FcrUIEventStore);
-    init(): Promise<void>;
     addObserver(observer: FcrDeviceObserver): void;
     removeObserver(observer: FcrDeviceObserver): void;
     startPlayLocalVideo(view: HTMLElement, isMirror?: boolean): void;
@@ -120,7 +119,7 @@ export declare class FcrDeviceStore {
     setCameraId(cameraId: string): void;
     setSpeakerId(speakerId: string): Promise<void>;
     setMicrophoneId(microphoneId: string): Promise<void>;
-    setSpeakerVolume(value: number): void;
+    setSpeakerVolume: import("lodash").DebouncedFuncLeading<(value: number) => void>;
     setMicrophoneVolume(value: number): void;
     actionsBeforeJoin(): void;
     startOrStopCamera(enable: boolean): void;
@@ -132,6 +131,8 @@ export declare class FcrDeviceStore {
     joinAudioByComputer(): Promise<void>;
     stopAudioByComputer(): void;
     private _fileToUiData;
+    openFirstCamera(): void;
+    openFirstMicrophone(): void;
     setConnectType(connectType: ConnectType): void;
     private _fetchZipAndUnzip;
     private _updateVirtualBackgroundList;