sfn-diagram 1.5.0 → 1.6.0

package/README.md

@@ -27,6 +27,8 @@ The core package pulls in **no browser engine** — SVG and Mermaid generation s
 npm install sfn-diagram node-html-to-image
 ```
 
+Not a Node project? The CLI also ships as standalone binaries for Linux, macOS, and Windows on every [release](https://github.com/yusufaf/sfn-diagram/releases), or via Homebrew (`brew install yusufaf/tap/sfn-diagram`), and as a [Docker image](https://sfn.yusufaf.dev/guides/cli/#docker). See [using sfn-diagram from other languages](https://sfn.yusufaf.dev/guides/other-languages/).
+
 ## Quick start
 
 ```ts
@@ -50,7 +52,7 @@ Mermaid instead of SVG? Swap in `generateMermaid`. Rendering a live state machin
 Prefer the command line:
 
 ```bash
-npx sfn-diagram diagram my-workflow.asl.json --format svg --out diagram.svg
+npx sfn-diagram my-workflow.asl.json --format svg -o diagram.svg
 ```
 
 ## Why sfn-diagram
@@ -61,7 +63,7 @@ There's no shortage of ways to look at a state machine — this is where sfn-dia
 |---|---|---|---|
 | Input | ASL, CloudFormation/SAM/CDK templates, live AWS state machines | Deployed state machine only | Manual Mermaid you write by hand |
 | Output | SVG, Mermaid, PNG, interactive HTML | Static graph in-browser | Mermaid diagram only |
