feat: error handling + withResponse + includeClient option #92
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
astahmer
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR introduces improved type-safe error handling and response access capabilities to the typed OpenAPI client. It adds a withResponse option that allows developers to access both success and error responses through a unified interface while maintaining backward compatibility.
- Adds
withResponseparameter to enable type-safe error handling with Response object access - Unifies response data access pattern with consistent
dataproperty for both success and error cases - Introduces
responsesschema definitions for all endpoints to support proper error typing
Reviewed Changes
Copilot reviewed 36 out of 36 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| test-new-api.ts | Test file demonstrating the new withResponse API with type inference validation |
| packages/typed-openapi/tests/snapshots/*.ts | Updated all client variations (zod, yup, valibot, typebox, io-ts, client, arktype) with new error handling types and withResponse method overloads |
commit: |
commit: |
Adds CLI options for client inclusion and success codes Introduces flags to control API client generation and customize success status codes via the command line, enhancing flexibility for different use cases.
Improves type-safe API error handling and response access Refactors API client response typing to unify success and error data under a consistent interface. Replaces separate error property with direct data access and ensures the Response object retains its methods. Updates documentation with clearer examples for type-safe error handling and data access patterns. Facilitates more ergonomic and predictable client usage, especially for error cases.
Adds type-safe error handling to TanStack Query generator Introduces discriminated unions and configurable success status codes for more robust error handling in generated TanStack Query clients. Supports advanced mutation options with `withResponse` and `selectFn` to enable granular control over success and error transformations in API responses. Improves documentation to highlight new error handling features and integration patterns.
… mutations test: add integration tests for the tanstack runtime feat: expose runtime status codes + new InferResponseByStatus type ci: fix
astahmer
force-pushed
the
feat/error-handling
branch
from
6441c58 to
7d35869
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Improves type-safe API error handling and response access
Refactors API client response typing to unify success and error data under a consistent interface.
Replaces separate error property with direct data access and ensures the Response object retains its methods.
Updates documentation with clearer examples for type-safe error handling and data access patterns.
Facilitates more ergonomic and predictable client usage, especially for error cases.