Merge branch 'master' of https://github.com/julian-ford/redux-toolkit into pr/add-listenerapi-cancel

Author: julian-ford

.github/workflows/tests.yml

@@ -105,7 +105,7 @@ jobs:
       fail-fast: false
       matrix:
         node: ['16.x']
-        ts: ['4.1', '4.2', '4.3', '4.4', '4.5', '4.6', '4.7', '4.8', '4.9.2-rc']
+        ts: ['4.1', '4.2', '4.3', '4.4', '4.5', '4.6', '4.7', '4.8', '4.9.5', '5.0', '5.1', '5.2']
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2

packages/toolkit/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reduxjs/toolkit",
-  "version": "1.9.6",
+  "version": "1.9.7",
   "description": "The official, opinionated, batteries-included toolset for efficient Redux development",
   "author": "Mark Erikson <mark@isquaredsoftware.com>",
   "license": "MIT",
@@ -28,6 +28,7 @@
   "types": "dist/index.d.ts",
   "devDependencies": {
     "@microsoft/api-extractor": "^7.13.2",
+    "@phryneas/ts-version": "^1.0.2",
     "@size-limit/preset-small-lib": "^4.11.0",
     "@testing-library/react": "^13.3.0",
     "@testing-library/user-event": "^13.1.5",

packages/toolkit/src/query/react/namedHooks.ts

@@ -6,26 +6,37 @@ import type {
   QueryDefinition,
 } from '@reduxjs/toolkit/query'
 
+type QueryHookNames<Definitions extends EndpointDefinitions> = {
+  [K in keyof Definitions as Definitions[K] extends {
+    type: DefinitionType.query
+  }
+    ? `use${Capitalize<K & string>}Query`
+    : never]: UseQuery<
+    Extract<Definitions[K], QueryDefinition<any, any, any, any>>
+  >
+}
+
+type LazyQueryHookNames<Definitions extends EndpointDefinitions> = {
+  [K in keyof Definitions as Definitions[K] extends {
+    type: DefinitionType.query
+  }
+    ? `useLazy${Capitalize<K & string>}Query`
+    : never]: UseLazyQuery<
+    Extract<Definitions[K], QueryDefinition<any, any, any, any>>
+  >
+}
+
+type MutationHookNames<Definitions extends EndpointDefinitions> = {
+  [K in keyof Definitions as Definitions[K] extends {
+    type: DefinitionType.mutation
+  }
+    ? `use${Capitalize<K & string>}Mutation`
+    : never]: UseMutation<
+    Extract<Definitions[K], MutationDefinition<any, any, any, any>>
+  >
+}
+
 export type HooksWithUniqueNames<Definitions extends EndpointDefinitions> =
-  keyof Definitions extends infer Keys
-    ? Keys extends string
-      ? Definitions[Keys] extends { type: DefinitionType.query }
-        ? {
-            [K in Keys as `use${Capitalize<K>}Query`]: UseQuery<
-              Extract<Definitions[K], QueryDefinition<any, any, any, any>>
-            >
-          } &
-            {
-              [K in Keys as `useLazy${Capitalize<K>}Query`]: UseLazyQuery<
-                Extract<Definitions[K], QueryDefinition<any, any, any, any>>
-              >
-            }
-        : Definitions[Keys] extends { type: DefinitionType.mutation }
-        ? {
-            [K in Keys as `use${Capitalize<K>}Mutation`]: UseMutation<
-              Extract<Definitions[K], MutationDefinition<any, any, any, any>>
-            >
-          }
-        : never
-      : never
-    : never
+  QueryHookNames<Definitions> &
+    LazyQueryHookNames<Definitions> &
+    MutationHookNames<Definitions>

packages/toolkit/src/tests/createAsyncThunk.typetest.ts

@@ -17,6 +17,7 @@ import type {
   AsyncThunkFulfilledActionCreator,
   AsyncThunkRejectedActionCreator,
 } from '@internal/createAsyncThunk'
+import type { TSVersion } from '@phryneas/ts-version'
 
 const ANY = {} as any
 const defaultDispatch = (() => {}) as ThunkDispatch<{}, any, AnyAction>
@@ -287,8 +288,22 @@ const anyAction = { type: 'foo' } as AnyAction
   // in that case, we have to forbid this behaviour or it will make arguments optional everywhere
   {
     const asyncThunk = createAsyncThunk('test', (arg?: number) => 0)
-    expectType<(arg?: number) => any>(asyncThunk)
-    asyncThunk()
+
+    // Per https://github.com/reduxjs/redux-toolkit/issues/3758#issuecomment-1742152774 , this is a bug in
+    // TS 5.1 and 5.2, that is fixed in 5.3. Conditionally run the TS assertion here.
+    type IsTS51Or52 = TSVersion.Major extends 5
+      ? TSVersion.Minor extends 1 | 2
+        ? true
+        : false
+      : false
+
+    type expectedType = IsTS51Or52 extends true
+      ? (arg: number) => any
+      : (arg?: number) => any
+    expectType<expectedType>(asyncThunk)
+    // We _should_ be able to call this with no arguments, but we run into that error in 5.1 and 5.2.
+    // Disabling this for now.
+    // asyncThunk()
     asyncThunk(5)
     // @ts-expect-error
     asyncThunk('string')

yarn.lock

@@ -6421,6 +6421,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@phryneas/ts-version@npm:^1.0.2":
+  version: 1.0.2
+  resolution: "@phryneas/ts-version@npm:1.0.2"
+  checksum: d51914a8ea35ff8b686a9379b9e9fe6d5b5feaf2e7511b880d2835015736e33bc82952bbc369918f251d4a755f32f4a9c4a34b0ec4dfdbc3e87a41d26401105c
+  languageName: node
+  linkType: hard
+
 "@pmmmwh/react-refresh-webpack-plugin@npm:^0.5.3":
   version: 0.5.7
   resolution: "@pmmmwh/react-refresh-webpack-plugin@npm:0.5.7"
@@ -6554,6 +6561,7 @@ __metadata:
   resolution: "@reduxjs/toolkit@workspace:packages/toolkit"
   dependencies:
     "@microsoft/api-extractor": ^7.13.2
+    "@phryneas/ts-version": ^1.0.2
     "@size-limit/preset-small-lib": ^4.11.0
     "@testing-library/react": ^13.3.0
     "@testing-library/user-event": ^13.1.5