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

//! Progressive Web App manifest, service worker, and offline support.
//!
//! Injects web manifest links into the global HTML shell head and serves
//! static PWA resource routes.
//!
//! # Configurations
//!
//! - `[pwa]` → [`config::PwaConfig`]: app name, theme color, icons, shortcuts, static asset
//!   directories, service worker path, and optional offline view name.
//!
//! # Shell head snippets
//!
//! - Manifest `<link rel="manifest">` injected via [`slots::SlotsHook`].
//! - Document title patched from `PWA_APP_NAME` in [`StateHook`].
//!
//! # Routes
//!
//! - `/app.webmanifest` — JSON manifest from config
//! - `/serviceworker.js` — custom or default caching/offline service worker
//! - `/offline` — offline fallback page
//! - `/static/pwa/{*path}` — static PWA assets from `StaticDir`
//! - `/.well-known/assetlinks.json` — Android Digital Asset Links
//!
//! Set `offlineViewName` to a key on [`crate::views::ViewRegistry`] to serve a custom offline handler.

pub mod config;
pub mod handlers;
pub mod routes;
pub mod slots;

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

use crate::plugin_install::define_plugin_install;
use crate::{
    app::App,
    capability::{CapStore, define_passthrough_cap},
    components::set_document_title,
    config::{ConfigCap, ConfigTag},
    hooks::AttachState,
    traits::{
        add::{AddCapability, CapTagAbsent},
        get::{GetByCapTag, GetByTag},
    },
};

use config::{PwaConfig, PwaConfigTag};

/// Capability tag for the PWA plugin (runtime config clone for [`crate::http::Cap`] extraction).
pub struct PwaTag;

define_passthrough_cap!(PwaStateCap, PwaTag, PwaConfig);

define_plugin_install! {
    plugin: PwaTag;
    /// Register PWA config, head slot, and deferred route/state hooks.
    steps: [
        templates(slots::Hook),
        slots(slots::SlotsHook),
        config(PwaConfigTag, PwaConfig),
        http(routes::Hook),
        state(StateHook),
    ]
}

/// Copies loaded `[pwa]` config onto [`PwaTag`] and applies the patch.
#[derive(Clone, Copy, Default)]
pub struct StateHook;

impl<L, CfgIdx, Configs, PwaCfgIdx, TagProof> AttachState<L, (CfgIdx, Configs, PwaCfgIdx, TagProof)>
    for StateHook
where
    L: GetByCapTag<ConfigTag, CfgIdx, Value = ConfigCap<HNil, Configs>>,
    Configs: GetByTag<PwaConfigTag, PwaCfgIdx, Value = PwaConfig>,
    L: HList + CapTagAbsent<PwaTag, TagProof>,
{
    type Output = HCons<PwaStateCap, L>;

    fn attach_state(app: App<L>) -> App<Self::Output> {
        let config = <Configs as GetByTag<PwaConfigTag, PwaCfgIdx>>::get_by_tag(
            &app.get_capability::<ConfigTag, CfgIdx>().items,
        )
        .clone();
        if !config.app_name.is_empty() {
            set_document_title(config.app_name.clone());
        }
        app.add_capability(CapStore::with_items(config))
    }
}