@ts-graphviz/ast 0.0.0-pr956-20240225073457 → 0.0.0-pr956-20240225160253

package/src/dot-shim/printer/stringify.ts

@@ -1,19 +0,0 @@
-import type { ASTNode } from '../../types.js';
-import { Printer } from './printer.js';
-import type { PrintOptions } from './types.js';
-
-/**
- * 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
- */
-export function stringify(ast: ASTNode, options?: PrintOptions): string {
-  const result = new Printer(options).print(ast);
-  if (!result) {
-    throw new Error();
-  }
-  return result;
-}

package/src/dot-shim/printer/types.ts

@@ -1,74 +0,0 @@
-import { ASTNode } from '../../types.js';
-
-/**
- * The IndentStyle type represents an indentation style for text. It can either be a `"space"` or a `"tab"`.
- * @group Convert AST to DOT
- */
-export type IndentStyle = 'space' | 'tab';
-
-/**
- * This type represents the EndOfLine type which is used to determine the type of line ending to be used when writing to a file.
- * @group Convert AST to DOT
- */
-export type EndOfLine = 'lf' | 'crlf';
-
-/**
- * This interface provides options for converting an abstract syntax tree (AST) to a DOT representation.
- * @group Convert AST to DOT
- */
-export interface PrintOptions {
-  /**
-   * The style of indentation to use when printing the AST.
-   *
-   * @default "space"
-   */
-  indentStyle?: IndentStyle;
-  /**
-   * The size of the indentation to use when printing the AST.
-   *
-   * @default 2
-   */
-  indentSize?: number;
-  /**
-   * The type of line ending to use when printing the AST.
-   *
-   * @default lf
-   */
-  endOfLine?: EndOfLine;
-}
-
-/**
- * PrintContext interface provides an interface for printing an ASTNode with a set of options.
- * @group Convert AST to DOT
- */
-export interface PrintContext extends Required<PrintOptions> {
-  /**
-   * Indicates if the AST should be printed in a directed graph.
-   */
-  directed: boolean;
-  /**
-   * A function to print an ASTNode, taking in an ASTNode as an argument. Returns a string.
-   */
-  print(ast: ASTNode): string;
-}
-
-/**
- * PrintPlugin is an interface for plugins used for printing an {@link ASTNode}.
- * @template T T extends {@link ASTNode}
- * @group Convert AST to DOT
- */
-export interface PrintPlugin<T extends ASTNode = ASTNode> {
-  /**
-   * Checks if an ASTNode matches the plugin
-   * @returns {boolean} true if the ASTNode matches the plugin
-   */
-  match(ast: ASTNode): boolean;
-  /**
-   * Prints an ASTNode
-   * @param context PrintContext object
-   * @param ast an ASTNode
-   * @returns printed string
-   * @memberof PrintPlugin
-   */
-  print(context: PrintContext, ast: T): string;
-}

package/src/model-shim/from-model/converter.ts

