@ukhomeoffice/cop-react-form-renderer 4.9.1 → 4.11.0

package/dist/components/TaskList/Task.js

@@ -58,6 +58,7 @@ var Task = function Task(_ref) {
     setLinkActive(task.state !== _models.TaskStates.TYPES.CANNOT_START_YET);
     setCurrentState(task.state);
   }, [task.state, setLinkActive, setCurrentState]);
+  var displayName = task.displayName || task.name;
   return /*#__PURE__*/_react.default.createElement("li", {
     className: classes('item')
   }, /*#__PURE__*/_react.default.createElement("span", {
@@ -72,7 +73,7 @@ var Task = function Task(_ref) {
       }
     },
     tabIndex: "0"
-  }, task.name) : task.name), /*#__PURE__*/_react.default.createElement(_TaskState.default, {
+  }, displayName) : displayName), /*#__PURE__*/_react.default.createElement(_TaskState.default, {
     state: currentState
   }));
 };
@@ -81,7 +82,8 @@ Task.propTypes = {
   task: _propTypes.default.shape({
     name: _propTypes.default.string.isRequired,
     pages: _propTypes.default.array.isRequired,
-    state: _propTypes.default.string
+    state: _propTypes.default.string,
+    displayName: _propTypes.default.string
   }).isRequired,
   onClick: _propTypes.default.func.isRequired
 };

package/dist/components/TaskList/Task.test.js

@@ -35,13 +35,14 @@ describe('components', function () {
       var span = container.childNodes[0].childNodes[0];
       var state = container.childNodes[0].childNodes[1];
       expect(span.classList).toContain('hods-task-list__task-name');
+      expect(span.textContent).toEqual(TASK.name);
       expect(state.textContent).toEqual('Completed');
     });
-    it('should render a task with inactive link if state is cannotStartYet', function () {
-      var NAME = 'taskName';
-      var STATE = _models.TaskStates.TYPES.CANNOT_START_YET;
+    it('should render a task with a displayName', function () {
+      var STATE = _models.TaskStates.TYPES.COMPLETE;
       var TASK = {
         name: 'taskName',
+        displayName: 'Alpha Bravo',
         pages: ['pageName'],
         state: STATE
       };
@@ -54,9 +55,33 @@ describe('components', function () {
       })),
           container = _render2.container;
 
+      expect(container.childNodes.length).toEqual(1);
+      expect(container.childNodes[0].classList).toContain('hods-task-list__item');
+      var span = container.childNodes[0].childNodes[0];
+      var state = container.childNodes[0].childNodes[1];
+      expect(span.classList).toContain('hods-task-list__task-name');
+      expect(span.textContent).toEqual(TASK.displayName);
+      expect(state.textContent).toEqual('Completed');
+    });
+    it('should render a task with inactive link if state is cannotStartYet', function () {
+      var STATE = _models.TaskStates.TYPES.CANNOT_START_YET;
+      var TASK = {
+        name: 'taskName',
+        pages: ['pageName'],
+        state: STATE
+      };
+
+      var ON_CLICK = function ON_CLICK() {};
+
+      var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
+        task: TASK,
+        onClick: ON_CLICK
+      })),
+          container = _render3.container;
+
       var span = container.childNodes[0].childNodes[0];
       expect(span.childNodes[0].tagName).toEqual(undefined);
-      expect(span.textContent).toEqual(NAME);
+      expect(span.textContent).toEqual(TASK.name);
     });
     it('should render a task with a link if state is not cannotStartYet', function () {
       var STATE = _models.TaskStates.TYPES.IN_PROGRESS;
@@ -68,17 +93,40 @@ describe('components', function () {
 
       var ON_CLICK = function ON_CLICK() {};
 
-      var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
+      var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
         task: TASK,
         onClick: ON_CLICK
       })),
-          container = _render3.container;
+          container = _render4.container;
 
       var span = container.childNodes[0].childNodes[0];
       expect(span.childNodes.length).toEqual(1);
       expect(span.childNodes[0].tagName).toEqual('A');
+      expect(span.textContent).toEqual(TASK.name);
     });
