@ukhomeoffice/cop-react-form-renderer 2.0.0 → 2.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -36,3 +36,15 @@ Runs Storybook on [http://localhost:6007](http://localhost:6007), which showcase
 ### `yarn storybook:build`
 
 Builds Storybook for production to the `storybook-static` folder.
+
+# Using the Service
+## Versioning
+For versioning this project uses SemVer.
+
+## Authors
+This project is authored by the Home Office.
+
+## License
+This project is licensed under the MIT license. For details please see [License](./LICENSE).
+
+This project contains public sector information licensed under the Open Government Licence v3.0. (http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/)

package/dist/components/CheckYourAnswers/CheckYourAnswers.js

@@ -61,7 +61,10 @@ var CheckYourAnswers = function CheckYourAnswers(_ref) {
       _onAction = _ref.onAction,
       onRowAction = _ref.onRowAction,
       hide_page_titles = _ref.hide_page_titles,
-      hide_actions = _ref.hide_actions;
+      hide_actions = _ref.hide_actions,
+      hide_title = _ref.hide_title,
+      summaryListClassModifiers = _ref.summaryListClassModifiers,
+      noChangeAction = _ref.noChangeAction;
 
   var _useState = (0, _react.useState)([]),
       _useState2 = _slicedToArray(_useState, 2),
@@ -109,7 +112,7 @@ var CheckYourAnswers = function CheckYourAnswers(_ref) {
 
   return /*#__PURE__*/_react.default.createElement("div", {
     className: DEFAULT_CLASS
-  }, title && /*#__PURE__*/_react.default.createElement(_copReactComponents.LargeHeading, {
+  }, title && !hide_title && /*#__PURE__*/_react.default.createElement(_copReactComponents.LargeHeading, {
     key: "heading"
   }, title), errors && errors.length > 0 && /*#__PURE__*/_react.default.createElement(_copReactComponents.ErrorSummary, {
     errors: errors
@@ -120,7 +123,9 @@ var CheckYourAnswers = function CheckYourAnswers(_ref) {
       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: page.rows
+      rows: page.rows,
+      classModifiers: summaryListClassModifiers,
+      noChangeAction: noChangeAction
     }));
   }), !hide_actions && /*#__PURE__*/_react.default.createElement(_PageActions.default, {
     actions: actions,
@@ -137,12 +142,18 @@ CheckYourAnswers.propTypes = {
   onAction: _propTypes.default.func.isRequired,
   onRowAction: _propTypes.default.func.isRequired,
   hide_page_titles: _propTypes.default.bool,
-  hide_actions: _propTypes.default.bool
+  hide_actions: _propTypes.default.bool,
+  hide_title: _propTypes.default.bool,
+  summaryListClassModifiers: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]),
+  noChangeAction: _propTypes.default.bool
 };
 CheckYourAnswers.defaultProps = {
   title: DEFAULT_TITLE,
   hide_page_titles: false,
-  hide_actions: false
+  hide_actions: false,
+  hide_title: false,
+  summaryListClassModifiers: null,
+  noChangeAction: false
 };
 var _default = CheckYourAnswers;
 exports.default = _default;

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

@@ -1,13 +1,21 @@
 <!-- Global imports -->
+
 import { ArgsTable, Canvas, Meta, Story } from '@storybook/addon-docs';
-import { Details, Heading, Link, Tag } from '@ukhomeoffice/cop-react-components';
+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';
@@ -15,38 +23,56 @@ 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]} />
+<Meta
+  title='Components/Check your answers'
+  id='D-CheckYourAnswers'
+  component={CheckYourAnswers}
+  decorators={[withMock]}
+/>
 
-<Heading size="xl" caption="Components">Check your answers</Heading>
+<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
-      }
-    ]
-  }}>
+  <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 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);
       };
