@glodon-ecs/web-bridge-sdk 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,17 +1,21 @@
-## 发布日志
-
-#### 0.4.0
-
-- 从js迁移到ts，SDK支持类型系统
-
-#### 0.3.0
-
-- 兼容 CC 方法调用中需要监听异步回调事件，才能在回调事件中返回返回值
-
-#### 0.2.0
-
-- 兼容 SU 事件取消后，回调函数继续被调用时，函数不存在报错
-
-#### 0.1.0
-
-第一版 SDK
+## 发布日志
+
+#### 0.5.0
+
+- 支持CCWeb(qiankun)
+
+#### 0.4.0
+
+- 从js迁移到ts，SDK支持类型系统
+
+#### 0.3.0
+
+- 兼容 CC 方法调用中需要监听异步回调事件，才能在回调事件中返回返回值
+
+#### 0.2.0
+
+- 兼容 SU 事件取消后，回调函数继续被调用时，函数不存在报错
+
+#### 0.1.0
+
+第一版 SDK

package/README.md

@@ -1,95 +1,96 @@
-## ECS-BRIDGE-SDK
-
-ECSHub Panel 存在与多个宿主环境交互的场景，因此抽离出桥接的 SDK，以适配不同宿主环境。
-
-已支持：
-
-- [x] SketchUp
-- [ ] QT
-- [ ] Web(for test)
-- [ ] Rhino
-- [x] Concetto
-
-### 前置项
-
-- node >= 16
-
-### 安装
-
-```bash
-npm install @glodon-ecs/web-bridge-sdk
-```
-
-### 使用示例
-
-```ts
-import ECSHubBridge, { BridgeEnv } from '@glodon-ecs/web-bridge-sdk';
-// 或使用命名导入：import { ECSHubBridge, BridgeEnv } from "@glodon-ecs/web-bridge-sdk";
-
-// 使用示例
-async function main() {
-  // initialize 方法需要先被调用
-  // await ECSHubBridge.initialize(); // 自动检测初始化，QT、SU、Web环境
-  const options = { env: BridgeEnv.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) => {});
-
-  // 取消订阅
-  unsubscribe();
-}
-```
-
-#### 扩展适配器
-
-> 继承 `BaseAdapter` 并实现三个抽象方法
-
-```ts
-import { BaseAdapter } from '@glodon-ecs/web-bridge-sdk';
-import type { LoggerType } from '@glodon-ecs/web-bridge-sdk';
-
-class CADAdapter extends BaseAdapter {
-  // 初始方法
-  async init() {
-    this.client = window.CADPlugin; // 假设第三方CAD插件
-  }
-
-  // 调用内部函数
-  async call(method: string, args: unknown[]) {
-    return this.client.execCommand(method, ...args);
-  }
-
-  // 注册事件监听
-  onEvent(event: string, callback: (...args: unknown[]) => void) {
-    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(client);
-```
-
-### 导出列表
-
-| 导出            | 类型            | 说明                                                       |
-| --------------- | --------------- | ---------------------------------------------------------- |
-| `ECSHubBridge`  | class (default) | 桥接器主类                                                 |
-| `BridgeEnv`     | enum            | 环境枚举：`qt` / `web` / `sketchup` / `concetto` / `rhino` |
-| `BaseAdapter`   | abstract class  | 适配器基类，扩展适配器时继承                               |
-| `BridgeOptions` | interface       | 初始化配置项类型                                           |
-| `LoggerType`    | type            | 日志对象类型                                               |
-
-```
-
-```
+## ECS-BRIDGE-SDK
+
+ECSHub Panel 存在与多个宿主环境交互的场景，因此抽离出桥接的 SDK，以适配不同宿主环境。
+
+已支持：
+
+- [√] SketchUp
+- [ ] QT
+- [ ] Web(for test)
+- [ ] Rhino
+- [√] Concetto
+- [√] ConcettoWeb
+
+### 前置项
+
+- node >= 16
+
+### 安装
+
+```bash
+npm install @glodon-ecs/web-bridge-sdk
+```
+
+### 使用示例
+
+```ts
+import ECSHubBridge, { BridgeEnv } from '@glodon-ecs/web-bridge-sdk';
+// 或使用命名导入：import { ECSHubBridge, BridgeEnv } from "@glodon-ecs/web-bridge-sdk";
+
+// 使用示例
+async function main() {
+  // initialize 方法需要先被调用
+  // await ECSHubBridge.initialize(); // 自动检测初始化，QT、SU、Web环境
+  const options = { env: BridgeEnv.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) => {});
+
+  // 取消订阅
+  unsubscribe();
+}
+```
+
+#### 扩展适配器
+
+> 继承 `BaseAdapter` 并实现三个抽象方法
+
+```ts
+import { BaseAdapter } from '@glodon-ecs/web-bridge-sdk';
+import type { LoggerType } from '@glodon-ecs/web-bridge-sdk';
+
+class CADAdapter extends BaseAdapter {
+  // 初始方法
+  async init() {
+    this.client = window.CADPlugin; // 假设第三方CAD插件
+  }
+
+  // 调用内部函数
+  async call(method: string, args: unknown[]) {
+    return this.client.execCommand(method, ...args);
+  }
+
+  // 注册事件监听
+  onEvent(event: string, callback: (...args: unknown[]) => void) {
+    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(client);
+```
+
+### 导出列表
+
+| 导出            | 类型            | 说明                                                       |
+| --------------- | --------------- | ---------------------------------------------------------- |
+| `ECSHubBridge`  | class (default) | 桥接器主类                                                 |
+| `BridgeEnv`     | enum            | 环境枚举：`qt` / `web` / `sketchup` / `concetto` / `rhino` |
+| `BaseAdapter`   | abstract class  | 适配器基类，扩展适配器时继承                               |
+| `BridgeOptions` | interface       | 初始化配置项类型                                           |
+| `LoggerType`    | type            | 日志对象类型                                               |
+
+```
+
+```

package/lib/index.d.ts

@@ -33,7 +33,8 @@ export declare enum BridgeEnv {
     web = "web",
     sketchup = "sketchup",
     concetto = "concetto",
-    rhino = "rhino"
+    rhino = "rhino",
+    qiankun = "qiankun"
 }
 
 export declare interface BridgeOptions {
@@ -59,6 +60,7 @@ declare class ECSHubBridge {
      * @param {LoggerType} [options.logger] 日志输出对象
      */
     constructor(options?: BridgeOptions);
+    _isQiankun(): boolean;
     /**
      * 环境检测
      * @private