@trojs/openapi-server 3.5.1 → 3.6.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@trojs/openapi-server",
   "description": "OpenAPI Server",
-  "version": "3.5.1",
+  "version": "3.6.0",
   "author": {
     "name": "Pieter Wigboldus",
     "url": "https://trojs.org/"

package/src/api.js

@@ -28,6 +28,7 @@ import { setupRouter } from './router.js'
  * @property {Handler=} unauthorizedHandler
  * @property {boolean=} swagger
  * @property {boolean=} apiDocs
+ * @property {boolean=} validateResponse
  * @property {AjvOpts=} ajvOptions
  * @property {AjvCustomizer=} customizeAjv
  * @property {any[]=} middleware
@@ -57,6 +58,7 @@ export class Api {
     unauthorizedHandler,
     swagger,
     apiDocs,
+    validateResponse,
     ajvOptions,
     customizeAjv,
     middleware = []
@@ -73,6 +75,7 @@ export class Api {
     this.unauthorizedHandler = unauthorizedHandler || undefined
     this.swagger = swagger ?? true
     this.apiDocs = apiDocs ?? true
+    this.validateResponse = validateResponse ?? true
     this.ajvOptions = ajvOptions ?? { allErrors: false }
     this.customizeAjv = customizeAjv
     this.middleware = middleware
@@ -120,6 +123,7 @@ export class Api {
       meta: this.meta,
       securityHandlers: this.securityHandlers,
       unauthorizedHandler: this.unauthorizedHandler,
+      validateResponse: this.validateResponse,
       ajvOptions: this.ajvOptions,
       customizeAjv: this.customizeAjv
     })

package/src/router.js

@@ -27,6 +27,7 @@ import { unauthorized } from './handlers/unauthorized.js'
  * @param {object=} params.meta
  * @param {SecurityHandler[]=} params.securityHandlers
  * @param {Handler=} params.unauthorizedHandler
+ * @param {boolean=} params.validateResponse
  * @param {AjvOpts=} params.ajvOptions
  * @param {AjvCustomizer=} params.customizeAjv
  * @param {boolean=} params.mock
@@ -42,6 +43,7 @@ export const setupRouter = ({
   meta,
   securityHandlers = [],
   unauthorizedHandler,
+  validateResponse = true,
   ajvOptions = {},
   customizeAjv,
   mock
@@ -58,12 +60,17 @@ export const setupRouter = ({
     customizeAjv: customizeAjv || ajvWithExtraFormats
   })
 
-  api.register({
+  const handlers = {
     unauthorizedHandler: unauthorizedHandler || unauthorized,
     validationFail: requestValidation,
-    notFound,
-    postResponseHandler: makeResponseValidation(logger)
-  })
+    notFound
+  }
+
+  if (validateResponse) {
+    handlers.postResponseHandler = makeResponseValidation(logger)
+  }
+
+  api.register(handlers)
 
   operationIds({ specification: openAPISpecification }).forEach(
     (operationId) => {

package/types/api.d.ts

@@ -23,6 +23,7 @@
  * @property {Handler=} unauthorizedHandler
  * @property {boolean=} swagger
  * @property {boolean=} apiDocs
+ * @property {boolean=} validateResponse
  * @property {AjvOpts=} ajvOptions
  * @property {AjvCustomizer=} customizeAjv
  * @property {any[]=} middleware
@@ -37,7 +38,7 @@ export class Api {
      * @class
      * @param {ApiSchema} params
      */
-    constructor({ version, specification, controllers, apiRoot, strictSpecification, errorDetails, logger, meta, securityHandlers, unauthorizedHandler, swagger, apiDocs, ajvOptions, customizeAjv, middleware }: ApiSchema);
+    constructor({ version, specification, controllers, apiRoot, strictSpecification, errorDetails, logger, meta, securityHandlers, unauthorizedHandler, swagger, apiDocs, validateResponse, ajvOptions, customizeAjv, middleware }: ApiSchema);
     version: string;
     specification: object;
     controllers: object;
@@ -50,6 +51,7 @@ export class Api {
     unauthorizedHandler: Handler | undefined;
     swagger: boolean;
     apiDocs: boolean;
+    validateResponse: boolean;
     ajvOptions: import("ajv").Options;
     customizeAjv: import("openapi-backend").AjvCustomizer | undefined;
     middleware: any[];
@@ -81,6 +83,7 @@ export type ApiSchema = {
     unauthorizedHandler?: Handler | undefined;
     swagger?: boolean | undefined;
     apiDocs?: boolean | undefined;
+    validateResponse?: boolean | undefined;
     ajvOptions?: AjvOpts | undefined;
     customizeAjv?: AjvCustomizer | undefined;
     middleware?: any[] | undefined;

package/types/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.js"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH;;;GAGG;AAEH;IACE;;;;OAIG;IACH,8MAFW,SAAS,EAkCnB;IAfC,gBAAsB;IACtB,sBAAkC;IAClC,oBAA8B;IAC9B,4BAAsB;IACtB,yCAA8C;IAC9C,sBAAyC;IACzC,eAA+B;IAC/B,aAAsB;IACtB,oCAA8C;IAC9C,yCAA2D;IAC3D,iBAA8B;IAC9B,iBAA8B;IAC9B,kCAAoD;IACpD,kEAAgC;IAChC,kBAA4B;IAG9B,aAsDC;CACF;sBAjIY,OAAO,iBAAiB,EAAE,OAAO;sBACjC,OAAO,KAAK,EAAE,OAAO;4BACrB,OAAO,iBAAiB,EAAE,aAAa;;;;;;;;UAOtC,MAAM;aACN,OAAO;;;aAEP,MAAM;mBACN,MAAM;iBACN,MAAM;cACN,MAAM,YAAC;0BACP,OAAO,YAAC;mBACR,OAAO,YAAC;aACR,MAAM,YAAC;WACP,MAAM,YAAC;uBACP,eAAe,EAAE,YAAC;0BAClB,OAAO,YAAC;cACR,OAAO,YAAC;cACR,OAAO,YAAC;iBACR,OAAO,YAAC;mBACR,aAAa,YAAC;iBACd,GAAG,EAAE,YAAC"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.js"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH;;;GAGG;AAEH;IACE;;;;OAIG;IACH,gOAFW,SAAS,EAoCnB;IAhBC,gBAAsB;IACtB,sBAAkC;IAClC,oBAA8B;IAC9B,4BAAsB;IACtB,yCAA8C;IAC9C,sBAAyC;IACzC,eAA+B;IAC/B,aAAsB;IACtB,oCAA8C;IAC9C,yCAA2D;IAC3D,iBAA8B;IAC9B,iBAA8B;IAC9B,0BAAgD;IAChD,kCAAoD;IACpD,kEAAgC;IAChC,kBAA4B;IAG9B,aAuDC;CACF;sBArIY,OAAO,iBAAiB,EAAE,OAAO;sBACjC,OAAO,KAAK,EAAE,OAAO;4BACrB,OAAO,iBAAiB,EAAE,aAAa;;;;;;;;UAOtC,MAAM;aACN,OAAO;;;aAEP,MAAM;mBACN,MAAM;iBACN,MAAM;cACN,MAAM,YAAC;0BACP,OAAO,YAAC;mBACR,OAAO,YAAC;aACR,MAAM,YAAC;WACP,MAAM,YAAC;uBACP,eAAe,EAAE,YAAC;0BAClB,OAAO,YAAC;cACR,OAAO,YAAC;cACR,OAAO,YAAC;uBACR,OAAO,YAAC;iBACR,OAAO,YAAC;mBACR,aAAa,YAAC;iBACd,GAAG,EAAE,YAAC"}

package/types/router.d.ts

@@ -1,4 +1,4 @@
-export function setupRouter({ openAPISpecification, controllers, apiRoot, strictSpecification, errorDetails, logger, meta, securityHandlers, unauthorizedHandler, ajvOptions, customizeAjv, mock }: {
+export function setupRouter({ openAPISpecification, controllers, apiRoot, strictSpecification, errorDetails, logger, meta, securityHandlers, unauthorizedHandler, validateResponse, ajvOptions, customizeAjv, mock }: {
     openAPISpecification: object;
     controllers: object;
     apiRoot?: string | undefined;
@@ -8,6 +8,7 @@ export function setupRouter({ openAPISpecification, controllers, apiRoot, strict
     meta?: object | undefined;
     securityHandlers?: SecurityHandler[] | undefined;
     unauthorizedHandler?: Handler | undefined;
+    validateResponse?: boolean | undefined;
     ajvOptions?: AjvOpts | undefined;
     customizeAjv?: AjvCustomizer | undefined;
     mock?: boolean | undefined;

package/types/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.js"],"names":[],"mappings":"AAkCO,oMAdJ;IAAuB,oBAAoB,EAAnC,MAAM;IACS,WAAW,EAA1B,MAAM;IACU,OAAO,GAAvB,MAAM,YAAC;IACU,mBAAmB,GAApC,OAAO,YAAC;IACS,YAAY,GAA7B,OAAO,YAAC;IACQ,MAAM,GAAtB,MAAM,YAAC;IACS,IAAI,GAApB,MAAM,YAAC;IACoB,gBAAgB,GAA3C,eAAe,EAAE,YAAC;IACD,mBAAmB,GAApC,OAAO,YAAC;IACS,UAAU,GAA3B,OAAO,YAAC;IACe,YAAY,GAAnC,aAAa,YAAC;IACG,IAAI,GAArB,OAAO,YAAC;CAChB,GAAU;IAAE,GAAG,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC;IAAC,oBAAoB,EAAE,MAAM,CAAA;CAAE,CAoEtE;qBA1FY,OAAO,UAAU,EAAE,MAAM;8BACzB,OAAO,UAAU,EAAE,eAAe;sBAClC,OAAO,UAAU,EAAE,OAAO;sBAC1B,OAAO,KAAK,EAAE,OAAO;4BACrB,OAAO,iBAAiB,EAAE,aAAa;+BAdrB,iBAAiB"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.js"],"names":[],"mappings":"AAmCO,sNAfJ;IAAuB,oBAAoB,EAAnC,MAAM;IACS,WAAW,EAA1B,MAAM;IACU,OAAO,GAAvB,MAAM,YAAC;IACU,mBAAmB,GAApC,OAAO,YAAC;IACS,YAAY,GAA7B,OAAO,YAAC;IACQ,MAAM,GAAtB,MAAM,YAAC;IACS,IAAI,GAApB,MAAM,YAAC;IACoB,gBAAgB,GAA3C,eAAe,EAAE,YAAC;IACD,mBAAmB,GAApC,OAAO,YAAC;IACS,gBAAgB,GAAjC,OAAO,YAAC;IACS,UAAU,GAA3B,OAAO,YAAC;IACe,YAAY,GAAnC,aAAa,YAAC;IACG,IAAI,GAArB,OAAO,YAAC;CAChB,GAAU;IAAE,GAAG,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC;IAAC,oBAAoB,EAAE,MAAM,CAAA;CAAE,CA0EtE;qBAjGY,OAAO,UAAU,EAAE,MAAM;8BACzB,OAAO,UAAU,EAAE,eAAe;sBAClC,OAAO,UAAU,EAAE,OAAO;sBAC1B,OAAO,KAAK,EAAE,OAAO;4BACrB,OAAO,iBAAiB,EAAE,aAAa;+BAdrB,iBAAiB"}