Skip to main content

made_api/
lib.rs

1//! The published contract of the embedded MADE.
2//!
3//! This crate is what a consuming product is allowed to know. It holds plain
4//! views, a capability report, an error vocabulary and one trait — and no
5//! domain types, no adapters, no storage. A consumer that compiles against this
6//! crate alone can be tested with a stub and swapped onto any implementation
7//! that honours the same contract.
8//!
9//! Versioned deliberately. [`CONTRACT_VERSION`] moves when the meaning of this
10//! surface changes, independently of the library's own release number: two
11//! builds of the same release can differ in features, and a consumer that
12//! guessed capabilities from a version string would find out mid-run. Consumers
13//! check [`ApiCapabilities`] at startup instead.
14//!
15//! Vocabulary note (ADR-001): these types speak the engine's own language —
16//! ceremonies. A consuming product maps them to its own terms at its own
17//! boundary; nothing of that product's vocabulary appears here.
18
19mod api_capabilities;
20mod api_error;
21mod authoring_views;
22mod ceremony_engine_api;
23mod ceremony_participant;
24mod ceremony_summary;
25mod definition_defect_view;
26mod intervention_response_view;
27mod intervention_views;
28mod published_definition_view;
29mod raise_intervention_request;
30mod recalled_entry_view;
31mod recollection_view;
32mod respond_to_intervention_request;
33mod start_ceremony_request;
34
35pub use api_capabilities::ApiCapabilities;
36pub use api_error::ApiError;
37pub use authoring_views::DefinitionAnalysisView;
38pub use ceremony_engine_api::CeremonyEngineApi;
39pub use ceremony_participant::CeremonyParticipant;
40pub use ceremony_summary::CeremonySummary;
41pub use definition_defect_view::DefinitionDefectView;
42pub use intervention_response_view::InterventionResponseView;
43pub use intervention_views::InterventionView;
44pub use published_definition_view::PublishedDefinitionView;
45pub use raise_intervention_request::RaiseInterventionRequest;
46pub use recalled_entry_view::RecalledEntryView;
47pub use recollection_view::RecollectionView;
48pub use respond_to_intervention_request::RespondToInterventionRequest;
49pub use start_ceremony_request::StartCeremonyRequest;
50
51/// The revision of this contract.
52///
53/// Moves on meaning, not on release: adding a capability keeps the version,
54/// changing what an existing field or method means raises it.
55pub const CONTRACT_VERSION: u32 = 3;