@logicflow/core 0.7.4 → 0.7.8

package/dist/style/index.css

@@ -120,13 +120,31 @@
   left: 0;
   right: 0;
   bottom: 0;
-  z-index: 1;
+  z-index: 2;
   pointer-events: none;
   overflow: hidden;
 }
 .lf-tool-overlay > * {
   pointer-events: all;
 }
+/* modification-overlay */
+
+.modification-overlay {
+  position: absolute;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  z-index: 1;
+  pointer-events: none;
+  overflow: hidden;
+}
+.modification-overlay > * {
+  pointer-events: all;
+}
+.lf-outline,.lf-snapline {
+  pointer-events: none;
+}
 
 .lf-keyboard-tips {
   float: right;

package/package.json

@@ -1,10 +1,16 @@
 {
   "name": "@logicflow/core",
-  "version": "0.7.4",
+  "version": "0.7.8",
   "description": "LogicFlow core, to quickly build flowchart editor",
   "main": "dist/logic-flow.js",
   "license": "Apache-2.0",
+  "homepage": "http://logic-flow.org/",
   "types": "types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/didi/LogicFlow",
+    "directory": "packages/core"
+  },
   "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",
@@ -18,13 +24,18 @@
   },
   "files": [
     "dist",
-    "types"
+    "types",
+    "README.md"
   ],
   "dependencies": {
     "@types/mousetrap": "^1.6.4",
     "mousetrap": "^1.6.5",
     "preact": "^10.4.8"
   },
+  "keywords": [
+    "flowchart",
+    "diagram"
+  ],
   "devDependencies": {
     "@babel/core": "^7.9.0",
     "@babel/plugin-proposal-class-properties": "^7.8.3",
@@ -81,5 +92,5 @@
     "last 2 versions",
     "not ie <= 11"
   ],
-  "gitHead": "ccb87dd5dd1e43d10cd474108f5561379f5f5206"
+  "gitHead": "4740088e9abbb943a8046c4030f21a5751050833"
 }

package/types/LogicFlow.d.ts

@@ -6,7 +6,7 @@ import History from './history/History';
 import Tool from './tool';
 import EventEmitter, { CallbackType } from './event/eventEmitter';
 import Keyboard from './keyboard';
