SolidJS + Solid (Tanstack) Query type requires fields in mutate that are already provided by createMutation

[mezuzza]

Description

I'm using solid js, openapi-ts, and solid-query together. Obviously not the most common stack in the world, but I'm running into a small problem. The api takes both a path parameter (id) and a body with two fields. All are required. When I create the API and provide the path parameter up front while inserting the body parameters later, typescript fails.

  const clearData = createMutation(() => ({
    ...clearDataMutation({
      path: {
        id: params.id,
      },
    }),
    onSuccess: (data) => {
      queryClient.setQueryData(queryKey, updater);
    },
  }));

  clearData.mutate({ // is not assignable to parameter of type 'Options<ClearDataData>'. Property 'path' is missing in type ...
    body: {
        field1: 1,
        field2: 2,
    },
  });

The provided fields need to be excluded or made optional from the signature of the mutate method.

Reproducible example or configuration

https://stackblitz.com/edit/hey-api-client-fetch-example

OpenAPI specification (optional)

No response

System information (optional)

No response

[bolt-new-by-stackblitz]

Start a new pull request in StackBlitz Codeflow.

• hey-api-client-fetch-example (Open reproduction)

[mrlubos]

@mezuzza if you were to remove the generated code and annotate the TanStack Query function manually with a generated type, would it still show an error? Trying to determine whether this is an issue with the package typing or a TypeScript/TanStack limitation

[Redmega]

This is also an issue with the ReactJS version of the libs, my updateThingMutation() to generate options has path as optional, but the mutate() function from the query has it as required, when I think that should be inversed.

Edit: It seems like the mutationFn variables is correctly typed as localOptions (Partial<Options<UpdateThingData>>) but because we are strictly typing mutationOptions as

UseMutationOptions<UpdateThingResponse, UpdateThingError, Options<UpdateThingData>>

that it overrides the inferred typing. I think Options<UpdateThingData> there (third type param) needs to make path optional but require body/query/etc., and then the options param of the parent updateThingMutation needs to not be Partial<Options<...>> but instead an object that only requires path (which is not likely to change)?