ice-entity-designer 0.0.18 → 0.0.19

package/dist/types/flow/FlowDesigner.d.mts

@@ -0,0 +1,104 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import type { ICE } from '../ice-render/index.mjs';
+import type { FlowNodeKind } from './FlowNode.mjs';
+import type { FlowEdgeSnapshot } from './FlowEdge.mjs';
+import type { FlowNodeSnapshot } from './FlowNode.mjs';
+/** 流程图快照：只含流程图自身的语义数据，跨版本可读 */
+export declare type FlowSnapshot = {
+    version: number;
+    kind: 'flowchart';
+    nodes: FlowNodeSnapshot[];
+    edges: FlowEdgeSnapshot[];
+};
+/** load() 的载入报告 */
+export declare type FlowLoadReport = {
+    /** 是否真的发生了一次载入（空值 / 非流程图快照为 false） */
+    loaded: boolean;
+    nodes: number;
+    edges: number;
+    /** 因 typeId 不匹配被跳过的节点/连线 */
+    skipped: string[];
+};
+export declare type FlowSnapshotValidationResult = {
+    valid: boolean;
+    errors: string[];
+};
+/**
+ * 校验流程图快照结构。
+ *
+ * 契约与 IED 的项目快照一致：**serialize() 的产物必须永远能通过本校验**，
+ * 因此只校验加载器需要的结构，可选值（颜色 / 尺寸 / 端口）缺省即合法。
+ */
+export declare function validateFlowSnapshot(data: any): FlowSnapshotValidationResult;
+/**
+ * @class FlowDesigner 流程图应用层
+ *
+ * 与 EntityDesigner 同构：在通用图元之上把「建节点 / 连线 / 选中 / 增删改 /
+ * 撤销重做 / 快照存取」串成闭环。不改变引擎语义，也不依赖具体页面框架。
+ */
+export default class FlowDesigner {
+    ice: ICE;
+    selectedId: string | null;
+    private __undoStack;
+    private __redoStack;
+    private __historyEnabled;
+    private __maxHistory;
+    private __listeners;
+    private __mousedownHandler;
+    constructor(ice: ICE);
+    get nodes(): any[];
+    get edges(): any[];
+    get selected(): any;
+    /**
+     * 订阅流程变更（增删改 / 连线 / 载入 / undo / redo 之后触发）。
+     * 回调参数是当前流程的快照（与 serialize() 一致）。
+     */
+    subscribe(listener: (snapshot: string, designer: FlowDesigner) => void): () => void;
+    private __emitChange;
+    select(id: string | null): this;
+    /** 没有给坐标时，按已有节点包围盒的下方网格错开摆放，避免新建节点互相压住 */
+    private __defaultPlacement;
+    createNode(kind: FlowNodeKind, props?: any): any;
+    /** 由节点的插槽位置算出连线端点（引擎按插槽吸附，端点需要给出初始坐标） */
+    private __slotPoint;
+    createEdge(props?: any): any;
+    updateNode(id: string, patch: Record<string, any>): any;
+    updateEdge(id: string, patch: Record<string, any>): any;
+    /** 删除节点（连带删除挂在它两端的连线）或删除一条连线 */
+    remove(id: string): void;
+    clear(): void;
+    serialize(): string;
+    toSnapshot(): FlowSnapshot;
+    /**
+     * 载入流程图快照（整体替换当前流程）。
+     *
+     * @throws 结构非法时抛错；此时当前流程与历史栈都不会被改动。
+     */
+    load(json: string): FlowLoadReport;
+    /** 用快照数据重建整张流程图（不发变更广播，由调用方决定广播时机） */
+    private __clearAndBuild;
+    /** 把整个流程缩放到画布可视区内 */
+    fitViewport(padding?: number): void;
+    canUndo(): boolean;
+    canRedo(): boolean;
+    captureHistory(): void;
+    /** 清空撤销/重做栈（用于「载入示例」这类不该占用历史的初始化操作） */
+    resetHistory(): void;
+    private __captureHistory;
+    private __applySnapshot;
+    /**
+     * 撤销：先记账（把当前状态压入 redo、从 undo 弹出目标），再回放目标快照，
+     * 最后统一广播 —— 顺序很关键：若先广播再记账，订阅方（属性面板 / 工具条按钮）
+     * 读到的会是旧栈状态，出现「canRedo() 为 true 但按钮仍 disabled」这类不一致。
+     */
+    undo(): void;
+    redo(): void;
+    private __handleMouseDown;
+    dispose(): void;
+}

