feat: Support generating mutations with @kubb/plugin-solid-query

Author: stijnvanhulle

.changeset/whole-pants-beam.md

@@ -0,0 +1,5 @@
+---
+"@kubb/plugin-solid-query": patch
+---
+
+Support generating mutations with @kubb/plugin-solid-query

examples/solid-query/src/gen/hooks/createUpdatePetWithForm.ts

@@ -12,7 +12,7 @@ import type {
 } from '../models/UpdatePetWithForm.ts'
 import type { RequestConfig, ResponseErrorConfig } from '@kubb/plugin-client/clients/axios'
 import type { QueryKey, QueryClient, UseBaseQueryOptions, UseQueryResult } from '@tanstack/solid-query'
-import { queryOptions, createQuery } from '@tanstack/solid-query'
+import { queryOptions, useQuery } from '@tanstack/solid-query'
 
 export const updatePetWithFormQueryKey = (petId: UpdatePetWithFormPathParams['petId'], params?: UpdatePetWithFormQueryParams) =>
   [{ url: '/pet/:petId', params: { petId: petId } }, ...(params ? [params] : [])] as const
@@ -77,7 +77,7 @@ export function createUpdatePetWithForm<
   const { client: queryClient, ...queryOptions } = queryConfig
   const queryKey = queryOptions?.queryKey ?? updatePetWithFormQueryKey(petId, params)
 
