@ts-rest/react-query/src/v4/inner-types.d.ts

react-query client integration for @ts-rest

import { AppRoute, AppRouteFunction, AppRouteMutation, AppRouteQuery, AreAllPropertiesOptional, PartialClientInferRequest } from '@ts-rest/core';
import { DataResponse, ReactQueryClientArgs, UseInfiniteQueryOptions, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from './types';
import { FetchQueryOptions, InfiniteData, QueryClient, QueryFilters, QueryFunctionContext, QueryKey } from '@tanstack/react-query';
export type AppRouteFunctions<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs> = {
    useQuery: TAppRoute extends AppRouteQuery ? DataReturnQuery<TAppRoute, TClientArgs> : never;
    useInfiniteQuery: TAppRoute extends AppRouteQuery ? DataReturnInfiniteQuery<TAppRoute, TClientArgs> : never;
    useQueries: TAppRoute extends AppRouteQuery ? DataReturnQueries<TAppRoute, TClientArgs> : never;
    query: TAppRoute extends AppRouteQuery ? AppRouteFunction<TAppRoute, TClientArgs> : never;
    useMutation: TAppRoute extends AppRouteMutation ? DataReturnMutation<TAppRoute, TClientArgs> : never;
    mutation: TAppRoute extends AppRouteMutation ? AppRouteFunction<TAppRoute, TClientArgs> : never;
    fetchQuery: TAppRoute extends AppRouteQuery ? DataReturnFetchQuery<TAppRoute, TClientArgs> : never;
    fetchInfiniteQuery: TAppRoute extends AppRouteQuery ? DataReturnFetchInfiniteQuery<TAppRoute, TClientArgs> : never;
    prefetchQuery: TAppRoute extends AppRouteQuery ? DataReturnPrefetchQuery<TAppRoute, TClientArgs> : never;
    prefetchInfiniteQuery: TAppRoute extends AppRouteQuery ? DataReturnPrefetchInfiniteQuery<TAppRoute, TClientArgs> : never;
    getQueryData: TAppRoute extends AppRouteQuery ? DataReturnGetQueryData<TAppRoute> : never;
    ensureQueryData: TAppRoute extends AppRouteQuery ? DataReturnFetchQuery<TAppRoute, TClientArgs> : never;
    getQueriesData: TAppRoute extends AppRouteQuery ? DataReturnGetQueriesData<TAppRoute> : never;
    setQueryData: TAppRoute extends AppRouteQuery ? DataReturnSetQueryData<TAppRoute> : never;
};
export type AppRouteFunctionsWithQueryClient<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs> = AppRouteFunctions<TAppRoute, TClientArgs> & {
    fetchQuery: TAppRoute extends AppRouteQuery ? DataReturnFetchQueryHook<TAppRoute, TClientArgs> : never;
    fetchInfiniteQuery: TAppRoute extends AppRouteQuery ? DataReturnFetchInfiniteQueryHook<TAppRoute, TClientArgs> : never;
    prefetchQuery: TAppRoute extends AppRouteQuery ? DataReturnPrefetchQueryHook<TAppRoute, TClientArgs> : never;
    prefetchInfiniteQuery: TAppRoute extends AppRouteQuery ? DataReturnPrefetchInfiniteQueryHook<TAppRoute, TClientArgs> : never;
    getQueryData: TAppRoute extends AppRouteQuery ? DataReturnGetQueryDataHook<TAppRoute> : never;
    ensureQueryData: TAppRoute extends AppRouteQuery ? DataReturnFetchQueryHook<TAppRoute, TClientArgs> : never;
    getQueriesData: TAppRoute extends AppRouteQuery ? DataReturnGetQueriesDataHook<TAppRoute> : never;
    setQueryData: TAppRoute extends AppRouteQuery ? DataReturnSetQueryDataHook<TAppRoute> : never;
};
export type DataReturnQuery<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs, TArgs = PartialClientInferRequest<TAppRoute, TClientArgs>> = AreAllPropertiesOptional<TArgs> extends true ? <TData = DataResponse<TAppRoute>>(queryKey: QueryKey, args?: TArgs, options?: UseQueryOptions<TAppRoute, TData, TClientArgs['includeThrownErrorsInErrorType']>) => UseQueryResult<TAppRoute, TData, TClientArgs['includeThrownErrorsInErrorType']> : <TData = DataResponse<TAppRoute>>(queryKey: QueryKey, args: TArgs, options?: UseQueryOptions<TAppRoute, TData, TClientArgs['includeThrownErrorsInErrorType']>) => UseQueryResult<TAppRoute, TData, TClientArgs['includeThrownErrorsInErrorType']>;
export type DataReturnQueriesOptions<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs> = PartialClientInferRequest<TAppRoute, TClientArgs> & Omit<UseQueryOptions<TAppRoute, DataResponse<TAppRoute>, TClientArgs['includeThrownErrorsInErrorType']>, 'queryFn'> & {
    queryKey: QueryKey;
};
export type DataReturnQueries<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs, TQueries = readonly DataReturnQueriesOptions<TAppRoute, TClientArgs>[]> = <TData = DataResponse<TAppRoute>>(args: {
    queries: TQueries;
    context?: UseQueryOptions<TAppRoute, TData, TClientArgs['includeThrownErrorsInErrorType']>['context'];
}) => UseQueryResult<TAppRoute, TData, TClientArgs['includeThrownErrorsInErrorType']>[];
export type DataReturnInfiniteQuery<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs> = <TData = DataResponse<TAppRoute>>(queryKey: QueryKey, args: (context: QueryFunctionContext<QueryKey>) => PartialClientInferRequest<TAppRoute, TClientArgs>, options?: UseInfiniteQueryOptions<TAppRoute, TData, TClientArgs['includeThrownErrorsInErrorType']>) => UseInfiniteQueryResult<TAppRoute, TData, TClientArgs['includeThrownErrorsInErrorType']>;
export type DataReturnMutation<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs> = (options?: UseMutationOptions<TAppRoute, TClientArgs>) => UseMutationResult<TAppRoute, TClientArgs>;
export type DataReturnFetchQuery<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs, TArgs = PartialClientInferRequest<TAppRoute, TClientArgs>> = AreAllPropertiesOptional<TArgs> extends true ? (queryClient: QueryClient, queryKey: QueryKey, args?: TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<DataResponse<TAppRoute>> : (queryClient: QueryClient, queryKey: QueryKey, args: TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<DataResponse<TAppRoute>>;
export type DataReturnFetchQueryHook<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs, TArgs = PartialClientInferRequest<TAppRoute, TClientArgs>> = AreAllPropertiesOptional<TArgs> extends true ? (queryKey: QueryKey, args?: TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<DataResponse<TAppRoute>> : (queryKey: QueryKey, args: TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<DataResponse<TAppRoute>>;
export type DataReturnPrefetchQuery<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs, TArgs = PartialClientInferRequest<TAppRoute, TClientArgs>> = AreAllPropertiesOptional<TArgs> extends true ? (queryClient: QueryClient, queryKey: QueryKey, args?: TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<void> : (queryClient: QueryClient, queryKey: QueryKey, args: TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<void>;
export type DataReturnPrefetchQueryHook<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs, TArgs = PartialClientInferRequest<TAppRoute, TClientArgs>> = AreAllPropertiesOptional<TArgs> extends true ? (queryKey: QueryKey, args?: TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<void> : (queryKey: QueryKey, args: TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<void>;
export type DataReturnFetchInfiniteQuery<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs, TArgs = PartialClientInferRequest<TAppRoute, TClientArgs>> = (queryClient: QueryClient, queryKey: QueryKey, args: (context: QueryFunctionContext) => TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<InfiniteData<DataResponse<TAppRoute>>>;
export type DataReturnFetchInfiniteQueryHook<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs, TArgs = PartialClientInferRequest<TAppRoute, TClientArgs>> = (queryKey: QueryKey, args: (context: QueryFunctionContext) => TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<InfiniteData<DataResponse<TAppRoute>>>;
export type DataReturnPrefetchInfiniteQuery<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs, TArgs = PartialClientInferRequest<TAppRoute, TClientArgs>> = (queryClient: QueryClient, queryKey: QueryKey, args: (context: QueryFunctionContext) => TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<void>;
export type DataReturnPrefetchInfiniteQueryHook<TAppRoute extends AppRoute, TClientArgs extends ReactQueryClientArgs, TArgs = PartialClientInferRequest<TAppRoute, TClientArgs>> = (queryKey: QueryKey, args: (context: QueryFunctionContext) => TArgs, options?: FetchQueryOptions<TAppRoute>) => Promise<void>;
export type DataReturnGetQueryData<TAppRoute extends AppRoute> = (queryClient: QueryClient, queryKey: QueryKey, filters?: QueryFilters) => DataResponse<TAppRoute> | undefined;
export type DataReturnGetQueryDataHook<TAppRoute extends AppRoute> = (queryKey: QueryKey, filters?: QueryFilters) => DataResponse<TAppRoute> | undefined;
export type DataReturnGetQueriesData<TAppRoute extends AppRoute> = (queryClient: QueryClient, filters: QueryFilters) => [queryKey: QueryKey, data: DataResponse<TAppRoute> | undefined][];
export type DataReturnGetQueriesDataHook<TAppRoute extends AppRoute> = (filters: QueryFilters) => [queryKey: QueryKey, data: DataResponse<TAppRoute> | undefined][];
export type DataReturnSetQueryData<TAppRoute extends AppRoute> = (queryClient: QueryClient, queryKey: QueryKey, updater: DataResponse<TAppRoute> | undefined | ((oldData: DataResponse<TAppRoute> | undefined) => DataResponse<TAppRoute> | undefined)) => DataResponse<TAppRoute> | undefined;
export type DataReturnSetQueryDataHook<TAppRoute extends AppRoute> = (queryKey: QueryKey, updater: DataResponse<TAppRoute> | undefined | ((oldData: DataResponse<TAppRoute> | undefined) => DataResponse<TAppRoute> | undefined)) => DataResponse<TAppRoute> | undefined;