@html-graph/html-graph 0.0.52 → 0.0.53

package/README.md

@@ -10,12 +10,10 @@
     <img width="100%" src="https://raw.githubusercontent.com/html-graph/html-graph/master/media/full-demo.gif"/>
 </a>
 
-Instead of connecting nodes dirrectly this library uses concept of ports, which provide greater fexibility at managing edges.
-Port is an entity of a node to which edge can be attached to.
-
-This library fits for tasks where easy nodes customization and interactiveness are required.
+Visit <a target="_blank" href="https://html-graph.github.io">live demo</a>.
 
-Visit <a target="_blank" href="https://html-graph.github.io">live demo</a>
+Instead of connecting nodes directly this library uses concept of ports, which provide greater fexibility at managing edges.
+Port is an entity of a node to which edge can be attached to.
 
 ## Features:
 
@@ -37,8 +35,14 @@ import { AddNodePorts, HtmlGraphBuilder } from "@html-graph/html-graph";
 
 const canvas = new HtmlGraphBuilder()
   .setOptions({
-    background: { type: "dots" },
-    edges: { hasTargetArrow: true },
+    background: {
+      type: "dots",
+    },
+    edges: {
+      shape: {
+        hasTargetArrow: true,
+      },
+    },
   })
   .setUserDraggableNodes()
   .setUserTransformableCanvas()
@@ -64,12 +68,13 @@ function createNode(
   backPort.classList.add("port");
   node.appendChild(backPort);
 
-  const ports = new Map([
-    [frontPortId, frontPort],
-    [backPortId, backPort],
-  ]);
-
-  return [node, ports];
+  return [
+    node,
+    [
+      [frontPortId, frontPort],
+      [backPortId, backPort],
+    ],
+  ];
 }
 
 const [node1, ports1] = createNode("Node 1", "port-1-1", "port-1-2");

package/dist/main.d.ts

@@ -2,11 +2,11 @@ export declare interface AddEdgeRequest {
     id?: unknown;
     from: string;
     to: string;
-    options?: EdgeOptions;
+    options?: EdgeShape;
     priority?: number;
 }
 
