feat: auto mode (#327)

src/index.ts

@@ -16,6 +16,11 @@ export type PluginOptions = Pick<
    * Global key generator, allow pre/postfixing store keys.
    */
   key?: (storeKey: string) => string
+
+  /**
+   * Automatically persist all stores with global defaults, opt-out individually.
+   */
+  auto?: boolean
 }
 
 /**
@@ -24,19 +29,23 @@ export type PluginOptions = Pick<
  */
 export function createPersistedState(options: PluginOptions = {}) {
   return function (context: PiniaPluginContext) {
-    createPersistence(context, p => ({
-      key: (options.key ? options.key : (x: string) => x)(p.key ?? context.store.$id),
-      debug: p.debug ?? options.debug ?? false,
-      serializer: p.serializer ?? options.serializer ?? {
-        serialize: data => JSON.stringify(data),
-        deserialize: data => destr(data),
-      },
-      storage: p.storage ?? options.storage ?? window.localStorage,
-      beforeHydrate: p.beforeHydrate,
-      afterHydrate: p.afterHydrate,
-      pick: p.pick,
-      omit: p.omit,
-    }))
+    createPersistence(
+      context,
+      p => ({
+        key: (options.key ? options.key : (x: string) => x)(p.key ?? context.store.$id),
+        debug: p.debug ?? options.debug ?? false,
+        serializer: p.serializer ?? options.serializer ?? {
+          serialize: data => JSON.stringify(data),
+          deserialize: data => destr(data),
+        },
+        storage: p.storage ?? options.storage ?? window.localStorage,
+        beforeHydrate: p.beforeHydrate,
+        afterHydrate: p.afterHydrate,
+        pick: p.pick,
+        omit: p.omit,
+      }),
+      options.auto ?? false,
+    )
   }
 }
 

src/module.ts

@@ -28,6 +28,11 @@ type ModuleOptions = Pick<PersistenceOptions, 'debug'> & {
     CookieOptions,
   'encode' | 'decode' | 'default' | 'watch' | 'readonly' | 'filter'
   >
+
+  /**
+   * Automatically persist all stores with global defaults, opt-out individually.
+   */
+  auto?: boolean
 }
 
 export default defineNuxtModule<ModuleOptions>({

src/runtime/core.ts

@@ -73,8 +73,9 @@ function persistState(
 export function createPersistence(
   context: PiniaPluginContext,
   optionsParser: (p: PersistenceOptions) => Persistence,
+  auto: boolean,
 ) {
-  const { pinia, store, options: { persist } } = context
+  const { pinia, store, options: { persist = auto } } = context
 
   if (!persist)
     return

src/runtime/plugin.ts

@@ -8,25 +8,29 @@ function piniaPlugin(context: PiniaPluginContext) {
   const config = useRuntimeConfig()
   const options = config.public.piniaPluginPersistedstate
 
-  createPersistence(context, p => ({
-    key: options.key
-      ? options.key.replace(/%id/g, p.key ?? context.store.$id)
-      : (p.key ?? context.store.$id),
-    debug: p.debug ?? options.debug ?? false,
-    serializer: p.serializer ?? {
-      serialize: data => JSON.stringify(data),
-      deserialize: data => destr(data),
-    },
-    storage: p.storage ?? (options.storage
-      ? options.storage === 'cookies'
-        ? storages.cookies(options.cookieOptions)
-        : storages[options.storage]()
-      : storages.cookies()),
-    beforeHydrate: p.beforeHydrate,
-    afterHydrate: p.afterHydrate,
-    pick: p.pick,
-    omit: p.omit,
-  }))
+  createPersistence(
+    context,
+    p => ({
+      key: options.key
+        ? options.key.replace(/%id/g, p.key ?? context.store.$id)
+        : (p.key ?? context.store.$id),
+      debug: p.debug ?? options.debug ?? false,
+      serializer: p.serializer ?? {
+        serialize: data => JSON.stringify(data),
+        deserialize: data => destr(data),
+      },
+      storage: p.storage ?? (options.storage
+        ? options.storage === 'cookies'
+          ? storages.cookies(options.cookieOptions)
+          : storages[options.storage]()
+        : storages.cookies()),
+      beforeHydrate: p.beforeHydrate,
+      afterHydrate: p.afterHydrate,
+      pick: p.pick,
+      omit: p.omit,
+    }),
+    options.auto ?? false,
+  )
 }
 
 export default defineNuxtPlugin(({ $pinia }) => {