Merge pull request #87 from JesusTheHun/new-major-wrap-up

Wrap up details for new major version release

Author: curran

package-lock.json

@@ -3,6 +3,11 @@
   "version": "3.5.0",
   "description": "A graph data structure with topological sort.",
   "author": "Curran Kelleher",
+  "contributors": [{
+    "name": "Jonathan MASSUCHETTI",
+    "email": "jonathan.massuchetti@dappit.fr",
+    "url": "https://github.com/JesusTheHun"
+  }],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/datavis-tech/graph-data-structure/issues"
@@ -35,7 +40,7 @@
     "test": "vitest --run",
     "prepublishOnly": "npm run build",
     "prettier": "prettier --write .",
-    "tsc": "tsc --noEmit",
+    "tsc": "tsc --noEmit --noEmitOnError",
     "release": "release-it"
   },
   "devDependencies": {

package.json

@@ -38,11 +38,14 @@ describe('graph types', () => {
   it('should require edge properties if LinkProps is defined', () => {
     const g = new Graph<string, { type: string }>();
 
-    g.addEdge('a', 'b', undefined, { type: 'foo' });
-    g.addEdge('a', 'b', 1, { type: 'foo' });
+    g.addEdge('a', 'b', { props: { type: 'foo' } });
+    g.addEdge('a', 'b', { weight: 1, props: { type: 'foo' } });
 
     // @ts-expect-error
     g.addEdge('a', 'b', 1);
+
+    // @ts-expect-error
+    g.addEdge('a', 'b', { weight: 1 });
   });
 
   it('should not allow edge properties if LinkProps is never', () => {

src/CycleError.js

@@ -116,14 +116,25 @@ export class Graph<Node = string, LinkProps = never> {
    * Adds an edge from the `source` node to `target` node.
    * This method will create the nodes if they were not already added.
    */
-  addEdge(
-    source: Node,
-    target: Node,
-    ...opts: [LinkProps] extends [never]
-      ? [weight?: EdgeWeight]
-      : [weight: EdgeWeight | undefined, linkProps: LinkProps]
-  ): this {
-    const [weight, linkProps] = opts;
+  addEdge(source: Node, target: Node, ...args: AddEdgeArgs<LinkProps>): this {
+    let weight: number | undefined;
+    let linkProps: LinkProps | undefined;
+
+    const firstArg = args[0];
+
+    if (typeof firstArg === 'number') {
+      weight = firstArg;
+    }
+
+    if (typeof firstArg === 'object') {
+      weight = firstArg.weight;
+
+      if (firstArg)
+        linkProps = Object.prototype.hasOwnProperty.call(firstArg, 'props')
+          ? (firstArg as { props: LinkProps }).props
+          : undefined;
+    }
+
     this.addNode(source);
     this.addNode(target);
     const adjacentNodes = this.adjacent(source);
@@ -162,3 +173,7 @@ export class Graph<Node = string, LinkProps = never> {
     return this.edges.get(source)?.has(target) ?? false;
   }
 }
+
+type AddEdgeArgs<LinkProps> = [LinkProps] extends [never]
+  ? [weight?: EdgeWeight] | [opts?: { weight?: EdgeWeight }]
+  : [opts: { weight?: EdgeWeight; props: LinkProps }];

src/Graph.js

@@ -6,10 +6,10 @@ describe('depthFirstSearch', () => {
   it('Should return the nodes connected to the source node with the correct type of edge.', function () {
     const graph = new Graph<string, { type: 'foo' | 'bar' }>();
 
-    graph.addEdge('a', 'b', undefined, { type: 'foo' });
-    graph.addEdge('b', 'c', undefined, { type: 'bar' });
-    graph.addEdge('b', 'd', undefined, { type: 'bar' });
-    graph.addEdge('b', 'e', undefined, { type: 'foo' });
+    graph.addEdge('a', 'b', { props: { type: 'foo' } });
+    graph.addEdge('b', 'c', { props: { type: 'bar' } });
+    graph.addEdge('b', 'd', { props: { type: 'bar' } });
+    graph.addEdge('b', 'e', { props: { type: 'foo' } });
 
     const nodes = depthFirstSearch(graph, {
       shouldFollow: ({ source, target, graph }) =>