@netless/window-manager 0.3.18 → 0.4.0-canary.11

package/src/index.ts

@@ -1,18 +1,19 @@
-import AppDocsViewer from "@netless/app-docs-viewer";
-import AppMediaPlayer, { setOptions } from "@netless/app-media-player";
 import Emittery from "emittery";
 import pRetry from "p-retry";
 import { AppManager } from "./AppManager";
 import { appRegister } from "./Register";
+import { ContainerResizeObserver } from "./ContainerResizeObserver";
+import { createBoxManager } from "./BoxManager";
 import { CursorManager } from "./Cursor";
-import { DEFAULT_CONTAINER_RATIO, REQUIRE_VERSION } from "./constants";
+import { DEFAULT_CONTAINER_RATIO, Events, REQUIRE_VERSION } from "./constants";
 import { Fields } from "./AttributesDelegate";
 import { initDb } from "./Register/storage";
 import { isNull, isObject } from "lodash";
 import { log } from "./Utils/log";
+import { ReconnectRefresher } from "./ReconnectRefresher";
 import { replaceRoomFunction } from "./Utils/RoomHacker";
-import { ResizeObserver as ResizeObserverPolyfill } from "@juggle/resize-observer";
-import { setupWrapper } from "./ViewManager";
+import { setupBuiltin } from "./BuiltinApps";
+import { setupWrapper } from "./Helper";
 import "./style.css";
 import "@netless/telebox-insider/dist/style.css";
 import {
@@ -22,7 +23,7 @@ import {
     isValidScenePath,
     wait,
 } from "./Utils/Common";
-import type { TELE_BOX_STATE } from "./BoxManager";
+import type { TELE_BOX_STATE, BoxManager } from "./BoxManager";
 import {
     AppCreateError,
     AppManagerNotInitError,
@@ -58,8 +59,6 @@ import type { NetlessApp, RegisterParams } from "./typings";
 import type { TeleBoxColorScheme, TeleBoxState } from "@netless/telebox-insider";
 import type { AppProxy } from "./AppProxy";
 
-const ResizeObserver = window.ResizeObserver || ResizeObserverPolyfill;
-
 export type WindowMangerAttributes = {
     modelValue?: string;
     boxState: TELE_BOX_STATE;
@@ -80,14 +79,14 @@ export type AddAppOptions = {
 
 export type setAppOptions = AddAppOptions & { appOptions?: any };
 
-export type AddAppParams = {
+export type AddAppParams<TAttributes = any> = {
     kind: string;
     // app 地址(本地 app 不需要传)
     src?: string;
     // 窗口配置
     options?: AddAppOptions;
     // 初始化 attributes
-    attributes?: any;
+    attributes?: TAttributes;
 };
 
 export type BaseInsertParams = {
@@ -108,6 +107,7 @@ export type AppSyncAttributes = {
     state?: any;
     isDynamicPPT?: boolean;
     fullPath?: string;
+    createdAt?: number;
 };
 
 export type AppInitState = {
@@ -137,9 +137,11 @@ export type EmitterEvent = {
     observerIdChange: number;
     boxStateChange: string;
     playgroundSizeChange: DOMRect;
+    onReconnected: void;
 };
 
-export const emitter: Emittery<EmitterEvent> = new Emittery();
+export type EmitterType = Emittery<EmitterEvent>;
+export const emitter: EmitterType = new Emittery();
 
 export type PublicEvent = {
     mainViewModeChange: ViewVisionMode;
@@ -147,11 +149,14 @@ export type PublicEvent = {
     darkModeChange: boolean;
     prefersColorSchemeChange: TeleBoxColorScheme;
     cameraStateChange: CameraState;
+    mainViewScenePathChange: string;
+    mainViewSceneIndexChange: number;
+    focusedChange: string | undefined;
 };
 
 export type MountParams = {
     room: Room;
-    container: HTMLElement;
+    container?: HTMLElement;
     /** 白板高宽比例, 默认为 9 / 16 */
     containerSizeRatio?: number;
     /** 显示 PS 透明背景，默认 true */
@@ -165,7 +170,10 @@ export type MountParams = {
     prefersColorScheme?: TeleBoxColorScheme;
 };
 
-export const callbacks: Emittery<PublicEvent> = new Emittery();
+export type CallbacksType = Emittery<PublicEvent>;
+export const callbacks: CallbacksType = new Emittery();
+
+export const reconnectRefresher = new ReconnectRefresher({ emitter });
 
 export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
     public static kind = "WindowManager";
@@ -177,7 +185,7 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
     public static containerSizeRatio = DEFAULT_CONTAINER_RATIO;
     private static isCreated = false;
 
-    public version = "0.3.18";
+    public version = __APP_VERSION__;
 
     public appListeners?: AppListeners;
 
@@ -188,93 +196,40 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
     public viewMode = ViewMode.Broadcaster;
     public isReplay = isPlayer(this.displayer);
 
+    private boxManager?: BoxManager;
+    private static params?: MountParams;
+
+    private containerResizeObserver?: ContainerResizeObserver;
+
     constructor(context: InvisiblePluginContext) {
         super(context);
+        WindowManager.displayer = context.displayer;
     }
 
-    /**
-     * 挂载 WindowManager
-     * @deprecated
-     */
-    public static async mount(
-        room: Room,
-        container: HTMLElement,
-        collectorContainer?: HTMLElement,
-        options?: {
-            chessboard: boolean;
-            containerSizeRatio: number;
-            collectorStyles?: Partial<CSSStyleDeclaration>;
-            debug?: boolean;
-            overwriteStyles?: string;
-        }
-    ): Promise<WindowManager>;
-
-    public static async mount(params: MountParams): Promise<WindowManager>;
-
-    public static async mount(
-        params: MountParams | Room,
-        container?: HTMLElement,
-        collectorContainer?: HTMLElement,
-        options?: {
-            chessboard?: boolean;
-            containerSizeRatio: number;
-            collectorStyles?: Partial<CSSStyleDeclaration>;
-            debug?: boolean;
-            overwriteStyles?: string;
-            disableCameraTransform?: boolean;
-        }
-    ): Promise<WindowManager> {
-        let room: Room;
-        let containerSizeRatio: number | undefined;
-        let collectorStyles: Partial<CSSStyleDeclaration> | undefined;
-        let debug: boolean | undefined;
-        let chessboard = true;
-        let overwriteStyles: string | undefined;
-        let cursor: boolean | undefined;
-        let disableCameraTransform = false;
-        let prefersColorScheme: TeleBoxColorScheme | undefined = "light";
-        if ("room" in params) {
-            room = params.room;
-            container = params.container;
-            collectorContainer = params.collectorContainer;
-            containerSizeRatio = params.containerSizeRatio;
-            collectorStyles = params.collectorStyles;
-            debug = params.debug;
-            if (params.chessboard != null) {
-                chessboard = params.chessboard;
-            }
-            overwriteStyles = params.overwriteStyles;
-            cursor = params.cursor;
-            disableCameraTransform = Boolean(params?.disableCameraTransform);
-            prefersColorScheme = params.prefersColorScheme;
-        } else {
-            room = params;
-            containerSizeRatio = options?.containerSizeRatio;
-            collectorStyles = options?.collectorStyles;
-            debug = options?.debug;
-            if (options?.chessboard != null) {
-                chessboard = options.chessboard;
-            }
-            overwriteStyles = options?.overwriteStyles;
-        }
+    public static async mount(params: MountParams): Promise<WindowManager> {
+        const room = params.room;
+        WindowManager.container = params.container;
+        const containerSizeRatio = params.containerSizeRatio;
+        const debug = params.debug;
+
+        const cursor = params.cursor;
+        WindowManager.params = params;
 
         this.checkVersion();
         if (isRoom(room)) {
             if (room.phase !== RoomPhase.Connected) {
                 throw new Error("[WindowManager]: Room only Connected can be mount");
             }
-        }
-        if (!container) {
-            throw new Error("[WindowManager]: Container must provide");
+            if (room.phase === RoomPhase.Connected) {
+                // redo undo 需要设置这个属性
+                room.disableSerialization = false;
+            }
         }
         if (WindowManager.isCreated) {
             throw new Error("[WindowManager]: Already created cannot be created again");
         }
         let manager = await this.initManager(room);
         this.debug = Boolean(debug);
-        if (this.debug) {
-            setOptions({ verbose: true });
-        }
         log("Already insert room", manager);
 
         if (isRoom(this.displayer)) {
@@ -297,29 +252,19 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
         if (containerSizeRatio) {
             WindowManager.containerSizeRatio = containerSizeRatio;
         }
-        WindowManager.container = container;
-        const { playground, wrapper, sizer, mainViewElement } = setupWrapper(container);
-        WindowManager.playground = playground;
-        if (chessboard) {
-            sizer.classList.add("netless-window-manager-chess-sizer");
-        }
-        if (overwriteStyles) {
-            const style = document.createElement("style");
-            style.textContent = overwriteStyles;
-            playground.appendChild(style);
-        }
         await manager.ensureAttributes();
-        manager.appManager = new AppManager(manager, {
-            collectorContainer: collectorContainer,
-            collectorStyles: collectorStyles,
-            prefersColorScheme: prefersColorScheme,
-        });
-        manager.observePlaygroundSize(playground, sizer, wrapper);
+
+        manager.appManager = new AppManager(manager);
+
         if (cursor) {
             manager.cursorManager = new CursorManager(manager.appManager);
         }
-        manager.bindMainView(mainViewElement, disableCameraTransform);
-        replaceRoomFunction(room, manager.appManager);
+
+        if (params.container) {
+            manager.bindContainer(params.container);
+        }
+
+        replaceRoomFunction(room, manager);
         emitter.emit("onCreated");
         WindowManager.isCreated = true;
         try {
@@ -359,6 +304,79 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
         return manager;
     }
 
+    private static initContainer(
+        manager: WindowManager,
+        container: HTMLElement,
+        chessboard: boolean | undefined,
+        overwriteStyles: string | undefined
+    ) {
+        if (!WindowManager.container) {
+            WindowManager.container = container;
+        }
+        const { playground, wrapper, sizer, mainViewElement } = setupWrapper(container);
+        WindowManager.playground = playground;
+        if (chessboard) {
+            sizer.classList.add("netless-window-manager-chess-sizer");
+        }
+        if (overwriteStyles) {
+            const style = document.createElement("style");
+            style.textContent = overwriteStyles;
+            playground.appendChild(style);
+        }
+        manager.containerResizeObserver = ContainerResizeObserver.create(
+            playground,
+            sizer,
+            wrapper,
+            emitter
+        );
+        WindowManager.wrapper = wrapper;
+        return mainViewElement;
+    }
+
+    public bindContainer(container: HTMLElement) {
+        if (WindowManager.isCreated && WindowManager.container) {
+            if (WindowManager.container.firstChild) {
+                container.appendChild(WindowManager.container.firstChild);
+            }
+        } else {
+            if (WindowManager.params) {
+                const params = WindowManager.params;
+                const mainViewElement = WindowManager.initContainer(
+                    this,
+                    container,
+                    params.chessboard,
+                    params.overwriteStyles
+                );
+                const boxManager = createBoxManager(this, callbacks, emitter, {
+                    collectorContainer: params.collectorContainer,
+                    collectorStyles: params.collectorStyles,
+                    prefersColorScheme: params.prefersColorScheme,
+                });
+                this.boxManager = boxManager;
+                this.appManager?.setBoxManager(boxManager);
+                this.bindMainView(mainViewElement, params.disableCameraTransform);
+                if (WindowManager.wrapper) {
+                    this.cursorManager?.setupWrapper(WindowManager.wrapper);
+                }
+            }
+        }
+        this.boxManager?.updateManagerRect();
+        this.appManager?.refresh();
+        this.appManager?.resetMaximized();
+        this.appManager?.resetMinimized();
+        WindowManager.container = container;
+    }
+
+    public bindCollectorContainer(container: HTMLElement) {
+        if (WindowManager.isCreated && this.boxManager) {
+            this.boxManager.setCollectorContainer(container);
+        } else {
+            if (WindowManager.params) {
+                WindowManager.params.collectorContainer = container;
+            }
+        }
+    }
+
     /**
      * 注册插件
      */
@@ -371,7 +389,7 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
     /**
      * 创建一个 app 至白板
      */
-    public async addApp(params: AddAppParams): Promise<string | undefined> {
+    public async addApp<T = any>(params: AddAppParams<T>): Promise<string | undefined> {
         if (this.appManager) {
             if (!params.kind || typeof params.kind !== "string") {
                 throw new ParamsInvalidError();
@@ -468,10 +486,8 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
      * 设置所有 app 的 readonly 模式
      */
     public setReadonly(readonly: boolean): void {
-        if (this.room?.isWritable) {
-            this.readonly = readonly;
-            this.appManager?.boxManager.setReadonly(readonly);
-        }
+        this.readonly = readonly;
+        this.boxManager?.setReadonly(readonly);
     }
 
     /**
@@ -531,26 +547,30 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
         return this.appManager?.store.apps();
     }
 
-    public get boxState(): TeleBoxState {
+    public get boxState(): TeleBoxState | undefined {
         if (this.appManager) {
-            return this.appManager.boxManager.boxState;
+            return this.appManager.boxManager?.boxState;
         } else {
             throw new AppManagerNotInitError();
         }
     }
 
     public get darkMode(): boolean {
-        return Boolean(this.appManager?.boxManager.darkMode);
+        return Boolean(this.appManager?.boxManager?.darkMode);
     }
 
-    public get prefersColorScheme(): TeleBoxColorScheme {
+    public get prefersColorScheme(): TeleBoxColorScheme | undefined {
         if (this.appManager) {
-            return this.appManager.boxManager.prefersColorScheme;
+            return this.appManager.boxManager?.prefersColorScheme;
         } else {
             throw new AppManagerNotInitError();
         }
     }
 
+    public get focused(): string | undefined {
+        return this.attributes.focus;
+    }
+
     /**
      * 查询所有的 App
      */
@@ -585,6 +605,10 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
             }>
     ): void {
         this.mainView.moveCameraToContain(rectangle);
+        this.appManager?.dispatchInternalEvent(Events.MoveCameraToContain, rectangle);
+        setTimeout(() => {
+            this.appManager?.mainViewProxy.setCameraAndSize();
+        }, 1000);
     }
 
     public convertToPointInWorld(point: Point): Point {
@@ -613,12 +637,13 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
         if (WindowManager.playground) {
             WindowManager.playground.parentNode?.removeChild(WindowManager.playground);
         }
+        WindowManager.params = undefined;
         log("Destroyed");
     }
 
-    private bindMainView(divElement: HTMLDivElement, disableCameraTransform: boolean) {
+    private bindMainView(divElement: HTMLDivElement, disableCameraTransform: boolean | undefined) {
         if (this.appManager) {
-            this.appManager.bindMainView(divElement, disableCameraTransform);
+            this.appManager.bindMainView(divElement, Boolean(disableCameraTransform));
             this.cursorManager?.setMainViewDivElement(divElement);
         }
     }
@@ -651,7 +676,7 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
     }
 
     public setPrefersColorScheme(scheme: TeleBoxColorScheme): void {
-        this.appManager?.boxManager.setPrefersColorScheme(scheme);
+        this.appManager?.boxManager?.setPrefersColorScheme(scheme);
     }
 
     private isDynamicPPT(scenes: SceneDefinition[]) {
@@ -686,62 +711,10 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
             }
         }
     }
-
-    private containerResizeObserver?: ResizeObserver;
-
-    private observePlaygroundSize(
-        container: HTMLElement,
-        sizer: HTMLElement,
-        wrapper: HTMLDivElement
-    ) {
-        this.updateSizer(container.getBoundingClientRect(), sizer, wrapper);
-
-        this.containerResizeObserver = new ResizeObserver(entries => {
-            const containerRect = entries[0]?.contentRect;
-            if (containerRect) {
-                this.updateSizer(containerRect, sizer, wrapper);
-                this.cursorManager?.updateContainerRect();
-                this.appManager?.boxManager.updateManagerRect();
-                emitter.emit("playgroundSizeChange", containerRect);
-            }
-        });
-
-        this.containerResizeObserver.observe(container);
-    }
-
-    private updateSizer(
-        { width, height }: DOMRectReadOnly,
-        sizer: HTMLElement,
-        wrapper: HTMLDivElement
-    ) {
-        if (width && height) {
-            if (height / width > WindowManager.containerSizeRatio) {
-                height = width * WindowManager.containerSizeRatio;
-                sizer.classList.toggle("netless-window-manager-sizer-horizontal", true);
-            } else {
-                width = height / WindowManager.containerSizeRatio;
-                sizer.classList.toggle("netless-window-manager-sizer-horizontal", false);
-            }
-            wrapper.style.width = `${width}px`;
-            wrapper.style.height = `${height}px`;
-        }
-    }
 }
 
-WindowManager.register({
-    kind: AppDocsViewer.kind,
-    src: AppDocsViewer,
-});
-WindowManager.register({
-    kind: AppMediaPlayer.kind,
-    src: AppMediaPlayer,
-});
-
-export const BuiltinApps = {
-    DocsViewer: AppDocsViewer.kind as string,
-    MediaPlayer: AppMediaPlayer.kind as string,
-};
+setupBuiltin();
 
 export * from "./typings";
 
-export { WhiteWindowSDK } from "./sdk";
+export { BuiltinApps } from "./BuiltinApps";

package/src/shim.d.ts

@@ -4,3 +4,7 @@ declare module "*.svelte" {
     const app: SvelteComponent;
     export default app;
 }
+
+declare global {
+    const __APP_VERSION__: string;
+  }

package/src/style.css

@@ -115,7 +115,7 @@
     flex-direction: column;
     align-items: center;
     justify-content: center;
-    position: fixed;
+    position: absolute;
     width: 26px;
     height: 26px;
     z-index: 2147483647;
@@ -167,3 +167,9 @@
     display: flex;
     justify-content: center;
 }
+
+.telebox-collector {
+    position: absolute;
+    right: 10px;
+    bottom: 15px;
+}

package/src/typings.ts

@@ -12,7 +12,7 @@ import type {
 import type { AppContext } from "./AppContext";
 import type { ReadonlyTeleBox, TeleBoxRect } from "@netless/telebox-insider";
 
-export interface NetlessApp<Attributes = any, SetupResult = any, AppOptions = any> {
+export interface NetlessApp<Attributes = any, MagixEventPayloads = any, AppOptions = any, SetupResult = any> {
     kind: string;
     config?: {
         /** Box width relative to whiteboard. 0~1. Default 0.5. */
@@ -28,7 +28,7 @@ export interface NetlessApp<Attributes = any, SetupResult = any, AppOptions = an
         /** App only single instance. */
         singleton?: boolean;
     };
-    setup: (context: AppContext<Attributes, AppOptions>) => SetupResult;
+    setup: (context: AppContext<Attributes, MagixEventPayloads, AppOptions>) => SetupResult;
 }
 
 export type AppEmitterEvent<T = any> = {
@@ -76,3 +76,4 @@ export type AppListenerKeys = keyof AppEmitterEvent;
 export type { AppContext } from "./AppContext";
 export type { ReadonlyTeleBox, TeleBoxRect };
 export type { SceneState, SceneDefinition, View, AnimationMode, Displayer, Room, Player };
+export type { Storage, StorageStateChangedEvent, StorageStateChangedListener } from "./App/Storage";

package/vite.config.js

@@ -1,13 +1,16 @@
 import path from "path";
 import { defineConfig } from "vite";
 import { svelte } from "@sveltejs/vite-plugin-svelte";
-import { dependencies ,peerDependencies } from "./package.json"
+import { dependencies ,peerDependencies, version } from "./package.json"
 
 
 export default defineConfig(({ mode }) => {
     const isProd = mode === "production";
 
     return {
+        define: {
+            __APP_VERSION__: JSON.stringify(version),
+        },
         plugins: [
             svelte({
                 emitCss: false,

package/dist/Utils/CameraStore.d.ts

@@ -1,15 +0,0 @@
-import type { Camera, View } from "white-web-sdk";
-export declare class CameraStore {
-    private cameras;
-    private listeners;
-    setCamera(id: string, camera: Camera): void;
-    getCamera(id: string): Camera | undefined;
-    deleteCamera(id: string): void;
-    recoverCamera(id: string, view?: View): void;
-    register(id: string, view: View): void;
-    unregister(id: string, view?: View): void;
-    private onListener;
-    private offListener;
-    switchView(id: string, view: View | undefined, callback: () => void): Promise<void>;
-    private getOrCreateListener;
-}

package/dist/ViewManager.d.ts

@@ -1,29 +0,0 @@
-import { Base } from "./Base";
-import type { View, Displayer } from "white-web-sdk";
-import type { AppManager } from "./AppManager";
-export declare class ViewManager extends Base {
-    private views;
-    private timer?;
-    private appTimer?;
-    private mainViewProxy;
-    private displayer;
-    constructor(manager: AppManager);
-    get currentScenePath(): string;
-    get mainView(): View;
-    createView(appId: string): View;
-    destroyView(appId: string): void;
-    private releaseView;
-    getView(appId: string): View | undefined;
-    switchMainViewToWriter(): Promise<boolean> | undefined;
-    freedomAllViews(): void;
-    switchAppToWriter(id: string): void;
-    destroy(): void;
-}
-export declare const createView: (displayer: Displayer) => View;
-export declare const setDefaultCameraBound: (view: View) => void;
-export declare const setupWrapper: (root: HTMLElement) => {
-    playground: HTMLDivElement;
-    wrapper: HTMLDivElement;
-    sizer: HTMLDivElement;
-    mainViewElement: HTMLDivElement;
-};

package/dist/sdk.d.ts

@@ -1,14 +0,0 @@
-import { WindowManager } from './index';
-import type { MountParams } from "./index";
-import type { WhiteWebSdkConfiguration, JoinRoomParams } from "white-web-sdk";
-declare type WhiteWindowSDKConfiguration = Omit<WhiteWebSdkConfiguration, "useMobXState">;
-declare type WindowJoinRoomParams = {
-    joinRoomParams: Omit<JoinRoomParams, "useMultiViews" | "disableMagixEventDispatchLimit">;
-    mountParams: Omit<MountParams, "room">;
-};
-export declare class WhiteWindowSDK {
-    private sdk;
-    constructor(params: WhiteWindowSDKConfiguration);
-    mount(params: WindowJoinRoomParams): Promise<WindowManager>;
-}
-export {};