@ukhomeoffice/cop-react-form-renderer 6.0.6-peter → 6.7.0-alpha

package/dist/components/CollectionSummary/CollectionSummary.js

@@ -1,6 +1,5 @@
 "use strict";
 
-function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -9,32 +8,26 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _react = _interopRequireWildcard(require("react"));
 var _hooks = require("../../hooks");
 var _PageAction = require("../../models/PageAction");
+var _elevateNestedComponents = _interopRequireDefault(require("../../utils/Component/elevateNestedComponents"));
+var _getErrorsForCollection = _interopRequireDefault(require("../../utils/CollectionPage/getErrorsForCollection"));
 var _utils = _interopRequireDefault(require("../../utils"));
 var _getCYARow = _interopRequireDefault(require("../../utils/CheckYourAnswers/getCYARow"));
-var _elevateNestedComponents = _interopRequireDefault(require("../../utils/Component/elevateNestedComponents"));
 var _Answer = _interopRequireDefault(require("../CheckYourAnswers/Answer"));
 var _ActionButton = _interopRequireDefault(require("../PageActions/ActionButton"));
 var _Confirmation = _interopRequireDefault(require("./Confirmation"));
 var _SummaryCard = _interopRequireDefault(require("./SummaryCard"));
 var _SummaryCardValidationContext = _interopRequireDefault(require("./SummaryCardValidationContext"));
 require("./CollectionSummary.scss");
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-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(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; } // Global imports.
+// Global imports.
+
 // Local imports.
+
 // Styles.
-var DEFAULT_ADD_BUTTON_LABEL = exports.DEFAULT_ADD_BUTTON_LABEL = 'Add';
+
+const DEFAULT_ADD_BUTTON_LABEL = exports.DEFAULT_ADD_BUTTON_LABEL = 'Add';
 
 // A note about validation.
 //
@@ -48,161 +41,158 @@ var DEFAULT_ADD_BUTTON_LABEL = exports.DEFAULT_ADD_BUTTON_LABEL = 'Add';
 // errors found by the summary and allow the Summary Card to keep any Quick Edit
 // errors local to the Quick Edit page.
 
