@trpc/tanstack-react-query 0.0.0-alpha.5 → 10.8.0-alpha-tmp-02-12-response-types-idea.853

package/dist/internals/types.d.ts

@@ -1,13 +1,39 @@
+import type { InfiniteData } from '@tanstack/react-query';
 import type { TRPCRequestOptions } from '@trpc/client';
+/**
+ * Turn a set of optional properties into required
+ * @internal
+ */
+export type WithRequired<TObj, TKey extends keyof TObj> = TObj & {
+    [P in TKey]-?: TObj[P];
+};
+/**
+ * @internal
+ */
 export type ResolverDef = {
     input: any;
     output: any;
     transformer: boolean;
     errorShape: any;
 };
-export type ExtractCursorType<TInput> = TInput extends {
+/**
+ * @remark `void` is here due to https://github.com/trpc/trpc/pull/4374
+ */
+type CursorInput = {
     cursor?: any;
-} ? TInput['cursor'] : unknown;
+};
+export type OptionalCursorInput = CursorInput | void;
+/**
+ * @internal
+ */
+export type ExtractCursorType<TInput> = TInput extends CursorInput ? TInput['cursor'] : unknown;
+/**
+ * @internal
+ */
+export type TRPCInfiniteData<TInput, TOutput> = InfiniteData<TOutput, NonNullable<ExtractCursorType<TInput>> | null>;
+/**
+ * @public
+ */
 export interface TRPCReactRequestOptions extends Omit<TRPCRequestOptions, 'signal'> {
     /**
      * Opt out of SSR for this query by passing `ssr: false`
@@ -18,18 +44,30 @@ export interface TRPCReactRequestOptions extends Omit<TRPCRequestOptions, 'signa
      */
     abortOnUnmount?: boolean;
 }
+/**
+ * @public
+ */
 export interface TRPCQueryBaseOptions {
     /**
      * tRPC-related options
      */
     trpc?: TRPCReactRequestOptions;
 }
+/**
+ * @public
+ */
 export interface TRPCQueryOptionsResult {
     trpc: {
         path: string;
     };
 }
+/**
+ * @public
+ */
 export type QueryType = 'any' | 'infinite' | 'query';
