@netless/appliance-plugin 1.1.37 → 1.1.38-beta.0

package/READMA.zh-CN.md

@@ -311,8 +311,8 @@ injectMethodToObject(windowmanager.mainView,'setMemberState');
 - `getElements` - 获取场景下的所有元素 (Version >=1.1.19)
 - `stopDraw` - 停止Draw事件 (Version >=1.1.19)
 - `setViewLocalScenePathChange` - 设置白板本地场景路径变化 (Version >=1.1.27)
-- `insertMarkmap` - 插入markdow文本到白板 (Version >=1.1.32) **该方法需要开启extras.useBackgroundThread**
-- `updateMarkmap` - 修改白板中的markdow文本 (Version >=1.1.32) **该方法需要开启extras.useBackgroundThread**
+- `insertMarkmap` - 插入 markdown 文本到白板 (Version >=1.1.32) **该方法需要开启 extras.useBackgroundThread。不能仅通过默认入口直接使用；业务项目如需使用 Markmap，需要自行依赖 `markmap-lib`、`markmap-view`、`mermaid`，并在调用前先导入 `@netless/appliance-plugin/markmap`。**
+- `updateMarkmap` - 修改白板中的 markdown 文本 (Version >=1.1.32) **该方法需要开启 extras.useBackgroundThread。不能仅通过默认入口直接使用；业务项目如需使用 Markmap，需要自行依赖 `markmap-lib`、`markmap-view`、`mermaid`，并在调用前先导入 `@netless/appliance-plugin/markmap`。**
 - `insertBackgroundImage` - 插入白板的背景图片 (Version >=1.1.32) **该方法需要开启extras.useBackgroundThread**
 
 6. Selector / Element 扩展接口
@@ -356,7 +356,7 @@ injectMethodToObject(windowmanager.mainView,'setMemberState');
 - 支持基于 `selectedElementsChange`、`selectorGeometryChange`、`selectorTransformChange`、`remoteSelectorChange` 事件渲染业务自定义 UI
 - 支持通过 `overwriteSelectorStyles` 覆盖 selector 外框、控制点、端点和锁态图标样式
 - 支持将自定义 floatbar 挂到 plugin 内部容器，或挂到业务自己的外部 overlay 容器
