@jlceda/pro-api-types 0.1.77 → 0.1.79

package/index.d.ts

@@ -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;
@@ -780,6 +781,7 @@ declare class EDA {
     sys_MessageBox: SYS_MessageBox;
     sys_PanelControl: SYS_PanelControl;
     sys_ShortcutKey: SYS_ShortcutKey;
+    sys_Storage: SYS_Storage;
     sys_Timer: SYS_Timer;
     sys_ToastMessage: SYS_ToastMessage;
     sys_Unit: SYS_Unit;
@@ -2713,7 +2715,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
     create(): Promise<IPCB_PrimitiveImage>;
     /** @alpha 定义 getState_* 函数 × 11 */
     /**
-     * 获取对象的图元 ID
+     * 获取对象���图元 ID
      *
      * @returns
      */
@@ -3691,9 +3693,9 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
     private uniqueId?;
     /** Component 属性：制造商 */
     private manufacturer?;
-    /** Component 属性：制造商编号 */
+    /** Component 属性���制造商编号 */
     private manufacturerId?;
-    /** Component ���性：供应商 */
+    /** Component 属性：供应商 */
     private supplier?;
     /** Component 属性：供应商编号 */
     private supplierId?;
@@ -3960,7 +3962,7 @@ declare class ISCH_PrimitiveRectangle implements ISCH_Primitive {
     private height;
     /** 圆角半径 */
     private cornerRadius;
-    /** 旋��角度 */
+    /** 旋转角度 */
     private rotation;
     /** 边框颜色 */
     private color;
@@ -4620,7 +4622,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
@@ -5113,7 +5115,7 @@ declare class PCB_Drc {
      * @param ruleConfiguration - 设计规则配置
      * @param configurationName - 配置名称
      * @param allowOverwrite - 是否允许覆写同名设计规则配置，`false` 则将在遇到同名设计规则配置时返回 `false`，请注意可能的数据丢失风险
-     * @returns 保���是否成功
+     * @returns 保存是否成功
      */
     saveRuleConfiguration(ruleConfiguration: {
         [key: string]: any;
@@ -5585,7 +5587,7 @@ declare class PCB_Layer {
  * PCB & 封装 / 生产资料类
  *
  * @public
- * @remarks 获取当前 PCB 的生产资料文件
+ * @remarks 获取当前 PCB 的生产资料文件及快捷下单
  */
 declare class PCB_ManufactureData {
     /**
@@ -5737,6 +5739,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 */
 }
 
 /**
@@ -6102,7 +6108,7 @@ declare class PCB_PrimitiveDimension implements IPCB_PrimitiveAPI {
      * @param lineWidth - 线宽
      * @param precision - 精度，取值范围 `0`-`4`
      * @param primitiveLock - 是否锁定
-     * @returns 尺寸标注图元对象
+     * @returns 尺寸标注图��对象
      */
     modify(primitiveId: string | IPCB_PrimitiveDimension, property: {
         dimensionType?: EPCB_PrimitiveDimensionType;
@@ -6744,7 +6750,7 @@ declare class SCH_Event {
  * 原理图 & 符号 / 生产资料类
  *
  * @public
- * @remarks 获取当前原理图图页的生产资料文件
+ * @remarks 获取当前原理图图页的生产资料文件及快捷下单
  */
 declare class SCH_ManufactureData {
     /**
@@ -6767,6 +6773,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 */
 }
 
 /**
@@ -7439,7 +7447,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 +7712,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;
+}
+
 /**
  * 系统 / 文件管理类
  *
@@ -7776,16 +7849,7 @@ declare class SYS_FileManager {
      * @returns 器件文件数据，`undefined` 表示数据获取失败
      */
     getDeviceFileByDeviceUuid(deviceUuid: string | Array<string>, libraryUuid?: string): Promise<File | undefined>;
-    /**
-     * 使用符号 UUID 获取符号文件
-     *
-     * @beta
-     * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
-     * @param symbolUuid - 符号 UUID 或符号 UUID 列表
-     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
-     * @returns 符号文件数据，`undefined` 表示数据获取失败
-     */
-    getSymbolFileBySymbolUuid(symbolUuid: string | Array<string>, libraryUuid?: string): Promise<File | undefined>;
+    /* Excluded from this release type: getSymbolFileBySymbolUuid */
     /**
      * 使用封装 UUID 获取封装文件
      *
@@ -7909,6 +7973,7 @@ declare class SYS_I18n {
      * 刷新当前语言环境
      *
      * @public
+     * @remarks 使扩展内部语言环境与 EDA 当前语言环境同步
      */
     flushCurrentLanguage(): Promise<void>;
     /**
@@ -7930,8 +7995,10 @@ declare class SYS_I18n {
      * 导入多语言
      *
      * @public
+     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param language - 语言
      * @param source - 欲导入的多语言数据对象
+     * @returns 导入是否成功
      */
     importMultilingual(language: string, source: ISYS_LanguageKeyValuePairs): boolean;
     /**
@@ -7941,6 +8008,7 @@ declare class SYS_I18n {
      * @param namespace - 命名空间
      * @param language - 语言
      * @param source - 欲导入的多语言数据对象
+     * @returns 导入是否成功
      */
     importMultilingualLanguage(namespace: string, language: string, source: ISYS_LanguageKeyValuePairs): boolean;
     /**
@@ -7949,6 +8017,7 @@ declare class SYS_I18n {
      * @public
      * @param namespace - 命名空间
      * @param source - 欲导入的多语言数据对象
+     * @returns 导入是否成功
      */
     importMultilingualNamespace(namespace: string, source: ISYS_MultilingualLanguagesData): boolean;
 }
@@ -8221,6 +8290,84 @@ declare class SYS_ShortcutKey {
     }>>;
 }
 
+/**
+ * 系统 / 存储类
+ *
+ * @public
+ * @remarks 可以进行扩展的用户配置存储、浏览器本地存储的操作接口
+ */
+declare class SYS_Storage {
+    /** 扩展 UUID */
+    private extensionUuid?;
+    /* Excluded from this release type: __constructor */
+    /**
+     * 获取扩展所有用户配置
+     *
+     * @public
+     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+     * @returns 扩展所有用户配置信息
+     */
+    getExtensionAllUserConfigs(): {
+        [key: string]: any;
+    };
+    /**
+     * 设置扩展所有用户配置
+     *
+     * @public
+     * @remarks
+     * 此举会覆盖当前扩展的所有用户配置信息，请谨慎操作
+     *
+     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+     * @param configs - 扩展所有用户配置
+     * @returns 操作是否成功
+     */
+    setExtensionAllUserConfigs(configs: {
+        [key: string]: any;
+    }): Promise<boolean>;
+    /**
+     * 清除扩展所有用户配置
+     *
+     * @public
+     * @remarks
+     * 此举会删除当前扩展的所有用户配置信息，请谨慎操作
+     *
+     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+     * @returns 操作是否成功
+     */
+    clearExtensionAllUserConfigs(): Promise<boolean>;
+    /**
+     * 获取扩展用户配置
+     *
+     * @public
+     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+     * @param key - 配置项
+     * @returns 配置项对应的值，不存在将返回 `undefined`
+     */
+    getExtensionUserConfig(key: string): any | undefined;
+    /**
+     * 设置扩展用户配置
+     *
+     * @public
+     * @remarks
+     * 新建扩展用户配置也使用本接口，在设置时如果不存在将会自动新建
+     *
+     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+     * @param key - 配置项
+     * @param value - 值
+     * @returns 操作是否成功
+     */
+    setExtensionUserConfig(key: string, value: any): Promise<boolean>;
+    /**
+     * 删除扩展用户配置
+     *
+     * @public
+     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+     * @param key - 配置项
+     * @returns 操作是否成功
+     */
+    deleteExtensionUserConfig(key: string): Promise<boolean>;
+}
+
 /**
  * 系统 / 定时器类
  *
@@ -8605,7 +8752,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.77",
+	"version": "0.1.79",
 	"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
 	"typings": "index.d.ts",
 	"keywords": [