@netless/fastboard-core 0.3.4-canary.0 → 0.3.4

package/dist/index.d.ts

@@ -0,0 +1,399 @@
+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';
+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';
+export { PreviewParams, default as SlideApp, Controller 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;
+interface Readable<T> {
+    readonly value: T;
+    subscribe(this: void, run: Subscriber<T>): Unsubscriber;
+    reaction(this: void, run: Subscriber<T>): Unsubscriber;
+}
+interface Writable<T> extends Readable<T> {
+    set(this: void, value: T): void;
+    update(this: void, updater: Updater<T>): void;
+}
+declare function readable<T>(value: T, start?: StartStopNotifier<T>): Readable<T>;
+declare function writable<T>(value: T, start: StartStopNotifier<T> | undefined, set: Subscriber<T>): Writable<T>;
+
+declare function getImageSize(url: string, fallback: Size): Promise<Size>;
+declare function makeSlideParams(scenes: SceneDefinition[]): {
+    scenes: SceneDefinition[];
+    taskId: string;
+    url: string;
+};
+declare function convertedFileToScene(f: ConvertedFile, i: number): SceneDefinition;
+
+declare function genUID(): string;
+
+declare const warnings: {
+    readonly "no-ppt-in-scenes": "You're probably inserting the slide app in a wrong way, there shouldn't exist `scenes[0].ppt`.";
+};
+declare function warn(id: keyof typeof warnings): void;
+
+declare class FastboardAppBase {
+    readonly sdk: WhiteWebSdk;
+    readonly room: Room;
+    readonly manager: WindowManager;
+    readonly hotKeys: Partial<HotKeys>;
+    constructor(sdk: WhiteWebSdk, room: Room, manager: WindowManager, hotKeys: Partial<HotKeys>);
+    protected _destroyed: boolean;
+    protected _assertNotDestroyed(): void;
+    protected _addRoomListener<K extends keyof RoomCallbacks>(name: K, listener: RoomCallbacks[K]): () => void;
+    protected _addManagerListener<K extends keyof PublicEvent>(name: K, listener: (value: PublicEvent[K]) => void): () => void;
+    protected _addMainViewListener<K extends keyof ViewCallbacks>(name: K, listener: ViewCallbacks[K]): () => void;
+    /**
+     * Destroy fastboard (disconnect from the whiteboard room).
+     */
+    destroy(): Promise<void>;
+}
+declare type RoomPhase = `${RoomPhase$1}`;
+
+/** pencil, eraser, rectangle... */
+declare type Appliance = `${ApplianceNames}`;
+/** triangle, star... */
+declare type Shape = `${ShapeType}`;
+/** Params for static docs, they are rendered as many images. */
+interface InsertDocsStatic {
+    readonly fileType: "pdf";
+    /** Unique string for binding whiteboard view to the doc. Must start with `/`. */
+    readonly scenePath: string;
+    /** @example [{ name: '1', ppt: { src: 'url/to/ppt/1.png' } }] */
+    readonly scenes: SceneDefinition[];
+    /** Window title. */
+    readonly title?: string;
+}
+/** Params for slides, they are rendered in @netless/app-slide with animations. */
+interface InsertDocsDynamic {
+    readonly fileType: "pptx";
+    /** Unique string for binding whiteboard view to the doc. Must start with `/`. */
+    readonly scenePath: string;
+    /** Conversion task id, see https://developer.netless.link/server-en/home/server-conversion#get-query-task-conversion-progress. */
+    readonly taskId: string;
+    /** Window title. */
+    readonly title?: string;
+    /** Where the slide resource placed. @default `https://convertcdn.netless.link/dynamicConvert` */
+    readonly url?: string;
+    /** @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;
+/** App download progress. */
+interface AppsStatus {
+    [kind: string]: {
+        status: "idle" | "loading" | "failed";
+        /** Exist if status is `failed`. */
+        reason?: string;
+    };
+}
+declare class FastboardApp extends FastboardAppBase {
+    /**
+     * Render this app to some DOM.
+     */
+    bindContainer(container: HTMLElement): void;
+    /**
+     * Move window-manager's collector to some place.
+     */
+    bindCollector(container: HTMLElement): void;
+    /**
+     * Is current room writable?
+     */
+    readonly writable: Writable<boolean>;
+    /**
+     * Is current room online?
+     */
+    readonly phase: Readable<"connecting" | "connected" | "reconnecting" | "disconnecting" | "disconnected">;
+    /**
+     * Current window-manager's windows' state (is it maximized?).
+     */
+    readonly boxState: Readable<"minimized" | "maximized" | "normal" | undefined>;
+    /**
+     * Current window-manager's focused app's id.
+     * @example "HelloWorld-1A2b3C4d"
+     */
+    readonly focusedApp: Readable<string | undefined>;
+    /**
+     * How many times can I call `app.redo()`?
+     */
+    readonly canRedoSteps: Readable<number>;
+    /**
+     * How many times can I call `app.undo()`?
+     */
+    readonly canUndoSteps: Readable<number>;
+    /**
+     * Current camera information of main view.
+     *
+     * Change the camera position by `app.moveCamera()`.
+     */
+    readonly camera: Readable<Camera>;
+    /**
+     * Current tool's info, like "is using pencil?", "what color?".
+     *
+     * Change the tool by `app.setAppliance()`.
+     */
+    readonly memberState: Readable<MemberState>;
+    /**
+     * 0..n-1, current index of main view scenes.
+     */
+    readonly sceneIndex: Writable<number>;
+    /**
+     * How many pages are in the main view?
+     */
+    readonly sceneLength: Readable<number>;
+    private _appsStatus;
+    /**
+     * Apps status.
+     */
+    readonly appsStatus: Readable<AppsStatus>;
+    /**
+     * Undo a step on main view.
+     */
+    undo(): void;
+    /**
+     * Redo a step on main view.
+     */
+    redo(): void;
+    /**
+     * Move current main view's camera position.
+     */
+    moveCamera(camera: Partial<Camera> & {
+        animationMode?: AnimationMode | undefined;
+    }): void;
+    /**
+     * Move current main view's camera to include a rectangle.
+     */
+    moveCameraToContain(rectangle: Rectangle & {
+        animationMode?: AnimationMode;
+    }): void;
+    /**
+     * Delete all things on the main view.
+     */
+    cleanCurrentScene(): void;
+    /**
+     * Set current tool, like "pencil".
+     */
+    setAppliance(appliance: ApplianceNames | Appliance, shape?: ShapeType | Shape): void;
+    /**
+     * Set pencil and shape's thickness.
+     */
+    setStrokeWidth(strokeWidth: number): void;
+    /**
+     * Set pencil and shape's color.
+     */
+    setStrokeColor(strokeColor: Color): void;
+    /**
+     * Set text size. Default is 16.
+     */
+    setTextSize(textSize: number): void;
+    /**
+     * Set text color.
+     *
+     * @example
+     * setTextColor([0x66, 0xcc, 0xff])
+     */
+    setTextColor(textColor: Color): void;
+    /**
+     * Goto previous page (the main whiteboard view).
+     */
+    prevPage(): Promise<boolean>;
+    /**
+     * Goto next page (the main whiteboard view).
+     */
+    nextPage(): Promise<boolean>;
+    /**
+     * Add one page to the main whiteboard view.
+     *
+     * @example
+     * addPage({ after: true }) // add one page right after current one.
+     * nextPage() // then, goto that page.
+     */
+    addPage(params?: AddPageParams): Promise<void>;
+    /**
+     * Remove one page at given index or current page (by default).
+     *
+     * Requires `@netless/window-manager` >= 0.4.30.
+     *
+     * @example
+     * removePage() // remove current page
+     */
+    removePage(index?: number): Promise<boolean>;
+    /**
+     * Insert an image to the main view.
+     *
+     * @example
+     * insertImage("https://i.imgur.com/CzXTtJV.jpg")
+     */
+    insertImage(url: string): Promise<void>;
+    /**
+     * Insert PDF/PPTX from conversion result.
+     * @param status https://developer.netless.link/server-en/home/server-conversion#get-query-task-conversion-progress
+     */
+    insertDocs(filename: string, status: ConversionResponse): Promise<string | undefined>;
+    /**
+     * Manual way.
+     * @example
+     * app.insertDocs({
+     *   fileType: 'pptx',
+     *   scenePath: `/pptx/${conversion.taskId}`,
+     *   taskId: conversion.taskId,
+     *   title: 'Title',
+     * })
+     */
+    insertDocs(params: InsertDocsParams): Promise<string | undefined>;
+    private _insertDocsImpl;
+    /**
+     * Insert the Media Player app.
+     */
+    insertMedia(title: string, src: string): Promise<string | undefined>;
+    /**
+     * Insert the Monaco Code Editor app.
+     * @deprecated Use `app.manager.addApp({ kind: 'Monaco' })` instead.
+     */
+    insertCodeEditor(): Promise<string | undefined>;
+    /**
+     * Insert the Countdown app.
+     * @deprecated Use `app.manager.addApp({ kind: 'Countdown' })` instead.
+     */
+    insertCountdown(): Promise<string | undefined>;
+    /**
+     * Insert the GeoGebra app.
+     * @deprecated Use `app.manager.addApp({ kind: 'GeoGebra' })` instead.
+     */
+    insertGeoGebra(): Promise<string | undefined>;
+}
+interface FastboardOptions {
+    sdkConfig: Omit<WhiteWebSdkConfiguration, "useMobXState"> & {
+        region: NonNullable<WhiteWebSdkConfiguration["region"]>;
+    };
+    joinRoom: Omit<JoinRoomParams, "useMultiViews" | "disableNewPencil" | "disableMagixEventDispatchLimit"> & {
+        callbacks?: Partial<RoomCallbacks>;
+    };
+    managerConfig?: Omit<MountParams, "room">;
+    netlessApps?: NetlessApp[];
+}
+/**
+ * Create a FastboardApp instance.
+ * @example
+ * let app = await createFastboard({
+ *   sdkConfig: {
+ *     appIdentifier: import.meta.env.VITE_APPID,
+ *     region: 'cn-hz',
+ *   },
+ *   joinRoom: {
+ *     uid: unique_id,
+ *     uuid: import.meta.env.VITE_ROOM_UUID,
+ *     roomToken: import.meta.env.VITE_ROOM_TOKEN,
+ *   },
+ * })
+ */
+declare function createFastboard({ sdkConfig, joinRoom: { callbacks, ...joinRoomParams }, managerConfig, netlessApps, }: FastboardOptions): Promise<FastboardApp>;
+
+declare class FastboardPlayerBase {
+    readonly sdk: WhiteWebSdk;
+    readonly player: Player;
+    readonly manager: WindowManager;
+    constructor(sdk: WhiteWebSdk, player: Player, manager: WindowManager);
+    protected _destroyed: boolean;
+    protected _assertNotDestroyed(): void;
+    protected _addPlayerListener<K extends keyof PlayerCallbacks>(name: K, listener: PlayerCallbacks[K]): () => void;
+    protected _addManagerListener<K extends keyof PublicEvent>(name: K, listener: (value: PublicEvent[K]) => void): () => void;
+    protected _addMainViewListener<K extends keyof ViewCallbacks>(name: K, listener: ViewCallbacks[K]): () => void;
+    destroy(): void;
+}
+declare type PlayerPhase = `${PlayerPhase$1}`;
+
+declare class FastboardPlayer extends FastboardPlayerBase {
+    /**
+     * Render this player to some DOM.
+     */
+    bindContainer(container: HTMLElement): void;
+    /**
+     * Move window-manager's collector to some place.
+     */
+    bindCollector(container: HTMLElement): void;
+    /**
+     * Player current time in milliseconds.
+     */
+    readonly currentTime: Writable<number>;
+    /**
+     * Player state, like "is it playing?".
+     */
+    readonly phase: Readable<"waitingFirstFrame" | "playing" | "pause" | "stop" | "ended" | "buffering">;
+    /**
+     * Will become true after buffering.
+     */
+    readonly canplay: Readable<boolean>;
+    private _setPlaybackRate;
+    /**
+     * Playback speed, default `1`.
+     */
+    readonly playbackRate: Writable<number>;
+    /**
+     * Playback duration in milliseconds.
+     */
+    readonly duration: Readable<number>;
+    /**
+     * Get state of room at that time, like "who was in the room?".
+     */
+    readonly state: Readable<PlayerState>;
+    /**
+     * Seek to some time in milliseconds.
+     */
+    seek(timestamp: number): Promise<PlayerSeekingResult>;
+    /**
+     * Change player state to playing.
+     */
+    play(): void;
+    /**
+     * Change player state to paused.
+     */
+    pause(): void;
+    /**
+     * Change player state to stopped.
+     */
+    stop(): void;
+    /**
+     * Set playback speed, a shortcut for `speed.set(x)`.
+     */
+    setPlaybackRate(value: number): void;
+}
+interface FastboardReplayOptions {
+    sdkConfig: Omit<WhiteWebSdkConfiguration, "useMobXState"> & {
+        region: NonNullable<WhiteWebSdkConfiguration["region"]>;
+    };
+    replayRoom: Omit<ReplayRoomParams, "useMultiViews"> & {
+        callbacks?: Partial<PlayerCallbacks>;
+    };
+    managerConfig?: Omit<MountParams, "room">;
+}
+/**
+ * Create a FastboardPlayer instance.
+ * @example
+ * let player = await replayFastboard({
+ *   sdkConfig: {
+ *     appIdentifier: import.meta.env.VITE_APPID,
+ *     region: 'cn-hz',
+ *   },
+ *   replayRoom: {
+ *     room: "room uuid",
+ *     roomToken: "NETLESSROOM_...",
+ *     beginTimestamp: 1646619090394,
+ *     duration: 70448,
+ *   },
+ * })
+ */
+declare function replayFastboard({ sdkConfig, replayRoom: { callbacks, ...replayRoomParams }, managerConfig, }: FastboardReplayOptions): Promise<FastboardPlayer>;
+
+interface AppsConfig {
+    [kind: string]: Omit<RegisterParams, "kind">;
+}
+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 };