@ukhomeoffice/cop-react-form-renderer 4.76.0 → 4.77.0

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 _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 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); }
@@ -278,38 +279,6 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
     hooks.onChange(data);
   };
 
-  // Kick off a task, gather required pages and move to the correct point
-  var onTaskAction = function onTaskAction(currentTask) {
-    if (currentTask) {
-      var task = currentTask;
-      task.fullPages = [];
-      task.pages.forEach(function (page) {
-        task.fullPages.push(_helpers.default.getPage(page, pages));
-      });
-      setCurrentTask(task);
-      var state = _objectSpread({}, task);
-      if (task.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[task.name].currentPage;
-          onPageChange(task.pages[0] || currentPage);
-        } else if (task.customCYA) {
-          onPageChange(task.customCYA);
-        } else {
-          onPageChange(_models.FormPages.CYA, state);
-        }
-      } else if (task.state === _models.TaskStates.TYPES.IN_PROGRESS) {
-        var _currentPage = data.formStatus.tasks[task.name].currentPage;
-        onPageChange(_currentPage || task.pages[0], state);
-      } else if (task.firstPage) {
-        var _currentPage2 = task.firstPage;
-        onPageChange(_currentPage2 || task.pages[0], state);
-      } else {
-        onPageChange(task.pages[0], state);
-      }
-    }
-  };
-
   // Handle navigation from "Check your answers".
   // Passing a dataCallback allows changes to formData from the
   // CYA screen. This is necessary to allow changing the active
@@ -326,7 +295,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);
             return false;
           }
           return true;
@@ -364,7 +333,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);
+    },
     formData: data
   })), formState.page && !formState.cya && !formState.page.collection && /*#__PURE__*/_react.default.createElement(_FormPage.default, {
     page: formState.page,

package/dist/components/FormRenderer/helpers/getUpdatedSectionStates.js

@@ -4,8 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _utils = _interopRequireDefault(require("../../../utils"));
 var _models = require("../../../models");
+var _utils = _interopRequireDefault(require("../../../utils"));
 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; }
@@ -14,7 +14,6 @@ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key i
 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); }
 /**
- *
  * @param {boolean} complete - true if task complete
  * @param {boolean} currentPage - true if current page
  * @param {TaskStates.TYPES|string} defaultState - default state to set task
@@ -35,14 +34,19 @@ var getCurrentTaskState = function getCurrentTaskState(_ref) {
 
 /**
  * check if dependent tasks have been completed
- * @param tasks - list of tasks
- * @param mustBeComplete - tasks which are depended on
+ * @param {object} taskStates - list of tasks
+ * @param {array} mustBeComplete - tasks which are depended on
+ * @param {boolean} ignoreSkipped - skipped tasks don't need to have been completed
  * @returns {boolean} true if dependent tasks complete
  */
