@web-ts-toolkit/http-errors 0.0.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.
- package/LICENSE +202 -0
- package/README.md +255 -0
- package/index.d.mts +187 -0
- package/index.d.ts +187 -0
- package/index.js +443 -0
- package/index.mjs +372 -0
- package/package.json +33 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright © 2017, Province of British Columbia, Canada.
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,255 @@
|
|
|
1
|
+
# http-errors
|
|
2
|
+
|
|
3
|
+
HTTP error classes for backend APIs, including 4xx client errors and 5xx server errors.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install @web-ts-toolkit/http-errors
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
### Basic TypeScript usage
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { HttpError, UnauthorizedError, ServiceUnavailableError } from '@web-ts-toolkit/http-errors';
|
|
17
|
+
|
|
18
|
+
throw new UnauthorizedError();
|
|
19
|
+
throw new UnauthorizedError('missing bearer token');
|
|
20
|
+
|
|
21
|
+
throw new HttpError(503);
|
|
22
|
+
throw new HttpError(503, 'please try again later');
|
|
23
|
+
|
|
24
|
+
throw new ServiceUnavailableError();
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Use a specific 4xx error
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import { BadRequestError } from '@web-ts-toolkit/http-errors';
|
|
31
|
+
|
|
32
|
+
function parseLimit(value: string | undefined): number {
|
|
33
|
+
const limit = Number(value);
|
|
34
|
+
|
|
35
|
+
if (!Number.isInteger(limit) || limit <= 0) {
|
|
36
|
+
throw new BadRequestError('limit must be a positive integer');
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
return limit;
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Use the category base classes
|
|
44
|
+
|
|
45
|
+
```ts
|
|
46
|
+
import { ClientError, ServerError } from '@web-ts-toolkit/http-errors';
|
|
47
|
+
|
|
48
|
+
throw new ClientError(403, 'forbidden project access');
|
|
49
|
+
throw new ServerError(503, 'search index is rebuilding');
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Attach a cause
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
import { ServiceUnavailableError } from '@web-ts-toolkit/http-errors';
|
|
56
|
+
|
|
57
|
+
try {
|
|
58
|
+
await fetch('https://api.example.com/health');
|
|
59
|
+
} catch (cause) {
|
|
60
|
+
throw new ServiceUnavailableError('upstream API is unavailable', { cause });
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Add machine-readable error metadata
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
import { BadRequestError } from '@web-ts-toolkit/http-errors';
|
|
68
|
+
|
|
69
|
+
throw new BadRequestError('invalid email', {
|
|
70
|
+
reason: 'INVALID_EMAIL',
|
|
71
|
+
domain: 'api.example.com',
|
|
72
|
+
metadata: {
|
|
73
|
+
field: 'email',
|
|
74
|
+
},
|
|
75
|
+
details: [
|
|
76
|
+
{
|
|
77
|
+
type: 'help',
|
|
78
|
+
links: [
|
|
79
|
+
{
|
|
80
|
+
description: 'Validation guide',
|
|
81
|
+
url: 'https://api.example.com/docs/errors/invalid-email',
|
|
82
|
+
},
|
|
83
|
+
],
|
|
84
|
+
},
|
|
85
|
+
],
|
|
86
|
+
errors: [
|
|
87
|
+
{
|
|
88
|
+
field: 'email',
|
|
89
|
+
description: 'Email must be a valid address.',
|
|
90
|
+
},
|
|
91
|
+
],
|
|
92
|
+
});
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
The base `HttpError` now carries optional structured fields that are useful when building AIP-193-style error payloads:
|
|
96
|
+
|
|
97
|
+
- `statusCode`: HTTP status code
|
|
98
|
+
- `status`: canonical status string for common HTTP codes, otherwise `UNKNOWN`
|
|
99
|
+
- `reason`: application-specific machine-readable identifier
|
|
100
|
+
- `domain`: logical error domain such as `api.example.com`
|
|
101
|
+
- `metadata`: stringified key-value metadata
|
|
102
|
+
- `details`: structured detail entries
|
|
103
|
+
- `errors`: validation or field-level error payloads
|
|
104
|
+
|
|
105
|
+
### Convert an error to an AIP-193-style payload
|
|
106
|
+
|
|
107
|
+
```ts
|
|
108
|
+
import { BadRequestError, toAip193ErrorPayload } from '@web-ts-toolkit/http-errors';
|
|
109
|
+
|
|
110
|
+
const error = new BadRequestError('invalid email', {
|
|
111
|
+
reason: 'INVALID_EMAIL',
|
|
112
|
+
domain: 'api.example.com',
|
|
113
|
+
metadata: {
|
|
114
|
+
field: 'email',
|
|
115
|
+
},
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
const payload = toAip193ErrorPayload(error);
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Express route example
|
|
122
|
+
|
|
123
|
+
```ts
|
|
124
|
+
import express from 'express';
|
|
125
|
+
import { BadRequestError, ForbiddenError, NotFoundError } from '@web-ts-toolkit/http-errors';
|
|
126
|
+
|
|
127
|
+
type User = {
|
|
128
|
+
id: string;
|
|
129
|
+
role: 'admin' | 'member';
|
|
130
|
+
};
|
|
131
|
+
|
|
132
|
+
type Project = {
|
|
133
|
+
id: string;
|
|
134
|
+
ownerId: string;
|
|
135
|
+
name: string;
|
|
136
|
+
};
|
|
137
|
+
|
|
138
|
+
const app = express();
|
|
139
|
+
|
|
140
|
+
const projects = new Map<string, Project>([['project-1', { id: 'project-1', ownerId: 'user-1', name: 'Toolkit' }]]);
|
|
141
|
+
|
|
142
|
+
app.use(express.json());
|
|
143
|
+
|
|
144
|
+
app.put('/projects/:id', (req, res) => {
|
|
145
|
+
const user = req.user as User | undefined;
|
|
146
|
+
const project = projects.get(req.params.id);
|
|
147
|
+
|
|
148
|
+
if (!user) {
|
|
149
|
+
throw new ForbiddenError('authentication required');
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
if (!project) {
|
|
153
|
+
throw new NotFoundError('project was not found');
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
if (project.ownerId !== user.id && user.role !== 'admin') {
|
|
157
|
+
throw new ForbiddenError('you cannot update this project');
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
if (typeof req.body.name !== 'string' || req.body.name.trim() === '') {
|
|
161
|
+
throw new BadRequestError('name is required');
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
project.name = req.body.name.trim();
|
|
165
|
+
res.json(project);
|
|
166
|
+
});
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### Express error middleware example
|
|
170
|
+
|
|
171
|
+
```ts
|
|
172
|
+
import type { NextFunction, Request, Response } from 'express';
|
|
173
|
+
import express from 'express';
|
|
174
|
+
import { HttpError, InternalServerError } from '@web-ts-toolkit/http-errors';
|
|
175
|
+
|
|
176
|
+
const app = express();
|
|
177
|
+
|
|
178
|
+
app.use((err: unknown, _req: Request, res: Response, _next: NextFunction) => {
|
|
179
|
+
if (err instanceof HttpError) {
|
|
180
|
+
return res.status(err.statusCode).json({
|
|
181
|
+
error: {
|
|
182
|
+
name: err.name,
|
|
183
|
+
message: err.message,
|
|
184
|
+
statusCode: err.statusCode,
|
|
185
|
+
},
|
|
186
|
+
});
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
const fallback = new InternalServerError('unexpected server error');
|
|
190
|
+
|
|
191
|
+
return res.status(fallback.statusCode).json({
|
|
192
|
+
error: {
|
|
193
|
+
name: fallback.name,
|
|
194
|
+
message: fallback.message,
|
|
195
|
+
statusCode: fallback.statusCode,
|
|
196
|
+
},
|
|
197
|
+
});
|
|
198
|
+
});
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Error Hierarchy
|
|
202
|
+
|
|
203
|
+
`HttpError` is the neutral base class for HTTP responses.
|
|
204
|
+
|
|
205
|
+
`ClientError` is the base class for 4xx responses.
|
|
206
|
+
|
|
207
|
+
`ServerError` is the base class for 5xx responses.
|
|
208
|
+
|
|
209
|
+
## Client Errors
|
|
210
|
+
|
|
211
|
+
| Code | Description | Class Name | Default Message |
|
|
212
|
+
| ---- | ------------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
213
|
+
| 400 | Bad Request | BadRequestError | The server cannot process the request due to a client error |
|
|
214
|
+
| 401 | Unauthorized | UnauthorizedError | The user is not authorized |
|
|
215
|
+
| 403 | Forbidden | ForbiddenError | The server refused to authorize the request |
|
|
216
|
+
| 404 | Not Found | NotFoundError | The server did not find a current representation for the target resource |
|
|
217
|
+
| 405 | Method Not Allowed | MethodNotAllowedError | The method received is not allowed |
|
|
218
|
+
| 406 | Not Acceptable | NotAcceptableError | The request is not acceptable to the user agent |
|
|
219
|
+
| 407 | Proxy Authentication Required | ProxyAuthRequiredError | The client needs to authenticate itself in order to use a proxy |
|
|
220
|
+
| 408 | Request Timeout | RequestTimeoutError | The request was not completed in the expected time |
|
|
221
|
+
| 409 | Conflict | ConflictError | The request was not completed due to a conflict with the target resource |
|
|
222
|
+
| 410 | Gone | GoneError | The target resource is no longer available at the origin server |
|
|
223
|
+
| 411 | Length Required | LengthRequiredError | The server refuses to accept the request without a defined Content-Length |
|
|
224
|
+
| 412 | Precondition Failed | PreconditionFailedError | One or more conditions given in the request header fields evaluated to false |
|
|
225
|
+
| 413 | Payload Too Large | PayloadTooLargeError | The request payload is too large |
|
|
226
|
+
| 414 | URI Too Long | UriTooLongError | The request target is too long |
|
|
227
|
+
| 415 | Unsupported Media Type | UnsupportedMediaTypeError | The payload is in a format not supported |
|
|
228
|
+
| 416 | Requested Range Not Satisfiable | RequestedRangeNotSatisfiableError | None of the ranges in the request's Range header field overlap the current extent of the selected resource |
|
|
229
|
+
| 417 | Expectation Failed | ExpectationFailedError | The expectation given in the request's Expect header field could not be met |
|
|
230
|
+
| 418 | I'm a teapot | TeapotError | I'm a teapot |
|
|
231
|
+
| 421 | Misdirected Request | MisdirectedRequestError | The request was directed at a server that is not able to produce a response |
|
|
232
|
+
| 422 | Unprocessable Entity | UnprocessableEntityError | The server is unable to process the request |
|
|
233
|
+
| 423 | Locked | LockedError | The source or destination resource of a method is locked |
|
|
234
|
+
| 424 | Failed Dependency | FailedDependencyError | The requested action depended on another action |
|
|
235
|
+
| 426 | Upgrade Required | UpgradeRequiredError | This service requires use of a different protocol |
|
|
236
|
+
| 428 | Precondition Required | PreconditionRequiredError | This request is required to be conditional |
|
|
237
|
+
| 429 | Too Many Requests | TooManyRequestsError | The user has sent too many requests in a given amount of time |
|
|
238
|
+
| 431 | Request Header Fields Too Large | RequestHeaderFieldsTooLargeError | Request header fields too large |
|
|
239
|
+
| 451 | Unavailable For Legal Reasons | UnavailableForLegalReasonsError | Denied access due to a consequence of a legal demand |
|
|
240
|
+
|
|
241
|
+
## Server Errors
|
|
242
|
+
|
|
243
|
+
| Code | Description | Class Name | Default Message |
|
|
244
|
+
| ---- | ------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------- |
|
|
245
|
+
| 500 | Internal Server Error | InternalServerError | The server encountered an unexpected condition |
|
|
246
|
+
| 501 | Not Implemented | NotImplementedError | The server does not support the functionality required to fulfill the request |
|
|
247
|
+
| 502 | Bad Gateway | BadGatewayError | The server received an invalid response from an upstream server |
|
|
248
|
+
| 503 | Service Unavailable | ServiceUnavailableError | The server is temporarily unable to handle the request |
|
|
249
|
+
| 504 | Gateway Timeout | GatewayTimeoutError | The server did not receive a timely response from an upstream server |
|
|
250
|
+
| 505 | HTTP Version Not Supported | HttpVersionNotSupportedError | The server does not support the HTTP protocol version used in the request |
|
|
251
|
+
| 506 | Variant Also Negotiates | VariantAlsoNegotiatesError | The server has an internal configuration error |
|
|
252
|
+
| 507 | Insufficient Storage | InsufficientStorageError | The server is unable to store the representation needed to complete the request |
|
|
253
|
+
| 508 | Loop Detected | LoopDetectedError | The server detected an infinite loop while processing the request |
|
|
254
|
+
| 510 | Not Extended | NotExtendedError | Further extensions to the request are required for the server to fulfill it |
|
|
255
|
+
| 511 | Network Authentication Required | NetworkAuthenticationRequiredError | The client needs to authenticate to gain network access |
|
package/index.d.mts
ADDED
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
type HttpErrorMetadataValue = string | number | boolean | bigint | null | undefined;
|
|
2
|
+
type HttpErrorOptions = ErrorOptions & {
|
|
3
|
+
status?: string;
|
|
4
|
+
reason?: string;
|
|
5
|
+
domain?: string;
|
|
6
|
+
metadata?: Record<string, HttpErrorMetadataValue>;
|
|
7
|
+
details?: unknown[];
|
|
8
|
+
errors?: unknown;
|
|
9
|
+
};
|
|
10
|
+
type HttpErrorShape = {
|
|
11
|
+
statusCode: number;
|
|
12
|
+
status?: string;
|
|
13
|
+
message: string;
|
|
14
|
+
reason?: string;
|
|
15
|
+
domain?: string;
|
|
16
|
+
metadata?: Record<string, string>;
|
|
17
|
+
details?: unknown[];
|
|
18
|
+
errors?: unknown;
|
|
19
|
+
};
|
|
20
|
+
type Aip193ErrorInfoDetail = {
|
|
21
|
+
type: 'error_info';
|
|
22
|
+
reason: string;
|
|
23
|
+
domain: string;
|
|
24
|
+
metadata?: Record<string, string>;
|
|
25
|
+
};
|
|
26
|
+
type Aip193ErrorPayload = {
|
|
27
|
+
error: {
|
|
28
|
+
code: number;
|
|
29
|
+
status: string;
|
|
30
|
+
message: string;
|
|
31
|
+
details?: unknown[];
|
|
32
|
+
};
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
declare const canonicalStatusByHttpStatus: {
|
|
36
|
+
readonly 400: "INVALID_ARGUMENT";
|
|
37
|
+
readonly 401: "UNAUTHENTICATED";
|
|
38
|
+
readonly 403: "PERMISSION_DENIED";
|
|
39
|
+
readonly 404: "NOT_FOUND";
|
|
40
|
+
readonly 409: "ABORTED";
|
|
41
|
+
readonly 412: "FAILED_PRECONDITION";
|
|
42
|
+
readonly 429: "RESOURCE_EXHAUSTED";
|
|
43
|
+
readonly 500: "INTERNAL";
|
|
44
|
+
readonly 501: "UNIMPLEMENTED";
|
|
45
|
+
readonly 503: "UNAVAILABLE";
|
|
46
|
+
readonly 504: "DEADLINE_EXCEEDED";
|
|
47
|
+
};
|
|
48
|
+
declare const getCanonicalStatus: (statusCode: number) => string;
|
|
49
|
+
|
|
50
|
+
declare const createAip193ErrorInfoDetail: (reason: string, domain: string, metadata?: Record<string, string>) => Aip193ErrorInfoDetail;
|
|
51
|
+
declare const toAip193ErrorPayload: (error: HttpErrorShape, fallbackDomain?: string) => Aip193ErrorPayload;
|
|
52
|
+
|
|
53
|
+
declare class HttpError extends Error {
|
|
54
|
+
readonly statusCode: number;
|
|
55
|
+
readonly status: string;
|
|
56
|
+
readonly date: Date;
|
|
57
|
+
readonly reason?: string;
|
|
58
|
+
readonly domain?: string;
|
|
59
|
+
readonly metadata?: Record<string, string>;
|
|
60
|
+
readonly details?: unknown[];
|
|
61
|
+
readonly errors?: unknown;
|
|
62
|
+
constructor(statusCode?: number, message?: string, options?: HttpErrorOptions);
|
|
63
|
+
}
|
|
64
|
+
declare class ClientError extends HttpError {
|
|
65
|
+
constructor(statusCode?: number, message?: string, options?: HttpErrorOptions);
|
|
66
|
+
}
|
|
67
|
+
declare class ServerError extends HttpError {
|
|
68
|
+
constructor(statusCode?: number, message?: string, options?: HttpErrorOptions);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
declare class BadRequestError extends ClientError {
|
|
72
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
73
|
+
}
|
|
74
|
+
declare class UnauthorizedError extends ClientError {
|
|
75
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
76
|
+
}
|
|
77
|
+
declare class ForbiddenError extends ClientError {
|
|
78
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
79
|
+
}
|
|
80
|
+
declare class NotFoundError extends ClientError {
|
|
81
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
82
|
+
}
|
|
83
|
+
declare class MethodNotAllowedError extends ClientError {
|
|
84
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
85
|
+
}
|
|
86
|
+
declare class NotAcceptableError extends ClientError {
|
|
87
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
88
|
+
}
|
|
89
|
+
declare class ProxyAuthRequiredError extends ClientError {
|
|
90
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
91
|
+
}
|
|
92
|
+
declare class RequestTimeoutError extends ClientError {
|
|
93
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
94
|
+
}
|
|
95
|
+
declare class ConflictError extends ClientError {
|
|
96
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
97
|
+
}
|
|
98
|
+
declare class GoneError extends ClientError {
|
|
99
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
100
|
+
}
|
|
101
|
+
declare class LengthRequiredError extends ClientError {
|
|
102
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
103
|
+
}
|
|
104
|
+
declare class PreconditionFailedError extends ClientError {
|
|
105
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
106
|
+
}
|
|
107
|
+
declare class PayloadTooLargeError extends ClientError {
|
|
108
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
109
|
+
}
|
|
110
|
+
declare class UriTooLongError extends ClientError {
|
|
111
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
112
|
+
}
|
|
113
|
+
declare class UnsupportedMediaTypeError extends ClientError {
|
|
114
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
115
|
+
}
|
|
116
|
+
declare class RequestedRangeNotSatisfiableError extends ClientError {
|
|
117
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
118
|
+
}
|
|
119
|
+
declare class ExpectationFailedError extends ClientError {
|
|
120
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
121
|
+
}
|
|
122
|
+
declare class TeapotError extends ClientError {
|
|
123
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
124
|
+
}
|
|
125
|
+
declare class MisdirectedRequestError extends ClientError {
|
|
126
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
127
|
+
}
|
|
128
|
+
declare class UnprocessableEntityError extends ClientError {
|
|
129
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
130
|
+
}
|
|
131
|
+
declare class LockedError extends ClientError {
|
|
132
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
133
|
+
}
|
|
134
|
+
declare class FailedDependencyError extends ClientError {
|
|
135
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
136
|
+
}
|
|
137
|
+
declare class UpgradeRequiredError extends ClientError {
|
|
138
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
139
|
+
}
|
|
140
|
+
declare class PreconditionRequiredError extends ClientError {
|
|
141
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
142
|
+
}
|
|
143
|
+
declare class TooManyRequestsError extends ClientError {
|
|
144
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
145
|
+
}
|
|
146
|
+
declare class RequestHeaderFieldsTooLargeError extends ClientError {
|
|
147
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
148
|
+
}
|
|
149
|
+
declare class UnavailableForLegalReasonsError extends ClientError {
|
|
150
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
declare class InternalServerError extends ServerError {
|
|
154
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
155
|
+
}
|
|
156
|
+
declare class NotImplementedError extends ServerError {
|
|
157
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
158
|
+
}
|
|
159
|
+
declare class BadGatewayError extends ServerError {
|
|
160
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
161
|
+
}
|
|
162
|
+
declare class ServiceUnavailableError extends ServerError {
|
|
163
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
164
|
+
}
|
|
165
|
+
declare class GatewayTimeoutError extends ServerError {
|
|
166
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
167
|
+
}
|
|
168
|
+
declare class HttpVersionNotSupportedError extends ServerError {
|
|
169
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
170
|
+
}
|
|
171
|
+
declare class VariantAlsoNegotiatesError extends ServerError {
|
|
172
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
173
|
+
}
|
|
174
|
+
declare class InsufficientStorageError extends ServerError {
|
|
175
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
176
|
+
}
|
|
177
|
+
declare class LoopDetectedError extends ServerError {
|
|
178
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
179
|
+
}
|
|
180
|
+
declare class NotExtendedError extends ServerError {
|
|
181
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
182
|
+
}
|
|
183
|
+
declare class NetworkAuthenticationRequiredError extends ServerError {
|
|
184
|
+
constructor(message?: string, options?: HttpErrorOptions);
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
export { type Aip193ErrorInfoDetail, type Aip193ErrorPayload, BadGatewayError, BadRequestError, ClientError, ConflictError, ExpectationFailedError, FailedDependencyError, ForbiddenError, GatewayTimeoutError, GoneError, HttpError, type HttpErrorMetadataValue, type HttpErrorOptions, type HttpErrorShape, HttpVersionNotSupportedError, InsufficientStorageError, InternalServerError, LengthRequiredError, LockedError, LoopDetectedError, MethodNotAllowedError, MisdirectedRequestError, NetworkAuthenticationRequiredError, NotAcceptableError, NotExtendedError, NotFoundError, NotImplementedError, PayloadTooLargeError, PreconditionFailedError, PreconditionRequiredError, ProxyAuthRequiredError, RequestHeaderFieldsTooLargeError, RequestTimeoutError, RequestedRangeNotSatisfiableError, ServerError, ServiceUnavailableError, TeapotError, TooManyRequestsError, UnauthorizedError, UnavailableForLegalReasonsError, UnprocessableEntityError, UnsupportedMediaTypeError, UpgradeRequiredError, UriTooLongError, VariantAlsoNegotiatesError, canonicalStatusByHttpStatus, createAip193ErrorInfoDetail, getCanonicalStatus, toAip193ErrorPayload };
|