@dvsa/cvs-type-definitions 1.0.11 → 2.0.11

package/README.md

@@ -1,14 +1,11 @@
 # cvs-type-definitions
+
 [json schema](https://json-schema.org/) and .ts type definitions for cvs vta application
 
 # Usage
 
 ## Install GitHub package:
 
-- Ensure consuming repo is set up to install private DVSA packages by adding the following to the `.npmrc` file:
-  `@dvsa:registry=https://npm.pkg.github.com`
-- **NOTE:** in order to install private DVSA packages you will need a `.npmrc` file in your `$PATH` containing a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) linked to the DVSA org. You should add the token to your `.npmrc` file as follows:
-  - `//npm.pkg.github.com/:_authToken=<AUTH_TOKEN_HERE>`
 - install GitHub package: `npm install @dvsa/cvs-type-definitions@latest`
 
 ## Example usage (TS types):
@@ -21,14 +18,11 @@ The package exports an `isValidObject()` function which can be used to validate
 
 `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. 
+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.
 
@@ -41,13 +35,14 @@ TypeScript interfaces will be generated from these files and saved to `types` di
 # Adding a new schema
 
 1. Create a new subdirectory with an appropriate name within the `json-defininitions` directory (e.g. `my-new-schema`)
-2. Add an `index.json` file to the new directory with appropriate json schema definitions
-3. Add the new schema name to the `schemas` constant array in `./schemas.ts` **NOTE:** this MUST match the directory name created at step 1 (`my-new-schema` in the example here)
+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 github package
+# Publishing a new version
 
-1. Raise a Pull Request on Github and await approvals
-2. Once merged, publish the new package from the latest `develop` branch to GitHub packages using `npm publish` - _You must be logged in and have the correct permissions to publish to the package
+- 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/json-schemas/{activity → v1/activity}/index.json

@@ -1,62 +1,62 @@
-{
-	"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"
-	]
+{
+	"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"
+	]
 }