rename newOrExisting to load, load to reload

Author: lucasfernog

plugins/store/api-iife.js

@@ -4,7 +4,7 @@
 
 const COMMANDS: &[&str] = &[
     "create_store",
-    "new_or_existing",
+    "load",
     "get_store",
     "close_store",
     "set",
@@ -17,7 +17,7 @@ const COMMANDS: &[&str] = &[
     "values",
     "entries",
     "length",
-    "load",
+    "reload",
     "save",
 ];
 

plugins/store/build.rs

@@ -55,11 +55,11 @@ export async function create(
  * @param path Path to save the store in `app_data_dir`
  * @param options Store configuration options
  */
-export async function newOrExisting(
+export async function load(
   path: string,
   options?: StoreOptions
 ): Promise<Store> {
-  return await Store.newOrExisting(path, options)
+  return await Store.load(path, options)
 }
 
 /**
@@ -77,7 +77,7 @@ export class LazyStore implements IStore {
 
   private get store(): Promise<Store> {
     if (!this._store) {
-      this._store = newOrExisting(this.path, this.options)
+      this._store = load(this.path, this.options)
     }
     return this._store
   }
@@ -180,6 +180,8 @@ export class Store extends Resource implements IStore {
    *
    * If the store already exists, its data will be overwritten.
    *
+   * To load the store if it already exists you must use {@link load} instead.
+   *
    * If the store is already loaded you must use {@link getStore} instead.
    *
    * @example
@@ -211,18 +213,15 @@ export class Store extends Resource implements IStore {
    * import { Store } from '@tauri-apps/api/store';
    * let store = await Store.get('store.json');
    * if (!store) {
-   *   store = await Store.newOrExisting('store.json');
+   *   store = await Store.load('store.json');
    * }
    * ```
    *
    * @param path Path to save the store in `app_data_dir`
    * @param options Store configuration options
    */
-  static async newOrExisting(
-    path: string,
-    options?: StoreOptions
-  ): Promise<Store> {
-    const rid = await invoke<number>('plugin:store|new_or_existing', {
+  static async load(path: string, options?: StoreOptions): Promise<Store> {
+    const rid = await invoke<number>('plugin:store|load', {
       path,
       ...options
     })
@@ -233,14 +232,14 @@ export class Store extends Resource implements IStore {
    * Gets an already loaded store.
    *
    * If the store is not loaded, returns `null`. In this case,
-   * you must either {@link Store.create | create} it or {@link Store.newOrExisting newOrExisting} it.
+   * you must either {@link Store.create | create} it or {@link Store.load load} it.
    *
    * @example
    * ```typescript
    * import { Store } from '@tauri-apps/api/store';
    * let store = await Store.get('store.json');
    * if (!store) {
-   *   store = await Store.newOrExisting('store.json');
+   *   store = await Store.load('store.json');
    * }
    * ```
    *
@@ -306,8 +305,8 @@ export class Store extends Resource implements IStore {
     return await invoke('plugin:store|length', { rid: this.rid })
   }
 
-  async load(): Promise<void> {
-    await invoke('plugin:store|load', { rid: this.rid })
+  async reload(): Promise<void> {
+    await invoke('plugin:store|reload', { rid: this.rid })
   }
 
   async save(): Promise<void> {

plugins/store/guest-js/index.ts

@@ -0,0 +1,13 @@
+# Automatically generated - DO NOT EDIT!
+
+"$schema" = "../../schemas/schema.json"
+
+[[permission]]
+identifier = "allow-reload"
+description = "Enables the reload command without any pre-configured scope."
+commands.allow = ["reload"]
+
+[[permission]]
+identifier = "deny-reload"
+description = "Denies the reload command without any pre-configured scope."
+commands.deny = ["reload"]

plugins/store/permissions/autogenerated/commands/new_or_existing.toml

@@ -10,7 +10,7 @@ All operations are enabled by default.
 
 
 - `allow-create-store`
-- `allow-new-or-existing`
+- `allow-load`
 - `allow-get-store`
 - `allow-close-store`
 - `allow-set`
@@ -324,25 +324,25 @@ Denies the load command without any pre-configured scope.
 <tr>
 <td>
 
-`store:allow-new-or-existing`
+`store:allow-reload`
 
 </td>
 <td>
 
-Enables the new_or_existing command without any pre-configured scope.
+Enables the reload command without any pre-configured scope.
 
 </td>
 </tr>
 
 <tr>
 <td>
 
-`store:deny-new-or-existing`
+`store:deny-reload`
 
 </td>
 <td>
 
-Denies the new_or_existing command without any pre-configured scope.
+Denies the reload command without any pre-configured scope.
 
 </td>
 </tr>

plugins/store/permissions/autogenerated/commands/reload.toml

@@ -12,7 +12,7 @@ All operations are enabled by default.
 """
 permissions = [
   "allow-create-store",
-  "allow-new-or-existing",
+  "allow-load",
   "allow-get-store",
   "allow-close-store",
   "allow-set",

plugins/store/permissions/autogenerated/reference.md

@@ -405,14 +405,14 @@
           "const": "deny-load"
         },
         {
-          "description": "Enables the new_or_existing command without any pre-configured scope.",
+          "description": "Enables the reload command without any pre-configured scope.",
           "type": "string",
-          "const": "allow-new-or-existing"
+          "const": "allow-reload"
         },
         {
-          "description": "Denies the new_or_existing command without any pre-configured scope.",
+          "description": "Denies the reload command without any pre-configured scope.",
           "type": "string",
-          "const": "deny-new-or-existing"
+          "const": "deny-reload"
         },
         {
           "description": "Enables the reset command without any pre-configured scope.",

plugins/store/permissions/default.toml

@@ -116,7 +116,7 @@ async fn create_store<R: Runtime>(
 }
 
 #[tauri::command]
-async fn new_or_existing<R: Runtime>(
+async fn load<R: Runtime>(
     app: AppHandle<R>,
     store_state: State<'_, StoreState>,
     path: PathBuf,
@@ -132,7 +132,7 @@ async fn new_or_existing<R: Runtime>(
         serialize_fn_name,
         deserialize_fn_name,
     )?;
-    let (_, rid) = builder.new_or_existing_inner()?;
+    let (_, rid) = builder.load_inner()?;
     Ok(rid)
 }
 
@@ -229,9 +229,9 @@ async fn length<R: Runtime>(app: AppHandle<R>, rid: ResourceId) -> Result<usize>
 }
 
 #[tauri::command]
-async fn load<R: Runtime>(app: AppHandle<R>, rid: ResourceId) -> Result<()> {
+async fn reload<R: Runtime>(app: AppHandle<R>, rid: ResourceId) -> Result<()> {
     let store = app.resources_table().get::<Store<R>>(rid)?;
-    store.load()
+    store.reload()
 }
 
 #[tauri::command]
@@ -290,7 +290,7 @@ pub trait StoreExt<R: Runtime> {
     /// tauri::Builder::default()
     ///   .plugin(tauri_plugin_store::Builder::default().build())
     ///   .setup(|app| {
-    ///     let store = app.store_builder("users.json").auto_save(Duration::from_secs(1)).new_or_existing()?;
+    ///     let store = app.store_builder("users.json").auto_save(Duration::from_secs(1)).load()?;
     ///     Ok(())
     ///   });
     /// ```
@@ -326,7 +326,7 @@ pub trait StoreExt<R: Runtime> {
 
 impl<R: Runtime, T: Manager<R>> StoreExt<R> for T {
     fn store(&self, path: impl AsRef<Path>) -> Result<Arc<Store<R>>> {
-        StoreBuilder::new(self.app_handle(), path).new_or_existing()
+        StoreBuilder::new(self.app_handle(), path).load()
     }
 
     fn create_store(&self, path: impl AsRef<Path>) -> Result<Arc<Store<R>>> {
@@ -447,15 +447,15 @@ impl Builder {
     /// tauri::Builder::default()
     ///   .plugin(tauri_plugin_store::Builder::default().build())
     ///   .setup(|app| {
-    ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.bin").new_or_existing()?;
+    ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.bin").load()?;
     ///     Ok(())
     ///   });
     /// ```
     pub fn build<R: Runtime>(self) -> TauriPlugin<R> {
         plugin::Builder::new("store")
             .invoke_handler(tauri::generate_handler![
                 create_store,
-                new_or_existing,
+                load,
                 get_store,
                 close_store,
                 set,
@@ -468,7 +468,7 @@ impl Builder {
                 values,
                 length,
                 entries,
-                load,
+                reload,
                 save,
             ])
             .setup(move |app_handle, _api| {