@hpcc-js/wasm-graphviz 1.24.0 → 1.25.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hpcc-js/wasm-graphviz",
-  "version": "1.24.0",
+  "version": "1.25.0",
   "description": "hpcc-js - WASM Graphviz",
   "type": "module",
   "exports": {
@@ -18,7 +18,7 @@
   ],
   "scripts": {
     "clean": "rimraf coverage dist dist-test types .nyc_output",
-    "gen-types": "tsgo --project tsconfig.json --emitDeclarationOnly",
+    "gen-types": "tsc --project tsconfig.json --emitDeclarationOnly",
     "gen-types-watch": "npm run gen-types -- --watch",
     "bundle": "node esbuild.js",
     "bundle-dev": "npm run bundle -- --development",
@@ -37,7 +37,7 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@hpcc-js/esbuild-plugins": "1.9.3",
+    "@hpcc-js/esbuild-plugins": "1.9.4",
     "@hpcc-js/wasm-util": "1.0.0"
   },
   "keywords": [
@@ -56,5 +56,5 @@
   },
   "homepage": "https://hpcc-systems.github.io/hpcc-js-wasm/",
   "license": "Apache-2.0",
-  "gitHead": "32faad64c64599080e938fe69207fa2080cd1de6"
+  "gitHead": "e9302b649306927c2844eda31d3ee58b17b8eb8a"
 }

package/src/graphviz.ts

@@ -8,8 +8,24 @@ import type {
     GraphDotAttr, GraphAttrs as GraphAttrs
 } from "./types.ts";
 
+type AttrValues<T> = Partial<{ [K in keyof T]: NonNullable<T[K]> }>;
+
+function applyAttrs<T extends object>(
+    attrs: AttrValues<T> | undefined,
+    apply: (attr: string, value: string | number | boolean) => void
+): void {
+    if (!attrs) {
+        return;
+    }
+    for (const [attr, value] of Object.entries(attrs)) {
+        if (value !== undefined) {
+            apply(attr, value as string | number | boolean);
+        }
+    }
+}
+
 /**
- * Various graphic and data formats for end user, web, documents and other applications.  See [Output Formats](https://graphviz.gitlab.io/docs/outputs/) for more information.
+ * Various graphic and data formats for end user, web, documents and other applications.  See [Output Formats](https://graphviz.org/docs/outputs/) for more information.
  */
 export type Format = "svg" | "svg_inline" | "dot" | "json" | "dot_json" | "xdot_json" | "plain" | "plain-ext" | "canon";
 
@@ -43,7 +59,7 @@ function parseEdges(json: string): EdgeInfo[] {
 }
 
 /**
- * Various algorithms for projecting abstract graphs into a space for visualization.  See [Layout Engines](https://graphviz.gitlab.io/docs/layouts/) for more details.
+ * Various algorithms for projecting abstract graphs into a space for visualization.  See [Layout Engines](https://graphviz.org/docs/layouts/) for more details.
  */
 export type Engine = "circo" | "dot" | "fdp" | "sfdp" | "neato" | "osage" | "patchwork" | "twopi" | "nop" | "nop2";
 
@@ -117,6 +133,35 @@ let g_graphviz: Promise<Graphviz> | undefined;
  */
 export type GraphType = "directed" | "undirected" | "strict directed" | "strict undirected";
 
+export interface GraphInit {
+    name?: string;
+    type?: GraphType;
+    attrs?: AttrValues<GraphAttrs>;
+    htmlAttrs?: AttrValues<GraphAttrs>;
+}
+
+export interface NodeInit {
+    name: string;
+    attrs?: AttrValues<NodeAttrs>;
+    htmlAttrs?: AttrValues<NodeAttrs>;
+}
+
+export interface EdgeInit {
+    tail: string;
+    head: string;
+    key?: string;
+    attrs?: AttrValues<EdgeAttrs>;
+    htmlAttrs?: AttrValues<EdgeAttrs>;
+}
+
+export interface SubgraphInit {
+    name: string;
+    attrs?: AttrValues<ClusterAttrs>;
+    htmlAttrs?: AttrValues<ClusterAttrs>;
+}
+
+export type ClusterInit = SubgraphInit;
+
 /**
  * A subgraph (or cluster) inside a {@link Graph}.
  *
@@ -148,8 +193,15 @@ export class Subgraph {
     /**
      * Create (or find) a node and add it to this subgraph.
      */
