@geekbears/gb-class-validators 0.0.10

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "bracketSpacing": true,
+  "singleQuote": true,
+  "printWidth": 120,
+  "trailingComma": "all",
+  "tabWidth": 4,
+  "semi": true,
+  "arrowParens": "avoid"
+}

package/README.md

@@ -0,0 +1 @@
+# Geekbears Custom Class Validators

package/jest-config.json

@@ -0,0 +1,7 @@
+{
+    "transform": {
+        "^.+\\.(t|j)sx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
+    "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
+}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './validators';

package/lib/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./validators"), exports);

package/lib/validators/exact-match.validator.d.ts

@@ -0,0 +1,2 @@
+import { ValidationOptions } from 'class-validator';
+export declare function ExactMatch(property: string, validationOptions?: ValidationOptions): (object: object, propertyName: string) => void;

package/lib/validators/exact-match.validator.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExactMatch = void 0;
+const class_validator_1 = require("class-validator");
+const lodash_1 = require("lodash");
+function ExactMatch(property, validationOptions) {
+    return (object, propertyName) => {
+        (0, class_validator_1.registerDecorator)({
+            name: 'exactMatch',
+            target: object.constructor,
+            propertyName,
+            constraints: [property],
+            options: validationOptions,
+            validator: {
+                validate(value, args) {
+                    const [relatedPropertyName] = args.constraints;
+                    const relatedValue = args.object[relatedPropertyName];
+                    return (0, lodash_1.isEqual)(value, relatedValue);
+                },
+            },
+        });
+    };
+}
+exports.ExactMatch = ExactMatch;

package/lib/validators/index.d.ts

@@ -0,0 +1,3 @@
+export * from './exact-match.validator';
+export * from './is-included-in.validator';
+export * from './phone.validator';

package/lib/validators/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./exact-match.validator"), exports);
+__exportStar(require("./is-included-in.validator"), exports);
+__exportStar(require("./phone.validator"), exports);

package/lib/validators/is-included-in.validator.d.ts

@@ -0,0 +1,2 @@
+import { ValidationOptions } from 'class-validator';
+export declare function IsIncludedIn(property: string[], validationOptions?: ValidationOptions): (object: object, propertyName: string) => void;

package/lib/validators/is-included-in.validator.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IsIncludedIn = void 0;
+const class_validator_1 = require("class-validator");
+function IsIncludedIn(property, validationOptions) {
+    return (object, propertyName) => {
+        (0, class_validator_1.registerDecorator)({
+            name: 'isIncludedIn',
+            target: object.constructor,
+            propertyName,
+            constraints: [property],
+            options: validationOptions,
+            validator: {
+                validate(value, args) {
+                    const [array] = args.constraints;
+                    return array.includes(value);
+                },
+            },
+        });
+    };
+}
+exports.IsIncludedIn = IsIncludedIn;

package/lib/validators/phone.validator.d.ts

@@ -0,0 +1,8 @@
+import { ValidationOptions } from 'class-validator';
+import { CountryCode } from 'libphonenumber-js';
+interface IsGBPhoneParams {
+    dev: CountryCode[];
+    prod: CountryCode[];
+}
+export declare function IsGBPhoneNumber(params: IsGBPhoneParams, validationOptions?: ValidationOptions): (object: Record<string, any>, propertyName: string) => void;
+export {};

package/lib/validators/phone.validator.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IsGBPhoneNumber = void 0;
+const class_validator_1 = require("class-validator");
+const libphonenumber_js_1 = require("libphonenumber-js");
+const lodash_1 = require("lodash");
+function IsGBPhoneNumber(params, validationOptions) {
+    return (object, propertyName) => {
+        (0, class_validator_1.registerDecorator)({
+            name: 'IsGBPhoneNumber',
+            target: object.constructor,
+            propertyName,
+            constraints: [[...params.dev], [...params.prod]],
+            options: validationOptions,
+            validator: {
+                validate(value, args) {
+                    const [validDevRegions, validProdRegions] = args.constraints;
+                    if (typeof value !== 'string')
+                        return false;
+                    const parsed = (0, libphonenumber_js_1.parsePhoneNumberFromString)(value);
+                    if (!parsed)
+                        return false;
+                    if (process.env.NODE_ENV === 'production') {
+                        return !(0, lodash_1.isEmpty)(validProdRegions) ? validProdRegions.includes(parsed.country) : true;
+                    }
+                    return !(0, lodash_1.isEmpty)(validDevRegions) ? validDevRegions.includes(parsed.country) : true;
+                },
+            },
+        });
+    };
+}
+exports.IsGBPhoneNumber = IsGBPhoneNumber;

package/package.json

@@ -0,0 +1,63 @@
+{
+    "name": "@geekbears/gb-class-validators",
+    "version": "0.0.10",
+    "description": "Geekbears custom validators using class-validator package.",
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "scripts": {
+        "test": "jest --config jest-config.json",
+        "prebuild": "rimraf lib",
+        "build": "tsc",
+        "format": "prettier --write \"src/**/*.ts\"",
+        "lint": "tslint -p tsconfig.json",
+        "prepare": "npm run build",
+        "prepublishOnly": "npm test && npm run lint",
+        "preversion": "npm run lint",
+        "version": "npm run format && git add -A src",
+        "postversion": "git push"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+ssh://git@gitlab.com/geekbears/utilities/backend/gb-class-validators.git"
+    },
+    "keywords": [
+        "class-validators",
+        "validators",
+        "geekbears"
+    ],
+    "author": {
+        "email": "it@geekbears.com",
+        "name": "It Geekbears"
+    },
+    "contributors": [
+        {
+            "email": "bruno@geekbears.com",
+            "name": "Bruno Jardon"
+        },
+        {
+            "email": "ivan@geekbears.com",
+            "name": "Ivan Rangel"
+        }
+    ],
+    "license": "MIT",
+    "bugs": {
+        "url": "https://gitlab.com/geekbears/utilities/backend/gb-class-validators/issues"
+    },
+    "homepage": "https://gitlab.com/geekbears/utilities/backend/gb-class-validators#readme",
+    "devDependencies": {
+        "@types/jest": "^29.5.1",
+        "@types/lodash": "^4.14.194",
+        "@types/validator": "^13.7.16",
+        "jest": "^29.5.0",
+        "prettier": "^2.8.8",
+        "rimraf": "^5.0.0",
+        "ts-jest": "^29.1.0",
+        "tslint": "^6.1.3",
+        "tslint-config-prettier": "^1.18.0",
+        "typescript": "^5.0.4"
+    },
+    "dependencies": {
+        "class-validator": "^0.14.0",
+        "lodash": "^4.17.21"
+    }
+}

package/src/__tests__/exact-validators.test.ts

@@ -0,0 +1,32 @@
+import { Validator } from 'class-validator';
+import { before } from 'lodash';
+import { ExactMatch } from '../validators';
+
+class MyClass {
+    @ExactMatch('lastName', {
+        message: '$property must be longer then $constraint1. Given value: $value',
+    })
+    firstName: string;
+    lastName: string;
+}
+
+describe('Exact Match Validator', () => {
+    let validator: Validator;
+
+    beforeEach(() => {
+        validator = new Validator();
+    });
+    test('should fail exact match verifications', async () => {
+        const model = new MyClass();
+        model.firstName = 'Name';
+        const errors = await validator.validate(model);
+        expect(errors.length).toEqual(1);
+    });
+    test('should pass match verifications', async () => {
+        const model = new MyClass();
+        model.firstName = 'Name';
+        model.lastName = 'Name';
+        const errors = await validator.validate(model);
+        expect(errors.length).toEqual(0);
+    });
+});

package/src/__tests__/is-included-in-validators.test.ts

@@ -0,0 +1,27 @@
+import { Validator } from 'class-validator';
+import { IsIncludedIn } from '../validators';
+
+class MyClass {
+    @IsIncludedIn(['word'])
+    words: string;
+}
+
+describe('Exact Match Validator', () => {
+    let validator: Validator;
+
+    beforeEach(() => {
+        validator = new Validator();
+    });
+    test('should fail exact match verifications', async () => {
+        const model = new MyClass();
+        model.words = 'not included';
+        const errors = await validator.validate(model);
+        expect(errors.length).toEqual(1);
+    });
+    test('should pass match verifications', async () => {
+        const model = new MyClass();
+        model.words = 'word';
+        const errors = await validator.validate(model);
+        expect(errors.length).toEqual(0);
+    });
+});

package/src/__tests__/phone-validators.test.ts

@@ -0,0 +1,100 @@
+import { Validator } from 'class-validator';
+import { IsGBPhoneNumber } from '../validators';
+
+class TestClass {
+    @IsGBPhoneNumber({ dev: ['US'], prod: ['US'] })
+    phone: any; // Type is any to mimmick JSON requests behavior
+}
+
+describe('Phone Validator', () => {
+    let validator: Validator;
+
+    beforeEach(() => {
+        validator = new Validator();
+    });
+
+    describe('Env different from production', () => {
+        test('should fail when not a string', async () => {
+            const model = new TestClass();
+            model.phone = 98234;
+            const errors = await validator.validate(model);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+
+        test('should fail when not providing an international code', async () => {
+            const model = new TestClass();
+            model.phone = '2025550115';
+            const errors = await validator.validate(model);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+
+        test('should fail when providing an invalid phone number', async () => {
+            const model = new TestClass();
+            model.phone = '98234';
+            const errors = await validator.validate(model);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+
+        test('should fail when providing a number from an invalid region', async () => {
+            const model = new TestClass();
+            model.phone = '+525522626391';
+            const errors = await validator.validate(model);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+
+        test('should pass when providing a valid phone number', async () => {
+            const model = new TestClass();
+            model.phone = '+12025550115';
+            const errors = await validator.validate(model);
+            expect(errors.length).toEqual(0);
+        });
+    });
+
+    describe('Prod env', () => {
+        const ENV = process.env;
+
+        beforeEach(() => {
+            jest.resetModules();
+            process.env = { ...ENV, NODE_ENV: 'production' };
+        });
+
+        afterEach(() => {
+            process.env = ENV;
+        });
+
+        test('should fail when not a string', async () => {
+            const model = new TestClass();
+            model.phone = 98234;
+            const errors = await validator.validate(model);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+
+        test('should fail when not providing an international code', async () => {
+            const model = new TestClass();
+            model.phone = '2025550115';
+            const errors = await validator.validate(model);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+
+        test('should fail when providing an invalid phone number', async () => {
+            const model = new TestClass();
+            model.phone = '98234';
+            const errors = await validator.validate(model);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+
+        test('should fail when providing a number from an invalid region', async () => {
+            const model = new TestClass();
+            model.phone = '+525522626391';
+            const errors = await validator.validate(model);
+            expect(errors.length).toBeGreaterThan(0);
+        });
+
+        test('should pass when providing a valid phone number', async () => {
+            const model = new TestClass();
+            model.phone = '+12025550115';
+            const errors = await validator.validate(model);
+            expect(errors.length).toEqual(0);
+        });
+    });
+});

package/src/index.ts

@@ -0,0 +1 @@
+export * from './validators';

package/src/validators/exact-match.validator.ts

@@ -0,0 +1,21 @@
+import { registerDecorator, ValidationArguments, ValidationOptions } from 'class-validator';
+import { isEqual } from 'lodash';
+
+export function ExactMatch(property: string, validationOptions?: ValidationOptions) {
+    return (object: object, propertyName: string) => {
+        registerDecorator({
+            name: 'exactMatch',
+            target: object.constructor,
+            propertyName,
+            constraints: [property],
+            options: validationOptions,
+            validator: {
+                validate(value: any, args: ValidationArguments) {
+                    const [relatedPropertyName] = args.constraints;
+                    const relatedValue = (args.object as any)[relatedPropertyName];
+                    return isEqual(value, relatedValue);
+                },
+            },
+        });
+    };
+}

package/src/validators/index.ts

@@ -0,0 +1,3 @@
+export * from './exact-match.validator';
+export * from './is-included-in.validator';
+export * from './phone.validator';

package/src/validators/is-included-in.validator.ts

@@ -0,0 +1,19 @@
+import { registerDecorator, ValidationArguments, ValidationOptions } from 'class-validator';
+
+export function IsIncludedIn(property: string[], validationOptions?: ValidationOptions) {
+    return (object: object, propertyName: string) => {
+        registerDecorator({
+            name: 'isIncludedIn',
+            target: object.constructor,
+            propertyName,
+            constraints: [property],
+            options: validationOptions,
+            validator: {
+                validate(value: string, args: ValidationArguments) {
+                    const [array] = args.constraints as string[][];
+                    return array.includes(value);
+                },
+            },
+        });
+    };
+}

package/src/validators/phone.validator.ts

@@ -0,0 +1,37 @@
+import { ValidationOptions, registerDecorator, ValidationArguments } from 'class-validator';
+import { parsePhoneNumberFromString, CountryCode } from 'libphonenumber-js';
+import { isEmpty } from 'lodash';
+
+interface IsGBPhoneParams {
+    dev: CountryCode[];
+    prod: CountryCode[];
+}
+
+export function IsGBPhoneNumber(params: IsGBPhoneParams, validationOptions?: ValidationOptions) {
+    return (object: Record<string, any>, propertyName: string) => {
+        registerDecorator({
+            name: 'IsGBPhoneNumber',
+            target: object.constructor,
+            propertyName,
+            constraints: [[...params.dev], [...params.prod]],
+            options: validationOptions,
+            validator: {
+                validate(value: any, args: ValidationArguments) {
+                    const [validDevRegions, validProdRegions] = args.constraints;
+
+                    if (typeof value !== 'string') return false;
+
+                    const parsed = parsePhoneNumberFromString(value);
+
+                    if (!parsed) return false;
+
+                    if (process.env.NODE_ENV === 'production') {
+                        return !isEmpty(validProdRegions) ? validProdRegions.includes(parsed.country) : true;
+                    }
+
+                    return !isEmpty(validDevRegions) ? validDevRegions.includes(parsed.country) : true;
+                },
+            },
+        });
+    };
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+        "target": "es6",
+        "module": "commonjs",
+        "declaration": true,
+        "outDir": "./lib",
+        "strict": true,
+        "experimentalDecorators": true,
+        "strictPropertyInitialization": false
+    },
+    "include": ["src"],
+    "exclude": ["node_modules", "**/__tests__/*"]
+}

package/tslint.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["tslint:recommended", "tslint-config-prettier"]
+}