@decaf-ts/decorator-validation 1.5.8 → 1.5.10

package/lib/esm/validation/Validation.d.ts

@@ -1,51 +0,0 @@
-import { Validator } from "./Validators/Validator";
-import { IValidatorRegistry, ValidatorDefinition } from "./Validators/types";
-/**
- * @summary Static class acting as a namespace for the Validation
- *
- * @class Validation
- * @static
- *
- * @category Validation
- */
-export declare class Validation {
-    private static actingValidatorRegistry?;
-    private constructor();
-    /**
-     * @summary Defines the acting ValidatorRegistry
-     *
-     * @param {IValidatorRegistry} validatorRegistry the new implementation of the validator Registry
-     * @param {function(Validator): Validator} [migrationHandler] the method to map the validator if required;
-     */
-    static setRegistry(validatorRegistry: IValidatorRegistry<Validator>, migrationHandler?: (validator: Validator) => Validator): void;
-    /**
-     * @summary Returns the current ValidatorRegistry
-     *
-     * @return IValidatorRegistry, defaults to {@link ValidatorRegistry}
-     */
-    private static getRegistry;
-    /**
-     * @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
-     */
-    static get<T extends Validator>(validatorKey: string): T | undefined;
-    /**
-     * @summary Registers the provided validators onto the registry
-     *
-     * @param {T[] | ValidatorDefinition[]} validator
-     */
-    static register<T extends Validator>(...validator: (ValidatorDefinition | T)[]): void;
-    /**
-     * @summary Builds the key to store as Metadata under Reflections
-     * @description concatenates {@link ValidationKeys#REFLECT} with the provided key
-     *
-     * @param {string} key
-     */
-    static key(key: string): string;
-    /**
-     * @summary Returns all registered validation keys
-     */
-    static keys(): string[];
-}

package/lib/esm/validation/Validators/DateValidator.d.ts

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

package/lib/esm/validation/Validators/EmailValidator.d.ts

@@ -1,28 +0,0 @@
-import { PatternValidator } from "./PatternValidator";
-import { PatternValidatorOptions } from "./types";
-/**
- * @summary Email Validator
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#EMAIL}
- *
- * @class EmailValidator
- * @extends PatternValidator
- *
- * @category Validators
- */
-export declare class EmailValidator 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/esm/validation/Validators/ListValidator.d.ts

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

package/lib/esm/validation/Validators/MaxLengthValidator.d.ts

@@ -1,29 +0,0 @@
-import { Validator } from "./Validator";
-import { MaxLengthValidatorOptions } from "./types";
-/**
- * @summary Maximum Length Validator
- * @description Validates strings and Arrays on their maximum length
- *
- * @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#MAX_LENGTH}
- *
- * @class MinLengthValidator
- * @extends Validator
- *
- * @category Validators
- */
-export declare class MaxLengthValidator extends Validator<MaxLengthValidatorOptions> {
-    constructor(message?: string);
-    /**
-     * @summary Validates a model
-     *
-     * @param {string} value
-     * @param {MaxLengthValidatorOptions} options
-     *
-     * @return {string | undefined}
-     *
-     * @override
-     *
-     * @see Validator#hasErrors
-     */
-    hasErrors(value: string | any[], options: MaxLengthValidatorOptions): string | undefined;
-}

package/lib/esm/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/esm/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/esm/validation/Validators/index.d.ts

@@ -1,52 +0,0 @@
-import { DateValidator } from "./DateValidator";
-import { TypeValidator } from "./TypeValidator";
-import { PasswordValidator } from "./PasswordValidator";
-import { StepValidator } from "./StepValidator";
-import { URLValidator } from "./URLValidator";
-import { PatternValidator } from "./PatternValidator";
-import { MinValidator } from "./MinValidator";
-import { MinLengthValidator } from "./MinLengthValidator";
-import { MaxValidator } from "./MaxValidator";
-import { MaxLengthValidator } from "./MaxLengthValidator";
-import { RequiredValidator } from "./RequiredValidator";
-import { EmailValidator } from "./EmailValidator";
-import { ListValidator } from "./ListValidator";
-export * from "./constants";
-export * from "./DateValidator";
-export * from "./decorators";
-export * from "./EmailValidator";
-export * from "./ListValidator";
-export * from "./MaxLengthValidator";
-export * from "./MaxValidator";
-export * from "./MinLengthValidator";
-export * from "./MinValidator";
-export * from "./PasswordValidator";
-export * from "./PatternValidator";
-export * from "./RequiredValidator";
-export * from "./StepValidator";
-export * from "./types";
-export * from "./TypeValidator";
-export * from "./URLValidator";
-export * from "./Validator";
-export * from "./ValidatorRegistry";
-/**
- * @summary constant holding all {@link Validator}s
- * @constant Validators
- * @memberOf module:decorator-validation.Validation.Validators
- * @category Validation
- */
-export declare const Validators: {
-    DateValidator: typeof DateValidator;
-    EmailValidator: typeof EmailValidator;
-    ListValidator: typeof ListValidator;
-    MaxLengthValidator: typeof MaxLengthValidator;
-    MaxValidator: typeof MaxValidator;
-    MinLengthValidator: typeof MinLengthValidator;
-    MinValidator: typeof MinValidator;
-    PasswordValidator: typeof PasswordValidator;
-    PatternValidator: typeof PatternValidator;
-    RequiredValidator: typeof RequiredValidator;
-    StepValidator: typeof StepValidator;
-    TypeValidator: typeof TypeValidator;
-    URLValidator: typeof URLValidator;
-};

