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.

Sign up for GitHub

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

Jump to bottom

fix(deps): update dependency @reduxjs/toolkit to v2 #5008

Merged
merged 3 commits into from
Mar 4, 2024
Merged

fix(deps): update dependency @reduxjs/toolkit to v2 #5008

merged 3 commits into from
Mar 4, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 29, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@reduxjs/toolkit (source) ^1.9.7 -> ^2.2.1 age adoption passing confidence

Release Notes

reduxjs/redux-toolkit (@​reduxjs/toolkit)

v2.2.1

Compare Source

v2.2.0

Compare Source

This minor release:

  • Adds a second parameter to entityAdapter.getInitialState(additionalProps, entities) to allow prefilling state
    • Equivalent to entityAdapter.setAll(entityAdapter.getInitialState(additionalProps), entities)
    • First parameter can be undefined if no additional properties are desired
  • Allows initialising combineSlices with no static reducers
    • Previously const combinedReducer = combineSlices().withLazyLoadedSlices<LazyLoadedSlices>() would have thrown an error
    • Now returns a "no-op" reducer that just returns an empty object until first reducer injected
  • Allows a new 'throw' value for overrideExisting in injectEndpoints, which throws an error if a definition is injected with a name which is already used
  • Exports more type helpers for RTKQ hook and trigger types
  • Exports types related to overriding result types in enhanceEndpoints
  • Fixes state inference for injected slices when undeclared (i.e. not in LazyLoadedSlices)
  • Adds a action.meta.arg.isPrefetch value to query thunk actions when prefetched

What's Changed

New Contributors

Full Changelog: reduxjs/redux-toolkit@v2.1.0...v2.2.0

v2.1.0

Compare Source

This minor release:

  • adds withTypes methods to listenerMiddleware and createDraftSafeSelector
  • adds a skipPollingIfUnfocused option to RTK Query
  • adds the ability to customise the createSelector instance used by RTK Query
  • reworks slice selector logic to avoid depending on this value
  • fixes the order and inference of create.asyncThunk type parameters
  • fixes requirements for meta fields returned from queryFns
  • marks promises that will never reject as safe, in preparation for https://github.com/typescript-eslint/typescript-eslint/issues/7008

What's Changed

New Contributors

Full Changelog: reduxjs/redux-toolkit@v2.0.1...v2.1.0

v2.0.1

Compare Source

v2.0.0

Compare Source

This major release :

  • Removes the deprecated object syntax from createSlice and createReducer
  • Removes other deprecated options
  • Updates the middleware and enhancers options of configureStore to require callbacks
  • Updates the packaging for better ESM/CJS compatibility and modernizes the build output
  • Includes all changes to Redux core 5.0, Reselect 5.0, and Redux Thunk 3.0
  • Updates RTKQ default subscription behavior
  • Adds a new combineSlices method with support for lazy-loading slice reducers
  • Adds a new "dynamic middleware" middleware with support for adding middleware at runtime
  • Adds a new callback syntax to createSlice.reducers, with optional support for defining thunks inside of createSlice
  • Adds the autoBatchEnhancer to configureStore by default
  • Has many additional TS tweaks and improvements

This release has breaking changes. (Note: v2.0.1 was released with a couple hotfixes for Reselect and Redux Thunk right as this was being finalized.)

This release is part of a wave of major versions of all the Redux packages: Redux Toolkit 2.0, Redux core 5.0, React-Redux 9.0, Reselect 5.0, and Redux Thunk 3.0.

For full details on all of the breaking changes and other significant changes to all of those packages, see the "Migrating to RTK 2.0 and Redux 5.0" migration guide in the Redux docs.

[!NOTE]
The Redux core, Reselect, and Redux Thunk packages are included as part of Redux Toolkit, and RTK users do not need to manually upgrade them - you'll get them as part of the upgrade to RTK 2.0. (If you're not using Redux Toolkit yet, please start migrating your existing legacy Redux code to use Redux Toolkit today!)

##### RTK
npm install @&#8203;reduxjs/toolkit
yarn add @&#8203;reduxjs/toolkit
Changelog
Object syntax for createSlice.extraReducers and createReducer removed

RTK's createReducer API was originally designed to accept a lookup table of action type strings to case reducers, like { "ADD_TODO": (state, action) => {} }. We later added the "builder callback" form to allow more flexibility in adding "matchers" and a default handler, and did the same for createSlice.extraReducers.

We have removed the "object" form for both createReducer and createSlice.extraReducers in RTK 2.0, as the builder callback form is effectively the same number of lines of code, and works much better with TypeScript.

As an example, this:

const todoAdded = createAction('todos/todoAdded')

createReducer(initialState, {
  [todoAdded]: (state, action) => {},
})

createSlice({
  name,
  initialState,
  reducers: {
    /* case reducers here */
  },
  extraReducers: {
    [todoAdded]: (state, action) => {},
  },
})

should be migrated to:

createReducer(initialState, (builder) => {
  builder.addCase(todoAdded, (state, action) => {})
})

createSlice({
  name,
  initialState,
  reducers: {
    /* case reducers here */
  },
  extraReducers: (builder) => {
    builder.addCase(todoAdded, (state, action) => {})
  },
})
Codemods

To simplify upgrading codebases, we've published a set of codemods that will automatically transform the deprecated "object" syntax into the equivalent "builder" syntax.

The codemods package is available on NPM as @reduxjs/rtk-codemods. More details are available here.

To run the codemods against your codebase, run npx @&#8203;reduxjs/rtk-codemods <TRANSFORM NAME> path/of/files/ or/some**/*glob.js.

Examples:

npx @&#8203;reduxjs/rtk-codemods createReducerBuilder ./src

npx @&#8203;reduxjs/rtk-codemods createSliceBuilder ./packages/my-app/**/*.ts

We also recommend re-running Prettier on the codebase before committing the changes.

These codemods should work, but we would greatly appreciate feedback from more real-world codebases!

configureStore Options Changes
configureStore.middleware must be a callback

Since the beginning, configureStore has accepted a direct array value as the middleware option. However, providing an array directly prevents configureStore from calling getDefaultMiddleware(). So, middleware: [myMiddleware] means there is no thunk middleware added (or any of the dev-mode checks).

This is a footgun, and we've had numerous users accidentally do this and cause their apps to fail because the default middleware never got configured.

As a result, we've now made the middleware only accept the callback form. If for some reason you still want to replace all of the built-in middleware, do so by returning an array from the callback:

const store = configureStore({
  reducer,
  middleware: (getDefaultMiddleware) => {
    // WARNING: this means that _none_ of the default middleware are added!
    return [myMiddleware]
    // or for TS users, use:
    // return new Tuple(myMiddleware)
  },
})

But note that we consistently recommend not replacing the default middleware entirely, and that you should use return getDefaultMiddleware().concat(myMiddleware).

configureStore.enhancers must be a callback

Similarly to configureStore.middleware, the enhancers field must also be a callback, for the same reasons.

The callback will receive a getDefaultEnhancers function that can be used to customise the batching enhancer that's now included by default.

For example:

const store = configureStore({
  reducer,
  enhancers: (getDefaultEnhancers) => {
    return getDefaultEnhancers({
      autoBatch: { type: 'tick' },
    }).concat(myEnhancer)
  },
})

It's important to note that the result of getDefaultEnhancers will also contain the middleware enhancer created with any configured/default middleware. To help prevent mistakes, configureStore will log an error to console if middleware was provided and the middleware enhancer wasn't included in the callback result.

const store = configureStore({
  reducer,
  enhancers: (getDefaultEnhancers) => {
    return [myEnhancer] // we've lost the  middleware here
    // instead:
    return getDefaultEnhancers().concat(myEnhancer)
  },
})

Also, note that if you supply the enhancers field, it must come after the middleware field in order for TS inference to work properly.

Standalone getDefaultMiddleware and getType removed

The standalone version of getDefaultMiddleware has been deprecated since v1.6.1, and has now been removed. Use the function passed to the middleware callback instead, which has the correct types.

We have also removed the getType export, which was used to extract a type string from action creators made with createAction. Instead, use the static property actionCreator.type.

RTK Query behaviour changes

We've had a number of reports where RTK Query had issues around usage of dispatch(endpoint.initiate(arg, {subscription: false})). There were also reports that multiple triggered lazy queries were resolving the promises at the wrong time. Both of these had the same underlying issue, which was that RTKQ wasn't tracking cache entries in these cases (intentionally). We've reworked the logic to always track cache entries (and remove them as needed), which should resolve those behavior issues.

We also have had issues raised about trying to run multiple mutations in a row and how tag invalidation behaves. RTKQ now has internal logic to delay tag invalidation briefly, to allow multiple invalidations to get handled together. This is controlled by a new invalidationBehavior: 'immediate' | 'delayed' flag on createApi. The new default behavior is 'delayed'. Set it to 'immediate' to revert to the behavior in RTK 1.9.

In RTK 1.9, we reworked RTK Query's internals to keep most of the subscription status inside the RTKQ middleware. The values are still synced to the Redux store state, but this is primarily for display by the Redux DevTools "RTK Query" panel. Related to the cache entry changes above, we've optimized how often those values get synced to the Redux state for perf.

ESM/CJS Package Compatibility

The biggest theme of the Redux v5 and RTK 2.0 releases is trying to get "true" ESM package publishing compatibility in place, while still supporting CJS in the published package.

The primary build artifact is now an ESM file, dist/redux-toolkit.modern.mjs. Most build tools should pick this up. There's also a CJS artifact, and a second copy of the ESM file named redux-toolkit.legacy-esm.js to support Webpack 4 (which does not recognize the exports field in package.json). Additionally, all of the build artifacts now live under ./dist/ in the published package.

Modernized Build Output

We now publish modern JS syntax targeting ES2020, including optional chaining, object spread, and other modern syntax. If you need to

Build Tooling

We're now building the package using https://github.com/egoist/tsup. We also now include sourcemaps for the ESM and CJS artifacts.

Dropping UMD Builds

Redux has always shipped with UMD build artifacts. These are primarily meant for direct import as script tags, such as in a CodePen or a no-bundler build environment.

