@dwp/govuk-casa 8.5.2 → 8.7.0

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

@@ -91,9 +91,9 @@ export function validateSessionName(name?: string | undefined): string;
  * Validates and sanitises sessions secure flag.
  *
  * @access private
- * @param {boolean} [secure=false] Session secure flag.
+ * @param {boolean} [secure] Session secure flag.
  * @throws {ReferenceError} For missing value type.
- * @throws {TypeError} For invalid value.
+ * @throws {TypeError} For invalid or missing value.
  * @returns {string} Name.
  */
 export function validateSessionSecure(secure?: boolean | undefined): string;

package/dist/lib/configuration-ingestor.js

@@ -190,12 +190,15 @@ exports.validateSessionName = validateSessionName;
  * Validates and sanitises sessions secure flag.
  *
  * @access private
- * @param {boolean} [secure=false] Session secure flag.
+ * @param {boolean} [secure] Session secure flag.
  * @throws {ReferenceError} For missing value type.
- * @throws {TypeError} For invalid value.
+ * @throws {TypeError} For invalid or missing value.
  * @returns {string} Name.
  */
-function validateSessionSecure(secure = false) {
+function validateSessionSecure(secure) {
+    if (secure === undefined) {
+        throw new Error('Session secure flag must be explicitly defined (session.secure)');
+    }
     if (typeof secure !== 'boolean') {
         throw new TypeError('Session secure flag must be boolean (session.secure)');
     }

package/dist/lib/field.d.ts

@@ -3,15 +3,15 @@
  *
  * @memberof module:@dwp/govuk-casa
  * @param {string} name Field name
- * @param {object} opts Options
+ * @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`
  * @returns {PageField} A PageField
  */
-export default function field(name: string, opts: {
+export default function field(name: string, opts?: {
     optional?: boolean | undefined;
     persist?: boolean | undefined;
-}): PageField;
+} | undefined): PageField;
 /**
  * This class is not exposed via the public API. Instances should instead be
  * instantiated through the `field()` factory function.
@@ -23,14 +23,14 @@ export class PageField {
      * Create a field.
      *
      * @param {string} name Field name
-     * @param {object} opts Options
+     * @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`
      */
     constructor(name: string, { optional, persist }?: {
         optional?: boolean | undefined;
         persist?: boolean | undefined;
-    });
+    } | undefined);
     /**
      * Clone this field.
      *
@@ -68,32 +68,56 @@ export class PageField {
      * @throws {SyntaxError} When the name is invalid in some way
      */
     rename(name: string): PageField;
+    /**
+     * Get validators
+     *
+     * @returns {Validator[]} A list containing all validators.
+     */
+    getValidators(): Validator[];
     /**
      * Add/get value validators
      * Some validators will include a `sanitise()` method which will be run at the
      * same time as other "processors".
      *
      * @param {Validator[]} items Validation functions
-     * @returns {PageField | Validator[]} Chain or return all validators
+     * @returns {PageField} Chain - Deprecated: this currently gets all validators if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getValidators().
      */
-    validators(items?: Validator[]): PageField | Validator[];
+    validators(items?: Validator[]): PageField;
+    /**
+     * Get processors
+     *
+     * @returns {FieldProcessorFunction[]} A list containing all processors.
+     */
+    getProcessors(): FieldProcessorFunction[];
     /**
      * Add/get value pre-processors
      * This is most often used to sanitise values to a particular data type.
      *
      * @param {FieldProcessorFunction[]} items Processor functions
-     * @returns {PageField | FieldProcessorFunction[]} Chain or return all processors
+     * @returns {PageField} Chain - Deprecated: this currently gets all processors if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getProcessors().
+     */
+    processors(items?: FieldProcessorFunction[]): PageField;
+    /**
+     * Get conditions
+     *
+     * @returns {ValidatorConditionFunction[]} A list containing all conditions.
      */
-    processors(items?: FieldProcessorFunction[]): PageField | FieldProcessorFunction[];
+    getConditions(): ValidatorConditionFunction[];
     /**
      * Add/get conditions
      * All conditions must be met in order for this field to be considered
      * "actionable".
      *
      * @param {ValidatorConditionFunction[]} items Condition functions
-     * @returns {PageField | ValidatorConditionFunction[]} Chain or return all conditions
+     * @returns {PageField} Chain - Deprecated: this currently gets all conditions if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getConditions().
      */
