@netless/window-manager 1.0.14 → 1.0.16

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as lodash from 'lodash';
 import * as white_web_sdk from 'white-web-sdk';
-import { SceneDefinition, SceneState, DisplayerState, View, ApplianceNames, ViewVisionMode, CameraState, RoomMember, Camera, Size, Event as Event$1, Scope, EventPhase, MagixEventListenerOptions as MagixEventListenerOptions$1, toJS, listenUpdated, unlistenUpdated, listenDisposed, unlistenDisposed, Room, ViewMode, Displayer, MemberState, Logger, AnimationMode, InvisiblePlugin, InvisiblePluginContext, Player, Rectangle, Point, CameraBound, ImageInformation } from 'white-web-sdk';
+import { SceneDefinition, SceneState, DisplayerState, View, ApplianceNames, ViewVisionMode, CameraState, RoomMember, Camera, Size, Event as Event$1, Scope, EventPhase, MagixEventListenerOptions as MagixEventListenerOptions$1, toJS, listenUpdated, unlistenUpdated, listenDisposed, unlistenDisposed, Room, ViewMode, Displayer, MemberState, Logger as Logger$1, AnimationMode, InvisiblePlugin, InvisiblePluginContext, Player, Rectangle, Point, CameraBound, ImageInformation } from 'white-web-sdk';
 export { AnimationMode, Displayer, Player, Room, SceneDefinition, SceneState, View } from 'white-web-sdk';
 import { TELE_BOX_STATE, TeleBoxRect, TeleBoxState, TeleBoxColorScheme, NotMinimizedBoxState, TeleBoxManager, TeleBoxCollector, ReadonlyTeleBox, TeleBoxManagerUpdateConfig, TeleBoxConfig } from '@netless/telebox-insider';
 export { ReadonlyTeleBox, TeleBoxCollector, TeleBoxManager, TeleBoxRect } from '@netless/telebox-insider';
