@hmcts/ccd-case-ui-toolkit 6.16.2-ccpay-5.2.8 → 6.18.0-restricted-case-access

package/fesm2015/hmcts-ccd-case-ui-toolkit.js

@@ -3452,18 +3452,39 @@ class FieldsUtils {
         }
         return this.isFlagsFieldType(caseField.field_type);
     }
+    /**
+     * @deprecated Use {@link isCaseFieldOfType} instead, passing 'FlagLauncher' as the single type in the `types` array
+     */
     static isFlagLauncherCaseField(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
+     */
     static isComponentLauncherCaseField(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
+     */
+    static isCaseFieldOfType(caseField, types) {
+        if (!caseField || !types) {
+            return false;
+        }
+        return types.some(type => type === caseField.field_type.type);
+    }
     static isLinkedCasesCaseField(caseField) {
         return FieldsUtils.isComponentLauncherCaseField(caseField) &&
             caseField.id === 'LinkedCasesComponentLauncher';
@@ -5504,65 +5525,59 @@ class FormValueService {
         }
     }
     /**
-     * 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
      */
-    removeFlagLauncherField(data, caseFields) {
-        if (data && caseFields && caseFields.length > 0) {
-            const flagLauncherCaseField = caseFields.filter(caseField => FieldsUtils.isFlagLauncherCaseField(caseField));
-            if (flagLauncherCaseField.length > 0) {
-                // There should be only one FlagLauncher case field
-                delete data[flagLauncherCaseField[0].id];
+    removeCaseFieldsOfType(data, caseFields, types) {
+        if (data && caseFields && caseFields.length > 0 && types.length > 0) {
+            const caseFieldsToRemove = caseFields.filter(caseField => FieldsUtils.isCaseFieldOfType(caseField, types));
+            for (const caseField of caseFieldsToRemove) {
+                delete data[caseField.id];
             }
         }
     }
     /**
-     * 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
      */
-    populateFlagDetailsFromCaseFields(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(caseField => !FieldsUtils.isFlagLauncherCaseField(caseField))
+    repopulateFormDataFromCaseFieldValues(data, caseFields) {
+        if (data && caseFields && caseFields.length > 0 &&
+            caseFields.findIndex(caseField => FieldsUtils.isCaseFieldOfType(caseField, ['FlagLauncher'])) > -1) {
+            // Ignore the FlagLauncher CaseField because it does not hold any values
+            caseFields.filter(caseField => !FieldsUtils.isCaseFieldOfType(caseField, ['FlagLauncher']))
                 .forEach(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(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(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
-     */
-    removeComponentLauncherField(data, caseFields) {
-        if (data && caseFields && caseFields.length > 0) {
-            const componentLauncherCaseField = caseFields.filter(caseField => 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.
      *
@@ -5571,7 +5586,7 @@ class FormValueService {
      */
     populateLinkedCasesDetailsFromCaseFields(data, caseFields) {
         if (data && caseFields && caseFields.length > 0) {
-            caseFields.filter(caseField => !FieldsUtils.isComponentLauncherCaseField(caseField))
+            caseFields.filter(caseField => !FieldsUtils.isCaseFieldOfType(caseField, ['ComponentLauncher']))
                 .forEach(caseField => {
                 if (data.hasOwnProperty('caseLinks') && caseField.value) {
                     data[caseField.id] = caseField.value;
@@ -8337,7 +8352,9 @@ class CaseEditComponent {
             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,
@@ -8426,16 +8443,13 @@ class CaseEditComponent {
         // 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) {
@@ -8554,8 +8568,7 @@ class CaseEditComponent {
             this.sessionStorageService.removeItem('eventUrl');
             const 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);
@@ -9214,7 +9227,7 @@ class CaseEditPageComponent {
         this.wizard = this.caseEdit.wizard;
         this.caseFields = this.getCaseFields();
         this.syncCaseEditDataService();
-        this.route.params
+        this.routeParamsSub = this.route.params
             .subscribe(params => {
             var _a, _b;
             const pageId = params['page'];
@@ -9236,13 +9249,14 @@ class CaseEditPageComponent {
             }
         });
         CaseEditPageComponent.setFocusToTop();
-        this.caseEditDataService.caseEditForm$.subscribe({
+        this.caseEditFormSub = this.caseEditDataService.caseEditForm$.subscribe({
             next: editForm => this.editForm = editForm
         });
-        this.caseEditDataService.caseIsLinkedCasesJourneyAtFinalStep$.subscribe({
-            next: isLinkedCasesJourneyAtFinalStep => this.isLinkedCasesJourneyAtFinalStep = isLinkedCasesJourneyAtFinalStep
-        });
-        this.caseEditDataService.caseTriggerSubmitEvent$.subscribe({
+        this.caseIsLinkedCasesJourneyAtFinalStepSub =
+            this.caseEditDataService.caseIsLinkedCasesJourneyAtFinalStep$.subscribe({
+                next: isLinkedCasesJourneyAtFinalStep => this.isLinkedCasesJourneyAtFinalStep = isLinkedCasesJourneyAtFinalStep
+            });
+        this.caseTriggerSubmitEventSub = this.caseEditDataService.caseTriggerSubmitEvent$.subscribe({
             next: state => {
                 if (state) {
                     this.caseEditDataService.setTriggerSubmitEvent(false);
@@ -9255,6 +9269,17 @@ class CaseEditPageComponent {
     ngAfterViewChecked() {
         this.cdRef.detectChanges();
     }
+    ngOnDestroy() {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        (_a = this.routeParamsSub) === null || _a === void 0 ? void 0 : _a.unsubscribe();
+        (_b = this.caseEditFormSub) === null || _b === void 0 ? void 0 : _b.unsubscribe();
+        (_c = this.caseIsLinkedCasesJourneyAtFinalStepSub) === null || _c === void 0 ? void 0 : _c.unsubscribe();
+        (_d = this.caseTriggerSubmitEventSub) === null || _d === void 0 ? void 0 : _d.unsubscribe();
+        (_e = this.validateSub) === null || _e === void 0 ? void 0 : _e.unsubscribe();
+        (_f = this.dialogRefAfterClosedSub) === null || _f === void 0 ? void 0 : _f.unsubscribe();
+        (_g = this.saveDraftSub) === null || _g === void 0 ? void 0 : _g.unsubscribe();
+        (_h = this.caseFormValidationErrorsSub) === null || _h === void 0 ? void 0 : _h.unsubscribe();
+    }
     applyValuesChanged(valuesChanged) {
         this.formValuesChanged = valuesChanged;
     }
@@ -9328,7 +9353,7 @@ class CaseEditPageComponent {
                             this.generateErrorMessage(casefield.field_type.collection_field_type.complex_fields, c.get('value'), id);
                         });
                     }
-                    else if (FieldsUtils.isFlagLauncherCaseField(casefield)) {
+                    else if (FieldsUtils.isCaseFieldOfType(casefield, ['FlagLauncher'])) {
                         // Check whether the case field DisplayContextParameter is signalling "create" mode or "update" mode
                         // (expected always to be one of the two), to set the correct error message
                         let action = '';
@@ -9382,7 +9407,7 @@ class CaseEditPageComponent {
             this.caseEdit.error = null;
             const caseEventData = this.buildCaseEventData();
             const loadingSpinnerToken = this.loadingService.register();
-            this.caseEdit.validate(caseEventData, this.currentPage.id)
+            this.validateSub = this.caseEdit.validate(caseEventData, this.currentPage.id)
                 .pipe(finalize(() => {
                 this.loadingService.unregister(loadingSpinnerToken);
             }))
@@ -9482,7 +9507,7 @@ class CaseEditPageComponent {
         if (this.eventTrigger.can_save_draft) {
             if (this.formValuesChanged) {
                 const dialogRef = this.dialog.open(SaveOrDiscardDialogComponent, this.dialogConfig);
-                dialogRef.afterClosed().subscribe(result => {
+                this.dialogRefAfterClosedSub = dialogRef.afterClosed().subscribe(result => {
                     if (result === 'Discard') {
                         this.discard();
                     }
@@ -9568,7 +9593,7 @@ class CaseEditPageComponent {
             const draftCaseEventData = this.formValueService.sanitise(this.editForm.value);
             draftCaseEventData.event_token = this.eventTrigger.event_token;
             draftCaseEventData.ignore_warning = this.caseEdit.ignoreWarning;
-            this.caseEdit.saveDraft(draftCaseEventData).subscribe((draft) => this.eventTrigger.case_id = DRAFT_PREFIX + draft.id, error => this.handleError(error));
+            this.saveDraftSub = this.caseEdit.saveDraft(draftCaseEventData).subscribe((draft) => this.eventTrigger.case_id = DRAFT_PREFIX + draft.id, error => this.handleError(error));
         }
     }
     getCaseFields() {
@@ -9631,7 +9656,7 @@ class CaseEditPageComponent {
         this.caseEditDataService.setCaseEventTriggerName(this.eventTrigger.name);
         this.caseEditDataService.setCaseTitle(this.getCaseTitle());
         this.caseEditDataService.setCaseEditForm(this.editForm);
-        this.caseEditDataService.caseFormValidationErrors$.subscribe({
+        this.caseFormValidationErrorsSub = this.caseEditDataService.caseFormValidationErrors$.subscribe({
             next: (validationErrors) => this.validationErrors = validationErrors
         });
     }
@@ -23345,9 +23370,10 @@ class CaseEditSubmitComponent {
         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(caseField => FieldsUtils.isFlagLauncherCaseField(caseField));
+        this.caseEdit.isCaseFlagSubmission =
+            this.eventTrigger.case_fields.some(caseField => FieldsUtils.isCaseFieldOfType(caseField, ['FlagLauncher']));
         this.caseEdit.isLinkedCasesSubmission =
-            this.eventTrigger.case_fields.some(caseField => FieldsUtils.isComponentLauncherCaseField(caseField));
+            this.eventTrigger.case_fields.some(caseField => FieldsUtils.isCaseFieldOfType(caseField, ['ComponentLauncher']));
         this.pageTitle = this.caseEdit.isCaseFlagSubmission ? 'Review flag details' : 'Check your answers';
     }
     ngOnDestroy() {
@@ -23415,29 +23441,30 @@ class CaseEditSubmitComponent {
     }
     checkYourAnswerFieldsToDisplayExists() {
         /* istanbul ignore else */
-        if (!this.eventTrigger.show_summary) {
-            return false;
-        }
-        for (const page of this.wizard.pages) {
-            /* istanbul ignore else */
-            if (this.isShown(page)) {
-                for (const field of page.case_fields) {
-                    /* 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) {
+            for (const page of this.wizard.pages) {
+                /* istanbul ignore else */
+                if (page.case_fields && this.isShown(page)) {
+                    for (const field of page.case_fields) {
+                        /* istanbul ignore else */
+                        if (this.canShowFieldInCYA(field)) {
+                            // at least one field needs showing
+                            return true;
+                        }
                     }
                 }
             }
         }
-        // found no fields to show in CYA summary page
-        return false;
+        else {
+            // found no fields to show in CYA summary page
+            return false;
+        }
     }
     readOnlySummaryFieldsToDisplayExists() {
         return this.eventTrigger.case_fields.some(field => field.show_summary_content_option >= 0);
     }
     showEventNotes() {
-        return this.eventTrigger.show_event_notes === true;
+        return !!this.eventTrigger.show_event_notes;
     }
     getLastPageShown() {
         let lastPage;
@@ -26084,7 +26111,7 @@ class CaseResolver {
             }
             else {
                 return this.caseNotifier.fetchAndRefresh(cid)
-                    .pipe(catchError(error => this.checkAuthorizationError(error)))
+                    .pipe(catchError(error => this.checkAuthorizationError(error, cid)))
                     .toPromise();
             }
         }
@@ -26096,20 +26123,24 @@ class CaseResolver {
             this.caseNotifier.cachedCaseView = plainToClassFromExist(new CaseView(), caseView);
             this.caseNotifier.announceCase(this.caseNotifier.cachedCaseView);
             return this.caseNotifier.cachedCaseView;
-        }), catchError(error => this.checkAuthorizationError(error))).toPromise();
+        }), catchError(error => this.checkAuthorizationError(error, cid))).toPromise();
     }
-    checkAuthorizationError(error) {
+    checkAuthorizationError(error, caseReference) {
         // TODO Should be logged to remote logging infrastructure
         if (error.status === 400) {
             this.router.navigate(['/search/noresults']);
             return of(null);
         }
-        console.error(error);
         if (CaseResolver.EVENT_REGEX.test(this.previousUrl) && error.status === 404) {
             this.router.navigate(['/list/case']);
             return of(null);
         }
-        if (error.status !== 401 && error.status !== 403) {
+        // Error 403, navigate to restricted case access page
+        if (error.status === 403) {
+            this.router.navigate([`/cases/restricted-case-access/${caseReference}`]);
+            return of(null);
+        }
+        if (error.status !== 401) {
             this.router.navigate(['/error']);
         }
         this.goToDefaultPage();