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

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

@@ -1,5 +1,11 @@
 import { Edge } from "./edge.js";
 import { Node } from "./node.js";
+export type GraphProps = {
+    name?: string;
+    nodes?: Node[];
+    edges?: Edge[];
+};
+/** Basic graph data structure */
 export declare class Graph extends EventTarget {
     /** List object of nodes. */
     private _nodeMap;
@@ -14,33 +20,30 @@ export declare class Graph extends EventTarget {
     version: number;
     /** Cached data: create array data from maps. */
     private _cache;
-    /**
-     * The constructor of the Graph class.
-     * @param  {Object} graph - copy the graph if this exists.
-     */
-    constructor(graph?: Graph | null);
+    constructor(props?: GraphProps);
+    constructor(graph: Graph);
     /**
      * Set graph name
-     * @param {string} name
+     * @param name
      */
     setGraphName(name: string): void;
     /** Get the name of the graph. Default value is the time stamp when creating this graph.
-     * @return {string} graph name.
+     * @return graph name.
      */
     getGraphName(): string;
     /**
      * Perform a batch of operations defined by cb before indicating graph is updated
-     * @param {function} cb - a callback fuction containing the operations to perform
+     * @param {function} cb - a callback function containing the operations to perform
      */
     transaction<T>(cb: (...args: unknown[]) => T): T;
     /**
      * Add a new node to the graph.
-     * @param {Node} node - expect a Node object to be added to the graph.
+     * @paramnode - expect a Node object to be added to the graph.
      */
     addNode(node: Node): void;
     /**
      * Batch add nodes to the graph.
-     * @param  {Node[]} nodes - a list of nodes to be added.
+     * @param nodes - a list of nodes to be added.
      */
     batchAddNodes(nodes: Node[]): void;
     /**
@@ -50,48 +53,48 @@ export declare class Graph extends EventTarget {
     getNodes(): Node[];
     /**
      * Get the node map of the graph. The key of the map is the ID of the nodes.
-     * @return {Object} - a map of nodes keyed by node IDs.
+     * @return - a map of nodes keyed by node IDs.
      */
     getNodeMap(): Record<string | number, Node>;
     /**
      * Find a node by id
-     * @param  {String} nodeId The id of the node
-     * @return {Object} Node
+     * @param nodeId The id of the node
+     * @return  Node
      */
     findNode(nodeId: string | number): Node | undefined;
     /**
      * Update the indicated node to the provided value
-     * @param {Node} node
+     * @param node
      */
     updateNode(node: Node): void;
     /**
      * Add a new edge to the graph.
-     * @param {Edge} edge - expect a Edge object to be added to the graph.
+     * @param edge - expect a Edge object to be added to the graph.
      */
     addEdge(edge: Edge): void;
     /**
      * Batch add edges to the graph
-     * @param  {Edge[]} edges - a list of edges to be added.
+     * @param edges - a list of edges to be added.
      */
     batchAddEdges(edges: Edge[]): void;
     /**
      * Update the indicated edge to the provided value
-     * @param {Edge} edge
+     * @param edge
      */
     updateEdge(edge: Edge): void;
     /**
      * Remove a node from the graph by node ID
-     * @param  {String|Number} nodeId - the ID of the target node.
+     * @param nodeId - the ID of the target node.
      */
     removeNode(nodeId: string | number): void;
     /**
      * Get all the edges of the graph.
-     * @return {Edge[]} get all the edges in the graph.
+     * @return get all the edges in the graph.
      */
     getEdges(): Edge[];
     /**
      * Get the edge map of the graph. The key of the map is the ID of the edges.
-     * @return {Object} - a map of edges keyed by edge IDs.
+     * @return - a map of edges keyed by edge IDs.
      */
     getEdgeMap(): Record<string, Edge>;
     /**
@@ -101,26 +104,26 @@ export declare class Graph extends EventTarget {
     removeEdge(edgeId: string | number): void;
     /**
      * Find the edge by edge ID.
-     * @param  {String|Number} id - the target edge ID
-     * @return {Edge} - the target edge.
+     * @param id - the target edge ID
+     * @return - the target edge.
      */
     findEdge(edgeId: string | number): Edge;
     /**
      * Return all the connected edges of a node by nodeID.
-     * @param  {String|Number} nodeId - the target node ID
-     * @return {Edge[]} - an array of the connected edges.
+     * @param  nodeId - the target node ID
+     * @return - an array of the connected edges.
      */
     getConnectedEdges(nodeId: string | number): Edge[];
     /**
      * Return all the sibling nodes of a node by nodeID.
-     * @param  {String|Number} nodeId - the target node ID
-     * @return {Node[]} - an array of the sibling nodes.
+     * @param nodeId - the target node ID
+     * @return - an array of the sibling nodes.
      */
     getNodeSiblings(nodeId: string | number): Node[];
     /**
      * Get the degree of a node.
-     * @param  {String|Number} nodeId - the target node ID.
-     * @return {Number} - the degree of the node.
+     * @param nodeId - the target node ID.
+     * @return - the degree of the node.
      */
     getDegree(nodeId: string | number): number;
     /**
@@ -146,10 +149,10 @@ export declare class Graph extends EventTarget {
     isEmpty(): boolean;
     /**
      * Check the equality of two graphs data by checking last update time stamp
-     * @param  {Object} g Another graph to be compared against itself
-     * @return {Bool}   True if the graph is the same as itself.
+     * @param graph Another graph to be compared against itself
+     * @return true if the graph is the same as itself.
      */
-    equals(g: Graph): boolean;
+    equals(graph: Graph): boolean;
     _bumpVersion(): void;
     _updateCache(key: 'nodes' | 'edges', updateValue: unknown): void;
 }

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

@@ -0,0 +1 @@
+{"version":3,"file":"graph.d.ts","sourceRoot":"","sources":["../../src/graph/graph.ts"],"names":[],"mappings":"AAMA,OAAO,EAAC,IAAI,EAAC,kBAAe;AAC5B,OAAO,EAAC,IAAI,EAAC,kBAAe;AAE5B,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAChB,CAAC;AAEF,iCAAiC;AACjC,qBAAa,KAAM,SAAQ,WAAW;IACpC,4BAA4B;IAC5B,OAAO,CAAC,QAAQ,CAA4B;IAC5C,4BAA4B;IAC5B,OAAO,CAAC,QAAQ,CAA4B;IAC5C;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAiC;IAC9C,oGAAoG;IAC7F,OAAO,SAAK;IACnB,gDAAgD;IAChD,OAAO,CAAC,MAAM,CAAmD;gBAErD,KAAK,CAAC,EAAE,UAAU;gBAClB,KAAK,EAAE,KAAK;IAwBxB;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIhC;;OAEG;IACH,YAAY,IAAI,MAAM;IAItB;;;OAGG;IACH,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC;IAShD;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAQzB;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI;IAalC;;;OAGG;IACH,QAAQ,IAAI,IAAI,EAAE;IAMlB;;;OAGG;IACH,UAAU,IAAI,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,IAAI,CAAC;IAI3C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;IAInD;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAM5B;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAgBzB;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI;IAKlC;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAM5B;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAgBzC;;;OAGG;IACH,QAAQ,IAAI,IAAI,EAAE;IAMlB;;;OAGG;IACH,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC;IAIlC;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAezC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAIvC;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAAE;IASlD;;;;OAIG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAAE;IAShD;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAS1C;;OAEG;IACH,UAAU,IAAI,IAAI;IAKlB;;OAEG;IACH,UAAU,IAAI,IAAI;IAKlB;;OAEG;IACH,KAAK,IAAI,IAAI;IAMb;;OAEG;IACH,aAAa,IAAI,IAAI;IAIrB;;;OAGG;IACH,OAAO,IAAI,OAAO;IAIlB;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAO7B,YAAY,IAAI,IAAI;IAIpB,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,EAAE,WAAW,EAAE,OAAO,GAAG,IAAI;CAGjE"}

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

@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 import { log } from "../utils/log.js";
-import { Cache } from "./cache.js";
-// Basic graph data structure
+import { Cache } from "../core/cache.js";
+/** Basic graph data structure */
 export class Graph extends EventTarget {
     /** List object of nodes. */
     _nodeMap = {};
@@ -20,34 +20,41 @@ export class Graph extends EventTarget {
     _cache = new Cache();
     /**
      * The constructor of the Graph class.
-     * @param  {Object} graph - copy the graph if this exists.
+     * @param graph - copy the graph if this exists.
      */
-    constructor(graph = null) {
+    constructor(propsOrGraph) {
         super();
-        // copy the graph if it exists in the parameter
-        if (graph) {
-            // start copying the graph
+        if (propsOrGraph instanceof Graph) {
+            // if a Graph instance was supplied, copy the supplied graph into this graph
+            const graph = propsOrGraph;
+            this._name = graph?._name || this._name;
             this._nodeMap = graph._nodeMap;
             this._edgeMap = graph._edgeMap;
-            this._name = graph && graph._name;
+        }
+        else {
+            // If graphProps were supplied, initialize this graph from the supplied props
+            const props = propsOrGraph;
+            this._name = props?.name || this._name;
+            this.batchAddNodes(props?.nodes || []);
+            this.batchAddEdges(props?.edges || []);
         }
     }
     /**
      * Set graph name
-     * @param {string} name
+     * @param name
      */
     setGraphName(name) {
         this._name = name;
     }
     /** Get the name of the graph. Default value is the time stamp when creating this graph.
-     * @return {string} graph name.
+     * @return graph name.
      */
     getGraphName() {
         return this._name.toString();
     }
     /**
      * Perform a batch of operations defined by cb before indicating graph is updated
-     * @param {function} cb - a callback fuction containing the operations to perform
+     * @param {function} cb - a callback function containing the operations to perform
      */
     transaction(cb) {
         try {
@@ -60,7 +67,7 @@ export class Graph extends EventTarget {
     }
     /**
      * Add a new node to the graph.
-     * @param {Node} node - expect a Node object to be added to the graph.
+     * @paramnode - expect a Node object to be added to the graph.
      */
     addNode(node) {
         // add it to the list and map
@@ -71,7 +78,7 @@ export class Graph extends EventTarget {
     }
     /**
      * Batch add nodes to the graph.
-     * @param  {Node[]} nodes - a list of nodes to be added.
+     * @param nodes - a list of nodes to be added.
      */
     batchAddNodes(nodes) {
         // convert an array of objects to an object
@@ -92,22 +99,22 @@ export class Graph extends EventTarget {
     }
     /**
      * Get the node map of the graph. The key of the map is the ID of the nodes.
-     * @return {Object} - a map of nodes keyed by node IDs.
+     * @return - a map of nodes keyed by node IDs.
      */
     getNodeMap() {
         return this._nodeMap;
     }
     /**
      * Find a node by id
-     * @param  {String} nodeId The id of the node
-     * @return {Object} Node
+     * @param nodeId The id of the node
+     * @return  Node
      */
     findNode(nodeId) {
         return this._nodeMap[nodeId];
     }
     /**
      * Update the indicated node to the provided value
-     * @param {Node} node
+     * @param node
      */
     updateNode(node) {
         this._nodeMap[node.getId()] = node;
@@ -116,7 +123,7 @@ export class Graph extends EventTarget {
     }
     /**
      * Add a new edge to the graph.
-     * @param {Edge} edge - expect a Edge object to be added to the graph.
+     * @param edge - expect a Edge object to be added to the graph.
      */
     addEdge(edge) {
         const sourceNode = this.findNode(edge.getSourceNodeId());
@@ -133,7 +140,7 @@ export class Graph extends EventTarget {
     }
     /**
      * Batch add edges to the graph
-     * @param  {Edge[]} edges - a list of edges to be added.
+     * @param edges - a list of edges to be added.
      */
     batchAddEdges(edges) {
         edges.forEach((edge) => this.addEdge(edge));
@@ -141,7 +148,7 @@ export class Graph extends EventTarget {
     }
     /**
      * Update the indicated edge to the provided value
-     * @param {Edge} edge
+     * @param edge
      */
     updateEdge(edge) {
         this._edgeMap[edge.getId()] = edge;
@@ -150,7 +157,7 @@ export class Graph extends EventTarget {
     }
     /**
      * Remove a node from the graph by node ID
-     * @param  {String|Number} nodeId - the ID of the target node.
+     * @param nodeId - the ID of the target node.
      */
     removeNode(nodeId) {
         const node = this.findNode(nodeId);
@@ -169,7 +176,7 @@ export class Graph extends EventTarget {
     }
     /**
      * Get all the edges of the graph.
-     * @return {Edge[]} get all the edges in the graph.
+     * @return get all the edges in the graph.
      */
     getEdges() {
         this._updateCache('edges', () => Object.values(this._edgeMap));
@@ -177,7 +184,7 @@ export class Graph extends EventTarget {
     }
     /**
      * Get the edge map of the graph. The key of the map is the ID of the edges.
-     * @return {Object} - a map of edges keyed by edge IDs.
+     * @return - a map of edges keyed by edge IDs.
      */
     getEdgeMap() {
         return this._edgeMap;
@@ -201,16 +208,16 @@ export class Graph extends EventTarget {
     }
     /**
      * Find the edge by edge ID.
-     * @param  {String|Number} id - the target edge ID
-     * @return {Edge} - the target edge.
+     * @param id - the target edge ID
+     * @return - the target edge.
      */
     findEdge(edgeId) {
         return this._edgeMap[edgeId];
     }
     /**
      * Return all the connected edges of a node by nodeID.
-     * @param  {String|Number} nodeId - the target node ID
-     * @return {Edge[]} - an array of the connected edges.
+     * @param  nodeId - the target node ID
+     * @return - an array of the connected edges.
      */
     getConnectedEdges(nodeId) {
         const node = this.findNode(nodeId);
@@ -222,8 +229,8 @@ export class Graph extends EventTarget {
     }
     /**
      * Return all the sibling nodes of a node by nodeID.
-     * @param  {String|Number} nodeId - the target node ID
-     * @return {Node[]} - an array of the sibling nodes.
+     * @param nodeId - the target node ID
+     * @return - an array of the sibling nodes.
      */
     getNodeSiblings(nodeId) {
         const node = this.findNode(nodeId);
@@ -235,8 +242,8 @@ export class Graph extends EventTarget {
     }
     /**
      * Get the degree of a node.
-     * @param  {String|Number} nodeId - the target node ID.
-     * @return {Number} - the degree of the node.
+     * @param nodeId - the target node ID.
+     * @return - the degree of the node.
      */
     getDegree(nodeId) {
         const node = this.findNode(nodeId);
@@ -283,14 +290,14 @@ export class Graph extends EventTarget {
     }
     /**
      * Check the equality of two graphs data by checking last update time stamp
-     * @param  {Object} g Another graph to be compared against itself
-     * @return {Bool}   True if the graph is the same as itself.
+     * @param graph Another graph to be compared against itself
+     * @return true if the graph is the same as itself.
      */
-    equals(g) {
-        if (!g || !(g instanceof Graph)) {
+    equals(graph) {
+        if (!graph || !(graph instanceof Graph)) {
             return false;
         }
-        return this.version === g.version;
+        return this.version === graph.version;
     }
     _bumpVersion() {
         this.version += 1;

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

@@ -1,11 +1,14 @@
-import { NODE_STATE, ValueOf } from "./constants.js";
+import { NODE_STATE, ValueOf } from "../core/constants.js";
 import { Edge } from "./edge.js";
-interface NodeOptions {
+/** Properties for creating a new node */
+export interface NodeOptions {
+    /** the unique ID of the node */
     id: number | string;
     selectable?: boolean;
     highlightConnectedEdges?: boolean;
-    data: Record<string, unknown>;
+    data?: Record<string, unknown>;
 }
+/** Basic data structure of a node */
 export declare class Node {
     id: string | number;
     /** Keep a reference to origin data. */
@@ -22,13 +25,11 @@ export declare class Node {
     readonly isNode = true;
     /**
      * The constructor of a node
-     * @param  {String|Number} options.id   - the unique ID of the node
-     * @param  {Record<string, unknown>} options.data - origin data reference
      */
     constructor({ id, selectable, highlightConnectedEdges, data }: NodeOptions);
     /**
      * Return the ID of the node
-     * @return {String|Number} - the ID of the node.
+     * @return - the ID of the node.
      */
     getId(): string | number;
     /**
@@ -38,59 +39,59 @@ export declare class Node {
     getDegree(): number;
     /**
      * Return the in-degree of the node.
-     * @return {Number} - the in-degree of the node.
+     * @return - the in-degree of the node.
      */
     getInDegree(): number;
     /**
      * Return the out-degree of the node.
-     * @return {Number} - the out-degree of the node.
+     * @return - the out-degree of the node.
      */
     getOutDegree(): number;
     /**
      * Return all the IDs of the sibling nodes.
-     * @return {String[]} [description]
+     * @return [description]
      */
     getSiblingIds(): (string | number)[];
     /**
      * Return all the connected edges.
-     * @return {Object[]} - an array of the connected edges.
+     * @return - an array of the connected edges.
      */
     getConnectedEdges(): Edge[];
     /**
      * Return of the value of the selected property key.
-     * @param  {String} key - property key.
-     * @return {Any} - the value of the property or undefined (not found).
+     * @param key - property key.
+     * @return - the value of the property or undefined (not found).
      */
     getPropertyValue(key: string): unknown;
     /**
      * Set the new node data.
-     * @param {Record<string, unknown>} data - the new data of the node
+     * @param data - the new data of the node
      */
     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 node state
-     * @param {String} state - one of NODE_STATE
+     * @param state - one of NODE_STATE
      */
     setState(state: ValueOf<typeof NODE_STATE>): void;
     /**
      * Get node state
-     * @returns {string} state - one of NODE_STATE
+     * @returns state - one of NODE_STATE
      */
     getState(): ValueOf<typeof NODE_STATE>;
     /**
      * Add connected edges to the node
-     * @param {Edge || Edge[]} edge an edge or an array of edges to be added to this._connectedEdges
+     * @param edge an edge or an array of edges to be added to this._connectedEdges
      */
     addConnectedEdges(edge: Edge | Edge[]): void;
     /**
      * Remove edges from this._connectedEdges
-     * @param {Edge | Edge[]} edge an edge or an array of edges to be removed from this._connectedEdges
+     * @param edge an edge or an array of edges to be removed from this._connectedEdges
      */
     removeConnectedEdges(edge: Edge | Edge[]): void;
     /**
@@ -100,5 +101,4 @@ export declare class Node {
     isSelectable(): boolean;
     shouldHighlightConnectedEdges(): boolean;
 }
-export {};
 //# sourceMappingURL=node.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../src/graph/node.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,UAAU,EAAE,OAAO,EAAC,6BAA0B;AACtD,OAAO,EAAC,IAAI,EAAC,kBAAe;AAE5B,yCAAyC;AACzC,MAAM,WAAW,WAAW;IAC1B,gCAAgC;IAChC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,qCAAqC;AACrC,qBAAa,IAAI;IACR,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,uCAAuC;IACvC,OAAO,CAAC,KAAK,CAA0B;IACvC,kBAAkB;IAClB,OAAO,CAAC,eAAe,CAA4B;IACnD,qCAAqC;IAC9B,KAAK,EAAE,OAAO,CAAC,OAAO,UAAU,CAAC,CAAsB;IAC9D,gCAAgC;IAChC,OAAO,CAAC,WAAW,CAAU;IAC7B,6EAA6E;IAC7E,OAAO,CAAC,wBAAwB,CAAU;IAC1C,gEAAgE;IAChE,SAAgB,MAAM,QAAQ;IAC9B;;OAEG;gBACS,EAAC,EAAE,EAAE,UAAkB,EAAE,uBAA+B,EAAE,IAAS,EAAC,EAAE,WAAW;IAO7F;;;OAGG;IACH,KAAK,IAAI,MAAM,GAAG,MAAM;IAIxB;;;OAGG;IACH,SAAS,IAAI,MAAM;IAInB;;;OAGG;IACH,WAAW,IAAI,MAAM;IAWrB;;;OAGG;IACH,YAAY,IAAI,MAAM;IAWtB;;;OAGG;IACH,aAAa,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE;IAepC;;;OAGG;IACH,iBAAiB,IAAI,IAAI,EAAE;IAI3B;;;;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,OAAO,CAAC,OAAO,UAAU,CAAC,GAAG,IAAI;IAIjD;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,OAAO,UAAU,CAAC;IAItC;;;OAGG;IACH,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,GAAG,IAAI;IAQ5C;;;OAGG;IACH,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,GAAG,IAAI;IAQ/C;;OAEG;IACH,mBAAmB,IAAI,IAAI;IAK3B,YAAY,IAAI,OAAO;IAIvB,6BAA6B,IAAI,OAAO;CAGzC"}

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

@@ -1,8 +1,8 @@
 // deck.gl-community
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
-import { NODE_STATE } from "./constants.js";
-// Basic data structure of a node
+import { NODE_STATE } from "../core/constants.js";
+/** Basic data structure of a node */
 export class Node {
     id;
     /** Keep a reference to origin data. */
@@ -19,8 +19,6 @@ export class Node {
     isNode = true;
     /**
      * The constructor of a node
-     * @param  {String|Number} options.id   - the unique ID of the node
-     * @param  {Record<string, unknown>} options.data - origin data reference
      */
     constructor({ id, selectable = false, highlightConnectedEdges = false, data = {} }) {
         this.id = id;
@@ -30,7 +28,7 @@ export class Node {
     }
     /**
      * Return the ID of the node
-     * @return {String|Number} - the ID of the node.
+     * @return - the ID of the node.
      */
     getId() {
         return this.id;
@@ -44,7 +42,7 @@ export class Node {
     }
     /**
      * Return the in-degree of the node.
-     * @return {Number} - the in-degree of the node.
+     * @return - the in-degree of the node.
      */
     getInDegree() {
         const nodeId = this.getId();
@@ -58,7 +56,7 @@ export class Node {
     }
     /**
      * Return the out-degree of the node.
-     * @return {Number} - the out-degree of the node.
+     * @return - the out-degree of the node.
      */
     getOutDegree() {
         const nodeId = this.getId();
@@ -72,7 +70,7 @@ export class Node {
     }
     /**
      * Return all the IDs of the sibling nodes.
-     * @return {String[]} [description]
+     * @return [description]
      */
     getSiblingIds() {
         const nodeId = this.getId();
@@ -88,15 +86,15 @@ export class Node {
     }
     /**
      * Return all the connected edges.
-     * @return {Object[]} - an array of the connected edges.
+     * @return - an array of the connected edges.
      */
     getConnectedEdges() {
         return Object.values(this._connectedEdges);
     }
     /**
      * Return of the value of the selected property key.
-     * @param  {String} key - property key.
-     * @return {Any} - the value of the property or undefined (not found).
+     * @param key - property key.
+     * @return - the value of the property or undefined (not found).
      */
     getPropertyValue(key) {
         // try to search the key within this object
@@ -112,36 +110,36 @@ export class Node {
     }
     /**
      * Set the new node data.
-     * @param {Record<string, unknown>} data - the new data of the node
+     * @param data - the new data of the node
      */
     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 node state
-     * @param {String} state - one of NODE_STATE
+     * @param state - one of NODE_STATE
      */
     setState(state) {
         this.state = state;
     }
     /**
      * Get node state
-     * @returns {string} state - one of NODE_STATE
+     * @returns state - one of NODE_STATE
      */
     getState() {
         return this.state;
     }
     /**
      * Add connected edges to the node
-     * @param {Edge || Edge[]} edge an edge or an array of edges to be added to this._connectedEdges
+     * @param edge an edge or an array of edges to be added to this._connectedEdges
      */
     addConnectedEdges(edge) {
         const iterableEdges = Array.isArray(edge) ? edge : [edge];
@@ -152,7 +150,7 @@ export class Node {
     }
     /**
      * Remove edges from this._connectedEdges
-     * @param {Edge | Edge[]} edge an edge or an array of edges to be removed from this._connectedEdges
+     * @param edge an edge or an array of edges to be removed from this._connectedEdges
      */
     removeConnectedEdges(edge) {
         const iterableEdges = Array.isArray(edge) ? edge : [edge];