fix(vue-colada): correctly infer mutation context (#191)

* fix(vue-colada): correctly infer mutation context

* improve tests

Author: dinwwwh

packages/react-query/src/procedure-utils.test-d.ts

@@ -271,15 +271,6 @@ describe('ProcedureUtils', () => {
       utils.mutationOptions({ context: { batch: 'invalid' } })
     })
 
-    it('infer correct mutation context type', () => {
-      utils.mutationOptions({
-        onMutate: () => ({ mutationContext: true }),
-        onError: (e, v, context) => {
-          expectTypeOf(context).toEqualTypeOf<undefined | { mutationContext: boolean }>()
-        },
-      })
-    })
-
     it('works with useMutation', () => {
       const mutation = useMutation(utils.mutationOptions({
         onSuccess: (data, input) => {
@@ -295,5 +286,19 @@ describe('ProcedureUtils', () => {
       expectTypeOf(mutation.data).toEqualTypeOf<UtilsOutput | undefined>()
       expectTypeOf(mutation.error).toEqualTypeOf<ErrorFromErrorMap<typeof baseErrorMap> | null>()
     })
+
+    it('infer correct mutation context type', () => {
+      useMutation({
+        ...utils.mutationOptions({
+          onMutate: () => ({ mutationContext: true }),
+          onError: (e, v, context) => {
+            expectTypeOf(context?.mutationContext).toEqualTypeOf<undefined | boolean>()
+          },
+        }),
+        onSettled: (d, e, v, context) => {
+          expectTypeOf(context?.mutationContext).toEqualTypeOf<undefined | boolean>()
+        },
+      })
+    })
   })
 })

packages/vue-colada/src/procedure-utils.test-d.ts

@@ -113,5 +113,19 @@ describe('ProcedureUtils', () => {
       expectTypeOf(mutation.data.value).toEqualTypeOf<UtilsOutput | undefined>()
       expectTypeOf(mutation.error.value).toEqualTypeOf<ErrorFromErrorMap<typeof baseErrorMap> | null>()
     })
+
+    it('infer correct mutation context type', () => {
+      useMutation({
+        ...utils.mutationOptions({
+          onMutate: () => ({ mutationContext: true }),
+          onError: (e, v, context) => {
+            expectTypeOf(context.mutationContext).toEqualTypeOf<undefined | boolean>()
+          },
+        }),
+        onSettled: (d, e, v, context) => {
+          expectTypeOf(context.mutationContext).toEqualTypeOf<undefined | boolean>()
+        },
+      })
+    })
   })
 })

packages/vue-colada/src/procedure-utils.ts

@@ -1,5 +1,6 @@
 import type { Client, ClientContext } from '@orpc/client'
 import type { MaybeOptionalOptions } from '@orpc/shared'
+import type { _EmptyObject } from '@pinia/colada'
 import type { MutationOptions, MutationOptionsIn, QueryOptions, QueryOptionsIn } from './types'
 import { computed } from 'vue'
 import { buildKey } from './key'
@@ -14,11 +15,11 @@ export interface ProcedureUtils<TClientContext extends ClientContext, TInput, TO
     >
   ): QueryOptions<TOutput, TError>
 
-  mutationOptions(
+  mutationOptions<UMutationContext extends Record<any, any> = _EmptyObject>(
     ...rest: MaybeOptionalOptions<
-      MutationOptionsIn<TClientContext, TInput, TOutput, TError>
+      MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>
     >
-  ): MutationOptions<TInput, TOutput, TError>
+  ): MutationOptions<TInput, TOutput, TError, UMutationContext>
 }
 
 export function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(

packages/vue-colada/src/types.ts

@@ -20,8 +20,8 @@ export type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput
 
 export type QueryOptions<TOutput, TError extends Error> = UseQueryOptions<TOutput, TError>
 
-export type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> =
+export type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TMutationContext extends Record<any, any>> =
   & (Record<never, never> extends TClientContext ? { context?: MaybeRefDeep<TClientContext> } : { context: MaybeRefDeep<TClientContext> })
-  & SetOptional<UseMutationOptions<TOutput, TInput, TError>, 'mutation'>
+  & SetOptional<UseMutationOptions<TOutput, TInput, TError, TMutationContext>, 'mutation'>
 
-export type MutationOptions<TInput, TOutput, TError extends Error> = UseMutationOptions<TOutput, TInput, TError>
+export type MutationOptions<TInput, TOutput, TError extends Error, TMutationContext extends Record<any, any>> = UseMutationOptions<TOutput, TInput, TError, TMutationContext>

packages/vue-query/src/procedure-utils.test-d.ts

@@ -258,15 +258,6 @@ describe('ProcedureUtils', () => {
       utils.mutationOptions({ context: { batch: 'invalid' } })
     })
 
-    it('infer correct mutation context type', () => {
-      utils.mutationOptions({
-        onMutate: () => ({ mutationContext: true }),
-        onError: (e, v, context) => {
-          expectTypeOf(context).toEqualTypeOf<undefined | { mutationContext: boolean }>()
-        },
-      })
-    })
-
     it('works with useMutation', () => {
       const mutation = useMutation(utils.mutationOptions({
         onSuccess: (data, input) => {
@@ -282,5 +273,19 @@ describe('ProcedureUtils', () => {
       expectTypeOf(mutation.data.value).toEqualTypeOf<UtilsOutput | undefined>()
       expectTypeOf(mutation.error.value).toEqualTypeOf<ErrorFromErrorMap<typeof baseErrorMap> | null>()
     })
+
+    it('infer correct mutation context type', () => {
+      useMutation({
+        ...utils.mutationOptions({
+          onMutate: () => ({ mutationContext: true }),
+          onError: (e, v, context) => {
+            expectTypeOf(context?.mutationContext).toEqualTypeOf<undefined | boolean>()
+          },
+        }),
+        onSettled: (d, e, v, context) => {
+          expectTypeOf(context?.mutationContext).toEqualTypeOf<undefined | boolean>()
+        },
+      })
+    })
   })
 })