@jlceda/pro-api-types 0.1.75 → 0.1.77

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

@@ -784,6 +784,7 @@ declare class EDA {
     sys_ToastMessage: SYS_ToastMessage;
     sys_Unit: SYS_Unit;
     sys_WebSocket: SYS_WebSocket;
+    sys_Window: SYS_Window;
     /* Excluded from this release type: extensionUuid */
     /* Excluded from this release type: allowExternalInteractions */
     /* Excluded from this release type: __constructor */
@@ -1550,6 +1551,30 @@ declare enum ESYS_Unit {
     MIL = "mil"
 }
 
+/**
+ * 窗口事件类型
+ *
+ * @public
+ */
+declare enum ESYS_WindowEventType {
+    /** 失去焦点 */
+    BLUR = "blur",
+    /** 获取焦点 */
+    FOCUS = "focus"
+}
+
+/**
+ * 打开窗口上下文目标
+ *
+ * @public
+ */
+declare enum ESYS_WindowOpenTarget {
+    /** 新标签页 */
+    BLANK = "_blank",
+    /** 当前页 */
+    SELF = "_self"
+}
+
 /**
  * 板子属性
  *
@@ -2554,7 +2579,7 @@ declare class IPCB_PrimitiveDimension implements IPCB_Primitive {
      * @returns
      */
     getState_PrimitiveId(): string;
-    /** @alpha 所有的 setState_* 方法都需要对��据进行基本的格式校验 */
+    /** @alpha 所有的 setState_* 方法都需要对数据进行基本的格式校验 */
     /**
      * 设置属性状态：尺寸标注类型
      *
@@ -2997,7 +3022,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      * @remarks
      * 设置焊盘外形时将会联动设置部分其它属性状态：
      *
-     * 1. 特殊焊盘外形属性将被清���
+     * 1. 特殊焊盘外形属性将被清空
      *
      * @param pad - 焊盘外形
      * @returns 焊盘图元对象
@@ -3668,7 +3693,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
     private manufacturer?;
     /** Component 属性：制造商编号 */
     private manufacturerId?;
-    /** Component 属性：供应商 */
+    /** Component ���性：供应商 */
     private supplier?;
     /** Component 属性：供应商编号 */
     private supplierId?;
@@ -3935,7 +3960,7 @@ declare class ISCH_PrimitiveRectangle implements ISCH_Primitive {
     private height;
     /** 圆角半径 */
     private cornerRadius;
-    /** 旋转角度 */
+    /** 旋��角度 */
     private rotation;
     /** 边框颜色 */
     private color;
@@ -4201,6 +4226,20 @@ declare interface ISYS_MultilingualLanguagesData {
     [language: string]: ISYS_LanguageKeyValuePairs;
 }
 
+/**
+ * 窗口事件监听可移除对象
+ *
+ * @public
+ * @remarks 本对象从 {@link addEventListener} 获取，并可用于移除创建的事件监听，仅需将其传入 {@link removeEventListener}
+ */
+declare interface ISYS_WindowEventListenerRemovableObject {
+    type: ESYS_WindowEventType;
+    listener: (ev: any) => any;
+    options?: {
+        capture?: boolean;
+    };
+}
+
 /**
  * 综合库 / 3D 模型类
  *
@@ -4581,7 +4620,7 @@ declare class LIB_Device {
      */
     getByLcscIds<T extends boolean>(lcscIds: string, libraryUuid?: string, allowMultiMatch?: T): Promise<T extends true ? ILIB_DeviceSearchItem | undefined : Array<ILIB_DeviceSearchItem>>;
     /**
-     * 使用立创 C 编号批量获取器件
+     * ���用立创 C 编号批量获取器件
      *
      * @beta
      * @remarks
@@ -4989,7 +5028,7 @@ declare class PCB_Document {
      * 嘉立创 EDA 专业版 API 使用的均为数据原点；
      *
      * 如果希望在 API 操作时前端画布坐标能与数据一致，
-     * 建议调用本方法并设置偏移量���零，
+     * 建议调用本方法并设置偏移量为零，
      * 即 `setCanvasOrigin(0, 0)`；
      *
      * 此处的单位为数据层面单位，在跨度上等同于画布层面的 mil
@@ -5074,7 +5113,7 @@ declare class PCB_Drc {
      * @param ruleConfiguration - 设计规则配置
      * @param configurationName - 配置名称
      * @param allowOverwrite - 是否允许覆写同名设计规则配置，`false` 则将在遇到同名设计规则配置时返回 `false`，请注意可能的数据丢失风险
-     * @returns 保存是否成功
+     * @returns 保���是否成功
      */
     saveRuleConfiguration(ruleConfiguration: {
         [key: string]: any;
@@ -7142,7 +7181,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      * @param primitiveId - 图元 ID
      * @param x - 坐标 X
      * @param y - 坐标 Y
-     * @param rotation - 旋转角度，可��� `0` `90` `180` `270`
+     * @param rotation - 旋转角度，可选 `0` `90` `180` `270`
      * @param mirror - 是否镜像
      * @param libraryPath - 库路径，默认为系统库
      * @param addIntoBom - 是否加入 BOM
@@ -7326,7 +7365,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
      * 获取多边形
      *
      * @beta
-     * @param primitiveIds - 多边形的图元 ID，可以为字符串或��符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 多边形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 多边形图元对象
      */
     get(primitiveIds: string): Promise<ISCH_PrimitivePolygon | undefined>;
@@ -7400,7 +7439,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
      * 获取矩形
      *
      * @public
-     * @param primitiveIds - 矩形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 矩形的��元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 矩形图元对象
      */
     get(primitiveIds: string): Promise<ISCH_PrimitiveRectangle | undefined>;
@@ -7514,7 +7553,7 @@ declare class SCH_PrimitiveWire implements ISCH_PrimitiveAPI {
      * 3. 有多个坐标点在多个不同网络的图元上，则创建失败
      *
      * 如若已指定，则遵循：
-     * 1. 有一个或多个坐���点在其他网络的图元上，且其他图元并未显式（通常指的是包含网络标签或网络端口）指定网络，则其他图元跟随指定的网络；
+     * 1. 有一个或多个坐标点在其他网络的图元上，且其他图元并未显式（通常指的是包含网络标签或网络端口）指定网络，则其他图元跟随指定的网络；
      * 2. 如若其他图元指定了网络，则创建失败
      * @param color - 导线颜色，`null` 表示默认
      * @param lineWidth - 线宽，范围 `1-10`，`null` 表示默认
@@ -8196,13 +8235,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;
     /**
      * 清除指定循环定时器
      *
@@ -8215,12 +8255,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;
 }
 
 /**
@@ -8358,6 +8408,45 @@ declare class SYS_WebSocket {
     close(id: string, code?: number, reason?: string, extensionUuid?: string): void;
 }
 
+/**
+ * 系统 / 窗口类
+ *
+ * @public
+ * @remarks 为了保证安全性，仅提供有限的窗口跳转与监听支持，更多操作请使用内联框架窗口 {@link SYS_IFrame}
+ */
+declare class SYS_Window {
+    /**
+     * 打开资源窗口
+     *
+     * @beta
+     * @param url - 欲加载资源的 URL 或路径
+     * @param target - 上下文目标
+     */
+    open(url: string, target?: ESYS_WindowOpenTarget): void;
+    /**
+     * 新增事件监听
+     *
+     * @beta
+     * @param type - 事件类型，当前支持 `blur` `focus`
+     * @param listener - 事件监听回调
+     * @param options - 可选参数
+     * @returns 事件监听方法，用于移除事件监听，如若为 `undefined` 则表示创建事件监听失败
+     */
+    addEventListener(type: ESYS_WindowEventType, listener: (ev: any) => any, options?: {
+        capture?: boolean;
+        once?: boolean;
+        passive?: boolean;
+        signal?: AbortSignal;
+    }): ISYS_WindowEventListenerRemovableObject | undefined;
+    /**
+     * 移除事件监听
+     *
+     * @beta
+     * @param removableObject - 窗口事件监听可移除对象
+     */
+    removeEventListener(removableObject: ISYS_WindowEventListenerRemovableObject): void;
+}
+
 /**
  * 可选中图层
  *
@@ -8516,7 +8605,7 @@ declare type TPCB_PolygonSourceArray = Array<'L' | 'ARC' | 'CARC' | 'C' | 'R' |
  * @remarks
  * 尺寸标注坐标集存在以下三种 {@link EPCB_PrimitiveDimensionType | 尺寸标注类型}：
  *
- * ① 半径标注
+ * ① 半���标注
  *
  * `[x1, y1, x2, y2, x3, y3]`
  *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@jlceda/pro-api-types",
-	"version": "0.1.75",
+	"version": "0.1.77",
 	"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",