@ukhomeoffice/cop-react-form-renderer 5.48.1-bravo → 5.49.0

package/dist/components/CollectionSummary/RenderListView.js

@@ -0,0 +1,126 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.DEFAULT_TITLE = exports.DEFAULT_EDIT_LABEL = exports.DEFAULT_DUPLICATE_BUTTON_LABEL = exports.DEFAULT_DETAILS_TITLE = exports.DEFAULT_DELETE_BUTTON_LABEL = exports.DEFAULT_CLASS = exports.DEFAULT_CHANGE_BUTTON_LABEL = exports.DEFAULT_CHANGE_BUTTON_CLASS = void 0;
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _react = _interopRequireDefault(require("react"));
+var _SummaryListRow = _interopRequireDefault(require("../SummaryList/SummaryListRow"));
+var _utils = _interopRequireDefault(require("../../utils"));
+require("./RenderListView.scss");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// Global imports.
+
+// Local imports.
+
+// Styles.
+
+var DEFAULT_CLASS = exports.DEFAULT_CLASS = 'hods-form-summary-card';
+var DEFAULT_TITLE = exports.DEFAULT_TITLE = 'Item';
+var DEFAULT_CHANGE_BUTTON_LABEL = exports.DEFAULT_CHANGE_BUTTON_LABEL = 'Change';
+var DEFAULT_DELETE_BUTTON_LABEL = exports.DEFAULT_DELETE_BUTTON_LABEL = 'Delete';
+var DEFAULT_EDIT_LABEL = exports.DEFAULT_EDIT_LABEL = 'Quick Edit';
+var DEFAULT_DUPLICATE_BUTTON_LABEL = exports.DEFAULT_DUPLICATE_BUTTON_LABEL = 'Duplicate';
+var DEFAULT_DETAILS_TITLE = exports.DEFAULT_DETAILS_TITLE = 'Full details';
+var DEFAULT_CHANGE_BUTTON_CLASS = exports.DEFAULT_CHANGE_BUTTON_CLASS = 'secondary';
+var RenderListView = function RenderListView(_ref) {
+  var _config$changeAction2, _config$changeAction3, _config$deleteAction, _masterPage$childPage;
+  var id = _ref.id,
+    entryData = _ref.entryData,
+    config = _ref.config,
+    onChange = _ref.onChange,
+    onDelete = _ref.onDelete,
+    masterPage = _ref.masterPage;
+  return /*#__PURE__*/_react.default.createElement("div", {
+    className: "govuk-summary-card",
+    id: id
+  }, /*#__PURE__*/_react.default.createElement("div", {
+    className: "govuk-summary-card__title-wrapper dark"
+  }, /*#__PURE__*/_react.default.createElement("h2", {
+    className: "govuk-summary-card__title"
+  }, _copReactComponents.Utils.interpolateString(config.title || DEFAULT_TITLE, entryData)), /*#__PURE__*/_react.default.createElement("ul", {
+    className: "govuk-summary-card__actions"
+  }, /*#__PURE__*/_react.default.createElement("li", {
+    className: "govuk-summary-card__action"
+  }, config.changeAction && typeof onChange === 'function' && /*#__PURE__*/_react.default.createElement(_copReactComponents.Button, {
+    id: "".concat(id, ".changeButton"),
+    onClick: function onClick() {
+      var _config$changeAction;
+      return onChange((_config$changeAction = config.changeAction) === null || _config$changeAction === void 0 ? void 0 : _config$changeAction.page, entryData.id);
+    },
+    classModifiers: ((_config$changeAction2 = config.changeAction) === null || _config$changeAction2 === void 0 ? void 0 : _config$changeAction2.classModifiers) || DEFAULT_CHANGE_BUTTON_CLASS
+  }, ((_config$changeAction3 = config.changeAction) === null || _config$changeAction3 === void 0 ? void 0 : _config$changeAction3.label) || DEFAULT_CHANGE_BUTTON_LABEL)), /*#__PURE__*/_react.default.createElement("li", {
+    className: "govuk-summary-card__action"
+  }, config.deleteAction && typeof onDelete === 'function' && /*#__PURE__*/_react.default.createElement(_copReactComponents.Button, {
+    id: "".concat(id, ".deleteButton"),
+    onClick: function onClick() {
+      return onDelete(entryData);
+    },
+    classModifiers: "secondary"
+  }, ((_config$deleteAction = config.deleteAction) === null || _config$deleteAction === void 0 ? void 0 : _config$deleteAction.label) || DEFAULT_DELETE_BUTTON_LABEL)))), /*#__PURE__*/_react.default.createElement("div", {
+    className: "govuk-summary-card__content"
+  }, /*#__PURE__*/_react.default.createElement("dl", {
+    className: "govuk-summary-list"
+  }, masterPage === null || masterPage === void 0 || (_masterPage$childPage = masterPage.childPages) === null || _masterPage$childPage === void 0 ? void 0 : _masterPage$childPage.flatMap(function (childPage) {
+    var _childPage$summaryLay;
+    return (_childPage$summaryLay = childPage.summaryLayout) === null || _childPage$summaryLay === void 0 ? void 0 : _childPage$summaryLay.sections.flatMap(function (section) {
+      var _section$fields;
+      return (_section$fields = section.fields) === null || _section$fields === void 0 ? void 0 : _section$fields.map(function (fieldId) {
+        var component = _utils.default.Component.elevateNested(childPage === null || childPage === void 0 ? void 0 : childPage.components, entryData).find(function (comp) {
+          return comp.fieldId === fieldId;
+        });
+        return component ? /*#__PURE__*/_react.default.createElement(_SummaryListRow.default, {
+          key: fieldId,
+          row: {
+            key: component.label,
+            value: _copReactComponents.Utils.interpolateString(entryData[component === null || component === void 0 ? void 0 : component.fieldId], entryData),
+            required: component.required
+          },
+          classes: function classes(element) {
+            return "govuk-summary-list__".concat(element);
+          }
+        }) : null;
+      });
+    });
+  }))));
+};
+RenderListView.propTypes = {
+  id: _propTypes.default.string.isRequired,
+  entryData: _propTypes.default.shape({
+    id: _propTypes.default.string.isRequired,
+    index: _propTypes.default.number.isRequired
+  }).isRequired,
+  config: _propTypes.default.shape({
+    banners: _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.shape({})])),
+    title: _propTypes.default.string,
+    details: _propTypes.default.string,
+    changeAction: _propTypes.default.shape({
+      label: _propTypes.default.string,
+      page: _propTypes.default.string.isRequired,
+      classModifiers: _propTypes.default.string
+    }),
+    deleteAction: _propTypes.default.shape({
+      label: _propTypes.default.string
+    }),
+    duplicateAction: _propTypes.default.shape({
+      label: _propTypes.default.string
+    }),
+    quickEdit: _propTypes.default.shape({
+      components: _propTypes.default.arrayOf(_propTypes.default.shape({
+        use: _propTypes.default.string
+      }))
+    }),
+    detailsTitle: _propTypes.default.string,
+    listView: _propTypes.default.bool
+  }).isRequired,
+  onChange: _propTypes.default.func.isRequired,
+  onDelete: _propTypes.default.func.isRequired,
+  masterPage: _propTypes.default.shape({
+    childPages: _propTypes.default.arrayOf(_propTypes.default.shape({
+      components: _propTypes.default.arrayOf(_propTypes.default.shape())
+    })).isRequired
+  }).isRequired
+};
+var _default = exports.default = RenderListView;

