arcly_http/
lib.rs

1//! **arcly-http** — NestJS ergonomics meets Rust safety & speed.
2//!
3//! This is the **facade crate**: it re-exports the always-compiled
4//! [`arcly-http-core`](arcly_http_core) foundation and, behind Cargo features,
5//! the optional subsystems. Nothing heavy compiles by default — enable only
6//! what you use:
7//!
8//! | Feature | Brings in | Heavy deps |
9//! |---|---|---|
10//! | *(default)* | DI, routing, `RequestContext`, auth, resilience, observability, OpenAPI | — |
11//! | `data` / `db-*` | multi-tenant data layer + drivers | sqlx / sea-orm / diesel |
12//! | `compliance` | PII masking + field encryption | aes-gcm |
13//! | `realtime` | WebSocket gateways + SSE | — |
14//! | `messaging` | event consumer mesh | — |
15//! | `full` | everything (what docs.rs builds) | all |
16//!
17//! Most applications only need `use arcly_http::prelude::*;`.
18
19#![forbid(unsafe_code)]
20
21pub mod app;
22pub mod testing;
23
24// ─── Always-on foundation (re-exported from arcly-http-core) ────────────────
25pub use arcly_http_core::{
26    auth, core, docs, http, observability, pipeline, resilience, transport, web,
27};
28// Path-compat + convenience module aliases (mirror the pre-split layout).
29pub use arcly_http_core::auth::{guards, oauth};
30pub use arcly_http_core::web::{cache, interceptors, security, validation};
31pub use arcly_http_core::{cookie, openapi, plugins, session};
32
33// ─── Optional subsystems (feature-gated) ────────────────────────────────────
34#[cfg(feature = "compliance")]
35pub use arcly_http_compliance::compliance;
36#[cfg(feature = "data")]
37pub use arcly_http_data::data;
38#[cfg(feature = "messaging")]
39pub use arcly_http_messaging::messaging;
40#[cfg(feature = "messaging")]
41pub use arcly_http_messaging::messaging::event;
42#[cfg(feature = "realtime")]
43pub use arcly_http_realtime::realtime;
44
45// Re-exports needed by macro expansions (`::arcly_http::…`).
46#[doc(hidden)]
47pub use arcly_http_core::__axum;
48pub use arcly_http_core::__schema_for;
49pub use futures;
50pub use inventory;
51pub use schemars;
52pub use serde_json;
53pub use validator;
54
55pub use app::{App, LaunchConfig};
56pub use web::{Error, RequestContext};
57
58/// Single stable surface for `arcly-http-macros` codegen.
59///
60/// Every symbol the proc-macros emit is re-exported here. Subsystem symbols
61/// are feature-gated: using an attribute whose subsystem feature is disabled
62/// (e.g. `#[EventConsumer]` without `messaging`) yields a clear unresolved-
63/// import error pointing at the missing feature.
64#[doc(hidden)]
65pub mod __macro_support {
66    pub use arcly_http_core::auth::guards::Guard;
67    pub use arcly_http_core::auth::policy::check_policies;
68    pub use arcly_http_core::core::engine::{
69        FrozenDiContainer, HttpMethod, Module, ModuleDescriptor, ParamLoc, ParamSpec,
70        ProviderDescriptor, Resolver, RouteDescriptor, RouteSpec,
71    };
72    pub use arcly_http_core::http::Json;
73    pub use arcly_http_core::observability::audit::emit_route_audit;
74    pub use arcly_http_core::resilience::timeout::run_with_timeout;
75    pub use arcly_http_core::resilience::{BreakerOpen, CircuitBreaker};
76    pub use arcly_http_core::web::context::RequestContext;
77    pub use arcly_http_core::web::extract::{
78        extract_body_validated, extract_header, extract_param, extract_query_validated, Inject,
79    };
80    pub use arcly_http_core::web::idempotency::run_idempotent;
81    pub use arcly_http_core::web::interceptors::{Interceptor, NextHandler};
82    pub use arcly_http_core::web::Error;
83
84    #[cfg(feature = "compliance")]
85    pub use arcly_http_compliance::compliance::crypto::EncryptRecord;
86    #[cfg(feature = "compliance")]
87    pub use arcly_http_compliance::compliance::masking::mask_response;
88    #[cfg(feature = "data")]
89    pub use arcly_http_data::data::tx::run_transactional;
90    #[cfg(feature = "messaging")]
91    pub use arcly_http_messaging::messaging::{EventContext, EventError, EventHandlerDescriptor};
92    #[cfg(feature = "realtime")]
93    pub use arcly_http_realtime::realtime::gateway::{
94        GatewayDescriptor, GatewayRuntime, MessageHandler,
95    };
96    #[cfg(feature = "realtime")]
97    pub use arcly_http_realtime::realtime::{ArclyGateway, WsClient};
98}
99
100/// `use arcly_http::prelude::*;` brings in everything a user needs.
101pub mod prelude {
102    pub use crate::app::{App, LaunchConfig};
103    pub use crate::auth::cookie::{CookieConfig, CookieService, SameSite};
104    pub use crate::auth::guards::{
105        JwtAuthGuard, RoleGuard, SessionAuthGuard, JWT_AUTH, SESSION_AUTH,
106    };
107    pub use crate::auth::oauth::{OAuth2Provider, OAuth2Service, OAuth2UserInfo};
108    pub use crate::auth::policy::{
109        check_policies, Decision, EnvAttributes, PolicyEngine, PolicyInput, PolicySet, PolicySource,
110    };
111    pub use crate::auth::secrets::{spawn_secret_watcher, Rotating, SecretSource, SecretVersion};
112    pub use crate::auth::session::{Session, SessionConfig, SessionManager, SessionStore};
113    pub use crate::auth::{JwtConfig, JwtService};
114    pub use crate::cache::{stats as cache_stats, CacheInterceptor, CacheStats};
115    pub use crate::core::engine::FrozenDiContainer;
116    pub use crate::core::plugins::{ArclyPlugin, ArclyPluginContext, PluginError, PluginStage};
117    pub use crate::http::{
118        byte_range, bytes_response, header, Body, Bytes, HeaderMap, HeaderName, HeaderValue,
119        IntoResponse, Json, Method, RequestParts, Response, ResponseBuilder, StatusCode, Uri,
120    };
121    pub use crate::interceptors::{
122        EnvelopeResponse, Interceptor, LatencyLog, NextHandler, TelemetryLog, TraceInterceptor,
123    };
124    pub use crate::observability::audit::{AuditOutcome, AuditPipeline, AuditRecord, AuditSink};
125    pub use crate::observability::health::{HealthCheck, HealthRegistry, HealthStatus};
126    pub use crate::observability::plugin::ArclyObservabilityPlugin;
127    pub use crate::openapi::{ApiKeyIn, OpenApiInfo, SecurityScheme};
128    pub use crate::pipeline::Provenance;
129    pub use crate::resilience::{
130        Bulkhead, DLockBackend, DistributedLock, DistributedRateLimit, FailurePolicy, LockGuard,
131        RateDecision, RateLimit, RateLimitBackend,
132    };
133    pub use crate::security::{configure as configure_security, FrameOptions, SecurityConfig};
134    pub use crate::validation::Validated;
135    pub use crate::web::boundary::BoundaryFilter;
136    pub use crate::web::cors::CorsConfig;
137    pub use crate::web::dynamic::{DynamicRouteTable, DYNAMIC_PREFIX};
138    pub use crate::web::error::{
139        BadRequest, Conflict, FieldError, Forbidden, GatewayTimeout, HttpError, HttpException,
140        Internal, NotFound, ProblemDetails, ServiceUnavailable, TooManyRequests, Unauthorized,
141        Validation,
142    };
143    pub use crate::web::idempotency::{IdempotencyDecision, IdempotencyStore};
144    pub use crate::web::multipart::{MultipartForm, Part};
145    pub use crate::web::pagination::{Page, PageParams};
146    pub use crate::web::responses::{Accepted, Created, NoContent};
147    pub use crate::web::tenant::{
148        TenantConfig, TenantGuard, TenantId, TenantRegistry, TenantStrategy, TENANT,
149    };
150    pub use crate::web::{Error, Inject, RequestContext};
151
152    // ─── Optional subsystems ────────────────────────────────────────────────
153    #[cfg(feature = "compliance")]
154    pub use crate::compliance::{
155        CryptoError, CryptoVault, DataKey, EncryptRecord, EncryptedField, KekSource, KeyId,
156        MaskRule, MaskStrategy, Masker, MaskingPolicy,
157    };
158    #[cfg(feature = "data")]
159    pub use crate::data::db::{ArclyDbPool, DbDriver, DbHealthCheck, OwnedDbConn};
160    #[cfg(all(feature = "data", feature = "db-sqlx"))]
161    pub use crate::data::migrate::{Migration, MigrationReport, MigrationRunner};
162    #[cfg(feature = "data")]
163    pub use crate::data::outbox::{
164        with_transaction, OutboxEntry, OutboxPublisher, OutboxRelay, OutboxStore, OutboxTx,
165        TransactionalDataSource,
166    };
167    #[cfg(feature = "data")]
168    pub use crate::data::tx::{in_transaction, with_current_tx, ArclyTransaction};
169    #[cfg(feature = "data")]
170    pub use crate::data::{
171        AccessIntent, DataError, DataErrorKind, DataSource, DataSourceRegistry, ReadAfterWritePin,
172    };
173    #[cfg(feature = "messaging")]
174    pub use crate::messaging::{
175        ConsumerRuntime, EventContext, EventHandlerDescriptor, InboundMessage, MessageTransport,
176    };
177
178    pub use arcly_http_macros::{
179        circuit_breaker, AuditLog, CacheKey, CacheTTL, Controller, Delete, Deprecated,
180        EncryptFields, EventConsumer, EventPattern, Get, Idempotent, Injectable, MaskFields,
181        Module, Multipart, Patch, Post, Put, RequirePolicies, Timeout, Transactional,
182        UseInterceptors, Version,
183    };
184    #[cfg(feature = "realtime")]
185    pub use arcly_http_macros::{Gateway, Subscribe};
186    pub use schemars::JsonSchema;
187    pub use validator::Validate;
188}
arcly_http/lib.rs

arcly_http/
lib.rs
