@netless/app-slide 0.2.39 → 0.2.41

package/dist/index.d.ts

@@ -661,48 +661,48 @@ declare class Slide extends Slide_base {
     static disposeLocalCache(): void;
 }
 
-declare type SlideState = Slide["slideState"];
-interface Attributes {
-    /** convert task id */
-    taskId: string;
-    /** base url of converted resources */
-    url: string;
-    /** internal state of slide, do not change */
-    state: SlideState | null;
-}
-declare type MagixPayload = {
-    type: typeof SLIDE_EVENTS.syncDispatch;
-    payload: SyncEvent;
-};
-declare type MagixEvents = {
-    [SLIDE_EVENTS.syncDispatch]: MagixPayload;
+declare type SlideState = Slide["slideState"];
+interface Attributes {
+    /** convert task id */
+    taskId: string;
+    /** base url of converted resources */
+    url: string;
+    /** internal state of slide, do not change */
+    state: SlideState | null;
+}
+declare type MagixPayload = {
+    type: typeof SLIDE_EVENTS.syncDispatch;
+    payload: SyncEvent;
+};
+declare type MagixEvents = {
+    [SLIDE_EVENTS.syncDispatch]: MagixPayload;
 };
 
-interface FreezableSlide {
-    freeze: () => void;
-    unfreeze: () => void;
-}
-declare let FreezerLength: number;
-declare function getFreezerLength(): number;
-/** @param length - must be >= 1, default is 2 */
-declare function setFreezerLength(length: number): void;
-declare const apps: {
-    map: Map<string, FreezableSlide>;
-    boxes: Map<string, ReadonlyTeleBox>;
-    queue: string[];
-    validateQueue(): void;
-    set(appId: string, slide: FreezableSlide, box: ReadonlyTeleBox): void;
-    delete(appId: string): void;
-    focus(appId: string): void;
-};
-declare function onCreated(callback: (appId: string) => void): () => boolean;
-declare function onDestroyed(callback: (appId: string) => void): () => boolean;
-declare type AddHooks = NonNullable<RegisterParams["addHooks"]>;
-/**
- * Put this function in your register code:
- * `WindowManager.register({ kind: 'Slide', src: SlideApp, addHooks })`
- * So that it will automatically freeze the app when it is not in focus.
- */
+interface FreezableSlide {
+    freeze: () => void;
+    unfreeze: () => void;
+}
+declare let FreezerLength: number;
+declare function getFreezerLength(): number;
+/** @param length - must be >= 1, default is 2 */
+declare function setFreezerLength(length: number): void;
+declare const apps: {
+    map: Map<string, FreezableSlide>;
+    boxes: Map<string, ReadonlyTeleBox>;
+    queue: string[];
+    validateQueue(): void;
+    set(appId: string, slide: FreezableSlide, box: ReadonlyTeleBox): void;
+    delete(appId: string): void;
+    focus(appId: string): void;
+};
+declare function onCreated(callback: (appId: string) => void): () => boolean;
+declare function onDestroyed(callback: (appId: string) => void): () => boolean;
+declare type AddHooks = NonNullable<RegisterParams["addHooks"]>;
+/**
+ * Put this function in your register code:
+ * `WindowManager.register({ kind: 'Slide', src: SlideApp, addHooks })`
+ * So that it will automatically freeze the app when it is not in focus.
+ */
 declare const addHooks: AddHooks;
 
 declare type SideEffectDisposer = () => any;
@@ -779,268 +779,268 @@ declare class SideEffectManager {
     genUID(): string;
 }
 
-interface DocsViewerPage {
-    src: string;
-    height: number;
-    width: number;
-    thumbnail?: string;
-}
-interface DocsViewerConfig {
-    readonly: boolean;
-    onNewPageIndex: (index: number) => void;
-    onPlay?: () => void;
-    urlInterrupter?: (url: string) => Promise<string>;
-}
-declare class DocsViewer {
-    constructor({ readonly, onNewPageIndex, onPlay, urlInterrupter }: DocsViewerConfig);
-    protected readonly: boolean;
-    protected onNewPageIndex: (index: number) => void;
-    protected onPlay?: () => void;
-    protected urlInterrupter: (url: string) => Promise<string> | string;
-    private _pages;
-    set pages(value: DocsViewerPage[]);
-    get pages(): DocsViewerPage[];
-    $content: HTMLElement;
-    $preview: HTMLElement;
-    $previewMask: HTMLElement;
-    $footer: HTMLElement;
-    $pageNumberInput: HTMLInputElement;
-    $totalPage: HTMLSpanElement;
-    $btnPlay: HTMLButtonElement;
-    $btnSidebar: HTMLButtonElement;
-    pageIndex: number;
-    unmount(): void;
-    setReadonly(readonly: boolean): void;
-    destroy(): void;
-    setPageIndex(pageIndex: number): void;
-    refreshTotalPage(): void;
-    setSmallBox(isSmallBox: boolean): void;
-    render(): HTMLElement;
-    protected renderContent(): HTMLElement;
-    private previewLazyLoad?;
-    protected renderPreview(): HTMLElement;
-    private refreshPreview;
-    protected renderPreviewMask(): HTMLElement;
-    setPaused: () => void;
-    setPlaying: () => void;
-    refreshBtnSidebar(): void;
-    protected renderFooter(): HTMLElement;
-    protected renderFooterBtn(className: string, $icon: SVGElement, $iconActive?: SVGElement): HTMLButtonElement;
-    protected togglePreview(isShowPreview?: boolean): void;
-    protected wrapClassName(className: string): string;
-    protected namespace: string;
-    protected isShowPreview: boolean;
-    protected isSmallBox: boolean;
-    protected sideEffect: SideEffectManager;
+interface DocsViewerPage {
+    src: string;
+    height: number;
+    width: number;
+    thumbnail?: string;
+}
+interface DocsViewerConfig {
+    readonly: boolean;
+    onNewPageIndex: (index: number) => void;
+    onPlay?: () => void;
+    urlInterrupter?: (url: string) => Promise<string>;
+}
+declare class DocsViewer {
+    constructor({ readonly, onNewPageIndex, onPlay, urlInterrupter }: DocsViewerConfig);
+    protected readonly: boolean;
+    protected onNewPageIndex: (index: number) => void;
+    protected onPlay?: () => void;
+    protected urlInterrupter: (url: string) => Promise<string> | string;
+    private _pages;
+    set pages(value: DocsViewerPage[]);
+    get pages(): DocsViewerPage[];
+    $content: HTMLElement;
+    $preview: HTMLElement;
+    $previewMask: HTMLElement;
+    $footer: HTMLElement;
+    $pageNumberInput: HTMLInputElement;
+    $totalPage: HTMLSpanElement;
+    $btnPlay: HTMLButtonElement;
+    $btnSidebar: HTMLButtonElement;
+    pageIndex: number;
+    unmount(): void;
+    setReadonly(readonly: boolean): void;
+    destroy(): void;
+    setPageIndex(pageIndex: number): void;
+    refreshTotalPage(): void;
+    setSmallBox(isSmallBox: boolean): void;
+    render(): HTMLElement;
+    protected renderContent(): HTMLElement;
+    private previewLazyLoad?;
+    protected renderPreview(): HTMLElement;
+    private refreshPreview;
+    protected renderPreviewMask(): HTMLElement;
+    setPaused: () => void;
+    setPlaying: () => void;
+    refreshBtnSidebar(): void;
+    protected renderFooter(): HTMLElement;
+    protected renderFooterBtn(className: string, $icon: SVGElement, $iconActive?: SVGElement): HTMLButtonElement;
+    protected togglePreview(isShowPreview?: boolean): void;
+    protected wrapClassName(className: string): string;
+    protected namespace: string;
+    protected isShowPreview: boolean;
+    protected isSmallBox: boolean;
+    protected sideEffect: SideEffectManager;
 }
 
-declare const DefaultUrl = "https://convertcdn.netless.link/dynamicConvert";
-interface SlideControllerOptions {
-    context: AppContext<Attributes, MagixEvents, AppOptions>;
-    anchor: HTMLDivElement;
-    onRenderEnd: () => void;
-    onPageChanged: (page: number) => void;
-    onTransitionStart: () => void;
-    onTransitionEnd: () => void;
-    onError: (args: {
-        error: Error;
-        index: number;
-    }) => void;
-    onRenderError?: (error: Error, pageIndex: number) => void;
-    showRenderError?: boolean;
-}
-declare class SlideController {
-    readonly context: SlideControllerOptions["context"];
-    readonly slide: Slide;
-    readonly showRenderError: boolean;
-    readonly onRenderError?: (error: Error, pageIndex: number) => void;
-    private readonly room?;
-    private readonly player?;
-    private readonly sideEffect;
-    private readonly onPageChanged;
-    private readonly onTransitionStart;
-    private readonly onTransitionEnd;
-    private readonly onError;
-    private syncStateOnceFlag;
-    private visible;
-    private savedIsFrozen;
-    constructor({ context, anchor, onPageChanged, onTransitionStart, onTransitionEnd, onError, onRenderError, showRenderError, }: SlideControllerOptions);
-    ready: boolean;
-    private resolveReady;
-    readonly readyPromise: Promise<void>;
-    jumpToPage(page: number): void;
-    private initialize;
-    private kickStart;
-    private registerEventListeners;
-    private onSyncDispatch;
-    private magixEventListener;
-    private syncStateOnce;
-    private onStateChange;
-    private pollCount;
-    private pollReadyState;
-    private _pageCount;
-    get pageCount(): number;
-    get page(): number;
-    private createSlide;
-    private destroyed;
-    destroy(): void;
-    timestamp: () => number;
-    isFrozen: boolean;
-    private _toFreeze;
-    freeze: () => void;
-    unfreeze: () => Promise<void>;
-    private onVisibilityChange;
+declare const DefaultUrl = "https://convertcdn.netless.link/dynamicConvert";
+interface SlideControllerOptions {
+    context: AppContext<Attributes, MagixEvents, AppOptions>;
+    anchor: HTMLDivElement;
+    onRenderEnd: () => void;
+    onPageChanged: (page: number) => void;
+    onTransitionStart: () => void;
+    onTransitionEnd: () => void;
+    onError: (args: {
+        error: Error;
+        index: number;
+    }) => void;
+    onRenderError?: (error: Error, pageIndex: number) => void;
+    showRenderError?: boolean;
+}
+declare class SlideController {
+    readonly context: SlideControllerOptions["context"];
+    readonly slide: Slide;
+    readonly showRenderError: boolean;
+    readonly onRenderError?: (error: Error, pageIndex: number) => void;
+    private readonly room?;
+    private readonly player?;
+    private readonly sideEffect;
+    private readonly onPageChanged;
+    private readonly onTransitionStart;
+    private readonly onTransitionEnd;
+    private readonly onError;
+    private syncStateOnceFlag;
+    private visible;
+    private savedIsFrozen;
+    constructor({ context, anchor, onPageChanged, onTransitionStart, onTransitionEnd, onError, onRenderError, showRenderError, }: SlideControllerOptions);
+    ready: boolean;
+    private resolveReady;
+    readonly readyPromise: Promise<void>;
+    jumpToPage(page: number): void;
+    private initialize;
+    private kickStart;
+    private registerEventListeners;
+    private onSyncDispatch;
+    private magixEventListener;
+    private syncStateOnce;
+    private onStateChange;
+    private pollCount;
+    private pollReadyState;
+    private _pageCount;
+    get pageCount(): number;
+    get page(): number;
+    private createSlide;
+    private destroyed;
+    destroy(): void;
+    timestamp: () => number;
+    isFrozen: boolean;
+    private _toFreeze;
+    freeze: () => void;
+    unfreeze: () => Promise<void>;
+    private onVisibilityChange;
 }
 
-declare type MountSlideOptions = Omit<SlideControllerOptions, "context" | "onPageChanged"> & {
-    onReady: () => void;
-};
-interface SlideDocsViewerConfig {
-    box: ReadonlyTeleBox;
-    view: View;
-    mountSlideController: (options: MountSlideOptions) => SlideController;
-    mountWhiteboard: (dom: HTMLDivElement) => void;
-    baseScenePath: string;
-    appId: string;
-    urlInterrupter?: (url: string) => Promise<string>;
-}
-declare class SlideDocsViewer {
-    viewer: DocsViewer;
-    slideController: SlideController | null;
-    protected readonly box: ReadonlyTeleBox;
-    protected readonly whiteboardView: SlideDocsViewerConfig["view"];
-    protected readonly mountSlideController: SlideDocsViewerConfig["mountSlideController"];
-    protected readonly mountWhiteboard: SlideDocsViewerConfig["mountWhiteboard"];
-    private readonly baseScenePath;
-    private readonly appId;
-    private isViewMounted;
-    constructor({ box, view, mountSlideController, mountWhiteboard, baseScenePath, appId, urlInterrupter, }: SlideDocsViewerConfig);
-    $slide: HTMLDivElement;
-    $whiteboardView: HTMLDivElement;
-    $overlay: HTMLDivElement;
-    render(): void;
-    protected renderOverlay(): HTMLDivElement;
-    protected renderSlideContainer(): HTMLDivElement;
-    protected renderWhiteboardView(): HTMLDivElement;
-    mount(): this;
-    protected onError: ({ error, index }: {
-        error: Error;
-        index: number;
-    }) => void;
-    protected onRenderEnd: () => void;
-    protected refreshPages: () => void;
-    protected getPageIndex(page: number): number;
-    unmount(): this;
-    setReadonly(readonly: boolean): void;
-    destroy(): void;
-    toggleClickThrough(tool?: string): void;
-    protected scaleDocsToFit: () => void;
-    protected onPlay: () => void;
-    protected onNewPageIndex: (index: number) => void;
-    protected sideEffect: SideEffectManager;
-    protected wrapClassName(className: string): string;
-    protected namespace: string;
-    private getWhiteSnapshot;
-    private reportProgress;
-    private toPdf;
+declare type MountSlideOptions = Omit<SlideControllerOptions, "context" | "onPageChanged"> & {
+    onReady: () => void;
+};
+interface SlideDocsViewerConfig {
+    box: ReadonlyTeleBox;
+    view: View;
+    mountSlideController: (options: MountSlideOptions) => SlideController;
+    mountWhiteboard: (dom: HTMLDivElement) => void;
+    baseScenePath: string;
+    appId: string;
+    urlInterrupter?: (url: string) => Promise<string>;
+}
+declare class SlideDocsViewer {
+    viewer: DocsViewer;
+    slideController: SlideController | null;
+    protected readonly box: ReadonlyTeleBox;
+    protected readonly whiteboardView: SlideDocsViewerConfig["view"];
+    protected readonly mountSlideController: SlideDocsViewerConfig["mountSlideController"];
+    protected readonly mountWhiteboard: SlideDocsViewerConfig["mountWhiteboard"];
+    private readonly baseScenePath;
+    private readonly appId;
+    private isViewMounted;
+    constructor({ box, view, mountSlideController, mountWhiteboard, baseScenePath, appId, urlInterrupter, }: SlideDocsViewerConfig);
+    $slide: HTMLDivElement;
+    $whiteboardView: HTMLDivElement;
+    $overlay: HTMLDivElement;
+    render(): void;
+    protected renderOverlay(): HTMLDivElement;
+    protected renderSlideContainer(): HTMLDivElement;
+    protected renderWhiteboardView(): HTMLDivElement;
+    mount(): this;
+    protected onError: ({ error, index }: {
+        error: Error;
+        index: number;
+    }) => void;
+    protected onRenderEnd: () => void;
+    protected refreshPages: () => void;
+    protected getPageIndex(page: number): number;
+    unmount(): this;
+    setReadonly(readonly: boolean): void;
+    destroy(): void;
+    toggleClickThrough(tool?: string): void;
+    protected scaleDocsToFit: () => void;
+    protected onPlay: () => void;
+    protected onNewPageIndex: (index: number) => void;
+    protected sideEffect: SideEffectManager;
+    protected wrapClassName(className: string): string;
+    protected namespace: string;
+    private getWhiteSnapshot;
+    private reportProgress;
+    private toPdf;
 }
 
-interface PreviewParams {
-    container: HTMLElement;
-    taskId: string;
-    url?: string;
-    debug?: boolean;
-}
-declare function previewSlide({ container, taskId, url, debug, }: PreviewParams): SlidePreviewer;
-declare class SlidePreviewer {
-    readonly viewer: DocsViewer;
-    readonly bgColor: string;
-    readonly target: HTMLElement;
-    slide: Slide | null;
-    debug: boolean;
-    $slide: HTMLDivElement;
-    private readonly sideEffect;
-    ready: boolean;
-    private resolveReady;
-    readonly readyPromise: Promise<void>;
-    constructor(config: {
-        target: HTMLElement;
-    });
-    render(): void;
-    /**
-     * In case you have a different window -- for example, in electron.
-     * Use this method to re-register hotkeys.
-     *
-     * @example
-     * previewer.registerHotKeys(windowLike)
-     */
-    registerHotKeys(windowLike: Window): void;
-    private hotkeyListener;
-    mount(taskId: string, url: string): void;
-    protected renderStyle(): HTMLElement;
-    protected registerEventListeners(): void;
-    protected onPageChanged: (page: number) => void;
-    protected onTransitionStart: () => void;
-    protected onTransitionEnd: () => void;
-    protected onError: ({ error }: {
-        error: Error;
-    }) => void;
-    private destroyed;
-    destroy(): void;
-    protected refreshPages: () => void;
-    protected getPageIndex(page: number): number;
-    protected renderSlideContainer(): HTMLDivElement;
-    protected onPlay: () => void;
-    protected onNewPageIndex: (index: number) => void;
-    protected wrapClassName(className: string): string;
-    protected namespace: string;
+interface PreviewParams {
+    container: HTMLElement;
+    taskId: string;
+    url?: string;
+    debug?: boolean;
+}
+declare function previewSlide({ container, taskId, url, debug, }: PreviewParams): SlidePreviewer;
+declare class SlidePreviewer {
+    readonly viewer: DocsViewer;
+    readonly bgColor: string;
+    readonly target: HTMLElement;
+    slide: Slide | null;
+    debug: boolean;
+    $slide: HTMLDivElement;
+    private readonly sideEffect;
+    ready: boolean;
+    private resolveReady;
+    readonly readyPromise: Promise<void>;
+    constructor(config: {
+        target: HTMLElement;
+    });
+    render(): void;
+    /**
+     * In case you have a different window -- for example, in electron.
+     * Use this method to re-register hotkeys.
+     *
+     * @example
+     * previewer.registerHotKeys(windowLike)
+     */
+    registerHotKeys(windowLike: Window): void;
+    private hotkeyListener;
+    mount(taskId: string, url: string): void;
+    protected renderStyle(): HTMLElement;
+    protected registerEventListeners(): void;
+    protected onPageChanged: (page: number) => void;
+    protected onTransitionStart: () => void;
+    protected onTransitionEnd: () => void;
+    protected onError: ({ error }: {
+        error: Error;
+    }) => void;
+    private destroyed;
+    destroy(): void;
+    protected refreshPages: () => void;
+    protected getPageIndex(page: number): number;
+    protected renderSlideContainer(): HTMLDivElement;
+    protected onPlay: () => void;
+    protected onNewPageIndex: (index: number) => void;
+    protected wrapClassName(className: string): string;
+    protected namespace: string;
 }
 
-declare const usePlugin: (plugin: any) => any;
-declare const version: string;
-
-interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCache" | "resourceTimeout" | "loaderDelegate" | "urlInterrupter" | "navigatorDelegate" | "fixedFrameSize" | "logger"> {
-    /** show debug controller */
-    debug?: boolean;
-    /** scale */
-    resolution?: number;
-    /** background color for slide animations */
-    bgColor?: string;
-    /** minimal fps @default 25 */
-    minFPS?: number;
-    /** maximal fps @default 30 */
-    maxFPS?: number;
-    /** automatically decrease fps @default true */
-    autoFPS?: boolean;
-    /** whether to re-scale automatically @default true */
-    autoResolution?: boolean;
-    /** 1~4, default: 3 */
-    maxResolutionLevel?: number;
-    /** use canvas2d mode, downside: some 3d effects are lost */
-    forceCanvas?: boolean;
-    /** fix windows 11 nvidia rendering bug, downside: render next page slows down */
-    enableNvidiaDetect?: boolean;
-    /** custom error handler */
-    onRenderError?: (error: Error, pageIndex: number) => void;
-    /** whether to show an overlay of error message @default: true */
-    showRenderError?: boolean;
-}
-interface ILogger {
-    info?(msg: string): void;
-    error?(msg: string): void;
-    warn?(msg: string): void;
-}
-interface AppResult {
-    viewer: () => SlideDocsViewer | null;
-    controller: () => SlideController | null | undefined;
-    slide: () => Slide | undefined;
-    position: () => [page: number, pageCount: number] | undefined;
-    nextStep: () => boolean;
-    prevStep: () => boolean;
-    nextPage: () => boolean;
-    prevPage: () => boolean;
-    jumpToPage: (page: number) => boolean;
-}
+declare const usePlugin: (plugin: any) => any;
+declare const version: string;
+
+interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCache" | "resourceTimeout" | "loaderDelegate" | "urlInterrupter" | "navigatorDelegate" | "fixedFrameSize" | "logger"> {
+    /** show debug controller */
+    debug?: boolean;
+    /** scale */
+    resolution?: number;
+    /** background color for slide animations */
+    bgColor?: string;
+    /** minimal fps @default 25 */
+    minFPS?: number;
+    /** maximal fps @default 30 */
+    maxFPS?: number;
+    /** automatically decrease fps @default true */
+    autoFPS?: boolean;
+    /** whether to re-scale automatically @default true */
+    autoResolution?: boolean;
+    /** 1~4, default: 3 */
+    maxResolutionLevel?: number;
+    /** use canvas2d mode, downside: some 3d effects are lost */
+    forceCanvas?: boolean;
+    /** fix windows 11 nvidia rendering bug, downside: render next page slows down */
+    enableNvidiaDetect?: boolean;
+    /** custom error handler */
+    onRenderError?: (error: Error, pageIndex: number) => void;
+    /** whether to show an overlay of error message @default: true */
+    showRenderError?: boolean;
+}
+interface ILogger {
+    info?(msg: string): void;
+    error?(msg: string): void;
+    warn?(msg: string): void;
+}
+interface AppResult {
+    viewer: () => SlideDocsViewer | null;
+    controller: () => SlideController | null | undefined;
+    slide: () => Slide | undefined;
+    position: () => [page: number, pageCount: number] | undefined;
+    nextStep: () => boolean;
+    prevStep: () => boolean;
+    nextPage: () => boolean;
+    prevPage: () => boolean;
+    jumpToPage: (page: number) => boolean;
+}
 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 };