chore: Updated dependencies and toolchain.

Author: ShogunPanda

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
         with:
           version: latest
       - name: Install dependencies
-        run: pnpm install
+        run: pnpm install --shamefully-hoist
       - name: Run Tests
         run: pnpm run ci
       - name: Upload coverage to Codecov

package.json

@@ -27,38 +27,42 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "dev": "swc --delete-dir-on-start -s -w -d dist src",
-    "prebuild": "rm -rf dist && npm run lint",
-    "build": "swc -d dist src",
-    "postbuild": "tsc -p . --emitDeclarationOnly",
+    "build": "swc --delete-dir-on-start -d dist src",
+    "postbuild": "concurrently npm:lint npm:typecheck",
     "format": "prettier -w src test",
-    "lint": "eslint src test",
-    "test": "c8 -c test/config/c8-local.json tap --rcfile=test/config/tap.yml test/*.test.ts",
-    "test:ci": "c8 -c test/config/c8-ci.json tap --rcfile=test/config/tap.yml --no-color test/*.test.ts",
+    "lint": "eslint --cache --ext .js,.jsx,.ts,.tsx src test",
+    "typecheck": "tsc -p . --emitDeclarationOnly",
+    "test": "c8 -c test/config/c8-local.json tap test/*.test.ts",
+    "test:ci": "c8 -c test/config/c8-ci.json tap --no-color test/*.test.ts",
     "ci": "npm run build && npm run test:ci",
     "prepublishOnly": "npm run ci",
     "postpublish": "git push origin && git push origin -f --tags"
   },
   "dependencies": {
-    "ajv": "^8.11.2",
-    "fastify-plugin": "^4.3.0",
-    "http-errors-enhanced": "^1.0.13"
+    "ajv": "^8.12.0",
+    "fastify-plugin": "^4.5.1",
+    "http-errors-enhanced": "^1.1.2"
   },
   "devDependencies": {
-    "@cowtech/eslint-config": "^8.8.0",
-    "@swc/cli": "^0.1.57",
-    "@swc/core": "^1.3.19",
-    "@types/node": "^18.11.9",
-    "@types/tap": "^15.0.7",
+    "@cowtech/eslint-config": "^8.10.0",
+    "@swc/cli": "^0.1.62",
+    "@swc/core": "^1.3.94",
+    "@types/node": "^20.8.7",
+    "@types/tap": "^15.0.10",
     "ajv-formats": "^2.1.1",
-    "c8": "^7.12.0",
+    "c8": "^8.0.1",
     "chokidar": "^3.5.3",
-    "fastify": "^4.10.2",
-    "prettier": "^2.8.0",
-    "tap": "^16.3.2",
+    "concurrently": "^8.2.2",
+    "fastify": "^4.24.3",
+    "prettier": "^3.0.3",
+    "tap": "^18.5.2",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.3"
+    "typescript": "^5.2.2"
   },
   "engines": {
-    "node": ">=14.15.0"
+    "node": ">= 18.18.0"
+  },
+  "tap": {
+    "extends": "./test/config/tap.yml"
   }
 }

src/handlers.ts

@@ -1,19 +1,24 @@
-import { FastifyError, FastifyReply, FastifyRequest } from 'fastify'
+import { type FastifyError, type FastifyReply, type FastifyRequest } from 'fastify'
 import {
   BadRequestError,
-  HttpError,
   INTERNAL_SERVER_ERROR,
   InternalServerError,
   NotFoundError,
   UnprocessableEntityError,
   UnsupportedMediaTypeError,
   addAdditionalProperties,
   messagesByCodes,
-  serializeError
+  serializeError,
+  type HttpError
 } from 'http-errors-enhanced'
-import { GenericObject, NodeError, RequestSection, kHttpErrorsEnhancedConfiguration } from './interfaces.js'
+import {
+  kHttpErrorsEnhancedConfiguration,
+  type GenericObject,
+  type NodeError,
+  type RequestSection
+} from './interfaces.js'
 import { upperFirst } from './utils.js'
