@ukhomeoffice/cop-react-form-renderer 4.16.3 → 4.17.0

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

@@ -9,6 +9,8 @@ var _mustBeAfter = _interopRequireDefault(require("./mustBeAfter"));
 
 var _mustBeBefore = _interopRequireDefault(require("./mustBeBefore"));
 
+var _mustBeEarlierDateTime = _interopRequireDefault(require("./mustBeEarlierDateTime"));
+
 var _mustBeInThePast = _interopRequireDefault(require("./mustBeInThePast"));
 
 var _mustBeInTheFuture = _interopRequireDefault(require("./mustBeInTheFuture"));
@@ -29,6 +31,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 var functions = {
   mustBeAfter: _mustBeAfter.default,
   mustBeBefore: _mustBeBefore.default,
+  mustBeEarlierDateTime: _mustBeEarlierDateTime.default,
   mustBeInThePast: _mustBeInThePast.default,
   mustBeInTheFuture: _mustBeInTheFuture.default,
   mustBeLongerThan: _mustBeLongerThan.default,

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

@@ -0,0 +1,67 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _dayjs = _interopRequireDefault(require("dayjs"));
+
+var _customParseFormat = _interopRequireDefault(require("dayjs/plugin/customParseFormat"));
+
+var _validateComponent = _interopRequireDefault(require("../validateComponent"));
+
+var _utils = require("./utils");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Global Imports
+//Local imports
+_dayjs.default.extend(_customParseFormat.default);
+/**
+ * Checks whether the combination of a given date & time input is in the past.
+ * NOTE: This additional validation will only work for containers. They get the
+ * date & time from their children - if there's an error then it can be displayed
+ * by wrapping both components.
+ * 
+ * @param {object} data A page's formData.
+ * @param {object} config An additionalValidation config obj.
+ * @param {object} container A config obj for a container.
+ * @returns True if the date & time are in the past, or there are errors with
+ * the individual components. False if the date & time is in the future, or
+ * the date/time component can't be found.
+ */
+
+
+var mustBeEarlierDateTime = function mustBeEarlierDateTime(data, config, container) {
+  var _container$components, _container$components2, _data$container$field, _data$container$field2;
+
+  var date = (_container$components = container.components) === null || _container$components === void 0 ? void 0 : _container$components.find(function (c) {
+    return c.fieldId === config.date;
+  });
+  var time = (_container$components2 = container.components) === null || _container$components2 === void 0 ? void 0 : _container$components2.find(function (c) {
+    return c.fieldId === config.time;
+  });
+
+  if (!date || !time || !data) {
+    return false;
+  } // Here we return true if there are errors with the date & time components 
+  // individually. This is to allow them to process their errors, and to prevent
+  // validation from stopping at the container level.
+
+
+  if ((0, _validateComponent.default)(date, data[container.fieldId], data[container.fieldId])) {
+    return true;
+  }
+
+  if ((0, _validateComponent.default)(time, data[container.fieldId], data[container.fieldId])) {
+    return true;
+  }
+
+  var dateStr = (0, _utils.formatString)((_data$container$field = data[container.fieldId]) === null || _data$container$field === void 0 ? void 0 : _data$container$field[config.date]);
+  var timeStr = (0, _utils.formattedTime)((_data$container$field2 = data[container.fieldId]) === null || _data$container$field2 === void 0 ? void 0 : _data$container$field2[config.time]);
+  return (0, _dayjs.default)("".concat(dateStr, " ").concat(timeStr), "".concat(_utils.DATE_FORMAT, " HH:mm")).isBefore((0, _dayjs.default)());
+};
+
+var _default = mustBeEarlierDateTime;
+exports.default = _default;

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

@@ -0,0 +1,111 @@
+"use strict";
+
+var _mustBeEarlierDateTime = _interopRequireDefault(require("./mustBeEarlierDateTime"));
+
+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.Validate.additional.mustBeEarlierDateTime', function () {
+  var DATA = {
+    testContainer: {
+      testDate: '01-01-2000',
+      testTime: '00:00'
+    }
+  };
+  var CONFIG = {
+    function: 'mustBeEarlierDateTime',
+    date: 'testDate',
+    time: 'testTime',
+    message: 'Date and time must be in the past'
+  };
+  var CONTAINER = {
+    fieldId: 'testContainer',
+    type: 'container',
+    components: [{
+      fieldId: 'testDate',
+      type: 'date',
+      required: true
+    }, {
+      fieldId: 'testTime',
+      type: 'time',
+      required: true
+    }]
+  };
+  test('should return false if the date component is missing', function () {
+    var EDITED_CONFIG = _objectSpread(_objectSpread({}, CONFIG), {}, {
+      date: 'notARealComponent'
+    });
+
+    var result = (0, _mustBeEarlierDateTime.default)(DATA, EDITED_CONFIG, CONTAINER);
+    expect(result).toEqual(false);
+  });
+  test('should return false if the time component is missing', function () {
+    var EDITED_CONFIG = _objectSpread(_objectSpread({}, CONFIG), {}, {
+      time: 'notARealComponent'
+    });
+
+    var result = (0, _mustBeEarlierDateTime.default)(DATA, EDITED_CONFIG, CONTAINER);
+    expect(result).toEqual(false);
+  });
+  test('should return false if data is null', function () {
+    var result = (0, _mustBeEarlierDateTime.default)(null, CONFIG, CONTAINER);
+    expect(result).toEqual(false);
+  });
+  test('should return true if date value is missing', function () {
+    var EDITED_DATA = {
+      testContainer: {
+        testTime: '00:00'
+      }
+    };
+    var result = (0, _mustBeEarlierDateTime.default)(EDITED_DATA, CONFIG, CONTAINER);
+    expect(result).toEqual(true);
+  });
+  test('should return true if time value is missing', function () {
+    var EDITED_DATA = {
+      testContainer: {
+        testDate: '01-01-2000'
+      }
+    };
+    var result = (0, _mustBeEarlierDateTime.default)(EDITED_DATA, CONFIG, CONTAINER);
+    expect(result).toEqual(true);
+  });
+  test('should return true if date has errors', function () {
+    var EDITED_DATA = {
+      testContainer: {
+        testDate: '011-011-200000',
+        testTime: '00:00'
+      }
+    };
+    var result = (0, _mustBeEarlierDateTime.default)(EDITED_DATA, CONFIG, CONTAINER);
+    expect(result).toEqual(true);
+  });
+  test('should return true if time has errors', function () {
+    var EDITED_DATA = {
+      testContainer: {
+        testDate: '01-01-2000',
+        testTime: '45:78'
+      }
+    };
+    var result = (0, _mustBeEarlierDateTime.default)(EDITED_DATA, CONFIG, CONTAINER);
+    expect(result).toEqual(true);
+  });
+  test('should return true if date & time are in the past', function () {
+    var result = (0, _mustBeEarlierDateTime.default)(DATA, CONFIG, CONTAINER);
+    expect(result).toEqual(true);
+  });
+  test('should return false if date & time are not in the past', function () {
+    var DATA = {
+      testContainer: {
+        testDate: '01-01-5000',
+        testTime: '00:00'
+      }
+    };
+    var result = (0, _mustBeEarlierDateTime.default)(DATA, CONFIG, CONTAINER);
+    expect(result).toEqual(false);
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "4.16.3",
+  "version": "4.17.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.2.4",
+    "@ukhomeoffice/cop-react-components": "2.2.5",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^4.3.1",