@hmcts/ccd-case-ui-toolkit 6.16.2-ccpay-5.2.8 → 6.16.2-ccpay-upgrade

package/bundles/hmcts-ccd-case-ui-toolkit.umd.js

@@ -4124,18 +4124,39 @@
             }
             return this.isFlagsFieldType(caseField.field_type);
         };
+        /**
+         * @deprecated Use {@link isCaseFieldOfType} instead, passing 'FlagLauncher' as the single type in the `types` array
+         */
         FieldsUtils.isFlagLauncherCaseField = function (caseField) {
             if (!caseField) {
                 return false;
             }
             return caseField.field_type.type === 'FlagLauncher';
         };
+        /**
+         * @deprecated Use {@link isCaseFieldOfType} instead, passing 'ComponentLauncher' as the single type in the `types`
+         * array
+         */
         FieldsUtils.isComponentLauncherCaseField = function (caseField) {
             if (!caseField) {
                 return false;
             }
             return caseField.field_type.type === 'ComponentLauncher';
         };
+        /**
+         * Checks if a {@link CaseField} is of one of the given field types.
+         *
+         * @param caseField The `CaseField` to check
+         * @param types An array of one or more field types
+         * @returns `true` if the `CaseField` type is one of those in the array of types to check against; `false`
+         * otherwise or if `caseField` or `types` are falsy
+         */
+        FieldsUtils.isCaseFieldOfType = function (caseField, types) {
+            if (!caseField || !types) {
+                return false;
+            }
+            return types.some(function (type) { return type === caseField.field_type.type; });
+        };
         FieldsUtils.isLinkedCasesCaseField = function (caseField) {
             return FieldsUtils.isComponentLauncherCaseField(caseField) &&
                 caseField.id === 'LinkedCasesComponentLauncher';
@@ -6323,65 +6344,70 @@
             }
         };
         /**
-         * Remove the FlagLauncher case field, which is not intended to be persisted.
+         * Remove from the top level of the form data any case fields of a given type or types that are not intended to be
+         * persisted. This function is intended to remove "special" case field types from the data, such as FlagLauncher or
+         * ComponentLauncher fields.
          *
-         * @param data The object tree of form values on which to perform the removal
+         * @param data The object tree of form values on which to perform the removal at the top level only
          * @param caseFields The list of underlying {@link CaseField} domain model objects for each field
+         * @param types An array of one or more field types
          */
