@ukhomeoffice/cop-react-form-renderer 2.2.0 → 2.6.1-alpha

package/dist/components/TaskList/TaskState.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.DEFAULT_CLASS = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+var _models = require("../../models");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+//Global Imports
+//Local imports
+var DEFAULT_CLASS = 'hods-task-list';
+exports.DEFAULT_CLASS = DEFAULT_CLASS;
+
+var TaskState = function TaskState(_ref) {
+  var state = _ref.state;
+
+  var classes = _copReactComponents.Utils.classBuilder(DEFAULT_CLASS, undefined, undefined);
+
+  if (!_models.TaskStates.DETAILS[state]) {
+    return null;
+  }
+
+  return /*#__PURE__*/_react.default.createElement(_copReactComponents.Tag, {
+    classModifiers: [_models.TaskStates.DETAILS[state].colour],
+    className: classes('tag')
+  }, _models.TaskStates.DETAILS[state].label);
+};
+
+TaskState.propTypes = {
+  state: _propTypes.default.string.isRequired
+};
+var _default = TaskState;
+exports.default = _default;

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

@@ -0,0 +1,99 @@
+"use strict";
+
+var _react = require("@testing-library/react");
+
+var _react2 = _interopRequireDefault(require("react"));
+
+var _TaskState = _interopRequireDefault(require("./TaskState"));
+
+var _models = require("../../models");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Global imports
+// Local imports
+describe('components', function () {
+  describe('TaskList.TaskState', function () {
+    it('should render a complete state icon', function () {
+      var STATE = _models.TaskStates.TYPES.COMPLETE;
+
+      var _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_TaskState.default, {
+        state: STATE
+      })),
+          container = _render.container;
+
+      expect(container.childNodes.length).toEqual(1);
+      expect(container.childNodes[0].classList).toContain('hods-tag');
+      expect(container.childNodes[0].textContent).toEqual(_models.TaskStates.DETAILS.complete.label);
+    });
+    it('should render an in progress state icon', function () {
+      var STATE = _models.TaskStates.TYPES.IN_PROGRESS;
+
+      var _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_TaskState.default, {
+        state: STATE
+      })),
+          container = _render2.container;
+
+      expect(container.childNodes.length).toEqual(1);
+      expect(container.childNodes[0].classList).toContain('hods-tag');
+      expect(container.childNodes[0].classList).toContain("hods-tag--".concat(_models.TaskStates.DETAILS.inProgress.colour));
+      expect(container.childNodes[0].textContent).toEqual(_models.TaskStates.DETAILS.inProgress.label);
+    });
+    it('should render a not started state icon', function () {
+      var STATE = _models.TaskStates.TYPES.NOT_STARTED;
+
+      var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_TaskState.default, {
+        state: STATE
+      })),
+          container = _render3.container;
+
+      expect(container.childNodes.length).toEqual(1);
+      expect(container.childNodes[0].classList).toContain('hods-tag');
+      expect(container.childNodes[0].classList).toContain("hods-tag--".concat(_models.TaskStates.DETAILS.notStarted.colour));
+      expect(container.childNodes[0].textContent).toEqual(_models.TaskStates.DETAILS.notStarted.label);
+    });
+    it('should render a cannot start state icon', function () {
+      var STATE = _models.TaskStates.TYPES.CANNOT_START_YET;
+
+      var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_TaskState.default, {
+        state: STATE
+      })),
+          container = _render4.container;
+
+      expect(container.childNodes.length).toEqual(1);
+      expect(container.childNodes[0].classList).toContain('hods-tag');
+      expect(container.childNodes[0].classList).toContain("hods-tag--".concat(_models.TaskStates.DETAILS.cannotStartYet.colour));
+      expect(container.childNodes[0].textContent).toEqual(_models.TaskStates.DETAILS.cannotStartYet.label);
+    });
+    it('should not render a state if given an unknown value', function () {
+      var STATE = 'spellingError';
+
+      var _render5 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_TaskState.default, {
+        state: STATE
+      })),
+          container = _render5.container;
+
+      expect(container.childNodes.length).toEqual(0);
+    });
+    it('should not render a state if given null', function () {
+      var STATE = null;
+
+      var _render6 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_TaskState.default, {
+        state: STATE
+      })),
+          container = _render6.container;
+
+      expect(container.childNodes.length).toEqual(0);
+    });
+    it('should not render a state if given undefined', function () {
+      var STATE = undefined;
+
+      var _render7 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_TaskState.default, {
+        state: STATE
+      })),
+          container = _render7.container;
+
+      expect(container.childNodes.length).toEqual(0);
+    });
+  });
+});

