Skip to content

Fix circular type inference in SDK functions with explicit return types #2907

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+463 −225
Draft

Fix circular type inference in SDK functions with explicit return types #2907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8133ee0
Initial plan
Copilot Oct 31, 2025
c49afff
Add explicit return types to SDK functions to prevent circular type i…
Copilot Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 65 additions & 20 deletions examples/openapi-ts-angular-common/src/client/sdk.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
// This file is auto-generated by @hey-api/openapi-ts

import type { Client, Options as Options2, TDataShape } from './client';
import type {
Client,
Options as Options2,
RequestResult,
TDataShape,
} from './client';
import { client } from './client.gen';
import type {
AddPetData,
Expand Down Expand Up @@ -86,7 +91,7 @@ export type Options<
*/
export const addPet = <ThrowOnError extends boolean = true>(
options: Options<AddPetData, ThrowOnError>,
) =>
): RequestResult<AddPetResponses, AddPetErrors, ThrowOnError, 'data'> =>
(options.client ?? client).post<
AddPetResponses,
AddPetErrors,
Expand Down Expand Up @@ -115,7 +120,7 @@ export const addPet = <ThrowOnError extends boolean = true>(
*/
export const updatePet = <ThrowOnError extends boolean = true>(
options: Options<UpdatePetData, ThrowOnError>,
) =>
): RequestResult<UpdatePetResponses, UpdatePetErrors, ThrowOnError, 'data'> =>
(options.client ?? client).put<
UpdatePetResponses,
UpdatePetErrors,
Expand Down Expand Up @@ -144,7 +149,12 @@ export const updatePet = <ThrowOnError extends boolean = true>(
*/
export const findPetsByStatus = <ThrowOnError extends boolean = true>(
options: Options<FindPetsByStatusData, ThrowOnError>,
) =>
): RequestResult<
FindPetsByStatusResponses,
FindPetsByStatusErrors,
ThrowOnError,
'data'
> =>
(options.client ?? client).get<
FindPetsByStatusResponses,
FindPetsByStatusErrors,
Expand All @@ -169,7 +179,12 @@ export const findPetsByStatus = <ThrowOnError extends boolean = true>(
*/
export const findPetsByTags = <ThrowOnError extends boolean = true>(
options: Options<FindPetsByTagsData, ThrowOnError>,
) =>
): RequestResult<
FindPetsByTagsResponses,
FindPetsByTagsErrors,
ThrowOnError,
'data'
> =>
(options.client ?? client).get<
FindPetsByTagsResponses,
FindPetsByTagsErrors,
Expand All @@ -194,7 +209,7 @@ export const findPetsByTags = <ThrowOnError extends boolean = true>(
*/
export const deletePet = <ThrowOnError extends boolean = true>(
options: Options<DeletePetData, ThrowOnError>,
) =>
): RequestResult<DeletePetResponses, DeletePetErrors, ThrowOnError, 'data'> =>
(options.client ?? client).delete<
DeletePetResponses,
DeletePetErrors,
Expand All @@ -219,7 +234,7 @@ export const deletePet = <ThrowOnError extends boolean = true>(
*/
export const getPetById = <ThrowOnError extends boolean = true>(
options: Options<GetPetByIdData, ThrowOnError>,
) =>
): RequestResult<GetPetByIdResponses, GetPetByIdErrors, ThrowOnError, 'data'> =>
(options.client ?? client).get<
GetPetByIdResponses,
GetPetByIdErrors,
Expand Down Expand Up @@ -248,7 +263,12 @@ export const getPetById = <ThrowOnError extends boolean = true>(
*/
export const updatePetWithForm = <ThrowOnError extends boolean = true>(
options: Options<UpdatePetWithFormData, ThrowOnError>,
) =>
): RequestResult<
UpdatePetWithFormResponses,
UpdatePetWithFormErrors,
ThrowOnError,
'data'
> =>
(options.client ?? client).post<
UpdatePetWithFormResponses,
UpdatePetWithFormErrors,
Expand All @@ -273,7 +293,7 @@ export const updatePetWithForm = <ThrowOnError extends boolean = true>(
*/
export const uploadFile = <ThrowOnError extends boolean = true>(
options: Options<UploadFileData, ThrowOnError>,
) =>
): RequestResult<UploadFileResponses, UploadFileErrors, ThrowOnError, 'data'> =>
(options.client ?? client).post<
UploadFileResponses,
UploadFileErrors,
Expand Down Expand Up @@ -303,7 +323,12 @@ export const uploadFile = <ThrowOnError extends boolean = true>(
*/
export const getInventory = <ThrowOnError extends boolean = true>(
options?: Options<GetInventoryData, ThrowOnError>,
) =>
): RequestResult<
GetInventoryResponses,
GetInventoryErrors,
ThrowOnError,
'data'
> =>
(options?.client ?? client).get<
GetInventoryResponses,
GetInventoryErrors,
Expand All @@ -328,7 +353,7 @@ export const getInventory = <ThrowOnError extends boolean = true>(
*/
export const placeOrder = <ThrowOnError extends boolean = true>(
options?: Options<PlaceOrderData, ThrowOnError>,
) =>
): RequestResult<PlaceOrderResponses, PlaceOrderErrors, ThrowOnError, 'data'> =>
(options?.client ?? client).post<
PlaceOrderResponses,
PlaceOrderErrors,
Expand All @@ -351,7 +376,12 @@ export const placeOrder = <ThrowOnError extends boolean = true>(
*/
export const deleteOrder = <ThrowOnError extends boolean = true>(
options: Options<DeleteOrderData, ThrowOnError>,
) =>
): RequestResult<
DeleteOrderResponses,
DeleteOrderErrors,
ThrowOnError,
'data'
> =>
(options.client ?? client).delete<
DeleteOrderResponses,
DeleteOrderErrors,
Expand All @@ -370,7 +400,12 @@ export const deleteOrder = <ThrowOnError extends boolean = true>(
*/
export const getOrderById = <ThrowOnError extends boolean = true>(
options: Options<GetOrderByIdData, ThrowOnError>,
) =>
): RequestResult<
GetOrderByIdResponses,
GetOrderByIdErrors,
ThrowOnError,
'data'
> =>
(options.client ?? client).get<
GetOrderByIdResponses,
GetOrderByIdErrors,
Expand All @@ -389,7 +424,7 @@ export const getOrderById = <ThrowOnError extends boolean = true>(
*/
export const createUser = <ThrowOnError extends boolean = true>(
options?: Options<CreateUserData, ThrowOnError>,
) =>
): RequestResult<CreateUserResponses, CreateUserErrors, ThrowOnError, 'data'> =>
(options?.client ?? client).post<
CreateUserResponses,
CreateUserErrors,
Expand All @@ -412,7 +447,12 @@ export const createUser = <ThrowOnError extends boolean = true>(
*/
export const createUsersWithListInput = <ThrowOnError extends boolean = true>(
options?: Options<CreateUsersWithListInputData, ThrowOnError>,
) =>
): RequestResult<
CreateUsersWithListInputResponses,
CreateUsersWithListInputErrors,
ThrowOnError,
'data'
> =>
(options?.client ?? client).post<
CreateUsersWithListInputResponses,
CreateUsersWithListInputErrors,
Expand All @@ -435,7 +475,7 @@ export const createUsersWithListInput = <ThrowOnError extends boolean = true>(
*/
export const loginUser = <ThrowOnError extends boolean = true>(
options?: Options<LoginUserData, ThrowOnError>,
) =>
): RequestResult<LoginUserResponses, LoginUserErrors, ThrowOnError, 'data'> =>
(options?.client ?? client).get<
LoginUserResponses,
LoginUserErrors,
Expand All @@ -454,7 +494,7 @@ export const loginUser = <ThrowOnError extends boolean = true>(
*/
export const logoutUser = <ThrowOnError extends boolean = true>(
options?: Options<LogoutUserData, ThrowOnError>,
) =>
): RequestResult<LogoutUserResponses, LogoutUserErrors, ThrowOnError, 'data'> =>
(options?.client ?? client).get<
LogoutUserResponses,
LogoutUserErrors,
Expand All @@ -473,7 +513,7 @@ export const logoutUser = <ThrowOnError extends boolean = true>(
*/
export const deleteUser = <ThrowOnError extends boolean = true>(
options: Options<DeleteUserData, ThrowOnError>,
) =>
): RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, 'data'> =>
(options.client ?? client).delete<
DeleteUserResponses,
DeleteUserErrors,
Expand All @@ -492,7 +532,12 @@ export const deleteUser = <ThrowOnError extends boolean = true>(
*/
export const getUserByName = <ThrowOnError extends boolean = true>(
options: Options<GetUserByNameData, ThrowOnError>,
) =>
): RequestResult<
GetUserByNameResponses,
GetUserByNameErrors,
ThrowOnError,
'data'
> =>
(options.client ?? client).get<
GetUserByNameResponses,
GetUserByNameErrors,
Expand All @@ -511,7 +556,7 @@ export const getUserByName = <ThrowOnError extends boolean = true>(
*/
export const updateUser = <ThrowOnError extends boolean = true>(
options: Options<UpdateUserData, ThrowOnError>,
) =>
): RequestResult<UpdateUserResponses, UpdateUserErrors, ThrowOnError, 'data'> =>
(options.client ?? client).put<
UpdateUserResponses,
UpdateUserErrors,
Expand Down
Loading