[CST-15074][DSpace#3355] PR review

Author: vins01-4science

src/app/external-log-in/email-confirmation/confirm-email/confirm-email.component.ts

@@ -1,46 +1,18 @@
 import { NgIf } from '@angular/common';
-import {
-  ChangeDetectionStrategy,
-  Component,
-  Inject,
-  Input,
-  OnDestroy,
-  OnInit,
-} from '@angular/core';
-import {
-  FormBuilder,
-  FormGroup,
-  ReactiveFormsModule,
-  Validators,
-} from '@angular/forms';
-import {
-  TranslateModule,
-  TranslateService,
-} from '@ngx-translate/core';
+import { ChangeDetectionStrategy, Component, Inject, Input, OnDestroy, OnInit, } from '@angular/core';
+import { FormBuilder, FormGroup, ReactiveFormsModule, Validators, } from '@angular/forms';
+import { TranslateModule, TranslateService, } from '@ngx-translate/core';
 import isEqual from 'lodash/isEqual';
-import {
-  combineLatest,
-  Subscription,
-  take,
-} from 'rxjs';
+import { combineLatest, Subscription, take, } from 'rxjs';
 
 import { AuthService } from '../../../core/auth/auth.service';
 import { EPersonDataService } from '../../../core/eperson/eperson-data.service';
 import { EPerson } from '../../../core/eperson/models/eperson.model';
 import { HardRedirectService } from '../../../core/services/hard-redirect.service';
-import {
-  NativeWindowRef,
-  NativeWindowService,
-} from '../../../core/services/window.service';
-import {
-  getFirstCompletedRemoteData,
-  getRemoteDataPayload,
-} from '../../../core/shared/operators';
+import { NativeWindowRef, NativeWindowService, } from '../../../core/services/window.service';
+import { getFirstCompletedRemoteData, getRemoteDataPayload, } from '../../../core/shared/operators';
 import { Registration } from '../../../core/shared/registration.model';
-import {
-  hasNoValue,
-  hasValue,
-} from '../../../shared/empty.util';
+import { hasNoValue, hasValue, } from '../../../shared/empty.util';
 import { NotificationsService } from '../../../shared/notifications/notifications.service';
 import { ExternalLoginService } from '../../services/external-login.service';
 
@@ -56,6 +28,9 @@ import { ExternalLoginService } from '../../services/external-login.service';
     ReactiveFormsModule,
   ],
 })
+/**
+ * Email confirmation component that will check for user email confirmation after account creation.
+ */
 export class ConfirmEmailComponent implements OnInit, OnDestroy {
   /**
    * The form containing the email input

src/app/external-log-in/email-confirmation/confirmation-sent/confirmation-sent.component.ts

@@ -1,7 +1,4 @@
-import {
-  ChangeDetectionStrategy,
-  Component,
-} from '@angular/core';
+import { ChangeDetectionStrategy, Component, } from '@angular/core';
 import { TranslateModule } from '@ngx-translate/core';
 
 @Component({
@@ -13,4 +10,7 @@ import { TranslateModule } from '@ngx-translate/core';
   standalone: true,
 
 })
+/**
+ * Simple component that shows up a confirmation to the user.
+ */
 export class ConfirmationSentComponent { }

src/app/external-log-in/email-confirmation/provide-email/provide-email.component.html

@@ -8,7 +8,6 @@ <h4 class="mb-3">
       type="email"
       id="email"
       formControlName="email"
-      placeholder="Input box"
       class="form-control form-control-lg position-relative"
     />
 

src/app/external-log-in/email-confirmation/provide-email/provide-email.component.spec.ts

@@ -1,14 +1,8 @@
 import { CommonModule } from '@angular/common';
 import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
-import {
-  ComponentFixture,
-  TestBed,
-} from '@angular/core/testing';
+import { ComponentFixture, TestBed, } from '@angular/core/testing';
 import { FormBuilder } from '@angular/forms';
-import {
-  TranslateLoader,
-  TranslateModule,
-} from '@ngx-translate/core';
+import { TranslateLoader, TranslateModule, } from '@ngx-translate/core';
 
 import { TranslateLoaderMock } from '../../../shared/mocks/translate-loader.mock';
 import { ExternalLoginService } from '../../services/external-login.service';
@@ -53,16 +47,16 @@ describe('ProvideEmailComponent', () => {
     expect(component).toBeTruthy();
   });
 
-  // it('should call externalLoginService.patchUpdateRegistration when form is submitted with valid email', () => {
-  //   const email = 'test@example.com';
-  //   component.emailForm.setValue({ email });
-  //   component.registrationId = '123';
-  //   component.token = '456';
-  //   fixture.detectChanges();
+  it('should call externalLoginService.patchUpdateRegistration when form is submitted with valid email', () => {
+    const email = 'test@example.com';
+    component.emailForm.setValue({ email });
+    component.registrationId = '123';
+    component.token = '456';
+    fixture.detectChanges();
 
-  //   const button = fixture.nativeElement.querySelector('button[type="submit"]');
-  //   button.click();
+    const button = fixture.nativeElement.querySelector('button[type="submit"]');
+    button.click();
 
-  //   expect(externalLoginServiceSpy.patchUpdateRegistration).toHaveBeenCalledWith([email], 'email', component.registrationId, component.token, 'add');
-  // });
+    expect(externalLoginServiceSpy.patchUpdateRegistration).toHaveBeenCalledWith([email], 'email', component.registrationId, component.token, 'add');
+  });
 });

