@netless/window-manager 0.4.0-canary.10 → 0.4.0-canary.14

package/dist/App/MagixEvent/index.d.ts

@@ -0,0 +1,29 @@
+import type { MagixEventListenerOptions as WhiteMagixListenerOptions, Event as WhiteEvent, EventPhase as WhiteEventPhase, Scope as WhiteScope } from "white-web-sdk";
+export interface MagixEventListenerOptions extends WhiteMagixListenerOptions {
+    /**
+     * Rapid emitted callbacks will be slowed down to this interval (in ms).
+     */
+    fireInterval?: number;
+    /**
+     * If `true`, sent events will reach self-listeners after committed to server.
+     * Otherwise the events will reach self-listeners immediately.
+     */
+    fireSelfEventAfterCommit?: boolean;
+}
+export interface MagixEventMessage<TPayloads = any, TEvent extends MagixEventTypes<TPayloads> = MagixEventTypes<TPayloads>> extends Omit<WhiteEvent, "scope" | "phase"> {
+    /** Event name */
+    event: TEvent;
+    /** Event Payload */
+    payload: TPayloads[TEvent];
+    /** Whiteboard ID of the client who dispatched the event. It will be AdminObserverId for system events. */
+    authorId: number;
+    scope: `${WhiteScope}`;
+    phase: `${WhiteEventPhase}`;
+}
+export declare type MagixEventTypes<TPayloads = any> = Extract<keyof TPayloads, string>;
+export declare type MagixEventPayload<TPayloads = any, TEvent extends MagixEventTypes<TPayloads> = MagixEventTypes<TPayloads>> = TPayloads[TEvent];
+export declare type MagixEventDispatcher<TPayloads = any> = <TEvent extends MagixEventTypes<TPayloads> = MagixEventTypes<TPayloads>>(event: TEvent, payload: TPayloads[TEvent]) => void;
+export declare type MagixEventHandler<TPayloads = any, TEvent extends MagixEventTypes<TPayloads> = MagixEventTypes<TPayloads>> = (message: MagixEventMessage<TPayloads, TEvent>) => void;
+export declare type MagixEventListenerDisposer = () => void;
+export declare type MagixEventAddListener<TPayloads = any> = <TEvent extends MagixEventTypes<TPayloads> = MagixEventTypes<TPayloads>>(event: TEvent, handler: MagixEventHandler<TPayloads, TEvent>, options?: MagixEventListenerOptions | undefined) => MagixEventListenerDisposer;
+export declare type MagixEventRemoveListener<TPayloads = any> = <TEvent extends MagixEventTypes<TPayloads> = MagixEventTypes<TPayloads>>(event: TEvent, handler?: MagixEventHandler<TPayloads, TEvent>) => void;

package/dist/App/Storage/index.d.ts

@@ -1,9 +1,10 @@
 import type { AppContext } from "../../AppContext";
-import type { Diff } from "./typings";
+import type { Diff, StorageStateChangedListener, StorageStateChangedListenerDisposer } from "./typings";
 import { StorageEvent } from "./StorageEvent";
 export * from './typings';