-    addNode(name: string): this {
+    addNode(name: string): this;
+    addNode(init: NodeInit): this;
+    addNode(nameOrInit: string | NodeInit): this {
+        const init = typeof nameOrInit === "string" ? { name: nameOrInit } : nameOrInit;
+        const { name, attrs, htmlAttrs } = init;
+
         this._sg.addNode(name);
+        applyAttrs<NodeAttrs>(attrs, (attr, value) => this.setNodeAttr(name, attr, value));
+        applyAttrs<NodeAttrs>(htmlAttrs, (attr, value) => this.setNodeHtmlAttr(name, attr, value));
         return this;
     }
 
@@ -157,8 +209,23 @@ export class Subgraph {
      * Create an edge inside this subgraph.  Both endpoints are created
      * automatically if they do not already exist.
      */
-    addEdge(tail: string, head: string, key: string = ""): this {
-        this._sg.addEdge(tail, head, key);
+    addEdge(tail: string, head: string, key?: string): this;
+    addEdge(init: EdgeInit): this;
+    addEdge(tailOrInit: string | EdgeInit, head?: string, key: string = ""): this {
+        const init = typeof tailOrInit === "string"
+            ? { tail: tailOrInit, head: head!, key }
+            : tailOrInit;
+        const { tail, head: resolvedHead, key: resolvedKey = "", attrs, htmlAttrs } = init;
+
+        this._sg.addEdge(tail, resolvedHead, resolvedKey);
+        applyAttrs<EdgeAttrs>(attrs, (attr, value) => this.setEdgeAttr(tail, resolvedHead, resolvedKey, attr, value));
+        applyAttrs<EdgeAttrs>(htmlAttrs, (attr, value) => this.setEdgeHtmlAttr(tail, resolvedHead, resolvedKey, attr, value));
+        return this;
+    }
+
+    applyInit(init: SubgraphInit): this {
+        applyAttrs<ClusterAttrs>(init.attrs, (attr, value) => this.setAttr(attr, value));
+        applyAttrs<ClusterAttrs>(init.htmlAttrs, (attr, value) => this.setHtmlAttr(attr, value));
         return this;
     }
 
@@ -183,16 +250,50 @@ export class Subgraph {
 
     /**
      * Set an attribute on the subgraph itself (e.g. `"label"`, `"style"`,
-     * `"color"`, `"bgcolor"`).
+     * `"color"`, `"bgcolor"`).  See the official Graphviz
+     * [attribute reference](https://graphviz.org/docs/attrs/) for supported
+     * attributes and values.
      *
      * When `attr` is a known cluster attribute the value type is inferred
      * automatically.  A generic `string | number | boolean` fallback is
-     * provided for custom or less-common attributes.
-     */
-    setAttr<K extends ClusterDotAttr>(attr: K, value: NonNullable<ClusterAttrs[K]>): this;
-    setAttr(attr: string, value: string | number | boolean): this;
-    setAttr(attr: string, value: unknown): this {
-        this._sg.setAttr(attr, String(value));
+     * provided for custom or less-common attributes.  Omit `value` to reset
+     * the attribute to Graphviz's default empty value.  `defaultValue` is
+     * passed to Graphviz as the default for this attribute if it has not
+     * already been declared.
+     */
+    setAttr<K extends ClusterDotAttr>(attr: K, value?: NonNullable<ClusterAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setAttr(attr: string, value?: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setAttr(attr: string, value: unknown = "", defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._sg.setAttr(attr, String(value));
+        } else {
+            this._sg.setAttr(attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setHtmlAttr<K extends ClusterDotAttr>(attr: K, value: NonNullable<ClusterAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setHtmlAttr(attr: string, value: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setHtmlAttr(attr: string, value: unknown, defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._sg.setHtmlAttr(attr, String(value));
+        } else {
+            this._sg.setHtmlAttr(attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setDefaultAttr<K extends ClusterDotAttr>(attr: K, value: NonNullable<ClusterAttrs[K]>): this;
+    setDefaultAttr(attr: string, value: string | number | boolean): this;
+    setDefaultAttr(attr: string, value: unknown): this {
+        this._sg.setDefaultAttr(attr, String(value));
+        return this;
+    }
+
+    setDefaultHtmlAttr<K extends ClusterDotAttr>(attr: K, value: NonNullable<ClusterAttrs[K]>): this;
+    setDefaultHtmlAttr(attr: string, value: string | number | boolean): this;
+    setDefaultHtmlAttr(attr: string, value: unknown): this {
+        this._sg.setDefaultHtmlAttr(attr, String(value));
         return this;
     }
 
@@ -209,12 +310,43 @@ export class Subgraph {
      *
      * When `attr` is a known node attribute the value type is inferred
      * automatically.  A generic `string | number | boolean` fallback is
-     * provided for custom attributes.
-     */
-    setNodeAttr<K extends NodeDotAttr>(node: string, attr: K, value: NonNullable<NodeAttrs[K]>): this;
-    setNodeAttr(node: string, attr: string, value: string | number | boolean): this;
-    setNodeAttr(node: string, attr: string, value: unknown): this {
-        this._sg.setNodeAttr(node, attr, String(value));
+     * provided for custom attributes.  Omit `value` to reset the attribute to
+     * Graphviz's default empty value.  `defaultValue` is passed to Graphviz as
+     * the default for this attribute if it has not already been declared.
+     */
+    setNodeAttr<K extends NodeDotAttr>(node: string, attr: K, value?: NonNullable<NodeAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setNodeAttr(node: string, attr: string, value?: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setNodeAttr(node: string, attr: string, value: unknown = "", defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._sg.setNodeAttr(node, attr, String(value));
+        } else {
+            this._sg.setNodeAttr(node, attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setNodeHtmlAttr<K extends NodeDotAttr>(node: string, attr: K, value: NonNullable<NodeAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setNodeHtmlAttr(node: string, attr: string, value: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setNodeHtmlAttr(node: string, attr: string, value: unknown, defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._sg.setNodeHtmlAttr(node, attr, String(value));
+        } else {
+            this._sg.setNodeHtmlAttr(node, attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setDefaultNodeAttr<K extends NodeDotAttr>(attr: K, value: NonNullable<NodeAttrs[K]>): this;
+    setDefaultNodeAttr(attr: string, value: string | number | boolean): this;
+    setDefaultNodeAttr(attr: string, value: unknown): this {
+        this._sg.setDefaultNodeAttr(attr, String(value));
+        return this;
+    }
+
+    setDefaultNodeHtmlAttr<K extends NodeDotAttr>(attr: K, value: NonNullable<NodeAttrs[K]>): this;
+    setDefaultNodeHtmlAttr(attr: string, value: string | number | boolean): this;
+    setDefaultNodeHtmlAttr(attr: string, value: unknown): this {
+        this._sg.setDefaultNodeHtmlAttr(attr, String(value));
         return this;
     }
 
@@ -232,12 +364,43 @@ export class Subgraph {
      *
      * When `attr` is a known edge attribute the value type is inferred
      * automatically.  A generic `string | number | boolean` fallback is
-     * provided for custom attributes.
-     */
-    setEdgeAttr<K extends EdgeDotAttr>(tail: string, head: string, key: string, attr: K, value: NonNullable<EdgeAttrs[K]>): this;
-    setEdgeAttr(tail: string, head: string, key: string, attr: string, value: string | number | boolean): this;
-    setEdgeAttr(tail: string, head: string, key: string, attr: string, value: unknown): this {
-        this._sg.setEdgeAttr(tail, head, key, attr, String(value));
+     * provided for custom attributes.  Omit `value` to reset the attribute to
+     * Graphviz's default empty value.  `defaultValue` is passed to Graphviz as
+     * the default for this attribute if it has not already been declared.
+     */
+    setEdgeAttr<K extends EdgeDotAttr>(tail: string, head: string, key: string, attr: K, value?: NonNullable<EdgeAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setEdgeAttr(tail: string, head: string, key: string, attr: string, value?: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setEdgeAttr(tail: string, head: string, key: string, attr: string, value: unknown = "", defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._sg.setEdgeAttr(tail, head, key, attr, String(value));
+        } else {
+            this._sg.setEdgeAttr(tail, head, key, attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setEdgeHtmlAttr<K extends EdgeDotAttr>(tail: string, head: string, key: string, attr: K, value: NonNullable<EdgeAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setEdgeHtmlAttr(tail: string, head: string, key: string, attr: string, value: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setEdgeHtmlAttr(tail: string, head: string, key: string, attr: string, value: unknown, defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._sg.setEdgeHtmlAttr(tail, head, key, attr, String(value));
+        } else {
+            this._sg.setEdgeHtmlAttr(tail, head, key, attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setDefaultEdgeAttr<K extends EdgeDotAttr>(attr: K, value: NonNullable<EdgeAttrs[K]>): this;
+    setDefaultEdgeAttr(attr: string, value: string | number | boolean): this;
+    setDefaultEdgeAttr(attr: string, value: unknown): this {
+        this._sg.setDefaultEdgeAttr(attr, String(value));
+        return this;
+    }
+
+    setDefaultEdgeHtmlAttr<K extends EdgeDotAttr>(attr: K, value: NonNullable<EdgeAttrs[K]>): this;
+    setDefaultEdgeHtmlAttr(attr: string, value: string | number | boolean): this;
+    setDefaultEdgeHtmlAttr(attr: string, value: unknown): this {
+        this._sg.setDefaultEdgeHtmlAttr(attr, String(value));
         return this;
     }
 
@@ -275,6 +438,11 @@ export class Subgraph {
     /** Returns the number of edges in this subgraph. */
     edgeCount(): number { return this._sg.edgeCount(); }
 
+    /** Returns the degree of a named node in this subgraph. */
+    nodeDegree(node: string, inDegree: number = 1, outDegree: number = 1): number {
+        return this._sg.nodeDegree(node, inDegree, outDegree);
+    }
+
     // ---- Attribute reading ----------------------------------------------
 
     /**
@@ -396,8 +564,15 @@ export class Graph {
      * Create a node.  If a node with this name already exists it is returned
      * unchanged.
      */
-    addNode(name: string): this {
+    addNode(name: string): this;
+    addNode(init: NodeInit): this;
+    addNode(nameOrInit: string | NodeInit): this {
+        const init = typeof nameOrInit === "string" ? { name: nameOrInit } : nameOrInit;
+        const { name, attrs, htmlAttrs } = init;
+
         this._graph.addNode(name);
+        applyAttrs<NodeAttrs>(attrs, (attr, value) => this.setNodeAttr(name, attr, value));
+        applyAttrs<NodeAttrs>(htmlAttrs, (attr, value) => this.setNodeHtmlAttr(name, attr, value));
         return this;
     }
 
@@ -407,22 +582,82 @@ export class Graph {
      * parallel edges between the same pair of nodes; omit (or pass `""`) for
      * an anonymous edge.
      */
-    addEdge(tail: string, head: string, key: string = ""): this {
-        this._graph.addEdge(tail, head, key);
+    addEdge(tail: string, head: string, key?: string): this;
+    addEdge(init: EdgeInit): this;
+    addEdge(tailOrInit: string | EdgeInit, head?: string, key: string = ""): this {
+        const init = typeof tailOrInit === "string"
+            ? { tail: tailOrInit, head: head!, key }
+            : tailOrInit;
+        const { tail, head: resolvedHead, key: resolvedKey = "", attrs, htmlAttrs } = init;
+
+        this._graph.addEdge(tail, resolvedHead, resolvedKey);
+        applyAttrs<EdgeAttrs>(attrs, (attr, value) => this.setEdgeAttr(tail, resolvedHead, resolvedKey, attr, value));
+        applyAttrs<EdgeAttrs>(htmlAttrs, (attr, value) => this.setEdgeHtmlAttr(tail, resolvedHead, resolvedKey, attr, value));
+        return this;
+    }
+
+    applyInit(init: GraphInit): this {
+        applyAttrs<GraphAttrs>(init.attrs, (attr, value) => this.setGraphAttr(attr, value));
+        applyAttrs<GraphAttrs>(init.htmlAttrs, (attr, value) => this.setGraphHtmlAttr(attr, value));
+        return this;
+    }
+
+    /**
+     * Replace this graph with one parsed from DOT source using Graphviz cgraph
+     * reading support.
+     */
+    read(dotSource: string): this {
+        if (!this._graph.read(dotSource)) {
+            throw new Error("Invalid DOT source");
+        }
         return this;
     }
 
     /**
      * Set a graph-level attribute (e.g. `"rankdir"`, `"label"`, `"bgcolor"`).
+     * See the official Graphviz [attribute reference](https://graphviz.org/docs/attrs/)
+     * for supported attributes and values.
      *
      * When `attr` is a known graph attribute the value type is inferred
      * automatically.  A generic `string | number | boolean` fallback is
-     * provided for custom or less-common attributes.
-     */
-    setGraphAttr<K extends GraphDotAttr>(attr: K, value: NonNullable<GraphAttrs[K]>): this;
-    setGraphAttr(attr: string, value: string | number | boolean): this;
-    setGraphAttr(attr: string, value: unknown): this {
-        this._graph.setGraphAttr(attr, String(value));
+     * provided for custom or less-common attributes.  Omit `value` to reset
+     * the attribute to Graphviz's default empty value.  `defaultValue` is
+     * passed to Graphviz as the default for this attribute if it has not
+     * already been declared.
+     */
+    setGraphAttr<K extends GraphDotAttr>(attr: K, value?: NonNullable<GraphAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setGraphAttr(attr: string, value?: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setGraphAttr(attr: string, value: unknown = "", defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._graph.setGraphAttr(attr, String(value));
+        } else {
+            this._graph.setGraphAttr(attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setGraphHtmlAttr<K extends GraphDotAttr>(attr: K, value: NonNullable<GraphAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setGraphHtmlAttr(attr: string, value: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setGraphHtmlAttr(attr: string, value: unknown, defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._graph.setGraphHtmlAttr(attr, String(value));
+        } else {
+            this._graph.setGraphHtmlAttr(attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setDefaultGraphAttr<K extends GraphDotAttr>(attr: K, value: NonNullable<GraphAttrs[K]>): this;
+    setDefaultGraphAttr(attr: string, value: string | number | boolean): this;
+    setDefaultGraphAttr(attr: string, value: unknown): this {
+        this._graph.setDefaultGraphAttr(attr, String(value));
+        return this;
+    }
+
+    setDefaultGraphHtmlAttr<K extends GraphDotAttr>(attr: K, value: NonNullable<GraphAttrs[K]>): this;
+    setDefaultGraphHtmlAttr(attr: string, value: string | number | boolean): this;
+    setDefaultGraphHtmlAttr(attr: string, value: unknown): this {
+        this._graph.setDefaultGraphHtmlAttr(attr, String(value));
         return this;
     }
 
@@ -432,12 +667,43 @@ export class Graph {
      *
      * When `attr` is a known node attribute the value type is inferred
      * automatically.  A generic `string | number | boolean` fallback is
-     * provided for custom attributes.
-     */
-    setNodeAttr<K extends NodeDotAttr>(node: string, attr: K, value: NonNullable<NodeAttrs[K]>): this;
-    setNodeAttr(node: string, attr: string, value: string | number | boolean): this;
-    setNodeAttr(node: string, attr: string, value: unknown): this {
-        this._graph.setNodeAttr(node, attr, String(value));
+     * provided for custom attributes.  Omit `value` to reset the attribute to
+     * Graphviz's default empty value.  `defaultValue` is passed to Graphviz as
+     * the default for this attribute if it has not already been declared.
+     */
+    setNodeAttr<K extends NodeDotAttr>(node: string, attr: K, value?: NonNullable<NodeAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setNodeAttr(node: string, attr: string, value?: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setNodeAttr(node: string, attr: string, value: unknown = "", defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._graph.setNodeAttr(node, attr, String(value));
+        } else {
+            this._graph.setNodeAttr(node, attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setNodeHtmlAttr<K extends NodeDotAttr>(node: string, attr: K, value: NonNullable<NodeAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setNodeHtmlAttr(node: string, attr: string, value: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setNodeHtmlAttr(node: string, attr: string, value: unknown, defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._graph.setNodeHtmlAttr(node, attr, String(value));
+        } else {
+            this._graph.setNodeHtmlAttr(node, attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setDefaultNodeAttr<K extends NodeDotAttr>(attr: K, value: NonNullable<NodeAttrs[K]>): this;
+    setDefaultNodeAttr(attr: string, value: string | number | boolean): this;
+    setDefaultNodeAttr(attr: string, value: unknown): this {
+        this._graph.setDefaultNodeAttr(attr, String(value));
+        return this;
+    }
+
+    setDefaultNodeHtmlAttr<K extends NodeDotAttr>(attr: K, value: NonNullable<NodeAttrs[K]>): this;
+    setDefaultNodeHtmlAttr(attr: string, value: string | number | boolean): this;
+    setDefaultNodeHtmlAttr(attr: string, value: unknown): this {
+        this._graph.setDefaultNodeHtmlAttr(attr, String(value));
         return this;
     }
 
@@ -448,12 +714,43 @@ export class Graph {
      *
      * When `attr` is a known edge attribute the value type is inferred
      * automatically.  A generic `string | number | boolean` fallback is
-     * provided for custom attributes.
-     */
-    setEdgeAttr<K extends EdgeDotAttr>(tail: string, head: string, key: string, attr: K, value: NonNullable<EdgeAttrs[K]>): this;
-    setEdgeAttr(tail: string, head: string, key: string, attr: string, value: string | number | boolean): this;
-    setEdgeAttr(tail: string, head: string, key: string, attr: string, value: unknown): this {
-        this._graph.setEdgeAttr(tail, head, key, attr, String(value));
+     * provided for custom attributes.  Omit `value` to reset the attribute to
+     * Graphviz's default empty value.  `defaultValue` is passed to Graphviz as
+     * the default for this attribute if it has not already been declared.
+     */
+    setEdgeAttr<K extends EdgeDotAttr>(tail: string, head: string, key: string, attr: K, value?: NonNullable<EdgeAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setEdgeAttr(tail: string, head: string, key: string, attr: string, value?: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setEdgeAttr(tail: string, head: string, key: string, attr: string, value: unknown = "", defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._graph.setEdgeAttr(tail, head, key, attr, String(value));
+        } else {
+            this._graph.setEdgeAttr(tail, head, key, attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setEdgeHtmlAttr<K extends EdgeDotAttr>(tail: string, head: string, key: string, attr: K, value: NonNullable<EdgeAttrs[K]>, defaultValue?: string | number | boolean): this;
+    setEdgeHtmlAttr(tail: string, head: string, key: string, attr: string, value: string | number | boolean, defaultValue?: string | number | boolean): this;
+    setEdgeHtmlAttr(tail: string, head: string, key: string, attr: string, value: unknown, defaultValue?: unknown): this {
+        if (defaultValue === undefined) {
+            this._graph.setEdgeHtmlAttr(tail, head, key, attr, String(value));
+        } else {
+            this._graph.setEdgeHtmlAttr(tail, head, key, attr, String(value), String(defaultValue));
+        }
+        return this;
+    }
+
+    setDefaultEdgeAttr<K extends EdgeDotAttr>(attr: K, value: NonNullable<EdgeAttrs[K]>): this;
+    setDefaultEdgeAttr(attr: string, value: string | number | boolean): this;
+    setDefaultEdgeAttr(attr: string, value: unknown): this {
+        this._graph.setDefaultEdgeAttr(attr, String(value));
+        return this;
+    }
+
+    setDefaultEdgeHtmlAttr<K extends EdgeDotAttr>(attr: K, value: NonNullable<EdgeAttrs[K]>): this;
+    setDefaultEdgeHtmlAttr(attr: string, value: string | number | boolean): this;
+    setDefaultEdgeHtmlAttr(attr: string, value: unknown): this {
+        this._graph.setDefaultEdgeHtmlAttr(attr, String(value));
         return this;
     }
 
@@ -547,6 +844,11 @@ export class Graph {
     /** Returns the number of direct subgraphs of this graph. */
     subgraphCount(): number { return this._graph.subgraphCount(); }
 
+    /** Returns the degree of a named node in the graph. */
+    nodeDegree(node: string, inDegree: number = 1, outDegree: number = 1): number {
+        return this._graph.nodeDegree(node, inDegree, outDegree);
+    }
+
     // ---- Attribute reading ----------------------------------------------
 
     /**
@@ -636,10 +938,13 @@ export class Graph {
      * cluster.setAttr("label", "My Cluster").addEdge("a", "b");
      * ```
      */
-    addSubgraph(name: string): Subgraph {
+    addSubgraph(name: string): Subgraph;
+    addSubgraph(init: SubgraphInit): Subgraph;
+    addSubgraph(nameOrInit: string | SubgraphInit): Subgraph {
+        const init = typeof nameOrInit === "string" ? { name: nameOrInit } : nameOrInit;
         // addSubgraph only returns null when the internal graph pointer is null,
         // which cannot happen while this Graph instance is alive.
-        return new Subgraph(this._graph.addSubgraph(name)!);
+        return new Subgraph(this._graph.addSubgraph(init.name)!).applyInit(init);
     }
 
     /**
@@ -697,11 +1002,18 @@ export class Graph {
         return retVal;
     }
 
+    /**
+     * Serialise the graph to a DOT-language string.
+     */
+    write(): string {
+        return this._graph.write();
+    }
+
     /**
      * Serialise the graph to a DOT-language string.
      */
     toDot(): string {
-        return this._graph.toDot();
+        return this.write();
     }
 
     /**
@@ -1067,9 +1379,32 @@ export class Graphviz {
      * const svg = graphviz.dot(graph.toDot());
      * ```
      */
-    createGraph(name: string = "G", type: GraphType = "directed"): Graph {
-        const directed = !type.includes("undirected") ? 1 : 0;
-        const strict = type.startsWith("strict") ? 1 : 0;
-        return new Graph(new this._module.CGraph(name, directed, strict), this._module);
+    createGraph(name?: string, type?: GraphType): Graph;
+    createGraph(init: GraphInit): Graph;
+    createGraph(nameOrInit: string | GraphInit = "G", type: GraphType = "directed"): Graph {
+        const init = typeof nameOrInit === "string"
+            ? { name: nameOrInit, type }
+            : nameOrInit;
+        const resolvedName = init.name ?? "G";
+        const resolvedType = init.type ?? "directed";
+        const directed = !resolvedType.includes("undirected") ? 1 : 0;
+        const strict = resolvedType.startsWith("strict") ? 1 : 0;
+        return new Graph(new this._module.CGraph(resolvedName, directed, strict), this._module).applyInit(init);
+    }
+
+    /**
+     * Parse DOT source into a mutable {@link Graph}.  The returned graph can
+     * be queried, modified, rendered directly, or serialised back to DOT with
+     * {@link Graph.toDot}.
+     */
+    read(dotSource: string): Graph {
+        const graph = this.createGraph();
+        try {
+            graph.read(dotSource);
+            return graph;
+        } catch (e) {
+            graph.delete();
+            throw e;
+        }
     }
 }

package/src/types.ts

@@ -81,6 +81,7 @@ export interface NodeAttrs {
     group?: string;
     height?: number;
     href?: string;
+    id?: string;
     image?: string;
     imagepos?: string;
     imagescale?: boolean | string;
@@ -146,6 +147,7 @@ export interface EdgeAttrs {
     headtooltip?: string;
     headURL?: string;
     href?: string;
+    id?: string;
     label?: string;
     labelangle?: number;
     labeldistance?: number;
@@ -204,6 +206,7 @@ export interface ClusterAttrs {
     fontsize?: number;
     gradientangle?: number;
     href?: string;
+    id?: string;
     K?: number;
     label?: string;
     labeljust?: string;
@@ -374,6 +377,7 @@ export const NODE_DOT_ATTRS: readonly NodeDotAttr[] = attrsOf<NodeDotAttr>({
     group: true,
     height: true,
     href: true,
+    id: true,
     image: true,
     imagepos: true,
     imagescale: true,
@@ -434,6 +438,7 @@ export const EDGE_DOT_ATTRS: readonly EdgeDotAttr[] = attrsOf<EdgeDotAttr>({
     headtooltip: true,
     headURL: true,
     href: true,
+    id: true,
     label: true,
     labelangle: true,
     labeldistance: true,
@@ -486,6 +491,7 @@ export const CLUSTER_DOT_ATTRS: readonly ClusterDotAttr[] = attrsOf<ClusterDotAt
     fontsize: true,
     gradientangle: true,
     href: true,
+    id: true,
     K: true,
     label: true,
     labeljust: true,