fcr-ui-scene 1.0.20 → 3.1.0

package/lib/common/event-store.js

@@ -0,0 +1,235 @@
+"use strict";
+
+require("core-js/modules/es.symbol.js");
+require("core-js/modules/es.array.filter.js");
+require("core-js/modules/es.array.for-each.js");
+require("core-js/modules/es.array.push.js");
+require("core-js/modules/es.object.define-properties.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.get-own-property-descriptors.js");
+require("core-js/modules/es.object.keys.js");
+require("core-js/modules/es.object.to-string.js");
+require("core-js/modules/web.dom-collections.for-each.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrUIEventStore = void 0;
+require("core-js/modules/es.array.concat.js");
+require("core-js/modules/es.date.now.js");
+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 _observable = require("agora-foundation/lib/utilities/observable");
+var _constant = require("../utilities/constant");
+var _logger = require("agora-foundation/lib/logger");
+var _chat = require("../modules/chat");
+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) { (0, _defineProperty2["default"])(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; }
+var FcrUIEventStore = exports.FcrUIEventStore = /*#__PURE__*/function () {
+  function FcrUIEventStore() {
+    (0, _classCallCheck2["default"])(this, FcrUIEventStore);
+    (0, _defineProperty2["default"])(this, "logger", (0, _logger.getLogger)());
+    (0, _defineProperty2["default"])(this, "_observable", new _observable.AgoraObservable());
+  }
+  return (0, _createClass2["default"])(FcrUIEventStore, [{
+    key: "sendEvent",
+    value: function sendEvent(action, payload) {
+      this.logger.debug('[FcrUIEventStore] sendEvent', _constant.UIAction[action], payload);
+      this._observable.notifyObservers('onEvent', action, payload);
+    }
+  }, {
+    key: "showToast",
+    value: function showToast(params) {
+      this.sendEvent(_constant.UIAction.SHOW_TOAST, params);
+    }
+  }, {
+    key: "showChatToast",
+    value: function showChatToast(params) {
+      this.sendEvent(_constant.UIAction.SHOW_TOAST, _objectSpread(_objectSpread({}, params), {}, {
+        customRootClass: _chat.CHAT_WRAPPER_CLASS
+      }));
+    }
+  }, {
+    key: "openConfirmDialog",
+    value: function openConfirmDialog(params) {
+      var dialogKey = _constant.DialogKey.CONFIRM;
+      var dialogId = "".concat(dialogKey, "_").concat(Date.now());
+      this.sendEvent(_constant.UIAction.OPEN_DIALOG, {
+        dialogKey: dialogKey,
+        dialogId: dialogId,
+        params: params
+      });
+      return dialogId;
+    }
+  }, {
+    key: "openDialog",
+    value: function openDialog(dialogKey, instanceId, params) {
+      var dialogId = "".concat(dialogKey, "_").concat(instanceId || dialogKey);
+      this.sendEvent(_constant.UIAction.OPEN_DIALOG, {
+        dialogKey: dialogKey,
+        dialogId: dialogId,
+        params: params
+      });
+      return dialogId;
+    }
+  }, {
+    key: "closeDialog",
+    value: function closeDialog(dialogId) {
+      this.sendEvent(_constant.UIAction.CLOSE_DIALOG, {
+        dialogId: dialogId
+      });
+    }
+  }, {
+    key: "startShareScreen",
+    value: function startShareScreen() {
+      this.sendEvent(_constant.UIAction.START_SHARE_SCREEN);
+    }
+  }, {
+    key: "stopShareScreen",
+    value: function stopShareScreen() {
+      this.sendEvent(_constant.UIAction.STOP_SHARE_SCREEN);
+    }
+  }, {
+    key: "updateAside",
+    value: function updateAside(params) {
+      this.sendEvent(_constant.UIAction.UPDATE_ASIDE, params);
+    }
+  }, {
+    key: "receiveNewChatMessages",
+    value: function receiveNewChatMessages(params) {
+      this.sendEvent(_constant.UIAction.RECEIVE_NEW_CHAT_MESSAGES, params);
+    }
+  }, {
+    key: "toggleLayout",
+    value: function toggleLayout(params) {
+      this.sendEvent(_constant.UIAction.TOGGLE_LAYOUT, params);
+    }
+  }, {
+    key: "notifyLayoutChanged",
+    value: function notifyLayoutChanged(params) {
+      this.sendEvent(_constant.UIAction.LAYOUT_CHANGED, params);
+    }
+  }, {
+    key: "toggleLayoutSize",
+    value: function toggleLayoutSize(params) {
+      this.sendEvent(_constant.UIAction.TOGGLE_LAYOUT_SIZE, params);
+    }
+  }, {
+    key: "notifyLayoutSizeChanged",
+    value: function notifyLayoutSizeChanged(params) {
+      this.sendEvent(_constant.UIAction.LAYOUT_SIZE_CHANGED, params);
+    }
+  }, {
+    key: "setMainSpeaker",
+    value: function setMainSpeaker(params) {
+      this.sendEvent(_constant.UIAction.SET_MAIN_SPEAKER, params);
+    }
+  }, {
+    key: "setUserPinState",
+    value: function setUserPinState(userId) {
+      this.sendEvent(_constant.UIAction.SET_USER_PIN_STATE, {
+        userId: userId
+      });
+    }
+  }, {
+    key: "updateShareState",
+    value: function updateShareState(isOpen) {
+      this.sendEvent(_constant.UIAction.UPDATE_SHARE_STATE, {
+        isOpen: isOpen
+      });
+    }
+  }, {
+    key: "openDeviceSettingDialog",
+    value: function openDeviceSettingDialog() {
+      var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var dialogId = this.openDialog(_constant.DialogKey.DEVICE_SETTINGS);
+      this.sendEvent(_constant.UIAction.OPEN_DEVICE_SETTING_DIALOG, _objectSpread({
+        dialogId: dialogId
+      }, config));
+    }
+  }, {
+    key: "closeDeviceSettingDialog",
+    value: function closeDeviceSettingDialog() {
+      this.closeDialog(_constant.DialogKey.DEVICE_SETTINGS);
+    }
+  }, {
+    key: "openLiveStreamingDialog",
+    value: function openLiveStreamingDialog() {
+      this.sendEvent(_constant.UIAction.OPEN_LIVE_STEAMING_DIALOG);
+    }
+  }, {
+    key: "closeLiveStreamingDialog",
+    value: function closeLiveStreamingDialog() {
+      this.sendEvent(_constant.UIAction.CLOSE_LIVE_STEAMING_DIALOG);
+    }
+  }, {
+    key: "stopLiveStreaming",
+    value: function stopLiveStreaming() {
+      this.sendEvent(_constant.UIAction.STOP_LIVE_STREAMING);
+    }
+  }, {
+    key: "openInviteDialog",
+    value: function openInviteDialog() {
+      this.sendEvent(_constant.UIAction.OPEN_INVITE_DIALOG);
+    }
+  }, {
+    key: "closeInviteDialog",
+    value: function closeInviteDialog() {
+      this.sendEvent(_constant.UIAction.CLOSE_INVITE_DIALOG);
+    }
+  }, {
+    key: "closeConfirmDialog",
+    value: function closeConfirmDialog() {
+      this.closeDialog(_constant.DialogKey.CONFIRM);
+    }
+  }, {
+    key: "exitRoom",
+    value: function exitRoom(reason) {
+      this.sendEvent(_constant.UIAction.EXIT_ROOM, {
+        reason: reason
+      });
+    }
+  }, {
+    key: "cloudRecording",
+    value: function cloudRecording(action) {
+      this.sendEvent(_constant.UIAction.CLOUD_RECORDING, {
+        action: action
+      });
+    }
+  }, {
+    key: "notifySpotlightStreamChanged",
+    value: function notifySpotlightStreamChanged(params) {
+      this.sendEvent(_constant.UIAction.SPOTLIGHT_STREAM_CHANGED, params);
+    }
+  }, {
+    key: "notifyCustomSettingsChanged",
+    value: function notifyCustomSettingsChanged(settings) {
+      this.sendEvent(_constant.UIAction.CUSTOM_SETTINGS_CHANGED, settings);
+    }
+  }, {
+    key: "addObserver",
+    value: function addObserver(observer) {
+      this._observable.addObserver(observer);
+    }
+  }, {
+    key: "removeObserver",
+    value: function removeObserver(observer) {
+      this._observable.removeObserver(observer);
+    }
+  }, {
+    key: "notifyChatUpdateTarget",
+    value: function notifyChatUpdateTarget(user) {
+      this.sendEvent(_constant.UIAction.CHAT_UPDATE_TARGET, user);
+    }
+  }, {
+    key: "notifyChatResetTarget",
+    value: function notifyChatResetTarget() {
+      this.sendEvent(_constant.UIAction.CHAT_RESET_TARGET);
+    }
+  }, {
+    key: "release",
+    value: function release() {}
+  }]);
+}();

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

@@ -0,0 +1,123 @@
+import { FcrPrivilegeControl, FcrStreamControl, FcrUserControl } from 'agora-edu-core';
+import { FcrRoomSessionControl } from 'agora-edu-core/lib/room-control/room-session';
+import { FcrPermissionAction, FcrPermissionInfo, FcrPrivilegeUserRole, FcrSecurityInfo, FcrSecuritySendChatPayload, FcrUserRole, FcrUserInfo } from 'agora-edu-core/lib/type';
+import { FcrUIEventStore } from './event-store';
+import { FcrSharePermissionState } from 'agora-edu-core/lib/room-control/whiteboard-control/enums';
+import { FcrSharePermissionProps } from 'agora-edu-core/lib/type';
+export type FcrSecuritySendChatOriginalPayload = {
+    public: 0 | 1;
+    private: {
+        host: 0 | 1;
+        cohost: 0 | 1;
+        participant: 0 | 1;
+    };
+};
+export declare class FcrSecurityStore {
+    private _privilegeControl;
+    private _userControl;
+    private _streamControl;
+    private _roomSessionControl;
+    private _uiEventStore;
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _disposers;
+    accessor securityInfos: FcrSecurityInfo[];
+    accessor permissionInfos: FcrPermissionInfo[];
+    accessor privilegeOperator: FcrUserInfo | undefined;
+    accessor boardOwnerUser: FcrUserInfo | undefined;
+    constructor(_privilegeControl: FcrPrivilegeControl, _userControl: FcrUserControl, _streamControl: FcrStreamControl, _roomSessionControl: FcrRoomSessionControl, _uiEventStore: FcrUIEventStore);
+    release(): void;
+    get localUser(): FcrUserInfo;
+    allowChangeSelfName: () => boolean;
+    allowChat: () => boolean;
+    convertSendChatPayload: (payload: FcrSecuritySendChatOriginalPayload) => FcrSecuritySendChatPayload;
+    allowedAllChat: () => boolean | undefined;
+    allowedPublicChatAndDisallowedPrivateChat: () => boolean | undefined;
+    disallowedPublicChatAndDisallowedPrivateChatToParticipant: () => boolean | undefined;
+    disallowedAllChat: () => boolean | undefined;
+    allowJoinWithMuteAudio: () => boolean;
+    allowShareScreen: () => boolean;
+    allowScreenShareAndBoard: () => boolean;
+    allowBoardWrite: () => boolean;
+    allowUnmuteSelfVideo: () => boolean;
+    allowUnmuteSelfAudio: () => boolean;
+    isLockRoomEnabled: () => boolean;
+    isWaitingRoomEnabled: () => boolean;
+    hasMutePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasUnmutePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasRequestStartAudioPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasRequestStartVideoPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasStartVideoPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasStopVideoPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasSelfMutePermission: () => boolean;
+    hasAllMutePermission: () => boolean;
+    hasSelfUnmutePermission: () => boolean;
+    hasAllUnmutePermission: () => boolean;
+    hasRevokeHostPermission: () => boolean;
+    hasKickOutPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasCallMergePermission(): boolean;
+    hasCallSplitPermission(): boolean;
+    hasStartScreenSharePermission: () => boolean;
+    hasChatSendPublicPermission: () => boolean;
+    hasPermissionToSendPrivateMessage: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasPermissionToControlAllowSendAll: () => boolean;
+    hasPermissionToControlDisallowSendAll: () => boolean;
+    hasPermissionToControlAllowSendPrivate: () => boolean;
+    hasPermissionToControlDisallowSendPrivate: () => boolean;
+    hasSetRolePermission(targetRole: FcrUserRole, setToRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasStartCloudRecordingPermission: () => boolean;
+    hasStartLiveStreamingPermission: () => boolean;
+    hasStopLiveStreamingPermission: () => boolean;
+    hasGetLiveStreamingLinkPermission: () => boolean;
+    hasEnableStartAudioPermission: () => boolean;
+    hasEnableChangeNamePermission: () => boolean;
+    hasEnableStartVideoPermission: () => boolean;
+    hasEnableJoinWithAudioPermission: () => boolean;
+    hasEnableStartScreenSharePermission: () => boolean;
+    hasLockRoomPermission: () => boolean;
+    hasEndRoomPermission(): boolean;
+    hasAssignHostBeforeLeavingPermission(role: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasStartBoardPermission(): boolean;
+    hasCloseBoardPermission(): boolean;
+    hasWriteBoardPermission(): boolean;
+    hasAllowStartBoardPermission(): boolean;
+    hasDisallowStartBoardPermission(): boolean;
+    hasAllowWriteBoardPermission(): boolean;
+    hasDisallowWriteBoardPermission(): boolean;
+    hasAllowScreenShareAndBoardPermission(): boolean;
+    getAllowedOperations(targetUserRole: FcrUserRole, isSelf: boolean): string[];
+    allowShare(enable: FcrSharePermissionState, payload?: Pick<FcrSharePermissionProps, 'screen'>): Promise<{
+        msg: string;
+        data: Record<string, FcrSharePermissionProps>;
+        code: number;
+        ts: number;
+    }>;
+    setAllowWriteBoard(state: FcrSharePermissionState, payload?: Pick<FcrSharePermissionProps, 'board'>): Promise<{
+        msg: string;
+        data: Record<string, FcrSharePermissionProps>;
+        code: number;
+        ts: number;
+    }>;
+    muteAll: () => void;
+    unmuteAll: () => void;
+    setLockRoomEnabled: (enable: boolean) => void;
+    setWaitingRoomEnabled: () => void;
+    setAllowChangeSelfName: () => void;
+    setAllowChat: (enable: boolean) => void;
+    setAllowChatWithPayload: (enable: boolean, payload: FcrSecuritySendChatPayload) => void;
+    setAllowedPublicChatAndDisallowedPrivateChat: () => void;
+    setDisallowedPublicChatAndDisallowedPrivateChatToParticipant: () => void;
+    setAllowJoinWithMuteAudio: (enable: boolean) => void;
+    setAllowShareScreen: (state: boolean) => void;
+    setAllowUnmuteSelfVideo: (enable: boolean) => void;
+    setAllowUnmuteSelfAudio: (enable: boolean) => void;
+    _hasPermission: (action: FcrPermissionAction, targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    _hasPermissionWithParams: (action: FcrPermissionAction, targetRole: FcrPrivilegeUserRole | FcrUserRole, params: Record<string, unknown>) => boolean;
+    private _handlePermissionUpdated;
+    private _handleSecurityUpdated;
+    private _handleUnmuteSessionReceived;
+    permitPrivateChat(userId: string): boolean;
+    private _printAllPermissions;
+    private _handleProcessEvent;
+    private _addReactions;
+    private _removeReactions;
+}