@html-graph/html-graph 8.17.0 → 8.18.1

package/README.md

@@ -30,9 +30,9 @@ import { CanvasBuilder } from "@html-graph/html-graph";
 const element = document.getElementById("canvas");
 
 const canvas = new CanvasBuilder(element)
-  .enableUserTransformableViewport()
-  .enableUserDraggableNodes()
-  .enableBackground()
+  .enableUserTransformableViewport() // Enables viewport pan and zoom
+  .enableUserDraggableNodes() // Enables draggable nodes
+  .enableBackground() // Renders background
   .build();
 ```
 

package/dist/html-graph.d.ts

@@ -291,17 +291,14 @@ export declare type CenterFn = (width: number, height: number) => Point;
 export declare interface ConnectablePortsConfig {
     readonly edgeShape?: EdgeShapeConfig;
     readonly connectionTypeResolver?: ConnectionTypeResolver;
-    readonly connectionPreprocessor?: ConnectionPreprocessor;
     readonly connectionAllowedVerifier?: ConnectionAllowedVerifier;
+    readonly connectionPreprocessor?: ConnectionPreprocessor;
     readonly mouseDownEventVerifier?: MouseEventVerifier;
     readonly mouseUpEventVerifier?: MouseEventVerifier;
-    readonly dragPortDirection?: number | undefined;
+    readonly dragPortDirection?: DraggingPortDirectionConfig;
     readonly events?: {
         readonly onAfterEdgeCreated?: (edgeId: Identifier) => void;
-        readonly onEdgeCreationInterrupted?: (params: {
-            readonly staticPortId: Identifier;
-            readonly isDirect: boolean;
-        }) => void;
+        readonly onEdgeCreationInterrupted?: (params: EdgeCreationInProgressParams) => void;
         readonly onEdgeCreationPrevented?: (request: AddEdgeRequest) => void;
     };
 }
@@ -380,13 +377,14 @@ declare interface DotsRenderer {
     readonly color?: string;
 }
 
-declare interface DraggableEdgesConfig {
+export declare interface DraggableEdgesConfig {
     readonly connectionPreprocessor?: ConnectionPreprocessor;
     readonly connectionAllowedVerifier?: ConnectionAllowedVerifier;
     readonly mouseDownEventVerifier?: MouseEventVerifier;
     readonly mouseUpEventVerifier?: MouseEventVerifier;
     readonly draggingEdgeResolver?: DraggingEdgeResolver;
     readonly draggingEdgeShape?: EdgeShapeConfig;
+    readonly dragPortDirection?: DraggingPortDirectionConfig;
     readonly events?: {
         readonly onAfterEdgeReattached?: (edgeId: Identifier) => void;
         readonly onEdgeReattachInterrupted?: (edge: GraphEdge & {
@@ -415,6 +413,13 @@ export declare interface DraggableNodesConfig {
 
 export declare type DraggingEdgeResolver = (portId: Identifier) => Identifier | null;
 
+export declare type DraggingPortDirectionConfig = number | undefined | "closest-connectable-port";
+
+export declare interface EdgeCreationInProgressParams {
+    readonly staticPortId: Identifier;
+    readonly isDirect: boolean;
+}
+
 declare interface EdgePath {
     readonly path: string;
     readonly midpoint: Point;
@@ -771,11 +776,7 @@ export declare interface LayoutAlgorithmParams {
     readonly viewport: Viewport;
 }
 
-export declare type LayoutApplyOn = {
-    type: "topologyChangeMacrotask";
-} | {
-    type: "topologyChangeMicrotask";
-} | EventSubject<void>;
+export declare type LayoutApplyOn = TopologyChangeMacrotask | TopologyChangeMicrotask | EventSubject<void>;
 
 export declare interface LayoutConfig {
     readonly algorithm?: LayoutAlgorithmConfig | undefined;
@@ -946,6 +947,18 @@ export declare interface StructuredEdgeShape extends EdgeShape {
     readonly onAfterRender: EventHandler<StructuredEdgeRenderModel>;
 }
 
+/**
+ * @deprecated
+ * use topologyChangeMicrotask instead
+ */
+declare type TopologyChangeMacrotask = {
+    type: "topologyChangeMacrotask";
+};
+
+declare type TopologyChangeMicrotask = {
+    type: "topologyChangeMicrotask";
+};
+
 export declare type TransformDeclaration = {
     readonly a?: number | undefined;
     readonly b?: number | undefined;
@@ -1024,7 +1037,7 @@ declare interface UpdateNodeRequest_2 {
 }
 
 export declare interface UpdatePortRequest {
-    readonly direction?: number;
+    readonly direction?: number | undefined;
 }
 
 declare interface UpdatePortRequest_2 {