@jlceda/pro-api-types 0.2.46 → 0.2.48

package/index.d.ts

@@ -228,7 +228,7 @@ declare global {
 	 * 分类索引
 	 *
 	 * @public
-	 * @deprecated - since EDA v3.2; dropped EDA v3.3
+	 * @deprecated since EDA v3.2; dropped EDA v3.3
 	 * @remarks 本分类索引用于索引指定库内的分类，其中库 UUID 和库类型仅作针对于本索引的识别用途，防止将不同库内的索引互相引用从而引发错误
 	 */
 	interface ILIB_ClassificationIndex {
@@ -251,7 +251,7 @@ declare global {
 	     * 创建一级分类
 	     *
 	     * @beta
-	     * @deprecated - since EDA v3.2; dropped EDA v3.3
+	     * @deprecated since EDA v3.2; dropped EDA v3.3
 	     * @param libraryUuid - 库 UUID
 	     * @param libraryType - 库类型
 	     * @param primaryClassificationName - 一级分类名称
@@ -262,7 +262,7 @@ declare global {
 	     * 创建二级分类
 	     *
 	     * @beta
-	     * @deprecated - since EDA v3.2; dropped EDA v3.3
+	     * @deprecated since EDA v3.2; dropped EDA v3.3
 	     * @param libraryUuid - 库 UUID
 	     * @param libraryType - 库类型
 	     * @param primaryClassificationUuid - 一级分类 UUID
@@ -274,7 +274,7 @@ declare global {
 	     * 获取指定名称的分类的分类索引
 	     *
 	     * @beta
-	     * @deprecated - since EDA v3.2; dropped EDA v3.3
+	     * @deprecated since EDA v3.2; dropped EDA v3.3
 	     * @remarks 分类索引内包含分类的 UUID，具体可查阅 {@link ILIB_ClassificationIndex}
 	     * @param libraryUuid - 库 UUID
 	     * @param libraryType - 库类型
@@ -301,7 +301,7 @@ declare global {
 	     * 获取指定索引的分类的名称
 	     *
 	     * @beta
-	     * @deprecated - since EDA v3.2; dropped EDA v3.3
+	     * @deprecated since EDA v3.2; dropped EDA v3.3
 	     * @param classificationIndex - 分类索引
 	     * @returns 两级分类的名称
 	     */
@@ -340,7 +340,7 @@ declare global {
 	     * 删除指定索引的分类
 	     *
 	     * @beta
-	     * @deprecated - since EDA v3.2; dropped EDA v3.3
+	     * @deprecated since EDA v3.2; dropped EDA v3.3
 	     * @param classificationIndex - 分类索引
 	     * @returns 操作是否成功
 	     */
@@ -424,6 +424,15 @@ declare global {
 	    /** 前次修改者 */
 	    lastModifiedBy: string;
 	}
+	/**
+	 * 可用于精确搜索的符号参数
+	 *
+	 * @public
+	 */
+	interface ILIB_SymbolPropertiesForSearch {
+	    /** 符号名称 */
+	    name?: string;
+	}
 	/**
 	 * 综合库 / 符号类
 	 *
@@ -508,6 +517,21 @@ declare global {
 	     * @returns 搜索到的符号属性列表
 	     */
 	    search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Promise<Array<ILIB_SymbolSearchItem>>;
+	    /**
+	     * 使用属性精确搜索符号
+	     *
+	     * @alpha
+	     * @param properties - 属性
+	     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
+	     * @param classification - 分类，默认为全部
+	     *
+	     * ADD since EDA v4
+	     * @param symbolType - 符号类型，默认为全部
+	     * @param itemsOfPage - 一页搜索结果的数量
+	     * @param page - 页数
+	     * @returns 搜索到的符号属性的列表
+	     */
+	    searchByProperties(properties: ILIB_SymbolPropertiesForSearch, libraryUuid?: string, classification?: Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Array<ILIB_SymbolSearchItem>;
 	    /**
 	     * 在编辑器打开文档
 	     *
@@ -945,7 +969,7 @@ declare global {
 	    /** 标签页是否可关闭 */
 	    isAbleDelete: boolean;
 	    /**
-	     * 标签页是否不使用 I18n 功能（内部功能）
+	     * ��签页是否不使用 I18n 功能（内部功能）
 	     *
 	     * @internal
 	     */
@@ -1350,7 +1374,7 @@ declare global {
 	 * 文档树 / 面板管理类
 	 *
 	 * @public
-	 * @remarks 在当前打开的工程内进行面板管理的相关操作
+	 * @remarks 在当前打开的工程内进行面板管理的��关操作
 	 */
 	class DMT_Panel {
 	    /**
@@ -2270,8 +2294,6 @@ declare global {
 	    name?: string;
 	    /** 值 */
 	    value?: string;
-	    /** 描述 */
-	    description?: string;
 	    /** 关联符号名称 */
 	    symbolName?: string;
 	    /** 关联封装名称 */
@@ -2412,17 +2434,17 @@ declare global {
 	     * 使用属性精确搜索器件
 	     *
 	     * @alpha
-	     * @remarks
-	     * 注意：本接口仅全离线客户端有效，在浏览器环境内调用将始终 `throw Error`
 	     * @param properties - 属性
 	     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
 	     * @param classification - 分类，默认为全部
+	     *
+	     * ADD since EDA v4
 	     * @param symbolType - 符号类型，默认为全部
 	     * @param itemsOfPage - 一页搜索结果的数量
 	     * @param page - 页数
 	     * @returns 搜索到的器件属性的列表
 	     */
-	    searchByProperties(properties: ILIB_DevicePropertiesForSearch, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Array<ILIB_DeviceSearchItem>;
+	    searchByProperties(properties: ILIB_DevicePropertiesForSearch, libraryUuid?: string, classification?: Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Array<ILIB_DeviceSearchItem>;
 	    /**
 	     * 使用立创 C 编号获取器件
 	     *
@@ -2501,6 +2523,15 @@ declare global {
 	    /** 前次修改者 */
 	    lastModifiedBy: string;
 	}
+	/**
+	 * 可用于精确搜索的封装参数
+	 *
+	 * @public
+	 */
+	interface ILIB_FootprintPropertiesForSearch {
+	    /** 封装名称 */
+	    name?: string;
+	}
 	/**
 	 * 综合库 / 封装类
 	 *
@@ -2583,6 +2614,20 @@ declare global {
 	     * @returns 搜索到的封装属性列表
 	     */
 	    search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, itemsOfPage?: number, page?: number): Promise<Array<ILIB_FootprintSearchItem>>;
+	    /**
+	     * 使用属性精确搜索封装
+	     *
+	     * @alpha
+	     * @param properties - 属性
+	     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
+	     * @param classification - 分类，默认为全部
+	     *
+	     * ADD since EDA v4
+	     * @param itemsOfPage - 一页搜索结果的数量
+	     * @param page - 页数
+	     * @returns 搜索到的封装属性的列表
+	     */
+	    searchByProperties(properties: ILIB_FootprintPropertiesForSearch, libraryUuid?: string, classification?: Array<string>, itemsOfPage?: number, page?: number): Array<ILIB_FootprintSearchItem>;
 	    /**
 	     * 在编辑器打开文档
 	     *
@@ -2739,7 +2784,7 @@ declare global {
 	 * 外部库分类索引
 	 *
 	 * @public
-	 * @deprecated - since EDA v3.2; dropped EDA v3.3
+	 * @deprecated since EDA v3.2; dropped EDA v3.3
 	 * @remarks
 	 * 支持外部库使用名称或 UUID 作为分类的唯一 ID 索引
 	 */
@@ -4808,7 +4853,7 @@ declare global {
 	     */
 	    modifyDifferentialPairNegativeNet(differentialPairName: string, negativeNet: string): Promise<boolean>;
 	    /**
-	     * 获取所有差分对的详细属性
+	     * 获取所有差分对的详���属性
 	     *
 	     * @beta
 	     * @remarks
@@ -4853,7 +4898,7 @@ declare global {
 	     * @beta
 	     * @param equalLengthNetGroupName - 等长网络组名称
 	     * @param net - 网络名称
-	     * @returns 操��是否成功
+	     * @returns 操作是否成功
 	     */
 	    addNetToEqualLengthNetGroup(equalLengthNetGroupName: string, net: string | Array<string>): Promise<boolean>;
 	    /**
@@ -7666,7 +7711,7 @@ declare global {
 	     *
 	     * @beta
 	     * @param reverse - 是否反相
-	     * @returns 文��图元对象
+	     * @returns 文本图元对象
 	     */
 	    setState_Reverse(reverse: boolean): IPCB_PrimitiveString;
 	    /**
@@ -8223,7 +8268,7 @@ declare global {
 	     */
 	    get(primitiveIds: string): Promise<IPCB_PrimitivePoured | undefined>;
 	    /**
-	     * 获取覆铜填充
+	     * ���取覆铜填充
 	     *
 	     * @beta
 	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
@@ -8268,7 +8313,7 @@ declare global {
 	     * 在 PCB 画布中创建图元
 	     *
 	     * @internal
-	     * @remarks 覆铜填充图元不支持新建，本接口调用将不会���任何效果
+	     * @remarks 覆铜填充图元不支持新建，本接口调用将不会有任何效果
 	     * @returns 覆铜填充图元对象
 	     */
 	    create(): IPCB_PrimitivePoured;
@@ -8751,7 +8796,7 @@ declare global {
 	     * @param net - 网络名称
 	     * @param layer - 层
 	     * @param primitiveLock - 是否锁定
-	     * @returns 覆铜边框的图元 ID 数组
+	     * @returns 覆铜边框的图元 ID 数��
 	     */
 	    getAllPrimitiveId(net?: string, layer?: TPCB_LayersOfCopper, primitiveLock?: boolean): Promise<Array<string>>;
 	    /**
@@ -9877,7 +9922,7 @@ declare global {
 	     */
 	    create(): Promise<IPCB_PrimitivePad>;
 	    /**
-	     * 获取属性状态：图元类型
+	     * 获取属性��态：图元类型
 	     *
 	     * @public
 	     * @returns 图元类型
@@ -10378,7 +10423,7 @@ declare global {
 	     *
 	     * @beta
 	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
-	     * @param primitiveIds - 器件的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+	     * @param primitiveIds - 器��的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
 	     * @returns 器件图元对象，空数组表示获取失败
 	     */
 	    get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveComponent>>;
@@ -10428,7 +10473,7 @@ declare global {
 	     *
 	     * @alpha
 	     * @remarks
-	     * DEFINED since API v0.2.26
+	     * ADD since API v0.2.26
 	     *
 	     * 本接口模拟前端点击放置按钮，指定的封装将绑定到当前鼠标，并在用户后续点击时放置于画布
 	     *
@@ -13731,7 +13776,7 @@ declare global {
 	     */
 	    setState_FontSize(fontSize: number | null): ISCH_PrimitiveAttribute;
 	    /**
-	     * 设置属性状态：是否加粗
+	     * ��置属性状态：是否加粗
 	     *
 	     * @beta
 	     * @param bold - 是否加粗
@@ -14840,7 +14885,7 @@ declare global {
 	     */
 	    setState_NoConnected(noConnected: boolean): ISCH_PrimitiveComponentPin;
 	    /**
-	     * 将异步图元重置为当前画布状态
+	     * 将异���图元重置为当前画布状态
 	     *
 	     * @internal
 	     * @remarks 本器件引脚图元属性不支持修改，本接口调用将不会有任何效果
@@ -15930,7 +15975,7 @@ declare global {
 	     *
 	     * @alpha
 	     * @remarks
-	     * DEFINED since API v0.2.26
+	     * ADD since API v0.2.26
 	     *
 	     * 本接口模拟前端点击放置按钮，指定的符号将绑定到当前鼠标，并在用户后续点击时放置于画布
 	     *
@@ -16501,6 +16546,7 @@ declare global {
 	     * 创建二进制内嵌对象
 	     *
 	     * @beta
+	     * @param content - 对象内容
 	     * @param startX - 起点坐标 X
 	     * @param startY - 起点坐标 Y
 	     * @param width - 宽
@@ -16508,7 +16554,6 @@ declare global {
 	     * @param rotation - 旋转角度
 	     * @param mirror - 是否镜像
 	     * @param fileName - 文件名称
-	     * @param content - 对象内容
 	     * @returns 二进制内嵌对象图元对象
 	     */
 	    create(content: File | string, startX: number, startY: number, width?: number, height?: number, rotation?: number, mirror?: boolean, fileName?: string): Promise<ISCH_PrimitiveObject | undefined>;
@@ -17486,7 +17531,7 @@ declare global {
 	     */
 	    getState_PrimitiveId(): string;
 	    /**
-	     * 获取属性状态：多段线坐标组
+	     * 获取属性状态：多���线坐标组
 	     *
 	     * @public
 	     * @returns 多段线坐标组
@@ -18094,7 +18139,7 @@ declare global {
 	interface SortInfo {
 	    /** 列key */
 	    colKey: string;
-	    /** 排序字��� */
+	    /** 排序字段 */
 	    key: string | string[];
 	    /** 排序状态 */
 	    status: SortStatus;
@@ -19019,7 +19064,7 @@ declare global {
 	     */
 	    isOfflineMode(): boolean;
 	    /**
-	     * 获取编辑器当前版本
+	     * 获取编辑器���前版本
 	     *
 	     * @public
 	     * @returns 编辑器当前版本
@@ -19513,7 +19558,7 @@ declare global {
 	        insertDividerAfter?: boolean;
 	        /** 在指定 ID 的菜单项的前面插入当前菜单项 */
 	        insertBefore?: string;
-	        /** 在插入时是如若指定的菜单项前面存在分隔线，是否跨过该分隔线（即和 insertBefore 指定 ID 的菜单项之间是否可能存在分隔线，这和 insertDividerAfter 并不冲突，因为 insertDividerAfter 在菜单项插入完成后添加） */
+	        /** 在插入时如若指定的菜单项前面存在分隔线，是否跨过该分隔线（即和 insertBefore 指定 ID 的菜单项之间是否可能存在分隔线，这和 insertDividerAfter 并不冲突，因为 insertDividerAfter 在菜单项插入完成后添加） */
 	        crossDividerWhenInsert?: boolean;
 	    }): Promise<string | undefined>;
 	    /**
@@ -19531,7 +19576,7 @@ declare global {
 	     *
 	     * 注意：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
 	     *
-	     * 非公开接口使用提醒：本接口按原样提��，不提供参数的额外文档，参数可能在任何版本出现破坏性更改并不另行通知
+	     * 非公开接口使用提醒：本接口按原样提供，不提供参数的额外文档，参数可能在任何版本出现破坏性更改并不另行通知
 	     * @param headerMenus - 顶部菜单数据
 	     * @example
 	     * headerMenus:
@@ -20544,7 +20589,7 @@ declare global {
 	     * 获取扩展所有用户配置
 	     *
 	     * @public
-	     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+	     * @remarks 注意：本接口仅扩展有效，在独立脚本环境��调用将始终 `throw Error`
 	     * @returns 扩展所有用户配置信息
 	     */
 	    getExtensionAllUserConfigs(): {
@@ -20589,7 +20634,7 @@ declare global {
 	     *
 	     * @public
 	     * @remarks
-	     * 新建扩展用户配置也使用本接口，在设置时如果不存在将会自动��建
+	     * 新建扩展用户配置也使用本接口，在设置时如果不存在将会自动新建
 	     *
 	     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
 	     * @param key - 配置项

package/package.json

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