sequential-workflow-machine

KO | EN

gitlite — search

#python #ai #llm #go #android #rust #windows #awesome #vue #awesome-list #pytorch #mcp #ios #open-source

sequential-workflow-machine

(★ 64)

Powerful sequential workflow machine for front-end and back-end applications. Check out https://nocode-js.com

File Explorer

Download Latest Version (.zip)

- - main.yml
  - packages.sh
- - index.ts
  - machine-unhandled-error.spec.ts
  - machine-unhandled-error.ts
  - types.ts
  - workflow-machine-builder.spec.ts
  - workflow-machine-builder.ts
  - workflow-machine-interpreter.spec.ts
  - workflow-machine-interpreter.ts
  - workflow-machine-snapshot.ts
  - workflow-machine.spec.ts
  - workflow-machine.ts
- .gitignore
- jest.config.cjs
- package.json
- rollup.config.mjs
- tsconfig.json
- set-version.cjs
.editorconfig
.eslintrc.json
.gitignore
.prettierrc
CHANGELOG.md
LICENSE
package.json
README.md
yarn.lock

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Sequential Workflow Machine

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fnocode-js%2Fsequential-workflow-machine%2Fbadge%3Fref%3Dmain&style=flat-square)](https://actions-badge.atrox.dev/b4rtaz/sequential-workflow-machine/goto?ref=main) [![License: MIT](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://raw.githubusercontent.com/nocode-js/sequential-workflow-machine/main/LICENSE) [![View this project on NPM](https://img.shields.io/npm/v/sequential-workflow-machine.svg?style=flat-square)](https://npmjs.org/package/sequential-workflow-machine)

The powerful sequential workflow machine for frontend and backend applications. It provides a simple API for creating its own step execution handlers (activities). It supports multiple types of activities. Internally it uses the [xstate](https://github.com/statelyai/xstate) library.

This machine uses the same data model as the [Sequential Workflow Designer](https://github.com/nocode-js/sequential-workflow-designer). So you can create a workflow definition in the designer and then run it by this machine easily.

📝 Check the [documentation](https://nocode-js.com/docs/category/sequential-workflow-machine) for more details.

## 🚀 Installation

Install the following packages by NPM command:

```
npm i sequential-workflow-model sequential-workflow-machine
```

## 🎬 Usage

You can use the machine in a JavaScript or TypeScript application. We recommend using TypeScript because a workflow uses a lot of data structures and it's hard to maintain data integrity.

At the beginning, you need to define the type of your workflow definition.

```ts
import { Definition } from 'sequential-workflow-model';

interface MyDefinition extends Definition {
  properties: {
    verbose: boolean;
  };
}
```

Next, define your step types.

```ts
import { Step } from 'sequential-workflow-model';

interface DownloadHtmlStep extends Step {
  componentType: 'task';
  type: 'downloadHtml';
  properties: {
    pageUrl: string;
  };
}

// ...
```

Prepare the workflow definition.

```ts
const definition: MyDefinition = {
  properties: {
    verbose: true,
  },
  sequence: [
    {
      id: '0x00001',
      componentType: 'task',
      type: 'downloadHtml',
      name: 'Download google.com',
      properties: {
        pageUrl: 'https://www.google.com',
      },
    },
  ],
};
```

Prepare the global state interface.

```ts
interface WorkflowGlobalState {
  html: string | null;
}
```

Prepare activities for your steps. The machine supports multiple types of activities. The basic activity is the atom activity. It's a simple handler that executes an atomic step and updates the global state.

```ts
import { createAtomActivity } from 'sequential-workflow-machine';

interface DownloadHtmlStepState {
  attempt: number;
}

Now we can create the activity set. The activity set is a collection of all supported activities.

```ts
import { createActivitySet } from 'sequential-workflow-machine';

const activitySet = createActivitySet<WorkflowGlobalState>([
  downloadHtmlActivity,
]);
```

Finally, we can create the workflow machine and run it.

```ts
import { createWorkflowMachineBuilder } from 'sequential-workflow-machine';

That's it!

## 💡 License

This project is released under the MIT license.

sequential-workflow-machine

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

sequential-workflow-machine

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README