-- 推荐结合 [customer-custom-selector-floatbar-integration.zh-CN.md](https://github.com/user-attachments/files/29439912/customer-custom-selector-floatbar-integration.zh-CN.md) 接入
+- 推荐结合 [customer-custom-selector-floatbar-integration.zh-CN.md](https://github.com/netless-io/fastboard/blob/main/docs/zh/customer-custom-selector-floatbar-integration.zh-CN.md) 接入
 
 9. 不兼容接口
 - [`exportScene`](https://doc.shengwang.cn/api-ref/whiteboard/javascript/interfaces/room#exportScene) - appliance-plugin 开启后，笔记不能按 room 的方式导出
@@ -433,7 +433,7 @@ room.setMemberState({
 - 通过 `overwriteSelectorStyles` 统一覆盖 selector 视觉样式
 
 详细设计与接入示例请参考：
-- [customer-custom-selector-floatbar-integration.zh-CN.md](https://github.com/user-attachments/files/29439912/customer-custom-selector-floatbar-integration.zh-CN.md)
+- [customer-custom-selector-floatbar-integration.zh-CN.md](https://github.com/netless-io/fastboard/blob/main/docs/zh/customer-custom-selector-floatbar-integration.zh-CN.md)
 
 ##### 扩展教具 (Version >=1.1.1)
 在原来的[白板教具](https://doc.shengwang.cn/api-ref/whiteboard/javascript/globals.html#memberstate)类型上,增加了一些扩展功能属性,如下:
@@ -751,8 +751,13 @@ plugin.usePlugin(autoDrawPlugin);
 ![Image](https://github.com/user-attachments/assets/c388691c-ae72-44ec-bbb7-e92c3a73c9c7)
 
 ##### 插入思维导图(需要markdown文本) (Version >=1.1.32)
+
+> `insertMarkmap`、`updateMarkmap` 属于可选 Markmap 能力，不能只导入 `@netless/appliance-plugin` 后直接使用。业务项目如需使用，需要自行安装 `markmap-lib`、`markmap-view`、`mermaid`，并在调用前先导入一次 `@netless/appliance-plugin/markmap`。
+
 ```ts
 import { ApplianceMultiPlugin } from '@netless/appliance-plugin';
+import '@netless/appliance-plugin/markmap';
+
 const plugin = await ApplianceMultiPlugin.getInstance(manager, {
     options: {
         cdn: {...}

package/README.md

@@ -303,8 +303,8 @@ The following interfaces are involved:
 - `getElements` - Get all elements in the specified scene (Version >=1.1.19)
 - `stopDraw` - Stop Draw event (Version >=1.1.19)
 - `setViewLocalScenePathChange` - Set the local scene path change for the whiteboard view (Version >=1.1.27)
-- `insertMarkmap` - Insert markdown text to whiteboard (Version >=1.1.32) **This method requires enabling extras.useBackgroundThread**
-- `updateMarkmap` - Update markdown text in whiteboard (Version >=1.1.32) **This method requires enabling extras.useBackgroundThread**
+- `insertMarkmap` - Insert markdown text to whiteboard (Version >=1.1.32) **This method requires enabling extras.useBackgroundThread. It cannot be used directly from the default package entry. Business projects that need Markmap must install `markmap-lib`, `markmap-view`, and `mermaid`, then import `@netless/appliance-plugin/markmap` before calling it.**
+- `updateMarkmap` - Update markdown text in whiteboard (Version >=1.1.32) **This method requires enabling extras.useBackgroundThread. It cannot be used directly from the default package entry. Business projects that need Markmap must install `markmap-lib`, `markmap-view`, and `mermaid`, then import `@netless/appliance-plugin/markmap` before calling it.**
 - `insertBackgroundImage` - Insert whiteboard background image (Version >=1.1.32) **This method requires enabling extras.useBackgroundThread**
 
 5. Selector / Element extension APIs
@@ -716,8 +716,13 @@ html {
 ```
 
 ##### Insert Mind Map (requires markdown text) (Version >=1.1.32)
+
+> `insertMarkmap` and `updateMarkmap` are optional Markmap APIs. They cannot be used directly after importing only `@netless/appliance-plugin`. If your project needs them, install `markmap-lib`, `markmap-view`, and `mermaid`, and import `@netless/appliance-plugin/markmap` once before calling either API.
+
 ```ts
 import { ApplianceMultiPlugin } from '@netless/appliance-plugin';
+import '@netless/appliance-plugin/markmap';
+
 const plugin = await ApplianceMultiPlugin.getInstance(manager, {
     options: {
         cdn: {...}

package/dist/appliance-plugin.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-BW3Xkxk-.js");exports.ActiveContainerType=e.ActiveContainerType;exports.ApplianceMultiPlugin=e.ApplianceMultiPlugin;exports.ApplianceNames=e.ApplianceNames;exports.ApplianceSigleWrapper=e.ApplianceSigleWrapper;exports.ApplianceSinglePlugin=e.ApplianceSinglePlugin;exports.Cursor_Hover_Id=e.Cursor_Hover_Id;exports.ECanvasShowType=e.ECanvasShowType;exports.EDataType=e.EDataType;exports.EForceStopReason=e.EForceStopReason;exports.EImageType=e.EImageType;exports.EMatrixrRelationType=e.EMatrixrRelationType;exports.EOperationType=e.EOperationType;exports.EPostMessageType=e.EPostMessageType;exports.ERenderFilterType=e.ERenderFilterType;exports.ESVGType=e.ESVGType;exports.EScaleType=e.EScaleType;exports.EStrokeType=e.EStrokeType;exports.EToolsKey=e.EToolsKey;exports.ElayerType=e.ElayerType;exports.EmitEventType=e.EmitEventType;exports.EventMessageType=e.EventMessageType;exports.EventWorkState=e.EventWorkState;exports.EvevtWorkState=e.EventWorkState;exports.InternalMsgEmitterType=e.InternalMsgEmitterType;exports.Main_View_Id=e.Main_View_Id;exports.Plugin=e.Plugin;exports.ShapeType=e.ShapeType;exports.Task_Time_Interval=e.Task_Time_Interval;exports.fullWorkerUrl=e.fullWorker;exports.subWorkerUrl=e.subWorker;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-CsPVcYdq.js");exports.ActiveContainerType=e.ActiveContainerType;exports.ApplianceMultiPlugin=e.ApplianceMultiPlugin;exports.ApplianceNames=e.ApplianceNames;exports.ApplianceSigleWrapper=e.ApplianceSigleWrapper;exports.ApplianceSinglePlugin=e.ApplianceSinglePlugin;exports.Cursor_Hover_Id=e.Cursor_Hover_Id;exports.ECanvasShowType=e.ECanvasShowType;exports.EDataType=e.EDataType;exports.EForceStopReason=e.EForceStopReason;exports.EImageType=e.EImageType;exports.EMatrixrRelationType=e.EMatrixrRelationType;exports.EOperationType=e.EOperationType;exports.EPostMessageType=e.EPostMessageType;exports.ERenderFilterType=e.ERenderFilterType;exports.ESVGType=e.ESVGType;exports.EScaleType=e.EScaleType;exports.EStrokeType=e.EStrokeType;exports.EToolsKey=e.EToolsKey;exports.ElayerType=e.ElayerType;exports.EmitEventType=e.EmitEventType;exports.EventMessageType=e.EventMessageType;exports.EventWorkState=e.EventWorkState;exports.EvevtWorkState=e.EventWorkState;exports.InternalMsgEmitterType=e.InternalMsgEmitterType;exports.Main_View_Id=e.Main_View_Id;exports.Plugin=e.Plugin;exports.ShapeType=e.ShapeType;exports.Task_Time_Interval=e.Task_Time_Interval;exports.fullWorkerUrl=e.fullWorker;exports.subWorkerUrl=e.subWorker;

package/dist/appliance-plugin.mjs

@@ -1,4 +1,4 @@
-import { a7 as s, a8 as p, a9 as r, aa as t, ab as i, a4 as l, Z as n, b as E, ac as o, t as T, j as y, ad as v, a as g, ae as S, d as c, u, w as k, c as m, af as M, E as _, ag as d, v as A, v as I, ah as W, Y as P, ai as b, aj as f, a6 as h, ak as w, al as C } from "./index-TIV0naEi.mjs";
+import { a7 as s, a8 as p, a9 as r, aa as t, ab as i, a4 as l, Z as n, b as E, ac as o, t as T, j as y, ad as v, a as g, ae as S, d as c, u, w as k, c as m, af as M, E as _, ag as d, v as A, v as I, ah as W, Y as P, ai as b, aj as f, a6 as h, ak as w, al as C } from "./index-C2MVZqzb.mjs";
 export {
   s as ActiveContainerType,
   p as ApplianceMultiPlugin,