-| CI / PR integration | [GitHub Action](https://sfn.yusufaf.dev/ecosystem/github-action/) posts a diff overlay on every PR that touches ASL | None | None |
+| CI / PR integration | [GitHub Action](https://sfn.yusufaf.dev/ecosystem/github-action/) or [GitLab CI](https://sfn.yusufaf.dev/ecosystem/gitlab/) posts a diff overlay on every PR/MR that touches ASL | None | None |
 | Execution overlays | Paints a real run's path/status/duration onto the diagram | Basic per-execution highlighting, console-only | Not applicable |
 | Runs where | CLI, Node, browser, edge runtimes | AWS Console only | Web app only |
 | Automation | Full programmatic API (`generateSvg`, `generateMermaid`, etc.) | None — UI only | None — UI only |
@@ -124,6 +126,7 @@ Working with an AI coding agent? The docs are published as [llms.txt](https://sf
 | **[`<sfn-diagram>` web component](https://sfn.yusufaf.dev/ecosystem/web-component/)** | Framework-agnostic custom element — Vue, Svelte, Solid, Angular, Astro, Hono, vanilla HTML |
 | **[React component](https://sfn.yusufaf.dev/ecosystem/react/)** | `sfn-diagram-react` — render diagrams in any React renderer |
 | **[GitHub Action](https://sfn.yusufaf.dev/ecosystem/github-action/)** | Comment a diagram and diff on every PR that touches an ASL file |
+| **[GitLab CI](https://sfn.yusufaf.dev/ecosystem/gitlab/)** | Same, via `sfn-diagram comment gitlab` from a plain CI job — no marketplace listing needed |
 
 ## Runtime support
 

package/custom-elements.json

@@ -8,7 +8,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "`<sfn-diagram>` — a framework-agnostic custom element rendering an AWS Step\nFunctions ASL definition as an SVG or Mermaid diagram, with an optional\ninteractive viewer (pan/zoom, search, minimap, click-a-state detail panel).\n\nRenders in light DOM (no shadow root), so page CSS reaches the SVG and the\nelement degrades to plain server-rendered markup: give it a pre-rendered\n`<svg>` child (from `generateSvg()` run at build/server time) and omit\n`definition` entirely for a zero-client-JS diagram; setting `interactive`\non top still upgrades that markup with pan/zoom/search.\n\nRegister it with defineSfnDiagram (imported from `sfn-diagram/element`),\nor import `sfn-diagram/element/auto` for its zero-config `<sfn-diagram>` side effect.",
+          "description": "`<sfn-diagram>` — a framework-agnostic custom element rendering an AWS Step\nFunctions ASL definition as an SVG or Mermaid diagram, with an optional\ninteractive viewer (pan/zoom, search, minimap, and a detail panel for a clicked\nstate or edge).\n\nRenders in light DOM (no shadow root), so page CSS reaches the SVG and the\nelement degrades to plain server-rendered markup: give it a pre-rendered\n`<svg>` child (from `generateSvg()` run at build/server time) and omit\n`definition` entirely for a zero-client-JS diagram; setting `interactive`\non top still upgrades that markup with pan/zoom/search.\n\nRegister it with defineSfnDiagram (imported from `sfn-diagram/element`),\nor import `sfn-diagram/element/auto` for its zero-config `<sfn-diagram>` side effect.",
           "name": "SfnDiagramElement",
           "members": [
             {
@@ -105,7 +105,7 @@
               "type": {
                 "text": "boolean"
               },
-              "description": "Enables pan/zoom, state search, the minimap, and the click-a-state detail panel."
+              "description": "Enables pan/zoom, state search, the minimap, and the detail panel for a clicked\nstate or edge."
             },
             {
               "kind": "method",

package/dist/aws.cjs

@@ -1,4 +1,4 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("./ci.cjs");
 let _aws_sdk_client_sfn = require("@aws-sdk/client-sfn");
 //#region src/aws.ts
 /**

package/dist/cfn.d.cts

@@ -34,6 +34,22 @@ interface ProcessorConfig {
   Mode?: "DISTRIBUTED" | "INLINE";
 }
 /**
+* A Distributed Map's `ItemBatcher`, which groups items so each child execution
+* receives an array rather than a single item. Either limit may be set; the first
+* one reached closes the batch.
+*/
+interface ItemBatcher {
+  BatchInput?: Record<string, any>;
+  /** Maximum payload bytes handed to one child execution. */
+  MaxInputBytesPerBatch?: number;
+  /** Reference path resolving to `MaxInputBytesPerBatch`. */
+  MaxInputBytesPerBatchPath?: string;
+  /** Maximum items handed to one child execution. */
+  MaxItemsPerBatch?: number;
+  /** Reference path resolving to `MaxItemsPerBatch`. */
+  MaxItemsPerBatchPath?: string;
+}
+/**
 * A Distributed Map `ItemReader` (dataset source) or `ResultWriter` (result sink).
 * Both point at an AWS resource — typically S3, or Athena for `ItemReader` — via
 * the same `Resource` ARN shape used by Task states.
@@ -59,7 +75,7 @@ interface AslState {
   Default?: string;
   End?: boolean;
   Error?: string;
-  ItemBatcher?: Record<string, any>;
+  ItemBatcher?: ItemBatcher;
   ItemProcessor?: AslDefinition;
   ItemReader?: ItemIo;
   ItemSelector?: Record<string, any>;
@@ -79,8 +95,8 @@ interface AslState {
   SecondsPath?: string;
   Timestamp?: string;
   TimestampPath?: string;
-  ToleratedFailureCount?: number;
-  ToleratedFailurePercentage?: number;
+  ToleratedFailureCount?: number | string;
+  ToleratedFailurePercentage?: number | string;
   Type: StateType;
 }
 /** A complete Amazon States Language state machine definition. */

package/dist/cfn.d.ts

@@ -34,6 +34,22 @@ interface ProcessorConfig {
   Mode?: "DISTRIBUTED" | "INLINE";
 }
 /**
+* A Distributed Map's `ItemBatcher`, which groups items so each child execution
+* receives an array rather than a single item. Either limit may be set; the first
+* one reached closes the batch.
+*/
+interface ItemBatcher {
+  BatchInput?: Record<string, any>;
+  /** Maximum payload bytes handed to one child execution. */
+  MaxInputBytesPerBatch?: number;
+  /** Reference path resolving to `MaxInputBytesPerBatch`. */
+  MaxInputBytesPerBatchPath?: string;
+  /** Maximum items handed to one child execution. */
+  MaxItemsPerBatch?: number;
+  /** Reference path resolving to `MaxItemsPerBatch`. */
+  MaxItemsPerBatchPath?: string;
+}
+/**
 * A Distributed Map `ItemReader` (dataset source) or `ResultWriter` (result sink).
 * Both point at an AWS resource — typically S3, or Athena for `ItemReader` — via
 * the same `Resource` ARN shape used by Task states.
@@ -59,7 +75,7 @@ interface AslState {
   Default?: string;
   End?: boolean;
   Error?: string;
-  ItemBatcher?: Record<string, any>;
+  ItemBatcher?: ItemBatcher;
   ItemProcessor?: AslDefinition;
   ItemReader?: ItemIo;
   ItemSelector?: Record<string, any>;
@@ -79,8 +95,8 @@ interface AslState {
   SecondsPath?: string;
   Timestamp?: string;
   TimestampPath?: string;
-  ToleratedFailureCount?: number;
-  ToleratedFailurePercentage?: number;
+  ToleratedFailureCount?: number | string;
+  ToleratedFailurePercentage?: number | string;
   Type: StateType;
 }
 /** A complete Amazon States Language state machine definition. */