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

package/dist/components/SummaryList/SummaryListTitleRow.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _react = _interopRequireDefault(require("react"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Global imports
+var SummaryListTitleRow = function SummaryListTitleRow(_ref) {
+  var title = _ref.title,
+      classes = _ref.classes;
+  return /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(classes('row'), " ").concat(classes('title'))
+  }, /*#__PURE__*/_react.default.createElement(_copReactComponents.SmallHeading, null, title));
+};
+
+SummaryListTitleRow.propTypes = {
+  title: _propTypes.default.string.isRequired,
+  classes: _propTypes.default.func.isRequired
+};
+var _default = SummaryListTitleRow;
+exports.default = _default;

package/dist/context/ValidationContext/ValidationContext.js

@@ -0,0 +1,122 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.ValidationContext = void 0;
+
+var _react = require("react");
+
+var _utils = _interopRequireDefault(require("../../utils"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+var ValidationContext = /*#__PURE__*/(0, _react.createContext)();
+exports.ValidationContext = ValidationContext;
+
+var ValidationContextProvider = function ValidationContextProvider(_ref) {
+  var children = _ref.children;
+
+  var _useState = (0, _react.useState)([]),
+      _useState2 = _slicedToArray(_useState, 2),
+      errors = _useState2[0],
+      setErrors = _useState2[1];
+
+  var addErrors = /*#__PURE__*/function () {
+    var _ref2 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee(errors) {
+      return regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              setErrors(function (prev) {
+                return [].concat(_toConsumableArray(prev), _toConsumableArray(errors)).filter(function (e) {
+                  return !!e;
+                });
+              });
+
+            case 1:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }));
+
+    return function addErrors(_x) {
+      return _ref2.apply(this, arguments);
+    };
+  }();
+
+  var clearErrors = /*#__PURE__*/function () {
+    var _ref3 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
+      return regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              setErrors([]);
+
+            case 1:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      }, _callee2);
+    }));
+
+    return function clearErrors() {
+      return _ref3.apply(this, arguments);
+    };
+  }();
+
+  var validate = {
+    page: function page(_page) {
+      var pageErrors = _utils.default.Validate.page(_page);
+
+      setErrors(pageErrors);
+      return pageErrors;
+    },
+    pages: function pages(_pages) {
+      var pagesErrors = _pages.flatMap(function (page) {
+        return _utils.default.Validate.page(page);
+      });
+
+      setErrors(pagesErrors);
+      return pagesErrors;
+    }
+  };
+  return /*#__PURE__*/React.createElement(ValidationContext.Provider, {
+    value: {
+      errors: errors,
+      addErrors: addErrors,
+      clearErrors: clearErrors,
+      validate: validate
+    }
+  }, children);
+};
+
+var _default = ValidationContextProvider;
+exports.default = _default;

package/dist/context/ValidationContext/ValidationContext.test.js

@@ -0,0 +1,98 @@
+"use strict";
+
+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 _react = require("@testing-library/react");
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+var _react2 = _interopRequireWildcard(require("react"));
+
+var _hooks = require("../../hooks");
+
+var _ValidationContext = _interopRequireDefault(require("./ValidationContext"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+
+var TestComponent = function TestComponent(_ref) {
+  var customErrors = _ref.customErrors;
+
+  var _useValidation = (0, _hooks.useValidation)(),
+      addErrors = _useValidation.addErrors,
+      clearErrors = _useValidation.clearErrors,
+      errors = _useValidation.errors,
+      validate = _useValidation.validate;
+
+  (0, _react2.useEffect)(function () {
+    if (customErrors) {
+      addErrors(customErrors);
+    } // eslint-disable-next-line react-hooks/exhaustive-deps
+
+  }, [customErrors]);
+  return /*#__PURE__*/_react2.default.createElement(_react2.default.Fragment, null, typeof addErrors === 'function' && /*#__PURE__*/_react2.default.createElement("span", null, "addErrors is a function"), typeof clearErrors === 'function' && /*#__PURE__*/_react2.default.createElement("span", null, "clearErrors is a function"), typeof validate.page === 'function' && /*#__PURE__*/_react2.default.createElement("span", null, "validate.page is a function"), Array.isArray(errors) && /*#__PURE__*/_react2.default.createElement("span", null, "errors is an array of length ", errors.length), (errors === null || errors === void 0 ? void 0 : errors.length) > 0 && /*#__PURE__*/_react2.default.createElement(_copReactComponents.ErrorSummary, {
+    errors: errors
+  }));
+};
+
+describe('context.ValidationContext', function () {
+  it('should appropriately set up the context', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
+    var _render, container;
+
+    return regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_ValidationContext.default, null, /*#__PURE__*/_react2.default.createElement(TestComponent, null))), container = _render.container;
+            expect(container.childNodes.length).toEqual(4);
+            expect(container.textContent).toContain('addErrors is a function');
+            expect(container.textContent).toContain('clearErrors is a function');
+            expect(container.textContent).toContain('validate.page is a function');
+            expect(container.textContent).toContain('errors is an array of length 0');
+
+          case 6:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  })));
+  it('should appropriately handle errors', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
+    var CUSTOM_ERRORS, _render2, container, errorSummary;
+
+    return regeneratorRuntime.wrap(function _callee2$(_context2) {
+      while (1) {
+        switch (_context2.prev = _context2.next) {
+          case 0:
+            CUSTOM_ERRORS = [{
+              id: 'alpha',
+              error: 'Alpha is required'
+            }];
+            _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_ValidationContext.default, null, /*#__PURE__*/_react2.default.createElement(TestComponent, {
+              customErrors: CUSTOM_ERRORS
+            }))), container = _render2.container;
+            expect(container.childNodes.length).toEqual(5);
+            expect(container.textContent).toContain('addErrors is a function');
+            expect(container.textContent).toContain('clearErrors is a function');
+            expect(container.textContent).toContain('validate.page is a function');
+            expect(container.textContent).toContain('errors is an array of length 1');
+            errorSummary = container.childNodes[4];
+            expect(errorSummary.tagName).toEqual('DIV');
+            expect(errorSummary.classList).toContain('govuk-error-summary');
+            expect(errorSummary.textContent).toContain(CUSTOM_ERRORS[0].error);
+
+          case 11:
+          case "end":
+            return _context2.stop();
+        }
+      }
+    }, _callee2);
+  })));
+});

