Merge pull request #266 from trojs/feature/custom-ajv-validator-v1

Add option to customize the ajv validator

package.json

@@ -1,7 +1,7 @@
 {
     "name": "@trojs/openapi-server",
     "description": "OpenAPI Server",
-    "version": "1.6.1",
+    "version": "1.7.0",
     "author": {
         "name": "Pieter Wigboldus",
         "url": "https://trojs.org/"
@@ -80,8 +80,8 @@
         "url": "https://github.com/sponsors/w3nl"
     },
     "overrides": {
-        "semver": "^7.5.3",
-        "send": "^0.19.0",
+        "semver@<=7.5.3": "^7.5.3",
+        "send@<=0.19.0": "^0.19.0",
         "cookie@<=0.7.0": "0.7.0"
     }
 }

src/router.js

@@ -12,6 +12,7 @@ import { unauthorized } from './handlers/unauthorized.js'
  * @typedef {import('./api.js').SecurityHandler} SecurityHandler
  * @typedef {import('./api.js').Handler} Handler
  * @typedef {import('ajv').Options} AjvOpts
+ * @typedef {import('openapi-backend').AjvCustomizer} AjvCustomizer
  */
 
 /**
@@ -27,6 +28,7 @@ import { unauthorized } from './handlers/unauthorized.js'
  * @param {SecurityHandler[]=} params.securityHandlers
  * @param {Handler=} params.unauthorizedHandler
  * @param {AjvOpts=} params.ajvOptions
+ * @param {AjvCustomizer=} params.customizeAjv
  * @param {boolean=} params.mock
  * @returns {{ api: OpenAPIBackend<any>, openAPISpecification: object }}
  */
@@ -41,17 +43,19 @@ export const setupRouter = ({
     securityHandlers = [],
     unauthorizedHandler,
     ajvOptions = {},
+    customizeAjv,
     mock
 }) => {
+    const ajvWithExtraFormats = (originalAjv) => {
+        addFormats(originalAjv)
+        return originalAjv
+    }
     const api = new OpenAPIBackend({
         definition: openAPISpecification,
         apiRoot,
         strict: strictSpecification,
         ajvOpts: ajvOptions,
-        customizeAjv: (originalAjv) => {
-            addFormats(originalAjv)
-            return originalAjv
-        }
+        customizeAjv: customizeAjv || ajvWithExtraFormats
     })
 
     api.register({

src/router.test.js

@@ -40,7 +40,14 @@ test('Test the router', async (t) => {
             const { api } = setupRouter({
                 secret: envExample.SECRET,
                 openAPISpecification,
-                controllers
+                controllers,
+                customizeAjv: (originalAjv) => {
+                    originalAjv.addKeyword('example', {
+                        validate: (schema, data) => data === 'example',
+                        errors: false
+                    })
+                    return originalAjv
+                }
             })
             const context = {
                 response: {