@dwp/govuk-casa 8.2.8 → 8.3.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [8.3.0](https://github.com/dwp/govuk-casa/compare/8.2.8...8.3.0) (2022-06-30)
+
+
+### Features
+
+* add support for complex field names ([a380b01](https://github.com/dwp/govuk-casa/commit/a380b01ce22b8b7957ad4950e4189cc404b5d9c5))
+
 ### [8.2.8](https://github.com/dwp/govuk-casa/compare/8.2.7...8.2.8) (2022-06-29)
 
 ### [8.2.7](https://github.com/dwp/govuk-casa/compare/8.2.6...8.2.7) (2022-06-15)

package/dist/lib/field.d.ts

@@ -39,20 +39,29 @@ export 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): any;
     /**
      * 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, value?: any): any;
     get name(): string;
     get meta(): object;
+    /**
+     * 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: string): PageField;
     /**
      * Add/get value validators
      * Some validators will include a `sanitise()` method which will be run at the

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,19 @@ 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);
     }
     /**
      * Extract this field's value from the given object.
@@ -107,29 +108,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 +145,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.2.8",
+  "version": "8.3.0",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "repository": {
     "type": "git",