feat: add ky client plugin #2958
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implements @hey-api/client-ky plugin with support for ky HTTP client. Features: - Ky integration with native retry, timeout, and hooks - Standard interceptors pattern (request/response/error) - Configurable retry options (limit, methods, statusCodes) - Raw ky options via kyOptions escape hatch - Full HTTP method support and SSE - Follows established client plugin architecture The implementation maintains consistency with other client plugins while leveraging ky's powerful built-in features.
|
|
🦋 Changeset detectedLatest commit: 212fcaf The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
dosubot
bot
added
the
size:XL
|
@SebastiaanWouters is attempting to deploy a commit to the Hey API Team on Vercel. A member of the Team first needs to authorize it. |
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #2958 +/- ##
==========================================
+ Coverage 28.58% 29.41% +0.83%
==========================================
Files 394 403 +9
Lines 35186 35766 +580
Branches 1938 2066 +128
==========================================
+ Hits 10057 10522 +465
- Misses 25102 25217 +115
Partials 27 27
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Add test suite for ky client plugin with comprehensive coverage: - buildUrl functionality with various path/query scenarios - zero-length body handling for all content types - unserialized and serialized request body handling - request, response, and error interceptors - error handling with throwOnError option - retry configuration - responseStyle configuration Tests follow patterns from client-fetch and cover all core functionality.
dosubot
bot
added
size:XXL
Fix TypeScript compilation errors without using `as any`: - Use inline array type instead of accessing `KyOptions['retry']['methods']` to avoid type error when retry can be number | object - Add type assertion for headers as HeadersInit to satisfy Request constructor - Change body type from `BodyInit | null` to `unknown` for consistency with client-fetch and to allow testing with edge case values - Use `Partial<KyInstance> as KyInstance` pattern in tests (same as client-axios) to properly type mock ky instances without `as any`
Add example project demonstrating ky client usage: - Created @example/openapi-ts-ky package with React/Vite setup - Configured to use @hey-api/client-ky plugin - Includes generated client code from Swagger Petstore OpenAPI spec Updated build configuration: - Added 'client-ky' to tsdown.config.ts plugin list - Ensures ky bundle files are copied to dist/clients/ky during build - Enables runtime access to ky client implementation This example allows typecheck validation in CI and serves as documentation for ky client integration.
Closed
commit: |
mrlubos
approved these changes
Nov 11, 2025
mrlubos
reviewed
Nov 11, 2025
| * 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<import('ky').Options, 'method' | 'prefixUrl'>; |
Member
There was a problem hiding this comment.
@SebastiaanWouters why did you decide to namespace these instead of extending Config?
Contributor
Author
There was a problem hiding this comment.
Vibe coded v0 sometimes contain weird choices, better to expose ky's API directly here indeed.
mrlubos
reviewed
Nov 11, 2025
|
|
||
| export interface Config<T extends ClientOptions = ClientOptions> | ||
| extends Omit< | ||
| import('ky').Options, |
Member
There was a problem hiding this comment.
@SebastiaanWouters why use dynamic import instead of importing on top?
Contributor
Author
There was a problem hiding this comment.
yes import on top is the better choice here 👍
Contributor
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2794
Implements @hey-api/client-ky plugin with support for ky HTTP client.
Features:
The implementation maintains consistency with other client plugins while leveraging ky's powerful built-in features.