@jlceda/pro-api-types 0.2.8 → 0.2.11

package/index.d.ts

@@ -1,3 +1,7 @@
+import * as react from 'react';
+import react__default from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
 /**
  * 文档树项目类型
  *
@@ -1379,7 +1383,7 @@ declare class DMT_Project {
      * 修改工程友好名称
      *
      * @internal
-     * @param projectUuid - 工程 UUID
+     * @param projectUuid - ���程 UUID
      * @param projectFriendlyName - 工程友好名称
      * @returns 是否修改成功
      */
@@ -3360,9 +3364,9 @@ declare class PCB_Document {
      * 本接口在前端画布上定位到指定的区域，区域数据为相对于数据原点的偏移；
      *
      * 例如：传入数据为 `{left: 0, right: 60, top: 100, bottom: -20}` =\> `navigateToRegion(0, 60, 100, -20)`，
-     * 则画布将会定位到以 `[30, 40]` 为中心的，`x` 轴方向长度为 `60`，`y` 轴方向长度为 `120` 的矩形范围；
+     * 则画布将会定位到以 `[30, 40]` ���中心的，`x` 轴方向长度为 `60`，`y` 轴方向长度为 `120` 的矩形范围；
      *
-     * 本��口不进行缩放操作，但会生成指示定位中心及表示区域范围的矩形框；
+     * 本接口不进行缩放操作，但会生成指示定位中心及表示区域范围的矩形框；
      *
      * 此处的单位为数据层面单位，在跨度上等同于画布层面的 mil
      * @param left - 矩形框第一 X 坐标
@@ -3773,9 +3777,15 @@ declare class PCB_Drc {
      * 获取所有差分对的详细属性
      *
      * @beta
+     * @remarks
+     * BREAKING CHANGE since EDA v3.4
+     *
+     * - 返回值类型更改为对象
      * @returns 所有差分对的详细属性
      */
-    getAllDifferentialPairs(): Promise<Array<IPCB_DifferentialPairItem>>;
+    getAllDifferentialPairs(): Promise<Array<IPCB_DifferentialPairItem> | {
+        [key: string]: any;
+    }>;
     /**
      * 创建等长网络组
      *
@@ -4729,7 +4739,7 @@ declare class SYS_FileManager {
      *
      * @beta
      * @remarks
-     * 可以���用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
+     * 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
      *
      * 注意：本接口需要启用 **团队库 \> 下载库** 权限，没有权限调用将始终 `throw Error`
      * @param footprintUuid - 封装 UUID 或封装 UUID 列表
@@ -5098,7 +5108,7 @@ declare class PCB_ManufactureData {
      * @param fileName - 文件名
      * @param unit - 单位
      * @param otherData - 其它
-     * @param layers - 导��层，默认则按照嘉立创生产需求导出
+     * @param layers - 导出层，默认则按照嘉立创生产需求导出
      * @param objects - 导出对象，默认则按照嘉立创生产需求导出
      * @returns ODB++ 文件数据
      */
@@ -5489,7 +5499,7 @@ declare class IPCB_ComplexPolygon {
      * 获取复杂多边形数据
      *
      * @public
-     * @remarks 强制返回复杂多边形格式数据，即使它仅包含单一的单多边形
+     * @remarks 强制返回复杂多边形格式数据��即使它仅包含单一的单多边形
      * @returns 复杂多边形数据
      */
     getSourceStrictComplex(): Array<TPCB_PolygonSourceArray>;
@@ -6051,7 +6061,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
      *
      * @beta
      * @param primitiveIds - 直线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
-     * @returns 直线图元对象，`undefined` 表示获取失败
+     * @returns 直线图元对象，`undefined` 表示获取失���
      */
     get(primitiveIds: string): Promise<IPCB_PrimitiveLine | undefined>;
     /**
@@ -6646,7 +6656,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
      */
     isAsync(): boolean;
     /**
-     * 将异步图元重置为当前画布状态
+     * 将异��图元重置为当前画布状态
      *
      * @beta
      * @returns 圆弧线图元对象
@@ -6656,7 +6666,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
      * 将对图元的更改应用到画布
      *
      * @beta
-     * @returns 圆弧线图元对��
+     * @returns 圆弧线图元对象
      */
     done(): Promise<IPCB_PrimitiveArc>;
     /**
@@ -7232,7 +7242,7 @@ declare class IPCB_PrimitiveAttribute implements IPCB_Primitive {
      * 在 PCB 画布中创建图元
      *
      * @internal
-     * @remarks 属性图���不支持新建，本接口调用将不会有任何效果
+     * @remarks 属性图元不支持新建，本接口调用将不会有任何效果
      * @returns 属性图元对象
      */
     create(): IPCB_PrimitiveAttribute;
@@ -13926,7 +13936,7 @@ declare class ISCH_PrimitivePin implements ISCH_Primitive {
  *
  * @public
  * @remarks
- * 器件��脚图元是一个特殊的图元，它指的是在原理图画布上关联到符号的引脚
+ * 器件引脚图元是一个特殊的图元，它指的是在原理图画布上关联到符号的引脚
  *
  * 器件引脚图元仅可更改 `pinNumber`、`noConnected` 属性，其它所有属性均为只读，
  * 并且你只能通过 {@link SCH_PrimitiveComponent.getAllPinsByPrimitiveId | 器件类的 getAllPinsByPrimitiveId 方法} 或 {@link ISCH_PrimitiveComponent.getAllPins | 器件图元的 getAllPins 方法} 获取到器件引脚图元
@@ -16572,7 +16582,7 @@ declare enum ESCH_SpiceSimulationEnginePushEventType {
  * 原理图 & 符号 / 仿真引擎类
  *
  * @public
- * @remarks 控制仿真引擎的对接和��互
+ * @remarks 控制仿真引擎的对接和交互
  */
 declare class SCH_SimulationEngine {
     /**
@@ -16643,6 +16653,249 @@ declare class SYS_ClientUrl {
     }, succeedCallFn?: (data: Response) => void | Promise<void>): Promise<Response>;
 }
 
+type IconProps = {
+    /** 模板名称 */
+    iconClass: string;
+} | {
+    /** 图标地址 */
+    iconUrl: string;
+} | {};
+
+interface ButtonStoreProps {
+    text?: string;
+    disable?: boolean;
+    type?: 'default' | 'primary' | 'danger' | 'forbidden' | 'text';
+    width?: number | 'responsive';
+    icon?: IconProps;
+}
+type ButtonStoreEvents = {
+    event: 'click';
+};
+
+interface PanelStoreProps {
+    value: string;
+    font?: string;
+    textAlign?: 'left' | 'center' | 'right';
+}
+type PanelStoreEvents = {
+    event: 'change';
+    data: boolean;
+};
+
+interface ContainerStyleProps {
+    backgroundColor?: string;
+    borderWidth?: number;
+    borderColor?: string;
+    hide?: boolean;
+}
+
+interface FlexItemStoreProps extends ContainerStyleProps {
+    flexRatio?: number;
+    width?: number;
+    height?: number;
+}
+type FlexItemStoreEvents = {
+    event: 'change';
+    data: boolean;
+};
+
+interface FlexStoreProps extends ContainerStyleProps {
+    padding?: number;
+    direction?: 'column' | 'column-reverse' | 'row' | 'row-reverse';
+    justify?: 'start' | 'center' | 'end';
+    align?: 'start' | 'center' | 'end' | 'stretch';
+    gap?: number;
+}
+type FlexStoreEvents = {
+    event: 'change';
+    data: boolean;
+};
+
+interface ModalStoreProps {
+    defaultTop: number;
+    defaultLeft: number;
+    defaultWidth: number;
+    defaultHeight: number;
+    maxDragX?: number;
+    maxDragY?: number;
+    hide?: boolean;
+}
+type ModalStoreEvents = {
+    event: 'moved';
+    top: number;
+    left: number;
+};
+
+interface GridSItemtoreProps extends ContainerStyleProps {
+    colSpan?: number;
+    rowSpan?: number;
+    align?: 'start' | 'center' | 'end' | 'stretch';
+}
+type CheckBoxStoreEvents$4 = {
+    event: 'resize';
+};
+
+interface GridStoreProps extends ContainerStyleProps {
+    columns: number;
+    padding?: number;
+    rowGap?: number;
+    colGap?: number;
+}
+type CheckBoxStoreEvents$3 = {
+    event: 'resize';
+};
+
+interface InputProps {
+    width?: number;
+    disabled?: boolean;
+    readonly?: boolean;
+    clearBtn?: boolean | 'keepAlive';
+    clickBtn?: Function;
+    dropDownList?: {
+        title: string;
+        clearBtn: boolean;
+    }[];
+    searchBtn?: boolean;
+    value?: string;
+    placeholder?: string;
+    preText?: string;
+    type: 'text' | 'telephone' | 'number' | 'password' | 'color' | 'email';
+    otherAttr?: {
+        [key: string]: string;
+    };
+    testVal?: string;
+}
+type CheckBoxStoreEvents$2 = {
+    event: 'change';
+    data: string;
+};
+
+interface SingleProps {
+    disabled?: boolean;
+    text: string;
+    value: string;
+    width?: number;
+}
+interface RadioStoreProps {
+    group: SingleProps[];
+    selectedValue?: string;
+    onlyChangeByBox?: boolean;
+    lineBreak?: boolean;
+}
+type CheckBoxStoreEvents$1 = {
+    event: 'change';
+    data: string;
+};
+
+interface TextAreaStoreProps {
+    disabled?: boolean;
+    value?: string;
+    width?: number;
+    height?: number;
+    resizable?: {
+        x?: boolean;
+        y?: boolean;
+    };
+    placeholder?: string;
+    name?: string;
+}
+type TextAreaStoreEvents = {
+    event: 'change';
+    data: string;
+};
+
+interface CheckBoxStoreProps {
+    checked?: boolean;
+    disabled?: boolean;
+    text?: string;
+    name?: string;
+    onlyChangeByBox?: boolean;
+}
+type CheckBoxStoreEvents = {
+    event: 'change';
+    data: boolean;
+};
+
+declare function Dialog({ children }: {
+    children?: react__default.ReactElement | react__default.ReactElement[];
+}): react_jsx_runtime.JSX.Element;
+
+declare abstract class PortalBase {
+    Provider: (props: any) => react_jsx_runtime.JSX.Element;
+    abstract createComponent(handl: string, type: string, props: any, parent: string): void;
+    abstract updateComponent(handl: string, props: any): void;
+    abstract detachComponent(handl: string): void;
+    abstract bindEvent(handl: string, callback: (ev: any) => void): void;
+}
+
+declare const Components: {
+    Dialog: typeof Dialog;
+    CheckBox: (props: CheckBoxStoreProps & {
+        onEvent?: ((ev: CheckBoxStoreEvents) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+    TextArea: (props: TextAreaStoreProps & {
+        onEvent?: ((ev: TextAreaStoreEvents) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+    RadioGroup: (props: RadioStoreProps & {
+        onEvent?: ((ev: CheckBoxStoreEvents$1) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+    Input: (props: InputProps & {
+        onEvent?: ((ev: CheckBoxStoreEvents$2) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+    Grid: (props: GridStoreProps & {
+        onEvent?: ((ev: CheckBoxStoreEvents$3) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+    GridItem: (props: GridSItemtoreProps & {
+        onEvent?: ((ev: CheckBoxStoreEvents$4) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+    Modal: (props: ModalStoreProps & {
+        onEvent?: ((ev: ModalStoreEvents) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+    Flex: (props: FlexStoreProps & {
+        onEvent?: ((ev: FlexStoreEvents) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+    FlexItem: (props: FlexItemStoreProps & {
+        onEvent?: ((ev: FlexItemStoreEvents) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+    Text: (props: PanelStoreProps & {
+        onEvent?: ((ev: PanelStoreEvents) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+    Button: (props: ButtonStoreProps & {
+        onEvent?: ((ev: ButtonStoreEvents) => void) | undefined;
+        children?: react.JSX.Element[] | react.JSX.Element;
+    }) => react.JSX.Element;
+};
+type Components = typeof Components;
+
+/**
+ * WorkerPortal 类，用于在 pro-api 中与 EditorDesignPortal 通信
+ */
+declare class WorkerPortal extends PortalBase {
+    private readonly portal;
+    private readonly compIndex;
+    constructor(container: HTMLElement);
+    createComponent(handle: string, type: string, props: any, parent: string): void;
+    updateComponent(handle: string, props: any): void;
+    detachComponent(handle: string): void;
+    bindEvent(handle: string, callback: (ev: any) => void): void;
+}
+/**
+ * 预制组件节点类型
+ *
+ * @remarks 只能使用 Components 内的预制组件
+ */
+type TComponentsNode = react__default.ReactElement<any, Components[keyof Components]> | Array<TComponentsNode> | null | undefined | boolean | string | number;
+
 /**
  * React 组件化弹出窗口接口
  *
@@ -16650,15 +16903,15 @@ declare class SYS_ClientUrl {
  */
 interface ISYS_ReactComponentizationDialogInterface {
     /** 预制组件 */
-    Components: any;
+    Components: Components;
     /** Portal 实例 */
-    portal: any;
+    portal: WorkerPortal;
     /**
      * 渲染 React 组件
      *
-     * @param node - React 节点
+     * @param node - Components 内的预制组件
      */
-    render: (node: any) => void;
+    render: (node: TComponentsNode) => void;
 }
 /**
  * 系统 / 对话框类
@@ -17002,7 +17255,7 @@ declare class SYS_FileSystem {
      * @remarks
      * 注意 1：本接口仅客户端有效，在浏览器环境内调用将始终 `throw Error`
      *
-     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未���用将始终 `throw Error`
+     * 注意 2：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 `throw Error`
      * @param uri - 文件资源定位符
      *
      * 如若结尾为斜杠 `/`（Windows 为反斜杠 `\`），则识别为文件夹；
@@ -18319,7 +18572,7 @@ declare class SYS_ShortcutKey {
      * 注册快捷键
      *
      * @beta
-     * @param shortcutKey - 快捷键，数组中包含多个元素则解析为组合快捷键，将按规则排序后存入缓存
+     * @param shortcutKey - 快捷键，数组中包含多个元素则���析为组合快捷键，将按规则排序后存入缓存
      * @param title - 快捷键标题，快捷键的友好名称
      * @param callbackFn - 回调函数
      * @returns 注册操作是否成功

package/package.json

@@ -1 +1 @@
-{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.8", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }
+{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.11", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }