@trpc/react-query 10.29.1 → 10.30.0

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.
Files changed (4) hide show
  1. package/dist/createTRPCReact.d.ts +29 -10
  2. package/dist/createTRPCReact.d.ts.map +1 -1
  3. package/package.json +6 -6
  4. package/src/createTRPCReact.tsx +65 -51
package/dist/createTRPCReact.d.ts CHANGED
@@ -12,38 +12,54 @@ import { CreateTRPCReactOptions } from './shared/types';
12
12
  * @internal
13
13
  */
14
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>>;
15
+ <TQueryFnData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>, TData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>>(input: inferProcedureInput<TProcedure>, opts: DefinedUseTRPCQueryOptions<TPath, inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientErrorLike<TProcedure>>): DefinedUseTRPCQueryResult<TData, TRPCClientErrorLike<TProcedure>>;
16
+ <TQueryFnData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>, TData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>>(input: inferProcedureInput<TProcedure>, opts?: UseTRPCQueryOptions<TPath, inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientErrorLike<TProcedure>>): UseTRPCQueryResult<TData, TRPCClientErrorLike<TProcedure>>;
17
17
  }
18
18
  /**
19
19
  * @internal
20
20
  */
21
- export type DecorateProcedure<TProcedure extends AnyProcedure, TFlags, TPath extends string> = TProcedure extends AnyQueryProcedure ? {
21
+ export type DecorateProcedure<TProcedure extends AnyProcedure, _TFlags, TPath extends string> = TProcedure extends AnyQueryProcedure ? {
22
22
  /**
23
23
  * Method to extract the query key for a procedure
24
24
  * @param type - defaults to `any`
25
- * @link https://trpc.io/docs/useContext#-the-function-i-want-isnt-here
25
+ * @see https://trpc.io/docs/client/react/getQueryKey
26
26
  * @deprecated - import `getQueryKey` from `@trpc/react-query` instead
27
27
  */
28
28
  getQueryKey: (input: inferProcedureInput<TProcedure>, type?: QueryType) => QueryKey;
29
+ /**
30
+ * @see https://trpc.io/docs/client/react/useQuery
31
+ */
29
32
  useQuery: ProcedureUseQuery<TProcedure, TPath>;
33
+ /**
34
+ * @see https://trpc.io/docs/client/react/suspense#usesuspensequery
35
+ */
36
+ useSuspenseQuery: <TQueryFnData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>, TData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>>(input: inferProcedureInput<TProcedure>, opts?: Omit<UseTRPCQueryOptions<TPath, inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientErrorLike<TProcedure>>, 'enabled' | 'suspense'>) => [
37
+ TData,
38
+ UseTRPCQuerySuccessResult<TData, TRPCClientErrorLike<TProcedure>>
39
+ ];
30
40
  } & (inferProcedureInput<TProcedure> extends {
31
41
  cursor?: any;
32
42
  } | void ? {
43
+ /**
44
+ * @see https://trpc.io/docs/client/react/suspense#useinfinitesuspensequery
45
+ */
33
46
  useInfiniteQuery: (input: Omit<inferProcedureInput<TProcedure>, 'cursor'>, opts?: UseTRPCInfiniteQueryOptions<TPath, inferProcedureInput<TProcedure>, inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>) => UseTRPCInfiniteQueryResult<inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>;
34
- } & (TFlags extends 'ExperimentalSuspense' ? {
47
+ /**
48
+ * @see https://trpc.io/docs/client/react/suspense
49
+ */
35
50
  useSuspenseInfiniteQuery: (input: Omit<inferProcedureInput<TProcedure>, 'cursor'>, opts?: Omit<UseTRPCInfiniteQueryOptions<TPath, inferProcedureInput<TProcedure>, inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>, 'enabled' | 'suspense'>) => [
36
51
  InfiniteData<inferTransformedProcedureOutput<TProcedure>>,
37
52
  UseTRPCInfiniteQuerySuccessResult<inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>
38
53
  ];
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
54
  } : object) : TProcedure extends AnyMutationProcedure ? {
55
+ /**
56
+ * @see https://trpc.io/docs/client/react/useMutation
57
+ */
45
58
  useMutation: <TContext = unknown>(opts?: UseTRPCMutationOptions<inferProcedureInput<TProcedure>, TRPCClientErrorLike<TProcedure>, inferTransformedProcedureOutput<TProcedure>, TContext>) => UseTRPCMutationResult<inferTransformedProcedureOutput<TProcedure>, TRPCClientErrorLike<TProcedure>, inferProcedureInput<TProcedure>, TContext>;
46
59
  } : TProcedure extends AnySubscriptionProcedure ? {
60
+ /**
61
+ * @see https://trpc.io/docs/subscriptions
62
+ */
47
63
  useSubscription: (input: inferProcedureInput<TProcedure>, opts?: UseTRPCSubscriptionOptions<inferTransformedSubscriptionOutput<TProcedure>, TRPCClientErrorLike<TProcedure>>) => void;
48
64
  } : never;
49
65
  /**
@@ -61,6 +77,9 @@ export type DecoratedProcedureRecord<TProcedures extends ProcedureRouterRecord,
61
77
  * @internal
62
78
  */
63
79
  export type CreateTRPCReactBase<TRouter extends AnyRouter, TSSRContext> = {
80
+ /**
81
+ * @see https://trpc.io/docs/client/react/useContext
82
+ */
64
83
  useContext(): CreateReactUtilsProxy<TRouter, TSSRContext>;
65
84
  Provider: TRPCProvider<TRouter, TSSRContext>;
66
85
  createClient: CreateClient<TRouter>;
package/dist/createTRPCReact.d.ts.map CHANGED
@@ -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,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"}
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,SAAS,+BAA+B,CAAC,UAAU,CAAC,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAC9G,KAAK,SAAS,+BAA+B,CAAC,UAAU,CAAC,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAEvG,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,SAAS,+BAA+B,CAAC,UAAU,CAAC,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAC9G,KAAK,SAAS,+BAA+B,CAAC,UAAU,CAAC,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAEvG,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,OAAO,EACP,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;;OAEG;IACH,QAAQ,EAAE,iBAAiB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC/C;;OAEG;IACH,gBAAgB,EAAE,CAChB,YAAY,SAAS,+BAA+B,CAAC,UAAU,CAAC,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAC9G,KAAK,SAAS,+BAA+B,CAAC,UAAU,CAAC,GAAG,+BAA+B,CAAC,UAAU,CAAC,EAEvG,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,GAAG,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS;IAAE,MAAM,CAAC,EAAE,GAAG,CAAA;CAAE,GAAG,IAAI,GAChE;IACE;;OAEG;IACH,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;IACF;;OAEG;IACH,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,UAAU,SAAS,oBAAoB,GACvC;IACE;;OAEG;IACH,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;;OAEG;IACH,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;;OAEG;IACH,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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trpc/react-query",
3
- "version": "10.29.1",
3
+ "version": "10.30.0",
4
4
  "description": "The tRPC React library",
5
5
  "author": "KATT",
6
6
  "license": "MIT",
@@ -64,15 +64,15 @@
64
64
  },
65
65
  "peerDependencies": {
66
66
  "@tanstack/react-query": "^4.18.0",
67
- "@trpc/client": "10.29.1",
68
- "@trpc/server": "10.29.1",
67
+ "@trpc/client": "10.30.0",
68
+ "@trpc/server": "10.30.0",
69
69
  "react": ">=16.8.0",
70
70
  "react-dom": ">=16.8.0"
71
71
  },
72
72
  "devDependencies": {
73
73
  "@tanstack/react-query": "^4.18.0",
74
- "@trpc/client": "10.29.1",
75
- "@trpc/server": "10.29.1",
74
+ "@trpc/client": "10.30.0",
75
+ "@trpc/server": "10.30.0",
76
76
  "@types/express": "^4.17.17",
77
77
  "@types/node": "^18.16.16",
78
78
  "@types/react": "^18.2.8",
@@ -91,5 +91,5 @@
91
91
  "funding": [
92
92
  "https://trpc.io/sponsor"
93
93
  ],
94
- "gitHead": "3dbc7b7e9fff233f89627c21450ba89754bc3e46"
94
+ "gitHead": "a841051a4deb9428acee54e98798e8c2402a0a35"
95
95
  }
package/src/createTRPCReact.tsx CHANGED
@@ -53,8 +53,8 @@ export interface ProcedureUseQuery<
53
53
  TPath extends string,
54
54
  > {
55
55
  <
56
- TQueryFnData = inferTransformedProcedureOutput<TProcedure>,
57
- TData = inferTransformedProcedureOutput<TProcedure>,
56
+ TQueryFnData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>,
57
+ TData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>,
58
58
  >(
59
59
  input: inferProcedureInput<TProcedure>,
60
60
  opts: DefinedUseTRPCQueryOptions<
@@ -67,8 +67,8 @@ export interface ProcedureUseQuery<
67
67
  ): DefinedUseTRPCQueryResult<TData, TRPCClientErrorLike<TProcedure>>;
68
68
 
69
69
  <
70
- TQueryFnData = inferTransformedProcedureOutput<TProcedure>,
71
- TData = inferTransformedProcedureOutput<TProcedure>,
70
+ TQueryFnData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>,
71
+ TData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>,
72
72
  >(
73
73
  input: inferProcedureInput<TProcedure>,
74
74
  opts?: UseTRPCQueryOptions<
@@ -86,23 +86,51 @@ export interface ProcedureUseQuery<
86
86
  */
87
87
  export type DecorateProcedure<
88
88
  TProcedure extends AnyProcedure,
89
- TFlags,
89
+ _TFlags,
90
90
  TPath extends string,
91
91
  > = TProcedure extends AnyQueryProcedure
92
92
  ? {
93
93
  /**
94
94
  * Method to extract the query key for a procedure
95
95
  * @param type - defaults to `any`
96
- * @link https://trpc.io/docs/useContext#-the-function-i-want-isnt-here
96
+ * @see https://trpc.io/docs/client/react/getQueryKey
97
97
  * @deprecated - import `getQueryKey` from `@trpc/react-query` instead
98
98
  */
99
99
  getQueryKey: (
100
100
  input: inferProcedureInput<TProcedure>,
101
101
  type?: QueryType,
102
102
  ) => QueryKey;
103
+ /**
104
+ * @see https://trpc.io/docs/client/react/useQuery
105
+ */
103
106
  useQuery: ProcedureUseQuery<TProcedure, TPath>;
107
+ /**
108
+ * @see https://trpc.io/docs/client/react/suspense#usesuspensequery
109
+ */
110
+ useSuspenseQuery: <
111
+ TQueryFnData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>,
112
+ TData extends inferTransformedProcedureOutput<TProcedure> = inferTransformedProcedureOutput<TProcedure>,
113
+ >(
114
+ input: inferProcedureInput<TProcedure>,
115
+ opts?: Omit<
116
+ UseTRPCQueryOptions<
117
+ TPath,
118
+ inferProcedureInput<TProcedure>,
119
+ TQueryFnData,
120
+ TData,
121
+ TRPCClientErrorLike<TProcedure>
122
+ >,
123
+ 'enabled' | 'suspense'
124
+ >,
125
+ ) => [
126
+ TData,
127
+ UseTRPCQuerySuccessResult<TData, TRPCClientErrorLike<TProcedure>>,
128
+ ];
104
129
  } & (inferProcedureInput<TProcedure> extends { cursor?: any } | void
105
130
  ? {
131
+ /**
132
+ * @see https://trpc.io/docs/client/react/suspense#useinfinitesuspensequery
133
+ */
106
134
  useInfiniteQuery: (
107
135
  input: Omit<inferProcedureInput<TProcedure>, 'cursor'>,
108
136
  opts?: UseTRPCInfiniteQueryOptions<
@@ -115,54 +143,34 @@ export type DecorateProcedure<
115
143
  inferTransformedProcedureOutput<TProcedure>,
116
144
  TRPCClientErrorLike<TProcedure>
117
145
  >;
118
- } & (TFlags extends 'ExperimentalSuspense'
119
- ? {
120
- useSuspenseInfiniteQuery: (
121
- input: Omit<inferProcedureInput<TProcedure>, 'cursor'>,
122
- opts?: Omit<
123
- UseTRPCInfiniteQueryOptions<
124
- TPath,
125
- inferProcedureInput<TProcedure>,
126
- inferTransformedProcedureOutput<TProcedure>,
127
- TRPCClientErrorLike<TProcedure>
128
- >,
129
- 'enabled' | 'suspense'
130
- >,
131
- ) => [
132
- InfiniteData<inferTransformedProcedureOutput<TProcedure>>,
133
- UseTRPCInfiniteQuerySuccessResult<
134
- inferTransformedProcedureOutput<TProcedure>,
135
- TRPCClientErrorLike<TProcedure>
136
- >,
137
- ];
138
- }
139
- : object)
140
- : object) &
141
- (TFlags extends 'ExperimentalSuspense'
142
- ? {
143
- useSuspenseQuery: <
144
- TQueryFnData = inferTransformedProcedureOutput<TProcedure>,
145
- TData = inferTransformedProcedureOutput<TProcedure>,
146
- >(
147
- input: inferProcedureInput<TProcedure>,
148
- opts?: Omit<
149
- UseTRPCQueryOptions<
150
- TPath,
151
- inferProcedureInput<TProcedure>,
152
- TQueryFnData,
153
- TData,
154
- TRPCClientErrorLike<TProcedure>
155
- >,
156
- 'enabled' | 'suspense'
146
+ /**
147
+ * @see https://trpc.io/docs/client/react/suspense
148
+ */
149
+ useSuspenseInfiniteQuery: (
150
+ input: Omit<inferProcedureInput<TProcedure>, 'cursor'>,
151
+ opts?: Omit<
152
+ UseTRPCInfiniteQueryOptions<
153
+ TPath,
154
+ inferProcedureInput<TProcedure>,
155
+ inferTransformedProcedureOutput<TProcedure>,
156
+ TRPCClientErrorLike<TProcedure>
157
157
  >,
158
- ) => [
159
- TData,
160
- UseTRPCQuerySuccessResult<TData, TRPCClientErrorLike<TProcedure>>,
161
- ];
162
- }
163
- : object)
158
+ 'enabled' | 'suspense'
159
+ >,
160
+ ) => [
161
+ InfiniteData<inferTransformedProcedureOutput<TProcedure>>,
162
+ UseTRPCInfiniteQuerySuccessResult<
163
+ inferTransformedProcedureOutput<TProcedure>,
164
+ TRPCClientErrorLike<TProcedure>
165
+ >,
166
+ ];
167
+ }
168
+ : object)
164
169
  : TProcedure extends AnyMutationProcedure
165
170
  ? {
171
+ /**
172
+ * @see https://trpc.io/docs/client/react/useMutation
173
+ */
166
174
  useMutation: <TContext = unknown>(
167
175
  opts?: UseTRPCMutationOptions<
168
176
  inferProcedureInput<TProcedure>,
@@ -179,6 +187,9 @@ export type DecorateProcedure<
179
187
  }
180
188
  : TProcedure extends AnySubscriptionProcedure
181
189
  ? {
190
+ /**
191
+ * @see https://trpc.io/docs/subscriptions
192
+ */
182
193
  useSubscription: (
183
194
  input: inferProcedureInput<TProcedure>,
184
195
  opts?: UseTRPCSubscriptionOptions<
@@ -217,6 +228,9 @@ export type DecoratedProcedureRecord<
217
228
  * @internal
218
229
  */
219
230
  export type CreateTRPCReactBase<TRouter extends AnyRouter, TSSRContext> = {
231
+ /**
232
+ * @see https://trpc.io/docs/client/react/useContext
233
+ */
220
234
  useContext(): CreateReactUtilsProxy<TRouter, TSSRContext>;
221
235
  Provider: TRPCProvider<TRouter, TSSRContext>;
222
236
  createClient: CreateClient<TRouter>;