@logicflow/core 1.0.0-alpha.1 → 1.0.0-alpha.5

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@logicflow/core",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.5",
   "description": "LogicFlow core, to quickly build flowchart editor",
   "main": "dist/logic-flow.js",
   "unpkg": "dist/logic-flow.js",
   "jsdelivr": "dist/logic-flow.js",
-  "module": "dis/logic-flow.es.js",
   "license": "Apache-2.0",
   "homepage": "http://logic-flow.org/",
   "types": "types/index.d.ts",
@@ -17,9 +16,8 @@
   "scripts": {
     "dev": "cross-env NODE_ENV=development webpack-dev-server --client-log-level warning --config scripts/webpack.config.dev.js",
     "clean": "rimraf dist lib esm cjs",
-    "build": "npm run build:umd;npm run build:es",
+    "build": "npm run build:umd",
     "build:umd": "cross-env NODE_ENV=production webpack --config scripts/webpack.config.build.js && cp -r src/style/ dist/style",
-    "build:es": "cp -r scripts/logic-flow.es.js dist/",
     "build-analyse": "cross-env analyse=true npm run build",
     "types": "tsc -d --declarationDir ./types --outDir temp && rimraf temp",
     "lint": "eslint . --ext .ts,.tsx",

package/types/model/BaseModel.d.ts

@@ -1,73 +1,14 @@
 import { ElementState } from '../constant/constant';
 import { TextConfig, AdditionData } from '../type';
 interface IBaseModel {
-    /**
-     * 节点或者连线的id.
-     * 默认情况下，使用uuidv4生成。
-     * 如果想要自定义，可以重写createId生成。
-     */
     id: string;
-    /**
-     * 不可自定义
-     * model对应的图形外观类型（eg: 圆形、矩形、多边形等）
-     * 用于logicflow内部计算使用。
-     */
     modelType: string;
-    /**
-     * 请勿直接修改属性，如果想要将一个节点类型修改为另一个类型。请使用
-     * `lf.graphModel.changeEdgeType`和`lf.graphModel.changeNodeType`
-     *
-     * 流程图元素类型，自定义元素时对应的标识。
-     * 在logicflow/core中对应着rect、circle、polyline这种。
-     * 在实际项目中，我们会基于业务类型进行自定义type.
-     * 例如BPMN应用场景，我们会定义开始节点的类型为bpmn:start-event
-     *
-     * 和modelType的区别是，type更多的是业务上的类型，而modelType则是外观上的类型。
-     * 例如bpmnjs的开始节点和结束节点type分别为'bpmn:start-event'和'bpmn:end-event'。
-     * 但是他们的modelType都是circle-node, 因为他们外观都是基于圆形自定义而来。
-     */
     type: string;
-    /**
-     * 元素状态
-     * 不同的状态对应着元素显示效果。
-     * 请勿直接修改。
-     * logicflow内部将元素状态分为5种：
-     * DEFAULT = 1 默认显示
-     * TEXT_EDIT = 2 此元素正在进行文本编辑
-     * SHOW_MENU = 3, 显示菜单，废弃请使用菜单插件
-     * ALLOW_CONNECT = 4, 此元素允许作为当前连线的目标节点
-     * NOT_ALLOW_CONNECT = 5, 此元素不允许作为当前连线的目标节点
-     */
     state: ElementState;
     additionStateData: AdditionData;
-    /**
-     * 元素上的文本
-     * logicflow中存在两种文本
-     * 一种是脱离连线和节点单独存在的文本
-     * 一种是必须和连线、节点关联的文本。
-     * 此属性控制的是第二种。
-     * 节点和连线删除、调整的时候，其关联的文本也会对应删除、调整。
-     */
     text: TextConfig;
-    /**
-     * 元素是否被选中
-     */
     isSelected: boolean;
-    /**
-     * 元素堆叠是层级，默认情况下节点zIndex值为1，连线zIndex为0。
-     * todo：写完善
-     */
     zIndex: number;
-    /**
-     * 创建节点ID
-     * 默认情况下，logicflow内部使用uuidv4生成id。
-     * 在自定义节点的时候，可以重写此方法基于自己的规则生成id。
-     * 注意，此方法必须是同步的。
-     * 如果想要异步修改Id，建议删除此节点后再同一位置创建一个新的节点。
-     * @overridable 可以重写
-     * @returns string
-     */
-    createId(): string;
     move(deltaX: number, deltaY: number): void;
     moveText(deltaX: number, deltaY: number): void;
     updateText(value: string): void;

package/types/model/GraphModel.d.ts

@@ -90,6 +90,10 @@ declare class GraphModel {
         nodes: import("../type").NodeData[];
         edges: import("../type").EdgeData[];
     };
+    modelToHistoryData(): false | {
+        nodes: any[];
+        edges: any[];
+    };
     getEdgeModel(edgeId: string): BaseEdgeModel;
     getElement(id: string): IBaseModel | undefined;
     getNodeEdges(nodeId: any): BaseEdgeModel[];
@@ -168,9 +172,8 @@ declare class GraphModel {
      * @param fn function
      */
     addNodeMoveRules(fn: NodeMoveRule): void;
-    setDefaultEdgeType(type: string): void;
+    changeEdgeType(type: string): void;
     changeNodeType(id: any, type: string): void;
-    changeEdgeType(id: any, type: any): void;
     setTheme(style: Style): void;
     clearData(): void;
 }

package/types/model/edge/BaseEdgeModel.d.ts

@@ -37,6 +37,7 @@ declare class BaseEdgeModel implements IBaseModel {
     zIndex: number;
     isSelected: boolean;
     isHovered: boolean;
+    isDragging: boolean;
     isHitable: boolean;
     hoverStroke: string;
     selectedStroke: string;

package/types/model/node/BaseNodeModel.d.ts

@@ -1,5 +1,5 @@
 import { ElementState, ModelType, ElementType } from '../../constant/constant';
-import { AdditionData, NodeData, NodeAttribute, NodeConfig, NodeMoveRule, Bounds, AnchorConfig, PointAnchor, AnchorsOffsetItem } from '../../type';
+import { AdditionData, NodeData, NodeAttribute, NodeConfig, NodeMoveRule, Bounds, Point, AnchorConfig } from '../../type';
 import GraphModel from '../GraphModel';
 import { IBaseModel } from '../BaseModel';
 export declare type ConnectRule = {
@@ -10,14 +10,8 @@ export declare type ConnectRuleResult = {
     isAllPass: boolean;
     msg?: string;
 };
-interface IBaseNodeModel extends IBaseModel {
-    /**
-     * model基础类型，固定为node
-     */
-    readonly BaseType: ElementType.NODE;
-}
 export { BaseNodeModel };
-export default class BaseNodeModel implements IBaseNodeModel {
+export default class BaseNodeModel implements IBaseModel {
     id: string;
     readonly BaseType = ElementType.NODE;
     modelType: ModelType;
@@ -52,9 +46,10 @@ export default class BaseNodeModel implements IBaseNodeModel {
     hoverOutlineStrokeDashArray: string;
     isSelected: boolean;
     isHovered: boolean;
+    isDragging: boolean;
     isHitable: boolean;
     zIndex: number;
-    anchorsOffset: AnchorsOffsetItem[];
+    anchorsOffset: any[];
     state: number;
     text: {
         value: string;
@@ -65,39 +60,12 @@ export default class BaseNodeModel implements IBaseNodeModel {
     };
     draggable: boolean;
     constructor(data: NodeConfig, graphModel: GraphModel, type: any);
-    /**
-     * 初始化节点数据，不建议重写
-     * 可以重写setAttributes来实现修改初始化功能
-     * initNodeData和setAttributes的区别在于
-     * initNodeData需要
-     */
-    protected initNodeData(data: any): void;
-    /**
-     * @overridable 支持重新
-     * @returns string
-     */
-    createId(): string;
-    /**
-     * 初始化文本属性，对
-     */
-    private formatText;
-    /**
-     * 设置model初始化属性
-     * 例如设置节点的宽度
-     * @example
-     *
-     * setAttributes () {
-     *   this.width = 300
-     *   this.height = 200
-     * }
-     *
-     * @overridable 支持重写
-     */
+    initNodeData(data: any): void;
+    createId(): any;
+    formatText(data: any): void;
     setAttributes(): void;
     /**
-     * 获取被保存时返回的数据
-     * @overridable 支持重写
-     * @returns NodeData
+     * 保存时获取的数据
      */
     getData(): NodeData;
     getProperties(): Record<string, any>;
@@ -118,20 +86,12 @@ export default class BaseNodeModel implements IBaseNodeModel {
      */
     isAllowMoveNode(deltaX: any, deltaY: any): boolean;
     getConnectedTargetRules(): ConnectRule[];
+    getAnchorsByOffset(): Point[];
     /**
-     * @overridable 子类重写此方法设置锚点
-     * @returns Point[] 锚点坐标构成的数组
-     */
-    getAnchorsByOffset(): PointAnchor[];
-    /**
-     * 获取节点默认情况下的锚点
-     */
-    getDetaultAnchor(): PointAnchor[];
-    /**
-     * 获取节点BBox
+     * 获取节点区域
      */
     getBounds(): Bounds;
-    get anchors(): PointAnchor[];
+    get anchors(): Point[];
     addNodeMoveRules(fn: NodeMoveRule): void;
     move(deltaX: any, deltaY: any, isignoreRule?: boolean): void;
     moveTo(x: any, y: any, isignoreRule?: boolean): void;

package/types/model/node/CircleNodeModel.d.ts

@@ -1,3 +1,4 @@
+import { Point } from '../../type';
 import BaseNodeModel from './BaseNodeModel';
 import { ModelType } from '../../constant/constant';
 import GraphModel from '../GraphModel';
@@ -7,11 +8,7 @@ declare class CircleNodeModel extends BaseNodeModel {
     constructor(data: any, graphModel: GraphModel);
     get width(): number;
     get height(): number;
-    getDetaultAnchor(): {
-        x: number;
-        y: number;
-        id: string;
-    }[];
+    get anchors(): Point[];
 }
 export { CircleNodeModel };
 export default CircleNodeModel;

package/types/model/node/PolygonNodeModel.d.ts

@@ -6,11 +6,6 @@ declare class PolygonNodeModel extends BaseNodeModel {
     modelType: ModelType;
     points: PointTuple[];
     constructor(data: any, graphModel: GraphModel);
-    /**
-     * 由于大多数情况下，我们初始化拿到的多边形坐标都是基于原点的（例如绘图工具到处的svg）。
-     * 在logicflow中对多边形进行移动，我们不需要去更新points，
-     * 而是去更新多边形中心点即可。
-     */
     get pointsPosition(): Point[];
     get width(): number;
     get height(): number;

package/types/type/index.d.ts

@@ -29,27 +29,6 @@ export declare type Point = {
     y: number;
     [key: string]: unknown;
 };
-/**
- * 锚点坐标
- * 为了方便计算
- * 锚点的位置都是相对于节点中心点的偏移量。
- */
-export declare type PointAnchor = {
-    /**
-     * 锚点x轴相对于中心点的偏移量
-     */
-    x: number;
-    /**
-     * 锚点y轴相对于中心点的偏移量
-     */
-    y: number;
-    /**
-     * 锚点Id
-     */
-    id?: string;
-    [key: string]: unknown;
-};
-export declare type AnchorsOffsetItem = PointTuple | PointAnchor;
 export declare type Size = {
     width: number;
     height: number;

package/types/view/node/BaseNode.d.ts

@@ -9,7 +9,6 @@ declare type IProps = {
     eventCenter: EventEmitter;
 };
 declare type Istate = {
-    isDraging: boolean;
     isHovered: boolean;
 };
 declare type StyleAttribute = {

package/dist/logic-flow.es.js

@@ -1,74 +0,0 @@
-
-/**
- * 由于logicflow本身基于preact、mobx、mobx-react编写。
- * 如果导出es module的形式，会在react项目中mobx-react会错误的使用react渲染。
- * 所以logicflow暂时不提供完善导出es module形式。
- */
-import {
-  LogicFlow,
-  LogicFlowUtil,
-  h,
-  observer,
-  BaseNode,
-  RectNode,
-  CircleNode,
-  PolygonNode,
-  DiamondNode,
-  EllipseNode,
-  TextNode,
-  HtmlNode,
-  BaseEdge,
-  LineEdge,
-  PolylineEdge,
-  BezierEdge,
-  BaseEdgeModel,
-  BezierEdgeModel,
-  LineEdgeModel,
-  PolylineEdgeModel,
-  BaseNodeModel,
-  CircleNodeModel,
-  DiamondNodeModel,
-  EllipseNodeModel,
-  PolygonNodeModel,
-  RectNodeModel,
-  TextNodeModel,
-  HtmlNodeModel,
-  GraphModel,
-  Arrow,
-  Keyboard,
-} from './logic-flow';
-
-export {
-  LogicFlow,
-  LogicFlowUtil,
-  h,
-  observer,
-  BaseNode,
-  RectNode,
-  CircleNode,
-  PolygonNode,
-  DiamondNode,
-  EllipseNode,
-  TextNode,
-  HtmlNode,
-  BaseEdge,
-  LineEdge,
-  PolylineEdge,
-  BezierEdge,
-  BaseEdgeModel,
-  BezierEdgeModel,
-  LineEdgeModel,
-  PolylineEdgeModel,
-  BaseNodeModel,
-  CircleNodeModel,
-  DiamondNodeModel,
-  EllipseNodeModel,
-  PolygonNodeModel,
-  RectNodeModel,
-  TextNodeModel,
-  HtmlNodeModel,
-  GraphModel,
-  Arrow,
-  Keyboard,
-}
-export default LogicFlow;