@decaf-ts/decorator-validation 1.19.0 → 1.21.0

package/lib/types/validation/Validators/constants.d.ts

@@ -1,157 +0,0 @@
-/**
- * @description Object-like set of keys used for comparison-based validations.
- * @summary Provides canonical names for validators that compare two values (equality and ordering checks).
- * @typedef {Object} ComparisonValidationKeysDef
- * @property {"equals"} EQUALS Validates if two values are equal.
- * @property {"different"} DIFF Validates if two values are different.
- * @property {"lessThan"} LESS_THAN Validates if a value is less than another.
- * @property {"lessThanOrEqual"} LESS_THAN_OR_EQUAL Validates if a value is less than or equal to another.
- * @property {"greaterThan"} GREATER_THAN Validates if a value is greater than another.
- * @property {"greaterThanOrEqual"} GREATER_THAN_OR_EQUAL Validates if a value is greater than or equal to another.
- * @memberOf module:decorator-validation.Validation
- */
-/**
- * @description Keys used for comparison-based validations.
- * @summary Canonical key names for comparison validators.
- * @const ComparisonValidationKeys
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- * @type {ComparisonValidationKeysDef}
- */
-export declare const ComparisonValidationKeys: {
-    readonly EQUALS: "equals";
-    readonly DIFF: "different";
-    readonly LESS_THAN: "lessThan";
-    readonly LESS_THAN_OR_EQUAL: "lessThanOrEqual";
-    readonly GREATER_THAN: "greaterThan";
-    readonly GREATER_THAN_OR_EQUAL: "greaterThanOrEqual";
-};
-/**
- * @description Object-like set of keys used across all validators in the system.
- * @summary Defines the canonical namespaced key prefix and the individual validation flags for rules such as required, min/max, length, patterns, types, lists and more.
- * @typedef {Object} ValidationKeysDef
- * @property {string} REFLECT prefixes others (namespace prefix)
- * @property {"required"} REQUIRED sets as required
- * @property {"min"} MIN defines min value
- * @property {"max"} MAX defines max value
- * @property {"step"} STEP defines step
- * @property {"minlength"} MIN_LENGTH defines min length
- * @property {"maxlength"} MAX_LENGTH defines max length
- * @property {"pattern"} PATTERN defines pattern
- * @property {"email"} EMAIL defines email
- * @property {"url"} URL defines url
- * @property {"date"} DATE defines date
- * @property {"type"} TYPE defines type
- * @property {"password"} PASSWORD defines password
- * @property {"list"} LIST defines list
- * @property {"unique"} UNIQUE flags uniqueness
- * @property {"validator"} VALIDATOR custom validator id
- * @memberOf module:decorator-validation.Validation
- */
-/**
- * @description The keys used for validation.
- * @summary A namespaced collection of validation key strings used throughout the library.
- * @const ValidationKeys
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- * @type {ValidationKeysDef}
- */
-export declare const ValidationKeys: {
-    readonly EQUALS: "equals";
-    readonly DIFF: "different";
-    readonly LESS_THAN: "lessThan";
-    readonly LESS_THAN_OR_EQUAL: "lessThanOrEqual";
-    readonly GREATER_THAN: "greaterThan";
-    readonly GREATER_THAN_OR_EQUAL: "greaterThanOrEqual";
-    readonly REFLECT: "validation";
-    readonly DATE: "date";
-    readonly EMAIL: "email";
-    readonly FORMAT: "format";
-    readonly LIST: "list";
-    readonly MAX: "max";
-    readonly MAX_LENGTH: "maxlength";
-    readonly MIN: "min";
-    readonly MIN_LENGTH: "minlength";
-    readonly PASSWORD: "password";
-    readonly PATTERN: "pattern";
-    readonly REQUIRED: "required";
-    readonly STEP: "step";
-    readonly TYPE: "type";
-    readonly UNIQUE: "unique";
-    readonly URL: "url";
-    readonly VALIDATOR: "validator";
-    readonly ENUM: "enum";
-};
-/**
- * @description list of month names
- * @summary Stores month names. Can be changed for localization purposes
- * @const MONTH_NAMES
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export declare const MONTH_NAMES: string[];
-/**
- * @description list of names of days of the week
- * @summary Stores names for days of the week. Can be changed for localization purposes
- * @const DAYS_OF_WEEK_NAMES
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export declare const DAYS_OF_WEEK_NAMES: string[];
-/**
- * @description Type definition for default error message strings keyed by validation type.
- * @summary Enumerates the supported error message keys with their intended meaning; used to localize or override default messages.
- * @typedef {Object} DefaultErrorMessages
- * @property {string} REQUIRED default error message
- * @property {string} MIN default error message
- * @property {string} MAX default error message
- * @property {string} MIN_LENGTH default error message
- * @property {string} MAX_LENGTH default error message
- * @property {string} PATTERN default error message
- * @property {string} EMAIL default error message
- * @property {string} URL default error message
- * @property {string} TYPE default error message
- * @property {string} STEP default error message
- * @property {string} DATE default error message
- * @property {string} DEFAULT default error message
- * @property {string} PASSWORD default error message
- * @property {string} LIST default error message
- * @property {string} LIST_INSIDE default error message
- * @property {string} MODEL_NOT_FOUND default error message
- * @memberOf module:decorator-validation.Validation
- */
-/**
- * @description Defines the default error messages
- * @summary Mapping between validation keys and their default human-readable error messages.
- * @const DEFAULT_ERROR_MESSAGES
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- * @type {DefaultErrorMessages}
- */
-export declare const DEFAULT_ERROR_MESSAGES: Record<string, string>;
-/**
- * @description Type definition for default regular expression patterns used in validation.
- * @summary Captures common regex patterns for email, URL, and password policies, including nested grouping for password-related rules.
- * @typedef {Object} DefaultPatterns
- * @property {RegExp} EMAIL Email address validation pattern
- * @property {RegExp} URL URL validation pattern
- * @property {Object} PASSWORD Password-related regex patterns
- * @property {RegExp} PASSWORD.CHAR8_ONE_OF_EACH At least 8 chars with lower, upper, number, and special char
- * @memberOf module:decorator-validation.Validation
- */
-/**
- * @description Defines the various default regexp patterns used
- * @summary Collection of frequently used validation patterns grouped under semantic keys.
- * @const DEFAULT_PATTERNS
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- * @type {DefaultPatterns}
- */
-export declare const DEFAULT_PATTERNS: {
-    EMAIL: RegExp;
-    URL: RegExp;
-    PASSWORD: {
-        CHAR8_ONE_OF_EACH: RegExp;
-    };
-    asd: string;
-};

