remove phantom type identifying state (#100)

Author: phryneas

src/apiState.ts

@@ -149,12 +149,12 @@ export type MutationSubState<D extends BaseEndpointDefinition<any, any, any>> =
       fulfilledTimeStamp?: undefined;
     };
 
-export type CombinedState<D extends EndpointDefinitions, E extends string> = {
+export type CombinedState<D extends EndpointDefinitions, E extends string, ReducerPath extends string> = {
   queries: QueryState<D>;
   mutations: MutationState<D>;
   provided: InvalidationState<E>;
   subscriptions: SubscriptionState;
-  config: ConfigState;
+  config: ConfigState<ReducerPath>;
 };
 
 export type InvalidationState<EntityTypes extends string> = {
@@ -172,7 +172,8 @@ export type SubscriptionState = {
   [queryCacheKey: string]: Subscribers | undefined;
 };
 
-export type ConfigState = {
+export type ConfigState<ReducerPath> = RefetchConfigOptions & {
+  reducerPath: ReducerPath;
   online: boolean;
   focused: boolean;
 } & ModifiableConfigState;
@@ -185,19 +186,10 @@ export type MutationState<D extends EndpointDefinitions> = {
   [requestId: string]: MutationSubState<D[string]> | undefined;
 };
 
-const __phantomType_ReducerPath = Symbol();
-export interface QueryStatePhantomType<Identifier extends string> {
-  [__phantomType_ReducerPath]: Identifier;
-}
-
 export type RootState<
   Definitions extends EndpointDefinitions,
   EntityTypes extends string,
   ReducerPath extends string
 > = {
-  [P in ReducerPath]: CombinedState<Definitions, EntityTypes> & QueryStatePhantomType<P>;
-};
-
-export type InternalRootState<ReducerPath extends string> = {
-  [_ in ReducerPath]: CombinedState<any, string>;
+  [P in ReducerPath]: CombinedState<Definitions, EntityTypes, P>;
 };

src/apiTypes.ts

@@ -11,7 +11,7 @@ import {
   QueryDefinition,
   MutationDefinition,
 } from './endpointDefinitions';
-import { CombinedState, QueryKeys, QueryStatePhantomType, RootState } from './apiState';
+import { CombinedState, QueryKeys, RootState } from './apiState';
 import { UnionToIntersection } from './tsHelpers';
 import { TS41Hooks } from './ts41Types';
 import './buildSelectors';
@@ -63,7 +63,7 @@ export type Api<
 > = {
   reducerPath: ReducerPath;
   internalActions: InternalActions;
-  reducer: Reducer<CombinedState<Definitions, EntityTypes> & QueryStatePhantomType<ReducerPath>, AnyAction>;
+  reducer: Reducer<CombinedState<Definitions, EntityTypes, ReducerPath>, AnyAction>;
   middleware: Middleware<{}, RootState<Definitions, string, ReducerPath>, ThunkDispatch<any, any, AnyAction>>;
   util: {
     updateQueryResult: UpdateQueryResultThunk<Definitions, RootState<Definitions, string, ReducerPath>>;

src/buildSelectors.ts

@@ -15,7 +15,6 @@ import {
   EntityTypesFrom,
   ReducerPathFrom,
 } from './endpointDefinitions';
-import type { InternalState } from './buildSlice';
 import { InternalSerializeQueryArgs } from './defaultSerializeQueryArgs';
 
 export const skipSelector = Symbol('skip selector');
@@ -77,7 +76,7 @@ export function buildSelectors<InternalQueryArgs, Definitions extends EndpointDe
   }
 
   function selectInternalState(rootState: RootState) {
-    return rootState[reducerPath] as InternalState;
+    return rootState[reducerPath];
   }
 
   function buildQuerySelector(

src/buildSlice.ts

@@ -20,8 +20,6 @@ import { applyPatches, Patch } from 'immer';
 import { onFocus, onFocusLost, onOffline, onOnline } from './setupListeners';
 import { isDocumentVisible, isOnline } from './utils';
 
-export type InternalState = CombinedState<any, string>;
-
 function updateQuerySubstateIfExists(
   state: QueryState<any>,
   queryCacheKey: QueryCacheKey,
@@ -57,7 +55,7 @@ export function buildSlice({
   mutationThunk: AsyncThunk<ThunkResult, MutationThunkArg<any>, {}>;
   endpointDefinitions: EndpointDefinitions;
   assertEntityType: AssertEntityTypes;
-  config: Omit<ConfigState, 'online' | 'focused'>;
+  config: Omit<ConfigState<string>, 'online' | 'focused'>;
 }) {
   const querySlice = createSlice({
     name: `${reducerPath}/queries`,
@@ -247,7 +245,7 @@ export function buildSlice({
       online: isOnline(),
       focused: isDocumentVisible(),
       ...config,
-    } as ConfigState,
+    } as ConfigState<string>,
     reducers: {},
     extraReducers: (builder) => {
       builder
@@ -266,7 +264,7 @@ export function buildSlice({
     },
   });
 
-  const reducer = combineReducers<InternalState>({
+  const reducer = combineReducers<CombinedState<any, string, string>>({
     queries: querySlice.reducer,
     mutations: mutationSlice.reducer,
     provided: invalidationSlice.reducer,

src/buildThunks.ts

@@ -1,6 +1,6 @@
 import { InternalSerializeQueryArgs } from './defaultSerializeQueryArgs';
 import { Api, ApiEndpointQuery, BaseQueryFn, BaseQueryArg, BaseQueryError } from './apiTypes';
-import { InternalRootState, QueryKeys, QueryStatus, QuerySubstateIdentifier } from './apiState';
+import { RootState, QueryKeys, QueryStatus, QuerySubstateIdentifier } from './apiState';
 import { StartQueryActionCreatorOptions } from './buildActionMaps';
 import {
   EndpointDefinition,
@@ -144,7 +144,7 @@ export function buildThunks<
   api: Api<BaseQuery, Definitions, ReducerPath, string>;
 }) {
   type InternalQueryArgs = BaseQueryArg<BaseQuery>;
-  type State = InternalRootState<ReducerPath>;
+  type State = RootState<any, string, ReducerPath>;
 
   const patchQueryResult: PatchQueryResultThunk<EndpointDefinitions, State> = (endpointName, args, patches) => (
     dispatch
@@ -193,7 +193,7 @@ export function buildThunks<
   const queryThunk = createAsyncThunk<
     ThunkResult,
     QueryThunkArg<InternalQueryArgs>,
-    { state: InternalRootState<ReducerPath> }
+    { state: RootState<any, string, ReducerPath> }
   >(
     `${reducerPath}/executeQuery`,
     async (arg, { signal, rejectWithValue, dispatch, getState }) => {
@@ -240,7 +240,7 @@ export function buildThunks<
   const mutationThunk = createAsyncThunk<
     ThunkResult,
     MutationThunkArg<InternalQueryArgs>,
-    { state: InternalRootState<ReducerPath> }
+    { state: RootState<any, string, ReducerPath> }
   >(`${reducerPath}/executeMutation`, async (arg, { signal, rejectWithValue, ...api }) => {
     const endpoint = endpointDefinitions[arg.endpoint] as MutationDefinition<any, any, any, any>;
 

src/index.ts

@@ -1,5 +1,5 @@
 import type { AnyAction, Reducer } from '@reduxjs/toolkit';
-import type { CombinedState, ModifiableConfigState, QueryStatePhantomType } from './apiState';
+import type { CombinedState } from './apiState';
 import { Api, BaseQueryArg, BaseQueryFn } from './apiTypes';
 import { buildActionMaps } from './buildActionMaps';
 import { buildHooks } from './buildHooks';
@@ -53,7 +53,7 @@ export function createApi<
   refetchOnFocus?: boolean;
   refetchOnReconnect?: boolean;
 }): Api<BaseQuery, Definitions, ReducerPath, EntityTypes> {
-  type State = CombinedState<Definitions, EntityTypes>;
+  type State = CombinedState<Definitions, EntityTypes, ReducerPath>;
 
   type InternalQueryArgs = BaseQueryArg<BaseQuery>;
 
@@ -115,22 +115,15 @@ export function createApi<
   });
   Object.assign(api.util, { patchQueryResult, updateQueryResult });
 
-  const config: ModifiableConfigState = {
-    refetchOnFocus,
-    refetchOnReconnect,
-    refetchOnMountOrArgChange,
-    keepUnusedDataFor,
-  };
-
   const { reducer, actions: sliceActions } = buildSlice({
     endpointDefinitions,
     queryThunk,
     mutationThunk,
     reducerPath,
     assertEntityType,
-    config,
+    config: { refetchOnFocus, refetchOnReconnect, refetchOnMountOrArgChange, keepUnusedDataFor, reducerPath },
   });
-  assertCast<Reducer<State & QueryStatePhantomType<ReducerPath>, AnyAction>>(reducer);
+  assertCast<Reducer<State, AnyAction>>(reducer);
   Object.assign(api.internalActions, sliceActions);
   api.reducer = reducer;