feat: mapper and schemaTransformer (#676)

* feat: mapper and schemaTransformer

* feat: use of Query and Mutation omponent for swagger-faker

* feat: add 'root' to KubbFile.Import

* chore: update ts and zod package with React components

* chore: update examples

* chore: camelcase/pascalcase transformers

* chore: fixes

* chore: pack updates

* feat: transformers subpackage

* chore: cleanup

* chore: jsdoc with tsFactory

* chore: fix snap

* chore(zod): example for mapper

.changeset/bright-needles-move.md

@@ -0,0 +1,5 @@
+---
+"@kubb/swagger-faker": patch
+---
+
+feat: use of Query and Mutation omponent for swagger-faker

.changeset/khaki-crews-act.md

@@ -0,0 +1,5 @@
+---
+"@kubb/swagger-faker": patch
+---
+
+mapper and transformers.schema to override default fakerParser

.changeset/large-melons-try.md

@@ -0,0 +1,5 @@
+---
+"@kubb/core": major
+---
+
+transformers subpackage

.changeset/lucky-moles-travel.md

@@ -0,0 +1,5 @@
+---
+"@kubb/core": patch
+---
+
+add 'root' to KubbFile.Import

.changeset/old-pandas-teach.md

@@ -1,5 +1,5 @@
 ---
-"@kubb/core": major
+"@kubb/core": patch
 ---
 
 pluginSorter to sort based on pre and post

.changeset/swift-eagles-raise.md

@@ -0,0 +1,6 @@
+---
+"@kubb/react": major
+"@kubb/parser": major
+---
+
+jsdoc with tsFactory

configs/vitest.config.ts

@@ -9,6 +9,7 @@ export default defineConfig({
       '@kubb/eslint-config': 'packages/config/eslint/src/index.ts',
       '@kubb/tsup-config': 'packages/config/tsup/src/index.ts',
       '@kubb/core/utils': 'packages/core/src/utils/index.ts',
+      '@kubb/core/transformers': 'packages/core/src/transformers/index.ts',
       '@kubb/core': 'packages/core/src/index.ts',
       '@kubb/swagger/utils': 'packages/swagger/src/utils/index.ts',
       '@kubb/swagger/hooks': 'packages/swagger/src/hooks/index.ts',

docs/guide/introduction.md

@@ -35,7 +35,7 @@ Kubb is trying to resolve that with a plugin system where we already provide you
 
 Kubb has the following features:
 
-- **Easy to Configure**: One of the goals of Kubb is to provide out-of-the-box plugins and utils for converting your Swagger/OpenAPI file to generated code.<br/><br/>You want to use a Swagger/OpenAPI file or URL, you want to split up the generated code based on a tag in the file, you want to use multiple Swagger/OpenApi files, we have you covered!
+- **Easy to Configure**: One of the goals of Kubb is to provide out-of-the-box plugins and utils for converting your Swagger/OpenAPI file to generated code.<br/><br/>You want to use a Swagger/OpenAPI file or URL, you want to split up the generated code based on a tag in the file, you want to use multiple Swagger/OpenAPI files, we have you covered!
 - **Generate SDK's**: Convert your Swagger/OpenAPI file to TypeScript, React-Query, Zod, Zodios, Faker.js, MSW and Axios.
 - **Templates**: Override/change the generated output of a plugin with the help of [JSX templates(React)](/reference/templates).
 - **Plugin Ecosystem**: Kubb has a [plugin system](/plugins/introdution) that makes it possible to change or add functionalities based on your needs.

docs/package.json

@@ -21,11 +21,11 @@
   "dependencies": {
     "@vercel/analytics": "^1.1.1",
     "sitemap": "^7.1.1",
-    "vitepress": "^1.0.0-rc.29",
+    "vitepress": "^1.0.0-rc.30",
     "vue": "^3.3.8"
   },
   "devDependencies": {
-    "@types/node": "^20.9.4"
+    "@types/node": "^20.10.0"
   },
   "packageManager": "[email protected]",
   "engines": {

eslint.config.js

@@ -34,6 +34,7 @@ export default [
       '@typescript-eslint/no-unsafe-return': 'off',
       '@typescript-eslint/no-unused-vars': 'off',
       '@typescript-eslint/no-unsafe-member-access': 'off',
+      '@typescript-eslint/no-unsafe-argument': 'off',
       'unused-imports/no-unused-vars': 'off',
     },
   },

examples/advanced/src/gen/clients/axios/petService/addPet.ts

@@ -5,8 +5,7 @@ import type { AddPetMutationRequest, AddPetMutationResponse } from '../../../mod
 /**
  * @description Add a new pet to the store
  * @summary Add a new pet to the store
- * @link /pet
- */
+ * @link /pet */
 export async function addPet(
   data: AddPetMutationRequest,
   options: Partial<Parameters<typeof client>[0]> = {},

examples/advanced/src/gen/clients/axios/petService/deletePet.ts

@@ -5,8 +5,7 @@ import type { DeletePetMutationResponse, DeletePetPathParams, DeletePetHeaderPar
 /**
  * @description delete a pet
  * @summary Deletes a pet
- * @link /pet/:petId
- */
+ * @link /pet/:petId */
 export async function deletePet(
   { petId }: DeletePetPathParams,
   headers?: DeletePetHeaderParams,

examples/advanced/src/gen/clients/axios/petService/findPetsByStatus.ts

@@ -5,8 +5,7 @@ import type { FindPetsByStatusQueryResponse, FindPetsByStatusQueryParams } from
 /**
  * @description Multiple status values can be provided with comma separated strings
  * @summary Finds Pets by status
- * @link /pet/findByStatus
- */
+ * @link /pet/findByStatus */
 export async function findPetsByStatus(
   params?: FindPetsByStatusQueryParams,
   options: Partial<Parameters<typeof client>[0]> = {},

examples/advanced/src/gen/clients/axios/petService/findPetsByTags.ts

@@ -5,8 +5,7 @@ import type { FindPetsByTagsQueryResponse, FindPetsByTagsQueryParams, FindPetsBy
 /**
  * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
  * @summary Finds Pets by tags
- * @link /pet/findByTags
- */
+ * @link /pet/findByTags */
 export async function findPetsByTags(
   headers: FindPetsByTagsHeaderParams,
   params?: FindPetsByTagsQueryParams,

examples/advanced/src/gen/clients/axios/petService/getPetById.ts

@@ -5,8 +5,7 @@ import type { GetPetByIdQueryResponse, GetPetByIdPathParams } from '../../../mod
 /**
  * @description Returns a single pet
  * @summary Find pet by ID
- * @link /pet/:petId
- */
+ * @link /pet/:petId */
 export async function getPetById(
   { petId }: GetPetByIdPathParams,
   options: Partial<Parameters<typeof client>[0]> = {},

examples/advanced/src/gen/clients/axios/petService/updatePet.ts

@@ -5,8 +5,7 @@ import type { UpdatePetMutationRequest, UpdatePetMutationResponse } from '../../
 /**
  * @description Update an existing pet by Id
  * @summary Update an existing pet
- * @link /pet
- */
+ * @link /pet */
 export async function updatePet(
   data: UpdatePetMutationRequest,
   options: Partial<Parameters<typeof client>[0]> = {},

examples/advanced/src/gen/clients/axios/petService/updatePetWithForm.ts

@@ -8,8 +8,7 @@ import type {
 
 /**
  * @summary Updates a pet in the store with form data
- * @link /pet/:petId
- */
+ * @link /pet/:petId */
 export async function updatePetWithForm(
   { petId }: UpdatePetWithFormPathParams,
   params?: UpdatePetWithFormQueryParams,

examples/advanced/src/gen/clients/axios/petService/uploadFile.ts

@@ -9,8 +9,7 @@ import type {
 
 /**
  * @summary uploads an image
- * @link /pet/:petId/uploadImage
- */
+ * @link /pet/:petId/uploadImage */
 export async function uploadFile(
   { petId }: UploadFilePathParams,
   data?: UploadFileMutationRequest,

examples/advanced/src/gen/clients/axios/petsService/createPets.ts

@@ -10,8 +10,7 @@ import type {
 
 /**
  * @summary Create a pet
- * @link /pets/:uuid
- */
+ * @link /pets/:uuid */
 export async function createPets(
   { uuid }: CreatePetsPathParams,
   data: CreatePetsMutationRequest,

examples/advanced/src/gen/clients/axios/userService/createUser.ts

@@ -5,8 +5,7 @@ import type { CreateUserMutationRequest, CreateUserMutationResponse } from '../.
 /**
  * @description This can only be done by the logged in user.
  * @summary Create user
- * @link /user
- */
+ * @link /user */
 export async function createUser(
   data?: CreateUserMutationRequest,
   options: Partial<Parameters<typeof client>[0]> = {},

examples/advanced/src/gen/clients/axios/userService/createUsersWithListInput.ts

@@ -8,8 +8,7 @@ import type {
 /**
  * @description Creates list of users with given input array
  * @summary Creates list of users with given input array
- * @link /user/createWithList
- */
+ * @link /user/createWithList */
 export async function createUsersWithListInput(
   data?: CreateUsersWithListInputMutationRequest,
   options: Partial<Parameters<typeof client>[0]> = {},

examples/advanced/src/gen/clients/axios/userService/deleteUser.ts

@@ -5,8 +5,7 @@ import type { DeleteUserMutationResponse, DeleteUserPathParams } from '../../../
 /**
  * @description This can only be done by the logged in user.
  * @summary Delete user
- * @link /user/:username
- */
+ * @link /user/:username */
 export async function deleteUser(
   { username }: DeleteUserPathParams,
   options: Partial<Parameters<typeof client>[0]> = {},

examples/advanced/src/gen/clients/axios/userService/getUserByName.ts

@@ -4,8 +4,7 @@ import type { GetUserByNameQueryResponse, GetUserByNamePathParams } from '../../
 
 /**
  * @summary Get user by user name
- * @link /user/:username
- */
+ * @link /user/:username */
 export async function getUserByName(
   { username }: GetUserByNamePathParams,
   options: Partial<Parameters<typeof client>[0]> = {},

examples/advanced/src/gen/clients/axios/userService/loginUser.ts

@@ -4,8 +4,7 @@ import type { LoginUserQueryResponse, LoginUserQueryParams } from '../../../mode
 
 /**
  * @summary Logs user into the system
- * @link /user/login
- */
+ * @link /user/login */
 export async function loginUser(
   params?: LoginUserQueryParams,
   options: Partial<Parameters<typeof client>[0]> = {},

examples/advanced/src/gen/clients/axios/userService/logoutUser.ts

@@ -4,8 +4,7 @@ import type { LogoutUserQueryResponse } from '../../../models/ts/userController/
 
 /**
  * @summary Logs out current logged in user session
- * @link /user/logout
- */
+ * @link /user/logout */
 export async function logoutUser(options: Partial<Parameters<typeof client>[0]> = {}): Promise<ResponseConfig<LogoutUserQueryResponse>> {
   return client<LogoutUserQueryResponse>({
     method: 'get',

examples/advanced/src/gen/clients/axios/userService/updateUser.ts

@@ -5,8 +5,7 @@ import type { UpdateUserMutationRequest, UpdateUserMutationResponse, UpdateUserP
 /**
  * @description This can only be done by the logged in user.
  * @summary Update user
- * @link /user/:username
- */
+ * @link /user/:username */
 export async function updateUser(
   { username }: UpdateUserPathParams,
   data?: UpdateUserMutationRequest,

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

@@ -21,8 +21,7 @@ type AddPet = {
 /**
  * @description Add a new pet to the store
  * @summary Add a new pet to the store
- * @link /pet
- */
+ * @link /pet */
 export function useAddPet<TData = AddPet['response'], TError = AddPet['error']>(options: {
   mutation?: UseMutationOptions<TData, TError, AddPet['request']>
   client?: AddPet['client']['paramaters']

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

@@ -21,8 +21,7 @@ type DeletePet = {
 /**
  * @description delete a pet
  * @summary Deletes a pet
- * @link /pet/:petId
- */
+ * @link /pet/:petId */
 export function useDeletePet<TData = DeletePet['response'], TError = DeletePet['error']>(
   petId: DeletePetPathParams['petId'],
   headers?: DeletePet['headerParams'],

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

@@ -41,12 +41,11 @@ export function findPetsByStatusQueryOptions<
       }).then(res => res?.data || res)
     },
   }
-} /**
+}
+/**
  * @description Multiple status values can be provided with comma separated strings
  * @summary Finds Pets by status
- * @link /pet/findByStatus
- */
-
+ * @link /pet/findByStatus */
 export function useFindPetsByStatus<
   TQueryFnData extends FindPetsByStatus['data'] = FindPetsByStatus['data'],
   TError = FindPetsByStatus['error'],
@@ -71,7 +70,6 @@ export function useFindPetsByStatus<
   query.queryKey = queryKey as TQueryKey
   return query
 }
-
 export const findPetsByStatusInfiniteQueryKey = (params?: FindPetsByStatus['queryParams']) =>
   [{ url: '/pet/findByStatus' }, ...(params ? [params] : [])] as const
 export type FindPetsByStatusInfiniteQueryKey = ReturnType<typeof findPetsByStatusInfiniteQueryKey>
@@ -100,12 +98,11 @@ export function findPetsByStatusInfiniteQueryOptions<
       }).then(res => res?.data || res)
     },
   }
-} /**
+}
+/**
  * @description Multiple status values can be provided with comma separated strings
  * @summary Finds Pets by status
- * @link /pet/findByStatus
- */
-
+ * @link /pet/findByStatus */
 export function useFindPetsByStatusInfinite<
   TQueryFnData extends FindPetsByStatus['data'] = FindPetsByStatus['data'],
   TError = FindPetsByStatus['error'],

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

@@ -48,12 +48,11 @@ export function findPetsByTagsQueryOptions<
       }).then(res => res?.data || res)
     },
   }
-} /**
+}
+/**
  * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
  * @summary Finds Pets by tags
- * @link /pet/findByTags
- */
-
+ * @link /pet/findByTags */
 export function useFindPetsByTags<
   TQueryFnData extends FindPetsByTags['data'] = FindPetsByTags['data'],
   TError = FindPetsByTags['error'],
@@ -78,7 +77,6 @@ export function useFindPetsByTags<
   query.queryKey = queryKey as TQueryKey
   return query
 }
-
 export const findPetsByTagsInfiniteQueryKey = (params?: FindPetsByTags['queryParams']) => [{ url: '/pet/findByTags' }, ...(params ? [params] : [])] as const
 export type FindPetsByTagsInfiniteQueryKey = ReturnType<typeof findPetsByTagsInfiniteQueryKey>
 export function findPetsByTagsInfiniteQueryOptions<
@@ -108,12 +106,11 @@ export function findPetsByTagsInfiniteQueryOptions<
       }).then(res => res?.data || res)
     },
   }
-} /**
+}
+/**
  * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
  * @summary Finds Pets by tags
- * @link /pet/findByTags
- */
-
+ * @link /pet/findByTags */
 export function useFindPetsByTagsInfinite<
   TQueryFnData extends FindPetsByTags['data'] = FindPetsByTags['data'],
   TError = FindPetsByTags['error'],

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

@@ -40,12 +40,11 @@ export function getPetByIdQueryOptions<
       }).then(res => res?.data || res)
     },
   }
-} /**
+}
+/**
  * @description Returns a single pet
  * @summary Find pet by ID
- * @link /pet/:petId
- */
-
+ * @link /pet/:petId */
 export function useGetPetById<
   TQueryFnData extends GetPetById['data'] = GetPetById['data'],
   TError = GetPetById['error'],
@@ -70,7 +69,6 @@ export function useGetPetById<
   query.queryKey = queryKey as TQueryKey
   return query
 }
-
 export const getPetByIdInfiniteQueryKey = (petId: GetPetByIdPathParams['petId']) => [{ url: '/pet/:petId', params: { petId: petId } }] as const
 export type GetPetByIdInfiniteQueryKey = ReturnType<typeof getPetByIdInfiniteQueryKey>
 export function getPetByIdInfiniteQueryOptions<
@@ -93,12 +91,11 @@ export function getPetByIdInfiniteQueryOptions<
       }).then(res => res?.data || res)
     },
   }
-} /**
+}
+/**
  * @description Returns a single pet
  * @summary Find pet by ID
- * @link /pet/:petId
- */
-
+ * @link /pet/:petId */
 export function useGetPetByIdInfinite<
   TQueryFnData extends GetPetById['data'] = GetPetById['data'],
   TError = GetPetById['error'],

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

@@ -21,8 +21,7 @@ type UpdatePet = {
 /**
  * @description Update an existing pet by Id
  * @summary Update an existing pet
- * @link /pet
- */
+ * @link /pet */
 export function useUpdatePet<TData = UpdatePet['response'], TError = UpdatePet['error']>(options: {
   mutation?: UseMutationOptions<TData, TError, UpdatePet['request']>
   client?: UpdatePet['client']['paramaters']

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

@@ -25,8 +25,7 @@ type UpdatePetWithForm = {
 }
 /**
  * @summary Updates a pet in the store with form data
- * @link /pet/:petId
- */
+ * @link /pet/:petId */
 export function useUpdatePetWithForm<TData = UpdatePetWithForm['response'], TError = UpdatePetWithForm['error']>(
   petId: UpdatePetWithFormPathParams['petId'],
   params?: UpdatePetWithForm['queryParams'],