@netless/app-slide 0.2.56 → 0.2.58

package/README-zh.md

@@ -30,6 +30,25 @@ manager.addApp({
   attributes: {
     taskId: "1234567...", // [2]
     url: "https://convertcdn.netless.link/dynamicConvert", // [3]
+    previewList: [
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/preview/1.png",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/preview/2.png",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/preview/3.png"
+    ],
+    resourceList: [
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/note.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/overview.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-1-0-color.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-1-0-color.png",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-2-0-color.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-2-0-color.png",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-3-0-color.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-3-0-color.png",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/slide-1.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/slide-2.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/slide-3.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/title.json"
+    ]
   } as SlideAttributes,
 });
 ```

package/README.md

@@ -32,6 +32,25 @@ manager.addApp({
   attributes: {
     taskId: "1234567...", // [2]
     url: "https://convertcdn.netless.link/dynamicConvert", // [3]
+    previewList: [
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/preview/1.png",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/preview/2.png",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/preview/3.png"
+    ],
+    resourceList: [
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/note.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/overview.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-1-0-color.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-1-0-color.png",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-2-0-color.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-2-0-color.png",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-3-0-color.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/sheet-3-0-color.png",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/slide-1.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/slide-2.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/slide-3.json",
+      "https://convertcdn.netless.group/test/dynamicConvert/8ed5cce449874494a9ca7894b39415fb/jsonOutput/title.json"
+    ]
   } as SlideAttributes,
 });
 ```

package/dist/index.d.ts

@@ -459,7 +459,10 @@ declare class Slide extends Slide_base {
     private logger;
     private _dispatchIncrId;
     private _receiveIncrId;
+    private resizeView;
+    private handleViewClick;
     static trackLogger: AliTrackLogger;
+    private resourceList;
     private get dispatchIncrId();
     constructor(initConfig: ISlideConfig);
     private _updateVolumeByStaticAdjuster;
@@ -470,9 +473,10 @@ declare class Slide extends Slide_base {
     static handleReleaseAllSlide: () => void;
     static handleLogReport: (sessionId: string) => Promise<void>;
     static handleLogDownload: () => Promise<void>;
+    private urlInterrupter;
     private initPlayer;
     private userInputHandle;
-    private handleViewClick;
+    private _handleViewClick;
     private handleViewTouchStart;
     private handleViewTouchEnd;
     private createController;
@@ -485,7 +489,7 @@ declare class Slide extends Slide_base {
      * @param height Height value that needs to be updated, unit px.
      */
     updateFixedFrameSize(width: number, height: number, callback?: () => void): void;
-    private resizeView;
+    private _resizeView;
     private receiveSyncHandler;
     /**
      * Set the state of the entire slide, the slide will update the screen with the incoming state.
@@ -580,6 +584,8 @@ declare class Slide extends Slide_base {
      * @param url Resource URL prefix
      */
     setResource(taskId: string, url: string): void;
+    private flushDebounce;
+    setResourceList(taskId: string, urls: string[]): void;
     private _renderSlide;
     private handlePrevSlide;
     private handleNextSlide;
@@ -679,7 +685,7 @@ declare class Slide extends Slide_base {
      */
     updateGlobalVolume(v: number): void;
     /**
-     * Get the global volume of this Slide instance.
+     * Get the global volume of this Slide instance..
      */
     getGlobalVolume(): number;
     /**
@@ -687,7 +693,7 @@ declare class Slide extends Slide_base {
      */
     static clearLocalCache(): void;
     /**
-     * @deprecated 该 api 已经失效, 请用 slideInstance.clearSlideCache 和 Slide.clearLocalCache 替代
+     * @deprecated This API is no longer functional. Please use `slideInstance.clearSlideCache` and `Slide.clearLocalCache` instead.
      */
     static disposeLocalCache(): void;
 }
@@ -700,6 +706,8 @@ interface Attributes {
     url: string;
     /** internal state of slide, do not change */
     state: SlideState | null;
+    resourceList: string[];
+    previewList: string[];
 }
 declare type MagixPayload = {
     type: typeof SLIDE_EVENTS.syncDispatch;
@@ -883,6 +891,7 @@ interface SlideControllerOptions {
     onRenderError?: (error: Error, pageIndex: number) => void;
     onNavigate?: (index: number, origin?: string) => void;
     showRenderError?: boolean;
+    invisibleBehavior?: "frozen" | "pause";
 }
 declare class SlideController {
     readonly context: SlideControllerOptions["context"];
@@ -901,7 +910,9 @@ declare class SlideController {
     private syncStateOnceFlag;
     private visible;
     private savedIsFrozen;
-    constructor({ context, anchor, onRenderStart, onPageChanged, onTransitionStart, onTransitionEnd, onNavigate, onError, onRenderError, showRenderError, }: SlideControllerOptions);
+    private invisibleBehavior;
+    previewList: string[];
+    constructor({ context, anchor, onRenderStart, onPageChanged, onTransitionStart, onTransitionEnd, onNavigate, onError, onRenderError, showRenderError, invisibleBehavior, }: SlideControllerOptions);
     ready: boolean;
     private resolveReady;
     readonly readyPromise: Promise<void>;
@@ -994,8 +1005,9 @@ interface PreviewParams {
     taskId: string;
     url?: string;
     debug?: boolean;
+    resourceList?: string[];
 }
-declare function previewSlide({ container, taskId, url, debug, }: PreviewParams): SlidePreviewer;
+declare function previewSlide({ container, taskId, resourceList, url, debug, }: PreviewParams): SlidePreviewer;
 declare class SlidePreviewer {
     readonly viewer: DocsViewer;
     readonly bgColor: string;
@@ -1003,6 +1015,7 @@ declare class SlidePreviewer {
     slide: Slide | null;
     debug: boolean;
     $slide: HTMLDivElement;
+    private previewList;
     private readonly sideEffect;
     ready: boolean;
     private resolveReady;
@@ -1020,7 +1033,7 @@ declare class SlidePreviewer {
      */
     registerHotKeys(windowLike: Window): void;
     private hotkeyListener;
-    mount(taskId: string, url: string): void;
+    mount(taskId: string, url: string, resourceList: string[], previewList?: string[]): void;
     protected renderStyle(): HTMLElement;
     protected registerEventListeners(): void;
     protected onPageChanged: (page: number) => void;
@@ -1068,6 +1081,8 @@ interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCache" | "
     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";
 }
 interface ILogger {
     info?(msg: string): void;