package/dist/context/ValidationContext/index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+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); }
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ValidationContext", {
+  enumerable: true,
+  get: function get() {
+    return _ValidationContext.ValidationContext;
+  }
+});
+exports.default = void 0;
+
+var _ValidationContext = _interopRequireWildcard(require("./ValidationContext"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+var _default = _ValidationContext.default;
+exports.default = _default;

package/dist/context/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ValidationContextProvider", {
+  enumerable: true,
+  get: function get() {
+    return _ValidationContext.default;
+  }
+});
+
+var _ValidationContext = _interopRequireDefault(require("./ValidationContext"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/hooks/index.js

@@ -41,9 +41,17 @@ Object.defineProperty(exports, "useRefData", {
     return _useRefData.default;
   }
 });
+Object.defineProperty(exports, "useValidation", {
+  enumerable: true,
+  get: function get() {
+    return _useValidation.default;
+  }
+});
 
 var _useAxios = _interopRequireDefault(require("./useAxios"));
 
+var _useValidation = _interopRequireDefault(require("./useValidation"));
+
 var _useHooks = _interopRequireDefault(require("./useHooks"));
 
 var _useGetRequest = _interopRequireDefault(require("./useGetRequest"));

package/dist/hooks/useValidation.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = require("react");
+
+var _ValidationContext = require("../context/ValidationContext");
+
+// Global imports
+// Local imports
+var useValidation = function useValidation() {
+  return (0, _react.useContext)(_ValidationContext.ValidationContext);
+};
+
+var _default = useValidation;
+exports.default = _default;

package/dist/index.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "FormRenderer", {
   enumerable: true,
   get: function get() {
-    return _FormRenderer.default;
+    return _components.FormRenderer;
   }
 });
 Object.defineProperty(exports, "FormTypes", {
@@ -24,7 +24,7 @@ Object.defineProperty(exports, "HubFormats", {
 Object.defineProperty(exports, "SummaryList", {
   enumerable: true,
   get: function get() {
-    return _SummaryList.default;
+    return _components.SummaryList;
   }
 });
 Object.defineProperty(exports, "Utils", {
@@ -33,11 +33,17 @@ Object.defineProperty(exports, "Utils", {
     return _utils.default;
   }
 });
+Object.defineProperty(exports, "ValidationContextProvider", {
+  enumerable: true,
+  get: function get() {
+    return _context.ValidationContextProvider;
+  }
+});
 exports.intercepts = exports.default = void 0;
 
-var _FormRenderer = _interopRequireDefault(require("./components/FormRenderer"));
+var _components = require("./components");
 
-var _SummaryList = _interopRequireDefault(require("./components/SummaryList"));
+var _context = require("./context");
 
 var _useHooks = require("./hooks/useHooks");
 
@@ -54,5 +60,5 @@ var intercepts = {
   reset: _useHooks.resetHooks
 };
 exports.intercepts = intercepts;
-var _default = _FormRenderer.default;
+var _default = _components.FormRenderer;
 exports.default = _default;

package/dist/json/group.json

@@ -175,23 +175,6 @@
         "field": "addressDetails.town"
       }
     },
-    {
-      "id": "postCode",
-      "fieldId": "postCode",
-      "label": "Postcode",
-      "type": "text",
-      "required": true,
-      "groupId": "addressDetails",
-      "custom_errors": [
-        {
-          "type": "required",
-          "message": "Please enter postcode"
-        }
-      ],
-      "source": {
-        "field": "addressDetails.postCode"
-      }
-    },
     {
       "id": "postCode",
       "fieldId": "postCode",
@@ -378,6 +361,7 @@
         {
           "id": "address",
           "label": "Address details",
+          "required": true,
           "components": ["firstLineOfTheAddress", "town", "city", "postCode"]
         }
       ],