-import { ValidationResult, convertValidationErrors, validationMessagesFormatters } from './validation.js'
+import { convertValidationErrors, validationMessagesFormatters, type ValidationResult } from './validation.js'
 
 export function handleNotFoundError(request: FastifyRequest, reply: FastifyReply): void {
   handleErrors(new NotFoundError('Not found.'), request, reply)
@@ -65,7 +70,12 @@ export function handleErrors(error: FastifyError | Error, request: FastifyReques
     error = new UnsupportedMediaTypeError(upperFirst(validationMessagesFormatters.contentType()))
   } else if (code === 'FST_ERR_CTP_EMPTY_JSON_BODY') {
     error = new BadRequestError(upperFirst(validationMessagesFormatters.jsonEmpty()))
-  } else if (code === 'MALFORMED_JSON' || error.message === 'Invalid JSON' || error.stack!.includes('at JSON.parse')) {
+  } else if (
+    code === 'MALFORMED_JSON' ||
+    error.name === 'SyntaxError' ||
+    error.message === 'Invalid JSON' ||
+    error.stack!.includes('at JSON.parse')
+  ) {
     error = new BadRequestError(upperFirst(validationMessagesFormatters.json()))
   }
 

src/index.ts

@@ -1,8 +1,8 @@
-import { FastifyError, FastifyInstance, FastifyPluginOptions } from 'fastify'
+import { type FastifyError, type FastifyInstance, type FastifyPluginOptions } from 'fastify'
 import fastifyPlugin from 'fastify-plugin'
 import { handleErrors, handleNotFoundError } from './handlers.js'
 import {
-  Configuration,
+  type Configuration,
   kHttpErrorsEnhancedConfiguration,
   kHttpErrorsEnhancedResponseValidations
 } from './interfaces.js'

src/interfaces.ts

@@ -1,5 +1,6 @@
-import Ajv, { ValidateFunction } from 'ajv'
-import { FastifyError } from 'fastify'
+import { type ValidateFunction } from 'ajv'
+import type Ajv from 'ajv'
+import { type FastifyError } from 'fastify'
 
 export const kHttpErrorsEnhancedConfiguration = Symbol('fastify-http-errors-enhanced-configuration')
 export const kHttpErrorsEnhancedResponseValidations = Symbol('fastify-http-errors-enhanced-response-validation')
@@ -23,22 +24,14 @@ declare module 'fastify' {
   }
 }
 
-export interface GenericObject {
-  [key: string]: any
-}
+export type GenericObject = Record<string, any>
 
 export type NodeError = NodeJS.ErrnoException
 
 export type RequestSection = 'params' | 'query' | 'querystring' | 'headers' | 'body' | 'response'
 
-export interface ResponseSchemas {
-  [key: string]: ValidateFunction
-}
+export type ResponseSchemas = Record<string, ValidateFunction>
 
-export interface Validations {
-  [key: string]: {
-    [key: string]: string
-  }
-}
+export type Validations = Record<string, Record<string, string>>
 
 export type ValidationFormatter = (...args: any[]) => string

src/validation.ts

@@ -1,19 +1,24 @@
 import Ajv from 'ajv'
-import * as fastify from 'fastify'
-import { FastifyInstance, FastifyReply, FastifyRequest, RouteOptions } from 'fastify'
-import { InternalServerError, INTERNAL_SERVER_ERROR } from 'http-errors-enhanced'
 import {
-  Configuration,
+  type FastifyInstance,
+  type FastifyReply,
+  type FastifyRequest,
+  type ValidationResult as FastifyValidationResult,
+  type RouteOptions
+} from 'fastify'
+import { INTERNAL_SERVER_ERROR, InternalServerError } from 'http-errors-enhanced'
+import {
   kHttpErrorsEnhancedConfiguration,
   kHttpErrorsEnhancedResponseValidations,
-  RequestSection,
-  ResponseSchemas,
-  ValidationFormatter,
-  Validations
+  type Configuration,
+  type RequestSection,
+  type ResponseSchemas,
+  type ValidationFormatter,
+  type Validations
 } from './interfaces.js'
 import { get } from './utils.js'
 
-export interface ValidationResult extends fastify.ValidationResult {
+export interface ValidationResult extends FastifyValidationResult {
   dataPath: any
   instancePath: string
 }
@@ -31,7 +36,7 @@ export function niceJoin(array: string[], lastSeparator: string = ' and ', separ
   }
 }
 
