@grethel-labs/excaliplant 0.6.0 → 0.8.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 (185) hide show
  1. package/CHANGELOG.md +52 -5
  2. package/README.md +391 -39
  3. package/assets/arrowheads/arrowheads.svg +46 -0
  4. package/assets/arrowheads/manifest.json +17 -0
  5. package/bin/excaliplant.mjs +2 -2
  6. package/index.mjs +136 -28
  7. package/package.json +31 -15
  8. package/src/diagrams/base/artifacts.mjs +35 -0
  9. package/src/diagrams/base/assets.mjs +23 -0
  10. package/src/diagrams/base/dependencies.mjs +25 -0
  11. package/src/diagrams/base/docs.mjs +37 -0
  12. package/src/diagrams/base/index.mjs +15 -0
  13. package/src/diagrams/base/layout.mjs +32 -0
  14. package/src/diagrams/base/module.mjs +210 -0
  15. package/src/diagrams/base/parser.mjs +50 -0
  16. package/src/diagrams/base/renderer.mjs +26 -0
  17. package/src/diagrams/base/security.mjs +23 -0
  18. package/src/diagrams/base/tests.mjs +37 -0
  19. package/src/diagrams/class/assets.mjs +22 -0
  20. package/src/diagrams/class/docs/coverage_examples.mjs +93 -0
  21. package/src/diagrams/class/docs.mjs +37 -0
  22. package/src/diagrams/class/layout.mjs +20 -0
  23. package/src/diagrams/class/module.mjs +101 -0
  24. package/src/diagrams/class/parser.mjs +53 -0
  25. package/src/diagrams/class/render.mjs +20 -0
  26. package/src/diagrams/class/security.mjs +19 -0
  27. package/src/diagrams/class/style.mjs +15 -0
  28. package/src/diagrams/class/tests/class_components.test.mjs +103 -0
  29. package/src/diagrams/class/tests/output/.gitignore +2 -0
  30. package/src/diagrams/class/tests/output.mjs +17 -0
  31. package/src/diagrams/class/tests.mjs +20 -0
  32. package/src/diagrams/component/assets.mjs +22 -0
  33. package/src/diagrams/component/docs/coverage_examples.mjs +98 -0
  34. package/src/diagrams/component/docs.mjs +37 -0
  35. package/src/diagrams/component/layout.mjs +20 -0
  36. package/src/diagrams/component/module.mjs +105 -0
  37. package/src/diagrams/component/parser.mjs +63 -0
  38. package/src/diagrams/component/render.mjs +20 -0
  39. package/src/diagrams/component/security.mjs +19 -0
  40. package/src/diagrams/component/tests/component_components.test.mjs +108 -0
  41. package/src/diagrams/component/tests/output/.gitignore +2 -0
  42. package/src/diagrams/component/tests/output.mjs +17 -0
  43. package/src/diagrams/component/tests.mjs +23 -0
  44. package/src/diagrams/deployment/assets.mjs +22 -0
  45. package/src/diagrams/deployment/docs/coverage_examples.mjs +80 -0
  46. package/src/diagrams/deployment/docs.mjs +31 -0
  47. package/src/diagrams/deployment/layout.mjs +20 -0
  48. package/src/diagrams/deployment/module.mjs +104 -0
  49. package/src/diagrams/deployment/parser.mjs +56 -0
  50. package/src/diagrams/deployment/render.mjs +20 -0
  51. package/src/diagrams/deployment/security.mjs +19 -0
  52. package/src/diagrams/deployment/tests/deployment_components.test.mjs +83 -0
  53. package/src/diagrams/deployment/tests/output/all-shapes.excalidraw.json +965 -0
  54. package/src/diagrams/deployment/tests/output/all-shapes.puml +11 -0
  55. package/src/diagrams/deployment/tests/output/all-shapes.svg +34 -0
  56. package/src/diagrams/deployment/tests/output/arrow-styles.excalidraw.json +450 -0
  57. package/src/diagrams/deployment/tests/output/arrow-styles.puml +8 -0
  58. package/src/diagrams/deployment/tests/output/arrow-styles.svg +18 -0
  59. package/src/diagrams/deployment/tests/output/basic-node.excalidraw.json +107 -0
  60. package/src/diagrams/deployment/tests/output/basic-node.puml +3 -0
  61. package/src/diagrams/deployment/tests/output/basic-node.svg +8 -0
  62. package/src/diagrams/deployment/tests/output/json-mixing.excalidraw.json +208 -0
  63. package/src/diagrams/deployment/tests/output/json-mixing.puml +6 -0
  64. package/src/diagrams/deployment/tests/output/json-mixing.svg +11 -0
  65. package/src/diagrams/deployment/tests/output/nested-containers.excalidraw.json +302 -0
  66. package/src/diagrams/deployment/tests/output/nested-containers.puml +9 -0
  67. package/src/diagrams/deployment/tests/output/nested-containers.svg +14 -0
  68. package/src/diagrams/deployment/tests/output/ports.excalidraw.json +172 -0
  69. package/src/diagrams/deployment/tests/output/ports.puml +5 -0
  70. package/src/diagrams/deployment/tests/output/ports.svg +10 -0
  71. package/src/diagrams/deployment/tests/output.mjs +22 -0
  72. package/src/diagrams/deployment/tests.mjs +20 -0
  73. package/src/diagrams/index.mjs +106 -0
  74. package/src/diagrams/sequence/assets.mjs +22 -0
  75. package/src/{parser/sequence_context.mjs → diagrams/sequence/context.mjs} +216 -25
  76. package/src/diagrams/sequence/docs/coverage_examples.mjs +552 -0
  77. package/src/diagrams/sequence/docs.mjs +20 -0
  78. package/src/diagrams/sequence/layout.mjs +26 -0
  79. package/src/diagrams/sequence/layout_engine.mjs +1033 -0
  80. package/src/diagrams/sequence/module.mjs +97 -0
  81. package/src/diagrams/sequence/parser.mjs +93 -0
  82. package/src/{parser/plugins/sequence → diagrams/sequence/plugins}/advanced.mjs +121 -4
  83. package/src/diagrams/sequence/plugins/fragments.mjs +67 -0
  84. package/src/diagrams/sequence/plugins/messages.mjs +427 -0
  85. package/src/diagrams/sequence/plugins/notes.mjs +192 -0
  86. package/src/diagrams/sequence/plugins/participants.mjs +70 -0
  87. package/src/diagrams/sequence/plugins/preamble.mjs +111 -0
  88. package/src/diagrams/sequence/render.mjs +29 -0
  89. package/src/diagrams/sequence/render_excalidraw.mjs +1381 -0
  90. package/src/diagrams/sequence/security.mjs +19 -0
  91. package/src/diagrams/sequence/spacing.mjs +106 -0
  92. package/src/diagrams/sequence/tests/output/arrow-variants.excalidraw.json +2443 -0
  93. package/src/diagrams/sequence/tests/output/arrow-variants.puml +22 -0
  94. package/src/diagrams/sequence/tests/output/arrow-variants.svg +61 -0
  95. package/src/diagrams/sequence/tests/output/autonumber-title-footbox-skinparam.excalidraw.json +1087 -0
  96. package/src/diagrams/sequence/tests/output/autonumber-title-footbox-skinparam.puml +35 -0
  97. package/src/diagrams/sequence/tests/output/autonumber-title-footbox-skinparam.svg +30 -0
  98. package/src/diagrams/sequence/tests/output/basics.excalidraw.json +765 -0
  99. package/src/diagrams/sequence/tests/output/basics.puml +8 -0
  100. package/src/diagrams/sequence/tests/output/basics.svg +22 -0
  101. package/src/diagrams/sequence/tests/output/combination-errors.excalidraw.json +2612 -0
  102. package/src/diagrams/sequence/tests/output/combination-errors.puml +23 -0
  103. package/src/diagrams/sequence/tests/output/combination-errors.svg +64 -0
  104. package/src/diagrams/sequence/tests/output/combination-flow.excalidraw.json +2769 -0
  105. package/src/diagrams/sequence/tests/output/combination-flow.puml +25 -0
  106. package/src/diagrams/sequence/tests/output/combination-flow.svg +69 -0
  107. package/src/diagrams/sequence/tests/output/feedback-loops-assets.excalidraw.json +3487 -0
  108. package/src/diagrams/sequence/tests/output/feedback-loops-assets.puml +21 -0
  109. package/src/diagrams/sequence/tests/output/feedback-loops-assets.svg +86 -0
  110. package/src/diagrams/sequence/tests/output/fragments.excalidraw.json +3347 -0
  111. package/src/diagrams/sequence/tests/output/fragments.puml +36 -0
  112. package/src/diagrams/sequence/tests/output/fragments.svg +82 -0
  113. package/src/diagrams/sequence/tests/output/global-presentation.excalidraw.json +938 -0
  114. package/src/diagrams/sequence/tests/output/global-presentation.puml +23 -0
  115. package/src/diagrams/sequence/tests/output/global-presentation.svg +27 -0
  116. package/src/diagrams/sequence/tests/output/label-wrapping.excalidraw.json +985 -0
  117. package/src/diagrams/sequence/tests/output/label-wrapping.puml +9 -0
  118. package/src/diagrams/sequence/tests/output/label-wrapping.svg +27 -0
  119. package/src/diagrams/sequence/tests/output/lifecycle.excalidraw.json +1771 -0
  120. package/src/diagrams/sequence/tests/output/lifecycle.puml +14 -0
  121. package/src/diagrams/sequence/tests/output/lifecycle.svg +43 -0
  122. package/src/diagrams/sequence/tests/output/notes.excalidraw.json +1213 -0
  123. package/src/diagrams/sequence/tests/output/notes.puml +16 -0
  124. package/src/diagrams/sequence/tests/output/notes.svg +35 -0
  125. package/src/diagrams/sequence/tests/output/participant-boxes.excalidraw.json +1342 -0
  126. package/src/diagrams/sequence/tests/output/participant-boxes.puml +14 -0
  127. package/src/diagrams/sequence/tests/output/participant-boxes.svg +35 -0
  128. package/src/diagrams/sequence/tests/output/participants.excalidraw.json +4146 -0
  129. package/src/diagrams/sequence/tests/output/participants.puml +26 -0
  130. package/src/diagrams/sequence/tests/output/participants.svg +102 -0
  131. package/src/diagrams/sequence/tests/output/timeline-decorations.excalidraw.json +1480 -0
  132. package/src/diagrams/sequence/tests/output/timeline-decorations.puml +18 -0
  133. package/src/diagrams/sequence/tests/output/timeline-decorations.svg +40 -0
  134. package/src/diagrams/sequence/tests/output.mjs +17 -0
  135. package/src/diagrams/sequence/tests/sequence_components.test.mjs +819 -0
  136. package/src/diagrams/sequence/tests.mjs +20 -0
  137. package/src/diagrams/shared/common_plugins/title.mjs +21 -0
  138. package/src/{parser/component_context.mjs → diagrams/shared/graph_context.mjs} +145 -21
  139. package/src/diagrams/shared/graph_parser.mjs +55 -0
  140. package/src/diagrams/shared/graph_plugins/association_class.mjs +47 -0
  141. package/src/{parser/plugins/component → diagrams/shared/graph_plugins}/class_block.mjs +27 -15
  142. package/src/{parser/plugins/component → diagrams/shared/graph_plugins}/connections.mjs +15 -8
  143. package/src/{parser/plugins/component → diagrams/shared/graph_plugins}/containers.mjs +21 -4
  144. package/src/diagrams/shared/graph_plugins/filters.mjs +25 -0
  145. package/src/diagrams/shared/graph_plugins/notes.mjs +104 -0
  146. package/src/diagrams/shared/graph_plugins/ports.mjs +44 -0
  147. package/src/diagrams/shared/graph_plugins/preamble.mjs +99 -0
  148. package/src/{parser/plugins/component → diagrams/shared/graph_plugins}/shapes.mjs +33 -5
  149. package/src/diagrams/shared/graph_runtime.mjs +28 -0
  150. package/src/{layout → general/layout}/elk_layout.mjs +7 -5
  151. package/src/{layout → general/layout}/sizing.mjs +1 -1
  152. package/src/{model → general/model}/diagram.mjs +403 -11
  153. package/src/general/platform/asset_base.mjs +58 -0
  154. package/src/general/platform/diagnostics.mjs +76 -0
  155. package/src/general/platform/security_base.mjs +441 -0
  156. package/src/general/platform/services.mjs +192 -0
  157. package/src/{render → general/render}/excalidraw.mjs +124 -16
  158. package/src/{render → general/render}/svg.mjs +77 -14
  159. package/src/{style → general/style}/font.mjs +10 -1
  160. package/src/{style → general/style}/style.mjs +2 -10
  161. package/src/{style → general/style}/text.mjs +104 -1
  162. package/src/main/builtin.mjs +60 -0
  163. package/src/main/dependencies.mjs +96 -0
  164. package/src/main/introspection.mjs +52 -0
  165. package/src/main/metadata.mjs +47 -0
  166. package/src/main/parser.mjs +244 -0
  167. package/src/main/pipeline.mjs +85 -0
  168. package/src/main/registry.mjs +148 -0
  169. package/src/{parser/engine.mjs → util/parser_engine.mjs} +1 -1
  170. package/src/{parser/utils.mjs → util/plantuml_utils.mjs} +72 -2
  171. package/src/layout/sequence_layout.mjs +0 -538
  172. package/src/parser/plantuml.mjs +0 -278
  173. package/src/parser/plugins/component/notes.mjs +0 -81
  174. package/src/parser/plugins/component/preamble.mjs +0 -54
  175. package/src/parser/plugins/sequence/fragments.mjs +0 -40
  176. package/src/parser/plugins/sequence/messages.mjs +0 -57
  177. package/src/parser/plugins/sequence/notes.mjs +0 -112
  178. package/src/parser/plugins/sequence/participants.mjs +0 -23
  179. package/src/parser/plugins/sequence/preamble.mjs +0 -62
  180. package/src/render/sequence_render.mjs +0 -794
  181. /package/src/{render → general/render}/canvas_svg.mjs +0 -0
  182. /package/src/{render → general/render}/png.mjs +0 -0
  183. /package/src/{render → general/render}/rng.mjs +0 -0
  184. /package/src/{render → general/render}/schema.mjs +0 -0
  185. /package/src/{style → general/style}/colors.mjs +0 -0
