feat: add loose UUID validation and update documentation

Author: PleBea

README.md

@@ -885,7 +885,7 @@ isBoolean(value);
 | `@IsTaxId()`                                           | Checks if the string is a valid tax ID. Default locale is `en-US`.                                                                                                                                    |
 | `@IsUrl(options?: IsURLOptions)`                       | Checks if the string is a URL.                                                                                                                                                                        |
 | `@IsMagnetURI()`                                       | Checks if the string is a [magnet uri format](https://en.wikipedia.org/wiki/Magnet_URI_scheme).                                                                                                       |
-| `@IsUUID(version?: UUIDVersion)`                       | Checks if the string is a UUID (version 3, 4, 5 or all ).                                                                                                                                             |
+| `@IsUUID(version?: UUIDVersion)`                       | Checks if the string is a UUID (version 1-8, nil, max, loose, all).                                                                                                                                   |
 | `@IsFirebasePushId()`                                  | Checks if the string is a [Firebase Push ID](https://firebase.googleblog.com/2015/02/the-2120-ways-to-ensure-unique_68.html)                                                                          |
 | `@IsUppercase()`                                       | Checks if the string is uppercase.                                                                                                                                                                    |
 | `@Length(min: number, max?: number)`                   | Checks if the string's length falls in a range.                                                                                                                                                       |

src/decorator/string/IsUUID.ts

@@ -6,15 +6,15 @@ import * as ValidatorJS from 'validator';
 export const IS_UUID = 'isUuid';
 
 /**
- * Checks if the string is a UUID (version 1-8, nil, max, all).
+ * Checks if the string is a UUID (version 1-8, nil, max, loose, all).
  * If given value is not a string, then it returns false.
  */
 export function isUUID(value: unknown, version?: ValidatorJS.UUIDVersion): boolean {
   return typeof value === 'string' && isUuidValidator(value, version);
 }
 
 /**
- * Checks if the string is a UUID (version 1-8, nil, max, all).
+ * Checks if the string is a UUID (version 1-8, nil, max, loose, all).
  * If given value is not a string, then it returns false.
  */
 export function IsUUID(version?: ValidatorJS.UUIDVersion, validationOptions?: ValidationOptions): PropertyDecorator {

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

@@ -4063,6 +4063,50 @@ describe('IsUUID all', () => {
   });
 });
 
+describe('IsUUID loose', () => {
+  const validValues = [
+    'A987FBC9-4BED-3078-8F07-9141BA07C9F3',
+    '{A987FBC9-4BED-3078-8F07-9141BA07C9F3}',
+    '{a987fbc9-4bed-3078-8f07-9141ba07c9f3}',
+    'A987FBC94BED30788F079141BA07C9F3',
+  ];
+  const invalidValues = [
+    null,
+    undefined,
+    '',
+    'xxxA987FBC9-4BED-3078-CF07-9141BA07C9F3',
+    '934859',
+    'AAAAAAAA-1111-1111-AAAG-111111111111',
+  ];
+
+  class MyClass {
+    @IsUUID('loose')
+    someProperty: string;
+  }
+
+  it('should not fail if validator.validate said that its valid', () => {
+    return checkValidValues(new MyClass(), validValues);
+  });
+
+  it('should fail if validator.validate said that its invalid', () => {
+    return checkInvalidValues(new MyClass(), invalidValues);
+  });
+
+  it('should not fail if method in validator said that its valid', () => {
+    validValues.forEach(value => expect(isUUID(value, 'loose')).toBeTruthy());
+  });
+
+  it('should fail if method in validator said that its invalid', () => {
+    invalidValues.forEach(value => expect(isUUID(value, 'loose')).toBeFalsy());
+  });
+
+  it('should return error object with proper data', () => {
+    const validationType = 'isUuid';
+    const message = 'someProperty must be a UUID';
+    return checkReturnedError(new MyClass(), invalidValues, validationType, message);
+  });
+});
+
 describe('IsFirebasePushId', () => {
   const validValues = [
     '-M-Jh_1KAH5rYJF_7-kY',