-    it('should call then given onClick function when the link is clicked', function () {
+    it('should render the displayName of a task with a link if state is not cannotStartYet', function () {
+      var STATE = _models.TaskStates.TYPES.IN_PROGRESS;
+      var TASK = {
+        name: 'taskName',
+        displayName: 'Charlie Delta',
+        pages: ['pageName'],
+        state: STATE
+      };
+
+      var ON_CLICK = function ON_CLICK() {};
+
+      var _render5 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
+        task: TASK,
+        onClick: ON_CLICK
+      })),
+          container = _render5.container;
+
+      var span = container.childNodes[0].childNodes[0];
+      expect(span.childNodes.length).toEqual(1);
+      expect(span.childNodes[0].tagName).toEqual('A');
+      expect(span.textContent).toEqual(TASK.displayName);
+    });
+    it('should call the given onClick function when the link is clicked', function () {
       var STATE = _models.TaskStates.TYPES.IN_PROGRESS;
       var TASK = {
         name: 'taskName',
@@ -91,16 +139,50 @@ describe('components', function () {
         ON_CLICK_CALLS.push(value);
       };
 
-      var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
+      var _render6 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
         task: TASK,
         onClick: ON_CLICK
       })),
-          container = _render4.container;
+          container = _render6.container;
 
       var link = container.childNodes[0].childNodes[0].childNodes[0];
 
       _react.fireEvent.click(link);
 
+      expect(ON_CLICK_CALLS.length).toEqual(1);
+      expect(ON_CLICK_CALLS[0]).toEqual({
+        pages: ['pageName'],
+        name: "taskName",
+        state: STATE
+      });
+    });
+    it('should call the given onClick function when the enter key is pressed on the link', function () {
+      var STATE = _models.TaskStates.TYPES.IN_PROGRESS;
+      var TASK = {
+        name: 'taskName',
+        pages: ['pageName'],
+        state: STATE
+      };
+      var ON_CLICK_CALLS = [];
+
+      var ON_CLICK = function ON_CLICK(value) {
+        ON_CLICK_CALLS.push(value);
+      };
+
+      var _render7 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
+        task: TASK,
+        onClick: ON_CLICK
+      })),
+          container = _render7.container;
+
+      var link = container.childNodes[0].childNodes[0].childNodes[0]; // The keyPress event needs charCode: 13 or it fails; bug with the library.
+
+      _react.fireEvent.keyPress(link, {
+        key: 'Enter',
+        code: 13,
+        charCode: 13
+      });
+
       expect(ON_CLICK_CALLS.length).toEqual(1);
       expect(ON_CLICK_CALLS[0]).toEqual({
         pages: ['pageName'],

package/dist/components/TaskList/TaskList.js

@@ -104,7 +104,8 @@ TaskList.propTypes = {
     tasks: _propTypes.default.arrayOf(_propTypes.default.shape({
       name: _propTypes.default.string.isRequired,
       pages: _propTypes.default.array.isRequired,
-      state: _propTypes.default.string
+      state: _propTypes.default.string,
+      displayName: _propTypes.default.string
     })).isRequired
   })).isRequired,
   classBlock: _propTypes.default.string,

package/dist/utils/CheckYourAnswers/getCYARowsForCollection.js

@@ -9,6 +9,8 @@ var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 
 var _models = require("../../models");
 
+var _getCYAAction = _interopRequireDefault(require("./getCYAAction"));
+
 var _getCYARowsForContainer = _interopRequireDefault(require("./getCYARowsForContainer"));
 
 var _showComponentCYA = _interopRequireDefault(require("./showComponentCYA"));
@@ -28,12 +30,7 @@ var getEntryToCollectionRow = function getEntryToCollectionRow(page, onAction) {
     pageId: page.id,
     key: ((_page$components$0$la = page.components[0].labels) === null || _page$components$0$la === void 0 ? void 0 : _page$components$0$la.empty) || 'Nothing entered',
     required: page.required,
-    action: {
-      page: page.id,
-      label: "Change",
-      aria_suffix: page.cya_link.aria_suffix,
-      onAction: onAction
-    }
+    action: (0, _getCYAAction.default)(false, page, onAction)
   }];
 };
 

package/dist/utils/Operate/getIndexOfMatchingValueIn.js

@@ -54,9 +54,19 @@ var getIndexOfMatchingValueIn = function getIndexOfMatchingValueIn(config, data)
 
       if (index === ignore) {
         return true;
-      }
+      } // Here we're simply checking if value matches the entry itself. This
+      // will be enough of a check for arrays of simple values.
+
+
+      if (entry === value) {
+        result = index;
+        return false;
+      } // If the last check failed and there is a config.key defined, then
+      // we're most likely checking an array of objects and should use the
+      // key to index in and find a matching value.
+
 
-      if (entry === value || config.key && entry[config.key] === value) {
+      if (config.key && (0, _getSourceData.default)(entry, config.key) === value) {
         result = index;
         return false;
       }

package/dist/utils/Operate/getIndexOfMatchingValueIn.test.js

@@ -6,7 +6,11 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 describe('Utils.Operate.getIndexOfPriorMatchingValueIn', function () {
   var DATA = {
-    arrayOfValues: ['abc', 'bcd', 'cde', 'def'],
+    arrayOfValues: ['abc', 'bcd', 'cde', 'def', {
+      root: {
+        branch: 'leaf'
+      }
+    }],
     cutoffIndex: 1,
     ignoreIndex: 2,
     valueToSearchFor: 'cde',
@@ -40,6 +44,16 @@ describe('Utils.Operate.getIndexOfPriorMatchingValueIn', function () {
     var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual('2');
   });
+  it('Should handle interpolated string for key', function () {
+    // eslint-disable-next-line no-template-curly-in-string
+    var CONFIG = {
+      target: 'arrayOfValues',
+      key: 'root.branch',
+      value: 'leaf'
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual('4');
+  });
   it('Should handle a cutoff value being specified', function () {
     var CONFIG = {
       target: 'arrayOfValues',

package/package.json

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