@dwp/govuk-casa 9.0.0 → 9.1.0

package/src/lib/mount.js

@@ -1,39 +1,40 @@
-import { Router } from 'express';
-import { pathToRegexp } from 'path-to-regexp';
+import { Router } from "express";
+import { pathToRegexp } from "path-to-regexp";
 
-import stripProxyPathMiddlewareFactory from '../middleware/strip-proxy-path.js';
-import serveFirstWaypointMiddlewareFactory from '../middleware/serve-first-waypoint.js';
+import stripProxyPathMiddlewareFactory from "../middleware/strip-proxy-path.js";
+import serveFirstWaypointMiddlewareFactory from "../middleware/serve-first-waypoint.js";
 
 /**
+ * @typedef {import("nunjucks").Environment} NunjucksEnvironment
  * @access private
- * @typedef {import('nunjucks').Environment} NunjucksEnvironment
  */
 
 /**
+ * @typedef {import("express").RequestHandler} ExpressRequestHandler
  * @access private
- * @typedef {import('express').RequestHandler} ExpressRequestHandler
  */
 
 /**
+ * @typedef {import("../casa").Mounter} Mounter
  * @access private
- * @typedef {import('../casa').Mounter} Mounter
  */
 
 /**
+ * @typedef {import("../casa").Plan} Plan
  * @access private
- * @typedef {import('../casa').Plan} Plan
  */
 
 /**
+ * @typedef {import("../casa").MutableRouter} MutableRouter
  * @access private
- * @typedef {import('../casa').MutableRouter} MutableRouter
  */
 
 /**
  * Mounting function factory.
  *
  * @param {object} args Arguments
- * @param {NunjucksEnvironment} args.nunjucksEnv Pre-configured Nunjucks environment
+ * @param {NunjucksEnvironment} args.nunjucksEnv Pre-configured Nunjucks
+ *   environment
  * @param {string} [args.mountUrl] Mount URL
  * @param {Plan} [args.plan] CASA Plan
  * @param {MutableRouter} args.staticRouter Router for all static assets
@@ -45,77 +46,72 @@ import serveFirstWaypointMiddlewareFactory from '../middleware/serve-first-waypo
  * @param {ExpressRequestHandler[]} args.bodyParserMiddleware Middleware
  * @param {ExpressRequestHandler[]} args.dataMiddleware Middleware
  * @param {ExpressRequestHandler[]} args.postMiddleware Middleware
- * @returns {Mounter} mount
+ * @returns {Mounter} Mount
  */
 export default ({
-  nunjucksEnv,
-  mountUrl,
-  plan,
-  staticRouter,
-  ancillaryRouter,
-  journeyRouter,
-  preMiddleware,
-  sessionMiddleware,
-  i18nMiddleware,
-  bodyParserMiddleware,
-  dataMiddleware,
-  postMiddleware,
-}) => (
-  app,
-  {
-    route = '/',
-    serveFirstWaypoint = false,
-  } = {},
-) => {
-  nunjucksEnv.express(app);
-  app.set('view engine', 'njk');
+    nunjucksEnv,
+    mountUrl,
+    plan,
+    staticRouter,
+    ancillaryRouter,
+    journeyRouter,
+    preMiddleware,
+    sessionMiddleware,
+    i18nMiddleware,
+    bodyParserMiddleware,
+    dataMiddleware,
+    postMiddleware,
+  }) =>
+  (app, { route = "/", serveFirstWaypoint = false } = {}) => {
+    nunjucksEnv.express(app);
+    app.set("view engine", "njk");
 
-  // If a `mountUrl` has been defined, then we're potentially in "proxy mode",
-  // in which we strip the proxy path prefix from the incoming request URLs.
-  if (mountUrl) {
-    app.use(stripProxyPathMiddlewareFactory({ mountUrl }));
-  }
+    // If a `mountUrl` has been defined, then we're potentially in "proxy mode",
+    // in which we strip the proxy path prefix from the incoming request URLs.
+    if (mountUrl) {
+      app.use(stripProxyPathMiddlewareFactory({ mountUrl }));
+    }
 
-  // Attach a handler to redirect requests for `/` to the first waypoint in
-  // the plan
-  if (serveFirstWaypoint && plan) {
-    const re = pathToRegexp(`${route}`.replace(/\/+/g, '/'));
-    app.use(re, serveFirstWaypointMiddlewareFactory({ plan }));
-  }
+    // Attach a handler to redirect requests for `/` to the first waypoint in
+    // the plan
+    if (serveFirstWaypoint && plan) {
+      const re = pathToRegexp(`${route}`.replace(/\/+/g, "/"));
+      app.use(re, serveFirstWaypointMiddlewareFactory({ plan }));
+    }
 
-  // Capture the mount path of this CASA app, before any parameterised path
-  // segments exert influence over `req.baseUrl` in the `router` further below.
-  // This can later be used by middleware that wants to use the
-  // "unparameterised" version of the request's `baseUrl`, such as the static
-  // router's middleware.
-  app.use((req, res, next) => {
-    req.unparameterisedBaseUrl = req.baseUrl;
-    next();
-  });
+    // Capture the mount path of this CASA app, before any parameterised path
+    // segments exert influence over `req.baseUrl` in the `router` further below.
+    // This can later be used by middleware that wants to use the
+    // "unparameterised" version of the request's `baseUrl`, such as the static
+    // router's middleware.
+    app.use((req, res, next) => {
+      req.unparameterisedBaseUrl = req.baseUrl;
+      next();
+    });
 
-  // Serve static assets from the `app` rather than the `router`. The router
-  // may contain parameterised path segments which would mean serving static
-  // assets over a dynamic URL each time, thus causing lots of cache misses on
-  // the browser.
-  const sealedStaticRouter = staticRouter.seal();
-  app.use(preMiddleware);
-  app.use(sealedStaticRouter);
+    // Serve static assets from the `app` rather than the `router`. The router
+    // may contain parameterised path segments which would mean serving static
+    // assets over a dynamic URL each time, thus causing lots of cache misses on
+    // the browser.
+    const sealedStaticRouter = staticRouter.seal();
+    app.use(preMiddleware);
+    app.use(sealedStaticRouter);
 
-  const router = Router({
-    // Required so that any parameters in the URL are propagated to middleware
-    mergeParams: true,
-  });
+    const router = Router({
+      // Required so that any parameters in the URL are propagated to middleware
+      mergeParams: true,
+    });
 
-  router.use(preMiddleware);
-  router.use(sessionMiddleware);
-  router.use(i18nMiddleware);
-  router.use(bodyParserMiddleware);
-  router.use(dataMiddleware);
-  router.use(ancillaryRouter.seal());
-  router.use(journeyRouter.seal());
-  router.use(postMiddleware);
+    router.use(preMiddleware);
+    router.use(sessionMiddleware);
+    router.use(i18nMiddleware);
+    router.use(bodyParserMiddleware);
+    router.use(dataMiddleware);
+    router.use(ancillaryRouter.seal());
+    router.use(journeyRouter.seal());
+    router.use(postMiddleware);
 
-  app.use(route, router);
+    app.use(route, router);
 
-  return app;
-};
+    return app;
+  };

