@jlceda/pro-api-types 0.2.60 → 0.2.62

package/index.d.ts

@@ -975,7 +975,7 @@ declare global {
 	 * 文档树 / 编辑器控制类
 	 *
 	 * @public
-	 * @remarks 此处编辑器控制基于当前已打开的工程设计下的���页，其它任何 `documentUuid` 都将被认为是不存在的文档页
+	 * @remarks 此处编辑器控制基于当前已打开的工程设计下���图页，其它任何 `documentUuid` 都将被认为是不存在的文档页
 	 */
 	class DMT_EditorControl {
 	    /**
@@ -1381,7 +1381,7 @@ declare global {
 	     */
 	    createPanel(): Promise<string | undefined>;
 	    /**
-	     * 修改面板���称
+	     * 修改面���名称
 	     *
 	     * @public
 	     * @param panelUuid - 面板 UUID
@@ -2391,7 +2391,7 @@ declare global {
 	     * @param targetLibraryUuid - 目标库 UUID
 	     * @param targetClassification - 目标库内的分类
 	     * @param newDeviceName - 新器件名称，如若目标库内存在重名器件将导致复制失败
-	     * @returns ���标库内新器件的 UUID
+	     * @returns 目标库内新器件的 UUID
 	     */
 	    copy(deviceUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newDeviceName?: string): Promise<string | undefined>;
 	    /**
@@ -2840,6 +2840,9 @@ declare global {
 	                };
 	            };
 	        };
+	        /**
+	         */
+	        images?: Array<ILIB_ExtendLibraryItem>;
 	        /**
 	         * @deprecated - 使用 attributes['Value'] 替代
 	         */
@@ -3902,7 +3905,7 @@ declare global {
 	     */
 	    createPolygon(polygon: TPCB_PolygonSourceArray): IPCB_Polygon | undefined;
 	    /**
-	     * 创建复杂多边形
+	     * 创建复杂多��形
 	     *
 	     * @public
 	     * @param complexPolygon - 复杂多边形数据
@@ -4233,6 +4236,119 @@ declare global {
 	    /** 停用 */
 	    INACTIVE = "inactive"
 	}
+	/**
+	 * 自动布线拐角风格
+	 *
+	 * @public
+	 */
+	enum EPCB_AutoRoutingCornerStyle {
+	    /** 任意角度 */
+	    /** 45 度 */
+	    DEGREE_45 = "45Degree",
+	    /** 90 度 */
+	    DEGREE_90 = "90Degree"
+	}
+	/**
+	 * 自动布线效果优先级
+	 *
+	 * @public
+	 */
+	enum EPCB_AutoRoutingOptimization {
+	    /** 优先布线长度（最短路径） */
+	    /** 优先布线美观（减少过孔、均匀分布） */
+	    /** 优先布通率（尽可能完成所有网络） */
+	    COMPLETION = "completion",
+	    /** 优先布线速度 */
+	    FASTER = "faster"
+	}
+	/**
+	 * 自动布线对已有导线/过孔的处理方式
+	 *
+	 * @public
+	 */
+	enum EPCB_AutoRoutingExistingPrimitiveMode {
+	    /** 保留已有导线和过孔（在其基础上继续布线） */
+	    KEEP = "keep",
+	    /** 移除已有导线和过孔（推倒重布） */
+	    REMOVE = "remove"
+	}
+	/**
+	 * 自动布线入参
+	 *
+	 * @public
+	 */
+	interface IPCB_AutoRoutingProps {
+	    /**
+	     * 布线网络
+	     *
+	     * @remarks 指定需要参与自动布线的网络名称数组；如不传入或传入空数组，则对所有未布线的网络进行自动布线
+	     */
+	    RoutingNets?: 'selected' | 'selectedComponents' | Array<string>;
+	    /**
+	     * 布线拐角风格
+	     *
+	     * @remarks 指定自动布线使用的拐角风格，默认为 45 度
+	     */
+	    cornerStyle?: EPCB_AutoRoutingCornerStyle;
+	    /**
+	     * 已有导线/过孔的处理方式
+	     *
+	     * @remarks 指定对画布上已有导线和过孔的处理方式，默认为保留
+	     */
+	    existingPrimitiveMode?: EPCB_AutoRoutingExistingPrimitiveMode;
+	    /**
+	     * 效果优先级
+	     *
+	     * @remarks 指定自动布线的优化目标，默认为布通率
+	     */
+	    optimization?: EPCB_AutoRoutingOptimization;
+	    /**
+	     * 布线图层
+	     *
+	     * @remarks 指定允许参与自动布线的图层 ID 数组；如不传入，则使用当前 PCB 的所有可用信号层
+	     */
+	    layers?: Array<TPCB_LayersOfCopper>;
+	    /**
+	     * 忽略网络
+	     *
+	     * @remarks 指定需要忽略（不参与自动布线）的网络名称数组；如不传入，则不忽略任何网络
+	     */
+	    ignoreNets?: Array<string>;
+	}
+	/**
+	 * 自动布局结果
+	 *
+	 * @public
+	 */
+	interface IPCB_AutoLayoutResult {
+	    /** 自动布局是否成功启动 */
+	    success: boolean;
+	    /** 参与自动布局的器件总数 */
+	    totalComponentsCount: number;
+	    /** 成功完成布局的器件数量 */
+	    successComponentsCount: number;
+	    /** 未能完成布局的器件图元 ID 列表 */
+	    failedComponents: Array<string>;
+	    /** 自动布局耗时（毫秒） */
+	    duration: number;
+	}
+	/**
+	 * 自动布线结果
+	 *
+	 * @public
+	 */
+	interface IPCB_AutoRoutingResult {
+	    /** 自动布线是否成功启动 */
+	    success: boolean;
+	    /** 参与自动布线的网络总数 */
+	    totalNetsCount: number;
+	    /** 成功完成布线的网络数量 */
+	    successNetsCount: number;
+	    /** 未能完成布线的网络名称列表 */
+	    failedNets: Array<string>;
+	    /** 自动布线耗时（毫秒） */
+	    duration: number;
+	}
 	/**
 	 * PCB & 封装 / 文档操作类
 	 *
@@ -4449,6 +4565,36 @@ declare global {
 	     * @param type - 清除类型，如若需要指定清除类型，请提前选择指定图元
 	     */
 	    clearRouting(type?: 'all' | 'net' | 'connection'): Promise<boolean>;
+	    /**
+	     * 自动布线
+	     *
+	     * @alpha
+	     * @remarks 如不传入任何参数，将对所有未布线的网络进行自动布线
+	     * @param props - 自动布线参数
+	     * @returns 自动布线结果
+	     * @example
+	     * ```javascript
+	     * // 对所有未布线的网络进行自动布线
+	     * const result = await eda.pcb_Document.autoRouting();
+	     * console.log(`布线完成：${result.routedNets}/${result.totalNets}`);
+	     *
+	     * // 指定网络进行自动布线，并忽略部分网络
+	     * const result = await eda.pcb_Document.autoRouting({
+	     *     nets: ['VCC', 'GND', 'SDA', 'SCL'],
+	     *     ignoreNets: ['NC'],
+	     *     cornerStyle: EPCB_AutoRoutingCornerStyle.DEGREE_45,
+	     *     optimization: EPCB_AutoRoutingOptimization.COMPLETION,
+	     * });
+	     * ```
+	     */
+	    autoRouting(props?: IPCB_AutoRoutingProps): Promise<IPCB_AutoRoutingResult>;
+	    /**
+	     * 自动布局
+	     *
+	     * @alpha
+	     * @returns 自动布局结果
+	     */
+	    autoLayout(): Promise<IPCB_AutoLayoutResult>;
 	}
 
 	/**
@@ -7470,7 +7616,7 @@ declare global {
 	     * 获取文本
 	     *
 	     * @alpha
-	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，���可能返回少于传入的图元 ID 数量的图元对象
 	     * @param primitiveIds - 文本的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
 	     * @returns 文本图元对象，空数组表示获取失败
 	     */
@@ -8268,7 +8414,7 @@ declare global {
 	     * 修改覆铜填充
 	     *
 	     * @internal
-	     * @remarks 覆铜填充图元不支���修改，本接口调用将不会有任何效果
+	     * @remarks 覆铜填充图元不支持修改，本接口调用将不会有任何效果
 	     * @returns `undefined`
 	     */
 	    modify(): undefined;
@@ -10317,7 +10463,7 @@ declare global {
 	     */
 	    setState_PadNumber(): IPCB_PrimitiveComponentPad;
 	    /**
-	     * 将异步图元重置为当前画布状态
+	     * ���异步图元重置为当前画布状态
 	     *
 	     * @internal
 	     * @remarks 本器件焊盘图元属性不支持修改，本接口调用将不会有任何效果
@@ -12316,8 +12462,9 @@ declare global {
 	     * 自动布线
 	     *
 	     * @beta
+	     * @remarks 如不传入任何参数，将对所有未布线的网络进行自动布线
 	     * @param props - 自动布线参数
-	     * @returns 结果
+	     * @returns 自动布线结果
 	     */
 	    autoRouting(props?: {
 	        uuids?: Array<string>;
@@ -12345,8 +12492,9 @@ declare global {
 	     * 自动布局
 	     *
 	     * @beta
+	     * @remarks 如不传入任何参数，将对所有器件进行自动布局
 	     * @param props - 自动布局参数
-	     * @returns 结果
+	     * @returns 自动布局结果
 	     */
 	    autoLayout(props?: {
 	        uuids?: Array<string>;
@@ -13592,6 +13740,7 @@ declare global {
 	     * 创建网络标签
 	     *
 	     * @alpha
+	     * @remarks ADD since EDA v4
 	     * @param x - 坐标 X
 	     * @param y - 坐标 Y
 	     * @param net - 网络名称
@@ -14143,7 +14292,7 @@ declare global {
 	     */
 	    toAsync(): ISCH_PrimitiveBus;
 	    /**
-	     * 将图元转换为同步图元
+	     * ���图元转换为同步图元
 	     *
 	     * @public
 	     * @returns 总线图元对象
@@ -16235,7 +16384,7 @@ declare global {
 	     * 获取属性状态：是否转到 PCB
 	     *
 	     * @public
-	     * @returns 是否转到 PCB
+	     * @returns ��否转到 PCB
 	     */
 	    getState_AddIntoPcb(): boolean | undefined;
 	    /**
@@ -17405,7 +17554,7 @@ declare global {
 	     */
 	    setState_LineType(lineType: ESCH_PrimitiveLineType | null): ISCH_PrimitiveRectangle;
 	    /**
-	     * 设置属性状态：填充样式
+	     * 设置属���状态：填充样式
 	     *
 	     * @beta
 	     * @param fillStyle - 填充样式
@@ -19570,16 +19719,16 @@ declare global {
 	     *
 	     * 本接口无法移除 {@link SYS_HeaderMenu.insertSystemHeaderMenus | 导入系统顶部菜单} 接口导入的系统顶部菜单项
 	     *
-	     * 本接口无法移除第一级菜单，`id` 数组请至少传递 `2` 个值
+	     * 当 `id` 数组仅包含一个元素时，将移除对应的一级菜单；当 `id` 数组包含多个元素时，将按照数组顺序按层级匹配菜单项，并移除数组最后一位对应的子菜单项
 	     *
-	     * 本接口无法移除 **高级** 菜单下的任何子菜单
+	     * 本接口无法移除 **高级** 菜单本身及其下的任何子菜单
 	     *
-	     * 注意：本接口需要使用者启用扩展的外��交互权限，如若未启用将始终 `throw Error`
+	     * 注意：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
 	     *
 	     * 非公开接口使用提醒：本接口按原样提供，不提供参数的额外文档，参数可能在任何版本出现破坏性更改并不另行通知
 	     * @param env - 环境
-	     * @param id - 菜单项 ID 树，将会按照数组顺序按层级匹配菜单项，并移除数组最后一位对应的菜单项
-	     * @param props - 其它参数，是否移除菜单项之前、之后的分隔线
+	     * @param id - 菜单项 ID 树，将会按照数组顺序按层级匹配菜单项，并移除数组最后一位对应的菜单项；仅传递一个元素时移除对应的一级菜单
+	     * @param props - 其它参数，是否移除菜单项之前、之后的分隔线（仅在移除子菜单项时生效）
 	     * @returns 移除操作是否成功，菜单已移除但分隔线未找到也会返回 `true` 的结果
 	     */
 	    removeSystemHeaderMenuItem(id: Array<string>, props?: {
@@ -20899,7 +21048,7 @@ declare global {
 	     *
 	     * @public
 	     * @remarks 注意：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
-	     * @param id - 自定义的 WebSocket ID
+	     * @param id - 自��义的 WebSocket ID
 	     * @param code - 数字状态码，对应 {@link https://developer.mozilla.org/docs/Web/API/CloseEvent/code | WebSocket.CloseEvent} 内允许的状态码
 	     * @param reason - 一个人类可读的字符串，解释连接关闭的原因
 	     * @param extensionUuid - 扩展 UUID，一般不需要指定，仅当需要操作其它扩展建立的 WebSocket 连接时才需要指定为其它扩展的 UUID

package/package.json

@@ -1 +1 @@
-{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.60", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }
+{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.62", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }