ts-graphviz 1.5.4 → 1.5.5-dev.02afc3340

package/lib/ast/index.js

@@ -2,17 +2,34 @@ import { pipe, map } from '../utils/index.js';
 import { isNodeModel, isForwardRefNode, createModelsContext } from '../common/index.js';
 
 /**
+ * Builder is an ASTBuilder that provides a method to create an ASTNode.
+ *
  * @group Create AST
  */
 class Builder {
   options;
-  /** @internal */
+  /**
+   * Get the current file range or null
+   * @internal
+   */
   getLocation() {
     return this.options?.locationFunction?.() ?? null;
   }
+  /**
+   * Constructor of Builder
+   * @param options - Options to initialize Builder
+   */
   constructor(options) {
     this.options = options;
   }
+  /**
+   * Create an {@link ASTNode} of the specified type
+   *
+   * @param type - Type of the {@link ASTNode}
+   * @param props - Properties of the {@link ASTNode}
+   * @param children - Children of the {@link ASTNode}
+   * @returns An {@link ASTNode}
+   */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   createElement(type, props, children) {
     return {
@@ -25,7 +42,13 @@ class Builder {
 }
 
 /**
+ * Create an {@link ASTNode} of the specified type
+ *
+ * @param type - Type of the {@link ASTNode}
+ * @param props - Properties of the {@link ASTNode}
+ * @param children - Children of the {@link ASTNode}
  * @group Create AST
+ * @returns An {@link ASTNode}
  */
 const createElement = Builder.prototype.createElement.bind(new Builder());
 
@@ -259,15 +282,24 @@ const defaultPlugins$2 = [
 ];
 
 /**
+ * Printer is a class responsible for converting an AST into a DOT string.
  * @group Convert AST to DOT
  */
 class Printer {
   options;
   /** @internal */
   #plugins = [...defaultPlugins$2];
+  /**
+   * @param options Options to be used when generating the DOT string.
+   */
   constructor(options = {}) {
     this.options = options;
   }
+  /**
+   * Generates a DOT string from an ASTNode.
+   * @param ast The ASTNode to be converted into a DOT string.
+   * @returns The DOT string generated from the ASTNode.
+   */
   print(ast) {
     const plugins = [...this.#plugins];
     const { indentSize = 2, indentStyle = 'space', endOfLine = 'lf' } = this.options;
@@ -290,10 +322,11 @@ class Printer {
 }
 
 /**
- * Stringify Graphviz AST Node.
+ * stringify is a function that converts a Graphviz AST Node into a string in DOT language.
  *
- * @param ast Graphviz AST node.
- * @returns DOT language string.
+ * @param ast Graphviz AST node that is to be converted.
+ * @param options PrintOptions object containing formatting options.
+ * @returns A string in DOT language.
  * @group Convert AST to DOT
  */
 function stringify(ast, options) {
@@ -5556,6 +5589,8 @@ const SubgraphPlugin$1 = {
 const defaultPlugins$1 = [AttributeListPlugin, EdgePlugin$1, NodePlugin$1, GraphPlugin$1, SubgraphPlugin$1];
 
 /**
+ * FromModelConverter is a class used to convert a {@link DotObjectModel} into an ASTNode.
+ *
  * @group Convert Model to AST
  */
 class FromModelConverter {
@@ -5565,6 +5600,12 @@ class FromModelConverter {
   constructor(options = {}) {
     this.options = options;
   }
+  /**
+   * Converts a DotObjectModel into an AST.
+   *
+   * @param model The {@link DotObjectModel} to be converted.
+   * @returns The AST generated from the model.
+   */
   convert(model) {
     const plugins = [...this.#plugins];
     const { commentKind = 'Slash' } = this.options;
@@ -5584,6 +5625,12 @@ class FromModelConverter {
 }
 
 /**
+ * A function used to convert a DotObjectModel into an AST.
+ *
+ * @param model - The {@link DotObjectModel} to be converted.
+ * @param options - An optional {@link ConvertFromModelOptions} object.
+ * @returns ModelToAST - The AST representation of the {@link DotObjectModel}.
+ *
  * @group Convert Model to AST
  */
 function fromModel(model, options) {

package/lib/common/index.d.ts

@@ -1434,6 +1434,9 @@ type AttributeKey =
   | SubgraphAttributeKey
   | ClusterSubgraphAttributeKey;
 
+/**
+ * KeyValueMapping is an interface that defines a set of attributes that can be used to configure a graph.
+ */
 interface KeyValueMapping {
   _background: string;
   area: Double;
@@ -1609,6 +1612,9 @@ interface KeyValueMapping {
   z: Blank | Double;
 }
 /**
+ * This type represents an Attribute, which is a key-value mapping of an {@link AttributeKey} to a value.
+ *
+ * @param T The {@link AttributeKey} to be mapped to a value.
  * @group Attribute
  */
 type Attribute<T extends AttributeKey> = KeyValueMapping[T];
@@ -1636,6 +1642,7 @@ declare const RootModelsContext: ModelsContext;
 declare function createModelsContext(models: Partial<ModelsContext>): ModelsContext;
 
 /**
+ * ASTType is an enumeration of the different types of nodes that can be found in an AST(Abstract Syntax Tree ).
  * @group Models
  */
 type ASTType =
@@ -1725,9 +1732,15 @@ type SubgraphAttributesObject = AttributesObject<ClusterSubgraphAttributeKey | S
  */
 type DotObjectType = 'AttributeList' | 'Node' | 'Edge' | 'Subgraph' | 'Graph';
 /**
+ * DotObjectModel is an interface that defines a generic type for a {@link DotObjectType}.
+ *
+ * @template T The type of the {@link DotObjectType}.
  * @group Models
  */
 interface DotObjectModel<T extends DotObjectType = DotObjectType> {
+  /**
+   * The type of the DotObjectType.
+   */
   $$type: T;
 }
 /**

package/lib/core/index.cjs

@@ -335,7 +335,14 @@ Object.assign(index_js.RootModelsContext, {
   Edge,
 });
 
-/** @hidden */
+/**
+ * ModelFactoryBuilder is a function that takes two parameters, directed and strictMode, and returns a ModelFactory.
+ *
+ * @param directed A boolean value indicating whether the graph should be directed or not.
+ * @param strictMode A boolean value indicating whether the graph should be in strict mode or not.
+ * @returns A ModelFactory that takes an array of unknowns as parameters and returns a RootGraphModel.
+ * @hidden
+ */
 function ModelFactoryBuilder(directed, strictMode) {
   return (...args) => {
     const G = directed ? this.Digraph : this.Graph;
@@ -350,6 +357,13 @@ function ModelFactoryBuilder(directed, strictMode) {
     return g;
   };
 }
+/**
+ * createModelFactories is a function that takes a boolean value, strict, and an optional ModelsContext parameter, context, and returns an object containing two ModelFactories.
+ *
+ * @param strict A boolean value indicating whether the graph should be in strict mode or not.
+ * @param context An optional ModelsContext parameter.
+ * @returns An object containing two ModelFactories, one for directed graphs and one for undirected graphs.
+ */
 function createModelFactories(strict, context = index_js.RootModelsContext) {
   return Object.freeze({
     digraph: ModelFactoryBuilder.call(context, true, strict),
@@ -359,12 +373,12 @@ function createModelFactories(strict, context = index_js.RootModelsContext) {
 
 const noStrict = createModelFactories(false);
 /**
- * API for creating directional graph objects.
+ *  digraph is a factory for creating Digraph objects.
  * @group Model Factory
  */
 const digraph = noStrict.digraph;
 /**
- * API for creating omnidirectional graph objects.
+ * graph is a factory for creating Graph objects.
  * @group Model Factory
  */
 const graph = noStrict.graph;
@@ -374,7 +388,11 @@ const graph = noStrict.graph;
  */
 const strict = createModelFactories(true);
 /**
- * @group Model Factory
+ * withContext creates a {@link ModelFactoriesWithStrict} object with the given context.
+ *
+ * @param models - An object containing the models to be used in the context.
+ *
+ * @returns A ModelFactoriesWithStrict object containing the factories. * @group Model Factory
  */
 function withContext(models) {
   const context = index_js.createModelsContext(models);
@@ -390,7 +408,7 @@ function withContext(models) {
  * @group Convert Model to DOT
  *
  * @param model Dot Object Model, like {@link Digraph}, {@link Graph}, {@link Subgraph}, {@link Node}, and {@link Edge}
- * @param options
+ * @param options Optional options for the conversion.
  * @returns DOT string
  */
 function toDot(model, options) {

package/lib/core/index.d.ts

@@ -2680,6 +2680,13 @@ declare class Subgraph extends GraphBase<SubgraphAttributeKey | ClusterSubgraphA
 }
 
 /**
+ * ModelFactory is an interface that provides a way to create a {@link RootGraphModel} object.
+ *
+ * @param id - Optional string parameter that specifies the id of the {@link RootGraphModel} object.
+ * @param attributes - Optional GraphAttributesObject parameter that specifies the attributes of the {@link RootGraphModel} object.
+ * @param callback - Optional callback function that takes a {@link RootGraphModel} object as a parameter.
+ *
+ * @returns {@link RootGraphModel} - Returns a {@link RootGraphModel} object.
  * @group Model Factory
  */
 interface ModelFactory {
@@ -2709,12 +2716,12 @@ interface ModelFactoriesWithStrict extends ModelFactories {
 }
 
 /**
- * API for creating directional graph objects.
+ *  digraph is a factory for creating Digraph objects.
  * @group Model Factory
  */
 declare const digraph: ModelFactory;
 /**
- * API for creating omnidirectional graph objects.
+ * graph is a factory for creating Graph objects.
  * @group Model Factory
  */
 declare const graph: ModelFactory;
@@ -2724,16 +2731,27 @@ declare const graph: ModelFactory;
  */
 declare const strict: ModelFactories;
 /**
- * @group Model Factory
+ * withContext creates a {@link ModelFactoriesWithStrict} object with the given context.
+ *
+ * @param models - An object containing the models to be used in the context.
+ *
+ * @returns A ModelFactoriesWithStrict object containing the factories. * @group Model Factory
  */
 declare function withContext(models: Partial<ModelsContext>): ModelFactoriesWithStrict;
 
 /**
+ * This interface provides options for converting a model to DOT.
  * @group Convert Model to DOT
  * @alpha
  */
 interface ToDotOptions {
+  /**
+   * Options for converting the model to DOT.
+   */
   convert?: ConvertFromModelOptions;
+  /**
+   * Options for printing DOT.
+   */
   print?: PrintOptions;
 }
 /**
@@ -2742,27 +2760,35 @@ interface ToDotOptions {
  * @group Convert Model to DOT
  *
  * @param model Dot Object Model, like {@link Digraph}, {@link Graph}, {@link Subgraph}, {@link Node}, and {@link Edge}
- * @param options
+ * @param options Optional options for the conversion.
  * @returns DOT string
  */
 declare function toDot(model: DotObjectModel, options?: ToDotOptions): string;
 
 /**
- * @group Convert DOT to DOT
+ * This interface provides options for converting DOT to a model.
+ * @group Convert DOT to Model
  * @alpha
  */
 interface FromDotOptions<T extends 'Dot' | 'Graph' | 'Node' | 'Edge' | 'Subgraph'> {
+  /**
+   * Options for parsing DOT.
+   */
   parse?: ParseOptions<T>;
+  /**
+   * Options for converting the parsed DOT to a model.
+   */
   convert?: ConvertToModelOptions;
 }
 /**
- * Convert DOT string to Model.
+ * fromDot is a function that converts a DOT string to a model.
  *
  * @group Convert DOT to Model
  *
- * @param dot DOT string
- * @param options
- * @returns Dot Object Model, like {@link Digraph}, {@link Graph}, {@link Subgraph}, {@link Node}, and {@link Edge}
+ * @param dot The DOT string to convert.
+ * @param options Options for converting the DOT string to a model.
+ * @returns A model of type {@link RootGraphModel}, {@link NodeModel}, {@link EdgeModel}, or {@link SubgraphModel},
+ * depending on the type specified in the options.
  * @beta
  */
 declare function fromDot(dot: string, options?: FromDotOptions<'Dot' | 'Graph'>): RootGraphModel;

package/lib/core/index.js

@@ -338,7 +338,14 @@ Object.assign(RootModelsContext, {
   Edge,
 });
 
-/** @hidden */
+/**
+ * ModelFactoryBuilder is a function that takes two parameters, directed and strictMode, and returns a ModelFactory.
+ *
+ * @param directed A boolean value indicating whether the graph should be directed or not.
+ * @param strictMode A boolean value indicating whether the graph should be in strict mode or not.
+ * @returns A ModelFactory that takes an array of unknowns as parameters and returns a RootGraphModel.
+ * @hidden
+ */
 function ModelFactoryBuilder(directed, strictMode) {
   return (...args) => {
     const G = directed ? this.Digraph : this.Graph;
@@ -353,6 +360,13 @@ function ModelFactoryBuilder(directed, strictMode) {
     return g;
   };
 }
+/**
+ * createModelFactories is a function that takes a boolean value, strict, and an optional ModelsContext parameter, context, and returns an object containing two ModelFactories.
+ *
+ * @param strict A boolean value indicating whether the graph should be in strict mode or not.
+ * @param context An optional ModelsContext parameter.
+ * @returns An object containing two ModelFactories, one for directed graphs and one for undirected graphs.
+ */
 function createModelFactories(strict, context = RootModelsContext) {
   return Object.freeze({
     digraph: ModelFactoryBuilder.call(context, true, strict),
@@ -362,12 +376,12 @@ function createModelFactories(strict, context = RootModelsContext) {
 
 const noStrict = createModelFactories(false);
 /**
- * API for creating directional graph objects.
+ *  digraph is a factory for creating Digraph objects.
  * @group Model Factory
  */
 const digraph = noStrict.digraph;
 /**
- * API for creating omnidirectional graph objects.
+ * graph is a factory for creating Graph objects.
  * @group Model Factory
  */
 const graph = noStrict.graph;
@@ -377,7 +391,11 @@ const graph = noStrict.graph;
  */
 const strict = createModelFactories(true);
 /**
- * @group Model Factory
+ * withContext creates a {@link ModelFactoriesWithStrict} object with the given context.
+ *
+ * @param models - An object containing the models to be used in the context.
+ *
+ * @returns A ModelFactoriesWithStrict object containing the factories. * @group Model Factory
  */
 function withContext(models) {
   const context = createModelsContext(models);
@@ -393,7 +411,7 @@ function withContext(models) {
  * @group Convert Model to DOT
  *
  * @param model Dot Object Model, like {@link Digraph}, {@link Graph}, {@link Subgraph}, {@link Node}, and {@link Edge}
- * @param options
+ * @param options Optional options for the conversion.
  * @returns DOT string
  */
 function toDot(model, options) {

package/package.json

@@ -1,125 +1,125 @@
 {
-  "name": "ts-graphviz",
-  "version": "1.5.4",
-  "author": "kamiazya <yuki@kamiazya.tech>",
-  "description": "Graphviz library for TypeScript.",
-  "homepage": "https://ts-graphviz.github.io/ts-graphviz/",
-  "type": "module",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ts-graphviz/ts-graphviz.git"
-  },
-  "keywords": [
-    "graphviz",
-    "dot"
-  ],
-  "bugs": {
-    "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
-  },
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/kamiazya"
-  },
-  "main": "./lib/index.cjs",
-  "module": "./lib/index.js",
-  "types": "lib/index.d.ts",
-  "exports": {
-    ".": {
-      "require": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.cjs"
-      },
-      "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
-      }
+    "name": "ts-graphviz",
+    "version": "1.5.5-dev.02afc3340",
+    "author": "kamiazya <yuki@kamiazya.tech>",
+    "description": "Graphviz library for TypeScript.",
+    "homepage": "https://ts-graphviz.github.io/ts-graphviz/",
+    "type": "module",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/ts-graphviz/ts-graphviz.git"
     },
-    "./ast": {
-      "require": {
-        "types": "./lib/ast/index.d.ts",
-        "default": "./lib/ast/index.cjs"
-      },
-      "import": {
-        "types": "./lib/ast/index.d.ts",
-        "default": "./lib/ast/index.js"
-      }
+    "keywords": [
+        "graphviz",
+        "dot"
+    ],
+    "bugs": {
+        "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
     },
-    "./adapter": {
-      "browser": {
-        "require": "./lib/adapter/browser/index.cjs",
-        "import": "./lib/adapter/browser/index.js",
-        "types": "./lib/adapter/browser/index.d.ts"
-      },
-      "deno": {
-        "types": "./lib/adapter/deno/mod.d.ts",
-        "default": "./lib/adapter/deno/mod.js"
-      },
-      "node": {
-        "require": "./lib/adapter/node/index.cjs",
-        "import": "./lib/adapter/node/index.js",
-        "types": "./lib/adapter/node/index.d.ts"
-      },
-      "default": {
-        "types": "./lib/adapter/node/index.d.ts",
-        "require": "./lib/adapter/node/index.cjs",
-        "import": "./lib/adapter/node/index.js"
-      }
+    "funding": {
+        "type": "github",
+        "url": "https://github.com/sponsors/kamiazya"
     },
-    "./package.json": "./package.json"
-  },
-  "typesVersions": {
-    "*": {
-      "ast": [
-        "lib/ast"
-      ],
-      "adapter": [
-        "lib/adapter/node"
-      ]
+    "main": "./lib/index.cjs",
+    "module": "./lib/index.js",
+    "types": "lib/index.d.ts",
+    "exports": {
+        ".": {
+            "require": {
+                "types": "./lib/index.d.ts",
+                "default": "./lib/index.cjs"
+            },
+            "import": {
+                "types": "./lib/index.d.ts",
+                "default": "./lib/index.js"
+            }
+        },
+        "./ast": {
+            "require": {
+                "types": "./lib/ast/index.d.ts",
+                "default": "./lib/ast/index.cjs"
+            },
+            "import": {
+                "types": "./lib/ast/index.d.ts",
+                "default": "./lib/ast/index.js"
+            }
+        },
+        "./adapter": {
+            "browser": {
+                "require": "./lib/adapter/browser/index.cjs",
+                "import": "./lib/adapter/browser/index.js",
+                "types": "./lib/adapter/browser/index.d.ts"
+            },
+            "deno": {
+                "types": "./lib/adapter/deno/mod.d.ts",
+                "default": "./lib/adapter/deno/mod.js"
+            },
+            "node": {
+                "require": "./lib/adapter/node/index.cjs",
+                "import": "./lib/adapter/node/index.js",
+                "types": "./lib/adapter/node/index.d.ts"
+            },
+            "default": {
+                "types": "./lib/adapter/node/index.d.ts",
+                "require": "./lib/adapter/node/index.cjs",
+                "import": "./lib/adapter/node/index.js"
+            }
+        },
+        "./package.json": "./package.json"
+    },
+    "typesVersions": {
+        "*": {
+            "ast": [
+                "lib/ast"
+            ],
+            "adapter": [
+                "lib/adapter/node"
+            ]
+        }
+    },
+    "license": "MIT",
+    "engines": {
+        "node": ">=14.16"
+    },
+    "runkitExampleFilename": "example/runkit.cjs",
+    "scripts": {
+        "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:deno": "mkdir -p lib/adapter/deno && cp -r src/adapter/deno/* lib/adapter/deno && sed -i \"s/index.ts/index.js/g\" lib/adapter/deno/mod.js && sed -i \"s/index.ts/index.d.ts/g\" lib/adapter/deno/mod.d.ts",
+        "build:node": "tsc -p tsconfig.build.json && rollup -c",
+        "build": "yarn build:node && yarn build:deno",
+        "postbuild": "prettier --write ./lib/**/*.{js,cjs,d.ts}",
+        "pretest": "yarn build:peggy",
+        "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest",
+        "format": "eslint --ext ts src --fix && prettier --write './**/*.{ts,js,json,yaml}' '!lib'",
+        "lint": "eslint --ext ts src",
+        "predoc": "yarn build:peggy",
+        "doc": "typedoc"
+    },
+    "devDependencies": {
+        "@rollup/plugin-replace": "^5.0.2",
+        "@types/jest": "^29.4.0",
+        "@types/jest-specific-snapshot": "^0.5.6",
+        "@typescript-eslint/eslint-plugin": "^5.49.0",
+        "@typescript-eslint/parser": "^5.49.0",
+        "eslint": "^8.32.0",
+        "eslint-config-prettier": "^8.6.0",
+        "eslint-plugin-import": "^2.27.5",
+        "eslint-plugin-jest": "^27.2.1",
+        "eslint-plugin-prettier": "^4.2.1",
+        "jest": "^29.4.1",
+        "jest-snapshot-serializer-raw": "^1.2.0",
+        "jest-specific-snapshot": "^7.0.0",
+        "peggy": "^2.0.1",
+        "prettier": "^2.8.3",
+        "prettier-plugin-pegjs": "^0.5.0",
+        "rollup": "^3.11.0",
+        "rollup-plugin-delete": "^2.0.0",
+        "rollup-plugin-dts": "5.1.1",
+        "svgo": "^3.0.2",
+        "ts-jest": "^29.0.5",
+        "ts-pegjs": "^3.0.0",
+        "typedoc": "^0.23.15",
+        "typescript": "^4.7.4"
     }
-  },
-  "license": "MIT",
-  "engines": {
-    "node": ">=14.16"
-  },
-  "runkitExampleFilename": "example/runkit.cjs",
-  "scripts": {
-    "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:deno": "mkdir -p lib/adapter/deno && cp -r src/adapter/deno/* lib/adapter/deno && sed -i \"s/index.ts/index.js/g\" lib/adapter/deno/mod.js && sed -i \"s/index.ts/index.d.ts/g\" lib/adapter/deno/mod.d.ts",
-    "build:node": "tsc -p tsconfig.build.json && rollup -c",
-    "build": "yarn build:node && yarn build:deno",
-    "postbuild": "prettier --write ./lib/**/*.{js,cjs,d.ts}",
-    "pretest": "yarn build:peggy",
-    "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest",
-    "format": "eslint --ext ts src --fix && prettier --write './**/*.{ts,js,json,yaml}' '!lib'",
-    "lint": "eslint --ext ts src",
-    "predoc": "yarn build:peggy",
-    "doc": "typedoc"
-  },
-  "devDependencies": {
-    "@rollup/plugin-replace": "^5.0.2",
-    "@types/jest": "^29.4.0",
-    "@types/jest-specific-snapshot": "^0.5.6",
-    "@typescript-eslint/eslint-plugin": "^5.49.0",
-    "@typescript-eslint/parser": "^5.49.0",
-    "eslint": "^8.32.0",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^29.4.1",
-    "jest-snapshot-serializer-raw": "^1.2.0",
-    "jest-specific-snapshot": "^7.0.0",
-    "peggy": "^2.0.1",
-    "prettier": "^2.8.3",
-    "prettier-plugin-pegjs": "^0.5.0",
-    "rollup": "^3.11.0",
-    "rollup-plugin-delete": "^2.0.0",
-    "rollup-plugin-dts": "5.1.1",
-    "svgo": "^3.0.2",
-    "ts-jest": "^29.0.5",
-    "ts-pegjs": "^3.0.0",
-    "typedoc": "^0.23.15",
-    "typescript": "^4.7.4"
-  }
-}
+}