@bpmnkit/docspack 0.0.2 → 0.0.3
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/.llms/chunks/cli.casen.aikit-skills.md +2 -2
- package/.llms/chunks/cli.casen.bpmn-generation-pipeline.md +2 -2
- package/.llms/chunks/cli.casen.connection-profiles.md +1 -1
- package/.llms/chunks/cli.casen.generate-bpmn-files.md +3 -3
- package/.llms/chunks/cli.casen.mcp-server-mode.md +31 -0
- package/.llms/chunks/cli.casen.md +1 -1
- package/.llms/chunks/cli.casen.plugins.md +2 -2
- package/.llms/chunks/cli.casen.worker-commands.md +20 -23
- package/.llms/chunks/cli.connector.all-flags.md +1 -1
- package/.llms/chunks/cli.connector.browse-the-bundled-ootb-catalog.md +2 -2
- package/.llms/chunks/cli.connector.built-in-catalog.md +1 -1
- package/.llms/chunks/cli.connector.common-workflows.md +1 -1
- package/.llms/chunks/cli.connector.generate-from-the-openapi-catalog.md +1 -1
- package/.llms/chunks/cli.connector.md +1 -1
- package/.llms/chunks/cli.connector.programmatic-usage.md +2 -2
- package/.llms/chunks/cli.connector.what-gets-generated.md +1 -1
- package/.llms/chunks/cli.generate.definition-mode-ai-scripting-path.md +1 -1
- package/.llms/chunks/cli.generate.md +1 -1
- package/.llms/chunks/cli.generate.modify-existing-mode-input.md +1 -1
- package/.llms/chunks/cli.generate.typical-ai-workflow.md +1 -1
- package/.llms/chunks/cli.plugin-authoring.md +1 -1
- package/.llms/chunks/cli.plugin-authoring.plugin-naming-conventions.md +1 -1
- package/.llms/chunks/cli.plugin-authoring.test-locally.md +1 -1
- package/.llms/chunks/cli.plugin-authoring.the-bpmnkit-cli-sdk-sdk.md +1 -1
- package/.llms/chunks/cli.plugin-authoring.what-gets-generated.md +1 -1
- package/.llms/chunks/cli.plugin-authoring.writing-commands.md +1 -1
- package/.llms/chunks/cli.plugins.bpmnkit-casen-report.md +1 -1
- package/.llms/chunks/cli.plugins.bpmnkit-casen-worker-http.md +2 -2
- package/.llms/chunks/cli.plugins.md +3 -4
- package/.llms/chunks/cli.skills.deploy.md +1 -1
- package/.llms/chunks/cli.skills.implement.md +2 -2
- package/.llms/chunks/cli.skills.md +2 -2
- package/.llms/chunks/cli.skills.no-mcp-server-required.md +1 -1
- package/.llms/chunks/cli.skills.review.md +1 -1
- package/.llms/chunks/cli.skills.test.md +1 -1
- package/.llms/chunks/cli.view.folder-support.md +1 -1
- package/.llms/chunks/cli.view.md +1 -1
- package/.llms/chunks/cli.view.tabbed-navigation.md +1 -1
- package/.llms/chunks/getting-started.concepts.ai-compact-format.md +13 -2
- package/.llms/chunks/getting-started.concepts.auto-layout.md +1 -1
- package/.llms/chunks/getting-started.concepts.parsing-and-serializing.md +49 -9
- package/.llms/chunks/getting-started.concepts.the-fluent-builder.md +1 -1
- package/.llms/chunks/getting-started.concepts.zeebe-extensions.md +1 -1
- package/.llms/chunks/getting-started.installation.md +1 -1
- package/.llms/chunks/getting-started.installation.runtime-requirements.md +1 -1
- package/.llms/chunks/getting-started.installation.svg-canvas-viewer.md +2 -2
- package/.llms/chunks/getting-started.installation.worker-client.md +1 -1
- package/.llms/chunks/getting-started.quick-start.md +1 -1
- package/.llms/chunks/getting-started.quick-start.step-2-simulate-locally.md +1 -1
- package/.llms/chunks/getting-started.quick-start.step-3-deploy-to-camunda-8.md +1 -1
- package/.llms/chunks/getting-started.quick-start.what-s-next.md +8 -9
- package/.llms/chunks/guides.ai-agents.deploy-grade-validation.md +1 -1
- package/.llms/chunks/guides.ai-agents.how-it-s-modeled.md +1 -1
- package/.llms/chunks/guides.ai-agents.md +1 -1
- package/.llms/chunks/guides.ai-agents.see-also.md +3 -3
- package/.llms/chunks/guides.ai-agents.testing-without-a-real-llm-call.md +1 -1
- package/.llms/chunks/guides.ai-agents.the-aiagent-plan-step.md +1 -1
- package/.llms/chunks/guides.ai-implement.deploying.md +2 -2
- package/.llms/chunks/guides.ai-implement.extending-an-existing-process.md +1 -1
- package/.llms/chunks/guides.ai-implement.lightweight-alternative-casen-skills-install.md +2 -2
- package/.llms/chunks/guides.ai-implement.md +2 -2
- package/.llms/chunks/guides.ai-implement.the-claude-code-plugin.md +2 -2
- package/.llms/chunks/guides.ai.claude-api-example.md +1 -1
- package/.llms/chunks/guides.ai.mcp-server.md +1 -1
- package/.llms/chunks/guides.ai.md +25 -2
- package/.llms/chunks/guides.ai.minimal-empty-diagram.md +1 -1
- package/.llms/chunks/guides.ai.openai-function-calling.md +1 -1
- package/.llms/chunks/guides.building-processes.boundary-events.md +1 -1
- package/.llms/chunks/guides.building-processes.call-activities.md +1 -1
- package/.llms/chunks/guides.building-processes.events.md +1 -1
- package/.llms/chunks/guides.building-processes.multi-instance.md +1 -1
- package/.llms/chunks/guides.building-processes.service-tasks.md +1 -1
- package/.llms/chunks/guides.building-processes.sub-processes.md +1 -1
- package/.llms/chunks/guides.building-processes.task-defaults.md +1 -1
- package/.llms/chunks/guides.claude-code-plugin.ambient-hooks.md +1 -1
- package/.llms/chunks/guides.claude-code-plugin.configuration.md +3 -3
- package/.llms/chunks/guides.claude-code-plugin.md +1 -1
- package/.llms/chunks/guides.claude-code-plugin.reference-docs.md +1 -1
- package/.llms/chunks/guides.deployment.ci-cd-deploy-on-push.md +1 -1
- package/.llms/chunks/guides.deployment.deploying-a-process.md +1 -1
- package/.llms/chunks/guides.deployment.handling-jobs.md +1 -1
- package/.llms/chunks/guides.deployment.managing-incidents.md +1 -1
- package/.llms/chunks/guides.deployment.md +1 -1
- package/.llms/chunks/guides.gateways.branching-inside-sub-processes.md +1 -1
- package/.llms/chunks/guides.gateways.exclusive-gateway-xor.md +1 -1
- package/.llms/chunks/guides.gateways.inclusive-gateway-or.md +1 -1
- package/.llms/chunks/guides.gateways.nested-branching.md +1 -1
- package/.llms/chunks/guides.gateways.parallel-gateway-and.md +1 -1
- package/.llms/chunks/guides.patterns.how-matching-works.md +1 -1
- package/.llms/chunks/guides.patterns.md +1 -1
- package/.llms/chunks/guides.patterns.pattern-schema.md +1 -1
- package/.llms/chunks/guides.patterns.see-also.md +2 -2
- package/.llms/chunks/guides.patterns.using-patterns-from-the-cli.md +1 -1
- package/.llms/chunks/guides.patterns.what-a-pattern-contains.md +1 -1
- package/.llms/chunks/guides.simulation.dmn-decision-evaluation.md +1 -1
- package/.llms/chunks/guides.simulation.instance-state.md +1 -1
- package/.llms/chunks/guides.simulation.md +1 -1
- package/.llms/chunks/guides.simulation.message-correlation.md +1 -1
- package/.llms/chunks/guides.simulation.multiple-deployments.md +1 -1
- package/.llms/chunks/guides.workers-standalone.anatomy-of-a-worker.md +1 -1
- package/.llms/chunks/guides.workers-standalone.camunda-saas.md +1 -1
- package/.llms/chunks/guides.workers-standalone.environment-variables.md +1 -1
- package/.llms/chunks/guides.workers-standalone.md +1 -1
- package/.llms/chunks/guides.workers-standalone.running-workers.md +1 -1
- package/.llms/chunks/guides.workers-standalone.see-also.md +3 -3
- package/.llms/chunks/packages.api.incident-resolution.md +1 -1
- package/.llms/chunks/packages.api.observability-events.md +1 -1
- package/.llms/chunks/packages.api.overview.md +1 -1
- package/.llms/chunks/packages.api.process-operations.md +1 -1
- package/.llms/chunks/packages.api.resource-namespaces.md +1 -1
- package/.llms/chunks/packages.canvas.events.md +1 -1
- package/.llms/chunks/packages.canvas.options.md +1 -1
- package/.llms/chunks/packages.canvas.overview.md +1 -1
- package/.llms/chunks/packages.connector-gen.body-expansion.md +1 -1
- package/.llms/chunks/packages.connector-gen.catalog-reference.md +1 -1
- package/.llms/chunks/packages.connector-gen.catalogentry-type.md +2 -2
- package/.llms/chunks/packages.connector-gen.generating-from-the-catalog.md +1 -1
- package/.llms/chunks/packages.connector-gen.installation.md +1 -1
- package/.llms/chunks/packages.connector-gen.lower-level-api.md +1 -1
- package/.llms/chunks/packages.connector-gen.overview.md +1 -1
- package/.llms/chunks/packages.connector-gen.writeoptions.md +1 -1
- package/.llms/chunks/packages.core.dmn-support.md +1 -1
- package/.llms/chunks/packages.core.installation-applybpmnoperations-definitions-operations-options.md +23 -0
- package/.llms/chunks/packages.core.installation-bpmn.continueprocess-definitions-processid.md +45 -0
- package/.llms/chunks/packages.core.installation-bpmn.creatediagram-id.md +1 -1
- package/.llms/chunks/packages.core.installation-bpmn.createprocess-id-name.md +1 -1
- package/.llms/chunks/packages.core.installation-bpmn.export-definitions.md +1 -1
- package/.llms/chunks/packages.core.installation-bpmn.makeempty-processid-processname.md +1 -1
- package/.llms/chunks/packages.core.installation-bpmn.parse-xml.md +1 -1
- package/.llms/chunks/packages.core.installation-bpmn.sample_xml.md +1 -1
- package/.llms/chunks/packages.core.installation-compactify-definitions.md +6 -3
- package/.llms/chunks/packages.core.installation-diagrambuilder-collaborations.md +35 -0
- package/.llms/chunks/packages.core.installation-diffsemantics-before-after.md +15 -0
- package/.llms/chunks/packages.core.installation-ensurezeebeextension-owner-extension.md +32 -0
- package/.llms/chunks/packages.core.installation-expand-compact.md +4 -2
- package/.llms/chunks/packages.core.installation-joins-inferred-by-default-or-declared.md +28 -0
- package/.llms/chunks/packages.core.installation-layoutprocess-process.md +1 -1
- package/.llms/chunks/packages.core.installation-processbuilder-methods.md +2 -2
- package/.llms/chunks/packages.core.installation-projectsemantics-definitions.md +7 -0
- package/.llms/chunks/packages.core.installation-reconcilecompact-definitions-compact-options.md +12 -0
- package/.llms/chunks/packages.core.installation-semantichash-definitions.md +23 -0
- package/.llms/chunks/packages.core.installation.md +1 -1
- package/.llms/chunks/packages.core.overview.md +2 -2
- package/.llms/chunks/packages.core.writing-files-bpmnkit-core-node.md +43 -0
- package/.llms/chunks/packages.docspack.installation.md +2 -2
- package/.llms/chunks/packages.docspack.overview.md +1 -1
- package/.llms/chunks/packages.docspack.reading-it-yourself.md +1 -1
- package/.llms/chunks/packages.docspack.trust.md +1 -1
- package/.llms/chunks/packages.docspack.using-the-index-directly.md +2 -2
- package/.llms/chunks/packages.editor.basic-setup.md +1 -1
- package/.llms/chunks/packages.editor.full-editor-with-all-plugins.md +1 -1
- package/.llms/chunks/packages.editor.hud-options.md +1 -1
- package/.llms/chunks/packages.editor.overview.md +1 -1
- package/.llms/chunks/packages.engine.installation.md +1 -1
- package/.llms/chunks/packages.engine.overview.md +1 -1
- package/.llms/chunks/packages.engine.processinstance.md +1 -1
- package/.llms/chunks/packages.engine.variable-scoping.md +1 -1
- package/.llms/chunks/packages.worker-client.client.poll-jobtype-options.md +1 -1
- package/.llms/chunks/packages.worker-client.createworkerclient-options.md +1 -1
- package/.llms/chunks/packages.worker-client.job.complete-variables.md +1 -1
- package/.llms/chunks/packages.worker-client.md +1 -1
- package/.llms/chunks/packages.worker-client.oauth2-camunda-saas.md +1 -1
- package/.llms/chunks/packages.worker-client.see-also.md +3 -3
- package/.llms/manifest.json +270 -59
- package/README.md +1 -1
- package/dist/chunk.js +1 -1
- package/llms.txt +64 -53
- package/package.json +3 -3
|
@@ -13,7 +13,7 @@ casen skills install
|
|
|
13
13
|
| `/test <path>` | Run scenario tests and report path/branch coverage |
|
|
14
14
|
| `/deploy <path>` | Deploy-readiness gate, then deploy to local Reebe or Camunda 8 |
|
|
15
15
|
|
|
16
|
-
For the richer skill set (`/bpmnkit:implement`, `:extend`, `:agent`, `:connect`, plus generated reference docs), install the Claude Code plugin instead: `/plugin marketplace add github:bpmnkit/monorepo` then `/plugin install bpmnkit`. See [AIKit Skills](/cli/skills
|
|
16
|
+
For the richer skill set (`/bpmnkit:implement`, `:extend`, `:agent`, `:connect`, plus generated reference docs), install the Claude Code plugin instead: `/plugin marketplace add github:bpmnkit/monorepo` then `/plugin install bpmnkit`. See [AIKit Skills](/docs/cli/skills) for full documentation.
|
|
17
17
|
|
|
18
18
|
---
|
|
19
|
-
Source: https://
|
|
19
|
+
Source: https://bpmnkit.com/docs/cli/casen
|
|
@@ -26,7 +26,7 @@ casen deploy deploy order-process.bpmn --target camunda8 # active Camunda 8 prof
|
|
|
26
26
|
|
|
27
27
|
`casen synth` reports any problems keyed by JSON path in the plan (e.g. `steps[2].connector.values.token`) — fix the plan, never the XML, and re-run. If the plan has a `tests` array, `casen synth` also writes a `<file>.bpmn.tests.json` sidecar, runnable with `casen test <file>.bpmn`.
|
|
28
28
|
|
|
29
|
-
See [Building Processes with AI](/guides/ai-implement
|
|
29
|
+
See [Building Processes with AI](/docs/guides/ai-implement) and [AI Agents](/docs/guides/ai-agents) for full walkthroughs.
|
|
30
30
|
|
|
31
31
|
---
|
|
32
|
-
Source: https://
|
|
32
|
+
Source: https://bpmnkit.com/docs/cli/casen
|
|
@@ -9,7 +9,7 @@ casen generate bpmn --input order.bpmn --dump-compact # inspect as JSON for AI
|
|
|
9
9
|
casen generate bpmn --input order.bpmn --patch '{"elements":[...],"flows":[...]}'
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
See [casen generate](/cli/generate
|
|
12
|
+
See [casen generate](/docs/cli/generate) for full documentation.
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
## View BPMN, DMN, and Form files
|
|
@@ -22,7 +22,7 @@ casen view dmn routing.dmn # DMN decision table
|
|
|
22
22
|
casen view open ./project/ # any mix of .bpmn/.dmn/.form
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
See [casen view](/cli/view
|
|
25
|
+
See [casen view](/docs/cli/view) for full documentation.
|
|
26
26
|
|
|
27
27
|
---
|
|
28
|
-
Source: https://
|
|
28
|
+
Source: https://bpmnkit.com/docs/cli/casen
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# casen CLI — MCP Server Mode
|
|
2
|
+
|
|
3
|
+
`casen` can act as an MCP (Model Context Protocol) server, exposing all cluster operations
|
|
4
|
+
as tools to Claude Desktop, Cursor, or any MCP client:
|
|
5
|
+
|
|
6
|
+
```sh
|
|
7
|
+
casen mcp
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
Configure in Claude Desktop (`claude_desktop_config.json`):
|
|
11
|
+
|
|
12
|
+
```json
|
|
13
|
+
{
|
|
14
|
+
"mcpServers": {
|
|
15
|
+
"camunda": {
|
|
16
|
+
"command": "casen",
|
|
17
|
+
"args": ["mcp"],
|
|
18
|
+
"env": {
|
|
19
|
+
"CAMUNDA_CLIENT_ID": "...",
|
|
20
|
+
"CAMUNDA_CLIENT_SECRET": "..."
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Now you can ask Claude: _"Show me the open incidents on the invoice-approval process"_ or
|
|
28
|
+
_"Resolve all incidents on process instance 2251799813685249"_.
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
Source: https://bpmnkit.com/docs/cli/casen
|
|
@@ -50,7 +50,7 @@ casen plugin remove casen-deploy
|
|
|
50
50
|
|
|
51
51
|
Once installed, plugin commands appear in the main TUI and in tab-completion alongside built-in commands.
|
|
52
52
|
|
|
53
|
-
To build your own plugin, see [Plugin Authoring](/cli/plugin-authoring
|
|
53
|
+
To build your own plugin, see [Plugin Authoring](/docs/cli/plugin-authoring).
|
|
54
54
|
|
|
55
55
|
---
|
|
56
|
-
Source: https://
|
|
56
|
+
Source: https://bpmnkit.com/docs/cli/casen
|
|
@@ -12,34 +12,31 @@ casen worker start send-invoice
|
|
|
12
12
|
```
|
|
13
13
|
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Local engine (Reebe)
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
17
|
+
Reebe is a Zeebe-compatible workflow engine (~50 MB) that runs locally, so you can deploy
|
|
18
|
+
and run processes without a Camunda 8 cluster.
|
|
19
19
|
|
|
20
20
|
```sh
|
|
21
|
-
|
|
22
|
-
|
|
21
|
+
# Embedded SQLite, no external database
|
|
22
|
+
casen reebe start
|
|
23
|
+
|
|
24
|
+
# Custom port — match ZEEBE_ADDRESS, which defaults to http://localhost:26500
|
|
25
|
+
casen reebe start --port 26500
|
|
23
26
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
```json
|
|
27
|
-
{
|
|
28
|
-
"mcpServers": {
|
|
29
|
-
"camunda": {
|
|
30
|
-
"command": "casen",
|
|
31
|
-
"args": ["mcp"],
|
|
32
|
-
"env": {
|
|
33
|
-
"CAMUNDA_CLIENT_ID": "...",
|
|
34
|
-
"CAMUNDA_CLIENT_SECRET": "..."
|
|
35
|
-
}
|
|
36
|
-
}
|
|
37
|
-
}
|
|
38
|
-
}
|
|
27
|
+
# PostgreSQL instead of the embedded database
|
|
28
|
+
casen reebe start --database-url postgres://user:pass@localhost/reebe
|
|
39
29
|
```
|
|
40
30
|
|
|
41
|
-
|
|
42
|
-
|
|
31
|
+
| Flag | Default | Description |
|
|
32
|
+
|---|---|---|
|
|
33
|
+
| `--port` | `8080` | HTTP port to listen on |
|
|
34
|
+
| `--database-url` | embedded SQLite | PostgreSQL connection URL |
|
|
35
|
+
| `--config` | `config.toml` | Path to the engine config file |
|
|
36
|
+
|
|
37
|
+
`casen reebe` on its own is shorthand for `casen reebe start`. The command runs the
|
|
38
|
+
`reebe-server` binary; build it with
|
|
39
|
+
`cargo install --path apps/reebe/crates/reebe-server` if it is not on your `PATH`.
|
|
43
40
|
|
|
44
41
|
---
|
|
45
|
-
Source: https://
|
|
42
|
+
Source: https://bpmnkit.com/docs/cli/casen
|
|
@@ -8,7 +8,7 @@ casen connector show io.camunda.connectors.Slack.v1
|
|
|
8
8
|
`search` scores the 116 bundled templates by keyword match and prints a table (template id,
|
|
9
9
|
direction, task type, description). `show` prints a template's task type, direction, and its
|
|
10
10
|
required/optional input keys — these are the keys a `ProcessPlan` `connector` step's `values`
|
|
11
|
-
object uses (see [Building Processes with AI](/guides/ai-implement
|
|
11
|
+
object uses (see [Building Processes with AI](/docs/guides/ai-implement)):
|
|
12
12
|
|
|
13
13
|
```
|
|
14
14
|
$ casen connector show io.camunda.connectors.Slack.v1
|
|
@@ -29,4 +29,4 @@ credential. This is the same catalog `@bpmnkit/connectors`' `listConnectors()`/`
|
|
|
29
29
|
expose programmatically.
|
|
30
30
|
|
|
31
31
|
---
|
|
32
|
-
Source: https://
|
|
32
|
+
Source: https://bpmnkit.com/docs/cli/connector
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# casen connector — Programmatic usage
|
|
2
2
|
|
|
3
3
|
The underlying generator is available as a standalone package for use in Node.js scripts and build
|
|
4
|
-
pipelines. See [`@bpmnkit/connector-gen`](/packages/connector-gen
|
|
4
|
+
pipelines. See [`@bpmnkit/connector-gen`](/docs/packages/connector-gen).
|
|
5
5
|
|
|
6
6
|
---
|
|
7
|
-
Source: https://
|
|
7
|
+
Source: https://bpmnkit.com/docs/cli/connector
|
|
@@ -17,4 +17,4 @@ Import the generated `.json` files into Camunda Modeler via
|
|
|
17
17
|
**File → Import Element Templates** or by placing them in your `.camunda/element-templates/` directory.
|
|
18
18
|
|
|
19
19
|
---
|
|
20
|
-
Source: https://
|
|
20
|
+
Source: https://bpmnkit.com/docs/cli/connector
|
|
@@ -17,7 +17,7 @@ casen plugin install @bpmnkit/casen-worker-http
|
|
|
17
17
|
|
|
18
18
|
## Authoring Plugins
|
|
19
19
|
|
|
20
|
-
See the [Plugin Authoring](/cli/plugin-authoring
|
|
20
|
+
See the [Plugin Authoring](/docs/cli/plugin-authoring) guide to build and publish your own `casen` plugin.
|
|
21
21
|
|
|
22
22
|
---
|
|
23
|
-
Source: https://
|
|
23
|
+
Source: https://bpmnkit.com/docs/cli/plugins
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
# casen Plugins
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
:::
|
|
3
|
+
> **Auto-generated** — this page is built from `plugins-cli/*/package.json` during the site
|
|
4
|
+
> build. Do not edit it by hand.
|
|
6
5
|
|
|
7
6
|
Official plugins extend `casen` with domain-specific command groups. Install them with:
|
|
8
7
|
|
|
@@ -22,4 +21,4 @@ casen plugin install <name>
|
|
|
22
21
|
---
|
|
23
22
|
|
|
24
23
|
---
|
|
25
|
-
Source: https://
|
|
24
|
+
Source: https://bpmnkit.com/docs/cli/plugins
|
|
@@ -28,9 +28,9 @@ Tests: 3/3 passed
|
|
|
28
28
|
Deploy to local Reebe, deploy to Camunda 8, or skip?
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
See [Building Processes with AI](/guides/ai-implement
|
|
31
|
+
See [Building Processes with AI](/docs/guides/ai-implement) for a full walkthrough.
|
|
32
32
|
|
|
33
33
|
---
|
|
34
34
|
|
|
35
35
|
---
|
|
36
|
-
Source: https://
|
|
36
|
+
Source: https://bpmnkit.com/docs/cli/skills
|
|
@@ -6,7 +6,7 @@ They drive `casen` directly (no MCP server, no proxy daemon).
|
|
|
6
6
|
|
|
7
7
|
For the full skill set — `/bpmnkit:implement`, `:extend`, `:agent`, `:connect`, plus generated
|
|
8
8
|
reference docs the skills read before authoring a plan — install the
|
|
9
|
-
[Claude Code plugin](/guides/ai-implement
|
|
9
|
+
[Claude Code plugin](/docs/guides/ai-implement#the-claude-code-plugin) instead.
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
## Installation
|
|
@@ -26,4 +26,4 @@ casen skills install --force
|
|
|
26
26
|
---
|
|
27
27
|
|
|
28
28
|
---
|
|
29
|
-
Source: https://
|
|
29
|
+
Source: https://bpmnkit.com/docs/cli/skills
|
|
@@ -3,4 +3,4 @@
|
|
|
3
3
|
These skills are plain Bash + Read/Write — they call `casen` directly and never depend on an MCP server or a running proxy. The `@bpmnkit/proxy` MCP server (`bpmn-aikit`) still exists separately, for Claude Desktop/Cursor or other MCP-only hosts — it's unrelated to these slash commands.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
|
-
Source: https://
|
|
6
|
+
Source: https://bpmnkit.com/docs/cli/skills
|
package/.llms/chunks/cli.view.md
CHANGED
|
@@ -16,8 +16,19 @@ const restored = expand(compact);
|
|
|
16
16
|
The compact format is designed for AI agents:
|
|
17
17
|
- Every element has an `id` and a human-readable `name`
|
|
18
18
|
- Sequence flows are represented as `{ from, to, condition? }` pairs
|
|
19
|
-
- Zeebe extensions (task type,
|
|
19
|
+
- Common Zeebe extensions (task type, headers, form and decision bindings) are inlined
|
|
20
20
|
- The full diagram of a typical approval workflow fits in ~500 tokens
|
|
21
21
|
|
|
22
|
+
> **`compactify()` is a lossy view, not a round trip.** `CompactElement` models about fifteen
|
|
23
|
+
> properties, so `expand(compactify(definitions))` is not `definitions`: collaborations,
|
|
24
|
+
> participants, message flows, lanes, data stores, artifacts, root-level messages and errors,
|
|
25
|
+
> multi-instance loop characteristics, full `zeebe:ioMapping` entries and most diagram
|
|
26
|
+
> interchange do not survive it.
|
|
27
|
+
>
|
|
28
|
+
> Use it to **show** a model to an LLM and to build a **new** model from one. Do not use it as
|
|
29
|
+
> an edit path for a file you need to keep — read the file, apply the change to the
|
|
30
|
+
> `BpmnDefinitions`, and export that. For the same reason `casen generate bpmn --input`
|
|
31
|
+
> refuses to overwrite its input unless you pass `--force`.
|
|
32
|
+
|
|
22
33
|
---
|
|
23
|
-
Source: https://
|
|
34
|
+
Source: https://bpmnkit.com/docs/getting-started/concepts
|
|
@@ -21,4 +21,4 @@ Under the hood, the layout algorithm:
|
|
|
21
21
|
You can access element sizes via the `ELEMENT_SIZES` export if you need to build custom layouts.
|
|
22
22
|
|
|
23
23
|
---
|
|
24
|
-
Source: https://
|
|
24
|
+
Source: https://bpmnkit.com/docs/getting-started/concepts
|
|
@@ -1,17 +1,16 @@
|
|
|
1
1
|
# Core Concepts — Parsing and Serializing
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Parse BPMN 2.0 XML into a typed object, modify it in TypeScript, and export it back:
|
|
4
4
|
|
|
5
5
|
```typescript
|
|
6
|
-
import { Bpmn } from "@bpmnkit/core";
|
|
6
|
+
import { Bpmn, findProcess } from "@bpmnkit/core";
|
|
7
7
|
|
|
8
8
|
// Parse XML into a typed object
|
|
9
9
|
const definitions = Bpmn.parse(xmlString);
|
|
10
10
|
|
|
11
|
-
// Access the first process
|
|
12
|
-
const process = definitions.
|
|
13
|
-
|
|
14
|
-
);
|
|
11
|
+
// Access the first process, or look one up by id
|
|
12
|
+
const process = definitions.processes[0];
|
|
13
|
+
const approval = findProcess(definitions, "approval-flow");
|
|
15
14
|
|
|
16
15
|
// Export back to XML
|
|
17
16
|
const newXml = Bpmn.export(definitions);
|
|
@@ -19,8 +18,49 @@ const newXml = Bpmn.export(definitions);
|
|
|
19
18
|
|
|
20
19
|
### Round-trip fidelity
|
|
21
20
|
|
|
22
|
-
|
|
23
|
-
|
|
21
|
+
`Bpmn.parse()` → `Bpmn.export()` preserves the document. Content the SDK models round-trips
|
|
22
|
+
through its typed fields; content it does not model is kept verbatim and re-emitted:
|
|
23
|
+
|
|
24
|
+
- **Unmodelled attributes** land in `unknownAttributes` on the element that carried them.
|
|
25
|
+
- **Unmodelled children** of `definitions`, a `process`, a `collaboration`, a flow node, a
|
|
26
|
+
`multiInstanceLoopCharacteristics` or a data association land in `unknownChildren` — so
|
|
27
|
+
`bpmn:import`, `bpmn:itemDefinition`, `bpmn:ioSpecification`, `bpmn:correlationKey`,
|
|
28
|
+
`bpmn:potentialOwner`, `bpmn:complexBehaviorDefinition` and vendor elements outside
|
|
29
|
+
`extensionElements` all survive, including their nested content.
|
|
30
|
+
- **`extensionElements`** are kept as raw `XmlElement` trees wherever BPMN allows them,
|
|
31
|
+
including on root-level `message`, `error`, `escalation` and `signal` elements — which is
|
|
32
|
+
what carries `zeebe:subscription` correlation keys.
|
|
33
|
+
|
|
34
|
+
`semanticHash(definitions)` gives you this as a check you can run yourself: it hashes the
|
|
35
|
+
model with the diagram excluded, so `semanticHash(applyAutoLayout(defs))` equals
|
|
36
|
+
`semanticHash(defs)`, and any difference means the model changed rather than the layout.
|
|
37
|
+
|
|
38
|
+
A corpus of BPMN documents is round-tripped on every build and compared structurally —
|
|
39
|
+
element counts, per-element attribute names, parent/child nesting and text content — by a
|
|
40
|
+
scanner written independently of the parser, so a regression fails CI rather than reaching a
|
|
41
|
+
release. See `packages/core/tests/roundtrip-corpus.test.ts`.
|
|
42
|
+
|
|
43
|
+
A second gate works from the other direction. The corpus can only find losses in documents
|
|
44
|
+
somebody wrote; this one asks the BPMN, DI and Zeebe schema descriptors what exists at all,
|
|
45
|
+
builds a document containing each of the 151 types they define, and requires it to come back
|
|
46
|
+
out — as a typed field or verbatim. A descriptor bump that widens the specification fails the
|
|
47
|
+
build instead of quietly widening the loss. See
|
|
48
|
+
`packages/core/tests/descriptor-coverage.test.ts`, or run
|
|
49
|
+
`pnpm --filter @bpmnkit/core check:descriptors` for the report.
|
|
50
|
+
|
|
51
|
+
**Deliberate normalisations.** The output is not byte-identical to the input, and two rewrites
|
|
52
|
+
are intentional:
|
|
53
|
+
|
|
54
|
+
- `isExecutable="false"` and `isSequential="false"` are written only when true. BPMN treats
|
|
55
|
+
the absent attribute as false, so this is stable and changes nothing.
|
|
56
|
+
- Empty `<extensionElements/>` elements are dropped, and whitespace and attribute order are
|
|
57
|
+
not preserved.
|
|
58
|
+
|
|
59
|
+
**Still not preserved.** Unmodelled *children* are captured on the containers listed above
|
|
60
|
+
only. On other elements — lanes, artifacts, root-level messages and errors —
|
|
61
|
+
`documentation` and `extensionElements` round-trip, but any other unrecognised child does
|
|
62
|
+
not. A second `<documentation>` on the same element is also dropped;
|
|
63
|
+
only the first is kept. If you need one of these, open an issue rather than working around it.
|
|
24
64
|
|
|
25
65
|
---
|
|
26
|
-
Source: https://
|
|
66
|
+
Source: https://bpmnkit.com/docs/getting-started/concepts
|
|
@@ -35,7 +35,7 @@ casen reebe # start local workflow engine
|
|
|
35
35
|
|
|
36
36
|
Then in Claude Code: `/implement an invoice approval process`
|
|
37
37
|
|
|
38
|
-
See [AI-Driven Implementation](/guides/ai-implement
|
|
38
|
+
See [AI-Driven Implementation](/docs/guides/ai-implement) for a full walkthrough.
|
|
39
39
|
|
|
40
40
|
---
|
|
41
|
-
Source: https://
|
|
41
|
+
Source: https://bpmnkit.com/docs/getting-started/installation
|
|
@@ -28,4 +28,4 @@ console.log(xml); // valid BPMN 2.0 XML
|
|
|
28
28
|
The `xml` string is a complete, valid BPMN 2.0 document that any standards-compliant engine can load.
|
|
29
29
|
|
|
30
30
|
---
|
|
31
|
-
Source: https://
|
|
31
|
+
Source: https://bpmnkit.com/docs/getting-started/quick-start
|
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
# Quick Start — What's next?
|
|
2
2
|
|
|
3
|
-
- [AI-Driven Implementation](/guides/ai-implement
|
|
4
|
-
- [Core Concepts](/getting-started/concepts
|
|
5
|
-
- [Building Processes](/guides/building-processes
|
|
6
|
-
- [Gateways & Branching](/guides/gateways
|
|
3
|
+
- [AI-Driven Implementation](/docs/guides/ai-implement) — let Claude implement processes end-to-end from a description
|
|
4
|
+
- [Core Concepts](/docs/getting-started/concepts) — understand how the builder, layout, and roundtrip work
|
|
5
|
+
- [Building Processes](/docs/guides/building-processes) — tasks, events, sub-processes, and markers
|
|
6
|
+
- [Gateways & Branching](/docs/guides/gateways) — exclusive, parallel, and event-based gateways
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
:::
|
|
8
|
+
> **AI-first workflow** — if you have Claude Code, the fastest path is `casen skills install`
|
|
9
|
+
> then `/implement <description>`. Claude generates the BPMN, scaffolds workers, and deploys —
|
|
10
|
+
> all from a single prompt.
|
|
12
11
|
|
|
13
12
|
---
|
|
14
|
-
Source: https://
|
|
13
|
+
Source: https://bpmnkit.com/docs/getting-started/quick-start
|