@runnablejs/express

Express middleware for Runnable.

Install

``bash
npm install @runnablejs/express
`

Usage

`typescript
import express from 'express';
import { installRunnable } from '@runnablejs/express';
import type { RunnableWorkflows } from '@runnablejs/express';

const app = express();

const workflows: RunnableWorkflows = {
create_user: {
title: 'Create User',
description: 'Create a new user',
icon: 'fa6-solid:user-plus',
category: 'Users',
execute: async (io) => {
const { name, email } = await io.form({
name: io.input.text({ label: 'Name', type: 'text' }),
email: io.input.text({ label: 'Email', type: 'email' }),
});

// your logic here
console.log('Creating user:', { name, email });

await io.message.success({
title: 'Success',
message: User ${name} created,
});
},
},
};

installRunnable(app, workflows, {
auth: {
form: {
verifyLogin: async ({ email, password }) => {
// verify credentials
return { id: '123', email };
},
},
},
});

app.listen(3000);
`

Access at http://localhost:3000/admin.

Configuration

$3

Set RUNNABLE_BASE_URL to change from /admin:

`bash
RUNNABLE_BASE_URL=runnable node app.js
`

$3

`typescript
installRunnable(app, workflows, {
auth: {
form: {
verifyLogin: async ({ email, password }) => {
const user = await verifyCredentials(email, password);
if (!user) throw new Error('Invalid credentials');
return { id: user.id, email: user.email };
},
},
},
logger: console, // optional
});
`

API

$3

- app - Express instance
- workflows - Workflow definitions
- context - Config object:
- auth.form.verifyLogin - Credential verification function
- logger` (optional) - Custom logger

License

MIT