ts-graphviz 1.5.5-dev.02afc3340 → 1.5.5-dev.27273c787

package/lib/adapter/browser/index.cjs

@@ -1,20 +1,9 @@
 'use strict';
 
-/**
- * @module ts-graphviz/adapter
- * @beta
- */
-/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any */
 const ERROR_MESSAGE = 'This module cannot be run in a browser.';
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
 function toStream(dot, options) {
   throw new Error(ERROR_MESSAGE);
 }
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
 function toFile(dot, path, options) {
   throw new Error(ERROR_MESSAGE);
 }

package/lib/adapter/browser/index.js

@@ -1,18 +1,7 @@
-/**
- * @module ts-graphviz/adapter
- * @beta
- */
-/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any */
 const ERROR_MESSAGE = 'This module cannot be run in a browser.';
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
 function toStream(dot, options) {
   throw new Error(ERROR_MESSAGE);
 }
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
 function toFile(dot, path, options) {
   throw new Error(ERROR_MESSAGE);
 }

package/lib/adapter/node/index.cjs

@@ -6,21 +6,12 @@ var index_js = require('../utils/index.cjs');
 var node_util = require('node:util');
 var node_fs = require('node:fs');
 
-/**
- * NOTE:
- * The node:stream/promises standard module is not provided in Node 14.
- * Fix Node 14 to use node:stream/promises after LTS ends.
- */
 const pipeline = node_util.promisify(node_stream.pipeline);
 
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
 async function toStream(dot, options) {
   const [command, args] = index_js.createCommandAndArgs(options ?? {});
   return new Promise(async function toStreamInternal(resolve, reject) {
     const p = node_child_process.spawn(command, args, { stdio: 'pipe' });
-    // error handling
     p.on('error', (e) => {
       reject(
         new Error(`Command "${command}" failed.\nMESSAGE:${e.message}`, {
@@ -45,9 +36,6 @@ async function toStream(dot, options) {
   });
 }
 
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
 async function toFile(dot, path, options) {
   const stream = await toStream(dot, options);
   await pipeline(stream, node_fs.createWriteStream(path));

package/lib/adapter/node/index.js

@@ -4,21 +4,12 @@ import { createCommandAndArgs } from '../utils/index.js';
 import { promisify } from 'node:util';
 import { createWriteStream } from 'node:fs';
 
-/**
- * NOTE:
- * The node:stream/promises standard module is not provided in Node 14.
- * Fix Node 14 to use node:stream/promises after LTS ends.
- */
 const pipeline = promisify(pipeline$1);
 
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
 async function toStream(dot, options) {
   const [command, args] = createCommandAndArgs(options ?? {});
   return new Promise(async function toStreamInternal(resolve, reject) {
     const p = spawn(command, args, { stdio: 'pipe' });
-    // error handling
     p.on('error', (e) => {
       reject(
         new Error(`Command "${command}" failed.\nMESSAGE:${e.message}`, {
@@ -43,9 +34,6 @@ async function toStream(dot, options) {
   });
 }
 
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
 async function toFile(dot, path, options) {
   const stream = await toStream(dot, options);
   await pipeline(stream, createWriteStream(path));

package/lib/adapter/utils/index.cjs

@@ -1,12 +1,5 @@
 'use strict';
 
-/**
- * escapeValue is a function that escapes a given Attribute value of a given AttributeKey.
- * It checks the type of the value and adds quotes if the value is of type string and contains whitespace.
- *
- * @param value The value of an Attribute of type T that extends AttributeKey
- * @returns The escaped Attribute value
- */
 function escapeValue(value) {
   if (value !== true) {
     if (typeof value === 'string' && /\s/g.test(value)) {
@@ -17,13 +10,6 @@ function escapeValue(value) {
   }
   return '';
 }
-/**
- * createCommandArgs is a function that creates command arguments from a given Options object.
- * It reads the properties of the Options object and creates corresponding command line arguments accordingly.
- *
- * @param options The Options object used to create command arguments
- * @returns A generator that yields strings for command arguments
- */
 function* createCommandArgs(options) {
   const { suppressWarnings = true, format = 'svg', attributes = {}, library = [], y = false, scale } = options;
   if (suppressWarnings) yield '-q';
@@ -65,12 +51,6 @@ function* createCommandArgs(options) {
   }
 }
 
-/**
- * createCommandAndArgs creates a command and an array of arguments, based on the given {@link Options}.
- *
- * @param options Options to create the command and args from.
- * @returns A tuple containing the command and an array of arguments.
- */
 function createCommandAndArgs(options) {
   return [options.dotCommand ?? 'dot', Array.from(createCommandArgs(options))];
 }

package/lib/adapter/utils/index.js

@@ -1,10 +1,3 @@
-/**
- * escapeValue is a function that escapes a given Attribute value of a given AttributeKey.
- * It checks the type of the value and adds quotes if the value is of type string and contains whitespace.
- *
- * @param value The value of an Attribute of type T that extends AttributeKey
- * @returns The escaped Attribute value
- */
 function escapeValue(value) {
   if (value !== true) {
     if (typeof value === 'string' && /\s/g.test(value)) {
@@ -15,13 +8,6 @@ function escapeValue(value) {
   }
   return '';
 }
-/**
- * createCommandArgs is a function that creates command arguments from a given Options object.
- * It reads the properties of the Options object and creates corresponding command line arguments accordingly.
- *
- * @param options The Options object used to create command arguments
- * @returns A generator that yields strings for command arguments
- */
 function* createCommandArgs(options) {
   const { suppressWarnings = true, format = 'svg', attributes = {}, library = [], y = false, scale } = options;
   if (suppressWarnings) yield '-q';
@@ -63,12 +49,6 @@ function* createCommandArgs(options) {
   }
 }
 
-/**
- * createCommandAndArgs creates a command and an array of arguments, based on the given {@link Options}.
- *
- * @param options Options to create the command and args from.
- * @returns A tuple containing the command and an array of arguments.
- */
 function createCommandAndArgs(options) {
   return [options.dotCommand ?? 'dot', Array.from(createCommandArgs(options))];
 }

package/lib/ast/index.cjs

@@ -3,36 +3,14 @@
 var index_js = require('../utils/index.cjs');
 var index_js$1 = require('../common/index.cjs');
 
-/**
- * Builder is an ASTBuilder that provides a method to create an ASTNode.
- *
- * @group Create AST
- */
 class Builder {
   options;
-  /**
-   * 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 {
       ...props,
@@ -43,15 +21,6 @@ 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());
 
 const EOL = /\r?\n/;
@@ -288,25 +257,12 @@ const defaultPlugins$2 = [
   SubgraphPrintPlugin,
 ];
 
-/**
- * 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;
@@ -328,14 +284,6 @@ class Printer {
   }
 }
 
-/**
- * stringify is a function that converts a Graphviz AST Node into a string in DOT language.
- *
- * @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) {
   const result = new Printer(options).print(ast);
   if (!result) {
@@ -344,7 +292,6 @@ function stringify(ast, options) {
   return result;
 }
 
-/* eslint-disable */
 function peg$padEnd(str, targetLength, padString) {
   padString = padString || ' ';
   if (str.length > targetLength) {
@@ -574,9 +521,7 @@ function peg$parse(input, options) {
     );
   };
   const peg$c21 = function (id, rhs, _children) {
-    // @ts-ignore
     return b.createElement(
-      // @ts-ignore
       'Edge',
       {
         targets: [id, ...rhs],
@@ -5287,9 +5232,6 @@ const parse$1 = peg$parse;
 function parse(input, options) {
   return parse$1(input, options);
 }
-/**
- * @group Convert DOT to AST
- */
 const DotSyntaxError = DotSyntaxError$1;
 
 function convertAttribute(key, value) {
@@ -5595,24 +5537,12 @@ 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 {
   options;
-  /** @hidden */
   #plugins = [...defaultPlugins$1];
   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;
@@ -5631,15 +5561,6 @@ 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) {
   return new FromModelConverter(options).convert(model);
 }
@@ -5815,23 +5736,12 @@ const NodePlugin = {
 
 const defaultPlugins = [NodePlugin, EdgePlugin, SubgraphPlugin, GraphPlugin, DotPlugin];
 
-/**
- * @group Convert AST to Model
- * @alpha
- */
 class ToModelConverter {
   options;
-  /** @hidden */
   plugins = [...defaultPlugins];
   constructor(options = {}) {
     this.options = options;
   }
-  /**
-   * Convert AST to Model.
-   *
-   * @param ast AST node.
-   * @alpha
-   */
   convert(ast) {
     const plugins = [...this.plugins];
     const context = {
@@ -5849,10 +5759,6 @@ class ToModelConverter {
   }
 }
 
-/**
- * @group Convert AST to Model
- * @beta
- */
 function toModel(ast, options) {
   return new ToModelConverter(options).convert(ast);
 }

package/lib/ast/index.js

@@ -1,36 +1,14 @@
 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;
-  /**
-   * 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 {
       ...props,
@@ -41,15 +19,6 @@ 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());
 
 const EOL = /\r?\n/;
@@ -281,25 +250,12 @@ const defaultPlugins$2 = [
   SubgraphPrintPlugin,
 ];
 
-/**
- * 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;
@@ -321,14 +277,6 @@ class Printer {
   }
 }
 
-/**
- * stringify is a function that converts a Graphviz AST Node into a string in DOT language.
- *
- * @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) {
   const result = new Printer(options).print(ast);
   if (!result) {
@@ -337,7 +285,6 @@ function stringify(ast, options) {
   return result;
 }
 
-/* eslint-disable */
 function peg$padEnd(str, targetLength, padString) {
   padString = padString || ' ';
   if (str.length > targetLength) {
@@ -567,9 +514,7 @@ function peg$parse(input, options) {
     );
   };
   const peg$c21 = function (id, rhs, _children) {
-    // @ts-ignore
     return b.createElement(
-      // @ts-ignore
       'Edge',
       {
         targets: [id, ...rhs],
@@ -5280,9 +5225,6 @@ const parse$1 = peg$parse;
 function parse(input, options) {
   return parse$1(input, options);
 }
-/**
- * @group Convert DOT to AST
- */
 const DotSyntaxError = DotSyntaxError$1;
 
 function convertAttribute(key, value) {
@@ -5588,24 +5530,12 @@ 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 {
   options;
-  /** @hidden */
   #plugins = [...defaultPlugins$1];
   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;
@@ -5624,15 +5554,6 @@ 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) {
   return new FromModelConverter(options).convert(model);
 }
@@ -5808,23 +5729,12 @@ const NodePlugin = {
 
 const defaultPlugins = [NodePlugin, EdgePlugin, SubgraphPlugin, GraphPlugin, DotPlugin];
 
-/**
- * @group Convert AST to Model
- * @alpha
- */
 class ToModelConverter {
   options;
-  /** @hidden */
   plugins = [...defaultPlugins];
   constructor(options = {}) {
     this.options = options;
   }
-  /**
-   * Convert AST to Model.
-   *
-   * @param ast AST node.
-   * @alpha
-   */
   convert(ast) {
     const plugins = [...this.plugins];
     const context = {
@@ -5842,10 +5752,6 @@ class ToModelConverter {
   }
 }
 
-/**
- * @group Convert AST to Model
- * @beta
- */
 function toModel(ast, options) {
   return new ToModelConverter(options).convert(ast);
 }

package/lib/common/index.cjs

@@ -1,30 +1,23 @@
 'use strict';
 
-/** @hidden */
 function isForwardRefNode(object) {
   return typeof object === 'object' && object !== null && typeof object.id === 'string';
 }
-/** @hidden */
 function isNodeModel(object) {
   return typeof object === 'object' && object !== null && object.$$type === 'Node' && typeof object.id === 'string';
 }
-/** @hidden */
 function isNodeRef(node) {
   return isNodeModel(node) || isForwardRefNode(node);
 }
-/** @hidden */
 function isNodeRefLike(node) {
   return typeof node === 'string' || isNodeRef(node);
 }
-/** @hidden */
 function isNodeRefGroupLike(target) {
   return Array.isArray(target) && target.every(isNodeRefLike);
 }
-/** @hidden */
 function isCompass(c) {
   return ['n', 'ne', 'e', 'se', 's', 'sw', 'w', 'nw', 'c'].includes(c);
 }
-/** @hidden */
 function toNodeRef(target) {
   if (isNodeRef(target)) {
     return target;
@@ -35,7 +28,6 @@ function toNodeRef(target) {
   }
   return { id, port };
 }
-/** @hidden */
 function toNodeRefGroup(targets) {
   if (targets.length < 2 && (isNodeRefLike(targets[0]) && isNodeRefLike(targets[1])) === false) {
     throw Error('EdgeTargets must have at least 2 elements.');
@@ -43,22 +35,13 @@ function toNodeRefGroup(targets) {
   return targets.map((t) => toNodeRef(t));
 }
 
-/**
- * @group Models Context
- * @alpha
- */
 const RootModelsContext = Object.seal({
-  // NOTE: RootModelsContext is also initialized after the model class is declared in the 'core/index.cjs' module.
   Graph: null,
   Digraph: null,
   Subgraph: null,
   Node: null,
   Edge: null,
 });
-/**
- * @group Models Context
- * @alpha
- */
 function createModelsContext(models) {
   return Object.assign(Object.seal(Object.assign({}, RootModelsContext)), models);
 }

package/lib/common/index.js

@@ -1,28 +1,21 @@
-/** @hidden */
 function isForwardRefNode(object) {
   return typeof object === 'object' && object !== null && typeof object.id === 'string';
 }
-/** @hidden */
 function isNodeModel(object) {
   return typeof object === 'object' && object !== null && object.$$type === 'Node' && typeof object.id === 'string';
 }
-/** @hidden */
 function isNodeRef(node) {
   return isNodeModel(node) || isForwardRefNode(node);
 }
-/** @hidden */
 function isNodeRefLike(node) {
   return typeof node === 'string' || isNodeRef(node);
 }
-/** @hidden */
 function isNodeRefGroupLike(target) {
   return Array.isArray(target) && target.every(isNodeRefLike);
 }
-/** @hidden */
 function isCompass(c) {
   return ['n', 'ne', 'e', 'se', 's', 'sw', 'w', 'nw', 'c'].includes(c);
 }
-/** @hidden */
 function toNodeRef(target) {
   if (isNodeRef(target)) {
     return target;
@@ -33,7 +26,6 @@ function toNodeRef(target) {
   }
   return { id, port };
 }
-/** @hidden */
 function toNodeRefGroup(targets) {
   if (targets.length < 2 && (isNodeRefLike(targets[0]) && isNodeRefLike(targets[1])) === false) {
     throw Error('EdgeTargets must have at least 2 elements.');
@@ -41,22 +33,13 @@ function toNodeRefGroup(targets) {
   return targets.map((t) => toNodeRef(t));
 }
 
-/**
- * @group Models Context
- * @alpha
- */
 const RootModelsContext = Object.seal({
-  // NOTE: RootModelsContext is also initialized after the model class is declared in the 'core/index.js' module.
   Graph: null,
   Digraph: null,
   Subgraph: null,
   Node: null,
   Edge: null,
 });
-/**
- * @group Models Context
- * @alpha
- */
 function createModelsContext(models) {
   return Object.assign(Object.seal(Object.assign({}, RootModelsContext)), models);
 }

package/lib/core/index.cjs

@@ -3,25 +3,13 @@
 var index_js = require('../common/index.cjs');
 var index_js$1 = require('../ast/index.cjs');
 
-/**
- * @group Attribute
- */
 const attribute = new Proxy(Object.freeze({}), {
   get: (_, key) => key,
 });
 
-/**
- * Base class for DOT objects.
- * @group Models
- */
 class DotObject {}
 
-/**
- * Base class for DOT objects with attributes.
- * @group Models
- */
 class AttributesBase extends DotObject {
-  /** @hidden */
   #attrs = new Map();
   constructor(attributes) {
     super();
@@ -57,10 +45,6 @@ class AttributesBase extends DotObject {
   }
 }
 
-/**
- * A set of attribute values for any object.
- * @group Models
- */
 class AttributeList extends AttributesBase {
   $$kind;
   get $$type() {
@@ -73,12 +57,7 @@ class AttributeList extends AttributesBase {
   }
 }
 
-/**
- * Base class for Graph objects.
- * @group Models
- */
 class GraphBase extends AttributesBase {
-  /** @hidden */
   #models = index_js.RootModelsContext;
   id;
   comment;
@@ -96,7 +75,6 @@ class GraphBase extends AttributesBase {
   get subgraphs() {
     return Array.from(this.#objects.subgraphs.values());
   }
-  /** @hidden */
   #objects = {
     nodes: new Map(),
     edges: new Set(),
@@ -208,10 +186,6 @@ class GraphBase extends AttributesBase {
   }
 }
 
-/**
- * Base class representing a root graph(digraph, graph).
- * @group Models
- */
 class RootGraph extends GraphBase {
   get $$type() {
     return 'Graph';
@@ -229,30 +203,18 @@ class RootGraph extends GraphBase {
   }
 }
 
-/**
- * DOT object class representing a digraph.
- * @group Models
- */
 class Digraph extends RootGraph {
   get directed() {
     return true;
   }
 }
 
-/**
- * DOT object class representing a graph.
- * @group Models
- */
 class Graph extends RootGraph {
   get directed() {
     return false;
   }
 }
 
-/**
- * DOT object class representing a subgraph.
- * @group Models
- */
 class Subgraph extends GraphBase {
   get $$type() {
     return 'Subgraph';
@@ -274,18 +236,10 @@ class Subgraph extends GraphBase {
   }
 }
 
-/**
- * A set of attribute values for any object.
- * @group Models
- */
 class AttributesGroup extends AttributesBase {
   comment;
 }
 
-/**
- * DOT object class representing a node.
- * @group Models
- */
 class Node extends DotObject {
   id;
   get $$type() {
@@ -306,10 +260,6 @@ class Node extends DotObject {
   }
 }
 
-/**
- * DOT object class representing a edge.
- * @group Models
- */
 class Edge extends DotObject {
   targets;
   get $$type() {
@@ -335,14 +285,6 @@ Object.assign(index_js.RootModelsContext, {
   Edge,
 });
 
-/**
- * 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;
@@ -357,13 +299,6 @@ 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),
@@ -372,28 +307,9 @@ function createModelFactories(strict, context = index_js.RootModelsContext) {
 }
 
 const noStrict = createModelFactories(false);
-/**
- *  digraph is a factory for creating Digraph objects.
- * @group Model Factory
- */
 const digraph = noStrict.digraph;
-/**
- * graph is a factory for creating Graph objects.
- * @group Model Factory
- */
 const graph = noStrict.graph;
-/**
- * Provides a strict mode API.
- * @group Model Factory
- */
 const strict = createModelFactories(true);
-/**
- * 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);
   return Object.freeze({
@@ -402,15 +318,6 @@ function withContext(models) {
   });
 }
 
-/**
- * Convert Model to DOT string.
- *
- * @group Convert Model to DOT
- *
- * @param model Dot Object Model, like {@link Digraph}, {@link Graph}, {@link Subgraph}, {@link Node}, and {@link Edge}
- * @param options Optional options for the conversion.
- * @returns DOT string
- */
 function toDot(model, options) {
   const ast = index_js$1.fromModel(model, options?.convert);
   return index_js$1.stringify(ast, options?.print);

package/lib/core/index.js

@@ -8,25 +8,13 @@ import {
 } from '../common/index.js';
 import { fromModel, stringify, parse, toModel } from '../ast/index.js';
 
-/**
- * @group Attribute
- */
 const attribute = new Proxy(Object.freeze({}), {
   get: (_, key) => key,
 });
 
-/**
- * Base class for DOT objects.
- * @group Models
- */
 class DotObject {}
 
-/**
- * Base class for DOT objects with attributes.
- * @group Models
- */
 class AttributesBase extends DotObject {
-  /** @hidden */
   #attrs = new Map();
   constructor(attributes) {
     super();
@@ -62,10 +50,6 @@ class AttributesBase extends DotObject {
   }
 }
 
-/**
- * A set of attribute values for any object.
- * @group Models
- */
 class AttributeList extends AttributesBase {
   $$kind;
   get $$type() {
@@ -78,12 +62,7 @@ class AttributeList extends AttributesBase {
   }
 }
 
-/**
- * Base class for Graph objects.
- * @group Models
- */
 class GraphBase extends AttributesBase {
-  /** @hidden */
   #models = RootModelsContext;
   id;
   comment;
@@ -101,7 +80,6 @@ class GraphBase extends AttributesBase {
   get subgraphs() {
     return Array.from(this.#objects.subgraphs.values());
   }
-  /** @hidden */
   #objects = {
     nodes: new Map(),
     edges: new Set(),
@@ -211,10 +189,6 @@ class GraphBase extends AttributesBase {
   }
 }
 
-/**
- * Base class representing a root graph(digraph, graph).
- * @group Models
- */
 class RootGraph extends GraphBase {
   get $$type() {
     return 'Graph';
@@ -232,30 +206,18 @@ class RootGraph extends GraphBase {
   }
 }
 
-/**
- * DOT object class representing a digraph.
- * @group Models
- */
 class Digraph extends RootGraph {
   get directed() {
     return true;
   }
 }
 
-/**
- * DOT object class representing a graph.
- * @group Models
- */
 class Graph extends RootGraph {
   get directed() {
     return false;
   }
 }
 
-/**
- * DOT object class representing a subgraph.
- * @group Models
- */
 class Subgraph extends GraphBase {
   get $$type() {
     return 'Subgraph';
@@ -277,18 +239,10 @@ class Subgraph extends GraphBase {
   }
 }
 
-/**
- * A set of attribute values for any object.
- * @group Models
- */
 class AttributesGroup extends AttributesBase {
   comment;
 }
 
-/**
- * DOT object class representing a node.
- * @group Models
- */
 class Node extends DotObject {
   id;
   get $$type() {
@@ -309,10 +263,6 @@ class Node extends DotObject {
   }
 }
 
-/**
- * DOT object class representing a edge.
- * @group Models
- */
 class Edge extends DotObject {
   targets;
   get $$type() {
@@ -338,14 +288,6 @@ Object.assign(RootModelsContext, {
   Edge,
 });
 
-/**
- * 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;
@@ -360,13 +302,6 @@ 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),
@@ -375,28 +310,9 @@ function createModelFactories(strict, context = RootModelsContext) {
 }
 
 const noStrict = createModelFactories(false);
-/**
- *  digraph is a factory for creating Digraph objects.
- * @group Model Factory
- */
 const digraph = noStrict.digraph;
-/**
- * graph is a factory for creating Graph objects.
- * @group Model Factory
- */
 const graph = noStrict.graph;
-/**
- * Provides a strict mode API.
- * @group Model Factory
- */
 const strict = createModelFactories(true);
-/**
- * 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);
   return Object.freeze({
@@ -405,15 +321,6 @@ function withContext(models) {
   });
 }
 
-/**
- * Convert Model to DOT string.
- *
- * @group Convert Model to DOT
- *
- * @param model Dot Object Model, like {@link Digraph}, {@link Graph}, {@link Subgraph}, {@link Node}, and {@link Edge}
- * @param options Optional options for the conversion.
- * @returns DOT string
- */
 function toDot(model, options) {
   const ast = fromModel(model, options?.convert);
   return stringify(ast, options?.print);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ts-graphviz",
-    "version": "1.5.5-dev.02afc3340",
+    "version": "1.5.5-dev.27273c787",
     "author": "kamiazya <yuki@kamiazya.tech>",
     "description": "Graphviz library for TypeScript.",
     "homepage": "https://ts-graphviz.github.io/ts-graphviz/",
@@ -86,7 +86,7 @@
         "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:node": "tsc -p tsconfig.build.json --declaration && tsc -p tsconfig.build.json --removeComments && rollup -c",
         "build": "yarn build:node && yarn build:deno",
         "postbuild": "prettier --write ./lib/**/*.{js,cjs,d.ts}",
         "pretest": "yarn build:peggy",