@deck.gl-community/graph-layers 9.0.2 → 9.1.0-beta.3

package/LICENSE

@@ -1,5 +1,5 @@
 Copyright (c) 2015 - 2021 Uber Technologies, Inc.
-Copyright (c) 2022 - 2023 react-graph-layers contributors
+Copyright (c) 2022 - 2023 vis.gl contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/core/graph-engine.d.ts

@@ -1,18 +1,27 @@
-import { BaseLayout } from "./base-layout.js";
-import { Edge } from "./edge.js";
-import { Graph } from "./graph.js";
+import type { Node } from "../graph/node.js";
+import { Edge } from "../graph/edge.js";
+import { Graph } from "../graph/graph.js";
+import { GraphLayout } from "./graph-layout.js";
+export type GraphEngineProps = {
+    graph: Graph;
+    layout: GraphLayout;
+};
+/** Graph engine controls the graph data and layout calculation */
 export declare class GraphEngine extends EventTarget {
+    props: Readonly<Required<GraphEngineProps>>;
     private readonly _graph;
     private readonly _layout;
     private readonly _cache;
     private _layoutDirty;
     private _transactionInProgress;
-    constructor(graph: Graph, layout: BaseLayout);
+    constructor(props: GraphEngineProps);
+    /** @deprecated Use props constructor: new GraphEngine(props) */
+    constructor(graph: Graph, layout: GraphLayout);
     /** Getters */
     getNodes: () => Node[];
     getEdges: () => Edge[];
-    getNodePosition: (node: any) => [number, number];
-    getEdgePosition: (edge: any) => {
+    getNodePosition: (node: Node) => [number, number];
+    getEdgePosition: (edge: Edge) => {
         type: string;
         sourcePosition: number[];
         targetPosition: number[];
@@ -20,7 +29,7 @@ export declare class GraphEngine extends EventTarget {
     };
     getGraphVersion: () => number;
     getLayoutLastUpdate: () => number;
-    getLayoutState: () => string;
+    getLayoutState: () => import("./graph-layout").GraphLayoutState;
     /** Operations on the graph */
     lockNodePosition: (node: any, x: any, y: any) => void;
     unlockNodePosition: (node: any) => void;

package/dist/core/graph-engine.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"graph-engine.d.ts","sourceRoot":"","sources":["../../src/core/graph-engine.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,UAAU,EAAC,yBAAsB;AAEzC,OAAO,EAAC,IAAI,EAAC,kBAAe;AAC5B,OAAO,EAAC,KAAK,EAAC,mBAAgB;AAG9B,qBAAa,WAAY,SAAQ,WAAW;IAC1C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,sBAAsB,CAAS;gBAE3B,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU;IAM5C,cAAc;IAEd,QAAQ,QAAO,IAAI,EAAE,CAMnB;IAEF,QAAQ,QAK6B,IAAI,EAAE,CACzC;IAEF,eAAe,kCAAgD;IAE/D,eAAe;;;;;MAAgD;IAE/D,eAAe,eAA6B;IAE5C,mBAAmB,eAA8B;IAEjD,cAAc,eAA4B;IAE1C,8BAA8B;IAE9B,gBAAgB,sCAA6D;IAE7E,kBAAkB,sBAAmD;IAErE;;OAEG;IACH,cAAc,aAMZ;IAEF;;OAEG;IACH,eAAe,aAMb;IAEF;;OAEG;IACH,aAAa,aAMX;IAEF;;OAEG;IACH,cAAc,aAMZ;IAEF,wBAAwB,wBAGtB;IAEF,mBAAmB,aAEjB;IAEF,iBAAiB,aAGf;IAEF,0BAA0B;IAE1B,GAAG,aAiBD;IAEF,KAAK,aAYH;IAEF,MAAM,aAA+B;IAErC,IAAI,aAA6B;IAEjC,aAAa,aAIX;IAEF,aAAa,aAIX;IAEF,YAAY,CAAC,GAAG,KAAA,EAAE,WAAW,KAAA;CAG9B"}
+{"version":3,"file":"graph-engine.d.ts","sourceRoot":"","sources":["../../src/core/graph-engine.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,IAAI,EAAC,yBAAsB;AACxC,OAAO,EAAC,IAAI,EAAC,yBAAsB;AACnC,OAAO,EAAC,KAAK,EAAC,0BAAuB;AACrC,OAAO,EAAC,WAAW,EAAC,0BAAuB;AAG3C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF,kEAAkE;AAClE,qBAAa,WAAY,SAAQ,WAAW;IAC1C,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAE5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;IACtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,sBAAsB,CAAS;gBAE3B,KAAK,EAAE,gBAAgB;IACnC,gEAAgE;gBACpD,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW;IAgB7C,cAAc;IAEd,QAAQ,QAAO,IAAI,EAAE,CAMnB;IAEF,QAAQ,QAK6B,IAAI,EAAE,CACzC;IAEF,eAAe,SAAU,IAAI,sBAAwC;IAErE,eAAe,SAAU,IAAI;;;;;MAAwC;IAErE,eAAe,eAA6B;IAE5C,mBAAmB,eAA8B;IAEjD,cAAc,kDAA4B;IAE1C,8BAA8B;IAE9B,gBAAgB,sCAA6D;IAE7E,kBAAkB,sBAAmD;IAErE;;OAEG;IACH,cAAc,aAMZ;IAEF;;OAEG;IACH,eAAe,aAMb;IAEF;;OAEG;IACH,aAAa,aAMX;IAEF;;OAEG;IACH,cAAc,aAMZ;IAEF,wBAAwB,wBAGtB;IAEF,mBAAmB,aAEjB;IAEF,iBAAiB,aAGf;IAEF,0BAA0B;IAE1B,GAAG,aAiBD;IAEF,KAAK,aAYH;IAEF,MAAM,aAA+B;IAErC,IAAI,aAA6B;IAEjC,aAAa,aAIX;IAEF,aAAa,aAIX;IAEF,YAAY,CAAC,GAAG,KAAA,EAAE,WAAW,KAAA;CAG9B"}

package/dist/core/graph-engine.js

@@ -1,18 +1,27 @@
 // deck.gl-community
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
+import { Graph } from "../graph/graph.js";
 import { Cache } from "./cache.js";
-// Graph engine controls the graph data and layout calculation
+/** Graph engine controls the graph data and layout calculation */
 export class GraphEngine extends EventTarget {
+    props;
     _graph;
     _layout;
     _cache = new Cache();
     _layoutDirty = false;
     _transactionInProgress = false;
-    constructor(graph, layout) {
+    constructor(props, layout) {
         super();
-        this._graph = graph;
-        this._layout = layout;
+        if (props instanceof Graph) {
+            props = {
+                graph: props,
+                layout
+            };
+        }
+        this.props = props;
+        this._graph = props.graph;
+        this._layout = props.layout;
     }
     /** Getters */
     getNodes = () => {

package/dist/core/graph-layout.d.ts

@@ -0,0 +1,69 @@
+import type { Graph } from "../graph/graph.js";
+import type { Node } from "../graph/node.js";
+import type { Edge } from "../graph/edge.js";
+export type GraphLayoutState = 'INIT' | 'START' | 'CALCULATING' | 'DONE' | 'ERROR';
+export type GraphLayoutOptions = {};
+/** All the layout classes are extended from this base layout class. */
+export declare class GraphLayout<OptionsT extends GraphLayoutOptions = GraphLayoutOptions> extends EventTarget {
+    /** Name of the layout. */
+    protected readonly _name: string;
+    /** Extra configuration options of the layout. */
+    protected _options: OptionsT;
+    version: number;
+    state: GraphLayoutState;
+    /**
+     * Constructor of GraphLayout
+     * @param options extra configuration options of the layout
+     */
+    constructor(options: OptionsT);
+    /**
+     * Check the equality of two layouts
+     * @param layout - The layout to be compared.
+     * @return - True if the layout is the same as itself.
+     */
+    equals(layout: GraphLayout): boolean;
+    /** virtual functions: will be implemented in the child class */
+    /** first time to pass the graph data into this layout */
+    initializeGraph(graph: Graph): void;
+    /** update the existing graph */
+    updateGraph(graph: Graph): void;
+    /** start the layout calculation */
+    start(): void;
+    /** update the layout calculation */
+    update(): void;
+    /** resume the layout calculation */
+    resume(): void;
+    /** stop the layout calculation */
+    stop(): void;
+    /** access the position of the node in the layout */
+    getNodePosition(node: Node): [number, number];
+    /** access the layout information of the edge */
+    getEdgePosition(edge: Edge): {
+        type: string;
+        sourcePosition: number[];
+        targetPosition: number[];
+        controlPoints: any[];
+    };
+    /**
+     * Pin the node to a designated position, and the node won't move anymore
+     * @param  node Node to be locked
+     * @param  x    x coordinate
+     * @param  y    y coordinate
+     */
+    lockNodePosition(node: Node, x: number, y: number): void;
+    /**
+     * Unlock the node, the node will be able to move freely.
+     * @param  {Object} node Node to be unlocked
+     */
+    unlockNodePosition(node: Node): void;
+    protected _updateState(state: any): void;
+    /** @fires GraphLayout#onLayoutStart */
+    protected _onLayoutStart: () => void;
+    /** @fires GraphLayout#onLayoutChange */
+    protected _onLayoutChange: () => void;
+    /** @fires GraphLayout#onLayoutDone */
+    protected _onLayoutDone: () => void;
+    /** @fires GraphLayout#onLayoutError */
+    protected _onLayoutError: () => void;
+}
+//# sourceMappingURL=graph-layout.d.ts.map

package/dist/core/graph-layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph-layout.d.ts","sourceRoot":"","sources":["../../src/core/graph-layout.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,KAAK,EAAC,0BAAuB;AAC1C,OAAO,KAAK,EAAC,IAAI,EAAC,yBAAsB;AACxC,OAAO,KAAK,EAAC,IAAI,EAAC,yBAAsB;AAMxC,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,GAAG,aAAa,GAAG,MAAM,GAAG,OAAO,CAAC;AAEnF,MAAM,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAEpC,uEAAuE;AACvE,qBAAa,WAAW,CACtB,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB,CACxD,SAAQ,WAAW;IACnB,0BAA0B;IAC1B,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAiB;IACjD,iDAAiD;IACjD,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAEtB,OAAO,SAAK;IACZ,KAAK,EAAE,gBAAgB,CAAU;IAExC;;;OAGG;gBACS,OAAO,EAAE,QAAQ;IAK7B;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO;IAOpC,gEAAgE;IAEhE,yDAAyD;IACzD,eAAe,CAAC,KAAK,EAAE,KAAK;IAC5B,gCAAgC;IAChC,WAAW,CAAC,KAAK,EAAE,KAAK;IACxB,mCAAmC;IACnC,KAAK;IACL,oCAAoC;IACpC,MAAM;IACN,oCAAoC;IACpC,MAAM;IACN,kCAAkC;IAClC,IAAI;IACJ,oDAAoD;IACpD,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAG7C,gDAAgD;IAChD,eAAe,CAAC,IAAI,EAAE,IAAI;;;;;;IAS1B;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAEjD;;;OAGG;IACH,kBAAkB,CAAC,IAAI,EAAE,IAAI;IAI7B,SAAS,CAAC,YAAY,CAAC,KAAK,KAAA;IAK5B,uCAAuC;IACvC,SAAS,CAAC,cAAc,QAAO,IAAI,CASjC;IAEF,wCAAwC;IACxC,SAAS,CAAC,eAAe,QAAO,IAAI,CASlC;IAEF,sCAAsC;IACtC,SAAS,CAAC,aAAa,QAAO,IAAI,CAShC;IAEF,uCAAuC;IACvC,SAAS,CAAC,cAAc,QAAO,IAAI,CASjC;CACH"}

package/dist/core/{base-layout.js → graph-layout.js}

@@ -2,110 +2,52 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 import isEqual from 'lodash.isequal';
-import { EDGE_TYPE, LAYOUT_STATE } from "./constants.js";
-/**
- * All the layout classes are extended from this base layout class.
- */
-export class BaseLayout extends EventTarget {
+import { EDGE_TYPE } from "./constants.js";
+/** All the layout classes are extended from this base layout class. */
+export class GraphLayout extends EventTarget {
     /** Name of the layout. */
-    _name = 'BaseLayout';
+    _name = 'GraphLayout';
     /** Extra configuration options of the layout. */
     _options;
     version = 0;
-    state = LAYOUT_STATE.INIT;
+    state = 'INIT';
     /**
-     * Constructor of BaseLayout
-     * @param  {Object} options extra configuration options of the layout
+     * Constructor of GraphLayout
+     * @param options extra configuration options of the layout
      */
-    constructor(options = {}) {
+    constructor(options) {
         super();
         this._options = options;
     }
-    /**
-     * @fires BaseLayout#onLayoutStart
-     * @protected
-     */
-    _onLayoutStart() {
-        this._updateState(LAYOUT_STATE.CALCULATING);
-        /**
-         * Layout calculation start.
-         *
-         * @event BaseLayout#onLayoutChange
-         * @type {CustomEvent}
-         */
-        this.dispatchEvent(new CustomEvent('onLayoutStart'));
-    }
-    /**
-     * @fires BaseLayout#onLayoutChange
-     * @protected
-     */
-    _onLayoutChange() {
-        this._updateState(LAYOUT_STATE.CALCULATING);
-        /**
-         * Layout calculation iteration.
-         *
-         * @event BaseLayout#onLayoutChange
-         * @type {CustomEvent}
-         */
-        this.dispatchEvent(new CustomEvent('onLayoutChange'));
-    }
-    /**
-     * @fires BaseLayout#onLayoutDone
-     * @protected
-     */
-    _onLayoutDone() {
-        this._updateState(LAYOUT_STATE.DONE);
-        /**
-         * Layout calculation is done.
-         *
-         * @event BaseLayout#onLayoutDone
-         * @type {CustomEvent}
-         */
-        this.dispatchEvent(new CustomEvent('onLayoutDone'));
-    }
-    /**
-     * @fires BaseLayout#onLayoutError
-     * @protected
-     */
-    _onLayoutError() {
-        this._updateState(LAYOUT_STATE.ERROR);
-        /**
-         * Layout calculation went wrong.
-         *
-         * @event BaseLayout#onLayoutError
-         * @type {CustomEvent}
-         */
-        this.dispatchEvent(new CustomEvent('onLayoutError'));
-    }
     /**
      * Check the equality of two layouts
-     * @param  {Object} layout The layout to be compared.
-     * @return {Bool}   True if the layout is the same as itself.
+     * @param layout - The layout to be compared.
+     * @return - True if the layout is the same as itself.
      */
     equals(layout) {
-        if (!layout || !(layout instanceof BaseLayout)) {
+        if (!layout || !(layout instanceof GraphLayout)) {
             return false;
         }
         return this._name === layout._name && isEqual(this._options, layout._options);
     }
     /** virtual functions: will be implemented in the child class */
-    // first time to pass the graph data into this layout
+    /** first time to pass the graph data into this layout */
     initializeGraph(graph) { }
-    // update the existing graph
+    /** update the existing graph */
     updateGraph(graph) { }
-    // start the layout calculation
+    /** start the layout calculation */
     start() { }
-    // update the layout calculation
+    /** update the layout calculation */
     update() { }
-    // resume the layout calculation
+    /** resume the layout calculation */
     resume() { }
-    // stop the layout calculation
+    /** stop the layout calculation */
     stop() { }
-    // access the position of the node in the layout
+    /** access the position of the node in the layout */
     getNodePosition(node) {
         return [0, 0];
     }
-    // access the layout information of the edge
+    /** access the layout information of the edge */
     getEdgePosition(edge) {
         return {
             type: EDGE_TYPE.LINE,
@@ -116,9 +58,9 @@ export class BaseLayout extends EventTarget {
     }
     /**
      * Pin the node to a designated position, and the node won't move anymore
-     * @param  {Object} node Node to be locked
-     * @param  {Number} x    x coordinate
-     * @param  {Number} y    y coordinate
+     * @param  node Node to be locked
+     * @param  x    x coordinate
+     * @param  y    y coordinate
      */
     lockNodePosition(node, x, y) { }
     /**
@@ -126,8 +68,49 @@ export class BaseLayout extends EventTarget {
      * @param  {Object} node Node to be unlocked
      */
     unlockNodePosition(node) { }
+    // INTERNAL METHODS
     _updateState(state) {
         this.state = state;
         this.version += 1;
     }
+    /** @fires GraphLayout#onLayoutStart */
+    _onLayoutStart = () => {
+        this._updateState('CALCULATING');
+        /**
+         * Layout calculation start.
+         * @event GraphLayout#onLayoutChange
+         * @type {CustomEvent}
+         */
+        this.dispatchEvent(new CustomEvent('onLayoutStart'));
+    };
+    /** @fires GraphLayout#onLayoutChange */
+    _onLayoutChange = () => {
+        this._updateState('CALCULATING');
+        /**
+         * Layout calculation iteration.
+         * @event GraphLayout#onLayoutChange
+         * @type {CustomEvent}
+         */
+        this.dispatchEvent(new CustomEvent('onLayoutChange'));
+    };
+    /** @fires GraphLayout#onLayoutDone */
+    _onLayoutDone = () => {
+        this._updateState('DONE');
+        /**
+         * Layout calculation is done.
+         * @event GraphLayout#onLayoutDone
+         * @type {CustomEvent}
+         */
+        this.dispatchEvent(new CustomEvent('onLayoutDone'));
+    };
+    /** @fires GraphLayout#onLayoutError */
+    _onLayoutError = () => {
+        this._updateState('ERROR');
+        /**
+         * Layout calculation went wrong.
+         * @event GraphLayout#onLayoutError
+         * @type {CustomEvent}
+         */
+        this.dispatchEvent(new CustomEvent('onLayoutError'));
+    };
 }

package/dist/core/interaction-manager.d.ts

@@ -1,5 +1,5 @@
+import { Node } from "../graph/node.js";
 import { GraphEngine } from "./graph-engine.js";
-import { Node } from "./node.js";
 interface EventMap {
     onClick?: (info: unknown, event: Event) => void;
     onHover?: (info: unknown) => void;

package/dist/core/interaction-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interaction-manager.d.ts","sourceRoot":"","sources":["../../src/core/interaction-manager.ts"],"names":[],"mappings":"AAMA,OAAO,EAAC,WAAW,EAAC,0BAAuB;AAC3C,OAAO,EAAC,IAAI,EAAC,kBAAe;AA8B5B,UAAU,QAAQ;IAChB,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAChD,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IAClC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IACpC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACtC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACjC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,MAAM,EAAE,WAAW,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,yBAAyB,EAAE,OAAO,CAAC;CACpC;AAED,qBAAa,kBAAkB;IACtB,cAAc,EAAE,QAAQ,CAAC;IAChC,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,iBAAiB,CAAqB;IAEvC,UAAU,EAAE,QAAQ,CAAc;IAClC,UAAU,EAAE,QAAQ,CAAc;IAClC,MAAM,EAAE,WAAW,CAAc;IACjC,cAAc,EAAE,OAAO,CAAc;IACrC,yBAAyB,EAAE,OAAO,CAAc;gBAE3C,KAAK,EAAE,uBAAuB,EAAE,cAAc,EAAE,QAAQ;IAUpE,WAAW,CAAC,EACV,UAAe,EACf,UAAe,EACf,MAAM,EACN,cAAc,EACd,yBAAyB,EAC1B,EAAE,uBAAuB,GAAG,IAAI;IAQjC,kBAAkB,IAAI,MAAM;IAI5B,OAAO,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA,GAAG,IAAI;IA4B1B,eAAe,IAAI,IAAI;IAiBvB,eAAe,CAAC,IAAI,KAAA,GAAG,IAAI;IAY3B,OAAO,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA;IAiCnB,WAAW,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA;IAMvB,MAAM,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA;IAuBlB,SAAS,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA;CAUtB"}
+{"version":3,"file":"interaction-manager.d.ts","sourceRoot":"","sources":["../../src/core/interaction-manager.ts"],"names":[],"mappings":"AAMA,OAAO,EAAC,IAAI,EAAC,yBAAsB;AACnC,OAAO,EAAC,WAAW,EAAC,0BAAuB;AA8B3C,UAAU,QAAQ;IAChB,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAChD,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IAClC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IACpC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACtC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACjC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,MAAM,EAAE,WAAW,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,yBAAyB,EAAE,OAAO,CAAC;CACpC;AAED,qBAAa,kBAAkB;IACtB,cAAc,EAAE,QAAQ,CAAC;IAChC,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,iBAAiB,CAAqB;IAEvC,UAAU,EAAE,QAAQ,CAAc;IAClC,UAAU,EAAE,QAAQ,CAAc;IAClC,MAAM,EAAE,WAAW,CAAc;IACjC,cAAc,EAAE,OAAO,CAAc;IACrC,yBAAyB,EAAE,OAAO,CAAc;gBAE3C,KAAK,EAAE,uBAAuB,EAAE,cAAc,EAAE,QAAQ;IAUpE,WAAW,CAAC,EACV,UAAe,EACf,UAAe,EACf,MAAM,EACN,cAAc,EACd,yBAAyB,EAC1B,EAAE,uBAAuB,GAAG,IAAI;IAQjC,kBAAkB,IAAI,MAAM;IAI5B,OAAO,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA,GAAG,IAAI;IA4B1B,eAAe,IAAI,IAAI;IAiBvB,eAAe,CAAC,IAAI,KAAA,GAAG,IAAI;IAY3B,OAAO,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA;IAiCnB,WAAW,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA;IAMvB,MAAM,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA;IAuBlB,SAAS,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA;CAUtB"}

package/dist/{core → graph}/edge.d.ts

@@ -1,11 +1,17 @@
 import { Node } from "./node.js";
-interface EdgeOptions {
+export interface EdgeOptions {
+    /** the unique ID of the edge */
     id: string | number;
+    /** the ID of the source node */
     sourceId: string | number;
+    /** the ID of the target node */
     targetId: string | number;
+    /** whether the edge is directed or not */
     directed?: boolean;
-    data: Record<string, unknown>;
+    /** origin data reference */
+    data?: Record<string, unknown>;
 }
+/** Basic edge data structure */
 export declare class Edge {
     /** Unique uuid of the edge. */
     id: string | number;
@@ -25,11 +31,7 @@ export declare class Edge {
     state: string;
     /**
      * The constructor
-     * @param  {String|Number} options.id - the unique ID of the edge
-     * @param  {String|Number} options.sourceId - the ID of the source node
-     * @param  {String|Number} options.targetId - the ID of the target node
-     * @param  {Boolean} options.directed - whether the edge is directed or not
-     * @param  {Record<string, unknown>} options.data - origin data reference
+     * @param options.id - information about the edge
      */
     constructor({ id, sourceId, targetId, data, directed }: EdgeOptions);
     /**
@@ -44,44 +46,43 @@ export declare class Edge {
     isDirected(): boolean;
     /**
      * Get the ID of the source node.
-     * @return {String|Number} the ID of the source node.
+     * @return the ID of the source node.
      */
     getSourceNodeId(): string | number;
     /**
      * Get the ID of the target node.
-     * @return {String|Number} the ID of the target node.
+     * @return the ID of the target node.
      */
     getTargetNodeId(): string | number;
     /**
      * Return of the value of the selected property key.
-     * @param  {String} key - property key.
-     * @return {Any} - the value of the property.
+     * @param  key - property key.
+     * @return - the value of the property.
      */
     getPropertyValue(key: string): unknown;
     /**
      * Set the origin data as a reference.
-     * @param {Object} data - the origin data.
+     * @param data - the origin data.
      */
     setData(data: Record<string, unknown>): void;
     /**
      * Update a data property.
-     * @param {String} key - the key of the property
-     * @param {Any} value - the value of the property.
+     * @param key - the key of the property
+     * @param value - the value of the property.
      */
     setDataProperty(key: string, value: unknown): void;
     /**
      * Set edge state
-     * @param {String} state - one of EDGE_STATE
+     * @param state - one of EDGE_STATE
      */
     setState(state: string): void;
     /**
      * Get edge state
-     * @returns {string} state - one of EDGE_STATE
+     * @returns state - one of EDGE_STATE
      */
     getState(): string;
     addNode(node: Node): void;
     removeNode(node: Node): void;
     getConnectedNodes(): Node[];
 }
-export {};
 //# sourceMappingURL=edge.d.ts.map

package/dist/graph/edge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"edge.d.ts","sourceRoot":"","sources":["../../src/graph/edge.ts"],"names":[],"mappings":"AAMA,OAAO,EAAC,IAAI,EAAC,kBAAe;AAE5B,MAAM,WAAW,WAAW;IAC1B,gCAAgC;IAChC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IACpB,gCAAgC;IAChC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,gCAAgC;IAChC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,gCAAgC;AAChC,qBAAa,IAAI;IACf,+BAA+B;IACxB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,6BAA6B;IAC7B,OAAO,CAAC,SAAS,CAAkB;IACnC,6BAA6B;IAC7B,OAAO,CAAC,SAAS,CAAkB;IACnC,2CAA2C;IAC3C,OAAO,CAAC,SAAS,CAAU;IAC3B,yCAAyC;IACzC,OAAO,CAAC,KAAK,CAA0B;IACvC,gEAAgE;IAChE,SAAgB,MAAM,QAAQ;IAC9B,wCAAwC;IACxC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA4B;IAC5D,kBAAkB;IACX,KAAK,SAAsB;IAElC;;;OAGG;gBACS,EAAC,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAgB,EAAC,EAAE,WAAW;IAQzE;;;OAGG;IACH,KAAK,IAAI,MAAM,GAAG,MAAM;IAIxB;;;OAGG;IACH,UAAU,IAAI,OAAO;IAIrB;;;OAGG;IACH,eAAe,IAAI,MAAM,GAAG,MAAM;IAIlC;;;OAGG;IACH,eAAe,IAAI,MAAM,GAAG,MAAM;IAIlC;;;;OAIG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAatC;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAI5C;;;;OAIG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAIlD;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI7B;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAIlB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAIzB,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAI5B,iBAAiB,IAAI,IAAI,EAAE;CAG5B"}

package/dist/{core → graph}/edge.js

@@ -2,7 +2,8 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 // Basic data structure of an edge
-import { EDGE_STATE } from "./constants.js";
+import { EDGE_STATE } from "../core/constants.js";
+/** Basic edge data structure */
 export class Edge {
     /** Unique uuid of the edge. */
     id;
@@ -22,11 +23,7 @@ export class Edge {
     state = EDGE_STATE.DEFAULT;
     /**
      * The constructor
-     * @param  {String|Number} options.id - the unique ID of the edge
-     * @param  {String|Number} options.sourceId - the ID of the source node
-     * @param  {String|Number} options.targetId - the ID of the target node
-     * @param  {Boolean} options.directed - whether the edge is directed or not
-     * @param  {Record<string, unknown>} options.data - origin data reference
+     * @param options.id - information about the edge
      */
     constructor({ id, sourceId, targetId, data, directed = false }) {
         this.id = id;
@@ -51,22 +48,22 @@ export class Edge {
     }
     /**
      * Get the ID of the source node.
-     * @return {String|Number} the ID of the source node.
+     * @return the ID of the source node.
      */
     getSourceNodeId() {
         return this._sourceId;
     }
     /**
      * Get the ID of the target node.
-     * @return {String|Number} the ID of the target node.
+     * @return the ID of the target node.
      */
     getTargetNodeId() {
         return this._targetId;
     }
     /**
      * Return of the value of the selected property key.
-     * @param  {String} key - property key.
-     * @return {Any} - the value of the property.
+     * @param  key - property key.
+     * @return - the value of the property.
      */
     getPropertyValue(key) {
         // try to search the key within this object
@@ -82,29 +79,29 @@ export class Edge {
     }
     /**
      * Set the origin data as a reference.
-     * @param {Object} data - the origin data.
+     * @param data - the origin data.
      */
     setData(data) {
         this._data = data;
     }
     /**
      * Update a data property.
-     * @param {String} key - the key of the property
-     * @param {Any} value - the value of the property.
+     * @param key - the key of the property
+     * @param value - the value of the property.
      */
     setDataProperty(key, value) {
         this._data[key] = value;
     }
     /**
      * Set edge state
-     * @param {String} state - one of EDGE_STATE
+     * @param state - one of EDGE_STATE
      */
     setState(state) {
         this.state = state;
     }
     /**
      * Get edge state
-     * @returns {string} state - one of EDGE_STATE
+     * @returns state - one of EDGE_STATE
      */
     getState() {
         return this.state;