@dwp/govuk-casa 6.8.4 → 6.9.0

package/middleware/page/utils.js

@@ -2,27 +2,28 @@ const { isObjectWithKeys, isObjectType, normalizeHtmlObjectPath } = require('../
 const JourneyContext = require('../../lib/JourneyContext.js');
 
 /**
-* Converts an array of functions to a nested callback, eg:
-* [                                  |   function nested(req, res, next) {-
-*   function a(req, res, next) {-    |     a(req, res, () => {-
-*     ...                            |       ...
-*     next();                        |       b(req, res, () => {-
-*   },                               |         ...
-*   function b(req, res, next) {-    |         c(req, res, () => {-
-*     ...                            |           ...
-*     next();                        |           next();
-*   },                               |         });
-*   function c(req, res, next) {-    |       })
-*     ...                            |     });
-*     next();                        |   }
-*   },                               |
-* ]                                  |
-* @param  {Logger} logger Request-specific Logger instance
-* @param  {string} hookName Name of the hook being called
-* @param  {string} waypointId id of waypoint
-* @param  {array} hooks array of middleware like functions
-* @return {function} nested function
-*/
+ * Converts an array of functions to a nested callback, eg:
+ * [                                  |   function nested(req, res, next) {-
+ *   function a(req, res, next) {-    |     a(req, res, () => {-
+ *     ...                            |       ...
+ *     next();                        |       b(req, res, () => {-
+ *   },                               |         ...
+ *   function b(req, res, next) {-    |         c(req, res, () => {-
+ *     ...                            |           ...
+ *     next();                        |           next();
+ *   },                               |         });
+ *   function c(req, res, next) {-    |       })
+ *     ...                            |     });
+ *     next();                        |   }
+ *   },                               |
+ * ]                                  |.
+ *
+ * @param  {object} logger Request-specific Logger instance.
+ * @param  {string} hookName Name of the hook being called.
+ * @param  {string} waypointId ID of waypoint.
+ * @param  {Array} hooks Array of middleware like functions.
+ * @returns {Function} Nested function.
+ */
 function nestHooks(logger, hookName, waypointId, hooks) {
   return hooks.reduce((inital, hook, hookNumber) => {
     if (typeof hook === 'function') {
@@ -43,12 +44,12 @@ function nestHooks(logger, hookName, waypointId, hooks) {
  * The returned Promise will always resolve unless the hook function ends the
  * response with something like `res.send()`.
  *
- * @param  {Logger} logger Request-specific Logger instance
- * @param  {request} req Express request
- * @param  {response} res Express response
- * @param  {object} pageMeta Metadata of page being processed
- * @param  {string} hookName Name of hook to execute
- * @return {Promise} Promise
+ * @param  {object} logger Request-specific Logger instance.
+ * @param  {object} req Express request.
+ * @param  {object} res Express response.
+ * @param  {object} pageMeta Metadata of page being processed.
+ * @param  {string} hookName Name of hook to execute.
+ * @returns {Promise} Promise.
  */
 function executeHook(logger, req = {}, res = {}, pageMeta = {}, hookName = '') {
   return new Promise((resolve, reject) => {
@@ -83,12 +84,12 @@ function executeHook(logger, req = {}, res = {}, pageMeta = {}, hookName = '') {
  * Where no validators are defined for the requested waypoint, we will store
  * nothing in the session.
  *
- * @param {Logger} logger Request-specific logger instance
- * @param {object} pageMeta Page meta object
- * @param {object} data Data to be pruned
- * @param {JourneyContext} journeyContext Request's journey context
- * @returns {object} The pruned data
- * @throws {TypeError} When given invalid argument types
+ * @param {object} logger Request-specific logger instance.
+ * @param {object} pageMeta Page meta object.
+ * @param {object} data Data to be pruned.
+ * @param {JourneyContext} journeyContext Request's journey context.
+ * @returns {object} The pruned data.
+ * @throws {TypeError} When given invalid argument types.
  */
 function extractSessionableData(
   logger,
@@ -149,9 +150,9 @@ function extractSessionableData(
 /**
  * Run modifying functions against the specified field.
  *
- * @param {object} fieldValue Value to modify
- * @param {array|function} gatherModifiers Either an array of functions or a single function
- * @return {mixed} Modified value
+ * @param {object} fieldValue Value to modify.
+ * @param {Array | Function} gatherModifiers Either an array of functions or a single function.
+ * @returns {any} Modified value.
  */
 function runGatherModifiers(fieldValue, gatherModifiers = []) {
   const modifiers = Array.isArray(gatherModifiers) ? gatherModifiers : [gatherModifiers];

package/middleware/page/validate.js

@@ -12,7 +12,7 @@ module.exports = (pageMeta = {}) => (req, res, next) => {
   /**
    * Run validation process.
    *
-   * @return {Promise} Promise
+   * @returns {Promise} Promise.
    */
   function runValidation() {
     let result;

package/middleware/session/index.js

@@ -3,7 +3,7 @@
  *
  * Enhances `req` with:
  *  object session = Current session
- *  model/claim claim = Current Claim state
+ *  model/claim claim = Current Claim state.
  */
 
 const logger = require('../../lib/Logger.js')('session');

package/middleware/static/index.js

@@ -39,9 +39,11 @@ const onehour = 3600000;
  *    govukFrontend: govuk-frontend npm package path <string>,
  *    govukTemplateJinja: govuk_template_jinja npm package path <string>
  *    govukCasa: @dwp/govuk-casa npm package path <string>
+ *  skipAssetsGeneration: boolean value to determine whether to skip the preparation of assets
  *
  * @param {object} args See above
  * @returns {void}
+ * @throws {ReferenceError}
  */
 module.exports = (args) => {
   const {
@@ -54,6 +56,7 @@ module.exports = (args) => {
       govukTemplateJinja = '',
       govukCasa = '',
     } = Object.create(null),
+    skipAssetsGeneration,
   } = args;
 
   const compiledAssetsDir = path.resolve(cAssetsDir);
@@ -73,13 +76,15 @@ module.exports = (args) => {
 
   const prefixCasa = `${proxyMountUrl}/govuk/casa`.replace(/\/+/g, '/');
 
-  logger.trace('Calling prepare-assets');
-  mwPrepareAssets({
-    logger,
-    npmGovukCasa: govukCasa,
-    compiledAssetsDir,
-    mountUrl,
-  });
+  if (!skipAssetsGeneration) {
+    logger.trace('Calling prepare-assets');
+    mwPrepareAssets({
+      logger,
+      npmGovukCasa: govukCasa,
+      compiledAssetsDir,
+      mountUrl,
+    });
+  }
 
   logger.trace('Calling serve-assets');
   mwServeAssets({

package/middleware/static/prepare-assets.js

@@ -2,11 +2,11 @@
  * Inject the configured `mountUrl` into the pre-compiled CSS sources, and copy
  * all CSS and JS to the `compiledAssetsDir` directory.
  *
- * @param {string} npmGovukCasa Path to root of `govuk-casa` module
- * @param {string} compiledAssetsDir Directory where compiled assets are saved
- * @param {string} mountUrl Mount point
+ * @param {string} npmGovukCasa Path to root of `govuk-casa` module.
+ * @param {string} compiledAssetsDir Directory where compiled assets are saved.
+ * @param {string} mountUrl Mount point.
  * @returns {void}
- * @throws {Exception} For any IO errors
+ * @throws {Error} For any IO errors.
  */
 
 const path = require('path');

package/middleware/static/serve-assets.js

@@ -2,10 +2,10 @@
  * Serve up all CASA assets from the `compiledAssetsDir` directory, and all
  * third party assets from their respective npm package directories.
  *
- * @param {express} app Express app
- * @param {Express.Static} static Static module from ExpressJS
- * @param {string} compiledAssetsDir Directory where static assets are saved
- * @param {string} prefixCasa Virtual URL prefix
+ * @param {Function} app Express app.
+ * @param {Function} static Static module from ExpressJS.
+ * @param {string} compiledAssetsDir Directory where static assets are saved.
+ * @param {string} prefixCasa Virtual URL prefix.
  * @returns {void}
  */
 
@@ -40,9 +40,6 @@ module.exports = (args) => {
   }, {
     url: `${proxyMountUrl}browserconfig.xml`,
     path: path.resolve(__dirname, '../../src/browserconfig.xml'),
-  }, {
-    url: `${proxyMountUrl}robots.txt`,
-    path: path.resolve(__dirname, '../../src/robots.txt'),
   }];
 
   mounts.forEach((m) => {

package/package.json

@@ -1,88 +1,86 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "6.8.4",
+  "version": "6.9.0",
   "description": "Framework for creating basic GOVUK Collect-And-Submit-Applications",
   "main": "casa.js",
   "files": [
-    "definitions/**/*",
-    "dist/**/*",
-    "lib/**/*",
-    "locales/**/*",
-    "middleware/**/*",
-    "test/utils/**/*",
-    "src/scss/*",
-    "src/browserconfig.xml",
-    "src/robots.txt",
-    "views/**/*",
-    "index.js",
-    "casa.js",
-    "**/*.d.ts",
-    "!**/*/.DS_Store",
-    "!**/*/.gitkeep",
-    "!examples/**/*",
-    "!test/unit/testdata/**/*"
+    "/definitions/**/*",
+    "/dist/**/*",
+    "/lib/**/*",
+    "/locales/**/*",
+    "/middleware/**/*",
+    "/test/utils/**/*",
+    "/src/scss/*",
+    "/src/browserconfig.xml",
+    "/views/**/*",
+    "/index.js",
+    "/casa.js",
+    "/**/*.d.ts",
+    "!/**/*/.DS_Store",
+    "!/**/*/.gitkeep",
+    "!/examples/**/*",
+    "!/test/unit/testdata/**/*"
   ],
   "engines": {
-    "node": ">=12.0.0 <14.0.0"
+    "node": ">=12.0.0 <15.0.0"
   },
   "repository": {
     "type": "git",
     "url": "git@github.com:dwp/govuk-casa.git"
   },
   "dependencies": {
-    "body-parser": "1.19.0",
+    "body-parser": "1.20.0",
     "colors": "1.4.0",
     "csurf": "1.11.0",
-    "debug": "4.3.1",
-    "fast-copy": "2.1.1",
-    "fs-extra": "9.1.0",
-    "govuk-frontend": "3.11.0",
+    "debug": "4.3.4",
+    "fast-copy": "2.1.2",
+    "fs-extra": "10.0.1",
+    "govuk-frontend": "3.14.0",
     "govuk_template_jinja": "0.26.0",
     "graphlib": "2.1.8",
     "klaw-sync": "6.0.0",
     "lodash.merge": "4.6.2",
-    "moment": "2.29.1",
+    "moment": "2.29.2",
     "nunjucks": "3.2.3",
     "object-resolve-path": "1.1.1",
     "serve-favicon": "2.5.0",
     "uid-safe": "2.1.5",
-    "validator": "13.5.2"
+    "validator": "13.7.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "12.0.0",
-    "@commitlint/config-conventional": "12.0.0",
-    "@commitlint/travis-cli": "12.0.0",
-    "@dwp/commitlint-config-base": "1.1.0",
-    "@dwp/eslint-config-base": "4.1.0",
-    "@stryker-mutator/core": "4.4.1",
+    "@commitlint/cli": "16.2.3",
+    "@commitlint/config-conventional": "16.2.1",
+    "@commitlint/travis-cli": "16.2.3",
+    "@dwp/commitlint-config-base": "1.2.0",
+    "@dwp/eslint-config-base": "5.0.1",
+    "@stryker-mutator/core": "5.6.1",
     "@stryker-mutator/html-reporter": "3.1.0",
     "@stryker-mutator/javascript-mutator": "4.0.0",
     "@stryker-mutator/mocha-framework": "4.0.0",
-    "@stryker-mutator/mocha-runner": "4.4.1",
-    "autocannon": "7.0.4",
-    "chai": "4.3.0",
+    "@stryker-mutator/mocha-runner": "5.6.1",
+    "autocannon": "7.8.1",
+    "chai": "4.3.6",
     "chai-as-promised": "7.1.1",
     "chai-http": "4.3.0",
-    "cheerio": "1.0.0-rc.5",
-    "conventional-changelog-cli": "2.1.1",
-    "eslint": "7.20.0",
-    "eslint-plugin-sonarjs": "0.6.0",
-    "express": "4.17.1",
-    "express-session": "1.17.1",
-    "husky": "5.1.1",
-    "jsdom": "16.4.0",
-    "minimatch": "3.0.4",
-    "mocha": "8.3.0",
-    "npm-audit-resolver": "2.2.1",
+    "cheerio": "1.0.0-rc.10",
+    "conventional-changelog-cli": "2.2.2",
+    "eslint": "7.32.0",
+    "eslint-plugin-sonarjs": "0.13.0",
+    "express": "4.17.3",
+    "express-session": "1.17.2",
+    "husky": "7.0.4",
+    "jsdom": "19.0.0",
+    "minimatch": "5.0.1",
+    "mocha": "9.2.2",
     "nyc": "15.1.0",
     "proxyquire": "2.1.3",
-    "sass": "1.32.8",
-    "sinon": "9.2.4",
-    "sinon-chai": "3.5.0",
-    "supertest": "6.1.3",
-    "uglify-js": "3.12.8",
+    "sass": "1.50.0",
+    "sinon": "13.0.1",
+    "sinon-chai": "3.7.0",
+    "supertest": "6.2.2",
+    "uglify-js": "3.15.3",
     "uuid": "8.3.2",
-    "yargs": "16.2.0"
+    "yargs": "17.4.0"
   },
   "peerDependencies": {
     "express": "4.x",
@@ -100,7 +98,7 @@
     "quality:coverage": "nyc npm test",
     "quality:mutation": "stryker run",
     "security": "npm run security:vulnerable-packages",
-    "security:vulnerable-packages": "check-audit --registry=https://registry.npmjs.org --json | node -e 'a=JSON.parse(fs.readFileSync(\"/dev/stdin\",\"utf-8\")).metadata.vulnerabilities;process.exit(a.high+a.critical);'",
+    "security:vulnerable-packages": "npm audit --production --registry=https://registry.npmjs.org --json | node -e 'a=JSON.parse(fs.readFileSync(\"/dev/stdin\",\"utf-8\")).metadata.vulnerabilities;process.exit(a.high+a.critical);'",
     "package:changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
     "start-pen-test-service": "PORT=4000 node ./test/penetration/server.js",
     "compile-static-assets": "node ./scripts/compile-sass.js && node ./scripts/compile-js.js",

package/src/js/casa.js

@@ -7,10 +7,11 @@
   /**
    * Polyfill for attaching event listeners to elements.
    *
-   * @param {HTMLElement} obj Element to which event is attached
-   * @param {string} ev Event name
-   * @param {Function} func Listener
+   * @param {HTMLElement} obj Element to which event is attached.
+   * @param {string} ev Event name.
+   * @param {Function} func Listener.
    * @returns {void}
+   * @throws {Error}
    */
   function attachEventPolyfill(obj, ev, func) {
     if (obj.addEventListener) {
@@ -60,7 +61,7 @@
   /**
    * Attach show/hide functionalty.
    *
-   * @param {HTMLElement} node Element to init
+   * @param {HTMLElement} node Element to init.
    * @returns {void}
    */
   function casaV1InitShowHide(node) {
@@ -70,7 +71,8 @@
 
     /**
      * Show target.
-     * @param {HTMLElement} targetEl Target
+     *
+     * @param {HTMLElement} targetEl Target.
      * @returns {void}
      */
     function showTarget(targetEl) {
@@ -80,7 +82,8 @@
 
     /**
      * Hide target.
-     * @param {HTMLElement} targetEl Target
+     *
+     * @param {HTMLElement} targetEl Target.
      * @returns {void}
      */
     function hideTarget(targetEl) {
@@ -90,6 +93,7 @@
 
     /**
      * Click node.
+     *
      * @returns {void}
      */
     function clickNode() {

package/views/casa/layouts/main.njk

@@ -8,6 +8,15 @@
 {% endblock %}
 
 
+{% block skipLink %}
+  {# Harcoding content for the skip link as t() may not be availble on some error pages #}
+  {{ govukSkipLink({
+    href: '#main-content',
+    text: 'Neidio i\'r prif gynnwys' if locale === 'cy' else 'Skip to main content'
+  }) }}
+{% endblock %}
+
+
 {% block bodyStart %}
   <div id="global-cookie-message" class="js-hidden">
     {% include "casa/partials/cookie_message.njk" %}

package/src/robots.txt

@@ -1,2 +0,0 @@
-User-agent: *
-Disallow: /