Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Support for Zustand 4.5.0+ and Introduce Mutative Middleware #92

Merged
merged 28 commits into from
Jan 5, 2025

Conversation

imarabinda
Copy link
Collaborator

@imarabinda imarabinda commented Jan 5, 2025

Description

This PR addresses the compatibility issue with zustand version 4.5.0 and above. It includes the following updates:

  • 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.

    const store = createStore(
    () => ({
        name: 'zustandX',
        stars: 0,
    }),
    {
        name: 'repo',
        immer: true,
    }
    );

    or

    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.

    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:

    const store = createStore(
    middlewareWrapHere(() => ({
        name: 'zustandX',
        stars: 0,
    })),
    {
        name: 'repo',
        immer: true,
    }
    );

Copy link

changeset-bot bot commented Jan 5, 2025

🦋 Changeset detected

Latest commit: 2fa1da9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
zustand-x Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@zbeyens
Copy link
Member

zbeyens commented Jan 5, 2025

Awesome! I'll let you add the major changeset, then I'll release this.

@zbeyens
Copy link
Member

zbeyens commented Jan 5, 2025

Just need to fix the CI now.

@imarabinda
Copy link
Collaborator Author

@zbeyens can you start the last workflow?

@zbeyens
Copy link
Member

zbeyens commented Jan 5, 2025

Thanks!

@zbeyens zbeyens merged commit 91f56e1 into udecode:main Jan 5, 2025
1 check passed
Comment on lines +18 to +20
set: TStoreApiSet<StateType, Mutators, TActions>,
get: TStoreApiGet<StateType, Mutators, TSelectors>,
api: TStateApiForBuilder<StateType, Mutators, TActions, TSelectors>
Copy link
Member

@zbeyens zbeyens Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@imarabinda README has extendSelectors((state, get, api), should we update it and add the missing breaking change in the changelog?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants