@netless/app-presentation 0.1.9-beta.5 → 0.1.9-beta.7

package/build.ts

@@ -68,6 +68,9 @@ let bundle = await rollup.rollup({
         },
         external: Object.keys({
           '@netless/window-manager': '*',
+          '@netless/appliance-plugin': '*',
+          '@netless/fastboard': '*',
+          'white-web-sdk': '*',
           ...peerDependencies,
         })
       })

package/dist/index.d.ts

@@ -1,13 +1,12 @@
-import { View, AppContext, NetlessApp, WindowManager } from '@netless/window-manager';
+import { View, NetlessApp, AppContext, WindowManager } from '@netless/window-manager';
+import * as lodash from 'lodash';
 
 /**
- * A function that can be called to dispose resources.
- */
-type Disposer<T = any> = () => T;
-/**
- * An object that has a `dispose` method to dispose resources.
+ * A combination of {@link Disposer} and {@link IDisposable}.
+ * It can be called to dispose resources or call the `dispose` method to dispose resources.
  */
-interface IDisposable<T = any> {
+interface DisposableDisposer<T = any> {
+    (): T;
     dispose(): T;
 }
 /**
@@ -15,11 +14,13 @@ interface IDisposable<T = any> {
  */
 type DisposableType<T = any> = Disposer<T> | IDisposable<T>;
 /**
- * A combination of {@link Disposer} and {@link IDisposable}.
- * It can be called to dispose resources or call the `dispose` method to dispose resources.
+ * A function that can be called to dispose resources.
  */
-interface DisposableDisposer<T = any> {
-    (): T;
+type Disposer<T = any> = () => T;
+/**
+ * An object that has a `dispose` method to dispose resources.
+ */
+interface IDisposable<T = any> {
     dispose(): T;
 }
 
@@ -35,13 +36,13 @@ interface DisposableDisposer<T = any> {
  */
 interface DisposableStore extends DisposableDisposer {
     /**
-     * Flush and clear all of the {@link Disposer}s and {@link IDisposable}s in the store.
+     * @internal
      */
-    (): void;
+    _disposables_?: Set<DisposableType>;
     /**
-     * Get the number of {@link DisposableType}s in the store.
+     * Flush and clear all of the {@link Disposer}s and {@link IDisposable}s in the store.
      */
-    size(): number;
+    (): void;
     /**
      * Add a {@link DisposableType} to the store.
      *
@@ -69,6 +70,23 @@ interface DisposableStore extends DisposableDisposer {
      * @returns The same array of {@link DisposableType}s.
      */
     add<T extends DisposableType>(disposables: T | T[]): T | T[];
+    /**
+     * Flush and clear all of the {@link Disposer}s and {@link IDisposable}s in the store.
+     */
+    dispose(this: void): void;
+    /**
+     * Invoke the {@link DisposableType} and remove it from the store at the specific key.
+     *
+     * @param disposable The {@link DisposableType} to be flushed. Flush all if omitted.
+     */
+    flush(disposable?: DisposableType): void;
+    /**
+     * Check if a {@link DisposableType} is in the store.
+     *
+     * @param disposable The {@link DisposableType}.
+     * @returns `true` if the {@link DisposableType} is in the store, otherwise `false`.
+     */
+    has(disposable: DisposableType): boolean;
     /**
      * Invoke the executor function and add the returned {@link DisposableType} to the store.
      *
@@ -83,10 +101,10 @@ interface DisposableStore extends DisposableDisposer {
      *
      * Do nothing if `null | undefined` is returned or the returned {@link DisposableType} is already in the store.
      *
-     * @param executor A function that returns either a {@link DisposableType} or `null`.
-     * @returns The returned {@link DisposableType}, or `undefined` if the executor returns `null`.
+     * @param executor A function that returns either a {@link DisposableType} or `undefined | null`.
+     * @returns The returned {@link DisposableType}, or `undefined` if the executor returns `undefined | null`.
      */
-    make<T extends DisposableType>(executor: () => T | null | undefined | void): T | void;
+    make<T extends DisposableType>(executor: () => null | T | undefined | void): T | void;
     /**
      * Invoke the executor function and add each {@link DisposableType} in the returned array to the store.
      *
@@ -104,7 +122,7 @@ interface DisposableStore extends DisposableDisposer {
      * @param executor A function that returns either an array of {@link DisposableType}s or `undefined | null`.
      * @returns The returned array of {@link DisposableType}s, or `undefined` if the executor returns `undefined | null`.
      */
-    make<T extends DisposableType[]>(executor: () => T | null | void | undefined): T | void;
+    make<T extends DisposableType[]>(executor: () => null | T | undefined | void): T | void;
     /**
      * Invoke the executor function and the returned {@link DisposableType}s to the store. Do nothing if `undefined | null` is returned.
      *
@@ -113,31 +131,18 @@ interface DisposableStore extends DisposableDisposer {
      * @param executor A function that returns either an array of {@link DisposableType}s or `undefined | null`.
      * @returns The returned array of {@link DisposableType}s, or `undefined` if the executor returns `undefined | null`.
      */
-    make<T extends DisposableType>(executor: () => T | T[] | null | void | undefined): T | T[] | void;
-    /**
-     * Check if a {@link DisposableType} is in the store.
-     *
-     * @param disposable The {@link DisposableType}.
-     * @returns `true` if the {@link DisposableType} is in the store, otherwise `false`.
-     */
-    has(disposable: DisposableType): boolean;
+    make<T extends DisposableType>(executor: () => null | T | T[] | undefined | void): T | T[] | void;
     /**
      * Remove the {@link DisposableType} from the store. Does not invoke the removed {@link DisposableType}.
      *
-     * @param disposable The {@link DisposableType} to be flushed.
+     * @param disposable The {@link DisposableType} to be removed.
      * @returns `true` if the {@link DisposableType} is found and removed, otherwise `false`.
      */
     remove(disposable: DisposableType): boolean;
     /**
-     * Invoke the {@link DisposableType} and remove it from the store at the specific key.
-     *
-     * @param disposable The {@link DisposableType} to be flushed. Flush all if omitted.
-     */
-    flush(disposable?: DisposableType): void;
-    /**
-     * Flush and clear all of the {@link Disposer}s and {@link IDisposable}s in the store.
+     * Get the number of {@link DisposableType}s in the store.
      */
-    dispose(this: void): void;
+    size(): number;
 }
 
 interface ILazyLoadInstance {
@@ -304,8 +309,18 @@ declare class Presentation implements IDisposable<void> {
     private isEditable;
 }
 
-declare const __inline: string;
-
+interface ScrollbarOption {
+    appId: string;
+    readonly?: boolean;
+    getPageSize: () => {
+        width: number;
+        height: number;
+    };
+    getWritable: () => boolean;
+    getOriginScale: () => number;
+    syncView: () => void;
+    scrollbarEventCallback?: ScrollbarEventCallback;
+}
 interface ScrollbarEventCallback {
     onScrollbarDragStart?: () => void;
     onScrollbarDragEnd?: () => void;
@@ -313,6 +328,55 @@ interface ScrollbarEventCallback {
     onScrollbarDragY?: (y: number) => void;
     onScrollCameraUpdated?: (appid: string, originScale: number, scale: number) => void;
 }
+declare class Scrollbar {
+    readonly namespace = "netless-app-presentation";
+    readonly appId: string;
+    private container;
+    private scrollContainer;
+    private option;
+    private view;
+    private scrollbarContainerX?;
+    private scrollbarContainerY?;
+    private scrollbarX?;
+    private scrollbarY?;
+    private draggableX?;
+    private draggableY?;
+    private cameraCache?;
+    private readonly;
+    constructor(container: HTMLElement, option: ScrollbarOption, view: View);
+    private c;
+    setReadonly(bol: boolean): void;
+    onCameraUpdated: lodash.DebouncedFunc<() => void>;
+    onDragStart: () => void;
+    getScrollXRange(camera: {
+        scale: number;
+    }): {
+        minX: number;
+        maxX: number;
+    };
+    getScrollYRange(camera: {
+        scale: number;
+    }): {
+        minY: number;
+        maxY: number;
+    };
+    onDragX: (transformedDrag: {
+        x: number;
+        y: number;
+    }) => void;
+    onDragY: (transformedDrag: {
+        x: number;
+        y: number;
+    }) => void;
+    onDragEnd: () => void;
+    private init;
+    destroy(): void;
+    moveCamera: (camera: {
+        centerX: number;
+        centerY: number;
+        scale: number;
+    }) => void;
+}
 
 type Logger = (...data: any[]) => void;
 interface Viewport {
@@ -347,6 +411,10 @@ interface PresentationAppOptions {
     /** debounceSync is used to set the presentation debounce sync, it will be used in the presentation, and the presentation will be debounce sync when the app is initialized */
     debounceSync?: boolean;
     scrollbarEventCallback?: ScrollbarEventCallback;
+    /** goToPageByClick is used to set the presentation go to page by click, it will be used in the presentation, and the presentation will be go to page by click when the app is initialized */
+    goToPageByClick?: boolean;
+    /** useClipView is used to set the presentation use clip view, it will be used in the presentation, and the presentation will be use clip view when the app is initialized */
+    useClipView?: boolean;
 }
 interface PresentationController {
     readonly app: Presentation;
@@ -382,8 +450,14 @@ interface PresentationController {
     getOriginScale: () => number;
     /** get the view scale */
     getScale: () => number;
+    /** get the page size */
+    getPageSize: () => {
+        width: number;
+        height: number;
+    };
+    /** screenshot the current page */
+    screenshotCurrentPageAsync: (context: CanvasRenderingContext2D, width?: number, height?: number) => Promise<void>;
 }
-
 declare const NetlessAppPresentation: NetlessApp<{}, {}, PresentationAppOptions, PresentationController>;
 type RegisterFn = typeof WindowManager["register"];
 interface InstallOptions {
@@ -409,4 +483,5 @@ declare const install: (register: RegisterFn, options?: InstallOptions) => Promi
 
 declare const version: string;
 
-export { type InstallOptions, type Logger, NetlessAppPresentation, Presentation, type PresentationAppOptions, type PresentationConfig, type PresentationController, type PresentationPage, type RegisterFn, NetlessAppPresentation as default, install, __inline as styles, version };
+export { NetlessAppPresentation, Presentation, Scrollbar, NetlessAppPresentation as default, install, version };
+export type { InstallOptions, Logger, PresentationAppOptions, PresentationConfig, PresentationController, PresentationPage, RegisterFn, ScrollbarEventCallback, ScrollbarOption };