chore: updating types

jarrodek · jarrodek · commit 5f1e0618047e · 2021-06-28T10:10:24.000-07:00
Signed-off-by: Pawel Psztyc &lt;jarrodek@gmail.com&gt;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@api-modeling/graphlib",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "A directed and undirected multi-graph library",
   "author": "Chris Pettitt <cpettitt@gmail.com>",
   "license": "MIT",
diff --git a/src/alg/components.d.ts b/src/alg/components.d.ts
@@ -9,4 +9,4 @@ import { NodeIdentifier } from "../types";
  * @argument graph - graph to find components in.
  * @returns array of nodes list representing components
  */
-export default function components<N, E>(g: Graph<N, E>): NodeIdentifier[][];
+export default function components<G, N, E>(g: Graph<G, N, E>): NodeIdentifier[][];
diff --git a/src/alg/dfs.d.ts b/src/alg/dfs.d.ts
@@ -9,4 +9,4 @@ import { NodeIdentifier } from "../types";
  *
  * Order must be one of "pre" or "post".
  */
-export default function dfs<N, E>(g: Graph<N, E>, vs: NodeIdentifier|NodeIdentifier[], order: 'pre'|'post'): NodeIdentifier[];
+export default function dfs<G, N, E>(g: Graph<G, N, E>, vs: NodeIdentifier|NodeIdentifier[], order: 'pre'|'post'): NodeIdentifier[];
diff --git a/src/alg/dijkstra-all.d.ts b/src/alg/dijkstra-all.d.ts
@@ -15,4 +15,4 @@ import { Edge, NodePath, NodeIdentifier } from "../types.js";
  * for the purposes of shortest path traversal. By default this function uses the graph.outEdges.
  * @returns shortest paths map.
  */
-export default function dijkstraAll<N, E>(g: Graph<N, E>, weightFunc?: (edge: Edge<E>) => number, edgeFunc?: (v: NodeIdentifier) => Edge<E>[]): Record<NodeIdentifier, Record<NodeIdentifier, NodePath>>;
+export default function dijkstraAll<G, N, E>(g: Graph<G, N, E>, weightFunc?: (edge: Edge<E>) => number, edgeFunc?: (v: NodeIdentifier) => Edge<E>[]): Record<NodeIdentifier, Record<NodeIdentifier, NodePath>>;
diff --git a/src/alg/dijkstra.d.ts b/src/alg/dijkstra.d.ts
@@ -19,4 +19,4 @@ import { Edge, NodePath, NodeIdentifier } from "../types";
  * for the purposes of shortest path traversal. By default this function uses the graph.outEdges.
  * @returns shortest pathes map that starts from node source
  */
-export default function dijkstra<N, E>(g: Graph<N, E>, source: NodeIdentifier, weightFn?: ((edge: Edge<E>) => number), edgeFn?: ((v: NodeIdentifier) => Edge<E>[])): Record<NodeIdentifier, NodePath>;
+export default function dijkstra<G, N, E>(g: Graph<G, N, E>, source: NodeIdentifier, weightFn?: ((edge: Edge<E>) => number), edgeFn?: ((v: NodeIdentifier) => Edge<E>[])): Record<NodeIdentifier, NodePath>;
diff --git a/src/alg/find-cycles.d.ts b/src/alg/find-cycles.d.ts
@@ -12,4 +12,4 @@ import { NodeIdentifier } from "../types";
  * @argument graph - graph where to search cycles.
  * @returns cycles list.
  */
-export default function findCycles<N, E>(g: Graph<N, E>): NodeIdentifier[][];
+export default function findCycles<G, N, E>(g: Graph<G, N, E>): NodeIdentifier[][];
diff --git a/src/alg/floyd-warshall.d.ts b/src/alg/floyd-warshall.d.ts
@@ -20,4 +20,4 @@ import { Edge, FloydWarshallResult, NodeIdentifier } from "../types";
  * for the purposes of shortest path traversal. By default this function uses the graph.outEdges.
  * @returns shortest pathes map.
  */
