@netless/fastboard-core 1.1.6 → 1.1.7

package/src/helpers/docs.ts

@@ -1,20 +1,29 @@
-import type { AppResult } from "@netless/app-slide";
 import type { FastboardApp, WindowManager } from "../impl";
 
+export type DocsEvent = "prevPage" | "nextPage" | "prevStep" | "nextStep" | "jumpToPage" | "scalePage";
+
 export interface 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 DocsEventManager = WindowManager & {
+  dispatchDocsEvent?: (event: DocsEvent, options?: DocsEventOptions) => boolean;
+};
+
 /**
- * Send specific command to the static docs / slide app.
- * Only works for apps that were created by `insertDocs()`.
+ * Send specific command to the DocsViewer / Presentation / Slide app.
+ * This is a compatibility wrapper around `WindowManager.dispatchDocsEvent()`.
+ * Works for documents created by `insertDocs()`.
  *
  * Returns false if failed to find the app or not writable.
  *
- * For static docs, `nextPage` equals to `nextStep`, as with `prevPage` and `prevStep`.
+ * For DocsViewer and Presentation, `nextPage` equals to `nextStep`, as with
+ * `prevPage` and `prevStep`.
  *
  * @example
  * ```js
@@ -27,91 +36,14 @@ export interface DocsEventOptions {
  */
 export function dispatchDocsEvent(
   fastboard: FastboardApp | WindowManager,
-  event: "prevPage" | "nextPage" | "prevStep" | "nextStep" | "jumpToPage",
+  event: DocsEvent,
   options: DocsEventOptions = {}
 ): boolean {
   const manager = "manager" in fastboard ? fastboard.manager : fastboard;
-
-  const appId = options.appId || manager.focused;
-  if (!appId) {
-    console.warn("not found " + (options.appId || "focused app"));
-    return false;
-  }
-
-  let page: number | undefined, input: HTMLInputElement | null;
-
-  // Click the DOM elements for static docs
-  if (appId.startsWith("DocsViewer-")) {
-    const dom = manager.queryOne(appId)?.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;
-      default:
-        console.warn("unknown event " + event);
-        return false;
-    }
-
-    return true;
-  }
-
-  // Check controller for slide docs
-  else if (appId.startsWith("Slide-")) {
-    const app = manager.queryOne(appId)?.appResult as unknown as AppResult | undefined;
-    if (!app) {
-      console.warn("not found app with id " + appId);
-      return false;
-    }
-
-    switch (event) {
-      case "prevPage":
-        return app.prevPage();
-      case "nextPage":
-        return app.nextPage();
-      case "prevStep":
-        return app.prevStep();
-      case "nextStep":
-        return app.nextStep();
-      case "jumpToPage":
-        page = options.page;
-        if (typeof page !== "number") {
-          console.warn("failed to jump" + (page ? " to page " + page : ""));
-          return false;
-        }
-        return app.jumpToPage(page);
-      default:
-        console.warn("unknown event " + event);
-        return false;
-    }
-  }
-
-  // No support for any other kind
-  else {
-    console.warn("not supported app " + appId);
+  const dispatchDocsEvent = (manager as DocsEventManager).dispatchDocsEvent;
+  if (!dispatchDocsEvent) {
+    console.warn("window manager does not support dispatchDocsEvent");
     return false;
   }
+  return dispatchDocsEvent.call(manager, event, options);
 }

package/src/impl/FastboardApp.ts

