@decaf-ts/decorator-validation 1.5.7 → 1.5.9

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

@@ -1,33 +1,7 @@
-import { Model } from "../model/Model";
 import { Constructor } from "../model/types";
-/**
- * @summary Helper in serialization
- *
- * @interface Serializer
- * @category Serialization
- */
-export interface Serializer<T extends Model> {
-    /**
-     * @summary Serializes a model
-     * @param {T} model
-     *
-     * @param args
-     * @method
-     *
-     * @throws {Error}
-     */
-    serialize(model: T, ...args: any[]): string;
-    /**
-     * @summary Rebuilds a model from serialization
-     * @param {string} str
-     *
-     * @param args
-     * @method
-     *
-     * @throws {Error}
-     */
-    deserialize(str: string, ...args: any[]): T;
-}
+import { Serializer } from "./types";
+import { Model } from "../model/Model";
+export declare const DefaultSerializationMethod = "json";
 /**
  * @summary Concrete implementation of a {@link Serializer} in JSON format
  * @description JS's native JSON.stringify (used here) is not deterministic
@@ -42,6 +16,7 @@ export interface Serializer<T extends Model> {
  * @category Serialization
  */
 export declare class JSONSerializer<T extends Model> implements Serializer<T> {
+    constructor();
     /**
      * @summary prepares the model for serialization
      * @description returns a shallow copy of the object, containing an enumerable {@link ModelKeys#ANCHOR} property
@@ -66,7 +41,6 @@ export declare class JSONSerializer<T extends Model> implements Serializer<T> {
      */
     serialize(model: T): string;
 }
