Merge pull request #457 from kubb-project/feat/dataReturnType

feat: `dataReturnType` for @kubb/swagger-tanstack-query, @kubb/swagger-client and @kubb/swagger-swr
kubb-labs · Oct 8, 2023 · 151ea18 · 151ea18 · vercel · Oct 8, 2023
2 parents d628687 + 9e5b124
commit 151ea18
Show file tree

Hide file tree

Showing 48 changed files with 280 additions and 207 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -167,7 +167,7 @@ export default defineConfig({
           },
           {
             text: '@kubb/react-templates <span class="beta">under construction</span>',
-            link: '/plugins/react-templates',
+            link: '/plugins/react-template',
           },
           {
             text: 'Swagger plugins',

diff --git a/docs/plugins/react-template.md b/docs/plugins/react-template.md
@@ -6,8 +6,11 @@ outline: deep
 ---
 # @kubb/react-template <Badge type="warning" text="under construction" />
 
+Use React to create templates/variants for any plugin.
+
 <hr/>
 
+
 ## Installation
 
 ::: code-group

diff --git a/docs/plugins/swagger-client/index.md b/docs/plugins/swagger-client/index.md
@@ -70,6 +70,15 @@ Relative to the root
 Type: `string` <br/>
 Default: `"@kubb/swagger-client/ts-client"`
 
+### dataReturnType <Badge type="warning" text="experimental" />
+ReturnType that needs to be used when calling client().
+
+`Data` will return ResponseConfig[data]. <br/>
+`Full` will return ResponseConfig.
+
+Type: `string` <br/>
+Default: `"data"`
+
 ### skipBy
 Array containing skipBy paramaters to exclude/skip tags/operations/methods/paths.
 
@@ -86,6 +95,7 @@ Override the name of the client that is getting generated, this will also overri
 Type: `(name: string) => string` <br/>
 
 
+
 ## Depended
 
 - [`@kubb/swagger`](/plugins/swagger)

diff --git a/docs/plugins/swagger-swr.md b/docs/plugins/swagger-swr.md
@@ -30,7 +30,6 @@ yarn add @kubb/swagger-swr
 
 :::
 
-
 ## Options
 
 
@@ -70,6 +69,15 @@ Relative to the root
 Type: `string` <br/>
 Default: `"@kubb/swagger-client/ts-client"`
 
+### dataReturnType <Badge type="warning" text="experimental" />
+ReturnType that needs to be used when calling client().
+
+`Data` will return ResponseConfig[data]. <br/>
+`Full` will return ResponseConfig.
+
+Type: `string` <br/>
+Default: `"data"`
+
 ### skipBy
 Array containing skipBy paramaters to exclude/skip tags/operations/methods/paths.
 

diff --git a/docs/plugins/swagger-tanstack-query.md b/docs/plugins/swagger-tanstack-query.md
@@ -75,6 +75,15 @@ Relative to the root
 Type: `string` <br/>
 Default: `"@kubb/swagger-client/ts-client"`
 
+### dataReturnType <Badge type="warning" text="experimental" />
+ReturnType that needs to be used when calling client().
+
+`Data` will return ResponseConfig[data]. <br/>
+`Full` will return ResponseConfig.
+
+Type: `string` <br/>
+Default: `"data"`
+
 ### framework
 Framework to be generated for.
 

diff --git a/docs/plugins/swagger-ts.md b/docs/plugins/swagger-ts.md
@@ -81,7 +81,6 @@ date: Date
 Type: `'string' | 'date'` <br/>
 Default: `'string'`
 
-
 ### optionalType
 Choose what to use as mode for an optional value.<br/>
 

diff --git a/examples/advanced/kubb.config.ts b/examples/advanced/kubb.config.ts
@@ -46,6 +46,7 @@ export default defineConfig(async () => {
           groupBy: { type: 'tag' },
           client: './src/client.ts',
           infinite: {},
+          dataReturnType: 'full',
         },
       ],
       [
@@ -60,6 +61,7 @@ export default defineConfig(async () => {
           ],
           groupBy: { type: 'tag' },
           client: './src/client.ts',
+          dataReturnType: 'full',
         },
       ],
       [
@@ -74,6 +76,7 @@ export default defineConfig(async () => {
           ],
           groupBy: { type: 'tag', output: './clients/axios/{{tag}}Service' },
           client: './src/client.ts',
+          dataReturnType: 'full',
         },
       ],
       [

diff --git a/examples/advanced/src/gen/clients/axios/petService/addPet.ts b/examples/advanced/src/gen/clients/axios/petService/addPet.ts
@@ -10,13 +10,11 @@ import type { AddPetMutationRequest, AddPetMutationResponse } from '../../../mod
 export async function addPet<TData = AddPetMutationResponse, TVariables = AddPetMutationRequest>(
   data: TVariables,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData, TVariables>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData, TVariables>({
     method: 'post',
     url: `/pet`,
     data,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/petService/deletePet.ts b/examples/advanced/src/gen/clients/axios/petService/deletePet.ts
@@ -11,13 +11,11 @@ export async function deletePet<TData = DeletePetMutationResponse>(
   petId: DeletePetPathParams['petId'],
   headers?: DeletePetHeaderParams,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData>({
     method: 'delete',
     url: `/pet/${petId}`,
     headers: { ...headers, ...options.headers },
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/petService/findPetsByStatus.ts b/examples/advanced/src/gen/clients/axios/petService/findPetsByStatus.ts
@@ -10,13 +10,11 @@ import type { FindPetsByStatusQueryResponse, FindPetsByStatusQueryParams } from
 export async function findPetsByStatus<TData = FindPetsByStatusQueryResponse>(
   params?: FindPetsByStatusQueryParams,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData>({
     method: 'get',
     url: `/pet/findByStatus`,
     params,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/petService/findPetsByTags.ts b/examples/advanced/src/gen/clients/axios/petService/findPetsByTags.ts
@@ -11,14 +11,12 @@ export async function findPetsByTags<TData = FindPetsByTagsQueryResponse>(
   headers: FindPetsByTagsHeaderParams,
   params?: FindPetsByTagsQueryParams,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData>({
     method: 'get',
     url: `/pet/findByTags`,
     params,
     headers: { ...headers, ...options.headers },
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/petService/getPetById.ts b/examples/advanced/src/gen/clients/axios/petService/getPetById.ts
@@ -10,12 +10,10 @@ import type { GetPetByIdQueryResponse, GetPetByIdPathParams } from '../../../mod
 export async function getPetById<TData = GetPetByIdQueryResponse>(
   petId: GetPetByIdPathParams['petId'],
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData>({
     method: 'get',
     url: `/pet/${petId}`,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/petService/updatePet.ts b/examples/advanced/src/gen/clients/axios/petService/updatePet.ts
@@ -10,13 +10,11 @@ import type { UpdatePetMutationRequest, UpdatePetMutationResponse } from '../../
 export async function updatePet<TData = UpdatePetMutationResponse, TVariables = UpdatePetMutationRequest>(
   data: TVariables,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData, TVariables>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData, TVariables>({
     method: 'put',
     url: `/pet`,
     data,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/petService/updatePetWithForm.ts b/examples/advanced/src/gen/clients/axios/petService/updatePetWithForm.ts
@@ -14,13 +14,11 @@ export async function updatePetWithForm<TData = UpdatePetWithFormMutationRespons
   petId: UpdatePetWithFormPathParams['petId'],
   params?: UpdatePetWithFormQueryParams,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData>({
     method: 'post',
     url: `/pet/${petId}`,
     params,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/petService/uploadFile.ts b/examples/advanced/src/gen/clients/axios/petService/uploadFile.ts
@@ -16,14 +16,12 @@ export async function uploadFile<TData = UploadFileMutationResponse, TVariables
   data?: TVariables,
   params?: UploadFileQueryParams,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData, TVariables>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData, TVariables>({
     method: 'post',
     url: `/pet/${petId}/uploadImage`,
     params,
     data,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/petsService/createPets.ts b/examples/advanced/src/gen/clients/axios/petsService/createPets.ts
@@ -18,15 +18,13 @@ export async function createPets<TData = CreatePetsMutationResponse, TVariables
   headers: CreatePetsHeaderParams,
   params?: CreatePetsQueryParams,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData, TVariables>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData, TVariables>({
     method: 'post',
     url: `/pets/${uuid}`,
     params,
     data,
     headers: { ...headers, ...options.headers },
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/userService/createUser.ts b/examples/advanced/src/gen/clients/axios/userService/createUser.ts
@@ -10,13 +10,11 @@ import type { CreateUserMutationRequest, CreateUserMutationResponse } from '../.
 export async function createUser<TData = CreateUserMutationResponse, TVariables = CreateUserMutationRequest>(
   data?: TVariables,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData, TVariables>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData, TVariables>({
     method: 'post',
     url: `/user`,
     data,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/userService/createUsersWithListInput.ts b/examples/advanced/src/gen/clients/axios/userService/createUsersWithListInput.ts
@@ -13,13 +13,11 @@ import type {
 export async function createUsersWithListInput<TData = CreateUsersWithListInputMutationResponse, TVariables = CreateUsersWithListInputMutationRequest>(
   data?: TVariables,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData, TVariables>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData, TVariables>({
     method: 'post',
     url: `/user/createWithList`,
     data,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/userService/deleteUser.ts b/examples/advanced/src/gen/clients/axios/userService/deleteUser.ts
@@ -10,12 +10,10 @@ import type { DeleteUserMutationResponse, DeleteUserPathParams } from '../../../
 export async function deleteUser<TData = DeleteUserMutationResponse>(
   username: DeleteUserPathParams['username'],
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData>({
     method: 'delete',
     url: `/user/${username}`,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/userService/getUserByName.ts b/examples/advanced/src/gen/clients/axios/userService/getUserByName.ts
@@ -9,12 +9,10 @@ import type { GetUserByNameQueryResponse, GetUserByNamePathParams } from '../../
 export async function getUserByName<TData = GetUserByNameQueryResponse>(
   username: GetUserByNamePathParams['username'],
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData>({
     method: 'get',
     url: `/user/${username}`,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/userService/loginUser.ts b/examples/advanced/src/gen/clients/axios/userService/loginUser.ts
@@ -9,13 +9,11 @@ import type { LoginUserQueryResponse, LoginUserQueryParams } from '../../../mode
 export async function loginUser<TData = LoginUserQueryResponse>(
   params?: LoginUserQueryParams,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData>({
     method: 'get',
     url: `/user/login`,
     params,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/userService/logoutUser.ts b/examples/advanced/src/gen/clients/axios/userService/logoutUser.ts
@@ -6,12 +6,10 @@ import type { LogoutUserQueryResponse } from '../../../models/ts/userController/
  * @summary Logs out current logged in user session
  * @link /user/logout
  */
-export async function logoutUser<TData = LogoutUserQueryResponse>(options: Partial<Parameters<typeof client>[0]> = {}): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData>({
+export async function logoutUser<TData = LogoutUserQueryResponse>(options: Partial<Parameters<typeof client>[0]> = {}): Promise<ResponseConfig<TData>> {
+  return client<TData>({
     method: 'get',
     url: `/user/logout`,
     ...options,
   })
-
-  return resData
 }
diff --git a/examples/advanced/src/gen/clients/axios/userService/updateUser.ts b/examples/advanced/src/gen/clients/axios/userService/updateUser.ts
@@ -11,13 +11,11 @@ export async function updateUser<TData = UpdateUserMutationResponse, TVariables
   username: UpdateUserPathParams['username'],
   data?: TVariables,
   options: Partial<Parameters<typeof client>[0]> = {},
-): Promise<ResponseConfig<TData>['data']> {
-  const { data: resData } = await client<TData, TVariables>({
+): Promise<ResponseConfig<TData>> {
+  return client<TData, TVariables>({
     method: 'put',
     url: `/user/${username}`,
     data,
     ...options,
   })
-
-  return resData
 }