-var allDependentTasksComplete = function allDependentTasksComplete(tasks, mustBeComplete) {
+var allDependentTasksComplete = function allDependentTasksComplete(taskStates, mustBeComplete) {
+  var ignoreSkipped = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
   return mustBeComplete.reduce(function (allComplete, taskName) {
-    var _tasks$taskName;
-    return allComplete && ((_tasks$taskName = tasks[taskName]) === null || _tasks$taskName === void 0 ? void 0 : _tasks$taskName.complete);
+    var task = taskStates[taskName];
+    if (ignoreSkipped && (task === null || task === void 0 ? void 0 : task.state) === _models.TaskStates.TYPES.SKIPPED) {
+      return allComplete;
+    }
+    return allComplete && (task === null || task === void 0 ? void 0 : task.complete);
   }, true);
 };
 var isPreviousTaskComplete = function isPreviousTaskComplete(tasks, taskIndex) {
@@ -61,20 +65,20 @@ var isPreviousTaskComplete = function isPreviousTaskComplete(tasks, taskIndex) {
  * @param {object} task - current task object
  * @param {number} taskIndex - order number of task in list
  * @param {object[]} taskList - list of tasks (associated with section)
- * @param tasks - list of task state
+ * @param {object} taskStates - map of task state
  * @param {boolean} nonSequential - set if tasks can be performed out of order
  * @param {boolean} allowFirst true if first task in list can be accepted
  * @returns {TYPES|string} new state
  */
 
-var updateTaskState = function updateTaskState(task, taskIndex, taskList, tasks) {
+var updateTaskState = function updateTaskState(task, taskIndex, taskList, taskStates) {
   var nonSequential = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : false;
   var allowFirst = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : true;
-  if (tasks[task.name]) {
-    return getCurrentTaskState(tasks[task.name], task.state);
+  if (taskStates[task.name]) {
+    return getCurrentTaskState(taskStates[task.name], task.state);
   }
   if (nonSequential) {
-    if (task.depends_on && !allDependentTasksComplete(tasks, task.depends_on)) {
+    if (task.depends_on && !allDependentTasksComplete(taskStates, task.depends_on, task.ignoreSkipped)) {
       return _models.TaskStates.TYPES.CANNOT_START_YET;
     }
     return _models.TaskStates.TYPES.NOT_STARTED;
@@ -93,27 +97,20 @@ var updateTaskState = function updateTaskState(task, taskIndex, taskList, tasks)
  * update all tasks in section with new state.
  * note use of clone and forEach as some tasks depend on previous update
  * @param {object} section - section to be processed
- * @param tasks - task updates
- * @param nonSequential - true if non-sequential task performance allowed
- * @param allowFirst - true if first task can be started
+ * @param {object} taskStates - task updates
+ * @param {boolean} nonSequential - true if non-sequential task performance allowed
+ * @param {boolean} allowFirst - true if first task can be started
  * @returns {object} - updated section
  */
-var updateTasks = function updateTasks(section, tasks, nonSequential, allowFirst, data) {
+var updateTasks = function updateTasks(section, taskStates, nonSequential, allowFirst) {
   var clone = section.tasks.map(function (a) {
     return _objectSpread({}, a);
   });
-  clone.forEach(function (task, taskIndex, taskList) {
-    var _currentTask$show_whe;
-    var currentTask = task;
-    if (section.skipped) {
-      currentTask.state = _models.TaskStates.TYPES.SKIPPED;
-    } else if (data && !_utils.default.Condition.met(currentTask.show_when, data[(_currentTask$show_whe = currentTask.show_when) === null || _currentTask$show_whe === void 0 ? void 0 : _currentTask$show_whe.field])) {
-      currentTask.state = _models.TaskStates.TYPES.SKIPPED;
-    } else {
-      var _task = task;
-      _task.state = updateTaskState(currentTask, taskIndex, taskList, tasks, nonSequential, allowFirst);
-    }
-    ;
+  clone.filter(function (t) {
+    return t.state !== _models.TaskStates.TYPES.SKIPPED;
+  }).forEach(function (t, index) {
+    var task = t;
+    task.state = updateTaskState(task, index, clone, taskStates, nonSequential, allowFirst);
   });
   return clone;
 };
@@ -142,28 +139,62 @@ var isPreviousSectionComplete = function isPreviousSectionComplete(sections, cur
 /**
  * update task states in sections
  * @param {object[]} sections - array of sections
- * @param {object} tasks - update task states
+ * @param {object} taskStates - update task states
  * @param {boolean} nonSequential - true if tasks can be performed non-sequentially
  * @param {object} data - current form data
  * @returns {object[]} - updated sections - note this is a clone
  */
-var getUpdatedSectionStates = function getUpdatedSectionStates(sections, tasks) {
+var getUpdatedSectionStates = function getUpdatedSectionStates(sections, taskStates) {
   var nonSequential = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
   var data = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
-  var clone = sections.map(function (a) {
-    return _objectSpread({}, a);
-  });
-  clone.forEach(function (section, sectionIndex, sectionList) {
-    var _currentSection$show_;
-    var currentSection = section;
-    var allowFirst = sectionIndex === 0 || isPreviousSectionComplete(sectionList, sectionIndex);
-    // Support a single show_when check on a section. Support for an
-    // array of checks will have to be added if required.
-    if (data && !_utils.default.Condition.met(currentSection.show_when, data[(_currentSection$show_ = currentSection.show_when) === null || _currentSection$show_ === void 0 ? void 0 : _currentSection$show_.field])) {
-      currentSection.skipped = true;
+  // Make a clone and handle any hidden sections.
+  var clone = sections.map(function (section) {
+    var showWhen = section.show_when ? [section.show_when].flat() : [];
+    if (data && !_utils.default.Condition.meetsAll(showWhen, data)) {
+      return _objectSpread(_objectSpread({}, section), {}, {
+        skipped: true,
+        tasks: section.tasks.map(function (task) {
+          return _objectSpread(_objectSpread({}, task), {}, {
+            state: _models.TaskStates.TYPES.SKIPPED
+          });
+        })
+      });
     }
     ;
-    currentSection.tasks = updateTasks(currentSection, tasks, nonSequential, allowFirst, data);
+    return _objectSpread({}, section);
+  });
+
+  // Now iterate through the clone and handle any hidden tasks.
+  clone.forEach(function (s) {
+    var section = s;
+    section.tasks = section.tasks.map(function (task) {
+      var showWhen = task.show_when ? [task.show_when].flat() : [];
+      if (data && !_utils.default.Condition.meetsAll(showWhen, data)) {
+        return _objectSpread(_objectSpread({}, task), {}, {
+          state: _models.TaskStates.TYPES.SKIPPED
+        });
+      }
+      return _objectSpread({}, task);
+    });
+  });
+
+  // Update the taskStates to account for skipped tasks.
+  var states = _objectSpread({}, taskStates);
+  clone.forEach(function (section) {
+    section.tasks.filter(function (t) {
+      return t.state === _models.TaskStates.TYPES.SKIPPED;
+    }).forEach(function (task) {
+      states[task.name] = _objectSpread(_objectSpread({}, states[task.name]), {}, {
+        state: _models.TaskStates.TYPES.SKIPPED
+      });
+    });
+  });
+
+  // Now figure out all the task states.
+  clone.forEach(function (s, index) {
+    var section = s;
+    var allowFirst = index === 0 || isPreviousSectionComplete(clone, index);
+    section.tasks = updateTasks(section, states, nonSequential, allowFirst);
   });
   return clone;
 };

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

@@ -1,10 +1,14 @@
 "use strict";
 
-var _getUpdatedSectionStates = _interopRequireDefault(require("./getUpdatedSectionStates"));
 var _models = require("../../../models");
+var _getUpdatedSectionStates = _interopRequireDefault(require("./getUpdatedSectionStates"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-// Local imports
-
+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); }
 describe('components.FormRenderer.helpers.getUpdatedSectionStates', function () {
   describe('sequential tasks', function () {
     it("should set all tasks to '".concat(_models.TaskStates.TYPES.CANNOT_START_YET, "' excluding the first which should be '").concat(_models.TaskStates.TYPES.NOT_STARTED, "'"), function () {
@@ -369,5 +373,86 @@ describe('components.FormRenderer.helpers.getUpdatedSectionStates', function ()
       expect(RESULT[1].tasks[0].state).toEqual(_models.TaskStates.TYPES.NOT_STARTED); // Charlie
       expect(RESULT[2].tasks[0].state).toEqual(_models.TaskStates.TYPES.NOT_STARTED); // Delta
     });
+
+    it('should not allow dependent state to start if incomplete dependencies are skipped, but skipped are not ignored', function () {
+      var TASKS = {
+        'Alpha': {
+          complete: true
+        },
+        'Bravo': {
+          complete: false,
+          state: _models.TaskStates.TYPES.SKIPPED
+        },
+        'Delta': {}
+      };
+      var RESULT = (0, _getUpdatedSectionStates.default)(SECTIONS, TASKS, NON_SEQUENTIAL);
+      expect(RESULT[1].tasks[0].state).toEqual(_models.TaskStates.TYPES.CANNOT_START_YET); // Charlie
+    });
+
+    it('should allow dependent state to start if incomplete dependencies are skipped, and skipped are ignored', function () {
+      var SKIPPABLE_SECTIONS = [SECTIONS[0], _objectSpread(_objectSpread({}, SECTIONS[1]), {}, {
+        tasks: [_objectSpread(_objectSpread({}, SECTIONS[1].tasks[0]), {}, {
+          ignoreSkipped: true
+        })]
+      }), SECTIONS[2]];
+      var TASKS = {
+        'Alpha': {
+          complete: true
+        },
+        'Bravo': {
+          complete: false,
+          state: _models.TaskStates.TYPES.SKIPPED
+        },
+        'Delta': {}
+      };
+      var RESULT = (0, _getUpdatedSectionStates.default)(SKIPPABLE_SECTIONS, TASKS, NON_SEQUENTIAL);
+      expect(RESULT[1].tasks[0].state).toEqual(_models.TaskStates.TYPES.NOT_STARTED); // Charlie
+    });
+
+    it('should automatically skip tasks that are not shown', function () {
+      var SHOW_WHEN_SECTIONS = [{
+        name: 'First',
+        tasks: [{
+          name: 'Alpha'
+        }]
+      }, {
+        name: 'Second',
+        tasks: [{
+          name: 'Bravo',
+          show_when: [{
+            field: 'echo',
+            op: '=',
+            value: 'foxtrot'
+          }, {
+            field: 'golf',
+            op: '=',
+            value: 'indigo'
+          } // shouldn't be shown
+          ]
+        }]
+      }, {
+        name: 'Third',
+        tasks: [{
+          name: 'Charlie',
+          depends_on: ['Alpha', 'Bravo'],
+          ignoreSkipped: true
+        }]
+      }];
+      var TASKS = {
+        'Alpha': {
+          complete: true
+        },
+        'Bravo': {
+          complete: false
+        },
+        'Delta': {}
+      };
+      var DATA = {
+        echo: 'foxtrot',
+        golf: 'hotel'
+      };
+      var RESULT = (0, _getUpdatedSectionStates.default)(SHOW_WHEN_SECTIONS, TASKS, NON_SEQUENTIAL, DATA);
+      expect(RESULT[2].tasks[0].state).toEqual(_models.TaskStates.TYPES.NOT_STARTED); // Charlie
+    });
   });
 });

package/dist/components/FormRenderer/onTaskAction.js

@@ -13,7 +13,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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) {
+var onTaskAction = function onTaskAction(currentTask, pages, setCurrentTask, hubDetails, data, onPageChange) {
   if (currentTask) {
     var task = currentTask;
     task.fullPages = [];
@@ -31,7 +31,7 @@ var onTaskAction = function onTaskAction(currentTask, pages, setCurrentTask, hub
       } else if (task.customCYA) {
         onPageChange(task.customCYA);
       } else {
-        onPageChange(FormPages.CYA, state);
+        onPageChange(_models.FormPages.CYA, state);
       }
     } else if (task.state === _models.TaskStates.TYPES.IN_PROGRESS) {
       var _currentPage = data.formStatus.tasks[currentTask.name].currentPage;

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

@@ -64,10 +64,7 @@ describe('components.FormRenderer.onTaskAction', function () {
     setCurrentTask: mockSetCurrentTask,
     hubDetails: {},
     data: DATA,
-    onPageChange: mockOnPageChange,
-    FormPages: {
-      CYA: 'cyaPage'
-    }
+    onPageChange: mockOnPageChange
   };
   var genericChecks = function genericChecks(currentTask) {
     expect(_helpers.default.getPageArgs.length).toEqual(currentTask.pages.length);
@@ -136,7 +133,7 @@ describe('components.FormRenderer.onTaskAction', function () {
       _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].page).toEqual(_models.FormPages.CYA);
       expect(onPageChangeArgs[0].state).toEqual(CUSTOM_ARGS.currentTask);
     });
   });

package/package.json

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