CHANGELOG.md

Changelog

v4.5.0

compare changes

🚀 Enhancements

• Export Persist type (bc23d5a)

🏡 Chore

• Upgrade dependencies (be73362)

❤️ Contributors

• Prazdevs hi@praz.dev

v4.4.1

compare changes

🩹 Fixes

• Remove node>=24 requirement (d50bd4b)

❤️ Contributors

• Prazdevs (@prazdevs)

v4.4.0

compare changes

🚀 Enhancements

• Move @nuxt/kit to peerDependencies (4cd2337)

📖 Documentation

• Restore setup store syntax (739bd1f)
• nuxt: Add SSR/middleware limitation (155511e)
• Add setup store persisted state (returned refs only) (7324490)

🏡 Chore

• Upgrade dependencies (52e879c)

❤️ Contributors

• Prazdevs (@prazdevs)

v4.3.0

compare changes

🚀 Enhancements

• nuxt: Add encode/decode to cookies options (f377002)

🩹 Fixes

• Type aware rules (0a62a72)

📖 Documentation

• Add limitations regarding Cookies and Cloudflare Workers (#370)
• Remove references to deprecated option syntax store declaration (fde3b95)
• Add contributing guide (fbeaf90)

🏡 Chore

• ⚠️ Upgrade dependencies + pinia@3 (ceac678)
• Update dependencies (40eddb2)

🤖 CI

• Prepare before linting (8c6ae57)

⚠️ Breaking Changes

• ⚠️ Upgrade dependencies + pinia@3 (ceac678)

❤️ Contributors

• Prazdevs (@prazdevs)
• Ian Jamieson i@njamieson.co.uk

v4.2.0

compare changes

🚀 Enhancements

• nuxt: Infer global cookieOptions to specified cookie storage without options (3c55848)
• nuxt: Explicit Nuxt plugin name (pinia-plugin-persistedstate) (a0a4c51)

🩹 Fixes

• nuxt: Check @pinia/nuxt module installation by pinia key (#359)

🏡 Chore

• Bump dependencies (incl. pinia^2.3.0 & @pinia/nuxt^0.9.0) (c71d618)

❤️ Contributors

• Prazdevs (@prazdevs)
• Donald Shtjefni (@dnldsht)

v4.1.3

compare changes

📖 Documentation

• Fix the afterHydrate describe (#350)
• Fix install script groups (2bd0f25)

📦 Build

• Bundle iife and umd with rollup (fcad302)

🏡 Chore

• Bump dependencies (76df472)

❤️ Contributors

• Prazdevs (@prazdevs)
• Erian (@catcoal)

v4.1.2

compare changes

📖 Documentation

• Add Chinese translation (#338)
• Add cookie max size info (#343)

📦 Build

• Export iife build (#349)

🏡 Chore

• Bump dependencies & lint (3418005)

❤️ Contributors

• Prazdevs (@prazdevs)
• Chong Li (@TIX007)

v4.1.1

compare changes

🩹 Fixes

• Bump deep-pick-omit to 1.2.1 (fixes falsy value persistence) (7be6b42)

❤️ Contributors

• Prazdevs (@prazdevs)

v4.1.0

compare changes

🚀 Enhancements

• Auto mode (#327)

📖 Documentation

• Update Nuxt links in README.md (#340)

🏡 Chore

• Upgrade dependencies (e1c0036)

❤️ Contributors

• Prazdevs (@prazdevs)
• Charlie ✨ (@MIGU-EDU)

v4.0.2

compare changes

🩹 Fixes

• Infer CookieStorageOptions from @nuxt/schema rather than nuxt/schema (9e77053)
• nuxt: Avoid calling runWithContext (#334)

📖 Documentation

• Improve readability (code group icons + code titles) (13b6332)

🏡 Chore

• Upgrade dependencies (ba8cd49)
• Upgrade dependencies (c2ae5a0)

❤️ Contributors

• Prazdevs (@prazdevs)

v4.0.1

compare changes

🩹 Fixes

• Augment @nuxt/schema rather than nuxt/schema (#330)

📖 Documentation

• Add group icon plugin (#329)

❤️ Contributors

• Daniel Roe (@danielroe)
• Leo (@yuyinws)

v4.0.0

🚀 Enhancements

• Support excluding paths from persistence with omit option
• Support autocompletion for dot-notation paths in pick and omit options
• ⚠️ Rehydrate only picked/omitted paths (when specified) instead of the whole state
• ⚠️ Drop global beforeRestore and afterRestore options
• ⚠️ Drop auto mode
• nuxt: Include Nuxt module in the base package
• nuxt: Add global key option using template string

🔥 Performance

• Deserialize with destr instead of JSON.parse

🩹 Fixes

• nuxt: Improve SSR handling and store hdyration/persistence behavior in route middleware

💅 Refactors

• ⚠️ Rename paths option to pick
• ⚠️ Rename beforeRestore and afterRestore options to beforeHydrate and afterHydrate
• nuxt: ⚠️ Rename auto-imported storage object to piniaPluginPersistedstate
• nuxt: ⚠️ Rename Nuxt config option key to piniaPluginPersistedstate

📖 Documentation

• Rewrite documentation to match v4 API
• Add references and links to Nuxt-specific details and implementations

📦 Build

• Build standalone from Nuxt module's runtime

🎨 Styles

• Add a new identity and logo to the project

⚠️ Breaking Changes

• ⚠️ Rehydrate only picked/omitted paths (when specified) instead of the whole state
• ⚠️ Drop global beforeRestore and afterRestore options
• ⚠️ Drop auto mode
• ⚠️ Rename paths option to pick
• ⚠️ Rename beforeRestore and afterRestore options to beforeHydrate and afterHydrate
• nuxt: ⚠️ Rename auto-imported storage object to piniaPluginPersistedstate
• nuxt: ⚠️ Rename Nuxt config option key to piniaPluginPersistedstate

❤️ Contributors

• Prazdevs (@prazdevs)

---

For changes prior to v4, please refer to the GitHub Releases