@netless/app-slide 0.2.56 → 0.2.58

package/package.json

@@ -1,16 +1,22 @@
 {
   "name": "@netless/app-slide",
-  "version": "0.2.56",
+  "version": "0.2.58",
   "main": "dist/main.cjs.js",
   "module": "dist/main.es.js",
   "types": "dist/index.d.ts",
+  "scripts": {
+    "types": "node scripts/build-types.mjs",
+    "build": "vite build && npm run types",
+    "build:dev": "vite build --mode development && npm run types",
+    "cleanup": "rimraf ./dist"
+  },
   "files": [
     "src",
     "dist",
     "README-zh.md"
   ],
   "devDependencies": {
-    "@netless/slide": "^1.4.0",
+    "@netless/slide": "^1.4.7",
     "@types/color-string": "^1.5.2",
     "color-string": "^1.9.1",
     "jspdf": "2.5.1",
@@ -24,11 +30,5 @@
     "jspdf": {
       "optional": true
     }
-  },
-  "scripts": {
-    "types": "node scripts/build-types.mjs",
-    "build": "vite build && npm run types",
-    "build:dev": "vite build --mode development && npm run types",
-    "cleanup": "rimraf ./dist"
   }
-}
+}

package/src/SlideController/helpers.ts

@@ -4,12 +4,17 @@ import type { Slide } from "@netless/slide";
 import type { DocsViewerPage } from "../DocsViewer";
 import type { Attributes } from "../typings";
 
