@hpcc-js/wasm-graphviz 1.24.0 → 1.24.1

package/types/graphviz.d.ts

@@ -1,7 +1,7 @@
 import type { MainModule, CGraph as CGraphWasm, CSubgraph as CSubgraphWasm } from "../types/graphvizlib.js";
 import type { NodeDotAttr, NodeAttrs, EdgeDotAttr, EdgeAttrs, ClusterDotAttr, ClusterAttrs, GraphDotAttr, GraphAttrs as GraphAttrs } from "./types.ts";
 /**
- * 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";
 /**
@@ -19,7 +19,7 @@ export interface EdgeInfo {
     key: string;
 }
 /**
- * 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";
 /**
@@ -110,14 +110,25 @@ export declare class Subgraph {
     removeEdge(tail: string, head: string, key?: string): this;
     /**
      * 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;
+     * 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;
+    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;
+    setDefaultAttr<K extends ClusterDotAttr>(attr: K, value: NonNullable<ClusterAttrs[K]>): this;
+    setDefaultAttr(attr: string, value: string | number | boolean): this;
+    setDefaultHtmlAttr<K extends ClusterDotAttr>(attr: K, value: NonNullable<ClusterAttrs[K]>): this;
+    setDefaultHtmlAttr(attr: string, value: string | number | boolean): this;
     /**
      * Clear a subgraph-level attribute by resetting it to its default (empty)
      * value.  Equivalent to `setAttr(attr, "")`.
@@ -128,10 +139,18 @@ export declare 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;
+     * 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;
+    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;
+    setDefaultNodeAttr<K extends NodeDotAttr>(attr: K, value: NonNullable<NodeAttrs[K]>): this;
+    setDefaultNodeAttr(attr: string, value: string | number | boolean): this;
+    setDefaultNodeHtmlAttr<K extends NodeDotAttr>(attr: K, value: NonNullable<NodeAttrs[K]>): this;
+    setDefaultNodeHtmlAttr(attr: string, value: string | number | boolean): this;
     /**
      * Clear a node attribute inside this subgraph by resetting it to its
      * default (empty) value.  Equivalent to `setNodeAttr(node, attr, "")`.
@@ -143,10 +162,18 @@ export declare 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;
+     * 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;
+    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;
+    setDefaultEdgeAttr<K extends EdgeDotAttr>(attr: K, value: NonNullable<EdgeAttrs[K]>): this;
+    setDefaultEdgeAttr(attr: string, value: string | number | boolean): this;
+    setDefaultEdgeHtmlAttr<K extends EdgeDotAttr>(attr: K, value: NonNullable<EdgeAttrs[K]>): this;
+    setDefaultEdgeHtmlAttr(attr: string, value: string | number | boolean): this;
     /**
      * Clear an edge attribute inside this subgraph by resetting it to its
      * default (empty) value.  Equivalent to `setEdgeAttr(tail, head, key, attr, "")`.
@@ -166,6 +193,8 @@ export declare class Subgraph {
     nodeCount(): number;
     /** Returns the number of edges in this subgraph. */
     edgeCount(): number;
+    /** Returns the degree of a named node in this subgraph. */
+    nodeDegree(node: string, inDegree?: number, outDegree?: number): number;
     /**
      * Returns the current value of a subgraph-level attribute, or `""` if
      * the attribute has not been set.
@@ -256,25 +285,49 @@ export declare class Graph {
      * an anonymous edge.
      */
     addEdge(tail: string, head: string, key?: string): this;
