fcr-ui-scene 1.0.20 → 3.1.0

package/lib/modules/whiteboard/context.d.ts

@@ -0,0 +1,66 @@
+import React from 'react';
+import { FcrBoardRoomConnectionState } from 'agora-edu-core/lib/room-control/whiteboard-control/enums';
+export interface DraggableHandler {
+    getPosition(): {
+        x: number;
+        y: number;
+    };
+    getSize(): {
+        width: number;
+        height: number;
+    };
+    updatePosition(position: {
+        x: number;
+        y: number;
+    }): void;
+    updateSize(size: {
+        width: string | number;
+        height: string | number;
+    }): void;
+}
+declare const boardUIContextDefault: {
+    observables: {
+        canOperate: boolean;
+        minimized: boolean;
+        connectionState: FcrBoardRoomConnectionState;
+        joinSuccessed: boolean;
+        contentAreaSize: {
+            width: number;
+            height: number;
+            left: number;
+            top: number;
+        };
+        progress: number;
+        writeEnabled: boolean;
+    };
+    handleBoardDomLoad: (ref: HTMLDivElement | null) => void;
+    handleCollectorDomLoad: (ref: HTMLDivElement | null) => void;
+    handleClose: () => void;
+    handleOpen: () => void;
+    setPrivilege: (canOperate: boolean) => void;
+    setWriteEnable: (enable: boolean) => void;
+};
+export declare const BoardUIContext: React.Context<{
+    observables: {
+        canOperate: boolean;
+        minimized: boolean;
+        connectionState: FcrBoardRoomConnectionState;
+        joinSuccessed: boolean;
+        contentAreaSize: {
+            width: number;
+            height: number;
+            left: number;
+            top: number;
+        };
+        progress: number;
+        writeEnabled: boolean;
+    };
+    handleBoardDomLoad: (ref: HTMLDivElement | null) => void;
+    handleCollectorDomLoad: (ref: HTMLDivElement | null) => void;
+    handleClose: () => void;
+    handleOpen: () => void;
+    setPrivilege: (canOperate: boolean) => void;
+    setWriteEnable: (enable: boolean) => void;
+}>;
+export type BoardUIContextValue = typeof boardUIContextDefault;
+export {};

package/lib/modules/whiteboard/context.js

