@dvsa/cvs-type-definitions 9.1.0 → 9.2.0

package/json-schemas/v1/dynamics-test-station/index.json

@@ -0,0 +1,70 @@
+{
+    "title": "Dynamics Test Station Schema",
+    "type": "object",
+    "properties": {
+        "testStationId": {
+            "type": "string"
+        },
+        "testStationPNumber": {
+            "type": "string"
+        },
+        "testStationName": {
+            "type": "string"
+        },
+        "testStationContactNumber": {
+            "type": "string"
+        },
+        "testStationAccessNotes": {
+            "type": "string"
+        },
+        "testStationGeneralNotes": {
+            "type": "string"
+        },
+        "testStationTown": {
+            "type": "string"
+        },
+        "testStationAddress": {
+            "type": "string"
+        },
+        "testStationPostcode": {
+            "type": "string"
+        },
+        "testStationLongitude": {
+            "type": "integer"
+        },
+        "testStationLatitude": {
+            "type": "integer"
+        },
+        "testStationType": {
+            "type": "string"
+        },
+        "testStationEmails": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "searchProperty": {
+            "type": "string"
+        },
+        "testStationCountry": {
+            "type": "string"
+        },
+        "testStationStatus": {
+            "type": "string"
+        }
+    },
+    "required": [
+        "testStationId",
+        "testStationPNumber",
+        "testStationName",
+        "testStationContactNumber",
+        "testStationTown",
+        "testStationAddress",
+        "testStationPostcode",
+        "testStationType",
+        "testStationEmails",
+        "testStationStatus"
+    ],
+    "additionalProperties": false
+}

package/package.json

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

package/schema-validator.d.ts

@@ -12,3 +12,4 @@ export declare type Schema = typeof schemas[number];
 export declare function isValidObject<B extends boolean | undefined>(schemaName: Schema, objectToValidate: object): boolean;
 export declare function isValidObject<B extends boolean | undefined>(schemaName: Schema, objectToValidate: object, returnErrors: B): B extends false ? boolean : ErrorObject[];
 export declare function isValidObject<B extends boolean | undefined>(schemaName: Schema, objectToValidate: object, returnErrors: B, logErrors: boolean | undefined): B extends false ? boolean : ErrorObject[];
+export declare function validate<B extends boolean | undefined>(schemaObject: object, objectToValidate: object, returnErrors: B, logErrors?: boolean): boolean | ErrorObject<string, Record<string, any>, unknown>[];

package/schema-validator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidObject = void 0;
+exports.validate = exports.isValidObject = void 0;
 var ajv_1 = require("ajv");
 var ajv_formats_1 = require("ajv-formats");
 var fs_1 = require("fs");
@@ -22,3 +22,20 @@ function isValidObject(schemaName, objectToValidate, returnErrors, logErrors) {
     return isValid;
 }
 exports.isValidObject = isValidObject;
+function validate(schemaObject, objectToValidate, returnErrors, logErrors) {
+    var _a;
+    if (logErrors === void 0) { logErrors = false; }
+    var ajv = new ajv_1.default({ removeAdditional: true, allErrors: true });
+    (0, ajv_formats_1.default)(ajv);
+    ajv.addKeyword('tsEnumNames');
+    var validateFunction = ajv.compile(schemaObject);
+    var isValid = validateFunction(objectToValidate);
+    if (logErrors && validateFunction.errors) {
+        console.error(validateFunction.errors);
+    }
+    if (returnErrors) {
+        return (_a = validateFunction.errors) !== null && _a !== void 0 ? _a : [];
+    }
+    return isValid;
+}
+exports.validate = validate;

package/schemas.d.ts

