@netless/app-slide 0.2.82 → 0.2.84

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ReadonlyTeleBox, RegisterParams, Room, Player, AppContext, View, NetlessApp } from '@netless/window-manager';
+import { ReadonlyTeleBox, RegisterParams, Room, AppContext, Player, View, NetlessApp } from '@netless/window-manager';
 import { VolumeAdjuster, SlideError } from '@netless/ppt-player';
 import { IPlugin } from '@netless/plugin-system';
 
@@ -758,6 +758,7 @@ interface FreezableSlide {
     freeze: () => void;
     unfreeze: () => void;
 }
+declare let useFreezer: boolean;
 declare let FreezerLength: number;
 declare function getFreezerLength(): number;
 /** @param length - must be >= 1, default is 2 */
@@ -912,6 +913,8 @@ declare class DocsViewer {
     protected sideEffect: SideEffectManager;
 }
 
+declare function syncSceneWithSlide(room: Room, context: AppContext<Attributes>, slide: Slide, baseScenePath: string): void;
+
 declare const DefaultUrl = "https://convertcdn.netless.link/dynamicConvert";
 interface SlideControllerOptions {
     context: AppContext<Attributes, MagixEvents, AppOptions>;
@@ -931,9 +934,9 @@ interface SlideControllerOptions {
     invisibleBehavior?: "frozen" | "pause";
 }
 type MagixEventListener = Parameters<AppContext<Attributes, MagixEvents>["addMagixEventListener"]>[1];
-declare class SlideController {
+declare class SlideControllerBase {
     readonly context: SlideControllerOptions["context"];
-    readonly slide: Slide;
+    slide: Slide;
     readonly showRenderError: boolean;
     readonly onRenderError?: (error: Error, pageIndex: number) => void;
     readonly onNavigate: (index: number, origin?: string) => void;
@@ -950,7 +953,7 @@ declare class SlideController {
     protected savedIsFrozen: boolean;
     protected invisibleBehavior: "frozen" | "pause";
     previewList: string[];
-    constructor({ context, anchor, onRenderStart, onPageChanged, onTransitionStart, onTransitionEnd, onNavigate, onError, onRenderError, showRenderError, invisibleBehavior, }: SlideControllerOptions);
+    constructor(props: SlideControllerOptions);
     ready: boolean;
     protected resolveReady: (index: number) => void;
     readonly readyPromise: Promise<void>;
@@ -977,6 +980,9 @@ declare class SlideController {
     unfreeze: () => Promise<void>;
     protected onVisibilityChange: () => Promise<void>;
 }
+declare class SlideController extends SlideControllerBase {
+    constructor(props: SlideControllerOptions);
+}
 
 type MountSlideOptions = Omit<SlideControllerOptions, "context" | "onPageChanged"> & {
     onReady: () => void;
@@ -1045,6 +1051,41 @@ declare class SlideDocsViewer {
     protected toPdf: () => Promise<null | undefined>;
 }
 
+type DebugMessage = {
+    slide: boolean | "__instance" | "__debug";
+};
+type RoomLogger = {
+    debug: (...args: any) => void;
+    info: (...args: any) => void;
+    warn: (...args: any) => void;
+};
+declare class Logger {
+    enable: boolean;
+    apps: Record<string, {
+        context?: AppContext | null;
+        controller?: SlideController | null;
+    }>;
+    setAppContext(appId: string, context: AppContext | null): void;
+    setAppController(appId: string, controller: SlideController | null): void;
+    deleteApp(appId: string): void;
+    level: "debug" | "verbose";
+    roomLogger: RoomLogger | null;
+    constructor(enable: boolean);
+    initialize(): void;
+    dispose(): void;
+    log(...args: any[]): void;
+    verbose(...args: any[]): void;
+    warn(...args: any[]): void;
+    /**
+     * @example
+     * window.postMessage({ slide: '__debug' })
+     * window.dispatchEvent(new MessageEvent('message', { data: { slide: '__debug' } }))
+     */
+    _onMessage: (ev: MessageEvent<DebugMessage> | CustomEvent<DebugMessage>) => void;
+}
+declare const logger: Logger;
+declare const log: (...args: any[]) => void;
+
 interface PreviewParams {
     container: HTMLElement;
     taskId: string;
@@ -1150,4 +1191,4 @@ interface AppResult {
 }
 declare const SlideApp: NetlessApp<Attributes, MagixEvents, AppOptions, AppResult>;
 
-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 };
+export { type AddHooks, type AppOptions, type AppResult, type Attributes, DefaultUrl, DocsViewer, type FreezableSlide, FreezerLength, type ILogger, type PreviewParams, SideEffectManager, Slide, SlideController, SlideControllerBase, SlideDocsViewer, SlidePreviewer, addHooks, apps, SlideApp as default, getFreezerLength, log, logger, onCreated, onDestroyed, previewSlide, setFreezerLength, syncSceneWithSlide, useFreezer, usePlugin, version };