@dvsa/cvs-type-definitions 2.0.16 → 2.0.18

package/package.json

@@ -1,38 +1,33 @@
 {
-  "name": "@dvsa/cvs-type-definitions",
-  "version": "2.0.16",
-  "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": "npm run generate && jest",
-    "generate": "ts-node scripts/generateSchemas.ts"
-  },
-  "author": "dvsa",
-  "license": "ISC",
-  "devDependencies": {
-    "@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": {
-    "ajv": "^8.12.0",
-    "json-schema-deref-sync": "^0.14.0",
-    "pretty-js": "^0.2.2",
-    "util": "^0.12.5"
-  }
+    "name": "@dvsa/cvs-type-definitions",
+    "version": "2.0.18",
+    "description": "type definitions for cvs vta application",
+    "main": "index.js",
+    "repository": {
+        "url": "git://github.com/dvsa/cvs-type-definitions.git"
+    },
+    "scripts": {
+        "build": "tsc",
+        "test": "npm run generate && jest",
+        "generate": "ts-node scripts/generateSchemas.ts"
+    },
+    "author": "dvsa",
+    "license": "ISC",
+    "devDependencies": {
+        "@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": {
+        "ajv": "^8.12.0",
+        "json-schema-deref-sync": "^0.14.0",
+        "pretty-js": "^0.2.2",
+        "util": "^0.12.5"
+    }
 }

package/README.md

@@ -1,48 +0,0 @@
-# cvs-type-definitions
-
-[json schema](https://json-schema.org/) and .ts type definitions for cvs vta application
-
-# Usage
-
-## Install GitHub package:
-
-- install GitHub package: `npm install @dvsa/cvs-type-definitions@latest`
-
-## Example usage (TS types):
-
-`import { CommercialVehicleTestSchema } from @dvsa/cvs-type-definitions/types/test`
-
-## Example usage (json schemas)
-
-The package exports an `isValidObject()` function which can be used to validate an object against a specified schema. E.g:
-
-`import { isValidObject } from '@dvsa/cvs-type-definitions/lib/src/schema-validation../../schema-validator';`
-
-`const isValidVisit: boolean = isValidObject('visit', myVisitObject);`
-
-# Updating a schema
-
-Edits should only be made to `json` schema definitions within `json-definitions` directory.
-
-TypeScript interfaces will be generated from these files and saved to `types` directory. De-referenced json schema definitions will be saved to `json-schemas` directory. Only these two directories are published in the npm package.
-
-1. Navigate into the relevant schema (e.g. `./json-definitions/test/index.json`)
-2. Edit file
-3. Generate the new TypeScript and de-referenced json schema definitions using `npm run generate`
-4. Bump the version of the package using `npm version {major|minor|patch}`
-5. Publish updates
-
-# Adding a new schema
-
-1. Create a new subdirectory with an appropriate name within the `json-defininitions` directory (e.g. `my-new-schema`)
-2. If you do not wish for a type file and a de-referenced schema to be generated for a schema, add `.ignore` in the name of the file (e.g. `my-new-schema.ignore.json`)
-3. Generate the new TypeScript definitions using `npm run generate`
-4. Bump the version of the package using `npm version {major|minor|patch}`
-5. Publish updates
-
-# Publishing a new version
-
-- Raise a PR
-- The PR title should start with `major`, `minor` or `patch` and be followed by the character `(`. Doing this ensure the correct version of the package is published to npm. A Github action should enforce the PR title format.
-- Add a description of the changes in the `Changelog` section of the PR description
-- Once merged to develop, a github action should create a release and publish a new version of that release on npm

package/lib/README.md

@@ -1,48 +0,0 @@
-# cvs-type-definitions
-
-[json schema](https://json-schema.org/) and .ts type definitions for cvs vta application
-
-# Usage
-
-## Install GitHub package:
-
-- install GitHub package: `npm install @dvsa/cvs-type-definitions@latest`
-
-## Example usage (TS types):
-
-`import { CommercialVehicleTestSchema } from @dvsa/cvs-type-definitions/types/test`
-
-## Example usage (json schemas)
-
-The package exports an `isValidObject()` function which can be used to validate an object against a specified schema. E.g:
-
-`import { isValidObject } from '@dvsa/cvs-type-definitions/lib/src/schema-validation../../schema-validator';`
-
-`const isValidVisit: boolean = isValidObject('visit', myVisitObject);`
-
-# Updating a schema
-
-Edits should only be made to `json` schema definitions within `json-definitions` directory.
-
-TypeScript interfaces will be generated from these files and saved to `types` directory. De-referenced json schema definitions will be saved to `json-schemas` directory. Only these two directories are published in the npm package.
-
-1. Navigate into the relevant schema (e.g. `./json-definitions/test/index.json`)
-2. Edit file
-3. Generate the new TypeScript and de-referenced json schema definitions using `npm run generate`
-4. Bump the version of the package using `npm version {major|minor|patch}`
-5. Publish updates
-
-# Adding a new schema
-
-1. Create a new subdirectory with an appropriate name within the `json-defininitions` directory (e.g. `my-new-schema`)
-2. If you do not wish for a type file and a de-referenced schema to be generated for a schema, add `.ignore` in the name of the file (e.g. `my-new-schema.ignore.json`)
-3. Generate the new TypeScript definitions using `npm run generate`
-4. Bump the version of the package using `npm version {major|minor|patch}`
-5. Publish updates
-
-# Publishing a new version
-
-- Raise a PR
-- The PR title should start with `major`, `minor` or `patch` and be followed by the character `(`. Doing this ensure the correct version of the package is published to npm. A Github action should enforce the PR title format.
-- Add a description of the changes in the `Changelog` section of the PR description
-- Once merged to develop, a github action should create a release and publish a new version of that release on npm

package/lib/json-schemas/v1/activity/index.json

@@ -1,62 +0,0 @@
-{
-	"title": "Activity Schema",
-	"type": "object",
-	"properties": {
-		"activityType": {
-			"type": "string"
-		},
-		"testStationName": {
-			"type": "string"
-		},
-		"testStationPNumber": {
-			"type": "string"
-		},
-		"testStationEmail": {
-			"type": "string"
-		},
-		"testStationType": {
-			"type": "string"
-		},
-		"testerName": {
-			"type": "string"
-		},
-		"testerStaffId": {
-			"type": "string"
-		},
-		"testerEmail": {
-			"type": "string"
-		},
-		"startTime": {
-			"type": "string"
-		},
-		"endTime": {
-			"type": "string"
-		},
-		"parentId": {
-			"type": "string"
-		},
-		"waitReason": {
-			"type": "array",
-			"items": {
-				"type": "string"
-			}
-		},
-		"notes": {
-			"type": "string"
-		},
-		"id": {
-			"type": "string"
-		}
-	},
-	"additionalProperties": false,
-	"required": [
-		"activityType",
-		"testStationName",
-		"testStationPNumber",
-		"testStationEmail",
-		"testStationType",
-		"testerName",
-		"testerStaffId",
-		"startTime"
-	]
-}

package/lib/json-schemas/v1/defect-category-reference-data/index.json

@@ -1,440 +0,0 @@
-{
-	"title": "Defect Category Reference Data Schema",
-	"type": "object",
-	"properties": {
-		"imNumber": {
-			"type": "integer"
-		},
-		"imDescription": {
-			"type": "string"
-		},
-		"forVehicleType": {
-			"type": "array",
-			"items": {
-				"type": "string"
-			}
-		},
-		"additionalInfo": {
-			"title": "Additional Info Schema",
-			"type": "object",
-			"properties": {
-				"psv": {
-					"properties": {
-						"location": {
-							"title": "Defect Location Metadata Schema",
-							"type": "object",
-							"properties": {
-								"vertical": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"horizontal": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"lateral": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"longitudinal": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"rowNumber": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "number"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"seatNumber": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "integer"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"axleNumber": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "number"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								}
-							},
-							"additionalProperties": false
-						},
-						"notes": {
-							"type": "boolean"
-						}
-					},
-					"additionalProperties": false
-				},
-				"hgv": {
-					"properties": {
-						"location": {
-							"title": "Defect Location Metadata Schema",
-							"type": "object",
-							"properties": {
-								"vertical": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"horizontal": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"lateral": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"longitudinal": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"rowNumber": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "number"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"seatNumber": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "integer"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"axleNumber": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "number"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								}
-							},
-							"additionalProperties": false
-						},
-						"notes": {
-							"type": "boolean"
-						}
-					},
-					"additionalProperties": false
-				},
-				"trl": {
-					"properties": {
-						"location": {
-							"title": "Defect Location Metadata Schema",
-							"type": "object",
-							"properties": {
-								"vertical": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"horizontal": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"lateral": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"longitudinal": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"rowNumber": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "number"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"seatNumber": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "integer"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								},
-								"axleNumber": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "number"
-											}
-										},
-										{
-											"type": "null"
-										}
-									]
-								}
-							},
-							"additionalProperties": false
-						},
-						"notes": {
-							"type": "boolean"
-						}
-					},
-					"additionalProperties": false
-				}
-			},
-			"additionalProperties": false,
-			"required": [
-				"hgv",
-				"psv",
-				"trl"
-			]
-		},
-		"items": {
-			"type": "array",
-			"items": {
-				"title": "Defect Item Reference Data Schema",
-				"type": "object",
-				"properties": {
-					"itemNumber": {
-						"type": "integer"
-					},
-					"itemDescription": {
-						"type": "string"
-					},
-					"forVehicleType": {
-						"type": "array",
-						"items": {
-							"type": "string"
-						}
-					},
-					"deficiencies": {
-						"type": "array",
-						"items": {
-							"title": "Defect Deficiency Reference Data Schema",
-							"type": "object",
-							"properties": {
-								"ref": {
-									"type": "string"
-								},
-								"deficiencyId": {
-									"type": [
-										"string",
-										"null"
-									]
-								},
-								"deficiencySubId": {
-									"type": "string"
-								},
-								"deficiencyCategory": {
-									"type": "string"
-								},
-								"deficiencyText": {
-									"type": "string"
-								},
-								"stdForProhibition": {
-									"type": "boolean"
-								},
-								"forVehicleType": {
-									"anyOf": [
-										{
-											"type": "array",
-											"items": {
-												"type": "string"
-											}
-										},
-										{
-											"type": "string",
-											"enum": [
-												"psv",
-												"hgv",
-												"trl",
-												"car",
-												"lgv",
-												"motorcycle"
-											]
-										}
-									]
-								}
-							},
-							"additionalProperties": false,
-							"required": [
-								"ref",
-								"deficiencyId",
-								"deficiencySubId",
-								"deficiencyCategory",
-								"deficiencyText",
-								"stdForProhibition",
-								"forVehicleType"
-							]
-						}
-					}
-				},
-				"additionalProperties": false,
-				"required": []
-			}
-		}
-	},
-	"additionalProperties": false,
-	"required": [
-		"imNumber",
-		"imDescription",
-		"forVehicleType",
-		"additionalInfo",
-		"items"
-	]
-}