feat: add support for ky v2 #3724 by atomicpages · Pull Request #3725 · hey-api/openapi-ts

atomicpages · 2026-04-07T21:45:40Z

Align generated Config / kyOptions types: omit prefix instead of removed prefixUrl.
Handle HTTPError with isHTTPError, use error.data when Ky has consumed the body, and fall back to response.text() when the body is still readable (e.g. tests).
Add unit test for Ky-style errors with data and a failing response.text().
Refresh openapi-ts-tests snapshots for @hey-api/client-ky; bump ky to 2.x in the Ky example and test package; regenerate example client output.
Docs: update docs/openapi-ts/clients/ky.md for Ky 2, prefixUrl → prefix, and kyOptions example.

Note: the tests I delegated to cursor. I'm happy to either revert and/or amend any changes. LMK

bolt-new-by-stackblitz · 2026-04-07T21:45:43Z

Run & review this pull request in StackBlitz Codeflow.

pullfrog · 2026-04-07T21:45:44Z

Reviewed PR #3725. Found a redundant/dead code path in the error-handling logic at client.ts:207-214 and a personal .vscode/settings.json change that should be reverted. The core ky v2 migration (import changes, isHTTPError, prefixUrl → prefix, error.data handling) looks correct. Submitted review with inline comments.

Task list (6/6 completed)

Read diff and identify major areas of change
Review core client implementation (bundle/client.ts, bundle/types.ts)
Review test changes
Review docs, examples, and dependency changes
Review snapshots for consistency
Submit review

^{｜ View workflow run ｜ Triggered by Pullfrog ｜ 𝕏}

vercel · 2026-04-07T21:45:47Z

@atomicpages is attempting to deploy a commit to the Hey API Team on Vercel.

A member of the Team first needs to authorize it.

changeset-bot · 2026-04-07T21:45:49Z

⚠️ No Changeset found

Latest commit: 66797c9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

pullfrog · 2026-04-07T21:47:27Z

TL;DR — Upgrades the @hey-api/client-ky plugin from Ky 1.x to Ky 2.0, adopting the new isHTTPError type guard and HTTPError.data property for error handling, and renaming prefixUrl to prefix throughout the generated client types.

Key changes

Upgrade Ky dependency to v2.0.0 — Bumps ky from 1.14.x to 2.0.0 across the main package, test package, and example, raising the minimum Node.js requirement to 22.
Use isHTTPError instead of manual duck-typing — Replaces the HTTPError type import and manual 'response' in error check with Ky 2's exported isHTTPError guard for proper error discrimination.
Handle HTTPError.data for consumed response bodies — When Ky 2 has already consumed the response body (populating error.data), the client now passes that data through to parseErrorResponse instead of attempting to re-read the body.
Rename prefixUrl to prefix in generated types — Updates the Config and kyOptions Omit keys to reflect Ky 2's renamed option.
Update documentation and add upgrade guide — Bumps the docs page from "Ky v1" to "Ky v2", adds a migration section covering the prefixUrl → prefix rename and other Ky 2 breaking changes, and adds a new collaborator.
Add test for HTTPError.data path — New test case verifies the client correctly surfaces error data when Ky has already consumed the response body.

_{Summary ｜ 35 files ｜ 2 commits ｜ base: main ← atomicpages:main}

Ky 2 error handling with `isHTTPError` and `HTTPError.data`

Before: The client imported the HTTPError type and checked errors with error && typeof error === 'object' && 'response' in error, then always read the response body via response.text() to extract the error payload.
After: The client uses Ky 2's isHTTPError guard for type-safe error detection and leverages HTTPError.data when Ky has already consumed the body, avoiding double-read errors.

Ky 2 automatically parses error responses and exposes the result on HTTPError.data, which also marks the body as consumed. The updated parseErrorResponse accepts an optional kyHttpError parameter: when present, it uses the pre-parsed data directly (attempting JSON parse only if the data is a string); when absent, it falls back to the original response.text() path.

Why three return paths in the catch block?

