@ts-graphviz/adapter 0.0.0-pr956-20240225073457

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @ts-graphviz/adapter
+
+## 0.0.0-pr956-20240225073457
+
+### Major Changes
+
+- [`6b2f0e8`](https://github.com/ts-graphviz/ts-graphviz/commit/6b2f0e8349605b4fe0dd950147ba3a8285b24b24) Thanks [@kamiazya](https://github.com/kamiazya)! - Release v2.0.0
+
+### Patch Changes
+
+- Updated dependencies [[`6b2f0e8`](https://github.com/ts-graphviz/ts-graphviz/commit/6b2f0e8349605b4fe0dd950147ba3a8285b24b24)]:
+  - @ts-graphviz/common@0.0.0-pr956-20240225073457

package/LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2019-2024 Yuki Yamazaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# @ts-graphviz/adapter
+
+This package contains runtime-dependent processing for the ts-graphviz library, such as I/O processing.
+
+It is part of the ts-graphviz library, which is split into modular packages to improve maintainability, flexibility, and ease of use.
+
+## Features
+
+- Runtime-specific I/O processing
+- Adapter function implementations for various environments, such as Node.js, Deno and browser(not implemented)
+
+## Usage
+
+Import the necessary classes and functions from the @ts-graphviz/adapter package:
+
+```ts
+import { } from '@ts-graphviz/adapter';
+```
+
+Use the imported items in your project to work with ts-graphviz in different runtime environments:
+
+```ts
+// TODO
+```
+
+For more examples and usage details, please refer to the ts-graphviz documentation.
+
+
+## Contributing
+
+Contributions to the ts-graphviz project are welcome.
+
+Please refer to the main ts-graphviz repository for guidelines on how to contribute.
+
+## License
+
+This package is released under the MIT License.

package/lib/browser.cjs

@@ -0,0 +1,14 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+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/browser.d.ts

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

package/lib/browser.js

@@ -0,0 +1,9 @@
+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/create-command-and-args.cjs

@@ -0,0 +1,87 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+function escapeValue(value) {
+  if (value !== true) {
+    if (typeof value === "string" && /\s/g.test(value)) {
+      return `="${value}"`;
+    }
+    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}`;
+        break;
+      }
+    }
+  }
+}
+
+function createCommandAndArgs(options) {
+  return [options.dotCommand ?? "dot", Array.from(createCommandArgs(options))];
+}
+
+exports.createCommandAndArgs = createCommandAndArgs;

package/lib/create-command-and-args.d.ts

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

package/lib/create-command-and-args.js

@@ -0,0 +1,83 @@
+function escapeValue(value) {
+  if (value !== true) {
+    if (typeof value === "string" && /\s/g.test(value)) {
+      return `="${value}"`;
+    }
+    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}`;
+        break;
+      }
+    }
+  }
+}
+
+function createCommandAndArgs(options) {
+  return [options.dotCommand ?? "dot", Array.from(createCommandArgs(options))];
+}
+
+export { createCommandAndArgs };

package/lib/create-command-args.d.ts

@@ -0,0 +1,18 @@
+import { Attribute, AttributeKey } from '@ts-graphviz/common';
+import { Layout, Options } from './types.js';
+/**
+ * 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
+ */
+export declare function escapeValue<T extends AttributeKey>(value: Attribute<T>): string;
+/**
+ * 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
+ */
+export declare function createCommandArgs<T extends Layout>(options: Options<T>): Generator<string>;

package/lib/deno.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @module @ts-graphviz/adapter
+ */
+import { Layout, Options } from './types.js';
+/**
+ * Execute the Graphviz dot command and make a Stream of the results.
+ */
+export declare 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 declare function toFile<T extends Layout>(dot: string, path: string, options?: Options<T>): Promise<void>;

package/lib/deno.js

@@ -0,0 +1,31 @@
+import { createCommandAndArgs } from './create-command-and-args.js';
+
+async function toStream(dot, options) {
+  const [command, args] = createCommandAndArgs(options ?? {});
+  const cp = new Deno.Command(command, {
+    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;
+  }
+}
+async function toFile(dot, path, options) {
+  const output = await open(path);
+  const stream = await toStream(dot, options);
+  await stream.pipeTo(output.writable);
+}
+
+export { toFile, toStream };

package/lib/node.cjs

@@ -0,0 +1,55 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const node_child_process = require('node:child_process');
+const node_stream = require('node:stream');
+const promises = require('node:stream/promises');
+const createCommandAndArgs = require('./create-command-and-args.cjs');
+const node_fs = require('node:fs');
+
+async function toStream(dot, options) {
+  const [command, args] = createCommandAndArgs.createCommandAndArgs(options ?? {});
+  return new Promise(function toStreamInternal(resolve, reject) {
+    const p = node_child_process.spawn(command, args, { stdio: "pipe" });
+    p.on("error", (e) => {
+      reject(
+        new Error(`Command "${command}" failed.
+MESSAGE:${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.
+CODE: ${code}
+SIGNAL: ${signal}
+MESSAGE: ${message}`
+          )
+        );
+      }
+    });
+    promises.pipeline(node_stream.Readable.from([dot]), p.stdin);
+  });
+}
+
+async function toFile(dot, path, options) {
+  const stream = await toStream(dot, options);
+  await promises.pipeline(stream, node_fs.createWriteStream(path));
+}
+
+exports.toFile = toFile;
+exports.toStream = toStream;

