charlesgael / tauri-pinia

Utility to make pinia stores persisted for tauri apps

tauri-pinia

This is a small utility that brings persistance to pinia for tauri apps

Installation is pretty simple

const app = createApp(YourApp)
app.use(await tauriPinia())
app.mount('#app')

It requires await during initialisation however because the module will do a first read from fs before initialisation.

Some configuration is available (given as argument to tauriPinia()):

• singleFile: If we do use single file for storage or one file per store
• storeFilename: (when singleFile = false) A store name to file name conversion, should you need it (e.g. {'myStore': 'storageFileForMyStore.json'}) it is not mandatory
• filename: (when singleFile = true) The name of the file to save in
• logger: A function, the same type as console.log for those who want more info what's happening
• excludeStore: List of stores to exclude completely from persisting

Non-persistant attributes

tauri-pinia now allows for non persistant attributes. In order to do it, a new property has been added in StoreConfig: ignoreProps.

In order to use it, simply do the following:

import { acceptHMRUpdate, defineStore } from 'pinia'

export const useCredentialStore = defineStore('credential', () => {
  const username = ref<string>()
  const password = ref<string>()
  const userId = ref<string>()

  const withDefault = ref<string>('default_value')
  const ignored = ref<number>(0)

  return { username, password, jiraUrl, userId, withDefault, ignored }
}, {
  ignoreProps: ['ignored'],
})

if (import.meta.hot)
  import.meta.hot.accept(acceptHMRUpdate(useCredentialStore as any, import.meta.hot))

In this example, the property ignored won't be written to disk nor loaded from disk.

tauri-pinia's Issues

Feature request: allow non-persistent attributes or/and stores

First, thanks for this library, it's a very nice and easy to use alternative to more traditional options! 👍

I'm submitting a ...

• bug report
• feature request
• question about the decisions made in the repository
• question about how to use this project

Summary

I'd like to have a way to mark either a store or an attribute of a state non-persistent so that it would always be based on the provided initial value. Currently for example something like appInitReady: false which gets toggled to true in init() action is currently stored as true on disk and the logic needs to be rewritten in order to work w/ tauri-pinia. There are many cases where empty / predefined initial values would be useful.

Initial ideas:

• allow marking non-persistent attributes in config (something in the lines of await tauriPinia({ excludedAttrs: ['debug', 'isInited', 'createdAt'] }))
• offer an api to mark store not to be persisted (in config or maybe easier via a state attribute like dontPersist: true)