ts-graphviz 1.8.2 → 2.0.0

package/package.json

@@ -1,125 +1,82 @@
 {
   "name": "ts-graphviz",
-  "version": "1.8.2",
-  "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"
-  },
+  "version": "2.0.0",
+  "description": "Graphviz library for TypeScript",
   "keywords": [
     "graphviz",
     "dot"
   ],
+  "homepage": "https://ts-graphviz.github.io/ts-graphviz/",
   "bugs": {
     "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
   },
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/ts-graphviz"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ts-graphviz/ts-graphviz.git",
+    "directory": "packages/ts-graphviz"
   },
-  "main": "./lib/index.cjs",
-  "module": "./lib/index.js",
-  "types": "lib/index.d.ts",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/ts-graphviz"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/ts-graphviz"
+    }
+  ],
+  "license": "MIT",
+  "author": "kamiazya <yuki@kamiazya.tech>",
+  "sideEffects": true,
+  "type": "module",
   "exports": {
     ".": {
       "require": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.cjs"
+        "types": "./lib/ts-graphviz.d.ts",
+        "default": "./lib/ts-graphviz.cjs"
       },
       "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
+        "types": "./lib/ts-graphviz.d.ts",
+        "default": "./lib/ts-graphviz.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"
-      }
+      "types": "./lib/ast.d.ts",
+      "require": "./lib/ast.cjs",
+      "default": "./lib/ast.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"
-      }
+      "types": "./lib/adapter.d.ts",
+      "require": "./lib/adapter.cjs",
+      "default": "./lib/adapter.js"
     },
     "./package.json": "./package.json"
   },
-  "typesVersions": {
-    "*": {
-      "ast": [
-        "lib/ast"
-      ],
-      "adapter": [
-        "lib/adapter/node"
-      ]
-    }
+  "main": "./lib/ts-graphviz.cjs",
+  "module": "./lib/ts-graphviz.js",
+  "types": "lib/ts-graphviz.d.ts",
+  "dependencies": {
+    "@ts-graphviz/adapter": "^2.0.0",
+    "@ts-graphviz/ast": "^2.0.0",
+    "@ts-graphviz/common": "^2.0.0",
+    "@ts-graphviz/core": "^2.0.0"
+  },
+  "devDependencies": {
+    "peggy": "^3.0.2",
+    "ts-pegjs": "^4.2.1",
+    "typescript": "^5.3.3",
+    "vite": "^5.1.3",
+    "vite-plugin-dts": "^3.7.3"
   },
-  "license": "MIT",
   "engines": {
-    "node": ">=14.16"
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
   },
   "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 --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",
-    "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"
+    "build": "vite build"
   }
-}
+}

package/SECURITY.md