-export declare class Storage<TState = any> implements Storage<TState> {
-    readonly id: string;
+export declare const STORAGE_NS = "_WM-STORAGE_";
+export declare class Storage<TState extends Record<string, any> = any> implements Storage<TState> {
+    readonly id: string | null;
     private readonly _context;
     private readonly _sideEffect;
     private _state;
@@ -13,14 +14,26 @@ export declare class Storage<TState = any> implements Storage<TState> {
      * `setState` alters local state immediately before sending to server. This will cache the old value for onStateChanged diffing.
      */
     private _lastValue;
-    constructor(context: AppContext<any>, id: string, defaultState?: TState);
+    constructor(context: AppContext, id?: string, defaultState?: TState);
     get state(): Readonly<TState>;
     readonly onStateChanged: StorageEvent<Diff<TState>>;
+    addStateChangedListener(handler: StorageStateChangedListener<TState>): StorageStateChangedListenerDisposer;
     ensureState(state: Partial<TState>): void;
     setState(state: Partial<TState>): void;
-    emptyStore(): void;
-    deleteStore(): void;
+    /**
+     * Empty storage data.
+     */
+    emptyStorage(): void;
+    /**
+     * Delete storage index with all of its data and destroy the Storage instance.
+     */
+    deleteStorage(): void;
     get destroyed(): boolean;
+    /**
+     * Destroy the Storage instance. The data will be kept.
+     */
     destroy(): void;
+    private _getRawState;
+    private _setRawState;
     private _updateProperties;
 }

package/dist/App/Storage/typings.d.ts

@@ -19,3 +19,4 @@ export declare type StorageOnSetStatePayload<TState = unknown> = {
 };
 export declare type StorageStateChangedEvent<TState = any> = Diff<TState>;
 export declare type StorageStateChangedListener<TState = any> = StorageEventListener<StorageStateChangedEvent<TState>>;
+export declare type StorageStateChangedListenerDisposer = () => void;

package/dist/AppContext.d.ts

@@ -7,13 +7,14 @@ import type { AppEmitterEvent } from "./index";
 import type { AppManager } from "./AppManager";
 import type { AppProxy } from "./AppProxy";
 import { Storage } from './App/Storage';
-export declare class AppContext<TAttrs extends Record<string, any> = any, AppOptions = any> {
+import type { MagixEventAddListener, MagixEventDispatcher, MagixEventRemoveListener } from './App/MagixEvent';
+export declare class AppContext<TAttributes = any, TMagixEventPayloads = any, TAppOptions = any> {
     private manager;
     private boxManager;
     appId: string;
     private appProxy;
     private appOptions?;
-    readonly emitter: Emittery<AppEmitterEvent<TAttrs>>;
+    readonly emitter: Emittery<AppEmitterEvent<TAttributes>>;
     readonly mobxUtils: {
         autorun: typeof autorun;
         reaction: typeof reaction;
@@ -28,19 +29,40 @@ export declare class AppContext<TAttrs extends Record<string, any> = any, AppOpt
     private store;
     readonly isAddApp: boolean;
     readonly isReplay: boolean;
-    constructor(manager: AppManager, boxManager: BoxManager, appId: string, appProxy: AppProxy, appOptions?: AppOptions | (() => AppOptions) | undefined);
-    getDisplayer(): import("white-web-sdk").Displayer<import("white-web-sdk").DisplayerCallbacks>;
-    getAttributes(): TAttrs | undefined;
-    getScenes(): SceneDefinition[] | undefined;
-    getView(): View | undefined;
-    getInitScenePath(): string | undefined;
-    getIsWritable(): boolean;
-    getBox(): ReadonlyTeleBox;
-    getRoom(): Room | undefined;
-    setAttributes(attributes: TAttrs): void;
-    updateAttributes(keys: string[], value: any): void;
-    setScenePath(scenePath: string): Promise<void>;
-    mountView(dom: HTMLDivElement): void;
-    getAppOptions(): AppOptions | undefined;
-    createStorage<TState>(storeId: string, defaultState?: TState): Storage<TState>;
+    constructor(manager: AppManager, boxManager: BoxManager, appId: string, appProxy: AppProxy, appOptions?: TAppOptions | (() => TAppOptions) | undefined);
+    getDisplayer: () => import("white-web-sdk").Displayer<import("white-web-sdk").DisplayerCallbacks>;
+    /** @deprecated Use context.storage.state instead. */
+    getAttributes: () => TAttributes | undefined;
+    getScenes: () => SceneDefinition[] | undefined;
+    getView: () => View | undefined;
+    getInitScenePath: () => string | undefined;
+    /** Get App writable status. */
+    getIsWritable: () => boolean;
+    /** Get the App Window UI box. */
+    getBox: () => ReadonlyTeleBox;
+    getRoom: () => Room | undefined;
+    /** @deprecated Use context.storage.setState instead. */
+    setAttributes: (attributes: TAttributes) => void;
+    /** @deprecated Use context.storage.setState instead. */
+    updateAttributes: (keys: string[], value: any) => void;
+    setScenePath: (scenePath: string) => Promise<void>;
+    mountView: (dom: HTMLDivElement) => void;
+    /** Get the local App options. */
+    getAppOptions: () => TAppOptions | undefined;
+    private _storage?;
+    /** Main Storage for attributes. */
+    get storage(): Storage<TAttributes>;
+    /**
+     * Create separated storages for flexible state management.
+     * @param storeId Namespace for the storage. Storages of the same namespace share the same data.
+     * @param defaultState Default state for initial storage creation.
+     * @returns
+     */
+    createStorage: <TState>(storeId: string, defaultState?: TState | undefined) => Storage<TState>;
+    /** Dispatch events to other clients (and self). */
+    dispatchMagixEvent: MagixEventDispatcher<TMagixEventPayloads>;
+    /** Listen to events from others clients (and self messages). */
+    addMagixEventListener: MagixEventAddListener<TMagixEventPayloads>;
+    /** Remove a Magix event listener. */
+    removeMagixEventListener: MagixEventRemoveListener<TMagixEventPayloads>;
 }

package/dist/AppManager.d.ts

@@ -20,6 +20,7 @@ export declare class AppManager {
     private appListeners;
     boxManager?: BoxManager;
     private _prevSceneIndex;
+    private _prevFocused;
     constructor(windowManger: WindowManager);
     private onCreated;
     /**

package/dist/AppProxy.d.ts

@@ -47,6 +47,7 @@ export declare class AppProxy extends Base {
     emitAppIsWritableChange(): void;
     private makeAppEventListener;
     private appAttributesUpdateListener;
+    private setFocusScenePathHandler;
     setScenePath(): void;
     setViewFocusScenePath(): void;
     private createView;

package/dist/BoxManager.d.ts

@@ -59,7 +59,7 @@ export declare class BoxManager {
     private playgroundSizeChangeListener;
     private get mainView();
     private get canOperate();
-    get boxState(): "minimized" | "maximized" | "normal";
+    get boxState(): "normal" | "minimized" | "maximized";
     get maximized(): boolean;
     get minimized(): boolean;
     get darkMode(): boolean;

package/dist/index.d.ts

@@ -104,6 +104,7 @@ export declare type PublicEvent = {
     cameraStateChange: CameraState;
     mainViewScenePathChange: string;
     mainViewSceneIndexChange: number;
+    focusedChange: string | undefined;
 };
 export declare type MountParams = {
     room: Room;
@@ -198,6 +199,7 @@ export declare class WindowManager extends InvisiblePlugin<WindowMangerAttribute
     get darkMode(): boolean;
     get prefersColorScheme(): TeleBoxColorScheme | undefined;
     get focused(): string | undefined;
+    get mainViewSceneIndex(): number;
     /**
      * 查询所有的 App
      */