@dvsa/cvs-type-definitions v6.4.0
cvs-type-definitions
json schema 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 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):
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.
- Navigate into the relevant schema (e.g.
./json-definitions/test/index.json
) - Edit file
- Generate the new TypeScript and de-referenced json schema definitions using
npm run generate
- Bump the version of the package using
npm version {major|minor|patch}
- Publish updates
Adding a new schema
- Create a new subdirectory with an appropriate name within the
json-defininitions
directory (e.g.my-new-schema
) - Add an
index.json
file to the new directory with appropriate json schema definitions - 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) - Generate the new TypeScript definitions using
npm run generate
- Bump the version of the package using
npm version {major|minor|patch}
- Publish updates
Publishing github package
- Raise a Pull Request on Github and await approvals
- Once merged, publish the new package from the latest
develop
branch to GitHub packages usingnpm publish
- _You must be logged in and have the correct permissions to publish to the package
24 days ago
29 days ago
1 month ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
10 months ago
10 months ago
9 months ago
7 months ago
9 months ago
7 months ago
9 months ago
7 months ago
9 months ago
9 months ago
6 months ago
9 months ago
6 months ago
9 months ago
6 months ago
9 months ago
7 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
5 months ago
9 months ago
5 months ago
9 months ago
5 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
6 months ago
7 months ago
7 months ago
7 months ago
6 months ago
8 months ago
7 months ago
8 months ago
8 months ago
7 months ago
7 months ago
7 months ago
8 months ago
8 months ago
8 months ago
6 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago
10 months ago
10 months ago
11 months ago
10 months ago
9 months ago
9 months ago
9 months ago
9 months ago
7 months ago
8 months ago
7 months ago
8 months ago
8 months ago
8 months ago
8 months ago
6 months ago
8 months ago
6 months ago
8 months ago
6 months ago
8 months ago
8 months ago
10 months ago
8 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
8 months ago
11 months ago