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

//! One-time password (OTP) delivery and verification.
//!
//! Integrates SMS (MSG91) and SMTP email to send six-digit OTP codes for
//! password recovery and multi-factor auth flows.
//!
//! # Database models
//!
//! - In-memory OTP cache ([`otp::MemoryCache`]) for pending codes.
//! - [`entities::OtpPreferences`]: singleton SMTP and MSG91 configuration.
//!
//! # Templates
//!
//! Forgot-password choice page, SMS/email request forms, verify form, and admin preferences
//! panel (see [`templates`]).
//!
//! # Routes
//!
//! - `/users/login` — login form with "Forgot password?" (overrides users)
//! - `/otp/forgot-password/` — SMS vs email recovery choice
//! - `/otp/login/sms/`, `/otp/login/email/` — send OTP codes
//! - `/otp/verify/` — verify code and reset password
//! - `/otp/preferences/` — admin SMTP/gateway settings
//!
//! # Patches applied
//!
//! - `/users/login` — OTP re-registers this path so the login page includes
//!   "Forgot password?" without requiring the signup plugin. Install signup
//!   *after* OTP if you also want a sign-up CTA (signup then wins the path).

pub mod adapters;
pub mod apps;
pub mod entities;
pub mod error;
pub mod export;
pub mod forms;
pub mod handlers;
pub mod keys;
pub mod migrations;
pub mod otp;
pub mod preferences;
pub mod routes;
pub mod state;
pub mod templates;

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

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

use state::OtpState;

/// Capability tag for the OTP plugin state.
pub struct OtpTag;

define_passthrough_cap!(OtpStateCap, OtpTag, OtpState);

define_plugin_install! {
    plugin: OtpTag;
    /// Register OTP deferred hooks (apps, migrations, templates, slots, routes, state).
    steps: [
        apps(apps::Hook),
        export(export::ExportHook),
        migrations(migrations::Hook),
        templates(templates::Hook, LoginIdx),
        slots(templates::SlotsHook),
        http(routes::Hook),
        state(StateHook),
    ]
}

/// Attaches [`OtpState`] (DB connection) at app mount.
#[derive(Clone, Copy, Default)]
pub struct StateHook;

impl<L, DbIdx, TagProof> AttachState<L, (DbIdx, TagProof)> for StateHook
where
    L: GetByCapTag<DbTag, DbIdx, Value = DbCap>,
    L: HList + CapTagAbsent<OtpTag, TagProof>,
{
    type Output = HCons<OtpStateCap, L>;

    fn attach_state(app: App<L>) -> App<Self::Output> {
        let conn = app.get_capability::<DbTag, DbIdx>().items.conn.clone();
        app.add_capability(CapStore::with_items(OtpState::new(conn)))
    }
}