@jlceda/pro-api-types 0.1.126 → 0.1.128

package/index.d.ts

@@ -86,7 +86,7 @@ declare class DMT_EditorControl {
      *
      * @beta
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
-     * @param libraryType - 库类型，支持符号和封装
+     * @param libraryType - ���类型，支持符号和封装
      * @param uuid - 符号、封装 UUID
      * @param splitScreenId - 分屏 ID，即 {@link DMT_EditorControl.getSplitScreenTree} 方法获取到的 {@link IDMT_EditorSplitScreenItem.id}
      * @returns 标签页 ID，如若为 `undefined`，则打开文档失败
@@ -582,7 +582,7 @@ declare class DMT_Schematic {
      * @beta
      * @param schematicPageUuid - 原理图图页 UUID
      * @param schematicPageName - 原理图图页名称
-     * @returns 是否���改成功
+     * @returns 是否修改成功
      */
     modifySchematicPageName(schematicPageUuid: string, schematicPageName: string): Promise<boolean>;
     /**
@@ -4786,7 +4786,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     setState_Layer(layer: TPCB_LayersOfPad): IPCB_PrimitivePad;
     /**
-     * 设置属性状���：焊盘编号
+     * 设置属性��态：焊盘编号
      *
      * @beta
      * @param padNumber - 焊盘编号
@@ -7628,7 +7628,7 @@ declare class ISCH_PrimitivePolygon implements ISCH_Primitive {
      */
     reset(): Promise<ISCH_PrimitivePolygon>;
     /**
-     * 将对图元的更改应用到画布
+     * ��对图元的更改应用到画布
      *
      * @beta
      * @returns 多边形图元对象
@@ -8427,7 +8427,7 @@ declare class LIB_3DModel {
      * @param classification - 分类，默认为全部
      * @param itemsOfPage - 一页搜索结果的数量
      * @param page - 页数
-     * @returns ���索到的 3D 模型属性列表
+     * @returns 搜索到的 3D 模型属性列表
      */
     search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex, itemsOfPage?: number, page?: number): Promise<Array<ILIB_3DModelSearchItem>>;
 }
