portograph 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Valeriy Simonov
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,234 @@
-# Temporary Holding Version
+# portograph
 
-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.
+[![CI](https://github.com/simnv/portograph/actions/workflows/ci.yml/badge.svg)](https://github.com/simnv/portograph/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/portograph)](https://www.npmjs.com/package/portograph)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+Write nodes, ports and links in YAML, and portograph draws the diagram as SVG or draw.io.
+
+Each node has its ports on its sides, and each link attaches to a port. Each node is in a group,
+and each group is on a tier, from top to bottom. A link between two facing ports is a
+straight line when nothing is in its path. Other links turn at right angles in the gaps between
+the tiers. The first target is network diagrams.
+
+<img src="docs/assets/example.png" alt="Two ISPs above a core router pair, a server flank to the right, and two access switches below that connect to both core routers" width="640">
+
+<details>
+<summary>The YAML for this diagram (<code>docs/assets/example.yaml</code>)</summary>
+
+```yaml
+portograph: 2
+groups:
+  internet: { tier: 0, label: Internet }
+  core: { tier: 1, label: Core }
+  servers: { align: right, of: core, label: Servers }
+  access: { tier: 2, label: Access }
+nodes:
+  isp-a: { group: internet, class: provider, label: ISP A, ports: [wan] }
+  isp-b: { group: internet, class: provider, label: ISP B, ports: [wan] }
+  core-1:
+    group: core
+    class: router
+    description: 192.0.2.1
+    ports: [{ name: wan, class: uplink }, te1, ge1, ge2]
+  core-2:
+    group: core
+    class: router
+    description: 192.0.2.2
+    ports: [{ name: wan, class: uplink }, te1, te2, ge1, ge2]
+  nms: { group: servers, class: Server, icon: server, label: NMS, description: 192.0.2.10, ports: [eth0] }
+  acc-1: { group: access, class: Switch, icon: switch, label: Access 1, ports: [up1, up2] }
+  acc-2: { group: access, class: Switch, icon: switch, label: Access 2, ports: [up1, up2] }
+links:
+  - [isp-a.wan, core-1.wan, { label: 1G }]
+  - [isp-b.wan, core-2.wan, { label: 1G }]
+  - [core-1.te1, core-2.te1]
+  - [core-2.te2, nms.eth0, { class: dashed }]
+  - [core-1.ge1, acc-1.up1]
+  - [core-1.ge2, acc-2.up1]
+  - [core-2.ge1, acc-1.up2]
+  - [core-2.ge2, acc-2.up2]
+```
+
+</details>
+
+## Install
+
+portograph needs Node.js 22 or newer.
+
+```sh
+npm i -g portograph
+```
+
+To run it once without an install, use `npx portograph`.
+
+## Quick start
+
+Save the YAML above as `site.yaml`, then run:
+
+```sh
+portograph render site.yaml --output site.svg
+```
+
+This command writes three files: `site.svg`, `site.layout.json` and `site.score.json`. Open the
+SVG in a browser. The layout JSON holds every position and path, and the score JSON holds the
+quality checks.
+
+For draw.io, set the format:
+
+```sh
+portograph render site.yaml --format drawio --output site.drawio
+```
+
+## CLI
+
+```text
+portograph <verb> [options] <file>
+```
+
+| Verb | Input | Output |
+|---|---|---|
+| `render` | YAML or layout JSON | SVG or draw.io, plus the layout JSON and the score JSON |
+| `layout` | YAML | layout JSON |
+| `score` | layout JSON | the gate results and the score, as JSON |
+| `migrate` | YAML in the older d3-fd `diagram:` format | YAML in the current format (v2) |
+
+Each command takes exactly one file. A file name of `-` reads stdin. Options can come before or
+after the file.
+
+| Option | Verbs | What it does |
+|---|---|---|
+| `--output <path>` | all | Writes the main output to this path. Without it, the main output goes to stdout. |
+| `--diagnostics text\|json` | all | Sets the format of the messages on stderr. `json` writes one JSON object per line. |
+| `--format svg\|drawio` | `render` | Sets the format of the main output. The default is `svg`. |
+| `--layers routed,overlay` | `render` | Draws only these link families. |
+| `--theme auto\|light\|dark\|print` | `render` | Sets the draw.io palette. The default `auto` puts light and dark in one file. |
+| `--labels on-run\|measured` | `render` | Sets where draw.io puts link labels: on the link (default) or in the box that the layout calculated. |
+| `--icons cisco19\|profile` | `render` | Sets the draw.io glyphs: the Cisco shapes of draw.io (default), or an image embedded in the file. |
+| `--timings` | `layout`, `render`, `score` | Keeps the stage timings in the JSON. Without it, two runs on one input write the same bytes. |
+| `--allow-gate-failures` | `render`, `score` | Reports a failed gate, but exits with 0. |
+| `--force` | all | Lays out a document with more than 1,000 nodes. |
+| `-h`, `--help` | | Shows the help. |
+| `-V`, `--version` | | Shows the version. |
+
+More examples:
+
+```sh
+cat site.yaml | portograph layout - > site.layout.json
+portograph score site.layout.json
+portograph render site.layout.json --layers routed --output routed.svg
+portograph layout site.yaml --diagnostics json 2> diagnostics.jsonl
+```
+
+Each diagnostic gives the file, line and column of the YAML that it is about:
+
+```text
+portograph: error: UNKNOWN_KEY at site.yaml:7:5 ($.nodes.a.colour): Unknown key colour
+```
+
+Exit codes:
+
+| Code | Meaning |
+|---|---|
+| 0 | The command succeeded. |
+| 1 | A hard gate failed. The command still writes all its files. |
+| 2 | An input error: usage, a file it cannot read, invalid YAML or JSON, or the node limit. |
+| 3 | A processing failure: the 120-second command deadline, a missing worker file, or an internal error. |
+
+Set `PORTOGRAPH_PROGRESS=1` to see the stage timings on stderr.
+
+## Library
+
+The package is ESM and CommonJS. It has types.
+
+```js
+import { parseWithDiagnostics, layout, score, render } from 'portograph';
+import { createNodeElkFactory, createNodeRouteFactory } from 'portograph/node';
+
+const parsed = parseWithDiagnostics(yaml);
+if (!parsed.ok) throw new Error(JSON.stringify(parsed.diagnostics));
+const model = await layout(parsed.document, {
+  diagnostics: parsed.diagnostics,
+  createElkAttempt: createNodeElkFactory(),
+  createRouteAttempt: createNodeRouteFactory(),
+});
+const report = score(model);
+const svg = render(model);
+```
+
+The package root exports these functions:
+
+| Export | What it does |
+|---|---|
+| `parse(text)` | Parses YAML into a document. It throws `ParseError` on an error. |
+| `parseWithDiagnostics(text)` | Parses YAML and returns `{ ok, document, diagnostics }`. It does not throw. |
+| `layout(document, options)` | Lays out a document and returns the layout model. |
+| `score(model)` | Returns the gate results and the score. |
+| `render(model, options)` | Returns the SVG text. |
+| `drawio(model, options)` | Returns the draw.io document. |
+| `serializeLayoutModel(model)`, `restoreFinalLayout(json)` | Write and read the layout JSON. |
+| `migrate(text)`, `migrateWithDiagnostics(text)` | Convert d3-fd YAML to the current format. |
+| `createBudget(ms)` | Makes one time budget that all the solver calls of a layout share. |
+| `createBrowserElkFactory()`, `createBrowserRouteFactory()` | Make the solver workers in a browser. |
+
+The root also exports the error classes `ParseError`, `ResolveError`, `CommandDeadlineError`,
+`ElkDeadlineError` and `RouteDeadlineError`, and the types. `portograph/node` exports
+`createNodeElkFactory` and `createNodeRouteFactory`, which make the solver workers in Node.js.
+
+`portograph/internal` exports the stage functions and the tables. It can change in any release.
+
+In a browser, the page must serve four files over HTTP. Put `elkjs/lib/elk-worker.min.js` and
+`portograph/dist/portograph-avoid-worker.mjs` beside the page. In the directory of that worker, serve
+`libavoid-js/dist/index.js` as `libavoid.mjs`, and `libavoid-js/dist/libavoid.wasm` as it is. To use other locations, give the URLs to
+`createBrowserElkFactory(url)` and `createBrowserRouteFactory({ workerUrl, moduleUrl, wasmUrl })`.
+A bundler resolves the `elkjs/lib/elk-api.js` import of the ES build. Without a bundler, load
+`elkjs/lib/elk-api.js` with a script tag before the UMD build `portograph/internal`
+(`dist/portograph.umd.cjs`).
+
+The library does not read the system fonts, so its output depends on the document only. The
+`FONT_MISSING` check below is in the CLI only.
+
+## The YAML format
+
+[`docs/design/schema.md`](docs/design/schema.md) gives every key. The words that it uses, for
+example tier, flank and bundle, are defined in [`GLOSSARY.md`](GLOSSARY.md) and
+[`CONTEXT.md`](CONTEXT.md).
+
+## Font: install Verdana
+
+portograph measures all text with the glyph widths of Verdana, and the SVG and the draw.io file
+ask for Verdana. The font list in the output is `Verdana, DejaVu Sans, sans-serif`. If a viewer
+does not have Verdana, it uses a fallback font. That font has different widths, so the text can
+be too wide for its box.
+
+Verdana comes with macOS and Windows. On Linux, install the `ttf-mscorefonts-installer` package,
+or copy the font files into `~/.local/share/fonts`. `portograph render` and `portograph layout`
+write the warning `FONT_MISSING` when they do not find Verdana.
+
+## How it works
+
+The pipeline has one main rule. If placement can reserve a route, a size or a spacing, it does so
+before the router starts. Placement sizes the lanes, the bars, the bundles and the gaps between
+the tiers, so routing never moves a node to make room. The router draws only the links that the
+region rules do not draw.
+
+[ELK](https://github.com/kieler/elkjs) places the skeleton, and
+[libavoid](https://github.com/Aksem/libavoid-js) routes the remaining links. The stages, in order,
+are in [`docs/design/pipeline.md`](docs/design/pipeline.md). The gates and the score are in
+[`docs/design/quality.md`](docs/design/quality.md), and the decisions are in
+[`docs/adr/`](docs/adr/).
+
+## Showcase
+
+The NTP example sheet from drawthe.net, drawn by portograph:
+
+![The NTP example sheet from drawthe.net, drawn by portograph](docs/assets/ntp.png)
+
+## Contributing
+
+Read [`CONTRIBUTING.md`](CONTRIBUTING.md) before you open a pull request. To report a security
+problem, read [`SECURITY.md`](SECURITY.md).
+
+## License
+
+Apache-2.0. See [`LICENSE`](LICENSE).