The catch block handles three scenarios: (1) error.data is defined — pass it directly as already-consumed data, (2) error.data is undefined but the body hasn't been read yet — fall back to the original text-reading path, (3) body is already consumed but data is undefined — still signal bodyConsumed: true to avoid a read error.

bundle/client.ts · bundle/types.ts · client.test.ts

Documentation and migration guide for Ky 2

Before: Docs described the client as "Ky v1" with no migration guidance.
After: Docs describe "Ky v2", note the Node.js 22 requirement, and include a dedicated section on renaming prefixUrl to prefix and other Ky 2 breaking changes.

ky.md

Dependency bumps and snapshot updates

Before: ky@1.14.x across all packages.
After: ky@2.0.0 in packages/openapi-ts, packages/openapi-ts-tests/main, and examples/openapi-ts-ky.

All 10 test snapshot directories under client-ky/ are regenerated with the updated imports (isHTTPError), error handling logic, and prefix rename. The example's generated schemas also drop x-swagger-router-model keys (likely a spec update artifact).

packages/openapi-ts/package.json · openapi-ts-tests/main/package.json · examples/openapi-ts-ky/package.json

^{｜ View workflow run ｜ Triggered by Pullfrog ｜ 𝕏}

atomicpages · 2026-04-07T21:48:24Z

-import type { HTTPError, Options as KyOptions } from 'ky';
-import ky from 'ky';
+import type { Options as KyOptions } from 'ky';
+import ky, { isHTTPError } from 'ky';


this was available in later version of ky v1, not required to use, but helps with tsc

pullfrog

Important

Two issues to address: a dead/redundant code path in the error-handling logic, and a personal editor setting that leaked into the diff.

^{｜ Fix all ➔ ｜ Fix 👍s ➔ ｜ View workflow run ｜ 𝕏}

atomicpages · 2026-04-07T21:49:23Z

