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

package/dist/components/PageActions/PageActions.test.js

@@ -4,6 +4,8 @@ var _react = require("@testing-library/react");
 
 var _react2 = _interopRequireDefault(require("react"));
 
+var _models = require("../../models");
+
 var _ActionButton = require("./ActionButton");
 
 var _PageActions = _interopRequireDefault(require("./PageActions"));
@@ -67,7 +69,7 @@ describe('components', function () {
               _react.fireEvent.click(submit, {});
 
               expect(ON_ACTION_CALLS.length).toEqual(1);
-              expect(ON_ACTION_CALLS[0]).toEqual(_ActionButton.DEFAULT_ACTIONS.submit);
+              expect(ON_ACTION_CALLS[0]).toEqual(_models.PageAction.DEFAULTS.submit);
 
             case 10:
             case "end":
@@ -142,7 +144,7 @@ describe('components', function () {
 
               expect(ON_ACTION_CALLS.length).toEqual(2);
               expect(ON_ACTION_CALLS[0]).toEqual(NAVIGATE);
-              expect(ON_ACTION_CALLS[1]).toEqual(_ActionButton.DEFAULT_ACTIONS.submit);
+              expect(ON_ACTION_CALLS[1]).toEqual(_models.PageAction.DEFAULTS.submit);
 
             case 16:
             case "end":

package/dist/components/SummaryList/RowAction.js

@@ -45,7 +45,7 @@ var RowAction = function RowAction(_ref) {
     setAttrs((0, _helpers.getRowActionAttributes)(row));
   }, [row, setAttrs]);
 
-  if (!(row !== null && row !== void 0 && row.action)) {
+  if (!row.action) {
     return null;
   }
 

package/dist/components/SummaryList/RowAction.test.js

@@ -12,23 +12,13 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 // Local imports
 describe('components', function () {
   describe('SummaryList.RowAction', function () {
-    it('should handle a null row', function () {
-      var ROW = null;
-
-      var _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
-        row: ROW
-      })),
-          container = _render.container;
-
-      expect(container.childNodes.length).toEqual(0);
-    });
     it('should handle a row without an action', function () {
       var ROW = {};
 
-      var _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
+      var _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
         row: ROW
       })),
-          container = _render2.container;
+          container = _render.container;
 
       expect(container.childNodes.length).toEqual(0);
     });
@@ -41,10 +31,10 @@ describe('components', function () {
         }
       };
 
-      var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
+      var _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
         row: ROW
       })),
-          container = _render3.container;
+          container = _render2.container;
 
       var link = container.childNodes[0];
       expect(link.tagName).toEqual('A');
@@ -61,10 +51,10 @@ describe('components', function () {
         }
       };
 
-      var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
+      var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
         row: ROW
       })),
-          container = _render4.container;
+          container = _render3.container;
 
       var link = container.childNodes[0];
       expect(link.tagName).toEqual('A');
@@ -85,10 +75,10 @@ describe('components', function () {
         }
       };
 
-      var _render5 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
+      var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
         row: ROW
       })),
-          container = _render5.container;
+          container = _render4.container;
 
       var link = container.childNodes[0];
       expect(link.tagName).toEqual('A');

package/dist/components/SummaryList/SummaryList.js

