@p10node/graphviz 0.0.0-stage → 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 p10node
+
+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

@@ -1,3 +1,50 @@
-# Temporary Holding Version
+# @p10node/graphviz
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Graphviz DOT text → SVG. No DOM needed (browser, Web Worker, Node, Bun), no server, no dependency.
+
+Part of [office-engine](https://github.com/p10node/office-engine). All languages in one package, and drawing the diagram blocks of a page: [`@p10node/diagram`](../diagram).
+
+## Install
+
+```sh
+npm i @p10node/graphviz
+```
+
+## Use
+
+```ts
+import { render, renderEach, renderTo, toPng } from '@p10node/graphviz'
+
+const { svg, width, height } = render('digraph { rankdir=LR; a -> b -> c }')
+const all = renderEach(text)                       // one per graph in the file
+renderTo(document.getElementById('out')!, text)    // into an element (browser)
+const png = await toPng(svg, 2)                    // PNG Blob, 2× size (browser)
+```
+
+`render` returns `{ svg, width, height }` (CSS pixels); a source that cannot be drawn throws a `DiagramError` with the reason.
+
+From a CDN, no build step:
+
+```html
+<div id="out"></div>
+<script type="module">
+  import { renderTo } from 'https://cdn.jsdelivr.net/npm/@p10node/graphviz/dist/index.js'
+  renderTo(document.getElementById('out'), 'digraph { rankdir=LR; a -> b -> c }')
+</script>
+```
+
+## What is drawn
+
+graph / digraph / strict, subgraphs and `cluster_*` boxes, `node` / `edge` / `graph` defaults, edge chains and `{a b} -> c`, `rank=same`, shapes (box, ellipse, circle, diamond, record, cylinder, note…), styles (filled, dashed, dotted, bold, rounded, invis), colors (names, `#rgb`, HSV, X11 grays), arrowheads, `dir`, labels (`\n` `\l`, record fields, HTML labels as text).
+
+Laid out by a built-in layered layout, so drawings look close to, not exactly like, the original tool's. Not drawn yet: layout engines other than `dot` (`neato`, `circo`, `fdp`… are laid out as `dot`), ports (edges meet the node), HTML table layouts (their text is shown).
+
+The SVG has a fixed `width` / `height`; to fit a column: `svg { max-width: 100%; height: auto; }`.
+
+## Safety
+
+Text from the source is escaped; only plain colors are kept; the SVG has no scripts, links, `<foreignObject>` or external references.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+/** A drawing: a self-contained SVG document and its size in CSS pixels. */
+export interface Diagram {
+    svg: string;
+    width: number;
+    height: number;
+}
+/** The source cannot be drawn (unsupported diagram kind, syntax the reader does not follow). */
+export declare class DiagramError extends Error {
+    constructor(message: string);
+}
+/** Every drawing of a source (one per graph). */
+export declare function renderEach(source: string): Diagram[];
+/** The (first) drawing of a source. */
+export declare function render(source: string): Diagram;
+/** Draws a source into an element (its content is replaced). */
+export declare function renderTo(target: Element, source: string): Diagram[];
+/** A PNG of a drawing's SVG, `scale` times its size. Browser only. */
+export declare function toPng(svg: string, scale?: number): Promise<Blob>;