@@ -1 +1 @@
-export declare const schemas: readonly ["enums/euVehicleCategory.enum.json", "enums/vehicleConfiguration.enum.json", "enums/vehicleSize.enum.json", "enums/vehicleSubclass.enum.json", "enums/vehicleType.enum.json", "required-standards/defects/enums/euVehicleCategory.enum.json", "required-standards/defects/get/index.json", "required-standards/defects/requiredStandardTaxonomySection.json", "test-type/enums/testTypeClassification.enum.json", "test-type/get/index.json", "test-type/nextTestTypesOrCategory.json", "test-type/testCode.json", "v1/activity/index.json", "v1/defect-category-reference-data/index.json", "v1/defect-details/index.json", "v1/defect-location/index.json", "v1/enums/activityType.enum.json", "v1/enums/closureReason.enum.json", "v1/enums/emissionStandard.enum.json", "v1/enums/fuelType.enum.json", "v1/enums/odometerReadingUnits.enum.json", "v1/enums/sources.enum.json", "v1/enums/testResult.enum.json", "v1/enums/testStationType.enum.json", "v1/enums/testStatus.enum.json", "v1/enums/typeOfTest.enum.json", "v1/enums/vehicleType.enum.json", "v1/enums/waitReason.enum.json", "v1/reason-item/index.json", "v1/recalls/index.json", "v1/tech-record/index.json", "v1/test/index.json", "v1/test-result/index.json", "v1/test-result-test-type/index.json", "v1/test-station/index.json", "v1/vehicle/index.json", "v1/vehicle-tech-record/index.json", "v1/visit/index.json", "v3/tech-record/enums/adrAdditionalNotesNumber.enum.json", "v3/tech-record/enums/adrBodyDeclarationType.enum.json", "v3/tech-record/enums/adrBodyType.enum.json", "v3/tech-record/enums/adrCertificateTypes.enum.json", "v3/tech-record/enums/adrCompatibilityGroupJ.enum.json", "v3/tech-record/enums/adrDangerousGood.enum.json", "v3/tech-record/enums/adrTankDetailsTankStatementSelect.enum.json", "v3/tech-record/enums/adrTankStatementSubstancePermitted.json", "v3/tech-record/enums/approvalType.enum.json", "v3/tech-record/enums/approvalTypeHgvOrPsv.enum.json", "v3/tech-record/enums/euVehicleCategory.enum.json", "v3/tech-record/enums/euVehicleCategoryCar.enum.json", "v3/tech-record/enums/euVehicleCategoryHgv.enum.json", "v3/tech-record/enums/euVehicleCategoryLgv.enum.json", "v3/tech-record/enums/euVehicleCategoryPsv.enum.json", "v3/tech-record/enums/euVehicleCategorySmallTrl.enum.json", "v3/tech-record/enums/euVehicleCategoryTrl.enum.json", "v3/tech-record/enums/radioButtonOptions.enum.json", "v3/tech-record/enums/tc3Types.enum.json", "v3/tech-record/enums/tyreUseCodeHgv.enum.json", "v3/tech-record/enums/tyreUseCodeTrl.enum.json", "v3/tech-record/enums/vehicleClassDescription.enum.json", "v3/tech-record/enums/vehicleClassDescriptionPSV.enum.json", "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/vehicleSize.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", "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/index.json", "v3/tech-record/get/small trl/complete/index.json", "v3/tech-record/get/small trl/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/put/car/complete/index.json", "v3/tech-record/put/car/skeleton/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/index.json", "v3/tech-record/put/lgv/skeleton/index.json", "v3/tech-record/put/motorcycle/complete/index.json", "v3/tech-record/put/motorcycle/skeleton/index.json", "v3/tech-record/put/psv/complete/index.json", "v3/tech-record/put/psv/skeleton/index.json", "v3/tech-record/put/psv/testable/index.json", "v3/tech-record/put/small trl/complete/index.json", "v3/tech-record/put/small trl/skeleton/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"];
+export declare const schemas: readonly ["enums/euVehicleCategory.enum.json", "enums/vehicleConfiguration.enum.json", "enums/vehicleSize.enum.json", "enums/vehicleSubclass.enum.json", "enums/vehicleType.enum.json", "required-standards/defects/enums/euVehicleCategory.enum.json", "required-standards/defects/get/index.json", "required-standards/defects/requiredStandardTaxonomySection.json", "test-type/enums/testTypeClassification.enum.json", "test-type/get/index.json", "test-type/nextTestTypesOrCategory.json", "test-type/testCode.json", "v1/activity/index.json", "v1/defect-category-reference-data/index.json", "v1/defect-details/index.json", "v1/defect-location/index.json", "v1/dynamics-test-station/index.json", "v1/enums/activityType.enum.json", "v1/enums/closureReason.enum.json", "v1/enums/emissionStandard.enum.json", "v1/enums/fuelType.enum.json", "v1/enums/odometerReadingUnits.enum.json", "v1/enums/sources.enum.json", "v1/enums/testResult.enum.json", "v1/enums/testStationType.enum.json", "v1/enums/testStatus.enum.json", "v1/enums/typeOfTest.enum.json", "v1/enums/vehicleType.enum.json", "v1/enums/waitReason.enum.json", "v1/reason-item/index.json", "v1/recalls/index.json", "v1/tech-record/index.json", "v1/test/index.json", "v1/test-result/index.json", "v1/test-result-test-type/index.json", "v1/test-station/index.json", "v1/vehicle/index.json", "v1/vehicle-tech-record/index.json", "v1/visit/index.json", "v3/tech-record/enums/adrAdditionalNotesNumber.enum.json", "v3/tech-record/enums/adrBodyDeclarationType.enum.json", "v3/tech-record/enums/adrBodyType.enum.json", "v3/tech-record/enums/adrCertificateTypes.enum.json", "v3/tech-record/enums/adrCompatibilityGroupJ.enum.json", "v3/tech-record/enums/adrDangerousGood.enum.json", "v3/tech-record/enums/adrTankDetailsTankStatementSelect.enum.json", "v3/tech-record/enums/adrTankStatementSubstancePermitted.json", "v3/tech-record/enums/approvalType.enum.json", "v3/tech-record/enums/approvalTypeHgvOrPsv.enum.json", "v3/tech-record/enums/euVehicleCategory.enum.json", "v3/tech-record/enums/euVehicleCategoryCar.enum.json", "v3/tech-record/enums/euVehicleCategoryHgv.enum.json", "v3/tech-record/enums/euVehicleCategoryLgv.enum.json", "v3/tech-record/enums/euVehicleCategoryPsv.enum.json", "v3/tech-record/enums/euVehicleCategorySmallTrl.enum.json", "v3/tech-record/enums/euVehicleCategoryTrl.enum.json", "v3/tech-record/enums/radioButtonOptions.enum.json", "v3/tech-record/enums/tc3Types.enum.json", "v3/tech-record/enums/tyreUseCodeHgv.enum.json", "v3/tech-record/enums/tyreUseCodeTrl.enum.json", "v3/tech-record/enums/vehicleClassDescription.enum.json", "v3/tech-record/enums/vehicleClassDescriptionPSV.enum.json", "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/vehicleSize.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", "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/index.json", "v3/tech-record/get/small trl/complete/index.json", "v3/tech-record/get/small trl/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/put/car/complete/index.json", "v3/tech-record/put/car/skeleton/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/index.json", "v3/tech-record/put/lgv/skeleton/index.json", "v3/tech-record/put/motorcycle/complete/index.json", "v3/tech-record/put/motorcycle/skeleton/index.json", "v3/tech-record/put/psv/complete/index.json", "v3/tech-record/put/psv/skeleton/index.json", "v3/tech-record/put/psv/testable/index.json", "v3/tech-record/put/small trl/complete/index.json", "v3/tech-record/put/small trl/skeleton/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"];

package/schemas.js

@@ -18,6 +18,7 @@ exports.schemas = [
     "v1/defect-category-reference-data/index.json",
     "v1/defect-details/index.json",
     "v1/defect-location/index.json",
+    "v1/dynamics-test-station/index.json",
     "v1/enums/activityType.enum.json",
     "v1/enums/closureReason.enum.json",
     "v1/enums/emissionStandard.enum.json",

package/types/v1/dynamics-test-station/index.d.ts

@@ -0,0 +1,25 @@
+/* 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 DynamicsTestStationSchema {
+  testStationId: string;
+  testStationPNumber: string;
+  testStationName: string;
+  testStationContactNumber: string;
+  testStationAccessNotes?: string;
+  testStationGeneralNotes?: string;
+  testStationTown: string;
+  testStationAddress: string;
+  testStationPostcode: string;
+  testStationLongitude?: number;
+  testStationLatitude?: number;
+  testStationType: string;
+  testStationEmails: string[];
+  searchProperty?: string;
+  testStationCountry?: string;
+  testStationStatus: string;
+}