@netless/fastboard-core 1.1.5 → 1.1.7

package/dist/index.d.ts

@@ -87,6 +87,10 @@ interface InsertDocsDynamic {
     readonly scenes?: SceneDefinition[];
 }
 type InsertDocsParams = InsertDocsStatic | InsertDocsDynamic;
+interface InsertDocsOptions {
+    /** Renderer for static documents. Dynamic documents always use Slide. @default "docsViewer" */
+    readonly staticRenderer?: "docsViewer" | "presentation";
+}
 interface ProjectorResponse {
     uuid: string;
     status: "Waiting" | "Converting" | "Finished" | "Fail";
@@ -283,12 +287,12 @@ declare 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.
      * @example
@@ -299,7 +303,8 @@ declare 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>;
+    private _insertDocs;
     /**
      * Insert the Media Player app.
      */
@@ -474,19 +479,24 @@ declare function addPlayerListener<K extends keyof PlayerCallbacks>(player: Play
 declare function addViewListener<K extends keyof ViewCallbacks>(view: View, name: K, listener: (value: ViewCallbacks[K]) => void): () => void;
 declare function addManagerListener<K extends keyof PublicEvent>(manager: WindowManager, name: K, listener: (value: PublicEvent[K]) => void): () => void;
 
+type DocsEvent = "prevPage" | "nextPage" | "prevStep" | "nextStep" | "jumpToPage" | "scalePage";
 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;
 }
 /**
- * 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
@@ -497,6 +507,6 @@ interface DocsEventOptions {
  * dispatchDocsEvent(fastboard, "prevPage", {appId:"Slide-1a2b3c4d"})
  * ```
  */
-declare function dispatchDocsEvent(fastboard: FastboardApp | WindowManager, event: "prevPage" | "nextPage" | "prevStep" | "nextStep" | "jumpToPage", options?: DocsEventOptions): boolean;
+declare function dispatchDocsEvent(fastboard: FastboardApp | WindowManager, event: DocsEvent, options?: DocsEventOptions): boolean;
 
-export { Appliance, AppsConfig, AppsStatus, DocsEventOptions, FastboardApp, FastboardOptions, FastboardPlayer, FastboardReplayOptions, InsertDocsDynamic, InsertDocsParams, InsertDocsStatic, PlayerPhase, ProjectorResponse, Readable, RoomPhase, RoomStateChanged, SetMemberStateFn, Shape, StartStopNotifier, Subscriber, Unsubscriber, Updater, Writable, addManagerListener, addPlayerListener, addRoomListener, addViewListener, convertedFileToScene, createFastboard, dispatchDocsEvent, genUID, getImageSize, makeSlideParams, readable, register, replayFastboard, version, warn, writable };
+export { Appliance, AppsConfig, AppsStatus, DocsEvent, DocsEventOptions, FastboardApp, FastboardOptions, FastboardPlayer, FastboardReplayOptions, InsertDocsDynamic, InsertDocsOptions, InsertDocsParams, InsertDocsStatic, PlayerPhase, ProjectorResponse, Readable, RoomPhase, RoomStateChanged, SetMemberStateFn, Shape, StartStopNotifier, Subscriber, Unsubscriber, Updater, Writable, addManagerListener, addPlayerListener, addRoomListener, addViewListener, convertedFileToScene, createFastboard, dispatchDocsEvent, genUID, getImageSize, makeSlideParams, readable, register, replayFastboard, version, warn, writable };

package/dist/index.js

@@ -251,7 +251,7 @@ for (const kind in DefaultApps) {
     windowManager.WindowManager.register(__spreadValues({ kind }, options));
   }
 }
-var version = "1.1.5";
+var version = "1.1.7";
 if (typeof window !== "undefined") {
   let str = window.__netlessUA || "";
   str += ` ${"@netless/fastboard-core"}@${version} `;
@@ -669,10 +669,16 @@ var FastboardApp = class extends FastboardAppBase {
     const originY = centerY - height / 2;
     this.manager.moveCameraToContain({ originX, originY, width, height });
   }
-  insertDocs(arg1, arg2) {
+  insertDocs(arg1, arg2, arg3) {
+    const response = typeof arg1 === "string" ? arg2 : void 0;
+    const options = typeof arg1 === "string" ? arg3 : arg2;
+    const staticAppKind = (options == null ? void 0 : options.staticRenderer) === "presentation" ? "Presentation" : "DocsViewer";
+    return this._insertDocs(arg1, response, staticAppKind);
+  }
+  _insertDocs(arg1, arg2, staticAppKind) {
     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) {
@@ -681,9 +687,12 @@ var FastboardApp = class extends FastboardAppBase {
       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;
@@ -693,25 +702,25 @@ var FastboardApp = class extends FastboardAppBase {
         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 */
-  _insertDocsImpl(_a) {
+  _insertDocsImpl(_a, staticAppKind) {
     var _b = _a, { fileType, scenePath, title, scenes } = _b, attributes = __objRest(_b, ["fileType", "scenePath", "title", "scenes"]);
     this._assertNotDestroyed();
     switch (fileType) {
       case "pdf":
         return this.manager.addApp({
-          kind: "DocsViewer",
+          kind: staticAppKind,
           options: { scenePath, title, scenes }
         });
       case "pptx":
@@ -808,7 +817,7 @@ async function createFastboard(_a) {
     _AppInMainViewPlugin = AppInMainViewPlugin;
     joinRoomParamsWithPlugin.invisiblePlugins = [
       ...joinRoomParamsWithPlugin.invisiblePlugins,
-      _AppInMainViewPlugin
+      AppInMainViewPlugin
     ];
   }
   const sdk = new whiteWebSdk.WhiteWebSdk(__spreadProps(__spreadValues({}, sdkConfig), {
@@ -1082,7 +1091,7 @@ async function replayFastboard(_a) {
     _AppInMainViewPlugin = AppInMainViewPlugin;
     replayRoomParamsWithPlugin.invisiblePlugins = [
       ...replayRoomParamsWithPlugin.invisiblePlugins,
-      _AppInMainViewPlugin
+      AppInMainViewPlugin
     ];
   }
   const sdk = new whiteWebSdk.WhiteWebSdk(__spreadProps(__spreadValues({}, sdkConfig), {
@@ -1160,77 +1169,13 @@ function addManagerListener(manager, name, listener) {
 
 // src/helpers/docs.ts
 function dispatchDocsEvent(fastboard, event, options = {}) {
-  var _a, _b, _c;
   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, input;
-  if (appId.startsWith("DocsViewer-")) {
-    const dom = (_b = (_a = manager.queryOne(appId)) == null ? void 0 : _a.box) == null ? void 0 : _b.$footer;
-    if (!dom) {
-      console.warn("not found app with id " + appId);
-      return false;
-    }
-    const click = (el) => {
-      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;
-  } else if (appId.startsWith("Slide-")) {
-    const app = (_c = manager.queryOne(appId)) == null ? void 0 : _c.appResult;
-    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;
-    }
-  } else {
-    console.warn("not supported app " + appId);
+  const dispatchDocsEvent2 = manager.dispatchDocsEvent;
+  if (!dispatchDocsEvent2) {
+    console.warn("window manager does not support dispatchDocsEvent");
     return false;
   }
+  return dispatchDocsEvent2.call(manager, event, options);
 }
 windowManager.WindowManager.register({
   kind: "Slide",