@trpc/react-query 11.3.1 → 11.3.2-canary.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/getQueryKey-CP8onRYT.cjs +104 -0
- package/dist/getQueryKey-Dekty44G.mjs +53 -0
- package/dist/getQueryKey-Dekty44G.mjs.map +1 -0
- package/dist/getQueryKey.d-C_PnqPni.d.cts +892 -0
- package/dist/getQueryKey.d-C_PnqPni.d.cts.map +1 -0
- package/dist/getQueryKey.d-CruH3ncI.d.mts +892 -0
- package/dist/getQueryKey.d-CruH3ncI.d.mts.map +1 -0
- package/dist/index.cjs +47 -0
- package/dist/index.d.cts +31 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.mts +31 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +40 -4
- package/dist/index.mjs.map +1 -0
- package/dist/rsc.cjs +69 -0
- package/dist/rsc.d.cts +80 -0
- package/dist/rsc.d.cts.map +1 -0
- package/dist/rsc.d.mts +80 -0
- package/dist/rsc.d.mts.map +1 -0
- package/dist/rsc.mjs +65 -104
- package/dist/rsc.mjs.map +1 -0
- package/dist/server/index.cjs +132 -0
- package/dist/server/index.d.cts +31 -0
- package/dist/server/index.d.cts.map +1 -0
- package/dist/server/index.d.mts +31 -0
- package/dist/server/index.d.mts.map +1 -0
- package/dist/server/index.mjs +133 -1
- package/dist/server/index.mjs.map +1 -0
- package/dist/shared/index.cjs +13 -0
- package/dist/shared/index.d.cts +2 -0
- package/dist/shared/index.d.mts +2 -0
- package/dist/shared/index.mjs +4 -7
- package/dist/shared-CMPBsqju.mjs +784 -0
- package/dist/shared-CMPBsqju.mjs.map +1 -0
- package/dist/shared-Doe-Gsbv.cjs +846 -0
- package/package.json +45 -26
- package/rsc/package.json +1 -0
- package/server/package.json +1 -0
- package/shared/package.json +1 -0
- package/dist/createTRPCQueryUtils.d.ts +0 -4
- package/dist/createTRPCQueryUtils.d.ts.map +0 -1
- package/dist/createTRPCQueryUtils.js +0 -16
- package/dist/createTRPCQueryUtils.mjs +0 -14
- package/dist/createTRPCReact.d.ts +0 -147
- package/dist/createTRPCReact.d.ts.map +0 -1
- package/dist/createTRPCReact.js +0 -60
- package/dist/createTRPCReact.mjs +0 -38
- package/dist/index.d.ts +0 -6
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -19
- package/dist/internals/context.d.ts +0 -157
- package/dist/internals/context.d.ts.map +0 -1
- package/dist/internals/context.js +0 -33
- package/dist/internals/context.mjs +0 -11
- package/dist/internals/getClientArgs.d.ts +0 -9
- package/dist/internals/getClientArgs.d.ts.map +0 -1
- package/dist/internals/getClientArgs.js +0 -24
- package/dist/internals/getClientArgs.mjs +0 -22
- package/dist/internals/getQueryKey.d.ts +0 -49
- package/dist/internals/getQueryKey.d.ts.map +0 -1
- package/dist/internals/getQueryKey.js +0 -75
- package/dist/internals/getQueryKey.mjs +0 -70
- package/dist/internals/trpcResult.d.ts +0 -18
- package/dist/internals/trpcResult.d.ts.map +0 -1
- package/dist/internals/trpcResult.js +0 -63
- package/dist/internals/trpcResult.mjs +0 -40
- package/dist/internals/useQueries.d.ts +0 -58
- package/dist/internals/useQueries.d.ts.map +0 -1
- package/dist/rsc.d.ts +0 -80
- package/dist/rsc.d.ts.map +0 -1
- package/dist/rsc.js +0 -130
- package/dist/server/index.d.ts +0 -2
- package/dist/server/index.d.ts.map +0 -1
- package/dist/server/index.js +0 -7
- package/dist/server/ssgProxy.d.ts +0 -31
- package/dist/server/ssgProxy.d.ts.map +0 -1
- package/dist/server/ssgProxy.js +0 -141
- package/dist/server/ssgProxy.mjs +0 -139
- package/dist/shared/hooks/createHooksInternal.d.ts +0 -31
- package/dist/shared/hooks/createHooksInternal.d.ts.map +0 -1
- package/dist/shared/hooks/createHooksInternal.js +0 -543
- package/dist/shared/hooks/createHooksInternal.mjs +0 -522
- package/dist/shared/hooks/createRootHooks.d.ts +0 -2
- package/dist/shared/hooks/createRootHooks.d.ts.map +0 -1
- package/dist/shared/hooks/types.d.ts +0 -157
- package/dist/shared/hooks/types.d.ts.map +0 -1
- package/dist/shared/index.d.ts +0 -22
- package/dist/shared/index.d.ts.map +0 -1
- package/dist/shared/index.js +0 -22
- package/dist/shared/polymorphism/index.d.ts +0 -5
- package/dist/shared/polymorphism/index.d.ts.map +0 -1
- package/dist/shared/polymorphism/mutationLike.d.ts +0 -17
- package/dist/shared/polymorphism/mutationLike.d.ts.map +0 -1
- package/dist/shared/polymorphism/queryLike.d.ts +0 -21
- package/dist/shared/polymorphism/queryLike.d.ts.map +0 -1
- package/dist/shared/polymorphism/routerLike.d.ts +0 -11
- package/dist/shared/polymorphism/routerLike.d.ts.map +0 -1
- package/dist/shared/polymorphism/utilsLike.d.ts +0 -7
- package/dist/shared/polymorphism/utilsLike.d.ts.map +0 -1
- package/dist/shared/proxy/decorationProxy.d.ts +0 -8
- package/dist/shared/proxy/decorationProxy.d.ts.map +0 -1
- package/dist/shared/proxy/decorationProxy.js +0 -30
- package/dist/shared/proxy/decorationProxy.mjs +0 -28
- package/dist/shared/proxy/useQueriesProxy.d.ts +0 -25
- package/dist/shared/proxy/useQueriesProxy.d.ts.map +0 -1
- package/dist/shared/proxy/useQueriesProxy.js +0 -27
- package/dist/shared/proxy/useQueriesProxy.mjs +0 -25
- package/dist/shared/proxy/utilsProxy.d.ts +0 -141
- package/dist/shared/proxy/utilsProxy.d.ts.map +0 -1
- package/dist/shared/proxy/utilsProxy.js +0 -106
- package/dist/shared/proxy/utilsProxy.mjs +0 -102
- package/dist/shared/queryClient.d.ts +0 -17
- package/dist/shared/queryClient.d.ts.map +0 -1
- package/dist/shared/queryClient.js +0 -9
- package/dist/shared/queryClient.mjs +0 -7
- package/dist/shared/types.d.ts +0 -98
- package/dist/shared/types.d.ts.map +0 -1
- package/dist/utils/createUtilityFunctions.d.ts +0 -23
- package/dist/utils/createUtilityFunctions.d.ts.map +0 -1
- package/dist/utils/createUtilityFunctions.js +0 -196
- package/dist/utils/createUtilityFunctions.mjs +0 -194
- package/dist/utils/inferReactQueryProcedure.d.ts +0 -25
- package/dist/utils/inferReactQueryProcedure.d.ts.map +0 -1
- package/rsc/index.d.ts +0 -1
- package/rsc/index.js +0 -1
- package/server/index.d.ts +0 -1
- package/server/index.js +0 -1
- package/shared/index.d.ts +0 -1
- package/shared/index.js +0 -1
|
@@ -0,0 +1,892 @@
|
|
|
1
|
+
import * as _trpc_client1 from "@trpc/client";
|
|
2
|
+
import { CreateTRPCClientOptions, TRPCClient, TRPCClientError, TRPCClientErrorLike, TRPCRequestOptions, TRPCUntypedClient, createTRPCClient } from "@trpc/client";
|
|
3
|
+
import { CancelOptions, DataTag, DefinedInitialDataInfiniteOptions, DefinedInitialDataOptions, DefinedUseInfiniteQueryResult, DefinedUseQueryResult, FetchInfiniteQueryOptions, FetchQueryOptions, InfiniteData, InfiniteQueryObserverSuccessResult, InitialDataFunction, InvalidateOptions, InvalidateQueryFilters, MutationOptions, Query, QueryClient, QueryClientConfig, QueryFilters, QueryKey, QueryObserverSuccessResult, QueryOptions, RefetchOptions, RefetchQueryFilters, ResetOptions, SetDataOptions, SkipToken, UndefinedInitialDataInfiniteOptions, UndefinedInitialDataOptions, UnusedSkipTokenInfiniteOptions, UnusedSkipTokenOptions, Updater, UseBaseQueryOptions, UseInfiniteQueryOptions, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult, UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from "@tanstack/react-query";
|
|
4
|
+
import { AnyClientTypes, AnyMutationProcedure, AnyProcedure, AnyQueryProcedure, AnyRootTypes, AnyRouter, DeepPartial, DistributiveOmit, MaybePromise, ProcedureType, ProtectedIntersection, RouterRecord, Simplify, coerceAsyncIterableToArray, inferAsyncIterableYield, inferProcedureInput, inferProcedureOutput, inferTransformedProcedureOutput } from "@trpc/server/unstable-core-do-not-import";
|
|
5
|
+
import * as React$1 from "react";
|
|
6
|
+
import { JSX, ReactNode } from "react";
|
|
7
|
+
|
|
8
|
+
//#region src/internals/context.d.ts
|
|
9
|
+
interface TRPCUseUtilsOptions {
|
|
10
|
+
/**
|
|
11
|
+
* tRPC-related options
|
|
12
|
+
*/
|
|
13
|
+
trpc?: TRPCRequestOptions;
|
|
14
|
+
}
|
|
15
|
+
interface TRPCFetchQueryOptions<TOutput, TError> extends DistributiveOmit<FetchQueryOptions<TOutput, TError>, 'queryKey'>, TRPCUseUtilsOptions {}
|
|
16
|
+
type TRPCFetchInfiniteQueryOptions<TInput, TOutput, TError> = DistributiveOmit<FetchInfiniteQueryOptions<TOutput, TError, TOutput, TRPCQueryKey, ExtractCursorType<TInput>>, 'queryKey' | 'initialPageParam'> & TRPCUseUtilsOptions & {
|
|
17
|
+
initialCursor?: ExtractCursorType<TInput>;
|
|
18
|
+
};
|
|
19
|
+
/** @internal */
|
|
20
|
+
type SSRState = 'mounted' | 'mounting' | 'prepass' | false;
|
|
21
|
+
interface TRPCContextPropsBase<TRouter extends AnyRouter, TSSRContext> {
|
|
22
|
+
/**
|
|
23
|
+
* The `TRPCClient`
|
|
24
|
+
*/
|
|
25
|
+
client: TRPCUntypedClient<TRouter>;
|
|
26
|
+
/**
|
|
27
|
+
* The SSR context when server-side rendering
|
|
28
|
+
* @default null
|
|
29
|
+
*/
|
|
30
|
+
ssrContext?: TSSRContext | null;
|
|
31
|
+
/**
|
|
32
|
+
* State of SSR hydration.
|
|
33
|
+
* - `false` if not using SSR.
|
|
34
|
+
* - `prepass` when doing a prepass to fetch queries' data
|
|
35
|
+
* - `mounting` before TRPCProvider has been rendered on the client
|
|
36
|
+
* - `mounted` when the TRPCProvider has been rendered on the client
|
|
37
|
+
* @default false
|
|
38
|
+
*/
|
|
39
|
+
ssrState?: SSRState;
|
|
40
|
+
/**
|
|
41
|
+
* @deprecated pass abortOnUnmount to `createTRPCReact` instead
|
|
42
|
+
* Abort loading query calls when unmounting a component - usually when navigating to a new page
|
|
43
|
+
* @default false
|
|
44
|
+
*/
|
|
45
|
+
abortOnUnmount?: boolean;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* @internal
|
|
49
|
+
*/
|
|
50
|
+
type DecoratedTRPCContextProps<TRouter extends AnyRouter, TSSRContext> = TRPCContextPropsBase<TRouter, TSSRContext> & {
|
|
51
|
+
client: TRPCClient<TRouter>;
|
|
52
|
+
};
|
|
53
|
+
interface TRPCContextProps<TRouter extends AnyRouter, TSSRContext> extends TRPCContextPropsBase<TRouter, TSSRContext> {
|
|
54
|
+
/**
|
|
55
|
+
* The react-query `QueryClient`
|
|
56
|
+
*/
|
|
57
|
+
queryClient: QueryClient;
|
|
58
|
+
}
|
|
59
|
+
declare const contextProps: (keyof TRPCContextPropsBase<any, any>)[];
|
|
60
|
+
/**
|
|
61
|
+
* @internal
|
|
62
|
+
*/
|
|
63
|
+
interface TRPCContextState<TRouter extends AnyRouter, TSSRContext = undefined> extends Required<TRPCContextProps<TRouter, TSSRContext>>, TRPCQueryUtils<TRouter> {}
|
|
64
|
+
/**
|
|
65
|
+
* @internal
|
|
66
|
+
*/
|
|
67
|
+
interface TRPCQueryUtils<TRouter extends AnyRouter> {
|
|
68
|
+
/**
|
|
69
|
+
* @see https://tanstack.com/query/latest/docs/framework/react/reference/queryOptions#queryoptions
|
|
70
|
+
*/
|
|
71
|
+
queryOptions(path: readonly string[],
|
|
72
|
+
// <-- look into if needed
|
|
73
|
+
queryKey: TRPCQueryKey, opts?: UndefinedTRPCQueryOptionsIn<unknown, unknown, TRPCClientError<AnyClientTypes>>): UndefinedTRPCQueryOptionsOut<unknown, unknown, TRPCClientError<AnyClientTypes>>;
|
|
74
|
+
queryOptions(path: readonly string[],
|
|
75
|
+
// <-- look into if needed
|
|
76
|
+
queryKey: TRPCQueryKey, opts: DefinedTRPCQueryOptionsIn<unknown, unknown, TRPCClientError<AnyClientTypes>>): DefinedTRPCQueryOptionsOut<unknown, unknown, TRPCClientError<AnyClientTypes>>;
|
|
77
|
+
/**
|
|
78
|
+
* @see https://tanstack.com/query/latest/docs/framework/react/reference/infiniteQueryOptions#infinitequeryoptions
|
|
79
|
+
*/
|
|
80
|
+
infiniteQueryOptions(path: readonly string[],
|
|
81
|
+
// <-- look into if needed
|
|
82
|
+
queryKey: TRPCQueryKey, opts: UndefinedTRPCInfiniteQueryOptionsIn<unknown, unknown, unknown, TRPCClientError<AnyClientTypes>>): UndefinedTRPCInfiniteQueryOptionsOut<unknown, unknown, unknown, TRPCClientError<AnyClientTypes>>;
|
|
83
|
+
infiniteQueryOptions(path: readonly string[],
|
|
84
|
+
// <-- look into if needed
|
|
85
|
+
queryKey: TRPCQueryKey, opts: DefinedTRPCInfiniteQueryOptionsIn<unknown, unknown, unknown, TRPCClientError<AnyClientTypes>>): DefinedTRPCInfiniteQueryOptionsOut<unknown, unknown, unknown, TRPCClientError<AnyClientTypes>>;
|
|
86
|
+
/**
|
|
87
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientfetchquery
|
|
88
|
+
*/
|
|
89
|
+
fetchQuery: (queryKey: TRPCQueryKey, opts?: TRPCFetchQueryOptions<unknown, TRPCClientError<TRouter>>) => Promise<unknown>;
|
|
90
|
+
/**
|
|
91
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientfetchinfinitequery
|
|
92
|
+
*/
|
|
93
|
+
fetchInfiniteQuery: (queryKey: TRPCQueryKey, opts?: TRPCFetchInfiniteQueryOptions<unknown, unknown, TRPCClientError<TRouter>>) => Promise<InfiniteData<unknown, unknown>>;
|
|
94
|
+
/**
|
|
95
|
+
* @see https://tanstack.com/query/v5/docs/framework/react/guides/prefetching
|
|
96
|
+
*/
|
|
97
|
+
prefetchQuery: (queryKey: TRPCQueryKey, opts?: TRPCFetchQueryOptions<unknown, TRPCClientError<TRouter>>) => Promise<void>;
|
|
98
|
+
/**
|
|
99
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientprefetchinfinitequery
|
|
100
|
+
*/
|
|
101
|
+
prefetchInfiniteQuery: (queryKey: TRPCQueryKey, opts?: TRPCFetchInfiniteQueryOptions<unknown, unknown, TRPCClientError<TRouter>>) => Promise<void>;
|
|
102
|
+
/**
|
|
103
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientensurequerydata
|
|
104
|
+
*/
|
|
105
|
+
ensureQueryData: (queryKey: TRPCQueryKey, opts?: TRPCFetchQueryOptions<unknown, TRPCClientError<TRouter>>) => Promise<unknown>;
|
|
106
|
+
/**
|
|
107
|
+
* @see https://tanstack.com/query/v5/docs/framework/react/guides/query-invalidation
|
|
108
|
+
*/
|
|
109
|
+
invalidateQueries: (queryKey: TRPCQueryKey, filters?: InvalidateQueryFilters<TRPCQueryKey>, options?: InvalidateOptions) => Promise<void>;
|
|
110
|
+
/**
|
|
111
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientresetqueries
|
|
112
|
+
*/
|
|
113
|
+
resetQueries: (queryKey: TRPCQueryKey, filters?: QueryFilters<TRPCQueryKey>, options?: ResetOptions) => Promise<void>;
|
|
114
|
+
/**
|
|
115
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientrefetchqueries
|
|
116
|
+
*/
|
|
117
|
+
refetchQueries: (queryKey: TRPCQueryKey, filters?: RefetchQueryFilters<TRPCQueryKey>, options?: RefetchOptions) => Promise<void>;
|
|
118
|
+
/**
|
|
119
|
+
* @see https://tanstack.com/query/v5/docs/framework/react/guides/query-cancellation
|
|
120
|
+
*/
|
|
121
|
+
cancelQuery: (queryKey: TRPCQueryKey, options?: CancelOptions) => Promise<void>;
|
|
122
|
+
/**
|
|
123
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientsetquerydata
|
|
124
|
+
*/
|
|
125
|
+
setQueryData: (queryKey: TRPCQueryKey, updater: Updater<unknown, unknown>, options?: SetDataOptions) => void;
|
|
126
|
+
/**
|
|
127
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientsetqueriesdata
|
|
128
|
+
*/
|
|
129
|
+
setQueriesData: (queryKey: TRPCQueryKey, filters: QueryFilters, updater: Updater<unknown, unknown>, options?: SetDataOptions) => [QueryKey, unknown][];
|
|
130
|
+
/**
|
|
131
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientgetquerydata
|
|
132
|
+
*/
|
|
133
|
+
getQueryData: (queryKey: TRPCQueryKey) => unknown;
|
|
134
|
+
/**
|
|
135
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientsetquerydata
|
|
136
|
+
*/
|
|
137
|
+
setInfiniteQueryData: (queryKey: TRPCQueryKey, updater: Updater<InfiniteData<unknown> | undefined, InfiniteData<unknown> | undefined>, options?: SetDataOptions) => void;
|
|
138
|
+
/**
|
|
139
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientgetquerydata
|
|
140
|
+
*/
|
|
141
|
+
getInfiniteQueryData: (queryKey: TRPCQueryKey) => InfiniteData<unknown> | undefined;
|
|
142
|
+
/**
|
|
143
|
+
* @see https://tanstack.com/query/latest/docs/reference/QueryClient/#queryclientsetmutationdefaults
|
|
144
|
+
*/
|
|
145
|
+
setMutationDefaults: (mutationKey: TRPCMutationKey, options: MutationOptions | ((args: {
|
|
146
|
+
canonicalMutationFn: (input: unknown) => Promise<unknown>;
|
|
147
|
+
}) => MutationOptions)) => void;
|
|
148
|
+
/**
|
|
149
|
+
* @see https://tanstack.com/query/latest/docs/reference/QueryClient#queryclientgetmutationdefaults
|
|
150
|
+
*/
|
|
151
|
+
getMutationDefaults: (mutationKey: TRPCMutationKey) => MutationOptions | undefined;
|
|
152
|
+
/**
|
|
153
|
+
* @see https://tanstack.com/query/latest/docs/reference/QueryClient#queryclientismutating
|
|
154
|
+
*/
|
|
155
|
+
isMutating: (filters: {
|
|
156
|
+
mutationKey: TRPCMutationKey;
|
|
157
|
+
}) => number;
|
|
158
|
+
}
|
|
159
|
+
declare const TRPCContext: React$1.Context<any>;
|
|
160
|
+
//#endregion
|
|
161
|
+
//#region src/shared/hooks/types.d.ts
|
|
162
|
+
type OutputWithCursor<TData, TCursor = any> = {
|
|
163
|
+
cursor: TCursor | null;
|
|
164
|
+
data: TData;
|
|
165
|
+
};
|
|
166
|
+
interface TRPCReactRequestOptions extends Omit<TRPCRequestOptions, 'signal'> {
|
|
167
|
+
/**
|
|
168
|
+
* Opt out of SSR for this query by passing `ssr: false`
|
|
169
|
+
*/
|
|
170
|
+
ssr?: boolean;
|
|
171
|
+
/**
|
|
172
|
+
* Opt out or into aborting request on unmount
|
|
173
|
+
*/
|
|
174
|
+
abortOnUnmount?: boolean;
|
|
175
|
+
}
|
|
176
|
+
interface TRPCUseQueryBaseOptions {
|
|
177
|
+
/**
|
|
178
|
+
* tRPC-related options
|
|
179
|
+
*/
|
|
180
|
+
trpc?: TRPCReactRequestOptions;
|
|
181
|
+
}
|
|
182
|
+
interface UseTRPCQueryOptions<TOutput, TData, TError, TQueryOptsData = TOutput> extends DistributiveOmit<UseBaseQueryOptions<TOutput, TError, TData, TQueryOptsData, any>, 'queryKey'>, TRPCUseQueryBaseOptions {}
|
|
183
|
+
interface UseTRPCSuspenseQueryOptions<TOutput, TData, TError> extends DistributiveOmit<UseSuspenseQueryOptions<TOutput, TError, TData, any>, 'queryKey'>, TRPCUseQueryBaseOptions {}
|
|
184
|
+
interface UseTRPCPrefetchQueryOptions<TOutput, TData, TError> extends DistributiveOmit<FetchQueryOptions<TOutput, TError, TData, any>, 'queryKey'>, TRPCUseQueryBaseOptions {}
|
|
185
|
+
/** @internal **/
|
|
186
|
+
interface DefinedUseTRPCQueryOptions<TOutput, TData, TError, TQueryOptsData = TOutput> extends DistributiveOmit<UseTRPCQueryOptions<TOutput, TData, TError, TQueryOptsData>, 'queryKey'> {
|
|
187
|
+
initialData: InitialDataFunction<TQueryOptsData> | TQueryOptsData;
|
|
188
|
+
}
|
|
189
|
+
interface TRPCQueryOptions<TData, TError> extends DistributiveOmit<QueryOptions<TData, TError, TData, any>, 'queryKey'>, TRPCUseQueryBaseOptions {
|
|
190
|
+
queryKey: TRPCQueryKey;
|
|
191
|
+
}
|
|
192
|
+
type ExtractCursorType<TInput> = TInput extends {
|
|
193
|
+
cursor?: any;
|
|
194
|
+
} ? TInput['cursor'] : unknown;
|
|
195
|
+
interface UseTRPCInfiniteQueryOptions<TInput, TOutput, TError> extends DistributiveOmit<UseInfiniteQueryOptions<TOutput, TError, TOutput, any, ExtractCursorType<TInput>>, 'queryKey' | 'initialPageParam'>, TRPCUseQueryBaseOptions {
|
|
196
|
+
initialCursor?: ExtractCursorType<TInput>;
|
|
197
|
+
}
|
|
198
|
+
type UseTRPCPrefetchInfiniteQueryOptions<TInput, TOutput, TError> = DistributiveOmit<FetchInfiniteQueryOptions<TOutput, TError, TOutput, any, ExtractCursorType<TInput>>, 'queryKey' | 'initialPageParam'> & TRPCUseQueryBaseOptions & {
|
|
199
|
+
initialCursor?: ExtractCursorType<TInput>;
|
|
200
|
+
};
|
|
201
|
+
interface UseTRPCSuspenseInfiniteQueryOptions<TInput, TOutput, TError> extends DistributiveOmit<UseSuspenseInfiniteQueryOptions<TOutput, TError, TOutput, any, ExtractCursorType<TInput>>, 'queryKey' | 'initialPageParam'>, TRPCUseQueryBaseOptions {
|
|
202
|
+
initialCursor?: ExtractCursorType<TInput>;
|
|
203
|
+
}
|
|
204
|
+
interface UseTRPCMutationOptions<TInput, TError, TOutput, TContext = unknown> extends UseMutationOptions<TOutput, TError, TInput, TContext>, TRPCUseQueryBaseOptions {}
|
|
205
|
+
interface UseTRPCSubscriptionOptions<TOutput, TError> {
|
|
206
|
+
/**
|
|
207
|
+
* @deprecated
|
|
208
|
+
* use a `skipToken` from `@tanstack/react-query` instead
|
|
209
|
+
* this will be removed in v12
|
|
210
|
+
*/
|
|
211
|
+
enabled?: boolean;
|
|
212
|
+
/**
|
|
213
|
+
* Called when the subscription is started
|
|
214
|
+
*/
|
|
215
|
+
onStarted?: () => void;
|
|
216
|
+
/**
|
|
217
|
+
* Called when new data is received
|
|
218
|
+
*/
|
|
219
|
+
onData?: (data: TOutput) => void;
|
|
220
|
+
/**
|
|
221
|
+
* Called when an **unrecoverable error** occurs and the subscription is closed
|
|
222
|
+
*/
|
|
223
|
+
onError?: (err: TError) => void;
|
|
224
|
+
/**
|
|
225
|
+
* Called when the subscription is completed on the server
|
|
226
|
+
*/
|
|
227
|
+
onComplete?: () => void;
|
|
228
|
+
}
|
|
229
|
+
interface TRPCSubscriptionBaseResult<TOutput, TError> {
|
|
230
|
+
status: 'idle' | 'connecting' | 'pending' | 'error';
|
|
231
|
+
data: undefined | TOutput;
|
|
232
|
+
error: null | TError;
|
|
233
|
+
/**
|
|
234
|
+
* Reset the subscription
|
|
235
|
+
*/
|
|
236
|
+
reset: () => void;
|
|
237
|
+
}
|
|
238
|
+
interface TRPCSubscriptionIdleResult<TOutput> extends TRPCSubscriptionBaseResult<TOutput, null> {
|
|
239
|
+
status: 'idle';
|
|
240
|
+
data: undefined;
|
|
241
|
+
error: null;
|
|
242
|
+
}
|
|
243
|
+
interface TRPCSubscriptionConnectingResult<TOutput, TError> extends TRPCSubscriptionBaseResult<TOutput, TError> {
|
|
244
|
+
status: 'connecting';
|
|
245
|
+
data: undefined | TOutput;
|
|
246
|
+
error: TError | null;
|
|
247
|
+
}
|
|
248
|
+
interface TRPCSubscriptionPendingResult<TOutput> extends TRPCSubscriptionBaseResult<TOutput, undefined> {
|
|
249
|
+
status: 'pending';
|
|
250
|
+
data: TOutput | undefined;
|
|
251
|
+
error: null;
|
|
252
|
+
}
|
|
253
|
+
interface TRPCSubscriptionErrorResult<TOutput, TError> extends TRPCSubscriptionBaseResult<TOutput, TError> {
|
|
254
|
+
status: 'error';
|
|
255
|
+
data: TOutput | undefined;
|
|
256
|
+
error: TError;
|
|
257
|
+
}
|
|
258
|
+
type TRPCSubscriptionResult<TOutput, TError> = TRPCSubscriptionIdleResult<TOutput> | TRPCSubscriptionConnectingResult<TOutput, TError> | TRPCSubscriptionErrorResult<TOutput, TError> | TRPCSubscriptionPendingResult<TOutput>;
|
|
259
|
+
interface TRPCProviderProps<TRouter extends AnyRouter, TSSRContext> extends Omit<TRPCContextProps<TRouter, TSSRContext>, 'client'> {
|
|
260
|
+
children: ReactNode;
|
|
261
|
+
client: TRPCClient<TRouter> | TRPCUntypedClient<TRouter>;
|
|
262
|
+
}
|
|
263
|
+
type TRPCProvider<TRouter extends AnyRouter, TSSRContext> = (props: TRPCProviderProps<TRouter, TSSRContext>) => JSX.Element;
|
|
264
|
+
type CreateClient<TRouter extends AnyRouter> = (opts: CreateTRPCClientOptions<TRouter>) => TRPCUntypedClient<TRouter>;
|
|
265
|
+
/**
|
|
266
|
+
* @internal
|
|
267
|
+
*/
|
|
268
|
+
type UseTRPCQueryResult<TData, TError> = TRPCHookResult & UseQueryResult<coerceAsyncIterableToArray<TData>, TError>;
|
|
269
|
+
/**
|
|
270
|
+
* @internal
|
|
271
|
+
*/
|
|
272
|
+
type DefinedUseTRPCQueryResult<TData, TError> = DefinedUseQueryResult<TData, TError> & TRPCHookResult;
|
|
273
|
+
/**
|
|
274
|
+
* @internal
|
|
275
|
+
*/
|
|
276
|
+
type UseTRPCQuerySuccessResult<TData, TError> = QueryObserverSuccessResult<TData, TError> & TRPCHookResult;
|
|
277
|
+
/**
|
|
278
|
+
* @internal
|
|
279
|
+
*/
|
|
280
|
+
type UseTRPCSuspenseQueryResult<TData, TError> = [TData, UseSuspenseQueryResult<TData, TError> & TRPCHookResult];
|
|
281
|
+
/**
|
|
282
|
+
* @internal
|
|
283
|
+
*/
|
|
284
|
+
type UseTRPCInfiniteQueryResult<TData, TError, TInput> = TRPCHookResult & UseInfiniteQueryResult<InfiniteData<TData, NonNullable<ExtractCursorType<TInput>> | null>, TError>;
|
|
285
|
+
/**
|
|
286
|
+
* @internal
|
|
287
|
+
*/
|
|
288
|
+
type UseTRPCInfiniteQuerySuccessResult<TData, TError, TInput> = InfiniteQueryObserverSuccessResult<InfiniteData<TData, NonNullable<ExtractCursorType<TInput>> | null>, TError> & TRPCHookResult;
|
|
289
|
+
/**
|
|
290
|
+
* @internal
|
|
291
|
+
*/
|
|
292
|
+
type UseTRPCSuspenseInfiniteQueryResult<TData, TError, TInput> = [InfiniteData<TData, NonNullable<ExtractCursorType<TInput>> | null>, UseSuspenseInfiniteQueryResult<InfiniteData<TData, NonNullable<ExtractCursorType<TInput>> | null>, TError> & TRPCHookResult];
|
|
293
|
+
/**
|
|
294
|
+
* @internal
|
|
295
|
+
*/
|
|
296
|
+
type UseTRPCMutationResult<TData, TError, TVariables, TContext> = TRPCHookResult & UseMutationResult<TData, TError, TVariables, TContext>;
|
|
297
|
+
interface TRPCHookResult {
|
|
298
|
+
trpc: {
|
|
299
|
+
path: string;
|
|
300
|
+
};
|
|
301
|
+
}
|
|
302
|
+
//# sourceMappingURL=types.d.ts.map
|
|
303
|
+
//#endregion
|
|
304
|
+
//#region src/shared/types.d.ts
|
|
305
|
+
interface TRPCQueryBaseOptions {
|
|
306
|
+
/**
|
|
307
|
+
* tRPC-related options
|
|
308
|
+
*/
|
|
309
|
+
trpc?: TRPCReactRequestOptions;
|
|
310
|
+
}
|
|
311
|
+
interface TRPCQueryOptionsResult {
|
|
312
|
+
trpc: {
|
|
313
|
+
path: string;
|
|
314
|
+
};
|
|
315
|
+
}
|
|
316
|
+
type TRPCOptionOverrides = 'queryKey' | 'queryFn' | 'queryHashFn' | 'queryHash';
|
|
317
|
+
type TRPCInfiniteOptionOverrides = TRPCOptionOverrides | 'initialPageParam';
|
|
318
|
+
/**
|
|
319
|
+
* QueryOptions API helpers
|
|
320
|
+
*/
|
|
321
|
+
interface UndefinedTRPCQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<UndefinedInitialDataOptions<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TData>, TRPCQueryKey>, TRPCOptionOverrides>, TRPCQueryBaseOptions {}
|
|
322
|
+
interface UndefinedTRPCQueryOptionsOut<TQueryFnData, TOutput, TError> extends UndefinedInitialDataOptions<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TOutput>, TRPCQueryKey>, TRPCQueryOptionsResult {
|
|
323
|
+
queryKey: DataTag<TRPCQueryKey, coerceAsyncIterableToArray<TOutput>, TError>;
|
|
324
|
+
}
|
|
325
|
+
interface DefinedTRPCQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<DefinedInitialDataOptions<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TData>, TRPCQueryKey>, TRPCOptionOverrides>, TRPCQueryBaseOptions {}
|
|
326
|
+
interface DefinedTRPCQueryOptionsOut<TQueryFnData, TData, TError> extends DefinedInitialDataOptions<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TData>, TRPCQueryKey>, TRPCQueryOptionsResult {
|
|
327
|
+
queryKey: DataTag<TRPCQueryKey, coerceAsyncIterableToArray<TData>, TError>;
|
|
328
|
+
}
|
|
329
|
+
interface UnusedSkipTokenTRPCQueryOptionsIn<TQueryFnData, TData, TError> extends DistributiveOmit<UnusedSkipTokenOptions<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TData>, TRPCQueryKey>, TRPCOptionOverrides>, TRPCQueryBaseOptions {}
|
|
330
|
+
interface UnusedSkipTokenTRPCQueryOptionsOut<TQueryFnData, TOutput, TError> extends UnusedSkipTokenOptions<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TOutput>, TRPCQueryKey>, TRPCQueryOptionsResult {
|
|
331
|
+
queryKey: DataTag<TRPCQueryKey, coerceAsyncIterableToArray<TOutput>, TError>;
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* InifiniteQueryOptions helpers
|
|
335
|
+
*/
|
|
336
|
+
interface UndefinedTRPCInfiniteQueryOptionsIn<TInput, TQueryFnData, TData, TError> extends DistributiveOmit<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, InfiniteData<TData, NonNullable<ExtractCursorType<TInput>> | null>, TRPCQueryKey, NonNullable<ExtractCursorType<TInput>> | null>, TRPCInfiniteOptionOverrides>, TRPCQueryBaseOptions {
|
|
337
|
+
initialCursor?: NonNullable<ExtractCursorType<TInput>> | null;
|
|
338
|
+
}
|
|
339
|
+
interface UndefinedTRPCInfiniteQueryOptionsOut<TInput, TQueryFnData, TData, TError> extends DistributiveOmit<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, InfiniteData<TData, NonNullable<ExtractCursorType<TInput>> | null>, TRPCQueryKey, NonNullable<ExtractCursorType<TInput>> | null>, 'initialPageParam'>, TRPCQueryOptionsResult {
|
|
340
|
+
queryKey: DataTag<TRPCQueryKey, TData, TError>;
|
|
341
|
+
initialPageParam: NonNullable<ExtractCursorType<TInput>> | null;
|
|
342
|
+
}
|
|
343
|
+
interface DefinedTRPCInfiniteQueryOptionsIn<TInput, TQueryFnData, TData, TError> extends DistributiveOmit<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, InfiniteData<TData, NonNullable<ExtractCursorType<TInput>> | null>, TRPCQueryKey, NonNullable<ExtractCursorType<TInput>> | null>, TRPCInfiniteOptionOverrides>, TRPCQueryBaseOptions {
|
|
344
|
+
initialCursor?: NonNullable<ExtractCursorType<TInput>> | null;
|
|
345
|
+
}
|
|
346
|
+
interface DefinedTRPCInfiniteQueryOptionsOut<TInput, TQueryFnData, TData, TError> extends DistributiveOmit<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, InfiniteData<TData, NonNullable<ExtractCursorType<TInput>> | null>, TRPCQueryKey, NonNullable<ExtractCursorType<TInput>> | null>, 'initialPageParam'>, TRPCQueryOptionsResult {
|
|
347
|
+
queryKey: DataTag<TRPCQueryKey, TData, TError>;
|
|
348
|
+
initialPageParam: NonNullable<ExtractCursorType<TInput>> | null;
|
|
349
|
+
}
|
|
350
|
+
interface UnusedSkipTokenTRPCInfiniteQueryOptionsIn<TInput, TQueryFnData, TData, TError> extends DistributiveOmit<UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, InfiniteData<TData, NonNullable<ExtractCursorType<TInput>> | null>, TRPCQueryKey, NonNullable<ExtractCursorType<TInput>> | null>, TRPCInfiniteOptionOverrides>, TRPCQueryBaseOptions {
|
|
351
|
+
initialCursor?: NonNullable<ExtractCursorType<TInput>> | null;
|
|
352
|
+
}
|
|
353
|
+
interface UnusedSkipTokenTRPCInfiniteQueryOptionsOut<TInput, TQueryFnData, TData, TError> extends DistributiveOmit<UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, InfiniteData<TData, NonNullable<ExtractCursorType<TInput>> | null>, TRPCQueryKey, NonNullable<ExtractCursorType<TInput>> | null>, 'initialPageParam'>, TRPCQueryOptionsResult {
|
|
354
|
+
queryKey: DataTag<TRPCQueryKey, TData, TError>;
|
|
355
|
+
initialPageParam: NonNullable<ExtractCursorType<TInput>> | null;
|
|
356
|
+
}
|
|
357
|
+
/**
|
|
358
|
+
* @internal
|
|
359
|
+
*/
|
|
360
|
+
interface UseMutationOverride {
|
|
361
|
+
onSuccess: (opts: {
|
|
362
|
+
/**
|
|
363
|
+
* Calls the original function that was defined in the query's `onSuccess` option
|
|
364
|
+
*/
|
|
365
|
+
originalFn: () => MaybePromise<void>;
|
|
366
|
+
queryClient: QueryClient;
|
|
367
|
+
/**
|
|
368
|
+
* Meta data passed in from the `useMutation()` hook
|
|
369
|
+
*/
|
|
370
|
+
meta: Record<string, unknown>;
|
|
371
|
+
}) => MaybePromise<void>;
|
|
372
|
+
}
|
|
373
|
+
/**
|
|
374
|
+
* @internal
|
|
375
|
+
*/
|
|
376
|
+
interface CreateTRPCReactOptions<_TRouter extends AnyRouter> {
|
|
377
|
+
/**
|
|
378
|
+
* Override behaviors of the built-in hooks
|
|
379
|
+
*/
|
|
380
|
+
overrides?: {
|
|
381
|
+
useMutation?: Partial<UseMutationOverride>;
|
|
382
|
+
};
|
|
383
|
+
/**
|
|
384
|
+
* Abort all queries when unmounting
|
|
385
|
+
* @default false
|
|
386
|
+
*/
|
|
387
|
+
abortOnUnmount?: boolean;
|
|
388
|
+
/**
|
|
389
|
+
* Override the default context provider
|
|
390
|
+
* @default undefined
|
|
391
|
+
*/
|
|
392
|
+
context?: React.Context<any>;
|
|
393
|
+
}
|
|
394
|
+
//#endregion
|
|
395
|
+
//#region src/shared/hooks/createHooksInternal.d.ts
|
|
396
|
+
/**
|
|
397
|
+
* @internal
|
|
398
|
+
*/
|
|
399
|
+
declare function createRootHooks<TRouter extends AnyRouter, TSSRContext = unknown>(config?: CreateTRPCReactOptions<TRouter>): {
|
|
400
|
+
Provider: TRPCProvider<TRouter, TSSRContext>;
|
|
401
|
+
createClient: (opts: _trpc_client1.CreateTRPCClientOptions<TRouter>) => _trpc_client1.TRPCClient<TRouter>;
|
|
402
|
+
useContext: () => TRPCContextState<TRouter, TSSRContext>;
|
|
403
|
+
useUtils: () => TRPCContextState<TRouter, TSSRContext>;
|
|
404
|
+
useQuery: (path: readonly string[], input: unknown, opts?: UseTRPCQueryOptions<unknown, unknown, TRPCClientErrorLike<TRouter>>) => UseTRPCQueryResult<unknown, TRPCClientErrorLike<TRouter>>;
|
|
405
|
+
usePrefetchQuery: (path: string[], input: unknown, opts?: UseTRPCPrefetchQueryOptions<unknown, unknown, TRPCClientErrorLike<TRouter>>) => void;
|
|
406
|
+
useSuspenseQuery: (path: readonly string[], input: unknown, opts?: UseTRPCSuspenseQueryOptions<unknown, unknown, TRPCClientErrorLike<TRouter>>) => UseTRPCSuspenseQueryResult<unknown, TRPCClientErrorLike<TRouter>>;
|
|
407
|
+
useQueries: TRPCUseQueries<TRouter>;
|
|
408
|
+
useSuspenseQueries: TRPCUseSuspenseQueries<TRouter>;
|
|
409
|
+
useMutation: (path: readonly string[], opts?: UseTRPCMutationOptions<unknown, TRPCClientErrorLike<TRouter>, unknown, unknown>) => UseTRPCMutationResult<unknown, TRPCClientErrorLike<TRouter>, unknown, unknown>;
|
|
410
|
+
useSubscription: (path: readonly string[], input: unknown, opts: UseTRPCSubscriptionOptions<unknown, TRPCClientErrorLike<TRouter>>) => TRPCSubscriptionResult<unknown, TRPCClientErrorLike<TRouter>>;
|
|
411
|
+
useInfiniteQuery: (path: readonly string[], input: unknown, opts: UseTRPCInfiniteQueryOptions<unknown, unknown, TRPCClientErrorLike<TRouter>>) => UseTRPCInfiniteQueryResult<unknown, TRPCClientErrorLike<TRouter>, unknown>;
|
|
412
|
+
usePrefetchInfiniteQuery: (path: string[], input: unknown, opts: UseTRPCPrefetchInfiniteQueryOptions<unknown, unknown, TRPCClientErrorLike<TRouter>>) => void;
|
|
413
|
+
useSuspenseInfiniteQuery: (path: readonly string[], input: unknown, opts: UseTRPCSuspenseInfiniteQueryOptions<unknown, unknown, TRPCClientErrorLike<TRouter>>) => UseTRPCSuspenseInfiniteQueryResult<unknown, TRPCClientErrorLike<TRouter>, unknown>;
|
|
414
|
+
};
|
|
415
|
+
/**
|
|
416
|
+
* Infer the type of a `createReactQueryHooks` function
|
|
417
|
+
* @internal
|
|
418
|
+
*/
|
|
419
|
+
type CreateReactQueryHooks<TRouter extends AnyRouter, TSSRContext = unknown> = ReturnType<typeof createRootHooks<TRouter, TSSRContext>>;
|
|
420
|
+
//# sourceMappingURL=createHooksInternal.d.ts.map
|
|
421
|
+
//#endregion
|
|
422
|
+
//#region src/shared/proxy/decorationProxy.d.ts
|
|
423
|
+
/**
|
|
424
|
+
* Create proxy for decorating procedures
|
|
425
|
+
* @internal
|
|
426
|
+
*/
|
|
427
|
+
declare function createReactDecoration<TRouter extends AnyRouter, TSSRContext = unknown>(hooks: CreateReactQueryHooks<TRouter, TSSRContext>): unknown;
|
|
428
|
+
//# sourceMappingURL=decorationProxy.d.ts.map
|
|
429
|
+
//#endregion
|
|
430
|
+
//#region src/utils/inferReactQueryProcedure.d.ts
|
|
431
|
+
/**
|
|
432
|
+
* @internal
|
|
433
|
+
*/
|
|
434
|
+
type InferQueryOptions<TRoot extends AnyRootTypes, TProcedure extends AnyProcedure, TData = inferTransformedProcedureOutput<TRoot, TProcedure>> = Omit<UseTRPCQueryOptions<inferTransformedProcedureOutput<TRoot, TProcedure>, inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientErrorLike<TRoot>, TData>, 'select' | 'queryFn'>;
|
|
435
|
+
/**
|
|
436
|
+
* @internal
|
|
437
|
+
*/
|
|
438
|
+
type InferMutationOptions<TRoot extends AnyRootTypes, TProcedure extends AnyProcedure, TMeta = unknown> = UseTRPCMutationOptions<inferProcedureInput<TProcedure>, TRPCClientErrorLike<TRoot>, inferTransformedProcedureOutput<TRoot, TProcedure>, TMeta>;
|
|
439
|
+
/**
|
|
440
|
+
* @internal
|
|
441
|
+
*/
|
|
442
|
+
type InferQueryResult<TRoot extends AnyRootTypes, TProcedure extends AnyProcedure> = UseTRPCQueryResult<inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientErrorLike<TRoot>>;
|
|
443
|
+
/**
|
|
444
|
+
* @internal
|
|
445
|
+
*/
|
|
446
|
+
type InferMutationResult<TRoot extends AnyRootTypes, TProcedure extends AnyProcedure, TContext = unknown> = UseTRPCMutationResult<inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientErrorLike<TRoot>, inferProcedureInput<TProcedure>, TContext>;
|
|
447
|
+
type inferReactQueryProcedureOptionsInner<TRoot extends AnyRootTypes, TRecord extends RouterRecord> = { [TKey in keyof TRecord]: TRecord[TKey] extends infer $Value ? $Value extends AnyQueryProcedure ? InferQueryOptions<TRoot, $Value> : $Value extends AnyMutationProcedure ? InferMutationOptions<TRoot, $Value> : $Value extends RouterRecord ? inferReactQueryProcedureOptionsInner<TRoot, $Value> : never : never };
|
|
448
|
+
type inferReactQueryProcedureOptions<TRouter extends AnyRouter> = inferReactQueryProcedureOptionsInner<TRouter['_def']['_config']['$types'], TRouter['_def']['record']>;
|
|
449
|
+
//#endregion
|
|
450
|
+
//#region src/shared/proxy/utilsProxy.d.ts
|
|
451
|
+
type DecorateQueryProcedure<TRoot extends AnyRootTypes, TProcedure extends AnyQueryProcedure> = {
|
|
452
|
+
/**
|
|
453
|
+
* @see https://tanstack.com/query/latest/docs/framework/react/reference/queryOptions#queryoptions
|
|
454
|
+
*/
|
|
455
|
+
queryOptions<TQueryFnData extends inferTransformedProcedureOutput<TRoot, TProcedure>, TData = TQueryFnData>(input: inferProcedureInput<TProcedure> | SkipToken, opts: DefinedTRPCQueryOptionsIn<TQueryFnData, TData, TRPCClientError<TRoot>>): DefinedTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientError<TRoot>>;
|
|
456
|
+
/**
|
|
457
|
+
* @see https://tanstack.com/query/latest/docs/framework/react/reference/queryOptions#queryoptions
|
|
458
|
+
*/
|
|
459
|
+
queryOptions<TQueryFnData extends inferTransformedProcedureOutput<TRoot, TProcedure>, TData = TQueryFnData>(input: inferProcedureInput<TProcedure> | SkipToken, opts?: UnusedSkipTokenTRPCQueryOptionsIn<TQueryFnData, TData, TRPCClientError<TRoot>>): UnusedSkipTokenTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientError<TRoot>>;
|
|
460
|
+
/**
|
|
461
|
+
* @see https://tanstack.com/query/latest/docs/framework/react/reference/queryOptions#queryoptions
|
|
462
|
+
*/
|
|
463
|
+
queryOptions<TQueryFnData extends inferTransformedProcedureOutput<TRoot, TProcedure>, TData = TQueryFnData>(input: inferProcedureInput<TProcedure> | SkipToken, opts?: UndefinedTRPCQueryOptionsIn<TQueryFnData, TData, TRPCClientError<TRoot>>): UndefinedTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientError<TRoot>>;
|
|
464
|
+
/**
|
|
465
|
+
* @see https://tanstack.com/query/latest/docs/framework/react/reference/infiniteQueryOptions#infinitequeryoptions
|
|
466
|
+
*/
|
|
467
|
+
infiniteQueryOptions<TQueryFnData extends inferTransformedProcedureOutput<TRoot, TProcedure>, TData = TQueryFnData>(input: inferProcedureInput<TProcedure> | SkipToken, opts: DefinedTRPCInfiniteQueryOptionsIn<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>): DefinedTRPCInfiniteQueryOptionsOut<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>;
|
|
468
|
+
/**
|
|
469
|
+
* @see https://tanstack.com/query/latest/docs/framework/react/reference/infiniteQueryOptions#infinitequeryoptions
|
|
470
|
+
*/
|
|
471
|
+
infiniteQueryOptions<TQueryFnData extends inferTransformedProcedureOutput<TRoot, TProcedure>, TData = TQueryFnData>(input: inferProcedureInput<TProcedure>, opts: UnusedSkipTokenTRPCInfiniteQueryOptionsIn<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>): UnusedSkipTokenTRPCInfiniteQueryOptionsOut<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>;
|
|
472
|
+
/**
|
|
473
|
+
* @see https://tanstack.com/query/latest/docs/framework/react/reference/infiniteQueryOptions#infinitequeryoptions
|
|
474
|
+
*/
|
|
475
|
+
infiniteQueryOptions<TQueryFnData extends inferTransformedProcedureOutput<TRoot, TProcedure>, TData = TQueryFnData>(input: inferProcedureInput<TProcedure> | SkipToken, opts?: UndefinedTRPCInfiniteQueryOptionsIn<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>): UndefinedTRPCInfiniteQueryOptionsOut<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>;
|
|
476
|
+
/**
|
|
477
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientfetchquery
|
|
478
|
+
*/
|
|
479
|
+
fetch(input: inferProcedureInput<TProcedure>, opts?: TRPCFetchQueryOptions<inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientError<TRoot>>): Promise<inferTransformedProcedureOutput<TRoot, TProcedure>>;
|
|
480
|
+
/**
|
|
481
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientfetchinfinitequery
|
|
482
|
+
*/
|
|
483
|
+
fetchInfinite(input: inferProcedureInput<TProcedure>, opts?: TRPCFetchInfiniteQueryOptions<inferProcedureInput<TProcedure>, inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientError<TRoot>>): Promise<InfiniteData<inferTransformedProcedureOutput<TRoot, TProcedure>, NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>> | null>>;
|
|
484
|
+
/**
|
|
485
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientprefetchquery
|
|
486
|
+
*/
|
|
487
|
+
prefetch(input: inferProcedureInput<TProcedure>, opts?: TRPCFetchQueryOptions<inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientError<TRoot>>): Promise<void>;
|
|
488
|
+
/**
|
|
489
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientprefetchinfinitequery
|
|
490
|
+
*/
|
|
491
|
+
prefetchInfinite(input: inferProcedureInput<TProcedure>, opts?: TRPCFetchInfiniteQueryOptions<inferProcedureInput<TProcedure>, inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientError<TRoot>>): Promise<void>;
|
|
492
|
+
/**
|
|
493
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientensurequerydata
|
|
494
|
+
*/
|
|
495
|
+
ensureData(input: inferProcedureInput<TProcedure>, opts?: TRPCFetchQueryOptions<inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientError<TRoot>>): Promise<inferTransformedProcedureOutput<TRoot, TProcedure>>;
|
|
496
|
+
/**
|
|
497
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientinvalidatequeries
|
|
498
|
+
*/
|
|
499
|
+
invalidate(input?: DeepPartial<inferProcedureInput<TProcedure>>, filters?: Omit<InvalidateQueryFilters, 'predicate'> & {
|
|
500
|
+
predicate?: (query: Query<inferProcedureOutput<TProcedure>, TRPCClientError<TRoot>, inferTransformedProcedureOutput<TRoot, TProcedure>, QueryKeyKnown<inferProcedureInput<TProcedure>, inferProcedureInput<TProcedure> extends {
|
|
501
|
+
cursor?: any;
|
|
502
|
+
} | void ? 'infinite' : 'query'>>) => boolean;
|
|
503
|
+
}, options?: InvalidateOptions): Promise<void>;
|
|
504
|
+
/**
|
|
505
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientrefetchqueries
|
|
506
|
+
*/
|
|
507
|
+
refetch(input?: inferProcedureInput<TProcedure>, filters?: RefetchQueryFilters, options?: RefetchOptions): Promise<void>;
|
|
508
|
+
/**
|
|
509
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientcancelqueries
|
|
510
|
+
*/
|
|
511
|
+
cancel(input?: inferProcedureInput<TProcedure>, options?: CancelOptions): Promise<void>;
|
|
512
|
+
/**
|
|
513
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientresetqueries
|
|
514
|
+
*/
|
|
515
|
+
reset(input?: inferProcedureInput<TProcedure>, options?: ResetOptions): Promise<void>;
|
|
516
|
+
/**
|
|
517
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientsetquerydata
|
|
518
|
+
*/
|
|
519
|
+
setData(
|
|
520
|
+
/**
|
|
521
|
+
* The input of the procedure
|
|
522
|
+
*/
|
|
523
|
+
input: inferProcedureInput<TProcedure>, updater: Updater<inferTransformedProcedureOutput<TRoot, TProcedure> | undefined, inferTransformedProcedureOutput<TRoot, TProcedure> | undefined>, options?: SetDataOptions): void;
|
|
524
|
+
/**
|
|
525
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientsetquerydata
|
|
526
|
+
*/
|
|
527
|
+
setQueriesData(
|
|
528
|
+
/**
|
|
529
|
+
* The input of the procedure
|
|
530
|
+
*/
|
|
531
|
+
input: inferProcedureInput<TProcedure>, filters: QueryFilters, updater: Updater<inferTransformedProcedureOutput<TRoot, TProcedure> | undefined, inferTransformedProcedureOutput<TRoot, TProcedure> | undefined>, options?: SetDataOptions): [QueryKey, inferTransformedProcedureOutput<TRoot, TProcedure>];
|
|
532
|
+
/**
|
|
533
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientsetquerydata
|
|
534
|
+
*/
|
|
535
|
+
setInfiniteData(input: inferProcedureInput<TProcedure>, updater: Updater<InfiniteData<inferTransformedProcedureOutput<TRoot, TProcedure>, NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>> | null> | undefined, InfiniteData<inferTransformedProcedureOutput<TRoot, TProcedure>, NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>> | null> | undefined>, options?: SetDataOptions): void;
|
|
536
|
+
/**
|
|
537
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientgetquerydata
|
|
538
|
+
*/
|
|
539
|
+
getData(input?: inferProcedureInput<TProcedure>): inferTransformedProcedureOutput<TRoot, TProcedure> | undefined;
|
|
540
|
+
/**
|
|
541
|
+
* @see https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientgetquerydata
|
|
542
|
+
*/
|
|
543
|
+
getInfiniteData(input?: inferProcedureInput<TProcedure>): InfiniteData<inferTransformedProcedureOutput<TRoot, TProcedure>, NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>> | null> | undefined;
|
|
544
|
+
};
|
|
545
|
+
type DecorateMutationProcedure<TRoot extends AnyRootTypes, TProcedure extends AnyMutationProcedure> = {
|
|
546
|
+
setMutationDefaults<TMeta = unknown>(options: InferMutationOptions<TRoot, TProcedure, TMeta> | ((args: {
|
|
547
|
+
canonicalMutationFn: NonNullable<InferMutationOptions<TRoot, TProcedure>['mutationFn']>;
|
|
548
|
+
}) => InferMutationOptions<TRoot, TProcedure, TMeta>)): void;
|
|
549
|
+
getMutationDefaults(): InferMutationOptions<TRoot, TProcedure> | undefined;
|
|
550
|
+
isMutating(): number;
|
|
551
|
+
};
|
|
552
|
+
/**
|
|
553
|
+
* this is the type that is used to add in procedures that can be used on
|
|
554
|
+
* an entire router
|
|
555
|
+
*/
|
|
556
|
+
type DecorateRouter = {
|
|
557
|
+
/**
|
|
558
|
+
* Invalidate the full router
|
|
559
|
+
* @see https://trpc.io/docs/v10/useContext#query-invalidation
|
|
560
|
+
* @see https://tanstack.com/query/v5/docs/framework/react/guides/query-invalidation
|
|
561
|
+
*/
|
|
562
|
+
invalidate(input?: undefined, filters?: InvalidateQueryFilters, options?: InvalidateOptions): Promise<void>;
|
|
563
|
+
};
|
|
564
|
+
/**
|
|
565
|
+
* @internal
|
|
566
|
+
*/
|
|
567
|
+
type DecoratedProcedureUtilsRecord<TRoot extends AnyRootTypes, TRecord extends RouterRecord> = DecorateRouter & { [TKey in keyof TRecord]: TRecord[TKey] extends infer $Value ? $Value extends AnyQueryProcedure ? DecorateQueryProcedure<TRoot, $Value> : $Value extends AnyMutationProcedure ? DecorateMutationProcedure<TRoot, $Value> : $Value extends RouterRecord ? DecoratedProcedureUtilsRecord<TRoot, $Value> & DecorateRouter : never : never };
|
|
568
|
+
type AnyDecoratedProcedure = DecorateQueryProcedure<any, any> & DecorateMutationProcedure<any, any>;
|
|
569
|
+
type CreateReactUtils<TRouter extends AnyRouter, TSSRContext> = ProtectedIntersection<DecoratedTRPCContextProps<TRouter, TSSRContext>, DecoratedProcedureUtilsRecord<TRouter['_def']['_config']['$types'], TRouter['_def']['record']>>;
|
|
570
|
+
type CreateQueryUtils<TRouter extends AnyRouter> = DecoratedProcedureUtilsRecord<TRouter['_def']['_config']['$types'], TRouter['_def']['record']>;
|
|
571
|
+
declare const getQueryType: (utilName: keyof AnyDecoratedProcedure) => QueryType;
|
|
572
|
+
/**
|
|
573
|
+
* @internal
|
|
574
|
+
*/
|
|
575
|
+
declare function createReactQueryUtils<TRouter extends AnyRouter, TSSRContext>(context: TRPCContextState<AnyRouter, TSSRContext>): ProtectedIntersection<DecoratedTRPCContextProps<TRouter, TSSRContext>, DecoratedProcedureUtilsRecord<TRouter["_def"]["_config"]["$types"], TRouter["_def"]["record"]>>;
|
|
576
|
+
/**
|
|
577
|
+
* @internal
|
|
578
|
+
*/
|
|
579
|
+
declare function createQueryUtilsProxy<TRouter extends AnyRouter>(context: TRPCQueryUtils<TRouter>): CreateQueryUtils<TRouter>;
|
|
580
|
+
//#endregion
|
|
581
|
+
//#region src/shared/proxy/useQueriesProxy.d.ts
|
|
582
|
+
type GetQueryOptions<TRoot extends AnyRootTypes, TProcedure extends AnyProcedure> = <TData = inferTransformedProcedureOutput<TRoot, TProcedure>>(input: inferProcedureInput<TProcedure>, opts?: TrpcQueryOptionsForUseQueries<inferTransformedProcedureOutput<TRoot, TProcedure>, TData, TRPCClientError<TRoot>>) => TrpcQueryOptionsForUseQueries<inferTransformedProcedureOutput<TRoot, TProcedure>, TData, TRPCClientError<TRoot>>;
|
|
583
|
+
/**
|
|
584
|
+
* @internal
|
|
585
|
+
*/
|
|
586
|
+
type UseQueriesProcedureRecord<TRoot extends AnyRootTypes, TRecord extends RouterRecord> = { [TKey in keyof TRecord]: TRecord[TKey] extends infer $Value ? $Value extends AnyQueryProcedure ? GetQueryOptions<TRoot, $Value> : $Value extends RouterRecord ? UseQueriesProcedureRecord<TRoot, $Value> : never : never };
|
|
587
|
+
type GetSuspenseQueryOptions<TRoot extends AnyRootTypes, TProcedure extends AnyQueryProcedure> = <TData = inferTransformedProcedureOutput<TRoot, TProcedure>>(input: inferProcedureInput<TProcedure>, opts?: TrpcQueryOptionsForUseSuspenseQueries<inferTransformedProcedureOutput<TRoot, TProcedure>, TData, TRPCClientError<TRoot>>) => TrpcQueryOptionsForUseSuspenseQueries<inferTransformedProcedureOutput<TRoot, TProcedure>, TData, TRPCClientError<TRoot>>;
|
|
588
|
+
/**
|
|
589
|
+
* @internal
|
|
590
|
+
*/
|
|
591
|
+
type UseSuspenseQueriesProcedureRecord<TRoot extends AnyRootTypes, TRecord extends RouterRecord> = { [TKey in keyof TRecord]: TRecord[TKey] extends infer $Value ? $Value extends AnyQueryProcedure ? GetSuspenseQueryOptions<TRoot, $Value> : $Value extends RouterRecord ? UseSuspenseQueriesProcedureRecord<TRoot, $Value> : never : never };
|
|
592
|
+
/**
|
|
593
|
+
* Create proxy for `useQueries` options
|
|
594
|
+
* @internal
|
|
595
|
+
*/
|
|
596
|
+
declare function createUseQueries<TRouter extends AnyRouter>(client: TRPCUntypedClient<TRouter> | TRPCClient<TRouter>): UseQueriesProcedureRecord<TRouter["_def"]["_config"]["$types"], TRouter["_def"]["record"]>;
|
|
597
|
+
//#endregion
|
|
598
|
+
//#region src/shared/queryClient.d.ts
|
|
599
|
+
/**
|
|
600
|
+
* @internal
|
|
601
|
+
*/
|
|
602
|
+
type CreateTRPCReactQueryClientConfig = {
|
|
603
|
+
queryClient?: QueryClient;
|
|
604
|
+
queryClientConfig?: never;
|
|
605
|
+
} | {
|
|
606
|
+
queryClientConfig?: QueryClientConfig;
|
|
607
|
+
queryClient?: never;
|
|
608
|
+
};
|
|
609
|
+
/**
|
|
610
|
+
* @internal
|
|
611
|
+
*/
|
|
612
|
+
declare const getQueryClient: (config: CreateTRPCReactQueryClientConfig) => QueryClient;
|
|
613
|
+
//# sourceMappingURL=queryClient.d.ts.map
|
|
614
|
+
//#endregion
|
|
615
|
+
//#region src/shared/polymorphism/mutationLike.d.ts
|
|
616
|
+
/**
|
|
617
|
+
* Use to describe a mutation route which matches a given mutation procedure's interface
|
|
618
|
+
*/
|
|
619
|
+
type MutationLike<TRoot extends AnyRootTypes, TProcedure extends AnyProcedure> = {
|
|
620
|
+
useMutation: (opts?: InferMutationOptions<TRoot, TProcedure>) => InferMutationResult<TRoot, TProcedure>;
|
|
621
|
+
};
|
|
622
|
+
/**
|
|
623
|
+
* Use to unwrap a MutationLike's input
|
|
624
|
+
*/
|
|
625
|
+
type InferMutationLikeInput<TMutationLike extends MutationLike<any, any>> = TMutationLike extends MutationLike<any, infer $Procedure> ? inferProcedureInput<$Procedure> : never;
|
|
626
|
+
/**
|
|
627
|
+
* Use to unwrap a MutationLike's data output
|
|
628
|
+
*/
|
|
629
|
+
type InferMutationLikeData<TMutationLike extends MutationLike<any, any>> = TMutationLike extends MutationLike<infer TRoot, infer TProcedure> ? inferTransformedProcedureOutput<TRoot, TProcedure> : never;
|
|
630
|
+
//# sourceMappingURL=mutationLike.d.ts.map
|
|
631
|
+
//#endregion
|
|
632
|
+
//#region src/shared/polymorphism/queryLike.d.ts
|
|
633
|
+
/**
|
|
634
|
+
* Use to request a query route which matches a given query procedure's interface
|
|
635
|
+
*/
|
|
636
|
+
type QueryLike<TRoot extends AnyRootTypes, TProcedure extends AnyProcedure> = {
|
|
637
|
+
useQuery: (variables: inferProcedureInput<TProcedure>, opts?: InferQueryOptions<TRoot, TProcedure, any>) => InferQueryResult<TRoot, TProcedure>;
|
|
638
|
+
useSuspenseQuery: (variables: inferProcedureInput<TProcedure>, opts?: InferQueryOptions<TRoot, TProcedure, any>) => UseTRPCSuspenseQueryResult<inferProcedureOutput<TProcedure>, TRPCClientErrorLike<TRoot>>;
|
|
639
|
+
};
|
|
640
|
+
/**
|
|
641
|
+
* Use to unwrap a QueryLike's input
|
|
642
|
+
*/
|
|
643
|
+
type InferQueryLikeInput<TQueryLike> = TQueryLike extends DecoratedQuery<infer $Def> ? $Def['input'] : TQueryLike extends QueryLike<any, infer TProcedure> ? inferProcedureInput<TProcedure> : never;
|
|
644
|
+
/**
|
|
645
|
+
* Use to unwrap a QueryLike's data output
|
|
646
|
+
*/
|
|
647
|
+
type InferQueryLikeData<TQueryLike> = TQueryLike extends DecoratedQuery<infer $Def> ? $Def['output'] : TQueryLike extends QueryLike<infer TRoot, infer TProcedure> ? inferTransformedProcedureOutput<TRoot, TProcedure> : never;
|
|
648
|
+
//# sourceMappingURL=queryLike.d.ts.map
|
|
649
|
+
//#endregion
|
|
650
|
+
//#region src/shared/polymorphism/routerLike.d.ts
|
|
651
|
+
/**
|
|
652
|
+
* Use to describe a route path which matches a given route's interface
|
|
653
|
+
*/
|
|
654
|
+
type RouterLike<TRouter extends AnyRouter> = RouterLikeInner<TRouter['_def']['_config']['$types'], TRouter['_def']['record']>;
|
|
655
|
+
type RouterLikeInner<TRoot extends AnyRootTypes, TRecord extends RouterRecord> = { [TKey in keyof TRecord]: TRecord[TKey] extends infer $Value ? $Value extends AnyQueryProcedure ? QueryLike<TRoot, $Value> : $Value extends AnyMutationProcedure ? MutationLike<TRoot, $Value> : $Value extends RouterRecord ? RouterLikeInner<TRoot, $Value> : never : never };
|
|
656
|
+
//# sourceMappingURL=routerLike.d.ts.map
|
|
657
|
+
//#endregion
|
|
658
|
+
//#region src/shared/polymorphism/utilsLike.d.ts
|
|
659
|
+
/**
|
|
660
|
+
* Use to describe a Utils/Context path which matches the given route's interface
|
|
661
|
+
*/
|
|
662
|
+
type UtilsLike<TRouter extends AnyRouter> = DecoratedProcedureUtilsRecord<TRouter['_def']['_config']['$types'], TRouter['_def']['record']>;
|
|
663
|
+
//# sourceMappingURL=utilsLike.d.ts.map
|
|
664
|
+
//#endregion
|
|
665
|
+
//#region src/internals/getClientArgs.d.ts
|
|
666
|
+
/**
|
|
667
|
+
* @internal
|
|
668
|
+
*/
|
|
669
|
+
declare function getClientArgs<TOptions>(queryKey: TRPCQueryKey, opts: TOptions, infiniteParams?: {
|
|
670
|
+
pageParam: any;
|
|
671
|
+
direction: 'forward' | 'backward';
|
|
672
|
+
}): readonly [string, unknown, any];
|
|
673
|
+
//# sourceMappingURL=getClientArgs.d.ts.map
|
|
674
|
+
//#endregion
|
|
675
|
+
//#region src/internals/useQueries.d.ts
|
|
676
|
+
/**
|
|
677
|
+
* @internal
|
|
678
|
+
*/
|
|
679
|
+
type UseQueryOptionsForUseQueries<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = DistributiveOmit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'>;
|
|
680
|
+
/**
|
|
681
|
+
* @internal
|
|
682
|
+
*/
|
|
683
|
+
type UseQueryOptionsForUseSuspenseQueries<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = DistributiveOmit<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'>;
|
|
684
|
+
/**
|
|
685
|
+
* @internal
|
|
686
|
+
*/
|
|
687
|
+
type TrpcQueryOptionsForUseQueries<TOutput, TData, TError> = DistributiveOmit<UseTRPCQueryOptions<TOutput, TData, TError>, 'queryKey'>;
|
|
688
|
+
/**
|
|
689
|
+
* @internal
|
|
690
|
+
*/
|
|
691
|
+
type TrpcQueryOptionsForUseSuspenseQueries<TOutput, TData, TError> = DistributiveOmit<UseTRPCSuspenseQueryOptions<TOutput, TData, TError>, 'queryKey'>;
|
|
692
|
+
/**
|
|
693
|
+
* @internal
|
|
694
|
+
*/
|
|
695
|
+
declare type QueriesResults<TQueriesOptions extends UseQueryOptionsForUseQueries<any, any, any, any>[]> = { [TKey in keyof TQueriesOptions]: TQueriesOptions[TKey] extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, any> ? UseTRPCQueryResult<unknown extends TData ? TQueryFnData : TData, TError> : never };
|
|
696
|
+
/**
|
|
697
|
+
* @internal
|
|
698
|
+
*/
|
|
699
|
+
declare type SuspenseQueriesResults<TQueriesOptions extends UseQueryOptionsForUseSuspenseQueries<any, any, any, any>[]> = [{ [TKey in keyof TQueriesOptions]: TQueriesOptions[TKey] extends UseQueryOptionsForUseSuspenseQueries<infer TQueryFnData, any, infer TData, any> ? unknown extends TData ? TQueryFnData : TData : never }, { [TKey in keyof TQueriesOptions]: TQueriesOptions[TKey] extends UseQueryOptionsForUseSuspenseQueries<infer TQueryFnData, infer TError, infer TData, any> ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData, TError> : never }];
|
|
700
|
+
type GetOptions<TQueryOptions> = TQueryOptions extends UseQueryOptionsForUseQueries<any, any, any, any> ? TQueryOptions : never;
|
|
701
|
+
/**
|
|
702
|
+
* @internal
|
|
703
|
+
*/
|
|
704
|
+
type QueriesOptions<TQueriesOptions extends any[], TResult extends any[] = []> = TQueriesOptions extends [] ? [] : TQueriesOptions extends [infer Head] ? [...TResult, GetOptions<Head>] : TQueriesOptions extends [infer Head, ...infer Tail] ? QueriesOptions<Tail, [...TResult, GetOptions<Head>]> : unknown[] extends TQueriesOptions ? TQueriesOptions : TQueriesOptions extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>[] ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptionsForUseQueries[];
|
|
705
|
+
type GetSuspenseOptions<TQueryOptions> = TQueryOptions extends UseQueryOptionsForUseSuspenseQueries<any, any, any, any> ? TQueryOptions : never;
|
|
706
|
+
/**
|
|
707
|
+
* @internal
|
|
708
|
+
*/
|
|
709
|
+
type SuspenseQueriesOptions<TQueriesOptions extends any[], TResult extends any[] = []> = TQueriesOptions extends [] ? [] : TQueriesOptions extends [infer Head] ? [...TResult, GetSuspenseOptions<Head>] : TQueriesOptions extends [infer Head, ...infer Tail] ? SuspenseQueriesOptions<Tail, [...TResult, GetSuspenseOptions<Head>]> : unknown[] extends TQueriesOptions ? TQueriesOptions : TQueriesOptions extends UseQueryOptionsForUseSuspenseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>[] ? UseQueryOptionsForUseSuspenseQueries<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptionsForUseSuspenseQueries[];
|
|
710
|
+
/**
|
|
711
|
+
* @internal
|
|
712
|
+
*/
|
|
713
|
+
type TRPCUseQueries<TRouter extends AnyRouter> = <TQueryOptions extends UseQueryOptionsForUseQueries<any, any, any, any>[], TCombinedResult = QueriesResults<TQueryOptions>>(queriesCallback: (t: UseQueriesProcedureRecord<TRouter['_def']['_config']['$types'], TRouter['_def']['record']>) => readonly [...QueriesOptions<TQueryOptions>], options?: {
|
|
714
|
+
combine?: (results: QueriesResults<TQueryOptions>) => TCombinedResult;
|
|
715
|
+
}) => TCombinedResult;
|
|
716
|
+
/**
|
|
717
|
+
* @internal
|
|
718
|
+
*/
|
|
719
|
+
type TRPCUseSuspenseQueries<TRouter extends AnyRouter> = <TQueryOptions extends UseQueryOptionsForUseSuspenseQueries<any, any, any, any>[]>(queriesCallback: (t: UseSuspenseQueriesProcedureRecord<TRouter['_def']['_config']['$types'], TRouter['_def']['record']>) => readonly [...SuspenseQueriesOptions<TQueryOptions>]) => SuspenseQueriesResults<TQueryOptions>;
|
|
720
|
+
//#endregion
|
|
721
|
+
//#region src/createTRPCReact.d.ts
|
|
722
|
+
type ResolverDef = {
|
|
723
|
+
input: any;
|
|
724
|
+
output: any;
|
|
725
|
+
transformer: boolean;
|
|
726
|
+
errorShape: any;
|
|
727
|
+
};
|
|
728
|
+
/**
|
|
729
|
+
* @internal
|
|
730
|
+
*/
|
|
731
|
+
interface ProcedureUseQuery<TDef extends ResolverDef> {
|
|
732
|
+
<TQueryFnData extends TDef['output'] = TDef['output'], TData = TQueryFnData>(input: TDef['input'] | SkipToken, opts: DefinedUseTRPCQueryOptions<TQueryFnData, TData, TRPCClientErrorLike<{
|
|
733
|
+
errorShape: TDef['errorShape'];
|
|
734
|
+
transformer: TDef['transformer'];
|
|
735
|
+
}>, TDef['output']>): DefinedUseTRPCQueryResult<TData, TRPCClientErrorLike<{
|
|
736
|
+
errorShape: TDef['errorShape'];
|
|
737
|
+
transformer: TDef['transformer'];
|
|
738
|
+
}>>;
|
|
739
|
+
<TQueryFnData extends TDef['output'] = TDef['output'], TData = TQueryFnData>(input: TDef['input'] | SkipToken, opts?: UseTRPCQueryOptions<TQueryFnData, TData, TRPCClientErrorLike<TDef>, TDef['output']>): UseTRPCQueryResult<TData, TRPCClientErrorLike<TDef>>;
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* @internal
|
|
743
|
+
*/
|
|
744
|
+
type ProcedureUsePrefetchQuery<TDef extends ResolverDef> = (input: TDef['input'] | SkipToken, opts?: TRPCFetchQueryOptions<TDef['output'], TRPCClientErrorLike<TDef>>) => void;
|
|
745
|
+
/**
|
|
746
|
+
* @remark `void` is here due to https://github.com/trpc/trpc/pull/4374
|
|
747
|
+
*/
|
|
748
|
+
type CursorInput = {
|
|
749
|
+
cursor?: any;
|
|
750
|
+
} | void;
|
|
751
|
+
type ReservedInfiniteQueryKeys = 'cursor' | 'direction';
|
|
752
|
+
type InfiniteInput<TInput> = Omit<TInput, ReservedInfiniteQueryKeys> | SkipToken;
|
|
753
|
+
type inferCursorType<TInput> = TInput extends {
|
|
754
|
+
cursor?: any;
|
|
755
|
+
} ? TInput['cursor'] : unknown;
|
|
756
|
+
type makeInfiniteQueryOptions<TCursor, TOptions> = Omit<TOptions, 'queryKey' | 'initialPageParam' | 'queryFn' | 'queryHash' | 'queryHashFn'> & TRPCUseQueryBaseOptions & {
|
|
757
|
+
initialCursor?: TCursor;
|
|
758
|
+
};
|
|
759
|
+
type trpcInfiniteData<TDef extends ResolverDef> = Simplify<InfiniteData<TDef['output'], inferCursorType<TDef['input']>>>;
|
|
760
|
+
interface useTRPCInfiniteQuery<TDef extends ResolverDef> {
|
|
761
|
+
<TData = trpcInfiniteData<TDef>>(input: InfiniteInput<TDef['input']>, opts: makeInfiniteQueryOptions<inferCursorType<TDef['input']>, DefinedInitialDataInfiniteOptions<TDef['output'], TRPCClientErrorLike<TDef>, TData, any, inferCursorType<TDef['input']>>>): TRPCHookResult & DefinedUseInfiniteQueryResult<TData, TRPCClientErrorLike<TDef>>;
|
|
762
|
+
<TData = trpcInfiniteData<TDef>>(input: InfiniteInput<TDef['input']>, opts?: makeInfiniteQueryOptions<inferCursorType<TDef['input']>, UndefinedInitialDataInfiniteOptions<TDef['output'], TRPCClientErrorLike<TDef>, TData, any, inferCursorType<TDef['input']>>>): TRPCHookResult & UseInfiniteQueryResult<TData, TRPCClientErrorLike<TDef>>;
|
|
763
|
+
<TData = trpcInfiniteData<TDef>>(input: InfiniteInput<TDef['input']>, opts?: makeInfiniteQueryOptions<inferCursorType<TDef['input']>, UseInfiniteQueryOptions<TDef['output'], TRPCClientErrorLike<TDef>, TData, any, inferCursorType<TDef['input']>>>): TRPCHookResult & UseInfiniteQueryResult<TData, TRPCClientErrorLike<TDef>>;
|
|
764
|
+
}
|
|
765
|
+
type useTRPCSuspenseInfiniteQuery<TDef extends ResolverDef> = (input: InfiniteInput<TDef['input']>, opts: makeInfiniteQueryOptions<inferCursorType<TDef['input']>, UseSuspenseInfiniteQueryOptions<TDef['output'], TRPCClientErrorLike<TDef>, trpcInfiniteData<TDef>, any, inferCursorType<TDef['input']>>>) => [trpcInfiniteData<TDef>, TRPCHookResult & UseSuspenseInfiniteQueryResult<trpcInfiniteData<TDef>, TRPCClientErrorLike<TDef>>];
|
|
766
|
+
/**
|
|
767
|
+
* @internal
|
|
768
|
+
*/
|
|
769
|
+
type MaybeDecoratedInfiniteQuery<TDef extends ResolverDef> = TDef['input'] extends CursorInput ? {
|
|
770
|
+
/**
|
|
771
|
+
* @see https://trpc.io/docs/v11/client/react/useInfiniteQuery
|
|
772
|
+
*/
|
|
773
|
+
useInfiniteQuery: useTRPCInfiniteQuery<TDef>;
|
|
774
|
+
/**
|
|
775
|
+
* @see https://trpc.io/docs/client/react/suspense#usesuspenseinfinitequery
|
|
776
|
+
*/
|
|
777
|
+
useSuspenseInfiniteQuery: useTRPCSuspenseInfiniteQuery<TDef>;
|
|
778
|
+
usePrefetchInfiniteQuery: (input: Omit<TDef['input'], ReservedInfiniteQueryKeys> | SkipToken, opts: TRPCFetchInfiniteQueryOptions<TDef['input'], TDef['output'], TRPCClientErrorLike<TDef>>) => void;
|
|
779
|
+
} : object;
|
|
780
|
+
/**
|
|
781
|
+
* @internal
|
|
782
|
+
*/
|
|
783
|
+
type DecoratedQueryMethods<TDef extends ResolverDef> = {
|
|
784
|
+
/**
|
|
785
|
+
* @see https://trpc.io/docs/v11/client/react/useQuery
|
|
786
|
+
*/
|
|
787
|
+
useQuery: ProcedureUseQuery<TDef>;
|
|
788
|
+
usePrefetchQuery: ProcedureUsePrefetchQuery<TDef>;
|
|
789
|
+
/**
|
|
790
|
+
* @see https://trpc.io/docs/v11/client/react/suspense#usesuspensequery
|
|
791
|
+
*/
|
|
792
|
+
useSuspenseQuery: <TQueryFnData extends TDef['output'] = TDef['output'], TData = TQueryFnData>(input: TDef['input'], opts?: UseTRPCSuspenseQueryOptions<TQueryFnData, TData, TRPCClientErrorLike<TDef>>) => [TData, UseSuspenseQueryResult<TData, TRPCClientErrorLike<TDef>> & TRPCHookResult];
|
|
793
|
+
};
|
|
794
|
+
/**
|
|
795
|
+
* @internal
|
|
796
|
+
*/
|
|
797
|
+
type DecoratedQuery<TDef extends ResolverDef> = MaybeDecoratedInfiniteQuery<TDef> & DecoratedQueryMethods<TDef>;
|
|
798
|
+
type DecoratedMutation<TDef extends ResolverDef> = {
|
|
799
|
+
/**
|
|
800
|
+
* @see https://trpc.io/docs/v11/client/react/useMutation
|
|
801
|
+
*/
|
|
802
|
+
useMutation: <TContext = unknown>(opts?: UseTRPCMutationOptions<TDef['input'], TRPCClientErrorLike<TDef>, TDef['output'], TContext>) => UseTRPCMutationResult<TDef['output'], TRPCClientErrorLike<TDef>, TDef['input'], TContext>;
|
|
803
|
+
};
|
|
804
|
+
interface ProcedureUseSubscription<TDef extends ResolverDef> {
|
|
805
|
+
(input: TDef['input'], opts?: UseTRPCSubscriptionOptions<inferAsyncIterableYield<TDef['output']>, TRPCClientErrorLike<TDef>>): TRPCSubscriptionResult<inferAsyncIterableYield<TDef['output']>, TRPCClientErrorLike<TDef>>;
|
|
806
|
+
(input: TDef['input'] | SkipToken, opts?: Omit<UseTRPCSubscriptionOptions<inferAsyncIterableYield<TDef['output']>, TRPCClientErrorLike<TDef>>, 'enabled'>): TRPCSubscriptionResult<inferAsyncIterableYield<TDef['output']>, TRPCClientErrorLike<TDef>>;
|
|
807
|
+
}
|
|
808
|
+
/**
|
|
809
|
+
* @internal
|
|
810
|
+
*/
|
|
811
|
+
type DecorateProcedure<TType extends ProcedureType, TDef extends ResolverDef> = TType extends 'query' ? DecoratedQuery<TDef> : TType extends 'mutation' ? DecoratedMutation<TDef> : TType extends 'subscription' ? {
|
|
812
|
+
/**
|
|
813
|
+
* @see https://trpc.io/docs/v11/subscriptions
|
|
814
|
+
*/
|
|
815
|
+
useSubscription: ProcedureUseSubscription<TDef>;
|
|
816
|
+
} : never;
|
|
817
|
+
/**
|
|
818
|
+
* @internal
|
|
819
|
+
*/
|
|
820
|
+
type DecorateRouterRecord<TRoot extends AnyRootTypes, TRecord extends RouterRecord> = { [TKey in keyof TRecord]: TRecord[TKey] extends infer $Value ? $Value extends AnyProcedure ? DecorateProcedure<$Value['_def']['type'], {
|
|
821
|
+
input: inferProcedureInput<$Value>;
|
|
822
|
+
output: inferTransformedProcedureOutput<TRoot, $Value>;
|
|
823
|
+
transformer: TRoot['transformer'];
|
|
824
|
+
errorShape: TRoot['errorShape'];
|
|
825
|
+
}> : $Value extends RouterRecord ? DecorateRouterRecord<TRoot, $Value> : never : never };
|
|
826
|
+
/**
|
|
827
|
+
* @internal
|
|
828
|
+
*/
|
|
829
|
+
type CreateTRPCReactBase<TRouter extends AnyRouter, TSSRContext> = {
|
|
830
|
+
/**
|
|
831
|
+
* @deprecated renamed to `useUtils` and will be removed in a future tRPC version
|
|
832
|
+
*
|
|
833
|
+
* @see https://trpc.io/docs/v11/client/react/useUtils
|
|
834
|
+
*/
|
|
835
|
+
useContext(): CreateReactUtils<TRouter, TSSRContext>;
|
|
836
|
+
/**
|
|
837
|
+
* @see https://trpc.io/docs/v11/client/react/useUtils
|
|
838
|
+
*/
|
|
839
|
+
useUtils(): CreateReactUtils<TRouter, TSSRContext>;
|
|
840
|
+
Provider: TRPCProvider<TRouter, TSSRContext>;
|
|
841
|
+
createClient: typeof createTRPCClient<TRouter>;
|
|
842
|
+
useQueries: TRPCUseQueries<TRouter>;
|
|
843
|
+
useSuspenseQueries: TRPCUseSuspenseQueries<TRouter>;
|
|
844
|
+
};
|
|
845
|
+
type CreateTRPCReact<TRouter extends AnyRouter, TSSRContext> = ProtectedIntersection<CreateTRPCReactBase<TRouter, TSSRContext>, DecorateRouterRecord<TRouter['_def']['_config']['$types'], TRouter['_def']['record']>>;
|
|
846
|
+
/**
|
|
847
|
+
* @internal
|
|
848
|
+
*/
|
|
849
|
+
|
|
850
|
+
declare function createTRPCReact<TRouter extends AnyRouter, TSSRContext = unknown>(opts?: CreateTRPCReactOptions<TRouter>): CreateTRPCReact<TRouter, TSSRContext>;
|
|
851
|
+
//#endregion
|
|
852
|
+
//#region src/internals/getQueryKey.d.ts
|
|
853
|
+
type QueryType = 'any' | 'infinite' | 'query';
|
|
854
|
+
type TRPCQueryKey = [readonly string[], {
|
|
855
|
+
input?: unknown;
|
|
856
|
+
type?: Exclude<QueryType, 'any'>;
|
|
857
|
+
}?];
|
|
858
|
+
type TRPCMutationKey = [readonly string[]];
|
|
859
|
+
type ProcedureOrRouter = DecoratedMutation<any> | DecoratedQuery<any> | DecorateRouterRecord<any, any>;
|
|
860
|
+
/**
|
|
861
|
+
* To allow easy interactions with groups of related queries, such as
|
|
862
|
+
* invalidating all queries of a router, we use an array as the path when
|
|
863
|
+
* storing in tanstack query.
|
|
864
|
+
**/
|
|
865
|
+
|
|
866
|
+
type GetInfiniteQueryInput<TProcedureInput, TInputWithoutCursorAndDirection = Omit<TProcedureInput, 'cursor' | 'direction'>> = keyof TInputWithoutCursorAndDirection extends never ? undefined : DeepPartial<TInputWithoutCursorAndDirection> | undefined;
|
|
867
|
+
/** @internal */
|
|
868
|
+
type GetQueryProcedureInput<TProcedureInput> = TProcedureInput extends {
|
|
869
|
+
cursor?: any;
|
|
870
|
+
} ? GetInfiniteQueryInput<TProcedureInput> : DeepPartial<TProcedureInput> | undefined;
|
|
871
|
+
type GetParams<TProcedureOrRouter extends ProcedureOrRouter> = TProcedureOrRouter extends DecoratedQuery<infer $Def> ? [input?: GetQueryProcedureInput<$Def['input']>, type?: QueryType] : [];
|
|
872
|
+
/**
|
|
873
|
+
* Method to extract the query key for a procedure
|
|
874
|
+
* @param procedureOrRouter - procedure or AnyRouter
|
|
875
|
+
* @param input - input to procedureOrRouter
|
|
876
|
+
* @param type - defaults to `any`
|
|
877
|
+
* @see https://trpc.io/docs/v11/getQueryKey
|
|
878
|
+
*/
|
|
879
|
+
declare function getQueryKey<TProcedureOrRouter extends ProcedureOrRouter>(procedureOrRouter: TProcedureOrRouter, ..._params: GetParams<TProcedureOrRouter>): TRPCQueryKey;
|
|
880
|
+
type QueryKeyKnown<TInput, TType extends Exclude<QueryType, 'any'>> = [string[], {
|
|
881
|
+
input?: GetQueryProcedureInput<TInput>;
|
|
882
|
+
type: TType;
|
|
883
|
+
}?];
|
|
884
|
+
/**
|
|
885
|
+
* Method to extract the mutation key for a procedure
|
|
886
|
+
* @param procedure - procedure
|
|
887
|
+
* @see https://trpc.io/docs/v11/getQueryKey#mutations
|
|
888
|
+
*/
|
|
889
|
+
declare function getMutationKey<TProcedure extends DecoratedMutation<any>>(procedure: TProcedure): TRPCMutationKey;
|
|
890
|
+
//#endregion
|
|
891
|
+
export { CreateClient, CreateQueryUtils, CreateReactUtils, CreateTRPCReact, CreateTRPCReactBase, CreateTRPCReactOptions, CreateTRPCReactQueryClientConfig, DecorateProcedure, DecorateQueryProcedure, DecorateRouterRecord, DecoratedProcedureUtilsRecord, DecoratedTRPCContextProps, DefinedTRPCInfiniteQueryOptionsIn, DefinedTRPCInfiniteQueryOptionsOut, DefinedTRPCQueryOptionsIn, DefinedTRPCQueryOptionsOut, DefinedUseTRPCQueryOptions, DefinedUseTRPCQueryResult, ExtractCursorType, InferMutationLikeData, InferMutationLikeInput, InferQueryLikeData, InferQueryLikeInput, MutationLike, OutputWithCursor, QueryLike, RouterLike, RouterLikeInner, SSRState, TRPCContext, TRPCContextProps, TRPCContextPropsBase, TRPCContextState, TRPCFetchInfiniteQueryOptions, TRPCFetchQueryOptions, TRPCHookResult, TRPCProvider, TRPCProviderProps, TRPCQueryBaseOptions, TRPCQueryOptions, TRPCQueryOptionsResult, TRPCQueryUtils, TRPCReactRequestOptions, TRPCSubscriptionBaseResult, TRPCSubscriptionConnectingResult, TRPCSubscriptionErrorResult, TRPCSubscriptionIdleResult, TRPCSubscriptionPendingResult, TRPCSubscriptionResult, TRPCUseQueries, TRPCUseQueryBaseOptions, TRPCUseSuspenseQueries, UndefinedTRPCInfiniteQueryOptionsIn, UndefinedTRPCInfiniteQueryOptionsOut, UndefinedTRPCQueryOptionsIn, UndefinedTRPCQueryOptionsOut, UnusedSkipTokenTRPCInfiniteQueryOptionsIn, UnusedSkipTokenTRPCInfiniteQueryOptionsOut, UnusedSkipTokenTRPCQueryOptionsIn, UnusedSkipTokenTRPCQueryOptionsOut, UseMutationOverride, UseQueriesProcedureRecord, UseSuspenseQueriesProcedureRecord, UseTRPCInfiniteQueryOptions, UseTRPCInfiniteQueryResult, UseTRPCInfiniteQuerySuccessResult, UseTRPCMutationOptions, UseTRPCMutationResult, UseTRPCPrefetchInfiniteQueryOptions, UseTRPCPrefetchQueryOptions, UseTRPCQueryOptions, UseTRPCQueryResult, UseTRPCQuerySuccessResult, UseTRPCSubscriptionOptions, UseTRPCSuspenseInfiniteQueryOptions, UseTRPCSuspenseInfiniteQueryResult, UseTRPCSuspenseQueryOptions, UseTRPCSuspenseQueryResult, UtilsLike, contextProps, createQueryUtilsProxy, createReactDecoration, createReactQueryUtils, createRootHooks, createTRPCReact, createUseQueries, getClientArgs, getMutationKey, getQueryClient, getQueryKey, getQueryType, inferReactQueryProcedureOptions };
|
|
892
|
+
//# sourceMappingURL=getQueryKey.d-CruH3ncI.d.mts.map
|