@ukhomeoffice/cop-react-form-renderer 4.88.0 → 4.89.0

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

@@ -273,7 +273,13 @@ describe('components', function () {
               }]);
             };
             HOOKS = {
-              onSubmit: ON_SUBMIT
+              onSubmit: ON_SUBMIT,
+              onAction: function onAction(formData, patch) {
+                return {
+                  formData: formData,
+                  patch: patch
+                };
+              }
             };
             _context10.next = 5;
             return (0, _testUtils.act)( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee9() {

package/dist/components/FormRenderer/onPageAction.js

@@ -27,16 +27,19 @@ var onPageAction = function onPageAction(action, patch, patchLabel, hooks, data,
   ;
   // Save a copy of data in case submit errors and we need to revert
   var preSubmitData = _objectSpread({}, data);
+  var form = formState;
+  var update = hooks.onAction(form.page.formData, patch, data, action.customAction);
+  form.page.formData = update.formData;
+  var _patch = update.patch;
+
   // 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.
-  var form = formState;
-  form.page.formData = _objectSpread(_objectSpread({}, form.page.formData), patch);
+  form.page.formData = _objectSpread(_objectSpread({}, form.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.
   if (_helpers.default.canActionProceed(action, form.page, validate.page)) {
-    var _patch = patch;
-    _patch = _helpers.default.cleanHiddenNestedData(patch, form.page);
+    _patch = _helpers.default.cleanHiddenNestedData(_patch, form.page);
     if (action.addToFormData) {
       var operations = Array.isArray(action.addToFormData) ? action.addToFormData : [action.addToFormData];
       operations.forEach(function (op) {

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

@@ -130,6 +130,15 @@ describe('components.FormRenderer.onPageAction', function () {
       this.onSubmitArgs = [];
       this.onFormCompleteCalls = 0;
       this.onCancelCalls = 0;
+      this.onActionCalls = 0;
+    },
+    onActionCalls: 0,
+    onAction: function onAction(formData, patch) {
+      this.onActionCalls += 1;
+      return {
+        formData: formData,
+        patch: patch
+      };
     }
   };
   var MOCK_VALIDATE = {
@@ -260,6 +269,7 @@ describe('components.FormRenderer.onPageAction', function () {
         changedFieldValue: argsUsed.patchLabel[firstKey]
       });
     }
+    expect(MOCK_HOOKS.onActionCalls).toEqual(1);
 
     // Both the success and error paths of the onSubmit hook are tested
     // together to make sure the correct function chains are called for

package/dist/context/HooksContext/HooksContext.js

@@ -22,6 +22,12 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
 function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 var DEFAULT_HOOKS = {
+  onAction: function onAction(formData, patch) {
+    return {
+      formData: formData,
+      patch: patch
+    };
+  },
   onChange: function onChange(data) {},
   onFormComplete: function onFormComplete() {},
   onFormLoad: function onFormLoad(setCurrentTask) {},
@@ -61,6 +67,7 @@ var HooksContextProvider = function HooksContextProvider(_ref) {
   var overrides = _ref.overrides,
     children = _ref.children;
   var _useState = (0, _react.useState)({
+      onAction: (overrides === null || overrides === void 0 ? void 0 : overrides.onAction) || DEFAULT_HOOKS.onAction,
       onChange: (overrides === null || overrides === void 0 ? void 0 : overrides.onChange) || DEFAULT_HOOKS.onChange,
       onFormComplete: (overrides === null || overrides === void 0 ? void 0 : overrides.onFormComplete) || DEFAULT_HOOKS.onFormComplete,
       onFormLoad: (overrides === null || overrides === void 0 ? void 0 : overrides.onFormLoad) || DEFAULT_HOOKS.onFormLoad,
@@ -104,6 +111,7 @@ exports.default = _default;
 HooksContextProvider.propTypes = {
   children: _propTypes.default.node,
   overrides: _propTypes.default.shape({
+    onAction: _propTypes.default.func,
     onCancel: _propTypes.default.func,
     onChange: _propTypes.default.func,
     onFormComplete: _propTypes.default.func,
@@ -121,6 +129,7 @@ HooksContextProvider.propTypes = {
 HooksContextProvider.defaultProps = {
   children: null,
   overrides: {
+    onAction: undefined,
     onCancel: undefined,
     onChange: undefined,
     onFormComplete: undefined,

package/package.json

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