Skip to content

About

Runtime host for Escalated plugins — JSON-RPC subprocess bridge

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Escalated

Escalated Plugin Runtime

The Node.js process that runs Escalated plugins.
Your backend's bridge starts it and talks to it over JSON-RPC 2.0 on stdio.

Website · Docs · Cloud · Releases


A plugin written with the Plugin SDK is all the runtime needs:

import { definePlugin } from '@escalated-dev/plugin-sdk'

export default definePlugin({
  name: 'my-plugin',
  version: '1.0.0',

  actions: {
    'ticket.created': async (event, ctx) => {
      ctx.log.info('New ticket!', event)
    },
  },
})

What it does

Runs every installed plugin in one process

It finds plugins in node_modules/@escalated-dev/plugin-*, routes hooks to them, and proxies their ctx.* calls back to your backend.

Never takes the helpdesk down with it

Your backend's bridge starts it on the first hook and restarts it with backoff after a crash. While it is down, filters return values unchanged.

Features

Loading

  • Discovers @escalated-dev/plugin-* packages
  • Started by your backend's bridge
  • Spawned lazily on first hook

Dispatch

  • Actions, filters, endpoints, webhooks
  • Cron jobs and widget badges
  • Activate and deactivate calls

Resilience (via the bridge)

  • Restarts with exponential backoff
  • Actions degrade when it is unavailable
  • Filters pass values through when down

Protocol

  • JSON-RPC 2.0 over stdin and stdout
  • Concurrent host calls
  • host_call_id on every ctx.* call

Active plugins

  • Runs only plugins the host lists
  • Older hosts run every loaded plugin

Real-time

  • Forwards broadcast events as action hooks
  • No extra plugin configuration

Every feature in detail

Node.js TypeScript JSON-RPC 2.0

Quick start

npm install @escalated-dev/plugin-runtime

Install it next to the plugins you want to use. Your backend's bridge spawns it, so you don't run it yourself. See installation and usage.

Learn more

License

MIT. Copyright (c) Escalated.dev. See LICENSE.

About

Runtime host for Escalated plugins — JSON-RPC subprocess bridge

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages