@hey-api/openapi-ts 0.86.12 → 0.87.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -14
- package/dist/clients/angular/index.ts +0 -1
- package/dist/clients/angular/types.ts +0 -27
- package/dist/clients/axios/index.ts +0 -1
- package/dist/clients/axios/types.ts +0 -19
- package/dist/clients/fetch/index.ts +0 -1
- package/dist/clients/fetch/types.ts +0 -27
- package/dist/clients/next/index.ts +0 -1
- package/dist/clients/next/types.ts +0 -19
- package/dist/clients/nuxt/index.ts +0 -1
- package/dist/clients/nuxt/types.ts +0 -12
- package/dist/clients/ofetch/index.ts +0 -1
- package/dist/clients/ofetch/types.ts +0 -27
- package/dist/{types-BRmx9r9T.d.ts → config-CNi83ZTD.d.ts} +1395 -2417
- package/dist/{types-Dh80P1tV.d.cts → config-PWeoedFF.d.cts} +1447 -2471
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +470 -25
- package/dist/index.d.ts +459 -16
- package/dist/index.js +1 -1
- package/dist/internal.cjs +1 -1
- package/dist/internal.d.cts +38 -1
- package/dist/internal.d.ts +38 -1
- package/dist/internal.js +1 -1
- package/dist/openApi-CCTdD3hW.cjs +19 -0
- package/dist/openApi-CCTdD3hW.cjs.map +1 -0
- package/dist/openApi-D7xrG_wR.js +19 -0
- package/dist/openApi-D7xrG_wR.js.map +1 -0
- package/dist/run.cjs +1 -1
- package/dist/run.cjs.map +1 -1
- package/dist/run.js +1 -1
- package/dist/run.js.map +1 -1
- package/dist/src-CZCpIWy7.js +11 -0
- package/dist/src-CZCpIWy7.js.map +1 -0
- package/dist/src-Cvd6zAsc.cjs +19 -0
- package/dist/src-Cvd6zAsc.cjs.map +1 -0
- package/package.json +1 -4
- package/dist/getSpec-1BMHZkPH.js +0 -25
- package/dist/getSpec-1BMHZkPH.js.map +0 -1
- package/dist/getSpec-xn4as4li.cjs +0 -25
- package/dist/getSpec-xn4as4li.cjs.map +0 -1
- package/dist/src-CQ_69Vcm.js +0 -1310
- package/dist/src-CQ_69Vcm.js.map +0 -1
- package/dist/src-DptUs1Ky.cjs +0 -1318
- package/dist/src-DptUs1Ky.cjs.map +0 -1
package/README.md
CHANGED
|
@@ -1,16 +1,14 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
<img alt="Two people looking at the blueprint" height="214" src="https://heyapi.dev/images/blueprint-640w.png" width="320">
|
|
3
|
-
<h1
|
|
4
|
-
<p
|
|
3
|
+
<h1><b>OpenAPI TypeScript</b></h1>
|
|
4
|
+
<p><em>“OpenAPI codegen that just works.”</em><br/><sub>— Guillermo Rauch, CEO of Vercel</sub></p>
|
|
5
5
|
</div>
|
|
6
6
|
|
|
7
|
-
<br/>
|
|
8
|
-
|
|
9
7
|
<p align="center">
|
|
10
|
-
<a href="https://opensource.org/license/mit" rel="nofollow"><img src="https://img.shields.io/github/license/hey-api/openapi-ts" alt="MIT License"></a>
|
|
11
8
|
<a href="https://npmjs.com/package/@hey-api/openapi-ts" rel="nofollow"><img src="https://img.shields.io/npm/dm/%40hey-api%2Fopenapi-ts?label=npm" alt="npm downloads"></a>
|
|
12
|
-
<a href="https://github.com/hey-api/openapi-ts" rel="nofollow"><img src="https://img.shields.io/github/stars/hey-api/openapi-ts?style=flat&logo=github&label=GitHub&color=54C82D" alt="GitHub stars" /></a>
|
|
13
9
|
<a href="https://github.com/hey-api/openapi-ts/actions?query=branch%3Amain"><img src="https://github.com/hey-api/openapi-ts/actions/workflows/ci.yml/badge.svg?event=push&branch=main" alt="CI status" /></a>
|
|
10
|
+
<a href="https://github.com/hey-api/openapi-ts" rel="nofollow"><img src="https://img.shields.io/github/stars/hey-api/openapi-ts?style=flat&logo=github&label=GitHub&color=54C82D" alt="GitHub stars" /></a>
|
|
11
|
+
<a href="https://github.com/hey-api/openapi-ts/blob/main/LICENSE.md" rel="nofollow"><img src="https://img.shields.io/github/license/hey-api/openapi-ts" alt="MIT License"></a>
|
|
14
12
|
</p>
|
|
15
13
|
|
|
16
14
|
<p align="center">
|
|
@@ -20,14 +18,12 @@
|
|
|
20
18
|
<span> • </span>
|
|
21
19
|
<a href="https://github.com/hey-api/openapi-ts/issues">Issues</a>
|
|
22
20
|
<span> • </span>
|
|
23
|
-
<a href="https://github.com/orgs/hey-api/discussions/1495">Roadmap</a>
|
|
24
|
-
<span> • </span>
|
|
25
21
|
<a href="https://heyapi.dev/openapi-ts/community/contributing">Contribute</a>
|
|
26
|
-
<span> • </span>
|
|
27
|
-
<a href="https://heyapi.dev/openapi-ts/community/spotlight#core-team">Join Core Team</a>
|
|
28
22
|
</p>
|
|
29
23
|
|
|
30
|
-
|
|
24
|
+
## About
|
|
25
|
+
|
|
26
|
+
[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an [open source](https://github.com/hey-api/openapi-ts/blob/main/LICENSE.md) OpenAPI to TypeScript code generator trusted by companies like Google, Amazon, and PayPal to generate API clients, SDKs, validators, and more. We also build complementary tools and [services](https://app.heyapi.dev/) that help teams design, manage, and distribute APIs more effectively.
|
|
31
27
|
|
|
32
28
|
## Features
|
|
33
29
|
|
|
@@ -41,9 +37,7 @@
|
|
|
41
37
|
|
|
42
38
|
## Dashboard
|
|
43
39
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
[Sign In](https://app.heyapi.dev) to Hey API Platform.
|
|
40
|
+
Access your projects and OpenAPI specifications in the [Hey API Platform](https://app.heyapi.dev/).
|
|
47
41
|
|
|
48
42
|
## Contributing
|
|
49
43
|
|
|
@@ -252,30 +252,3 @@ export type Options<
|
|
|
252
252
|
'body' | 'path' | 'query' | 'url'
|
|
253
253
|
> &
|
|
254
254
|
([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
255
|
-
|
|
256
|
-
export type OptionsLegacyParser<
|
|
257
|
-
TData = unknown,
|
|
258
|
-
ThrowOnError extends boolean = boolean,
|
|
259
|
-
TResponseStyle extends ResponseStyle = 'fields',
|
|
260
|
-
> = TData extends { body?: any }
|
|
261
|
-
? TData extends { headers?: any }
|
|
262
|
-
? OmitKeys<
|
|
263
|
-
RequestOptions<unknown, TResponseStyle, ThrowOnError>,
|
|
264
|
-
'body' | 'headers' | 'url'
|
|
265
|
-
> &
|
|
266
|
-
TData
|
|
267
|
-
: OmitKeys<
|
|
268
|
-
RequestOptions<unknown, TResponseStyle, ThrowOnError>,
|
|
269
|
-
'body' | 'url'
|
|
270
|
-
> &
|
|
271
|
-
TData &
|
|
272
|
-
Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'headers'>
|
|
273
|
-
: TData extends { headers?: any }
|
|
274
|
-
? OmitKeys<
|
|
275
|
-
RequestOptions<unknown, TResponseStyle, ThrowOnError>,
|
|
276
|
-
'headers' | 'url'
|
|
277
|
-
> &
|
|
278
|
-
TData &
|
|
279
|
-
Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body'>
|
|
280
|
-
: OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'url'> &
|
|
281
|
-
TData;
|
|
@@ -193,22 +193,3 @@ export type Options<
|
|
|
193
193
|
'body' | 'path' | 'query' | 'url'
|
|
194
194
|
> &
|
|
195
195
|
([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
196
|
-
|
|
197
|
-
export type OptionsLegacyParser<
|
|
198
|
-
TData = unknown,
|
|
199
|
-
ThrowOnError extends boolean = boolean,
|
|
200
|
-
> = TData extends { body?: any }
|
|
201
|
-
? TData extends { headers?: any }
|
|
202
|
-
? OmitKeys<
|
|
203
|
-
RequestOptions<unknown, ThrowOnError>,
|
|
204
|
-
'body' | 'headers' | 'url'
|
|
205
|
-
> &
|
|
206
|
-
TData
|
|
207
|
-
: OmitKeys<RequestOptions<unknown, ThrowOnError>, 'body' | 'url'> &
|
|
208
|
-
TData &
|
|
209
|
-
Pick<RequestOptions<unknown, ThrowOnError>, 'headers'>
|
|
210
|
-
: TData extends { headers?: any }
|
|
211
|
-
? OmitKeys<RequestOptions<unknown, ThrowOnError>, 'headers' | 'url'> &
|
|
212
|
-
TData &
|
|
213
|
-
Pick<RequestOptions<unknown, ThrowOnError>, 'body'>
|
|
214
|
-
: OmitKeys<RequestOptions<unknown, ThrowOnError>, 'url'> & TData;
|
|
@@ -237,30 +237,3 @@ export type Options<
|
|
|
237
237
|
'body' | 'path' | 'query' | 'url'
|
|
238
238
|
> &
|
|
239
239
|
([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
240
|
-
|
|
241
|
-
export type OptionsLegacyParser<
|
|
242
|
-
TData = unknown,
|
|
243
|
-
ThrowOnError extends boolean = boolean,
|
|
244
|
-
TResponseStyle extends ResponseStyle = 'fields',
|
|
245
|
-
> = TData extends { body?: any }
|
|
246
|
-
? TData extends { headers?: any }
|
|
247
|
-
? OmitKeys<
|
|
248
|
-
RequestOptions<unknown, TResponseStyle, ThrowOnError>,
|
|
249
|
-
'body' | 'headers' | 'url'
|
|
250
|
-
> &
|
|
251
|
-
TData
|
|
252
|
-
: OmitKeys<
|
|
253
|
-
RequestOptions<unknown, TResponseStyle, ThrowOnError>,
|
|
254
|
-
'body' | 'url'
|
|
255
|
-
> &
|
|
256
|
-
TData &
|
|
257
|
-
Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'headers'>
|
|
258
|
-
: TData extends { headers?: any }
|
|
259
|
-
? OmitKeys<
|
|
260
|
-
RequestOptions<unknown, TResponseStyle, ThrowOnError>,
|
|
261
|
-
'headers' | 'url'
|
|
262
|
-
> &
|
|
263
|
-
TData &
|
|
264
|
-
Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body'>
|
|
265
|
-
: OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'url'> &
|
|
266
|
-
TData;
|
|
@@ -194,22 +194,3 @@ export type Options<
|
|
|
194
194
|
'body' | 'path' | 'query' | 'url'
|
|
195
195
|
> &
|
|
196
196
|
([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
197
|
-
|
|
198
|
-
export type OptionsLegacyParser<
|
|
199
|
-
TData = unknown,
|
|
200
|
-
ThrowOnError extends boolean = boolean,
|
|
201
|
-
> = TData extends { body?: any }
|
|
202
|
-
? TData extends { headers?: any }
|
|
203
|
-
? OmitKeys<
|
|
204
|
-
RequestOptions<unknown, ThrowOnError>,
|
|
205
|
-
'body' | 'headers' | 'url'
|
|
206
|
-
> &
|
|
207
|
-
TData
|
|
208
|
-
: OmitKeys<RequestOptions<unknown, ThrowOnError>, 'body' | 'url'> &
|
|
209
|
-
TData &
|
|
210
|
-
Pick<RequestOptions<unknown, ThrowOnError>, 'headers'>
|
|
211
|
-
: TData extends { headers?: any }
|
|
212
|
-
? OmitKeys<RequestOptions<unknown, ThrowOnError>, 'headers' | 'url'> &
|
|
213
|
-
TData &
|
|
214
|
-
Pick<RequestOptions<unknown, ThrowOnError>, 'body'>
|
|
215
|
-
: OmitKeys<RequestOptions<unknown, ThrowOnError>, 'url'> & TData;
|
|
@@ -189,18 +189,6 @@ export type Options<
|
|
|
189
189
|
> &
|
|
190
190
|
([TData] extends [never] ? unknown : WithRefs<Omit<TData, 'url'>>);
|
|
191
191
|
|
|
192
|
-
export type OptionsLegacyParser<TData = unknown> = TData extends { body?: any }
|
|
193
|
-
? TData extends { headers?: any }
|
|
194
|
-
? OmitKeys<RequestOptions, 'body' | 'headers' | 'url'> & TData
|
|
195
|
-
: OmitKeys<RequestOptions, 'body' | 'url'> &
|
|
196
|
-
TData &
|
|
197
|
-
Pick<RequestOptions, 'headers'>
|
|
198
|
-
: TData extends { headers?: any }
|
|
199
|
-
? OmitKeys<RequestOptions, 'headers' | 'url'> &
|
|
200
|
-
TData &
|
|
201
|
-
Pick<RequestOptions, 'body'>
|
|
202
|
-
: OmitKeys<RequestOptions, 'url'> & TData;
|
|
203
|
-
|
|
204
192
|
type FetchOptions<TData> = Omit<
|
|
205
193
|
UseFetchOptions<TData, TData>,
|
|
206
194
|
keyof AsyncDataOptions<TData>
|
|
@@ -304,30 +304,3 @@ export type Options<
|
|
|
304
304
|
'body' | 'path' | 'query' | 'url'
|
|
305
305
|
> &
|
|
306
306
|
([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
307
|
-
|
|
308
|
-
export type OptionsLegacyParser<
|
|
309
|
-
TData = unknown,
|
|
310
|
-
ThrowOnError extends boolean = boolean,
|
|
311
|
-
TResponseStyle extends ResponseStyle = 'fields',
|
|
312
|
-
> = TData extends { body?: any }
|
|
313
|
-
? TData extends { headers?: any }
|
|
314
|
-
? OmitKeys<
|
|
315
|
-
RequestOptions<unknown, TResponseStyle, ThrowOnError>,
|
|
316
|
-
'body' | 'headers' | 'url'
|
|
317
|
-
> &
|
|
318
|
-
TData
|
|
319
|
-
: OmitKeys<
|
|
320
|
-
RequestOptions<unknown, TResponseStyle, ThrowOnError>,
|
|
321
|
-
'body' | 'url'
|
|
322
|
-
> &
|
|
323
|
-
TData &
|
|
324
|
-
Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'headers'>
|
|
325
|
-
: TData extends { headers?: any }
|
|
326
|
-
? OmitKeys<
|
|
327
|
-
RequestOptions<unknown, TResponseStyle, ThrowOnError>,
|
|
328
|
-
'headers' | 'url'
|
|
329
|
-
> &
|
|
330
|
-
TData &
|
|
331
|
-
Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body'>
|
|
332
|
-
: OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'url'> &
|
|
333
|
-
TData;
|