Skip to content

fix(openapi-typescript-helpers): fix SuccessResponseJSON and ErrorResponseJSON helpers #1871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 29, 2024

Conversation

brunolca
Copy link
Contributor

Changes

fix SuccessResponseJSON and ErrorResponseJSON helpers

How to Review

Should fix issue #1785

I tested it with the following code:

import type { ErrorResponseJSON, SuccessResponseJSON } from "./index.d.ts";
import type { components, paths } from "./v1.d.ts";

type Expect<T extends true> = T;
type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;

type A = ErrorResponseJSON<paths["/fact"]["get"]>;

type B = number;

type Tests = [
  Expect<Equal<ErrorResponseJSON<paths["/fact"]["get"]>, components["schemas"]["Error"]>>,
  Expect<Equal<SuccessResponseJSON<paths["/breeds"]["get"]>, components["schemas"]["Breed"][]>>,
];

Checklist

  • Unit tests updated
  • docs/ updated (if necessary)

I could add a test.d.ts to test the types but i thought it could (on breaking changes) break the global test script (used in ci...)

@brunolca brunolca requested a review from a team as a code owner August 21, 2024 11:21
Copy link

changeset-bot bot commented Aug 21, 2024

🦋 Changeset detected

Latest commit: bc29324

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
openapi-typescript-helpers Patch
openapi-fetch Patch
openapi-react-query Patch

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

Copy link
Contributor

@drwpow drwpow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@drwpow drwpow merged commit bd88568 into openapi-ts:main Aug 29, 2024
8 checks passed
@github-actions github-actions bot mentioned this pull request Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants