@dwp/govuk-casa 8.7.9 → 8.7.12

package/README.md

@@ -2,7 +2,6 @@
 
 A framework for building forms based on the [GOV.UK Design System](https://design-system.service.gov.uk/).
 
-
 ## Features
 
 * Adopts the [GOVUK Design System](https://design-system.service.gov.uk/) which provides well-researched, accessible markup out of the box
@@ -12,7 +11,6 @@ A framework for building forms based on the [GOV.UK Design System](https://desig
 * Built on ExpressJS so offers a shallow learning curve
 * Distributable supports both ES6 and CommonJS codebases
 
-
 ## Getting started
 
 ```bash
@@ -23,19 +21,16 @@ npm -E @dwp/govuk-casa
 * [API Reference](docs/api-reference.md)
 * [Examples](examples/)
 
-
 ## Migrating between versions
 
 A series of migration guides are provided in [`docs/migration-guides/`](docs/migration-guides/) that should help you upgrade between major versions of CASA.
 
 Also see our [list of upcoming deprecations](DEPRECATIONS.md) that are planned for delivery in the next major version.
 
-
 ## Support
 
 CASA is maintained by the [DWP Engineering Practice](mailto:open-source@engineering.digital.dwp.gov.uk).
 
-
 ## Contributing
 
 If you'd like to contribute any changes, enhancements or report issues, please take a look at our [contribution notes](CONTRIBUTING.md) and [in-depth guidance](docs/contributors/index.md).

package/dist/casa.d.ts

@@ -427,7 +427,7 @@ export type PlanTraverseOptions = {
      */
     stopCondition?: Function | undefined;
     /**
-     * Mutliple target routes found, this decides which to use
+     * Multiple target routes found, this decides which to use
      */
     arbiter?: string | PlanArbiter | undefined;
 };

package/dist/casa.js

@@ -286,7 +286,7 @@ exports.nunjucksFilters = nunjucksFilters;
  * @property {string} routeName Follow routes matching this name (next | prev)
  * @property {Map} history Used to detect loops in traversal (INTERNAL USE ONLY)
  * @property {Function} [stopCondition] If true, traversal will be stopped (useful for performance)
- * @property {string|PlanArbiter} [arbiter] Mutliple target routes found, this decides which to use
+ * @property {string|PlanArbiter} [arbiter] Multiple target routes found, this decides which to use
  */
 /**
  * @typedef {object} PlanArbiterParams

package/dist/lib/CasaTemplateLoader.d.ts

@@ -15,13 +15,6 @@ export default class CasaTemplateLoader extends FileSystemLoader {
      * @param {FileSystemLoaderOptions} opts Loader options
      */
     constructor(searchPaths: string[], opts: FileSystemLoaderOptions);
-    /**
-     * Extract the source from the given template file.
-     *
-     * @param {string} name Source file path
-     * @returns {string} Source contents of template
-     */
-    getSource(name: string): string;
     /**
      * Add a modification function to the loader.
      *
@@ -34,5 +27,6 @@ export default class CasaTemplateLoader extends FileSystemLoader {
     #private;
 }
 export type FileSystemLoaderOptions = import('nunjucks').FileSystemLoaderOptions;
+export type LoaderSource = import('nunjucks').LoaderSource;
 export type BlockModifier = (templateName: string) => string;
 import { FileSystemLoader } from "nunjucks";

package/dist/lib/CasaTemplateLoader.js

@@ -17,6 +17,10 @@ const nunjucks_1 = require("nunjucks");
  * @access private
  * @typedef {import('nunjucks').FileSystemLoaderOptions} FileSystemLoaderOptions
  */
+/**
+ * @access private
+ * @typedef {import('nunjucks').LoaderSource} LoaderSource
+ */
 const VALID_BLOCKS = [
     'beforeContent',
     'bodyEnd',
@@ -58,7 +62,7 @@ class CasaTemplateLoader extends nunjucks_1.FileSystemLoader {
      * Extract the source from the given template file.
      *
      * @param {string} name Source file path
-     * @returns {string} Source contents of template
+     * @returns {LoaderSource} Source contents of template
      */
     getSource(name) {
         const source = super.getSource(name);

package/dist/lib/Plan.d.ts

@@ -214,6 +214,7 @@ export type PlanRoute = import('../casa').PlanRoute;
 export type PlanRouteCondition = import('../casa').PlanRouteCondition;
 export type PlanTraverseOptions = import('../casa').PlanTraverseOptions;
 export type PlanArbiter = import('../casa').PlanArbiter;
+export type Graph = any;
 export type PlanConstructorOptions = {
     /**
      * Check page validity before conditions

package/dist/lib/Plan.js

@@ -35,6 +35,10 @@ const log = (0, logger_js_1.default)('lib:plan');
  * @access private
  * @typedef {import('../casa').PlanArbiter} PlanArbiter
  */
+/**
+ * @access private
+ * @typedef {import('graphlib').Graph} Graph
+ */
 /**
  * @typedef {object} PlanConstructorOptions
  * @property {boolean} [validateBeforeRouteCondition=true] Check page validity before conditions
@@ -502,8 +506,8 @@ class Plan {
             });
             // When there's more than one candidate route to take, we need help to choose
             if (target.length > 1) {
-                const satisifed = target.map((t) => `${t.v} -> ${t.w}`);
-                log.debug(`Multiple routes were satisfied for "${routeName}" from "${startWP}" (${satisifed.join(' / ')}). Deciding how to resolve ...`);
+                const satisfied = target.map((t) => `${t.v} -> ${t.w}`);
+                log.debug(`Multiple routes were satisfied for "${routeName}" from "${startWP}" (${satisfied.join(' / ')}). Deciding how to resolve ...`);
                 if (arbiter === 'auto') {
                     log.debug('Using automatic arbitration process');
                     const targetNames = target.map(({ w }) => w);

package/dist/lib/ValidationError.js

@@ -53,7 +53,7 @@ class ValidationError {
                 focusSuffix: [],
             });
         }
-        // No contextual changes applicable; return ValidationErorr made from the
+        // No contextual changes applicable; return ValidationError made from the
         // original object
         if (isPlainObject(errorMsg)) {
             return new ValidationError(errorMsg);

package/dist/lib/configuration-ingestor.d.ts

@@ -1,5 +1,5 @@
 /**
- * Validates and sanitises i18n obejct.
+ * Validates and sanitises i18n object.
  *
  * @access private
  * @param {object} i18n Object to validate.

package/dist/lib/configuration-ingestor.js

@@ -20,7 +20,7 @@ const utils_js_1 = require("./utils.js");
 const log = (0, logger_js_1.default)('lib:configuration-ingestor');
 const echo = (a) => (a);
 /**
- * Validates and sanitises i18n obejct.
+ * Validates and sanitises i18n object.
  *
  * @access private
  * @param {object} i18n Object to validate.

package/dist/lib/nunjucks-filters.js

@@ -29,8 +29,34 @@ const combineMerge = (target, source, options) => {
     });
     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]';
+}
+function isPlainObjectOrArray(o) {
+    if (Array.isArray(o)) {
+        return true;
+    }
+    if (isObject(o) === false) {
+        return false;
+    }
+    const ctor = o.constructor;
+    if (ctor === undefined) {
+        return true;
+    }
+    const prot = ctor.prototype;
+    if (isObject(prot) === false) {
+        return false;
+    }
+    // eslint-disable-next-line no-prototype-builtins
+    if (prot.hasOwnProperty('isPrototypeOf') === false) {
+        return false;
+    }
+    return true;
+}
 function mergeObjects(...objects) {
-    return deepmergeAll([Object.create(null), ...objects], { arrayMerge: combineMerge });
+    return deepmergeAll([Object.create(null), ...objects], { arrayMerge: combineMerge, isMergeableObject: isPlainObjectOrArray });
 }
 exports.mergeObjects = mergeObjects;
 /**

package/dist/lib/utils.d.ts

@@ -3,7 +3,7 @@
  * @typedef {import('../casa').GlobalHook | import('../casa').PageHook} Hook
  */
 /**
- * Test is a value can be stringifed (numbers or strings)
+ * Test is a value can be stringified (numbers or strings)
  *
  * @access private
  * @param {any} value Item to test

package/dist/lib/utils.js

@@ -6,7 +6,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.notProto = exports.validateHookPath = exports.validateHookName = exports.validateView = exports.validateUrlPath = exports.validateWaypoint = exports.resolveMiddlewareHooks = exports.isEmpty = exports.stringifyInput = exports.isStringable = void 0;
 /**
- * Test is a value can be stringifed (numbers or strings)
+ * Test is a value can be stringified (numbers or strings)
  *
  * @access private
  * @param {any} value Item to test

package/dist/lib/validators/dateObject.js

@@ -124,7 +124,7 @@ class DateObject extends ValidatorFactory_js_1.default {
             if (!Object.prototype.hasOwnProperty.call(value, 'yyyy') || !value.yyyy) {
                 errorMsg.focusSuffix.push('[yyyy]');
             }
-            // If the date is invalid, but not specific parts have been highighted in
+            // If the date is invalid, but not specific parts have been highlighted in
             // error, then highlight all inputs, focusing on the [dd] first
             if (!valid && !errorMsg.focusSuffix.length) {
                 errorMsg.focusSuffix = ['[dd]', '[mm]', '[yyyy]'];

package/dist/lib/validators/required.d.ts

@@ -10,7 +10,7 @@
  * Test if value is present.
  *
  * Value is required. The following values will fail this rule:
- *  (all values that satisify `isEmpty()`) plus '\s'
+ *  (all values that satisfy `isEmpty()`) plus '\s'
  *
  * See {@link RequiredConfigOptions} for `make()` options.
  *

package/dist/lib/validators/required.js

@@ -21,7 +21,7 @@ const { isPlainObject } = lodash_1.default; // CommonJS
  * Test if value is present.
  *
  * Value is required. The following values will fail this rule:
- *  (all values that satisify `isEmpty()`) plus '\s'
+ *  (all values that satisfy `isEmpty()`) plus '\s'
  *
  * See {@link RequiredConfigOptions} for `make()` options.
  *

package/dist/middleware/gather-fields.js

@@ -26,7 +26,7 @@ const JourneyContext_js_1 = __importDefault(require("../lib/JourneyContext.js"))
 exports.default = ({ waypoint, fields = [], }) => [
     (req, res, next) => {
         // Store a copy of the journey context before modifying it. This is useful
-        // for any comparison work that may be done in subseqent middleware.
+        // for any comparison work that may be done in subsequent middleware.
         req.casa.archivedJourneyContext = JourneyContext_js_1.default.fromContext(req.casa.journeyContext);
         // Ignore data for any non-persistent fields
         // ESLint disabled as `fields`, `i` and `name` are dev-controlled

package/dist/middleware/strip-proxy-path.js

@@ -40,7 +40,7 @@ exports.default = ({ mountUrl = '/', }) => [
         }
         else {
             // Strip the proxy path prefix from the original URL so that
-            // subsequnt middleware sees the URL path as though proxy wasn't there.
+            // subsequent middleware sees the URL path as though proxy wasn't there.
             // req.url will already have the proxy prefix and mountUrl removed.
             /* eslint-disable security/detect-non-literal-regexp */
             log.trace(`req.originalUrl before proxy stripping: ${req.originalUrl}`);

package/dist/middleware/validate-fields.js

@@ -20,7 +20,7 @@ exports.default = ({ waypoint, fields = [], plan, }) => [
     (req, res, next) => {
         var _a, _b;
         const mountUrl = `${req.baseUrl}/`;
-        // Run validators for every field to build up a compelte list of errors
+        // Run validators for every field to build up a complete list of errors
         // currently associated with this waypoint.
         let errors = [];
         for (let i = 0, l = fields.length; i < l; i++) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.7.9",
+  "version": "8.7.12",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "repository": {
     "type": "git",
@@ -50,50 +50,50 @@
     "cookie-parser": "1.4.6",
     "csurf": "1.11.0",
     "debug": "4.3.4",
-    "deepmerge": "4.3.0",
+    "deepmerge": "4.3.1",
     "express": "4.18.2",
     "express-session": "1.17.3",
     "govuk-frontend": "4.5.0",
     "graphlib": "2.1.8",
     "helmet": "6.0.1",
-    "i18next": "22.4.10",
-    "i18next-http-middleware": "3.2.2",
+    "i18next": "22.4.12",
+    "i18next-http-middleware": "3.3.0",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
-    "luxon": "3.2.1",
+    "luxon": "3.3.0",
     "nunjucks": "3.2.3",
     "path-to-regexp": "6.2.1",
     "uuid": "9.0.0",
     "validator": "13.9.0"
   },
   "devDependencies": {
-    "@babel/core": "7.21.0",
-    "@babel/eslint-parser": "7.19.1",
+    "@babel/core": "7.21.3",
+    "@babel/eslint-parser": "7.21.3",
     "@babel/preset-env": "7.20.2",
-    "@ckeditor/jsdoc-plugins": "34.0.2",
+    "@ckeditor/jsdoc-plugins": "35.0.3",
     "@commitlint/config-conventional": "17.4.4",
     "@dwp/casa-spiderplan": "2.5.4",
     "@dwp/casa-spiderplan-a11y-plugin": "0.1.10",
     "@dwp/casa-spiderplan-zap-plugin": "0.1.6",
     "@dwp/eslint-config-base": "6.1.0",
     "@types/express": "4.17.17",
-    "@types/node": "18.14.1",
+    "@types/node": "18.15.3",
     "@types/nunjucks": "3.2.2",
     "c8": "7.13.0",
     "chai": "4.3.7",
     "cheerio": "1.0.0-rc.12",
     "commitlint": "17.4.4",
     "docdash": "2.0.1",
-    "eslint": "8.34.0",
+    "eslint": "8.36.0",
     "eslint-plugin-no-unsafe-regex": "1.0.0",
     "eslint-plugin-security": "1.7.1",
     "eslint-plugin-sonarjs": "0.18.0",
-    "fast-check": "3.7.0",
+    "fast-check": "3.7.1",
     "jsdoc": "4.0.2",
     "jsdoc-tsimport-plugin": "1.0.5",
     "mocha": "10.2.0",
-    "sass": "1.58.3",
-    "sinon": "15.0.1",
+    "sass": "1.59.3",
+    "sinon": "15.0.2",
     "sinon-chai": "3.7.0",
     "supertest": "6.3.3",
     "typescript": "4.9.5"

package/views/casa/components/checkboxes/README.md

@@ -10,7 +10,6 @@ Custom parameters:
 * `casaErrors` - form errors (just pass `formErrors`)
 * `casaWithAnalytics` - enable DWP's conventional Google Analytics attributes (`data-ga-question` and `data-ga-answer`) - `false` by default; **IMPORTANT: DO NOT ENABLE this option if the question or answer may contain personally-identifiable information as values will be pushed to Google**
 
-
 ## Example usage
 
 Basic example:
@@ -76,7 +75,7 @@ casaGovukCheckboxes({
 
 ## Displaying errors
 
-ref: https://design-system.service.gov.uk/components/error-summary/
+ref: <https://design-system.service.gov.uk/components/error-summary/>
 
 The error summary link must set focus on the first checkbox in the group. Unless you have specified an explicit `id` for the first item in the list, this macro will explicitly set that `id` to `f-<name>`, e.g. `f-preferences` in order for links from the error summary to work as expected.
 
@@ -89,4 +88,4 @@ The following attributes will be attached to each `<input>` option if `casaWithA
 
 These are the conventions used by DWP.
 
-**IMPORTANT: DO NOT ENABLE this option if the question or answer may contain personally-identifiable information as values will be pushed to Google**
+> **IMPORTANT:** DO NOT ENABLE this option if the question or answer may contain personally-identifiable information as values will be pushed to Google

package/views/casa/components/date-input/README.md

@@ -88,7 +88,8 @@ The `formatDateObject()` Nunjucks filter will take a date object captured with t
 ```nunjucks
 {{ myDate | formatDateObject }}
 ```
-```
+
+```nunjucks
 1 January 1980
 ```
 
@@ -97,6 +98,7 @@ You can also pass a locale:
 ```nunjucks
 {{ myDate | formatDateObject({ locale: 'cy' }) }}
 ```
-```
+
+```nunjucks
 1 Ionawr 1980
 ```

package/views/casa/components/journey-form/README.md

@@ -5,7 +5,8 @@ Component to wrap your form inputs in a `<form>` that contains all the required
 A "Continue" button (and "Cancel" link if in edit mode) will also be added.
 
 - [1.3.5: Identify Input Purpose](https://www.w3.org/WAI/WCAG21/Understanding/identify-input-purpose.html)
-- [<form>: The Form element - autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#attr-autocomplete)
+- [`<form>`: The Form element - autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#attr-autocomplete)
+
 ## Example usage
 
 ```nunjucks
@@ -51,7 +52,7 @@ Note that the submit button is configured to prevent double-clicks and avoid dup
 | Name | Type | Required | Description |
 |------|------|----------|-------------|
 | `formUrl` | string | Yes | The form's "action", available in a `formUrl` template variable |
-| `autoComplete` | string | No | Allows you to override the autocomplete paramater  - the default value is 'off'
+| `autoComplete` | string | No | Allows you to override the autocomplete parameter  - the default value is 'off'
 | `csrfToken` | string | Yes | Token used to protect form from CSRF (available to user's templates via the global `casa.csrfToken` variable) |
 | `inEditMode` | boolean | No | Toggle edit-mode of the form (available to page templates using default GET/POST handlers via the local `inEditMode` variable) |
 | `editOriginUrl` | string | No | Absolute URL to the page from which the edit request came (defaults to `review`) (available to user's templates using default GET/POST handlers via the local `editOriginUrl` variable) |

package/views/casa/components/radios/README.md

@@ -57,7 +57,7 @@ If you want one of the radio items to toggle the display of an element:
 
 ## Displaying errors
 
-ref: https://design-system.service.gov.uk/components/error-summary/
+ref: <https://design-system.service.gov.uk/components/error-summary/>
 
 The error summary link must set focus on the first radio in the group. Unless you have specified an explicit `id` for the first item in the list, this macro will explicitly set that `id` to `f-<name>`, e.g. `f-preferences` in order for links from the error summary to work as expected.
 
@@ -70,4 +70,4 @@ The following attributes will be attached to each `<input>` option if `casaWithA
 
 These are the conventions used by DWP.
 
-**IMPORTANT: DO NOT ENABLE this option if the question or answer may contain personally-identifiable information as values will be pushed to Google**
+> **IMPORTANT:** DO NOT ENABLE this option if the question or answer may contain personally-identifiable information as values will be pushed to Google

package/views/casa/layouts/main.njk

@@ -7,7 +7,7 @@
 
 
 {% block skipLink %}
-  {# Harcoding content for the skip link as t() may not be availble on some error pages #}
+  {# Hardcoding content for the skip link as t() may not be available on some error pages #}
   {{ govukSkipLink({
     href: '#main-content',
     text: "Neidio i'r prif gynnwys" if locale === 'cy' else 'Skip to main content'