package/CHANGELOG.md CHANGED
@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8
8
 
9
9
  ### Added
10
10
 
11
- - New `src/style/style.mjs` module with a single source of truth for
11
+ - New `src/general/style/style.mjs` module with a single source of truth for
12
12
  renderer styling. `getStyle()` / `setStyle()` / `resetStyle()` /
13
13
  `loadStyleFromFile()` are exported from the package root, the CLI
14
14
  exposes `excaliplant --style <file>`, and the `./style` subpath is
@@ -20,7 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
20
20
  - Auto-shrink for box titles and descriptions: long unbreakable
21
21
  identifiers now reduce their font size (down to `text.minFontSize`)
22
22
  rather than overflowing. Disable via `text.autoShrink: false`. New
23
- helper `measureFitted` is exported from `src/style/text.mjs`.
23
+ helper `measureFitted` is exported from `src/general/style/text.mjs`.
24
24
  - Edge-label chips now carry `customData.role` markers
25
25
  (`edgeLabelChip` / `edgeLabelText`) so renderers, tests, and
26
26
  third-party tools can identify them reliably.
@@ -45,6 +45,46 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
45
45
  [`docs/API.template.md.njk`](docs/API.template.md.njk) on every
46
46
  `npm run build:docs` run, so it can never drift from the README.
