-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathstatus.ts
498 lines (472 loc) · 14.4 KB
/
status.ts
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
// Copyright 2018-2024 the oak authors. All rights reserved. MIT license.
/**
* Contains the {@linkcode STATUS_CODE} object which contains standard HTTP
* status codes and provides several type guards for handling status codes
* with type safety.
*
* @example
* ```ts
* import {
* STATUS_CODE,
* STATUS_TEXT,
* } from "jsr:@oak/commons/status";
*
* console.log(STATUS_CODE.NotFound); // Returns 404
* console.log(STATUS_TEXT[STATUS_CODE.NotFound]); // Returns "Not Found"
* ```
*
* @example
* ```ts
* import { isErrorStatus } from "jsr:@oak/commons/status";
*
* const res = await fetch("https://example.com/");
*
* if (isErrorStatus(res.status)) {
* // error handling here...
* }
* ```
*
* @module
*/
/**
* Standard HTTP status codes.
*/
export enum Status {
/** RFC 7231, 6.2.1 */
Continue = 100,
/** RFC 7231, 6.2.2 */
SwitchingProtocols = 101,
/** RFC 2518, 10.1 */
Processing = 102,
/** RFC 8297 **/
EarlyHints = 103,
/** RFC 7231, 6.3.1 */
OK = 200,
/** RFC 7231, 6.3.2 */
Created = 201,
/** RFC 7231, 6.3.3 */
Accepted = 202,
/** RFC 7231, 6.3.4 */
NonAuthoritativeInfo = 203,
/** RFC 7231, 6.3.5 */
NoContent = 204,
/** RFC 7231, 6.3.6 */
ResetContent = 205,
/** RFC 7233, 4.1 */
PartialContent = 206,
/** RFC 4918, 11.1 */
MultiStatus = 207,
/** RFC 5842, 7.1 */
AlreadyReported = 208,
/** RFC 3229, 10.4.1 */
IMUsed = 226,
/** RFC 7231, 6.4.1 */
MultipleChoices = 300,
/** RFC 7231, 6.4.2 */
MovedPermanently = 301,
/** RFC 7231, 6.4.3 */
Found = 302,
/** RFC 7231, 6.4.4 */
SeeOther = 303,
/** RFC 7232, 4.1 */
NotModified = 304,
/** RFC 7231, 6.4.5 */
UseProxy = 305,
/** RFC 7231, 6.4.7 */
TemporaryRedirect = 307,
/** RFC 7538, 3 */
PermanentRedirect = 308,
/** RFC 7231, 6.5.1 */
BadRequest = 400,
/** RFC 7235, 3.1 */
Unauthorized = 401,
/** RFC 7231, 6.5.2 */
PaymentRequired = 402,
/** RFC 7231, 6.5.3 */
Forbidden = 403,
/** RFC 7231, 6.5.4 */
NotFound = 404,
/** RFC 7231, 6.5.5 */
MethodNotAllowed = 405,
/** RFC 7231, 6.5.6 */
NotAcceptable = 406,
/** RFC 7235, 3.2 */
ProxyAuthRequired = 407,
/** RFC 7231, 6.5.7 */
RequestTimeout = 408,
/** RFC 7231, 6.5.8 */
Conflict = 409,
/** RFC 7231, 6.5.9 */
Gone = 410,
/** RFC 7231, 6.5.10 */
LengthRequired = 411,
/** RFC 7232, 4.2 */
PreconditionFailed = 412,
/** RFC 7231, 6.5.11 */
RequestEntityTooLarge = 413,
/** RFC 7231, 6.5.12 */
RequestURITooLong = 414,
/** RFC 7231, 6.5.13 */
UnsupportedMediaType = 415,
/** RFC 7233, 4.4 */
RequestedRangeNotSatisfiable = 416,
/** RFC 7231, 6.5.14 */
ExpectationFailed = 417,
/** RFC 7168, 2.3.3 */
Teapot = 418,
/** RFC 7540, 9.1.2 */
MisdirectedRequest = 421,
/** RFC 4918, 11.2 */
UnprocessableEntity = 422,
/** RFC 4918, 11.3 */
Locked = 423,
/** RFC 4918, 11.4 */
FailedDependency = 424,
/** RFC 8470, 5.2 */
TooEarly = 425,
/** RFC 7231, 6.5.15 */
UpgradeRequired = 426,
/** RFC 6585, 3 */
PreconditionRequired = 428,
/** RFC 6585, 4 */
TooManyRequests = 429,
/** RFC 6585, 5 */
RequestHeaderFieldsTooLarge = 431,
/** RFC 7725, 3 */
UnavailableForLegalReasons = 451,
/** RFC 7231, 6.6.1 */
InternalServerError = 500,
/** RFC 7231, 6.6.2 */
NotImplemented = 501,
/** RFC 7231, 6.6.3 */
BadGateway = 502,
/** RFC 7231, 6.6.4 */
ServiceUnavailable = 503,
/** RFC 7231, 6.6.5 */
GatewayTimeout = 504,
/** RFC 7231, 6.6.6 */
HTTPVersionNotSupported = 505,
/** RFC 2295, 8.1 */
VariantAlsoNegotiates = 506,
/** RFC 4918, 11.5 */
InsufficientStorage = 507,
/** RFC 5842, 7.2 */
LoopDetected = 508,
/** RFC 2774, 7 */
NotExtended = 510,
/** RFC 6585, 6 */
NetworkAuthenticationRequired = 511,
}
/**
* A constant hash of all the standard HTTP status codes.
*/
export const STATUS_CODE = {
/** RFC 7231, 6.2.1 */
Continue: 100,
/** RFC 7231, 6.2.2 */
SwitchingProtocols: 101,
/** RFC 2518, 10.1 */
Processing: 102,
/** RFC 8297 **/
EarlyHints: 103,
/** RFC 7231, 6.3.1 */
OK: 200,
/** RFC 7231, 6.3.2 */
Created: 201,
/** RFC 7231, 6.3.3 */
Accepted: 202,
/** RFC 7231, 6.3.4 */
NonAuthoritativeInfo: 203,
/** RFC 7231, 6.3.5 */
NoContent: 204,
/** RFC 7231, 6.3.6 */
ResetContent: 205,
/** RFC 7233, 4.1 */
PartialContent: 206,
/** RFC 4918, 11.1 */
MultiStatus: 207,
/** RFC 5842, 7.1 */
AlreadyReported: 208,
/** RFC 3229, 10.4.1 */
IMUsed: 226,
/** RFC 7231, 6.4.1 */
MultipleChoices: 300,
/** RFC 7231, 6.4.2 */
MovedPermanently: 301,
/** RFC 7231, 6.4.3 */
Found: 302,
/** RFC 7231, 6.4.4 */
SeeOther: 303,
/** RFC 7232, 4.1 */
NotModified: 304,
/** RFC 7231, 6.4.5 */
UseProxy: 305,
/** RFC 7231, 6.4.7 */
TemporaryRedirect: 307,
/** RFC 7538, 3 */
PermanentRedirect: 308,
/** RFC 7231, 6.5.1 */
BadRequest: 400,
/** RFC 7235, 3.1 */
Unauthorized: 401,
/** RFC 7231, 6.5.2 */
PaymentRequired: 402,
/** RFC 7231, 6.5.3 */
Forbidden: 403,
/** RFC 7231, 6.5.4 */
NotFound: 404,
/** RFC 7231, 6.5.5 */
MethodNotAllowed: 405,
/** RFC 7231, 6.5.6 */
NotAcceptable: 406,
/** RFC 7235, 3.2 */
ProxyAuthRequired: 407,
/** RFC 7231, 6.5.7 */
RequestTimeout: 408,
/** RFC 7231, 6.5.8 */
Conflict: 409,
/** RFC 7231, 6.5.9 */
Gone: 410,
/** RFC 7231, 6.5.10 */
LengthRequired: 411,
/** RFC 7232, 4.2 */
PreconditionFailed: 412,
/** RFC 7231, 6.5.11 */
ContentTooLarge: 413,
/** RFC 7231, 6.5.12 */
URITooLong: 414,
/** RFC 7231, 6.5.13 */
UnsupportedMediaType: 415,
/** RFC 7233, 4.4 */
RangeNotSatisfiable: 416,
/** RFC 7231, 6.5.14 */
ExpectationFailed: 417,
/** RFC 7168, 2.3.3 */
Teapot: 418,
/** RFC 7540, 9.1.2 */
MisdirectedRequest: 421,
/** RFC 4918, 11.2 */
UnprocessableEntity: 422,
/** RFC 4918, 11.3 */
Locked: 423,
/** RFC 4918, 11.4 */
FailedDependency: 424,
/** RFC 8470, 5.2 */
TooEarly: 425,
/** RFC 7231, 6.5.15 */
UpgradeRequired: 426,
/** RFC 6585, 3 */
PreconditionRequired: 428,
/** RFC 6585, 4 */
TooManyRequests: 429,
/** RFC 6585, 5 */
RequestHeaderFieldsTooLarge: 431,
/** RFC 7725, 3 */
UnavailableForLegalReasons: 451,
/** RFC 7231, 6.6.1 */
InternalServerError: 500,
/** RFC 7231, 6.6.2 */
NotImplemented: 501,
/** RFC 7231, 6.6.3 */
BadGateway: 502,
/** RFC 7231, 6.6.4 */
ServiceUnavailable: 503,
/** RFC 7231, 6.6.5 */
GatewayTimeout: 504,
/** RFC 7231, 6.6.6 */
HTTPVersionNotSupported: 505,
/** RFC 2295, 8.1 */
VariantAlsoNegotiates: 506,
/** RFC 4918, 11.5 */
InsufficientStorage: 507,
/** RFC 5842, 7.2 */
LoopDetected: 508,
/** RFC 2774, 7 */
NotExtended: 510,
/** RFC 6585, 6 */
NetworkAuthenticationRequired: 511,
} as const;
export type StatusCode = typeof STATUS_CODE[keyof typeof STATUS_CODE];
/**
* A record of all the status codes text.
*/
export const STATUS_TEXT = {
[STATUS_CODE.Accepted]: "Accepted",
[STATUS_CODE.AlreadyReported]: "Already Reported",
[STATUS_CODE.BadGateway]: "Bad Gateway",
[STATUS_CODE.BadRequest]: "Bad Request",
[STATUS_CODE.Conflict]: "Conflict",
[STATUS_CODE.Continue]: "Continue",
[STATUS_CODE.Created]: "Created",
[STATUS_CODE.EarlyHints]: "Early Hints",
[STATUS_CODE.ExpectationFailed]: "Expectation Failed",
[STATUS_CODE.FailedDependency]: "Failed Dependency",
[STATUS_CODE.Forbidden]: "Forbidden",
[STATUS_CODE.Found]: "Found",
[STATUS_CODE.GatewayTimeout]: "Gateway Timeout",
[STATUS_CODE.Gone]: "Gone",
[STATUS_CODE.HTTPVersionNotSupported]: "HTTP Version Not Supported",
[STATUS_CODE.IMUsed]: "IM Used",
[STATUS_CODE.InsufficientStorage]: "Insufficient Storage",
[STATUS_CODE.InternalServerError]: "Internal Server Error",
[STATUS_CODE.LengthRequired]: "Length Required",
[STATUS_CODE.Locked]: "Locked",
[STATUS_CODE.LoopDetected]: "Loop Detected",
[STATUS_CODE.MethodNotAllowed]: "Method Not Allowed",
[STATUS_CODE.MisdirectedRequest]: "Misdirected Request",
[STATUS_CODE.MovedPermanently]: "Moved Permanently",
[STATUS_CODE.MultiStatus]: "Multi Status",
[STATUS_CODE.MultipleChoices]: "Multiple Choices",
[STATUS_CODE.NetworkAuthenticationRequired]:
"Network Authentication Required",
[STATUS_CODE.NoContent]: "No Content",
[STATUS_CODE.NonAuthoritativeInfo]: "Non Authoritative Info",
[STATUS_CODE.NotAcceptable]: "Not Acceptable",
[STATUS_CODE.NotExtended]: "Not Extended",
[STATUS_CODE.NotFound]: "Not Found",
[STATUS_CODE.NotImplemented]: "Not Implemented",
[STATUS_CODE.NotModified]: "Not Modified",
[STATUS_CODE.OK]: "OK",
[STATUS_CODE.PartialContent]: "Partial Content",
[STATUS_CODE.PaymentRequired]: "Payment Required",
[STATUS_CODE.PermanentRedirect]: "Permanent Redirect",
[STATUS_CODE.PreconditionFailed]: "Precondition Failed",
[STATUS_CODE.PreconditionRequired]: "Precondition Required",
[STATUS_CODE.Processing]: "Processing",
[STATUS_CODE.ProxyAuthRequired]: "Proxy Auth Required",
[STATUS_CODE.ContentTooLarge]: "Content Too Large",
[STATUS_CODE.RequestHeaderFieldsTooLarge]: "Request Header Fields Too Large",
[STATUS_CODE.RequestTimeout]: "Request Timeout",
[STATUS_CODE.URITooLong]: "URI Too Long",
[STATUS_CODE.RangeNotSatisfiable]: "Range Not Satisfiable",
[STATUS_CODE.ResetContent]: "Reset Content",
[STATUS_CODE.SeeOther]: "See Other",
[STATUS_CODE.ServiceUnavailable]: "Service Unavailable",
[STATUS_CODE.SwitchingProtocols]: "Switching Protocols",
[STATUS_CODE.Teapot]: "I'm a teapot",
[STATUS_CODE.TemporaryRedirect]: "Temporary Redirect",
[STATUS_CODE.TooEarly]: "Too Early",
[STATUS_CODE.TooManyRequests]: "Too Many Requests",
[STATUS_CODE.Unauthorized]: "Unauthorized",
[STATUS_CODE.UnavailableForLegalReasons]: "Unavailable For Legal Reasons",
[STATUS_CODE.UnprocessableEntity]: "Unprocessable Entity",
[STATUS_CODE.UnsupportedMediaType]: "Unsupported Media Type",
[STATUS_CODE.UpgradeRequired]: "Upgrade Required",
[STATUS_CODE.UseProxy]: "Use Proxy",
[STATUS_CODE.VariantAlsoNegotiates]: "Variant Also Negotiates",
} as const;
/**
* A type alias which is a set of string literal types of all the status text
* values.
*/
export type StatusText = typeof STATUS_TEXT[keyof typeof STATUS_TEXT];
/** An HTTP status that is a informational (1XX). */
export type InformationalStatus =
| typeof STATUS_CODE.Continue
| typeof STATUS_CODE.SwitchingProtocols
| typeof STATUS_CODE.Processing
| typeof STATUS_CODE.EarlyHints;
/** An HTTP status that is a success (2XX). */
export type SuccessfulStatus =
| typeof STATUS_CODE.OK
| typeof STATUS_CODE.Created
| typeof STATUS_CODE.Accepted
| typeof STATUS_CODE.NonAuthoritativeInfo
| typeof STATUS_CODE.NoContent
| typeof STATUS_CODE.ResetContent
| typeof STATUS_CODE.PartialContent
| typeof STATUS_CODE.MultiStatus
| typeof STATUS_CODE.AlreadyReported
| typeof STATUS_CODE.IMUsed;
/** An HTTP status that is a redirect (3XX). */
export type RedirectStatus =
| typeof STATUS_CODE.MultipleChoices // 300
| typeof STATUS_CODE.MovedPermanently // 301
| typeof STATUS_CODE.Found // 302
| typeof STATUS_CODE.SeeOther // 303
| typeof STATUS_CODE.UseProxy // 305 - DEPRECATED
| typeof STATUS_CODE.TemporaryRedirect // 307
| typeof STATUS_CODE.PermanentRedirect; // 308
/** An HTTP status that is a client error (4XX). */
export type ClientErrorStatus =
| typeof STATUS_CODE.BadRequest
| typeof STATUS_CODE.Unauthorized
| typeof STATUS_CODE.PaymentRequired
| typeof STATUS_CODE.Forbidden
| typeof STATUS_CODE.NotFound
| typeof STATUS_CODE.MethodNotAllowed
| typeof STATUS_CODE.NotAcceptable
| typeof STATUS_CODE.ProxyAuthRequired
| typeof STATUS_CODE.RequestTimeout
| typeof STATUS_CODE.Conflict
| typeof STATUS_CODE.Gone
| typeof STATUS_CODE.LengthRequired
| typeof STATUS_CODE.PreconditionFailed
| typeof STATUS_CODE.ContentTooLarge
| typeof STATUS_CODE.URITooLong
| typeof STATUS_CODE.UnsupportedMediaType
| typeof STATUS_CODE.RangeNotSatisfiable
| typeof STATUS_CODE.ExpectationFailed
| typeof STATUS_CODE.Teapot
| typeof STATUS_CODE.MisdirectedRequest
| typeof STATUS_CODE.UnprocessableEntity
| typeof STATUS_CODE.Locked
| typeof STATUS_CODE.FailedDependency
| typeof STATUS_CODE.UpgradeRequired
| typeof STATUS_CODE.PreconditionRequired
| typeof STATUS_CODE.TooManyRequests
| typeof STATUS_CODE.RequestHeaderFieldsTooLarge
| typeof STATUS_CODE.UnavailableForLegalReasons;
/** An HTTP status that is a server error (5XX). */
export type ServerErrorStatus =
| typeof STATUS_CODE.InternalServerError
| typeof STATUS_CODE.NotImplemented
| typeof STATUS_CODE.BadGateway
| typeof STATUS_CODE.ServiceUnavailable
| typeof STATUS_CODE.GatewayTimeout
| typeof STATUS_CODE.HTTPVersionNotSupported
| typeof STATUS_CODE.VariantAlsoNegotiates
| typeof STATUS_CODE.InsufficientStorage
| typeof STATUS_CODE.LoopDetected
| typeof STATUS_CODE.NotExtended
| typeof STATUS_CODE.NetworkAuthenticationRequired;
/** An HTTP status that is an error (4XX and 5XX). */
export type ErrorStatus = ClientErrorStatus | ServerErrorStatus;
/**
* A type guard that determines if the value is a valid {@linkcode StatusCode}.
*/
export function isStatus(status: number): status is StatusCode {
return Object.values(STATUS_CODE).includes(status as StatusCode);
}
/** A type guard that determines if the status code is informational. */
export function isInformationalStatus(
status: number,
): status is InformationalStatus {
return isStatus(status) && status >= 100 && status < 200;
}
/** A type guard that determines if the status code is successful. */
export function isSuccessfulStatus(
status: number,
): status is SuccessfulStatus {
return isStatus(status) && status >= 200 && status < 300;
}
/** A type guard that determines if the status code is a redirection. */
export function isRedirectStatus(status: number): status is RedirectStatus {
return isStatus(status) && status >= 300 && status < 400;
}
/** A type guard that determines if the status code is a client error. */
export function isClientErrorStatus(
status: number,
): status is ClientErrorStatus {
return isStatus(status) && status >= 400 && status < 500;
}
/** A type guard that determines if the status code is a server error. */
export function isServerErrorStatus(
status: number,
): status is ServerErrorStatus {
return isStatus(status) && status >= 500 && status < 600;
}
/** A type guard that determines if the status code is an error. */
export function isErrorStatus(status: number): status is ErrorStatus {
return isStatus(status) && status >= 400 && status < 600;
}