archik 0.12.6 → 0.12.7
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.
|
@@ -333,7 +333,7 @@ A node in the architecture YAML declares which flows it participates in via the
|
|
|
333
333
|
- .archik/checkout-flow.archik.seq.yaml
|
|
334
334
|
```
|
|
335
335
|
|
|
336
|
-
`seqFiles` is
|
|
336
|
+
`seqFiles` is a **non-empty array of relative paths** (at least one entry required) from the project root. The validator checks each path exists on disk. Nodes without `seqFiles` are unaffected.
|
|
337
337
|
|
|
338
338
|
**UI effect:** nodes with `seqFiles` get clickable diagram links in the node inspector. The toolbar shows a "glow" button that highlights all nodes with seq diagrams so they're easy to spot on large canvases.
|
|
339
339
|
|
|
@@ -355,6 +355,8 @@ description: "..." # optional
|
|
|
355
355
|
participants: # required, at least one
|
|
356
356
|
- id: browser # participant ref id (used in steps)
|
|
357
357
|
nodeId: frontend # architecture node id this participant maps to
|
|
358
|
+
# the node's kind (gateway, service, database…) is
|
|
359
|
+
# automatically applied to the participant header icon/color
|
|
358
360
|
label: Browser # optional display label (defaults to nodeId)
|
|
359
361
|
|
|
360
362
|
steps: # ordered list of messages, notes, groups
|
|
@@ -399,6 +401,17 @@ steps: # ordered list of messages, notes, groups
|
|
|
399
401
|
label: "401 Unauthorized"
|
|
400
402
|
arrow: return
|
|
401
403
|
status: proposed # optional
|
|
404
|
+
|
|
405
|
+
# --- ref group (drill-down to another seq file) ---
|
|
406
|
+
- type: group
|
|
407
|
+
id: g2
|
|
408
|
+
kind: ref
|
|
409
|
+
label: "checkout flow" # display label inside the frame
|
|
410
|
+
seqFile: .archik/checkout-flow.archik.seq.yaml
|
|
411
|
+
# relative path to the linked seq file
|
|
412
|
+
# makes the frame clickable in the UI →
|
|
413
|
+
# navigates to that diagram
|
|
414
|
+
branches: [] # branches must be present (can be empty for ref)
|
|
402
415
|
```
|
|
403
416
|
|
|
404
417
|
**Arrow types:**
|
|
@@ -453,9 +466,10 @@ npx archik validate .archik/main.archik.yaml
|
|
|
453
466
|
|
|
454
467
|
```bash
|
|
455
468
|
npx archik render --seq .archik/login-flow.archik.seq.yaml --out login-flow.svg
|
|
469
|
+
# optionally: --theme dark|light (default: dark)
|
|
456
470
|
```
|
|
457
471
|
|
|
458
|
-
Renders a headless SVG of the sequence diagram. Useful for CI or docs.
|
|
472
|
+
Renders a headless SVG of the sequence diagram. Useful for CI or docs. Participant icons/colors are automatically resolved from the architecture node kinds when a root arch doc is present in the same project root.
|
|
459
473
|
|
|
460
474
|
## Verification workflow
|
|
461
475
|
|
|
@@ -472,13 +486,16 @@ The CLI ships as the `archik` npm package; default to `npx archik` (works in fre
|
|
|
472
486
|
```
|
|
473
487
|
npx archik schema # the document shape (always start here when authoring)
|
|
474
488
|
--json # structured shape for piping into jq
|
|
489
|
+
--seq # seq diagram schema instead of arch schema
|
|
475
490
|
|
|
476
491
|
npx archik q describe <id> | deps <id> | dependents <id>
|
|
477
492
|
list | edges | impact <id> | stats
|
|
493
|
+
sequences [--node <id>] # list seq diagrams; --node filters to flows involving a node
|
|
478
494
|
--json # stable machine-readable shape
|
|
479
495
|
|
|
480
496
|
npx archik validate <path> [--json] # schema + cross-file check (CI-friendly)
|
|
481
497
|
npx archik render --out diagram.svg --theme light|dark
|
|
498
|
+
render --seq <path> --out seq.svg --theme light|dark # render a seq diagram to SVG
|
|
482
499
|
npx archik diff a.yaml b.yaml [--out diff.svg] [--json]
|
|
483
500
|
|
|
484
501
|
npx archik suggest show [--json]
|