@@ -1,43 +0,0 @@
-import { DotObjectModel } from '@ts-graphviz/common';
-import { defaultPlugins } from './plugins/index.js';
-import {
-  ConvertFromModelContext,
-  ConvertFromModelOptions,
-  ConvertFromModelPlugin,
-} from './types.js';
-import { ModelToAST } from './types.js';
-
-/**
- * FromModelConverter is a class used to convert a {@link DotObjectModel} into an ASTNode.
- *
- * @group Convert Model to AST
- */
-export class FromModelConverter {
-  /** @hidden */
-  #plugins: ConvertFromModelPlugin<DotObjectModel>[] = [...defaultPlugins];
-
-  constructor(private options: ConvertFromModelOptions = {}) {}
-
-  /**
-   * Converts a DotObjectModel into an AST.
-   *
-   * @param model The {@link DotObjectModel} to be converted.
-   * @returns The AST generated from the model.
-   */
-  public convert<T extends DotObjectModel>(model: T): ModelToAST<T> {
-    const plugins = [...this.#plugins];
-    const { commentKind = 'Slash' } = this.options;
-    const context: ConvertFromModelContext = {
-      commentKind,
-      convert<U extends DotObjectModel>(m: U): ModelToAST<U> {
-        for (const plugin of plugins) {
-          if (plugin.match(m)) {
-            return plugin.convert(context, m) as ModelToAST<U>;
-          }
-        }
-        throw Error();
-      },
-    };
-    return context.convert(model);
-  }
-}

package/src/model-shim/from-model/from-model.ts

@@ -1,19 +0,0 @@
-import { DotObjectModel } from '@ts-graphviz/common';
-import { FromModelConverter } from './converter.js';
-import { ConvertFromModelOptions, ModelToAST } from './types.js';
-
-/**
- * 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
- */
-export function fromModel<T extends DotObjectModel>(
-  model: T,
-  options?: ConvertFromModelOptions,
-): ModelToAST<T> {
-  return new FromModelConverter(options).convert(model);
-}

package/src/model-shim/from-model/index.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './converter.js';
-export * from './from-model.js';

package/src/model-shim/from-model/plugins/AttributeListPlugin.ts

@@ -1,19 +0,0 @@
-import { AttributeListModel } from '@ts-graphviz/common';
-import { createElement } from '../../../builder/create-element.js';
-import { ConvertFromModelPlugin } from '../types.js';
-import { convertAttribute } from './utils/index.js';
-
-export const AttributeListPlugin: ConvertFromModelPlugin<AttributeListModel> = {
-  match(model) {
-    return model.$$type === 'AttributeList';
-  },
-  convert(context, model) {
-    return createElement(
-      'AttributeList',
-      {
-        kind: model.$$kind,
-      },
-      model.values.map(([key, value]) => convertAttribute(key, value)),
-    );
-  },
-};

package/src/model-shim/from-model/plugins/EdgePlugin.ts

@@ -1,140 +0,0 @@
-import { EdgeModel, isForwardRefNode, isNodeModel } from '@ts-graphviz/common';
-import { createElement } from '../../../builder/create-element.js';
-import { EdgeTargetASTNode } from '../../../types.js';
-import { ConvertFromModelPlugin } from '../types.js';
-import { convertAttribute, convertComment } from './utils/index.js';
-
-export const EdgePlugin: ConvertFromModelPlugin<EdgeModel> = {
-  match(model) {
-    return model.$$type === 'Edge';
-  },
-  convert(context, model) {
-    return createElement(
-      'Edge',
-      {
-        targets: model.targets.map((target) => {
-          if (isNodeModel(target)) {
-            return createElement(
-              'NodeRef',
-              {
-                id: createElement(
-                  'Literal',
-                  {
-                    value: target.id,
-                    quoted: true,
-                  },
-                  [],
-                ),
-              },
-              [],
-            );
-          }
-          if (isForwardRefNode(target)) {
-            return createElement(
-              'NodeRef',
-              {
-                id: createElement(
-                  'Literal',
-                  {
-                    value: target.id,
-                    quoted: true,
-                  },
-                  [],
-                ),
-                port: target.port
-                  ? createElement(
-                      'Literal',
-                      {
-                        value: target.port,
-                        quoted: true,
-                      },
-                      [],
-                    )
-                  : undefined,
-                compass: target.compass
-                  ? createElement(
-                      'Literal',
-                      {
-                        value: target.compass,
-                        quoted: true,
-                      },
-                      [],
-                    )
-                  : undefined,
-              },
-              [],
-            );
-          }
-          return createElement(
-            'NodeRefGroup',
-            {},
-            target.map((n) => {
-              if (isNodeModel(n)) {
-                return createElement(
-                  'NodeRef',
-                  {
-                    id: createElement(
-                      'Literal',
-                      {
-                        value: n.id,
-                        quoted: true,
-                      },
-                      [],
-                    ),
-                  },
-                  [],
-                );
-              }
-              return createElement(
-                'NodeRef',
-                {
-                  id: createElement(
-                    'Literal',
-                    {
-                      value: n.id,
-                      quoted: true,
-                    },
-                    [],
-                  ),
-                  port: n.port
-                    ? createElement(
-                        'Literal',
-                        {
-                          value: n.port,
-                          quoted: true,
-                        },
-                        [],
-                      )
-                    : undefined,
-                  compass: n.compass
-                    ? createElement(
-                        'Literal',
-                        {
-                          value: n.compass,
-                          quoted: true,
-                        },
-                        [],
-                      )
-                    : undefined,
-                },
-                [],
-              );
-            }),
-          );
-        }) as [
-          from: EdgeTargetASTNode,
-          to: EdgeTargetASTNode,
-          ...rest: EdgeTargetASTNode[],
-        ],
-      },
-      [
-        ...(model.attributes.comment
-          ? [convertComment(model.attributes.comment, context.commentKind)]
-          : []),
-        ...model.attributes.values.map(([key, value]) =>
-          convertAttribute(key, value),
-        ),
-      ],
-    );
-  },
-};

package/src/model-shim/from-model/plugins/GraphPlugin.ts

@@ -1,36 +0,0 @@
-import { RootGraphModel } from '@ts-graphviz/common';
-import { createElement } from '../../../builder/create-element.js';
-import { ConvertFromModelPlugin } from '../types.js';
-import { convertClusterChildren } from './utils/convert-cluster-children.js';
-import { convertComment } from './utils/convert-comment.js';
-
-export const GraphPlugin: ConvertFromModelPlugin<RootGraphModel> = {
-  match(model) {
-    return model.$$type === 'Graph';
-  },
-  convert(context, model) {
-    return createElement('Dot', {}, [
-      ...(model.comment
-        ? [convertComment(model.comment, context.commentKind)]
-        : []),
-      createElement(
-        'Graph',
-        {
-          directed: model.directed,
-          strict: model.strict,
-          id: model.id
-            ? createElement(
-                'Literal',
-                {
-                  value: model.id,
-                  quoted: true,
-                },
-                [],
-              )
-            : undefined,
-        },
-        convertClusterChildren(context, model),
-      ),
-    ]);
-  },
-};

package/src/model-shim/from-model/plugins/NodePlugin.ts

@@ -1,33 +0,0 @@
-import { NodeModel } from '@ts-graphviz/common';
-import { createElement } from '../../../builder/create-element.js';
-import { ConvertFromModelPlugin } from '../types.js';
-import { convertAttribute, convertComment } from './utils/index.js';
-
-export const NodePlugin: ConvertFromModelPlugin<NodeModel> = {
-  match(model) {
-    return model.$$type === 'Node';
-  },
-  convert(context, model) {
-    return createElement(
-      'Node',
-      {
-        id: createElement(
-          'Literal',
-          {
-            value: model.id,
-            quoted: true,
-          },
-          [],
-        ),
-      },
-      [
-        ...(model.attributes.comment
-          ? [convertComment(model.attributes.comment, context.commentKind)]
-          : []),
-        ...model.attributes.values.map(([key, value]) =>
-          convertAttribute(key, value),
-        ),
-      ],
-    );
-  },
-};

package/src/model-shim/from-model/plugins/SubraphPlugin.ts

@@ -1,28 +0,0 @@
-import { SubgraphModel } from '@ts-graphviz/common';
-import { createElement } from '../../../builder/create-element.js';
-import { ConvertFromModelPlugin } from '../types.js';
-import { convertClusterChildren } from './utils/convert-cluster-children.js';
-
-export const SubgraphPlugin: ConvertFromModelPlugin<SubgraphModel> = {
-  match(model) {
-    return model.$$type === 'Subgraph';
-  },
-  convert(context, model) {
-    return createElement(
-      'Subgraph',
-      {
-        id: model.id
-          ? createElement(
-              'Literal',
-              {
-                value: model.id,
-                quoted: true,
-              },
-              [],
-            )
-          : undefined,
-      },
-      convertClusterChildren(context, model),
-    );
-  },
-};

package/src/model-shim/from-model/plugins/index.ts

@@ -1,13 +0,0 @@
-import { AttributeListPlugin } from './AttributeListPlugin.js';
-import { EdgePlugin } from './EdgePlugin.js';
-import { GraphPlugin } from './GraphPlugin.js';
-import { NodePlugin } from './NodePlugin.js';
-import { SubgraphPlugin } from './SubraphPlugin.js';
-
-export const defaultPlugins = [
-  AttributeListPlugin,
-  EdgePlugin,
-  NodePlugin,
-  GraphPlugin,
-  SubgraphPlugin,
-];

package/src/model-shim/from-model/plugins/utils/convert-attribute.ts

@@ -1,47 +0,0 @@
-import { Attribute, AttributeKey } from '@ts-graphviz/common';
-import { createElement } from '../../../../builder/create-element.js';
-import { AttributeASTNode } from '../../../../types.js';
-
-export function convertAttribute<K extends AttributeKey>(
-  key: K,
-  value: Attribute<K>,
-): AttributeASTNode {
-  if (typeof value === 'string') {
-    const trimmed = value.trim();
-    const isHTMLLike = /^<.+>$/ms.test(trimmed);
-    if (isHTMLLike) {
-      return createElement(
-        'Attribute',
-        {
-          key: createElement('Literal', { value: key, quoted: false }, []),
-          value: createElement(
-            'Literal',
-            { value: trimmed.slice(1, trimmed.length - 1), quoted: 'html' },
-            [],
-          ),
-        },
-        [],
-      );
-    }
-    return createElement(
-      'Attribute',
-      {
-        key: createElement('Literal', { value: key, quoted: false }, []),
-        value: createElement('Literal', { value: value, quoted: true }, []),
-      },
-      [],
-    );
-  }
-  return createElement(
-    'Attribute',
-    {
-      key: createElement('Literal', { value: key, quoted: false }, []),
-      value: createElement(
-        'Literal',
-        { value: String(value), quoted: false },
-        [],
-      ),
-    },
-    [],
-  );
-}

package/src/model-shim/from-model/plugins/utils/convert-cluster-children.ts

@@ -1,44 +0,0 @@
-import { GraphBaseModel } from '@ts-graphviz/common';
-import { ClusterStatementASTNode } from '../../../../types.js';
-import { ConvertFromModelContext } from '../../types.js';
-import { convertAttribute } from './convert-attribute.js';
-import { convertComment } from './convert-comment.js';
-
-export function convertClusterChildren(
-  context: ConvertFromModelContext,
-  model: GraphBaseModel,
-) {
-  return Array.from(
-    (function* (): Generator<ClusterStatementASTNode> {
-      for (const [key, value] of model.values) {
-        yield convertAttribute(key, value);
-      }
-      for (const attrs of Object.values(model.attributes)) {
-        if (attrs.size > 0) {
-          if (attrs.comment) {
-            yield convertComment(attrs.comment, context.commentKind);
-          }
-          yield context.convert(attrs);
-        }
-      }
-      for (const node of model.nodes) {
-        if (node.comment) {
-          yield convertComment(node.comment, context.commentKind);
-        }
-        yield context.convert(node);
-      }
-      for (const subgraph of model.subgraphs) {
-        if (subgraph.comment) {
-          yield convertComment(subgraph.comment, context.commentKind);
-        }
-        yield context.convert(subgraph);
-      }
-      for (const edge of model.edges) {
-        if (edge.comment) {
-          yield convertComment(edge.comment, context.commentKind);
-        }
-        yield context.convert(edge);
-      }
-    })(),
-  );
-}

package/src/model-shim/from-model/plugins/utils/convert-comment.ts

@@ -1,16 +0,0 @@
-import { createElement } from '../../../../builder/create-element.js';
-import { CommentASTNode, CommentKind } from '../../../../types.js';
-
-export function convertComment(
-  value: string,
-  kind: CommentKind,
-): CommentASTNode {
-  return createElement(
-    'Comment',
-    {
-      kind: kind,
-      value: value,
-    },
-    [],
-  );
-}

package/src/model-shim/from-model/plugins/utils/index.ts

@@ -1,3 +0,0 @@
-export * from './convert-attribute.js';
-export * from './convert-comment.js';
-export * from './convert-cluster-children.js';

package/src/model-shim/from-model/types.ts

@@ -1,62 +0,0 @@
-import { DotObjectModel } from '@ts-graphviz/common';
-import {
-  AttributeListASTNode,
-  CommentKind,
-  DotASTNode,
-  EdgeASTNode,
-  GraphASTNode,
-  NodeASTNode,
-  SubgraphASTNode,
-} from '../../types.js';
-
-/**
- * ModelToAST is a type alias used to map a generic type T to a specific AST node type.
- *
- * If T is a DotObjectModel, the type U is inferred and used to determine which AST node type to map to.
- *
- * If U is 'Graph', the type is mapped to either a {@link GraphASTNode} or a {@link DotASTNode}.
- * If U is 'AttributeList', the type is mapped to an {@link AttributeListASTNode}.
- * If U is 'Edge', the type is mapped to an {@link EdgeASTNode}.
- * If U is 'Node', the type is mapped to a {@link NodeASTNode}.
- * If U is 'Subgraph', the type is mapped to a {@link SubgraphASTNode}.
- *
- * If T is not a DotObjectModel, the type is mapped to never.
- *
- * @group AST
- */
-export type ModelToAST<T> = T extends DotObjectModel<infer U>
-  ? U extends 'Graph'
-    ? GraphASTNode | DotASTNode
-    : U extends 'AttributeList'
-      ? AttributeListASTNode
-      : U extends 'Edge'
-        ? EdgeASTNode
-        : U extends 'Node'
-          ? NodeASTNode
-          : U extends 'Subgraph'
-            ? SubgraphASTNode
-            : never
-  : never;
-
-/**
- * @group Convert Model to AST
- */
-export interface ConvertFromModelOptions {
-  commentKind?: CommentKind;
-}
-
-/**
- * @group Convert Model to AST
- */
-export interface ConvertFromModelContext
-  extends Required<ConvertFromModelOptions> {
-  convert<T extends DotObjectModel>(model: T): ModelToAST<T>;
-}
-
-/**
- * @group Convert Model to AST
- */
-export interface ConvertFromModelPlugin<T extends DotObjectModel> {
-  match(model: T): boolean;
-  convert(context: ConvertFromModelContext, model: T): ModelToAST<T>;
-}

package/src/model-shim/index.ts

@@ -1,2 +0,0 @@
-export * from './from-model/index.js';
-export * from './to-model/index.js';

package/src/model-shim/to-model/converter.ts

@@ -1,42 +0,0 @@
-import { createModelsContext } from '@ts-graphviz/common';
-import { defaultPlugins } from './plugins/index.js';
-import {
-  ASTToModel,
-  ConvertToModelContext,
-  ConvertToModelOptions,
-  ConvertToModelPlugin,
-  ToModelConvertableASTNode,
-} from './types.js';
-
-/**
- * @group Convert AST to Model
- */
-export class ToModelConverter {
-  /** @hidden */
-  protected plugins: ConvertToModelPlugin<ToModelConvertableASTNode>[] = [
-    ...defaultPlugins,
-  ];
-
-  constructor(private options: ConvertToModelOptions = {}) {}
-
-  /**
-   * Convert AST to Model.
-   *
-   * @param ast AST node.
-   */
-  public convert<T extends ToModelConvertableASTNode>(ast: T): ASTToModel<T> {
-    const plugins = [...this.plugins];
-    const context: ConvertToModelContext = {
-      models: createModelsContext(this.options.models ?? {}),
-      convert<U extends ToModelConvertableASTNode>(m: U): ASTToModel<U> {
-        for (const plugin of plugins) {
-          if (plugin.match(m)) {
-            return plugin.convert(context, m) as ASTToModel<U>;
-          }
-        }
-        throw Error();
-      },
-    };
-    return context.convert(ast);
-  }
-}

package/src/model-shim/to-model/index.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './converter.js';
-export * from './to-model.js';