feat: add support for array-valsan (endpoint responses)

Author: DrewImm

package-lock.json

@@ -22,11 +22,11 @@
 		"publish": "npm run script -- publish"
 	},
 	"dependencies": {
-		"auto-oas": "^1.2.1",
+		"auto-oas": "^1.3.0",
 		"cors": "^2.8.5",
 		"express": "^5.1.0",
 		"swagger-ui-express": "^5.0.1",
-		"valsan": "^2.2.0"
+		"valsan": "^2.3.0"
 	},
 	"devDependencies": {
 		"@istanbuljs/nyc-config-typescript": "^1.0.2",
@@ -52,7 +52,7 @@
 		"typescript": "~5.4.2"
 	},
 	"peerDependencies": {
-		"valsan": "^2.2.0"
+		"valsan": "^2.3.0"
 	},
 	"repository": {
 		"type": "git",

package.json

@@ -1,4 +1,4 @@
-import { ObjectSanitizer } from 'valsan';
+import { ObjectSanitizer, ObjectValSan, ArrayValSan } from 'valsan';
 import { SchemaObject } from 'auto-oas/oas/v3.1';
 
 import { BaseApiEndpoint } from '../router';
@@ -41,7 +41,7 @@ export class OasEndpointComponentConverter {
 		example,
 	}: {
 		name: string;
-		sanitizer: ObjectSanitizer;
+		sanitizer: ObjectSanitizer | ObjectValSan | ArrayValSan;
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
 		example?: any;
 	}) {

src/oas/oas-endpoint-component-converter.ts

@@ -1,4 +1,4 @@
-import { ObjectSanitizer } from 'valsan';
+import { ObjectSanitizer, ObjectValSan } from 'valsan';
 import {
 	PathItemObject,
 	ParameterObject,
@@ -122,7 +122,7 @@ export class OasEndpointConverter {
 		example,
 	}: {
 		location: 'path' | 'query' | 'header';
-		sanitizer?: ObjectSanitizer;
+		sanitizer?: ObjectSanitizer | ObjectValSan;
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
 		example?: any;
 	}) {

src/oas/oas-endpoint-converter.ts

@@ -10,6 +10,7 @@ import { ObjectSanitizer } from 'valsan/object-sanitizer';
 import { BaseApiRoute } from './base';
 import { validateRequest } from './validation-middleware';
 import { BadRequestError, HTTPError, UnprocessableEntityError } from '../error';
+import { ArrayValSan, ObjectValSan } from 'valsan';
 
 export type ApiRequest = ExpressRequest;
 export type ApiResponse = ExpressResponse;
@@ -33,23 +34,23 @@ export abstract class BaseApiEndpoint extends BaseApiRoute {
 	public method: EndpointMethod = EndpointMethod.GET;
 	public statusCode: number = 200;
 
-	public body?: ObjectSanitizer;
+	public body?: ObjectSanitizer | ObjectValSan;
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public bodyExample?: any;
 
-	public query?: ObjectSanitizer;
+	public query?: ObjectSanitizer | ObjectValSan;
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public queryExample?: any;
 
-	public params?: ObjectSanitizer;
+	public params?: ObjectSanitizer | ObjectValSan;
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public paramsExample?: any;
 
-	public headers?: ObjectSanitizer;
+	public headers?: ObjectSanitizer | ObjectValSan;
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public headersExample?: any;
 
-	public response?: ObjectSanitizer;
+	public response?: ObjectSanitizer | ObjectValSan | ArrayValSan;
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public responseExample?: any;
 

src/router/endpoint.ts

@@ -1,13 +1,21 @@
-import { ObjectSanitizer } from 'valsan';
+import {
+	ArrayValSan,
+	ObjectSanitizer,
+	ObjectValSan,
+	ObjectValSanOptions,
+} from 'valsan';
 import { ApiRequest, BaseApiEndpoint } from './endpoint';
 import { UnprocessableEntityError } from '../error';
 
 /**
  * Runs a valsan ObjectSanitizer on a value,
  *  throws with error details if validation fails.
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export async function runSanitizer(sanitizer: ObjectSanitizer, value: any) {
+export async function runSanitizer(
+	sanitizer: ObjectSanitizer | ObjectValSan | ArrayValSan,
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	value: any
+) {
 	const result = await sanitizer.run(value);
 
 	if (!result.success) {
@@ -35,6 +43,12 @@ export async function validateRequest(
 			continue;
 		}
 
+		if (part === 'headers' && 'options' in sanitizer) {
+			(
+				sanitizer.options as ObjectValSanOptions
+			).allowAdditionalProperties = true;
+		}
+
 		const sanitized = await runSanitizer(sanitizer, request[part]);
 
 		if (part === 'query') {