Files
tauri-plugins-workspace/plugins/store/permissions/autogenerated/reference.md
T
Tony 8c67d44aef refactor(store)!: more reworks (#1860)
* refactor(store): more reworks

* Enable auto save by default

* Store to resource table by default

* Remove share store

* Clean up

* Add close store

* Add store function

* Add lazy store

* Add init to lazy store

* refresh cache in example

* Add get-or-create-store

* Revert "Add get-or-create-store"

This reverts commit 7ffd769240.

* try get first

* Docs

* Use absolute path for store

* more docs

* Allow js to use pre-stored (de)serialize functions

* Fix js get and close store

* Show case how to use pretty json

* Update readme

* Use store instead of `store_builder` in example

* Build

* Fix example

* More docs for StoreBuilder::build

* Add default (de)serialize fn

* Use pretty json by default

* Use `undefined` for empty value in get

* Change files

* Differentiate json null from no value for events

* Add create or existing

* Build

* Rename inner store's inset method to set

* Update readme

* Apply suggestions from code review

* Use close instead

* Update breaking changes

* Return result in resolve_store_path

* Change to close_resource and take &self

* Clean up

* Apply suggestions from code review

Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>

* Remove unused pub(crate)

* Update change file

* Expose resolve_store_path

* Remove with_store

* Remove StoreInner from pub and expose is_empty

* Fix wrong jsdoc param

* Update readme

* rename createOrExistingStore to createOrLoad

* make api consistent with the JS implementation, add examples

* fmt

* reintroduce "get existing store" behavior for create_or_load

* rename createOrLoad to newOrExisting

* keep store lock throughout whole new_or_existing_inner

* Remove load

* Missed if load

* Don't make StoreState public

* Remove R: Runtime from Builder

* rename newOrExisting to load, load to reload

* update docs

* rename missing reload fn

* rename builder fn to build()

* fix default permission

* Fix description and create_new logic

* Clippy

* Update docs

* Update docs

* remove create_store command

* remove close_store command since we extend from Resource

* Revert "remove close_store command since we extend from Resource"

This reverts commit 4a29fc8990.

* Reapply "remove close_store command since we extend from Resource"

This reverts commit 70a1830e7d.

---------

Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>
Co-authored-by: Lucas Nogueira <lucas@tauri.app>
2024-10-17 19:14:41 +08:00

400 lines
3.7 KiB
Markdown

## Default Permission
This permission set configures what kind of
operations are available from the store plugin.
#### Granted Permissions
All operations are enabled by default.
- `allow-load`
- `allow-get-store`
- `allow-set`
- `allow-get`
- `allow-has`
- `allow-delete`
- `allow-clear`
- `allow-reset`
- `allow-keys`
- `allow-values`
- `allow-entries`
- `allow-length`
- `allow-reload`
- `allow-save`
## Permission Table
<table>
<tr>
<th>Identifier</th>
<th>Description</th>
</tr>
<tr>
<td>
`store:allow-clear`
</td>
<td>
Enables the clear command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-clear`
</td>
<td>
Denies the clear command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-delete`
</td>
<td>
Enables the delete command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-delete`
</td>
<td>
Denies the delete command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-entries`
</td>
<td>
Enables the entries command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-entries`
</td>
<td>
Denies the entries command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-get`
</td>
<td>
Enables the get command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-get`
</td>
<td>
Denies the get command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-get-store`
</td>
<td>
Enables the get_store command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-get-store`
</td>
<td>
Denies the get_store command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-has`
</td>
<td>
Enables the has command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-has`
</td>
<td>
Denies the has command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-keys`
</td>
<td>
Enables the keys command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-keys`
</td>
<td>
Denies the keys command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-length`
</td>
<td>
Enables the length command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-length`
</td>
<td>
Denies the length command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-load`
</td>
<td>
Enables the load command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-load`
</td>
<td>
Denies the load command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-reload`
</td>
<td>
Enables the reload command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-reload`
</td>
<td>
Denies the reload command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-reset`
</td>
<td>
Enables the reset command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-reset`
</td>
<td>
Denies the reset command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-save`
</td>
<td>
Enables the save command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-save`
</td>
<td>
Denies the save command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-set`
</td>
<td>
Enables the set command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-set`
</td>
<td>
Denies the set command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:allow-values`
</td>
<td>
Enables the values command without any pre-configured scope.
</td>
</tr>
<tr>
<td>
`store:deny-values`
</td>
<td>
Denies the values command without any pre-configured scope.
</td>
</tr>
</table>