this-rs 0.0.9

Framework for building complex multi-entity REST and GraphQL APIs with many relationships
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

//! # this-rs Framework
//!
//! A generic entity and relationship management framework for building RESTful APIs in Rust.
//!
//! ## Features
//!
//! - **Entity/Data/Link Architecture**: Clean hierarchy with macro-based implementation
//! - **Flexible Relationships**: Support multiple link types between entities
//! - **Bidirectional Navigation**: Query relationships from both directions
//! - **Auto-Pluralization**: Intelligent plural forms (company → companies)
//! - **Configuration-Based**: Define relationships via YAML configuration
//! - **Type-Safe**: Leverage Rust's type system for compile-time guarantees
//! - **Soft Delete Support**: Built-in soft deletion with deleted_at
//! - **Automatic Timestamps**: created_at and updated_at managed automatically
//!
//! ## Quick Start
//!
//! ```rust,ignore
//! use this::prelude::*;
//!
//! // Define a Data entity (extends Entity base)
//! impl_data_entity!(
//!     User,
//!     "user",
//!     ["name", "email"],
//!     {
//!         email: String,
//!         password_hash: String,
//!     }
//! );
//!
//! // Define a Link entity (extends Entity base)
//! impl_link_entity!(
//!     UserCompanyLink,
//!     "user_company_link",
//!     {
//!         role: String,
//!         start_date: DateTime<Utc>,
//!     }
//! );
//!
//! // Usage
//! let user = User::new(
//!     "John Doe".to_string(),
//!     "active".to_string(),
//!     "john@example.com".to_string(),
//!     "$argon2$...".to_string(),
//! );
//!
//! user.soft_delete(); // Soft delete support
//! user.restore();     // Restore support
//! ```

pub mod config;
pub mod core;
pub mod entities;
pub mod events;
pub mod links;
pub mod server;
pub mod storage;

/// Re-exports of commonly used types and traits
pub mod prelude {
    // === Core Traits ===
    pub use crate::core::{
        auth::{AuthContext, AuthPolicy, AuthProvider, NoAuthProvider},
        entity::{Data, Entity, Link},
        field::{FieldFormat, FieldValue},
        link::{LinkAuthConfig, LinkDefinition, LinkEntity},
        module::{EntityCreator, EntityFetcher, Module},
        pluralize::Pluralizer,
        query::{PaginatedResponse, PaginationMeta, QueryParams},
        service::{DataService, LinkService},
        store::QueryableStore,
        validation::{EntityValidationConfig, Validated},
    };

    // === Macros ===
    pub use crate::{
        add_filters_for_field, add_validators_for_field, data_fields, entity_fields,
        impl_data_entity, impl_data_entity_validated, impl_link_entity, link_fields,
    };

    // === Link Handlers ===
    pub use crate::links::{
        handlers::{
            AppState, create_link, delete_link, get_link, list_available_links, list_links,
            update_link,
        },
        registry::{LinkDirection, LinkRouteRegistry, RouteInfo},
    };

    // === Storage ===
    #[cfg(feature = "dynamodb")]
    pub use crate::storage::{DynamoDBDataService, DynamoDBLinkService};
    pub use crate::storage::{InMemoryDataService, InMemoryLinkService};
    #[cfg(feature = "lmdb")]
    pub use crate::storage::{LmdbDataService, LmdbLinkService};
    #[cfg(feature = "mongodb_backend")]
    pub use crate::storage::{MongoDataService, MongoLinkService};
    #[cfg(feature = "mysql")]
    pub use crate::storage::{MysqlDataService, MysqlLinkService};
    #[cfg(feature = "neo4j")]
    pub use crate::storage::{Neo4jDataService, Neo4jLinkService};
    #[cfg(feature = "postgres")]
    pub use crate::storage::{PostgresDataService, PostgresLinkService};
    #[cfg(feature = "scylladb")]
    pub use crate::storage::{ScyllaDataService, ScyllaLinkService};

    // === Config ===
    pub use crate::config::{
        EntityAuthConfig, EntityConfig, EventsConfig, LinksConfig, SinkConfig, SinkType,
        ValidationRule,
    };

    // === Server ===
    pub use crate::server::{EntityDescriptor, EntityRegistry, ServerBuilder};

    // === External dependencies ===
    pub use anyhow::Result;
    pub use async_trait::async_trait;
    pub use chrono::{DateTime, Utc};
    pub use serde::{Deserialize, Serialize};
    pub use uuid::Uuid;

    // === Axum ===
    pub use axum::{
        Router,
        extract::{Path, State},
        http::HeaderMap,
        routing::{delete, get, post, put},
    };
}