'use client' import * as React from 'react' import { QueriesObserver, QueryObserver, notifyManager, } from '@tanstack/query-core' import { useQueryClient } from './QueryClientProvider' import { useIsRestoring } from './isRestoring' import { useQueryErrorResetBoundary } from './QueryErrorResetBoundary' import { ensurePreventErrorBoundaryRetry, getHasError, useClearResetErrorBoundary, } from './errorBoundaryUtils' import { ensureStaleTime, fetchOptimistic, shouldSuspend, willFetch, } from './suspense' import type { DefinedUseQueryResult, UseQueryOptions, UseQueryResult, } from './types' import type { DefaultError, OmitKeyof, QueriesObserverOptions, QueriesPlaceholderDataFunction, QueryClient, QueryFunction, QueryKey, QueryObserverOptions, SkipToken, ThrowOnError, } from '@tanstack/query-core' // This defines the `UseQueryOptions` that are accepted in `QueriesOptions` & `GetOptions`. // `placeholderData` function always gets undefined passed type UseQueryOptionsForUseQueries< TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, > = OmitKeyof< UseQueryOptions, 'placeholderData' > & { placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction } // Avoid TS depth-limit error in case of large array literal type MAXIMUM_DEPTH = 20 type GetOptions = // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData } T extends { queryFnData: infer TQueryFnData error?: infer TError data: infer TData } ? UseQueryOptionsForUseQueries : T extends { queryFnData: infer TQueryFnData; error?: infer TError } ? UseQueryOptionsForUseQueries : T extends { data: infer TData; error?: infer TError } ? UseQueryOptionsForUseQueries : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData] T extends [infer TQueryFnData, infer TError, infer TData] ? UseQueryOptionsForUseQueries : T extends [infer TQueryFnData, infer TError] ? UseQueryOptionsForUseQueries : T extends [infer TQueryFnData] ? UseQueryOptionsForUseQueries : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided T extends { queryFn?: | QueryFunction | SkipToken select?: (data: any) => infer TData throwOnError?: ThrowOnError } ? UseQueryOptionsForUseQueries< TQueryFnData, TError, TData, TQueryKey > : T extends { queryFn?: | QueryFunction | SkipToken throwOnError?: ThrowOnError } ? UseQueryOptionsForUseQueries< TQueryFnData, TError, TQueryFnData, TQueryKey > : // Fallback UseQueryOptionsForUseQueries // A defined initialData setting should return a DefinedUseQueryResult rather than UseQueryResult type GetDefinedOrUndefinedQueryResult = T extends { initialData?: infer TInitialData } ? unknown extends TInitialData ? UseQueryResult : TInitialData extends TData ? DefinedUseQueryResult : TInitialData extends () => infer TInitialDataResult ? unknown extends TInitialDataResult ? UseQueryResult : TInitialDataResult extends TData ? DefinedUseQueryResult : UseQueryResult : UseQueryResult : UseQueryResult type GetResults = // Part 1: responsible for mapping explicit type parameter to function result, if object T extends { queryFnData: any; error?: infer TError; data: infer TData } ? GetDefinedOrUndefinedQueryResult : T extends { queryFnData: infer TQueryFnData; error?: infer TError } ? GetDefinedOrUndefinedQueryResult : T extends { data: infer TData; error?: infer TError } ? GetDefinedOrUndefinedQueryResult : // Part 2: responsible for mapping explicit type parameter to function result, if tuple T extends [any, infer TError, infer TData] ? GetDefinedOrUndefinedQueryResult : T extends [infer TQueryFnData, infer TError] ? GetDefinedOrUndefinedQueryResult : T extends [infer TQueryFnData] ? GetDefinedOrUndefinedQueryResult : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided T extends { queryFn?: QueryFunction | SkipToken select?: (data: any) => infer TData throwOnError?: ThrowOnError } ? GetDefinedOrUndefinedQueryResult< T, unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError > : T extends { queryFn?: | QueryFunction | SkipToken throwOnError?: ThrowOnError } ? GetDefinedOrUndefinedQueryResult< T, TQueryFnData, unknown extends TError ? DefaultError : TError > : // Fallback UseQueryResult /** * QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param */ export type QueriesOptions< T extends Array, TResult extends Array = [], TDepth extends ReadonlyArray = [], > = TDepth['length'] extends MAXIMUM_DEPTH ? Array : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions] : T extends [infer Head, ...infer Tail] ? QueriesOptions< [...Tail], [...TResult, GetOptions], [...TDepth, 1] > : ReadonlyArray extends T ? T : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type! // use this to infer the param types in the case of Array.map() argument T extends Array< UseQueryOptionsForUseQueries< infer TQueryFnData, infer TError, infer TData, infer TQueryKey > > ? Array< UseQueryOptionsForUseQueries< TQueryFnData, TError, TData, TQueryKey > > : // Fallback Array /** * QueriesResults reducer recursively maps type param to results */ export type QueriesResults< T extends Array, TResult extends Array = [], TDepth extends ReadonlyArray = [], > = TDepth['length'] extends MAXIMUM_DEPTH ? Array : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults] : T extends [infer Head, ...infer Tail] ? QueriesResults< [...Tail], [...TResult, GetResults], [...TDepth, 1] > : T extends Array< UseQueryOptionsForUseQueries< infer TQueryFnData, infer TError, infer TData, any > > ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results Array< UseQueryResult< unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError > > : // Fallback Array export function useQueries< T extends Array, TCombinedResult = QueriesResults, >( { queries, ...options }: { queries: readonly [...QueriesOptions] combine?: (result: QueriesResults) => TCombinedResult }, queryClient?: QueryClient, ): TCombinedResult { const client = useQueryClient(queryClient) const isRestoring = useIsRestoring() const errorResetBoundary = useQueryErrorResetBoundary() const defaultedQueries = React.useMemo( () => queries.map((opts) => { const defaultedOptions = client.defaultQueryOptions( opts as QueryObserverOptions< unknown, Error, unknown, unknown, QueryKey >, ) // Make sure the results are already in fetching state before subscribing or updating options defaultedOptions._optimisticResults = isRestoring ? 'isRestoring' : 'optimistic' return defaultedOptions }), [queries, client, isRestoring], ) defaultedQueries.forEach((query) => { ensureStaleTime(query) ensurePreventErrorBoundaryRetry(query, errorResetBoundary) }) useClearResetErrorBoundary(errorResetBoundary) const [observer] = React.useState( () => new QueriesObserver( client, defaultedQueries, options as QueriesObserverOptions, ), ) const [optimisticResult, getCombinedResult, trackResult] = observer.getOptimisticResult( defaultedQueries, (options as QueriesObserverOptions).combine, ) React.useSyncExternalStore( React.useCallback( (onStoreChange) => isRestoring ? () => undefined : observer.subscribe(notifyManager.batchCalls(onStoreChange)), [observer, isRestoring], ), () => observer.getCurrentResult(), () => observer.getCurrentResult(), ) React.useEffect(() => { // Do not notify on updates because of changes in the options because // these changes should already be reflected in the optimistic result. observer.setQueries( defaultedQueries, options as QueriesObserverOptions, { listeners: false, }, ) }, [defaultedQueries, options, observer]) const shouldAtLeastOneSuspend = optimisticResult.some((result, index) => shouldSuspend(defaultedQueries[index], result), ) const suspensePromises = shouldAtLeastOneSuspend ? optimisticResult.flatMap((result, index) => { const opts = defaultedQueries[index] if (opts) { const queryObserver = new QueryObserver(client, opts) if (shouldSuspend(opts, result)) { return fetchOptimistic(opts, queryObserver, errorResetBoundary) } else if (willFetch(result, isRestoring)) { void fetchOptimistic(opts, queryObserver, errorResetBoundary) } } return [] }) : [] if (suspensePromises.length > 0) { throw Promise.all(suspensePromises) } const firstSingleResultWhichShouldThrow = optimisticResult.find( (result, index) => { const query = defaultedQueries[index] return ( query && getHasError({ result, errorResetBoundary, throwOnError: query.throwOnError, query: client.getQueryCache().get(query.queryHash), }) ) }, ) if (firstSingleResultWhichShouldThrow?.error) { throw firstSingleResultWhichShouldThrow.error } return getCombinedResult(trackResult()) }