Add GenericError for status related errors

README.md

@@ -44,9 +44,19 @@ const optionalArgs = {
 throw new ApiError(400, error, optionalArgs);
 ```
 
+### GenericError
+
+Extends from ApiError with a preset of status code 0 and GENERIC_ERROR as error.
+This should be used when it's internal without needing an actual status code.
+
+```javascript
+throw new GenericError(); // or
+throw new GenericError(error, optionalArgs);
+```
+
 ### BadRequestError
 
-extends from ApiError with a preset of status code 400 and BAD_REQUEST as error.
+Extends from ApiError with a preset of status code 400 and BAD_REQUEST as error.
 
 ```javascript
 throw new BadRequestError(); // or
@@ -55,7 +65,7 @@ throw new BadRequestError(error, optionalArgs);
 
 ### NotFoundError
 
-extends from ApiError with a preset of status code 404 and RESOURCE_NOT_FOUND as error.
+Extends from ApiError with a preset of status code 404 and RESOURCE_NOT_FOUND as error.
 
 ```javascript
 throw new NotFoundError(); // or
@@ -64,7 +74,7 @@ throw new NotFoundError(error, optionalArgs);
 
 ### ForbiddenError
 
-extends from ApiError with a preset of status code 403 and FORBIDDEN as error.
+Extends from ApiError with a preset of status code 403 and FORBIDDEN as error.
 
 ```javascript
 throw new ForbiddenError(); // or
@@ -73,7 +83,7 @@ throw new ForbiddenError(error, optionalArgs);
 
 ### InternalServerError
 
-extends from ApiError with a preset of status code 500 and INTERNAL_ERROR as error.
+Extends from ApiError with a preset of status code 500 and INTERNAL_ERROR as error.
 
 ```javascript
 throw new InternalServerError(); // or
@@ -82,7 +92,7 @@ throw new InternalServerError(error, optionalArgs);
 
 ### UnauthorizedError
 
-extends from ApiError with a preset of status code 401 and UNAUTHORIZED as error.
+Extends from ApiError with a preset of status code 401 and UNAUTHORIZED as error.
 
 ```javascript
 throw new UnauthorizedError(); // or
@@ -91,7 +101,7 @@ throw new UnauthorizedError(error, optionalArgs);
 
 ### ValidationError
 
-extends from ApiError with a preset of status code 400 and INVALID_INPUT as error.
+Extends from ApiError with a preset of status code 400 and INVALID_INPUT as error.
 
 ```javascript
 throw new ValidationError(); // or
@@ -100,7 +110,7 @@ throw new ValidationError(error, optionalArgs);
 
 ### AuthenticationError
 
-extends from ApiError with a preset of status code 400 and AUTHENTICATION_FAILED as error.
+Extends from ApiError with a preset of status code 400 and AUTHENTICATION_FAILED as error.
 
 ```javascript
 throw new AuthenticationError(); // or

src/config/errors.config.ts

@@ -1,4 +1,5 @@
 export const errors = {
+  GENERIC_ERROR:          { code: 'GENERIC_ERROR', i18n: 'internal_error', message: 'An unkown error occurred' },
   INTERNAL_ERROR:         { code: 'INTERNAL_ERROR', i18n: 'internal_error', message: 'An unkown error occurred' },
   INVALID_INPUT:          { code: 'INVALID_INPUT', i18n: 'invalid_input', message: 'Invalid input provided' },
   AUTHENTICATION_FAILED:  { code: 'AUTHENTICATION_FAILED', i18n: 'authentication_failed', message: 'Authentication failed' },

src/lib/errors.ts

@@ -25,6 +25,13 @@ export class ApiError extends Error {
   }
 }
 
+export class GenericError extends ApiError {
+  constructor(error?: ErrorType, args?: ErrorArgs) {
+    super(0, error == null ? errors.GENERIC_ERROR : error, args);
+    this.name = 'GenericError';
+  }
+}
+
 export class BadRequestError extends ApiError {
   constructor(error?: ErrorType, args?: ErrorArgs) {
     super(httpStatus.BAD_REQUEST, error == null ? errors.BAD_REQUEST : error, args);

tests/errors.test.ts

@@ -9,6 +9,7 @@ import {
   UnauthorizedError,
   ValidationError,
   AuthenticationError,
+  GenericError,
 } from '../src';
 
 describe('errors', () => {
@@ -50,6 +51,42 @@ describe('errors', () => {
     });
   });
 
+  describe('GenericError', () => {
+    it('Should throw a GenericError with default arguments', () => {
+      try {
+        throw new GenericError();
+      } catch (error) {
+        expect(error).toBeInstanceOf(Error);
+        expect(error).toBeInstanceOf(GenericError);
+        expect(error.name).toEqual('GenericError');
+        expect(error.id).toEqual(expect.any(String));
+        expect(error.toString()).toEqual(`GenericError: ${errors.GENERIC_ERROR.message}`);
+        expect(error.stack).not.toBeNull();
+        expect(error.detail).toBeUndefined();
+      }
+    });
+
+    it('Should throw an InternalServerError with custom error', () => {
+      const args = {
+        code: 'CUSTOM_CODE',
+        message: 'Error with a custom message',
+      };
+
+      try {
+        throw new GenericError(args);
+      } catch (error) {
+        expect(error).toBeInstanceOf(Error);
+        expect(error).toBeInstanceOf(GenericError);
+        expect(error.name).toEqual('GenericError');
+        expect(error.code).toEqual(args.code);
+        expect(error.id).toEqual(expect.any(String));
+        expect(error.toString()).toEqual('GenericError: Error with a custom message');
+        expect(error.stack).not.toBeNull();
+        expect(error.detail).toBeUndefined();
+      }
+    });
+  });
+
   describe('BadRequestError', () => {
     it('Should throw an BadRequestError with default arguments', () => {
       try {