@dvsa/cvs-type-definitions 1.0.11

package/lib/schemas.d.ts

@@ -0,0 +1 @@
+export declare const schemas: readonly ["test", "visit", "test-station", "defect-category-reference-data", "defect-details", "defect-location", "tech-record", "vehicle", "test-result", "vehicle-tech-record", "activity", "test-type", "reason-item"];

package/lib/schemas.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schemas = void 0;
+exports.schemas = [
+    'test',
+    'visit',
+    'test-station',
+    'defect-category-reference-data',
+    'defect-details',
+    'defect-location',
+    'tech-record',
+    'vehicle',
+    'test-result',
+    'vehicle-tech-record',
+    'activity',
+    'test-type',
+    'reason-item'
+];

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

@@ -0,0 +1,3 @@
+import { schemas } from '../../schemas';
+export declare type Schema = typeof schemas[number];
+export declare const isValidObject: (schemaName: Schema, objectToValidate: object) => boolean;

package/lib/src/schema-validation/schema-validator.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidObject = void 0;
+var Enjoi = require('enjoi');
+var isValidObject = function (schemaName, objectToValidate) {
+    var schemaPath = "json-schemas/".concat(schemaName, "/index.json");
+    var schemaFile = require(schemaPath);
+    var schema = Enjoi.schema(schemaFile);
+    var error = schema.validate(objectToValidate).error;
+    if (error) {
+        console.error("Object failed validation against ".concat(schemaName, " Schema. Failures: "));
+        error.details.forEach(function (errorDetail) {
+            console.log(errorDetail.message);
+        });
+    }
+    else {
+        console.log('*********schema passes validation********');
+    }
+    return !error;
+};
+exports.isValidObject = isValidObject;
+(0, exports.isValidObject)('test-result', {});

package/package.json

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

package/types/activity/index.d.ts

