@decaf-ts/decorator-validation 1.5.1 → 1.5.2

package/lib/model/constants.cjs

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsTypes = exports.ReservedModels = exports.Primitives = void 0;
-/**
- * @summary References the relevant JS primitives
- *
- * @property {string} STRING references the string primitive
- * @property {string} NUMBER references the number primitive
- * @property {string} BOOLEAN references the boolean primitive
- * @property {string} BIGINT references the bigint primitive
- *
- * @constant Primitives
- * @memberOf module:decorator-validation.Model
- */
-var Primitives;
-(function (Primitives) {
-    Primitives["STRING"] = "string";
-    Primitives["NUMBER"] = "number";
-    Primitives["BOOLEAN"] = "boolean";
-    Primitives["BIGINT"] = "bigint";
-})(Primitives || (exports.Primitives = Primitives = {}));
-/**
- * @summary References the Reserved model names to ignore during Model rebuilding
- *
- * @property {string} STRING
- * @property {string} OBJECT
- * @property {string} NUMBER
- * @property {string} BOOLEAN
- * @property {string} BIGINT
- * @property {string} DATE
- *
- * @constant ReservedModels
- * @memberOf module:decorator-validation.Model
- */
-var ReservedModels;
-(function (ReservedModels) {
-    ReservedModels["STRING"] = "string";
-    ReservedModels["OBJECT"] = "object";
-    ReservedModels["NUMBER"] = "number";
-    ReservedModels["BOOLEAN"] = "boolean";
-    ReservedModels["BIGINT"] = "bigint";
-    ReservedModels["DATE"] = "date";
-})(ReservedModels || (exports.ReservedModels = ReservedModels = {}));
-/**
- * @summary References the basic supported js types
- *
- * @property {string} string
- * @property {string} array
- * @property {string} number
- * @property {string} boolean
- * @property {string} symbol
- * @property {string} function
- * @property {string} object
- * @property {string} undefined
- * @property {string} null
- * @property {string} BIGINT
- *
- * @constant jsTypes
- * @memberOf module:decorator-validation.Model
- */
-exports.jsTypes = [
-    "string",
-    "array",
-    "number",
-    "boolean",
-    "symbol",
-    "function",
-    "object",
-    "undefined",
-    "null",
-    "bigint",
-];

package/lib/model/constants.d.ts

@@ -1,56 +0,0 @@
-/**
- * @summary References the relevant JS primitives
- *
- * @property {string} STRING references the string primitive
- * @property {string} NUMBER references the number primitive
- * @property {string} BOOLEAN references the boolean primitive
- * @property {string} BIGINT references the bigint primitive
- *
- * @constant Primitives
- * @memberOf module:decorator-validation.Model
- */
-export declare enum Primitives {
-    STRING = "string",
-    NUMBER = "number",
-    BOOLEAN = "boolean",
-    BIGINT = "bigint"
-}
-/**
- * @summary References the Reserved model names to ignore during Model rebuilding
- *
- * @property {string} STRING
- * @property {string} OBJECT
- * @property {string} NUMBER
- * @property {string} BOOLEAN
- * @property {string} BIGINT
- * @property {string} DATE
- *
- * @constant ReservedModels
- * @memberOf module:decorator-validation.Model
- */
-export declare enum ReservedModels {
-    STRING = "string",
-    OBJECT = "object",
-    NUMBER = "number",
-    BOOLEAN = "boolean",
-    BIGINT = "bigint",
-    DATE = "date"
-}
-/**
- * @summary References the basic supported js types
- *
- * @property {string} string
- * @property {string} array
- * @property {string} number
- * @property {string} boolean
- * @property {string} symbol
- * @property {string} function
- * @property {string} object
- * @property {string} undefined
- * @property {string} null
- * @property {string} BIGINT
- *
- * @constant jsTypes
- * @memberOf module:decorator-validation.Model
- */
-export declare const jsTypes: string[];

package/lib/model/construction.cjs

@@ -1,68 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.construct = construct;
-exports.findLastProtoBeforeObject = findLastProtoBeforeObject;
-exports.bindModelPrototype = bindModelPrototype;
-const Model_1 = require("./Model.cjs");
-/**
- * @summary Helper Function to override constructors
- *
- * @param {Function} constructor
- * @param {any[]} [args]
- * @return {T} the new instance
- *
- * @function construct
- * @memberOf module:decorator-validation.Construction
- */
-function construct(constructor, ...args) {
-    const _constr = (...argz) => new constructor(...argz);
-    _constr.prototype = constructor.prototype;
-    return _constr(...args);
-}
-/**
- * @summary Recursively finds the last prototype before Object
- * @param {object} obj
- *
- * @function findLastProtoBeforeObject
- * @memberOf module:decorator-validation.Construction
- */
-function findLastProtoBeforeObject(obj) {
-    let prototype = Object.getPrototypeOf(obj);
-    if (prototype === Object.prototype)
-        return obj;
-    while (prototype !== Object.prototype) {
-        prototype = Object.getPrototypeOf(prototype);
-        if (prototype === Object.prototype)
-            return prototype;
-        if (Object.getPrototypeOf(prototype) === Object.prototype)
-            return prototype;
-    }
-    throw new Error("Could not find proper prototype");
-}
-/**
- * @sumary binds the {@link Model} class as a root prototype of the provided instance
- *
- * @param {unknown} obj
- *
- * @function bindModelPrototype
- * @memberOf module:decorator-validation.Construction
- */
-function bindModelPrototype(obj) {
-    if (obj instanceof Model_1.Model)
-        return;
-    function bindPrototype(objToOverride, prototype) {
-        Object.setPrototypeOf(objToOverride, prototype);
-    }
-    const prototype = Object.getPrototypeOf(obj);
-    if (prototype === Object.prototype) {
-        return bindPrototype(obj, Model_1.Model.prototype);
-    }
-    while (prototype !== Object.prototype) {
-        const prot = Object.getPrototypeOf(prototype);
-        if (prot === Object.prototype ||
-            Object.getPrototypeOf(prot) === Object.prototype) {
-            return bindPrototype(prototype, Model_1.Model.prototype);
-        }
-    }
-    throw new Error("Could not find proper prototype to bind");
-}

package/lib/model/construction.d.ts

@@ -1,29 +0,0 @@
-import { Model } from "./Model";
-/**
- * @summary Helper Function to override constructors
- *
- * @param {Function} constructor
- * @param {any[]} [args]
- * @return {T} the new instance
- *
- * @function construct
- * @memberOf module:decorator-validation.Construction
- */
-export declare function construct<T extends Model>(constructor: any, ...args: any[]): T;
-/**
- * @summary Recursively finds the last prototype before Object
- * @param {object} obj
- *
- * @function findLastProtoBeforeObject
- * @memberOf module:decorator-validation.Construction
- */
-export declare function findLastProtoBeforeObject(obj: object): object;
-/**
- * @sumary binds the {@link Model} class as a root prototype of the provided instance
- *
- * @param {unknown} obj
- *
- * @function bindModelPrototype
- * @memberOf module:decorator-validation.Construction
- */
-export declare function bindModelPrototype(obj: unknown): void;

package/lib/model/decorators.cjs

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.model = model;
-exports.hashedBy = hashedBy;
-exports.serializedBy = serializedBy;
-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
- * @description
- *
- * - Registers the class under the model registry so it can be easily rebuilt;
- * - Overrides the class constructor;
- * - Runs the global {@link ModelBuilderFunction} if defined;
- * - Runs the optional {@link InstanceCallback} if provided;
- *
- * @param {InstanceCallback} [instanceCallback] optional callback that will be called with the instance upon instantiation. defaults to undefined
- *
- * @function model
- *
- * @memberOf module:decorator-validation.Model
- *
- */
-function model(instanceCallback) {
-    return ((original) => {
-        // the new constructor behaviour
-        const newConstructor = function (...args) {
-            const instance = (0, construction_1.construct)(original, ...args);
-            (0, construction_1.bindModelPrototype)(instance);
-            // run a builder function if defined with the first argument (The ModelArg)
-            const builder = Model_1.Model.getBuilder();
-            if (builder)
-                builder(instance, args.length ? args[0] : undefined);
-            (0, reflection_1.metadata)(Model_1.Model.key(constants_1.ModelKeys.MODEL), original.name)(instance.constructor);
-            if (instanceCallback)
-                instanceCallback(instance, ...args);
-            return instance;
-        };
-        // copy prototype so instanceof operator still works
-        newConstructor.prototype = original.prototype;
-        // Sets the proper constructor name for type verification
-        Object.defineProperty(newConstructor, "name", {
-            writable: false,
-            enumerable: true,
-            configurable: false,
-            value: original.prototype.constructor.name,
-        });
-        (0, reflection_1.metadata)(Model_1.Model.key(constants_1.ModelKeys.MODEL), original.name)(original);
-        Model_1.Model.register(newConstructor, original.name);
-        // return new constructor (will override original)
-        return newConstructor;
-    });
-}
-function hashedBy(algorithm, ...args) {
-    return (0, reflection_1.metadata)(Model_1.Model.key(constants_1.ModelKeys.HASHING), {
-        algorithm: algorithm,
-        args: args,
-    });
-}
-function serializedBy(serializer, ...args) {
-    return (0, reflection_1.metadata)(Model_1.Model.key(constants_1.ModelKeys.SERIALIZATION), {
-        serializer: serializer,
-        args: args,
-    });
-}

