@bpmnkit/operate 0.0.5 → 0.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +9 -21
- package/package.json +53 -45
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 urbanisierung
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
<img src="https://raw.githubusercontent.com/
|
|
2
|
+
<img src="https://raw.githubusercontent.com/bpmnkit/monorepo/main/doc/logos/logo-2-gateway.svg" width="72" height="72" alt="BPMN Kit logo">
|
|
3
3
|
<h1>@bpmnkit/operate</h1>
|
|
4
4
|
<p>Monitoring and operations frontend for Camunda 8 clusters — real-time SSE, zero dependencies</p>
|
|
5
5
|
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
[](https://github.com/bpmnkit/monorepo/blob/main/LICENSE)
|
|
8
8
|
[](https://github.com/bpmnkit/monorepo)
|
|
9
9
|
|
|
10
|
-
[Documentation](https://
|
|
10
|
+
[Website](https://bpmnkit.com) · [Documentation](https://docs.bpmnkit.com) · [GitHub](https://github.com/bpmnkit/monorepo) · [Changelog](https://github.com/bpmnkit/monorepo/blob/main/packages/operate/CHANGELOG.md)
|
|
11
11
|
</div>
|
|
12
12
|
|
|
13
13
|
---
|
|
@@ -25,15 +25,13 @@ A **mock mode** (`mock: true`) ships fixture data without any running proxy or c
|
|
|
25
25
|
- **Dashboard** — real-time stats: active instances, open incidents, active jobs, pending tasks
|
|
26
26
|
- **Process Definitions** — deployed process list with name, version, and tenant
|
|
27
27
|
- **Process Instances** — paginated list with state filter (Active / Completed / Terminated)
|
|
28
|
-
- **Instance Detail** — BPMN canvas via `@bpmnkit/canvas` with live token-highlight overlay
|
|
28
|
+
- **Instance Detail** — BPMN canvas via `@bpmnkit/canvas` with live token-highlight overlay
|
|
29
29
|
- **Incidents** — error type, message, process, and resolution state
|
|
30
30
|
- **Jobs** — job type, worker, retries, state, error message
|
|
31
31
|
- **User Tasks** — name, assignee, state, due date, priority
|
|
32
|
-
- **Profile switcher** — header dropdown
|
|
32
|
+
- **Profile switcher** — header dropdown that switches all SSE streams on change
|
|
33
33
|
- **Mock/demo mode** — fully self-contained fixture data, no cluster required
|
|
34
|
-
- **SSE architecture** — proxy polls server-side; frontend opens one `EventSource` per view, gets pushed updates
|
|
35
34
|
- **Hash router** — `#/`, `#/instances`, `#/instances/:key`, `#/definitions`, etc.
|
|
36
|
-
- **Themeable** — light / dark / auto via `--bpmnkit-*` CSS custom properties from `@bpmnkit/ui`; theme choice persisted to `localStorage`
|
|
37
35
|
|
|
38
36
|
## Installation
|
|
39
37
|
|
|
@@ -69,20 +67,6 @@ createOperate({
|
|
|
69
67
|
})
|
|
70
68
|
```
|
|
71
69
|
|
|
72
|
-
The proxy must be running (`pnpm proxy`) and have at least one profile configured via the `casen` CLI.
|
|
73
|
-
|
|
74
|
-
## How it works
|
|
75
|
-
|
|
76
|
-
```
|
|
77
|
-
Browser ──── EventSource ────▶ @bpmnkit/proxy ──── CamundaClient ────▶ Camunda cluster
|
|
78
|
-
◀─── SSE events ────── (polls on interval, pushes results)
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
1. Each view opens an SSE connection to `/operate/stream?topic=<view>&interval=<ms>`.
|
|
82
|
-
2. The proxy creates a `CamundaClient` using the configured profile's auth credentials.
|
|
83
|
-
3. On each polling tick, the proxy fetches the relevant Camunda data and emits a `{ type: "data", payload }` SSE event.
|
|
84
|
-
4. The store updates and the view re-renders.
|
|
85
|
-
|
|
86
70
|
## API Reference
|
|
87
71
|
|
|
88
72
|
### `createOperate(options)`
|
|
@@ -124,8 +108,12 @@ interface OperateApi {
|
|
|
124
108
|
| [`@bpmnkit/plugins`](https://www.npmjs.com/package/@bpmnkit/plugins) | 22 composable canvas plugins |
|
|
125
109
|
| [`@bpmnkit/api`](https://www.npmjs.com/package/@bpmnkit/api) | Camunda 8 REST API TypeScript client |
|
|
126
110
|
| [`@bpmnkit/ascii`](https://www.npmjs.com/package/@bpmnkit/ascii) | Render BPMN diagrams as Unicode ASCII art |
|
|
111
|
+
| [`@bpmnkit/ui`](https://www.npmjs.com/package/@bpmnkit/ui) | Shared design tokens and UI components |
|
|
127
112
|
| [`@bpmnkit/profiles`](https://www.npmjs.com/package/@bpmnkit/profiles) | Shared auth, profile storage, and client factories for CLI & proxy |
|
|
113
|
+
| [`@bpmnkit/connector-gen`](https://www.npmjs.com/package/@bpmnkit/connector-gen) | Generate connector templates from OpenAPI specs |
|
|
114
|
+
| [`@bpmnkit/cli`](https://www.npmjs.com/package/@bpmnkit/cli) | Camunda 8 command-line interface (casen) |
|
|
115
|
+
| [`@bpmnkit/proxy`](https://www.npmjs.com/package/@bpmnkit/proxy) | Local AI bridge and Camunda API proxy server |
|
|
128
116
|
|
|
129
117
|
## License
|
|
130
118
|
|
|
131
|
-
[MIT](https://github.com/bpmnkit/monorepo/blob/main/LICENSE) ©
|
|
119
|
+
[MIT](https://github.com/bpmnkit/monorepo/blob/main/LICENSE) © BPMN Kit — made by [u11g](https://u11g.com)
|
package/package.json
CHANGED
|
@@ -1,46 +1,54 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
2
|
+
"name": "@bpmnkit/operate",
|
|
3
|
+
"version": "0.0.7",
|
|
4
|
+
"description": "Monitoring and operations frontend for Camunda 8 clusters — real-time SSE, zero dependencies",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./dist/index.js",
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"import": "./dist/index.js"
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
"files": [
|
|
15
|
+
"LICENSE",
|
|
16
|
+
"README.md",
|
|
17
|
+
"dist/**/*.js",
|
|
18
|
+
"dist/**/*.d.ts"
|
|
19
|
+
],
|
|
20
|
+
"dependencies": {
|
|
21
|
+
"@bpmnkit/api": "0.0.10",
|
|
22
|
+
"@bpmnkit/canvas": "0.0.10",
|
|
23
|
+
"@bpmnkit/core": "0.0.10",
|
|
24
|
+
"@bpmnkit/plugins": "0.0.10",
|
|
25
|
+
"@bpmnkit/ui": "0.0.6"
|
|
26
|
+
},
|
|
27
|
+
"keywords": [
|
|
28
|
+
"bpmn",
|
|
29
|
+
"camunda",
|
|
30
|
+
"operate",
|
|
31
|
+
"monitoring",
|
|
32
|
+
"workflow",
|
|
33
|
+
"process-instances",
|
|
34
|
+
"incidents",
|
|
35
|
+
"typescript"
|
|
36
|
+
],
|
|
37
|
+
"license": "MIT",
|
|
38
|
+
"publishConfig": {
|
|
39
|
+
"access": "public"
|
|
40
|
+
},
|
|
41
|
+
"repository": {
|
|
42
|
+
"type": "git",
|
|
43
|
+
"url": "https://github.com/bpmnkit/monorepo"
|
|
44
|
+
},
|
|
45
|
+
"homepage": "https://bpmnkit.com",
|
|
46
|
+
"bugs": {
|
|
47
|
+
"url": "https://github.com/bpmnkit/monorepo/issues"
|
|
48
|
+
},
|
|
49
|
+
"scripts": {
|
|
50
|
+
"build": "tsc",
|
|
51
|
+
"typecheck": "tsc --noEmit",
|
|
52
|
+
"check": "biome check ."
|
|
53
|
+
}
|
|
54
|
+
}
|