sfn-diagram 1.9.1 → 2.0.0

package/README.md

@@ -23,6 +23,8 @@ Generate diagrams from AWS Step Functions ASL (Amazon States Language) definitio
 npm install sfn-diagram
 ```
 
+Requires Node >= 22.12.0 on Node; the package is ES modules only, and `require()` works there. Upgrading from 1.x? See [Migrating to 2.0](https://sfn.yusufaf.dev/upgrading-to-v2/).
+
 The core package pulls in **no browser engine or native rasterizer** — SVG and Mermaid generation stay lightweight. PNG export uses `@resvg/resvg-js`, a native, browser-free renderer, provided by an optional peer dependency. Install it only if you use `sfn-diagram/png`:
 
 ```bash
@@ -119,7 +121,7 @@ from a bad definition. See
 - **Modern ASL**: Variables (`Assign`) shown per state, and Distributed Map rendered distinctly from an inline Map — including its `MaxConcurrency`, `ItemReader` source, and `ResultWriter` sink
 - **Visual Diffing**: Compare two definitions and highlight added / modified / removed states — drives the PR-preview GitHub Action
 - **Linting**: `lintAsl()` returns every structural and semantic finding at once (unreachable states, dangling transitions, `End` with `Next`, JSONPath/JSONata field mixing, …); `sfn-diagram --check` fails CI on errors
-- **Execution Overlays**: Paint a real execution's history onto the diagram — succeeded/failed/caught/not-reached states, the taken path, and per-state duration & retry counts. From a saved history file or live from an execution ARN, and `--follow` keeps re-rendering until the run finishes; with `--format html` it can be painted onto a `--diff` in the same viewer
+- **Execution Overlays**: Paint a real execution's history onto the diagram — succeeded/failed/caught/aborted/not-reached states, the taken path, and per-state duration & retry counts. From a saved history file or live from an execution ARN, and `--follow` keeps re-rendering until the run finishes; with `--format html` it can be painted onto a `--diff` in the same viewer
 - **Customizable Themes**: AWS light/dark themes, an `auto` theme that follows the system colour scheme, plus custom theme support
 - **Flexible Layouts**: Top-bottom, left-right, right-left, bottom-top
 - **Type-Safe**: Full TypeScript support with comprehensive type definitions
@@ -157,6 +159,8 @@ Full documentation lives at **[sfn.yusufaf.dev](https://sfn.yusufaf.dev)**.
 - [Examples](https://sfn.yusufaf.dev/guides/examples/) — complete worked examples
 - [Use with your framework](https://sfn.yusufaf.dev/guides/frameworks/) — Next.js, Remix, SvelteKit, Astro
 - [API reference](https://sfn.yusufaf.dev/reference/) — generated from source, always current
+- [Compatibility policy](https://sfn.yusufaf.dev/compatibility/) — what each version number promises
+- [Migrating to 2.0](https://sfn.yusufaf.dev/upgrading-to-v2/) — upgrading from 1.x, with before-and-after code for every breaking change
 
 Working with an AI coding agent? The docs are published as [llms.txt](https://sfn.yusufaf.dev/llms.txt), and every page is available as raw Markdown by appending `.md` to its URL.
 
@@ -173,7 +177,7 @@ Working with an AI coding agent? The docs are published as [llms.txt](https://sf
 
 ## Runtime support
 
-Core (`sfn-diagram`) is platform-agnostic — it runs in Node, the browser, and edge runtimes. Only `sfn-diagram/png` and the CLI are Node-only. See [runtime support](https://sfn.yusufaf.dev/guides/runtimes/).
+Core (`sfn-diagram`) is platform-agnostic — it runs in Node, the browser, and edge runtimes. Only `sfn-diagram/png` and the CLI are Node-only. On Node it needs Node >= 22.12.0. See [runtime support](https://sfn.yusufaf.dev/guides/runtimes/).
 
 ## Contributing