@dvsa/smc-encounter-schema 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Driver & Vehicle Standards Agency
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+# Encounter Schema
+
+Schemas required for Encounter submission as well as custom validators
+## Developing
+### Pre-requisites
+
+- Node.js (Please see `.nvmrc` for specific version)
+- `npm` (If using [n](https://github.com/tj/n) or [nvm](https://github.com/nvm-sh/nvm), this will be automatically managed)
+- Security
+    - [Git secrets](https://github.com/awslabs/git-secrets)
+    - [ScanRepo](https://github.com/UKHomeOffice/repo-security-scanner)
+        - Unzip `repo-security-scanner_<version>_Darwin_<architercture>.tar.gz` and rename the executable inside the folder
+          to `scanrepo` - Add executable to path (using `echo $PATH` to find your path)
+
+### Getting started
+
+###### Run the following command after cloning the project
+
+1. `npm install` (or `npm i`)
+
+###### The code that will be published lives inside the ./src directory.
+
+To simplify the publishing step, each file must be exported from the `index.ts` file.
+
+### Publishing
+
+To see the output of what will be published, run the following command:
+
+```shell
+npm publish --dry-run
+```

package/biome.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["@dvsa/biome-config/biome"]
+}

package/chunk-FKJCRL2J.mjs

@@ -0,0 +1 @@
+import {IsNotEmpty,IsString}from'class-validator';var I=Object.defineProperty;var o=(m,s,g,t)=>{for(var r=void 0,i=m.length-1,p;i>=0;i--)(p=m[i])&&(r=(p(s,g,r))||r);return r&&I(s,g,r),r};var a=class{generatedNumber};o([IsNotEmpty(),IsString()],a.prototype,"generatedNumber");export{a};

package/index.d.mts

@@ -0,0 +1,17 @@
+import * as class_validator from 'class-validator';
+import { ValidatorOptions } from 'class-validator/types/validation/ValidatorOptions';
+import { EncounterReq } from './models/request/EncounterReq.mjs';
+
+declare abstract class ValidatorBase {
+    private static _encounterReq;
+    protected constructor(encounterReq: Readonly<Partial<EncounterReq>>);
+    static get encounterReq(): Readonly<Partial<EncounterReq>>;
+}
+declare class EncounterSchema extends ValidatorBase {
+    private validationOptions;
+    private static readonly _defaultValidatorOptions;
+    constructor(encounterReq: Partial<EncounterReq>, validationOptions?: ValidatorOptions);
+    validate(): Promise<class_validator.ValidationError[]>;
+}
+
+export { EncounterSchema, ValidatorBase };

package/index.d.ts

@@ -0,0 +1,17 @@
+import * as class_validator from 'class-validator';
+import { ValidatorOptions } from 'class-validator/types/validation/ValidatorOptions';
+import { EncounterReq } from './models/request/EncounterReq.js';
+
+declare abstract class ValidatorBase {
+    private static _encounterReq;
+    protected constructor(encounterReq: Readonly<Partial<EncounterReq>>);
+    static get encounterReq(): Readonly<Partial<EncounterReq>>;
+}
+declare class EncounterSchema extends ValidatorBase {
+    private validationOptions;
+    private static readonly _defaultValidatorOptions;
+    constructor(encounterReq: Partial<EncounterReq>, validationOptions?: ValidatorOptions);
+    validate(): Promise<class_validator.ValidationError[]>;
+}
+
+export { EncounterSchema, ValidatorBase };

package/index.js

@@ -0,0 +1 @@
+'use strict';require('reflect-metadata');var classTransformer=require('class-transformer'),classValidator=require('class-validator');var d=Object.defineProperty;var p=(t,a,e,o)=>{for(var r=void 0,s=t.length-1,l;s>=0;s--)(l=t[s])&&(r=(l(a,e,r))||r);return r&&d(a,e,r),r};var n=class{generatedNumber};p([classValidator.IsNotEmpty(),classValidator.IsString()],n.prototype,"generatedNumber");var i=class t{static _encounterReq;constructor(a){t._encounterReq=a;}static get encounterReq(){return t._encounterReq}},c=class t extends i{constructor(e,o=t._defaultValidatorOptions){super(e);this.validationOptions=o;}static _defaultValidatorOptions={validationError:{target:false,value:false}};async validate(){let e=classTransformer.plainToInstance(n,i.encounterReq);return await classValidator.validate(e,this.validationOptions)}};exports.EncounterSchema=c;exports.ValidatorBase=i;

package/index.mjs

@@ -0,0 +1 @@
+import {a as a$1}from'./chunk-FKJCRL2J.mjs';import'reflect-metadata';import {plainToInstance}from'class-transformer';import {validate}from'class-validator';var a=class t{static _encounterReq;constructor(o){t._encounterReq=o;}static get encounterReq(){return t._encounterReq}},n=class t extends a{constructor(e,s=t._defaultValidatorOptions){super(e);this.validationOptions=s;}static _defaultValidatorOptions={validationError:{target:false,value:false}};async validate(){let e=plainToInstance(a$1,a.encounterReq);return await validate(e,this.validationOptions)}};export{n as EncounterSchema,a as ValidatorBase};

package/jest.config.ts

@@ -0,0 +1,8 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+};
+
+export default config;

package/models/request/EncounterReq.d.mts

@@ -0,0 +1,5 @@
+declare class EncounterReq {
+    generatedNumber: string;
+}
+
+export { EncounterReq };

package/models/request/EncounterReq.d.ts

@@ -0,0 +1,5 @@
+declare class EncounterReq {
+    generatedNumber: string;
+}
+
+export { EncounterReq };

package/models/request/EncounterReq.js

@@ -0,0 +1 @@
+'use strict';var classValidator=require('class-validator');var I=Object.defineProperty;var o=(m,s,g,t)=>{for(var r=void 0,i=m.length-1,p;i>=0;i--)(p=m[i])&&(r=(p(s,g,r))||r);return r&&I(s,g,r),r};var a=class{generatedNumber};o([classValidator.IsNotEmpty(),classValidator.IsString()],a.prototype,"generatedNumber");exports.EncounterReq=a;

package/models/request/EncounterReq.mjs

@@ -0,0 +1 @@
+export{a as EncounterReq}from'../../chunk-FKJCRL2J.mjs';

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@dvsa/smc-encounter-schema",
+  "version": "0.0.0",
+  "author": "DVSA",
+  "license": "ISC",
+  "keywords": ["dvsa", "nodejs", "typescript"],
+  "publishConfig": {
+    "directory": "dist",
+    "access": "public"
+  },
+  "scripts": {
+    "build": "npm run clean && tsup",
+    "clean": "rimraf coverage dist && npm run clean:temp",
+    "clean:temp": "rimraf api classes response",
+    "gitSecrets": "git secrets --scan . && git log -p -- . | scanrepo",
+    "lint": "biome check src",
+    "lint:fix": "npm run lint -- --write",
+    "prepare": "husky",
+    "test": "jest",
+    "test:coverage": "npm run test -- --coverage",
+    "build:package": "npm run build",
+    "prepublishOnly": "npm run build:package && cp -r ./dist/* . && rm -rf ./dist",
+    "postpublish": "git clean -fd && npm run clean:temp"
+  },
+  "dependencies": {
+    "class-validator": "^0.14.0",
+    "class-transformer": "^0.5.1",
+    "reflect-metadata": "^0.2.2"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@dvsa/biome-config": "0.4.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.15.16",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "lint-staged": "^16.1.0",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.3.4",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3"
+  },
+  "lint-staged": {
+    "*.{js,ts,mjs,css,md,ts,json}": "npm run lint:fix --ws -- --no-errors-on-unmatched"
+  }
+}

package/src/index.ts

@@ -0,0 +1,35 @@
+import 'reflect-metadata';
+import { plainToInstance } from 'class-transformer';
+import { validate as validateEncounter } from 'class-validator';
+import type { ValidatorOptions } from 'class-validator/types/validation/ValidatorOptions';
+import { EncounterReq } from './models/request/EncounterReq';
+
+export abstract class ValidatorBase {
+	private static _encounterReq: Readonly<Partial<EncounterReq>>;
+
+	protected constructor(encounterReq: Readonly<Partial<EncounterReq>>) {
+		ValidatorBase._encounterReq = encounterReq;
+	}
+
+	static get encounterReq(): Readonly<Partial<EncounterReq>> {
+		return ValidatorBase._encounterReq;
+	}
+}
+
+export class EncounterSchema extends ValidatorBase {
+	private static readonly _defaultValidatorOptions: ValidatorOptions = {
+		validationError: { target: false, value: false },
+	};
+
+	constructor(
+		encounterReq: Partial<EncounterReq>,
+		private validationOptions: ValidatorOptions = EncounterSchema._defaultValidatorOptions
+	) {
+		super(encounterReq);
+	}
+
+	async validate() {
+		const encounterReqInstance = plainToInstance(EncounterReq, ValidatorBase.encounterReq);
+		return await validateEncounter(encounterReqInstance, this.validationOptions);
+	}
+}

package/src/models/__mocks__/invalid/missing-mandatory.json

@@ -0,0 +1 @@
+{}

package/src/models/__mocks__/valid/complete-encounter.json

@@ -0,0 +1,3 @@
+{
+  "generatedNumber": "123"
+}

package/src/models/__tests__/index.spec.ts

@@ -0,0 +1,20 @@
+import { EncounterSchema } from '../../index';
+import * as MissingMandatory from '../__mocks__/invalid/missing-mandatory.json';
+import * as CompleteEncounter from '../__mocks__/valid/complete-encounter.json';
+
+describe('Encounter Schema Tests', () => {
+	describe('Valid encounters', () => {
+		it('should return 0 errors for a valid encounter', async () => {
+			const encounterSchema = new EncounterSchema(CompleteEncounter);
+			expect(await encounterSchema.validate()).toHaveLength(0);
+		});
+	});
+
+	describe('Invalid encounters', () => {
+		it('should return errors for an invalid encounter', async () => {
+			const encounterSchema = new EncounterSchema(MissingMandatory);
+			const validationErrors = await encounterSchema.validate();
+			expect(validationErrors).toHaveLength(1);
+		});
+	});
+});

package/src/models/request/EncounterReq.ts

@@ -0,0 +1,7 @@
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class EncounterReq {
+	@IsNotEmpty()
+	@IsString()
+	generatedNumber!: string;
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022"],
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "module": "CommonJS",
+    "types": ["node", "jest"],
+    "declaration": true,
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "src/**/*.spec.ts", "src/**/*.spec.d.ts"]
+}

package/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+	entry: ['src/**/*.ts', '!src/**/*.spec.ts'],
+	format: ['esm', 'cjs'],
+	outDir: 'dist',
+	treeshake: true,
+	minify: true,
+	dts: true,
+});