ts-graphviz 1.5.5-dev.bdbba8a60 → 1.5.6-dev.29eb2444f

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);