@ukhomeoffice/cop-react-form-renderer 6.15.3-alpha → 6.15.4-alpha

package/dist/utils/Operate/doesContainValue.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Global imports.
+
+// Local imports.
+
+/**
+ * Returns if it can find a value in the form data. supports searching in arrays and objects
+ * @param {object} config The config of the operation.
+ * @param {string} config.target the JPath to the object/array that contains the data we want to checkon
+ * @param {string} config.key the JPath to the field we want to check
+ * @param {string} config.value the value that we want to check the the data against
+ * @param {object} data A page's formData.
+ * @returns The index of the matching value if one exists, or null.
+ */
+const doesContainValue = (config, data) => {
+  const targetPath = _copReactComponents.Utils.interpolateString(config.target, data);
+  const target = (0, _getSourceData.default)(data, targetPath);
+  if (target && Array.isArray(target)) {
+    return target.some(entry => config.key ? (0, _getSourceData.default)(entry, config.key) === config.value : entry === config.value);
+  }
+  if (target && typeof target === "object") {
+    return (0, _getSourceData.default)(target, config.key) === config.value;
+  }
+  return false;
+};
+var _default = exports.default = doesContainValue;

package/dist/utils/Operate/doesContainValue.test.js

@@ -0,0 +1,75 @@
+"use strict";
+
+var _doesContainValue = _interopRequireDefault(require("./doesContainValue"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+describe('doesContainValue', () => {
+  const mockData = {
+    arrayOfValues: ['abc', 'bcd', 'cde', 'def', {
+      root: {
+        branch: 'leaf'
+      }
+    }],
+    cutoffIndex: 1,
+    ignoreIndex: 2,
+    valueToSearchFor: 'cde',
+    targetName: 'arrayOfValues',
+    fieldName: 'valueToSearchFor',
+    cutoffName: 'cutoffIndex',
+    ignoreName: 'ignoreIndex'
+  };
+  test('returns true if value exists in array', () => {
+    const config = {
+      target: 'arrayOfValues',
+      value: 'cde'
+    };
+    const result = (0, _doesContainValue.default)(config, mockData);
+    expect(result).toBe(true);
+  });
+  test('returns false if value does not exist in array', () => {
+    const config = {
+      target: 'arrayOfValues',
+      value: 'xyz'
+    };
+    const result = (0, _doesContainValue.default)(config, mockData);
+    expect(result).toBe(false);
+  });
+  test('returns true if key-value pair matches in array object', () => {
+    const config = {
+      target: 'arrayOfValues',
+      key: 'root.branch',
+      value: 'leaf'
+    };
+    const result = (0, _doesContainValue.default)(config, mockData);
+    expect(result).toBe(true);
+  });
+  test('returns false if key-value pair does not match in array object', () => {
+    const config = {
+      target: 'arrayOfValues',
+      key: 'root.branch',
+      value: 'notLeaf'
+    };
+    const result = (0, _doesContainValue.default)(config, mockData);
+    expect(result).toBe(false);
+  });
+  test('handles non-array targets gracefully', () => {
+    const config = {
+      target: 'nonExistentTarget',
+      value: 'value'
+    };
+    const result = (0, _doesContainValue.default)(config, mockData);
+    expect(result).toBe(false);
+  });
+  test('handles objects as target correctly', () => {
+    const config = {
+      target: 'objectTarget',
+      key: 'key',
+      value: 'value'
+    };
+    const result = (0, _doesContainValue.default)(config, {
+      objectTarget: {
+        key: 'value'
+      }
+    });
+    expect(result).toBe(true);
+  });
+});

package/dist/utils/Operate/runPageOperations.js

@@ -14,6 +14,7 @@ var _shouldRun = _interopRequireDefault(require("./shouldRun"));
 var _setDataItem = _interopRequireDefault(require("../Data/setDataItem"));
 var _getFirstOf = _interopRequireDefault(require("./getFirstOf"));
 var _getLength = _interopRequireDefault(require("./getLength"));
+var _doesContainValue = _interopRequireDefault(require("./doesContainValue"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // Global imports.
 
@@ -22,6 +23,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 const functions = {
   checkValueIsTruthy: _checkValueIsTruthy.default,
   getIndexOfMatchingValueIn: _getIndexOfMatchingValueIn.default,
+  doesContainValue: _doesContainValue.default,
   persistValueInFormData: _persistValueInFormData.default,
   setValueInFormData: _setValueInFormData.default,
   deleteValueInFormData: _deleteValueInFormData.default,

package/dist/utils/Validate/validateOnPageLoad.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.doValidateOnPageLoad = void 0;
+var _Condition = _interopRequireDefault(require("../Condition"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const doValidateOnPageLoad = page => {
+  var _validation$runWhen, _validation$runWhen2;
+  if (!(page !== null && page !== void 0 && page.customValidation)) return false;
+
+  // Find the validation with `onLoad` set to true
+  const validation = page === null || page === void 0 ? void 0 : page.customValidation.find(item => {
+    var _item$runWhen;
+    return ((_item$runWhen = item.runWhen) === null || _item$runWhen === void 0 ? void 0 : _item$runWhen.onLoad) === true;
+  });
+  if (!validation) return false;
+
+  // Check if the constraint is met using the condition
+  return (_validation$runWhen = validation.runWhen) !== null && _validation$runWhen !== void 0 && _validation$runWhen.constraint ? _Condition.default.meetsOne((_validation$runWhen2 = validation.runWhen) === null || _validation$runWhen2 === void 0 ? void 0 : _validation$runWhen2.constraint, page.formData) : false;
+};
+exports.doValidateOnPageLoad = doValidateOnPageLoad;

package/dist/utils/Validate/validateOnPageLoad.test.js

@@ -0,0 +1,88 @@
+"use strict";
+
+var _Condition = _interopRequireDefault(require("../Condition"));
+var _validateOnPageLoad = require("./validateOnPageLoad");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+describe('doValidateOnPageLoad', () => {
+  const formData = {
+    people: [{
+      name: 'John Doe'
+    }, {
+      name: 'Jane Doe'
+    }]
+  };
+  it('should return false if page.customValidation is not defined', () => {
+    const page = {
+      formData
+    };
+    const result = (0, _validateOnPageLoad.doValidateOnPageLoad)(page);
+    expect(result).toBe(false);
+  });
+  it('should return false if no validation item has onLoad set to true', () => {
+    const page = {
+      customValidation: [{
+        message: "Validation without onLoad",
+        runWhen: {
+          onLoad: false
+        }
+      }],
+      formData
+    };
+    const result = (0, _validateOnPageLoad.doValidateOnPageLoad)(page);
+    expect(result).toBe(false);
+  });
+  it('should return false if validation constraint is not met', () => {
+    const page = {
+      customValidation: [{
+        message: "Update all people details before continuing",
+        runWhen: {
+          onLoad: true,
+          constraint: [{
+            field: 'people',
+            op: _Condition.default.GREATER_THAN,
+            value: 3 // Condition that will fail
+          }]
+        }
+      }],
+      formData
+    };
+    jest.spyOn(_Condition.default, 'meetsOne').mockImplementation(() => false);
+    const result = (0, _validateOnPageLoad.doValidateOnPageLoad)(page);
+    expect(result).toBe(false);
+    expect(_Condition.default.meetsOne).toHaveBeenCalledWith(page.customValidation[0].runWhen.constraint, formData);
+  });
+  it('should return true if validation constraint is met', () => {
+    const page = {
+      customValidation: [{
+        message: "Update all people details before continuing",
+        runWhen: {
+          onLoad: true,
+          constraint: [{
+            field: 'people',
+            op: _Condition.default.GREATER_THAN,
+            value: 0 // Condition that will pass
+          }]
+        }
+      }],
+      formData
+    };
+    jest.spyOn(_Condition.default, 'meetsOne').mockImplementation(() => true);
+    const result = (0, _validateOnPageLoad.doValidateOnPageLoad)(page);
+    expect(result).toBe(true);
+    expect(_Condition.default.meetsOne).toHaveBeenCalledWith(page.customValidation[0].runWhen.constraint, formData);
+  });
+  it('should return false if no matching validation is found', () => {
+    const page = {
+      customValidation: [{
+        message: "Validation without constraint",
+        runWhen: {
+          onLoad: true,
+          constraint: null
+        }
+      }],
+      formData
+    };
+    const result = (0, _validateOnPageLoad.doValidateOnPageLoad)(page);
+    expect(result).toBe(false);
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "6.15.3-alpha",
+  "version": "6.15.4-alpha",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,12 +16,12 @@
     "yalc-publish": "yarn compile-with-maps && cp -r src dist/src && yalc publish --push"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "4.7.4",
+    "@ukhomeoffice/cop-react-components": "4.7.15",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^5.0.0",
-    "web-vitals": "^1.0.1",
-    "uuid": "^8.1.0"
+    "uuid": "^8.1.0",
+    "web-vitals": "^1.0.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.15.4",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-chained-component-show-whens-containerised.json

@@ -1,119 +0,0 @@
-{
-  "id": "example-form",
-  "version": "0.0.1",
-  "name": "example-form",
-  "title": "Example form",
-  "type": "form",
-  "components": [
-    {
-      "id": "alpha-parent",
-      "fieldId": "alpha-parent",
-      "type": "container",
-      "components": [
-        {
-          "id": "alpha",
-          "fieldId": "alpha",
-          "label": "Alpha",
-          "type": "text",
-          "show_when": {
-            "op": "=",
-            "field": "bravo-parent.bravo",
-            "value": "bravo-value"
-          }
-        }
-      ]
-    },
-    {
-      "id": "bravo-parent",
-      "fieldId": "bravo-parent",
-      "type": "container",
-      "components": [
-        {
-          "id": "bravo",
-          "fieldId": "bravo",
-          "label": "Bravo",
-          "type": "text",
-          "show_when": {
-            "op": "=",
-            "field": "gamma-parent.gamma",
-            "value": "gamma-value"
-          }
-        }
-      ]
-    },
-    {
-      "id": "personKnown",
-      "fieldId": "personKnown",
-      "type": "radios",
-      "data": {
-        "options": [
-          {
-            "value": "yes",
-            "label": "Yes",
-            "nested": [
-              {
-                "id": "telephone",
-                "fieldId": "telephone",
-                "type": "text",
-                "label": "Telephone",
-                "required": true
-              }
-            ]
-          },
-          {
-            "value": "no",
-            "label": "No"
-          }
-        ]
-      }
-    },
-    {
-      "id": "gamma-parent",
-      "fieldId": "gamma-parent",
-      "type": "container",
-      "components": [
-        {
-          "id": "gamma",
-          "fieldId": "gamma",
-          "label": "Gamma",
-          "type": "text",
-          "show_when": {
-            "op": "=",
-            "field": "epsilon",
-            "value": "epsilon-value"
-          }
-        }
-      ]
-    },
-    {
-      "id": "epsilon",
-      "fieldId": "epsilon",
-      "label": "Epsilon",
-      "type": "text"
-    }
-  ],
-  "pages": [
-    {
-      "id": "visiblePage",
-      "name": "visiblePage",
-      "title": "Visible Page",
-      "components": [
-        {
-          "use": "alpha-parent"
-        },
-        {
-          "use": "bravo-parent"
-        },
-        {
-          "use": "personKnown"
-        },
-        {
-          "use": "gamma-parent"
-        },
-        {
-          "use": "epsilon"
-        }
-      ]
-    }
-  ]
-}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-chained-component-show-whens-dependent-component-nested-block.json

@@ -1,112 +0,0 @@
-{
-  "id": "example-form",
-  "version": "0.0.1",
-  "name": "example-form",
-  "title": "Example form",
-  "type": "form",
-  "components": [
-    {
-      "id": "alpha",
-      "fieldId": "alpha",
-      "label": "Alpha",
-      "type": "text"      
-    },
-    {
-      "id": "bravo",
-      "fieldId": "bravo",
-      "label": "Bravo",
-      "type": "text",
-      "show_when": [
-        {
-          "type": "or",
-          "conditions": [
-            {
-              "op": "=",
-              "field": "gamma",
-              "value": "NOT-gamma-value"
-            },
-            {
-              "op": "=",
-              "field": "epsilon",
-              "value": "NOT-epsilon-value"
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "id": "personKnown",
-      "fieldId": "personKnown",
-      "type": "radios",
-      "data": {
-        "options": [
-          {
-            "value": "yes",
-            "label": "Yes",
-            "nested": [
-              {
-                "id": "telephone",
-                "fieldId": "telephone",
-                "type": "text",
-                "label": "Telephone",
-                "required": true  
-              },
-              {
-                "id": "address",
-                "fieldId": "address",
-                "type": "text",
-                "label": "Address",
-                "required": true  
-              }
-            ],
-            "show_when": {
-              "op": "=",
-              "field": "bravo",
-              "value": "bravo-value"
-            }
-          },
-          {
-            "value": "no",
-            "label": "No"
-          }
-        ]
-      }
-    },
-    {
-      "id": "gamma",
-      "fieldId": "gamma",
-      "label": "Gamma",
-      "type": "text"
-    },
-    {
-      "id": "epsilon",
-      "fieldId": "epsilon",
-      "label": "Epsilon",
-      "type": "text"
-    }
-  ],
-  "pages": [
-    {
-      "id": "visiblePage",
-      "name": "visiblePage",
-      "title": "Visible Page",
-      "components": [
-        {
-          "use": "alpha"
-        },
-        {
-          "use": "bravo"
-        },
-        {
-          "use": "personKnown"
-        },
-        {
-          "use": "gamma"
-        },
-        {
-          "use": "epsilon"
-        }
-      ]
-    }
-  ]
-}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-chained-component-show-whens-dependent-component-nested.json

@@ -1,105 +0,0 @@
-{
-  "id": "example-form",
-  "version": "0.0.1",
-  "name": "example-form",
-  "title": "Example form",
-  "type": "form",
-  "components": [
-    {
-      "id": "alpha",
-      "fieldId": "alpha",
-      "label": "Alpha",
-      "type": "text"      
-    },
-    {
-      "id": "bravo",
-      "fieldId": "bravo",
-      "label": "Bravo",
-      "type": "text",
-      "show_when": [
-        {
-          "type": "or",
-          "conditions": [
-            {
-              "op": "=",
-              "field": "gamma",
-              "value": "NOT-gamma-value"
-            },
-            {
-              "op": "=",
-              "field": "epsilon",
-              "value": "NOT-epsilon-value"
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "id": "personKnown",
-      "fieldId": "personKnown",
-      "type": "radios",
-      "data": {
-        "options": [
-          {
-            "value": "yes",
-            "label": "Yes",
-            "nested": [
-              {
-                "id": "telephone",
-                "fieldId": "telephone",
-                "type": "text",
-                "label": "Telephone",
-                "required": true,
-                "show_when": {
-                  "op": "=",
-                  "field": "bravo",
-                  "value": "bravo-value"
-                }
-              }
-            ]
-          },
-          {
-            "value": "no",
-            "label": "No"
-          }
-        ]
-      }
-    },
-    {
-      "id": "gamma",
-      "fieldId": "gamma",
-      "label": "Gamma",
-      "type": "text"
-    },
-    {
-      "id": "epsilon",
-      "fieldId": "epsilon",
-      "label": "Epsilon",
-      "type": "text"
-    }
-  ],
-  "pages": [
-    {
-      "id": "visiblePage",
-      "name": "visiblePage",
-      "title": "Visible Page",
-      "components": [
-        {
-          "use": "alpha"
-        },
-        {
-          "use": "bravo"
-        },
-        {
-          "use": "personKnown"
-        },
-        {
-          "use": "gamma"
-        },
-        {
-          "use": "epsilon"
-        }
-      ]
-    }
-  ]
-}