@netless/window-manager 1.0.7-beta.1 → 1.0.7-beta.2

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import * as lodash from 'lodash';
 import * as white_web_sdk from 'white-web-sdk';
-import { RoomMember, View, ApplianceNames, Camera, Size, SceneDefinition, SceneState, DisplayerState, ViewVisionMode, CameraState, MagixEventListenerOptions as MagixEventListenerOptions$1, Event as Event$1, Scope, EventPhase, autorun, reaction, toJS, listenUpdated, unlistenUpdated, listenDisposed, unlistenDisposed, Room, ViewMode, Displayer, MemberState, AnimationMode, Player, InvisiblePlugin, InvisiblePluginContext, Rectangle, Point, CameraBound, ImageInformation } from 'white-web-sdk';
+import { SceneDefinition, SceneState, DisplayerState, View, ApplianceNames, ViewVisionMode, CameraState, Event as Event$1, Scope, EventPhase, MagixEventListenerOptions as MagixEventListenerOptions$1, toJS, listenUpdated, unlistenUpdated, listenDisposed, unlistenDisposed, Room, RoomMember, Camera, Size, ViewMode, Displayer, MemberState, AnimationMode, InvisiblePlugin, InvisiblePluginContext, Player, Rectangle, Point, CameraBound, ImageInformation } from 'white-web-sdk';
 export { AnimationMode, Displayer, Player, Room, SceneDefinition, SceneState, View } from 'white-web-sdk';
-import Emittery from 'emittery';
-import { TELE_BOX_STATE, TeleBoxRect, TeleBoxColorScheme, TeleBoxManager, ReadonlyTeleBox, TeleBoxManagerUpdateConfig, TeleBoxConfig, TeleBoxState } from '@netless/telebox-insider';
+import { TELE_BOX_STATE, TeleBoxRect, TeleBoxColorScheme, TeleBoxManager, TeleBoxState, NotMinimizedBoxState, ReadonlyTeleBox, TeleBoxManagerUpdateConfig, TeleBoxConfig } from '@netless/telebox-insider';
 export { ReadonlyTeleBox, TeleBoxRect } from '@netless/telebox-insider';
