fcr-core/lib/room-control/whiteboard-control/index.js

Core APIs for building online scenes

"use strict";

require("core-js/modules/es.symbol.description.js");
require("core-js/modules/es.error.cause.js");
require("core-js/modules/es.array.push.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");
require("core-js/modules/esnext.map.every.js");
require("core-js/modules/esnext.map.filter.js");
require("core-js/modules/esnext.map.find.js");
require("core-js/modules/esnext.map.find-key.js");
require("core-js/modules/esnext.map.includes.js");
require("core-js/modules/esnext.map.key-of.js");
require("core-js/modules/esnext.map.map-keys.js");
require("core-js/modules/esnext.map.map-values.js");
require("core-js/modules/esnext.map.merge.js");
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/esnext.weak-map.delete-all.js");
require("core-js/modules/esnext.weak-map.emplace.js");
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.FcrWhiteboardControlImpl = void 0;
require("core-js/modules/es.regexp.exec.js");
require("core-js/modules/esnext.async-iterator.map.js");
require("core-js/modules/esnext.iterator.map.js");
require("core-js/modules/web.dom-collections.iterator.js");
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _whiteWebSdk = require("white-web-sdk");
var netlessVideoPlugin = _interopRequireWildcard(require("@netless/video-js-plugin"));
var _windowManager = require("@netless/window-manager");
var _utils = require("./utils");
var _observable = require("agora-foundation/lib/utilities/observable");
var _asyncRetry = require("agora-foundation/lib/utilities/async-retry");
var _boardWindow = require("./board-window");
var _enums = require("./enums");
var _decorator = require("agora-foundation/lib/decorator");
var _user = require("../../utilities/user");
var _2 = require("../..");
var _logger = require("../../utilities/logger");
var _error = require("../../utilities/error");
var _FcrWhiteboardControlImpl;
let _initProto;
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
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 (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 (e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function (e) { return e[n]; }, (o < 2 || 4 === o) && (F = function (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 (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; }
/**
 * @internal
 */
class FcrWhiteboardControlImpl {
  constructor(_scene, _privilegeControl, _api) {
    (0, _defineProperty2.default)(this, "logger", (_initProto(this), (0, _logger.getLogger)()));
    (0, _defineProperty2.default)(this, "_client", {});
    (0, _defineProperty2.default)(this, "_joined", false);
    (0, _defineProperty2.default)(this, "_connectState", _2.FcrConnectionState.DISCONNECTED);
    (0, _defineProperty2.default)(this, "_observable", new _observable.AgoraObservable());
    (0, _defineProperty2.default)(this, "_options", {
      debug: false
    });
    this._scene = _scene;
    this._privilegeControl = _privilegeControl;
    this._api = _api;
    _scene.addObserver({
      onScenePropertiesUpdated: (_, event) => {
        var _event$cause;
        const operatorUser = (0, _user.convertRteUserToFcrUser)(event.operatorUser);
        if (((_event$cause = event.cause) === null || _event$cause === void 0 ? void 0 : _event$cause.cmd) === 10) {
          var _ref, _event$cause$data$wid2;
          const {
            state,
            extra: {
              backgroundColor: bgColor
            }
          } = (_ref = _scene.getScenePropertiesByKeyPath('widgets.netlessBoard')) !== null && _ref !== void 0 ? _ref : {
            state: 0,
            extra: {
              backgroundColor: '#fff'
            }
          };
          if (state === 1) {
            this._observable.notifyObservers('onActive', _scene.getScenePropertiesByKeyPath('widgets.netlessBoard').ownerUserUuid, operatorUser);
          }
          if (state === 0) {
            var _event$cause$data$wid;
            this._observable.notifyObservers('onInactive', (_event$cause$data$wid = event.cause.data.widgetCause) === null || _event$cause$data$wid === void 0 || (_event$cause$data$wid = _event$cause$data$wid.data) === null || _event$cause$data$wid === void 0 ? void 0 : _event$cause$data$wid.reason, operatorUser);
          }
          if (((_event$cause$data$wid2 = event.cause.data.widgetCause) === null || _event$cause$data$wid2 === void 0 ? void 0 : _event$cause$data$wid2.cmd) === 100101) {
            this._observable.notifyObservers('onBackgroundColorUpdated', bgColor, operatorUser);
          }
        }
      }
    });
    this._addLogObserver();
  }
  async active() {
    return (0, _error.handleRequestError)(() => this._api.toggleWhiteboardActivityState(this._scene.sceneId, _enums.FcrSharePermissionState.ON), _error.FcrErrorModuleCode.ROOM_WHITEBOARD, 'active failed');
  }
  async inactive() {
    return (0, _error.handleRequestError)(() => this._api.toggleWhiteboardActivityState(this._scene.sceneId, _enums.FcrSharePermissionState.OFF), _error.FcrErrorModuleCode.ROOM_WHITEBOARD, 'inactive failed');
  }
  async open() {
    var _this$_scene$getUser;
    // 白板权限禁用状态下，主持人和联席主持人仍然可以发起共享，所以，不能根据是否禁用状态直接拒绝
    const roomId = this._scene.sceneId;
    const userId = this._scene.localUser.getLocalUserId();
    const cursorName = (_this$_scene$getUser = this._scene.getUser(userId)) === null || _this$_scene$getUser === void 0 ? void 0 : _this$_scene$getUser.userName;
    const {
      data
    } = await this._getToken(roomId, userId);
    const {
      boardAppId,
      boardId,
      boardRegion,
      boardToken
    } = data || {};
    this._joined = true;
    if (this._connectState !== _2.FcrConnectionState.DISCONNECTED) {
      return this._boardView;
    }
    const plugins = this._createPlugins();
    this._client = new _whiteWebSdk.WhiteWebSdk({
      appIdentifier: boardAppId,
      useMobXState: true,
      pptParams: {
        useServerWrap: true
      },
      deviceType: _whiteWebSdk.DeviceType.Surface,
      plugins,
      preloadDynamicPPT: true,
      loggerOptions: {
        reportQualityMode: _whiteWebSdk.LoggerReportMode.AlwaysReport,
        reportDebugLogMode: _whiteWebSdk.LoggerReportMode.AlwaysReport,
        reportLevelMask: this._options.debug ? 'debug' : 'info',
        printLevelMask: this._options.debug ? 'debug' : 'info'
      }
    });
    const hasPermission = true;
    const joinParams = {
      region: boardRegion,
      uuid: boardId,
      uid: userId,
      roomToken: boardToken,
      isWritable: hasPermission,
      disableDeviceInputs: false,
      disableCameraTransform: true,
      disableNewPencil: false,
      disableEraseImage: false,
      wrappedComponents: [],
      invisiblePlugins: [_windowManager.WindowManager],
      useMultiViews: true,
      disableMagixEventDispatchLimit: true,
      userPayload: {
        userId,
        avatar: '',
        cursorName,
        disappearCursor: true
      },
      floatBar: {
        colors: _utils.textColors.map(color => (0, _utils.hexColorToWhiteboardColor)(color))
      }
    };
    try {
      const retriesMax = 10;
      this._updateConnnectionState(_2.FcrConnectionState.CONNECTING);
      await (0, _asyncRetry.retryAttempt)(async () => {
        const room = await this._client.joinRoom(joinParams, {
          onPhaseChanged: this._handleConnectionStateUpdated,
          onRoomStateChanged: this._handleRoomStateUpdated
        });
        this._room = room;
        room.setViewMode(_whiteWebSdk.ViewMode.Broadcaster);
        this._boardView = new _boardWindow.FcrBoardMainWindowImpl(room, this._privilegeControl);
        this._updateConnnectionState(_2.FcrConnectionState.CONNECTED);
      }, [], {
        retriesMax
      }).fail(async _ref2 => {
        let {
          error,
          timeFn,
          currentRetry
        } = _ref2;
        this.logger.info("failed to join board room, error: ".concat(error.message, ", current retry: ").concat(currentRetry));
        if (this._joined) {
          await timeFn();
        }
        this.logger.info("continue attemptting? ".concat(this._joined));
        return this._joined;
      }).abort(() => {
        this._updateConnnectionState(_2.FcrConnectionState.DISCONNECTED);
      }).exec();
    } catch (e) {
      this._updateConnnectionState(_2.FcrConnectionState.DISCONNECTED);
    }
    return this._boardView;
  }
  async close() {
    this._joined = false;
    if (this._boardView) {
      // @ts-ignore
      this._boardView.destroy();
      this._boardView = undefined;
    }
    if (this._room) {
      try {
        // Workaround for whiteboard sdk issue: frameGenerator being null when disconnecting will cause error and trigger 'did-finish-loading' event in electron.
        // Set writable to false to prevent this error from throwing.
        this.logger.info('change writable to false before disconnecting');
        this._room.setWritable(false);
        await this._room.disconnect();
      } catch (e) {}
      this._room = undefined;
    }
  }
  async setBackgroundColor(backgroundColor) {
    this._api.setBackgroundColor({
      roomId: this._scene.sceneId,
      backgroundColor
    }).then(() => {
      Promise.resolve();
    }).catch(e => {
      Promise.reject(e);
    });
  }
  getActivity() {
    return this._scene.getScenePropertiesByKeyPath('widgets.netlessBoard').state === 1;
  }
  getOwnerId() {
    return this._scene.getScenePropertiesByKeyPath('widgets.netlessBoard.ownerUserUuid');
  }
  getBackgroundColor() {
    return this._scene.getScenePropertiesByKeyPath('widgets.netlessBoard.extra.backgroundColor');
  }
  getConnectionState() {
    return this._connectState;
  }
  getMainWindow() {
    return this._boardView;
  }
  addObserver(observer) {
    this._observable.addObserver(observer);
  }
  removeObserver(observer) {
    this._observable.removeObserver(observer);
  }
  getBoardActiveInfo() {
    const {
      state,
      ownerUserUuid: ownerUserId
    } = this._scene.getScenePropertiesByKeyPath('widgets.netlessBoard') || {
      isActive: false,
      ownerUserUuid: null
    };
    const isActive = state === _enums.FcrSharePermissionState.ON;
    return {
      isActive,
      ownerUserId
    };
  }
  async leave() {
    var _this$_boardView, _this$_room;
    //@ts-ignore
    (_this$_boardView = this._boardView) === null || _this$_boardView === void 0 || _this$_boardView.destroy();
    this._boardView = undefined;
    (_this$_room = this._room) === null || _this$_room === void 0 || _this$_room.disconnect();
    this._room = undefined;
  }
  _createPlugins() {
    const plugins = (0, _whiteWebSdk.createPlugins)({
      [netlessVideoPlugin.PluginId]: netlessVideoPlugin.videoJsPlugin()
    });
    plugins.setPluginContext(netlessVideoPlugin.PluginId, {
      enable: true,
      verbose: true
    });
    return plugins;
  }
  async _getToken(roomId, userId) {
    return await (0, _error.handleRequestError)(() => this._api.getWhiteboardToken({
      roomId,
      userId
    }), _error.FcrErrorModuleCode.ROOM_WHITEBOARD, 'get whiteboard token failed');
  }
  _handleRoomStateUpdated(state) {
    const {
      memberState
    } = state;
    if (memberState) {
      const {
        strokeColor,
        strokeWidth,
        currentApplianceName,
        textSize,
        shapeType
      } = memberState;
      const localState = {};
      const [tool, shape] = (0, _utils.convertToFcrBoardToolShape)(currentApplianceName, shapeType);
      localState.tool = tool;
      localState.shape = shape;
      if (typeof strokeColor !== 'undefined') {
        const [r, g, b] = strokeColor;
        localState.strokeColor = {
          r,
          g,
          b
        };
      }
      if (typeof strokeWidth !== 'undefined') {
        localState.strokeWidth = strokeWidth;
      }
      if (typeof textSize !== 'undefined') {
        localState.textSize = textSize;
      }
    }
  }
  _updateConnnectionState(state) {
    this._connectState = state;
    this._observable.notifyObservers('onConnectionStateUpdated', state);
  }
  _handleConnectionStateUpdated(phase) {
    if (phase === _whiteWebSdk.RoomPhase.Connecting) {
      this._updateConnnectionState(_2.FcrConnectionState.CONNECTING);
    } else if (phase === _whiteWebSdk.RoomPhase.Connected) {
      // this._updateConnnectionState(FcrBoardRoomConnectionState.CONNECTED);
    } else if (phase === _whiteWebSdk.RoomPhase.Reconnecting) {
      this._updateConnnectionState(_2.FcrConnectionState.RECONNECTING);
    } else if (phase === _whiteWebSdk.RoomPhase.Disconnected) {
      this._updateConnnectionState(_2.FcrConnectionState.DISCONNECTED);
    } else if (phase === _whiteWebSdk.RoomPhase.Disconnecting) {
      // this._updateConnnectionState(FcrConnectionState.DISCONNECTING);
    }
  }
  _addLogObserver() {
    this.addObserver((0, _logger.generateLogObserver)(this.logger, ['onActive', 'onInactive', 'onBackgroundColorUpdated', 'onConnectionStateUpdated']));
  }
}
exports.FcrWhiteboardControlImpl = FcrWhiteboardControlImpl;
_FcrWhiteboardControlImpl = FcrWhiteboardControlImpl;
[_initProto] = _applyDecs(_FcrWhiteboardControlImpl, [[[_decorator.bound, _logger.trace], 2, "active"], [[_decorator.bound, _logger.trace], 2, "inactive"], [[_decorator.bound, _logger.trace], 2, "open"], [[_decorator.bound, _logger.trace], 2, "close"], [[_decorator.bound, _logger.trace], 2, "setBackgroundColor"], [[_decorator.bound, _logger.trace], 2, "getActivity"], [[_decorator.bound, _logger.trace], 2, "getOwnerId"], [[_decorator.bound, _logger.trace], 2, "getBackgroundColor"], [[_decorator.bound, _logger.trace], 2, "getConnectionState"], [[_decorator.bound, _logger.trace], 2, "getMainWindow"], [[_decorator.bound, _logger.trace], 2, "addObserver"], [[_decorator.bound, _logger.trace], 2, "removeObserver"], [_decorator.bound, 2, "getBoardActiveInfo"], [_logger.trace, 2, "leave"], [_decorator.bound, 2, "_getToken"], [_decorator.bound, 2, "_handleRoomStateUpdated"], [_decorator.bound, 2, "_updateConnnectionState"], [_decorator.bound, 2, "_handleConnectionStateUpdated"]], []).e;