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

• Adds a temporary workaround for 4.9.0 and 4.10.0 generate circular types oazapfts/oazapfts#491

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

• Codegen: better handling of duplicate param names (Codegen: better handling of duplicate param names #3780)
  • If a parameter name is both used in a query and a parameter, it will be prefixed with query/param now to avoid conflicts

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

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:

• #1806
• #3962
• #3983

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

• Fix: TypeScript Type Portability Issues by @aryaemami59 in #4467
• Export UpdateDefinitions from toolkit/query by @joekrill in #4519
• feat: Adds ExtraArgument to withTypes for listenerMiddleware. by @antondalgren in #4517
• Improve treeshakeability of build artifacts by @aryaemami59 in #4435
• Export RetryOptions by @markerikson in #4529

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

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

• Fix useIsomorphicLayoutEffect usage in React Native environments by @aryaemami59 in #4436
• Add export for FetchBaseQueryArgs by @WilsonCWong in #4465
• Fix Immer current usage when calling addManyMutably more than once by @JacobShafer in #4420
• Golf a few pieces of entity adapter code by @EskiMojo14 in #4485

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

v2.2.5

This bugfix release fixes an issue in the recent createEntityAdapter sorting perf improvements that could (in specific cases) cause Immer to throw an error when trying to read a plain JS value instead of a proxy-wrapped value.

What's Changed

• Fix missed spot where use of current may fail if the value is not a draft by @markerikson in #4412

Full Changelog: v2.2.4...v2.2.5

v2.2.4

This bugfix release improves sorting performance in createEntityAdapter, shrinks the code size in matcher utilities, fixes assorted issues with query hooks, and makes several TS tweaks.

Changelog

Entity Adapter Sorting Performance

Users reported in #4252 that the sorting performance of createEntityAdapter seemed abnormally bad - the provided comparison functions were being called far more times than expected.

Upon investigation, we had a couple of problems. We were always starting from an array that was in insertion order, not the existing sorted order, and that would always require significant effort to re-sort even if there weren't any actual changes to the sorted results. Also, the sorting checks required frequent access to Immer's Proxy-wrapped values, even in cases where all we needed was the plain state values for comparison purposes.

We've reworked the internal sorting logic to always start from the existing sorted array, do reads against a plain value to avoid the Proxy getter overhead where possible, and optimized inserts into existing sorted arrays. This should significantly speed up sorted entity adapter behavior.

Matcher Code Size Optimization

We've reworked the internals of the thunk-related matchers to deduplicate some of the logic, shaving a few bytes off the final bundle size.

RTK Query Hook Updates

defaultSerializeQueryArgs can now handle BigInt values safely.

The isLoading flag logic was improved to handle errors when a query hook tries to subscribe.

TS Updates

create.asyncThunk's types were improved to avoid cases where it might infer any.

We've made several internal types changes to work correctly with React 19's upcoming types.

The retryCondition method now receives unknown as an argument, instead of always assuming the user is using fetchBaseQuery.

Other Changes

The Reselect dep has been bumped to 5.1.0 to match the expected internal usage of createSelector.withTypes().

What's Changed

• Update remaining Context references to match the new nullable Context by @aryaemami59 in #4336
• types: export GetThunkAPI type by @shrouxm in #4289
• Inline the deprecated React.ReactChild type by @aryaemami59 in #4382
• Replace usage of deprecated JSX global namespace with React.JSX by @aryaemami59 in #4381
• Fix useRef usages to be called with an explicit argument of undefined. by @aryaemami59 in #4380
• Bump reselect dependency to 5.1.0 to resolve #4200 by @aryaemami59 in #4400
• Improve sorted entity adapter sorting performance by @markerikson in #4361
• Prevent inference of any in create.asyncThunk by @EskiMojo14 in #4389
• try out simplifying matcher code by @EskiMojo14 in #4386
• Handle bigint in useQuerySubscription by @rkofman in #4315
• fix: ensure hook subscription failures do not reset isLoading state by @smacpherson64 in #4364
• Improve usability of the initiate() action for mutations. by @jared-ca in #4337
• Make retryCondition receive unknown error, as the user may not be using fetchBaseQuery by @EskiMojo14 in #3957

Full Changelog: v2.2.3...v2.2.4

v2.2.3

This bugfix release fixes the types for functions that accept a React Context instance to match the changes in React Redux v9.

What's Changed

• Update React Redux dependency to v9, and update docs to use .withTypes by @aryaemami59 in #4308

Full Changelog: v2.2.2...v2.2.3

v2.2.2

This patch release fixes an incorrect build setting for the legacy-esm artifacts, and fixes an issue with RTKQ query hooks didn't always remove the cache entries if arguments were changed rapidly.

Changes

legacy-esm Artifact Transpilation

The legacy-esm build artifacts are intended for use by Webpack 4. Those were supposed to be transpiled to target "es2017", but were in fact still set to target "esnext" - an oversight during the 2.0 development cycle. This release fixes that setting, so those artifacts are now correctly transpiled.

Other Fixes

RTKQ query hooks now handle additional actions around argument changes that should result in cache entries being removed.

Additionally, 2.2.1 contained a fix to an incorrectly named type: TypedUseMutationTrigger is now TypedMutationTrigger.

What's Changed

• rename TypedUseMutationTrigger to TypedMutationTrigger, and add deprecated alias by @EskiMojo14 in #4204
• Fixed memory leak in rapid hook arg changing by @riqts in #4268
• Fix incorrect legacy-esm target by @markerikson in #4284

Full Changelog: v2.2.0...v2.2.2

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

New Contributors

• @itz-Me-Pj made their first contribution in #4139
• @kantbtrue made their first contribution in #4161
• @kyselberg made their first contribution in #4173
• @721-atikshaikh made their first contribution in #4174
• @smff made their first contribution in #4186
• @ffluk3 made their first contribution in #4189

Full Changelog: v2.1.0...v2.2.0

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 queryFns
• marks promises that will never reject as safe, in preparation for typescript-eslint/typescript-eslint#7008

What's Changed

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

New Contributors

• @suspiciousRaccoon made their first contribution in #3611
• @fatihgnc made their first contribution in #4013
• @thisjeremiah made their first contribution in #4029
• @riqts made their first contribution in #4082
• @untilhamza made their first contribution in #4086
• @Fonger made their first contribution in #3951
• @alphonsotran made their first contribution in #3301
• @shrijan00003 made their first contribution in #3588
• @JoshuaKGoldberg made their first contribution in #4102
• @nickgirardo made their first contribution in #4116

Full Changelog: v2.0.1...v2.1.0