fcr-ui-scene 3.4.5 → 3.5.0

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

@@ -0,0 +1,135 @@
+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 'fcr-core/lib/room-control/chatroom-control/type';
+import React from 'react';
+export interface FcrUIDialogParams {
+    dialogKey: DialogKey;
+    dialogId: string;
+    params?: unknown;
+}
+export interface FcrUIToastParams {
+    type: 'error' | 'warn' | 'info' | 'normal';
+    message: string;
+    duration?: number;
+    id?: string;
+    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;
+    icon?: FcrIconType;
+    okText?: string;
+    cancelText?: string;
+    showCancel?: boolean;
+    closable?: boolean;
+    onConfirm?: () => void;
+    onOk?: () => void;
+    onCancel?: () => void;
+    alignCenter?: boolean;
+    width?: number;
+    height?: number;
+    buttonBlock?: boolean;
+    cancelType?: ButtonType;
+}
+export interface FcrUIUpdateAsideParams {
+    participant?: boolean;
+    chat?: boolean;
+}
+export interface FcrUINewChatMessagesParams {
+    latestMessage: FcrChatRoomReceiveBaseMessage;
+    count: number;
+    type: string;
+}
+export interface FcrUIToggleLayoutParams {
+    layout: 'speaker' | 'gallery';
+    manual?: boolean;
+}
+export interface FcrUIToggleLayoutSizeParams {
+    size: 16 | 25;
+}
+export interface FcrUILayoutSizeChangedParams extends FcrUIToggleLayoutSizeParams {
+}
+export interface FcrUISetMainSpeakerParams {
+    userId: string;
+}
+export interface FcrUIVisibilityStateParams {
+    visibility: boolean;
+}
+export interface FcrUIUpdateShareScreenParams {
+    isOpen: boolean;
+}
+export interface FcrCloudRecordingParams {
+    action: 'start' | 'pause' | 'resume' | 'stop';
+}
+export interface FcrHandleDeviceActionParams {
+    enable?: boolean;
+    view?: HTMLDivElement;
+}
+export interface FcrSpotlightStreamChangedParams {
+    type: 'add' | 'remove';
+    streamId: string;
+}
+export interface FcrUIEventObserver {
+    onEvent?(action: UIAction, payload?: unknown): void;
+}
+export declare class FcrUIEventStore {
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _observable;
+    sendEvent(action: UIAction, payload?: unknown): void;
+    showToast(params: FcrUIToastParams): void;
+    showNotification(params: FcrNotificationParams): void;
+    closeNotification(key: NotificationContentType): void;
+    showChatToast(params: FcrUIToastParams): void;
+    openConfirmDialog(params: ConfirmContentProps): string;
+    openDialog(dialogKey: DialogKey, instanceId?: string, params?: unknown): string;
+    closeDialog(dialogId: string): void;
+    startShareScreen(): void;
+    stopShareScreen(): void;
+    updateAside(params: FcrUIUpdateAsideParams): void;
+    receiveNewChatMessages(params: FcrUINewChatMessagesParams): void;
+    toggleLayout(params: FcrUIToggleLayoutParams): void;
+    notifyLayoutChanged(params: FcrUIToggleLayoutParams): void;
+    toggleLayoutSize(params: FcrUIToggleLayoutSizeParams): void;
+    notifyLayoutSizeChanged(params: FcrUILayoutSizeChangedParams): void;
+    setMainSpeaker(params: FcrUISetMainSpeakerParams): void;
+    setUserPinState(userId: string): void;
+    updateShareState(isOpen: boolean): void;
+    openDeviceSettingDialog(config?: Partial<DeviceSettingDialogConfig>): void;
+    closeDeviceSettingDialog(): void;
+    openLiveStreamingDialog(): void;
+    closeLiveStreamingDialog(): void;
+    stopLiveStreaming(): void;
+    openInviteDialog(): void;
+    closeInviteDialog(): void;
+    closeWaitingRoomDialog(): void;
+    closeRemoveAdmitWaitingRoomDialog(dialogKey: DialogKey): void;
+    closeConfirmDialog(): 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, roomType: RoomType): void;
+    notifyChatResetTarget(): void;
+    release(): void;
+}

package/lib/common/event-store.js

