@dwp/govuk-casa 8.16.1 → 8.16.3

package/src/lib/constants.js

@@ -1,11 +1,11 @@
 /**
  * General-purpose references to the different request lifecycle phases.
  */
-export const REQUEST_PHASE_STEER = Symbol('steer');
-export const REQUEST_PHASE_SANITISE = Symbol('sanitise');
-export const REQUEST_PHASE_GATHER = Symbol('gather');
-export const REQUEST_PHASE_VALIDATE = Symbol('validate');
-export const REQUEST_PHASE_REDIRECT = Symbol('redirect');
-export const REQUEST_PHASE_RENDER = Symbol('render');
-export const CONFIG_ERROR_VISIBILITY_ONSUBMIT = Symbol('onsubmit');
-export const CONFIG_ERROR_VISIBILITY_ALWAYS = Symbol('always');
+export const REQUEST_PHASE_STEER = Symbol("steer");
+export const REQUEST_PHASE_SANITISE = Symbol("sanitise");
+export const REQUEST_PHASE_GATHER = Symbol("gather");
+export const REQUEST_PHASE_VALIDATE = Symbol("validate");
+export const REQUEST_PHASE_REDIRECT = Symbol("redirect");
+export const REQUEST_PHASE_RENDER = Symbol("render");
+export const CONFIG_ERROR_VISIBILITY_ONSUBMIT = Symbol("onsubmit");
+export const CONFIG_ERROR_VISIBILITY_ALWAYS = Symbol("always");

package/src/lib/context-id-generators.js

@@ -1,5 +1,4 @@
-/* eslint-disable import/no-cycle */
-import { randomUUID } from 'node:crypto';
+import { randomUUID } from "node:crypto";
 
 /**
  * @typedef {import('../casa.js').ContextIdGenerator} ContextIdGenerator
@@ -21,51 +20,53 @@ const uuid = () => () => randomUUID();
  *
  * @returns {ContextIdGenerator} Generator function
  */
-const sequentialInteger = () => ({ reservedIds }) => {
-  const contextIds = Array.from(reservedIds).sort();
+const sequentialInteger =
+  () =>
+  ({ reservedIds }) => {
+    const contextIds = Array.from(reservedIds).sort();
 
-  if (!contextIds.length) {
-    return '1';
-  }
+    if (!contextIds.length) {
+      return "1";
+    }
 
-  // Find the first numeric ID that we can increment
-  let lastInSequence;
-  do {
-    lastInSequence = Number.parseInt(contextIds.pop(), 10);
-  } while (contextIds.length && Number.isNaN(lastInSequence));
+    // Find the first numeric ID that we can increment
+    let lastInSequence;
+    do {
+      lastInSequence = Number.parseInt(contextIds.pop(), 10);
+    } while (contextIds.length && Number.isNaN(lastInSequence));
 
-  return String(!Number.isNaN(lastInSequence) ? lastInSequence + 1 : 1);
-};
+    return String(!Number.isNaN(lastInSequence) ? lastInSequence + 1 : 1);
+  };
 
-const shortGuid = ({
-  length = 5,
-  prefix = '',
-  pool = 'abcdefhkmnprtwxy346789',
-} = {}) => ({ reservedIds }) => {
-  // Ambiguous characters excluded
-  const poolSize = pool.length;
+const shortGuid =
+  ({ length = 5, prefix = "", pool = "abcdefhkmnprtwxy346789" } = {}) =>
+  ({ reservedIds }) => {
+    // Ambiguous characters excluded
+    const poolSize = pool.length;
 
-  const maxAttempts = 10;
-  let attempts = maxAttempts;
-  let id;
+    const maxAttempts = 10;
+    let attempts = maxAttempts;
+    let id;
 
-  do {
-    id = Array(length).fill(0).map(() => pool.charAt(Math.floor(Math.random() * poolSize))).join('');
-    attempts--;
-  } while (attempts > 0 && reservedIds.includes(id));
+    do {
+      id = Array(length)
+        .fill(0)
+        /* eslint-disable-next-line sonarjs/pseudo-random */
+        .map(() => pool.charAt(Math.floor(Math.random() * poolSize)))
+        .join("");
+      attempts--;
+    } while (attempts > 0 && reservedIds.includes(id));
 
-  if (attempts === 0) {
-    throw new Error(`Failed to generate GUID after ${maxAttempts} iterations`);
-  }
+    if (attempts === 0) {
+      throw new Error(
+        `Failed to generate GUID after ${maxAttempts} iterations`,
+      );
+    }
 
-  return `${prefix}${id}`;
-}
+    return `${prefix}${id}`;
+  };
 
 /**
  * @namespace ContextIdGenerators
  */
-export {
-  uuid,
-  sequentialInteger,
-  shortGuid,
-};
+export { uuid, sequentialInteger, shortGuid };

package/src/lib/end-session.js

@@ -1,6 +1,6 @@
-import logger from './logger.js';
+import logger from "./logger.js";
 
