@jlceda/pro-api-types 0.1.174 → 0.1.175

package/index.d.ts

@@ -806,11 +806,6 @@ declare class DMT_Workspace {
     getCurrentWorkspaceInfo(): Promise<IDMT_WorkspaceItem | undefined>;
 }
 
-declare enum EBoardOutlineSourceType {
-    FromKeepoutLayer = "keepout",
-    FromMechanicalLayer1 = "mechanical"
-}
-
 /**
  * 嘉立创 EDA 专业版 API 接口
  *
@@ -1029,12 +1024,6 @@ declare enum EDMT_ProjectCollaborationMode {
     FREE = 1
 }
 
-declare enum EImportOptionType {
-    ImportDocument = "ImportDocument",
-    ExtractLibraries = "ExtractLibraries",
-    ImportDocumentExtractLibraries = "ImportDocumentExtractLibraries"
-}
-
 /**
  * 层状态
  */
@@ -1079,6 +1068,22 @@ declare enum ELIB_LibraryType {
     PANEL_LIBRARY = "29"
 }
 
+/**
+ * 预览视图类型
+ *
+ * @public
+ */
+declare enum ELIB_PreviewType {
+    /** 符号预览 */
+    SYMBOL = "S",
+    /** 封装预览 */
+    FOOTPRINT = "F",
+    /** 产品实物预览 */
+    PRODUCT = "P",
+    /** 3D 预览 */
+    MODEL_3D = "3D"
+}
+
 /**
  * 符号类型
  *
@@ -1361,6 +1366,18 @@ declare enum EPCB_LayerType {
     CUSTOM = "CUSTOM"
 }
 
+/**
+ * 鼠标事件类型
+ *
+ * @public
+ */
+declare enum EPCB_MouseEventType {
+    /** 选中 */
+    SELECTED = "selected",
+    /** 取消选中 */
+    CLEAR_SELECTED = "clearSelected"
+}
+
 /**
  * PCB 板材类型
  *
@@ -1413,6 +1430,22 @@ declare enum EPCB_PrimitiveDimensionType {
     ANGLE = "Protractor Dimension"
 }
 
+/**
+ * 图元事件类型
+ *
+ * @public
+ */
+declare enum EPCB_PrimitiveEventType {
+    /** 删除 */
+    DELETE = "delete",
+    /** 创建 */
+    CREATE = "create",
+    /** 移动 */
+    MOVE = "move",
+    /** 属性变更（除位置外的属性变更） */
+    CHANGE = "change"
+}
+
 /**
  * 填充图元填充模式
  *
@@ -1603,6 +1636,18 @@ declare enum EPCB_PrimitiveViaType {
     SUTURE = 2
 }
 
+/**
+ * 鼠标事件类型
+ *
+ * @public
+ */
+declare enum ESCH_MouseEventType {
+    /** 选中 */
+    SELECTED = "selected",
+    /** 取消选中 */
+    CLEAR_SELECTED = "clearSelected"
+}
+
 /**
  * 器件类型
  *
@@ -1653,6 +1698,22 @@ declare enum ESCH_PrimitiveComponentType_2 {
     CBB_SYMBOL = "block_symbol"
 }
 
+/**
+ * 图元事件类型
+ *
+ * @public
+ */
+declare enum ESCH_PrimitiveEventType {
+    /** 删除 */
+    DELETE = "delete",
+    /** 创建 */
+    CREATE = "create",
+    /** 移动 */
+    MOVE = "move",
+    /** 属性变更（除位置外的属性变更） */
+    CHANGE = "change"
+}
+
 /**
  * 填充样式
  *
@@ -1773,11 +1834,6 @@ declare enum ESCH_PrimitiveType {
     ELLIPSE = "Ellipse"
 }
 
-declare enum ESchPrimitiveStyle {
-    UseSystemTheme = "system",
-    UseSourceFileStyle = "custom"
-}
-
 /**
  * 底部面板标签页
  *
@@ -1822,6 +1878,58 @@ declare enum ESYS_HeaderMenuEnvironment {
     PANEL_VIEW = "panelView"
 }
 
+/**
+ * 导入工程板边框来源
+ *
+ * @public
+ * @remarks 仅 `fileType` 为 `Altium Designer` 或 `Protel` 时才可以指定该属性，否则将被忽略
+ */
+declare enum ESYS_ImportProjectBoardOutlineSource {
+    /** 从 Keepout 层 */
+    FROM_KEEPOUT_LAYER = "keepout",
+    /** 从机械层 1 */
+    FROM_MECHANICAL_LAYER_1 = "mechanical"
+}
+
+/**
+ * 导入工程导入选项
+ *
+ * @public
+ */
+declare enum ESYS_ImportProjectImportOption {
+    /** 导入文档 */
+    IMPORT_DOCUMENT = "ImportDocument",
+    /** 提取库文件 */
+    EXTRACT_LIBRARIES = "ExtractLibraries",
+    /** 导入文档并提取库 */
+    IMPORT_DOCUMENT_EXTRACT_LIBRARIES = "ImportDocumentExtractLibraries"
+}
+
+/**
+ * 导入工程原理图图元样式
+ *
+ * @public
+ */
+declare enum ESYS_ImportProjectSchematicObjectStyle {
+    /** 使用系统主题 */
+    USE_SYSTEM_THEME = "system",
+    /** 使用源文件样式 */
+    USE_SOURCE_FILE_STYLE = "custom"
+}
+
+/**
+ * 导入工程过孔阻焊扩展
+ *
+ * @public
+ * @remarks 仅 `fileType` 为 `Altium Designer` 或 `Protel` 时才可以指定该属性，否则将被忽略
+ */
+declare enum ESYS_ImportProjectViaSolderMaskExpansion {
+    /** 全部盖油 */
+    ALL_COVER_OIL = "cover",
+    /** 跟随源设置 */
+    FOLLOW_ORIGINAL_SETTING = "custom"
+}
+
 /**
  * 左侧面板标签页
  *
@@ -2047,11 +2155,6 @@ declare enum ESYS_WindowOpenTarget {
     SELF = "_self"
 }
 
-declare enum EViaSolderMaskExpansion {
-    AllCoverOil = "cover",
-    FollowOriginalSetting = "custom"
-}
-
 /**
  * 板子属性
  *
@@ -2726,6 +2829,8 @@ declare interface ILIB_ExtendLibraryDeviceFunctions extends ILIB_ExtendLibraryFu
         supplierPart?: string;
         manufacturer?: string;
         description?: string;
+        updateTime?: number;
+        createTime?: number;
     }>>;
     /**
      * 获取支持的符号类型
@@ -2786,6 +2891,12 @@ declare interface ILIB_ExtendLibraryFunctions {
      * @returns 库元素列表
      */
     getList: (props: ILIB_ExtendLibrarySearchProperty<any>) => Promise<ILIB_ExtendLibrarySearchResult<any>>;