We've dropped those build artifacts from the published package, on the grounds that the use cases seem pretty rare today.

There's now a redux-toolkit.browser.mjs file in the package that can be loaded from a CDN like Unpkg.

If you have strong use cases for us continuing to include UMD build artifacts, please let us know!

Dependency Updates
Redux Libraries

RTK now depends on Redux core 5.0, Reselect 5.0, and Redux Thunk 3.0. See the linked release notes for those libraries, as each of them has additional breaking changes. The "Migrating to RTK 2.0 and Redux 5.0" docs page also covers the combined changes in one page

Immer 10

RTK now also depends on Immer 10.0, which has several major improvements and updates:

  • Much faster update perf
  • Much smaller bundle size
  • Better ESM/CJS package formatting
  • No default export
  • No ES5 fallback

We've also removed the prior call to automatically enable the Immer ES5 fallback mode any time RTK was loaded.

Other Changes
Bundle Size Optimizations

Redux 4.1.0 optimized its bundle size by extracting error message strings out of production builds, based on React's approach. We've applied the same technique to RTK. This saves about 1000 bytes from prod bundles (actual benefits will depend on which imports are being used).

We also noted that ESBuild does not deduplicate imports when it bundles source files, and this was causing RTK Query's bundle to contain a dozen references to import { } from "@&#8203;reduxjs/toolkit", including some of the same methods. Manually deduplicating those saves about 600 bytes off the production RTKQ artifact.

reactHooksModule custom hook configuration

Previously, custom versions of React Redux's hooks (useSelector, useDispatch, and useStore) could be passed separately to reactHooksModule, usually to enable using a different context to the default ReactReduxContext.

In practicality, the react hooks module needs all three of these hooks to be provided, and it became an easy mistake to only pass useSelector and useDispatch, without useStore.

The module has now moved all three of these under the same configuration key, and will check that all three are provided if the key is present.

// previously
const customCreateApi = buildCreateApi(
  coreModule(),
  reactHooksModule({
    useDispatch: createDispatchHook(MyContext),
    useSelector: createSelectorHook(MyContext),
    useStore: createStoreHook(MyContext),
  })
)

// now
const customCreateApi = buildCreateApi(
  coreModule(),
  reactHooksModule({
    hooks: {
      useDispatch: createDispatchHook(MyContext),
      useSelector: createSelectorHook(MyContext),
      useStore: createStoreHook(MyContext),
    },
  })
)
Deprecated Options Removed

Several other options were previously marked as deprecated, and have been removed. We've also removed polyfills like the AbortController polyfill.

TypeScript Changes
configureStore field order for middleware matters

If you are passing both the middleware and enhancers fields to configureStore, the middleware field must come first in order for internal TS inference to work properly.

Non-default middleware/enhancers must use Tuple

We've seen many cases where users passing the middleware parameter to configureStore have tried spreading the array returned by getDefaultMiddleware(), or passed an alternate plain array. This unfortunately loses the exact TS types from the individual middleware, and often causes TS problems down the road (such as dispatch being typed as Dispatch<AnyAction> and not knowing about thunks).

getDefaultMiddleware() already used an internal MiddlewareArray class, an Array subclass that had strongly typed .concat/prepend() methods to correctly capture and retain the middleware types.

We've renamed that type to Tuple, and configureStore's TS types now require that you must use Tuple if you want to pass your own array of middleware:

import { configureStore, Tuple } from '@&#8203;reduxjs/toolkit'

configureStore({
  reducer: rootReducer,
  middleware: (getDefaultMiddleware) => new Tuple(additionalMiddleware, logger),
})