package/lib/types/validation/Validators/decorators.d.ts

@@ -1,12 +0,0 @@
-import { Validator } from "./Validator";
-/**
- * @summary Marks the class as a validator for a certain key.
- * @description Registers the class in the {@link Validation} with the provided key
- *
- * @param {string} keys the validation key
- *
- * @function validator
- *
- * @category Class Decorators
- */
-export declare function validator<T extends Validator>(...keys: string[]): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor | number) => void;

package/lib/types/validation/Validators/index.d.ts

@@ -1,26 +0,0 @@
-export * from "./constants";
-export * from "./AsyncValidator";
-export * from "./DateValidator";
-export * from "./decorators";
-export * from "./DiffValidator";
-export * from "./EmailValidator";
-export * from "./EqualsValidator";
-export * from "./GreaterThanValidator";
-export * from "./GreaterThanOrEqualValidator";
-export * from "./LessThanValidator";
-export * from "./LessThanOrEqualValidator";
-export * from "./ListValidator";
-export * from "./MaxLengthValidator";
-export * from "./MaxValidator";
-export * from "./MinLengthValidator";
-export * from "./MinValidator";
-export * from "./OptionValidator";
-export * from "./PasswordValidator";
-export * from "./PatternValidator";
-export * from "./RequiredValidator";
-export * from "./StepValidator";
-export * from "./TypeValidator";
-export * from "./URLValidator";
-export * from "./Validator";
-export * from "./ValidatorRegistry";
-export * from "./utils";

