@netless/slide 0.3.8 → 0.4.0

package/README.md

@@ -358,6 +358,63 @@ clearSlideCache(): void;
 static clearLocalCache(): void;
 ```
 
+### 资源代理
+
+**注意: `@netless/slide@0.4.0` 版本才开始支持。**
+
+从 `@netless/slide@0.4.0` 开始, 你可以在创建 Slide 对象时提供一个 loaderDelegate 对象, 从而代理 Slide 内部所有远程资源, 进而可以实现
+资源重定向, 资源鉴权等需求.
+
+loaderDelegate 属性需符合 `ILoaderDelegate` 接口, 需要注意对于媒体资源, 并不能直接返回资源内容, 只能同步的返回重定向后的资源地址.
+
+```typescript
+export interface ILoaderDelegate {
+    /**
+     * 加载 json 资源, 需返回 json 文本
+     * @param url 原始资源地址
+     */
+    loadJson(url: string): Promise<string>;
+    /**
+     * 加载图片资源, 需返回 Blob 对象
+     * @param url 原始资源地址
+     */
+    loadImage(url: string): Promise<Blob>;
+    /**
+     * 媒体文件重定向, mp3 和 mp4 资源会调用这个代理函数, 需返回重定向后的 url
+     * @param url 原始资源地址
+     */
+    redirectMedia(url: string): string;
+}
+```
+
+一个什么也不干的 loaderDelegate 如下所示, 但是你可以对传入的 url 进行加工:
+
+```typescript
+import { Slide, ILoaderDelegate } from "@netless/slide"
+
+const delegate: ILoaderDelegate = {
+    loadJson(url: string): Promise<string> {
+        return fetch(url).then(res => {
+            return res.text();
+        });
+    },
+    loadImage(url: string): Promise<Blob> {
+        return fetch(url).then(res => {
+            return res.blob();
+        });
+    },
+    redirectMedia(url: string): string {
+        return url;
+    }
+}
+
+const slide = new Slide({
+    /// ... 其他初始化配置
+    loaderDelegate: delegate,
+})
+```
+
+
 ## [示例及具体文档参考](https://github.com/netless-io/netless-slide-demo)
 
 ## changelog
@@ -495,3 +552,11 @@ static clearLocalCache(): void;
 
 #### 0.3.8
 * subtask 错误添加子任务类型输出，方便定位 bug
+
+#### 0.3.9
+* 新增 resourceTimeout 配置
+* 修复资源加载引起的错误无法跳转下一页的问题
+
+#### 0.3.10
+* 新增本地日志下载功能
+* 修复加载状态不一致导致无法下一步的问题

package/lib/RenderingTaskManager.d.ts

@@ -17,4 +17,5 @@ export declare class RenderingTaskManager {
     private replaceIdleTask;
     addTask(fn: () => Promise<void>, slideIndex: number, id: string): void;
     hasStartTask(): boolean;
+    destroy(): void;
 }

package/lib/RenderingTaskManager.js

@@ -131,6 +131,9 @@ var RenderingTaskManager = /** @class */ (function () {
     RenderingTaskManager.prototype.hasStartTask = function () {
         return this.tasks.some(function (t) { return t.state === "start"; });
     };
+    RenderingTaskManager.prototype.destroy = function () {
+        this.eventHub.removeAllListeners();
+    };
     return RenderingTaskManager;
 }());
 export { RenderingTaskManager };

package/lib/Slide.d.ts

@@ -1,4 +1,6 @@
+import { SlideError, ILoaderDelegate } from "@netless/ppt-player";
 export { ErrorType } from "@netless/ppt-player";
+export type { ILoaderDelegate } from "@netless/ppt-player";
 export interface RtcAudio {
     /**
      * 开始播放音频.
@@ -153,6 +155,14 @@ export interface ISlideConfig {
      * 默认为 true
      */
     useLocalCache?: boolean;
+    /**
+     * 资源加载超时时间, 默认 15 秒
+     */
+    resourceTimeout?: number;
+    /**
+     * 远程资源代理, 详细使用参考 README
+     */
+    loaderDelegate?: ILoaderDelegate;
 }
 interface MediaState {
     type: "pause" | "play";
@@ -235,11 +245,11 @@ export interface SlideEventEmitter {
     emit(event: typeof SLIDE_EVENTS.syncReceive, args: SyncEvent): boolean;
     on(event: typeof SLIDE_EVENTS.syncReceive, listener: (event: SyncEvent) => void): this;
     emit(event: typeof SLIDE_EVENTS.renderError, args: {
-        error: Error;
+        error: SlideError;
         index: number;
     }): boolean;
     on(event: typeof SLIDE_EVENTS.renderError, listener: (args: {
-        error: Error;
+        error: SlideError;
         index: number;
     }) => void): this;
     emit(event: typeof SLIDE_EVENTS.animateStart): boolean;
@@ -257,6 +267,10 @@ export interface SlideEventEmitter {
 }
 declare const Slide_base: new () => SlideEventEmitter;
 export declare class Slide extends Slide_base {
+    static logStore: LocalForage;
+    static _tempLog: string;
+    static _tempLogIndex: number;
+    static flushLog(): Promise<void>;
     private iosResetCache;
     private iosNewPlayer?;
     private needClearCacheImage;
@@ -264,6 +278,7 @@ export declare class Slide extends Slide_base {
     private __slideState;
     private userInputTime;
     private isSyncingSlideState;
+    private randomId;
     private resize;
     private isAnimating;
     private renderingTaskManager;
@@ -299,6 +314,7 @@ export declare class Slide extends Slide_base {
     private _receiveIncrId;
     private get dispatchIncrId();
     constructor(config: ISlideConfig);
+    static handleLogDownload: () => Promise<void>;
     private initPlayer;
     private userInputHandle;
     private handleViewClick;
@@ -408,7 +424,13 @@ export declare class Slide extends Slide_base {
     renderSlide(index: number, isForward?: boolean): void;
     private needCreateNewPlayer;
     private poseRenderSlide;
-    private doRenderSlide;
+    /**
+     * 直接渲染 index 指定的页码, 不论当前是 sync 还是 interactive 模式.
+     * 即调用此方法不会触发 syncDispatch 事件
+     * @param index 要渲染的页码
+     * @param isForward 是否向前翻页, 影响切页动画时正放还是倒放
+     */
+    doRenderSlide(index: number, isForward?: boolean): Promise<void>;
     /**
      * 执行下一个主序列动画
      */