@decaf-ts/decorator-validation 1.5.9 → 1.5.11

package/lib/validation/Validators/PasswordValidator.d.ts

@@ -1,28 +0,0 @@
-import { PatternValidator } from "./PatternValidator";
-import { PatternValidatorOptions } from "../types";
-/**
- * @summary Handles Password Validation
- *
- * @param {string} [errorMessage] defaults to {@link DEFAULT_ERROR_MESSAGES#PASSWORD}
- *
- * @class PasswordValidator
- * @extends PatternValidator
- *
- * @category Validators
- */
-export declare class PasswordValidator extends PatternValidator {
-    constructor(message?: string);
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {PatternValidatorOptions} [options={}]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see PatternValidator#hasErrors
-     */
-    hasErrors(value: string, options?: PatternValidatorOptions): string | undefined;
-}

package/lib/validation/Validators/PatternValidator.d.ts

@@ -1,37 +0,0 @@
-import { Validator } from "./Validator";
-import { PatternValidatorOptions } from "../types";
-export declare const regexpParser: RegExp;
-/**
- * @summary Pattern Validator
- *
- * @param {string} [key] defaults to {@link ValidationKeys#PATTERN}
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#PATTERN}
- *
- * @class PatternValidator
- * @extends Validator
- *
- * @category Validators
- */
-export declare class PatternValidator extends Validator<PatternValidatorOptions> {
-    constructor(message?: string);
-    /**
-     * @summary parses and validates a pattern
-     *
-     * @param {string} pattern
-     * @private
-     */
-    private getPattern;
-    /**
-     * @summary Validates a Model
-     *
-     * @param {string} value
-     * @param {PatternValidatorOptions} options
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: string, options: PatternValidatorOptions): string | undefined;
-}

package/lib/validation/Validators/RequiredValidator.d.ts

@@ -1,28 +0,0 @@
-import { Validator } from "./Validator";
-import { ValidatorOptions } from "../types";
-/**
- * @summary Required Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#REQUIRED}
- *
- * @class RequiredValidator
- * @extends Validator
- *
- * @category Validators
- */
-export declare class RequiredValidator extends Validator {
-    constructor(message?: string);
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {ValidatorOptions} [options={}]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: any, options?: ValidatorOptions): string | undefined;
-}

package/lib/validation/Validators/StepValidator.d.ts

@@ -1,29 +0,0 @@
-import { Validator } from "./Validator";
-import { StepValidatorOptions } from "../types";
-/**
- * @summary Step Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#STEP}
- *
- * @class StepValidator
- * @extends Validator
- *
- * @category Validators
- */
-export declare class StepValidator extends Validator<StepValidatorOptions> {
-    constructor(message?: string);
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {number} step
-     * @param {StepValidatorOptions} options
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: number | string, options: StepValidatorOptions): string | undefined;
-}

package/lib/validation/Validators/TypeValidator.d.ts

@@ -1,25 +0,0 @@
-import { Validator } from "./Validator";
-import { TypeValidatorOptions } from "../types";
-/**
- * @summary Required Validator
- *
- * @class RequiredValidator
- * @extends Validator
- *
- * @category Validators
- */
-export declare class TypeValidator extends Validator<TypeValidatorOptions> {
-    constructor(message?: string);
-    /**
-     * @summary Validates a model
-     * @param {string} value
-     * @param {TypeValidatorOptions} options
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: any, options: TypeValidatorOptions): string | undefined;
-}

package/lib/validation/Validators/URLValidator.d.ts

@@ -1,27 +0,0 @@
-import { PatternValidator } from "./PatternValidator";
-import { PatternValidatorOptions } from "../types";
-/**
- * @summary URL Validator
- * @description Pattern from {@link https://gist.github.com/dperini/729294}
- *
- * @class URLValidator
- * @extends PatternValidator
- *
- * @category Validators
- */
-export declare class URLValidator extends PatternValidator {
-    constructor(message?: string);
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {PatternValidatorOptions} [options={}]
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: string, options?: PatternValidatorOptions): string | undefined;
-}

package/lib/validation/Validators/Validator.d.ts

@@ -1,41 +0,0 @@
-import { ValidatorOptions } from "../types";
-/**
- * @summary Base Implementation for Validators
- * @description Provides the underlying functionality for {@link Validator}s
- *
- * @param {string} validationKey the key to register the validator under
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#DEFAULT}
- * @param {string[]} [acceptedTypes] defines the value types this validator can validate
- *
- * @class Validator
- * @abstract
- * @category Validators
- */
-export declare abstract class Validator<V extends ValidatorOptions = ValidatorOptions> {
-    readonly message: string;
-    readonly acceptedTypes?: string[];
-    protected constructor(message?: string, ...acceptedTypes: string[]);
-    /**
-     * @summary builds the error message
-     * @param {string} message
-     * @param {any[]} args
-     * @protected
-     */
-    protected getMessage(message: string, ...args: any[]): string;
-    /**
-     * @summary Validates type
-     * @param {any} unbound
-     * @private
-     */
-    private checkTypeAndHasErrors;
-    /**
-     * @summary Validates an attribute
-     * @param {any} value
-     * @param {ValidatorOptions} [options] Validate options for customizing the model validation behavior
-     *
-     * @abstract
-     *
-     * @see Model#hasErrors
-     */
-    abstract hasErrors(value: any, options?: V): string | undefined;
-}

