snap-on-openapi 1.0.9 → 1.0.11

package/dist/OpenApi.js

@@ -185,19 +185,19 @@ export class OpenApi {
             const queryValidator = route.validators.query?.strict() ?? z.object({});
             const query = queryValidator.safeParse(req.query);
             if (!query.success) {
-                throw new ValidationError(query.error, ValidationLocation.Query);
+                throw new ValidationError(query.error, ValidationLocation.Query, req.query);
             }
             const pathvalidator = route.validators.path?.strict() ?? z.object({});
             const path = pathvalidator.safeParse(req.params);
             if (!path.success) {
-                throw new ValidationError(path.error, ValidationLocation.Path);
+                throw new ValidationError(path.error, ValidationLocation.Path, req.params);
             }
             let response;
             const containsBody = route.method !== Method.GET;
             if (containsBody && route.validators.body) {
                 const body = route.validators.body.safeParse(req.body);
                 if (!body.success) {
-                    throw new ValidationError(body.error, ValidationLocation.Body);
+                    throw new ValidationError(body.error, ValidationLocation.Body, req.body);
                 }
                 const context = await this.config.routes[route.type].contextFactory({
                     route: route,
@@ -241,9 +241,13 @@ export class OpenApi {
                 body: route.validators.response ?? z.undefined(),
                 headers: route.validators.responseHeaders?.strict() ?? z.object({}),
             });
+            if (this.config.disableResponseValidation) {
+                this.logger.info('Response: 200', finalResponse);
+                return { status: 200, body: finalResponse.body, headers: finalResponse.headers };
+            }
             const validated = finalResponseValidator.safeParse(finalResponse);
             if (!validated.success) {
-                throw new ValidationError(validated.error, ValidationLocation.Response);
+                throw new ValidationError(validated.error, ValidationLocation.Response, finalResponse);
             }
             this.logger.info('Response: 200', validated.data);
             return { status: 200, body: validated.data.body, headers: validated.data.headers };
@@ -255,7 +259,7 @@ export class OpenApi {
     handleError(e, req) {
         this.logger.error('Error during request openAPI route handling', e);
         try {
-            const response = this.config.handleError ? this.config.handleError(e, req) : this.config.defaultError;
+            const response = this.config.handleError ? this.config.handleError(e, { request: req, logger: this.logger }) : this.config.defaultError;
             const status = this.config.errors[response.code].status;
             const valid = this.config.errors[response.code].responseValidator.safeParse(response.body);
             if (!valid.success) {

package/dist/types/config/Config.d.ts

@@ -10,6 +10,7 @@ import { RouteContextMap } from './RouteContextMap.js';
 import { RouteExtraPropsMap } from './RouteExtraPropsMap.js';
 import { Server } from './Server.js';
 export type Config<TRouteTypes extends string, TErrorCodes extends string, TErrorConfigMap extends ErrorConfigMap<TErrorCodes>, TRouteParamMap extends RouteExtraPropsMap<TRouteTypes>, TRouteContextMap extends RouteContextMap<TRouteTypes, TRouteParamMap>, TRouteConfigMap extends RouteConfigMap<TRouteTypes, TErrorCodes, TRouteParamMap, TRouteContextMap>> = {
+    disableResponseValidation?: boolean;
     logger?: Logger;
     basePath: RoutePath;
     routes: TRouteConfigMap;
@@ -27,7 +28,10 @@ export type Config<TRouteTypes extends string, TErrorCodes extends string, TErro
     apiVersion?: string;
     servers?: Server[];
     logLevel?: LogLevel;
-    handleError?: (e: unknown, req: Request) => ErrorResponse<TErrorCodes, TErrorConfigMap>;
+    handleError?: (e: unknown, context: {
+        request: Request;
+        logger: Logger;
+    }) => ErrorResponse<TErrorCodes, TErrorConfigMap>;
     middleware?: <T extends TRouteTypes>(route: AnyRoute<T>, ctx: Awaited<ReturnType<TRouteContextMap[T]>>) => Promise<{
         body?: unknown;
         status?: number;

package/dist/types/errors/ValidationError.d.ts

@@ -2,9 +2,11 @@ import { ZodError } from 'zod';
 import { ValidationLocation } from '../../enums/ValidationLocations.js';
 import { BuiltInError } from './BuiltInError.js';
 export declare class ValidationError extends BuiltInError {
-    private error;
-    private location;
-    constructor(error: ZodError<unknown>, location: ValidationLocation);
+    protected error: ZodError<unknown>;
+    protected location: ValidationLocation;
+    protected data?: unknown;
+    constructor(error: ZodError<unknown>, location: ValidationLocation, data: unknown);
     getZodError(): ZodError<unknown>;
     getLocation(): ValidationLocation;
+    getData(): unknown;
 }

package/dist/types/errors/ValidationError.js

@@ -3,10 +3,12 @@ import { BuiltInError } from './BuiltInError.js';
 export class ValidationError extends BuiltInError {
     error;
     location;
-    constructor(error, location) {
+    data;
+    constructor(error, location, data) {
         super(ErrorCode.ValidationFailed);
         this.error = error;
         this.location = location;
+        this.data = data;
     }
     getZodError() {
         return this.error;
@@ -14,4 +16,7 @@ export class ValidationError extends BuiltInError {
     getLocation() {
         return this.location;
     }
+    getData() {
+        return this.data;
+    }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "snap-on-openapi",
   "author": "Alex Sarychev",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "Swiftly build type-checked OpenAPI applications with Zod and TypeScript",
   "type": "module",
   "license": "ISC",