@bpmnkit/docspack 0.0.3 → 0.0.5

package/.llms/manifest.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://docspack.dev/schema/v1.json",
 	"name": "@bpmnkit/docspack",
-	"version": "0.0.3",
+	"version": "0.0.5",
 	"documents": [
 		"@bpmnkit/core",
 		"@bpmnkit/canvas",
@@ -230,6 +230,47 @@
 				"@bpmnkit/connector-gen"
 			]
 		},
+		{
+			"id": "cli.diff",
+			"file": "chunks/cli.diff.md",
+			"tokens": 412,
+			"tags": [
+				"cli",
+				"diff"
+			],
+			"entities": [
+				"diffSemantics()",
+				"targetNamespace"
+			]
+		},
+		{
+			"id": "cli.diff.flags",
+			"file": "chunks/cli.diff.flags.md",
+			"tokens": 301,
+			"tags": [
+				"cli",
+				"diff",
+				"flags"
+			],
+			"entities": []
+		},
+		{
+			"id": "cli.diff.the-same-diff-elsewhere",
+			"file": "chunks/cli.diff.the-same-diff-elsewhere.md",
+			"tokens": 128,
+			"tags": [
+				"cli",
+				"diff",
+				"same",
+				"elsewhere"
+			],
+			"entities": [
+				"diffDiagram()",
+				"@bpmnkit/core",
+				"createBpmnDiff()",
+				"@bpmnkit/plugins"
+			]
+		},
 		{
 			"id": "cli.generate",
 			"file": "chunks/cli.generate.md",
@@ -1009,13 +1050,16 @@
 		{
 			"id": "guides.building-processes.multi-instance",
 			"file": "chunks/guides.building-processes.multi-instance.md",
-			"tokens": 92,
+			"tokens": 687,
 			"tags": [
 				"guides",
 				"building-processes",
 				"multi-instance"
 			],
-			"entities": []
+			"entities": [
+				"defaultFlow",
+				"continueProcess()"
+			]
 		},
 		{
 			"id": "guides.claude-code-plugin",
@@ -1135,6 +1179,69 @@
 			],
 			"entities": []
 		},
+		{
+			"id": "guides.drop",
+			"file": "chunks/guides.drop.md",
+			"tokens": 141,
+			"tags": [
+				"guides",
+				"drop"
+			],
+			"entities": []
+		},
+		{
+			"id": "guides.drop.sharing-a-file",
+			"file": "chunks/guides.drop.sharing-a-file.md",
+			"tokens": 410,
+			"tags": [
+				"guides",
+				"drop",
+				"sharing",
+				"file"
+			],
+			"entities": []
+		},
+		{
+			"id": "guides.drop.reviewing-it-together",
+			"file": "chunks/guides.drop.reviewing-it-together.md",
+			"tokens": 604,
+			"tags": [
+				"guides",
+				"drop",
+				"reviewing",
+				"together"
+			],
+			"entities": [
+				"@bpmnkit/plugins"
+			]
+		},
+		{
+			"id": "guides.drop.running-your-own",
+			"file": "chunks/guides.drop.running-your-own.md",
+			"tokens": 200,
+			"tags": [
+				"guides",
+				"drop",
+				"running",
+				"own"
+			],
+			"entities": [
+				"apps/drop",
+				"@bpmnkit/core",
+				"apps/drop/DEPLOY.md"
+			]
+		},
+		{
+			"id": "guides.drop.what-drop-is-not",
+			"file": "chunks/guides.drop.what-drop-is-not.md",
+			"tokens": 136,
+			"tags": [
+				"guides",
+				"drop",
+				"not"
+			],
+			"entities": []
+		},
 		{
 			"id": "guides.gateways.exclusive-gateway-xor",
 			"file": "chunks/guides.gateways.exclusive-gateway-xor.md",
@@ -1347,6 +1454,189 @@
 				"engine.getDeployedProcesses()"
 			]
 		},