@@ -1,5 +0,0 @@
-## Security contact information
-
-To report a security vulnerability, please use the
-[Tidelift security contact](https://tidelift.com/security).
-Tidelift will coordinate the fix and disclosure.

package/lib/adapter/browser/index.cjs

@@ -1,12 +0,0 @@
-'use strict';
-
-const ERROR_MESSAGE = 'This module cannot be run in a browser.';
-function toStream(dot, options) {
-  throw new Error(ERROR_MESSAGE);
-}
-function toFile(dot, path, options) {
-  throw new Error(ERROR_MESSAGE);
-}
-
-exports.toFile = toFile;
-exports.toStream = toStream;

package/lib/adapter/browser/index.d.ts

@@ -1,15 +0,0 @@
-/**
- * @module ts-graphviz/adapter
- * @beta
- */
-type Options = any;
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
-declare function toStream(dot: string, options?: Options): never;
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
-declare function toFile(dot: string, path: string, options?: Options): never;
-
-export { Options, toFile, toStream };

package/lib/adapter/browser/index.js

@@ -1,9 +0,0 @@
-const ERROR_MESSAGE = 'This module cannot be run in a browser.';
-function toStream(dot, options) {
-  throw new Error(ERROR_MESSAGE);
-}
-function toFile(dot, path, options) {
-  throw new Error(ERROR_MESSAGE);
-}
-
-export { toFile, toStream };

package/lib/adapter/deno/mod.d.ts

@@ -1,13 +0,0 @@
-import { Options, Format, Layout } from '../types/index.d.ts';
-
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
-export function toStream<T extends Layout>(dot: string, options?: Options<T>): Promise<ReadableStream<Uint8Array>>;
-
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
-export function toFile<T extends Layout>(dot: string, path: string, options?: Options<T>): Promise<void>;
-
-export { Options, Format, Layout };

package/lib/adapter/deno/mod.js

@@ -1,36 +0,0 @@
-import { createCommandAndArgs } from '../utils/index.js';
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
-export async function toStream(dot, options) {
-  const [command, args] = createCommandAndArgs(options);
-  const cp = new Deno.Command(command, {
-    args: args,
-    stdin: 'piped',
-    stdout: 'piped',
-  }).spawn();
-  const stdin = cp.stdin.getWriter();
-  await stdin.write(new TextEncoder().encode(dot));
-  await stdin.close();
-  return cp.stdout;
-}
-
-function open(path) {
-  try {
-    return Deno.open(path, { write: true });
-  } catch (e) {
-    if (e instanceof Deno.errors.NotFound) {
-      return Deno.open(path, { createNew: true, write: true });
-    }
-    throw e;
-  }
-}
-
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
-export async function toFile(dot, path, options) {
-  const output = await open(path);
-  const stream = await toStream(dot, options);
-  await stream.pipeTo(output.writable);
-}

package/lib/adapter/node/index.cjs

@@ -1,45 +0,0 @@
-'use strict';
-
-var node_stream = require('node:stream');
-var node_child_process = require('node:child_process');
-var index_js = require('../utils/index.cjs');
-var node_util = require('node:util');
-var node_fs = require('node:fs');
-
-const pipeline = node_util.promisify(node_stream.pipeline);
-
-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' });
-    p.on('error', (e) => {
-      reject(
-        new Error(`Command "${command}" failed.\nMESSAGE:${e.message}`, {
-          cause: e,
-        }),
-      );
-    });
-    const stderrChunks = [];
-    p.stdout.on('pause', () => p.stdout.resume());
-    p.stderr.on('data', (chunk) => stderrChunks.push(chunk));
-    p.stderr.on('pause', () => p.stderr.resume());
-    const dist = p.stdout.pipe(new node_stream.PassThrough());
-    p.on('close', async (code, signal) => {
-      if (code === 0) {
-        resolve(dist);
-      } else {
-        const message = Buffer.concat(stderrChunks).toString();
-        reject(new Error(`Command "${command}" failed.\nCODE: ${code}\nSIGNAL: ${signal}\nMESSAGE: ${message}`));
-      }
-    });
-    await pipeline(node_stream.Readable.from([dot]), p.stdin);
-  });
-}
-
-async function toFile(dot, path, options) {
-  const stream = await toStream(dot, options);
-  await pipeline(stream, node_fs.createWriteStream(path));
-}
-
-exports.toFile = toFile;
-exports.toStream = toStream;

package/lib/adapter/node/index.d.ts

@@ -1,15 +0,0 @@
-/// <reference types="node" />
-import { Layout, Options } from '../types/index.js';
-export { Format, Layout, Options } from '../types/index.js';
-
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
-declare function toStream<T extends Layout>(dot: string, options?: Options<T>): Promise<NodeJS.ReadableStream>;
-
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
-declare function toFile<T extends Layout>(dot: string, path: string, options?: Options<T>): Promise<void>;
-
-export { toFile, toStream };

package/lib/adapter/node/index.js

@@ -1,42 +0,0 @@
-import { pipeline as pipeline$1, PassThrough, Readable } from 'node:stream';
-import { spawn } from 'node:child_process';
-import { createCommandAndArgs } from '../utils/index.js';
-import { promisify } from 'node:util';
-import { createWriteStream } from 'node:fs';
-
-const pipeline = promisify(pipeline$1);
-
-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' });
-    p.on('error', (e) => {
-      reject(
-        new Error(`Command "${command}" failed.\nMESSAGE:${e.message}`, {
-          cause: e,
-        }),
-      );
-    });
-    const stderrChunks = [];
-    p.stdout.on('pause', () => p.stdout.resume());
-    p.stderr.on('data', (chunk) => stderrChunks.push(chunk));
-    p.stderr.on('pause', () => p.stderr.resume());
-    const dist = p.stdout.pipe(new PassThrough());
-    p.on('close', async (code, signal) => {
-      if (code === 0) {
-        resolve(dist);
-      } else {
-        const message = Buffer.concat(stderrChunks).toString();
-        reject(new Error(`Command "${command}" failed.\nCODE: ${code}\nSIGNAL: ${signal}\nMESSAGE: ${message}`));
-      }
-    });
-    await pipeline(Readable.from([dot]), p.stdin);
-  });
-}
-
-async function toFile(dot, path, options) {
-  const stream = await toStream(dot, options);
-  await pipeline(stream, createWriteStream(path));
-}
-
-export { toFile, toStream };