src/app/external-log-in/email-confirmation/provide-email/provide-email.component.ts

@@ -1,16 +1,6 @@
 import { NgIf } from '@angular/common';
-import {
-  ChangeDetectionStrategy,
-  Component,
-  Input,
-  OnDestroy,
-} from '@angular/core';
-import {
-  FormBuilder,
-  FormGroup,
-  ReactiveFormsModule,
-  Validators,
-} from '@angular/forms';
+import { ChangeDetectionStrategy, Component, Input, OnDestroy, } from '@angular/core';
+import { FormBuilder, FormGroup, ReactiveFormsModule, Validators, } from '@angular/forms';
 import { TranslateModule } from '@ngx-translate/core';
 import { Subscription } from 'rxjs';
 
@@ -29,6 +19,9 @@ import { ExternalLoginService } from '../../services/external-login.service';
   ],
   standalone: true,
 })
+/**
+ * This component provides a proper field to submit the email that will be updated for its registration token
+ */
 export class ProvideEmailComponent implements OnDestroy {
   /**
    * The form group for the email input

src/app/external-log-in/external-log-in/external-log-in.component.ts

@@ -1,34 +1,15 @@
-import {
-  NgComponentOutlet,
-  NgIf,
-} from '@angular/common';
-import {
-  ChangeDetectionStrategy,
-  Component,
-  Injector,
-  Input,
-  OnDestroy,
-  OnInit,
-} from '@angular/core';
-import {
-  NgbModal,
-  NgbModalRef,
-} from '@ng-bootstrap/ng-bootstrap';
-import {
-  TranslateModule,
-  TranslateService,
-} from '@ngx-translate/core';
+import { NgComponentOutlet, NgIf, } from '@angular/common';
+import { ChangeDetectionStrategy, Component, Injector, Input, OnDestroy, OnInit, } from '@angular/core';
+import { NgbModal, NgbModalRef, } from '@ng-bootstrap/ng-bootstrap';
+import { TranslateModule, TranslateService, } from '@ngx-translate/core';
 
 import { AuthService } from '../../core/auth/auth.service';
 import { AuthMethodType } from '../../core/auth/models/auth.method-type';
 import { AuthRegistrationType } from '../../core/auth/models/auth.registration-type';
 import { Registration } from '../../core/shared/registration.model';
 import { AlertComponent } from '../../shared/alert/alert.component';
 import { AlertType } from '../../shared/alert/alert-type';
-import {
-  hasValue,
-  isEmpty,
-} from '../../shared/empty.util';
+import { hasValue, isEmpty, } from '../../shared/empty.util';
 import { ThemedLogInComponent } from '../../shared/log-in/themed-log-in.component';
 import {
   ExternalLoginTypeComponent,
@@ -53,6 +34,9 @@ import { ProvideEmailComponent } from '../email-confirmation/provide-email/provi
   ],
   standalone: true,
 })
+/**
+ * This component is responsible to handle the external-login depending on the RegistrationData details provided
+ */
 export class ExternalLogInComponent implements OnInit, OnDestroy  {
   /**
    * The AlertType enumeration for access in the component's template

src/app/external-log-in/registration-types/orcid-confirmation/orcid-confirmation.component.ts

@@ -1,15 +1,6 @@
 import { NgIf } from '@angular/common';
-import {
-  ChangeDetectionStrategy,
-  Component,
-  Inject,
-  OnInit,
-} from '@angular/core';
-import {
-  FormBuilder,
-  FormGroup,
-  ReactiveFormsModule,
-} from '@angular/forms';
+import { ChangeDetectionStrategy, Component, Inject, OnInit, } from '@angular/core';
+import { FormBuilder, FormGroup, ReactiveFormsModule, } from '@angular/forms';
 import { TranslateModule } from '@ngx-translate/core';
 
 import { Registration } from '../../../core/shared/registration.model';
@@ -29,6 +20,9 @@ import { ExternalLoginMethodEntryComponent } from '../../decorators/external-log
   ],
   standalone: true,
 })
+/**
+ * This component is responsible to show the registered data inside the registration token to the user
+ */
 export class OrcidConfirmationComponent extends ExternalLoginMethodEntryComponent implements OnInit  {
 
   /**

src/app/external-log-in/services/external-login.service.ts

@@ -1,15 +1,8 @@
 import { Injectable } from '@angular/core';
 import { Router } from '@angular/router';
-import {
-  select,
-  Store,
-} from '@ngrx/store';
+import { select, Store, } from '@ngrx/store';
 import { TranslateService } from '@ngx-translate/core';
-import {
-  filter,
-  map,
-  Observable,
-} from 'rxjs';
+import { filter, map, Observable, } from 'rxjs';
 import { AuthMethod } from 'src/app/core/auth/models/auth.method';
 import { getAuthenticationMethods } from 'src/app/core/auth/selectors';
 import { CoreState } from 'src/app/core/core-state.model';
@@ -23,6 +16,10 @@ import { NotificationsService } from '../../shared/notifications/notifications.s
 @Injectable({
   providedIn: 'root',
 })
+/**
+ * This service is responsible to communicate with the epersonRegistrationService to update the RegistrationData
+ * provided by the user.
+ */
 export class ExternalLoginService {
 
   constructor(

src/app/external-login-page/external-login-page.component.ts

@@ -1,19 +1,8 @@
-import {
-  AsyncPipe,
-  NgIf,
-} from '@angular/common';
-import {
-  Component,
-  OnInit,
-} from '@angular/core';
+import { AsyncPipe, NgIf, } from '@angular/common';
+import { Component, OnInit, } from '@angular/core';
 import { ActivatedRoute } from '@angular/router';
 import { TranslateModule } from '@ngx-translate/core';
-import {
-  first,
-  map,
-  Observable,
-  tap,
-} from 'rxjs';
+import { first, map, Observable, tap, } from 'rxjs';
 
 import { RemoteData } from '../core/data/remote-data';
 import { Registration } from '../core/shared/registration.model';
@@ -34,6 +23,9 @@ import { hasNoValue } from '../shared/empty.util';
   ],
   standalone: true,
 })
+/**
+ * This component is a wrapper of the external-login component that loads up the RegistrationData.
+ */
 export class ExternalLoginPageComponent implements OnInit {
   /**
    * The token used to get the registration data,

src/app/external-login-review-account-info-page/external-login-review-account-info-page.component.ts

@@ -1,18 +1,7 @@
-import {
-  AsyncPipe,
-  NgIf,
-} from '@angular/common';
-import {
-  Component,
-  OnInit,
-} from '@angular/core';
+import { AsyncPipe, NgIf, } from '@angular/common';
+import { Component, OnInit, } from '@angular/core';
 import { ActivatedRoute } from '@angular/router';
-import {
-  first,
-  map,
-  Observable,
-  tap,
-} from 'rxjs';
+import { first, map, Observable, tap, } from 'rxjs';
 
 import { RemoteData } from '../core/data/remote-data';
 import { Registration } from '../core/shared/registration.model';
@@ -32,6 +21,9 @@ import { ReviewAccountInfoComponent } from './review-account-info/review-account
   ],
   standalone: true,
 })
+/**
+ * This component is a wrapper for review-account-info component responsible to provide RegistrationData.
+ */
 export class ExternalLoginReviewAccountInfoPageComponent implements OnInit {
   /**
    * The token used to get the registration data