@orpc/vue-query 0.18.0 → 0.20.0

package/dist/index.js

@@ -47,7 +47,7 @@ function createProcedureUtils(client, path) {
       const input = options?.input;
       return {
         queryKey: computed(() => buildKey(path, { type: "query", input: deepUnref(input) })),
-        queryFn: ({ signal }) => client(deepUnref(input), { signal }),
+        queryFn: ({ signal }) => client(deepUnref(input), { signal, context: deepUnref(options?.context) }),
         ...options
       };
     },
@@ -55,14 +55,14 @@ function createProcedureUtils(client, path) {
       const input = options.input;
       return {
         queryKey: computed(() => buildKey(path, { type: "infinite", input: deepUnref(input) })),
-        queryFn: ({ pageParam, signal }) => client({ ...deepUnref(input), cursor: pageParam }, { signal }),
+        queryFn: ({ pageParam, signal }) => client({ ...deepUnref(input), cursor: pageParam }, { signal, context: deepUnref(options.context) }),
         ...options
       };
     },
-    mutationOptions(options) {
+    mutationOptions(...[options]) {
       return {
         mutationKey: buildKey(path, { type: "mutation" }),
-        mutationFn: (input) => client(input),
+        mutationFn: (input) => client(input, { context: deepUnref(options?.context) }),
         ...options
       };
     }

package/dist/src/types.d.ts

@@ -8,22 +8,34 @@ export type NonUndefinedGuard<T> = T extends undefined ? never : T;
 export type InferCursor<T> = T extends {
     cursor?: any;
 } ? T['cursor'] : never;
-export type QueryOptions<TInput, TOutput, TSelectData> = (undefined extends TInput ? {
+export type QueryOptions<TInput, TOutput, TClientContext, TSelectData> = (undefined extends TInput ? {
     input?: MaybeDeepRef<TInput>;
 } : {
     input: MaybeDeepRef<TInput>;
+}) & (undefined extends TClientContext ? {
+    context?: MaybeDeepRef<TClientContext>;
+} : {
+    context: MaybeDeepRef<TClientContext>;
 }) & SetOptional<{
     [P in keyof QueryObserverOptions<TOutput, DefaultError, TSelectData, TOutput, QueryKey>]: P extends 'enabled' ? MaybeRefOrGetter<QueryObserverOptions<TOutput, DefaultError, TSelectData, TOutput, QueryKey>[P]> : MaybeDeepRef<QueryObserverOptions<TOutput, DefaultError, TSelectData, TOutput, QueryKey>[P]>;
 }, 'queryKey'> & {
     shallow?: MaybeRef<boolean>;
     initialData?: NonUndefinedGuard<TOutput> | (() => NonUndefinedGuard<TOutput>) | undefined;
 };
-export type InfiniteOptions<TInput, TOutput, TSelectData> = (undefined extends TInput ? {
+export type InfiniteOptions<TInput, TOutput, TClientContext, TSelectData> = (undefined extends TInput ? {
     input?: MaybeDeepRef<Omit<TInput, 'cursor'>>;
 } : {
     input: MaybeDeepRef<Omit<TInput, 'cursor'>>;
+}) & (undefined extends TClientContext ? {
+    context?: MaybeDeepRef<TClientContext>;
+} : {
+    context: MaybeDeepRef<TClientContext>;
 }) & SetOptional<UseInfiniteQueryOptions<TOutput, DefaultError, TSelectData, TOutput, QueryKey, InferCursor<TInput>>, 'queryKey' | (undefined extends InferCursor<TInput> ? 'initialPageParam' : never)>;
-export type MutationOptions<TInput, TOutput> = {
+export type MutationOptions<TInput, TOutput, TClientContext> = (undefined extends TClientContext ? {
+    context?: MaybeDeepRef<TClientContext>;
+} : {
+    context: MaybeDeepRef<TClientContext>;
+}) & {
     [P in keyof MutationObserverOptions<TOutput, DefaultError, TInput, unknown>]: MaybeDeepRef<MutationObserverOptions<TOutput, DefaultError, TInput, unknown>[P]>;
 } & {
     shallow?: MaybeRef<boolean>;

package/dist/src/utils-procedure.d.ts

@@ -6,20 +6,20 @@ import type { InfiniteOptions, MutationOptions, QueryOptions } from './types';
 /**
  * Utils at procedure level
  */
-export interface ProcedureUtils<TInput, TOutput> {
-    queryOptions: <U extends QueryOptions<TInput, TOutput, any>>(...options: [U] | (undefined extends TInput ? [] : never)) => IsEqual<U, QueryOptions<TInput, TOutput, any>> extends true ? {
+export interface ProcedureUtils<TInput, TOutput, TClientContext> {
+    queryOptions: <U extends QueryOptions<TInput, TOutput, TClientContext, any>>(...opt: [options: U] | (undefined extends TInput & TClientContext ? [] : never)) => IsEqual<U, QueryOptions<TInput, TOutput, TClientContext, any>> extends true ? {
         queryKey: QueryKey;
         queryFn: () => Promise<TOutput>;
     } : Omit<{
         queryKey: ComputedRef<QueryKey>;
         queryFn: () => Promise<TOutput>;
     }, keyof U> & U;
-    infiniteOptions: <U extends InfiniteOptions<TInput, TOutput, any>>(options: U) => Omit<{
+    infiniteOptions: <U extends InfiniteOptions<TInput, TOutput, TClientContext, any>>(options: U) => Omit<{
         queryKey: ComputedRef<QueryKey>;
         queryFn: () => Promise<TOutput>;
         initialPageParam: undefined;
     }, keyof U> & U;
-    mutationOptions: <U extends MutationOptions<TInput, TOutput>>(options?: U) => IsEqual<U, MutationOptions<TInput, TOutput>> extends true ? {
+    mutationOptions: <U extends MutationOptions<TInput, TOutput, TClientContext>>(...opt: [options: U] | (undefined extends TClientContext ? [] : never)) => IsEqual<U, MutationOptions<TInput, TOutput, TClientContext>> extends true ? {
         mutationKey: QueryKey;
         mutationFn: (input: TInput) => Promise<TOutput>;
     } : Omit<{
@@ -27,5 +27,5 @@ export interface ProcedureUtils<TInput, TOutput> {
         mutationFn: (input: TInput) => Promise<TOutput>;
     }, keyof U> & U;
 }
-export declare function createProcedureUtils<TInput, TOutput>(client: ProcedureClient<TInput, TOutput>, path: string[]): ProcedureUtils<TInput, TOutput>;
+export declare function createProcedureUtils<TInput, TOutput, TClientContext>(client: ProcedureClient<TInput, TOutput, TClientContext>, path: string[]): ProcedureUtils<TInput, TOutput, TClientContext>;
 //# sourceMappingURL=utils-procedure.d.ts.map

package/dist/src/utils-router.d.ts

@@ -1,12 +1,12 @@
 import type { ProcedureClient, RouterClient } from '@orpc/server';
 import { type GeneralUtils } from './utils-general';
 import { type ProcedureUtils } from './utils-procedure';
-export type RouterUtils<T extends RouterClient<any>> = T extends ProcedureClient<infer TInput, infer TOutput> ? ProcedureUtils<TInput, TOutput> & GeneralUtils<TInput> : {
-    [K in keyof T]: T[K] extends RouterClient<any> ? RouterUtils<T[K]> : never;
+export type RouterUtils<T extends RouterClient<any, any>> = T extends ProcedureClient<infer TInput, infer TOutput, infer TClientContext> ? ProcedureUtils<TInput, TOutput, TClientContext> & GeneralUtils<TInput> : {
+    [K in keyof T]: T[K] extends RouterClient<any, any> ? RouterUtils<T[K]> : never;
 } & GeneralUtils<unknown>;
 /**
  * @param client - The client create form `@orpc/client`
  * @param path - The base path for query key
  */
-export declare function createRouterUtils<T extends RouterClient<any>>(client: T, path?: string[]): RouterUtils<T>;
+export declare function createRouterUtils<T extends RouterClient<any, any>>(client: T, path?: string[]): RouterUtils<T>;
 //# sourceMappingURL=utils-router.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/vue-query",
   "type": "module",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -34,9 +34,9 @@
   "peerDependencies": {
     "@tanstack/vue-query": ">=5.50.0",
     "vue": ">=3.3.0",
-    "@orpc/contract": "0.18.0",
-    "@orpc/server": "0.18.0",
-    "@orpc/client": "0.18.0"
+    "@orpc/client": "0.20.0",
+    "@orpc/contract": "0.20.0",
+    "@orpc/server": "0.20.0"
   },
   "scripts": {
     "build": "tsup --clean --sourcemap --entry.index=src/index.ts --format=esm --onSuccess='tsc -b --noCheck'",