@naman_deep_singh/errors-utils 1.3.3 → 1.4.0
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/README.md +37 -48
- package/dist/cjs/constants/errorCodes.d.ts +28 -23
- package/dist/cjs/constants/errorCodes.js +57 -22
- package/dist/cjs/constants/errorMessages.d.ts +8 -1
- package/dist/cjs/constants/errorMessages.js +72 -29
- package/dist/cjs/error/AppError.d.ts +2 -2
- package/dist/cjs/error/AppError.js +2 -2
- package/dist/cjs/error/ServiceUnavailable.d.ts +4 -0
- package/dist/cjs/error/ServiceUnavailable.js +11 -0
- package/dist/cjs/error/TokenExpiredError.d.ts +2 -2
- package/dist/cjs/error/TokenExpiredError.js +2 -2
- package/dist/cjs/error/TokenMalformedError.d.ts +2 -2
- package/dist/cjs/error/TokenMalformedError.js +2 -2
- package/dist/cjs/error/UnauthorizedError.d.ts +1 -2
- package/dist/cjs/error/UnauthorizedError.js +2 -2
- package/dist/cjs/errorRegistry/errorRegistry.d.ts +19 -0
- package/dist/cjs/errorRegistry/errorRegistry.js +63 -0
- package/dist/cjs/errorRegistry/index.d.ts +3 -0
- package/dist/cjs/errorRegistry/index.js +6 -0
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.js +1 -3
- package/dist/cjs/middleware/express/{errorHandler.js → errorHandler.middleware.js} +4 -4
- package/dist/cjs/middleware/express/index.d.ts +2 -2
- package/dist/cjs/middleware/express/index.js +2 -2
- package/dist/esm/constants/errorCodes.d.ts +28 -23
- package/dist/esm/constants/errorCodes.js +57 -22
- package/dist/esm/constants/errorMessages.d.ts +8 -1
- package/dist/esm/constants/errorMessages.js +72 -29
- package/dist/esm/error/AppError.d.ts +2 -2
- package/dist/esm/error/AppError.js +2 -2
- package/dist/esm/error/ServiceUnavailable.d.ts +4 -0
- package/dist/esm/error/ServiceUnavailable.js +7 -0
- package/dist/esm/error/TokenExpiredError.d.ts +2 -2
- package/dist/esm/error/TokenExpiredError.js +2 -2
- package/dist/esm/error/TokenMalformedError.d.ts +2 -2
- package/dist/esm/error/TokenMalformedError.js +2 -2
- package/dist/esm/error/UnauthorizedError.d.ts +1 -2
- package/dist/esm/error/UnauthorizedError.js +2 -2
- package/dist/esm/errorRegistry/errorRegistry.d.ts +19 -0
- package/dist/esm/errorRegistry/errorRegistry.js +59 -0
- package/dist/esm/errorRegistry/index.d.ts +3 -0
- package/dist/esm/errorRegistry/index.js +3 -0
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -3
- package/dist/esm/middleware/express/{errorHandler.js → errorHandler.middleware.js} +5 -5
- package/dist/esm/middleware/express/index.d.ts +2 -2
- package/dist/esm/middleware/express/index.js +2 -2
- package/dist/types/constants/errorCodes.d.ts +28 -23
- package/dist/types/constants/errorMessages.d.ts +8 -1
- package/dist/types/error/AppError.d.ts +2 -2
- package/dist/types/error/ServiceUnavailable.d.ts +4 -0
- package/dist/types/error/TokenExpiredError.d.ts +2 -2
- package/dist/types/error/TokenMalformedError.d.ts +2 -2
- package/dist/types/error/UnauthorizedError.d.ts +1 -2
- package/dist/types/errorRegistry/errorRegistry.d.ts +19 -0
- package/dist/types/errorRegistry/index.d.ts +3 -0
- package/dist/types/index.d.ts +1 -1
- package/dist/types/middleware/express/index.d.ts +2 -2
- package/package.json +1 -1
- package/dist/cjs/error/RateLimitError.d.ts +0 -4
- package/dist/cjs/error/RateLimitError.js +0 -11
- package/dist/cjs/utils/mapAppErrorToResponder.d.ts +0 -3
- package/dist/cjs/utils/mapAppErrorToResponder.js +0 -27
- package/dist/esm/error/RateLimitError.d.ts +0 -4
- package/dist/esm/error/RateLimitError.js +0 -7
- package/dist/esm/utils/mapAppErrorToResponder.d.ts +0 -3
- package/dist/esm/utils/mapAppErrorToResponder.js +0 -24
- package/dist/types/error/RateLimitError.d.ts +0 -4
- package/dist/types/utils/mapAppErrorToResponder.d.ts +0 -3
- /package/dist/cjs/middleware/express/{errorConverter.d.ts → errorConverter.middleware.d.ts} +0 -0
- /package/dist/cjs/middleware/express/{errorConverter.js → errorConverter.middleware.js} +0 -0
- /package/dist/cjs/middleware/express/{errorHandler.d.ts → errorHandler.middleware.d.ts} +0 -0
- /package/dist/esm/middleware/express/{errorConverter.d.ts → errorConverter.middleware.d.ts} +0 -0
- /package/dist/esm/middleware/express/{errorConverter.js → errorConverter.middleware.js} +0 -0
- /package/dist/esm/middleware/express/{errorHandler.d.ts → errorHandler.middleware.d.ts} +0 -0
- /package/dist/types/middleware/express/{errorConverter.d.ts → errorConverter.middleware.d.ts} +0 -0
- /package/dist/types/middleware/express/{errorHandler.d.ts → errorHandler.middleware.d.ts} +0 -0
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ErrorMessageRegistry = void 0;
|
|
4
|
+
const response_utils_1 = require("@naman_deep_singh/response-utils");
|
|
5
|
+
const constants_1 = require("src/constants");
|
|
6
|
+
class ErrorMessageRegistry {
|
|
7
|
+
constructor() {
|
|
8
|
+
this.registry = new Map();
|
|
9
|
+
// Initialize with default messages
|
|
10
|
+
Object.entries(constants_1.ERROR_MESSAGES).forEach(([code, message]) => {
|
|
11
|
+
this.registry.set(code, message);
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
/** Singleton accessor */
|
|
15
|
+
static getInstance() {
|
|
16
|
+
if (!ErrorMessageRegistry.instance) {
|
|
17
|
+
ErrorMessageRegistry.instance = new ErrorMessageRegistry();
|
|
18
|
+
}
|
|
19
|
+
return ErrorMessageRegistry.instance;
|
|
20
|
+
}
|
|
21
|
+
/** Register or override messages */
|
|
22
|
+
register(messages) {
|
|
23
|
+
for (const [code, message] of Object.entries(messages)) {
|
|
24
|
+
this.registry.set(code, message);
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
/** Resolve a message for a given error code */
|
|
28
|
+
resolve(code, defaultMessage = 'Unexpected error') {
|
|
29
|
+
return this.registry.get(code) ?? defaultMessage;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Map an AppError to an ExpressResponder
|
|
33
|
+
* Centralizes error-to-HTTP mapping
|
|
34
|
+
*/
|
|
35
|
+
mapAppErrorToResponder(responder, err) {
|
|
36
|
+
switch (err.statusCode) {
|
|
37
|
+
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.BAD_REQUEST:
|
|
38
|
+
return responder.badRequest(this.resolve(err.code), {
|
|
39
|
+
details: err.details,
|
|
40
|
+
});
|
|
41
|
+
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.UNAUTHORIZED:
|
|
42
|
+
return responder.unauthorized(this.resolve(err.code));
|
|
43
|
+
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.FORBIDDEN:
|
|
44
|
+
return responder.forbidden(this.resolve(err.code));
|
|
45
|
+
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.NOT_FOUND:
|
|
46
|
+
return responder.notFound(this.resolve(err.code));
|
|
47
|
+
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.CONFLICT:
|
|
48
|
+
return responder.conflict(this.resolve(err.code));
|
|
49
|
+
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.UNPROCESSABLE_ENTITY:
|
|
50
|
+
return responder.unprocessableEntity(this.resolve(err.code), {
|
|
51
|
+
details: err.details,
|
|
52
|
+
});
|
|
53
|
+
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.TOO_MANY_REQUESTS:
|
|
54
|
+
return responder.tooManyRequests(this.resolve(err.code));
|
|
55
|
+
default:
|
|
56
|
+
// Any other status maps to generic server error
|
|
57
|
+
return responder.serverError(this.resolve(err.code), {
|
|
58
|
+
details: err.details,
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
exports.ErrorMessageRegistry = ErrorMessageRegistry;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.errorMessageRegistry = void 0;
|
|
4
|
+
const errorRegistry_1 = require("./errorRegistry");
|
|
5
|
+
/** Singleton export for easy access */
|
|
6
|
+
exports.errorMessageRegistry = errorRegistry_1.ErrorMessageRegistry.getInstance();
|
package/dist/cjs/index.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * from './errorRegistry';
|
|
1
2
|
export * from './error/AppError';
|
|
2
3
|
export * from './error/HTTPError';
|
|
3
4
|
export * from './error/BadRequestError';
|
|
@@ -6,7 +7,6 @@ export * from './error/ForbiddenError';
|
|
|
6
7
|
export * from './error/NotFoundError';
|
|
7
8
|
export * from './error/ConflictError';
|
|
8
9
|
export * from './error/ValidationError';
|
|
9
|
-
export * from './error/RateLimitError';
|
|
10
10
|
export * from './error/TooManyRequestsError';
|
|
11
11
|
export * from './error/TokenExpiredError';
|
|
12
12
|
export * from './error/TokenMalformedError';
|
package/dist/cjs/index.js
CHANGED
|
@@ -14,8 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
|
|
18
|
-
// Base Errors
|
|
17
|
+
__exportStar(require("./errorRegistry"), exports);
|
|
19
18
|
// =========================
|
|
20
19
|
__exportStar(require("./error/AppError"), exports);
|
|
21
20
|
__exportStar(require("./error/HTTPError"), exports);
|
|
@@ -28,7 +27,6 @@ __exportStar(require("./error/ForbiddenError"), exports);
|
|
|
28
27
|
__exportStar(require("./error/NotFoundError"), exports);
|
|
29
28
|
__exportStar(require("./error/ConflictError"), exports);
|
|
30
29
|
__exportStar(require("./error/ValidationError"), exports);
|
|
31
|
-
__exportStar(require("./error/RateLimitError"), exports);
|
|
32
30
|
__exportStar(require("./error/TooManyRequestsError"), exports);
|
|
33
31
|
// =========================
|
|
34
32
|
// Auth / Token Errors
|
|
@@ -2,18 +2,18 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.expressErrorHandler = expressErrorHandler;
|
|
4
4
|
const response_utils_1 = require("@naman_deep_singh/response-utils");
|
|
5
|
+
const errorRegistry_1 = require("src/errorRegistry");
|
|
5
6
|
const constants_1 = require("../../constants");
|
|
6
7
|
const AppError_1 = require("../../error/AppError");
|
|
7
|
-
const mapAppErrorToResponder_1 = require("../../utils/mapAppErrorToResponder");
|
|
8
8
|
function expressErrorHandler(err, _req, res, _next) {
|
|
9
9
|
const responder = new response_utils_1.ExpressResponder({}, res);
|
|
10
10
|
// 1. Known operational error
|
|
11
11
|
if (err instanceof AppError_1.AppError) {
|
|
12
|
-
return
|
|
12
|
+
return errorRegistry_1.errorMessageRegistry.mapAppErrorToResponder(responder, err);
|
|
13
13
|
}
|
|
14
14
|
// 2. Log unexpected errors (never expose internals in prod)
|
|
15
15
|
console.error('UNEXPECTED ERROR:', err);
|
|
16
16
|
// 3. Normalize unknown error → AppError
|
|
17
|
-
const internalError = new AppError_1.AppError(constants_1.ERROR_CODES.INTERNAL_SERVER_ERROR,
|
|
18
|
-
return
|
|
17
|
+
const internalError = new AppError_1.AppError(constants_1.ERROR_CODES.INTERNAL_SERVER_ERROR, response_utils_1.HTTP_STATUS.SERVER_ERROR.INTERNAL_SERVER_ERROR, process.env.NODE_ENV === 'production' ? undefined : err, err instanceof Error ? err : undefined);
|
|
18
|
+
return errorRegistry_1.errorMessageRegistry.mapAppErrorToResponder(responder, internalError);
|
|
19
19
|
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './errorHandler';
|
|
2
|
-
export * from './errorConverter';
|
|
1
|
+
export * from './errorHandler.middleware';
|
|
2
|
+
export * from './errorConverter.middleware';
|
|
@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./errorHandler"), exports);
|
|
18
|
-
__exportStar(require("./errorConverter"), exports);
|
|
17
|
+
__exportStar(require("./errorHandler.middleware"), exports);
|
|
18
|
+
__exportStar(require("./errorConverter.middleware"), exports);
|
|
@@ -1,32 +1,37 @@
|
|
|
1
1
|
export declare const ERROR_CODES: {
|
|
2
2
|
readonly BAD_REQUEST: "BAD_REQUEST";
|
|
3
|
+
readonly VALIDATION_FAILED: "VALIDATION_FAILED";
|
|
3
4
|
readonly UNAUTHORIZED: "UNAUTHORIZED";
|
|
4
5
|
readonly FORBIDDEN: "FORBIDDEN";
|
|
5
6
|
readonly NOT_FOUND: "NOT_FOUND";
|
|
6
7
|
readonly CONFLICT: "CONFLICT";
|
|
7
|
-
readonly VALIDATION_FAILED: "VALIDATION_FAILED";
|
|
8
|
-
readonly RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED";
|
|
9
|
-
readonly INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR";
|
|
10
|
-
readonly CRYPTO_INTEGRITY_ERROR: "CRYPTO_INTEGRITY_ERROR";
|
|
11
8
|
readonly TOO_MANY_REQUESTS: "TOO_MANY_REQUESTS";
|
|
12
|
-
readonly
|
|
9
|
+
readonly INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR";
|
|
10
|
+
readonly SERVICE_UNAVAILABLE: "SERVICE_UNAVAILABLE";
|
|
11
|
+
readonly DEPENDENCY_FAILURE: "DEPENDENCY_FAILURE";
|
|
12
|
+
readonly HTTP_ERROR: "HTTP_ERROR";
|
|
13
|
+
readonly HTTP_TIMEOUT: "HTTP_TIMEOUT";
|
|
14
|
+
readonly UPSTREAM_SERVICE_ERROR: "UPSTREAM_SERVICE_ERROR";
|
|
15
|
+
readonly AUTH_FAILED: "AUTH_FAILED";
|
|
16
|
+
readonly TOKEN_MISSING: "TOKEN_MISSING";
|
|
13
17
|
readonly TOKEN_INVALID: "TOKEN_INVALID";
|
|
14
|
-
readonly
|
|
15
|
-
readonly
|
|
16
|
-
readonly
|
|
17
|
-
readonly
|
|
18
|
-
readonly
|
|
19
|
-
readonly
|
|
20
|
-
readonly
|
|
21
|
-
readonly
|
|
22
|
-
readonly
|
|
23
|
-
readonly
|
|
24
|
-
readonly
|
|
25
|
-
readonly
|
|
26
|
-
readonly
|
|
27
|
-
readonly
|
|
28
|
-
readonly
|
|
29
|
-
readonly
|
|
30
|
-
readonly
|
|
18
|
+
readonly TOKEN_EXPIRED: "TOKEN_EXPIRED";
|
|
19
|
+
readonly CRYPTO_ERROR: "CRYPTO_ERROR";
|
|
20
|
+
readonly CRYPTO_INTEGRITY_ERROR: "CRYPTO_INTEGRITY_ERROR";
|
|
21
|
+
readonly CACHE_ERROR: "CACHE_ERROR";
|
|
22
|
+
readonly CACHE_CONNECTION_FAILED: "CACHE_CONNECTION_FAILED";
|
|
23
|
+
readonly DATABASE_ERROR: "DATABASE_ERROR";
|
|
24
|
+
readonly DATABASE_CONNECTION_FAILED: "DATABASE_CONNECTION_FAILED";
|
|
25
|
+
readonly DATABASE_CONSTRAINT_VIOLATION: "DATABASE_CONSTRAINT_VIOLATION";
|
|
26
|
+
readonly MESSAGE_BROKER_ERROR: "MESSAGE_BROKER_ERROR";
|
|
27
|
+
readonly MESSAGE_PUBLISH_FAILED: "MESSAGE_PUBLISH_FAILED";
|
|
28
|
+
readonly FILE_ERROR: "FILE_ERROR";
|
|
29
|
+
readonly FILE_NOT_FOUND: "FILE_NOT_FOUND";
|
|
30
|
+
readonly FILE_UPLOAD_FAILED: "FILE_UPLOAD_FAILED";
|
|
31
|
+
readonly FILE_TOO_LARGE: "FILE_TOO_LARGE";
|
|
32
|
+
readonly CONFIG_ERROR: "CONFIG_ERROR";
|
|
33
|
+
readonly CONFIG_MISSING: "CONFIG_MISSING";
|
|
34
|
+
readonly TIMEOUT_ERROR: "TIMEOUT_ERROR";
|
|
35
|
+
readonly RESOURCE_EXHAUSTED: "RESOURCE_EXHAUSTED";
|
|
31
36
|
};
|
|
32
|
-
export type ErrorCode = keyof typeof ERROR_CODES;
|
|
37
|
+
export type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
|
|
@@ -1,31 +1,66 @@
|
|
|
1
1
|
export const ERROR_CODES = {
|
|
2
|
+
/* ------------------------------------------------------------------ */
|
|
3
|
+
/* 🧱 Common / Generic */
|
|
4
|
+
/* ------------------------------------------------------------------ */
|
|
2
5
|
BAD_REQUEST: 'BAD_REQUEST',
|
|
6
|
+
VALIDATION_FAILED: 'VALIDATION_FAILED',
|
|
3
7
|
UNAUTHORIZED: 'UNAUTHORIZED',
|
|
4
8
|
FORBIDDEN: 'FORBIDDEN',
|
|
5
9
|
NOT_FOUND: 'NOT_FOUND',
|
|
6
10
|
CONFLICT: 'CONFLICT',
|
|
7
|
-
VALIDATION_FAILED: 'VALIDATION_FAILED',
|
|
8
|
-
RATE_LIMIT_EXCEEDED: 'RATE_LIMIT_EXCEEDED',
|
|
9
|
-
INTERNAL_SERVER_ERROR: 'INTERNAL_SERVER_ERROR',
|
|
10
|
-
CRYPTO_INTEGRITY_ERROR: 'CRYPTO_INTEGRITY_ERROR',
|
|
11
11
|
TOO_MANY_REQUESTS: 'TOO_MANY_REQUESTS',
|
|
12
|
-
|
|
12
|
+
INTERNAL_SERVER_ERROR: 'INTERNAL_SERVER_ERROR',
|
|
13
|
+
SERVICE_UNAVAILABLE: 'SERVICE_UNAVAILABLE',
|
|
14
|
+
DEPENDENCY_FAILURE: 'DEPENDENCY_FAILURE',
|
|
15
|
+
/* ------------------------------------------------------------------ */
|
|
16
|
+
/* 🌐 HTTP / Network */
|
|
17
|
+
/* ------------------------------------------------------------------ */
|
|
18
|
+
HTTP_ERROR: 'HTTP_ERROR',
|
|
19
|
+
HTTP_TIMEOUT: 'HTTP_TIMEOUT',
|
|
20
|
+
UPSTREAM_SERVICE_ERROR: 'UPSTREAM_SERVICE_ERROR',
|
|
21
|
+
/* ------------------------------------------------------------------ */
|
|
22
|
+
/* 🔐 Authentication / Authorization */
|
|
23
|
+
/* ------------------------------------------------------------------ */
|
|
24
|
+
AUTH_FAILED: 'AUTH_FAILED',
|
|
25
|
+
TOKEN_MISSING: 'TOKEN_MISSING',
|
|
13
26
|
TOKEN_INVALID: 'TOKEN_INVALID',
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
27
|
+
TOKEN_EXPIRED: 'TOKEN_EXPIRED',
|
|
28
|
+
/* ------------------------------------------------------------------ */
|
|
29
|
+
/* 🔑 Cryptography / Security */
|
|
30
|
+
/* ------------------------------------------------------------------ */
|
|
31
|
+
CRYPTO_ERROR: 'CRYPTO_ERROR',
|
|
32
|
+
CRYPTO_INTEGRITY_ERROR: 'CRYPTO_INTEGRITY_ERROR',
|
|
33
|
+
/* ------------------------------------------------------------------ */
|
|
34
|
+
/* 💾 Cache */
|
|
35
|
+
/* ------------------------------------------------------------------ */
|
|
36
|
+
CACHE_ERROR: 'CACHE_ERROR',
|
|
37
|
+
CACHE_CONNECTION_FAILED: 'CACHE_CONNECTION_FAILED',
|
|
38
|
+
/* ------------------------------------------------------------------ */
|
|
39
|
+
/* 🗄️ Database */
|
|
40
|
+
/* ------------------------------------------------------------------ */
|
|
41
|
+
DATABASE_ERROR: 'DATABASE_ERROR',
|
|
42
|
+
DATABASE_CONNECTION_FAILED: 'DATABASE_CONNECTION_FAILED',
|
|
43
|
+
DATABASE_CONSTRAINT_VIOLATION: 'DATABASE_CONSTRAINT_VIOLATION',
|
|
44
|
+
/* ------------------------------------------------------------------ */
|
|
45
|
+
/* 📩 Messaging / Queues */
|
|
46
|
+
/* ------------------------------------------------------------------ */
|
|
47
|
+
MESSAGE_BROKER_ERROR: 'MESSAGE_BROKER_ERROR',
|
|
48
|
+
MESSAGE_PUBLISH_FAILED: 'MESSAGE_PUBLISH_FAILED',
|
|
49
|
+
/* ------------------------------------------------------------------ */
|
|
50
|
+
/* 📁 File / Storage */
|
|
51
|
+
/* ------------------------------------------------------------------ */
|
|
52
|
+
FILE_ERROR: 'FILE_ERROR',
|
|
53
|
+
FILE_NOT_FOUND: 'FILE_NOT_FOUND',
|
|
54
|
+
FILE_UPLOAD_FAILED: 'FILE_UPLOAD_FAILED',
|
|
55
|
+
FILE_TOO_LARGE: 'FILE_TOO_LARGE',
|
|
56
|
+
/* ------------------------------------------------------------------ */
|
|
57
|
+
/* ⚙️ Configuration / Environment */
|
|
58
|
+
/* ------------------------------------------------------------------ */
|
|
59
|
+
CONFIG_ERROR: 'CONFIG_ERROR',
|
|
60
|
+
CONFIG_MISSING: 'CONFIG_MISSING',
|
|
61
|
+
/* ------------------------------------------------------------------ */
|
|
62
|
+
/* ⏱️ Timeouts / Resources */
|
|
63
|
+
/* ------------------------------------------------------------------ */
|
|
64
|
+
TIMEOUT_ERROR: 'TIMEOUT_ERROR',
|
|
65
|
+
RESOURCE_EXHAUSTED: 'RESOURCE_EXHAUSTED',
|
|
31
66
|
};
|
|
@@ -1,2 +1,9 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type ErrorCode } from './errorCodes';
|
|
2
|
+
/**
|
|
3
|
+
* Canonical error messages mapped to ERROR_CODES
|
|
4
|
+
* - Human-readable
|
|
5
|
+
* - Safe for API responses
|
|
6
|
+
* - Useful for logs
|
|
7
|
+
* - Can be overridden by services if needed
|
|
8
|
+
*/
|
|
2
9
|
export declare const ERROR_MESSAGES: Record<ErrorCode, string>;
|
|
@@ -1,31 +1,74 @@
|
|
|
1
|
+
import { ERROR_CODES } from './errorCodes';
|
|
2
|
+
/**
|
|
3
|
+
* Canonical error messages mapped to ERROR_CODES
|
|
4
|
+
* - Human-readable
|
|
5
|
+
* - Safe for API responses
|
|
6
|
+
* - Useful for logs
|
|
7
|
+
* - Can be overridden by services if needed
|
|
8
|
+
*/
|
|
1
9
|
export const ERROR_MESSAGES = {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
TOO_MANY_REQUESTS: 'Too many requests',
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
10
|
+
/* ------------------------------------------------------------------ */
|
|
11
|
+
/* 🧱 Common / Generic */
|
|
12
|
+
/* ------------------------------------------------------------------ */
|
|
13
|
+
[ERROR_CODES.BAD_REQUEST]: 'The request is invalid or malformed.',
|
|
14
|
+
[ERROR_CODES.VALIDATION_FAILED]: 'Request validation failed.',
|
|
15
|
+
[ERROR_CODES.UNAUTHORIZED]: 'Authentication is required.',
|
|
16
|
+
[ERROR_CODES.FORBIDDEN]: 'You do not have permission to perform this action.',
|
|
17
|
+
[ERROR_CODES.NOT_FOUND]: 'The requested resource was not found.',
|
|
18
|
+
[ERROR_CODES.CONFLICT]: 'The request could not be completed due to a conflict.',
|
|
19
|
+
[ERROR_CODES.TOO_MANY_REQUESTS]: 'Too many requests. Please try again later.',
|
|
20
|
+
[ERROR_CODES.INTERNAL_SERVER_ERROR]: 'An unexpected internal error occurred.',
|
|
21
|
+
[ERROR_CODES.SERVICE_UNAVAILABLE]: 'The service is currently unavailable.',
|
|
22
|
+
[ERROR_CODES.DEPENDENCY_FAILURE]: 'A dependent service failed to respond.',
|
|
23
|
+
/* ------------------------------------------------------------------ */
|
|
24
|
+
/* 🌐 HTTP / Network */
|
|
25
|
+
/* ------------------------------------------------------------------ */
|
|
26
|
+
[ERROR_CODES.HTTP_ERROR]: 'An HTTP error occurred while processing the request.',
|
|
27
|
+
[ERROR_CODES.HTTP_TIMEOUT]: 'The request timed out.',
|
|
28
|
+
[ERROR_CODES.UPSTREAM_SERVICE_ERROR]: 'An upstream service returned an error.',
|
|
29
|
+
/* ------------------------------------------------------------------ */
|
|
30
|
+
/* 🔐 Authentication / Authorization */
|
|
31
|
+
/* ------------------------------------------------------------------ */
|
|
32
|
+
[ERROR_CODES.AUTH_FAILED]: 'Authentication failed.',
|
|
33
|
+
[ERROR_CODES.TOKEN_MISSING]: 'Authentication token is missing.',
|
|
34
|
+
[ERROR_CODES.TOKEN_INVALID]: 'Authentication token is invalid.',
|
|
35
|
+
[ERROR_CODES.TOKEN_EXPIRED]: 'Authentication token has expired.',
|
|
36
|
+
/* ------------------------------------------------------------------ */
|
|
37
|
+
/* 🔑 Cryptography / Security */
|
|
38
|
+
/* ------------------------------------------------------------------ */
|
|
39
|
+
[ERROR_CODES.CRYPTO_ERROR]: 'A cryptographic operation failed.',
|
|
40
|
+
[ERROR_CODES.CRYPTO_INTEGRITY_ERROR]: 'Data integrity verification failed.',
|
|
41
|
+
/* ------------------------------------------------------------------ */
|
|
42
|
+
/* 💾 Cache */
|
|
43
|
+
/* ------------------------------------------------------------------ */
|
|
44
|
+
[ERROR_CODES.CACHE_ERROR]: 'A cache operation failed.',
|
|
45
|
+
[ERROR_CODES.CACHE_CONNECTION_FAILED]: 'Failed to connect to the cache store.',
|
|
46
|
+
/* ------------------------------------------------------------------ */
|
|
47
|
+
/* 🗄️ Database */
|
|
48
|
+
/* ------------------------------------------------------------------ */
|
|
49
|
+
[ERROR_CODES.DATABASE_ERROR]: 'A database error occurred.',
|
|
50
|
+
[ERROR_CODES.DATABASE_CONNECTION_FAILED]: 'Failed to connect to the database.',
|
|
51
|
+
[ERROR_CODES.DATABASE_CONSTRAINT_VIOLATION]: 'The operation violates a database constraint.',
|
|
52
|
+
/* ------------------------------------------------------------------ */
|
|
53
|
+
/* 📩 Messaging / Queues */
|
|
54
|
+
/* ------------------------------------------------------------------ */
|
|
55
|
+
[ERROR_CODES.MESSAGE_BROKER_ERROR]: 'A message broker error occurred.',
|
|
56
|
+
[ERROR_CODES.MESSAGE_PUBLISH_FAILED]: 'Failed to publish message to the message broker.',
|
|
57
|
+
/* ------------------------------------------------------------------ */
|
|
58
|
+
/* 📁 File / Storage */
|
|
59
|
+
/* ------------------------------------------------------------------ */
|
|
60
|
+
[ERROR_CODES.FILE_ERROR]: 'A file operation failed.',
|
|
61
|
+
[ERROR_CODES.FILE_NOT_FOUND]: 'The requested file was not found.',
|
|
62
|
+
[ERROR_CODES.FILE_UPLOAD_FAILED]: 'File upload failed.',
|
|
63
|
+
[ERROR_CODES.FILE_TOO_LARGE]: 'The uploaded file exceeds the allowed size.',
|
|
64
|
+
/* ------------------------------------------------------------------ */
|
|
65
|
+
/* ⚙️ Configuration / Environment */
|
|
66
|
+
/* ------------------------------------------------------------------ */
|
|
67
|
+
[ERROR_CODES.CONFIG_ERROR]: 'Configuration error detected.',
|
|
68
|
+
[ERROR_CODES.CONFIG_MISSING]: 'Required configuration is missing.',
|
|
69
|
+
/* ------------------------------------------------------------------ */
|
|
70
|
+
/* ⏱️ Timeouts / Resources */
|
|
71
|
+
/* ------------------------------------------------------------------ */
|
|
72
|
+
[ERROR_CODES.TIMEOUT_ERROR]: 'The operation timed out.',
|
|
73
|
+
[ERROR_CODES.RESOURCE_EXHAUSTED]: 'The system has exhausted required resources.',
|
|
31
74
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import type { ErrorCode } from '../constants';
|
|
2
2
|
export declare class AppError extends Error {
|
|
3
3
|
statusCode: number;
|
|
4
4
|
isOperational: boolean;
|
|
@@ -8,7 +8,7 @@ export declare class AppError extends Error {
|
|
|
8
8
|
constructor(code: ErrorCode, statusCode?: number, details?: unknown, cause?: Error);
|
|
9
9
|
toJSON(): {
|
|
10
10
|
success: boolean;
|
|
11
|
-
code:
|
|
11
|
+
code: ErrorCode;
|
|
12
12
|
message: string;
|
|
13
13
|
details: {} | null;
|
|
14
14
|
};
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { HTTP_STATUS } from '@naman_deep_singh/response-utils';
|
|
2
|
-
import {
|
|
2
|
+
import { errorMessageRegistry } from 'src';
|
|
3
3
|
export class AppError extends Error {
|
|
4
4
|
constructor(code, statusCode = HTTP_STATUS.SERVER_ERROR.INTERNAL_SERVER_ERROR, details, cause) {
|
|
5
|
-
super(
|
|
5
|
+
super(errorMessageRegistry.resolve(code)); // message comes from mapping
|
|
6
6
|
this.code = code;
|
|
7
7
|
this.statusCode = statusCode;
|
|
8
8
|
this.isOperational = true;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { ERROR_CODES } from 'src/constants';
|
|
2
|
+
import { InternalServerError } from './InternalServerError';
|
|
3
|
+
export class ServiceUnavailableError extends InternalServerError {
|
|
4
|
+
constructor(details, cause) {
|
|
5
|
+
super(ERROR_CODES.SERVICE_UNAVAILABLE, details, cause);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export declare class TokenExpiredError extends
|
|
1
|
+
import { HTTPError } from './HTTPError';
|
|
2
|
+
export declare class TokenExpiredError extends HTTPError {
|
|
3
3
|
constructor(details?: unknown, cause?: Error);
|
|
4
4
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { HTTP_STATUS } from '@naman_deep_singh/response-utils';
|
|
2
2
|
import { ERROR_CODES } from 'src/constants';
|
|
3
|
-
import {
|
|
4
|
-
export class TokenExpiredError extends
|
|
3
|
+
import { HTTPError } from './HTTPError';
|
|
4
|
+
export class TokenExpiredError extends HTTPError {
|
|
5
5
|
constructor(details, cause) {
|
|
6
6
|
super(ERROR_CODES.TOKEN_EXPIRED, HTTP_STATUS.CLIENT_ERROR.UNAUTHORIZED, details, cause);
|
|
7
7
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export declare class TokenMalformedError extends
|
|
1
|
+
import { HTTPError } from './HTTPError';
|
|
2
|
+
export declare class TokenMalformedError extends HTTPError {
|
|
3
3
|
constructor(details?: unknown, cause?: Error);
|
|
4
4
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { HTTP_STATUS } from '@naman_deep_singh/response-utils';
|
|
2
2
|
import { ERROR_CODES } from 'src/constants';
|
|
3
|
-
import {
|
|
4
|
-
export class TokenMalformedError extends
|
|
3
|
+
import { HTTPError } from './HTTPError';
|
|
4
|
+
export class TokenMalformedError extends HTTPError {
|
|
5
5
|
constructor(details, cause) {
|
|
6
6
|
super(ERROR_CODES.TOKEN_INVALID, HTTP_STATUS.CLIENT_ERROR.UNAUTHORIZED, details, cause);
|
|
7
7
|
}
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import { type ErrorCode } from 'src/constants';
|
|
2
1
|
import { HTTPError } from './HTTPError';
|
|
3
2
|
export declare class UnauthorizedError extends HTTPError {
|
|
4
|
-
constructor(
|
|
3
|
+
constructor(details?: unknown, cause?: Error);
|
|
5
4
|
}
|
|
@@ -2,7 +2,7 @@ import { HTTP_STATUS } from '@naman_deep_singh/response-utils';
|
|
|
2
2
|
import { ERROR_CODES } from 'src/constants';
|
|
3
3
|
import { HTTPError } from './HTTPError';
|
|
4
4
|
export class UnauthorizedError extends HTTPError {
|
|
5
|
-
constructor(
|
|
6
|
-
super(
|
|
5
|
+
constructor(details, cause) {
|
|
6
|
+
super(ERROR_CODES.UNAUTHORIZED, HTTP_STATUS.CLIENT_ERROR.UNAUTHORIZED, details, cause);
|
|
7
7
|
}
|
|
8
8
|
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { ExpressResponder } from '@naman_deep_singh/response-utils';
|
|
2
|
+
import { type ErrorCode } from 'src/constants';
|
|
3
|
+
import type { AppError } from 'src/error/AppError';
|
|
4
|
+
export declare class ErrorMessageRegistry {
|
|
5
|
+
private static instance;
|
|
6
|
+
private readonly registry;
|
|
7
|
+
private constructor();
|
|
8
|
+
/** Singleton accessor */
|
|
9
|
+
static getInstance(): ErrorMessageRegistry;
|
|
10
|
+
/** Register or override messages */
|
|
11
|
+
register(messages: Record<string, string>): void;
|
|
12
|
+
/** Resolve a message for a given error code */
|
|
13
|
+
resolve(code: ErrorCode | string, defaultMessage?: string): string;
|
|
14
|
+
/**
|
|
15
|
+
* Map an AppError to an ExpressResponder
|
|
16
|
+
* Centralizes error-to-HTTP mapping
|
|
17
|
+
*/
|
|
18
|
+
mapAppErrorToResponder(responder: ExpressResponder<unknown>, err: AppError): any;
|
|
19
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { HTTP_STATUS } from '@naman_deep_singh/response-utils';
|
|
2
|
+
import { ERROR_MESSAGES } from 'src/constants';
|
|
3
|
+
export class ErrorMessageRegistry {
|
|
4
|
+
constructor() {
|
|
5
|
+
this.registry = new Map();
|
|
6
|
+
// Initialize with default messages
|
|
7
|
+
Object.entries(ERROR_MESSAGES).forEach(([code, message]) => {
|
|
8
|
+
this.registry.set(code, message);
|
|
9
|
+
});
|
|
10
|
+
}
|
|
11
|
+
/** Singleton accessor */
|
|
12
|
+
static getInstance() {
|
|
13
|
+
if (!ErrorMessageRegistry.instance) {
|
|
14
|
+
ErrorMessageRegistry.instance = new ErrorMessageRegistry();
|
|
15
|
+
}
|
|
16
|
+
return ErrorMessageRegistry.instance;
|
|
17
|
+
}
|
|
18
|
+
/** Register or override messages */
|
|
19
|
+
register(messages) {
|
|
20
|
+
for (const [code, message] of Object.entries(messages)) {
|
|
21
|
+
this.registry.set(code, message);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
/** Resolve a message for a given error code */
|
|
25
|
+
resolve(code, defaultMessage = 'Unexpected error') {
|
|
26
|
+
return this.registry.get(code) ?? defaultMessage;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Map an AppError to an ExpressResponder
|
|
30
|
+
* Centralizes error-to-HTTP mapping
|
|
31
|
+
*/
|
|
32
|
+
mapAppErrorToResponder(responder, err) {
|
|
33
|
+
switch (err.statusCode) {
|
|
34
|
+
case HTTP_STATUS.CLIENT_ERROR.BAD_REQUEST:
|
|
35
|
+
return responder.badRequest(this.resolve(err.code), {
|
|
36
|
+
details: err.details,
|
|
37
|
+
});
|
|
38
|
+
case HTTP_STATUS.CLIENT_ERROR.UNAUTHORIZED:
|
|
39
|
+
return responder.unauthorized(this.resolve(err.code));
|
|
40
|
+
case HTTP_STATUS.CLIENT_ERROR.FORBIDDEN:
|
|
41
|
+
return responder.forbidden(this.resolve(err.code));
|
|
42
|
+
case HTTP_STATUS.CLIENT_ERROR.NOT_FOUND:
|
|
43
|
+
return responder.notFound(this.resolve(err.code));
|
|
44
|
+
case HTTP_STATUS.CLIENT_ERROR.CONFLICT:
|
|
45
|
+
return responder.conflict(this.resolve(err.code));
|
|
46
|
+
case HTTP_STATUS.CLIENT_ERROR.UNPROCESSABLE_ENTITY:
|
|
47
|
+
return responder.unprocessableEntity(this.resolve(err.code), {
|
|
48
|
+
details: err.details,
|
|
49
|
+
});
|
|
50
|
+
case HTTP_STATUS.CLIENT_ERROR.TOO_MANY_REQUESTS:
|
|
51
|
+
return responder.tooManyRequests(this.resolve(err.code));
|
|
52
|
+
default:
|
|
53
|
+
// Any other status maps to generic server error
|
|
54
|
+
return responder.serverError(this.resolve(err.code), {
|
|
55
|
+
details: err.details,
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * from './errorRegistry';
|
|
1
2
|
export * from './error/AppError';
|
|
2
3
|
export * from './error/HTTPError';
|
|
3
4
|
export * from './error/BadRequestError';
|
|
@@ -6,7 +7,6 @@ export * from './error/ForbiddenError';
|
|
|
6
7
|
export * from './error/NotFoundError';
|
|
7
8
|
export * from './error/ConflictError';
|
|
8
9
|
export * from './error/ValidationError';
|
|
9
|
-
export * from './error/RateLimitError';
|
|
10
10
|
export * from './error/TooManyRequestsError';
|
|
11
11
|
export * from './error/TokenExpiredError';
|
|
12
12
|
export * from './error/TokenMalformedError';
|