@@ -54,45 +80,61 @@ Renders the **Check your answers** screen for a form.
         console.log('row action invoked', page);
       };
       return (
-        <CheckYourAnswers pages={PAGES} onAction={ON_ACTION} onRowAction={ON_ROW_ACTION} />
+        <CheckYourAnswers
+          pages={PAGES}
+          onAction={ON_ACTION}
+          onRowAction={ON_ROW_ACTION}
+        />
       );
     }}
   </Story>
 </Canvas>
 
-<Details summary="Properties" className="no-indent">
-  <ArgsTable of={ CheckYourAnswers } />
+<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
-      }
-    ]
-  }}>
+  <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 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);
       };
@@ -100,7 +142,12 @@ Renders the **Check your answers** screen for a form.
         console.log('row action invoked', page);
       };
       return (
-        <CheckYourAnswers pages={PAGES} hide_page_titles={true} onAction={ON_ACTION} onRowAction={ON_ROW_ACTION} />
+        <CheckYourAnswers
+          pages={PAGES}
+          hide_page_titles={true}
+          onAction={ON_ACTION}
+          onRowAction={ON_ROW_ACTION}
+        />
       );
     }}
   </Story>
@@ -109,31 +156,38 @@ Renders the **Check your answers** screen for a form.
 ### 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
-      }
-    ]
-  }}>
+  <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 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);
@@ -142,7 +196,73 @@ Renders the **Check your answers** screen for a form.
         console.log('row action invoked', page);
       };
       return (
-        <CheckYourAnswers pages={PAGES} hide_page_titles={true} actions={ACTIONS} onAction={ON_ACTION} onRowAction={ON_ROW_ACTION} />
+        <CheckYourAnswers
+          pages={PAGES}
+          hide_page_titles={true}
+          actions={ACTIONS}
+          onAction={ON_ACTION}
+          onRowAction={ON_ROW_ACTION}
+        />
+      );
+    }}
+  </Story>
+</Canvas>
+
+### Read-only style
+
+<Canvas>
+  <Story
+    name='Read-only style'
+    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}
+          hide_title={true}
+          summaryListClassModifiers='no-border'
+          noChangeAction={true}
+        />
       );
     }}
   </Story>

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

@@ -328,5 +328,49 @@ describe('components', function () {
         }
       }, _callee10);
     })));
+    it('should show no title if is set to hidden', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee12() {
+      var cya, _cya$childNodes4, names, _names$childNodes2, firstName, surname;
+
+      return regeneratorRuntime.wrap(function _callee12$(_context12) {
+        while (1) {
+          switch (_context12.prev = _context12.next) {
+            case 0:
+              _context12.next = 2;
+              return (0, _testUtils.act)( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee11() {
+                return regeneratorRuntime.wrap(function _callee11$(_context11) {
+                  while (1) {
+                    switch (_context11.prev = _context11.next) {
+                      case 0:
+                        (0, _reactDom.render)( /*#__PURE__*/_react.default.createElement(_CheckYourAnswers.default, {
+                          pages: PAGES,
+                          onRowAction: ON_ROW_ACTION,
+                          onAction: ON_ACTION,
+                          hide_title: true
+                        }), container);
+
+                      case 1:
+                      case "end":
+                        return _context11.stop();
+                    }
+                  }
+                }, _callee11);
+              })));
+
+            case 2:
+              cya = checkCYA(container);
+              _cya$childNodes4 = _slicedToArray(cya.childNodes, 1), names = _cya$childNodes4[0];
+              expect(names.tagName).toEqual('DL');
+              expect(names.classList).toContain("govuk-!-margin-bottom-".concat(_CheckYourAnswers.DEFAULT_MARGIN_BOTTOM));
+              _names$childNodes2 = _slicedToArray(names.childNodes, 2), firstName = _names$childNodes2[0], surname = _names$childNodes2[1];
+              checkRow(firstName, 'First name', 'John', false);
+              checkRow(surname, 'Last name', 'Smith', false);
+
+            case 9:
+            case "end":
+              return _context12.stop();
+          }
+        }
+      }, _callee12);
+    })));
   });
 });

package/dist/components/FormComponent/FormComponent.js

