ts-graphviz 1.5.4 → 1.5.5-dev.27273c787

package/lib/ast/index.js

@@ -1,19 +1,14 @@
 import { pipe, map } from '../utils/index.js';
 import { isNodeModel, isForwardRefNode, createModelsContext } from '../common/index.js';
 
-/**
- * @group Create AST
- */
 class Builder {
   options;
-  /** @internal */
   getLocation() {
     return this.options?.locationFunction?.() ?? null;
   }
   constructor(options) {
     this.options = options;
   }
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   createElement(type, props, children) {
     return {
       ...props,
@@ -24,9 +19,6 @@ class Builder {
   }
 }
 
-/**
- * @group Create AST
- */
 const createElement = Builder.prototype.createElement.bind(new Builder());
 
 const EOL = /\r?\n/;
@@ -258,12 +250,8 @@ const defaultPlugins$2 = [
   SubgraphPrintPlugin,
 ];
 
-/**
- * @group Convert AST to DOT
- */
 class Printer {
   options;
-  /** @internal */
   #plugins = [...defaultPlugins$2];
   constructor(options = {}) {
     this.options = options;
@@ -289,13 +277,6 @@ class Printer {
   }
 }
 
-/**
- * Stringify Graphviz AST Node.
- *
- * @param ast Graphviz AST node.
- * @returns DOT language string.
- * @group Convert AST to DOT
- */
 function stringify(ast, options) {
   const result = new Printer(options).print(ast);
   if (!result) {
@@ -304,7 +285,6 @@ function stringify(ast, options) {
   return result;
 }
 
-/* eslint-disable */
 function peg$padEnd(str, targetLength, padString) {
   padString = padString || ' ';
   if (str.length > targetLength) {
@@ -534,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],
@@ -5247,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) {
@@ -5555,12 +5530,8 @@ const SubgraphPlugin$1 = {
 
 const defaultPlugins$1 = [AttributeListPlugin, EdgePlugin$1, NodePlugin$1, GraphPlugin$1, SubgraphPlugin$1];
 
-/**
- * @group Convert Model to AST
- */
 class FromModelConverter {
   options;
-  /** @hidden */
   #plugins = [...defaultPlugins$1];
   constructor(options = {}) {
     this.options = options;
@@ -5583,9 +5554,6 @@ class FromModelConverter {
   }
 }
 
-/**
- * @group Convert Model to AST
- */
 function fromModel(model, options) {
   return new FromModelConverter(options).convert(model);
 }
@@ -5761,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 = {
@@ -5795,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.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/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,7 +285,6 @@ Object.assign(index_js.RootModelsContext, {
   Edge,
 });
 
-/** @hidden */
 function ModelFactoryBuilder(directed, strictMode) {
   return (...args) => {
     const G = directed ? this.Digraph : this.Graph;
@@ -358,24 +307,9 @@ function createModelFactories(strict, context = index_js.RootModelsContext) {
 }
 
 const noStrict = createModelFactories(false);
-/**
- * API for creating directional graph objects.
- * @group Model Factory
- */
 const digraph = noStrict.digraph;
-/**
- * API for creating omnidirectional graph objects.
- * @group Model Factory
- */
 const graph = noStrict.graph;
-/**
- * Provides a strict mode API.
- * @group Model Factory
- */
 const strict = createModelFactories(true);
-/**
- * @group Model Factory
- */
 function withContext(models) {
   const context = index_js.createModelsContext(models);
   return Object.freeze({
@@ -384,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
- * @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.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;