rename createOrLoad to newOrExisting

Author: lucasfernog

plugins/store/api-iife.js

@@ -4,7 +4,7 @@
 
 const COMMANDS: &[&str] = &[
     "create_store",
-    "create_or_load",
+    "new_or_existing",
     "get_store",
     "close_store",
     "set",

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 createOrLoad(
+export async function newOrExisting(
   path: string,
   options?: StoreOptions
 ): Promise<Store> {
-  return await Store.createOrLoad(path, options)
+  return await Store.newOrExisting(path, options)
 }
 
 /**
@@ -77,7 +77,7 @@ export class LazyStore implements IStore {
 
   private get store(): Promise<Store> {
     if (!this._store) {
-      this._store = createOrLoad(this.path, this.options)
+      this._store = newOrExisting(this.path, this.options)
     }
     return this._store
   }
@@ -211,18 +211,18 @@ 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.createOrLoad('store.json');
+   *   store = await Store.newOrExisting('store.json');
    * }
    * ```
    *
    * @param path Path to save the store in `app_data_dir`
    * @param options Store configuration options
    */
-  static async createOrLoad(
+  static async newOrExisting(
     path: string,
     options?: StoreOptions
   ): Promise<Store> {
-    const rid = await invoke<number>('plugin:store|create_or_load', {
+    const rid = await invoke<number>('plugin:store|new_or_existing', {
       path,
       ...options
     })
@@ -233,14 +233,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.createOrLoad createOrLoad} it.
+   * you must either {@link Store.create | create} it or {@link Store.newOrExisting newOrExisting} it.
    *
    * @example
    * ```typescript
    * import { Store } from '@tauri-apps/api/store';
    * let store = await Store.get('store.json');
    * if (!store) {
-   *   store = await Store.createOrLoad('store.json');
+   *   store = await Store.newOrExisting('store.json');
    * }
    * ```
    *

plugins/store/guest-js/index.ts

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

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

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

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

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

plugins/store/permissions/autogenerated/reference.md

@@ -314,16 +314,6 @@
           "type": "string",
           "const": "deny-close-store"
         },
-        {
-          "description": "Enables the create_or_load command without any pre-configured scope.",
-          "type": "string",
-          "const": "allow-create-or-load"
-        },
-        {
-          "description": "Denies the create_or_load command without any pre-configured scope.",
-          "type": "string",
-          "const": "deny-create-or-load"
-        },
         {
           "description": "Enables the create_store command without any pre-configured scope.",
           "type": "string",
@@ -414,6 +404,16 @@
           "type": "string",
           "const": "deny-load"
         },
+        {
+          "description": "Enables the new_or_existing command without any pre-configured scope.",
+          "type": "string",
+          "const": "allow-new-or-existing"
+        },
+        {
+          "description": "Denies the new_or_existing command without any pre-configured scope.",
+          "type": "string",
+          "const": "deny-new-or-existing"
+        },
         {
           "description": "Enables the reset command without any pre-configured scope.",
           "type": "string",

plugins/store/permissions/default.toml

@@ -117,7 +117,7 @@ async fn create_store<R: Runtime>(
 }
 
 #[tauri::command]
-async fn create_or_load<R: Runtime>(
+async fn new_or_existing<R: Runtime>(
     app: AppHandle<R>,
     store_state: State<'_, StoreState>,
     path: PathBuf,
@@ -133,7 +133,7 @@ async fn create_or_load<R: Runtime>(
         serialize_fn_name,
         deserialize_fn_name,
     )?;
-    let (_, rid) = builder.create_or_load_inner()?;
+    let (_, rid) = builder.new_or_existing_inner()?;
     Ok(rid)
 }
 
@@ -291,7 +291,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)).create_or_load()?;
+    ///     let store = app.store_builder("users.json").auto_save(Duration::from_secs(1)).new_or_existing()?;
     ///     Ok(())
     ///   });
     /// ```
@@ -328,7 +328,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>>> {
         let path = path.as_ref();
-        StoreBuilder::new(self.app_handle(), path).create_or_load()
+        StoreBuilder::new(self.app_handle(), path).new_or_existing()
     }
 
     fn create_store(&self, path: impl AsRef<Path>) -> Result<Arc<Store<R>>> {
@@ -451,15 +451,15 @@ impl<R: Runtime> Builder<R> {
     /// tauri::Builder::default()
     ///   .plugin(tauri_plugin_store::Builder::default().build())
     ///   .setup(|app| {
-    ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.bin").create_or_load()?;
+    ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.bin").new_or_existing()?;
     ///     Ok(())
     ///   });
     /// ```
     pub fn build(self) -> TauriPlugin<R> {
         plugin::Builder::new("store")
             .invoke_handler(tauri::generate_handler![
                 create_store,
-                create_or_load,
+                new_or_existing,
                 get_store,
                 close_store,
                 set,

plugins/store/permissions/schemas/schema.json

@@ -79,7 +79,7 @@ impl<R: Runtime> StoreBuilder<R> {
     ///
     ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.bin")
     ///       .defaults(defaults)
-    ///       .create_or_load()?;
+    ///       .new_or_existing()?;
     ///     Ok(())
     ///   });
     /// ```
@@ -97,7 +97,7 @@ impl<R: Runtime> StoreBuilder<R> {
     ///   .setup(|app| {
     ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.bin")
     ///       .default("foo".to_string(), "bar")
-    ///       .create_or_load()?;
+    ///       .new_or_existing()?;
     ///     Ok(())
     ///   });
     /// ```
@@ -119,7 +119,7 @@ impl<R: Runtime> StoreBuilder<R> {
     ///   .setup(|app| {
     ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.json")
     ///       .serialize(|cache| serde_json::to_vec(&cache).map_err(Into::into))
-    ///       .create_or_load()?;
+    ///       .new_or_existing()?;
     ///     Ok(())
     ///   });
     /// ```
@@ -137,7 +137,7 @@ impl<R: Runtime> StoreBuilder<R> {
     ///   .setup(|app| {
     ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.json")
     ///       .deserialize(|bytes| serde_json::from_slice(&bytes).map_err(Into::into))
-    ///       .create_or_load()?;
+    ///       .new_or_existing()?;
     ///     Ok(())
     ///   });
     /// ```
@@ -155,7 +155,7 @@ impl<R: Runtime> StoreBuilder<R> {
     ///   .setup(|app| {
     ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.json")
     ///         .auto_save(std::time::Duration::from_millis(100))
-    ///         .create_or_load()?;
+    ///         .new_or_existing()?;
     ///     Ok(())
     ///   });
     /// ```
@@ -217,7 +217,7 @@ impl<R: Runtime> StoreBuilder<R> {
     /// tauri::Builder::default()
     ///   .plugin(tauri_plugin_store::Builder::default().build())
     ///   .setup(|app| {
-    ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.json").create_or_load()?;
+    ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.json").new_or_existing()?;
     ///     Ok(())
     ///   });
     /// ```
@@ -241,16 +241,16 @@ impl<R: Runtime> StoreBuilder<R> {
     /// tauri::Builder::default()
     ///   .plugin(tauri_plugin_store::Builder::default().build())
     ///   .setup(|app| {
-    ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.json").create_or_load();
+    ///     let store = tauri_plugin_store::StoreBuilder::new(app, "store.json").new_or_existing();
     ///     Ok(())
     ///   });
     /// ```
-    pub fn create_or_load(self) -> crate::Result<Arc<Store<R>>> {
-        let (store, _) = self.create_or_load_inner()?;
+    pub fn new_or_existing(self) -> crate::Result<Arc<Store<R>>> {
+        let (store, _) = self.new_or_existing_inner()?;
         Ok(store)
     }
 
-    pub(crate) fn create_or_load_inner(self) -> crate::Result<(Arc<Store<R>>, ResourceId)> {
+    pub(crate) fn new_or_existing_inner(self) -> crate::Result<(Arc<Store<R>>, ResourceId)> {
         {
             let state = self.app.state::<StoreState>();
             let stores = state.stores.lock().unwrap();