spec-spine-types 0.8.0

Typed DTOs, frontmatter grammar, configuration, and schema-version constants for spec-spine: the data substrate shared by the engine and (future) bindings.
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

//! # spec-spine-types
//!
//! The typed data substrate for spec-spine: configuration, the spec frontmatter
//! grammar, the authority-unit and typed-edge vocabulary, the registry DTOs,
//! schema-version constants, and the stable [`Error`] enum.
//!
//! Everything here is plain, owned, `serde`-serializable data (no lifetimes,
//! generics, or trait objects at the public boundary) so the same types back
//! both the `spec-spine-core` engine and future FFI bindings.
//!
//! See `docs/design/00-architecture.md` for the design and the provenance of
//! the ported semantics.
//!
//! ## Layout
//! - [`config`]: the `spec-spine.toml` model ([`Config`]).
//! - [`frontmatter`]: the authored grammar ([`Frontmatter`], [`parse_frontmatter`]).
//! - [`unit`] / [`edges`]: the authority-unit and relationship vocabulary.
//! - [`registry`]: the compiled spec-as-source DTOs ([`Registry`]).
//! - [`version`]: schema-version constants.
//! - [`error`]: the [`Error`] enum and its exit-code contract.

pub mod attest;
pub mod codebase;
pub mod config;
pub mod edges;
pub mod error;
pub mod frontmatter;
pub mod registry;
pub mod schema;
pub mod unit;
pub mod version;

// --- curated public prelude (the names callers reach for most) ---

pub use attest::{
    ATTESTATION_SCHEMA_VERSION, CompileVerdict, CorpusAttestation, CoupleVerdict, LedgerSeal,
    LintVerdict, ToolStamp, Verdicts,
};
pub use codebase::{
    CodebaseIndex, Diagnostic, Diagnostics, ImplementingPath, IndexBuild, IndexPackageShard,
    IndexSpecShard, LineSpan, PackageKind, PackageRecord, ResolvedLocation, ResolvedUnit,
    SourceField, TraceMapping, TraceSource, Traceability,
};
pub use config::{
    AllowlistConfig, BrandingConfig, Config, CouplingConfig, FrontmatterConfig, IndexConfig,
    LayoutConfig, ManifestConfig, ProvenanceConfig, load_config,
};
pub use edges::{
    CoAuthorityItem, ConstrainItem, ExtendItem, Origin, Provenance, ReferenceItem, RefineItem,
    SupersedeItem, SupersedeScope, SupersedeScoped,
};
pub use error::{Error, Result};
pub use frontmatter::{
    Frontmatter, FrontmatterIssue, Implementation, KNOWN_KEYS, Risk, Status, parse_frontmatter,
    parse_frontmatter_with, split_frontmatter,
};
pub use registry::{
    Build, BuildMeta, Registry, RegistrySpecShard, Severity, SpecRecord, ValidationReport,
    Violation,
};
pub use schema::{
    BUILD_META_SCHEMA, INDEX_PACKAGE_SHARD_SCHEMA, INDEX_SCHEMA, INDEX_SPEC_SHARD_SCHEMA,
    REGISTRY_SCHEMA, REGISTRY_SPEC_SHARD_SCHEMA,
};
pub use unit::Unit;
pub use version::{
    BUILD_META_SCHEMA_VERSION, CONFIG_VERSION, INDEX_SCHEMA_VERSION, REGISTRY_SCHEMA_VERSION,
    parse_semver,
};