package/lib/adapter/types/index.cjs

@@ -1 +0,0 @@
-'use strict';

package/lib/adapter/types/index.d.ts

@@ -1,134 +0,0 @@
-import {
-  EdgeAttributesObject,
-  NodeAttributesObject,
-  GraphAttributesObject,
-  SubgraphAttributesObject,
-} from '../../common/index.js';
-import { $keywords, $keywordsValidation } from '../../utils/index.js';
-
-type Format = Format.values;
-declare namespace Format {
-  type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
-  interface $values extends $keywords<'png' | 'svg' | 'json' | 'jpg' | 'pdf' | 'xdot' | 'dot' | 'plain' | 'dot_json'> {}
-  interface $exclude extends $keywordsValidation {}
-}
-type Layout = Layout.values;
-declare namespace Layout {
-  type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
-  interface $values
-    extends $keywords<'dot' | 'neato' | 'fdp' | 'sfdp' | 'circo' | 'twopi' | 'nop' | 'nop2' | 'osage' | 'patchwork'> {}
-  interface $exclude extends $keywordsValidation {}
-}
-/**
- * NeatoOptions interface provides options for the neato layout.
- */
-interface NeatoOptions {
-  layout: 'neato';
-  /**
-   * Sets no-op flag in neato.
-   */
-  noop?: number;
-  /**
-   * Reduce graph.
-   */
-  reduce?: boolean;
-}
-/**
- * FdpOptions interface provides options for the fdp layout.
- */
-interface FdpOptions {
-  layout: 'fdp';
-  /**
-   * Use grid.
-   *
-   * @default true
-   */
-  grid?: boolean;
-  /**
-   * Use old attractive force
-   *
-   * @default true
-   */
-  oldAttractive?: boolean;
-  /**
-   * Set number of iterations.
-   */
-  iterations?: number;
-  /**
-   * Set unscaled factor
-   */
-  unscaledFactor?: number;
-  /**
-   * Set overlap expansion factor.
-   */
-  overlapExpansionFactor?: number;
-  /**
-   * Set temperature.
-   */
-  temperature?: number;
-}
-/**
- * @description
- * This interface describes an optional parameter called "layout" which is used to set a layout engine.
- * The default value for this parameter is 'dot', and it must be an option of the Layout type,
- * excluding 'neato' and 'fdp'.
- */
-interface OtherOptions {
-  /**
-   * Set layout engine.
-   *
-   * @default 'dot'
-   */
-  layout?: Exclude<Layout, 'neato' | 'fdp'>;
-}
-/**
- * This interface represents the CommonOptions for setting output format.
- */
-interface CommonOptions {
-  /**
-   * Set output format.
-   *
-   * @default 'svg'
-   */
-  format?: Format;
-  /**
-   * If true, set level of message suppression (=1).
-   *
-   * @default true
-   */
-  suppressWarnings?: boolean;
-  /**
-   * Path of graphviz dot command.
-   */
-  dotCommand?: string;
-  attributes?: {
-    /**
-     * Set edge attribute.
-     */
-    edge?: EdgeAttributesObject;
-    /**
-     * Set node attribute.
-     */
-    node?: NodeAttributesObject;
-    /**
-     * Set graph attribute.
-     */
-    graph?: GraphAttributesObject & SubgraphAttributesObject;
-  };
-  /**
-   * Scale input
-   */
-  scale?: number;
-  /**
-   * Use external library.
-   */
-  library?: string[];
-  /**
-   * Invert y coordinate in output.
-   */
-  y?: boolean;
-}
-type Options<T extends Layout = Layout> = CommonOptions &
-  (T extends 'neato' ? NeatoOptions : T extends 'fdp' ? FdpOptions : OtherOptions);
-
-export { CommonOptions, FdpOptions, Format, Layout, NeatoOptions, Options, OtherOptions };

package/lib/adapter/utils/index.cjs

