drop pre-TS-4.1 types and workarounds (#2249)

* drop pre-4.1 type compatibility hack * update test matrix, remove pre41 annotations
reduxjs · Apr 18, 2022 · c5d5335 · c5d5335
1 parent a00b8b8
commit c5d5335
Show file tree

Hide file tree

Showing 9 changed files with 3 additions and 53 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -96,7 +96,7 @@ jobs:
       fail-fast: false
       matrix:
         node: ['14.x']
-        ts: ['4.1', '4.2', '4.3', '4.4', '4.5', '4.6.1-rc', 'next']
+        ts: ['4.1', '4.2', '4.3', '4.4', '4.5', '4.6', '4.7.0-beta', 'next']
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
@@ -123,10 +123,6 @@ jobs:
 
       - run: sed -i -e /@remap-prod-remove-line/d ./tsconfig.base.json ./jest.config.js ./src/tests/*.* ./src/query/tests/*.*
 
-      - name: "@ts-ignore stuff that didn't exist pre-4.1 in the tests"
-        if: ${{ matrix.ts < 4.1 }}
-        run: sed -i -e 's/@pre41-ts-ignore/@ts-ignore/' -e  '/pre41-remove-start/,/pre41-remove-end/d' ./src/tests/*.* ./src/query/tests/*.ts*
-
       - name: Test types
         run: |
           yarn tsc --version

diff --git a/packages/toolkit/scripts/build.ts b/packages/toolkit/scripts/build.ts
@@ -326,13 +326,6 @@ async function main({ skipExtraction = false, local = false }: BuildArgs) {
     await buildUMD(outputPath, entryPoint.prefix, entryPoint.globalName)
   }
 
-  // We need one additional package.json file in dist to support
-  // versioned types for TS <4.1
-  fs.copyFileSync(
-    'src/query/react/versionedTypes/package.dist.json',
-    'dist/query/react/versionedTypes/package.json'
-  )
-
   if (!skipExtraction) {
     for (let entryPoint of entryPoints) {
       try {

diff --git a/packages/toolkit/src/query/react/module.ts b/packages/toolkit/src/query/react/module.ts
@@ -12,7 +12,7 @@ import { capitalize } from '../utils'
 import { safeAssign } from '../tsHelpers'
 import type { BaseQueryFn } from '@reduxjs/toolkit/dist/query/baseQueryTypes'
 
-import type { HooksWithUniqueNames } from './versionedTypes'
+import type { HooksWithUniqueNames } from './namedHooks'
 
 import {
   useDispatch as rrUseDispatch,

diff --git a/...c/query/react/versionedTypes/ts41Types.ts → ...ges/toolkit/src/query/react/namedHooks.ts b/...c/query/react/versionedTypes/ts41Types.ts → ...ges/toolkit/src/query/react/namedHooks.ts
@@ -1,13 +1,11 @@
-import type { UseMutation, UseLazyQuery, UseQuery } from '../buildHooks'
+import type { UseMutation, UseLazyQuery, UseQuery } from './buildHooks'
 import type {
   DefinitionType,
   EndpointDefinitions,
   MutationDefinition,
   QueryDefinition,
 } from '@reduxjs/toolkit/dist/query/endpointDefinitions'
 
-// For TS 4.1 and later, we can use string literal types to define
-// the exact names of each endpoint's exported hooks
 export type HooksWithUniqueNames<Definitions extends EndpointDefinitions> =
   keyof Definitions extends infer Keys
     ? Keys extends string

diff --git a/packages/toolkit/src/query/react/versionedTypes/index.ts b/packages/toolkit/src/query/react/versionedTypes/index.ts
diff --git a/packages/toolkit/src/query/react/versionedTypes/package.dist.json b/packages/toolkit/src/query/react/versionedTypes/package.dist.json
diff --git a/packages/toolkit/src/query/react/versionedTypes/ts40Types.ts b/packages/toolkit/src/query/react/versionedTypes/ts40Types.ts
diff --git a/packages/toolkit/src/query/tests/buildHooks.test.tsx b/packages/toolkit/src/query/tests/buildHooks.test.tsx
@@ -1828,14 +1828,10 @@ describe('hooks with createApi defaults set', () => {
 
     const storeRef = setupApiStore(api)
 
-    // @pre41-ts-ignore
     expectExactType(api.useGetPostsQuery)(api.endpoints.getPosts.useQuery)
-    // @pre41-ts-ignore
     expectExactType(api.useUpdatePostMutation)(
-      // @pre41-ts-ignore
       api.endpoints.updatePost.useMutation
     )
-    // @pre41-ts-ignore
     expectExactType(api.useAddPostMutation)(api.endpoints.addPost.useMutation)
 
     test('useQueryState serves a deeply memoized value and does not rerender unnecessarily', async () => {

diff --git a/packages/toolkit/src/query/tests/unionTypes.test.ts b/packages/toolkit/src/query/tests/unionTypes.test.ts
@@ -141,7 +141,6 @@ describe.skip('TS only tests', () => {
       expectType<never>(result)
     }
   })
-  // pre41-remove-start
   test('useQuery TS4.1 union', () => {
     const result = api.useTestQuery()
 
@@ -207,7 +206,6 @@ describe.skip('TS only tests', () => {
       expectType<never>(result)
     }
   })
-  // pre41-remove-end
 
   test('useLazyQuery union', () => {
     const [_trigger, result] = api.endpoints.test.useLazyQuery()
@@ -275,7 +273,6 @@ describe.skip('TS only tests', () => {
     }
   })
 
-  // pre41-remove-start
   test('useLazyQuery TS4.1 union', () => {
     const [_trigger, result] = api.useLazyTestQuery()
 
@@ -341,7 +338,6 @@ describe.skip('TS only tests', () => {
       expectType<never>(result)
     }
   })
-  // pre41-remove-end
 
   test('queryHookResult (without selector) union', () => {
     const useQueryStateResult = api.endpoints.test.useQueryState()
@@ -501,7 +497,6 @@ describe.skip('TS only tests', () => {
     })(result)
   })
 
-  // pre41-remove-start
   test('useMutation TS4.1 union', () => {
     const [_trigger, result] = api.useMutationMutation()
 
@@ -552,5 +547,4 @@ describe.skip('TS only tests', () => {
       expectType<never>(result)
     }
   })
-  // pre41-remove-end
 })