uf-valence 0.1.5

Valence public crate — schema-driven ORM for Rust
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
//! **Valence** is a schema-driven ORM for Rust: declare typed tables with
//! [`valence_schema!`], generate [`Model`] CRUD at build time, and wire storage through
//! [`Valence::builder`] without locking into one database.
//!
//! *Typed schemas and models with composable storage adapters.*
//!
//! # Features
//!
//! - **Schema DSL** — fields, connections, policies, ownership, TTL, and trait mixins
//!   ([`valence_schema!`], [`valence_trait_schema!`])
//! - **Table TTL** — declare `ttl: { seconds }` on a schema; call [`Valence::ensure_ttl_for_all`]
//!   once at boot ([`ttl`] module: native Redis/Mongo, Deferred stamp + warn otherwise)
//! - **Build-time codegen** — typed models from host `schemas/` via `valence-codegen`
//! - **Composable backends** — in-memory, SQLite, IndraDB, SurrealDB, Postgres, MongoDB, Redis
//! - **Multi-backend routing** — one [`DatabaseRouter`]; each schema picks a backend with
//!   `database:` / [`DatabaseFromEngine`]
//! - **Host ports** — secrets, actor identity, endpoints, and telemetry injected at boot
//! - **Privacy-aware CRUD** — policy and ownership hooks on generated [`Model`] paths; field
//!   privacy via [`PrivacyEvaluator::filter_entity_fields`] on `Model::get` and query rows
//! - **Queued delete** — `Model::delete` authorizes **Delete** on every **CascadeDelete** DAG node
//!   ([`check_dag_delete_privacy`]) before queueing; Read is not required. `SetNull` / `RemoveEdge`
//!   clear under the requester via deletion-scoped `merge_record` / `unrelate_edge`. Host workers
//!   restore the deleting actor and run schema `side_effects` on physical CascadeDelete.
//! - **Query privacy** — [`QueryCore::execute`] / `Model::query` post-filter rows by entity read
//!   policy and field policies
//! - **Default-deny policies** — schemas without entity `policies:` deny non-System actors
//! - **Query paging clamps** — [`MAX_QUERY_LIMIT`] / [`MAX_QUERY_OFFSET`] on [`QueryCore`]
//! - **Dual-key privacy bypass** — bench/test only: `VALENCE_PRIVACY_BYPASS` +
//!   `VALENCE_PRIVACY_BYPASS_FORCE_ON` (never in production; see repository `SECURITY.md`)
//! - **Actor JSON policy** — optional [`RejectExternalSystemActor`] on factory builds
//!
//! Enable backends with Cargo features (`mem` is the default). The crate `README.md` lists every
//! feature flag and environment variable. See repository [`SECURITY.md`](https://github.com/unified-field-dev/valence/blob/main/SECURITY.md)
//! for integrator wiring.
//!
//! # Topologies
//!
//! Valence is an **in-process** ORM: one host process owns [`Valence`] / [`DatabaseRouter`].
//! There is no coordinator/worker daemon split.
//!
//! ## Embedded (one process)
//!
//! Engine runs in-process (`mem`, `sqlite`, `indradb`, Surreal embedded). No external database
//! required for the canonical path.
//!
//! ## Remote (wire)
//!
//! The host process is a client to an external database (Postgres, MongoDB, Redis, Surreal
//! remote). Start the service, set the URL env var, then run one example process.
//!
//! Runnable catalog: [`examples/README.md`](https://github.com/unified-field-dev/valence/blob/main/examples/README.md)
//! (walkthrough ladder) and crate [`README.md`](https://github.com/unified-field-dev/valence/blob/main/valence/README.md#how-to-run-examples).
//!
//! # Getting started
//!
//! Follow these steps in order. Each linked API page includes details for that task.
//!
//! ## 1. Choose and wire storage
//!
//! | Backend | Type | Feature | Topology | When to use |
//! |---------|------|---------|----------|-------------|
//! | In-memory | [`InMemoryBackend`] | `mem` (default) | [embedded](#embedded-one-process) | Local experiments; tests |
//! | SQLite | [`SqliteBackend`] | `sqlite` | [embedded](#embedded-one-process) | Durable single-host store |
//! | IndraDB | [`IndradbBackend`] | `indradb` | [embedded](#embedded-one-process) | Graph-oriented workloads |
//! | SurrealDB | [`SurrealEmbeddedBackend`] | `surreal` | [embedded](#embedded-one-process) | Surreal engine in-process |
//! | Postgres | [`PostgresBackend`] | `postgres` | [remote](#remote-wire) | Wire Postgres (`DATABASE_URL`) |
//! | MongoDB | [`MongoBackend`] | `mongodb` | [remote](#remote-wire) | Wire Mongo (`VALENCE_MONGODB_URI`) |
//! | Redis | [`RedisBackend`] | `redis` | [remote](#remote-wire) | Wire Redis (`VALENCE_REDIS_URL`) |
//!
//! ### Select a backend in the schema
//!
//! A schema does not contain a backend instance. Its `database:` field points to a stable
//! [`DatabaseFromEngine`] evaluator. The evaluator combines:
//!
//! - a **logical name** (for example `"default"`) that must match
//!   [`ValenceBuilder::add_backend`], and
//! - an **engine ID** exported by the selected adapter.
//!
//! Define `COUNTER_DB` for the backend you enable:
//!
//! | Backend | `COUNTER_DB` declaration |
//! |---------|--------------------------|
//! | In-memory | `Database::from_engine("default", MEM_ENGINE_ID)` |
//! | SQLite | `Database::from_engine("default", SQLITE_ENGINE_ID)` |
//! | IndraDB | `Database::from_engine("default", INDRADB_ENGINE_ID)` |
//! | SurrealDB | `Database::from_engine("default", SURREAL_ENGINE_ID)` |
//! | Postgres | `Database::from_engine("default", POSTGRES_ENGINE_ID)` |
//! | MongoDB | `Database::from_engine("default", MONGODB_ENGINE_ID)` |
//! | Redis | `Database::from_engine("default", REDIS_ENGINE_ID)` |
//!
//! Then use that evaluator in the same Counter schema:
//!
//! ```ignore
//! use valence::{Database, DatabaseFromEngine, FieldType, valence_schema};
//!
//! // Choose the engine constant for the enabled backend.
//! pub const COUNTER_DB: DatabaseFromEngine =
//!     Database::from_engine("default", valence::MEM_ENGINE_ID);
//!
//! valence_schema! {
//!     Counter {
//!         table: "counter",
//!         version: "0.1.0",
//!         description: "Simple counter",
//!         database: COUNTER_DB,
//!         fields: [
//!             id: { r#type: FieldType::String, primary_key: true, required: true },
//!             value: { r#type: FieldType::Integer, required: true },
//!         ],
//!     }
//! }
//! ```
//!
//! Omitting `database:` selects [`DEFAULT_IN_MEMORY`] (`"default"` +
//! [`MEM_ENGINE_ID`]). If that router key is absent, the current runtime falls back to its
//! active/default backend. Declare `database:` explicitly for clear behavior and for any runtime
//! with multiple backends.
//!
//! **In-memory first run:**
//!
//! ```rust
//! # #[cfg(feature = "mem")]
//! use std::sync::Arc;
//! # #[cfg(feature = "mem")]
//! use valence::{
//!     Database, DatabaseFromEngine, FieldType, InMemoryBackend, Valence, MEM_ENGINE_ID,
//!     valence_schema,
//! };
//!
//! # #[cfg(feature = "mem")]
//! const COUNTER_DB: DatabaseFromEngine =
//!     Database::from_engine("default", MEM_ENGINE_ID);
//!
//! # #[cfg(feature = "mem")]
//! valence_schema! {
//!     Counter {
//!         table: "counter",
//!         version: "0.1.0",
//!         database: COUNTER_DB,
//!         fields: [
//!             id: { r#type: FieldType::String, primary_key: true, required: true },
//!             value: { r#type: FieldType::Integer, required: true },
//!         ],
//!     }
//! }
//!
//! # #[cfg(feature = "mem")]
//! # #[tokio::main]
//! # async fn main() -> valence::Result<()> {
//! # #[cfg(feature = "mem")]
//! let valence = Valence::builder()
//!     .add_backend("default", Arc::new(InMemoryBackend::new()))
//!     .build()?;
//! # #[cfg(feature = "mem")]
//! assert_eq!(valence.backend_for_table("counter")?.engine_id(), MEM_ENGINE_ID);
//! # #[cfg(feature = "mem")]
//! # Ok(())
//! # }
//! ```
//!
//! Runnable: `cargo run -p uf-valence --example quickstart --features mem`
//!
//! ## 2. Declare schemas
//!
//! Schemas are the typed contracts Valence registers and (via codegen) turns into models.
//!
//! ```ignore
//! use valence::{
//!     Database, DatabaseFromEngine, FieldType, MEM_ENGINE_ID, valence_schema,
//! };
//!
//! const COUNTER_DB: DatabaseFromEngine =
//!     Database::from_engine("default", MEM_ENGINE_ID);
//!
//! valence_schema! {
//!     Counter {
//!         table: "counter",
//!         version: "0.1.0",
//!         description: "Simple counter",
//!         database: COUNTER_DB,
//!         fields: [
//!             id: { r#type: FieldType::String, primary_key: true, required: true },
//!             value: { r#type: FieldType::Integer, required: true },
//!         ],
//!     }
//! }
//! ```
//!
//! Replace `MEM_ENGINE_ID` with the engine constant from the table in step 1 when the Counter
//! belongs on another backend.
//!
//! See [`valence_schema!`] and [`valence_trait_schema!`] for the DSL field reference.
//! Minimal schema example: workspace [`examples/minimal-schema`](https://github.com/unified-field-dev/valence/blob/main/examples/minimal-schema/).
//! Macros and `valence-codegen` share one syn DSL parser (`valence-schema-dsl`), so
//! host `schemas/*_valence_schema.rs` files accept the same syntax and semantics
//! (including `database:` evaluators).
//!
//! ### Declare and ensure TTL
//!
//! Add `ttl: { seconds: N }` on a table schema (create-only clock). After backends are
//! registered, call [`Valence::ensure_ttl_for_all`] once — it scrapes the schema registry
//! for every TTL table (no hand list). See the [`ttl`] module for capabilities, the reserved
//! [`ttl::EXPIRE_AT_FIELD`], and Deferred/non-native warnings. Hosts wire
//! `valence_platform::ttl_sweep::register_ttl_service` so Deferred engines delete expired rows.
//!
//! ## 3. Set up build-time codegen
//!
//! Typed [`Model`] impls are **generated at compile time** from schema files under
//! `schemas/` (for example `widget_valence_schema.rs`). Add a build dependency and a
//! one-line `build.rs`:
//!
//! ```toml
//! [dependencies]
//! uf-valence = { git = "https://github.com/deathbreakfast/valence", package = "uf-valence", features = ["mem"] }
//!
//! [build-dependencies]
//! uf-valence-codegen = { git = "https://github.com/deathbreakfast/valence", package = "uf-valence-codegen" }
//! ```
//!
//! ```ignore
//! // build.rs
//! fn main() {
//!     valence_codegen::build().expect("valence codegen failed");
//! }
//! ```
//!
//! Include generated models (this is what must be linked for typed CRUD and inventory):
//!
//! ```ignore
//! valence::include_generated_models!();
//! ```
//!
//! Schema files under `schemas/` are **scan inputs** for codegen; they are not
//! `mod`-linked. End-to-end proof: workspace [`examples/codegen-host`](https://github.com/unified-field-dev/valence/blob/main/examples/codegen-host/) and
//! [`examples/product-model-host`](https://github.com/unified-field-dev/valence/blob/main/examples/product-model-host/). See the
//! [valence-codegen](../valence_codegen/index.html) crate docs for custom roots via
//! `build_with` / `CodegenConfig`.
//!
//! ## 4. Use generated models (CRUD)
//!
//! After codegen, call [`Model`] methods with a [`Valence`] runtime:
//!
//! ```ignore
//! use valence::Model;
//!
//! // Widget is generated from schemas/widget_valence_schema.rs
//! let created = Widget::create(widget, &valence).await?;
//! let loaded = Widget::get(created.id(), &valence).await?;
//! Widget::update(created.id(), updated, &valence).await?;
//! Widget::delete(created.id(), &valence).await?;
//! ```
//!
//! Product-shaped schemas and connections: [`examples/product-model-host`](https://github.com/unified-field-dev/valence/blob/main/examples/product-model-host/).
//!
//! ## 5. Route multiple backends
//!
//! One [`Valence`] holds a heterogeneous [`DatabaseRouter`]. Schema `database:` evaluators
//! pick the router key per table.
//!
//! ```rust,no_run
//! # #[cfg(feature = "mem")]
//! # async fn demo() -> valence::Result<()> {
//! use std::sync::Arc;
//! use valence::{InMemoryBackend, Valence, router_key, MEM_ENGINE_ID};
//!
//! let primary = router_key("primary", MEM_ENGINE_ID);
//! let valence = Valence::builder()
//!     .add_backend("primary", Arc::new(InMemoryBackend::new()))
//!     .add_backend("archive", Arc::new(InMemoryBackend::new()))
//!     .default_backend_key(primary)
//!     .build()?;
//! # let _ = valence;
//! # Ok(())
//! # }
//! ```
//!
//! Runnable: `cargo run -p uf-valence --example multi_backend --features mem`
//!
//! Heterogeneous engines (mem Project ↔ sqlite Task) with hop + query:
//! `cargo run -p cross-backend-model-host`. Walkthrough: [`examples/README.md`](https://github.com/unified-field-dev/valence/blob/main/examples/README.md).
//!
//! ## 6. Inject host ports
//!
//! Optional builder methods wire secrets, actor identity, endpoints, and telemetry:
//! [`ValenceBuilder::secret_provider`], [`ValenceBuilder::actor_factory`],
//! [`ValenceBuilder::endpoint_resolver`], [`ValenceBuilder::telemetry_sink`].
//!
//! Port table and reference impls: [`valence_core::ports`]. Storage adapter contract and
//! third-party checklist: [`DatabaseBackend`]. Router semantics: [`DatabaseRouter`].
//!
//! ```rust
//! # #[cfg(feature = "mem")]
//! # fn demo() -> valence::Result<()> {
//! use std::sync::Arc;
//! use valence::{
//!     ConsoleSink, EnvSecretProvider, InMemoryBackend, JsonActorFactory, NoopEndpointResolver,
//!     Valence,
//! };
//!
//! let _valence = Valence::builder()
//!     .add_backend("default", Arc::new(InMemoryBackend::new()))
//!     .secret_provider(Arc::new(EnvSecretProvider))
//!     .actor_factory(Arc::new(JsonActorFactory))
//!     .endpoint_resolver(Arc::new(NoopEndpointResolver))
//!     .telemetry_sink(Arc::new(ConsoleSink))
//!     .build()?;
//! # Ok(())
//! # }
//! ```
//!
//! ## How the pieces link together
//!
//! ```text
//! schemas/*.rs ──► build.rs (valence_codegen::build) ──► $OUT_DIR/generated_models.rs
//!   (scan inputs)                                              │
//!                                                              │ include_generated_models!
//!//!                                              impl Model + inventory submit
//!//!                              SchemaRegistry ◄────────────────┤
//!//!                                              typed CRUD on Valence
//!//!                              Valence runtime ◄── DatabaseRouter / backends
//! ```
//!
//! **Dependency rules:** `valence-core` owns ports and runtime (no engine SDK);
//! `valence-backend-*` advertise open `ENGINE_ID`s; the public crate re-exports behind features;
//! apps own schema roots and call `valence-codegen` from `build.rs`; one operation stays on
//! one backend; host adapters inject at boot.
//!
//! # Next steps
//!
//! | Task | Start here |
//! |------|------------|
//! | **Example walkthrough** | [`examples/README.md`](https://github.com/unified-field-dev/valence/blob/main/examples/README.md) |
//! | Schema DSL fields | [`valence_schema!`], [`valence_trait_schema!`] |
//! | Build-time codegen | [valence-codegen](../valence_codegen/index.html), [`examples/codegen-host`](https://github.com/unified-field-dev/valence/blob/main/examples/codegen-host/) |
//! | Wire storage | [`Valence::builder()`], [`InMemoryBackend`] |
//! | Model CRUD | [`Model`], [`examples/product-model-host`](https://github.com/unified-field-dev/valence/blob/main/examples/product-model-host/) |
//! | Multi-backend routing | [`DatabaseRouter`], `multi_backend` example |
//! | Cross-backend hop + query | [`examples/cross-backend-model-host`](https://github.com/unified-field-dev/valence/blob/main/examples/cross-backend-model-host/) |
//! | Hybrid multi-logical | `hybrid_multi_logical` example (`hybrid,mem`) |
//! | Custom adapter | [`DatabaseBackend`], [`examples/acme-valence-backend-stub`](https://github.com/unified-field-dev/valence/blob/main/examples/acme-valence-backend-stub/) |
//! | Surreal inventory bootstrap | [`examples/embedded-bootstrap`](https://github.com/unified-field-dev/valence/blob/main/examples/embedded-bootstrap/) |
//! | SQLite | [`SqliteBackend`], `quickstart_sqlite` example |
//! | IndraDB | [`IndradbBackend`], `quickstart_indradb` example |
//! | Surreal embedded | [`SurrealEmbeddedBackend`], `surreal_embedded` example |
//! | Postgres | [`PostgresBackend`], `quickstart_postgres` (env-gated) |
//! | MongoDB | [`MongoBackend`], `quickstart_mongodb` (env-gated) |
//! | Redis | [`RedisBackend`], `quickstart_redis` (env-gated) |
//! | Admin runtime | [`SchemaRegistry`], [`QueryCore`], [`examples/admin-runtime-host`](https://github.com/unified-field-dev/valence/blob/main/examples/admin-runtime-host/) |
//! | Config / env vars | crate [`README.md`](README.md) |
//! | How to run examples | [`examples/README.md`](https://github.com/unified-field-dev/valence/blob/main/examples/README.md) |
//!
//! # Entry points
//!
//! - [`prelude`] — ergonomic schema authoring imports
//! - [`Valence`] / [`ValenceBuilder`] — runtime assembly
//! - [`valence_schema!`] — schema DSL macro
//! - [`Model`] — generated CRUD surface
//! - [`DatabaseBackend`] / [`DatabaseRouter`] — storage ports
//!
//! # Prerequisites and gotchas
//!
//! - Enable backend features explicitly (`mem` is on by default).
//! - Product schemas and codegen roots belong in **your** application.
//! - Wire adapters (postgres/mongodb/redis) need live URLs; examples skip cleanly when unset.
//! - SurrealDB support lives in `valence-backend-surreal` (feature `surreal`), not in core ports.
//! - Generated models (or macro-expanded schemas) must be linked into the binary or
//!   `inventory` will not see them.
//!
//! # Runnable examples
//!
//! **Walkthrough ladder:** [`examples/README.md`](https://github.com/unified-field-dev/valence/blob/main/examples/README.md)
//! — quickstarts, workspace hosts, and testkit hop fixtures in order.
//!
//! Canonical path (see crate README **How to run examples**):
//!
//! ```bash
//! cargo run -p uf-valence --example quickstart --features mem
//! cargo run -p uf-valence --example quickstart_sqlite --features sqlite
//! cargo run -p uf-valence --example multi_backend --features mem
//! cargo test -p codegen-host
//! cargo run -p cross-backend-model-host
//! ```
//!
//! | Example | Features | Notes |
//! |---------|----------|-------|
//! | `quickstart` | `mem` | Schema + mem boot + registry proof |
//! | `quickstart_sqlite` | `sqlite` | Embedded SQLite |
//! | `multi_backend` | `mem` | Multiple logical backends |
//! | `hybrid_multi_logical` | `hybrid,mem` | Hybrid primary, several logical names |
//! | `surreal_embedded` | `surreal` | Surreal mem engine |
//! | `quickstart_indradb` | `indradb` | Embedded IndraDB |
//! | `quickstart_postgres` | `postgres` | Requires `DATABASE_URL` |
//! | `quickstart_mongodb` | `mongodb` | Requires `VALENCE_MONGODB_URI` |
//! | `quickstart_redis` | `redis` | Requires `VALENCE_REDIS_URL` |
//! | `quickstart_telemetry` | `mem,telemetry-console` | Console telemetry sink |
//!
//! Workspace hosts (see [`examples/README.md`](https://github.com/unified-field-dev/valence/blob/main/examples/README.md)):
//! `minimal-schema`, `codegen-host`, `product-model-host`, `cross-backend-model-host`,
//! `admin-runtime-host`, `embedded-bootstrap`, `acme-valence-backend-stub`.
//! Hop crates (`hop-pair-model-host`, `hop-chain-model-host`) are testkit/matrix fixtures only.

extern crate self as valence;

mod include_generated;

/// Table-level TTL policy, stamp helpers, and ensure entry points.
pub use valence_core::ttl;
pub use valence_core::*;
pub use valence_macros::*;

#[cfg(feature = "telemetry-console")]
pub use valence_telemetry::*;

#[cfg(feature = "mem")]
pub use valence_backend_mem::{
    install_default_mem_router, InMemoryBackend, ENGINE_ID as MEM_ENGINE_ID,
};

#[cfg(feature = "sqlite")]
pub use valence_backend_sqlite::{
    SqliteBackend, ENGINE_ID as SQLITE_ENGINE_ID, PRIMARY as SQLITE_PRIMARY,
};

#[cfg(feature = "postgres")]
pub use valence_backend_postgres::{
    PostgresBackend, ENGINE_ID as POSTGRES_ENGINE_ID, PRIMARY as POSTGRES_PRIMARY,
};

#[cfg(feature = "mongodb")]
pub use valence_backend_mongodb::{
    MongoBackend, ENGINE_ID as MONGODB_ENGINE_ID, PRIMARY as MONGODB_PRIMARY,
};

#[cfg(feature = "indradb")]
pub use valence_backend_indradb::{
    IndradbBackend, ENGINE_ID as INDRADB_ENGINE_ID, PRIMARY as INDRADB_PRIMARY,
};

