@dvsa/cvs-type-definitions 1.0.11 → 2.0.12

package/package.json

@@ -1,33 +1,38 @@
 {
   "name": "@dvsa/cvs-type-definitions",
-  "version": "1.0.11",
+  "version": "2.0.12",
   "description": "type definitions for cvs vta application",
   "main": "index.js",
   "files": [
     "lib/**/*",
     "json-schemas/**/*",
-    "types/**/*"
+    "types/**/*",
+    "src/**/*",
+    "schemas.ts"
   ],
   "repository": {
     "url": "git://github.com/dvsa/cvs-type-definitions.git"
   },
   "scripts": {
     "build": "tsc",
-    "test": "test",
+    "test": "npm run generate && jest",
     "generate": "ts-node generateSchemas.ts"
   },
   "author": "dvsa",
   "license": "ISC",
   "devDependencies": {
-    "@types/node": "^18.11.5",
+    "@jest/globals": "^29.5.0",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^18.16.7",
+    "jest": "^29.5.0",
     "json-schema-to-typescript": "^11.0.2",
+    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.1.0",
     "typescript": "^4.8.4"
   },
   "dependencies": {
-    "enjoi": "^9.0.1",
-    "joi": "^17.6.4",
+    "ajv": "^8.12.0",
     "json-schema-deref-sync": "^0.14.0",
     "pretty-js": "^0.2.2",
     "util": "^0.12.5"

package/schemas.ts

@@ -0,0 +1,49 @@
+export const schemas = [
+  "v1/activity/index.json",
+  "v1/defect-category-reference-data/index.json",
+  "v1/defect-details/index.json",
+  "v1/defect-location/index.json",
+  "v1/reason-item/index.json",
+  "v1/tech-record/index.json",
+  "v1/test/index.json",
+  "v1/test-result/index.json",
+  "v1/test-station/index.json",
+  "v1/test-type/index.json",
+  "v1/vehicle/index.json",
+  "v1/vehicle-tech-record/index.json",
+  "v1/visit/index.json",
+  "v3/tech-record/get/car/complete/index.json",
+  "v3/tech-record/get/car/skeleton/index.json",
+  "v3/tech-record/get/hgv/complete/index.json",
+  "v3/tech-record/get/hgv/skeleton/index.json",
+  "v3/tech-record/get/hgv/testable/index.json",
+  "v3/tech-record/get/lgv/complete/index.json",
+  "v3/tech-record/get/lgv/skeleton/index.json",
+  "v3/tech-record/get/motorcycle/complete/index.json",
+  "v3/tech-record/get/motorcycle/skeleton/index.json",
+  "v3/tech-record/get/psv/complete/index.json",
+  "v3/tech-record/get/psv/skeleton/index.json",
+  "v3/tech-record/get/psv/testable/index.json",
+  "v3/tech-record/get/search/complete/index.json",
+  "v3/tech-record/get/search/skeleton/index.json",
+  "v3/tech-record/get/trl/complete/index.json",
+  "v3/tech-record/get/trl/skeleton/index.json",
+  "v3/tech-record/get/trl/testable/index.json",
+  "v3/tech-record/post/psv/complete/index.json",
+  "v3/tech-record/post/psv/skeleton/index.json",
+  "v3/tech-record/post/psv/testable/index.json",
+  "v3/tech-record/put/car/complete/request/index.json",
+  "v3/tech-record/put/car/complete/response/index.json",
+  "v3/tech-record/put/car/skeleton/request/index.json",
+  "v3/tech-record/put/car/skeleton/response/index.json",
+  "v3/tech-record/put/hgv/complete/index.json",
+  "v3/tech-record/put/hgv/skeleton/index.json",
+  "v3/tech-record/put/hgv/testable/index.json",
+  "v3/tech-record/put/lgv/complete/request/index.json",
+  "v3/tech-record/put/lgv/complete/response/index.json",
+  "v3/tech-record/put/lgv/skeleton/request/index.json",
+  "v3/tech-record/put/lgv/skeleton/response/index.json",
+  "v3/tech-record/put/trl/complete/index.json",
+  "v3/tech-record/put/trl/skeleton/index.json",
+  "v3/tech-record/put/trl/testable/index.json",
+] as const;

package/src/schema-validation/schema-validator.ts

@@ -0,0 +1,25 @@
+import Ajv from "ajv";
+import { schemas } from "../../schemas";
+
+export type Schema = typeof schemas[number];
+
+export const isValidObject = (
+  schemaName: Schema,
+  objectToValidate: object,
+  logErrors = false
+): boolean => {
+  const ajv = new Ajv({ removeAdditional: true, allErrors: true });
+  const schemaPath = `json-schemas/${schemaName}`;
+  const schema = require(schemaPath);
+
+  const validateFunction = ajv.compile(schema);
+  const isValid = validateFunction(objectToValidate);
+
+  if(logErrors && validateFunction.errors){
+    console.error(validateFunction.errors)
+  }
+
+ return isValid
+
+
+};

package/types/v3/tech-record/get/car/complete/index.d.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type EUVehicleCategory =
+  | "m1"
+  | "m2"
+  | "m3"
+  | "n1"
+  | "n2"
+  | "n3"
+  | "o1"
+  | "o2"
+  | "o3"
+  | "o4"
+  | "l1e-a"
+  | "l1e"
+  | "l2e"
+  | "l3e"
+  | "l4e"
+  | "l5e"
+  | "l6e"
+  | "l7e";
+export type StatusCode = "provisional" | "current" | "archived";
+export type VehicleConfiguration =
+  | "rigid"
+  | "articulated"
+  | "centre axle drawbar"
+  | "semi-car transporter"
+  | "semi-trailer"
+  | "long semi-trailer"
+  | "low loader"
+  | "other"
+  | "drawbar"
+  | "four-in-line"
+  | "dolly"
+  | "full drawbar";
+export type VehicleType = "psv" | "trl" | "hgv" | "car" | "lgv" | "motorcycle";
+export type VehicleSubclass = ("n" | "p" | "a" | "s" | "c" | "l" | "t" | "e" | "m" | "r" | "w")[];
+
+export interface TechRecordCompleteCarSchema {
+  techRecord_applicantDetails_name?: string | null;
+  techRecord_applicantDetails_address1?: null | string;
+  techRecord_applicantDetails_address2?: null | string;
+  techRecord_applicantDetails_postTown?: null | string;
+  techRecord_applicantDetails_address3?: null | string;
+  techRecord_applicantDetails_postCode?: null | string;
+  techRecord_applicantDetails_telephoneNumber?: null | string;
+  techRecord_applicantDetails_emailAddress?: null | string;
+  createdTimestamp: string;
+  partialVin?: string;
+  primaryVrm?: string;
+  systemNumber: string;
+  techRecord_createdAt?: string;
+  techRecord_createdById?: string;
+  techRecord_createdByName?: string;
+  techRecord_euVehicleCategory?: EUVehicleCategory;
+  techRecord_lastUpdatedAt?: string | null;
+  techRecord_lastUpdatedById?: string | null;
+  techRecord_lastUpdatedByName?: string | null;
+  techRecord_manufactureYear?: string | null;
+  techRecord_recordCompleteness?: string;
+  techRecord_noOfAxles?: number;
+  techRecord_reasonForCreation?: string;
+  techRecord_regnDate?: string | null;
+  techRecord_statusCode?: StatusCode;
+  techRecord_vehicleConfiguration?: VehicleConfiguration;
+  techRecord_vehicleType?: VehicleType;
+  vin?: string;
+  vehicleSubclass: VehicleSubclass;
+}

package/types/v3/tech-record/get/car/skeleton/index.d.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type EUVehicleCategory =
+  | "m1"
+  | "m2"
+  | "m3"
+  | "n1"
+  | "n2"
+  | "n3"
+  | "o1"
+  | "o2"
+  | "o3"
+  | "o4"
+  | "l1e-a"
+  | "l1e"
+  | "l2e"
+  | "l3e"
+  | "l4e"
+  | "l5e"
+  | "l6e"
+  | "l7e";
+export type StatusCode = "provisional" | "current" | "archived";
+export type VehicleConfiguration =
+  | "rigid"
+  | "articulated"
+  | "centre axle drawbar"
+  | "semi-car transporter"
+  | "semi-trailer"
+  | "long semi-trailer"
+  | "low loader"
+  | "other"
+  | "drawbar"
+  | "four-in-line"
+  | "dolly"
+  | "full drawbar";
+export type VehicleType = "psv" | "trl" | "hgv" | "car" | "lgv" | "motorcycle";
+
+export interface TechRecordSkeletonCarSchema {
+  techRecord_applicantDetails_name?: string | null;
+  techRecord_applicantDetails_address1?: null | string;
+  techRecord_applicantDetails_address2?: null | string;
+  techRecord_applicantDetails_postTown?: null | string;
+  techRecord_applicantDetails_address3?: null | string;
+  techRecord_applicantDetails_postCode?: null | string;
+  techRecord_applicantDetails_telephoneNumber?: null | string;
+  techRecord_applicantDetails_emailAddress?: null | string;
+  createdTimestamp: string;
+  partialVin?: string;
+  primaryVrm?: string;
+  systemNumber: string;
+  techRecord_createdAt?: string;
+  techRecord_createdById?: string;
+  techRecord_createdByName?: string;
+  techRecord_euVehicleCategory?: EUVehicleCategory;
+  techRecord_lastUpdatedAt?: string | null;
+  techRecord_lastUpdatedById?: string | null;
+  techRecord_lastUpdatedByName?: string | null;
+  techRecord_manufactureYear?: string | null;
+  techRecord_recordCompleteness?: string;
+  techRecord_noOfAxles?: number;
+  techRecord_reasonForCreation?: string;
+  techRecord_regnDate?: string | null;
+  techRecord_statusCode?: StatusCode;
+  techRecord_vehicleConfiguration?: VehicleConfiguration;
+  techRecord_vehicleType?: VehicleType;
+  vin?: string;
+}

package/types/v3/tech-record/get/hgv/complete/index.d.ts

@@ -0,0 +1,285 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type TC2Types = "initial";
+export type TC3Types = "intermediate" | "periodic" | "exceptional";
+export type FitmentCode = "single" | "double";
+export type EUVehicleCategory =
+  | "m1"
+  | "m2"
+  | "m3"
+  | "n1"
+  | "n2"
+  | "n3"
+  | "o1"
+  | "o2"
+  | "o3"
+  | "o4"
+  | "l1e-a"
+  | "l1e"
+  | "l2e"
+  | "l3e"
+  | "l4e"
+  | "l5e"
+  | "l6e"
+  | "l7e";
+export type FuelPropulsionSystem =
+  | "DieselPetrol"
+  | "Diesel"
+  | "Petrol"
+  | "Hybrid"
+  | "Electric"
+  | "CNG"
+  | "Fuel cell"
+  | "LNG"
+  | "Other";
+export type MicrofilmDocumentTypes =
+  | "PSV Miscellaneous"
+  | "AAT - Trailer Annual Test"
+  | "AIV - HGV International App"
+  | "COIF Modification"
+  | "Trailer COC + Int Plate"
+  | "RCT - Trailer Test Cert paid"
+  | "HGV COC + Int Plate"
+  | "PSV Carry/Auth"
+  | "OMO Report"
+  | "AIT - Trailer International App"
+  | "IPV - HGV EEC Plate/Cert"
+  | "XCV - HGV Test Cert free"
+  | "AAV - HGV Annual Test"
+  | "COIF Master"
+  | "Tempo 100 Sp Ord"
+  | "Deleted"
+  | "PSV N/ALT"
+  | "XPT - Tr Plating Cert paid"
+  | "FFV - HGV First Test"
+  | "Repl Vitesse 100"
+  | "TCV - HGV Test Cert"
+  | "ZZZ -  Miscellaneous"
+  | "Test Certificate"
+  | "XCT - Trailer Test Cert free"
+  | "C52 - COC and VTG52A"
+  | "Tempo 100 Report"
+  | "Main File Amendment"
+  | "PSV Doc"
+  | "PSV COC"
+  | "PSV Repl COC"
+  | "TAV - COC"
+  | "NPT - Trailer Alteration"
+  | "OMO Certificate"
+  | "PSV Repl COIF"
+  | "PSV Repl COF"
+  | "COIF Application"
+  | "XPV - HGV Plating Cert Free"
+  | "TCT  - Trailer Test Cert"
+  | "Tempo 100 App"
+  | "PSV Decision on N/ALT"
+  | "Special Order PSV"
+  | "NPV - HGV Alteration"
+  | "No Description Found"
+  | "Vitesse 100 Sp Ord"
+  | "Brake Test Details"
+  | "COIF Productional"
+  | "RDT - Test Disc Paid"
+  | "RCV -  HGV Test Cert"
+  | "FFT -  Trailer First Test"
+  | "IPT - Trailer EEC Plate/Cert"
+  | "XDT - Test Disc Free"
+  | "PRV - HGV Plating Cert paid"
+  | "COF Cert"
+  | "PRT - Tr Plating Cert paid"
+  | "Tempo 100 Permit";
+export type PlateReasonForIssue =
+  | "Free replacement"
+  | "Replacement"
+  | "Destroyed"
+  | "Provisional"
+  | "Original"
+  | "Manual";
+export type StatusCode = "provisional" | "current" | "archived";
+export type VehicleClassDescription =
+  | "motorbikes over 200cc or with a sidecar"
+  | "not applicable"
+  | "small psv (ie: less than or equal to 22 seats)"
+  | "motorbikes up to 200cc"
+  | "trailer"
+  | "large psv(ie: greater than 23 seats)"
+  | "3 wheelers"
+  | "heavy goods vehicle"
+  | "MOT class 4"
+  | "MOT class 7"
+  | "MOT class 5";
+export type VehicleConfiguration =
+  | "rigid"
+  | "articulated"
+  | "centre axle drawbar"
+  | "semi-car transporter"
+  | "semi-trailer"
+  | "long semi-trailer"
+  | "low loader"
+  | "other"
+  | "drawbar"
+  | "four-in-line"
+  | "dolly"
+  | "full drawbar";
+export type ApprovalType =
+  | "NTA"
+  | "ECTA"
+  | "IVA"
+  | "NSSTA"
+  | "ECSSTA"
+  | "GB WVTA"
+  | "UKNI WVTA"
+  | "EU WVTA Pre 23"
+  | "EU WVTA 23 on"
+  | "QNIG"
+  | "Prov.GB WVTA"
+  | "Small series"
+  | "IVA - VCA"
+  | "IVA - DVSA/NI";
+
+export interface GETHGVTechnicalRecordV3Complete {
+  createdTimestamp: string;
+  partialVin: string;
+  systemNumber: string;
+  techRecord_adrDetails_vehicleDetails_type?: string | null;
+  techRecord_adrDetails_vehicleDetails_approvalDate?: string | null;
+  techRecord_adrDetails_permittedDangerousGoods?: string[] | null;
+  techRecord_adrDetails_compatibilityGroupJ?: boolean | null;
+  techRecord_adrDetails_additionalExaminerNotes?: string | null;
+  techRecord_adrDetails_applicantDetails_name?: string | null;
+  techRecord_adrDetails_applicantDetails_street?: string | null;
+  techRecord_adrDetails_applicantDetails_town?: string | null;
+  techRecord_adrDetails_applicantDetails_city?: string | null;
+  techRecord_adrDetails_applicantDetails_postcode?: string | null;
+  techRecord_adrDetails_memosApply?: string[] | null;
+  techRecord_adrDetails_documents?: string[] | null;
+  techRecord_adrDetails_listStatementApplicable?: boolean | null;
+  techRecord_adrDetails_batteryListNumber?: string | null;
+  techRecord_adrDetails_brakeDeclarationsSeen?: boolean | null;
+  techRecord_adrDetails_brakeDeclarationIssuer?: string | null;
+  techRecord_adrDetails_brakeEndurance?: boolean | null;
+  techRecord_adrDetails_weight?: string | null;
+  techRecord_adrDetails_declarationsSeen?: boolean | null;
+  techRecord_adrDetails_additionalNotes_guidanceNotes?: string[] | null;
+  techRecord_adrDetails_additionalNotes_number?: string[] | null;
+  techRecord_adrDetails_adrTypeApprovalNo?: string | null;
+  techRecord_adrDetails_adrCertificateNotes?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tankManufacturer?: string | null;
+  techRecord_adrDetails_tank_tankDetails_yearOfManufacture?: number | null;
+  techRecord_adrDetails_tank_tankDetails_tankManufacturerSerialNo?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tankTypeAppNo?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tankCode?: string | null;
+  techRecord_adrDetails_tank_tankDetails_specialProvisions?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tc2Details_tc2Type?: null | TC2Types;
+  techRecord_adrDetails_tank_tankDetails_tc2Details_tc2IntermediateApprovalNo?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tc2Details_tc2IntermediateExpiryDate?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tc3Details_tc3Type?: null | TC3Types;
+  techRecord_adrDetails_tank_tankDetails_tc3Type_tc3PeriodicNumber?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tc3Type_tc3PeriodicExpiryDate?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tankStatement_substancesPermitted?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tankStatement_statement?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tankStatement_productListRefNo?: string | null;
+  techRecord_adrDetails_tank_tankDetails_tankStatement_productListUnNo?: string[] | null;
+  techRecord_adrDetails_tank_tankDetails_tankStatement_productList?: string | null;
+  techRecord_alterationMarker?: boolean | null;
+  techRecord_applicantDetails_name: string;
+  techRecord_applicantDetails_address1: null | string;
+  techRecord_applicantDetails_address2: null | string;
+  techRecord_applicantDetails_postTown: string;
+  techRecord_applicantDetails_address3?: null | string;
+  techRecord_applicantDetails_postCode?: null | string;
+  techRecord_applicantDetails_telephoneNumber?: null | string;
+  techRecord_applicantDetails_emailAddress?: null | string;
+  techRecord_applicationId?: string;
+  axles: HGVAxles[];
+  techRecord_bodyType_code: string;
+  techRecord_bodyType_description: string;
+  techRecord_brakes_antilockBrakingSystem?: string | null;
+  techRecord_brakes_dtpNumber: string;
+  techRecord_brakes_loadSensingValve?: boolean | null;
+  techRecord_conversionRefNo?: string | null;
+  techRecord_createdAt: string;
+  techRecord_createdById: string;
+  techRecord_createdByName: string;
+  techRecord_departmentalVehicleMarker?: boolean | null;
+  techRecord_dimensions_axleSpacing_axles?: string;
+  techRecord_dimensions_axleSpacing_value?: number | null;
+  techRecord_dimensions_length: number;
+  techRecord_dimensions_width: number;
+  techRecord_drawbarCouplingFitted: boolean;
+  techRecord_emissionsLimit?: null | number;
+  techRecord_euroStandard: string;
+  techRecord_euVehicleCategory: EUVehicleCategory;
+  techRecord_frontAxleToRearAxle: number;
+  techRecord_frontAxleTo5thWheelMin: number;
+  techRecord_frontAxleTo5thWheelMax: number;
+  techRecord_frontVehicleTo5thWheelCouplingMin?: number | null;
+  techRecord_frontVehicleTo5thWheelCouplingMax?: number | null;
+  techRecord_fuelPropulsionSystem: FuelPropulsionSystem;
+  techRecord_functionCode?: string | null;
+  techRecord_grossDesignWeight: number;
+  techRecord_grossEecWeight?: number | null;
+  techRecord_grossGbWeight: number;
+  techRecord_make: string;
+  techRecord_maxTrainGbWeight: number;
+  techRecord_maxTrainEecWeight?: number | null;
+  techRecord_maxTrainDesignWeight?: number | null;
+  techRecord_manufactureYear: number;
+  techRecord_microfilm_microfilmDocumentType?: null | MicrofilmDocumentTypes;
+  techRecord_microfilm_microfilmRollNumber?: string | null;
+  techRecord_microfilm_microfilmSerialNumber?: string | null;
+  techRecord_model: string;
+  techRecord_numberOfWheelsDriven: number;
+  techRecord_noOfAxles?: number | null;
+  techRecord_notes: string;
+  techRecord_offRoad: boolean;
+  plates?: HGVPlates[];
+  techRecord_reasonForCreation: string;
+  techRecord_recordCompleteness: "complete";
+  techRecord_regnDate: string;
+  techRecord_roadFriendly: boolean;
+  techRecord_statusCode: StatusCode;
+  techRecord_speedLimiterMrk: boolean;
+  techRecord_tachoExemptMrk: boolean;
+  techRecord_trainDesignWeight?: number | null;
+  techRecord_trainEecWeight?: number | null;
+  techRecord_trainGbWeight: number;
+  techRecord_tyreUseCode: string;
+  techRecord_vehicleClass_code: string;
+  techRecord_vehicleClass_description: VehicleClassDescription;
+  techRecord_vehicleConfiguration: VehicleConfiguration;
+  techRecord_approvalType: ApprovalType;
+  techRecord_approvalTypeNumber?: string | null;
+  techRecord_ntaNumber?: string | null;
+  techRecord_variantNumber?: string | null;
+  techRecord_variantVersionNumber?: string | null;
+  techRecord_lastUpdatedAt?: string | null;
+  techRecord_lastUpdatedByName?: string | null;
+  techRecord_lastUpdatedById?: string | null;
+  techRecord_vehicleType: "hgv";
+  primaryVrm: string;
+  vin: string;
+}
+export interface HGVAxles {
+  techRecord_parkingBrakeMrk?: boolean;
+  techRecord_axleNumber?: number;
+  techRecord_weights_gbWeight?: number;
+  techRecord_weights_designWeight?: number;
+  techRecord_weights_eecWeight?: number | null;
+  techRecord_tyres_tyreCode?: number;
+  techRecord_tyres_tyreSize?: string;
+  techRecord_tyres_plyRating?: string | null;
+  techRecord_tyres_fitmentCode?: FitmentCode;
+  techRecord_tyres_dataTrAxles?: null | number;
+}
+export interface HGVPlates {
+  techRecord_plateSerialNumber?: string | null;
+  techRecord_plateIssueDate?: string | null;
+  techRecord_reasonForIssue?: null | PlateReasonForIssue;
+  techRecord_plateIssuer?: string | null;
+}