Fix: TypeScript Type Portability Issues

[aryaemami59]

Overview

The type portability issues in this repository are primarily caused by three specific TypeScript errors:

1. TS4023: Exported variable 'useAppDispatch' has or is using name 'TimeResponse' from external module "/home/runner/work/redux-toolkit/redux-toolkit/examples/publish-ci/vite/src/app/services/times" but cannot be named.

   • Solution: This one can actually be resolved quite often by converting the problematic type from an interface to a type alias. Other times we might have to export the problematic type.

2. TS2742: The inferred type of 'useGetQuotesQuery' cannot be named without a reference to '../../../node_modules/@reduxjs/toolkit/dist/query/react/buildHooks'. This is likely not portable. A type annotation is necessary.

   • Solution: Bundling the type definitions seems to have resolved this issue.

3. TS2527: The inferred type of 'quotesApiSlice' references an inaccessible 'unique symbol' type. A type annotation is necessary.
   This one took a while for me to figure out, It turns out in order for a unique symbol type to be "accessible", the unique symbol has to be imported upon declaration, so we want something that looks like this:

   export declare const coreModuleName: unique symbol

   But dts-rollup-plugin gives us this instead:

   declare const coreModuleName: unique symbol
   export { coreModuleName }

   But TypeScript treats declare const coreModuleName: unique symbol and export { coreModuleName }; as 2 different unique symbols because each reference to coreModuleName is completely unique.

   • Solution: While somewhat hacky, I wrote a small script that takes all exported unique symbols and converts them from:

     declare const coreModuleName: unique symbol
     export { coreModuleName }

     To:

     export declare const coreModuleName: unique symbol

This PR:

• Resolves:

  • The inferred type of 'X' cannot be named without a reference to '@reduxjs/toolkit/node_modules/immer/dist/internal'. This is likely not portable. A type annotation is necessary. #1806
  • FakeBaseQuery references an inaccessible 'unique symbol' type.  #2314
  • Support for Typescript Node16 Module Resolution (RTK-Query & RTK-Query/React) #2485
  • (RTK Alpha 2): Cannot resolve types when moduleResolution is set to node16 #3202
  • [RTK v2.0]: Function createApi Types are not Portable #3568
  • 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. #3962
  • Error with tsc when attempting to import types from RTK Query using @reduxjs/toolkit 2.0.1 #3970
  • The inferred type of [...] cannot be named without a reference to [...] buildHooks.js #3983
  • Typescript errors using Node ESM module resolution and "declaration: true" #4066
  • ReducerWithInitialState is not portlable according to TS #4108
  • Export DraftableEntityState, IsAny, UseQuery and other types #4401
  • [TS2742] The inferred type of '...' cannot be named without a reference to ... #4448
  • UpdateDefinitions type not exported from @reduxjs/toolkit/dist/query/endpointDefinitions #4492
  • The inferred type of 'useLatestProductsQuery' cannot be named without a reference to '../../../node_modules/@reduxjs/toolkit/dist/query/react/buildHooks'. This is likely not portable. A type annotation is necessary. How to resolve this error?  #4498

• Converts the following types from interface to type alias:

  • AsyncThunkSliceReducerConfig
  • ReducerDefinition
  • AsyncThunkSliceReducerDefinition
  • MutationTypes
  • MutationThunkArg
  • MutationCacheLifecycleApi
  • MutationLifecycleApi
  • BaseEndpointTypes
  • CacheLifecyclePromises
  • MutationBaseLifecycleApi
  • QueryLifecyclePromises
  • LifecycleApi
  • PromiseWithKnownReason
  • QueryTypes
  • StartQueryActionCreatorOptions
  • QueryThunkArg
  • UseQuerySubscriptionOptions
  • GetSelectorsOptions
  • EndpointDefinitionWithQueryFn
  • EndpointDefinitionWithQuery

• Exports the following types:

  • StartQueryActionCreatorOptions
  • CombinedSliceReducer

• Exports the following values:

  • UNINITIALIZED_VALUE

• Removes relative declare module statements.

• Patches console-testing-library so we can run the type tests with "moduleResolution": "Bundler". Previously it would fail due to console-testing-library not having a types field in it's subpath exports.

• Adds 3 new example workspaces:

1. @examples-type-portability/bundler to test for "moduleResolution": "Bundler".
2. @examples-type-portability/nodenext-cjs to test for "moduleResolution": "NodeNext" with TypeScript's CJS syntax and "type": "commonjs" in package.json.
3. @examples-type-portability/nodenext-esm to test for "moduleResolution": "NodeNext" with ESM syntax and "type": "module" in package.json.

Things to keep in mind

• Although I prefer using interfaces, it might be worthwhile to switch to type aliases going forward. interfaces are more prone to type portability issues compared to type aliases, which often dissolve into their constituents. I highly recommend using type aliases for all new types unless interfaces are necessary (e.g., for declaration merging).

• I've noticed that using an interface as the return type of an external function often leads to type portability issues unless the interface itself is also exported.

[aryaemami59]

Alright this one should be good to go. Let me know if this needs anything.