feat: add support for ky v2 #3724

docs/openapi-ts/clients/ky.md

@@ -1,6 +1,6 @@
 ---
-title: Ky v1 Client
-description: Generate a type-safe Ky v1 client from OpenAPI with the Ky client for openapi-ts. Fully compatible with validators, transformers, and all core features.
+title: Ky Client
+description: Generate a type-safe Ky 2 client from OpenAPI with the Ky client for openapi-ts. Fully compatible with validators, transformers, and all core features.
 ---
 
 <script setup lang="ts">
@@ -11,8 +11,8 @@ import { sebastiaanWouters } from '@data/people.js';
 </script>
 
 <Heading>
-  <h1>Ky<span class="sr-only"> v1</span></h1>
-  <VersionLabel value="v1" />
+  <h1>Ky<span class="sr-only"> v2</span></h1>
+  <VersionLabel value="v2" />
 </Heading>
 
 ### About
@@ -23,7 +23,7 @@ The Ky client for Hey API generates a type-safe client from your OpenAPI spec, f
 
 ### Collaborators
 
-<AuthorsList :people="[sebastiaanWouters]" />
+<AuthorsList :people="[sebastiaanWouters,atomicpages]" />
 
 ## Features
 
@@ -62,6 +62,22 @@ npx @hey-api/openapi-ts \
 
 The Ky client is built as a thin wrapper on top of Ky, extending its functionality to work with Hey API. If you're already familiar with Ky, configuring your client will feel like working directly with Ky.
 
