WIP Try separating QueryArg and PageParam for infinite queries

Author: markerikson

packages/toolkit/src/query/core/apiState.ts

@@ -7,6 +7,8 @@ import type {
   BaseEndpointDefinition,
   ResultTypeFrom,
   QueryArgFrom,
+  InfiniteQueryDefinition,
+  PageParamFrom,
 } from '../endpointDefinitions'
 import type { Id, WithRequiredProp } from '../tsHelpers'
 
@@ -28,24 +30,21 @@ export type RefetchConfigOptions = {
   refetchOnFocus: boolean
 }
 
-export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
+export type GetNextPageParamFunction<TPageParam, TQueryFnData> = (
   lastPage: TQueryFnData,
   allPages: Array<TQueryFnData>,
   lastPageParam: TPageParam,
   allPageParams: Array<TPageParam>,
 ) => TPageParam | undefined | null
 
-export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
+export type GetPreviousPageParamFunction<TPageParam, TQueryFnData> = (
   firstPage: TQueryFnData,
   allPages: Array<TQueryFnData>,
   firstPageParam: TPageParam,
   allPageParams: Array<TPageParam>,
 ) => TPageParam | undefined | null
 
-export type InfiniteQueryConfigOptions<
-  TQueryFnData = unknown,
-  TPageParam = unknown,
-> = {
+export type InfiniteQueryConfigOptions<TQueryFnData, TPageParam> = {
   /**
    * This function can be set to automatically get the previous cursor for infinite queries.
    * The result will also be used to determine the value of `hasPreviousPage`.
@@ -54,7 +53,7 @@ export type InfiniteQueryConfigOptions<
   getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
 }
 
-export interface InfiniteData<TData, TPageParam = unknown> {
+export interface InfiniteData<TData, TPageParam> {
   pages: Array<TData>
   pageParams: Array<TPageParam>
 }
@@ -239,15 +238,18 @@ export type QuerySubState<
 
 export type InfiniteQuerySubState<
   D extends BaseEndpointDefinition<any, any, any>,
-> = QuerySubState<D, InfiniteData<ResultTypeFrom<D>>> & {
-  // TODO: These shouldn't be optional
-  hasNextPage?: boolean
-  hasPreviousPage?: boolean
-  isFetchingNextPage?: boolean
-  isFetchingPreviousPage?: boolean
-  param?: QueryArgFrom<D>
-  direction?: 'forward' | 'backwards'
-}
+> =
+  D extends InfiniteQueryDefinition<any, any, any, any, any>
+    ? QuerySubState<D, InfiniteData<ResultTypeFrom<D>, PageParamFrom<D>>> & {
+        // TODO: These shouldn't be optional
+        hasNextPage?: boolean
+        hasPreviousPage?: boolean
+        isFetchingNextPage?: boolean
+        isFetchingPreviousPage?: boolean
+        param?: PageParamFrom<D>
+        direction?: 'forward' | 'backwards'
+      }
+    : never
 
 type BaseMutationSubState<D extends BaseEndpointDefinition<any, any, any>> = {
   requestId: string

packages/toolkit/src/query/core/buildInitiate.ts

@@ -70,10 +70,10 @@ export type StartInfiniteQueryActionCreatorOptions = {
   subscribe?: boolean
   forceRefetch?: boolean | number
   subscriptionOptions?: SubscriptionOptions
-  infiniteQueryOptions?: InfiniteQueryConfigOptions
+  infiniteQueryOptions?: InfiniteQueryConfigOptions<unknown, unknown>
   direction?: 'forward' | 'backwards'
   [forceQueryFnSymbol]?: () => QueryReturnValue
-  data?: InfiniteData<unknown>
+  data?: InfiniteData<unknown, unknown>
   param?: unknown
   previous?: boolean
 }
@@ -112,7 +112,7 @@ export type QueryActionCreatorResult<
 }
 
 export type InfiniteQueryActionCreatorResult<
-  D extends InfiniteQueryDefinition<any, any, any, any>,
+  D extends InfiniteQueryDefinition<any, any, any, any, any>,
 > = Promise<InfiniteQueryResultSelectorResult<D>> & {
   arg: QueryArgFrom<D>
   requestId: string
@@ -480,7 +480,7 @@ You must add the middleware for RTK-Query to function correctly!`,
 
   function buildInitiateInfiniteQuery(
     endpointName: string,
-    endpointDefinition: InfiniteQueryDefinition<any, any, any, any>,
+    endpointDefinition: InfiniteQueryDefinition<any, any, any, any, any>,
     pages?: number,
   ) {
     const infiniteQueryAction: StartInfiniteQueryActionCreator<any> =

packages/toolkit/src/query/core/buildSelectors.ts

@@ -105,14 +105,14 @@ export type QueryResultSelectorResult<
 > = QuerySubState<Definition> & RequestStatusFlags
 
 type InfiniteQueryResultSelectorFactory<
-  Definition extends InfiniteQueryDefinition<any, any, any, any>,
+  Definition extends InfiniteQueryDefinition<any, any, any, any, any>,
   RootState,
 > = (
   queryArg: QueryArgFrom<Definition> | SkipToken,
 ) => (state: RootState) => InfiniteQueryResultSelectorResult<Definition>
 
 export type InfiniteQueryResultSelectorResult<
-  Definition extends InfiniteQueryDefinition<any, any, any, any>,
+  Definition extends InfiniteQueryDefinition<any, any, any, any, any>,
 > = InfiniteQuerySubState<Definition> & RequestStatusFlags
 
 type MutationResultSelectorFactory<
@@ -215,7 +215,7 @@ export function buildSelectors<
   // selector currently is just a clone of Query though
   function buildInfiniteQuerySelector(
     endpointName: string,
-    endpointDefinition: InfiniteQueryDefinition<any, any, any, any>,
+    endpointDefinition: InfiniteQueryDefinition<any, any, any, any, any>,
   ) {
     return ((queryArgs: any) => {
       const serializedArgs = serializeQueryArgs({

packages/toolkit/src/query/core/buildThunks.ts

@@ -122,7 +122,7 @@ export type InfiniteQueryThunkArg = QuerySubstateIdentifier &
     type: `query`
     originalArgs: unknown
     endpointName: string
-    data: InfiniteData<unknown>
+    data: InfiniteData<unknown, unknown>
     param: unknown
     previous?: boolean
     direction?: 'forward' | 'backwards'
@@ -426,7 +426,7 @@ export function buildThunks<
         const oldPageParams: any[] = []
 
         const fetchPage = async (
-          data: InfiniteData<unknown>,
+          data: InfiniteData<unknown, unknown>,
           param: unknown,
           previous?: boolean,
         ): Promise<QueryReturnValue> => {
@@ -480,10 +480,10 @@ export function buildThunks<
               // @ts-ignore
               const param = getNextPageParam(
                 endpointDefinition.infiniteQueryOptions,
-                result.data as InfiniteData<unknown>,
+                result.data as InfiniteData<unknown, unknown>,
               )
               result = await fetchPage(
-                result.data as InfiniteData<unknown>,
+                result.data as InfiniteData<unknown, unknown>,
                 param,
               )
             }
@@ -601,8 +601,8 @@ In the case of an unhandled error, no tags will be "provided" or "invalidated".`
   }
 
   function getNextPageParam(
-    options: InfiniteQueryConfigOptions<any>,
-    { pages, pageParams }: InfiniteData<unknown>,
+    options: InfiniteQueryConfigOptions<unknown, unknown>,
+    { pages, pageParams }: InfiniteData<unknown, unknown>,
   ): unknown | undefined {
     const lastIndex = pages.length - 1
     return options.getNextPageParam(
@@ -614,8 +614,8 @@ In the case of an unhandled error, no tags will be "provided" or "invalidated".`
   }
 
   function getPreviousPageParam(
-    options: InfiniteQueryConfigOptions<any>,
-    { pages, pageParams }: InfiniteData<unknown>,
+    options: InfiniteQueryConfigOptions<unknown, unknown>,
+    { pages, pageParams }: InfiniteData<unknown, unknown>,
   ): unknown | undefined {
     return options.getPreviousPageParam?.(
       pages[0],