sfn-diagram 1.6.0 → 1.7.0

package/README.md

@@ -21,10 +21,10 @@ Generate diagrams from AWS Step Functions ASL (Amazon States Language) definitio
 npm install sfn-diagram
 ```
 
-The core package pulls in **no browser engine** — SVG and Mermaid generation stay lightweight. PNG export relies on a headless browser, provided by the optional peer dependency `node-html-to-image`. Install it only if you use `sfn-diagram/png`:
+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
-npm install sfn-diagram node-html-to-image
+npm install sfn-diagram @resvg/resvg-js
 ```
 
 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/).

package/dist/aws.cjs

@@ -1,4 +1,3 @@
-require("./ci.cjs");
 let _aws_sdk_client_sfn = require("@aws-sdk/client-sfn");
 //#region src/aws.ts
 /**

package/dist/aws.d.cts

@@ -1,7 +1,6 @@
 import { HistoryEvent, SFNClient } from "@aws-sdk/client-sfn";
-
 //#region src/aws.d.ts
-interface FetchExecutionHistoryParams {
+export interface FetchExecutionHistoryParams {
   /** A caller-constructed SFN client (with the caller's credentials/region). */
   client: SFNClient;
   /** ARN of the execution whose history should be fetched. */
@@ -10,27 +9,26 @@ interface FetchExecutionHistoryParams {
   maxResults?: number;
 }
 /**
-* Fetches the complete history of a Step Functions execution, paginating through
-* every `GetExecutionHistory` page so callers don't have to hand-roll the
-* `nextToken` loop.
-*
-* The returned `HistoryEvent[]` can be passed straight to `parseExecutionHistory`,
-* `generateExecution`, or `generateMermaidExecution` from `sfn-diagram`.
-*
-* @param params - The SFN client, execution ARN, and optional page size.
-* @returns All history events for the execution, in chronological order.
-*
-* @example
-* ```ts
-* import { SFNClient } from '@aws-sdk/client-sfn';
-* import { fetchExecutionHistory } from 'sfn-diagram/aws';
-* import { generateExecution } from 'sfn-diagram';
-*
-* const client = new SFNClient({ region: 'us-east-1' });
-* const events = await fetchExecutionHistory({ client, executionArn });
-* const { svg } = generateExecution({ aslDefinition: asl, history: events });
-* ```
-*/
-declare function fetchExecutionHistory(params: FetchExecutionHistoryParams): Promise<HistoryEvent[]>;
-//#endregion
-export { FetchExecutionHistoryParams, fetchExecutionHistory };
+ * Fetches the complete history of a Step Functions execution, paginating through
+ * every `GetExecutionHistory` page so callers don't have to hand-roll the
+ * `nextToken` loop.
+ *
+ * The returned `HistoryEvent[]` can be passed straight to `parseExecutionHistory`,
+ * `generateExecution`, or `generateMermaidExecution` from `sfn-diagram`.
+ *
+ * @param params - The SFN client, execution ARN, and optional page size.
+ * @returns All history events for the execution, in chronological order.
+ *
+ * @example
+ * ```ts
+ * import { SFNClient } from '@aws-sdk/client-sfn';
+ * import { fetchExecutionHistory } from 'sfn-diagram/aws';
+ * import { generateExecution } from 'sfn-diagram';
+ *
+ * const client = new SFNClient({ region: 'us-east-1' });
+ * const events = await fetchExecutionHistory({ client, executionArn });
+ * const { svg } = generateExecution({ aslDefinition: asl, history: events });
+ * ```
+ */
+export declare function fetchExecutionHistory(params: FetchExecutionHistoryParams): Promise<HistoryEvent[]>;
+//#endregion

package/dist/aws.d.ts

@@ -1,7 +1,6 @@
 import { HistoryEvent, SFNClient } from "@aws-sdk/client-sfn";
-
 //#region src/aws.d.ts
-interface FetchExecutionHistoryParams {
+export interface FetchExecutionHistoryParams {
   /** A caller-constructed SFN client (with the caller's credentials/region). */
   client: SFNClient;
   /** ARN of the execution whose history should be fetched. */
@@ -10,27 +9,26 @@ interface FetchExecutionHistoryParams {
   maxResults?: number;
 }
 /**
-* Fetches the complete history of a Step Functions execution, paginating through
-* every `GetExecutionHistory` page so callers don't have to hand-roll the
-* `nextToken` loop.
-*
-* The returned `HistoryEvent[]` can be passed straight to `parseExecutionHistory`,
-* `generateExecution`, or `generateMermaidExecution` from `sfn-diagram`.
-*
-* @param params - The SFN client, execution ARN, and optional page size.
-* @returns All history events for the execution, in chronological order.
-*
-* @example
-* ```ts
-* import { SFNClient } from '@aws-sdk/client-sfn';
-* import { fetchExecutionHistory } from 'sfn-diagram/aws';
-* import { generateExecution } from 'sfn-diagram';
-*
-* const client = new SFNClient({ region: 'us-east-1' });
-* const events = await fetchExecutionHistory({ client, executionArn });
-* const { svg } = generateExecution({ aslDefinition: asl, history: events });
-* ```
-*/
-declare function fetchExecutionHistory(params: FetchExecutionHistoryParams): Promise<HistoryEvent[]>;
-//#endregion
-export { FetchExecutionHistoryParams, fetchExecutionHistory };
+ * Fetches the complete history of a Step Functions execution, paginating through
+ * every `GetExecutionHistory` page so callers don't have to hand-roll the
+ * `nextToken` loop.
+ *
+ * The returned `HistoryEvent[]` can be passed straight to `parseExecutionHistory`,
+ * `generateExecution`, or `generateMermaidExecution` from `sfn-diagram`.
+ *
+ * @param params - The SFN client, execution ARN, and optional page size.
+ * @returns All history events for the execution, in chronological order.
+ *
+ * @example
+ * ```ts
+ * import { SFNClient } from '@aws-sdk/client-sfn';
+ * import { fetchExecutionHistory } from 'sfn-diagram/aws';
+ * import { generateExecution } from 'sfn-diagram';
+ *
+ * const client = new SFNClient({ region: 'us-east-1' });
+ * const events = await fetchExecutionHistory({ client, executionArn });
+ * const { svg } = generateExecution({ aslDefinition: asl, history: events });
+ * ```
+ */
+export declare function fetchExecutionHistory(params: FetchExecutionHistoryParams): Promise<HistoryEvent[]>;
+//#endregion