@decaf-ts/decorator-validation 1.5.7 → 1.5.9

package/lib/esm/model/Registry.js

@@ -1,73 +0,0 @@
-import { Model } from "./Model";
-import { sf } from "../utils/strings";
-import { isModel } from "./utils";
-/**
- * @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 class ModelRegistryManager {
-    constructor(testFunction = isModel) {
-        this.cache = {};
-        this.testFunction = testFunction;
-    }
-    /**
-     * @summary register new Models
-     * @param {any} constructor
-     * @param {string} [name] when not defined, the name of the constructor will be used
-     */
-    register(constructor, name) {
-        if (typeof constructor !== "function")
-            throw new Error("Model registering failed. Missing Class name or constructor");
-        name = name || constructor.name;
-        this.cache[name] = constructor;
-    }
-    /**
-     * @summary Gets a registered Model {@link ModelConstructor}
-     * @param {string} name
-     */
-    get(name) {
-        try {
-            return this.cache[name];
-            // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        }
-        catch (e) {
-            return 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 = {}, clazz) {
-        if (!clazz && !this.testFunction(obj))
-            throw new Error("Provided obj is not a Model object");
-        const name = clazz || Model.getMetadata(obj);
-        if (!(name in this.cache))
-            throw new Error(sf("Provided class {0} is not a registered Model object", name));
-        return new this.cache[name](obj);
-    }
-}
-/**
- * @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 function bulkModelRegister(...models) {
-    models.forEach((m) => {
-        const constructor = (m.constructor ? m.constructor : m);
-        Model.register(constructor, m.name);
-    });
-}

package/lib/esm/model/utils.d.ts

@@ -1,11 +0,0 @@
-import { Model } from "./Model";
-export declare function isPropertyModel<M extends Model>(target: M, attribute: string): boolean | string | undefined;
-/**
- * @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;

package/lib/esm/model/utils.js

@@ -1,25 +0,0 @@
-import { ModelKeys } from "../utils/constants";
-import { Model } from "./Model";
-export function isPropertyModel(target, attribute) {
-    if (isModel(target[attribute]))
-        return true;
-    const metadata = Reflect.getMetadata(ModelKeys.TYPE, target, attribute);
-    return Model.get(metadata.name) ? metadata.name : undefined;
-}
-/**
- * @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 function isModel(target) {
-    try {
-        return target instanceof Model || !!Model.getMetadata(target);
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    }
-    catch (e) {
-        return false;
-    }
-}

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

@@ -1,88 +0,0 @@
-import { Validator } from "./Validator";
-import { IRegistry } from "../../utils/registry";
-import { Constructor } from "../../model/types";
-/**
- * @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;
-}

package/lib/model/Registry.d.ts

@@ -1,59 +0,0 @@
-import { Model } from "./Model";
-import { BuilderRegistry } from "../utils/registry";
-import { Constructor, ModelConstructor } from "./types";
-/**
- * @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;

package/lib/model/Registry.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelRegistryManager = void 0;
-exports.bulkModelRegister = bulkModelRegister;
-const Model_1 = require("./Model");
-const strings_1 = require("../utils/strings");
-const utils_1 = require("./utils");
-/**
- * @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
- */
-class ModelRegistryManager {
-    constructor(testFunction = utils_1.isModel) {
-        this.cache = {};
-        this.testFunction = testFunction;
-    }
-    /**
-     * @summary register new Models
-     * @param {any} constructor
-     * @param {string} [name] when not defined, the name of the constructor will be used
-     */
-    register(constructor, name) {
-        if (typeof constructor !== "function")
-            throw new Error("Model registering failed. Missing Class name or constructor");
-        name = name || constructor.name;
-        this.cache[name] = constructor;
-    }
-    /**
-     * @summary Gets a registered Model {@link ModelConstructor}
-     * @param {string} name
-     */
-    get(name) {
-        try {
-            return this.cache[name];
-            // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        }
-        catch (e) {
-            return 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 = {}, clazz) {
-        if (!clazz && !this.testFunction(obj))
-            throw new Error("Provided obj is not a Model object");
-        const name = clazz || Model_1.Model.getMetadata(obj);
-        if (!(name in this.cache))
-            throw new Error((0, strings_1.sf)("Provided class {0} is not a registered Model object", name));
-        return new this.cache[name](obj);
-    }
-}
-exports.ModelRegistryManager = ModelRegistryManager;
-/**
- * @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
- */
-function bulkModelRegister(...models) {
-    models.forEach((m) => {
-        const constructor = (m.constructor ? m.constructor : m);
-        Model_1.Model.register(constructor, m.name);
-    });
-}

package/lib/model/utils.d.ts

@@ -1,11 +0,0 @@
-import { Model } from "./Model";
-export declare function isPropertyModel<M extends Model>(target: M, attribute: string): boolean | string | undefined;
-/**
- * @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;

package/lib/model/utils.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPropertyModel = isPropertyModel;
-exports.isModel = isModel;
-const constants_1 = require("../utils/constants");
-const Model_1 = require("./Model");
-function isPropertyModel(target, attribute) {
-    if (isModel(target[attribute]))
-        return true;
-    const metadata = Reflect.getMetadata(constants_1.ModelKeys.TYPE, target, attribute);
-    return Model_1.Model.get(metadata.name) ? metadata.name : undefined;
-}
-/**
- * @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
- */
-function isModel(target) {
-    try {
-        return target instanceof Model_1.Model || !!Model_1.Model.getMetadata(target);
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    }
-    catch (e) {
-        return false;
-    }
-}

package/lib/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 Decorators
- */
-export declare function validator<T extends Validator>(...keys: string[]): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;

package/lib/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/validation/Validators/index.js

@@ -1,69 +0,0 @@
-"use strict";
-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.Validators = void 0;
-const DateValidator_1 = require("./DateValidator");
-const TypeValidator_1 = require("./TypeValidator");
-const PasswordValidator_1 = require("./PasswordValidator");
-const StepValidator_1 = require("./StepValidator");
-const URLValidator_1 = require("./URLValidator");
-const PatternValidator_1 = require("./PatternValidator");
-const MinValidator_1 = require("./MinValidator");
-const MinLengthValidator_1 = require("./MinLengthValidator");
-const MaxValidator_1 = require("./MaxValidator");
-const MaxLengthValidator_1 = require("./MaxLengthValidator");
-const RequiredValidator_1 = require("./RequiredValidator");
-const EmailValidator_1 = require("./EmailValidator");
-const ListValidator_1 = require("./ListValidator");
-__exportStar(require("./constants"), exports);
-__exportStar(require("./DateValidator"), exports);
-__exportStar(require("./decorators"), exports);
-__exportStar(require("./EmailValidator"), exports);
-__exportStar(require("./ListValidator"), exports);
-__exportStar(require("./MaxLengthValidator"), exports);
-__exportStar(require("./MaxValidator"), exports);
-__exportStar(require("./MinLengthValidator"), exports);
-__exportStar(require("./MinValidator"), exports);
-__exportStar(require("./PasswordValidator"), exports);
-__exportStar(require("./PatternValidator"), exports);
-__exportStar(require("./RequiredValidator"), exports);
-__exportStar(require("./StepValidator"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./TypeValidator"), exports);
-__exportStar(require("./URLValidator"), exports);
-__exportStar(require("./Validator"), exports);
-__exportStar(require("./ValidatorRegistry"), exports);
-/**
- * @summary constant holding all {@link Validator}s
- * @constant Validators
- * @memberOf module:decorator-validation.Validation.Validators
- * @category Validation
- */
-exports.Validators = {
-    DateValidator: DateValidator_1.DateValidator,
-    EmailValidator: EmailValidator_1.EmailValidator,
-    ListValidator: ListValidator_1.ListValidator,
-    MaxLengthValidator: MaxLengthValidator_1.MaxLengthValidator,
-    MaxValidator: MaxValidator_1.MaxValidator,
-    MinLengthValidator: MinLengthValidator_1.MinLengthValidator,
-    MinValidator: MinValidator_1.MinValidator,
-    PasswordValidator: PasswordValidator_1.PasswordValidator,
-    PatternValidator: PatternValidator_1.PatternValidator,
-    RequiredValidator: RequiredValidator_1.RequiredValidator,
-    StepValidator: StepValidator_1.StepValidator,
-    TypeValidator: TypeValidator_1.TypeValidator,
-    URLValidator: URLValidator_1.URLValidator,
-};