Merge remote-tracking branch 'origin/CST-12498' into coar-notify-7

src/app/admin/admin-ldn-services/ldn-service-form-edit/ldn-service-form-edit.component.ts

@@ -21,6 +21,10 @@ import {FindListOptions} from '../../../core/data/find-list-options.model';
 import {PaginationComponentOptions} from '../../../shared/pagination/pagination-component-options.model';
 import {NotifyServicePattern} from '../ldn-services-model/ldn-service-patterns.model';
 
+
+/**
+ * Component for editing LDN service through a form that allows to edit the properties of the selected service
+ */
 @Component({
   selector: 'ds-ldn-service-form-edit',
   templateUrl: './ldn-service-form-edit.component.html',
@@ -110,12 +114,18 @@ export class LdnServiceFormEditComponent implements OnInit {
     this.setItemfilters();
   }
 
+  /**
+   * Sets item filters using LDN item filters service
+   */
   setItemfilters() {
     this.itemfiltersRD$ = this.ldnItemfiltersService.findAll().pipe(
       getFirstCompletedRemoteData());
   }
 
-
+  /**
+   * Fetches LDN service data by ID and updates the form
+   * @param serviceId - The ID of the LDN service
+   */
   fetchServiceData(serviceId: string): void {
     this.ldnServicesService.findById(serviceId).pipe(
       getFirstCompletedRemoteData()
@@ -140,6 +150,11 @@ export class LdnServiceFormEditComponent implements OnInit {
     );
   }
 
+  /**
+   * Filters pattern objects, initializes form groups, assigns labels, and adds them to the specified form array so the correct string is shown in the dropdown..
+   * @param formArrayName - The name of the form array to be populated
+   * @param isOutbound - A boolean indicating whether the patterns are outbound (true) or inbound (false)
+   */
   filterPatternObjectsAndPickLabel(formArrayName: string, isOutbound: boolean) {
     const PatternsArray = this.formModel.get(formArrayName) as FormArray;
     PatternsArray.clear();
@@ -170,6 +185,10 @@ export class LdnServiceFormEditComponent implements OnInit {
 
   }
 
+  /**
+   * Generates an array of patch operations based on form changes
+   * @returns Array of patch operations
+   */
   generatePatchOperations(): any[] {
     const patchOperations: any[] = [];
 
@@ -202,51 +221,86 @@ export class LdnServiceFormEditComponent implements OnInit {
     return patchOperations;
   }
 
+  /**
+   * Submits the form by opening the confirmation modal
+   */
   onSubmit() {
     this.openConfirmModal(this.confirmModal);
   }
 
+  /**
+   * Adds a new inbound pattern form group to the array of inbound patterns in the form
+   */
   addInboundPattern() {
     const notifyServiceInboundPatternsArray = this.formModel.get('notifyServiceInboundPatterns') as FormArray;
     notifyServiceInboundPatternsArray.push(this.createInboundPatternFormGroup());
   }
 
+  /**
+   * Adds a new outbound pattern form group to the array of outbound patterns in the form
+   */
   addOutboundPattern() {
     const notifyServiceOutboundPatternsArray = this.formModel.get('notifyServiceOutboundPatterns') as FormArray;
     notifyServiceOutboundPatternsArray.push(this.createOutboundPatternFormGroup());
   }
 
-
+  /**
+   * Selects an outbound pattern by updating its values based on the provided pattern value and index
+   * @param patternValue - The selected pattern value
+   * @param index - The index of the outbound pattern in the array
+   */
   selectOutboundPattern(patternValue: string, index: number): void {
     const patternArray = (this.formModel.get('notifyServiceOutboundPatterns') as FormArray);
     patternArray.controls[index].patchValue({pattern: patternValue});
     patternArray.controls[index].patchValue({patternLabel: this.translateService.instant('ldn-service.form.pattern.' + patternValue + '.label')});
 
   }
 
+  /**
+   * Selects an outbound item filter by updating its value based on the provided filter value and index
+   * @param filterValue - The selected filter value
+   * @param index - The index of the inbound pattern in the array
+   */
   selectOutboundItemFilter(filterValue: string, index: number) {
     const filterArray = (this.formModel.get('notifyServiceOutboundPatterns') as FormArray);
     filterArray.controls[index].patchValue({constraint: filterValue});
   }
 
+  /**
+   * Selects an inbound pattern by updating its values based on the provided pattern value and index
+   * @param patternValue - The selected pattern value
+   * @param index - The index of the inbound pattern in the array
+   */
   selectInboundPattern(patternValue: string, index: number): void {
     const patternArray = (this.formModel.get('notifyServiceInboundPatterns') as FormArray);
     patternArray.controls[index].patchValue({pattern: patternValue});
     patternArray.controls[index].patchValue({patternLabel: this.translateService.instant('ldn-service.form.pattern.' + patternValue + '.label')});
   }
 
+  /**
+   * Selects an inbound item filter by updating its value based on the provided filter value and index
+   * @param filterValue - The selected filter value
+   * @param index - The index of the inbound pattern in the array
+   */
   selectInboundItemFilter(filterValue: string, index: number): void {
     const filterArray = (this.formModel.get('notifyServiceInboundPatterns') as FormArray);
     filterArray.controls[index].patchValue({constraint: filterValue});
   }
 
+  /**
+   * Toggles the automatic property of an inbound pattern at the specified index
+   * @param i - The index of the inbound pattern in the array
+   */
   toggleAutomatic(i: number) {
     const automaticControl = this.formModel.get(`notifyServiceInboundPatterns.${i}.automatic`);
     if (automaticControl) {
       automaticControl.setValue(!automaticControl.value);
     }
   }
 
+  /**
+   * Toggles the enabled status of the LDN service by sending a patch request
+   */
   toggleEnabled() {
     const newStatus = !this.formModel.get('enabled').value;
 
@@ -267,20 +321,33 @@ export class LdnServiceFormEditComponent implements OnInit {
     );
   }
 
-
+  /**
+   * Closes the modal
+   */
   closeModal() {
     this.modalRef.close();
     this.cdRef.detectChanges();
   }
 
+  /**
+   * Opens a confirmation modal with the specified content
+   * @param content - The content to be displayed in the modal
+   */
   openConfirmModal(content) {
     this.modalRef = this.modalService.open(content);
   }
 
+  /**
+   * Opens a reset form modal with the specified content
+   * @param content - The content to be displayed in the modal
+   */
   openResetFormModal(content) {
     this.modalRef = this.modalService.open(content);
   }
 
+  /**
+   * Patches the LDN service by retrieving and sending patch operations geenrated in generatePatchOperations()
+   */
   patchService() {
     this.deleteMarkedInboundPatterns();
     this.deleteMarkedOutboundPatterns();
@@ -305,37 +372,59 @@ export class LdnServiceFormEditComponent implements OnInit {
       });
   }
 
+  /**
+   * Resets the form and navigates back to the LDN services page
+   */
   resetFormAndLeave() {
     this.sendBack();
     this.closeModal();
   }
 
+  /**
+   * Marks the specified inbound pattern for deletion
+   * @param index - The index of the inbound pattern in the array
+   */
   markForInboundPatternDeletion(index: number) {
     if (!this.markedForDeletionInboundPattern.includes(index)) {
       this.markedForDeletionInboundPattern.push(index);
     }
   }
 
+  /**
+   * Unmarks the specified inbound pattern for deletion
+   * @param index - The index of the inbound pattern in the array
+   */
   unmarkForInboundPatternDeletion(index: number) {
     const i = this.markedForDeletionInboundPattern.indexOf(index);
     if (i !== -1) {
       this.markedForDeletionInboundPattern.splice(i, 1);
     }
   }
 
+  /**
+   * Marks the specified outbound pattern for deletion
+   * @param index - The index of the outbound pattern in the array
+   */
   markForOutboundPatternDeletion(index: number) {
     if (!this.markedForDeletionOutboundPattern.includes(index)) {
       this.markedForDeletionOutboundPattern.push(index);
     }
   }
 
+  /**
+   * Unmarks the specified outbound pattern for deletion
+   * @param index - The index of the outbound pattern in the array
+   */
   unmarkForOutboundPatternDeletion(index: number) {
     const i = this.markedForDeletionOutboundPattern.indexOf(index);
     if (i !== -1) {
       this.markedForDeletionOutboundPattern.splice(i, 1);
     }
   }
 
+  /**
+   * Deletes marked inbound patterns from the form model
+   */
   deleteMarkedInboundPatterns() {
     this.markedForDeletionInboundPattern.sort((a, b) => b - a);
     const patternsArray = this.formModel.get('notifyServiceInboundPatterns') as FormArray;
@@ -355,7 +444,9 @@ export class LdnServiceFormEditComponent implements OnInit {
     this.markedForDeletionInboundPattern = [];
   }
 
-
+  /**
+   * Deletes marked outbound patterns from the form model
+   */
   deleteMarkedOutboundPatterns() {
     this.markedForDeletionOutboundPattern.sort((a, b) => b - a);
     const patternsArray = this.formModel.get('notifyServiceOutboundPatterns') as FormArray;
@@ -376,7 +467,12 @@ export class LdnServiceFormEditComponent implements OnInit {
     this.markedForDeletionOutboundPattern = [];
   }
 
-
+  /**
+   * Creates a replace operation and adds it to the patch operations if the form control is dirty
+   * @param patchOperations - The array to store patch operations
+   * @param formControlName - The name of the form control
+   * @param path - The JSON Patch path for the operation
+   */
   private createReplaceOperation(patchOperations: any[], formControlName: string, path: string): void {
     if (this.formModel.get(formControlName).dirty) {
       patchOperations.push({
@@ -387,6 +483,11 @@ export class LdnServiceFormEditComponent implements OnInit {
     }
   }
 
+  /**
+   * Handles patterns in the form array, checking if an add or replace operations is required
+   * @param patchOperations - The array to store patch operations
+   * @param formArrayName - The name of the form array
+   */
   private handlePatterns(patchOperations: any[], formArrayName: string): void {
     const patternsArray = this.formModel.get(formArrayName) as FormArray;
 
@@ -417,10 +518,17 @@ export class LdnServiceFormEditComponent implements OnInit {
     }
   }
 
+  /**
+   * Navigates back to the LDN services page
+   */
   private sendBack() {
     this.router.navigateByUrl('admin/ldn/services');
   }
 
+  /**
+   * Creates a form group for outbound patterns
+   * @returns The form group for outbound patterns
+   */
   private createOutboundPatternFormGroup(): FormGroup {
     return this.formBuilder.group({
       pattern: '',
@@ -430,6 +538,10 @@ export class LdnServiceFormEditComponent implements OnInit {
     });
   }
 
+  /**
+   * Creates a form group for inbound patterns
+   * @returns The form group for inbound patterns
+   */
   private createInboundPatternFormGroup(): FormGroup {
     return this.formBuilder.group({
       pattern: '',
@@ -440,6 +552,10 @@ export class LdnServiceFormEditComponent implements OnInit {
     });
   }
 
+  /**
+   * Initializes an existing form group for outbound patterns
+   * @returns The initialized form group for outbound patterns
+   */
   private initializeOutboundPatternFormGroup(): FormGroup {
     return this.formBuilder.group({
       pattern: '',
@@ -448,6 +564,10 @@ export class LdnServiceFormEditComponent implements OnInit {
     });
   }
 
+  /**
+   * Initializes an existing form group for inbound patterns
+   * @returns The initialized form group for inbound patterns
+   */
   private initializeInboundPatternFormGroup(): FormGroup {
     return this.formBuilder.group({
       pattern: '',