lariv-rs 0.1.0

Compile-time plugin web application framework built on Axum, SeaORM, Maud, and HTMX
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

//! User administration and authentication for Lariv.
//!
//! Manages users, roles, password hashes, session authentication, and route authorization.
//!
//! # Configurations
//!
//! - `[users]` → [`config::UsersConfig`]: signing key, JWT issuer, initial admin email/password,
//!   and staff roles for user-management routes.
//!
//! # Database models
//!
//! - [`entities::User`]: system users (password hash, email, phone, role reference).
//! - [`entities::Role`]: access control roles (unassigned, superuser, admin, …).
//!
//! # Global layers and middleware
//!
//! - [`layers::AuthLayer`]: validates `auth-token` session cookies; injects authenticated user into context.
//! - [`layers::RoleLayer`]: restricts downstream views by role membership.
//! - [`middleware::RequireAuth`], [`middleware::RequireStaff`]: Axum extractors wrapping the same logic.
//!
//! # Templates
//!
//! Login, logout, user/role CRUD, self-profile, and change-password pages (see [`templates`]).
//!
//! # Routes
//!
//! - `/users/login`, `/users/logout`, `/users/unauthenticated`, `/users/success`
//! - `/users/self`, `/users/self/edit`, `/users/self/change-password`
//! - `/users`, `/users/create`, `/users/u/{id}`, edit/delete/change-password variants
//! - `/users/roles`, `/users/roles/create`, `/users/roles/{id}`, edit/delete variants
//!
//! # CLI commands
//!
//! - `createsuperuser` — manually create a superuser account
//! - `changepassword` — change a user's password by email
//! - `revalidate_users` — normalize user email and phone formats

pub mod apps;
pub mod auth;
pub mod cli;
pub mod config;
pub mod create_modals;
pub mod entities;
pub mod error;
pub mod export;
pub mod forms;
pub mod handlers;
pub mod jwt;
pub mod keys;
pub mod layers;
pub mod middleware;
pub mod migrations;
pub mod null_text;
pub mod password;
pub mod phone;
pub mod routes;
pub mod seed;
pub mod session;
pub mod state;
pub mod templates;

#[cfg(test)]
mod tests;

use frunk::{HCons, HNil, hlist::HList};

use crate::plugin_install::define_plugin_install;
use crate::{
    app::{App, MountedApp},
    capability::{CapStore, define_passthrough_cap},
    config::{ConfigCap, ConfigTag},
    db::{DbCap, DbTag},
    hooks::{AttachState, RunSeed},
    traits::{
        add::{AddCapability, CapTagAbsent},
        get::{GetByCapTag, GetByTag},
    },
};

use config::{UsersConfig, UsersConfigTag};
use state::UsersState;

/// Capability tag for the users plugin state.
pub struct UsersTag;

define_passthrough_cap!(UsersStateCap, UsersTag, UsersState);

define_plugin_install! {
    plugin: UsersTag;
    /// Register users deferred hooks and config section.
    steps: [
        apps(apps::Hook),
        export(export::ExportHook),
        migrations(migrations::Hook),
        templates(templates::Hook),
        slots(templates::SlotsHook),
        config(UsersConfigTag, UsersConfig),
        http(routes::Hook),
        state(StateHook),
        seeds(SeedsHook),
        commands(cli::Hook),
    ]
}

/// Attaches [`UsersState`] (DB connection + resolved signing keys) at app mount.
#[derive(Clone, Copy, Default)]
pub struct StateHook;

impl<L, DbIdx, CfgIdx, Configs, UsersCfgIdx, TagProof>
    AttachState<L, (DbIdx, CfgIdx, Configs, UsersCfgIdx, TagProof)> for StateHook
where
    L: GetByCapTag<DbTag, DbIdx, Value = DbCap>,
    L: GetByCapTag<ConfigTag, CfgIdx, Value = ConfigCap<HNil, Configs>>,
    Configs: GetByTag<UsersConfigTag, UsersCfgIdx, Value = UsersConfig>,
    L: HList + CapTagAbsent<UsersTag, TagProof>,
{
    type Output = HCons<UsersStateCap, L>;

    fn attach_state(app: App<L>) -> App<Self::Output> {
        let conn = app.get_capability::<DbTag, DbIdx>().items.conn.clone();
        let config = <Configs as GetByTag<UsersConfigTag, UsersCfgIdx>>::get_by_tag(
            &app.get_capability::<ConfigTag, CfgIdx>().items,
        )
        .clone();
        app.add_capability(CapStore::with_items(UsersState::new(conn, config)))
    }
}

/// Seeds default roles and the configured admin user after mount.
#[derive(Clone, Copy, Default)]
pub struct SeedsHook;

#[async_trait::async_trait]
impl<M, UsersIdx> RunSeed<M, UsersIdx> for SeedsHook
where
    M: GetByTag<UsersTag, UsersIdx, Value = UsersState> + Sync,
{
    async fn run_seed(app: &MountedApp<M>) -> anyhow::Result<()> {
        seed::seed(app.get_capability_output::<UsersTag, UsersIdx>()).await?;
        Ok(())
    }
}