@jlceda/pro-api-types 0.1.167 → 0.1.169

package/index.d.ts

@@ -889,6 +889,7 @@ declare class EDA {
     sys_Log: SYS_Log;
     sys_Message: SYS_Message;
     sys_MessageBox: SYS_MessageBox;
+    sys_MessageBus: SYS_MessageBus;
     sys_PanelControl: SYS_PanelControl;
     sys_Setting: SYS_Setting;
     sys_ShortcutKey: SYS_ShortcutKey;
@@ -5374,7 +5375,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      *
      * @beta
      * @param solderMaskAndPasteMaskExpansion - 阻焊/助焊扩展
-     * @returns 焊盘图元对象
+     * @returns 焊盘��元对象
      */
     setState_SolderMaskAndPasteMaskExpansion(solderMaskAndPasteMaskExpansion: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null): IPCB_PrimitivePad;
     /**
@@ -6019,7 +6020,7 @@ declare class IPCB_PrimitiveRegion implements IPCB_Primitive {
      * 获取属性状态：是否锁定
      *
      * @public
-     * @returns 是否锁定
+     * @returns ���否锁定
      */
     getState_PrimitiveLock(): boolean;
     /**
@@ -6653,7 +6654,7 @@ declare class IPCB_PrimitiveVia implements IPCB_Primitive {
      *
      * @beta
      * @remarks 将会获取与过孔直接相连的导线、圆弧线图元对象
-     * @returns 相邻的导线、圆弧线图元对象
+     * @returns 相邻的导线、��弧线图元对象
      */
     getAdjacentPrimitives(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;
 }
@@ -7315,7 +7316,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
     private uniqueId?;
     /** Component 属性：制造商 */
     private manufacturer?;
-    /** Component 属性：制��商编号 */
+    /** Component 属性：制造商编号 */
     private manufacturerId?;
     /** Component 属性：供应商 */
     private supplier?;
@@ -9140,6 +9141,28 @@ declare interface ISYS_LogLine {
     message: string;
 }
 
+/**
+ * 消息总线任务
+ *
+ * @public
+ */
+declare interface ISYS_MessageBusTask {
+    /** 调用以取消任务 */
+    cancel: () => void;
+    /**
+     * 检查运行状态
+     *
+     * @returns 是否正在监听
+     */
+    running: () => boolean;
+    /**
+     * 任务处理
+     *
+     * @param message - 接收到的数据
+     */
+    execute: (message: any) => Promise<void>;
+}
+
 /**
  * 多语言数据
  *
@@ -9584,7 +9607,7 @@ declare class LIB_Device {
      *
      * 私有化部署环境暂无法使用本接口
      * @param lcscIds - 立创 C 编号数组
-     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获��
+     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
      * @param allowMultiMatch - 是否允许单个立创 C 编号匹配多个结果
      * @returns 搜索到的器件属性的列表
      */
@@ -9979,7 +10002,7 @@ declare class PCB_Document {
      * 输入画布坐标返回该坐标对应的数据坐标
      *
      * @public
-     * @remarks 嘉立创 EDA ��端显示的坐标均为画布原点；嘉立创 EDA API 使用的均为数据原点；在创建 PCB 时，默认画布原点等于数据原点
+     * @remarks 嘉立创 EDA 前端显示的坐标均为画布原点；嘉立创 EDA API 使用的均为数据原点；在创建 PCB 时，默认画布原点等于数据原点
      * @param canvasOriginX - 画布原点 X
      * @param canvasOriginY - 画布原点 Y
      * @returns 数据原点坐标
@@ -10055,9 +10078,48 @@ declare class PCB_Document {
      * @returns 操作是否成功
      */
     navigateToCoordinates(x: number, y: number): Promise<boolean>;
-    /* Excluded from this release type: navigateToRegion */
-    /* Excluded from this release type: getPrimitiveAtPoint */
-    /* Excluded from this release type: getPrimitivesInRegion */
+    /**
+     * 定位到画布区域
+     *
+     * @beta
+     * @remarks
+     * 本接口在前端画布上定位到指定的区域，区域数据为相对于数据原点的偏移；
+     *
+     * 例如：传入数据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`，
+     * 则画布将会定位到以 `[30, 40]` 为中心的，`x` 轴方向长度为 `60`，`y` 轴方向长度为 `120` 的矩形范围；
+     *
+     * 本接口不进行缩放操作，但会生成指示定位中心及表示区域范围的矩形框；
+     *
+     * 此处的单位为数据层面单位，在跨度上等同于画布层面的 mil
+     * @param left - 矩形框第一 X 坐标
+     * @param right - 矩形框第二 X 坐标
+     * @param top - 矩形框第一 Y 坐标
+     * @param bottom - 矩形框第二 Y 坐标
+     * @returns 操作是否成功
+     */
+    navigateToRegion(left: number, right: number, top: number, bottom: number): Promise<boolean>;
+    /**
+     * 获取坐标点的图元
+     *
+     * @beta
+     * @remarks 本操作和前端鼠标点击操作类似，将会获取指定坐标点上的图元
+     * @param x - 坐标点 X
+     * @param y - 坐标点 Y
+     * @returns 坐标点的图元，如若坐标点无法找到图元，将返回 `undefined`
+     */
+    getPrimitiveAtPoint(x: number, y: number): Promise<IPCB_Primitive | undefined>;
+    /**
+     * 获取区域内所有图元
+     *
+     * @beta
+     * @param left - 矩形框第一 X 坐标
+     * @param right - 矩形框第二 X 坐标
+     * @param top - 矩形框第一 Y 坐标
+     * @param bottom - 矩形框第二 Y 坐标
+     * @param leftToRight - 是否仅获取完全框选的图元，`false` 则触碰即获取
+     * @returns 区域内所有图元
+     */
+    getPrimitivesInRegion(left: number, right: number, top: number, bottom: number, leftToRight?: boolean): Promise<Array<IPCB_Primitive>>;
     /**
      * 缩放到板框（适应板框）
      *
@@ -10065,6 +10127,7 @@ declare class PCB_Document {
      * @returns 操作是否成功
      */
     zoomToBoardOutline(): Promise<boolean>;
+    /* Excluded from this release type: getCurrentFilterConfiguration */
 }
 
 /**
@@ -11892,7 +11955,7 @@ declare class PCB_PrimitivePad implements IPCB_PrimitiveAPI {
      * @beta
      * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 焊盘的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
-     * @returns 焊盘图元对象，空数组表示获取失败
+     * @returns 焊盘图元���象，空数组表示获取失败
      */
     get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitivePad>>;
     /**
@@ -11970,7 +12033,7 @@ declare class PCB_PrimitivePolyline implements IPCB_PrimitiveAPI {
      * 获取折线
      *
      * @beta
-     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可���返回少于传入的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 折线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 折线图元对象，空数组表示获取失败
      */
@@ -12391,6 +12454,7 @@ declare class SCH_Document {
     /* Excluded from this release type: navigateToRegion */
     /* Excluded from this release type: getPrimitiveAtPoint */
     /* Excluded from this release type: getPrimitivesInRegion */
+    /* Excluded from this release type: getCurrentFilterConfiguration */
 }
 
 /**
@@ -12404,7 +12468,7 @@ declare class SCH_Drc {
      * 检查 DRC
      *
      * @public
-     * @remarks 如若检查结果存在 **错误** 或以上级别，将会始终呼出底��� DRC 窗口，无视 `userInterface` 参数
+     * @remarks 如若检查结果存在 **错误** 或以上级别，将会始终呼出底部 DRC 窗口，无视 `userInterface` 参数
      * @param strict - 是否严格检查，严格检查时存在 Warning 将返回 `false`，否则返回 `true`
      * @param userInterface - 是否显示 UI（呼出底部 DRC 窗口）
      * @returns DRC 检查是否无错误
@@ -13954,7 +14018,7 @@ declare class SYS_Dialog {
     showSelectDialog(options: Array<string> | Array<{
         value: string;
         displayContent: string;
-    }>, beforeContent?: string, afterContent?: string, title?: string, defaultOption?: string, multiple?: false, callbackFn?: (value: string) => void): void;
+    }>, beforeContent?: string, afterContent?: string, title?: string, defaultOption?: string, multiple?: false, callbackFn?: (value: string) => void | Promise<void>): void;
     /**
      * 弹出多选窗口
      *
@@ -13976,7 +14040,8 @@ declare class SYS_Dialog {
     showSelectDialog(options: Array<string> | Array<{
         value: string;
         displayContent: string;
-    }>, beforeContent?: string, afterContent?: string, title?: string, defaultOption?: Array<string>, multiple?: true, callbackFn?: (value: Array<string>) => void): void;
+    }>, beforeContent?: string, afterContent?: string, title?: string, defaultOption?: Array<string>, multiple?: true, callbackFn?: (value: Array<string>) => void | Promise<void>): void;
+    /* Excluded from this release type: insertScriptToDialog */
 }
 
 /**
@@ -14186,8 +14251,72 @@ declare class SYS_FileManager {
      * @returns 面板库文件数据，`undefined` 表示数据获取失败
      */
     getPanelLibraryFileByPanelLibraryUuid(panelLibraryUuid: string | Array<string>, libraryUuid?: string): Promise<File | undefined>;
-    /* Excluded from this release type: importProjectByProjectFile */
-    /* Excluded from this release type: importProjectByProjectFile */
+    /**
+     * 使用工程文件导入工程
+     *
+     * @beta
+     * @remarks 暂不支持提取库的相关配置，如果需求提取库，将会按照默认配置提取
+     * @param projectFile - 工程文件
+     * @param fileType - 文件类型
+     * @param props - 导入参数，参考 EDA 前端 **导入** 窗口内的配置项
+     * @param saveTo - 保存到工程参数
+     * @returns 导入的工程的简略工程属性
+     */
+    importProjectByProjectFile(projectFile: File, fileType?: 'JLCEDA' | 'JLCEDA Pro' | 'EasyEDA' | 'EasyEDA Pro' | 'Allegro' | 'OrCAD' | 'EAGLE' | 'KiCad' | 'PADS' | 'LTspice', props?: {
+        importOption?: EImportOptionType;
+        schematicObjectStyle?: ESchPrimitiveStyle;
+        associateFootprint?: boolean;
+        associate3DModel?: boolean;
+        importFootprintNotesLayer?: boolean;
+    }, saveTo?: {
+        operation: 'New Project';
+        newProjectOwnerTeamUuid: IDMT_TeamItem['uuid'];
+        newProjectOwnerFolderUuid?: IDMT_FolderItem['uuid'];
+        newProjectName?: string;
+        newProjectFriendlyName?: string;
+        newProjectDescription?: string;
+        newProjectCollaborationMode?: EDMT_ProjectCollaborationMode;
+    } | {
+        operation: 'Existing Project';
+        existingProjectUuid: IDMT_BriefProjectItem['uuid'];
+    }, librariesImportSetting?: {
+        ownerTeamUuid: IDMT_TeamItem['uuid'];
+        createDeviceForSingleSymbol?: boolean;
+    }): Promise<IDMT_BriefProjectItem | undefined>;
+    /**
+     * 使用工程文件导入工程
+     *
+     * @beta
+     * @remarks 暂不支持提取库的相关配置，如果需求提取库，将会按照默认配置提取
+     * @param projectFile - 工程文件
+     * @param fileType - 文件类型
+     * @param props - 导入参数，参考 EDA 前端 **导入** 窗口内的配置项
+     * @param saveTo - 保存到工程参数
+     * @returns 导入的工程的简略工程属性
+     */
+    importProjectByProjectFile(projectFile: File, fileType?: 'Altium Designer' | 'Protel', props?: {
+        importOption?: EImportOptionType;
+        viaSolderMaskExpansion?: EViaSolderMaskExpansion;
+        boardOutlineSource?: EBoardOutlineSourceType;
+        schematicObjectStyle?: ESchPrimitiveStyle;
+        associateFootprint?: boolean;
+        associate3DModel?: boolean;
+        importFootprintNotesLayer?: boolean;
+    }, saveTo?: {
+        operation: 'New Project';
+        newProjectOwnerTeamUuid: IDMT_TeamItem['uuid'];
+        newProjectOwnerFolderUuid?: IDMT_FolderItem['uuid'];
+        newProjectName?: string;
+        newProjectFriendlyName?: string;
+        newProjectDescription?: string;
+        newProjectCollaborationMode?: EDMT_ProjectCollaborationMode;
+    } | {
+        operation: 'Existing Project';
+        existingProjectUuid: IDMT_BriefProjectItem['uuid'];
+    }, librariesImportSetting?: {
+        ownerTeamUuid: IDMT_TeamItem['uuid'];
+        createDeviceForSingleSymbol?: boolean;
+    }): Promise<IDMT_BriefProjectItem | undefined>;
 }
 
 /**
@@ -14469,19 +14598,29 @@ declare class SYS_IFrame {
      * 内联框架需要展示 `htmlFileName` 的内容，该 HTML 从扩展包内获取，并已在安装时被存储至 IndexedDB 中
      *
      * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
-     * @param htmlFileName - 需要加载的 HTML 文件在扩展包内的路径
+     * @param htmlFileName - 需要加载的 HTML 文件在扩展包内的路径，从扩展根目录起始，例如 `/iframe/index.html`
      * @param width - 内联框架窗口的宽度
      * @param height - 内联框架窗口的高度
      * @param id - 内联框架窗口 ID，用于关闭内联框架窗口
+     * @param props - 其它参数
      * @returns 操作是否成功
      */