+    /**
+     * Replace this graph with one parsed from DOT source using Graphviz cgraph
+     * reading support.
+     */
+    read(dotSource: string): 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;
+     * 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;
+    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;
+    setDefaultGraphAttr<K extends GraphDotAttr>(attr: K, value: NonNullable<GraphAttrs[K]>): this;
+    setDefaultGraphAttr(attr: string, value: string | number | boolean): this;
+    setDefaultGraphHtmlAttr<K extends GraphDotAttr>(attr: K, value: NonNullable<GraphAttrs[K]>): this;
+    setDefaultGraphHtmlAttr(attr: string, value: string | number | boolean): this;
     /**
      * Set an attribute on a named node (e.g. `"color"`, `"label"`, `"shape"`).
      * The node must exist; call {@link addNode} first if needed.
      *
      * 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;
+     * 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;
+    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;
+    setDefaultNodeAttr<K extends NodeDotAttr>(attr: K, value: NonNullable<NodeAttrs[K]>): this;
+    setDefaultNodeAttr(attr: string, value: string | number | boolean): this;
+    setDefaultNodeHtmlAttr<K extends NodeDotAttr>(attr: K, value: NonNullable<NodeAttrs[K]>): this;
+    setDefaultNodeHtmlAttr(attr: string, value: string | number | boolean): this;
     /**
      * Set an attribute on an edge identified by `(tail, head, key)`.
      * Use the same `key` that was passed to {@link addEdge}; pass `""` for
@@ -282,10 +335,18 @@ export declare 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;
+     * 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;
+    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;
+    setDefaultEdgeAttr<K extends EdgeDotAttr>(attr: K, value: NonNullable<EdgeAttrs[K]>): this;
+    setDefaultEdgeAttr(attr: string, value: string | number | boolean): this;
+    setDefaultEdgeHtmlAttr<K extends EdgeDotAttr>(attr: K, value: NonNullable<EdgeAttrs[K]>): this;
+    setDefaultEdgeHtmlAttr(attr: string, value: string | number | boolean): this;
     /**
      * Remove a node and all its edges from the graph.  Removing from the root
      * graph also removes the node from every subgraph.
@@ -339,6 +400,8 @@ export declare class Graph {
     edgeCount(): number;
     /** Returns the number of direct subgraphs of this graph. */
     subgraphCount(): number;
+    /** Returns the degree of a named node in the graph. */
+    nodeDegree(node: string, inDegree?: number, outDegree?: number): number;
     /**
      * Returns the current value of a graph-level attribute, or `""` if the
      * attribute has not been set.
@@ -426,6 +489,10 @@ export declare class Graph {
      * @returns The rendered output as a string.
      */
     layout(outputFormat?: Format, layoutEngine?: Engine, options?: Options): string;
+    /**
+     * Serialise the graph to a DOT-language string.
+     */
+    write(): string;
     /**
      * Serialise the graph to a DOT-language string.
      */
