@jlceda/pro-api-types 0.2.34 → 0.2.35

package/index.d.ts

@@ -43,6 +43,8 @@ declare global {
 	    HOME = -1,
 	    /** 空白页 */
 	    BLANK = 0,
+	    /** 工程 */
+	    PROJECT = 5,
 	    /** 原理图图页 */
 	    SCHEMATIC_PAGE = 1,
 	    /** PCB */
@@ -72,7 +74,15 @@ declare global {
 	    /** 封装 */
 	    FOOTPRINT = 4,
 	    /** 面板库 */
-	    PANEL_LIBRARY = 29
+	    PANEL_LIBRARY = 29,
+	    /** 仿真原理图图页：NGspice */
+	    SIMULATION_SCHEMATIC_PAGE_NGSPICE = 8,
+	    /** 仿真原理图图页：SimulIDE */
+	    SIMULATION_SCHEMATIC_PAGE_SIMULIDE = 9,
+	    /** 仿真元件符号：NGspice */
+	    SIMULATION_SYMBOL_COMPONENT_NGSPICE = 7,
+	    /** 仿真元件符号：SimulIDE */
+	    SIMULATION_SYMBOL_COMPONENT_SIMULIDE = 32
 	}
 	/**
 	 * 编辑器文档对象
@@ -927,6 +937,8 @@ declare global {
 	    title: string;
 	    /** 标签页 ID */
 	    tabId: string;
+	    /** 文档类型 */
+	    documentType: EDMT_EditorDocumentType;
 	    /** 标签页是否可拖动 */
 	    draggable: boolean;
 	    /** 标签页是否可关闭 */
@@ -1150,6 +1162,88 @@ declare global {
 	    removeIndicatorMarkers(tabId?: string): Promise<boolean>;
 	}
 
+	/**
+	 * 编辑器标签页事件类型
+	 *
+	 * @public
+	 * @remarks 在类型为 {@link EDMT_EditorTabEventType.CLOSE | 关闭} 或 {@link EDMT_EditorTabEventType.OPEN | 打开} 时，均会同时触发 {@link EDMT_EditorTabEventType.TOGGLE | 切换} 事件
+	 */
+	enum EDMT_EditorTabEventType {
+	    /** 切换 */
+	    TOGGLE = "toggle",
+	    /** 关闭 */
+	    CLOSE = "close",
+	    /** 打开 */
+	    OPEN = "open"
+	}
+	/**
+	 * 编辑器标签页事件触发原因
+	 *
+	 * @public
+	 */
+	enum EDMT_EditorTabEventTriggerCause {
+	    /** 切换标签页 */
+	    TOGGLE_TAB = "Toggle Tab",
+	    /** 关闭标签页 */
+	    CLOSE_TAB = "Close Tab",
+	    /** 打开文档 */
+	    OPEN_DOCUMENT = "Open Document",
+	    /** 打开工程 */
+	    OPEN_PROJECT = "Open Project",
+	    /** 关闭工程 */
+	    CLOSE_PROJECT = "Close Project"
+	}
+	/**
+	 * 文档树 / 事件类
+	 *
+	 * @public
+	 * @remarks 注册事件回调
+	 */
+	class DMT_Event {
+	    /** 扩展 UUID */
+	    private extensionUuid?;
+	    /**
+	     * @internal
+	     * @param extensionUuid - 扩展 UUID
+	     */
+	    constructor(extensionUuid?: string);
+	    /**
+	     * 新增编辑器标签页事件监听
+	     *
+	     * @alpha
+	     * @remarks
+	     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+	     *
+	     * 在 {@link EDMT_EditorTabEventType | 标签页事件类型} 为 {@link EDMT_EditorTabEventType.CLOSE | 关闭} 或 {@link EDMT_EditorTabEventType.OPEN | 打开} 时，均会同时触发 {@link EDMT_EditorTabEventType.TOGGLE | 切换} 事件
+	     * @param id - 事件 ID，用以防止重复注册事件
+	     * @param eventType - 事件类型
+	     * @param callFn - 事件触发时的回调函数
+	     * @param onlyOnce - 是否仅监听一次
+	     */
+	    addEditorTabEventListener(id: string, eventType: 'all' | EDMT_EditorTabEventType, callFn: (eventType: EDMT_EditorTabEventType, props: {
+	        triggerCause: EDMT_EditorTabEventTriggerCause;
+	        documentType: EDMT_EditorDocumentType;
+	        title: string;
+	        tabId: string;
+	    }) => void | Promise<void>, onlyOnce?: boolean): void;
+	    /**
+	     * 移除事件监听
+	     *
+	     * @public
+	     * @param id - 事件 ID
+	     * @returns 是否移除指定事件监听
+	     */
+	    removeEventListener(id: string): boolean;
+	    /**
+	     * 查询事件监听是否存在
+	     *
+	     * @public
+	     * @param id - 事件 ID
+	     * @returns 事件监听是否存在
+	     */
+	    isEventListenerAlreadyExist(id: string): boolean;
+	}
+
 	/**
 	 * 文件夹属性
 	 *
@@ -1392,7 +1486,7 @@ declare global {
 	     * @beta
 	     * @param projectFriendlyName - 工程友好名称
 	     * @param projectName - 工程名称，不可重复，仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`，如若不指定，则根据工程友好名称自动生成
-	     * @param teamUuid - 团队 UUID，如若不指定，则默认为个人；在不存在个人工程的环境下必须指定团��� UUID
+	     * @param teamUuid - 团队 UUID，如若不指定，则默认为个人；在不存在个人工程的环境下必须指定团队 UUID
 	     * @param folderUuid - 文件夹 UUID，如若不指定，则为根文件夹
 	     * @param description - 工程描述
 	     * @param collaborationMode - 工程协作模式，如若团队权限无需工程设置协作模式，则该参数将被忽略
@@ -3277,7 +3371,7 @@ declare global {
 	     * 保存文档
 	     *
 	     * @public
-	     * @returns 保存操作是否成功，保存失败、上传失败等错误均返回 `false`
+	     * @returns 保存操作是否成功，保存失败、上传失败���错误均返回 `false`
 	     */
 	    save(uuid: string): Promise<boolean>;
 	    /**
@@ -4690,7 +4784,7 @@ declare global {
 	     *
 	     * 注意：本接口需要启用 **工程设计图 \> 文件导出** 权限，没有权限调用将始终 `throw Error`
 	     * @param fileName - 文件名
-	     * @param password - 加密密码
+	     * @param password - 加密���码
 	     * @param fileType - 文件格式
 	     * @returns 文档文件数据，`undefined` 表示当前未打开文档或数据获取失败
 	     */
@@ -4839,7 +4933,11 @@ declare global {
 	        existingProjectUuid: IDMT_BriefProjectItem['uuid'];
 	    }, librariesImportSetting?: {
 	        ownerTeamUuid: IDMT_TeamItem['uuid'];
+	        deviceClassification?: Array<string>;
+	        symbolClassification?: Array<string>;
+	        footprintClassification?: Array<string>;
 	        createDeviceForSingleSymbol?: boolean;
+	        updateExistingLibrariesWithTheSameName?: boolean;
 	    }): Promise<IDMT_BriefProjectItem | undefined>;
 	    /**
 	     * 使用工程文件导入工程
@@ -4873,7 +4971,11 @@ declare global {
 	        existingProjectUuid: IDMT_BriefProjectItem['uuid'];
 	    }, librariesImportSetting?: {
 	        ownerTeamUuid: IDMT_TeamItem['uuid'];
+	        deviceClassification?: Array<string>;
+	        symbolClassification?: Array<string>;
+	        footprintClassification?: Array<string>;
 	        createDeviceForSingleSymbol?: boolean;
+	        updateExistingLibrariesWithTheSameName?: boolean;
 	    }): Promise<IDMT_BriefProjectItem | undefined>;
 	    /**
 	     * 提取文件内的工程配置信息
@@ -5120,7 +5222,7 @@ declare global {
 	     * @beta
 	     * @param templateFile - BOM 模板文件
 	     * @param template - BOM 模板名称，如若为 `undefined` 则自动从 `templateFile` 中取值
-	     * @returns BOM 模板��称
+	     * @returns BOM 模板名称
 	     * @example
 	     * ```javascript
 	     * // 从文件选择器读取模板文件
@@ -5444,7 +5546,7 @@ declare global {
 	     * 获取 JRouter 专用自动布线文件（JSON）
 	     *
 	     * @beta
-	     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
+	     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件���出到本地文件系统
 	     * @param fileName - 文件名
 	     * @returns 自动布线 JSON 文件数据
 	     */