@@ -0,0 +1,34 @@
+"use strict";
+
+require("core-js/modules/es.object.define-property.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BoardUIContext = void 0;
+var _react = require("react");
+var _enums = require("agora-edu-core/lib/room-control/whiteboard-control/enums");
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+var boardUIContextDefault = {
+  observables: {
+    canOperate: false,
+    minimized: false,
+    connectionState: _enums.FcrBoardRoomConnectionState.DISCONNECTED,
+    joinSuccessed: false,
+    contentAreaSize: {
+      width: 0,
+      height: 0,
+      left: 0,
+      top: 0
+    },
+    progress: 0,
+    writeEnabled: false
+  },
+  handleBoardDomLoad: function handleBoardDomLoad(ref) {},
+  handleCollectorDomLoad: function handleCollectorDomLoad(ref) {},
+  handleClose: function handleClose() {},
+  handleOpen: function handleOpen() {},
+  setPrivilege: function setPrivilege(canOperate) {},
+  setWriteEnable: function setWriteEnable(enable) {}
+};
+var BoardUIContext = exports.BoardUIContext = /*#__PURE__*/(0, _react.createContext)(boardUIContextDefault);

package/lib/modules/whiteboard/i18n/config.d.ts

@@ -0,0 +1 @@
+export declare const addResource: () => void;

package/lib/modules/whiteboard/i18n/config.js

@@ -0,0 +1,15 @@
+"use strict";
+
+require("core-js/modules/es.object.define-property.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.addResource = void 0;
+var _i18n = require("agora-ui-foundation/lib/i18n");
+var _en = _interopRequireDefault(require("./en"));
+var _zh = _interopRequireDefault(require("./zh"));
+var addResource = exports.addResource = function addResource() {
+  (0, _i18n.addResourceBundle)('zh', _zh["default"]);
+  (0, _i18n.addResourceBundle)('en', _en["default"]);
+};

package/lib/modules/whiteboard/i18n/en/index.d.ts

@@ -0,0 +1,32 @@
+declare const _default: {
+    fcr_savecanvas_tips_save_successfully: string;
+    fcr_savecanvas_tips_save_failed: string;
+    fcr_board_resource_already_opened: string;
+    fcr_board_tool_eraser: string;
+    fcr_board_tool_extra: string;
+    fcr_board_tool_undo: string;
+    fcr_board_tool_redo: string;
+    fcr_board_tool_clicker: string;
+    fcr_board_tool_selector: string;
+    fcr_board_tool_text: string;
+    fcr_board_tool_drag: string;
+    fcr_board_tool_laser_pointer: string;
+    fcr_board_tool_save: string;
+    fcr_board_tool_move: string;
+    fcr_board_tool_pen: string;
+    fcr_board_tool_screen: string;
+    fcr_board_tool_shape: string;
+    fcr_board_new_page: string;
+    fcr_board_show_pageration: string;
+    fcr_board_hide_pageration: string;
+    fcr_board_display_name: string;
+    fcr_savecanvas_tips_saving: string;
+    fcr_board_cannot_join_room: string;
+    fcr_board_label_connect_board: string;
+    fcr_board_label_reconnect_board: string;
+    fcr_board_window_connect_board1: string;
+    fcr_board_window_connect_board2: string;
+    fcr_board_button_continue_wait: string;
+    fcr_board_button_close_whiteboard: string;
+};
+export default _default;

package/lib/modules/whiteboard/i18n/en/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+require("core-js/modules/es.object.define-property.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = exports["default"] = {
+  fcr_savecanvas_tips_save_successfully: 'Save successfully',
+  fcr_savecanvas_tips_save_failed: 'Save failed',
+  fcr_board_resource_already_opened: 'The resource is already opened',
+  fcr_board_tool_eraser: 'Eraser',
+  fcr_board_tool_extra: 'Extra',
+  fcr_board_tool_undo: 'Undo',
+  fcr_board_tool_redo: 'Redo',
+  fcr_board_tool_clicker: 'Clicker',
+  fcr_board_tool_selector: 'Selector',
+  fcr_board_tool_text: 'Text',
+  fcr_board_tool_drag: 'Drag',
+  fcr_board_tool_laser_pointer: 'Laser Pointer',
+  fcr_board_tool_save: 'Save',
+  fcr_board_tool_move: 'Move',
+  fcr_board_tool_pen: 'Pen',
+  fcr_board_tool_screen: 'Screen',
+  fcr_board_tool_shape: 'Shape',
+  fcr_board_new_page: 'New page',
+  fcr_board_show_pageration: 'Show Pageration',
+  fcr_board_hide_pageration: 'Hide Pageration',
+  fcr_board_display_name: 'Whiteboard',
+  fcr_savecanvas_tips_saving: 'outputing, please wait',
+  fcr_board_cannot_join_room: 'Cannot join whiteboard room after times of attemptting, please rejoin classroom',
+  fcr_board_label_connect_board: 'Opening whiteboard, please wait...',
+  fcr_board_label_reconnect_board: 'We are reconnecting the whiteboard for you, please wait...',
+  fcr_board_window_connect_board1: 'We are  reconnecting the whiteboard for you, please wait...',
+  fcr_board_window_connect_board2: "If you haven't connected to the whiteboard for a long time, you can temporarily close the whiteboard and try again later.",
+  fcr_board_button_continue_wait: 'Continue to wait...',
+  fcr_board_button_close_whiteboard: 'Close whiteboard without waiting'
+};

package/lib/modules/whiteboard/i18n/zh/index.d.ts

@@ -0,0 +1,32 @@
+declare const _default: {
+    fcr_savecanvas_tips_save_successfully: string;
+    fcr_savecanvas_tips_save_failed: string;
+    fcr_board_resource_already_opened: string;
+    fcr_board_tool_eraser: string;
+    fcr_board_tool_extra: string;
+    fcr_board_tool_undo: string;
+    fcr_board_tool_redo: string;
+    fcr_board_tool_clicker: string;
+    fcr_board_tool_selector: string;
+    fcr_board_tool_text: string;
+    fcr_board_tool_drag: string;
+    fcr_board_tool_laser_pointer: string;
+    fcr_board_tool_save: string;
+    fcr_board_tool_move: string;
+    fcr_board_tool_pen: string;
+    fcr_board_tool_screen: string;
+    fcr_board_tool_shape: string;
+    fcr_board_new_page: string;
+    fcr_board_show_pageration: string;
+    fcr_board_hide_pageration: string;
+    fcr_board_display_name: string;
+    fcr_savecanvas_tips_saving: string;
+    fcr_board_cannot_join_room: string;
+    fcr_board_label_connect_board: string;
+    fcr_board_label_reconnect_board: string;
+    fcr_board_window_connect_board1: string;
+    fcr_board_window_connect_board2: string;
+    fcr_board_button_continue_wait: string;
+    fcr_board_button_close_whiteboard: string;
+};
+export default _default;

package/lib/modules/whiteboard/i18n/zh/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+require("core-js/modules/es.object.define-property.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = exports["default"] = {
+  fcr_savecanvas_tips_save_successfully: '保存成功',
+  fcr_savecanvas_tips_save_failed: '保存失败',
+  fcr_board_resource_already_opened: '课件已打开',
+  fcr_board_tool_eraser: '橡皮擦',
+  fcr_board_tool_extra: '更多',
+  fcr_board_tool_undo: '撤销',
+  fcr_board_tool_redo: '恢复',
+  fcr_board_tool_clicker: '鼠标',
+  fcr_board_tool_selector: '选择',
+  fcr_board_tool_text: '文本',
+  fcr_board_tool_drag: '拖拽',
+  fcr_board_tool_laser_pointer: '激光笔',
+  fcr_board_tool_save: '保存板书',
+  fcr_board_tool_move: '移动',
+  fcr_board_tool_pen: '书写',
+  fcr_board_tool_screen: '截图',
+  fcr_board_tool_shape: '形状',
+  fcr_board_new_page: '新增一页',
+  fcr_board_show_pageration: '显示页码',
+  fcr_board_hide_pageration: '隐藏页码',
+  fcr_board_display_name: '白板',
+  fcr_savecanvas_tips_saving: '正在导出，请稍后...',
+  fcr_board_cannot_join_room: '加入白板房间失败，请重新进入教室',
+  fcr_board_label_connect_board: '正在打开白板，请稍后...',
+  fcr_board_label_reconnect_board: '我们正在为您重新连接白板，请等待...',
+  fcr_board_window_connect_board1: '我们正在为您重新连接白板，请等待...',
+  fcr_board_window_connect_board2: '如长时间没有连接上白板，您可以暂时关闭白板，稍后再回来重试。',
+  fcr_board_button_continue_wait: '继续等待...',
+  fcr_board_button_close_whiteboard: '不等待了，关闭白板'
+};

package/lib/modules/whiteboard/index.d.ts

@@ -0,0 +1,114 @@
+import { FcrUserControl } from 'agora-edu-core/lib/room-control/user-control';
+import { FcrUIEventStore } from '../../common/event-store';
+import { FcrBoardRegion, ToolbarEvents, WhiteboardBaseEvents, WhiteboardControlbarEvents, WhiteboardRoomEvents, WhiteboardUIEvents } from './type';
+import { FcrRoomControl } from 'agora-edu-core/lib/room-control';
+import { DialogKey, UIAction } from '../../utilities/constant';
+import { UIModule } from '../../base';
+import { FcrUserInfo } from 'agora-edu-core/lib/type';
+import { FcrStreamControl } from 'agora-edu-core';
+import { FcrSecurityStore } from '../../common/security-store';
+import { FcrWhiteboardControl } from 'agora-edu-core/lib/room-control/whiteboard-control/types';
+import { FcrUIVideoWindowLayoutType } from '../layout/type';
+export declare class FcrWhiteboardUIModule extends UIModule {
+    private _disposers;
+    private _uiEventStore;
+    private _userControl;
+    private _roomControl;
+    private _securityStore;
+    private _whiteboardControl;
+    private _boardStore;
+    private _connectionState;
+    private _boardMainWindow;
+    private _toolbarContext?;
+    private _defaultBoardState;
+    private _toolbarStore;
+    private _controlbarStore;
+    private _initWidth;
+    private _initHeight;
+    private _joinSuccessed;
+    private _isActive;
+    private _timer;
+    private _isMyBoard;
+    private _t;
+    protected _mounted: boolean;
+    protected _initialized: boolean;
+    protected _joined: boolean;
+    protected _boardDom?: HTMLDivElement | null;
+    protected _collectorDom?: HTMLDivElement | null;
+    protected _grantedUsers: Set<string>;
+    protected _outerDom?: Element;
+    protected _initArgs?: {
+        appId: string;
+        region: FcrBoardRegion;
+    };
+    private accessor _lonelyWindowState;
+    private accessor _ownerUser;
+    private accessor _isHost;
+    private accessor _boardBackground;
+    private accessor _localUser;
+    get hasPrivilege(): boolean;
+    get contentAreaSize(): {
+        width: number;
+        height: number;
+        top: number;
+        left: number;
+    };
+    constructor({ uiEventStore, userControl, roomControl, whiteboardControl, streamControl, securityStore, }: {
+        uiEventStore: FcrUIEventStore;
+        userControl: FcrUserControl;
+        roomControl: FcrRoomControl;
+        whiteboardControl: FcrWhiteboardControl;
+        streamControl: FcrStreamControl;
+        securityStore: FcrSecurityStore;
+    });
+    getComponent(dom?: Element | null): React.ReactNode;
+    onEvent(event: UIAction, payload: {
+        dialogKey: DialogKey;
+        dialogId?: string;
+    } & {
+        action: WhiteboardControlbarEvents | WhiteboardBaseEvents;
+        payload?: boolean | FcrUIVideoWindowLayoutType | WhiteboardControlbarEvents;
+    } & {
+        layout: FcrUIVideoWindowLayoutType;
+    }): void;
+    onProcessEvent(event: {
+        action: ToolbarEvents & WhiteboardRoomEvents & WhiteboardUIEvents;
+        payload: never;
+    }): void;
+    onPropertiesUpdate(params: {
+        operatorUser: FcrUserInfo;
+    }): void;
+    onDestroy(params?: {
+        operatorUser?: FcrUserInfo;
+    }): void;
+    mount(): void;
+    unmount(): void;
+    unload(): void;
+    private _setBackground;
+    private _resetToolIfNeed;
+    private _checkBoard;
+    private _boardUIEvents;
+    private _caseToolbarEvents;
+    private _setCanvasBound;
+    private _resetCanvasPosition;
+    private _resetScaleState;
+    private _createBoardUIContext;
+    private _createToolbarUIContext;
+    private _updateDockPosition;
+    private _updateDockPlacement;
+    private _repositionToolbar;
+    private _updateMaxVisibleTools;
+    private _setBackgroundColor;
+    private _updateRedo;
+    private _updateUndo;
+    private _setConnectionState;
+    private _open;
+    private _close;
+    private _getSnapshotImage;
+    private _openLonelyWindow;
+    private _setJoinSuccessed;
+    private _boardObservble;
+    private _MainWindowEvents;
+    private _addDisposers;
+    private _alertWhenReplace;
+}