cloud-script v1.0.0

Typescript 2 ASL Transpiler

Typescript 2 ASL allows developers to define their AWS Step Functions using the Typescript programming language. Using Typescript allows developers to benefit from: a familiar syntax, type safety and mature ecosystem of tools for linting, editing and automated testing.

The following program can be executed and tested locally. When deployed to your AWS Cloud this program will execute using as a Step Function State Machine. How the Typescript code gets converted to ASL can be seen in the interactive playground.

import * as asl from "@ts2asl/asl-lib"

//main will be converted to ASL and deployed as a state machine
export const main = asl.deploy.asStateMachine(async (input: IInput) => {
  if (typeof input.name !== "string") {
    input.name = "World";
  }
  const rnd = await random();
  return {
    greeting: `Hello ${input.name}`,
    luckyNumber: rnd
  }
});

//random will be deployed as a lambda function
export const random = asl.deploy.asLambda(async (input: { min?: number; max?: number } = {}) => {
  const min = input.min ?? 0;
  const max = input.max ?? 100;
  return Math.round(Math.random() * (max - min) + min);
});

interface IInput {
  name: string;
}

Deployment using the CDK

Typescript 2 ASL features a CDK construct that allows developers to integrate the Typescript to ASL conversion process into existing CI/CD pipelines. An example stack can be found in this repository.

import * as ts2asl from '@ts2asl/cdk-typescript-statemachine';

new ts2asl.TypescriptStateMachine(this, "TypescriptStateMachine", {
  programName: "hello-world",
  defaultFunctionProps: {},
  defaultStepFunctionProps: {
    stateMachineType: "EXPRESS",
    roleArn: executionRole.roleArn
  },
  sourceFile: "./src/program.ts",
});

Typescript language support

The following Typescript langauge features are supported:

• variable assingments
• throwing errors
• input validation
• enclosed variables
• if statements
• for ... of statements
• for ... in statements
• do while statements
• try/catch/finally statements
• boolean evaluation logic
• promise.all
• array.map
• array.filter
• console.log
• evaluation of literal expressions
• string templates

Additionally there is typescript library support for

• ASL States (Pass, Wait, Choice, Parallel, Map, etc.)
• SDK Integrations