@ukhomeoffice/cop-react-form-renderer 0.1.0-beta → 1.0.0-gamma

package/dist/components/CheckYourAnswers/Answer.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _FormComponent = _interopRequireDefault(require("../FormComponent"));
+
+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); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { 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 Answer = function Answer(_ref) {
+  var value = _ref.value,
+      component = _ref.component;
+
+  if (!value) {
+    return null;
+  }
+
+  if (!component) {
+    return value;
+  }
+
+  return /*#__PURE__*/_react.default.createElement(_FormComponent.default, {
+    component: _objectSpread(_objectSpread({}, component), {}, {
+      readonly: true
+    }),
+    wrap: false,
+    value: value
+  });
+};
+
+Answer.propTypes = {
+  value: _propTypes.default.any,
+  component: _propTypes.default.object
+};
+var _default = Answer;
+exports.default = _default;

package/dist/components/CheckYourAnswers/Answer.test.js

@@ -0,0 +1,94 @@
+"use strict";
+
+var _react = require("@testing-library/react");
+
+var _Readonly = require("@ukhomeoffice/cop-react-components/dist/Readonly");
+
+var _react2 = _interopRequireDefault(require("react"));
+
+var _Answer = _interopRequireDefault(require("./Answer"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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); }); }; }
+
+describe('components', function () {
+  describe('CheckYourAnswers.Answer', function () {
+    it('should handle a null value', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
+      var VALUE, COMPONENT, _render, container;
+
+      return regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              VALUE = null;
+              COMPONENT = null;
+              _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Answer.default, {
+                value: VALUE,
+                component: COMPONENT
+              })), container = _render.container;
+              expect(container.childNodes.length).toEqual(0);
+
+            case 4:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    })));
+    it('should handle a null component', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
+      var VALUE, COMPONENT, _render2, container;
+
+      return regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              VALUE = 'Alpha';
+              COMPONENT = null;
+              _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Answer.default, {
+                value: VALUE,
+                component: COMPONENT
+              })), container = _render2.container;
+              expect(container.textContent).toEqual(VALUE);
+
+            case 4:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      }, _callee2);
+    })));
+    it('should handle a component', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3() {
+      var VALUE, COMPONENT, _render3, container, answer;
+
+      return regeneratorRuntime.wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              VALUE = 'Bravo';
+              COMPONENT = {
+                id: 'alpha',
+                fieldId: 'alpha',
+                type: 'text',
+                label: 'Alpha'
+              };
+              _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Answer.default, {
+                value: VALUE,
+                component: COMPONENT
+              })), container = _render3.container;
+              answer = container.childNodes[0];
+              expect(answer.tagName).toEqual('DIV');
+              expect(answer.classList).toContain(_Readonly.DEFAULT_CLASS);
+              expect(answer.textContent).toEqual(VALUE);
+
+            case 7:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3);
+    })));
+  });
+});

package/dist/components/CheckYourAnswers/CheckYourAnswers.js

@@ -5,73 +5,144 @@ function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "functi
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.DEFAULT_MARGIN_BOTTOM = void 0;
+exports.default = exports.DEFAULT_TITLE = exports.DEFAULT_MARGIN_BOTTOM = exports.DEFAULT_CLASS = void 0;
 
-var _react = _interopRequireWildcard(require("react"));
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 
 var _propTypes = _interopRequireDefault(require("prop-types"));
 
-var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+var _react = _interopRequireWildcard(require("react"));
+
+var _utils = _interopRequireDefault(require("../../utils"));
+
+var _PageActions = _interopRequireDefault(require("../PageActions"));
 
 var _SummaryList = _interopRequireDefault(require("../SummaryList"));
 
-var _utils = _interopRequireDefault(require("../../utils"));
+var _Answer = _interopRequireDefault(require("./Answer"));
 
 require("./CheckYourAnswers.scss");
 
-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; }
 
