fcr-ui-scene 3.7.7-rc.1 → 3.7.8

package/lib/modules/dialog/hooks/useElectron.d.ts

@@ -0,0 +1,28 @@
+import { FcrUIDialogHooksProps } from '../type';
+export declare const DialogInstanceContext: import("react").Context<{
+    browserWindow: Electron.BrowserWindow;
+    newRendererWindow: Window;
+    resizable: boolean;
+    baseUrl: string;
+    closeDialog: () => void;
+    /**
+     * @param continueClose - 继续关闭窗口的回调函数
+     */
+    continueClose: () => void;
+    /**
+     * 窗口关闭时是否已被拦截，此值只反应状态，不会影响继续关闭的逻辑
+     */
+    interceptedClose: boolean;
+    /**
+     * 重置被拦截状态
+     */
+    setInterceptedClose: (interceptedClose: boolean) => void;
+}>;
+export declare const shadowOffset: number;
+export declare const enterFullScreenHandler: () => void;
+export declare const leaveFullScreenHandler: () => void;
+export declare function useElectronDialog(props: FcrUIDialogHooksProps): {
+    store: import("../store").default;
+    browserWindow: Electron.BrowserWindow | undefined;
+    newRendererWindow: Window | undefined;
+};

package/lib/modules/dialog/hooks/useElectron.js

