@ukhomeoffice/cop-react-form-renderer 4.69.0 → 4.69.2

package/dist/components/FormRenderer/FormRenderer.js

@@ -20,6 +20,7 @@ var _handlers = _interopRequireDefault(require("./handlers"));
 var _helpers = _interopRequireDefault(require("./helpers"));
 var _onCYAAction = _interopRequireDefault(require("./onCYAAction"));
 var _onPageAction = _interopRequireDefault(require("./onPageAction"));
+var _onTaskAction2 = _interopRequireDefault(require("./onTaskAction"));
 require("./FormRenderer.scss");
 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; }
@@ -292,7 +293,7 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
       hubDetails.sections.every(function (section) {
         return section.tasks.every(function (task) {
           if (task.pages.includes(page.pageId) && task.name !== currentTask.name) {
-            onTaskAction(task);
+            (0, _onTaskAction2.default)(task, pages, setCurrentTask, hubDetails, data, onPageChange, _models.FormPages);
             return false;
           }
           return true;
@@ -303,37 +304,6 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
       _handlers.default.cyaAction(page, pageId, onPageChange);
     }
   };
-
-  //Kick off a task, gather required pages and move to the correct point
-  var onTaskAction = function onTaskAction(currentTask) {
-    if (currentTask) {
-      currentTask.fullPages = [];
-      currentTask.pages.forEach(function (page) {
-        currentTask.fullPages.push(_helpers.default.getPage(page, pages));
-      });
-      setCurrentTask(currentTask);
-      var state = _objectSpread({}, currentTask);
-      if (currentTask.state === _models.TaskStates.TYPES.COMPLETE) {
-        if (hubDetails !== null && hubDetails !== void 0 && hubDetails.noTaskCYAs) {
-          // If the task is complete and there are no CYA's then show user first page
-          var currentPage = data.formStatus.tasks[currentTask.name].currentPage;
-          onPageChange(currentTask.pages[0] || currentPage);
-        } else if (currentTask.customCYA) {
-          onPageChange(currentTask.customCYA);
-        } else {
-          onPageChange(_models.FormPages.CYA, state);
-        }
-      } else if (currentTask.state === _models.TaskStates.TYPES.IN_PROGRESS) {
-        var _currentPage = data.formStatus.tasks[currentTask.name].currentPage;
-        onPageChange(_currentPage || currentTask.pages[0], state);
-      } else if (currentTask.firstPage) {
-        var _currentPage2 = currentTask.firstPage;
-        onPageChange(_currentPage2 || currentTask.pages[0], state);
-      } else {
-        onPageChange(currentTask.pages[0], state);
-      }
-    }
-  };
   var classes = _utils.default.classBuilder(classBlock, classModifiers, className);
   if (hub === _models.HubFormats.TASK) {
     cya.actions = [_models.PageAction.TYPES.SAVE_AND_CONTINUE, _models.PageAction.TYPES.SAVE_AND_RETURN];
@@ -359,7 +329,9 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
     type: type
   })), hub === _models.HubFormats.TASK && formState.pageId === _models.FormPages.HUB && /*#__PURE__*/_react.default.createElement(_TaskList.default, _extends({}, hubDetails, {
     refNumber: data.businessKey,
-    onTaskAction: onTaskAction,
+    onTaskAction: function onTaskAction(task) {
+      (0, _onTaskAction2.default)(task, pages, setCurrentTask, hubDetails, data, onPageChange, _models.FormPages);
+    },
     formData: data
   })), formState.page && !formState.cya && !formState.page.collection && /*#__PURE__*/_react.default.createElement(_FormPage.default, {
     page: formState.page,

package/dist/components/FormRenderer/onTaskAction.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _models = require("../../models");
+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); }
+var onTaskAction = function onTaskAction(currentTask, pages, setCurrentTask, hubDetails, data, onPageChange, FormPages) {
+  if (currentTask) {
+    currentTask.fullPages = [];
+    currentTask.pages.forEach(function (page) {
+      currentTask.fullPages.push(_helpers.default.getPage(page, pages));
+    });
+    setCurrentTask(currentTask);
+    var state = _objectSpread({}, currentTask);
+    if (currentTask.state === _models.TaskStates.TYPES.COMPLETE) {
+      if (hubDetails !== null && hubDetails !== void 0 && hubDetails.noTaskCYAs) {
+        // If the task is complete and there are no CYA's then show user first page
+        var currentPage = data.formStatus.tasks[currentTask.name].currentPage;
+        onPageChange(currentTask.pages[0] || currentPage);
+      } else if (currentTask.customCYA) {
+        onPageChange(currentTask.customCYA);
+      } else {
+        onPageChange(FormPages.CYA, state);
+      }
+    } else if (currentTask.state === _models.TaskStates.TYPES.IN_PROGRESS) {
+      var _currentPage = data.formStatus.tasks[currentTask.name].currentPage;
+      onPageChange(_currentPage || currentTask.pages[0], state);
+    } else if (currentTask.firstPage) {
+      onPageChange(currentTask.firstPage, state);
+    } else {
+      onPageChange(currentTask.pages[0], state);
+    }
+  }
+};
+var _default = onTaskAction;
+exports.default = _default;

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