-export const validationMessagesFormatters: { [key: string]: ValidationFormatter } = {
+export const validationMessagesFormatters: Record<string, ValidationFormatter> = {
   contentType: () =>
     'only JSON payloads are accepted. Please set the "Content-Type" header to start with "application/json"',
   json: () => 'the body payload is not a valid JSON',
@@ -91,10 +96,10 @@ export const validationMessagesFormatters: { [key: string]: ValidationFormatter
 
 export function convertValidationErrors(
   section: RequestSection,
-  data: { [key: string]: unknown },
+  data: Record<string, unknown>,
   validationErrors: ValidationResult[]
 ): Validations {
-  const errors: { [key: string]: string } = {}
+  const errors: Record<string, string> = {}
 
   if (section === 'querystring') {
     section = 'query'
@@ -217,7 +222,7 @@ export function addResponseValidation(this: FastifyInstance, route: RouteOptions
   this[kHttpErrorsEnhancedResponseValidations].push([
     this,
     validators,
-    Object.entries(route.schema.response as { [key: string]: object })
+    Object.entries(route.schema.response as Record<string, object>)
   ])
 
   // Note that this hook is not called for non JSON payloads therefore validation is not possible in such cases
@@ -232,29 +237,33 @@ export function addResponseValidation(this: FastifyInstance, route: RouteOptions
 
     // Never validate error 500
     if (statusCode === INTERNAL_SERVER_ERROR) {
-      return done(null, payload)
+      done(null, payload)
+      return
     }
 
     // No validator, it means the HTTP status is not allowed
     const validator = validators[statusCode]
 
     if (!validator) {
       if (request[kHttpErrorsEnhancedConfiguration]!.allowUndeclaredResponses) {
-        return done(null, payload)
+        done(null, payload)
+        return
       }
 
-      return done(new InternalServerError(validationMessagesFormatters.invalidResponseCode(statusCode)))
+      done(new InternalServerError(validationMessagesFormatters.invalidResponseCode(statusCode)))
+      return
     }
 
     // Now validate the payload
     const valid = validator(payload)
 
     if (!valid) {
-      return done(
+      done(
         new InternalServerError(validationMessagesFormatters.invalidResponse(statusCode), {
           failedValidations: convertValidationErrors('response', payload, validator.errors as ValidationResult[])
         })
       )
+      return
     }
 
     done(null, payload)
@@ -263,7 +272,7 @@ export function addResponseValidation(this: FastifyInstance, route: RouteOptions
 
 export function compileResponseValidationSchema(this: FastifyInstance, configuration: Configuration): void {
   // Fix CJS/ESM interoperability
-  // @ts-expect-error
+  // @ts-expect-error Fix types
   let AjvConstructor = Ajv as Ajv & { default?: Ajv }
 
   if (AjvConstructor.default) {
@@ -273,7 +282,7 @@ export function compileResponseValidationSchema(this: FastifyInstance, configura
   const hasCustomizer = typeof configuration.responseValidatorCustomizer === 'function'
 
   for (const [instance, validators, schemas] of this[kHttpErrorsEnhancedResponseValidations]) {
-    // @ts-expect-error
+    // @ts-expect-error Fix types
     const compiler = new AjvConstructor({
       // The fastify defaults, with the exception of removeAdditional and coerceTypes, which have been reversed
       removeAdditional: false,

test/config/tap.yml

@@ -1,7 +1,7 @@
 ---
 jobs: 5
 timeout: 60
-reporter: spec
-coverage: false
+disable-coverage: true
+allow-empty-coverage: true
 node-arg:
   - --loader=ts-node/esm

test/hooks.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-floating-promises */
 
-import fastify, { FastifyError, FastifyInstance, FastifyPluginOptions } from 'fastify'
+import fastify, { type FastifyError, type FastifyInstance, type FastifyPluginOptions } from 'fastify'
 import { INTERNAL_SERVER_ERROR } from 'http-errors-enhanced'
 import t from 'tap'
 import { plugin as fastifyHttpErrorsEnhanced } from '../src/index.js'

test/index.test.ts

@@ -1,6 +1,11 @@
 /* eslint-disable @typescript-eslint/no-floating-promises */
 
-import fastify, { FastifyInstance, FastifyPluginOptions, FastifyReply, FastifyRequest } from 'fastify'
+import fastify, {
+  type FastifyInstance,
+  type FastifyPluginOptions,
+  type FastifyReply,
+  type FastifyRequest
+} from 'fastify'
 import {
   BAD_GATEWAY,
   BAD_REQUEST,
@@ -560,7 +565,8 @@ t.test('Plugin', t => {
 
       t.same(payload, {
         error: 'Internal Server Error',
-        message: '[Error] params/id must be number',
+        message: '[FST_ERR_VALIDATION] params/id must be number',
+        code: 'FST_ERR_VALIDATION',
         statusCode: INTERNAL_SERVER_ERROR,
         validation: [
           {
@@ -631,7 +637,8 @@ t.test('Plugin', t => {
 
       t.same(payload, {
         error: 'Internal Server Error',
-        message: '[Error] params/id must be number',
+        message: '[FST_ERR_VALIDATION] params/id must be number',
+        code: 'FST_ERR_VALIDATION',
         statusCode: INTERNAL_SERVER_ERROR,
         validation: [
           {

test/validation.test.ts

@@ -2,11 +2,16 @@
 
 import Ajv from 'ajv'
 import addFormats from 'ajv-formats'
-import fastify, { FastifyInstance, FastifyPluginOptions, FastifyReply, FastifyRequest } from 'fastify'
+import fastify, {
+  type FastifyInstance,
+  type FastifyPluginOptions,
+  type FastifyReply,
+  type FastifyRequest
+} from 'fastify'
 import { ACCEPTED, INTERNAL_SERVER_ERROR, OK } from 'http-errors-enhanced'
 import t from 'tap'
 import { convertValidationErrors, niceJoin, plugin as fastifyErrorProperties } from '../src/index.js'
-import { ValidationResult } from '../src/validation.js'
+import { type ValidationResult } from '../src/validation.js'
 
 async function buildServer(options: FastifyPluginOptions = {}): Promise<FastifyInstance> {
   const server = fastify()

tsconfig.json

@@ -17,5 +17,7 @@
     "strictNullChecks": true,
     "useUnknownInCatchVariables": false
   },
-  "include": ["src/*.ts"]
+  "include": [
+    "src/*.ts"
+  ]
 }