package/dist/types/flow/FlowDesigner.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import type { ICE } from '../ice-render/index';
+import type { FlowNodeKind } from './FlowNode';
+import type { FlowEdgeSnapshot } from './FlowEdge';
+import type { FlowNodeSnapshot } from './FlowNode';
+/** 流程图快照：只含流程图自身的语义数据，跨版本可读 */
+export declare type FlowSnapshot = {
+    version: number;
+    kind: 'flowchart';
+    nodes: FlowNodeSnapshot[];
+    edges: FlowEdgeSnapshot[];
+};
+/** load() 的载入报告 */
+export declare type FlowLoadReport = {
+    /** 是否真的发生了一次载入（空值 / 非流程图快照为 false） */
+    loaded: boolean;
+    nodes: number;
+    edges: number;
+    /** 因 typeId 不匹配被跳过的节点/连线 */
+    skipped: string[];
+};
+export declare type FlowSnapshotValidationResult = {
+    valid: boolean;
+    errors: string[];
+};
+/**
+ * 校验流程图快照结构。
+ *
+ * 契约与 IED 的项目快照一致：**serialize() 的产物必须永远能通过本校验**，
+ * 因此只校验加载器需要的结构，可选值（颜色 / 尺寸 / 端口）缺省即合法。
+ */
+export declare function validateFlowSnapshot(data: any): FlowSnapshotValidationResult;
+/**
+ * @class FlowDesigner 流程图应用层
+ *
+ * 与 EntityDesigner 同构：在通用图元之上把「建节点 / 连线 / 选中 / 增删改 /
+ * 撤销重做 / 快照存取」串成闭环。不改变引擎语义，也不依赖具体页面框架。
+ */
+export default class FlowDesigner {
+    ice: ICE;
+    selectedId: string | null;
+    private __undoStack;
+    private __redoStack;
+    private __historyEnabled;
+    private __maxHistory;
+    private __listeners;
+    private __mousedownHandler;
+    constructor(ice: ICE);
+    get nodes(): any[];
+    get edges(): any[];
+    get selected(): any;
+    /**
+     * 订阅流程变更（增删改 / 连线 / 载入 / undo / redo 之后触发）。
+     * 回调参数是当前流程的快照（与 serialize() 一致）。
+     */
+    subscribe(listener: (snapshot: string, designer: FlowDesigner) => void): () => void;
+    private __emitChange;
+    select(id: string | null): this;
+    /** 没有给坐标时，按已有节点包围盒的下方网格错开摆放，避免新建节点互相压住 */
+    private __defaultPlacement;
+    createNode(kind: FlowNodeKind, props?: any): any;
+    /** 由节点的插槽位置算出连线端点（引擎按插槽吸附，端点需要给出初始坐标） */
+    private __slotPoint;
+    createEdge(props?: any): any;
+    updateNode(id: string, patch: Record<string, any>): any;
+    updateEdge(id: string, patch: Record<string, any>): any;
+    /** 删除节点（连带删除挂在它两端的连线）或删除一条连线 */
+    remove(id: string): void;
+    clear(): void;
+    serialize(): string;
+    toSnapshot(): FlowSnapshot;
+    /**
+     * 载入流程图快照（整体替换当前流程）。
+     *
+     * @throws 结构非法时抛错；此时当前流程与历史栈都不会被改动。
+     */
+    load(json: string): FlowLoadReport;
+    /** 用快照数据重建整张流程图（不发变更广播，由调用方决定广播时机） */
+    private __clearAndBuild;
+    /** 把整个流程缩放到画布可视区内 */
+    fitViewport(padding?: number): void;
+    canUndo(): boolean;
+    canRedo(): boolean;
+    captureHistory(): void;
+    /** 清空撤销/重做栈（用于「载入示例」这类不该占用历史的初始化操作） */
+    resetHistory(): void;
+    private __captureHistory;
+    private __applySnapshot;
+    /**
+     * 撤销：先记账（把当前状态压入 redo、从 undo 弹出目标），再回放目标快照，
+     * 最后统一广播 —— 顺序很关键：若先广播再记账，订阅方（属性面板 / 工具条按钮）
+     * 读到的会是旧栈状态，出现「canRedo() 为 true 但按钮仍 disabled」这类不一致。
+     */
+    undo(): void;
+    redo(): void;
+    private __handleMouseDown;
+    dispose(): void;
+}

package/dist/types/flow/FlowEdge.d.mts

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import { ICEVisioLink } from '../ice-render/index.mjs';
+/** 连线端点所在的插槽位置（上 / 右 / 下 / 左 / 中心） */
+export declare type FlowPort = 'T' | 'R' | 'B' | 'L' | 'C';
+/** 连线在快照里的纯数据 */
+export declare type FlowEdgeSnapshot = {
+    id: string;
+    typeId: string;
+    sourceId: string | null;
+    targetId: string | null;
+    sourcePort: FlowPort | null;
+    targetPort: FlowPort | null;
+    label: string;
+    linkShape: string;
+    startPoint: number[];
+    endPoint: number[];
+};
+/**
+ * @class FlowEdge 流程图连线
+ *
+ * 复用引擎的 Visio 连线（正交折线 / 贝塞尔），带标签与箭头，并通过 `links` 挂在
+ * 两端节点的插槽上 —— 节点被拖动时连线自动跟随重新布线。
+ */
+export default class FlowEdge extends ICEVisioLink {
+    static readonly typeId = "FlowEdge";
+    constructor(props?: any);
+    /** 流程快照用的纯数据 */
+    toFlowObject(): FlowEdgeSnapshot;
+}

