- Added a new Archify skill, enabling users to create polished architecture, workflow, sequence, data-flow, and lifecycle diagrams. - Implemented comprehensive functionality including rendering, validation, and delivery of diagrams in various formats. - Integrated a user-friendly command-line interface for generating and previewing diagrams. - Developed supporting files including package.json, LICENSE, and SKILL.md for documentation and licensing. - Added unit tests to ensure reliability and functionality of the new skill. These changes enhance the application by providing a structured approach to visualizing system architecture and workflows, improving user experience and data representation.
4.7 KiB
Sequence Renderer
Render diagram_type: "sequence" JSON files into the standard Archify HTML
template.
node archify/renderers/sequence/render-sequence.mjs input.sequence.json output.html
The renderer validates input against archify/schemas/sequence.schema.json
with the bundled standalone validator. No dependency installation is required.
If output.html is omitted, the renderer uses meta.output from the JSON file
or falls back to sequence.html in the current working directory.
Input
Sequence JSON files must set:
{
"schema_version": 1,
"diagram_type": "sequence",
"meta": {
"title": "Cache Miss Request Sequence",
"viewBox": [920, 760]
},
"participants": [],
"segments": [],
"messages": [],
"activations": [],
"cards": []
}
The timeline scales with the viewBox height: a taller meta.viewBox buys more
message room, a shorter one shrinks the readable band instead of clipping. A
complete worked example lives at
archify/examples/cache-miss-request.sequence.json.
The schema lives at:
archify/schemas/sequence.schema.json
Legend
The default visual legend derives kinds from messages[].variant (omitting
variant means default). Supported meta.legend.entries keys, in stable
order, are emphasis, return, security, dashed, and default. These are
visual message keys, not Semantic Lens controls; label/visibility overrides do
not create edge facts.
Layout budget
| Constant | Value |
|---|---|
| viewBox | default [920, 760]; schema minimum [480, 480] |
| Participant boxes | fixed (default): 86×54 at y 72; spread: viewBox-relative width from 86px up to 190px |
| Participant columns | fixed: centers at x = 62 + index×108; spread: columns distribute across the available viewBox width |
| Participant count | the last box must end at or before width − 40; layouts that cannot fit fail closed |
| Lifelines | from y 142 down to height − 65; band must be ≥120px tall |
Message y range |
[160, height − 83] |
| Message spacing | ≥28px vertical between messages that share horizontal space |
| Arrow span | ≥60px horizontal between the two participants |
| Segments | y pixel ranges with to > from, inside [72, lifeline bottom + 20] |
| Legend row | y = height − 54 |
segments[].from/to and activations[].from/to are y pixel coordinates, not
participant ids; activations also require to > from.
Column fit
Sequence diagrams use meta.column_fit: "fixed" by default so existing
documents keep their historical coordinates. Use "spread" when a wide
viewBox would otherwise leave empty space on the right or when meaningful
participant labels do not fit the fixed 86px boxes. Spread derives box width
and column distance from the viewBox while preserving participant order,
lifelines, and message semantics.
Design Rules
- Put participants across the top, ordered by the story the reader should follow.
- Time moves downward.
- Use
emphasisfor the main request path. - Use
securityfor auth, consent, permission, and policy calls. - Use
returnfor quiet response messages. - Use
dashedfor async trace, event, logging, and non-blocking work. - Use segments as light background guides; keep segment labels short.
- Keep labels concise, but try
meta.column_fit: "spread"before shortening a meaningful participant label just to fit the fixed boxes.
Schema violations exit non-zero with path-prefixed messages annotated with the element's id or label. The renderer additionally fails when it can detect layout problems, including missing participants, duplicate participant IDs, participant labels wider than their box, unknown message endpoints, messages outside the readable timeline, overly tight vertical spacing between messages that overlap horizontally, invalid segment or activation ranges, or participants that exceed the viewBox. The shared Clean Flow contract treats participant headers as semantic boxes while explicitly allowing messages to cross intermediate lifelines, activation bars, and segment frames. Text width is estimated CJK-aware: fullwidth glyphs count as two units.
Set meta.quality_profile to showcase for polished delivery. Unrelated proper
message X crossings then fail with composition/proper-crossing; default
standard keeps them as artifact-receipt warnings. Messages may still cross
intermediate lifelines. Collinear corridors remain outside the proper-X rule,
but a separate gate warns in standard and fails in showcase when unrelated
messages overlap for at least 8px. Shared semantic endpoints, point touches,
and shorter overlaps remain valid. Showcase also rejects any route segment
below 8px and any interior turn segment below 16px; ordinary 8–15px endpoint
stubs remain valid.