@@ -39,17 +39,17 @@ var SummaryList = function SummaryList(_ref) {
 
   return /*#__PURE__*/_react.default.createElement("dl", _extends({}, attrs, {
     className: classes()
-  }), rows.map(function (row, index) {
+  }), rows.map(function (row) {
     return /*#__PURE__*/_react.default.createElement("div", {
-      key: index,
+      key: "".concat(row.pageId, "_").concat(row.fieldId),
       className: classes('row')
     }, /*#__PURE__*/_react.default.createElement("dt", {
       className: classes('key')
     }, row.key), /*#__PURE__*/_react.default.createElement("dd", {
       className: classes('value')
-    }, row.value), row.action && /*#__PURE__*/_react.default.createElement("dd", {
+    }, row.value), /*#__PURE__*/_react.default.createElement("dd", {
       className: classes('actions')
-    }, /*#__PURE__*/_react.default.createElement(_RowAction.default, {
+    }, row.action && /*#__PURE__*/_react.default.createElement(_RowAction.default, {
       row: row
     })));
   }));

package/dist/components/SummaryList/SummaryList.scss

@@ -1,2 +1,9 @@
 @import "node_modules/govuk-frontend/govuk/_base";
 @import "node_modules/govuk-frontend/govuk/components/summary-list/_summary-list";
+
+.govuk-summary-list__actions {
+  .govuk-link {
+    color: govuk-colour('blue');
+    cursor: pointer;
+  }
+}

package/dist/components/SummaryList/SummaryList.stories.mdx

@@ -0,0 +1,36 @@
+<!-- Global imports -->
+import { ArgsTable, Canvas, Meta, Story } from '@storybook/addon-docs';
+import { Details, Heading } from '@ukhomeoffice/cop-react-components';
+
+<!-- Local imports -->
+import Utils from '../../utils';
+import SummaryList from './SummaryList';
+
+<Meta title="Components/Summary list" id="D-SummaryList" component={ SummaryList } />
+
+<Heading size="xl" caption="Components">Summary list</Heading>
+
+Renders a list of key-value pairs, most commonly on the **Check your answers** screen, and optionally
+display action links.
+
+<Canvas withToolbar>
+  <Story name="Default">
+    {() => {
+      const onAction = (row) => {
+        console.log('action clicked', row);
+      };
+      const ROWS = [
+        { pageId: 'p1', fieldId: 'forename', key: 'Forename(s)', value: 'John' },
+        { pageId: 'p1', fieldId: 'surname', key: 'Surname', value: 'Smith' },
+        { pageId: 'p2', fieldId: 'dob', key: 'Date of birth', value: '29/08/1993', action: { label: 'Change', onAction } },
+      ];
+      return (
+        <SummaryList rows={ROWS} />
+      );
+    }}
+  </Story>
+</Canvas>
+
+<Details summary="Properties" className="no-indent">
+  <ArgsTable of={ SummaryList } />
+</Details>

package/dist/components/SummaryList/SummaryList.test.js

@@ -0,0 +1,197 @@
+"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 _react2 = _interopRequireDefault(require("react"));
+
+var _SummaryList = _interopRequireWildcard(require("./SummaryList"));
+
+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 _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: 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; }
+
+describe('components', function () {
+  describe('SummaryList', function () {
+    var checkSummaryList = function checkSummaryList(container, id) {
+      var summaryList = (0, _react.getByTestId)(container, id);
+      expect(summaryList.tagName).toEqual('DL');
+      expect(summaryList.classList).toContain(_SummaryList.DEFAULT_CLASS);
+      return summaryList;
+    };
+
+    var checkRow = function checkRow(summaryList, index) {
+      var row = summaryList.childNodes[index];
+      expect(row.tagName).toEqual('DIV');
+      expect(row.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__row"));
+
+      var _row$childNodes = _slicedToArray(row.childNodes, 3),
+          key = _row$childNodes[0],
+          value = _row$childNodes[1],
+          actions = _row$childNodes[2];
+
+      expect(key.tagName).toEqual('DT');
+      expect(key.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__key"));
+      expect(value.tagName).toEqual('DD');
+      expect(value.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__value"));
+      expect(actions.tagName).toEqual('DD');
+      expect(actions.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__actions"));
+      return [key, value, actions];
+    };
+
+    it('should handle an empty rows array', function () {
+      var ID = 'test-id';
+      var ROWS = [];
+
+      var _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+        "data-testid": ID,
+        rows: ROWS
+      })),
+          container = _render.container;
+
+      var summaryList = checkSummaryList(container, ID);
+      expect(summaryList.childNodes.length).toEqual(0);
+    });
+    it('should handle rows with no actions and string values', function () {
+      var ID = 'test-id';
+      var ROWS = [{
+        pageId: 'p1',
+        fieldId: 'a',
+        key: 'Alpha',
+        value: 'Alpha value'
+      }, {
+        pageId: 'p2',
+        fieldId: 'b',
+        key: 'Bravo',
+        value: 'Bravo value'
+      }];
+
+      var _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+        "data-testid": ID,
+        rows: ROWS
+      })),
+          container = _render2.container;
+
+      var summaryList = checkSummaryList(container, ID);
+      expect(summaryList.childNodes.length).toEqual(ROWS.length);
+      ROWS.forEach(function (row, index) {
+        var _checkRow = checkRow(summaryList, index),
+            _checkRow2 = _slicedToArray(_checkRow, 3),
+            key = _checkRow2[0],
+            value = _checkRow2[1],
+            actions = _checkRow2[2];
+
+        expect(key.textContent).toEqual(row.key);
+        expect(value.textContent).toEqual(row.value);
+        expect(actions.childNodes.length).toEqual(0);
+      });
+    });
+    it('should handle rows with no actions and component values', function () {
+      var ID = 'test-id';
+      var VALUES = ['Alpha component value', 'Bravo component value'];
+      var ROWS = [{
+        pageId: 'p1',
+        fieldId: 'a',
+        key: 'Alpha',
+        value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[0])
+      }, {
+        pageId: 'p2',
+        fieldId: 'b',
+        key: 'Bravo',
+        value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[1])
+      }];
+
+      var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+        "data-testid": ID,
+        rows: ROWS
+      })),
+          container = _render3.container;
+
+      var summaryList = checkSummaryList(container, ID);
+      expect(summaryList.childNodes.length).toEqual(ROWS.length);
+      ROWS.forEach(function (row, index) {
+        var _checkRow3 = checkRow(summaryList, index),
+            _checkRow4 = _slicedToArray(_checkRow3, 3),
+            key = _checkRow4[0],
+            value = _checkRow4[1],
+            actions = _checkRow4[2];
+
+        expect(key.textContent).toEqual(row.key);
+        expect(value.childNodes.length).toEqual(1);
+        var valueDiv = value.childNodes[0];
+        expect(valueDiv.tagName).toEqual('DIV');
+        expect(valueDiv.textContent).toEqual(VALUES[index]);
+        expect(actions.childNodes.length).toEqual(0);
+      });
+    });
+    it('should handle rows with actions', function () {
+      var ID = 'test-id';
+      var ON_ACTION_CALLS = [];
+
+      var ON_ACTION = function ON_ACTION(row) {
+        ON_ACTION_CALLS.push(row);
+      };
+
+      var ROWS = [{
+        pageId: 'p1',
+        fieldId: 'a',
+        key: 'Alpha',
+        value: 'Alpha value',
+        action: {
+          label: 'Change A',
+          onAction: ON_ACTION
+        }
+      }, {
+        pageId: 'p2',
+        fieldId: 'b',
+        key: 'Bravo',
+        value: 'Bravo value',
+        action: {
+          label: 'Change B',
+          onAction: ON_ACTION
+        }
+      }];
+
+      var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+        "data-testid": ID,
+        rows: ROWS
+      })),
+          container = _render4.container;
+
+      var summaryList = checkSummaryList(container, ID);
+      expect(summaryList.childNodes.length).toEqual(ROWS.length);
+      ROWS.forEach(function (row, index) {
+        var _checkRow5 = checkRow(summaryList, index),
+            _checkRow6 = _slicedToArray(_checkRow5, 3),
+            key = _checkRow6[0],
+            value = _checkRow6[1],
+            actions = _checkRow6[2];
+
+        expect(key.textContent).toEqual(row.key);
+        expect(value.textContent).toEqual(row.value);
+        var a = actions.childNodes[0];
+        expect(a.textContent).toEqual(row.action.label);
+
+        _react.fireEvent.click(a, {});
+
+        expect(ON_ACTION_CALLS.length).toEqual(index + 1);
+        expect(ON_ACTION_CALLS[index]).toEqual(row);
+      });
+    });
+  });
+});