47
47
  The TypeDoc devDependency was removed.
48
+ - Reusable arrow model classes (`DiagramArrow`, `ArrowEndpoint`,
49
+ `ArrowLine`, `ArrowLabel`) are now exported from the package root
50
+ and used by both sequence messages and component/class connections.
51
+ - Sequence diagrams now support endpoint labels, long label wrapping
52
+ against arrowhead-safe budgets, `hide unlinked`, `header`,
53
+ `footer`, `mainframe`, single-canvas `newpage`, solid lifelines,
54
+ and simplified `&` parallel-message parsing.
55
+ - Sequence diagrams now support multiline participant block titles,
56
+ message alignment / response-below-arrow skinparams, actor style
57
+ modes, group secondary labels and colours, safe formatted
58
+ autonumber output, Teoz pragmas / partition wrappers, and expanded
59
+ sequence skinparams for messages, notes, groups, dividers, and
60
+ activation bars.
61
+ - SVG marker assets for all produced arrowhead forms are stored under
62
+ [`assets/arrowheads/`](assets/arrowheads/), and the docs build now
63
+ emits a self-updating model class diagram in the README architecture
64
+ section.
65
+ - Modular diagram architecture foundation: built-in sequence, class,
66
+ and component diagrams now run as separate diagram-type modules from
67
+ per-diagram module folders. The closed-world `DiagramModuleRegistry`
68
+ is separated from platform services, parsed models receive weak
69
+ module metadata, module-owned layout/render adapters are dispatched, and the
70
+ package exports module base classes, registry helpers, platform
71
+ introspection, `security-base`, `asset-base`, diagnostics, failure
72
+ boundaries, capability checks, and final Excalidraw artifact
73
+ validation.
74
+ - Diagram modules now use concrete main classes (`SequenceDiagramModule`,
75
+ `ClassDiagramModule`, `ComponentDiagramModule`) composed from base
76
+ parser, layout, renderer, documentation, test, security, and asset
77
+ facets. The shared base contracts live in the `src/diagrams/base/`
78
+ module folder.
79
+ - Source structure now foregrounds diagram modules under `src/diagrams/`,
80
+ main orchestration under `src/main/`, shared runtime under
81
+ `src/general/`, and low-level parser helpers under `src/util/`. Legacy
82
+ top-level implementation folders (`src/parser`, `src/layout`,
83
+ `src/render`, `src/model`, `src/modules`, `src/platform`, `src/style`)
84
+ were removed; package subpath exports now point directly at the new
85
+ primary files.
86
+ - Shared parser helpers now cover reusable title-line parsing and block-line
87
+ accumulation for note-style block plugins.
48
88
 
