openapi-typesafe-helpers 0.0.0 → 1.0.0-rc.0
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/LICENSE +22 -0
- package/README.md +9 -1
- package/dist/index.cjs +3 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +176 -0
- package/dist/index.d.mts +176 -0
- package/dist/index.d.ts +176 -0
- package/dist/index.mjs +2 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +51 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Drew Powers
|
|
4
|
+
Copyright (c) 2026 Fedor Chishchin and openapi-typesafe contributors
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
in the Software without restriction, including without limitation the rights
|
|
9
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
1
|
# openapi-typesafe-helpers
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Type helpers shared by `openapi-typesafe-fetch` and `openapi-typesafe-react-query` (for example `PathsWithMethod`,
|
|
4
|
+
`SuccessResponse`, `ErrorResponse`, `MediaType`). Types only; no runtime code.
|
|
5
|
+
|
|
6
|
+
A maintained successor to `openapi-typescript-helpers` (see the [repository README](../../README.md)).
|
|
7
|
+
Most projects do not need to install it directly.
|
|
8
|
+
|
|
9
|
+
## License
|
|
10
|
+
|
|
11
|
+
[MIT](./LICENSE)
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
type HttpMethod = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace" | "query";
|
|
2
|
+
type OkStatus = 200 | 201 | 202 | 203 | 204 | 206 | 207 | "2XX";
|
|
3
|
+
type ErrorStatus = 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511 | "5XX" | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 427 | 428 | 429 | 430 | 431 | 444 | 450 | 451 | 497 | 498 | 499 | "4XX" | "default";
|
|
4
|
+
type OKStatusUnion<T> = FilterKeys<T, OkStatus>;
|
|
5
|
+
type FirstErrorStatus<T> = T extends {
|
|
6
|
+
500: any;
|
|
7
|
+
} ? T[500] : T extends {
|
|
8
|
+
501: any;
|
|
9
|
+
} ? T[501] : T extends {
|
|
10
|
+
502: any;
|
|
11
|
+
} ? T[502] : T extends {
|
|
12
|
+
503: any;
|
|
13
|
+
} ? T[503] : T extends {
|
|
14
|
+
504: any;
|
|
15
|
+
} ? T[504] : T extends {
|
|
16
|
+
505: any;
|
|
17
|
+
} ? T[505] : T extends {
|
|
18
|
+
506: any;
|
|
19
|
+
} ? T[506] : T extends {
|
|
20
|
+
507: any;
|
|
21
|
+
} ? T[507] : T extends {
|
|
22
|
+
508: any;
|
|
23
|
+
} ? T[508] : T extends {
|
|
24
|
+
510: any;
|
|
25
|
+
} ? T[510] : T extends {
|
|
26
|
+
511: any;
|
|
27
|
+
} ? T[511] : T extends {
|
|
28
|
+
"5XX": any;
|
|
29
|
+
} ? T["5XX"] : T extends {
|
|
30
|
+
400: any;
|
|
31
|
+
} ? T[400] : T extends {
|
|
32
|
+
401: any;
|
|
33
|
+
} ? T[401] : T extends {
|
|
34
|
+
402: any;
|
|
35
|
+
} ? T[402] : T extends {
|
|
36
|
+
403: any;
|
|
37
|
+
} ? T[403] : T extends {
|
|
38
|
+
404: any;
|
|
39
|
+
} ? T[404] : T extends {
|
|
40
|
+
405: any;
|
|
41
|
+
} ? T[405] : T extends {
|
|
42
|
+
406: any;
|
|
43
|
+
} ? T[406] : T extends {
|
|
44
|
+
407: any;
|
|
45
|
+
} ? T[407] : T extends {
|
|
46
|
+
408: any;
|
|
47
|
+
} ? T[408] : T extends {
|
|
48
|
+
409: any;
|
|
49
|
+
} ? T[409] : T extends {
|
|
50
|
+
410: any;
|
|
51
|
+
} ? T[410] : T extends {
|
|
52
|
+
411: any;
|
|
53
|
+
} ? T[411] : T extends {
|
|
54
|
+
412: any;
|
|
55
|
+
} ? T[412] : T extends {
|
|
56
|
+
413: any;
|
|
57
|
+
} ? T[413] : T extends {
|
|
58
|
+
414: any;
|
|
59
|
+
} ? T[414] : T extends {
|
|
60
|
+
415: any;
|
|
61
|
+
} ? T[415] : T extends {
|
|
62
|
+
416: any;
|
|
63
|
+
} ? T[416] : T extends {
|
|
64
|
+
417: any;
|
|
65
|
+
} ? T[417] : T extends {
|
|
66
|
+
418: any;
|
|
67
|
+
} ? T[418] : T extends {
|
|
68
|
+
420: any;
|
|
69
|
+
} ? T[420] : T extends {
|
|
70
|
+
421: any;
|
|
71
|
+
} ? T[421] : T extends {
|
|
72
|
+
422: any;
|
|
73
|
+
} ? T[422] : T extends {
|
|
74
|
+
423: any;
|
|
75
|
+
} ? T[423] : T extends {
|
|
76
|
+
424: any;
|
|
77
|
+
} ? T[424] : T extends {
|
|
78
|
+
425: any;
|
|
79
|
+
} ? T[425] : T extends {
|
|
80
|
+
426: any;
|
|
81
|
+
} ? T[426] : T extends {
|
|
82
|
+
427: any;
|
|
83
|
+
} ? T[427] : T extends {
|
|
84
|
+
428: any;
|
|
85
|
+
} ? T[428] : T extends {
|
|
86
|
+
429: any;
|
|
87
|
+
} ? T[429] : T extends {
|
|
88
|
+
430: any;
|
|
89
|
+
} ? T[430] : T extends {
|
|
90
|
+
431: any;
|
|
91
|
+
} ? T[431] : T extends {
|
|
92
|
+
444: any;
|
|
93
|
+
} ? T[444] : T extends {
|
|
94
|
+
450: any;
|
|
95
|
+
} ? T[450] : T extends {
|
|
96
|
+
451: any;
|
|
97
|
+
} ? T[451] : T extends {
|
|
98
|
+
497: any;
|
|
99
|
+
} ? T[497] : T extends {
|
|
100
|
+
498: any;
|
|
101
|
+
} ? T[498] : T extends {
|
|
102
|
+
499: any;
|
|
103
|
+
} ? T[499] : T extends {
|
|
104
|
+
"4XX": any;
|
|
105
|
+
} ? T["4XX"] : T extends {
|
|
106
|
+
default: any;
|
|
107
|
+
} ? T["default"] : never;
|
|
108
|
+
type PathsWithMethod<Paths extends {}, PathnameMethod extends HttpMethod> = {
|
|
109
|
+
[Pathname in keyof Paths]: Paths[Pathname] extends {
|
|
110
|
+
[K in PathnameMethod]: any;
|
|
111
|
+
} ? Pathname : never;
|
|
112
|
+
}[keyof Paths];
|
|
113
|
+
interface OperationObject {
|
|
114
|
+
parameters: any;
|
|
115
|
+
requestBody: any;
|
|
116
|
+
responses: any;
|
|
117
|
+
}
|
|
118
|
+
type PathItemObject = {
|
|
119
|
+
[M in HttpMethod]: OperationObject;
|
|
120
|
+
} & {
|
|
121
|
+
parameters?: any;
|
|
122
|
+
};
|
|
123
|
+
type ResponseObjectMap<T> = T extends {
|
|
124
|
+
responses: any;
|
|
125
|
+
} ? T["responses"] : unknown;
|
|
126
|
+
type ResponseContent<T> = T extends {
|
|
127
|
+
content: any;
|
|
128
|
+
} ? T["content"] : unknown;
|
|
129
|
+
type OperationRequestBody<T> = "requestBody" extends keyof T ? T["requestBody"] : never;
|
|
130
|
+
type PickRequestBody<T> = "requestBody" extends keyof T ? Pick<T, "requestBody"> : never;
|
|
131
|
+
type IsOperationRequestBodyOptional<T> = RequiredKeysOf<PickRequestBody<T>> extends never ? true : false;
|
|
132
|
+
type OperationRequestBodyMediaContent<T> = IsOperationRequestBodyOptional<T> extends true ? ResponseContent<NonNullable<OperationRequestBody<T>>> | undefined : ResponseContent<OperationRequestBody<T>>;
|
|
133
|
+
type OperationRequestBodyContent<T> = FilterKeys<OperationRequestBodyMediaContent<T>, MediaType> extends never ? FilterKeys<NonNullable<OperationRequestBodyMediaContent<T>>, MediaType> | undefined : FilterKeys<OperationRequestBodyMediaContent<T>, MediaType>;
|
|
134
|
+
type SuccessResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = GetResponseContent<T, Media, OkStatus>;
|
|
135
|
+
type GetResponseContent<T extends Record<string | number, any>, Media extends MediaType = MediaType, ResponseCode extends keyof T = keyof T> = ResponseCode extends keyof T ? {
|
|
136
|
+
[K in ResponseCode]: T[K]["content"] extends Record<string, any> ? FilterKeys<T[K]["content"], Media> extends never ? T[K]["content"] : FilterKeys<T[K]["content"], Media> : K extends keyof T ? T[K]["content"] : never;
|
|
137
|
+
}[ResponseCode] : never;
|
|
138
|
+
type ErrorResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = GetResponseContent<T, Media, ErrorStatus>;
|
|
139
|
+
type SuccessResponseJSON<PathMethod extends Record<string | number, any>> = SuccessResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
|
|
140
|
+
type ErrorResponseJSON<PathMethod extends Record<string | number, any>> = ErrorResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
|
|
141
|
+
type RequestBodyJSON<PathMethod> = JSONLike<FilterKeys<OperationRequestBody<PathMethod>, "content">>;
|
|
142
|
+
type FilterKeys<Obj, Matchers> = Obj[keyof Obj & Matchers];
|
|
143
|
+
type GetValueWithDefault<Obj, KeyPattern, Default> = Obj extends any ? FilterKeys<Obj, KeyPattern> extends never ? Default : FilterKeys<Obj, KeyPattern> : never;
|
|
144
|
+
type MediaType = `${string}/${string}`;
|
|
145
|
+
type JSONLike<T> = FilterKeys<T, `${string}/json`>;
|
|
146
|
+
type FindRequiredKeys<T, K extends keyof T> = K extends unknown ? undefined extends T[K] ? never : K : K;
|
|
147
|
+
type HasRequiredKeys<T> = FindRequiredKeys<T, keyof T>;
|
|
148
|
+
type RequiredKeysOfHelper<T> = {
|
|
149
|
+
[K in keyof T]: {} extends Pick<T, K> ? never : K;
|
|
150
|
+
}[keyof T];
|
|
151
|
+
type RequiredKeysOf<T> = RequiredKeysOfHelper<T> extends undefined ? never : RequiredKeysOfHelper<T>;
|
|
152
|
+
type $Read<T> = {
|
|
153
|
+
readonly $read: T;
|
|
154
|
+
};
|
|
155
|
+
type $Write<T> = {
|
|
156
|
+
readonly $write: T;
|
|
157
|
+
};
|
|
158
|
+
type ReadWritePrimitive = string | number | boolean | bigint | symbol | null | undefined;
|
|
159
|
+
type ReadWriteLeaf = ReadWritePrimitive | ((...args: never) => unknown);
|
|
160
|
+
type ReadWriteMarkedKeys<T, Marker> = {
|
|
161
|
+
[K in keyof T]-?: NonNullable<T[K]> extends never ? never : NonNullable<T[K]> extends Marker ? K : never;
|
|
162
|
+
}[keyof T];
|
|
163
|
+
type ReadWriteResolveArray<T extends readonly unknown[], Resolved extends "read" | "write"> = T[number][] extends T ? T extends unknown[] ? ReadWriteResolve<T[number], Resolved>[] : readonly ReadWriteResolve<T[number], Resolved>[] : {
|
|
164
|
+
[K in keyof T]: ReadWriteResolve<T[K], Resolved>;
|
|
165
|
+
};
|
|
166
|
+
type ReadWriteResolve<T, Resolved extends "read" | "write"> = Resolved extends "read" ? Readable<T> : Writable<T>;
|
|
167
|
+
type Readable<T> = T extends $Write<any> ? never : T extends $Read<infer U> ? Readable<U> : T extends ReadWriteLeaf ? T : T extends readonly unknown[] ? ReadWriteResolveArray<T, "read"> : T extends object ? {
|
|
168
|
+
[K in keyof T as K extends ReadWriteMarkedKeys<T, $Write<any>> ? never : K]: Readable<T[K]>;
|
|
169
|
+
} : T;
|
|
170
|
+
type Writable<T> = T extends $Read<any> ? never : T extends $Write<infer U> ? Writable<U> : T extends ReadWriteLeaf ? T : T extends readonly unknown[] ? ReadWriteResolveArray<T, "write"> : T extends object ? {
|
|
171
|
+
[K in keyof T as K extends ReadWriteMarkedKeys<T, $Read<any>> ? never : K]: Writable<T[K]>;
|
|
172
|
+
} & {
|
|
173
|
+
[K in ReadWriteMarkedKeys<T, $Read<any>>]?: never;
|
|
174
|
+
} : T;
|
|
175
|
+
|
|
176
|
+
export type { $Read, $Write, ErrorResponse, ErrorResponseJSON, ErrorStatus, FilterKeys, FindRequiredKeys, FirstErrorStatus, GetResponseContent, GetValueWithDefault, HasRequiredKeys, HttpMethod, IsOperationRequestBodyOptional, JSONLike, MediaType, OKStatusUnion, OkStatus, OperationObject, OperationRequestBody, OperationRequestBodyContent, OperationRequestBodyMediaContent, PathItemObject, PathsWithMethod, Readable, RequestBodyJSON, RequiredKeysOf, ResponseContent, ResponseObjectMap, SuccessResponse, SuccessResponseJSON, Writable };
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
type HttpMethod = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace" | "query";
|
|
2
|
+
type OkStatus = 200 | 201 | 202 | 203 | 204 | 206 | 207 | "2XX";
|
|
3
|
+
type ErrorStatus = 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511 | "5XX" | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 427 | 428 | 429 | 430 | 431 | 444 | 450 | 451 | 497 | 498 | 499 | "4XX" | "default";
|
|
4
|
+
type OKStatusUnion<T> = FilterKeys<T, OkStatus>;
|
|
5
|
+
type FirstErrorStatus<T> = T extends {
|
|
6
|
+
500: any;
|
|
7
|
+
} ? T[500] : T extends {
|
|
8
|
+
501: any;
|
|
9
|
+
} ? T[501] : T extends {
|
|
10
|
+
502: any;
|
|
11
|
+
} ? T[502] : T extends {
|
|
12
|
+
503: any;
|
|
13
|
+
} ? T[503] : T extends {
|
|
14
|
+
504: any;
|
|
15
|
+
} ? T[504] : T extends {
|
|
16
|
+
505: any;
|
|
17
|
+
} ? T[505] : T extends {
|
|
18
|
+
506: any;
|
|
19
|
+
} ? T[506] : T extends {
|
|
20
|
+
507: any;
|
|
21
|
+
} ? T[507] : T extends {
|
|
22
|
+
508: any;
|
|
23
|
+
} ? T[508] : T extends {
|
|
24
|
+
510: any;
|
|
25
|
+
} ? T[510] : T extends {
|
|
26
|
+
511: any;
|
|
27
|
+
} ? T[511] : T extends {
|
|
28
|
+
"5XX": any;
|
|
29
|
+
} ? T["5XX"] : T extends {
|
|
30
|
+
400: any;
|
|
31
|
+
} ? T[400] : T extends {
|
|
32
|
+
401: any;
|
|
33
|
+
} ? T[401] : T extends {
|
|
34
|
+
402: any;
|
|
35
|
+
} ? T[402] : T extends {
|
|
36
|
+
403: any;
|
|
37
|
+
} ? T[403] : T extends {
|
|
38
|
+
404: any;
|
|
39
|
+
} ? T[404] : T extends {
|
|
40
|
+
405: any;
|
|
41
|
+
} ? T[405] : T extends {
|
|
42
|
+
406: any;
|
|
43
|
+
} ? T[406] : T extends {
|
|
44
|
+
407: any;
|
|
45
|
+
} ? T[407] : T extends {
|
|
46
|
+
408: any;
|
|
47
|
+
} ? T[408] : T extends {
|
|
48
|
+
409: any;
|
|
49
|
+
} ? T[409] : T extends {
|
|
50
|
+
410: any;
|
|
51
|
+
} ? T[410] : T extends {
|
|
52
|
+
411: any;
|
|
53
|
+
} ? T[411] : T extends {
|
|
54
|
+
412: any;
|
|
55
|
+
} ? T[412] : T extends {
|
|
56
|
+
413: any;
|
|
57
|
+
} ? T[413] : T extends {
|
|
58
|
+
414: any;
|
|
59
|
+
} ? T[414] : T extends {
|
|
60
|
+
415: any;
|
|
61
|
+
} ? T[415] : T extends {
|
|
62
|
+
416: any;
|
|
63
|
+
} ? T[416] : T extends {
|
|
64
|
+
417: any;
|
|
65
|
+
} ? T[417] : T extends {
|
|
66
|
+
418: any;
|
|
67
|
+
} ? T[418] : T extends {
|
|
68
|
+
420: any;
|
|
69
|
+
} ? T[420] : T extends {
|
|
70
|
+
421: any;
|
|
71
|
+
} ? T[421] : T extends {
|
|
72
|
+
422: any;
|
|
73
|
+
} ? T[422] : T extends {
|
|
74
|
+
423: any;
|
|
75
|
+
} ? T[423] : T extends {
|
|
76
|
+
424: any;
|
|
77
|
+
} ? T[424] : T extends {
|
|
78
|
+
425: any;
|
|
79
|
+
} ? T[425] : T extends {
|
|
80
|
+
426: any;
|
|
81
|
+
} ? T[426] : T extends {
|
|
82
|
+
427: any;
|
|
83
|
+
} ? T[427] : T extends {
|
|
84
|
+
428: any;
|
|
85
|
+
} ? T[428] : T extends {
|
|
86
|
+
429: any;
|
|
87
|
+
} ? T[429] : T extends {
|
|
88
|
+
430: any;
|
|
89
|
+
} ? T[430] : T extends {
|
|
90
|
+
431: any;
|
|
91
|
+
} ? T[431] : T extends {
|
|
92
|
+
444: any;
|
|
93
|
+
} ? T[444] : T extends {
|
|
94
|
+
450: any;
|
|
95
|
+
} ? T[450] : T extends {
|
|
96
|
+
451: any;
|
|
97
|
+
} ? T[451] : T extends {
|
|
98
|
+
497: any;
|
|
99
|
+
} ? T[497] : T extends {
|
|
100
|
+
498: any;
|
|
101
|
+
} ? T[498] : T extends {
|
|
102
|
+
499: any;
|
|
103
|
+
} ? T[499] : T extends {
|
|
104
|
+
"4XX": any;
|
|
105
|
+
} ? T["4XX"] : T extends {
|
|
106
|
+
default: any;
|
|
107
|
+
} ? T["default"] : never;
|
|
108
|
+
type PathsWithMethod<Paths extends {}, PathnameMethod extends HttpMethod> = {
|
|
109
|
+
[Pathname in keyof Paths]: Paths[Pathname] extends {
|
|
110
|
+
[K in PathnameMethod]: any;
|
|
111
|
+
} ? Pathname : never;
|
|
112
|
+
}[keyof Paths];
|
|
113
|
+
interface OperationObject {
|
|
114
|
+
parameters: any;
|
|
115
|
+
requestBody: any;
|
|
116
|
+
responses: any;
|
|
117
|
+
}
|
|
118
|
+
type PathItemObject = {
|
|
119
|
+
[M in HttpMethod]: OperationObject;
|
|
120
|
+
} & {
|
|
121
|
+
parameters?: any;
|
|
122
|
+
};
|
|
123
|
+
type ResponseObjectMap<T> = T extends {
|
|
124
|
+
responses: any;
|
|
125
|
+
} ? T["responses"] : unknown;
|
|
126
|
+
type ResponseContent<T> = T extends {
|
|
127
|
+
content: any;
|
|
128
|
+
} ? T["content"] : unknown;
|
|
129
|
+
type OperationRequestBody<T> = "requestBody" extends keyof T ? T["requestBody"] : never;
|
|
130
|
+
type PickRequestBody<T> = "requestBody" extends keyof T ? Pick<T, "requestBody"> : never;
|
|
131
|
+
type IsOperationRequestBodyOptional<T> = RequiredKeysOf<PickRequestBody<T>> extends never ? true : false;
|
|
132
|
+
type OperationRequestBodyMediaContent<T> = IsOperationRequestBodyOptional<T> extends true ? ResponseContent<NonNullable<OperationRequestBody<T>>> | undefined : ResponseContent<OperationRequestBody<T>>;
|
|
133
|
+
type OperationRequestBodyContent<T> = FilterKeys<OperationRequestBodyMediaContent<T>, MediaType> extends never ? FilterKeys<NonNullable<OperationRequestBodyMediaContent<T>>, MediaType> | undefined : FilterKeys<OperationRequestBodyMediaContent<T>, MediaType>;
|
|
134
|
+
type SuccessResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = GetResponseContent<T, Media, OkStatus>;
|
|
135
|
+
type GetResponseContent<T extends Record<string | number, any>, Media extends MediaType = MediaType, ResponseCode extends keyof T = keyof T> = ResponseCode extends keyof T ? {
|
|
136
|
+
[K in ResponseCode]: T[K]["content"] extends Record<string, any> ? FilterKeys<T[K]["content"], Media> extends never ? T[K]["content"] : FilterKeys<T[K]["content"], Media> : K extends keyof T ? T[K]["content"] : never;
|
|
137
|
+
}[ResponseCode] : never;
|
|
138
|
+
type ErrorResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = GetResponseContent<T, Media, ErrorStatus>;
|
|
139
|
+
type SuccessResponseJSON<PathMethod extends Record<string | number, any>> = SuccessResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
|
|
140
|
+
type ErrorResponseJSON<PathMethod extends Record<string | number, any>> = ErrorResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
|
|
141
|
+
type RequestBodyJSON<PathMethod> = JSONLike<FilterKeys<OperationRequestBody<PathMethod>, "content">>;
|
|
142
|
+
type FilterKeys<Obj, Matchers> = Obj[keyof Obj & Matchers];
|
|
143
|
+
type GetValueWithDefault<Obj, KeyPattern, Default> = Obj extends any ? FilterKeys<Obj, KeyPattern> extends never ? Default : FilterKeys<Obj, KeyPattern> : never;
|
|
144
|
+
type MediaType = `${string}/${string}`;
|
|
145
|
+
type JSONLike<T> = FilterKeys<T, `${string}/json`>;
|
|
146
|
+
type FindRequiredKeys<T, K extends keyof T> = K extends unknown ? undefined extends T[K] ? never : K : K;
|
|
147
|
+
type HasRequiredKeys<T> = FindRequiredKeys<T, keyof T>;
|
|
148
|
+
type RequiredKeysOfHelper<T> = {
|
|
149
|
+
[K in keyof T]: {} extends Pick<T, K> ? never : K;
|
|
150
|
+
}[keyof T];
|
|
151
|
+
type RequiredKeysOf<T> = RequiredKeysOfHelper<T> extends undefined ? never : RequiredKeysOfHelper<T>;
|
|
152
|
+
type $Read<T> = {
|
|
153
|
+
readonly $read: T;
|
|
154
|
+
};
|
|
155
|
+
type $Write<T> = {
|
|
156
|
+
readonly $write: T;
|
|
157
|
+
};
|
|
158
|
+
type ReadWritePrimitive = string | number | boolean | bigint | symbol | null | undefined;
|
|
159
|
+
type ReadWriteLeaf = ReadWritePrimitive | ((...args: never) => unknown);
|
|
160
|
+
type ReadWriteMarkedKeys<T, Marker> = {
|
|
161
|
+
[K in keyof T]-?: NonNullable<T[K]> extends never ? never : NonNullable<T[K]> extends Marker ? K : never;
|
|
162
|
+
}[keyof T];
|
|
163
|
+
type ReadWriteResolveArray<T extends readonly unknown[], Resolved extends "read" | "write"> = T[number][] extends T ? T extends unknown[] ? ReadWriteResolve<T[number], Resolved>[] : readonly ReadWriteResolve<T[number], Resolved>[] : {
|
|
164
|
+
[K in keyof T]: ReadWriteResolve<T[K], Resolved>;
|
|
165
|
+
};
|
|
166
|
+
type ReadWriteResolve<T, Resolved extends "read" | "write"> = Resolved extends "read" ? Readable<T> : Writable<T>;
|
|
167
|
+
type Readable<T> = T extends $Write<any> ? never : T extends $Read<infer U> ? Readable<U> : T extends ReadWriteLeaf ? T : T extends readonly unknown[] ? ReadWriteResolveArray<T, "read"> : T extends object ? {
|
|
168
|
+
[K in keyof T as K extends ReadWriteMarkedKeys<T, $Write<any>> ? never : K]: Readable<T[K]>;
|
|
169
|
+
} : T;
|
|
170
|
+
type Writable<T> = T extends $Read<any> ? never : T extends $Write<infer U> ? Writable<U> : T extends ReadWriteLeaf ? T : T extends readonly unknown[] ? ReadWriteResolveArray<T, "write"> : T extends object ? {
|
|
171
|
+
[K in keyof T as K extends ReadWriteMarkedKeys<T, $Read<any>> ? never : K]: Writable<T[K]>;
|
|
172
|
+
} & {
|
|
173
|
+
[K in ReadWriteMarkedKeys<T, $Read<any>>]?: never;
|
|
174
|
+
} : T;
|
|
175
|
+
|
|
176
|
+
export type { $Read, $Write, ErrorResponse, ErrorResponseJSON, ErrorStatus, FilterKeys, FindRequiredKeys, FirstErrorStatus, GetResponseContent, GetValueWithDefault, HasRequiredKeys, HttpMethod, IsOperationRequestBodyOptional, JSONLike, MediaType, OKStatusUnion, OkStatus, OperationObject, OperationRequestBody, OperationRequestBodyContent, OperationRequestBodyMediaContent, PathItemObject, PathsWithMethod, Readable, RequestBodyJSON, RequiredKeysOf, ResponseContent, ResponseObjectMap, SuccessResponse, SuccessResponseJSON, Writable };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
type HttpMethod = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace" | "query";
|
|
2
|
+
type OkStatus = 200 | 201 | 202 | 203 | 204 | 206 | 207 | "2XX";
|
|
3
|
+
type ErrorStatus = 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511 | "5XX" | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 427 | 428 | 429 | 430 | 431 | 444 | 450 | 451 | 497 | 498 | 499 | "4XX" | "default";
|
|
4
|
+
type OKStatusUnion<T> = FilterKeys<T, OkStatus>;
|
|
5
|
+
type FirstErrorStatus<T> = T extends {
|
|
6
|
+
500: any;
|
|
7
|
+
} ? T[500] : T extends {
|
|
8
|
+
501: any;
|
|
9
|
+
} ? T[501] : T extends {
|
|
10
|
+
502: any;
|
|
11
|
+
} ? T[502] : T extends {
|
|
12
|
+
503: any;
|
|
13
|
+
} ? T[503] : T extends {
|
|
14
|
+
504: any;
|
|
15
|
+
} ? T[504] : T extends {
|
|
16
|
+
505: any;
|
|
17
|
+
} ? T[505] : T extends {
|
|
18
|
+
506: any;
|
|
19
|
+
} ? T[506] : T extends {
|
|
20
|
+
507: any;
|
|
21
|
+
} ? T[507] : T extends {
|
|
22
|
+
508: any;
|
|
23
|
+
} ? T[508] : T extends {
|
|
24
|
+
510: any;
|
|
25
|
+
} ? T[510] : T extends {
|
|
26
|
+
511: any;
|
|
27
|
+
} ? T[511] : T extends {
|
|
28
|
+
"5XX": any;
|
|
29
|
+
} ? T["5XX"] : T extends {
|
|
30
|
+
400: any;
|
|
31
|
+
} ? T[400] : T extends {
|
|
32
|
+
401: any;
|
|
33
|
+
} ? T[401] : T extends {
|
|
34
|
+
402: any;
|
|
35
|
+
} ? T[402] : T extends {
|
|
36
|
+
403: any;
|
|
37
|
+
} ? T[403] : T extends {
|
|
38
|
+
404: any;
|
|
39
|
+
} ? T[404] : T extends {
|
|
40
|
+
405: any;
|
|
41
|
+
} ? T[405] : T extends {
|
|
42
|
+
406: any;
|
|
43
|
+
} ? T[406] : T extends {
|
|
44
|
+
407: any;
|
|
45
|
+
} ? T[407] : T extends {
|
|
46
|
+
408: any;
|
|
47
|
+
} ? T[408] : T extends {
|
|
48
|
+
409: any;
|
|
49
|
+
} ? T[409] : T extends {
|
|
50
|
+
410: any;
|
|
51
|
+
} ? T[410] : T extends {
|
|
52
|
+
411: any;
|
|
53
|
+
} ? T[411] : T extends {
|
|
54
|
+
412: any;
|
|
55
|
+
} ? T[412] : T extends {
|
|
56
|
+
413: any;
|
|
57
|
+
} ? T[413] : T extends {
|
|
58
|
+
414: any;
|
|
59
|
+
} ? T[414] : T extends {
|
|
60
|
+
415: any;
|
|
61
|
+
} ? T[415] : T extends {
|
|
62
|
+
416: any;
|
|
63
|
+
} ? T[416] : T extends {
|
|
64
|
+
417: any;
|
|
65
|
+
} ? T[417] : T extends {
|
|
66
|
+
418: any;
|
|
67
|
+
} ? T[418] : T extends {
|
|
68
|
+
420: any;
|
|
69
|
+
} ? T[420] : T extends {
|
|
70
|
+
421: any;
|
|
71
|
+
} ? T[421] : T extends {
|
|
72
|
+
422: any;
|
|
73
|
+
} ? T[422] : T extends {
|
|
74
|
+
423: any;
|
|
75
|
+
} ? T[423] : T extends {
|
|
76
|
+
424: any;
|
|
77
|
+
} ? T[424] : T extends {
|
|
78
|
+
425: any;
|
|
79
|
+
} ? T[425] : T extends {
|
|
80
|
+
426: any;
|
|
81
|
+
} ? T[426] : T extends {
|
|
82
|
+
427: any;
|
|
83
|
+
} ? T[427] : T extends {
|
|
84
|
+
428: any;
|
|
85
|
+
} ? T[428] : T extends {
|
|
86
|
+
429: any;
|
|
87
|
+
} ? T[429] : T extends {
|
|
88
|
+
430: any;
|
|
89
|
+
} ? T[430] : T extends {
|
|
90
|
+
431: any;
|
|
91
|
+
} ? T[431] : T extends {
|
|
92
|
+
444: any;
|
|
93
|
+
} ? T[444] : T extends {
|
|
94
|
+
450: any;
|
|
95
|
+
} ? T[450] : T extends {
|
|
96
|
+
451: any;
|
|
97
|
+
} ? T[451] : T extends {
|
|
98
|
+
497: any;
|
|
99
|
+
} ? T[497] : T extends {
|
|
100
|
+
498: any;
|
|
101
|
+
} ? T[498] : T extends {
|
|
102
|
+
499: any;
|
|
103
|
+
} ? T[499] : T extends {
|
|
104
|
+
"4XX": any;
|
|
105
|
+
} ? T["4XX"] : T extends {
|
|
106
|
+
default: any;
|
|
107
|
+
} ? T["default"] : never;
|
|
108
|
+
type PathsWithMethod<Paths extends {}, PathnameMethod extends HttpMethod> = {
|
|
109
|
+
[Pathname in keyof Paths]: Paths[Pathname] extends {
|
|
110
|
+
[K in PathnameMethod]: any;
|
|
111
|
+
} ? Pathname : never;
|
|
112
|
+
}[keyof Paths];
|
|
113
|
+
interface OperationObject {
|
|
114
|
+
parameters: any;
|
|
115
|
+
requestBody: any;
|
|
116
|
+
responses: any;
|
|
117
|
+
}
|
|
118
|
+
type PathItemObject = {
|
|
119
|
+
[M in HttpMethod]: OperationObject;
|
|
120
|
+
} & {
|
|
121
|
+
parameters?: any;
|
|
122
|
+
};
|
|
123
|
+
type ResponseObjectMap<T> = T extends {
|
|
124
|
+
responses: any;
|
|
125
|
+
} ? T["responses"] : unknown;
|
|
126
|
+
type ResponseContent<T> = T extends {
|
|
127
|
+
content: any;
|
|
128
|
+
} ? T["content"] : unknown;
|
|
129
|
+
type OperationRequestBody<T> = "requestBody" extends keyof T ? T["requestBody"] : never;
|
|
130
|
+
type PickRequestBody<T> = "requestBody" extends keyof T ? Pick<T, "requestBody"> : never;
|
|
131
|
+
type IsOperationRequestBodyOptional<T> = RequiredKeysOf<PickRequestBody<T>> extends never ? true : false;
|
|
132
|
+
type OperationRequestBodyMediaContent<T> = IsOperationRequestBodyOptional<T> extends true ? ResponseContent<NonNullable<OperationRequestBody<T>>> | undefined : ResponseContent<OperationRequestBody<T>>;
|
|
133
|
+
type OperationRequestBodyContent<T> = FilterKeys<OperationRequestBodyMediaContent<T>, MediaType> extends never ? FilterKeys<NonNullable<OperationRequestBodyMediaContent<T>>, MediaType> | undefined : FilterKeys<OperationRequestBodyMediaContent<T>, MediaType>;
|
|
134
|
+
type SuccessResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = GetResponseContent<T, Media, OkStatus>;
|
|
135
|
+
type GetResponseContent<T extends Record<string | number, any>, Media extends MediaType = MediaType, ResponseCode extends keyof T = keyof T> = ResponseCode extends keyof T ? {
|
|
136
|
+
[K in ResponseCode]: T[K]["content"] extends Record<string, any> ? FilterKeys<T[K]["content"], Media> extends never ? T[K]["content"] : FilterKeys<T[K]["content"], Media> : K extends keyof T ? T[K]["content"] : never;
|
|
137
|
+
}[ResponseCode] : never;
|
|
138
|
+
type ErrorResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = GetResponseContent<T, Media, ErrorStatus>;
|
|
139
|
+
type SuccessResponseJSON<PathMethod extends Record<string | number, any>> = SuccessResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
|
|
140
|
+
type ErrorResponseJSON<PathMethod extends Record<string | number, any>> = ErrorResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
|
|
141
|
+
type RequestBodyJSON<PathMethod> = JSONLike<FilterKeys<OperationRequestBody<PathMethod>, "content">>;
|
|
142
|
+
type FilterKeys<Obj, Matchers> = Obj[keyof Obj & Matchers];
|
|
143
|
+
type GetValueWithDefault<Obj, KeyPattern, Default> = Obj extends any ? FilterKeys<Obj, KeyPattern> extends never ? Default : FilterKeys<Obj, KeyPattern> : never;
|
|
144
|
+
type MediaType = `${string}/${string}`;
|
|
145
|
+
type JSONLike<T> = FilterKeys<T, `${string}/json`>;
|
|
146
|
+
type FindRequiredKeys<T, K extends keyof T> = K extends unknown ? undefined extends T[K] ? never : K : K;
|
|
147
|
+
type HasRequiredKeys<T> = FindRequiredKeys<T, keyof T>;
|
|
148
|
+
type RequiredKeysOfHelper<T> = {
|
|
149
|
+
[K in keyof T]: {} extends Pick<T, K> ? never : K;
|
|
150
|
+
}[keyof T];
|
|
151
|
+
type RequiredKeysOf<T> = RequiredKeysOfHelper<T> extends undefined ? never : RequiredKeysOfHelper<T>;
|
|
152
|
+
type $Read<T> = {
|
|
153
|
+
readonly $read: T;
|
|
154
|
+
};
|
|
155
|
+
type $Write<T> = {
|
|
156
|
+
readonly $write: T;
|
|
157
|
+
};
|
|
158
|
+
type ReadWritePrimitive = string | number | boolean | bigint | symbol | null | undefined;
|
|
159
|
+
type ReadWriteLeaf = ReadWritePrimitive | ((...args: never) => unknown);
|
|
160
|
+
type ReadWriteMarkedKeys<T, Marker> = {
|
|
161
|
+
[K in keyof T]-?: NonNullable<T[K]> extends never ? never : NonNullable<T[K]> extends Marker ? K : never;
|
|
162
|
+
}[keyof T];
|
|
163
|
+
type ReadWriteResolveArray<T extends readonly unknown[], Resolved extends "read" | "write"> = T[number][] extends T ? T extends unknown[] ? ReadWriteResolve<T[number], Resolved>[] : readonly ReadWriteResolve<T[number], Resolved>[] : {
|
|
164
|
+
[K in keyof T]: ReadWriteResolve<T[K], Resolved>;
|
|
165
|
+
};
|
|
166
|
+
type ReadWriteResolve<T, Resolved extends "read" | "write"> = Resolved extends "read" ? Readable<T> : Writable<T>;
|
|
167
|
+
type Readable<T> = T extends $Write<any> ? never : T extends $Read<infer U> ? Readable<U> : T extends ReadWriteLeaf ? T : T extends readonly unknown[] ? ReadWriteResolveArray<T, "read"> : T extends object ? {
|
|
168
|
+
[K in keyof T as K extends ReadWriteMarkedKeys<T, $Write<any>> ? never : K]: Readable<T[K]>;
|
|
169
|
+
} : T;
|
|
170
|
+
type Writable<T> = T extends $Read<any> ? never : T extends $Write<infer U> ? Writable<U> : T extends ReadWriteLeaf ? T : T extends readonly unknown[] ? ReadWriteResolveArray<T, "write"> : T extends object ? {
|
|
171
|
+
[K in keyof T as K extends ReadWriteMarkedKeys<T, $Read<any>> ? never : K]: Writable<T[K]>;
|
|
172
|
+
} & {
|
|
173
|
+
[K in ReadWriteMarkedKeys<T, $Read<any>>]?: never;
|
|
174
|
+
} : T;
|
|
175
|
+
|
|
176
|
+
export type { $Read, $Write, ErrorResponse, ErrorResponseJSON, ErrorStatus, FilterKeys, FindRequiredKeys, FirstErrorStatus, GetResponseContent, GetValueWithDefault, HasRequiredKeys, HttpMethod, IsOperationRequestBodyOptional, JSONLike, MediaType, OKStatusUnion, OkStatus, OperationObject, OperationRequestBody, OperationRequestBodyContent, OperationRequestBodyMediaContent, PathItemObject, PathsWithMethod, Readable, RequestBodyJSON, RequiredKeysOf, ResponseContent, ResponseObjectMap, SuccessResponse, SuccessResponseJSON, Writable };
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}
|
package/package.json
CHANGED
|
@@ -1,6 +1,53 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "openapi-typesafe-helpers",
|
|
3
|
-
"
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"description": "TypeScript helpers for consuming openapi-typesafe types",
|
|
4
|
+
"version": "1.0.0-rc.0",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Fedor Chishchin",
|
|
7
|
+
"url": "https://github.com/fedorello"
|
|
8
|
+
},
|
|
9
|
+
"contributors": [
|
|
10
|
+
{
|
|
11
|
+
"name": "Drew Powers",
|
|
12
|
+
"email": "drew@pow.rs"
|
|
13
|
+
}
|
|
14
|
+
],
|
|
15
|
+
"license": "MIT",
|
|
16
|
+
"type": "module",
|
|
17
|
+
"main": "./dist/index.mjs",
|
|
18
|
+
"exports": {
|
|
19
|
+
".": {
|
|
20
|
+
"import": "./dist/index.mjs",
|
|
21
|
+
"require": "./dist/index.cjs",
|
|
22
|
+
"default": "./dist/index.mjs"
|
|
23
|
+
},
|
|
24
|
+
"./*": "./*"
|
|
25
|
+
},
|
|
26
|
+
"files": [
|
|
27
|
+
"dist"
|
|
28
|
+
],
|
|
29
|
+
"homepage": "https://github.com/openapi-typesafe/openapi-typesafe#readme",
|
|
30
|
+
"repository": {
|
|
31
|
+
"type": "git",
|
|
32
|
+
"url": "git+https://github.com/openapi-typesafe/openapi-typesafe.git",
|
|
33
|
+
"directory": "packages/openapi-typesafe-helpers"
|
|
34
|
+
},
|
|
35
|
+
"bugs": {
|
|
36
|
+
"url": "https://github.com/openapi-typesafe/openapi-typesafe/issues"
|
|
37
|
+
},
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"typescript": "^6.0.3"
|
|
40
|
+
},
|
|
41
|
+
"engines": {
|
|
42
|
+
"node": ">=22"
|
|
43
|
+
},
|
|
44
|
+
"scripts": {
|
|
45
|
+
"build": "unbuild",
|
|
46
|
+
"format": "biome format src --write",
|
|
47
|
+
"lint": "pnpm run lint:js && pnpm run lint:ts",
|
|
48
|
+
"lint:js": "biome check src",
|
|
49
|
+
"lint:ts": "tsc --noEmit",
|
|
50
|
+
"test": "pnpm run test:exports",
|
|
51
|
+
"test:exports": "pnpm run build && ../../scripts/check-exports.sh"
|
|
52
|
+
}
|
|
53
|
+
}
|