@jlceda/pro-api-types 0.1.78 → 0.1.79

package/index.d.ts

@@ -781,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;
@@ -2714,7 +2715,7 @@ declare class IPCB_PrimitiveImage implements IPCB_Primitive {
     create(): Promise<IPCB_PrimitiveImage>;
     /** @alpha 定义 getState_* 函数 × 11 */
     /**
-     * 获取对象的图元 ID
+     * 获取对象���图元 ID
      *
      * @returns
      */
@@ -3692,7 +3693,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
     private uniqueId?;
     /** Component 属性：制造商 */
     private manufacturer?;
-    /** Component 属性：制造商编号 */
+    /** Component 属性���制造商编号 */
     private manufacturerId?;
     /** Component 属性：供应商 */
     private supplier?;
@@ -5683,7 +5684,7 @@ declare class PCB_ManufactureData {
      */
     getNetlistFile(fileName?: string, netlistType?: ENetlistType): Promise<File | undefined>;
     /**
-     * 获取 DXF ���件
+     * 获取 DXF 文件
      *
      * @beta
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
@@ -6107,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;
@@ -7719,7 +7720,7 @@ declare class SYS_ClientUrl {
  */
 declare class SYS_Environment {
     /**
-     * 是否处于浏览器环境
+     * 是否处���浏览器环境
      *
      * @public
      * @returns 是否处于浏览器环境
@@ -7848,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 获取封装文件
      *
@@ -7981,6 +7973,7 @@ declare class SYS_I18n {
      * 刷新当前语言环境
      *
      * @public
+     * @remarks 使扩展内部语言环境与 EDA 当前语言环境同步
      */
     flushCurrentLanguage(): Promise<void>;
     /**
@@ -8002,8 +7995,10 @@ declare class SYS_I18n {
      * 导入多语言
      *
      * @public
+     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
      * @param language - 语言
      * @param source - 欲导入的多语言数据对象
+     * @returns 导入是否成功
      */
     importMultilingual(language: string, source: ISYS_LanguageKeyValuePairs): boolean;
     /**
@@ -8013,6 +8008,7 @@ declare class SYS_I18n {
      * @param namespace - 命名空间
      * @param language - 语言
      * @param source - 欲导入的多语言数据对象
+     * @returns 导入是否成功
      */
     importMultilingualLanguage(namespace: string, language: string, source: ISYS_LanguageKeyValuePairs): boolean;
     /**
@@ -8021,6 +8017,7 @@ declare class SYS_I18n {
      * @public
      * @param namespace - 命名空间
      * @param source - 欲导入的多语言数据对象
+     * @returns 导入是否成功
      */
     importMultilingualNamespace(namespace: string, source: ISYS_MultilingualLanguagesData): boolean;
 }
@@ -8174,7 +8171,7 @@ declare class SYS_PanelControl {
      * 打开左侧面板
      *
      * @public
-     * @param tab - 标签页，���若不指定则不切换标签页
+     * @param tab - 标签页，如若不指定则不切换标签页
      */
     openLeftPanel(tab?: ESYS_LeftPanelTab): void;
     /**
@@ -8293,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>;
+}
+
 /**
  * 系统 / 定时器类
  *
@@ -8596,7 +8671,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.78",
+	"version": "0.1.79",
 	"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
 	"typings": "index.d.ts",
 	"keywords": [