fcr-ui-scene 3.4.2 → 3.4.4

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

@@ -1,16 +1,17 @@
-import { DialogKey, UIAction } from '../utilities/constant';
-import { FcrUserInfo } from 'agora-edu-core/lib/type';
+import { DialogKey, RoomType, UIAction } from '../utilities/constant';
+import { FcrUserInfo } from 'fcr-core/lib/type';
 import { DeviceSettingDialogConfig, CustomSetting } from '../modules/setting/store';
 import { FcrUIExitReason } from '../type';
 import { ToastSize } from 'agora-ui-foundation/lib/components/toast';
 import { FcrIconType } from 'agora-ui-foundation/lib/components/icon/type';
 import { ButtonType } from 'agora-ui-foundation/lib/components/button';
 import { ConfirmContentProps } from 'agora-ui-foundation/lib/components/confirm-content';
-import { FcrChatRoomReceiveBaseMessage } from 'agora-edu-core/lib/room-control/chatroom-control/type';
-export interface FcrUIDialogParams {
+import { FcrChatRoomReceiveBaseMessage } from 'fcr-core/lib/room-control/chatroom-control/type';
+import React from 'react';
+export interface FcrUIDialogParams<T> {
     dialogKey: DialogKey;
     dialogId: string;
-    params?: unknown;
+    params?: T extends unknown ? unknown : T;
 }
 export interface FcrUIToastParams {
     type: 'error' | 'warn' | 'info' | 'normal';
@@ -20,6 +21,18 @@ export interface FcrUIToastParams {
     size?: ToastSize;
     customRootClass?: string;
 }
+export declare enum NotificationContentType {
+    WAITING_ROOM = "WAITING_ROOM",
+    INTERPRETER_STATUS = "INTERPRETER_STATUS"
+}
+export interface FcrNotificationParams {
+    duration?: number;
+    placement: 'top' | 'topLeft' | 'topRight' | 'bottom' | 'bottomLeft' | 'bottomRight';
+    type: NotificationContentType;
+    onOk?: () => void;
+    onClose?: () => void;
+    data?: any;
+}
 export interface FcrUIConfirmDialogParams {
     title: string;
     content: React.ReactNode;
@@ -44,6 +57,7 @@ export interface FcrUIUpdateAsideParams {
 export interface FcrUINewChatMessagesParams {
     latestMessage: FcrChatRoomReceiveBaseMessage;
     count: number;
+    type: string;
 }
 export interface FcrUIToggleLayoutParams {
     layout: 'speaker' | 'gallery';
@@ -82,12 +96,22 @@ export declare class FcrUIEventStore {
     private _observable;
     sendEvent(action: UIAction, payload?: unknown): void;
     showToast(params: FcrUIToastParams): void;
+    showNotification(params: FcrNotificationParams): void;
+    closeNotification(key: NotificationContentType): void;
     showChatToast(params: FcrUIToastParams): void;
+    /**
+     * 默认同一个 title 或 content 的 confirm 窗口只打开一个实例
+     * @param key 可以通过 key 区分相同 title 或 content 的 confirm 窗口
+     * @param duration 可以通过 duration 配置自动关闭时间
+     * @mulitple 可以通过 mulitple 配置打开多个实例（忽略 key）
+     * */
     openConfirmDialog(params: ConfirmContentProps & {
-        height?: number;
-    }): string;
+        key?: string;
+        duration?: number;
+    }, mulitple?: boolean): string;
     openDialog(dialogKey: DialogKey, instanceId?: string, params?: unknown): string;
     closeDialog(dialogId: string): void;
+    closeConfirm(dialogId: string): void;
     startShareScreen(): void;
     stopShareScreen(): void;
     updateAside(params: FcrUIUpdateAsideParams): void;
@@ -106,14 +130,15 @@ export declare class FcrUIEventStore {
     stopLiveStreaming(): void;
     openInviteDialog(): void;
     closeInviteDialog(): void;
-    closeConfirmDialog(): void;
-    exitRoom(reason: FcrUIExitReason): void;
+    closeWaitingRoomDialog(): void;
+    closeRemoveAdmitWaitingRoomDialog(dialogKey: DialogKey): void;
+    exitRoom(reason: FcrUIExitReason, roomType: number): void;
     cloudRecording(action: FcrCloudRecordingParams['action']): void;
     notifySpotlightStreamChanged(params: FcrSpotlightStreamChangedParams): void;
     notifyCustomSettingsChanged(settings: CustomSetting): void;
     addObserver(observer: FcrUIEventObserver): void;
     removeObserver(observer: FcrUIEventObserver): void;
-    notifyChatUpdateTarget(user: FcrUserInfo): void;
+    notifyChatUpdateTarget(user: FcrUserInfo, roomType: RoomType): void;
     notifyChatResetTarget(): void;
     release(): void;
 }

package/lib/common/event-store.js

@@ -20,7 +20,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.FcrUIEventStore = void 0;
+exports.NotificationContentType = 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"));
@@ -32,6 +32,11 @@ 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 NotificationContentType = exports.NotificationContentType = /*#__PURE__*/function (NotificationContentType) {
+  NotificationContentType["WAITING_ROOM"] = "WAITING_ROOM";
+  NotificationContentType["INTERPRETER_STATUS"] = "INTERPRETER_STATUS";
+  return NotificationContentType;
+}({});
 var FcrUIEventStore = exports.FcrUIEventStore = /*#__PURE__*/function () {
   function FcrUIEventStore() {
     (0, _classCallCheck2["default"])(this, FcrUIEventStore);
@@ -41,13 +46,35 @@ var FcrUIEventStore = exports.FcrUIEventStore = /*#__PURE__*/function () {
   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);
+      var start = Date.now();
+      try {
+        this._observable.notifyObservers('onEvent', action, payload);
+      } finally {
+        var end = Date.now();
+        var time = end - start;
+        if (time >= 10) {
+          this.logger.warn("[FcrUIEventStore] sendEvent ".concat(_constant.UIAction[action], ", payload: ").concat(payload, ", handlers took: ").concat(end - start, "ms"));
+        }
+      }
     }
   }, {
     key: "showToast",
     value: function showToast(params) {
-      this.sendEvent(_constant.UIAction.SHOW_TOAST, params);
+      this.sendEvent(_constant.UIAction.OPEN_DIALOG, {
+        dialogKey: _constant.DialogKey.SHOW_TOAST,
+        dialogId: "".concat(_constant.DialogKey.SHOW_TOAST, "_").concat(Date.now()),
+        params: params
+      });
+    }
+  }, {
+    key: "showNotification",
+    value: function showNotification(params) {
+      this.sendEvent(_constant.UIAction.SHOW_NOTIFICATION, params);
+    }
+  }, {
+    key: "closeNotification",
+    value: function closeNotification(key) {
+      this.sendEvent(_constant.UIAction.COLSE_NOTIFICATION, key);
     }
   }, {
     key: "showChatToast",
@@ -56,11 +83,18 @@ var FcrUIEventStore = exports.FcrUIEventStore = /*#__PURE__*/function () {
         customRootClass: _chat.CHAT_WRAPPER_CLASS
       }));
     }
+
+    /**
+     * 默认同一个 title 或 content 的 confirm 窗口只打开一个实例
+     * @param key 可以通过 key 区分相同 title 或 content 的 confirm 窗口
+     * @param duration 可以通过 duration 配置自动关闭时间
+     * @mulitple 可以通过 mulitple 配置打开多个实例（忽略 key）
+     * */
   }, {
     key: "openConfirmDialog",
-    value: function openConfirmDialog(params) {
+    value: function openConfirmDialog(params, mulitple) {
       var dialogKey = _constant.DialogKey.CONFIRM;
-      var dialogId = "".concat(dialogKey, "_").concat(Date.now());
+      var dialogId = mulitple ? "".concat(dialogKey, "_").concat(Date.now()) : "".concat(dialogKey, "_").concat(params.key || params.title || params.content);
       this.sendEvent(_constant.UIAction.OPEN_DIALOG, {
         dialogKey: dialogKey,
         dialogId: dialogId,
@@ -86,6 +120,14 @@ var FcrUIEventStore = exports.FcrUIEventStore = /*#__PURE__*/function () {
         dialogId: dialogId
       });
     }
+  }, {
+    key: "closeConfirm",
+    value: function closeConfirm(dialogId) {
+      this.sendEvent(_constant.UIAction.CLOSE_DIALOG, {
+        dialogId: dialogId,
+        dialogKey: _constant.DialogKey.CONFIRM
+      });
+    }
   }, {
     key: "startShareScreen",
     value: function startShareScreen() {
@@ -185,15 +227,21 @@ var FcrUIEventStore = exports.FcrUIEventStore = /*#__PURE__*/function () {
       this.sendEvent(_constant.UIAction.CLOSE_INVITE_DIALOG);
     }
   }, {
-    key: "closeConfirmDialog",
-    value: function closeConfirmDialog() {
-      this.closeDialog(_constant.DialogKey.CONFIRM);
+    key: "closeWaitingRoomDialog",
+    value: function closeWaitingRoomDialog() {
+      this.sendEvent(_constant.UIAction.CLOSE_WAITING_ROOM_DIALOG);
+    }
+  }, {
+    key: "closeRemoveAdmitWaitingRoomDialog",
+    value: function closeRemoveAdmitWaitingRoomDialog(dialogKey) {
+      this.sendEvent(_constant.UIAction.CLOSE_REMOVE_ADMIT_WAITING_ROOM_DIALOG, dialogKey);
     }
   }, {
     key: "exitRoom",
-    value: function exitRoom(reason) {
+    value: function exitRoom(reason, roomType) {
       this.sendEvent(_constant.UIAction.EXIT_ROOM, {
-        reason: reason
+        reason: reason,
+        roomType: roomType
       });
     }
   }, {
@@ -225,8 +273,11 @@ var FcrUIEventStore = exports.FcrUIEventStore = /*#__PURE__*/function () {
     }
   }, {
     key: "notifyChatUpdateTarget",
-    value: function notifyChatUpdateTarget(user) {
-      this.sendEvent(_constant.UIAction.CHAT_UPDATE_TARGET, user);
+    value: function notifyChatUpdateTarget(user, roomType) {
+      this.sendEvent(_constant.UIAction.CHAT_UPDATE_TARGET, {
+        user: user,
+        roomType: roomType
+      });
     }
   }, {
     key: "notifyChatResetTarget",

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

@@ -1,34 +1,30 @@
-import { FcrPrivilegeControl, FcrStreamControl, FcrUserControl } from 'agora-edu-core';
-import { FcrUserRole, FcrUserInfo } from 'agora-edu-core/lib/type';
+import { FcrPrivilegeControl, FcrStreamControl, FcrUserControl } from 'fcr-core';
+import { FcrUserRole, FcrUserInfo, FcrLineType } from 'fcr-core/lib/type';
 import { FcrUIEventStore } from './event-store';
-import { FcrSharePermissionState } from 'agora-edu-core/lib/room-control/whiteboard-control/enums';
-import { FcrRoomSessionControl } from 'agora-edu-core/lib/room-control/room-session/type';
-import { FcrPermissionAction, FcrPermissionInfo, FcrPrivilegeUserRole, FcrSecurityInfo, FcrSecuritySendChatPayload, FcrSecuritySharePayload, FcrSecurityWriteBoardPayload } from 'agora-edu-core/lib/room-control/privilege-control/type';
-export type FcrSecuritySendChatOriginalPayload = {
-    public: 0 | 1;
-    private: {
-        host: 0 | 1;
-        cohost: 0 | 1;
-        participant: 0 | 1;
-    };
-};
+import { FcrSharePermissionState } from 'fcr-core/lib/room-control/whiteboard-control/enums';
+import { FcrPermissionInfo, FcrPrivilegeUserRole, FcrSecurityInfo, FcrSecuritySendChatPayload } from 'fcr-core/lib/room-control/privilege-control/type';
+import { FcrInterpreterControl } from 'fcr-core/lib/room-control/interpreter-control/types';
+import { FcrSecuritySendChatOriginalPayload } from './type';
 export declare class FcrSecurityStore {
     private _privilegeControl;
     private _userControl;
     private _streamControl;
-    private _roomSessionControl;
     private _uiEventStore;
+    private _interpterControl?;
     protected logger: import("agora-foundation/lib/logger").Logger;
     private _disposers;
+    private _prevWaterMarkEnable;
     accessor securityInfos: FcrSecurityInfo[];
-    accessor permissionInfos: FcrPermissionInfo[] | undefined;
+    accessor permissionInfos: FcrPermissionInfo[];
     accessor privilegeOperator: FcrUserInfo | undefined;
     accessor boardOwnerUser: FcrUserInfo | undefined;
-    constructor(_privilegeControl: FcrPrivilegeControl, _userControl: FcrUserControl, _streamControl: FcrStreamControl, _roomSessionControl: FcrRoomSessionControl, _uiEventStore: FcrUIEventStore);
+    get hasSecurityPermission(): boolean;
+    constructor(_privilegeControl: FcrPrivilegeControl, _userControl: FcrUserControl, _streamControl: FcrStreamControl, _uiEventStore: FcrUIEventStore, _interpterControl?: FcrInterpreterControl | undefined);
     release(): void;
     get localUser(): FcrUserInfo;
     allowChangeSelfName: () => boolean;
     allowChat: () => boolean;
+    getWaterMarkContent: () => string;
     convertSendChatPayload: (payload: FcrSecuritySendChatOriginalPayload) => FcrSecuritySendChatPayload;
     allowedAllChat: () => boolean | undefined;
     allowedPublicChatAndDisallowedPrivateChat: () => boolean | undefined;
@@ -42,6 +38,8 @@ export declare class FcrSecurityStore {
     allowUnmuteSelfAudio: () => boolean;
     isLockRoomEnabled: () => boolean;
     isWaitingRoomEnabled: () => boolean;
+    isWaterMarkEnabled: () => boolean;
+    hasWaitingRoomPermission: (role?: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasMutePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasUnmutePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasRequestStartAudioPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
@@ -54,16 +52,17 @@ export declare class FcrSecurityStore {
     hasAllUnmutePermission: () => boolean;
     hasRevokeHostPermission: () => boolean;
     hasKickOutPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
-    hasCallMergePermission(): boolean;
-    hasCallSplitPermission(): boolean;
+    hasCallMergePermission: () => boolean;
+    hasCallSplitPermission: () => boolean;
     hasStartScreenSharePermission: () => boolean;
     hasChatSendPublicPermission: () => boolean;
+    hasChatSendPublicPermissionByTargetRole: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasPermissionToSendPrivateMessage: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasPermissionToControlAllowSendAll: () => boolean;
     hasPermissionToControlDisallowSendAll: () => boolean;
     hasPermissionToControlAllowSendPrivate: () => boolean;
     hasPermissionToControlDisallowSendPrivate: () => boolean;
-    hasSetRolePermission(targetRole: FcrUserRole, setToRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasSetRolePermission: (targetRole: FcrUserRole, setToRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasStartCloudRecordingPermission: () => boolean;
     hasStartLiveStreamingPermission: () => boolean;
     hasStopLiveStreamingPermission: () => boolean;
@@ -74,24 +73,33 @@ export declare class FcrSecurityStore {
     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(state: FcrSharePermissionState, payload: FcrSecuritySharePayload): Promise<void>;
-    setAllowWriteBoard(state: FcrSharePermissionState, payload: FcrSecurityWriteBoardPayload): Promise<void>;
+    hasWatermarkEnablePermission: () => boolean;
+    hasWatermarkDisablePermission: () => boolean;
+    hasEndRoomPermission: () => boolean;
+    hasAssignHostBeforeLeavingPermission: (role: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasStartBoardPermission: () => boolean;
+    hasCloseBoardPermission: () => boolean;
+    hasWriteBoardPermission: () => boolean;
+    hasAllowStartBoardPermission: () => boolean;
+    hasDisallowStartBoardPermission: () => boolean;
+    hasAllowWriteBoardPermission: () => boolean;
+    hasDisallowWriteBoardPermission: () => boolean;
+    hasAllowScreenShareAndBoardPermission: () => boolean;
+    hasAllowWaterMarkPermission: () => boolean;
+    hasEnableInterpreterPermission: () => boolean;
+    hasDisableInterpreterPermission: () => boolean;
+    hasAllowChangeNamePermission: () => boolean;
+    hasDisallowChangeNamePermission: () => boolean;
+    hasChangeNamePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    isMulti: () => boolean;
+    getAllowedOperations: (targetUserRole: FcrUserRole, isSelf: boolean) => string[];
+    allowShare: (state: FcrSharePermissionState) => Promise<void>;
+    setAllowWriteBoard: (state: FcrSharePermissionState | boolean) => Promise<void>;
     muteAll: () => void;
     unmuteAll: () => void;
     setLockRoomEnabled: (enable: boolean) => void;
     setWaitingRoomEnabled: () => void;
-    setAllowChangeSelfName: () => void;
+    setAllowChangeSelfName: (enable: boolean) => void;
     setAllowChat: (enable: boolean) => void;
     setAllowChatWithPayload: (enable: boolean, payload: FcrSecuritySendChatPayload) => void;
     setAllowedPublicChatAndDisallowedPrivateChat: () => void;
@@ -100,14 +108,14 @@ export declare class FcrSecurityStore {
     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;
+    hasSendAllChatPermission: () => boolean;
+    private _hasPermission;
+    private _hasPermissionWithParams;
     private _handlePermissionUpdated;
     private _handleSecurityUpdated;
-    private _handleUnmuteSessionReceived;
     permitPrivateChat(userId: string): boolean;
     private _printAllPermissions;
-    private _handleProcessEvent;
-    private _addReactions;
-    private _removeReactions;
+    setAllowWaterMark(state: boolean, lineType?: FcrLineType): Promise<void>;
+    _getInterpreterInfo(): import("fcr-core/lib/room-control/interpreter-control/types").FcrInterpreterUserInfo | null | undefined;
 }
+export declare const SecurityStoreContext: import("react").Context<FcrSecurityStore>;