@@ -5989,7 +6091,7 @@ declare global {
 	     */
 	    unhighlightNet(net: string): Promise<boolean>;
 	    /**
-	     * 取消高亮所���网络
+	     * 取消高亮所有网络
 	     *
 	     * @beta
 	     * @returns 操作是否成功
@@ -7125,7 +7227,7 @@ declare global {
 	     * 获取文本
 	     *
 	     * @alpha
-	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图���对象
+	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
 	     * @param primitiveIds - 文本的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
 	     * @returns 文本图元对象，空数组表示获取失败
 	     */
@@ -8767,7 +8869,7 @@ declare global {
 	     *
 	     * @beta
 	     * @param primitiveId - 图元 ID
-	     * @param property - 修改参数
+	     * @param property - 修��参数
 	     * @returns 折线图元对象
 	     */
 	    modify(primitiveId: string | IPCB_PrimitivePolyline, property: {
@@ -8882,7 +8984,7 @@ declare global {
 	     */
 	    getState_Polygon(): IPCB_Polygon;
 	    /**
-	     * 获���属性状态：线宽
+	     * 获取属性状态：线宽
 	     *
 	     * @public
 	     * @returns 线宽
@@ -9974,7 +10076,7 @@ declare global {
 	     * 将异步图元重置为当前画布状态
 	     *
 	     * @internal
-	     * @remarks 本器件焊盘图元属性不支持修��，本接口调用将不会有任何效果
+	     * @remarks 本器件焊盘图元属性不支持修改，本接口调用将不会有任何效果
 	     * @returns 器件焊盘图元对象
 	     */
 	    reset(): Promise<IPCB_PrimitiveComponentPad>;
@@ -10403,7 +10505,7 @@ declare global {
 	     *
 	     * @beta
 	     * @param layer - 层
-	     * @returns 器件图元对象
+	     * @returns 器���图元对象
 	     */
 	    setState_Layer(layer: TPCB_LayersOfComponent): IPCB_PrimitiveComponent;
 	    /**
@@ -11534,7 +11636,7 @@ declare global {
 	     * 将图元转换为异步图元
 	     *
 	     * @public
-	     * @returns 二进制内嵌对象图元对象
+	     * @returns 二进制内嵌对象图��对象
 	     */
 	    toAsync(): IPCB_PrimitiveObject;
 	    /**
@@ -14416,7 +14518,7 @@ declare global {
 	     * 将图元转换为同步图元
 	     *
 	     * @public
-	     * @returns 引��图元对象
+	     * @returns 引脚图元对象
 	     */
 	    toSync(): ISCH_PrimitivePin;
 	    /**
@@ -14779,7 +14881,7 @@ declare global {
 	     * @param addIntoPcb - 是否转到 PCB
 	     * @param designator - 位号
 	     * @param name - 名称，`null` 表示留空
-	     * @param uniqueId - 唯一 ID，`null` 表示留空
+	     * @param uniqueId - 唯一 ID，`null` 表示��空
 	     * @param manufacturer - 制造商，`null` 表示留空
 	     * @param manufacturerId - 制造商编号，`null` 表示留空
 	     * @param supplier - 供应商，`null` 表示留空
@@ -14856,7 +14958,7 @@ declare global {
 	     *
 	     * 本接口的返回时机并不会等待用户的放置操作，一旦器件被绑定到鼠标，本接口将立即返回 `true` 的结果
 	     * @param component - 关联库器件
-	     * @returns 是否找���器件
+	     * @returns 是否找到器件
 	     */
 	    placeComponentWithMouse(component: {
 	        libraryUuid: string;
@@ -15783,7 +15885,7 @@ declare global {
 	     * 获取属性状态：图元 ID
 	     *
 	     * @public
-	     * @returns 图元 ID
+	     * @returns 图�� ID
 	     */
 	    getState_PrimitiveId(): string;
 	    /**
@@ -16969,7 +17071,7 @@ declare global {
 	     *
 	     * @beta
 	     * @param height - 高
-	     * @returns 矩形图元对象
+	     * @returns 矩形图元���象
 	     */
 	    setState_Height(height: number): ISCH_PrimitiveRectangle;
 	    /**
@@ -17082,7 +17184,7 @@ declare global {
 	     * 3. 有多个坐标点在多个不同网络的图元上，则创建失败
 	     *
 	     * 如若已指定，则遵循：
-	     * 1. 有一个或多个坐标点在��他网络的图元上，且其他图元并未显式（通常指的是包含网络标签或网络端口）指定网络，则其他图元跟随指定的网络；
+	     * 1. 有一个或多个坐标点在其他网络的图元上，且其他图元并未显式（通常指的是包含网络标签或网络端口）指定网络，则其他图元跟随指定的网络；
 	     * 2. 如若其他图元指定了网络，则创建失败
 	     * @param color - 导线颜色，`null` 表示默认
 	     * @param lineWidth - 线宽，范围 `1-10`，`null` 表示默认
@@ -17325,13 +17427,6 @@ declare global {
 	     * @returns 所有已选中图元的图元对象
 	     */
 	    getAllSelectedPrimitives(): Promise<Array<ISCH_Primitive>>;
-	    /**
-	     * 3.0版：查询所有已选中图元的图元对象
-	     *
-	     * @beta
-	     * @returns 所有已选中图元的图元对象
-	     */
-	    refactorGetAllSelectedPrimitives(): Promise<Array<ISCH_Primitive>>;
 	    /**
 	     * 查询选中图元的图元 ID
 	     *
@@ -17385,6 +17480,13 @@ declare global {
 	        x: number;
 	        y: number;
 	    } | undefined>;
+	    /**
+	     * 查询所有已选中图元的图元对象
+	     *
+	     * @internal
+	     * @returns 所有已选中图元的图元对象
+	     */
+	    private getAllSelectedPrimitives3;
 	}
 
 	/**
@@ -20114,6 +20216,7 @@ declare global {
 	class EDA {
 	    dmt_Board: DMT_Board;
 	    dmt_EditorControl: DMT_EditorControl;
+	    dmt_Event: DMT_Event;
 	    dmt_Folder: DMT_Folder;
 	    dmt_Panel: DMT_Panel;
 	    dmt_Pcb: DMT_Pcb;

package/package.json

@@ -1 +1 @@
-{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.34", "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.35", "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" } }