package/lib/model/decorators.d.ts

@@ -1,25 +0,0 @@
-/**
- * @summary defines the tpe os an InstanceCallback function
- *
- * @memberOf module:decorator-validation.Model
- */
-export type InstanceCallback = (instance: any, ...args: any[]) => void;
-/**
- * @summary Defines a class as a Model class
- * @description
- *
- * - Registers the class under the model registry so it can be easily rebuilt;
- * - Overrides the class constructor;
- * - Runs the global {@link ModelBuilderFunction} if defined;
- * - Runs the optional {@link InstanceCallback} if provided;
- *
- * @param {InstanceCallback} [instanceCallback] optional callback that will be called with the instance upon instantiation. defaults to undefined
- *
- * @function model
- *
- * @memberOf module:decorator-validation.Model
- *
- */
-export declare function model(instanceCallback?: InstanceCallback): any;
-export declare function hashedBy(algorithm: string, ...args: any[]): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
-export declare function serializedBy(serializer: string, ...args: any[]): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;

package/lib/model/index.cjs

@@ -1,25 +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 });
-__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("./Registry.cjs"), exports);
-__exportStar(require("./types.cjs"), exports);
-__exportStar(require("./utils.cjs"), exports);
-__exportStar(require("./validation.cjs"), exports);

package/lib/model/index.d.ts

@@ -1,9 +0,0 @@
-export * from "./constants";
-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/types.cjs

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/model/types.d.ts

@@ -1,79 +0,0 @@
-import { ModelErrorDefinition } from "./ModelErrorDefinition";
-import { Model } from "./Model";
-/**
- * @summary Typo of a Model builder function
- * @memberOf module:decorator-validation.Construction
- * @category Construction
- */
-export type ModelBuilderFunction = <T extends Model>(self: T, obj?: T | Record<string, any>) => T;
-/**
- * @summary Definition of a Model Constructor Argument
- *
- * @memberOf module:decorator-validation.Model
- * @category Model
- *
- * @see ModelConstructor
- */
-export type ModelArg<T> = T | Record<string, any>;
-/**
- * @summary Definition of a Class Constructor
- * @description Generic type for Constructor functions
- *
- * @typedef Constructor
- *
- * @param {any[]} [args]
- * @memberOf module:decorator-validation.Model
- * @category Model
- */
-export type Constructor<T> = {
-    new (...args: any[]): T;
-};
-/**
- * @summary Definition of a Model Constructor
- * @description Generic type for all Model Constructor functions
- *
- * @typedef ModelConstructor
- *
- * @param {ModelArg<T>} [model]
- * @param {any[]} [args]
- * @memberOf module:decorator-validation.Model
- * @category Construction
- */
-export type ModelConstructor<T extends Model> = {
-    new (model?: ModelArg<T>, ...args: any[]): T;
-};
-/**
- * @summary Defines the Validation API for validatable models
- * @interface Validatable
- *
- * @category Validation
- */
-export interface Validatable {
-    /**
-     * @summary Validates the model and returns the {@link ModelErrorDefinition} if any
-     * @param {any} [args]
-     *
-     * @method
-     */
-    hasErrors(...args: any[]): ModelErrorDefinition | undefined;
-}
-/**
- * @summary Serializable interface
- *
- * @interface Serializable
- *
- * @category Serialization
- */
-export interface Serializable {
-    /**
-     * @summary serializes the model
-     * @method
-     */
-    serialize(): string;
-}
-export interface Hashable {
-    hash(): string;
-}
-export interface Comparable<T> {
-    equals(other: T, ...args: any[]): boolean;
-}