-var CollectionSummary = function CollectionSummary(_ref) {
+const CollectionSummary = _ref => {
   var _config$confirmation, _config$confirmation2, _config$confirmation3;
-  var config = _ref.config,
-    formData = _ref.formData,
-    onAction = _ref.onAction,
-    onChange = _ref.onChange,
-    pages = _ref.pages;
-  var _useValidation = (0, _hooks.useValidation)(),
-    errors = _useValidation.errors,
-    addErrors = _useValidation.addErrors,
-    clearErrors = _useValidation.clearErrors;
-  var _useState = (0, _react.useState)(null),
-    _useState2 = _slicedToArray(_useState, 2),
-    entryToDelete = _useState2[0],
-    setEntryToDelete = _useState2[1];
-  var data = (0, _react.useMemo)(function () {
-    return _utils.default.CollectionPage.getData(config.collectionName, formData) || [];
-  }, [formData]);
-  var masterPage = (0, _react.useMemo)(function () {
-    var collectionNameParts = config.collectionName.split('.');
-    var childPages = _utils.default.CollectionPage.mergePages(pages || []) || [];
-    return collectionNameParts.reduce(function (acc, current, index) {
+  let {
+    config,
+    formData,
+    onAction,
+    onChange,
+    onTopLevelChange,
+    pages
+  } = _ref;
+  const {
+    hooks
+  } = (0, _hooks.useHooks)();
+  const {
+    errors,
+    addErrors,
+    clearErrors,
+    queuedErrors,
+    enqueueErrors,
+    dequeueErrors
+  } = (0, _hooks.useValidation)();
+  const [entryToDelete, setEntryToDelete] = (0, _react.useState)(null);
+  const data = (0, _react.useMemo)(() => _utils.default.CollectionPage.getData(config.collectionName, formData) || [], [formData]);
+  const masterPage = (0, _react.useMemo)(() => {
+    const collectionNameParts = config.collectionName.split('.');
+    let childPages = _utils.default.CollectionPage.mergePages(pages || []) || [];
+    return collectionNameParts.reduce((acc, current, index) => {
       var _childPages$find;
-      var currentPath = index === 0 ? "".concat(acc).concat(current) : "".concat(acc, ".").concat(current);
+      const currentPath = index === 0 ? "".concat(acc).concat(current) : "".concat(acc, ".").concat(current);
       if (index === collectionNameParts.length - 1) {
         var _childPages;
-        return ((_childPages = childPages) === null || _childPages === void 0 ? void 0 : _childPages.find(function (p) {
+        return ((_childPages = childPages) === null || _childPages === void 0 ? void 0 : _childPages.find(p => {
           var _p$collection;
           return ((_p$collection = p.collection) === null || _p$collection === void 0 ? void 0 : _p$collection.name) === currentPath;
         })) || null;
       }
-      childPages = ((_childPages$find = childPages.find(function (p) {
+      childPages = ((_childPages$find = childPages.find(p => {
         var _p$collection2;
         return ((_p$collection2 = p.collection) === null || _p$collection2 === void 0 ? void 0 : _p$collection2.name) === currentPath;
       })) === null || _childPages$find === void 0 ? void 0 : _childPages$find.childPages) || null;
       return currentPath;
     }, "");
   }, [pages]);
-  var allComponents = (0, _react.useMemo)(function () {
+  const allComponents = (0, _react.useMemo)(() => {
     if (config.card.listView) {
       var _masterPage$childPage;
-      var components = (_masterPage$childPage = masterPage.childPages) === null || _masterPage$childPage === void 0 ? void 0 : _masterPage$childPage.reduce(function (acc, page) {
-        var elevatedComponents = (0, _elevateNestedComponents.default)(page.components, _objectSpread(_objectSpread({}, formData), entryToDelete));
+      const components = (_masterPage$childPage = masterPage.childPages) === null || _masterPage$childPage === void 0 ? void 0 : _masterPage$childPage.reduce((acc, page) => {
+        const elevatedComponents = (0, _elevateNestedComponents.default)(page.components, {
+          ...formData,
+          ...entryToDelete
+        });
         return acc.concat(elevatedComponents);
       }, []);
       return components || [];
     }
     return [];
   }, [masterPage, formData, entryToDelete, config.card.listView]);
-  var validateEntries = function validateEntries() {
-    var stored = [];
-    // We only clear errors if it's not empty to avoid
+  const validateEntries = () => {
+    // We only clear queuedErrors if it's not empty to avoid
     // triggering a race condition with the 'data' memo 
     // above.
-    if (errors.length > 0) {
-      stored = errors.filter(function (e) {
-        return e.id === config.id;
-      });
-      clearErrors();
+    if (queuedErrors.length > 0) {
+      dequeueErrors(e => e.raisedBy === config.id);
     }
-    var allErrors = [];
-    data.forEach(function (entry) {
-      // Validation of a collection page uses the data from the
-      // active entry, so here we have to set the active ID before
-      // validating.
-      var childPages = masterPage === null || masterPage === void 0 ? void 0 : masterPage.childPages.map(function (page) {
-        return _objectSpread(_objectSpread({}, page), {}, {
-          formData: _objectSpread(_objectSpread({}, masterPage.formData), {}, _defineProperty({}, "".concat(config.collectionName, "ActiveId"), entry.id))
-        });
-      });
-      var allPagesErrors = (childPages === null || childPages === void 0 ? void 0 : childPages.flatMap(function (page) {
-        return _utils.default.Validate.page(page);
-      })) || [];
-      // For each error we found, add the entryId so we know what Summary Card
-      // we have to pass it to.
-      var entryErrors = allPagesErrors.map(function (e) {
-        return _objectSpread(_objectSpread({}, e), {}, {
-          entryId: entry.id
-        });
-      });
-      allErrors = allErrors.concat(entryErrors);
-    });
-    if (stored.length > 0) {
-      allErrors = allErrors.concat(stored);
-    }
-    // We only add allErrors if it's not empty to avoid
+    const allErrors = (0, _getErrorsForCollection.default)(config, masterPage, formData, hooks);
+
+    // We only queue allErrors if it's not empty to avoid
     // triggering a race condition with the 'data' memo 
     // above.
     if (allErrors.length > 0) {
-      addErrors(allErrors);
+      enqueueErrors(allErrors);
     }
   };
-  (0, _react.useEffect)(function () {
+  (0, _react.useEffect)(() => {
     // An empty array here indicates nothing to validate, higher level validation
     // such as 'required' is taken care of at the page level not here
     if (Array.isArray(data) && data.length > 0) {
       validateEntries();
     }
   }, [data]);
-  var onSummaryCardChange = function onSummaryCardChange(page, entryId) {
-    if (typeof onAction !== 'function') {
-      return;
+  const onSummaryCardFullEdit = (page, entryId) => {
+    if (typeof onAction === 'function') {
+      const newData = [].concat(data);
+      const entryIndex = data.findIndex(e => e.id === entryId);
+      const {
+        isDuplicate,
+        ...newEntry
+      } = data[entryIndex];
+      newData[entryIndex] = {
+        ...newEntry
+      };
+      onAction({
+        type: _PageAction.PageActionTypes.SAVE_AND_NAVIGATE,
+        page,
+        addToFormData: [{
+          field: "".concat(config.collectionName.split('.').pop(), "ActiveId"),
+          value: entryId
+        }, {
+          field: config.collectionName,
+          value: newData,
+          isCollection: true
+        }]
+      });
     }
-    onAction({
-      type: _PageAction.PageActionTypes.SAVE_AND_NAVIGATE,
-      page: page,
-      addToFormData: {
-        field: "".concat(config.collectionName.split('.').pop(), "ActiveId"),
-        value: entryId
-      }
-    });
   };
-  var onDuplicate = function onDuplicate(entry) {
+  const onDuplicate = entry => {
     var _config$card;
-    _utils.default.CollectionPage.duplicateEntry(config.collectionName, formData, entry.id, ((_config$card = config.card) === null || _config$card === void 0 || (_config$card = _config$card.duplicateAction) === null || _config$card === void 0 ? void 0 : _config$card.fieldsToIgnore) || []);
-    var parentCollection = config.collectionName.split('.').shift();
+    _utils.default.CollectionPage.duplicateEntry(config.collectionName, formData, entry.id, ((_config$card = config.card) === null || _config$card === void 0 || (_config$card = _config$card.duplicateAction) === null || _config$card === void 0 ? void 0 : _config$card.fieldsToIgnore) || [], {
+      isDuplicate: true
+    });
+    const topLevelCollectionName = config.collectionName.split('.').shift();
     // Report the whole top-level collection as being changed. We have to do this
     // because of how patch is applied to formData on a page submission.
-    if (typeof onChange === 'function') {
-      onChange({
+    if (typeof onTopLevelChange === 'function') {
+      onTopLevelChange({
         target: {
-          name: parentCollection,
-          value: _utils.default.CollectionPage.getData(parentCollection, formData)
+          name: topLevelCollectionName,
+          value: _utils.default.CollectionPage.getData(topLevelCollectionName, formData)
         }
       });
       validateEntries();
     }
   };
-  var onDeleteConfirm = function onDeleteConfirm() {
+  const onDeleteConfirm = () => {
     if (!entryToDelete) {
       return;
     }
     _utils.default.CollectionPage.removeEntry(config.collectionName, formData, entryToDelete.id);
-    var parentCollection = config.collectionName.split('.').shift();
+    const topLevelCollectionName = config.collectionName.split('.').shift();
     // Report the whole top-level collection as being changed. We have to do this
     // because of how patch is applied to formData on a page submission.
-    if (typeof onChange === 'function') {
-      onChange({
+    if (typeof onTopLevelChange === 'function') {
+      onTopLevelChange({
         target: {
-          name: parentCollection,
-          value: _utils.default.CollectionPage.getData(parentCollection, formData)
+          name: topLevelCollectionName,
+          value: _utils.default.CollectionPage.getData(topLevelCollectionName, formData)
         }
       });
     }
     setEntryToDelete(null);
     validateEntries();
   };
-  var renderFieldValue = function renderFieldValue(field) {
-    var component = allComponents.find(function (c) {
-      return c.fieldId === field;
-    });
+  const renderFieldValue = field => {
+    const component = allComponents.find(c => c.fieldId === field);
     if (!component) return null;
-    var row = (0, _getCYARow.default)(_objectSpread(_objectSpread({}, masterPage), {}, {
-      formData: _objectSpread(_objectSpread({}, formData), entryToDelete)
-    }), component);
+    const row = (0, _getCYARow.default)({
+      ...masterPage,
+      formData: {
+        ...formData,
+        ...entryToDelete
+      }
+    }, component);
     return /*#__PURE__*/_react.default.createElement("div", {
       key: field,
       className: "confirmation-field-value"
@@ -216,20 +206,22 @@ var CollectionSummary = function CollectionSummary(_ref) {
     id: config.fieldId
   }, entryToDelete && /*#__PURE__*/_react.default.createElement(_Confirmation.default, {
     id: "".concat(config.fieldId, ".confirmation"),
-    message: _utils.default.interpolateString((_config$confirmation = config.confirmation) === null || _config$confirmation === void 0 ? void 0 : _config$confirmation.message, entryToDelete) || null,
+    message: _utils.default.interpolateString((_config$confirmation = config.confirmation) === null || _config$confirmation === void 0 ? void 0 : _config$confirmation.message, {
+      ...entryToDelete,
+      index: entryToDelete.index + 1
+    }) || null,
     confirmLabel: _utils.default.interpolateString((_config$confirmation2 = config.confirmation) === null || _config$confirmation2 === void 0 ? void 0 : _config$confirmation2.label, entryToDelete) || null,
     onConfirm: onDeleteConfirm,
-    onCancel: function onCancel() {
-      return setEntryToDelete(null);
-    }
+    onCancel: () => setEntryToDelete(null)
   }, config.card.listView ? /*#__PURE__*/_react.default.createElement("div", {
     className: "confirmation-content"
   }, (_config$confirmation3 = config.confirmation) === null || _config$confirmation3 === void 0 ? void 0 : _config$confirmation3.displayFields.map(renderFieldValue)) : /*#__PURE__*/_react.default.createElement(_SummaryCard.default, {
     id: "".concat(config.fieldId, ".confirmationChild"),
     entryData: entryToDelete,
-    config: config.card ? _objectSpread(_objectSpread({}, config.card), {}, {
+    config: config.card ? {
+      ...config.card,
       quickEdit: null
-    }) : {},
+    } : {},
     masterPage: masterPage,
     classModifiers: "nested",
     hideDetails: true
@@ -243,39 +235,46 @@ var CollectionSummary = function CollectionSummary(_ref) {
       classModifiers: ['secondary']
     },
     onAction: onAction
-  }), data.map(function (entry, index) {
-    var isInError = errors.filter(function (e) {
-      return e.entryId === entry.id;
-    }).length > 0;
-    var finalConfig = _objectSpread(_objectSpread({}, config.card), isInError && config.errorCard ? config.errorCard : {});
-    var key = "".concat(config.fieldId, ".summaryCard").concat(entry.id);
+  }), data.map((entry, index) => {
+    const isInError = errors.filter(e => e.entryId === entry.id).length > 0;
+    const finalConfig = {
+      ...config.card,
+      ...(entry.isDuplicate && config.duplicatedCard ? config.duplicatedCard : {}),
+      ...(isInError && config.errorCard ? config.errorCard : {})
+    };
+    const key = "".concat(config.fieldId, ".summaryCard").concat(entry.id);
     return /*#__PURE__*/_react.default.createElement(_SummaryCardValidationContext.default, {
       entryId: entry.id,
-      topLevelErrors: errors
+      topLevelErrors: errors,
+      clearTopLevelErrorsForCard: () => {
+        const newErrors = errors.filter(e => e.entryId !== entry.id);
+        clearErrors();
+        addErrors(newErrors);
+      }
     }, /*#__PURE__*/_react.default.createElement(_SummaryCard.default, {
       id: key,
       key: key,
-      entryData: _objectSpread(_objectSpread({}, entry), {}, {
-        index: index
-      }),
+      entryData: {
+        ...entry,
+        index
+      },
       masterPage: masterPage,
       config: finalConfig || {},
-      onChange: onSummaryCardChange,
+      onFullEdit: onSummaryCardFullEdit,
       onDuplicate: onDuplicate,
-      onDelete: function onDelete() {
-        return setEntryToDelete(entry);
-      },
-      onQuickEdit: function onQuickEdit(target) {
+      onDelete: () => setEntryToDelete({
+        ...entry,
+        index
+      }),
+      onQuickEdit: target => {
         validateEntries();
         return onChange(target);
       },
       parentCollectionName: config.collectionName.split('.').shift(),
       childCollections: config.childCollections || [],
       formData: formData,
-      classModifiers: entry === entryToDelete ? ['deleting-summary-card'] : [''],
-      inError: errors.filter(function (e) {
-        return e.entryId === entry.id;
-      }).length > 0
+      classModifiers: entry.id === (entryToDelete === null || entryToDelete === void 0 ? void 0 : entryToDelete.id) ? ['deleting-summary-card'] : [''],
+      inError: errors.filter(e => e.entryId === entry.id).length > 0
     }));
   }), config.card.listView && config.addButton && /*#__PURE__*/_react.default.createElement(_ActionButton.default, {
     id: "".concat(config.fieldId, ".addButton"),
@@ -315,6 +314,14 @@ CollectionSummary.propTypes = {
         fieldsToIgnore: _propTypes.default.arrayOf(_propTypes.default.string)
       })
     }),
+    duplicatedCard: _propTypes.default.shape({
+      banners: _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.shape({})])),
+      title: _propTypes.default.string,
+      details: _propTypes.default.string,
+      duplicateAction: _propTypes.default.shape({
+        fieldsToIgnore: _propTypes.default.arrayOf(_propTypes.default.string)
+      })
+    }),
     confirmation: _propTypes.default.shape({
       message: _propTypes.default.string,
       label: _propTypes.default.string,
@@ -324,12 +331,14 @@ CollectionSummary.propTypes = {
   }).isRequired,
   onAction: _propTypes.default.func,
   onChange: _propTypes.default.func,
+  onTopLevelChange: _propTypes.default.func,
   formData: _propTypes.default.shape({}).isRequired,
   pages: _propTypes.default.arrayOf(_propTypes.default.shape({}))
 };
 CollectionSummary.defaultProps = {
   onAction: null,
   onChange: null,
+  onTopLevelChange: null,
   pages: []
 };
 var _default = exports.default = CollectionSummary;

package/dist/components/CollectionSummary/CollectionSummary.scss

@@ -1,4 +1,4 @@
-@import "node_modules/govuk-frontend/govuk/_base";
+@import "govuk-frontend/dist/govuk/_base";
 
 .hods-form-summary-card.hods-form-summary-card--nested {
   box-shadow: none;