package/dist/components/TaskList/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _TaskList = _interopRequireDefault(require("./TaskList"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = _TaskList.default;
+exports.default = _default;

package/dist/hooks/index.js

@@ -1,8 +1,22 @@
 "use strict";
 
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "STATUS_COMPLETE", {
+  enumerable: true,
+  get: function get() {
+    return _useRefData.STATUS_COMPLETE;
+  }
+});
+Object.defineProperty(exports, "STATUS_LOADING", {
+  enumerable: true,
+  get: function get() {
+    return _useRefData.STATUS_LOADING;
+  }
+});
 Object.defineProperty(exports, "useAxios", {
   enumerable: true,
   get: function get() {
@@ -34,6 +48,10 @@ var _useHooks = _interopRequireDefault(require("./useHooks"));
 
 var _useGetRequest = _interopRequireDefault(require("./useGetRequest"));
 
-var _useRefData = _interopRequireDefault(require("./useRefData"));
+var _useRefData = _interopRequireWildcard(require("./useRefData"));
+
+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 }; }

package/dist/json/taskList.json

@@ -0,0 +1,228 @@
+{
+  "id": "eventAtTheBorder",
+  "version": "1",
+  "name": "Event at the border",
+  "title": "Event at the border",
+  "type": "task-list",
+  "components": [
+    {
+      "id": "firstName",
+      "fieldId": "firstName",
+      "label": "First name",
+      "type": "text",
+      "required": true
+    },
+    {
+      "id": "surname",
+      "fieldId": "surname",
+      "label": "Last name",
+      "type": "text",
+      "required": true
+    },
+    {
+      "id": "date",
+      "fieldId": "date",
+      "label": "Date",
+      "type": "date",
+      "required": true
+    },
+    {
+      "id": "officerName",
+      "fieldId": "officerName",
+      "label": "Officer Name",
+      "type": "text"
+    },
+    {
+      "id": "immigrationDate",
+      "fieldId": "immigrationDate",
+      "label": "Immigration Date",
+      "type": "date",
+      "required": true
+    },
+    {
+      "id": "mode",
+      "fieldId": "mode",
+      "label": "Mode",
+      "type": "radios",
+      "data": {
+        "options": [
+          {
+            "value": "sea",
+            "label": "Sea"
+          },
+          {
+            "value": "air",
+            "label": "Air"
+          }
+        ]
+      },
+      "required": true
+    }
+  ],
+  "pages": [
+    {
+      "id": "eventDate",
+      "name": "eventDate",
+      "title": "Event Date",
+      "components": [
+        {
+          "use": "date"
+        }
+      ],
+      "actions": [
+        {
+          "type": "saveAndNavigate",
+          "page": "eventMode"
+        }
+      ],
+      "cya_link": {
+        "page": "eventDate",
+        "aria_suffix": "Event Date"
+      }
+    },
+    {
+      "id": "eventMode",
+      "name": "eventMode",
+      "title": "Event Mode",
+      "components": [
+        {
+          "use": "mode"
+        }
+      ],
+      "actions": [
+        {
+          "type": "saveAndNavigate",
+          "page": "cya"
+        }
+      ],
+      "cya_link": {
+        "page": "eventMode",
+        "aria_suffix": "Event Mode"
+      }
+    },
+    {
+      "id": "officeDetails",
+      "name": "officeDetails",
+      "title": "Officer Details",
+      "components": [
+        {
+          "use": "officerName"
+        }
+      ],
+      "actions": [
+        {
+          "type": "saveAndNavigate",
+          "page": "cya"
+        }
+      ],
+      "cya_link": {
+        "page": "officeDetails",
+        "aria_suffix": "Officer Details"
+      }
+    },
+    {
+      "id": "immigrationDate",
+      "name": "immigrationDate",
+      "title": "Immigration Date",
+      "components": [
+        {
+          "use": "immigrationDate"
+        }
+      ],
+      "actions": [
+        {
+          "type": "saveAndNavigate",
+          "page": "cya"
+        }
+      ],
+      "cya_link": {
+        "page": "immigrationDate",
+        "aria_suffix": "Immigration Date"
+      }
+    },
+    {
+      "id": "firstName",
+      "name": "firstName",
+      "title": "First Name",
+      "components": [
+        {
+          "use": "firstName"
+        }
+      ],
+      "actions": [
+        {
+          "type": "saveAndNavigate",
+          "page": "surname"
+        }
+      ],
+      "cya_link": {
+        "page": "firstName",
+        "aria_suffix": "First Name"
+      }
+    },
+    {
+      "id": "surname",
+      "name": "surname",
+      "title": "Surname",
+      "components": [
+        {
+          "use": "surname"
+        }
+      ],
+      "actions": [
+        {
+          "type": "saveAndNavigate",
+          "page": "cya"
+        }
+      ],
+      "cya_link": {
+        "page": "surname",
+        "aria_suffix": "Surname"
+      }
+    }
+  ],
+  "hub": {
+    "format": "CYA",
+    "refTitle": "COP reference number",
+    "sections": [
+      {
+        "name": "Add event details",
+        "tasks": [
+          {
+            "name": "Date, location and mode details",
+            "pages": ["eventDate", "eventMode"],
+            "state": "complete"
+          },
+          {
+            "name": "Officer and agency details",
+            "pages": ["officeDetails"],
+            "state": "inProgress"
+          }
+        ]
+      },
+      {
+        "name": "Add people details",
+        "tasks": [
+          {
+            "name": "People details",
+            "pages": ["firstName", "surname"],
+            "state": "complete"
+          },
+          {
+            "name": "Immigration details",
+            "pages": ["immigrationDate"],
+            "state": "inProgress"
+          },
+          {
+            "name": "Journey details",
+            "pages": ["none"],
+            "state": "cannotStartYet"
+          }
+        ]
+      }
+    ]
+  },
+  "cya": {
+    "hide_page_titles": false
+  }
+}

package/dist/json/userProfile.data.json

@@ -10,5 +10,6 @@
   "userDetails": {
     "linemanagerEmail": "line.manager@digital.homeoffice.gov.uk",
     "delegateEmails": "del.egate@digital.homeoffice.gov.uk"
-  }
+  },
+  "businessKey": "123456789"
 }

