@glodon-ecs/web-bridge-sdk 0.1.1 → 0.3.0

package/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "endOfLine": "auto"
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 发布日志
+
+#### 0.3.0
+
+- 兼容 CC 方法调用中需要监听异步回调事件，才能在回调事件中返回返回值
+
+#### 0.2.0
+
+- 兼容 SU 事件取消后，回调函数继续被调用时，函数不存在报错
+
+#### 0.1.0
+
+第一版 SDK

package/README.md

@@ -1,57 +1,68 @@
-## ECS-BRIDGE-SDK
-
-> ECS 通信桥接 SDK
-
-- node >= 16
-
-### 使用示例
-
-```js
-import ECSHubBridge from "@glodon-ecs/web-bridge-sdk";
-
-// 使用示例
-async function main() {
-  // initialize 方法需要先被调用
-
-  await ECSHubBridge.initialize({ env: "sketchup" });
-  const bridge = ECSHubBridge.getInstance();
-
-  // 调用方法
-  const data = await bridge.callMethod("getInitialData", "param1");
-
-  // 订阅
-  const unsubscribe = bridge.subscribe("modelChanged", (data) => {});
-}
-```
-
-#### 扩展适配器
-
-> 需要实现如下三个内部方法
-
-```js
-class CADAdapter {
-  // 初始方法
-  async init() {
-    this._client = window.CADPlugin; // 假设第三方CAD插件
-  }
-
-  // 调用内部函数
-  call(method, args) {
-    return this._client.execCommand(method, ...args);
-  }
-
-  // 注册事件监听
-  onEvent(event, callback) {
-    this._client.on(event, callback);
-    return () => this._client.off(event, callback);
-  }
-}
-
-// 注入自定义适配器
-await ECSHubBridge.initialize();
-ECSHubBridge.setAdapter(new CADAdapter());
-
-// 设置自定义适配器的client交互对象，如 ecsClient
-await ECSHubBridge.initialize();
-ECSHubBridge.setAdapterClient(new ECS({...}));
-```
+## ECS-BRIDGE-SDK
+
+ECSHub Panel 存在与多个宿主环境交互的场景，因此抽离出桥接的 SDK，以适配不同宿主环境。
+
+已支持：
+
+- [x] SketchUp
+- [ ] QT
+- [x] Web(for test)
+- [ ] Rhino
+- [-] Concetto
+
+### 前置项
+
+- node >= 16
+
+### 使用示例
+
+```js
+import ECSHubBridge from '@glodon-ecs/web-bridge-sdk';
+
+// 使用示例
+async function main() {
+  // initialize 方法需要先被调用
+  // await ECSHubBridge.initialize(); // 自动检测初始化，QT、SU、Web环境
+  const options = { env: 'sketchup', logger: window.console }; // options 可选
+  await ECSHubBridge.initialize(options);
+  const bridge = ECSHubBridge.getInstance();
+
+  // 调用方法
+  const data = await bridge.callMethod('getInitialData', 'param1');
+
+  // 订阅
+  const unsubscribe = bridge.subscribe('modelChanged', (data) => {});
+}
+```
+
+#### 扩展适配器
+
+> 需要实现如下三个内部方法
+
+```js
+class CADAdapter {
+  // 初始方法
+  async init() {
+    this.client = window.CADPlugin; // 假设第三方CAD插件
+  }
+
+  // 调用内部函数
+  call(method, args, options) {
+    return this.client.execCommand(method, args, options);
+  }
+
+  // 注册事件监听
+  onEvent(event, callback) {
+    this.client.on(event, callback);
+    return () => this.client.off(event, callback);
+  }
+}
+
+// 注入自定义适配器
+await ECSHubBridge.initialize();
+ECSHubBridge.setAdapter(new CADAdapter(), 'cad');
+
+// 设置自定义适配器的client交互对象，如 ecsClient
+await ECSHubBridge.initialize();
+ECSHubBridge.setAdapterClient(new ECS({...}));
+```