49
89
  ### Changed
50
90
 
@@ -68,10 +108,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
68
108
  field, so connection arrows / lines and edge-label chips appear
69
109
  perfectly straight in the exported SVG / PNG (matching the existing
70
110
  `roughness: 0` Excalidraw JSON output).
71
- - `FONT` from `src/style/text.mjs` is now a live view of the active
111
+ - `FONT` from `src/general/style/text.mjs` is now a live view of the active
72
112
  style document. Existing reads (`FONT.sizeTitle`, `FONT.family`,
73
113
  …) keep working; calls to `setStyle()` / `loadStyleFromFile()`
74
114
  immediately propagate to sizing and rendering.
115
+ - Sequence-diagram timeline spacing is centralized in one spacing
116
+ contract so messages, notes, refs, markers, fragments, and wrapped
117
+ endpoint labels reserve symmetric top/bottom gaps consistently.
75
118
 
76
119
  ### Fixed
77
120
 
@@ -105,9 +148,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
105
148
  - Long class / interface / enum member signatures now wrap at
106
149
  semantically meaningful break points (after `,` `(` `:`,
107
150
  before `|` `&` `)`) via the new `wrapMemberSignature` helper
108
- in `src/style/text.mjs`, with continuation indent. Sizing
151
+ in `src/general/style/text.mjs`, with continuation indent. Sizing
109
152
  grows the box height accordingly so members no longer bleed
110
153
  past the right edge.
154
+ - SVG start markers are now anchored at the visual tip, so backward
155
+ and start-side arrowheads point at their endpoint instead of starting
156
+ there. Additional rendered heads include circles, dots, bars, and
157
+ partial top/bottom heads.
111
158
 
112
159
  ## [0.3.7] - 2026-05-04
113
160
 
@@ -187,7 +234,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
187
234
  attribute. Previously a string like `'" onload="alert(1)'` could
188
235
  break out of the attribute and inject arbitrary markup into the
189
236
  emitted SVG. The escape uses the same routine as the rest of
190
- `src/render/svg.mjs` (`escapeAttr`, now exported) and now also
237
+ `src/general/render/svg.mjs` (`escapeAttr`, now exported) and now also
191
238
  escapes `>` for defence in depth.
192
239
  - `parsePlantUml` gains opt-in resource limits