package/dist/hooks/useHooks.js

@@ -3,32 +3,29 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.resetHooks = exports.removeHook = exports.default = exports.addHook = void 0;
-var ALLOWED_HOOKS = ['onRequest', 'onFormLoad', 'onPageChange', 'onSubmit'];
+exports.resetHooks = exports.removeHook = exports.default = exports.addHook = exports.ALLOWED_HOOKS = void 0;
+var ALLOWED_HOOKS = ['onRequest', 'onFormComplete', 'onFormLoad', 'onPageChange', 'onSubmit'];
+exports.ALLOWED_HOOKS = ALLOWED_HOOKS;
 var DEFAULT_HOOKS = {
-  onRequest: function onRequest(req) {
-    return req;
-  },
+  onFormComplete: function onFormComplete() {},
   onFormLoad: function onFormLoad() {},
   onPageChange: function onPageChange(pageId) {
     return pageId;
   },
-  onSubmit: function onSubmit(type, payload, onSuccess, onError) {
-    onSuccess();
-  }
-};
-var hooks = {
   onRequest: function onRequest(req) {
     return req;
   },
-  onFormLoad: function onFormLoad() {},
-  onPageChange: function onPageChange(pageId) {
-    return pageId;
-  },
   onSubmit: function onSubmit(type, payload, onSuccess, onError) {
-    onSuccess();
+    if (typeof onSuccess === 'function') onSuccess();
   }
 };
