@netless/appliance-plugin 1.0.1 → 1.0.3

package/README.md

@@ -11,8 +11,8 @@ A whiteboard pencil drawing plugin based on SpriteJS as a rendering engine.
 The following two demos are implemented in the example folder for reference only. 
 | scenario | demo path | depends on | 
 | :-- | :----: | :-- | 
-| multi-window | example/src/multi.ts | @netless/window-manager, white-web-sdk | 
-| white-board | example/src/single.ts | white-web-sdk | 
+| multi-window | [example/src/multi.ts](https://github.com/hqer927/appliance-plugin/blob/master/example/src/multi.ts)    | @netless/window-manager、white-web-sdk |
+| white-board | [example/src/single.ts](https://github.com/hqer927/appliance-plugin/blob/master/example/src/single.ts)    | white-web-sdk |
 <!-- | fastboard | todo | todo | -->
  
 ## Principle 
@@ -71,7 +71,7 @@ const room = await whiteWebSdk.joinRoom({
 invisiblePlugins: [WindowManager, ApplianceMultiPlugin], 
 useMultiViews: true, 
 }) 
-const manager = await WindowManager.mount({ room , container:elm, chessboard: true, cursor: true, supportTeachingAidsPlugin: true}); 
+const manager = await WindowManager.mount({ room , container:elm, chessboard: true, cursor: true, supportAppliancePlugin: true}); 
 if (manager) { 
 await manager.switchMainViewToWriter(); 
 await ApplianceMultiPlugin.getInstance(manager,
@@ -134,8 +134,29 @@ module: {
 },
 ``` 
  
-### Call introduction 
-The plug-in re-implements some interfaces of the same name on room or window or manager. If you do not use the interface on the plug-in, you will not get the desired effect. But we can use injectMethodToObject to re-inject it back into the original object to get the plugin's intended effect. As follows: 
+## Call introduction 
+### api introduction
+The plugin re-implements some of the interfaces of the same name on room or Windows Manager, but internally we have re-injected them back into the original object via injectMethodToObject. No changes are required for external users. As follows:
+```js
+    // Internal hack
+    injectMethodToObject(windowmanager, 'undo');
+    injectMethodToObject(windowmanager, 'redo');
+    injectMethodToObject(windowmanager,'cleanCurrentScene');
+    injectMethodToObject(windowmanager,'insertImage');
+    injectMethodToObject(windowmanager,'completeImageUpload');
+    injectMethodToObject(windowmanager,'lockImage');
+    injectMethodToObject(room,'getImagesInformation');
+    injectMethodToObject(room,'callbacks');
+    injectMethodToObject(room,'screenshotToCanvasAsync');
+    injectMethodToObject(room,'getBoundingRectAsync');
+    injectMethodToObject(room,'scenePreviewAsync');
+    injectMethodToObject(windowmanager.mainView,'setMemberState');
+    // These we can see the call behavior through the front-end log, for example:
+    // [ApplianceMultiPlugin] setMemberState
+    // [ApplianceMultiPlugin] cleanCurrentScene
+```
+The following interfaces are involved:
+
 1. Interface on room 
 - `setMemberState` 
 - `undo` 
@@ -165,13 +186,30 @@ The plug-in re-implements some interfaces of the same name on room or window or
 - `getBoundingRectAsync` 
 - `screenshotToCanvasAsync` 
 - `scenePreviewAsync` 
-- `destroy` 
-- `injectMethodToObject` 
- 
-**The injectMethodToObject interface can rebind the plugin's reimplemented method to the desired object.** For example: 
- 
+- `destroy`
+
+### Configure parameters 
+``getInstance(wm: WindowManager, adaptor: ApplianceAdaptor)`` 
+- wm: WindowManager\room\player. In multi-window mode, you pass WindowManager, and in single-window mode, you pass room or player(whiteboard playback mode). 
+- adaptor: configures the adapter. 
+    - options: ``AppliancePluginOptions``; The cdn addresses of both workers must be configured. 
+        ```js 
+            export type AppliancePluginOptions = { 
+                /** cdn Configuration item */ 
+                cdn: CdnOpt; 
+                /** Synchronize data configuration items */ 
+                syncOpt? : SyncOpt; 
+                /** Canvas configuration item */ 
+                canvasOpt? : CanvasOpt; 
+            } 
+        ```
+    - cursorAdapter? : ``CursorAdapter``; This parameter is optional. In single whiteboard mode, customize the mouse style.
+
+### Front-end debugging introduction 
+During the interconnection process, if you want to understand and track the internal status of the plug-in, you can view the internal data through the following console commands. 
+
 ```js 
-// The purpose is to bind the plugin's undo operation to room. Keep outside calls to undo logic from room. 
-plugin.injectMethodToObject(room,'undo'); 
-``` 
-So, the interface of the same name on room,window-manager, or Window-Manager.mainView can be injected into the original object using injectMethodToObject.
+const applianPlugin = await ApplianceSinglePlugin.getInstance(...) 
+applianPlugin.CurrentManager  // can see the package version number, internal state, etc 
+applianPlugin.CurrentManager.ConsoleWorkerInfo () // can check information to draw on the worker 
+```

package/cdn/cdn.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r="/fullWorker-CIvt1j.js",e="/subWorker-BE-0dg.js";exports.fullWorkerUrl=r;exports.subWorkerUrl=e;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r="/fullWorker-uIttd_.js",e="/subWorker-4wkCzC.js";exports.fullWorkerUrl=r;exports.subWorkerUrl=e;