@netless/app-slide 0.0.27 → 0.0.28

package/dist/utils/freezer.d.ts

@@ -0,0 +1,21 @@
+import type { RegisterParams } from "@netless/window-manager";
+export interface FreezableSlide {
+    freeze: () => void;
+    unfreeze: () => void;
+}
+export declare const FreezerLength = 2;
+export declare const apps: {
+    map: Map<string, FreezableSlide>;
+    queue: string[];
+    validateQueue(): void;
+    set(appId: string, slide: FreezableSlide): void;
+    delete(appId: string): void;
+    focus(appId: string): void;
+};
+export declare type AddHooks = NonNullable<RegisterParams["addHooks"]>;
+/**
+ * Put this function in your register code:
+ * `WindowManager.register({ addHooks })`
+ * So that it will automatically freeze the app when it is not in focus.
+ */
+export declare const addHooks: AddHooks;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netless/app-slide",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "main": "dist/main.cjs.js",
   "module": "dist/main.es.js",
   "types": "dist/index.d.ts",
@@ -11,7 +11,7 @@
   ],
   "devDependencies": {
     "@netless/app-shared": "^0.1.1",
-    "@netless/slide": "^0.1.32",
+    "@netless/slide": "^0.1.33",
     "@types/color-string": "^1.5.0",
     "color-string": "^1.6.0",
     "side-effect-manager": "^0.1.5",

package/src/SlideController/index.ts

@@ -76,6 +76,16 @@ export class SlideController {
     this.initialize();
   }
 
+  public ready = false;
+  private resolveReady!: () => void;
+  public readonly readyPromise = new Promise<void>(resolve => {
+    this.resolveReady = () =>
+      setTimeout(() => {
+        this.ready = true;
+        resolve();
+      }, 1000);
+  });
+
   public jumpToPage(page: number) {
     if (this.ready) {
       page = clamp(page, 1, this.pageCount);
@@ -150,6 +160,8 @@ export class SlideController {
     slide.on(SLIDE_EVENTS.renderError, this.onError);
     slide.on(SLIDE_EVENTS.stateChange, this.onStateChange);
     slide.on(SLIDE_EVENTS.syncDispatch, this.onSyncDispatch);
+
+    slide.on(SLIDE_EVENTS.renderEnd, this.resolveReady);
   }
 
   private onSyncDispatch = (event: SyncEvent) => {
@@ -204,15 +216,14 @@ export class SlideController {
     }
   };
 
-  private resolveReady!: () => void;
-  public readonly readyPromise = new Promise<void>(resolve => {
-    this.resolveReady = resolve;
-  });
-
   private pollCount = 0;
   private pollReadyState = () => {
     if (this.ready) {
-      this.resolveReady();
+      if (this._toFreeze === 1) {
+        this.freeze();
+      } else if (this._toFreeze === -1) {
+        this.unfreeze();
+      }
     } else if (this.pollCount < MaxPollCount) {
       this.pollCount++;
       setTimeout(this.pollReadyState, 500);
@@ -225,12 +236,13 @@ export class SlideController {
     }
   };
 
-  public get ready() {
-    return this.slide.slideCount > 0;
-  }
-
+  // cache `slideCount`, because once the slide is frozen,
+  // the `slideCount` will be 0
+  private _pageCount = 0;
   public get pageCount() {
-    return this.slide.slideCount;
+    if (this._pageCount > 0) return this._pageCount;
+    this._pageCount = this.slide.slideCount;
+    return this._pageCount;
   }
 
   public get page() {
@@ -283,4 +295,56 @@ export class SlideController {
       return Date.now();
     }
   };
+
+  public isFrozen = false;
+  private _toFreeze: -1 | 0 | 1 = 0; // -1: unfreeze, 0: no change, 1: freeze
+  private freezePromise: Promise<void> | null = null;
+
+  private afterFreeze(from: -1 | 1) {
+    if (from === 1) {
+      this.isFrozen = true;
+      this.freezePromise = null;
+      if (this._toFreeze === -1) {
+        this.unfreeze();
+      }
+    } else if (from === -1) {
+      this.isFrozen = false;
+      this.freezePromise = null;
+      if (this._toFreeze === 1) {
+        this.freeze();
+      }
+    }
+  }
+
+  public freeze = () => {
+    if (this.ready) {
+      if (this.debug) {
+        console.log("[Slide] freeze", this.context.appId);
+      }
+      if (this.freezePromise) {
+        this._toFreeze = 1;
+      } else if (!this.isFrozen) {
+        this._toFreeze = 0;
+        this.freezePromise = this.slide.frozen().then(this.afterFreeze.bind(this, 1));
+      }
+    } else {
+      this._toFreeze = 1;
+    }
+  };
+
+  public unfreeze = async () => {
+    if (this.ready) {
+      if (this.debug) {
+        console.log("[Slide] unfreeze", this.context.appId);
+      }
+      if (this.freezePromise) {
+        this._toFreeze = -1;
+      } else if (this.isFrozen) {
+        this._toFreeze = 0;
+        this.freezePromise = this.slide.release().then(this.afterFreeze.bind(this, -1));
+      }
+    } else {
+      this._toFreeze = -1;
+    }
+  };
 }

package/src/SlideDocsViewer/index.ts

@@ -161,17 +161,19 @@ export class SlideDocsViewer {
   protected scaleDocsToFit = () => {
     if (this.slideController) {
       const { width, height } = this.slideController.slide;
-      this.whiteboardView.moveCameraToContain({
-        originX: -width / 2,
-        originY: -height / 2,
-        width,
-        height,
-        animationMode: "immediately" as AnimationMode.Immediately,
-      });
-      if (!this.isViewMounted && width && height) {
-        this.isViewMounted = true;
-        console.log("[Slide] mount whiteboard view");
-        this.mountWhiteboard(this.$whiteboardView);
+      if (width && height) {
+        this.whiteboardView.moveCameraToContain({
+          originX: -width / 2,
+          originY: -height / 2,
+          width,
+          height,
+          animationMode: "immediately" as AnimationMode.Immediately,
+        });
+        if (!this.isViewMounted) {
+          this.isViewMounted = true;
+          console.log("[Slide] mount whiteboard view");
+          this.mountWhiteboard(this.$whiteboardView);
+        }
       }
     }
   };

package/src/SlideDocsViewer/style.scss

@@ -6,6 +6,6 @@ $namespace: "netless-app-slide";
   left: 0;
   width: 100%;
   height: 100%;
-  z-index: 100;
+  z-index: 1001;
   overflow: hidden;
 }

package/src/index.ts

@@ -2,6 +2,7 @@ import type { NetlessApp } from "@netless/window-manager";
 import type { RoomState } from "white-web-sdk";
 import type { MountSlideOptions } from "./SlideDocsViewer";
 import type { Attributes } from "./typings";
+import type { AddHooks, FreezableSlide } from "./utils/freezer";
 
 import { SideEffectManager } from "side-effect-manager";
 import { ensureAttributes } from "@netless/app-shared";
@@ -12,11 +13,12 @@ import {
   SlideController,
 } from "./SlideController";
 import { SlideDocsViewer } from "./SlideDocsViewer";
+import { apps, FreezerLength, addHooks } from "./utils/freezer";
 import styles from "./style.scss?inline";
 
-export type { Attributes };
+export type { Attributes, AddHooks, FreezableSlide };
 
-export { DefaultUrl };
+export { DefaultUrl, apps, FreezerLength, addHooks };
 
 const SlideApp: NetlessApp<Attributes> = {
   kind: "Slide",
@@ -48,6 +50,9 @@ const SlideApp: NetlessApp<Attributes> = {
       const room = context.getRoom();
       if (docsViewer && docsViewer.slideController && room && context.getIsWritable()) {
         syncSceneWithSlide(room, context, docsViewer.slideController.slide, baseScenePath);
+        if (context.getAppOptions()?.debug || import.meta.env.DEV) {
+          console.log("[Slide] page to", page);
+        }
         docsViewer.viewer.setPageIndex(page - 1);
       }
     };
@@ -58,6 +63,7 @@ const SlideApp: NetlessApp<Attributes> = {
         ...options,
         onPageChanged,
       });
+      apps.set(context.appId, slideController);
       if (import.meta.env.DEV) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         (window as any).slideController = slideController;
@@ -95,6 +101,7 @@ const SlideApp: NetlessApp<Attributes> = {
 
     context.emitter.on("destroy", () => {
       console.log("[Slide]: destroy");
+      apps.delete(context.appId);
       sideEffect.flushAll();
       if (docsViewer) {
         docsViewer.destroy();

package/src/utils/freezer.ts

@@ -0,0 +1,78 @@
+import type { RegisterParams } from "@netless/window-manager";
+
+export interface FreezableSlide {
+  freeze: () => void;
+  unfreeze: () => void;
+}
+
+export const FreezerLength = 2;
+
+export const apps = {
+  map: new Map<string, FreezableSlide>(),
+  queue: [] as string[],
+  validateQueue() {
+    if (import.meta.env.DEV) {
+      console.log("[Slide] freezer: validate", this.queue);
+    }
+    while (this.queue.length > FreezerLength) {
+      const appId = this.queue.pop() as string;
+      const slide = this.map.get(appId);
+      if (slide) {
+        if (import.meta.env.DEV) {
+          console.log("[Slide] freezer: validate-freeze", appId, this.queue);
+        }
+        slide.freeze();
+      }
+    }
+  },
+  set(appId: string, slide: FreezableSlide) {
+    if (import.meta.env.DEV) {
+      console.log("[Slide] freezer: add", appId, this.queue);
+    }
+    this.map.set(appId, slide);
+    if (!this.queue.includes(appId)) {
+      this.queue.unshift(appId);
+    }
+    this.validateQueue();
+  },
+  delete(appId: string) {
+    if (import.meta.env.DEV) {
+      console.log("[Slide] freezer: delete", appId, this.queue);
+    }
+    this.map.delete(appId);
+    this.queue = this.queue.filter(id => id !== appId);
+  },
+  focus(appId: string) {
+    const slide = this.map.get(appId);
+    const index = this.queue.indexOf(appId);
+    if (index > -1) {
+      this.queue.splice(index, 1);
+    }
+    this.queue.unshift(appId);
+    this.validateQueue();
+    if (import.meta.env.DEV) {
+      console.log("[Slide] freezer: focus", appId, this.queue);
+    }
+    if (slide) {
+      slide.unfreeze();
+    }
+  },
+};
+
+if (import.meta.env.DEV) {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  (window as any).freezer = apps;
+}
+
+export type AddHooks = NonNullable<RegisterParams["addHooks"]>;
+
+/**
+ * Put this function in your register code:
+ * `WindowManager.register({ addHooks })`
+ * So that it will automatically freeze the app when it is not in focus.
+ */
+export const addHooks: AddHooks = emitter => {
+  emitter.on("focus", ({ appId }) => {
+    apps.focus(appId);
+  });
+};