Add openapi-typescript-helpers package #1300
Conversation
🦋 Changeset detectedLatest commit: 9ac668b 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 |
drwpow
force-pushed
the
types-helper-package
branch
from
3a1445c
to
adcd95a
Compare
Deploying with
|
| Latest commit: |
9ac668b
|
| Status: | ⚡️ Build in progress... |
drwpow
force-pushed
the
types-helper-package
branch
7 times, most recently
from
61c5dd4
to
d4e989d
Compare
drwpow
force-pushed
the
types-helper-package
branch
from
d4e989d
to
4eed424
Compare
| /** Return `content` for a Response Object */ | ||
| export type ResponseContent<T> = T extends { content: any } ? T["content"] : unknown; | ||
| /** Return `requestBody` for an Operation Object */ | ||
| export type OperationRequestBody<T> = T extends { requestBody?: any } ? T["requestBody"] : never; |
There was a problem hiding this comment.
Almost all the types got renamed. As I was writing down JSDoc descriptions for each, I realized that none of the names made sense (they were close, but didn’t accurately describe how they were actually functioning… in fairness a lot of refactoring happened, though, and the names probably were not kept up with well)
| } | ||
|
|
||
| return { | ||
| /** Call a GET endpoint */ | ||
| async GET<P extends PathsWith<Paths, "get">>(url: P, init: FetchOptions<FilterKeys<Paths[P], "get">>) { | ||
| async GET<P extends PathsWithMethod<Paths, "get">>(url: P, init: FetchOptions<FilterKeys<Paths[P], "get">>) { |
There was a problem hiding this comment.
On a related note: type names became more verbose, but for the sake of clarity
| export type RequestOptions<T> = Params<T> & | ||
| RequestBody<T> & { | ||
| export type ParamsOption<T> = T extends { parameters: any } ? { params: NonNullable<T["parameters"]> } : DefaultParamsOption; | ||
| export type RequestBodyOption<T> = OperationRequestBodyContent<T> extends never ? { body?: never } : undefined extends OperationRequestBodyContent<T> ? { body?: OperationRequestBodyContent<T> } : { body: OperationRequestBodyContent<T> }; |
There was a problem hiding this comment.
The types that were left in here are opinionated and meant specifically for openapi-fetch. They are still exported so they can still be used. But hints at “you’re probably only importing this because you want to mimic / mock openapi-fetch behavior specifically” while leaving the generic usecases to the new types package
drwpow
force-pushed
the
types-helper-package
branch
from
b6a33d1
to
9ac668b
Compare
Changes
Adds
openapi-typescript-helperspackage, as suggested in #1259. Still a bit of a WIP, but will be nice just being able to have types for anything that comes up. That way we have itHow to Review
openapi-fetchespecially)Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)