-    conditions(items?: ValidatorConditionFunction[]): PageField | ValidatorConditionFunction[];
+    conditions(items?: ValidatorConditionFunction[]): PageField;
     /**
      * Run all validators and return array of errors, if applicable.
      *

package/dist/lib/field.js

@@ -18,6 +18,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PageField = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const utils_js_1 = require("./utils.js");
+const logger_js_1 = __importDefault(require("./logger.js"));
+const log = (0, logger_js_1.default)('lib:field');
 const { isFunction } = lodash_1.default;
 /**
  * @access private
@@ -58,7 +60,7 @@ class PageField {
      * Create a field.
      *
      * @param {string} name Field name
-     * @param {object} opts Options
+     * @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`
      */
@@ -98,6 +100,7 @@ class PageField {
             complexFieldProperty: undefined,
         }, "f");
         // Apply name
+        /* eslint-disable-next-line security/detect-non-literal-fs-filename */
         this.rename(name);
     }
     /**
@@ -110,14 +113,14 @@ class PageField {
             optional: __classPrivateFieldGet(this, _PageField_meta, "f").optional,
             persist: __classPrivateFieldGet(this, _PageField_meta, "f").persist,
         });
-        if (this.validators()) {
-            clone.validators(this.validators());
+        if (this.getValidators()) {
+            clone.validators(this.getValidators());
         }
-        if (this.conditions()) {
-            clone.conditions(this.conditions());
+        if (this.getConditions()) {
+            clone.conditions(this.getConditions());
         }
-        if (this.processors()) {
-            clone.processors(this.processors());
+        if (this.getProcessors()) {
+            clone.processors(this.getProcessors());
         }
         return clone;
     }
@@ -193,46 +196,79 @@ class PageField {
         }
         return this;
     }
+    /**
+     * Get validators
+     *
+     * @returns {Validator[]} A list containing all validators.
+     */
+    getValidators() {
+        return __classPrivateFieldGet(this, _PageField_validators, "f");
+    }
     /**
      * Add/get value validators
      * Some validators will include a `sanitise()` method which will be run at the
      * same time as other "processors".
      *
      * @param {Validator[]} items Validation functions
-     * @returns {PageField | Validator[]} Chain or return all validators
+     * @returns {PageField} Chain - Deprecated: this currently gets all validators if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getValidators().
      */
     validators(items = []) {
         if (!items.length) {
-            return __classPrivateFieldGet(this, _PageField_validators, "f");
+            log.warn('Calling validators() to get all validators is deprecated, please use getValidators()');
+            return this.getValidators();
         }
         __classPrivateFieldSet(this, _PageField_validators, [...__classPrivateFieldGet(this, _PageField_validators, "f"), ...(items.flat())], "f");
         return this;
     }
+    /**
+     * Get processors
+     *
+     * @returns {FieldProcessorFunction[]} A list containing all processors.
+     */
+    getProcessors() {
+        return __classPrivateFieldGet(this, _PageField_processors, "f");
+    }
     /**
      * Add/get value pre-processors
      * This is most often used to sanitise values to a particular data type.
      *
      * @param {FieldProcessorFunction[]} items Processor functions
-     * @returns {PageField | FieldProcessorFunction[]} Chain or return all processors
+     * @returns {PageField} Chain - Deprecated: this currently gets all processors if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getProcessors().
      */
     processors(items = []) {
         if (!items.length) {
-            return __classPrivateFieldGet(this, _PageField_processors, "f");
+            log.warn('Calling processors() to get all processors is deprecated, please use getProcessors()');
+            return this.getProcessors();
         }
         __classPrivateFieldSet(this, _PageField_processors, [...__classPrivateFieldGet(this, _PageField_processors, "f"), ...(items.flat())], "f");
         return this;
     }
