Read-only Express middleware dashboard for observing prsm infrastructure at runtime. Mount it, pass your instances, get a live UI.

Installation

npm install @prsm/devtools

Quick Start

import express from 'express'
import { RealtimeServer } from '@prsm/realtime'
import Queue from '@prsm/queue'
import { Cron } from '@prsm/cron'
import { slidingWindow } from '@prsm/limit'
import WorkflowEngine from '@prsm/workflow'
import { prsmDevtools } from '@prsm/devtools'

const app = express()

const realtime = new RealtimeServer({ redis: { host: '127.0.0.1', port: 6379 } })
const queue = new Queue({ concurrency: 5 })
const cron = new Cron()
const apiLimiter = slidingWindow({ max: 100, window: '1m' })
const workflow = new WorkflowEngine()

app.use('/devtools', prsmDevtools({
  realtime,
  queue,
  cron,
  limit: { api: apiLimiter },
  workflow,
}))

app.listen(3000)
// open http://localhost:3000/devtools

Everything is optional. Only pass what you have - tabs appear only for connected subsystems.

What You See

Overview - unified event stream from all subsystems, live via SSE

Realtime - full inspector for @prsm/realtime with sub-tabs:

• Rooms - active rooms, members, per-member presence state
• Channels - channels with active subscribers
• Collections - collections with subscribers, expandable resolved records per connection
• Records - subscribed records with live-updating data view (via SSE) and subscription mode per connection
• Metadata - detailed connection view with rooms, channels, collections, records, and presence

Includes a connection picker sidebar for filtering all views by a specific client, and a registered patterns panel showing exposed channels, records, collections, presence, and commands.

Queue - in-flight count (polled), completed/failed/retried counters (session), event log

Cron - registered jobs with next fire times, fire/error event log

Limits - registered limiters, peek inspector (inspect a key without consuming)

Workflows - registered workflow definitions with interactive graph view, step inspector, retry/timeout metadata

Executions - workflow execution list with filters, live graph overlay showing execution progress, per-step state, output/error inspector, and journal timeline

API

prsmDevtools(options)

Returns an Express Router. Mount it wherever you want.

app.use('/devtools', prsmDevtools(options))

Options

| Option | Type | Description | | --- | --- | --- | | realtime | RealtimeServer | A @prsm/realtime server instance | | queue | Queue | A @prsm/queue instance | | cron | Cron | A @prsm/cron instance | | limit | Object<string, Limiter> | Named limiters from @prsm/limit | | workflow | WorkflowEngine | An @prsm/workflow engine instance |

All options are optional. The dashboard adapts to what's provided.

Endpoints

The middleware exposes these under its mount path:

| Endpoint | Description | | --- | --- | | GET /api/config | Which subsystems are connected | | GET /api/events | SSE stream (queue, cron, workflow, and realtime record updates) | | GET /api/queue | Current in-flight count | | GET /api/cron | Registered jobs with next fire times | | GET /api/limits | List of named limiters | | GET /api/limits/:name/peek/:key | Peek at a limiter key | | GET /api/workflows | Registered workflows with graph data | | GET /api/workflows/describe | One workflow definition | | GET /api/workflow/executions | Workflow executions, filterable by workflow/status | | GET /api/workflow/executions/:id | One workflow execution | | GET /api/realtime/state | Full realtime state snapshot | | GET /api/realtime/connection/:id | Detailed connection info | | GET /api/realtime/room/:name | Room members with metadata and presence | | GET /api/realtime/record/:id | Fetch a record's current value | | GET /api/realtime/collection/:id/records | Resolved records for a collection + connection |

How It Works

The middleware listens to events on the instances you pass and forwards them to connected browsers via Server-Sent Events. Realtime record updates stream live over SSE - when you expand a record in the UI, its value updates in place as it changes on the server. Polling endpoints read current state from the instances' public APIs.

The Vue SPA is pre-built at publish time and served as static files from the same mount point. No build step needed in your project.

No dependencies on any @prsm packages. The middleware reads from whatever objects you give it.

License

MIT