@@ -0,0 +1,277 @@
+"use strict";
+
+require("core-js/modules/es.symbol.js");
+require("core-js/modules/es.array.filter.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/esnext.iterator.filter.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.shadowOffset = exports.leaveFullScreenHandler = exports.enterFullScreenHandler = exports.DialogInstanceContext = void 0;
+exports.useElectronDialog = useElectronDialog;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+require("core-js/modules/es.array.concat.js");
+require("core-js/modules/es.array.for-each.js");
+require("core-js/modules/es.array.includes.js");
+require("core-js/modules/es.date.to-json.js");
+require("core-js/modules/es.json.stringify.js");
+require("core-js/modules/es.object.to-string.js");
+require("core-js/modules/es.promise.js");
+require("core-js/modules/es.string.includes.js");
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.for-each.js");
+require("core-js/modules/esnext.promise.with-resolvers.js");
+require("core-js/modules/web.dom-collections.for-each.js");
+var _react = require("react");
+var _store = require("../store");
+var _renderer = require("../../../utilities/renderer");
+var _reactDom = require("react-dom");
+var _levelConfig = require("../level-config");
+var _dialogUtils = require("../../../utilities/dialog-utils");
+var _constant = require("../../../utilities/constant");
+var _mobx = require("mobx");
+var _jsxRuntime = require("react/jsx-runtime");
+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 DialogInstanceContext = exports.DialogInstanceContext = /*#__PURE__*/(0, _react.createContext)(null);
+var shadowOffset = exports.shadowOffset = 15 + 15;
+var enterFullScreenHandler = exports.enterFullScreenHandler = function enterFullScreenHandler() {
+  _store.dialogWindows.forEach(function (win, k) {
+    !_levelConfig.TOP_LEVEL_DIALOG_LAYER.includes(k) && win.setAlwaysOnTop(true, _levelConfig.diffPlatformHighLevelLayer);
+  });
+};
+var leaveFullScreenHandler = exports.leaveFullScreenHandler = function leaveFullScreenHandler() {
+  _store.dialogWindows.forEach(function (win, k) {
+    ![].concat((0, _toConsumableArray2["default"])(_levelConfig.TOP_LEVEL_DIALOG_LAYER), (0, _toConsumableArray2["default"])(_levelConfig.HIGH_LEVEL_DIALOG_LAYER)).includes(k) && win.setAlwaysOnTop(true, 'normal');
+  });
+};
+function useElectronDialog(props) {
+  var store = (0, _react.useContext)(_store.StoreContext);
+  var customConfigs = props.config,
+    dialogId = props.dialogId,
+    dialogKey = props.dialogKey,
+    onClose = props.onClose,
+    scroll = props.scroll,
+    _props$focus = props.focus,
+    focus = _props$focus === void 0 ? true : _props$focus,
+    children = props.children,
+    ignoreMouseEvents = props.ignoreMouseEvents,
+    _props$alwaysOnTop = props.alwaysOnTop,
+    alwaysOnTop = _props$alwaysOnTop === void 0 ? false : _props$alwaysOnTop,
+    fullScreen = props.fullScreen,
+    onOpened = props.onOpened,
+    onUnmounted = props.onUnmounted,
+    _props$hasCustomShado = props.hasCustomShadow,
+    hasCustomShadow = _props$hasCustomShado === void 0 ? true : _props$hasCustomShado,
+    _props$disableShortcu = props.disableShortcutClose,
+    disableShortcutClose = _props$disableShortcu === void 0 ? false : _props$disableShortcu,
+    beforeClose = props.beforeClose;
+  var dialogIdOrKey = dialogId || dialogKey;
+  var windowRef = (0, _react.useRef)();
+  var newRendernerWindowRef = (0, _react.useRef)();
+  var _customConfigs$width = customConfigs.width,
+    w = _customConfigs$width === void 0 ? 0 : _customConfigs$width,
+    _customConfigs$height = customConfigs.height,
+    h = _customConfigs$height === void 0 ? 0 : _customConfigs$height;
+  var config = _objectSpread(_objectSpread({
+    type: 'panel',
+    hasShadow: false,
+    frame: false,
+    transparent: true,
+    resizeble: false
+  }, customConfigs), {}, {
+    setAlwaysOnTop: alwaysOnTop,
+    width: w + (hasCustomShadow ? shadowOffset : 0),
+    height: h + (hasCustomShadow ? shadowOffset : 0)
+  });
+  (0, _react.useEffect)(function () {
+    var node;
+    window.runtime.openRendererWindow(dialogIdOrKey, function (dom, browserWindow, newRendererWindow, baseUrl) {
+      node = dom;
+      windowRef.current = browserWindow;
+      newRendernerWindowRef.current = newRendererWindow;
+      if (dialogId) {
+        store === null || store === void 0 || store.log("[dialog]: open dialog can I find dialog with dialogId: ".concat(dialogKey, ": ").concat(_store.dialogIdWindows.has(dialogId)));
+        _store.dialogIdWindows.set(dialogId, browserWindow);
+      } else {
+        store === null || store === void 0 || store.log("[dialog]: open dialog can I find dialog with dialogKey: ".concat(dialogKey, ": ").concat(_store.dialogWindows.has(dialogKey)));
+        _store.dialogWindows.set(dialogKey, browserWindow);
+      }
+      var isControlbar = dialogKey === _constant.FcrUIDialogKey.CONTROL_BAR;
+      var follow = isControlbar ? false : 'screen';
+      var _ref = (0, _dialogUtils.followCorrectDisplay)({
+          browserWindow: browserWindow,
+          alwaysFollowScreen: fullScreen,
+          follow: follow
+        }),
+        nearDisplayBounds = _ref.nearDisplayBounds,
+        followControlbar = _ref.followControlbar;
+      function handleMouseMove(event) {
+        store === null || store === void 0 || store.setConfirmPosition({
+          x: event.screenX,
+          y: event.screenY
+        });
+      }
+      newRendererWindow.addEventListener('mousemove', handleMouseMove);
+      store === null || store === void 0 || store.log("[useElectronDialog][dialog]: ".concat(dialogId ? 'dialogId' : 'dialogKey', ": ").concat(dialogKey, ", ").concat(followControlbar ? 'control bar' : 'main window', " nearing display bounds: ").concat(JSON.stringify(nearDisplayBounds)));
+
+      // 设置所有窗口为所有工作区可见
+      browserWindow.setVisibleOnAllWorkspaces(true, {
+        visibleOnFullScreen: true,
+        skipTransformProcessType: true
+      });
+
+      // @ts-ignore
+      // window._browserWindows = window._browserWindows || {};
+      // @ts-ignore
+      // window._browserWindows[dialogKey] = browserWindow;
+      // @ts-ignore
+      // window._windows = window._windows || {};
+      // @ts-ignore
+      // window._windows[dialogKey] = newRendererWindow;
+
+      // 因为窗口有可能需要单独设置位置，所以，窗口打开的回调需要放置在默认的位置设置之后
+      onOpened === null || onOpened === void 0 || onOpened({
+        browserWindow: browserWindow,
+        newRendererWindow: newRendererWindow,
+        store: store,
+        // 重写 setBounds 方法，使得设置 bounds 时，自动加上阴影的宽度
+        setBounds: function setBounds(bounds, animate) {
+          var b = _objectSpread({}, bounds);
+          if (b.width && hasCustomShadow) b.width = b.width + shadowOffset;
+          if (b.height && hasCustomShadow) b.height = b.height + shadowOffset;
+          browserWindow.setBounds(b, animate);
+        },
+        nearDisplayBounds: nearDisplayBounds
+      });
+
+      // 同原生 electron 的 ignoreMouseEvents 一样，设置为 true 时，窗口将不再接收鼠标事件
+      if (ignoreMouseEvents) {
+        browserWindow.setIgnoreMouseEvents(true, typeof ignoreMouseEvents === 'boolean' ? {
+          forward: true
+        } : ignoreMouseEvents);
+      }
+      browserWindow.setAlwaysOnTop(typeof alwaysOnTop === 'boolean' ? alwaysOnTop : typeof alwaysOnTop === 'string', typeof alwaysOnTop === 'string' ? alwaysOnTop : _levelConfig.diffPlatformHighLevelLayer);
+      if (_levelConfig.TOP_LEVEL_DIALOG_LAYER.includes(dialogKey)) {
+        browserWindow.setAlwaysOnTop(true, _levelConfig.diffPlatformTopLevelLayer);
+      }
+      if (_levelConfig.HIGH_LEVEL_DIALOG_LAYER.includes(dialogKey)) {
+        browserWindow.setAlwaysOnTop(true, _levelConfig.diffPlatformHighLevelLayer);
+      }
+      if (!scroll) {
+        browserWindow.webContents.insertCSS("\n            ::-webkit-scrollbar {\n              display: none;\n            }\n            #root {\n              padding: ".concat(hasCustomShadow ? shadowOffset / 2 : 0, "px;\n              display: ").concat(hasCustomShadow ? 'flex' : 'block', ";\n              align-items: center;\n            }\n          "));
+      }
+      if (disableShortcutClose) {
+        newRendererWindow.addEventListener('keydown', function (event) {
+          if ((event.ctrlKey || event.metaKey) && event.key === 'w') {
+            event.preventDefault();
+          }
+        });
+      }
+      focus && browserWindow.focus();
+      store === null || store === void 0 || store.log("[useElectronDialog][dialog]: dialog ".concat(dialogIdOrKey, " focused"));
+      var _Promise$withResolver = Promise.withResolvers(),
+        promise = _Promise$withResolver.promise,
+        resolve = _Promise$withResolver.resolve;
+      function continueClose() {
+        store === null || store === void 0 || store.log("[useElectronDialog][dialog]: continueClose");
+        (0, _reactDom.unmountComponentAtNode)(node);
+        if (dialogId) {
+          store.closeDilaogByDialogId(dialogId);
+        } else {
+          _store.dialogWindows["delete"](dialogKey);
+          store === null || store === void 0 || store.closeDialogByKey(dialogKey);
+        }
+        onClose === null || onClose === void 0 || onClose({
+          store: store,
+          browserWindow: browserWindow,
+          newRendererWindow: newRendererWindow
+        });
+        return true;
+      }
+      var dialogInstanceValue = (0, _mobx.observable)({
+        browserWindow: browserWindow,
+        newRendererWindow: newRendererWindow,
+        resizable: !!customConfigs.resizable,
+        baseUrl: baseUrl,
+        closeDialog: function closeDialog() {
+          dialogId ? store.closeDilaogByDialogId(dialogId) : store.closeDialogByKey(dialogKey);
+        },
+        continueClose: function continueClose() {
+          return resolve(false);
+        },
+        interceptedClose: false,
+        setInterceptedClose: function setInterceptedClose(interceptedClose) {
+          dialogInstanceValue.interceptedClose = interceptedClose;
+        }
+      });
+      (0, _renderer.handleWillClose)(browserWindow, /*#__PURE__*/(0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee() {
+        var interception;
+        return _regenerator["default"].wrap(function (_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              interception = (beforeClose === null || beforeClose === void 0 ? void 0 : beforeClose({
+                store: store,
+                browserWindow: browserWindow,
+                newRendererWindow: newRendererWindow,
+                continueClose: function continueClose() {
+                  return resolve(false);
+                }
+              })) || false;
+              dialogInstanceValue.setInterceptedClose(interception);
+              if (!interception) {
+                _context.next = 1;
+                break;
+              }
+              _context.next = 1;
+              return promise;
+            case 1:
+              continueClose();
+              return _context.abrupt("return", false);
+            case 2:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      })));
+      (0, _reactDom.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_store.StoreContext.Provider, {
+        value: store,
+        children: /*#__PURE__*/(0, _jsxRuntime.jsx)(DialogInstanceContext.Provider, {
+          value: dialogInstanceValue,
+          children: typeof children === 'function' ? children(browserWindow) : children
+        })
+      }), dom);
+    }, config);
+    if ((0, _renderer.isMac)()) {
+      // 这组监听是为了处理 mac 全屏模式下，弹窗会因为主窗口全屏而变成独立窗口的问题
+      window.runtime.browserWindow.addListener('enter-full-screen', enterFullScreenHandler);
+      window.runtime.browserWindow.addListener('leave-full-screen', leaveFullScreenHandler);
+    }
+    return function () {
+      node && (0, _reactDom.unmountComponentAtNode)(node);
+      if ((0, _renderer.isMac)()) {
+        window.runtime.browserWindow.removeListener('enter-full-screen', enterFullScreenHandler);
+        window.runtime.browserWindow.removeListener('leave-full-screen', leaveFullScreenHandler);
+      }
+      // showtoast 和 confirm 的 dialog 需要常驻，所以不关闭
+      if (dialogIdOrKey !== _constant.FcrUIDialogKey.SHOW_TOAST && dialogIdOrKey !== _constant.FcrUIDialogKey.CONFIRM) {
+        window.runtime.closeRendererWindow(dialogIdOrKey);
+      }
+      onUnmounted === null || onUnmounted === void 0 || onUnmounted(store);
+    };
+  }, []);
+  return {
+    store: store,
+    browserWindow: windowRef.current,
+    newRendererWindow: newRendernerWindowRef.current
+  };
+}

package/lib/modules/dialog/store.d.ts

@@ -0,0 +1,135 @@
+import { FcrStreamControl, FcrUserControl } from 'fcr-core';
+import { FcrUIDialogKey } from '../../utilities/constant';
+import { FcrUIPrivilegeProvider } from '../../providers/privilege-provider';
+import { FcrUIDeviceProvider } from '../../providers/device-provider';
+import { FcrUILocalVideoRenderProvider, FcrUIRemoteVideoRenderProvider } from '../../providers/renderer-provider';
+import { FcrUIEventProvider } from '../../providers/event-provider';
+import { FcrUISharedLayoutDataSource } from '../../shared-data-source/layout-data';
+import { FcrUIDialogProvider } from '../../providers/dialog-provider';
+import { FcrUIPhoneAudioConnectorProvider } from '../../providers/phone-audio-provider';
+import { FcrWindowInfo } from 'fcr-core/lib/type';
+import { CurrentShareBounds } from '../control-bar/types';
+import { FcrUIDialogComponent } from './type';
+import { FcrUIWidgetProvider } from '../../providers/widget-provider';
+import { FcrUIChatProvider } from '../../providers/chat-provider';
+import { FcrUIAbilityProviderImpl } from 'fcr-ui-scene/src/providers/ability-provider';
+import { FcrUIScreenShareSharedDataSource } from '../../shared-data-source/screen-share-data';
+import { FcrUISharedConfirmDataSource } from '../../shared-data-source/confirm-data';
+import { CurrentShareScreenWorkArea } from '../../utilities/dialog-utils';
+import { FcrUIAnnotationProvider } from '../../providers/annotation-provider';
+import { FcrUIMultiDisplayProvider } from '../../providers/multi-display-provider';
+import { FcrUIRoomProvider } from '../../providers/room-provider';
+import { FcrUISharedSettingDataSource } from '../../shared-data-source/setting';
+export declare let dialogWindows: Map<FcrUIDialogKey, Electron.BrowserWindow>;
+export declare let dialogIdWindows: Map<string, Electron.BrowserWindow>;
+export default class DialogStore {
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _eventProvider;
+    private _userInfo;
+    private _streamControl;
+    private _userControl;
+    private _deviceStore;
+    private _securityStore;
+    private _localVideoRenderProvider;
+    private _remoteVideoRenderManager;
+    private _dialogProvider;
+    private _widgetProvider;
+    private _sharedSettingDataSource;
+    private _roomProvider;
+    private _sharedLayoutDataSource;
+    private _phoneAudioConnectorProvider;
+    private _sharedScreenShareSharedDataSource;
+    private _sharedConfirmDataSource;
+    private _dialogComponentMapByKey;
+    private _chatProvider;
+    private _multiDisplayProvider?;
+    private _electronDialogs;
+    private _annotationProvider;
+    private _disposers;
+    private _handleDialogEventObserver;
+    private _userObserver;
+    private _roomObserver;
+    private _handleSecondaryWindowEventObserver;
+    accessor openedDialogs: {
+        dialogKey: FcrUIDialogKey;
+        dialogId: string;
+        params?: unknown;
+    }[];
+    accessor confirmDialogs: Map<string, unknown>;
+    accessor userCount: number;
+    accessor participantElectronDialogContainer: HTMLElement | null;
+    accessor currentDialogBounds: Map<FcrUIDialogKey, number>;
+    accessor videoWindowBounds: any;
+    accessor recordShareBounds: Map<CurrentShareBounds, CurrentShareScreenWorkArea>;
+    accessor allApplicationWindows: FcrWindowInfo[];
+    accessor interceptClose: boolean;
+    get currentShareId(): string;
+    get currentShareType(): import("fcr-core/lib/type").FcrScreenCaptureType;
+    get currentShareBounds(): CurrentShareBounds;
+    get dialogComponentMapByKey(): Map<FcrUIDialogKey, FcrUIDialogComponent>;
+    get participantCount(): number;
+    get isManager(): boolean;
+    get dialogs(): {
+        dialogKey: FcrUIDialogKey;
+        dialogId: string;
+        params?: unknown;
+    }[];
+    get streamControl(): FcrStreamControl;
+    get deviceStore(): FcrUIDeviceProvider;
+    get remoteVideoRenderManager(): FcrUIRemoteVideoRenderProvider;
+    get localVideoRenderProvider(): FcrUILocalVideoRenderProvider;
+    get waitingRoomState(): boolean;
+    get isMultiDisplayActive(): boolean;
+    get connectType(): import("../../type").FcrUIConnectType;
+    get hasOwnPstnStream(): boolean;
+    get widgetDialogIds(): Map<string, string>;
+    get chatRoomState(): import("fcr-core/lib/type").FcrChatRoomConnectionState;
+    get isSharingScreen(): boolean;
+    get isSharingScreenOwner(): boolean;
+    constructor({ eventProvider, userControl, deviceStore, streamControl, localVideoRenderProvider, remoteVideoRenderManager, securityStore, sharedLayoutDataSource, dialogProvider, phoneAudioConnectorProvider, dialogsByKey, widgetProvider, chatProvider, sharedScreenShareSharedDataSource, sharedConfirmDataSource, annotationProvider, multiDisplayProvider, roomProvider, sharedSettingDataSource, }: {
+        streamControl: FcrStreamControl;
+        userControl: FcrUserControl;
+        eventProvider: FcrUIEventProvider;
+        securityStore: FcrUIPrivilegeProvider;
+        deviceStore: FcrUIDeviceProvider;
+        localVideoRenderProvider: FcrUILocalVideoRenderProvider;
+        remoteVideoRenderManager: FcrUIRemoteVideoRenderProvider;
+        sharedLayoutDataSource: FcrUISharedLayoutDataSource;
+        dialogProvider: FcrUIDialogProvider;
+        phoneAudioConnectorProvider: FcrUIPhoneAudioConnectorProvider;
+        dialogsByKey: Map<FcrUIDialogKey, FcrUIDialogComponent>;
+        widgetProvider: FcrUIWidgetProvider;
+        chatProvider: FcrUIChatProvider;
+        abilityProvider: FcrUIAbilityProviderImpl;
+        sharedScreenShareSharedDataSource: FcrUIScreenShareSharedDataSource;
+        sharedConfirmDataSource: FcrUISharedConfirmDataSource;
+        annotationProvider: FcrUIAnnotationProvider;
+        multiDisplayProvider?: FcrUIMultiDisplayProvider;
+        roomProvider: FcrUIRoomProvider;
+        sharedSettingDataSource: FcrUISharedSettingDataSource;
+    });
+    setConfirmPosition(position: {
+        x: number;
+        y: number;
+    }): void;
+    setParticipantElectronDialogContainer(dom: HTMLElement | null): void;
+    setVideoWindowBounds(payload: any): void;
+    closeDialogByKey(dialogKey: FcrUIDialogKey): void;
+    closeDilaogByDialogId(dialogId: string): void;
+    closeSystemPreferenceDialog(): void;
+    closeChatFromDialog(): void;
+    moveChatFromDialogToAside(): void;
+    closeConnectionDialog(): boolean;
+    closeParticipantDialog(): void;
+    moveParticipantFromDialogToAside(): void;
+    release(): void;
+    resizeVideoWindow(width: number, height: number): void;
+    recordCurrentSharingScreenBounds(): CurrentShareScreenWorkArea;
+    moveMainWindowToIndexLeastDisplay(): void;
+    log(info: string): void;
+    private _handleDialogEvent;
+    private _hanleAllUserCountUpdated;
+    private _handleSecondaryWindowEvent;
+    private _setInterceptClose;
+}
+export declare const StoreContext: import("react").Context<DialogStore>;