@@ -0,0 +1,220 @@
+"use strict";
+
+var _models = require("../../models");
+var _helpers = _interopRequireDefault(require("./helpers"));
+var _onTaskAction = _interopRequireDefault(require("./onTaskAction"));
+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); }
+jest.mock('./helpers', function () {
+  return {
+    getPageArgs: [],
+    getPage: function getPage(page, pages) {
+      this.getPageArgs.push({
+        page: page,
+        pages: pages
+      });
+    },
+    reset: function reset() {
+      this.getPageArgs = [];
+    }
+  };
+});
+describe('components.FormRenderer.onTaskAction', function () {
+  var setCurrentTaskArgs = [];
+  var mockSetCurrentTask = function mockSetCurrentTask(task) {
+    setCurrentTaskArgs.push(task);
+  };
+  var onPageChangeArgs = [];
+  var mockOnPageChange = function mockOnPageChange(page, state) {
+    onPageChangeArgs.push({
+      page: page,
+      state: state
+    });
+  };
+  var PAGES = [{
+    id: 'page1'
+  }, {
+    id: 'page2'
+  }, {
+    id: 'page3'
+  }, {
+    id: 'customCya'
+  }];
+  var DATA = {
+    formStatus: {
+      tasks: {
+        task1: {
+          currentPage: 'page1'
+        },
+        task2: {
+          currentPage: 'page2'
+        },
+        taskNoCurrentPage: {}
+      }
+    }
+  };
+  var ARGS = {
+    currentTask: null,
+    pages: PAGES,
+    setCurrentTask: mockSetCurrentTask,
+    hubDetails: {},
+    data: DATA,
+    onPageChange: mockOnPageChange,
+    FormPages: {
+      CYA: 'cyaPage'
+    }
+  };
+  var genericChecks = function genericChecks(currentTask) {
+    expect(_helpers.default.getPageArgs.length).toEqual(currentTask.pages.length);
+    expect(currentTask.fullPages.length).toEqual(currentTask.pages.length);
+    expect(setCurrentTaskArgs.length).toEqual(1);
+    expect(setCurrentTaskArgs[0]).toEqual(currentTask);
+  };
+  beforeEach(function () {
+    setCurrentTaskArgs = [];
+    onPageChangeArgs = [];
+    _helpers.default.reset();
+  });
+  it('should do nothing if currentTask is null', function () {
+    _onTaskAction.default.apply(void 0, Object.values(ARGS));
+    expect(_helpers.default.getPageArgs.length).toEqual(0);
+    expect(setCurrentTaskArgs.length).toEqual(0);
+    expect(onPageChangeArgs.length).toEqual(0);
+  });
+  describe("when currentTask has a state of ".concat(_models.TaskStates.TYPES.COMPLETE), function () {
+    var TASK = {
+      name: 'task1',
+      state: _models.TaskStates.TYPES.COMPLETE,
+      pages: ['page1', 'page2', 'page3']
+    };
+    it('should handle task CYAs not being shown', function () {
+      var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        currentTask: TASK,
+        hubDetails: {
+          noTaskCYAs: true
+        }
+      });
+      _onTaskAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      genericChecks(CUSTOM_ARGS.currentTask);
+      expect(onPageChangeArgs.length).toEqual(1);
+      expect(onPageChangeArgs[0].page).toEqual(CUSTOM_ARGS.currentTask.pages[0]);
+    });
+    it('should handle task CYAs not being shown and no pages being provided on currentTask', function () {
+      var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        currentTask: _objectSpread(_objectSpread({}, TASK), {}, {
+          pages: []
+        }),
+        hubDetails: {
+          noTaskCYAs: true
+        }
+      });
+      _onTaskAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      genericChecks(CUSTOM_ARGS.currentTask);
+      expect(onPageChangeArgs.length).toEqual(1);
+      expect(onPageChangeArgs[0].page).toEqual(CUSTOM_ARGS.data.formStatus.tasks[CUSTOM_ARGS.currentTask.name].currentPage);
+    });
+    it('should handle a custom CYA being provided', function () {
+      var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        currentTask: _objectSpread(_objectSpread({}, TASK), {}, {
+          customCYA: 'customCya'
+        })
+      });
+      _onTaskAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      genericChecks(CUSTOM_ARGS.currentTask);
+      expect(onPageChangeArgs.length).toEqual(1);
+      expect(onPageChangeArgs[0].page).toEqual(CUSTOM_ARGS.currentTask.customCYA);
+    });
+    it('should handle navigation to a normal CYA page', function () {
+      var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        currentTask: TASK
+      });
+      _onTaskAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      genericChecks(CUSTOM_ARGS.currentTask);
+      expect(onPageChangeArgs.length).toEqual(1);
+      expect(onPageChangeArgs[0].page).toEqual(CUSTOM_ARGS.FormPages.CYA);
+      expect(onPageChangeArgs[0].state).toEqual(CUSTOM_ARGS.currentTask);
+    });
+  });
+  describe("when currentTask has a state of ".concat(_models.TaskStates.TYPES.IN_PROGRESS), function () {
+    it('should handle page change when formStatus has a current page for the task', function () {
+      var TASK = {
+        name: 'task1',
+        state: _models.TaskStates.TYPES.IN_PROGRESS,
+        pages: ['page1', 'page2', 'page3']
+      };
+      var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        currentTask: TASK
+      });
+      _onTaskAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      genericChecks(CUSTOM_ARGS.currentTask);
+      expect(onPageChangeArgs.length).toEqual(1);
+      expect(onPageChangeArgs[0].page).toEqual(CUSTOM_ARGS.data.formStatus.tasks[CUSTOM_ARGS.currentTask.name].currentPage);
+      expect(onPageChangeArgs[0].state).toEqual(CUSTOM_ARGS.currentTask);
+    });
+    it('should handle page change when formStatus does not have a current page for the task', function () {
+      var TASK = {
+        name: 'taskNoCurrentPage',
+        state: _models.TaskStates.TYPES.IN_PROGRESS,
+        pages: ['page1', 'page2', 'page3']
+      };
+      var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        currentTask: TASK
+      });
+      _onTaskAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      genericChecks(CUSTOM_ARGS.currentTask);
+      expect(onPageChangeArgs.length).toEqual(1);
+      expect(onPageChangeArgs[0].page).toEqual(CUSTOM_ARGS.currentTask.pages[0]);
+      expect(onPageChangeArgs[0].state).toEqual(CUSTOM_ARGS.currentTask);
+    });
+  });
+  var otherStates = Object.values(_models.TaskStates.TYPES).filter(function (t) {
+    return t !== _models.TaskStates.TYPES.IN_PROGRESS && t !== _models.TaskStates.TYPES.COMPLETE;
+  });
+  otherStates.forEach(function (state) {
+    describe("when currentTask has a state of ".concat(state), function () {
+      var TASK = {
+        name: 'task1',
+        state: state,
+        pages: ['page1', 'page2', 'page3']
+      };
+      it('should handle the task having a specific first page defined', function () {
+        var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+          currentTask: _objectSpread(_objectSpread({}, TASK), {}, {
+            firstPage: 'page2'
+          })
+        });
+        _onTaskAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+        genericChecks(CUSTOM_ARGS.currentTask);
+        expect(onPageChangeArgs.length).toEqual(1);
+        expect(onPageChangeArgs[0].page).toEqual(CUSTOM_ARGS.currentTask.firstPage);
+        expect(onPageChangeArgs[0].state).toEqual(CUSTOM_ARGS.currentTask);
+      });
+      it('should handle the task having the first page defined as null', function () {
+        var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+          currentTask: _objectSpread(_objectSpread({}, TASK), {}, {
+            firstPage: null
+          })
+        });
+        _onTaskAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+        genericChecks(CUSTOM_ARGS.currentTask);
+        expect(onPageChangeArgs.length).toEqual(1);
+        expect(onPageChangeArgs[0].page).toEqual(CUSTOM_ARGS.currentTask.pages[0]);
+        expect(onPageChangeArgs[0].state).toEqual(CUSTOM_ARGS.currentTask);
+      });
+      it('should handle the task not having a specific first page defined', function () {
+        var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+          currentTask: TASK
+        });
+        _onTaskAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+        genericChecks(CUSTOM_ARGS.currentTask);
+        expect(onPageChangeArgs.length).toEqual(1);
+        expect(onPageChangeArgs[0].page).toEqual(CUSTOM_ARGS.currentTask.pages[0]);
+      });
+    });
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "4.69.0",
+  "version": "4.69.2",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,7 +16,7 @@
     "post-compile": "rimraf dist/*.test.* dist/**/*.test.* dist/**/*.stories.* dist/docs dist/assets"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "^2.14.1",
+    "@ukhomeoffice/cop-react-components": "^2.14.3",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^4.3.1",