package/lib/validation/Validators/ValidatorRegistry.d.ts

@@ -1,47 +0,0 @@
-import { ValidatorDefinition } from "../types";
-import { IValidatorRegistry } from "../types";
-import type { Validator } from "./Validator";
-/**
- * @summary Duck typing for Validators
- * @function isValidator
- * @param val
- */
-export declare function isValidator(val: any): any;
-/**
- * @summary Base Implementation of a Validator Registry
- *
- * @prop {Validator[]} [validators] the initial validators to register
- *
- * @class ValidatorRegistry
- * @implements IValidatorRegistry<T>
- *
- * @category Validation
- */
-export declare class ValidatorRegistry<T extends Validator> implements IValidatorRegistry<T> {
-    private cache;
-    private customKeyCache;
-    constructor(...validators: (ValidatorDefinition | Validator)[]);
-    /**
-     * @summary retrieves the custom keys
-     */
-    getCustomKeys(): {
-        [indexer: string]: string;
-    };
-    /**
-     * @summary retrieves the registered validators keys
-     */
-    getKeys(): string[];
-    /**
-     * @summary Retrieves a validator
-     *
-     * @param {string} validatorKey one of the {@link ValidationKeys}
-     * @return {Validator | undefined} the registered Validator or undefined if there is nono matching the provided key
-     */
-    get<T extends Validator>(validatorKey: string): T | undefined;
-    /**
-     * @summary Registers the provided validators onto the registry
-     *
-     * @param {T[] | ValidatorDefinition[]} validator
-     */
-    register<T extends Validator>(...validator: (ValidatorDefinition | T)[]): void;
-}

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

