fcr-core 3.7.8 → 3.8.0-alpha

package/lib/room-control/{whiteboard-control/types.d.ts → whiteboard-control-v2/type.d.ts}

@@ -1,114 +1,12 @@
-import { FcrConnectionState } from '../..';
-import { FcrBoardShape, FcrBoardToolType } from './enums';
-import { AgoraRteRenderView, FcrImageData, FcrJoinRoomOptions, FcrWhiteboardView } from '../../imports';
-import { ColorSchema } from '../../schema';
-import { FcrSize } from '../stream-control/type';
-import { FcrBoardPropertiesState } from '../whiteboard-control-v2/whiteboard-control/type';
-export type FcrBaseWhiteboardObserver = {
-    /**
-     * Callback to receive the connection state change.
-     * @param state
-     */
-    onConnectionStateUpdated?(state: FcrConnectionState): void;
-};
-export type FcrBoardMainWindowObserver = {
-    /**
-     * Callback to receive the page info change.
-     * @param info
-     */
-    onPageInfoUpdated?(info: FcrBoardPageInfo): void;
-    /**
-     * Callback to receive the undo state change.
-     * @param enable
-     */
-    onUndoStateUpdated?(enable: boolean): void;
-    /**
-     * Callback to receive the redo state change.
-     * @param enable
-     */
-    onRedoStateUpdated?(enable: boolean): void;
-};
-export type FcrBoardRoomJoinConfig = {
-    roomId: string;
-    roomToken?: string;
-    boardRatio: number;
-    hasOperationPrivilege: boolean;
-    userId: string;
-    userName: string;
-};
-export type FcrColor = ColorSchema;
-export type FcrBoardState = {
-    strokeColor: FcrColor;
-    strokeWidth: number;
-    textSize: number;
-    tool: FcrBoardToolType;
-    shape: FcrBoardShape;
-};
-export type FetchImageResult = {
-    width: number;
-    height: number;
-    file: unknown;
-    uuid: string;
-    url: string;
-};
-export type BaseImageSize = {
-    width: number;
-    height: number;
-};
-export type FcrBoardPageInfo = {
-    showIndex: number;
-    count: number;
-};
-export type FcrBoardPage = {
-    name: string;
-    contentUrl: string;
-    previewUrl: string;
-    contentWidth: number;
-    contentHeight: number;
-};
-export type FcrBoardH5WindowConfig = {
-    resourceUuid: string;
-    resourceUrl: string;
-    title: string;
-};
-export type FcrBoardMediaWindowConfig = {
-    resourceUuid: string;
-    resourceUrl: string;
-    title: string;
-    mimeType: string;
-};
-export type FcrBoardMaterialWindowConfig<T = unknown> = {
-    resourceUuid: string;
-    urlPrefix: string;
-    title: string;
-    pageList: T[];
-    taskUuid: string;
-    resourceHasAnimation: boolean;
-};
-export type MountOptions = {
-    collectorContainer?: AgoraRteRenderView;
-    containerSizeRatio?: number;
-};
-export type SlideOptions = {
-    minFPS?: number;
-    maxFPS?: number;
-    resolution?: number;
-    autoResolution?: boolean;
-    autoFPS?: boolean;
-    maxResolutionLevel?: number;
-    forceCanvas?: boolean;
-};
-export type FcrBoardWindowOptions = SlideOptions & {
-    debug: boolean;
-};
-export type FcrBoardRoomOptions = SlideOptions & {
-    debug: boolean;
-};
-export interface FcrBaseWhiteboardControl {
+import { FcrImageData, FcrWhiteboardView } from '../../imports';
+import { FcrConnectionState, FcrSize } from '../../type';
+import { FcrBoardToolType } from './enum';
+import type { FcrBoardPageInfo, FcrColor } from '../whiteboard-control/type';
+export interface FcrBaseWhiteboardControl<T extends FcrBaseWhiteboardObserver> {
     /**
      * Opens the whiteboard and creates a main window.
      */
-    open(): Promise<FcrBoardMainWindow>;
+    open(parameters?: Record<string, unknown>): Promise<FcrBoardMainWindow>;
     /**
      * Closes the whiteboard and releases the main window.
      */
@@ -120,17 +18,22 @@ export interface FcrBaseWhiteboardControl {
     /**
      * Gets the main window of the whiteboard.
      */
-    getMainWindow(): FcrBoardMainWindow | undefined;
+    getMainWindow(): FcrBoardMainWindow | null;
+    /**
+     * Sets whether the current user has operation privilege.
+     * @param hasOperationPrivilege
+     */
+    setOperationPrivilege(hasOperationPrivilege: boolean): void;
     /**
      * Adds an observer to the whiteboard.
      * @param observer
      */
-    addObserver(observer: FcrBaseWhiteboardObserver): void;
+    addObserver(observer: T): void;
     /**
      * Removes the observer from the whiteboard.
      * @param observer
      */
-    removeObserver(observer: FcrBaseWhiteboardObserver): void;
+    removeObserver(observer: T): void;
 }
 export interface FcrBoardMainWindow {
     /**
@@ -240,6 +143,10 @@ export interface FcrBoardMainWindow {
      * @param enable
      */
     setAutoCancelDraw(enable: boolean): void;
+    /**
+     * Checks if the current user has write permission.
+     */
+    getWritable(): boolean;
     /**
      * Adds an observer to the main window.
      * @param observer
@@ -251,62 +158,41 @@ export interface FcrBoardMainWindow {
      */
     removeObserver(observer: FcrBoardMainWindowObserver): void;
 }
-export type FcrBoardExtra = {
+export interface FcrBaseWhiteboardObserver {
+    /**
+     * Callback to receive the connection state change.
+     * @param state
+     */
+    onConnectionStateUpdated?(state: FcrConnectionState): void;
+}
+export interface FcrBoardMainWindowObserver {
+    /**
+     * Callback to receive the page info change.
+     * @param info
+     */
+    onPageInfoUpdated?(info: FcrBoardPageInfo): void;
+    /**
+     * Callback to receive the undo state change.
+     * @param enable
+     */
+    onUndoStateUpdated?(enable: boolean): void;
+    /**
+     * Callback to receive the redo state change.
+     * @param enable
+     */
+    onRedoStateUpdated?(enable: boolean): void;
+    /**
+     * Callback to receive the writable state change.
+     * @param isWritable
+     */
+    onWritable?(isWritable: boolean): void;
+}
+export type FcrObjectForgeInitConfig = {
     boardAppId: string;
     boardId: string;
-    boardRegion: FcrJoinRoomOptions['sdkConfig']['region'];
+    boardRegion: string;
     boardToken: string;
 };
-export type FcrBoardInfo = {
-    state: FcrBoardPropertiesState;
-    isActive: boolean;
-    ownerUserUuid: string;
-    extra: FcrBoardExtra & {
-        backgroundColor: string;
-    };
-};
-export type FcrBoardDocPage = {
-    name: string;
-    contentUrl: string;
-    previewUrl: string;
-    contentWidth: number;
-    contentHeight: number;
-};
-export type FcrBoardSubWindowConfig = {
-    resourceUuid: string;
-    resourceHasAnimation: boolean;
-    title: string;
-    pageList: number[];
-};
-export type FcrBoardMediaSubWindowConfig = {
-    resourceUrl: string;
-    title: string;
+export type FcrBoardInfoExtra = {
+    backgroundColor: string;
 };
-export type FcrWhiteboardScreenShareData = {
-    videoState: number;
-    videoSourceState: number;
-    videoSourceType: number;
-    audioState: number;
-    audioSourceState: number;
-    audioSourceType: number;
-};
-export type FcrBoradRoomConfig = {
-    boardRatio: number;
-    userId: string;
-    userName: string;
-    roomId: string;
-};
-export type FcrBoardActiveInfo = {
-    isActive: true;
-    ownerUserId: string;
-    reason?: FcrBoardInactiveReason;
-} | {
-    isActive: false;
-    ownerUserId: null;
-    reason?: FcrBoardInactiveReason;
-};
-export declare enum FcrBoardInactiveReason {
-    CLOSE = 1,
-    TIMEOUT = 2,
-    SEIZE = 3
-}

package/lib/room-control/whiteboard-control-v2/type.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/lib/room-control/whiteboard-control-v2/utils.d.ts

@@ -1,7 +1,6 @@
-import { WhiteboardToolType } from '@netless/forge-whiteboard';
-import { FcrBoardToolType } from '../whiteboard-control/enums';
-import type { Logger } from 'agora-foundation/lib/logger';
-export declare function convertToForgeBoardTool(type: FcrBoardToolType): WhiteboardToolType;
+import { FcrBoardToolType } from './enum';
+import { Logger, FcrWhiteboardToolType } from '../../imports';
+export declare function convertToForgeBoardTool(type: FcrBoardToolType): FcrWhiteboardToolType;
 export declare const getAnnotationConfigFromRoomProperties: (properties: Record<string, unknown>, logger: Logger) => {
     size: {
         width: number;
@@ -18,3 +17,5 @@ export declare const resizeToMax: (w: number, h: number, scaleBase?: number) =>
     width: number;
     height: number;
 };
+export declare const WHITEBOARD_WIDTH = 1920;
+export declare const WHITEBOARD_HEIGHT = 1080;

package/lib/room-control/whiteboard-control-v2/utils.js

@@ -1,53 +1,52 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.WHITEBOARD_WIDTH = exports.WHITEBOARD_HEIGHT = void 0;
 exports.convertToForgeBoardTool = convertToForgeBoardTool;
 exports.resizeToMax = exports.getAnnotationConfigFromRoomProperties = void 0;
-var _enums = require("../whiteboard-control/enums");
-var _get = _interopRequireDefault(require("lodash/get"));
+var _enum = require("./enum");
 var _imports = require("../../imports");
 function convertToForgeBoardTool(type) {
   switch (type) {
-    case _enums.FcrBoardToolType.ARROW:
+    case _enum.FcrBoardToolType.ARROW:
       return 'arrow';
-    case _enums.FcrBoardToolType.CURVE:
+    case _enum.FcrBoardToolType.CURVE:
       return 'curve';
-    case _enums.FcrBoardToolType.ELLIPSE:
+    case _enum.FcrBoardToolType.ELLIPSE:
       return 'ellipse';
-    case _enums.FcrBoardToolType.ERASER:
+    case _enum.FcrBoardToolType.ERASER:
       return 'eraser';
-    case _enums.FcrBoardToolType.LASER_POINTER:
+    case _enum.FcrBoardToolType.LASER_POINTER:
       return 'laser';
-    case _enums.FcrBoardToolType.TEXT:
+    case _enum.FcrBoardToolType.TEXT:
       return 'text';
-    case _enums.FcrBoardToolType.RECTANGLE:
+    case _enum.FcrBoardToolType.RECTANGLE:
       return 'rectangle';
-    case _enums.FcrBoardToolType.TRIANGLE:
+    case _enum.FcrBoardToolType.TRIANGLE:
       return 'triangle';
-    case _enums.FcrBoardToolType.SELECTOR:
+    case _enum.FcrBoardToolType.SELECTOR:
       return 'selector';
-    case _enums.FcrBoardToolType.STRAIGHT:
+    case _enum.FcrBoardToolType.STRAIGHT:
       return 'line';
     // case FcrBoardToolType.PENTAGRAM:
     //   return 'pentagram';
     // case FcrBoardToolType.RHOMBUS:
     //   return 'rhombus';
-    case _enums.FcrBoardToolType.HAND:
+    case _enum.FcrBoardToolType.HAND:
       return 'grab';
     default:
       return 'curve';
   }
 }
 const getAnnotationConfigFromRoomProperties = (properties, logger) => {
-  const boardAppId = (0, _get.default)(properties, 'widgets.annotation.extra.boardAppId');
-  const boardId = (0, _get.default)(properties, 'widgets.annotation.extra.boardId');
-  const boardToken = (0, _get.default)(properties, 'widgets.annotation.extra.boardToken');
-  const boardRegion = (0, _get.default)(properties, 'widgets.annotation.extra.boardRegion');
-  let width = (0, _get.default)(properties, 'widgets.annotation.size.width');
-  let height = (0, _get.default)(properties, 'widgets.annotation.size.height');
+  const boardAppId = (0, _imports.get)(properties, 'widgets.annotation.extra.boardAppId');
+  const boardId = (0, _imports.get)(properties, 'widgets.annotation.extra.boardId');
+  const boardToken = (0, _imports.get)(properties, 'widgets.annotation.extra.boardToken');
+  const boardRegion = (0, _imports.get)(properties, 'widgets.annotation.extra.boardRegion');
+  let width = (0, _imports.get)(properties, 'widgets.annotation.size.width');
+  let height = (0, _imports.get)(properties, 'widgets.annotation.size.height');
   if (typeof width !== 'number') {
     logger.warn("got invalid width for annotation board, width: ".concat(width));
     width = 0;
@@ -99,4 +98,6 @@ const resizeToMax = function (w, h) {
   };
 };
 exports.resizeToMax = resizeToMax;
-const FCR_ANNOTATION_SCALE_BASE = 1920;
+const FCR_ANNOTATION_SCALE_BASE = 1920;
+const WHITEBOARD_WIDTH = exports.WHITEBOARD_WIDTH = 1920;
+const WHITEBOARD_HEIGHT = exports.WHITEBOARD_HEIGHT = 1080;

package/lib/room-control/whiteboard-control-v2/whiteboard-control/control.d.ts

@@ -1,34 +1,35 @@
-import { AgoraRteConnectionState } from 'agora-rte-sdk';
-import { FcrBaseWhiteboardControl, FcrBoardExtra, FcrBoardMainWindow } from '../../whiteboard-control/types';
-import { AgoraObservable } from 'agora-rte-sdk/lib/imports';
-import { FcrBoardConfig, FcrWhiteboardObserver } from './type';
-import { FcrConnectionState } from '../../..';
-import { Room } from '@netless/forge-room';
-import { Whiteboard, WhiteboardPermissionFlag } from '@netless/forge-whiteboard';
-import { AgoraRtmClient } from 'agora-rte-sdk/lib/core/rtm/client';
-export declare class FcrWhiteboardControlImpl implements FcrBaseWhiteboardControl {
-    private _rtmClient;
-    private _config;
-    protected logger: import("agora-rte-sdk/lib/imports").Logger;
-    protected whiteboard: Whiteboard | undefined;
-    protected boardRoom: Room | undefined;
-    protected observable: AgoraObservable<FcrWhiteboardObserver>;
-    private _boardView;
-    private _connectState;
-    private _boardConfig;
-    private _openAbortController;
-    constructor(_rtmClient: AgoraRtmClient, _config: FcrBoardConfig);
-    openWithConfig(config: FcrBoardExtra): Promise<FcrBoardMainWindow>;
-    open(): Promise<FcrBoardMainWindow>;
-    close(): Promise<void>;
-    getConnectionState(): AgoraRteConnectionState;
-    getMainWindow(): FcrBoardMainWindow | undefined;
-    addObserver(observer: FcrWhiteboardObserver): void;
-    removeObserver(observer: FcrWhiteboardObserver): void;
-    release(): void;
-    addPermission(permission: WhiteboardPermissionFlag): void;
-    removePermission(permission: WhiteboardPermissionFlag): void;
-    protected updateConnnectionState(state: FcrConnectionState): void;
-    private _addLogObserver;
-    protected _connect(): Promise<FcrBoardMainWindow>;
+import { FcrObjectForgeInitConfig } from '../type';
+import { AgoraRteScene } from '../../../imports';
+import type { RTMClient } from 'agora-rtm';
+import { FcrCoreServiceApi } from '../../../service/api';
+import { FcrSharedCache } from '../../shared-cache';
+import { FcrBoardConfig, FcrStandaloneWhiteboardControl, FcrWhiteboardControl, FcrWhiteboardObserver } from './type';
+import { FcrBaseWhiteboardControlImpl } from '../base';
+import { FcrBoardActiveInfo } from '../../whiteboard-control/type';
+import { WhiteboardOption } from '@netless/forge-whiteboard';
+export declare class FcrWhiteboardControlImpl extends FcrBaseWhiteboardControlImpl<FcrWhiteboardObserver> implements FcrWhiteboardControl {
+    private _scene;
+    private _api;
+    protected logger: import("agora-foundation/lib/logger/type").Logger;
+    private _roomCache;
+    private _backgroundColor;
+    private _isActive;
+    private _ownerId;
+    private _notifyObservers;
+    constructor(rtmClient: RTMClient, config: FcrBoardConfig, hasOperationPrivilege: boolean, sharedCache: FcrSharedCache, forgeInitConfigFetcher: () => Promise<FcrObjectForgeInitConfig>, _scene: AgoraRteScene, _api: FcrCoreServiceApi);
+    active(): Promise<void>;
+    inactive(): Promise<void>;
+    getBoardActiveInfo(): FcrBoardActiveInfo;
+    setBackgroundColor(backgroundColor: string): Promise<void>;
+    getBackgroundColor(): string;
+    getActivity(): boolean;
+    getOwnerId(): string | null;
+    protected getApplicationId(): string;
+    private _onScenePropertiesUpdated;
+    protected getWhiteboardOption(): WhiteboardOption;
+    protected addLogObserver(): void;
+}
+export declare class FcrStandaloneWhiteboardControlImpl extends FcrBaseWhiteboardControlImpl<FcrWhiteboardObserver> implements FcrStandaloneWhiteboardControl {
+    protected getApplicationId(): string;
+    protected getWhiteboardOption(): WhiteboardOption;
 }