https://github.com/nocode-js/sequential-workflow-model

Extendable data model of sequential workflow.
https://github.com/nocode-js/sequential-workflow-model

Last synced: 10 days ago
JSON representation

Extendable data model of sequential workflow.

• Host: GitHub
• URL: https://github.com/nocode-js/sequential-workflow-model
• Owner: nocode-js
• License: mit
• Created: 2023-03-04T10:23:34.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-09T23:12:29.000Z (11 months ago)
• Last Synced: 2025-04-19T21:57:54.958Z (14 days ago)
• Language: TypeScript
• Size: 64.5 KB
• Stars: 3
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sequential Workflow Model

[![License: MIT](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](/LICENSE) [![View this project on NPM](https://img.shields.io/npm/v/sequential-workflow-model.svg?style=flat-square)](https://npmjs.org/package/sequential-workflow-model)

This package contains a extendable data model of a sequential workflow.

The package is used by the following packages:

* [Sequential Workflow Designer](https://github.com/nocode-js/sequential-workflow-designer)

* [Sequential Workflow Machine](https://github.com/nocode-js/sequential-workflow-machine)

## 🔨 How to Extend Model

To extend the model, you need to extend base interfaces.

```ts

interface MyDefinition extends Definition {

  properties: {

    baseUrl: string;

  };

}

interface SendEmailStep extends Step {

  componentType: 'task';

  type: 'sendEmail';

  properties: {

    to: string;

    subject: string;

    body: string;

  };

}

interface IfStep extends BranchedStep {

  componentType: 'switch';

  type: 'if';

  properties: {

    condition: string;

  };

}

```

## 💡 License

This project is released under the MIT license.