[react-query] type-safe Query and Mutation keys

[Akuukis]

React Query added support to type Query and Mutation keys in #8521:

Typing query and mutation keys

Registering the query and mutation key types

Also similarly to registering a global error type, you can also register a global QueryKey and MutationKey type. This allows you to provide more structure to your keys, that matches your application's hierarchy, and have them be typed across all of the library's surface area. Note that the registered type must extend the Array type, so that your keys remain an array.

import '@tanstack/react-query'

type QueryKey = ['dashboard' | 'marketing', ...ReadonlyArray<unknown>]

declare module '@tanstack/react-query' {
  interface Register {
    queryKey: QueryKey
    mutationKey: QueryKey
  }
}

Let's add support for that in Orval? It would allow for a simple and type-safe custom options per-mutation, e.g.

export const getCustomMutatorOptions = (options: Redacted): Redacted => {
  switch(options.mutationKey) {
    case('catCreate'): {
      // Add mutation specific invalidation, etc.
    }
    case('catDestroy'): {
      // Add mutation specific invalidation, etc.
    }
    ...
  }
}

cc:

• Invalidation from Mutations #506
• Add a react-query default mutationKey that is the name of the mutation function (e.g. useCreateUser) #1249
• Customize default query keys #243