package/lib/types/validation/Validators/utils.d.ts

@@ -1,75 +0,0 @@
-/**
- * Validates whether two values are eligible for comparison using >= or <= operators.
- *
- * Supported types: `undefined`, `number`, `bigint`, and `Date`.
- *
- * @param a - The first value to compare.
- * @param b - The second value to compare.
- *
- * @returns {boolean} True if both values are of supported types.
- *
- * @throws {TypeError} If either value is of an unsupported type.
- * @memberOf module:decorator-validation
- */
-export declare function isValidForGteOrLteComparison(a: any, b: any): boolean;
-/**
- * @summary Compares two values to determine if the first is less than the second.
- * @description Supports numbers and dates. Throws an error for unsupported types.
- *
- * @param {any} a - The first value to compare.
- * @param {any} b - The second value to compare against.
- *
- * @returns {boolean} True if `a` is less than `b`, false otherwise.
- *
- * @throws {Error} If either `a` or `b` is `null` or `undefined`.
- * @throws {TypeError} If values are of mismatched or unsupported types.
- * @memberOf module:decorator-validation
- */
-export declare function isLessThan(a: any, b: any): boolean;
-/**
- * Checks if `a` is greater than `b`.
- * Supports comparison for numbers and Date objects.
- *
- * @param {any} a - The value to validate.
- * @param {any} b - The value to compare against.
- *
- * @returns {boolean} True if `a` is greater than `b`, otherwise false.
- *
- * @throws {Error} If either `a` or `b` is `null` or `undefined`.
- * @throws {TypeError} If values are of mismatched or unsupported types.
- * @memberOf module:decorator-validation
- */
-export declare function isGreaterThan(a: any, b: any): boolean;
-/**
- * @description Checks if a value matches a specified type name
- * @summary Utility function to verify if a value's type matches the provided type name
- * @param {unknown} value - The value to check the type of
- * @param {string} acceptedType - The type name to check against
- * @return {boolean} Returns true if the value matches the accepted type, false otherwise
- */
-export declare function checkType(value: unknown, acceptedType: string): boolean;
-/**
- * @description Checks if a value matches any of the specified type names
- * @summary Utility function to verify if a value's type matches any of the provided type names
- * @param {unknown} value - The value to check the type of
- * @param {string[]} acceptedTypes - Array of type names to check against
- * @return {boolean} Returns true if the value matches any of the accepted types, false otherwise
- */
-export declare function checkTypes(value: unknown, acceptedTypes: string[]): boolean;
-/**
- * @description Evaluates if a value matches the specified type metadata
- * @summary Compares a value against type metadata to determine if they match
- * @param {unknown} value - The value to evaluate
- * @param {string | string[] | {name: string}} types - Type metadata to check against, can be a string, array of strings, or an object with a name property
- * @return {boolean} Returns true if the value matches the type metadata, false otherwise
- */
-export declare function evaluateDesignTypes(value: unknown, types: string | string[] | {
-    name: string;
-}): boolean;
-/**
- * @description Returns the length of a value
- * @summary Returns the length of a value
- * @param {string | Set<any> | any[] | Map<any, any>} value - The value to evaluate
- * @return {number} Returns the length of a value
- */
-export declare function valueLength(value: string | Set<any> | any[] | Map<any, any>): number;

package/lib/types/validation/decorators.d.ts

