Merge pull request #61 from nibble-4bits/chore/prepare-for-v1-release

Chore/prepare for v1 release

Author: nibble-4bits

.github/workflows/prepare-for-release.yml

@@ -0,0 +1,29 @@
+name: prepare-for-release
+
+on:
+  push:
+    branches:
+      - 'master'
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  test-build-prepare-for-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm test
+      - name: Build project
+        run: npm run build
+      - name: Create tag from package.json
+        uses: jaywcjlove/create-tag-action@v1.3.18
+        with:
+          token: ${{ github.token }}
+          package-path: ./package.json

.github/workflows/publish-package.yml

@@ -1,9 +1,9 @@
 name: publish-package
 
 on:
-  push:
-    branches:
-      - 'master'
+  release:
+    types:
+      - published
 
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 

README.md

@@ -2,7 +2,25 @@
 
 A TypeScript implementation of the [Amazon States Language specification](https://states-language.net/spec.html).
 
-This package lets you run AWS Step Functions completely locally, both in Node.js and in the browser!
+This package lets you run AWS Step Functions state machines completely locally, both in Node.js and in the browser!
+
+<p align="left">
+  <a href="/LICENSE">
+    <img alt="Project license (MIT)" src="https://img.shields.io/github/license/nibble-4bits/aws-local-stepfunctions">
+  </a>
+  <a href="https://github.com/nibble-4bits/aws-local-stepfunctions/actions/workflows/pr-run-tests.yml">
+    <img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/nibble-4bits/aws-local-stepfunctions/pr-run-tests.yml">
+  </a>
+  <a href="https://www.npmjs.com/package/aws-local-stepfunctions">
+    <img alt="Latest npm version" src="https://img.shields.io/npm/v/aws-local-stepfunctions">
+  </a>
+  <a href="https://www.npmjs.com/package/aws-local-stepfunctions">
+    <img alt="node-lts" src="https://img.shields.io/node/v-lts/aws-local-stepfunctions">
+  </a>
+  <a href="https://www.npmjs.com/package/aws-local-stepfunctions">
+    <img alt="npm type definitions" src="https://img.shields.io/npm/types/aws-local-stepfunctions">
+  </a>
+</p>
 
 ## Table of contents
 

__tests__/StateMachine.test.ts

@@ -2,7 +2,7 @@ import type { StateMachineDefinition } from '../src/typings/StateMachineDefiniti
 import type { EventLog } from '../src/typings/EventLogs';
 import { StateMachine } from '../src/stateMachine/StateMachine';
 import { ExecutionAbortedError } from '../src/error/ExecutionAbortedError';
-import { StatesTimeoutError } from '../src/error/predefined/StatesTimeoutError';
+import { ExecutionTimeoutError } from '../src/error/ExecutionTimeoutError';
 import { ExecutionError } from '../src/error/ExecutionError';
 
 afterEach(() => {
@@ -125,7 +125,7 @@ describe('State Machine', () => {
       await expect(execution.result).resolves.toBe(null);
     });
 
-    test('should throw an `States.Timeout` error if execution times out', async () => {
+    test('should throw an `ExecutionTimeoutError` error if execution times out', async () => {
       const machineDefinition: StateMachineDefinition = {
         StartAt: 'WaitState',
         TimeoutSeconds: 1,
@@ -142,7 +142,7 @@ describe('State Machine', () => {
       const stateMachine = new StateMachine(machineDefinition);
       const execution = stateMachine.run(input);
 
-      await expect(execution.result).rejects.toThrow(StatesTimeoutError);
+      await expect(execution.result).rejects.toThrow(ExecutionTimeoutError);
     });
 
     test('should throw an `ExecutionError` if execution fails', async () => {
@@ -366,7 +366,7 @@ describe('State Machine', () => {
         events.push(event);
       }
 
-      await expect(execution.result).rejects.toThrow(StatesTimeoutError);
+      await expect(execution.result).rejects.toThrow(ExecutionTimeoutError);
       expect(events).toEqual([
         { type: 'ExecutionStarted', timestamp: 1670198400000, input: {} },
         { type: 'StateEntered', timestamp: 1670198400000, state: { name: 'PassState1', type: 'Pass', input: {} } },

examples/abort-execution.js

@@ -37,7 +37,7 @@ setTimeout(() => {
 
 try {
   const result = await execution.result;
-  console.log(result); // If not aborted, would log 12 once execution finished
+  console.log(result); // If not aborted, would log 12 once execution finishes
 } catch (e) {
   if (e instanceof ExecutionAbortedError) {
     // Since execution was aborted, type of error is `ExecutionAbortedError`

package.json

@@ -1,7 +1,7 @@
 {
   "name": "aws-local-stepfunctions",
   "version": "0.7.0",
-  "description": "Execute an AWS Step Function locally",
+  "description": "Execute an AWS Step Function state machine locally",
   "keywords": [
     "aws",
     "local",
@@ -35,6 +35,9 @@
     "browser": "./build/main.browser.esm.js",
     "default": "./build/main.browser.esm.js"
   },
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "bin": {
     "local-sfn": "./build/CLI.cjs"
   },

src/error/ExecutionTimeoutError.ts

@@ -0,0 +1,10 @@
+/**
+ * Represents the timeout of a state machine execution.
+ */
+export class ExecutionTimeoutError extends Error {
+  constructor() {
+    super('Execution timed out');
+
+    this.name = 'ExecutionTimeoutError';
+  }
+}

src/error/RuntimeError.ts

@@ -1,7 +1,7 @@
 /**
  * Base class for all internal errors that can be thrown during the state machine execution.
  */
-export class RuntimeError extends Error {
+export abstract class RuntimeError extends Error {
   /**
    * Whether this runtime error can be matched in a `Retry` field
    */

src/main.ts

@@ -1,4 +1,4 @@
 export { StateMachine } from './stateMachine/StateMachine';
 export { ExecutionError } from './error/ExecutionError';
 export { ExecutionAbortedError } from './error/ExecutionAbortedError';
-export { StatesTimeoutError as ExecutionTimeoutError } from './error/predefined/StatesTimeoutError';
+export { ExecutionTimeoutError } from './error/ExecutionTimeoutError';

src/stateMachine/StateExecutor.ts

@@ -1,5 +1,5 @@
 import type { AllStates } from '../typings/AllStates';
-import type { ExecutionResult } from '../typings/StateActions';
+import type { ActionResult } from '../typings/StateActions';
 import type { RetryResult, CatchResult, StateHandlers } from '../typings/StateExecutor';
 import type { ExecuteOptions } from '../typings/StateMachineImplementation';
 import type { ErrorOutput } from '../typings/ErrorHandling';
@@ -105,7 +105,7 @@ export class StateExecutor {
   /**
    * Execute the current state.
    */
-  async execute(input: JSONValue, context: Context, options: ExecuteOptions): Promise<ExecutionResult> {
+  async execute(input: JSONValue, context: Context, options: ExecuteOptions): Promise<ActionResult> {
     const rawInput = cloneDeep(input);
 
     try {
@@ -274,7 +274,7 @@ export class StateExecutor {
     context: Context,
     stateName: string,
     options: ExecuteOptions
-  ): Promise<ExecutionResult> {
+  ): Promise<ActionResult> {
     const overrideFn = options.runOptions?.overrides?.taskResourceLocalHandlers?.[stateName];
     const awsConfig = options.stateMachineOptions?.awsConfig;
 
@@ -297,7 +297,7 @@ export class StateExecutor {
     context: Context,
     stateName: string,
     options: ExecuteOptions
-  ): Promise<ExecutionResult> {
+  ): Promise<ActionResult> {
     const parallelStateAction = new ParallelStateAction(stateDefinition, stateName);
     const executionResult = await parallelStateAction.execute(input, context, {
       stateMachineOptions: options.stateMachineOptions,
@@ -323,7 +323,7 @@ export class StateExecutor {
     context: Context,
     stateName: string,
     options: ExecuteOptions
-  ): Promise<ExecutionResult> {
+  ): Promise<ActionResult> {
     const mapStateAction = new MapStateAction(stateDefinition, stateName);
     const executionResult = await mapStateAction.execute(input, context, {
       stateMachineOptions: options.stateMachineOptions,
@@ -350,7 +350,7 @@ export class StateExecutor {
     stateName: string,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     options: ExecuteOptions
-  ): Promise<ExecutionResult> {
+  ): Promise<ActionResult> {
     const passStateAction = new PassStateAction(stateDefinition, stateName);
     const executionResult = await passStateAction.execute(input, context);
 
@@ -370,7 +370,7 @@ export class StateExecutor {
     context: Context,
     stateName: string,
     options: ExecuteOptions
-  ): Promise<ExecutionResult> {
+  ): Promise<ActionResult> {
     const waitTimeOverrideOption = options.runOptions?.overrides?.waitTimeOverrides?.[stateName];
 
     const waitStateAction = new WaitStateAction(stateDefinition, stateName);
@@ -406,7 +406,7 @@ export class StateExecutor {
     stateName: string,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     options: ExecuteOptions
-  ): Promise<ExecutionResult> {
+  ): Promise<ActionResult> {
     const choiceStateAction = new ChoiceStateAction(stateDefinition, stateName);
     const executionResult = await choiceStateAction.execute(input, context);
 
@@ -427,7 +427,7 @@ export class StateExecutor {
     stateName: string,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     options: ExecuteOptions
-  ): Promise<ExecutionResult> {
+  ): Promise<ActionResult> {
     const succeedStateAction = new SucceedStateAction(stateDefinition, stateName);
     const executionResult = await succeedStateAction.execute(input, context);
 
@@ -448,7 +448,7 @@ export class StateExecutor {
     stateName: string,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     options: ExecuteOptions
-  ): Promise<ExecutionResult> {
+  ): Promise<ActionResult> {
     const failStateAction = new FailStateAction(stateDefinition, stateName);
     const executionResult = await failStateAction.execute(input, context);