feat: use of zod validation for tanstack

.changeset/chatty-owls-grow.md

@@ -0,0 +1,5 @@
+---
+"@kubb/swagger-tanstack-query": minor
+---
+
+useQuery with Zod validation

docs/plugins/swagger-tanstack-query/index.md

@@ -365,6 +365,68 @@ export default defineConfig({
 
 :::
 
+### parser
+
+Which parser can be used before returning the data to `@tanstack/query`.
+
+`'zod'` will use `@kubb/swagger-zod` to parse the data. <br/>
+
+::: info type
+
+::: code-group
+
+```typescript ['zod']
+export function getPetByIdQueryOptions() {
+  const queryKey = getPetByIdQueryKey(petId)
+  return {
+    queryKey,
+    queryFn: async () => {
+      const res = await client({
+        method: 'get',
+        url: `/pet/${petId}`,
+      })
+
+      return getPetByIdQueryResponseSchema.parse(res.data)
+    },
+  }
+}
+```
+
+:::
+
+::: info
+
+Type: `'zod'` <br/>
+
+::: code-group
+
+```typescript ['zod']
+import { defineConfig } from '@kubb/core'
+import createSwagger from '@kubb/swagger'
+import createSwaggerTanstackQuery from '@kubb/swagger-tanstack-query'
+import createSwaggerTS from '@kubb/swagger-ts'
+
+export default defineConfig({
+  input: {
+    path: './petStore.yaml',
+  },
+  output: {
+    path: './src/gen',
+  },
+  plugins: [
+    createSwagger({ output: false }),
+    createSwaggerTS({}),
+    createSwaggerTanstackQuery(
+      {
+        parser: 'zod',
+      },
+    ),
+  ],
+})
+```
+
+:::
+
 ### framework
 
 Framework to be generated for.

examples/advanced/configs/kubb.config.ts

@@ -84,6 +84,7 @@ export default defineConfig(async () => {
           },
           infinite: {},
           dataReturnType: 'full',
+          parser: 'zod',
         },
       ],
       [

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts

@@ -1,3 +1,4 @@
+import { findPetsByStatusQueryResponseSchema } from '../../../zod/petController/findPetsByStatusSchema'
 import client from '../../../../tanstack-query-client.ts'
 import { useQuery, useInfiniteQuery } from '@tanstack/react-query'
 import type { FindPetsByStatusQueryResponse, FindPetsByStatusQueryParams, FindPetsByStatus400 } from '../../../models/ts/petController/FindPetsByStatus'
@@ -41,7 +42,7 @@ export function findPetsByStatusQueryOptions<TData = FindPetsByStatus['response'
         params,
         ...options,
       })
-      return res
+      return { ...res, data: findPetsByStatusQueryResponseSchema.parse(res.data) }
     },
   }
 }
@@ -92,7 +93,7 @@ export function findPetsByStatusInfiniteQueryOptions<TData = FindPetsByStatus['r
           ...(options.params || {}),
         },
       })
-      return res
+      return { ...res, data: findPetsByStatusQueryResponseSchema.parse(res.data) }
     },
   }
 }

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts

@@ -1,3 +1,4 @@
+import { findPetsByTagsQueryResponseSchema } from '../../../zod/petController/findPetsByTagsSchema'
 import client from '../../../../tanstack-query-client.ts'
 import { useQuery, useInfiniteQuery } from '@tanstack/react-query'
 import type {
@@ -48,7 +49,7 @@ export function findPetsByTagsQueryOptions<TData = FindPetsByTags['response'], T
         headers: { ...headers, ...options.headers },
         ...options,
       })
-      return res
+      return { ...res, data: findPetsByTagsQueryResponseSchema.parse(res.data) }
     },
   }
 }
@@ -100,7 +101,7 @@ export function findPetsByTagsInfiniteQueryOptions<TData = FindPetsByTags['respo
           ...(options.params || {}),
         },
       })
-      return res
+      return { ...res, data: findPetsByTagsQueryResponseSchema.parse(res.data) }
     },
   }
 }

examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts

@@ -1,3 +1,4 @@
+import { getPetByIdQueryResponseSchema } from '../../../zod/petController/getPetByIdSchema'
 import client from '../../../../tanstack-query-client.ts'
 import { useQuery, useInfiniteQuery } from '@tanstack/react-query'
 import type { GetPetByIdQueryResponse, GetPetByIdPathParams, GetPetById400, GetPetById404 } from '../../../models/ts/petController/GetPetById'
@@ -40,7 +41,7 @@ export function getPetByIdQueryOptions<TData = GetPetById['response'], TQueryDat
         url: `/pet/${petId}`,
         ...options,
       })
-      return res
+      return { ...res, data: getPetByIdQueryResponseSchema.parse(res.data) }
     },
   }
 }
@@ -84,7 +85,7 @@ export function getPetByIdInfiniteQueryOptions<TData = GetPetById['response'], T
         url: `/pet/${petId}`,
         ...options,
       })
-      return res
+      return { ...res, data: getPetByIdQueryResponseSchema.parse(res.data) }
     },
   }
 }