package/dist/components/CollectionSummary/RenderListView.scss

@@ -0,0 +1,8 @@
+$govuk-font-family: 'Roboto', arial, sans-serif;
+
+@import "node_modules/govuk-frontend/govuk/_base";
+@import "node_modules/govuk-frontend/govuk/components/summary-list/_index";
+
+.govuk-summary-card__title-wrapper.dark {
+  background-color: #D1D1D1;
+}

package/dist/components/CollectionSummary/RenderListView.test.js

@@ -0,0 +1,190 @@
+"use strict";
+
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _setupTests = require("../../setupTests");
+var _RenderListView = _interopRequireDefault(require("./RenderListView"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// Global imports.
+
+// Local imports.
+
+describe('components.CollectionSummary.RenderListView', function () {
+  var ENTRY = {
+    id: '001',
+    item1: 'Value 1',
+    item2: 'Value 2',
+    index: 0
+  };
+  var MASTER_PAGE = {
+    childPages: [{
+      summaryLayout: {
+        sections: [{
+          fields: ['item1', 'item2']
+        }]
+      },
+      components: [{
+        fieldId: 'item1',
+        label: 'Item 1',
+        required: true
+      }, {
+        fieldId: 'item2',
+        label: 'Item 2'
+      }]
+    }]
+  };
+  var CONFIG = {
+    title: 'Title text',
+    listView: true
+    // ...other config properties
+  };
+
+  var ID = 'testListView';
+  var onChangeArgs = [];
+  var ON_CHANGE = function ON_CHANGE(page, id) {
+    onChangeArgs.push({
+      page: page,
+      id: id
+    });
+  };
+  beforeEach(function () {
+    onChangeArgs = [];
+  });
+  var onDeleteArgs = [];
+  var ON_DELETE = function ON_DELETE(entry) {
+    onDeleteArgs.push(entry);
+  };
+  beforeEach(function () {
+    onDeleteArgs = [];
+  });
+
+  // Setup function to check rendered elements
+  var checkSetup = function checkSetup(container) {
+    var listViewDiv = container.children[0];
+    expect(listViewDiv.tagName).toEqual('DIV');
+    expect(listViewDiv.classList).toContain('govuk-summary-card');
+    return listViewDiv;
+  };
+  it('should correctly render RenderListView component', function () {
+    var _renderWithValidation = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_RenderListView.default, {
+        id: ID,
+        entryData: ENTRY,
+        config: CONFIG,
+        onChange: ON_CHANGE,
+        onDelete: ON_DELETE,
+        masterPage: MASTER_PAGE
+      })),
+      container = _renderWithValidation.container;
+    var listViewDiv = checkSetup(container);
+
+    // Check title wrapper and title text
+    var titleWrapper = listViewDiv.querySelector('.govuk-summary-card__title-wrapper');
+    expect(titleWrapper).not.toBeNull();
+    var title = titleWrapper.querySelector('.govuk-summary-card__title');
+    expect(title.textContent).toEqual(CONFIG.title);
+
+    // Logic to check the rendered rows
+    var rows = container.querySelectorAll('.govuk-summary-list__row');
+    expect(rows.length).toEqual(2); // Expecting two rows as per MOCK_MASTER_PAGE
+
+    // Check the first row
+    var firstRowKey = rows[0].querySelector('.govuk-summary-list__key');
+    var firstRowValue = rows[0].querySelector('.govuk-summary-list__value');
+    expect(firstRowKey.textContent).toEqual('Item 1');
+    expect(firstRowValue.textContent).toEqual(ENTRY.item1);
+
+    // Check the second row
+    var secondRowKey = rows[1].querySelector('.govuk-summary-list__key');
+    var secondRowValue = rows[1].querySelector('.govuk-summary-list__value');
+    expect(secondRowKey.textContent).toEqual('Item 2 (optional)');
+    expect(secondRowValue.textContent).toEqual(ENTRY.item2);
+  });
+});
+describe('Action buttons in RenderListView', function () {
+  var ID = 'testListView';
+  var onChangeArgs = [];
+  var onChangeCalls = 0;
+  var ON_CHANGE = function ON_CHANGE(page, id) {
+    onChangeArgs.push({
+      page: page,
+      id: id
+    });
+    onChangeCalls += 1;
+  };
+  var onDeleteArgs = [];
+  var onDeleteCalls = 0;
+  var ON_DELETE = function ON_DELETE(entry) {
+    onDeleteArgs.push(entry);
+    onDeleteCalls += 1;
+  };
+  beforeEach(function () {
+    onChangeArgs = [];
+    onChangeCalls = 0;
+    onDeleteArgs = [];
+    onDeleteCalls = 0;
+  });
+  var ENTRY = {
+    id: '001',
+    item1: 'Value 1',
+    item2: 'Value 2',
+    index: 0
+  };
+  var MASTER_PAGE = {
+    childPages: [{
+      summaryLayout: {
+        sections: [{
+          fields: ['item1', 'item2']
+        }]
+      },
+      components: [{
+        fieldId: 'item1',
+        label: 'Item 1',
+        required: true
+      }, {
+        fieldId: 'item2',
+        label: 'Item 2'
+      }]
+    }]
+  };
+  var CONFIG = {
+    title: 'Title text',
+    listView: true,
+    changeAction: {
+      label: 'Change label',
+      page: 'testPage'
+    },
+    deleteAction: {
+      label: 'Delete label'
+    }
+  };
+  it('should render and handle action buttons correctly', function () {
+    var _renderWithValidation2 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_RenderListView.default, {
+        id: ID,
+        entryData: ENTRY,
+        config: CONFIG,
+        onChange: ON_CHANGE,
+        onDelete: ON_DELETE,
+        masterPage: MASTER_PAGE
+      })),
+      container = _renderWithValidation2.container;
+    var listViewDiv = container.querySelector('.govuk-summary-card');
+    expect(listViewDiv).not.toBeNull();
+
+    // Check for change button
+    var changeButton = listViewDiv.querySelector('[id$=".changeButton"]');
+    expect(changeButton.textContent).toEqual(CONFIG.changeAction.label);
+    _react2.fireEvent.click(changeButton, {});
+    expect(onChangeCalls).toEqual(1);
+    expect(onChangeArgs[0]).toMatchObject({
+      page: CONFIG.changeAction.page,
+      id: ENTRY.id
+    });
+
+    // Check for delete button
+    var deleteButton = listViewDiv.querySelector('[id$=".deleteButton"]');
+    expect(deleteButton.textContent).toEqual(CONFIG.deleteAction.label);
+    _react2.fireEvent.click(deleteButton, {});
+    expect(onDeleteCalls).toEqual(1);
+    expect(onDeleteArgs[0]).toEqual(ENTRY);
+  });
+});

