Xeplr OS / Services

@xeplr/workflow-api

The free workflow HTTP API over @xeplr/workflow-engine: mount it in an Express app with registerWorkflow(), or run it on its own, and build your own workflow screens on it.

Install

npm install @xeplr/workflow-api

Peer dependencies you provide: @xeplr/actions, @xeplr/auth, @xeplr/base-apis, @xeplr/db, @xeplr/email, @xeplr/schema-handler, express

The idea

Mount the routes in your own app — or run the server on its own — and build your own workflow screens on them: save a workflow and its steps in one call, run it, try a step against sample output, and find the workflows a trigger starts. An arrow can be written as a simple { field, op, value } condition; a trigger or a condition that could never work is refused when it is saved, with the reason.

Where it sits

Part of Services — long-running pieces. Each one boots with the same init() / start() / router() shape and mounts into an Express app you already have.

Builds on

Third-party dependencies

  • dotenv

Documentation for @xeplr/workflow-api is in its README on npm.

These packages are what Xeplr Analytics is made of

If you are assembling this yourself, it may be worth seeing the assembled version first.