Skip to content

Releases: reduxjs/redux-toolkit

v2.5.0

11 Dec 02:36
@markerikson markerikson
v2.5.0
6590cec
Compare
Choose a tag to compare
v2.5.0 Latest
Latest

This feature release updates the React peer dependency to work with React 19, and fixes an additional skip token issue.

Changelog

React 19 Compat

React 19 was just released! We've updated our peer dep to accept React 19, and updated our runtime and type tests to check against both React 18 and 19.

Also see React-Redux v9.2.0 for the same peer dep update.

Other Fixes

We previously fixed an issue with the RTKQ core where serializeQueryArgs callbacks could be called with skipToken, potentially leading to errors. We've fixed an additional location in the useQuery hooks where that could happen as well.

What's Changed

Full Changelog: v2.4.0...v2.5.0

Contributors

markerikson and aryaemami59
Assets 2
Loading

v2.4.0

28 Nov 21:00
@markerikson markerikson
v2.4.0
3a6ec28
Compare
Choose a tag to compare
v2.4.0

This feature release includes multiple tweaks and fixes to RTK Query functionality, additional exported TS types, and drops support for TS versions earlier than 5.0.

Changelog

RTK Query Improvements

Lazy query hooks can now be reset.

retry.fail now accepts meta as a second argument.

Tag invalidation arrays now ignore nullish values.

We did some small internal refactoring around Maps and default values that shrank bundle size slightly.

Bugfixes

Passing skipToken to a query hook now bails out before running any other logic, which fixes cases where serializeQueryArgs previously threw an error because there were no args to process.

The autoBatchEnhancer now reads window.requestAnimationFrame later, which it to work properly with Jest fake timers.

We fixed cases where the hook result isSuccess flag would briefly flicker to false when switched to a different cache entry that was uninitialized, and would briefly flicker to true when refetching a query that previously errored.

The listener middleware previously had inconsistent logic checks for comparing against existing listener entries (effect + type, vs effect only). It now always checks both effect + type.

Additional TS Types

We now export Typed[Query|Mutation]OnQueryStarted helpers to let you define onQueryStarted callbacks outside of createApi if desired.

We also now export a CreateAsyncThunkFunction type that can be used to type userland wrappers around createAsyncThunk.

TS Support Matrix Updates

We've historically tried to maintain TS backwards compatibility as long as possible, and made occasional updates to our TS support matrix in minor versions over time. As of RTK 2.3.0, we officially supported back through TS 4.7.

As of this release, we're tweaking that support policy to match the policy used by DefinitelyTyped:

Definitely Typed only tests packages on versions of TypeScript that are less than 2 years old
image

Given that, we've dropped official support for TS versions earlier than 5.0. (RTK may work with those versions, but we no longer test against them and won't try to fix issues with those versions.)

We'll continue to update our TS support matrix over time based on that 2-year rolling window.

What's Changed

  • add example to reproduce defect of serializeQueryArgs with skipToken by @Themezv in #4708
  • Read window.rAF later to allow fake timers to work correctly by @ensconced in #4701
  • Add type helpers for OnQueryStarted callbacks by @aryaemami59 in #4713
  • Add a type for createAsyncThunk without the withTypes method by @EskiMojo14 in #4667
  • Add ability to reset lazy query hooks by @alexmotoc in #4689
  • Ignore nullish values in tag invalidations by @pierroberto in #4671
  • Allow passing meta to retry.fail, and passing baseQuery to ensure types match by @EskiMojo14 in #4723
  • Keep isSuccess: true when switching to an uninitialized cache entry by @markerikson in #4731
  • Keep isSuccess consistent when refetching after an error by @markerikson in #4732
  • Update to new version of upsert proposal, and fix listener equality checks by @EskiMojo14 in #4735

Full Changelog: v2.3.0...v2.4.0

Contributors

markerikson, Themezv, and 5 other contributors
Assets 2
Loading

v2.3.0

14 Oct 21:28
@markerikson markerikson
v2.3.0
77fb33d
Compare
Choose a tag to compare
v2.3.0

This feature release adds a new RTK Query upsertQueryEntries util to batch-upsert cache entries more efficiently, passes through additional values for use in prepareHeaders, and exports additional TS types around query options and selectors.

Changelog

upsertQueryEntries

RTK Query already had an upsertQueryData thunk that would upsert a single cache entry. However, some users wanted to upsert many cache entries (potentially hundreds or thousands), and found that upsertQueryData had poor performance in those cases. This is because upsertQueryData runs the full async request handling sequence, including dispatching both pending and fulfilled actions, each of which run the main reducer and update store subscribers. That means there's 2N store / UI updates per item, so upserting hundreds of items becomes extremely perf-intensive.

