@hmcts/ccd-case-ui-toolkit 7.3.35 → 7.3.36-3582-rc-1

package/fesm2022/hmcts-ccd-case-ui-toolkit.mjs

@@ -6050,8 +6050,8 @@ class FormValueService {
     constructor(fieldTypeSanitiser) {
         this.fieldTypeSanitiser = fieldTypeSanitiser;
     }
-    sanitise(rawValue) {
-        return this.sanitiseObject(rawValue);
+    sanitise(rawValue, isCaseFlagJourney = false) {
+        return this.sanitiseObject(rawValue, isCaseFlagJourney);
     }
     sanitiseCaseReference(reference) {
         // strip non digits
@@ -6073,7 +6073,7 @@ class FormValueService {
     sanitiseDynamicLists(caseFields, editForm) {
         return this.fieldTypeSanitiser.sanitiseLists(caseFields, editForm.data);
     }
-    sanitiseObject(rawObject) {
+    sanitiseObject(rawObject, isCaseFlagJourney = false) {
         if (!rawObject) {
             return rawObject;
         }
@@ -6087,14 +6087,17 @@ class FormValueService {
                 break;
             }
             else if ('CaseReference' === key) {
-                sanitisedObject[key] = this.sanitiseValue(this.sanitiseCaseReference(String(rawObject[key])));
+                sanitisedObject[key] = this.sanitiseValue(this.sanitiseCaseReference(String(rawObject[key])), isCaseFlagJourney);
             }
             else {
-                sanitisedObject[key] = this.sanitiseValue(rawObject[key]);
+                sanitisedObject[key] = this.sanitiseValue(rawObject[key], isCaseFlagJourney);
                 if (Array.isArray(sanitisedObject[key])) {
                     // If the 'sanitised' array is empty, whereas the original array had 1 or more items
                     // delete the property from the sanatised object
-                    if (sanitisedObject[key].length === 0 && rawObject[key].length > 0) {
+                    const shouldDeleteField = sanitisedObject[key].length === 0
+                        && rawObject[key].length > 0
+                        && !isCaseFlagJourney;
+                    if (shouldDeleteField) {
                         delete sanitisedObject[key];
                     }
                 }
@@ -6102,13 +6105,13 @@ class FormValueService {
         }
         return sanitisedObject;
     }
-    sanitiseArray(rawArray) {
+    sanitiseArray(rawArray, isCaseFlagJourney = false) {
         if (!rawArray) {
             return rawArray;
         }
         rawArray.forEach(item => {
             if (item && item.hasOwnProperty('value')) {
-                item.value = this.sanitiseValue(item.value);
+                item.value = this.sanitiseValue(item.value, isCaseFlagJourney);
             }
         });
         // Filter the array to ensure only truthy values are returned; double-bang operator returns the boolean true/false
@@ -6118,13 +6121,13 @@ class FormValueService {
             .filter(item => !!item)
             .filter(item => item.hasOwnProperty('value') ? FieldsUtils.containsNonEmptyValues(item.value) : true);
     }
-    sanitiseValue(rawValue) {
+    sanitiseValue(rawValue, isCaseFlagJourney = false) {
         if (Array.isArray(rawValue)) {
-            return this.sanitiseArray(rawValue);
+            return this.sanitiseArray(rawValue, isCaseFlagJourney);
         }
         switch (typeof rawValue) {
             case 'object':
-                return this.sanitiseObject(rawValue);
+                return this.sanitiseObject(rawValue, isCaseFlagJourney);
             case 'string':
                 return rawValue.trim();
             case 'number':
@@ -6305,6 +6308,60 @@ class FormValueService {
             }
         }
     }
+    // exui-3582 When a form field becomes hidden based on user’s input in the event journey, 
+    // its stored value must be cleared and it must not be submitted or persisted.
+    removeHiddenField(data, caseFields, clearNonCase, formControls) {
+        if (clearNonCase && data && caseFields && caseFields.length > 0) {
+            for (const field of caseFields) {
+                if (!FormValueService.isLabel(field) && FormValueService.isReadOnly(field)) {
+                    // Retain anything that is readonly and not a label.
+                    continue;
+                }
+                // Check if formControls[field.id] exists before accessing its properties
+                const caseField = formControls[field.id] ? formControls[field.id]['caseField'] : undefined;
+                if (caseField === undefined || field.hidden === true) {
+                    continue;
+                }
+                const hasValue = data.hasOwnProperty(field.id) && data[field.id] != null &&
+                    (typeof data[field.id] !== 'object' || Object.keys(data[field.id]).length > 0);
+                if (caseField?.hidden === true &&
+                    field.display_context !== 'HIDDEN' &&
+                    field.display_context !== 'HIDDEN_TEMP' &&
+                    !field.retain_hidden_value &&
+                    field.id !== 'caseLinks' &&
+                    hasValue) {
+                    data[field.id] = null;
+                    continue; // If field is now hidden, skip checking its children
+                }
+                if (field.field_type) {
+                    switch (field.field_type.type) {
+                        case 'Complex':
+                            const complexData = data[field.id] ?? data['value'];
+                            if (complexData && formControls[field.id] && formControls[field.id]['controls']) {
+                                this.removeHiddenField(complexData, field.field_type.complex_fields, clearNonCase, formControls[field.id]['controls']);
+                            }
+                            break;
+                        case 'Collection':
+                            const collection = data[field.id];
+                            if (collection && Array.isArray(collection) && field.field_type.collection_field_type.type === 'Complex') {
+                                collection.forEach((item, index) => {
+                                    if (formControls[field.id] && formControls[field.id]['controls'] && formControls[field.id]['controls'][index]) {
+                                        const itemControls = formControls[field.id]?.['controls']?.[index]?.['controls']?.['value'];
+                                        const collectionData = item['value'] ?? item;
+                                        if (collectionData && itemControls?.['controls']) {
+                                            this.removeHiddenField(collectionData, field.field_type.collection_field_type.complex_fields, clearNonCase, itemControls['controls']);
+                                        }
+                                    }
+                                });
+                            }
+                            break;
+                        default:
+                            break;
+                    }
+                }
+            }
+        }
+    }
     /**
      * Remove any empty collection fields where a value of greater than zero is specified in the field's {@link FieldType}
      * `min` attribute.
@@ -9630,7 +9687,7 @@ class CaseEditComponent {
     }
     generateCaseEventData({ eventTrigger, form }) {
         const caseEventData = {
-            data: this.replaceEmptyComplexFieldValues(this.formValueService.sanitise(this.replaceHiddenFormValuesWithOriginalCaseData(form.get('data'), eventTrigger.case_fields))),
+            data: this.replaceEmptyComplexFieldValues(this.formValueService.sanitise(this.replaceHiddenFormValuesWithOriginalCaseData(form.get('data'), eventTrigger.case_fields), this.isCaseFlagSubmission)),
             event: form.value.event
         };
         this.formValueService.clearNonCaseFields(caseEventData.data, eventTrigger.case_fields);
@@ -9653,6 +9710,11 @@ class CaseEditComponent {
         if (!this.isCaseFlagSubmission) {
             this.formValueService.removeUnnecessaryFields(caseEventData.data, pageListCaseFields, true, true);
         }
+        // removeHiddenFields while are hidden in the UI
+        // Only remove hidden fields if editForm and its controls are available
+        if (form?.controls?.['data']?.['controls']) {
+            this.formValueService.removeHiddenField(caseEventData.data, pageListCaseFields, true, form.controls['data']['controls']);
+        }
         caseEventData.event_token = eventTrigger.event_token;
         caseEventData.ignore_warning = this.ignoreWarning;
         if (this.confirmation) {
@@ -11797,6 +11859,11 @@ class CaseEditPageComponent {
         this.validPageListCaseFieldsService.deleteNonValidatedFields(this.caseEdit.validPageList, caseEventData.data, this.eventTrigger.case_fields, fromPreviousPage, this.editForm.controls['data'].value);
         // Tidy it up before we return it.
         this.formValueService.removeUnnecessaryFields(caseEventData.data, caseFields, clearEmpty, clearNonCase, fromPreviousPage, this.currentPage.case_fields);
+        // removeHiddenFields while are hidden in the UI
+        // Only remove hidden fields if editForm and its controls are available
+        if (this.editForm?.controls?.['data']?.['controls']) {
+            this.formValueService.removeHiddenField(caseEventData.data, caseFields, clearNonCase, this.editForm.controls['data']['controls']);
+        }
         return caseEventData;
     }
     syncCaseEditDataService() {