feat(query): allow body type customisation through mutator for mutations

[CPatchane]

Status

HOLD

Related PRs

Wait merging PR #318 before merging this one. ✅

Description

Look only at the last commit, the previous ones are from #318.
With those two PRs combined, we're now able to customise via the mutator the return type (see PR #318) (in my example, a server returning snake cased data that we want to camel case in our TS code) but also the body type (this PR) expecting by the operation function (since that the server is expecting snake cased keys, the mutator can handle that case change systematically) through a dedicated and optional type named BodyType.

How it works

In the mutator, we can export a type named BodyType like following (similar to what we can do for ErrorType):

// ./custom-mutator.ts
export type BodyType<BodyData> = CamelCase<BodyData>

Then, it will generated for the mutation:

export const postMyDemo = (id: string, postMyDemoBody: BodyType<PostMyDemoBody>) => {
  return apiClient<void>({
    url: `/my/demo`,
    method: "post",
    data: postMyDemoBody,
  })
}

export type PostMyDemoMutationResult = NonNullable<AsyncReturnType<typeof postMyDemo>>
export type PostMyDemoMutationBody = BodyType<PostMyDemoBody>
export type PostMyDemoMutationError = unknown

export const usePostMyDemo = <TError = unknown,  TContext = unknown>(
options?: {
  mutation?: UseMutationOptions<
    AsyncReturnType<typeof postMyDemo>,
    TError,
    {
      id: string
      data: BodyType<PostMyDemoBody>
    },
    TContext
  >
}) => {
  const { mutation: mutationOptions } = options || {}

  const mutationFn: MutationFunction<
    AsyncReturnType<typeof postMyDemo>,
    {
      id: string
      data: BodyType<PostMyDemoBody>
    }
  > = (props) => {
    const { id, data } = props || {}

    return postMyDemo(id, data)
  }

  return useMutation<
    AsyncReturnType<typeof postMyDemo>,
    TError,
    {
      id: string
      data: BodyType<PostMyDemoBody>
    },
    TContext
  >(mutationFn, mutationOptions)
}

Wdyt?
It might not be related to this PR but I personally think we might need more tests (with a snapshotting system?), at least to be able to see when a fix/feature is added how this is impacting the different scenarios because I think that TS won't be able catch everything imho.

[vercel]

Someone is attempting to deploy a commit to a Personal Account owned by @anymaniax on Vercel.

@anymaniax first needs to authorize it.

[melloware]

Again since this is adding new code I think this is another good improvement.

[anymaniax]

What is the status of this one? Since the other one is merged

[CPatchane]

I'll rework that one to take into account the changes from the other one, I'll ping you back when it's done :)

[anymaniax]

ok thanks for the great work on this again

[CPatchane]

@anymaniax I had to update the samples due to the last PR too.
I did the changes to handle BodyType, but it will work only for queries with custom clients. I don't think we need it for the other clients but I might be wrong. Wdyt?

[CPatchane]

you don't handle the case where you only have the bodyTypName no?

Good catch, I just pushed a fix :)

[CPatchane]

I updated the samples and add a new generated test named "custom-client" allowing to test the BodyType usage. Let me know if it's good :)

[anymaniax]

Thanks 🎉! Will do a release soon