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

//! Website routing from database-backed page records.
//!
//! Maps URL paths to filesystem VNodes, renders minijinja/HTML pages,
//! and provides a GrapesJS visual builder for `.html`/`.htm`/`.tmpl` files.
//!
//! # Dynamic views security note
//!
//! Dynamic views cannot serve arbitrary files under a directory — that would allow arbitrary
//! read access via templates and the virtual filesystem.
//!
//! # Configurations
//!
//! - `[website]` → [`config::WebsiteConfig`]: `newPageRootDir` (blank page parent path),
//!   `assetsDir` (GrapesJS uploads; defaults to `{newPageRootDir}/assets`).
//!
//! # Database models
//!
//! - [`entities::DbRoute`]: active URL path → page VNode mapping; optional GrapesJS project JSON
//!   and theme registry key.
//! - [`entities::WebsitePreferences`]: singleton Custom theme CSS/JS VNode ids.
//!
//! # Templates and builder
//!
//! - Public catch-all [`handlers::dynamic`] and admin route CRUD ([`handlers::routes`], [`handlers::builder`]).
//! - GrapesJS blocks, components, traits, and themes registered via [`grapesjs::Hook`].
//! - Preferences for Custom theme CSS/JS ([`handlers::preferences`]).
//!
//! # Routes
//!
//! - `/{path...}` — dynamic catch-all (patches home route)
//! - `/website/`, `/website/create/`, `/website/{id}/`, edit/delete
//! - `/website/preferences/` — Custom theme CSS/JS files
//! - `/website/{id}/builder/`, `/website/{id}/builder/project/`, `/website/{id}/builder/theme/`
//! - `/website/builder/assets/` — GrapesJS AssetManager upload
//! - `/media/{id}/` — public asset stream

pub mod apps;
pub mod builder;
pub mod builder_assets;
pub mod builder_refs;
pub mod component_catalog;
pub mod config;
pub mod dotlottie;
pub mod entities;
pub mod forms;
pub mod grapesjs;
pub mod handlers;
pub mod html_edit;
pub mod keys;
pub mod match_route;
pub mod migrations;
pub mod preferences;
pub mod publish;
pub mod render;
pub mod routes;
pub mod state;
pub mod template_funcs;
pub mod templates;
pub mod theme;

use std::sync::Arc;

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

use crate::plugin_install::define_plugin_install;
use crate::{
    app::App,
    capability::{CapStore, define_passthrough_cap},
    config::{ConfigCap, ConfigTag},
    db::{DbCap, DbTag},
    hooks::AttachState,
    plugins::filesystem::{
        config::{FilesystemConfig, FilesystemConfigTag},
        storage::{DynFilestore, filestore_from_config},
    },
    traits::{
        add::{AddCapability, CapTagAbsent},
        get::{GetByCapTag, GetByTag},
    },
};

use config::{WebsiteConfig, WebsiteConfigTag};
use state::WebsiteState;

/// Capability tag for the website plugin state.
pub struct WebsiteTag;

define_passthrough_cap!(WebsiteStateCap, WebsiteTag, WebsiteState);

define_plugin_install! {
    plugin: WebsiteTag;
    /// Register website deferred hooks (apps, grapesjs, migrations, templates, slots, config, routes, state).
    steps: [
        apps(apps::Hook),
        grapesjs(grapesjs::Hook),
        migrations(migrations::Hook),
        templates(templates::Hook),
        slots(templates::SlotsHook),
        config(WebsiteConfigTag, WebsiteConfig),
        http(routes::Hook),
        state(StateHook),
    ]
}

/// Attaches [`WebsiteState`] (DB, filestore, website config) at app mount.
#[derive(Clone, Copy, Default)]
pub struct StateHook;

impl<L, DbIdx, CfgIdx, Configs, FsCfgIdx, WsCfgIdx, TagProof>
    AttachState<L, (DbIdx, CfgIdx, Configs, FsCfgIdx, WsCfgIdx, TagProof)> for StateHook
where
    L: GetByCapTag<DbTag, DbIdx, Value = DbCap>,
    L: GetByCapTag<ConfigTag, CfgIdx, Value = ConfigCap<HNil, Configs>>,
    Configs: GetByTag<FilesystemConfigTag, FsCfgIdx, Value = FilesystemConfig>,
    Configs: GetByTag<WebsiteConfigTag, WsCfgIdx, Value = WebsiteConfig>,
    L: HList + CapTagAbsent<WebsiteTag, TagProof>,
{
    type Output = HCons<WebsiteStateCap, L>;

    fn attach_state(app: App<L>) -> App<Self::Output> {
        let conn = app.get_capability::<DbTag, DbIdx>().items.conn.clone();
        let configs = &app.get_capability::<ConfigTag, CfgIdx>().items;
        let fs_config =
            <Configs as GetByTag<FilesystemConfigTag, FsCfgIdx>>::get_by_tag(configs).clone();
        let website_config =
            <Configs as GetByTag<WebsiteConfigTag, WsCfgIdx>>::get_by_tag(configs).clone();
        let store: Arc<DynFilestore> = filestore_from_config(&fs_config);
        app.add_capability(CapStore::with_items(WebsiteState::new(
            conn,
            store,
            website_config,
        )))
    }
}