Merge branch 'feature/RELEASE-123' into fix/CB2-10419

package.json

@@ -47,7 +47,7 @@
     "@angular/router": "^17.2.1",
     "@azure/msal-angular": "^3.0.13",
     "@azure/msal-browser": "^3.10.0",
-    "@dvsa/cvs-type-definitions": "^6.1.0",
+    "@dvsa/cvs-type-definitions": "^6.3.0",
     "@ngrx/effects": "^17.1.0",
     "@ngrx/entity": "^17.1.0",
     "@ngrx/router-store": "^17.1.0",

src/app/features/tech-record/components/tech-record-amend-vrm/tech-record-amend-vrm.component.html

@@ -1,4 +1,10 @@
 <div *ngIf="techRecord">
+  <app-field-warning-message
+    *ngIf="showWarning"
+    [warningMessage]="
+      'Cherished transfers will update the VRM on the most recent test record for HGVs and PSVs, where an annual test certificate has been generated'
+    "
+  ></app-field-warning-message>
   <h2 class="govuk-heading-l">{{ makeAndModel }}</h2>
 
   <dl class="govuk-summary-list">

src/app/features/tech-record/components/tech-record-amend-vrm/tech-record-amend-vrm.component.spec.ts

@@ -1,6 +1,4 @@
-import {
-  ComponentFixture, fakeAsync, TestBed,
-} from '@angular/core/testing';
+import { ComponentFixture, fakeAsync, TestBed } from '@angular/core/testing';
 import { ReactiveFormsModule } from '@angular/forms';
 import { ActivatedRoute, ActivatedRouteSnapshot, Router } from '@angular/router';
 import { RouterTestingModule } from '@angular/router/testing';
@@ -31,6 +29,7 @@ const mockTechRecordService = {
   validateVrmDoesNotExist: jest.fn(),
   validateVrmForCherishedTransfer: jest.fn(),
   checkVrmNotActive: jest.fn(),
+  getVehicleTypeWithSmallTrl: jest.fn(),
 };
 
 const mockDynamicFormService = {
@@ -170,4 +169,34 @@ describe('TechRecordChangeVrmComponent', () => {
       );
     });
   });
+
+  describe('showWarning', () => {
+    it('should return true if the vehicle type is a psv', () => {
+      component.techRecord = { techRecord_vehicleType: 'psv' } as VehiclesOtherThan<'trl'>;
+      mockTechRecordService.getVehicleTypeWithSmallTrl.mockReturnValue('psv');
+
+      expect(component.showWarning).toBe(true);
+    });
+
+    it('should return true if the vehicle type is a hgv', () => {
+      component.techRecord = { techRecord_vehicleType: 'hgv' } as VehiclesOtherThan<'trl'>;
+      mockTechRecordService.getVehicleTypeWithSmallTrl.mockReturnValue('hgv');
+
+      expect(component.showWarning).toBe(true);
+    });
+
+    it('should return false if the vehicle type is not a psv or hgv', () => {
+      component.techRecord = { techRecord_vehicleType: 'lgv' } as VehiclesOtherThan<'trl'>;
+      mockTechRecordService.getVehicleTypeWithSmallTrl.mockReturnValue('lgv');
+
+      expect(component.showWarning).toBe(false);
+    });
+
+    it('should default to false if the vehicle type is not present', () => {
+      component.techRecord = undefined;
+      mockTechRecordService.getVehicleTypeWithSmallTrl.mockReturnValue(undefined);
+
+      expect(component.showWarning).toBe(false);
+    });
+  });
 });

src/app/features/tech-record/components/tech-record-amend-vrm/tech-record-amend-vrm.component.ts

@@ -169,4 +169,11 @@ export class AmendVrmComponent implements OnDestroy, OnInit {
     }
     return true;
   }
+
+  get showWarning(): boolean {
+    if (this.vehicleType) {
+      return this.vehicleType === 'psv' || this.vehicleType === 'hgv';
+    }
+    return false;
+  }
 }

src/app/features/tech-record/components/tech-record-edit-additional-examiner-note/tech-record-edit-additional-examiner-note.component.html

@@ -0,0 +1,31 @@
+<div *ngIf="currentTechRecord">
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-full">
+      <dl class="govuk-summary-list">
+        <h1 class="govuk-heading-l">Edit Additional Examiner Note</h1>
+        <div class="parent-div">
+          <td class="govuk-heading-s">Date</td>
+          <td class="table-value">{{ examinerNoteObj.createdAtDate | date: 'dd/MM/yyyy' | defaultNullOrEmpty }}</td>
+          <td class="govuk-heading-s">Created by</td>
+          <td class="table-value">{{ examinerNoteObj.lastUpdatedBy }}</td>
+        </div>
+        <div class="govuk-summary-list__row">
+          <form [formGroup]="form">
+            <app-text-area
+              #examinerNote
+              formControlName="additionalExaminerNote"
+              name="AdditionalExaminerNote"
+              [width]="width.L"
+              (ngModelChange)="ngOnChanges(examinerNote.value)"
+            >
+            </app-text-area>
+          </form>
+        </div>
+      </dl>
+    </div>
+  </div>
+  <app-button-group>
+    <app-button id="submit-examiner-note" (clicked)="handleSubmit()">Save</app-button>
+    <app-button id="cancel-amend-examiner-note" design="link" data-module="govuk-button" (clicked)="navigateBack()">Cancel</app-button>
+  </app-button-group>
+</div>

