ts-graphviz 1.0.0-3 → 1.0.1

package/lib/core/index.js

@@ -1,19 +1,21 @@
 import { isNodeRefGroupLike, toNodeRefGroup, toNodeRef, isNodeRefLike } from '#lib/common';
 import { fromModel, stringify } from '#lib/ast';
 
+/**
+ * @group Attribute
+ */
 const attribute = new Proxy(Object.freeze({}), {
   get: (_, key) => key,
 });
 
 /**
- * Classes implemented in the 'ts-graphviz' library are designed to inherit from this class.
- */
-class GraphvizObject {}
-/**
- * Classes implemented in the 'ts-graphviz' library that implement the `toDot` method are designed to inherit from this class.
+ * Base class for DOT objects.
+ * @group Models
  */
-class DotObject extends GraphvizObject {}
+class DotObject {}
 /**
+ * Base class for DOT objects with attributes.
+ * @group Models
  */
 class AttributesBase extends DotObject {
   /** @hidden */
@@ -27,15 +29,12 @@ class AttributesBase extends DotObject {
   get values() {
     return Array.from(this.#attrs.entries());
   }
-  /** The size of the attribute. */
   get size() {
     return this.#attrs.size;
   }
-  /** The size of the attribute. */
   get(key) {
     return this.#attrs.get(key);
   }
-  /** Set a value to the attribute. */
   set(key, value) {
     if (value !== null && value !== undefined) {
       this.#attrs.set(key, value);
@@ -56,20 +55,20 @@ class AttributesBase extends DotObject {
 }
 /**
  * A set of attribute values for any object.
+ * @group Models
  */
 class AttributesGroupModel extends AttributesBase {
-  /** Comments to include when outputting with toDot. */
   comment;
 }
 /**
  * A set of attribute values for any object.
+ * @group Models
  */
 class AttributeList extends AttributesBase {
   $$kind;
   get $$type() {
     return 'AttributeList';
   }
-  /** Comments to include when outputting with toDot. */
   comment;
   constructor($$kind, attributes) {
     super(attributes);
@@ -77,73 +76,42 @@ class AttributeList extends AttributesBase {
   }
 }
 /**
- * Base class for clusters.
- * @hidden
+ * Base class for Graph objects.
+ * @group Models
  */
 class GraphBase extends AttributesBase {
-  /** Cluster ID */
   id;
-  /** Comments to include when outputting with toDot. */
   comment;
-  /**
-   * Nodes in the cluster.
-   * @hidden
-   */
   get nodes() {
     return Array.from(this.#objects.nodes.values());
   }
-  /**
-   * Edges in the cluster.
-   * @hidden
-   */
   get edges() {
     return Array.from(this.#objects.edges.values());
   }
-  /**
-   * Subgraphs in the cluster.
-   * @hidden
-   */
   get subgraphs() {
     return Array.from(this.#objects.subgraphs.values());
   }
+  /** @hidden */
   #objects = {
     nodes: new Map(),
     edges: new Set(),
     subgraphs: new Set(),
   };
-  /**
-   * Add a Node to the cluster.
-   */
   addNode(node) {
     this.#objects.nodes.set(node.id, node);
   }
-  /**
-   * Add Edge to the cluster.
-   */
   addEdge(edge) {
     this.#objects.edges.add(edge);
   }
-  /**
-   * Add a Subgraph to the cluster.
-   */
   addSubgraph(subgraph) {
     this.#objects.subgraphs.add(subgraph);
   }
-  /**
-   * Check if the Node exists in the cluster.
-   */
   existNode(nodeId) {
     return this.#objects.nodes.has(nodeId);
   }
-  /**
-   * Check if the Edge exists in the cluster.
-   */
   existEdge(edge) {
     return this.#objects.edges.has(edge);
   }
-  /**
-   * Check if the Subgraph exists in the cluster.
-   */
   existSubgraph(subgraph) {
     return this.#objects.subgraphs.has(subgraph);
   }
@@ -154,50 +122,26 @@ class GraphBase extends AttributesBase {
     this.#objects.subgraphs.add(graph);
     return graph;
   }
-  /**
-   * Remove Node from the cluster.
-   */
   removeNode(node) {
     this.#objects.nodes.delete(typeof node === 'string' ? node : node.id);
   }
-  /**
-   * Remove Edge from the cluster.
-   */
   removeEdge(edge) {
     this.#objects.edges.delete(edge);
   }
-  /**
-   * Remove Subgraph from the cluster.
-   */
   removeSubgraph(subgraph) {
     this.#objects.subgraphs.delete(subgraph);
   }
-  /**
-   * Create a Node in the cluster.
-   */
   createNode(id, attributes) {
     const node = new Node(id, attributes);
     this.#objects.nodes.set(id, node);
     return node;
   }
-  /**
-   * Get Subgraph in cluster by specifying id.
-   *
-   * If there is no Subgraph with the specified id in the cluster, return undefined.
-   */
   getSubgraph(id) {
     return Array.from(this.#objects.subgraphs.values()).find((subgraph) => subgraph.id === id);
   }
-  /**EdgeAttributesObject
-   * Get Node in cluster by specifying id.
-   *
-   * @description
-   * If there is no Node with the specified id in the cluster, return undefined.
-   */
   getNode(id) {
     return this.#objects.nodes.get(id);
   }
-  /** Create Edge and add it to the cluster. */
   createEdge(targets, attributes) {
     const ts = targets.map((t) => (isNodeRefGroupLike(t) ? toNodeRefGroup(t) : toNodeRef(t)));
     const edge = new Edge(ts, attributes);
@@ -250,33 +194,13 @@ class GraphBase extends AttributesBase {
       this.attributes.edge.apply(firstArg);
     }
   }
-  /**
-   * Set a common attribute for the clusters in the cluster.
-   *
-   * ```ts
-   * const G = digraph('G', (g) => {
-   *   g.graph({
-   *     [attribute.color]: 'red',
-   *     [attribute.label]: 'my label',
-   *   });
-   * });
-   *
-   * console.log(toDot(G));
-   * // digraph "G" {
-   * //   graph [
-   * //     color = "red",
-   * //     label = "my label",
-   * //   ];
-   * // }
-   * ```
-   * @param attributes Object of attributes to be adapted to the clusters.
-   */
   graph(attributes) {
     this.attributes.graph.apply(attributes);
   }
 }
 /**
- * Subgraph object.
+ * DOT object class representing a subgraph.
+ * @group Models
  */
 class Subgraph extends GraphBase {
   get $$type() {
@@ -296,7 +220,6 @@ class Subgraph extends GraphBase {
       this.apply(attributes);
     }
   }
-  /** Determines whether the Subgraph is a SubgraphCluster. */
   isSubgraphCluster() {
     if (typeof this.id === 'string') {
       return this.id.startsWith('cluster');
@@ -305,14 +228,14 @@ class Subgraph extends GraphBase {
   }
 }
 /**
- * Node object.
+ * DOT object class representing a node.
+ * @group Models
  */
 class Node extends DotObject {
   id;
   get $$type() {
     return 'Node';
   }
-  /** Comments to include when outputting with toDot. */
   comment;
   attributes;
   constructor(id, attributes) {
@@ -320,7 +243,6 @@ class Node extends DotObject {
     this.id = id;
     this.attributes = new AttributesGroupModel(attributes);
   }
-  /** Returns ForwardRefNode with port and compass specified. */
   port(port) {
     if (typeof port === 'string') {
       return { id: this.id, port };
@@ -329,13 +251,14 @@ class Node extends DotObject {
   }
 }
 /**
+ * DOT object class representing a edge.
+ * @group Models
  */
 class Edge extends DotObject {
   targets;
   get $$type() {
     return 'Edge';
   }
-  /** Comments to include when outputting with toDot. */
   comment;
   attributes;
   constructor(targets, attributes) {
@@ -348,23 +271,14 @@ class Edge extends DotObject {
   }
 }
 /**
- * Base class for RootGraph.
- *
+ * Base class representing a root graph(digraph, graph).
+ * @group Models
  */
 class RootGraph extends GraphBase {
   get $$type() {
     return 'Graph';
   }
   id;
-  /**
-   * Strict mode.
-   *
-   * @description
-   * A graph may also be described as strict.
-   * This forbids the creation of multi-edges, i.e., there can be at most one edge with a given tail node and head node in the directed case.
-   * For undirected graphs, there can be at most one edge connected to the same two nodes.
-   * Subsequent edge statements using the same two nodes will identify the edge with the previously defined one and apply any attributes given in the edge statement.
-   */
   strict;
   attributes = Object.freeze({
     graph: new AttributeList('Graph'),
@@ -381,11 +295,19 @@ class RootGraph extends GraphBase {
     }
   }
 }
+/**
+ * DOT object class representing a graph.
+ * @group Models
+ */
 class Graph extends RootGraph {
   get directed() {
     return false;
   }
 }
+/**
+ * DOT object class representing a digraph.
+ * @group Models
+ */
 class Digraph extends RootGraph {
   get directed() {
     return true;
@@ -406,18 +328,42 @@ function builder(directed, strictMode) {
     return g;
   };
 }
-/** API for creating directional graph objects. */
+/**
+ * API for creating directional graph objects.
+ * @group Model Builder
+ */
 const digraph = builder(true, false);
-/** API for creating omnidirectional graph objects. */
+/**
+ * API for creating omnidirectional graph objects.
+ * @group Model Builder
+ */
 const graph = builder(false, false);
-/** Provides a strict mode API. */
+/**
+ * Provides a strict mode API.
+ * @group Model Builder
+ */
 const strict = Object.freeze({
-  /** API for creating directional graph objects in strict mode. */
+  /**
+   * API for creating directional graph objects in strict mode.
+   * @group Model Builder
+   */
   digraph: builder(true, true),
-  /** API for creating omnidirectional graph objects in strict mode. */
+  /**
+   * API for creating omnidirectional graph objects in strict mode.
+   * @group Model Builder
+   */
   graph: builder(false, true),
 });
 
+/**
+ * Convert Model to DOT string.
+ *
+ * @group Convert Model to DOT
+ *
+ * @param model Dot Object Model, like {@link Digraph}, {@link Graph}, {@link Node}, and {@link Edge}
+ * @param options
+ * @returns DOT string
+ */
 function toDot(model, options) {
   const ast = fromModel(model, options?.convert);
   return stringify(ast, options?.print);
@@ -432,7 +378,6 @@ export {
   Edge,
   Graph,
   GraphBase,
-  GraphvizObject,
   Node,
   RootGraph,
   Subgraph,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-graphviz",
-  "version": "1.0.0-3",
+  "version": "1.0.1",
   "author": "kamiazya <yuki@kamiazya.tech>",
   "description": "Graphviz library for TypeScript.",
   "homepage": "https://ts-graphviz.github.io/ts-graphviz/",
@@ -47,7 +47,7 @@
     "node": ">=14.16"
   },
   "scripts": {
-    "build:peggy": "peggy --plugin ts-pegjs --extra-options-file src/ast/parser/peggy.options.json -o src/ast/parser/index.ts src/ast/parser/dot.peggy",
+    "build:peggy": "peggy --plugin ts-pegjs --extra-options-file src/ast/dot-shim/parser/peggy.options.json -o src/ast/dot-shim/parser/_parse.ts src/ast/dot-shim/parser/dot.peggy",
     "prebuild": "yarn build:peggy",
     "build": "tsc -p tsconfig.build.json && rollup -c",
     "postbuild": "prettier --write ./lib/**/index.{js,cjs,d.ts}",
@@ -80,7 +80,7 @@
     "svgo": "^2.8.0",
     "ts-jest": "^28.0.7",
     "ts-pegjs": "^2.1.0",
-    "typedoc": "^0.22.4",
+    "typedoc": "^0.23.15",
     "typescript": "^4.7.4"
   }
 }