@jlceda/pro-api-types 0.1.90 → 0.1.92

package/index.d.ts

@@ -413,7 +413,7 @@ declare class DMT_Project {
      * @beta
      * @param projectFriendlyName - 工程友好名称
      * @param projectName - 工程名称，仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`，如若不指定，则根据工程友好名称自动生成
-     * @param teamUuid - 团队 UUID，如若不指定，则默认为个人；在不存在个人工程的环境下必须指定团队 UUID
+     * @param teamUuid - 团队 UUID，如若不指定，则默认为个人；在不存在个人工程的环境下必须指定��队 UUID
      * @param folderUuid - 文件夹 UUID，如若不指定，则为根文件夹
      * @param description - 工程描述
      * @param collaborationMode - 工程协作模式，如若团队权限无需工程设置协作模式，则该参数将被忽略
@@ -754,6 +754,9 @@ declare class EDA {
     pcb_PrimitiveRegion: PCB_PrimitiveRegion;
     pcb_PrimitiveVia: PCB_PrimitiveVia;
     pcb_SelectControl: PCB_SelectControl;
+    EPCB_LayerId: {
+        [key: string]: number;
+    };
     pnl_Document: PNL_Document;
     sch_Document: SCH_Document;
     sch_Drc: SCH_Drc;
@@ -773,6 +776,7 @@ declare class EDA {
     sch_SelectControl: SCH_SelectControl;
     sch_Utils: SCH_Utils;
     sys_ClientUrl: SYS_ClientUrl;
+    sys_Dialog: SYS_Dialog;
     sys_Environment: SYS_Environment;
     sys_FileManager: SYS_FileManager;
     sys_FileSystem: SYS_FileSystem;
@@ -1187,7 +1191,7 @@ declare enum EPCB_LayerId {
     SHELL_3D_TOP = 54,
     /** 3D 外壳底层 */
     SHELL_3D_BOTTOM = 55,
-    /** 钻��图层 */
+    /** 钻孔图层 */
     DRILL_DRAWING = 56
 }
 
@@ -2043,36 +2047,12 @@ declare interface ILIB_DeviceAssociationItem {
     footprintUuid?: string;
 }
 
-/**
- * 器件属性
- *
- * @public
- */
-declare interface ILIB_DeviceItem {
-    /** 库类型 */
-    readonly libraryType: ELIB_LibraryType.DEVICE;
-    /** 器件 UUID */
-    uuid: string;
-    /** 所属库 UUID */
-    libraryUuid: string;
-    /** 器件名称 */
-    name: string;
-    /** 器件分类 */
-    classification?: ILIB_ClassificationIndex;
-    /** 关联 */
-    association: ILIB_DeviceAssociationItem;
-    /** 描述 */
-    description?: string;
-    /** 扩展属性 */
-    property: ILIB_DevicePropertyItem;
-}
-
 /**
  * 器件扩展属性
  *
  * @public
  */
-declare interface ILIB_DevicePropertyItem {
+declare interface ILIB_DeviceExtendPropertyItem {
     /** 名称 */
     name?: string;
     /** 位号 */
@@ -2095,6 +2075,30 @@ declare interface ILIB_DevicePropertyItem {
     [key: string]: boolean | number | string | undefined;
 }
 
+/**
+ * 器件属性
+ *
+ * @public
+ */
+declare interface ILIB_DeviceItem {
+    /** 库类型 */
+    readonly libraryType: ELIB_LibraryType.DEVICE;
+    /** 器件 UUID */
+    uuid: string;
+    /** 所属库 UUID */
+    libraryUuid: string;
+    /** 器件名称 */
+    name: string;
+    /** 器件分类 */
+    classification?: ILIB_ClassificationIndex;
+    /** 关联 */
+    association: ILIB_DeviceAssociationItem;
+    /** 描述 */
+    description?: string;
+    /** 扩展属性 */
+    property: ILIB_DeviceExtendPropertyItem;
+}
+
 /**
  * 搜索到的器件属性
  *
@@ -2600,11 +2604,11 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
      *
      * @beta
      * @param layer - 层
-     * @returns 圆弧线图元对象
+     * @returns 圆弧线图��对象
      */
     setState_Layer(layer: TPCB_LayersOfLine): IPCB_PrimitiveArc;
     /**
-     * ��置属性状态：起始位置 X
+     * 设置属性状态：起始位置 X
      *
      * @beta
      * @param startX - 起始位置 X
@@ -3235,7 +3239,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
      * 获取属性状态：图像源数据（复杂多边形）
      *
      * @public
-     * @returns ���像源数据（复杂多边形）
+     * @returns 图像源数据（复杂多边形）
      */
     getState_ComplexPolygon(): TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray>;
     /**
@@ -3404,7 +3408,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
     private startY;
     /** 终止位置 X */
     private endX;
-    /** 终止��置 Y */
+    /** 终止位置 Y */
     private endY;
     /** 线宽 */
     private lineWidth;
@@ -3866,7 +3870,7 @@ declare class IPCB_PrimitivePad implements IPCB_Primitive {
      */
     setState_HoleOffsetX(holeOffsetX: number): IPCB_PrimitivePad;
     /**
-     * 设置属性状态：孔偏移 Y
+     * 设置属性状态：孔偏��� Y
      *
      * @beta
      * @remarks 如若孔不存在，则属性将不会被修改
@@ -4481,7 +4485,7 @@ declare class IPCB_PrimitiveRegion implements IPCB_Primitive {
      */
     setState_LineWidth(lineWidth: number): IPCB_PrimitiveRegion;
     /**
-     * 设��属性状态：是否锁定
+     * 设置属性状态：是否锁定
      *
      * @beta
      * @param primitiveLock - 是否锁定
@@ -5057,7 +5061,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
     private readonly primitiveType;
     /** 器件类型 */
     private componentType;
-    /** 图元 ID */
+    /** ���元 ID */
     private primitiveId?;
     /** 关联库器件 */
     private component;
@@ -5848,6 +5852,24 @@ declare class ISCH_PrimitiveWire implements ISCH_Primitive {
     done(): ISCH_PrimitiveWire;
 }
 
+/**
+ * 文件系统文件路径
+ *
+ * @public
+ */
+declare interface ISYS_FileSystemFileList {
+    /** 文件名（前后均无斜杠） */
+    fileName: string;
+    /** 是否为目录 */
+    isDirectory: boolean;
+    /** 目录子文件 */
+    subFiles?: Array<ISYS_FileSystemFileList>;
+    /** 相对路径，不包含前面的传入路径和文件名（当没有传入路径时，不存在相对路径），且前后均无斜杠 */
+    relativePath?: string;
+    /** 完整路径，包含文件名的绝对路径 */
+    fullPath: string;
+}
+
 /**
  * 语言数据键值对
  *
@@ -6187,7 +6209,7 @@ declare class LIB_Device {
         symbolType?: ELIB_SymbolType;
         symbolUuid?: string;
         footprintUuid?: string;
-    }, description?: string, property?: ILIB_DevicePropertyItem): Promise<string | undefined>;
+    }, description?: string, property?: ILIB_DeviceExtendPropertyItem): Promise<string | undefined>;
     /**
      * 删除器件
      *
@@ -6709,7 +6731,7 @@ declare class PCB_Document {
      * 建议调用本方法并设置偏移量为零，
      * 即 `setCanvasOrigin(0, 0)`；
      *
-     * 此处的单位为数据层面单位，在跨度上等��于画布层面的 mil
+     * 此处的单位为数据层面单位，在跨度上等同于画布层面的 mil
      * @param offsetX - 画布原点相对于数据原点的 X 坐标偏移
      * @param offsetY - 画布原点相对于数据原点的 Y 坐标偏移
      * @returns 操作是否成功
@@ -7879,7 +7901,7 @@ declare class PCB_PrimitiveFill implements IPCB_PrimitiveAPI {
 }
 
 /**
- * PCB & 封装 / 图像图元类
+ * PCB & 封装 / 图像��元类
  *
  * @public
  */
@@ -8435,7 +8457,7 @@ declare class SCH_Document {
      * 保存文档
      *
      * @public
-     * @returns 保存操作是否成功，保存失败、上传��败等错误均返回 `false`
+     * @returns 保存操作是否成功，保存失败、上传失败等错误均返回 `false`
      */
     save(): Promise<boolean>;
 }
@@ -8540,7 +8562,7 @@ declare class SCH_ManufactureData {
      */
     placeComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
     /**
-     * SMT ��件下单
+     * SMT 元件下单
      *
      * @beta
      * @param interactive - 是否启用交互式检查
@@ -9019,7 +9041,7 @@ declare class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI {
      *
      * @beta
      * @param primitiveIds - 器件的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
-     * @returns 器��图元对象，`undefined` 表示获取失败
+     * @returns 器件图元对象，`undefined` 表示获取失败
      */
     get(primitiveIds: string): Promise<ISCH_PrimitiveComponent | undefined>;
     /**
@@ -9113,7 +9135,7 @@ declare class SCH_PrimitivePin implements ISCH_PrimitiveAPI {
      * 获取所有引脚的图元 ID
      *
      * @beta
-     * @remarks 当��于符号编辑器时，componentPrimitiveId 应始终为 undefined
+     * @remarks 当处于符号编辑器时，componentPrimitiveId 应始终为 undefined
      * @returns 引脚的图元 ID 数组
      */
     getAllPrimitiveId(componentPrimitiveId?: string | ISCH_PrimitiveComponent): Promise<Array<string>>;
@@ -9207,7 +9229,7 @@ declare class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI {
      * @param height - 高
      * @param cornerRadius - 圆角半径
      * @param rotation - 旋转角度，绕左上点旋转，可选 `0` `90` `180` `270`
-     * @param color - 颜色，`null` ���示默认
+     * @param color - 颜色，`null` 表示默认
      * @param fillColor - 填充颜色，`none` 表示无填充，`null` 表示默认
      * @param lineWidth - 线宽，范围 `1-10`，`null` 表示默认
      * @param lineType - 线型，`0` 实线，`1` 短划线，`2` 点线，`3` 点划线，`null` 表示默认
@@ -9513,6 +9535,40 @@ declare class SYS_ClientUrl {
     }, succeedCallFn?: (data: Response) => void | Promise<void>): Promise<Response>;
 }
 
+/**
+ * 系统 / 对话框类
+ *
+ * @public
+ * @remarks 生成对话框窗口
+ */
+declare class SYS_Dialog {
+    /**
+     * 弹出消息窗口
+     *
+     * @public
+     * @remarks 显示一个文字消息窗口
+     * @param content - 消息文本，支持使用 `\n` 换行
+     * @param title - 弹出窗口标题
+     * @param buttonTitle - 按钮标题，为空则不显示按钮
+     */
+    showInformationMessage(content: string, title?: string, buttonTitle?: string): void;
+    /**
+     * 弹出确认窗口
+     *
+     * @public
+     * @remarks 显示一个拥有确认和取消按钮的窗口
+     * @param content - 消息文本，支持使用 `\n` 换行
+     * @param title - 弹出窗口标题
+     * @param mainButtonTitle - 主要按钮标题
+     * @param buttonTitle - 主要按钮标题
+     * @param callbackFn - 回调函数，如需调用扩展内的函数，请在函数名前加上扩展的唯一 ID，以西文句号 `.` 分隔
+     */
+    showConfirmationMessage(content: string, title?: string, mainButtonTitle?: string, buttonTitle?: string, callbackFn?: (mainButtonClicked: boolean) => void): void;
+    /* Excluded from this release type: showInputDialog */
+    /* Excluded from this release type: showSelectDialog */
+    /* Excluded from this release type: showSelectDialog */
+}
+
 /**
  * 系统 / 运行环境类
  *
@@ -9686,7 +9742,7 @@ declare class SYS_FileSystem {
     private allowExternalInteractions?;
     /* Excluded from this release type: __constructor */
     /**
-     * 打开读入文��窗口
+     * 打开读入文件窗口
      *
      * @beta
      * @param filenameExtensions - 文件扩展名
@@ -9704,6 +9760,12 @@ declare class SYS_FileSystem {
     saveFile(fileData: File | Blob, fileName?: string): Promise<void>;
     /* Excluded from this release type: readFileFromFileSystem */
     /* Excluded from this release type: saveFileToFileSystem */
+    /* Excluded from this release type: listFilesOfFileSystem */
+    /* Excluded from this release type: deleteFileInFileSystem */
+    /* Excluded from this release type: getEdaPath */
+    /* Excluded from this release type: getDocumentsPath */
+    /* Excluded from this release type: getLibrariesPaths */
+    /* Excluded from this release type: getProjectsPaths */
 }
 
 /**
@@ -9931,6 +9993,7 @@ declare class SYS_Log {
  * 系统 / 消息框类
  *
  * @public
+ * @deprecated 已更名为 {@link SYS_Dialog}
  * @remarks 生成消息提示框
  */
 declare class SYS_MessageBox {
@@ -9938,6 +10001,7 @@ declare class SYS_MessageBox {
      * 显示消息框
      *
      * @public
+     * @deprecated 请使用 {@link SYS_Dialog.showInformationMessage} 替代
      * @remarks 显示一个文字消息提示框
      * @param content - 消息文本，支持使用 `\n` 换行
      * @param title - 消息框标题
@@ -9948,12 +10012,13 @@ declare class SYS_MessageBox {
      * 显示确认框
      *
      * @public
+     * @deprecated 请使用 {@link SYS_Dialog.showConfirmationMessage} 替代
      * @remarks 显示一个拥有确认和取消按钮的确认框
      * @param content - 消息文本，支持使用 `\n` 换行
      * @param title - 确认框标题
      * @param mainButtonTitle - 主要按钮标题
      * @param buttonTitle - 主要按钮标题
-     * @param callbackFn - 回调函数，如需调用插件内的函数，请在函数名前加上插件的唯一 ID，以西文句号 `.` 分隔
+     * @param callbackFn - 回调函数，如需调用扩展内的函数，请在函数名前加上扩展的唯一 ID，以西文句号 `.` 分隔
      */
     showConfirmationMessage(content: string, title?: string, mainButtonTitle?: string, buttonTitle?: string, callbackFn?: (mainButtonClicked: boolean) => void): void;
 }
@@ -10061,7 +10126,7 @@ declare class SYS_ShortcutKey {
      * @param shortcutKey - 快捷键，数组中包含多个元素则解析为组合快捷键，将按规则排序后存入缓存
      * @param title - 快捷键标题，快捷键的友好名称
      * @param callbackFn - 回调函数
-     * @returns 注册操作���否成功
+     * @returns 注册操作是否成功
      */
     registerShortcutKey(shortcutKey: TShortcutKeys, title: string, callbackFn: (shortcutKey: TShortcutKeys) => void | Promise<void>, documentType: Array<ESYS_ShortcutKeyEffectiveEditorDocumentType> | undefined, scene: Array<ESYS_ShortcutKeyEffectiveEditorScene> | undefined, hotkeyCmd: string): Promise<boolean>;
     /**

package/package.json

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