src/app/features/tech-record/components/tech-record-edit-additional-examiner-note/tech-record-edit-additional-examiner-note.component.scss

@@ -0,0 +1,8 @@
+.parent-div {
+  display: flex;
+  flex-direction: row;
+}
+.table-value {
+  margin-left: 1%;
+  margin-right: 1%;
+}

src/app/features/tech-record/components/tech-record-edit-additional-examiner-note/tech-record-edit-additional-examiner-note.component.spec.ts

@@ -0,0 +1,95 @@
+import { ComponentFixture, TestBed } from '@angular/core/testing';
+import { DynamicFormsModule } from '@forms/dynamic-forms.module';
+import { FormsModule, ReactiveFormsModule } from '@angular/forms';
+import { RouterTestingModule } from '@angular/router/testing';
+import { TechnicalRecordService } from '@services/technical-record/technical-record.service';
+import { MockStore, provideMockStore } from '@ngrx/store/testing';
+import { initialAppState } from '@store/index';
+import { ActivatedRoute, Router } from '@angular/router';
+import { of } from 'rxjs';
+import { GlobalErrorService } from '@core/components/global-error/global-error.service';
+import { TechRecordEditAdditionalExaminerNoteComponent } from './tech-record-edit-additional-examiner-note.component';
+
+const mockTechRecordService = {
+  techRecord$: jest.fn(),
+};
+describe('TechRecordEditAdditionalExaminerNoteComponent', () => {
+  let fixture: ComponentFixture<TechRecordEditAdditionalExaminerNoteComponent>;
+  let component: TechRecordEditAdditionalExaminerNoteComponent;
+  let router: Router;
+  let errorService: GlobalErrorService;
+  let route: ActivatedRoute;
+  let store: MockStore;
+
+  beforeEach(async () => {
+    await TestBed.configureTestingModule({
+      declarations: [TechRecordEditAdditionalExaminerNoteComponent],
+      imports: [DynamicFormsModule, FormsModule, ReactiveFormsModule, RouterTestingModule],
+      providers: [
+        { provide: TechnicalRecordService, useValue: mockTechRecordService },
+        provideMockStore({ initialState: initialAppState }),
+        { provide: ActivatedRoute, useValue: { params: of([{ id: 1 }]) } },
+      ],
+    }).compileComponents();
+    fixture = TestBed.createComponent(TechRecordEditAdditionalExaminerNoteComponent);
+    component = fixture.componentInstance;
+    router = TestBed.inject(Router);
+    errorService = TestBed.inject(GlobalErrorService);
+    route = TestBed.inject(ActivatedRoute);
+    store = TestBed.inject(MockStore);
+  });
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+  describe('ngOnInit', () => {
+    it('should call all initialisation functions', () => {
+      const examinerNoteSpy = jest.spyOn(component, 'getExaminerNote').mockReturnValue();
+      const techRecordSpy = jest.spyOn(component, 'getTechRecord').mockReturnValue();
+      const formSpy = jest.spyOn(component, 'setupForm').mockReturnValue();
+      component.ngOnInit();
+      expect(examinerNoteSpy).toHaveBeenCalled();
+      expect(formSpy).toHaveBeenCalled();
+      expect(techRecordSpy).toHaveBeenCalled();
+    });
+  });
+  describe('navigateBack', () => {
+    it('should clear all errors', () => {
+      jest.spyOn(router, 'navigate').mockImplementation();
+
+      const clearErrorsSpy = jest.spyOn(errorService, 'clearErrors');
+
+      component.navigateBack();
+
+      expect(clearErrorsSpy).toHaveBeenCalledTimes(1);
+    });
+
+    it('should navigate back to the previous page', () => {
+      const navigateSpy = jest.spyOn(router, 'navigate').mockImplementation(() => Promise.resolve(true));
+
+      component.navigateBack();
+
+      expect(navigateSpy).toHaveBeenCalledWith(['../../'], { relativeTo: route });
+    });
+  });
+  describe('handleSubmit', () => {
+    it('should not dispatch an action if the notes are the same', () => {
+      const storeSpy = jest.spyOn(store, 'dispatch');
+      const navigateBackSpy = jest.spyOn(component, 'navigateBack').mockReturnValue();
+      component.originalExaminerNote = 'foobar';
+      component.editedExaminerNote = 'foobar';
+      component.handleSubmit();
+      expect(storeSpy).not.toHaveBeenCalled();
+      expect(navigateBackSpy).toHaveBeenCalled();
+    });
+
+    it('should dispatch an action if the notes are not the same', () => {
+      const storeSpy = jest.spyOn(store, 'dispatch');
+      const navigateBackSpy = jest.spyOn(component, 'navigateBack').mockReturnValue();
+      component.originalExaminerNote = 'foo';
+      component.editedExaminerNote = 'bar';
+      component.handleSubmit();
+      expect(storeSpy).toHaveBeenCalled();
+      expect(navigateBackSpy).toHaveBeenCalled();
+    });
+  });
+});

