feat: add isJWT validator (#444)

Author: Kiliandeca

README.md

@@ -837,6 +837,7 @@ validator.isISBN(str, version); // Checks if the string is an ISBN (version 10 o
 validator.isISIN(str); // Checks if the string is an ISIN (stock/security identifier).
 validator.isISO8601(str); // Checks if the string is a valid ISO 8601 date.
 validator.isJSON(str); // Checks if the string is valid JSON (note: uses JSON.parse).
+validator.isJWT(str) // Checks if the string is valid JWT.
 validator.isObject(object); // Checks if the object is valid Object (null, functions, arrays will return false)
 validator.isNotEmptyObject(object); // Checks if the object is not empty
 validator.isLowercase(str); // Checks if the string is lowercase.
@@ -929,6 +930,7 @@ validator.isInstance(value, target); // Checks value is an instance of the targe
 | `@IsISIN()`                                     | Checks if the string is an ISIN (stock/security identifier).                                                                     |
 | `@IsISO8601()`                                  | Checks if the string is a valid ISO 8601 date.                                                                                   |
 | `@IsJSON()`                                     | Checks if the string is valid JSON.                                                                                              |
+| `@IsJWT()`                                      | Checks if the string is valid JWT.                                                                                                |
 | `@IsObject()`                                   | Checks if the object is valid Object (null, functions, arrays will return false).                                                                                              |
 | `@IsNotEmptyObject()`                           | Checks if the object is not empty.                                                                                              |
 | `@IsLowercase()`                                | Checks if the string is lowercase.                                                                                               |

src/decorator/decorators.ts

@@ -923,6 +923,21 @@ export function IsJSON(validationOptions?: ValidationOptions) {
     };
 }
 
+/**
+ * Checks if the string is valid JWT.
+ */
+export function IsJWT(validationOptions?: ValidationOptions) {
+    return function (object: Object, propertyName: string) {
+        const args: ValidationMetadataArgs = {
+            type: ValidationTypes.IS_JWT,
+            target: object.constructor,
+            propertyName: propertyName,
+            validationOptions: validationOptions
+        };
+        getFromContainer(MetadataStorage).addValidationMetadata(new ValidationMetadata(args));
+    };
+}
+
 /**
  * Checks if the value is a valid object.
  */

src/validation/ValidationTypes.ts

@@ -73,6 +73,7 @@ export class ValidationTypes {
     static IS_ISIN = "isIsin";
     static IS_ISO8601 = "isIso8601";
     static IS_JSON = "isJson";
+    static IS_JWT = "isJwt";
     static IS_OBJECT = "isObject";
     static IS_NOT_EMPTY_OBJECT = "isNotEmptyObject";
     static IS_LOWERCASE = "isLowercase";
@@ -227,6 +228,8 @@ export class ValidationTypes {
                 return eachPrefix + "$property must be a valid ISO 8601 date string";
             case this.IS_JSON:
                 return eachPrefix + "$property must be a json string";
+            case this.IS_JWT:
+                return eachPrefix + "$property must be a jwt string";
             case this.IS_OBJECT:
                 return eachPrefix + "$property must be an object";
             case this.IS_NOT_EMPTY_OBJECT:

src/validation/Validator.ts

@@ -230,6 +230,8 @@ export class Validator {
                 return this.isISO8601(value);
             case ValidationTypes.IS_JSON:
                 return this.isJSON(value);
+            case ValidationTypes.IS_JWT:
+                return this.isJWT(value);
             case ValidationTypes.IS_OBJECT:
                 return this.isObject(value);
             case ValidationTypes.IS_NOT_EMPTY_OBJECT:
@@ -704,6 +706,14 @@ export class Validator {
         return typeof value === "string" && this.validatorJs.isJSON(value);
     }
 
+    /**
+     * Checks if the string is valid JWT token.
+     * If given value is not a string, then it returns false.
+     */
+    isJWT(value: unknown): boolean {
+        return typeof value === "string" && this.validatorJs.isJWT(value);
+    }
+
     /**
      * Checks if the value is valid Object.
      * Returns false if the value is not an object.

test/functional/validation-functions-and-decorators.spec.ts

@@ -36,6 +36,7 @@ import {
     IsIn,
     IsInt,
     IsJSON,
+    IsJWT,
     IsObject,
     IsNotEmptyObject,
     Length,
@@ -2314,6 +2315,50 @@ describe("IsJSON", function() {
 
 });
 
+describe("IsJWT", function() {
+
+    const validValues = [
+        "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dnZWRJbkFzIjoiYWRtaW4iLCJpYXQiOjE0MjI3Nzk2Mzh9.gzSraSYS8EXBxLN_oWnFSRgCzcmJmMjLiuyu5CSpyHI",
+        "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb3JlbSI6Imlwc3VtIn0.ymiJSsMJXR6tMSr8G9usjQ15_8hKPDv_CArLhxw28MI",
+        "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkb2xvciI6InNpdCIsImFtZXQiOlsibG9yZW0iLCJpcHN1bSJdfQ.rRpe04zbWbbJjwM43VnHzAboDzszJtGrNsUxaqQ-GQ8",
+        "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqb2huIjp7ImFnZSI6MjUsImhlaWdodCI6MTg1fSwiamFrZSI6eyJhZ2UiOjMwLCJoZWlnaHQiOjI3MH19.YRLPARDmhGMC3BBk_OhtwwK21PIkVCqQe8ncIRPKo-E",
+        "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ", // No signature
+      ];
+    const invalidValues = [
+        "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
+        "$Zs.ewu.su84",
+        "ks64$S/9.dy$§kz.3sd73b",
+      ];
+
+    class MyClass {
+        @IsJWT()
+        someProperty: string;
+    }
+
+    it("should not fail if validator.validate said that its valid", function(done) {
+        checkValidValues(new MyClass(), validValues, done);
+    });
+
+    it("should fail if validator.validate said that its invalid", function(done) {
+        checkInvalidValues(new MyClass(), invalidValues, done);
+    });
+
+    it("should not fail if method in validator said that its valid", function() {
+        validValues.forEach(value => validator.isJWT(value).should.be.true);
+    });
+
+    it("should fail if method in validator said that its invalid", function() {
+        invalidValues.forEach(value => validator.isJWT(value).should.be.false);
+    });
+
+    it("should return error object with proper data", function(done) {
+        const validationType = "isJwt";
+        const message = "someProperty must be a jwt string";
+        checkReturnedError(new MyClass(), invalidValues, validationType, message, done);
+    });
+
+});
+
 describe("IsObject", function() {
 
     const validValues = [{ "key": "value" }, { key: "value" }, {}];