@jlceda/pro-api-types 0.2.40 → 0.2.42

package/index.d.ts

@@ -498,7 +498,7 @@ declare global {
 	     * 搜索符号
 	     *
 	     * @beta
-	     * @param key - 搜索关键字
+	     * @param key - 搜索���键字
 	     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
 	     * @param classification - 分类，默认为全部
 	     * @param symbolType - 符号类型，默认为全部
@@ -1181,18 +1181,6 @@ declare global {
 	 *
 	 * @public
 	 */
-	enum EDMT_EditorTabEventTriggerCause {
-	    /** 切换标签页 */
-	    TOGGLE_TAB = "Toggle Tab",
-	    /** 关闭标签页 */
-	    CLOSE_TAB = "Close Tab",
-	    /** 打开文档 */
-	    OPEN_DOCUMENT = "Open Document",
-	    /** 打开工程 */
-	    OPEN_PROJECT = "Open Project",
-	    /** 关闭工程 */
-	    CLOSE_PROJECT = "Close Project"
-	}
 	/**
 	 * 文档树 / 事件类
 	 *
@@ -1221,7 +1209,6 @@ declare global {
 	     * @param onlyOnce - 是否仅监听一次
 	     */
 	    addEditorTabEventListener(id: string, eventType: 'all' | EDMT_EditorTabEventType, callFn: (eventType: EDMT_EditorTabEventType, props: {
-	        triggerCause: EDMT_EditorTabEventTriggerCause;
 	        documentType: EDMT_EditorDocumentType;
 	        title: string;
 	        tabId: string;
@@ -1885,7 +1872,7 @@ declare global {
 	     */
 	    copy(modelUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newModelName?: string): Promise<string | undefined>;
 	    /**
-	     * 搜索 3D 模型
+	     * ��索 3D 模型
 	     *
 	     * @beta
 	     * @param key - 搜索关键字
@@ -4387,7 +4374,7 @@ declare global {
 	     * 本接口在前端画布上定位到指定的区域，区域数据为相对于数据原点的偏移；
 	     *
 	     * 例如：传入数据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`，
-	     * 则画布将会定位到以 `[30, 40]` 为中心的，`x` 轴方向长度为 `60`，`y` 轴方向长度为 `120` 的矩形范围；
+	     * 则画布将会定位到以 `[30, 40]` 为��心的，`x` 轴方向长度为 `60`，`y` 轴方向长度为 `120` 的矩形范围；
 	     *
 	     * 本接口不进行缩放操作，但会生成指示定位中心及表示区域范围的矩形框；
 	     *
@@ -5265,7 +5252,7 @@ declare global {
 	     * @remarks
 	     * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
 	     *
-	     * 注意：本接口需要启用 **团队库 \> ��载库** 权限，没有权限调用将始终 `throw Error`
+	     * 注意：本接口需要启用 **团队库 \> 下载库** 权限，没有权限调用将始终 `throw Error`
 	     *
 	     * @param deviceUuid - 器件 UUID 或器件 UUID 列表
 	     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取，如若不传入，则为系统库
@@ -5281,7 +5268,7 @@ declare global {
 	     *
 	     * 注意：本接口需要启用 **团队库 \> 下载库** 权限，没有权限调用将始终 `throw Error`
 	     * @param symbolUuid - 符号 UUID 或符号 UUID 列表
-	     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+	     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取，如若不传入，则为系统库
 	     * @returns 符号文件数据，`undefined` 表示数据获取失败
 	     */
 	    getSymbolFileBySymbolUuid(symbolUuid: string | Array<string>, libraryUuid?: string, fileType?: 'elibz' | 'elibz2'): Promise<File | undefined>;
@@ -5294,7 +5281,7 @@ declare global {
 	     *
 	     * 注意：本接口需要启用 **团队库 \> 下载库** 权限，没有权限调用将始终 `throw Error`
 	     * @param footprintUuid - 封装 UUID 或封装 UUID 列表
-	     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+	     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取，如若不传入，则为系统库
 	     * @returns 封装文件数据，`undefined` 表示数据获取失败
 	     */
 	    getFootprintFileByFootprintUuid(footprintUuid: string | Array<string>, libraryUuid?: string, fileType?: 'elibz' | 'elibz2'): Promise<File | undefined>;
@@ -5307,7 +5294,7 @@ declare global {
 	     *
 	     * 注意：本接口需要启用 **团队模块 \> 下载模块** 权限，没有权限调用将始终 `throw Error`
 	     * @param cbbUuid - 复用模块 UUID
-	     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+	     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取，如若不传入，则为系统库
 	     * @param fileName - 复用模块名
 	     * @param password - 加密密码
 	     * @returns 复用模块文件数据，`undefined` 表示数据获取失败
@@ -5328,7 +5315,7 @@ declare global {
 	     *
 	     * 注意：本接口需要启用 **团队库 \> 下载库** 权限，没有权限调用将始终 `throw Error`
 	     * @param panelLibraryUuid - 面板库 UUID 或面板库 UUID 列表
-	     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+	     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取，如若不传入，则为系统库
 	     * @returns 面板库文件数据，`undefined` 表示数据获取失败
 	     */
 	    getPanelLibraryFileByPanelLibraryUuid(panelLibraryUuid: string | Array<string>, libraryUuid?: string, fileType?: 'elibz' | 'elibz2'): Promise<File | undefined>;
@@ -7682,7 +7669,7 @@ declare global {
 	     */
 	    setState_Reverse(reverse: boolean): IPCB_PrimitiveString;
 	    /**
-	     * 设置属性状态：反相扩展
+	     * ���置属性状态：反相扩展
 	     *
 	     * @beta
 	     * @param expansion - 反相扩展
@@ -8280,7 +8267,7 @@ declare global {
 	     * 在 PCB 画布中创建图元
 	     *
 	     * @internal
-	     * @remarks 覆铜���充图元不支持新建，本接口调用将不会有任何效果
+	     * @remarks 覆铜填充图元不支持新建，本接口调用将不会有任何效果
 	     * @returns 覆铜填充图元对象
 	     */
 	    create(): IPCB_PrimitivePoured;
@@ -9399,7 +9386,7 @@ declare global {
 	    private async;
 	    /** 图元类型 */
 	    private readonly primitiveType;
-	    /** ��元 ID */
+	    /** 图元 ID */
 	    private primitiveId?;
 	    /** 层 */
 	    private layer;
@@ -12173,7 +12160,7 @@ declare global {
 	     *
 	     * 此处的单位跨度为 0.01inch
 	     * @param x - 坐标 X
-	     * @param y - 坐标 Y
+	     * @param y - ��标 Y
 	     * @returns 操作是否成功
 	     */
 	    navigateToCoordinates(x: number, y: number): Promise<boolean>;
@@ -12596,7 +12583,7 @@ declare global {
 	     *
 	     * 如果设置为 `true`，将会忽略所有检查警告项并尽可能生成下单资料；
 	     *
-	     * 如果设置为 `false`，存在任意警告将中断执行并返回 `false` 的结果
+	     * 如果设置为 `false`，存在任意警告将中断执行并返回 `false` 的结��
 	     * @returns 是否通过下单检查
 	     */
 	    placeComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
@@ -13097,7 +13084,7 @@ declare global {
 	     * @param bold - 是否加粗
 	     * @param italic - 是否斜体
 	     * @param underLine - 是否加下划线
-	     * @param alignMode - 对齐模式，`0` 左顶，`1` 中顶，`2` 右顶，`3` 左中，`4` 中中，`5` 右中，`6` 左底，`7` 中底，`8` 右底
+	     * @param alignMode - 对齐模式
 	     * @returns 文本图元对象
 	     */
 	    create(x: number, y: number, content: string, rotation?: number, textColor?: string | null, fontName?: string | null, fontSize?: number | null, bold?: boolean, italic?: boolean, underLine?: boolean, alignMode?: ESCH_PrimitiveTextAlignMode): Promise<ISCH_PrimitiveText | undefined>;
@@ -13928,6 +13915,12 @@ declare global {
 	 * 总线图元
 	 *
 	 * @public
+	 * @remarks
+	 * 尚未解决的问题：
+	 *
+	 * `ISCH_PrimitiveWire.net` 全局网络名属性因其涉及多图页刷新，当前获取的值可能为 **错误** 的。
+	 * 当你尝试为一个导线、总线设置多个名称（放置多个网络标签）时，获取到的 `net` 属性可能并不是当前最新的，
+	 * 需要等待画布事件异步刷新全局网络后，再行获取。
 	 */
 	class ISCH_PrimitiveBus implements ISCH_Primitive {
 	    /** 异步 */
@@ -14346,7 +14339,7 @@ declare global {
 	     */
 	    toSync(): ISCH_PrimitiveCircle;
 	    /**
-	     * 查询图元是否为异步���元
+	     * 查询图元是否为异步图元
 	     *
 	     * @public
 	     * @returns 是否为异步图元
@@ -15884,7 +15877,7 @@ declare global {
 	     * 获取器件
 	     *
 	     * @beta
-	     * @remarks 如若传入多个图元 ID，任意图元 ID ��匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
 	     * @param primitiveIds - 器件的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
 	     * @returns 器件图元对象，空数组表示获取失败
 	     */
@@ -17444,6 +17437,12 @@ declare global {
 	 * 导线图元
 	 *
 	 * @public
+	 * @remarks
+	 * 尚未解决的问题：
+	 *
+	 * `ISCH_PrimitiveWire.net` 全局网络名属性因其涉及多图页刷新，当前获取的值可能为 **错误** 的。
+	 * 当你尝试为一个导线、总线设置多个名称（放置多个网络标签）时，获取到的 `net` 属性可能并不是当前最新的，
+	 * 需要等待画布事件异步刷新全局网络后，再行获取。
 	 */
 	class ISCH_PrimitiveWire implements ISCH_Primitive {
 	    /** 异步 */
@@ -17553,7 +17552,7 @@ declare global {
 	     */
 	    setState_LineWidth(lineWidth: number | null): ISCH_PrimitiveWire;
 	    /**
-	     * 设置属性状态：线型
+	     * 设置��性状态：线型
 	     *
 	     * @beta
 	     * @param lineType - 线型
@@ -17575,7 +17574,7 @@ declare global {
 	     */
 	    toSync(): ISCH_PrimitiveWire;
 	    /**
-	     * 查询图���是否为异步图元
+	     * 查询图元是否为异步图元
 	     *
 	     * @public
 	     * @returns 是否为异步图元
@@ -18561,7 +18560,7 @@ declare global {
 	     * 获取扩展内的文件
 	     *
 	     * @public
-	     * @param uri - 文件路径
+	     * @param uri - 文件路���
 	     * @returns File 格式文件
 	     */
 	    getExtensionFile(uri: string): Promise<File | undefined>;
@@ -20087,7 +20086,7 @@ declare global {
 	 * @remarks 设置定时器
 	 */
 	class SYS_Timer {
-	    /** ���展 UUID */
+	    /** 扩展 UUID */
 	    private extensionUuid?;
 	    /**
 	     * @internal

package/package.json

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