mokkenstorm.dev
fork of hey-api/openapi-ts because I need some additional things
Merge pull request #1253 from hey-api/docs/sponsorship-links
fix: update sponsorship links
+133
-40
+8
.changeset/beige-keys-wonder.md
+8
.changeset/beige-keys-wonder.md
+1
-1
README.md
+1
-1
README.md
+1
-1
docs/.vitepress/config/en.ts
+1
-1
docs/.vitepress/config/en.ts
+90
docs/.vitepress/theme/custom.css
+90
docs/.vitepress/theme/custom.css
···
62
62
.buttonLink:hover {
63
63
color: var(--vp-c-brand-2);
64
64
}
65
+
66
+
.home-list {
67
+
text-align: center;
68
+
}
69
+
70
+
.home-list li {
71
+
list-style: none;
72
+
}
73
+
74
+
.home-list > ul {
75
+
display: flex;
76
+
justify-content: center;
77
+
padding: 0;
78
+
}
79
+
80
+
.home-list > h3 {
81
+
color: var(--vp-c-text-2);
82
+
display: inline-block;
83
+
font-size: 0.9rem;
84
+
margin-top: 2rem;
85
+
text-transform: uppercase;
86
+
}
87
+
88
+
.home-sponsors li {
89
+
align-items: center;
90
+
display: flex;
91
+
height: 100px;
92
+
justify-content: center;
93
+
max-width: 240px;
94
+
width: 100%;
95
+
}
96
+
97
+
.home-sponsors-new > a {
98
+
align-items: center;
99
+
border: 1px solid currentColor;
100
+
border-radius: 10px;
101
+
color: var(--vp-c-text-2);
102
+
display: flex;
103
+
height: 100%;
104
+
justify-content: center;
105
+
text-decoration: none;
106
+
text-transform: lowercase;
107
+
width: 100%;
108
+
}
109
+
110
+
.VPFeatures.VPHomeFeatures {
111
+
padding: 0;
112
+
}
113
+
114
+
.VPFeatures.VPHomeFeatures > .container {
115
+
max-width: initial;
116
+
}
117
+
118
+
.VPFeatures.VPHomeFeatures > .container > .items {
119
+
flex-wrap: nowrap;
120
+
gap: 0.5rem;
121
+
margin: 0;
122
+
overflow-x: auto;
123
+
padding: 0.2rem 1.5rem;
124
+
scroll-padding-inline: 1.5rem;
125
+
scroll-snap-type: x mandatory;
126
+
scrollbar-width: none; /* Firefox */
127
+
-ms-overflow-style: none; /* IE and Edge */
128
+
}
129
+
130
+
@media (min-width: 640px) {
131
+
.VPFeatures.VPHomeFeatures > .container > .items {
132
+
padding: 0.4rem 3rem;
133
+
scroll-padding-inline: 3rem;
134
+
}
135
+
}
136
+
137
+
@media (min-width: 960px) {
138
+
.VPFeatures.VPHomeFeatures > .container > .items {
139
+
padding: 0.5rem 4rem;
140
+
scroll-padding-inline: 4rem;
141
+
}
142
+
}
143
+
144
+
.VPFeatures.VPHomeFeatures > .container > .items::-webkit-scrollbar {
145
+
display: none;
146
+
}
147
+
148
+
.VPFeatures.VPHomeFeatures > .container > .items > .item {
149
+
flex-shrink: 0;
150
+
max-width: 390px;
151
+
padding: 0;
152
+
scroll-snap-align: start;
153
+
width: 100%;
154
+
}
+21
-8
docs/index.md
+21
-8
docs/index.md
···
26
26
details: Ensure code correctness without runtime overhead. No manual maintenance required.
27
27
link: /openapi-ts/output
28
28
linkText: Learn more
29
-
- icon: 🦴
29
+
- icon: <svg class="icon-json-schema xmlns="http://www.w3.org/2000/svg" viewBox="0 0 70.423 70.423" height="24" width="24"><g fill="#fff"><path d="M122.994 114.19c-4.329-.94-7.58-3.479-8.712-6.801-.79-2.316-.677-6.072.333-11.15.485-2.439.882-5.349.882-6.467-.001-3.718-1.712-5.736-5.1-6.017l-1.955-.162v-4.785l1.852-.251c2.702-.366 3.744-1.029 4.576-2.91.611-1.38.689-2.068.505-4.472-.119-1.562-.535-4.349-.924-6.192-.99-4.683-.949-8.485.117-10.773 1.568-3.369 5.437-5.855 9.932-6.383l1.933-.227v5.036h-1.3c-1.771 0-4.25 1.262-4.883 2.488-.608 1.176-.654 2.864-.158 5.802.783 4.644 1.047 9.099.676 11.422-.425 2.658-1.975 5.796-3.68 7.448l-1.18 1.144 1.615 1.983c1.99 2.443 2.765 4.148 3.243 7.142.378 2.369.085 7.283-.67 11.214-1.054 5.485.162 7.652 4.661 8.306l1.676.244v2.448c0 2.792.171 2.697-3.439 1.913z" style="stroke-width:.35277775" transform="translate(-104.228 -45.508)"/><path d="M152.23 112.25v-2.43l2.05-.424c2.263-.467 4.054-1.863 4.459-3.475.127-.507-.113-3.164-.534-5.903-1.372-8.93-.611-13.537 2.855-17.297l1.482-1.608-1.11-1.266c-3.98-4.53-4.67-8.552-3.154-18.37.763-4.945.764-4.993.087-6.173-.797-1.388-3.284-2.776-4.975-2.776h-1.16v-2.47c0-2.81-.058-2.773 3.246-2.072 3.965.841 6.805 2.853 8.278 5.865.846 1.728.973 2.4.95 5.01-.016 1.66-.358 4.683-.762 6.72-1.499 7.564-1.365 9.576.765 11.533.99.908 1.64 1.173 3.37 1.368l2.145.243v4.848h-1.676c-2.151.001-3.932.91-4.838 2.47-.952 1.637-.893 5.206.173 10.406.907 4.422 1.053 8.459.389 10.729-.701 2.394-3.82 5.296-6.748 6.277-1.261.423-2.968.871-3.792.996l-1.5.228z" style="stroke-width:.35277778" transform="translate(-104.228 -45.508)"/><path d="M131.742 108.266c-1.021-1.299-.873-3.537.381-5.732.928-1.624 4.809-6.948 7.61-10.44l1.132-1.41-1.802-5.226c-2.022-5.86-2.01-5.974.656-6.372l1.468-.219 1.64 3.35c.903 1.843 1.77 3.351 1.928 3.351.158 0 1.775-1.755 3.594-3.9 3.16-3.727 3.357-3.892 4.426-3.694.645.12 1.218.047 1.354-.173.318-.515 1.23.247 1.23 1.027 0 .32-.453 1.134-1.009 1.81-2.267 2.755-7.104 9.27-7.104 9.57 0 .177.975 2.454 2.167 5.059l2.166 4.736-.658.985c-.362.541-.662 1.126-.667 1.299-.005.173-.278.483-.606.69-.832.525-1.447-.115-3.99-4.153-1.164-1.848-2.231-3.365-2.372-3.37-.313-.01-3.79 5.133-6.48 9.581-2.37 3.924-1.938 3.42-3.265 3.801-.956.274-1.194.199-1.799-.57zM131.986 83.677c-2.152-3.847-6.019-9.428-7.579-10.938-.792-.767-1.44-1.575-1.44-1.796 0-.601 1.616-1.22 3.19-1.22 1.698 0 3.496 1.479 5.1 4.193.582.985 1.156 1.794 1.276 1.798.12.004.809-1.651 1.53-3.678 1.547-4.34 5.624-12.778 7.225-14.951 1.373-1.863 3.43-2.865 5.903-2.876 3.234-.013 3.243.13.205 3.297-4.636 4.832-6.764 8.81-11.252 21.037-1.246 3.396-2.39 6.48-2.542 6.852-.23.566-.498.281-1.616-1.718z" style="stroke-width:.35277775" transform="translate(-104.228 -45.508)"/></g></svg>
30
30
title: Data Fetching
31
31
details: Type-safe data with our REST clients. Fetch, Axios, Angular, Node, and XHR are available.
32
32
link: /openapi-ts/clients
33
33
linkText: See all clients
34
-
- icon: <svg class="icon-json-schema xmlns="http://www.w3.org/2000/svg" viewBox="0 0 70.423 70.423" height="24" width="24"><g fill="#fff"><path d="M122.994 114.19c-4.329-.94-7.58-3.479-8.712-6.801-.79-2.316-.677-6.072.333-11.15.485-2.439.882-5.349.882-6.467-.001-3.718-1.712-5.736-5.1-6.017l-1.955-.162v-4.785l1.852-.251c2.702-.366 3.744-1.029 4.576-2.91.611-1.38.689-2.068.505-4.472-.119-1.562-.535-4.349-.924-6.192-.99-4.683-.949-8.485.117-10.773 1.568-3.369 5.437-5.855 9.932-6.383l1.933-.227v5.036h-1.3c-1.771 0-4.25 1.262-4.883 2.488-.608 1.176-.654 2.864-.158 5.802.783 4.644 1.047 9.099.676 11.422-.425 2.658-1.975 5.796-3.68 7.448l-1.18 1.144 1.615 1.983c1.99 2.443 2.765 4.148 3.243 7.142.378 2.369.085 7.283-.67 11.214-1.054 5.485.162 7.652 4.661 8.306l1.676.244v2.448c0 2.792.171 2.697-3.439 1.913z" style="stroke-width:.35277775" transform="translate(-104.228 -45.508)"/><path d="M152.23 112.25v-2.43l2.05-.424c2.263-.467 4.054-1.863 4.459-3.475.127-.507-.113-3.164-.534-5.903-1.372-8.93-.611-13.537 2.855-17.297l1.482-1.608-1.11-1.266c-3.98-4.53-4.67-8.552-3.154-18.37.763-4.945.764-4.993.087-6.173-.797-1.388-3.284-2.776-4.975-2.776h-1.16v-2.47c0-2.81-.058-2.773 3.246-2.072 3.965.841 6.805 2.853 8.278 5.865.846 1.728.973 2.4.95 5.01-.016 1.66-.358 4.683-.762 6.72-1.499 7.564-1.365 9.576.765 11.533.99.908 1.64 1.173 3.37 1.368l2.145.243v4.848h-1.676c-2.151.001-3.932.91-4.838 2.47-.952 1.637-.893 5.206.173 10.406.907 4.422 1.053 8.459.389 10.729-.701 2.394-3.82 5.296-6.748 6.277-1.261.423-2.968.871-3.792.996l-1.5.228z" style="stroke-width:.35277778" transform="translate(-104.228 -45.508)"/><path d="M131.742 108.266c-1.021-1.299-.873-3.537.381-5.732.928-1.624 4.809-6.948 7.61-10.44l1.132-1.41-1.802-5.226c-2.022-5.86-2.01-5.974.656-6.372l1.468-.219 1.64 3.35c.903 1.843 1.77 3.351 1.928 3.351.158 0 1.775-1.755 3.594-3.9 3.16-3.727 3.357-3.892 4.426-3.694.645.12 1.218.047 1.354-.173.318-.515 1.23.247 1.23 1.027 0 .32-.453 1.134-1.009 1.81-2.267 2.755-7.104 9.27-7.104 9.57 0 .177.975 2.454 2.167 5.059l2.166 4.736-.658.985c-.362.541-.662 1.126-.667 1.299-.005.173-.278.483-.606.69-.832.525-1.447-.115-3.99-4.153-1.164-1.848-2.231-3.365-2.372-3.37-.313-.01-3.79 5.133-6.48 9.581-2.37 3.924-1.938 3.42-3.265 3.801-.956.274-1.194.199-1.799-.57zM131.986 83.677c-2.152-3.847-6.019-9.428-7.579-10.938-.792-.767-1.44-1.575-1.44-1.796 0-.601 1.616-1.22 3.19-1.22 1.698 0 3.496 1.479 5.1 4.193.582.985 1.156 1.794 1.276 1.798.12.004.809-1.651 1.53-3.678 1.547-4.34 5.624-12.778 7.225-14.951 1.373-1.863 3.43-2.865 5.903-2.876 3.234-.013 3.243.13.205 3.297-4.636 4.832-6.764 8.81-11.252 21.037-1.246 3.396-2.39 6.48-2.542 6.852-.23.566-.498.281-1.616-1.718z" style="stroke-width:.35277775" transform="translate(-104.228 -45.508)"/></g></svg>
35
-
title: JSON Schemas
36
-
details: Export OpenAPI schemas as JavaScript objects. JSON Schema 2020-12 supported.
37
-
link: /openapi-ts/output#json-schemas
38
-
linkText: Learn more
39
34
- icon: <svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 190 190"><g fill="none" fill-rule="evenodd"><path d="M150.276 61.344c3.093-14.981 3.756-26.471 1.757-34.815-1.189-4.962-3.362-9.01-6.668-11.93-3.49-3.084-7.901-4.597-12.858-4.597-8.178 0-16.775 3.725-25.963 10.802-3.747 2.887-7.636 6.366-11.676 10.44a8.743 8.743 0 0 0-1.09-1.163C82.36 19.915 72.746 13.599 64.523 11.164c-4.89-1.448-9.48-1.586-13.66-.181-4.414 1.483-7.93 4.55-10.41 8.845-4.094 7.089-5.174 16.403-3.648 27.904.623 4.688 1.686 9.794 3.189 15.327a8.725 8.725 0 0 0-1.698.38c-14.489 4.797-24.749 9.955-30.96 15.85-3.696 3.506-6.109 7.41-6.981 11.733-.921 4.562-.023 9.137 2.454 13.43 4.087 7.078 11.6 12.66 22.304 17.082 4.298 1.776 9.161 3.384 14.595 4.83a8.735 8.735 0 0 0-.57 1.776c-3.092 14.98-3.756 26.47-1.756 34.814 1.188 4.962 3.362 9.01 6.667 11.93 3.49 3.084 7.902 4.597 12.86 4.597 8.177 0 16.774-3.725 25.962-10.802 3.787-2.917 7.72-6.44 11.805-10.57.42.656.936 1.267 1.546 1.81 11.42 10.166 21.034 16.482 29.257 18.917 4.89 1.448 9.48 1.586 13.66.181 4.414-1.483 7.93-4.55 10.41-8.845 4.094-7.089 5.174-16.403 3.648-27.904-.645-4.857-1.764-10.164-3.354-15.929a8.715 8.715 0 0 0 1.863-.398c14.489-4.797 24.749-9.955 30.96-15.85 3.696-3.506 6.109-7.41 6.981-11.733.921-4.562.023-9.137-2.454-13.43-4.087-7.078-11.6-12.66-22.304-17.082-4.427-1.828-9.452-3.48-15.082-4.959.2-.49.36-1.006.47-1.543Z" fill="#002C4B" fill-rule="nonzero"/><path d="M80.397 64h29.211a5 5 0 0 1 4.337 2.512l14.632 25.5a5 5 0 0 1 0 4.976l-14.632 25.5a5 5 0 0 1-4.337 2.512H80.397a5 5 0 0 1-4.337-2.512l-14.632-25.5a5 5 0 0 1 0-4.976l14.632-25.5A5 5 0 0 1 80.397 64Zm25.59 6.277a5 5 0 0 1 4.339 2.513l11.017 19.224a5 5 0 0 1 0 4.972l-11.017 19.224a5 5 0 0 1-4.338 2.513h-21.97a5 5 0 0 1-4.339-2.513L68.662 96.986a5 5 0 0 1 0-4.972L79.679 72.79a5 5 0 0 1 4.338-2.513h21.97Zm-3.906 6.864H87.924a5 5 0 0 0-4.335 2.51l-7.1 12.358a5 5 0 0 0 0 4.982l7.1 12.358a5 5 0 0 0 4.335 2.51h14.157a5 5 0 0 0 4.335-2.51l7.1-12.358a5 5 0 0 0 0-4.982l-7.1-12.358a5 5 0 0 0-4.335-2.51Zm-3.762 6.571a5 5 0 0 1 4.334 2.506l3.33 5.788a5 5 0 0 1 0 4.988l-3.33 5.788a5 5 0 0 1-4.334 2.506h-6.633a5 5 0 0 1-4.334-2.506l-3.33-5.788a5 5 0 0 1 0-4.988l3.33-5.788a5 5 0 0 1 4.334-2.506h6.633Zm-3.315 6.473a4.313 4.313 0 1 0-.003 8.63 4.313 4.313 0 1 0 .003-8.63ZM60 94.5h7.768" fill="#FFD94C"/><path d="M54.86 108.358a2.713 2.713 0 0 1 3.718 1.041l.475.845a269.421 269.421 0 0 0 11.888 19.191c4.867 7.15 10.34 14.39 16.421 21.716a2.776 2.776 0 0 1-.296 3.847l-.612.537c-20.107 17.568-33.176 21.078-39.206 10.527-5.898-10.32-3.764-29.08 6.403-56.28a2.748 2.748 0 0 1 1.21-1.424Zm85.674 20.684a2.708 2.708 0 0 1 3.126 2.152l.153.792c4.97 26.01 1.47 39.014-10.497 39.014-11.706 0-26.607-11.091-44.703-33.273a2.725 2.725 0 0 1-.613-1.745 2.712 2.712 0 0 1 2.73-2.694l.955.007c7.62.041 15.03-.223 22.226-.794 8.498-.673 17.373-1.826 26.623-3.46Zm6.875-55.23c.523-1.41 2.1-2.149 3.546-1.663l.788.266c25.84 8.803 35.66 18.477 29.455 29.022-6.068 10.314-23.714 17.823-52.936 22.527a2.852 2.852 0 0 1-1.88-.345 2.726 2.726 0 0 1-.993-3.772l.5-.837c3.988-6.694 7.592-13.356 10.813-19.986 3.803-7.83 7.372-16.233 10.707-25.212Zm-85.67-7.776a2.852 2.852 0 0 1 1.878.345 2.726 2.726 0 0 1 .994 3.772l-.5.837c-3.988 6.694-7.592 13.356-10.813 19.986-3.803 7.83-7.372 16.233-10.707 25.212-.523 1.41-2.1 2.149-3.546 1.663l-.788-.266c-25.84-8.803-35.66-18.477-29.455-29.022C14.87 78.25 32.516 70.74 61.738 66.036Zm41.807-31.57c20.107-17.57 33.176-21.079 39.206-10.528 5.898 10.32 3.764 29.08-6.403 56.28a2.748 2.748 0 0 1-1.21 1.424 2.713 2.713 0 0 1-3.717-1.041l-.475-.845a269.421 269.421 0 0 0-11.888-19.191c-4.867-7.15-10.34-14.39-16.421-21.716a2.776 2.776 0 0 1 .296-3.847ZM57.684 18c11.706 0 26.607 11.091 44.703 33.273.402.492.618 1.11.613 1.745a2.712 2.712 0 0 1-2.73 2.694l-.955-.007c-7.62-.041-15.03.223-22.226.794-8.498.673-17.373 1.826-26.623 3.46a2.708 2.708 0 0 1-3.126-2.153l-.153-.792C42.217 31.004 45.717 18 57.684 18Z" fill="#FF4154"/></g></svg>
40
35
title: Plugins
41
36
details: Reduce third-party boilerplate with our plugin ecosystem.
···
48
43
linkText: Find out more
49
44
---
50
45
51
-
### Migrating from OpenAPI Typescript Codegen?
46
+
<div class="home-list home-sponsors">
47
+
48
+
### Sponsors
49
+
50
+
<ul>
51
+
<li class="home-sponsors-new">
52
+
<a href="mailto:lmenus@lmen.us?subject=Hey%20API%20sponsorship%20enquiry">
53
+
+ your logo
54
+
</a>
55
+
</li>
56
+
</ul>
57
+
58
+
</div>
52
59
53
-
Read our [migration guide](/openapi-ts/migrating#openapi-typescript-codegen).
60
+
<div class="home-list">
61
+
62
+
### Migration guides
63
+
64
+
- [OpenAPI TypeScript Codegen](/openapi-ts/migrating#openapi-typescript-codegen)
65
+
66
+
</div>
54
67
55
68
<style>
56
69
.icon-github path {
+1
-1
docs/openapi-ts/configuration.md
+1
-1
docs/openapi-ts/configuration.md
···
55
55
Filters work only with the [experimental parser](#parser) which is currently an opt-in feature.
56
56
:::
57
57
58
-
If you work with large specifications and want to generate output from their subset, set `input.include` to a valid regular expression string.
58
+
If you work with large specifications and want to generate output from their subset, set `input.include` to a regular expression string matching against resource references.
59
59
60
60
```js
61
61
export default {
-20
docs/openapi-ts/output.md
-20
docs/openapi-ts/output.md
···
207
207
208
208
:::
209
209
210
-
### Filtering Endpoints
211
-
212
-
If you only want to include specific endpoints in the generated services, you can use the `filter` config option to filter endpoints. The provided value should be a regular expression to match against endpoints with the `{method} {path}` pattern. For example, the config below will only include all `/api/v1/foo` endpoints.
213
-
214
-
```js
215
-
export default {
216
-
client: '@hey-api/client-fetch',
217
-
input: 'path/to/openapi.json',
218
-
output: 'src/client',
219
-
plugins: [
220
-
'@hey-api/schemas', // preserves default output
221
-
'@hey-api/types', // preserves default output
222
-
{
223
-
filter: '^\\w+ /api/v1/foo$', // [!code ++]
224
-
name: '@hey-api/services',
225
-
},
226
-
],
227
-
};
228
-
```
229
-
230
210
### Output
231
211
232
212
Below are different outputs depending on your chosen style. No services approach will not generate the `services.gen.ts` file.
+1
-1
docs/sponsorship.md
+1
-1
docs/sponsorship.md
+1
-1
package.json
+1
-1
package.json
+1
-1
packages/client-axios/README.md
+1
-1
packages/client-axios/README.md
+1
-1
packages/client-axios/package.json
+1
-1
packages/client-axios/package.json
+1
-1
packages/client-fetch/README.md
+1
-1
packages/client-fetch/README.md
+1
-1
packages/client-fetch/package.json
+1
-1
packages/client-fetch/package.json
+1
-1
packages/openapi-ts/README.md
+1
-1
packages/openapi-ts/README.md