@jlceda/pro-api-types 0.2.45 → 0.2.47

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 操作是否成功
 	     */
@@ -963,7 +963,7 @@ declare global {
 	     *
 	     * @public
 	     * @param documentUuid - 文档 UUID，此处支持 {@link IDMT_SchematicItem.uuid}、{@link IDMT_SchematicPageItem.uuid}、{@link IDMT_PcbItem.uuid}、{@link IDMT_PanelItem.uuid} 作为输入
-	     * @param splitScreenId - 分��� ID，即 {@link DMT_EditorControl.getSplitScreenTree} 方法获取到的 {@link IDMT_EditorSplitScreenItem.id}
+	     * @param splitScreenId - 分屏 ID，即 {@link DMT_EditorControl.getSplitScreenTree} 方法获取到的 {@link IDMT_EditorSplitScreenItem.id}
 	     * @returns 标签页 ID，如若为 `undefined`，则打开文档失败
 	     */
 	    openDocument(documentUuid: string, splitScreenId?: string): Promise<string | undefined>;
@@ -1382,7 +1382,7 @@ declare global {
 	     *
 	     * @public
 	     * @param panelUuid - 面板 UUID
-	     * @returns 面板的详细属性，如若为 `undefined` 则获取失败
+	     * @returns 面板的详细属性，如若为 `undefined` 则获取��败
 	     */
 	    getPanelInfo(panelUuid: string): Promise<IDMT_PanelItem | undefined>;
 	    /**
@@ -2270,8 +2270,6 @@ declare global {
 	    name?: string;
 	    /** 值 */
 	    value?: string;
-	    /** 描述 */
-	    description?: string;
 	    /** 关联符号名称 */
 	    symbolName?: string;
 	    /** 关联封装名称 */
@@ -2412,11 +2410,11 @@ 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 - 页数
@@ -2739,7 +2737,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 索引
 	 */
@@ -4375,7 +4373,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` 的矩形范围；
 	     *
 	     * 本接口不进行缩放操作，但会生成指示定位中心及表示区域范围的矩形框；
 	     *
@@ -8268,7 +8266,7 @@ declare global {
 	     * 在 PCB 画布中创建图元
 	     *
 	     * @internal
-	     * @remarks 覆铜填充图元不支持新建，本接口调用将不会��任何效果
+	     * @remarks 覆铜填充图元不支持新建，本接口调用将不会有任何效果
 	     * @returns 覆铜填充图元对象
 	     */
 	    create(): IPCB_PrimitivePoured;
@@ -10415,7 +10413,7 @@ declare global {
 	     * @remarks
 	     * 本接口模拟前端点击放置按钮，指定的器件将绑定到当前鼠标，并在用户后续点击时放置于画布
 	     *
-	     * 本接口的返回时机并���会等待用户的放置操作，一旦器件被绑定到鼠标，本接口将立即返回 `true` 的结果
+	     * 本接口的返回时机并不会等待用户的放置操作，一旦器件被绑定到鼠标，本接口将立即返回 `true` 的结果
 	     * @param component - 关联库器件
 	     * @returns 是否找到器件
 	     */
@@ -10428,7 +10426,7 @@ declare global {
 	     *
 	     * @alpha
 	     * @remarks
-	     * DEFINED since API v0.2.26
+	     * ADD since API v0.2.26
 	     *
 	     * 本接口模拟前端点击放置按钮，指定的封装将绑定到当前鼠标，并在用户后续点击时放置于画布
 	     *
@@ -13791,7 +13789,7 @@ declare global {
 	     *
 	     * @beta
 	     * @param keyVisible - 键是否显示
-	     * @returns 属性图元对象
+	     * @returns 属性图元对���
 	     */
 	    setState_KeyVisible(keyVisible: boolean | null): ISCH_PrimitiveAttribute;
 	    /**
@@ -15930,7 +15928,7 @@ declare global {
 	     *
 	     * @alpha
 	     * @remarks
-	     * DEFINED since API v0.2.26
+	     * ADD since API v0.2.26
 	     *
 	     * 本接口模拟前端点击放置按钮，指定的符号将绑定到当前鼠标，并在用户后续点击时放置于画布
 	     *
@@ -18094,7 +18092,7 @@ declare global {
 	interface SortInfo {
 	    /** 列key */
 	    colKey: string;
-	    /** 排序字�� */
+	    /** 排序字段 */
 	    key: string | string[];
 	    /** 排序状态 */
 	    status: SortStatus;

package/package.json

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