package/lib/model/utils.cjs

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPropertyModel = isPropertyModel;
-exports.isModel = isModel;
-const constants_1 = require("../utils/constants.cjs");
-const Model_1 = require("./Model.cjs");
-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/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/validation.cjs

@@ -1,138 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validate = validate;
-const ModelErrorDefinition_1 = require("./ModelErrorDefinition.cjs");
-const reflection_1 = require("@decaf-ts/reflection");
-const constants_1 = require("../utils/constants.cjs");
-const strings_1 = require("../utils/strings.cjs");
-const constants_2 = require("./constants.cjs");
-const Validation_1 = require("../validation/Validation.cjs");
-const constants_3 = require("../validation/Validators/constants.cjs");
-const utils_1 = require("./utils.cjs");
-/**
- * @summary Analyses the decorations of the properties and validates the obj according to them
- *
- * @typedef T extends Model
- * @prop {T} obj Model object to validate
- * @prop {string[]} [propsToIgnore] object properties to ignore in the validation
- *
- * @function validate
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-function validate(obj, ...propsToIgnore) {
-    const decoratedProperties = [];
-    for (const prop in obj)
-        if (Object.prototype.hasOwnProperty.call(obj, prop) &&
-            propsToIgnore.indexOf(prop) === -1)
-            decoratedProperties.push(reflection_1.Reflection.getPropertyDecorators(constants_3.ValidationKeys.REFLECT, obj, prop));
-    let result = undefined;
-    for (const decoratedProperty of decoratedProperties) {
-        const { prop, decorators } = decoratedProperty;
-        if (!decorators || !decorators.length)
-            continue;
-        const defaultTypeDecorator = decorators[0];
-        // tries to find any type decorators or other decorators that already enforce type (the ones with the allowed types property defined). if so, skip the default type verification
-        if (decorators.find((d) => {
-            if (d.key === constants_3.ValidationKeys.TYPE)
-                return true;
-            return !!d.props.types?.find((t) => t === defaultTypeDecorator.props.name);
-        })) {
-            decorators.shift(); // remove the design:type decorator, since the type will already be checked
-        }
-        let errs = undefined;
-        for (const decorator of decorators) {
-            const validator = Validation_1.Validation.get(decorator.key);
-            if (!validator) {
-                throw new Error(`Missing validator for ${decorator.key}`);
-            }
-            const decoratorProps = decorator.key === constants_1.ModelKeys.TYPE
-                ? [decorator.props]
-                : (decorator.props || {});
-            const err = validator.hasErrors(obj[prop.toString()], decoratorProps);
-            if (err) {
-                errs = errs || {};
-                errs[decorator.key] = err;
-            }
-        }
-        if (errs) {
-            result = result || {};
-            result[decoratedProperty.prop.toString()] = errs;
-        }
-    }
-    // tests nested classes
-    for (const prop of Object.keys(obj).filter((k) => !result || !result[k])) {
-        let err;
-        // if a nested Model
-        const allDecorators = reflection_1.Reflection.getPropertyDecorators(constants_3.ValidationKeys.REFLECT, obj, prop).decorators;
-        const decorators = reflection_1.Reflection.getPropertyDecorators(constants_3.ValidationKeys.REFLECT, obj, prop).decorators.filter((d) => [constants_1.ModelKeys.TYPE, constants_3.ValidationKeys.TYPE].indexOf(d.key) !== -1);
-        if (!decorators || !decorators.length)
-            continue;
-        const dec = decorators.pop();
-        const clazz = dec.props.name
-            ? [dec.props.name]
-            : Array.isArray(dec.props.customTypes)
-                ? dec.props.customTypes
-                : [dec.props.customTypes];
-        const reserved = Object.values(constants_2.ReservedModels).map((v) => v.toLowerCase());
-        for (const c of clazz) {
-            if (reserved.indexOf(c.toLowerCase()) === -1) {
-                const typeDecoratorKey = Array.isArray(obj[prop])
-                    ? constants_3.ValidationKeys.LIST
-                    : constants_3.ValidationKeys.TYPE;
-                const types = allDecorators.find((d) => d.key === typeDecoratorKey) || {};
-                let allowedTypes = [];
-                if (types && types.props) {
-                    const customTypes = Array.isArray(obj[prop])
-                        ? types.props.class
-                        : types.props.customTypes;
-                    if (customTypes)
-                        allowedTypes = Array.isArray(customTypes)
-                            ? customTypes.map((t) => `${t}`.toLowerCase())
-                            : [customTypes.toLowerCase()];
-                }
-                const validate = (prop, value) => {
-                    if (typeof value === "object" || typeof value === "function")
-                        return (0, utils_1.isModel)(value)
-                            ? value.hasErrors()
-                            : allowedTypes.includes(typeof value)
-                                ? undefined
-                                : "Value has no validatable type";
-                };
-                switch (c) {
-                    case Array.name:
-                    case Set.name:
-                        if (allDecorators.length) {
-                            const listDec = allDecorators.find((d) => d.key === constants_3.ValidationKeys.LIST);
-                            if (listDec) {
-                                err = (c === Array.name
-                                    ? obj[prop]
-                                    : // If it's a Set
-                                        obj[prop].values())
-                                    .map((v) => validate(prop, v))
-                                    .filter((e) => !!e);
-                                if (!err?.length) {
-                                    // if the result is an empty list...
-                                    err = undefined;
-                                }
-                            }
-                        }
-                        break;
-                    default:
-                        try {
-                            if (obj[prop])
-                                err = validate(prop, obj[prop]);
-                        }
-                        catch (e) {
-                            console.warn((0, strings_1.sf)("Model should be validatable but its not: " + e));
-                        }
-                }
-            }
-            if (err) {
-                result = result || {};
-                result[prop] = err;
-            }
-        }
-    }
-    return result ? new ModelErrorDefinition_1.ModelErrorDefinition(result) : undefined;
-}

package/lib/model/validation.d.ts

@@ -1,14 +0,0 @@
-import { ModelErrorDefinition } from "./ModelErrorDefinition";
-import { Model } from "./Model";
-/**
- * @summary Analyses the decorations of the properties and validates the obj according to them
- *
- * @typedef T extends Model
- * @prop {T} obj Model object to validate
- * @prop {string[]} [propsToIgnore] object properties to ignore in the validation
- *
- * @function validate
- * @memberOf module:decorator-validation.Validation
- * @category Validation
- */
-export declare function validate<T extends Model>(obj: T, ...propsToIgnore: string[]): ModelErrorDefinition | undefined;

package/lib/utils/constants.cjs

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelKeys = void 0;
-/**
- * @summary Defines the various Model keys used for reflection
- *
- * @property {string} REFLECT prefix to all other keys
- * @property {string} TYPE type key
- * @property {string} PARAMS method params key
- * @property {string} RETURN method return key
- * @property {string} MODEL model key
- * @property {string} ANCHOR anchor key. will serve as a ghost property in the model
- *
- * @constant ModelKeys
- * @memberOf module:decorator-validation.Model
- * @category Model
- */
-var ModelKeys;
-(function (ModelKeys) {
-    ModelKeys["REFLECT"] = "decaf.model.";
-    ModelKeys["TYPE"] = "design:type";
-    ModelKeys["PARAMS"] = "design:paramtypes";
-    ModelKeys["RETURN"] = "design:returntype";
-    ModelKeys["MODEL"] = "model";
-    ModelKeys["ANCHOR"] = "__model";
-    ModelKeys["CONSTRUCTION"] = "constructed-by";
-    ModelKeys["ATTRIBUTE"] = "__attributes";
-    ModelKeys["HASHING"] = "hashing";
-    ModelKeys["SERIALIZATION"] = "serialization";
-})(ModelKeys || (exports.ModelKeys = ModelKeys = {}));