@@ -1,96 +0,0 @@
-/**
- * @summary The keys used for validation
- *
- * @property {string} REFLECT prefixes others
- * @property {string} REQUIRED sets as required
- * @property {string} MIN defines min value
- * @property {string} MAX defines max value
- * @property {string} STEP defines step
- * @property {string} MIN_LENGTH defines min length
- * @property {string} MAX_LENGTH defines max length
- * @property {string} PATTERN defines pattern
- * @property {string} EMAIL defines email
- * @property {string} URL defines url
- * @property {string} DATE defines date
- * @property {string} TYPE defines type
- * @property {string} PASSWORD defines password
- * @property {string} LIST defines list
- *
- * @constant ValidationKeys
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export declare const ValidationKeys: {
-    REFLECT: string;
-    VALIDATOR: string;
-    REQUIRED: string;
-    MIN: string;
-    MAX: string;
-    STEP: string;
-    MIN_LENGTH: string;
-    MAX_LENGTH: string;
-    PATTERN: string;
-    EMAIL: string;
-    URL: string;
-    DATE: string;
-    TYPE: string;
-    PASSWORD: string;
-    LIST: string;
-};
-/**
- * @summary list of month names
- * @description Stores month names. Can be changed for localization purposes
- *
- * @constant MONTH_NAMES
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export declare const MONTH_NAMES: string[];
-/**
- * @summary list of names of days of the week
- * @description Stores names for days of the week. Can be changed for localization purposes
- *
- * @constant DAYS_OF_WEEK_NAMES
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export declare const DAYS_OF_WEEK_NAMES: string[];
-/**
- * @summary Defines the default error messages
- *
- * @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
- *
- * @constant DEFAULT_ERROR_MESSAGES
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export declare const DEFAULT_ERROR_MESSAGES: Record<string, string>;
-/**
- * @summary Defines the various default regexp patterns used
- *
- * @enum DEFAULT_PATTERNS
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export declare const DEFAULT_PATTERNS: {
-    EMAIL: RegExp;
-    URL: RegExp;
-    PASSWORD: {
-        CHAR8_ONE_OF_EACH: RegExp;
-    };
-};

package/lib/validation/decorators.d.ts

@@ -1,178 +0,0 @@
-import "reflect-metadata";
-import { ModelConstructor } from "../model/types";
-/**
- * @summary Marks the property as required.
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#REQUIRED}
- *
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#REQUIRED}
- *
- * @function required
- *
- * @category Decorators
- */
-export declare function required(message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @summary Defines a minimum value for the property
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#MIN}
- *
- * @param {number | Date} value
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MIN}
- *
- * @function min
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function min(value: number | Date | string, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @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
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function max(value: number | Date | string, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @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
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function step(value: number, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @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
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function minlength(value: number, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @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
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function maxlength(value: number, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @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
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function pattern(value: RegExp | string, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @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
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function email(message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @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
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function url(message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @summary Enforces type verification
- * @description Validators to validate a decorated property must use key {@link ValidationKeys#TYPE}
- *
- * @param {string[] | string} types accepted types
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#TYPE}
- *
- * @function type
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function type(types: string[] | string, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @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}
- * @param {Constructor<Validator>} [validator] the Validator to be used. Defaults to {@link DateValidator}
- *
- * @function date
- *
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function date(format?: string, message?: string): (target: Record<string, any>, propertyKey?: 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 PasswordPatterns#CHAR8_ONE_OF_EACH}
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#PASSWORD}
- * @param {Constructor<Validator>} [validator] Defaults to {@link PasswordValidator}
- *
- * @function password
- *
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function password(pattern?: RegExp, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @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}
- * @param {Constructor<Validator>} [validator] defaults to {@link ListValidator}
- *
- * @function list
- *
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function list(clazz: ModelConstructor<any> | ModelConstructor<any>[], collection?: "Array" | "Set", message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-/**
- * @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}
- * @param {Constructor<Validator>} [validator]
- *
- * @function set
- *
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
- */
-export declare function set(clazz: ModelConstructor<any>, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;

package/lib/validation/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./Validators";
-export * from "./decorators";
-export * from "./types";
-export * from "./Validation";

package/lib/validation/types.d.ts

@@ -1,134 +0,0 @@
-import { DecoratorMetadata } from "@decaf-ts/reflection";
-import { Constructor } from "../model";
-import { Validator } from "./Validators";
-import { IRegistry } from "../utils";
-/**
- * @summary Type for validation decorator metadata
- * @memberOf module:decorator-validation.Reflection
- * @category Reflection
- */
-export type ValidationMetadata = {
-    [indexer: string]: any;
-    args?: any[];
-    message: string;
-    types?: string[];
-};
-/**
- * @summary Type for a validator property decorator definition
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export type ValidationPropertyDecoratorDefinition = {
-    prop: string | symbol;
-    decorators: ValidationDecoratorDefinition[];
-};
-/**
- * @summary Type for a validator decorator definition
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export type ValidationDecoratorDefinition = DecoratorMetadata & {
-    props: ValidationElementDefinition;
-};
-/**
- * @summary Type for a validator element metadata
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export type ValidationElementDefinition = {
-    [indexer: string]: any;
-    value?: string | number;
-    message: string;
-    types?: string[];
-};
-/**
- * @summary Type for a model errors
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export type ModelErrors = Record<string, Record<string, string | undefined>>;
-/**
- * @summary Util type for {@link Validator} configuration
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export type ValidatorDefinition = {
-    validator: Constructor<Validator>;
-    validationKey: string;
-    save: boolean;
-};
-/**
- * @summary Base API for a {@link Validator} registry
- *
- * @interface ValidatorRegistry
- * @extends IRegistry
- *
- * @category Validation
- */
-export interface IValidatorRegistry<T extends Validator> extends IRegistry<T> {
-    /**
-     * @summary retrieves the custom keys
-     * @method
-     */
-    getCustomKeys(): Record<string, string>;
-    /**
-     * @summary Retrieves the Registered validator keys
-     * @return {string[]} the registered validators keys
-     * @method
-     */
-    getKeys(): string[];
-    /**
-     * @summary Registers the provided validators onto the registry
-     *
-     * @typedef T extends Validator
-     * @param {T[] | ValidatorDefinition[]} validator
-     * @method
-     */
-    register<T extends Validator>(...validator: (T | ValidatorDefinition)[]): void;
-    /**
-     * @summary Retrieves the Validator constructor if registered
-     *
-     * @typedef T extends Validator
-     * @param {string} key one of the {@link ValidationKeys}
-     * @return {Validator | undefined} the registered Validator or undefined if there is nono matching the provided key
-     * @method
-     */
-    get<T extends Validator>(key: string): T | undefined;
-}
-export type ValidatorOptions = {
-    message?: string;
-};
-export interface URLValidatorOptions extends ValidatorOptions {
-    types: string | string[] | {
-        name: string;
-    };
-}
-export interface TypeValidatorOptions extends ValidatorOptions {
-    types: string | string[] | {
-        name: string;
-    };
-}
-export interface StepValidatorOptions extends ValidatorOptions {
-    step: number | string;
-}
-export interface PatternValidatorOptions extends ValidatorOptions {
-    pattern?: RegExp | string;
-}
-export interface MinValidatorOptions extends ValidatorOptions {
-    min: number | Date | string;
-}
-export interface MinLengthValidatorOptions extends ValidatorOptions {
-    minLength: number;
-}
-export interface MaxValidatorOptions extends ValidatorOptions {
-    max: number | Date | string;
-}
-export interface MaxLengthValidatorOptions extends ValidatorOptions {
-    maxLength: number;
-}
-export interface ListValidatorOptions extends ValidatorOptions {
-    clazz: string[];
-}
-export interface DateValidatorOptions extends ValidatorOptions {
-    format?: string;
-}