+    /**
+     * 获取支持的预览类型
+     *
+     * @returns 预览类型数组
+     */
+    getSupportedPreviewTypes: () => Promise<Array<ELIB_PreviewType>>;
 }
 
 /**
@@ -4137,7 +4248,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
      */
     setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveComponent;
     /**
-     * 设置属性状��：是否加入 BOM
+     * 设置属性状态：是否加入 BOM
      *
      * @beta
      * @param addIntoBom - 是否加入 BOM
@@ -5992,7 +6103,7 @@ declare class IPCB_PrimitivePour implements IPCB_Primitive {
      */
     getState_PourFillMethod(): any;
     /**
-     * 获取属性��态：是否保留孤岛
+     * 获取属性状态：是否保留孤岛
      *
      * @public
      * @returns 是否保留孤岛
@@ -6626,7 +6737,7 @@ declare class IPCB_PrimitiveString implements IPCB_Primitive {
      */
     setState_Text(text: string): IPCB_PrimitiveString;
     /**
-     * 设置���性状态：字体
+     * 设置属性状态：字体
      *
      * @beta
      * @param fontFamily - 字体
@@ -7842,7 +7953,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
      *
      * @beta
      * @param rotation - 旋转角度
-     * @returns 器件图元对象
+     * @returns 器���图元对象
      */
     setState_Rotation(rotation: number): ISCH_PrimitiveComponent;
     /**
@@ -9207,7 +9318,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
      */
     setState_TextColor(textColor: string | null): ISCH_PrimitiveText;
     /**
-     * 设置属��状态：字体名称
+     * 设置属性状态：字体名称
      *
      * @beta
      * @param fontName - 字体名称
@@ -10469,7 +10580,7 @@ declare class PCB_Document {
      *
      * @public
      * @remarks
-     * 嘉立创 EDA 专业版前端显示的坐标均为画布原点；
+     * 嘉立创 EDA 专业版前端显示的��标均为画布原点；
      *
      * 嘉立创 EDA 专业版 API 使用的均为数据原点；
      *
@@ -10525,7 +10636,7 @@ declare class PCB_Document {
      * @remarks
      * 本接口在前端画布上定位到指定的区域，区域数据为相对于数据原点的偏移；
      *
-     * 例如：���入数据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`，
+     * 例如：传入数据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`，
      * 则画布将会定位到以 `[30, 40]` 为中心的，`x` 轴方向长度为 `60`，`y` 轴方向长度为 `120` 的矩形范围；
      *
      * 本接口不进行缩放操作，但会生成指示定位中心及表示区域范围的矩形框；
@@ -10935,7 +11046,7 @@ declare class PCB_Drc {
      * @param padPair - 焊盘对
      * @returns 操作是否成功
      * @example 有三种不同的用法，确保画布上已有对应的焊盘。 分别是 一，游离焊盘-游离焊盘；二，器件焊盘 - 器件焊盘；三，器件焊盘 - 游离焊盘
-     * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['e0','e1']) // 游离焊盘-游离��盘
+     * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['e0','e1']) // 游离焊盘-游离焊盘
      * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['R1:1','R1:2']) // 器件焊盘 - 器件焊盘
      * await eda.pcb_Drc.addPadPairToPadPairGroup('test',['R1:1','e1']) // 器件焊盘 - 游离焊盘
      */