package/src/lib/nunjucks-filters.js

@@ -1,6 +1,6 @@
-import merge from 'deepmerge';
-import { DateTime } from 'luxon';
-import nunjucks from 'nunjucks';
+import merge from "deepmerge";
+import { DateTime } from "luxon";
+import nunjucks from "nunjucks";
 
 const { all: deepmergeAll } = merge;
 
@@ -9,54 +9,54 @@ const { all: deepmergeAll } = merge;
 // ref: https://www.npmjs.com/package/deepmerge
 
 const combineMerge = (target, source, options) => {
-  const destination = target.slice()
+  const destination = target.slice();
 
   source.forEach((item, index) => {
     // ESLint disabled as `index` is only an integer
     /* eslint-disable security/detect-object-injection */
-    if (typeof destination[index] === 'undefined') {
-      destination[index] = options.cloneUnlessOtherwiseSpecified(item, options)
+    if (typeof destination[index] === "undefined") {
+      destination[index] = options.cloneUnlessOtherwiseSpecified(item, options);
     } else if (options.isMergeableObject(item)) {
-      destination[index] = merge(target[index], item, options)
+      destination[index] = merge(target[index], item, options);
     } else if (target.indexOf(item) === -1) {
-      destination.push(item)
+      destination.push(item);
     }
     /* eslint-enable security/detect-object-injection */
-  })
-  return destination
-}
+  });
+  return destination;
+};
 
 // Allows objects to be deepmerged and retain their type, without becoming [object Object]
 // ref: https://github.com/jonschlinkert/is-plain-object/blob/master/is-plain-object.js
 
 function isObject(o) {
-  return Object.prototype.toString.call(o) === '[object Object]';
+  return Object.prototype.toString.call(o) === "[object Object]";
 }
 
 function isPlainObjectOrArray(o) {
   if (Array.isArray(o)) {
-    return true
+    return true;
   }
   if (isObject(o) === false) {
-    return false
+    return false;
   }
   const ctor = o.constructor;
   if (ctor === undefined) {
-    return true
+    return true;
   }
   const prot = ctor.prototype;
   if (isObject(prot) === false) {
-    return false
+    return false;
   }
   // eslint-disable-next-line no-prototype-builtins
-  return prot.hasOwnProperty('isPrototypeOf');
+  return prot.hasOwnProperty("isPrototypeOf");
 }
 
 function mergeObjects(...objects) {
-  return deepmergeAll([
-    Object.create(null),
-    ...objects,
-  ], { arrayMerge: combineMerge, isMergeableObject: isPlainObjectOrArray });
+  return deepmergeAll([Object.create(null), ...objects], {
+    arrayMerge: combineMerge,
+    isMergeableObject: isPlainObjectOrArray,
+  });
 }
 /**
  * Determine whether a value exists in a list.
@@ -66,7 +66,7 @@ function mergeObjects(...objects) {
  * @param {any} search Item to search within the `source`
  * @returns {boolean} True if the search item was found
  */