package/dist/types/flow/FlowEdge.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import { ICEVisioLink } from '../ice-render/index';
+/** 连线端点所在的插槽位置（上 / 右 / 下 / 左 / 中心） */
+export declare type FlowPort = 'T' | 'R' | 'B' | 'L' | 'C';
+/** 连线在快照里的纯数据 */
+export declare type FlowEdgeSnapshot = {
+    id: string;
+    typeId: string;
+    sourceId: string | null;
+    targetId: string | null;
+    sourcePort: FlowPort | null;
+    targetPort: FlowPort | null;
+    label: string;
+    linkShape: string;
+    startPoint: number[];
+    endPoint: number[];
+};
+/**
+ * @class FlowEdge 流程图连线
+ *
+ * 复用引擎的 Visio 连线（正交折线 / 贝塞尔），带标签与箭头，并通过 `links` 挂在
+ * 两端节点的插槽上 —— 节点被拖动时连线自动跟随重新布线。
+ */
+export default class FlowEdge extends ICEVisioLink {
+    static readonly typeId = "FlowEdge";
+    constructor(props?: any);
+    /** 流程快照用的纯数据 */
+    toFlowObject(): FlowEdgeSnapshot;
+}

package/dist/types/flow/FlowNode.d.mts

@@ -0,0 +1,54 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import { ICEGroup } from '../ice-render/index.mjs';
+/** 流程图节点类型：起止 / 处理 / 判定 / 输入输出 */
+export declare type FlowNodeKind = 'terminator' | 'process' | 'decision' | 'io';
+export declare type FlowNodePreset = {
+    label: string;
+    width: number;
+    height: number;
+    fill: string;
+    stroke: string;
+    radius?: number;
+    shape: 'rect' | 'diamond' | 'parallelogram';
+};
+/** 各类型节点的默认尺寸与配色（同时作为属性面板的预设） */
+export declare const FLOW_NODE_KINDS: Record<FlowNodeKind, FlowNodePreset>;
+/** 流程图节点在快照里的纯数据（不含引擎内部状态） */
+export declare type FlowNodeSnapshot = {
+    id: string;
+    typeId: string;
+    kind: FlowNodeKind;
+    title: string;
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    fillColor: string;
+    strokeColor: string;
+};
+/**
+ * @class FlowNode 流程图节点
+ *
+ * 一个不可见的容器（ICEGroup）里放「形状 + 居中标题」：容器只负责定位、拖拽与命中，
+ * 形状由子组件绘制，因此菱形 / 平行四边形这类非矩形轮廓也能正确渲染，
+ * 而节点的 width/height 始终就是它的包围盒（连线插槽、布局都按它算）。
+ */
+export default class FlowNode extends ICEGroup {
+    /** 稳定的类型标识（下游打包会 mangle 类名，判型不要用 constructor.name） */
+    static readonly typeId = "FlowNode";
+    protected shapeComponent: any;
+    protected labelComponent: any;
+    constructor(props?: any);
+    /** 按当前 kind / 尺寸 / 配色重建形状与标题（切换类型或改样式时调用） */
+    private __buildShape;
+    /** 改节点属性（标题 / 类型 / 配色 / 尺寸），必要时重建形状 */
+    applyPatch(patch?: Record<string, any>): this;
+    /** 流程快照用的纯数据 */
+    toFlowObject(): FlowNodeSnapshot;
+}

