@ukhomeoffice/cop-react-form-renderer 4.0.0-alpha → 4.0.0

package/dist/components/FormRenderer/FormRenderer.js

@@ -332,6 +332,13 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
 
             break;
 
+          case _models.PageAction.TYPES.COLLECTION_REMOVE:
+            var activeId = formState.page.formData["".concat(action.collection, "ActiveId")];
+            formState.page.formData["".concat(action.collection)] = formState.page.formData["".concat(action.collection)].filter(function (entry) {
+              return entry.id !== activeId;
+            });
+            break;
+
           default:
             break;
         } // Save draft or submit.

package/dist/components/SummaryList/SummaryList.js

@@ -67,6 +67,14 @@ var SummaryList = function SummaryList(_ref) {
       });
     }
 
+    if (row.type === 'action') {
+      return /*#__PURE__*/_react.default.createElement("div", {
+        key: "".concat(key, "-actions")
+      }, /*#__PURE__*/_react.default.createElement(_GroupAction.default, {
+        group: row
+      }));
+    }
+
     return /*#__PURE__*/_react.default.createElement(_SummaryListRow.default, {
       key: key,
       row: row,

package/dist/hooks/useRefData.js

@@ -82,7 +82,7 @@ var useRefData = function useRefData(component, formData) {
       setStatus(STATUS_COMPLETE);
     } else if (_status === _useGetRequest2.STATUS_FETCHED) {
       if (_data) {
-        setData(_Data.default.refData.toOptions(_data.data, component.item));
+        setData(_Data.default.refData.toOptions(_data.data || _data, component.item));
       }
 
       setStatus(STATUS_COMPLETE);

package/dist/models/CollectionLabels.js

@@ -7,6 +7,7 @@ exports.default = void 0;
 var CollectionLabels = {
   add: 'Add another',
   remove: 'Remove',
+  change: 'Change',
   // eslint-disable-next-line no-template-curly-in-string
   item: 'Item ${index}'
 };

package/dist/models/PageAction.js

@@ -12,6 +12,7 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 var TYPE_CANCEL = 'cancel';
 var TYPE_COLLECTION_ADD = 'collectionAdd';
 var TYPE_COLLECTION_DUPLICATE = 'collectionDuplicate';
+var TYPE_COLLECTION_REMOVE = 'collectionRemove';
 var TYPE_NAVIGATE = 'navigate';
 var TYPE_SAVE_AND_CONTINUE = 'saveAndContinue';
 var TYPE_SAVE_AND_NAVIGATE = 'saveAndNavigate';
@@ -21,6 +22,7 @@ var PageActionTypes = {
   CANCEL: TYPE_CANCEL,
   COLLECTION_ADD: TYPE_COLLECTION_ADD,
   COLLECTION_DUPLICATE: TYPE_COLLECTION_DUPLICATE,
+  COLLECTION_REMOVE: TYPE_COLLECTION_REMOVE,
   NAVIGATE: TYPE_NAVIGATE,
   SAVE_AND_CONTINUE: TYPE_SAVE_AND_CONTINUE,
   SAVE_AND_NAVIGATE: TYPE_SAVE_AND_NAVIGATE,
@@ -33,7 +35,7 @@ var DefaultPageActions = (_DefaultPageActions = {}, _defineProperty(_DefaultPage
   validate: false,
   label: 'Cancel',
   classModifiers: 'secondary'
-}), _defineProperty(_DefaultPageActions, TYPE_COLLECTION_ADD, undefined), _defineProperty(_DefaultPageActions, TYPE_COLLECTION_DUPLICATE, undefined), _defineProperty(_DefaultPageActions, TYPE_NAVIGATE, undefined), _defineProperty(_DefaultPageActions, TYPE_SAVE_AND_CONTINUE, {
+}), _defineProperty(_DefaultPageActions, TYPE_COLLECTION_ADD, undefined), _defineProperty(_DefaultPageActions, TYPE_COLLECTION_DUPLICATE, undefined), _defineProperty(_DefaultPageActions, TYPE_COLLECTION_REMOVE, undefined), _defineProperty(_DefaultPageActions, TYPE_NAVIGATE, undefined), _defineProperty(_DefaultPageActions, TYPE_SAVE_AND_CONTINUE, {
   type: TYPE_SAVE_AND_CONTINUE,
   validate: true,
   label: 'Save and continue'

package/dist/utils/CheckYourAnswers/getCYACollectionChangeAction.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+var _models = require("../../models");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : 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 getCYACollectionChangeAction = function getCYACollectionChangeAction(page, item, _onAction, labelCount, action) {
+  var label = (action === null || action === void 0 ? void 0 : action.label) || _models.CollectionLabels.change;
+  return {
+    pageId: page.id,
+    fieldId: "change".concat(labelCount).concat(action.page),
+    key: "change".concat(labelCount).concat(action.page),
+    type: 'action',
+    action: {
+      onAction: function onAction(row) {
+        var changeCallback = function changeCallback(data) {
+          data["".concat(page.collection.name, "ActiveId")] = item.id;
+          return data;
+        };
+
+        var nextPage = row;
+
+        if (action.page) {
+          nextPage = {
+            pageId: action.page
+          };
+        }
+
+        _onAction(nextPage, changeCallback);
+      },
+      label: _copReactComponents.Utils.interpolateString(label, _objectSpread(_objectSpread({}, item), {}, {
+        index: labelCount
+      }))
+    }
+  };
+};
+
+var _default = getCYACollectionChangeAction;
+exports.default = _default;

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

@@ -0,0 +1,76 @@
+"use strict";
+
+var _getCYACollectionChangeAction = _interopRequireDefault(require("./getCYACollectionChangeAction"));
+
+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); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : 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; }
+
+describe('utils', function () {
+  describe('CheckYourAnswers', function () {
+    describe('getCYACollectionChangeAction', function () {
+      var PAGE = {
+        id: 2,
+        collection: {
+          name: 'collectionName'
+        }
+      };
+      var ITEM = {
+        id: 2
+      };
+      var TEST_DATA = {
+        page: _objectSpread({}, PAGE),
+        collectionName: [{
+          id: 1
+        }, {
+          id: 2
+        }, {
+          id: 3
+        }],
+        collectionNameActiveId: 3
+      };
+      it('should change activeId to the selected item and call onAction with the correct page', function () {
+        var ON_ACTION = function ON_ACTION(row, call_back) {
+          expect(row.id).toEqual(2);
+          TEST_DATA = call_back(TEST_DATA);
+        };
+
+        var action = (0, _getCYACollectionChangeAction.default)(PAGE, ITEM, ON_ACTION, 0, {});
+        action.action.onAction(PAGE);
+        expect(TEST_DATA.collectionNameActiveId).toEqual(2);
+      });
+      it('should get label to custom value', function () {
+        var action = (0, _getCYACollectionChangeAction.default)(PAGE, ITEM, function () {}, 0, {
+          label: 'customName'
+        });
+        expect(action.action.label).toEqual('customName');
+      });
+      it('should call onAction with a custom page', function () {
+        var PAGE_WITH_CUSTOM_DESTINATION = {
+          id: 2,
+          collection: {
+            name: 'collectionName',
+            actions: [{
+              type: 'change',
+              label: 'confirm delete',
+              page: 'confirmDelete'
+            }]
+          }
+        };
+
+        var ON_ACTION = function ON_ACTION(page, call_back) {
+          expect(page.pageId).toEqual('confirmDelete');
+          TEST_DATA = call_back(TEST_DATA);
+        };
+
+        var action = (0, _getCYACollectionChangeAction.default)(PAGE_WITH_CUSTOM_DESTINATION, ITEM, ON_ACTION, 0, PAGE_WITH_CUSTOM_DESTINATION.collection.actions[0]);
+        action.action.onAction({});
+        expect(TEST_DATA.collectionNameActiveId).toEqual(2);
+      });
+    });
+  });
+});

package/dist/utils/CheckYourAnswers/getCYACollectionDeleteAction.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+var _models = require("../../models");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : 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 getCYACollectionDeleteAction = function getCYACollectionDeleteAction(page, item, _onAction, labelCount, action) {
+  var label = (action === null || action === void 0 ? void 0 : action.label) || _models.CollectionLabels.remove;
+  return {
+    pageId: page.id,
+    fieldId: "delete".concat(labelCount),
+    key: "delete".concat(labelCount),
+    type: 'action',
+    action: {
+      onAction: function onAction() {
+        var deleteCallback = function deleteCallback(data) {
+          data["".concat(page.collection.name)] = data["".concat(page.collection.name)].filter(function (i) {
+            return i.id !== item.id;
+          });
+          return data;
+        };
+
+        _onAction(null, deleteCallback);
+      },
+      label: _copReactComponents.Utils.interpolateString(label, _objectSpread(_objectSpread({}, item), {}, {
+        index: labelCount
+      }))
+    }
+  };
+};
+
+var _default = getCYACollectionDeleteAction;
+exports.default = _default;

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

@@ -0,0 +1,59 @@
+"use strict";
+
+var _getCYACollectionDeleteAction = _interopRequireDefault(require("./getCYACollectionDeleteAction"));
+
+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); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : 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; }
+
+describe('utils', function () {
+  describe('CheckYourAnswers', function () {
+    describe('getCYACollectionDeleteAction', function () {
+      var PAGE = {
+        id: 'pageid',
+        collection: {
+          name: 'collectionName',
+          labels: {
+            remove: 'customName'
+          }
+        }
+      };
+      var ITEM = {
+        id: 2
+      };
+      var TEST_DATA = {
+        page: _objectSpread({}, PAGE),
+        collectionName: [{
+          id: 1
+        }, {
+          id: 2
+        }, {
+          id: 3
+        }]
+      };
+      it('should remove selected item from the form data', function () {
+        var data = null;
+
+        var ON_ACTION = function ON_ACTION(undefined, call_back) {
+          data = call_back(TEST_DATA);
+        };
+
+        var action = (0, _getCYACollectionDeleteAction.default)(PAGE, ITEM, ON_ACTION, 0, {});
+        action.action.onAction();
+        expect(data.collectionName.length).toEqual(2);
+        expect(data.collectionName[0].id).toEqual(1);
+        expect(data.collectionName[1].id).toEqual(3);
+      });
+      it('should get label to custom value', function () {
+        var action = (0, _getCYACollectionDeleteAction.default)(PAGE, ITEM, function () {}, 0, {
+          label: "customName"
+        });
+        expect(action.action.label).toEqual('customName');
+      });
+    });
+  });
+});

package/dist/utils/CheckYourAnswers/getCYARowsForCollectionPage.js

@@ -11,6 +11,10 @@ var _models = require("../../models");
 
 var _getCYARowsForContainer = _interopRequireDefault(require("./getCYARowsForContainer"));
 
+var _getCYACollectionDeleteAction = _interopRequireDefault(require("./getCYACollectionDeleteAction"));
+
+var _getCYACollectionChangeAction = _interopRequireDefault(require("./getCYACollectionChangeAction"));
+
 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); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -19,17 +23,6 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 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 getChangeActionForItem = function getChangeActionForItem(page, item, onAction) {
-  return function (row) {
-    var changeCallback = function changeCallback(data) {
-      data["".concat(page.collection.name, "ActiveId")] = item.id;
-      return data;
-    };
-
-    onAction(row, changeCallback);
-  };
-};
-
 var getContainerForPage = function getContainerForPage(page, item, labelCount, full_path) {
   return {
     id: item.id,
@@ -62,6 +55,23 @@ var getTitleRowForItem = function getTitleRowForItem(page, item, pageId, labelCo
   };
 };
 
+var getActionRows = function getActionRows(page, item, onAction, labelCount) {
+  var _page$collection, _page$collection$acti;
+
+  var actions = (_page$collection = page.collection) === null || _page$collection === void 0 ? void 0 : (_page$collection$acti = _page$collection.actions) === null || _page$collection$acti === void 0 ? void 0 : _page$collection$acti.map(function (action) {
+    if (action.type === 'remove') {
+      return (0, _getCYACollectionDeleteAction.default)(page, item, onAction, labelCount, action);
+    } else if (action.type === 'change') {
+      return (0, _getCYACollectionChangeAction.default)(page, item, onAction, labelCount, action);
+    } else {
+      return null;
+    }
+  }).filter(function (action) {
+    return !!action;
+  });
+  return actions;
+};
+
 var getCYARowsForCollectionPage = function getCYARowsForCollectionPage(page, onAction) {
   var _page$formData, _page$formData$page$c;
 
@@ -70,10 +80,11 @@ var getCYARowsForCollectionPage = function getCYARowsForCollectionPage(page, onA
     var labelCount = index + 1;
     var full_path = "".concat(page.collection.name, "[").concat(index, "]");
     var container = getContainerForPage(page, item, labelCount, full_path);
-    var itemChangeAction = getChangeActionForItem(page, item, onAction);
-    var containerRows = (0, _getCYARowsForContainer.default)(page, container, item, itemChangeAction);
+    var containerRows = (0, _getCYARowsForContainer.default)(page, container, item, undefined);
     var titleRow = getTitleRowForItem(page, item, page.id, labelCount, full_path);
+    var actionRows = getActionRows(page, item, onAction, labelCount);
     rows = rows.concat(titleRow);
+    rows = rows.concat(actionRows);
     rows = rows.concat(containerRows);
   });
   return rows.filter(function (row) {

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

@@ -23,7 +23,17 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
       name: 'collection',
       labels: {
         item: 'Collection entry ${index}'
-      }
+      },
+      actions: [{
+        type: 'change'
+      }, {
+        type: 'remove',
+        label: 'custom remove label'
+      }, {
+        type: 'change',
+        label: 'custom change label',
+        page: 'confirmDelete'
+      }]
     },
     title: 'Collection',
     components: [TEXT_COMP]
@@ -51,7 +61,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     });
 
     var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
