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

Core APIs for building online scenes

"use strict";

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");
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.FcrPrivilegeControlImpl = void 0;
require("core-js/modules/esnext.iterator.constructor.js");
require("core-js/modules/esnext.iterator.for-each.js");
require("core-js/modules/esnext.iterator.map.js");
var _imports = require("../../imports");
var _type = require("../../type");
var _user = require("../../utilities/user");
var _helper = require("./helper");
var _type2 = require("./type");
var _logger = require("../../utilities/logger");
var _error = require("../../utilities/error");
var _validateParams = _interopRequireDefault(require("../../utilities/validate-params"));
var _schema = require("../../schema");
let _initProto, _getSecurityInfoDecs, _getLocalUserPermissionInfoDecs, _enableLockedRoomDecs, _allowShareAndWriteDecs, _allowWriteBoardDecs, _allowWriteBoardByUserIdsDecs, _allowSendChatDecs, _allowStartAudioDecs, _allowStartVideoDecs, _allowJoinWithMutedAudioDecs, _allowJoinWithMutedVideoDecs, _allowWatermarkDecs, _allowChangeUserNameDecs, _allowStartCaptionDecs, _allowStartTranscribingDecs, _allowUpdateSttSourceLanguageDecs, _allowJoinWithPromptSoundDecs;
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 FcrPrivilegeControlImpl {
  static {
    [_initProto] = _applyDecs(this, [[_imports.trace, 2, "allowWriteAnnotation"], [_getSecurityInfoDecs, 2, "getSecurityInfo"], [_getLocalUserPermissionInfoDecs, 2, "getLocalUserPermissionInfo"], [_enableLockedRoomDecs, 2, "enableLockedRoom"], [_allowShareAndWriteDecs, 2, "allowShareAndWrite"], [_allowWriteBoardDecs, 2, "allowWriteBoard"], [_allowWriteBoardByUserIdsDecs, 2, "allowWriteBoardByUserIds"], [_allowSendChatDecs, 2, "allowSendChat"], [_allowStartAudioDecs, 2, "allowStartAudio"], [_allowStartVideoDecs, 2, "allowStartVideo"], [_allowJoinWithMutedAudioDecs, 2, "allowJoinWithMutedAudio"], [_allowJoinWithMutedVideoDecs, 2, "allowJoinWithMutedVideo"], [_allowWatermarkDecs, 2, "allowWatermark"], [_allowChangeUserNameDecs, 2, "allowChangeUserName"], [_allowStartCaptionDecs, 2, "allowStartCaption"], [_allowStartTranscribingDecs, 2, "allowStartTranscribing"], [_allowUpdateSttSourceLanguageDecs, 2, "allowUpdateSttSourceLanguage"], [_allowJoinWithPromptSoundDecs, 2, "allowJoinWithPromptSound"]], []).e;
  }
  //@internal
  [(_getSecurityInfoDecs = [_imports.trace, (0, _validateParams.default)(_schema.fcrSecurityActionSchema)], _getLocalUserPermissionInfoDecs = [_imports.trace, (0, _validateParams.default)(_schema.fcrPermissionActionSchema)], _enableLockedRoomDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowShareAndWriteDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowWriteBoardDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowWriteBoardByUserIdsDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.stringArraySchema)], _allowSendChatDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema, _schema.fcrSecuritySendChatPayloadSchema)], _allowStartAudioDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowStartVideoDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowJoinWithMutedAudioDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowJoinWithMutedVideoDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowWatermarkDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema, _schema.fcrLineTypeSchema.optional())], _allowChangeUserNameDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowStartCaptionDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowStartTranscribingDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowUpdateSttSourceLanguageDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], _allowJoinWithPromptSoundDecs = [_imports.trace, (0, _validateParams.default)(_schema.booleanSchema, _schema.fcrPrivilegeUserRoleArraySchema)], "logger")] = (_initProto(this), (0, _logger.createLogger)({
    prefix: 'FcrPrivilegeControlImpl'
  }));
  _observable = new _imports.AgoraObservable();
  constructor(_engine, _scene, _api, _sharedCache) {
    this._engine = _engine;
    this._scene = _scene;
    this._api = _api;
    this._sharedCache = _sharedCache;
    this._roomCache = _sharedCache.getRoomCache(this._scene.sceneId);
    this._addLogObserver();
    this._addSceneObserver();
  }
  async allowWriteAnnotation(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.toggleAnnotation({
      roomId: this._scene.sceneId,
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role]),
      payload: {
        write: enable ? 1 : 0
      }
    }), _error.FcrErrorModuleCode.ROOM_WHITEBOARD, 'allow annotation failed');
  }
  getSecurityInfo(action) {
    const info = this._scene.getScenePropertiesByKeyPath(`security.${action}`);
    return this._convertSecurityInfo(info, action);
  }
  // @trace
  getAllSecurityInfo() {
    const map = this._scene.getScenePropertiesByKeyPath('security');
    const securityKeys = Object.keys(map);
    return securityKeys.map(key => this._convertSecurityInfo(map[key], key));
  }

  /* getSecurityInfoByTargetRole(targetRole: FcrUserRole): FcrSecurityInfo[] {
    const map = this._scene.getScenePropertiesByKeyPath('security') as Record<
      string,
      FcrSecurityObj
    >;
     const securityKeys = Object.keys(map);
     const infoListOfTargetRole = securityKeys.filter((key) =>
      map[key].targetRoles.includes(FcrUserRoleToStringMap[targetRole]),
    );
     return infoListOfTargetRole.map((key) => this._convertSecurityInfo(map[key], key));
  } */

  getLocalUserPermissionInfo(action) {
    return (0, _helper.getLocalUserPermissionInfo)(this._scene, action);
  }

  // @trace
  getAllLocalUserPermissionInfo() {
    const permissionStringArray = this._scene.getUserPropertiesByKeyPath(`permission.list`, this._scene.localUser.getLocalUserId());
    return permissionStringArray.map(permissionString => this._convertPermissionInfo(_helper.FcrPermission.fromString(permissionString), _type2.FcrOperatePermissionType.GET));
  }
  async enableLockedRoom(enable, targetRoles) {
    return (0, _error.handleRequestError)(() => this._api.enableLockedRoom({
      enable,
      roomId: this._scene.sceneId,
      targetRoles
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'enable locked room failed');
  }
  async allowShareAndWrite(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.toggleShareEnable({
      roomId: this._scene.sceneId,
      enable: true,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role]),
      payload: {
        screen: enable ? 1 : 0,
        board: {
          start: enable ? 1 : 0
        },
        annotation: {
          start: enable ? 1 : 0
        }
      }
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow share failed');
  }
  async allowWriteBoard(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.toggleShareEnable({
      roomId: this._scene.sceneId,
      enable: true,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role]),
      payload: {
        // screen: 1,
        board: {
          write: enable ? 1 : 0
        },
        annotation: {
          write: enable ? 1 : 0
        }
      }
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow write board failed');
  }
  async allowWriteBoardByUserIds(enable, targetUserIds) {
    await (0, _error.handleRequestError)(() => this._api.toggleShareEnableByUserIds({
      roomId: this._scene.sceneId,
      enable: true,
      toUserUuids: targetUserIds,
      payload: {
        board: {
          write: enable ? 1 : 0
        }
      }
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow write board by user ids failed');
  }
  async allowSendChat(enable, targetRoles, payload) {
    await (0, _error.handleRequestError)(() => this._api.allowSendChat({
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role]),
      roomId: this._scene.sceneId,
      payload
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow send chat failed');
  }
  async allowStartAudio(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.allowStartAudio({
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role]),
      roomId: this._scene.sceneId
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow start audio failed');
  }
  async allowStartVideo(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.allowStartVideo({
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role]),
      roomId: this._scene.sceneId
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow start video failed');
  }
  async allowJoinWithMutedAudio(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.allowJoinWithMuteAudio({
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role]),
      roomId: this._scene.sceneId
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow join with mute audio failed');
  }
  async allowJoinWithMutedVideo(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.allowJoinWithMutedVideo({
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role]),
      roomId: this._scene.sceneId
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow join with mute audio failed');
  }

  /* async allowChangeName(enable: boolean, targetRoles: FcrPrivilegeUserRole[]) {
    await this._api.allowChangeName({
      enable,
      targetRoles: targetRoles.map((role) => FcrPrivilegeUserRoleToStringMap[role]),
      roomId: this._scene.sceneId,
    });
  } */

  /** 开启水印 */
  async allowWatermark(enable, targetRoles, lineType) {
    await (0, _error.handleRequestError)(() => this._api.allowWatermark({
      roomId: this._scene.sceneId,
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role]),
      payload: {
        lineType: lineType ?? _type.FcrLineType.SINGLE_ROW
      }
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow water mark failed');
  }
  async allowChangeUserName(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.allowChangeUserName({
      roomId: this._scene.sceneId,
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role])
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow change user name failed');
  }
  async allowStartCaption(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.allowStartCaption({
      roomUuid: this._scene.sceneId,
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role])
    }), _error.FcrErrorModuleCode.ROOM_STT, 'allow start caption failed');
  }
  async allowStartTranscribing(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.allowStartTranscribing({
      roomUuid: this._scene.sceneId,
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role])
    }), _error.FcrErrorModuleCode.ROOM_STT, 'allow start transcribing failed');
  }
  async allowUpdateSttSourceLanguage(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.allowUpdateSttSourceLanguage({
      roomUuid: this._scene.sceneId,
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role])
    }), _error.FcrErrorModuleCode.ROOM_STT, 'allow update stt source language failed');
  }
  async allowJoinWithPromptSound(enable, targetRoles) {
    await (0, _error.handleRequestError)(() => this._api.allowJoinWithPromptSound({
      roomId: this._scene.sceneId,
      enable,
      targetRoles: targetRoles.map(role => _type2.FcrPrivilegeUserRoleToStringMap[role])
    }), _error.FcrErrorModuleCode.ROOM_PRIVILEGE, 'allow join with prompt sound failed');
  }
  addObserver(observer) {
    this._observable.addObserver(observer);
  }
  removeObserver(observer) {
    this._observable.removeObserver(observer);
  }
  _convertSecurityInfo(security, action) {
    if (!security) {
      return {
        enable: false
      };
    }
    const {
      targetRoles,
      payload
    } = security;
    if (action === _type2.FcrSecurityAction.Annotation) {
      return {
        info: {
          action: action,
          payload
        },
        ...security
      };
    }
    return {
      enable: !!security.enable,
      info: {
        targetRoles: targetRoles ? targetRoles.map(role => (0, _user.convertStringPrivilegeRoleToFcrPrivilegeRole)(role)) : [],
        payload,
        action: action
      }
    };
  }
  _convertPermissionInfo(permission, operateType) {
    if (!permission) {
      return {
        enable: false
      };
    }
    const {
      module,
      action
    } = permission;
    const permissionInfo = {
      enable: operateType === _type2.FcrOperatePermissionType.ADD || operateType === _type2.FcrOperatePermissionType.GET ? true : false,
      info: {
        targetRoles: permission.targetRoles.map(role => (0, _user.convertStringPrivilegeRoleToFcrPrivilegeRole)(role)),
        action: `${module}:${action}`,
        params: permission.conditions
      }
    };
    return permissionInfo;
  }
  _addSceneObserver() {
    this._scene.addObserver({
      onScenePropertiesUpdated: (sceneId, event) => {
        if ('security' in event.changedProperties) {
          const securityChangedKeys = Object.keys(event.changedProperties.security);
          securityChangedKeys.forEach(key => {
            const infoObj = (0, _imports.get)(event.changedProperties, `security.${key}`);
            this._observable.notifyObservers('onSecurityInfoUpdated', sceneId, {
              securityInfo: this._convertSecurityInfo(infoObj, key),
              operatorUser: (0, _user.checkFcrUserRole)((0, _user.convertRteUserToFcrUser)(event.operatorUser, this._roomCache)),
              cause: event.cause
            });
          });
        }
      }
    });
    (0, _helper.addLocalUserPermissionObserver)(this._scene, {
      onLocalUserPermissionInfoAdded: (sceneId, event) => {
        this._observable.notifyObservers('onLocalUserPermissionInfoAdded', sceneId, event);
      },
      onLocalUserPermissionInfoDeleted: (sceneId, event) => {
        this._observable.notifyObservers('onLocalUserPermissionInfoDeleted', sceneId, event);
      }
    }, this._roomCache);
  }
  _addLogObserver() {
    this.addObserver((0, _logger.generateLogObserver)(this.logger, ['onSecurityInfoUpdated', 'onLocalUserPermissionInfoAdded', 'onLocalUserPermissionInfoDeleted']));
  }
}
exports.FcrPrivilegeControlImpl = FcrPrivilegeControlImpl;