@dvsa/appdev-api-common 0.4.1 → 0.4.3

package/package.json

@@ -1,53 +1,50 @@
 {
-  "name": "@dvsa/appdev-api-common",
-  "version": "0.4.1",
-  "keywords": [
-    "dvsa",
-    "nodejs",
-    "typescript"
-  ],
-  "author": "DVSA",
-  "description": "Utils library for common API functionality",
-  "publishConfig": {
-    "directory": "dist",
-    "access": "public"
-  },
-  "scripts": {
-    "localLink": "npm run clean && npm version patch && npm run build && cp package.json dist && cd dist && npm link",
-    "clean": "rimraf coverage dist",
-    "clean:temp": "rimraf auth api",
-    "lint": "biome check src",
-    "lint:fix": "npm run lint -- --write",
-    "build": "npm run clean && tsc",
-    "build:package": "npm run build",
-    "test": "jest",
-    "test:coverage": "jest --coverage",
-    "prepublishOnly": "npm run build:package && cp -r ./dist/* . && rm -rf ./dist",
-    "postpublish": "git clean -fd && npm run clean:temp",
-    "gitSecrets": "git secrets --scan . && git log -p -- . | scanrepo"
-  },
-  "dependencies": {
-    "ajv": "^8.17.1",
-    "dayjs": "^1.11.13",
-    "jose": "^5.9.6"
-  },
-  "devDependencies": {
-    "@biomejs/biome": "1.9.3",
-    "@dvsa/biome-config": "0.3.0",
-    "@types/aws-lambda": "^8.10.145",
-    "@types/express": "^5.0.0",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.14.8",
-    "husky": "^9.1.6",
-    "jest": "^29.7.0",
-    "lint-staged": "^15.2.10",
-    "rimraf": "^6.0.1",
-    "routing-controllers": "^0.11.2",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.5.2"
-  },
-  "lint-staged": {
-    "*.{js,ts,mjs,css,md,ts,json}": "npm run lint:fix -- --no-errors-on-unmatched"
-  }
+	"name": "@dvsa/appdev-api-common",
+	"version": "0.4.3",
+	"keywords": ["dvsa", "nodejs", "typescript"],
+	"author": "DVSA",
+	"description": "Utils library for common API functionality",
+	"publishConfig": {
+		"directory": "dist",
+		"access": "public"
+	},
+	"scripts": {
+		"localLink": "npm run clean && npm version patch && npm run build && cp package.json dist && cd dist && npm link",
+		"clean": "rimraf coverage dist",
+		"clean:temp": "rimraf auth api",
+		"lint": "biome check src",
+		"lint:fix": "npm run lint -- --write",
+		"build": "npm run clean && tsc",
+		"build:package": "npm run build",
+		"test": "jest",
+		"test:coverage": "jest --coverage",
+		"prepublishOnly": "npm run build:package && cp -r ./dist/* . && rm -rf ./dist",
+		"postpublish": "git clean -fd && npm run clean:temp",
+		"gitSecrets": "git secrets --scan . && git log -p -- . | scanrepo"
+	},
+	"dependencies": {
+		"ajv": "^8.17.1",
+		"ajv-formats": "^3.0.1",
+		"dayjs": "^1.11.13",
+		"jose": "^5.9.6"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "1.9.3",
+		"@dvsa/biome-config": "0.3.0",
+		"@types/aws-lambda": "^8.10.145",
+		"@types/express": "^5.0.0",
+		"@types/jest": "^29.5.14",
+		"@types/node": "^20.14.8",
+		"husky": "^9.1.7",
+		"jest": "^29.7.0",
+		"lint-staged": "^15.2.10",
+		"rimraf": "^6.0.1",
+		"routing-controllers": "^0.11.2",
+		"ts-jest": "^29.2.5",
+		"ts-node": "^10.9.2",
+		"typescript": "^5.5.2"
+	},
+	"lint-staged": {
+		"*.{js,ts,mjs,css,md,ts,json}": "npm run lint:fix -- --no-errors-on-unmatched"
+	}
 }