-  const query = createQuery(
+  const query = useQuery(
     () => ({
       ...(updatePetWithFormQueryOptions(petId, params, config) as unknown as UseBaseQueryOptions),
       queryKey,

examples/solid-query/src/gen/hooks/index.ts

@@ -7,6 +7,17 @@ export type { GetUserByNameQueryKey } from './createGetUserByName.ts'
 export type { LoginUserQueryKey } from './createLoginUser.ts'
 export type { LogoutUserQueryKey } from './createLogoutUser.ts'
 export type { UpdatePetWithFormQueryKey } from './createUpdatePetWithForm.ts'
+export type { AddPetMutationKey } from './useAddPet.ts'
+export type { CreateUserMutationKey } from './useCreateUser.ts'
+export type { CreateUsersWithListInputMutationKey } from './useCreateUsersWithListInput.ts'
+export type { DeleteOrderMutationKey } from './useDeleteOrder.ts'
+export type { DeletePetMutationKey } from './useDeletePet.ts'
+export type { DeleteUserMutationKey } from './useDeleteUser.ts'
+export type { PlaceOrderMutationKey } from './usePlaceOrder.ts'
+export type { PlaceOrderPatchMutationKey } from './usePlaceOrderPatch.ts'
+export type { UpdatePetMutationKey } from './useUpdatePet.ts'
+export type { UpdateUserMutationKey } from './useUpdateUser.ts'
+export type { UploadFileMutationKey } from './useUploadFile.ts'
 export { findPetsByStatusQueryKey, findPetsByStatus, findPetsByStatusQueryOptions } from './createFindPetsByStatus.ts'
 export { findPetsByTagsQueryKey, findPetsByTags, findPetsByTagsQueryOptions } from './createFindPetsByTags.ts'
 export { getInventoryQueryKey, getInventory, getInventoryQueryOptions } from './createGetInventory.ts'
@@ -16,3 +27,14 @@ export { getUserByNameQueryKey, getUserByName, getUserByNameQueryOptions } from
 export { loginUserQueryKey, loginUser, loginUserQueryOptions } from './createLoginUser.ts'
 export { logoutUserQueryKey, logoutUser, logoutUserQueryOptions } from './createLogoutUser.ts'
 export { updatePetWithFormQueryKey, updatePetWithForm, updatePetWithFormQueryOptions, createUpdatePetWithForm } from './createUpdatePetWithForm.ts'
+export { addPetMutationKey, addPet, useAddPet } from './useAddPet.ts'
+export { createUserMutationKey, createUser, useCreateUser } from './useCreateUser.ts'
+export { createUsersWithListInputMutationKey, createUsersWithListInput, useCreateUsersWithListInput } from './useCreateUsersWithListInput.ts'
+export { deleteOrderMutationKey, deleteOrder, useDeleteOrder } from './useDeleteOrder.ts'
+export { deletePetMutationKey, deletePet, useDeletePet } from './useDeletePet.ts'
+export { deleteUserMutationKey, deleteUser, useDeleteUser } from './useDeleteUser.ts'
+export { placeOrderMutationKey, placeOrder, usePlaceOrder } from './usePlaceOrder.ts'
+export { placeOrderPatchMutationKey, placeOrderPatch, usePlaceOrderPatch } from './usePlaceOrderPatch.ts'
+export { updatePetMutationKey, updatePet, useUpdatePet } from './useUpdatePet.ts'
+export { updateUserMutationKey, updateUser, useUpdateUser } from './useUpdateUser.ts'
+export { uploadFileMutationKey, uploadFile, useUploadFile } from './useUploadFile.ts'

examples/solid-query/src/gen/hooks/useAddPet.ts

@@ -0,0 +1,62 @@
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+
+import fetch from '@kubb/plugin-client/clients/axios'
+import type { AddPetMutationRequest, AddPetMutationResponse, AddPet405 } from '../models/AddPet.ts'
+import type { RequestConfig, ResponseErrorConfig } from '@kubb/plugin-client/clients/axios'
+import type { UseMutationOptions, QueryClient } from '@tanstack/solid-query'
+import { useMutation } from '@tanstack/solid-query'
+
+export const addPetMutationKey = () => [{ url: '/pet' }] as const
+
+export type AddPetMutationKey = ReturnType<typeof addPetMutationKey>
+
+/**
+ * @description Add a new pet to the store
+ * @summary Add a new pet to the store
+ * {@link /pet}
+ */
+export async function addPet(data: AddPetMutationRequest, config: Partial<RequestConfig<AddPetMutationRequest>> & { client?: typeof fetch } = {}) {
+  const { client: request = fetch, ...requestConfig } = config
+
+  const requestData = data
+
+  const res = await request<AddPetMutationResponse, ResponseErrorConfig<AddPet405>, AddPetMutationRequest>({
+    method: 'POST',
+    url: '/pet',
+    data: requestData,
+    ...requestConfig,
+  })
+  return res.data
+}
+
+/**
+ * @description Add a new pet to the store
+ * @summary Add a new pet to the store
+ * {@link /pet}
+ */
+export function useAddPet<TContext>(
+  options: {
+    mutation?: ReturnType<UseMutationOptions<AddPetMutationResponse, ResponseErrorConfig<AddPet405>, { data: AddPetMutationRequest }, TContext>> & {
+      client?: QueryClient
+    }
+    client?: Partial<RequestConfig<AddPetMutationRequest>> & { client?: typeof fetch }
+  } = {},
+) {
+  const { mutation = {}, client: config = {} } = options ?? {}
+  const { client: queryClient, ...mutationOptions } = mutation
+  const mutationKey = mutationOptions.mutationKey ?? addPetMutationKey()
+
+  return useMutation<AddPetMutationResponse, ResponseErrorConfig<AddPet405>, { data: AddPetMutationRequest }, TContext>(
+    () => ({
+      mutationFn: async ({ data }) => {
+        return addPet(data, config)
+      },
+      mutationKey,
+      ...mutationOptions,
+    }),
+    queryClient ? () => queryClient : undefined,
+  )
+}

examples/solid-query/src/gen/hooks/useCreateUser.ts

@@ -0,0 +1,62 @@
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+
+import fetch from '@kubb/plugin-client/clients/axios'
+import type { CreateUserMutationRequest, CreateUserMutationResponse } from '../models/CreateUser.ts'
+import type { RequestConfig, ResponseErrorConfig } from '@kubb/plugin-client/clients/axios'
+import type { UseMutationOptions, QueryClient } from '@tanstack/solid-query'
+import { useMutation } from '@tanstack/solid-query'
+
+export const createUserMutationKey = () => [{ url: '/user' }] as const
+
+export type CreateUserMutationKey = ReturnType<typeof createUserMutationKey>
+
+/**
+ * @description This can only be done by the logged in user.
+ * @summary Create user
+ * {@link /user}
+ */
+export async function createUser(data?: CreateUserMutationRequest, config: Partial<RequestConfig<CreateUserMutationRequest>> & { client?: typeof fetch } = {}) {
+  const { client: request = fetch, ...requestConfig } = config
+
+  const requestData = data
+
+  const res = await request<CreateUserMutationResponse, ResponseErrorConfig<Error>, CreateUserMutationRequest>({
+    method: 'POST',
+    url: '/user',
+    data: requestData,
+    ...requestConfig,
+  })
+  return res.data
+}
+
+/**
+ * @description This can only be done by the logged in user.
+ * @summary Create user
+ * {@link /user}
+ */
+export function useCreateUser<TContext>(
+  options: {
+    mutation?: ReturnType<UseMutationOptions<CreateUserMutationResponse, ResponseErrorConfig<Error>, { data?: CreateUserMutationRequest }, TContext>> & {
+      client?: QueryClient
+    }
+    client?: Partial<RequestConfig<CreateUserMutationRequest>> & { client?: typeof fetch }
+  } = {},
+) {
+  const { mutation = {}, client: config = {} } = options ?? {}
+  const { client: queryClient, ...mutationOptions } = mutation
+  const mutationKey = mutationOptions.mutationKey ?? createUserMutationKey()
+
+  return useMutation<CreateUserMutationResponse, ResponseErrorConfig<Error>, { data?: CreateUserMutationRequest }, TContext>(
+    () => ({
+      mutationFn: async ({ data }) => {
+        return createUser(data, config)
+      },
+      mutationKey,
+      ...mutationOptions,
+    }),
+    queryClient ? () => queryClient : undefined,
+  )
+}

examples/solid-query/src/gen/hooks/useCreateUsersWithListInput.ts

@@ -0,0 +1,65 @@
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+
+import fetch from '@kubb/plugin-client/clients/axios'
+import type { CreateUsersWithListInputMutationRequest, CreateUsersWithListInputMutationResponse } from '../models/CreateUsersWithListInput.ts'
+import type { RequestConfig, ResponseErrorConfig } from '@kubb/plugin-client/clients/axios'
+import type { UseMutationOptions, QueryClient } from '@tanstack/solid-query'
+import { useMutation } from '@tanstack/solid-query'
+
+export const createUsersWithListInputMutationKey = () => [{ url: '/user/createWithList' }] as const
+
+export type CreateUsersWithListInputMutationKey = ReturnType<typeof createUsersWithListInputMutationKey>
+
+/**
+ * @description Creates list of users with given input array
+ * @summary Creates list of users with given input array
+ * {@link /user/createWithList}
+ */
+export async function createUsersWithListInput(
+  data?: CreateUsersWithListInputMutationRequest,
+  config: Partial<RequestConfig<CreateUsersWithListInputMutationRequest>> & { client?: typeof fetch } = {},
+) {
+  const { client: request = fetch, ...requestConfig } = config
+
+  const requestData = data
+
+  const res = await request<CreateUsersWithListInputMutationResponse, ResponseErrorConfig<Error>, CreateUsersWithListInputMutationRequest>({
+    method: 'POST',
+    url: '/user/createWithList',
+    data: requestData,
+    ...requestConfig,
+  })
+  return res.data
+}
+
+/**
+ * @description Creates list of users with given input array
+ * @summary Creates list of users with given input array
+ * {@link /user/createWithList}
+ */
+export function useCreateUsersWithListInput<TContext>(
+  options: {
+    mutation?: ReturnType<
+      UseMutationOptions<CreateUsersWithListInputMutationResponse, ResponseErrorConfig<Error>, { data?: CreateUsersWithListInputMutationRequest }, TContext>
+    > & { client?: QueryClient }
+    client?: Partial<RequestConfig<CreateUsersWithListInputMutationRequest>> & { client?: typeof fetch }
+  } = {},
+) {
+  const { mutation = {}, client: config = {} } = options ?? {}
+  const { client: queryClient, ...mutationOptions } = mutation
+  const mutationKey = mutationOptions.mutationKey ?? createUsersWithListInputMutationKey()
+
+  return useMutation<CreateUsersWithListInputMutationResponse, ResponseErrorConfig<Error>, { data?: CreateUsersWithListInputMutationRequest }, TContext>(
+    () => ({
+      mutationFn: async ({ data }) => {
+        return createUsersWithListInput(data, config)
+      },
+      mutationKey,
+      ...mutationOptions,
+    }),
+    queryClient ? () => queryClient : undefined,
+  )
+}

examples/solid-query/src/gen/hooks/useDeleteOrder.ts

@@ -0,0 +1,69 @@
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+
+import fetch from '@kubb/plugin-client/clients/axios'
+import type { DeleteOrderMutationResponse, DeleteOrderPathParams, DeleteOrder400, DeleteOrder404 } from '../models/DeleteOrder.ts'
+import type { RequestConfig, ResponseErrorConfig } from '@kubb/plugin-client/clients/axios'
+import type { UseMutationOptions, QueryClient } from '@tanstack/solid-query'
+import { useMutation } from '@tanstack/solid-query'
+
+export const deleteOrderMutationKey = () => [{ url: '/store/order/:orderId' }] as const
+
+export type DeleteOrderMutationKey = ReturnType<typeof deleteOrderMutationKey>
+
+/**
+ * @description For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
+ * @summary Delete purchase order by ID
+ * {@link /store/order/:orderId}
+ */
+export async function deleteOrder(orderId: DeleteOrderPathParams['orderId'], config: Partial<RequestConfig> & { client?: typeof fetch } = {}) {
+  const { client: request = fetch, ...requestConfig } = config
+
+  const res = await request<DeleteOrderMutationResponse, ResponseErrorConfig<DeleteOrder400 | DeleteOrder404>, unknown>({
+    method: 'DELETE',
+    url: `/store/order/${orderId}`,
+    ...requestConfig,
+  })
+  return res.data
+}
+
+/**
+ * @description For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
+ * @summary Delete purchase order by ID
+ * {@link /store/order/:orderId}
+ */
+export function useDeleteOrder<TContext>(
+  options: {
+    mutation?: ReturnType<
+      UseMutationOptions<
+        DeleteOrderMutationResponse,
+        ResponseErrorConfig<DeleteOrder400 | DeleteOrder404>,
+        { orderId: DeleteOrderPathParams['orderId'] },
+        TContext
+      >
+    > & { client?: QueryClient }
+    client?: Partial<RequestConfig> & { client?: typeof fetch }
+  } = {},
+) {
+  const { mutation = {}, client: config = {} } = options ?? {}
+  const { client: queryClient, ...mutationOptions } = mutation
+  const mutationKey = mutationOptions.mutationKey ?? deleteOrderMutationKey()
+
+  return useMutation<
+    DeleteOrderMutationResponse,
+    ResponseErrorConfig<DeleteOrder400 | DeleteOrder404>,
+    { orderId: DeleteOrderPathParams['orderId'] },
+    TContext
+  >(
+    () => ({
+      mutationFn: async ({ orderId }) => {
+        return deleteOrder(orderId, config)
+      },
+      mutationKey,
+      ...mutationOptions,
+    }),
+    queryClient ? () => queryClient : undefined,
+  )
+}

examples/solid-query/src/gen/hooks/useDeletePet.ts

@@ -0,0 +1,74 @@
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+
+import fetch from '@kubb/plugin-client/clients/axios'
+import type { DeletePetMutationResponse, DeletePetPathParams, DeletePetHeaderParams, DeletePet400 } from '../models/DeletePet.ts'
+import type { RequestConfig, ResponseErrorConfig } from '@kubb/plugin-client/clients/axios'
+import type { UseMutationOptions, QueryClient } from '@tanstack/solid-query'
+import { useMutation } from '@tanstack/solid-query'
+
+export const deletePetMutationKey = () => [{ url: '/pet/:petId' }] as const
+
+export type DeletePetMutationKey = ReturnType<typeof deletePetMutationKey>
+
+/**
+ * @description delete a pet
+ * @summary Deletes a pet
+ * {@link /pet/:petId}
+ */
+export async function deletePet(
+  petId: DeletePetPathParams['petId'],
+  headers?: DeletePetHeaderParams,
+  config: Partial<RequestConfig> & { client?: typeof fetch } = {},
+) {
+  const { client: request = fetch, ...requestConfig } = config
+
+  const res = await request<DeletePetMutationResponse, ResponseErrorConfig<DeletePet400>, unknown>({
+    method: 'DELETE',
+    url: `/pet/${petId}`,
+    ...requestConfig,
+    headers: { ...headers, ...requestConfig.headers },
+  })
+  return res.data
+}
+
+/**
+ * @description delete a pet
+ * @summary Deletes a pet
+ * {@link /pet/:petId}
+ */
+export function useDeletePet<TContext>(
+  options: {
+    mutation?: ReturnType<
+      UseMutationOptions<
+        DeletePetMutationResponse,
+        ResponseErrorConfig<DeletePet400>,
+        { petId: DeletePetPathParams['petId']; headers?: DeletePetHeaderParams },
+        TContext
+      >
+    > & { client?: QueryClient }
+    client?: Partial<RequestConfig> & { client?: typeof fetch }
+  } = {},
+) {
+  const { mutation = {}, client: config = {} } = options ?? {}
+  const { client: queryClient, ...mutationOptions } = mutation
+  const mutationKey = mutationOptions.mutationKey ?? deletePetMutationKey()
+
+  return useMutation<
+    DeletePetMutationResponse,
+    ResponseErrorConfig<DeletePet400>,
+    { petId: DeletePetPathParams['petId']; headers?: DeletePetHeaderParams },
+    TContext
+  >(
+    () => ({
+      mutationFn: async ({ petId, headers }) => {
+        return deletePet(petId, headers, config)
+      },
+      mutationKey,
+      ...mutationOptions,
+    }),
+    queryClient ? () => queryClient : undefined,
+  )
+}