-        FormValueService.prototype.removeFlagLauncherField = function (data, caseFields) {
-            if (data && caseFields && caseFields.length > 0) {
-                var flagLauncherCaseField = caseFields.filter(function (caseField) { return FieldsUtils.isFlagLauncherCaseField(caseField); });
-                if (flagLauncherCaseField.length > 0) {
-                    // There should be only one FlagLauncher case field
-                    delete data[flagLauncherCaseField[0].id];
+        FormValueService.prototype.removeCaseFieldsOfType = function (data, caseFields, types) {
+            var e_12, _a;
+            if (data && caseFields && caseFields.length > 0 && types.length > 0) {
+                var caseFieldsToRemove = caseFields.filter(function (caseField) { return FieldsUtils.isCaseFieldOfType(caseField, types); });
+                try {
+                    for (var caseFieldsToRemove_1 = __values(caseFieldsToRemove), caseFieldsToRemove_1_1 = caseFieldsToRemove_1.next(); !caseFieldsToRemove_1_1.done; caseFieldsToRemove_1_1 = caseFieldsToRemove_1.next()) {
+                        var caseField = caseFieldsToRemove_1_1.value;
+                        delete data[caseField.id];
+                    }
+                }
+                catch (e_12_1) { e_12 = { error: e_12_1 }; }
+                finally {
+                    try {
+                        if (caseFieldsToRemove_1_1 && !caseFieldsToRemove_1_1.done && (_a = caseFieldsToRemove_1.return)) _a.call(caseFieldsToRemove_1);
+                    }
+                    finally { if (e_12) throw e_12.error; }
                 }
             }
         };
         /**
-         * Populate the flag data for each Flags field, from the data held in its corresponding CaseField.
+         * Re-populate the form data from the values held in the case fields. This is necessary in order to pick up, for
+         * each `Flags` field, any flag details data not currently present.
+         *
+         * `Flags` fields may be contained in other `CaseField` instances, either as a sub-field of a Complex field, or
+         * fields in a collection (or sub-fields of Complex fields in a collection). Therefore, it is necessary to
+         * iterate through all `CaseField`s.
          *
          * @param data The object tree of form values on which to perform the data population
          * @param caseFields The list of underlying {@link CaseField} domain model objects for each field
          */
-        FormValueService.prototype.populateFlagDetailsFromCaseFields = function (data, caseFields) {
-            if (data && caseFields && caseFields.length > 0) {
-                // Cannot filter out anything other than to remove the FlagLauncher CaseField because Flags fields may be
-                // contained in other CaseField instances, either as a sub-field of a Complex field, or fields in a collection
-                // (or sub-fields of Complex fields in a collection)
-                caseFields.filter(function (caseField) { return !FieldsUtils.isFlagLauncherCaseField(caseField); })
+        FormValueService.prototype.repopulateFormDataFromCaseFieldValues = function (data, caseFields) {
+            if (data && caseFields && caseFields.length > 0 &&
+                caseFields.findIndex(function (caseField) { return FieldsUtils.isCaseFieldOfType(caseField, ['FlagLauncher']); }) > -1) {
+                // Ignore the FlagLauncher CaseField because it does not hold any values
+                caseFields.filter(function (caseField) { return !FieldsUtils.isCaseFieldOfType(caseField, ['FlagLauncher']); })
                     .forEach(function (caseField) {
-                    // Ensure that the data object is populated for all case field IDs it contains, even if there is currently
-                    // nothing for a given case field ID (hence the use of hasOwnProperty())
+                    // Ensure that the data object is populated for all CaseField keys it contains, even if for a given
+                    // CaseField key, the data object has a falsy value (hence the use of hasOwnProperty() for the check below)
+                    // See https://tools.hmcts.net/jira/browse/EUI-7377
                     if (data.hasOwnProperty(caseField.id) && caseField.value) {
-                        // Create new object for the case field ID within the data object, if necessary
-                        if (data[caseField.id]) {
-                            // Copy all values from the corresponding CaseField; this ensures all nested flag data (for example, a
-                            // Flags field within a Complex field or a collection of Complex fields) is copied across
-                            Object.keys(data[caseField.id]).forEach(function (key) {
-                                if (caseField.value.hasOwnProperty(key)) {
-                                    data[caseField.id][key] = caseField.value[key];
-                                }
-                            });
+                        // Create new object for the CaseField ID within the data object, if necessary (i.e. if the current value
+                        // is falsy)
+                        if (!data[caseField.id]) {
+                            data[caseField.id] = {};
                         }
+                        // Copy all values from the corresponding CaseField; this ensures all nested flag data (for example, a
+                        // Flags field within a Complex field or a collection of Complex fields) is copied across
+                        Object.keys(data[caseField.id]).forEach(function (key) {
+                            if (caseField.value.hasOwnProperty(key)) {
+                                data[caseField.id][key] = caseField.value[key];
+                            }
+                        });
                     }
                 });
             }
         };
-        /**
-         * Remove the ComponentLauncher case field, which is not intended to be persisted.
-         *
-         * @param data The object tree of form values on which to perform the removal
-         * @param caseFields The list of underlying {@link CaseField} domain model objects for each field
-         */
-        FormValueService.prototype.removeComponentLauncherField = function (data, caseFields) {
-            if (data && caseFields && caseFields.length > 0) {
-                var componentLauncherCaseField = caseFields.filter(function (caseField) { return FieldsUtils.isComponentLauncherCaseField(caseField); });
-                if (componentLauncherCaseField.length > 0) {
-                    // There should be only one ComponentLauncher case field
-                    delete data[componentLauncherCaseField[0].id];
-                }
-            }
-        };
         /**
          * Populate the linked cases from the data held in its corresponding CaseField.
          *
@@ -6390,7 +6416,7 @@
          */
         FormValueService.prototype.populateLinkedCasesDetailsFromCaseFields = function (data, caseFields) {
             if (data && caseFields && caseFields.length > 0) {
-                caseFields.filter(function (caseField) { return !FieldsUtils.isComponentLauncherCaseField(caseField); })
+                caseFields.filter(function (caseField) { return !FieldsUtils.isCaseFieldOfType(caseField, ['ComponentLauncher']); })
                     .forEach(function (caseField) {
                     if (data.hasOwnProperty('caseLinks') && caseField.value) {
                         data[caseField.id] = caseField.value;
@@ -9614,7 +9640,9 @@
                 form: this.form,
             });
             /* istanbul ignore else */
-            if (!nextPage && !this.eventTrigger.show_summary && !this.eventTrigger.show_event_notes) {
+            if (!nextPage &&
+                !(this.eventTrigger.show_summary || this.eventTrigger.show_summary === null) &&
+                !this.eventTrigger.show_event_notes) {
                 this.submitForm({
                     eventTrigger: this.eventTrigger,
                     form: this.form,
@@ -9706,16 +9734,13 @@
             // Remove collection fields that have "min" validation of greater than zero set on the FieldType but are empty;
             // these will fail validation
             this.formValueService.removeEmptyCollectionsWithMinValidation(caseEventData.data, eventTrigger.case_fields);
-            // If this is a Case Flag submission (and thus a FlagLauncher field is present in the event trigger), the flag
-            // details data needs populating for each Flags field, then the FlagLauncher field needs removing
-            if (this.isCaseFlagSubmission) {
-                this.formValueService.populateFlagDetailsFromCaseFields(caseEventData.data, eventTrigger.case_fields);
-                this.formValueService.removeFlagLauncherField(caseEventData.data, eventTrigger.case_fields);
-            }
-            if (this.isLinkedCasesSubmission) {
-                this.formValueService.populateLinkedCasesDetailsFromCaseFields(caseEventData.data, eventTrigger.case_fields);
-                this.formValueService.removeComponentLauncherField(caseEventData.data, eventTrigger.case_fields);
-            }
+            // For Case Flag submissions (where a FlagLauncher field is present in the event trigger), the flag details data
+            // needs populating for each Flags field, then the FlagLauncher field needs removing
+            this.formValueService.repopulateFormDataFromCaseFieldValues(caseEventData.data, eventTrigger.case_fields);
+            // Data population step required for Linked Cases
+            this.formValueService.populateLinkedCasesDetailsFromCaseFields(caseEventData.data, eventTrigger.case_fields);
+            // Remove "Launcher"-type fields (these have no values and are not intended to be persisted)
+            this.formValueService.removeCaseFieldsOfType(caseEventData.data, eventTrigger.case_fields, ['FlagLauncher', 'ComponentLauncher']);
             caseEventData.event_token = eventTrigger.event_token;
             caseEventData.ignore_warning = this.ignoreWarning;
             if (this.confirmation) {
@@ -9837,8 +9862,7 @@
                 _this.sessionStorageService.removeItem('eventUrl');
                 var confirmation = _this.buildConfirmation(response);
                 if (confirmation && (confirmation.getHeader() || confirmation.getBody())) {
-                    // Add finally to fix sonar bug
-                    _this.confirm(confirmation).finally();
+                    _this.confirm(confirmation);
                 }
                 else {
                     _this.emitSubmitted(response);
@@ -26788,9 +26812,10 @@
             this.contextFields = this.getCaseFields();
             // Indicates if the submission is for a Case Flag, as opposed to a "regular" form submission, by the presence of
             // a FlagLauncher field in the event trigger
-            this.caseEdit.isCaseFlagSubmission = this.eventTrigger.case_fields.some(function (caseField) { return FieldsUtils.isFlagLauncherCaseField(caseField); });
+            this.caseEdit.isCaseFlagSubmission =
+                this.eventTrigger.case_fields.some(function (caseField) { return FieldsUtils.isCaseFieldOfType(caseField, ['FlagLauncher']); });
             this.caseEdit.isLinkedCasesSubmission =
-                this.eventTrigger.case_fields.some(function (caseField) { return FieldsUtils.isComponentLauncherCaseField(caseField); });
+                this.eventTrigger.case_fields.some(function (caseField) { return FieldsUtils.isCaseFieldOfType(caseField, ['ComponentLauncher']); });
             this.pageTitle = this.caseEdit.isCaseFlagSubmission ? 'Review flag details' : 'Check your answers';
         };
         CaseEditSubmitComponent.prototype.ngOnDestroy = function () {
@@ -26863,49 +26888,50 @@
         CaseEditSubmitComponent.prototype.checkYourAnswerFieldsToDisplayExists = function () {
             var e_1, _d, e_2, _e;
             /* istanbul ignore else */
-            if (!this.eventTrigger.show_summary) {
-                return false;
-            }
-            try {
-                for (var _f = __values(this.wizard.pages), _g = _f.next(); !_g.done; _g = _f.next()) {
-                    var page = _g.value;
-                    /* istanbul ignore else */
-                    if (this.isShown(page)) {
-                        try {
-                            for (var _h = (e_2 = void 0, __values(page.case_fields)), _j = _h.next(); !_j.done; _j = _h.next()) {
-                                var field = _j.value;
-                                /* istanbul ignore else */
-                                if (this.canShowFieldInCYA(field)) {
-                                    // at least one field needs showing
-                                    return true;
+            if (this.eventTrigger.show_summary || this.eventTrigger.show_summary === null) {
+                try {
+                    for (var _f = __values(this.wizard.pages), _g = _f.next(); !_g.done; _g = _f.next()) {
+                        var page = _g.value;
+                        /* istanbul ignore else */
+                        if (page.case_fields && this.isShown(page)) {
+                            try {
+                                for (var _h = (e_2 = void 0, __values(page.case_fields)), _j = _h.next(); !_j.done; _j = _h.next()) {
+                                    var field = _j.value;
+                                    /* istanbul ignore else */
+                                    if (this.canShowFieldInCYA(field)) {
+                                        // at least one field needs showing
+                                        return true;
+                                    }
                                 }
                             }
-                        }
-                        catch (e_2_1) { e_2 = { error: e_2_1 }; }
-                        finally {
-                            try {
-                                if (_j && !_j.done && (_e = _h.return)) _e.call(_h);
+                            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                            finally {
+                                try {
+                                    if (_j && !_j.done && (_e = _h.return)) _e.call(_h);
+                                }
+                                finally { if (e_2) throw e_2.error; }
                             }
-                            finally { if (e_2) throw e_2.error; }
                         }
                     }
                 }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
-                try {
-                    if (_g && !_g.done && (_d = _f.return)) _d.call(_f);
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (_g && !_g.done && (_d = _f.return)) _d.call(_f);
+                    }
+                    finally { if (e_1) throw e_1.error; }
                 }
-                finally { if (e_1) throw e_1.error; }
             }
-            // found no fields to show in CYA summary page
-            return false;
+            else {
+                // found no fields to show in CYA summary page
+                return false;
+            }
         };
         CaseEditSubmitComponent.prototype.readOnlySummaryFieldsToDisplayExists = function () {
             return this.eventTrigger.case_fields.some(function (field) { return field.show_summary_content_option >= 0; });
         };
         CaseEditSubmitComponent.prototype.showEventNotes = function () {
-            return this.eventTrigger.show_event_notes === true;
+            return !!this.eventTrigger.show_event_notes;
         };
         CaseEditSubmitComponent.prototype.getLastPageShown = function () {
             var _this = this;