@@ -1,313 +0,0 @@
-import { ComparisonValidatorOptions, DateValidatorOptions, ListValidatorOptions, ValidatorOptions } from "./types";
-import { ModelConstructor } from "../model/types";
-import { Constructor } from "@decaf-ts/decoration";
-/**
- * @description Combined property decorator factory for metadata and attribute marking
- * @summary Creates a decorator that both marks a property as a model attribute and assigns metadata to it
- *
- * @template V
- * @param {PropertyDecorator} decorator - The metadata key
- * @param {string} key - The metadata key
- * @param {V} value - The metadata value to associate with the property
- * @return {Function} - Combined decorator function
- * @function validationMetadata
- * @category Property Decorators
- */
-export declare function validationMetadata<V>(decorator: any, key: string, value: V): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor | number) => void;
-export declare function innerValidationDecorator(dec: any, key: string, meta: any): (obj: any, prop: any) => void;
-export declare function async(): (model: object) => void;
-/**
- * @description Property decorator that marks a field as required
- * @summary Marks the property as required, causing validation to fail if the property is undefined, null, or empty.
- * Validators to validate a decorated property must use key {@link ValidationKeys#REQUIRED}.
- * This decorator is commonly used as the first validation step for important fields.
- *
- * @param {string} [message] - The error message to display when validation fails. Defaults to {@link DEFAULT_ERROR_MESSAGES#REQUIRED}
- * @return {PropertyDecorator} A decorator function that can be applied to class properties
- *
- * @function required
- * @category Property Decorators
- *
- * @example
- * ```typescript
- * class User {
- *   @required()
- *   username: string;
- *
- *   @required("Email address is mandatory")
- *   email: string;
- * }
- * ```
- */
-export declare function required(message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @description Property decorator that enforces a minimum value constraint
- * @summary Defines a minimum value for the property, causing validation to fail if the property value is less than the specified minimum.
- * Validators to validate a decorated property must use key {@link ValidationKeys#MIN}.
- * This decorator works with numeric values and dates.
- *
- * @param {number | Date | string} value - The minimum value allowed. For dates, can be a Date object or a string that can be converted to a date
- * @param {string} [message] - The error message to display when validation fails. Defaults to {@link DEFAULT_ERROR_MESSAGES#MIN}
- * @return {PropertyDecorator} A decorator function that can be applied to class properties
- *
- * @function min
- * @category Property Decorators
- *
- * @example
- * ```typescript
- * class Product {
- *   @min(0)
- *   price: number;
- *
- *   @min(new Date(2023, 0, 1), "Date must be after January 1, 2023")
- *   releaseDate: Date;
- * }
- * ```
- */
-export declare function min(value: number | Date | string, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @summary Defines a maximum value for the property
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#MAX}
- *
- * @param {number | Date} value
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MAX}
- *
- * @function max
- * @category Property Decorators
- */
-export declare function max(value: number | Date | string, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @summary Defines a step value for the property
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#STEP}
- *
- * @param {number} value
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#STEP}
- *
- * @function step
- * @category Property Decorators
- */
-export declare function step(value: number, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @summary Defines a minimum length for the property
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#MIN_LENGTH}
- *
- * @param {string} value
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MIN_LENGTH}
- *
- * @function minlength
- * @category Property Decorators
- */
-export declare function minlength(value: number, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @summary Defines a maximum length for the property
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#MAX_LENGTH}
- *
- * @param {string} value
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MAX_LENGTH}
- *
- * @function maxlength
- * @category Property Decorators
- */
-export declare function maxlength(value: number, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @summary Defines a RegExp pattern the property must respect
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#PATTERN}
- *
- * @param {string} value
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#PATTERN}
- *
- * @function pattern
- * @category Property Decorators
- */
-export declare function pattern(value: RegExp | string, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @summary Defines the property as an email
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#EMAIL}
- *
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#EMAIL}
- *
- * @function email
- * @category Property Decorators
- */
-export declare function email(message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @summary Defines the property as an URL
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#URL}
- *
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#URL}
- *
- * @function url
- * @category Property Decorators
- */
-export declare function url(message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-export type TypeConstructor = Constructor | typeof BigInt;
-export interface TypeMetadata extends ValidatorOptions {
-    customTypes: (TypeConstructor | (() => TypeConstructor))[] | TypeConstructor | (() => TypeConstructor);
-}
-/**
- * @summary Enforces type verification
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#TYPE}
- *
- * @param {Constructor[] | Constructor} types accepted types
- * @param {Constructor} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#TYPE}
- *
- * @function type
- * @category Property Decorators
- */
-export declare function type(types: (TypeConstructor | (() => TypeConstructor))[] | TypeConstructor | (() => TypeConstructor), message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-export type DateMetadata = DateValidatorOptions;
-/**
- * @summary Date Handler Decorator
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#DATE}
- *
- * Will enforce serialization according to the selected format
- *
- * @param {string} format accepted format according to {@link formatDate}
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#DATE}
- *
- * @function date
- *
- * @category Property Decorators
- */
-export declare function date(format?: string, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @summary Password Handler Decorator
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#PASSWORD}
- *
- * @param {RegExp} [pattern] defaults to {@link DEFAULT_PATTERNS#CHAR8_ONE_OF_EACH}
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#PASSWORD}
- *
- * @function password
- *
- * @category Property Decorators
- */
-export declare function password(pattern?: RegExp, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-export interface ListMetadata extends ListValidatorOptions {
-    type: "Array" | "Set";
-}
-/**
- * @summary List Decorator
- * @description Also sets the {@link type} to the provided collection
- *
- * @param {ModelConstructor} clazz
- * @param {string} [collection] The collection being used. defaults to Array
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#LIST}
- *
- * @function list
- *
- * @category Property Decorators
- */
-export declare function list(clazz: Constructor | (() => Constructor) | (Constructor | (() => Constructor))[], collection?: "Array" | "Set", message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @summary Set Decorator
- * @description Wrapper for {@link list} with the 'Set' Collection
- *
- * @param {ModelConstructor} clazz
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#LIST}
- *
- * @function set
- *
- * @category Property Decorators
- */
-export declare function set(clazz: ModelConstructor<any>, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
-/**
- * @summary Declares that the decorated property must be equal to another specified property.
- * @description Applies the {@link ValidationKeys.EQUALS} validator to ensure the decorated value matches the value of the given property.
- *
- * @param {string} propertyToCompare - The name of the property to compare equality against.
- * @param {ComparisonValidatorOptions} options - Options for the validator.
- * @param {string} [options.label] - The label text displayed in the error message.
- * @param {string} [options.message=DEFAULT_ERROR_MESSAGES.EQUALS] - Custom error message to be returned if validation fails.
- *
- * @returns {PropertyDecorator} A property decorator used to register the equality validation metadata.
- *
- * @function eq
- * @category Property Decorators
- */
-export declare function eq(propertyToCompare: string, options?: Omit<ComparisonValidatorOptions, "async" | "description">): (obj: any, prop: any) => void;
-/**
- * @summary Declares that the decorated property must be different from another specified property.
- * @description Applies the {@link ValidationKeys.DIFF} validator to ensure the decorated value is different from the value of the given property.
- *
- * @param {string} propertyToCompare - The name of the property to compare difference against.
- * @param {ComparisonValidatorOptions} options - Options for the validator.
- * @param {string} [options.label] - The label text displayed in the error message.
- * @param {string} [options.message=DEFAULT_ERROR_MESSAGES.DIFF] - Custom error message to be returned if validation fails.
- *
- * @returns {PropertyDecorator} A property decorator used to register the difference validation metadata.
- *
- * @function diff
- * @category Property Decorators
- */
-export declare function diff(propertyToCompare: string, options?: Omit<ComparisonValidatorOptions, "async" | "description">): (obj: any, prop: any) => void;
-/**
- * @summary Declares that the decorated property must be less than another specified property.
- * @description Applies the {@link ValidationKeys.LESS_THAN} validator to ensure the decorated value is less than the value of the given property.
- *
- * @param {string} propertyToCompare - The name of the property to compare against.
- * @param {ComparisonValidatorOptions} options - Options for the validator.
- * @param {string} [options.label] - The label text displayed in the error message.
- * @param {string} [options.message=DEFAULT_ERROR_MESSAGES.LESS_THAN] - Custom error message to be returned if validation fails.
- *
- * @returns {PropertyDecorator} A property decorator used to register the less than validation metadata.
- *
- * @function lt
- * @category Property Decorators
- */
-export declare function lt(propertyToCompare: string, options?: Omit<ComparisonValidatorOptions, "async" | "description">): (obj: any, prop: any) => void;
-/**
- * @summary Declares that the decorated property must be equal or less than another specified property.
- * @description Applies the {@link ValidationKeys.LESS_THAN_OR_EQUAL} validator to ensure the decorated value is equal or less than the value of the given property.
- *
- * @param {string} propertyToCompare - The name of the property to compare against.
- * @param {ComparisonValidatorOptions} options - Options for the validator.
- * @param {string} [options.label] - The label text displayed in the error message.
- * @param {string} [options.message=DEFAULT_ERROR_MESSAGES.LESS_THAN_OR_EQUAL] - Custom error message to be returned if validation fails.
- *
- * @returns {PropertyDecorator} A property decorator used to register the less than or equal validation metadata.
- *
- * @function lte
- * @category Property Decorators
- */
-export declare function lte(propertyToCompare: string, options?: Omit<ComparisonValidatorOptions, "async" | "description">): (obj: any, prop: any) => void;
-/**
- * @summary Declares that the decorated property must be greater than another specified property.
- * @description Applies the {@link ValidationKeys.GREATER_THAN} validator to ensure the decorated value is greater than the value of the given property.
- *
- * @param {string} propertyToCompare - The name of the property to compare against.
- * @param {ComparisonValidatorOptions} options - Options for the validator.
- * @param {string} [options.label] - The label text displayed in the error message.
- * @param {string} [options.message=DEFAULT_ERROR_MESSAGES.GREATER_THAN] - Custom error message to be returned if validation fails.
- *
- * @returns {PropertyDecorator} A property decorator used to register the greater than validation metadata.
- *
- * @function gt
- * @category Property Decorators
- */
-export declare function gt(propertyToCompare: string, options?: Omit<ComparisonValidatorOptions, "async" | "description">): (obj: any, prop: any) => void;
-/**
- * @summary Declares that the decorated property must be equal or greater than another specified property.
- * @description Applies the {@link ValidationKeys.GREATER_THAN_OR_EQUAL} validator to ensure the decorated value is equal or greater than the value of the given property.
- *
- * @param {string} propertyToCompare - The name of the property to compare against.
- * @param {ComparisonValidatorOptions} options - Options for the validator.
- * @param {string} [options.label] - The label text displayed in the error message.
- * @param {string} [options.message=DEFAULT_ERROR_MESSAGES.GREATER_THAN_OR_EQUAL] - Custom error message to be returned if validation fails.
- *
- * @returns {PropertyDecorator} A property decorator used to register the greater than or equal validation metadata.
- *
- * @function gte
- * @category Property Decorators
- */
-export declare function gte(propertyToCompare: string, options?: Omit<ComparisonValidatorOptions, "async" | "description">): (obj: any, prop: any) => void;
-/**
- * @summary Defines a list or an object of accepted values for the property
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#ENUM}
- *
- * @param {any[] | Record<any, any>} value
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#ENUM}
- *
- * @function option
- * @category Property Decorators
- */
-export declare function option(value: any[] | Record<any, any>, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;

package/lib/types/validation/index.d.ts

@@ -1,9 +0,0 @@
-/**
- * @description Exports for the validation module.
- * @summary This file exports all the necessary components for the validation functionality, including validators, decorators, types, and the Validation class.
- * @module decorator-validation/validation
- */
-export * from "./Validators";
-export * from "./decorators";
-export * from "./types";
-export * from "./Validation";