-function includes(source = [], search = '') {
+function includes(source = [], search = "") {
   return source.includes(search);
 }
 
@@ -75,43 +75,43 @@ function includes(source = [], search = '') {
  *
  * Requires NodeJS >= 14 to make use of bundled date locale data.
  *
- * `date` may be any of the following types:
- *   object - {dd:'', mm:'', yyyy:''}
+ * `date` may be any of the following types: object - {dd:'', mm:'', yyyy:''}
  *
  * @memberof NunjucksFilters
- * @param  {object} date Date
- * @param  {string} date.dd Day
- * @param  {string} date.mm Month
- * @param  {string} date.yyyy Year
- * @param  {object} [config] Options
- * @param  {string} [config.locale] Locale (default 'en')
- * @param  {string} [config.format] Format (default 'd MMMM yyyy')
+ * @param {object} date Date
+ * @param {string} date.dd Day
+ * @param {string} date.mm Month
+ * @param {string} date.yyyy Year
+ * @param {object} [config] Options
+ * @param {string} [config.locale] Locale (default 'en')
+ * @param {string} [config.format] Format (default 'd MMMM yyyy')
  * @returns {string} Formatted date
  */
 function formatDateObject(date, config = {}) {
-  const { locale = 'en', format = 'd MMMM yyyy' } = config;
+  const { locale = "en", format = "d MMMM yyyy" } = config;
 
   if (
-    Object.prototype.toString.call(date) === '[object Object]'
-    && 'yyyy' in date
-    && 'mm' in date
-    && 'dd' in date
+    Object.prototype.toString.call(date) === "[object Object]" &&
+    "yyyy" in date &&
+    "mm" in date &&
+    "dd" in date
   ) {
     return DateTime.fromObject({
       year: Math.max(0, parseInt(date.yyyy, 10)),
       month: Math.max(0, parseInt(date.mm, 10)),
       day: Math.max(1, parseInt(date.dd, 10)),
-    }).setLocale(locale).toFormat(format);
+    })
+      .setLocale(locale)
+      .toFormat(format);
   }
-  return 'INVALID DATE OBJECT';
+  return "INVALID DATE OBJECT";
 }
 
 /**
  * Attribute values will be HTML/attribute escaped.
  *
- * Example:
- *   Given: {class: 'basic', 'data-ga': 3}
- *   Output: class="basic" data-ga="3"
+ * Example: Given: {class: 'basic', 'data-ga': 3} Output: class="basic"
+ * data-ga="3"
  *
  * @memberof NunjucksFilters
  * @param {object} attrsObject Attributes object (in name:value pairs)
@@ -119,32 +119,29 @@ function formatDateObject(date, config = {}) {
  */
 function renderAsAttributes(attrsObject) {
   const attrsList = [];
-  if (typeof attrsObject === 'object') {
+  if (typeof attrsObject === "object") {
     Object.keys(attrsObject).forEach((key) => {
       // ESLint disable as `attrsObject` is dev-controlled, `Object.keys()` has
       // been used (to get "own" properties) and `m` is one of the characters
       // found by the regex.
       /* eslint-disable security/detect-object-injection */
-      const value = String(attrsObject[key]).replace(/[<>"'&]/g, (m) => ({
-        '<': '&lt;',
-        '>': '&gt;',
-        '"': '&quot;',
-        '\'': '&#039;',
-        '&': '&amp;',
-      }[m]));
+      const value = String(attrsObject[key]).replace(
+        /[<>"'&]/g,
+        (m) =>
+          ({
+            "<": "&lt;",
+            ">": "&gt;",
+            '"': "&quot;",
+            "'": "&#039;",
+            "&": "&amp;",
+          })[m],
+      );
       /* eslint-enable security/detect-object-injection */
       attrsList.push(`${key}="${value}"`);
     });
   }
-  return new nunjucks.runtime.SafeString(attrsList.join(' '));
+  return new nunjucks.runtime.SafeString(attrsList.join(" "));
 }
 
-/**
- * @namespace NunjucksFilters
- */
-export {
-  mergeObjects,
-  includes,
-  formatDateObject,
-  renderAsAttributes,
-};
+/** @namespace NunjucksFilters */
+export { mergeObjects, includes, formatDateObject, renderAsAttributes };

package/src/lib/nunjucks.js

@@ -1,27 +1,29 @@
-import { readFileSync } from 'fs';
-import { resolve } from 'path';
-import { Environment } from 'nunjucks';
-import dirname from './dirname.cjs';
-import CasaTemplateLoader from './CasaTemplateLoader.js';
+import { readFileSync } from "fs";
+import { resolve } from "path";
+import { Environment } from "nunjucks";
+import dirname from "./dirname.cjs";
+import CasaTemplateLoader from "./CasaTemplateLoader.js";
 import {
-  mergeObjects, includes, renderAsAttributes, formatDateObject,
-} from './nunjucks-filters.js';
+  mergeObjects,
+  includes,
+  renderAsAttributes,
+  formatDateObject,
+} from "./nunjucks-filters.js";
 
 /**
  * @typedef {object} NunjucksOptions
- * @property {string[]} [views=[]] Template file directories (optional, default [])
+ * @property {string[]} [views=[]] Template file directories (optional, default
+ *   []). Default is `[]`
  */
 
 /**
  * Create a Nunjucks environment.
  *
- * @access private
  * @param {NunjucksOptions} options Nunjucks options
  * @returns {Environment} Nunjucks Environment instance
+ * @access private
  */