package/dist/types/flow/FlowNode.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import { ICEGroup } from '../ice-render/index';
+/** 流程图节点类型：起止 / 处理 / 判定 / 输入输出 */
+export declare type FlowNodeKind = 'terminator' | 'process' | 'decision' | 'io';
+export declare type FlowNodePreset = {
+    label: string;
+    width: number;
+    height: number;
+    fill: string;
+    stroke: string;
+    radius?: number;
+    shape: 'rect' | 'diamond' | 'parallelogram';
+};
+/** 各类型节点的默认尺寸与配色（同时作为属性面板的预设） */
+export declare const FLOW_NODE_KINDS: Record<FlowNodeKind, FlowNodePreset>;
+/** 流程图节点在快照里的纯数据（不含引擎内部状态） */
+export declare type FlowNodeSnapshot = {
+    id: string;
+    typeId: string;
+    kind: FlowNodeKind;
+    title: string;
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    fillColor: string;
+    strokeColor: string;
+};
+/**
+ * @class FlowNode 流程图节点
+ *
+ * 一个不可见的容器（ICEGroup）里放「形状 + 居中标题」：容器只负责定位、拖拽与命中，
+ * 形状由子组件绘制，因此菱形 / 平行四边形这类非矩形轮廓也能正确渲染，
+ * 而节点的 width/height 始终就是它的包围盒（连线插槽、布局都按它算）。
+ */
+export default class FlowNode extends ICEGroup {
+    /** 稳定的类型标识（下游打包会 mangle 类名，判型不要用 constructor.name） */
+    static readonly typeId = "FlowNode";
+    protected shapeComponent: any;
+    protected labelComponent: any;
+    constructor(props?: any);
+    /** 按当前 kind / 尺寸 / 配色重建形状与标题（切换类型或改样式时调用） */
+    private __buildShape;
+    /** 改节点属性（标题 / 类型 / 配色 / 尺寸），必要时重建形状 */
+    applyPatch(patch?: Record<string, any>): this;
+    /** 流程快照用的纯数据 */
+    toFlowObject(): FlowNodeSnapshot;
+}

package/dist/types/flow/flow_shapes.d.mts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import { ICEPath } from '../ice-render/index.mjs';
+/** 判定节点：菱形 */
+export declare class FlowDiamond extends ICEPath {
+    static readonly typeId = "FlowDiamond";
+    protected createPathObject(): any;
+}
+/** 输入 / 输出节点：平行四边形 */
+export declare class FlowParallelogram extends ICEPath {
+    static readonly typeId = "FlowParallelogram";
+    protected createPathObject(): any;
+}

package/dist/types/flow/flow_shapes.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import { ICEPath } from '../ice-render/index';
+/** 判定节点：菱形 */
+export declare class FlowDiamond extends ICEPath {
+    static readonly typeId = "FlowDiamond";
+    protected createPathObject(): any;
+}
+/** 输入 / 输出节点：平行四边形 */
+export declare class FlowParallelogram extends ICEPath {
+    static readonly typeId = "FlowParallelogram";
+    protected createPathObject(): any;
+}

package/dist/types/index.d.mts

@@ -13,6 +13,13 @@ export type { ProjectLoadReport, ProjectLoadSkippedNode } from './designer/Entit
 export { toSchemaObject, toSchemaString } from './utils/serialization_util.mjs';
 export { validateSchema } from './utils/schema_validator.mjs';
 export { PROJECT_SCHEMA_VERSION, validateProjectSnapshot } from './utils/project_schema.mjs';
+export { default as FlowNode, FLOW_NODE_KINDS } from './flow/FlowNode.mjs';
+export type { FlowNodeKind, FlowNodePreset, FlowNodeSnapshot } from './flow/FlowNode.mjs';
+export { default as FlowEdge } from './flow/FlowEdge.mjs';
+export type { FlowPort, FlowEdgeSnapshot } from './flow/FlowEdge.mjs';
+export { default as FlowDesigner, validateFlowSnapshot } from './flow/FlowDesigner.mjs';
+export type { FlowSnapshot, FlowLoadReport, FlowSnapshotValidationResult } from './flow/FlowDesigner.mjs';
+export { FlowDiamond, FlowParallelogram } from './flow/flow_shapes.mjs';
 /**
  * 引擎内核（ice-render）在构建时已被打包进本包，这里一并导出。
  *

package/dist/types/index.d.ts

@@ -13,6 +13,13 @@ export type { ProjectLoadReport, ProjectLoadSkippedNode } from './designer/Entit
 export { toSchemaObject, toSchemaString } from './utils/serialization_util';
 export { validateSchema } from './utils/schema_validator';
 export { PROJECT_SCHEMA_VERSION, validateProjectSnapshot } from './utils/project_schema';
+export { default as FlowNode, FLOW_NODE_KINDS } from './flow/FlowNode';
+export type { FlowNodeKind, FlowNodePreset, FlowNodeSnapshot } from './flow/FlowNode';
+export { default as FlowEdge } from './flow/FlowEdge';
+export type { FlowPort, FlowEdgeSnapshot } from './flow/FlowEdge';
+export { default as FlowDesigner, validateFlowSnapshot } from './flow/FlowDesigner';
+export type { FlowSnapshot, FlowLoadReport, FlowSnapshotValidationResult } from './flow/FlowDesigner';
+export { FlowDiamond, FlowParallelogram } from './flow/flow_shapes';
 /**
  * 引擎内核（ice-render）在构建时已被打包进本包，这里一并导出。
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "大漠穷秋",
   "name": "ice-entity-designer",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "description": "An entity designer based on ice-render.",
   "repository": {
     "type": "git",