#[cfg(feature = "hybrid")]
pub use valence_backend_hybrid::{
    CachePolicy, CacheRules, HybridBackend, HybridBackendBuilder, ENGINE_ID as HYBRID_ENGINE_ID,
    PRIMARY as HYBRID_PRIMARY,
};

#[cfg(feature = "redis")]
pub use valence_backend_redis::{
    RedisBackend, ENGINE_ID as REDIS_ENGINE_ID, PRIMARY as REDIS_PRIMARY,
};

#[cfg(feature = "surreal")]
pub use valence_backend_surreal::{
    bootstrap_embedded_router, connect_embedded_at_path, extract_id_from_record_display,
    extract_id_from_select_value, register_embedded_logical_names,
    register_embedded_logical_names_slices, shared_router_with_embedded_logical_names,
    surreal_record_id_for, EmbeddedEngine, RegisterEmbeddedLogicalNamesOptions, SDb,
    SurrealEmbeddedBackend, SurrealMemBackend, ENGINE_ID as SURREAL_ENGINE_ID,
};

#[cfg(all(feature = "surreal", feature = "surreal-inventory"))]
pub use valence_backend_surreal::{
    bootstrap_embedded_router_from_inventory, collect_distinct_embedded_surreal_logical_names,
    register_embedded_logical_names_from_inventory, DEFAULT_EMBEDDED_SURREAL_LOGICAL_NAMES,
};

