@netless/window-manager 0.4.17 → 0.4.20

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.4.20
+
+1. 导出 Page 相关类型
+
+## 0.4.19
+
+1. 升级 @netless/app-docs-viewer@0.2.9
+
+## 0.4.18
+
+1. 修复设置 viewMode freedom 时, 不能 focus 到主白板的问题
+
 ## 0.4.17
 
 1. 修复 safari 浏览器下 removeScenes 为 "/" 没有清理完成完成时可以 addApp

package/README.md

@@ -210,8 +210,14 @@ manager.destroy();
 
 ## 开发流程
 
-yarn build:lib
+```bash
+pnpm install
 
-cd test
+pnpm build
 
-yarn dev
+cd example
+
+pnpm install
+
+pnpm dev
+```

package/dist/{AppContext.d.ts → App/AppContext.d.ts}

@@ -1,14 +1,15 @@
-import { Storage } from "./App/Storage";
+import { Storage } from "./Storage";
 import { autorun, listenDisposed, listenUpdated, reaction, unlistenDisposed, unlistenUpdated, toJS } from "white-web-sdk";
 import type { Room, SceneDefinition, View } from "white-web-sdk";
 import type { ReadonlyTeleBox } from "@netless/telebox-insider";
 import type Emittery from "emittery";
-import type { BoxManager } from "./BoxManager";
-import type { AppEmitterEvent } from "./index";
-import type { AppManager } from "./AppManager";
+import type { BoxManager } from "../BoxManager";
+import type { AppEmitterEvent } from "../index";
+import type { AppManager } from "../AppManager";
 import type { AppProxy } from "./AppProxy";
