@dwp/govuk-casa 8.16.2 → 8.16.4

package/src/routes/static.js

@@ -1,12 +1,12 @@
-import ExpressJS from 'express';
-import { readFileSync } from 'fs';
-import { URL } from 'url';
-import { resolve } from 'path';
-import { createRequire } from 'module';
+import ExpressJS from "express";
+import { readFileSync } from "fs";
+import { URL } from "url";
+import { resolve } from "path";
+import { createRequire } from "module";
 
-import dirname from './dirname.cjs';
-import MutableRouter from '../lib/MutableRouter.js';
-import { validateUrlPath } from '../lib/utils.js';
+import dirname from "./dirname.cjs";
+import MutableRouter from "../lib/MutableRouter.js";
+import { validateUrlPath } from "../lib/utils.js";
 
 const { static: ExpressStatic } = ExpressJS; // CommonJS
 
@@ -14,7 +14,10 @@ const oneDay = 86400000;
 
 /**
  * @typedef {object} StaticOptions Options to configure static router
- * @property {number} [maxAge=3600000] Cache TTL for all assets (optional, default 1 hour)
+ * @property {number} [maxAge=3600000] Cache TTL for all assets. Default is
+ *   `3600000`
+ * @property {string} [cacheControl=private] Cache control headers. Default is
+ *   `private`
  */
 
 /**
@@ -26,22 +29,25 @@ const oneDay = 86400000;
  */
 export default function staticRouter({
   maxAge = 3600000,
+  cacheControl = "private",
 } = {}) {
   const router = new MutableRouter();
 
   const notFoundHandler = (req, res, next) => {
     // Fall through to a general purpose error handler
-    next(new Error('404'));
+    next(new Error("404"));
   };
 
   const setHeaders = (req, res, next) => {
-    res.set('cache-control', 'public');
-    res.set('pragma', 'cache');
-    res.set('expires', new Date(Date.now() + oneDay).toUTCString());
-    const { pathname } = new URL(req?.originalUrl ?? '', 'https://placeholder.test/');
-    if (pathname.substr(-4) === '.css') {
+    res.set("cache-control", cacheControl);
+    res.set("expires", new Date(Date.now() + maxAge).toUTCString());
+    const { pathname } = new URL(
+      req?.originalUrl ?? "",
+      "https://placeholder.test/",
+    );
+    if (pathname.substr(-4) === ".css") {
       // Just needed for our in-memory CSS assets
-      res.set('content-type', 'text/css');
+      res.set("content-type", "text/css");
     }
     next();
   };
@@ -59,22 +65,54 @@ export default function staticRouter({
   // must be replaced with the dynamic `mountUrl` to ensure govuk-frontend
   // assets are served from the correct location.
   /* eslint-disable security/detect-non-literal-fs-filename */
-  const casaCss = readFileSync(resolve(dirname, '../../dist/assets/css/casa.css'), { encoding: 'utf8' });
-  const casaCssIe8 = readFileSync(resolve(dirname, '../../dist/assets/css/casa-ie8.css'), { encoding: 'utf8' });
+  const casaCss = readFileSync(
+    resolve(dirname, "../../dist/assets/css/casa.css"),
+    { encoding: "utf8" },
+  );
+  const casaCssIe8 = readFileSync(
+    resolve(dirname, "../../dist/assets/css/casa-ie8.css"),
+    { encoding: "utf8" },
+  );
   /* eslint-enable security/detect-non-literal-fs-filename */
 
   // The static middleware will only server GET/HEAD requests, so we can mount
   // the middleware using `use()` rather than resorting to `get()`
-  const govukFrontendDirectory = resolve(createRequire(dirname).resolve('govuk-frontend'), '../../');
+  const govukFrontendDirectory = resolve(
+    createRequire(dirname).resolve("govuk-frontend"),
+    "../../",
+  );
 
-  router.use('/govuk/assets/js/all.js', ExpressStatic(`${govukFrontendDirectory}/govuk/all.js`, staticConfig));
-  router.use('/govuk/assets/js/all.js.map', ExpressStatic(`${govukFrontendDirectory}/govuk/all.js.map`, staticConfig));
-  router.use('/govuk/assets', ExpressStatic(`${govukFrontendDirectory}/govuk/assets`, staticConfig));
-  router.use('/govuk/assets', notFoundHandler);
+  router.use(
+    "/govuk/assets/js/all.js",
+    ExpressStatic(`${govukFrontendDirectory}/govuk/all.js`, staticConfig),
+  );
+  router.use(
+    "/govuk/assets/js/all.js.map",
+    ExpressStatic(`${govukFrontendDirectory}/govuk/all.js.map`, staticConfig),
+  );
+  router.use(
+    "/govuk/assets",
+    ExpressStatic(`${govukFrontendDirectory}/govuk/assets`, staticConfig),
+  );
+  router.use("/govuk/assets", notFoundHandler);
 
-  router.get('/casa/assets/css/casa.css', setHeaders, (req, res) => res.send(casaCss.replace(/~~~CASA_MOUNT_URL~~~/g, validateUrlPath(`${req.baseUrl}/`))));
-  router.get('/casa/assets/css/casa-ie8.css', setHeaders, (req, res) => res.send(casaCssIe8.replace(/~~~CASA_MOUNT_URL~~~/g, validateUrlPath(`${req.baseUrl}/`))));
-  router.use('/casa/assets', notFoundHandler);
+  router.get("/casa/assets/css/casa.css", setHeaders, (req, res) =>
+    res.send(
+      casaCss.replace(
+        /~~~CASA_MOUNT_URL~~~/g,
+        validateUrlPath(`${req.baseUrl}/`),
+      ),
+    ),
+  );
+  router.get("/casa/assets/css/casa-ie8.css", setHeaders, (req, res) =>
+    res.send(
+      casaCssIe8.replace(
+        /~~~CASA_MOUNT_URL~~~/g,
+        validateUrlPath(`${req.baseUrl}/`),
+      ),
+    ),
+  );
+  router.use("/casa/assets", notFoundHandler);
 
   return router;
 }