@tanstack/query-core 5.0.0-beta.6 → 5.0.0-rc.0

package/src/types.ts

@@ -7,6 +7,8 @@ import type { QueryFilters, QueryTypeFilter } from './utils'
 import type { QueryCache } from './queryCache'
 import type { MutationCache } from './mutationCache'
 
+type NoInfer<T> = [T][T extends any ? 0 : never]
+
 export interface Register {
   // defaultError: Error
   // queryMeta: Record<string, unknown>
@@ -19,7 +21,7 @@ export type DefaultError = Register extends {
   ? TError
   : Error
 
-export type QueryKey = readonly unknown[]
+export type QueryKey = ReadonlyArray<unknown>
 
 export type QueryFunction<
   T = unknown,
@@ -27,6 +29,22 @@ export type QueryFunction<
   TPageParam = never,
 > = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>
 
+export type QueryPersister<
+  T = unknown,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = never,
+> = [TPageParam] extends [never]
+  ? (
+      queryFn: QueryFunction<T, TQueryKey, never>,
+      context: QueryFunctionContext<TQueryKey>,
+      query: Query,
+    ) => T | Promise<T>
+  : (
+      queryFn: QueryFunction<T, TQueryKey, TPageParam>,
+      context: QueryFunctionContext<TQueryKey>,
+      query: Query,
+    ) => T | Promise<T>
+
 export type QueryFunctionContext<
   TQueryKey extends QueryKey = QueryKey,
   TPageParam = never,
@@ -68,21 +86,21 @@ export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
 
 export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
   firstPage: TQueryFnData,
-  allPages: TQueryFnData[],
+  allPages: Array<TQueryFnData>,
   firstPageParam: TPageParam,
-  allPageParams: TPageParam[],
-) => TPageParam | undefined
+  allPageParams: Array<TPageParam>,
+) => TPageParam | undefined | null
 
 export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
   lastPage: TQueryFnData,
-  allPages: TQueryFnData[],
+  allPages: Array<TQueryFnData>,
   lastPageParam: TPageParam,
-  allPageParams: TPageParam[],
-) => TPageParam | undefined
+  allPageParams: Array<TPageParam>,
+) => TPageParam | undefined | null
 
-export interface InfiniteData<TData> {
-  pages: TData[]
-  pageParams: unknown[]
+export interface InfiniteData<TData, TPageParam = unknown> {
+  pages: Array<TData>
+  pageParams: Array<TPageParam>
 }
 
 export type QueryMeta = Register extends {
@@ -118,6 +136,11 @@ export interface QueryOptions<
   networkMode?: NetworkMode
   gcTime?: number
   queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>
+  persister?: QueryPersister<
+    NoInfer<TQueryFnData>,
+    NoInfer<TQueryKey>,
+    NoInfer<TPageParam>
+  >
   queryHash?: string
   queryKey?: TQueryKey
   queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
@@ -129,9 +152,7 @@ export interface QueryOptions<
    * Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic.
    * Defaults to `true`.
    */
-  structuralSharing?:
-    | boolean
-    | ((oldData: TData | undefined, newData: TData) => TData)
+  structuralSharing?: boolean | (<T>(oldData: T | undefined, newData: T) => T)
   _defaulted?: boolean
   /**
    * Additional payload to be stored on each query.
@@ -144,14 +165,14 @@ export interface QueryOptions<
   maxPages?: number
 }
 
-export interface DefaultPageParam<TPageParam = unknown> {
-  defaultPageParam: TPageParam
+export interface InitialPageParam<TPageParam = unknown> {
+  initialPageParam: TPageParam
 }
 
 export interface InfiniteQueryPageParamsOptions<
   TQueryFnData = unknown,
   TPageParam = unknown,
-> extends DefaultPageParam<TPageParam> {
+> extends InitialPageParam<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`.
@@ -322,7 +343,7 @@ export interface InfiniteQueryObserverOptions<
       TQueryFnData,
       TError,
       TData,
-      InfiniteData<TQueryData>,
+      InfiniteData<TQueryData, TPageParam>,
       TQueryKey,
       TPageParam
     >,
@@ -380,11 +401,11 @@ export type FetchInfiniteQueryOptions<
 > = FetchQueryOptions<
   TQueryFnData,
   TError,
-  InfiniteData<TData>,
+  InfiniteData<TData, TPageParam>,
   TQueryKey,
   TPageParam
 > &
-  DefaultPageParam<TPageParam> &
+  InitialPageParam<TPageParam> &
   FetchInfiniteQueryPages<TQueryFnData, TPageParam>
 
 export interface ResultOptions {
@@ -606,7 +627,7 @@ export type InfiniteQueryObserverResult<
   | InfiniteQueryObserverLoadingResult<TData, TError>
   | DefinedInfiniteQueryObserverResult<TData, TError>
 
-export type MutationKey = readonly unknown[]
+export type MutationKey = ReadonlyArray<unknown>
 
 export type MutationStatus = 'idle' | 'pending' | 'success' | 'error'
 

package/src/utils.ts

@@ -334,12 +334,12 @@ export function keepPreviousData<T>(
   return previousData
 }
 
-export function addToEnd<T>(items: T[], item: T, max = 0): T[] {
+export function addToEnd<T>(items: Array<T>, item: T, max = 0): Array<T> {
   const newItems = [...items, item]
   return max && newItems.length > max ? newItems.slice(1) : newItems
 }
 
-export function addToStart<T>(items: T[], item: T, max = 0): T[] {
+export function addToStart<T>(items: Array<T>, item: T, max = 0): Array<T> {
   const newItems = [item, ...items]
   return max && newItems.length > max ? newItems.slice(0, -1) : newItems
 }