-export declare const DefaultSerializationMethod = "json";
 export declare class Serialization {
     private static current;
     private static cache;

package/lib/esm/utils/serialization.js

@@ -1,5 +1,6 @@
 import { Model } from "../model/Model";
 import { ModelKeys } from "./constants";
+export const DefaultSerializationMethod = "json";
 /**
  * @summary Concrete implementation of a {@link Serializer} in JSON format
  * @description JS's native JSON.stringify (used here) is not deterministic
@@ -14,6 +15,7 @@ import { ModelKeys } from "./constants";
  * @category Serialization
  */
 export class JSONSerializer {
+    constructor() { }
     /**
      * @summary prepares the model for serialization
      * @description returns a shallow copy of the object, containing an enumerable {@link ModelKeys#ANCHOR} property
@@ -53,7 +55,6 @@ export class JSONSerializer {
         return JSON.stringify(this.preSerialize(model));
     }
 }
-export const DefaultSerializationMethod = "json";
 export class Serialization {
     static { this.current = DefaultSerializationMethod; }
     static { this.cache = {

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

@@ -0,0 +1,29 @@
+import { Model } from "../model";
+/**
+ * @summary Helper in serialization
+ *
+ * @interface Serializer
+ * @category Serialization
+ */
+export interface Serializer<T extends Model> {
+    /**
+     * @summary Serializes a model
+     * @param {T} model
+     *
+     * @param args
+     * @method
+     *
+     * @throws {Error}
+     */
+    serialize(model: T, ...args: any[]): string;
+    /**
+     * @summary Rebuilds a model from serialization
+     * @param {string} str
+     *
+     * @param args
+     * @method
+     *
+     * @throws {Error}
+     */
+    deserialize(str: string, ...args: any[]): T;
+}

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validators/Validator";
-import { IValidatorRegistry, ValidatorDefinition } from "./Validators/types";
+import { IValidatorRegistry, ValidatorDefinition } from "./types";
 /**
  * @summary Static class acting as a namespace for the Validation
  *

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validator";
-import { DateValidatorOptions } from "./types";
+import { DateValidatorOptions } from "../types";
 /**
  * @summary Date Validator
  *

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

@@ -1,5 +1,5 @@
 import { PatternValidator } from "./PatternValidator";
-import { PatternValidatorOptions } from "./types";
+import { PatternValidatorOptions } from "../types";
 /**
  * @summary Email Validator
  *

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validator";
-import { ListValidatorOptions } from "./types";
+import { ListValidatorOptions } from "../types";
 /**
  * @summary List Validator
  *

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validator";
-import { MaxLengthValidatorOptions } from "./types";
+import { MaxLengthValidatorOptions } from "../types";
 /**
  * @summary Maximum Length Validator
  * @description Validates strings and Arrays on their maximum length

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validator";
-import { MaxValidatorOptions } from "./types";
+import { MaxValidatorOptions } from "../types";
 /**
  * @summary Max Validator
  *

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validator";
-import { MinLengthValidatorOptions } from "./types";
+import { MinLengthValidatorOptions } from "../types";
 /**
  * @summary Minimum Length Validator
  * @description Validates strings and Arrays on their minimum length

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validator";
-import { MinValidatorOptions } from "./types";
+import { MinValidatorOptions } from "../types";
 /**
  * @summary Min Validator
  *

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

@@ -1,5 +1,5 @@
 import { PatternValidator } from "./PatternValidator";
-import { PatternValidatorOptions } from "./types";
+import { PatternValidatorOptions } from "../types";
 /**
  * @summary Handles Password Validation
  *

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validator";
-import { PatternValidatorOptions } from "./types";
+import { PatternValidatorOptions } from "../types";
 export declare const regexpParser: RegExp;
 /**
  * @summary Pattern Validator

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validator";
-import { ValidatorOptions } from "./types";
+import { ValidatorOptions } from "../types";
 /**
  * @summary Required Validator
  *

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validator";
-import { StepValidatorOptions } from "./types";
+import { StepValidatorOptions } from "../types";
 /**
  * @summary Step Validator
  *

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

@@ -1,5 +1,5 @@
 import { Validator } from "./Validator";
-import { TypeValidatorOptions } from "./types";
+import { TypeValidatorOptions } from "../types";
 /**
  * @summary Required Validator
  *

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

@@ -1,5 +1,5 @@
 import { PatternValidator } from "./PatternValidator";
-import { PatternValidatorOptions } from "./types";
+import { PatternValidatorOptions } from "../types";
 /**
  * @summary URL Validator
  * @description Pattern from {@link https://gist.github.com/dperini/729294}

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

@@ -1,4 +1,4 @@
-import { ValidatorOptions } from "./types";
+import { ValidatorOptions } from "../types";
 /**
  * @summary Base Implementation for Validators
  * @description Provides the underlying functionality for {@link Validator}s

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

@@ -1,5 +1,5 @@
-import { ValidatorDefinition } from "./types";
-import { IValidatorRegistry } from "./types";
+import { ValidatorDefinition } from "../types";
+import { IValidatorRegistry } from "../types";
 import type { Validator } from "./Validator";
 /**
  * @summary Duck typing for Validators

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

@@ -24,7 +24,6 @@ export * from "./PasswordValidator";
 export * from "./PatternValidator";
 export * from "./RequiredValidator";
 export * from "./StepValidator";
-export * from "./types";
 export * from "./TypeValidator";
 export * from "./URLValidator";
 export * from "./Validator";

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

@@ -24,7 +24,6 @@ export * from "./PasswordValidator";
 export * from "./PatternValidator";
 export * from "./RequiredValidator";
 export * from "./StepValidator";
-export * from "./types";
 export * from "./TypeValidator";
 export * from "./URLValidator";
 export * from "./Validator";

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

@@ -1,4 +1,7 @@
 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
@@ -44,3 +47,88 @@ export type ValidationElementDefinition = {
  * @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;
+}

package/lib/{index.js → index.cjs}

@@ -53,7 +53,7 @@ exports.VERSION = void 0;
  * @namespace Format
  * @memberOf module:decorator-validation
  */
-__exportStar(require("./utils"), exports);
-__exportStar(require("./validation"), exports);
-__exportStar(require("./model"), exports);
-exports.VERSION = "1.5.6";
+__exportStar(require("./utils/index.cjs"), exports);
+__exportStar(require("./validation/index.cjs"), exports);
+__exportStar(require("./model/index.cjs"), exports);
+exports.VERSION = "1.5.8";

package/lib/index.d.ts

@@ -39,4 +39,4 @@
 export * from "./utils";
 export * from "./validation";
 export * from "./model";
-export declare const VERSION = "1.5.6";
+export declare const VERSION = "1.5.8";

package/lib/model/{Model.js → Model.cjs}

@@ -1,18 +1,113 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Model = void 0;
-const serialization_1 = require("../utils/serialization");
-const Registry_1 = require("./Registry");
+exports.Model = exports.ModelRegistryManager = void 0;
+exports.isPropertyModel = isPropertyModel;
+exports.isModel = isModel;
+exports.bulkModelRegister = bulkModelRegister;
+const serialization_1 = require("../utils/serialization.cjs");
 const reflection_1 = require("@decaf-ts/reflection");
-const validation_1 = require("./validation");
-const hashing_1 = require("../utils/hashing");
-const utils_1 = require("./utils");
-const constants_1 = require("../utils/constants");
-const constants_2 = require("../validation/Validators/constants");
-const strings_1 = require("../utils/strings");
-const constants_3 = require("./constants");
+const validation_1 = require("./validation.cjs");
+const hashing_1 = require("../utils/hashing.cjs");
+const constants_1 = require("../utils/constants.cjs");
+const constants_2 = require("../validation/Validators/constants.cjs");
+const strings_1 = require("../utils/strings.cjs");
+const constants_3 = require("./constants.cjs");
 let modelBuilderFunction;
 let actingModelRegistry;
+function isPropertyModel(target, attribute) {
+    if (isModel(target[attribute]))
+        return true;
+    const metadata = Reflect.getMetadata(constants_1.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
+ */
+function isModel(target) {
+    try {
+        return target instanceof Model || !!Model.getMetadata(target);
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    }
+    catch (e) {
+        return false;
+    }
+}
+/**
+ * @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 = 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((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.register(constructor, m.name);
+    });
+}
 /**
  * @summary Abstract class representing a Validatable Model object
  * @description Meant to be used as a base class for all Model classes
@@ -122,7 +217,7 @@ class Model {
                 obj[prop] || undefined;
             if (typeof self[prop] !== "object")
                 continue;
-            const propM = (0, utils_1.isPropertyModel)(self, prop);
+            const propM = isPropertyModel(self, prop);
             if (propM) {
                 try {
                     self[prop] = Model.build(self[prop], typeof propM === "string" ? propM : undefined);
@@ -209,7 +304,7 @@ class Model {
      */
     static getRegistry() {
         if (!actingModelRegistry)
-            actingModelRegistry = new Registry_1.ModelRegistryManager();
+            actingModelRegistry = new ModelRegistryManager();
         return actingModelRegistry;
     }
     /**

package/lib/model/Model.d.ts

@@ -1,6 +1,72 @@
 import { BuilderRegistry } from "../utils/registry";
 import { ModelErrorDefinition } from "./ModelErrorDefinition";
 import { Comparable, Constructor, Hashable, ModelArg, ModelBuilderFunction, ModelConstructor, Serializable, Validatable } from "./types";
+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;
+/**
+ * @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

package/lib/model/{construction.js → construction.cjs}

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.construct = construct;
 exports.findLastProtoBeforeObject = findLastProtoBeforeObject;
 exports.bindModelPrototype = bindModelPrototype;
-const Model_1 = require("./Model");
+const Model_1 = require("./Model.cjs");
 /**
  * @summary Helper Function to override constructors
  *

package/lib/model/{decorators.js → decorators.cjs}

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.model = model;
 exports.hashedBy = hashedBy;
 exports.serializedBy = serializedBy;
-const construction_1 = require("./construction");
-const constants_1 = require("../utils/constants");
-const Model_1 = require("./Model");
+const construction_1 = require("./construction.cjs");
+const constants_1 = require("../utils/constants.cjs");
+const Model_1 = require("./Model.cjs");
 const reflection_1 = require("@decaf-ts/reflection");
 /**
  * @summary Defines a class as a Model class

package/lib/{utils/index.js → model/index.cjs}

@@ -14,10 +14,10 @@ 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 });
-__exportStar(require("./constants"), exports);
-__exportStar(require("./dates"), exports);
-__exportStar(require("./decorators"), exports);
-__exportStar(require("./hashing"), exports);
-__exportStar(require("./registry"), exports);
-__exportStar(require("./serialization"), exports);
-__exportStar(require("./strings"), exports);
+__exportStar(require("./constants.cjs"), exports);
+__exportStar(require("./construction.cjs"), exports);
+__exportStar(require("./decorators.cjs"), exports);
+__exportStar(require("./Model.cjs"), exports);
+__exportStar(require("./ModelErrorDefinition.cjs"), exports);
+__exportStar(require("./types.cjs"), exports);
+__exportStar(require("./validation.cjs"), exports);

package/lib/model/index.d.ts

@@ -3,7 +3,5 @@ export * from "./construction";
 export * from "./decorators";
 export * from "./Model";
 export * from "./ModelErrorDefinition";
-export * from "./Registry";
 export * from "./types";
-export * from "./utils";
 export * from "./validation";