193
240
  (`maxInputBytes`, `maxLines`, `maxNodes`, `maxEdges`) with sensible
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  [![node](https://img.shields.io/node/v/@grethel-labs/excaliplant.svg)](https://nodejs.org)
8
8
  [![license](https://img.shields.io/npm/l/@grethel-labs/excaliplant.svg)](./LICENSE)
9
9
 
10
- > PlantUML → ELK layout → Excalidraw renderer with a plugin-based parser. &nbsp;·&nbsp; **v0.6.0** &nbsp;·&nbsp; 136 tests &nbsp;·&nbsp; MIT
10
+ > PlantUML → ELK layout → Excalidraw renderer with a plugin-based parser. &nbsp;·&nbsp; **v0.8.0** &nbsp;·&nbsp; 194 tests &nbsp;·&nbsp; MIT
11
11
 
12
12
  `@grethel-labs/excaliplant` takes PlantUML source, runs it through a plugin-based
13
13
  parser, lays it out with [ELK](https://github.com/kieler/elkjs), and
@@ -123,13 +123,15 @@ directly to output colours in block or compact form: `ArrowColor`,
123
123
  `ParticipantBackgroundColor`, `ParticipantBorderColor`, and
124
124
  `LifeLineBorderColor`.
125
125
 
126
+ See the full [Sequence Diagram Component Coverage](./docs/sequence-components.md) for detailed examples and support matrix.
127
+
126
128
  ### Run the tests
127
129
 
128
130
  ```sh
129
131
  npm test
130
132
  ```
131
133
 
132
- Ships with **136 tests** across functional, edge-case,
134
+ Ships with **194 tests** across functional, edge-case,
133
135
  security (XSS / ReDoS / prototype-pollution), and self-introspection
134
136
  suites.
135
137
 
@@ -149,9 +151,9 @@ JSDoc tags.
149
151
  _Sources: [PlantUML](docs/ressources/generated/puml/modules.puml) · [SVG](docs/ressources/generated/svg/modules.svg)_
150
152
 
151
153
  The module graph reflects how the source is laid out under
152
- [`src/`](./src/). Note in particular how the parser is split into a
153
- single tiny `engine` plus a stack of plugins under `parser/plugins/`,
154
- each plugin handling one PlantUML construct.
154
+ [`src/`](./src/). Diagram-type behavior is collected in first-class
155
+ module folders under `src/diagrams/`, orchestration lives under
156
+ `src/main/`, and host capabilities live under `src/general/platform/`.
155
157
 
156
158
  ### renderPlantUml flow
157
159
 
@@ -169,7 +171,7 @@ The call graph for `renderPlantUml(text)` walks three subsystems:
169
171
  deterministic tabular layout.
170
172
  3. **renderer** walks the laid-out model and emits Excalidraw JSON.
171
173
  The same model can also be exported to SVG via
172
- [`src/render/svg.mjs`](./src/render/svg.mjs) — used by the
174
+ [`src/general/render/svg.mjs`](./src/general/render/svg.mjs) — used by the
173
175
  documentation pipeline.
174
176
 
175
177
  ### Parser plugins
@@ -182,9 +184,21 @@ Each parser plugin is a tiny self-contained file that handles ONE
182
184
  PlantUML construct. The engine offers each input line to plugins
183
185
  in registration order; the first plugin that returns `true` wins.
184
186
 
185
- To add support for a new PlantUML keyword, drop a new file in
186
- `src/parser/plugins/` and append it to the default array in
187
- [`plantuml.mjs`](./src/parser/plantuml.mjs). No engine change required.
187
+ To add support for a new PlantUML keyword, drop a new file in the
188
+ owning diagram module folder and append it to that module's parser
189
+ contract. No engine change required.
190
+
191
+ ### Model classes
192
+
193
+ ![Model classes](docs/ressources/generated/svg/model.svg)
194
+
195
+ _Sources: [PlantUML](docs/ressources/generated/puml/model.puml) · [SVG](docs/ressources/generated/svg/model.svg)_
196
+
197
+ The model diagram is generated dynamically from exported classes in
198
+ [`src/general/model/diagram.mjs`](./src/general/model/diagram.mjs). It shows how the
199
+ reusable arrow classes sit underneath both component connections and
200
+ sequence messages, so future model classes appear in the README without
201
+ hand-maintained PlantUML.
188
202
 
189
203
  ## Pipeline
190
204
 
@@ -209,6 +223,9 @@ PlantUML text
209
223
  ```text
210
224
  excaliplant
211
225
  ├── assets
226
+ │ ├── arrowheads
227
+ │ │ ├── arrowheads.svg
228
+ │ │ └── manifest.json
212
229
  │ └── fonts
213
230
  │ ├── Excalifont-Regular.ttf
214
231
  │ ├── Excalifont-Regular.woff2
@@ -217,8 +234,12 @@ excaliplant
217
234
  │ └── excaliplant.mjs
218
235
  ├── docs
219
236
  │ ├── ressources
237
+ │ │ └── sequence
238
+ │ │ ├── puml
239
+ │ │ └── svg
220
240
  │ ├── scripts
221
241
  │ │ ├── build-docs.mjs
242
+ │ │ ├── build-sequence-coverage.mjs
222
243
  │ │ ├── check-build-manifest.mjs
223
244
  │ │ ├── config.mjs
224
245
  │ │ ├── extract-api.mjs
@@ -227,7 +248,10 @@ excaliplant
227
248
  │ │ └── self-diagrams.mjs
228
249
  │ ├── API.md
229
250
  │ ├── API.template.md.njk
230
- │ └── README.template.md.njk
251
+ │ ├── README.template.md.njk
252
+ │ ├── sequence-components.md
253
+ │ ├── sequence-components.template.md.njk
254
+ │ └── src-structure-refactor-plan.md
231
255
  ├── scripts
232
256
  │ ├── auto-patch-deps.mjs
233
257
  │ ├── bump-release-version.mjs
@@ -237,43 +261,124 @@ excaliplant
237
261
  │ ├── setup-merge-drivers.mjs
238
262
  │ └── smoke.mjs
239
263
  ├── src
240
- │ ├── layout
241
- │ │ ├── elk_layout.mjs
242
- │ │ ├── sequence_layout.mjs
243
- │ │ └── sizing.mjs
244
- │ ├── model
245
- │ │ └── diagram.mjs
246
- │ ├── parser
247
- │ │ ├── plugins
248
- │ │ │ ├── component
249
- │ │ │ └── sequence
250
- │ │ ├── component_context.mjs
251
- │ │ ├── engine.mjs
252
- │ │ ├── plantuml.mjs
253
- │ │ ├── sequence_context.mjs
254
- │ │ └── utils.mjs
255
- │ ├── render
256
- │ │ ├── canvas_svg.mjs
257
- │ │ ├── excalidraw.mjs
258
- │ │ ├── png.mjs
259
- │ │ ├── rng.mjs
260
- │ │ ├── schema.mjs
261
- │ │ ├── sequence_render.mjs
262
- │ │ └── svg.mjs
263
- │ └── style
264
- │ ├── colors.mjs
265
- │ ├── font.mjs
266
- │ ├── style.mjs
267
- │ └── text.mjs
264
+ │ ├── diagrams
265
+ │ │ ├── base
266
+ │ │ │ ├── artifacts.mjs
267
+ │ │ │ ├── assets.mjs
268
+ │ │ │ ├── dependencies.mjs
269
+ │ │ │ ├── docs.mjs
270
+ │ │ │ ├── index.mjs
271
+ │ │ │ ├── layout.mjs
272
+ │ │ │ ├── module.mjs
273
+ │ │ │ ├── parser.mjs
274
+ │ │ │ ├── renderer.mjs
275
+ │ │ │ ├── security.mjs
276
+ │ │ │ └── tests.mjs
277
+ │ │ ├── class
278
+ │ │ │ ├── docs
279
+ │ │ │ ├── tests
280
+ │ │ │ ├── assets.mjs
281
+ │ │ │ ├── docs.mjs
282
+ │ │ │ ├── layout.mjs
283
+ │ │ │ ├── module.mjs
284
+ │ │ │ ├── parser.mjs
285
+ │ │ │ ├── render.mjs
286
+ │ │ │ ├── security.mjs
287
+ │ │ │ ├── style.mjs
288
+ │ │ │ └── tests.mjs
289
+ │ │ ├── component
290
+ │ │ │ ├── docs
291
+ │ │ │ ├── tests
292
+ │ │ │ ├── assets.mjs
293
+ │ │ │ ├── docs.mjs
294
+ │ │ │ ├── layout.mjs
295
+ │ │ │ ├── module.mjs
296
+ │ │ │ ├── parser.mjs
297
+ │ │ │ ├── render.mjs
298
+ │ │ │ ├── security.mjs
299
+ │ │ │ └── tests.mjs
300
+ │ │ ├── deployment
301
+ │ │ │ ├── docs
302
+ │ │ │ ├── tests
303
+ │ │ │ ├── assets.mjs
304
+ │ │ │ ├── docs.mjs
305
+ │ │ │ ├── layout.mjs
306
+ │ │ │ ├── module.mjs
307
+ │ │ │ ├── parser.mjs
308
+ │ │ │ ├── render.mjs
309
+ │ │ │ ├── security.mjs
310
+ │ │ │ └── tests.mjs
311
+ │ │ ├── sequence
312
+ │ │ │ ├── docs
313
+ │ │ │ ├── plugins
314
+ │ │ │ ├── tests
315
+ │ │ │ ├── assets.mjs
316
+ │ │ │ ├── context.mjs
317
+ │ │ │ ├── docs.mjs
318
+ │ │ │ ├── layout.mjs
319
+ │ │ │ ├── layout_engine.mjs
320
+ │ │ │ ├── module.mjs
321
+ │ │ │ ├── parser.mjs
322
+ │ │ │ ├── render.mjs
323
+ │ │ │ ├── render_excalidraw.mjs
324
+ │ │ │ ├── security.mjs
325
+ │ │ │ ├── spacing.mjs
326
+ │ │ │ └── tests.mjs
327
+ │ │ ├── shared
328
+ │ │ │ ├── common_plugins
329
+ │ │ │ ├── graph_plugins
330
+ │ │ │ ├── graph_context.mjs
331
+ │ │ │ ├── graph_parser.mjs
332
+ │ │ │ └── graph_runtime.mjs
333
+ │ │ └── index.mjs
334
+ │ ├── general
335
+ │ │ ├── layout
336
+ │ │ │ ├── elk_layout.mjs
337
+ │ │ │ └── sizing.mjs
338
+ │ │ ├── model
339
+ │ │ │ └── diagram.mjs
340
+ │ │ ├── platform
341
+ │ │ │ ├── asset_base.mjs
342
+ │ │ │ ├── diagnostics.mjs
343
+ │ │ │ ├── security_base.mjs
344
+ │ │ │ └── services.mjs
345
+ │ │ ├── render
346
+ │ │ │ ├── canvas_svg.mjs
347
+ │ │ │ ├── excalidraw.mjs
348
+ │ │ │ ├── png.mjs
349
+ │ │ │ ├── rng.mjs
350
+ │ │ │ ├── schema.mjs
351
+ │ │ │ └── svg.mjs
352
+ │ │ └── style
353
+ │ │ ├── colors.mjs
354
+ │ │ ├── font.mjs
355
+ │ │ ├── style.mjs
356
+ │ │ └── text.mjs
357
+ │ ├── main
358
+ │ │ ├── builtin.mjs
359
+ │ │ ├── dependencies.mjs
360
+ │ │ ├── introspection.mjs
361
+ │ │ ├── metadata.mjs
362
+ │ │ ├── parser.mjs
363
+ │ │ ├── pipeline.mjs
364
+ │ │ └── registry.mjs
365
+ │ └── util
366
+ │ ├── parser_engine.mjs
367
+ │ └── plantuml_utils.mjs
268
368
  ├── tests
269
369
  │ ├── helpers
270
370
  │ │ └── output.mjs
371
+ │ ├── class_components.test.mjs
372
+ │ ├── component_components.test.mjs
373
+ │ ├── deployment_components.test.mjs
271
374
  │ ├── edge_cases.test.mjs
272
375
  │ ├── functional_more.test.mjs
273
376
  │ ├── merge_driver.test.mjs
377
+ │ ├── modular_architecture.test.mjs
274
378
  │ ├── plantuml.test.mjs
275
379
  │ ├── security.test.mjs
276
380
  │ ├── self_introspection.test.mjs
381
+ │ ├── sequence_components.test.mjs
277
382
  │ └── style.test.mjs
278
383
  ├── AGENTS.md
279
384
  ├── CHANGELOG.md
@@ -285,7 +390,9 @@ excaliplant
285
390
  ├── SECURITY.md
286
391
  ├── THIRD_PARTY_NOTICES.md
287
392
  ├── index.mjs
393
+ ├── lifecycle-test.svg
288
394
  ├── package.json
395
+ ├── prompt-deployment-diagram.md
289
396
  ├── style.example.json
290
397
  ├── style.example.yaml
291
398
  └── tsconfig.json
@@ -298,6 +405,202 @@ generated by the same command from JSDoc.
298
405
 
299
406
  ## Module documentation
300
407
 
408
+ ### diagrams
409
+
410
+
411
+
412
+ ### diagrams/base
413
+
414
+
415
+
416
+ ### diagrams/base/artifacts
417
+
418
+
419
+
420
+ ### diagrams/base/assets
421
+
422
+
423
+
424
+ ### diagrams/base/dependencies
425
+
426
+
427
+
428
+ ### diagrams/base/docs
429
+
430
+
431
+
432
+ ### diagrams/base/layout
433
+
434
+
435
+
436
+ ### diagrams/base/module
437
+
438
+
439
+
440
+ ### diagrams/base/parser
441
+
442
+
443
+
444
+ ### diagrams/base/renderer
445
+
446
+
447
+
448
+ ### diagrams/base/security
449
+
450
+
451
+
452
+ ### diagrams/base/tests
453
+
454
+
455
+
456
+ ### diagrams/class/assets
457
+
458
+
459
+
460
+ ### diagrams/class/docs
461
+
462
+
463
+
464
+ ### diagrams/class/docs/coverage_examples
465
+
466
+
467
+
468
+ ### diagrams/class/layout
469
+
470
+
471
+
472
+ ### diagrams/class/module
473
+
474
+
475
+
476
+ ### diagrams/class/parser
477
+
478
+
479
+
480
+ ### diagrams/class/render
481
+
482
+
483
+
484
+ ### diagrams/class/security
485
+
486
+
487
+
488
+ ### diagrams/class/style
489
+
490
+
491
+
492
+ ### diagrams/class/tests
493
+
494
+
495
+
496
+ ### diagrams/component/assets
497
+
498
+
499
+
500
+ ### diagrams/component/docs
501
+
502
+
503
+
504
+ ### diagrams/component/docs/coverage_examples
505
+
506
+
507
+
508
+ ### diagrams/component/layout
509
+
510
+
511
+
512
+ ### diagrams/component/module
513
+
514
+
515
+
516
+ ### diagrams/component/parser
517
+
518
+
519
+
520
+ ### diagrams/component/render
521
+
522
+
523
+
524
+ ### diagrams/component/security
525
+
526
+
527
+
528
+ ### diagrams/component/tests
529
+
530
+
531
+
532
+ ### diagrams/deployment/assets
533
+
534
+
535
+
536
+ ### diagrams/deployment/docs
537
+
538
+
539
+
540
+ ### diagrams/deployment/layout
541
+
542
+
543
+
544
+ ### diagrams/deployment/module
545
+
546
+
547
+
548
+ ### diagrams/deployment/parser
549
+
550
+
551
+
552
+ ### diagrams/deployment/render
553
+
554
+
555
+
556
+ ### diagrams/deployment/security
557
+
558
+
559
+
560
+ ### diagrams/deployment/tests
561
+
562
+
563
+
564
+ ### diagrams/sequence/assets
565
+
566
+
567
+
568
+ ### diagrams/sequence/docs
569
+
570
+
571
+
572
+ ### diagrams/sequence/layout
573
+
574
+
575
+
576
+ ### diagrams/sequence/module
577
+
578
+
579
+
580
+ ### diagrams/sequence/parser
581
+
582
+
583
+
584
+ ### diagrams/sequence/render
585
+
586
+
587
+
588
+ ### diagrams/sequence/security
589
+
590
+
591
+
592
+ ### diagrams/sequence/tests
593
+
594
+
595
+
596
+ ### diagrams/shared/graph_parser
597
+
598
+
599
+
600
+ ### diagrams/shared/graph_runtime
601
+
602
+
603
+
301
604
  ### layout
302
605
 
303
606
  Layout chooses positions for every shape and routes every edge.
@@ -311,6 +614,10 @@ tabular (lifelines on the X axis, time on the Y axis), so a
311
614
  deterministic ~90-line algorithm produces better, more compact
312
615
  results than a force-directed solver could.
313
616
 
617
+ ### main/builtin
618
+
619
+
620
+
314
621
  ### model
315
622
 
316
623
  Input-agnostic diagram model. Two top-level kinds:
@@ -325,6 +632,26 @@ pipeline; the parser is just one possible source. Callers can
325
632
  also build a `Diagram` programmatically and feed it to
326
633
  `renderDiagram()`.
327
634
 
635
+ ### modules/dependencies
636
+
637
+
638
+
639
+ ### modules/introspection
640
+
641
+
642
+
643
+ ### modules/metadata
644
+
645
+
646
+
647
+ ### modules/pipeline
648
+
649
+
650
+
651
+ ### modules/registry
652
+
653
+
654
+
328
655
  ### parser/engine
329
656
 
330
657
  A ~50-line line-walker. The engine itself knows nothing about
@@ -332,6 +659,22 @@ PlantUML syntax; that lives entirely in plugins. Block plugins
332
659
  (multi-line notes, class bodies) take exclusive ownership of
333
660
  subsequent lines until they release.
334
661
 
662
+ ### platform/asset-base
663
+
664
+
665
+
666
+ ### platform/diagnostics
667
+
668
+
669
+
670
+ ### platform/security-base
671
+
672
+
673
+
674
+ ### platform/services
675
+
676
+
677
+
335
678
  ### render
336
679
 
337
680
  Emits Excalidraw JSON. Each model shape is dispatched to a
@@ -339,9 +682,18 @@ dedicated `renderXxx()` function that produces one or more
339
682
  Excalidraw primitive elements (rectangle, ellipse, line, arrow,
340
683
  text). The output document is a stand-alone `.excalidraw` file
341
684
  that any Excalidraw front-end can open. The companion module
342
- `src/render/svg.mjs` converts the same JSON to SVG for the
685
+ `src/general/render/svg.mjs` converts the same JSON to SVG for the
343
686
  build-time documentation pipeline.
344
687
 
688
+ ### sequence-spacing
689
+
690
+ Central spacing contract for sequence diagrams.
691
+
692
+ Sequence layout has many visual item types (messages, notes, refs,
693
+ dividers, fragments, lifecycle bars). They all reserve vertical space
694
+ through this module so adding a new timeline item does not introduce a
695
+ one-off top/bottom rhythm.
696
+
345
697
  ## License
346
698
 
347
699
  MIT © grethel-labs
@@ -0,0 +1,46 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 120 80" aria-label="Arrowhead marker shapes">
2
+ <defs>
3
+ <symbol id="arrow" viewBox="0 0 10 10">
4
+ <path d="M0,0 L10,5 L0,10" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" />
5
+ </symbol>
6
+ <symbol id="triangle" viewBox="0 0 10 10">
7
+ <path d="M0,0 L10,5 L0,10 z" fill="currentColor" />
8
+ </symbol>
9
+ <symbol id="triangle_outline" viewBox="0 0 10 10">
10
+ <path d="M0,0 L10,5 L0,10 z" fill="#fff" stroke="currentColor" />
11
+ </symbol>
12
+ <symbol id="diamond" viewBox="0 0 12 10">
13
+ <path d="M0,5 L6,0 L12,5 L6,10 z" fill="currentColor" />
14
+ </symbol>
15
+ <symbol id="diamond_outline" viewBox="0 0 12 10">
16
+ <path d="M0,5 L6,0 L12,5 L6,10 z" fill="#fff" stroke="currentColor" />
17
+ </symbol>
18
+ <symbol id="circle_outline" viewBox="0 0 10 10">
19
+ <path d="M5,5 m-4,0 a4,4 0 1,0 8,0 a4,4 0 1,0 -8,0" fill="#fff" stroke="currentColor" />
20
+ </symbol>
21
+ <symbol id="dot" viewBox="0 0 10 10">
22
+ <path d="M5,5 m-3,0 a3,3 0 1,0 6,0 a3,3 0 1,0 -6,0" fill="currentColor" />
23
+ </symbol>
24
+ <symbol id="bar" viewBox="0 0 10 10">
25
+ <path d="M5,0 L5,10" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" />
26
+ </symbol>
27
+ <symbol id="partial_top" viewBox="0 0 10 10">
28
+ <path d="M0,0 L10,5" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" />
29
+ </symbol>
30
+ <symbol id="partial_bottom" viewBox="0 0 10 10">
31
+ <path d="M0,10 L10,5" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" />
32
+ </symbol>
33
+ </defs>
34
+ <g color="#1f2933" transform="translate(8 8)">
35
+ <use href="#arrow" x="0" y="0" width="16" height="16" />
36
+ <use href="#triangle" x="22" y="0" width="16" height="16" />
37
+ <use href="#triangle_outline" x="44" y="0" width="16" height="16" />
38
+ <use href="#diamond" x="66" y="0" width="19" height="16" />
39
+ <use href="#diamond_outline" x="91" y="0" width="19" height="16" />
40
+ <use href="#circle_outline" x="0" y="34" width="16" height="16" />
41
+ <use href="#dot" x="22" y="34" width="16" height="16" />
42
+ <use href="#bar" x="44" y="34" width="16" height="16" />
43
+ <use href="#partial_top" x="66" y="34" width="16" height="16" />
44
+ <use href="#partial_bottom" x="88" y="34" width="16" height="16" />
45
+ </g>
46
+ </svg>