@@ -0,0 +1,280 @@
+"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/esnext.async-iterator.filter.js");
+require("core-js/modules/esnext.async-iterator.for-each.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/web.dom-collections.for-each.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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"));
+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 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);
+    (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) {
+      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.OPEN_DIALOG, {
+        dialogKey: _constant.DialogKey.SHOW_TOAST,
+        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",
+    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: "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: "closeConfirmDialog",
+    value: function closeConfirmDialog() {
+      this.closeDialog(_constant.DialogKey.CONFIRM);
+    }
+  }, {
+    key: "exitRoom",
+    value: function exitRoom(reason, roomType) {
+      this.sendEvent(_constant.UIAction.EXIT_ROOM, {
+        reason: reason,
+        roomType: roomType
+      });
+    }
+  }, {
+    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, roomType) {
+      this.sendEvent(_constant.UIAction.CHAT_UPDATE_TARGET, {
+        user: user,
+        roomType: roomType
+      });
+    }
+  }, {
+    key: "notifyChatResetTarget",
+    value: function notifyChatResetTarget() {
+      this.sendEvent(_constant.UIAction.CHAT_RESET_TARGET);
+    }
+  }, {
+    key: "release",
+    value: function release() {}
+  }]);
+}();

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

@@ -0,0 +1,58 @@
+import { FcrCoreEngine, FcrError } from 'fcr-core';
+import { FcrUIEventStore } from './event-store';
+import { FcrMainRoomControl, FcrRoomJoinOptions, FcrRoomType, FcrWaitingRoomControl } from 'fcr-core/lib/room-control/type';
+import { FcrDeviceStore } from './device-store';
+import { FcrUISceneConfig } from '../type';
+import { FcrInterpreterRoomControl, FcrLanguage } from 'fcr-core/lib/room-control/interpreter-control/types';
+interface ToggleInterpreterRoom {
+    control: FcrInterpreterRoomControl;
+    language: FcrLanguage;
+    isToggleInterperterRemoteAudio?: boolean;
+}
+export interface LeaveInterpreterRoom extends ToggleInterpreterRoom {
+}
+export interface JoinInterpreterRoom extends ToggleInterpreterRoom {
+    roomJoinOptions: FcrRoomJoinOptions;
+}
+export type FcrRoomObserver = {
+    onJoinMainRoom?: (ticket: string) => void;
+    onLeaveMainRoom?: () => void;
+    onJoinMainRoomFailed?: (error: FcrError) => void;
+    onJoinWaitingRoom?: (roomControl: FcrWaitingRoomControl, isWaitingRoomManager?: boolean) => void;
+    onLeaveWaitingRoom?: () => void;
+    onJoinWaitingRoomFailed?: (error: FcrError) => void;
+    onWaitingRoomLocalUserKickedOut?: (roomId: string) => void;
+    onMainRoomLocalUserKickedOut?: (roomId: string) => void;
+    onJoinInterpretingRoom?: (param: JoinInterpreterRoom) => void;
+    onJoinInterpretingRoomSuccess?: (param: JoinInterpreterRoom) => void;
+    onJoinInterpretingRoomFailed?: (param: JoinInterpreterRoom) => void;
+    onLeaveInterpretingRoom?: (param: LeaveInterpreterRoom) => void;
+    onLeaveInterpretingRoomFailed?: (param: LeaveInterpreterRoom) => void;
+    onLeaveInterpretingRoomSuccess?: (param: LeaveInterpreterRoom) => void;
+};
+export declare class FcrRoomStore {
+    private _uiEventStore;
+    private _deviceStore;
+    private _sceneConfig;
+    private _engine;
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _observable;
+    private _mainRoomControl?;
+    private _waitingRoomControl?;
+    private _mainRoomObserver;
+    private _mainRoomUserObserver;
+    private _waitingRoomUserObserver;
+    private _waitingRoomObserver;
+    constructor(_uiEventStore: FcrUIEventStore, _deviceStore: FcrDeviceStore, _sceneConfig: FcrUISceneConfig, _engine: FcrCoreEngine);
+    release(): void;
+    addObserver(observer: FcrRoomObserver): void;
+    removeObserver(observer: FcrRoomObserver): void;
+    handleJoinRoom(roomId: string): Promise<readonly [FcrRoomType.Mainroom, FcrMainRoomControl] | readonly [FcrRoomType.Waitingroom, FcrWaitingRoomControl]>;
+    handleJoinMainRoom(roomId: string, ticket: string): Promise<FcrMainRoomControl>;
+    private _judgeWaitingRoomPremissionAndCreateRoomControl;
+    private _destroyWaitingRoom;
+    private _getJoinRoomOption;
+    joinInterpreterRoom(param: JoinInterpreterRoom): Promise<void>;
+    leaveInterpreterRoom(param: LeaveInterpreterRoom): Promise<void>;
+}
+export {};