(Note that this has no effect if you're using RTK with plain JS, and you could still pass a plain array here.)

This same restriction applies to the enhancers field.

Entity adapter type updates

createEntityAdapter now has an Id generic argument, which will be used to strongly type the item IDs anywhere those are exposed. Previously, the ID field type was always string | number. TS will now try to infer the exact type from either the .id field of your entity type, or the selectId return type. You could also fall back to passing that generic type directly. If you use the EntityState<Data, Id> type directly, you must supply both generic arguments!

The .entities lookup table is now defined to use a standard TS Record<Id, MyEntityType>, which assumes that each item lookup exists by default. Previously, it used a Dictionary<MyEntityType> type, which assumed the result was MyEntityType | undefined. The Dictionary type has been removed.

If you prefer to assume that the lookups might be undefined, use TypeScript's noUncheckedIndexedAccess configuration option to control that.

New Features

These features are new in Redux Toolkit 2.0, and help cover additional use cases that we've seen users ask for in the ecosystem.

combineSlices API with slice reducer injection for code-splitting

The Redux core has always included combineReducers, which takes an object full of "slice reducer" functions and generates a reducer that calls those slice reducers. RTK's createSlice generates slice reducers + associated action creators, and we've taught the pattern of exporting individual action creators as named exports and the slice reducer as a default export. Meanwhile, we've never had official support for lazy-loading reducers, although we've had sample code for some "reducer injection" patterns in our docs.

This release includes a new combineSlices API that is designed to enable lazy-loading of reducers at runtime. It accepts individual slices or an object full of slices as arguments, and automatically calls combineReducers using the sliceObject.name field as the key for each state field. The generated reducer function has an additional .inject() method attached that can be used to dynamically inject additional slices at runtime. It also includes a .withLazyLoadedSlices() method that can be used to generate TS types for reducers that will be added later. See #​2776 for the original discussion around this idea.

For now, we are not building this into configureStore, so you'll need to call const rootReducer = combineSlices(.....) yourself and pass that to configureStore({reducer: rootReducer}).

Basic usage: a mixture of slices and standalone reducers passed to combineSlices

const stringSlice = createSlice({
  name: 'string',
  initialState: '',
  reducers: {},
})

const numberSlice = createSlice({
  name: 'number',
  initialState: 0,
  reducers: {},
})

const booleanReducer = createReducer(false, () => {})

const api = createApi(/*  */)

const combinedReducer = combineSlices(
  stringSlice,
  {
    num: numberSlice.reducer,
    boolean: booleanReducer,
  },
  api
)
expect(combinedReducer(undefined, dummyAction())).toEqual({
  string: stringSlice.getInitialState(),
  num: numberSlice.getInitialState(),
  boolean: booleanReducer.getInitialState(),
  api: api.reducer.getInitialState(),
})

Basic slice reducer injection

// Create a reducer with a TS type that knows `numberSlice` will be injected
const combinedReducer =
  combineSlices(stringSlice).withLazyLoadedSlices<
    WithSlice<typeof numberSlice>
  >()

// `state.number` doesn't exist initially
expect(combinedReducer(undefined, dummyAction()).number).toBe(undefined)

// Create a version of the reducer with `numberSlice` injected (mainly useful for types)
const injectedReducer = combinedReducer.inject(numberSlice)

// `state.number` now exists, and injectedReducer's type no longer marks it as optional
expect(injectedReducer(undefined, dummyAction()).number).toBe(
  numberSlice.getInitialState()
)

// original reducer has also been changed (type is still optional)
expect(combinedReducer(undefined, dummyAction()).number).toBe(
  numberSlice.getInitialState()
)
selectors field in createSlice

The existing createSlice API now has support for defining selectors directly as part of the slice. By default, these will be generated with the assumption that the slice is mounted in the root state using slice.name as the field, such as name: "todos" -> rootState.todos. Additionally, there's now a slice.selectSlice method that does that default root state lookup.

You can call sliceObject.getSelectors(selectSliceState) to generate the selectors with an alternate location, similar to how entityAdapter.getSelectors() works.

const slice = createSlice({
  name: 'counter',
  initialState: 42,
  reducers: {},
  selectors: {
    selectSlice: (state) => state,
    selectMultiple: (state, multiplier: number) => state * multiplier,
  },
})

// Basic usage
const testState = {
  [slice.name]: slice.getInitialState(),
}
const { selectSlice, selectMultiple } = slice.selectors
expect(selectSlice(testState)).toBe(slice.getInitialState())
expect(selectMultiple(testState, 2)).toBe(slice.getInitialState() * 2)

// Usage with the slice reducer mounted under a different key
const customState = {
  number: slice.getInitialState(),
}
const { selectSlice, selectMultiple } = slice.getSelectors(
  (state: typeof customState) => state.number
)
expect(selectSlice(customState)).toBe(slice.getInitialState())
expect(selectMultiple(customState, 2)).toBe(slice.getInitialState() * 2)
createSlice.reducers callback syntax and thunk support

One of the oldest feature requests we've had is the ability to declare thunks directly inside of createSlice. Until now, you've always had to declare them separately, give the thunk a string action prefix, and handle the actions via createSlice.extraReducers:

// Declare the thunk separately
const fetchUserById = createAsyncThunk(
  'users/fetchByIdStatus',
  async (userId: number, thunkAPI) => {
    const response = await userAPI.fetchById(userId)
    return response.data
  }
)

const usersSlice = createSlice({
  name: 'users',
  initialState,
  reducers: {
    // standard reducer logic, with auto-generated action types per reducer
  },
  extraReducers: (builder) => {
    // Add reducers for additional action types here, and handle loading state as needed
    builder.addCase(fetchUserById.fulfilled, (state, action) => {
      state.entities.push(action.payload)
    })
  },
})

Many users have told us that this separation feels awkward.

We've wanted to include a way to define thunks directly inside of createSlice, and have played around with various prototypes. There were always two major blocking issues, and a secondary concern:

  1. It wasn't clear what the syntax for declaring a thunk inside should look like.
  2. Thunks have access to getState and dispatch, but the RootState and AppDispatch types are normally inferred from the store, which in turn infers it from the slice state types. Declaring thunks inside createSlice would cause circular type inference errors, as the store needs the slice types but the slice needs the store types. We weren't willing to ship an API that would work okay for our JS users but not for our TS users, especially since we want people to use TS with RTK.
  3. You can't do synchronous conditional imports in ES modules, and there's no good way to make the createAsyncThunk import optional. Either createSlice always depends on it (and adds that to the bundle size), or it can't use createAsyncThunk at all.

We've settled on these compromises:

  • In order to create async thunks with createSlice, you specifically need to set up a custom version of createSlice that has access to createAsyncThunk.
  • You can declare thunks inside of createSlice.reducers, by using a "creator callback" syntax for the reducers field that is similar to the build callback syntax in RTK Query's createApi (using typed functions to create fields in an object). Doing this does look a bit different than the existing "object" syntax for the reducers field, but is still fairly similar.
  • You can customize some of the types for thunks inside of createSlice, but you cannot customize the state or dispatch types. If those are needed, you can manually do an as cast, like getState() as RootState.

In practice, we hope these are reasonable tradeoffs. Creating thunks inside of createSlice has been widely asked for, so we think it's an API that will see usage. If the TS customization options are a limitation, you can still declare thunks outside of createSlice as always, and most async thunks don't need dispatch or getState - they just fetch data and return. And finally, setting up a custom createSlice allows you to opt into createAsyncThunk being included in your bundle size (though it may already be included if used directly or as part of RTK Query - in either of these cases there's no additional bundle size).

Here's what the new callback syntax looks like:

const createSliceWithThunks = buildCreateSlice({
  creators: { asyncThunk: asyncThunkCreator },
})

const todosSlice = createSliceWithThunks({
  name: 'todos',
  initialState: {
    loading: false,
    todos: [],
    error: null,
  } as TodoState,
  reducers: (create) => ({
    // A normal "case reducer", same as always
    deleteTodo: create.reducer((state, action: PayloadAction<number>) => {
      state.todos.splice(action.payload, 1)
    }),
    // A case reducer with a "prepare callback" to customize the action
    addTodo: create.preparedReducer(
      (text: string) => {
        const id = nanoid()
        return { payload: { id, text } }
      },
      // action type is inferred from prepare callback
      (state, action) => {
        state.todos.push(action.payload)
      }
    ),
    // An async thunk
    fetchTodo: create.asyncThunk(
      // Async payload function as the first argument
      async (id: string, thunkApi) => {
        const res = await fetch(`myApi/todos?id=${id}`)
        return (await res.json()) as Item
      },
      // An object containing `{pending?, rejected?, fulfilled?, settled?, options?}` second
      {
        pending: (state) => {
          state.loading = true
        },
        rejected: (state, action) => {
          state.error = action.payload ?? action.error
        },
        fulfilled: (state, action) => {
          state.todos.push(action.payload)
        },
        // settled is called for both rejected and fulfilled actions
        settled: (state, action) => {
          state.loading = false
        },
      }
    ),
  }),
})

// `addTodo` and `deleteTodo` are normal action creators.
// `fetchTodo` is the async thunk
export const { addTodo, deleteTodo, fetchTodo } = todosSlice.actions
Codemod

Using the new callback syntax is entirely optional (the object syntax is still standard), but an existing slice would need to be converted before it can take advantage of the new capabilities this syntax provides. To make this easier, a codemod is provided.

npx @&#8203;reduxjs/rtk-codemods createSliceReducerBuilder ./src/features/todos/slice.ts
"Dynamic middleware" middleware

A Redux store's middleware pipeline is fixed at store creation time and can't be changed later. We have seen ecosystem libraries that tried to allow dynamically adding and removing middleware, potentially useful for things like code splitting.

This is a relatively niche use case, but we've built our own version of a "dynamic middleware" middleware. Add it to the Redux store at setup time, and it lets you add middleware later at runtime. It also comes with a React hook integration that will automatically add a middleware to the store and return the updated dispatch method..

import { createDynamicMiddleware, configureStore } from '@&#8203;reduxjs/toolkit'

const dynamicMiddleware = createDynamicMiddleware()

const store = configureStore({
  reducer: {
    todos: todosReducer,
  },
  middleware: (getDefaultMiddleware) =>
    getDefaultMiddleware().prepend(dynamicMiddleware.middleware),
})

// later
dynamicMiddleware.addMiddleware(someOtherMiddleware)
configureStore adds autoBatchEnhancer by default

In v1.9.0, we added a new autoBatchEnhancer that delays notifying subscribers briefly when multiple "low-priority" actions are dispatched in a row. This improves perf, as UI updates are typically the most expensive part of the update process. RTK Query marks most of its own internal actions as "low-pri" by default, but you have to have the autoBatchEnhancer added to the store to benefit from that.

We've updated configureStore to add the autoBatchEnhancer to the store setup by default, so that users can benefit from the improved perf without needing to manually tweak the store config themselves.

entityAdapter.getSelectors accepts a createSelector function

entityAdapter.getSelectors() now accepts an options object as its second argument. This allows you to pass in your own preferred createSelector method, which will be used to memoize the generated selectors. This could be useful if you want to use one of Reselect's new alternate memoizers, or some other memoization library with an equivalent signature.

Next.js Setup Guide

We now have a docs page that covers how to set up Redux properly with Next.js. We've seen a lot of questions around using Redux, Next, and the App Router together, and this guide should help provide advice.

(At this time, the Next.js with-redux example is still showing outdated patterns - we're going to file a PR shortly to update that to match our docs guide.)

What's Changed

Configuration

📅 Schedule: Branch creation - "after 5pm,every weekend" in timezone America/Los_Angeles, Automerge - "after 5pm,every weekend" in timezone America/Los_Angeles.

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot enabled auto-merge (squash) February 29, 2024 07:31
@renovate renovate bot force-pushed the renovate/reduxjs-toolkit-2.x branch 6 times, most recently from 0c1365d to 2e7d70c Compare February 29, 2024 23:52
auto-merge was automatically disabled February 29, 2024 23:53

Merge queue setting changed

@renovate renovate bot force-pushed the renovate/reduxjs-toolkit-2.x branch 9 times, most recently from 17ffc9f to af90f29 Compare March 4, 2024 08:39
@renovate renovate bot force-pushed the renovate/reduxjs-toolkit-2.x branch from af90f29 to 61a64de Compare March 4, 2024 11:12
@renovate Renovate
Copy link
Contributor Author

renovate bot commented Mar 4, 2024

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠ Warning: custom changes will be lost.

@codecov Codecov
Copy link

codecov bot commented Mar 4, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 96.55172% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 85.50%. Comparing base (d9f005e) to head (5b52e63).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5008      +/-   ##
==========================================
- Coverage   85.51%   85.50%   -0.01%     
==========================================
  Files         724      724              
  Lines       29553    29562       +9     
  Branches     5104     5108       +4     
==========================================
+ Hits        25272    25278       +6     
- Misses       4043     4046       +3     
  Partials      238      238
Files Coverage Δ
src/account/reducer.ts 41.81% <100.00%> (ø)
src/alert/reducer.ts 70.00% <ø> (ø)
src/app/reducers.ts 22.82% <ø> (ø)
src/dapps/slice.ts 26.19% <ø> (ø)
src/escrow/reducer.ts 62.96% <100.00%> (+4.62%) ⬆️
src/exchange/reducer.ts 40.90% <ø> (ø)
src/fees/reducer.ts 75.00% <100.00%> (ø)
src/fiatExchanges/quotes/FiatConnectQuote.ts 100.00% <ø> (ø)
src/fiatExchanges/quotes/NormalizedQuote.ts 100.00% <ø> (ø)
src/fiatExchanges/reducer.ts 73.68% <100.00%> (+4.93%) ⬆️
... and 20 more

... and 2 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d9f005e...5b52e63. Read the comment docs.

@jeanregisser jeanregisser added this pull request to the merge queue Mar 4, 2024
Merged via the queue into main with commit 78719f2 Mar 4, 2024
16 checks passed
@jeanregisser jeanregisser deleted the renovate/reduxjs-toolkit-2.x branch March 4, 2024 14:21
shottah pushed a commit to zed-io/kolektivo that referenced this pull request May 15, 2024
@renovate @jeanregisser @shottah
fix(deps): update dependency @reduxjs/toolkit to v2 (valora-inc#5008)
e10f6d1 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@reduxjs/toolkit](https://redux-toolkit.js.org)
([source](https://togithub.com/reduxjs/redux-toolkit)) | [`^1.9.7` ->
`^2.2.1`](https://renovatebot.com/diffs/npm/@reduxjs%2ftoolkit/1.9.7/2.2.1)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/@reduxjs%2ftoolkit/2.2.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@reduxjs%2ftoolkit/2.2.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@reduxjs%2ftoolkit/1.9.7/2.2.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@reduxjs%2ftoolkit/1.9.7/2.2.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>reduxjs/redux-toolkit (@&#8203;reduxjs/toolkit)</summary>

###
[`v2.2.1`](https://togithub.com/reduxjs/redux-toolkit/compare/v2.2.0...v2.2.1)

[Compare
Source](https://togithub.com/reduxjs/redux-toolkit/compare/v2.2.0...v2.2.1)

###
[`v2.2.0`](https://togithub.com/reduxjs/redux-toolkit/releases/tag/v2.2.0)

[Compare
Source](https://togithub.com/reduxjs/redux-toolkit/compare/v2.1.0...v2.2.0)

This *minor release*:

- Adds a second parameter to
`entityAdapter.getInitialState(additionalProps, entities)` to allow
prefilling state
- Equivalent to
`entityAdapter.setAll(entityAdapter.getInitialState(additionalProps),
entities)`
- First parameter can be `undefined` if no additional properties are
desired
-   Allows initialising `combineSlices` with no static reducers
- Previously `const combinedReducer =
combineSlices().withLazyLoadedSlices<LazyLoadedSlices>()` would have
thrown an error
- Now returns a "no-op" reducer that just returns an empty object until
first reducer injected
- Allows a new `'throw'` value for `overrideExisting` in
`injectEndpoints`, which throws an error if a definition is injected
with a name which is already used
-   Exports more type helpers for RTKQ hook and trigger types
- Exports types related to overriding result types in `enhanceEndpoints`
- Fixes state inference for injected slices when undeclared (i.e. not in
`LazyLoadedSlices`)
- Adds a `action.meta.arg.isPrefetch` value to query thunk actions when
prefetched

#### What's Changed

- Revamp type tests setup by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4095](https://togithub.com/reduxjs/redux-toolkit/pull/4095)
- Bump Prettier and Prettier related packages by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4126](https://togithub.com/reduxjs/redux-toolkit/pull/4126)
- Fix codemods to work with TypeScript 4.7+ by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4081](https://togithub.com/reduxjs/redux-toolkit/pull/4081)
- Export types related to overriding the result types by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4134](https://togithub.com/reduxjs/redux-toolkit/pull/4134)
- Migrate type tests to Vitest by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4127](https://togithub.com/reduxjs/redux-toolkit/pull/4127)
- Fix RetryOptions type test by flipping order by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4136](https://togithub.com/reduxjs/redux-toolkit/pull/4136)
- Format all files by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4135](https://togithub.com/reduxjs/redux-toolkit/pull/4135)
- \[Docs/Website] skipPollingIfUnfocused added to polling overview and
query options by [@&#8203;riqts](https://togithub.com/riqts) in
[https://github.com/reduxjs/redux-toolkit/pull/4131](https://togithub.com/reduxjs/redux-toolkit/pull/4131)
- \[Docs] Changed create.asyncThunk setup admonition to caution by
[@&#8203;riqts](https://togithub.com/riqts) in
[https://github.com/reduxjs/redux-toolkit/pull/4150](https://togithub.com/reduxjs/redux-toolkit/pull/4150)
- Temporarily revert node-fetch bump until ESM issues are sorted by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4151](https://togithub.com/reduxjs/redux-toolkit/pull/4151)
- Contributing Markdown Refresh by
[@&#8203;itz-Me-Pj](https://togithub.com/itz-Me-Pj) in
[https://github.com/reduxjs/redux-toolkit/pull/4139](https://togithub.com/reduxjs/redux-toolkit/pull/4139)
- investigate re-adding size limit action by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4083](https://togithub.com/reduxjs/redux-toolkit/pull/4083)
- Add size limit imports for more commonly used RTK exports by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4155](https://togithub.com/reduxjs/redux-toolkit/pull/4155)
- pure some things by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4157](https://togithub.com/reduxjs/redux-toolkit/pull/4157)
- cut back on suffixes tested for size by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4160](https://togithub.com/reduxjs/redux-toolkit/pull/4160)
- Incorrect builder method referenced by
[@&#8203;kantbtrue](https://togithub.com/kantbtrue) in
[https://github.com/reduxjs/redux-toolkit/pull/4161](https://togithub.com/reduxjs/redux-toolkit/pull/4161)
- Rename `cli.js` to `cli.mjs` by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4169](https://togithub.com/reduxjs/redux-toolkit/pull/4169)
- Migrate Codegen OpenAPI's unit tests to Vitest by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4137](https://togithub.com/reduxjs/redux-toolkit/pull/4137)
- Fix wrong state for injected slices when not declared via
`withLazyLoadedSlices` by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4172](https://togithub.com/reduxjs/redux-toolkit/pull/4172)
- \[Docs, createEntityAdapter API]: add missing setOne and setMany
signature by [@&#8203;kyselberg](https://togithub.com/kyselberg) in
[https://github.com/reduxjs/redux-toolkit/pull/4173](https://togithub.com/reduxjs/redux-toolkit/pull/4173)
- Corrected the "Observing cache behaviour" example point no.4 by
[@&#8203;721-atikshaikh](https://togithub.com/721-atikshaikh) in
[https://github.com/reduxjs/redux-toolkit/pull/4174](https://togithub.com/reduxjs/redux-toolkit/pull/4174)
- feat: add isPrefetch property in query action by
[@&#8203;juliengbt](https://togithub.com/juliengbt) in
[https://github.com/reduxjs/redux-toolkit/pull/4177](https://togithub.com/reduxjs/redux-toolkit/pull/4177)
- allow initialising combined slice reducer with no static slices by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4184](https://togithub.com/reduxjs/redux-toolkit/pull/4184)
- Create more Typed wrappers for RTKQ hook types by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4147](https://togithub.com/reduxjs/redux-toolkit/pull/4147)
- proposal fix for axios base query types by
[@&#8203;smff](https://togithub.com/smff) in
[https://github.com/reduxjs/redux-toolkit/pull/4186](https://togithub.com/reduxjs/redux-toolkit/pull/4186)
- Provide 'throw' option for `overrideExisting` by
[@&#8203;ffluk3](https://togithub.com/ffluk3) in
[https://github.com/reduxjs/redux-toolkit/pull/4189](https://togithub.com/reduxjs/redux-toolkit/pull/4189)
- Use vite-tsconfig-paths to make path aliasing easier by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4175](https://togithub.com/reduxjs/redux-toolkit/pull/4175)
- Remove trailing commas in `tsconfig.json` files of all CodesandBox
examples by [@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4190](https://togithub.com/reduxjs/redux-toolkit/pull/4190)
- \[Docs] Added withTypes documentation in createDraftSafeSelector by
[@&#8203;riqts](https://togithub.com/riqts) in
[https://github.com/reduxjs/redux-toolkit/pull/4143](https://togithub.com/reduxjs/redux-toolkit/pull/4143)
- Add second parameter to getInitialState to prefill entities by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4183](https://togithub.com/reduxjs/redux-toolkit/pull/4183)

#### New Contributors

- [@&#8203;itz-Me-Pj](https://togithub.com/itz-Me-Pj) made their first
contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4139](https://togithub.com/reduxjs/redux-toolkit/pull/4139)
- [@&#8203;kantbtrue](https://togithub.com/kantbtrue) made their first
contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4161](https://togithub.com/reduxjs/redux-toolkit/pull/4161)
- [@&#8203;kyselberg](https://togithub.com/kyselberg) made their first
contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4173](https://togithub.com/reduxjs/redux-toolkit/pull/4173)
- [@&#8203;721-atikshaikh](https://togithub.com/721-atikshaikh) made
their first contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4174](https://togithub.com/reduxjs/redux-toolkit/pull/4174)
- [@&#8203;smff](https://togithub.com/smff) made their first
contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4186](https://togithub.com/reduxjs/redux-toolkit/pull/4186)
- [@&#8203;ffluk3](https://togithub.com/ffluk3) made their first
contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4189](https://togithub.com/reduxjs/redux-toolkit/pull/4189)

**Full Changelog**:
https://github.com/reduxjs/redux-toolkit/compare/v2.1.0...v2.2.0

###
[`v2.1.0`](https://togithub.com/reduxjs/redux-toolkit/releases/tag/v2.1.0)

[Compare
Source](https://togithub.com/reduxjs/redux-toolkit/compare/v2.0.1...v2.1.0)

This *minor release*:

- adds withTypes methods to `listenerMiddleware` and
`createDraftSafeSelector`
-   adds a `skipPollingIfUnfocused` option to RTK Query
- adds the ability to customise the `createSelector` instance used by
RTK Query
-   reworks slice selector logic to avoid depending on `this` value
-   fixes the order and inference of `create.asyncThunk` type parameters
-   fixes requirements for meta fields returned from `queryFn`s
- marks promises that will never reject as safe, in preparation for
[https://github.com/typescript-eslint/typescript-eslint/issues/7008](https://togithub.com/typescript-eslint/typescript-eslint/issues/7008)

#### What's Changed

- Update docs to avoid circular type by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3948](https://togithub.com/reduxjs/redux-toolkit/pull/3948)
- Copy "Migrating to Modern Redux" and "RTK is Redux" docs from core
site by [@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3956](https://togithub.com/reduxjs/redux-toolkit/pull/3956)
- Fix store path rtk-query pokemon api tutorial by
[@&#8203;suspiciousRaccoon](https://togithub.com/suspiciousRaccoon) in
[https://github.com/reduxjs/redux-toolkit/pull/3611](https://togithub.com/reduxjs/redux-toolkit/pull/3611)
- tweak RTKQ without hooks section, and add note regarding memoization
by [@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3963](https://togithub.com/reduxjs/redux-toolkit/pull/3963)
- Add section regarding overriding deps by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3968](https://togithub.com/reduxjs/redux-toolkit/pull/3968)
- Add section re: RR custom context typing change by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3995](https://togithub.com/reduxjs/redux-toolkit/pull/3995)
- Add Expo demo app to CI workflow by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/3985](https://togithub.com/reduxjs/redux-toolkit/pull/3985)
- docs: fix a typo in queries markdown file by
[@&#8203;fatihgnc](https://togithub.com/fatihgnc) in
[https://github.com/reduxjs/redux-toolkit/pull/4013](https://togithub.com/reduxjs/redux-toolkit/pull/4013)
- Preserve nullable store state type by avoiding intersection with {} by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4011](https://togithub.com/reduxjs/redux-toolkit/pull/4011)
- Upgrade version of "graphql-request" by
[@&#8203;phryneas](https://togithub.com/phryneas) in
[https://github.com/reduxjs/redux-toolkit/pull/4026](https://togithub.com/reduxjs/redux-toolkit/pull/4026)
- \[graphql-request-base-query] update RTK peerDependency by
[@&#8203;phryneas](https://togithub.com/phryneas) in
[https://github.com/reduxjs/redux-toolkit/pull/4027](https://togithub.com/reduxjs/redux-toolkit/pull/4027)
- fix: improve selectFromResult memoization by
[@&#8203;thisjeremiah](https://togithub.com/thisjeremiah) in
[https://github.com/reduxjs/redux-toolkit/pull/4029](https://togithub.com/reduxjs/redux-toolkit/pull/4029)
- Rename "createSliceWithThunks" and "createThunkSlice" to
"createAppSlice" by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4035](https://togithub.com/reduxjs/redux-toolkit/pull/4035)
- Bump Vitest to latest version by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4047](https://togithub.com/reduxjs/redux-toolkit/pull/4047)
- fix inference and order of async thunk generics by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4061](https://togithub.com/reduxjs/redux-toolkit/pull/4061)
- Fix markdown links on Next.js page by
[@&#8203;DmitryScaletta](https://togithub.com/DmitryScaletta) in
[https://github.com/reduxjs/redux-toolkit/pull/4069](https://togithub.com/reduxjs/redux-toolkit/pull/4069)
- Introduce pre-typed listener middleware via
`listenerMiddleware.withTypes<RootState, AppDispatch>()` method by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4049](https://togithub.com/reduxjs/redux-toolkit/pull/4049)
- Add `.withTypes` to `createDraftSafeSelector` by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4080](https://togithub.com/reduxjs/redux-toolkit/pull/4080)
- Task/remove all settled by
[@&#8203;bever1337](https://togithub.com/bever1337) in
[https://github.com/reduxjs/redux-toolkit/pull/3917](https://togithub.com/reduxjs/redux-toolkit/pull/3917)
- Allow customising createSelector instance used by RTKQ by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4048](https://togithub.com/reduxjs/redux-toolkit/pull/4048)
- cacheLifecycle fix for fixedCacheKey in mutationThunk by
[@&#8203;riqts](https://togithub.com/riqts) in
[https://github.com/reduxjs/redux-toolkit/pull/4082](https://togithub.com/reduxjs/redux-toolkit/pull/4082)
- avoid relying on `this` in createSlice by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4071](https://togithub.com/reduxjs/redux-toolkit/pull/4071)
- documentation: fix grammar in redux and redux toolkit comparison by
[@&#8203;untilhamza](https://togithub.com/untilhamza) in
[https://github.com/reduxjs/redux-toolkit/pull/4086](https://togithub.com/reduxjs/redux-toolkit/pull/4086)
- Update `tsconfig.typetests.json` to include all TS files by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4091](https://togithub.com/reduxjs/redux-toolkit/pull/4091)
- Remove abort event listner for AbortController by
[@&#8203;Fonger](https://togithub.com/Fonger) in
[https://github.com/reduxjs/redux-toolkit/pull/3951](https://togithub.com/reduxjs/redux-toolkit/pull/3951)
- Docs: unused value 'isRejected' in code snippet by
[@&#8203;alphonsotran](https://togithub.com/alphonsotran) in
[https://github.com/reduxjs/redux-toolkit/pull/3301](https://togithub.com/reduxjs/redux-toolkit/pull/3301)
- fix/kitchen-sink-isAuthenticated: fixed isAuthenticated state change
on login fullfilled by
[@&#8203;shrijan00003](https://togithub.com/shrijan00003) in
[https://github.com/reduxjs/redux-toolkit/pull/3588](https://togithub.com/reduxjs/redux-toolkit/pull/3588)
- Fix `composeWithDevTools` spy by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4093](https://togithub.com/reduxjs/redux-toolkit/pull/4093)
- require queryFn meta to match base query by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/4098](https://togithub.com/reduxjs/redux-toolkit/pull/4098)
- Added 'SafePromise' branded Promises for createAsyncThunk by
[@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) in
[https://github.com/reduxjs/redux-toolkit/pull/4102](https://togithub.com/reduxjs/redux-toolkit/pull/4102)
- Add React Native demo app to CI workflow by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/3984](https://togithub.com/reduxjs/redux-toolkit/pull/3984)
- Modernize unit test setup by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/redux-toolkit/pull/4114](https://togithub.com/reduxjs/redux-toolkit/pull/4114)
- Add missing reducer field to ConfigureStoreOptions docs by
[@&#8203;nickgirardo](https://togithub.com/nickgirardo) in
[https://github.com/reduxjs/redux-toolkit/pull/4116](https://togithub.com/reduxjs/redux-toolkit/pull/4116)
- Option for queries to pause polling when unfocused by
[@&#8203;riqts](https://togithub.com/riqts) in
[https://github.com/reduxjs/redux-toolkit/pull/4055](https://togithub.com/reduxjs/redux-toolkit/pull/4055)

#### New Contributors

- [@&#8203;suspiciousRaccoon](https://togithub.com/suspiciousRaccoon)
made their first contribution in
[https://github.com/reduxjs/redux-toolkit/pull/3611](https://togithub.com/reduxjs/redux-toolkit/pull/3611)
- [@&#8203;fatihgnc](https://togithub.com/fatihgnc) made their first
contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4013](https://togithub.com/reduxjs/redux-toolkit/pull/4013)
- [@&#8203;thisjeremiah](https://togithub.com/thisjeremiah) made their
first contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4029](https://togithub.com/reduxjs/redux-toolkit/pull/4029)
- [@&#8203;riqts](https://togithub.com/riqts) made their first
contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4082](https://togithub.com/reduxjs/redux-toolkit/pull/4082)
- [@&#8203;untilhamza](https://togithub.com/untilhamza) made their first
contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4086](https://togithub.com/reduxjs/redux-toolkit/pull/4086)
- [@&#8203;Fonger](https://togithub.com/Fonger) made their first
contribution in
[https://github.com/reduxjs/redux-toolkit/pull/3951](https://togithub.com/reduxjs/redux-toolkit/pull/3951)
- [@&#8203;alphonsotran](https://togithub.com/alphonsotran) made their
first contribution in
[https://github.com/reduxjs/redux-toolkit/pull/3301](https://togithub.com/reduxjs/redux-toolkit/pull/3301)
- [@&#8203;shrijan00003](https://togithub.com/shrijan00003) made their
first contribution in
[https://github.com/reduxjs/redux-toolkit/pull/3588](https://togithub.com/reduxjs/redux-toolkit/pull/3588)
- [@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) made
their first contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4102](https://togithub.com/reduxjs/redux-toolkit/pull/4102)
- [@&#8203;nickgirardo](https://togithub.com/nickgirardo) made their
first contribution in
[https://github.com/reduxjs/redux-toolkit/pull/4116](https://togithub.com/reduxjs/redux-toolkit/pull/4116)

**Full Changelog**:
https://github.com/reduxjs/redux-toolkit/compare/v2.0.1...v2.1.0

###
[`v2.0.1`](https://togithub.com/reduxjs/redux-toolkit/compare/v2.0.0...v2.0.1)

[Compare
Source](https://togithub.com/reduxjs/redux-toolkit/compare/v2.0.0...v2.0.1)

###
[`v2.0.0`](https://togithub.com/reduxjs/redux-toolkit/releases/tag/v2.0.0)

[Compare
Source](https://togithub.com/reduxjs/redux-toolkit/compare/v1.9.7...v2.0.0)

This **major release** :

- Removes the deprecated object syntax from `createSlice` and
`createReducer`
-   Removes other deprecated options
- Updates the `middleware` and `enhancers` options of `configureStore`
to require callbacks
- Updates the packaging for better ESM/CJS compatibility and modernizes
the build output
- Includes all changes to [Redux core
5.0](https://togithub.com/reduxjs/redux/releases/tag/v5.0.0), [Reselect
5.0](https://togithub.com/reduxjs/reselect/releases/tag/v5.0.0), and
[Redux Thunk
3.0](https://togithub.com/reduxjs/redux-thunk/releases/tag/v3.0.0)
-   Updates RTKQ default subscription behavior
- Adds a new `combineSlices` method with support for lazy-loading slice
reducers
- Adds a new "dynamic middleware" middleware with support for adding
middleware at runtime
- Adds a new callback syntax to `createSlice.reducers`, with optional
support for defining thunks inside of `createSlice`
-   Adds the `autoBatchEnhancer` to `configureStore` by default
-   Has many additional TS tweaks and improvements

This release has **breaking changes**. (Note: v2.0.1 was released with a
couple hotfixes for Reselect and Redux Thunk right as this was being
finalized.)

This release is part of a wave of major versions of all the Redux
packages: **Redux Toolkit 2.0, Redux core 5.0, React-Redux 9.0, Reselect
5.0, and Redux Thunk 3.0**.

For full details on all of the breaking changes and other significant
changes to all of those packages, see the **["Migrating to RTK 2.0 and
Redux 5.0" migration
guide](https://redux.js.org/usage/migrations/migrating-rtk-2)** in the
Redux docs.

> \[!NOTE]
> The Redux core, Reselect, and Redux Thunk packages are included as
part of Redux Toolkit, and RTK users do not need to manually upgrade
them - you'll get them as part of the upgrade to RTK 2.0. (If you're not
using Redux Toolkit yet, [**please start migrating your existing legacy
Redux code to use Redux Toolkit
today!**](https://redux.js.org/usage/migrating-to-modern-redux))

```bash

##### RTK
npm install @&#8203;reduxjs/toolkit
yarn add @&#8203;reduxjs/toolkit
```

##### Changelog

##### Object syntax for `createSlice.extraReducers` and `createReducer`
removed

RTK's `createReducer` API was originally designed to accept a lookup
table of action type strings to case reducers, like `{ "ADD_TODO":
(state, action) => {} }`. We later added the "builder callback" form to
allow more flexibility in adding "matchers" and a default handler, and
did the same for `createSlice.extraReducers`.

We have removed the "object" form for both `createReducer` and
`createSlice.extraReducers` in RTK 2.0, as the builder callback form is
effectively the same number of lines of code, and works much better with
TypeScript.

As an example, this:

```ts
const todoAdded = createAction('todos/todoAdded')

createReducer(initialState, {
  [todoAdded]: (state, action) => {},
})

createSlice({
  name,
  initialState,
  reducers: {
    /* case reducers here */
  },
  extraReducers: {
    [todoAdded]: (state, action) => {},
  },
})
```

should be migrated to:

```ts
createReducer(initialState, (builder) => {
  builder.addCase(todoAdded, (state, action) => {})
})

createSlice({
  name,
  initialState,
  reducers: {
    /* case reducers here */
  },
  extraReducers: (builder) => {
    builder.addCase(todoAdded, (state, action) => {})
  },
})
```

##### Codemods

To simplify upgrading codebases, we've published a set of codemods that
will automatically transform the deprecated "object" syntax into the
equivalent "builder" syntax.

The codemods package is available on NPM as
[`@reduxjs/rtk-codemods`](https://www.npmjs.com/package/@&#8203;reduxjs/rtk-codemods).
More details are available [here](../api/codemods).

To run the codemods against your codebase, run `npx
@&#8203;reduxjs/rtk-codemods <TRANSFORM NAME> path/of/files/
or/some**/*glob.js.`

Examples:

```sh
npx @&#8203;reduxjs/rtk-codemods createReducerBuilder ./src

npx @&#8203;reduxjs/rtk-codemods createSliceBuilder ./packages/my-app/**/*.ts
```

We also recommend re-running Prettier on the codebase before committing
the changes.

These codemods should work, but we would greatly appreciate feedback
from more real-world codebases!

##### `configureStore` Options Changes

##### `configureStore.middleware` must be a callback

Since the beginning, `configureStore` has accepted a direct array value
as the `middleware` option. However, providing an array directly
prevents `configureStore` from calling `getDefaultMiddleware()`. So,
`middleware: [myMiddleware]` means there is no thunk middleware added
(or any of the dev-mode checks).

This is a footgun, and we've had numerous users accidentally do this and
cause their apps to fail because the default middleware never got
configured.

As a result, we've now made the `middleware` only accept the callback
form. *If* for some reason you still want to replace *all* of the
built-in middleware, do so by returning an array from the callback:

```ts
const store = configureStore({
  reducer,
  middleware: (getDefaultMiddleware) => {
    // WARNING: this means that _none_ of the default middleware are added!
    return [myMiddleware]
    // or for TS users, use:
    // return new Tuple(myMiddleware)
  },
})
```

But note that **we consistently recommend not replacing the default
middleware entirely**, and that you should use `return
getDefaultMiddleware().concat(myMiddleware)`.

##### `configureStore.enhancers` must be a callback

Similarly to `configureStore.middleware`, the `enhancers` field must
also be a callback, for the same reasons.

The callback will receive a `getDefaultEnhancers` function that can be
used to customise the batching enhancer [that's now included by
default](#configurestore-adds-autobatchenhancer-by-default).

For example:

```ts
const store = configureStore({
  reducer,
  enhancers: (getDefaultEnhancers) => {
    return getDefaultEnhancers({
      autoBatch: { type: 'tick' },
    }).concat(myEnhancer)
  },
})
```

It's important to note that the result of `getDefaultEnhancers` will
**also** contain the middleware enhancer created with any
configured/default middleware. To help prevent mistakes,
`configureStore` will log an error to console if middleware was provided
and the middleware enhancer wasn't included in the callback result.

```ts
const store = configureStore({
  reducer,
  enhancers: (getDefaultEnhancers) => {
    return [myEnhancer] // we've lost the  middleware here
    // instead:
    return getDefaultEnhancers().concat(myEnhancer)
  },
})
```

Also, note that **if you supply the `enhancers` field, it *must* come
*after* the `middleware` field in order for TS inference to work
properly**.

##### Standalone `getDefaultMiddleware` and `getType` removed

The standalone version of `getDefaultMiddleware` has been deprecated
since v1.6.1, and has now been removed. Use the function passed to the
`middleware` callback instead, which has the correct types.

We have also removed the `getType` export, which was used to extract a
type string from action creators made with `createAction`. Instead, use
the static property `actionCreator.type`.

##### RTK Query behaviour changes

We've had a number of reports where RTK Query had issues around usage of
`dispatch(endpoint.initiate(arg, {subscription: false}))`. There were
also reports that multiple triggered lazy queries were resolving the
promises at the wrong time. Both of these had the same underlying issue,
which was that RTKQ wasn't tracking cache entries in these cases
(intentionally). We've reworked the logic to always track cache entries
(and remove them as needed), which should resolve those behavior issues.

We also have had issues raised about trying to run multiple mutations in
a row and how tag invalidation behaves. RTKQ now has internal logic to
delay tag invalidation briefly, to allow multiple invalidations to get
handled together. This is controlled by a new `invalidationBehavior:
'immediate' | 'delayed'` flag on `createApi`. The new default behavior
is `'delayed'`. Set it to `'immediate'` to revert to the behavior in RTK
1.9.

In RTK 1.9, we reworked RTK Query's internals to keep most of the
subscription status inside the RTKQ middleware. The values are still
synced to the Redux store state, but this is primarily for display by
the Redux DevTools "RTK Query" panel. Related to the cache entry changes
above, we've optimized how often those values get synced to the Redux
state for perf.

##### ESM/CJS Package Compatibility

The biggest theme of the Redux v5 and RTK 2.0 releases is trying to get
"true" ESM package publishing compatibility in place, while still
supporting CJS in the published package.

**The primary build artifact is now an ESM file,
`dist/redux-toolkit.modern.mjs`**. Most build tools should pick this up.
There's also a CJS artifact, and a second copy of the ESM file named
`redux-toolkit.legacy-esm.js` to support Webpack 4 (which does not
recognize the `exports` field in `package.json`). Additionally, all of
the build artifacts now live under `./dist/` in the published package.

##### Modernized Build Output

We now publish modern JS syntax targeting ES2020, including optional
chaining, object spread, and other modern syntax. If you need to

##### Build Tooling

We're now building the package using https://github.com/egoist/tsup. We
also now include sourcemaps for the ESM and CJS artifacts.

##### Dropping UMD Builds

Redux has always shipped with UMD build artifacts. These are primarily
meant for direct import as script tags, such as in a CodePen or a
no-bundler build environment.

We've dropped those build artifacts from the published package, on the
grounds that the use cases seem pretty rare today.

There's now a `redux-toolkit.browser.mjs` file in the package that can
be loaded from a CDN like Unpkg.

If you have strong use cases for us continuing to include UMD build
artifacts, please let us know!

##### Dependency Updates

##### Redux Libraries

RTK now depends on **[Redux core
5.0](https://togithub.com/reduxjs/redux/releases/tag/v5.0.0), [Reselect
5.0](https://togithub.com/reduxjs/reselect/releases/tag/v5.0.0), and
[Redux Thunk
3.0](https://togithub.com/reduxjs/redux-thunk/releases/tag/v3.0.0)**.
See the linked release notes for those libraries, as **each of them has
additional breaking changes**. The ["Migrating to RTK 2.0 and Redux 5.0"
docs page](https://redux.js.org/usage/migrations/migrating-rtk-2) also
covers the combined changes in one page

##### Immer 10

RTK now also depends on [Immer
10.0](https://togithub.com/immerjs/immer/releases/tag/v10.0.0), which
has several major improvements and updates:

-   Much faster update perf
-   Much smaller bundle size
-   Better ESM/CJS package formatting
-   No default export
-   No ES5 fallback

We've also removed the prior call to automatically enable the Immer ES5
fallback mode any time RTK was loaded.

##### Other Changes

##### Bundle Size Optimizations

Redux 4.1.0 optimized its bundle size by [extracting error message
strings out of production
builds](https://togithub.com/reduxjs/redux/releases/tag/v4.1.0), based
on React's approach. We've applied the same technique to RTK. This saves
about 1000 bytes from prod bundles (actual benefits will depend on which
imports are being used).

We also noted that [ESBuild does not deduplicate imports when it bundles
source files](https://togithub.com/evanw/esbuild/issues/475), and this
was causing RTK Query's bundle to contain a dozen references to `import
{ } from "@&#8203;reduxjs/toolkit"`, including some of the same methods.
Manually deduplicating those saves about 600 bytes off the production
RTKQ artifact.

##### `reactHooksModule` custom hook configuration

Previously, custom versions of React Redux's hooks (`useSelector`,
`useDispatch`, and `useStore`) could be passed separately to
`reactHooksModule`, usually to enable using a different context to the
default `ReactReduxContext`.

In practicality, the react hooks module needs all three of these hooks
to be provided, and it became an easy mistake to only pass `useSelector`
and `useDispatch`, without `useStore`.

The module has now moved all three of these under the same configuration
key, and will check that all three are provided if the key is present.

```ts
// previously
const customCreateApi = buildCreateApi(
  coreModule(),
  reactHooksModule({
    useDispatch: createDispatchHook(MyContext),
    useSelector: createSelectorHook(MyContext),
    useStore: createStoreHook(MyContext),
  })
)

// now
const customCreateApi = buildCreateApi(
  coreModule(),
  reactHooksModule({
    hooks: {
      useDispatch: createDispatchHook(MyContext),
      useSelector: createSelectorHook(MyContext),
      useStore: createStoreHook(MyContext),
    },
  })
)
```

##### Deprecated Options Removed

Several other options were previously marked as deprecated, and have
been removed. We've also removed polyfills like the `AbortController`
polyfill.

##### TypeScript Changes

##### `configureStore` field order for `middleware` matters

If you are passing *both* the `middleware` and `enhancers` fields to
`configureStore`, the `middleware` field *must* come first in order for
internal TS inference to work properly.

##### Non-default middleware/enhancers must use `Tuple`

We've seen many cases where users passing the `middleware` parameter to
configureStore have tried spreading the array returned by
`getDefaultMiddleware()`, or passed an alternate plain array. This
unfortunately loses the exact TS types from the individual middleware,
and often causes TS problems down the road (such as `dispatch` being
typed as `Dispatch<AnyAction>` and not knowing about thunks).

`getDefaultMiddleware()` already used an internal `MiddlewareArray`
class, an `Array` subclass that had strongly typed `.concat/prepend()`
methods to correctly capture and retain the middleware types.

We've renamed that type to `Tuple`, and `configureStore`'s TS types now
require that you *must* use `Tuple` if you want to pass your own array
of middleware:

```ts
import { configureStore, Tuple } from '@&#8203;reduxjs/toolkit'

configureStore({
  reducer: rootReducer,
  middleware: (getDefaultMiddleware) => new Tuple(additionalMiddleware, logger),
})
```

(Note that this has no effect if you're using RTK with plain JS, and you
could still pass a plain array here.)

This same restriction applies to the `enhancers` field.

##### Entity adapter type updates

`createEntityAdapter` now has an `Id` generic argument, which will be
used to strongly type the item IDs anywhere those are exposed.
Previously, the ID field type was always `string | number`. TS will now
try to infer the exact type from either the `.id` field of your entity
type, or the `selectId` return type. You could also fall back to passing
that generic type directly. **If you use the `EntityState<Data, Id>`
type directly, you *must* supply both generic arguments!**

The `.entities` lookup table is now defined to use a standard TS
`Record<Id, MyEntityType>`, which assumes that each item lookup exists
by default. Previously, it used a `Dictionary<MyEntityType>` type, which
assumed the result was `MyEntityType | undefined`. The `Dictionary` type
has been removed.

If you prefer to assume that the lookups *might* be undefined, use
TypeScript's `noUncheckedIndexedAccess` configuration option to control
that.

##### New Features

These features are new in Redux Toolkit 2.0, and help cover additional
use cases that we've seen users ask for in the ecosystem.

##### `combineSlices` API with slice reducer injection for
code-splitting

The Redux core has always included `combineReducers`, which takes an
object full of "slice reducer" functions and generates a reducer that
calls those slice reducers. RTK's `createSlice` generates slice reducers
+ associated action creators, and we've taught the pattern of exporting
individual action creators as named exports and the slice reducer as a
default export. Meanwhile, we've never had official support for
lazy-loading reducers, although we've had [sample code for some "reducer
injection" patterns in our
docs](https://redux.js.org/usage/code-splitting).

This release includes a new [`combineSlices`](../api/combineSlices) API
that is designed to enable lazy-loading of reducers at runtime. It
accepts individual slices or an object full of slices as arguments, and
automatically calls `combineReducers` using the `sliceObject.name` field
as the key for each state field. The generated reducer function has an
additional `.inject()` method attached that can be used to dynamically
inject additional slices at runtime. It also includes a
`.withLazyLoadedSlices()` method that can be used to generate TS types
for reducers that will be added later. See
[#&#8203;2776](https://togithub.com/reduxjs/redux-toolkit/issues/2776)
for the original discussion around this idea.

For now, we are not building this into `configureStore`, so you'll need
to call `const rootReducer = combineSlices(.....)` yourself and pass
that to `configureStore({reducer: rootReducer})`.

**Basic usage: a mixture of slices and standalone reducers passed to
`combineSlices`**

```ts
const stringSlice = createSlice({
  name: 'string',
  initialState: '',
  reducers: {},
})

const numberSlice = createSlice({
  name: 'number',
  initialState: 0,
  reducers: {},
})

const booleanReducer = createReducer(false, () => {})

const api = createApi(/*  */)

const combinedReducer = combineSlices(
  stringSlice,
  {
    num: numberSlice.reducer,
    boolean: booleanReducer,
  },
  api
)
expect(combinedReducer(undefined, dummyAction())).toEqual({
  string: stringSlice.getInitialState(),
  num: numberSlice.getInitialState(),
  boolean: booleanReducer.getInitialState(),
  api: api.reducer.getInitialState(),
})
```

**Basic slice reducer injection**

```ts
// Create a reducer with a TS type that knows `numberSlice` will be injected
const combinedReducer =
  combineSlices(stringSlice).withLazyLoadedSlices<
    WithSlice<typeof numberSlice>
  >()

// `state.number` doesn't exist initially
expect(combinedReducer(undefined, dummyAction()).number).toBe(undefined)

// Create a version of the reducer with `numberSlice` injected (mainly useful for types)
const injectedReducer = combinedReducer.inject(numberSlice)

// `state.number` now exists, and injectedReducer's type no longer marks it as optional
expect(injectedReducer(undefined, dummyAction()).number).toBe(
  numberSlice.getInitialState()
)

// original reducer has also been changed (type is still optional)
expect(combinedReducer(undefined, dummyAction()).number).toBe(
  numberSlice.getInitialState()
)
```

##### `selectors` field in `createSlice`

The existing `createSlice` API now has support for defining
[`selectors`](../api/createSlice#selectors) directly as part of the
slice. By default, these will be generated with the assumption that the
slice is mounted in the root state using `slice.name` as the field, such
as `name: "todos"` -> `rootState.todos`. Additionally, there's now a
`slice.selectSlice` method that does that default root state lookup.

You can call `sliceObject.getSelectors(selectSliceState)` to generate
the selectors with an alternate location, similar to how
`entityAdapter.getSelectors()` works.

```ts
const slice = createSlice({
  name: 'counter',
  initialState: 42,
  reducers: {},
  selectors: {
    selectSlice: (state) => state,
    selectMultiple: (state, multiplier: number) => state * multiplier,
  },
})

// Basic usage
const testState = {
  [slice.name]: slice.getInitialState(),
}
const { selectSlice, selectMultiple } = slice.selectors
expect(selectSlice(testState)).toBe(slice.getInitialState())
expect(selectMultiple(testState, 2)).toBe(slice.getInitialState() * 2)

// Usage with the slice reducer mounted under a different key
const customState = {
  number: slice.getInitialState(),
}
const { selectSlice, selectMultiple } = slice.getSelectors(
  (state: typeof customState) => state.number
)
expect(selectSlice(customState)).toBe(slice.getInitialState())
expect(selectMultiple(customState, 2)).toBe(slice.getInitialState() * 2)
```

##### `createSlice.reducers` callback syntax and thunk support

One of the oldest feature requests we've had is the ability to declare
thunks directly inside of `createSlice`. Until now, you've always had to
declare them separately, give the thunk a string action prefix, and
handle the actions via `createSlice.extraReducers`:

```ts
// Declare the thunk separately
const fetchUserById = createAsyncThunk(
  'users/fetchByIdStatus',
  async (userId: number, thunkAPI) => {
    const response = await userAPI.fetchById(userId)
    return response.data
  }
)

const usersSlice = createSlice({
  name: 'users',
  initialState,
  reducers: {
    // standard reducer logic, with auto-generated action types per reducer
  },
  extraReducers: (builder) => {
    // Add reducers for additional action types here, and handle loading state as needed
    builder.addCase(fetchUserById.fulfilled, (state, action) => {
      state.entities.push(action.payload)
    })
  },
})
```

Many users have told us that this separation feels awkward.

We've *wanted* to include a way to define thunks directly inside of
`createSlice`, and have played around with various prototypes. There
were always two major blocking issues, and a secondary concern:

1. It wasn't clear what the syntax for declaring a thunk inside should
look like.
2. Thunks have access to `getState` and `dispatch`, but the `RootState`
and `AppDispatch` types are normally inferred from the store, which in
turn infers it from the slice state types. Declaring thunks inside
`createSlice` would cause circular type inference errors, as the store
needs the slice types but the slice needs the store types. We weren't
willing to ship an API that would work okay for our JS users but not for
our TS users, especially since we *want* people to use TS with RTK.
3. You can't do synchronous conditional imports in ES modules, and
there's no good way to make the `createAsyncThunk` import optional.
Either `createSlice` always depends on it (and adds that to the bundle
size), or it can't use `createAsyncThunk` at all.

We've settled on these compromises:

- **In order to create async thunks with `createSlice`, you specifically
need to [set up a custom version of `createSlice` that has access to
`createAsyncThunk`](../api/createSlice#createasyncthunk)**.
- You can declare thunks inside of `createSlice.reducers`, by using a
"creator callback" syntax for the `reducers` field that is similar to
the `build` callback syntax in RTK Query's `createApi` (using typed
functions to create fields in an object). Doing this does look a bit
different than the existing "object" syntax for the `reducers` field,
but is still fairly similar.
- You can customize *some* of the types for thunks inside of
`createSlice`, but you *cannot* customize the `state` or `dispatch`
types. If those are needed, you can manually do an `as` cast, like
`getState() as RootState`.

In practice, we hope these are reasonable tradeoffs. Creating thunks
inside of `createSlice` has been widely asked for, so we think it's an
API that will see usage. If the TS customization options are a
limitation, you can still declare thunks outside of `createSlice` as
always, and most async thunks don't need `dispatch` or `getState` - they
just fetch data and return. And finally, setting up a custom
`createSlice` allows you to opt into `createAsyncThunk` being included
in your bundle size (though it may already be included if used directly
or as part of RTK Query - in either of these cases there's no
*additional* bundle size).

Here's what the new callback syntax looks like:

```ts
const createSliceWithThunks = buildCreateSlice({
  creators: { asyncThunk: asyncThunkCreator },
})

const todosSlice = createSliceWithThunks({
  name: 'todos',
  initialState: {
    loading: false,
    todos: [],
    error: null,
  } as TodoState,
  reducers: (create) => ({
    // A normal "case reducer", same as always
    deleteTodo: create.reducer((state, action: PayloadAction<number>) => {
      state.todos.splice(action.payload, 1)
    }),
    // A case reducer with a "prepare callback" to customize the action
    addTodo: create.preparedReducer(
      (text: string) => {
        const id = nanoid()
        return { payload: { id, text } }
      },
      // action type is inferred from prepare callback
      (state, action) => {
        state.todos.push(action.payload)
      }
    ),
    // An async thunk
    fetchTodo: create.asyncThunk(
      // Async payload function as the first argument
      async (id: string, thunkApi) => {
        const res = await fetch(`myApi/todos?id=${id}`)
        return (await res.json()) as Item
      },
      // An object containing `{pending?, rejected?, fulfilled?, settled?, options?}` second
      {
        pending: (state) => {
          state.loading = true
        },
        rejected: (state, action) => {
          state.error = action.payload ?? action.error
        },
        fulfilled: (state, action) => {
          state.todos.push(action.payload)
        },
        // settled is called for both rejected and fulfilled actions
        settled: (state, action) => {
          state.loading = false
        },
      }
    ),
  }),
})

// `addTodo` and `deleteTodo` are normal action creators.
// `fetchTodo` is the async thunk
export const { addTodo, deleteTodo, fetchTodo } = todosSlice.actions
```

##### Codemod

**Using the new callback syntax is entirely optional (the object syntax
is still standard)**, but an existing slice would need to be converted
before it can take advantage of the new capabilities this syntax
provides. To make this easier, a [codemod](../api/codemods) is provided.

```sh
npx @&#8203;reduxjs/rtk-codemods createSliceReducerBuilder ./src/features/todos/slice.ts
```

##### "Dynamic middleware" middleware

A Redux store's middleware pipeline is fixed at store creation time and
can't be changed later. We *have* seen ecosystem libraries that tried to
allow dynamically adding and removing middleware, potentially useful for
things like code splitting.

This is a relatively niche use case, but we've built [our own version of
a "dynamic middleware" middleware](../api/createDynamicMiddleware). Add
it to the Redux store at setup time, and it lets you add middleware
later at runtime. It also comes with a [React hook integration that will
automatically add a middleware to the store and return the updated
dispatch method.](../api/createDynamicMiddleware#react-integration).

```ts
import { createDynamicMiddleware, configureStore } from '@&#8203;reduxjs/toolkit'

const dynamicMiddleware = createDynamicMiddleware()

const store = configureStore({
  reducer: {
    todos: todosReducer,
  },
  middleware: (getDefaultMiddleware) =>
    getDefaultMiddleware().prepend(dynamicMiddleware.middleware),
})

// later
dynamicMiddleware.addMiddleware(someOtherMiddleware)
```

##### `configureStore` adds `autoBatchEnhancer` by default

[In v1.9.0, we added a new
`autoBatchEnhancer`](https://togithub.com/reduxjs/redux-toolkit/releases/tag/v1.9.0)
that delays notifying subscribers briefly when multiple "low-priority"
actions are dispatched in a row. This improves perf, as UI updates are
typically the most expensive part of the update process. RTK Query marks
most of its own internal actions as "low-pri" by default, but you have
to have the `autoBatchEnhancer` added to the store to benefit from that.

We've updated `configureStore` to add the `autoBatchEnhancer` to the
store setup by default, so that users can benefit from the improved perf
without needing to manually tweak the store config themselves.

##### `entityAdapter.getSelectors` accepts a `createSelector` function


[`entityAdapter.getSelectors()`](../api/createEntityAdapter#selector-functions)
now accepts an options object as its second argument. This allows you to
pass in your own preferred `createSelector` method, which will be used
to memoize the generated selectors. This could be useful if you want to
use one of Reselect's new alternate memoizers, or some other memoization
library with an equivalent signature.

##### Next.js Setup Guide

We now have a docs page that covers [how to set up Redux properly with
Next.js](https://redux.js.org/usage/nextjs). We've seen a lot of
questions around using Redux, Next, and the App Router together, and
this guide should help provide advice.

(At this time, the Next.js `with-redux` example is still showing
outdated patterns - we're going to file a PR shortly to update that to
match our docs guide.)

##### What's Changed

- Remove legacy object syntax for reducers by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3051](https://togithub.com/reduxjs/redux-toolkit/pull/3051)
- Upgrade build tooling by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3088](https://togithub.com/reduxjs/redux-toolkit/pull/3088)
- Migrate the RTK package to be full ESM by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3095](https://togithub.com/reduxjs/redux-toolkit/pull/3095)
- Migrate RTK test suite from Jest to Vitest by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3102](https://togithub.com/reduxjs/redux-toolkit/pull/3102)
- Fix type errors after upgrading to Redux 5 alpha by
[@&#8203;Methuselah96](https://togithub.com/Methuselah96) in
[https://github.com/reduxjs/redux-toolkit/pull/3177](https://togithub.com/reduxjs/redux-toolkit/pull/3177)
- Bump Redux dep to 5.0.0-alpha.2 by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3170](https://togithub.com/reduxjs/redux-toolkit/pull/3170)
- Test published artifacts in CI by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3213](https://togithub.com/reduxjs/redux-toolkit/pull/3213)
- Merge RTK CI examples into `v2.0-integration` by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3253](https://togithub.com/reduxjs/redux-toolkit/pull/3253)
- Add `arethetypeswrong` automated CLI check by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3294](https://togithub.com/reduxjs/redux-toolkit/pull/3294)
- update tip regarding overrideExisting to match actual behaviour by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3305](https://togithub.com/reduxjs/redux-toolkit/pull/3305)
- Add `attw` CLI option to treat problems as non-errors by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3316](https://togithub.com/reduxjs/redux-toolkit/pull/3316)
- Rework build setup and hopefully fix ESM compat issues by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3318](https://togithub.com/reduxjs/redux-toolkit/pull/3318)
- Bump Immer to 10.0-beta by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3320](https://togithub.com/reduxjs/redux-toolkit/pull/3320)
- Switch build setup from a custom ESBuild+TS script to `tsup` by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3362](https://togithub.com/reduxjs/redux-toolkit/pull/3362)
- Use original instead of immer draft for perf by
[@&#8203;GeorchW](https://togithub.com/GeorchW) in
[https://github.com/reduxjs/redux-toolkit/pull/3270](https://togithub.com/reduxjs/redux-toolkit/pull/3270)
- enable enhanceEndpoints.transformResponse to override ResultType by
[@&#8203;dmitrigrabov](https://togithub.com/dmitrigrabov) in
[https://github.com/reduxjs/redux-toolkit/pull/2953](https://togithub.com/reduxjs/redux-toolkit/pull/2953)
- Fix global `responseHandler` being used in `fetchBaseQuery` by
[@&#8203;praxxis](https://togithub.com/praxxis) in
[https://github.com/reduxjs/redux-toolkit/pull/3137](https://togithub.com/reduxjs/redux-toolkit/pull/3137)
- reset internalState.currentSubscriptions on `resetApiState` by
[@&#8203;phryneas](https://togithub.com/phryneas) in
[https://github.com/reduxjs/redux-toolkit/pull/3333](https://togithub.com/reduxjs/redux-toolkit/pull/3333)
- Bump deps and mark `subscriptionUpdated` as autobatched by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3364](https://togithub.com/reduxjs/redux-toolkit/pull/3364)
- Redux 5alpha5 by [@&#8203;EskiMojo14](https://togithub.com/EskiMojo14)
in
[https://github.com/reduxjs/redux-toolkit/pull/3367](https://togithub.com/reduxjs/redux-toolkit/pull/3367)
- add isAction helper function, and ensure listener middleware only runs
for actions by [@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3372](https://togithub.com/reduxjs/redux-toolkit/pull/3372)
- Allow inference of enhancer state extensions, and fix inference when
using callback form by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3207](https://togithub.com/reduxjs/redux-toolkit/pull/3207)
- combineSlices implementation by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3297](https://togithub.com/reduxjs/redux-toolkit/pull/3297)
- Bump Immer to 10.0 final by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3376](https://togithub.com/reduxjs/redux-toolkit/pull/3376)
- Allow partial preloaded state for combined slice reducer and update
devDeps by [@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3381](https://togithub.com/reduxjs/redux-toolkit/pull/3381)
- ensure it's only possible to pass all or none of the hooks to
reactHooksModule by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3400](https://togithub.com/reduxjs/redux-toolkit/pull/3400)
- Remove remaining deprecated exports by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3398](https://togithub.com/reduxjs/redux-toolkit/pull/3398)
- create action creator middleware by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3414](https://togithub.com/reduxjs/redux-toolkit/pull/3414)
- Restore query status types by
[@&#8203;markerikson](https://togithub.com/markerikson) in
[https://github.com/reduxjs/redux-toolkit/pull/3420](https://togithub.com/reduxjs/redux-toolkit/pull/3420)
- Implement auto fork joining by
[@&#8203;ericanderson](https://togithub.com/ericanderson) in
[https://github.com/reduxjs/redux-toolkit/pull/3407](https://togithub.com/reduxjs/redux-toolkit/pull/3407)
- types: make it easier to wrap createAsyncThunk by
[@&#8203;shrouxm](https://togithub.com/shrouxm) in
[https://github.com/reduxjs/redux-toolkit/pull/3393](https://togithub.com/reduxjs/redux-toolkit/pull/3393)
- Fixed Stackoverflow bug if children prop is a ref to root/parent
object by [@&#8203;cheprasov](https://togithub.com/cheprasov) in
[https://github.com/reduxjs/redux-toolkit/pull/3428](https://togithub.com/reduxjs/redux-toolkit/pull/3428)
- Add getDefaultEnhancers callback, and add autoBatchEnhancer to
defaults. by [@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3347](https://togithub.com/reduxjs/redux-toolkit/pull/3347)
- Update to Redux alpha 6 by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3442](https://togithub.com/reduxjs/redux-toolkit/pull/3442)
- Remove toString override from action creators, in favour of explicit
.type field. by [@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3425](https://togithub.com/reduxjs/redux-toolkit/pull/3425)
- Add "creator callback" syntax to slice reducer field, to allow for
async thunk creation by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3388](https://togithub.com/reduxjs/redux-toolkit/pull/3388)
- API for adding middleware dynamically by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3292](https://togithub.com/reduxjs/redux-toolkit/pull/3292)
- Add Id type parameter in createEntityAdapter by
[@&#8203;Matt-Ord](https://togithub.com/Matt-Ord) in
[https://github.com/reduxjs/redux-toolkit/pull/3187](https://togithub.com/reduxjs/redux-toolkit/pull/3187)
- Require usage of Tuple in TS by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3460](https://togithub.com/reduxjs/redux-toolkit/pull/3460)
- Require that enhancers is a callback by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3461](https://togithub.com/reduxjs/redux-toolkit/pull/3461)
- fix invalid createEntityAdapter call by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3490](https://togithub.com/reduxjs/redux-toolkit/pull/3490)
- Use Record\<EntityId, T> instead of Dictionary<T> by
[@&#8203;EskiMojo14](https://togithub.com/EskiMojo14) in
[https://github.com/reduxjs/redux-toolkit/pull/3424](https://togithub.com/redux

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 5pm,every weekend" in timezone
America/Los_Angeles, Automerge - "after 5pm,every weekend" in timezone
America/Los_Angeles.

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/valora-inc/wallet).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMTIuMCIsInVwZGF0ZWRJblZlciI6IjM3LjIxMi4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Jean Regisser <jean.regisser@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@renovate-approve renovate-approve[bot] renovate-approve[bot] approved these changes

Assignees
No one assigned
Labels
npm renovate
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jeanregisser