@@ -208,6 +208,11 @@ export interface InsertDocsDynamic {
 
 export type InsertDocsParams = InsertDocsStatic | InsertDocsDynamic;
 
+export interface InsertDocsOptions {
+  /** Renderer for static documents. Dynamic documents always use Slide. @default "docsViewer" */
+  readonly staticRenderer?: "docsViewer" | "presentation";
+}
+
 export interface ProjectorResponse {
   uuid: string;
   status: "Waiting" | "Converting" | "Finished" | "Fail";
@@ -602,13 +607,21 @@ export class FastboardApp<TEventData extends Record<string, any> = any> extends
    * Insert PDF/PPTX from conversion result.
    * @param status https://developer.netless.link/server-en/home/server-conversion#get-query-task-conversion-progress
    */
-  insertDocs(filename: string, status: ConversionResponse): Promise<string | undefined>;
+  insertDocs(
+    filename: string,
+    status: ConversionResponse,
+    options?: InsertDocsOptions
+  ): Promise<string | undefined>;
 
   /**
    * Insert PDF/PPTX from projector conversion result.
    * @param response https://developer.netless.link/server-zh/home/server-projector#get-%E6%9F%A5%E8%AF%A2%E4%BB%BB%E5%8A%A1%E8%BD%AC%E6%8D%A2%E8%BF%9B%E5%BA%A6
    */
-  insertDocs(filename: string, response: ProjectorResponse): Promise<string | undefined>;
+  insertDocs(
+    filename: string,
+    response: ProjectorResponse,
+    options?: InsertDocsOptions
+  ): Promise<string | undefined>;
 
   /**
    * Manual way.
@@ -620,12 +633,27 @@ export class FastboardApp<TEventData extends Record<string, any> = any> extends
    *   title: 'Title',
    * })
    */
-  insertDocs(params: InsertDocsParams): Promise<string | undefined>;
+  insertDocs(params: InsertDocsParams, options?: InsertDocsOptions): Promise<string | undefined>;
 
-  insertDocs(arg1: string | InsertDocsParams, arg2?: ConversionResponse | ProjectorResponse) {
+  insertDocs(
+    arg1: string | InsertDocsParams,
+    arg2?: ConversionResponse | ProjectorResponse | InsertDocsOptions,
+    arg3?: InsertDocsOptions
+  ) {
+    const response = typeof arg1 === "string" ? (arg2 as ConversionResponse | ProjectorResponse) : undefined;
+    const options = typeof arg1 === "string" ? arg3 : (arg2 as InsertDocsOptions | undefined);
+    const staticAppKind = options?.staticRenderer === "presentation" ? "Presentation" : "DocsViewer";
+    return this._insertDocs(arg1, response, staticAppKind);
+  }
+
+  private _insertDocs(
+    arg1: string | InsertDocsParams,
+    arg2: ConversionResponse | ProjectorResponse | undefined,
+    staticAppKind: "DocsViewer" | "Presentation"
+  ) {
     this._assertNotDestroyed();
     if (typeof arg1 === "object" && "fileType" in arg1) {
-      return this._insertDocsImpl(arg1);
+      return this._insertDocsImpl(arg1, staticAppKind);
     } else if (arg2 && arg2.status !== "Finished") {
       throw new Error("FastboardApp cannot insert a converting doc.");
     } else if (arg2 && "progress" in arg2) {
@@ -634,9 +662,12 @@ export class FastboardApp<TEventData extends Record<string, any> = any> extends
       const scenes1 = arg2.progress.convertedFileList.map(convertedFileToScene);
       const { scenes, taskId, url } = makeSlideParams(scenes1);
       if (taskId && url) {
-        return this._insertDocsImpl({ fileType: "pptx", scenePath, scenes, title, taskId, url });
+        return this._insertDocsImpl(
+          { fileType: "pptx", scenePath, scenes, title, taskId, url },
+          staticAppKind
+        );
       } else {
-        return this._insertDocsImpl({ fileType: "pdf", scenePath, scenes: scenes1, title });
+        return this._insertDocsImpl({ fileType: "pdf", scenePath, scenes: scenes1, title }, staticAppKind);
       }
     } else if (arg2 && arg2.images) {
       const title = arg1;
@@ -646,25 +677,28 @@ export class FastboardApp<TEventData extends Record<string, any> = any> extends
         const { width, height, url } = arg2.images[name];
         scenes.push({ name, ppt: { width, height, src: url } });
       }
-      return this._insertDocsImpl({ fileType: "pdf", scenePath, scenes, title });
+      return this._insertDocsImpl({ fileType: "pdf", scenePath, scenes, title }, staticAppKind);
     } else if (arg2 && arg2.prefix) {
       const title = arg1;
       const scenePath = `/${arg2.uuid}/${genUID()}`;
       const taskId = arg2.uuid;
       const url = arg2.prefix;
-      this._insertDocsImpl({ fileType: "pptx", scenePath, taskId, title, url });
+      return this._insertDocsImpl({ fileType: "pptx", scenePath, taskId, title, url }, staticAppKind);
     } else {
       throw new Error("Invalid input: not found 'progress', 'prefix' nor 'images'");
     }
   }
 
   /** @internal */
-  private _insertDocsImpl({ fileType, scenePath, title, scenes, ...attributes }: InsertDocsParams) {
+  private _insertDocsImpl(
+    { fileType, scenePath, title, scenes, ...attributes }: InsertDocsParams,
+    staticAppKind: "DocsViewer" | "Presentation"
+  ) {
     this._assertNotDestroyed();
     switch (fileType) {
       case "pdf":
         return this.manager.addApp({
-          kind: "DocsViewer",
+          kind: staticAppKind,
           options: { scenePath, title, scenes },
         });
       case "pptx":
@@ -794,7 +828,7 @@ export async function createFastboard<TEventData extends Record<string, any> = a
     _AppInMainViewPlugin = AppInMainViewPlugin;
     joinRoomParamsWithPlugin.invisiblePlugins = [
       ...joinRoomParamsWithPlugin.invisiblePlugins,
-      _AppInMainViewPlugin,
+      AppInMainViewPlugin,
     ];
   }
 

package/src/impl/FastboardPlayer.ts

@@ -269,7 +269,7 @@ export async function replayFastboard<TEventData extends Record<string, any> = a
     _AppInMainViewPlugin = AppInMainViewPlugin;
     replayRoomParamsWithPlugin.invisiblePlugins = [
       ...replayRoomParamsWithPlugin.invisiblePlugins,
-      _AppInMainViewPlugin,
+      AppInMainViewPlugin,
     ];
   }
 

package/src/impl/bridge-runtime.ts

@@ -1,12 +1,13 @@
-import type { WindowManager } from "@netless/window-manager";
+import type { ExtendPlugin, WindowManager } from "@netless/window-manager";
+import type { autorun, toJS } from "white-web-sdk";
 
 export interface FastboardBridgeRuntime {
   whiteWebSdk: {
-    autorun: typeof import("white-web-sdk").autorun;
-    toJS: typeof import("white-web-sdk").toJS;
+    autorun: typeof autorun;
+    toJS: typeof toJS;
   };
   windowManager: {
-    ExtendPlugin: typeof import("@netless/window-manager").ExtendPlugin;
+    ExtendPlugin: typeof ExtendPlugin;
   };
 }