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

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

@@ -28,7 +28,7 @@ const addValue = (key, value, multiMap) => {
  * 
  * @param {Object} payload Javascript object from which the node will be deleted. Updated by the method.
  * @param {String} path A string containing a decimal point delimited path specifying the node to delete.
- * @return Nothing, obj above updated.
+ * @return {void}, obj above updated.
  */
 exports.addValue = addValue;
 const deleteNodeByPath = (payload, path) => {
@@ -88,15 +88,20 @@ const getNestedQuestionPath = (optionPath, nestedFieldId) => {
 /** 
  * If the component has options, go through each option removing the data for any nested fields. 
  * Required as nested options are in the payload at the same heirarchical level.
+ * 
+ * There are occasions when a field shouldn't be removed from the payload, eg if a form is being used for 2 purposes
+ * eg the cop-reassign-task-to-rcc.json, and the field is only being hidden for display purposes. Allow these fields
+ * to be preserved with a property on the component.
 
  * @param {Object} payload Javascript object from which the node will be deleted. Updated by the method.
  * @param {String} path A string containing a decimal point delimited path specifying the node to delete.
  * @param {Object} component The form component representing the path being deleted
- * @return Nothing, obj above updated.
+ * @return {void}, obj above updated.
  */
 exports.getNestedQuestionPath = getNestedQuestionPath;
 const deleteNodeAndOptions = (payload, path, component) => {
   var _component$data;
+  if (component.preserveInPayload) return;
   deleteNodeByPath(payload, path);
   // If the component has options, go through each option removing the data for any nested fields. Required as nested options are in the payload at the same heirarchical level.
   if (component !== null && component !== void 0 && (_component$data = component.data) !== null && _component$data !== void 0 && _component$data.options) {
@@ -115,7 +120,7 @@ const deleteNodeAndOptions = (payload, path, component) => {
  * but added by the renderer to find the activeId. If so, remove these objects entirely as they have been pruned.
  * 
  * @param {Array} array Array of objects. Each object which has only 1 remaining field called 'id' should be removed.
- * @return Nothing, array above updated.
+ * @return {void}, array above updated.
  */
 exports.deleteNodeAndOptions = deleteNodeAndOptions;
 const removeObjectWithOnlySingleIdField = array => {
@@ -238,11 +243,13 @@ exports.isShowEntity = isShowEntity;
 const findComponentDefinitionInForm = (pageComponentDef, componentByIdMap, componentByFieldIdMap) => {
   var _ref, _componentByIdMap$get;
   const componentInForm = (_ref = (_componentByIdMap$get = componentByIdMap.get(pageComponentDef.use)) !== null && _componentByIdMap$get !== void 0 ? _componentByIdMap$get : componentByFieldIdMap.get(pageComponentDef.use)) !== null && _ref !== void 0 ? _ref : pageComponentDef;
+
+  // Create clone of component, so processing can make changes to it without changing the form
+  const componentInFormClone = JSON.parse(JSON.stringify(componentInForm));
   if (pageComponentDef.use && pageComponentDef.show_when) {
-    componentInForm.show_when = pageComponentDef.show_when;
+    componentInFormClone.show_when = pageComponentDef.show_when;
   }
-  // Retun clone of component, so subsequent processing can make changes to it without changing the form
-  return JSON.parse(JSON.stringify(componentInForm));
+  return componentInFormClone;
 };
 
 /**
@@ -254,7 +261,7 @@ const findComponentDefinitionInForm = (pageComponentDef, componentByIdMap, compo
  * @param {*} component The component definition being deleted that needs corresponding meta data also deleted
  * @param {*} collectionDataObject The payload containing the file data being deleted (for which the corresponding meta needs deleting)
  * @param {*} formData The entire payload, which will include the meta section
- * @returns Nothing, as the formData will be updated in situ
+ * @returns {void}, as the formData will be updated in situ
  */
 exports.findComponentDefinitionInForm = findComponentDefinitionInForm;
 const deleteCorrespondingMetaInfo = (component, collectionDataObject, formData) => {
@@ -335,6 +342,7 @@ const removeEmptyArraysAndUnusedCollectionIDs = payload => {
  * When the counter reaches 1 we know all other occurences of the component have been resolved
  * so it is safe to delete.
  * 
+ * 
  * @param {*} payload The form payload from which to delete the component data
  * @param {*} path The payload path of the component
  * @param {*} component The component whose data we should attempt to delete

package/dist/components/FormRenderer/onCYAAction.js

@@ -18,7 +18,7 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
  * 
  * @param {*} action 
  */
-const onCYAAction = (setPagePoint, action, pages, validate, components, data, setData, type, pageId, currentTask, hooks, addErrors, hub, onPageChange, formState, submitting, setSubmitting) => {
+const onCYAAction = (setPagePoint, action, pages, validate, cleanseHiddenData, components, data, setData, type, pageId, currentTask, hooks, addErrors, hub, onPageChange, formState, submitting, setSubmitting) => {
   // Check to see whether the action is able to proceed, which in
   // in the case of a submission will validate the fields in the page.
   if (action.type === _models.PageAction.TYPES.SUBMIT && hub !== _models.HubFormats.TASK) {
@@ -36,7 +36,7 @@ const onCYAAction = (setPagePoint, action, pages, validate, components, data, se
         pages,
         components
       };
-      _helpers.default.clearOutUncompletedRoutes(formPagesAndComponents, submissionData);
+      _helpers.default.clearOutUncompletedRoutes(cleanseHiddenData, formPagesAndComponents, submissionData);
       submissionData.formStatus = _helpers.default.getSubmissionStatus(type, pages, pageId, action, submissionData, currentTask, true);
       setData(submissionData);
       // Now submit the data to the backend...
@@ -80,7 +80,7 @@ const onCYAAction = (setPagePoint, action, pages, validate, components, data, se
           pages,
           components
         };
-        _helpers.default.clearOutUncompletedRoutes(formPagesAndComponents, submissionData);
+        _helpers.default.clearOutUncompletedRoutes(cleanseHiddenData, formPagesAndComponents, submissionData);
         submissionData.formStatus = _helpers.default.getSubmissionStatus(type, pages, pageId, action, submissionData, currentTask, true);
         setData(submissionData);
         // Now submit the data to the backend...

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

@@ -57,7 +57,7 @@ jest.mock('./helpers', () => ({
     this.getSubmissionStatusCalls = 0;
   },
   clearOutUncompletedRoutesCalls: 0,
-  clearOutUncompletedRoutes(formPagesAndComponents, formData) {
+  clearOutUncompletedRoutes(cleanseHiddenData, formPagesAndComponents, formData) {
     this.clearOutUncompletedRoutesCalls += 1;
     return formData;
   }
@@ -170,6 +170,7 @@ describe('components.FormRenderer.onCYAAction', () => {
     },
     pages: PAGES,
     validate: () => {},
+    cleanseHiddenData: true,
     components: COMPONENTS,
     data: {},
     setData: mockSetData,

package/dist/components/FormRenderer/onPageAction.js

@@ -19,7 +19,7 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
 // (patch captures payload-ready field name and value, 
 // patchLabel captures non-ID values 
 // for display purposes after submission.)
-const onPageAction = (action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting, existingErrors) => {
+const onPageAction = (action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, cleanseHiddenData, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting, existingErrors) => {
   // Save a copy of data in case submit errors and we need to revert
   const preSubmitData = _objectSpread({}, data);
   const form = formState;
@@ -112,7 +112,7 @@ const onPageAction = (action, patch, patchLabel, hooks, data, formState, validat
         components
       };
       if (action.type === _models.PageAction.TYPES.SUBMIT) {
-        _helpers.default.clearOutUncompletedRoutes(formPagesAndComponents, submissionData);
+        _helpers.default.clearOutUncompletedRoutes(cleanseHiddenData, formPagesAndComponents, submissionData);
       }
 
       // In case of hub-and-spoke if patchLabel has changed then 

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

@@ -47,7 +47,7 @@ jest.mock('./helpers', () => ({
     return patch;
   },
   clearOutUncompletedRoutesCalls: 0,
-  clearOutUncompletedRoutes(formPagesAndComponents, formData) {
+  clearOutUncompletedRoutes(cleanseHiddenData, formPagesAndComponents, formData) {
     this.clearOutUncompletedRoutesCalls += 1;
     return formData;
   },
@@ -229,6 +229,7 @@ describe('components.FormRenderer.onPageAction', () => {
     validate: MOCK_VALIDATE,
     onPageChange: mockOnPageChange,
     type: _models.FormTypes.FORM_WITH_TASK,
+    cleanseHiddenData: true,
     pages: PAGES,
     components: COMPONENTS,
     pageId: 'alpha',

package/dist/utils/Component/getComponentTests/getComponent.multifile.test.js

@@ -23,7 +23,8 @@ describe('utils.Component.get', () => {
       fieldId: FIELD_ID,
       label: LABEL,
       onChange: ON_CHANGE,
-      'data-testid': ID
+      'data-testid': ID,
+      allowedTypes: []
     };
     const {
       container

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "6.15.11-alpha",
+  "version": "6.15.11",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
     "test": "react-scripts test",
     "test:coverage": "yarn test --coverage --watchAll=false",
     "lint": "eslint --ext .js,.jsx src",
+    "lint:fix": "eslint --ext .js,.jsx src --fix",
     "storybook:start": "start-storybook --docs -s src/assets --no-manager-cache -p 6007",
     "storybook:build": "build-storybook --docs -s src/assets",
     "storybook": "yarn storybook:start",
@@ -16,12 +17,12 @@
     "yalc-publish": "yarn compile-with-maps && cp -r src dist/src && yalc publish --push"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "4.7.10",
+    "@ukhomeoffice/cop-react-components": "4.7.16",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^5.0.0",
-    "web-vitals": "^1.0.1",
-    "uuid": "^8.1.0"
+    "uuid": "^8.1.0",
+    "web-vitals": "^1.0.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.15.4",