@@ -11,6 +11,8 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 
 var _react = require("react");
 
+var _useHooks2 = _interopRequireDefault(require("../../hooks/useHooks"));
+
 var _useRefData2 = _interopRequireWildcard(require("../../hooks/useRefData"));
 
 var _utils = _interopRequireDefault(require("../../utils"));
@@ -52,6 +54,9 @@ var FormComponent = function FormComponent(_ref) {
       onChange = _ref.onChange,
       attrs = _objectWithoutProperties(_ref, _excluded);
 
+  var _useHooks = (0, _useHooks2.default)(),
+      hooks = _useHooks.hooks;
+
   var _useRefData = (0, _useRefData2.default)(component),
       data = _useRefData.data,
       status = _useRefData.status;
@@ -72,7 +77,7 @@ var FormComponent = function FormComponent(_ref) {
     options: options,
     value: value || '',
     onChange: onChange
-  }), wrap);
+  }), wrap, hooks.onGetComponent);
 };
 
 FormComponent.propTypes = {

package/dist/components/FormComponent/FormComponent.test.js

@@ -4,6 +4,8 @@ var _react = require("@testing-library/react");
 
 var _react2 = _interopRequireDefault(require("react"));
 
+var _useHooks = require("../../hooks/useHooks");
+
 var _FormComponent = _interopRequireDefault(require("./FormComponent"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -14,6 +16,9 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
 
 describe('components', function () {
   describe('FormComponent', function () {
+    beforeEach(function () {
+      (0, _useHooks.resetHooks)();
+    });
     it('should render a text component appropriately', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
       var ID, VALUE, COMPONENT, ON_CHANGE, _render, container, formGroup, label, hint, input;
 
@@ -133,5 +138,67 @@ describe('components', function () {
         }
       }, _callee3);
     })));
+    it('should render an overridden html component appropriately', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee4() {
+      var ID, COMPONENT, _render4, container, div;
+
+      return regeneratorRuntime.wrap(function _callee4$(_context4) {
+        while (1) {
+          switch (_context4.prev = _context4.next) {
+            case 0:
+              (0, _useHooks.addHook)('onGetComponent', function (config, wrap) {
+                return /*#__PURE__*/_react2.default.createElement("div", null, "".concat(config.type, " | ").concat(config.tagName, " | ").concat(config.content, " | ").concat(wrap));
+              });
+              ID = 'component';
+              COMPONENT = {
+                type: 'html',
+                tagName: 'p',
+                content: 'HTML content'
+              };
+              _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_FormComponent.default, {
+                "data-testid": ID,
+                component: COMPONENT
+              })), container = _render4.container;
+              div = container.childNodes[0];
+              expect(div.tagName).toEqual('DIV');
+              expect(div.textContent).toEqual("".concat(COMPONENT.type, " | ").concat(COMPONENT.tagName, " | ").concat(COMPONENT.content, " | true"));
+
+            case 7:
+            case "end":
+              return _context4.stop();
+          }
+        }
+      }, _callee4);
+    })));
+    it('should render the correct html component when the override returns null', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5() {
+      var ID, COMPONENT, _render5, container, p;
+
+      return regeneratorRuntime.wrap(function _callee5$(_context5) {
+        while (1) {
+          switch (_context5.prev = _context5.next) {
+            case 0:
+              (0, _useHooks.addHook)('onGetComponent', function () {
+                return null;
+              });
+              ID = 'component';
+              COMPONENT = {
+                type: 'html',
+                tagName: 'p',
+                content: 'HTML content'
+              };
+              _render5 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_FormComponent.default, {
+                "data-testid": ID,
+                component: COMPONENT
+              })), container = _render5.container;
+              p = container.childNodes[0];
+              expect(p.tagName).toEqual('P');
+              expect(p.textContent).toEqual(COMPONENT.content);
+
+            case 7:
+            case "end":
+              return _context5.stop();
+          }
+        }
+      }, _callee5);
+    })));
   });
 });