@@ -0,0 +1,23 @@
+/* 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 interface ActivitySchema {
+  activityType: string;
+  testStationName: string;
+  testStationPNumber: string;
+  testStationEmail: string;
+  testStationType: string;
+  testerName: string;
+  testerStaffId: string;
+  testerEmail?: string;
+  startTime: string;
+  endTime?: string;
+  parentId?: string;
+  waitReason?: string[];
+  notes?: string;
+  id?: string;
+}

package/types/defect-category-reference-data/index.d.ts

@@ -0,0 +1,52 @@
+/* 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 interface DefectCategoryReferenceDataSchema {
+  imNumber: number;
+  imDescription: string;
+  forVehicleType: string[];
+  additionalInfo: AdditionalInfoSchema;
+  items: DefectItemReferenceDataSchema[];
+}
+export interface AdditionalInfoSchema {
+  psv: {
+    location?: DefectLocationMetadataSchema;
+    notes?: boolean;
+  };
+  hgv: {
+    location?: DefectLocationMetadataSchema;
+    notes?: boolean;
+  };
+  trl: {
+    location?: DefectLocationMetadataSchema;
+    notes?: boolean;
+  };
+}
+export interface DefectLocationMetadataSchema {
+  vertical?: string[] | null;
+  horizontal?: string[] | null;
+  lateral?: string[] | null;
+  longitudinal?: string[] | null;
+  rowNumber?: number[] | null;
+  seatNumber?: number[] | null;
+  axleNumber?: number[] | null;
+}
+export interface DefectItemReferenceDataSchema {
+  itemNumber?: number;
+  itemDescription?: string;
+  forVehicleType?: string[];
+  deficiencies?: DefectDeficiencyReferenceDataSchema[];
+}
+export interface DefectDeficiencyReferenceDataSchema {
+  ref: string;
+  deficiencyId: string | null;
+  deficiencySubId: string;
+  deficiencyCategory: string;
+  deficiencyText: string;
+  stdForProhibition: boolean;
+  forVehicleType: string[] | ("psv" | "hgv" | "trl" | "car" | "lgv" | "motorcycle");
+}

package/types/defect-details/index.d.ts

@@ -0,0 +1,53 @@
+/* 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 interface DefectDetailsSchema {
+  imNumber: number;
+  imDescription: string;
+  additionalInformation: {
+    location: DefectLocationSchema;
+    notes: string;
+  };
+  itemNumber: number;
+  itemDescription: string;
+  deficiencyRef: string;
+  deficiencyId: string | null;
+  deficiencySubId: string | null;
+  deficiencyCategory: string;
+  deficiencyText: string | null;
+  stdForProhibition: boolean | null;
+  prs: boolean | null;
+  prohibitionIssued: boolean | null;
+  metadata: DefectMetadataSchema;
+}
+export interface DefectLocationSchema {
+  vertical?: string | null;
+  horizontal?: string | null;
+  lateral?: string | null;
+  longitudinal?: string | null;
+  rowNumber?: number | null;
+  seatNumber?: number | null;
+  axleNumber?: number | null;
+}
+export interface DefectMetadataSchema {
+  category: {
+    additionalInfo?: DefectAdditionalDetailsMetadataSchema;
+  };
+}
+export interface DefectAdditionalDetailsMetadataSchema {
+  location: DefectLocationMetadataSchema;
+  notes: boolean;
+}
+export interface DefectLocationMetadataSchema {
+  vertical?: string[] | null;
+  horizontal?: string[] | null;
+  lateral?: string[] | null;
+  longitudinal?: string[] | null;
+  rowNumber?: number[] | null;
+  seatNumber?: number[] | null;
+  axleNumber?: number[] | null;
+}

package/types/defect-location/index.d.ts

@@ -0,0 +1,16 @@
+/* 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 interface DefectLocationSchema {
+  vertical?: string | null;
+  horizontal?: string | null;
+  lateral?: string | null;
+  longitudinal?: string | null;
+  rowNumber?: number | null;
+  seatNumber?: number | null;
+  axleNumber?: number | null;
+}

package/types/reason-item/index.d.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 interface ReasonItemSchema {
+  text: string;
+  isChecked: boolean;
+}

package/types/tech-record/index.d.ts

@@ -0,0 +1,202 @@
+/* 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 interface TechRecordSchema {
+  bodyType: {
+    code: string;
+    description: string;
+  };
+  manufactureYear: number;
+  regnDate: string;
+  ntaNumber: string;
+  conversionRefNo: string;
+  speedLimiterMrk: boolean;
+  tachoExemptMrk: boolean;
+  reasonForCreation: string;
+  statusCode: string;
+  grossKerbWeight: number;
+  grossLadenWeight: number;
+  noOfAxles: number;
+  brakeCode: string;
+  vehicleType: string;
+  euVehicleCategory: string;
+  axles: AxleSchema[];
+  vehicleClass: VehicleClassSchema;
+  vehicleSubclass: string[];
+  vehicleConfiguration: string;
+  recordCompleteness?: string;
+  chassisMake?: string;
+  chassisModel?: string;
+  bodyMake?: string;
+  bodyModel?: string;
+  vehicleSize?: string;
+  coifDate?: string;
+  unladenWeight?: number;
+  grossGbWeight?: number;
+  grossDesignWeight?: number;
+  grossUnladenWeight?: number;
+  seatsLowerDeck?: number;
+  seatsUpperDeck?: number;
+  standingCapacity?: number;
+  speedRestriction?: number;
+  dispensations?: string;
+  remarks?: string;
+  brakes?: Brake;
+  make?: string;
+  model?: string;
+  functionCode?: string;
+  typeUseCode?: string;
+  roadFriendly?: boolean;
+  drawbarCouplingFitted?: boolean;
+  dimensions?: DimensionsSchema;
+  notes: string;
+  adrDetails?: ADRDetailsSchema;
+  trainGbWeight?: number;
+  trainDesignWeight?: number;
+  maxTrainGbWeight?: number;
+  maxTrainDesignWeight?: number;
+  euroStandard?: number;
+  frontAxleTo5thWheelMin?: number;
+  frontAxleTo5thWheelMax?: number;
+  frontAxleTo5thWheelCouplingMin?: number;
+  frontAxleTo5thWheelCouplingMax?: number;
+  firstUseDate?: string;
+  maxLoadOnCoupling?: number;
+  suspensionType?: string;
+  couplingType?: string;
+  frontAxleToRearAxle?: number;
+  rearAxleToRearTrl?: number;
+  couplingCenterToRearAxleMin?: number;
+  couplingCenterToRearAxleMax?: number;
+  couplingCenterToRearTrlMin?: number;
+  couplingCenterToRearTrlMax?: number;
+  numberOfWheelsDriven?: number;
+}
+export interface AxleSchema {
+  parkingBrakeMrk?: boolean;
+  axleNumber: number;
+  weights?: WeightsSchema;
+  tyres: TyresSchema;
+  brakes?: AxleBrakePropertiesSchema;
+}
+export interface WeightsSchema {
+  kerbWeight?: number;
+  ladenWeight?: number;
+  gbWeight: number;
+  designWeight: number;
+}
+export interface TyresSchema {
+  tyreSize: string;
+  plyRating: string;
+  fitmentCode: string;
+  dataTrPsvAxles?: number;
+  tyreCode: number;
+  dataTrAxles?: number;
+  /**
+   * PSV only
+   */
+  speedCategorySymbol?: string;
+}
+export interface AxleBrakePropertiesSchema {
+  brakeActuator: number;
+  leverLength: number;
+  springBrakeParking: boolean;
+}
+export interface VehicleClassSchema {
+  code: string;
+  description: string;
+}
+export interface Brake {
+  brakeCode?: string;
+  dataTrBrakeOne?: string;
+  dataTrBrakeTwo?: string;
+  dataTrBrakeThree?: string;
+  retarderBrakeOne?: string;
+  retarderBrakeTwo?: string;
+  brakeCodeOriginal?: string;
+  brakeForceWheelsNotLocked?: BrakeForceWheel;
+  brakeForceWheelsUpToHalfLocked?: BrakeForceWheel;
+  dtpNumber?: string;
+  loadSensingValve?: boolean;
+  antilockBrakingSystem?: boolean;
+}
+export interface BrakeForceWheel {
+  serviceBrakeForce: number;
+  secondaryBrakeForce: number;
+  parkingBrakeForce: number;
+}
+export interface DimensionsSchema {
+  length: number;
+  width: number;
+  /**
+   * @minItems 1
+   * @maxItems 1
+   */
+  axleSpacing: [
+    {
+      axles: string;
+      value: number;
+    }
+  ];
+}
+export interface ADRDetailsSchema {
+  vehicleDetails?: {
+    type?: string;
+    approvalDate?: string;
+  };
+  listStatementApplicable?: boolean;
+  batteryListNumber?: string;
+  permittedDangerousGoods?: string[];
+  additionalExaminerNotes?: string;
+  applicantDetails?: ApplicantDetailsSchema;
+  memosApply?: string[];
+  additionalNotes?: {
+    number?: string[];
+    guidanceNotes?: string[];
+  };
+  adrTypeApprovalNo?: string;
+  compatibilityGroupJ?: boolean;
+  tank?: TankSchema;
+}
+export interface ApplicantDetailsSchema {
+  name?: string;
+  street?: string;
+  town?: string;
+  city?: string;
+  postcode?: string;
+}
+export interface TankSchema {
+  tankDetails?: TankDetailsSchema;
+  tankStatement?: TankStatementSchema;
+}
+export interface TankDetailsSchema {
+  tankManufacturer?: string;
+  tc2Details?: TC2DetailsSchema;
+  tc3Details?: TC3DetailsSchema[];
+  yearOfManufacture?: string;
+  tankCode?: string;
+  specialProvisions?: string;
+  tankManufacturerSerialNo?: string;
+  tankTypeAppNo?: string;
+}
+export interface TC2DetailsSchema {
+  tc2Type?: string;
+  tc2IntermediateApprovalNo?: string;
+  tc2IntermediateExpiryDate?: string;
+}
+export interface TC3DetailsSchema {
+  tc3Type?: string;
+  tc3IntermediateApprovalNo?: string;
+  tc3IntermediateExpiryDate?: string;
+}
+export interface TankStatementSchema {
+  substancesPermitted?: string;
+  statement?: string;
+  productList?: string;
+  productListRefNo?: string;
+  productListUnNo?: string[];
+}