feat(store)!: fully rework and add auto save

.changes/store-auto-save.md

@@ -0,0 +1,7 @@
+---
+"store": patch
+---
+
+Add a setting `auto_save` to enable a store to debounce save on modification (on calls like set, clear, delete, reset)
+
+**Breaking change**: `with_store` now takes one more parameter `auto_save: Option<Duration>`

plugins/store/Cargo.toml

@@ -23,3 +23,4 @@ tauri = { workspace = true }
 log = { workspace = true }
 thiserror = { workspace = true }
 dunce = { workspace = true }
+tokio = { version = "1", features = [ "sync", "time", "macros" ]}

plugins/store/README.md

@@ -154,7 +154,7 @@ use tauri_plugin_store::with_store;
 let stores = app.state::<StoreCollection<Wry>>();
 let path = PathBuf::from("app_data.bin");
 
-with_store(app_handle, stores, path, |store| store.insert("a".to_string(), json!("b")))
+with_store(app_handle, stores, path, None, |store| store.insert("a".to_string(), json!("b")))
 ```
 
 ## Contributing

plugins/store/examples/AppSettingsManager/src-tauri/src/main.rs

@@ -5,17 +5,21 @@
 // Prevents additional console window on Windows in release, DO NOT REMOVE!!
 #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
 
-use tauri_plugin_store::StoreBuilder;
+use std::time::Duration;
+
+use serde_json::json;
+use tauri_plugin_store::{Builder, StoreBuilder};
 
 mod app;
 use app::settings::AppSettings;
 
 fn main() {
     tauri::Builder::default()
-        .plugin(tauri_plugin_store::Builder::default().build())
         .setup(|app| {
             // Init store and load it from disk
-            let mut store = StoreBuilder::new("settings.json").build(app.handle().clone());
+            let mut store = StoreBuilder::new("settings.json")
+                .auto_save(Duration::from_millis(100))
+                .build(app.handle().clone());
 
             // If there are no saved settings yet, this will return an error so we ignore the return value.
             let _ = store.load();
@@ -27,17 +31,22 @@ fn main() {
                     let theme = app_settings.theme;
                     let launch_at_login = app_settings.launch_at_login;
 
-                    println!("theme {}", theme);
-                    println!("launch_at_login {}", launch_at_login);
-
-                    Ok(())
+                    println!("theme {theme}");
+                    println!("launch_at_login {launch_at_login}");
+                    store.insert(
+                        "appSettings".into(),
+                        json!({ "theme": theme, "launchAtLogin": launch_at_login }),
+                    )?;
                 }
                 Err(err) => {
-                    eprintln!("Error loading settings: {}", err);
+                    eprintln!("Error loading settings: {err}");
                     // Handle the error case if needed
-                    Err(err) // Convert the error to a Box<dyn Error> and return Err(err) here
+                    return Err(err); // Convert the error to a Box<dyn Error> and return Err(err) here
                 }
             }
+            app.handle()
+                .plugin(Builder::default().store(store).build())?;
+            Ok(())
         })
         .run(tauri::generate_context!())
         .expect("error while running tauri application");

plugins/store/guest-js/index.ts

@@ -17,8 +17,14 @@ interface ChangePayload<T> {
  */
 export class Store {
   path: string;
-  constructor(path: string) {
+  readonly autoSave?: number;
+  /**
+   * @param path: Path to save the store in `app_data_dir`
+   * @param autoSave: Auto save on modification with debounce duration in milliseconds
+   */
+  constructor(path: string, autoSave?: number) {
     this.path = path;
+    this.autoSave = autoSave;
   }
 
   /**
@@ -31,6 +37,7 @@ export class Store {
   async set(key: string, value: unknown): Promise<void> {
     await invoke("plugin:store|set", {
       path: this.path,
+      autoSave: this.autoSave,
       key,
       value,
     });
@@ -45,6 +52,7 @@ export class Store {
   async get<T>(key: string): Promise<T | null> {
     return await invoke("plugin:store|get", {
       path: this.path,
+      autoSave: this.autoSave,
       key,
     });
   }
@@ -58,6 +66,7 @@ export class Store {
   async has(key: string): Promise<boolean> {
     return await invoke("plugin:store|has", {
       path: this.path,
+      autoSave: this.autoSave,
       key,
     });
   }
@@ -71,6 +80,7 @@ export class Store {
   async delete(key: string): Promise<boolean> {
     return await invoke("plugin:store|delete", {
       path: this.path,
+      autoSave: this.autoSave,
       key,
     });
   }
@@ -84,6 +94,7 @@ export class Store {
   async clear(): Promise<void> {
     await invoke("plugin:store|clear", {
       path: this.path,
+      autoSave: this.autoSave,
     });
   }
 
@@ -96,6 +107,7 @@ export class Store {
   async reset(): Promise<void> {
     await invoke("plugin:store|reset", {
       path: this.path,
+      autoSave: this.autoSave,
     });
   }
 
@@ -107,6 +119,7 @@ export class Store {
   async keys(): Promise<string[]> {
     return await invoke("plugin:store|keys", {
       path: this.path,
+      autoSave: this.autoSave,
     });
   }
 
@@ -118,6 +131,7 @@ export class Store {
   async values<T>(): Promise<T[]> {
     return await invoke("plugin:store|values", {
       path: this.path,
+      autoSave: this.autoSave,
     });
   }
 
@@ -129,6 +143,7 @@ export class Store {
   async entries<T>(): Promise<Array<[key: string, value: T]>> {
     return await invoke("plugin:store|entries", {
       path: this.path,
+      autoSave: this.autoSave,
     });
   }
 
@@ -140,6 +155,7 @@ export class Store {
   async length(): Promise<number> {
     return await invoke("plugin:store|length", {
       path: this.path,
+      autoSave: this.autoSave,
     });
   }
 
@@ -154,6 +170,7 @@ export class Store {
   async load(): Promise<void> {
     await invoke("plugin:store|load", {
       path: this.path,
+      autoSave: this.autoSave,
     });
   }
 
@@ -167,6 +184,7 @@ export class Store {
   async save(): Promise<void> {
     await invoke("plugin:store|save", {
       path: this.path,
+      autoSave: this.autoSave,
     });
   }