+The generated client targets **Ky 2.x** (Ky 2 requires [Node.js 22](https://github.com/sindresorhus/ky/releases/tag/v2.0.0) or newer). Install `ky@^2` in your application.
+
+### Ky options and upgrading from Ky 1
+
+Hey API types omit several Ky options that the wrapper sets itself (for example `method`, `body`, and `prefix`). For any other Ky settings, pass them in **`kyOptions`** or on the top-level config where the generated types allow it.
+
+If you are upgrading from Ky 1, rename **`prefixUrl` to `prefix`** anywhere you pass Ky configuration (including inside `kyOptions`). Ky 2 also adds a standard **`baseUrl`** option for URL resolution; see the [Ky v2.0.0 release notes](https://github.com/sindresorhus/ky/releases/tag/v2.0.0) for hooks, `HTTPError.data`, and other breaking changes.
+
+```js
+client.setConfig({
+  kyOptions: {
+    prefix: 'https://api.example.com/v1/', // was `prefixUrl` in Ky 1
+  },
+});
+```
+
 When we installed the client above, it created a [`client.gen.ts`](/openapi-ts/output#client) file. You will most likely want to configure the exported `client` instance. There are two ways to do that.
 
 ### `setConfig()`

examples/openapi-ts-ky/package.json

@@ -15,7 +15,7 @@
     "@radix-ui/react-form": "0.1.1",
     "@radix-ui/react-icons": "1.3.2",
     "@radix-ui/themes": "3.1.6",
-    "ky": "1.14.0",
+    "ky": "2.0.0",
     "react": "19.0.0",
     "react-dom": "19.0.0"
   },

examples/openapi-ts-ky/src/client/client.gen.ts

@@ -15,6 +15,4 @@ export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (
   override?: Config<ClientOptions & T>,
 ) => Config<Required<ClientOptions> & T>;
 
-export const client = createClient(
-  createConfig<ClientOptions2>({ baseUrl: 'https://petstore3.swagger.io/api/v3' }),
-);
+export const client = createClient(createConfig<ClientOptions2>({ baseUrl: '/api/v3' }));

examples/openapi-ts-ky/src/client/client/client.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import type { HTTPError, Options as KyOptions } from 'ky';
-import ky from 'ky';
+import type { Options as KyOptions } from 'ky';
+import ky, { isHTTPError } from 'ky';
 
 import { createSseClient } from '../core/serverSentEvents.gen';
 import type { HttpMethod } from '../core/types.gen';
@@ -83,22 +83,44 @@ export const createClient = (config: Config = {}): Client => {
     request: Request,
     opts: ResolvedRequestOptions,
     interceptorsMiddleware: Middleware<Request, Response, unknown, ResolvedRequestOptions>,
+    kyHttpError?: { bodyConsumed: true; data: unknown },
   ) => {
     const result = {
       request,
       response,
     };
 
-    const textError = await response.text();
-    let jsonError: unknown;
+    let error: unknown;
 
-    try {
-      jsonError = JSON.parse(textError);
-    } catch {
-      jsonError = undefined;
+    if (kyHttpError) {
+      if (kyHttpError.data !== undefined) {
+        if (typeof kyHttpError.data === 'string') {
+          let jsonError: unknown;
+          try {
+            jsonError = JSON.parse(kyHttpError.data);
+          } catch {
+            jsonError = undefined;
+          }
+          error = jsonError ?? kyHttpError.data;
+        } else {
+          error = kyHttpError.data;
+        }
+      } else {
+        error = '';
+      }
+    } else {
+      const textError = await response.text();
+      let jsonError: unknown;
+
+      try {
+        jsonError = JSON.parse(textError);
+      } catch {
+        jsonError = undefined;
+      }
+
+      error = jsonError ?? textError;
     }
 
-    const error = jsonError ?? textError;
     let finalError = error;
 
     for (const fn of interceptorsMiddleware.error.fns) {
@@ -174,17 +196,30 @@ export const createClient = (config: Config = {}): Client => {
     try {
       response = await kyInstance(request, kyOptions);
     } catch (error) {
-      if (error && typeof error === 'object' && 'response' in error) {
-        const httpError = error as HTTPError;
-        response = httpError.response;
+      if (isHTTPError(error)) {
+        response = error.response;
 
         for (const fn of interceptors.response.fns) {
           if (fn) {
             response = await fn(response, request, opts);
           }
         }
 
-        return parseErrorResponse(response, request, opts, interceptors);
+        if (error.data !== undefined) {
+          return parseErrorResponse(response, request, opts, interceptors, {
+            bodyConsumed: true,
+            data: error.data,
+          });
+        }
+
+        if (!response.bodyUsed) {
+          return parseErrorResponse(response, request, opts, interceptors);
+        }
+
+        return parseErrorResponse(response, request, opts, interceptors, {
+          bodyConsumed: true,
+          data: undefined,
+        });
       }
 
       throw error;

examples/openapi-ts-ky/src/client/client/types.gen.ts

@@ -33,7 +33,7 @@ export interface RetryOptions {
 
 export interface Config<T extends ClientOptions = ClientOptions>
   extends
-    Omit<KyOptions, 'body' | 'headers' | 'method' | 'prefixUrl' | 'retry' | 'throwHttpErrors'>,
+    Omit<KyOptions, 'body' | 'headers' | 'method' | 'prefix' | 'retry' | 'throwHttpErrors'>,
     CoreConfig {
   /**
    * Base URL for all requests made by this client.
@@ -48,7 +48,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
    * Additional ky-specific options that will be passed directly to ky.
    * This allows you to use any ky option not explicitly exposed in the config.
    */
-  kyOptions?: Omit<KyOptions, 'method' | 'prefixUrl'>;
+  kyOptions?: Omit<KyOptions, 'method' | 'prefix'>;
   /**
    * Return the response data parsed in a specified format. By default, `auto`
    * will infer the appropriate method from the `Content-Type` response header.

examples/openapi-ts-ky/src/client/schemas.gen.ts

@@ -32,7 +32,6 @@ export const OrderSchema = {
     },
   },
   type: 'object',
-  'x-swagger-router-model': 'io.swagger.petstore.model.Order',
   xml: {
     name: 'order',
   },
@@ -51,7 +50,6 @@ export const CategorySchema = {
     },
   },
   type: 'object',
-  'x-swagger-router-model': 'io.swagger.petstore.model.Category',
   xml: {
     name: 'category',
   },
@@ -96,7 +94,6 @@ export const UserSchema = {
     },
   },
   type: 'object',
-  'x-swagger-router-model': 'io.swagger.petstore.model.User',
   xml: {
     name: 'user',
   },
@@ -113,7 +110,6 @@ export const TagSchema = {
     },
   },
   type: 'object',
-  'x-swagger-router-model': 'io.swagger.petstore.model.Tag',
   xml: {
     name: 'tag',
   },
@@ -162,7 +158,6 @@ export const PetSchema = {
   },
   required: ['name', 'photoUrls'],
   type: 'object',
-  'x-swagger-router-model': 'io.swagger.petstore.model.Pet',
   xml: {
     name: 'pet',
   },

examples/openapi-ts-ky/src/client/types.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 export type ClientOptions = {
-  baseUrl: 'https://petstore3.swagger.io/api/v3' | (string & {});
+  baseUrl: `${string}://${string}/api/v3` | (string & {});
 };
 
 export type Order = {

packages/openapi-ts-tests/main/package.json

@@ -35,7 +35,7 @@
     "cross-spawn": "7.0.6",
     "eslint": "9.39.2",
     "fastify": "5.7.4",
-    "ky": "1.14.3",
+    "ky": "2.0.0",
     "node-fetch": "3.3.2",
     "nuxt": "3.14.1592",
     "ofetch": "1.5.1",

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/base-url-false/client/client.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import type { HTTPError, Options as KyOptions } from 'ky';
-import ky from 'ky';
+import type { Options as KyOptions } from 'ky';
+import ky, { isHTTPError } from 'ky';
 
 import { createSseClient } from '../core/serverSentEvents.gen';
 import type { HttpMethod } from '../core/types.gen';
@@ -77,22 +77,44 @@ export const createClient = (config: Config = {}): Client => {
     request: Request,
     opts: ResolvedRequestOptions,
     interceptorsMiddleware: Middleware<Request, Response, unknown, ResolvedRequestOptions>,
+    kyHttpError?: { bodyConsumed: true; data: unknown },
   ) => {
     const result = {
       request,
       response,
     };
 
-    const textError = await response.text();
-    let jsonError: unknown;
+    let error: unknown;
 
-    try {
-      jsonError = JSON.parse(textError);
-    } catch {
-      jsonError = undefined;
+    if (kyHttpError) {
+      if (kyHttpError.data !== undefined) {
+        if (typeof kyHttpError.data === 'string') {
+          let jsonError: unknown;
+          try {
+            jsonError = JSON.parse(kyHttpError.data);
+          } catch {
+            jsonError = undefined;
+          }
+          error = jsonError ?? kyHttpError.data;
+        } else {
+          error = kyHttpError.data;
+        }
+      } else {
+        error = '';
+      }
+    } else {
+      const textError = await response.text();
+      let jsonError: unknown;
+
+      try {
+        jsonError = JSON.parse(textError);
+      } catch {
+        jsonError = undefined;
+      }
+
+      error = jsonError ?? textError;
     }
 
-    const error = jsonError ?? textError;
     let finalError = error;
 
     for (const fn of interceptorsMiddleware.error.fns) {
@@ -168,17 +190,30 @@ export const createClient = (config: Config = {}): Client => {
     try {
       response = await kyInstance(request, kyOptions);
     } catch (error) {
-      if (error && typeof error === 'object' && 'response' in error) {
-        const httpError = error as HTTPError;
-        response = httpError.response;
+      if (isHTTPError(error)) {
+        response = error.response;
 
         for (const fn of interceptors.response.fns) {
           if (fn) {
             response = await fn(response, request, opts);
           }
         }
 
-        return parseErrorResponse(response, request, opts, interceptors);
+        if (error.data !== undefined) {
+          return parseErrorResponse(response, request, opts, interceptors, {
+            bodyConsumed: true,
+            data: error.data,
+          });
+        }
+
+        if (!response.bodyUsed) {
+          return parseErrorResponse(response, request, opts, interceptors);
+        }
+
+        return parseErrorResponse(response, request, opts, interceptors, {
+          bodyConsumed: true,
+          data: undefined,
+        });
       }
 
       throw error;

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/base-url-false/client/types.gen.ts

@@ -36,7 +36,7 @@ export interface RetryOptions {
 
 export interface Config<T extends ClientOptions = ClientOptions>
   extends
-    Omit<KyOptions, 'body' | 'headers' | 'method' | 'prefixUrl' | 'retry' | 'throwHttpErrors'>,
+    Omit<KyOptions, 'body' | 'headers' | 'method' | 'prefix' | 'retry' | 'throwHttpErrors'>,
     CoreConfig {
   /**
    * Base URL for all requests made by this client.
@@ -51,7 +51,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
    * Additional ky-specific options that will be passed directly to ky.
    * This allows you to use any ky option not explicitly exposed in the config.
    */
-  kyOptions?: Omit<KyOptions, 'method' | 'prefixUrl'>;
+  kyOptions?: Omit<KyOptions, 'method' | 'prefix'>;
   /**
    * Return the response data parsed in a specified format. By default, `auto`
    * will infer the appropriate method from the `Content-Type` response header.