mokkenstorm.dev
fork of hey-api/openapi-ts because I need some additional things
1# @docs/openapi-ts
2
3## 0.10.4
4
5### Patch Changes
6
7- docs: add bigint section to transformers ([#2865](https://github.com/hey-api/openapi-ts/pull/2865)) ([`ba4d9bf`](https://github.com/hey-api/openapi-ts/commit/ba4d9bf603d8c897016fd1775d13e184111ace17)) by [@wn-mitch](https://github.com/wn-mitch)
8
9## 0.10.3
10
11### Patch Changes
12
13- chore: clarify TanStack Query reactivity in Vue ([#2745](https://github.com/hey-api/openapi-ts/pull/2745)) ([`5d06dbd`](https://github.com/hey-api/openapi-ts/commit/5d06dbdf8c2a834ecefdd7305b59572470f45a7e)) by [@9M6](https://github.com/9M6)
14
15## 0.10.2
16
17### Patch Changes
18
19- [#2117](https://github.com/hey-api/openapi-ts/pull/2117) [`a1435b9`](https://github.com/hey-api/openapi-ts/commit/a1435b915a272d9ffa599c194ee52c2a33f77fcd) Thanks [@johnny-mh](https://github.com/johnny-mh)! - docs: add docs for `input.patch` feature
20
21## 0.10.1
22
23### Patch Changes
24
25- [#1774](https://github.com/hey-api/openapi-ts/pull/1774) [`c0b36b9`](https://github.com/hey-api/openapi-ts/commit/c0b36b95645d484034c3af145c5554867568979b) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: announce Hey API platform
26
27## 0.10.0
28
29### Minor Changes
30
31- [#1568](https://github.com/hey-api/openapi-ts/pull/1568) [`465410c`](https://github.com/hey-api/openapi-ts/commit/465410c201eb19e737e3143ad53a146e95f80107) Thanks [@mrlubos](https://github.com/mrlubos)! - feat: change the default parser
32
33## 0.9.0
34
35### Minor Changes
36
37- [#1511](https://github.com/hey-api/openapi-ts/pull/1511) [`4e8064d`](https://github.com/hey-api/openapi-ts/commit/4e8064d9a589e14b42d2b1a329e2436f242884da) Thanks [@mrlubos](https://github.com/mrlubos)! - feat: add watch mode
38
39 ## Watch Mode
40
41 ::: warning
42 Watch mode currently supports only remote files via URL.
43 :::
44
45 If your schema changes frequently, you may want to automatically regenerate the output during development. To watch your input file for changes, enable `watch` mode in your configuration or pass the `--watch` flag to the CLI.
46
47 ### Config
48
49 ```js
50 export default {
51 client: '@hey-api/client-fetch',
52 input: 'path/to/openapi.json',
53 output: 'src/client',
54 watch: true,
55 };
56 ```
57
58 ### CLI
59
60 ```sh
61 npx @hey-api/openapi-ts \
62 -c @hey-api/client-fetch \
63 -i path/to/openapi.json \
64 -o src/client \
65 -w
66 ```
67
68### Patch Changes
69
70- [#1496](https://github.com/hey-api/openapi-ts/pull/1496) [`1e418ba`](https://github.com/hey-api/openapi-ts/commit/1e418ba760b9903326ec37009651c32e195e24a9) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: split output section into multiple pages
71
72## 0.8.0
73
74### Minor Changes
75
76- [#1447](https://github.com/hey-api/openapi-ts/pull/1447) [`200821b`](https://github.com/hey-api/openapi-ts/commit/200821b3ceea8ffca7656fe3f6e2ef98b7110a2a) Thanks [@mrlubos](https://github.com/mrlubos)! - fix: revert license to MIT
77
78### Patch Changes
79
80- [#1430](https://github.com/hey-api/openapi-ts/pull/1430) [`9cec9e8`](https://github.com/hey-api/openapi-ts/commit/9cec9e8582c12a8c041b922d9587e16f6f19782a) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: add validators page
81
82## 0.7.4
83
84### Patch Changes
85
86- [#1420](https://github.com/hey-api/openapi-ts/pull/1420) [`8010dbb`](https://github.com/hey-api/openapi-ts/commit/8010dbb1ab8b91d1d49d5cf16276183764a63ff3) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: add buildUrl() method to Axios client page
87
88## 0.7.3
89
90### Patch Changes
91
92- [#1316](https://github.com/hey-api/openapi-ts/pull/1316) [`a79fac8`](https://github.com/hey-api/openapi-ts/commit/a79fac8919ed29eec7195cbd441ffa38b559d63c) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: add Plugins page
93
94## 0.7.2
95
96### Patch Changes
97
98- [#1253](https://github.com/hey-api/openapi-ts/pull/1253) [`01dee3d`](https://github.com/hey-api/openapi-ts/commit/01dee3df879232939e43355231147b3d910fb482) Thanks [@mrlubos](https://github.com/mrlubos)! - fix: update sponsorship links
99
100## 0.7.1
101
102### Patch Changes
103
104- [#1222](https://github.com/hey-api/openapi-ts/pull/1222) [`ceb4363`](https://github.com/hey-api/openapi-ts/commit/ceb4363d52893ebe947e21aac402b868ff2820d4) Thanks [@mrlubos](https://github.com/mrlubos)! - feat: add support for @tanstack/angular-query-experimental package
105
106## 0.7.0
107
108### Minor Changes
109
110- [#1201](https://github.com/hey-api/openapi-ts/pull/1201) [`972a93a`](https://github.com/hey-api/openapi-ts/commit/972a93a91a945cc9ead73c08bb0fa9ee120433ba) Thanks [@mrlubos](https://github.com/mrlubos)! - feat: make plugins first-class citizens
111
112 This release makes plugins first-class citizens. In order to achieve that, the following breaking changes were introduced.
113
114 ### Removed CLI options
115
116 The `--types`, `--schemas`, and `--services` CLI options have been removed. You can list which plugins you'd like to use explicitly by passing a list of plugins as `--plugins <plugin1> <plugin2>`
117
118 ### Removed `*.export` option
119
120 Previously, you could explicitly disable export of certain artifacts using the `*.export` option or its shorthand variant. These were both removed. You can now disable export of specific artifacts by manually defining an array of `plugins` and excluding the unwanted plugin.
121
122 ::: code-group
123
124 ```js [shorthand]
125 export default {
126 client: '@hey-api/client-fetch',
127 input: 'path/to/openapi.json',
128 output: 'src/client',
129 schemas: false, // [!code --]
130 plugins: ['@hey-api/types', '@hey-api/services'], // [!code ++]
131 };
132 ```
133
134 ```js [*.export]
135 export default {
136 client: '@hey-api/client-fetch',
137 input: 'path/to/openapi.json',
138 output: 'src/client',
139 schemas: {
140 export: false, // [!code --]
141 },
142 plugins: ['@hey-api/types', '@hey-api/services'], // [!code ++]
143 };
144 ```
145
146 :::
147
148 ### Renamed `schemas.name` option
149
150 Each plugin definition contains a `name` field. This was conflicting with the `schemas.name` option. As a result, it has been renamed to `nameBuilder`.
151
152 ```js
153 export default {
154 client: '@hey-api/client-fetch',
155 input: 'path/to/openapi.json',
156 output: 'src/client',
157 schemas: {
158 name: (name) => `${name}Schema`, // [!code --]
159 },
160 plugins: [
161 // ...other plugins
162 {
163 nameBuilder: (name) => `${name}Schema`, // [!code ++]
164 name: '@hey-api/schemas',
165 },
166 ],
167 };
168 ```
169
170 ### Removed `services.include` shorthand option
171
172 Previously, you could use a string value as a shorthand for the `services.include` configuration option. You can now achieve the same result using the `include` option.
173
174 ```js
175 export default {
176 client: '@hey-api/client-fetch',
177 input: 'path/to/openapi.json',
178 output: 'src/client',
179 services: '^MySchema', // [!code --]
180 plugins: [
181 // ...other plugins
182 {
183 include: '^MySchema', // [!code ++]
184 name: '@hey-api/services',
185 },
186 ],
187 };
188 ```
189
190 ### Renamed `services.name` option
191
192 Each plugin definition contains a `name` field. This was conflicting with the `services.name` option. As a result, it has been renamed to `serviceNameBuilder`.
193
194 ```js
195 export default {
196 client: '@hey-api/client-fetch',
197 input: 'path/to/openapi.json',
198 output: 'src/client',
199 services: {
200 name: '{{name}}Service', // [!code --]
201 },
202 plugins: [
203 // ...other plugins
204 {
205 serviceNameBuilder: '{{name}}Service', // [!code ++]
206 name: '@hey-api/services',
207 },
208 ],
209 };
210 ```
211
212 ### Renamed `types.dates` option
213
214 Previously, you could set `types.dates` to a boolean or a string value, depending on whether you wanted to transform only type strings into dates, or runtime code too. Many people found these options confusing, so they have been simplified to a boolean and extracted into a separate `@hey-api/transformers` plugin.
215
216 ```js
217 export default {
218 client: '@hey-api/client-fetch',
219 input: 'path/to/openapi.json',
220 output: 'src/client',
221 types: {
222 dates: 'types+transform', // [!code --]
223 },
224 plugins: [
225 // ...other plugins
226 {
227 dates: true, // [!code ++]
228 name: '@hey-api/transformers',
229 },
230 ],
231 };
232 ```
233
234 ### Removed `types.include` shorthand option
235
236 Previously, you could use a string value as a shorthand for the `types.include` configuration option. You can now achieve the same result using the `include` option.
237
238 ```js
239 export default {
240 client: '@hey-api/client-fetch',
241 input: 'path/to/openapi.json',
242 output: 'src/client',
243 types: '^MySchema', // [!code --]
244 plugins: [
245 // ...other plugins
246 {
247 include: '^MySchema', // [!code ++]
248 name: '@hey-api/types',
249 },
250 ],
251 };
252 ```
253
254 ### Renamed `types.name` option
255
256 Each plugin definition contains a `name` field. This was conflicting with the `types.name` option. As a result, it has been renamed to `style`.
257
258 ```js
259 export default {
260 client: '@hey-api/client-fetch',
261 input: 'path/to/openapi.json',
262 output: 'src/client',
263 types: {
264 name: 'PascalCase', // [!code --]
265 },
266 plugins: [
267 // ...other plugins
268 {
269 name: '@hey-api/types',
270 style: 'PascalCase', // [!code ++]
271 },
272 ],
273 };
274 ```
275
276## 0.6.2
277
278### Patch Changes
279
280- [#1162](https://github.com/hey-api/openapi-ts/pull/1162) [`1c85c24`](https://github.com/hey-api/openapi-ts/commit/1c85c24af514e9781aab1960298caa28effef5d3) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: add Zod plugin page
281
282## 0.6.1
283
284### Patch Changes
285
286- [#1151](https://github.com/hey-api/openapi-ts/pull/1151) [`587791d`](https://github.com/hey-api/openapi-ts/commit/587791dfede0167fbed229281467e4c4875936f5) Thanks [@mrlubos](https://github.com/mrlubos)! - fix: update website domain, add license documentation
287
288## 0.6.0
289
290### Minor Changes
291
292- [#1009](https://github.com/hey-api/openapi-ts/pull/1009) [`c6b044d`](https://github.com/hey-api/openapi-ts/commit/c6b044d0bc9dc54cb0eb58d23438f4e1d050cb38) Thanks [@mrlubos](https://github.com/mrlubos)! - feat: change schemas name pattern, add schemas.name option
293
294## 0.5.11
295
296### Patch Changes
297
298- [#978](https://github.com/hey-api/openapi-ts/pull/978) [`2e051a5`](https://github.com/hey-api/openapi-ts/commit/2e051a596302c2e103dca25951a07b4aae1e9e23) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: add basic TanStack Query plugin description
299
300## 0.5.10
301
302### Patch Changes
303
304- [#830](https://github.com/hey-api/openapi-ts/pull/830) [`babf11a`](https://github.com/hey-api/openapi-ts/commit/babf11ae082af642ac71cfee9c523cc976132a50) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: split clients documentation into separate pages
305
306- [#830](https://github.com/hey-api/openapi-ts/pull/830) [`323d0a0`](https://github.com/hey-api/openapi-ts/commit/323d0a03c6560f27d0ce5eee1708ee16dc395532) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: remove interceptors page in favour of per-client sections
307
308- [#830](https://github.com/hey-api/openapi-ts/pull/830) [`babf11a`](https://github.com/hey-api/openapi-ts/commit/babf11ae082af642ac71cfee9c523cc976132a50) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: add v0.52.0 migration
309
310## 0.5.9
311
312### Patch Changes
313
314- [#828](https://github.com/hey-api/openapi-ts/pull/828) [`82a4696`](https://github.com/hey-api/openapi-ts/commit/82a4696b0b209ea2d9147f47f213479e61aed3d7) Thanks [@mrlubos](https://github.com/mrlubos)! - fix: add migration guide for v0.51.0
315
316## 0.5.8
317
318### Patch Changes
319
320- [#613](https://github.com/hey-api/openapi-ts/pull/613) [`b3786dc`](https://github.com/hey-api/openapi-ts/commit/b3786dc6749d8d4ae26bb63322e124663f881741) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: add Axios client documentation
321
322## 0.5.7
323
324### Patch Changes
325
326- [#632](https://github.com/hey-api/openapi-ts/pull/632) [`9c16bc7`](https://github.com/hey-api/openapi-ts/commit/9c16bc71cde48c0cb700b7e720a9e2ad56ec5f02) Thanks [@mrlubos](https://github.com/mrlubos)! - docs: add output page
327
328## 0.5.6
329
330### Patch Changes
331
332- docs: add fetch client documentation ([#602](https://github.com/hey-api/openapi-ts/pull/602))
333
334- docs: add migration notes for v0.46.0 ([#602](https://github.com/hey-api/openapi-ts/pull/602))
335
336## 0.5.5
337
338### Patch Changes
339
340- docs: add migration for v0.45.0 ([#569](https://github.com/hey-api/openapi-ts/pull/569))
341
342## 0.5.4
343
344### Patch Changes
345
346- docs: add format and lint migration for 0.44.0 ([#546](https://github.com/hey-api/openapi-ts/pull/546))
347
348## 0.5.3
349
350### Patch Changes
351
352- docs: add links to homepage ([#489](https://github.com/hey-api/openapi-ts/pull/489))
353
354- feat: remove enum postfix, use typescript enums in types when generated, export enums from types.gen.ts ([#498](https://github.com/hey-api/openapi-ts/pull/498))
355
356- docs: add examples ([#476](https://github.com/hey-api/openapi-ts/pull/476))
357
358## 0.5.2
359
360### Patch Changes
361
362- docs: add github action to integrations ([#451](https://github.com/hey-api/openapi-ts/pull/451))
363
364## 0.5.1
365
366### Patch Changes
367
368- docs: add tanstack-query and http clients sections ([#436](https://github.com/hey-api/openapi-ts/pull/436))
369
370## 0.5.0
371
372### Minor Changes
373
374- feat: allow choosing naming convention for types ([#402](https://github.com/hey-api/openapi-ts/pull/402))
375
376## 0.4.0
377
378### Minor Changes
379
380- docs: add integrations ([#394](https://github.com/hey-api/openapi-ts/pull/394))
381
382- feat: rename generated files ([#363](https://github.com/hey-api/openapi-ts/pull/363))
383
384### Patch Changes
385
386- docs: add enums migration ([#358](https://github.com/hey-api/openapi-ts/pull/358))
387
388## 0.3.0
389
390### Minor Changes
391
392- fix: rename write to dryRun and invert value ([#326](https://github.com/hey-api/openapi-ts/pull/326))
393
394### Patch Changes
395
396- docs: update contributing guidelines ([#347](https://github.com/hey-api/openapi-ts/pull/347))
397
398## 0.2.2
399
400### Patch Changes
401
402- docs: add migration notes ([#306](https://github.com/hey-api/openapi-ts/pull/306))
403
404## 0.2.1
405
406### Patch Changes
407
408- fix(config): rename exportSchemas to schemas ([#288](https://github.com/hey-api/openapi-ts/pull/288))
409
410## 0.2.0
411
412### Minor Changes
413
414- docs: add support for localization of docs ([#251](https://github.com/hey-api/openapi-ts/pull/251))
415
416### Patch Changes
417
418- docs: add logo ([#250](https://github.com/hey-api/openapi-ts/pull/250))