-    expect(ROWS.length).toEqual(2); // Title row + component row
+    expect(ROWS.length).toEqual(5); // Title row + action rows + component row
 
     expect(ROWS[0].key).toEqual('Collection entry 1');
   });
@@ -71,7 +81,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     });
 
     var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
-    expect(ROWS.length).toEqual(2); // Title row + component row
+    expect(ROWS.length).toEqual(5); // Title row + action rows + component row
 
     expect(ROWS[0].key).toEqual('Item 1');
   });
@@ -91,17 +101,23 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     });
 
     var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
-    expect(ROWS.length).toEqual(4); // Title row + component row for each item
+    expect(ROWS.length).toEqual(10); // Title row + component row for each item
 
     expect(ROWS[0].type).toEqual('title');
     expect(ROWS[0].key).toEqual('Collection entry 1'); // Formatted according to collection.labels.item
 
-    expect(ROWS[1].value).toEqual('value');
-    expect(ROWS[1].key).toEqual('Test text');
-    expect(ROWS[2].type).toEqual('title');
-    expect(ROWS[2].key).toEqual('Collection entry 2'); // Formatted according to collection.labels.item
-
-    expect(ROWS[3].value).toEqual('value');
-    expect(ROWS[3].key).toEqual('Test text');
+    expect(ROWS[1].action.label).toEqual('Change');
+    expect(ROWS[2].action.label).toEqual('custom remove label');
+    expect(ROWS[3].action.label).toEqual('custom change label');
+    expect(ROWS[4].value).toEqual('value');
+    expect(ROWS[4].key).toEqual('Test text');
+    expect(ROWS[5].type).toEqual('title');
+    expect(ROWS[5].key).toEqual('Collection entry 2'); // Formatted according to collection.labels.item
+
+    expect(ROWS[6].action.label).toEqual('Change');
+    expect(ROWS[7].action.label).toEqual('custom remove label');
+    expect(ROWS[8].action.label).toEqual('custom change label');
+    expect(ROWS[9].value).toEqual('value');
+    expect(ROWS[9].key).toEqual('Test text');
   });
 });