package/validation/request-body.js

@@ -5,8 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ValidateRequestBody = ValidateRequestBody;
 const ajv_1 = __importDefault(require("ajv"));
+const ajv_formats_1 = __importDefault(require("ajv-formats"));
 const http_status_codes_1 = require("../api/http-status-codes");
+const validation_error_1 = require("./validation-error");
 const ajv = new ajv_1.default({ removeAdditional: true, allErrors: true });
+(0, ajv_formats_1.default)(ajv);
 ajv.addKeyword("tsEnumNames");
 /**
  * Decorator tp validate an express request body against a specified schema
@@ -15,15 +18,15 @@ ajv.addKeyword("tsEnumNames");
  * - isArray: whether the body is expected to be an array
  * - errorDetails: whether to return detailed error messages (Note: errors are logged regardless of this setting)
  */
-function ValidateRequestBody(schema, opts = { isArray: false, errorDetails: false }) {
+function ValidateRequestBody(schema, opts = { isArray: false, errorDetails: true }) {
     return (_target, _propertyKey, descriptor) => {
         const originalMethod = descriptor.value;
-        descriptor.value = async function (body, res, next) {
+        // biome-ignore lint/suspicious/noExplicitAny: tuples should be any in this instance
+        descriptor.value = async function (...args) {
+            const [body] = args;
             // just to be safe, check the bodies existence before attempting to validate it
             if (!body) {
-                return res
-                    .status(http_status_codes_1.HttpStatus.BAD_REQUEST)
-                    .json({ message: "No request body detected" });
+                throw new validation_error_1.ValidationError(http_status_codes_1.HttpStatus.BAD_REQUEST, "No request body detected");
             }
             const payload = Buffer.isBuffer(body)
                 ? JSON.parse(body.toString("utf-8"))
@@ -37,17 +40,12 @@ function ValidateRequestBody(schema, opts = { isArray: false, errorDetails: fals
             const isValid = validateFunction(payload);
             // if an error exists, then return a 400 with details
             if (!isValid) {
+                console.error("Validation failed on body:", JSON.stringify(body));
                 console.error(validateFunction.errors);
-                const response = {
-                    message: "Validation error",
-                };
-                if (opts?.errorDetails) {
-                    Object.assign(response, { errors: validateFunction.errors });
-                }
-                return res.status(http_status_codes_1.HttpStatus.BAD_REQUEST).json(response);
+                throw new validation_error_1.ValidationError(http_status_codes_1.HttpStatus.BAD_REQUEST, "Validation failed", opts?.errorDetails ? validateFunction.errors : null);
             }
             // proceed with attached method if schema is valid
-            return originalMethod.apply(this, [body, res, next]);
+            return originalMethod.apply(this, args);
         };
     };
 }

package/validation/validation-error.d.ts

@@ -0,0 +1,14 @@
+import { HttpStatus } from "../api/http-status-codes";
+export declare class ValidationError extends Error {
+    private readonly statusCode;
+    private readonly details;
+    constructor(statusCode?: HttpStatus, message?: string, details?: unknown | null);
+    toJSON(): {
+        error: {
+            name: string;
+            message: string;
+            details: unknown;
+            statusCode: number;
+        };
+    };
+}

package/validation/validation-error.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationError = void 0;
+const http_status_codes_1 = require("../api/http-status-codes");
+class ValidationError extends Error {
+    statusCode;
+    details;
+    constructor(statusCode = http_status_codes_1.HttpStatus.BAD_REQUEST, message = "Validation failed", details = null) {
+        super(message);
+        this.statusCode = statusCode;
+        this.details = details;
+        this.name = "ValidationError";
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, ValidationError);
+        }
+    }
+    toJSON() {
+        return {
+            error: {
+                name: this.name,
+                message: this.message,
+                details: this.details,
+                statusCode: this.statusCode,
+            },
+        };
+    }
+}
+exports.ValidationError = ValidationError;