@bpmnkit/docspack 0.0.2 → 0.0.4
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.diff.flags.md +46 -0
- package/.llms/chunks/cli.diff.md +43 -0
- package/.llms/chunks/cli.diff.the-same-diff-elsewhere.md +14 -0
- 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 +67 -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.drop.md +12 -0
- package/.llms/chunks/guides.drop.reviewing-it-together.md +45 -0
- package/.llms/chunks/guides.drop.running-your-own.md +21 -0
- package/.llms/chunks/guides.drop.sharing-a-file.md +42 -0
- package/.llms/chunks/guides.drop.what-drop-is-not.md +12 -0
- 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.vscode.commands.md +14 -0
- package/.llms/chunks/guides.vscode.installing.md +22 -0
- package/.llms/chunks/guides.vscode.md +13 -0
- package/.llms/chunks/guides.vscode.settings.md +19 -0
- package/.llms/chunks/guides.vscode.support.md +11 -0
- package/.llms/chunks/guides.vscode.what-it-does-a-feel-playground-on-your-selection.md +8 -0
- package/.llms/chunks/guides.vscode.what-it-does-a-visual-diff-in-source-control.md +11 -0
- package/.llms/chunks/guides.vscode.what-it-does-copy-the-diagram-as-text.md +8 -0
- package/.llms/chunks/guides.vscode.what-it-does-deploy-against-your-own-clusters.md +21 -0
- package/.llms/chunks/guides.vscode.what-it-does-editing-that-leaves-a-readable-diff.md +22 -0
- package/.llms/chunks/guides.vscode.what-it-does-findings-in-the-problems-panel.md +13 -0
- package/.llms/chunks/guides.vscode.what-it-does-preview-beside-the-source.md +12 -0
- package/.llms/chunks/guides.vscode.what-it-does-run-the-diagram-in-the-editor.md +9 -0
- 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-ad-hoc-sub-processes-children-are-a-set-not-a-chain.md +42 -0
- 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 +11 -3
- package/.llms/chunks/packages.core.installation-createflowelement-id-type-options.md +7 -0
- package/.llms/chunks/packages.core.installation-diagrambuilder-collaborations.md +35 -0
- package/.llms/chunks/packages.core.installation-diffdiagram-before-after.md +33 -0
- package/.llms/chunks/packages.core.installation-diffsemantics-before-after.md +15 -0
- package/.llms/chunks/packages.core.installation-element-catalog.md +10 -0
- package/.llms/chunks/packages.core.installation-ensurezeebeextension-owner-extension.md +32 -0
- package/.llms/chunks/packages.core.installation-expand-compact.md +8 -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 +17 -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-retypeelement-element-type.md +20 -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-exportpreserving-original-definitions.md +51 -0
- package/.llms/chunks/packages.core.writing-files-bpmnkit-core-node-writebpmn-definitions-options.md +38 -0
- package/.llms/chunks/packages.core.writing-files-bpmnkit-core-node.md +7 -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 +699 -60
- package/README.md +2 -1
- package/dist/chunk.js +1 -1
- package/llms.txt +92 -53
- package/package.json +3 -3
|
@@ -23,4 +23,4 @@ them entirely when nothing relevant matches.
|
|
|
23
23
|
| `order-fulfillment` | E-commerce / supply chain | Inventory validation, payment, warehouse order, shipment tracking |
|
|
24
24
|
|
|
25
25
|
---
|
|
26
|
-
Source: https://
|
|
26
|
+
Source: https://bpmnkit.com/docs/guides/patterns
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Pattern Library — See also
|
|
2
2
|
|
|
3
|
-
- [Building Processes with AI](/guides/ai-implement
|
|
3
|
+
- [Building Processes with AI](/docs/guides/ai-implement) — how Claude uses patterns during `/bpmnkit:implement`
|
|
4
4
|
- [`@bpmnkit/patterns` source](https://github.com/bpmnkit/monorepo/tree/main/packages/patterns)
|
|
5
5
|
|
|
6
6
|
---
|
|
7
|
-
Source: https://
|
|
7
|
+
Source: https://bpmnkit.com/docs/guides/patterns
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# VS Code Extension — Commands
|
|
2
|
+
|
|
3
|
+
| Command | Where |
|
|
4
|
+
| --- | --- |
|
|
5
|
+
| **BPMN Kit: Open Diagram to the Side** | Editor title bar, command palette |
|
|
6
|
+
| **BPMN Kit: Compare Diagram with HEAD** | Source Control context menu, editor title bar |
|
|
7
|
+
| **BPMN Kit: Compare Diagrams Visually** | Explorer, with exactly two `.bpmn` files selected |
|
|
8
|
+
| **BPMN Kit: Open FEEL Playground** | Command palette — pre-filled from the selection |
|
|
9
|
+
| **BPMN Kit: Copy Diagram as ASCII** | Editor title bar, Explorer, command palette |
|
|
10
|
+
| **BPMN Kit: Deploy to Camunda 8** | Command palette |
|
|
11
|
+
| **BPMN Kit: Deploy and Start Instance** | Explorer, command palette |
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# VS Code Extension — Installing
|
|
2
|
+
|
|
3
|
+
The extension is **pre-1.0 and not on the Marketplace yet** — it is built from the monorepo
|
|
4
|
+
and ships when the packages it is built from do:
|
|
5
|
+
|
|
6
|
+
```sh
|
|
7
|
+
git clone https://github.com/bpmnkit/monorepo
|
|
8
|
+
cd monorepo && pnpm install
|
|
9
|
+
pnpm --filter bpmnkit build
|
|
10
|
+
pnpm --filter bpmnkit package # → apps/vscode/bpmnkit.vsix
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Then install the `.vsix`: **Extensions → … → Install from VSIX…**, or
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
code --install-extension apps/vscode/bpmnkit.vsix
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
It activates on a workspace containing a `.bpmn` file, and requires VS Code 1.90 or newer.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# VS Code Extension
|
|
2
|
+
|
|
3
|
+
**BPMN Kit for VS Code** puts the toolkit where the code already is. It renders `.bpmn`,
|
|
4
|
+
`.dmn` and `.form` files, reports the same findings `casen lint` reports, compares a diagram
|
|
5
|
+
against `HEAD`, runs the process without a cluster, and edits the file without reformatting
|
|
6
|
+
it.
|
|
7
|
+
|
|
8
|
+
The renderer is [`@bpmnkit/canvas`](/docs/packages/canvas), the same from-scratch BPMN 2.0
|
|
9
|
+
implementation the website and the browser editor use. There is no bpmn.io anywhere in the
|
|
10
|
+
extension, which is the point: the files it shows you are the files git has, byte for byte.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# VS Code Extension — Settings
|
|
2
|
+
|
|
3
|
+
| Setting | Default | What it does |
|
|
4
|
+
| --- | --- | --- |
|
|
5
|
+
| `bpmnkit.lint.enabled` | `true` | Report findings in the Problems panel |
|
|
6
|
+
| `bpmnkit.lint.run` | `onType` | `onType` or `onSave` |
|
|
7
|
+
| `bpmnkit.lint.forceEngineRules` | `false` | Apply Camunda 8 rules to an engine-neutral diagram |
|
|
8
|
+
| `bpmnkit.viewer.grid` | `true` | Dot grid behind the diagram |
|
|
9
|
+
| `bpmnkit.viewer.minimap` | `true` | Minimap in the BPMN viewer |
|
|
10
|
+
| `bpmnkit.simulation.enabled` | `true` | Offer step-through simulation in the preview |
|
|
11
|
+
| `bpmnkit.editing.enabled` | `true` | Let the diagram editor change the file |
|
|
12
|
+
|
|
13
|
+
Findings are reported for `.bpmn` files that are open; a file the editor has not loaded is
|
|
14
|
+
not analysed, same as every other linter in VS Code. Set `bpmnkit.editing.enabled` to `false`
|
|
15
|
+
for the same editors with editing switched off, when a diagram should be openable with no
|
|
16
|
+
chance of changing it.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# VS Code Extension — Support
|
|
2
|
+
|
|
3
|
+
The extension is pre-1.0 and community-supported, developed in the open in the
|
|
4
|
+
[monorepo](https://github.com/bpmnkit/monorepo) alongside the packages it is built from.
|
|
5
|
+
Minor versions may change behaviour before 1.0: the features above will not disappear, but
|
|
6
|
+
setting names and command titles may still move. Bugs and requests go to
|
|
7
|
+
[GitHub issues](https://github.com/bpmnkit/monorepo/issues). MIT-licensed, like everything
|
|
8
|
+
else in the repository.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# VS Code Extension — What it does — A FEEL playground on your selection
|
|
2
|
+
|
|
3
|
+
Select an expression anywhere in the XML and open the playground: it comes up pre-filled,
|
|
4
|
+
with a context you can edit and the result evaluated as you type. Unary tests too, for
|
|
5
|
+
decision-table input entries.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# VS Code Extension — What it does — A visual diff in Source Control
|
|
2
|
+
|
|
3
|
+
Right-click a `.bpmn` file in Source Control to see it against `HEAD`, or select exactly two
|
|
4
|
+
in the Explorer to compare them with each other. Added, removed, changed and moved elements
|
|
5
|
+
are marked on synchronised canvases — a moved element reads as *moved*, not as two unrelated
|
|
6
|
+
pictures. The text diff stays where it was; this is a second view of the same change, not a
|
|
7
|
+
replacement for the first. The same comparison is available as
|
|
8
|
+
[`casen diff bpmn`](/docs/cli/diff) and on a [drop](/docs/guides/drop).
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# VS Code Extension — What it does — Copy the diagram as text
|
|
2
|
+
|
|
3
|
+
For a code review, where a picture cannot go. **BPMN Kit: Copy Diagram as ASCII** renders the
|
|
4
|
+
layout into a fenced block that pastes into a pull request, an issue or a commit message,
|
|
5
|
+
dedented so the diagram is not mostly margin.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# VS Code Extension — What it does — Deploy against your own clusters
|
|
2
|
+
|
|
3
|
+
Deployment targets come from `casen`'s profile store — the same file
|
|
4
|
+
[`casen profile create`](/docs/cli/casen#connection-profiles) writes — so there is no second
|
|
5
|
+
place to configure a cluster and no credentials in your workspace settings:
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
casen profile create staging --base-url https://<cluster>.camunda.io/<id> \
|
|
9
|
+
--auth-type oauth --client-id … --client-secret …
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Every `c8` profile then appears in the extension. Deploy the open file, or deploy and start
|
|
13
|
+
an instance with variables; the instance key comes back in a notification. Deploy-and-start
|
|
14
|
+
also offers the payloads it finds in `.camunda/payloads/*.json`, walking up from the diagram,
|
|
15
|
+
so the inputs a process is always tried with are a pick rather than a paste.
|
|
16
|
+
|
|
17
|
+
Credentials are read only to sign the request — nothing in the extension stores, displays or
|
|
18
|
+
logs them.
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# VS Code Extension — What it does — Editing that leaves a readable diff
|
|
2
|
+
|
|
3
|
+
The diagram editor is a **text** custom editor: it edits the same `TextDocument` a text
|
|
4
|
+
editor would open. The file is dirty when the document is, <kbd>Ctrl</kbd>+<kbd>S</kbd>
|
|
5
|
+
saves it, hot exit restores it, undo is the editor's own undo, and a text editor open on the
|
|
6
|
+
same file is a second view of one document rather than a competing copy. Type in the XML and
|
|
7
|
+
the diagram follows; move a box and the XML follows.
|
|
8
|
+
|
|
9
|
+
Saving writes a diff a reviewer can read. A visual editor normally serialises the whole
|
|
10
|
+
model, which reformats the file on the first change and buries one edit in a rewrite of
|
|
11
|
+
everything. This one writes the file that was already there: renaming a task changes the
|
|
12
|
+
line with the task on it, moving a box changes two numbers, and your indentation, attribute
|
|
13
|
+
order and comments come back untouched. Opening a diagram and saving it without editing
|
|
14
|
+
anything leaves the file byte for byte. Form files get the same treatment — indentation, key
|
|
15
|
+
order and trailing newline all survive.
|
|
16
|
+
|
|
17
|
+
That behaviour is not extension-specific; it is
|
|
18
|
+
[`exportPreserving()`](/docs/packages/core#exportpreservingoriginal-definitions) from
|
|
19
|
+
`@bpmnkit/core`, available to anything that writes a model back over a file it parsed.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# VS Code Extension — What it does — Findings in the Problems panel
|
|
2
|
+
|
|
3
|
+
The same static analysis `casen lint` runs — flow reachability, naming, FEEL syntax, data
|
|
4
|
+
flow, Camunda 8 deployability — reported against the element that caused it, so clicking a
|
|
5
|
+
problem takes you to the tag rather than to line 1.
|
|
6
|
+
|
|
7
|
+
The analysis matches the file. A diagram that declares no `modeler:executionPlatform` is not
|
|
8
|
+
judged against Camunda 8 deployability, because "this service task has no
|
|
9
|
+
`zeebe:taskDefinition`" is not a defect in a diagram that was never going to be deployed to
|
|
10
|
+
Zeebe. Turn on `bpmnkit.lint.forceEngineRules` to apply those rules anyway.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# VS Code Extension — What it does — Preview beside the source
|
|
2
|
+
|
|
3
|
+
`.bpmn`, `.dmn` and `.form` all render, with a minimap and zoom for BPMN. The preview
|
|
4
|
+
follows the buffer as you type rather than on save, and when the XML is momentarily
|
|
5
|
+
unparseable it keeps the last drawing that worked rather than blanking.
|
|
6
|
+
|
|
7
|
+
The text editor stays the default for all three file types. Open the diagram with
|
|
8
|
+
**BPMN Kit: Open Diagram to the Side**, with *Reopen Editor With…*, or make it your default
|
|
9
|
+
through `workbench.editorAssociations`.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VS Code Extension — What it does — Run the diagram in the editor
|
|
2
|
+
|
|
3
|
+
[`@bpmnkit/engine`](/docs/packages/engine) is a BPMN engine written in TypeScript, so the
|
|
4
|
+
preview does not need a cluster to execute what is on screen. Press **Run** and watch tokens
|
|
5
|
+
move; press **One Step** to advance the instance one element at a time, reading the variables
|
|
6
|
+
as they change. Nothing is deployed and nothing leaves your machine.
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
Source: https://bpmnkit.com/docs/guides/vscode
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Standalone Workers — See also
|
|
2
2
|
|
|
3
|
-
- [`@bpmnkit/worker-client`](/packages/worker-client
|
|
4
|
-
- [AI-Driven Implementation](/guides/ai-implement
|
|
3
|
+
- [`@bpmnkit/worker-client`](/docs/packages/worker-client) — full API reference
|
|
4
|
+
- [AI-Driven Implementation](/docs/guides/ai-implement) — scaffold workers as part of `/implement`
|
|
5
5
|
|
|
6
6
|
---
|
|
7
|
-
Source: https://
|
|
7
|
+
Source: https://bpmnkit.com/docs/guides/workers-standalone
|
|
@@ -15,7 +15,7 @@ interface CatalogEntry {
|
|
|
15
15
|
## CLI
|
|
16
16
|
|
|
17
17
|
The same functionality is available via `casen connector generate` and `casen connector catalog`.
|
|
18
|
-
See the [CLI reference](/cli/connector
|
|
18
|
+
See the [CLI reference](/docs/cli/connector).
|
|
19
19
|
|
|
20
20
|
---
|
|
21
|
-
Source: https://
|
|
21
|
+
Source: https://bpmnkit.com/docs/packages/connector-gen
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# @bpmnkit/core — Installation — Ad-hoc sub-processes: children are a set, not a chain
|
|
2
|
+
|
|
3
|
+
Sequential calls in a builder chain auto-connect with sequence flows. Inside
|
|
4
|
+
`.adHocSubProcess()` they do not: BPMN defines an ad-hoc sub-process's children as an unordered
|
|
5
|
+
set of independently-invocable activities, and Camunda 8's agentic AI runtime reads that
|
|
6
|
+
structurally — a child *without* an incoming flow is an LLM-invocable tool, a child *with* one
|
|
7
|
+
is part of an internal sub-flow and not a tool at all.
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
.adHocSubProcess("agent", (s) => {
|
|
11
|
+
s.serviceTask("listUsers", { taskType: "io.camunda:http-json:1" });
|
|
12
|
+
s.serviceTask("loadUser", { taskType: "io.camunda:http-json:1" });
|
|
13
|
+
s.serviceTask("createUser", { taskType: "io.camunda:http-json:1" });
|
|
14
|
+
}, { name: "Handle request" })
|
|
15
|
+
// → three tools, no sequence flows, no <bpmndi:BPMNEdge> between them
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Auto-chaining them produced a file that lints clean and deploys, while the agent saw one tool
|
|
19
|
+
and a two-step sub-flow — so the default is off rather than opt-out.
|
|
20
|
+
|
|
21
|
+
An internal sub-flow inside the container stays expressible: say so with `.connectTo()`, which
|
|
22
|
+
still creates a flow from the cursor.
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
.adHocSubProcess("agent", (s) => {
|
|
26
|
+
s.serviceTask("listUsers", { taskType: "io.camunda:http-json:1" }); // a tool
|
|
27
|
+
s.serviceTask("step1", { taskType: "work" }).connectTo("step2"); // an internal sub-flow
|
|
28
|
+
s.serviceTask("step2", { taskType: "work" });
|
|
29
|
+
})
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Each child's LLM-facing description is its `documentation`, which every builder method accepts:
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
s.serviceTask("listUsers", {
|
|
36
|
+
taskType: "io.camunda:http-json:1",
|
|
37
|
+
documentation: "Call this to retrieve all users. Returns id, name, email.",
|
|
38
|
+
});
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
Source: https://bpmnkit.com/docs/packages/core
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# @bpmnkit/core — Installation — `applyBpmnOperations(definitions, operations, options?)`
|
|
2
|
+
|
|
3
|
+
Applies edit operations to the full model. The operation vocabulary is the same one an LLM
|
|
4
|
+
produces; applying it here rather than to a `CompactDiagram` means an edit touches only what it
|
|
5
|
+
names and leaves the document's pools, lanes, data wiring and Zeebe detail alone.
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import { applyBpmnOperations } from "@bpmnkit/core";
|
|
9
|
+
|
|
10
|
+
const { definitions, applied } = applyBpmnOperations(parsed, [
|
|
11
|
+
{ op: "rename", id: "Task_1", name: "Approve invoice" },
|
|
12
|
+
{ op: "update", id: "Task_1", patch: { jobType: "approve" } },
|
|
13
|
+
]);
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
**Strict by default.** An operation naming an element that does not exist throws an
|
|
17
|
+
`OperationError` and nothing is applied — the previous implementation skipped such operations
|
|
18
|
+
silently, so a patch with a misspelled id reported success and changed nothing. Pass
|
|
19
|
+
`{ strict: false }` to get `{ definitions, applied, problems }` instead and decide for
|
|
20
|
+
yourself. The input is never mutated either way.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
Source: https://bpmnkit.com/docs/packages/core
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# @bpmnkit/core — Installation — `Bpmn.continueProcess(definitions, processId)`
|
|
2
|
+
|
|
3
|
+
Continue an existing model instead of generating a replacement for it. `build()` returns *that
|
|
4
|
+
document* with the named process's contents replaced, so other processes, the collaboration,
|
|
5
|
+
lanes, diagram interchange, root elements and unmodelled content all survive. The input is not
|
|
6
|
+
mutated.
|
|
7
|
+
|
|
8
|
+
```typescript
|
|
9
|
+
const updated = Bpmn.continueProcess(Bpmn.parse(xml), "order-process")
|
|
10
|
+
.insertAfter("validate")
|
|
11
|
+
.serviceTask("notify", { name: "Notify", taskType: "notify" })
|
|
12
|
+
.build();
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Also available as `ProcessBuilder.from(definitions, processId)`.
|
|
16
|
+
|
|
17
|
+
**`.at(nodeId)`** continues from a node whose path is open — no outgoing sequence flow, or a
|
|
18
|
+
gateway, where several outgoing flows are the point. It refuses a node that is not directly in
|
|
19
|
+
that process (a node inside a sub-process means building that sub-process), an end event, and a
|
|
20
|
+
node that would gain a second outgoing flow — that is an uncontrolled split, and almost always
|
|
21
|
+
means you wanted to insert.
|
|
22
|
+
|
|
23
|
+
**`.insertAfter(nodeId)`** splices what you build next into the path leaving an existing node:
|
|
24
|
+
`validate → end` becomes `validate → notify → end`. The existing flow keeps its **id and its
|
|
25
|
+
target** and only changes where it starts, so an edge nobody asked to move keeps its identity
|
|
26
|
+
in the diagram and in a diff. It refuses a node with no outgoing flow, and one with several,
|
|
27
|
+
where "after" is ambiguous.
|
|
28
|
+
|
|
29
|
+
Which of the two you mean is not guessable, so it is not guessed.
|
|
30
|
+
|
|
31
|
+
**Continuing never infers gateways.** `ProcessBuilder` normally inserts join gateways for
|
|
32
|
+
branches you build; on a parsed model that reads the whole topology and retargets edges you
|
|
33
|
+
never touched, so continue mode does not do it. A branch that needs a join here says so with
|
|
34
|
+
`.connectTo(joinId)`. `build()` refuses outright if anything would rewire a sequence flow the
|
|
35
|
+
document already had.
|
|
36
|
+
|
|
37
|
+
**Diagram interchange is not regenerated.** Existing shapes keep their positions, and elements
|
|
38
|
+
you add have none until `.withAutoLayout()` or a later `applyAutoLayout()` gives them one.
|
|
39
|
+
|
|
40
|
+
`isExecutable` and the process name are left as they were unless you call `.executable()` or
|
|
41
|
+
`.name()`. BPMN reads an absent `isExecutable` as false, so writing the builder's default onto
|
|
42
|
+
a process that never carried it would make a non-executable process executable.
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
Source: https://bpmnkit.com/docs/packages/core
|