@netless/window-manager 1.0.0-canary.46 → 1.0.0-canary.47

package/README.md

@@ -1,6 +1,18 @@
 # WindowManager
 
-- 目录
+`WindowManager` 是一个基于 `white-web-sdk` `InvisiblePlugin` 实现的窗口管理系统.
+
+本应用提供了以下内容：
+
+1. 提供 `NetlessApp` 插件 `API` 系统
+2. 支持 `APP` 以窗口的形式打开
+3. 支持应用在各个端的同步
+4. 光标同步
+5. 视角跟随
+
+## 内容列表
+  - [安装](#安装)
+  - [快速开始](#快速开始)
   - [概念](docs/concept.md)
   - [references](docs/api.md)
   - [从白板迁移](docs/migrate.md)
@@ -8,11 +20,17 @@
   - [进阶使用](docs/advanced.md)
     - [视角跟随](docs/advanced.md#view-mode)
   - [开发自定义 APP](docs/develop-app.md)
-## MainView
 
-`MainView` 也就是主白板, 是垫在所有窗口下面的主白板
+## 安装
 
-因为多窗口的原因，所以抽象出来一个主白板, 并且把以前部分对 `room` 的操作, 迁移到对 `mainView` 操作
+pnpm
+```sh
+$ pnpm install @netless/window-manager
+```
+yarn
+```sh
+$ yarn install @netless/window-manager
+```
 
 ### 快速开始
 
@@ -43,10 +61,16 @@ sdk.joinRoom({
 
 [mount 完整参数](docs/api.md#mount)
 
-
 > `containerSizeRatio` 为了保证窗口在不同分辨率下显示效果, 白板在相同的比例区域才能进行同步
 
-> `chessboard` 当挂载的区域不完全符合比例时, 白板会在挂载的 dom 中划分一个符合比例的区域出来, 此时多出来的部分会默认显示为棋盘透明背景
+
+## MainView
+
+`MainView` 也就是主白板, 是垫在所有窗口下面的主白板
+
+因为多窗口的原因，所以抽象出来一个主白板, 并且把以前部分对 `room` 的操作, 迁移到对 `mainView` 操作
+
+
 
 ### `collector`
 

package/dist/index.cjs.js

@@ -1284,7 +1284,7 @@ class AppContext {
   get currentMember() {
     const self = findMemberByUid(this.room, this.manager.uid);
     if (!self) {
-      throw new Error(`Member ${this.manager.uid} not found.`);
+      return void 0;
     }
     return __spreadValues({
       uid: this.manager.uid
@@ -12121,7 +12121,7 @@ const reconnectRefresher = new ReconnectRefresher({ emitter });
 const _WindowManager = class extends whiteWebSdk.InvisiblePlugin {
   constructor(context) {
     super(context);
-    this.version = "1.0.0-canary.46";
+    this.version = "1.0.0-canary.47";
     this.dependencies = { "dependencies": { "@juggle/resize-observer": "^3.3.1", "@netless/telebox-insider": "1.0.0-alpha.36", "emittery": "^0.11.0", "lodash": "^4.17.21", "p-retry": "^4.6.2", "side-effect-manager": "^1.1.1", "uuid": "^7.0.3", "value-enhancer": "^1.3.2" }, "peerDependencies": { "white-web-sdk": "^2.16.0" }, "devDependencies": { "@netless/app-docs-viewer": "^0.3.2", "@netless/app-plyr": "0.2.0", "@playwright/test": "^1.23.2", "@rollup/plugin-commonjs": "^20.0.0", "@rollup/plugin-node-resolve": "^13.0.4", "@rollup/plugin-url": "^6.1.0", "@sveltejs/vite-plugin-svelte": "^1.0.0-next.49", "@tsconfig/svelte": "^2.0.1", "@types/debug": "^4.1.7", "@types/lodash": "^4.14.182", "@types/lodash-es": "^4.17.6", "@types/node": "^18.0.3", "@types/uuid": "^8.3.4", "@typescript-eslint/eslint-plugin": "^4.30.0", "@typescript-eslint/parser": "^4.30.0", "@vitest/ui": "^0.14.2", "cypress": "^8.7.0", "dotenv": "^10.0.0", "eslint": "^7.32.0", "eslint-config-prettier": "^8.3.0", "eslint-plugin-svelte3": "^3.2.0", "jsdom": "^19.0.0", "less": "^4.1.3", "prettier": "^2.3.2", "prettier-plugin-svelte": "^2.4.0", "rollup-plugin-analyzer": "^4.0.0", "rollup-plugin-styles": "^3.14.1", "svelte": "^3.42.4", "typescript": "^4.5.5", "vite": "^2.5.3", "vite-plugin-dts": "^1.2.1", "vitest": "^0.18.0", "white-web-sdk": "2.16.26" } };
     this.emitter = callbacks;
     this.viewMode = whiteWebSdk.ViewMode.Broadcaster;
@@ -12477,12 +12477,13 @@ const _WindowManager = class extends whiteWebSdk.InvisiblePlugin {
   async addPage(params) {
     if (this.appManager) {
       const after = params == null ? void 0 : params.after;
-      const scene = params == null ? void 0 : params.scene;
+      const scene = (params == null ? void 0 : params.scene) || {};
+      const scenes = Array.isArray(scene) ? scene : [scene];
       if (after) {
         const nextIndex = this.mainViewSceneIndex + 1;
-        this.room.putScenes(ROOT_DIR, [scene || {}], nextIndex);
+        this.room.putScenes(ROOT_DIR, scenes, nextIndex);
       } else {
-        this.room.putScenes(ROOT_DIR, [scene || {}]);
+        this.room.putScenes(ROOT_DIR, scenes);
       }
     }
   }

package/dist/index.es.js

@@ -1277,7 +1277,7 @@ class AppContext {
   get currentMember() {
     const self = findMemberByUid(this.room, this.manager.uid);
     if (!self) {
-      throw new Error(`Member ${this.manager.uid} not found.`);
+      return void 0;
     }
     return __spreadValues({
       uid: this.manager.uid
@@ -12114,7 +12114,7 @@ const reconnectRefresher = new ReconnectRefresher({ emitter });
 const _WindowManager = class extends InvisiblePlugin {
   constructor(context) {
     super(context);
-    this.version = "1.0.0-canary.46";
+    this.version = "1.0.0-canary.47";
     this.dependencies = { "dependencies": { "@juggle/resize-observer": "^3.3.1", "@netless/telebox-insider": "1.0.0-alpha.36", "emittery": "^0.11.0", "lodash": "^4.17.21", "p-retry": "^4.6.2", "side-effect-manager": "^1.1.1", "uuid": "^7.0.3", "value-enhancer": "^1.3.2" }, "peerDependencies": { "white-web-sdk": "^2.16.0" }, "devDependencies": { "@netless/app-docs-viewer": "^0.3.2", "@netless/app-plyr": "0.2.0", "@playwright/test": "^1.23.2", "@rollup/plugin-commonjs": "^20.0.0", "@rollup/plugin-node-resolve": "^13.0.4", "@rollup/plugin-url": "^6.1.0", "@sveltejs/vite-plugin-svelte": "^1.0.0-next.49", "@tsconfig/svelte": "^2.0.1", "@types/debug": "^4.1.7", "@types/lodash": "^4.14.182", "@types/lodash-es": "^4.17.6", "@types/node": "^18.0.3", "@types/uuid": "^8.3.4", "@typescript-eslint/eslint-plugin": "^4.30.0", "@typescript-eslint/parser": "^4.30.0", "@vitest/ui": "^0.14.2", "cypress": "^8.7.0", "dotenv": "^10.0.0", "eslint": "^7.32.0", "eslint-config-prettier": "^8.3.0", "eslint-plugin-svelte3": "^3.2.0", "jsdom": "^19.0.0", "less": "^4.1.3", "prettier": "^2.3.2", "prettier-plugin-svelte": "^2.4.0", "rollup-plugin-analyzer": "^4.0.0", "rollup-plugin-styles": "^3.14.1", "svelte": "^3.42.4", "typescript": "^4.5.5", "vite": "^2.5.3", "vite-plugin-dts": "^1.2.1", "vitest": "^0.18.0", "white-web-sdk": "2.16.26" } };
     this.emitter = callbacks;
     this.viewMode = ViewMode.Broadcaster;
@@ -12470,12 +12470,13 @@ const _WindowManager = class extends InvisiblePlugin {
   async addPage(params) {
     if (this.appManager) {
       const after = params == null ? void 0 : params.after;
-      const scene = params == null ? void 0 : params.scene;
+      const scene = (params == null ? void 0 : params.scene) || {};
+      const scenes = Array.isArray(scene) ? scene : [scene];
       if (after) {
         const nextIndex = this.mainViewSceneIndex + 1;
-        this.room.putScenes(ROOT_DIR, [scene || {}], nextIndex);
+        this.room.putScenes(ROOT_DIR, scenes, nextIndex);
       } else {
-        this.room.putScenes(ROOT_DIR, [scene || {}]);
+        this.room.putScenes(ROOT_DIR, scenes);
       }
     }
   }

package/dist/index.umd.js

@@ -1278,7 +1278,7 @@ var __objRest = (source, exclude) => {
     get currentMember() {
       const self2 = findMemberByUid(this.room, this.manager.uid);
       if (!self2) {
-        throw new Error(`Member ${this.manager.uid} not found.`);
+        return void 0;
       }
       return __spreadValues({
         uid: this.manager.uid
@@ -12115,7 +12115,7 @@ var __objRest = (source, exclude) => {
   const _WindowManager = class extends whiteWebSdk.InvisiblePlugin {
     constructor(context) {
       super(context);
-      this.version = "1.0.0-canary.46";
+      this.version = "1.0.0-canary.47";
       this.dependencies = { "dependencies": { "@juggle/resize-observer": "^3.3.1", "@netless/telebox-insider": "1.0.0-alpha.36", "emittery": "^0.11.0", "lodash": "^4.17.21", "p-retry": "^4.6.2", "side-effect-manager": "^1.1.1", "uuid": "^7.0.3", "value-enhancer": "^1.3.2" }, "peerDependencies": { "white-web-sdk": "^2.16.0" }, "devDependencies": { "@netless/app-docs-viewer": "^0.3.2", "@netless/app-plyr": "0.2.0", "@playwright/test": "^1.23.2", "@rollup/plugin-commonjs": "^20.0.0", "@rollup/plugin-node-resolve": "^13.0.4", "@rollup/plugin-url": "^6.1.0", "@sveltejs/vite-plugin-svelte": "^1.0.0-next.49", "@tsconfig/svelte": "^2.0.1", "@types/debug": "^4.1.7", "@types/lodash": "^4.14.182", "@types/lodash-es": "^4.17.6", "@types/node": "^18.0.3", "@types/uuid": "^8.3.4", "@typescript-eslint/eslint-plugin": "^4.30.0", "@typescript-eslint/parser": "^4.30.0", "@vitest/ui": "^0.14.2", "cypress": "^8.7.0", "dotenv": "^10.0.0", "eslint": "^7.32.0", "eslint-config-prettier": "^8.3.0", "eslint-plugin-svelte3": "^3.2.0", "jsdom": "^19.0.0", "less": "^4.1.3", "prettier": "^2.3.2", "prettier-plugin-svelte": "^2.4.0", "rollup-plugin-analyzer": "^4.0.0", "rollup-plugin-styles": "^3.14.1", "svelte": "^3.42.4", "typescript": "^4.5.5", "vite": "^2.5.3", "vite-plugin-dts": "^1.2.1", "vitest": "^0.18.0", "white-web-sdk": "2.16.26" } };
       this.emitter = callbacks;
       this.viewMode = whiteWebSdk.ViewMode.Broadcaster;
@@ -12471,12 +12471,13 @@ var __objRest = (source, exclude) => {
     async addPage(params) {
       if (this.appManager) {
         const after = params == null ? void 0 : params.after;
-        const scene = params == null ? void 0 : params.scene;
+        const scene = (params == null ? void 0 : params.scene) || {};
+        const scenes = Array.isArray(scene) ? scene : [scene];
         if (after) {
           const nextIndex = this.mainViewSceneIndex + 1;
-          this.room.putScenes(ROOT_DIR, [scene || {}], nextIndex);
+          this.room.putScenes(ROOT_DIR, scenes, nextIndex);
         } else {
-          this.room.putScenes(ROOT_DIR, [scene || {}]);
+          this.room.putScenes(ROOT_DIR, scenes);
         }
       }
     }

package/dist/src/App/AppContext.d.ts

@@ -51,7 +51,7 @@ export declare class AppContext<TAttributes = any, TMagixEventPayloads = any, TA
     get box(): ReadonlyTeleBox;
     get room(): Room | undefined;
     get members(): Member[];
-    get currentMember(): Member;
+    get currentMember(): Member | undefined;
     /** @deprecated Use context.storage.setState instead. */
     setAttributes: (attributes: TAttributes) => void;
     /** @deprecated Use context.storage.setState instead. */

package/dist/src/Page/PageController.d.ts

@@ -1,7 +1,7 @@
 import type { SceneDefinition } from "white-web-sdk";
 export declare type AddPageParams = {
     after?: boolean;
-    scene?: SceneDefinition;
+    scene?: SceneDefinition | SceneDefinition[];
 };
 export declare type PageState = {
     index: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netless/window-manager",
-  "version": "1.0.0-canary.46",
+  "version": "1.0.0-canary.47",
   "description": "",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

package/src/App/AppContext.ts

@@ -180,10 +180,11 @@ export class AppContext<TAttributes = any, TMagixEventPayloads = any, TAppOption
         return this.manager.members$.value;
     }
 
-    public get currentMember(): Member {
+    //** currentMember is undefined in read-only and replay mode. */
+    public get currentMember(): Member | undefined {
         const self = findMemberByUid(this.room, this.manager.uid);
         if (!self) {
-            throw new Error(`Member ${this.manager.uid} not found.`);
+            return undefined;
         }
         return {
             uid: this.manager.uid,

package/src/Page/PageController.ts

@@ -2,7 +2,7 @@ import type { SceneDefinition } from "white-web-sdk";
 
 export type AddPageParams = {
     after?: boolean;
-    scene?: SceneDefinition;
+    scene?: SceneDefinition | SceneDefinition[];
 };
 
 export type PageState = {

package/src/index.ts

@@ -539,12 +539,13 @@ export class WindowManager extends InvisiblePlugin<WindowMangerAttributes> imple
     public async addPage(params?: AddPageParams): Promise<void> {
         if (this.appManager) {
             const after = params?.after;
-            const scene = params?.scene;
+            const scene = params?.scene || {};
+            const scenes = Array.isArray(scene) ? scene : [scene];
             if (after) {
                 const nextIndex = this.mainViewSceneIndex + 1;
-                this.room.putScenes(ROOT_DIR, [scene || {}], nextIndex);
+                this.room.putScenes(ROOT_DIR, scenes, nextIndex);
             } else {
-                this.room.putScenes(ROOT_DIR, [scene || {}]);
+                this.room.putScenes(ROOT_DIR, scenes);
             }
         }
     }