-import { EdgeConfig, EdgeFilter, NodeConfig, NodeAttribute, Extension, ComponentRender, FocusOnArgs, EdgeAttribute, EdgeData, GraphConfigData, RegisterElementFn, RegisterConfig } from './type';
+import { EdgeConfig, EdgeFilter, NodeConfig, NodeAttribute, Extension, ComponentRender, FocusOnArgs, EdgeAttribute, EdgeData, GraphConfigData, RegisterElementFn, RegisterConfig, ZoomParam, PointTuple } from './type';
 import SnaplineModel from './model/SnaplineModel';
 import { EditConfigInterface } from './model/EditConfigModel';
 declare type GraphConfigModel = {
@@ -52,10 +52,11 @@ export default class LogicFlow {
     redo(): void;
     /**
      * 放大缩小图形
-     * isZoomIn 是否放大，默认false, 表示缩小。
+     * @param zoomSize 放大缩小的值，支持传入0-n之间的数字。小于1表示缩小，大于1表示放大。也支持传入true和false按照内置的刻度放大缩小
+     * @param point 缩放的原点
      * @returns {string} -放大缩小的比例
      */
-    zoom(isZoomIn?: boolean): string;
+    zoom(zoomSize?: ZoomParam, point?: PointTuple): string;
     /**
      * 还原图形
      */
@@ -74,10 +75,10 @@ export default class LogicFlow {
      * 获取缩放的值和平移的值。
      */
     getTransform(): {
-        SCALE_X: any;
-        SCALE_Y: any;
-        TRANSLATE_X: any;
-        TRANSLATE_Y: any;
+        SCALE_X: number;
+        SCALE_Y: number;
+        TRANSLATE_X: number;
+        TRANSLATE_Y: number;
     };
     /**
      * 平移图形
@@ -112,6 +113,11 @@ export default class LogicFlow {
      * @param value 文案内容
      */
     updateText(id: string, value: string): void;
+    /**
+     * 删除元素，在不确定当前id是节点还是连线时使用
+     * @param id 元素id
+     */
+    deleteElement(id: any): boolean;
     /**
      * 修改指定节点类型
      * @param id 节点id
@@ -133,7 +139,7 @@ export default class LogicFlow {
      * 删除节点
      * @param {string} nodeId 节点Id
      */
-    deleteNode(nodeId: string): void;
+    deleteNode(nodeId: string): boolean;
     /**
      * 显示节点文本编辑框
      * @param nodeId 节点id
@@ -149,7 +155,13 @@ export default class LogicFlow {
      * 删除边
      * @param {string} edgeId 边Id
      */
-    deleteEdge(edgeId: string): void;
+    deleteEdge(edgeId: string): boolean;
+    /**
+     * 删除指定类型的边
+     * todo: API一致
+     * @param config.sourceNodeId 边的起点节点ID
+     * @param config.targetNodeId 边的终点节点ID
+     */
     removeEdge(config: {
         sourceNodeId: string;
         targetNodeId: string;
@@ -239,8 +251,8 @@ export default class LogicFlow {
             y: number;
         };
         canvasOverlayPosition: {
-            x: any;
-            y: any;
+            x: number;
+            y: number;
         };
     };
     /**
@@ -248,10 +260,7 @@ export default class LogicFlow {
      * @param isIgnoreCheck 是否包括sourceNode和targetNode没有被选中的连线,默认包括。
      * 复制的时候不能包括此类连线, 因为复制的时候不允许悬空的连线。
      */
-    getSelectElements(isIgnoreCheck?: boolean): {
-        nodes: any[];
-        edges: any[];
-    };
+    getSelectElements(isIgnoreCheck?: boolean): GraphConfigData;
     /**
      * 动态修改 id 对应元素 model 中的属性
      * @param {string} id 元素id
@@ -279,7 +288,7 @@ export default class LogicFlow {
      * @param leftTopPoint 区域左上角坐标, dom层坐标
      * @param rightBottomPoint 区域右下角坐标，dom层坐标
      */
-    getAreaElement(leftTopPoint: any, rightBottomPoint: any): any[];
+    getAreaElement(leftTopPoint: PointTuple, rightBottomPoint: PointTuple): any[];
     removeNodeSnapLine(): void;
     setView(type: string, component: any): void;
     getView: (type: string) => any;

package/types/event/eventEmitter.d.ts

@@ -15,22 +15,22 @@ export default class EventEmitter {
        */
     on(evt: string, callback: CallbackType, once?: boolean): this;
     /**
-       * 监听一个事件一次
-       * @param evt
-       * @param callback
-       */
-    once(evt: string, callback: CallbackType): this;
+     * 监听一个事件一次
+     * @param evt
+     * @param callback
+     */
+    once(evt: string, callback: CallbackType): void;
     /**
        * 触发一个事件
        * @param evt
        * @param args
        */
-    emit(evt: string, eventArgs: EventArgs): void;
+    emit(evts: string, eventArgs: EventArgs): void;
     /**
        * 取消监听一个事件，或者一个channel
        * @param evt
        * @param callback
        */
-    off(evt?: string, callback?: CallbackType): this;
+    off(evts?: string, callback?: CallbackType): this;
     getEvents(): Record<string, EventType[]>;
 }

package/types/model/GraphModel.d.ts

@@ -1,6 +1,7 @@
 import BaseNodeModel from './node/BaseNodeModel';
 import BaseEdgeModel from './edge/BaseEdgeModel';
 import EditConfigModel from './EditConfigModel';
+import TransfromModel from './TransformModel';
 import { IBaseModel } from './BaseModel';
 import { ElementState, ModelType, ElementType } from '../constant/constant';
 import { AdditionData, Point, NodeConfig, EdgeConfig, Style, NodeMoveRule } from '../type';
@@ -32,7 +33,7 @@ declare class GraphModel {
     plugins: any[];
     tools: any[];
     background: any;
-    transformMatrix: any;
+    transformMatrix: TransfromModel;
     editConfig: EditConfigModel;
     gridSize: number;
     partial: boolean;
@@ -73,8 +74,8 @@ declare class GraphModel {
             y: number;
         };
         canvasOverlayPosition: {
-            x: any;
-            y: any;
+            x: number;
+            y: number;
         };
     };
     /**

package/types/model/TransformModel.d.ts

@@ -1,5 +1,5 @@
 import EventEmitter from '../event/eventEmitter';
-import { PointTuple } from '../type';
+import { PointTuple, ZoomParam } from '../type';
 export interface TransfromInterface {
     SCALE_X: number;
     SKEW_Y: number;
@@ -10,10 +10,13 @@ export interface TransfromInterface {
     ZOOM_SIZE: number;
     MINI_SCALE_SIZE: number;
     MAX_SCALE_SIZE: number;
-    zoom: (isZoomout: boolean) => boolean;
+    zoom: (isZoomout: ZoomParam) => boolean;
     HtmlPointToCanvasPoint: (point: PointTuple) => PointTuple;
     CanvasPointToHtmlPoint: (point: PointTuple) => PointTuple;
     moveCanvasPointByHtml: (point: PointTuple, x: number, y: number) => PointTuple;
+    getTransformStyle: () => {
+        transform: string;
+    };
 }
 export default class TransfromModel implements TransfromInterface {
     MINI_SCALE_SIZE: number;
@@ -53,7 +56,13 @@ export default class TransfromModel implements TransfromInterface {
      * @param deltaY y轴距离变化
      */
     fixDeltaXY(deltaX: number, deltaY: number): PointTuple;
-    zoom(isZoomIn?: boolean, point?: PointTuple): boolean;
+    /**
+     * 基于当前的缩放，获取画布渲染样式transform值
+     */
+    getTransformStyle(): {
+        transform: string;
+    };
+    zoom(zoomSize?: ZoomParam, point?: PointTuple): boolean;
     private emitGraphTransform;
     resetZoom(): void;
     translate(x: number, y: number): void;

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

@@ -59,7 +59,7 @@ export default class BaseNodeModel implements IBaseModel {
     draggable: boolean;
     constructor(data: NodeConfig, graphModel: GraphModel, type: any);
     initNodeData(data: any): void;
-    createId(): string;
+    createId(): any;
     formatText(data: any): void;
     setAttributes(): void;
     /**

package/types/type/index.d.ts

@@ -120,7 +120,7 @@ export declare type EdgeConfig = {
         x: number;
         y: number;
         value: string;
-    };
+    } | string;
     pointsList?: Point[];
     zIndex?: number;
     properties?: Record<string, unknown>;
@@ -352,4 +352,5 @@ export declare type AnchorConfig = {
  * deltaY: 移动的y轴距离
  */
 export declare type NodeMoveRule = (model: BaseNodeModel, deltaX: number, deltaY: number) => Boolean;
+export declare type ZoomParam = boolean | number;
 export {};

package/types/view/overlay/CanvasOverlay.d.ts

@@ -1,2 +1,30 @@
-declare const _default: any;
-export default _default;
+import { h, Component } from 'preact';
+import GraphModel from '../../model/GraphModel';
+import { StepDrag } from '../../util/drag';
+import EventEmitter from '../../event/eventEmitter';
+import Dnd from '../behavior/DnD';
+declare type IProps = {
+    graphModel: GraphModel;
+    eventCenter: EventEmitter;
+    dnd: Dnd;
+};
+declare type Istate = {
+    isDraging: boolean;
+};
+declare class CanvasOverlay extends Component<IProps, Istate> {
+    stepDrag: StepDrag;
+    stepScrollX: number;
+    stepScrollY: number;
+    constructor(props: IProps);
+    onDraging: ({ deltaX, deltaY }: {
+        deltaX: any;
+        deltaY: any;
+    }) => void;
+    onDragEnd: () => void;
+    zoomHandler: (ev: WheelEvent) => void;
+    clickHandler: (ev: MouseEvent) => void;
+    handleContextMenu: (ev: MouseEvent) => void;
+    mouseDownHandler: (ev: MouseEvent) => void;
+    render(): h.JSX.Element;
+}
+export default CanvasOverlay;

package/types/view/overlay/HtmlOverlay.d.ts

@@ -4,53 +4,12 @@
  * 目前这里可以放文本。
  * 之后可以考虑放图片，范围框等。
  */
-import { h } from 'preact';
+import { h, Component } from 'preact';
 import GraphModel from '../../model/GraphModel';
-import { GraphTransform } from '../../type';
 declare type IProps = {
     graphModel: GraphModel;
 };
-declare const _default: {
-    new (props?: {
-        graphModel: GraphModel;
-    } & IProps, context?: any): {
-        getMatrixString(): GraphTransform;
-        render(): h.JSX.Element;
-        componentWillMount?(): void;
-        componentDidMount?(): void;
-        componentWillUnmount?(): void;
-        getChildContext?(): object;
-        componentWillReceiveProps?(nextProps: Readonly<{
-            graphModel: GraphModel;
-        } & IProps>, nextContext: any): void;
-        shouldComponentUpdate?(nextProps: Readonly<{
-            graphModel: GraphModel;
-        } & IProps>, nextState: Readonly<{}>, nextContext: any): boolean;
-        componentWillUpdate?(nextProps: Readonly<{
-            graphModel: GraphModel;
-        } & IProps>, nextState: Readonly<{}>, nextContext: any): void;
-        getSnapshotBeforeUpdate?(oldProps: Readonly<{
-            graphModel: GraphModel;
-        } & IProps>, oldState: Readonly<{}>): any;
-        componentDidUpdate?(previousProps: Readonly<{
-            graphModel: GraphModel;
-        } & IProps>, previousState: Readonly<{}>, snapshot: any): void;
-        componentDidCatch?(error: any, errorInfo: any): void;
-        state: Readonly<{}>;
-        props: import("preact").RenderableProps<{
-            graphModel: GraphModel;
-        } & IProps, any>;
-        context: any;
-        base?: Element | Text;
-        setState<K extends never>(state: Partial<{}> | ((prevState: Readonly<{}>, props: Readonly<{
-            graphModel: GraphModel;
-        } & IProps>) => Partial<{}> | Pick<{}, K>) | Pick<{}, K>, callback?: () => void): void;
-        forceUpdate(callback?: () => void): void;
-    };
-    displayName?: string;
-    defaultProps?: any;
-    contextType?: import("preact").Context<any>;
-    getDerivedStateFromProps?(props: object, state: object): object;
-    getDerivedStateFromError?(error: any): object;
-};
-export default _default;
+declare class HtmlOverlay extends Component<IProps> {
+    render(): h.JSX.Element;
+}
+export default HtmlOverlay;

package/types/view/overlay/ModificationOverlay.d.ts

@@ -0,0 +1,9 @@
+import { h, Component } from 'preact';
+import GraphModel from '../../model/GraphModel';
+declare type IProps = {
+    graphModel: GraphModel;
+};
+export default class ModificationOverlay extends Component<IProps> {
+    render(): h.JSX.Element;
+}
+export {};