examples/advanced/src/gen/clients/hooks/userController/useGetUserByName.ts

@@ -1,3 +1,4 @@
+import { getUserByNameQueryResponseSchema } from '../../../zod/userController/getUserByNameSchema'
 import client from '../../../../tanstack-query-client.ts'
 import { useQuery, useInfiniteQuery } from '@tanstack/react-query'
 import type { GetUserByNameQueryResponse, GetUserByNamePathParams, GetUserByName400, GetUserByName404 } from '../../../models/ts/userController/GetUserByName'
@@ -40,7 +41,7 @@ export function getUserByNameQueryOptions<TData = GetUserByName['response'], TQu
         url: `/user/${username}`,
         ...options,
       })
-      return res
+      return { ...res, data: getUserByNameQueryResponseSchema.parse(res.data) }
     },
   }
 }
@@ -84,7 +85,7 @@ export function getUserByNameInfiniteQueryOptions<TData = GetUserByName['respons
         url: `/user/${username}`,
         ...options,
       })
-      return res
+      return { ...res, data: getUserByNameQueryResponseSchema.parse(res.data) }
     },
   }
 }

examples/advanced/src/gen/clients/hooks/userController/useLoginUser.ts

@@ -1,3 +1,4 @@
+import { loginUserQueryResponseSchema } from '../../../zod/userController/loginUserSchema'
 import client from '../../../../tanstack-query-client.ts'
 import { useQuery, useInfiniteQuery } from '@tanstack/react-query'
 import type { LoginUserQueryResponse, LoginUserQueryParams, LoginUser400 } from '../../../models/ts/userController/LoginUser'
@@ -41,7 +42,7 @@ export function loginUserQueryOptions<TData = LoginUser['response'], TQueryData
         params,
         ...options,
       })
-      return res
+      return { ...res, data: loginUserQueryResponseSchema.parse(res.data) }
     },
   }
 }
@@ -89,7 +90,7 @@ export function loginUserInfiniteQueryOptions<TData = LoginUser['response'], TQu
           ...(options.params || {}),
         },
       })
-      return res
+      return { ...res, data: loginUserQueryResponseSchema.parse(res.data) }
     },
   }
 }

examples/advanced/src/gen/clients/hooks/userController/useLogoutUser.ts

@@ -1,3 +1,4 @@
+import { logoutUserQueryResponseSchema } from '../../../zod/userController/logoutUserSchema'
 import client from '../../../../tanstack-query-client.ts'
 import { useQuery, useInfiniteQuery } from '@tanstack/react-query'
 import type { LogoutUserQueryResponse, LogoutUserError } from '../../../models/ts/userController/LogoutUser'
@@ -39,7 +40,7 @@ export function logoutUserQueryOptions<TData = LogoutUser['response'], TQueryDat
         url: `/user/logout`,
         ...options,
       })
-      return res
+      return { ...res, data: logoutUserQueryResponseSchema.parse(res.data) }
     },
   }
 }
@@ -78,7 +79,7 @@ export function logoutUserInfiniteQueryOptions<TData = LogoutUser['response'], T
         url: `/user/logout`,
         ...options,
       })
-      return res
+      return { ...res, data: logoutUserQueryResponseSchema.parse(res.data) }
     },
   }
 }

examples/advanced/src/gen/zod/addressSchema.ts

@@ -5,4 +5,4 @@ export const addressSchema = z.object({
   'city': z.string().optional(),
   'state': z.string().optional(),
   'zip': z.string().optional(),
-}).optional()
+})

examples/advanced/src/gen/zod/apiResponseSchema.ts

@@ -1,3 +1,3 @@
 import { z } from 'zod'
 
-export const apiResponseSchema = z.object({ 'code': z.number().optional(), 'type': z.string().optional(), 'message': z.string().optional() }).optional()
+export const apiResponseSchema = z.object({ 'code': z.number().optional(), 'type': z.string().optional(), 'message': z.string().optional() })

examples/advanced/src/gen/zod/categorySchema.ts

@@ -1,3 +1,3 @@
 import { z } from 'zod'
 
-export const categorySchema = z.object({ 'id': z.number().optional(), 'name': z.string().optional() }).optional()
+export const categorySchema = z.object({ 'id': z.number().optional(), 'name': z.string().optional() })

examples/advanced/src/gen/zod/customerSchema.ts

@@ -5,4 +5,4 @@ export const customerSchema = z.object({
   'id': z.number().optional(),
   'username': z.string().optional(),
   'address': z.array(z.lazy(() => addressSchema)).optional(),
-}).optional()
+})

examples/advanced/src/gen/zod/orderSchema.ts

@@ -8,4 +8,4 @@ export const orderSchema = z.object({
   'status': z.enum([`placed`, `approved`, `delivered`]).describe(`Order Status`).optional(),
   'http_status': z.enum([`ok`, `not_found`]).describe(`HTTP Status`).optional(),
   'complete': z.boolean().optional(),
-}).optional()
+})

examples/advanced/src/gen/zod/petController/addPetSchema.ts

@@ -2,7 +2,7 @@ import { z } from 'zod'
 import { addPetRequestSchema } from '../addPetRequestSchema'
 import { petSchema } from '../petSchema'
 
