feat: exposed coerced query parameters to other hooks

Author: restfulhead

README.md

@@ -3,5 +3,5 @@
 This mono repository contains libraries for implementing APIs. It contains the following sub-packages:
 
 * [ajv-openapi-request-response-validator](./packages/ajv-openapi-request-response-validator/README.md): Validation of http request and responses against an OpenAPI schema.
-* [azure-functions-openapi-validator](./packages/azure-functions-openapi-validator/): Azure functions v4 middleware that uses the openapi validator
+* [azure-functions-openapi-validator](./packages/azure-functions-openapi-validator/README.md): Azure functions v4 middleware that uses the openapi validator
 * [azure-functions-openapi-validator-example](./packages/azure-functions-openapi-validator-example/README.md): Example Azure functions v4 app that uses the middleware

packages/ajv-openapi-request-response-validator/README.md

@@ -14,7 +14,7 @@ This library contains an Open API v3.0 validator that validates http requests an
 * Does not support `readOnly` or `writeOnly`.
 * The default config sets AJV's `removeAdditional` to `false`, otherwise `allOf` validation may cause unexpected results
 * The default config sets AJV's `coerceTypes` to `false`, otherwise `anyof` validation may cause unexpected results
-  * Query params are usually string values on the other hand, to make them work this library coerces those by default prior to validation
+  * Query params are usually string values on the other hand, so this library coerces those by default prior to validation
 * This library does not validate the Open API specification itself. I suggest you use another tool for this for now.
 
 To check out what is supported, take a look at the [test fixtures](/test/fixtures/)

packages/ajv-openapi-request-response-validator/src/ajv-openapi-request-response-validator.ts

@@ -17,6 +17,7 @@ import {
   Primitive,
   isURLSearchParams,
   unserializeParameters,
+  STRICT_COERCION_STRATEGY,
 } from './openapi-validator'
 import { merge, openApiMergeRules } from 'allof-merge'
 
@@ -111,7 +112,7 @@ export class AjvOpenApiValidator {
     origParams: Record<string, Primitive> | URLSearchParams,
     strict = true,
     logger?: Logger
-  ): ErrorObj[] | undefined {
+  ): { normalizedParams: Record<string, Primitive>; errors: ErrorObj[] | undefined } {
     const parameterDefinitions = this.paramsValidators.filter((p) => p.path === path?.toLowerCase() && p.method === method?.toLowerCase())
 
     const log = logger ? logger : this.validatorOpts.logger
@@ -196,7 +197,7 @@ export class AjvOpenApiValidator {
         })
     }
 
-    return errResponse.length ? errResponse : undefined
+    return { normalizedParams: params, errors: errResponse.length ? errResponse : undefined }
   }
 
   validateRequestBody(path: string, method: string, data: unknown, strict = true, logger?: Logger): ErrorObj[] | undefined {
@@ -274,7 +275,7 @@ export class AjvOpenApiValidator {
     return undefined
   }
 
-  private initialize(origSpec: OpenAPIV3.Document, coerceTypes: boolean): void {
+  private initialize(origSpec: OpenAPIV3.Document, coerceTypes: boolean | 'strict'): void {
     const schemaCompileFailures: string[] = []
     const spec: OpenAPIV3.Document = merge(origSpec, { rules: openApiMergeRules() })
 
@@ -478,14 +479,15 @@ export class AjvOpenApiValidator {
               }
             })
 
-            if (this.validatorOpts.coerceTypes == true && resolvedParams.length > 0) {
+            if (this.validatorOpts.coerceTypes && resolvedParams.length > 0) {
               this.requestCoercers.push({
                 path: path.toLowerCase(),
                 method: method.toLowerCase() as string,
                 coercer: new OpenapiRequestCoercer({
                   logger: this.validatorOpts.logger,
                   enableObjectCoercion: true,
                   parameters: resolvedParams,
+                  coercionStrategy: this.validatorOpts.coerceTypes === 'strict' ? STRICT_COERCION_STRATEGY : undefined,
                 }),
               })
             }