@bpmnkit/docspack 0.0.5 → 1.0.0

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.
Files changed (60) hide show
  1. package/.llms/chunks/getting-started.stability.deprecation.md +15 -0
  2. package/.llms/chunks/getting-started.stability.support-window.md +49 -0
  3. package/.llms/chunks/getting-started.stability.versions-are-per-package-not-per-repo.md +17 -0
  4. package/.llms/chunks/getting-started.stability.what-counts-as-public-api.md +33 -0
  5. package/.llms/chunks/getting-started.stability.what-is-a-breaking-change.md +70 -0
  6. package/.llms/chunks/getting-started.stability.what-is-not-a-breaking-change.md +25 -0
  7. package/.llms/chunks/getting-started.stability.what-this-page-is-for.md +21 -0
  8. package/.llms/chunks/guides.ai.minimal-empty-diagram.md +1 -0
  9. package/.llms/chunks/guides.ai.previewing-while-the-model-writes.md +57 -0
  10. package/.llms/chunks/guides.using-bpmnkit-with-ai.asking.md +47 -0
  11. package/.llms/chunks/guides.using-bpmnkit-with-ai.from-the-library-instead-of-the-cli-the-other-route-docspack-index.md +56 -0
  12. package/.llms/chunks/guides.using-bpmnkit-with-ai.from-the-library-instead-of-the-cli.md +86 -0
  13. package/.llms/chunks/guides.using-bpmnkit-with-ai.md +17 -0
  14. package/.llms/chunks/guides.using-bpmnkit-with-ai.runnable-examples.md +31 -0
  15. package/.llms/chunks/guides.using-bpmnkit-with-ai.telling-an-agent-they-exist.md +23 -0
  16. package/.llms/chunks/guides.using-bpmnkit-with-ai.the-two-packs-bpmn-kit-ships.md +20 -0
  17. package/.llms/chunks/guides.using-bpmnkit-with-ai.the-whole-loop-five-markdown-files-to-a-bpmn-diagram.md +64 -0
  18. package/.llms/chunks/guides.using-bpmnkit-with-ai.where-to-go-next.md +13 -0
  19. package/.llms/chunks/packages.ascii.from-the-command-line.md +23 -0
  20. package/.llms/chunks/packages.ascii.installation.md +34 -0
  21. package/.llms/chunks/packages.ascii.overview.md +15 -0
  22. package/.llms/chunks/packages.ascii.rendering-a-decision-table.md +29 -0
  23. package/.llms/chunks/packages.ascii.rendering-a-form.md +39 -0
  24. package/.llms/chunks/packages.camunda-docspack.a-note-on-the-pack-s-name.md +15 -0
  25. package/.llms/chunks/packages.camunda-docspack.installation.md +41 -0
  26. package/.llms/chunks/packages.camunda-docspack.overview.md +28 -0
  27. package/.llms/chunks/packages.camunda-docspack.rebuilding-it.md +27 -0
  28. package/.llms/chunks/packages.camunda-docspack.what-makes-this-corpus-different.md +16 -0
  29. package/.llms/chunks/packages.connectors.api-reference.md +22 -0
  30. package/.llms/chunks/packages.connectors.applying-a-template.md +64 -0
  31. package/.llms/chunks/packages.connectors.installation.md +45 -0
  32. package/.llms/chunks/packages.connectors.overview.md +16 -0
  33. package/.llms/chunks/packages.connectors.stability.md +16 -0
  34. package/.llms/chunks/packages.connectors.validating-a-template.md +27 -0
  35. package/.llms/chunks/packages.connectors.workspace-templates.md +20 -0
  36. package/.llms/chunks/packages.core.installation-compactify-definitions.md +8 -0
  37. package/.llms/chunks/packages.core.installation-createcompactstream-options.md +41 -0
  38. package/.llms/chunks/packages.core.installation-joins-inferred-by-default-or-declared.md +3 -3
  39. package/.llms/chunks/{packages.docspack.installation.md → packages.docspack.giving-an-agent-access.md} +5 -10
  40. package/.llms/chunks/packages.docspack.reading-it-yourself.md +6 -0
  41. package/.llms/chunks/packages.docspack.the-other-pack.md +24 -0
  42. package/.llms/chunks/packages.feel.api-reference.md +34 -0
  43. package/.llms/chunks/packages.feel.formatting-and-highlighting.md +24 -0
  44. package/.llms/chunks/packages.feel.installation.md +45 -0
  45. package/.llms/chunks/packages.feel.overview.md +15 -0
  46. package/.llms/chunks/packages.feel.stability.md +7 -0
  47. package/.llms/chunks/packages.feel.unary-tests.md +46 -0
  48. package/.llms/chunks/packages.plugins.installation.md +28 -0
  49. package/.llms/chunks/packages.plugins.overview.md +18 -0
  50. package/.llms/chunks/packages.plugins.styles.md +26 -0
  51. package/.llms/chunks/packages.plugins.what-is-available.md +68 -0
  52. package/.llms/manifest.json +763 -10
  53. package/README.md +11 -4
  54. package/dist/cli.js +11 -1
  55. package/dist/load.d.ts +10 -2
  56. package/dist/load.js +15 -3
  57. package/dist/search.d.ts +5 -1
  58. package/dist/search.js +12 -1
  59. package/llms.txt +52 -6
  60. package/package.json +1 -1
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  [![license](https://img.shields.io/npm/l/@bpmnkit/docspack?style=flat-square)](https://github.com/bpmnkit/monorepo/blob/main/LICENSE)
8
8
  [![typescript](https://img.shields.io/badge/TypeScript-strict-6244d7?style=flat-square&logo=typescript&logoColor=white)](https://github.com/bpmnkit/monorepo)
9
9
  [![ai-assisted](https://img.shields.io/badge/AI--assisted-claude-8b5cf6?style=flat-square)](https://github.com/bpmnkit/monorepo)
10
- [![experimental](https://img.shields.io/badge/status-experimental-f59e0b?style=flat-square)](https://github.com/bpmnkit/monorepo)
10
+ [![stable](https://img.shields.io/badge/status-stable-16a34a?style=flat-square)](https://bpmnkit.com/docs/getting-started/stability)
11
11
 
12
12
  [Website](https://bpmnkit.com) · [Documentation](https://bpmnkit.com/docs) · [GitHub](https://github.com/bpmnkit/monorepo) · [Changelog](https://github.com/bpmnkit/monorepo/blob/main/packages/docspack/CHANGELOG.md)
13
13
  </div>
@@ -22,6 +22,8 @@ An agent installs it, asks a question, and gets back the two or three passages t
22
22
 
23
23
  It follows the [docspack package format](https://docspack.dev/spec), so the upstream `docspack` CLI discovers and indexes it like any other vendor pack. The bundled `bpmnkit-docs` command does the same job with no extra tooling.
24
24
 
25
+ It also reads [`@bpmnkit/camunda-docspack`](https://www.npmjs.com/package/@bpmnkit/camunda-docspack) — the Camunda 8 documentation in the same format. Install both and ask this one how to drive the library, that one what the engine does.
26
+
25
27
  ```
26
28
  Markdown docs → chunks + manifest → BM25 index → three passages
27
29
  ```
@@ -44,17 +46,20 @@ npm install -D @bpmnkit/docspack
44
46
 
45
47
  ## Quick Start
46
48
 
47
- Give an agent one line in `AGENTS.md` or `CLAUDE.md`:
49
+ Give an agent one paragraph in `AGENTS.md` or `CLAUDE.md` — naming both packs, because an agent told only about the first will never think to ask the second:
48
50
 
49
51
  ```
50
- Run \`npx bpmnkit-docs ask "<question>"\` for BPMN Kit documentation.
51
- It answers from the version this project installed.
52
+ Run `npx bpmnkit-docs ask "<question>"` for BPMN Kit documentation, and
53
+ `npx bpmnkit-docs ask "<question>" --pack @bpmnkit/camunda-docspack` for
54
+ Camunda 8 documentation — BPMN semantics, FEEL, engine behaviour, the REST API.
55
+ Both answer from the versions this project installed.
52
56
  ```
53
57
 
54
58
  Then:
55
59
 
56
60
  ```sh
57
61
  npx bpmnkit-docs ask "how do I deploy a process to Camunda 8"
62
+ npx bpmnkit-docs ask "what happens when no gateway condition is true" --pack @bpmnkit/camunda-docspack
58
63
  npx bpmnkit-docs search "exclusive gateway"
59
64
  npx bpmnkit-docs list
60
65
  ```
@@ -111,6 +116,8 @@ function loadPack(dir: string): Pack
111
116
 
112
117
  Options: `--limit <n>`, `--max-tokens <n>`, `--pack <name>`, `--cwd <dir>`.
113
118
 
119
+ `--pack` narrows before the index is built, not after, so asking one pack a question does not pay for reading the others. A name that is not installed is an error listing what is, rather than an empty answer that would read as "the documentation does not cover this".
120
+
114
121
  ---
115
122
 
116
123
  ## Related Packages
package/dist/cli.js CHANGED
@@ -72,8 +72,18 @@ function main(argv) {
72
72
  return 1;
73
73
  }
74
74
  const selected = args.options.get("pack");
75
+ // Narrowing before indexing, not after: every chunk of every pack is read from
76
+ // disk to build the index, so asking one pack a question should not pay for
77
+ // the others. It is the difference between ~60ms and ~650ms here.
78
+ const scoped = selected === undefined ? packs : packs.filter((pack) => pack.name === selected);
79
+ if (scoped.length === 0) {
80
+ process.stderr.write(`No documentation package named "${selected}". Found: ${packs
81
+ .map((pack) => pack.name)
82
+ .join(", ")}\n`);
83
+ return 1;
84
+ }
75
85
  const scope = selected ? { packs: [selected] } : {};
76
- const index = indexPacks(packs);
86
+ const index = indexPacks(scoped);
77
87
  if (args.command === "search") {
78
88
  const hits = search(index, query, { ...scope, limit: number(args, "limit", 10) });
79
89
  process.stdout.write(formatSearch(query, hits));
package/dist/load.d.ts CHANGED
@@ -18,8 +18,16 @@ export declare function chunkPath(packDir: string, chunk: ManifestChunk): string
18
18
  export declare function readChunk(pack: Pack, chunk: ManifestChunk): string;
19
19
  /**
20
20
  * Every documentation package reachable from `cwd`: the vendor-scoped
21
- * `@<vendor>/docspack` and community `@docspack-community/*` packages installed
22
- * in any `node_modules` up the tree, plus `cwd` itself when it is a pack.
21
+ * `@<vendor>/docspack`, its `@<vendor>/<name>-docspack` siblings, and community
22
+ * `@docspack-community/*` packages installed in any `node_modules` up the tree,
23
+ * plus `cwd` itself when it is a pack.
24
+ *
25
+ * The suffix is for a vendor that also redistributes somebody else's
26
+ * documentation — `@bpmnkit/camunda-docspack` is ours — and had nowhere to put
27
+ * it when the spec named one pack per scope. It is still a pure name check,
28
+ * inside a scope that vendor owns, so the pack carries the same trust as the
29
+ * bare name and nothing here has to reach the network to decide. Upstream
30
+ * adopted the same shape in `docspack@1.2.0`.
23
31
  */
24
32
  export declare function discoverPacks(cwd?: string): Pack[];
25
33
  /** Load every chunk of every pack into a searchable index. */
package/dist/load.js CHANGED
@@ -65,8 +65,16 @@ export function readChunk(pack, chunk) {
65
65
  }
66
66
  /**
67
67
  * Every documentation package reachable from `cwd`: the vendor-scoped
68
- * `@<vendor>/docspack` and community `@docspack-community/*` packages installed
69
- * in any `node_modules` up the tree, plus `cwd` itself when it is a pack.
68
+ * `@<vendor>/docspack`, its `@<vendor>/<name>-docspack` siblings, and community
69
+ * `@docspack-community/*` packages installed in any `node_modules` up the tree,
70
+ * plus `cwd` itself when it is a pack.
71
+ *
72
+ * The suffix is for a vendor that also redistributes somebody else's
73
+ * documentation — `@bpmnkit/camunda-docspack` is ours — and had nowhere to put
74
+ * it when the spec named one pack per scope. It is still a pure name check,
75
+ * inside a scope that vendor owns, so the pack carries the same trust as the
76
+ * bare name and nothing here has to reach the network to decide. Upstream
77
+ * adopted the same shape in `docspack@1.2.0`.
70
78
  */
71
79
  export function discoverPacks(cwd = process.cwd()) {
72
80
  const found = new Map();
@@ -90,7 +98,11 @@ export function discoverPacks(cwd = process.cwd()) {
90
98
  offer(join(modules, scope, name));
91
99
  }
92
100
  else {
93
- offer(join(modules, scope, "docspack"));
101
+ for (const name of listDirectory(join(modules, scope))) {
102
+ if (name === "docspack" || name.endsWith("-docspack")) {
103
+ offer(join(modules, scope, name));
104
+ }
105
+ }
94
106
  }
95
107
  }
96
108
  }
package/dist/search.d.ts CHANGED
@@ -30,7 +30,11 @@ export declare function buildIndex(inputs: IndexInput[]): DocsIndex;
30
30
  export interface SearchOptions {
31
31
  /** Maximum hits to return. */
32
32
  limit?: number;
33
- /** Restrict to these package names — a project asks only about what it installed. */
33
+ /**
34
+ * Restrict to these package names — a project asks only about what it
35
+ * installed. A name that was never indexed throws rather than returning
36
+ * nothing, so a typo cannot pass for an absence of documentation.
37
+ */
34
38
  packs?: readonly string[];
35
39
  }
36
40
  /** Rank every chunk that shares a term with the query. Ties break on chunk id. */
package/dist/search.js CHANGED
@@ -47,10 +47,21 @@ export function buildIndex(inputs) {
47
47
  /** Rank every chunk that shares a term with the query. Ties break on chunk id. */
48
48
  export function search(index, query, options = {}) {
49
49
  const limit = options.limit ?? 3;
50
+ const allowed = options.packs ? new Set(options.packs) : null;
51
+ if (allowed) {
52
+ // Narrowing to a package that was never indexed would otherwise come back
53
+ // as an empty result, which reads as "the documentation does not cover
54
+ // this" — a different answer, and the wrong one to hand a model.
55
+ const indexed = new Set(index.chunks.map((candidate) => candidate.pack.name));
56
+ for (const name of allowed) {
57
+ if (!indexed.has(name)) {
58
+ throw new Error(`No documentation package named "${name}". Indexed: ${[...indexed].sort().join(", ")}`);
59
+ }
60
+ }
61
+ }
50
62
  const queryTerms = terms(query);
51
63
  if (queryTerms.length === 0)
52
64
  return [];
53
- const allowed = options.packs ? new Set(options.packs) : null;
54
65
  const total = index.chunks.length;
55
66
  const hits = [];
56
67
  for (const candidate of index.chunks) {
package/llms.txt CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  > BPMN Kit documentation as an offline, version-locked docspack package with a built-in search CLI for AI agents
4
4
 
5
- Version 0.0.5. 191 chunks documenting @bpmnkit/core, @bpmnkit/canvas, @bpmnkit/editor, @bpmnkit/engine, @bpmnkit/feel, @bpmnkit/plugins, @bpmnkit/api, @bpmnkit/ascii, @bpmnkit/connector-gen, @bpmnkit/connectors, @bpmnkit/patterns, @bpmnkit/worker-client, @bpmnkit/cli.
5
+ Version 1.0.0. 237 chunks documenting @bpmnkit/core, @bpmnkit/canvas, @bpmnkit/editor, @bpmnkit/engine, @bpmnkit/feel, @bpmnkit/plugins, @bpmnkit/api, @bpmnkit/ascii, @bpmnkit/connector-gen, @bpmnkit/connectors, @bpmnkit/patterns, @bpmnkit/worker-client, @bpmnkit/cli.
6
6
 
7
7
  ```sh
8
8
  npm i -D @bpmnkit/docspack
@@ -68,6 +68,13 @@ npx bpmnkit-docs ask "how do I deploy a process"
68
68
  - [Quick Start — Step 2: Simulate locally](.llms/chunks/getting-started.quick-start.step-2-simulate-locally.md) — 157 tokens
69
69
  - [Quick Start — Step 3: Deploy to Camunda 8](.llms/chunks/getting-started.quick-start.step-3-deploy-to-camunda-8.md) — 151 tokens
70
70
  - [Quick Start — What's next?](.llms/chunks/getting-started.quick-start.what-s-next.md) — 140 tokens
71
+ - [Stability and Versioning — What this page is for](.llms/chunks/getting-started.stability.what-this-page-is-for.md) — 241 tokens
72
+ - [Stability and Versioning — Versions are per package, not per repo](.llms/chunks/getting-started.stability.versions-are-per-package-not-per-repo.md) — 179 tokens
73
+ - [Stability and Versioning — What counts as public API](.llms/chunks/getting-started.stability.what-counts-as-public-api.md) — 416 tokens
74
+ - [Stability and Versioning — What is a breaking change](.llms/chunks/getting-started.stability.what-is-a-breaking-change.md) — 776 tokens
75
+ - [Stability and Versioning — What is not a breaking change](.llms/chunks/getting-started.stability.what-is-not-a-breaking-change.md) — 262 tokens
76
+ - [Stability and Versioning — Deprecation](.llms/chunks/getting-started.stability.deprecation.md) — 142 tokens
77
+ - [Stability and Versioning — Support window](.llms/chunks/getting-started.stability.support-window.md) — 497 tokens
71
78
 
72
79
  ## guides
73
80
 
@@ -83,9 +90,10 @@ npx bpmnkit-docs ask "how do I deploy a process"
83
90
  - [Building Processes with AI — Deploying](.llms/chunks/guides.ai-implement.deploying.md) — 255 tokens
84
91
  - [Building Processes with AI — Extending an existing process](.llms/chunks/guides.ai-implement.extending-an-existing-process.md) — 100 tokens
85
92
  - [AI Integration](.llms/chunks/guides.ai.md) — 478 tokens
86
- - [AI Integration — Minimal Empty Diagram](.llms/chunks/guides.ai.minimal-empty-diagram.md) — 229 tokens
93
+ - [AI Integration — Minimal Empty Diagram](.llms/chunks/guides.ai.minimal-empty-diagram.md) — 247 tokens
87
94
  - [AI Integration — Claude API Example](.llms/chunks/guides.ai.claude-api-example.md) — 226 tokens
88
95
  - [AI Integration — OpenAI Function Calling](.llms/chunks/guides.ai.openai-function-calling.md) — 192 tokens
96
+ - [AI Integration — Previewing While the Model Writes](.llms/chunks/guides.ai.previewing-while-the-model-writes.md) — 687 tokens
89
97
  - [AI Integration — MCP Server](.llms/chunks/guides.ai.mcp-server.md) — 151 tokens
90
98
  - [Building Processes — Service Tasks](.llms/chunks/guides.building-processes.service-tasks.md) — 202 tokens
91
99
  - [Building Processes — Events](.llms/chunks/guides.building-processes.events.md) — 244 tokens
@@ -124,6 +132,15 @@ npx bpmnkit-docs ask "how do I deploy a process"
124
132
  - [Simulation — Message Correlation](.llms/chunks/guides.simulation.message-correlation.md) — 144 tokens
125
133
  - [Simulation — DMN Decision Evaluation](.llms/chunks/guides.simulation.dmn-decision-evaluation.md) — 251 tokens
126
134
  - [Simulation — Multiple Deployments](.llms/chunks/guides.simulation.multiple-deployments.md) — 85 tokens
135
+ - [Using BPMN Kit with AI](.llms/chunks/guides.using-bpmnkit-with-ai.md) — 210 tokens
136
+ - [Using BPMN Kit with AI — The two packs BPMN Kit ships](.llms/chunks/guides.using-bpmnkit-with-ai.the-two-packs-bpmn-kit-ships.md) — 147 tokens
137
+ - [Using BPMN Kit with AI — Telling an agent they exist](.llms/chunks/guides.using-bpmnkit-with-ai.telling-an-agent-they-exist.md) — 224 tokens
138
+ - [Using BPMN Kit with AI — Asking](.llms/chunks/guides.using-bpmnkit-with-ai.asking.md) — 314 tokens
139
+ - [Using BPMN Kit with AI — From the library instead of the CLI](.llms/chunks/guides.using-bpmnkit-with-ai.from-the-library-instead-of-the-cli.md) — 706 tokens
140
+ - [Using BPMN Kit with AI — From the library instead of the CLI — The other route: `docspack index`](.llms/chunks/guides.using-bpmnkit-with-ai.from-the-library-instead-of-the-cli-the-other-route-docspack-index.md) — 551 tokens
141
+ - [Using BPMN Kit with AI — The whole loop: five Markdown files to a BPMN diagram](.llms/chunks/guides.using-bpmnkit-with-ai.the-whole-loop-five-markdown-files-to-a-bpmn-diagram.md) — 604 tokens
142
+ - [Using BPMN Kit with AI — Runnable examples](.llms/chunks/guides.using-bpmnkit-with-ai.runnable-examples.md) — 312 tokens
143
+ - [Using BPMN Kit with AI — Where to go next](.llms/chunks/guides.using-bpmnkit-with-ai.where-to-go-next.md) — 117 tokens
127
144
  - [VS Code Extension](.llms/chunks/guides.vscode.md) — 139 tokens
128
145
  - [VS Code Extension — Installing](.llms/chunks/guides.vscode.installing.md) — 140 tokens
129
146
  - [VS Code Extension — What it does — Preview beside the source](.llms/chunks/guides.vscode.what-it-does-preview-beside-the-source.md) — 131 tokens
@@ -151,6 +168,16 @@ npx bpmnkit-docs ask "how do I deploy a process"
151
168
  - [@bpmnkit/api — Process Operations](.llms/chunks/packages.api.process-operations.md) — 238 tokens
152
169
  - [@bpmnkit/api — Incident Resolution](.llms/chunks/packages.api.incident-resolution.md) — 137 tokens
153
170
  - [@bpmnkit/api — Observability Events](.llms/chunks/packages.api.observability-events.md) — 94 tokens
171
+ - [@bpmnkit/ascii — Overview](.llms/chunks/packages.ascii.overview.md) — 170 tokens
172
+ - [@bpmnkit/ascii — Installation](.llms/chunks/packages.ascii.installation.md) — 303 tokens
173
+ - [@bpmnkit/ascii — Rendering a decision table](.llms/chunks/packages.ascii.rendering-a-decision-table.md) — 197 tokens
174
+ - [@bpmnkit/ascii — Rendering a form](.llms/chunks/packages.ascii.rendering-a-form.md) — 262 tokens
175
+ - [@bpmnkit/ascii — From the command line](.llms/chunks/packages.ascii.from-the-command-line.md) — 152 tokens
176
+ - [@bpmnkit/camunda-docspack — Overview](.llms/chunks/packages.camunda-docspack.overview.md) — 308 tokens
177
+ - [@bpmnkit/camunda-docspack — Installation](.llms/chunks/packages.camunda-docspack.installation.md) — 252 tokens
178
+ - [@bpmnkit/camunda-docspack — What makes this corpus different](.llms/chunks/packages.camunda-docspack.what-makes-this-corpus-different.md) — 192 tokens
179
+ - [@bpmnkit/camunda-docspack — Rebuilding it](.llms/chunks/packages.camunda-docspack.rebuilding-it.md) — 227 tokens
180
+ - [@bpmnkit/camunda-docspack — A note on the pack's name](.llms/chunks/packages.camunda-docspack.a-note-on-the-pack-s-name.md) — 165 tokens
154
181
  - [@bpmnkit/canvas — Overview](.llms/chunks/packages.canvas.overview.md) — 161 tokens
155
182
  - [@bpmnkit/canvas — Options](.llms/chunks/packages.canvas.options.md) — 147 tokens
156
183
  - [@bpmnkit/canvas — Events](.llms/chunks/packages.canvas.events.md) — 269 tokens
@@ -162,6 +189,13 @@ npx bpmnkit-docs ask "how do I deploy a process"
162
189
  - [@bpmnkit/connector-gen — Lower-level API](.llms/chunks/packages.connector-gen.lower-level-api.md) — 185 tokens
163
190
  - [@bpmnkit/connector-gen — Catalog reference](.llms/chunks/packages.connector-gen.catalog-reference.md) — 518 tokens
164
191
  - [@bpmnkit/connector-gen — `CatalogEntry` type](.llms/chunks/packages.connector-gen.catalogentry-type.md) — 86 tokens
192
+ - [@bpmnkit/connectors — Overview](.llms/chunks/packages.connectors.overview.md) — 146 tokens
193
+ - [@bpmnkit/connectors — Installation](.llms/chunks/packages.connectors.installation.md) — 240 tokens
194
+ - [@bpmnkit/connectors — Applying a template](.llms/chunks/packages.connectors.applying-a-template.md) — 432 tokens
195
+ - [@bpmnkit/connectors — Workspace templates](.llms/chunks/packages.connectors.workspace-templates.md) — 189 tokens
196
+ - [@bpmnkit/connectors — Validating a template](.llms/chunks/packages.connectors.validating-a-template.md) — 213 tokens
197
+ - [@bpmnkit/connectors — API Reference](.llms/chunks/packages.connectors.api-reference.md) — 230 tokens
198
+ - [@bpmnkit/connectors — Stability](.llms/chunks/packages.connectors.stability.md) — 137 tokens
165
199
  - [@bpmnkit/core — Overview](.llms/chunks/packages.core.overview.md) — 136 tokens
166
200
  - [@bpmnkit/core — Installation](.llms/chunks/packages.core.installation.md) — 27 tokens
167
201
  - [@bpmnkit/core — Installation — `Bpmn.createProcess(id, name?)`](.llms/chunks/packages.core.installation-bpmn.createprocess-id-name.md) — 51 tokens
@@ -179,22 +213,24 @@ npx bpmnkit-docs ask "how do I deploy a process"
179
213
  - [@bpmnkit/core — Installation — `applyBpmnOperations(definitions, operations, options?)`](.llms/chunks/packages.core.installation-applybpmnoperations-definitions-operations-options.md) — 235 tokens
180
214
  - [@bpmnkit/core — Installation — `ensureZeebeExtension(owner, extension)`](.llms/chunks/packages.core.installation-ensurezeebeextension-owner-extension.md) — 323 tokens
181
215
  - [@bpmnkit/core — Installation — `reconcileCompact(definitions, compact, options?)`](.llms/chunks/packages.core.installation-reconcilecompact-definitions-compact-options.md) — 129 tokens
182
- - [@bpmnkit/core — Installation — `compactify(definitions)`](.llms/chunks/packages.core.installation-compactify-definitions.md) — 204 tokens
216
+ - [@bpmnkit/core — Installation — `compactify(definitions)`](.llms/chunks/packages.core.installation-compactify-definitions.md) — 342 tokens
183
217
  - [@bpmnkit/core — Installation — `expand(compact)`](.llms/chunks/packages.core.installation-expand-compact.md) — 164 tokens
218
+ - [@bpmnkit/core — Installation — `createCompactStream(options?)`](.llms/chunks/packages.core.installation-createcompactstream-options.md) — 502 tokens
184
219
  - [@bpmnkit/core — Installation — `retypeElement(element, type)`](.llms/chunks/packages.core.installation-retypeelement-element-type.md) — 189 tokens
185
220
  - [@bpmnkit/core — Installation — `createFlowElement(id, type, options?)`](.llms/chunks/packages.core.installation-createflowelement-id-type-options.md) — 61 tokens
186
221
  - [@bpmnkit/core — Installation — Element catalog](.llms/chunks/packages.core.installation-element-catalog.md) — 96 tokens
187
222
  - [@bpmnkit/core — Installation — `layoutProcess(process)`](.llms/chunks/packages.core.installation-layoutprocess-process.md) — 85 tokens
188
223
  - [@bpmnkit/core — Installation — ProcessBuilder methods](.llms/chunks/packages.core.installation-processbuilder-methods.md) — 698 tokens
189
224
  - [@bpmnkit/core — Installation — Ad-hoc sub-processes: children are a set, not a chain](.llms/chunks/packages.core.installation-ad-hoc-sub-processes-children-are-a-set-not-a-chain.md) — 368 tokens
190
- - [@bpmnkit/core — Installation — Joins: inferred by default, or declared](.llms/chunks/packages.core.installation-joins-inferred-by-default-or-declared.md) — 314 tokens
225
+ - [@bpmnkit/core — Installation — Joins: inferred by default, or declared](.llms/chunks/packages.core.installation-joins-inferred-by-default-or-declared.md) — 324 tokens
191
226
  - [@bpmnkit/core — Writing files — `@bpmnkit/core/node`](.llms/chunks/packages.core.writing-files-bpmnkit-core-node.md) — 52 tokens
192
227
  - [@bpmnkit/core — Writing files — `@bpmnkit/core/node` — `writeBpmn(definitions, options)`](.llms/chunks/packages.core.writing-files-bpmnkit-core-node-writebpmn-definitions-options.md) — 440 tokens
193
228
  - [@bpmnkit/core — Writing files — `@bpmnkit/core/node` — `exportPreserving(original, definitions)`](.llms/chunks/packages.core.writing-files-bpmnkit-core-node-exportpreserving-original-definitions.md) — 598 tokens
194
229
  - [@bpmnkit/core — DMN Support](.llms/chunks/packages.core.dmn-support.md) — 113 tokens
195
230
  - [@bpmnkit/docspack — Overview](.llms/chunks/packages.docspack.overview.md) — 252 tokens
196
- - [@bpmnkit/docspack — Installation](.llms/chunks/packages.docspack.installation.md) — 251 tokens
197
- - [@bpmnkit/docspack — Reading it yourself](.llms/chunks/packages.docspack.reading-it-yourself.md) — 252 tokens
231
+ - [@bpmnkit/docspack — The other pack](.llms/chunks/packages.docspack.the-other-pack.md) — 145 tokens
232
+ - [@bpmnkit/docspack — Giving an agent access](.llms/chunks/packages.docspack.giving-an-agent-access.md) — 268 tokens
233
+ - [@bpmnkit/docspack — Reading it yourself](.llms/chunks/packages.docspack.reading-it-yourself.md) — 329 tokens
198
234
  - [@bpmnkit/docspack — Using the index directly](.llms/chunks/packages.docspack.using-the-index-directly.md) — 320 tokens
199
235
  - [@bpmnkit/docspack — Trust](.llms/chunks/packages.docspack.trust.md) — 118 tokens
200
236
  - [@bpmnkit/editor — Overview](.llms/chunks/packages.editor.overview.md) — 135 tokens
@@ -205,6 +241,16 @@ npx bpmnkit-docs ask "how do I deploy a process"
205
241
  - [@bpmnkit/engine — Installation](.llms/chunks/packages.engine.installation.md) — 346 tokens
206
242
  - [@bpmnkit/engine — ProcessInstance](.llms/chunks/packages.engine.processinstance.md) — 161 tokens
207
243
  - [@bpmnkit/engine — Variable Scoping](.llms/chunks/packages.engine.variable-scoping.md) — 148 tokens
244
+ - [@bpmnkit/feel — Overview](.llms/chunks/packages.feel.overview.md) — 152 tokens
245
+ - [@bpmnkit/feel — Installation](.llms/chunks/packages.feel.installation.md) — 264 tokens
246
+ - [@bpmnkit/feel — Unary tests](.llms/chunks/packages.feel.unary-tests.md) — 425 tokens
247
+ - [@bpmnkit/feel — Formatting and highlighting](.llms/chunks/packages.feel.formatting-and-highlighting.md) — 151 tokens
248
+ - [@bpmnkit/feel — API Reference](.llms/chunks/packages.feel.api-reference.md) — 356 tokens
249
+ - [@bpmnkit/feel — Stability](.llms/chunks/packages.feel.stability.md) — 39 tokens
250
+ - [@bpmnkit/plugins — Overview](.llms/chunks/packages.plugins.overview.md) — 162 tokens
251
+ - [@bpmnkit/plugins — Installation](.llms/chunks/packages.plugins.installation.md) — 134 tokens
252
+ - [@bpmnkit/plugins — What is available](.llms/chunks/packages.plugins.what-is-available.md) — 738 tokens
253
+ - [@bpmnkit/plugins — Styles](.llms/chunks/packages.plugins.styles.md) — 247 tokens
208
254
  - [@bpmnkit/worker-client](.llms/chunks/packages.worker-client.md) — 141 tokens
209
255
  - [@bpmnkit/worker-client — `createWorkerClient(options?)`](.llms/chunks/packages.worker-client.createworkerclient-options.md) — 267 tokens
210
256
  - [@bpmnkit/worker-client — `client.poll(jobType, options?)`](.llms/chunks/packages.worker-client.client.poll-jobtype-options.md) — 265 tokens
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bpmnkit/docspack",
3
- "version": "0.0.5",
3
+ "version": "1.0.0",
4
4
  "type": "module",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",