@geekbears/gb-class-validators 0.0.21 → 0.0.23

package/eslint.config.mjs

@@ -0,0 +1,183 @@
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import globals from "globals";
+import tsParser from "@typescript-eslint/parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+export default [...compat.extends(
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "prettier",
+), {
+    plugins: {
+
+
+        "@typescript-eslint": typescriptEslint,
+    },
+
+    languageOptions: {
+        globals: {
+            ...globals.node,
+        },
+
+        parser: tsParser,
+        ecmaVersion: 5,
+        sourceType: "module",
+
+        parserOptions: {
+            project: "tsconfig.json",
+        },
+    },
+
+    rules: {
+        "@typescript-eslint/adjacent-overload-signatures": "error",
+
+        "@typescript-eslint/array-type": ["error", {
+            default: "array",
+        }],
+
+
+
+        "@typescript-eslint/consistent-type-assertions": "error",
+        "@typescript-eslint/dot-notation": "error",
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/indent": "off",
+
+        "@typescript-eslint/member-delimiter-style": ["off", {
+            multiline: {
+                delimiter: "none",
+                requireLast: true,
+            },
+
+            singleline: {
+                delimiter: "semi",
+                requireLast: false,
+            },
+        }],
+
+        "@typescript-eslint/naming-convention": ["error", {
+            selector: "variable",
+            format: ["camelCase", "UPPER_CASE", "PascalCase"],
+            leadingUnderscore: "allow",
+            trailingUnderscore: "forbid",
+        }],
+
+        "@typescript-eslint/no-empty-function": "error",
+        "@typescript-eslint/no-empty-interface": "error",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-misused-new": "error",
+        "@typescript-eslint/no-namespace": "error",
+        "@typescript-eslint/no-parameter-properties": "off",
+
+        "@typescript-eslint/no-shadow": ["error", {
+            hoist: "all",
+        }],
+
+        "@typescript-eslint/no-unused-expressions": "error",
+        "@typescript-eslint/no-use-before-define": "off",
+        "@typescript-eslint/no-var-requires": "error",
+        "@typescript-eslint/prefer-for-of": "error",
+        "@typescript-eslint/prefer-function-type": "error",
+        "@typescript-eslint/prefer-namespace-keyword": "error",
+        "@typescript-eslint/quotes": "off",
+        "@typescript-eslint/semi": ["off", null],
+
+        "@typescript-eslint/triple-slash-reference": ["error", {
+            path: "always",
+            types: "prefer-import",
+            lib: "always",
+        }],
+
+        "@typescript-eslint/type-annotation-spacing": "off",
+        "@typescript-eslint/typedef": "off",
+        "@typescript-eslint/unified-signatures": "error",
+        "arrow-parens": ["off", "always"],
+        "brace-style": ["off", "off"],
+        "comma-dangle": "off",
+        complexity: "off",
+        "constructor-super": "error",
+        "dot-notation": "off",
+        "eol-last": "off",
+        eqeqeq: ["error", "smart"],
+        "guard-for-in": "error",
+
+        "id-denylist": [
+            "error",
+            "any",
+            "Number",
+            "number",
+            "String",
+            "string",
+            "Boolean",
+            "boolean",
+            "Undefined",
+            "undefined",
+        ],
+
+        "id-match": "error",
+        indent: "off",
+        "linebreak-style": "off",
+        "max-classes-per-file": ["error", 1],
+        "max-len": "off",
+        "new-parens": "off",
+        "newline-per-chained-call": "off",
+        "no-bitwise": "error",
+        "no-caller": "error",
+        "no-cond-assign": "error",
+        "no-console": "error",
+        "no-debugger": "error",
+        "no-empty": "error",
+        "no-empty-function": "off",
+        "no-eval": "error",
+        "no-extra-semi": "off",
+        "no-fallthrough": "off",
+        "no-invalid-this": "off",
+        "no-irregular-whitespace": "off",
+        "no-multiple-empty-lines": "off",
+        "no-new-wrappers": "error",
+        "no-shadow": "off",
+        "no-throw-literal": "error",
+        "no-trailing-spaces": "off",
+        "no-undef-init": "error",
+        "no-underscore-dangle": "off",
+        "no-unsafe-finally": "error",
+        "no-unused-expressions": "off",
+        "no-unused-labels": "error",
+        "no-use-before-define": "off",
+        "no-var": "error",
+        "object-shorthand": "error",
+        "one-var": ["error", "never"],
+
+        "padded-blocks": ["off", {
+            blocks: "never",
+        }, {
+                allowSingleLineBlocks: true,
+            }],
+        "prefer-const": "error",
+        "quote-props": "off",
+        quotes: "off",
+        radix: "error",
+
+        semi: "off",
+        "space-before-function-paren": "off",
+        "space-in-parens": ["off", "never"],
+
+        "spaced-comment": ["error", "always", {
+            markers: ["/"],
+        }],
+
+        "use-isnan": "error",
+        "valid-typeof": "off",
+    },
+}];

package/lib/validators/index.d.ts

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

package/lib/validators/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./exact-match.validator"), exports);
 __exportStar(require("./is-included-in.validator"), exports);
 __exportStar(require("./phone.validator"), exports);
+__exportStar(require("./phone-v2.validator"), exports);

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

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