-// Global imports
-// Local imports
-// Styles
+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); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { 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; }
+
+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 DEFAULT_CLASS = 'hods-check-your-answers';
+exports.DEFAULT_CLASS = DEFAULT_CLASS;
+var DEFAULT_TITLE = 'Check your answers';
+exports.DEFAULT_TITLE = DEFAULT_TITLE;
 var DEFAULT_MARGIN_BOTTOM = 9;
 exports.DEFAULT_MARGIN_BOTTOM = DEFAULT_MARGIN_BOTTOM;
 
 var CheckYourAnswers = function CheckYourAnswers(_ref) {
   var title = _ref.title,
-      pages = _ref.pages,
+      _pages = _ref.pages,
+      actions = _ref.actions,
+      _onAction = _ref.onAction,
+      onRowAction = _ref.onRowAction,
       hide_page_titles = _ref.hide_page_titles,
-      onAction = _ref.onAction;
+      hide_actions = _ref.hide_actions;
+
+  var _useState = (0, _react.useState)([]),
+      _useState2 = _slicedToArray(_useState, 2),
+      pages = _useState2[0],
+      setPages = _useState2[1];
+
+  var _useState3 = (0, _react.useState)([]),
+      _useState4 = _slicedToArray(_useState3, 2),
+      errors = _useState4[0],
+      setErrors = _useState4[1];
+
+  (0, _react.useEffect)(function () {
+    var getRows = function getRows(page, pageIndex) {
+      var rows = _utils.default.CheckYourAnswers.getRows(page, onRowAction);
+
+      return rows.map(function (row, index) {
+        return _objectSpread(_objectSpread({}, row), {}, {
+          value: /*#__PURE__*/_react.default.createElement(_Answer.default, {
+            key: "".concat(pageIndex, "_").concat(index),
+            value: row.value,
+            component: row.component
+          })
+        });
+      });
+    };
+
+    setPages(_pages.map(function (page, index) {
+      var rows = getRows(page, index);
+      return rows.length > 0 ? _objectSpread(_objectSpread({}, page), {}, {
+        rows: rows
+      }) : null;
+    }).filter(function (p) {
+      return !!p;
+    }));
+  }, [_pages, onRowAction, setPages]);
   var listMarginBottom = hide_page_titles ? 0 : DEFAULT_MARGIN_BOTTOM;
 
   var isLastPage = function isLastPage(index) {
     return index === pages.length - 1;
   };
 
+  var onError = function onError(errors) {
+    setErrors(errors);
+  };
+
   return /*#__PURE__*/_react.default.createElement("div", {
-    className: "hods-check-your-answers"
+    className: DEFAULT_CLASS
   }, title && /*#__PURE__*/_react.default.createElement(_copReactComponents.LargeHeading, {
     key: "heading"
-  }, title), pages && pages.map(function (page, pageIndex) {
-    var rows = _utils.default.CheckYourAnswers.getRows(page, onAction);
-
-    if (rows.length === 0) {
-      return null;
-    }
-
+  }, title), errors && errors.length > 0 && /*#__PURE__*/_react.default.createElement(_copReactComponents.ErrorSummary, {
+    errors: errors
+  }), pages && pages.map(function (page, pageIndex) {
     var pageMarginBottom = isLastPage(pageIndex) ? DEFAULT_MARGIN_BOTTOM : listMarginBottom;
     var className = "govuk-!-margin-bottom-".concat(pageMarginBottom);
     return /*#__PURE__*/_react.default.createElement(_react.Fragment, {
       key: pageIndex
     }, !hide_page_titles && page.title && /*#__PURE__*/_react.default.createElement(_copReactComponents.MediumHeading, null, page.title), /*#__PURE__*/_react.default.createElement(_SummaryList.default, {
       className: className,
-      rows: rows
+      rows: page.rows
     }));
+  }), !hide_actions && /*#__PURE__*/_react.default.createElement(_PageActions.default, {
+    actions: actions,
+    onAction: function onAction(action) {
+      return _onAction(action, onError);
+    }
   }));
 };
 
 CheckYourAnswers.propTypes = {
   title: _propTypes.default.string.isRequired,
   pages: _propTypes.default.arrayOf(_propTypes.default.object).isRequired,
-  hide_page_titles: _propTypes.default.bool
+  actions: _propTypes.default.arrayOf(_propTypes.default.object),
+  onAction: _propTypes.default.func.isRequired,
+  onRowAction: _propTypes.default.func.isRequired,
+  hide_page_titles: _propTypes.default.bool,
+  hide_actions: _propTypes.default.bool
 };
 CheckYourAnswers.defaultProps = {
-  title: 'Check your answers',
-  hide_page_titles: false
+  title: DEFAULT_TITLE,
+  hide_page_titles: false,
+  hide_actions: false
 };
 var _default = CheckYourAnswers;
 exports.default = _default;

package/dist/components/CheckYourAnswers/CheckYourAnswers.scss

@@ -1,9 +1,2 @@
 @import "node_modules/govuk-frontend/govuk/_base";
 @import "node_modules/govuk-frontend/govuk/overrides/spacing";
-
-.hods-check-your-answers {
-  .govuk-link {
-    color: govuk-colour('blue');
-    cursor: pointer;
-  }
-}

package/dist/components/CheckYourAnswers/CheckYourAnswers.stories.mdx