-      jsonError = JSON.parse(textError);
-    } catch {
-      jsonError = undefined;
+    if (kyHttpError) {


This is due to:

Make .json() throw on empty bodies and 204 responses instead of returning an empty string (Make json() throw on empty responses sindresorhus/ky#854) sindresorhus/ky@1b8e1ff

Make beforeError hook receive all errors, not just HTTPError (Make beforeError hook receive all errors sindresorhus/ky#829) sindresorhus/ky@101c74b

atomicpages · 2026-04-07T21:50:32Z

-      if (error && typeof error === 'object' && 'response' in error) {
-        const httpError = error as HTTPError;
-        response = httpError.response;
+      if (isHTTPError(error)) {


This should be safe to use: https://github.com/sindresorhus/ky/blob/7d23d68e2614777f240896060f31d77f74f1a0d2/source/utils/type-guards.ts#L8

This has already landed in #3806 , you may wanna pull/rebase from the latest branch.

atomicpages · 2026-04-07T21:51:47Z

-export const client = createClient(
-  createConfig<ClientOptions2>({ baseUrl: 'https://petstore3.swagger.io/api/v3' }),
-);
+export const client = createClient(createConfig<ClientOptions2>({ baseUrl: '/api/v3' }));


Verified the base url remains correct

Instead of altering the example, maybe you can add a test case?

In my own PR, I added an unit test case with mocked fetch to validate that fetch receives proper credential: include

https://github.com/hey-api/openapi-ts/pull/3806/changes#diff-8fb0edada9da43429e2b0d6320cef568f66ddceae516847d9e1c5c2923a68ea5

You can use the similar technique to validate mocked fetch received a proper URL.

pullfrog · 2026-04-07T22:02:48Z

Acknowledged the author's correction on the truthiness thread — '' is falsy so the || fallback still produces {}, matching old behavior. No code changes needed; thread resolved.

Task list (2/3 completed)

Review atomicpages' reply correcting truthiness analysis
Reply acknowledging the correction on the truthiness thread
Report progress

^{｜ View workflow run ｜ Triggered by Pullfrog ｜ 𝕏}

pullfrog · 2026-04-07T22:04:54Z

Fixed the bug in the final error branch of client.ts:212 — replaced error.data (always undefined at that point) with an explicit undefined. Updated the source, 11 snapshots, and the ky example. All 2036 tests pass.

Task list (4/4 completed)

Checkout PR branch and read the file
Fix final branch: replace error.data with explicit undefined
Run tests and update snapshots
Commit, push, and reply to review comment

^{｜ View workflow run ｜ Triggered by Pullfrog ｜ 𝕏}

SukkaW · 2026-04-25T19:50:31Z

@atomicpages Hello, would you like to resolve the conflict? Some of your changes got landed already in my merged PR #3806 (e.g., prefer ky.ishTTPError over instanceof).

There are also other changes as well. I will add a few review comments.

SukkaW · 2026-04-25T19:53:51Z

+
+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.


Technically, this is not true.

AFAIK, the current version of client-ky only respects baseUrl from Hey API's own options, and Hey API always uses the buildUrl function to join the full URL, so the Ky instance will always receive a full URL instead of a relative URL.

In short, Ky's prefixUrl option never worked in the current version of client-ky.

SukkaW · 2026-04-25T19:57:30Z

 export interface Config<T extends ClientOptions = ClientOptions>
  extends
-    Omit<KyOptions, 'body' | 'headers' | 'method' | 'prefixUrl' | 'retry' | 'throwHttpErrors'>,
+    Omit<KyOptions, 'body' | 'headers' | 'method' | 'prefix' | 'retry' | 'throwHttpErrors'>,


Ky v2 also has baseUrl, isn't it?

https://github.com/sindresorhus/ky#baseurl

Also, it would be nice to still include prefixUrl in the list as well, it would be nice to support both Ky v1 and v2 when possible.

SukkaW · 2026-04-25T20:06:28Z

+        return parseErrorResponse(response, request, opts, interceptors, {
+          bodyConsumed: true,
+          data: undefined,
+        });


bodyConsumed issue may (or may not) be resolved by my other yet-to-be-merged PR #3814

In that PR, I use a huge try catch block, so any thrown error may not have its body consumed (remains to be seen, though).

feat: add support for ky v2 hey-api#3724

6e31393

dosubot Bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Apr 7, 2026

dosubot Bot added the feature 🚀 Feature request. label Apr 7, 2026

atomicpages commented Apr 7, 2026

View reviewed changes

pullfrog Bot reviewed Apr 7, 2026

View reviewed changes

Comment thread packages/openapi-ts/src/plugins/@hey-api/client-ky/bundle/client.ts

Comment thread .vscode/settings.json Outdated

Comment thread packages/openapi-ts/src/plugins/@hey-api/client-ky/bundle/client.ts

atomicpages commented Apr 7, 2026

View reviewed changes

chore: remove .vscode/settings.json

273163b

fix: use explicit undefined in final error branch instead of error.data

66797c9

SukkaW reviewed Apr 25, 2026

View reviewed changes


		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.

Uh oh!

Conversation

atomicpages commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bolt-new-by-stackblitz Bot commented Apr 7, 2026

Uh oh!

pullfrog Bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel Bot commented Apr 7, 2026

Uh oh!

changeset-bot Bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

pullfrog Bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Key changes

Ky 2 error handling with isHTTPError and HTTPError.data

Documentation and migration guide for Ky 2

Dependency bumps and snapshot updates

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pullfrog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pullfrog Bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pullfrog Bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SukkaW commented Apr 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

atomicpages commented Apr 7, 2026 •

edited

Loading

pullfrog Bot commented Apr 7, 2026 •

edited

Loading

changeset-bot Bot commented Apr 7, 2026 •

edited

Loading

pullfrog Bot commented Apr 7, 2026 •

edited

Loading

Ky 2 error handling with `isHTTPError` and `HTTPError.data`

pullfrog Bot commented Apr 7, 2026 •

edited

Loading

pullfrog Bot commented Apr 7, 2026 •

edited

Loading

SukkaW commented Apr 25, 2026 •

edited

Loading