package/lib/validators/phone-v2.validator.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IsGBPhoneNumberV2 = IsGBPhoneNumberV2;
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const class_validator_1 = require("class-validator");
+const google_libphonenumber_1 = require("google-libphonenumber");
+function IsGBPhoneNumberV2(validationOptions) {
+    return function (object, propertyName) {
+        (0, class_validator_1.registerDecorator)({
+            target: object.constructor,
+            propertyName,
+            options: validationOptions,
+            constraints: [],
+            validator: {
+                validate(value, args) {
+                    let isValid = false;
+                    if (typeof value !== 'string')
+                        return isValid;
+                    const phoneUtil = google_libphonenumber_1.PhoneNumberUtil.getInstance();
+                    try {
+                        const parsedNumber = phoneUtil.parseAndKeepRawInput(value, '');
+                        isValid = phoneUtil.isValidNumber(parsedNumber);
+                    }
+                    catch (error) {
+                        return isValid;
+                    }
+                    return isValid;
+                },
+                defaultMessage(args) {
+                    return 'The phone number ($value) is not valid!';
+                },
+            },
+        });
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@geekbears/gb-class-validators",
-    "version": "0.0.21",
+    "version": "0.0.23",
     "description": "Geekbears custom validators using class-validator package.",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -9,7 +9,7 @@
         "prebuild": "rimraf lib",
         "build": "tsc",
         "format": "prettier --write \"src/**/*.ts\"",
-        "lint": "tslint -p tsconfig.json",
+        "lint": "eslint -c eslint.config.mjs src/*.ts --fix",
         "prepare": "npm run build",
         "prepublishOnly": "npm test && npm run lint",
         "preversion": "npm run lint",
@@ -37,6 +37,10 @@
         {
             "email": "ivan@geekbears.com",
             "name": "Ivan Rangel"
+        },
+        {
+            "email": "jorge.davalos@geekbears.com",
+            "name": "Jorge Dávalos"
         }
     ],
     "license": "MIT",
@@ -45,19 +49,27 @@
     },
     "homepage": "https://gitlab.com/geekbears/utilities/backend/gb-class-validators#readme",
     "devDependencies": {
-        "@types/jest": "^29.5.13",
-        "@types/lodash": "^4.17.9",
+        "@eslint/eslintrc": "^3.2.0",
+        "@eslint/js": "^9.15.0",
+        "@types/google-libphonenumber": "^7.4.30",
+        "@types/jest": "^29.5.14",
+        "@types/lodash": "^4.17.13",
         "@types/validator": "^13.12.2",
+        "@typescript-eslint/eslint-plugin": "^8.16.0",
+        "@typescript-eslint/parser": "^8.15.0",
+        "eslint": "^9.15.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-prettier": "^5.2.1",
+        "globals": "^15.12.0",
         "jest": "^29.7.0",
         "prettier": "^3.3.3",
         "rimraf": "^6.0.1",
         "ts-jest": "^29.2.5",
-        "tslint": "^6.1.3",
-        "tslint-config-prettier": "^1.18.0",
-        "typescript": "^5.6.2"
+        "typescript": "^5.7.2"
     },
     "dependencies": {
         "class-validator": "^0.14.1",
+        "google-libphonenumber": "^3.2.39",
         "lodash": "^4.17.21"
     }
 }

package/src/__tests__/phone-validator-v2.test.ts

@@ -0,0 +1,64 @@
+import { Validator } from 'class-validator';
+import { IsGBPhoneNumberV2 } from '../validators';
+
+class TestClass {
+    @IsGBPhoneNumberV2()
+    phone: any;
+}
+
+describe('Phone Validator V2', () => {
+    let validator: Validator;
+
+    beforeEach(() => {
+        validator = new Validator();
+    });
+
+    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 providing a non-international phone number (missing country 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 (incorrect format)', 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 phone number with an invalid country code', async () => {
+        const model = new TestClass();
+        model.phone = '+535522626391';
+        const errors = await validator.validate(model);
+        expect(errors.length).toBeGreaterThan(0);
+    });
+
+    test('should pass when providing a valid phone number with an international code', async () => {
+        const model = new TestClass();
+        model.phone = '+44 7911 123456';
+        const errors = await validator.validate(model);
+        expect(errors.length).toEqual(0);
+    });
+
+    test("should fail when providing a phone number that can't be parsed by google-libphonenumber", async () => {
+        const model = new TestClass();
+        model.phone = '+12345';
+        const errors = await validator.validate(model);
+        expect(errors.length).toBeGreaterThan(0);
+    });
+
+    test('should fail when providing an incomplete phone number', async () => {
+        const model = new TestClass();
+        model.phone = '+44 791';
+        const errors = await validator.validate(model);
+        expect(errors.length).toBeGreaterThan(0);
+    });
+});

package/src/validators/index.ts

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

package/src/validators/phone-v2.validator.ts

@@ -0,0 +1,35 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { ValidationOptions, registerDecorator, ValidationArguments } from 'class-validator';
+import { PhoneNumberUtil } from 'google-libphonenumber';
+
+export function IsGBPhoneNumberV2(validationOptions?: ValidationOptions) {
+    return function (object: object, propertyName: string) {
+        registerDecorator({
+            target: object.constructor,
+            propertyName,
+            options: validationOptions,
+            constraints: [],
+            validator: {
+                validate(value: any, args: ValidationArguments) {
+                    let isValid = false;
+                    if (typeof value !== 'string') return isValid;
+                    const phoneUtil = PhoneNumberUtil.getInstance();
+                    try {
+                        const parsedNumber = phoneUtil.parseAndKeepRawInput(value, '');
+                        isValid = phoneUtil.isValidNumber(parsedNumber);
+                    } catch (error) {
+                        return isValid;
+                    }
+                    return isValid;
+                },
+
+                defaultMessage(args: ValidationArguments) {
+                    return 'The phone number ($value) is not valid!';
+                },
+            },
+        });
+    };
+}