package/lib/esm/validation/Validators/types.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,46 +0,0 @@
-import { DecoratorMetadata } from "@decaf-ts/reflection";
-/**
- * @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>>;

package/lib/index.d.ts

@@ -1,42 +0,0 @@
-/**
- * @module decorator-validation
- */
-/**
- * @summary Model definition functionality
- * @description defines the base class and related functionality
- *
- * @namespace Model
- * @memberOf module:decorator-validation
- */
-/**
- * @summary Holds all the supported decorators
- * @namespace Decorators
- * @memberOf module:decorator-validation
- */
-/**
- * @summary Validation related functionality
- * @description Defines the Model validation apis and base classes for validators
- *
- * @namespace Validation
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Dates
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Hashing
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Serialization
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Format
- * @memberOf module:decorator-validation
- */
-export * from "./utils";
-export * from "./validation";
-export * from "./model";
-export declare const VERSION = "1.5.7";

package/lib/index.js

@@ -1,59 +0,0 @@
-"use strict";
-/**
- * @module decorator-validation
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VERSION = void 0;
-/**
- * @summary Model definition functionality
- * @description defines the base class and related functionality
- *
- * @namespace Model
- * @memberOf module:decorator-validation
- */
-/**
- * @summary Holds all the supported decorators
- * @namespace Decorators
- * @memberOf module:decorator-validation
- */
-/**
- * @summary Validation related functionality
- * @description Defines the Model validation apis and base classes for validators
- *
- * @namespace Validation
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Dates
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Hashing
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Serialization
- * @memberOf module:decorator-validation
- */
-/**
- * @namespace Format
- * @memberOf module:decorator-validation
- */
-__exportStar(require("./utils"), exports);
-__exportStar(require("./validation"), exports);
-__exportStar(require("./model"), exports);
-exports.VERSION = "1.5.7";

package/lib/model/Model.d.ts