-export declare type AddNodePorts = ReadonlyMap<unknown, MarkNodePortRequest>;
+export declare type AddNodePorts = Iterable<readonly [unknown, MarkNodePortRequest]>;
 
 export declare interface AddNodeRequest {
     id?: unknown;
@@ -22,9 +22,6 @@ export declare type BackgroundDrawingFn = (ctx: CanvasRenderingContext2D, transf
 
 declare type BackgroundOptions = {
     readonly type: "none";
-} | {
-    readonly type: "color";
-    readonly color?: string;
 } | {
     readonly type: "dots";
     readonly dotColor?: string;
@@ -36,7 +33,7 @@ declare type BackgroundOptions = {
     readonly drawingFn: BackgroundDrawingFn;
 };
 
-export declare class BezierEdgeController implements EdgeController {
+export declare class BezierEdgeShape implements EdgeController {
     private readonly color;
     private readonly width;
     private readonly curvature;
@@ -51,7 +48,7 @@ export declare class BezierEdgeController implements EdgeController {
     update(x: number, y: number, width: number, height: number, from: PortPayload, to: PortPayload): void;
 }
 
-declare interface BezierEdgeOptions {
+declare interface BezierEdgeShape_2 {
     readonly type?: "bezier";
     readonly color?: string;
     readonly width?: number;
@@ -67,6 +64,10 @@ declare interface BezierEdgeOptions {
 }
 
 export declare interface Canvas {
+    /**
+     * provides api for accessing graph model
+     */
+    readonly model: PublicGraphStore;
     /**
      * provides api for canvas transformation
      */
@@ -118,10 +119,6 @@ export declare interface Canvas {
      * moves viewport to nodes
      */
     moveToNodes(nodeIds: readonly string[]): Canvas;
-    /**
-     * moves specified node on top
-     */
-    moveNodeOnTop(nodeId: unknown): Canvas;
     /**
      * attaches canvas to given element
      */
@@ -150,13 +147,13 @@ export declare interface Canvas {
 export declare class CanvasCore implements Canvas {
     private readonly apiOptions?;
     readonly transformation: PublicViewportTransformer;
+    readonly model: PublicGraphStore;
     private readonly di;
-    private readonly edgeControllerFactory;
+    private readonly edgeShapeFactory;
     constructor(apiOptions?: CoreOptions | undefined);
     addNode(node: AddNodeRequest): CanvasCore;
     updateNode(nodeId: unknown, request: UpdateNodeRequest): CanvasCore;
     removeNode(nodeId: unknown): CanvasCore;
-    moveNodeOnTop(nodeId: unknown): CanvasCore;
     markPort(port: MarkPortRequest): CanvasCore;
     updatePort(portId: string, request: UpdatePortRequest): CanvasCore;
     unmarkPort(portId: string): CanvasCore;
@@ -173,6 +170,8 @@ export declare class CanvasCore implements Canvas {
 
 export declare type CenterFn = (width: number, height: number) => [number, number];
 
+declare type ConstantPriority = number;
+
 export declare interface CoreOptions {
     /**
      * canvas background settings
@@ -187,6 +186,10 @@ export declare interface CoreOptions {
          * center of nodes specified in addNode method by x and y
          */
         readonly centerFn?: CenterFn;
+        /**
+         * specifies default z-index value
+         */
+        readonly priority?: Priority;
     };
     /**
      * ports related behavior
@@ -205,19 +208,19 @@ export declare interface CoreOptions {
     /**
      *edges related behavior
      */
-    readonly edges?: EdgeOptions;
-    /**
-     * layers related behavior
-     */
-    readonly layers?: {
+    readonly edges?: {
         /**
-         * sets layers order
+         * specifies default controller
          */
-        readonly mode?: LayersMode;
+        readonly shape?: EdgeShape;
+        /**
+         * specifies default z-index value
+         */
+        readonly priority?: Priority;
     };
 }
 
-export declare const createBezierEdgeControllerFactory: (options: {
+export declare const createBezierEdgeShapeFactory: (options: {
     color: string;
     width: number;
     arrowLength: number;
@@ -229,9 +232,9 @@ export declare const createBezierEdgeControllerFactory: (options: {
     smallCycleRadius: number;
     detourDistance: number;
     detourDirection: number;
-}) => EdgeControllerFactory;
+}) => EdgeShapeFactory;
 
-export declare const createHorizontalEdgeControllerFactory: (options: {
+export declare const createHorizontalEdgeShapeFactory: (options: {
     color: string;
     width: number;
     arrowLength: number;
@@ -243,9 +246,9 @@ export declare const createHorizontalEdgeControllerFactory: (options: {
     roundness: number;
     detourDistance: number;
     detourDirection: number;
-}) => EdgeControllerFactory;
+}) => EdgeShapeFactory;
 
-export declare const createStraightEdgeControllerFactory: (options: {
+export declare const createStraightEdgeShareFactory: (options: {
     color: string;
     width: number;
     arrowLength: number;
@@ -257,9 +260,9 @@ export declare const createStraightEdgeControllerFactory: (options: {
     roundness: number;
     detourDistance: number;
     detourDirection: number;
-}) => EdgeControllerFactory;
+}) => EdgeShapeFactory;
 
-export declare const createVerticalEdgeControllerFactory: (options: {
+export declare const createVerticalEdgeShapeFactory: (options: {
     color: string;
     width: number;
     arrowLength: number;
@@ -271,14 +274,16 @@ export declare const createVerticalEdgeControllerFactory: (options: {
     roundness: number;
     detourDistance: number;
     detourDirection: number;
-}) => EdgeControllerFactory;
+}) => EdgeShapeFactory;
 
-declare interface CustomEdgeOptions {
+declare interface CustomEdgeShape {
     readonly type: "custom";
-    readonly controllerFactory: EdgeControllerFactory;
+    readonly controllerFactory: EdgeShapeFactory;
 }
 
-export declare class CycleCircleEdgeController implements EdgeController {
+declare type CustomPriority = PriorityFn;
+
+export declare class CycleCircleEdgeShape implements EdgeController {
     private readonly color;
     private readonly width;
     private readonly arrowLength;
@@ -293,7 +298,7 @@ export declare class CycleCircleEdgeController implements EdgeController {
     update(x: number, y: number, _width: number, _height: number, from: PortPayload): void;
 }
 
-export declare class CycleSquareEdgeController implements EdgeController {
+export declare class CycleSquareEdgeShape implements EdgeController {
     private readonly color;
     private readonly width;
     private readonly arrowLength;
@@ -310,7 +315,7 @@ export declare class CycleSquareEdgeController implements EdgeController {
     update(x: number, y: number, _width: number, _height: number, from: PortPayload): void;
 }
 
-export declare class DetourStraightEdgeController implements EdgeController {
+export declare class DetourStraightEdgeShape implements EdgeController {
     private readonly color;
     private readonly width;
     private readonly arrowLength;
@@ -329,6 +334,7 @@ export declare class DetourStraightEdgeController implements EdgeController {
 }
 
 export declare interface DragOptions {
+    grabPriorityStrategy?: "freeze" | "move-on-top";
     events?: {
         onNodeDrag?: (payload: NodeDragPayload) => void;
         onBeforeNodeDrag?: (payload: NodeDragPayload) => boolean;
@@ -340,9 +346,16 @@ export declare interface EdgeController {
     update(x: number, y: number, width: number, height: number, from: PortPayload, to: PortPayload): void;
 }
 
-declare type EdgeControllerFactory = (type: EdgeType) => EdgeController;
+declare interface EdgePayload {
+    from: string;
+    to: string;
+    shape: EdgeController;
+    priority: number;
+}
+
+declare type EdgeShape = BezierEdgeShape_2 | StraightEdgeShape_2 | CustomEdgeShape | HorizontalEdgeShape_2 | VerticalEdgeShape_2;
 
-declare type EdgeOptions = BezierEdgeOptions | StraightEdgeOptions | CustomEdgeOptions | HorizontalEdgeOptions | VerticalEdgeOptions;
+declare type EdgeShapeFactory = (type: EdgeType) => EdgeController;
 
 export declare enum EdgeType {
     Regular = "regular",
@@ -350,7 +363,57 @@ export declare enum EdgeType {
     NodeCycle = "node-cycle"
 }
 
-export declare class HorizontalEdgeController implements EdgeController {
+export declare interface GraphEdge {
+    readonly from: unknown;
+    readonly to: unknown;
+    readonly priority: number;
+}
+
+export declare interface GraphNode {
+    readonly element: HTMLElement;
+    readonly x: number;
+    readonly y: number;
+    readonly centerFn: CenterFn;
+    readonly priority: number;
+}
+
+export declare interface GraphPort {
+    readonly element: HTMLElement;
+    readonly centerFn: CenterFn;
+    readonly direction: number;
+}
+
+declare class GraphStore {
+    private readonly nodes;
+    private readonly ports;
+    private readonly nodePorts;
+    private readonly portNodeId;
+    private readonly edges;
+    private readonly incommingEdges;
+    private readonly outcommingEdges;
+    private readonly cycleEdges;
+    addNode(nodeId: unknown, element: HTMLElement, x: number, y: number, centerFn: CenterFn, priority: number): void;
+    getNode(nodeId: unknown): NodePayload | undefined;
+    removeNode(nodeId: unknown): void;
+    addPort(portId: unknown, element: HTMLElement, nodeId: unknown, centerFn: CenterFn, dir: number): void;
+    getPort(portId: unknown): PortPayload | undefined;
+    getPortNode(portId: string): unknown | undefined;
+    removePort(portId: string): void;
+    addEdge(edgeId: unknown, fromPortId: string, toPortId: string, shape: EdgeController, priority: number): void;
+    getEdge(edgeId: unknown): EdgePayload | undefined;
+    removeEdge(edgeId: unknown): void;
+    getPortAdjacentEdges(portId: string): readonly unknown[];
+    getNodeAdjacentEdges(nodeId: unknown): readonly unknown[];
+    clear(): void;
+    getPortIncomingEdges(portId: unknown): readonly unknown[];
+    getPortOutcomingEdges(portId: unknown): readonly unknown[];
+    getPortCycleEdges(portId: unknown): readonly unknown[];
+    getNodeIncomingEdges(nodeId: unknown): readonly unknown[];
+    getNodeOutcomingEdges(nodeId: unknown): readonly unknown[];
+    getNodeCycleEdges(nodeId: unknown): readonly unknown[];
+}
+
+export declare class HorizontalEdgeShape implements EdgeController {
     private readonly color;
     private readonly width;
     private readonly arrowLength;
@@ -366,7 +429,7 @@ export declare class HorizontalEdgeController implements EdgeController {
     update(x: number, y: number, width: number, height: number, from: PortPayload, to: PortPayload): void;
 }
 
-declare interface HorizontalEdgeOptions {
+declare interface HorizontalEdgeShape_2 {
     readonly type: "horizontal";
     readonly color?: string;
     readonly width?: number;
@@ -393,7 +456,7 @@ export declare class HtmlGraphBuilder {
     build(): Canvas;
 }
 
-declare type LayersMode = "edges-on-top" | "nodes-on-top" | "edges-follow-node";
+declare type IncrementalPriority = "incremental";
 
 export declare type MarkNodePortRequest = HTMLElement | {
     readonly element: HTMLElement;
@@ -416,17 +479,12 @@ export declare interface NodeDragPayload {
     readonly y: number;
 }
 
-export declare interface NodeItem {
-    readonly id: string;
-    readonly x: number;
-    readonly y: number;
-    readonly element: HTMLElement;
-}
-
-export declare interface NodeResponse {
-    readonly x: number;
-    readonly y: number;
-    readonly element: HTMLElement;
+declare interface NodePayload {
+    element: HTMLElement;
+    x: number;
+    y: number;
+    centerFn: CenterFn;
+    priority: number;
 }
 
 export declare interface PatchViewportRequest {
@@ -441,6 +499,27 @@ export declare interface PortPayload {
     direction: number;
 }
 
+declare type Priority = ConstantPriority | IncrementalPriority | SharedIncrementalPriority | CustomPriority;
+
+export declare type PriorityFn = () => number;
+
+declare class PublicGraphStore {
+    private readonly graphStore;
+    constructor(graphStore: GraphStore);
+    getNode(nodeId: unknown): GraphNode | undefined;
+    getPort(portId: unknown): GraphPort | undefined;
+    getPortNode(portId: string): unknown | undefined;
+    getEdge(edgeId: unknown): GraphEdge | undefined;
+    getPortAdjacentEdges(portId: string): readonly unknown[];
+    getNodeAdjacentEdges(nodeId: unknown): readonly unknown[];
+    getPortIncomingEdges(portId: unknown): readonly unknown[];
+    getPortOutcomingEdges(portId: unknown): readonly unknown[];
+    getPortCycleEdges(portId: unknown): readonly unknown[];
+    getNodeIncomingEdges(nodeId: unknown): readonly unknown[];
+    getNodeOutcomingEdges(nodeId: unknown): readonly unknown[];
+    getNodeCycleEdges(nodeId: unknown): readonly unknown[];
+}
+
 export declare class PublicViewportTransformer {
     private readonly transformer;
     constructor(transformer: ViewportTransformer);
@@ -466,7 +545,9 @@ export declare class PublicViewportTransformer {
     getAbsScale(): number;
 }
 
-export declare class StraightEdgeController implements EdgeController {
+declare type SharedIncrementalPriority = "shared-incremental";
+
+export declare class StraightEdgeShape implements EdgeController {
     private readonly color;
     private readonly width;
     private readonly arrowLength;
@@ -482,7 +563,7 @@ export declare class StraightEdgeController implements EdgeController {
     update(x: number, y: number, width: number, height: number, from: PortPayload, to: PortPayload): void;
 }
 
-declare interface StraightEdgeOptions {
+declare interface StraightEdgeShape_2 {
     readonly type: "straight";
     readonly color?: string;
     readonly width?: number;
@@ -538,7 +619,9 @@ declare interface UpdatePortRequest {
 
 export declare class UserDraggableNodesCanvas implements Canvas {
     private readonly canvas;
+    readonly model: PublicGraphStore;
     readonly transformation: PublicViewportTransformer;
+    private maxNodePriority;
     private readonly nodes;
     private grabbedNodeId;
     private onNodeDrag;
@@ -551,8 +634,9 @@ export declare class UserDraggableNodesCanvas implements Canvas {
     private readonly onCanvasTouchMove;
     private readonly onCanvasTouchEnd;
     private previousTouchCoords;
+    private freezePriority;
     constructor(canvas: Canvas, dragOptions?: DragOptions);
-    addNode(node: AddNodeRequest): UserDraggableNodesCanvas;
+    addNode(request: AddNodeRequest): UserDraggableNodesCanvas;
     updateNode(nodeId: unknown, request: UpdateNodeRequest): UserDraggableNodesCanvas;
     removeNode(nodeId: unknown): UserDraggableNodesCanvas;
     markPort(port: MarkPortRequest): UserDraggableNodesCanvas;
@@ -563,18 +647,20 @@ export declare class UserDraggableNodesCanvas implements Canvas {
     removeEdge(edgeId: unknown): UserDraggableNodesCanvas;
     patchViewportState(request: PatchViewportRequest): UserDraggableNodesCanvas;
     moveToNodes(nodeIds: readonly string[]): UserDraggableNodesCanvas;
-    moveNodeOnTop(nodeId: string): UserDraggableNodesCanvas;
     clear(): UserDraggableNodesCanvas;
     attach(element: HTMLElement): UserDraggableNodesCanvas;
     detach(): UserDraggableNodesCanvas;
     destroy(): void;
     private setCursor;
     private dragNode;
+    private updateMaxNodePriority;
+    private moveNodeOnTop;
 }
 
 export declare class UserTransformableCanvas implements Canvas {
     private readonly canvas;
     private readonly options?;
+    readonly model: PublicGraphStore;
     readonly transformation: PublicViewportTransformer;
     private element;
     private isMoving;
@@ -605,7 +691,6 @@ export declare class UserTransformableCanvas implements Canvas {
     removeEdge(edgeId: unknown): UserTransformableCanvas;
     patchViewportState(request: PatchViewportRequest): UserTransformableCanvas;
     moveToNodes(nodeIds: readonly string[]): UserTransformableCanvas;
-    moveNodeOnTop(nodeId: string): UserTransformableCanvas;
     clear(): UserTransformableCanvas;
     attach(element: HTMLElement): UserTransformableCanvas;
     detach(): UserTransformableCanvas;
@@ -616,7 +701,7 @@ export declare class UserTransformableCanvas implements Canvas {
     private scaleViewport;
 }
 
-export declare class VerticalEdgeController implements EdgeController {
+export declare class VerticalEdgeShape implements EdgeController {
     private readonly color;
     private readonly width;
     private readonly arrowLength;
@@ -632,7 +717,7 @@ export declare class VerticalEdgeController implements EdgeController {
     update(x: number, y: number, width: number, height: number, from: PortPayload, to: PortPayload): void;
 }
 
-declare interface VerticalEdgeOptions {
+declare interface VerticalEdgeShape_2 {
     readonly type: "vertical";
     readonly color?: string;
     readonly width?: number;