ts-graphviz 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,676 @@
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d6485f9858ed4b3e8ef76611a2896bc4)](https://app.codacy.com/gh/ts-graphviz/ts-graphviz?utm_source=github.com&utm_medium=referral&utm_content=ts-graphviz/ts-graphviz&utm_campaign=Badge_Grade_Settings)
+[![GitHub Action](https://github.com/kamiazya/ts-graphviz/workflows/NodeCI/badge.svg)](https://github.com/kamiazya/ts-graphviz/actions?workflow=NodeCI)
+[![npm version](https://badge.fury.io/js/ts-graphviz.svg)](https://badge.fury.io/js/ts-graphviz)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
+[![code style: prettier](https://img.shields.io/badge/code%20style-prettier-ff69b4?logo=prettier&style=flat)](https://github.com/facebook/jest)
+[![test: jest](https://img.shields.io/badge/tested%20with-jest-99424f?logo=jest&style=flat)](https://github.com/facebook/jest)
+![node version](https://img.shields.io/node/v/ts-graphviz)
+[![deno version](https://img.shields.io/badge/deno-^1.28.0-black?logo=deno)](https://github.com/denoland/deno)
+![npm](https://img.shields.io/npm/dm/ts-graphviz)
+[![All Contributors](https://img.shields.io/github/all-contributors/ts-graphviz/ts-graphviz?color=orange)](#contributors)
+[![Tidelift](https://tidelift.com/badges/package/npm/ts-graphviz?style=flat)](https://tidelift.com/subscription/pkg/npm-ts-graphviz?utm_source=npm-ts-graphviz&utm_medium=readme)
+
+# ts-graphviz
+
+[Graphviz](https://graphviz.gitlab.io/) library for TypeScript.
+
+[![GitHub](https://img.shields.io/badge/-GitHub-181717?logo=GitHub&style=flat)](https://github.com/ts-graphviz/ts-graphviz)
+[![npm](https://img.shields.io/badge/-npm-CB3837?logo=npm&style=flat)](https://www.npmjs.com/package/ts-graphviz)
+[![yarn](https://img.shields.io/badge/-yarn-ffffff?logo=Yarn&style=flat)](https://yarnpkg.com/package/ts-graphviz)
+[![Refarence](https://img.shields.io/badge/-Refarence-3178C6?logo=TypeScript&style=flat&logoColor=fff)](https://ts-graphviz.github.io/ts-graphviz/)
+[![Suponser](https://img.shields.io/badge/-Suponser-fff?logo=GitHub%20Sponsors&style=flat)](https://github.com/sponsors/kamiazya)
+
+> [English](https://github.com/ts-graphviz/ts-graphviz/blob/main/packages/ts-graphviz/README.md) | [日本語](https://github.com/ts-graphviz/ts-graphviz/blob/main/packages/ts-graphviz/README_ja.md)
+
+## Key Features ✨
+
+`ts-graphviz` package provides models and ASTs for the Graphviz DOT language fully integrated with TypeScript.
+
+- **TypeScript-friendly API**
+  - It provides models in the DOT language. TypeScript type definitions are also provided for attributes and even attribute types.
+- **Freedom from programming paradigms**
+  - Designed to be object-oriented, it provides APIs that can be adapted to both imperative and declarative APIs. You can choose the paradigm that best fits your project.
+- **Suitable for any use cases**
+  - Both a high-layer API to provide models and a low-layer API to handle ASTs are provided to address any use cases.
+
+## Installation 💽
+
+### Node.js
+
+This package can then be installed using a package manager.
+
+```bash
+# npm
+$ npm install -S ts-graphviz
+# or yarn
+$ yarn add ts-graphviz
+# or pnpm
+$ pnpm add ts-graphviz
+```
+
+> **Note** Want to try before installing? Check out [Runkit](https://npm.runkit.com/ts-graphviz) to see how it works.
+
+### Deno 🦕
+
+[Deno v1.28 and above supports npm](https://deno.land/manual/node/npm_specifiers).
+
+You can install and use the package by specifying the following:
+
+```ts
+import { toDot } from 'npm:ts-graphviz';
+```
+
+## Usage 📑
+
+This section provides an overview of the package.
+
+For more detailed API specifications, please refer to the comments in the TypeScript type definitions and the [document](https://ts-graphviz.github.io/ts-graphviz/) automatically generated based on them.
+
+### `ts-graphviz` Module 🚩
+
+This module provides **Model**, an interface for working with the DOT language in JavaScript/TypeScript.
+
+![ts-graphviz](./media/ts-graphviz.svg)
+
+#### Object-Oriented ❤️
+
+**Model** is designed to be object-oriented and provides classes `Digraph`, `Graph`, `Subgraph`, `Node`, and `Edge`.
+
+Provides a `toDot` function to convert **Model** to **DOT** (DOT language string).
+
+```typescript
+import { attribute as _, Digraph, Subgraph, Node, Edge, toDot } from 'ts-graphviz';
+
+const G = new Digraph();
+const A = new Subgraph('A');
+const node1 = new Node('node1', {
+  [_.color]: 'red'
+});
+const node2 = new Node('node2', {
+  [_.color]: 'blue'
+});
+const edge = new Edge([node1, node2], {
+  [_.label]: 'Edge Label',
+  [_.color]: 'pink'
+});
+G.addSubgraph(A);
+A.addNode(node1);
+A.addNode(node2);
+A.addEdge(edge);
+const dot = toDot(G);
+// digraph {
+//   subgraph "A" {
+//     "node1" [
+//       color = "red",
+//     ];
+//     "node2" [
+//       color = "blue",
+//     ];
+//     "node1" -> "node2" [
+//       label = "Edge Label",
+//       color = "pink",
+//     ];
+//   }
+// }
+```
+
+<details>
+<summary>Advanced Usage</summary>
+
+##### Custom Class 🤖
+
+You can also add your own implementation by inheriting from the class.
+
+```typescript
+import { Digraph, Node, Edge, EdgeTargetTuple, attribute as _, toDot } from 'ts-graphviz';
+
+class MyCustomDigraph extends Digraph {
+  constructor() {
+    super('G', {
+      [_.label]: 'This is Custom Digraph',
+    });
+  }
+}
+class MyCustomNode extends Node {
+  constructor(id: string) {
+    super(`node_${id}`, {
+      [_.label]: `This is Custom Node ${id}`,
+    });
+  }
+}
+
+class MyCustomEdge extends Edge {
+  constructor(targets: EdgeTargetTuple) {
+    super(targets, {
+      [_.label]: 'This is Custom Edge',
+    });
+  }
+}
+
+const digraph = new MyCustomDigraph();
+const node1 = new MyCustomNode('A');
+const node2 = new MyCustomNode('B');
+const edge = new MyCustomEdge([node1, node2]);
+digraph.addNode(node1);
+digraph.addNode(node2);
+digraph.addEdge(edge);
+const dot = toDot(digraph);
+// digraph "G" {
+//   label = "This is Custom Digraph";
+//   "node_A" [
+//     label = "This is Custom Node A";
+//   ];
+//   "node_B" [
+//     label = "This is Custom Node B";
+//   ];
+//   "node_A" -> "node_B" [
+//     label = "This is Custom Edge";
+//   ];
+// }
+```
+
+##### Models Context API ( `with` method) 🧅
+
+You can also use the _Models Context API_ to create custom classes for objects generated inside of Graph.
+
+
+The `with` methods of `Digraph`, `Graph`, and `Subgraph`, which are implementations of `GraphBaseModel`, are provided to predefine custom models.
+
+```typescript
+const g = new Digraph();
+g.with({
+  Node: MyCustomNode,
+  Edge: MyCustomEdge,
+});
+const a = g.createNode('A'); // MyCustomNode
+const b = g.createNode('B'); // MyCustomNode
+g.createEdge([a, b]); // MyCustomEdge
+const dot = toDot(g);
+// digraph {
+//   "node_A" [
+//     label = "This is Custom Node A";
+//   ];
+//   "node_B" [
+//     label = "This is Custom Node B";
+//   ];
+//   "node_A" -> "node_B" [
+//     label = "This is Custom Edge";
+//   ];
+// }
+```
+
+##### `fromDot` function ⏪
+
+> The status of this function is ! [beta](https://img.shields.io/badge/-beta-orange).
+
+The main scenario for using this library is to use the `toDot` function, but it also supports conversions in the reverse direction.
+
+By converting **DOT** to **Model**, a portion of the code can be written in the DOT language.
+
+```typescript
+const G = fromDot(
+  `digraph {
+    node_A [
+      label = "This is a Label of Node A";
+    ];
+  }`,
+);
+
+G.edge(['node_A', 'node_B']);
+
+const dot = toDot(G)
+// digraph {
+//   "node_A" [
+//     label = "This is a Label of Node A";
+//   ];
+//   "node_A" -> "node_B";
+// }
+```
+
+</details>
+
+#### Declarative API 😎
+
+When creating `Graph` or `Digraph`, you can use _Model Factory_ to provide a notation more similar to the **DOT** language.
+
+**Model** also has a declarative API, so you can consistently choose a declarative paradigm.
+
+
+```typescript
+import { attribute as _, digraph, toDot } from 'ts-graphviz';
+
+ const G = digraph('G', (g) => {
+  const a = g.node('aa');
+  const b = g.node('bb');
+  const c = g.node('cc');
+  g.edge([a, b, c], {
+    [_.color]: 'red'
+  });
+  g.subgraph('A', (A) => {
+    const Aa = A.node('Aaa', {
+      [_.color]: 'pink'
+    });
+
+    const Ab = A.node('Abb', {
+      [_.color]: 'violet'
+    });
+    const Ac = A.node('Acc');
+    A.edge([Aa.port('a'), Ab, Ac, 'E'], {
+      [_.color]: 'red'
+    });
+  });
+});
+
+const dot = toDot(G);
+// digraph "G" {
+//   "aa";
+//   "bb";
+//   "cc";
+//   subgraph "A" {
+//     "Aaa" [
+//       color = "pink",
+//     ];
+//     "Abb" [
+//       color = "violet",
+//     ];
+//     "Acc";
+//     "Aaa":"a" -> "Abb" -> "Acc" -> "E" [
+//       color = "red",
+//     ];
+//   }
+//   "aa" -> "bb" -> "cc" [
+//     color = "red",
+//   ];
+// }
+```
+
+> **Note** Of course, we also provide an API for creating strict mode graphs.
+>
+> ```typescript
+> import { strict, toDot } from 'ts-graphviz';
+>
+> const G = strict.graph(...);
+> const dot = toDot(G);
+> // strict graph {
+> // }
+> ```
+
+
+<details>
+<summary>Advanced Usage</summary>
+
+##### Models Context API ( `withContext` function ) 💈
+
+
+The `withContext` function returns a _Model Factory_ function.
+
+This _Model Factory_ provides a means to replace `RootGraphModel` with a custom class, such as `Digraph` or `Graph`.
+
+This API provides a way to integrate declarative APIs and custom classes.
+
+```typescript
+const { digraph } = withContext({
+  Digraph: MyCustomDigraph,
+  Node: MyCustomNode,
+  Edge: MyCustomEdge,
+});
+
+const G = digraph((g) => {
+  const a = g.node('A'); // MyCustomNode
+  const b = g.node('B'); // MyCustomNode
+  g.edge([a, b]); // MyCustomEdge
+});
+const dot = toDot(g);
+// digraph "G" {
+//   label = "This is Custom Digraph";
+//   "node_A" [
+//     label = "This is Custom Node A";
+//   ];
+//   "node_B" [
+//     label = "This is Custom Node B";
+//   ];
+//   "node_A" -> "node_B" [
+//     label = "This is Custom Edge";
+//   ];
+// }
+```
+
+</details>
+
+### `ts-graphviz/adapter` Module 🔌
+
+> This module status is ![beta](https://img.shields.io/badge/-beta-orange).
+
+
+Provides an interface to run Graphviz dot commands.
+
+[Graphviz](https://graphviz.gitlab.io/) must be installed so that the dot command can be executed.
+
+Execute the dot command to output a DOT language string to a stream or file.
+
+![Adapter State Machine](./media/adapter-state-machine.svg)
+
+This module provides the following functions.
+
+- The `toStream` function converts **DOT** to **Stream**.
+    ```ts
+    import { toStream } from 'ts-graphviz/adapter';
+
+    const dot = `
+      digraph example {
+        node1 [
+          label = "My Node",
+        ]
+      }
+    `;
+
+    const stream = await toStream(dot, { format: 'svg' });
+    // Node.js
+    stream.pipe(process.stdout);
+    // Deno
+    await stream.pipeTo(Deno.stdout.writable);
+    ```
+- Writes **DOT** to a file at the specified path `toFile` function
+    ```ts
+    import { toFile } from 'ts-graphviz/adapter';
+
+    const dot = `
+      digraph example {
+        node1 [
+          label = "My Node",
+        ]
+      }
+    `;
+
+    await toFile(dot, './result.svg', { format: 'svg' });
+    ```
+
+> **Note** Designed to work with Node.js and Deno, Stream is runtime native.
+
+### `ts-graphviz/ast` Module 🔢
+
+> This module status is ![beta](https://img.shields.io/badge/-beta-orange).
+
+An API is provided to handle ASTs for advanced use.
+
+![State Machine](./media/state-machine.svg)
+
+The following functions are provided as described in the state transition diagram.
+
+- The `fromModel` function converts **Model** to **AST**.
+- The `toModel` function converts **AST** to **Model**.
+- The `stringify` function converts **AST** to **DOT**.
+- The `parse` function to convert from **DOT** to **AST**.
+
+> **Note** As you can see from the above figure, the `toDot` function provided by the `ts-graphviz` package is a composite of `fromModel` and `stringify`. The `fromDot` function is a composite of `parse` and `toModel`.
+
+Detailed usage is TODO.
+Please refer to the TypeScript type definition.
+
+
+<details>
+<summary>The parse function and AST</summary>
+
+
+```typescript
+import { parse } from 'ts-graphviz/ast';
+
+const ast = parse(`
+  digraph example {
+    node1 [
+      label = "My Node",
+    ]
+  }
+`);
+// {
+//   type: 'Dot',
+//   location: {
+//     start: { offset: 3, line: 2, column: 3 },
+//     end: { offset: 68, line: 7, column: 1 }
+//   },
+//   children: [
+//     {
+//       id: {
+//         value: 'example',
+//         quoted: false,
+//         type: 'Literal',
+//         location: {
+//           start: { offset: 11, line: 2, column: 11 },
+//           end: { offset: 18, line: 2, column: 18 }
+//         },
+//         children: []
+//       },
+//       directed: true,
+//       strict: false,
+//       type: 'Graph',
+//       location: {
+//         start: { offset: 3, line: 2, column: 3 },
+//         end: { offset: 67, line: 6, column: 4 }
+//       },
+//       children: [
+//         {
+//           id: {
+//             value: 'node1',
+//             quoted: false,
+//             type: 'Literal',
+//             location: {
+//               start: { offset: 25, line: 3, column: 5 },
+//               end: { offset: 30, line: 3, column: 10 }
+//             },
+//             children: []
+//           },
+//           type: 'Node',
+//           location: {
+//             start: { offset: 25, line: 3, column: 5 },
+//             end: { offset: 63, line: 5, column: 6 }
+//           },
+//           children: [
+//             {
+//               key: {
+//                 value: 'label',
+//                 quoted: false,
+//                 type: 'Literal',
+//                 location: {
+//                   start: { offset: 39, line: 4, column: 7 },
+//                   end: { offset: 44, line: 4, column: 12 }
+//                 },
+//                 children: []
+//               },
+//               value: {
+//                 value: 'My Node',
+//                 quoted: true,
+//                 type: 'Literal',
+//                 location: {
+//                   start: { offset: 47, line: 4, column: 15 },
+//                   end: { offset: 56, line: 4, column: 24 }
+//                 },
+//                 children: []
+//               },
+//               location: {
+//                 start: { offset: 39, line: 4, column: 7 },
+//                 end: { offset: 57, line: 4, column: 25 }
+//               },
+//               type: 'Attribute',
+//               children: []
+//             }
+//           ]
+//         }
+//       ]
+//     }
+//   ]
+// }
+```
+
+</details>
+
+### Extending the Type System 🧰
+
+> The status of this feature is ![beta](https://img.shields.io/badge/-beta-orange).
+
+With ts-graphviz, you can extend the library's type system to customize graph visualization solutions to meet specific needs.
+
+> **Note** To allow for customization, types are named with the `$` symbol.
+>
+> If you want to extend a type definition in cases not listed below, check the source code to see if you can extend it with `$...`.
+>
+> If not, please create an issue or pull request.
+
+#### Use Case: Specifying Custom Graph Layout and Output Formats
+
+```ts
+import { $keywords } from 'ts-graphviz';
+import { toFile } from 'ts-graphviz/adapter';
+
+// 1. Declare the 'ts-graphviz/adapter' module.
+declare module 'ts-graphviz/adapter' {
+  export namespace Layout {
+    // 2. Define the $values interface in the Layout namespace.
+    // 3. Inherit from $keywords<'my-custom-algorithm'> and specify the name of the new layout engine in <...>.
+    export interface $values extends $keywords<'my-custom-algorithm'> {}
+  }
+
+  export namespace Format {
+    // 4. Define the $values interface in the Format namespace.
+    // 5. Inherit from $keywords<'mp4'> and specify the name of the new output format in <...>.
+    export interface $values extends $keywords<'mp4'> {}
+  }
+}
+
+toFile('digraph { a -> b }', '/path/to/file', {
+  layout: 'my-custom-algorithm',
+  format: 'mp4',
+});
+```
+
+#### Use Case: Adding Custom Attributes
+
+```ts
+import { digraph, toDot, attribute as _, $keywords } from 'ts-graphviz';
+
+// 1. Declare the 'ts-graphviz' module.
+declare module 'ts-graphviz' {
+  export namespace GraphAttributeKey {
+    // 2. Define the $values interface in the GraphAttributeKey namespace.
+    // 3. Inherit from $keywords<'hoge'> and specify the name of the new attribute in <...>.
+    export interface $values extends $keywords<'hoge'> {}
+  }
+
+  export namespace Attribute {
+    // 4. Define the $keys interface in the Attribute namespace.
+    // 5. Inherit from $keywords<'hoge'> and specify the name of the new attribute in <...>.
+    export interface $keys extends $keywords<'hoge'> {}
+
+    // 6. Define the $types interface in the Attribute namespace.
+    // 7. Specify the new attribute in the key and define its corresponding value in the value.
+    export interface $types {
+      hoge: string;
+    }
+  }
+}
+
+console.log(
+  toDot(
+    digraph((g) => {
+      g.set(_.hoge, 'fuga');
+    }),
+  ),
+);
+```
+
+## Who's using `ts-graphviz` 📜
+
+- [Apollo GraphQL](https://github.com/apollographql)
+- [AWS](https://github.com/aws)
+- [IBM (StrongLoop)](https://strongloop.com)
+- [The University of Tokyo](https://github.com/csg-tokyo)
+- [Transmute](https://github.com/transmute-industries)
+
+> **Note** Let us know that you're using `ts-graphviz` on [GitHub Discussions](https://github.com/ts-graphviz/ts-graphviz/discussions/736) 🙏
+
+
+## Related Projects 💫
+
+Related projects can be found at [**ts-graphviz** GitHub Organization](https://github.com/ts-graphviz).
+
+The TypeScript/JavaScript ecosystem provides a variety of OSS with the goal of making Graphviz more connected and easier to use.
+
+## Contributors 👥
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="http://blog.kamiazya.tech/"><img src="https://avatars0.githubusercontent.com/u/35218186?v=4?s=100" width="100px;" alt="Yuki Yamazaki"/><br /><sub><b>Yuki Yamazaki</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=kamiazya" title="Code">💻</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=kamiazya" title="Tests">⚠️</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=kamiazya" title="Documentation">📖</a> <a href="#ideas-kamiazya" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://laysent.com"><img src="https://avatars2.githubusercontent.com/u/1191606?v=4?s=100" width="100px;" alt="LaySent"/><br /><sub><b>LaySent</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Alaysent" title="Bug reports">🐛</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=laysent" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/elasticdotventures"><img src="https://avatars0.githubusercontent.com/u/35611074?v=4?s=100" width="100px;" alt="elasticdotventures"/><br /><sub><b>elasticdotventures</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=elasticdotventures" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ChristianMurphy"><img src="https://avatars.githubusercontent.com/u/3107513?v=4?s=100" width="100px;" alt="Christian Murphy"/><br /><sub><b>Christian Murphy</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=ChristianMurphy" title="Code">💻</a> <a href="#ideas-ChristianMurphy" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=ChristianMurphy" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ArtemAdamenko"><img src="https://avatars.githubusercontent.com/u/2178516?v=4?s=100" width="100px;" alt="Artem"/><br /><sub><b>Artem</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3AArtemAdamenko" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/fredericohpandolfo"><img src="https://avatars.githubusercontent.com/u/24229136?v=4?s=100" width="100px;" alt="fredericohpandolfo"/><br /><sub><b>fredericohpandolfo</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Afredericohpandolfo" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/diegoquinteiro"><img src="https://avatars.githubusercontent.com/u/1878108?v=4?s=100" width="100px;" alt="diegoquinteiro"/><br /><sub><b>diegoquinteiro</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Adiegoquinteiro" title="Bug reports">🐛</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/robross0606"><img src="https://avatars.githubusercontent.com/u/2965467?v=4?s=100" width="100px;" alt="robross0606"/><br /><sub><b>robross0606</b></sub></a><br /><a href="#ideas-robross0606" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://blake-regalia.net"><img src="https://avatars.githubusercontent.com/u/1456400?v=4?s=100" width="100px;" alt="Blake Regalia"/><br /><sub><b>Blake Regalia</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Ablake-regalia" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/bigbug"><img src="https://avatars.githubusercontent.com/u/27259?v=4?s=100" width="100px;" alt="bigbug"/><br /><sub><b>bigbug</b></sub></a><br /><a href="#question-bigbug" title="Answering Questions">💬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/murawakimitsuhiro"><img src="https://avatars.githubusercontent.com/u/13833242?v=4?s=100" width="100px;" alt="mrwk"/><br /><sub><b>mrwk</b></sub></a><br /><a href="#question-murawakimitsuhiro" title="Answering Questions">💬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/svdvonde"><img src="https://avatars.githubusercontent.com/u/2751783?v=4?s=100" width="100px;" alt="svdvonde"/><br /><sub><b>svdvonde</b></sub></a><br /><a href="#question-svdvonde" title="Answering Questions">💬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/seethroughdev"><img src="https://avatars.githubusercontent.com/u/203779?v=4?s=100" width="100px;" alt="Adam"/><br /><sub><b>Adam</b></sub></a><br /><a href="#question-seethroughdev" title="Answering Questions">💬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/trevor-scheer"><img src="https://avatars.githubusercontent.com/u/29644393?v=4?s=100" width="100px;" alt="Trevor Scheer"/><br /><sub><b>Trevor Scheer</b></sub></a><br /><a href="#a11y-trevor-scheer" title="Accessibility">️️️️♿️</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://pre.ms"><img src="https://avatars.githubusercontent.com/u/238277?v=4?s=100" width="100px;" alt="Prem Pillai"/><br /><sub><b>Prem Pillai</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Acloud-on-prem" title="Bug reports">🐛</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors)
+specification. Contributions of any kind welcome!
+
+## How to Contribute 💪
+
+The easiest way to contribute is to use the library and star [repository](https://github.com/ts-graphviz/ts-graphviz).
+
+### Questions 💭
+
+Feel free to ask questions on [GitHub Discussions](https://github.com/ts-graphviz/ts-graphviz/discussions).
+
+### Report bugs / request additional features 💡
+
+Please register at [GitHub Issues](https://github.com/ts-graphviz/ts-graphviz/issues/new/choose).
+
+### Development / Bug Fixes 🧑‍💻
+
+See [CONTRIBUTING.md](https://github.com/ts-graphviz/ts-graphviz/blob/main/CONTRIBUTING.md).
+
+### Financial Support 💸
+
+Please support [ts-graphviz](https://github.com/sponsors/ts-graphviz).
+
+Our goal for ts-graphviz is to attract 10 sponsors who can provide ongoing support to help cover development and maintenance costs,
+and help us continue expanding and improving the library. By achieving this goal, we can ensure that ts-graphviz remains a valuable resource
+for developers who need to analyze and visualize complex graph structures, while also fostering a strong and supportive community of users and sponsors.
+
+> **Note** Even just a dollar is enough motivation to develop 😊
+
+## ts-graphviz for Enterprise 🏢
+
+Available as part of the Tidelift Subscription.
+
+The maintainers of ts-graphviz and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open-source dependencies you use to build your applications.
+Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use.
+
+[Learn more](https://tidelift.com/subscription/pkg/npm-ts-graphviz?utm_source=npm-ts-graphviz&utm_medium=referral&utm_campaign=enterprise&utm_term=repo).
+
+## License ⚖️
+
+This software is released under the MIT License, see [LICENSE](https://github.com/ts-graphviz/ts-graphviz/blob/main/LICENSE).

package/lib/adapter.cjs

@@ -0,0 +1,14 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const adapter = require('@ts-graphviz/adapter');
+
+
+
+Object.keys(adapter).forEach(k => {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: () => adapter[k]
+	});
+});

package/lib/adapter.d.ts

@@ -0,0 +1 @@
+export * from '@ts-graphviz/adapter';

package/lib/adapter.js

@@ -0,0 +1 @@
+export * from '@ts-graphviz/adapter';

package/lib/ast.cjs

@@ -0,0 +1,14 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const ast = require('@ts-graphviz/ast');
+
+
+
+Object.keys(ast).forEach(k => {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: () => ast[k]
+	});
+});

package/lib/ast.d.ts

@@ -0,0 +1 @@
+export * from '@ts-graphviz/ast';

package/lib/ast.js

@@ -0,0 +1 @@
+export * from '@ts-graphviz/ast';

package/lib/ts-graphviz.cjs

@@ -0,0 +1,21 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const common = require('@ts-graphviz/common');
+const core = require('@ts-graphviz/core');
+
+
+
+Object.keys(common).forEach(k => {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: () => common[k]
+	});
+});
+Object.keys(core).forEach(k => {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: () => core[k]
+	});
+});

package/lib/ts-graphviz.d.ts

@@ -0,0 +1,2 @@
+export * from '@ts-graphviz/common';
+export * from '@ts-graphviz/core';

package/lib/ts-graphviz.js

@@ -0,0 +1,2 @@
+export * from '@ts-graphviz/common';
+export * from '@ts-graphviz/core';

package/media/Makefile

@@ -0,0 +1,7 @@
+DOT = $(wildcard ./*.dot)
+SVG = $(DOT:./%.dot=./%.svg)
+
+image: $(SVG)
+
+%.svg: %.dot
+	dot -Tsvg $< | yarn --silent run svgo - > $@

package/media/adapter-state-machine.dot

@@ -0,0 +1,8 @@
+digraph state_machine {
+  newrank=true;
+
+  node [ shape = circle ]
+
+  DOT -> Stream [ label = "toStream" ]
+  DOT -> File   [ label = "toFile" ]
+}

package/media/adapter-state-machine.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="172pt" height="211pt" viewBox="0 0 172.44 211.09"><g class="graph" transform="translate(4 207.09)"><path fill="#fff" stroke="transparent" d="M-4 4v-211.09h172.44V4H-4z"/><g class="node"><circle cx="89.85" cy="-171.89" r="31.4" fill="none" stroke="#000"/><text x="89.85" y="-168.19" font-family="Times,serif" font-size="14" text-anchor="middle">DOT</text></g><g class="node"><circle cx="44.85" cy="-44.85" r="44.69" fill="none" stroke="#000"/><text x="44.85" y="-41.15" font-family="Times,serif" font-size="14" text-anchor="middle">Stream</text></g><g class="edge"><path fill="none" stroke="#000" d="M66.46-151.09c-7.72 7.95-15.4 17.76-19.61 28.4-2.87 7.24-4.54 15.17-5.4 23.11"/><path stroke="#000" d="m44.94-99.32-4.18 9.73-2.8-10.21 6.98.48z"/><text x="80.35" y="-111.49" font-family="Times,serif" font-size="14" text-anchor="middle">toStream</text></g><g class="node"><circle cx="135.85" cy="-44.85" r="28.7" fill="none" stroke="#000"/><text x="135.85" y="-41.15" font-family="Times,serif" font-size="14" text-anchor="middle">File</text></g><g class="edge"><path fill="none" stroke="#000" d="M104.32-144.01c3.38 6.84 6.79 14.26 9.53 21.32 4.95 12.76 9.35 27.09 12.89 39.89"/><path stroke="#000" d="m130.18-83.48-.79 10.56-5.97-8.75 6.76-1.81z"/><text x="139.85" y="-111.49" font-family="Times,serif" font-size="14" text-anchor="middle">toFile</text></g></g></svg>

package/media/state-machine.dot

@@ -0,0 +1,12 @@
+digraph state_machine {
+  newrank=true;
+
+  node [ shape = circle ]
+
+  Model -> DOT   [ label = "toDot", constraint = false ]
+  AST   -> DOT   [ label = "stringify" ]
+  DOT   -> AST   [ label = "parse" ]
+  Model -> AST   [ label = "fromModel" ]
+  AST   -> Model [ label = "toModel" ]
+  DOT   -> Model [ label = "fromDot", constraint = false ]
+}

package/media/state-machine.svg

@@ -0,0 +1 @@
+<svg width="404" height="197pt" viewBox="0 0 302.59 196.79" xmlns="http://www.w3.org/2000/svg"><g class="graph" transform="translate(4 192.79)"><path fill="#fff" stroke="transparent" d="M-4 4v-196.79h302.59V4H-4z"/><g class="node"><circle fill="none" stroke="#000" cx="52.59" cy="-149.14" r="39.79"/><text text-anchor="middle" x="52.59" y="-145.44" font-family="Times,serif" font-size="14">Model</text></g><g class="node"><circle fill="none" stroke="#000" cx="218.59" cy="-149.14" r="31.4"/><text text-anchor="middle" x="218.59" y="-145.44" font-family="Times,serif" font-size="14">DOT</text></g><g class="edge"><path fill="none" stroke="#000" d="M90.64-137.1c9.44 2.47 19.6 4.7 29.18 5.96 17.63 2.32 22.42 2.63 40 0 6.37-.96 13.01-2.46 19.43-4.2"/><path stroke="#000" d="m178.51-138.77 10.58.54-8.61 6.17-1.97-6.71z"/><text text-anchor="middle" x="139.82" y="-134.94" font-family="Times,serif" font-size="14">toDot</text></g><g class="node"><circle fill="none" stroke="#000" cx="146.59" cy="-29.25" r="29.5"/><text text-anchor="middle" x="146.59" y="-25.55" font-family="Times,serif" font-size="14">AST</text></g><g class="edge"><path fill="none" stroke="#000" d="M21.2-124.93C5.91-110.76-6.93-92.37 4.59-76.49c23.16 31.9 68.9 42.22 102.23 45.34"/><path stroke="#000" d="m107.45-34.61 9.71 4.24-10.23 2.74.52-6.98z"/><text text-anchor="middle" x="44.09" y="-80.29" font-family="Times,serif" font-size="14">fromModel</text></g><g class="edge"><path fill="none" stroke="#000" d="M187.19-149.14h-84.61"/><path stroke="#000" d="m102.36-145.64-10-3.5 10-3.5v7z"/><text text-anchor="middle" x="139.82" y="-155.94" font-family="Times,serif" font-size="14">fromDot</text></g><g class="edge"><path fill="none" stroke="#000" d="M202.62-121.98c-10.54 17.26-24.44 40.01-35.75 58.54"/><path stroke="#000" d="m169.75-61.44-8.2 6.71 2.22-10.36 5.98 3.65z"/><text text-anchor="middle" x="202.59" y="-80.29" font-family="Times,serif" font-size="14">parse</text></g><g class="edge"><path fill="none" stroke="#000" d="M128.8-52.57c-12.81-16.06-30.42-38.14-45.48-57.03"/><path stroke="#000" d="m80.54-107.47-3.49-10 8.97 5.63-5.48 4.37z"/><text text-anchor="middle" x="138.09" y="-80.29" font-family="Times,serif" font-size="14">toModel</text></g><g class="edge"><path fill="none" stroke="#000" d="M174.74-37.96c18.87-6.8 42.31-18.78 53.85-38.53 5.88-10.07 6.19-22.25 4.18-33.7"/><path stroke="#000" d="m229.35-109.45 1.15-10.53 5.67 8.95-6.82 1.58z"/><text text-anchor="middle" x="264.09" y="-80.29" font-family="Times,serif" font-size="14">stringify</text></g></g></svg>

package/media/ts-graphviz.dot

@@ -0,0 +1,21 @@
+digraph state_machine {
+  rankdir = LR;
+  node [ shape = circle ]
+
+  // { rank = same; factory_fn; Model; DOT; }
+
+  factory_fn [
+    shape = record,
+    label = "{{Model Factory Functions | strict.digraph(...)\lstrict.graph(...)\ldigraph(...)\lgraph(...)\l}}"
+  ]
+
+  oop [
+    shape = record,
+    label = "{{Object Oriented Programing | new Digraph(...)\lnew Graph(...)\l...\l}}"
+  ]
+
+  {factory_fn, oop} -> Model;
+
+  Model -> DOT [ label = "toDot" ]
+  DOT -> Model [ label = "fromDot" ]
+}

package/media/ts-graphviz.svg

@@ -0,0 +1 @@
+<svg width="503pt" height="196pt" viewBox="0 0 502.69 195.5" xmlns="http://www.w3.org/2000/svg"><g class="graph" transform="translate(4 191.5)"><path fill="#fff" stroke="transparent" d="M-4 4v-195.5h502.69V4H-4z"/><g class="node"><path fill="none" stroke="#000" d="M13-96v-91h194v91H13z"/><text text-anchor="middle" x="110" y="-171.8" font-family="Times,serif" font-size="14">Model Factory Functions</text><path fill="none" stroke="#000" d="M13-164h194"/><text x="21" y="-148.8" font-family="Times,serif" font-size="14">strict.digraph(...)</text><text x="21" y="-133.8" font-family="Times,serif" font-size="14">strict.graph(...)</text><text x="21" y="-118.8" font-family="Times,serif" font-size="14">digraph(...)</text><text x="21" y="-103.8" font-family="Times,serif" font-size="14">graph(...)</text></g><g class="node"><circle fill="none" stroke="#000" cx="296.65" cy="-89.5" r="39.79"/><text text-anchor="middle" x="296.65" y="-85.8" font-family="Times,serif" font-size="14">Model</text></g><g class="edge"><path fill="none" stroke="#000" d="M207.11-114.43c14.38 4.05 28.64 8.06 41.38 11.65"/><path stroke="#000" d="m249.67-106.08 8.68 6.08-10.57.65 1.89-6.73z"/></g><g class="node"><path fill="none" stroke="#000" d="M0-.5v-76h220v76H0z"/><text text-anchor="middle" x="110" y="-61.3" font-family="Times,serif" font-size="14">Object Oriented Programing</text><path fill="none" stroke="#000" d="M0-53.5h220"/><text x="8" y="-38.3" font-family="Times,serif" font-size="14">new Digraph(...)</text><text x="8" y="-23.3" font-family="Times,serif" font-size="14">new Graph(...)</text><text x="8" y="-8.3" font-family="Times,serif" font-size="14">...</text></g><g class="edge"><path fill="none" stroke="#000" d="M220.01-68.61c9.87-2.73 19.48-5.38 28.35-7.83"/><path stroke="#000" d="m247.47-79.82 10.57.71-8.7 6.03-1.87-6.74z"/></g><g class="node"><circle fill="none" stroke="#000" cx="463.49" cy="-89.5" r="31.4"/><text text-anchor="middle" x="463.49" y="-85.8" font-family="Times,serif" font-size="14">DOT</text></g><g class="edge"><path fill="none" stroke="#000" d="M336.3-89.5h85.43"/><path stroke="#000" d="m422.05-93 10 3.5-10 3.5v-7z"/><text text-anchor="middle" x="384.29" y="-93.3" font-family="Times,serif" font-size="14">toDot</text></g><g class="edge"><path fill="none" stroke="#000" d="M434.99-76.62c-6.64 2.54-13.8 4.81-20.7 6.12-26.2 4.98-33.68 4.3-60 0-3.48-.57-7.04-1.32-10.59-2.2"/><path stroke="#000" d="m342.47-69.41-8.7-6.05 10.58-.69-1.88 6.74z"/><text text-anchor="middle" x="384.29" y="-74.3" font-family="Times,serif" font-size="14">fromDot</text></g></g></svg>

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "ts-graphviz",
+  "version": "0.0.0-pr956-20240225073457",
+  "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",
+    "directory": "packages/ts-graphviz"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "keywords": [
+    "graphviz",
+    "dot"
+  ],
+  "bugs": {
+    "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/ts-graphviz"
+  },
+  "files": [
+    "lib",
+    "media",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./lib/ts-graphviz.cjs",
+  "module": "./lib/ts-graphviz.js",
+  "types": "lib/ts-graphviz.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./lib/ts-graphviz.d.ts",
+        "default": "./lib/ts-graphviz.cjs"
+      },
+      "import": {
+        "types": "./lib/ts-graphviz.d.ts",
+        "default": "./lib/ts-graphviz.js"
+      }
+    },
+    "./ast": {
+      "types": "./lib/ast.d.ts",
+      "require": "./lib/ast.cjs",
+      "default": "./lib/ast.js"
+    },
+    "./adapter": {
+      "types": "./lib/adapter.d.ts",
+      "require": "./lib/adapter.cjs",
+      "default": "./lib/adapter.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "runkitExampleFilename": "example/runkit.cjs",
+  "dependencies": {
+    "@ts-graphviz/adapter": "^0.0.0-pr956-20240225073457",
+    "@ts-graphviz/ast": "^0.0.0-pr956-20240225073457",
+    "@ts-graphviz/core": "^0.0.0-pr956-20240225073457",
+    "@ts-graphviz/common": "^0.0.0-pr956-20240225073457"
+  },
+  "devDependencies": {
+    "peggy": "^3.0.2",
+    "ts-pegjs": "^4.2.1",
+    "typescript": "^5.3.3",
+    "vite": "^5.1.3",
+    "vite-plugin-dts": "^3.7.2"
+  },
+  "scripts": {
+    "build": "vite build"
+  }
+}