@netless/fastboard-core 0.3.6 → 0.3.8-alpha.0

package/dist/index.d.ts

@@ -1,15 +1,15 @@
-import { Size, SceneDefinition, ConvertedFile, RoomPhase as RoomPhase$1, ApplianceNames, ShapeType, MemberState, RoomState, Camera, AnimationMode, Rectangle, Color, ConversionResponse, WhiteWebSdkConfiguration, JoinRoomParams, RoomCallbacks, WhiteWebSdk, Room, HotKeys, ViewCallbacks, PlayerPhase as PlayerPhase$1, PlayerState, PlayerSeekingResult, ReplayRoomParams, PlayerCallbacks, Player } from 'white-web-sdk';
+import { Size, SceneDefinition, ConvertedFile, RoomPhase as RoomPhase$1, ApplianceNames, ShapeType, MemberState, RoomState, Camera, AnimationMode, Rectangle, Color, ConversionResponse, WhiteWebSdkConfiguration, JoinRoomParams, RoomCallbacks, WhiteWebSdk, Room, HotKeys, ViewCallbacks, PlayerPhase as PlayerPhase$1, PlayerState, PlayerSeekingResult, ReplayRoomParams, PlayerCallbacks, Player, View } from 'white-web-sdk';
 export { AnimationMode, ApplianceNames, Camera, Color, ConversionResponse, HotKey, HotKeys, JoinRoomParams, MemberState, PlayerSeekingResult, Rectangle, Room, RoomCallbacks, RoomState, SceneDefinition, ShapeType, ViewCallbacks, WhiteWebSdk, WhiteWebSdkConfiguration } from 'white-web-sdk';
 import { AddPageParams, MountParams, NetlessApp, WindowManager, PublicEvent, RegisterParams } from '@netless/window-manager';
 export { AddPageParams, MountParams, NetlessApp, PublicEvent, WindowManager } from '@netless/window-manager';
 import { SyncedStore } from '@netless/synced-store';
 export { Diff, DiffOne, Storage, SyncedStore } from '@netless/synced-store';
-export { PreviewParams, default as SlideApp, Controller as SlideController, AppOptions as SlideOptions, SlidePreviewer, addHooks as addSlideHooks, previewSlide, apps as slideApps } from '@netless/app-slide';
+export { PreviewParams, default as SlideApp, AppResult as SlideController, AppOptions as SlideOptions, SlidePreviewer, addHooks as addSlideHooks, previewSlide, apps as slideApps } from '@netless/app-slide';
 
