eve-esi-types 3.0.4 → 3.1.2

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.
@@ -9,7 +9,7 @@
9
9
  * THIS DTS IS AUTO GENERATED, DO NOT EDIT
10
10
  *
11
11
  * @file eve-esi-types/v2/response-map.d.ts
12
- * @summary This file is auto-generated and defines version 3.0.4 of the EVE Online ESI response types.
12
+ * @summary This file is auto-generated and defines version 3.1.1 of the EVE Online ESI response types.
13
13
  */
14
14
  import "./types-index.d.ts";
15
15
 
@@ -9,7 +9,7 @@
9
9
  * THIS DTS IS AUTO GENERATED, DO NOT EDIT
10
10
  *
11
11
  * @file eve-esi-types/v2/types-index.d.ts
12
- * @summary This file is auto-generated and defines version 3.0.4 of the EVE Online ESI response types.
12
+ * @summary This file is auto-generated and defines version 3.1.1 of the EVE Online ESI response types.
13
13
  */
14
14
  import "./get_wars_ok.d.ts";
15
15
  import "./get_status_ok.d.ts";
@@ -1,186 +0,0 @@
1
- <!--!
2
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3
- Copyright (C) 2025 jeffy-g <hirotom1107@gmail.com>
4
- Released under the MIT license
5
- https://opensource.org/licenses/mit-license.php
6
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
7
- -->
8
-
9
- # ESI Types Utility Summary
10
-
11
- ## TESICachedSeconds
12
- `TESICachedSeconds` is a type to get the cached seconds for a specific HTTP method.
13
-
14
- ```typescript
15
- type TESICachedSeconds<
16
- Method extends TESIEntryMethod, AsEndpoint = void
17
- > = {
18
- [M in TESIEntryMethod]: {
19
- [EP in keyof TESIResponseOKMap[M]]: TESIResponseOKMap[M][EP]["cachedSeconds"] extends number
20
- ? AsEndpoint extends void
21
- ? TESIResponseOKMap[M][EP]["cachedSeconds"]: EP
22
- : never
23
- }[keyof TESIResponseOKMap[M]];
24
- }[Method];
25
- ```
26
-
27
- ## TPathParamsNever
28
- `TPathParamsNever` is a type used when path parameters are not required.
29
-
30
- ```typescript
31
- type TPathParamsNever = { pathParams?: never };
32
- ```
33
-
34
- ## TESIRequestFunctionSignature2
35
- `TESIRequestFunctionSignature2` is a type that defines the signature of an ESI request function.
36
-
37
- ```typescript
38
- type TESIRequestFunctionSignature2<ActualOpt> = <
39
- M extends TESIEntryMethod,
40
- RealEP extends ReplacePathParams<keyof TESIResponseOKMap[M] & string> | keyof TESIResponseOKMap[M],
41
- EP extends InferEndpointOrigin<RealEP, keyof TESIResponseOKMap[M]> extends never ? RealEP: InferEndpointOrigin<RealEP, keyof TESIResponseOKMap[M]>,
42
- PathParams extends RealEP extends EP ? IfNeedPathParams<EP>: TPathParamsNever,
43
- Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ActualOpt & PathParams>,
44
- R extends InferESIResponseResult<M, EP>
45
- >(method: M, endpoint: RealEP, options?: Opt) => Promise<R>;
46
- ```
47
-
48
- ## TESIRequestFunctionEachMethod2
49
- `TESIRequestFunctionEachMethod2` is a type that defines functions to make ESI requests for a specific HTTP method.
50
-
51
- ```typescript
52
- type TESIRequestFunctionEachMethod2<M extends TESIEntryMethod, ActualOpt = {}> = <
53
- RealEP extends ReplacePathParams<keyof TESIResponseOKMap[M] & string> | keyof TESIResponseOKMap[M],
54
- EP extends InferEndpointOrigin<RealEP, keyof TESIResponseOKMap[M]> extends never ? RealEP: InferEndpointOrigin<RealEP, keyof TESIResponseOKMap[M]>,
55
- PathParams extends RealEP extends EP ? IfNeedPathParams<EP>: TPathParamsNever,
56
- Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ActualOpt & PathParams>,
57
- R extends InferESIResponseResult<M, EP>
58
- >(endpoint: RealEP, options?: Opt) => Promise<R>;
59
- ```
60
-
61
- ## ReplacePathParams
62
- `ReplacePathParams` is a type that replaces path parameters in a string with numbers.
63
-
64
- ```typescript
65
- type ReplacePathParams<T extends string> = T extends `${infer Start}{${infer Param}}${infer End}`
66
- ? `${Start}${number}${ReplacePathParams<End>}` : T;
67
- ```
68
-
69
- ## IfNeedPathParams
70
- `IfNeedPathParams` is a type that determines if the endpoint requires path parameters.
71
-
72
- ```typescript
73
- type IfNeedPathParams<EP> = IfParameterizedPath<EP> extends never ? TPathParamsNever :
74
- EP extends ReplacePathParams<EP> ? TPathParamsNever : { pathParams: IfParameterizedPath<EP> };
75
- ```
76
-
77
- ## InferEndpointOrigin
78
- `InferEndpointOrigin` is a type that infers the original endpoint path from a real endpoint path.
79
-
80
- ```typescript
81
- type InferEndpointOrigin<RealEP extends unknown, Endpoints> = {
82
- [EP in Endpoints]: RealEP extends ReplacePathParams<EP>
83
- ? EP : never;
84
- }[Endpoints];
85
- ```
86
-
87
- ## IfParameterizedPath
88
- `IfParameterizedPath` is a type that determines the required number of replacements if the endpoint is a parameterized path.
89
-
90
- ```typescript
91
- type IfParameterizedPath<EP, Opt = never> = EP extends `${string}/{${string}}${string}`
92
- ? PickPathParameters<EP> extends never
93
- ? Opt : InferKeysLen<PickPathParameters<EP>> extends 1
94
- ? number : [number, number]
95
- : Opt;
96
- ```
97
-
98
- ## IdentifyParameters
99
- `IdentifyParameters` is a type that identifies the required parameters for a given entry type.
100
-
101
- ```typescript
102
- type IdentifyParameters<
103
- Entry, Opt,
104
- Keys = Exclude<keyof Entry, "result" | "tag" | "cachedSeconds">
105
- > = RequireThese<Opt, Keys> & Pick<Entry, Keys>;
106
- ```
107
-
108
- ## InferESIResponseResult
109
- `InferESIResponseResult` is a type that infers the result type of an ESI response based on the method and endpoint.
110
-
111
- ```typescript
112
- type InferESIResponseResult<
113
- M extends TESIEntryMethod,
114
- EP extends keyof TESIResponseOKMap[M]
115
- > = TESIResponseOKMap[M][EP] extends { result: infer U } ? U : never;
116
- ```
117
-
118
- ## NoContentResponse
119
- `NoContentResponse` is a type that represents a response with no content (HTTP status 204).
120
-
121
- ```typescript
122
- type NoContentResponse = { /* status: 204 */ };
123
- ```
124
-
125
- ## TESIEntryMethod
126
- `TESIEntryMethod` is a type that represents the HTTP methods supported by ESI.
127
-
128
- ```typescript
129
- type TESIEntryMethod = keyof TESIResponseOKMap;
130
- ```
131
-
132
- ## TEndPointGet
133
- `TEndPointGet` is a type that represents the endpoints for the "get" method.
134
-
135
- ```typescript
136
- type TEndPointGet = keyof TESIResponseOKMap["get"];
137
- ```
138
-
139
- ## TEndPointPost
140
- `TEndPointPost` is a type that represents the endpoints for the "post" method.
141
-
142
- ```typescript
143
- type TEndPointPost = keyof TESIResponseOKMap["post"];
144
- ```
145
-
146
- ## TEndPointPut
147
- `TEndPointPut` is a type that represents the endpoints for the "put" method.
148
-
149
- ```typescript
150
- type TEndPointPut = keyof TESIResponseOKMap["put"];
151
- ```
152
-
153
- ## TEndPointDelete
154
- `TEndPointDelete` is a type that represents the endpoints for the "delete" method.
155
-
156
- ```typescript
157
- type TEndPointDelete = keyof TESIResponseOKMap["delete"];
158
- ```
159
-
160
- ## TESIResponseGetEntry
161
- `TESIResponseGetEntry` is a type that represents the entry details for the "get" method.
162
-
163
- ```typescript
164
- type TESIResponseGetEntry<K extends TEndPointGet> = TESIResponseOKMap["get"][K];
165
- ```
166
-
167
- ## TESIResponsePutEntry
168
- `TESIResponsePutEntry` is a type that represents the entry details for the "put" method.
169
-
170
- ```typescript
171
- type TESIResponsePutEntry<K extends TEndPointPut> = TESIResponseOKMap["put"][K];
172
- ```
173
-
174
- ## TESIResponsePostEntry
175
- `TESIResponsePostEntry` is a type that represents the entry details for the "post" method.
176
-
177
- ```typescript
178
- type TESIResponsePostEntry<K extends TEndPointPost> = TESIResponseOKMap["post"][K];
179
- ```
180
-
181
- ## TESIResponseDeleteEntry
182
- `TESIResponseDeleteEntry` is a type that represents the entry details for the "delete" method.
183
-
184
- ```typescript
185
- type TESIResponseDeleteEntry<K extends TEndPointDelete> = TESIResponseOKMap["delete"][K];
186
- ```
File without changes