Changelog

Copy Markdown View Source

[0.8.0] - 2026-06-06

Changed

  • Bumped yog_ex requirement to ~> 0.98.2.
    • Mermaid rendering: Node IDs are now sanitized to n_0, n_1, etc. by Yog for Mermaid compatibility. Labels and styles remain unchanged.
    • DOT rendering: HTML-like labels are now emitted with proper single-angle bracket syntax (label=<TABLE...>) instead of the previous double-angle bracket form.

Added

  • Choreo.ERD — Database Entity-Relationship Modeling:

    • Implemented Choreo.ERD schema builder with strict NimbleOptions column and relationship constraint validation.
    • Implemented themed HTML-like table record visualization (Choreo.ERD.Render.DOT) supporting standard crow's foot multiplicities and post-rendering unquoting.
    • Implemented native Mermaid erDiagram visual syntax rendering (Choreo.ERD.Render.Mermaid).
    • Implemented a topological analysis suite (Choreo.ERD.Analysis) including undirected BFS join path discovery, DFS circular foreign key cycle detection, isolated orphan entity tracking, and table coupling metrics.
    • Implemented Choreo.Viewable protocol for Choreo.ERD to enable standard graph lens operations (focus, zoom, filter, collapse).
    • Added ExDoc groupings and a full interactive Livebook walkthrough guide (livebooks/erd_walkthrough.livemd).

  • Choreo.UML — Class & Struct Diagrams:

    • Implemented Choreo.UML schema builder with strict NimbleOptions field, arity, visibility, and relationship constraint validation.
    • Implemented themed three-compartment HTML record table visualization (Choreo.UML.Render.DOT) supporting standard class/struct/interface/behavior/protocol types, visibilities (+, -, #), and proper hollow/solid arrowhead line layouts.
    • Implemented Mermaid visual syntax rendering (Choreo.UML.Render.Mermaid) supporting both flowchart layouts and native classDiagram rendering.
    • Implemented Choreo.Viewable protocol for standard graph lens operations (focus, zoom, filter, collapse).
    • Implemented a static analysis suite (Choreo.UML.Analysis) including circular dependency detection, behavior contract validation, and Robert C. Martin's coupling & stability metrics.
    • Added ExDoc groupings and a full interactive Livebook walkthrough guide (livebooks/uml_walkthrough.livemd).

  • Choreo.Planner — Project Planning Diagrams:

    • Implemented Choreo.Planner builder for project planning with tasks, milestones, users, and labels.
    • Implemented relationship builders: contains/3 (milestone hierarchy), depends_on/3 (finish-to-start), blocks/3 (semantic blocker), assign/3 (ownership), tag/3 (categorization), and relates/3 (association).
    • Implemented native Mermaid rendering (Choreo.Planner.Render.Mermaid) supporting :kanban, :kanban_compat, :gantt, and :flowchart syntaxes with status columns, color coding, and dependency scheduling.
    • Implemented themed DOT flowchart rendering (Choreo.Planner.Render.DOT) via Yog.Multi.DOT.
    • Implemented a planning analysis suite (Choreo.Planner.Analysis) including ready/1, blocked/1, critical_path/2, bottlenecks/1, and validate/1.
    • Added a full interactive Livebook walkthrough guide (livebooks/planner_walkthrough.livemd).

  • Choreo.C4 — C4 Model Architecture Diagrams:

    • Implemented Choreo.C4 schema builder for L1–L3 C4 modeling with add_person/3, add_software_system/3, add_container/3, and add_component/3.
    • Implemented parent/child clustering with automatic container assignment from :parent references.
    • Implemented zoom-aware rendering via Choreo.Viewable protocol, enabling level-based filtering (System Context, Containers, Components).
    • Implemented themed DOT rendering (Choreo.C4.Render.DOT) with C4-specific visual conventions: persons as ellipses, systems as boxes, containers as rounded boxes, and components as dashed boxes.
    • Implemented native Mermaid rendering (Choreo.C4.Render.Mermaid) with matching shapes and built-in theme support.
    • Implemented a structural analysis suite (Choreo.C4.Analysis) including missing parent detection, missing description/technology detection, isolated node detection, missing relationship labels, and general validate/1.
    • Added a full interactive Livebook walkthrough guide (livebooks/c4_walkthrough.livemd).

  • Choreo.Sequence — Sequence Diagrams:

    • Implemented Choreo.Sequence builder for ordered participant interactions with add_actor/3, add_participant/3, message/4, async/4, return/4, and self_message/3.
    • Implemented activation boxes via activate/2 and deactivate/2, plus notes (note/3) and fragments (loop, opt, alt/else, par, break, critical).
    • Implemented native Mermaid sequenceDiagram rendering (Choreo.Sequence.Render.Mermaid) with actors, participants, activation boxes, notes, and fragments.
    • Implemented a best-effort DOT timeline fallback (Choreo.Sequence.Render.DOT) for static image and PDF pipelines.
    • Implemented a quality analysis suite (Choreo.Sequence.Analysis) including missing labels, unknown participants, isolated participants, unbalanced activations, unclosed fragments, and general validate/1.
    • Added a full interactive Livebook walkthrough guide (livebooks/sequence_walkthrough.livemd).

  • Native Mermaid Visualizers & Syntaxes:

    • Choreo.FSM: Added native :state_diagram (stateDiagram-v2) syntax support mapping initial/final states to entry/acceptance targets ([*] --> state and state --> [*]) and mapping custom labels.
    • Choreo.Dependency: Added native :class_diagram (classDiagram) syntax support mapping application/module/library types to standard UML stereotypes (e.g. <<module>>) and mapping relationships to standard UML connectors (..>, --|>, -->).
    • Updated all walkthrough Livebooks and the README.md to demonstrate and utilize these alternative syntaxes.

  • Structural & Heatmap Analysis Suite:

  • Structural Enhancements:

    • Updated cluster schema to support both atom and string :style options, resolving rendering crashes in Yog.Multi.DOT.

[0.7.1] - 2026-05-04

Added

  • Theming API Overhaul:
    • Implemented Choreo.Theme.override/2 to allow non-destructive deep-merging of nested theme maps (colors, shapes) while replacing top-level attributes like graph_rankdir.
    • Added a standardized theme/2 helper function across all core modules (Workflow, Dataflow, MindMap, FSM, DecisionTree, Dependency, and ThreatModel) to easily apply specific overrides while preserving default module schemas.
  • Added :retention option to Choreo.ThreatModel.add_data_store/3 for modeling data lifecycles.

Fixed

  • Added :none to the allowed privilege types in Choreo.ThreatModel processes to support modeling unprivileged services.
  • Choreo.ThreatModel.Analysis now correctly downgrades the base severity of STRIDE threats (Spoofing, Tampering, Information Disclosure, Denial of Service) for processes with :none privilege to reflect their lower impact surface.

[0.7.0] - 2026-05-03

Added

  • Cross-module diagram composition (Choreo.embed/4):

    • Safely merge modular sub-diagrams (Workflow, Dataflow, etc.) into root clusters.
    • Automatic cluster namespace isolation and node ID prefixing.

  • Custom theme presets and per-node style overrides across all modules:

    • Overriding shape, fillcolor, fontcolor, style, and penwidth for individual nodes.
    • Global theme preset capabilities.

  • Automated validation parameter docs using NimbleOptions.docs/1.

  • Strict Schema Validation using NimbleOptions across all core modules:

  • Multigraph support (parallel edges) for Choreo and Choreo.FSM:

  • Choreo.MindMap — concept-mapping builder with hierarchical branches and associative cross-links

    • Nodes: set_root/3, add_topic/3, add_subtopic/3, add_note/3
    • Edges: branch/4 (hierarchical), associate/4 (cross-link with dashed, undirected rendering)
    • Analysis: depth/1, breadth/1, leaves/1, orphan_nodes/1, max_width/1, paths/1, type_frequencies/1, cyclic?/1, validate/1
    • 5 built-in themes (:default, :dark, :warm, :forest, :ocean) with mind-map-specific colour palettes
    • Same-rank sibling alignment in DOT output

  • Choreo.View — graph lens layer for zoom, focus, filter, and collapse transforms across diagram modules

    • focus/3 — ego-graph view (node + N-hop neighbourhood, bidirectional by default)
    • focus_between/4 — shortest-path view between two nodes, with optional neighbourhood radius
    • zoom/2 — module-defined level-based filtering with optional transitive: true for virtual edges through removed intermediates
    • filter/3 — predicate-based node filtering with optional transitive: true
    • collapse/4 — aggregate multiple nodes into one, automatically rewiring all incoming/outgoing edges and removing duplicates/self-loops
    • Protocol-based design (Choreo.Viewable) so each module defines its own rebuild, root-resolution, zoom-predicate, and virtual-edge styling
    • Virtual edges are automatically styled (dashed, pale) via the protocol's virtual_edge_meta/1 callback
    • Supports all diagram modules: Choreo, Choreo.MindMap, Choreo.DecisionTree, Choreo.Dataflow, Choreo.ThreatModel, Choreo.Dependency, and Choreo.Workflow
    • Choreo.View transparently handles both simple graphs (Yog.Graph) and multigraphs (Yog.Multi.Graph) via internal dispatch helpers

  • Choreo.FSM enforces 100% DFA purity at build time:

    • Epsilon transitions (empty labels) are rejected with ArgumentError
    • Different transition labels between the same state pair are now allowed (e.g., q0 --"a"--> q1 and q0 --"b"--> q1)
    • Duplicate labels from the same state are still rejected (DFA determinism)

Changed

0.6.0 — 2026-04-25

Added

Changed

  • Breaking: Choreo.FSM state typing moved from node state_type field to meta MapSets (initial_states and final_states). add_state/3 with type: :initial or type: :final now populates these sets directly.
  • Choreo.FSM.add_state/3 with type: :normal now explicitly clears a state from both initial_states and final_states in meta. Omitting the :type option (e.g. updating a label) preserves existing status.
  • Choreo.FSM.Analysis.deterministic?/1 now enforces a single initial state in addition to unique outgoing transition labels, aligning with classical DFA definition.

Fixed

  • add_state/3 with type: :initial now correctly registers the state in meta.initial_states so that reachable_states/1, accepts?/2, and rendering treat it as an entry point.
  • Fixed broken doctests in Choreo.FSM.add_initial_state/2 and Choreo.FSM.add_final_state/2 that still referenced the removed state_type node field.

0.5.0 — 2026-04-24

Added

  • Choreo.Workflow — task orchestration builder with Saga-pattern compensation support
    • Nodes: add_start/3, add_end/3, add_task/3, add_decision/3, add_fork/3, add_join/3, add_compensation/3, add_event/3
    • Edge types: :sequence, :compensation, :retry, :failure, :timeout
    • Swimlane grouping for visual organization
    • Analysis: critical_path/1, parallelizable_tasks/1, failure_scenarios/1, missing_compensations/1, bottlenecks/2, simulate/1, validate/1
  • Internal helpers module — shared bfs_reachable/2, build_cluster_subgraphs/2, best_predecessor/3 extracted to eliminate Credo duplicate-code warnings

Changed

Fixed

  • All mix credo --strict warnings resolved (double filters, deep nesting, unused aliases, list append inefficiencies, Enum.map_join/3 usage, with→case conversions)
  • Incorrect @spec return types for edge-returning functions (String.t() → number())

0.1.0 — 2026-04-24

Added

  • Choreo — infrastructure architecture diagrams with typed nodes (database, cache, service, queue, etc.), clusters, and MST/topological-sort analysis
  • Choreo.FSM — finite-state machine builder with initial/final states, transitions, determinism checks, NFA simulation, equivalence checking, and pruning
  • Choreo.Dataflow — pipeline / ETL diagram builder with sources, transforms, buffers, conditionals, merges, and sinks
    • Analysis: cycle detection, topological sort, orphan/dead-end detection, bottlenecks, critical-path (longest path), throughput simulation, backpressure detection
    • Edge types: normal, error, retry, dead-letter
    • Cluster support
  • Choreo.Dependency — software dependency graphs with applications, libraries, modules, interfaces, and tests
    • Analysis: circular dependency extraction (actual paths), impact analysis (affected_by/2, depends_on/2), layer violation detection, centrality ranking, longest dependency chain
    • Cycle edge highlighting in DOT output
  • Choreo.DecisionTree — classification tree builder with enforced tree invariants
    • Analysis: decide/2 evaluation, path enumeration, depth/breadth metrics, feature importance, redundant-branch pruning
  • Choreo.ThreatModel — STRIDE threat modeling with automated threat generation
    • Analysis: auto-generated STRIDE threats per element type, trust-boundary crossing detection, exposed data stores, high-risk processes, unencrypted flow detection
    • Severity scoring based on sensitivity, privilege, encryption, and trust level
  • Shared DOT rendering pipeline with :default, :dark, and custom Choreo.Theme support
  • Graphviz integration in ExDoc for inline diagram rendering
  • Credo, Dialyzer, and ExCoveralls tooling