@@ -0,0 +1,149 @@
+<!-- Global imports -->
+import { ArgsTable, Canvas, Meta, Story } from '@storybook/addon-docs';
+import { Details, Heading, Link, Tag } from '@ukhomeoffice/cop-react-components';
+import withMock from 'storybook-addon-mock';
+
+<!-- Local imports -->
+import Utils from '../../utils';
+import CheckYourAnswers from './CheckYourAnswers';
+
+<!-- JSON documents -->
+import CIVIL_SERVANT from '../../json/areYouACivilServant.json';
+import GRADE from '../../json/grade.json';
+import TEAMS from '../../json/team.json';
+import USER_PROFILE_DATA from '../../json/userProfile.data.json';
+import USER_PROFILE from '../../json/userProfile.json';
+import FIRST_FORM from '../../json/firstForm.json';
+
+<Meta title="Components/Check your answers" id="D-CheckYourAnswers" component={ CheckYourAnswers } decorators={[withMock]} />
+
+<Heading size="xl" caption="Components">Check your answers</Heading>
+
+Renders the **Check your answers** screen for a form.
+
+<Canvas withToolbar>
+  <Story name="Default" parameters={{
+    mockData: [
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/areYouACivilServant`,
+        method: 'GET',
+        status: 200,
+        response: CIVIL_SERVANT
+      },
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/grade`,
+        method: 'GET',
+        status: 200,
+        response: GRADE
+      },
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/team`,
+        method: 'GET',
+        status: 200,
+        response: TEAMS
+      }
+    ]
+  }}>
+    {() => {
+      const DATA = Utils.Data.setupForm(USER_PROFILE.pages, USER_PROFILE.components, USER_PROFILE_DATA);
+      const PAGES = Utils.FormPage.getAll(USER_PROFILE.pages, USER_PROFILE.components, { ...DATA });
+      const ON_ACTION = (action, patch, onError) => {
+        console.log('action invoked', action, patch);
+      };
+      const ON_ROW_ACTION = (page) => {
+        console.log('row action invoked', page);
+      };
+      return (
+        <CheckYourAnswers pages={PAGES} onAction={ON_ACTION} onRowAction={ON_ROW_ACTION} />
+      );
+    }}
+  </Story>
+</Canvas>
+
+<Details summary="Properties" className="no-indent">
+  <ArgsTable of={ CheckYourAnswers } />
+</Details>
+
+## Variant
+### Without page titles
+
+<Canvas>
+  <Story name="No page titles" parameters={{
+    mockData: [
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/areYouACivilServant`,
+        method: 'GET',
+        status: 200,
+        response: CIVIL_SERVANT
+      },
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/grade`,
+        method: 'GET',
+        status: 200,
+        response: GRADE
+      },
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/team`,
+        method: 'GET',
+        status: 200,
+        response: TEAMS
+      }
+    ]
+  }}>
+    {() => {
+      const DATA = Utils.Data.setupForm(USER_PROFILE.pages, USER_PROFILE.components, USER_PROFILE_DATA);
+      const PAGES = Utils.FormPage.getAll(USER_PROFILE.pages, USER_PROFILE.components, { ...DATA });
+      const ON_ACTION = (action, patch, onError) => {
+        console.log('action invoked', action, patch);
+      };
+      const ON_ROW_ACTION = (page) => {
+        console.log('row action invoked', page);
+      };
+      return (
+        <CheckYourAnswers pages={PAGES} hide_page_titles={true} onAction={ON_ACTION} onRowAction={ON_ROW_ACTION} />
+      );
+    }}
+  </Story>
+</Canvas>
+
+### With actions
+
+<Canvas>
+  <Story name="With actions" parameters={{
+    mockData: [
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/areYouACivilServant`,
+        method: 'GET',
+        status: 200,
+        response: CIVIL_SERVANT
+      },
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/grade`,
+        method: 'GET',
+        status: 200,
+        response: GRADE
+      },
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/team`,
+        method: 'GET',
+        status: 200,
+        response: TEAMS
+      }
+    ]
+  }}>
+    {() => {
+      const DATA = { firstName: 'John', surname: 'Smith', age: 41 };
+      const PAGES = Utils.FormPage.getAll(FIRST_FORM.pages, FIRST_FORM.components, { ...DATA });
+      const ACTIONS = FIRST_FORM.cya.actions;
+      const ON_ACTION = (action, patch, onError) => {
+        console.log('action invoked', action, patch);
+      };
+      const ON_ROW_ACTION = (page) => {
+        console.log('row action invoked', page);
+      };
+      return (
+        <CheckYourAnswers pages={PAGES} hide_page_titles={true} actions={ACTIONS} onAction={ON_ACTION} onRowAction={ON_ROW_ACTION} />
+      );
+    }}
+  </Story>
+</Canvas>