+var hooks = {
+  onFormComplete: DEFAULT_HOOKS.onFormComplete,
+  onFormLoad: DEFAULT_HOOKS.onFormLoad,
+  onPageChange: DEFAULT_HOOKS.onPageChange,
+  onRequest: DEFAULT_HOOKS.onRequest,
+  onSubmit: DEFAULT_HOOKS.onSubmit
+};
 
 var addHook = function addHook(name, hook) {
   if (ALLOWED_HOOKS.includes(name)) {

package/dist/index.js

@@ -41,7 +41,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 // Local imports
 var intercepts = {
-  add: _useHooks.addHook
+  add: _useHooks.addHook,
+  remove: _useHooks.removeHook,
+  reset: _useHooks.resetHooks
 };
 exports.intercepts = intercepts;
 var _default = _FormRenderer.default;

package/dist/index.test.js

@@ -0,0 +1,18 @@
+"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 _ = _interopRequireWildcard(require("."));
+
+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; }
+
+// Local imports
+it('should have exported everything appropriately', function () {
+  expect(_.default).toBeDefined();
+  expect(_.FormTypes).toBeDefined();
+  expect(_.HubFormats).toBeDefined();
+  expect(_.intercepts).toBeDefined();
+  expect(_.Utils).toBeDefined();
+});

package/dist/models/EventTypes.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var TYPE_BLUR = 'blur';
+var TYPE_SUBMIT = 'submit';
+var EventTypes = {
+  BLUR: TYPE_BLUR,
+  SUBMIT: TYPE_SUBMIT
+};
+var _default = EventTypes;
+exports.default = _default;

package/dist/models/FormPages.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var PAGE_CYA = 'cya';
+var PAGE_HUB = 'hub';
+var FormPages = {
+  CYA: PAGE_CYA,
+  HUB: PAGE_HUB
+};
+var _default = FormPages;
+exports.default = _default;

package/dist/models/PageAction.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.PageActionTypes = exports.DefaultPageActions = void 0;
+
+var _DefaultPageActions;
+
+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 TYPE_SUBMIT = 'submit';
+var TYPE_SAVE_AND_CONTINUE = 'saveAndContinue';
+var TYPE_SAVE_AND_RETURN = 'saveAndReturn';
+var PageActionTypes = {
+  SUBMIT: TYPE_SUBMIT,
+  SAVE_AND_CONTINUE: TYPE_SAVE_AND_CONTINUE,
+  SAVE_AND_RETURN: TYPE_SAVE_AND_RETURN
+};
+exports.PageActionTypes = PageActionTypes;
+var DefaultPageActions = (_DefaultPageActions = {}, _defineProperty(_DefaultPageActions, TYPE_SUBMIT, {
+  type: TYPE_SUBMIT,
+  validate: true
+}), _defineProperty(_DefaultPageActions, TYPE_SAVE_AND_CONTINUE, {
+  type: TYPE_SAVE_AND_CONTINUE,
+  validate: true,
+  label: 'Save and continue'
+}), _defineProperty(_DefaultPageActions, TYPE_SAVE_AND_RETURN, {
+  type: TYPE_SAVE_AND_RETURN,
+  validate: false,
+  label: 'Save and return later',
+  classModifiers: 'secondary'
+}), _DefaultPageActions);
+exports.DefaultPageActions = DefaultPageActions;
+var PageAction = {
+  TYPES: PageActionTypes,
+  DEFAULTS: DefaultPageActions
+};
+var _default = PageAction;
+exports.default = _default;

package/dist/models/index.js

@@ -9,6 +9,18 @@ Object.defineProperty(exports, "ComponentTypes", {
     return _ComponentTypes.default;
   }
 });
