@ukhomeoffice/cop-react-form-renderer 2.8.4 → 2.10.0

package/dist/utils/Validate/validateCollection.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _validateContainer = _interopRequireDefault(require("./validateContainer"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var validateCollection = function validateCollection(collection, items) {
+  var errors = [];
+
+  if (collection && Array.isArray(collection.item) && Array.isArray(items)) {
+    items.forEach(function (item, index) {
+      var full_path = "".concat(collection.full_path || collection.fieldId, "[").concat(index, "]");
+      var container = {
+        full_path: full_path,
+        components: collection.item.map(function (component) {
+          return _objectSpread(_objectSpread({}, component), {}, {
+            full_path: "".concat(full_path, ".").concat(component.fieldId)
+          });
+        })
+      };
+      errors.push((0, _validateContainer.default)(container, item));
+    });
+  }
+
+  return errors.filter(function (e) {
+    return !!e;
+  }).flat();
+};
+
+var _default = validateCollection;
+exports.default = _default;

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

@@ -0,0 +1,74 @@
+"use strict";
+
+var _models = require("../../models");
+
+var _validateCollection = _interopRequireDefault(require("./validateCollection"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+describe('utils.Validate.Collection', function () {
+  var setup = function setup(id, type, label, required, item) {
+    return {
+      id: id,
+      fieldId: id,
+      type: type,
+      label: label,
+      required: required,
+      item: item
+    };
+  };
+
+  it('should return an empty array when the component is null', function () {
+    expect((0, _validateCollection.default)(null, [])).toEqual([]);
+  });
+  it('should return an empty array when the collection has an undefined item array', function () {
+    var ID = 'collection';
+    var LABEL = 'field';
+    var COLLECTION = setup(ID, _models.ComponentTypes.COLLECTION, LABEL, false, undefined);
+    expect((0, _validateCollection.default)(COLLECTION, [])).toEqual([]);
+  });
+  it('should return an empty array when the collection has an empty item array', function () {
+    var ID = 'collection';
+    var LABEL = 'field';
+    var COLLECTION = setup(ID, _models.ComponentTypes.COLLECTION, LABEL, false, []);
+    expect((0, _validateCollection.default)(COLLECTION, [])).toEqual([]);
+  });
+  it('should return an empty array when the collection has only valid items', function () {
+    var EMAIL_ID = 'email';
+    var EMAIL_LABEL = 'Email';
+    var EMAIL = setup(EMAIL_ID, _models.ComponentTypes.EMAIL, EMAIL_LABEL, false);
+    var ID = 'collection';
+    var LABEL = 'field';
+    var COLLECTION = setup(ID, _models.ComponentTypes.COLLECTION, LABEL, false, [EMAIL]);
+    var ITEMS = [_defineProperty({}, EMAIL_ID, 'alpha.bravo@homeoffice.gov.uk'), _defineProperty({}, EMAIL_ID, 'charlie.delta@homeoffice.gov.uk')];
+    expect((0, _validateCollection.default)(COLLECTION, ITEMS)).toEqual([]);
+  });
+  it('should return an array containing an error when the collection has an invalid first item', function () {
+    var EMAIL_ID = 'email';
+    var EMAIL_LABEL = 'Email';
+    var EMAIL = setup(EMAIL_ID, _models.ComponentTypes.EMAIL, EMAIL_LABEL, false);
+    var ID = 'container';
+    var LABEL = 'field';
+    var COLLECTION = setup(ID, _models.ComponentTypes.CONTAINER, LABEL, false, [EMAIL]);
+    var ITEMS = [_defineProperty({}, EMAIL_ID, 'alpha.bravo@digital.homeoffice.com'), _defineProperty({}, EMAIL_ID, 'alpha.bravo@digital.homeoffice.gov.uk')];
+    expect((0, _validateCollection.default)(COLLECTION, ITEMS)).toEqual([{
+      id: "".concat(ID, "[0].").concat(EMAIL_ID),
+      error: "Enter ".concat(EMAIL_LABEL.toLowerCase(), " in the correct format, like jane.doe@homeoffice.gov.uk")
+    }]);
+  });
+  it('should return an array containing an error when the collection has an invalid second item', function () {
+    var EMAIL_ID = 'email';
+    var EMAIL_LABEL = 'Email';
+    var EMAIL = setup(EMAIL_ID, _models.ComponentTypes.EMAIL, EMAIL_LABEL, false);
+    var ID = 'container';
+    var LABEL = 'field';
+    var COLLECTION = setup(ID, _models.ComponentTypes.CONTAINER, LABEL, false, [EMAIL]);
+    var ITEMS = [_defineProperty({}, EMAIL_ID, 'alpha.bravo@digital.homeoffice.gov.uk'), _defineProperty({}, EMAIL_ID, 'alpha.bravo@digital.homeoffice.com')];
+    expect((0, _validateCollection.default)(COLLECTION, ITEMS)).toEqual([{
+      id: "".concat(ID, "[1].").concat(EMAIL_ID),
+      error: "Enter ".concat(EMAIL_LABEL.toLowerCase(), " in the correct format, like jane.doe@homeoffice.gov.uk")
+    }]);
+  });
+});

package/dist/utils/Validate/validateComponent.js

@@ -11,97 +11,116 @@ var _showComponent = _interopRequireDefault(require("../Component/showComponent"
 
 var _additional = _interopRequireDefault(require("./additional"));
 
-var _validateDate2 = _interopRequireDefault(require("./validateDate"));
+var _validateCollection = _interopRequireDefault(require("./validateCollection"));
+
+var _validateContainer = _interopRequireDefault(require("./validateContainer"));
+
+var _validateDate = _interopRequireDefault(require("./validateDate"));
 
 var _validateEmail = _interopRequireDefault(require("./validateEmail"));
 
 var _validateRequired = _interopRequireDefault(require("./validateRequired"));
 
-var _validateTime2 = _interopRequireDefault(require("./validateTime"));
+var _validateTime = _interopRequireDefault(require("./validateTime"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
-var validateContainer = function validateContainer(container, formData) {
-  var errors = [];
-
-  if (Array.isArray(container.components)) {
-    var fd = formData && container.fieldId ? formData[container.fieldId] : formData;
-    container.components.forEach(function (component) {
-      errors.push(validateComponent(component, fd));
-    });
-  }
-
-  return errors.filter(function (e) {
-    return !!e;
-  });
-};
 /**
  * Validates a single component.
  * @param {object} component The component to validate.
  * @param {object} formData The data to use that holds this component's value.
  * @returns The first encountered error with the component.
  */
+var validateComponent = function validateComponent(component, formData) {
+  var _component$data$optio;
 
+  if (!(0, _showComponent.default)(component, formData)) {
+    return undefined;
+  }
 
-var validateComponent = function validateComponent(component, formData) {
   var error = undefined;
+  var nestedId = undefined;
+  var propertiesInError = undefined;
   var data = formData && _typeof(formData) === 'object' ? formData : {};
 
-  if (component && (0, _showComponent.default)(component, formData)) {
-    if (component.type === _models.ComponentTypes.CONTAINER) {
-      return validateContainer(component, formData);
-    }
+  if (component.type === _models.ComponentTypes.CONTAINER) {
+    return (0, _validateContainer.default)(component, formData);
+  }
 
-    var value = data[component.fieldId];
-    delete component.propsInError;
+  var value = data[component.fieldId];
 
-    if (component.required) {
-      error = (0, _validateRequired.default)(value, component.label, component.custom_errors);
-    }
+  if (component.required) {
+    error = (0, _validateRequired.default)(value, component.label, component.custom_errors);
+  }
 
-    if (!error && component.type === _models.ComponentTypes.EMAIL) {
-      error = (0, _validateEmail.default)(value, component.label);
-    }
+  if (!error) {
+    switch (component.type) {
+      case _models.ComponentTypes.COLLECTION:
+        return (0, _validateCollection.default)(component, value);
 
-    if (!error && component.type === _models.ComponentTypes.DATE) {
-      var _validateDate = (0, _validateDate2.default)(value),
-          message = _validateDate.message,
-          propsInError = _validateDate.propsInError;
+      case _models.ComponentTypes.EMAIL:
+        error = (0, _validateEmail.default)(value, component.label);
+        break;
 
-      component.propsInError = propsInError;
-      error = message;
-    }
+      case _models.ComponentTypes.DATE:
+      case _models.ComponentTypes.TIME:
+        var validator = component.type === _models.ComponentTypes.DATE ? _validateDate.default : _validateTime.default;
+
+        var _validator = validator(value),
+            message = _validator.message,
+            propsInError = _validator.propsInError;
+
+        propertiesInError = propsInError;
+        error = message;
+        break;
 
-    if (!error && component.type === _models.ComponentTypes.TIME) {
-      var _validateTime = (0, _validateTime2.default)(value),
-          _message = _validateTime.message,
-          _propsInError = _validateTime.propsInError;
+      case _models.ComponentTypes.RADIOS:
+        (_component$data$optio = component.data.options) === null || _component$data$optio === void 0 ? void 0 : _component$data$optio.some(function (option) {
+          var nestedError;
 
-      component.propsInError = _propsInError;
-      error = _message;
+          if (option.nested && option.nested.shown) {
+            var _nestedError;
+
+            nestedError = validateComponent(option.nested, formData);
+            error = (_nestedError = nestedError) === null || _nestedError === void 0 ? void 0 : _nestedError.error;
+
+            if (nestedError) {
+              nestedId = nestedError.id;
+            }
+          }
+
+          return nestedError;
+        });
+        break;
+
+      default:
+        break;
     }
 
     if (!error && component.additionalValidation) {
       error = (0, _additional.default)(component, value);
 
       if (component.type === _models.ComponentTypes.DATE && error) {
-        component.propsInError = {
+        propertiesInError = {
           day: true,
           month: true,
           year: true
         };
       }
     }
+  }
 
-    component.error = error;
+  if (error) {
+    return {
+      id: nestedId || component.full_path || component.id,
+      error: error,
+      properties: propertiesInError
+    };
   }
 
-  return error ? {
-    id: component.id,
-    error: error
-  } : undefined;
+  return undefined;
 };
 
 var _default = validateComponent;