-const log = logger('lib:end-session');
+const log = logger("lib:end-session");
 
 /**
  * A convenience for ending the current session, but retaining some data in it,
@@ -19,7 +19,7 @@ export default function endSession(req, next) {
   const { language } = req.session;
 
   Object.entries(req.session).forEach(([k]) => {
-    if (!['cookie'].includes(k)) {
+    if (!["cookie"].includes(k)) {
       // ESLint disabled as `Object.entries()` returns "own" properties, and
       // all values are being null'd, so not assigned any user-controlled values
       /* eslint-disable-next-line security/detect-object-injection */

package/src/lib/field.js

@@ -1,8 +1,8 @@
-import lodash from 'lodash';
-import { isEmpty } from './utils.js';
-import logger from './logger.js';
+import lodash from "lodash";
+import { isEmpty } from "./utils.js";
+import logger from "./logger.js";
 
-const log = logger('lib:field');
+const log = logger("lib:field");
 const { isFunction } = lodash;
 
 /**
@@ -78,12 +78,17 @@ export class PageField {
    *
    * @param {string} name Field name
    * @param {object} [opts] Options
-   * @param {boolean} [opts.optional=false] Whether this field is optional
-   * @param {boolean} [opts.persist=true] Whether this field will persist in `req.body`
+   * @param {boolean} [opts.optional] Whether this field is optional
+   * @param {boolean} [opts.persist] Whether this field will persist in `req.body`
    */
