@bpmnkit/core 0.8.0 → 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.
- package/README.md +25 -1
- package/dist/bpmn/bpmn-builder.d.ts +1 -12
- package/dist/bpmn/bpmn-builder.js +2 -3
- package/dist/bpmn/bpmn-parser.js +4 -4
- package/dist/bpmn/compact-stream.d.ts +64 -0
- package/dist/bpmn/compact-stream.js +167 -0
- package/dist/dmn/dmn-parser.js +4 -3
- package/dist/form/form-parser.js +29 -28
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -0
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
[](https://github.com/bpmnkit/monorepo/blob/main/LICENSE)
|
|
8
8
|
[](https://github.com/bpmnkit/monorepo)
|
|
9
9
|
[](https://github.com/bpmnkit/monorepo)
|
|
10
|
-
[](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/core/CHANGELOG.md)
|
|
13
13
|
</div>
|
|
@@ -205,6 +205,29 @@ const restored = expand(JSON.parse(json))
|
|
|
205
205
|
const outXml = Bpmn.export(restored)
|
|
206
206
|
```
|
|
207
207
|
|
|
208
|
+
### Rendering while the model is still writing
|
|
209
|
+
|
|
210
|
+
A model emits a diagram one token at a time, and the outermost `}` — the one
|
|
211
|
+
`JSON.parse` waits for — is the last character it sends. `createCompactStream`
|
|
212
|
+
reads the elements out of the text as their own literals close, so there is
|
|
213
|
+
something to draw long before the document is finished:
|
|
214
|
+
|
|
215
|
+
```typescript
|
|
216
|
+
import { createCompactStream } from "@bpmnkit/core"
|
|
217
|
+
|
|
218
|
+
// `base` is the diagram being edited, so a frame shows the whole thing rather
|
|
219
|
+
// than the fragment the model is adding to it. Omit it to build from nothing.
|
|
220
|
+
const diagramStream = createCompactStream({ base: null })
|
|
221
|
+
|
|
222
|
+
function onModelChunk(chunk: string): void {
|
|
223
|
+
const frame = diagramStream.push(chunk) // null until the frame changes
|
|
224
|
+
if (frame) console.log("elements so far:", frame.processes[0]?.flowElements.length)
|
|
225
|
+
}
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
Frames are a guess at an unfinished document: `push` never throws, drops what it
|
|
229
|
+
cannot place, and expects the caller to have an authoritative result coming.
|
|
230
|
+
|
|
208
231
|
## API Reference
|
|
209
232
|
|
|
210
233
|
### BPMN
|
|
@@ -301,6 +324,7 @@ const { semanticHash, changes } = await writeBpmn(defs, { output: "flow.bpmn" })
|
|
|
301
324
|
| `optimize(defs)` | Run all optimization rules; returns `OptimizeReport` |
|
|
302
325
|
| `compactify(defs)` | Convert to compact `CompactDiagram` |
|
|
303
326
|
| `expand(compact)` | Restore full `BpmnDefinitions` |
|
|
327
|
+
| `createCompactStream(opts?)` | Read a diagram out of a model's token stream, frame by frame |
|
|
304
328
|
| `generateId(prefix)` | Generate a unique short ID |
|
|
305
329
|
|
|
306
330
|
---
|
|
@@ -159,16 +159,6 @@ export interface BuildOptions {
|
|
|
159
159
|
* that cannot see what it did not emit.
|
|
160
160
|
*/
|
|
161
161
|
explicitJoins?: boolean;
|
|
162
|
-
/**
|
|
163
|
-
* The former name for {@link BuildOptions.explicitJoins}, still honoured.
|
|
164
|
-
*
|
|
165
|
-
* Renamed because "strict" says nothing about what it is strict *about*, and
|
|
166
|
-
* because `applyBpmnOperations` takes a `strict` that means something else
|
|
167
|
-
* entirely — whether to throw or report problems.
|
|
168
|
-
*
|
|
169
|
-
* @deprecated Use `explicitJoins`.
|
|
170
|
-
*/
|
|
171
|
-
strict?: boolean;
|
|
172
162
|
}
|
|
173
163
|
/** Options for a collaboration participant (a pool). */
|
|
174
164
|
export interface ParticipantOptions {
|
|
@@ -842,8 +832,7 @@ export declare class ProcessBuilder {
|
|
|
842
832
|
* says: inference reads the whole topology, and on a document you were handed
|
|
843
833
|
* that means rewriting edges you never touched.
|
|
844
834
|
*
|
|
845
|
-
* @param options - `explicitJoins` refuses inferred join gateways.
|
|
846
|
-
* the former name for it and still works.
|
|
835
|
+
* @param options - `explicitJoins` refuses inferred join gateways.
|
|
847
836
|
*/
|
|
848
837
|
build(options?: BuildOptions): BpmnDefinitions;
|
|
849
838
|
/**
|
|
@@ -2161,8 +2161,7 @@ export class ProcessBuilder {
|
|
|
2161
2161
|
* says: inference reads the whole topology, and on a document you were handed
|
|
2162
2162
|
* that means rewriting edges you never touched.
|
|
2163
2163
|
*
|
|
2164
|
-
* @param options - `explicitJoins` refuses inferred join gateways.
|
|
2165
|
-
* the former name for it and still works.
|
|
2164
|
+
* @param options - `explicitJoins` refuses inferred join gateways.
|
|
2166
2165
|
*/
|
|
2167
2166
|
build(options) {
|
|
2168
2167
|
this.resolvePendingSplice();
|
|
@@ -2174,7 +2173,7 @@ export class ProcessBuilder {
|
|
|
2174
2173
|
// that needs a join here means saying so with `.connectTo(joinId)`.
|
|
2175
2174
|
if (this._source === undefined)
|
|
2176
2175
|
insertJoinGateways(this.flowElements, this.sequenceFlows);
|
|
2177
|
-
const explicitJoins = options?.explicitJoins ??
|
|
2176
|
+
const explicitJoins = options?.explicitJoins ?? false;
|
|
2178
2177
|
if (explicitJoins && this.flowElements.length > beforeCount) {
|
|
2179
2178
|
const inserted = this.flowElements
|
|
2180
2179
|
.slice(beforeCount)
|
package/dist/bpmn/bpmn-parser.js
CHANGED
|
@@ -1343,7 +1343,7 @@ class ShapeFrame extends Frame {
|
|
|
1343
1343
|
finish() {
|
|
1344
1344
|
const attrs = this.attrs;
|
|
1345
1345
|
if (!this.bounds)
|
|
1346
|
-
throw new
|
|
1346
|
+
throw new ParseError(`Missing <dc:Bounds> in shape "${attr(attrs, "id")}"`);
|
|
1347
1347
|
this.target.push({
|
|
1348
1348
|
id: requiredAttr(attrs, "id", this.name),
|
|
1349
1349
|
bpmnElement: requiredAttr(attrs, "bpmnElement", this.name),
|
|
@@ -1451,7 +1451,7 @@ class DiagramFrame extends Frame {
|
|
|
1451
1451
|
finish() {
|
|
1452
1452
|
const plane = this.plane;
|
|
1453
1453
|
if (!plane)
|
|
1454
|
-
throw new
|
|
1454
|
+
throw new ParseError("Missing <bpmndi:BPMNPlane> in diagram");
|
|
1455
1455
|
this.target.push({
|
|
1456
1456
|
id: requiredAttr(this.attrs, "id", this.name),
|
|
1457
1457
|
plane: {
|
|
@@ -1596,9 +1596,9 @@ class BpmnSink {
|
|
|
1596
1596
|
export function parseBpmn(xml) {
|
|
1597
1597
|
const sink = new BpmnSink();
|
|
1598
1598
|
if (!scanXml(xml, sink))
|
|
1599
|
-
throw new
|
|
1599
|
+
throw new ParseError("Failed to parse XML: no root element found");
|
|
1600
1600
|
if (sink.rootName !== undefined) {
|
|
1601
|
-
throw new
|
|
1601
|
+
throw new ParseError(`Expected <definitions> root element, got <${sink.rootName}>`);
|
|
1602
1602
|
}
|
|
1603
1603
|
return sink.result;
|
|
1604
1604
|
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The diagram a model is writing, read out of the tokens as they arrive.
|
|
3
|
+
*
|
|
4
|
+
* A language model emits a diagram one character at a time, so the shape of a
|
|
5
|
+
* process is knowable long before its last token. Nothing downstream can use a
|
|
6
|
+
* half-written document, though: `JSON.parse` wants the closing brace, and the
|
|
7
|
+
* outermost one — the tool argument's own wrapper — is the very last character
|
|
8
|
+
* sent.
|
|
9
|
+
*
|
|
10
|
+
* So this does not parse the document. It picks complete `{…}` object literals
|
|
11
|
+
* out of the text as they close and keeps the ones shaped like a
|
|
12
|
+
* {@link CompactElement} or a {@link CompactFlow}, which are the innermost
|
|
13
|
+
* objects and therefore the first to finish. That is also what makes it
|
|
14
|
+
* indifferent to what it is reading: a `replace_diagram` argument, a ```json
|
|
15
|
+
* block in an assistant's prose, or the body of a `compose_diagram` snippet all
|
|
16
|
+
* carry the same literals, and none of them have to be valid as a whole.
|
|
17
|
+
*
|
|
18
|
+
* **Frames are advisory.** Everything here is a guess at an unfinished
|
|
19
|
+
* document, and the caller is expected to have an authoritative result coming.
|
|
20
|
+
* That is what lets it drop what it cannot place instead of reporting an error,
|
|
21
|
+
* and why it never throws on input.
|
|
22
|
+
*
|
|
23
|
+
* @packageDocumentation
|
|
24
|
+
*/
|
|
25
|
+
import type { BpmnDefinitions } from "./bpmn-model.js";
|
|
26
|
+
import type { CompactDiagram } from "./compact.js";
|
|
27
|
+
/** Options for {@link createCompactStream}. */
|
|
28
|
+
export interface CompactStreamOptions {
|
|
29
|
+
/**
|
|
30
|
+
* The diagram being edited.
|
|
31
|
+
*
|
|
32
|
+
* A model changing an existing process streams only what it is adding, so
|
|
33
|
+
* without this a frame is a disconnected fragment rather than the diagram
|
|
34
|
+
* with the fragment in it. Only the first process is previewed; a frame is
|
|
35
|
+
* one process, whatever the document turns out to hold.
|
|
36
|
+
*/
|
|
37
|
+
base?: CompactDiagram | null;
|
|
38
|
+
}
|
|
39
|
+
/** A diagram assembled from a text stream. See {@link createCompactStream}. */
|
|
40
|
+
export interface CompactStream {
|
|
41
|
+
/**
|
|
42
|
+
* Adds the next piece of text.
|
|
43
|
+
*
|
|
44
|
+
* @returns The diagram as it now stands, or `null` when this chunk added
|
|
45
|
+
* nothing renderable — no new element, or not enough for a diagram yet.
|
|
46
|
+
*/
|
|
47
|
+
push(chunk: string): BpmnDefinitions | null;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Reads a diagram out of a stream of text.
|
|
51
|
+
*
|
|
52
|
+
* @param options - See {@link CompactStreamOptions}.
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```typescript
|
|
56
|
+
* const stream = createCompactStream({ base: currentDiagram })
|
|
57
|
+
* for await (const chunk of tokens) {
|
|
58
|
+
* const defs = stream.push(chunk)
|
|
59
|
+
* if (defs) render(defs)
|
|
60
|
+
* }
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
export declare function createCompactStream(options?: CompactStreamOptions): CompactStream;
|
|
64
|
+
//# sourceMappingURL=compact-stream.d.ts.map
|
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The diagram a model is writing, read out of the tokens as they arrive.
|
|
3
|
+
*
|
|
4
|
+
* A language model emits a diagram one character at a time, so the shape of a
|
|
5
|
+
* process is knowable long before its last token. Nothing downstream can use a
|
|
6
|
+
* half-written document, though: `JSON.parse` wants the closing brace, and the
|
|
7
|
+
* outermost one — the tool argument's own wrapper — is the very last character
|
|
8
|
+
* sent.
|
|
9
|
+
*
|
|
10
|
+
* So this does not parse the document. It picks complete `{…}` object literals
|
|
11
|
+
* out of the text as they close and keeps the ones shaped like a
|
|
12
|
+
* {@link CompactElement} or a {@link CompactFlow}, which are the innermost
|
|
13
|
+
* objects and therefore the first to finish. That is also what makes it
|
|
14
|
+
* indifferent to what it is reading: a `replace_diagram` argument, a ```json
|
|
15
|
+
* block in an assistant's prose, or the body of a `compose_diagram` snippet all
|
|
16
|
+
* carry the same literals, and none of them have to be valid as a whole.
|
|
17
|
+
*
|
|
18
|
+
* **Frames are advisory.** Everything here is a guess at an unfinished
|
|
19
|
+
* document, and the caller is expected to have an authoritative result coming.
|
|
20
|
+
* That is what lets it drop what it cannot place instead of reporting an error,
|
|
21
|
+
* and why it never throws on input.
|
|
22
|
+
*
|
|
23
|
+
* @packageDocumentation
|
|
24
|
+
*/
|
|
25
|
+
import { expand } from "./compact.js";
|
|
26
|
+
import { ELEMENT_TYPE_GROUPS } from "./element-catalog.js";
|
|
27
|
+
function isRecord(value) {
|
|
28
|
+
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Reads a diagram out of a stream of text.
|
|
32
|
+
*
|
|
33
|
+
* @param options - See {@link CompactStreamOptions}.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```typescript
|
|
37
|
+
* const stream = createCompactStream({ base: currentDiagram })
|
|
38
|
+
* for await (const chunk of tokens) {
|
|
39
|
+
* const defs = stream.push(chunk)
|
|
40
|
+
* if (defs) render(defs)
|
|
41
|
+
* }
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
export function createCompactStream(options) {
|
|
45
|
+
const baseProcess = options?.base?.processes[0];
|
|
46
|
+
const elements = new Map();
|
|
47
|
+
const flows = new Map();
|
|
48
|
+
for (const element of baseProcess?.elements ?? [])
|
|
49
|
+
elements.set(element.id, element);
|
|
50
|
+
for (const flow of baseProcess?.flows ?? [])
|
|
51
|
+
flows.set(flow.id, flow);
|
|
52
|
+
const documentId = options?.base?.id ?? "Definitions_1";
|
|
53
|
+
const processId = baseProcess?.id ?? "Process_1";
|
|
54
|
+
const processName = baseProcess?.name;
|
|
55
|
+
let text = "";
|
|
56
|
+
/** How far `scan` has read. Every character is looked at exactly once. */
|
|
57
|
+
let read = 0;
|
|
58
|
+
/** Offsets of the `{`s that are still open, outermost first. */
|
|
59
|
+
const open = [];
|
|
60
|
+
let inString = false;
|
|
61
|
+
let escaped = false;
|
|
62
|
+
let changed = false;
|
|
63
|
+
/** Drops a container's contents from the top level — they belong to it. */
|
|
64
|
+
function forget(children) {
|
|
65
|
+
for (const child of children?.elements ?? []) {
|
|
66
|
+
elements.delete(child.id);
|
|
67
|
+
forget(child.children);
|
|
68
|
+
}
|
|
69
|
+
for (const flow of children?.flows ?? [])
|
|
70
|
+
flows.delete(flow.id);
|
|
71
|
+
}
|
|
72
|
+
/** Keeps `value` if it is an element or a flow. */
|
|
73
|
+
function take(value) {
|
|
74
|
+
if (!isRecord(value) || typeof value.id !== "string" || value.id === "")
|
|
75
|
+
return;
|
|
76
|
+
if (typeof value.type === "string" && Object.hasOwn(ELEMENT_TYPE_GROUPS, value.type)) {
|
|
77
|
+
const element = value;
|
|
78
|
+
forget(element.children);
|
|
79
|
+
elements.set(element.id, element);
|
|
80
|
+
changed = true;
|
|
81
|
+
return;
|
|
82
|
+
}
|
|
83
|
+
if (typeof value.from === "string" && typeof value.to === "string") {
|
|
84
|
+
// `isDefault` is dropped rather than carried: `expand` throws when a flow
|
|
85
|
+
// claims a gateway that has not been written yet, which during a stream is
|
|
86
|
+
// most of the time. A preview without the marker beats no preview.
|
|
87
|
+
const { isDefault: _dropped, ...flow } = value;
|
|
88
|
+
flows.set(flow.id, flow);
|
|
89
|
+
changed = true;
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Reads the new text once, taking each literal at the `}` that closes it.
|
|
94
|
+
*
|
|
95
|
+
* A brace stack rather than a re-scan: every character is looked at exactly
|
|
96
|
+
* once across the whole stream, and each literal is considered exactly once,
|
|
97
|
+
* innermost first — so a container is seen after the children it has to
|
|
98
|
+
* reclaim, and the tool argument's own wrapper is not waited on.
|
|
99
|
+
*/
|
|
100
|
+
function scan() {
|
|
101
|
+
for (; read < text.length; read++) {
|
|
102
|
+
const ch = text[read];
|
|
103
|
+
if (escaped) {
|
|
104
|
+
escaped = false;
|
|
105
|
+
continue;
|
|
106
|
+
}
|
|
107
|
+
if (ch === "\\") {
|
|
108
|
+
escaped = true;
|
|
109
|
+
continue;
|
|
110
|
+
}
|
|
111
|
+
if (ch === '"') {
|
|
112
|
+
inString = !inString;
|
|
113
|
+
continue;
|
|
114
|
+
}
|
|
115
|
+
if (inString)
|
|
116
|
+
continue;
|
|
117
|
+
if (ch === "{") {
|
|
118
|
+
open.push(read);
|
|
119
|
+
continue;
|
|
120
|
+
}
|
|
121
|
+
if (ch !== "}")
|
|
122
|
+
continue;
|
|
123
|
+
const start = open.pop();
|
|
124
|
+
if (start === undefined)
|
|
125
|
+
continue; // a stray brace in prose
|
|
126
|
+
try {
|
|
127
|
+
take(JSON.parse(text.slice(start, read + 1)));
|
|
128
|
+
}
|
|
129
|
+
catch {
|
|
130
|
+
/* not a literal we can read */
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
return {
|
|
135
|
+
push(chunk) {
|
|
136
|
+
text += chunk;
|
|
137
|
+
scan();
|
|
138
|
+
if (!changed)
|
|
139
|
+
return null;
|
|
140
|
+
changed = false;
|
|
141
|
+
const kept = [...elements.values()];
|
|
142
|
+
if (kept.length === 0)
|
|
143
|
+
return null;
|
|
144
|
+
const known = new Set(kept.map((element) => element.id));
|
|
145
|
+
const diagram = {
|
|
146
|
+
id: documentId,
|
|
147
|
+
processes: [
|
|
148
|
+
{
|
|
149
|
+
id: processId,
|
|
150
|
+
name: processName,
|
|
151
|
+
elements: kept,
|
|
152
|
+
// A flow whose other end has not been written yet lays out as
|
|
153
|
+
// nothing; one naming an element that never arrives would too.
|
|
154
|
+
flows: [...flows.values()].filter((flow) => known.has(flow.from) && known.has(flow.to)),
|
|
155
|
+
},
|
|
156
|
+
],
|
|
157
|
+
};
|
|
158
|
+
try {
|
|
159
|
+
return expand(diagram);
|
|
160
|
+
}
|
|
161
|
+
catch {
|
|
162
|
+
return null; // an element whose fields have not all arrived
|
|
163
|
+
}
|
|
164
|
+
},
|
|
165
|
+
};
|
|
166
|
+
}
|
|
167
|
+
//# sourceMappingURL=compact-stream.js.map
|
package/dist/dmn/dmn-parser.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ParseError } from "../errors.js";
|
|
1
2
|
import { parseXml } from "../xml/xml-parser.js";
|
|
2
3
|
const DMN_NS = "https://www.omg.org/spec/DMN/20191111/MODEL/";
|
|
3
4
|
/** Strip namespace prefix from a tag name. */
|
|
@@ -28,7 +29,7 @@ function attr(element, name) {
|
|
|
28
29
|
function requiredAttr(element, name) {
|
|
29
30
|
const value = attr(element, name);
|
|
30
31
|
if (value === undefined) {
|
|
31
|
-
throw new
|
|
32
|
+
throw new ParseError(`Missing required attribute "${name}" on element <${element.name}>`);
|
|
32
33
|
}
|
|
33
34
|
return value;
|
|
34
35
|
}
|
|
@@ -59,7 +60,7 @@ function parseInputExpression(el) {
|
|
|
59
60
|
function parseInput(el) {
|
|
60
61
|
const exprEl = findChild(el, "inputExpression");
|
|
61
62
|
if (!exprEl) {
|
|
62
|
-
throw new
|
|
63
|
+
throw new ParseError(`Missing <inputExpression> in input "${attr(el, "id")}"`);
|
|
63
64
|
}
|
|
64
65
|
return {
|
|
65
66
|
id: requiredAttr(el, "id"),
|
|
@@ -231,7 +232,7 @@ function parseDiagram(dmndiEl) {
|
|
|
231
232
|
export function parseDmn(xml) {
|
|
232
233
|
const root = parseXml(xml);
|
|
233
234
|
if (localName(root.name) !== "definitions") {
|
|
234
|
-
throw new
|
|
235
|
+
throw new ParseError(`Expected <definitions> root element, got <${root.name}>`);
|
|
235
236
|
}
|
|
236
237
|
// Extract namespace declarations
|
|
237
238
|
const namespaces = {};
|
package/dist/form/form-parser.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ParseError } from "../errors.js";
|
|
1
2
|
const KNOWN_COMPONENT_TYPES = new Set([
|
|
2
3
|
"text",
|
|
3
4
|
"textfield",
|
|
@@ -29,20 +30,20 @@ export function parseForm(json) {
|
|
|
29
30
|
raw = JSON.parse(json);
|
|
30
31
|
}
|
|
31
32
|
catch (e) {
|
|
32
|
-
throw new
|
|
33
|
+
throw new ParseError(`Failed to parse form JSON: ${e.message}`);
|
|
33
34
|
}
|
|
34
35
|
if (typeof raw !== "object" || raw === null || Array.isArray(raw)) {
|
|
35
|
-
throw new
|
|
36
|
+
throw new ParseError("Form JSON must be an object");
|
|
36
37
|
}
|
|
37
38
|
const obj = raw;
|
|
38
39
|
if (typeof obj.id !== "string" || obj.id.length === 0) {
|
|
39
|
-
throw new
|
|
40
|
+
throw new ParseError("Form must have a non-empty 'id' string");
|
|
40
41
|
}
|
|
41
42
|
if (typeof obj.type !== "string") {
|
|
42
|
-
throw new
|
|
43
|
+
throw new ParseError("Form must have a 'type' string");
|
|
43
44
|
}
|
|
44
45
|
if (!Array.isArray(obj.components)) {
|
|
45
|
-
throw new
|
|
46
|
+
throw new ParseError("Form must have a 'components' array");
|
|
46
47
|
}
|
|
47
48
|
const definition = {
|
|
48
49
|
id: obj.id,
|
|
@@ -72,14 +73,14 @@ export function parseForm(json) {
|
|
|
72
73
|
}
|
|
73
74
|
function parseComponent(raw, path) {
|
|
74
75
|
if (typeof raw !== "object" || raw === null || Array.isArray(raw)) {
|
|
75
|
-
throw new
|
|
76
|
+
throw new ParseError(`${path}: component must be an object`);
|
|
76
77
|
}
|
|
77
78
|
const obj = raw;
|
|
78
79
|
if (typeof obj.type !== "string") {
|
|
79
|
-
throw new
|
|
80
|
+
throw new ParseError(`${path}: component must have a 'type' string`);
|
|
80
81
|
}
|
|
81
82
|
if (typeof obj.id !== "string" || obj.id.length === 0) {
|
|
82
|
-
throw new
|
|
83
|
+
throw new ParseError(`${path}: component must have a non-empty 'id'`);
|
|
83
84
|
}
|
|
84
85
|
const layout = parseLayout(obj.layout, path);
|
|
85
86
|
if (!KNOWN_COMPONENT_TYPES.has(obj.type)) {
|
|
@@ -88,7 +89,7 @@ function parseComponent(raw, path) {
|
|
|
88
89
|
switch (obj.type) {
|
|
89
90
|
case "text": {
|
|
90
91
|
if (typeof obj.text !== "string") {
|
|
91
|
-
throw new
|
|
92
|
+
throw new ParseError(`${path}: text component must have a 'text' string`);
|
|
92
93
|
}
|
|
93
94
|
const c = { type: "text", id: obj.id, text: obj.text };
|
|
94
95
|
if (typeof obj.label === "string")
|
|
@@ -147,7 +148,7 @@ function parseLayout(raw, path) {
|
|
|
147
148
|
if (raw === undefined || raw === null)
|
|
148
149
|
return undefined;
|
|
149
150
|
if (typeof raw !== "object" || Array.isArray(raw)) {
|
|
150
|
-
throw new
|
|
151
|
+
throw new ParseError(`${path}.layout: must be an object`);
|
|
151
152
|
}
|
|
152
153
|
const obj = raw;
|
|
153
154
|
const layout = {};
|
|
@@ -165,7 +166,7 @@ function parseValidation(raw, path) {
|
|
|
165
166
|
if (raw === undefined || raw === null)
|
|
166
167
|
return undefined;
|
|
167
168
|
if (typeof raw !== "object" || Array.isArray(raw)) {
|
|
168
|
-
throw new
|
|
169
|
+
throw new ParseError(`${path}.validate: must be an object`);
|
|
169
170
|
}
|
|
170
171
|
const obj = raw;
|
|
171
172
|
const v = {};
|
|
@@ -179,11 +180,11 @@ function parseValidation(raw, path) {
|
|
|
179
180
|
}
|
|
180
181
|
function parseValues(raw, path) {
|
|
181
182
|
if (!Array.isArray(raw)) {
|
|
182
|
-
throw new
|
|
183
|
+
throw new ParseError(`${path}.values: must be an array`);
|
|
183
184
|
}
|
|
184
185
|
return raw.map((v, i) => {
|
|
185
186
|
if (typeof v !== "object" || v === null) {
|
|
186
|
-
throw new
|
|
187
|
+
throw new ParseError(`${path}.values[${i}]: must be an object`);
|
|
187
188
|
}
|
|
188
189
|
const vo = v;
|
|
189
190
|
return {
|
|
@@ -194,10 +195,10 @@ function parseValues(raw, path) {
|
|
|
194
195
|
}
|
|
195
196
|
function parseFieldComponent(obj, type, path, layout) {
|
|
196
197
|
if (typeof obj.label !== "string") {
|
|
197
|
-
throw new
|
|
198
|
+
throw new ParseError(`${path}: ${type} must have a 'label' string`);
|
|
198
199
|
}
|
|
199
200
|
if (typeof obj.key !== "string") {
|
|
200
|
-
throw new
|
|
201
|
+
throw new ParseError(`${path}: ${type} must have a 'key' string`);
|
|
201
202
|
}
|
|
202
203
|
const validate = parseValidation(obj.validate, path);
|
|
203
204
|
const base = {
|
|
@@ -214,10 +215,10 @@ function parseFieldComponent(obj, type, path, layout) {
|
|
|
214
215
|
}
|
|
215
216
|
function parseSelectComponent(obj, path, layout) {
|
|
216
217
|
if (typeof obj.label !== "string") {
|
|
217
|
-
throw new
|
|
218
|
+
throw new ParseError(`${path}: select must have a 'label' string`);
|
|
218
219
|
}
|
|
219
220
|
if (typeof obj.key !== "string") {
|
|
220
|
-
throw new
|
|
221
|
+
throw new ParseError(`${path}: select must have a 'key' string`);
|
|
221
222
|
}
|
|
222
223
|
const c = {
|
|
223
224
|
type: "select",
|
|
@@ -243,10 +244,10 @@ function parseSelectComponent(obj, path, layout) {
|
|
|
243
244
|
}
|
|
244
245
|
function parseValuesComponent(obj, type, path, layout) {
|
|
245
246
|
if (typeof obj.label !== "string") {
|
|
246
|
-
throw new
|
|
247
|
+
throw new ParseError(`${path}: ${type} must have a 'label' string`);
|
|
247
248
|
}
|
|
248
249
|
if (typeof obj.key !== "string") {
|
|
249
|
-
throw new
|
|
250
|
+
throw new ParseError(`${path}: ${type} must have a 'key' string`);
|
|
250
251
|
}
|
|
251
252
|
const values = Array.isArray(obj.values) ? parseValues(obj.values, path) : undefined;
|
|
252
253
|
if (type === "radio") {
|
|
@@ -288,10 +289,10 @@ function parseValuesComponent(obj, type, path, layout) {
|
|
|
288
289
|
}
|
|
289
290
|
function parseCheckboxComponent(obj, path, layout) {
|
|
290
291
|
if (typeof obj.label !== "string") {
|
|
291
|
-
throw new
|
|
292
|
+
throw new ParseError(`${path}: checkbox must have a 'label' string`);
|
|
292
293
|
}
|
|
293
294
|
if (typeof obj.key !== "string") {
|
|
294
|
-
throw new
|
|
295
|
+
throw new ParseError(`${path}: checkbox must have a 'key' string`);
|
|
295
296
|
}
|
|
296
297
|
const c = {
|
|
297
298
|
type: "checkbox",
|
|
@@ -310,10 +311,10 @@ function parseCheckboxComponent(obj, path, layout) {
|
|
|
310
311
|
}
|
|
311
312
|
function parseGroupComponent(obj, path, layout) {
|
|
312
313
|
if (typeof obj.label !== "string") {
|
|
313
|
-
throw new
|
|
314
|
+
throw new ParseError(`${path}: group must have a 'label' string`);
|
|
314
315
|
}
|
|
315
316
|
if (!Array.isArray(obj.components)) {
|
|
316
|
-
throw new
|
|
317
|
+
throw new ParseError(`${path}: group must have a 'components' array`);
|
|
317
318
|
}
|
|
318
319
|
const components = obj.components.map((c, i) => parseComponent(c, `${path}.components[${i}]`));
|
|
319
320
|
const c = {
|
|
@@ -330,9 +331,9 @@ function parseGroupComponent(obj, path, layout) {
|
|
|
330
331
|
}
|
|
331
332
|
function parseNumberComponent(obj, path, layout) {
|
|
332
333
|
if (typeof obj.label !== "string")
|
|
333
|
-
throw new
|
|
334
|
+
throw new ParseError(`${path}: number must have a 'label' string`);
|
|
334
335
|
if (typeof obj.key !== "string")
|
|
335
|
-
throw new
|
|
336
|
+
throw new ParseError(`${path}: number must have a 'key' string`);
|
|
336
337
|
const c = { type: "number", id: obj.id, label: obj.label, key: obj.key };
|
|
337
338
|
const validate = parseValidation(obj.validate, path);
|
|
338
339
|
if (validate)
|
|
@@ -357,7 +358,7 @@ function parseDatetimeComponent(obj, _path, layout) {
|
|
|
357
358
|
}
|
|
358
359
|
function parseButtonComponent(obj, path, layout) {
|
|
359
360
|
if (typeof obj.label !== "string")
|
|
360
|
-
throw new
|
|
361
|
+
throw new ParseError(`${path}: button must have a 'label' string`);
|
|
361
362
|
const c = { type: "button", id: obj.id, label: obj.label };
|
|
362
363
|
if (typeof obj.action === "string")
|
|
363
364
|
c.action = obj.action;
|
|
@@ -367,9 +368,9 @@ function parseButtonComponent(obj, path, layout) {
|
|
|
367
368
|
}
|
|
368
369
|
function parseTaglistComponent(obj, path, layout) {
|
|
369
370
|
if (typeof obj.label !== "string")
|
|
370
|
-
throw new
|
|
371
|
+
throw new ParseError(`${path}: taglist must have a 'label' string`);
|
|
371
372
|
if (typeof obj.key !== "string")
|
|
372
|
-
throw new
|
|
373
|
+
throw new ParseError(`${path}: taglist must have a 'key' string`);
|
|
373
374
|
const c = {
|
|
374
375
|
type: "taglist",
|
|
375
376
|
id: obj.id,
|
package/dist/index.d.ts
CHANGED
|
@@ -57,6 +57,8 @@ export type { BenchmarkResult, BoundingBox, ElementComparison, ElementPosition,
|
|
|
57
57
|
export type { Bounds, LayoutEdge, LayoutNode, LayoutResult, Waypoint } from "./layout/index.js";
|
|
58
58
|
export { ELEMENT_SIZES, GRID_CELL_HEIGHT, GRID_CELL_WIDTH } from "./layout/index.js";
|
|
59
59
|
export { compactify, expand } from "./bpmn/compact.js";
|
|
60
|
+
export { createCompactStream } from "./bpmn/compact-stream.js";
|
|
61
|
+
export type { CompactStream, CompactStreamOptions } from "./bpmn/compact-stream.js";
|
|
60
62
|
export { ELEMENT_GROUP_ORDER, ELEMENT_TYPE_GROUPS, allElementTypes, elementTypesInGroup, } from "./bpmn/element-catalog.js";
|
|
61
63
|
export type { ElementTypeGroup } from "./bpmn/element-catalog.js";
|
|
62
64
|
export { createFlowElement, retypeElement } from "./bpmn/element-shape.js";
|
package/dist/index.js
CHANGED
|
@@ -31,6 +31,7 @@ export { layoutProcess, layoutFlowNodes } from "./layout/index.js";
|
|
|
31
31
|
export { benchmarkLayout, compareLayouts, formatBenchmarkResult, generateAutoLayout, parseReferenceLayout, } from "./layout/index.js";
|
|
32
32
|
export { ELEMENT_SIZES, GRID_CELL_HEIGHT, GRID_CELL_WIDTH } from "./layout/index.js";
|
|
33
33
|
export { compactify, expand } from "./bpmn/compact.js";
|
|
34
|
+
export { createCompactStream } from "./bpmn/compact-stream.js";
|
|
34
35
|
export { ELEMENT_GROUP_ORDER, ELEMENT_TYPE_GROUPS, allElementTypes, elementTypesInGroup, } from "./bpmn/element-catalog.js";
|
|
35
36
|
export { createFlowElement, retypeElement } from "./bpmn/element-shape.js";
|
|
36
37
|
export { applyOperations } from "./bpmn/operations.js";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bpmnkit/core",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -20,8 +20,11 @@
|
|
|
20
20
|
"dist/**/*.js",
|
|
21
21
|
"dist/**/*.d.ts"
|
|
22
22
|
],
|
|
23
|
+
"engines": {
|
|
24
|
+
"node": ">=20"
|
|
25
|
+
},
|
|
23
26
|
"dependencies": {
|
|
24
|
-
"@bpmnkit/feel": "
|
|
27
|
+
"@bpmnkit/feel": "^1.0.0"
|
|
25
28
|
},
|
|
26
29
|
"description": "TypeScript-first BPMN 2.0 SDK — parse, build, layout, and optimize diagrams",
|
|
27
30
|
"keywords": [
|