{"id":23066897,"url":"https://github.com/dvsa/cvs-type-definitions","last_synced_at":"2026-04-10T08:07:38.006Z","repository":{"id":173680465,"uuid":"552997653","full_name":"dvsa/cvs-type-definitions","owner":"dvsa","description":"json schema definitions and .ts type definitions for cvs vta application","archived":false,"fork":false,"pushed_at":"2026-03-26T08:01:34.000Z","size":21331,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2026-03-26T12:38:58.260Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@dvsa/cvs-type-definitions","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dvsa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-10-17T14:52:36.000Z","updated_at":"2026-03-26T08:01:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"cdf41db8-21ff-4404-958c-89b372f2ff0a","html_url":"https://github.com/dvsa/cvs-type-definitions","commit_stats":null,"previous_names":["dvsa/cvs-type-definitions"],"tags_count":167,"template":false,"template_full_name":null,"purl":"pkg:github/dvsa/cvs-type-definitions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvsa%2Fcvs-type-definitions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvsa%2Fcvs-type-definitions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvsa%2Fcvs-type-definitions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvsa%2Fcvs-type-definitions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dvsa","download_url":"https://codeload.github.com/dvsa/cvs-type-definitions/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvsa%2Fcvs-type-definitions/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31307459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-16T05:15:30.830Z","updated_at":"2026-04-02T14:01:42.291Z","avatar_url":"https://github.com/dvsa.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cvs-type-definitions\n\n[json schema](https://json-schema.org/) and .ts type definitions for cvs vta application\n\n# Usage\n\n## Install GitHub package:\n\n- install GitHub package: `npm install @dvsa/cvs-type-definitions@latest`\n\n## Example usage (TS types):\n\n`import { CommercialVehicleTestSchema } from @dvsa/cvs-type-definitions/types/test`\n\n## Example usage (json schemas)\n\nThe package exports an `isValidObject()` function which can be used to validate an object against a specified schema. e.g:\n\n`import { isValidObject } from '@dvsa/cvs-type-definitions/lib/src/schema-validation../../schema-validator';`\n\n`const isValidVisit: boolean = isValidObject('visit', myVisitObject);`\n\n# Updating a schema\n\nEdits should only be made to `json` schema definitions within `json-definitions` directory.\n\nTypeScript 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.\n\n1. Navigate into the relevant schema (e.g. `./json-definitions/test/index.json`)\n2. Edit file\n3. Generate the new TypeScript and de-referenced json schema definitions using `npm run generate`\n4. Bump the version of the package using `npm version {major|minor|patch}`\n5. Publish updates\n\n# Adding a new schema\n\n1. Create a new subdirectory with an appropriate name within the `json-defininitions` directory (e.g. `my-new-schema`)\n2. 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`)\n3. Generate the new TypeScript definitions using `npm run generate`\n4. Bump the version of the package using `npm version {major|minor|patch}`\n5. Publish updates\n\n# Creating a new enum\n1. Add (or update) the enum to a file marked `*.enum.json` in the `enum` folder in `json-definitions`\n2. Make sure you give it both `enum` and `tsEnumNames` properties on the object\n3. Then update the `json-definitions` to use the new file name\n4. Run the generate and you should have just a new file in the enum folder of types, which is exportable and useable.\n\n# Publishing a new version\n\n- Raise a PR\n- 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.\n- Add a description of the changes in the `Changelog` section of the PR description\n- Once merged to develop, a github action should create a release and publish a new version of that release on npm\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdvsa%2Fcvs-type-definitions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdvsa%2Fcvs-type-definitions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdvsa%2Fcvs-type-definitions/lists"}