-declare type Subscriber<T> = (value: T) => void;
-declare type Unsubscriber = () => void;
-declare type Updater<T> = (value: T) => T;
-declare type StartStopNotifier<T> = (set: Subscriber<T>) => Unsubscriber | void;
+type Subscriber<T> = (value: T) => void;
+type Unsubscriber = () => void;
+type Updater<T> = (value: T) => T;
+type StartStopNotifier<T> = (set: Subscriber<T>) => Unsubscriber | void;
 interface Readable<T> {
     readonly value: T;
     subscribe(this: void, run: Subscriber<T>): Unsubscriber;
@@ -37,7 +37,7 @@ declare const warnings: {
 };
 declare function warn(id: keyof typeof warnings): void;
 
-declare class FastboardAppBase<TEventData = any> {
+declare class FastboardAppBase<TEventData extends Record<string, any> = any> {
     readonly sdk: WhiteWebSdk;
     readonly room: Room;
     readonly manager: WindowManager;
@@ -54,12 +54,12 @@ declare class FastboardAppBase<TEventData = any> {
      */
     destroy(): Promise<void>;
 }
-declare type RoomPhase = `${RoomPhase$1}`;
+type RoomPhase = `${RoomPhase$1}`;
 
 /** pencil, eraser, rectangle... */
-declare type Appliance = `${ApplianceNames}`;
+type Appliance = `${ApplianceNames}`;
 /** triangle, star... */
-declare type Shape = `${ShapeType}`;
+type Shape = `${ShapeType}`;
 /** Params for static docs, they are rendered as many images. */
 interface InsertDocsStatic {
     readonly fileType: "pdf";
@@ -84,9 +84,32 @@ interface InsertDocsDynamic {
     /** @example [{ name: '1' }, { name: '2' }, { name: '3' }] */
     readonly scenes?: SceneDefinition[];
 }
-declare type InsertDocsParams = InsertDocsStatic | InsertDocsDynamic;
-declare type SetMemberStateFn = (partialMemberState: Partial<MemberState>) => void;
-declare type RoomStateChanged = (diff: Partial<RoomState>) => void;
+type InsertDocsParams = InsertDocsStatic | InsertDocsDynamic;
+interface ProjectorResponse {
+    uuid: string;
+    status: "Waiting" | "Converting" | "Finished" | "Fail";
+    type: "dynamic" | "static";
+    /** 0..100 */
+    convertedPercentage: number;
+    /** https://example.org/path/to/dynamicConvert, only when type=dynamic */
+    prefix?: string;
+    pageCount?: number;
+    /** {1:"{prefix}/{taskId}/preview/1.png"}, only when type=dynamic and preview=true */
+    previews?: Record<number, string>;
+    /** {prefix}/{taskId}/jsonOutput/note.json */
+    note?: string;
+    /** {1:{width,height,url}}, only when type=static */
+    images?: Record<number, {
+        width: number;
+        height: number;
+        url: string;
+    }>;
+    /** 20xxxxx */
+    errorCode?: string;
+    errorMessage?: string;
+}
+type SetMemberStateFn = (partialMemberState: Partial<MemberState>) => void;
+type RoomStateChanged = (diff: Partial<RoomState>) => void;
 /** App download progress. */
 interface AppsStatus {
     [kind: string]: {
@@ -95,7 +118,7 @@ interface AppsStatus {
         reason?: string;
     };
 }
-declare class FastboardApp<TEventData = any> extends FastboardAppBase<TEventData> {
+declare class FastboardApp<TEventData extends Record<string, any> = any> extends FastboardAppBase<TEventData> {
     /**
      * Render this app to some DOM.
      */
@@ -149,7 +172,6 @@ declare class FastboardApp<TEventData = any> extends FastboardAppBase<TEventData
      * How many pages are in the main view?
      */
     readonly sceneLength: Readable<number>;
-    private _appsStatus;
     /**
      * Apps status.
      */
@@ -238,6 +260,11 @@ declare class FastboardApp<TEventData = any> extends FastboardAppBase<TEventData
      * @param status https://developer.netless.link/server-en/home/server-conversion#get-query-task-conversion-progress
      */
     insertDocs(filename: string, status: ConversionResponse): Promise<string | undefined>;
+    /**
+     * Insert PDF/PPTX from projector conversion result.
+     * @param response https://developer.netless.link/server-zh/home/server-projector#get-%E6%9F%A5%E8%AF%A2%E4%BB%BB%E5%8A%A1%E8%BD%AC%E6%8D%A2%E8%BF%9B%E5%BA%A6
+     */
+    insertDocs(filename: string, response: ProjectorResponse): Promise<string | undefined>;
     /**
      * Manual way.
      * @example
@@ -249,7 +276,6 @@ declare class FastboardApp<TEventData = any> extends FastboardAppBase<TEventData
      * })
      */
     insertDocs(params: InsertDocsParams): Promise<string | undefined>;
-    private _insertDocsImpl;
     /**
      * Insert the Media Player app.
      */
@@ -275,7 +301,7 @@ interface FastboardOptions {
         region: NonNullable<WhiteWebSdkConfiguration["region"]>;
     };
     joinRoom: Omit<JoinRoomParams, "useMultiViews" | "disableNewPencil" | "disableMagixEventDispatchLimit"> & {
-        callbacks?: Partial<RoomCallbacks>;
+        callbacks?: Partial<Omit<RoomCallbacks, "onCanRedoStepsUpdate" | "onCanUndoStepsUpdate">>;
     };
     managerConfig?: Omit<MountParams, "room">;
     netlessApps?: NetlessApp[];
@@ -295,9 +321,9 @@ interface FastboardOptions {
  *   },
  * })
  */
-declare function createFastboard<TEventData = any>({ sdkConfig, joinRoom: { callbacks, ...joinRoomParams }, managerConfig, netlessApps, }: FastboardOptions): Promise<FastboardApp<TEventData>>;
+declare function createFastboard<TEventData extends Record<string, any> = any>({ sdkConfig, joinRoom: { callbacks, ...joinRoomParams }, managerConfig, netlessApps, }: FastboardOptions): Promise<FastboardApp<TEventData>>;
 
-declare class FastboardPlayerBase<TEventData = any> {
+declare class FastboardPlayerBase<TEventData extends Record<string, any> = any> {
     readonly sdk: WhiteWebSdk;
     readonly player: Player;
     readonly manager: WindowManager;
@@ -310,9 +336,9 @@ declare class FastboardPlayerBase<TEventData = any> {
     protected _addMainViewListener<K extends keyof ViewCallbacks>(name: K, listener: ViewCallbacks[K]): () => void;
     destroy(): void;
 }
-declare type PlayerPhase = `${PlayerPhase$1}`;
+type PlayerPhase = `${PlayerPhase$1}`;
 
-declare class FastboardPlayer<TEventData = any> extends FastboardPlayerBase<TEventData> {
+declare class FastboardPlayer<TEventData extends Record<string, any> = any> extends FastboardPlayerBase<TEventData> {
     /**
      * Render this player to some DOM.
      */
@@ -333,7 +359,6 @@ declare class FastboardPlayer<TEventData = any> extends FastboardPlayerBase<TEve
      * Will become true after buffering.
      */
     readonly canplay: Readable<boolean>;
-    private _setPlaybackRate;
     /**
      * Playback speed, default `1`.
      */
@@ -393,7 +418,7 @@ interface FastboardReplayOptions {
  *   },
  * })
  */
-declare function replayFastboard<TEventData = any>({ sdkConfig, replayRoom: { callbacks, ...replayRoomParams }, managerConfig, netlessApps, }: FastboardReplayOptions): Promise<FastboardPlayer<TEventData>>;
+declare function replayFastboard<TEventData extends Record<string, any> = any>({ sdkConfig, replayRoom: { callbacks, ...replayRoomParams }, managerConfig, netlessApps, }: FastboardReplayOptions): Promise<FastboardPlayer<TEventData>>;
 
 interface AppsConfig {
     [kind: string]: Omit<RegisterParams, "kind">;
@@ -401,4 +426,34 @@ interface AppsConfig {
 declare const register: typeof WindowManager.register;
 declare const version: string;
 
-export { Appliance, AppsConfig, AppsStatus, FastboardApp, FastboardOptions, FastboardPlayer, FastboardReplayOptions, InsertDocsDynamic, InsertDocsParams, InsertDocsStatic, PlayerPhase, Readable, RoomPhase, RoomStateChanged, SetMemberStateFn, Shape, StartStopNotifier, Subscriber, Unsubscriber, Updater, Writable, convertedFileToScene, createFastboard, genUID, getImageSize, makeSlideParams, readable, register, replayFastboard, version, warn, writable };
+declare function addRoomListener<K extends keyof RoomCallbacks>(room: Room, name: K, listener: RoomCallbacks[K]): () => void;
+declare function addPlayerListener<K extends keyof PlayerCallbacks>(player: Player, name: K, listener: PlayerCallbacks[K]): () => void;
+declare function addViewListener<K extends keyof ViewCallbacks>(view: View, name: K, listener: (value: ViewCallbacks[K]) => void): () => void;
+declare function addManagerListener<K extends keyof PublicEvent>(manager: WindowManager, name: K, listener: (value: PublicEvent[K]) => void): () => void;
+
+interface 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;
+}
+/**
+ * Send specific command to the static docs / slide app.
+ * Only works for apps that were created by `insertDocs()`.
+ *
+ * Returns false if failed to find the app or not writable.
+ *
+ * For static docs, `nextPage` equals to `nextStep`, as with `prevPage` and `prevStep`.
+ *
+ * @example
+ * ```js
+ * // send "next page" to the focused app
+ * dispatchDocsEvent(fastboard, "nextPage")
+ *
+ * // send "prev page" to some app
+ * dispatchDocsEvent(fastboard, "prevPage", {appId:"Slide-1a2b3c4d"})
+ * ```
+ */
+declare function dispatchDocsEvent(fastboard: FastboardApp | WindowManager, event: "prevPage" | "nextPage" | "prevStep" | "nextStep" | "jumpToPage", options?: DocsEventOptions): boolean;
+
+export { Appliance, AppsConfig, AppsStatus, DocsEventOptions, FastboardApp, FastboardOptions, FastboardPlayer, FastboardReplayOptions, InsertDocsDynamic, InsertDocsParams, InsertDocsStatic, PlayerPhase, ProjectorResponse, Readable, RoomPhase, RoomStateChanged, SetMemberStateFn, Shape, StartStopNotifier, Subscriber, Unsubscriber, Updater, Writable, addManagerListener, addPlayerListener, addRoomListener, addViewListener, convertedFileToScene, createFastboard, dispatchDocsEvent, genUID, getImageSize, makeSlideParams, readable, register, replayFastboard, version, warn, writable };