Merge pull request #93 from udecode/changeset-release/main

[Release] Version packages

packages/zustand-x/CHANGELOG.md

@@ -1,5 +1,79 @@
 # @udecode/zustood
 
+## 5.0.0
+
+### Major Changes
+
+- [#92](https://github.com/udecode/zustand-x/pull/92) by [@imarabinda](https://github.com/imarabinda) –
+
+  - Added support for Zustand 4.5.0+.
+  - `mutative` support. Pass `mutative: true` in the options.
+
+  ## Migration Instructions
+
+  Update the Store Initialization:
+
+  1. Replace the old method of initializing the store with the new API.
+
+     ```tsx
+     const store = createStore(
+       () => ({
+         name: 'zustandX',
+         stars: 0,
+       }),
+       {
+         name: 'repo',
+         immer: true,
+       }
+     );
+     ```
+
+     or
+
+     ```tsx
+     const store = createStore(
+       {
+         name: 'zustandX',
+         stars: 0,
+       },
+       {
+         name: 'repo',
+         immer: true,
+       }
+     );
+     ```
+
+  2. Ensure to pass the configuration object with name and other options as needed.
+  3. If your application relies on immer, enable it by passing immer: true in the configuration object.
+
+     ```tsx
+     const store = createStore(
+       () => ({
+         name: 'zustandX',
+         stars: 0,
+       }),
+       {
+         name: 'repo',
+         immer: true,
+       }
+     );
+     ```
+
+  4. With the new version, integrating middlewares has also changed. Here's how to upgrade your middleware usage:
+
+     ```tsx
+     const store = createStore(
+       middlewareWrapHere(() => ({
+         name: 'zustandX',
+         stars: 0,
+       })),
+       {
+         name: 'repo',
+         immer: true,
+       }
+     );
+     ```
+
 ## 3.0.4
 
 ### Patch Changes

packages/zustand-x/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zustand-x",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "Zustand store factory for a best-in-class developer experience.",
   "license": "MIT",
   "homepage": "https://zustand-x.udecode.dev",