feat: Improve types, only support Node LTS, replaced jest with tap.

Author: Shogun

.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "tsconfig.test.json"
+  },
+  "extends": ["@cowtech/eslint-config/typescript"]
+}

lib/handlers.js

@@ -88,7 +88,7 @@ function handleErrors(error, request, reply) {
     // Send the error back
     reply
         .code(statusCode)
-        .headers(headers || {})
+        .headers(headers !== null && headers !== void 0 ? headers : {})
         .type('application/json')
         .send(body);
 }

lib/index.js

@@ -21,9 +21,9 @@ exports.validationMessagesFormatters = validation_2.validationMessagesFormatters
 exports.plugin = fastify_plugin_1.default(function (instance, options, done) {
     var _a, _b, _c;
     const isProduction = process.env.NODE_ENV === 'production';
-    const hideUnhandledErrors = (_a = options.hideUnhandledErrors, (_a !== null && _a !== void 0 ? _a : isProduction));
-    const convertValidationErrors = (_b = options.convertValidationErrors, (_b !== null && _b !== void 0 ? _b : true));
-    const convertResponsesValidationErrors = (_c = options.convertResponsesValidationErrors, (_c !== null && _c !== void 0 ? _c : !isProduction));
+    const hideUnhandledErrors = (_a = options.hideUnhandledErrors) !== null && _a !== void 0 ? _a : isProduction;
+    const convertValidationErrors = (_b = options.convertValidationErrors) !== null && _b !== void 0 ? _b : true;
+    const convertResponsesValidationErrors = (_c = options.convertResponsesValidationErrors) !== null && _c !== void 0 ? _c : !isProduction;
     instance.decorateRequest('errorProperties', { hideUnhandledErrors, convertValidationErrors });
     instance.setErrorHandler(handlers_1.handleErrors);
     instance.setNotFoundHandler(handlers_1.handleNotFoundError);
@@ -40,5 +40,6 @@ exports.plugin = fastify_plugin_1.default(function (instance, options, done) {
     }
     done();
 }, { name: 'fastify-errors-properties' });
+exports.default = exports.plugin;
 module.exports = exports.plugin;
 Object.assign(module.exports, exports);

lib/properties.js

@@ -11,9 +11,10 @@ function addAdditionalProperties(target, source) {
 }
 exports.addAdditionalProperties = addAdditionalProperties;
 function serializeError(error) {
+    var _a, _b;
     const serialized = {
-        message: `[${error.code || error.name}] ${error.message}`,
-        stack: (error.stack || '')
+        message: `[${(_a = error.code) !== null && _a !== void 0 ? _a : error.name}] ${error.message}`,
+        stack: ((_b = error.stack) !== null && _b !== void 0 ? _b : '')
             .split('\n')
             .slice(1)
             .map((s) => s

lib/utils.js

@@ -9,6 +9,7 @@ function upperFirst(source) {
 }
 exports.upperFirst = upperFirst;
 function get(target, path) {
+    var _a;
     const tokens = path.split('.').map((t) => t.trim());
     for (const token of tokens) {
         if (typeof target === 'undefined' || target === null) {
@@ -18,7 +19,7 @@ function get(target, path) {
         }
         const index = token.match(/^(\d+)|(?:\[(\d+)\])$/);
         if (index) {
-            target = target[parseInt(index[1] || index[2], 10)];
+            target = target[parseInt((_a = index[1]) !== null && _a !== void 0 ? _a : index[2], 10)];
         }
         else {
             target = target[token];

lib/validation.js

@@ -64,7 +64,7 @@ exports.validationMessagesFormatters = {
         return max === 0 ? 'must be a empty array' : `must be an array with at most ${max} items`;
     },
     enum: (values) => `must be one of the following values: ${niceJoin(values.map((f) => `"${f}"`), ' or ')}`,
-    pattern: (pattern) => `must match pattern "${pattern.replace(/\(\?\:/g, '(')}"`,
+    pattern: (pattern) => `must match pattern "${pattern.replace(/\(\?:/g, '(')}"`,
     invalidResponseCode: (code) => `This endpoint cannot respond with HTTP status ${code}.`,
     invalidResponse: (code) => `The response returned from the endpoint violates its specification for the HTTP status ${code}.`,
     invalidFormat: (format) => `must match format "${format}" (format)`
@@ -77,6 +77,9 @@ function convertValidationErrors(section, data, validationErrors) {
     // For each error
     for (const e of validationErrors) {
         let message = '';
+        let pattern;
+        let value;
+        let reason;
         // Normalize the key
         let key = e.dataPath;
         if (key.startsWith('.')) {
@@ -121,8 +124,8 @@ function convertValidationErrors(section, data, validationErrors) {
                 message = exports.validationMessagesFormatters.enum(e.params.allowedValues);
                 break;
             case 'pattern':
-                const pattern = e.params.pattern;
-                const value = utils_1.get(data, key);
+                pattern = e.params.pattern;
+                value = utils_1.get(data, key);
                 if (pattern === '.+' && !value) {
                     message = exports.validationMessagesFormatters.presentString();
                 }
@@ -131,7 +134,7 @@ function convertValidationErrors(section, data, validationErrors) {
                 }
                 break;
             case 'format':
-                let reason = e.params.format;
+                reason = e.params.format;
                 // Normalize the key
                 if (reason === 'date-time') {
                     reason = 'timestamp';
@@ -140,15 +143,15 @@ function convertValidationErrors(section, data, validationErrors) {
                 break;
         }
         // No custom message was found, default to input one replacing the starting verb and adding some path info
-        if (!message) {
+        if (!message.length) {
             message = `${e.message.replace(/^should/, 'must')} (${e.keyword})`;
         }
         // Find the property to add
         let property = key
             .replace(/\[(\d+)\]/g, '.$1') // Array path
             .replace(/\[([^\]]+)\]/g, '.$1'); // Object path
         // Remove useless quotes
-        if (property.match(/(?:^['"])(?:[^\.]+)(?:['"]$)/)) {
+        if (property.match(/(?:^['"])(?:[^.]+)(?:['"]$)/)) {
             property = property.substring(1, property.length - 1);
         }
         // Fix empty properties

package.json

@@ -25,37 +25,32 @@
   "typings": "types/index.d.ts",
   "types": "types/index.d.ts",
   "scripts": {
-    "lint": "tslint --project tsconfig.test.json -t stylish src/*.ts test/*.ts",
-    "test": "jest test --verbose --coverage --coverageReporters=html --coverageReporters=text",
-    "ci": "yarn lint && jest --coverage --coverageThreshold='{\"global\":{\"branches\":90,\"functions\":90,\"lines\":90,\"statements\":90}}' --ci --coverageReporters=json",
+    "lint": "eslint src/*.ts test/*.ts",
+    "test": "tap --reporter=spec --coverage-report=html --coverage-report=text --no-browser test/*.test.ts",
+    "ci": "yarn lint && tap --no-color --reporter=spec --coverage-report=json --coverage-report=text --branches 90 --functions 90 --lines 90 --statements 90 test/*.test.ts",
     "prebuild": "rm -rf lib/* types/* && yarn lint",
     "build": "tsc -p .",
     "prepublishOnly": "yarn ci",
     "postpublish": "git push origin && git push origin -f --tags"
   },
   "dependencies": {
-    "ajv": "^6.10.2",
-    "fastify-plugin": "^1.6.0",
+    "ajv": "^6.12.0",
+    "fastify-plugin": "^1.6.1",
     "http-errors": "^1.7.3",
     "http-status-codes": "^1.4.0",
     "statuses": "^1.5.0"
   },
   "devDependencies": {
-    "@cowtech/tslint-config": "^5.13.0",
-    "@types/http-errors": "^1.6.2",
-    "@types/jest": "^24.0.23",
-    "@types/node": "^12.12.8",
+    "@cowtech/eslint-config": "^6.8.4",
+    "@types/http-errors": "^1.6.3",
+    "@types/node": "^13.9.0",
     "@types/statuses": "^1.5.0",
-    "fastify": "^2.10.0",
-    "jest": "^24.9.0",
-    "jest-additional-expectations": "^0.1.0",
+    "fastify": "^2.12.1",
     "prettier": "^1.19.1",
-    "ts-jest": "^24.1.0",
-    "tslint": "^5.20.1",
-    "typescript": "^3.7.2"
+    "tap": "^14.10.6",
+    "typescript": "^3.8.3"
   },
-  "jest": {
-    "preset": "ts-jest",
-    "watchman": false
+  "engines": {
+    "node": ">=12.15.0"
   }
 }

src/handlers.ts

@@ -82,7 +82,7 @@ export function handleErrors(
   // Send the error back
   reply
     .code(statusCode)
-    .headers(headers || {})
+    .headers(headers ?? {})
     .type('application/json')
     .send(body)
 }

src/index.ts

@@ -1,7 +1,9 @@
 import Ajv from 'ajv'
 import { FastifyInstance, RegisterOptions } from 'fastify'
 import fastifyPlugin from 'fastify-plugin'
-import { IncomingMessage, Server, ServerResponse } from 'http'
+import { IncomingMessage, Server as HttpServer, ServerResponse } from 'http'
+import { Http2Server, Http2ServerRequest, Http2ServerResponse } from 'http2'
+import { Server as HttpsServer } from 'https'
 import { handleErrors, handleNotFoundError } from './handlers'
 import { addResponseValidation } from './validation'
 
@@ -10,10 +12,26 @@ export * from './interfaces'
 export { addAdditionalProperties, serializeError } from './properties'
 export { convertValidationErrors, niceJoin, validationMessagesFormatters } from './validation'
 
+export interface Options<
+  S extends HttpServer | HttpsServer | Http2Server = HttpServer,
+  I extends IncomingMessage | Http2ServerRequest = IncomingMessage,
+  R extends ServerResponse | Http2ServerResponse = ServerResponse
+> extends RegisterOptions<S, I, R> {
+  hideUnhandledErrors?: boolean
+  convertValidationErrors?: boolean
+  convertResponsesValidationErrors?: boolean
+}
+
+export type Plugin<
+  S extends HttpServer | HttpsServer | Http2Server = HttpServer,
+  I extends IncomingMessage | Http2ServerRequest = IncomingMessage,
+  R extends ServerResponse | Http2ServerResponse = ServerResponse
+> = (fastify: FastifyInstance<S, I, R>, options: Options<S, I, R>) => void
+
 export const plugin = fastifyPlugin(
-  function<S = Server, I = IncomingMessage, R = ServerResponse>(
-    instance: FastifyInstance,
-    options: RegisterOptions<S, I, R>,
+  function(
+    instance: FastifyInstance<HttpServer, IncomingMessage, ServerResponse>,
+    options: Options<HttpServer, IncomingMessage, ServerResponse>,
     done: () => void
   ): void {
     const isProduction = process.env.NODE_ENV === 'production'
@@ -46,5 +64,6 @@ export const plugin = fastifyPlugin(
   { name: 'fastify-errors-properties' }
 )
 
+export default plugin as Plugin
 module.exports = plugin
 Object.assign(module.exports, exports)

src/interfaces.ts

@@ -2,7 +2,10 @@ import { Ajv, ValidateFunction } from 'ajv'
 import { FastifyInstance, FastifyReply, FastifyRequest } from 'fastify'
 import { ServerResponse } from 'http'
 
-export type GenericObject = { [key: string]: any }
+export interface GenericObject {
+  [key: string]: any
+}
+
 export type NodeError = NodeJS.ErrnoException
 
 export type RequestSection = 'params' | 'query' | 'querystring' | 'headers' | 'body' | 'response'