@netless/appliance-plugin 1.1.35 → 1.1.36-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/READMA.zh-CN.md +36 -0
- package/README.md +6 -0
- package/cdn/cdn.js +1 -1
- package/cdn/{fullWorker-BBlLKX.js → fullWorker-uAwmRi.js} +110 -110
- package/cdn/{subWorker-CoPwom.js → subWorker-BVNpAC.js} +110 -110
- package/dist/appliance-plugin.js +1 -1
- package/dist/appliance-plugin.mjs +1 -1
- package/dist/assets/fullWorker-B_mvkoeW.js +593 -0
- package/dist/assets/subWorker-CRdsidWT.js +593 -0
- package/dist/{bridge-DUU4aNx2.mjs → bridge-DYkH1J6p.mjs} +6 -6
- package/dist/{bridge-28U3vx4e.js → bridge-enxPG6qf.js} +1 -1
- package/dist/bridge.js +1 -1
- package/dist/bridge.mjs +1 -1
- package/dist/collector/collector.d.ts +1 -0
- package/dist/collector/types.d.ts +5 -1
- package/dist/component/textEditor/manager.d.ts +9 -1
- package/dist/component/textEditor/types.d.ts +5 -0
- package/dist/component/textEditor/utils.d.ts +21 -0
- package/dist/component/textEditor/view.d.ts +0 -4
- package/dist/core/enum.d.ts +3 -1
- package/dist/core/mainEngine.d.ts +4 -1
- package/dist/core/msgEvent/copyNode/forMain.d.ts +3 -0
- package/dist/core/msgEvent/copyNode/utils.d.ts +9 -0
- package/dist/core/msgEvent/deleteNode/forMain.d.ts +1 -0
- package/dist/core/msgEvent/setColor/forMain.d.ts +2 -0
- package/dist/core/msgEvent/setFont/forMain.d.ts +1 -0
- package/dist/core/msgEvent/setLock/forMain.d.ts +1 -0
- package/dist/core/msgEvent/setShape/forMain.d.ts +1 -0
- package/dist/core/msgEvent/setZIndex/forMain.d.ts +2 -0
- package/dist/core/tools/pencil.d.ts +1 -0
- package/dist/core/tools/selector.d.ts +4 -0
- package/dist/core/types.d.ts +6 -0
- package/dist/core/worker/fullWorkerLocal.d.ts +4 -4
- package/dist/core/worker/simpleWorker.d.ts +2 -2
- package/dist/displayer/floatBar/dragBox/activateSelectorText.d.ts +13 -0
- package/dist/displayer/floatBar/dragBox/selectorSwitch.d.ts +19 -0
- package/dist/fullWorker.js +110 -110
- package/dist/index-2On9v0Ff.mjs +19693 -0
- package/dist/index-BSD0B_eV.js +1 -0
- package/dist/{index-0fHpKu9i.mjs → index-BZql6xgR.mjs} +1 -1
- package/dist/index-Bm90lQii.js +1 -0
- package/dist/{index-CJN2Kuo1.mjs → index-BrJL-fin.mjs} +3253 -3069
- package/dist/{index-DP9oeLip.js → index-CIjmeY9J.js} +1 -1
- package/dist/{index-MFIjYwT5.js → index-CcS9cKSp.js} +1 -1
- package/dist/index-D4z0hSjm.js +1 -0
- package/dist/{index-BXXQq9TJ.mjs → index-D8SnD90W.mjs} +1 -1
- package/dist/index-DbI0V6BY.mjs +19719 -0
- package/dist/{index-CZRunvvh.mjs → index-K9QVPOhV.mjs} +3253 -3069
- package/dist/index-W9Jz9E04.js +1 -0
- package/dist/plugin/baseApplianceManager.d.ts +7 -0
- package/dist/plugin/baseViewContainerManager.d.ts +23 -9
- package/dist/plugin/displayerView.d.ts +4 -1
- package/dist/plugin/elementCapability.d.ts +29 -0
- package/dist/plugin/multi/displayer/appViewDisplayerManager.d.ts +1 -0
- package/dist/plugin/multi/displayer/mainViewDisplayerManager.d.ts +1 -0
- package/dist/plugin/selectorApi.d.ts +135 -0
- package/dist/plugin/single/displayer/mainViewDisplayerManager.d.ts +1 -0
- package/dist/plugin/types.d.ts +334 -5
- package/dist/plugin/utils.d.ts +9 -0
- package/dist/style.css +1 -1
- package/dist/subWorker.js +110 -110
- package/dist/undo/index.d.ts +45 -4
- package/dist/undo/timing.d.ts +50 -0
- package/package.json +12 -1
- package/dist/assets/fullWorker-Cud7fwjG.js +0 -593
- package/dist/assets/subWorker-BL9l8peV.js +0 -593
- package/dist/index-BXh3eQEk.js +0 -1
- package/dist/index-BsHV7nh_.js +0 -1
- package/dist/index-Crnj0IHn.mjs +0 -16625
- package/dist/index-pEXetfdb.js +0 -1
- package/dist/index-vyNIKk26.js +0 -1
- package/dist/index-zUtKU6c_.mjs +0 -16599
package/READMA.zh-CN.md
CHANGED
|
@@ -47,6 +47,10 @@ appliance-plugin 是一个高性能的白板绘制插件,依赖 [white-web-sdk
|
|
|
47
47
|
npm install @netless/appliance-plugin
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
+
> **Fastboard full 包说明:** 如果你是通过 `@netless/fastboard-full` 或 `@netless/fastboard-react-full` 配合 `enableAppliancePlugin` 使用,请安装带有 `./bridge` 导出的 `@netless/appliance-plugin` 版本,建议 `>= 1.1.35`(`./bridge` 首次出现在 `>= 1.1.34-beta.2`)。
|
|
51
|
+
>
|
|
52
|
+
> 业务代码继续引用 `@netless/appliance-plugin` 即可,不需要也不建议手动改成 `@netless/appliance-plugin/bridge`。`@netless/appliance-plugin/bridge` 由 fastboard full 在内部加载,用来复用 full 内部已经 bundled 的 `white-web-sdk` runtime。
|
|
53
|
+
|
|
50
54
|
### 注册插件
|
|
51
55
|
|
|
52
56
|
插件可以支持两种场景,它们接入插件命名不同:
|
|
@@ -156,6 +160,8 @@ const fastboard = await createFastboard({
|
|
|
156
160
|
});
|
|
157
161
|
```
|
|
158
162
|
|
|
163
|
+
> **注意:** 在 fastboard full 模式下,`@netless/fastboard-full` / `@netless/fastboard-react-full` 会在内部加载 `@netless/appliance-plugin/bridge`。业务代码只需要配置 `enableAppliancePlugin` 并提供 worker 地址,同时继续引用 `@netless/appliance-plugin` 即可;不需要也不建议手动引入 `@netless/appliance-plugin/bridge`。
|
|
164
|
+
|
|
159
165
|
#### 多窗口(直接对接window-manager)
|
|
160
166
|
|
|
161
167
|
```js
|
|
@@ -330,6 +336,36 @@ injectMethodToObject(windowmanager.mainView,'setMemberState');
|
|
|
330
336
|
- `updateMarkmap` - 修改白板中的markdow文本 (Version >=1.1.32) **该方法需要开启extras.useBackgroundThread**
|
|
331
337
|
- `insertBackgroundImage` - 插入白板的背景图片 (Version >=1.1.32) **该方法需要开启extras.useBackgroundThread**
|
|
332
338
|
|
|
339
|
+
6. Selector / Element 扩展接口
|
|
340
|
+
- `getSelectedElements(viewId?)` - 获取当前 selector 选中快照
|
|
341
|
+
- `blurSelector(viewId?)` - 取消当前 selector 选中
|
|
342
|
+
- `updateSelectedElements(viewId?, changes)` - 更新当前 selector 选中集的属性
|
|
343
|
+
- `copySelectedElements(viewId?)` - 复制当前 selector 选中集
|
|
344
|
+
- `deleteSelectedElements(viewId?)` - 删除当前 selector 选中集
|
|
345
|
+
- `updateElement(elementId, scenePath, viewId, updateElementInfo, useUndoRedoStack?)` - 单元素最终态更新接口,返回 `Promise<boolean>`
|
|
346
|
+
|
|
347
|
+
其中需要注意:
|
|
348
|
+
|
|
349
|
+
- `updateSelectedElements(...)` 是 selector-only 能力,只处理当前选中的 selector 集合
|
|
350
|
+
- `updateElement(...)` 是 storage-first 的单元素最终态更新通知接口
|
|
351
|
+
- `updateElement(...)` 不表达调用返回时已经渲染完成
|
|
352
|
+
- `updateElement(...)` 不支持 selector
|
|
353
|
+
- `updateElementInfo` 需要显式携带 `toolsType`,并按教具类型声明对应字段
|
|
354
|
+
- `updateElement(...)` 返回 `Promise<boolean>`,仅表示本次调用是否通过基础校验并成功发起
|
|
355
|
+
|
|
356
|
+
7. Selector 扩展事件
|
|
357
|
+
- `selectedElementsChange`
|
|
358
|
+
- 只在 `selectedIds` 变化时触发
|
|
359
|
+
- 只表示最终选中集合变化
|
|
360
|
+
- `selectorGeometryChange`
|
|
361
|
+
- 只表示最终几何结果变化
|
|
362
|
+
- 坐标统一为 `viewRect`
|
|
363
|
+
- `selectorTransformChange`
|
|
364
|
+
- 只表示拖拽、拉伸、旋转、端点编辑等过程态
|
|
365
|
+
- 只暴露 `viewId + emitEventType + workState`
|
|
366
|
+
- `remoteSelectorChange`
|
|
367
|
+
- 表示远端 / 被同步端 selector 的同步结果变化
|
|
368
|
+
|
|
333
369
|
5. 不兼容接口
|
|
334
370
|
- [`exportScene`](https://doc.shengwang.cn/api-ref/whiteboard/javascript/interfaces/room#exportScene) - appliance-plugin 开启后,笔记不能按 room 的方式导出
|
|
335
371
|
- [服务端截图](https://doc.shengwang.cn/doc/whiteboard/restful/fastboard-sdk/restful-wb/operations/post-v5-rooms-uuid-screenshots) - appliance-plugin 开启后,笔记不能通过调用服务端截图方式获取截图,而需要改用 `screenshotToCanvasAsync` 获取
|
package/README.md
CHANGED
|
@@ -47,6 +47,10 @@ The plugin supports the following drawing tools:
|
|
|
47
47
|
npm install @netless/appliance-plugin
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
+
> **Fastboard full packages:** If you are using `@netless/fastboard-full` or `@netless/fastboard-react-full` together with `enableAppliancePlugin`, install an `@netless/appliance-plugin` version that exposes `./bridge`. We recommend `>= 1.1.35` (`./bridge` first appeared in `>= 1.1.34-beta.2`).
|
|
51
|
+
>
|
|
52
|
+
> Keep importing `@netless/appliance-plugin` in app code. You do not need, and generally should not, replace it with `@netless/appliance-plugin/bridge`. The `/bridge` entry is loaded internally by fastboard full to reuse the bundled `white-web-sdk` runtime.
|
|
53
|
+
|
|
50
54
|
### Register Plugin
|
|
51
55
|
|
|
52
56
|
Plugins can support two scenarios, they have different plugin names:
|
|
@@ -157,6 +161,8 @@ const fastboard = await createFastboard({
|
|
|
157
161
|
});
|
|
158
162
|
```
|
|
159
163
|
|
|
164
|
+
> **Note:** In fastboard full mode, `@netless/fastboard-full` / `@netless/fastboard-react-full` load `@netless/appliance-plugin/bridge` internally. App code only needs to configure `enableAppliancePlugin`, provide worker URLs, and keep importing `@netless/appliance-plugin`; do not manually switch your import to `@netless/appliance-plugin/bridge`.
|
|
165
|
+
|
|
160
166
|
#### Multi-window (Direct integration with window-manager)
|
|
161
167
|
|
|
162
168
|
```js
|
package/cdn/cdn.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r="/fullWorker-
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r="/fullWorker-uAwmRi.js",e="/subWorker-BVNpAC.js";exports.fullWorkerUrl=r;exports.subWorkerUrl=e;
|