RTK Query now includes an api.util.upsertQueryEntries action that is meant to handle the batched upsert use case more efficiently. It's a single synchronous action that accepts an array of many {endpointName, arg, value} entries to upsert. This results in a single store update, making this vastly better for performance vs many individual upsertQueryData calls.

We see this as having two main use cases. The first is prefilling the cache with data retrieved from storage on app startup (and it's worth noting that upsertQueryEntries can accept entries for many different endpoints as part of the same array).

The second is to act as a "pseudo-normalization" tool. RTK Query is not a "normalized" cache. However, there are times when you may want to prefill other cache entries with the contents of another endpoint, such as taking the results of a getPosts list endpoint response and prefilling the individual getPost(id) endpoint cache entries, so that components that reference an individual item endpoint already have that data available.

Currently, you can implement the "pseudo-normalization" approach by dispatching upsertQueryEntries in an endpoint lifecycle, like this:

const api = createApi({
  endpoints: (build) => ({
    getPosts: build.query<Post[], void>({
      query: () => '/posts',
      async onQueryStarted(_, { dispatch, queryFulfilled }) {
        const res = await queryFulfilled
        const posts = res.data

        // Pre-fill the individual post entries with the results
        // from the list endpoint query
        dispatch(
          api.util.upsertQueryEntries(
            posts.map((post) => ({
              endpointName: 'getPost',
              arg: { id: post.id },
              value: post,
            })),
          ),
        )
      },
    }),
    getPost: build.query<Post, Pick<Post, 'id'>>({
      query: (post) => `post/${post.id}`,
    }),
  }),
})

Down the road we may add a new option to query endpoints that would let you provide the mapping function and have it automatically update the corresponding entries.

For additional comparisons between upsertQueryData and upsertQueryEntries, see the upsertQueryEntries API reference.

prepareHeaders Options

The prepareHeaders callback for fetchBaseQuery now receives two additional values in the api argument:

  • arg: the URL string or FetchArgs object that was passed in to fetchBaseQuery for this endpoint
  • extraOptions: any extra options that were provided to the base query

Additional TS Types

We've added a TypedQueryStateSelector type that can be used to pre-type selectors for use with selectFromResult:

const typedSelectFromResult: TypedQueryStateSelector<
  PostsApiResponse,
  QueryArgument,
  BaseQueryFunction,
  SelectedResult
> = (state) => ({ posts: state.data?.posts ?? EMPTY_ARRAY })

function PostsList() {
  const { posts } = useGetPostsQuery(undefined, {
    selectFromResult: typedSelectFromResult,
  })
}

We've also exported several additional TS types around base queries and tag definitions.

What's Changed

Full Changelog: v2.2.8...v2.3.0

Contributors

markerikson, phryneas, and 3 other contributors
Assets 2
Loading

RTK-Query OpenAPI Codegen v2.0.0

14 Oct 17:59
@markerikson markerikson
@rtk-query/[email protected]
b7b3df6
Compare
Choose a tag to compare
RTK-Query OpenAPI Codegen v2.0.0

This major release revamps the build and publishing setup for the RTK Query OpenAPI Codegen, as well as merging numerous PRs from external contributors.

This should resolve many outstanding issues and feature requests.

There were no changes from 2.0.0-alpha.0.

What's Changed

Contributors

FabianFrank, markerikson, and 11 other contributors
Assets 2
Loading
0 Join discussion

v2.2.8

08 Oct 03:20
@markerikson markerikson
v2.2.8
e7540a5
Compare
Choose a tag to compare
v2.2.8

This bugfix release fixes a long-standing issue with RTK Query lazy query triggers returning stale data in some cases, fixes an error handling issue in RTK Query, and exports additional TS types.

Changelog

Lazy Query Trigger Handling

We'd had a couple long-standing issues reporting that const result = await someLazyQueryTrigger() sometimes returned stale data, especially if a mutation had just invalidated that query's tag.

We finally got a good repro of this issue and identified it as a mis-written call inside of the middleware that skipped past the necessary handling to activate the correct query status tracking in that scenario. This should now be fixed.

Other Changes

Timeout handling in RTKQ endpoints should now correctly throw a timeout-related error instead of an AbortError.

Base queries now have access to the current queryCacheKey value so it can be used in deciding query logic.

We've exported several more TS types related to query options, as some users have been depending on those even though they previously weren't part of the public API.

What's Changed

Full Changelog: v2.2.7...v2.2.8

Contributors

andrejpavlovic, phryneas, and 3 other contributors
Assets 2
Loading

RTK-Query OpenAPI Codegen v2.0.0-alpha.0

30 Aug 23:07
@markerikson markerikson
@rtk-query/[email protected]
8b32304
Compare
Choose a tag to compare
RTK-Query OpenAPI Codegen v2.0.0-alpha.0

This alpha release revamps the build and publishing setup for the RTK Query OpenAPI Codegen, as well as merging numerous PRs from external contributors.

This should resolve many outstanding issues and feature requests.

What's Changed

Contributors

FabianFrank, markerikson, and 11 other contributors
Assets 2
Loading
0 Join discussion

RTK-Query OpenAPI Codegen v1.2.0

30 Aug 23:05
@markerikson markerikson
@rtk-query/[email protected]
7536b8b
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
RTK-Query OpenAPI Codegen v1.2.0

This rolls up several existing minor releases:

1.2.0 - 2023-11-09

This version adds a new mergeReadWriteOnly configuration option (default to false) that, when set to true will not generate separate types for read-only and write-only properties.

1.1.3 - 2023-10-11

Added

1.1.2 - 2023-10-11

Added

  • Support for Read Only Properties in the Open API spec. Previously, this property was ignored.
    • Now if the readOnly property is present and set to true in a schema, it will split the type into two types: one with the read only property suffixed as 'Read' and the other without the read only properties, using the same type name as before.
    • This may cause issues if you had your OpenAPI spec properly typed/configured, as it will remove the read onyl types from your existing type. You will need to switch to the new type suffixed as 'Read' to avoid missing property names.

1.1.1 - 2023-10-11

Changed

Assets 2
Loading

RTK-Query OpenAPI Codegen v1.1.0

30 Aug 23:03
@markerikson markerikson
@rtk-query/[email protected]
81dd5b4
Compare
Choose a tag to compare
RTK-Query OpenAPI Codegen v1.1.0

Changelog

Added:

  • Option of generating real TS enums instead of string unions Adds the option of generating real TS enums instead of string unions #2854
  • Compatibility with TypeScript 5.x versions as the codegen relies on the TypeScript AST for code generation
    • As a result also needs a higher TypeScript version to work with (old version range was 4.1-4.5)
  • Changes dependency from a temporarily patched old version of oazapfts back to the current upstream version
Assets 2
Loading

v2.2.7

27 Jul 17:40
@markerikson markerikson
v2.2.7
75b4f69
Compare
Choose a tag to compare
v2.2.7

This bugfix release fixes issues with "TS type portability" errors, improves build artifact tree shaking behavior, and exports some additional TS types.

Changelog

TS Type Portability

We've had a slew of issues reported around "TS type portability" errors, such as:

The error messages are typically along the lines of:

Type error: The inferred type of 'configureStore' cannot be named without a reference to '@reduxjs/toolkit/node_modules/redux'. This is likely not portable. A type annotation is necessary.

@aryaemami59 did some deep investigation and concluded these were due to a mixture of using interface instead of type in most places, not pre-bundling our TS typedefs, and not exporting some of the unique symbols we use internally.

Arya put together a highly detailed writeup and set of fixes in #4467: Fix: TypeScript Type Portability Issues, and that appears to resolve all of those issues we've seen. Thank you!

Other Changes

Arya also did significant work to improve RTK's treeshaking, tweaking internal definitions to let bundlers better separate out unused code.

We've exported additional types like UpdateDefinitions and RetryOptions, per request.

listenerMiddleware.withTypes() methods now allow passing in an ExtraArgument generic.

What's Changed

Full Changelog: v2.2.6...v2.2.7

Contributors

joekrill, markerikson, and 2 other contributors
Assets 2
Loading

v2.2.6

29 Jun 11:10
@EskiMojo14 EskiMojo14
v2.2.6
a9362fb
Compare
Choose a tag to compare
v2.2.6

This bugfix release:

  • Brings internal useIsomorphicLayoutEffect usage in line with React Redux in React Native environments
  • Exports FetchBaseQueryArgs type
  • Fixes an issue in recent createEntityAdapter sorting perf improvements that could (in specific cases) cause Immer to throw an error

What's Changed

Full Changelog: v2.2.5...v2.2.6

Contributors

JacobShafer, WilsonCWong, and 2 other contributors
Assets 2
Loading