https://github.com/wmfs/statebox

Orchestrate workflows using Amazon States Language
https://github.com/wmfs/statebox

package tymly workflow

Last synced: 7 days ago
JSON representation

Orchestrate workflows using Amazon States Language

• Host: GitHub
• URL: https://github.com/wmfs/statebox
• Owner: wmfs
• License: mit
• Created: 2018-06-12T08:10:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-01-10T08:21:27.000Z (17 days ago)
• Last Synced: 2025-01-12T13:08:14.517Z (14 days ago)
• Topics: package, tymly, workflow
• Language: JavaScript
• Homepage:
• Size: 1.19 MB
• Stars: 44
• Watchers: 10
• Forks: 7
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        

![Statebox Logo](/images/statebox-logo.png)

[![Tymly Package](https://img.shields.io/badge/tymly-package-blue.svg)](https://tymly.io/)

[![npm (scoped)](https://img.shields.io/npm/v/@wmfs/statebox.svg)](https://www.npmjs.com/package/@wmfs/statebox)

[![CircleCI](https://circleci.com/gh/wmfs/statebox.svg?style=svg)](https://circleci.com/gh/wmfs/statebox)

[![codecov](https://codecov.io/gh/wmfs/statebox/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/statebox)

[![CodeFactor](https://www.codefactor.io/repository/github/wmfs/statebox/badge)](https://www.codefactor.io/repository/github/wmfs/statebox)

[![Dependabot badge](https://img.shields.io/badge/Dependabot-active-brightgreen.svg)](https://dependabot.com/)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/wmfs/tymly/blob/master/packages/pg-concat/LICENSE)

> Orchestrate Node functions using [Amazon States Language](https://states-language.net/spec.html)

## Useful links

* [AWS Step Functions](https://aws.amazon.com/step-functions/) - overview of Amazon States Language, use cases, etc

* [statelint](https://npmjs.com/package/@wmfs/statelint) - a validator for Amazon States Language JSON files

* https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html

* https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskSuccess.html

## Install

```bash

$ npm install @wmfs/statebox --save

```

## Usage

```javascript

const Statebox = require('@wmfs/statebox')

const statebox = new Statebox({})

const main = async

function() {

  // STEP 1:

  // Create some 'module' resources (i.e. Javascript

  // classes with 'run' and optional 'init' methods)

  // that state machines can then refer to...

  // -------------------------------------------------

  await statebox.ready

  statebox.createModuleResources({

    // Simple module to add two numbers together

    add: class Add {

      run(event, context) {

        context.sendTaskSuccess(event.number1 + event.number2)

      }

    },

    // Simple module to subtract one number from another

    subtract: class Subtract {

      // Init methods are optional, but all allow

      // resource-instances to be configured...

      init(resourceConfig, env, callback) {

        callback(null)

      }

      run(event, context) {

        context.sendTaskSuccess(event.number1 - event.number2)

      }

    }

  })

  // STEP 2:

  // Next create a new 'calculator' state

  // machine using Amazon States Language...

  // ---------------------------------------

  await statebox.createStateMachines({

      'calculator': {

        Comment: 'A simple calculator',

        StartAt: 'OperatorChoice',

        States: {

          OperatorChoice: {

            Type: 'Choice',

            Choices: [{

              Variable: '$.operator',

              StringEquals: '+',

              Next: 'Add'

            }, {

              Variable: '$.operator',

              StringEquals: '-',

              Next: 'Subtract'

            }]

          },

          Add: {

            Type: 'Task',

            InputPath: '$.numbers',

            Resource: 'module:add', // See createModuleResources()

            ResultPath: '$.result',

            End: true

          },

          Subtract: {

            Type: 'Task',

            InputPath: '$.numbers',

            Resource: 'module:subtract',

            ResultPath: '$.result',

            End: true

          }

        }

      }

    }, {}, // 'env': An environment/context/sandbox

  )

  // STEP 3:

  // Start a new execution on a state machine

  // ----------------------------------------

  const executionDescription = await statebox.startExecution({

      numbers: {

        number1: 3,

        number2: 2

      },

      operator: '-'

    }, // input

    'calculator', // state machine name

    {} // options

  )

  // STEP 4:

  // Look at the results...

  // ----------------------

  console.log(executionDescription)

  //  Result object

  //  -------------

  // {

  //   executionName: '...',

  //   ctx: {

  //     numbers': {

  //       number1: 3,

  //       number2: 2

  //     },

  //     operator: '-',

  //     result: 1 <--- The important bit :-)

  //   },

  //   currentStateName:'Subtract',

  //   currentResource:'module:subtract',

  //   stateMachineName:'calculator',

  //   startDate: '2018-09-03T21:58:04.287Z'

  // }

}

if (require.main === module) {

  main();

}

```

## Testing

```bash

$ npm test

```

## License

[MIT](https://github.com/wmfs/tymly/packages/statebox/blob/master/LICENSE)