-import type { MagixEventAddListener, MagixEventDispatcher, MagixEventRemoveListener } from "./App/MagixEvent";
-export declare class AppContext<TAttributes = any, TMagixEventPayloads = any, TAppOptions = any> {
+import type { MagixEventAddListener, MagixEventDispatcher, MagixEventRemoveListener } from "./MagixEvent";
+import type { AddPageParams, PageController, PageState } from "../Page";
+export declare class AppContext<TAttributes = any, TMagixEventPayloads = any, TAppOptions = any> implements PageController {
     private manager;
     private boxManager;
     appId: string;
@@ -65,4 +66,9 @@ export declare class AppContext<TAttributes = any, TMagixEventPayloads = any, TA
     addMagixEventListener: MagixEventAddListener<TMagixEventPayloads>;
     /** Remove a Magix event listener. */
     removeMagixEventListener: MagixEventRemoveListener<TMagixEventPayloads>;
+    /** PageController  */
+    nextPage: () => Promise<boolean>;
+    prevPage: () => Promise<boolean>;
+    addPage: (params?: AddPageParams | undefined) => Promise<void>;
+    get pageState(): PageState;
 }

package/dist/App/AppPageStateImpl.d.ts

@@ -0,0 +1,17 @@
+import type { Displayer, View } from "white-web-sdk";
+import type { PageState } from "../Page";
+export declare type AppPageStateParams = {
+    displayer: Displayer;
+    scenePath: string | undefined;
+    view: View | undefined;
+    notifyPageStateChange: () => void;
+};
+export declare class AppPageStateImpl {
+    private params;
+    private sceneNode;
+    constructor(params: AppPageStateParams);
+    private onSceneChange;
+    getFullPath(index: number): string | undefined;
+    toObject(): PageState;
+    destroy(): void;
+}

package/dist/{AppProxy.d.ts → App/AppProxy.d.ts}

@@ -1,16 +1,19 @@
 import Emittery from "emittery";
-import type { AppEmitterEvent, AppInitState, BaseInsertParams } from "./index";
+import { AppContext } from "./AppContext";
+import type { AppEmitterEvent, AppInitState, BaseInsertParams } from "../index";
 import type { SceneState, View, SceneDefinition } from "white-web-sdk";
-import type { AppManager } from "./AppManager";
-import type { NetlessApp } from "./typings";
+import type { AppManager } from "../AppManager";
+import type { NetlessApp } from "../typings";
 import type { ReadonlyTeleBox } from "@netless/telebox-insider";
+import type { PageState } from "../Page";
+export declare type AppEmitter = Emittery<AppEmitterEvent>;
 export declare class AppProxy {
     private params;
     private manager;
     kind: string;
     id: string;
     scenePath?: string;
-    appEmitter: Emittery<AppEmitterEvent>;
+    appEmitter: AppEmitter;
     scenes?: SceneDefinition[];
     private appListener;
     private boxManager;
@@ -20,14 +23,16 @@ export declare class AppProxy {
     isAddApp: boolean;
     private status;
     private stateKey;
-    private appResult?;
-    private appContext?;
+    private _pageState;
+    appResult?: NetlessApp<any>;
+    appContext?: AppContext<any, any>;
     constructor(params: BaseInsertParams, manager: AppManager, appId: string, isAddApp: boolean);
     private initScenes;
     get view(): View | undefined;
+    get viewIndex(): number | undefined;
     get isWritable(): boolean;
     get attributes(): any;
-    get appAttributes(): import("./index").AppSyncAttributes;
+    get appAttributes(): import("../index").AppSyncAttributes;
     getFullScenePath(): string | undefined;
     private getFullScenePathFromScenes;
     setFullPath(path: string): void;
@@ -50,6 +55,9 @@ export declare class AppProxy {
     setScenePath(): void;
     setViewFocusScenePath(): string | undefined;
     private createView;
+    notifyPageStateChange: () => void;
+    get pageState(): PageState;
+    setSceneIndex(index: number): void;
     destroy(needCloseBox: boolean, cleanAttrs: boolean, skipUpdate: boolean, error?: Error): Promise<void>;
     close(): Promise<void>;
 }

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

@@ -1,4 +1,4 @@
-import type { AppContext } from "../../AppContext";
+import type { AppContext } from "../AppContext";
 import type { Diff, StorageStateChangedListener, StorageStateChangedListenerDisposer } from "./typings";
 import { StorageEvent } from "./StorageEvent";
 export * from './typings';

package/dist/App/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./AppProxy";
+export * from "./AppContext";

package/dist/AppManager.d.ts

@@ -1,5 +1,5 @@
 import { AppStatus, Events } from "./constants";
-import { AppProxy } from "./AppProxy";
+import { AppProxy } from "./App";
 import { MainViewProxy } from "./View/MainView";
 import { WindowManager } from "./index";
 import { ViewManager } from "./View/ViewManager";

package/dist/Page/PageController.d.ts

@@ -0,0 +1,15 @@
+import type { SceneDefinition } from "white-web-sdk";
+export declare type AddPageParams = {
+    after?: boolean;
+    scene?: SceneDefinition;
+};
+export declare type PageState = {
+    index: number;
+    length: number;
+};
+export interface PageController {
+    nextPage: () => Promise<boolean>;
+    prevPage: () => Promise<boolean>;
+    addPage: (params?: AddPageParams) => Promise<void>;
+    pageState: PageState;
+}

package/dist/Page/index.d.ts

@@ -0,0 +1 @@
+export * from "./PageController";

package/dist/PageState.d.ts

@@ -1,8 +1,5 @@
 import type { AppManager } from "./AppManager";
-export declare type PageState = {
-    index: number;
-    length: number;
-};
+import type { PageState } from "./Page";
 export declare class PageStateImpl {
     private manager;
     constructor(manager: AppManager);

package/dist/RedoUndo.d.ts

@@ -1,5 +1,5 @@
 import type { View } from "white-web-sdk";
-import type { AppProxy } from "./AppProxy";
+import type { AppProxy } from "./App";
 export declare type RedoUndoContext = {
     mainView: () => View;
     focus: () => string | undefined;

package/dist/Utils/AppCreateQueue.d.ts

@@ -1,4 +1,4 @@
-import type { AppProxy } from "../AppProxy";
+import type { AppProxy } from "../App";
 export declare type Invoker = () => Promise<AppProxy | undefined>;
 export declare class AppCreateQueue {
     private list;

package/dist/Utils/Common.d.ts

@@ -13,7 +13,7 @@ export declare const addEmitterOnceListener: (event: any, listener: any) => void
 export declare const notifyMainViewModeChange: import("lodash").DebouncedFunc<(callbacks: Emittery<PublicEvent>, mode: ViewVisionMode) => void>;
 export declare const makeValidScenePath: (displayer: Displayer, scenePath: string, index?: number) => string | undefined;
 export declare const entireScenes: (displayer: Displayer) => import("white-web-sdk").SceneMap;
-export declare const putScenes: (room: Room | undefined, path: string, scenes: SceneDefinition[]) => void | undefined;
+export declare const putScenes: (room: Room | undefined, path: string, scenes: SceneDefinition[], index?: number | undefined) => void | undefined;
 export declare const isValidScenePath: (scenePath: string) => boolean;
 export declare const parseSceneDir: (scenePath: string) => string;
 export declare const ensureValidScenePath: (scenePath: string) => string;

package/dist/callback.d.ts

@@ -2,7 +2,7 @@ import Emittery from "emittery";
 import type { TeleBoxColorScheme, TELE_BOX_STATE } from "@netless/telebox-insider";
 import type { CameraState, SceneState, ViewVisionMode } from "white-web-sdk";
 import type { LoadAppEvent } from "./Register";
-import type { PageState } from "./PageState";
+import type { PageState } from "./Page";
 export declare type PublicEvent = {
     mainViewModeChange: ViewVisionMode;
     boxStateChange: `${TELE_BOX_STATE}`;

package/dist/index.d.ts

@@ -11,10 +11,10 @@ import type { Displayer, SceneDefinition, View, Room, InvisiblePluginContext, Ca
 import type { AppListeners } from "./AppListener";
 import type { NetlessApp, RegisterParams } from "./typings";
 import type { TeleBoxColorScheme, TeleBoxState } from "@netless/telebox-insider";
-import type { AppProxy } from "./AppProxy";
-import type { PublicEvent } from "./Callback";
+import type { AppProxy } from "./App";
+import type { PublicEvent } from "./callback";
 import type Emittery from "emittery";
-import type { PageState } from "./PageState";
+import type { PageController, AddPageParams, PageState } from "./Page";
 export declare type WindowMangerAttributes = {
     modelValue?: string;
     boxState: TELE_BOX_STATE;
@@ -89,11 +89,7 @@ export declare type MountParams = {
     prefersColorScheme?: TeleBoxColorScheme;
 };
 export declare const reconnectRefresher: ReconnectRefresher;
-export declare type AddPageParams = {
-    after?: boolean;
-    scene?: SceneDefinition;
-};
-export declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes> {
+export declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes> implements PageController {
     static kind: string;
     static displayer: Displayer;
     static wrapper?: HTMLElement;