src/app/features/tech-record/components/tech-record-edit-additional-examiner-note/tech-record-edit-additional-examiner-note.component.ts

@@ -0,0 +1,108 @@
+import { Component, OnInit } from '@angular/core';
+import { ActivatedRoute, Router } from '@angular/router';
+import { TechnicalRecordService } from '@services/technical-record/technical-record.service';
+import { TechRecordType } from '@dvsa/cvs-type-definitions/types/v3/tech-record/tech-record-vehicle-type';
+import { ReplaySubject, take, takeUntil } from 'rxjs';
+import { GlobalErrorService } from '@core/components/global-error/global-error.service';
+import {
+  CustomFormControl,
+  FormNodeEditTypes,
+  FormNodeTypes,
+  FormNodeWidth,
+} from '@forms/services/dynamic-form.types';
+import { FormGroup, Validators } from '@angular/forms';
+import { Store } from '@ngrx/store';
+import { State } from '@store/index';
+import { updateExistingADRAdditionalExaminerNote } from '@store/technical-records';
+import { AdditionalExaminerNotes } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/hgv/complete';
+
+@Component({
+  selector: 'tech-record-edit-additional-examiner-note',
+  templateUrl: './tech-record-edit-additional-examiner-note.component.html',
+  styleUrls: ['./tech-record-edit-additional-examiner-note.component.scss'],
+})
+export class TechRecordEditAdditionalExaminerNoteComponent implements OnInit {
+  currentTechRecord!: TechRecordType<'hgv' | 'trl' | 'lgv'>;
+  examinerNoteIndex!: number;
+  editedExaminerNote: string = '';
+  originalExaminerNote: string = '';
+  examinerNoteObj!: AdditionalExaminerNotes;
+  destroy$ = new ReplaySubject<boolean>(1);
+  form!: FormGroup;
+  formControl!: CustomFormControl;
+
+  constructor(
+    private router: Router,
+    private route: ActivatedRoute,
+    private technicalRecordService: TechnicalRecordService,
+    private globalErrorService: GlobalErrorService,
+    private store: Store<State>,
+  ) { }
+
+  ngOnInit() {
+    this.getTechRecord();
+    this.getExaminerNote();
+    this.setupForm();
+  }
+
+  getTechRecord() {
+    this.technicalRecordService.techRecord$.pipe(takeUntil(this.destroy$)).subscribe((currentTechRecord) => {
+      this.currentTechRecord = currentTechRecord as TechRecordType<'hgv' | 'lgv' | 'trl'>;
+    });
+  }
+
+  getExaminerNote() {
+    this.route.params.pipe(take(1)).subscribe((params) => {
+      this.examinerNoteIndex = params['examinerNoteIndex'];
+    });
+    const additionalExaminerNotes = this.currentTechRecord?.techRecord_adrDetails_additionalExaminerNotes;
+    if (additionalExaminerNotes) {
+      const examinerNote = additionalExaminerNotes[this.examinerNoteIndex].note;
+      if (examinerNote) {
+        this.examinerNoteObj = additionalExaminerNotes[this.examinerNoteIndex];
+        this.originalExaminerNote = examinerNote;
+        this.editedExaminerNote = examinerNote;
+      }
+    }
+  }
+
+  setupForm() {
+    this.formControl = new CustomFormControl({
+      name: 'additionalExaminerNote', type: FormNodeTypes.CONTROL,
+    }, '', [Validators.required]);
+    this.form = new FormGroup({
+      additionalExaminerNote: this.formControl,
+    });
+    this.formControl.patchValue(this.editedExaminerNote);
+  }
+
+  navigateBack() {
+    this.globalErrorService.clearErrors();
+    void this.router.navigate(['../../'], { relativeTo: this.route });
+  }
+
+  handleSubmit(): void {
+    if (this.originalExaminerNote !== this.editedExaminerNote) {
+      this.store.dispatch(
+        updateExistingADRAdditionalExaminerNote({
+          examinerNoteIndex: this.examinerNoteIndex,
+          additionalExaminerNote: this.editedExaminerNote,
+        }),
+      );
+    }
+    this.navigateBack();
+  }
+
+  ngOnChanges(examinerNote: string) {
+    this.editedExaminerNote = examinerNote;
+  }
+
+  get editTypes(): typeof FormNodeEditTypes {
+    return FormNodeEditTypes;
+  }
+
+  get width(): typeof FormNodeWidth {
+    return FormNodeWidth;
+  }
+
+}