Merge pull request #1646 from hey-api/feat/sdk-client-required

feat: support required client in SDK using sdk.client = false
hey-api · Jan 30, 2025 · 3bdc656 · 3bdc656
2 parents 93039cc + 2cbffeb
commit 3bdc656
Show file tree

Hide file tree

Showing 220 changed files with 26,241 additions and 7,419 deletions.
diff --git a/.changeset/dry-eggs-begin.md b/.changeset/dry-eggs-begin.md
@@ -1,7 +1,6 @@
 ---
 '@hey-api/client-axios': patch
 '@hey-api/client-fetch': patch
-'@hey-api/client-next': patch
 '@hey-api/client-nuxt': patch
 '@hey-api/openapi-ts': patch
 ---

diff --git a/.changeset/orange-bags-hope.md b/.changeset/orange-bags-hope.md
@@ -0,0 +1,8 @@
+---
+'@hey-api/client-axios': patch
+'@hey-api/client-fetch': patch
+'@hey-api/client-next': patch
+'@hey-api/client-nuxt': patch
+---
+
+fix: remove client from Options interface
diff --git a/.changeset/thin-impalas-tell.md b/.changeset/thin-impalas-tell.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+feat: support required client in SDK using sdk.client = false
diff --git a/.changeset/tiny-kings-reflect.md b/.changeset/tiny-kings-reflect.md
@@ -0,0 +1,8 @@
+---
+'@hey-api/client-axios': patch
+'@hey-api/client-fetch': patch
+'@hey-api/client-next': patch
+'@hey-api/client-nuxt': patch
+---
+
+fix: export TDataShape interface
diff --git a/examples/openapi-ts-axios/src/client/sdk.gen.ts b/examples/openapi-ts-axios/src/client/sdk.gen.ts
@@ -1,6 +1,10 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import type { Options } from '@hey-api/client-axios';
+import type {
+  Client,
+  Options as ClientOptions,
+  TDataShape,
+} from '@hey-api/client-axios';
 
 import { client as _heyApiClient } from './client.gen';
 import type {
@@ -38,32 +42,42 @@ import type {
   UploadFileResponse,
 } from './types.gen';
 
+type Options<
+  TData extends TDataShape = TDataShape,
+  ThrowOnError extends boolean = boolean,
+> = ClientOptions<TData, ThrowOnError> & {
+  /**
+   * You can provide a client instance returned by `createClient()` instead of
+   * individual options. This might be also useful if you want to implement a
+   * custom client.
+   */
+  client?: Client;
+};
+
 /**
  * Add a new pet to the store
  * Add a new pet to the store
  */
 export const addPet = <ThrowOnError extends boolean = false>(
   options: Options<AddPetData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).post<
-    AddPetResponse,
-    unknown,
-    ThrowOnError
-  >({
-    responseType: 'blob',
-    security: [
-      {
-        scheme: 'bearer',
-        type: 'http',
+  (options.client ?? _heyApiClient).post<AddPetResponse, unknown, ThrowOnError>(
+    {
+      responseType: 'blob',
+      security: [
+        {
+          scheme: 'bearer',
+          type: 'http',
+        },
+      ],
+      url: '/pet',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options?.headers,
       },
-    ],
-    url: '/pet',
-    ...options,
-    headers: {
-      'Content-Type': 'application/json',
-      ...options?.headers,
     },
-  });
+  );
 
 /**
  * Update an existing pet
@@ -72,7 +86,7 @@ export const addPet = <ThrowOnError extends boolean = false>(
 export const updatePet = <ThrowOnError extends boolean = false>(
   options: Options<UpdatePetData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).put<
+  (options.client ?? _heyApiClient).put<
     UpdatePetResponse,
     unknown,
     ThrowOnError
@@ -144,7 +158,7 @@ export const findPetsByTags = <ThrowOnError extends boolean = false>(
 export const deletePet = <ThrowOnError extends boolean = false>(
   options: Options<DeletePetData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
+  (options.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
     security: [
       {
         scheme: 'bearer',
@@ -162,7 +176,7 @@ export const deletePet = <ThrowOnError extends boolean = false>(
 export const getPetById = <ThrowOnError extends boolean = false>(
   options: Options<GetPetByIdData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).get<
+  (options.client ?? _heyApiClient).get<
     GetPetByIdResponse,
     unknown,
     ThrowOnError
@@ -188,7 +202,7 @@ export const getPetById = <ThrowOnError extends boolean = false>(
 export const updatePetWithForm = <ThrowOnError extends boolean = false>(
   options: Options<UpdatePetWithFormData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).post<unknown, unknown, ThrowOnError>({
+  (options.client ?? _heyApiClient).post<unknown, unknown, ThrowOnError>({
     security: [
       {
         scheme: 'bearer',
@@ -205,7 +219,7 @@ export const updatePetWithForm = <ThrowOnError extends boolean = false>(
 export const uploadFile = <ThrowOnError extends boolean = false>(
   options: Options<UploadFileData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).post<
+  (options.client ?? _heyApiClient).post<
     UploadFileResponse,
     unknown,
     ThrowOnError
@@ -273,7 +287,7 @@ export const placeOrder = <ThrowOnError extends boolean = false>(
 export const deleteOrder = <ThrowOnError extends boolean = false>(
   options: Options<DeleteOrderData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
+  (options.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
     url: '/store/order/{orderId}',
     ...options,
   });
@@ -285,7 +299,7 @@ export const deleteOrder = <ThrowOnError extends boolean = false>(
 export const getOrderById = <ThrowOnError extends boolean = false>(
   options: Options<GetOrderByIdData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).get<
+  (options.client ?? _heyApiClient).get<
     GetOrderByIdResponse,
     unknown,
     ThrowOnError
@@ -370,7 +384,7 @@ export const logoutUser = <ThrowOnError extends boolean = false>(
 export const deleteUser = <ThrowOnError extends boolean = false>(
   options: Options<DeleteUserData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
+  (options.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
     url: '/user/{username}',
     ...options,
   });
@@ -381,7 +395,7 @@ export const deleteUser = <ThrowOnError extends boolean = false>(
 export const getUserByName = <ThrowOnError extends boolean = false>(
   options: Options<GetUserByNameData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).get<
+  (options.client ?? _heyApiClient).get<
     GetUserByNameResponse,
     unknown,
     ThrowOnError
@@ -398,7 +412,7 @@ export const getUserByName = <ThrowOnError extends boolean = false>(
 export const updateUser = <ThrowOnError extends boolean = false>(
   options: Options<UpdateUserData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).put<unknown, unknown, ThrowOnError>({
+  (options.client ?? _heyApiClient).put<unknown, unknown, ThrowOnError>({
     url: '/user/{username}',
     ...options,
     headers: {

diff --git a/examples/openapi-ts-fastify/src/client/sdk.gen.ts b/examples/openapi-ts-fastify/src/client/sdk.gen.ts
@@ -1,6 +1,10 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import type { Options } from '@hey-api/client-fetch';
+import type {
+  Client,
+  Options as ClientOptions,
+  TDataShape,
+} from '@hey-api/client-fetch';
 
 import { client as _heyApiClient } from './client.gen';
 import type {
@@ -14,6 +18,18 @@ import type {
   ShowPetByIdResponse,
 } from './types.gen';
 
+type Options<
+  TData extends TDataShape = TDataShape,
+  ThrowOnError extends boolean = boolean,
+> = ClientOptions<TData, ThrowOnError> & {
+  /**
+   * You can provide a client instance returned by `createClient()` instead of
+   * individual options. This might be also useful if you want to implement a
+   * custom client.
+   */
+  client?: Client;
+};
+
 /**
  * List all pets
  */
@@ -50,7 +66,7 @@ export const createPets = <ThrowOnError extends boolean = false>(
 export const showPetById = <ThrowOnError extends boolean = false>(
   options: Options<ShowPetByIdData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).get<
+  (options.client ?? _heyApiClient).get<
     ShowPetByIdResponse,
     ShowPetByIdError,
     ThrowOnError

diff --git a/examples/openapi-ts-fetch/src/client/sdk.gen.ts b/examples/openapi-ts-fetch/src/client/sdk.gen.ts
@@ -1,6 +1,10 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import type { Options } from '@hey-api/client-fetch';
+import type {
+  Client,
+  Options as ClientOptions,
+  TDataShape,
+} from '@hey-api/client-fetch';
 
 import { client as _heyApiClient } from './client.gen';
 import type {
@@ -38,31 +42,41 @@ import type {
   UploadFileResponse,
 } from './types.gen';
 
+type Options<
+  TData extends TDataShape = TDataShape,
+  ThrowOnError extends boolean = boolean,
+> = ClientOptions<TData, ThrowOnError> & {
+  /**
+   * You can provide a client instance returned by `createClient()` instead of
+   * individual options. This might be also useful if you want to implement a
+   * custom client.
+   */
+  client?: Client;
+};
+
 /**
  * Add a new pet to the store
  * Add a new pet to the store
  */
 export const addPet = <ThrowOnError extends boolean = false>(
   options: Options<AddPetData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).post<
-    AddPetResponse,
-    unknown,
-    ThrowOnError
-  >({
-    security: [
-      {
-        scheme: 'bearer',
-        type: 'http',
+  (options.client ?? _heyApiClient).post<AddPetResponse, unknown, ThrowOnError>(
+    {
+      security: [
+        {
+          scheme: 'bearer',
+          type: 'http',
+        },
+      ],
+      url: '/pet',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options?.headers,
       },
-    ],
-    url: '/pet',
-    ...options,
-    headers: {
-      'Content-Type': 'application/json',
-      ...options?.headers,
     },
-  });
+  );
 
 /**
  * Update an existing pet
@@ -71,7 +85,7 @@ export const addPet = <ThrowOnError extends boolean = false>(
 export const updatePet = <ThrowOnError extends boolean = false>(
   options: Options<UpdatePetData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).put<
+  (options.client ?? _heyApiClient).put<
     UpdatePetResponse,
     unknown,
     ThrowOnError
@@ -140,7 +154,7 @@ export const findPetsByTags = <ThrowOnError extends boolean = false>(
 export const deletePet = <ThrowOnError extends boolean = false>(
   options: Options<DeletePetData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
+  (options.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
     security: [
       {
         scheme: 'bearer',
@@ -158,7 +172,7 @@ export const deletePet = <ThrowOnError extends boolean = false>(
 export const getPetById = <ThrowOnError extends boolean = false>(
   options: Options<GetPetByIdData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).get<
+  (options.client ?? _heyApiClient).get<
     GetPetByIdResponse,
     unknown,
     ThrowOnError
@@ -183,7 +197,7 @@ export const getPetById = <ThrowOnError extends boolean = false>(
 export const updatePetWithForm = <ThrowOnError extends boolean = false>(
   options: Options<UpdatePetWithFormData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).post<unknown, unknown, ThrowOnError>({
+  (options.client ?? _heyApiClient).post<unknown, unknown, ThrowOnError>({
     security: [
       {
         scheme: 'bearer',
@@ -200,7 +214,7 @@ export const updatePetWithForm = <ThrowOnError extends boolean = false>(
 export const uploadFile = <ThrowOnError extends boolean = false>(
   options: Options<UploadFileData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).post<
+  (options.client ?? _heyApiClient).post<
     UploadFileResponse,
     unknown,
     ThrowOnError
@@ -268,7 +282,7 @@ export const placeOrder = <ThrowOnError extends boolean = false>(
 export const deleteOrder = <ThrowOnError extends boolean = false>(
   options: Options<DeleteOrderData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
+  (options.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
     url: '/store/order/{orderId}',
     ...options,
   });
@@ -280,7 +294,7 @@ export const deleteOrder = <ThrowOnError extends boolean = false>(
 export const getOrderById = <ThrowOnError extends boolean = false>(
   options: Options<GetOrderByIdData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).get<
+  (options.client ?? _heyApiClient).get<
     GetOrderByIdResponse,
     unknown,
     ThrowOnError
@@ -362,7 +376,7 @@ export const logoutUser = <ThrowOnError extends boolean = false>(
 export const deleteUser = <ThrowOnError extends boolean = false>(
   options: Options<DeleteUserData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
+  (options.client ?? _heyApiClient).delete<unknown, unknown, ThrowOnError>({
     url: '/user/{username}',
     ...options,
   });
@@ -373,7 +387,7 @@ export const deleteUser = <ThrowOnError extends boolean = false>(
 export const getUserByName = <ThrowOnError extends boolean = false>(
   options: Options<GetUserByNameData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).get<
+  (options.client ?? _heyApiClient).get<
     GetUserByNameResponse,
     unknown,
     ThrowOnError
@@ -389,7 +403,7 @@ export const getUserByName = <ThrowOnError extends boolean = false>(
 export const updateUser = <ThrowOnError extends boolean = false>(
   options: Options<UpdateUserData, ThrowOnError>,
 ) =>
-  (options?.client ?? _heyApiClient).put<unknown, unknown, ThrowOnError>({
+  (options.client ?? _heyApiClient).put<unknown, unknown, ThrowOnError>({
     url: '/user/{username}',
     ...options,
     headers: {