@orpc/pinia-colada 0.0.0 → 1.14.11

package/README.md

@@ -52,6 +52,7 @@ You can read the documentation [here](https://orpc.dev).
 - [@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/swr](https://www.npmjs.com/package/@orpc/swr): Integrate with [SWR](https://swr.vercel.app/).
 - [@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/).
@@ -108,11 +109,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/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>
+   <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>
   </tr>
   <tr>
-   <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>
 </table>
@@ -172,6 +172,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   <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/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&amp;v=4" width="32" height="32" alt="Ryan Vogel" /></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,13 +1,17 @@
 import { ClientContext, Client, AnyNestedClient, InferClientContext, InferClientError } from '@orpc/client';
-import { RouterContract, RouterContractClient, ContractClientFactory } from '@orpc/contract';
+import { RouterContract, RouterContractClient, ContractClientFactory, AnySchema, ErrorMap, MetaPlugin, Meta, InferSchemaInput, InferSchemaOutput, ORPCErrorFromErrorMap } from '@orpc/contract';
 import { JsonifiedClient } from '@orpc/openapi';
-import { Promisable, PartialDeep, Interceptor, PromiseWithError, MaybeOptionalOptions, OrderablePlugin, Public } from '@orpc/shared';
-import { EntryKey, UseQueryOptions, UseMutationOptions, DefineQueryOptions, UseInfiniteQueryData, DefineInfiniteQueryOptions, DefineQueryOptionsTagged, DefineInfiniteQueryOptionsTagged, DefineMutationOptionsTagged, UseInfiniteQueryFnContext, EntryKeyTagged, _EmptyObject } from '@pinia/colada';
+import { Promisable, PartialDeep, Interceptor, PromiseWithError, MaybeOptionalOptions, OrderablePlugin, Public, ThrowableError } from '@orpc/shared';
+import { EntryKey, UseQueryOptions, UseMutationOptionsGlobal, DefineQueryOptions, UseInfiniteQueryData, DefineInfiniteQueryOptions, UseMutationOptions, DefineQueryOptionsTagged, DefineInfiniteQueryOptionsTagged, DefineMutationOptionsTagged, UseInfiniteQueryFnContext, EntryKeyTagged, _EmptyObject } from '@pinia/colada';
 
 type InferStreamedQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
 type InferLiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
 type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
-type UseMutationFnContext = Parameters<UseMutationOptions<any, any>['mutation']>[1];
+/**
+ * The context passed to the mutation function, including the merged
+ * `UseMutationGlobalContext` values provided by a global `onMutate` hook.
+ */
+type UseMutationFnContext = Parameters<NonNullable<UseMutationOptionsGlobal['onSuccess']>>[2];
 declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
 type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
 interface OperationContext {
@@ -233,6 +237,15 @@ interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TO
      */
     mutationOptions?: ProcedureUtilsModifier<MutationOptionsIn<TClientContext, TInput, TOutput, TError, Record<any, any>>>;
 }
+declare function isProcedureUtilsOptions(value: unknown): value is ProcedureUtilsOptions<any, any, any, any>;
+/**
+ * Merge two procedure utils options where `override` takes priority.
+ * A key explicitly set to `undefined` in `override` resets the base value.
+ * When both sides define a key: interceptors are concatenated (base ones run first),
+ * modifiers are spread-merged when both are plain objects and composed (base applied
+ * first) otherwise, with plain objects applied as regular spread merges.
+ */
+declare function mergeProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TOutput, TError>(base: ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>, override: ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>): ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>;
 declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> extends SharedUtils<TInput> {
     protected readonly options: ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>;
     /**
@@ -418,5 +431,42 @@ declare function createContractJsonifiedUtilsFactory<TClientContext extends Clie
  */
 declare function liveQuery<T>(queryFn: (context: UseQueryFnContext) => Promisable<AsyncIterable<T>>): (context: UseQueryFnContext) => Promise<T>;
 
-export { CompositeRouterUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createPiniaColadaUtils, createRouterUtils, generateOperationKey, liveQuery, serializableStreamedQuery };
-export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyOptions, OperationKeyPrefixOptions, OperationType, 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 };
+type PiniaColadaMetaOptions<TClientContext extends ClientContext, TInput, TOutput, TError> = Omit<ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>, 'prefix'>;
+interface PiniaColadaMetaPlugin<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> extends MetaPlugin<TInputSchema, TOutputSchema, TErrorMap> {
+    name: '~pinia-colada';
+}
+/**
+ * Define base Pinia Colada options and interceptors on a procedure contract.
+ * Applied multiple times, later options are spread-merged with higher priority
+ * while interceptors are concatenated. A key explicitly set to `undefined`
+ * resets the value from earlier applications instead of merging.
+ *
+ * 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}
+ */
+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: {
+    '~orpc': {
+        meta: Meta;
+    };
+}): PiniaColadaMetaOptions<ClientContext, unknown, unknown, ThrowableError> | undefined;
+/**
+ * Router utils plugin that applies base options defined via {@link piniaColada}
+ * on the given router contract. Meta options act as the base layer: options defined
+ * on the utils override them, and utils interceptors run after meta interceptors.
+ *
+ * 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}
+ */
+declare class ContractOptionsUtilsPlugin<T extends AnyNestedClient = AnyNestedClient> implements RouterUtilsPlugin<T> {
+    private readonly contract;
+    readonly name = "~contract-options";
+    constructor(contract: RouterContract);
+    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 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

@@ -1,13 +1,17 @@
 import { ClientContext, Client, AnyNestedClient, InferClientContext, InferClientError } from '@orpc/client';
-import { RouterContract, RouterContractClient, ContractClientFactory } from '@orpc/contract';
+import { RouterContract, RouterContractClient, ContractClientFactory, AnySchema, ErrorMap, MetaPlugin, Meta, InferSchemaInput, InferSchemaOutput, ORPCErrorFromErrorMap } from '@orpc/contract';
 import { JsonifiedClient } from '@orpc/openapi';
-import { Promisable, PartialDeep, Interceptor, PromiseWithError, MaybeOptionalOptions, OrderablePlugin, Public } from '@orpc/shared';
-import { EntryKey, UseQueryOptions, UseMutationOptions, DefineQueryOptions, UseInfiniteQueryData, DefineInfiniteQueryOptions, DefineQueryOptionsTagged, DefineInfiniteQueryOptionsTagged, DefineMutationOptionsTagged, UseInfiniteQueryFnContext, EntryKeyTagged, _EmptyObject } from '@pinia/colada';
+import { Promisable, PartialDeep, Interceptor, PromiseWithError, MaybeOptionalOptions, OrderablePlugin, Public, ThrowableError } from '@orpc/shared';
+import { EntryKey, UseQueryOptions, UseMutationOptionsGlobal, DefineQueryOptions, UseInfiniteQueryData, DefineInfiniteQueryOptions, UseMutationOptions, DefineQueryOptionsTagged, DefineInfiniteQueryOptionsTagged, DefineMutationOptionsTagged, UseInfiniteQueryFnContext, EntryKeyTagged, _EmptyObject } from '@pinia/colada';
 
 type InferStreamedQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
 type InferLiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
 type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
-type UseMutationFnContext = Parameters<UseMutationOptions<any, any>['mutation']>[1];
+/**
+ * The context passed to the mutation function, including the merged
+ * `UseMutationGlobalContext` values provided by a global `onMutate` hook.
+ */
+type UseMutationFnContext = Parameters<NonNullable<UseMutationOptionsGlobal['onSuccess']>>[2];
 declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
 type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
 interface OperationContext {
@@ -233,6 +237,15 @@ interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TO
      */
     mutationOptions?: ProcedureUtilsModifier<MutationOptionsIn<TClientContext, TInput, TOutput, TError, Record<any, any>>>;
 }
+declare function isProcedureUtilsOptions(value: unknown): value is ProcedureUtilsOptions<any, any, any, any>;
+/**
+ * Merge two procedure utils options where `override` takes priority.
+ * A key explicitly set to `undefined` in `override` resets the base value.
+ * When both sides define a key: interceptors are concatenated (base ones run first),
+ * modifiers are spread-merged when both are plain objects and composed (base applied
+ * first) otherwise, with plain objects applied as regular spread merges.
+ */
+declare function mergeProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TOutput, TError>(base: ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>, override: ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>): ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>;
 declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> extends SharedUtils<TInput> {
     protected readonly options: ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>;
     /**
@@ -418,5 +431,42 @@ declare function createContractJsonifiedUtilsFactory<TClientContext extends Clie
  */
 declare function liveQuery<T>(queryFn: (context: UseQueryFnContext) => Promisable<AsyncIterable<T>>): (context: UseQueryFnContext) => Promise<T>;
 
-export { CompositeRouterUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createPiniaColadaUtils, createRouterUtils, generateOperationKey, liveQuery, serializableStreamedQuery };
-export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyOptions, OperationKeyPrefixOptions, OperationType, 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 };
+type PiniaColadaMetaOptions<TClientContext extends ClientContext, TInput, TOutput, TError> = Omit<ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>, 'prefix'>;
+interface PiniaColadaMetaPlugin<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> extends MetaPlugin<TInputSchema, TOutputSchema, TErrorMap> {
+    name: '~pinia-colada';
+}
+/**
+ * Define base Pinia Colada options and interceptors on a procedure contract.
+ * Applied multiple times, later options are spread-merged with higher priority
+ * while interceptors are concatenated. A key explicitly set to `undefined`
+ * resets the value from earlier applications instead of merging.
+ *
+ * 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}
+ */
+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: {
+    '~orpc': {
+        meta: Meta;
+    };
+}): PiniaColadaMetaOptions<ClientContext, unknown, unknown, ThrowableError> | undefined;
+/**
+ * Router utils plugin that applies base options defined via {@link piniaColada}
+ * on the given router contract. Meta options act as the base layer: options defined
+ * on the utils override them, and utils interceptors run after meta interceptors.
+ *
+ * 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}
+ */
+declare class ContractOptionsUtilsPlugin<T extends AnyNestedClient = AnyNestedClient> implements RouterUtilsPlugin<T> {
+    private readonly contract;
+    readonly name = "~contract-options";
+    constructor(contract: RouterContract);
+    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 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 } from '@orpc/contract';
-import { sortPlugins, stringifyJSON, resolveMaybeOptionalOptions, intercept, isAsyncIteratorObject, toArray, bindMethods, getOrBind, get, isTypescriptObject } from '@orpc/shared';
+import { resolveBasePathMeta, getRouterContract, ProcedureContract } from '@orpc/contract';
+import { sortPlugins, stringifyJSON, resolveMaybeOptionalOptions, intercept, isTypescriptObject, isAsyncIteratorObject, toArray, bindMethods, getOrBind, get } from '@orpc/shared';
 import { RPCJsonSerializer, RECURSIVE_CLIENT_UNWRAP_KEYS } from '@orpc/client';
 
 class CompositeRouterUtilsPlugin {
@@ -110,6 +110,75 @@ function limitArraySize(items, maxSize) {
 
 const OPERATION_CONTEXT_SYMBOL = Symbol.for("ORPC_PINIA_COLADA_OPERATION_CONTEXT");
 
+const PROCEDURE_UTILS_INTERCEPTOR_KEYS = [
+  "queryInterceptors",
+  "streamedInterceptors",
+  "liveInterceptors",
+  "infiniteInterceptors",
+  "mutationInterceptors"
+];
+const PROCEDURE_UTILS_MODIFIER_KEYS = [
+  "queryKey",
+  "queryOptions",
+  "streamedKey",
+  "streamedOptions",
+  "liveKey",
+  "liveOptions",
+  "infiniteKey",
+  "infiniteOptions",
+  "mutationKey",
+  "mutationOptions"
+];
+function isProcedureUtilsOptions(value) {
+  if (!isTypescriptObject(value)) {
+    return false;
+  }
+  for (const key in value) {
+    if (value[key] === void 0) {
+      continue;
+    }
+    if (key === "prefix") {
+      if (typeof value[key] !== "string") {
+        return false;
+      }
+    } else if (PROCEDURE_UTILS_INTERCEPTOR_KEYS.includes(key)) {
+      if (!Array.isArray(value[key]) || value[key].some((i) => typeof i !== "function")) {
+        return false;
+      }
+    } else if (PROCEDURE_UTILS_MODIFIER_KEYS.includes(key)) {
+      if (!isTypescriptObject(value[key])) {
+        return false;
+      }
+    }
+  }
+  return true;
+}
+function mergeProcedureUtilsModifier(base, override) {
+  if (typeof base !== "function" && typeof override !== "function") {
+    return { ...base, ...override };
+  }
+  const applyBase = typeof base === "function" ? base : (options) => ({ ...base, ...options });
+  const applyOverride = typeof override === "function" ? override : (options) => ({ ...override, ...options });
+  return (options) => applyOverride(applyBase(options));
+}
+function mergeProcedureUtilsOptions(base, override) {
+  const merged = { ...base, ...override };
+  for (const key of PROCEDURE_UTILS_INTERCEPTOR_KEYS) {
+    const baseValue = base[key];
+    const overrideValue = override[key];
+    if (baseValue && overrideValue) {
+      merged[key] = [...baseValue, ...overrideValue];
+    }
+  }
+  for (const key of PROCEDURE_UTILS_MODIFIER_KEYS) {
+    const baseValue = base[key];
+    const overrideValue = override[key];
+    if (baseValue && overrideValue) {
+      merged[key] = mergeProcedureUtilsModifier(baseValue, overrideValue);
+    }
+  }
+  return merged;
+}
 class ProcedureUtils extends SharedUtils {
   /**
    * Calling corresponding procedure client
@@ -437,20 +506,22 @@ function createRouterUtilsInternal(client, options, plugin) {
   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)],
-      liveInterceptors: [...toArray(options.liveInterceptors), ...toArray(options.scoped?.liveInterceptors)],
-      infiniteInterceptors: [...toArray(options.infiniteInterceptors), ...toArray(options.scoped?.infiniteInterceptors)],
-      mutationInterceptors: [...toArray(options.mutationInterceptors), ...toArray(options.scoped?.mutationInterceptors)]
-    })
+    plugin.initProcedureOptions(path, mergeProcedureUtilsOptions(
+      {
+        prefix: options.prefix,
+        queryInterceptors: options.queryInterceptors,
+        streamedInterceptors: options.streamedInterceptors,
+        liveInterceptors: options.liveInterceptors,
+        infiniteInterceptors: options.infiniteInterceptors,
+        mutationInterceptors: options.mutationInterceptors
+      },
+      options.scoped ?? {}
+    ))
   )) : bindMethods(new SharedUtils(path, options));
   const recursive = new Proxy(utils, {
     get(target, prop) {
       const value = getOrBind(target, prop);
-      const nextClient = get(client, [prop]);
+      const nextClient = client[prop];
       if (typeof prop !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop) || !isTypescriptObject(nextClient)) {
         return value;
       }
@@ -474,27 +545,6 @@ function createRouterUtilsInternal(client, options, plugin) {
   });
   return recursive;
 }
-function isProcedureUtilsOptions(value) {
-  if (!isTypescriptObject(value)) {
-    return false;
-  }
-  if (value.queryInterceptors !== void 0 && !Array.isArray(value.queryInterceptors)) {
-    return false;
-  }
-  if (value.streamedInterceptors !== void 0 && !Array.isArray(value.streamedInterceptors)) {
-    return false;
-  }
-  if (value.liveInterceptors !== void 0 && !Array.isArray(value.liveInterceptors)) {
-    return false;
-  }
-  if (value.infiniteInterceptors !== void 0 && !Array.isArray(value.infiniteInterceptors)) {
-    return false;
-  }
-  if (value.mutationInterceptors !== void 0 && !Array.isArray(value.mutationInterceptors)) {
-    return false;
-  }
-  return true;
-}
 
 function createContractUtilsFactory(clientFactory, options) {
   const factory = (contract) => {
@@ -513,4 +563,37 @@ function createContractJsonifiedUtilsFactory(clientFactory, options) {
   return createContractUtilsFactory(clientFactory, options);
 }
 
-export { CompositeRouterUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createPiniaColadaUtils, createRouterUtils, generateOperationKey, liveQuery, serializableStreamedQuery };
+function piniaColada(options) {
+  return {
+    name: "~pinia-colada",
+    init(meta) {
+      const current = meta["~pinia-colada"];
+      return {
+        ...meta,
+        "~pinia-colada": current ? mergeProcedureUtilsOptions(current, options) : options
+      };
+    }
+  };
+}
+function getPiniaColadaMeta(procedureOrLazy) {
+  return procedureOrLazy["~orpc"].meta["~pinia-colada"];
+}
+class ContractOptionsUtilsPlugin {
+  constructor(contract) {
+    this.contract = contract;
+  }
+  name = "~contract-options";
+  initProcedureOptions(path, options) {
+    const procedure = getRouterContract(this.contract, path);
+    if (!(procedure instanceof ProcedureContract)) {
+      return options;
+    }
+    const base = getPiniaColadaMeta(procedure);
+    if (!base) {
+      return options;
+    }
+    return mergeProcedureUtilsOptions(base, options);
+  }
+}
+
+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 };

package/package.json

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