Skip to main content

minco/
lib.rs

1//! Minco's ergonomic facade crate.
2//!
3//! `minco` re-exports the provider-neutral kernel and enables the contract,
4//! HTTP, and official default-plugin crates through Cargo features. Database,
5//! Lambda, planning, release, and test support remain opt-in so applications
6//! compile only the capabilities they use.
7//!
8//! # Minimal composition
9//!
10//! ```rust
11//! use minco::prelude::*;
12//!
13//! let manager = minco::default_plugin_manager()?;
14//! let _application = manager.compose(&PluginSelection::default())?;
15//! # Ok::<(), minco::core::PluginError>(())
16//! ```
17#![forbid(unsafe_code)]
18
19/// Provider-neutral plugin, capability, service, and application graph APIs.
20pub use minco_core as core;
21
22#[cfg(feature = "config")]
23/// Typed environments, configuration schema, provenance, and secret references.
24pub use minco_config as config;
25
26#[cfg(feature = "db")]
27/// Provider-neutral migration catalogs, plans, status, risk, and verification models.
28pub use minco_db as db;
29
30#[cfg(feature = "contract")]
31/// `OpenAPI` loading, validation, operation inventory, and deterministic binding generation.
32pub use minco_contract as contract;
33
34#[cfg(feature = "http")]
35/// Axum and Tower delivery conventions.
36pub use minco_http as http;
37
38#[cfg(feature = "interaction")]
39/// Provider-neutral support entry, attachments, transcription, and workflow primitives.
40pub use minco_interaction as interaction;
41
42#[cfg(feature = "plan")]
43/// Provider-neutral deployment planning, structural cost checks, and SAM rendering.
44pub use minco_plan as plan;
45
46#[cfg(feature = "release")]
47/// Immutable release manifests and artifact verification.
48pub use minco_release as release;
49
50#[cfg(feature = "test")]
51/// In-process HTTP and command-evidence test helpers.
52pub use minco_test as test;
53
54#[cfg(feature = "plugin-health")]
55/// Official health and readiness plugin.
56pub use minco_plugin_health as plugin_health;
57
58#[cfg(feature = "plugin-observability")]
59/// Official structured-observability plugin.
60pub use minco_plugin_observability as plugin_observability;
61
62#[cfg(feature = "plugin-idempotency")]
63/// Official idempotency primitives and plugin.
64pub use minco_plugin_idempotency as plugin_idempotency;
65
66#[cfg(feature = "plugin-payments-waffo")]
67/// Official Waffo Pancake checkout, signed API, and webhook plugin.
68pub use minco_plugin_payments_waffo as plugin_payments_waffo;
69
70#[cfg(feature = "plugin-sessions")]
71/// Official provider-neutral session issuance and revocation plugin.
72pub use minco_plugin_sessions as plugin_sessions;
73
74#[cfg(feature = "plugin-identity")]
75/// Official verified-claims identity and permission plugin.
76pub use minco_plugin_identity as plugin_identity;
77
78#[cfg(feature = "plugin-object-storage")]
79/// Official provider-neutral object-storage plugin.
80pub use minco_plugin_object_storage as plugin_object_storage;
81
82#[cfg(feature = "plugin-events")]
83/// Official domain-event and explicit outbox plugin.
84pub use minco_plugin_events as plugin_events;
85
86#[cfg(feature = "plugin-jobs")]
87/// Official durable typed work plugin.
88pub use minco_plugin_jobs as plugin_jobs;
89
90#[cfg(feature = "plugin-notifications")]
91/// Official provider-neutral notification plugin.
92pub use minco_plugin_notifications as plugin_notifications;
93
94#[cfg(feature = "plugin-audit")]
95/// Official append-only audit plugin.
96pub use minco_plugin_audit as plugin_audit;
97
98#[cfg(feature = "plugin-feedback")]
99/// Official AI-ready client feedback-loop plugin.
100pub use minco_plugin_feedback as plugin_feedback;
101
102#[cfg(feature = "plugin-ticketing")]
103/// Official project-scoped support Ticketing plugin.
104pub use minco_plugin_ticketing as plugin_ticketing;
105
106#[cfg(feature = "plugin-static-site")]
107/// Official provider-neutral static-site deployment plugin.
108pub use minco_plugin_static_site as plugin_static_site;
109
110#[cfg(feature = "plugin-realtime")]
111/// Official provider-neutral subscriber-only realtime plugin.
112pub use minco_plugin_realtime as plugin_realtime;
113
114#[cfg(feature = "sqlx-postgres")]
115/// Bounded `SQLx` `PostgreSQL` pool support.
116pub use minco_sqlx_postgres as sqlx_postgres;
117
118#[cfg(feature = "sqlx-sqlite")]
119/// `SQLx` `SQLite` pool support.
120pub use minco_sqlx_sqlite as sqlx_sqlite;
121
122#[cfg(feature = "aws-lambda")]
123/// Native AWS Lambda HTTP and SSM integration.
124pub use minco_aws_lambda as aws_lambda;
125
126#[cfg(feature = "aws-worker")]
127/// Native AWS Lambda SQS partial-batch worker runtime.
128pub use minco_aws_worker as aws_worker;
129
130#[cfg(feature = "aws-adapters")]
131/// Production S3, SQS, SES, Cognito, webhook, static-site, and `AppSync` adapters.
132pub use minco_aws_adapters as aws_adapters;
133
134/// Common imports for application composition.
135pub mod prelude {
136    #[cfg(feature = "config")]
137    pub use minco_config::{
138        ConfigLayer, ConfigSourceKind, ConfigurationField, ConfigurationGraph, ConfigurationSchema,
139        ConfigurationValueKind, Environment, EnvironmentClass, SecretReference,
140    };
141    pub use minco_core::{
142        ApplicationGraph, CapabilityProvision, CapabilityRequirement, ComposedApplication,
143        ContributionCollection, ContributionRegistrar, ContributionRegistration,
144        ContributionTypeRegistration, DuplicateServiceRegistration, FrozenContributions,
145        FrozenServices, GraphBuilder, GraphError, HealthCheckDescriptor, IdleCostClass,
146        MigrationSet, OperationDescriptor, Plugin, PluginContext, PluginDescriptor, PluginError,
147        PluginFinalizeContext, PluginId, PluginManager, PluginSelection, RegistrationOwner,
148        RegistrationProvenance, ResourceIntent, ResourceKind, ServiceCollection, ServiceError,
149        ServiceRegistrar, ServiceRegistration, WakeSource,
150    };
151
152    #[cfg(feature = "db")]
153    pub use minco_db::{
154        DatabaseBackend, MigrationCatalog, MigrationPlan, MigrationRisk, MigrationState,
155        MigrationStatus, TargetState,
156    };
157
158    #[cfg(feature = "http")]
159    pub use minco_http::{
160        ApiFailure, ContractAuthorizationAlternative, ContractAuthorizationPolicy,
161        ContractValidate, ContractValidationErrors, HttpConfigurationError, HttpHeaderPolicy,
162        HttpRuntimeConfig, Principal, ProblemDetails, RequestMetadata, ValidatedJson,
163        ValidatedPath, ValidatedQuery, apply_standard_middleware, authorize_operation,
164        problem_response,
165    };
166}
167
168/// Builds a plugin manager containing every official plugin enabled at compile time.
169///
170/// With the default feature set this registers health, observability, and
171/// idempotency. Applications can disable any registered default at runtime with
172/// [`core::PluginSelection`] or remove it from the binary with
173/// `default-features = false` and explicit features.
174pub fn default_plugin_manager() -> Result<core::PluginManager, core::PluginError> {
175    let mut manager = core::PluginManager::default();
176    register_enabled_plugins(&mut manager)?;
177    Ok(manager)
178}
179
180fn register_enabled_plugins(manager: &mut core::PluginManager) -> Result<(), core::PluginError> {
181    #[cfg(feature = "plugin-health")]
182    manager.register(plugin_health::HealthPlugin)?;
183
184    #[cfg(feature = "plugin-observability")]
185    manager.register(plugin_observability::ObservabilityPlugin::default())?;
186
187    #[cfg(feature = "plugin-idempotency")]
188    manager.register(plugin_idempotency::IdempotencyPlugin::memory())?;
189
190    #[cfg(feature = "plugin-payments-waffo")]
191    manager.register(plugin_payments_waffo::WaffoPlugin)?;
192
193    #[cfg(feature = "plugin-sessions")]
194    manager.register(plugin_sessions::SessionsPlugin::memory())?;
195
196    #[cfg(feature = "plugin-identity")]
197    manager.register(plugin_identity::IdentityPlugin::default())?;
198
199    #[cfg(feature = "plugin-object-storage")]
200    manager.register(plugin_object_storage::ObjectStoragePlugin::memory())?;
201
202    #[cfg(feature = "plugin-events")]
203    manager.register(plugin_events::EventsPlugin::memory().0)?;
204
205    #[cfg(feature = "plugin-jobs")]
206    manager.register(
207        plugin_jobs::JobsPlugin::memory(
208            std::sync::Arc::new(plugin_jobs::JobHandlerRegistry::new()),
209        )
210        .0,
211    )?;
212
213    #[cfg(feature = "plugin-notifications")]
214    manager.register(plugin_notifications::NotificationsPlugin::memory().0)?;
215
216    #[cfg(feature = "plugin-audit")]
217    manager.register(plugin_audit::AuditPlugin::memory().0)?;
218
219    #[cfg(feature = "plugin-feedback")]
220    manager.register(plugin_feedback::FeedbackPlugin::memory())?;
221
222    #[cfg(feature = "plugin-ticketing")]
223    manager.register(plugin_ticketing::TicketingPlugin::memory())?;
224
225    #[cfg(feature = "plugin-static-site")]
226    manager.register(plugin_static_site::StaticSitePlugin::default())?;
227
228    #[cfg(feature = "plugin-realtime")]
229    manager.register(plugin_realtime::RealtimePlugin::default())?;
230
231    // Keep the no-feature build warning-free when every registration above is
232    // compiled out.
233    let _ = manager;
234    Ok(())
235}
236
237/// Composes all compile-time official plugins using the supplied runtime selection.
238pub fn compose_defaults(
239    selection: &core::PluginSelection,
240) -> Result<core::ComposedApplication, core::PluginError> {
241    default_plugin_manager()?.compose(selection)
242}
243
244#[cfg(all(test, feature = "default-plugins"))]
245mod tests {
246    use super::*;
247
248    #[test]
249    fn default_features_compose_the_official_plugin_set() {
250        let application = compose_defaults(&core::PluginSelection::default()).unwrap();
251        let ids = application
252            .graph
253            .plugins
254            .iter()
255            .map(|plugin| plugin.id.as_str())
256            .collect::<Vec<_>>();
257
258        assert_eq!(ids, ["health", "idempotency", "observability"]);
259    }
260}
261
262#[cfg(all(test, feature = "http"))]
263mod http_prelude_tests {
264    use super::prelude::*;
265
266    #[test]
267    fn request_boundary_types_are_available_through_the_facade_prelude() {
268        fn accepts<T: ContractValidate>() {}
269        accepts::<FacadeRequest>();
270        let request = ValidatedJson(FacadeRequest);
271        let _ = request.into_inner();
272        let _: Option<ValidatedQuery<FacadeRequest>> = None;
273        let _: Option<ValidatedPath<FacadeRequest>> = None;
274    }
275
276    struct FacadeRequest;
277
278    impl ContractValidate for FacadeRequest {
279        fn validate_contract(&self, _errors: &mut ContractValidationErrors) {}
280    }
281}