@ukhomeoffice/cop-react-form-renderer 5.0.0-alpha → 5.0.1

package/dist/components/FormRenderer/onPageAction.js

@@ -0,0 +1,145 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _models = require("../../models");
+var _utils = _interopRequireDefault(require("../../utils"));
+var _handlers = _interopRequireDefault(require("./handlers"));
+var _helpers = _interopRequireDefault(require("./helpers"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+// Handle actions from pages.
+// (patch captures payload-ready field name and value, 
+// patchLabel captures non-ID values 
+// for display purposes after submission.)
+var onPageAction = function onPageAction(action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors) {
+  if (action.type === _models.PageAction.TYPES.CANCEL) {
+    hooks.onCancel();
+    return;
+  }
+  ;
+  // 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.
+  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)) {
+    _patch = _helpers.default.cleanHiddenNestedData(_patch, form.page);
+    if (action.addToFormData) {
+      var operations = Array.isArray(action.addToFormData) ? action.addToFormData : [action.addToFormData];
+      operations.forEach(function (op) {
+        _utils.default.Data.setDataItem(formState.page.formData, op.field, op.value);
+      });
+      form.page.formData[action.addToFormData.field] = action.addToFormData.value;
+    }
+    if (action.type === _models.PageAction.TYPES.NAVIGATE) {
+      _handlers.default.navigate(action, pageId, onPageChange);
+    } else {
+      var pageUpdate = function pageUpdate(next) {
+        return onPageChange(_helpers.default.getNextPageId(type, pages, pageId, action, next));
+      };
+      /* eslint-disable no-case-declarations */
+      switch (action.type) {
+        case _models.PageAction.TYPES.SUBMIT:
+          setPagePoint('submit');
+          break;
+        case _models.PageAction.TYPES.SAVE_AND_NAVIGATE:
+          var state = _objectSpread({}, currentTask);
+          pageUpdate = function pageUpdate() {
+            return _handlers.default.navigate(action, pageId, onPageChange, state);
+          };
+          break;
+        case _models.PageAction.TYPES.COLLECTION_ADD:
+          form.page.formData["".concat(action.collection, "ActiveId")] = Date.now().toString();
+          pageUpdate = function pageUpdate() {
+            return _handlers.default.navigate(action, pageId, onPageChange);
+          };
+          break;
+        case _models.PageAction.TYPES.COLLECTION_DUPLICATE:
+          if (_utils.default.CollectionPage.duplicateActiveEntry(action.collection, formState.page.formData)) {
+            pageUpdate = function pageUpdate() {
+              return _handlers.default.navigate(action, pageId, onPageChange);
+            };
+          }
+          ;
+          break;
+        case _models.PageAction.TYPES.COLLECTION_REMOVE:
+          var activeId = form.page.formData["".concat(action.collection, "ActiveId")];
+          form.page.formData["".concat(action.collection)] = form.page.formData["".concat(action.collection)].map(function (entry) {
+            if (entry.id === activeId) {
+              // Store the entry.
+              if (action.recordRemoval) {
+                form.page.formData["".concat(action.collection, "LastRemoved")] = _objectSpread({}, entry);
+              }
+              return null;
+            }
+            ;
+            return entry;
+          }).filter(function (e) {
+            return !!e;
+          });
+          break;
+        default:
+          break;
+      }
+      ;
+      /* eslint-enable no-case-declarations */
+
+      // Save draft or submit.
+      var submissionData = _utils.default.Format.form({
+        pages: pages,
+        components: components
+      }, _objectSpread(_objectSpread(_objectSpread({}, data), patch), formState.page.formData), _models.EventTypes.SUBMIT);
+      submissionData.formStatus = _helpers.default.getSubmissionStatus(type, pages, pageId, action, submissionData, currentTask, true, hubDetails === null || hubDetails === void 0 ? void 0 : hubDetails.sections);
+      if (_patch) {
+        setData(submissionData);
+      }
+      ;
+
+      // In case of hub-and-spoke if patchLabel has changed then 
+      // save name and value to variables for call to onSubmit hook
+      var changedFieldName;
+      var changedFieldValue;
+      if (type === _models.FormTypes.HUB && Object.keys(patchLabel).length > 0) {
+        /* eslint-disable prefer-destructuring */
+        changedFieldName = Object.keys(patchLabel)[0];
+        changedFieldValue = Object.values(patchLabel)[0];
+        /* eslint-enable prefer-destructuring */
+      }
+      ;
+
+      // Now submit the data to the backend...
+      hooks.onSubmit(action.type, submissionData, function (response) {
+        // The backend response may well contain data we need so apply it...
+        // ... but this needs to happen in a useEffect, not right away.
+        var sData = _objectSpread(_objectSpread({}, submissionData), response);
+        setSubmitted({
+          data: sData
+        });
+        pageUpdate(sData);
+      }, function (errors) {
+        _handlers.default.submissionError(errors, addErrors);
+        setData(_objectSpread({}, preSubmitData));
+      }, changedFieldName, changedFieldValue, pageId);
+    }
+    ;
+  }
+  ;
+};
+var _default = onPageAction;
+exports.default = _default;