CalvinBackup/tauri-plugins-workspace
1
0
Fork 0
mirror of https://github.com/tauri-apps/plugins-workspace.git synced 2026-04-29 12:06:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add create or existing

Browse Source
This commit is contained in:
Tony
2024-10-05 16:21:27 +08:00
parent 7faf8c31e0
commit dc5be009b7
9 changed files with 193 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/store/api-iife.js
+1 -1
View File
@@ -1 +1 @@
if("__TAURI__"in window){var __TAURI_PLUGIN_STORE__=function(t){"use strict";var e,a;function r(t,e=!1){return window.__TAURI_INTERNALS__.transformCallback(t,e)}async function s(t,e={},a){return window.__TAURI_INTERNALS__.invoke(t,e,a)}"function"==typeof SuppressedError&&SuppressedError;class i{get rid(){return function(t,e,a,r){if("a"===a&&!r)throw new TypeError("Private accessor was defined without a getter");if("function"==typeof e?t!==e||!r:!e.has(t))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===a?r:"a"===a?r.call(t):r?r.value:e.get(t)}(this,e,"f")}constructor(t){e.set(this,void 0),function(t,e,a,r,s){if("function"==typeof e?t!==e||!s:!e.has(t))throw new TypeError("Cannot write private member to an object whose class did not declare it");e.set(t,a)}(this,e,t)}async close(){return s("plugin:resources|close",{rid:this.rid})}}async function n(t,e,a){const i={kind:"Any"};return s("plugin:event|listen",{event:t,target:i,handler:r(e)}).then((e=>async()=>async function(t,e){await s("plugin:event|unlisten",{event:t,eventId:e})}(t,e)))}async function o(t,e){return await u.createStore(t,e)}async function c(t){return await u.getStore(t)}e=new WeakMap,function(t){t.WINDOW_RESIZED="tauri://resize",t.WINDOW_MOVED="tauri://move",t.WINDOW_CLOSE_REQUESTED="tauri://close-requested",t.WINDOW_DESTROYED="tauri://destroyed",t.WINDOW_FOCUS="tauri://focus",t.WINDOW_BLUR="tauri://blur",t.WINDOW_SCALE_FACTOR_CHANGED="tauri://scale-change",t.WINDOW_THEME_CHANGED="tauri://theme-changed",t.WINDOW_CREATED="tauri://window-created",t.WEBVIEW_CREATED="tauri://webview-created",t.DRAG_ENTER="tauri://drag-enter",t.DRAG_OVER="tauri://drag-over",t.DRAG_DROP="tauri://drag-drop",t.DRAG_LEAVE="tauri://drag-leave"}(a||(a={}));class u extends i{constructor(t){super(t)}static async createStore(t,e){const a=await s("plugin:store|create_store",{path:t,...e});return new u(a)}static async getStore(t){const e=await s("plugin:store|get_store",{path:t});return e?new u(e):void 0}async set(t,e){await s("plugin:store|set",{rid:this.rid,key:t,value:e})}async get(t){const[e,a]=await s("plugin:store|get",{rid:this.rid,key:t});return a?e:void 0}async has(t){return await s("plugin:store|has",{rid:this.rid,key:t})}async delete(t){return await s("plugin:store|delete",{rid:this.rid,key:t})}async clear(){await s("plugin:store|clear",{rid:this.rid})}async reset(){await s("plugin:store|reset",{rid:this.rid})}async keys(){return await s("plugin:store|keys",{rid:this.rid})}async values(){return await s("plugin:store|values",{rid:this.rid})}async entries(){return await s("plugin:store|entries",{rid:this.rid})}async length(){return await s("plugin:store|length",{rid:this.rid})}async load(){await s("plugin:store|load",{rid:this.rid})}async save(){await s("plugin:store|save",{rid:this.rid})}async onKeyChange(t,e){return await n("store://change",(a=>{a.payload.resourceId===this.rid&&a.payload.key===t&&e(a.payload.exists?a.payload.value:void 0)}))}async onChange(t){return await n("store://change",(e=>{e.payload.resourceId===this.rid&&t(e.payload.key,e.payload.exists?e.payload.value:void 0)}))}async close(){await s("plugin:store|close_store",{rid:this.rid})}}return t.LazyStore=class{get store(){return this._store||(this._store=c(this.path).then((async t=>t||await o(this.path,this.options)))),this._store}constructor(t,e){this.path=t,this.options=e}async init(){await this.store}async set(t,e){return(await this.store).set(t,e)}async get(t){return(await this.store).get(t)}async has(t){return(await this.store).has(t)}async delete(t){return(await this.store).delete(t)}async clear(){await(await this.store).clear()}async reset(){await(await this.store).reset()}async keys(){return(await this.store).keys()}async values(){return(await this.store).values()}async entries(){return(await this.store).entries()}async length(){return(await this.store).length()}async load(){await(await this.store).load()}async save(){await(await this.store).save()}async onKeyChange(t,e){return(await this.store).onKeyChange(t,e)}async onChange(t){return(await this.store).onChange(t)}async close(){this._store&&await(await this._store).close()}},t.Store=u,t.createStore=o,t.getStore=c,t}({});Object.defineProperty(window.__TAURI__,"store",{value:__TAURI_PLUGIN_STORE__})}
if("__TAURI__"in window){var __TAURI_PLUGIN_STORE__=function(t){"use strict";var e,r;function a(t,e=!1){return window.__TAURI_INTERNALS__.transformCallback(t,e)}async function s(t,e={},r){return window.__TAURI_INTERNALS__.invoke(t,e,r)}"function"==typeof SuppressedError&&SuppressedError;class i{get rid(){return function(t,e,r,a){if("a"===r&&!a)throw new TypeError("Private accessor was defined without a getter");if("function"==typeof e?t!==e||!a:!e.has(t))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===r?a:"a"===r?a.call(t):a?a.value:e.get(t)}(this,e,"f")}constructor(t){e.set(this,void 0),function(t,e,r,a,s){if("function"==typeof e?t!==e||!s:!e.has(t))throw new TypeError("Cannot write private member to an object whose class did not declare it");e.set(t,r)}(this,e,t)}async close(){return s("plugin:resources|close",{rid:this.rid})}}async function n(t,e,r){const i={kind:"Any"};return s("plugin:event|listen",{event:t,target:i,handler:a(e)}).then((e=>async()=>async function(t,e){await s("plugin:event|unlisten",{event:t,eventId:e})}(t,e)))}async function o(t,e){return await c.createOrExistingStore(t,e)}e=new WeakMap,function(t){t.WINDOW_RESIZED="tauri://resize",t.WINDOW_MOVED="tauri://move",t.WINDOW_CLOSE_REQUESTED="tauri://close-requested",t.WINDOW_DESTROYED="tauri://destroyed",t.WINDOW_FOCUS="tauri://focus",t.WINDOW_BLUR="tauri://blur",t.WINDOW_SCALE_FACTOR_CHANGED="tauri://scale-change",t.WINDOW_THEME_CHANGED="tauri://theme-changed",t.WINDOW_CREATED="tauri://window-created",t.WEBVIEW_CREATED="tauri://webview-created",t.DRAG_ENTER="tauri://drag-enter",t.DRAG_OVER="tauri://drag-over",t.DRAG_DROP="tauri://drag-drop",t.DRAG_LEAVE="tauri://drag-leave"}(r||(r={}));class c extends i{constructor(t){super(t)}static async createStore(t,e){const r=await s("plugin:store|create_store",{path:t,...e});return new c(r)}static async createOrExistingStore(t,e){const r=await s("plugin:store|create_or_existing_store",{path:t,...e});return new c(r)}static async getStore(t){const e=await s("plugin:store|get_store",{path:t});return e?new c(e):void 0}async set(t,e){await s("plugin:store|set",{rid:this.rid,key:t,value:e})}async get(t){const[e,r]=await s("plugin:store|get",{rid:this.rid,key:t});return r?e:void 0}async has(t){return await s("plugin:store|has",{rid:this.rid,key:t})}async delete(t){return await s("plugin:store|delete",{rid:this.rid,key:t})}async clear(){await s("plugin:store|clear",{rid:this.rid})}async reset(){await s("plugin:store|reset",{rid:this.rid})}async keys(){return await s("plugin:store|keys",{rid:this.rid})}async values(){return await s("plugin:store|values",{rid:this.rid})}async entries(){return await s("plugin:store|entries",{rid:this.rid})}async length(){return await s("plugin:store|length",{rid:this.rid})}async load(){await s("plugin:store|load",{rid:this.rid})}async save(){await s("plugin:store|save",{rid:this.rid})}async onKeyChange(t,e){return await n("store://change",(r=>{r.payload.resourceId===this.rid&&r.payload.key===t&&e(r.payload.exists?r.payload.value:void 0)}))}async onChange(t){return await n("store://change",(e=>{e.payload.resourceId===this.rid&&t(e.payload.key,e.payload.exists?e.payload.value:void 0)}))}async close(){await s("plugin:store|close_store",{rid:this.rid})}}return t.LazyStore=class{get store(){return this._store||(this._store=o(this.path,this.options)),this._store}constructor(t,e){this.path=t,this.options=e}async init(){await this.store}async set(t,e){return(await this.store).set(t,e)}async get(t){return(await this.store).get(t)}async has(t){return(await this.store).has(t)}async delete(t){return(await this.store).delete(t)}async clear(){await(await this.store).clear()}async reset(){await(await this.store).reset()}async keys(){return(await this.store).keys()}async values(){return(await this.store).values()}async entries(){return(await this.store).entries()}async length(){return(await this.store).length()}async load(){await(await this.store).load()}async save(){await(await this.store).save()}async onKeyChange(t,e){return(await this.store).onKeyChange(t,e)}async onChange(t){return(await this.store).onChange(t)}async close(){this._store&&await(await this._store).close()}},t.Store=c,t.createOrExistingStore=o,t.createStore=async function(t,e){return await c.createStore(t,e)},t.getStore=async function(t){return await c.getStore(t)},t}({});Object.defineProperty(window.__TAURI__,"store",{value:__TAURI_PLUGIN_STORE__})}
plugins/store/build.rs
+1
View File
@@ -4,6 +4,7 @@
const COMMANDS: &[&str] = &[
"create_store",
"create_or_existing_store",
"get_store",
"close_store",
"set",
plugins/store/guest-js/index.ts
+34 -3
View File
@@ -45,6 +45,19 @@ export async function createStore(
return await Store.createStore(path, options)
}
/**
* Create a new Store or get the existing store with the path
*
* @param path: Path to save the store in `app_data_dir`
* @param options: Store configuration options
*/
export async function createOrExistingStore(
path: string,
options?: StoreOptions
): Promise<Store> {
return await Store.createOrExistingStore(path, options)
}
/**
* @param path: Path of the store in the rust side
*/
@@ -60,9 +73,7 @@ export class LazyStore implements IStore {
private get store(): Promise<Store> {
if (!this._store) {
this._store = getStore(this.path).then(
async (store) => store || (await createStore(this.path, this.options))
)
this._store = createOrExistingStore(this.path, this.options)
}
return this._store
}
@@ -183,6 +194,26 @@ export class Store extends Resource implements IStore {
)
}
/**
* Create a new Store or get the existing store with the path
*
* @param path: Path to save the store in `app_data_dir`
* @param options: Store configuration options
*/
static async createOrExistingStore(
path: string,
options?: StoreOptions
): Promise<Store> {
const rid = await invoke<number>('plugin:store|create_or_existing_store', {
path,
...options
})
return new Store(
rid
// path
)
}
/**
* @param path: Path of the store in the rust side
*/
plugins/store/permissions/autogenerated/commands/create_or_existing_store.toml
+13
View File
@@ -0,0 +1,13 @@
# Automatically generated - DO NOT EDIT!
"$schema" = "../../schemas/schema.json"
[[permission]]
identifier = "allow-create-or-existing-store"
description = "Enables the create_or_existing_store command without any pre-configured scope."
commands.allow = ["create_or_existing_store"]
[[permission]]
identifier = "deny-create-or-existing-store"
description = "Denies the create_or_existing_store command without any pre-configured scope."
commands.deny = ["create_or_existing_store"]
plugins/store/permissions/autogenerated/reference.md
+26
View File
@@ -89,6 +89,32 @@ Denies the close_store command without any pre-configured scope.
<tr>
<td>
`store:allow-create-or-existing-store`
</td>
<td>
Enables the create_or_existing_store command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-create-or-existing-store`
</td>
<td>
Denies the create_or_existing_store command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-create-store`
</td>
plugins/store/permissions/default.toml
+1
View File
@@ -12,6 +12,7 @@ All operations are enabled by default.
"""
permissions = [
"allow-create-store",
"allow-create-or-existing-store",
"allow-get-store",
"allow-close-store",
"allow-clear",
plugins/store/permissions/schemas/schema.json
+10
View File
@@ -314,6 +314,16 @@
"type": "string",
"const": "deny-close-store"
},
{
"description": "Enables the create_or_existing_store command without any pre-configured scope.",
"type": "string",
"const": "allow-create-or-existing-store"
},
{
"description": "Denies the create_or_existing_store command without any pre-configured scope.",
"type": "string",
"const": "deny-create-or-existing-store"
},
{
"description": "Enables the create_store command without any pre-configured scope.",
"type": "string",
plugins/store/src/lib.rs
+47 -9
View File
@@ -57,17 +57,15 @@ enum AutoSave {
Bool(bool),
}
#[tauri::command]
async fn create_store<R: Runtime>(
fn builder<R: Runtime>(
app: AppHandle<R>,
store_state: State<'_, StoreState>,
path: PathBuf,
auto_save: Option<AutoSave>,
serialize_fn_name: Option<String>,
deserialize_fn_name: Option<String>,
) -> Result<ResourceId> {
let mut builder = app.store_builder(path.clone());
) -> Result<StoreBuilder<R>> {
let mut builder = app.store_builder(path);
if let Some(auto_save) = auto_save {
match auto_save {
AutoSave::DebounceDuration(duration) => {
@@ -95,11 +93,51 @@ async fn create_store<R: Runtime>(
.ok_or_else(|| crate::Error::DeserializeFunctionNotFound(deserialize_fn_name))?;
builder = builder.deserialize(*deserialize_fn);
}
Ok(builder)
}
#[tauri::command]
async fn create_store<R: Runtime>(
app: AppHandle<R>,
store_state: State<'_, StoreState>,
path: PathBuf,
auto_save: Option<AutoSave>,
serialize_fn_name: Option<String>,
deserialize_fn_name: Option<String>,
) -> Result<ResourceId> {
let builder = builder(
app,
store_state,
path,
auto_save,
serialize_fn_name,
deserialize_fn_name,
)?;
let (_, rid) = builder.build_inner()?;
Ok(rid)
}
#[tauri::command]
async fn create_or_existing_store<R: Runtime>(
app: AppHandle<R>,
store_state: State<'_, StoreState>,
path: PathBuf,
auto_save: Option<AutoSave>,
serialize_fn_name: Option<String>,
deserialize_fn_name: Option<String>,
) -> Result<ResourceId> {
let builder = builder(
app,
store_state,
path,
auto_save,
serialize_fn_name,
deserialize_fn_name,
)?;
let (_, rid) = builder.build_or_existing_inner();
Ok(rid)
}
#[tauri::command]
async fn get_store<R: Runtime>(
app: AppHandle<R>,
@@ -107,7 +145,7 @@ async fn get_store<R: Runtime>(
path: PathBuf,
) -> Result<Option<ResourceId>> {
let stores = store_state.stores.lock().unwrap();
Ok(stores.get(&resolve_store_path(app, path)).copied())
Ok(stores.get(&resolve_store_path(&app, path)).copied())
}
#[tauri::command]
@@ -217,8 +255,7 @@ pub trait StoreExt<R: Runtime> {
impl<R: Runtime, T: Manager<R>> StoreExt<R> for T {
fn store(&self, path: impl AsRef<Path>) -> Arc<Store<R>> {
self.get_store(&path)
.unwrap_or_else(|| self.create_store(&path).unwrap())
StoreBuilder::new(self.app_handle(), path).build_or_existing()
}
fn create_store(&self, path: impl AsRef<Path>) -> Result<Arc<Store<R>>> {
@@ -233,7 +270,7 @@ impl<R: Runtime, T: Manager<R>> StoreExt<R> for T {
let collection = self.state::<StoreState>();
let stores = collection.stores.lock().unwrap();
stores
.get(path.as_ref())
.get(&resolve_store_path(self.app_handle(), path.as_ref()))
.and_then(|rid| self.resources_table().get(*rid).ok())
}
}
@@ -351,6 +388,7 @@ impl<R: Runtime> Builder<R> {
create_store,
get_store,
close_store,
create_or_existing_store,
set,
get,
has,
plugins/store/src/store.rs
+60 -8
View File
@@ -24,10 +24,16 @@ pub type SerializeFn =
pub type DeserializeFn =
fn(&[u8]) -> Result<HashMap<String, JsonValue>, Box<dyn std::error::Error + Send + Sync>>;
pub(crate) fn resolve_store_path<R: Runtime>(app: AppHandle<R>, path: impl AsRef<Path>) -> PathBuf {
app.path()
.resolve(path, BaseDirectory::AppData)
.expect("failed to resolve app dir")
pub(crate) fn resolve_store_path<R: Runtime>(
app: &AppHandle<R>,
path: impl AsRef<Path>,
) -> PathBuf {
dunce::simplified(
&app.path()
.resolve(path, BaseDirectory::AppData)
.expect("failed to resolve app dir"),
)
.to_path_buf()
}
/// Builds a [`Store`]
@@ -55,14 +61,13 @@ impl<R: Runtime> StoreBuilder<R> {
/// ```
pub fn new<M: Manager<R>, P: AsRef<Path>>(manager: &M, path: P) -> Self {
let app = manager.app_handle().clone();
let path = resolve_store_path(app.clone(), path);
let path = resolve_store_path(&app, path);
let state = app.state::<StoreState>();
let serialize_fn = state.default_serialize;
let deserialize_fn = state.default_deserialize;
Self {
app,
// Since Store.path is only exposed to the user in emit calls we may as well simplify it here already.
path: dunce::simplified(&path).to_path_buf(),
path,
defaults: None,
serialize_fn,
deserialize_fn,
@@ -212,7 +217,38 @@ impl<R: Runtime> StoreBuilder<R> {
Ok((store, rid))
}
/// Builds the [`Store`].
pub(crate) fn build_or_existing_inner(mut self) -> (Arc<Store<R>>, ResourceId) {
let state = self.app.state::<StoreState>();
let mut stores = state.stores.lock().unwrap();
if let Some(rid) = stores.get(&self.path) {
(self.app.resources_table().get(*rid).unwrap(), *rid)
} else {
let mut store_inner = StoreInner::new(
self.app.clone(),
self.path.clone(),
self.defaults.take(),
self.serialize_fn,
self.deserialize_fn,
);
if self.load_on_build {
let _ = store_inner.load();
}
let store = Store {
auto_save: self.auto_save,
auto_save_debounce_sender: Arc::new(Mutex::new(None)),
store: Arc::new(Mutex::new(store_inner)),
};
let store = Arc::new(store);
let rid = self.app.resources_table().add_arc(store.clone());
stores.insert(self.path, rid);
(store, rid)
}
}
/// Builds the [`Store`], also see [`build_or_existing`](Self::build_or_existing).
///
/// This loads the store from disk and put the store in the app's resource table,
/// to remove it from the resource table, call [`Store::close_store`]
@@ -235,6 +271,22 @@ impl<R: Runtime> StoreBuilder<R> {
let (store, _) = self.build_inner()?;
Ok(store)
}
/// Get the existing store with the same path or builds a new [`Store`], also see [`build`](Self::build).
///
/// # Examples
/// ```
/// tauri::Builder::default()
/// .plugin(tauri_plugin_store::Builder::default().build())
/// .setup(|app| {
/// let store = tauri_plugin_store::StoreBuilder::new(app, "store.json").build_or_existing();
/// Ok(())
/// });
/// ```
pub fn build_or_existing(self) -> Arc<Store<R>> {
let (store, _) = self.build_or_existing_inner();
store
}
}
pub(crate) enum AutoSaveMessage {