@dwp/govuk-casa 8.2.7 → 8.4.0

package/dist/lib/field.js

@@ -45,7 +45,7 @@ const { isFunction } = lodash_1.default;
  */
 // Quick check to see if the field name corresponds to a non-primitive complex
 // type. For example, `my_field[nested]`.
-const reComplexType = /\[/;
+const reComplexType = /^([^[]+)\[([^\]]+)\]/;
 const reInvalidName = /[^a-z0-9_.\-[\]]/i;
 /**
  * This class is not exposed via the public API. Instances should instead be
@@ -86,18 +86,40 @@ class PageField {
         if (!name) {
             throw new SyntaxError('A name for this field is required, i.e. "field(\'myField\')".');
         }
-        else if (reInvalidName.test(String(name))) {
-            throw new SyntaxError(`Field '${String(name)}' name contains invalid characters.`);
-        }
-        __classPrivateFieldSet(this, _PageField_name, String(name), "f");
+        __classPrivateFieldSet(this, _PageField_name, undefined, "f");
         __classPrivateFieldSet(this, _PageField_validators, [], "f");
         __classPrivateFieldSet(this, _PageField_processors, [], "f");
         __classPrivateFieldSet(this, _PageField_conditions, [], "f");
         __classPrivateFieldSet(this, _PageField_meta, {
             optional,
             persist,
-            complex: reComplexType.test(name),
+            complex: undefined,
+            complexFieldName: undefined,
+            complexFieldProperty: undefined,
         }, "f");
+        // Apply name
+        this.rename(name);
+    }
+    /**
+     * Clone this field.
+     *
+     * @returns {PageField} Cloned field
+     */
+    clone() {
+        const clone = new PageField(__classPrivateFieldGet(this, _PageField_name, "f"), {
+            optional: __classPrivateFieldGet(this, _PageField_meta, "f").optional,
+            persist: __classPrivateFieldGet(this, _PageField_meta, "f").persist,
+        });
+        if (this.validators()) {
+            clone.validators(this.validators());
+        }
+        if (this.conditions()) {
+            clone.conditions(this.conditions());
+        }
+        if (this.processors()) {
+            clone.processors(this.processors());
+        }
+        return clone;
     }
     /**
      * Extract this field's value from the given object.
@@ -107,29 +129,35 @@ class PageField {
      *
      * @param {object} obj Object from which to extract the value
      * @returns {any} Value extracted from object
-     * @throws {Error} When run on a complex field (not yet supported)
      */
     getValue(obj = Object.create(null)) {
-        if (!__classPrivateFieldGet(this, _PageField_meta, "f").complex) {
-            return obj[__classPrivateFieldGet(this, _PageField_name, "f")];
+        var _a;
+        if (__classPrivateFieldGet(this, _PageField_meta, "f").complex) {
+            return (_a = obj[__classPrivateFieldGet(this, _PageField_meta, "f").complexFieldName]) === null || _a === void 0 ? void 0 : _a[__classPrivateFieldGet(this, _PageField_meta, "f").complexFieldProperty];
         }
-        throw new Error('Not yet supporting complex field types');
+        return obj[__classPrivateFieldGet(this, _PageField_name, "f")];
     }
     /**
      * Store this field's value in the given object, using its name as the key.
      *
+     * For complex fields, the field object will be created if it does not yet
+     * exist, before then storing the property within that object.
+     *
      * @param {object} obj Object from which to extract the value
      * @param {any} value Value to be stored
      * @returns {any} Value extracted from object
-     * @throws {Error} When run on a complex field (not yet supported)
      */
     putValue(obj = Object.create(null), value = undefined) {
-        if (!__classPrivateFieldGet(this, _PageField_meta, "f").complex) {
+        var _a;
+        if (__classPrivateFieldGet(this, _PageField_meta, "f").complex) {
+            /* eslint-disable-next-line no-param-reassign */
+            obj[__classPrivateFieldGet(this, _PageField_meta, "f").complexFieldName] = Object.assign(Object.assign({}, ((_a = obj[__classPrivateFieldGet(this, _PageField_meta, "f").complexFieldName]) !== null && _a !== void 0 ? _a : {})), { [__classPrivateFieldGet(this, _PageField_meta, "f").complexFieldProperty]: value });
+        }
+        else {
             /* eslint-disable-next-line no-param-reassign */
             obj[__classPrivateFieldGet(this, _PageField_name, "f")] = value;
-            return this;
         }
-        throw new Error('Not yet supporting complex field types');
+        return this;
     }
     /* -------------------------------------------------------------- configure */
     get name() {
@@ -138,6 +166,33 @@ class PageField {
     get meta() {
         return __classPrivateFieldGet(this, _PageField_meta, "f");
     }
+    /**
+     * Rename this field.
+     *
+     * @param {string} name New name to be applied
+     * @returns {PageField} Chain
+     * @throws {SyntaxError} When the name is invalid in some way
+     */
+    rename(name) {
+        if (reInvalidName.test(String(name))) {
+            throw new SyntaxError(`Field '${String(name)}' name contains invalid characters.`);
+        }
+        // Complex names are only supported to one level deep. For example,
+        // `field[prop]` is supported, whilst `field[prop][subprop]` is not. Throw
+        // 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');
+        }
+        __classPrivateFieldSet(this, _PageField_name, String(name), "f");
+        __classPrivateFieldGet(this, _PageField_meta, "f").complex = isComplex;
+        // Extract the field name and property from a complex type for later use
+        if (isComplex) {
+            const parts = name.match(reComplexType);
+            [, __classPrivateFieldGet(this, _PageField_meta, "f").complexFieldName, __classPrivateFieldGet(this, _PageField_meta, "f").complexFieldProperty] = parts;
+        }
+        return this;
+    }
     /**
      * Add/get value validators
      * Some validators will include a `sanitise()` method which will be run at the

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

@@ -1,6 +1,15 @@
 /**
  * Generate a URL pointing at a particular waypoint.
  *
+ * @example
+ * // generates: /path/details?edit&editorigin=%2Fsomewhere%2Felse
+ * waypointUrl({
+ *   mountUrl: '/path/',
+ *   waypoint: 'details',
+ *   edit: true,
+ *   editOrigin: '/somewhere/else'
+ * })
+ *
  * @memberof module:@dwp/govuk-casa
  * @param {object} obj Options
  * @param {string} obj.waypoint Waypoint

package/dist/lib/waypoint-url.js

@@ -17,6 +17,15 @@ const sanitiseWaypoint = (w) => w.replace(/[^/a-z0-9_-]/ig, '').replace(/\/+/g,
 /**
  * Generate a URL pointing at a particular waypoint.
  *
+ * @example
+ * // generates: /path/details?edit&editorigin=%2Fsomewhere%2Felse
+ * waypointUrl({
+ *   mountUrl: '/path/',
+ *   waypoint: 'details',
+ *   edit: true,
+ *   editOrigin: '/somewhere/else'
+ * })
+ *
  * @memberof module:@dwp/govuk-casa
  * @param {object} obj Options
  * @param {string} obj.waypoint Waypoint

package/dist/middleware/steer-journey.js

@@ -57,7 +57,13 @@ exports.default = ({ waypoint, plan, }) => [
             startWaypoint: waypoint,
             stopCondition: () => (true), // stop at the first one
         });
-        res.locals.casa.journeyPreviousUrl = prevRoute.target ? (0, waypoint_url_js_1.default)({ mountUrl, waypoint: prevRoute.target, routeName: 'prev' }) : undefined;
+        res.locals.casa.journeyPreviousUrl = prevRoute.target ? (0, waypoint_url_js_1.default)({
+            mountUrl,
+            waypoint: prevRoute.target,
+            routeName: 'prev',
+            edit: req.casa.editMode,
+            editOrigin: req.casa.editOrigin,
+        }) : undefined;
         return next();
     },
 ];

package/locales/cy/validation.json

@@ -2,7 +2,17 @@
   "rule": {
     "dateObject": {
       "inline": "Rhowch ddyddiad dilys",
-      "summary": "Rhowch ddyddiad dilys"
+      "summary": "Rhowch ddyddiad dilys",
+
+      "afterOffset": {
+        "inline": "Rhowch ddyddiad o fewn yr ystod benodol",
+        "summary": "Rhowch ddyddiad o fewn yr ystod benodol"
+      },
+
+      "beforeOffset": {
+        "inline": "Rhowch ddyddiad o fewn yr ystod benodol",
+        "summary": "Rhowch ddyddiad o fewn yr ystod benodol"
+      }
     },
 
     "email": {

package/locales/en/validation.json

@@ -2,7 +2,17 @@
   "rule": {
     "dateObject": {
       "inline": "Enter a valid date",
-      "summary": "Enter a valid date"
+      "summary": "Enter a valid date",
+
+      "afterOffset": {
+        "inline": "Enter a date within the given range",
+        "summary": "Enter a date within the given range"
+      },
+
+      "beforeOffset": {
+        "inline": "Enter a date within the given range",
+        "summary": "Enter a date within the given range"
+      }
     },
 
     "email": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.2.7",
+  "version": "8.4.0",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "repository": {
     "type": "git",
@@ -48,52 +48,52 @@
     "deepmerge": "4.2.2",
     "express": "4.18.1",
     "express-session": "1.17.3",
-    "govuk-frontend": "4.0.1",
+    "govuk-frontend": "4.2.0",
     "graphlib": "2.1.8",
     "helmet": "5.1.0",
-    "i18next": "21.8.8",
+    "i18next": "21.8.14",
     "i18next-http-middleware": "3.2.1",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
-    "luxon": "2.4.0",
+    "luxon": "2.5.0",
     "nunjucks": "3.2.3",
     "path-to-regexp": "6.2.1",
     "uuid": "8.3.2",
     "validator": "13.7.0"
   },
   "devDependencies": {
-    "@babel/core": "7.18.2",
-    "@babel/eslint-parser": "7.18.2",
-    "@babel/preset-env": "7.18.2",
-    "@ckeditor/jsdoc-plugins": "30.2.0",
-    "@commitlint/config-conventional": "17.0.2",
-    "@dwp/casa-spiderplan": "2.4.0",
+    "@babel/core": "7.18.9",
+    "@babel/eslint-parser": "7.18.9",
+    "@babel/preset-env": "7.18.9",
+    "@ckeditor/jsdoc-plugins": "30.3.2",
+    "@commitlint/config-conventional": "17.0.3",
+    "@dwp/casa-spiderplan": "2.4.1",
     "@dwp/casa-spiderplan-a11y-plugin": "0.1.4",
     "@dwp/casa-spiderplan-zap-plugin": "0.1.1",
     "@dwp/eslint-config-base": "6.0.0",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.40",
+    "@types/node": "18.0.0",
     "@types/nunjucks": "3.2.1",
     "babel-eslint": "10.1.0",
     "c8": "7.11.3",
     "chai": "4.3.6",
-    "cheerio": "1.0.0-rc.11",
-    "commitlint": "17.0.2",
+    "cheerio": "1.0.0-rc.12",
+    "commitlint": "17.0.3",
     "docdash": "1.2.0",
-    "eslint": "8.17.0",
+    "eslint": "8.20.0",
     "eslint-plugin-no-unsafe-regex": "1.0.0",
     "eslint-plugin-security": "1.5.0",
     "eslint-plugin-sonarjs": "0.13.0",
-    "fast-check": "3.0.0",
+    "fast-check": "3.0.1",
     "husky": "8.0.1",
     "jsdoc": "3.6.10",
     "jsdoc-tsimport-plugin": "1.0.5",
     "mocha": "10.0.0",
-    "sass": "1.52.2",
+    "sass": "1.53.0",
     "sinon": "14.0.0",
     "sinon-chai": "3.7.0",
     "standard-version": "9.5.0",
-    "supertest": "6.2.3",
-    "typescript": "4.7.3"
+    "supertest": "6.2.4",
+    "typescript": "4.7.4"
   }
 }