feat(cb2-12692): Implement Types Definition into cert-gen (#197)

* feat(cb2-12692): use types definition and common constants * feat(cb2-12692): use types definition and common constants
dvsa · Nov 18, 2024 · 87449da · 87449da
1 parent 76a4635
commit 87449da
Show file tree

Hide file tree

Showing 21 changed files with 1,053 additions and 518 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -58,7 +58,8 @@
     "@aws-sdk/client-s3": "^3.564.0",
     "@aws-sdk/client-secrets-manager": "^3.564.0",
     "@dvsa/cvs-feature-flags": "^0.13.0",
-    "@dvsa/cvs-type-definitions": "^2.1.11",
+    "@dvsa/cvs-type-definitions": "^7.6.3",
+    "@dvsa/cvs-microservice-common": "^1.2.4",
     "@smithy/types": "^2.12.0",
     "@smithy/util-utf8": "^2.3.0",
     "aws-lambda": "^1.0.5",

diff --git a/src/certificate/commands/DefectsCommand.ts b/src/certificate/commands/DefectsCommand.ts
@@ -1,11 +1,10 @@
 import { Service } from 'typedi';
 import { DefectRepository } from '../../defect/DefectRepository';
 import { DefectService } from '../../defect/DefectService';
-import { ITestResult } from '../../models';
+import { IFlatDefect, ITestResult } from '../../models';
 import { ICertificatePayload } from '../../models';
 import { ITestType } from '../../models';
 import { CERTIFICATE_DATA, TEST_RESULTS } from '../../models/Enums';
-import { IFlatDefect } from '../../models/IFlatDefect';
 import { BasePayloadCommand } from '../ICertificatePayloadCommand';
 
 @Service()

diff --git a/src/defect/DefectRepository.ts b/src/defect/DefectRepository.ts
@@ -1,10 +1,9 @@
 import { InvocationRequest, InvocationResponse } from '@aws-sdk/client-lambda';
 import { toUint8Array } from '@smithy/util-utf8';
 import { Service } from 'typedi';
-import { IInvokeConfig } from '../models';
+import { IDefectParent, IInvokeConfig } from '../models';
 import { ERRORS } from '../models/Enums';
 import { HTTPError } from '../models/HTTPError';
-import { IDefectParent } from '../models/IDefectParent';
 import { LambdaService } from '../services/LambdaService';
 import { Configuration } from '../utils/Configuration';
 

diff --git a/src/defect/DefectService.ts b/src/defect/DefectService.ts
@@ -1,10 +1,6 @@
 import { Service } from 'typedi';
-import { ICustomDefect } from '../models';
+import { ICustomDefect, IDefectChild, IDefectParent, IFlatDefect, IItem } from '../models';
 import { CERTIFICATE_DATA, IVA_30, LOCATION_ENGLISH, LOCATION_WELSH, TEST_RESULTS } from '../models/Enums';
-import { IDefectChild } from '../models/IDefectChild';
-import { IDefectParent } from '../models/IDefectParent';
-import { IFlatDefect } from '../models/IFlatDefect';
-import { IItem } from '../models/IItem';
 import { TestResultService } from '../test-result/TestResultService';
 
 @Service()

diff --git a/src/functions/CertificateRequestProcessor.ts b/src/functions/CertificateRequestProcessor.ts
@@ -1,8 +1,9 @@
 import { DeleteObjectCommandOutput, PutObjectCommandOutput } from '@aws-sdk/client-s3';
+import { TestStatus } from '@dvsa/cvs-type-definitions/types/v1/enums/testStatus.enum';
 import { Service } from 'typedi';
 import { validate as uuidValidate } from 'uuid';
 import { ITestResult } from '../models';
-import { ERRORS, TEST_RESULT_STATUS } from '../models/Enums';
+import { ERRORS } from '../models/Enums';
 import { CertificateGenerationService } from '../services/CertificateGenerationService';
 import { CertificateUploadService } from '../services/CertificateUploadService';
 
@@ -16,7 +17,7 @@ export class CertificateRequestProcessor {
 	) {}
 
 	public async process(testResult: ITestResult): Promise<CertGenReturn> {
-		const isCancelled = testResult.testStatus === TEST_RESULT_STATUS.CANCELLED;
+		const isCancelled = testResult.testStatus === TestStatus.CANCELLED;
 		if (isCancelled) {
 			return this.remove(testResult);
 		}

diff --git a/src/models/Enums.ts b/src/models/Enums.ts
@@ -21,11 +21,6 @@ export enum TEST_RESULTS {
 	PRS = 'prs',
 }
 
-export enum TEST_RESULT_STATUS {
-	SUBMITTED = 'submitted',
-	CANCELLED = 'cancelled',
-}
-
 export enum CERTIFICATE_DATA {
 	RWT_DATA = 'RWT_DATA',
 	PASS_DATA = 'PASS_DATA',
@@ -68,53 +63,6 @@ export enum IVA_30 {
 	EMPTY_CUSTOM_DEFECTS = 'N/A',
 }
 
-export const ADR_TEST = {
-	IDS: ['50', '59', '60'],
-};
-
-export const BASIC_IVA_TEST = {
-	IDS: ['125', '129', '154', '158', '159', '185'],
-};
-
-export const IVA30_TEST = {
-	IDS: [
-		'125',
-		'126',
-		'128',
-		'129',
-		'130',
-		'153',
-		'154',
-		'158',
-		'159',
-		'161',
-		'162',
-		'163',
-		'184',
-		'185',
-		'186',
-		'187',
-		'188',
-		'189',
-		'190',
-		'191',
-		'192',
-		'193',
-		'194',
-		'195',
-		'196',
-		'197',
-	],
-};
-
-export const MSVA30_TEST = {
-	IDS: ['133', '134', '135', '136', '138', '139', '140', '166', '167', '169', '170', '172', '173'],
-};
-
-export const HGV_TRL_ROADWORTHINESS_TEST_TYPES = {
-	IDS: ['62', '63', '91', '101', '122'],
-};
-
 export const AVAILABLE_WELSH = {
 	CERTIFICATES: [
 		'hgv_pass',

diff --git a/src/models/IDefectChild.ts b/src/models/IDefectChild.ts
diff --git a/src/models/IDefectParent.ts b/src/models/IDefectParent.ts
diff --git a/src/models/IFlatDefect.ts b/src/models/IFlatDefect.ts
diff --git a/src/models/IItem.ts b/src/models/IItem.ts
diff --git a/src/models/ISecret.ts b/src/models/ISecret.ts
diff --git a/src/models/ITestStations.ts b/src/models/ITestStations.ts
diff --git a/src/models/Types.ts b/src/models/Types.ts
@@ -1,53 +1,38 @@
-import { TechRecordCompleteCarSchema } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/car/complete';
-import { TechRecordSkeletonCarSchema } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/car/skeleton';
-import { GETHGVTechnicalRecordV3Complete } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/hgv/complete';
-import { GETHGVTechnicalRecordV3Skeleton } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/hgv/skeleton';
-import { GETHGVTechnicalRecordV3Testable } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/hgv/testable';
-import { TechRecordCompleteMotorcycleSchema } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/motorcycle/complete';
-import { GETPSVTechnicalRecordV3Complete } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/psv/complete';
-import { GETPSVTechnicalRecordV3Skeleton } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/psv/skeleton';
-import { GETPSVTechnicalRecordV3Testable } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/psv/testable';
-import { GETTRLTechnicalRecordV3Complete } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/trl/complete';
-import { GETTRLTechnicalRecordV3Skeleton } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/trl/skeleton';
-import { GETTRLTechnicalRecordV3Testable } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/trl/testable';
+import { TechRecordGETCarComplete } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/car/complete';
+import { TechRecordGETCarSkeleton } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/car/skeleton';
+import { TechRecordGETHGVComplete } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/hgv/complete';
+import { TechRecordGETHGVSkeleton } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/hgv/skeleton';
+import { TechRecordGETHGVTestable } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/hgv/testable';
+import { TechRecordGETMotorcycleComplete } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/motorcycle/complete';
+import { TechRecordGETPSVComplete } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/psv/complete';
+import { TechRecordGETPSVSkeleton } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/psv/skeleton';
+import { TechRecordGETPSVTestable } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/psv/testable';
+import { TechRecordGETTRLComplete } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/trl/complete';
+import { TechRecordGETTRLSkeleton } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/trl/skeleton';
+import { TechRecordGETTRLTestable } from '@dvsa/cvs-type-definitions/types/v3/tech-record/get/trl/testable';
 
 export type TechRecordGet =
-	| TechRecordCompleteCarSchema
-	| TechRecordSkeletonCarSchema
-	| GETHGVTechnicalRecordV3Complete
-	| GETHGVTechnicalRecordV3Testable
-	| GETHGVTechnicalRecordV3Skeleton
-	| TechRecordCompleteMotorcycleSchema
-	| GETPSVTechnicalRecordV3Complete
-	| GETPSVTechnicalRecordV3Testable
-	| GETPSVTechnicalRecordV3Skeleton
-	| GETTRLTechnicalRecordV3Complete
-	| GETTRLTechnicalRecordV3Testable
-	| GETTRLTechnicalRecordV3Skeleton;
+	| TechRecordGETCarComplete
+	| TechRecordGETCarSkeleton
+	| TechRecordGETHGVComplete
+	| TechRecordGETHGVTestable
+	| TechRecordGETHGVSkeleton
+	| TechRecordGETMotorcycleComplete
+	| TechRecordGETPSVComplete
+	| TechRecordGETPSVTestable
+	| TechRecordGETPSVSkeleton
+	| TechRecordGETTRLComplete
+	| TechRecordGETTRLTestable
+	| TechRecordGETTRLSkeleton;
 
 export type TechRecordType<T extends TechRecordGet['techRecord_vehicleType']> = T extends 'car' | 'lgv'
-	? TechRecordCompleteCarSchema
+	? TechRecordGETCarComplete
 	: T extends 'hgv'
-		? GETHGVTechnicalRecordV3Complete | GETHGVTechnicalRecordV3Testable
+		? TechRecordGETHGVComplete | TechRecordGETHGVTestable
 		: T extends 'motorcycle'
-			? TechRecordCompleteMotorcycleSchema
+			? TechRecordGETMotorcycleComplete
 			: T extends 'psv'
-				? GETPSVTechnicalRecordV3Complete | GETPSVTechnicalRecordV3Testable
+				? TechRecordGETPSVComplete | TechRecordGETPSVTestable
 				: T extends 'trl'
-					? GETTRLTechnicalRecordV3Complete | GETTRLTechnicalRecordV3Testable
+					? TechRecordGETTRLComplete | TechRecordGETTRLTestable
 					: never;
-
-export interface ISearchResult {
-	systemNumber: string;
-	createdTimestamp: string;
-	vin: string;
-	primaryVrm?: string;
-	trailerId?: string;
-	techRecord_vehicleType: string;
-	techRecord_manufactureYear?: number | null;
-	techRecord_chassisMake?: string;
-	techRecord_chassisModel?: string;
-	techRecord_make?: string;
-	techRecord_model?: string;
-	techRecord_statusCode?: string;
-}