import { ClientContext, Client, NestedClient } from '@orpc/client'; import { OperationType, OperationKeyOptions } from '@orpc/tanstack-query'; export { OperationKeyOptions as BuildKeyOptions, OperationType as KeyType, generateOperationKey as buildKey } from '@orpc/tanstack-query'; import { QueryKey, SkipToken, UseQueryOptions, QueryFunctionContext, UseInfiniteQueryOptions, UseMutationOptions, InfiniteData } from '@tanstack/react-query'; import { SetOptional, MaybeOptionalOptions } from '@orpc/shared'; /** * Utils at any level (procedure or router) */ interface GeneralUtils { /** * Generate a query/mutation key for checking status, invalidate, set, get, etc. * * @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#query-mutation-key Tanstack Query/Mutation Key Docs} */ key(options?: OperationKeyOptions): QueryKey; } declare function createGeneralUtils(path: string[]): GeneralUtils; type QueryOptionsIn = (undefined extends TInput ? { input?: TInput | SkipToken; } : { input: TInput | SkipToken; }) & (Record extends TClientContext ? { context?: TClientContext; } : { context: TClientContext; }) & SetOptional, 'queryKey'>; interface QueryOptionsBase { queryKey: QueryKey; queryFn(ctx: QueryFunctionContext): Promise; throwOnError?(error: TError): boolean; retryDelay?: (count: number, error: TError) => number; enabled?: boolean; } type InfiniteOptionsIn = { input: ((pageParam: TPageParam) => TInput) | SkipToken; } & (Record extends TClientContext ? { context?: TClientContext; } : { context: TClientContext; }) & SetOptional, 'queryKey'>; interface InfiniteOptionsBase { queryKey: QueryKey; queryFn(ctx: QueryFunctionContext): Promise; throwOnError?(error: TError): boolean; retryDelay?: (count: number, error: TError) => number; enabled?: boolean; } type MutationOptionsIn = (Record extends TClientContext ? { context?: TClientContext; } : { context: TClientContext; }) & MutationOptions; type MutationOptions = UseMutationOptions; interface ProcedureUtils { /** * Calling corresponding procedure client * * @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#calling-procedure-clients Tanstack Calling Procedure Client Docs} */ call: Client; /** * Generate options used for useQuery/useSuspenseQuery/prefetchQuery/... * * @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#query-options-utility Tanstack Query Options Utility Docs} */ queryOptions(...rest: MaybeOptionalOptions>): NoInfer, keyof U>>; /** * Generate options used for useInfiniteQuery/useSuspenseInfiniteQuery/prefetchInfiniteQuery/... * * @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#infinite-query-options-utility Tanstack Infinite Query Options Utility Docs} */ infiniteOptions>(options: U & InfiniteOptionsIn): NoInfer, keyof U>>; /** * Generate options used for useMutation/... * * @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#mutation-options Tanstack Mutation Options Docs} */ mutationOptions(...rest: MaybeOptionalOptions>): MutationOptions; } interface CreateProcedureUtilsOptions { path: string[]; } declare function createProcedureUtils(client: Client, options: CreateProcedureUtilsOptions): ProcedureUtils; type RouterUtils> = T extends Client ? ProcedureUtils & GeneralUtils : { [K in keyof T]: T[K] extends NestedClient ? RouterUtils : never; } & GeneralUtils; interface CreateRouterUtilsOptions { path?: string[]; } /** * Create a router utils from a client. * * @info Both client-side and server-side clients are supported. * @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/react Tanstack Query React Docs} */ declare function createRouterUtils>(client: T, options?: CreateRouterUtilsOptions): RouterUtils; export { createGeneralUtils, createRouterUtils as createORPCReactQueryUtils, createProcedureUtils, createRouterUtils }; export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, ProcedureUtils, QueryOptionsBase, QueryOptionsIn, RouterUtils };