@@ -8519,7 +8519,7 @@ declare class LIB_Cbb {
      * @beta
      * @param cbbUuid - 复用模块 UUID
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
-     * @param splitScreenId - 分屏 ID，不填写则默认在最后输入焦点的分屏内打开，可以使用 {@link DMT_EditorControl} 内的接口获取
+     * @param splitScreenId - 分屏 ID，不填写则默认在最后输入焦点的分屏内打开，可���使用 {@link DMT_EditorControl} 内的接口获取
      * @returns 标签页 ID，对应 {@link IDMT_EditorTabItem.tabId}，可使用 {@link DMT_EditorControl.getSplitScreenIdByTabId} 获取到分屏 ID
      */
     openSymbolInEditor(cbbUuid: string, libraryUuid: string, splitScreenId?: string): Promise<string | undefined>;
@@ -9181,7 +9181,7 @@ declare class PCB_Document {
      */
     startCalculatingRatline(): Promise<boolean>;
     /**
-     * 停���飞线计算功能
+     * 停止飞线计算功能
      *
      * @public
      * @returns 操作是否成功
@@ -9916,10 +9916,38 @@ declare class PCB_ManufactureData {
      * @returns 飞针测试文件数据
      */
     getFlyingProbeTestFile(fileName?: string): Promise<File | undefined>;
-    /* Excluded from this release type: getBomTemplates */
-    /* Excluded from this release type: uploadBomTemplateFile */
-    /* Excluded from this release type: getBomTemplateFile */
-    /* Excluded from this release type: deleteBomTemplate */
+    /**
+     * 获取 BOM 模板列表
+     *
+     * @beta
+     * @returns BOM 模板列表
+     */
+    getBomTemplates(): Promise<string[]>;
+    /**
+     * 上传 BOM 模板文件
+     *
+     * @beta
+     * @param templateFile - BOM 模板文件
+     * @param template - BOM 模板名称，如若为 `undefined` 则自动从 `templateFile` 中取值
+     * @returns BOM 模板名称
+     */
+    uploadBomTemplateFile(templateFile: File, template?: string): Promise<string | undefined>;
+    /**
+     * 获取 BOM 模板文件
+     *
+     * @beta
+     * @param template - BOM 模板名称
+     * @returns BOM 模板文件
+     */
+    getBomTemplateFile(template: string): Promise<File | undefined>;
+    /**
+     * 删除 BOM 模板
+     *
+     * @beta
+     * @param template - BOM 模板名称
+     * @returns 操作是否成功
+     */
+    deleteBomTemplate(template: string): Promise<boolean>;
     /**
      * 获取 BOM 文件
      *
@@ -10345,7 +10373,7 @@ declare class PCB_Primitive {
      * 获取图元的 BBox
      *
      * @beta
-     * @param primitiveIds - ���元 ID 数组或图元对象数组
+     * @param primitiveIds - 图元 ID 数组或图元对象数组
      * @returns 图元的 BBox，如若图元不存在或没有 BBox，将会返回 `undefined` 的结果
      */
     getPrimitivesBBox(primitiveIds: Array<string | IPCB_Primitive>): Promise<{
@@ -11593,7 +11621,7 @@ declare class SCH_Event {
 }
 
 /**
- * 原理图 & 符号 / 生产资���类
+ * 原理图 & 符号 / 生产资料类
  *
  * @public
  * @remarks 获取当前原理图图页的生产资料文件及快捷下单
@@ -11978,7 +12006,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
     private defaultLibraryUuid;
     /* Excluded from this release type: __constructor */
     /**
-     * 设��在扩展 API 中 Power 网络标识关联的器件 UUID
+     * 设置在扩展 API 中 Power 网络标识关联的器件 UUID
      *
      * @beta
      * @param component - 关联库器件
@@ -12616,7 +12644,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
      *
      * @beta
      * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
-     * @param primitiveIds - 多边形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 多边形的图元 ID，可以为字符串或字符串数组，如若为���组，则返回的也是数组
      * @returns 多边形图元对象，空数组表示获取失败
      */
     get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitivePolygon>>;
@@ -13138,6 +13166,7 @@ declare class SYS_FileManager {
      * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
      *
      * 注意：本接口需要启用 **工程管理 \> 下载工程** 权限，没有权限调用将始终 `throw Error`
+     *
      * @param fileName - 文件名
      * @param password - 加密密码
      * @returns 工程文件数据，`undefined` 表示当前未打开工程或数据获取失败
@@ -13203,8 +13232,9 @@ declare class SYS_FileManager {
      * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
      *
      * 注意：本接口需要启用 **团队库 \> 下载库** 权限，没有权限调用将始终 `throw Error`
+     *
      * @param deviceUuid - 器件 UUID 或器件 UUID 列表
-     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取，如若不传入，则为系统库
      * @returns 器件文件数据，`undefined` 表示数据获取失败
      */
     getDeviceFileByDeviceUuid(deviceUuid: string | Array<string>, libraryUuid?: string): Promise<File | undefined>;
@@ -13914,7 +13944,7 @@ declare class SYS_ToastMessage {
      * @param messageType - 消息类型
      * @param timer - 自动关闭倒计时秒数，`0` 为不自动关闭
      * @param bottomPanel - 展开底部信息面板
-     * @param buttonTitle - 回调按钮标题
+     * @param buttonTitle - ��调按钮标题
      * @param buttonCallbackFn - 回调函数内容，字符串形式，会被自动解析并执行
      */
     showMessage(message: string, messageType?: ESYS_ToastMessageType, timer?: number, bottomPanel?: ESYS_BottomPanelTab, buttonTitle?: string, buttonCallbackFn?: string): void;
@@ -14092,7 +14122,7 @@ declare class SYS_Window {
  * 可选中图层
  *
  * @public
- * @remarks 此处为所有在编辑器图层菜单中可以选中并设置��见性的图层
+ * @remarks 此处为所有在编辑器图层菜单中可以选中并设置可见性的图层
  */
 declare type TPCB_LayersInTheSelectable = TPCB_LayersOfInner | TPCB_LayersOfCustom | EPCB_LayerId.TOP | EPCB_LayerId.TOP_SILKSCREEN | EPCB_LayerId.TOP_SOLDER_MASK | EPCB_LayerId.TOP_PASTE_MASK | EPCB_LayerId.TOP_ASSEMBLY | EPCB_LayerId.TOP_STIFFENER | EPCB_LayerId.BOTTOM | EPCB_LayerId.BOTTOM_SILKSCREEN | EPCB_LayerId.BOTTOM_SOLDER_MASK | EPCB_LayerId.BOTTOM_PASTE_MASK | EPCB_LayerId.BOTTOM_ASSEMBLY | EPCB_LayerId.BOTTOM_STIFFENER | EPCB_LayerId.BOARD_OUTLINE | EPCB_LayerId.MULTI | EPCB_LayerId.DOCUMENT | EPCB_LayerId.MECHANICAL | EPCB_LayerId.DRILL_DRAWING | EPCB_LayerId.RATLINE | EPCB_LayerId.COMPONENT_SHAPE | EPCB_LayerId.COMPONENT_MARKING | EPCB_LayerId.PIN_SOLDERING | EPCB_LayerId.PIN_FLOATING | EPCB_LayerId.SHELL_3D_OUTLINE | EPCB_LayerId.SHELL_3D_TOP | EPCB_LayerId.SHELL_3D_BOTTOM;
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@jlceda/pro-api-types",
-	"version": "0.1.126",
+	"version": "0.1.128",
 	"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
 	"typings": "index.d.ts",
 	"keywords": [