@@ -655,4 +722,10 @@ export declare class Graphviz {
      * ```
      */
     createGraph(name?: string, type?: GraphType): Graph;
+    /**
+     * 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;
 }

package/types/graphvizlib.d.ts

@@ -47,8 +47,15 @@ export interface CGraphviz extends ClassHandle {
   set unflatten_out(value: EmbindString);
   createFile(_0: EmbindString, _1: EmbindString): void;
   layout(_0: EmbindString, _1: EmbindString, _2: EmbindString): string;
+  acyclic(_0: EmbindString): boolean;
+  acyclic(_0: EmbindString, _1: boolean): boolean;
   acyclic(_0: EmbindString, _1: boolean, _2: boolean): boolean;
+  tred(_0: EmbindString): void;
+  tred(_0: EmbindString, _1: boolean): void;
   tred(_0: EmbindString, _1: boolean, _2: boolean): void;
+  unflatten(_0: EmbindString): string;
+  unflatten(_0: EmbindString, _1: number): string;
+  unflatten(_0: EmbindString, _1: number, _2: boolean): string;
   unflatten(_0: EmbindString, _1: number, _2: boolean, _3: number): string;
 }
 
@@ -61,18 +68,40 @@ export interface CGraph extends ClassHandle {
   edgeCount(): number;
   subgraphCount(): number;
   addNode(_0: EmbindString): void;
+  addEdge(_0: EmbindString, _1: EmbindString): void;
   addEdge(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
   setGraphAttr(_0: EmbindString, _1: EmbindString): void;
+  setGraphAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
+  setGraphHtmlAttr(_0: EmbindString, _1: EmbindString): void;
+  setGraphHtmlAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
   setNodeAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
+  setNodeAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString): void;
+  setNodeHtmlAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
+  setNodeHtmlAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString): void;
   setEdgeAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString, _4: EmbindString): void;
+  setEdgeAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString, _4: EmbindString, _5: EmbindString): void;
+  setEdgeHtmlAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString, _4: EmbindString): void;
+  setEdgeHtmlAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString, _4: EmbindString, _5: EmbindString): void;
+  setDefaultGraphAttr(_0: EmbindString, _1: EmbindString): void;
+  setDefaultGraphHtmlAttr(_0: EmbindString, _1: EmbindString): void;
+  setDefaultNodeAttr(_0: EmbindString, _1: EmbindString): void;
+  setDefaultNodeHtmlAttr(_0: EmbindString, _1: EmbindString): void;
+  setDefaultEdgeAttr(_0: EmbindString, _1: EmbindString): void;
+  setDefaultEdgeHtmlAttr(_0: EmbindString, _1: EmbindString): void;
+  read(_0: EmbindString): boolean;
   addSubgraph(_0: EmbindString): CSubgraph | null;
   getSubgraph(_0: EmbindString): CSubgraph | null;
   removeNode(_0: EmbindString): void;
+  removeEdge(_0: EmbindString, _1: EmbindString): void;
   removeEdge(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
   removeSubgraph(_0: EmbindString): void;
   hasNode(_0: EmbindString): boolean;
+  hasEdge(_0: EmbindString, _1: EmbindString): boolean;
   hasEdge(_0: EmbindString, _1: EmbindString, _2: EmbindString): boolean;
   hasSubgraph(_0: EmbindString): boolean;
+  nodeDegree(_0: EmbindString): number;
+  nodeDegree(_0: EmbindString, _1: number): number;
+  nodeDegree(_0: EmbindString, _1: number, _2: number): number;
   getGraphAttr(_0: EmbindString): string;
   getNodeAttr(_0: EmbindString, _1: EmbindString): string;
   getEdgeAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString): string;
@@ -82,6 +111,7 @@ export interface CGraph extends ClassHandle {
   outEdges(_0: EmbindString): string;
   inEdges(_0: EmbindString): string;
   nodeEdges(_0: EmbindString): string;
+  write(): string;
   toDot(): string;
   layout(_0: EmbindString, _1: EmbindString): string;
 }
@@ -90,14 +120,35 @@ export interface CSubgraph extends ClassHandle {
   nodeCount(): number;
   edgeCount(): number;
   addNode(_0: EmbindString): void;
+  addEdge(_0: EmbindString, _1: EmbindString): void;
   addEdge(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
   setAttr(_0: EmbindString, _1: EmbindString): void;
+  setAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
+  setHtmlAttr(_0: EmbindString, _1: EmbindString): void;
+  setHtmlAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
   setNodeAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
+  setNodeAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString): void;
+  setNodeHtmlAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
+  setNodeHtmlAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString): void;
   setEdgeAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString, _4: EmbindString): void;
+  setEdgeAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString, _4: EmbindString, _5: EmbindString): void;
+  setEdgeHtmlAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString, _4: EmbindString): void;
+  setEdgeHtmlAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString, _4: EmbindString, _5: EmbindString): void;
+  setDefaultAttr(_0: EmbindString, _1: EmbindString): void;
+  setDefaultHtmlAttr(_0: EmbindString, _1: EmbindString): void;
+  setDefaultNodeAttr(_0: EmbindString, _1: EmbindString): void;
+  setDefaultNodeHtmlAttr(_0: EmbindString, _1: EmbindString): void;
+  setDefaultEdgeAttr(_0: EmbindString, _1: EmbindString): void;
+  setDefaultEdgeHtmlAttr(_0: EmbindString, _1: EmbindString): void;
   removeNode(_0: EmbindString): void;
+  removeEdge(_0: EmbindString, _1: EmbindString): void;
   removeEdge(_0: EmbindString, _1: EmbindString, _2: EmbindString): void;
   hasNode(_0: EmbindString): boolean;
+  hasEdge(_0: EmbindString, _1: EmbindString): boolean;
   hasEdge(_0: EmbindString, _1: EmbindString, _2: EmbindString): boolean;
+  nodeDegree(_0: EmbindString): number;
+  nodeDegree(_0: EmbindString, _1: number): number;
+  nodeDegree(_0: EmbindString, _1: number, _2: number): number;
   getAttr(_0: EmbindString): string;
   getNodeAttr(_0: EmbindString, _1: EmbindString): string;
   getEdgeAttr(_0: EmbindString, _1: EmbindString, _2: EmbindString, _3: EmbindString): string;
@@ -111,6 +162,7 @@ export interface CSubgraph extends ClassHandle {
 interface EmbindModule {
   CGraphviz: {
     new(): CGraphviz;
+    new(_0: number): CGraphviz;
     new(_0: number, _1: number): CGraphviz;
     version(): string;
     lastError(): string;

package/types/types.d.ts

@@ -40,6 +40,7 @@ export interface NodeAttrs {
     group?: string;
     height?: number;
     href?: string;
+    id?: string;
     image?: string;
     imagepos?: string;
     imagescale?: boolean | string;
@@ -102,6 +103,7 @@ export interface EdgeAttrs {
     headtooltip?: string;
     headURL?: string;
     href?: string;
+    id?: string;
     label?: string;
     labelangle?: number;
     labeldistance?: number;
@@ -156,6 +158,7 @@ export interface ClusterAttrs {
     fontsize?: number;
     gradientangle?: number;
     href?: string;
+    id?: string;
     K?: number;
     label?: string;
     labeljust?: string;