v2.6.0 Add cache control string to the router

README.md

@@ -70,6 +70,7 @@ const routerInstance = router(server, {
   appEnv: process.ENV.APP_ENV, // optional, used to specify the env in Sentry, defaults to "unknown"
   logger: logger, // pass in the luxuryescapes logger and the error handler will use this, resulting in single line log messages in new relic with stack traces.
   sanitizeKeys: [/_token$/, /password/i, "someHideousKey", "path.with.dot"], // array of keys or paths to sanitize from the request body, query and params on error
+  cacheControlString: 'public, max-age=600', // you can pass cache directives in a ',' separated string string. Reference https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#cache_directives
 })
 
 // define routes

index.d.ts

@@ -119,6 +119,12 @@ declare module "@luxuryescapes/router" {
      * @defaultValue `{}`
      */
     jsonOptions?: { [option: string]: string | number | boolean | null | undefined };
+
+    /**
+     * Cache-Control header value
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control
+     */
+    cacheControlString?: string;
   }
 
   interface SchemaRouteOptions {

lib/middleware/cache-control.js

@@ -0,0 +1,10 @@
+module.exports = exports = ({ cacheControlString }) => {
+  return function responseCacheControl (req, res, next) {
+    const originalFunc = res.json
+    res.json = (responseBody) => {
+      res.set('Cache-Control', cacheControlString)
+      return originalFunc.call(res, responseBody)
+    }
+    next()
+  }
+}

lib/router.js

@@ -7,14 +7,15 @@ const createErrorHandler = require('./middleware/error-handler')
 const networkLogger = require('./middleware/network-logger')
 const requestValidator = require('./middleware/request-validator')
 const responseValidator = require('./middleware/response-validator')
+const responseCacheControl = require('./middleware/cache-control')
 const sentry = require('./sentry')
 
 const handle = (
   app,
   method,
   routeDefinitions,
   { validateResponses, logRequests, logResponses, correlationIdExtractor, logger, appEnv },
-  { url, operationId, preHandlers, handlers, schema, isPublic, tags, summary, description, deprecated, warnOnRequestValidationError, jsonOptions }
+  { url, operationId, preHandlers, handlers, schema, isPublic, tags, summary, description, deprecated, warnOnRequestValidationError, jsonOptions, cacheControlString }
 ) => {
   let _handlers = [express.json(jsonOptions || {})]
 
@@ -43,6 +44,10 @@ const handle = (
     _handlers.push(responseValidator({ schema: schema.responses }))
   }
 
+  if (cacheControlString) {
+    _handlers.push(responseCacheControl({ cacheControlString }))
+  }
+
   _handlers = [..._handlers, ...handlers].map(handler => {
     const wrappedHandler = asyncMiddleware(handler)
     // this ensures that the original middleware name is preserved and not rewritten to 'asyncMiddleware'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luxuryescapes/router",
-  "version": "2.5.32",
+  "version": "2.6.0",
   "description": "Wrapper around express router that provides validation and documentation out of the box",
   "main": "index.js",
   "types": "index.d.ts",