feat: Migrations regarding higher kinded mutators for v4

[devanshj]

(#715 branch renamed)

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 1ef2049:

Sandbox	Source
React	Configuration
React Typescript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
React Parcel	Configuration
Next.js	Configuration

[devanshj]

In #715 you reviewed and finally we were going to remove PartialState, StateSliceListener and Destroy. Let's keep Destroy just to be consistent as we have types for all other keys of store.

[dai-shi]

Looks like a good migration path!

[dai-shi]

So, this looks almost ready.
Can you fix remaining issues and CI?

[dai-shi]

Okay, I'm merging this for v3.7.0. If we have more ideas for migration paths, we can release patch versions v3.7.x.

[devanshj]

Okay, I'm merging this for v3.7.0. If we have more ideas for migration paths, we can release patch versions v3.7.x.

If you're in a hurry go for it otherwise I was about to deprecate other middleware store types in favor Mutate too, we're already deprecating for subscribeWithSelector so it'd be nice if we do it for other middlewares too in one release itself.

[dai-shi]

If you're in a hurry go for it otherwise I was about to deprecate other middleware store types in favor Mutate too, we're already deprecating for subscribeWithSelector so it'd be nice if we do it for other middlewares too in one release itself.

Oh, I thought it's impossible.
It would be nice if you can. I'll wait for it.

[devanshj]

Right now the deprecation message is this...

/**
 * @deprecated Use `Mutate<StoreApi<T>, [["zustand/subscribeWithSelector", never]]>`.
 * If you have multiple middlewares see the documentation for `Mutate` usage.
 */

I think we need to educate users how to use Mutate for multiple middlewares (see tests), should we do it in the readme? Or in the release notes? (in which case I'd replace "documentation" with "release notes for v3.7.0")

And I think we should also mention this is for an easier migration to v4.

[dai-shi]

yeah, we should write it in release notes (i don't plan to change readme for this.)
if you have a suggestion how to write in the release notes please let me know your draft.

And it may sound crazy, but in the @deprecated message, let's say "See tests/middlewareTypes.test.tsx" and would you modify multiple middleware usage there?

[devanshj]

And it may sound crazy, but in the @deprecated message, let's say "See tests/middlewareTypes.test.tsx" and would you modify multiple middleware usage there?

I'd be fine with that, the readme also anyway tells users to refer to the test file regarding middleware types, so it's not a big deal I guess. And I already have migrated the all tests (including ones with multiple middlewares) to Mutate.

[dai-shi]

Cool. I'm already pretty happy with this version.

Please follow the coding convention and fix conflicts, and we should be good to go!

[dai-shi]

Looks great! Let's ship it.