+		{
+			"id": "guides.vscode",
+			"file": "chunks/guides.vscode.md",
+			"tokens": 139,
+			"tags": [
+				"guides",
+				"vscode"
+			],
+			"entities": [
+				"@bpmnkit/canvas"
+			]
+		},
+		{
+			"id": "guides.vscode.installing",
+			"file": "chunks/guides.vscode.installing.md",
+			"tokens": 140,
+			"tags": [
+				"guides",
+				"vscode",
+				"installing"
+			],
+			"entities": []
+		},
+		{
+			"id": "guides.vscode.what-it-does-preview-beside-the-source",
+			"file": "chunks/guides.vscode.what-it-does-preview-beside-the-source.md",
+			"tokens": 131,
+			"tags": [
+				"guides",
+				"vscode",
+				"preview",
+				"beside",
+				"source"
+			],
+			"entities": [
+				"workbench.editorAssociations"
+			]
+		},
+		{
+			"id": "guides.vscode.what-it-does-editing-that-leaves-a-readable-diff",
+			"file": "chunks/guides.vscode.what-it-does-editing-that-leaves-a-readable-diff.md",
+			"tokens": 302,
+			"tags": [
+				"guides",
+				"vscode",
+				"editing",
+				"leaves",
+				"readable",
+				"diff"
+			],
+			"entities": [
+				"TextDocument",
+				"exportPreserving()",
+				"@bpmnkit/core"
+			]
+		},
+		{
+			"id": "guides.vscode.what-it-does-findings-in-the-problems-panel",
+			"file": "chunks/guides.vscode.what-it-does-findings-in-the-problems-panel.md",
+			"tokens": 150,
+			"tags": [
+				"guides",
+				"vscode",
+				"findings",
+				"problems",
+				"panel"
+			],
+			"entities": [
+				"bpmnkit.lint.forceEngineRules"
+			]
+		},
+		{
+			"id": "guides.vscode.what-it-does-a-visual-diff-in-source-control",
+			"file": "chunks/guides.vscode.what-it-does-a-visual-diff-in-source-control.md",
+			"tokens": 146,
+			"tags": [
+				"guides",
+				"vscode",
+				"visual",
+				"diff",
+				"source",
+				"control"
+			],
+			"entities": []
+		},
+		{
+			"id": "guides.vscode.what-it-does-run-the-diagram-in-the-editor",
+			"file": "chunks/guides.vscode.what-it-does-run-the-diagram-in-the-editor.md",
+			"tokens": 105,
+			"tags": [
+				"guides",
+				"vscode",
+				"run",
+				"diagram",
+				"editor"
+			],
+			"entities": [
+				"@bpmnkit/engine"
+			]
+		},
+		{
+			"id": "guides.vscode.what-it-does-a-feel-playground-on-your-selection",
+			"file": "chunks/guides.vscode.what-it-does-a-feel-playground-on-your-selection.md",
+			"tokens": 75,
+			"tags": [
+				"guides",
+				"vscode",
+				"feel",
+				"playground",
+				"selection"
+			],
+			"entities": []
+		},
+		{
+			"id": "guides.vscode.what-it-does-deploy-against-your-own-clusters",
+			"file": "chunks/guides.vscode.what-it-does-deploy-against-your-own-clusters.md",
+			"tokens": 208,
+			"tags": [
+				"guides",
+				"vscode",
+				"deploy",
+				"against",
+				"own",
+				"clusters"
+			],
+			"entities": []
+		},
+		{
+			"id": "guides.vscode.what-it-does-copy-the-diagram-as-text",
+			"file": "chunks/guides.vscode.what-it-does-copy-the-diagram-as-text.md",
+			"tokens": 84,
+			"tags": [
+				"guides",
+				"vscode",
+				"copy",
+				"diagram",
+				"text"
+			],
+			"entities": []
+		},
+		{
+			"id": "guides.vscode.commands",
+			"file": "chunks/guides.vscode.commands.md",
+			"tokens": 181,
+			"tags": [
+				"guides",
+				"vscode",
+				"commands"
+			],
+			"entities": []
+		},
+		{
+			"id": "guides.vscode.settings",
+			"file": "chunks/guides.vscode.settings.md",
+			"tokens": 241,
+			"tags": [
+				"guides",
+				"vscode",
+				"settings"
+			],
+			"entities": [
+				"bpmnkit.lint.enabled",
+				"bpmnkit.lint.run",
+				"onType",
+				"onSave",
+				"bpmnkit.lint.forceEngineRules",
+				"bpmnkit.viewer.grid",
+				"bpmnkit.viewer.minimap",
+				"bpmnkit.simulation.enabled",
+				"bpmnkit.editing.enabled"
+			]
+		},
+		{
+			"id": "guides.vscode.support",
+			"file": "chunks/guides.vscode.support.md",
+			"tokens": 99,
+			"tags": [
+				"guides",
+				"vscode",
+				"support"
+			],
+			"entities": []
+		},
 		{
 			"id": "guides.workers-standalone",
 			"file": "chunks/guides.workers-standalone.md",
@@ -1845,6 +2135,25 @@
 			],
 			"entities": []
 		},
+		{
+			"id": "packages.core.installation-diffdiagram-before-after",
+			"file": "chunks/packages.core.installation-diffdiagram-before-after.md",
+			"tokens": 331,
+			"tags": [
+				"packages",
+				"core",
+				"installation",
+				"diffdiagram",
+				"before",
+				"after"
+			],
+			"entities": [
+				"diffSemantics()",
+				"targetNamespace",
+				"createBpmnDiff()",
+				"@bpmnkit/plugins"
+			]
+		},
 		{
 			"id": "packages.core.installation-applybpmnoperations-definitions-operations-options",
 			"file": "chunks/packages.core.installation-applybpmnoperations-definitions-operations-options.md",
@@ -1905,7 +2214,7 @@
 		{
 			"id": "packages.core.installation-compactify-definitions",
 			"file": "chunks/packages.core.installation-compactify-definitions.md",
-			"tokens": 111,
+			"tokens": 204,
 			"tags": [
 				"packages",
 				"core",
@@ -1921,7 +2230,7 @@
 		{
 			"id": "packages.core.installation-expand-compact",
 			"file": "chunks/packages.core.installation-expand-compact.md",
-			"tokens": 106,
+			"tokens": 164,
 			"tags": [
 				"packages",
 				"core",
@@ -1931,7 +2240,61 @@
 			],
 			"entities": [
 				"BpmnDefinitions",
-				"CompactDiagram"
+				"CompactDiagram",
+				"BpmnElementType",
+				"dataObject",
+				"dataObjectReference",
+				"dataStoreReference"
+			]
+		},
+		{
+			"id": "packages.core.installation-retypeelement-element-type",
+			"file": "chunks/packages.core.installation-retypeelement-element-type.md",
+			"tokens": 189,
+			"tags": [
+				"packages",
+				"core",
+				"installation",
+				"retypeelement",
+				"element",
+				"type"
+			],
+			"entities": [
+				"ensureZeebeExtension",
+				"serviceTask",
+				"manualTask"
+			]
+		},
+		{
+			"id": "packages.core.installation-createflowelement-id-type-options",
+			"file": "chunks/packages.core.installation-createflowelement-id-type-options.md",
+			"tokens": 61,
+			"tags": [
+				"packages",
+				"core",
+				"installation",
+				"createflowelement",
+				"type",
+				"options"
+			],
+			"entities": [
+				"BpmnElementType"
+			]
+		},
+		{
+			"id": "packages.core.installation-element-catalog",
+			"file": "chunks/packages.core.installation-element-catalog.md",
+			"tokens": 96,
+			"tags": [
+				"packages",
+				"core",
+				"installation",
+				"element",
+				"catalog"
+			],
+			"entities": [
+				"BpmnElementType",
+				"allElementTypes()"
 			]
 		},
 		{
@@ -1953,7 +2316,7 @@
 		{
 			"id": "packages.core.installation-processbuilder-methods",
 			"file": "chunks/packages.core.installation-processbuilder-methods.md",
-			"tokens": 412,
+			"tokens": 698,
 			"tags": [
 				"packages",
 				"core",
@@ -1963,9 +2326,29 @@
 			],
 			"entities": [
 				"addStartEvent",
-				"BpmnDefinitions"
+				"BpmnDefinitions",
+				"dataObject",
+				"dataObjectReference",
+				"dataStoreReference"
 			]
 		},
+		{
+			"id": "packages.core.installation-ad-hoc-sub-processes-children-are-a-set-not-a-chain",
+			"file": "chunks/packages.core.installation-ad-hoc-sub-processes-children-are-a-set-not-a-chain.md",
+			"tokens": 368,
+			"tags": [
+				"packages",
+				"core",
+				"installation",
+				"ad-hoc",
+				"sub-processes",
+				"children",
+				"set",
+				"not",
+				"chain"
+			],
+			"entities": []
+		},
 		{
 			"id": "packages.core.installation-joins-inferred-by-default-or-declared",
 			"file": "chunks/packages.core.installation-joins-inferred-by-default-or-declared.md",
@@ -1989,7 +2372,7 @@
 		{
 			"id": "packages.core.writing-files-bpmnkit-core-node",
 			"file": "chunks/packages.core.writing-files-bpmnkit-core-node.md",
-			"tokens": 474,
+			"tokens": 52,
 			"tags": [
 				"packages",
 				"core",
@@ -2000,12 +2383,57 @@
 			],
 			"entities": [
 				"@bpmnkit/core/node",
-				"@bpmnkit/core",
+				"@bpmnkit/core"
+			]
+		},
+		{
+			"id": "packages.core.writing-files-bpmnkit-core-node-writebpmn-definitions-options",
+			"file": "chunks/packages.core.writing-files-bpmnkit-core-node-writebpmn-definitions-options.md",
+			"tokens": 440,
+			"tags": [
+				"packages",
+				"core",
+				"writing",
+				"files",
+				"bpmnkit",
+				"node",
+				"writebpmn",
+				"definitions",
+				"options"
+			],
+			"entities": [
 				"WriteVerificationError",
 				"WriteError",
 				"Bpmn.export()"
 			]
 		},
+		{
+			"id": "packages.core.writing-files-bpmnkit-core-node-exportpreserving-original-definitions",
+			"file": "chunks/packages.core.writing-files-bpmnkit-core-node-exportpreserving-original-definitions.md",
+			"tokens": 598,
+			"tags": [
+				"packages",
+				"core",
+				"writing",
+				"files",
+				"bpmnkit",
+				"node",
+				"exportpreserving",
+				"original",
+				"definitions"
+			],
+			"entities": [
+				"Bpmn.export()",
+				"@bpmnkit/core",
+				"flowElements",
+				"sequenceFlows",
+				"exportXml()",
+				"exportDmnPreserving",
+				"preserveDmnFormatting",
+				"exportFormPreserving",
+				"preserveFormFormatting"
+			]
+		},
 		{
 			"id": "packages.core.dmn-support",
 			"file": "chunks/packages.core.dmn-support.md",

package/README.md

@@ -125,6 +125,7 @@ Options: `--limit <n>`, `--max-tokens <n>`, `--pack <name>`, `--cwd <dir>`.
 | [`@bpmnkit/plugins`](https://www.npmjs.com/package/@bpmnkit/plugins) | 22 composable canvas plugins |
 | [`@bpmnkit/api`](https://www.npmjs.com/package/@bpmnkit/api) | Camunda 8 REST API TypeScript client |
 | [`@bpmnkit/ascii`](https://www.npmjs.com/package/@bpmnkit/ascii) | Render BPMN diagrams as Unicode ASCII art |
+| [`@bpmnkit/camunda-docspack`](https://www.npmjs.com/package/@bpmnkit/camunda-docspack) | Camunda 8 docs as an offline docspack package for AI agents |
 | [`@bpmnkit/ui`](https://www.npmjs.com/package/@bpmnkit/ui) | Shared design tokens and UI components |
 | [`@bpmnkit/profiles`](https://www.npmjs.com/package/@bpmnkit/profiles) | Shared auth, profile storage, and client factories for CLI & proxy |
 | [`@bpmnkit/operate`](https://www.npmjs.com/package/@bpmnkit/operate) | Monitoring & operations frontend for Camunda clusters |
@@ -135,6 +136,7 @@ Options: `--limit <n>`, `--max-tokens <n>`, `--pack <name>`, `--cwd <dir>`.
 | [`@bpmnkit/patterns`](https://www.npmjs.com/package/@bpmnkit/patterns) | Domain process patterns for BPMNKit AIKit |
 | [`@bpmnkit/reebe-wasm`](https://www.npmjs.com/package/@bpmnkit/reebe-wasm) | WebAssembly BPMN engine for browser simulation |
 | [`@bpmnkit/worker-client`](https://www.npmjs.com/package/@bpmnkit/worker-client) | Thin Zeebe REST client for standalone workers |
+| [`@bpmnkit/user-tasks`](https://www.npmjs.com/package/@bpmnkit/user-tasks) | Embeddable user task widget for Camunda 8 |
 | [`@bpmnkit/cli-sdk`](https://www.npmjs.com/package/@bpmnkit/cli-sdk) | Plugin authoring SDK for the casen CLI |
 | [`@bpmnkit/create-casen-plugin`](https://www.npmjs.com/package/@bpmnkit/create-casen-plugin) | Scaffold a new casen CLI plugin in seconds |
 | [`@bpmnkit/casen-report`](https://www.npmjs.com/package/@bpmnkit/casen-report) | HTML reports from Camunda 8 incident and SLA data |

package/dist/chunk.js

@@ -25,7 +25,7 @@ export function chunkDocument(doc, options = {}) {
             if (text === "")
                 continue;
             const directives = readDirectives(part.lines);
-            const chunkTitle = part.heading === "" ? title : `${title} — ${part.heading}`;
+            const chunkTitle = joinHeadings(title, part.heading);
             const source = options.siteUrl ? `\n\n---\nSource: ${options.siteUrl}/${doc.slug}` : "";
             const bodyText = `# ${chunkTitle}\n\n${stripDirectives(text)}${source}\n`;
             chunks.push({
@@ -116,8 +116,7 @@ function subdivide(section, maxTokens) {
         return [section];
     const parts = [];
     for (const sub of splitByHeading(section.lines.join("\n"), 3)) {
-        const heading = sub.heading === "" ? section.heading : `${section.heading} — ${sub.heading}`;
-        parts.push(...byParagraph({ heading, lines: sub.lines }, maxTokens));
+        parts.push(...byParagraph({ heading: joinHeadings(section.heading, sub.heading), lines: sub.lines }, maxTokens));
     }
     return parts.length > 0 ? parts : [section];
 }
@@ -132,7 +131,7 @@ function byParagraph(section, maxTokens) {
         if (current.join("").trim() === "")
             return;
         const suffix = parts.length === 0 ? "" : ` (${parts.length + 1})`;
-        parts.push({ heading: `${section.heading}${suffix}`, lines: current });
+        parts.push({ heading: `${section.heading}${suffix}`.trim(), lines: current });
         current = [];
     };
     for (const line of section.lines) {
@@ -177,6 +176,17 @@ function stripDirectives(text) {
         .join("\n")
         .trim();
 }
+/**
+ * Join a chunk's heading trail, dropping the levels that have no heading of their own.
+ *
+ * A document whose text before the first `##` is shorter than `minTokens` is merged into the
+ * section after it, and the merged section keeps the preamble's empty heading. Composing that
+ * blindly produced a hole in the middle of the trail — `Naming BPMN elements —  — Naming
+ * gateways` — which is what a reader sees at the top of the chunk and what an answer cites.
+ */
+function joinHeadings(...parts) {
+    return parts.filter((part) => part.trim() !== "").join(" — ");
+}
 /** Heading words carry the topic; function words carry nothing worth weighting 3x. */
 function headingTags(heading) {
     return tokenize(heading).filter((word) => word.length > 2 && !STOP_WORDS.has(word));