@zero-server/errors 0.9.0 → 0.9.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 +21 -21
- package/README.md +2 -2
- package/index.js +36 -36
- package/lib/debug.js +372 -0
- package/lib/errors.js +683 -0
- package/package.json +10 -4
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2026 Tony Wiedman
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Tony Wiedman
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> HttpError + 25+ typed framework and ORM errors.
|
|
4
4
|
|
|
5
|
-
Every typed error class shipped by the SDK: HTTP status errors, framework errors (configuration / middleware / routing / timeout), ORM errors (database / connection / migration / transaction / query / adapter / cache), and the Phase 4 errors (tenancy / audit / plugin / procedure). Plus the `createError` factory and `
|
|
5
|
+
Every typed error class shipped by the SDK: HTTP status errors, framework errors (configuration / middleware / routing / timeout), ORM errors (database / connection / migration / transaction / query / adapter / cache), and the Phase 4 errors (tenancy / audit / plugin / procedure). Plus the `createError` factory, `isHttpError` guard, and the lightweight `debug` logger.
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
@@ -30,7 +30,7 @@ This package narrows `@zero-server/sdk` to **34** exports. See the [scope page](
|
|
|
30
30
|
|
|
31
31
|
- [Scope page](https://github.com/tonywied17/zero-server/blob/main/docs/scopes/errors.md)
|
|
32
32
|
- [Full API reference](https://github.com/tonywied17/zero-server/blob/main/API.md)
|
|
33
|
-
- [Live docs](https://z-server.
|
|
33
|
+
- [Live docs](https://z-server.dev)
|
|
34
34
|
|
|
35
35
|
## License
|
|
36
36
|
|
package/index.js
CHANGED
|
@@ -1,40 +1,40 @@
|
|
|
1
1
|
// AUTO-GENERATED by .tools/generate-package-stubs.js — edit .tools/scope-manifest.js and re-run `npm run packages:generate`.
|
|
2
2
|
'use strict';
|
|
3
|
-
const
|
|
4
|
-
|
|
3
|
+
const errors = require('./lib/errors');
|
|
4
|
+
const debug = require('./lib/debug');
|
|
5
5
|
module.exports = {
|
|
6
|
-
HttpError:
|
|
7
|
-
BadRequestError:
|
|
8
|
-
UnauthorizedError:
|
|
9
|
-
ForbiddenError:
|
|
10
|
-
NotFoundError:
|
|
11
|
-
MethodNotAllowedError:
|
|
12
|
-
ConflictError:
|
|
13
|
-
GoneError:
|
|
14
|
-
PayloadTooLargeError:
|
|
15
|
-
UnprocessableEntityError:
|
|
16
|
-
ValidationError:
|
|
17
|
-
TooManyRequestsError:
|
|
18
|
-
InternalError:
|
|
19
|
-
NotImplementedError:
|
|
20
|
-
BadGatewayError:
|
|
21
|
-
ServiceUnavailableError:
|
|
22
|
-
DatabaseError:
|
|
23
|
-
ConfigurationError:
|
|
24
|
-
MiddlewareError:
|
|
25
|
-
RoutingError:
|
|
26
|
-
TimeoutError:
|
|
27
|
-
ConnectionError:
|
|
28
|
-
MigrationError:
|
|
29
|
-
TransactionError:
|
|
30
|
-
QueryError:
|
|
31
|
-
AdapterError:
|
|
32
|
-
CacheError:
|
|
33
|
-
TenancyError:
|
|
34
|
-
AuditError:
|
|
35
|
-
PluginError:
|
|
36
|
-
ProcedureError:
|
|
37
|
-
createError:
|
|
38
|
-
isHttpError:
|
|
39
|
-
debug
|
|
6
|
+
HttpError: errors.HttpError,
|
|
7
|
+
BadRequestError: errors.BadRequestError,
|
|
8
|
+
UnauthorizedError: errors.UnauthorizedError,
|
|
9
|
+
ForbiddenError: errors.ForbiddenError,
|
|
10
|
+
NotFoundError: errors.NotFoundError,
|
|
11
|
+
MethodNotAllowedError: errors.MethodNotAllowedError,
|
|
12
|
+
ConflictError: errors.ConflictError,
|
|
13
|
+
GoneError: errors.GoneError,
|
|
14
|
+
PayloadTooLargeError: errors.PayloadTooLargeError,
|
|
15
|
+
UnprocessableEntityError: errors.UnprocessableEntityError,
|
|
16
|
+
ValidationError: errors.ValidationError,
|
|
17
|
+
TooManyRequestsError: errors.TooManyRequestsError,
|
|
18
|
+
InternalError: errors.InternalError,
|
|
19
|
+
NotImplementedError: errors.NotImplementedError,
|
|
20
|
+
BadGatewayError: errors.BadGatewayError,
|
|
21
|
+
ServiceUnavailableError: errors.ServiceUnavailableError,
|
|
22
|
+
DatabaseError: errors.DatabaseError,
|
|
23
|
+
ConfigurationError: errors.ConfigurationError,
|
|
24
|
+
MiddlewareError: errors.MiddlewareError,
|
|
25
|
+
RoutingError: errors.RoutingError,
|
|
26
|
+
TimeoutError: errors.TimeoutError,
|
|
27
|
+
ConnectionError: errors.ConnectionError,
|
|
28
|
+
MigrationError: errors.MigrationError,
|
|
29
|
+
TransactionError: errors.TransactionError,
|
|
30
|
+
QueryError: errors.QueryError,
|
|
31
|
+
AdapterError: errors.AdapterError,
|
|
32
|
+
CacheError: errors.CacheError,
|
|
33
|
+
TenancyError: errors.TenancyError,
|
|
34
|
+
AuditError: errors.AuditError,
|
|
35
|
+
PluginError: errors.PluginError,
|
|
36
|
+
ProcedureError: errors.ProcedureError,
|
|
37
|
+
createError: errors.createError,
|
|
38
|
+
isHttpError: errors.isHttpError,
|
|
39
|
+
debug,
|
|
40
40
|
};
|
package/lib/debug.js
ADDED
|
@@ -0,0 +1,372 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @module debug
|
|
3
|
+
* @description Lightweight namespaced debug logger with levels, colors, and timestamps.
|
|
4
|
+
* Enable via DEBUG env variable: DEBUG=app:*,router (supports glob patterns).
|
|
5
|
+
* Each namespace gets a unique color for easy visual scanning.
|
|
6
|
+
*
|
|
7
|
+
* Levels: trace (0), debug (1), info (2), warn (3), error (4), fatal (5), silent (6).
|
|
8
|
+
* Set level via DEBUG_LEVEL env var or programmatically.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* const debug = require('@zero-server/sdk').debug;
|
|
12
|
+
* const log = debug('app:routes');
|
|
13
|
+
*
|
|
14
|
+
* log.info('server started on port %d', 3000);
|
|
15
|
+
* log.warn('deprecation notice');
|
|
16
|
+
* log.error('failed to connect', err);
|
|
17
|
+
* log('shorthand for debug level');
|
|
18
|
+
*
|
|
19
|
+
* // Set minimum level — anything below is silenced
|
|
20
|
+
* debug.level('warn'); // only warn, error, fatal
|
|
21
|
+
* debug.level('silent'); // suppress all output
|
|
22
|
+
* debug.level('trace'); // show everything
|
|
23
|
+
* debug.level(0); // same as 'trace'
|
|
24
|
+
*/
|
|
25
|
+
|
|
26
|
+
const LEVELS = { trace: 0, debug: 1, info: 2, warn: 3, error: 4, fatal: 5, silent: 6 };
|
|
27
|
+
const LEVEL_NAMES = ['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'];
|
|
28
|
+
const LEVEL_COLORS = ['\x1b[2m', '\x1b[36m', '\x1b[32m', '\x1b[33m', '\x1b[31m', '\x1b[35;1m'];
|
|
29
|
+
|
|
30
|
+
// Namespace colors (rotate through these)
|
|
31
|
+
const NS_COLORS = [
|
|
32
|
+
'\x1b[36m', '\x1b[33m', '\x1b[32m', '\x1b[35m', '\x1b[34m',
|
|
33
|
+
'\x1b[36;1m', '\x1b[33;1m', '\x1b[32;1m', '\x1b[35;1m', '\x1b[34;1m',
|
|
34
|
+
];
|
|
35
|
+
|
|
36
|
+
const RESET = '\x1b[0m';
|
|
37
|
+
const DIM = '\x1b[2m';
|
|
38
|
+
|
|
39
|
+
let _colorIdx = 0;
|
|
40
|
+
const _nsColorMap = new Map();
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Global state
|
|
44
|
+
*/
|
|
45
|
+
let _globalLevel = LEVELS[process.env.DEBUG_LEVEL] !== undefined
|
|
46
|
+
? LEVELS[process.env.DEBUG_LEVEL]
|
|
47
|
+
: LEVELS.debug;
|
|
48
|
+
|
|
49
|
+
let _enabledPatterns = null;
|
|
50
|
+
let _output = process.stdout;
|
|
51
|
+
let _outputCustom = false;
|
|
52
|
+
let _useColors = process.stdout.isTTY || false;
|
|
53
|
+
let _timestamps = true;
|
|
54
|
+
let _jsonMode = false;
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Parse DEBUG env var into patterns.
|
|
58
|
+
* @private
|
|
59
|
+
*/
|
|
60
|
+
function _parsePatterns()
|
|
61
|
+
{
|
|
62
|
+
const raw = process.env.DEBUG;
|
|
63
|
+
if (!raw) return null;
|
|
64
|
+
return raw.split(/[\s,]+/).filter(Boolean).map(p =>
|
|
65
|
+
{
|
|
66
|
+
const neg = p.startsWith('-');
|
|
67
|
+
const pat = neg ? p.slice(1) : p;
|
|
68
|
+
// Convert glob to regex: * => .*, ? => .
|
|
69
|
+
const re = new RegExp('^' + pat.replace(/[.+^${}()|[\]\\]/g, '\\$&').replace(/\*/g, '.*').replace(/\?/g, '.') + '$');
|
|
70
|
+
return { neg, re };
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
_enabledPatterns = _parsePatterns();
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Check if a namespace is enabled.
|
|
78
|
+
* @private
|
|
79
|
+
* @param {string} ns - Debug namespace.
|
|
80
|
+
* @returns {boolean} True if the namespace matches the DEBUG patterns.
|
|
81
|
+
*/
|
|
82
|
+
function _isEnabled(ns)
|
|
83
|
+
{
|
|
84
|
+
if (!_enabledPatterns) return true; // No DEBUG set — enable all
|
|
85
|
+
let enabled = false;
|
|
86
|
+
for (const { neg, re } of _enabledPatterns)
|
|
87
|
+
{
|
|
88
|
+
if (re.test(ns)) enabled = !neg;
|
|
89
|
+
}
|
|
90
|
+
return enabled;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* Get a color for a namespace.
|
|
95
|
+
* @private
|
|
96
|
+
*/
|
|
97
|
+
function _nsColor(ns)
|
|
98
|
+
{
|
|
99
|
+
if (!_nsColorMap.has(ns))
|
|
100
|
+
{
|
|
101
|
+
_nsColorMap.set(ns, NS_COLORS[_colorIdx % NS_COLORS.length]);
|
|
102
|
+
_colorIdx++;
|
|
103
|
+
}
|
|
104
|
+
return _nsColorMap.get(ns);
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* Format a timestamp.
|
|
109
|
+
* @private
|
|
110
|
+
*/
|
|
111
|
+
function _ts()
|
|
112
|
+
{
|
|
113
|
+
const d = new Date();
|
|
114
|
+
const pad = (n) => String(n).padStart(2, '0');
|
|
115
|
+
return `${pad(d.getHours())}:${pad(d.getMinutes())}:${pad(d.getSeconds())}.${String(d.getMilliseconds()).padStart(3, '0')}`;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Format arguments (like console.log — supports %s, %d, %j, %o).
|
|
120
|
+
* @private
|
|
121
|
+
*/
|
|
122
|
+
function _format(args)
|
|
123
|
+
{
|
|
124
|
+
if (args.length === 0) return '';
|
|
125
|
+
if (typeof args[0] === 'string' && args.length > 1)
|
|
126
|
+
{
|
|
127
|
+
let i = 1;
|
|
128
|
+
const str = args[0].replace(/%([sdjo%])/g, (_, f) =>
|
|
129
|
+
{
|
|
130
|
+
if (f === '%') return '%';
|
|
131
|
+
if (i >= args.length) return `%${f}`;
|
|
132
|
+
const v = args[i++];
|
|
133
|
+
if (f === 's') return String(v);
|
|
134
|
+
if (f === 'd') return Number(v);
|
|
135
|
+
if (f === 'j' || f === 'o')
|
|
136
|
+
{
|
|
137
|
+
try { return JSON.stringify(v); }
|
|
138
|
+
catch { return String(v); }
|
|
139
|
+
}
|
|
140
|
+
return String(v);
|
|
141
|
+
});
|
|
142
|
+
const rest = args.slice(i).map(a =>
|
|
143
|
+
typeof a === 'object' ? JSON.stringify(a) : String(a)
|
|
144
|
+
);
|
|
145
|
+
return rest.length > 0 ? str + ' ' + rest.join(' ') : str;
|
|
146
|
+
}
|
|
147
|
+
return args.map(a =>
|
|
148
|
+
{
|
|
149
|
+
if (a instanceof Error) return a.stack || a.message;
|
|
150
|
+
if (typeof a === 'object')
|
|
151
|
+
{
|
|
152
|
+
try { return JSON.stringify(a); }
|
|
153
|
+
catch { return String(a); }
|
|
154
|
+
}
|
|
155
|
+
return String(a);
|
|
156
|
+
}).join(' ');
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* Write a log entry.
|
|
161
|
+
* @private
|
|
162
|
+
*/
|
|
163
|
+
function _write(ns, level, args)
|
|
164
|
+
{
|
|
165
|
+
const msg = _format(args);
|
|
166
|
+
const out = (_outputCustom || level < LEVELS.warn) ? _output : process.stderr;
|
|
167
|
+
|
|
168
|
+
if (_jsonMode)
|
|
169
|
+
{
|
|
170
|
+
const entry = {
|
|
171
|
+
timestamp: new Date().toISOString(),
|
|
172
|
+
level: LEVEL_NAMES[level],
|
|
173
|
+
namespace: ns,
|
|
174
|
+
message: msg,
|
|
175
|
+
};
|
|
176
|
+
// If last arg is an Error, attach stack
|
|
177
|
+
const last = args[args.length - 1];
|
|
178
|
+
if (last instanceof Error)
|
|
179
|
+
{
|
|
180
|
+
entry.error = { message: last.message, stack: last.stack, code: last.code };
|
|
181
|
+
}
|
|
182
|
+
out.write(JSON.stringify(entry) + '\n');
|
|
183
|
+
return;
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
// Pretty text output
|
|
187
|
+
const parts = [];
|
|
188
|
+
if (_timestamps)
|
|
189
|
+
{
|
|
190
|
+
parts.push(_useColors ? `${DIM}${_ts()}${RESET}` : _ts());
|
|
191
|
+
}
|
|
192
|
+
// Level
|
|
193
|
+
const lvlName = LEVEL_NAMES[level];
|
|
194
|
+
if (_useColors)
|
|
195
|
+
{
|
|
196
|
+
parts.push(`${LEVEL_COLORS[level]}${lvlName.padEnd(5)}${RESET}`);
|
|
197
|
+
}
|
|
198
|
+
else
|
|
199
|
+
{
|
|
200
|
+
parts.push(lvlName.padEnd(5));
|
|
201
|
+
}
|
|
202
|
+
// Namespace
|
|
203
|
+
if (_useColors)
|
|
204
|
+
{
|
|
205
|
+
parts.push(`${_nsColor(ns)}${ns}${RESET}`);
|
|
206
|
+
}
|
|
207
|
+
else
|
|
208
|
+
{
|
|
209
|
+
parts.push(ns);
|
|
210
|
+
}
|
|
211
|
+
parts.push(msg);
|
|
212
|
+
|
|
213
|
+
out.write(parts.join(' ') + '\n');
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
/**
|
|
217
|
+
* Create a namespaced debug logger.
|
|
218
|
+
*
|
|
219
|
+
* @param {string} namespace - Logger namespace (e.g. 'app:routes', 'db:queries').
|
|
220
|
+
* @returns {Function & { trace, debug, info, warn, error, fatal, enabled }} Logger function.
|
|
221
|
+
*/
|
|
222
|
+
function debug(namespace)
|
|
223
|
+
{
|
|
224
|
+
const enabled = _isEnabled(namespace);
|
|
225
|
+
|
|
226
|
+
// Default call = debug level
|
|
227
|
+
const logger = (...args) =>
|
|
228
|
+
{
|
|
229
|
+
if (!enabled || _globalLevel > LEVELS.debug) return;
|
|
230
|
+
_write(namespace, LEVELS.debug, args);
|
|
231
|
+
};
|
|
232
|
+
|
|
233
|
+
logger.trace = (...args) =>
|
|
234
|
+
{
|
|
235
|
+
if (!enabled || _globalLevel > LEVELS.trace) return;
|
|
236
|
+
_write(namespace, LEVELS.trace, args);
|
|
237
|
+
};
|
|
238
|
+
|
|
239
|
+
logger.debug = logger;
|
|
240
|
+
|
|
241
|
+
logger.info = (...args) =>
|
|
242
|
+
{
|
|
243
|
+
if (!enabled || _globalLevel > LEVELS.info) return;
|
|
244
|
+
_write(namespace, LEVELS.info, args);
|
|
245
|
+
};
|
|
246
|
+
|
|
247
|
+
logger.warn = (...args) =>
|
|
248
|
+
{
|
|
249
|
+
if (!enabled || _globalLevel > LEVELS.warn) return;
|
|
250
|
+
_write(namespace, LEVELS.warn, args);
|
|
251
|
+
};
|
|
252
|
+
|
|
253
|
+
logger.error = (...args) =>
|
|
254
|
+
{
|
|
255
|
+
if (!enabled || _globalLevel > LEVELS.error) return;
|
|
256
|
+
_write(namespace, LEVELS.error, args);
|
|
257
|
+
};
|
|
258
|
+
|
|
259
|
+
logger.fatal = (...args) =>
|
|
260
|
+
{
|
|
261
|
+
if (!enabled || _globalLevel > LEVELS.fatal) return;
|
|
262
|
+
_write(namespace, LEVELS.fatal, args);
|
|
263
|
+
};
|
|
264
|
+
|
|
265
|
+
/** Whether this namespace is active. */
|
|
266
|
+
logger.enabled = enabled;
|
|
267
|
+
|
|
268
|
+
/** The namespace string */
|
|
269
|
+
logger.namespace = namespace;
|
|
270
|
+
|
|
271
|
+
return logger;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
// --- Configuration API -------------------------------------------
|
|
275
|
+
|
|
276
|
+
/**
|
|
277
|
+
* Set the minimum log level globally.
|
|
278
|
+
* Messages below this level are silenced.
|
|
279
|
+
*
|
|
280
|
+
* @param {string|number} level - Level name or number.
|
|
281
|
+
* `'trace'` (0) — all output
|
|
282
|
+
* `'debug'` (1) — debug and above
|
|
283
|
+
* `'info'` (2) — info and above
|
|
284
|
+
* `'warn'` (3) — warn and above
|
|
285
|
+
* `'error'` (4) — error and fatal only
|
|
286
|
+
* `'fatal'` (5) — fatal only
|
|
287
|
+
* `'silent'` (6) — nothing
|
|
288
|
+
*/
|
|
289
|
+
debug.level = function(level)
|
|
290
|
+
{
|
|
291
|
+
if (typeof level === 'string') _globalLevel = LEVELS[level.toLowerCase()] ?? LEVELS.debug;
|
|
292
|
+
else _globalLevel = level;
|
|
293
|
+
};
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* Enable/disable namespaces programmatically (same syntax as DEBUG env var).
|
|
297
|
+
* @param {string} patterns - Comma-separated patterns. Use '-ns' to exclude.
|
|
298
|
+
*/
|
|
299
|
+
debug.enable = function(patterns)
|
|
300
|
+
{
|
|
301
|
+
process.env.DEBUG = patterns;
|
|
302
|
+
_enabledPatterns = _parsePatterns();
|
|
303
|
+
};
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* Disable all debug output.
|
|
307
|
+
*/
|
|
308
|
+
debug.disable = function()
|
|
309
|
+
{
|
|
310
|
+
process.env.DEBUG = '';
|
|
311
|
+
_enabledPatterns = [{ neg: false, re: /^$/ }]; // match nothing
|
|
312
|
+
};
|
|
313
|
+
|
|
314
|
+
/**
|
|
315
|
+
* Enable structured JSON output.
|
|
316
|
+
* @param {boolean} [on=true] - Enable flag.
|
|
317
|
+
*/
|
|
318
|
+
debug.json = function(on = true)
|
|
319
|
+
{
|
|
320
|
+
_jsonMode = on;
|
|
321
|
+
};
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* Enable/disable timestamps.
|
|
325
|
+
* @param {boolean} [on=true] - Enable flag.
|
|
326
|
+
*/
|
|
327
|
+
debug.timestamps = function(on = true)
|
|
328
|
+
{
|
|
329
|
+
_timestamps = on;
|
|
330
|
+
};
|
|
331
|
+
|
|
332
|
+
/**
|
|
333
|
+
* Enable/disable colors.
|
|
334
|
+
* @param {boolean} [on=true] - Enable flag.
|
|
335
|
+
*/
|
|
336
|
+
debug.colors = function(on = true)
|
|
337
|
+
{
|
|
338
|
+
_useColors = on;
|
|
339
|
+
};
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* Set custom output stream.
|
|
343
|
+
* @param {object} stream - Writable stream with write() method.
|
|
344
|
+
*/
|
|
345
|
+
debug.output = function(stream)
|
|
346
|
+
{
|
|
347
|
+
_output = stream;
|
|
348
|
+
_outputCustom = true;
|
|
349
|
+
};
|
|
350
|
+
|
|
351
|
+
/**
|
|
352
|
+
* Reset all settings to defaults.
|
|
353
|
+
*/
|
|
354
|
+
debug.reset = function()
|
|
355
|
+
{
|
|
356
|
+
_globalLevel = LEVELS[process.env.DEBUG_LEVEL] !== undefined
|
|
357
|
+
? LEVELS[process.env.DEBUG_LEVEL]
|
|
358
|
+
: LEVELS.debug;
|
|
359
|
+
_enabledPatterns = _parsePatterns();
|
|
360
|
+
_output = process.stdout;
|
|
361
|
+
_outputCustom = false;
|
|
362
|
+
_useColors = process.stdout.isTTY || false;
|
|
363
|
+
_timestamps = true;
|
|
364
|
+
_jsonMode = false;
|
|
365
|
+
_colorIdx = 0;
|
|
366
|
+
_nsColorMap.clear();
|
|
367
|
+
};
|
|
368
|
+
|
|
369
|
+
/** Expose level constants. */
|
|
370
|
+
debug.LEVELS = LEVELS;
|
|
371
|
+
|
|
372
|
+
module.exports = debug;
|
package/lib/errors.js
ADDED
|
@@ -0,0 +1,683 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @module errors
|
|
3
|
+
* @description HTTP error classes with status codes, error codes, and structured details.
|
|
4
|
+
* Every error extends HttpError which carries a statusCode, code, and optional details.
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* const { NotFoundError, ValidationError, createError } = require('@zero-server/sdk');
|
|
8
|
+
*
|
|
9
|
+
* // Throw a named error class
|
|
10
|
+
* throw new NotFoundError('User not found');
|
|
11
|
+
*
|
|
12
|
+
* // Attach a machine-readable code + details
|
|
13
|
+
* throw new NotFoundError('Invoice missing', {
|
|
14
|
+
* code: 'INVOICE_NOT_FOUND',
|
|
15
|
+
* details: { invoiceId: 'INV-42' },
|
|
16
|
+
* });
|
|
17
|
+
*
|
|
18
|
+
* // Field-level validation errors
|
|
19
|
+
* throw new ValidationError('Invalid input', {
|
|
20
|
+
* email: 'required',
|
|
21
|
+
* age: 'must be >= 18',
|
|
22
|
+
* });
|
|
23
|
+
*
|
|
24
|
+
* // Factory — create by status code
|
|
25
|
+
* throw createError(503, 'Try again later');
|
|
26
|
+
*/
|
|
27
|
+
|
|
28
|
+
// --- Status Text Map ---------------------------------------------
|
|
29
|
+
|
|
30
|
+
const STATUS_TEXT = {
|
|
31
|
+
400: 'Bad Request',
|
|
32
|
+
401: 'Unauthorized',
|
|
33
|
+
402: 'Payment Required',
|
|
34
|
+
403: 'Forbidden',
|
|
35
|
+
404: 'Not Found',
|
|
36
|
+
405: 'Method Not Allowed',
|
|
37
|
+
406: 'Not Acceptable',
|
|
38
|
+
408: 'Request Timeout',
|
|
39
|
+
409: 'Conflict',
|
|
40
|
+
410: 'Gone',
|
|
41
|
+
413: 'Payload Too Large',
|
|
42
|
+
415: 'Unsupported Media Type',
|
|
43
|
+
418: "I'm a Teapot",
|
|
44
|
+
422: 'Unprocessable Entity',
|
|
45
|
+
429: 'Too Many Requests',
|
|
46
|
+
500: 'Internal Server Error',
|
|
47
|
+
501: 'Not Implemented',
|
|
48
|
+
502: 'Bad Gateway',
|
|
49
|
+
503: 'Service Unavailable',
|
|
50
|
+
504: 'Gateway Timeout',
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
// --- Base HttpError ----------------------------------------------
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Base HTTP error class. All framework error classes extend this.
|
|
57
|
+
*/
|
|
58
|
+
class HttpError extends Error
|
|
59
|
+
{
|
|
60
|
+
/**
|
|
61
|
+
* @constructor
|
|
62
|
+
* @param {number} statusCode - HTTP status code.
|
|
63
|
+
* @param {string} [message] - Human-readable message.
|
|
64
|
+
* @param {object} [opts] - Additional error options.
|
|
65
|
+
* @param {string} [opts.code] - Machine-readable error code (e.g. 'VALIDATION_FAILED').
|
|
66
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
67
|
+
*/
|
|
68
|
+
constructor(statusCode, message, opts = {})
|
|
69
|
+
{
|
|
70
|
+
super(message || STATUS_TEXT[statusCode] || 'Error');
|
|
71
|
+
this.name = this.constructor.name;
|
|
72
|
+
this.statusCode = statusCode;
|
|
73
|
+
this.code = opts.code || this._defaultCode();
|
|
74
|
+
if (opts.details !== undefined) this.details = opts.details;
|
|
75
|
+
Error.captureStackTrace(this, this.constructor);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/** @private */
|
|
79
|
+
_defaultCode()
|
|
80
|
+
{
|
|
81
|
+
return (STATUS_TEXT[this.statusCode] || 'ERROR')
|
|
82
|
+
.toUpperCase()
|
|
83
|
+
.replace(/[^A-Z0-9]+/g, '_')
|
|
84
|
+
.replace(/(^_|_$)/g, '');
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Serialize for JSON responses.
|
|
89
|
+
* @returns {{ error: string, code: string, statusCode: number, details?: * }}
|
|
90
|
+
*/
|
|
91
|
+
toJSON()
|
|
92
|
+
{
|
|
93
|
+
const obj = { error: this.message, code: this.code, statusCode: this.statusCode };
|
|
94
|
+
if (this.details !== undefined) obj.details = this.details;
|
|
95
|
+
return obj;
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
// --- Specific Error Classes --------------------------------------
|
|
100
|
+
|
|
101
|
+
class BadRequestError extends HttpError
|
|
102
|
+
{
|
|
103
|
+
/**
|
|
104
|
+
* @constructor
|
|
105
|
+
* @param {string} [message] - Human-readable message.
|
|
106
|
+
* @param {object} [opts] - Additional error options.
|
|
107
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
108
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
109
|
+
*/
|
|
110
|
+
constructor(message, opts) { super(400, message, opts); }
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
class UnauthorizedError extends HttpError
|
|
114
|
+
{
|
|
115
|
+
/**
|
|
116
|
+
* @constructor
|
|
117
|
+
* @param {string} [message] - Human-readable message.
|
|
118
|
+
* @param {object} [opts] - Additional error options.
|
|
119
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
120
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
121
|
+
*/
|
|
122
|
+
constructor(message, opts) { super(401, message, opts); }
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
class ForbiddenError extends HttpError
|
|
126
|
+
{
|
|
127
|
+
/**
|
|
128
|
+
* @constructor
|
|
129
|
+
* @param {string} [message] - Human-readable message.
|
|
130
|
+
* @param {object} [opts] - Additional error options.
|
|
131
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
132
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
133
|
+
*/
|
|
134
|
+
constructor(message, opts) { super(403, message, opts); }
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
class NotFoundError extends HttpError
|
|
138
|
+
{
|
|
139
|
+
/**
|
|
140
|
+
* @constructor
|
|
141
|
+
* @param {string} [message] - Human-readable message.
|
|
142
|
+
* @param {object} [opts] - Additional error options.
|
|
143
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
144
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
145
|
+
*/
|
|
146
|
+
constructor(message, opts) { super(404, message, opts); }
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
class MethodNotAllowedError extends HttpError
|
|
150
|
+
{
|
|
151
|
+
/**
|
|
152
|
+
* @constructor
|
|
153
|
+
* @param {string} [message] - Human-readable message.
|
|
154
|
+
* @param {object} [opts] - Additional error options.
|
|
155
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
156
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
157
|
+
*/
|
|
158
|
+
constructor(message, opts) { super(405, message, opts); }
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
class ConflictError extends HttpError
|
|
162
|
+
{
|
|
163
|
+
/**
|
|
164
|
+
* @constructor
|
|
165
|
+
* @param {string} [message] - Human-readable message.
|
|
166
|
+
* @param {object} [opts] - Additional error options.
|
|
167
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
168
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
169
|
+
*/
|
|
170
|
+
constructor(message, opts) { super(409, message, opts); }
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
class GoneError extends HttpError
|
|
174
|
+
{
|
|
175
|
+
/**
|
|
176
|
+
* @constructor
|
|
177
|
+
* @param {string} [message] - Human-readable message.
|
|
178
|
+
* @param {object} [opts] - Additional error options.
|
|
179
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
180
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
181
|
+
*/
|
|
182
|
+
constructor(message, opts) { super(410, message, opts); }
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
class PayloadTooLargeError extends HttpError
|
|
186
|
+
{
|
|
187
|
+
/**
|
|
188
|
+
* @constructor
|
|
189
|
+
* @param {string} [message] - Human-readable message.
|
|
190
|
+
* @param {object} [opts] - Additional error options.
|
|
191
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
192
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
193
|
+
*/
|
|
194
|
+
constructor(message, opts) { super(413, message, opts); }
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
class UnprocessableEntityError extends HttpError
|
|
198
|
+
{
|
|
199
|
+
/**
|
|
200
|
+
* @constructor
|
|
201
|
+
* @param {string} [message] - Human-readable message.
|
|
202
|
+
* @param {object} [opts] - Additional error options.
|
|
203
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
204
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
205
|
+
*/
|
|
206
|
+
constructor(message, opts) { super(422, message, opts); }
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* Validation error with field-level details.
|
|
211
|
+
*/
|
|
212
|
+
class ValidationError extends HttpError
|
|
213
|
+
{
|
|
214
|
+
/**
|
|
215
|
+
* @constructor
|
|
216
|
+
* @param {string} [message] - Summary message.
|
|
217
|
+
* @param {object|Array} [errors] - Field errors, e.g. { email: 'required', age: 'must be >= 18' }.
|
|
218
|
+
* @param {object} [opts] - Additional error options.
|
|
219
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
220
|
+
*/
|
|
221
|
+
constructor(message, errors, opts = {})
|
|
222
|
+
{
|
|
223
|
+
super(422, message || 'Validation Failed', { code: 'VALIDATION_FAILED', ...opts, details: errors });
|
|
224
|
+
this.errors = errors || {};
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
class TooManyRequestsError extends HttpError
|
|
229
|
+
{
|
|
230
|
+
/**
|
|
231
|
+
* @constructor
|
|
232
|
+
* @param {string} [message] - Human-readable message.
|
|
233
|
+
* @param {object} [opts] - Additional error options.
|
|
234
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
235
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
236
|
+
*/
|
|
237
|
+
constructor(message, opts) { super(429, message, opts); }
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
class InternalError extends HttpError
|
|
241
|
+
{
|
|
242
|
+
/**
|
|
243
|
+
* @constructor
|
|
244
|
+
* @param {string} [message] - Human-readable message.
|
|
245
|
+
* @param {object} [opts] - Additional error options.
|
|
246
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
247
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
248
|
+
*/
|
|
249
|
+
constructor(message, opts) { super(500, message, opts); }
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
class NotImplementedError extends HttpError
|
|
253
|
+
{
|
|
254
|
+
/**
|
|
255
|
+
* @constructor
|
|
256
|
+
* @param {string} [message] - Human-readable message.
|
|
257
|
+
* @param {object} [opts] - Additional error options.
|
|
258
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
259
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
260
|
+
*/
|
|
261
|
+
constructor(message, opts) { super(501, message, opts); }
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
class BadGatewayError extends HttpError
|
|
265
|
+
{
|
|
266
|
+
/**
|
|
267
|
+
* @constructor
|
|
268
|
+
* @param {string} [message] - Human-readable message.
|
|
269
|
+
* @param {object} [opts] - Additional error options.
|
|
270
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
271
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
272
|
+
*/
|
|
273
|
+
constructor(message, opts) { super(502, message, opts); }
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
class ServiceUnavailableError extends HttpError
|
|
277
|
+
{
|
|
278
|
+
/**
|
|
279
|
+
* @constructor
|
|
280
|
+
* @param {string} [message] - Human-readable message.
|
|
281
|
+
* @param {object} [opts] - Additional error options.
|
|
282
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
283
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
284
|
+
*/
|
|
285
|
+
constructor(message, opts) { super(503, message, opts); }
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
// --- Framework Error Classes -------------------------------------
|
|
289
|
+
|
|
290
|
+
/**
|
|
291
|
+
* Database / ORM error — wraps adapter-level failures.
|
|
292
|
+
*/
|
|
293
|
+
class DatabaseError extends HttpError
|
|
294
|
+
{
|
|
295
|
+
/**
|
|
296
|
+
* @constructor
|
|
297
|
+
* @param {string} [message] - Description of the DB failure.
|
|
298
|
+
* @param {object} [opts] - Additional error options.
|
|
299
|
+
* @param {string} [opts.query] - The query or operation that failed.
|
|
300
|
+
* @param {string} [opts.adapter] - Adapter name (sqlite, mysql, etc.).
|
|
301
|
+
*/
|
|
302
|
+
constructor(message, opts = {})
|
|
303
|
+
{
|
|
304
|
+
super(500, message || 'Database Error', { code: 'DATABASE_ERROR', ...opts });
|
|
305
|
+
if (opts.query) this.query = opts.query;
|
|
306
|
+
if (opts.adapter) this.adapter = opts.adapter;
|
|
307
|
+
}
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Configuration error — thrown when app/adapter configuration is invalid.
|
|
312
|
+
*/
|
|
313
|
+
class ConfigurationError extends HttpError
|
|
314
|
+
{
|
|
315
|
+
/**
|
|
316
|
+
* @constructor
|
|
317
|
+
* @param {string} [message] - What misconfiguration was detected.
|
|
318
|
+
* @param {object} [opts] - Additional error options.
|
|
319
|
+
* @param {string} [opts.setting] - The setting key that's invalid.
|
|
320
|
+
*/
|
|
321
|
+
constructor(message, opts = {})
|
|
322
|
+
{
|
|
323
|
+
super(500, message || 'Configuration Error', { code: 'CONFIGURATION_ERROR', ...opts });
|
|
324
|
+
if (opts.setting) this.setting = opts.setting;
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
/**
|
|
329
|
+
* Middleware error — a middleware function failed unexpectedly.
|
|
330
|
+
*/
|
|
331
|
+
class MiddlewareError extends HttpError
|
|
332
|
+
{
|
|
333
|
+
/**
|
|
334
|
+
* @constructor
|
|
335
|
+
* @param {string} [message] - Description.
|
|
336
|
+
* @param {object} [opts] - Additional error options.
|
|
337
|
+
* @param {string} [opts.middleware] - Middleware name.
|
|
338
|
+
*/
|
|
339
|
+
constructor(message, opts = {})
|
|
340
|
+
{
|
|
341
|
+
super(500, message || 'Middleware Error', { code: 'MIDDLEWARE_ERROR', ...opts });
|
|
342
|
+
if (opts.middleware) this.middleware = opts.middleware;
|
|
343
|
+
}
|
|
344
|
+
}
|
|
345
|
+
|
|
346
|
+
/**
|
|
347
|
+
* Routing error — thrown when route resolution fails.
|
|
348
|
+
*/
|
|
349
|
+
class RoutingError extends HttpError
|
|
350
|
+
{
|
|
351
|
+
/**
|
|
352
|
+
* @constructor
|
|
353
|
+
* @param {string} [message] - Description.
|
|
354
|
+
* @param {object} [opts] - Additional error options.
|
|
355
|
+
* @param {string} [opts.path] - The route path.
|
|
356
|
+
* @param {string} [opts.method] - The HTTP method.
|
|
357
|
+
*/
|
|
358
|
+
constructor(message, opts = {})
|
|
359
|
+
{
|
|
360
|
+
super(500, message || 'Routing Error', { code: 'ROUTING_ERROR', ...opts });
|
|
361
|
+
if (opts.path) this.path = opts.path;
|
|
362
|
+
if (opts.method) this.method = opts.method;
|
|
363
|
+
}
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
/**
|
|
367
|
+
* Timeout error — operation exceeded allowed time.
|
|
368
|
+
*/
|
|
369
|
+
class TimeoutError extends HttpError
|
|
370
|
+
{
|
|
371
|
+
/**
|
|
372
|
+
* @constructor
|
|
373
|
+
* @param {string} [message] - Description.
|
|
374
|
+
* @param {object} [opts] - Additional error options.
|
|
375
|
+
* @param {number} [opts.timeout] - The timeout limit in ms.
|
|
376
|
+
*/
|
|
377
|
+
constructor(message, opts = {})
|
|
378
|
+
{
|
|
379
|
+
super(408, message || 'Request Timeout', { code: 'TIMEOUT', ...opts });
|
|
380
|
+
if (opts.timeout) this.timeout = opts.timeout;
|
|
381
|
+
}
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
// --- ORM-Specific Error Classes ----------------------------------
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
* Connection error — database connection failures with retry context.
|
|
388
|
+
*/
|
|
389
|
+
class ConnectionError extends DatabaseError
|
|
390
|
+
{
|
|
391
|
+
/**
|
|
392
|
+
* @constructor
|
|
393
|
+
* @param {string} [message] - Description.
|
|
394
|
+
* @param {object} [opts] - Additional error options.
|
|
395
|
+
* @param {string} [opts.adapter] - Adapter name.
|
|
396
|
+
* @param {number} [opts.attempt] - Retry attempt number.
|
|
397
|
+
* @param {number} [opts.maxRetries] - Maximum retries configured.
|
|
398
|
+
* @param {string} [opts.host] - Target host.
|
|
399
|
+
* @param {number} [opts.port] - Target port.
|
|
400
|
+
*/
|
|
401
|
+
constructor(message, opts = {})
|
|
402
|
+
{
|
|
403
|
+
super(message || 'Connection Failed', { code: 'CONNECTION_ERROR', ...opts });
|
|
404
|
+
if (opts.attempt !== undefined) this.attempt = opts.attempt;
|
|
405
|
+
if (opts.maxRetries !== undefined) this.maxRetries = opts.maxRetries;
|
|
406
|
+
if (opts.host) this.host = opts.host;
|
|
407
|
+
if (opts.port) this.port = opts.port;
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
* Migration error — migration execution failures.
|
|
413
|
+
*/
|
|
414
|
+
class MigrationError extends DatabaseError
|
|
415
|
+
{
|
|
416
|
+
/**
|
|
417
|
+
* @constructor
|
|
418
|
+
* @param {string} [message] - Description.
|
|
419
|
+
* @param {object} [opts] - Additional error options.
|
|
420
|
+
* @param {string} [opts.migration] - Migration name that failed.
|
|
421
|
+
* @param {string} [opts.direction] - 'up' or 'down'.
|
|
422
|
+
* @param {number} [opts.batch] - Batch number.
|
|
423
|
+
*/
|
|
424
|
+
constructor(message, opts = {})
|
|
425
|
+
{
|
|
426
|
+
super(message || 'Migration Failed', { code: 'MIGRATION_ERROR', ...opts });
|
|
427
|
+
if (opts.migration) this.migration = opts.migration;
|
|
428
|
+
if (opts.direction) this.direction = opts.direction;
|
|
429
|
+
if (opts.batch !== undefined) this.batch = opts.batch;
|
|
430
|
+
}
|
|
431
|
+
}
|
|
432
|
+
|
|
433
|
+
/**
|
|
434
|
+
* Transaction error — transaction commit/rollback failures.
|
|
435
|
+
*/
|
|
436
|
+
class TransactionError extends DatabaseError
|
|
437
|
+
{
|
|
438
|
+
/**
|
|
439
|
+
* @constructor
|
|
440
|
+
* @param {string} [message] - Description.
|
|
441
|
+
* @param {object} [opts] - Additional error options.
|
|
442
|
+
* @param {string} [opts.phase] - 'begin', 'commit', or 'rollback'.
|
|
443
|
+
*/
|
|
444
|
+
constructor(message, opts = {})
|
|
445
|
+
{
|
|
446
|
+
super(message || 'Transaction Failed', { code: 'TRANSACTION_ERROR', ...opts });
|
|
447
|
+
if (opts.phase) this.phase = opts.phase;
|
|
448
|
+
}
|
|
449
|
+
}
|
|
450
|
+
|
|
451
|
+
/**
|
|
452
|
+
* Query error — query execution failures with SQL context.
|
|
453
|
+
*/
|
|
454
|
+
class QueryError extends DatabaseError
|
|
455
|
+
{
|
|
456
|
+
/**
|
|
457
|
+
* @constructor
|
|
458
|
+
* @param {string} [message] - Description.
|
|
459
|
+
* @param {object} [opts] - Additional error options.
|
|
460
|
+
* @param {string} [opts.sql] - The SQL that failed (if applicable).
|
|
461
|
+
* @param {Array} [opts.params] - Query parameters.
|
|
462
|
+
* @param {string} [opts.table] - Target table.
|
|
463
|
+
*/
|
|
464
|
+
constructor(message, opts = {})
|
|
465
|
+
{
|
|
466
|
+
super(message || 'Query Failed', { code: 'QUERY_ERROR', ...opts });
|
|
467
|
+
if (opts.sql) this.sql = opts.sql;
|
|
468
|
+
if (opts.params) this.params = opts.params;
|
|
469
|
+
if (opts.table) this.table = opts.table;
|
|
470
|
+
}
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
/**
|
|
474
|
+
* Adapter error — adapter-level issues (driver not found, unsupported operation).
|
|
475
|
+
*/
|
|
476
|
+
class AdapterError extends DatabaseError
|
|
477
|
+
{
|
|
478
|
+
/**
|
|
479
|
+
* @constructor
|
|
480
|
+
* @param {string} [message] - Description.
|
|
481
|
+
* @param {object} [opts] - Additional error options.
|
|
482
|
+
* @param {string} [opts.adapter] - Adapter name.
|
|
483
|
+
* @param {string} [opts.operation] - The operation that failed.
|
|
484
|
+
*/
|
|
485
|
+
constructor(message, opts = {})
|
|
486
|
+
{
|
|
487
|
+
super(message || 'Adapter Error', { code: 'ADAPTER_ERROR', ...opts });
|
|
488
|
+
if (opts.operation) this.operation = opts.operation;
|
|
489
|
+
}
|
|
490
|
+
}
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* Cache error — caching layer failures.
|
|
494
|
+
*/
|
|
495
|
+
class CacheError extends HttpError
|
|
496
|
+
{
|
|
497
|
+
/**
|
|
498
|
+
* @constructor
|
|
499
|
+
* @param {string} [message] - Description.
|
|
500
|
+
* @param {object} [opts] - Additional error options.
|
|
501
|
+
* @param {string} [opts.operation] - Cache operation that failed.
|
|
502
|
+
* @param {string} [opts.key] - Cache key involved.
|
|
503
|
+
*/
|
|
504
|
+
constructor(message, opts = {})
|
|
505
|
+
{
|
|
506
|
+
super(500, message || 'Cache Error', { code: 'CACHE_ERROR', ...opts });
|
|
507
|
+
if (opts.operation) this.operation = opts.operation;
|
|
508
|
+
if (opts.key) this.key = opts.key;
|
|
509
|
+
}
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
// --- Phase 4 Error Classes ---------------------------------------
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* Tenancy error — multi-tenancy operation failures.
|
|
516
|
+
*/
|
|
517
|
+
class TenancyError extends DatabaseError
|
|
518
|
+
{
|
|
519
|
+
/**
|
|
520
|
+
* @constructor
|
|
521
|
+
* @param {string} [message] - Description.
|
|
522
|
+
* @param {object} [opts] - Additional error options.
|
|
523
|
+
* @param {string} [opts.tenant] - Tenant identifier.
|
|
524
|
+
* @param {string} [opts.strategy] - Tenancy strategy (row, schema).
|
|
525
|
+
*/
|
|
526
|
+
constructor(message, opts = {})
|
|
527
|
+
{
|
|
528
|
+
super(message || 'Tenancy Error', { code: 'TENANCY_ERROR', ...opts });
|
|
529
|
+
if (opts.tenant) this.tenant = opts.tenant;
|
|
530
|
+
if (opts.strategy) this.strategy = opts.strategy;
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
/**
|
|
535
|
+
* Audit error — audit logging failures.
|
|
536
|
+
*/
|
|
537
|
+
class AuditError extends DatabaseError
|
|
538
|
+
{
|
|
539
|
+
/**
|
|
540
|
+
* @constructor
|
|
541
|
+
* @param {string} [message] - Description.
|
|
542
|
+
* @param {object} [opts] - Additional error options.
|
|
543
|
+
* @param {string} [opts.action] - Audit action that failed.
|
|
544
|
+
* @param {string} [opts.table] - Target table.
|
|
545
|
+
*/
|
|
546
|
+
constructor(message, opts = {})
|
|
547
|
+
{
|
|
548
|
+
super(message || 'Audit Error', { code: 'AUDIT_ERROR', ...opts });
|
|
549
|
+
if (opts.action) this.action = opts.action;
|
|
550
|
+
if (opts.table) this.table = opts.table;
|
|
551
|
+
}
|
|
552
|
+
}
|
|
553
|
+
|
|
554
|
+
/**
|
|
555
|
+
* Plugin error — plugin registration or lifecycle failures.
|
|
556
|
+
*/
|
|
557
|
+
class PluginError extends HttpError
|
|
558
|
+
{
|
|
559
|
+
/**
|
|
560
|
+
* @constructor
|
|
561
|
+
* @param {string} [message] - Description.
|
|
562
|
+
* @param {object} [opts] - Additional error options.
|
|
563
|
+
* @param {string} [opts.plugin] - Plugin name.
|
|
564
|
+
* @param {string} [opts.phase] - Lifecycle phase (install, boot, uninstall).
|
|
565
|
+
*/
|
|
566
|
+
constructor(message, opts = {})
|
|
567
|
+
{
|
|
568
|
+
super(500, message || 'Plugin Error', { code: 'PLUGIN_ERROR', ...opts });
|
|
569
|
+
if (opts.plugin) this.plugin = opts.plugin;
|
|
570
|
+
if (opts.phase) this.phase = opts.phase;
|
|
571
|
+
}
|
|
572
|
+
}
|
|
573
|
+
|
|
574
|
+
/**
|
|
575
|
+
* Procedure error — stored procedure/function failures.
|
|
576
|
+
*/
|
|
577
|
+
class ProcedureError extends DatabaseError
|
|
578
|
+
{
|
|
579
|
+
/**
|
|
580
|
+
* @constructor
|
|
581
|
+
* @param {string} [message] - Description.
|
|
582
|
+
* @param {object} [opts] - Additional error options.
|
|
583
|
+
* @param {string} [opts.procedure] - Procedure or function name.
|
|
584
|
+
* @param {string} [opts.operation] - Operation (create, drop, execute).
|
|
585
|
+
*/
|
|
586
|
+
constructor(message, opts = {})
|
|
587
|
+
{
|
|
588
|
+
super(message || 'Procedure Error', { code: 'PROCEDURE_ERROR', ...opts });
|
|
589
|
+
if (opts.procedure) this.procedure = opts.procedure;
|
|
590
|
+
if (opts.operation) this.operation = opts.operation;
|
|
591
|
+
}
|
|
592
|
+
}
|
|
593
|
+
|
|
594
|
+
// --- Factory -----------------------------------------------------
|
|
595
|
+
|
|
596
|
+
/**
|
|
597
|
+
* Create an HttpError by status code.
|
|
598
|
+
*
|
|
599
|
+
* @param {number} statusCode - HTTP status code.
|
|
600
|
+
* @param {string} [message] - Human-readable error message.
|
|
601
|
+
* @param {object} [opts] - Additional error options.
|
|
602
|
+
* @param {string} [opts.code] - Machine-readable error code.
|
|
603
|
+
* @param {*} [opts.details] - Extra data (field errors, debug info, etc.).
|
|
604
|
+
* @returns {HttpError} Matching HttpError subclass instance.
|
|
605
|
+
*
|
|
606
|
+
* @example
|
|
607
|
+
* throw createError(404, 'User not found');
|
|
608
|
+
* throw createError(422, 'Invalid input', { details: { email: 'required' } });
|
|
609
|
+
*/
|
|
610
|
+
function createError(statusCode, message, opts)
|
|
611
|
+
{
|
|
612
|
+
const map = {
|
|
613
|
+
400: BadRequestError,
|
|
614
|
+
401: UnauthorizedError,
|
|
615
|
+
403: ForbiddenError,
|
|
616
|
+
404: NotFoundError,
|
|
617
|
+
405: MethodNotAllowedError,
|
|
618
|
+
408: TimeoutError,
|
|
619
|
+
409: ConflictError,
|
|
620
|
+
410: GoneError,
|
|
621
|
+
413: PayloadTooLargeError,
|
|
622
|
+
422: UnprocessableEntityError,
|
|
623
|
+
429: TooManyRequestsError,
|
|
624
|
+
500: InternalError,
|
|
625
|
+
501: NotImplementedError,
|
|
626
|
+
502: BadGatewayError,
|
|
627
|
+
503: ServiceUnavailableError,
|
|
628
|
+
};
|
|
629
|
+
|
|
630
|
+
const Cls = map[statusCode];
|
|
631
|
+
if (Cls) return new Cls(message, opts);
|
|
632
|
+
return new HttpError(statusCode, message, opts);
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
/**
|
|
636
|
+
* Check if a value is an HttpError (or duck-typed equivalent).
|
|
637
|
+
* @param {*} err - Error object.
|
|
638
|
+
* @returns {boolean} True if the value is an HttpError.
|
|
639
|
+
*/
|
|
640
|
+
function isHttpError(err)
|
|
641
|
+
{
|
|
642
|
+
if (!err || !(err instanceof Error)) return false;
|
|
643
|
+
return err instanceof HttpError || typeof err.statusCode === 'number';
|
|
644
|
+
}
|
|
645
|
+
|
|
646
|
+
module.exports = {
|
|
647
|
+
HttpError,
|
|
648
|
+
BadRequestError,
|
|
649
|
+
UnauthorizedError,
|
|
650
|
+
ForbiddenError,
|
|
651
|
+
NotFoundError,
|
|
652
|
+
MethodNotAllowedError,
|
|
653
|
+
ConflictError,
|
|
654
|
+
GoneError,
|
|
655
|
+
PayloadTooLargeError,
|
|
656
|
+
UnprocessableEntityError,
|
|
657
|
+
ValidationError,
|
|
658
|
+
TooManyRequestsError,
|
|
659
|
+
InternalError,
|
|
660
|
+
NotImplementedError,
|
|
661
|
+
BadGatewayError,
|
|
662
|
+
ServiceUnavailableError,
|
|
663
|
+
// Framework-specific errors
|
|
664
|
+
DatabaseError,
|
|
665
|
+
ConfigurationError,
|
|
666
|
+
MiddlewareError,
|
|
667
|
+
RoutingError,
|
|
668
|
+
TimeoutError,
|
|
669
|
+
// ORM-specific errors
|
|
670
|
+
ConnectionError,
|
|
671
|
+
MigrationError,
|
|
672
|
+
TransactionError,
|
|
673
|
+
QueryError,
|
|
674
|
+
AdapterError,
|
|
675
|
+
CacheError,
|
|
676
|
+
// Phase 4 errors
|
|
677
|
+
TenancyError,
|
|
678
|
+
AuditError,
|
|
679
|
+
PluginError,
|
|
680
|
+
ProcedureError,
|
|
681
|
+
createError,
|
|
682
|
+
isHttpError,
|
|
683
|
+
};
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zero-server/errors",
|
|
3
|
-
"version": "0.9.
|
|
3
|
+
"version": "0.9.2",
|
|
4
4
|
"description": "HttpError + 25+ typed framework and ORM errors.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"zero-server",
|
|
7
|
-
"zero-
|
|
7
|
+
"zero-server",
|
|
8
8
|
"errors"
|
|
9
9
|
],
|
|
10
10
|
"author": "Anthony Wiedman",
|
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
"./package.json": "./package.json"
|
|
21
21
|
},
|
|
22
22
|
"files": [
|
|
23
|
+
"lib",
|
|
23
24
|
"index.js",
|
|
24
25
|
"index.d.ts",
|
|
25
26
|
"README.md",
|
|
@@ -42,7 +43,12 @@
|
|
|
42
43
|
"access": "public"
|
|
43
44
|
},
|
|
44
45
|
"sideEffects": false,
|
|
45
|
-
"
|
|
46
|
-
"@zero-server/sdk": "0.9.
|
|
46
|
+
"peerDependencies": {
|
|
47
|
+
"@zero-server/sdk": ">=0.9.2"
|
|
48
|
+
},
|
|
49
|
+
"peerDependenciesMeta": {
|
|
50
|
+
"@zero-server/sdk": {
|
|
51
|
+
"optional": true
|
|
52
|
+
}
|
|
47
53
|
}
|
|
48
54
|
}
|