Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RED-23] fix: Updated type references to resolve portable types issue #3728

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { BaseQueryApi } from '@reduxjs/toolkit/dist/query/baseQueryTypes'
import type { BaseQueryApi } from '@reduxjs/toolkit/query'
import type {
GraphQLClient,
RequestOptions,
Expand Down
2 changes: 2 additions & 0 deletions packages/toolkit/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,5 @@ export {
autoBatchEnhancer,
} from './autoBatchEnhancer'
export type { AutoBatchOptions } from './autoBatchEnhancer'

export type { ExtractDispatchExtensions as TSHelpersExtractDispatchExtensions } from './tsHelpers'
2 changes: 1 addition & 1 deletion packages/toolkit/src/query/core/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ import { coreModule, coreModuleName } from './module'

const createApi = /* @__PURE__ */ buildCreateApi(coreModule())

export { createApi, coreModule }
export { createApi, coreModule, coreModuleName }
38 changes: 35 additions & 3 deletions packages/toolkit/src/query/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
export type {
CombinedState,
QueryCacheKey,
QueryKeys,
QuerySubState,
RootState,
SubscriptionOptions,
} from './core/apiState'
export { QueryStatus } from './core/apiState'
export type { Api, Module, ApiModules } from './apiTypes'
export type { Api, ApiContext, ApiModules, Module } from './apiTypes'
export type {
BaseQueryApi,
BaseQueryEnhancer,
Expand All @@ -11,6 +19,9 @@ export type {
QueryDefinition,
MutationDefinition,
TagDescription,
QueryArgFrom,
ResultTypeFrom,
DefinitionType,
} from './endpointDefinitions'
export { fetchBaseQuery } from './fetchBaseQuery'
export type {
Expand All @@ -21,10 +32,31 @@ export type {
export { retry } from './retry'
export { setupListeners } from './core/setupListeners'
export { skipSelector, skipToken } from './core/buildSelectors'
export type { SkipToken } from './core/buildSelectors'
export type {
QueryResultSelectorResult,
MutationResultSelectorResult,
SkipToken,
} from './core/buildSelectors'
export type {
QueryActionCreatorResult,
MutationActionCreatorResult,
} from './core/buildInitiate'
export type { CreateApi, CreateApiOptions } from './createApi'
export { buildCreateApi } from './createApi'
export { fakeBaseQuery } from './fakeBaseQuery'
export { copyWithStructuralSharing } from './utils/copyWithStructuralSharing'
export { createApi, coreModule } from './core'
export { createApi, coreModule, coreModuleName } from './core'
export type {
ApiEndpointMutation,
ApiEndpointQuery,
CoreModule,
PrefetchOptions,
} from './core/module'
export { defaultSerializeQueryArgs } from './defaultSerializeQueryArgs'
export type { SerializeQueryArgs } from './defaultSerializeQueryArgs'

export type {
Id as TSHelpersId,
NoInfer as TSHelpersNoInfer,
Override as TSHelpersOverride,
} from './tsHelpers'
2 changes: 1 addition & 1 deletion packages/toolkit/src/query/react/ApiProvider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import React from 'react'
import type { ReactReduxContextValue } from 'react-redux'
import { Provider } from 'react-redux'
import { setupListeners } from '@reduxjs/toolkit/query'
import type { Api } from '@reduxjs/toolkit/dist/query/apiTypes'
import type { Api } from '@reduxjs/toolkit/query'

/**
* Can be used as a `Provider` if you **do not already have a Redux store**.
Expand Down
34 changes: 17 additions & 17 deletions packages/toolkit/src/query/react/buildHooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,37 +17,37 @@ import type {
SubscriptionOptions,
QueryKeys,
RootState,
} from '@reduxjs/toolkit/dist/query/core/apiState'
} from '@reduxjs/toolkit/query'
import type {
EndpointDefinitions,
MutationDefinition,
QueryDefinition,
QueryArgFrom,
ResultTypeFrom,
} from '@reduxjs/toolkit/dist/query/endpointDefinitions'
} from '@reduxjs/toolkit/query'
import type {
QueryResultSelectorResult,
MutationResultSelectorResult,
SkipToken,
} from '@reduxjs/toolkit/dist/query/core/buildSelectors'
} from '@reduxjs/toolkit/query'
import type {
QueryActionCreatorResult,
MutationActionCreatorResult,
} from '@reduxjs/toolkit/dist/query/core/buildInitiate'
import type { SerializeQueryArgs } from '@reduxjs/toolkit/dist/query/defaultSerializeQueryArgs'
} from '@reduxjs/toolkit/query'
import type { SerializeQueryArgs } from '@reduxjs/toolkit/query'
import { shallowEqual } from 'react-redux'
import type { Api, ApiContext } from '@reduxjs/toolkit/dist/query/apiTypes'
import type { Api, ApiContext } from '@reduxjs/toolkit/query'
import type {
Id,
NoInfer,
Override,
} from '@reduxjs/toolkit/dist/query/tsHelpers'
TSHelpersId,
TSHelpersNoInfer,
TSHelpersOverride,
} from '@reduxjs/toolkit/query'
import type {
ApiEndpointMutation,
ApiEndpointQuery,
CoreModule,
PrefetchOptions,
} from '@reduxjs/toolkit/dist/query/core/module'
} from '@reduxjs/toolkit/query'
import type { ReactHooksModuleOptions } from './module'
import { useStableQueryArgs } from './useSerializedStableValue'
import type { UninitializedValue } from './constants'
Expand Down Expand Up @@ -374,7 +374,7 @@ export type UseQueryStateOptions<
export type UseQueryStateResult<
_ extends QueryDefinition<any, any, any, any>,
R
> = NoInfer<R>
> = TSHelpersNoInfer<R>

/**
* Helper type to manually type the result
Expand All @@ -387,7 +387,7 @@ export type TypedUseQueryStateResult<
R = UseQueryStateDefaultResult<
QueryDefinition<QueryArg, BaseQuery, string, ResultType, string>
>
> = NoInfer<R>
> = TSHelpersNoInfer<R>

type UseQueryStateBaseResult<D extends QueryDefinition<any, any, any, any>> =
QuerySubState<D> & {
Expand Down Expand Up @@ -420,15 +420,15 @@ type UseQueryStateBaseResult<D extends QueryDefinition<any, any, any, any>> =
}

type UseQueryStateDefaultResult<D extends QueryDefinition<any, any, any, any>> =
Id<
| Override<
TSHelpersId<
| TSHelpersOverride<
Extract<
UseQueryStateBaseResult<D>,
{ status: QueryStatus.uninitialized }
>,
{ isUninitialized: true }
>
| Override<
| TSHelpersOverride<
UseQueryStateBaseResult<D>,
| { isLoading: true; isFetching: boolean; data: undefined }
| ({
Expand Down Expand Up @@ -477,7 +477,7 @@ export type UseMutationStateOptions<
export type UseMutationStateResult<
D extends MutationDefinition<any, any, any, any>,
R
> = NoInfer<R> & {
> = TSHelpersNoInfer<R> & {
originalArgs?: QueryArgFrom<D>
/**
* Resets the hook state to it's initial `uninitialized` state.
Expand Down
16 changes: 2 additions & 14 deletions packages/toolkit/src/query/react/index.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,6 @@
import { coreModule, buildCreateApi, CreateApi } from '@reduxjs/toolkit/query'
import { coreModule, buildCreateApi } from '@reduxjs/toolkit/query'
import { reactHooksModule, reactHooksModuleName } from './module'

import type { MutationHooks, QueryHooks } from './buildHooks'
import type {
EndpointDefinitions,
QueryDefinition,
MutationDefinition,
QueryArgFrom,
} from '@reduxjs/toolkit/dist/query/endpointDefinitions'
import type { BaseQueryFn } from '@reduxjs/toolkit/dist/query/baseQueryTypes'

import type { QueryKeys } from '@reduxjs/toolkit/dist/query/core/apiState'
import type { PrefetchOptions } from '@reduxjs/toolkit/dist/query/core/module'

export * from '@reduxjs/toolkit/query'
export { ApiProvider } from './ApiProvider'

Expand All @@ -27,4 +15,4 @@ export type {
TypedUseQuerySubscriptionResult,
TypedUseMutationResult,
} from './buildHooks'
export { createApi, reactHooksModule }
export { createApi, reactHooksModule, reactHooksModuleName }
6 changes: 3 additions & 3 deletions packages/toolkit/src/query/react/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ import type {
QueryDefinition,
MutationDefinition,
QueryArgFrom,
} from '@reduxjs/toolkit/dist/query/endpointDefinitions'
} from '@reduxjs/toolkit/query'
import type { Api, Module } from '../apiTypes'
import { capitalize } from '../utils'
import { safeAssign } from '../tsHelpers'
import type { BaseQueryFn } from '@reduxjs/toolkit/dist/query/baseQueryTypes'
import type { BaseQueryFn } from '@reduxjs/toolkit/query'

import type { HooksWithUniqueNames } from './namedHooks'

Expand All @@ -26,7 +26,7 @@ import type { PrefetchOptions } from '../core/module'
export const reactHooksModuleName = /* @__PURE__ */ Symbol()
export type ReactHooksModule = typeof reactHooksModuleName

declare module '@reduxjs/toolkit/dist/query/apiTypes' {
declare module '@reduxjs/toolkit/query' {
export interface ApiModules<
// eslint-disable-next-line @typescript-eslint/no-unused-vars
BaseQuery extends BaseQueryFn,
Expand Down
2 changes: 1 addition & 1 deletion packages/toolkit/src/query/react/namedHooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type {
EndpointDefinitions,
MutationDefinition,
QueryDefinition,
} from '@reduxjs/toolkit/dist/query/endpointDefinitions'
} from '@reduxjs/toolkit/query'

export type HooksWithUniqueNames<Definitions extends EndpointDefinitions> =
keyof Definitions extends infer Keys
Expand Down
4 changes: 2 additions & 2 deletions packages/toolkit/src/query/react/useSerializedStableValue.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { useEffect, useRef, useMemo } from 'react'
import type { SerializeQueryArgs } from '@reduxjs/toolkit/dist/query/defaultSerializeQueryArgs'
import type { EndpointDefinition } from '@reduxjs/toolkit/dist/query/endpointDefinitions'
import type { SerializeQueryArgs } from '@reduxjs/toolkit/query'
import type { EndpointDefinition } from '@reduxjs/toolkit/query'

export function useStableQueryArgs<T>(
queryArgs: T,
Expand Down