package/dist/models/ComponentTypes.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var TYPE_AUTOCOMPLETE = 'autocomplete';
 var TYPE_CHECKBOXES = 'checkboxes';
+var TYPE_CONTAINER = 'container';
 var TYPE_DATE = 'date';
 var TYPE_EMAIL = 'email';
 var TYPE_HEADING = 'heading';
@@ -15,9 +16,11 @@ var TYPE_PHONE_NUMBER = 'phone-number';
 var TYPE_RADIOS = 'radios';
 var TYPE_TEXT = 'text';
 var TYPE_TEXT_AREA = 'textarea';
+var TYPE_TIME = 'time';
 var ComponentTypes = {
   AUTOCOMPLETE: TYPE_AUTOCOMPLETE,
   CHECKBOXES: TYPE_CHECKBOXES,
+  CONTAINER: TYPE_CONTAINER,
   DATE: TYPE_DATE,
   EMAIL: TYPE_EMAIL,
   HEADING: TYPE_HEADING,
@@ -26,7 +29,8 @@ var ComponentTypes = {
   PHONE_NUMBER: TYPE_PHONE_NUMBER,
   RADIOS: TYPE_RADIOS,
   TEXT: TYPE_TEXT,
-  TEXT_AREA: TYPE_TEXT_AREA
+  TEXT_AREA: TYPE_TEXT_AREA,
+  TIME: TYPE_TIME
 };
 var _default = ComponentTypes;
 exports.default = _default;

package/dist/models/FormTypes.js

@@ -7,11 +7,13 @@ exports.default = void 0;
 var TYPE_FORM = 'form';
 var TYPE_CHECK_YOUR_ANSWERS = 'cya';
 var TYPE_HUB_AND_SPOKE = 'hub-and-spoke';
+var TYPE_TASK_LIST = 'task-list';
 var TYPE_WIZARD = 'wizard';
 var FormTypes = {
   FORM: TYPE_FORM,
   CYA: TYPE_CHECK_YOUR_ANSWERS,
   HUB: TYPE_HUB_AND_SPOKE,
+  TASK: TYPE_TASK_LIST,
   WIZARD: TYPE_WIZARD
 };
 var _default = FormTypes;

package/dist/models/HubFormats.js

@@ -5,8 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var HUB_FORMAT_CYA = 'CYA';
+var HUB_FORMAT_TASK = 'TASK';
 var HubFormats = {
-  CYA: HUB_FORMAT_CYA
+  CYA: HUB_FORMAT_CYA,
+  TASK: HUB_FORMAT_TASK
 };
 var _default = HubFormats;
 exports.default = _default;

package/dist/models/PageAction.js

@@ -11,11 +11,13 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 var TYPE_NAVIGATE = 'navigate';
 var TYPE_SAVE_AND_CONTINUE = 'saveAndContinue';
+var TYPE_SAVE_AND_NAVIGATE = 'saveAndNavigate';
 var TYPE_SAVE_AND_RETURN = 'saveAndReturn';
 var TYPE_SUBMIT = 'submit';
 var PageActionTypes = {
   NAVIGATE: TYPE_NAVIGATE,
   SAVE_AND_CONTINUE: TYPE_SAVE_AND_CONTINUE,
+  SAVE_AND_NAVIGATE: TYPE_SAVE_AND_NAVIGATE,
   SAVE_AND_RETURN: TYPE_SAVE_AND_RETURN,
   SUBMIT: TYPE_SUBMIT
 };
@@ -24,6 +26,9 @@ var DefaultPageActions = (_DefaultPageActions = {}, _defineProperty(_DefaultPage
   type: TYPE_SAVE_AND_CONTINUE,
   validate: true,
   label: 'Save and continue'
+}), _defineProperty(_DefaultPageActions, TYPE_SAVE_AND_NAVIGATE, {
+  type: TYPE_SAVE_AND_NAVIGATE,
+  validate: true
 }), _defineProperty(_DefaultPageActions, TYPE_SAVE_AND_RETURN, {
   type: TYPE_SAVE_AND_RETURN,
   validate: false,

package/dist/models/TaskStates.js

@@ -0,0 +1,41 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.StateTypes = void 0;
+
+var _StateDetails;
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var TYPE_COMPLETE = 'complete';
+var TYPE_IN_PROGRESS = 'inProgress';
+var TYPE_NOT_STARTED = 'notStarted';
+var TYPE_CANNOT_START_YET = 'cannotStartYet';
+var StateTypes = {
+  COMPLETE: TYPE_COMPLETE,
+  IN_PROGRESS: TYPE_IN_PROGRESS,
+  NOT_STARTED: TYPE_NOT_STARTED,
+  CANNOT_START_YET: TYPE_CANNOT_START_YET
+};
+exports.StateTypes = StateTypes;
+var StateDetails = (_StateDetails = {}, _defineProperty(_StateDetails, TYPE_COMPLETE, {
+  label: 'Completed',
+  colour: ''
+}), _defineProperty(_StateDetails, TYPE_IN_PROGRESS, {
+  label: 'In Progress',
+  colour: 'blue'
+}), _defineProperty(_StateDetails, TYPE_NOT_STARTED, {
+  label: 'Not Started',
+  colour: 'grey'
+}), _defineProperty(_StateDetails, TYPE_CANNOT_START_YET, {
+  label: 'Cannot Start Yet',
+  colour: 'grey'
+}), _StateDetails);
+var TaskStates = {
+  TYPES: StateTypes,
+  DETAILS: StateDetails
+};
+var _default = TaskStates;
+exports.default = _default;

package/dist/models/index.js

@@ -39,6 +39,12 @@ Object.defineProperty(exports, "PageAction", {
     return _PageAction.default;
   }
 });
+Object.defineProperty(exports, "TaskStates", {
+  enumerable: true,
+  get: function get() {
+    return _TaskStates.default;
+  }
+});
 
 var _ComponentTypes = _interopRequireDefault(require("./ComponentTypes"));
 
@@ -52,4 +58,6 @@ var _HubFormats = _interopRequireDefault(require("./HubFormats"));
 
 var _PageAction = _interopRequireDefault(require("./PageAction"));
 
+var _TaskStates = _interopRequireDefault(require("./TaskStates"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/utils/CheckYourAnswers/getCYARowsForContainer.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _models = require("../../models");
+
+var _getCYARow = _interopRequireDefault(require("./getCYARow"));
+
+var _showComponentCYA = _interopRequireDefault(require("./showComponentCYA"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var getCYARowsForContainer = function getCYARowsForContainer(page, container, formData, onAction) {
+  if ((0, _showComponentCYA.default)(container, page.formData)) {
+    return container.components.filter(function (c) {
+      return (0, _showComponentCYA.default)(c, page.formData);
+    }).flatMap(function (component) {
+      if (component.type === _models.ComponentTypes.CONTAINER) {
+        var fd = formData ? formData[component.fieldId] : undefined;
+        return getCYARowsForContainer(page, component, fd, onAction);
+      }
+
+      return (0, _getCYARow.default)(_objectSpread(_objectSpread({}, page), {}, {
+        formData: formData
+      }), component, onAction);
+    });
+  }
+};
+
+var _default = getCYARowsForContainer;
+exports.default = _default;