package/lib/node.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @module @ts-graphviz/adapter
+ */
+export type { Options, Format, Layout } from './types.js';
+export * from './to-stream.node.js';
+export * from './to-file.node.js';

package/lib/node.js

@@ -0,0 +1,50 @@
+import { spawn } from 'node:child_process';
+import { PassThrough, Readable } from 'node:stream';
+import { pipeline } from 'node:stream/promises';
+import { createCommandAndArgs } from './create-command-and-args.js';
+import { createWriteStream } from 'node:fs';
+
+async function toStream(dot, options) {
+  const [command, args] = createCommandAndArgs(options ?? {});
+  return new Promise(function toStreamInternal(resolve, reject) {
+    const p = spawn(command, args, { stdio: "pipe" });
+    p.on("error", (e) => {
+      reject(
+        new Error(`Command "${command}" failed.
+MESSAGE:${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.
+CODE: ${code}
+SIGNAL: ${signal}
+MESSAGE: ${message}`
+          )
+        );
+      }
+    });
+    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/to-file.node.d.ts

@@ -0,0 +1,5 @@
+import { Layout, Options } from './types.js';
+/**
+ * Execute the Graphviz dot command and output the results to a file.
+ */
+export declare function toFile<T extends Layout>(dot: string, path: string, options?: Options<T>): Promise<void>;

package/lib/to-stream.node.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" resolution-mode="require"/>
+import { Layout, Options } from './types.js';
+/**
+ * Execute the Graphviz dot command and make a Stream of the results.
+ */
+export declare function toStream<T extends Layout>(dot: string, options?: Options<T>): Promise<NodeJS.ReadableStream>;

package/lib/types.d.ts

@@ -0,0 +1,127 @@
+import { $keywords, $keywordsValidation, EdgeAttributesObject, GraphAttributesObject, NodeAttributesObject, SubgraphAttributesObject } from '@ts-graphviz/common';
+export type Format = Format.values;
+export 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 {
+    }
+}
+export type Layout = Layout.values;
+export 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.
+ */
+export interface NeatoOptions {
+    layout: 'neato';
+    /**
+     * Sets no-op flag in neato.
+     */
+    noop?: number;
+    /**
+     * Reduce graph.
+     */
+    reduce?: boolean;
+}
+/**
+ * FdpOptions interface provides options for the fdp layout.
+ */
+export 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'.
+ */
+export interface OtherOptions {
+    /**
+     * Set layout engine.
+     *
+     * @default 'dot'
+     */
+    layout?: Exclude<Layout, 'neato' | 'fdp'>;
+}
+/**
+ * This interface represents the CommonOptions for setting output format.
+ */
+export 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;
+}
+export type Options<T extends Layout = Layout> = CommonOptions & (T extends 'neato' ? NeatoOptions : T extends 'fdp' ? FdpOptions : OtherOptions);

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@ts-graphviz/adapter",
+  "version": "0.0.0-pr956-20240225073457",
+  "description": "",
+  "type": "module",
+  "main": "./lib/node.cjs",
+  "module": "./lib/node.js",
+  "types": "./lib/node.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "types": "./lib/browser.d.ts",
+        "require": "./lib/browser.cjs",
+        "default": "./lib/browser.js"
+      },
+      "deno": {
+        "types": "./lib/deno.d.ts",
+        "default": "./lib/deno.js"
+      },
+      "default": {
+        "types": "./lib/node.d.ts",
+        "require": "./lib/node.cjs",
+        "default": "./lib/node.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ts-graphviz/ts-graphviz.git",
+    "directory": "packages/adapter"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "author": "Yuki Yamazaki <yuki@kamiazya.tech>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
+  },
+  "homepage": "https://github.com/ts-graphviz/ts-graphviz#readme",
+  "dependencies": {
+    "@ts-graphviz/common": "^0.0.0-pr956-20240225073457"
+  },
+  "devDependencies": {
+    "@deno/shim-deno": "^0.19.1",
+    "@types/node": "^20.2.1",
+    "typescript": "^5.3.3",
+    "vite": "^5.1.3",
+    "vite-plugin-dts": "^3.7.2"
+  },
+  "scripts": {
+    "build": "vite build && rm ./lib/deno.cjs "
+  }
+}