-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.ts
More file actions
366 lines (341 loc) · 10.6 KB
/
api.ts
File metadata and controls
366 lines (341 loc) · 10.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
import type {
Additional,
ConditionalKeys,
ConditionalScope,
DevupApiRequestInit,
DevupApiServers,
DevupApiStruct,
DevupApiStructKey,
DevupDeleteApiStruct,
DevupDeleteApiStructKey,
DevupGetApiStruct,
DevupGetApiStructKey,
DevupPatchApiStruct,
DevupPatchApiStructKey,
DevupPostApiStruct,
DevupPostApiStructKey,
DevupPutApiStruct,
DevupPutApiStructKey,
ExtractValue,
Middleware,
RequiredOptions,
} from '@devup-api/core'
import { convertResponse } from './response-converter'
import { getApiEndpointInfo } from './url-map'
import { getApiEndpoint, getQueryString, isPlainObject } from './utils'
// biome-ignore lint/suspicious/noExplicitAny: any is used to allow for flexibility in the type
export type DevupApiResponse<T, E = any> =
| {
data: T
error?: undefined
response: Response
}
| {
data?: undefined
error: E
response: Response
}
export class DevupApi<S extends ConditionalKeys<DevupApiServers>> {
private baseUrl: string
private defaultOptions: DevupApiRequestInit
private serverName: S
private middleware: Middleware[]
constructor(
baseUrl: string,
defaultOptions: DevupApiRequestInit = {},
serverName: S,
) {
this.baseUrl = baseUrl.replace(/\/$/, '')
this.defaultOptions = defaultOptions
this.serverName = serverName as S
this.middleware = []
}
get<
T extends DevupGetApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupGetApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
return this.request(path, {
method: 'GET',
...options[0],
} as DevupApiRequestInit & Omit<O, 'response' | 'error'>)
}
GET<
T extends DevupGetApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupGetApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
return this.request(path, {
method: 'GET',
...options[0],
} as DevupApiRequestInit & Omit<O, 'response' | 'error'>)
}
post<
T extends DevupPostApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupPostApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
return this.request(path, {
method: 'POST',
...options[0],
} as DevupApiRequestInit & Omit<O, 'response' | 'error'>)
}
POST<
T extends DevupPostApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupPostApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
return this.request(path, {
method: 'POST',
...options[0],
} as DevupApiRequestInit & Omit<O, 'response' | 'error'>)
}
put<
T extends DevupPutApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupPutApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
return this.request(path, {
method: 'PUT',
...options[0],
} as DevupApiRequestInit & Omit<O, 'response' | 'error'>)
}
PUT<
T extends DevupPutApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupPutApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
return this.request(path, {
method: 'PUT',
...options[0],
} as DevupApiRequestInit & Omit<O, 'response' | 'error'>)
}
delete<
T extends DevupDeleteApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupDeleteApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
return this.request(path, {
method: 'DELETE',
...options[0],
} as DevupApiRequestInit & Omit<O, 'response' | 'error'>)
}
DELETE<
T extends DevupDeleteApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupDeleteApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
return this.request(path, {
method: 'DELETE',
...options[0],
} as DevupApiRequestInit & Omit<O, 'response' | 'error'>)
}
patch<
T extends DevupPatchApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupPatchApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
return this.request(path, {
method: 'PATCH',
...options[0],
} as DevupApiRequestInit & Omit<O, 'response' | 'error'>)
}
PATCH<
T extends DevupPatchApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupPatchApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
return this.request(path, {
method: 'PATCH',
...options[0],
} as DevupApiRequestInit & Omit<O, 'response' | 'error'>)
}
async request<
T extends DevupApiStructKey<S>,
O extends Additional<T, ConditionalScope<DevupApiStruct, S>>,
>(
path: T,
...options: [RequiredOptions<O>] extends [never]
? [options?: DevupApiRequestInit]
: [options: DevupApiRequestInit & Omit<O, 'response' | 'error'>]
): Promise<
DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
> {
const { method, url } = getApiEndpointInfo(path, this.serverName)
const { middleware = [], query, ...restOptions } = options[0] || {}
const mergedOptions = {
...this.defaultOptions,
...restOptions,
}
const requestOptions = {
...mergedOptions,
method: mergedOptions.method || method,
}
if (requestOptions.body && isPlainObject(requestOptions.body)) {
requestOptions.body = JSON.stringify(requestOptions.body)
}
const queryString = query ? `?${getQueryString(query).toString()}` : ''
let request = new Request(
getApiEndpoint(
this.baseUrl,
url,
(
requestOptions as {
params?: Record<
string,
string | number | boolean | null | undefined
>
}
).params,
) + queryString,
requestOptions as RequestInit,
)
const finalMiddleware = [...this.middleware, ...middleware]
let tempResponse: Response | undefined
for (const middleware of finalMiddleware) {
if (middleware.onRequest) {
const result = await middleware.onRequest({
request,
schemaPath: url,
params: requestOptions.params,
query: requestOptions.query,
headers: requestOptions.headers,
body: requestOptions.body,
})
if (result) {
if (result instanceof Request) {
request = result
} else if (result instanceof Response) {
tempResponse = result
break
} else {
throw new Error(
'onRequest: must return new Request() or Response() when modifying the request',
)
}
}
}
}
const ret = (await (tempResponse
? convertResponse(request, tempResponse)
: fetch(request).then((response) =>
convertResponse(request, response),
))) as DevupApiResponse<
ExtractValue<O, 'response'>,
ExtractValue<O, 'error'>
>
let response = ret.response
let error: unknown = ret.error
for (const middleware of finalMiddleware) {
if (response && middleware.onResponse) {
const result = await (response && middleware.onResponse
? middleware.onResponse({
request,
schemaPath: url,
params: requestOptions.params,
query: requestOptions.query,
headers: requestOptions.headers,
body: requestOptions.body,
response: ret.response,
})
: error && middleware.onError
? middleware.onError({
request,
schemaPath: url,
params: requestOptions.params,
query: requestOptions.query,
headers: requestOptions.headers,
body: requestOptions.body,
error: ret.error,
})
: undefined)
if (result) {
if (result instanceof Response) {
response = result
break
} else if (result instanceof Error) {
error = result
break
}
}
}
}
return {
data: ret.data,
error: error,
response,
} as DevupApiResponse<ExtractValue<O, 'response'>, ExtractValue<O, 'error'>>
}
setDefaultOptions(options: DevupApiRequestInit) {
this.defaultOptions = options
}
getBaseUrl() {
return this.baseUrl
}
getDefaultOptions() {
return this.defaultOptions
}
use(...middleware: Middleware[]) {
this.middleware.push(...middleware)
}
}