+Object.defineProperty(exports, "EventTypes", {
+  enumerable: true,
+  get: function get() {
+    return _EventTypes.default;
+  }
+});
+Object.defineProperty(exports, "FormPages", {
+  enumerable: true,
+  get: function get() {
+    return _FormPages.default;
+  }
+});
 Object.defineProperty(exports, "FormTypes", {
   enumerable: true,
   get: function get() {
@@ -21,11 +33,23 @@ Object.defineProperty(exports, "HubFormats", {
     return _HubFormats.default;
   }
 });
+Object.defineProperty(exports, "PageAction", {
+  enumerable: true,
+  get: function get() {
+    return _PageAction.default;
+  }
+});
 
 var _ComponentTypes = _interopRequireDefault(require("./ComponentTypes"));
 
+var _EventTypes = _interopRequireDefault(require("./EventTypes"));
+
+var _FormPages = _interopRequireDefault(require("./FormPages"));
+
 var _FormTypes = _interopRequireDefault(require("./FormTypes"));
 
 var _HubFormats = _interopRequireDefault(require("./HubFormats"));
 
+var _PageAction = _interopRequireDefault(require("./PageAction"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/utils/CheckYourAnswers/getCYAAction.js

@@ -5,6 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+/**
+ * Gets an action object, configured appropriately for a Check your answers component.
+ * 
+ * @param {boolean} readonly Whether or not the component is readonly.
+ * @param {object} cya_link A configuration object for any link to show.
+ * @param {Function} onAction A function to invoke if the link is clicked.
+ * 
+ * @returns An action object for a Check your answers row.
+ */
 var getCYAAction = function getCYAAction(readonly, cya_link, onAction) {
   if (readonly !== true && cya_link) {
     return {

package/dist/utils/CheckYourAnswers/getCYARow.js

@@ -12,6 +12,16 @@ var _getCYAAction = _interopRequireDefault(require("./getCYAAction"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
+
+/**
+ * Gets a row object, configured appropriately for a Check your answers component.
+ * 
+ * @param {object} page The page to which this component row belongs.
+ * @param {object} component The component to render on this row.
+ * @param {Function} onAction A function to invoke if the change link is clicked.
+ * 
+ * @returns A configuration object for a Check your answers row.
+ */
 var getCYARow = function getCYARow(page, component, onAction) {
   return {
     pageId: page.id,

package/dist/utils/CheckYourAnswers/getCYARowsForPage.js

@@ -12,6 +12,15 @@ var _showComponentCYA = _interopRequireDefault(require("./showComponentCYA"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
+
+/**
+ * Gets an array of row objects, each configured appropriately for a Check your answers component.
+ * 
+ * @param {object} page The page to show components for.
+ * @param {Function} onAction A function to invoke if the change link on any row is clicked.
+ * 
+ * @returns An array of configuration objects for Check your answers rows.
+ */
 var getCYARowsForPage = function getCYARowsForPage(page, onAction) {
   return page.components.filter(function (c) {
     return (0, _showComponentCYA.default)(c, page.formData);

package/dist/utils/CheckYourAnswers/showComponentCYA.js

@@ -5,20 +5,21 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _Component = _interopRequireDefault(require("../Component"));
-
 var _models = require("../../models");
 
+var _Component = _interopRequireDefault(require("../Component"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
 var EXCLUDE_FROM_CYA = [_models.ComponentTypes.HEADING, _models.ComponentTypes.HTML, _models.ComponentTypes.INSET_TEXT];
 /**
- * Determines whether a given component should display on the
- * Check your answers page.
+ * Determines whether a given component should display on the Check your answers screen.
+ * 
  * @param {object} options The component options.
  * @param {object} data The data contained on the form.
- * @returns A boolean true, if the component should show; otherwise false.
+ * 
+ * @returns A boolean true if the component should show; otherwise false.
  */
 
 var showComponentCYA = function showComponentCYA(options, data) {

package/dist/utils/Component/getComponent.test.js

@@ -75,7 +75,7 @@ describe('utils', function () {
 
         var heading = (0, _react.getByTestId)(container, ID);
         expect(heading.innerHTML).toContain(CONTENT);
-        expect(heading.tagName).toEqual('H3');
+        expect(heading.tagName).toEqual('H2');
         expect(heading.classList).toContain("govuk-heading-".concat(SIZE));
       });
       it('should return an appropriately rendered inset-text component', function () {