feat: Refactored and renamed as fastify-http-errors-enhanced.

Author: ShogunPanda

CHANGELOG.md

@@ -1,3 +1,9 @@
+### 2020-11-22 / 2.0.0
+
+- feat: Renamed to `fastify-http-errors-enhanced`.
+- feat: Dropped all error related depedencies in favor of `http-errors-enhanced`.
+- feat: Removed `addAdditionalProperties` and `serializeError` which can now be found in `http-errors-enhanced`.
+
 ### 2020-09-28 / 1.0.0
 
 - feat: Updated to fastify 3.x.x.
@@ -49,4 +55,3 @@
 
 - chore: Rebuild.
 - feat: Extract errors to another module.
-

README.md

@@ -1,20 +1,20 @@
-# fastify-errors-properties
+# fastify-http-errors-enhanced
 
-[![Package Version](https://img.shields.io/npm/v/fastify-errors-properties.svg)](https://npm.im/fastify-errors-properties)
-[![Dependency Status](https://img.shields.io/david/ShogunPanda/fastify-errors-properties)](https://david-dm.org/ShogunPanda/fastify-errors-properties)
-[![Build](https://github.com/ShogunPanda/fastify-errors-properties/workflows/CI/badge.svg)](https://github.com/ShogunPanda/fastify-errors-properties/actions?query=workflow%3ACI)
-[![Code Coverage](https://img.shields.io/codecov/c/gh/ShogunPanda/fastify-errors-properties?token=d0ae1643f35c4c4f9714a357f796d05d)](https://codecov.io/gh/ShogunPanda/fastify-errors-properties)
+[![Package Version](https://img.shields.io/npm/v/fastify-http-errors-enhanced.svg)](https://npm.im/fastify-http-errors-enhanced)
+[![Dependency Status](https://img.shields.io/david/ShogunPanda/fastify-http-errors-enhanced)](https://david-dm.org/ShogunPanda/fastify-http-errors-enhanced)
+[![Build](https://github.com/ShogunPanda/fastify-http-errors-enhanced/workflows/CI/badge.svg)](https://github.com/ShogunPanda/fastify-http-errors-enhanced/actions?query=workflow%3ACI)
+[![Code Coverage](https://img.shields.io/codecov/c/gh/ShogunPanda/fastify-http-errors-enhanced?token=d0ae1643f35c4c4f9714a357f796d05d)](https://codecov.io/gh/ShogunPanda/fastify-http-errors-enhanced)
 
-A error handling plugin for Fastify that enables additional properties in errors.
+A error handling plugin for Fastify that uses enhanced HTTP errors.
 
-http://sw.cowtech.it/fastify-errors-properties
+http://sw.cowtech.it/fastify-http-errors-enhanced
 
 ## Installation
 
 Just run:
 
 ```bash
-npm install fastify-errors-properties --save
+npm install fastify-http-errors-enhanced --save
 ```
 
 ## Usage
@@ -46,10 +46,10 @@ To clarify, take this server as a example:
 const server = require('fastify')()
 const createError = require('http-errors')
 
-server.register(require('fastify-errors-properties'))
+server.register(require('fastify-http-errors-enhanced'))
 
 server.get('/invalid', {
-  handler: async function(request, reply) {
+  handler: async function (request, reply) {
     throw createError(404, 'You are not supposed to reach this.', { header: { 'X-Req-Id': request.id, id: 123 } })
   }
 })
@@ -98,10 +98,10 @@ To clarify, take this server as a example:
 const server = require('fastify')()
 const createError = require('http-errors')
 
-server.register(require('fastify-errors-properties'), { hideUnhandledErrors: false })
+server.register(require('fastify-http-errors-enhanced'), { hideUnhandledErrors: false })
 
 server.get('/invalid', {
-  handler: function(request, reply) {
+  handler: function (request, reply) {
     const error = new Error('This was not supposed to happen.')
     error.id = 123
     throw error
@@ -159,7 +159,7 @@ Example of a response validation error:
 }
 ```
 
-## Contributing to fastify-errors-properties
+## Contributing to fastify-http-errors-enhanced
 
 - Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 - Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.

lib/handlers.js

@@ -1,36 +1,11 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleErrors = exports.handleValidationError = exports.handleNotFoundError = void 0;
-const http_errors_1 = __importStar(require("http-errors"));
-const http_status_codes_1 = __importDefault(require("http-status-codes"));
-const statuses_1 = __importDefault(require("statuses"));
-const properties_1 = require("./properties");
+const http_errors_enhanced_1 = require("http-errors-enhanced");
 const utils_1 = require("./utils");
 const validation_1 = require("./validation");
 function handleNotFoundError(request, reply) {
-    handleErrors(new http_errors_1.NotFound('Not found.'), request, reply);
+    handleErrors(new http_errors_enhanced_1.NotFoundError('Not found.'), request, reply);
 }
 exports.handleNotFoundError = handleNotFoundError;
 function handleValidationError(error, request) {
@@ -40,7 +15,7 @@ function handleValidationError(error, request) {
       and fastify throws on first failing section.
     */
     const section = error.message.match(/^\w+/)[0];
-    return http_errors_1.default(http_status_codes_1.default.BAD_REQUEST, 'One or more validations failed trying to process your request.', {
+    return new http_errors_enhanced_1.BadRequestError('One or more validations failed trying to process your request.', {
         failedValidations: validation_1.convertValidationErrors(section, Reflect.get(request, section), error.validation)
     });
 }
@@ -56,38 +31,37 @@ function handleErrors(error, request, reply) {
         }
         else if ((_b = request.errorProperties) === null || _b === void 0 ? void 0 : _b.hideUnhandledErrors) {
             // It is requested to hide the error, just log it and then create a generic one
-            request.log.error({ error: properties_1.serializeError(error) });
-            error = new http_errors_1.InternalServerError('An error occurred trying to process your request.');
+            request.log.error({ error: http_errors_enhanced_1.serializeError(error) });
+            error = new http_errors_enhanced_1.InternalServerError('An error occurred trying to process your request.');
         }
         else {
-            // Wrap in a http-error, making the stack explicitily available
-            error = Object.assign(new http_errors_1.InternalServerError(error.message), properties_1.serializeError(error));
+            // Wrap in a HttpError, making the stack explicitily available
+            error = new http_errors_enhanced_1.InternalServerError(http_errors_enhanced_1.serializeError(error));
             Object.defineProperty(error, 'stack', { enumerable: true });
         }
     }
     else if (code === 'INVALID_CONTENT_TYPE' || code === 'FST_ERR_CTP_INVALID_MEDIA_TYPE') {
-        error = http_errors_1.default(http_status_codes_1.default.UNSUPPORTED_MEDIA_TYPE, utils_1.upperFirst(validation_1.validationMessagesFormatters.contentType()));
+        error = new http_errors_enhanced_1.UnsupportedMediaTypeError(utils_1.upperFirst(validation_1.validationMessagesFormatters.contentType()));
     }
     else if (code === 'FST_ERR_CTP_EMPTY_JSON_BODY') {
-        error = http_errors_1.default(http_status_codes_1.default.BAD_REQUEST, utils_1.upperFirst(validation_1.validationMessagesFormatters.jsonEmpty()));
+        error = new http_errors_enhanced_1.BadRequestError(utils_1.upperFirst(validation_1.validationMessagesFormatters.jsonEmpty()));
     }
     else if (code === 'MALFORMED_JSON' || error.message === 'Invalid JSON' || error.stack.includes('at JSON.parse')) {
-        error = http_errors_1.default(http_status_codes_1.default.BAD_REQUEST, utils_1.upperFirst(validation_1.validationMessagesFormatters.json()));
+        error = new http_errors_enhanced_1.BadRequestError(utils_1.upperFirst(validation_1.validationMessagesFormatters.json()));
     }
     // Get the status code
     let { statusCode, headers } = error;
     // Code outside HTTP range
     if (statusCode < 100 || statusCode > 599) {
-        statusCode = http_status_codes_1.default.INTERNAL_SERVER_ERROR;
+        statusCode = http_errors_enhanced_1.INTERNAL_SERVER_ERROR;
     }
     // Create the body
     const body = {
         statusCode,
-        code: error.code,
-        error: statuses_1.default(statusCode.toString()),
+        error: http_errors_enhanced_1.messagesByCodes[statusCode],
         message: error.message
     };
-    properties_1.addAdditionalProperties(body, error);
+    http_errors_enhanced_1.addAdditionalProperties(body, error);
     // Send the error back
     // eslint-disable-next-line @typescript-eslint/no-floating-promises
     reply

lib/index.js

@@ -13,16 +13,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.plugin = exports.validationMessagesFormatters = exports.niceJoin = exports.convertValidationErrors = exports.serializeError = exports.addAdditionalProperties = void 0;
+exports.plugin = exports.validationMessagesFormatters = exports.niceJoin = exports.convertValidationErrors = void 0;
 const ajv_1 = __importDefault(require("ajv"));
 const fastify_plugin_1 = __importDefault(require("fastify-plugin"));
 const handlers_1 = require("./handlers");
 const validation_1 = require("./validation");
 __exportStar(require("./handlers"), exports);
 __exportStar(require("./interfaces"), exports);
-var properties_1 = require("./properties");
-Object.defineProperty(exports, "addAdditionalProperties", { enumerable: true, get: function () { return properties_1.addAdditionalProperties; } });
-Object.defineProperty(exports, "serializeError", { enumerable: true, get: function () { return properties_1.serializeError; } });
 var validation_2 = require("./validation");
 Object.defineProperty(exports, "convertValidationErrors", { enumerable: true, get: function () { return validation_2.convertValidationErrors; } });
 Object.defineProperty(exports, "niceJoin", { enumerable: true, get: function () { return validation_2.niceJoin; } });
@@ -48,7 +45,7 @@ exports.plugin = fastify_plugin_1.default(function (instance, options, done) {
         instance.addHook('onRoute', validation_1.addResponseValidation);
     }
     done();
-}, { name: 'fastify-errors-properties' });
+}, { name: 'fastify-http-errors-enhanced' });
 exports.default = exports.plugin;
 module.exports = exports.plugin;
 Object.assign(module.exports, exports);

lib/properties.js

@@ -1,11 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addResponseValidation = exports.convertValidationErrors = exports.validationMessagesFormatters = exports.niceJoin = void 0;
-const http_errors_1 = __importDefault(require("http-errors"));
-const http_status_codes_1 = __importDefault(require("http-status-codes"));
+const http_errors_enhanced_1 = require("http-errors-enhanced");
 const utils_1 = require("./utils");
 function niceJoin(array, lastSeparator = ' and ', separator = ', ') {
     switch (array.length) {
@@ -177,18 +173,18 @@ function addResponseValidation(route) {
     route.preSerialization = async function (_request, reply, payload) {
         const statusCode = reply.raw.statusCode;
         // Never validate error 500
-        if (statusCode === http_status_codes_1.default.INTERNAL_SERVER_ERROR) {
+        if (statusCode === http_errors_enhanced_1.INTERNAL_SERVER_ERROR) {
             return payload;
         }
         // No validator, it means the HTTP status is not allowed
         const validator = validators[statusCode];
         if (!validator) {
-            throw http_errors_1.default(http_status_codes_1.default.INTERNAL_SERVER_ERROR, exports.validationMessagesFormatters.invalidResponseCode(statusCode));
+            throw new http_errors_enhanced_1.InternalServerError(exports.validationMessagesFormatters.invalidResponseCode(statusCode));
         }
         // Now validate the payload
         const valid = validator(payload);
         if (!valid) {
-            throw http_errors_1.default(http_status_codes_1.default.INTERNAL_SERVER_ERROR, exports.validationMessagesFormatters.invalidResponse(statusCode), {
+            throw new http_errors_enhanced_1.InternalServerError(exports.validationMessagesFormatters.invalidResponse(statusCode), {
                 failedValidations: convertValidationErrors('response', payload, validator.errors)
             });
         }

lib/validation.js

@@ -1,16 +1,17 @@
 {
-  "name": "fastify-errors-properties",
+  "name": "fastify-http-errors-enhanced",
   "version": "1.0.0",
-  "description": "Fastify plugin to support http-errors additional properties.",
-  "homepage": "https://sw.cowtech.it/fastify-errors-properties",
-  "repository": "github:ShogunPanda/fastify-errors-properties",
+  "description": "A error handling plugin for Fastify that uses enhanced HTTP errors.",
+  "homepage": "https://sw.cowtech.it/fastify-http-errors-enhanced",
+  "repository": "github:ShogunPanda/fastify-http-errors-enhanced",
   "keywords": [
     "fastify",
     "fastify-plugin",
-    "http-errors"
+    "http-errors",
+    "http-errors-enhanced"
   ],
   "bugs": {
-    "url": "https://github.com/ShogunPanda/fastify-errors-properties/issues"
+    "url": "https://github.com/ShogunPanda/fastify-http-errors-enhanced/issues"
   },
   "author": "Shogun <shogun@cowtech.it>",
   "license": "ISC",
@@ -35,22 +36,18 @@
     "postpublish": "git push origin && git push origin -f --tags"
   },
   "dependencies": {
-    "ajv": "^6.12.5",
-    "fastify-plugin": "^2.3.4",
-    "http-errors": "^1.8.0",
-    "http-status-codes": "^2.1.4",
-    "statuses": "^2.0.0"
+    "ajv": "^6.12.6",
+    "fastify-plugin": "^3.0.0",
+    "http-errors-enhanced": "^0.3.0"
   },
   "devDependencies": {
-    "@cowtech/eslint-config": "^7.10.0",
-    "@types/http-errors": "^1.8.0",
-    "@types/node": "^14.11.2",
-    "@types/statuses": "^2.0.0",
+    "@cowtech/eslint-config": "^7.10.1",
+    "@types/node": "^14.14.10",
     "@types/tap": "^14.10.1",
-    "fastify": "^3.4.1",
-    "prettier": "^2.1.2",
-    "tap": "^14.10.8",
-    "typescript": "^4.0.3"
+    "fastify": "^3.8.0",
+    "prettier": "^2.2.1",
+    "tap": "^14.11.0",
+    "typescript": "^4.1.2"
   },
   "engines": {
     "node": ">=12.15.0"