+import Emittery from 'emittery';
 
 declare enum Events {
     AppMove = "AppMove",
@@ -36,153 +36,6 @@ declare enum AppStatus {
     StartCreate = "StartCreate"
 }
 
-declare class CursorManager {
-    private manager;
-    private enableCursor;
-    containerRect?: DOMRect;
-    wrapperRect?: DOMRect;
-    cursorInstances: Map<string, Cursor>;
-    roomMembers?: readonly RoomMember[];
-    userApplianceIcons: ApplianceIcons;
-    private mainViewElement?;
-    private sideEffectManager;
-    private store;
-    private leaveFlag;
-    private _style;
-    constructor(manager: AppManager, enableCursor: boolean, cursorOptions?: CursorOptions, applianceIcons?: ApplianceIcons);
-    get applianceIcons(): ApplianceIcons;
-    get style(): "default" | "custom";
-    set style(value: "default" | "custom");
-    private onCursorMove;
-    private initCursorInstance;
-    private enableCustomCursor;
-    private canMoveCursor;
-    setupWrapper(wrapper: HTMLElement): void;
-    setMainViewDivElement(div: HTMLDivElement): void;
-    get boxState(): any;
-    get focusView(): View | undefined;
-    private mouseMoveListener_;
-    private mouseMoveTimer;
-    private mouseMoveListener;
-    private mouseLeaveListener;
-    private showPencilEraserIfNeeded;
-    private updateCursor;
-    private getPoint;
-    /**
-     *  因为窗口内框在不同分辨率下的大小不一样，所以这里通过来鼠标事件的 target 来判断是在主白板还是在 APP 中
-     */
-    private getType;
-    updateContainerRect(): void;
-    deleteCursor(uid: string): void;
-    hideCursor(uid: string): void;
-    destroy(): void;
-}
-
-declare class Cursor {
-    private manager;
-    private memberId;
-    private cursorManager;
-    private wrapper?;
-    private member?;
-    private timer?;
-    private component?;
-    private style;
-    constructor(manager: AppManager, memberId: string, cursorManager: CursorManager, wrapper?: HTMLElement | undefined);
-    move: (position: Position) => void;
-    setStyle: (style: typeof this.style) => void;
-    leave: () => void;
-    private moveCursor;
-    get memberApplianceName(): ApplianceNames | undefined;
-    get memberColor(): string;
-    get memberColorHex(): string;
-    private get payload();
-    get memberCursorName(): any;
-    private get memberTheme();
-    private get memberCursorTextColor();
-    private get memberCursorTagBackgroundColor();
-    private get memberAvatar();
-    private get memberOpacity();
-    private get memberTagName();
-    private autoHidden;
-    private createCursor;
-    private initProps;
-    private getIcon;
-    private isCustomIcon;
-    updateMember(): RoomMember | undefined;
-    private updateComponent;
-    destroy(): void;
-    hide(): void;
-}
-
-type Apps = {
-    [key: string]: AppSyncAttributes;
-};
-type Position = {
-    x: number;
-    y: number;
-    type: PositionType;
-    id?: string;
-};
-type PositionType = "main" | "app";
-type StoreContext = {
-    getAttributes: () => any;
-    safeUpdateAttributes: (keys: string[], value: any) => void;
-    safeSetAttributes: (attributes: any) => void;
-};
-type ICamera = Camera & {
-    id: string;
-};
-type ISize = Size & {
-    id: string;
-};
-declare class AttributesDelegate {
-    private context;
-    constructor(context: StoreContext);
-    setContext(context: StoreContext): void;
-    get attributes(): any;
-    apps(): Apps;
-    get focus(): string | undefined;
-    getAppAttributes(id: string): AppSyncAttributes;
-    getAppState(id: string): any;
-    getMaximized(): any;
-    getMinimized(): any;
-    setupAppAttributes(params: AddAppParams, id: string, isDynamicPPT: boolean): void;
-    updateAppState(appId: string, stateName: AppAttributes, state: any): void;
-    cleanAppAttributes(id: string): void;
-    cleanFocus(): void;
-    getAppSceneIndex(id: string): any;
-    getAppScenePath(id: string): any;
-    getMainViewScenePath(): string | undefined;
-    getMainViewSceneIndex(): any;
-    getBoxState(): any;
-    setMainViewScenePath(scenePath: string): void;
-    setMainViewSceneIndex(index: number): void;
-    getMainViewCamera(): MainViewCamera;
-    getMainViewSize(): MainViewSize;
-    setMainViewCamera(camera: ICamera): void;
-    setMainViewSize(size: ISize): void;
-    setMainViewCameraAndSize(camera: ICamera, size: ISize): void;
-    setAppFocus: (appId: string, focus: boolean) => void;
-    updateCursor(uid: string, position: Position): void;
-    updateCursorState(uid: string, cursorState: string | undefined): void;
-    getCursorState(uid: string): any;
-    cleanCursor(uid: string): void;
-    setMainViewFocusPath(mainView: View): void;
-    getIframeBridge(): any;
-    setIframeBridge(data: any): void;
-}
-type MainViewSize = {
-    id: string;
-    width: number;
-    height: number;
-};
-type MainViewCamera = {
-    id: string;
-    centerX: number;
-    centerY: number;
-    scale: number;
-};
-
 type StorageEventListener<T> = (event: T) => void;
 declare class StorageEvent<TMessage> {
     listeners: Set<StorageEventListener<TMessage>>;
@@ -205,6 +58,7 @@ type StorageStateChangedListenerDisposer = () => void;
 
 declare class Storage<TState extends Record<string, any> = any> implements Storage<TState> {
     readonly id: string | null;
+    readonly maxIllusionQueueSize = 500;
     private readonly _context;
     private readonly _sideEffect;
     private _state;
@@ -246,6 +100,9 @@ type BoxMovePayload = {
 type BoxFocusPayload = {
     appId: string;
 };
+type BoxBlurredPayload = {
+    appId: string;
+};
 type BoxResizePayload = {
     appId: string;
     width: number;
@@ -267,6 +124,7 @@ type BoxEvent = {
     resize: BoxResizePayload;
     close: BoxClosePayload;
     boxStateChange: BoxStateChangePayload;
+    blurred: BoxBlurredPayload;
 };
 type BoxEmitterType = Emittery<BoxEvent>;
 
@@ -423,6 +281,7 @@ type PublicEvent = {
     onBoxMove: BoxMovePayload;
     onBoxResize: BoxResizePayload;
     onBoxFocus: BoxFocusPayload;
+    onBoxBlurred: BoxBlurredPayload;
     onBoxClose: BoxClosePayload;
     onBoxStateChange: BoxStateChangePayload;
     onMainViewMounted: View;
@@ -473,6 +332,7 @@ type CreateBoxParams = {
     options?: AddAppOptions;
     canOperate?: boolean;
     smartPosition?: boolean;
+    boxStatus?: TeleBoxState;
 };
 type AppId = {
     appId: string;
@@ -497,11 +357,14 @@ type CreateTeleBoxManagerConfig = {
     collectorContainer?: HTMLElement;
     collectorStyles?: Partial<CSSStyleDeclaration>;
     prefersColorScheme?: TeleBoxColorScheme;
+    useBoxesStatus?: boolean;
 };
 type BoxManagerContext = {
     safeSetAttributes: (attributes: any) => void;
     getMainView: () => View;
     updateAppState: (appId: string, field: AppAttributes, value: any) => void;
+    setBoxStatus: (appId: string, status?: TeleBoxState) => void;
+    setLastNotMinimizedBoxStatus: (appId: string, status?: NotMinimizedBoxState) => void;
     emitter: EmitterType;
     boxEmitter: BoxEmitterType;
     callbacks: CallbacksType;
@@ -517,7 +380,7 @@ declare class BoxManager {
     constructor(context: BoxManagerContext, createTeleBoxManagerConfig?: CreateTeleBoxManagerConfig | undefined);
     private get mainView();
     private get canOperate();
-    get boxState(): "maximized" | "minimized" | "normal";
+    get boxState(): "normal" | "minimized" | "maximized";
     get maximized(): boolean;
     get minimized(): boolean;
     get darkMode(): boolean;
@@ -525,6 +388,10 @@ declare class BoxManager {
     get boxSize(): number;
     createBox(params: CreateBoxParams): void;
     setBoxInitState(appId: string): void;
+    setBoxesStatus(status?: Record<string, TeleBoxState>): void;
+    setBoxStatus(appId: string, status?: TeleBoxState): void;
+    setLastNotMinimizedBoxesStatus(status?: Record<string, NotMinimizedBoxState>): void;
+    setLastNotMinimizedBoxStatus(appId: string, status?: NotMinimizedBoxState): void;
     setupBoxManager(createTeleBoxManagerConfig?: CreateTeleBoxManagerConfig): TeleBoxManager;
     setCollectorContainer(container: HTMLElement): void;
     getBox(appId: string): ReadonlyTeleBox | undefined;
@@ -587,8 +454,8 @@ declare class AppContext<TAttributes extends {} = any, TMagixEventPayloads = any
     private appOptions?;
     readonly emitter: Emittery<AppEmitterEvent<TAttributes>>;
     readonly mobxUtils: {
-        autorun: typeof autorun;
-        reaction: typeof reaction;
+        autorun: any;
+        reaction: any;
         toJS: typeof toJS;
     };
     readonly objectUtils: {
@@ -600,8 +467,12 @@ declare class AppContext<TAttributes extends {} = any, TMagixEventPayloads = any
     private store;
     readonly isAddApp: boolean;
     readonly isReplay: boolean;
-    constructor(manager: AppManager, boxManager: BoxManager, appId: string, appProxy: AppProxy, appOptions?: TAppOptions | (() => TAppOptions) | undefined);
+    constructor(manager: AppManager, boxManager: BoxManager, appId: string, appProxy: AppProxy, appOptions?: (TAppOptions | (() => TAppOptions)) | undefined);
+    getManager: () => AppManager;
+    getBoxManager: () => BoxManager;
+    getWindowManager: () => WindowManager;
     getDisplayer: () => white_web_sdk.Displayer<white_web_sdk.DisplayerCallbacks>;
+    getAppProxy: () => AppProxy;
     /** @deprecated Use context.storage.state instead. */
     getAttributes: () => TAttributes | undefined;
     getScenes: () => SceneDefinition[] | undefined;
@@ -708,6 +579,167 @@ declare class AppProxy implements PageRemoveService {
     close(): Promise<void>;
 }
 
+declare class CursorManager {
+    private manager;
+    private enableCursor;
+    containerRect?: DOMRect;
+    wrapperRect?: DOMRect;
+    cursorInstances: Map<string, Cursor>;
+    roomMembers?: readonly RoomMember[];
+    userApplianceIcons: ApplianceIcons;
+    private mainViewElement?;
+    private sideEffectManager;
+    private store;
+    private leaveFlag;
+    private _style;
+    constructor(manager: AppManager, enableCursor: boolean, cursorOptions?: CursorOptions, applianceIcons?: ApplianceIcons);
+    get applianceIcons(): ApplianceIcons;
+    get style(): "default" | "custom";
+    set style(value: "default" | "custom");
+    private onCursorMove;
+    private initCursorInstance;
+    private enableCustomCursor;
+    private canMoveCursor;
+    setupWrapper(wrapper: HTMLElement): void;
+    setMainViewDivElement(div: HTMLDivElement): void;
+    get boxState(): any;
+    get focusView(): View | undefined;
+    private mouseMoveListener_;
+    private mouseMoveTimer;
+    private mouseMoveListener;
+    private mouseLeaveListener;
+    private showPencilEraserIfNeeded;
+    private updateCursor;
+    private getPoint;
+    /**
+     *  因为窗口内框在不同分辨率下的大小不一样，所以这里通过来鼠标事件的 target 来判断是在主白板还是在 APP 中
+     */
+    private getType;
+    updateContainerRect(): void;
+    deleteCursor(uid: string): void;
+    hideCursor(uid: string): void;
+    destroy(): void;
+}
+
+declare class Cursor {
+    private manager;
+    private memberId;
+    private cursorManager;
+    private wrapper?;
+    private member?;
+    private timer?;
+    private component?;
+    private style;
+    constructor(manager: AppManager, memberId: string, cursorManager: CursorManager, wrapper?: HTMLElement | undefined);
+    move: (position: Position) => void;
+    setStyle: (style: typeof this.style) => void;
+    leave: () => void;
+    private moveCursor;
+    get memberApplianceName(): ApplianceNames | undefined;
+    get memberColor(): string;
+    get memberColorHex(): string;
+    private get payload();
+    get memberCursorName(): any;
+    private get memberTheme();
+    private get memberCursorTextColor();
+    private get memberCursorTagBackgroundColor();
+    private get memberAvatar();
+    private get memberOpacity();
+    private get memberTagName();
+    private autoHidden;
+    private createCursor;
+    private initProps;
+    private getIcon;
+    private isCustomIcon;
+    updateMember(): RoomMember | undefined;
+    private updateComponent;
+    destroy(): void;
+    hide(): void;
+}
+
+type ExtendClass = {
+    AppManager?: typeof AppManager;
+    BoxManager?: typeof BoxManager;
+    AttributesDelegate?: typeof AttributesDelegate;
+    CursorManager?: typeof CursorManager;
+    AppProxy?: typeof AppProxy;
+};
+
+type Apps = {
+    [key: string]: AppSyncAttributes;
+};
+type Position = {
+    x: number;
+    y: number;
+    type: PositionType;
+    id?: string;
+};
+type PositionType = "main" | "app";
+type StoreContext = {
+    getAttributes: () => any;
+    safeUpdateAttributes: (keys: string[], value: any) => void;
+    safeSetAttributes: (attributes: any) => void;
+};
+type ICamera = Camera & {
+    id: string;
+};
+type ISize = Size & {
+    id: string;
+};
+declare class AttributesDelegate {
+    private context;
+    constructor(context: StoreContext);
+    setContext(context: StoreContext): void;
+    get attributes(): any;
+    apps(): Apps;
+    get focus(): string | undefined;
+    getAppAttributes(id: string): AppSyncAttributes;
+    getAppState(id: string): any;
+    getMaximized(): any;
+    getMinimized(): any;
+    getBoxesStatus(): Record<string, TELE_BOX_STATE> | undefined;
+    getBoxStatus(id: string): TELE_BOX_STATE | undefined;
+    setBoxStatus(id: string, status?: TeleBoxState): void;
+    getLastNotMinimizedBoxesStatus(): Record<string, NotMinimizedBoxState> | undefined;
+    getLastNotMinimizedBoxStatus(id: string): NotMinimizedBoxState | undefined;
+    setLastNotMinimizedBoxStatus(id: string, status?: NotMinimizedBoxState): void;
+    setupAppAttributes(params: AddAppParams, id: string, isDynamicPPT: boolean): void;
+    updateAppState(appId: string, stateName: AppAttributes, state: any): void;
+    cleanAppAttributes(id: string): void;
+    cleanFocus(): void;
+    getAppSceneIndex(id: string): any;
+    getAppScenePath(id: string): any;
+    getMainViewScenePath(): string | undefined;
+    getMainViewSceneIndex(): any;
+    getBoxState(): any;
+    setMainViewScenePath(scenePath: string): void;
+    setMainViewSceneIndex(index: number): void;
+    getMainViewCamera(): MainViewCamera;
+    getMainViewSize(): MainViewSize;
+    setMainViewCamera(camera: ICamera): void;
+    setMainViewSize(size: ISize): void;
+    setMainViewCameraAndSize(camera: ICamera, size: ISize): void;
+    setAppFocus: (appId: string, focus: boolean) => void;
+    updateCursor(uid: string, position: Position): void;
+    updateCursorState(uid: string, cursorState: string | undefined): void;
+    getCursorState(uid: string): any;
+    cleanCursor(uid: string): void;
+    setMainViewFocusPath(mainView: View): void;
+    getIframeBridge(): any;
+    setIframeBridge(data: any): void;
+}
+type MainViewSize = {
+    id: string;
+    width: number;
+    height: number;
+};
+type MainViewCamera = {
+    id: string;
+    centerX: number;
+    centerY: number;
+    scale: number;
+};
+
 declare class MainViewProxy {
     private manager;
     /** Refresh the view's camera in an interval of 1.5s. */
@@ -819,6 +851,9 @@ declare class AppManager {
     private sideEffectManager;
     sceneState: SceneState | null;
     rootDirRemoving: boolean;
+    private _useBoxesStatus;
+    get useBoxesStatus(): boolean;
+    set useBoxesStatus(value: boolean);
     constructor(windowManger: WindowManager);
     getMemberState(): MemberState;
     private onRemoveScenes;
@@ -850,8 +885,10 @@ declare class AppManager {
     private onBoxMove;
     private onBoxResize;
     private onBoxFocus;
+    private onBoxBlurred;
     private onBoxClose;
     private onBoxStateChange;
+    addBoxesStatusChangeListener: () => void;
     addAppsChangeListener: () => void;
     addAppCloseListener: () => void;
     private onMainViewIndexChange;
@@ -1147,8 +1184,13 @@ type AppInitState = {
     maximized?: boolean;
     minimized?: boolean;
     sceneIndex?: number;
+    /** 所有box的基本状态 */
     boxState?: TeleBoxState;
     zIndex?: number;
+    /** 扩展版本,单个box的状态 */
+    boxStatus?: TeleBoxState;
+    /** 上次非最小化窗口状态 */
+    lastNotMinimizedBoxStatus?: NotMinimizedBoxState;
 };
 type CursorMovePayload = {
     uid: string;
@@ -1182,6 +1224,8 @@ type MountParams = {
     fullscreen?: boolean;
     polling?: boolean;
     supportAppliancePlugin?: boolean;
+    /** 是否使用 boxesStatus 状态 */
+    useBoxesStatus?: boolean;
 };
 declare const reconnectRefresher: ReconnectRefresher;
 declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any> implements PageController {
@@ -1211,12 +1255,13 @@ declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
     private _cursorUIDsStyleDOM?;
     private boxManager?;
     private static params?;
+    static extendClass?: ExtendClass;
     private containerResizeObserver?;
     containerSizeRatio: number;
     private extendPluginManager?;
     constructor(context: InvisiblePluginContext);
     static onCreate(manager: WindowManager): void;
-    static mount(params: MountParams): Promise<WindowManager>;
+    static mount(params: MountParams, extendClass?: ExtendClass): Promise<WindowManager>;
     private static initManager;
     private static initContainer;
     static get registered(): Map<string, RegisterParams>;
@@ -1292,6 +1337,10 @@ declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
     setBoxState(boxState: TeleBoxState): void;
     setMaximized(maximized: boolean): void;
     setMinimized(minimized: boolean): void;
+    /** 设置指定 box 的状态, 如果为 undefined, 则移除状态*/
+    setBoxStatus(boxId: string, boxStatus?: TELE_BOX_STATE): void;
+    /** 设置指定 box 的非最小化状态, 如果为 undefined, 则移除状态 */
+    setLastNotMinimizedBoxStatus(boxId: string, lastNotMinimizedBoxStatus?: NotMinimizedBoxState): void;
     setFullscreen(fullscreen: boolean): void;
     get cursorUIDs(): string[];
     setCursorUIDs(cursorUIDs?: string[] | null): void;
@@ -1300,6 +1349,8 @@ declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
     get cameraState(): CameraState;
     get apps(): Apps | undefined;
     get boxState(): TeleBoxState | undefined;
+    get boxStatus(): Record<string, TELE_BOX_STATE> | undefined;
+    get lastNotMinimizedBoxStatus(): Record<string, NotMinimizedBoxState> | undefined;
     get darkMode(): boolean;
     get prefersColorScheme(): TeleBoxColorScheme | undefined;
     get focused(): string | undefined;
@@ -1371,4 +1422,5 @@ declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
     useExtendPlugin(extend: ExtendPluginInstance<any>): void;
 }
 
-export { type AddAppOptions, type AddAppParams, type AddPageParams, AppContext, AppCreateError, type AppEmitterEvent, type AppInitState, type AppListenerKeys, AppManagerNotInitError, AppNotRegisterError, type AppPayload, type AppSyncAttributes, type ApplianceIcons, type BaseInsertParams, BindContainerRoomPhaseInvalidError, BoxManagerNotFoundError, BoxNotCreatedError, BuiltinApps, type CursorMovePayload, type CursorOptions, DomEvents, type ExtendContext, type ExtendManagerOptions, ExtendPlugin, type ExtendPluginInstance, ExtendPluginManager, IframeBridge, type IframeBridgeAttributes, type IframeBridgeEvents, IframeEvents, type IframeSize, type InsertOptions, InvalidScenePath, type MountParams, type NetlessApp, type OnCreateInsertOption, type PageController, type PageRemoveService, type PageState, ParamsInvalidError, type PublicEvent, type RegisterEventData, type RegisterEvents, type RegisterParams, Storage, type StorageStateChangedEvent, type StorageStateChangedListener, WhiteWebSDKInvalidError, WindowManager, type WindowMangerAttributes, type apps, calculateNextIndex, reconnectRefresher, type setAppOptions };
+export { AppContext, AppCreateError, AppManagerNotInitError, AppNotRegisterError, BindContainerRoomPhaseInvalidError, BoxManagerNotFoundError, BoxNotCreatedError, BuiltinApps, DomEvents, ExtendPlugin, ExtendPluginManager, IframeBridge, IframeEvents, InvalidScenePath, ParamsInvalidError, Storage, WhiteWebSDKInvalidError, WindowManager, calculateNextIndex, reconnectRefresher };
+export type { AddAppOptions, AddAppParams, AddPageParams, AppEmitterEvent, AppInitState, AppListenerKeys, AppPayload, AppSyncAttributes, ApplianceIcons, BaseInsertParams, CursorMovePayload, CursorOptions, ExtendContext, ExtendManagerOptions, ExtendPluginInstance, IframeBridgeAttributes, IframeBridgeEvents, IframeSize, InsertOptions, MountParams, NetlessApp, OnCreateInsertOption, PageController, PageRemoveService, PageState, PublicEvent, RegisterEventData, RegisterEvents, RegisterParams, StorageStateChangedEvent, StorageStateChangedListener, WindowMangerAttributes, apps, setAppOptions };