-export function createDocsViewerPages(slide: Slide): DocsViewerPage[] {
+export function createDocsViewerPages(slide: Slide, previewUrls: string[] = []): DocsViewerPage[] {
   const { width, height, slideCount, slideState } = slide;
   const { taskId, url } = slideState;
   const pages: DocsViewerPage[] = [];
   for (let i = 1; i <= slideCount; ++i) {
-    pages.push({ width, height, thumbnail: `${url}/${taskId}/preview/${i}.png`, src: "ppt" });
+    const signedUrl = previewUrls.find(v => v.indexOf(`preview/${i}.png`) >= 0);
+    if (signedUrl) {
+      pages.push({ width, height, thumbnail: signedUrl, src: "ppt" });
+    } else {
+      pages.push({ width, height, thumbnail: `${url}/${taskId}/preview/${i}.png`, src: "ppt" });
+    }
   }
   return pages;
 }

package/src/SlideController/index.ts

@@ -27,6 +27,8 @@ export const EmptyAttributes: Attributes = {
   taskId: "",
   url: "",
   state: null,
+  resourceList: [],
+  previewList: [],
 };
 
 export interface SlideControllerOptions {
@@ -41,6 +43,7 @@ export interface SlideControllerOptions {
   onRenderError?: (error: Error, pageIndex: number) => void;
   onNavigate?: (index: number, origin?: string) => void;
   showRenderError?: boolean;
+  invisibleBehavior?: "frozen" | "pause";
 }
 
 const noop = function noop() {
@@ -73,6 +76,11 @@ export class SlideController {
   private visible: boolean;
   private savedIsFrozen: boolean;
 
+  private invisibleBehavior: "frozen" | "pause";
+
+  // 签名后的预览图
+  public previewList: string[] = [];
+
   public constructor({
     context,
     anchor,
@@ -84,7 +92,9 @@ export class SlideController {
     onError,
     onRenderError,
     showRenderError,
+    invisibleBehavior,
   }: SlideControllerOptions) {
+    this.invisibleBehavior = invisibleBehavior ?? "frozen";
     this.onRenderStart = onRenderStart;
     this.onPageChanged = onPageChanged;
     this.onTransitionStart = onTransitionStart;
@@ -148,8 +158,13 @@ export class SlideController {
     if (context.getIsWritable()) {
       context.storage.ensureState(EmptyAttributes);
     }
-    const { taskId, url, state } = context.storage.state;
-    slide.setResource(taskId, url || DefaultUrl);
+    const { taskId, url, resourceList, previewList, state } = context.storage.state;
+    this.previewList = previewList;
+    if (resourceList && resourceList.length > 0) {
+      slide.setResourceList(taskId, resourceList);
+    } else {
+      slide.setResource(taskId, url || DefaultUrl);
+    }
     if (state) {
       // if we already have state, try restore from it
       log("[Slide] init with state", JSON.stringify(state));
@@ -341,7 +356,11 @@ export class SlideController {
     this.isFrozen = true;
     if (this.ready) {
       log("[Slide] freeze", this.context.appId);
-      this.slide.frozen();
+      if (this.invisibleBehavior === "frozen") {
+        this.slide.frozen();
+      } else {
+        this.slide.pause();
+      }
     } else {
       this._toFreeze = 1;
     }
@@ -352,7 +371,11 @@ export class SlideController {
     this.isFrozen = false;
     if (this.ready) {
       log("[Slide] unfreeze", this.context.appId);
-      this.slide.release();
+      if (this.invisibleBehavior === "frozen") {
+        this.slide.release();
+      } else {
+        this.slide.resume();
+      }
     } else {
       this._toFreeze = -1;
     }

package/src/SlideDocsViewer/index.ts

@@ -213,7 +213,7 @@ export class SlideDocsViewer {
 
   protected refreshPages = () => {
     if (this.slideController) {
-      this.viewer.pages = createDocsViewerPages(this.slideController.slide);
+      this.viewer.pages = createDocsViewerPages(this.slideController.slide, this.slideController.previewList);
       this.viewer.setPageIndex(this.getPageIndex(this.slideController.page));
       this.scaleDocsToFit();
     }

package/src/SlidePreviewer/index.ts

@@ -11,11 +11,13 @@ export interface PreviewParams {
   taskId: string;
   url?: string;
   debug?: boolean;
+  resourceList?: string[];
 }
 
 export default function previewSlide({
   container,
   taskId,
+  resourceList = [],
   url = DefaultUrl,
   debug = import.meta.env.DEV,
 }: PreviewParams) {
@@ -27,7 +29,7 @@ export default function previewSlide({
   const previewer = new SlidePreviewer({ target: container });
   previewer.debug = !!debug;
 
-  previewer.mount(taskId, url);
+  previewer.mount(taskId, url, resourceList);
 
   return previewer;
 }
@@ -46,6 +48,8 @@ export class SlidePreviewer {
 
   public $slide!: HTMLDivElement;
 
+  private previewList: string[] = [];
+
   private readonly sideEffect = new SideEffectManager();
 
   public ready = false;
@@ -110,7 +114,7 @@ export class SlidePreviewer {
     }
   };
 
-  public mount(taskId: string, url: string) {
+  public mount(taskId: string, url: string, resourceList: string[], previewList: string[] = []) {
     this.target.appendChild(this.renderStyle());
     this.target.appendChild(this.viewer.$content);
     this.target.appendChild(this.viewer.$footer);
@@ -132,8 +136,13 @@ export class SlidePreviewer {
 
     this.registerEventListeners();
 
-    this.slide.setResource(taskId, url);
+    if (resourceList.length > 0) {
+      this.slide.setResourceList(taskId, resourceList);
+    } else {
+      this.slide.setResource(taskId, url);
+    }
     this.slide.renderSlide(1);
+    this.previewList = previewList;
   }
 
   protected renderStyle(): HTMLElement {
@@ -186,7 +195,7 @@ export class SlidePreviewer {
 
   protected refreshPages = () => {
     if (this.slide) {
-      this.viewer.pages = createDocsViewerPages(this.slide);
+      this.viewer.pages = createDocsViewerPages(this.slide, this.previewList);
       this.viewer.setPageIndex(this.getPageIndex(this.slide.slideState.currentSlideIndex));
     }
   };

package/src/index.ts

@@ -69,6 +69,8 @@ export interface AppOptions
   onRenderError?: (error: Error, pageIndex: number) => void;
   /** whether to show an overlay of error message @default: true */
   showRenderError?: boolean;
+  /** Specify the behavior after hiding the slide; Freeze will destroy the slide and replace it with a snapshot, while Pause simply pauses the slide @default: 'frozen' */
+  invisibleBehavior?: "frozen" | "pause";
 }
 
 export interface ILogger {
@@ -150,6 +152,7 @@ const SlideApp: NetlessApp<Attributes, MagixEvents, AppOptions, AppResult> = {
         onNavigate: options.onNavigate,
         onRenderError: appOptions.onRenderError,
         showRenderError: appOptions.showRenderError,
+        invisibleBehavior: appOptions.invisibleBehavior,
       });
       if (useFreezer) apps.set(context.appId, slideController, box);
       logger.setAppController(context.appId, slideController);

package/src/typings.ts

@@ -9,6 +9,8 @@ export interface Attributes {
   url: string;
   /** internal state of slide, do not change */
   state: SlideState | null;
+  resourceList: string[];
+  previewList: string[];
 }
 
 export type MagixPayload = {

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 netless
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.