@orpc/pinia-colada 2.0.0-beta.23 → 2.0.0-beta.25

package/README.md

@@ -44,6 +44,7 @@ You can read the documentation [here](https://orpc.dev).
 
 - [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
 - [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
+- [@orpc/hibernation](https://www.npmjs.com/package/@orpc/hibernation): Leverage Hibernation APIs like [Cloudflare's Hibernation WebSocket](https://developers.cloudflare.com/durable-objects/best-practices/websockets/#durable-objects-hibernation-websocket-api).
 - [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
 
 **Framework & ecosystem integrations**
@@ -114,6 +115,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   </tr>
   <tr>
    <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>
+   <td align="center"><a href="https://github.com/ellis-driscoll?ref=orpc" target="_blank" rel="noopener" title="Ellis Driscoll"><img src="https://avatars.githubusercontent.com/u/70685966?u=c5f95bc33b5991d9744abe00052542e4a2ed3cb9&amp;v=4" width="139" alt="Ellis Driscoll"/><br />Ellis Driscoll</a></td>
   </tr>
 </table>
 
@@ -139,8 +141,9 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
    <td align="center"><a href="https://github.com/mr-kelly?ref=orpc" target="_blank" rel="noopener" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&amp;v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
   </tr>
   <tr>
+   <td align="center"><a href="https://github.com/guyariely?ref=orpc" target="_blank" rel="noopener" title="Guy Ariely"><img src="https://avatars.githubusercontent.com/u/42813496?u=edb6b7f563bf28e160a290832e7da57c0506f8ca&amp;v=4" width="119" alt="Guy Ariely"/><br />Guy Ariely</a></td>
    <td align="center"><a href="https://github.com/piscis?ref=orpc" target="_blank" rel="noopener" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&amp;v=4" width="119" alt="Alex"/><br />Alex</a></td>
-   <td align="center"><a href="https://github.com/finom?ref=orpc" target="_blank" rel="noopener" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=29e91400dbd4a9c217048a8f59562c4f740498e6&amp;v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
+   <td align="center"><a href="https://github.com/finom?ref=orpc" target="_blank" rel="noopener" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=c5f2daf7ebece498e85c83367bb37b4e10e2649d&amp;v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
   </tr>
 </table>
 

package/dist/index.d.mts

@@ -12,8 +12,20 @@ type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
  * `UseMutationGlobalContext` values provided by a global `onMutate` hook.
  */
 type UseMutationFnContext = Parameters<NonNullable<UseMutationOptionsGlobal['onSuccess']>>[2];
+/**
+ * The symbol under which Pinia Colada utils attach operation details
+ * (key and operation type) to the client context.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada#client-context | Pinia Colada Integration - Client Context}
+ */
 declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
 type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
+/**
+ * A client context automatically populated by Pinia Colada utils,
+ * exposing the operation key and type of the calling operation.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada#client-context | Pinia Colada Integration - Client Context}
+ */
 interface OperationContext {
     [OPERATION_CONTEXT_SYMBOL]?: {
         key: EntryKey;
@@ -117,7 +129,7 @@ type OperationKey<TType extends OperationType, TInput> = EntryKey & ([path: stri
  * The input is serialized to JSON-compatible values because Pinia Colada
  * requires entry keys to be serializable.
  *
- * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
  */
 declare function generateOperationKey<TType extends OperationType, TInput>(path: string[], options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
 
@@ -128,7 +140,7 @@ declare class SharedUtils<TInput> {
     /**
      * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     key<TType extends OperationType>(options?: Omit<OperationKeyOptions<TType, TInput>, 'prefix'>): OperationKey<TType, TInput>;
 }
@@ -251,26 +263,26 @@ declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutp
     /**
      * Calling corresponding procedure client
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#calling-procedure-clients Pinia Colada Calling Procedure Client Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#calling-procedure-clients | Pinia Colada Integration - Calling Procedure Clients}
      */
     call: Client<TClientContext, TInput, TOutput, TError>;
     constructor(path: string[], client: Client<TClientContext, TInput, TOutput, TError>, options?: ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>);
     /**
      * Generate a **full matching** key for useQuery/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     queryKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): EntryKeyTagged<TOutput, TError>;
     /**
      * Generate options used for useQuery/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-options-utility Pinia Colada Query Options Utility Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-options-utility | Pinia Colada Integration - Query Options Utility}
      */
     queryOptions<UInitialData extends TOutput | undefined = TOutput | undefined>(...rest: MaybeOptionalOptions<QueryOptionsIn<TClientContext, TInput, TOutput, TError, UInitialData>>): NoInfer<QueryOptionsOut<TOutput, TError, UInitialData>>;
     /**
      * Generate a **full matching** key for [Streamed Query Options](https://orpc.dev/docs/integrations/pinia-colada#streamed-query-options-utility).
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     streamedKey(...rest: MaybeOptionalOptions<StreamedKeyOptions<TInput>>): EntryKeyTagged<InferStreamedQueryOutput<TOutput>, TError>;
     /**
@@ -282,7 +294,7 @@ declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutp
     /**
      * Generate a **full matching** key for [Live Query Options](https://orpc.dev/docs/integrations/pinia-colada#live-query-options-utility).
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     liveKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): EntryKeyTagged<InferLiveQueryOutput<TOutput>, TError>;
     /**
@@ -294,25 +306,25 @@ declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutp
     /**
      * Generate a **full matching** key for useInfiniteQuery/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     infiniteKey<UPageParam>(optionsIn: InfiniteKeyOptions<TInput, UPageParam>): EntryKeyTagged<UseInfiniteQueryData<TOutput, UPageParam>, TError>;
     /**
      * Generate options used for useInfiniteQuery/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#infinite-query-options-utility Pinia Colada Infinite Query Options Utility Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#infinite-query-options-utility | Pinia Colada Integration - Infinite Query Options Utility}
      */
     infiniteOptions<UPageParam, UInitialData extends UseInfiniteQueryData<TOutput, UPageParam> | undefined = undefined>(optionsIn: InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, UPageParam, UInitialData>): NoInfer<InfiniteOptionsOut<TOutput, TError, UPageParam, UInitialData>>;
     /**
      * Generate a **full matching** key for useMutation/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     mutationKey(...rest: MaybeOptionalOptions<MutationKeyOptions<TInput>>): MutationOptionsOut<TInput, TOutput, TError, _EmptyObject>['key'];
     /**
      * Generate options used for useMutation/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#mutation-options Pinia Colada Mutation Options Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#mutation-options | Pinia Colada Integration - Mutation Options}
      */
     mutationOptions<UMutationContext extends Record<any, any> = _EmptyObject>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): NoInfer<MutationOptionsOut<TInput, TOutput, TError, UMutationContext>>;
 }
@@ -360,6 +372,12 @@ declare class CompositeRouterUtilsPlugin<T extends AnyNestedClient> implements R
     initProcedureOptions(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
 }
 
+/**
+ * The utils shape derived from a client: procedure clients map to procedure
+ * utils, and routers map recursively to nested utils.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada | Pinia Colada Integration}
+ */
 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<SharedUtils<unknown>>;
@@ -405,10 +423,13 @@ interface RouterUtilsOptions<T extends AnyNestedClient> extends OperationKeyPref
     plugins?: RouterUtilsPlugin<T>[] | undefined;
 }
 /**
- * Create a router utils from a client.
+ * Creates Pinia Colada utils from a client, exposing query/mutation
+ * option builders for every procedure in the router.
  *
- * @info Both client-side and server-side clients are supported.
- * @see {@link https://orpc.dev/docs/integrations/pinia-colada Pinia Colada Docs}
+ * @remarks
+ * **Note**: Both client-side and server-side clients are supported.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada | Pinia Colada Integration}
  */
 declare function createRouterUtils<T extends AnyNestedClient>(client: T, options?: NoInfer<RouterUtilsOptions<T>>): RouterUtils<T>;
 
@@ -417,6 +438,16 @@ interface ContractUtilsFactory<TClientContext extends ClientContext> {
 }
 interface ContractUtilsFactoryOptions<TClientContext extends ClientContext> extends Omit<RouterUtilsOptions<RouterContractClient<RouterContract, TClientContext>>, 'path'> {
 }
+/**
+ * Creates a factory that builds Pinia Colada utils directly from a contract,
+ * using the given contract client factory. Useful for scaling large projects
+ * where each part only needs a slice of the router.
+ *
+ * @remarks
+ * **Note**: The contract must define a `path` meta matching its position in the root router contract.
+ *
+ * @see {@link https://orpc.dev/docs/advanced/scaling-large-projects#pinia-colada-integration | Scaling Large Projects - Pinia Colada Integration}
+ */
 declare function createContractUtilsFactory<TClientContext extends ClientContext>(clientFactory: ContractClientFactory<TClientContext>, options: ContractUtilsFactoryOptions<TClientContext>): ContractUtilsFactory<TClientContext>;
 interface ContractJsonifiedUtilsFactory<TClientContext extends ClientContext> {
     <T extends RouterContract>(contract: T): RouterUtils<JsonifiedClient<RouterContractClient<T, TClientContext>>>;
@@ -443,7 +474,7 @@ interface PiniaColadaMetaPlugin<TInputSchema extends AnySchema, TOutputSchema ex
  *
  * Apply them to router utils with {@link ContractOptionsUtilsPlugin}.
  *
- * @see {@link https://orpc.dev/docs/integrations/pinia-colada#contract-options-plugin Pinia Colada Contract Options Plugin Docs}
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada#contract-options-plugin | Pinia Colada Integration - Contract Options Plugin}
  */
 declare function piniaColada<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap>(options: PiniaColadaMetaOptions<ClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ORPCErrorFromErrorMap<TErrorMap> | ThrowableError>): PiniaColadaMetaPlugin<TInputSchema, TOutputSchema, TErrorMap>;
 declare function getPiniaColadaMeta(procedureOrLazy: {
@@ -459,7 +490,7 @@ declare function getPiniaColadaMeta(procedureOrLazy: {
  * The contract shape must match the client the utils are created from,
  * so pass the root router contract when utils paths start from the root.
  *
- * @see {@link https://orpc.dev/docs/integrations/pinia-colada#contract-options-plugin Pinia Colada Contract Options Plugin Docs}
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada#contract-options-plugin | Pinia Colada Integration - Contract Options Plugin}
  */
 declare class ContractOptionsUtilsPlugin<T extends AnyNestedClient = AnyNestedClient> implements RouterUtilsPlugin<T> {
     private readonly contract;
@@ -468,5 +499,5 @@ declare class ContractOptionsUtilsPlugin<T extends AnyNestedClient = AnyNestedCl
     initProcedureOptions(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
 }
 
-export { CompositeRouterUtilsPlugin, ContractOptionsUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createPiniaColadaUtils, createRouterUtils, generateOperationKey, getPiniaColadaMeta, isProcedureUtilsOptions, liveQuery, mergeProcedureUtilsOptions, piniaColada, serializableStreamedQuery };
+export { CompositeRouterUtilsPlugin, ContractOptionsUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createORPCVueColadaUtils, createRouterUtils as createPiniaColadaUtils, createRouterUtils, generateOperationKey, getPiniaColadaMeta, isProcedureUtilsOptions, liveQuery, mergeProcedureUtilsOptions, piniaColada, serializableStreamedQuery };
 export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyOptions, OperationKeyPrefixOptions, OperationType, PiniaColadaMetaOptions, PiniaColadaMetaPlugin, OperationContext as PiniaColadaOperationContext, ProcedureUtilsInfiniteInterceptor, ProcedureUtilsInfiniteInterceptorOptions, ProcedureUtilsLiveInterceptor, ProcedureUtilsLiveInterceptorOptions, ProcedureUtilsModifier, ProcedureUtilsMutationInterceptor, ProcedureUtilsMutationInterceptorOptions, ProcedureUtilsOptions, ProcedureUtilsQueryInterceptor, ProcedureUtilsQueryInterceptorOptions, ProcedureUtilsStreamedInterceptor, ProcedureUtilsStreamedInterceptorOptions, QueryKeyOptions, QueryOptionsIn, QueryOptionsOut, RouterUtils, RouterUtilsOptions, RouterUtilsPlugin, RouterUtilsScoped, SerializableStreamedQueryOptions, StreamedKeyOptions, StreamedOptionsIn, StreamedOptionsOut, UseMutationFnContext, UseQueryFnContext };

package/dist/index.d.ts

@@ -12,8 +12,20 @@ type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
  * `UseMutationGlobalContext` values provided by a global `onMutate` hook.
  */
 type UseMutationFnContext = Parameters<NonNullable<UseMutationOptionsGlobal['onSuccess']>>[2];
+/**
+ * The symbol under which Pinia Colada utils attach operation details
+ * (key and operation type) to the client context.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada#client-context | Pinia Colada Integration - Client Context}
+ */
 declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
 type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
+/**
+ * A client context automatically populated by Pinia Colada utils,
+ * exposing the operation key and type of the calling operation.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada#client-context | Pinia Colada Integration - Client Context}
+ */
 interface OperationContext {
     [OPERATION_CONTEXT_SYMBOL]?: {
         key: EntryKey;
@@ -117,7 +129,7 @@ type OperationKey<TType extends OperationType, TInput> = EntryKey & ([path: stri
  * The input is serialized to JSON-compatible values because Pinia Colada
  * requires entry keys to be serializable.
  *
- * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
  */
 declare function generateOperationKey<TType extends OperationType, TInput>(path: string[], options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
 
@@ -128,7 +140,7 @@ declare class SharedUtils<TInput> {
     /**
      * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     key<TType extends OperationType>(options?: Omit<OperationKeyOptions<TType, TInput>, 'prefix'>): OperationKey<TType, TInput>;
 }
@@ -251,26 +263,26 @@ declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutp
     /**
      * Calling corresponding procedure client
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#calling-procedure-clients Pinia Colada Calling Procedure Client Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#calling-procedure-clients | Pinia Colada Integration - Calling Procedure Clients}
      */
     call: Client<TClientContext, TInput, TOutput, TError>;
     constructor(path: string[], client: Client<TClientContext, TInput, TOutput, TError>, options?: ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>);
     /**
      * Generate a **full matching** key for useQuery/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     queryKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): EntryKeyTagged<TOutput, TError>;
     /**
      * Generate options used for useQuery/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-options-utility Pinia Colada Query Options Utility Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-options-utility | Pinia Colada Integration - Query Options Utility}
      */
     queryOptions<UInitialData extends TOutput | undefined = TOutput | undefined>(...rest: MaybeOptionalOptions<QueryOptionsIn<TClientContext, TInput, TOutput, TError, UInitialData>>): NoInfer<QueryOptionsOut<TOutput, TError, UInitialData>>;
     /**
      * Generate a **full matching** key for [Streamed Query Options](https://orpc.dev/docs/integrations/pinia-colada#streamed-query-options-utility).
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     streamedKey(...rest: MaybeOptionalOptions<StreamedKeyOptions<TInput>>): EntryKeyTagged<InferStreamedQueryOutput<TOutput>, TError>;
     /**
@@ -282,7 +294,7 @@ declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutp
     /**
      * Generate a **full matching** key for [Live Query Options](https://orpc.dev/docs/integrations/pinia-colada#live-query-options-utility).
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     liveKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): EntryKeyTagged<InferLiveQueryOutput<TOutput>, TError>;
     /**
@@ -294,25 +306,25 @@ declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutp
     /**
      * Generate a **full matching** key for useInfiniteQuery/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     infiniteKey<UPageParam>(optionsIn: InfiniteKeyOptions<TInput, UPageParam>): EntryKeyTagged<UseInfiniteQueryData<TOutput, UPageParam>, TError>;
     /**
      * Generate options used for useInfiniteQuery/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#infinite-query-options-utility Pinia Colada Infinite Query Options Utility Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#infinite-query-options-utility | Pinia Colada Integration - Infinite Query Options Utility}
      */
     infiniteOptions<UPageParam, UInitialData extends UseInfiniteQueryData<TOutput, UPageParam> | undefined = undefined>(optionsIn: InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, UPageParam, UInitialData>): NoInfer<InfiniteOptionsOut<TOutput, TError, UPageParam, UInitialData>>;
     /**
      * Generate a **full matching** key for useMutation/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
      */
     mutationKey(...rest: MaybeOptionalOptions<MutationKeyOptions<TInput>>): MutationOptionsOut<TInput, TOutput, TError, _EmptyObject>['key'];
     /**
      * Generate options used for useMutation/...
      *
-     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#mutation-options Pinia Colada Mutation Options Docs}
+     * @see {@link https://orpc.dev/docs/integrations/pinia-colada#mutation-options | Pinia Colada Integration - Mutation Options}
      */
     mutationOptions<UMutationContext extends Record<any, any> = _EmptyObject>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): NoInfer<MutationOptionsOut<TInput, TOutput, TError, UMutationContext>>;
 }
@@ -360,6 +372,12 @@ declare class CompositeRouterUtilsPlugin<T extends AnyNestedClient> implements R
     initProcedureOptions(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
 }
 
+/**
+ * The utils shape derived from a client: procedure clients map to procedure
+ * utils, and routers map recursively to nested utils.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada | Pinia Colada Integration}
+ */
 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<SharedUtils<unknown>>;
@@ -405,10 +423,13 @@ interface RouterUtilsOptions<T extends AnyNestedClient> extends OperationKeyPref
     plugins?: RouterUtilsPlugin<T>[] | undefined;
 }
 /**
- * Create a router utils from a client.
+ * Creates Pinia Colada utils from a client, exposing query/mutation
+ * option builders for every procedure in the router.
  *
- * @info Both client-side and server-side clients are supported.
- * @see {@link https://orpc.dev/docs/integrations/pinia-colada Pinia Colada Docs}
+ * @remarks
+ * **Note**: Both client-side and server-side clients are supported.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada | Pinia Colada Integration}
  */
 declare function createRouterUtils<T extends AnyNestedClient>(client: T, options?: NoInfer<RouterUtilsOptions<T>>): RouterUtils<T>;
 
@@ -417,6 +438,16 @@ interface ContractUtilsFactory<TClientContext extends ClientContext> {
 }
 interface ContractUtilsFactoryOptions<TClientContext extends ClientContext> extends Omit<RouterUtilsOptions<RouterContractClient<RouterContract, TClientContext>>, 'path'> {
 }
+/**
+ * Creates a factory that builds Pinia Colada utils directly from a contract,
+ * using the given contract client factory. Useful for scaling large projects
+ * where each part only needs a slice of the router.
+ *
+ * @remarks
+ * **Note**: The contract must define a `path` meta matching its position in the root router contract.
+ *
+ * @see {@link https://orpc.dev/docs/advanced/scaling-large-projects#pinia-colada-integration | Scaling Large Projects - Pinia Colada Integration}
+ */
 declare function createContractUtilsFactory<TClientContext extends ClientContext>(clientFactory: ContractClientFactory<TClientContext>, options: ContractUtilsFactoryOptions<TClientContext>): ContractUtilsFactory<TClientContext>;
 interface ContractJsonifiedUtilsFactory<TClientContext extends ClientContext> {
     <T extends RouterContract>(contract: T): RouterUtils<JsonifiedClient<RouterContractClient<T, TClientContext>>>;
@@ -443,7 +474,7 @@ interface PiniaColadaMetaPlugin<TInputSchema extends AnySchema, TOutputSchema ex
  *
  * Apply them to router utils with {@link ContractOptionsUtilsPlugin}.
  *
- * @see {@link https://orpc.dev/docs/integrations/pinia-colada#contract-options-plugin Pinia Colada Contract Options Plugin Docs}
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada#contract-options-plugin | Pinia Colada Integration - Contract Options Plugin}
  */
 declare function piniaColada<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap>(options: PiniaColadaMetaOptions<ClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ORPCErrorFromErrorMap<TErrorMap> | ThrowableError>): PiniaColadaMetaPlugin<TInputSchema, TOutputSchema, TErrorMap>;
 declare function getPiniaColadaMeta(procedureOrLazy: {
@@ -459,7 +490,7 @@ declare function getPiniaColadaMeta(procedureOrLazy: {
  * The contract shape must match the client the utils are created from,
  * so pass the root router contract when utils paths start from the root.
  *
- * @see {@link https://orpc.dev/docs/integrations/pinia-colada#contract-options-plugin Pinia Colada Contract Options Plugin Docs}
+ * @see {@link https://orpc.dev/docs/integrations/pinia-colada#contract-options-plugin | Pinia Colada Integration - Contract Options Plugin}
  */
 declare class ContractOptionsUtilsPlugin<T extends AnyNestedClient = AnyNestedClient> implements RouterUtilsPlugin<T> {
     private readonly contract;
@@ -468,5 +499,5 @@ declare class ContractOptionsUtilsPlugin<T extends AnyNestedClient = AnyNestedCl
     initProcedureOptions(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
 }
 
-export { CompositeRouterUtilsPlugin, ContractOptionsUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createPiniaColadaUtils, createRouterUtils, generateOperationKey, getPiniaColadaMeta, isProcedureUtilsOptions, liveQuery, mergeProcedureUtilsOptions, piniaColada, serializableStreamedQuery };
+export { CompositeRouterUtilsPlugin, ContractOptionsUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createORPCVueColadaUtils, createRouterUtils as createPiniaColadaUtils, createRouterUtils, generateOperationKey, getPiniaColadaMeta, isProcedureUtilsOptions, liveQuery, mergeProcedureUtilsOptions, piniaColada, serializableStreamedQuery };
 export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyOptions, OperationKeyPrefixOptions, OperationType, PiniaColadaMetaOptions, PiniaColadaMetaPlugin, OperationContext as PiniaColadaOperationContext, ProcedureUtilsInfiniteInterceptor, ProcedureUtilsInfiniteInterceptorOptions, ProcedureUtilsLiveInterceptor, ProcedureUtilsLiveInterceptorOptions, ProcedureUtilsModifier, ProcedureUtilsMutationInterceptor, ProcedureUtilsMutationInterceptorOptions, ProcedureUtilsOptions, ProcedureUtilsQueryInterceptor, ProcedureUtilsQueryInterceptorOptions, ProcedureUtilsStreamedInterceptor, ProcedureUtilsStreamedInterceptorOptions, QueryKeyOptions, QueryOptionsIn, QueryOptionsOut, RouterUtils, RouterUtilsOptions, RouterUtilsPlugin, RouterUtilsScoped, SerializableStreamedQueryOptions, StreamedKeyOptions, StreamedOptionsIn, StreamedOptionsOut, UseMutationFnContext, UseQueryFnContext };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { resolveBasePathMeta, getRouterContract, ProcedureContract } from '@orpc/contract';
-import { sortPlugins, stringifyJSON, resolveMaybeOptionalOptions, intercept, isTypescriptObject, isAsyncIteratorObject, toArray, bindMethods, getOrBind, get } from '@orpc/shared';
+import { sortPlugins, stringifyJSON, resolveMaybeOptionalOptions, intercept, isTypescriptObject, isAsyncIteratorObject, toArray, bindMethods, get } from '@orpc/shared';
 import { RPCJsonSerializer, RECURSIVE_CLIENT_UNWRAP_KEYS } from '@orpc/client';
 
 class CompositeRouterUtilsPlugin {
@@ -68,7 +68,7 @@ class SharedUtils {
   /**
    * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
    *
-   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
    */
   key(options = {}) {
     return generateOperationKey(this.path, { ...options, prefix: this.options.prefix });
@@ -183,7 +183,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Calling corresponding procedure client
    *
-   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#calling-procedure-clients Pinia Colada Calling Procedure Client Docs}
+   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#calling-procedure-clients | Pinia Colada Integration - Calling Procedure Clients}
    */
   call;
   constructor(path, client, options = {}) {
@@ -193,7 +193,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate a **full matching** key for useQuery/...
    *
-   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
    */
   queryKey(...rest) {
     let optionsIn = resolveMaybeOptionalOptions(rest);
@@ -208,7 +208,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate options used for useQuery/...
    *
-   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-options-utility Pinia Colada Query Options Utility Docs}
+   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-options-utility | Pinia Colada Integration - Query Options Utility}
    */
   queryOptions(...rest) {
     let optionsIn = resolveMaybeOptionalOptions(rest);
@@ -250,7 +250,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate a **full matching** key for [Streamed Query Options](https://orpc.dev/docs/integrations/pinia-colada#streamed-query-options-utility).
    *
-   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
    */
   streamedKey(...rest) {
     let optionsIn = resolveMaybeOptionalOptions(rest);
@@ -316,7 +316,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate a **full matching** key for [Live Query Options](https://orpc.dev/docs/integrations/pinia-colada#live-query-options-utility).
    *
-   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
    */
   liveKey(...rest) {
     let optionsIn = resolveMaybeOptionalOptions(rest);
@@ -379,7 +379,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate a **full matching** key for useInfiniteQuery/...
    *
-   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
    */
   infiniteKey(optionsIn) {
     if (typeof this.options.infiniteKey === "function") {
@@ -399,7 +399,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate options used for useInfiniteQuery/...
    *
-   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#infinite-query-options-utility Pinia Colada Infinite Query Options Utility Docs}
+   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#infinite-query-options-utility | Pinia Colada Integration - Infinite Query Options Utility}
    */
   infiniteOptions(optionsIn) {
     if (typeof this.options.infiniteOptions === "function") {
@@ -440,7 +440,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate a **full matching** key for useMutation/...
    *
-   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs}
+   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#query-mutation-key | Pinia Colada Integration - Query/Mutation Key}
    */
   mutationKey(...rest) {
     let optionsIn = resolveMaybeOptionalOptions(rest);
@@ -455,7 +455,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate options used for useMutation/...
    *
-   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#mutation-options Pinia Colada Mutation Options Docs}
+   * @see {@link https://orpc.dev/docs/integrations/pinia-colada#mutation-options | Pinia Colada Integration - Mutation Options}
    */
   mutationOptions(...rest) {
     let optionsIn = resolveMaybeOptionalOptions(rest);
@@ -517,30 +517,33 @@ function createRouterUtilsInternal(client, options, plugin) {
       },
       options.scoped ?? {}
     ))
-  )) : bindMethods(new SharedUtils(path, options));
+  ), { unbound: ["call"] }) : bindMethods(new SharedUtils(path, options));
+  const cache = /* @__PURE__ */ new Map();
   const recursive = new Proxy(utils, {
     get(target, prop) {
-      const value = getOrBind(target, prop);
-      const nextClient = client[prop];
+      const value = Reflect.get(target, prop);
+      const nextClient = Reflect.get(client, prop);
       if (typeof prop !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop) || !isTypescriptObject(nextClient)) {
         return value;
       }
-      const nextUtils = createRouterUtilsInternal(nextClient, {
-        ...options,
-        path: [...path, prop],
-        scoped: get(options.scoped, [prop])
-      }, plugin);
-      if (typeof value !== "function") {
-        return nextUtils;
-      }
-      return new Proxy(value, {
-        get(target2, prop2) {
-          if (typeof prop2 !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop2)) {
-            return getOrBind(target2, prop2);
+      let result = cache.get(prop);
+      if (result === void 0) {
+        const nextUtils = createRouterUtilsInternal(nextClient, {
+          ...options,
+          path: [...path, prop],
+          scoped: options.scoped?.[prop]
+        }, plugin);
+        result = typeof value !== "function" ? nextUtils : new Proxy(value, {
+          get(target2, prop2) {
+            if (typeof prop2 !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop2)) {
+              return Reflect.get(target2, prop2);
+            }
+            return Reflect.get(nextUtils, prop2);
           }
-          return getOrBind(nextUtils, prop2);
-        }
-      });
+        });
+        cache.set(prop, result);
+      }
+      return result;
     }
   });
   return recursive;
@@ -596,4 +599,4 @@ class ContractOptionsUtilsPlugin {
   }
 }
 
-export { CompositeRouterUtilsPlugin, ContractOptionsUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createPiniaColadaUtils, createRouterUtils, generateOperationKey, getPiniaColadaMeta, isProcedureUtilsOptions, liveQuery, mergeProcedureUtilsOptions, piniaColada, serializableStreamedQuery };
+export { CompositeRouterUtilsPlugin, ContractOptionsUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createORPCVueColadaUtils, createRouterUtils as createPiniaColadaUtils, createRouterUtils, generateOperationKey, getPiniaColadaMeta, isProcedureUtilsOptions, liveQuery, mergeProcedureUtilsOptions, piniaColada, serializableStreamedQuery };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/pinia-colada",
   "type": "module",
-  "version": "2.0.0-beta.23",
+  "version": "2.0.0-beta.25",
   "license": "MIT",
   "homepage": "https://orpc.dev",
   "repository": {
@@ -32,10 +32,10 @@
     "vue": ">=3.5.17"
   },
   "dependencies": {
-    "@orpc/client": "2.0.0-beta.23",
-    "@orpc/shared": "2.0.0-beta.23",
-    "@orpc/openapi": "2.0.0-beta.23",
-    "@orpc/contract": "2.0.0-beta.23"
+    "@orpc/client": "2.0.0-beta.25",
+    "@orpc/openapi": "2.0.0-beta.25",
+    "@orpc/shared": "2.0.0-beta.25",
+    "@orpc/contract": "2.0.0-beta.25"
   },
   "devDependencies": {
     "@pinia/colada": "^1.4.2",