package/dist/utils/Validate/additional/index.js

@@ -19,6 +19,10 @@ var _mustBeShorterThan = _interopRequireDefault(require("./mustBeShorterThan"));
 
 var _mustEnterAtLeastOne = _interopRequireDefault(require("./mustEnterAtLeastOne"));
 
+var _mustBeNumbersOnly = _interopRequireDefault(require("./mustBeNumbersOnly"));
+
+var _mustBeLessThan = _interopRequireDefault(require("./mustBeLessThan"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
@@ -29,7 +33,9 @@ var functions = {
   mustBeInTheFuture: _mustBeInTheFuture.default,
   mustBeLongerThan: _mustBeLongerThan.default,
   mustBeShorterThan: _mustBeShorterThan.default,
-  mustEnterAtLeastOne: _mustEnterAtLeastOne.default
+  mustEnterAtLeastOne: _mustEnterAtLeastOne.default,
+  mustBeNumbersOnly: _mustBeNumbersOnly.default,
+  mustBeLessThan: _mustBeLessThan.default
 };
 
 var additionalValidation = function additionalValidation(value, config, component) {

package/dist/utils/Validate/additional/mustBeLessThan.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+/**
+ * @param {string} string - the string to check value.
+ * @param {number} config.value - the string.value must be equal or less than config.value. 
+ * @returns true if sting value is equal to or less then config.value, false if not.
+ */
+var mustBeLessThan = function mustBeLessThan(string, config) {
+  if (!string) {
+    // null, undefined and empty strings should be picked up by the required flag
+    // and not considered here as they would be valid for optional fields.
+    return true;
+  }
+
+  return string < config.value;
+};
+
+var _default = mustBeLessThan;
+exports.default = _default;

package/dist/utils/Validate/additional/mustBeLessThan.test.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _mustBeLessThan = _interopRequireDefault(require("./mustBeLessThan"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('utils', function () {
+  describe('Validate', function () {
+    describe('additional', function () {
+      describe('mustBeShorterThan', function () {
+        test('should return true given a number equal to or less than 1000000000', function () {
+          var result = (0, _mustBeLessThan.default)(999999999.999, {
+            value: 1000000000
+          });
+          expect(result).toEqual(true);
+        });
+        test('should return false if provided value greater than 1000000000', function () {
+          var result = (0, _mustBeLessThan.default)('1000000000.9', {
+            value: 1000000000
+          });
+          expect(result).toBeFalsy();
+        });
+        test('should return true when string is undefined', function () {
+          var result = (0, _mustBeLessThan.default)(undefined, {
+            value: 3
+          });
+          expect(result).toEqual(true);
+        });
+        test('should return true when string is empty', function () {
+          var result = (0, _mustBeLessThan.default)('', {
+            value: 3
+          });
+          expect(result).toEqual(true);
+        });
+        test('should return true when string is null', function () {
+          var result = (0, _mustBeLessThan.default)(null, {
+            value: 3
+          });
+          expect(result).toEqual(true);
+        });
+      });
+    });
+  });
+});

package/dist/utils/Validate/additional/mustBeNumbersOnly.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+/**
+ * @returns true if number pass the regex, false if not.
+ */
+var mustBeNumbersOnly = function mustBeNumbersOnly(number) {
+  var numbersOnlyRegex = /^[0-9]*\.?[0-9]*$/;
+
+  if (!number) {
+    // null, undefined and empty numbers should be picked up by the required flag
+    // and not considered here as they would be valid for optional fields.
+    return true;
+  }
+
+  return numbersOnlyRegex.test(number);
+};
+
+var _default = mustBeNumbersOnly;
+exports.default = _default;

package/dist/utils/Validate/additional/mustBeNumbersOnly.test.js

@@ -0,0 +1,38 @@
+"use strict";
+
+var _mustBeNumbersOnly = _interopRequireDefault(require("./mustBeNumbersOnly"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('utils', function () {
+  describe('Validate', function () {
+    describe('additional', function () {
+      describe('mustBeNumbersOnly', function () {
+        test('should return true  given a string is number', function () {
+          var result = (0, _mustBeNumbersOnly.default)('349732');
+          expect(result).toEqual(true);
+        });
+        test('should return true given a string is numbers contains desimile', function () {
+          var result = (0, _mustBeNumbersOnly.default)('123456.123');
+          expect(result).toEqual(true);
+        });
+        test('should return false if given number contains letters', function () {
+          var result = (0, _mustBeNumbersOnly.default)('123124Hello');
+          expect(result).toEqual(false);
+        });
+        test('should return true when string is undefined', function () {
+          var result = (0, _mustBeNumbersOnly.default)(undefined);
+          expect(result).toEqual(true);
+        });
+        test('should return true when string is empty', function () {
+          var result = (0, _mustBeNumbersOnly.default)('');
+          expect(result).toEqual(true);
+        });
+        test('should return true when string is null', function () {
+          var result = (0, _mustBeNumbersOnly.default)(null);
+          expect(result).toEqual(true);
+        });
+      });
+    });
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "4.0.0-alpha",
+  "version": "4.0.0",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,7 +16,7 @@
     "post-compile": "rimraf dist/*.test.* dist/**/*.test.* dist/**/*.stories.* dist/docs dist/assets"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "2.0.0-alpha",
+    "@ukhomeoffice/cop-react-components": "^2.0.0",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^4.3.1",