Merge pull request #40 from hqer927/main

chore:release 1.1.0

Author: hqer927

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.0 (2025-07-07)
+- update `@netless/app-slide` to `^0.2.78`.
+- update `@netless/window-manager` to `^1.0.5`.
+
 ## 1.0.6 (2025-06-10)
 - Added `enableAppInMainViewPlugin` in FastboardOptions to support app in mainView.
 - update `@netless/app-slide` to `^0.2.73`.

README-zh.md

@@ -67,8 +67,6 @@ async function main() {
     // [3] (可选)
     managerConfig: {
       cursor: true,
-      // (可选), 开启appliance-plugin, 从0.3.22开始, 开启配置需要安装@netless/appliance-plugin,具体参考使用性能优化版本介绍 
-      supportAppliancePlugin: true,
     },
     // [4] (可选)
     netlessApps: [],
@@ -171,7 +169,6 @@ function App() {
     // (可选), 开启 appliance-plugin 插件, 开启配置需要安装@netless/appliance-plugin,具体参考使用性能优化版本介绍
     managerConfig: {
       cursor: true,
-      supportAppliancePlugin: true,
     }
     // (可选), 开启 appliance-plugin 插件, 开启配置需要安装@netless/appliance-plugin,具体参考使用性能优化版本介绍
     enableAppliancePlugin: {
@@ -437,7 +434,7 @@ const appId = await fastboard.manager.addApp({
 
 <h2 id="performance">使用性能优化版本</h2>
 
-通过 `enableAppliancePlugin` 及 `managerConfig.supportAppliancePlugin` 配置项开启 appliance-plugin 插件，以提升性能以及提供[新的白板功能](https://github.com/netless-io/fastboard/blob/main/docs/zh/appliance-plugin.md#%E6%96%B0%E5%8A%9F%E8%83%BD), 也可以参考文档:[appliance-plugin](./docs/zh/appliance-plugin.md)了解更多内容。
+通过 `enableAppliancePlugin` 配置项开启 appliance-plugin 插件，以提升性能以及提供[新的白板功能](https://github.com/netless-io/fastboard/blob/main/docs/zh/appliance-plugin.md#%E6%96%B0%E5%8A%9F%E8%83%BD), 也可以参考文档:[appliance-plugin](./docs/zh/appliance-plugin.md)了解更多内容。
 > **注意：** 开启使用性能优化版本,需要安装 ``@netless/appliance-plugin`` 。
 
 ### 示例代码
@@ -497,7 +494,6 @@ const fastboard = await createFastboard({
     },
     managerConfig: {
       cursor: true,
-      supportAppliancePlugin: true,
       ...
     },
     // 更多的`enableAppliancePlugin`配置项参考:https://github.com/netless-io/fastboard/blob/main/docs/zh/appliance-plugin.md#%E9%85%8D%E7%BD%AE%E5%8F%82%E6%95%B0

README.md

@@ -68,8 +68,6 @@ async function main() {
     // [3] (optional)
     managerConfig: {
       cursor: true,
-      // (Optional), enable the appliance-plugin plugin. To enable the configuration, you need to install @netless/appliance-plugin. For specific details, please refer to the introduction of the performance optimization version
-      supportAppliancePlugin: true,
     },
     // [4] (optional)
     netlessApps: [],
@@ -160,8 +158,6 @@ function App() {
     },
     managerConfig: {
       cursor: true,
-      // (Optional), enable the appliance-plugin plugin. To enable the configuration, you need to install @netless/appliance-plugin. For specific details, please refer to the introduction of the performance optimization version
-      supportAppliancePlugin: true,
     },
     // (Optional), enable the appliance-plugin plugin. To enable the configuration, you need to install @netless/appliance-plugin. For specific details, please refer to the introduction of the performance optimization version
     enableAppliancePlugin: {
@@ -428,7 +424,7 @@ To develop your own app, see [Write you a Netless App](./docs/en/app.md).
 
 ## performance
 
-Through ` enableAppliancePlugin ` and ` managerConfig. SupportAppliancePlugin ` configuration items open appliance-plugins plugin. In order to enhance performance and provide [new whiteboard features](https://github.com/netless-io/fastboard/blob/main/docs/en/appliance-plugin.md#new-features), or refer to the [appliance-plugin](./docs/en/appliance-plugin.md) document for more information.
+Through ` enableAppliancePlugin ` configuration items open appliance-plugins plugin. In order to enhance performance and provide [new whiteboard features](https://github.com/netless-io/fastboard/blob/main/docs/en/appliance-plugin.md#new-features), or refer to the [appliance-plugin](./docs/en/appliance-plugin.md) document for more information.
 > **Note:** To enable the use of the performance optimized version, you need to install `@netless/appliance-plugin`.
 
 ```js
@@ -487,7 +483,6 @@ const fastboard = await createFastboard({
     },
     managerConfig: {
       cursor: true,
-      supportAppliancePlugin: true,
       ...
     },
     // about enableAppliancePlugin: https://github.com/netless-io/fastboard/blob/main/docs/en/appliance-plugin.md#configure-parameters

package.json

@@ -48,7 +48,7 @@
     "overrides": {
       "@netless/window-manager": "^1.0.5",
       "@netless/appliance-plugin": "^1.1.17",
-      "@netless/app-in-mainview-plugin": "^0.0.7",
+      "@netless/app-in-mainview-plugin": "^0.0.9",
       "white-web-sdk": "^2.16.53"
     },
     "peerDependencyRules": {

packages/fastboard-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netless/fastboard-core",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "description": "A tiny wrapper of white-web-sdk and @netless/window-manager and @netless/appliance-plugin.",
   "main": "src/index.ts",
   "exports": {
@@ -21,7 +21,7 @@
     "build": "buildtool"
   },
   "dependencies": {
-    "@netless/app-slide": "^0.2.75",
+    "@netless/app-slide": "^0.2.78",
     "@netless/synced-store": "^2.0.7"
   },
   "peerDependencies": {
@@ -34,7 +34,12 @@
   "devDependencies": {
     "@netless/buildtool": "workspace:*",
     "jspdf": "^2.5.1",
-    "white-web-sdk": "^2.16.53"
+    "white-web-sdk": "^2.16.53",
+    "@netless/window-manager": "^1.0.5"
+  },
+  "optionalDependencies": {
+    "@netless/app-in-mainview-plugin": "^0.0.9",
+    "@netless/appliance-plugin": "^1.1.17"
   },
   "publishConfig": {
     "main": "dist/index.js",

packages/fastboard-core/src/impl/FastboardApp.ts

@@ -18,7 +18,6 @@ import type {
   ShapeType,
   ViewCallbacks,
   WhiteWebSdkConfiguration,
-  RoomMember,
   FloatBarOptions,
   ApplianceNames,
 } from "white-web-sdk";
@@ -39,24 +38,24 @@ import {
 import { ensure_official_plugins, transform_app_status } from "../internal";
 import { register } from "../behaviors/lite";
 
-import { ApplianceMultiPlugin } from "@netless/appliance-plugin";
 import type {
   AppliancePluginOptions,
   AppliancePluginInstance,
   ApplianceNames as ExtendApplianceNames,
   MemberState as ExtendMemberState,
   PublicEvent as AppliancePublicEvent,
   PublicListener as AppliancePublicListener,
+  ApplianceMultiPlugin,
 } from "@netless/appliance-plugin";
 
-import { AppInMainViewPlugin } from "@netless/app-in-mainview-plugin";
 import type {
   AppInMainViewOptions,
   AppInMainViewInstance,
   PublicEvent as AppInMainViewPublicEvent,
   PublicListener as AppInMainViewPublicListener,
   AppId,
   AppValue,
+  AppInMainViewPlugin,
 } from "@netless/app-in-mainview-plugin";
 
 function noop() {}
@@ -772,21 +771,27 @@ export async function createFastboard<TEventData extends Record<string, any> = a
     enableAppliancePlugin?.cdn.fullWorkerUrl && enableAppliancePlugin?.cdn.subWorkerUrl ? true : false;
 
   const joinRoomParamsWithPlugin = ensure_official_plugins(joinRoomParams);
+  let _ApplianceMultiPlugin: typeof ApplianceMultiPlugin | undefined;
   if (isEnableAppliancePlugin) {
+    const { ApplianceMultiPlugin } = await import("@netless/appliance-plugin");
+    _ApplianceMultiPlugin = ApplianceMultiPlugin;
     if (joinRoomParamsWithPlugin.invisiblePlugins) {
       joinRoomParamsWithPlugin.invisiblePlugins = [
         ...joinRoomParamsWithPlugin.invisiblePlugins,
-        ApplianceMultiPlugin,
+        _ApplianceMultiPlugin,
       ];
     }
     if (managerConfig) {
       managerConfig.supportAppliancePlugin = true;
     }
   }
+  let _AppInMainViewPlugin: typeof AppInMainViewPlugin | undefined;
   if (enableAppInMainViewPlugin && joinRoomParamsWithPlugin.invisiblePlugins) {
+    const { AppInMainViewPlugin } = await import("@netless/app-in-mainview-plugin");
+    _AppInMainViewPlugin = AppInMainViewPlugin;
     joinRoomParamsWithPlugin.invisiblePlugins = [
       ...joinRoomParamsWithPlugin.invisiblePlugins,
-      AppInMainViewPlugin,
+      _AppInMainViewPlugin,
     ];
   }
 
@@ -833,15 +838,15 @@ export async function createFastboard<TEventData extends Record<string, any> = a
     room,
   });
   let appInMainViewPluginInstance: AppInMainViewInstance | undefined;
-  if (enableAppInMainViewPlugin) {
-    appInMainViewPluginInstance = await AppInMainViewPlugin.getInstance(
+  if (enableAppInMainViewPlugin && _AppInMainViewPlugin) {
+    appInMainViewPluginInstance = await _AppInMainViewPlugin.getInstance(
       manager,
       enableAppInMainViewPlugin === true ? undefined : enableAppInMainViewPlugin
     );
   }
   let appliancePluginInstance: AppliancePluginInstance | undefined;
-  if (isEnableAppliancePlugin && enableAppliancePlugin) {
-    appliancePluginInstance = await ApplianceMultiPlugin.getInstance(manager, {
+  if (isEnableAppliancePlugin && enableAppliancePlugin && _ApplianceMultiPlugin) {
+    appliancePluginInstance = await _ApplianceMultiPlugin.getInstance(manager, {
       options: enableAppliancePlugin,
     });
   }

packages/fastboard-core/src/impl/FastboardPlayer.ts

@@ -17,12 +17,15 @@ import { SyncedStorePlugin } from "@netless/synced-store";
 import { readable, writable } from "../utils";
 import { ensure_official_plugins } from "../internal";
 import { register } from "../behaviors/lite";
-import { ApplianceMultiPlugin } from "@netless/appliance-plugin";
-import type { AppliancePluginOptions, AppliancePluginInstance } from "@netless/appliance-plugin";
-import {
+import type {
+  AppliancePluginOptions,
+  AppliancePluginInstance,
+  ApplianceMultiPlugin,
+} from "@netless/appliance-plugin";
+import type {
   AppInMainViewPlugin,
-  type AppInMainViewOptions,
-  type AppInMainViewInstance,
+  AppInMainViewOptions,
+  AppInMainViewInstance,
 } from "@netless/app-in-mainview-plugin";
 function noop() {}
 
@@ -242,22 +245,28 @@ export async function replayFastboard<TEventData extends Record<string, any> = a
     enableAppliancePlugin?.cdn.fullWorkerUrl && enableAppliancePlugin?.cdn.subWorkerUrl ? true : false;
 
   const replayRoomParamsWithPlugin = ensure_official_plugins(replayRoomParams);
+  let _ApplianceMultiPlugin: typeof ApplianceMultiPlugin | undefined;
   if (isEnableAppliancePlugin) {
+    const { ApplianceMultiPlugin } = await import("@netless/appliance-plugin");
+    _ApplianceMultiPlugin = ApplianceMultiPlugin;
     if (replayRoomParamsWithPlugin.invisiblePlugins) {
       replayRoomParamsWithPlugin.invisiblePlugins = [
         ...replayRoomParamsWithPlugin.invisiblePlugins,
-        ApplianceMultiPlugin,
+        _ApplianceMultiPlugin,
       ];
     }
 
     if (managerConfig) {
       managerConfig.supportAppliancePlugin = true;
     }
   }
+  let _AppInMainViewPlugin: typeof AppInMainViewPlugin | undefined;
   if (enableAppInMainViewPlugin && replayRoomParamsWithPlugin.invisiblePlugins) {
+    const { AppInMainViewPlugin } = await import("@netless/app-in-mainview-plugin");
+    _AppInMainViewPlugin = AppInMainViewPlugin;
     replayRoomParamsWithPlugin.invisiblePlugins = [
       ...replayRoomParamsWithPlugin.invisiblePlugins,
-      AppInMainViewPlugin,
+      _AppInMainViewPlugin,
     ];
   }
 
@@ -290,14 +299,14 @@ export async function replayFastboard<TEventData extends Record<string, any> = a
   player.play();
   const manager = await managerPromise;
   let appliancePluginInstance: AppliancePluginInstance | undefined;
-  if (isEnableAppliancePlugin && enableAppliancePlugin) {
-    appliancePluginInstance = await ApplianceMultiPlugin.getInstance(manager, {
+  if (isEnableAppliancePlugin && enableAppliancePlugin && _ApplianceMultiPlugin) {
+    appliancePluginInstance = await _ApplianceMultiPlugin.getInstance(manager, {
       options: enableAppliancePlugin,
     });
   }
   let appInMainViewPluginInstance: AppInMainViewInstance | undefined;
-  if (enableAppInMainViewPlugin) {
-    appInMainViewPluginInstance = await AppInMainViewPlugin.getInstance(
+  if (enableAppInMainViewPlugin && _AppInMainViewPlugin) {
+    appInMainViewPluginInstance = await _AppInMainViewPlugin.getInstance(
       manager,
       enableAppInMainViewPlugin === true ? undefined : enableAppInMainViewPlugin
     );

packages/fastboard-core/tsconfig.json

@@ -1,4 +1,8 @@
 {
   "extends": "../../tsconfig-base.json",
-  "include": ["src"]
+  "include": ["src"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    "types": []
+  }
 }

packages/fastboard-react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netless/fastboard-react",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "description": "React components of @netless/fastboard.",
   "main": "src/index.tsx",
   "files": [

packages/fastboard-ui/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netless/fastboard-ui",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "description": "The front-end of @netless/fastboard-core.",
   "main": "src/index.ts",
   "svelte": "dist/index.svelte.mjs",