@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
package/dist/esm/index.js
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
// Base Errors
|
|
1
|
+
export * from './errorRegistry';
|
|
3
2
|
// =========================
|
|
4
3
|
export * from './error/AppError';
|
|
5
4
|
export * from './error/HTTPError';
|
|
@@ -12,7 +11,6 @@ export * from './error/ForbiddenError';
|
|
|
12
11
|
export * from './error/NotFoundError';
|
|
13
12
|
export * from './error/ConflictError';
|
|
14
13
|
export * from './error/ValidationError';
|
|
15
|
-
export * from './error/RateLimitError';
|
|
16
14
|
export * from './error/TooManyRequestsError';
|
|
17
15
|
// =========================
|
|
18
16
|
// Auth / Token Errors
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import { ExpressResponder } from '@naman_deep_singh/response-utils';
|
|
1
|
+
import { ExpressResponder, HTTP_STATUS } from '@naman_deep_singh/response-utils';
|
|
2
|
+
import { errorMessageRegistry } from 'src/errorRegistry';
|
|
2
3
|
import { ERROR_CODES } from '../../constants';
|
|
3
4
|
import { AppError } from '../../error/AppError';
|
|
4
|
-
import { mapAppErrorToResponder } from '../../utils/mapAppErrorToResponder';
|
|
5
5
|
export function expressErrorHandler(err, _req, res, _next) {
|
|
6
6
|
const responder = new ExpressResponder({}, res);
|
|
7
7
|
// 1. Known operational error
|
|
8
8
|
if (err instanceof AppError) {
|
|
9
|
-
return mapAppErrorToResponder(responder, err);
|
|
9
|
+
return errorMessageRegistry.mapAppErrorToResponder(responder, err);
|
|
10
10
|
}
|
|
11
11
|
// 2. Log unexpected errors (never expose internals in prod)
|
|
12
12
|
console.error('UNEXPECTED ERROR:', err);
|
|
13
13
|
// 3. Normalize unknown error → AppError
|
|
14
|
-
const internalError = new AppError(ERROR_CODES.INTERNAL_SERVER_ERROR,
|
|
15
|
-
return mapAppErrorToResponder(responder, internalError);
|
|
14
|
+
const internalError = new AppError(ERROR_CODES.INTERNAL_SERVER_ERROR, HTTP_STATUS.SERVER_ERROR.INTERNAL_SERVER_ERROR, process.env.NODE_ENV === 'production' ? undefined : err, err instanceof Error ? err : undefined);
|
|
15
|
+
return errorMessageRegistry.mapAppErrorToResponder(responder, internalError);
|
|
16
16
|
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './errorHandler';
|
|
2
|
-
export * from './errorConverter';
|
|
1
|
+
export * from './errorHandler.middleware';
|
|
2
|
+
export * from './errorConverter.middleware';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './errorHandler';
|
|
2
|
-
export * from './errorConverter';
|
|
1
|
+
export * from './errorHandler.middleware';
|
|
2
|
+
export * from './errorConverter.middleware';
|
|
@@ -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,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,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,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,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,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
|
}
|
|
@@ -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
|
+
}
|
package/dist/types/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';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './errorHandler';
|
|
2
|
-
export * from './errorConverter';
|
|
1
|
+
export * from './errorHandler.middleware';
|
|
2
|
+
export * from './errorConverter.middleware';
|
package/package.json
CHANGED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.RateLimitError = void 0;
|
|
4
|
-
const constants_1 = require("src/constants");
|
|
5
|
-
const TooManyRequestsError_1 = require("./TooManyRequestsError");
|
|
6
|
-
class RateLimitError extends TooManyRequestsError_1.TooManyRequestsError {
|
|
7
|
-
constructor(details, cause) {
|
|
8
|
-
super(constants_1.ERROR_CODES.RATE_LIMIT_EXCEEDED, details, cause);
|
|
9
|
-
}
|
|
10
|
-
}
|
|
11
|
-
exports.RateLimitError = RateLimitError;
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.mapAppErrorToResponder = mapAppErrorToResponder;
|
|
4
|
-
const response_utils_1 = require("@naman_deep_singh/response-utils");
|
|
5
|
-
function mapAppErrorToResponder(responder, err) {
|
|
6
|
-
switch (err.statusCode) {
|
|
7
|
-
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.BAD_REQUEST:
|
|
8
|
-
return responder.badRequest(err.message, { details: err.details });
|
|
9
|
-
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.UNAUTHORIZED:
|
|
10
|
-
return responder.unauthorized(err.message);
|
|
11
|
-
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.FORBIDDEN:
|
|
12
|
-
return responder.forbidden(err.message);
|
|
13
|
-
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.NOT_FOUND:
|
|
14
|
-
return responder.notFound(err.message);
|
|
15
|
-
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.CONFLICT:
|
|
16
|
-
return responder.conflict(err.message);
|
|
17
|
-
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.UNPROCESSABLE_ENTITY:
|
|
18
|
-
return responder.unprocessableEntity(err.message, {
|
|
19
|
-
details: err.details,
|
|
20
|
-
});
|
|
21
|
-
case response_utils_1.HTTP_STATUS.CLIENT_ERROR.TOO_MANY_REQUESTS:
|
|
22
|
-
return responder.tooManyRequests(err.message);
|
|
23
|
-
default:
|
|
24
|
-
// Any other custom status maps to a generic server error
|
|
25
|
-
return responder.serverError(err.message, { details: err.details });
|
|
26
|
-
}
|
|
27
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { ERROR_CODES } from 'src/constants';
|
|
2
|
-
import { TooManyRequestsError } from './TooManyRequestsError';
|
|
3
|
-
export class RateLimitError extends TooManyRequestsError {
|
|
4
|
-
constructor(details, cause) {
|
|
5
|
-
super(ERROR_CODES.RATE_LIMIT_EXCEEDED, details, cause);
|
|
6
|
-
}
|
|
7
|
-
}
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import { HTTP_STATUS } from '@naman_deep_singh/response-utils';
|
|
2
|
-
export function mapAppErrorToResponder(responder, err) {
|
|
3
|
-
switch (err.statusCode) {
|
|
4
|
-
case HTTP_STATUS.CLIENT_ERROR.BAD_REQUEST:
|
|
5
|
-
return responder.badRequest(err.message, { details: err.details });
|
|
6
|
-
case HTTP_STATUS.CLIENT_ERROR.UNAUTHORIZED:
|
|
7
|
-
return responder.unauthorized(err.message);
|
|
8
|
-
case HTTP_STATUS.CLIENT_ERROR.FORBIDDEN:
|
|
9
|
-
return responder.forbidden(err.message);
|
|
10
|
-
case HTTP_STATUS.CLIENT_ERROR.NOT_FOUND:
|
|
11
|
-
return responder.notFound(err.message);
|
|
12
|
-
case HTTP_STATUS.CLIENT_ERROR.CONFLICT:
|
|
13
|
-
return responder.conflict(err.message);
|
|
14
|
-
case HTTP_STATUS.CLIENT_ERROR.UNPROCESSABLE_ENTITY:
|
|
15
|
-
return responder.unprocessableEntity(err.message, {
|
|
16
|
-
details: err.details,
|
|
17
|
-
});
|
|
18
|
-
case HTTP_STATUS.CLIENT_ERROR.TOO_MANY_REQUESTS:
|
|
19
|
-
return responder.tooManyRequests(err.message);
|
|
20
|
-
default:
|
|
21
|
-
// Any other custom status maps to a generic server error
|
|
22
|
-
return responder.serverError(err.message, { details: err.details });
|
|
23
|
-
}
|
|
24
|
-
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/dist/types/middleware/express/{errorConverter.d.ts → errorConverter.middleware.d.ts}
RENAMED
|
File without changes
|
|
File without changes
|