@trpc/react-query 10.28.0 → 10.28.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/README.md +1 -2
- package/dist/{context-1da55110.js → context-4557b3d3.js} +31 -31
- package/dist/{createHooksInternal-bd7db1e7.js → createHooksInternal-03506f75.js} +483 -472
- package/dist/{createHooksInternal-9f8a4b21.js → createHooksInternal-466f5861.js} +21 -7
- package/dist/{createHooksInternal-d15d0073.mjs → createHooksInternal-a6562110.mjs} +21 -7
- package/dist/createTRPCReact.d.ts +75 -75
- package/dist/createTRPCReact.d.ts.map +1 -1
- package/dist/index.d.ts +5 -5
- package/dist/index.js +1 -1
- package/dist/index.mjs +2 -2
- package/dist/internals/context.d.ts +125 -127
- package/dist/internals/context.d.ts.map +1 -1
- package/dist/internals/getArrayQueryKey.d.ts +24 -24
- package/dist/internals/getArrayQueryKey.d.ts.map +1 -1
- package/dist/internals/getClientArgs.d.ts +1 -1
- package/dist/internals/getQueryKey.d.ts +30 -30
- package/dist/internals/getQueryKey.d.ts.map +1 -1
- package/dist/internals/useHookResult.d.ts +9 -9
- package/dist/internals/useQueries.d.ts +27 -27
- package/dist/internals/useQueries.d.ts.map +1 -1
- package/dist/interop.d.ts +10 -10
- package/dist/interop.d.ts.map +1 -1
- package/dist/{queryClient-77734cc3.js → queryClient-1c8d7d8a.js} +3 -3
- package/dist/server/index.d.ts +3 -3
- package/dist/server/ssgProxy.d.ts +36 -36
- package/dist/server/ssgProxy.d.ts.map +1 -1
- package/dist/server/types.d.ts +9 -9
- package/dist/server/types.d.ts.map +1 -1
- package/dist/shared/hooks/createHooksInternal.d.ts +27 -27
- package/dist/shared/hooks/createHooksInternal.d.ts.map +1 -1
- package/dist/shared/hooks/createRootHooks.d.ts +6 -6
- package/dist/shared/hooks/deprecated/createHooksInternal.d.ts +60 -60
- package/dist/shared/hooks/deprecated/createHooksInternal.d.ts.map +1 -1
- package/dist/shared/hooks/types.d.ts +81 -81
- package/dist/shared/hooks/types.d.ts.map +1 -1
- package/dist/shared/index.d.ts +21 -21
- package/dist/shared/index.js +1 -1
- package/dist/shared/index.mjs +1 -1
- package/dist/shared/polymorphism/index.d.ts +4 -4
- package/dist/shared/polymorphism/mutationLike.d.ts +17 -17
- package/dist/shared/polymorphism/mutationLike.d.ts.map +1 -1
- package/dist/shared/polymorphism/queryLike.d.ts +17 -17
- package/dist/shared/polymorphism/queryLike.d.ts.map +1 -1
- package/dist/shared/polymorphism/routerLike.d.ts +9 -9
- package/dist/shared/polymorphism/routerLike.d.ts.map +1 -1
- package/dist/shared/polymorphism/utilsLike.d.ts +6 -6
- package/dist/shared/polymorphism/utilsLike.d.ts.map +1 -1
- package/dist/shared/proxy/decorationProxy.d.ts +7 -7
- package/dist/shared/proxy/useQueriesProxy.d.ts +17 -17
- package/dist/shared/proxy/useQueriesProxy.d.ts.map +1 -1
- package/dist/shared/proxy/utilsProxy.d.ts +92 -93
- package/dist/shared/proxy/utilsProxy.d.ts.map +1 -1
- package/dist/shared/queryClient.d.ts +15 -15
- package/dist/shared/queryClient.d.ts.map +1 -1
- package/dist/shared/types.d.ts +52 -52
- package/dist/ssg/index.d.ts +14 -14
- package/dist/ssg/ssg.d.ts +15 -15
- package/dist/ssg/ssg.d.ts.map +1 -1
- package/dist/utils/inferReactQueryProcedure.d.ts +23 -23
- package/dist/utils/inferReactQueryProcedure.d.ts.map +1 -1
- package/package.json +7 -7
- package/src/createTRPCReact.tsx +3 -3
- package/src/internals/context.tsx +3 -5
- package/src/internals/getQueryKey.ts +2 -2
- package/src/interop.ts +2 -2
- package/src/server/ssgProxy.ts +2 -2
- package/src/shared/hooks/createHooksInternal.tsx +38 -13
- package/src/shared/hooks/deprecated/createHooksInternal.tsx +10 -7
- package/src/shared/proxy/utilsProxy.ts +4 -4
- package/src/ssg/ssg.ts +2 -2
|
@@ -360,10 +360,14 @@ function getClientArgs(pathAndInput, opts) {
|
|
|
360
360
|
throw new Error('Unable to retrieve application context. Did you forget to wrap your App inside `withTRPC` HoC?');
|
|
361
361
|
}
|
|
362
362
|
const { abortOnUnmount , client , ssrState , queryClient , prefetchQuery } = context;
|
|
363
|
-
|
|
363
|
+
const defaultOpts = queryClient.getQueryDefaults(getArrayQueryKey.getArrayQueryKey(pathAndInput, 'query'));
|
|
364
|
+
if (typeof window === 'undefined' && ssrState === 'prepass' && opts?.trpc?.ssr !== false && (opts?.enabled ?? defaultOpts?.enabled) !== false && !queryClient.getQueryCache().find(getArrayQueryKey.getArrayQueryKey(pathAndInput, 'query'))) {
|
|
364
365
|
void prefetchQuery(pathAndInput, opts);
|
|
365
366
|
}
|
|
366
|
-
const ssrOpts = useSSRQueryOptionsIfNeeded(pathAndInput, 'query',
|
|
367
|
+
const ssrOpts = useSSRQueryOptionsIfNeeded(pathAndInput, 'query', {
|
|
368
|
+
...defaultOpts,
|
|
369
|
+
...opts
|
|
370
|
+
});
|
|
367
371
|
const shouldAbortOnUnmount = opts?.trpc?.abortOnUnmount ?? config?.abortOnUnmount ?? abortOnUnmount;
|
|
368
372
|
const hook = reactQuery.useQuery({
|
|
369
373
|
...ssrOpts,
|
|
@@ -394,6 +398,9 @@ function getClientArgs(pathAndInput, opts) {
|
|
|
394
398
|
context: ReactQueryContext
|
|
395
399
|
});
|
|
396
400
|
const actualPath = Array.isArray(path) ? path[0] : path;
|
|
401
|
+
const defaultOpts = queryClient.getMutationDefaults([
|
|
402
|
+
actualPath.split('.')
|
|
403
|
+
]);
|
|
397
404
|
const hook = reactQuery.useMutation({
|
|
398
405
|
...opts,
|
|
399
406
|
mutationKey: [
|
|
@@ -407,11 +414,11 @@ function getClientArgs(pathAndInput, opts) {
|
|
|
407
414
|
},
|
|
408
415
|
context: ReactQueryContext,
|
|
409
416
|
onSuccess (...args) {
|
|
410
|
-
const originalFn = ()=>opts?.onSuccess?.(...args);
|
|
417
|
+
const originalFn = ()=>opts?.onSuccess?.(...args) ?? defaultOpts?.onSuccess?.(...args);
|
|
411
418
|
return mutationSuccessOverride({
|
|
412
419
|
originalFn,
|
|
413
420
|
queryClient,
|
|
414
|
-
meta: opts?.meta ?? {}
|
|
421
|
+
meta: opts?.meta ?? defaultOpts?.meta ?? {}
|
|
415
422
|
});
|
|
416
423
|
}
|
|
417
424
|
});
|
|
@@ -463,10 +470,17 @@ function getClientArgs(pathAndInput, opts) {
|
|
|
463
470
|
function useInfiniteQuery(pathAndInput, opts) {
|
|
464
471
|
const [path, input] = pathAndInput;
|
|
465
472
|
const { client , ssrState , prefetchInfiniteQuery , queryClient , abortOnUnmount , } = useContext();
|
|
466
|
-
|
|
467
|
-
|
|
473
|
+
const defaultOpts = queryClient.getQueryDefaults(getArrayQueryKey.getArrayQueryKey(pathAndInput, 'infinite'));
|
|
474
|
+
if (typeof window === 'undefined' && ssrState === 'prepass' && opts?.trpc?.ssr !== false && (opts?.enabled ?? defaultOpts?.enabled) !== false && !queryClient.getQueryCache().find(getArrayQueryKey.getArrayQueryKey(pathAndInput, 'infinite'))) {
|
|
475
|
+
void prefetchInfiniteQuery(pathAndInput, {
|
|
476
|
+
...defaultOpts,
|
|
477
|
+
...opts
|
|
478
|
+
});
|
|
468
479
|
}
|
|
469
|
-
const ssrOpts = useSSRQueryOptionsIfNeeded(pathAndInput, 'infinite',
|
|
480
|
+
const ssrOpts = useSSRQueryOptionsIfNeeded(pathAndInput, 'infinite', {
|
|
481
|
+
...defaultOpts,
|
|
482
|
+
...opts
|
|
483
|
+
});
|
|
470
484
|
// request option should take priority over global
|
|
471
485
|
const shouldAbortOnUnmount = opts?.trpc?.abortOnUnmount ?? abortOnUnmount;
|
|
472
486
|
const hook = reactQuery.useInfiniteQuery({
|
|
@@ -354,10 +354,14 @@ function getClientArgs(pathAndInput, opts) {
|
|
|
354
354
|
throw new Error('Unable to retrieve application context. Did you forget to wrap your App inside `withTRPC` HoC?');
|
|
355
355
|
}
|
|
356
356
|
const { abortOnUnmount , client , ssrState , queryClient , prefetchQuery } = context;
|
|
357
|
-
|
|
357
|
+
const defaultOpts = queryClient.getQueryDefaults(getArrayQueryKey(pathAndInput, 'query'));
|
|
358
|
+
if (typeof window === 'undefined' && ssrState === 'prepass' && opts?.trpc?.ssr !== false && (opts?.enabled ?? defaultOpts?.enabled) !== false && !queryClient.getQueryCache().find(getArrayQueryKey(pathAndInput, 'query'))) {
|
|
358
359
|
void prefetchQuery(pathAndInput, opts);
|
|
359
360
|
}
|
|
360
|
-
const ssrOpts = useSSRQueryOptionsIfNeeded(pathAndInput, 'query',
|
|
361
|
+
const ssrOpts = useSSRQueryOptionsIfNeeded(pathAndInput, 'query', {
|
|
362
|
+
...defaultOpts,
|
|
363
|
+
...opts
|
|
364
|
+
});
|
|
361
365
|
const shouldAbortOnUnmount = opts?.trpc?.abortOnUnmount ?? config?.abortOnUnmount ?? abortOnUnmount;
|
|
362
366
|
const hook = useQuery({
|
|
363
367
|
...ssrOpts,
|
|
@@ -388,6 +392,9 @@ function getClientArgs(pathAndInput, opts) {
|
|
|
388
392
|
context: ReactQueryContext
|
|
389
393
|
});
|
|
390
394
|
const actualPath = Array.isArray(path) ? path[0] : path;
|
|
395
|
+
const defaultOpts = queryClient.getMutationDefaults([
|
|
396
|
+
actualPath.split('.')
|
|
397
|
+
]);
|
|
391
398
|
const hook = useMutation({
|
|
392
399
|
...opts,
|
|
393
400
|
mutationKey: [
|
|
@@ -401,11 +408,11 @@ function getClientArgs(pathAndInput, opts) {
|
|
|
401
408
|
},
|
|
402
409
|
context: ReactQueryContext,
|
|
403
410
|
onSuccess (...args) {
|
|
404
|
-
const originalFn = ()=>opts?.onSuccess?.(...args);
|
|
411
|
+
const originalFn = ()=>opts?.onSuccess?.(...args) ?? defaultOpts?.onSuccess?.(...args);
|
|
405
412
|
return mutationSuccessOverride({
|
|
406
413
|
originalFn,
|
|
407
414
|
queryClient,
|
|
408
|
-
meta: opts?.meta ?? {}
|
|
415
|
+
meta: opts?.meta ?? defaultOpts?.meta ?? {}
|
|
409
416
|
});
|
|
410
417
|
}
|
|
411
418
|
});
|
|
@@ -457,10 +464,17 @@ function getClientArgs(pathAndInput, opts) {
|
|
|
457
464
|
function useInfiniteQuery$1(pathAndInput, opts) {
|
|
458
465
|
const [path, input] = pathAndInput;
|
|
459
466
|
const { client , ssrState , prefetchInfiniteQuery , queryClient , abortOnUnmount , } = useContext();
|
|
460
|
-
|
|
461
|
-
|
|
467
|
+
const defaultOpts = queryClient.getQueryDefaults(getArrayQueryKey(pathAndInput, 'infinite'));
|
|
468
|
+
if (typeof window === 'undefined' && ssrState === 'prepass' && opts?.trpc?.ssr !== false && (opts?.enabled ?? defaultOpts?.enabled) !== false && !queryClient.getQueryCache().find(getArrayQueryKey(pathAndInput, 'infinite'))) {
|
|
469
|
+
void prefetchInfiniteQuery(pathAndInput, {
|
|
470
|
+
...defaultOpts,
|
|
471
|
+
...opts
|
|
472
|
+
});
|
|
462
473
|
}
|
|
463
|
-
const ssrOpts = useSSRQueryOptionsIfNeeded(pathAndInput, 'infinite',
|
|
474
|
+
const ssrOpts = useSSRQueryOptionsIfNeeded(pathAndInput, 'infinite', {
|
|
475
|
+
...defaultOpts,
|
|
476
|
+
...opts
|
|
477
|
+
});
|
|
464
478
|
// request option should take priority over global
|
|
465
479
|
const shouldAbortOnUnmount = opts?.trpc?.abortOnUnmount ?? abortOnUnmount;
|
|
466
480
|
const hook = useInfiniteQuery({
|
|
@@ -1,76 +1,76 @@
|
|
|
1
|
-
import { InfiniteData } from '@tanstack/react-query';
|
|
2
|
-
import { TRPCClientErrorLike } from '@trpc/client';
|
|
3
|
-
import { AnyMutationProcedure, AnyProcedure, AnyQueryProcedure, AnyRouter, AnySubscriptionProcedure, ProcedureRouterRecord, ProtectedIntersection
|
|
4
|
-
import { inferTransformedProcedureOutput, inferTransformedSubscriptionOutput } from '@trpc/server/shared';
|
|
5
|
-
import { QueryKey, QueryType } from './internals/getArrayQueryKey';
|
|
6
|
-
import { TRPCUseQueries } from './internals/useQueries';
|
|
7
|
-
import { CreateReactUtilsProxy } from './shared';
|
|
8
|
-
import { CreateReactQueryHooks } from './shared/hooks/createRootHooks';
|
|
9
|
-
import { CreateClient, DefinedUseTRPCQueryOptions, DefinedUseTRPCQueryResult, TRPCProvider, UseDehydratedState, UseTRPCInfiniteQueryOptions, UseTRPCInfiniteQueryResult, UseTRPCInfiniteQuerySuccessResult, UseTRPCMutationOptions, UseTRPCMutationResult, UseTRPCQueryOptions, UseTRPCQueryResult, UseTRPCQuerySuccessResult, UseTRPCSubscriptionOptions } from './shared/hooks/types';
|
|
10
|
-
import { CreateTRPCReactOptions } from './shared/types';
|
|
11
|
-
/**
|
|
12
|
-
* @internal
|
|
13
|
-
*/
|
|
14
|
-
export interface ProcedureUseQuery<TProcedure extends AnyProcedure, TPath extends string> {
|
|
15
|
-
<TQueryFnData = inferTransformedProcedureOutput<TProcedure>, TData = inferTransformedProcedureOutput<TProcedure>>(input: inferProcedureInput<TProcedure>, opts: DefinedUseTRPCQueryOptions<TPath, inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientErrorLike<TProcedure>>): DefinedUseTRPCQueryResult<TData, TRPCClientErrorLike<TProcedure>>;
|
|
16
|
-
<TQueryFnData = inferTransformedProcedureOutput<TProcedure>, TData = inferTransformedProcedureOutput<TProcedure>>(input: inferProcedureInput<TProcedure>, opts?: UseTRPCQueryOptions<TPath, inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientErrorLike<TProcedure>>): UseTRPCQueryResult<TData, TRPCClientErrorLike<TProcedure>>;
|
|
17
|
-
}
|
|
18
|
-
/**
|
|
19
|
-
* @internal
|
|
20
|
-
*/
|
|
21
|
-
export
|
|
22
|
-
/**
|
|
23
|
-
* Method to extract the query key for a procedure
|
|
24
|
-
* @param type - defaults to `any`
|
|
25
|
-
* @link https://trpc.io/docs/useContext#-the-function-i-want-isnt-here
|
|
26
|
-
* @deprecated - import `getQueryKey` from `@trpc/react-query` instead
|
|
27
|
-
*/
|
|
28
|
-
getQueryKey: (input: inferProcedureInput<TProcedure>, type?: QueryType) => QueryKey;
|
|
29
|
-
useQuery: ProcedureUseQuery<TProcedure, TPath>;
|
|
30
|
-
} & (inferProcedureInput<TProcedure> extends {
|
|
31
|
-
cursor?: any;
|
|
32
|
-
} | void ? {
|
|
33
|
-
useInfiniteQuery: (input: Omit<inferProcedureInput<TProcedure>, 'cursor'>, opts?: UseTRPCInfiniteQueryOptions<TPath, inferProcedureInput<TProcedure>, inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>) => UseTRPCInfiniteQueryResult<inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>;
|
|
34
|
-
} & (TFlags extends 'ExperimentalSuspense' ? {
|
|
35
|
-
useSuspenseInfiniteQuery: (input: Omit<inferProcedureInput<TProcedure>, 'cursor'>, opts?: Omit<UseTRPCInfiniteQueryOptions<TPath, inferProcedureInput<TProcedure>, inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>, 'enabled' | 'suspense'>) => [
|
|
36
|
-
InfiniteData<inferTransformedProcedureOutput<TProcedure>>,
|
|
37
|
-
UseTRPCInfiniteQuerySuccessResult<inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>
|
|
38
|
-
];
|
|
39
|
-
} : object) : object) & (TFlags extends 'ExperimentalSuspense' ? {
|
|
40
|
-
useSuspenseQuery: <TQueryFnData = inferTransformedProcedureOutput<TProcedure>, TData = inferTransformedProcedureOutput<TProcedure>>(input: inferProcedureInput<TProcedure>, opts?: Omit<UseTRPCQueryOptions<TPath, inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientErrorLike<TProcedure>>, 'enabled' | 'suspense'>) => [
|
|
41
|
-
TData,
|
|
42
|
-
UseTRPCQuerySuccessResult<TData, TRPCClientErrorLike<TProcedure>>
|
|
43
|
-
];
|
|
44
|
-
} : object) : TProcedure extends AnyMutationProcedure ? {
|
|
45
|
-
useMutation: <TContext = unknown>(opts?: UseTRPCMutationOptions<inferProcedureInput<TProcedure>, TRPCClientErrorLike<TProcedure>, inferTransformedProcedureOutput<TProcedure>, TContext>) => UseTRPCMutationResult<inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>, inferProcedureInput<TProcedure>, TContext>;
|
|
46
|
-
} : TProcedure extends AnySubscriptionProcedure ? {
|
|
47
|
-
useSubscription: (input: inferProcedureInput<TProcedure>, opts?: UseTRPCSubscriptionOptions<inferTransformedSubscriptionOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>) => void;
|
|
48
|
-
} : never;
|
|
49
|
-
/**
|
|
50
|
-
* @internal
|
|
51
|
-
*/
|
|
52
|
-
export
|
|
53
|
-
[TKey in keyof TProcedures]: TProcedures[TKey] extends AnyRouter ? {
|
|
54
|
-
/**
|
|
55
|
-
* @deprecated - import `getQueryKey` from `@trpc/react-query` instead
|
|
56
|
-
*/
|
|
57
|
-
getQueryKey: () => QueryKey;
|
|
58
|
-
} & DecoratedProcedureRecord<TProcedures[TKey]['_def']['record'], TFlags, `${TPath}${TKey & string}.`> : TProcedures[TKey] extends AnyProcedure ? DecorateProcedure<TProcedures[TKey], TFlags, `${TPath}${TKey & string}`> : never;
|
|
59
|
-
};
|
|
60
|
-
/**
|
|
61
|
-
* @internal
|
|
62
|
-
*/
|
|
63
|
-
export
|
|
64
|
-
useContext(): CreateReactUtilsProxy<TRouter, TSSRContext>;
|
|
65
|
-
Provider: TRPCProvider<TRouter, TSSRContext>;
|
|
66
|
-
createClient: CreateClient<TRouter>;
|
|
67
|
-
useQueries: TRPCUseQueries<TRouter>;
|
|
68
|
-
useDehydratedState: UseDehydratedState<TRouter>;
|
|
69
|
-
};
|
|
70
|
-
export
|
|
71
|
-
/**
|
|
72
|
-
* @internal
|
|
73
|
-
*/
|
|
74
|
-
export declare function createHooksInternalProxy<TRouter extends AnyRouter, TSSRContext = unknown, TFlags = null>(trpc: CreateReactQueryHooks<TRouter, TSSRContext>): ProtectedIntersection<CreateTRPCReactBase<TRouter, TSSRContext>, DecoratedProcedureRecord<TRouter["_def"]["record"], TFlags, "">>;
|
|
75
|
-
export declare function createTRPCReact<TRouter extends AnyRouter, TSSRContext = unknown, TFlags = null>(opts?: CreateTRPCReactOptions<TRouter>): CreateTRPCReact<TRouter, TSSRContext, TFlags>;
|
|
1
|
+
import { InfiniteData } from '@tanstack/react-query';
|
|
2
|
+
import { TRPCClientErrorLike } from '@trpc/client';
|
|
3
|
+
import { AnyMutationProcedure, AnyProcedure, AnyQueryProcedure, AnyRouter, AnySubscriptionProcedure, inferProcedureInput, ProcedureRouterRecord, ProtectedIntersection } from '@trpc/server';
|
|
4
|
+
import { inferTransformedProcedureOutput, inferTransformedSubscriptionOutput } from '@trpc/server/shared';
|
|
5
|
+
import { QueryKey, QueryType } from './internals/getArrayQueryKey';
|
|
6
|
+
import { TRPCUseQueries } from './internals/useQueries';
|
|
7
|
+
import { CreateReactUtilsProxy } from './shared';
|
|
8
|
+
import { CreateReactQueryHooks } from './shared/hooks/createRootHooks';
|
|
9
|
+
import { CreateClient, DefinedUseTRPCQueryOptions, DefinedUseTRPCQueryResult, TRPCProvider, UseDehydratedState, UseTRPCInfiniteQueryOptions, UseTRPCInfiniteQueryResult, UseTRPCInfiniteQuerySuccessResult, UseTRPCMutationOptions, UseTRPCMutationResult, UseTRPCQueryOptions, UseTRPCQueryResult, UseTRPCQuerySuccessResult, UseTRPCSubscriptionOptions } from './shared/hooks/types';
|
|
10
|
+
import { CreateTRPCReactOptions } from './shared/types';
|
|
11
|
+
/**
|
|
12
|
+
* @internal
|
|
13
|
+
*/
|
|
14
|
+
export interface ProcedureUseQuery<TProcedure extends AnyProcedure, TPath extends string> {
|
|
15
|
+
<TQueryFnData = inferTransformedProcedureOutput<TProcedure>, TData = inferTransformedProcedureOutput<TProcedure>>(input: inferProcedureInput<TProcedure>, opts: DefinedUseTRPCQueryOptions<TPath, inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientErrorLike<TProcedure>>): DefinedUseTRPCQueryResult<TData, TRPCClientErrorLike<TProcedure>>;
|
|
16
|
+
<TQueryFnData = inferTransformedProcedureOutput<TProcedure>, TData = inferTransformedProcedureOutput<TProcedure>>(input: inferProcedureInput<TProcedure>, opts?: UseTRPCQueryOptions<TPath, inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientErrorLike<TProcedure>>): UseTRPCQueryResult<TData, TRPCClientErrorLike<TProcedure>>;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @internal
|
|
20
|
+
*/
|
|
21
|
+
export type DecorateProcedure<TProcedure extends AnyProcedure, TFlags, TPath extends string> = TProcedure extends AnyQueryProcedure ? {
|
|
22
|
+
/**
|
|
23
|
+
* Method to extract the query key for a procedure
|
|
24
|
+
* @param type - defaults to `any`
|
|
25
|
+
* @link https://trpc.io/docs/useContext#-the-function-i-want-isnt-here
|
|
26
|
+
* @deprecated - import `getQueryKey` from `@trpc/react-query` instead
|
|
27
|
+
*/
|
|
28
|
+
getQueryKey: (input: inferProcedureInput<TProcedure>, type?: QueryType) => QueryKey;
|
|
29
|
+
useQuery: ProcedureUseQuery<TProcedure, TPath>;
|
|
30
|
+
} & (inferProcedureInput<TProcedure> extends {
|
|
31
|
+
cursor?: any;
|
|
32
|
+
} | void ? {
|
|
33
|
+
useInfiniteQuery: (input: Omit<inferProcedureInput<TProcedure>, 'cursor'>, opts?: UseTRPCInfiniteQueryOptions<TPath, inferProcedureInput<TProcedure>, inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>) => UseTRPCInfiniteQueryResult<inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>;
|
|
34
|
+
} & (TFlags extends 'ExperimentalSuspense' ? {
|
|
35
|
+
useSuspenseInfiniteQuery: (input: Omit<inferProcedureInput<TProcedure>, 'cursor'>, opts?: Omit<UseTRPCInfiniteQueryOptions<TPath, inferProcedureInput<TProcedure>, inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>, 'enabled' | 'suspense'>) => [
|
|
36
|
+
InfiniteData<inferTransformedProcedureOutput<TProcedure>>,
|
|
37
|
+
UseTRPCInfiniteQuerySuccessResult<inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>
|
|
38
|
+
];
|
|
39
|
+
} : object) : object) & (TFlags extends 'ExperimentalSuspense' ? {
|
|
40
|
+
useSuspenseQuery: <TQueryFnData = inferTransformedProcedureOutput<TProcedure>, TData = inferTransformedProcedureOutput<TProcedure>>(input: inferProcedureInput<TProcedure>, opts?: Omit<UseTRPCQueryOptions<TPath, inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientErrorLike<TProcedure>>, 'enabled' | 'suspense'>) => [
|
|
41
|
+
TData,
|
|
42
|
+
UseTRPCQuerySuccessResult<TData, TRPCClientErrorLike<TProcedure>>
|
|
43
|
+
];
|
|
44
|
+
} : object) : TProcedure extends AnyMutationProcedure ? {
|
|
45
|
+
useMutation: <TContext = unknown>(opts?: UseTRPCMutationOptions<inferProcedureInput<TProcedure>, TRPCClientErrorLike<TProcedure>, inferTransformedProcedureOutput<TProcedure>, TContext>) => UseTRPCMutationResult<inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>, inferProcedureInput<TProcedure>, TContext>;
|
|
46
|
+
} : TProcedure extends AnySubscriptionProcedure ? {
|
|
47
|
+
useSubscription: (input: inferProcedureInput<TProcedure>, opts?: UseTRPCSubscriptionOptions<inferTransformedSubscriptionOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>) => void;
|
|
48
|
+
} : never;
|
|
49
|
+
/**
|
|
50
|
+
* @internal
|
|
51
|
+
*/
|
|
52
|
+
export type DecoratedProcedureRecord<TProcedures extends ProcedureRouterRecord, TFlags, TPath extends string = ''> = {
|
|
53
|
+
[TKey in keyof TProcedures]: TProcedures[TKey] extends AnyRouter ? {
|
|
54
|
+
/**
|
|
55
|
+
* @deprecated - import `getQueryKey` from `@trpc/react-query` instead
|
|
56
|
+
*/
|
|
57
|
+
getQueryKey: () => QueryKey;
|
|
58
|
+
} & DecoratedProcedureRecord<TProcedures[TKey]['_def']['record'], TFlags, `${TPath}${TKey & string}.`> : TProcedures[TKey] extends AnyProcedure ? DecorateProcedure<TProcedures[TKey], TFlags, `${TPath}${TKey & string}`> : never;
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* @internal
|
|
62
|
+
*/
|
|
63
|
+
export type CreateTRPCReactBase<TRouter extends AnyRouter, TSSRContext> = {
|
|
64
|
+
useContext(): CreateReactUtilsProxy<TRouter, TSSRContext>;
|
|
65
|
+
Provider: TRPCProvider<TRouter, TSSRContext>;
|
|
66
|
+
createClient: CreateClient<TRouter>;
|
|
67
|
+
useQueries: TRPCUseQueries<TRouter>;
|
|
68
|
+
useDehydratedState: UseDehydratedState<TRouter>;
|
|
69
|
+
};
|
|
70
|
+
export type CreateTRPCReact<TRouter extends AnyRouter, TSSRContext, TFlags> = ProtectedIntersection<CreateTRPCReactBase<TRouter, TSSRContext>, DecoratedProcedureRecord<TRouter['_def']['record'], TFlags>>;
|
|
71
|
+
/**
|
|
72
|
+
* @internal
|
|
73
|
+
*/
|
|
74
|
+
export declare function createHooksInternalProxy<TRouter extends AnyRouter, TSSRContext = unknown, TFlags = null>(trpc: CreateReactQueryHooks<TRouter, TSSRContext>): ProtectedIntersection<CreateTRPCReactBase<TRouter, TSSRContext>, DecoratedProcedureRecord<TRouter["_def"]["record"], TFlags, "">>;
|
|
75
|
+
export declare function createTRPCReact<TRouter extends AnyRouter, TSSRContext = unknown, TFlags = null>(opts?: CreateTRPCReactOptions<TRouter>): CreateTRPCReact<TRouter, TSSRContext, TFlags>;
|
|
76
76
|
//# sourceMappingURL=createTRPCReact.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createTRPCReact.d.ts","sourceRoot":"","sources":["../src/createTRPCReact.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EACL,oBAAoB,EACpB,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,wBAAwB,EACxB,
|
|
1
|
+
{"version":3,"file":"createTRPCReact.d.ts","sourceRoot":"","sources":["../src/createTRPCReact.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EACL,oBAAoB,EACpB,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,cAAc,CAAC;AACtB,OAAO,EAEL,+BAA+B,EAC/B,kCAAkC,EACnC,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAGL,qBAAqB,EACtB,MAAM,UAAU,CAAC;AAClB,OAAO,EAEL,qBAAqB,EACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,YAAY,EACZ,0BAA0B,EAC1B,yBAAyB,EACzB,YAAY,EACZ,kBAAkB,EAClB,2BAA2B,EAC3B,0BAA0B,EAC1B,iCAAiC,EACjC,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,EACnB,kBAAkB,EAClB,yBAAyB,EACzB,0BAA0B,EAC3B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAChC,UAAU,SAAS,YAAY,EAC/B,KAAK,SAAS,MAAM;IAEpB,CACE,YAAY,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAC1D,KAAK,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAEnD,KAAK,EAAE,mBAAmB,CAAC,UAAU,CAAC,EACtC,IAAI,EAAE,0BAA0B,CAC9B,KAAK,EACL,mBAAmB,CAAC,UAAU,CAAC,EAC/B,YAAY,EACZ,KAAK,EACL,mBAAmB,CAAC,UAAU,CAAC,CAChC,GACA,yBAAyB,CAAC,KAAK,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAErE,CACE,YAAY,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAC1D,KAAK,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAEnD,KAAK,EAAE,mBAAmB,CAAC,UAAU,CAAC,EACtC,IAAI,CAAC,EAAE,mBAAmB,CACxB,KAAK,EACL,mBAAmB,CAAC,UAAU,CAAC,EAC/B,YAAY,EACZ,KAAK,EACL,mBAAmB,CAAC,UAAU,CAAC,CAChC,GACA,kBAAkB,CAAC,KAAK,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;CAC/D;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAC3B,UAAU,SAAS,YAAY,EAC/B,MAAM,EACN,KAAK,SAAS,MAAM,IAClB,UAAU,SAAS,iBAAiB,GACpC;IACE;;;;;OAKG;IACH,WAAW,EAAE,CACX,KAAK,EAAE,mBAAmB,CAAC,UAAU,CAAC,EACtC,IAAI,CAAC,EAAE,SAAS,KACb,QAAQ,CAAC;IACd,QAAQ,EAAE,iBAAiB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;CAChD,GAAG,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS;IAAE,MAAM,CAAC,EAAE,GAAG,CAAA;CAAE,GAAG,IAAI,GAChE;IACE,gBAAgB,EAAE,CAChB,KAAK,EAAE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,EACtD,IAAI,CAAC,EAAE,2BAA2B,CAChC,KAAK,EACL,mBAAmB,CAAC,UAAU,CAAC,EAC/B,+BAA+B,CAAC,UAAU,CAAC,EAC3C,mBAAmB,CAAC,UAAU,CAAC,CAChC,KACE,0BAA0B,CAC7B,+BAA+B,CAAC,UAAU,CAAC,EAC3C,mBAAmB,CAAC,UAAU,CAAC,CAChC,CAAC;CACH,GAAG,CAAC,MAAM,SAAS,sBAAsB,GACtC;IACE,wBAAwB,EAAE,CACxB,KAAK,EAAE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,EACtD,IAAI,CAAC,EAAE,IAAI,CACT,2BAA2B,CACzB,KAAK,EACL,mBAAmB,CAAC,UAAU,CAAC,EAC/B,+BAA+B,CAAC,UAAU,CAAC,EAC3C,mBAAmB,CAAC,UAAU,CAAC,CAChC,EACD,SAAS,GAAG,UAAU,CACvB,KACE;QACH,YAAY,CAAC,+BAA+B,CAAC,UAAU,CAAC,CAAC;QACzD,iCAAiC,CAC/B,+BAA+B,CAAC,UAAU,CAAC,EAC3C,mBAAmB,CAAC,UAAU,CAAC,CAChC;KACF,CAAC;CACH,GACD,MAAM,CAAC,GACX,MAAM,CAAC,GACT,CAAC,MAAM,SAAS,sBAAsB,GAClC;IACE,gBAAgB,EAAE,CAChB,YAAY,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAC1D,KAAK,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAEnD,KAAK,EAAE,mBAAmB,CAAC,UAAU,CAAC,EACtC,IAAI,CAAC,EAAE,IAAI,CACT,mBAAmB,CACjB,KAAK,EACL,mBAAmB,CAAC,UAAU,CAAC,EAC/B,YAAY,EACZ,KAAK,EACL,mBAAmB,CAAC,UAAU,CAAC,CAChC,EACD,SAAS,GAAG,UAAU,CACvB,KACE;QACH,KAAK;QACL,yBAAyB,CAAC,KAAK,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;KAClE,CAAC;CACH,GACD,MAAM,CAAC,GACb,UAAU,SAAS,oBAAoB,GACvC;IACE,WAAW,EAAE,CAAC,QAAQ,GAAG,OAAO,EAC9B,IAAI,CAAC,EAAE,sBAAsB,CAC3B,mBAAmB,CAAC,UAAU,CAAC,EAC/B,mBAAmB,CAAC,UAAU,CAAC,EAC/B,+BAA+B,CAAC,UAAU,CAAC,EAC3C,QAAQ,CACT,KACE,qBAAqB,CACxB,+BAA+B,CAAC,UAAU,CAAC,EAC3C,mBAAmB,CAAC,UAAU,CAAC,EAC/B,mBAAmB,CAAC,UAAU,CAAC,EAC/B,QAAQ,CACT,CAAC;CACH,GACD,UAAU,SAAS,wBAAwB,GAC3C;IACE,eAAe,EAAE,CACf,KAAK,EAAE,mBAAmB,CAAC,UAAU,CAAC,EACtC,IAAI,CAAC,EAAE,0BAA0B,CAC/B,kCAAkC,CAAC,UAAU,CAAC,EAC9C,mBAAmB,CAAC,UAAU,CAAC,CAChC,KACE,IAAI,CAAC;CACX,GACD,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAClC,WAAW,SAAS,qBAAqB,EACzC,MAAM,EACN,KAAK,SAAS,MAAM,GAAG,EAAE,IACvB;KACD,IAAI,IAAI,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,SAAS,SAAS,GAC5D;QACE;;WAEG;QACH,WAAW,EAAE,MAAM,QAAQ,CAAC;KAC7B,GAAG,wBAAwB,CAC1B,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,EACnC,MAAM,EACN,GAAG,KAAK,GAAG,IAAI,GAAG,MAAM,GAAG,CAC5B,GACD,WAAW,CAAC,IAAI,CAAC,SAAS,YAAY,GACtC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,IAAI,GAAG,MAAM,EAAE,CAAC,GACxE,KAAK;CACV,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,OAAO,SAAS,SAAS,EAAE,WAAW,IAAI;IACxE,UAAU,IAAI,qBAAqB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC1D,QAAQ,EAAE,YAAY,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC7C,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IACpC,UAAU,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IACpC,kBAAkB,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,eAAe,CACzB,OAAO,SAAS,SAAS,EACzB,WAAW,EACX,MAAM,IACJ,qBAAqB,CACvB,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,EACzC,wBAAwB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAC5D,CAAC;AAEF;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,SAAS,SAAS,EACzB,WAAW,GAAG,OAAO,EACrB,MAAM,GAAG,IAAI,EACb,IAAI,EAAE,qBAAqB,CAAC,OAAO,EAAE,WAAW,CAAC,qIAoBlD;AAED,wBAAgB,eAAe,CAC7B,OAAO,SAAS,SAAS,EACzB,WAAW,GAAG,OAAO,EACrB,MAAM,GAAG,IAAI,EAEb,IAAI,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC,GACrC,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,CAK/C"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export * from '@trpc/client';
|
|
2
|
-
export { getQueryKey } from './internals/getQueryKey';
|
|
3
|
-
export { createTRPCReact, type CreateTRPCReact } from './createTRPCReact';
|
|
4
|
-
export { createReactQueryHooks } from './interop';
|
|
5
|
-
export type { inferReactQueryProcedureOptions } from './utils/inferReactQueryProcedure';
|
|
1
|
+
export * from '@trpc/client';
|
|
2
|
+
export { getQueryKey } from './internals/getQueryKey';
|
|
3
|
+
export { createTRPCReact, type CreateTRPCReact } from './createTRPCReact';
|
|
4
|
+
export { createReactQueryHooks } from './interop';
|
|
5
|
+
export type { inferReactQueryProcedureOptions } from './utils/inferReactQueryProcedure';
|
|
6
6
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
5
|
var client = require('@trpc/client');
|
|
6
|
-
var createHooksInternal = require('./createHooksInternal-
|
|
6
|
+
var createHooksInternal = require('./createHooksInternal-466f5861.js');
|
|
7
7
|
var shared = require('@trpc/server/shared');
|
|
8
8
|
var React = require('react');
|
|
9
9
|
require('@tanstack/react-query');
|
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export * from '@trpc/client';
|
|
2
|
-
import { c as createHooksInternal, a as createReactQueryUtilsProxy, b as createReactProxyDecoration } from './createHooksInternal-
|
|
3
|
-
export { g as getQueryKey } from './createHooksInternal-
|
|
2
|
+
import { c as createHooksInternal, a as createReactQueryUtilsProxy, b as createReactProxyDecoration } from './createHooksInternal-a6562110.mjs';
|
|
3
|
+
export { g as getQueryKey } from './createHooksInternal-a6562110.mjs';
|
|
4
4
|
import { createFlatProxy } from '@trpc/server/shared';
|
|
5
5
|
import { useMemo } from 'react';
|
|
6
6
|
import '@tanstack/react-query';
|