@decaf-ts/decorator-validation 1.5.7 → 1.5.8

package/lib/model/Model.d.ts

@@ -1,6 +1,71 @@
 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

package/lib/model/Model.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Model = void 0;
+exports.Model = exports.ModelRegistryManager = void 0;
+exports.isModel = isModel;
+exports.bulkModelRegister = bulkModelRegister;
 const serialization_1 = require("../utils/serialization");
-const Registry_1 = require("./Registry");
 const reflection_1 = require("@decaf-ts/reflection");
 const validation_1 = require("./validation");
 const hashing_1 = require("../utils/hashing");
@@ -13,6 +14,94 @@ const strings_1 = require("../utils/strings");
 const constants_3 = require("./constants");
 let modelBuilderFunction;
 let actingModelRegistry;
+/**
+ * @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
@@ -209,7 +298,7 @@ class Model {
      */
     static getRegistry() {
         if (!actingModelRegistry)
-            actingModelRegistry = new Registry_1.ModelRegistryManager();
+            actingModelRegistry = new ModelRegistryManager();
         return actingModelRegistry;
     }
     /**

package/lib/model/index.d.ts

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

package/lib/model/index.js

@@ -19,7 +19,6 @@ __exportStar(require("./construction"), exports);
 __exportStar(require("./decorators"), exports);
 __exportStar(require("./Model"), exports);
 __exportStar(require("./ModelErrorDefinition"), exports);
-__exportStar(require("./Registry"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./validation"), exports);

package/lib/model/utils.d.ts

@@ -1,11 +1,2 @@
 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 +1,11 @@
 "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]))
+    if ((0, Model_1.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/model/validation.js

@@ -6,9 +6,9 @@ const reflection_1 = require("@decaf-ts/reflection");
 const constants_1 = require("../utils/constants");
 const strings_1 = require("../utils/strings");
 const constants_2 = require("./constants");
+const Model_1 = require("./Model");
 const Validation_1 = require("../validation/Validation");
 const constants_3 = require("../validation/Validators/constants");
-const utils_1 = require("./utils");
 /**
  * @summary Analyses the decorations of the properties and validates the obj according to them
  *
@@ -48,7 +48,7 @@ function validate(obj, ...propsToIgnore) {
             }
             const decoratorProps = decorator.key === constants_1.ModelKeys.TYPE
                 ? [decorator.props]
-                : (decorator.props || {});
+                : decorator.props || {};
             const err = validator.hasErrors(obj[prop.toString()], decoratorProps);
             if (err) {
                 errs = errs || {};
@@ -93,7 +93,7 @@ function validate(obj, ...propsToIgnore) {
                 }
                 const validate = (prop, value) => {
                     if (typeof value === "object" || typeof value === "function")
-                        return (0, utils_1.isModel)(value)
+                        return (0, Model_1.isModel)(value)
                             ? value.hasErrors()
                             : allowedTypes.includes(typeof value)
                                 ? undefined

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/decorator-validation",
-  "version": "1.5.7",
+  "version": "1.5.8",
   "description": "simple decorator based validation engine",
   "type": "module",
   "exports": {

package/lib/esm/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/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/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);
-    });
-}