@jlceda/pro-api-types 0.1.76 → 0.1.78

package/README.en.md

@@ -10,7 +10,7 @@ JLCEDA & EasyEDA Pro Edition Extension API Interface Type Definition
 
 It is recommended to use [pro-api-sdk](https://github.com/easyeda/pro-api-sdk) for extension development, this definition file is pre-configured within the SDK.
 
-1. 安装类型定义
+1. Install type definition
 
     ```shell
     npm install --save-dev @jlceda/pro-api-types

package/index.d.ts

@@ -416,7 +416,7 @@ declare class DMT_Project {
      * @param teamUuid - 团队 UUID，如若不指定，则默认为个人；在不存在个人工程的环境下必须指定团队 UUID
      * @param folderUuid - 文件夹 UUID，如若不指定，则为根文件夹
      * @param description - 工程描述
-     * @param collaborationMode - 工程协作模式，如若团队权限无需工程设置协作模式，则��参数将被忽略
+     * @param collaborationMode - 工程协作模式，如若团队权限无需工程设置协作模式，则该参数将被忽略
      * @returns 工程 UUID，如若为 `undefined` 则创建失败
      */
     createProject(projectFriendlyName: string, projectName?: string, teamUuid?: string, folderUuid?: string, description?: string, collaborationMode?: EDMT_ProjectCollaborationMode): Promise<string | undefined>;
@@ -595,7 +595,7 @@ declare class DMT_Schematic {
      */
     getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;
     /**
-     * 获取当前原��图图页的详细属性
+     * 获取当前原理图图页的详细属性
      *
      * @beta
      * @remarks 将会获取当前打开且拥有最后输入焦点的原理图图页的详细属性
@@ -770,6 +770,7 @@ declare class EDA {
     sch_SelectControl: SCH_SelectControl;
     sch_Utils: SCH_Utils;
     sys_ClientUrl: SYS_ClientUrl;
+    sys_Environment: SYS_Environment;
     sys_FileManager: SYS_FileManager;
     sys_FileSystem: SYS_FileSystem;
     sys_FontManager: SYS_FontManager;
@@ -2110,7 +2111,7 @@ declare interface ILIB_PanelLibraryItem {
     libraryUuid: string;
     /** 面板库名称 */
     name: string;
-    /** 分�� */
+    /** 分类 */
     classification?: ILIB_ClassificationIndex;
     /** 描述 */
     description?: string;
@@ -2270,7 +2271,7 @@ declare interface IPCB_LayerItem {
     type: EPCB_LayerType;
     /** 颜色（RGB HEX 格式） */
     color: string;
-    /** ��明度（%） */
+    /** 透明度（%） */
     transparency: number;
 }
 
@@ -3273,7 +3274,7 @@ declare class IPCB_PrimitivePolyline implements IPCB_Primitive {
 declare interface IPCB_PrimitiveSolderMaskAndPasteMaskExpansion {
     /** 顶层阻焊扩展 */
     topSolderMask?: number;
-    /** 底��阻焊扩展 */
+    /** 底层阻焊扩展 */
     bottomSolderMask?: number;
     /** 顶层助焊扩展 */
     topPasteMask?: number;
@@ -3960,7 +3961,7 @@ declare class ISCH_PrimitiveRectangle implements ISCH_Primitive {
     private height;
     /** 圆角半径 */
     private cornerRadius;
-    /** 旋���角度 */
+    /** 旋转角度 */
     private rotation;
     /** 边框颜色 */
     private color;
@@ -5585,7 +5586,7 @@ declare class PCB_Layer {
  * PCB & 封装 / 生产资料类
  *
  * @public
- * @remarks 获取当前 PCB 的生产资料文件
+ * @remarks 获取当前 PCB 的生产资料文件及快捷下单
  */
 declare class PCB_ManufactureData {
     /**
@@ -5682,7 +5683,7 @@ declare class PCB_ManufactureData {
      */
     getNetlistFile(fileName?: string, netlistType?: ENetlistType): Promise<File | undefined>;
     /**
-     * 获取 DXF 文件
+     * 获取 DXF ���件
      *
      * @beta
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
@@ -5737,6 +5738,10 @@ declare class PCB_ManufactureData {
      * @returns PCB 信息文件
      */
     getPcbInfoFile(fileName?: string): Promise<File | undefined>;
+    /* Excluded from this release type: placeComponentsOrder */
+    /* Excluded from this release type: placeSmtComponentsOrder */
+    /* Excluded from this release type: placePcbOrder */
+    /* Excluded from this release type: place3DShellOrder */
 }
 
 /**
@@ -5895,7 +5900,7 @@ declare class PCB_PrimitiveArc implements IPCB_PrimitiveAPI {
      */
     create(net: string, layer: TPCB_LayersOfLine, startX: number, startY: number, endX: number, endY: number, arcAngle: number, lineWidth?: number, interactiveMode?: EPCB_PrimitiveArcInteractiveMode, primitiveLock?: boolean): Promise<IPCB_PrimitiveArc | undefined>;
     /**
-     * ���除圆弧线
+     * 删除圆弧线
      *
      * @beta
      * @param primitiveIds - 圆弧线的图元 ID 或圆弧线图元对象
@@ -6659,7 +6664,7 @@ declare class PNL_Document {
      * 保存文档
      *
      * @beta
-     * @returns 保存操作是否成功，保存失败、上传���败等错误均返回 `false`
+     * @returns 保存操作是否成功，保存失败、上传失败等错误均返回 `false`
      */
     save(): Promise<boolean>;
 }
@@ -6744,7 +6749,7 @@ declare class SCH_Event {
  * 原理图 & 符号 / 生产资料类
  *
  * @public
- * @remarks 获取当前原理图图页的生产资料文件
+ * @remarks 获取当前原理图图页的生产资料文件及快捷下单
  */
 declare class SCH_ManufactureData {
     /**
@@ -6767,6 +6772,8 @@ declare class SCH_ManufactureData {
      * @returns 网表文件数据
      */
     getNetlistFile(fileName?: string, netlistType?: ENetlistType): Promise<File | undefined>;
+    /* Excluded from this release type: placeComponentsOrder */
+    /* Excluded from this release type: placeSmtComponentsOrder */
 }
 
 /**
@@ -7081,7 +7088,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      *
      * @beta
      * @param componentUuid - 器件 UUID
-     * @param libraryPath - 库路���，默认为系统库
+     * @param libraryPath - 库路径，默认为系统库
      * @returns 操作是否成功
      */
     setNetFlagComponentUuid_ProtectGround(componentUuid: string, libraryPath?: string): Promise<boolean>;
@@ -7439,7 +7446,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
      * 获取矩形
      *
      * @public
-     * @param primitiveIds - 矩形的���元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 矩形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 矩形图元对象
      */
     get(primitiveIds: string): Promise<ISCH_PrimitiveRectangle | undefined>;
@@ -7704,6 +7711,71 @@ declare class SYS_ClientUrl {
     }, succeedCallFn?: (data: Response) => void | Promise<void>): Promise<Response>;
 }
 
+/**
+ * 系统 / 运行环境类
+ *
+ * @public
+ * @remarks 获取嘉立创 EDA 专业版运行环境参数
+ */
+declare class SYS_Environment {
+    /**
+     * 是否处于浏览器环境
+     *
+     * @public
+     * @returns 是否处于浏览器环境
+     */
+    isWeb(): boolean;
+    /**
+     * 是否处于客户端环境
+     *
+     * @public
+     * @returns 是否处于客户端环境
+     */
+    isClient(): boolean;
+    /**
+     * 是否为 EasyEDA Pro 版本
+     *
+     * @public
+     * @returns 是否为 EasyEDA Pro 版本
+     */
+    isEasyEDAProEdition(): boolean;
+    /**
+     * 是否为嘉立创EDA 专业版本
+     *
+     * @public
+     * @returns 是否为嘉立创EDA 专业版本
+     */
+    isJLCEDAProEdition(): boolean;
+    /**
+     * 是否为私有化部署版本
+     *
+     * @public
+     * @returns 是否为私有化部署版本
+     */
+    isProPrivateEdition(): boolean;
+    /**
+     * 是否为在线模式
+     *
+     * @public
+     * @returns 是否为在线模式
+     */
+    isOnlineMode(): boolean;
+    /**
+     * 是否为半离线模式
+     *
+     * @public
+     * @returns 是否为半离线模式
+     */
+    isHalfOfflineMode(): boolean;
+    /**
+     * 是否为全离线模式
+     *
+     * @public
+     * @returns 是否为全离线模式
+     */
+    isOfflineMode(): boolean;
+}
+
 /**
  * 系统 / 文件管理类
  *
@@ -7797,7 +7869,7 @@ declare class SYS_FileManager {
      */
     getFootprintFileByFootprintUuid(footprintUuid: string | Array<string>, libraryUuid?: string): Promise<File | undefined>;
     /**
-     * 使用复用模块 UUID ��取复用模块文件
+     * 使用复用模块 UUID 获取复用模块文件
      *
      * @beta
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
@@ -8102,7 +8174,7 @@ declare class SYS_PanelControl {
      * 打开左侧面板
      *
      * @public
-     * @param tab - 标签页，如若不指定则不切换标签页
+     * @param tab - 标签页，���若不指定则不切换标签页
      */
     openLeftPanel(tab?: ESYS_LeftPanelTab): void;
     /**
@@ -8235,13 +8307,14 @@ declare class SYS_Timer {
      * 设置循环定时器
      *
      * @public
+     * @remarks 如果遇到 ID 重复的定时器，则之前设置的定时器将被清除
      * @param id - 定时器 ID，用于定位&删除定时器
      * @param timeout - 定时时间，单位 ms
      * @param callFn - 定时调用函数
-     * @param argument - 传给定时调用函数的参数
+     * @param args - 传给定时调用函数的参数
      * @returns 定时器是否设置成功
      */
-    setIntervalTimer(id: string, timeout: number, callFn: (argument: any) => void, argument?: any): boolean;
+    setIntervalTimer(id: string, timeout: number, callFn: (...args: any) => void, ...args: any): boolean;
     /**
      * 清除指定循环定时器
      *
@@ -8254,12 +8327,22 @@ declare class SYS_Timer {
      * 设置单次定时器
      *
      * @public
+     * @remarks 如果遇到 ID 重复的定时器，则之前设置的定时器将被清除
+     * @param id - 定时器 ID
      * @param timeout - 定时时间，单位 ms
      * @param callFn - 定时调用函数
-     * @param argument - 传给定时调用函数的参数
+     * @param args - 传给定时调用函数的参数
      * @returns 定时器是否设置成功
      */
-    setTimeoutTimer(timeout: number, callFn: (argument: any) => void, argument?: any): boolean;
+    setTimeoutTimer(id: string, timeout: number, callFn: (...args: any) => void, ...args: any): boolean;
+    /**
+     * 清除指定单次定时器
+     *
+     * @public
+     * @param id - 定时器 ID
+     * @returns 定时器是否清除成功
+     */
+    clearTimeoutTimer(id: string): boolean;
 }
 
 /**
@@ -8295,7 +8378,7 @@ declare class SYS_Unit {
      *
      * @public
      * @param mil - 输入密尔数
-     * @param numberOfDecimals - 保留小��位数，默认为 `4`
+     * @param numberOfDecimals - 保留小数位数，默认为 `4`
      * @returns 输出毫米数
      */
     milToMm(mil: number, numberOfDecimals?: number): number;
@@ -8513,7 +8596,7 @@ declare type TPCB_LayerTypesOfInnerLayer = EPCB_LayerType.SIGNAL | EPCB_LayerTyp
  *
  * @public
  * @remarks
- * 单多边形为首尾重合的一条不间断的线所描述的区域，如果首尾不重合将会自动重合。
+ * 单多边形为首尾重合的一条不间断的线所描述的区域��如果首尾不重合将会自动重合。
  *
  * 单多边形的数据格式举例：
  *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@jlceda/pro-api-types",
-	"version": "0.1.76",
+	"version": "0.1.78",
 	"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
 	"typings": "index.d.ts",
 	"keywords": [
@@ -30,11 +30,11 @@
 		"eslint-plugin-tsdoc": "^0.3.0",
 		"fast-text-encoding": "^1.0.6",
 		"fs-extra": "^11.2.0",
-		"husky": "^9.1.4",
-		"lint-staged": "^15.2.9",
+		"husky": "^9.1.6",
+		"lint-staged": "^15.2.10",
 		"prettier": "^3.3.3",
 		"ts-node": "^10.9.2",
-		"typescript": "^5.5.4"
+		"typescript": "^5.6.2"
 	},
 	"lint-staged": {
 		"*.ts": "eslint --cache --fix",