Installation

BPMN SDK is a collection of focused packages. Install only what you need.

Core SDK

The @bpmn-sdk/core package is the foundation — it provides the fluent process builder, BPMN 2.0 parser/serializer, auto-layout, and the AI-compact format.

pnpm add @bpmn-sdk/core
# or
npm install @bpmn-sdk/core
# or
yarn add @bpmn-sdk/core

Simulation Engine

To run BPMN processes locally (browser or Node.js):

pnpm add @bpmn-sdk/engine

Camunda 8 REST API Client

To interact with a live Camunda 8 cluster:

pnpm add @bpmn-sdk/api

SVG Canvas Viewer

To embed an interactive BPMN diagram viewer in a web page:

pnpm add @bpmn-sdk/canvas

Full Editor

The editor bundles the canvas, a properties panel, and an AI bridge:

pnpm add @bpmn-sdk/editor

CLI

The casen CLI is a standalone tool — install it globally:

pnpm add -g casen

TypeScript Requirements

All packages require TypeScript 5.0+ with strict: true. The recommended tsconfig.json settings:

{
  "compilerOptions": {
    "strict": true,
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "target": "ES2022"
  }
}

For browser/bundler projects (Vite, Webpack, etc.), use:

{
  "compilerOptions": {
    "strict": true,
    "module": "ESNext",
    "moduleResolution": "bundler"
  }
}

Runtime Requirements

Runtime	Minimum Version
Node.js	20 LTS
Deno	1.40+
Bun	1.0+
Browsers	ES2022 (Chrome 94, Firefox 93, Safari 15.4)

All packages are ESM-only ("type": "module"). CommonJS is not supported.