@netless/window-manager 1.0.14 → 1.0.16

package/src/index.ts

@@ -16,7 +16,8 @@ import { ArgusLog, log } from "./Utils/log";
 import { PageStateImpl } from "./PageState";
 import { ReconnectRefresher } from "./ReconnectRefresher";
 import { replaceRoomFunction } from "./Utils/RoomHacker";
-import { setupBuiltin } from "./BuiltinApps";
+import { BuiltinApps, setupBuiltin } from "./BuiltinApps";
+import type { BuiltinAppOptions } from "./BuiltinApps";
 import "video.js/dist/video-js.css";
 import "./style.css";
 import "@netless/telebox-insider/dist/style.css";
@@ -62,11 +63,11 @@ import type Emittery from "emittery";
 import type { PageController, AddPageParams, PageState } from "./Page";
 import { boxEmitter } from "./BoxEmitter";
 import { IframeBridge } from "./View/IframeBridge";
-import { setOptions } from "@netless/app-media-player";
 import type { ExtendPluginInstance } from "./ExtendPluginManager";
 import { ExtendPluginManager } from "./ExtendPluginManager";
 import { getExtendClass } from "./Utils/extendClass";
 import type { ExtendClass } from "./Utils/extendClass";
+import { resolveAppOptions as mergeAppOptions } from "./Utils/resolveAppOptions";
 
 export * from "./utils/extendClass";
 