@@ -999,7 +999,7 @@ declare class ArgusLog {
     /** debounce 窗口内 safeUpdateAttributes：同 keys 数组则只更新 value，否则追加一段，flush 时拼成一条 */
     private pendingUpdateSegments;
     private updateMergeTimer;
-    constructor(logger: Logger, name: string, debounceTime?: number | undefined);
+    constructor(logger: Logger$1, name: string, debounceTime?: number | undefined);
     private emitInfo;
     private flush;
     private flushShallowMerge;
@@ -1025,6 +1025,69 @@ declare class ArgusLog {
     dispose(): void;
 }
 
+interface PresentationPage {
+    src: string;
+    width: number;
+    height: number;
+    thumbnail?: string | undefined;
+    name?: string;
+}
+interface ScrollbarEventCallback {
+    onScrollbarDragStart?: () => void;
+    onScrollbarDragEnd?: () => void;
+    onScrollbarDragX?: (x: number) => void;
+    onScrollbarDragY?: (y: number) => void;
+    onScrollCameraUpdated?: (appid: string, originScale: number, scale: number) => void;
+}
+
+type Logger = (...data: any[]) => void;
+interface Viewport {
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
+}
+interface PresentationAppOptions {
+    /** Disables user move / scale the image and whiteboard. */
+    disableCameraTransform?: boolean;
+    /** Max scale = `maxCameraScale` * default scale. Not working when `disableCameraTransform` is true. Default: 3 */
+    maxCameraScale?: number;
+    /** Custom logger. Default: a logger that reports to the whiteboard server. */
+    log?: Logger;
+    /** Custom thumbnail generator. Default is appending `"?x-oss-process=image/resize,l_50"` to `src`. */
+    thumbnail?: (src: string) => string;
+    /**
+     * Custom viewport to set on the first time the presentation was added. Default is full page.
+     * Numbers range in 0 to 1 is considered a ratio to multiply the real page size.
+     * Example settings:
+     *
+     * - Full page: `{ x: 0, y: 0, width: 1, height: 1 }`
+     * - Half page: `{ x: 0, y: 0, width: 1, height: 0.5 }`
+     * - Absolute top-left area of the page: `{ x: 0, y: 0, width: 100, height: 100 }`
+     */
+    viewport?: Viewport | ((page: PresentationPage) => Viewport);
+    /** justDocsViewReadonly is used to set the presentation readonly, it will be used in the presentation, and the presentation will be readonly when the app is initialized */
+    justDocsViewReadonly?: true;
+    /** useScrollbar is used to set the presentation use scrollbar, it will be used in the presentation, and the presentation will be use scrollbar when the app is initialized */
+    useScrollbar?: boolean;
+    /** 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 BuiltinAppOptions {
+    Presentation?: PresentationAppOptions;
+}
+declare const BuiltinApps: {
+    DocsViewer: string;
+    MediaPlayer: string;
+    Presentation: string;
+};
+
 declare class AppListeners {
     private manager;
     private displayer;
@@ -1224,11 +1287,6 @@ type ExtendClass = {
 };
 declare function getExtendClass<T extends ExtendClassAble>(baseClass: T, extendClass?: ExtendClass): T;
 
-declare const BuiltinApps: {
-    DocsViewer: string;
-    MediaPlayer: string;
-};
-
 type WindowMangerAttributes = {
     modelValue?: string;
     boxState: TELE_BOX_STATE;
@@ -1247,6 +1305,15 @@ type AddAppOptions = {
 type setAppOptions = AddAppOptions & {
     appOptions?: any;
 };
+type DocsEvent = "prevPage" | "nextPage" | "prevStep" | "nextStep" | "jumpToPage" | "scalePage";
+type DocsEventOptions = {
+    /** If provided, will dispatch to the specific app. Default to the focused app. */
+    appId?: string;
+    /** Used by `jumpToPage` event, range from 1 to total pages count. */
+    page?: number;
+    /** Used by `scalePage` event. Range from 1 to 4, decimals allowed. `1` means default fitted size. */
+    scale?: number;
+};
 type AddAppParams<TAttributes = any> = {
     kind: string;
     src?: string;
@@ -1334,6 +1401,8 @@ type MountParams = {
     supportAppliancePlugin?: boolean;
     /** 是否使用 boxesStatus 状态管理窗口 */
     useBoxesStatus?: boolean;
+    /** Local Presentation options applied before restoring apps. Not synchronized. */
+    builtinAppOptions?: BuiltinAppOptions;
 };
 declare const reconnectRefresher: ReconnectRefresher;
 declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any> implements PageController {
@@ -1362,6 +1431,7 @@ declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
     private _cursorUIDs;
     private _cursorUIDsStyleDOM?;
     _appliancePlugin?: any;
+    builtinAppOptions?: BuiltinAppOptions;
     private boxManager?;
     private static params?;
     static extendClass?: ExtendClass$1;
@@ -1370,7 +1440,7 @@ declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
     private extendPluginManager?;
     private _roomLogger?;
     attributesDeboundceLog?: ArgusLog;
-    get Logger(): Logger | undefined;
+    get Logger(): Logger$1 | undefined;
     constructor(context: InvisiblePluginContext);
     static onCreate(manager: WindowManager): void;
     static mount(params: MountParams, extendClass?: ExtendClass$1): Promise<WindowManager>;
@@ -1388,6 +1458,7 @@ declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
      * 注销插件
      */
     static unregister(kind: string): void;
+    resolveAppOptions(kind: string, registeredOptions?: any | (() => any)): any | (() => any);
     /**
      * 创建一个 app 至白板
      */
@@ -1489,6 +1560,13 @@ declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
      * 查询单个 App
      */
     queryOne(appId: string): AppProxy | undefined;
+    /**
+     * Send specific command to DocsViewer / Presentation / Slide app.
+     *
+     * Static docs and Presentation do not have animation steps, so `prevStep` / `nextStep`
+     * are treated as `prevPage` / `nextPage`.
+     */
+    dispatchDocsEvent(event: DocsEvent, options?: DocsEventOptions): boolean;
     /**
      * 关闭 APP
      */
@@ -1536,4 +1614,4 @@ declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes, any>
 }
 
 export { AppContext, AppCreateError, AppManager, AppManagerNotInitError, AppNotRegisterError, AppProxy, AttributesDelegate, BindContainerRoomPhaseInvalidError, BoxManager, BoxManagerNotFoundError, BoxNotCreatedError, BuiltinApps, CursorManager, ExtendPlugin, ExtendPluginManager, InvalidScenePath, ParamsInvalidError, Storage, WhiteWebSDKInvalidError, WindowManager, calculateNextIndex, getExtendClass, reconnectRefresher };
-export type { AddAppOptions, AddAppParams, AddPageParams, AppEmitterEvent, AppInitState, AppListenerKeys, AppPayload, AppSyncAttributes, ApplianceIcons, BaseInsertParams, CursorMovePayload, CursorOptions, ExtendClass, ExtendClassAble, ExtendContext, ExtendManagerOptions, ExtendPluginInstance, MountParams, NetlessApp, PageController, PageRemoveService, PageState, PublicEvent, RegisterEventData, RegisterEvents, RegisterParams, StorageStateChangedEvent, StorageStateChangedListener, WindowMangerAttributes, apps, setAppOptions };
+export type { AddAppOptions, AddAppParams, AddPageParams, AppEmitterEvent, AppInitState, AppListenerKeys, AppPayload, AppSyncAttributes, ApplianceIcons, BaseInsertParams, BuiltinAppOptions, CursorMovePayload, CursorOptions, DocsEvent, DocsEventOptions, ExtendClass, ExtendClassAble, ExtendContext, ExtendManagerOptions, ExtendPluginInstance, MountParams, NetlessApp, PageController, PageRemoveService, PageState, PublicEvent, RegisterEventData, RegisterEvents, RegisterParams, StorageStateChangedEvent, StorageStateChangedListener, WindowMangerAttributes, apps, setAppOptions };