-export default function floydWarshall<N, E>(g: Graph<N, E>, weightFn?: (edge: Edge<E>) => number, edgeFn?: (v: NodeIdentifier) => Edge<E>[]): FloydWarshallResult;
+export default function floydWarshall<G, N, E>(g: Graph<G, N, E>, weightFn?: (edge: Edge<E>) => number, edgeFn?: (v: NodeIdentifier) => Edge<E>[]): FloydWarshallResult;
diff --git a/src/alg/is-acyclic.d.ts b/src/alg/is-acyclic.d.ts
@@ -8,4 +8,4 @@ import { Graph } from "../graph";
  * @argument graph graph to detect whether it acyclic ot not.
  * @returns whether graph contain cycles or not.
  */
-export default function isAcyclic<N, E>(g: Graph<N, E>): boolean;
+export default function isAcyclic<G, N, E>(g: Graph<G, N, E>): boolean;
diff --git a/src/alg/postorder.d.ts b/src/alg/postorder.d.ts
@@ -10,4 +10,4 @@ import { NodeIdentifier } from "../types";
  * @argument vs - nodes list to traverse.
  * @returns the nodes in the order they were visited as a list of their names.
  */
-export default function postOrder<N, E>(g: Graph<N, E>, vs: NodeIdentifier|NodeIdentifier[]): NodeIdentifier[];
+export default function postOrder<G, N, E>(g: Graph<G, N, E>, vs: NodeIdentifier|NodeIdentifier[]): NodeIdentifier[];
diff --git a/src/alg/preorder.d.ts b/src/alg/preorder.d.ts
@@ -10,4 +10,4 @@ import { NodeIdentifier } from "../types";
  * @argument vs - nodes list to traverse.
  * @returns the nodes in the order they were visited as a list of their names.
  */
-export default function preOrder<N, E>(g: Graph<N, E>, vs: NodeIdentifier|NodeIdentifier[]): NodeIdentifier[];
+export default function preOrder<G, N, E>(g: Graph<G, N, E>, vs: NodeIdentifier|NodeIdentifier[]): NodeIdentifier[];
diff --git a/src/alg/prim.d.ts b/src/alg/prim.d.ts
@@ -12,4 +12,4 @@ import { Edge } from "../types";
  * It throws an Error if the graph is not connected.
  * @returns minimum spanning tree of graph.
  */
-export default function prim<N, E>(g: Graph<N, E>, weightFunc: (edge: Edge<E>) => number): Graph<N, E>;
+export default function prim<G, N, E>(g: Graph<G, N, E>, weightFunc: (edge: Edge<E>) => number): Graph<G, N, E>;
diff --git a/src/alg/tarjan.d.ts b/src/alg/tarjan.d.ts
@@ -14,4 +14,4 @@ import { NodeIdentifier } from "../types";
  * @return an array of components. Each component is itself an array that contains
  * the ids of all nodes in the component.
  */
-export default function tarjan<N, E>(g: Graph<N, E>): NodeIdentifier[][];
+export default function tarjan<G, N, E>(g: Graph<G, N, E>): NodeIdentifier[][];
diff --git a/src/alg/topsort.d.ts b/src/alg/topsort.d.ts
@@ -11,4 +11,4 @@ export class CycleException extends Error {}
  * @argument graph - graph to apply topological sorting to.
  * @returns an array of nodes such that for each edge u -> v, u appears before v in the array.
  */
