aws-local-stepfunctions 0.4.0 → 0.6.0

package/README.md

@@ -2,11 +2,9 @@
 
 A TypeScript implementation of the [Amazon States Language specification](https://states-language.net/spec.html).
 
-This package lets you run AWS Step Functions locally on your machine!
+This package lets you run AWS Step Functions completely locally, both in Node.js and in the browser!
 
-> NOTE: This is a work in progress. Some features defined in the specification might not be supported at all yet or might have limited support.
-
-## Table of Contents
+## Table of contents
 
 - [Features](#features)
 - [Installation](#installation)
@@ -14,15 +12,16 @@ This package lets you run AWS Step Functions locally on your machine!
   - [Node.js](#nodejs)
     - [CommonJS](#commonjs)
     - [ES Module](#es-module)
+  - [Browser](#browser)
 - [API](#api)
-  - [Constructor](#constructor-new-statemachinedefinition-validationoptions)
+  - [Constructor](#constructor-new-statemachinedefinition-statemachineoptions)
   - [StateMachine.run](#statemachineruninput-options)
 - [Examples](#examples)
 - [License](#license)
 
 ## Features
 
-To see a list of features that have full support, partial support, or no support, refer to [this document](/docs/feature-support.md).
+To see the list of features defined in the specification that have full support, partial support, or no support, refer to [this document](/docs/feature-support.md).
 
 ## Installation
 
@@ -32,8 +31,6 @@ npm install aws-local-stepfunctions
 
 ## Importing
 
-Currently, the only supported environment to import the package is Node.js. Browser support is not available yet.
-
 ### Node.js
 
 #### CommonJS
@@ -48,20 +45,44 @@ const { StateMachine } = require('aws-local-stepfunctions');
 import { StateMachine } from 'aws-local-stepfunctions';
 ```
 
+### Browser
+
+You can import the bundled package directly into a browser script as an ES module, from one of the following CDNs:
+
+> NOTE: The following examples will import the latest package version. Refer to the CDNs websites to know about other ways in which you can specify the package URL (for example, to import a specific version).
+
+#### [unpkg](https://unpkg.com/)
+
+```js
+import { StateMachine } from 'https://unpkg.com/aws-local-stepfunctions';
+```
+
+#### [jsDelivr](https://www.jsdelivr.com/)
+
+```js
+import { StateMachine } from 'https://cdn.jsdelivr.net/npm/aws-local-stepfunctions/build/main.browser.esm.js';
+```
+
 ## API
 
-### Constructor: `new StateMachine(definition[, validationOptions])`
+### Constructor: `new StateMachine(definition[, stateMachineOptions])`
 
 #### Parameters
 
 The constructor takes the following parameters:
 
 - `definition`: The Amazon States Language definition of the state machine.
-- `validationOptions` (optional): An object that specifies how the definition should be validated.
-  - `checkPaths`: If set to `false`, won't validate JSONPaths.
-  - `checkArn`: If set to `false`, won't validate ARN syntax in `Task` states.
-
-The constructor will attempt to validate the definition by default, unless the `validationOptions` param is specified. If the definition is not valid, an error will be thrown.
+- `stateMachineOptions?`:
+  - `validationOptions?`: An object that specifies how the definition should be validated.
+    - `checkPaths`: If set to `false`, won't validate JSONPaths.
+    - `checkArn`: If set to `false`, won't validate ARN syntax in `Task` states.
+  - `awsConfig?`: An object that specifies the [AWS region and credentials](/docs/feature-support.md#providing-aws-credentials-and-region-to-execute-lambda-functions-specified-in-task-states) to use when invoking a Lambda function in a `Task` state. If not set, the AWS config will be resolved based on the [credentials provider chain](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html) of the AWS SDK for JavaScript V3. You don't need to use this option if you have a [shared config/credentials file](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) (for example, if you have the [AWS CLI](https://aws.amazon.com/cli/) installed) or if you use a local override for all of your `Task` states.
+    - `region`: The AWS region where the Lambda functions are created.
+    - `credentials`: An object that specifies which type of credentials to use.
+      - `cognitoIdentityPool`: An object that specifies the Cognito Identity Pool ID to use for requesting credentials.
+      - `accessKeys`: An object that specifies the Access Key ID and Secret Access Key to use as credentials.
+
+The constructor will attempt to validate the definition by default, unless the `validationOptions` property is specified. If the definition is not valid, an error will be thrown.
 
 #### Example
 
@@ -81,14 +102,16 @@ const machineDefinition = {
 };
 
 // Instantiate a new state machine with the given definition and don't validate JSONPaths.
-const stateMachine = new StateMachine(machineDefinition, { checkPaths: false });
+const stateMachine = new StateMachine(machineDefinition, {
+  validationOptions: { checkPaths: false },
+});
 ```
 
 ### `StateMachine.run(input[, options])`
 
 Runs the state machine with the given `input` parameter and returns an object with the following properties:
 
-- `abort`: A function that takes no parameters and doesn't return any value. If called, aborts the execution and throws an `ExecutionAbortedError`, unless the `noThrowOnAbort` option is set.
+- `abort`: A function that takes no parameters and doesn't return any value. If called, [aborts the execution](/docs/feature-support.md#abort-a-running-execution) and throws an `ExecutionAbortedError`, unless the `noThrowOnAbort` option is set.
 - `result`: A `Promise` that resolves with the execution result once it finishes.
 
 Each execution is independent of all others, meaning that you can concurrently call this method as many times as needed, without worrying about race conditions.
@@ -96,11 +119,11 @@ Each execution is independent of all others, meaning that you can concurrently c
 #### Parameters
 
 - `input`: The initial input to pass to the state machine. This can be any valid JSON value.
-- `options` (optional):
-  - `overrides`: An object to override the behavior of certain states:
-    - `taskResourceLocalHandlers`: Overrides the resource of the specified `Task` states to run a local function.
-    - `waitTimeOverrides`: Overrides the wait duration of the specified `Wait` states. The specifed override duration should be in milliseconds.
-  - `noThrowOnAbort`: If this option is set to `true`, aborting the execution will simply return `null` as result instead of throwing.
+- `options?`:
+  - `overrides?`: An object to override the behavior of certain states:
+    - `taskResourceLocalHandlers?`: An [object that overrides](/docs/feature-support.md#task-state-resource-override) the resource of the specified `Task` states to run a local function.
+    - `waitTimeOverrides?`: An [object that overrides](/docs/feature-support.md#wait-state-duration-override) the wait duration of the specified `Wait` states. The specifed override duration should be in milliseconds.
+  - `noThrowOnAbort?`: If this option is set to `true`, aborting the execution will simply return `null` as result instead of throwing.
 
 #### Basic example: