fix(angular-query): align mutation options to most recent react-query types (#9543)

* fix(angular-query): align mutation options to most recent react-query types

* add tests

Author: arnoud-dv

packages/angular-query-experimental/src/__tests__/mutation-options.test-d.ts

@@ -1,33 +1,199 @@
-import { assertType, describe, expectTypeOf, test } from 'vitest'
-import { mutationOptions } from '../mutation-options'
+import { assertType, describe, expectTypeOf, it } from 'vitest'
+import { QueryClient } from '@tanstack/query-core'
+import {
+  injectIsMutating,
+  injectMutation,
+  injectMutationState,
+  mutationOptions,
+} from '..'
+import type {
+  DefaultError,
+  MutationState,
+  WithRequired,
+} from '@tanstack/query-core'
+import type { CreateMutationOptions, CreateMutationResult } from '../types'
 
 describe('mutationOptions', () => {
-  test('should not allow excess properties', () => {
-    assertType<Parameters<typeof mutationOptions>>([
-      {
-        mutationFn: () => Promise.resolve(5),
-        mutationKey: ['key'],
-        // @ts-expect-error this is a good error, because onMutates does not exist!
-        onMutates: 1000,
+  it('should not allow excess properties', () => {
+    // @ts-expect-error this is a good error, because onMutates does not exist!
+    mutationOptions({
+      mutationFn: () => Promise.resolve(5),
+      mutationKey: ['key'],
+      onMutates: 1000,
+      onSuccess: (data) => {
+        expectTypeOf(data).toEqualTypeOf<number>()
       },
-    ])
-    assertType<Parameters<typeof mutationOptions>>([
-      {
-        mutationFn: () => Promise.resolve(5),
-        mutationKey: ['key'],
-        // @ts-expect-error this is a good error, because onMutates does not exist!
-        onMutates: 1000,
+    })
+  })
+
+  it('should infer types for callbacks', () => {
+    mutationOptions({
+      mutationFn: () => Promise.resolve(5),
+      mutationKey: ['key'],
+      onSuccess: (data) => {
+        expectTypeOf(data).toEqualTypeOf<number>()
       },
-    ])
+    })
   })
 
-  test('should infer types for callbacks', () => {
+  it('should infer types for onError callback', () => {
     mutationOptions({
+      mutationFn: () => {
+        throw new Error('fail')
+      },
+      mutationKey: ['key'],
+      onError: (error) => {
+        expectTypeOf(error).toEqualTypeOf<DefaultError>()
+      },
+    })
+  })
+
+  it('should infer types for variables', () => {
+    mutationOptions<number, DefaultError, { id: string }>({
+      mutationFn: (vars) => {
+        expectTypeOf(vars).toEqualTypeOf<{ id: string }>()
+        return Promise.resolve(5)
+      },
+      mutationKey: ['with-vars'],
+    })
+  })
+
+  it('should infer context type correctly', () => {
+    mutationOptions<number, DefaultError, void, { name: string }>({
       mutationFn: () => Promise.resolve(5),
       mutationKey: ['key'],
+      onMutate: () => {
+        return { name: 'context' }
+      },
+      onSuccess: (_data, _variables, context) => {
+        expectTypeOf(context).toEqualTypeOf<{ name: string }>()
+      },
+    })
+  })
+
+  it('should error if mutationFn return type mismatches TData', () => {
+    assertType(
+      mutationOptions<number>({
+        // @ts-expect-error this is a good error, because return type is string, not number
+        mutationFn: async () => Promise.resolve('wrong return'),
+      }),
+    )
+  })
+
+  it('should allow mutationKey to be omitted', () => {
+    return mutationOptions({
+      mutationFn: () => Promise.resolve(123),
       onSuccess: (data) => {
         expectTypeOf(data).toEqualTypeOf<number>()
       },
     })
   })
+
+  it('should infer all types when not explicitly provided', () => {
+    expectTypeOf(
+      mutationOptions({
+        mutationFn: (id: string) => Promise.resolve(id.length),
+        mutationKey: ['key'],
+        onSuccess: (data) => {
+          expectTypeOf(data).toEqualTypeOf<number>()
+        },
+      }),
+    ).toEqualTypeOf<
+      WithRequired<
+        CreateMutationOptions<number, DefaultError, string>,
+        'mutationKey'
+      >
+    >()
+    expectTypeOf(
+      mutationOptions({
+        mutationFn: (id: string) => Promise.resolve(id.length),
+        onSuccess: (data) => {
+          expectTypeOf(data).toEqualTypeOf<number>()
+        },
+      }),
+    ).toEqualTypeOf<
+      Omit<CreateMutationOptions<number, DefaultError, string>, 'mutationKey'>
+    >()
+  })
+
+  it('should infer types when used with injectMutation', () => {
+    const mutation = injectMutation(() =>
+      mutationOptions({
+        mutationKey: ['key'],
+        mutationFn: () => Promise.resolve('data'),
+        onSuccess: (data) => {
+          expectTypeOf(data).toEqualTypeOf<string>()
+        },
+      }),
+    )
+    expectTypeOf(mutation).toEqualTypeOf<
+      CreateMutationResult<string, DefaultError, void, unknown>
+    >()
+
+    injectMutation(
+      // should allow when used with injectMutation without mutationKey
+      () =>
+        mutationOptions({
+          mutationFn: () => Promise.resolve('data'),
+          onSuccess: (data) => {
+            expectTypeOf(data).toEqualTypeOf<string>()
+          },
+        }),
+    )
+  })
+
+  it('should infer types when used with injectIsMutating', () => {
+    const isMutating = injectIsMutating(
+      mutationOptions({
+        mutationKey: ['key'],
+        mutationFn: () => Promise.resolve(5),
+      }),
+    )
+    expectTypeOf(isMutating()).toEqualTypeOf<number>()
+
+    injectIsMutating(
+      // @ts-expect-error filters should have mutationKey
+      mutationOptions({
+        mutationFn: () => Promise.resolve(5),
+      }),
+    )
+  })
+
+  it('should infer types when used with queryClient.isMutating', () => {
+    const queryClient = new QueryClient()
+
+    const isMutating = queryClient.isMutating(
+      mutationOptions({
+        mutationKey: ['key'],
+        mutationFn: () => Promise.resolve(5),
+      }),
+    )
+    expectTypeOf(isMutating).toEqualTypeOf<number>()
+
+    queryClient.isMutating(
+      // @ts-expect-error filters should have mutationKey
+      mutationOptions({
+        mutationFn: () => Promise.resolve(5),
+      }),
+    )
+  })
+
+  it('should infer types when used with injectMutationState', () => {
+    const mutationState = injectMutationState(() => ({
+      filters: mutationOptions({
+        mutationKey: ['key'],
+        mutationFn: () => Promise.resolve(5),
+      }),
+    }))
+    expectTypeOf(mutationState()).toEqualTypeOf<
+      Array<MutationState<unknown, Error, unknown, unknown>>
+    >()
+
+    injectMutationState({
+      // @ts-expect-error filters should have mutationKey
+      filters: mutationOptions({
+        mutationFn: () => Promise.resolve(5),
+      }),
+    })
+  })
 })