-export default function topSort<N, E>(g: Graph<N, E>): NodeIdentifier[];
+export default function topSort<G, N, E>(g: Graph<G, N, E>): NodeIdentifier[];
diff --git a/src/graph.d.ts b/src/graph.d.ts
@@ -4,11 +4,11 @@ import { CountedEdges, Edge, GraphInit, NodeChildren, NodeIdentifier, NodeParent
  * The graph library.
  * The `N` interface represents a node dictionary and the `E` interface represents an edge dictionary.
  */
-export declare class Graph<N, E> {
+export declare class Graph<G, N, E> {
   _isDirected: boolean;
   _isMultigraph: boolean;
   _isCompound: boolean;
-  _label: any;
+  _label: G;
   /**
    * v -> label
    */
@@ -92,7 +92,7 @@ export declare class Graph<N, E> {
   /**
    * Sets the label for the graph to `label`.
    */
-  setGraph(label: any): Graph<N,E>;
+  setGraph(label: any): Graph<G,N,E>;
 
   /**
    * @returns The currently assigned label for the graph. If no label has been assigned, returns undefined
@@ -114,7 +114,7 @@ export declare class Graph<N, E> {
    * If the value is not a function it is assigned as the label directly. 
    * If the value is a function, it is called with the id of the node being created.
    */
-  setDefaultNodeLabel(newDefault: string|((node?: NodeIdentifier) => any)): Graph<N,E>;
+  setDefaultNodeLabel(newDefault: string|((node?: NodeIdentifier) => any)): Graph<G,N,E>;
 
   /**
    * @returns the number of nodes in the graph.
@@ -138,7 +138,7 @@ export declare class Graph<N, E> {
   /**
    * Shortcut to calling `setNode()` on each array element
    */
-  setNodes(vs: NodeIdentifier[], value?: N): Graph<N,E>;
+  setNodes(vs: NodeIdentifier[], value?: N): Graph<G,N,E>;
 
   /**
    * Creates or updates the value for the node v in the graph. 
@@ -149,7 +149,7 @@ export declare class Graph<N, E> {
    * @param v The node to set
    * @returns the graph, allowing this to be chained with other functions. Takes O(1) time.
    */
-  setNode(v: NodeIdentifier, label?: N): Graph<N,E>;
+  setNode(v: NodeIdentifier, label?: N): Graph<G,N,E>;
 
   /**
    * @returns the label assigned to the node or undefined when not found. Takes O(1) time.
@@ -167,7 +167,7 @@ export declare class Graph<N, E> {
    * 
    * @returns the graph, allowing this to be chained with other functions. Takes O(|E|) time.
    */
-  removeNode(v: NodeIdentifier): Graph<N,E>;
+  removeNode(v: NodeIdentifier): Graph<G,N,E>;
 
   /**
    * Sets the parent for `v` to `parent` if it is defined or removes the parent for `v` if `parent` is undefined. 
@@ -176,7 +176,7 @@ export declare class Graph<N, E> {
    * @param parent The parent to set. Removes the parent when not set.
    * @returns the graph, allowing this to be chained with other functions. Takes O(1) time.
    */
-  setParent(v: NodeIdentifier, parent?: NodeIdentifier): Graph<N,E>;
+  setParent(v: NodeIdentifier, parent?: NodeIdentifier): Graph<G,N,E>;
 
   _removeFromParentsChildList(v: NodeIdentifier): void;
 
@@ -214,14 +214,14 @@ export declare class Graph<N, E> {
   /**
    * @param filter The filter function.
    */
-  filterNodes(filter: (id: NodeIdentifier) => boolean): Graph<N,E>;
+  filterNodes(filter: (id: NodeIdentifier) => boolean): Graph<G,N,E>;
 
   /**
    * Sets a new default value that is assigned to edges that are created without a label. 
    * If the value is not a function it is assigned as the label directly. 
    * If the value is a function, it is called with the parameters (v, w, name).
    */
-  setDefaultEdgeLabel(newDefault: string|((v:NodeIdentifier, w:NodeIdentifier, name?: string|number) => any)): Graph<N,E>;
+  setDefaultEdgeLabel(newDefault: string|((v:NodeIdentifier, w:NodeIdentifier, name?: string|number) => any)): Graph<G,N,E>;
 
   /**
    * @returns the number of edges in the graph.
@@ -233,7 +233,7 @@ export declare class Graph<N, E> {
    */
   edges(): Edge<E>[];
 
-  setPath(vs: NodeIdentifier[], value?: string): Graph<N,E>;
+  setPath(vs: NodeIdentifier[], value?: string): Graph<G,N,E>;
 
   /**
    * Creates or updates the label for the edge (v, w) with the optionally supplied name. 
@@ -251,7 +251,7 @@ export declare class Graph<N, E> {
    * @param name
    * @returns Returns the graph, allowing this to be chained with other functions. 
    */
-  setEdge(v: NodeIdentifier|Edge<E>, w?: NodeIdentifier|E, value?: E, name?: string|number): Graph<N,E>;
+  setEdge(v: NodeIdentifier|Edge<E>, w?: NodeIdentifier|E, value?: E, name?: string|number): Graph<G,N,E>;
 
   /**
    * The name parameter is only useful with multi graphs. `v` and `w` can be interchanged for undirected graphs. 
@@ -290,7 +290,7 @@ export declare class Graph<N, E> {
    * @param w Required when `v` is not an edge. When the `v` is an object then this is `name` param.
    * @param name 
    */
-  removeEdge(v: Edge<E>|NodeIdentifier, w?: NodeIdentifier|string, name?: string): Graph<N,E>;
+  removeEdge(v: Edge<E>|NodeIdentifier, w?: NodeIdentifier|string, name?: string): Graph<G,N,E>;
 
   /**
    * Returns all edges that point to the node `v`. 
diff --git a/src/json.d.ts b/src/json.d.ts
@@ -8,7 +8,7 @@ import { GraphJson } from './types';
  * @argument graph target to create JSON representation of.
  * @returns JSON serializable graph representation
  */
-export declare function write<N, E>(g: Graph<N, E>): GraphJson<N, E>;
+export declare function write<G, N, E>(g: Graph<G, N, E>): GraphJson<G, N, E>;
 
 /**
  * Takes JSON as input and returns the graph representation.
@@ -23,4 +23,4 @@ export declare function write<N, E>(g: Graph<N, E>): GraphJson<N, E>;
  * @argument json - JSON serializable graph representation
  * @returns graph constructed according to specified representation
  */
-export declare function read<N, E>(json: GraphJson<N, E>): Graph<N, E>;
+export declare function read<G, N, E>(json: GraphJson<G, N, E>): Graph<G, N, E>;
diff --git a/src/types.d.ts b/src/types.d.ts
@@ -65,11 +65,16 @@ export type NodeParents = Record<NodeIdentifier, NodeIdentifier>;
 export type CountedEdge = Record<NodeIdentifier, number>;
 export type CountedEdges = Record<NodeIdentifier, CountedEdge>;
 
-export declare interface GraphJson<N, E> {
+/**
+ * G - Graph value
+ * N - Node value
+ * E - Edge value
+ */
+export declare interface GraphJson<G, N, E> {
   options: GraphInit;
   nodes: Node<N>[];
   edges: JsonEdge<E>[];
-  value?: string;
+  value?: G;
 }
 
 export declare interface PriorityQueueItem {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@api-modeling/graphlib",`
`3`		`- "version": "3.0.2",`
	`3`	`+ "version": "3.0.3",`
`4`	`4`	`"description": "A directed and undirected multi-graph library",`
`5`	`5`	`"author": "Chris Pettitt <cpettitt@gmail.com>",`
`6`	`6`	`"license": "MIT",`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,4 @@ import { NodeIdentifier } from "../types";`
`9`	`9`	`*`
`10`	`10`	`* Order must be one of "pre" or "post".`
`11`	`11`	`*/`
`12`		`-export default function dfs<N, E>(g: Graph<N, E>, vs: NodeIdentifier\|NodeIdentifier[], order: 'pre'\|'post'): NodeIdentifier[];`
	`12`	`+export default function dfs<G, N, E>(g: Graph<G, N, E>, vs: NodeIdentifier\|NodeIdentifier[], order: 'pre'\|'post'): NodeIdentifier[];`