@@ -1,203 +0,0 @@
-import { BuilderRegistry } from "../utils/registry";
-import { ModelErrorDefinition } from "./ModelErrorDefinition";
-import { Comparable, Constructor, Hashable, ModelArg, ModelBuilderFunction, ModelConstructor, Serializable, Validatable } from "./types";
-/**
- * @summary For Serialization/deserialization purposes.
- * @description Reads the {@link ModelKeys.ANCHOR} property of a {@link Model} to discover the class to instantiate
- *
- * @function isModel
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export declare function isModel(target: Record<string, any>): boolean;
-/**
- * @summary ModelRegistry Interface
- *
- * @interface ModelRegistry
- * @extends BuilderRegistry<Model>
- *
- * @category Model
- */
-export type ModelRegistry<T extends Model> = BuilderRegistry<T>;
-/**
- * @summary Util class to enable serialization and correct rebuilding
- *
- * @param {string} anchorKey defaults to {@link ModelKeys.ANCHOR}. The property name where the registered class name is stored;
- * @param {function(Record<string, any>): boolean} [testFunction] method to test if the provided object is a Model Object. defaults to {@link isModel}
- *
- * @class ModelRegistryManager
- * @implements ModelRegistry
- *
- * @category Model
- */
-export declare class ModelRegistryManager<T extends Model> implements ModelRegistry<T> {
-    private cache;
-    private readonly testFunction;
-    constructor(testFunction?: (obj: Record<string, any>) => boolean);
-    /**
-     * @summary register new Models
-     * @param {any} constructor
-     * @param {string} [name] when not defined, the name of the constructor will be used
-     */
-    register(constructor: ModelConstructor<T>, name?: string): void;
-    /**
-     * @summary Gets a registered Model {@link ModelConstructor}
-     * @param {string} name
-     */
-    get(name: string): ModelConstructor<T> | undefined;
-    /**
-     * @param {Record<string, any>} obj
-     * @param {string} [clazz] when provided, it will attempt to find the matching constructor
-     *
-     * @throws Error If clazz is not found, or obj is not a {@link Model} meaning it has no {@link ModelKeys.ANCHOR} property
-     */
-    build(obj?: Record<string, any>, clazz?: string): T;
-}
-/**
- * @summary Bulk Registers Models
- * @description Useful when using bundlers that might not evaluate all the code at once
- *
- * @param {Array<Constructor<T>> | Array<{name: string, constructor: Constructor<T>}>} [models]
- *
- * @memberOf module:decorator-validation.Model
- * @category Model
- */
-export declare function bulkModelRegister<T extends Model>(...models: (Constructor<T> | {
-    name: string;
-    constructor: Constructor<T>;
-})[]): void;
-/**
- * @summary Abstract class representing a Validatable Model object
- * @description Meant to be used as a base class for all Model classes
- *
- * Model objects must:
- *  - Have all their required properties marked with '!';
- *  - Have all their optional properties marked as '?':
- *
- * @param {Model | {}} model base object from which to populate properties from
- *
- * @class Model
- * @abstract
- * @implements Validatable
- * @implements Serializable
- *
- * @example
- *      class ClassName {
- *          @required()
- *          requiredPropertyName!: PropertyType;
- *
- *          optionalPropertyName?: PropertyType;
- *      }
- */
-export declare abstract class Model implements Validatable, Serializable, Hashable, Comparable<Model> {
-    protected constructor(arg?: ModelArg<Model>);
-    /**
-     * @summary Validates the object according to its decorated properties
-     *
-     * @param {any[]} [exceptions] properties in the object to be ignored for the validation. Marked as 'any' to allow for extension but expects strings
-     */
-    hasErrors(...exceptions: any[]): ModelErrorDefinition | undefined;
-    /**
-     * @summary Compare object equality recursively
-     * @param {any} obj object to compare to
-     * @param {string} [exceptions] property names to be excluded from the comparison
-     */
-    equals(obj: any, ...exceptions: string[]): boolean;
-    /**
-     * @summary Returns the serialized model according to the currently defined {@link Serializer}
-     */
-    serialize(): string;
-    /**
-     * @summary Override the implementation for js's 'toString()' which sucks...
-     * @override
-     */
-    toString(): string;
-    /**
-     * @summary Defines a default implementation for object hash. Relies on a very basic implementation based on Java's string hash;
-     */
-    hash(): string;
-    /**
-     * @summary Deserializes a Model
-     * @param {string} str
-     *
-     * @throws {Error} If it fails to parse the string, or if it fails to build the model
-     */
-    static deserialize(str: string): any;
-    /**
-     * @summary Repopulates the Object properties with the ones from the new object
-     * @description Iterates all common properties of obj (if existing) and self, and copies them onto self
-     *
-     * @param {T} self
-     * @param {T | Record<string, any>} [obj]
-     *
-     */
-    static fromObject<T extends Model>(self: T, obj?: T | Record<string, any>): T;
-    /**
-     * @summary Repopulates the instance with the ones from the new Model Object
-     * @description Iterates all common properties of obj (if existing) and self, and copies them onto self.
-     * Is aware of nested Model Objects and rebuilds them also.
-     * When List properties are decorated with {@link list}, they list items will also be rebuilt
-     *
-     * @param {T} self
-     * @param {T | Record<string, any>} [obj]
-     *
-     */
-    static fromModel<T extends Model>(self: T, obj?: T | Record<string, any>): T;
-    /**
-     * @summary Sets the Global {@link ModelBuilderFunction}
-     * @param {ModelBuilderFunction} [builder]
-     */
-    static setBuilder(builder?: ModelBuilderFunction): void;
-    /**
-     * @summary Retrieves the current global {@link ModelBuilderFunction}
-     */
-    static getBuilder(): ModelBuilderFunction | undefined;
-    /**
-     * Returns the current {@link ModelRegistryManager}
-     *
-     * @return ModelRegistry, defaults to {@link ModelRegistryManager}
-     */
-    private static getRegistry;
-    /**
-     * Returns the current actingModelRegistry
-     *
-     * @param {BuilderRegistry} modelRegistry the new implementation of Registry
-     */
-    static setRegistry(modelRegistry: BuilderRegistry<any>): void;
-    /**
-     * @summary register new Models
-     * @param {any} constructor
-     * @param {string} [name] when not defined, the name of the constructor will be used
-     *
-     * @see ModelRegistry
-     */
-    static register<T extends Model>(constructor: ModelConstructor<T>, name?: string): void;
-    /**
-     * @summary Gets a registered Model {@link ModelConstructor}
-     * @param {string} name
-     *
-     * @see ModelRegistry
-     */
-    static get<T extends Model>(name: string): ModelConstructor<T> | undefined;
-    /**
-     * @param {Record<string, any>} obj
-     * @param {string} [clazz] when provided, it will attempt to find the matching constructor
-     *
-     * @throws Error If clazz is not found, or obj is not a {@link Model} meaning it has no {@link ModelKeys.ANCHOR} property
-     *
-     * @see ModelRegistry
-     */
-    static build<T extends Model>(obj?: Record<string, any>, clazz?: string): T;
-    static getMetadata<V extends Model>(model: V): any;
-    static getAttributes<V extends Model>(model: Constructor<V> | V): string[];
-    static equals<V extends Model>(obj1: V, obj2: V, ...exceptions: any[]): boolean;
-    static hasErrors<V extends Model>(model: V, ...propsToIgnore: string[]): ModelErrorDefinition | undefined;
-    static serialize<V extends Model>(model: V): any;
-    static hash<V extends Model>(model: V): any;
-    /**
-     * @summary Builds the key to store as Metadata under Reflections
-     * @description concatenates {@link ModelKeys#REFLECT} with the provided key
-     * @param {string} str
-     */
-    static key(str: string): string;
-}