-export default function nunjucksConfig({
-  views = [],
-}) {
+export default function nunjucksConfig({ views = [] }) {
   // Prepare a single Nunjucks environment for all responses to use. Note that
   // we cannot prepare response-specific global functions/filters if we use a
   // single environment, but the performance gains of doing so are significant.
@@ -42,13 +44,16 @@ export default function nunjucksConfig({
 
   // Globals
   // These can't be modified once set. But they can be overridden by res.locals.
-  /* eslint-disable-next-line security/detect-non-literal-fs-filename */
-  env.addGlobal('casaVersion', JSON.parse(readFileSync(resolve(dirname, '../../package.json'))).version);
+  env.addGlobal(
+    "casaVersion",
+    /* eslint-disable-next-line security/detect-non-literal-fs-filename */
+    JSON.parse(readFileSync(resolve(dirname, "../../package.json"))).version,
+  );
 
-  env.addGlobal('mergeObjects', mergeObjects);
-  env.addGlobal('includes', includes);
-  env.addGlobal('formatDateObject', formatDateObject);
-  env.addGlobal('renderAsAttributes', renderAsAttributes);
+  env.addGlobal("mergeObjects", mergeObjects);
+  env.addGlobal("includes", includes);
+  env.addGlobal("formatDateObject", formatDateObject);
+  env.addGlobal("renderAsAttributes", renderAsAttributes);
 
   return env;
 }