package/dist/components/CollectionSummary/SummaryCard.js

@@ -14,6 +14,7 @@ var _hooks = require("../../hooks");
 var _FormPage = _interopRequireDefault(require("../FormPage"));
 var _FormComponent = _interopRequireDefault(require("../FormComponent"));
 var _BannerStrip = _interopRequireDefault(require("./BannerStrip"));
+var _RenderListView = _interopRequireDefault(require("./RenderListView"));
 require("./SummaryCard.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; }
@@ -133,6 +134,18 @@ var SummaryCard = function SummaryCard(_ref) {
       return _ref2.apply(this, arguments);
     };
   }();
+
+  // To render summary card in list view as per https://design-system.service.gov.uk/components/summary-list
+  if (config.listView) {
+    return /*#__PURE__*/_react.default.createElement(_RenderListView.default, {
+      id: id,
+      entryData: entryData,
+      config: config,
+      onChange: onChange,
+      onDelete: onDelete,
+      masterPage: masterPage
+    });
+  }
   return /*#__PURE__*/_react.default.createElement("div", {
     className: classes(),
     id: id
@@ -249,7 +262,8 @@ SummaryCard.propTypes = {
         use: _propTypes.default.string
       }))
     }),
-    detailsTitle: _propTypes.default.string
+    detailsTitle: _propTypes.default.string,
+    listView: _propTypes.default.bool
   }).isRequired,
   masterPage: _propTypes.default.shape({
     childPages: _propTypes.default.arrayOf(_propTypes.default.shape({

package/dist/utils/Component/getComponent.js

@@ -253,7 +253,6 @@ var getChildJsx = function getChildJsx(parent, paramChild) {
     component: child,
     value: child.value,
     onChange: parent.onChange,
-    onTopLevelChange: parent.onChange,
     key: child.key,
     formData: parent.formData
   });

package/dist/utils/Component/getDefaultValueFromConfig.js

@@ -79,7 +79,7 @@ var setupDefaultObjectValue = function setupDefaultObjectValue(defaultObject, da
   // be used as field names to get values from data.
   if (defaultObj.sourced) {
     var _result;
-    result = (_result = result) !== null && _result !== void 0 ? _result : {};
+    (_result = result) !== null && _result !== void 0 ? _result : result = {};
     Object.keys(defaultObj.sourced).every(function (key) {
       var sourcedValue = typeof defaultObj.sourced[key] === 'string' && (0, _getSourceData.default)(data, defaultObj.sourced[key]);
       if (sourcedValue === undefined && defaultObj.skipIfSourceInvalid) {

package/package.json

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