@html-graph/html-graph 7.9.0 → 8.1.0

package/dist/html-graph.d.ts

@@ -18,7 +18,7 @@ export declare type AddNodePorts = Iterable<MarkNodePortRequest>;
 
 export declare interface AddNodeRequest {
     readonly id?: Identifier | undefined;
-    readonly element: HTMLElement;
+    readonly element: NodeElement;
     readonly x?: number | null | undefined;
     readonly y?: number | null | undefined;
     readonly ports?: AddNodePorts | undefined;
@@ -28,7 +28,7 @@ export declare interface AddNodeRequest {
 
 declare interface AddNodeRequest_2 {
     readonly id: Identifier;
-    readonly element: HTMLElement;
+    readonly element: NodeElement;
     readonly x: number | null;
     readonly y: number | null;
     readonly centerFn: CenterFn;
@@ -38,16 +38,18 @@ declare interface AddNodeRequest_2 {
 declare interface AddPortRequest {
     readonly id: Identifier;
     readonly nodeId: Identifier;
-    readonly element: HTMLElement;
+    readonly element: PortElement;
     readonly direction: number;
 }
 
 export declare interface AnimatedLayoutAlgorithm {
-    /**
-     * TODO: v8
-     * make single parameter object
-     */
-    calculateNextCoordinates(graph: Graph, dt: number, viewport: Viewport): ReadonlyMap<Identifier, Point>;
+    calculateNextCoordinates(params: AnimatedLayoutAlgorithmParams): ReadonlyMap<Identifier, Point>;
+}
+
+export declare interface AnimatedLayoutAlgorithmParams {
+    readonly graph: Graph;
+    readonly dt: number;
+    readonly viewport: Viewport;
 }
 
 export declare interface AnimatedLayoutConfig {
@@ -62,16 +64,6 @@ export declare interface AnimatedLayoutConfig {
         readonly edgeEquilibriumLength?: number;
         readonly edgeStiffness?: number;
         readonly seed?: string;
-        /**
-         * @deprecated
-         * use convergenceVelocity instead
-         */
-        readonly effectiveDistance?: number;
-        /**
-         * @deprecated
-         * use convergenceVelocity instead
-         */
-        readonly convergenceDelta?: number;
         readonly convergenceVelocity?: number;
         readonly maxForce?: number;
         readonly nodeForceCoefficient?: number;
@@ -561,35 +553,25 @@ export declare class Graph {
     readonly onBeforeClear: EventHandler<void>;
     constructor(graphStore: GraphStore);
     hasNode(nodeId: Identifier): boolean;
-    getNode(nodeId: Identifier): GraphNode | null;
-    findNodeIdByElement(element: HTMLElement): Identifier | null;
-    /**
-     * @deprecated
-     * use findNodeIdByElement instead
-     */
-    getElementNodeId(element: HTMLElement): Identifier | null;
+    getNode(nodeId: Identifier): GraphNode;
+    findNodeIdByElement(element: Element): Identifier | undefined;
     getAllNodeIds(): readonly Identifier[];
     hasPort(portId: Identifier): boolean;
-    getPort(portId: Identifier): GraphPort | null;
+    getPort(portId: Identifier): GraphPort;
     getAllPortIds(): readonly Identifier[];
-    getNodePortIds(nodeId: Identifier): readonly Identifier[] | null;
-    /**
-     * @deprecated
-     * use findPortIdsByElement instead
-     */
-    getElementPortIds(element: HTMLElement): readonly Identifier[];
-    findPortIdsByElement(element: HTMLElement): readonly Identifier[];
+    getNodePortIds(nodeId: Identifier): readonly Identifier[];
+    findPortIdsByElement(element: Element): readonly Identifier[];
     getAllEdgeIds(): readonly Identifier[];
     hasEdge(edgeId: Identifier): boolean;
-    getEdge(edgeId: Identifier): GraphEdge | null;
-    getPortIncomingEdgeIds(portId: Identifier): readonly Identifier[] | null;
-    getPortOutgoingEdgeIds(portId: Identifier): readonly Identifier[] | null;
-    getPortCycleEdgeIds(portId: Identifier): readonly Identifier[] | null;
-    getPortAdjacentEdgeIds(portId: Identifier): readonly Identifier[] | null;
-    getNodeIncomingEdgeIds(nodeId: Identifier): readonly Identifier[] | null;
-    getNodeOutgoingEdgeIds(nodeId: Identifier): readonly Identifier[] | null;
-    getNodeCycleEdgeIds(nodeId: Identifier): readonly Identifier[] | null;
-    getNodeAdjacentEdgeIds(nodeId: Identifier): readonly Identifier[] | null;
+    getEdge(edgeId: Identifier): GraphEdge;
+    getPortIncomingEdgeIds(portId: Identifier): readonly Identifier[];
+    getPortOutgoingEdgeIds(portId: Identifier): readonly Identifier[];
+    getPortCycleEdgeIds(portId: Identifier): readonly Identifier[];
+    getPortAdjacentEdgeIds(portId: Identifier): readonly Identifier[];
+    getNodeIncomingEdgeIds(nodeId: Identifier): readonly Identifier[];
+    getNodeOutgoingEdgeIds(nodeId: Identifier): readonly Identifier[];
+    getNodeCycleEdgeIds(nodeId: Identifier): readonly Identifier[];
+    getNodeAdjacentEdgeIds(nodeId: Identifier): readonly Identifier[];
 }
 
 export declare interface GraphEdge {
@@ -600,7 +582,7 @@ export declare interface GraphEdge {
 }
 
 export declare interface GraphNode {
-    readonly element: HTMLElement;
+    readonly element: NodeElement;
     readonly x: number | null;
     readonly y: number | null;
     readonly centerFn: CenterFn;
@@ -608,7 +590,7 @@ export declare interface GraphNode {
 }
 
 export declare interface GraphPort {
-    readonly element: HTMLElement;
+    readonly element: PortElement;
     readonly direction: number;
     readonly nodeId: Identifier;
 }
@@ -650,34 +632,22 @@ declare class GraphStore {
     readonly onBeforeClear: EventHandler<void>;
     constructor();
     hasNode(nodeId: Identifier): boolean;
-    /**
-     * TODO: v8
-     * throw error when node does not exist
-     */
-    getNode(nodeId: Identifier): StoreNode | undefined;
+    getNode(nodeId: Identifier): StoreNode;
     addNode(request: AddNodeRequest_2): void;
     getAllNodeIds(): readonly Identifier[];
-    findNodeIdByElement(element: HTMLElement): Identifier | undefined;
+    findNodeIdByElement(element: Element): Identifier | undefined;
     updateNode(nodeId: Identifier, request: UpdateNodeRequest_2): void;
     removeNode(nodeId: Identifier): void;
     hasPort(portId: Identifier): boolean;
-    /**
-     * TODO: v8
-     * throw error when port does not exist
-     */
-    getPort(portId: Identifier): StorePort | undefined;
+    getPort(portId: Identifier): StorePort;
     addPort(request: AddPortRequest): void;
     updatePort(portId: Identifier, request: UpdatePortRequest_2): void;
     getAllPortIds(): readonly Identifier[];
-    findPortIdsByElement(element: HTMLElement): readonly Identifier[];
-    getNodePortIds(nodeId: Identifier): readonly Identifier[] | undefined;
+    findPortIdsByElement(element: Element): readonly Identifier[];
+    getNodePortIds(nodeId: Identifier): readonly Identifier[];
     removePort(portId: Identifier): void;
     hasEdge(edgeId: Identifier): boolean;
-    /**
-     * TODO: v8
-     * throw error when edge does not exist
-     */
-    getEdge(edgeId: Identifier): StoreEdge | undefined;
+    getEdge(edgeId: Identifier): StoreEdge;
     addEdge(request: AddEdgeRequest_2): void;
     updateEdge(edgeId: Identifier, request: UpdateEdgeRequest_2): void;
     getAllEdgeIds(): readonly Identifier[];
@@ -777,11 +747,7 @@ export declare class InteractiveEdgeShape implements StructuredEdgeShape {
 }
 
 export declare interface LayoutAlgorithm {
-    /**
-     * TODO: v8
-     * make single parameter object
-     */
-    calculateCoordinates(graph: Graph, viewport: Viewport): ReadonlyMap<Identifier, Point>;
+    calculateCoordinates(params: LayoutAlgorithmParams): ReadonlyMap<Identifier, Point>;
 }
 
 declare type LayoutAlgorithmConfig = {
@@ -796,16 +762,6 @@ declare type LayoutAlgorithmConfig = {
     readonly nodeMass?: number;
     readonly edgeEquilibriumLength?: number;
     readonly edgeStiffness?: number;
-    /**
-     * @deprecated
-     * use convergenceVelocity instead
-     */
-    readonly effectiveDistance?: number;
-    /**
-     * @deprecated
-     * use convergenceVelocity instead
-     */
-    readonly convergenceDelta?: number;
     readonly convergenceVelocity?: number;
     readonly maxForce?: number;
     readonly nodeForceCoefficient?: number;
@@ -815,13 +771,12 @@ declare type LayoutAlgorithmConfig = {
     };
 };
 
+export declare interface LayoutAlgorithmParams {
+    readonly graph: Graph;
+    readonly viewport: Viewport;
+}
+
 export declare type LayoutApplyOn = {
-    /**
-     * @deprecated
-     * use "topologyChangeMacrotask" instead
-     */
-    type: "topologyChangeTimeout";
-} | {
     type: "topologyChangeMacrotask";
 } | {
     type: "topologyChangeMicrotask";
@@ -834,13 +789,13 @@ export declare interface LayoutConfig {
 
 export declare type MarkNodePortRequest = {
     readonly id?: Identifier | undefined;
-    readonly element: HTMLElement;
+    readonly element: PortElement;
     readonly direction?: number | undefined;
 };
 
 export declare interface MarkPortRequest {
     readonly id?: Identifier | undefined;
-    readonly element: HTMLElement;
+    readonly element: PortElement;
     readonly nodeId: Identifier;
     readonly direction?: number | undefined;
 }
@@ -860,6 +815,8 @@ export declare class MidpointEdgeShape implements StructuredEdgeShape {
 
 export declare type MouseEventVerifier = (event: MouseEvent) => boolean;
 
+export declare type NodeElement = HTMLElement | SVGSVGElement;
+
 export declare interface PatchMatrixRequest {
     readonly scale?: number | undefined;
     readonly x?: number | undefined;
@@ -877,6 +834,8 @@ export declare interface Point {
     readonly y: number;
 }
 
+export declare type PortElement = HTMLElement | SVGElement;
+
 declare type Priority = ConstantPriority | IncrementalPriority | CustomPriority;
 
 export declare type PriorityFn = () => number;
@@ -903,18 +862,18 @@ declare interface StoreEdge {
 }
 
 declare interface StoreNode {
-    readonly element: HTMLElement;
+    readonly element: NodeElement;
     readonly payload: {
         x: number | null;
         y: number | null;
         centerFn: CenterFn;
         priority: number;
     };
-    readonly ports: Map<Identifier, HTMLElement>;
+    readonly ports: Map<Identifier, PortElement>;
 }
 
 declare interface StorePort {
-    readonly element: HTMLElement;
+    readonly element: PortElement;
     readonly payload: {
         direction: number;
     };