@ukhomeoffice/cop-react-form-renderer 3.12.0 → 3.13.0

package/dist/components/FormRenderer/FormRenderer.js

@@ -250,9 +250,14 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
   }, [newPageId]); // Handle actions from pages.
 
   var onPageAction = function onPageAction(action, patch) {
-    // Re-apply the patch to the page's formData.
+    if (action.type === _models.PageAction.TYPES.CANCEL) {
+      hooks.onCancel();
+      return;
+    } // Re-apply the patch to the page's formData.
     // This should normally have no effect but will prevent issues 
     // with validation if formData happens to have been wiped.
+
+
     formState.page.formData = _objectSpread(_objectSpread({}, formState.page.formData), patch); // Check to see whether the action is able to proceed, which in
     // in the case of a submission will validate the fields in the page.
 
@@ -388,6 +393,10 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
         });
       }
     }
+
+    if (action.type === _models.PageAction.TYPES.CANCEL) {
+      hooks.onCancel();
+    }
   };
 
   var classes = _utils.default.classBuilder(classBlock, classModifiers, className);

package/dist/components/FormRenderer/FormRenderer.test.js

@@ -99,6 +99,10 @@ describe('components', function () {
       return page.childNodes[page.childNodes.length - 1].childNodes[0].childNodes[0];
     };
 
+    var getCancelButton = function getCancelButton(page) {
+      return page.childNodes[page.childNodes.length - 1].childNodes[1].childNodes[0];
+    };
+
     it('should start on the hub page correctly and display the title', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
       var form, title, hub;
       return regeneratorRuntime.wrap(function _callee2$(_context2) {
@@ -743,5 +747,66 @@ describe('components', function () {
         }
       }, _callee20);
     })));
+    it('should handle cancellation from a page', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee22() {
+      var ON_CANCEL_CALLS, ON_CANCEL, HOOKS, form, hub, _hub$childNodes5, civilServantList, link, page, cancel;
+
+      return regeneratorRuntime.wrap(function _callee22$(_context22) {
+        while (1) {
+          switch (_context22.prev = _context22.next) {
+            case 0:
+              ON_CANCEL_CALLS = [];
+
+              ON_CANCEL = function ON_CANCEL() {
+                ON_CANCEL_CALLS.push(undefined);
+              };
+
+              HOOKS = {
+                onCancel: ON_CANCEL
+              };
+              _context22.next = 5;
+              return (0, _testUtils.act)( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee21() {
+                return regeneratorRuntime.wrap(function _callee21$(_context21) {
+                  while (1) {
+                    switch (_context21.prev = _context21.next) {
+                      case 0:
+                        (0, _reactDom.render)( /*#__PURE__*/_react2.default.createElement(_FormRenderer.default, _extends({}, _userProfile.default, {
+                          data: _userProfileData.default,
+                          hooks: HOOKS
+                        })), container);
+
+                      case 1:
+                      case "end":
+                        return _context21.stop();
+                    }
+                  }
+                }, _callee21);
+              })));
+
+            case 5:
+              form = checkForm(container); // Navigate to the "Are you a civil servant?" page.
+
+              hub = form.childNodes[1]; // Hub = CYA
+
+              _hub$childNodes5 = _slicedToArray(hub.childNodes, 3), civilServantList = _hub$childNodes5[2];
+              link = getChangeLink(civilServantList);
+
+              _react.fireEvent.click(link, {}); // Should already be answered "Yes", so simply click "Continue".
+
+
+              page = form.childNodes[0];
+              cancel = getCancelButton(page);
+              expect(ON_CANCEL_CALLS.length).toEqual(0);
+
+              _react.fireEvent.click(cancel, {});
+
+              expect(ON_CANCEL_CALLS.length).toEqual(1);
+
+            case 15:
+            case "end":
+              return _context22.stop();
+          }
+        }
+      }, _callee22);
+    })));
   });
 });

package/dist/context/HooksContext/HooksContext.js

@@ -45,7 +45,9 @@ var DEFAULT_HOOKS = {
   },
   onSubmit: function onSubmit(type, payload, onSuccess, onError) {
     if (typeof onSuccess === 'function') onSuccess();
-  }
+  },
+  onCancel: function onCancel() {} // Consuming application must provide function to action, else this does nothing.
+
 };
 var ALLOWED_HOOKS = Object.keys(DEFAULT_HOOKS);
 exports.ALLOWED_HOOKS = ALLOWED_HOOKS;
@@ -62,7 +64,8 @@ var HooksContextProvider = function HooksContextProvider(_ref) {
     onGetComponent: (overrides === null || overrides === void 0 ? void 0 : overrides.onGetComponent) || DEFAULT_HOOKS.onGetComponent,
     onPageChange: (overrides === null || overrides === void 0 ? void 0 : overrides.onPageChange) || DEFAULT_HOOKS.onPageChange,
     onRequest: (overrides === null || overrides === void 0 ? void 0 : overrides.onRequest) || DEFAULT_HOOKS.onRequest,
-    onSubmit: (overrides === null || overrides === void 0 ? void 0 : overrides.onSubmit) || DEFAULT_HOOKS.onSubmit
+    onSubmit: (overrides === null || overrides === void 0 ? void 0 : overrides.onSubmit) || DEFAULT_HOOKS.onSubmit,
+    onCancel: (overrides === null || overrides === void 0 ? void 0 : overrides.onCancel) || DEFAULT_HOOKS.onCancel
   }),
       _useState2 = _slicedToArray(_useState, 2),
       hooks = _useState2[0],

package/dist/json/userProfile.json

@@ -138,7 +138,7 @@
           "label": ""
         }
       ],
-      "actions": ["submit"],
+      "actions": ["submit", "cancel"],
       "cya_link": {
         "page": "civil-servant-status",
         "aria_suffix": "civil servant status"

package/dist/models/PageAction.js

@@ -9,12 +9,14 @@ 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_CANCEL = 'cancel';
 var TYPE_NAVIGATE = 'navigate';
 var TYPE_SAVE_AND_CONTINUE = 'saveAndContinue';
 var TYPE_SAVE_AND_NAVIGATE = 'saveAndNavigate';
 var TYPE_SAVE_AND_RETURN = 'saveAndReturn';
 var TYPE_SUBMIT = 'submit';
 var PageActionTypes = {
+  CANCEL: TYPE_CANCEL,
   NAVIGATE: TYPE_NAVIGATE,
   SAVE_AND_CONTINUE: TYPE_SAVE_AND_CONTINUE,
   SAVE_AND_NAVIGATE: TYPE_SAVE_AND_NAVIGATE,
@@ -22,7 +24,12 @@ var PageActionTypes = {
   SUBMIT: TYPE_SUBMIT
 };
 exports.PageActionTypes = PageActionTypes;
-var DefaultPageActions = (_DefaultPageActions = {}, _defineProperty(_DefaultPageActions, TYPE_NAVIGATE, undefined), _defineProperty(_DefaultPageActions, TYPE_SAVE_AND_CONTINUE, {
+var DefaultPageActions = (_DefaultPageActions = {}, _defineProperty(_DefaultPageActions, TYPE_CANCEL, {
+  type: TYPE_CANCEL,
+  validate: false,
+  label: 'Cancel',
+  classModifiers: 'secondary'
+}), _defineProperty(_DefaultPageActions, TYPE_NAVIGATE, undefined), _defineProperty(_DefaultPageActions, TYPE_SAVE_AND_CONTINUE, {
   type: TYPE_SAVE_AND_CONTINUE,
   validate: true,
   label: 'Save and continue'

package/package.json

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