@orpc/tanstack-query 2.0.0-beta.18 → 2.0.0-beta.19

package/README.md

@@ -49,11 +49,14 @@ You can read the documentation [here](https://orpc.dev).
 **Framework & ecosystem integrations**
 
 - [@orpc/next](https://www.npmjs.com/package/@orpc/next): Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
+- [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk): Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools.
 - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
+- [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada): Integrate with [Pinia Colada](https://pinia-colada.esm.dev/).
 - [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
 - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
 - [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).
 - [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare): Adapters for [Cloudflare's RateLimit and Durable Objects](https://developers.cloudflare.com/workers/).
+- [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc): Reuse existing [tRPC](https://trpc.io/) routers within oRPC.
 
 **Observability**
 
@@ -105,11 +108,10 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
    <td align="center"><a href="https://github.com/valerii15298?ref=orpc" target="_blank" rel="noopener" title="Valerii Petryniak"><img src="https://avatars.githubusercontent.com/u/44531564?u=88ac74d9bacd20401518441907acad21063cd397&amp;v=4" width="139" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
    <td align="center"><a href="https://github.com/letstri?ref=orpc" target="_blank" rel="noopener" title="Valerii Strilets"><img src="https://avatars.githubusercontent.com/u/13253748?u=c7b10399ccc8f8081e24db94ec32cd9858e86ac3&amp;v=4" width="139" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
    <td align="center"><a href="https://github.com/K-Mistele?ref=orpc" target="_blank" rel="noopener" title="Kyle Mistele"><img src="https://avatars.githubusercontent.com/u/18430555?u=3afebeb81de666e35aaac3ed46f14159d7603ffb&amp;v=4" width="139" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
-   <td align="center"><a href="https://github.com/andrewpeters9?ref=orpc" target="_blank" rel="noopener" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="139" alt="Andrew Peters"/><br />Andrew Peters</a></td>
    <td align="center"><a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&amp;v=4" width="139" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
+   <td align="center"><a href="https://github.com/christ12938?ref=orpc" target="_blank" rel="noopener" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="139" alt="christ12938"/><br />christ12938</a></td>
   </tr>
   <tr>
-   <td align="center"><a href="https://github.com/christ12938?ref=orpc" target="_blank" rel="noopener" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="139" alt="christ12938"/><br />christ12938</a></td>
    <td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&amp;v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
    <td align="center"><a href="https://github.com/itigoore01?ref=orpc" target="_blank" rel="noopener" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&amp;v=4" width="139" alt="shota"/><br />shota</a></td>
   </tr>
@@ -169,6 +171,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   <a href="https://github.com/nelsonlaidev?ref=orpc" target="_blank" rel="noopener" title="Nelson Lai"><img src="https://avatars.githubusercontent.com/u/75498339?u=2fc0e0b95dd184c5ffb744df977cb15a18b60672&amp;v=4" width="32" height="32" alt="Nelson Lai" /></a>
   <a href="https://github.com/nguyenlc1993?ref=orpc" target="_blank" rel="noopener" title="Lê Cao Nguyên"><img src="https://avatars.githubusercontent.com/u/13871971?u=83c8b69d9e35b589c4e1f066cc113b1d9461386f&amp;v=4" width="32" height="32" alt="Lê Cao Nguyên" /></a>
   <a href="https://github.com/wobsoriano?ref=orpc" target="_blank" rel="noopener" title="Robert Soriano"><img src="https://avatars.githubusercontent.com/u/13049130?u=6d72104182e7c9ed25934815313fb69107332111&amp;v=4" width="32" height="32" alt="Robert Soriano" /></a>
+  <a href="https://github.com/andrewpeters9?ref=orpc" target="_blank" rel="noopener" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="32" height="32" alt="Andrew Peters" /></a>
   <a href="https://github.com/SKostyukovich?ref=orpc" target="_blank" rel="noopener" title="SKostyukovich"><img src="https://avatars.githubusercontent.com/u/10700067?v=4" width="32" height="32" alt="SKostyukovich" /></a>
   <a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="noopener" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&amp;v=4" width="32" height="32" alt="Peter Adam" /></a>
   <a href="https://github.com/FabworksHQ?ref=orpc" target="_blank" rel="noopener" title="Fabworks"><img src="https://avatars.githubusercontent.com/u/160179500?v=4" width="32" height="32" alt="Fabworks" /></a>

package/dist/index.d.mts

@@ -1,6 +1,6 @@
-import { ClientContext, Client, AnyNestedClient, InferClientContext, InferClientError, ThrowableError } from '@orpc/client';
-import { AnySchema, ErrorMap, ProcedureContract, InferSchemaInput, InferSchemaOutput, ORPCErrorFromErrorMap, RouterContractClient, RouterContract, ContractCaller } from '@orpc/contract';
-import { JsonifiedValue, JsonifiedClientError, JsonifiedClient } from '@orpc/openapi';
+import { ClientContext, Client, AnyNestedClient, InferClientContext, InferClientError } from '@orpc/client';
+import { RouterContract, RouterContractClient, ContractClientFactory } from '@orpc/contract';
+import { JsonifiedClient } from '@orpc/openapi';
 import { Promisable, PartialDeep, Interceptor, PromiseWithError, MaybeOptionalOptions, OrderablePlugin, Public } from '@orpc/shared';
 import { QueryKey, QueryFunctionContext, QueryFunction, SkipToken, QueryObserverOptions, InfiniteQueryObserverOptions, MutationObserverOptions, DataTag, InfiniteData, MutationFunctionContext } from '@tanstack/query-core';
 
@@ -33,12 +33,6 @@ declare function serializableStreamedQuery<TQueryFnData = unknown, TQueryKey ext
 type InferStreamedQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
 type InferLiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
 type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
-type OperationKeyOptions<TType extends OperationType, TInput> = {
-    type?: TType;
-    input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
-    fnOptions?: TType extends 'streamed' ? SerializableStreamedQueryOptions : never;
-};
-type OperationKey<TType extends OperationType, TInput> = [path: string[], options: OperationKeyOptions<TType, TInput>];
 declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
 interface OperationContext {
     [OPERATION_CONTEXT_SYMBOL]?: {
@@ -108,6 +102,31 @@ type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TE
 }) & MutationOptionsOut<TInput, TOutput, TError, TMutationContext>;
 type MutationOptionsOut<TInput, TOutput, TError, TMutationContext> = MutationObserverOptions<TOutput, TError, TInput, TMutationContext>;
 
+interface OperationKeyPrefixOptions {
+    /**
+     * Prepended as the first element of the key when present.
+     * Use this to avoid key conflicts when multiple router utils share the same client.
+     */
+    prefix?: string;
+}
+type OperationKeyOptions<TType extends OperationType, TInput> = OperationKeyPrefixOptions & {
+    type?: TType;
+    input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
+    fnOptions?: TType extends 'streamed' ? SerializableStreamedQueryOptions : never;
+};
+type OperationKey<TType extends OperationType, TInput> = [path: string[], options: Omit<OperationKeyOptions<TType, TInput>, 'prefix'>] | [prefix: string, path: string[], options: Omit<OperationKeyOptions<TType, TInput>, 'prefix'>];
+declare function generateOperationKey<TType extends OperationType, TInput>(path: string[], options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
+
+declare class SharedUtils<TInput> {
+    protected readonly path: string[];
+    protected readonly options: OperationKeyPrefixOptions;
+    constructor(path: string[], options: OperationKeyPrefixOptions);
+    /**
+     * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
+     */
+    key<TType extends OperationType>(options?: Omit<OperationKeyOptions<TType, TInput>, 'prefix'>): OperationKey<TType, TInput>;
+}
+
 interface ProcedureUtilsQueryInterceptorOptions<TClientContext extends ClientContext, TInput> {
     path: string[];
     context: TClientContext & OperationContext;
@@ -135,7 +154,7 @@ type ProcedureUtilsMutationInterceptor<TClientContext extends ClientContext, TIn
  * or a function that receives per-call options and returns overridden this.options.
  */
 type ProcedureUtilsModifier<T extends object> = Partial<T> | ((options: T) => T);
-interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TOutput, TError> {
+interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TOutput, TError> extends OperationKeyPrefixOptions {
     /**
      * Key options modifier for .queryKey and .queryOptions
      * Can be partial options or a function that receives per-call options and returns override this.options.
@@ -207,9 +226,8 @@ interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TO
      */
     mutationOptions?: ProcedureUtilsModifier<MutationOptionsIn<TClientContext, TInput, TOutput, TError, unknown>>;
 }
-declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
-    private readonly path;
-    private readonly options;
+declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> extends SharedUtils<TInput> {
+    protected readonly options: ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>;
     /**
      * Calling corresponding procedure client
      */
@@ -297,24 +315,17 @@ interface RouterUtilsPlugin<T extends AnyNestedClient> extends OrderablePlugin {
     initProcedureOptions?(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
 }
 
-declare class SharedRouterUtils<TInput> {
-    private readonly path;
-    constructor(path: string[]);
-    /**
-     * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
-     */
-    key<TType extends OperationType>(options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
-}
-type RouterUtils<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Public<ProcedureUtils<UClientContext, UInput, UOutput, UError>> & Public<SharedRouterUtils<UInput>> : {
+type RouterUtils<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Public<ProcedureUtils<UClientContext, UInput, UOutput, UError>> : {
     [K in keyof T]: T[K] extends AnyNestedClient ? RouterUtils<T[K]> : never;
-} & Public<SharedRouterUtils<unknown>>;
+} & Public<SharedUtils<unknown>>;
 type RouterUtilsScoped<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtilsOptions<UClientContext, UInput, UOutput, UError> : {
     [K in keyof T]?: T[K] extends AnyNestedClient ? RouterUtilsScoped<T[K]> : never;
 };
-interface RouterUtilsOptions<T extends AnyNestedClient> {
+interface RouterUtilsOptions<T extends AnyNestedClient> extends OperationKeyPrefixOptions {
     /**
-     * Base path for all query keys. Use this to avoid conflicts when mounting
-     * multiple router utils instances.
+     * Base path for all query keys.
+     *
+     * @internal
      */
     path?: string[] | undefined;
     /**
@@ -356,19 +367,17 @@ interface RouterUtilsOptions<T extends AnyNestedClient> {
 declare function createRouterUtils<T extends AnyNestedClient>(client: T, options?: NoInfer<RouterUtilsOptions<T>>): RouterUtils<T>;
 
 interface ContractUtilsFactory<TClientContext extends ClientContext> {
-    <TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap>(procedure: ProcedureContract<TInputSchema, TOutputSchema, TErrorMap>): Public<SharedRouterUtils<InferSchemaInput<TInputSchema>>> & Public<ProcedureUtils<TClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ORPCErrorFromErrorMap<TErrorMap> | ThrowableError>>;
+    <T extends RouterContract>(contract: T): RouterUtils<RouterContractClient<T, TClientContext>>;
 }
-interface ContractUtilsFactoryOptions<TClientContext extends ClientContext> extends RouterUtilsOptions<RouterContractClient<RouterContract, TClientContext>> {
+interface ContractUtilsFactoryOptions<TClientContext extends ClientContext> extends Omit<RouterUtilsOptions<RouterContractClient<RouterContract, TClientContext>>, 'path'> {
 }
-declare function createContractUtilsFactory<TClientContext extends ClientContext>(caller: ContractCaller<TClientContext>, options: ContractUtilsFactoryOptions<TClientContext>): ContractUtilsFactory<TClientContext>;
+declare function createContractUtilsFactory<TClientContext extends ClientContext>(clientFactory: ContractClientFactory<TClientContext>, options: ContractUtilsFactoryOptions<TClientContext>): ContractUtilsFactory<TClientContext>;
 interface ContractJsonifiedUtilsFactory<TClientContext extends ClientContext> {
-    <TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap>(procedure: ProcedureContract<TInputSchema, TOutputSchema, TErrorMap>): SharedRouterUtils<InferSchemaInput<TInputSchema>> & ProcedureUtils<TClientContext, InferSchemaInput<TInputSchema>, JsonifiedValue<InferSchemaOutput<TOutputSchema>>, JsonifiedClientError<ORPCErrorFromErrorMap<TErrorMap> | ThrowableError>>;
+    <T extends RouterContract>(contract: T): RouterUtils<JsonifiedClient<RouterContractClient<T, TClientContext>>>;
 }
-interface ContractJsonifiedUtilsFactoryOptions<TClientContext extends ClientContext> extends RouterUtilsOptions<JsonifiedClient<RouterContractClient<RouterContract, TClientContext>>> {
+interface ContractJsonifiedUtilsFactoryOptions<TClientContext extends ClientContext> extends Omit<RouterUtilsOptions<JsonifiedClient<RouterContractClient<RouterContract, TClientContext>>>, 'path'> {
 }
-declare function createContractJsonifiedUtilsFactory<TClientContext extends ClientContext>(caller: ContractCaller<TClientContext>, options: ContractJsonifiedUtilsFactoryOptions<TClientContext>): ContractJsonifiedUtilsFactory<TClientContext>;
-
-declare function generateOperationKey<TType extends OperationType, TInput>(path: string[], state?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
+declare function createContractJsonifiedUtilsFactory<TClientContext extends ClientContext>(clientFactory: ContractClientFactory<TClientContext>, options: ContractJsonifiedUtilsFactoryOptions<TClientContext>): ContractJsonifiedUtilsFactory<TClientContext>;
 
-export { OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedRouterUtils, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey, serializableStreamedQuery };
-export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyOptions, OperationType, ProcedureUtilsInfiniteInterceptor, ProcedureUtilsInfiniteInterceptorOptions, ProcedureUtilsLiveInterceptor, ProcedureUtilsLiveInterceptorOptions, ProcedureUtilsModifier, ProcedureUtilsMutationInterceptor, ProcedureUtilsMutationInterceptorOptions, ProcedureUtilsOptions, ProcedureUtilsQueryInterceptor, ProcedureUtilsQueryInterceptorOptions, ProcedureUtilsStreamedInterceptor, ProcedureUtilsStreamedInterceptorOptions, QueryKeyOptions, QueryOptionsIn, QueryOptionsOut, RouterUtils, RouterUtilsOptions, RouterUtilsScoped, SerializableStreamedQueryOptions, StreamedKeyOptions, StreamedOptionsIn, StreamedOptionsOut, OperationContext as TanstackQueryOperationContext };
+export { OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey, serializableStreamedQuery };
+export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyOptions, OperationKeyPrefixOptions, OperationType, ProcedureUtilsInfiniteInterceptor, ProcedureUtilsInfiniteInterceptorOptions, ProcedureUtilsLiveInterceptor, ProcedureUtilsLiveInterceptorOptions, ProcedureUtilsModifier, ProcedureUtilsMutationInterceptor, ProcedureUtilsMutationInterceptorOptions, ProcedureUtilsOptions, ProcedureUtilsQueryInterceptor, ProcedureUtilsQueryInterceptorOptions, ProcedureUtilsStreamedInterceptor, ProcedureUtilsStreamedInterceptorOptions, QueryKeyOptions, QueryOptionsIn, QueryOptionsOut, RouterUtils, RouterUtilsOptions, RouterUtilsScoped, SerializableStreamedQueryOptions, StreamedKeyOptions, StreamedOptionsIn, StreamedOptionsOut, OperationContext as TanstackQueryOperationContext };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { ClientContext, Client, AnyNestedClient, InferClientContext, InferClientError, ThrowableError } from '@orpc/client';
-import { AnySchema, ErrorMap, ProcedureContract, InferSchemaInput, InferSchemaOutput, ORPCErrorFromErrorMap, RouterContractClient, RouterContract, ContractCaller } from '@orpc/contract';
-import { JsonifiedValue, JsonifiedClientError, JsonifiedClient } from '@orpc/openapi';
+import { ClientContext, Client, AnyNestedClient, InferClientContext, InferClientError } from '@orpc/client';
+import { RouterContract, RouterContractClient, ContractClientFactory } from '@orpc/contract';
+import { JsonifiedClient } from '@orpc/openapi';
 import { Promisable, PartialDeep, Interceptor, PromiseWithError, MaybeOptionalOptions, OrderablePlugin, Public } from '@orpc/shared';
 import { QueryKey, QueryFunctionContext, QueryFunction, SkipToken, QueryObserverOptions, InfiniteQueryObserverOptions, MutationObserverOptions, DataTag, InfiniteData, MutationFunctionContext } from '@tanstack/query-core';
 
@@ -33,12 +33,6 @@ declare function serializableStreamedQuery<TQueryFnData = unknown, TQueryKey ext
 type InferStreamedQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
 type InferLiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
 type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
-type OperationKeyOptions<TType extends OperationType, TInput> = {
-    type?: TType;
-    input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
-    fnOptions?: TType extends 'streamed' ? SerializableStreamedQueryOptions : never;
-};
-type OperationKey<TType extends OperationType, TInput> = [path: string[], options: OperationKeyOptions<TType, TInput>];
 declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
 interface OperationContext {
     [OPERATION_CONTEXT_SYMBOL]?: {
@@ -108,6 +102,31 @@ type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TE
 }) & MutationOptionsOut<TInput, TOutput, TError, TMutationContext>;
 type MutationOptionsOut<TInput, TOutput, TError, TMutationContext> = MutationObserverOptions<TOutput, TError, TInput, TMutationContext>;
 
+interface OperationKeyPrefixOptions {
+    /**
+     * Prepended as the first element of the key when present.
+     * Use this to avoid key conflicts when multiple router utils share the same client.
+     */
+    prefix?: string;
+}
+type OperationKeyOptions<TType extends OperationType, TInput> = OperationKeyPrefixOptions & {
+    type?: TType;
+    input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
+    fnOptions?: TType extends 'streamed' ? SerializableStreamedQueryOptions : never;
+};
+type OperationKey<TType extends OperationType, TInput> = [path: string[], options: Omit<OperationKeyOptions<TType, TInput>, 'prefix'>] | [prefix: string, path: string[], options: Omit<OperationKeyOptions<TType, TInput>, 'prefix'>];
+declare function generateOperationKey<TType extends OperationType, TInput>(path: string[], options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
+
+declare class SharedUtils<TInput> {
+    protected readonly path: string[];
+    protected readonly options: OperationKeyPrefixOptions;
+    constructor(path: string[], options: OperationKeyPrefixOptions);
+    /**
+     * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
+     */
+    key<TType extends OperationType>(options?: Omit<OperationKeyOptions<TType, TInput>, 'prefix'>): OperationKey<TType, TInput>;
+}
+
 interface ProcedureUtilsQueryInterceptorOptions<TClientContext extends ClientContext, TInput> {
     path: string[];
     context: TClientContext & OperationContext;
@@ -135,7 +154,7 @@ type ProcedureUtilsMutationInterceptor<TClientContext extends ClientContext, TIn
  * or a function that receives per-call options and returns overridden this.options.
  */
 type ProcedureUtilsModifier<T extends object> = Partial<T> | ((options: T) => T);
-interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TOutput, TError> {
+interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TOutput, TError> extends OperationKeyPrefixOptions {
     /**
      * Key options modifier for .queryKey and .queryOptions
      * Can be partial options or a function that receives per-call options and returns override this.options.
@@ -207,9 +226,8 @@ interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TO
      */
     mutationOptions?: ProcedureUtilsModifier<MutationOptionsIn<TClientContext, TInput, TOutput, TError, unknown>>;
 }
-declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
-    private readonly path;
-    private readonly options;
+declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> extends SharedUtils<TInput> {
+    protected readonly options: ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>;
     /**
      * Calling corresponding procedure client
      */
@@ -297,24 +315,17 @@ interface RouterUtilsPlugin<T extends AnyNestedClient> extends OrderablePlugin {
     initProcedureOptions?(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
 }
 
-declare class SharedRouterUtils<TInput> {
-    private readonly path;
-    constructor(path: string[]);
-    /**
-     * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
-     */
-    key<TType extends OperationType>(options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
-}
-type RouterUtils<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Public<ProcedureUtils<UClientContext, UInput, UOutput, UError>> & Public<SharedRouterUtils<UInput>> : {
+type RouterUtils<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Public<ProcedureUtils<UClientContext, UInput, UOutput, UError>> : {
     [K in keyof T]: T[K] extends AnyNestedClient ? RouterUtils<T[K]> : never;
-} & Public<SharedRouterUtils<unknown>>;
+} & Public<SharedUtils<unknown>>;
 type RouterUtilsScoped<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtilsOptions<UClientContext, UInput, UOutput, UError> : {
     [K in keyof T]?: T[K] extends AnyNestedClient ? RouterUtilsScoped<T[K]> : never;
 };
-interface RouterUtilsOptions<T extends AnyNestedClient> {
+interface RouterUtilsOptions<T extends AnyNestedClient> extends OperationKeyPrefixOptions {
     /**
-     * Base path for all query keys. Use this to avoid conflicts when mounting
-     * multiple router utils instances.
+     * Base path for all query keys.
+     *
+     * @internal
      */
     path?: string[] | undefined;
     /**
@@ -356,19 +367,17 @@ interface RouterUtilsOptions<T extends AnyNestedClient> {
 declare function createRouterUtils<T extends AnyNestedClient>(client: T, options?: NoInfer<RouterUtilsOptions<T>>): RouterUtils<T>;
 
 interface ContractUtilsFactory<TClientContext extends ClientContext> {
-    <TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap>(procedure: ProcedureContract<TInputSchema, TOutputSchema, TErrorMap>): Public<SharedRouterUtils<InferSchemaInput<TInputSchema>>> & Public<ProcedureUtils<TClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ORPCErrorFromErrorMap<TErrorMap> | ThrowableError>>;
+    <T extends RouterContract>(contract: T): RouterUtils<RouterContractClient<T, TClientContext>>;
 }
-interface ContractUtilsFactoryOptions<TClientContext extends ClientContext> extends RouterUtilsOptions<RouterContractClient<RouterContract, TClientContext>> {
+interface ContractUtilsFactoryOptions<TClientContext extends ClientContext> extends Omit<RouterUtilsOptions<RouterContractClient<RouterContract, TClientContext>>, 'path'> {
 }
-declare function createContractUtilsFactory<TClientContext extends ClientContext>(caller: ContractCaller<TClientContext>, options: ContractUtilsFactoryOptions<TClientContext>): ContractUtilsFactory<TClientContext>;
+declare function createContractUtilsFactory<TClientContext extends ClientContext>(clientFactory: ContractClientFactory<TClientContext>, options: ContractUtilsFactoryOptions<TClientContext>): ContractUtilsFactory<TClientContext>;
 interface ContractJsonifiedUtilsFactory<TClientContext extends ClientContext> {
-    <TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap>(procedure: ProcedureContract<TInputSchema, TOutputSchema, TErrorMap>): SharedRouterUtils<InferSchemaInput<TInputSchema>> & ProcedureUtils<TClientContext, InferSchemaInput<TInputSchema>, JsonifiedValue<InferSchemaOutput<TOutputSchema>>, JsonifiedClientError<ORPCErrorFromErrorMap<TErrorMap> | ThrowableError>>;
+    <T extends RouterContract>(contract: T): RouterUtils<JsonifiedClient<RouterContractClient<T, TClientContext>>>;
 }
-interface ContractJsonifiedUtilsFactoryOptions<TClientContext extends ClientContext> extends RouterUtilsOptions<JsonifiedClient<RouterContractClient<RouterContract, TClientContext>>> {
+interface ContractJsonifiedUtilsFactoryOptions<TClientContext extends ClientContext> extends Omit<RouterUtilsOptions<JsonifiedClient<RouterContractClient<RouterContract, TClientContext>>>, 'path'> {
 }
-declare function createContractJsonifiedUtilsFactory<TClientContext extends ClientContext>(caller: ContractCaller<TClientContext>, options: ContractJsonifiedUtilsFactoryOptions<TClientContext>): ContractJsonifiedUtilsFactory<TClientContext>;
-
-declare function generateOperationKey<TType extends OperationType, TInput>(path: string[], state?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
+declare function createContractJsonifiedUtilsFactory<TClientContext extends ClientContext>(clientFactory: ContractClientFactory<TClientContext>, options: ContractJsonifiedUtilsFactoryOptions<TClientContext>): ContractJsonifiedUtilsFactory<TClientContext>;
 
-export { OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedRouterUtils, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey, serializableStreamedQuery };
-export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyOptions, OperationType, ProcedureUtilsInfiniteInterceptor, ProcedureUtilsInfiniteInterceptorOptions, ProcedureUtilsLiveInterceptor, ProcedureUtilsLiveInterceptorOptions, ProcedureUtilsModifier, ProcedureUtilsMutationInterceptor, ProcedureUtilsMutationInterceptorOptions, ProcedureUtilsOptions, ProcedureUtilsQueryInterceptor, ProcedureUtilsQueryInterceptorOptions, ProcedureUtilsStreamedInterceptor, ProcedureUtilsStreamedInterceptorOptions, QueryKeyOptions, QueryOptionsIn, QueryOptionsOut, RouterUtils, RouterUtilsOptions, RouterUtilsScoped, SerializableStreamedQueryOptions, StreamedKeyOptions, StreamedOptionsIn, StreamedOptionsOut, OperationContext as TanstackQueryOperationContext };
+export { OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey, serializableStreamedQuery };
+export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyOptions, OperationKeyPrefixOptions, OperationType, ProcedureUtilsInfiniteInterceptor, ProcedureUtilsInfiniteInterceptorOptions, ProcedureUtilsLiveInterceptor, ProcedureUtilsLiveInterceptorOptions, ProcedureUtilsModifier, ProcedureUtilsMutationInterceptor, ProcedureUtilsMutationInterceptorOptions, ProcedureUtilsOptions, ProcedureUtilsQueryInterceptor, ProcedureUtilsQueryInterceptorOptions, ProcedureUtilsStreamedInterceptor, ProcedureUtilsStreamedInterceptorOptions, QueryKeyOptions, QueryOptionsIn, QueryOptionsOut, RouterUtils, RouterUtilsOptions, RouterUtilsScoped, SerializableStreamedQueryOptions, StreamedKeyOptions, StreamedOptionsIn, StreamedOptionsOut, OperationContext as TanstackQueryOperationContext };

package/dist/index.mjs

@@ -1,16 +1,8 @@
-import { getPathMeta } from '@orpc/contract';
+import { resolveBasePathMeta } from '@orpc/contract';
 import { sortPlugins, stringifyJSON, resolveMaybeOptionalOptions, intercept, toArray, isAsyncIteratorObject, bindMethods, getOrBind, get, isTypescriptObject } from '@orpc/shared';
 import { RECURSIVE_CLIENT_UNWRAP_KEYS } from '@orpc/client';
 import { skipToken } from '@tanstack/query-core';
 
-function generateOperationKey(path, state = {}) {
-  return [path, {
-    ...state.input !== void 0 ? { input: state.input } : {},
-    ...state.type !== void 0 ? { type: state.type } : {},
-    ...state.fnOptions !== void 0 ? { fnOptions: state.fnOptions } : {}
-  }];
-}
-
 class CompositeRouterUtilsPlugin {
   constructor(plugins = []) {
     this.plugins = plugins;
@@ -35,6 +27,18 @@ class CompositeRouterUtilsPlugin {
   }
 }
 
+function generateOperationKey(path, options = {}) {
+  return [
+    ...options.prefix !== void 0 ? [options.prefix] : [],
+    path,
+    {
+      ...options.input !== void 0 ? { input: options.input } : {},
+      ...options.type !== void 0 ? { type: options.type } : {},
+      ...options.fnOptions !== void 0 ? { fnOptions: options.fnOptions } : {}
+    }
+  ];
+}
+
 function liveQuery(queryFn) {
   return async (context) => {
     const stream = await queryFn(context);
@@ -53,6 +57,19 @@ function liveQuery(queryFn) {
   };
 }
 
+class SharedUtils {
+  constructor(path, options) {
+    this.path = path;
+    this.options = options;
+  }
+  /**
+   * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
+   */
+  key(options = {}) {
+    return generateOperationKey(this.path, { ...options, prefix: this.options.prefix });
+  }
+}
+
 function serializableStreamedQuery(queryFn, { refetchMode = "reset", maxChunks = Number.POSITIVE_INFINITY } = {}) {
   return async (context) => {
     const query = context.client.getQueryCache().find({ queryKey: context.queryKey, exact: true });
@@ -111,16 +128,15 @@ function limitArraySize(items, maxSize) {
 
 const OPERATION_CONTEXT_SYMBOL = Symbol.for("ORPC_TANSTACK_QUERY_OPERATION_CONTEXT");
 
-class ProcedureUtils {
-  constructor(path, client, options = {}) {
-    this.path = path;
-    this.options = options;
-    this.call = client;
-  }
+class ProcedureUtils extends SharedUtils {
   /**
    * Calling corresponding procedure client
    */
   call;
+  constructor(path, client, options = {}) {
+    super(path, options);
+    this.call = client;
+  }
   /**
    * Generate a **full matching** key for [Query Options](https://orpc.dev/docs/integrations/tanstack-query#query-options).
    */
@@ -131,7 +147,7 @@ class ProcedureUtils {
     } else if (this.options.queryKey) {
       optionsIn = { ...this.options.queryKey, ...optionsIn };
     }
-    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { type: "query", input: optionsIn.input });
+    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { prefix: this.options.prefix, type: "query", input: optionsIn.input });
     return queryKey;
   }
   /**
@@ -187,7 +203,7 @@ class ProcedureUtils {
     } else if (this.options.streamedKey) {
       optionsIn = { ...this.options.streamedKey, ...optionsIn };
     }
-    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { type: "streamed", input: optionsIn.input, fnOptions: optionsIn.queryFnOptions });
+    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { prefix: this.options.prefix, type: "streamed", input: optionsIn.input, fnOptions: optionsIn.queryFnOptions });
     return queryKey;
   }
   /**
@@ -254,7 +270,7 @@ class ProcedureUtils {
     } else if (this.options.liveKey) {
       optionsIn = { ...this.options.liveKey, ...optionsIn };
     }
-    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { type: "live", input: optionsIn.input });
+    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { prefix: this.options.prefix, type: "live", input: optionsIn.input });
     return queryKey;
   }
   /**
@@ -321,6 +337,7 @@ class ProcedureUtils {
       optionsIn = { ...this.options.infiniteKey, ...optionsIn };
     }
     const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, {
+      prefix: this.options.prefix,
       type: "infinite",
       input: optionsIn.input === skipToken ? skipToken : optionsIn.input(optionsIn.initialPageParam)
     });
@@ -377,7 +394,7 @@ class ProcedureUtils {
     } else if (this.options.mutationKey) {
       optionsIn = { ...this.options.mutationKey, ...optionsIn };
     }
-    const mutationKey = optionsIn.mutationKey ?? generateOperationKey(this.path, { type: "mutation" });
+    const mutationKey = optionsIn.mutationKey ?? generateOperationKey(this.path, { prefix: this.options.prefix, type: "mutation" });
     return mutationKey;
   }
   /**
@@ -421,29 +438,18 @@ class ProcedureUtils {
   }
 }
 
-class SharedRouterUtils {
-  constructor(path) {
-    this.path = path;
-  }
-  /**
-   * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
-   */
-  key(options = {}) {
-    return generateOperationKey(this.path, options);
-  }
-}
 function createRouterUtils(client, options = {}) {
   const plugin = new CompositeRouterUtilsPlugin(options.plugins);
   options = plugin.init(options);
   return createRouterUtilsInternal(client, options, plugin);
 }
-function createRouterUtilsInternal(client, options = {}, plugin) {
+function createRouterUtilsInternal(client, options, plugin) {
   const path = toArray(options.path);
-  const sharedUtils = bindMethods(new SharedRouterUtils(path));
-  const procedureUtils = typeof client === "function" && (options.scoped === void 0 || isProcedureUtilsOptions(options.scoped)) ? bindMethods(new ProcedureUtils(
+  const utils = typeof client === "function" && (options.scoped === void 0 || isProcedureUtilsOptions(options.scoped)) ? bindMethods(new ProcedureUtils(
     path,
     client,
     plugin.initProcedureOptions(path, {
+      prefix: options.prefix,
       ...options.scoped,
       queryInterceptors: [...toArray(options.queryInterceptors), ...toArray(options.scoped?.queryInterceptors)],
       streamedInterceptors: [...toArray(options.streamedInterceptors), ...toArray(options.scoped?.streamedInterceptors)],
@@ -451,11 +457,8 @@ function createRouterUtilsInternal(client, options = {}, plugin) {
       infiniteInterceptors: [...toArray(options.infiniteInterceptors), ...toArray(options.scoped?.infiniteInterceptors)],
       mutationInterceptors: [...toArray(options.mutationInterceptors), ...toArray(options.scoped?.mutationInterceptors)]
     })
-  )) : void 0;
-  const recursive = new Proxy({
-    ...sharedUtils,
-    ...procedureUtils
-  }, {
+  )) : bindMethods(new SharedUtils(path, options));
+  const recursive = new Proxy(utils, {
     get(target, prop) {
       const value = getOrBind(target, prop);
       const nextClient = get(client, [prop]);
@@ -504,30 +507,21 @@ function isProcedureUtilsOptions(value) {
   return true;
 }
 
-function createContractUtilsFactory(caller, options) {
-  return (procedure) => {
-    const path = getPathMeta(procedure);
-    if (!path) {
+function createContractUtilsFactory(clientFactory, options) {
+  const factory = (contract) => {
+    const client = clientFactory(contract);
+    const path = resolveBasePathMeta(contract);
+    if (path === void 0) {
       throw new TypeError(
         "ContractUtilsFactory: procedure contract must define `meta.path` that matches its path in the root router contract."
       );
     }
-    const scoped = get(options.scoped, path);
-    if (scoped !== void 0 && (scoped === null || typeof scoped !== "object")) {
-      throw new TypeError(
-        `ContractUtilsFactory: "scoped" at path "${path.join(".")}" must be an object or undefined, got "${scoped}".`
-      );
-    }
-    const client = (...rest) => caller(procedure, ...rest);
-    return createRouterUtils(client, {
-      ...options,
-      scoped,
-      path: [...toArray(options.path), ...path]
-    });
+    return createRouterUtils(client, { ...options, path, scoped: get(options.scoped, path) });
   };
+  return factory;
 }
-function createContractJsonifiedUtilsFactory(caller, options) {
-  return createContractUtilsFactory(caller, options);
+function createContractJsonifiedUtilsFactory(clientFactory, options) {
+  return createContractUtilsFactory(clientFactory, options);
 }
 
-export { OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedRouterUtils, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey, serializableStreamedQuery };
+export { OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey, serializableStreamedQuery };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/tanstack-query",
   "type": "module",
-  "version": "2.0.0-beta.18",
+  "version": "2.0.0-beta.19",
   "license": "MIT",
   "homepage": "https://orpc.dev",
   "repository": {
@@ -29,10 +29,10 @@
     "@tanstack/query-core": ">=5.80.2"
   },
   "dependencies": {
-    "@orpc/client": "2.0.0-beta.18",
-    "@orpc/openapi": "2.0.0-beta.18",
-    "@orpc/shared": "2.0.0-beta.18",
-    "@orpc/contract": "2.0.0-beta.18"
+    "@orpc/contract": "2.0.0-beta.19",
+    "@orpc/client": "2.0.0-beta.19",
+    "@orpc/shared": "2.0.0-beta.19",
+    "@orpc/openapi": "2.0.0-beta.19"
   },
   "devDependencies": {
     "@angular/core": "^22.0.1",