-    openIFrame(htmlFileName: string, width?: number, height?: number, id?: string): Promise<boolean>;
+    openIFrame(htmlFileName: string, width?: number, height?: number, id?: string, props?: {
+        /** 是否显示最大化按钮 */
+        maximizeButton?: boolean;
+        /** 是否显示最小化按钮 */
+        minimizeButton?: boolean;
+        /** 按钮点击回调 */
+        buttonCallbackFn?: (button: 'close' | 'minimize' | 'maximize') => void;
+        /** 是否背景置灰 */
+        grayscaleMask?: boolean;
+    }): Promise<boolean>;
     /**
      * 关闭内联框架窗口
      *
      * @beta
      * @remarks
-     * 关闭当前扩展打开的所有内联框架窗口；
+     * 关闭指定 ID 的内联框架窗口；
      *
      * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param id - 内联框架窗口 ID，如若传入 `undefined`，将关闭由本扩展打开的所有内联框架窗口
@@ -14677,6 +14816,179 @@ declare class SYS_MessageBox {
     showConfirmationMessage(content: string, title?: string, mainButtonTitle?: string, buttonTitle?: string, callbackFn?: (mainButtonClicked: boolean) => void): void;
 }
 
+/**
+ * 系统 / 消息总线类
+ *
+ * @public
+ */
+declare class SYS_MessageBus {
+    /** 扩展 UUID */
+    private extensionUuid?;
+    /* Excluded from this release type: __constructor */
+    /**
+     * 创建私有消息总线
+     *
+     * @public
+     * @remarks 一般无需调用该方法，在进行监听或发送消息时会自动创建私有消息总线
+     */
+    createPrivateMessageBus(): void;
+    /**
+     * 移除私有消息总线
+     *
+     * @public
+     * @remarks 一般无需调用该方法，除非你知道自己在做什么
+     */
+    removePrivateMessageBus(): void;
+    /**
+     * 私有消息总线：推消息
+     *
+     * @public
+     * @remarks 每个消息只有一个 Puller 可以收到
+     * @param topic - 主题
+     * @param message - 消息
+     */
+    push(topic: string, message: any): void;
+    /**
+     * 公共消息总线：推消息
+     *
+     * @public
+     * @remarks 每个消息只有一个 Puller 可以收到
+     * @param topic - 主题
+     * @param message - 消息
+     */
+    pushPublic(topic: string, message: any): void;
+    /**
+     * 私有消息总线：拉消息
+     *
+     * @public
+     * @remarks 每次只能拉一个消息
+     * @param topic - 主题
+     * @param callbackFn - 拉到消息后的回调
+     * @returns 消息总线任务
+     */
+    pull(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;
+    /**
+     * 公共消息总线：拉消息
+     *
+     * @public
+     * @remarks 每次只能拉一个消息
+     * @param topic - 主题
+     * @param callbackFn - 拉到消息后的回调
+     * @returns 消息总线任务
+     */
+    pullPublic(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;
+    /**
+     * 私有消息总线：拉消息 Promise 版本
+     *
+     * @public
+     * @remarks 每次只能拉一个消息，可以使用 `await` 等待消息拉取
+     * @param topic - 主题
+     * @returns 拉取到的消息
+     */
+    pullAsync(topic: string): Promise<any>;
+    /**
+     * 公共消息总线：拉消息 Promise 版本
+     *
+     * @public
+     * @remarks 每次只能拉一个消息，可以使用 `await` 等待消息拉取
+     * @param topic - 主题
+     * @returns 拉取到的消息
+     */
+    pullAsyncPublic(topic: string): Promise<any>;
+    /**
+     * 私有消息总线：发布消息
+     *
+     * @public
+     * @remarks 将消息广播给每一个 Subscriber
+     * @param topic - 主题
+     * @param message - 消息
+     */
+    publish(topic: string, message: any): void;
+    /**
+     * 公共消息总线：发布消息
+     *
+     * @public
+     * @remarks 将消息广播给每一个 Subscriber
+     * @param topic - 主题
+     * @param message - 消息
+     */
+    publishPublic(topic: string, message: any): void;
+    /**
+     * 私有消息总线：订阅消息
+     *
+     * @public
+     * @remarks 持久性订阅消息
+     * @param topic - 主题
+     * @param callbackFn - 接收到消息后的回调
+     * @returns 消息总线任务
+     */
+    subscribe(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;
+    /**
+     * 公共消息总线：订阅消息
+     *
+     * @public
+     * @remarks 持久性订阅消息
+     * @param topic - 主题
+     * @param callbackFn - 接收到消息后的回调
+     * @returns 消息总线任务
+     */
+    subscribePublic(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;
+    /**
+     * 私有消息总线：订阅单次消息
+     *
+     * @public
+     * @param topic - 主题
+     * @param callbackFn - 接收到消息后的回调
+     * @returns 消息总线任务
+     */
+    subscribeOnce(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;
+    /**
+     * 公共消息总线：订阅单次消息
+     *
+     * @public
+     * @param topic - 主题
+     * @param callbackFn - 接收到消息后的回调
+     * @returns 消息总线任务
+     */
+    subscribeOncePublic(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;
+    /**
+     * 私有消息总线：调用 RPC 服务
+     *
+     * @public
+     * @param topic - 主题
+     * @param message - 消息
+     * @param timeout - 超时
+     * @returns RPC 服务返回
+     */
+    rpcCall(topic: string, message?: any, timeout?: number): Promise<any>;
+    /**
+     * 公共消息总线：调用 RPC 服务
+     *
+     * @public
+     * @param topic - 主题
+     * @param message - 消息
+     * @param timeout - 超时
+     * @returns RPC 服务返回
+     */
+    rpcCallPublic(topic: string, message?: any, timeout?: number): Promise<any>;
+    /**
+     * 私有消息总线：注册 RPC 服务
+     *
+     * @public
+     * @param topic - 主题
+     * @param callbackFn - 接收到消息后的回调
+     */
+    rpcService(topic: string, callbackFn: (...args: Array<any>) => any | Promise<any>): void;
+    /**
+     * 公共消息总线：注册 RPC 服务
+     *
+     * @public
+     * @param topic - 主题
+     * @param callbackFn - 接收到消息后的回调
+     */
+    rpcServicePublic(topic: string, callbackFn: (...args: Array<any>) => any | Promise<any>): void;
+}
+
 /**
  * 系统 / 面板控制类
  *
@@ -15339,7 +15651,7 @@ declare type TPCB_PolygonSourceArray = Array<'L' | 'ARC' | 'CARC' | 'C' | 'R' |
  *
  * - `{number}` `y1` - 圆、圆弧上的端点 Y
  *
- * - `{number}` `x2` - 标注线尾部的端点 X
+ * - `{number}` `x2` - 标注线尾部的��点 X
  *
  * - `{number}` `y2` - 标注线尾部的端点 Y
  *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@jlceda/pro-api-types",
-	"version": "0.1.167",
+	"version": "0.1.169",
 	"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
 	"typings": "index.d.ts",
 	"keywords": [