@netless/app-slide 0.2.61-beta.0 → 0.2.62-beta.0

package/README-zh.md

@@ -13,6 +13,12 @@ WindowManager.register({
   appOptions: {
     // 打开这个选项显示 debug 工具栏
     debug: false,
+    urlInterrupter: async (url: string) => {
+      // 一般会有不同的实现，比如签名。
+      const { ak, expire } = await getSTSToken(); // 客户的客户端实现。
+      return `${url}?expire=${expire}&ak=${ak}`;
+    },
+    // 更多选项可以在 https://github.com/netless-io/netless-slide-demo#slide-%E9%85%8D%E7%BD%AE 查看
   },
   src: async () => {
     const app = await import("@netless/app-slide");

package/README.md

@@ -15,6 +15,13 @@ WindowManager.register({
   appOptions: {
     // turn on to show debug controller
     debug: false,
+    urlInterrupter: async (url: string) => {
+      // There will be different implementations depending on different cloud storage services.
+      // Generally, signatures are added to the query parameters.
+      const { ak, expire } = await getSTSToken(); // Customer service side implementation.
+      return `${url}?expire=${expire}&ak=${ak}`;
+      // https://github.com/netless-io/netless-slide-demo#slide-%E9%85%8D%E7%BD%AE for more options
+    },
   },
   src: async () => {
     const app = await import("@netless/app-slide");

package/dist/index.d.ts

@@ -698,7 +698,7 @@ declare class Slide extends Slide_base {
     static disposeLocalCache(): void;
 }
 
-declare type SlideState = Slide["slideState"];
+type SlideState = Slide["slideState"];
 interface Attributes {
     /** convert task id */
     taskId: string;
@@ -709,11 +709,11 @@ interface Attributes {
     resourceList: string[];
     previewList: string[];
 }
-declare type MagixPayload = {
+type MagixPayload = {
     type: typeof SLIDE_EVENTS.syncDispatch;
     payload: SyncEvent;
 };
-declare type MagixEvents = {
+type MagixEvents = {
     [SLIDE_EVENTS.syncDispatch]: MagixPayload;
 };
 
@@ -736,7 +736,7 @@ declare const apps: {
 };
 declare function onCreated(callback: (appId: string) => void): () => boolean;
 declare function onDestroyed(callback: (appId: string) => void): () => boolean;
-declare type AddHooks = NonNullable<RegisterParams["addHooks"]>;
+type AddHooks = NonNullable<RegisterParams["addHooks"]>;
 /**
  * Put this function in your register code:
  * `WindowManager.register({ kind: 'Slide', src: SlideApp, addHooks })`
@@ -744,7 +744,7 @@ declare type AddHooks = NonNullable<RegisterParams["addHooks"]>;
  */
 declare const addHooks: AddHooks;
 
-declare type SideEffectDisposer = () => any;
+type SideEffectDisposer = () => any;
 declare class SideEffectManager {
     /**
      * Add a disposer directly.
@@ -940,10 +940,11 @@ declare class SlideController {
     private onVisibilityChange;
 }
 
-declare type MountSlideOptions = Omit<SlideControllerOptions, "context" | "onPageChanged"> & {
+type MountSlideOptions = Omit<SlideControllerOptions, "context" | "onPageChanged"> & {
     onReady: () => void;
 };
 interface SlideDocsViewerConfig {
+    context: AppContext<Attributes, MagixEvents, AppOptions>;
     box: ReadonlyTeleBox;
     view: View;
     mountSlideController: (options: MountSlideOptions) => SlideController;
@@ -955,6 +956,7 @@ interface SlideDocsViewerConfig {
     onNavigate?: (index: number, origin?: string) => void;
 }
 declare class SlideDocsViewer {
+    readonly context: AppContext<Attributes, MagixEvents, AppOptions>;
     viewer: DocsViewer;
     slideController: SlideController | null;
     protected readonly box: ReadonlyTeleBox;
@@ -965,7 +967,7 @@ declare class SlideDocsViewer {
     private readonly baseScenePath;
     private readonly appId;
     private isViewMounted;
-    constructor({ box, view, mountSlideController, mountWhiteboard, baseScenePath, appId, urlInterrupter, onPagesReady, onNavigate, }: SlideDocsViewerConfig);
+    constructor({ context, box, view, mountSlideController, mountWhiteboard, baseScenePath, appId, urlInterrupter, onPagesReady, onNavigate, }: SlideDocsViewerConfig);
     $slide: HTMLDivElement;
     $whiteboardView: HTMLDivElement;
     $overlay: HTMLDivElement;
@@ -1102,4 +1104,4 @@ interface AppResult {
 }
 declare const SlideApp: NetlessApp<Attributes, MagixEvents, AppOptions, AppResult>;
 
-export { AddHooks, AppOptions, AppResult, Attributes, DefaultUrl, FreezableSlide, FreezerLength, ILogger, PreviewParams, Slide, SlidePreviewer, addHooks, apps, SlideApp as default, getFreezerLength, onCreated, onDestroyed, previewSlide, setFreezerLength, usePlugin, version };
+export { type AddHooks, type AppOptions, type AppResult, type Attributes, DefaultUrl, type FreezableSlide, FreezerLength, type ILogger, type PreviewParams, Slide, SlidePreviewer, addHooks, apps, SlideApp as default, getFreezerLength, onCreated, onDestroyed, previewSlide, setFreezerLength, usePlugin, version };