+/**
+ * @public
+ */
 export type TRPCQueryKey = [
     readonly string[],
     {
@@ -37,5 +75,9 @@ export type TRPCQueryKey = [
         type?: Exclude<QueryType, 'any'>;
     }?
 ];
+/**
+ * @public
+ */
 export type TRPCMutationKey = [readonly string[]];
+export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/internals/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/internals/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEvD,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,EAAE,GAAG,CAAC;IACZ,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,GAAG,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,MAAM,IAAI,MAAM,SAAS;IAAE,MAAM,CAAC,EAAE,GAAG,CAAA;CAAE,GACnE,MAAM,CAAC,QAAQ,CAAC,GAChB,OAAO,CAAC;AAEZ,MAAM,WAAW,uBAEf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;IAC1C;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,uBAAuB,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,UAAU,GAAG,OAAO,CAAC;AAErD,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,MAAM,EAAE;IACjB;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;KAAE,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,CAAC,SAAS,MAAM,EAAE,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/internals/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,EAAE,IAAI,SAAS,MAAM,IAAI,IAAI,IAAI,GAAG;KAC9D,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,EAAE,GAAG,CAAC;IACZ,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,GAAG,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,KAAK,WAAW,GAAG;IAAE,MAAM,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC;AACpC,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,IAAI,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,MAAM,IAAI,MAAM,SAAS,WAAW,GAC9D,MAAM,CAAC,QAAQ,CAAC,GAChB,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,MAAM,EAAE,OAAO,IAAI,YAAY,CAC1D,OAAO,EACP,WAAW,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAC9C,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,uBAEf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;IAC1C;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,uBAAuB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,UAAU,GAAG,OAAO,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,MAAM,EAAE;IACjB;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;KAAE,CAAC;CACvD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,SAAS,MAAM,EAAE,CAAC,CAAC"}

package/dist/internals/utils.d.ts

@@ -21,8 +21,16 @@ export declare function buildQueryFromAsyncIterable(asyncIterable: AsyncIterable
  * To allow easy interactions with groups of related queries, such as
  * invalidating all queries of a router, we use an array as the path when
  * storing in tanstack query.
- **/
-export declare function getQueryKeyInternal(path: readonly string[], input: unknown, type: QueryType): TRPCQueryKey;
+ *
+ * @internal
+ */
+export declare function getQueryKeyInternal(path: readonly string[], input?: unknown, type?: QueryType): TRPCQueryKey;
+/**
+ * @internal
+ */
 export declare function getMutationKeyInternal(path: readonly string[]): TRPCMutationKey;
+/**
+ * @internal
+ */
 export declare function unwrapLazyArg<T>(valueOrLazy: T | (() => T)): T;
 //# sourceMappingURL=utils.d.ts.map

package/dist/internals/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/internals/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpE,OAAO,KAAK,EACV,SAAS,EACT,eAAe,EACf,YAAY,EACZ,sBAAsB,EACvB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE;IAC7C,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CACzB,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAMjC;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EACpC,QAAQ,EAAE,YAAY,EACtB,IAAI,EAAE,QAAQ,EACd,cAAc,CAAC,EAAE;IACf,SAAS,EAAE,GAAG,CAAC;IACf,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;CACnC,mCAYF;AAED;;GAEG;AACH,wBAAsB,2BAA2B,CAC/C,aAAa,EAAE,aAAa,CAAC,OAAO,CAAC,EACrC,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,YAAY,sBAsBvB;AAED;;;;IAII;AACJ,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,SAAS,GACd,YAAY,CA0Cd;AAED,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,SAAS,MAAM,EAAE,GACtB,eAAe,CAKjB;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAE9D"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/internals/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpE,OAAO,KAAK,EACV,SAAS,EACT,eAAe,EACf,YAAY,EACZ,sBAAsB,EACvB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE;IAC7C,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CACzB,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAMjC;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EACpC,QAAQ,EAAE,YAAY,EACtB,IAAI,EAAE,QAAQ,EACd,cAAc,CAAC,EAAE;IACf,SAAS,EAAE,GAAG,CAAC;IACf,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;CACnC,mCAcF;AAED;;GAEG;AACH,wBAAsB,2BAA2B,CAC/C,aAAa,EAAE,aAAa,CAAC,OAAO,CAAC,EACrC,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,YAAY,sBAsBvB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,KAAK,CAAC,EAAE,OAAO,EACf,IAAI,CAAC,EAAE,SAAS,GACf,YAAY,CA2Cd;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,SAAS,MAAM,EAAE,GACtB,eAAe,CAKjB;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAE9D"}

package/dist/internals/utils.js

@@ -19,7 +19,7 @@ var unstableCoreDoNotImport = require('@trpc/server/unstable-core-do-not-import'
     if (infiniteParams) {
         input = {
             ...input ?? {},
-            ...infiniteParams.pageParam ? {
+            ...infiniteParams.pageParam !== undefined ? {
                 cursor: infiniteParams.pageParam
             } : {},
             direction: infiniteParams.direction
@@ -57,7 +57,9 @@ var unstableCoreDoNotImport = require('@trpc/server/unstable-core-do-not-import'
  * To allow easy interactions with groups of related queries, such as
  * invalidating all queries of a router, we use an array as the path when
  * storing in tanstack query.
- **/ function getQueryKeyInternal(path, input, type) {
+ *
+ * @internal
+ */ function getQueryKeyInternal(path, input, type) {
     // Construct a query key that is easy to destructure and flexible for
     // partial selecting etc.
     // https://github.com/trpc/trpc/issues/3128
@@ -93,14 +95,18 @@ var unstableCoreDoNotImport = require('@trpc/server/unstable-core-do-not-import'
         }
     ];
 }
-function getMutationKeyInternal(path) {
+/**
+ * @internal
+ */ function getMutationKeyInternal(path) {
     // some parts of the path may be dot-separated, split them up
     const splitPath = path.flatMap((part)=>part.split('.'));
     return splitPath.length ? [
         splitPath
     ] : [];
 }
-function unwrapLazyArg(valueOrLazy) {
+/**
+ * @internal
+ */ function unwrapLazyArg(valueOrLazy) {
     return unstableCoreDoNotImport.isFunction(valueOrLazy) ? valueOrLazy() : valueOrLazy;
 }
 

package/dist/internals/utils.mjs

@@ -17,7 +17,7 @@ import { isObject, isFunction } from '@trpc/server/unstable-core-do-not-import';
     if (infiniteParams) {
         input = {
             ...input ?? {},
-            ...infiniteParams.pageParam ? {
+            ...infiniteParams.pageParam !== undefined ? {
                 cursor: infiniteParams.pageParam
             } : {},
             direction: infiniteParams.direction
@@ -55,7 +55,9 @@ import { isObject, isFunction } from '@trpc/server/unstable-core-do-not-import';
  * To allow easy interactions with groups of related queries, such as
  * invalidating all queries of a router, we use an array as the path when
  * storing in tanstack query.
- **/ function getQueryKeyInternal(path, input, type) {
+ *
+ * @internal
+ */ function getQueryKeyInternal(path, input, type) {
     // Construct a query key that is easy to destructure and flexible for
     // partial selecting etc.
     // https://github.com/trpc/trpc/issues/3128
@@ -91,14 +93,18 @@ import { isObject, isFunction } from '@trpc/server/unstable-core-do-not-import';
         }
     ];
 }
-function getMutationKeyInternal(path) {
+/**
+ * @internal
+ */ function getMutationKeyInternal(path) {
     // some parts of the path may be dot-separated, split them up
     const splitPath = path.flatMap((part)=>part.split('.'));
     return splitPath.length ? [
         splitPath
     ] : [];
 }
-function unwrapLazyArg(valueOrLazy) {
+/**
+ * @internal
+ */ function unwrapLazyArg(valueOrLazy) {
     return isFunction(valueOrLazy) ? valueOrLazy() : valueOrLazy;
 }
 

package/package.json

@@ -1,18 +1,26 @@
 {
   "name": "@trpc/tanstack-react-query",
-  "version": "0.0.0-alpha.5",
+  "version": "10.8.0-alpha-tmp-02-12-response-types-idea.853+be416f215",
   "description": "TanStack React Query Integration for tRPC",
   "author": "juliusmarminge",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
-  "homepage": "https://trpc.io/docs/client/tanstack-react-query/introduction",
+  "homepage": "https://trpc.io/docs/client/tanstack-react-query/setup",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/trpc/trpc.git",
     "directory": "packages/tanstack-react-query"
   },
+  "scripts": {
+    "build": "rollup --config rollup.config.ts --configPlugin rollup-plugin-swc3",
+    "dev": "pnpm build --watch",
+    "codegen-entrypoints": "tsx entrypoints.script.ts",
+    "lint": "eslint --cache src",
+    "test-run:tsc": "tsc --noEmit --pretty",
+    "ts-watch": "tsc --watch"
+  },
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -40,30 +48,30 @@
     }
   },
   "peerDependencies": {
-    "@tanstack/react-query": "^5.62.8",
-    "@trpc/client": "10.45.1",
-    "@trpc/server": "^10.45.1",
+    "@tanstack/react-query": "^5.67.1",
+    "@trpc/client": "10.8.0-alpha-tmp-02-12-response-types-idea.853+be416f215",
+    "@trpc/server": "10.8.0-alpha-tmp-02-12-response-types-idea.853+be416f215",
     "react": ">=18.2.0",
     "react-dom": ">=18.2.0",
     "typescript": ">=5.7.2"
   },
   "devDependencies": {
-    "@tanstack/react-query": "^5.66.0",
-    "@trpc/client": "10.45.1",
-    "@trpc/server": "^10.45.1",
-    "@types/node": "^20.10.0",
-    "@types/react": "^18.3.1",
-    "eslint": "^8.57.0",
+    "@tanstack/react-query": "^5.67.1",
+    "@trpc/client": "10.8.0-alpha-tmp-02-12-response-types-idea.853+be416f215",
+    "@trpc/server": "10.8.0-alpha-tmp-02-12-response-types-idea.853+be416f215",
+    "@types/node": "^22.13.5",
+    "@types/react": "^19.0.0",
+    "eslint": "^9.21.0",
     "event-source-polyfill": "^1.0.31",
     "konn": "^0.7.0",
     "react": "^19.0.0",
-    "react-dom": "^18.3.1",
-    "rollup": "^4.9.5",
-    "tsx": "^4.0.0",
-    "typescript": "^5.6.2",
-    "vitest": "^2.0.4",
+    "react-dom": "^19.0.0",
+    "rollup": "^4.34.8",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.6",
     "ws": "^8.0.0",
-    "zod": "^3.0.0"
+    "zod": "^3.24.2"
   },
   "publishConfig": {
     "access": "public"
@@ -71,12 +79,5 @@
   "funding": [
     "https://trpc.io/sponsor"
   ],
-  "scripts": {
-    "build": "rollup --config rollup.config.ts --configPlugin rollup-plugin-swc3",
-    "dev": "pnpm build --watch",
-    "codegen-entrypoints": "tsx entrypoints.script.ts",
-    "lint": "eslint --cache src",
-    "test-run:tsc": "tsc --noEmit --pretty",
-    "ts-watch": "tsc --watch"
-  }
-}
+  "gitHead": "be416f215b4b891c4f6382535345ec397a02ae03"
+}

package/src/index.ts

@@ -1,11 +1,11 @@
 export { createTRPCContext } from './internals/Context';
 export type {
   TRPCOptionsProxy,
-  InferInput,
-  InferOutput,
+  inferInput,
+  inferOutput,
   DecorateMutationProcedure,
   DecorateProcedure,
-  DecorateQueryKeyable,
+  DecorateRouterKeyable,
   DecorateQueryProcedure,
   DecorateSubscriptionProcedure,
 } from './internals/createOptionsProxy';
@@ -23,3 +23,4 @@ export type {
 } from './internals/subscriptionOptions';
 export { createTRPCOptionsProxy } from './internals/createOptionsProxy';
 export { useSubscription } from './internals/subscriptionOptions';
+export type * from './internals/types';

package/src/internals/Context.tsx

@@ -1,13 +1,30 @@
-import { type QueryClient } from '@tanstack/react-query';
-import { type CreateTRPCClient } from '@trpc/client';
-import type { AnyRouter } from '@trpc/server/unstable-core-do-not-import';
+import type { QueryClient } from '@tanstack/react-query';
+import type { TRPCClient } from '@trpc/client';
+import type { AnyTRPCRouter } from '@trpc/server';
 import * as React from 'react';
-import {
-  createTRPCOptionsProxy,
-  type TRPCOptionsProxy,
-} from './createOptionsProxy';
+import type { TRPCOptionsProxy } from './createOptionsProxy';
+import { createTRPCOptionsProxy } from './createOptionsProxy';
 
-export function createTRPCContext<TRouter extends AnyRouter>() {
+export interface CreateTRPCContextResult<TRouter extends AnyTRPCRouter> {
+  TRPCProvider: React.FC<{
+    children: React.ReactNode;
+    queryClient: QueryClient;
+    trpcClient: TRPCClient<TRouter>;
+  }>;
+  useTRPC: () => TRPCOptionsProxy<TRouter>;
+  useTRPCClient: () => TRPCClient<TRouter>;
+}
+/**
+ * Create a set of type-safe provider-consumers
+ *
+ * @see https://trpc.io/docs/client/tanstack-react-query/setup#3a-setup-the-trpc-context-provider
+ */
+export function createTRPCContext<
+  TRouter extends AnyTRPCRouter,
+>(): CreateTRPCContextResult<TRouter> {
+  const TRPCClientContext = React.createContext<TRPCClient<TRouter> | null>(
+    null,
+  );
   const TRPCContext = React.createContext<TRPCOptionsProxy<TRouter> | null>(
     null,
   );
@@ -16,7 +33,7 @@ export function createTRPCContext<TRouter extends AnyRouter>() {
     props: Readonly<{
       children: React.ReactNode;
       queryClient: QueryClient;
-      trpcClient: CreateTRPCClient<TRouter>;
+      trpcClient: TRPCClient<TRouter>;
     }>,
   ) {
     const value = React.useMemo(
@@ -28,9 +45,11 @@ export function createTRPCContext<TRouter extends AnyRouter>() {
       [props.trpcClient, props.queryClient],
     );
     return (
-      <TRPCContext.Provider value={value}>
-        {props.children}
-      </TRPCContext.Provider>
+      <TRPCClientContext.Provider value={props.trpcClient}>
+        <TRPCContext.Provider value={value}>
+          {props.children}
+        </TRPCContext.Provider>
+      </TRPCClientContext.Provider>
     );
   }
 
@@ -42,5 +61,15 @@ export function createTRPCContext<TRouter extends AnyRouter>() {
     return utils;
   }
 
-  return { TRPCProvider, useTRPC };
+  function useTRPCClient() {
+    const client = React.useContext(TRPCClientContext);
+    if (!client) {
+      throw new Error(
+        'useTRPCClient() can only be used inside of a <TRPCProvider>',
+      );
+    }
+    return client;
+  }
+
+  return { TRPCProvider, useTRPC, useTRPCClient };
 }