@fluojs/validation 1.0.0-beta.1 → 1.0.0-beta.3

package/README.ko.md

@@ -4,8 +4,6 @@
 
 fluo를 위한 입력값 검증 데코레이터, Mapped DTO 헬퍼 및 검증 엔진입니다.
 
-`@fluojs/validation`은 애플리케이션의 **입력 경계(Input Boundary)**를 담당합니다. 가공되지 않은(untyped) raw 데이터를 검증이 완료된 타입 기반 클래스 인스턴스(DTO)로 변환하는 강력한 데코레이터 세트와 실체화(Materialization) 엔진을 제공합니다. 이를 통해 비즈니스 로직에 도달하기 전 데이터의 무결성을 보장합니다.
-
 ## 목차
 
 - [설치](#설치)
@@ -24,115 +22,135 @@ pnpm add @fluojs/validation
 
 ## 사용 시점
 
-- 들어오는 데이터(요청 바디, 쿼리 파라미터 등)를 클래스 기반 스키마에 맞춰 검증해야 할 때.
-- 일반 JavaScript 객체를 재귀적 검증이 포함된 타입 기반 클래스 인스턴스로 변환하고 싶을 때.
-- 기존 DTO로부터 새로운 DTO를 파생시키고 싶을 때 (예: `UserDto`에서 `UpdateUserDto` 생성).
-- Zod나 Valibot 같은 기존 검증 라이브러리를 클래스 기반 DTO 구조 내에서 사용하고 싶을 때.
+- raw request payload를 비즈니스 로직에 도달하기 전에 검증된 DTO 인스턴스로 바꿔야 할 때
+- 컨트롤러나 서비스에서 ad hoc parsing 대신 class 기반 검증 규칙을 쓰고 싶을 때
+- `PickType`, `PartialType`, `IntersectionType` 같은 metadata-preserving mapped DTO helper가 필요할 때
+- `@ValidateClass(...)`로 Zod나 Valibot 같은 Standard Schema validator를 붙이고 싶을 때
 
 ## 빠른 시작
 
-표준 데코레이터를 사용하여 DTO를 정의하고, `DefaultValidator`를 사용하여 raw 데이터를 실체화 및 검증합니다.
-
-```typescript
-import { IsEmail, IsString, MinLength, DefaultValidator } from '@fluojs/validation';
+```ts
+import { DefaultValidator, DtoValidationError, IsEmail, IsString, MinLength } from '@fluojs/validation';
 
 class CreateUserDto {
   @IsEmail()
-  email: string = '';
+  email = '';
 
   @IsString()
   @MinLength(2)
-  name: string = '';
+  name = '';
 }
 
 const validator = new DefaultValidator();
-const rawData = { email: 'test@example.com', name: 'Ko' };
-
-// materialize()는 CreateUserDto의 인스턴스를 생성하고 검증을 수행합니다.
-const user = await validator.materialize(rawData, CreateUserDto);
 
-console.log(user instanceof CreateUserDto); // true
-console.log(user.name); // "Ko"
+try {
+  const dto = await validator.materialize(
+    { email: 'hello@example.com', name: 'fluo' },
+    CreateUserDto,
+  );
+
+  console.log(dto instanceof CreateUserDto);
+} catch (error) {
+  if (error instanceof DtoValidationError) {
+    console.log(error.issues);
+  }
+}
 ```
 
 ## 주요 패턴
 
-### 실체화 vs 검증 (Materialization vs Validation)
+### `materialize()` vs `validate()`
 
 - **`materialize<T>(value, target)`**: **입력 처리**에 가장 적합합니다. plain 객체를 받아 대상 클래스의 인스턴스를 생성하고, 값을 복사하며, 중첩된 DTO를 재귀적으로 처리한 후 모든 검증 규칙을 실행합니다.
-- **`validate(instance, target)`**: **기존 객체 확인**에 적합합니다. 이미 생성된 인스턴스에 대해 검증 규칙만 실행합니다. 타입 변환이나 중첩된 객체의 실체화는 수행하지 않습니다.
+- **`validate(instance, target)`**: **기존 루트 객체 확인**에 적합합니다. 이미 생성된 루트 값에 대해 검증 규칙을 실행하며, plain 객체인 `@ValidateNested(...)` 값은 중첩 DTO 규칙을 실행하기 위해 임시로 실체화할 수 있습니다. 이 임시 실체화는 호출자가 넘긴 속성 값을 대체하지 않습니다.
+
+`materialize()`는 plain 입력 객체의 안전한 own enumerable 속성을 복사하고,
+DTO 바인딩 메타데이터를 적용한 뒤 `@ValidateNested(...)` 필드를 재귀적으로
+실체화합니다. 어떤 요청 소스를 선택하고 스칼라 값을 변환할지는 transport 또는
+binder가 검증 전에 담당한다는 request-pipeline 계약을 유지합니다.
+`materialize()`에 넘기는 루트 값은 plain 객체이거나 대상 DTO 인스턴스여야 합니다.
+문자열, 배열, `null` 같은 잘못된 루트 값은 대상 DTO 생성자나 필드 initializer가
+실행되기 전에 거부됩니다.
+
+### 검증 이슈 형태
+
+`DtoValidationError.issues`는 request-pipeline 오류 상세에 사용하는 안정적인 DTO입니다.
+
+```ts
+type ValidationIssue = {
+  code: string;
+  field?: string;
+  message: string;
+  source?: 'path' | 'query' | 'header' | 'cookie' | 'body';
+};
+```
 
-### Mapped Types (Pick, Omit, Partial)
+중첩 DTO는 `address.city`, `items[0].name` 같은 dot path와 collection index를
+사용합니다. HTTP 바인딩에서 온 규칙은 `source`를 붙이며, standalone validation이나
+Standard Schema 이슈에서는 값이 없을 수 있습니다.
 
-모든 검증 데코레이터와 바인딩 메타데이터를 보존하면서 새로운 DTO 클래스를 파생합니다.
+### Mapped DTO 헬퍼
 
-```typescript
+```ts
 import { IsString, IsEmail, PickType, PartialType } from '@fluojs/validation';
 
 class UserDto {
-  @IsString() name: string = '';
-  @IsEmail() email: string = '';
+  @IsString() name = '';
+  @IsEmail() email = '';
 }
 
-// 'email' 필드만 포함
 class EmailOnlyDto extends PickType(UserDto, ['email']) {}
-
-// 모든 필드를 선택 사항(optional)으로 변경
 class UpdateUserDto extends PartialType(UserDto) {}
 ```
 
-### Standard Schema 지원 (Zod, Valibot)
+### Standard Schema 지원
 
-`@ValidateClass`를 통해 클래스 레벨에서 선호하는 스키마 라이브러리를 사용할 수 있습니다. fluo는 [Standard Schema](https://github.com/standard-schema/spec) 규격을 구현하는 모든 라이브러리를 지원합니다.
-유효하지 않은 입력은 명시적인 `issues`로 보고되어야 하며, 이슈가 없는 검증 결과는 성공으로 처리합니다.
+Standard Schema adapter는 유효하지 않은 입력을 명시적인 issue로 보고해야 합니다. issue가 없는 검증 결과는 성공으로 처리합니다.
 
-```typescript
+```ts
 import { ValidateClass } from '@fluojs/validation';
 import { z } from 'zod';
 
-const UserSchema = z.object({
-  age: z.number().min(18),
-});
+const UserSchema = z.object({ age: z.number().min(18) });
 
 @ValidateClass(UserSchema)
 class RestrictedUserDto {
-  age: number = 0;
+  age = 0;
 }
 ```
 
-### 중첩 검증 (Nested Validation)
+`ValidateClass(...)`는 custom class-level validator도 받을 수 있습니다. `Validate(...)`는 built-in decorator만으로 부족할 때 custom field-level validator를 붙이고, `ValidateIf(...)`는 predicate가 false를 반환하면 dependent validator를 short-circuit합니다.
 
-`@ValidateNested`를 사용하여 복잡한 계층적 데이터 구조를 검증합니다.
+### 중첩 검증
 
-```typescript
-import { IsString, ValidateNested } from '@fluojs/validation';
+`@ValidateNested(...)`는 객체 필드, 배열, `Set`, `Map`을 지원합니다. 중첩 DTO path는 validation issue에서 dot/index 표기법을 사용하며, cycle은 안전하게 감지되고 shared reference는 허용됩니다.
 
-class ProfileDto {
-  @IsString() bio: string = '';
-}
+### 암묵적 scalar coercion 없음
 
-class UserDto {
-  @IsString() name: string = '';
-  
-  @ValidateNested(() => ProfileDto)
-  profile?: ProfileDto;
-}
-```
+`materialize()`는 의도적으로 엄격합니다. Transport가 `'42'`를 넘기고 DTO가 `number`를 기대한다면, transport나 binding layer가 먼저 변환해야 합니다.
 
 ## 공개 API
 
-- **검증 엔진**: `DefaultValidator`, `DtoValidationError`, `ValidationIssue`
-- **핵심 데코레이터**: `IsString`, `IsNumber`, `IsBoolean`, `IsEmail`, `IsUrl`, `ValidateNested`, `ValidateIf`, `IsOptional`, `ValidateClass`
+- **검증 엔진**: `DefaultValidator`, `DtoValidationError`, `ValidationIssue`, `Validator`
+- **핵심 데코레이터**: `IsString`, `IsNumber`, `IsBoolean`, `IsDate`, `IsArray`, `IsObject`, `IsEnum`, `IsInt`, `IsDefined`, `IsOptional`, `ValidateNested`, `ValidateIf`, `Validate`, `ValidateClass`
+- **존재 및 비교 데코레이터**: `IsEmpty`, `IsNotEmpty`, `Equals`, `NotEquals`, `IsIn`, `IsNotIn`
+- **문자열 및 네트워크 데코레이터**: `IsEmail`, `IsUrl`, `IsUUID`, `IsIP`, `IsAlpha`, `IsAlphanumeric`, `IsAscii`, `IsBase64`, `IsBooleanString`, `IsDataURI`, `IsDateString`, `IsDecimal`, `IsFQDN`, `IsHexColor`, `IsHexadecimal`, `IsJSON`, `IsJWT`, `IsLocale`, `IsLowercase`, `IsMagnetURI`, `IsMimeType`, `IsMongoId`, `IsNumberString`, `IsPort`, `IsRFC3339`, `IsSemVer`, `IsUppercase`, `IsISO8601`, `Matches`, `Length`, `MinLength`, `MaxLength`, `Contains`, `NotContains`
+- **숫자, 날짜, 지리, locale 데코레이터**: `Min`, `Max`, `IsPositive`, `IsNegative`, `IsDivisibleBy`, `MinDate`, `MaxDate`, `IsLatitude`, `IsLongitude`, `IsLatLong`, `IsISBN`, `IsISSN`, `IsMobilePhone`, `IsPostalCode`, `IsRgbColor`, `IsCurrency`
+- **배열 데코레이터**: `ArrayContains`, `ArrayNotContains`, `ArrayNotEmpty`, `ArrayMinSize`, `ArrayMaxSize`, `ArrayUnique`
 - **Mapped DTO 헬퍼**: `PickType`, `OmitType`, `PartialType`, `IntersectionType`
+- **Mapped DTO 서브패스**: `@fluojs/validation/mapped-types`
+- **Standard Schema 계약**: `ValidateClass(...)` 스키마를 타입 지정하기 위한 `StandardSchemaV1Like`
 - **검증 흐름**: 실체화 및 검증을 위한 `materialize()`, 단순 검증을 위한 `validate()`
 
 ## 관련 패키지
 
-- `@fluojs/core`: 데코레이터가 사용하는 메타데이터 시스템을 제공합니다.
-- `@fluojs/http`: 이 패키지를 사용하여 들어오는 요청 데이터를 자동으로 검증합니다.
-- `@fluojs/serialization`: **출력** 측면(응답용 DTO 가공)을 담당합니다.
+- `@fluojs/http`: request data를 bind한 뒤 이 패키지로 검증합니다.
+- `@fluojs/serialization`: response side에서 output DTO를 가공합니다.
+- `@fluojs/core`: validation decorator가 사용하는 metadata primitive를 제공합니다.
 
 ## 예제 소스
 
-- `packages/validation/src/validation.test.ts`: 모든 데코레이터와 엔진에 대한 종합 테스트.
-- `examples/realworld-api`: 실제 프로덕션과 유사한 환경에서의 DTO 사용 예시.
+- `packages/validation/src/validation.test.ts`
+- `packages/validation/src/mapped-types.test.ts`
+- `examples/realworld-api/src/users/create-user.dto.ts`
+- `examples/auth-jwt-passport/src/auth/login.dto.ts`

package/README.md

@@ -2,7 +2,7 @@
 
 <p><strong><kbd>English</kbd></strong> <a href="./README.ko.md"><kbd>한국어</kbd></a></p>
 
-Input-side validation decorators, mapped DTO helpers, and the materialization engine for fluo.
+Input-side validation decorators, mapped DTO helpers, and the validation engine for fluo.
 
 ## Table of Contents
 
@@ -62,7 +62,34 @@ try {
 ### `materialize()` vs `validate()`
 
 - `materialize(value, Target)` builds a typed instance and validates it recursively
-- `validate(instance, Target)` only validates an already-created value
+- `validate(instance, Target)` validates an already-created root value and may
+  temporarily materialize plain nested `@ValidateNested(...)` values to run their
+  nested DTO rules without replacing the caller's properties
+
+`materialize()` copies safe own enumerable properties from plain input objects,
+applies DTO binding metadata, and recursively hydrates `@ValidateNested(...)`
+fields. It preserves the request-pipeline contract that transports or binders own
+source selection and scalar conversion before validation runs.
+The root value passed to `materialize()` must already be a plain object or an
+instance of the target DTO; malformed roots such as strings, arrays, and `null`
+are rejected before the target DTO constructor or field initializers run.
+
+### Validation issue shape
+
+`DtoValidationError.issues` is a stable DTO for request-pipeline error details:
+
+```ts
+type ValidationIssue = {
+  code: string;
+  field?: string;
+  message: string;
+  source?: 'path' | 'query' | 'header' | 'cookie' | 'body';
+};
+```
+
+Nested DTOs use dot paths and collection indexes, such as `address.city` or
+`items[0].name`. HTTP bindings attach `source` when the rule came from request
+metadata; standalone validation and Standard Schema issues may leave it unset.
 
 ### Mapped DTO helpers
 
@@ -94,15 +121,27 @@ class RestrictedUserDto {
 }
 ```
 
+`ValidateClass(...)` also accepts custom class-level validators. `Validate(...)` attaches custom field-level validators when built-in decorators are not enough, and `ValidateIf(...)` short-circuits dependent validators when its predicate returns false.
+
+### Nested validation
+
+`@ValidateNested(...)` supports object fields, arrays, `Set`, and `Map`. Nested DTO paths use dot/index notation in validation issues, cycles are detected safely, and shared references are allowed.
+
 ### No implicit scalar coercion
 
 `materialize()` is intentionally strict. If a transport gives you `'42'` and your DTO expects `number`, the transport or binding layer must convert it first.
 
 ## Public API
 
-- **Validator engine**: `DefaultValidator`, `DtoValidationError`, `ValidationIssue`
-- **Core decorators**: `IsString`, `IsNumber`, `IsBoolean`, `IsEmail`, `IsUrl`, `ValidateNested`, `ValidateIf`, `IsOptional`, `ValidateClass`
+- **Validator engine**: `DefaultValidator`, `DtoValidationError`, `ValidationIssue`, `Validator`
+- **Core decorators**: `IsString`, `IsNumber`, `IsBoolean`, `IsDate`, `IsArray`, `IsObject`, `IsEnum`, `IsInt`, `IsDefined`, `IsOptional`, `ValidateNested`, `ValidateIf`, `Validate`, `ValidateClass`
+- **Presence and comparison decorators**: `IsEmpty`, `IsNotEmpty`, `Equals`, `NotEquals`, `IsIn`, `IsNotIn`
+- **String and network decorators**: `IsEmail`, `IsUrl`, `IsUUID`, `IsIP`, `IsAlpha`, `IsAlphanumeric`, `IsAscii`, `IsBase64`, `IsBooleanString`, `IsDataURI`, `IsDateString`, `IsDecimal`, `IsFQDN`, `IsHexColor`, `IsHexadecimal`, `IsJSON`, `IsJWT`, `IsLocale`, `IsLowercase`, `IsMagnetURI`, `IsMimeType`, `IsMongoId`, `IsNumberString`, `IsPort`, `IsRFC3339`, `IsSemVer`, `IsUppercase`, `IsISO8601`, `Matches`, `Length`, `MinLength`, `MaxLength`, `Contains`, `NotContains`
+- **Number, date, geo, and locale decorators**: `Min`, `Max`, `IsPositive`, `IsNegative`, `IsDivisibleBy`, `MinDate`, `MaxDate`, `IsLatitude`, `IsLongitude`, `IsLatLong`, `IsISBN`, `IsISSN`, `IsMobilePhone`, `IsPostalCode`, `IsRgbColor`, `IsCurrency`
+- **Array decorators**: `ArrayContains`, `ArrayNotContains`, `ArrayNotEmpty`, `ArrayMinSize`, `ArrayMaxSize`, `ArrayUnique`
 - **Mapped DTO helpers**: `PickType`, `OmitType`, `PartialType`, `IntersectionType`
+- **Mapped DTO subpath**: `@fluojs/validation/mapped-types`
+- **Standard Schema contract**: `StandardSchemaV1Like` for typing `ValidateClass(...)` schemas
 - **Validation flow**: `materialize()` for hydration + validation, `validate()` for validation-only checks
 
 ## Related Packages
@@ -114,5 +153,6 @@ class RestrictedUserDto {
 ## Example Sources
 
 - `packages/validation/src/validation.test.ts`
+- `packages/validation/src/mapped-types.test.ts`
 - `examples/realworld-api/src/users/create-user.dto.ts`
 - `examples/auth-jwt-passport/src/auth/login.dto.ts`

package/dist/decorators.d.ts

@@ -35,19 +35,61 @@ export declare function IsBoolean(options?: ValidationDecoratorOptions): FieldDe
  * @returns A field decorator that adds conditional validation execution.
  */
 export declare const ValidateIf: (validateIf: (dto: unknown, value: unknown) => boolean | Promise<boolean>, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is defined value.
+ */
 export declare const IsDefined: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is optional value.
+ */
 export declare const IsOptional: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the equals value.
+ */
 export declare const Equals: (value: unknown, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the not equals value.
+ */
 export declare const NotEquals: (value: unknown, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is empty value.
+ */
 export declare const IsEmpty: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is not empty value.
+ */
 export declare const IsNotEmpty: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is in value.
+ */
 export declare const IsIn: (values: readonly unknown[], options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is not in value.
+ */
 export declare const IsNotIn: (values: readonly unknown[], options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is date value.
+ */
 export declare const IsDate: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is array value.
+ */
 export declare const IsArray: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is object value.
+ */
 export declare const IsObject: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is int value.
+ */
 export declare const IsInt: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is positive value.
+ */
 export declare const IsPositive: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is negative value.
+ */
 export declare const IsNegative: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
 /**
  * Validates that the field value is included in the given enum-like set.
@@ -57,12 +99,33 @@ export declare const IsNegative: (options?: ValidationDecoratorOptions) => Field
  * @returns A field decorator that registers an enum-membership rule.
  */
 export declare function IsEnum(values: Record<string, unknown> | readonly unknown[], options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Provides the is divisible by value.
+ */
 export declare const IsDivisibleBy: (value: number, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the min value.
+ */
 export declare const Min: (value: number, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the max value.
+ */
 export declare const Max: (value: number, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the min date value.
+ */
 export declare const MinDate: (value: Date, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the max date value.
+ */
 export declare const MaxDate: (value: Date, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the contains value.
+ */
 export declare const Contains: (value: string, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the not contains value.
+ */
 export declare const NotContains: (value: string, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
 /**
  * Validates string length using optional min/max boundaries.
@@ -81,7 +144,13 @@ export declare function Length(min: number, max?: number, options?: ValidationDe
  * @returns A field decorator that registers recursive nested DTO validation.
  */
 export declare function ValidateNested(dto: Constructor | (() => Constructor), options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Provides the min length value.
+ */
 export declare const MinLength: (value: number, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the max length value.
+ */
 export declare const MaxLength: (value: number, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
 /**
  * Validates the field using a regular expression pattern.
@@ -92,49 +161,262 @@ export declare const MaxLength: (value: number, options?: ValidationDecoratorOpt
  * @returns A field decorator that registers a regex-matching rule.
  */
 export declare function Matches(pattern: RegExp | string, modifiersOrOptions?: string | ValidationDecoratorOptions, options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Provides the is alpha value.
+ *
+ * @param options The options.
+ */
 export declare const IsAlpha: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is alphanumeric value.
+ *
+ * @param options The options.
+ */
 export declare const IsAlphanumeric: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is ascii value.
+ *
+ * @param options The options.
+ */
 export declare const IsAscii: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is base64 value.
+ *
+ * @param options The options.
+ */
 export declare const IsBase64: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is boolean string value.
+ *
+ * @param options The options.
+ */
 export declare const IsBooleanString: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is data uri value.
+ *
+ * @param options The options.
+ */
 export declare const IsDataURI: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is date string value.
+ *
+ * @param options The options.
+ */
 export declare const IsDateString: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is decimal value.
+ *
+ * @param options The options.
+ */
 export declare const IsDecimal: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is email value.
+ *
+ * @param options The options.
+ */
 export declare const IsEmail: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is fqdn value.
+ *
+ * @param options The options.
+ */
 export declare const IsFQDN: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is hex color value.
+ *
+ * @param options The options.
+ */
 export declare const IsHexColor: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is hexadecimal value.
+ *
+ * @param options The options.
+ */
 export declare const IsHexadecimal: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is json value.
+ *
+ * @param options The options.
+ */
 export declare const IsJSON: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is jwt value.
+ *
+ * @param options The options.
+ */
 export declare const IsJWT: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is locale value.
+ *
+ * @param options The options.
+ */
 export declare const IsLocale: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is lowercase value.
+ *
+ * @param options The options.
+ */
 export declare const IsLowercase: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is magnet uri value.
+ *
+ * @param options The options.
+ */
 export declare const IsMagnetURI: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is mime type value.
+ *
+ * @param options The options.
+ */
 export declare const IsMimeType: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is mongo id value.
+ *
+ * @param options The options.
+ */
 export declare const IsMongoId: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is number string value.
+ *
+ * @param options The options.
+ */
 export declare const IsNumberString: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is port value.
+ *
+ * @param options The options.
+ */
 export declare const IsPort: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is rfc3339 value.
+ *
+ * @param options The options.
+ */
 export declare const IsRFC3339: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is sem ver value.
+ *
+ * @param options The options.
+ */
 export declare const IsSemVer: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is uppercase value.
+ *
+ * @param options The options.
+ */
 export declare const IsUppercase: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is iso8601 value.
+ *
+ * @param options The options.
+ */
 export declare const IsISO8601: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is latitude value.
+ *
+ * @param options The options.
+ */
 export declare const IsLatitude: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is longitude value.
+ *
+ * @param options The options.
+ */
 export declare const IsLongitude: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the is lat long value.
+ *
+ * @param options The options.
+ */
 export declare const IsLatLong: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
-/** Validates that a value is an IPv4/IPv6 address. */
+/**
+ *  Validates that a value is an IPv4/IPv6 address.
+ *
+ * @param version The version.
+ * @param options The options.
+ * @returns The is ip result.
+ */
 export declare function IsIP(version?: '4' | '6' | '4_or_6', options?: ValidationDecoratorOptions): FieldDecoratorFn;
-/** Validates that a value is an ISBN string. */
+/**
+ *  Validates that a value is an ISBN string.
+ *
+ * @param version The version.
+ * @param options The options.
+ * @returns The is isbn result.
+ */
 export declare function IsISBN(version?: 10 | 13, options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Is issn.
+ *
+ * @param options The options.
+ * @returns The is issn result.
+ */
 export declare function IsISSN(options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Is mobile phone.
+ *
+ * @param locale The locale.
+ * @param options The options.
+ * @returns The is mobile phone result.
+ */
 export declare function IsMobilePhone(locale?: string | readonly string[], options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Is postal code.
+ *
+ * @param locale The locale.
+ * @param options The options.
+ * @returns The is postal code result.
+ */
 export declare function IsPostalCode(locale?: string, options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Is rgb color.
+ *
+ * @param includePercentValues The include percent values.
+ * @param options The options.
+ * @returns The is rgb color result.
+ */
 export declare function IsRgbColor(includePercentValues?: boolean, options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Is url.
+ *
+ * @param options The options.
+ * @returns The is url result.
+ */
 export declare function IsUrl(options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Is uuid.
+ *
+ * @param version The version.
+ * @param options The options.
+ * @returns The is uuid result.
+ */
 export declare function IsUUID(version?: '3' | '4' | '5' | 'all', options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Is currency.
+ *
+ * @param options The options.
+ * @returns The is currency result.
+ */
 export declare function IsCurrency(options?: ValidationDecoratorOptions): FieldDecoratorFn;
+/**
+ * Provides the array contains value.
+ */
 export declare const ArrayContains: (values: readonly unknown[], options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the array not contains value.
+ */
 export declare const ArrayNotContains: (values: readonly unknown[], options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the array not empty value.
+ */
 export declare const ArrayNotEmpty: (options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the array min size value.
+ */
 export declare const ArrayMinSize: (value: number, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
+/**
+ * Provides the array max size value.
+ */
 export declare const ArrayMaxSize: (value: number, options?: ValidationDecoratorOptions) => FieldDecoratorFn;
 /**
  * Ensures all values in the array are unique, optionally by selector.