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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netless/fastboard-core",
-  "version": "0.3.3",
+  "version": "0.3.4-canary.0",
   "description": "A tiny wrapper of white-web-sdk and @netless/window-manager.",
   "main": "dist/index.js",
   "files": [
@@ -9,7 +9,7 @@
   ],
   "repository": "netless-io/fastboard",
   "dependencies": {
-    "@netless/app-slide": "^0.2.0"
+    "@netless/app-slide": "^0.2.1"
   },
   "peerDependencies": {
     "@netless/window-manager": ">=0.4.0",

package/src/impl/FastboardApp.ts

@@ -176,8 +176,8 @@ export class FastboardApp extends FastboardAppBase {
   readonly writable = writable(
     this.room.isWritable,
     set => {
-      this._addRoomListener("onEnableWriteNowChanged", () => set(this.room.isWritable));
       set(this.room.isWritable);
+      return this._addRoomListener("onEnableWriteNowChanged", () => set(this.room.isWritable));
     },
     this.room.setWritable.bind(this.room)
   );
@@ -186,16 +186,16 @@ export class FastboardApp extends FastboardAppBase {
    * Is current room online?
    */
   readonly phase = readable<RoomPhase>(this.room.phase, set => {
-    this._addRoomListener("onPhaseChanged", set);
     set(this.room.phase);
+    return this._addRoomListener("onPhaseChanged", set);
   });
 
   /**
    * Current window-manager's windows' state (is it maximized?).
    */
   readonly boxState = readable(this.manager.boxState, set => {
-    this._addManagerListener("boxStateChange", set);
     set(this.manager.boxState);
+    return this._addManagerListener("boxStateChange", set);
   });
 
   /**
@@ -203,24 +203,24 @@ export class FastboardApp extends FastboardAppBase {
    * @example "HelloWorld-1A2b3C4d"
    */
   readonly focusedApp = readable(this.manager.focused, set => {
-    this._addManagerListener("focusedChange", set);
     set(this.manager.focused);
+    return this._addManagerListener("focusedChange", set);
   });
 
   /**
    * How many times can I call `app.redo()`?
    */
   readonly canRedoSteps = readable(this.manager.canRedoSteps, set => {
-    this._addManagerListener("canRedoStepsChange", set);
     set(this.manager.canRedoSteps);
+    return this._addManagerListener("canRedoStepsChange", set);
   });
 
   /**
    * How many times can I call `app.undo()`?
    */
   readonly canUndoSteps = readable(this.manager.canUndoSteps, set => {
-    this._addManagerListener("canUndoStepsChange", set);
     set(this.manager.canUndoSteps);
+    return this._addManagerListener("canUndoStepsChange", set);
   });
 
   /**
@@ -229,8 +229,8 @@ export class FastboardApp extends FastboardAppBase {
    * Change the camera position by `app.moveCamera()`.
    */
   readonly camera = readable(this.manager.camera, set => {
-    this._addMainViewListener("onCameraUpdated", set);
     set(this.manager.camera);
+    return this._addMainViewListener("onCameraUpdated", set);
   });
 
   /**
@@ -239,8 +239,8 @@ export class FastboardApp extends FastboardAppBase {
    * Change the tool by `app.setAppliance()`.
    */
   readonly memberState = readable(this.room.state.memberState, set => {
-    this._addRoomListener("onRoomStateChanged", ({ memberState: m }) => m && set(m));
     set(this.room.state.memberState);
+    return this._addRoomListener("onRoomStateChanged", ({ memberState: m }) => m && set(m));
   });
 
   /**
@@ -249,8 +249,8 @@ export class FastboardApp extends FastboardAppBase {
   readonly sceneIndex = writable(
     this.manager.mainViewSceneIndex,
     set => {
-      this._addManagerListener("mainViewSceneIndexChange", set);
       set(this.manager.mainViewSceneIndex);
+      return this._addManagerListener("mainViewSceneIndexChange", set);
     },
     this.manager.setMainViewSceneIndex.bind(this.manager)
   );
@@ -259,8 +259,8 @@ export class FastboardApp extends FastboardAppBase {
    * How many pages are in the main view?
    */
   readonly sceneLength = readable(this.manager.mainViewScenesLength, set => {
-    this._addManagerListener("mainViewScenesLengthChange", set);
     set(this.manager.mainViewScenesLength);
+    return this._addManagerListener("mainViewScenesLengthChange", set);
   });
 
   private _appsStatus: AppsStatus = {};
@@ -494,6 +494,7 @@ export class FastboardApp extends FastboardAppBase {
 
   /**
    * Insert the Monaco Code Editor app.
+   * @deprecated Use `app.manager.addApp({ kind: 'Monaco' })` instead.
    */
   insertCodeEditor() {
     this._assertNotDestroyed();
@@ -505,6 +506,7 @@ export class FastboardApp extends FastboardAppBase {
 
   /**
    * Insert the Countdown app.
+   * @deprecated Use `app.manager.addApp({ kind: 'Countdown' })` instead.
    */
   insertCountdown() {
     this._assertNotDestroyed();
@@ -516,6 +518,7 @@ export class FastboardApp extends FastboardAppBase {
 
   /**
    * Insert the GeoGebra app.
+   * @deprecated Use `app.manager.addApp({ kind: 'GeoGebra' })` instead.
    */
   insertGeoGebra() {
     this._assertNotDestroyed();

package/src/impl/FastboardPlayer.ts

@@ -80,8 +80,8 @@ export class FastboardPlayer extends FastboardPlayerBase {
   readonly currentTime = writable(
     this.player.progressTime,
     set => {
-      this._addPlayerListener("onProgressTimeChanged", set);
       set(this.player.progressTime);
+      return this._addPlayerListener("onProgressTimeChanged", set);
     },
     this.player.seekToProgressTime.bind(this.player)
   );
@@ -90,16 +90,16 @@ export class FastboardPlayer extends FastboardPlayerBase {
    * Player state, like "is it playing?".
    */
   readonly phase = readable<PlayerPhase>(this.player.phase, set => {
-    this._addPlayerListener("onPhaseChanged", set);
     set(this.player.phase);
+    return this._addPlayerListener("onPhaseChanged", set);
   });
 
   /**
    * Will become true after buffering.
    */
   readonly canplay = readable(this.player.isPlayable, set => {
-    this._addPlayerListener("onIsPlayableChanged", set);
     set(this.player.isPlayable);
+    return this._addPlayerListener("onIsPlayableChanged", set);
   });
 
   private _setPlaybackRate!: (value: number) => void;
@@ -129,8 +129,8 @@ export class FastboardPlayer extends FastboardPlayerBase {
    * Get state of room at that time, like "who was in the room?".
    */
   readonly state = readable<PlayerState>(this.player.state, set => {
-    this._addPlayerListener("onPlayerStateChanged", () => set(this.player.state));
     set(this.player.state);
+    return this._addPlayerListener("onPlayerStateChanged", () => set(this.player.state));
   });
 
   /**

package/src/impl/index.ts

@@ -1,3 +1,2 @@
 export * from "./FastboardApp";
 export * from "./FastboardPlayer";
-export * from "../behaviors";

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from "./utils";
 export * from "./impl";
+export * from "./behaviors";

package/dist/index.d.ts

@@ -1,386 +0,0 @@
-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, WindowManager, PublicEvent, RegisterParams } from '@netless/window-manager';
-export { AddPageParams, MountParams, 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<"normal" | "minimized" | "maximized" | 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>;
-    /**
-     * 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.
-     */
-    insertCodeEditor(): Promise<string | undefined>;
-    /**
-     * Insert the Countdown app.
-     */
-    insertCountdown(): Promise<string | undefined>;
-    /**
-     * Insert the GeoGebra app.
-     */
-    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">;
-}
-/**
- * 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, }: 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 };