@@ -90,6 +91,54 @@ export type AddAppOptions = {
 
 export type setAppOptions = AddAppOptions & { appOptions?: any };
 
+export type DocsEvent =
+    | "prevPage"
+    | "nextPage"
+    | "prevStep"
+    | "nextStep"
+    | "jumpToPage"
+    | "scalePage";
+
+export type DocsEventOptions = {
+    /** If provided, will dispatch to the specific app. Default to the focused app. */
+    appId?: string;
+    /** Used by `jumpToPage` event, range from 1 to total pages count. */
+    page?: number;
+    /** Used by `scalePage` event. Range from 1 to 4, decimals allowed. `1` means default fitted size. */
+    scale?: number;
+};
+
+type SlideDocsAppResult = {
+    prevPage: () => boolean;
+    nextPage: () => boolean;
+    prevStep: () => boolean;
+    nextStep: () => boolean;
+    jumpToPage: (page: number) => boolean;
+    scaleView: (scale: number) => void;
+};
+
+type PresentationDocsAppResult = {
+    prevPage: () => boolean;
+    nextPage: () => boolean;
+    jumpPage: (index: number) => boolean;
+    moveCamera: (camera: { centerX: number; centerY: number; scale: number }) => void;
+    getOriginScale: () => number;
+};
+
+const SlideAppKind = "Slide";
+const PresentationAppKind = BuiltinApps.Presentation;
+const MinDocsPageScale = 1;
+const MaxDocsPageScale = 4;
+
+function isValidDocsPageScale(scale: unknown): scale is number {
+    return (
+        typeof scale === "number" &&
+        Number.isFinite(scale) &&
+        scale >= MinDocsPageScale &&
+        scale <= MaxDocsPageScale
+    );
+}
+
 export type AddAppParams<TAttributes = any> = {
     kind: string;
     // app 地址(本地 app 不需要传)
@@ -197,6 +246,8 @@ export type MountParams = {
     supportAppliancePlugin?: boolean;
     /** 是否使用 boxesStatus 状态管理窗口 */
     useBoxesStatus?: boolean;
+    /** Local Presentation options applied before restoring apps. Not synchronized. */
+    builtinAppOptions?: BuiltinAppOptions;
 };
 
 export const reconnectRefresher = new ReconnectRefresher({ emitter: internalEmitter });
@@ -234,6 +285,8 @@ export class WindowManager
 
     public _appliancePlugin?: any;
 
+    public builtinAppOptions?: BuiltinAppOptions;
+
     private boxManager?: BoxManager;
     private static params?: MountParams;
     static extendClass?: ExtendClass;
@@ -255,7 +308,7 @@ export class WindowManager
         super(context);
         WindowManager.displayer = context.displayer;
         (window as any).NETLESS_DEPS = __APP_DEPENDENCIES__;
-        this.emitter.on('mainViewScenePathChange', this.onMainViewScenePathChangeHandler)
+        this.emitter.on("mainViewScenePathChange", this.onMainViewScenePathChangeHandler);
     }
 
     public static onCreate(manager: WindowManager) {
@@ -289,7 +342,11 @@ export class WindowManager
             manager = await this.initManager(room);
             if (manager) {
                 manager._roomLogger = (room as unknown as { logger: Logger }).logger;
-                manager.attributesDeboundceLog = new ArgusLog(manager._roomLogger, "attributes", 300);
+                manager.attributesDeboundceLog = new ArgusLog(
+                    manager._roomLogger,
+                    "attributes",
+                    300
+                );
                 if (WindowManager.registered.size > 0) {
                     manager._roomLogger.info(
                         `[WindowManager] registered apps: ${JSON.stringify(
@@ -304,9 +361,6 @@ export class WindowManager
         }
 
         this.debug = Boolean(debug);
-        if (this.debug) {
-            setOptions({ verbose: true });
-        }
         if (manager?._roomLogger) {
             manager._roomLogger.info(
                 `[WindowManager] Already insert room version: ${manager.version}`
@@ -337,6 +391,8 @@ export class WindowManager
             throw new Error("[WindowManager]: create manager failed");
         }
 
+        manager.builtinAppOptions = params.builtinAppOptions;
+
         if (containerSizeRatio) {
             WindowManager.containerSizeRatio = containerSizeRatio;
         }
@@ -390,27 +446,43 @@ export class WindowManager
             console.warn("[WindowManager]: indexedDB open failed");
             console.log(error);
         }
-        manager.emitter.on('mainViewScenePathChange', manager.onMainViewScenePathChangeHandler)
+        manager.emitter.on("mainViewScenePathChange", manager.onMainViewScenePathChangeHandler);
         return manager;
     }
 
     public onMainViewScenePathChangeHandler = (scenePath: string) => {
         const mainViewElement = this.mainView.divElement;
         if (mainViewElement) {
-            const backgroundImage = mainViewElement.querySelector('.background img');
+            const backgroundImage = mainViewElement.querySelector(".background img");
             if (backgroundImage) {
                 const backgroundImageRect = backgroundImage?.getBoundingClientRect();
                 const backgroundImageCSS = window.getComputedStyle(backgroundImage);
-                const backgroundImageVisible = backgroundImageRect?.width > 0 && backgroundImageRect?.height > 0 && backgroundImageCSS.display !== 'none';
+                const backgroundImageVisible =
+                    backgroundImageRect?.width > 0 &&
+                    backgroundImageRect?.height > 0 &&
+                    backgroundImageCSS.display !== "none";
                 const camera = this.mainView.camera;
-                console.log("[window-manager] backgroundImageVisible:" + backgroundImageVisible + " camera:" + JSON.stringify(camera));
+                console.log(
+                    "[window-manager] backgroundImageVisible:" +
+                        backgroundImageVisible +
+                        " camera:" +
+                        JSON.stringify(camera)
+                );
                 return;
             }
-            console.log("[window-manager] onMainViewScenePathChange scenePath:" + scenePath + ' backgroundImageVisible is not found');
+            console.log(
+                "[window-manager] onMainViewScenePathChange scenePath:" +
+                    scenePath +
+                    " backgroundImageVisible is not found"
+            );
             return;
         }
-        console.log("[window-manager] onMainViewScenePathChange scenePath:" + scenePath + ' mainViewElement is not found');
-    }
+        console.log(
+            "[window-manager] onMainViewScenePathChange scenePath:" +
+                scenePath +
+                " mainViewElement is not found"
+        );
+    };
 
     private static initManager(room: Room): Promise<WindowManager | undefined> {
         return createInvisiblePlugin(room);
@@ -522,6 +594,15 @@ export class WindowManager
         return appRegister.unregister(kind);
     }
 
+    public resolveAppOptions(
+        kind: string,
+        registeredOptions?: any | (() => any)
+    ): any | (() => any) {
+        const override =
+            kind === BuiltinApps.Presentation ? this.builtinAppOptions?.Presentation : undefined;
+        return mergeAppOptions(registeredOptions, override);
+    }
+
     /**
      * 创建一个 app 至白板
      */
@@ -1007,6 +1088,172 @@ export class WindowManager
         return this.appManager?.appProxies.get(appId);
     }
 
+    /**
+     * Send specific command to DocsViewer / Presentation / Slide app.
+     *
+     * Static docs and Presentation do not have animation steps, so `prevStep` / `nextStep`
+     * are treated as `prevPage` / `nextPage`.
+     */
+    public dispatchDocsEvent(event: DocsEvent, options: DocsEventOptions = {}): boolean {
+        const appId = options.appId || this.focused;
+        if (!appId) {
+            console.warn("not found " + (options.appId || "focused app"));
+            return false;
+        }
+
+        const app = this.queryOne(appId);
+        if (!app) {
+            console.warn("not found app with id " + appId);
+            return false;
+        }
+
+        const isDocsViewerApp =
+            appId.startsWith(`${BuiltinApps.DocsViewer}-`) || app.kind === BuiltinApps.DocsViewer;
+        const isPresentationApp =
+            appId.startsWith(`${PresentationAppKind}-`) || app.kind === PresentationAppKind;
+        const isSlideApp = appId.startsWith(`${SlideAppKind}-`) || app.kind === SlideAppKind;
+        let appKind = app.kind;
+        if (isDocsViewerApp) {
+            appKind = BuiltinApps.DocsViewer;
+        } else if (isPresentationApp) {
+            appKind = PresentationAppKind;
+        } else if (isSlideApp) {
+            appKind = SlideAppKind;
+        }
+
+        if (!WindowManager.registered.has(appKind)) {
+            console.warn("not registered app kind " + appKind);
+            return false;
+        }
+
+        let page: number | undefined, input: HTMLInputElement | null, scale: number | undefined;
+
+        if (isDocsViewerApp) {
+            const dom = app.box?.$footer;
+            if (!dom) {
+                console.warn("not found app with id " + appId);
+                return false;
+            }
+
+            const click = (el: Element | null) => {
+                el && el.dispatchEvent(new MouseEvent("click"));
+            };
+
+            switch (event) {
+                case "prevPage":
+                case "prevStep":
+                    click(dom.querySelector('button[class$="btn-page-back"]'));
+                    break;
+                case "nextPage":
+                case "nextStep":
+                    click(dom.querySelector('button[class$="btn-page-next"]'));
+                    break;
+                case "jumpToPage":
+                    page = options.page;
+                    input = dom.querySelector('input[class$="page-number-input"]');
+                    if (!input || typeof page !== "number") {
+                        console.warn("failed to jump" + (page ? " to page " + page : ""));
+                        return false;
+                    }
+                    input.value = "" + page;
+                    input.dispatchEvent(new InputEvent("change"));
+                    break;
+                case "scalePage":
+                    console.warn("not supported event " + event + " for app kind " + appKind);
+                    return false;
+                default:
+                    console.warn("unknown event " + event);
+                    return false;
+            }
+
+            return true;
+        }
+
+        if (isPresentationApp) {
+            const controller = app.appResult as PresentationDocsAppResult | undefined;
+            if (!controller) {
+                console.warn("not found app with id " + appId);
+                return false;
+            }
+
+            switch (event) {
+                case "prevPage":
+                case "prevStep":
+                    return controller.prevPage();
+                case "nextPage":
+                case "nextStep":
+                    return controller.nextPage();
+                case "jumpToPage":
+                    page = options.page;
+                    if (typeof page !== "number") {
+                        console.warn("failed to jump" + (page ? " to page " + page : ""));
+                        return false;
+                    }
+                    return controller.jumpPage(page - 1);
+                case "scalePage":
+                    scale = options.scale;
+                    if (!isValidDocsPageScale(scale)) {
+                        console.warn("failed to scale, scale should be a number from 1 to 4");
+                        return false;
+                    }
+                    try {
+                        controller.moveCamera({
+                            centerX: 0,
+                            centerY: 0,
+                            scale: controller.getOriginScale() * scale,
+                        });
+                        return true;
+                    } catch (error) {
+                        console.warn(error);
+                        return false;
+                    }
+                default:
+                    console.warn("unknown event " + event);
+                    return false;
+            }
+        }
+
+        if (isSlideApp) {
+            const controller = app.appResult as SlideDocsAppResult | undefined;
+            if (!controller) {
+                console.warn("not found app with id " + appId);
+                return false;
+            }
+
+            switch (event) {
+                case "prevPage":
+                    return controller.prevPage();
+                case "nextPage":
+                    return controller.nextPage();
+                case "prevStep":
+                    return controller.prevStep();
+                case "nextStep":
+                    return controller.nextStep();
+                case "jumpToPage":
+                    page = options.page;
+                    if (typeof page !== "number") {
+                        console.warn("failed to jump" + (page ? " to page " + page : ""));
+                        return false;
+                    }
+                    return controller.jumpToPage(page);
+                case "scalePage":
+                    scale = options.scale;
+                    if (!isValidDocsPageScale(scale)) {
+                        console.warn("failed to scale, scale should be a number from 1 to 4");
+                        return false;
+                    }
+                    controller.scaleView(scale);
+                    return true;
+                default:
+                    console.warn("unknown event " + event);
+                    return false;
+            }
+        }
+
+        console.warn("not supported app kind " + app.kind);
+        return false;
+    }
+
     /**
      * 关闭 APP
      */
@@ -1081,7 +1328,7 @@ export class WindowManager
             WindowManager.playground.parentNode?.removeChild(WindowManager.playground);
         }
         WindowManager.params = undefined;
-        this.emitter.off('mainViewScenePathChange', this.onMainViewScenePathChangeHandler);
+        this.emitter.off("mainViewScenePathChange", this.onMainViewScenePathChangeHandler);
         this._iframeBridge?.destroy();
         this._iframeBridge = undefined;
         log("Destroyed");
@@ -1113,7 +1360,10 @@ export class WindowManager
         if (this.canOperate) {
             this.setAttributes(attributes);
             if (this.attributesDeboundceLog) {
-                this.attributesDeboundceLog.logDebouncedShallowMerge("safeSetAttributes", attributes);
+                this.attributesDeboundceLog.logDebouncedShallowMerge(
+                    "safeSetAttributes",
+                    attributes
+                );
             }
         }
     }
@@ -1134,7 +1384,10 @@ export class WindowManager
     public cleanCurrentScene(): void {
         log("clean current scene");
         this.focusedView?.cleanCurrentScene();
-        this.Logger && this.Logger.info(`[WindowManager]: cleanCurrentScene ${this.focusedView?.focusScenePath}`);
+        this.Logger &&
+            this.Logger.info(
+                `[WindowManager]: cleanCurrentScene ${this.focusedView?.focusScenePath}`
+            );
     }
 
     public redo(): number {
@@ -1147,7 +1400,8 @@ export class WindowManager
 
     public delete(): void {
         this.focusedView?.delete();
-        this.Logger && this.Logger.info(`[WindowManager]: delete ${this.focusedView?.focusScenePath}`);
+        this.Logger &&
+            this.Logger.info(`[WindowManager]: delete ${this.focusedView?.focusScenePath}`);
     }
 
     public copy(): void {
@@ -1257,6 +1511,7 @@ setupBuiltin();
 export * from "./typings";
 
 export { BuiltinApps } from "./BuiltinApps";
+export type { BuiltinAppOptions } from "./BuiltinApps";
 export type { PublicEvent } from "./callback";
 
 export * from "./ExtendPluginManager";