@@ -10986,7 +11097,8 @@ declare class PCB_Event {
      * @param callFn - 事件触发时的回调函数
      * @param onlyOnce - 是否仅监听一次
      */
-    addMouseEventListener(id: string, eventType: 'all' | 'selected' | 'clearSelected', callFn: (eventType: 'selected' | 'clearSelected') => void | Promise<void>, onlyOnce?: boolean): void;
+    addMouseEventListener(id: string, eventType: 'all' | EPCB_MouseEventType, callFn: (eventType: EPCB_MouseEventType) => void | Promise<void>, onlyOnce?: boolean): void;
+    /* Excluded from this release type: addPrimitiveEventListener */
     /**
      * 移除事件监听
      *
@@ -11227,7 +11339,7 @@ declare class PCB_ManufactureData {
      * @beta
      * @returns BOM 模板列表
      */
-    getBomTemplates(): Promise<string[]>;
+    getBomTemplates(): Promise<Array<string>>;
     /**
      * 上传 BOM 模板文件
      *
@@ -11621,7 +11733,7 @@ declare class PCB_Net {
      * 取消高亮网络
      *
      * @beta
-     * @remarks 本接口的返回值为结果导向，如果该网络原先未高亮，也将返回 `true`
+     * @remarks 本接口的返回值为结果导向，��果该网络原先未高亮，也将返回 `true`
      * @param net - 网络名称
      * @returns 操作是否成功
      */
@@ -12029,7 +12141,7 @@ declare class PCB_PrimitiveFill implements IPCB_PrimitiveAPI {
      *
      * @beta
      * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
-     * @param primitiveIds - 填充的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 填充的图元 ID，可��为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 填充图元对象，空数组表示获取失败
      */
     get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveFill>>;
@@ -12845,7 +12957,7 @@ declare class PCB_SelectControl {
      * 获取当前鼠标在画布上的位置
      *
      * @beta
-     * @returns 鼠标在画布上的位置，`undefined` 代表当前鼠标不在画布上
+     * @returns 鼠标在画布上的位置，`undefined` 代表当前鼠标不���画布上
      */
     getCurrentMousePosition(): Promise<{
         x: number;
@@ -12932,7 +13044,8 @@ declare class SCH_Event {
      * @param callFn - 事件触发时的回调函数
      * @param onlyOnce - 是否仅监听一次
      */
-    addMouseEventListener(id: string, eventType: 'all' | 'selected' | 'clearSelected', callFn: (eventType: 'selected' | 'clearSelected') => void | Promise<void>, onlyOnce?: boolean): void;
+    addMouseEventListener(id: string, eventType: 'all' | ESCH_MouseEventType, callFn: (eventType: ESCH_MouseEventType) => void | Promise<void>, onlyOnce?: boolean): void;
+    /* Excluded from this release type: addPrimitiveEventListener */
     /**
      * 移除事件监听
      *
@@ -12958,6 +13071,7 @@ declare class SCH_Event {
  * @remarks 获取当前原理图图页的生产资料文件及快捷下单
  */
 declare class SCH_ManufactureData {
+    /* Excluded from this release type: getAssemblyVariantsConfigs */
     /**
      * 获取 BOM 文件
      *
@@ -12970,12 +13084,13 @@ declare class SCH_ManufactureData {
      * @param statistics - 统计，包含所有需要启用的统计项的名称
      * @param property - 属性，包含所有需要启用的属性的名称
      * @param columns - 列的属性及排序，`title`、`sort`、`group`、`orderWeight` 不传入则取默认值，`null` 代表 **无** 或 **空**
+     * @param assemblyVariantsConfig - 装配体变量配置
      * @returns BOM 文件数据
      */
     getBomFile(fileName?: string, fileType?: 'xlsx' | 'csv', template?: string, filterOptions?: Array<{
         property: string;
         includeValue: boolean | string;
-    }>, statistics?: Array<string>, property?: Array<string>, columns?: Array<IPCB_BomPropertiesTableColumns>): Promise<File | undefined>;
+    }>, statistics?: Array<string>, property?: Array<string>, columns?: Array<IPCB_BomPropertiesTableColumns>, assemblyVariantsConfig?: string): Promise<File | undefined>;
     /**
      * 获取网表文件（Netlist）
      *
@@ -13632,7 +13747,7 @@ declare class SCH_PrimitiveComponent3 implements ISCH_PrimitiveAPI {
         uuid: string;
     } | ILIB_DeviceItem | ILIB_DeviceSearchItem): Promise<boolean>;
     /**
-     * 设置在扩展 API 中 AnalogGround 网络标识关联的器件 UUID
+     * 设置在扩展 API 中 AnalogGround 网络标��关联的器件 UUID
      *
      * @beta
      * @param component - 关联库器件
@@ -13698,7 +13813,7 @@ declare class SCH_PrimitiveComponent3 implements ISCH_PrimitiveAPI {
      * @param mirror - 是否镜像
      * @param addIntoBom - 是否加入 BOM
      * @param addIntoPcb - 是否转到 PCB
-     * @returns 器件图���对象
+     * @returns 器件图元对象
      */
     create(component: {
         libraryUuid: string;
@@ -14076,7 +14191,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
      * 获取矩形
      *
      * @beta
-     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它���元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 矩形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 矩形图元对象，空数组表示获取失败
      */
@@ -14603,9 +14718,10 @@ declare class SYS_FileManager {
      *
      * @param fileName - 文件名
      * @param password - 加密密码
+     * @param fileType - 文件格式
      * @returns 工程文件数据，`undefined` 表示当前未打开工程或数据获取失败
      */
-    getProjectFile(fileName?: string, password?: string): Promise<File | undefined>;
+    getProjectFile(fileName?: string, password?: string, fileType?: '.epro' | '.epro2'): Promise<File | undefined>;
     /**
      * 获取文档文件
      *
@@ -14616,9 +14732,10 @@ declare class SYS_FileManager {
      * 注意：本接口需要启用 **工程设计图 \> 文件导出** 权限，没有权限调用将始终 `throw Error`
      * @param fileName - 文件名
      * @param password - 加密密码
+     * @param fileType - 文件格式
      * @returns 文档文件数据，`undefined` 表示当前未打开文档或数据获取失败
      */
-    getDocumentFile(fileName?: string, password?: string): Promise<File | undefined>;
+    getDocumentFile(fileName?: string, password?: string, fileType?: '.epro' | '.epro2'): Promise<File | undefined>;
     /**
      * 获取文档源码
      *
@@ -14647,7 +14764,7 @@ declare class SYS_FileManager {
     /**
      * 使用工程 UUID 获取工程文件
      *
-     * @public
+     * @beta
      * @remarks
      * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
      *
@@ -14655,9 +14772,10 @@ declare class SYS_FileManager {
      * @param projectUuid - 工程 UUID
      * @param fileName - 文件名
      * @param password - 加密密码
+     * @param fileType - 文件格式
      * @returns 工程文件数据，`undefined` 表示当前未打开工程或数据获取失败
      */
-    getProjectFileByProjectUuid(projectUuid: string, fileName?: string, password?: string): Promise<File | undefined>;
+    getProjectFileByProjectUuid(projectUuid: string, fileName?: string, password?: string, fileType?: '.epro' | '.epro2'): Promise<File | undefined>;
     /**
      * 使用器件 UUID 获取器件文件
      *
@@ -14700,7 +14818,12 @@ declare class SYS_FileManager {
      * @param password - 加密密码
      * @returns 复用模块文件数据，`undefined` 表示数据获取失败
      */
-    getCbbFileByCbbUuid(cbbUuid: string, libraryUuid?: string, cbbName?: string, password?: string): Promise<File | undefined>;
+    getCbbFileByCbbUuid(cbbUuid: string, libraryUuid?: string, props?: {
+        fileName?: string;
+        password?: string;
+        templateSchematicUuid?: string;
+        templatePcbUuid?: string;
+    }): Promise<File | undefined>;
     /**
      * 使用面板库 UUID 获取面板库文件
      *
@@ -14726,8 +14849,8 @@ declare class SYS_FileManager {
      * @returns 导入的工程的简略工程属性
      */
     importProjectByProjectFile(projectFile: File, fileType?: 'JLCEDA' | 'JLCEDA Pro' | 'EasyEDA' | 'EasyEDA Pro' | 'Allegro' | 'OrCAD' | 'EAGLE' | 'KiCad' | 'PADS' | 'LTspice', props?: {
-        importOption?: EImportOptionType;
-        schematicObjectStyle?: ESchPrimitiveStyle;
+        importOption?: ESYS_ImportProjectImportOption;
+        schematicObjectStyle?: ESYS_ImportProjectSchematicObjectStyle;
         associateFootprint?: boolean;
         associate3DModel?: boolean;
         importFootprintNotesLayer?: boolean;
@@ -14758,10 +14881,10 @@ declare class SYS_FileManager {
      * @returns 导入的工程的简略工程属性
      */
     importProjectByProjectFile(projectFile: File, fileType?: 'Altium Designer' | 'Protel', props?: {
-        importOption?: EImportOptionType;
-        viaSolderMaskExpansion?: EViaSolderMaskExpansion;
-        boardOutlineSource?: EBoardOutlineSourceType;
-        schematicObjectStyle?: ESchPrimitiveStyle;
+        importOption?: ESYS_ImportProjectImportOption;
+        viaSolderMaskExpansion?: ESYS_ImportProjectViaSolderMaskExpansion;
+        boardOutlineSource?: ESYS_ImportProjectBoardOutlineSource;
+        schematicObjectStyle?: ESYS_ImportProjectSchematicObjectStyle;
         associateFootprint?: boolean;
         associate3DModel?: boolean;
         importFootprintNotesLayer?: boolean;
@@ -15129,7 +15252,7 @@ declare class SYS_IFrame {
      *
      * @beta
      * @remarks
-     * 关闭指定 ID 的内联框架窗口；
+     * 关闭指定 ID 的内联框架窗口
      *
      * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param id - 内联框架窗口 ID，如若传入 `undefined`，将关闭由本扩展打开的所有内联框架窗口
@@ -15143,6 +15266,8 @@ declare class SYS_IFrame {
      * @remarks 本接口为结果导向的：
      * 如若未找到指定内联框架窗口，接口将会返回 `false`；
      * 如若在执行操作前该内联框架窗口已处于隐藏状态，接口将会返回 `true`
+     *
+     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param id - 内联框架窗口 ID
      * @returns 操作是否成功
      */
@@ -15154,14 +15279,17 @@ declare class SYS_IFrame {
      * @remarks 本接口为结果导向的：
      * 如若未找到指定内联框架窗口，接口将会返回 `false`；
      * 如若在执行操作前该内联框架窗口已处于显示状态，接口将会返回 `true`
+     *
+     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param id - 内联框架窗口 ID
      * @returns 操作是否成功
      */
     showIFrame(id?: string): Promise<boolean>;
+    /* Excluded from this release type: isIFrameAlreadyExist */
 }
 
 /**
- * 系统 / 加载与进度条类
+ * 系统 / 加载与进���条类
  *
  * @public
  */
@@ -15276,7 +15404,7 @@ declare class SYS_Message {
      * 展示跟随鼠标的提示
      *
      * @beta
-     * @remarks 同一时间只能展示一条提示，如果展示���的提示，则之前的提示将被自动移除
+     * @remarks 同一时间只能展示一条提示，如果展示新的提示，则之前的提示将被自动移除
      * @param tip - 提示内容
      * @param msTimeout - 展示时间，以毫秒（ms）为单位，如若不传入则持续展示，直到调用 {@link SYS_Message.removeFollowMouseTip | removeFollowMouseTip} 或被其它提示覆盖
      */
@@ -15694,7 +15822,7 @@ declare class SYS_Storage {
      *
      * @public
      * @remarks
-     * 此举会删除当前扩展的所有用户配置信息，请谨慎操作
+     * 此举会删除当前扩展的所有用户配置信息，请��慎操作
      *
      * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @returns 操作是否成功

package/package.json

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