@@ -1,58 +0,0 @@
-'use strict';
-
-function escapeValue(value) {
-  if (value !== true) {
-    if (typeof value === 'string' && /\s/g.test(value)) {
-      return `="${value}"`;
-    } else {
-      return `=${value}`;
-    }
-  }
-  return '';
-}
-function* createCommandArgs(options) {
-  const { suppressWarnings = true, format = 'svg', attributes = {}, library = [], y = false, scale } = options;
-  if (suppressWarnings) yield '-q';
-  yield `-T${format}`;
-  if (attributes.graph) {
-    for (const [key, value] of Object.entries(attributes.graph)) {
-      yield `-G${key}${escapeValue(value)}`;
-    }
-  }
-  if (attributes.node) {
-    for (const [key, value] of Object.entries(attributes.node)) {
-      yield `-N${key}${escapeValue(value)}`;
-    }
-  }
-  if (attributes.edge) {
-    for (const [key, value] of Object.entries(attributes.edge)) {
-      yield `-E${key}${escapeValue(value)}`;
-    }
-  }
-  if (typeof scale === 'number' && !Number.isNaN(scale)) yield `-s${scale}`;
-  if (Array.isArray(library)) for (const lib of library) yield `-l${lib}`;
-  if (y === true) yield `-y`;
-  if (typeof options.layout === 'string') {
-    yield `-K${options.layout}`;
-    switch (options.layout) {
-      case 'neato':
-        const { reduce, noop } = options;
-        if (reduce === true) yield '-x';
-        if (typeof noop === 'number') yield `-n${noop}`;
-        break;
-      case 'fdp':
-        const { grid, oldAttractive, iterations, unscaledFactor, overlapExpansionFactor, temperature } = options;
-        yield ['-L', grid ? '' : 'g', oldAttractive ? 'O' : ''].join('');
-        if (typeof iterations === 'number') yield `-Ln${iterations}`;
-        if (typeof unscaledFactor === 'number') yield `-LU${unscaledFactor}`;
-        if (typeof overlapExpansionFactor === 'number') yield `-LC${overlapExpansionFactor}`;
-        if (typeof temperature === 'number') yield `-LT${temperature}`;
-    }
-  }
-}
-
-function createCommandAndArgs(options) {
-  return [options.dotCommand ?? 'dot', Array.from(createCommandArgs(options))];
-}
-
-exports.createCommandAndArgs = createCommandAndArgs;

package/lib/adapter/utils/index.d.ts

@@ -1,11 +0,0 @@
-import { Layout, Options } from '../types/index.js';
-
-/**
- * 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.
- */
-declare function createCommandAndArgs<T extends Layout>(options: Options<T>): [command: string, args: string[]];
-
-export { createCommandAndArgs };

package/lib/adapter/utils/index.js

@@ -1,56 +0,0 @@
-function escapeValue(value) {
-  if (value !== true) {
-    if (typeof value === 'string' && /\s/g.test(value)) {
-      return `="${value}"`;
-    } else {
-      return `=${value}`;
-    }
-  }
-  return '';
-}
-function* createCommandArgs(options) {
-  const { suppressWarnings = true, format = 'svg', attributes = {}, library = [], y = false, scale } = options;
-  if (suppressWarnings) yield '-q';
-  yield `-T${format}`;
-  if (attributes.graph) {
-    for (const [key, value] of Object.entries(attributes.graph)) {
-      yield `-G${key}${escapeValue(value)}`;
-    }
-  }
-  if (attributes.node) {
-    for (const [key, value] of Object.entries(attributes.node)) {
-      yield `-N${key}${escapeValue(value)}`;
-    }
-  }
-  if (attributes.edge) {
-    for (const [key, value] of Object.entries(attributes.edge)) {
-      yield `-E${key}${escapeValue(value)}`;
-    }
-  }
-  if (typeof scale === 'number' && !Number.isNaN(scale)) yield `-s${scale}`;
-  if (Array.isArray(library)) for (const lib of library) yield `-l${lib}`;
-  if (y === true) yield `-y`;
-  if (typeof options.layout === 'string') {
-    yield `-K${options.layout}`;
-    switch (options.layout) {
-      case 'neato':
-        const { reduce, noop } = options;
-        if (reduce === true) yield '-x';
-        if (typeof noop === 'number') yield `-n${noop}`;
-        break;
-      case 'fdp':
-        const { grid, oldAttractive, iterations, unscaledFactor, overlapExpansionFactor, temperature } = options;
-        yield ['-L', grid ? '' : 'g', oldAttractive ? 'O' : ''].join('');
-        if (typeof iterations === 'number') yield `-Ln${iterations}`;
-        if (typeof unscaledFactor === 'number') yield `-LU${unscaledFactor}`;
-        if (typeof overlapExpansionFactor === 'number') yield `-LC${overlapExpansionFactor}`;
-        if (typeof temperature === 'number') yield `-LT${temperature}`;
-    }
-  }
-}
-
-function createCommandAndArgs(options) {
-  return [options.dotCommand ?? 'dot', Array.from(createCommandArgs(options))];
-}
-
-export { createCommandAndArgs };