+    /**
+     * Get conditions
+     *
+     * @returns {ValidatorConditionFunction[]} A list containing all conditions.
+     */
+    getConditions() {
+        return __classPrivateFieldGet(this, _PageField_conditions, "f");
+    }
     /**
      * Add/get conditions
      * All conditions must be met in order for this field to be considered
      * "actionable".
      *
      * @param {ValidatorConditionFunction[]} items Condition functions
-     * @returns {PageField | ValidatorConditionFunction[]} Chain or return all conditions
+     * @returns {PageField} Chain - Deprecated: this currently gets all conditions if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getConditions().
      */
     conditions(items = []) {
         if (!items.length) {
-            return __classPrivateFieldGet(this, _PageField_conditions, "f");
+            log.warn('Calling conditions() to get all conditions is deprecated, please use getConditions()');
+            return this.getConditions();
         }
         __classPrivateFieldSet(this, _PageField_conditions, [...__classPrivateFieldGet(this, _PageField_conditions, "f"), ...(items.flat())], "f");
         return this;
@@ -361,7 +397,7 @@ class PageField {
      * @returns {PageField} Chain
      */
     if(...args) {
-        return this.conditions(...args);
+        return this.conditions(args);
     }
 }
 exports.PageField = PageField;
@@ -371,7 +407,7 @@ _PageField_name = new WeakMap(), _PageField_processors = new WeakMap(), _PageFie
  *
  * @memberof module:@dwp/govuk-casa
  * @param {string} name Field name
- * @param {object} opts Options
+ * @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`
  * @returns {PageField} A PageField

package/dist/lib/waypoint-url.d.ts

@@ -9,25 +9,24 @@
  *   edit: true,
  *   editOrigin: '/somewhere/else'
  * })
- *
  * @memberof module:@dwp/govuk-casa
  * @param {object} obj Options
- * @param {string} obj.waypoint Waypoint
- * @param {string} obj.mountUrl Mount URL
- * @param {JourneyContext} obj.journeyContext JourneyContext
- * @param {boolean} obj.edit Turn edit mode on or off
- * @param {string} obj.editOrigin Edit mode original URL
- * @param {boolean} obj.skipTo Skip to this waypoint from the current one
- * @param {string} obj.routeName Plan route name; next | prev
+ * @param {string} [obj.waypoint=""] Waypoint
+ * @param {string} [obj.mountUrl="/"] Mount URL
+ * @param {JourneyContext} [obj.journeyContext] JourneyContext
+ * @param {boolean} [obj.edit=false] Turn edit mode on or off
+ * @param {string} [obj.editOrigin] Edit mode original URL
+ * @param {boolean} [obj.skipTo] Skip to this waypoint from the current one
+ * @param {string} [obj.routeName=next] Plan route name; next | prev
  * @returns {string} URL
  */
 export default function waypointUrl({ waypoint, mountUrl, journeyContext, edit, editOrigin, skipTo, routeName, }?: {
-    waypoint: string;
-    mountUrl: string;
-    journeyContext: JourneyContext;
-    edit: boolean;
-    editOrigin: string;
-    skipTo: boolean;
-    routeName: string;
+    waypoint?: string | undefined;
+    mountUrl?: string | undefined;
+    journeyContext?: import("./JourneyContext").default | undefined;
+    edit?: boolean | undefined;
+    editOrigin?: string | undefined;
+    skipTo?: boolean | undefined;
+    routeName?: string | undefined;
 }): string;
 export type JourneyContext = import('./index').JourneyContext;

package/dist/lib/waypoint-url.js

@@ -25,16 +25,15 @@ const sanitiseWaypoint = (w) => w.replace(/[^/a-z0-9_-]/ig, '').replace(/\/+/g,
  *   edit: true,
  *   editOrigin: '/somewhere/else'
  * })
- *
  * @memberof module:@dwp/govuk-casa
  * @param {object} obj Options
- * @param {string} obj.waypoint Waypoint
- * @param {string} obj.mountUrl Mount URL
- * @param {JourneyContext} obj.journeyContext JourneyContext
- * @param {boolean} obj.edit Turn edit mode on or off
- * @param {string} obj.editOrigin Edit mode original URL
- * @param {boolean} obj.skipTo Skip to this waypoint from the current one
- * @param {string} obj.routeName Plan route name; next | prev
+ * @param {string} [obj.waypoint=""] Waypoint
+ * @param {string} [obj.mountUrl="/"] Mount URL
+ * @param {JourneyContext} [obj.journeyContext] JourneyContext
+ * @param {boolean} [obj.edit=false] Turn edit mode on or off
+ * @param {string} [obj.editOrigin] Edit mode original URL
+ * @param {boolean} [obj.skipTo] Skip to this waypoint from the current one
+ * @param {string} [obj.routeName=next] Plan route name; next | prev
  * @returns {string} URL
  */
 function waypointUrl({ waypoint = '', mountUrl = '/', journeyContext, edit = false, editOrigin, skipTo, routeName = 'next', } = Object.create(null)) {

package/locales/cy/common.json

@@ -20,4 +20,4 @@
       }
     }
   }
-}
+}

package/locales/cy/macros.json

@@ -12,4 +12,4 @@
     "address4": "Sir",
     "postcode": "Cod post"
   }
-}
+}

package/locales/cy/review.json

@@ -5,4 +5,4 @@
     "containsErrors": "Mae'r dudalen hon yn cynnwys gwallau",
     "changeLink": "Newid"
   }
-}
+}

package/locales/cy/validation.json

@@ -78,4 +78,4 @@
       }
     }
   }
-}
+}

package/locales/en/common.json

@@ -20,4 +20,4 @@
       }
     }
   }
-}
+}

package/locales/en/review.json

@@ -5,4 +5,4 @@
     "containsErrors": "This page contains errors",
     "changeLink": "Change"
   }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.5.2",
+  "version": "8.7.0",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "repository": {
     "type": "git",
@@ -19,23 +19,28 @@
     "views/**/*"
   ],
   "engines": {
-    "node": ">=14.17.2"
+    "node": "^14.0.0 || ^16.0.0 || ^18.0.0",
+    "npm": "^8.0.0"
   },
   "scripts": {
     "pipeline": "npm run coverage && npm run lint",
+    "coverage": "c8 npm test",
+    "test": "npm run test:unit && npm run test:e2e",
     "test:unit": "mocha './tests/**/*.test.js'",
     "test:e2e": "spiderplan --worker-init ./tests/e2e/worker-init.js --language en ./tests/e2e/personas/**/*.yaml",
-    "test": "npm run test:unit && npm run test:e2e",
+    "test:dast": "spiderplan --worker-init ./tests/e2e/worker-init.js --language en ./tests/e2e/personas/**/traversal.yaml --workers 1 --zap --zap-proxy 'http://localhost:8080/' --zap-target-hostname 'host.docker.internal'",
+    "test:dast:report": "curl -s --header 'X-ZAP-Api-Key: secret' http://localhost:8080/OTHER/core/other/htmlreport > gl-dast-report.html",
+    "test:dast:setup": "docker run --rm --name casa-dast -d -u zap -p 8080:8080 -i owasp/zap2docker-stable zap.sh -daemon -host 0.0.0.0 -port 8080 -config api.addrs.addr.name=\".*\" -config api.addrs.addr.regex=true -config api.key=secret; npm run test:dast:ready-check",
+    "test:dast:ready-check": "while [ \"$(curl -Is -o /dev/null -w %{response_code} http://localhost:8080/)\" -ne \"200\" ]; do sleep 1; echo 'Waiting for ZAP to start ...'; done",
+    "test:dast:teardown": "docker stop casa-dast",
     "lint": "eslint .",
-    "coverage": "c8 npm test",
     "build": "npm run build:prepare && npm run build:sources && npm run build:css-assets",
     "build:prepare": "rm -rf dist/* && mkdir -p dist/assets/js/ && mkdir -p dist/assets/css/",
     "build:sources": "tsc -p tsconfig-cjs.json && ./scripts/fixup.sh",
     "build:css-assets": "node scripts/compile-sass.js",
     "build:api-docs": "npx jsdoc -c ./jsdoc.json -d ./docs/api/ --debug -P '' -r -R ./README.md --verbose -t ./node_modules/docdash ./src",
     "prepare": "npm run build",
-    "upgrade-deps": "OD=$(npm outdated --long --parseable); echo \"$OD\" | grep ':devDependencies:' | awk -F: '{ print $4 }' | xargs npm i -DE; echo \"$OD\" | grep ':dependencies:' | awk -F: '{ print $4 }' | xargs npm i -E",
-    "standard-version": "node scripts/standard-version.js"
+    "upgrade-deps": "OD=$(npm outdated --long --parseable); echo \"$OD\" | grep ':devDependencies:' | awk -F: '{ print $4 }' | xargs npm i -DE; echo \"$OD\" | grep ':dependencies:' | awk -F: '{ print $4 }' | xargs npm i -E"
   },
   "keywords": [],
   "author": "DWP Digital",
@@ -48,52 +53,49 @@
     "deepmerge": "4.2.2",
     "express": "4.18.2",
     "express-session": "1.17.3",
-    "govuk-frontend": "4.3.1",
+    "govuk-frontend": "4.4.0",
     "graphlib": "2.1.8",
-    "helmet": "5.1.1",
-    "i18next": "21.10.0",
+    "helmet": "6.0.0",
+    "i18next": "22.0.6",
     "i18next-http-middleware": "3.2.1",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
-    "luxon": "2.5.0",
+    "luxon": "3.1.0",
     "nunjucks": "3.2.3",
     "path-to-regexp": "6.2.1",
-    "uuid": "8.3.2",
+    "uuid": "9.0.0",
     "validator": "13.7.0"
   },
   "devDependencies": {
-    "@babel/core": "7.19.6",
+    "@babel/core": "7.20.2",
     "@babel/eslint-parser": "7.19.1",
-    "@babel/preset-env": "7.19.4",
-    "@ckeditor/jsdoc-plugins": "30.5.0",
-    "@commitlint/config-conventional": "17.1.0",
-    "@dwp/casa-spiderplan": "2.4.1",
-    "@dwp/casa-spiderplan-a11y-plugin": "0.1.4",
+    "@babel/preset-env": "7.20.2",
+    "@ckeditor/jsdoc-plugins": "31.1.9",
+    "@commitlint/config-conventional": "17.3.0",
+    "@dwp/casa-spiderplan": "2.5.1",
+    "@dwp/casa-spiderplan-a11y-plugin": "0.1.5",
     "@dwp/casa-spiderplan-zap-plugin": "0.1.1",
     "@dwp/eslint-config-base": "6.0.0",
     "@types/express": "4.17.14",
-    "@types/node": "18.11.8",
+    "@types/node": "18.11.9",
     "@types/nunjucks": "3.2.1",
-    "babel-eslint": "10.1.0",
     "c8": "7.12.0",
-    "chai": "4.3.6",
+    "chai": "4.3.7",
     "cheerio": "1.0.0-rc.12",
-    "commitlint": "17.1.2",
-    "docdash": "1.2.0",
-    "eslint": "8.26.0",
+    "commitlint": "17.3.0",
+    "docdash": "2.0.0",
+    "eslint": "8.28.0",
     "eslint-plugin-no-unsafe-regex": "1.0.0",
     "eslint-plugin-security": "1.5.0",
     "eslint-plugin-sonarjs": "0.16.0",
     "fast-check": "3.3.0",
-    "husky": "8.0.1",
-    "jsdoc": "3.6.11",
+    "jsdoc": "4.0.0",
     "jsdoc-tsimport-plugin": "1.0.5",
     "mocha": "10.1.0",
-    "sass": "1.55.0",
-    "sinon": "14.0.1",
+    "sass": "1.56.1",
+    "sinon": "14.0.2",
     "sinon-chai": "3.7.0",
-    "standard-version": "9.5.0",
     "supertest": "6.3.1",
-    "typescript": "4.8.4"
+    "typescript": "4.9.3"
   }
 }

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

@@ -99,4 +99,4 @@ You can also pass a locale:
 ```
 ```
 1 Ionawr 1980
-```
+```

package/views/casa/layouts/journey.njk

@@ -46,4 +46,4 @@
   }) %}
     {% block journey_form %}{% endblock %}
   {% endcall %}
-{% endblock %}
+{% endblock %}