dendryform-core 0.1.0

Core schema types, validation, theme, and layout plan for dendryform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

//! # dendryform-core
//!
//! Core schema types, validation, theme, and layout plan for dendryform.
//!
//! This crate defines the data model for describing software architecture
//! diagrams: nodes, edges, tiers, connectors, containers, and the theme
//! system. All types use private fields with validated constructors to
//! ensure invalid states are unrepresentable.
//!
//! ## Key Types
//!
//! - [`NodeId`] — validated slug identifier for nodes
//! - [`Node`] — a card in the diagram, built via [`NodeBuilder`]
//! - [`Edge`] — a semantic relationship between nodes
//! - [`Tier`] — a horizontal band of nodes
//! - [`Diagram`] — the validated top-level document
//!
//! ## Construction Patterns
//!
//! Types are constructed either programmatically (via builders and
//! constructors) or by deserializing YAML/JSON. Deserialization of
//! [`Diagram`] validates cross-cutting invariants automatically via
//! `#[serde(try_from)]`.

mod color;
mod connector;
mod container;
mod diagram;
mod edge;
mod error;
mod id;
mod kind;
mod layer;
mod layout;
mod legend;
mod metadata;
mod node;
mod tech;
mod theme;
mod tier;

// Re-export all public types at crate root for ergonomic imports.
pub use color::Color;
pub use connector::{Connector, ConnectorStyle};
pub use container::{Container, ContainerBorder};
pub use diagram::{Diagram, DiagramHeader, RawDiagram, Title};
pub use edge::Edge;
pub use error::ValidationError;
pub use id::NodeId;
pub use kind::{EdgeKind, NodeKind};
pub use layer::{FlowLabels, Layer};
pub use layout::TierLayout;
pub use legend::LegendEntry;
pub use metadata::Metadata;
pub use node::{Node, NodeBuilder};
pub use tech::Tech;
pub use theme::{
    Backgrounds, Borders, ColorSet, Fonts, Spacing, TextColors, Theme, ThemeOverrides, ThemePalette,
};
pub use tier::Tier;

/// Returns the version of the dendryform-core crate.
pub fn version() -> &'static str {
    env!("CARGO_PKG_VERSION")
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_version_is_set() {
        assert_eq!(version(), "0.1.0");
    }
}