-export const addPet405Schema = z.object({ 'code': z.number().optional(), 'message': z.string().optional() }).optional()
+export const addPet405Schema = z.object({ 'code': z.number().optional(), 'message': z.string().optional() })
 
 /**
  * @description Create a new pet in the store

examples/advanced/src/gen/zod/petController/deletePetSchema.ts

@@ -4,6 +4,6 @@ import { z } from 'zod'
  * @description Invalid pet value
  */
 export const deletePet400Schema = z.any()
-export const deletePetHeaderParamsSchema = z.object({ 'api_key': z.string().optional() }).optional()
+export const deletePetHeaderParamsSchema = z.object({ 'api_key': z.string().optional() })
 export const deletePetMutationResponseSchema = z.any()
 export const deletePetPathParamsSchema = z.object({ 'petId': z.number().describe(`Pet id to delete`) })

examples/advanced/src/gen/zod/petController/findPetsByStatusSchema.ts

@@ -7,7 +7,7 @@ import { petSchema } from '../petSchema'
 export const findPetsByStatus400Schema = z.any()
 export const findPetsByStatusQueryParamsSchema = z.object({
   'status': z.enum([`available`, `pending`, `sold`]).default('available').describe(`Status values that need to be considered for filter`).optional(),
-}).optional()
+})
 
 /**
  * @description successful operation

examples/advanced/src/gen/zod/petController/findPetsByTagsSchema.ts

@@ -10,7 +10,7 @@ export const findPetsByTagsQueryParamsSchema = z.object({
   'tags': z.array(z.string()).describe(`Tags to filter by`).optional(),
   'page': z.string().describe(`to request with required page number or pagination`).optional(),
   'pageSize': z.string().describe(`to request with required page size`).optional(),
-}).optional()
+})
 
 /**
  * @description successful operation

examples/advanced/src/gen/zod/petController/updatePetWithFormSchema.ts

@@ -9,4 +9,4 @@ export const updatePetWithFormPathParamsSchema = z.object({ 'petId': z.number().
 export const updatePetWithFormQueryParamsSchema = z.object({
   'name': z.string().describe(`Name of pet that needs to be updated`).optional(),
   'status': z.string().describe(`Status of pet that needs to be updated`).optional(),
-}).optional()
+})

examples/advanced/src/gen/zod/petController/uploadFileSchema.ts

@@ -3,7 +3,7 @@ import { apiResponseSchema } from '../apiResponseSchema'
 
 export const uploadFileMutationRequestSchema = z.string()
 export const uploadFilePathParamsSchema = z.object({ 'petId': z.number().describe(`ID of pet to update`) })
-export const uploadFileQueryParamsSchema = z.object({ 'additionalMetadata': z.string().describe(`Additional Metadata`).optional() }).optional()
+export const uploadFileQueryParamsSchema = z.object({ 'additionalMetadata': z.string().describe(`Additional Metadata`).optional() })
 
 /**
  * @description successful operation

examples/advanced/src/gen/zod/petNotFoundSchema.ts

@@ -1,3 +1,3 @@
 import { z } from 'zod'
 
-export const petNotFoundSchema = z.object({ 'code': z.number().optional(), 'message': z.string().optional() }).optional()
+export const petNotFoundSchema = z.object({ 'code': z.number().optional(), 'message': z.string().optional() })

examples/advanced/src/gen/zod/petsController/createPetsSchema.ts

@@ -9,7 +9,7 @@ export const createPetsHeaderParamsSchema = z.object({ 'X-EXAMPLE': z.enum([`ONE
 export const createPetsMutationRequestSchema = z.object({ 'name': z.string(), 'tag': z.string() })
 export const createPetsMutationResponseSchema = z.any()
 export const createPetsPathParamsSchema = z.object({ 'uuid': z.string().describe(`UUID`) })
-export const createPetsQueryParamsSchema = z.object({ 'offset': z.number().describe(`Offset`).optional() }).optional()
+export const createPetsQueryParamsSchema = z.object({ 'offset': z.number().describe(`Offset`).optional() })
 
 /**
  * @description unexpected error

examples/advanced/src/gen/zod/tagSchema.ts

@@ -1,3 +1,3 @@
 import { z } from 'zod'
 
-export const tagSchema = z.object({ 'id': z.number().optional(), 'name': z.string().optional() }).optional()
+export const tagSchema = z.object({ 'id': z.number().optional(), 'name': z.string().optional() })

examples/advanced/src/gen/zod/userController/loginUserSchema.ts

@@ -7,7 +7,7 @@ export const loginUser400Schema = z.any()
 export const loginUserQueryParamsSchema = z.object({
   'username': z.string().describe(`The user name for login`).optional(),
   'password': z.string().describe(`The password for login in clear text`).optional(),
-}).optional()
+})
 
 /**
  * @description successful operation

examples/advanced/src/gen/zod/userSchema.ts

@@ -9,4 +9,4 @@ export const userSchema = z.object({
   'password': z.string().optional(),
   'phone': z.string().optional(),
   'userStatus': z.number().describe(`User Status`).optional(),
-}).optional()
+})