#[cfg(all(feature = "surreal", feature = "surreal-connect-env"))]
pub use valence_backend_surreal::{
    connect_embedded_from_env, database_from_env, embedded_engine_from_env, embedded_path_from_env,
    namespace_from_env,
};

#[cfg(all(feature = "surreal", feature = "surreal-remote"))]
pub use valence_backend_surreal::SurrealRemoteBackend;

/// Hidden re-exports for generated model code and platform migrations.
#[doc(hidden)]
pub mod __internal {
    pub use valence_core::__internal::{CompiledQuery, QueryCompiler};
}

/// Ergonomic imports for schema authoring and generated models.
pub mod prelude {
    pub use crate::{
        valence_schema, valence_trait_schema, Cardinality, Currency, CurrencyCode, Database,
        DatabaseEvaluator, DatabaseFromEngine, FieldChange, FieldOperation, FieldType, IdHolder,
        JsonAsSerdeError, Model, Mutation, MutationKind, OnDelete, RecordId, Reference, Role,
        SideEffect, Validator, WithReference, DEFAULT_IN_MEMORY, DEFAULT_IN_MEMORY_ROUTER_KEY,
    };
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::Arc;

    #[test]
    fn public_crate_reexports_core() {
        let _ = router_key("default", KnownEngines::INMEMORY_MEM);
    }

    #[cfg(feature = "mem")]
    #[tokio::test]
    async fn mem_feature_wires_backend() {
        let valence = Valence::builder()
            .add_backend("default", Arc::new(InMemoryBackend::new()))
            .build()
            .expect("build");
        assert_eq!(valence.active_backend().unwrap().engine_id(), MEM_ENGINE_ID);
    }

    #[cfg(feature = "surreal")]
    #[tokio::test]
    async fn surreal_feature_wires_backend() {
        use surrealdb::engine::local::Mem;

        let db = valence_backend_surreal::SDb::init();
        db.connect::<Mem>(()).await.expect("connect");
        db.use_ns("test").use_db("test").await.expect("ns");
        let valence = Valence::builder()
            .add_backend("default", Arc::new(SurrealEmbeddedBackend::new(db)))
            .build()
            .expect("build");
        assert_eq!(
            valence.active_backend().unwrap().engine_id(),
            SURREAL_ENGINE_ID
        );
    }
}