@ukhomeoffice/cop-react-form-renderer 4.82.1 → 4.85.0

package/dist/context/HooksContext/HooksContext.js

@@ -41,10 +41,10 @@ var DEFAULT_HOOKS = {
   onSubmit: function onSubmit(type, payload, onSuccess, onError) {
     if (typeof onSuccess === 'function') onSuccess();
   },
-  onValidate: function onValidate(page) {
-    return [];
+  onValidate: function onValidate(page, errors) {
+    return errors;
   },
-  // Consuming application must provide functionality, otherwise this reports no errors.
+  // Returns the list of errors already found in FR by default.
   onCancel: function onCancel() {} // Consuming application must provide function to action, else this does nothing.
 };
 

package/dist/context/ValidationContext/ValidationContext.js

@@ -70,8 +70,7 @@ var ValidationContextProvider = function ValidationContextProvider(_ref) {
   var validate = {
     page: function page(_page) {
       var pageErrors = _utils.default.Validate.page(_page);
-      var hookPageErrors = hooks.onValidate(_page);
-      var allErrors = Array.isArray(hookPageErrors) ? pageErrors.concat(hookPageErrors) : pageErrors;
+      var allErrors = hooks.onValidate(_page, pageErrors);
       setErrors(allErrors);
       return allErrors;
     },
@@ -79,10 +78,9 @@ var ValidationContextProvider = function ValidationContextProvider(_ref) {
       var pagesErrors = _pages.flatMap(function (page) {
         return _utils.default.Validate.page(page);
       });
-      var hookPagesErrors = _pages.flatMap(function (page) {
-        return hooks.onValidate(page);
+      var allErrors = _pages.flatMap(function (page) {
+        return hooks.onValidate(page, pagesErrors);
       });
-      var allErrors = Array.isArray(hookPagesErrors) ? pagesErrors.concat(hookPagesErrors) : pagesErrors;
       setErrors(allErrors);
       return allErrors;
     }

package/dist/index.js

@@ -28,6 +28,12 @@ Object.defineProperty(exports, "FormTypes", {
     return _models.FormTypes;
   }
 });
+Object.defineProperty(exports, "HooksContextProvider", {
+  enumerable: true,
+  get: function get() {
+    return _context.HooksContextProvider;
+  }
+});
 Object.defineProperty(exports, "HubFormats", {
   enumerable: true,
   get: function get() {

package/dist/utils/CheckYourAnswers/showComponentCYA.js

@@ -9,6 +9,7 @@ var _Component = _interopRequireDefault(require("../Component"));
 var _Container = _interopRequireDefault(require("../Container"));
 var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/* eslint-disable no-console */
 // Local imports
 
 var EXCLUDE_FROM_CYA = [_models.ComponentTypes.ALERT, _models.ComponentTypes.HEADING, _models.ComponentTypes.HTML, _models.ComponentTypes.INSET_TEXT];
@@ -32,10 +33,17 @@ var showComponentCYA = function showComponentCYA(options, data) {
   if (Object.prototype.hasOwnProperty.call(options, 'show_on_cya') && !options.show_on_cya) {
     return false;
   }
-  if (options.hideOnCyaWhenEmpty && options.type === _models.ComponentTypes.COLLECTION) {
-    var itemCollectionsData = (0, _getSourceData.default)(data, options.full_path);
-    if (!(itemCollectionsData !== null && itemCollectionsData !== void 0 && itemCollectionsData.length)) {
-      return false;
+  if (options.hideOnCyaWhenEmpty) {
+    if (options.type === _models.ComponentTypes.COLLECTION) {
+      var itemCollectionsData = (0, _getSourceData.default)(data, options.full_path);
+      if (!(itemCollectionsData !== null && itemCollectionsData !== void 0 && itemCollectionsData.length)) {
+        return false;
+      }
+    } else {
+      var value = (0, _getSourceData.default)(data, options.fieldId);
+      if (!value && value !== false && value !== 0) {
+        return false;
+      }
     }
   }
   if (options.type === _models.ComponentTypes.CONTAINER) {

package/dist/utils/CheckYourAnswers/showComponentCYA.test.js

@@ -57,9 +57,9 @@ describe('utils', function () {
           type: _models.ComponentTypes.TEXT
         }, null)).toBeTruthy();
       });
-      it('should show when hideOnCyaWhenEmpty is defined and truthy', function () {
+      it('should show when hideOnCyaWhenEmpty is defined and falsy', function () {
         expect((0, _showComponentCYA.default)({
-          hideOnCyaWhenEmpty: true
+          hideOnCyaWhenEmpty: false
         })).toBeTruthy();
       });
       it('should show collection when hideOnCyaWhenEmpty is not defined', function () {
@@ -73,11 +73,11 @@ describe('utils', function () {
           type: _models.ComponentTypes.COLLECTION
         })).toBeFalsy();
       });
-      it('should show when it\'s not a collection and hideOnCyaWhenEmpty is truthy', function () {
+      it('should not show when it\'s not a collection and hideOnCyaWhenEmpty is truthy', function () {
         expect((0, _showComponentCYA.default)({
           hideOnCyaWhenEmpty: true,
           type: _models.ComponentTypes.TEXT
-        })).toBeTruthy();
+        })).toBeFalsy();
       });
       it('should show when length of full_path data is 1 or more', function () {
         expect((0, _showComponentCYA.default)({
@@ -97,6 +97,47 @@ describe('utils', function () {
           example: []
         })).toBeFalsy();
       });
+      it('should show when value of component data does exist and hideOnCyaWhenEmpty is truthy', function () {
+        expect((0, _showComponentCYA.default)({
+          hideOnCyaWhenEmpty: true,
+          type: _models.ComponentTypes.TEXT,
+          fieldId: "example"
+        }, {
+          example: "yes"
+        })).toBeTruthy();
+      });
+      it('should not show when value of component data does not exist and hideOnCyaWhenEmpty is truthy', function () {
+        expect((0, _showComponentCYA.default)({
+          hideOnCyaWhenEmpty: true,
+          type: _models.ComponentTypes.TEXT,
+          fieldId: "example"
+        }, {})).toBeFalsy();
+      });
+      it('should show when value of component data does not exist and hideOnCyaWhenEmpty is falsy', function () {
+        expect((0, _showComponentCYA.default)({
+          hideOnCyaWhenEmpty: false,
+          type: _models.ComponentTypes.TEXT,
+          fieldId: "example"
+        }, {})).toBeTruthy();
+      });
+      it('should show when value of component data does is falsy and hideOnCyaWhenEmpty is truthy', function () {
+        expect((0, _showComponentCYA.default)({
+          hideOnCyaWhenEmpty: true,
+          type: _models.ComponentTypes.TEXT,
+          fieldId: "example"
+        }, {
+          example: false
+        })).toBeTruthy();
+      });
+      it('should show when value of component data is numerically zero and hideOnCyaWhenEmpty is truthy', function () {
+        expect((0, _showComponentCYA.default)({
+          hideOnCyaWhenEmpty: true,
+          type: _models.ComponentTypes.TEXT,
+          fieldId: "example"
+        }, {
+          example: 0
+        })).toBeTruthy();
+      });
     });
   });
 });

package/dist/utils/Component/isEditable.js

@@ -10,7 +10,7 @@ var _models = require("../../models");
 var EDITABLE_TYPES = [_models.ComponentTypes.AUTOCOMPLETE, _models.ComponentTypes.CALCULATION, _models.ComponentTypes.CHECKBOXES, _models.ComponentTypes.DATE, _models.ComponentTypes.EMAIL, _models.ComponentTypes.FILE, _models.ComponentTypes.MULTI_FILE, _models.ComponentTypes.PHONE_NUMBER, _models.ComponentTypes.RADIOS, _models.ComponentTypes.SELECT, _models.ComponentTypes.TEXT, _models.ComponentTypes.TEXT_AREA, _models.ComponentTypes.TIME];
 exports.EDITABLE_TYPES = EDITABLE_TYPES;
 var isEditable = function isEditable(options) {
-  return EDITABLE_TYPES.includes(options === null || options === void 0 ? void 0 : options.type);
+  return EDITABLE_TYPES.includes(options === null || options === void 0 ? void 0 : options.type) || (options === null || options === void 0 ? void 0 : options.isEditable) || false;
 };
 var _default = isEditable;
 exports.default = _default;

package/dist/utils/Component/isEditable.test.js

@@ -33,6 +33,11 @@ describe('utils', function () {
           type: 'hidden'
         })).toEqual(false);
       });
+      it("should return true if options has 'isEditable' set to true", function () {
+        expect((0, _isEditable.default)({
+          isEditable: true
+        })).toEqual(true);
+      });
     });
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "4.82.1",
+  "version": "4.85.0",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",