minor(cb2-9718): update vehicleType and inspectionType to use enums (#…

…138)

Co-authored-by: Owen Corrigan (BJSS, VTM) <122352145+owen-corrigan-bjss@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

json-definitions/iva/defects/enums/inspectionType.ignore.json → json-definitions/iva/defects/enums/inspectionType.enum.json

@@ -1,6 +1,10 @@
 {
   "title": "Inspection Type",
   "type": "string",
+  "tsEnumNames":[
+    "basic",
+    "normal"
+  ],
   "enum":[
     "basic",
     "normal"

json-definitions/iva/defects/get/index.json

@@ -21,7 +21,7 @@
       "items": {
         "anyOf": [
           {
-            "$ref": "../../../v3/tech-record/enums/vehicleType.ignore.json"
+            "$ref": "../../../v3/tech-record/enums/vehicleType.enum.json"
           }
         ]
       }
@@ -66,7 +66,7 @@
             "items": {
               "anyOf": [
                 {
-                  "$ref": "../enums/inspectionType.ignore.json"
+                  "$ref": "../enums/inspectionType.enum.json"
                 }
               ]
             }

json-definitions/v3/tech-record/enums/vehicleType.ignore.json → json-definitions/v3/tech-record/enums/vehicleType.enum.json

@@ -1,6 +1,14 @@
 {
   "title": "Vehicle Type",
   "type": "string",
+  "tsEnumNames":[
+    "psv",
+    "trl",
+    "hgv",
+    "car",
+    "lgv",
+    "motorcycle"
+  ],
   "enum":[
     "psv",
     "trl",

json-definitions/v3/tech-record/get/search/index.json

@@ -21,7 +21,7 @@
       "$ref": "../../enums/statusCode.ignore.json"
     },
     "techRecord_vehicleType": {
-      "$ref": "../../enums/vehicleType.ignore.json"
+      "$ref": "../../enums/vehicleType.enum.json"
     },
     "createdTimestamp": {
       "type": "string"

json-schemas/iva/defects/enums/inspectionType.enum.json

@@ -0,0 +1,12 @@
+{
+	"title": "Inspection Type",
+	"type": "string",
+	"tsEnumNames": [
+		"basic",
+		"normal"
+	],
+	"enum": [
+		"basic",
+		"normal"
+	]
+}

json-schemas/iva/defects/get/index.json

@@ -27,6 +27,14 @@
 					{
 						"title": "Vehicle Type",
 						"type": "string",
+						"tsEnumNames": [
+							"psv",
+							"trl",
+							"hgv",
+							"car",
+							"lgv",
+							"motorcycle"
+						],
 						"enum": [
 							"psv",
 							"trl",
@@ -130,6 +138,10 @@
 								{
 									"title": "Inspection Type",
 									"type": "string",
+									"tsEnumNames": [
+										"basic",
+										"normal"
+									],
 									"enum": [
 										"basic",
 										"normal"

json-schemas/v3/tech-record/enums/vehicleType.enum.json

@@ -0,0 +1,20 @@
+{
+	"title": "Vehicle Type",
+	"type": "string",
+	"tsEnumNames": [
+		"psv",
+		"trl",
+		"hgv",
+		"car",
+		"lgv",
+		"motorcycle"
+	],
+	"enum": [
+		"psv",
+		"trl",
+		"hgv",
+		"car",
+		"lgv",
+		"motorcycle"
+	]
+}

json-schemas/v3/tech-record/get/search/index.json

@@ -29,6 +29,14 @@
 		"techRecord_vehicleType": {
 			"title": "Vehicle Type",
 			"type": "string",
+			"tsEnumNames": [
+				"psv",
+				"trl",
+				"hgv",
+				"car",
+				"lgv",
+				"motorcycle"
+			],
 			"enum": [
 				"psv",
 				"trl",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dvsa/cvs-type-definitions",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "type definitions for cvs vta and vtm applications",
   "main": "index.js",
   "repository": {

schemas.ts

@@ -1,4 +1,5 @@
 export const schemas = [
+  "iva/defects/enums/inspectionType.enum.json",
   "iva/defects/get/index.json",
   "v1/activity/index.json",
   "v1/defect-category-reference-data/index.json",
@@ -25,6 +26,7 @@ export const schemas = [
   "v3/tech-record/enums/vehicleConfigurationHgvPsv.enum.json",
   "v3/tech-record/enums/vehicleConfigurationLightVehicle.enum.json",
   "v3/tech-record/enums/vehicleConfigurationTrl.enum.json",
+  "v3/tech-record/enums/vehicleType.enum.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",

types/iva/defects/enums/inspectionType.enum.ts

@@ -0,0 +1,11 @@
+/* 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 enum InspectionType {
+  basic = "basic",
+  normal = "normal"
+}

types/iva/defects/get/index.d.ts

@@ -5,9 +5,6 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type VehicleType = "psv" | "trl" | "hgv" | "car" | "lgv" | "motorcycle";
-export type InspectionType = "basic" | "normal";
-
 export interface DefectGETIVA {
   sectionNumber: string;
   sectionDescription: string;
@@ -22,6 +19,14 @@ export interface DefectGETIVA {
   }[];
 }
 
+export enum VehicleType {
+  psv = "psv",
+  trl = "trl",
+  hgv = "hgv",
+  car = "car",
+  lgv = "lgv",
+  motorcycle = "motorcycle"
+}
 export enum EUVehicleCategory {
   M1 = "m1",
   M2 = "m2",
@@ -42,3 +47,7 @@ export enum EUVehicleCategory {
   L6E = "l6e",
   L7E = "l7e"
 }
+export enum InspectionType {
+  basic = "basic",
+  normal = "normal"
+}

types/v3/tech-record/enums/vehicleType.enum.ts

@@ -0,0 +1,15 @@
+/* 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 enum VehicleType {
+  psv = "psv",
+  trl = "trl",
+  hgv = "hgv",
+  car = "car",
+  lgv = "lgv",
+  motorcycle = "motorcycle"
+}

types/v3/tech-record/get/search/index.d.ts

@@ -6,7 +6,6 @@
  */
 
 export type StatusCode = "provisional" | "current" | "archived";
-export type VehicleType = "psv" | "trl" | "hgv" | "car" | "lgv" | "motorcycle";
 
 export interface TechRecordSearchSchema {
   primaryVrm?: string;
@@ -24,3 +23,12 @@ export interface TechRecordSearchSchema {
   techRecord_reasonForCreation?: string;
   techRecord_createdByName?: string;
 }
+
+export enum VehicleType {
+  psv = "psv",
+  trl = "trl",
+  hgv = "hgv",
+  car = "car",
+  lgv = "lgv",
+  motorcycle = "motorcycle"
+}