-  constructor(name, { optional = false, persist = true } = Object.create(null)) {
+  constructor(
+    name,
+    { optional = false, persist = true } = Object.create(null),
+  ) {
     if (!name) {
-      throw new SyntaxError('A name for this field is required, i.e. "field(\'myField\')".');
+      throw new SyntaxError(
+        "A name for this field is required, i.e. \"field('myField')\".",
+      );
     }
 
     this.#name = undefined;
@@ -100,7 +105,7 @@ export class PageField {
     };
 
     // Apply name
-    /* eslint-disable-next-line security/detect-non-literal-fs-filename */
+
     this.rename(name);
   }
 
@@ -139,7 +144,9 @@ export class PageField {
    */
   getValue(obj = Object.create(null)) {
     if (this.#meta.complex) {
-      return obj[this.#meta.complexFieldName]?.[this.#meta.complexFieldProperty];
+      return obj[this.#meta.complexFieldName]?.[
+        this.#meta.complexFieldProperty
+      ];
     }
     return obj[this.#name];
   }
@@ -156,13 +163,11 @@ export class PageField {
    */
   putValue(obj = Object.create(null), value = undefined) {
     if (this.#meta.complex) {
-      /* eslint-disable-next-line no-param-reassign */
       obj[this.#meta.complexFieldName] = {
         ...(obj[this.#meta.complexFieldName] ?? {}),
         [this.#meta.complexFieldProperty]: value,
       };
     } else {
-      /* eslint-disable-next-line no-param-reassign */
       obj[this.#name] = value;
     }
 
@@ -188,7 +193,9 @@ export class PageField {
    */
   rename(name) {
     if (reInvalidName.test(String(name))) {
-      throw new SyntaxError(`Field '${String(name)}' name contains invalid characters.`);
+      throw new SyntaxError(
+        `Field '${String(name)}' name contains invalid characters.`,
+      );
     }
 
     // Complex names are only supported to one level deep. For example,
@@ -196,7 +203,9 @@ export class PageField {
     // early to aid developer.
     const isComplex = reComplexType.test(name);
     if (isComplex && name.match(/\[/g).length > 1) {
-      throw new SyntaxError('Complex field names are only supported to 1 property depth. E.g. a[b] is ok, a[b][c] is not');
+      throw new SyntaxError(
+        "Complex field names are only supported to 1 property depth. E.g. a[b] is ok, a[b][c] is not",
+      );
     }
 
     this.#name = String(name);
@@ -232,10 +241,12 @@ export class PageField {
    */
   validators(items = []) {
     if (!items.length) {
-      log.warn('Calling validators() to get all validators is deprecated, please use getValidators()');
+      log.warn(
+        "Calling validators() to get all validators is deprecated, please use getValidators()",
+      );
       return this.getValidators();
     }
-    this.#validators = [...this.#validators, ...(items.flat())];
+    this.#validators = [...this.#validators, ...items.flat()];
     return this;
   }
 
@@ -259,11 +270,13 @@ export class PageField {
    */
   processors(items = []) {
     if (!items.length) {
-      log.warn('Calling processors() to get all processors is deprecated, please use getProcessors()');
+      log.warn(
+        "Calling processors() to get all processors is deprecated, please use getProcessors()",
+      );
       return this.getProcessors();
     }
 
-    this.#processors = [...this.#processors, ...(items.flat())];
+    this.#processors = [...this.#processors, ...items.flat()];
     return this;
   }
 
@@ -288,10 +301,12 @@ export class PageField {
    */
   conditions(items = []) {
     if (!items.length) {
-      log.warn('Calling conditions() to get all conditions is deprecated, please use getConditions()');
+      log.warn(
+        "Calling conditions() to get all conditions is deprecated, please use getConditions()",
+      );
       return this.getConditions();
     }
-    this.#conditions = [...this.#conditions, ...(items.flat())];
+    this.#conditions = [...this.#conditions, ...items.flat()];
     return this;
   }
 
@@ -325,22 +340,23 @@ export class PageField {
       // ESLint disabled as `i` is an integer
       /* eslint-disable security/detect-object-injection */
       // TODO: Replace `value` with `context.fieldValue` here
-      let fieldErrors = this.#validators[i].validate(value, context)
+      let fieldErrors = this.#validators[i].validate(value, context);
       if (!Array.isArray(fieldErrors)) {
         // Friendly message for developer
-        throw new TypeError(`The validator at index ${i} (name: ${this.#validators[i].name || 'unknown'}) for field '${this.#name}' did not return an array`);
+        throw new TypeError(
+          `The validator at index ${i} (name: ${this.#validators[i].name || "unknown"}) for field '${this.#name}' did not return an array`,
+        );
       }
 
-      fieldErrors = fieldErrors.map((e) => e.withContext({
-        ...context,
-        validator: this.#validators[i].name,
-      }));
+      fieldErrors = fieldErrors.map((e) =>
+        e.withContext({
+          ...context,
+          validator: this.#validators[i].name,
+        }),
+      );
       /* eslint-enable security/detect-object-injection */
 
-      errors = [
-        ...errors,
-        ...(fieldErrors ?? []),
-      ];
+      errors = [...errors, ...(fieldErrors ?? [])];
     }
 
     return errors;
@@ -447,8 +463,8 @@ export class PageField {
  * @memberof module:@dwp/govuk-casa
  * @param {string} name Field name
  * @param {object} [opts] Options
- * @param {boolean} [opts.optional=false] Whether this field is optional
- * @param {boolean} [opts.persist=true] Whether this field will persist in `req.body`
+ * @param {boolean} [opts.optional] Whether this field is optional
+ * @param {boolean} [opts.persist] Whether this field will persist in `req.body`
  * @returns {PageField} A PageField
  */
 export default function field(name, opts) {

package/src/lib/index.js

@@ -3,18 +3,18 @@
  * imported anywhere in code, other than JSDoc references.
  */
 
-import CasaTemplateLoader from './CasaTemplateLoader.js';
-import configure from './configure.js';
-import configurationIngestor from './configuration-ingestor.js';
-import endSession from './end-session.js';
-import field, { PageField } from './field.js';
-import JourneyContext from './JourneyContext.js';
-import MutableRouter from './MutableRouter.js';
-import Plan from './Plan.js';
-import ValidationError from './ValidationError.js';
-import ValidatorFactory from './ValidatorFactory.js';
-import waypointUrl from './waypoint-url.js';
-import * as utils from './utils.js';
+import CasaTemplateLoader from "./CasaTemplateLoader.js";
+import configure from "./configure.js";
+import configurationIngestor from "./configuration-ingestor.js";
+import endSession from "./end-session.js";
+import field, { PageField } from "./field.js";
+import JourneyContext from "./JourneyContext.js";
+import MutableRouter from "./MutableRouter.js";
+import Plan from "./Plan.js";
+import ValidationError from "./ValidationError.js";
+import ValidatorFactory from "./ValidatorFactory.js";
+import waypointUrl from "./waypoint-url.js";
+import * as utils from "./utils.js";
 
 export {
   CasaTemplateLoader,

package/src/lib/logger.js

@@ -1,16 +1,16 @@
-import debug from 'debug';
+import debug from "debug";
 
-const casaDebugger = debug('casa');
+const casaDebugger = debug("casa");
 
 export default (namespace) => {
   const logger = casaDebugger.extend(namespace);
 
   return {
-    trace: logger.extend('trace'),
-    debug: logger.extend('debug'),
-    info: logger.extend('info'),
-    warn: logger.extend('warn'),
-    error: logger.extend('error'),
-    fatal: logger.extend('fatal'),
+    trace: logger.extend("trace"),
+    debug: logger.extend("debug"),
+    info: logger.extend("info"),
+    warn: logger.extend("warn"),
+    error: logger.extend("error"),
+    fatal: logger.extend("fatal"),
   };
-}
+};

package/src/lib/mount.js

@@ -1,8 +1,8 @@
-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";
 
 /**
  * @access private
@@ -48,80 +48,75 @@ import serveFirstWaypointMiddlewareFactory from '../middleware/serve-first-waypo
  * @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.regexp, 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.regexp, 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);
-  // !!! DEPRECATE in v9 !!! For performance reasons, static assets will
-  // always be handled via the `app` middleware rather than `router`.
-  // Anywhere `mountUrl` is used in templates to service static assets must be
-  // changed to use `staticMountUrl`.
-  // TASK: remove this line below
-  router.use(sealedStaticRouter);
-  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);
+    // !!! DEPRECATE in v9 !!! For performance reasons, static assets will
+    // always be handled via the `app` middleware rather than `router`.
+    // Anywhere `mountUrl` is used in templates to service static assets must be
+    // changed to use `staticMountUrl`.
+    // TASK: remove this line below
+    router.use(sealedStaticRouter);
+    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;
+  };