aws-local-stepfunctions 0.2.0 → 0.3.1

package/README.md

@@ -6,6 +6,19 @@ This package lets you run AWS Step Functions locally on your machine!
 
 > 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
+
+- [Features](#features)
+- [Installation](#installation)
+- [Importing](#importing)
+  - [Node.js](#nodejs)
+    - [CommonJS](#commonjs)
+    - [ES Module](#es-module)
+- [API](#api)
+  - [Constructor](#constructor-new-statemachinedefinition-validationoptions)
+  - [StateMachine.run](#statemachineruninput-options)
+- [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).
@@ -38,6 +51,8 @@ import { StateMachine } from 'aws-local-stepfunctions';
 
 ### Constructor: `new StateMachine(definition[, validationOptions])`
 
+#### Parameters
+
 The constructor takes the following parameters:
 
 - `definition`: The Amazon States Language definition of the state machine.
@@ -47,7 +62,7 @@ The constructor takes the following parameters:
 
 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.
 
-Example:
+#### Example
 
 ```js
 import { StateMachine } from 'aws-local-stepfunctions';
@@ -68,19 +83,27 @@ const machineDefinition = {
 const stateMachine = new StateMachine(machineDefinition, { checkPaths: false });
 ```
 
-### `async StateMachine.run(input[, options])`
+### `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.
+- `result`: A `Promise` that resolves with the execution result once it finishes.
 
-Executes the state machine with the given `input` parameter and returns the result of the execution.
+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.
 
-It takes the following parameters:
+#### Parameters
 
 - `input`: The initial input to pass to the state machine. This can be any valid JSON value.
 - `options` (optional):
-  - `overrides`: An object to overrides the behavior of certain states:
+  - `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.
 
-Example without `options`:
+#### Examples
+
+##### Example without `options`:
 
 ```js
 import { StateMachine } from 'aws-local-stepfunctions';
@@ -96,14 +119,15 @@ const machineDefinition = {
   },
 };
 
-const stateMachine = new StateMachine(machineDefinition, { checkPaths: false });
+const stateMachine = new StateMachine(machineDefinition);
 const myInput = { value1: 'hello', value2: 123, value3: true };
-const result = await stateMachine.run(myInput); // execute the state machine
+const execution = stateMachine.run(myInput); // execute the state machine
 
+const result = await execution.result; // wait until the execution finishes to get the result
 console.log(result); // log the result of the execution
 ```
 
-Example with `options`:
+##### Example with `options`:
 
 ```js
 import { StateMachine } from 'aws-local-stepfunctions';
@@ -133,9 +157,9 @@ function addNumbersLocal(input) {
   return input.num1 + input.num2;
 }
 
-const stateMachine = new StateMachine(machineDefinition, { checkPaths: false });
+const stateMachine = new StateMachine(machineDefinition);
 const myInput = { value1: 'hello', value2: 123, value3: true };
-const result = await stateMachine.run(myInput, {
+const execution = stateMachine.run(myInput, {
   overrides: {
     taskResourceLocalHandlers: {
       AddNumbers: addNumbersLocal, // call the `addNumbersLocal` function instead of invoking the Lambda function specified for the `AddNumbers` state
@@ -146,7 +170,46 @@ const result = await stateMachine.run(myInput, {
   },
 });
 
-console.log(result); // log the result of the execution
+const result = await execution.result;
+console.log(result);
+```
+
+##### Aborting an execution
+
+```js
+import { StateMachine, ExecutionAbortedError } from 'aws-local-stepfunctions';
+
+const machineDefinition = {
+  StartAt: 'Hello World',
+  States: {
+    'Hello World': {
+      Type: 'Task',
+      Resource: 'arn:aws:lambda:us-east-1:123456789012:function:HelloWorld',
+      End: true,
+    },
+  },
+};
+
+const stateMachine = new StateMachine(machineDefinition);
+const myInput = { value1: 'hello', value2: 123, value3: true };
+const execution = stateMachine.run(myInput);
+
+// abort the execution after 3 seconds
+setTimeout(() => {
+  execution.abort();
+}, 3000);
+
+try {
+  const result = await execution.result;
+  console.log(result);
+} catch (e) {
+  if (e instanceof ExecutionAbortedError) {
+    // since execution was aborted, type of error is `ExecutionAbortedError`
+    console.log('Execution was aborted');
+  } else {
+    console.error('Some other error', e);
+  }
+}
 ```
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aws-local-stepfunctions",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Execute an AWS Step Function locally",
   "keywords": [
     "aws",
@@ -34,7 +34,7 @@
   },
   "scripts": {
     "test": "jest",
-    "build": "bunchee --minify src/main.ts",
+    "build": "tsup",
     "prettier": "prettier --write src/**/*.ts",
     "lint": "eslint src/**/*.ts",
     "lint:fix": "eslint src/**/*.ts --fix"
@@ -43,16 +43,16 @@
     "@tsconfig/node16-strictest": "^1.0.4",
     "@types/jest": "^29.0.3",
     "@types/lodash": "^4.14.184",
-    "@types/node": "^17.0.31",
+    "@types/node": "^18.14.0",
     "@types/picomatch": "^2.3.0",
     "@typescript-eslint/eslint-plugin": "^5.22.0",
     "@typescript-eslint/parser": "^5.22.0",
-    "bunchee": "^2.2.0",
     "eslint": "^8.14.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
     "prettier": "^2.6.2",
     "ts-jest": "^29.0.3",
+    "tsup": "^6.6.3",
     "typescript": "^4.6.4"
   },
   "dependencies": {

package/build/main.cjs

@@ -1,3 +0,0 @@
-Object.defineProperty(exports,"__esModule",{value:!0});var jsonpathPlus=require("jsonpath-plus"),clientLambda=require("@aws-sdk/client-lambda"),wcmatch=require("wildcard-match"),aslValidator=require("asl-validator"),set=require("lodash/set.js"),cloneDeep=require("lodash/cloneDeep.js"),pLimit=require("p-limit");function _interopDefaultLegacy(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var wcmatch__default=_interopDefaultLegacy(wcmatch),aslValidator__default=_interopDefaultLegacy(aslValidator),set__default=_interopDefaultLegacy(set),cloneDeep__default=_interopDefaultLegacy(cloneDeep),pLimit__default=_interopDefaultLegacy(pLimit);function isPlainObj(e){return!!e&&Object.getPrototypeOf(e)===Object.prototype}function sleep(e){return new Promise(t=>{setTimeout(t,e)})}class CustomError extends Error{constructor(e){super(e)}}class LambdaExecutionError extends CustomError{toString(){return`${this.name}: ${this.message}. The error thrown by the Lambda was:
-${this.wrappedError.stack}`}constructor(e,t){super(`Execution of Lambda function "${t}" failed`),this.name="LambdaExecutionError",this.wrappedError=Error(e.errorMessage),this.wrappedError.stack=e.trace.join("\n")}}function asyncGeneratorStep$1(e,t,r,a,n,i,s){try{var u=e[i](s),l=u.value}catch(c){r(c);return}u.done?t(l):Promise.resolve(l).then(a,n)}function _asyncToGenerator$1(e){return function(){var t=this,r=arguments;return new Promise(function(a,n){var i=e.apply(t,r);function s(e){asyncGeneratorStep$1(i,a,n,s,u,"next",e)}function u(e){asyncGeneratorStep$1(i,a,n,s,u,"throw",e)}s(void 0)})}}class LambdaClient{invokeFunction(e,t){var r=this;return _asyncToGenerator$1(function*(){let a=Buffer.from(JSON.stringify(t)),n=new clientLambda.InvokeCommand({FunctionName:e,Payload:a}),i=yield r.client.send(n),s=null;if(i.Payload&&(s=JSON.parse(s=Buffer.from(i.Payload).toString())),i.FunctionError)throw new LambdaExecutionError(s,e);return s})()}constructor(e){this.client=new clientLambda.LambdaClient(null!=e?e:{})}}function testChoiceRule(e,t,r){if("And"in e)return e.And.every(e=>testChoiceRule(e,t,r));if("Or"in e)return e.Or.some(e=>testChoiceRule(e,t,r));if("Not"in e)return!testChoiceRule(e.Not,t,r);if("StringEquals"in e){let a=r(e.Variable,t);return a===e.StringEquals}if("StringEqualsPath"in e){let n=r(e.Variable,t),i=r(e.StringEqualsPath,t);return n===i}if("StringLessThan"in e){let s=r(e.Variable,t);return s<e.StringLessThan}if("StringLessThanPath"in e){let u=r(e.Variable,t),l=r(e.StringLessThanPath,t);return u<l}if("StringGreaterThan"in e){let c=r(e.Variable,t);return c>e.StringGreaterThan}if("StringGreaterThanPath"in e){let o=r(e.Variable,t),h=r(e.StringGreaterThanPath,t);return o>h}if("StringLessThanEquals"in e){let p=r(e.Variable,t);return p<=e.StringLessThanEquals}if("StringLessThanEqualsPath"in e){let m=r(e.Variable,t),d=r(e.StringLessThanEqualsPath,t);return m<=d}if("StringGreaterThanEquals"in e){let f=r(e.Variable,t);return f>=e.StringGreaterThanEquals}if("StringGreaterThanEqualsPath"in e){let T=r(e.Variable,t),S=r(e.StringGreaterThanEqualsPath,t);return T>=S}if("StringMatches"in e){let P=r(e.Variable,t),y=wcmatch__default.default(e.StringMatches,{separator:!1});return y(P)}if("NumericEquals"in e){let b=r(e.Variable,t);return b===e.NumericEquals}if("NumericEqualsPath"in e){let w=r(e.Variable,t),E=r(e.NumericEqualsPath,t);return w===E}if("NumericLessThan"in e){let I=r(e.Variable,t);return I<e.NumericLessThan}if("NumericLessThanPath"in e){let g=r(e.Variable,t),q=r(e.NumericLessThanPath,t);return g<q}if("NumericGreaterThan"in e){let L=r(e.Variable,t);return L>e.NumericGreaterThan}if("NumericGreaterThanPath"in e){let v=r(e.Variable,t),V=r(e.NumericGreaterThanPath,t);return v>V}if("NumericLessThanEquals"in e){let N=r(e.Variable,t);return N<=e.NumericLessThanEquals}if("NumericLessThanEqualsPath"in e){let _=r(e.Variable,t),G=r(e.NumericLessThanEqualsPath,t);return _<=G}if("NumericGreaterThanEquals"in e){let R=r(e.Variable,t);return R>=e.NumericGreaterThanEquals}if("NumericGreaterThanEqualsPath"in e){let D=r(e.Variable,t),j=r(e.NumericGreaterThanEqualsPath,t);return D>=j}if("BooleanEquals"in e){let O=r(e.Variable,t);return O===e.BooleanEquals}if("BooleanEqualsPath"in e){let x=r(e.Variable,t),C=r(e.BooleanEqualsPath,t);return x===C}if("TimestampEquals"in e){let M=new Date(r(e.Variable,t)),$=new Date(e.TimestampEquals);return M.getTime()===$.getTime()}if("TimestampEqualsPath"in e){let k=new Date(r(e.Variable,t)),B=new Date(r(e.TimestampEqualsPath,t));return k.getTime()===B.getTime()}if("TimestampLessThan"in e){let F=new Date(r(e.Variable,t)),Q=new Date(e.TimestampLessThan);return F<Q}if("TimestampLessThanPath"in e){let A=new Date(r(e.Variable,t)),W=new Date(r(e.TimestampLessThanPath,t));return A<W}if("TimestampGreaterThan"in e){let J=new Date(r(e.Variable,t)),H=new Date(e.TimestampGreaterThan);return J>H}if("TimestampGreaterThanPath"in e){let Z=new Date(r(e.Variable,t)),z=new Date(r(e.TimestampGreaterThanPath,t));return Z>z}if("TimestampLessThanEquals"in e){let K=new Date(r(e.Variable,t)),U=new Date(e.TimestampLessThanEquals);return K<=U}if("TimestampLessThanEqualsPath"in e){let X=new Date(r(e.Variable,t)),Y=new Date(r(e.TimestampLessThanEqualsPath,t));return X<=Y}if("TimestampGreaterThanEquals"in e){let ee=new Date(r(e.Variable,t)),et=new Date(e.TimestampGreaterThanEquals);return ee>=et}if("TimestampGreaterThanEqualsPath"in e){let er=new Date(r(e.Variable,t)),ea=new Date(r(e.TimestampGreaterThanEqualsPath,t));return er>=ea}if("IsNull"in e){let en=r(e.Variable,t),ei=e.IsNull;return ei&&null===en}if("IsPresent"in e){let es=r(e.Variable,t),eu=e.IsPresent;return eu&&!!es}if("IsNumeric"in e){let el=r(e.Variable,t),ec=e.IsNumeric;return ec&&"number"==typeof el}if("IsString"in e){let eo=r(e.Variable,t),eh=e.IsString;return eh&&"string"==typeof eo}if("IsBoolean"in e){let ep=r(e.Variable,t),em=e.IsBoolean;return em&&"boolean"==typeof ep}if("IsTimestamp"in e){let ed=r(e.Variable,t),ef=e.IsTimestamp;return ef&&/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|(\+|-)\d{2}:\d{2})/.test(ed)}return!1}function asyncGeneratorStep(e,t,r,a,n,i,s){try{var u=e[i](s),l=u.value}catch(c){r(c);return}u.done?t(l):Promise.resolve(l).then(a,n)}function _asyncToGenerator(e){return function(){var t=this,r=arguments;return new Promise(function(a,n){var i=e.apply(t,r);function s(e){asyncGeneratorStep(i,a,n,s,u,"next",e)}function u(e){asyncGeneratorStep(i,a,n,s,u,"throw",e)}s(void 0)})}}function _extends(){return(_extends=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var a in r)Object.prototype.hasOwnProperty.call(r,a)&&(e[a]=r[a])}return e}).apply(this,arguments)}class StateMachine{run(e,t){var r=this;return _asyncToGenerator(function*(){r.rawInput=e,r.currInput=e;let a=!1;do r.currState=r.states[r.currStateName],r.processInput(),yield r.stateHandlers[r.currState.Type](t),r.processResult(),r.rawInput=r.currResult,r.currInput=r.currResult,"Next"in r.currState&&(r.currStateName=r.currState.Next),("End"in r.currState||"Succeed"===r.currState.Type||"Fail"===r.currState.Type)&&(a=!0);while(!a);return r.currResult})()}processInputPath(){return"InputPath"in this.currState?null===this.currState.InputPath?{}:this.jsonQuery(this.currState.InputPath,this.currInput):this.currInput}processPayloadTemplate(e,t){let r=Object.entries(e).map(([e,r])=>{let a=e,n=r;return isPlainObj(r)&&(n=this.processPayloadTemplate(r,t)),e.endsWith(".$")&&"string"==typeof r&&(a=e.replace(".$",""),n=this.jsonQuery(r,t)),[a,n]});return Object.fromEntries(r)}processInput(){this.currInput=this.processInputPath(),"Parameters"in this.currState&&"Map"!==this.currState.Type&&(this.currInput=this.processPayloadTemplate(this.currState.Parameters,this.currInput))}processResultPath(){if("ResultPath"in this.currState){if(null===this.currState.ResultPath)return this.rawInput;let e=this.currState.ResultPath.replace("$.","");if(isPlainObj(this.rawInput)){let t=cloneDeep__default.default(this.rawInput);return set__default.default(t,e,this.currResult)}}return this.currResult}processOutputPath(){return"OutputPath"in this.currState?null===this.currState.OutputPath?{}:this.jsonQuery(this.currState.OutputPath,this.currResult):this.currResult}processResult(){"ResultSelector"in this.currState&&(this.currResult=this.processPayloadTemplate(this.currState.ResultSelector,this.currResult)),this.currResult=this.processResultPath(),this.currResult=this.processOutputPath()}handleTaskState(e){var t=this;return _asyncToGenerator(function*(){var r,a;let n=t.currState,i=new LambdaClient,s=null==e?void 0:null==(r=e.overrides)?void 0:null==(a=r.taskResourceLocalHandlers)?void 0:a[t.currStateName];try{if(s){let u=yield s(t.currInput);t.currResult=u;return}let l=yield i.invokeFunction(n.Resource,t.currInput);t.currResult=l}catch(c){throw c instanceof LambdaExecutionError?console.error(c.toString()):console.error(c),c}})()}handleMapState(e){var t=this;return _asyncToGenerator(function*(){let r=t.currState,a=t.currInput;if(r.ItemsPath&&(a=t.jsonQuery(r.ItemsPath,t.currInput)),!Array.isArray(a))return;let n=(a,n)=>{let i;t.context.Map={Item:{Index:n,Value:a}},r.Parameters&&(i=t.processPayloadTemplate(r.Parameters,t.currInput));let s=new StateMachine(r.Iterator,t.validationOptions);return s.run(null!=i?i:a,e)},i=pLimit__default.default(r.MaxConcurrency||40),s=a.map((e,t)=>i(()=>n(e,t))),u=yield Promise.all(s);delete t.context.Map,t.currResult=u})()}handlePassState(e){var t=this;return _asyncToGenerator(function*(){let e=t.currState;e.Result?t.currResult=e.Result:t.currResult=t.currInput})()}handleWaitState(e){var t=this;return _asyncToGenerator(function*(){var r,a;let n=t.currState,i=null==e?void 0:null==(r=e.overrides)?void 0:null==(a=r.waitTimeOverrides)?void 0:a[t.currStateName];if(i){yield sleep(i),t.currResult=t.currInput;return}if(n.Seconds)yield sleep(1e3*n.Seconds);else if(n.Timestamp){let s=new Date(n.Timestamp),u=Date.now(),l=s.getTime()-u;yield sleep(l)}else if(n.SecondsPath){let c=t.jsonQuery(n.SecondsPath,t.currInput);yield sleep(1e3*c)}else if(n.TimestampPath){let o=t.jsonQuery(n.TimestampPath,t.currInput),h=new Date(o),p=Date.now(),m=h.getTime()-p;yield sleep(m)}t.currResult=t.currInput})()}handleChoiceState(e){var t=this;return _asyncToGenerator(function*(){let e=t.currState;for(let r of e.Choices){let a=testChoiceRule(r,t.currInput,t.jsonQuery);if(a){t.currStateName=r.Next,t.currResult=t.currInput;return}}if(e.Default){t.currStateName=e.Default,t.currResult=t.currInput;return}})()}handleSucceedState(e){var t=this;return _asyncToGenerator(function*(){t.currResult=t.currInput})()}handleFailState(e){return _asyncToGenerator(function*(){})()}jsonQuery(e,t){return e.startsWith("$$")?jsonpathPlus.JSONPath({path:e.slice(1),json:this.context,wrap:!1}):jsonpathPlus.JSONPath({path:e,json:t,wrap:!1})}constructor(e,t){let{isValid:r,errorsText:a}=aslValidator__default.default(e,_extends({checkArn:!0,checkPaths:!0},t));if(!r)throw Error(`State machine definition is invalid, see error(s) below:
- ${a("\n")}`);this.states=e.States,this.currStateName=e.StartAt,this.currState=this.states[this.currStateName],this.rawInput={},this.currInput={},this.currResult=null,this.context={},this.stateHandlers={Task:this.handleTaskState.bind(this),Map:this.handleMapState.bind(this),Pass:this.handlePassState.bind(this),Wait:this.handleWaitState.bind(this),Choice:this.handleChoiceState.bind(this),Succeed:this.handleSucceedState.bind(this),Fail:this.handleFailState.bind(this)},this.validationOptions=t}}exports.StateMachine=StateMachine;

package/build/main.d.ts

@@ -1,323 +0,0 @@
-declare type StateType = 'Task' | 'Map' | 'Pass' | 'Wait' | 'Choice' | 'Succeed' | 'Fail';
-
-interface BaseState {
-    Type: StateType;
-    Comment?: string;
-}
-
-declare type PayloadTemplate = object;
-interface CanHaveInputPath {
-    InputPath?: string | null;
-}
-interface CanHaveParameters {
-    Parameters?: PayloadTemplate;
-}
-interface CanHaveResultSelector {
-    ResultSelector?: PayloadTemplate;
-}
-interface CanHaveResultPath {
-    ResultPath?: string | null;
-}
-interface CanHaveOutputPath {
-    OutputPath?: string | null;
-}
-
-declare type StringOperatorNames = 'StringEquals' | 'StringLessThan' | 'StringGreaterThan' | 'StringLessThanEquals' | 'StringGreaterThanEquals' | 'StringMatches';
-declare type StringPathOperatorNames = 'StringEqualsPath' | 'StringLessThanPath' | 'StringGreaterThanPath' | 'StringLessThanEqualsPath' | 'StringGreaterThanEqualsPath';
-declare type NumericOperatorNames = 'NumericEquals' | 'NumericLessThan' | 'NumericGreaterThan' | 'NumericLessThanEquals' | 'NumericGreaterThanEquals';
-declare type NumericPathOperatorNames = 'NumericEqualsPath' | 'NumericLessThanPath' | 'NumericGreaterThanPath' | 'NumericLessThanEqualsPath' | 'NumericGreaterThanEqualsPath';
-declare type BooleanOperatorNames = 'BooleanEquals';
-declare type BooleanPathOperatorNames = 'BooleanEqualsPath';
-declare type TimestampOperatorNames = 'TimestampEquals' | 'TimestampLessThan' | 'TimestampGreaterThan' | 'TimestampLessThanEquals' | 'TimestampGreaterThanEquals';
-declare type TimestampPathOperatorNames = 'TimestampEqualsPath' | 'TimestampLessThanPath' | 'TimestampGreaterThanPath' | 'TimestampLessThanEqualsPath' | 'TimestampGreaterThanEqualsPath';
-declare type TypeTestOperatorNames = 'IsNull' | 'IsPresent' | 'IsNumeric' | 'IsString' | 'IsBoolean' | 'IsTimestamp';
-declare type StringComparisonOperator = {
-    [P in StringOperatorNames]?: string;
-};
-declare type StringPathComparisonOperator = {
-    [P in StringPathOperatorNames]?: string;
-};
-declare type NumericComparisonOperator = {
-    [P in NumericOperatorNames]?: number;
-};
-declare type NumericPathComparisonOperator = {
-    [P in NumericPathOperatorNames]?: string;
-};
-declare type BooleanComparisonOperator = {
-    [P in BooleanOperatorNames]?: boolean;
-};
-declare type BooleanPathComparisonOperator = {
-    [P in BooleanPathOperatorNames]?: string;
-};
-declare type TimestampComparisonOperator = {
-    [P in TimestampOperatorNames]?: string;
-};
-declare type TimestampPathComparisonOperator = {
-    [P in TimestampPathOperatorNames]?: string;
-};
-declare type TypeTestComparisonOperator = {
-    [P in TypeTestOperatorNames]?: true;
-};
-declare type ComparisonOperator = StringComparisonOperator | StringPathComparisonOperator | NumericComparisonOperator | NumericPathComparisonOperator | BooleanComparisonOperator | BooleanPathComparisonOperator | TimestampComparisonOperator | TimestampPathComparisonOperator | TypeTestComparisonOperator;
-declare type BaseDataTestExpression = {
-    Variable: string;
-};
-declare type DataTestExpression = BaseDataTestExpression & ComparisonOperator;
-declare type BooleanExpression = {
-    And?: ChoiceRuleWithoutNext[];
-    Or?: ChoiceRuleWithoutNext[];
-    Not?: ChoiceRuleWithoutNext;
-};
-declare type ChoiceRuleWithoutNext = DataTestExpression | BooleanExpression;
-declare type ChoiceRule = (DataTestExpression | BooleanExpression) & {
-    Next: string;
-};
-interface BaseChoiceState extends BaseState, CanHaveInputPath, CanHaveOutputPath {
-    Type: 'Choice';
-    Choices: ChoiceRule[];
-    Default?: string;
-}
-declare type ChoiceState = BaseChoiceState;
-
-interface EndableState extends BaseState {
-    Type: Exclude<StateType, 'Choice' | 'Succeed' | 'Fail'>;
-    End: true;
-}
-interface SucceedOrFailState extends BaseState {
-    Type: Extract<StateType, 'Succeed' | 'Fail'>;
-}
-declare type TerminalState = EndableState | SucceedOrFailState;
-
-interface BaseFailState extends BaseState {
-    Type: 'Fail';
-    Cause?: string;
-    Error?: string;
-}
-declare type FailState = TerminalState & BaseFailState;
-
-interface NextableState extends BaseState {
-    Type: Exclude<StateType, 'Choice' | 'Succeed' | 'Fail'>;
-    Next: string;
-}
-declare type IntermediateState = NextableState;
-
-interface BaseMapState extends BaseState, CanHaveInputPath, CanHaveParameters, CanHaveResultSelector, CanHaveResultPath, CanHaveOutputPath {
-    Type: 'Map';
-    Iterator: Omit<StateMachineDefinition, 'Version' | 'TimeoutSeconds'>;
-    ItemsPath?: string;
-    MaxConcurrency?: number;
-}
-declare type MapState = (IntermediateState | TerminalState) & BaseMapState;
-
-declare type JSONValue = null | boolean | number | string | object | any[];
-
-interface BasePassState extends BaseState, CanHaveInputPath, CanHaveParameters, CanHaveResultPath, CanHaveOutputPath {
-    Type: 'Pass';
-    Result?: JSONValue;
-}
-declare type PassState = (IntermediateState | TerminalState) & BasePassState;
-
-interface BaseSucceedState extends BaseState, CanHaveInputPath, CanHaveOutputPath {
-    Type: 'Succeed';
-}
-declare type SucceedState = TerminalState & BaseSucceedState;
-
-interface BaseTaskState extends BaseState, CanHaveInputPath, CanHaveParameters, CanHaveResultSelector, CanHaveResultPath, CanHaveOutputPath {
-    Type: 'Task';
-    Resource: string;
-}
-declare type TaskState = (IntermediateState | TerminalState) & BaseTaskState;
-
-interface BaseWaitState extends BaseState, CanHaveInputPath, CanHaveOutputPath {
-    Type: 'Wait';
-    Seconds?: number;
-    Timestamp?: string;
-    SecondsPath?: string;
-    TimestampPath?: string;
-}
-declare type WaitState = (IntermediateState | TerminalState) & BaseWaitState;
-
-declare type AllStates = TaskState | MapState | PassState | WaitState | ChoiceState | SucceedState | FailState;
-
-interface StateMachineDefinition {
-    States: Record<string, AllStates>;
-    StartAt: string;
-    Comment?: string;
-    Version?: string;
-    TimeoutSeconds?: number;
-}
-
-declare type TaskStateResourceLocalHandler = {
-    [taskStateName: string]: (...args: any) => any;
-};
-declare type WaitStateTimeOverride = {
-    [waitStateName: string]: number;
-};
-interface Overrides {
-    taskResourceLocalHandlers?: TaskStateResourceLocalHandler;
-    waitTimeOverrides?: WaitStateTimeOverride;
-}
-interface RunOptions {
-    overrides?: Overrides;
-}
-interface ValidationOptions {
-    readonly checkPaths?: boolean;
-    readonly checkArn?: boolean;
-}
-
-declare class StateMachine {
-    /**
-     * The name of the state currently being executed.
-     */
-    private currStateName;
-    /**
-     * The current state being executed.
-     */
-    private currState;
-    /**
-     * The unmodified input to the current state.
-     */
-    private rawInput;
-    /**
-     * The input that can be modified according to the `InputPath` and `Parameters` fields of the current state.
-     */
-    private currInput;
-    /**
-     * The result that can be modified according to the `ResultSelector`, `ResultPath` and `OutputPath` fields of the current state.
-     */
-    private currResult;
-    /**
-     * The context object of the state machine.
-     */
-    private context;
-    /**
-     * A map of all states defined in the state machine.
-     */
-    private readonly states;
-    /**
-     * A map of functions to handle each type of state.
-     */
-    private readonly stateHandlers;
-    /**
-     * Options to control whether to apply certain validations to the state machine definition.
-     */
-    private readonly validationOptions;
-    /**
-     * Constructs a new state machine.
-     * @param definition The state machine definition defined using the Amazon States Language (https://states-language.net/spec.html).
-     * @param validationOptions Options to control whether to apply certain validations to the definition.
-     * These options also apply to state machines defined in  the `Iterator` field of `Map` states.
-     */
-    constructor(definition: StateMachineDefinition, validationOptions?: ValidationOptions);
-    /**
-     * Executes the state machine, running through the states specified in the definiton.
-     * @param input The input to pass to this state machine execution.
-     * @param options Miscellaneous options to control certain behaviors of the execution.
-     */
-    run(input: JSONValue, options?: RunOptions): Promise<JSONValue>;
-    /**
-     * Process the current input according to the path defined in the `InputPath` field, if specified in the current state.
-     * @returns
-     * * If `InputPath` is not specified, returns the current input unmodified.
-     * * If `InputPath` is `null`, returns an empty object (`{}`).
-     * * If `InputPath` is a string, it's considered a JSONPath and the selected portion of the current input is returned.
-     */
-    private processInputPath;
-    /**
-     * Recursively process a payload template to resolve the properties that are JSONPaths.
-     * @param payloadTemplate The payload template to process.
-     * @param json The object to evaluate with JSONPath (whether of null, boolean, number, string, object, or array type).
-     * @returns The processed payload template.
-     */
-    private processPayloadTemplate;
-    /**
-     * Process the current input according to the `InputPath` and `Parameters` fields.
-     */
-    private processInput;
-    /**
-     * Process the current result according to the path defined in the `ResultPath` field, if specified in the current state.
-     * @returns
-     * * If `ResultPath` is not specified, returns the current result unmodified.
-     * * If `ResultPath` is `null`, returns the raw input (i.e. the input passed to current state).
-     * * If `ResultPath` is a string, it's considered a JSONPath and returns a combination of the raw input with the current result,
-     * by placing the current result in the specified path.
-     */
-    private processResultPath;
-    /**
-     * Process the current result according to the path defined in the `OutputPath` field, if specified in the current state.
-     * @returns
-     * * If `OutputPath` is not specified, returns the current result unmodified.
-     * * If `OutputPath` is `null`, returns an empty object (`{}`).
-     * * If `OutputPath` is a string, it's considered a JSONPath and the selected portion of the current result is returned.
-     */
-    private processOutputPath;
-    /**
-     * Process the current result according to the `ResultSelector`, `ResultPath` and `OutputPath` fields.
-     */
-    private processResult;
-    /**
-     * Handler for task states.
-     *
-     * Invokes the Lambda function specified in the `Resource` field
-     * and sets the current result of the state machine to the value returned by the Lambda.
-     */
-    private handleTaskState;
-    /**
-     * Handler for map states.
-     *
-     * Iterates over the current input items or the items of an array specified
-     * by the `ItemsPath` field, and then processes each item by passing it
-     * as the input to the state machine specified in the `Iterator` field.
-     */
-    private handleMapState;
-    /**
-     * Handler for pass states.
-     *
-     * If the `Result` field is specified, copies `Result` into the current result.
-     * Else, copies the current input into the current result.
-     */
-    private handlePassState;
-    /**
-     * Handler for wait states.
-     *
-     * Pauses the state machine execution for a certain amount of time
-     * based on one of the `Seconds`, `Timestamp`, `SecondsPath` or `TimestampPath` fields.
-     */
-    private handleWaitState;
-    /**
-     * Handler for choice states.
-     *
-     * Evaluates each choice rule specified in the `Choices` field.
-     *
-     * If one of the rules matches, then the state machine transitions to the
-     * state specified in the `Next` field for that choice rule.
-     *
-     * If no rule matches but the `Default` field is specified,
-     * then the next state will be the state specified in said field.
-     *
-     * If no rule matches and the `Default` field is not specified, throws a
-     * States.NoChoiceMatched error.
-     */
-    private handleChoiceState;
-    /**
-     * Handler for succeed states.
-     *
-     * Ends the state machine execution successfully.
-     */
-    private handleSucceedState;
-    /**
-     * Handler for fail states.
-     *
-     * Ends the state machine execution and marks it as a failure.
-     */
-    private handleFailState;
-    /**
-     * Queries for a property in an object using a JSONPath expression.
-     * @param pathExpression The JSONPath expression to query for.
-     * @param json The object to evaluate (whether of null, boolean, number, string, object, or array type).
-     * @returns The value of the property that was queried for, if found. Otherwise returns `undefined`.
-     */
-    private jsonQuery;
-}
-
-export { StateMachine };

package/build/main.esm.js

@@ -1,3 +0,0 @@
-import{JSONPath as e}from"jsonpath-plus";import{LambdaClient as t,InvokeCommand as r}from"@aws-sdk/client-lambda";import a from"wildcard-match";import n from"asl-validator";import i from"lodash/set.js";import s from"lodash/cloneDeep.js";import u from"p-limit";function isPlainObj(e){return!!e&&Object.getPrototypeOf(e)===Object.prototype}function sleep(e){return new Promise(t=>{setTimeout(t,e)})}class CustomError extends Error{constructor(e){super(e)}}class LambdaExecutionError extends CustomError{toString(){return`${this.name}: ${this.message}. The error thrown by the Lambda was:
-${this.wrappedError.stack}`}constructor(e,t){super(`Execution of Lambda function "${t}" failed`),this.name="LambdaExecutionError",this.wrappedError=Error(e.errorMessage),this.wrappedError.stack=e.trace.join("\n")}}function asyncGeneratorStep$1(e,t,r,a,n,i,s){try{var u=e[i](s),l=u.value}catch(o){r(o);return}u.done?t(l):Promise.resolve(l).then(a,n)}function _asyncToGenerator$1(e){return function(){var t=this,r=arguments;return new Promise(function(a,n){var i=e.apply(t,r);function s(e){asyncGeneratorStep$1(i,a,n,s,u,"next",e)}function u(e){asyncGeneratorStep$1(i,a,n,s,u,"throw",e)}s(void 0)})}}class LambdaClient{invokeFunction(e,t){var a=this;return _asyncToGenerator$1(function*(){let n=Buffer.from(JSON.stringify(t)),i=new r({FunctionName:e,Payload:n}),s=yield a.client.send(i),u=null;if(s.Payload&&(u=JSON.parse(u=Buffer.from(s.Payload).toString())),s.FunctionError)throw new LambdaExecutionError(u,e);return u})()}constructor(e){this.client=new t(null!=e?e:{})}}function testChoiceRule(e,t,r){if("And"in e)return e.And.every(e=>testChoiceRule(e,t,r));if("Or"in e)return e.Or.some(e=>testChoiceRule(e,t,r));if("Not"in e)return!testChoiceRule(e.Not,t,r);if("StringEquals"in e){let n=r(e.Variable,t);return n===e.StringEquals}if("StringEqualsPath"in e){let i=r(e.Variable,t),s=r(e.StringEqualsPath,t);return i===s}if("StringLessThan"in e){let u=r(e.Variable,t);return u<e.StringLessThan}if("StringLessThanPath"in e){let l=r(e.Variable,t),o=r(e.StringLessThanPath,t);return l<o}if("StringGreaterThan"in e){let c=r(e.Variable,t);return c>e.StringGreaterThan}if("StringGreaterThanPath"in e){let h=r(e.Variable,t),p=r(e.StringGreaterThanPath,t);return h>p}if("StringLessThanEquals"in e){let m=r(e.Variable,t);return m<=e.StringLessThanEquals}if("StringLessThanEqualsPath"in e){let f=r(e.Variable,t),d=r(e.StringLessThanEqualsPath,t);return f<=d}if("StringGreaterThanEquals"in e){let T=r(e.Variable,t);return T>=e.StringGreaterThanEquals}if("StringGreaterThanEqualsPath"in e){let S=r(e.Variable,t),P=r(e.StringGreaterThanEqualsPath,t);return S>=P}if("StringMatches"in e){let b=r(e.Variable,t),y=a(e.StringMatches,{separator:!1});return y(b)}if("NumericEquals"in e){let E=r(e.Variable,t);return E===e.NumericEquals}if("NumericEqualsPath"in e){let w=r(e.Variable,t),I=r(e.NumericEqualsPath,t);return w===I}if("NumericLessThan"in e){let g=r(e.Variable,t);return g<e.NumericLessThan}if("NumericLessThanPath"in e){let v=r(e.Variable,t),G=r(e.NumericLessThanPath,t);return v<G}if("NumericGreaterThan"in e){let q=r(e.Variable,t);return q>e.NumericGreaterThan}if("NumericGreaterThanPath"in e){let N=r(e.Variable,t),R=r(e.NumericGreaterThanPath,t);return N>R}if("NumericLessThanEquals"in e){let V=r(e.Variable,t);return V<=e.NumericLessThanEquals}if("NumericLessThanEqualsPath"in e){let L=r(e.Variable,t),D=r(e.NumericLessThanEqualsPath,t);return L<=D}if("NumericGreaterThanEquals"in e){let O=r(e.Variable,t);return O>=e.NumericGreaterThanEquals}if("NumericGreaterThanEqualsPath"in e){let j=r(e.Variable,t),x=r(e.NumericGreaterThanEqualsPath,t);return j>=x}if("BooleanEquals"in e){let C=r(e.Variable,t);return C===e.BooleanEquals}if("BooleanEqualsPath"in e){let $=r(e.Variable,t),_=r(e.BooleanEqualsPath,t);return $===_}if("TimestampEquals"in e){let M=new Date(r(e.Variable,t)),k=new Date(e.TimestampEquals);return M.getTime()===k.getTime()}if("TimestampEqualsPath"in e){let B=new Date(r(e.Variable,t)),F=new Date(r(e.TimestampEqualsPath,t));return B.getTime()===F.getTime()}if("TimestampLessThan"in e){let Q=new Date(r(e.Variable,t)),A=new Date(e.TimestampLessThan);return Q<A}if("TimestampLessThanPath"in e){let W=new Date(r(e.Variable,t)),H=new Date(r(e.TimestampLessThanPath,t));return W<H}if("TimestampGreaterThan"in e){let J=new Date(r(e.Variable,t)),Z=new Date(e.TimestampGreaterThan);return J>Z}if("TimestampGreaterThanPath"in e){let z=new Date(r(e.Variable,t)),K=new Date(r(e.TimestampGreaterThanPath,t));return z>K}if("TimestampLessThanEquals"in e){let U=new Date(r(e.Variable,t)),X=new Date(e.TimestampLessThanEquals);return U<=X}if("TimestampLessThanEqualsPath"in e){let Y=new Date(r(e.Variable,t)),ee=new Date(r(e.TimestampLessThanEqualsPath,t));return Y<=ee}if("TimestampGreaterThanEquals"in e){let et=new Date(r(e.Variable,t)),er=new Date(e.TimestampGreaterThanEquals);return et>=er}if("TimestampGreaterThanEqualsPath"in e){let ea=new Date(r(e.Variable,t)),en=new Date(r(e.TimestampGreaterThanEqualsPath,t));return ea>=en}if("IsNull"in e){let ei=r(e.Variable,t),es=e.IsNull;return es&&null===ei}if("IsPresent"in e){let eu=r(e.Variable,t),el=e.IsPresent;return el&&!!eu}if("IsNumeric"in e){let eo=r(e.Variable,t),ec=e.IsNumeric;return ec&&"number"==typeof eo}if("IsString"in e){let eh=r(e.Variable,t),ep=e.IsString;return ep&&"string"==typeof eh}if("IsBoolean"in e){let em=r(e.Variable,t),ef=e.IsBoolean;return ef&&"boolean"==typeof em}if("IsTimestamp"in e){let ed=r(e.Variable,t),eT=e.IsTimestamp;return eT&&/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|(\+|-)\d{2}:\d{2})/.test(ed)}return!1}function asyncGeneratorStep(e,t,r,a,n,i,s){try{var u=e[i](s),l=u.value}catch(o){r(o);return}u.done?t(l):Promise.resolve(l).then(a,n)}function _asyncToGenerator(e){return function(){var t=this,r=arguments;return new Promise(function(a,n){var i=e.apply(t,r);function s(e){asyncGeneratorStep(i,a,n,s,u,"next",e)}function u(e){asyncGeneratorStep(i,a,n,s,u,"throw",e)}s(void 0)})}}function _extends(){return(_extends=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var a in r)Object.prototype.hasOwnProperty.call(r,a)&&(e[a]=r[a])}return e}).apply(this,arguments)}class StateMachine{run(e,t){var r=this;return _asyncToGenerator(function*(){r.rawInput=e,r.currInput=e;let a=!1;do r.currState=r.states[r.currStateName],r.processInput(),yield r.stateHandlers[r.currState.Type](t),r.processResult(),r.rawInput=r.currResult,r.currInput=r.currResult,"Next"in r.currState&&(r.currStateName=r.currState.Next),("End"in r.currState||"Succeed"===r.currState.Type||"Fail"===r.currState.Type)&&(a=!0);while(!a);return r.currResult})()}processInputPath(){return"InputPath"in this.currState?null===this.currState.InputPath?{}:this.jsonQuery(this.currState.InputPath,this.currInput):this.currInput}processPayloadTemplate(e,t){let r=Object.entries(e).map(([e,r])=>{let a=e,n=r;return isPlainObj(r)&&(n=this.processPayloadTemplate(r,t)),e.endsWith(".$")&&"string"==typeof r&&(a=e.replace(".$",""),n=this.jsonQuery(r,t)),[a,n]});return Object.fromEntries(r)}processInput(){this.currInput=this.processInputPath(),"Parameters"in this.currState&&"Map"!==this.currState.Type&&(this.currInput=this.processPayloadTemplate(this.currState.Parameters,this.currInput))}processResultPath(){if("ResultPath"in this.currState){if(null===this.currState.ResultPath)return this.rawInput;let e=this.currState.ResultPath.replace("$.","");if(isPlainObj(this.rawInput)){let t=s(this.rawInput);return i(t,e,this.currResult)}}return this.currResult}processOutputPath(){return"OutputPath"in this.currState?null===this.currState.OutputPath?{}:this.jsonQuery(this.currState.OutputPath,this.currResult):this.currResult}processResult(){"ResultSelector"in this.currState&&(this.currResult=this.processPayloadTemplate(this.currState.ResultSelector,this.currResult)),this.currResult=this.processResultPath(),this.currResult=this.processOutputPath()}handleTaskState(e){var t=this;return _asyncToGenerator(function*(){var r,a;let n=t.currState,i=new LambdaClient,s=null==e?void 0:null==(r=e.overrides)?void 0:null==(a=r.taskResourceLocalHandlers)?void 0:a[t.currStateName];try{if(s){let u=yield s(t.currInput);t.currResult=u;return}let l=yield i.invokeFunction(n.Resource,t.currInput);t.currResult=l}catch(o){throw o instanceof LambdaExecutionError?console.error(o.toString()):console.error(o),o}})()}handleMapState(e){var t=this;return _asyncToGenerator(function*(){let r=t.currState,a=t.currInput;if(r.ItemsPath&&(a=t.jsonQuery(r.ItemsPath,t.currInput)),!Array.isArray(a))return;let n=(a,n)=>{let i;t.context.Map={Item:{Index:n,Value:a}},r.Parameters&&(i=t.processPayloadTemplate(r.Parameters,t.currInput));let s=new StateMachine(r.Iterator,t.validationOptions);return s.run(null!=i?i:a,e)},i=u(r.MaxConcurrency||40),s=a.map((e,t)=>i(()=>n(e,t))),l=yield Promise.all(s);delete t.context.Map,t.currResult=l})()}handlePassState(e){var t=this;return _asyncToGenerator(function*(){let e=t.currState;e.Result?t.currResult=e.Result:t.currResult=t.currInput})()}handleWaitState(e){var t=this;return _asyncToGenerator(function*(){var r,a;let n=t.currState,i=null==e?void 0:null==(r=e.overrides)?void 0:null==(a=r.waitTimeOverrides)?void 0:a[t.currStateName];if(i){yield sleep(i),t.currResult=t.currInput;return}if(n.Seconds)yield sleep(1e3*n.Seconds);else if(n.Timestamp){let s=new Date(n.Timestamp),u=Date.now(),l=s.getTime()-u;yield sleep(l)}else if(n.SecondsPath){let o=t.jsonQuery(n.SecondsPath,t.currInput);yield sleep(1e3*o)}else if(n.TimestampPath){let c=t.jsonQuery(n.TimestampPath,t.currInput),h=new Date(c),p=Date.now(),m=h.getTime()-p;yield sleep(m)}t.currResult=t.currInput})()}handleChoiceState(e){var t=this;return _asyncToGenerator(function*(){let e=t.currState;for(let r of e.Choices){let a=testChoiceRule(r,t.currInput,t.jsonQuery);if(a){t.currStateName=r.Next,t.currResult=t.currInput;return}}if(e.Default){t.currStateName=e.Default,t.currResult=t.currInput;return}})()}handleSucceedState(e){var t=this;return _asyncToGenerator(function*(){t.currResult=t.currInput})()}handleFailState(e){return _asyncToGenerator(function*(){})()}jsonQuery(t,r){return t.startsWith("$$")?e({path:t.slice(1),json:this.context,wrap:!1}):e({path:t,json:r,wrap:!1})}constructor(e,t){let{isValid:r,errorsText:a}=n(e,_extends({checkArn:!0,checkPaths:!0},t));if(!r)throw Error(`State machine definition is invalid, see error(s) below:
- ${a("\n")}`);this.states=e.States,this.currStateName=e.StartAt,this.currState=this.states[this.currStateName],this.rawInput={},this.currInput={},this.currResult=null,this.context={},this.stateHandlers={Task:this.handleTaskState.bind(this),Map:this.handleMapState.bind(this),Pass:this.handlePassState.bind(this),Wait:this.handleWaitState.bind(this),Choice:this.handleChoiceState.bind(this),Succeed:this.handleSucceedState.bind(this),Fail:this.handleFailState.bind(this)},this.validationOptions=t}}export{StateMachine};