fraiseql_cli/schema/intermediate/
mod.rs

1//! Intermediate Schema Format
2//!
3//! Language-agnostic schema representation that all language libraries output.
4//! See `docs/architecture/intermediate-schema.md` for full specification.
5
6pub mod advanced_types;
7pub mod analytics;
8pub mod fragments;
9pub mod operations;
10pub mod subscriptions;
11pub mod types;
12
13pub use advanced_types::{
14    IntermediateInputField, IntermediateInputObject, IntermediateInterface, IntermediateUnion,
15};
16pub use analytics::{
17    IntermediateAggregateQuery, IntermediateDimensionPath, IntermediateDimensions,
18    IntermediateFactTable, IntermediateFilter, IntermediateMeasure,
19};
20pub use fragments::{
21    IntermediateAppliedDirective, IntermediateDirective, IntermediateFragment,
22    IntermediateFragmentField, IntermediateFragmentFieldDef,
23};
24use fraiseql_core::schema::{
25    DebugConfig, McpConfig, NamingConvention, RestConfig, SessionVariablesConfig,
26    SubscriptionsConfig, ValidationConfig,
27};
28pub use operations::{
29    IntermediateArgument, IntermediateAutoParams, IntermediateMutation, IntermediateQuery,
30    IntermediateQueryDefaults,
31};
32use serde::{Deserialize, Serialize};
33pub use subscriptions::{
34    IntermediateFilterCondition, IntermediateObserver, IntermediateObserverAction,
35    IntermediateRetryConfig, IntermediateSubscription, IntermediateSubscriptionFilter,
36};
37pub use types::{
38    IntermediateDeprecation, IntermediateEnum, IntermediateEnumValue, IntermediateField,
39    IntermediateScalar, IntermediateType,
40};
41
42/// Intermediate schema - universal format from all language libraries
43#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
44pub struct IntermediateSchema {
45    /// Schema format version
46    #[serde(default = "default_version")]
47    pub version: String,
48
49    /// GraphQL object types
50    #[serde(default)]
51    pub types: Vec<IntermediateType>,
52
53    /// GraphQL enum types
54    #[serde(default)]
55    pub enums: Vec<IntermediateEnum>,
56
57    /// GraphQL input object types
58    #[serde(default)]
59    pub input_types: Vec<IntermediateInputObject>,
60
61    /// GraphQL interface types (per GraphQL spec §3.7)
62    #[serde(default)]
63    pub interfaces: Vec<IntermediateInterface>,
64
65    /// GraphQL union types (per GraphQL spec §3.10)
66    #[serde(default)]
67    pub unions: Vec<IntermediateUnion>,
68
69    /// GraphQL queries
70    #[serde(default)]
71    pub queries: Vec<IntermediateQuery>,
72
73    /// GraphQL mutations
74    #[serde(default)]
75    pub mutations: Vec<IntermediateMutation>,
76
77    /// GraphQL subscriptions
78    #[serde(default)]
79    pub subscriptions: Vec<IntermediateSubscription>,
80
81    /// GraphQL fragments (reusable field selections)
82    #[serde(default, skip_serializing_if = "Option::is_none")]
83    pub fragments: Option<Vec<IntermediateFragment>>,
84
85    /// GraphQL directive definitions (custom directives)
86    #[serde(default, skip_serializing_if = "Option::is_none")]
87    pub directives: Option<Vec<IntermediateDirective>>,
88
89    /// Analytics fact tables (optional)
90    #[serde(default, skip_serializing_if = "Option::is_none")]
91    pub fact_tables: Option<Vec<IntermediateFactTable>>,
92
93    /// Analytics aggregate queries (optional)
94    #[serde(default, skip_serializing_if = "Option::is_none")]
95    pub aggregate_queries: Option<Vec<IntermediateAggregateQuery>>,
96
97    /// Observer definitions (database change event listeners)
98    #[serde(default, skip_serializing_if = "Option::is_none")]
99    pub observers: Option<Vec<IntermediateObserver>>,
100
101    /// Custom scalar type definitions
102    ///
103    /// Defines custom GraphQL scalar types with validation rules.
104    /// Custom scalars can be defined in Python, TypeScript, Java, Go, and Rust SDKs,
105    /// and are compiled into the CompiledSchema's CustomTypeRegistry.
106    #[serde(default, skip_serializing_if = "Option::is_none")]
107    pub custom_scalars: Option<Vec<IntermediateScalar>>,
108
109    /// Security configuration (from fraiseql.toml)
110    /// Compiled from the security section of fraiseql.toml at compile time.
111    /// Optional - if not provided, defaults are used.
112    #[serde(default, skip_serializing_if = "Option::is_none")]
113    pub security: Option<serde_json::Value>,
114
115    /// Observers/event system configuration (from fraiseql.toml).
116    ///
117    /// Contains backend connection settings (redis_url, nats_url, etc.) compiled
118    /// from the `[observers]` TOML section. Embedded verbatim into the compiled schema.
119    #[serde(default, skip_serializing_if = "Option::is_none")]
120    pub observers_config: Option<serde_json::Value>,
121
122    /// Federation configuration (from fraiseql.toml).
123    ///
124    /// Contains Apollo Federation settings and circuit breaker configuration compiled
125    /// from the `[federation]` TOML section. Embedded verbatim into the compiled schema.
126    #[serde(default, skip_serializing_if = "Option::is_none")]
127    pub federation_config: Option<serde_json::Value>,
128
129    /// WebSocket subscription configuration (hooks, limits).
130    ///
131    /// Compiled from the `[subscriptions]` TOML section. Embedded verbatim into
132    /// the compiled schema for server-side consumption.
133    #[serde(default, skip_serializing_if = "Option::is_none")]
134    pub subscriptions_config: Option<SubscriptionsConfig>,
135
136    /// Query validation config (depth/complexity limits).
137    ///
138    /// Compiled from `[validation]` in `fraiseql.toml`. Embedded into the compiled
139    /// schema for server-side consumption.
140    #[serde(default, skip_serializing_if = "Option::is_none")]
141    pub validation_config: Option<ValidationConfig>,
142
143    /// Debug/development configuration.
144    ///
145    /// Compiled from `[debug]` in `fraiseql.toml`. Embedded into the compiled
146    /// schema for server-side consumption.
147    #[serde(default, skip_serializing_if = "Option::is_none")]
148    pub debug_config: Option<DebugConfig>,
149
150    /// MCP (Model Context Protocol) server configuration.
151    ///
152    /// Compiled from `[mcp]` in `fraiseql.toml`. Embedded into the compiled
153    /// schema for server-side consumption.
154    #[serde(default, skip_serializing_if = "Option::is_none")]
155    pub mcp_config: Option<McpConfig>,
156
157    /// REST transport configuration.
158    ///
159    /// Compiled from `[rest]` in `fraiseql.toml`. Embedded into the compiled
160    /// schema for server-side consumption.
161    #[serde(default, skip_serializing_if = "Option::is_none")]
162    pub rest_config: Option<RestConfig>,
163
164    /// Global auto-param defaults for list queries (injected from TOML by the merger).
165    ///
166    /// Never present in `schema.json` — populated at compile time from `[query_defaults]`
167    /// in `fraiseql.toml`. Used by the converter to resolve per-query `auto_params`.
168    #[serde(default, skip_serializing_if = "Option::is_none")]
169    pub query_defaults: Option<IntermediateQueryDefaults>,
170
171    /// Naming convention for GraphQL operation names.
172    ///
173    /// Compiled from `fraiseql.toml` top-level `naming_convention` setting.
174    #[serde(default)]
175    pub naming_convention: NamingConvention,
176
177    /// Session variable injection configuration.
178    ///
179    /// When populated, the executor calls `set_config()` before each query and
180    /// mutation to inject per-request values (JWT claims, HTTP headers, or literals)
181    /// as PostgreSQL transaction-scoped settings.
182    ///
183    /// Embedded verbatim from the `session_variables` key in `schema.json`.
184    #[serde(default, skip_serializing_if = "Option::is_none")]
185    pub session_variables: Option<SessionVariablesConfig>,
186
187    /// Hierarchy definitions for ID-based ltree operators.
188    ///
189    /// Compiled from the `[hierarchies]` TOML section. Maps hierarchy names
190    /// to table/path_column pairs for subquery generation.
191    #[serde(default, skip_serializing_if = "Option::is_none")]
192    pub hierarchies_config: Option<fraiseql_core::schema::HierarchiesConfig>,
193}
194
195fn default_version() -> String {
196    "2.0.0".to_string()
197}
198
199#[cfg(test)]
200mod tests;
fraiseql_cli/schema/intermediate/mod.rs

fraiseql_cli/schema/intermediate/
mod.rs
