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

package/dist/components/TaskList/TaskList.js

@@ -11,12 +11,19 @@ var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 var _dist = require("@ukhomeoffice/cop-react-components/dist");
 var _models = require("../../models");
 var _Task = _interopRequireDefault(require("./Task"));
+var _showComponent = _interopRequireDefault(require("../../utils/Component/showComponent"));
 require("./TaskList.scss");
-var _excluded = ["refTitle", "refNumber", "incompleteTitle", "sections", "fieldId", "onTaskAction", "classBlock", "classModifiers", "className"];
+var _excluded = ["id", "refTitle", "refNumber", "notes", "incompleteTitle", "sections", "fieldId", "onTaskAction", "classBlock", "classModifiers", "className", "formData"];
 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; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+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; }
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 var DEFAULT_CLASS = 'hods-task-list';
@@ -24,8 +31,10 @@ exports.DEFAULT_CLASS = DEFAULT_CLASS;
 var DEFAULT_INCOMPLETE_TITLE = 'Incomplete form';
 exports.DEFAULT_INCOMPLETE_TITLE = DEFAULT_INCOMPLETE_TITLE;
 var TaskList = function TaskList(_ref) {
-  var refTitle = _ref.refTitle,
+  var id = _ref.id,
+    refTitle = _ref.refTitle,
     refNumber = _ref.refNumber,
+    notes = _ref.notes,
     incompleteTitle = _ref.incompleteTitle,
     sections = _ref.sections,
     fieldId = _ref.fieldId,
@@ -33,24 +42,36 @@ var TaskList = function TaskList(_ref) {
     classBlock = _ref.classBlock,
     classModifiers = _ref.classModifiers,
     className = _ref.className,
+    formData = _ref.formData,
     attrs = _objectWithoutProperties(_ref, _excluded);
   var classes = _copReactComponents.Utils.classBuilder(classBlock, classModifiers, className);
 
-  //TODO state will be retrieved from a document in S3 rather than given in the component definition, covered under COP-9885
-  var numberOfCompleteSections = sections.reduce(function (totalComplete, currentSection) {
-    return totalComplete + currentSection.tasks.filter(function (t) {
-      return t.state === _models.TaskStates.TYPES.COMPLETE;
-    }).length;
-  }, 0);
-  var numberOfSections = sections.reduce(function (totalSections, current) {
-    return totalSections + current.tasks.length;
-  }, 0);
+  // TODO state will be retrieved from a document in S3 rather than given in the component definition, covered under COP-9885
+  var _sections$filter$redu = sections.filter(function (section) {
+      return !section.skipped;
+    }).reduce(function (acc, current) {
+      var _current$tasks$filter, _current$tasks, _current$tasks$filter2, _current$tasks2;
+      return [acc[0] + ((_current$tasks$filter = (_current$tasks = current.tasks) === null || _current$tasks === void 0 ? void 0 : _current$tasks.filter(function (t) {
+        return t.state === _models.TaskStates.TYPES.COMPLETE;
+      }).length) !== null && _current$tasks$filter !== void 0 ? _current$tasks$filter : 0), acc[1] + ((_current$tasks$filter2 = (_current$tasks2 = current.tasks) === null || _current$tasks2 === void 0 ? void 0 : _current$tasks2.filter(function (task) {
+        return task.state !== _models.TaskStates.TYPES.SKIPPED;
+      }).length) !== null && _current$tasks$filter2 !== void 0 ? _current$tasks$filter2 : 0)];
+    }, [0, 0]),
+    _sections$filter$redu2 = _slicedToArray(_sections$filter$redu, 2),
+    completeSections = _sections$filter$redu2[0],
+    totalSections = _sections$filter$redu2[1];
+  var notesId = "".concat(id, "Notes");
+  var _ref2 = notes && notes || {},
+    notesTitle = _ref2.title,
+    notesText = _ref2.text;
   var onClick = function onClick(task) {
     if (typeof onTaskAction === 'function') {
       onTaskAction(task);
     }
   };
-  return /*#__PURE__*/_react.default.createElement("div", _extends({}, attrs, {
+  return /*#__PURE__*/_react.default.createElement("div", _extends({
+    id: id
+  }, attrs, {
     className: classes()
   }), refNumber && refTitle && /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("p", {
     className: "govuk-body govuk-!-margin-bottom-0"
@@ -58,20 +79,33 @@ var TaskList = function TaskList(_ref) {
     className: "tasklist-summary"
   }, "".concat(refTitle))), /*#__PURE__*/_react.default.createElement("p", {
     className: "govuk-body govuk-!-font-weight-regular"
-  }, "".concat(refNumber))), numberOfSections !== numberOfCompleteSections && /*#__PURE__*/_react.default.createElement("p", {
+  }, "".concat(refNumber))), totalSections !== completeSections && /*#__PURE__*/_react.default.createElement("p", {
     className: "govuk-body govuk-!-margin-bottom-0"
   }, /*#__PURE__*/_react.default.createElement("strong", {
     className: "tasklist-summary"
   }, incompleteTitle)), /*#__PURE__*/_react.default.createElement("p", {
     className: "govuk-body govuk-!-margin-bottom-7"
-  }, "You have completed ".concat(numberOfCompleteSections, " of ").concat(numberOfSections, " sections")), sections.map(function (section, index) {
+  }, "You have completed ".concat(completeSections, " of ").concat(totalSections, " sections")), notesTitle && notesText && (0, _showComponent.default)(notes, formData) && /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("p", {
+    className: "govuk-body govuk-!-margin-bottom-0"
+  }, /*#__PURE__*/_react.default.createElement("strong", {
+    className: "tasklist-summary"
+  }, _copReactComponents.Utils.interpolateString(notesTitle, formData))), /*#__PURE__*/_react.default.createElement(_copReactComponents.TextArea, {
+    id: notesId,
+    fieldId: notesId,
+    readOnly: true,
+    value: _copReactComponents.Utils.interpolateString(notesText, formData)
+  })), sections.filter(function (section) {
+    return !section.skipped;
+  }).map(function (section, index) {
     return /*#__PURE__*/_react.default.createElement(_react.Fragment, {
       key: "".concat(section.name)
     }, /*#__PURE__*/_react.default.createElement("h2", {
       className: classes('section')
     }, sections.length > 1 ? "".concat(index + 1, ". ") : '', section.name), /*#__PURE__*/_react.default.createElement("ol", {
       className: classes('items')
-    }, /*#__PURE__*/_react.default.createElement(_dist.Hint, null, section.label ? section.label : ''), section.tasks.map(function (task) {
+    }, /*#__PURE__*/_react.default.createElement(_dist.Hint, null, section.label ? section.label : ''), section.tasks.filter(function (task) {
+      return task.state !== _models.TaskStates.TYPES.SKIPPED;
+    }).map(function (task) {
       return /*#__PURE__*/_react.default.createElement(_Task.default, {
         key: "".concat(section.name, "-").concat(task.name),
         task: task,
@@ -81,26 +115,43 @@ var TaskList = function TaskList(_ref) {
   }));
 };
 TaskList.propTypes = {
+  classBlock: _propTypes.default.string,
+  classModifiers: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]),
+  className: _propTypes.default.string,
+  fieldId: _propTypes.default.string,
+  formData: _propTypes.default.shape({}),
+  id: _propTypes.default.string,
+  incompleteTitle: _propTypes.default.string,
+  notes: _propTypes.default.shape({
+    title: _propTypes.default.string,
+    text: _propTypes.default.string
+  }),
+  onTaskAction: _propTypes.default.func,
   refTitle: _propTypes.default.string,
   refNumber: _propTypes.default.string,
-  incompleteTitle: _propTypes.default.string,
   sections: _propTypes.default.arrayOf(_propTypes.default.shape({
     name: _propTypes.default.string.isRequired,
     label: _propTypes.default.string,
     tasks: _propTypes.default.arrayOf(_propTypes.default.shape({
       name: _propTypes.default.string.isRequired,
-      pages: _propTypes.default.array.isRequired,
+      pages: _propTypes.default.arrayOf(_propTypes.default.string).isRequired,
       state: _propTypes.default.string,
       displayName: _propTypes.default.string
     })).isRequired
-  })).isRequired,
-  classBlock: _propTypes.default.string,
-  classModifiers: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]),
-  className: _propTypes.default.string
+  })).isRequired
 };
 TaskList.defaultProps = {
   classBlock: DEFAULT_CLASS,
-  incompleteTitle: DEFAULT_INCOMPLETE_TITLE
+  classModifiers: [],
+  className: '',
+  fieldId: '',
+  formData: {},
+  id: '',
+  incompleteTitle: DEFAULT_INCOMPLETE_TITLE,
+  onTaskAction: undefined,
+  notes: {},
+  refTitle: undefined,
+  refNumber: undefined
 };
 var _default = TaskList;
 exports.default = _default;

package/dist/components/TaskList/TaskList.stories.mdx

@@ -0,0 +1,164 @@
+<!-- Global imports -->
+import { ArgsTable, Canvas, Meta, Story } from '@storybook/addon-docs';
+import { Details, Heading } from '@ukhomeoffice/cop-react-components';
+
+<!-- Local imports -->
+import Utils from '../../utils';
+import TaskList from './TaskList';
+
+<Meta title="Components/Task list" id="D-TaskList" component={ TaskList } />
+
+<Heading size="xl" caption="Components">Task list</Heading>
+
+Renders a list of tasks along with the current status for each. Each task that is not in the `Cannot start yet` state can be 
+selected to navigate to that task.
+
+<Canvas withToolbar>
+  <Story name="Default">
+    {() => {
+      const onAction = (row) => {
+        console.log('action clicked', row);
+      };
+      const COP_REF = '123';
+      const REF_TITLE = 'COP reference number';
+      const SECTIONS = [
+        {
+          name: 'Add event details',
+          tasks: [
+            { name: 'Date, location and mode details', state: 'complete' },
+            { name: 'Officer and agency details', state: 'inProgress' },
+          ],
+        },
+        {
+          name: 'Add people details',
+          tasks: [
+            { name: 'People details', state: 'complete' },
+            { name: 'Immigration details', state: 'inProgress' },
+            { name: 'Journey details', state: 'notStarted' },
+          ],
+        },
+        {
+          name: 'Add item details',
+          tasks: [
+            { name: 'Item details', state: 'cannotStartYet' },
+            { name: 'Search and interception details', state: 'cannotStartYet' },
+          ],
+        },
+      ];
+      return (
+        <TaskList refNumber={COP_REF} refTitle={REF_TITLE} sections={SECTIONS} />
+      );
+    }}
+  </Story>
+</Canvas>
+
+<Details summary="Properties" className="no-indent">
+  <ArgsTable of={ TaskList } />
+</Details>
+
+## With custom incomplete title
+This can be specified within the `hub` portion of the form JSON:
+```
+{
+  ...
+  hub: {
+    ...
+    incompleteTitle: 'You still have work to do, it seems'
+  }
+}
+```
+
+<Canvas withToolbar>
+  <Story name="With custom incomplete title">
+    {() => {
+      const onAction = (row) => {
+        console.log('action clicked', row);
+      };
+      const COP_REF = '123';
+      const REF_TITLE = 'COP reference number';
+      const INCOMPLETE_TITLE = 'You still have work to do, it seems'
+      const SECTIONS = [
+        {
+          name: 'Add event details',
+          tasks: [
+            { name: 'Date, location and mode details', state: 'complete' },
+            { name: 'Officer and agency details', state: 'inProgress' },
+          ],
+        },
+        {
+          name: 'Add people details',
+          tasks: [
+            { name: 'People details', state: 'complete' },
+            { name: 'Immigration details', state: 'inProgress' },
+            { name: 'Journey details', state: 'notStarted' },
+          ],
+        },
+        {
+          name: 'Add item details',
+          tasks: [
+            { name: 'Item details', state: 'cannotStartYet' },
+            { name: 'Search and interception details', state: 'cannotStartYet' },
+          ],
+        },
+      ];
+      return (
+        <TaskList refNumber={COP_REF} refTitle={REF_TITLE} sections={SECTIONS} incompleteTitle={INCOMPLETE_TITLE} />
+      );
+    }}
+  </Story>
+</Canvas>
+
+## With labels on tasks
+This is a non-required property of the individual `tasks` fields of the form JSON:
+```
+{
+  ...
+  tasks: [
+    {
+      ...
+      label: 'This is a label'
+    }
+    ...
+}
+```
+
+<Canvas withToolbar>
+  <Story name="With labels on tasks">
+    {() => {
+      const onAction = (row) => {
+        console.log('action clicked', row);
+      };
+      const COP_REF = '123';
+      const REF_TITLE = 'COP reference number';
+      const SECTIONS = [
+        {
+          name: 'Add event details',
+          label: 'Task 1 label',
+          tasks: [
+            { name: 'Date, location and mode details', state: 'complete' },
+            { name: 'Officer and agency details', state: 'inProgress' },
+          ],
+        },
+        {
+          name: 'Add people details',
+          tasks: [
+            { name: 'People details', state: 'complete' },
+            { name: 'Immigration details', state: 'inProgress' },
+            { name: 'Journey details', state: 'notStarted' },
+          ],
+        },
+        {
+          name: 'Add item details',
+          label: 'Task 3 label',
+          tasks: [
+            { name: 'Item details', state: 'cannotStartYet' },
+            { name: 'Search and interception details', state: 'cannotStartYet' },
+          ],
+        },
+      ];
+      return (
+        <TaskList refNumber={COP_REF} refTitle={REF_TITLE} sections={SECTIONS} />
+      );
+    }}
+  </Story>
+</Canvas>