tauri-plugin-persistence 0.1.1

A wrapper plugin for several persistence backends, focused on managing complex project folders with less boilerplate.
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

//! High-level abstractions for project contexts & database access for Tauri applications.
//! 
//! Primary features:
//! - Database creation & management with PoloDB
//! - Management of open file handles
//! - Basic filesystem operations within the context
//! - Automatic prevention of context escapes


use std::collections::HashMap;
use tauri::{
    plugin::{Builder, TauriPlugin},
    Manager, Runtime,
};

mod api;
mod commands;
#[cfg(desktop)]
mod desktop;

pub use api::{Collection, Context, Database, Error, FileHandle, Result, Transaction, types};
pub(crate) use api::state;

#[cfg(desktop)]
pub use desktop::Persistence;
use tauri_specta::collect_commands;
use tokio::sync::Mutex;

/// Extensions to [`tauri::App`], [`tauri::AppHandle`] and [`tauri::Window`] to access the persistence APIs.
pub trait PersistenceExt<R: Runtime> {
    /// Gets a reference to the [Persistence] API
    fn persistence(&self) -> &Persistence<R>;
}

impl<R: Runtime, T: Manager<R>> crate::PersistenceExt<R> for T {
    fn persistence(&self) -> &Persistence<R> {
        self.state::<Persistence<R>>().inner()
    }
}

#[doc(hidden)]
fn builder() -> tauri_specta::Builder<tauri::Wry> {
    tauri_specta::Builder::<tauri::Wry>::new()
    .plugin_name("persistence")
    .commands(collect_commands![
        commands::context,
        commands::database,
        commands::file_handle,
        commands::database_get_collections,
        commands::database_close,
        commands::database_start_transaction,
        commands::database_commit_transaction,
        commands::database_rollback_transaction,
        commands::collection_count_documents,
        commands::collection_update_documents,
        commands::collection_delete_documents,
        commands::collection_create_index,
        commands::collection_drop_index,
        commands::collection_drop,
        commands::collection_insert_documents,
        commands::collection_find_many_documents,
        commands::collection_find_one_document,
        commands::file_close,
        commands::file_write_text,
        commands::file_write_bytes,
        commands::file_read_text,
        commands::file_read_bytes,
        commands::get_context_base_path,
        commands::get_absolute_path_to,
        commands::create_directory,
        commands::remove_directory,
        commands::remove_file,
        commands::file_metadata,
        commands::list_directory
    ])
}

/// Initializes the plugin.
pub fn init() -> TauriPlugin<tauri::Wry> {
    let builder = builder();

    Builder::new("persistence")
        .invoke_handler(builder.invoke_handler())
        .setup(move |app, api| {
            #[cfg(desktop)]
            let persistence = desktop::init(app, api)?;
            app.manage(persistence);
            app.manage::<state::PluginState>(Mutex::new(HashMap::new()));
            builder.mount_events(app);
            Ok(())
        })
        .build()
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn export_types() {
        builder()
            .export(
                specta_typescript::Typescript::default()
                    .formatter(specta_typescript::formatter::prettier)
                    .bigint(specta_typescript::BigIntExportBehavior::Number),
                "./guest-js/commands.ts",
            )
            .expect("failed to export specta types");
    }
}