@decaf-ts/decorator-validation 1.15.0 → 1.17.0

package/lib/types/model/ModelErrorDefinition.d.cts

@@ -0,0 +1,22 @@
+import { ModelErrors } from "../validation/types.cjs";
+/**
+ * @summary Helper Class to hold the error results
+ * @description holds error results in an 'indexable' manner
+ * while still providing the same result on toString
+ *
+ * @param {ModelErrors} errors
+ *
+ * @class ModelErrorDefinition
+ *
+ * @category Model
+ */
+export declare class ModelErrorDefinition {
+    [indexer: string]: Record<string, string | undefined> | (() => string | undefined);
+    constructor(errors: ModelErrors);
+    /**
+     * @summary Outputs the class to a nice readable string
+     *
+     * @override
+     */
+    toString(): string;
+}

package/lib/types/model/ModelErrorDefinition.d.mts

@@ -0,0 +1,22 @@
+import { ModelErrors } from "../validation/types.js";
+/**
+ * @summary Helper Class to hold the error results
+ * @description holds error results in an 'indexable' manner
+ * while still providing the same result on toString
+ *
+ * @param {ModelErrors} errors
+ *
+ * @class ModelErrorDefinition
+ *
+ * @category Model
+ */
+export declare class ModelErrorDefinition {
+    [indexer: string]: Record<string, string | undefined> | (() => string | undefined);
+    constructor(errors: ModelErrors);
+    /**
+     * @summary Outputs the class to a nice readable string
+     *
+     * @override
+     */
+    toString(): string;
+}

package/lib/types/model/ModelRegistry.d.cts

@@ -0,0 +1,181 @@
+import { Constructor } from "@decaf-ts/decoration";
+import { ModelBuilderFunction, ModelConstructor } from "./types.cjs";
+import { type Model } from "./Model.cjs";
+import { BuilderRegistry } from "../utils/registry.cjs";
+/**
+ * @description Registry type for storing and retrieving model constructors
+ * @summary The ModelRegistry type defines a registry for model constructors that extends
+ * the BuilderRegistry interface. It provides a standardized way to register, retrieve,
+ * and build model instances, enabling the model system to work with different types of models.
+ *
+ * @interface ModelRegistry
+ * @template T Type of model that can be registered, must extend Model
+ * @extends BuilderRegistry<T>
+ * @memberOf module:decorator-validation
+ * @category Model
+ */
+export type ModelRegistry<T extends Model> = BuilderRegistry<T>;
+/**
+ * @description Registry manager for model constructors that enables serialization and rebuilding
+ * @summary The ModelRegistryManager implements the ModelRegistry interface and provides
+ * functionality for registering, retrieving, and building model instances. It maintains
+ * a cache of model constructors indexed by name, allowing for efficient lookup and instantiation.
+ * This class is essential for the serialization and deserialization of model objects.
+ *
+ * @param {function(Record<string, any>): boolean} [testFunction] - Function to test if an object is a model, defaults to {@link Model#isModel}
+ *
+ * @class ModelRegistryManager
+ * @template M Type of model that can be registered, must extend Model
+ * @implements ModelRegistry<M>
+ * @category Model
+ *
+ * @example
+ * ```typescript
+ * // Create a model registry
+ * const registry = new ModelRegistryManager();
+ *
+ * // Register a model class
+ * registry.register(User);
+ *
+ * // Retrieve a model constructor by name
+ * const UserClass = registry.get("User");
+ *
+ * // Build a model instance from a plain object
+ * const userData = { name: "John", age: 30 };
+ * const user = registry.build(userData, "User");
+ * ```
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Client
+ *   participant R as ModelRegistryManager
+ *   participant M as Model Class
+ *
+ *   C->>R: new ModelRegistryManager(testFunction)
+ *   C->>R: register(ModelClass)
+ *   R->>R: Store in cache
+ *   C->>R: get("ModelName")
+ *   R-->>C: ModelClass constructor
+ *   C->>R: build(data, "ModelName")
+ *   R->>R: Get constructor from cache
+ *   R->>M: new ModelClass(data)
+ *   M-->>R: Model instance
+ *   R-->>C: Model instance
+ */
+export declare class ModelRegistryManager<M extends Model<true | false>> implements ModelRegistry<M> {
+    private cache;
+    private readonly testFunction;
+    constructor(testFunction?: (obj: Record<string, any>) => boolean);
+    /**
+     * @description Registers a model constructor with the registry
+     * @summary Adds a model constructor to the registry cache, making it available for
+     * later retrieval and instantiation. If no name is provided, the constructor's name
+     * property is used as the key in the registry.
+     *
+     * @param {ModelConstructor<M>} constructor - The model constructor to register
+     * @param {string} [name] - Optional name to register the constructor under, defaults to constructor.name
+     * @return {void}
+     * @throws {Error} If the constructor is not a function
+     */
+    register(constructor: ModelConstructor<M>, name?: string): void;
+    /**
+     * @summary Gets a registered Model {@link ModelConstructor}
+     * @param {string} name
+     */
+    get(name: string): ModelConstructor<M> | 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): M;
+    /**
+     * @description Configures the global model builder function
+     * @summary Sets the Global {@link ModelBuilderFunction} used for building model instances
+     *
+     * @param {ModelBuilderFunction} [builder] - The builder function to set as the global builder
+     * @return {void}
+     */
+    static setBuilder(builder?: ModelBuilderFunction): void;
+    /**
+     * @description Retrieves the currently configured global model builder function
+     * @summary Returns the current global {@link ModelBuilderFunction} used for building model instances
+     *
+     * @return {ModelBuilderFunction | undefined} - The current global builder function or undefined if not set
+     */
+    static getBuilder(): ModelBuilderFunction | undefined;
+    /**
+     * @description Copies and rebuilds properties from a source object to a model instance, handling nested models
+     * @summary Repopulates the instance with properties from the new Model Object, recursively rebuilding nested models
+     *
+     * @template T
+     * @param {T} self - The target model instance to update
+     * @param {T | Record<string, any>} [obj] - The source object containing properties to copy
+     * @return {T} - The updated model instance with rebuilt nested models
+     *
+     * @mermaid
+     * sequenceDiagram
+     *   participant C as Client
+     *   participant M as Model.fromModel
+     *   participant B as Model.build
+     *   participant R as Reflection
+     *
+     *   C->>M: fromModel(self, obj)
+     *   M->>M: Get attributes from self
+     *   loop For each property
+     *     M->>M: Copy property from obj to self
+     *     alt Property is a model
+     *       M->>M: Check if property is a model
+     *       M->>B: build(property, modelType)
+     *       B-->>M: Return built model
+     *     else Property is a complex type
+     *       M->>R: Get property decorators
+     *       R-->>M: Return decorators
+     *       M->>M: Filter type decorators
+     *       alt Property is Array/Set with list decorator
+     *         M->>M: Process each item in collection
+     *         loop For each item
+     *           M->>B: build(item, itemModelType)
+     *           B-->>M: Return built model
+     *         end
+     *       else Property is another model type
+     *         M->>B: build(property, propertyType)
+     *         B-->>M: Return built model
+     *       end
+     *     end
+     *   end
+     *   M-->>C: Return updated self
+     */
+    static fromModel<T extends Model>(self: T, obj?: T | Record<string, any>): T;
+    /**
+     * @description Provides access to the current model registry
+     * @summary Returns the current {@link ModelRegistryManager} instance, creating one if it doesn't exist
+     *
+     * @return {ModelRegistry<any>} - The current model registry, defaults to a new {@link ModelRegistryManager} if not set
+     * @private
+     */
+    static getRegistry(): BuilderRegistry<any>;
+    /**
+     * @description Configures the model registry to be used by the Model system
+     * @summary Sets the current model registry to a custom implementation
+     *
+     * @param {BuilderRegistry<any>} modelRegistry - The new implementation of Registry to use
+     * @return {void}
+     */
+    static setRegistry(modelRegistry: BuilderRegistry<any>): void;
+}
+/**
+ * @summary Bulk Registers Models
+ * @description Useful when using bundlers that might not evaluate all the code at once
+ *
+ * @template M extends Model
+ * @param {Array<Constructor<M>> | Array<{name: string, constructor: Constructor<M>}>} [models]
+ *
+ * @memberOf module:decorator-validation
+ * @category Model
+ */
+export declare function bulkModelRegister<M extends Model>(...models: (Constructor<M> | {
+    name: string;
+    constructor: Constructor<M>;
+})[]): void;

package/lib/types/model/ModelRegistry.d.mts

@@ -0,0 +1,181 @@
+import { Constructor } from "@decaf-ts/decoration";
+import { ModelBuilderFunction, ModelConstructor } from "./types.js";
+import { type Model } from "./Model.js";
+import { BuilderRegistry } from "../utils/registry.js";
+/**
+ * @description Registry type for storing and retrieving model constructors
+ * @summary The ModelRegistry type defines a registry for model constructors that extends
+ * the BuilderRegistry interface. It provides a standardized way to register, retrieve,
+ * and build model instances, enabling the model system to work with different types of models.
+ *
+ * @interface ModelRegistry
+ * @template T Type of model that can be registered, must extend Model
+ * @extends BuilderRegistry<T>
+ * @memberOf module:decorator-validation
+ * @category Model
+ */
+export type ModelRegistry<T extends Model> = BuilderRegistry<T>;
+/**
+ * @description Registry manager for model constructors that enables serialization and rebuilding
+ * @summary The ModelRegistryManager implements the ModelRegistry interface and provides
+ * functionality for registering, retrieving, and building model instances. It maintains
+ * a cache of model constructors indexed by name, allowing for efficient lookup and instantiation.
+ * This class is essential for the serialization and deserialization of model objects.
+ *
+ * @param {function(Record<string, any>): boolean} [testFunction] - Function to test if an object is a model, defaults to {@link Model#isModel}
+ *
+ * @class ModelRegistryManager
+ * @template M Type of model that can be registered, must extend Model
+ * @implements ModelRegistry<M>
+ * @category Model
+ *
+ * @example
+ * ```typescript
+ * // Create a model registry
+ * const registry = new ModelRegistryManager();
+ *
+ * // Register a model class
+ * registry.register(User);
+ *
+ * // Retrieve a model constructor by name
+ * const UserClass = registry.get("User");
+ *
+ * // Build a model instance from a plain object
+ * const userData = { name: "John", age: 30 };
+ * const user = registry.build(userData, "User");
+ * ```
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Client
+ *   participant R as ModelRegistryManager
+ *   participant M as Model Class
+ *
+ *   C->>R: new ModelRegistryManager(testFunction)
+ *   C->>R: register(ModelClass)
+ *   R->>R: Store in cache
+ *   C->>R: get("ModelName")
+ *   R-->>C: ModelClass constructor
+ *   C->>R: build(data, "ModelName")
+ *   R->>R: Get constructor from cache
+ *   R->>M: new ModelClass(data)
+ *   M-->>R: Model instance
+ *   R-->>C: Model instance
+ */
+export declare class ModelRegistryManager<M extends Model<true | false>> implements ModelRegistry<M> {
+    private cache;
+    private readonly testFunction;
+    constructor(testFunction?: (obj: Record<string, any>) => boolean);
+    /**
+     * @description Registers a model constructor with the registry
+     * @summary Adds a model constructor to the registry cache, making it available for
+     * later retrieval and instantiation. If no name is provided, the constructor's name
+     * property is used as the key in the registry.
+     *
+     * @param {ModelConstructor<M>} constructor - The model constructor to register
+     * @param {string} [name] - Optional name to register the constructor under, defaults to constructor.name
+     * @return {void}
+     * @throws {Error} If the constructor is not a function
+     */
+    register(constructor: ModelConstructor<M>, name?: string): void;
+    /**
+     * @summary Gets a registered Model {@link ModelConstructor}
+     * @param {string} name
+     */
+    get(name: string): ModelConstructor<M> | 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): M;
+    /**
+     * @description Configures the global model builder function
+     * @summary Sets the Global {@link ModelBuilderFunction} used for building model instances
+     *
+     * @param {ModelBuilderFunction} [builder] - The builder function to set as the global builder
+     * @return {void}
+     */
+    static setBuilder(builder?: ModelBuilderFunction): void;
+    /**
+     * @description Retrieves the currently configured global model builder function
+     * @summary Returns the current global {@link ModelBuilderFunction} used for building model instances
+     *
+     * @return {ModelBuilderFunction | undefined} - The current global builder function or undefined if not set
+     */
+    static getBuilder(): ModelBuilderFunction | undefined;
+    /**
+     * @description Copies and rebuilds properties from a source object to a model instance, handling nested models
+     * @summary Repopulates the instance with properties from the new Model Object, recursively rebuilding nested models
+     *
+     * @template T
+     * @param {T} self - The target model instance to update
+     * @param {T | Record<string, any>} [obj] - The source object containing properties to copy
+     * @return {T} - The updated model instance with rebuilt nested models
+     *
+     * @mermaid
+     * sequenceDiagram
+     *   participant C as Client
+     *   participant M as Model.fromModel
+     *   participant B as Model.build
+     *   participant R as Reflection
+     *
+     *   C->>M: fromModel(self, obj)
+     *   M->>M: Get attributes from self
+     *   loop For each property
+     *     M->>M: Copy property from obj to self
+     *     alt Property is a model
+     *       M->>M: Check if property is a model
+     *       M->>B: build(property, modelType)
+     *       B-->>M: Return built model
+     *     else Property is a complex type
+     *       M->>R: Get property decorators
+     *       R-->>M: Return decorators
+     *       M->>M: Filter type decorators
+     *       alt Property is Array/Set with list decorator
+     *         M->>M: Process each item in collection
+     *         loop For each item
+     *           M->>B: build(item, itemModelType)
+     *           B-->>M: Return built model
+     *         end
+     *       else Property is another model type
+     *         M->>B: build(property, propertyType)
+     *         B-->>M: Return built model
+     *       end
+     *     end
+     *   end
+     *   M-->>C: Return updated self
+     */
+    static fromModel<T extends Model>(self: T, obj?: T | Record<string, any>): T;
+    /**
+     * @description Provides access to the current model registry
+     * @summary Returns the current {@link ModelRegistryManager} instance, creating one if it doesn't exist
+     *
+     * @return {ModelRegistry<any>} - The current model registry, defaults to a new {@link ModelRegistryManager} if not set
+     * @private
+     */
+    static getRegistry(): BuilderRegistry<any>;
+    /**
+     * @description Configures the model registry to be used by the Model system
+     * @summary Sets the current model registry to a custom implementation
+     *
+     * @param {BuilderRegistry<any>} modelRegistry - The new implementation of Registry to use
+     * @return {void}
+     */
+    static setRegistry(modelRegistry: BuilderRegistry<any>): void;
+}
+/**
+ * @summary Bulk Registers Models
+ * @description Useful when using bundlers that might not evaluate all the code at once
+ *
+ * @template M extends Model
+ * @param {Array<Constructor<M>> | Array<{name: string, constructor: Constructor<M>}>} [models]
+ *
+ * @memberOf module:decorator-validation
+ * @category Model
+ */
+export declare function bulkModelRegister<M extends Model>(...models: (Constructor<M> | {
+    name: string;
+    constructor: Constructor<M>;
+})[]): void;

package/lib/types/model/constants.d.cts

@@ -0,0 +1,65 @@
+/**
+ * @description Enumeration of JavaScript primitive type identifiers used by the model system.
+ * @summary References the relevant JS primitives and standardizes their string representations across the library.
+ * @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
+ * @enum Primitives
+ * @readonly
+ * @memberOf module:decorator-validation
+ */
+export declare enum Primitives {
+    /** references the string primitive */
+    STRING = "string",
+    /** references the number primitive */
+    NUMBER = "number",
+    /** references the boolean primitive */
+    BOOLEAN = "boolean",
+    /** references the bigint primitive */
+    BIGINT = "bigint"
+}
+/**
+ * @description Reserved model names which are excluded from model rebuilding.
+ * @summary References the Reserved model names to ignore during Model rebuilding to avoid interfering with native types and special cases.
+ * @property {string} STRING
+ * @property {string} OBJECT
+ * @property {string} NUMBER
+ * @property {string} BOOLEAN
+ * @property {string} BIGINT
+ * @property {string} DATE
+ * @enum ReservedModels
+ * @readonly
+ * @memberOf module:decorator-validation
+ */
+export declare const ReservedModels: {
+    /** reserved name for string */
+    STRING: StringConstructor;
+    /** reserved name for object */
+    OBJECT: ObjectConstructor;
+    /** reserved name for number */
+    NUMBER: NumberConstructor;
+    /** reserved name for boolean */
+    BOOLEAN: BooleanConstructor;
+    /** reserved name for bigint */
+    BIGINT: BigIntConstructor;
+    /** reserved name for Date */
+    DATE: DateConstructor;
+};
+/**
+ * @description Basic supported JavaScript types used by the validation system.
+ * @summary References the basic supported JS types as strings that can be used for type checking and metadata.
+ * @typedef {Object} JsTypes
+ * @property {"string"} string String primitive identifier
+ * @property {"array"} array Array type identifier
+ * @property {"number"} number Number primitive identifier
+ * @property {"boolean"} boolean Boolean primitive identifier
+ * @property {"symbol"} symbol Symbol primitive identifier
+ * @property {"function"} function Function type identifier
+ * @property {"object"} object Object type identifier
+ * @property {"undefined"} undefined Undefined type identifier
+ * @property {"null"} null Null value identifier
+ * @property {"bigint"} BIGINT BigInt primitive identifier
+ * @memberOf module:decorator-validation
+ */
+export declare const jsTypes: string[];

package/lib/types/model/constants.d.mts

@@ -0,0 +1,65 @@
+/**
+ * @description Enumeration of JavaScript primitive type identifiers used by the model system.
+ * @summary References the relevant JS primitives and standardizes their string representations across the library.
+ * @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
+ * @enum Primitives
+ * @readonly
+ * @memberOf module:decorator-validation
+ */
+export declare enum Primitives {
+    /** references the string primitive */
+    STRING = "string",
+    /** references the number primitive */
+    NUMBER = "number",
+    /** references the boolean primitive */
+    BOOLEAN = "boolean",
+    /** references the bigint primitive */
+    BIGINT = "bigint"
+}
+/**
+ * @description Reserved model names which are excluded from model rebuilding.
+ * @summary References the Reserved model names to ignore during Model rebuilding to avoid interfering with native types and special cases.
+ * @property {string} STRING
+ * @property {string} OBJECT
+ * @property {string} NUMBER
+ * @property {string} BOOLEAN
+ * @property {string} BIGINT
+ * @property {string} DATE
+ * @enum ReservedModels
+ * @readonly
+ * @memberOf module:decorator-validation
+ */
+export declare const ReservedModels: {
+    /** reserved name for string */
+    STRING: StringConstructor;
+    /** reserved name for object */
+    OBJECT: ObjectConstructor;
+    /** reserved name for number */
+    NUMBER: NumberConstructor;
+    /** reserved name for boolean */
+    BOOLEAN: BooleanConstructor;
+    /** reserved name for bigint */
+    BIGINT: BigIntConstructor;
+    /** reserved name for Date */
+    DATE: DateConstructor;
+};
+/**
+ * @description Basic supported JavaScript types used by the validation system.
+ * @summary References the basic supported JS types as strings that can be used for type checking and metadata.
+ * @typedef {Object} JsTypes
+ * @property {"string"} string String primitive identifier
+ * @property {"array"} array Array type identifier
+ * @property {"number"} number Number primitive identifier
+ * @property {"boolean"} boolean Boolean primitive identifier
+ * @property {"symbol"} symbol Symbol primitive identifier
+ * @property {"function"} function Function type identifier
+ * @property {"object"} object Object type identifier
+ * @property {"undefined"} undefined Undefined type identifier
+ * @property {"null"} null Null value identifier
+ * @property {"bigint"} BIGINT BigInt primitive identifier
+ * @memberOf module:decorator-validation
+ */
+export declare const jsTypes: string[];

package/lib/types/model/construction.d.cts

@@ -0,0 +1,46 @@
+import { Model } from "./Model.cjs";
+/**
+ * @description Helper function to create an instance by invoking a constructor with dynamic arguments.
+ * @summary Overrides standard construction patterns by wrapping the given constructor to allow spread argument invocation while preserving the prototype chain.
+ * @template M the model instance type
+ * @param {any} constructor The constructor function to invoke.
+ * @param {...any[]} args Optional arguments to pass to the constructor.
+ * @return {M} The newly constructed instance.
+ * @function construct
+ * @memberOf module:decorator-validation
+ */
+export declare function construct<M extends Model>(constructor: any, ...args: any[]): M;
+/**
+ * @description Recursively finds the last prototype in the chain before reaching Object.prototype.
+ * @summary Walks up the prototype chain to locate the most derived prototype that still precedes the base Object prototype.
+ * @param {object} obj The object whose prototype chain will be inspected.
+ * @return {object} The last prototype before Object.prototype, or the input object if its prototype is Object.prototype.
+ * @function findLastProtoBeforeObject
+ * @memberOf module:decorator-validation
+ */
+export declare function findLastProtoBeforeObject(obj: object): object;
+/**
+ * @description Binds the Model class as the root prototype of the provided instance when not already a Model.
+ * @summary Ensures objects created outside of the Model inheritance chain gain Model as their ultimate prototype to access model utilities.
+ * @param {unknown} obj The object to bind to the Model prototype chain.
+ * @return {void}
+ * @function bindModelPrototype
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant Fn as bindModelPrototype
+ *   participant M as Model.prototype
+ *   Caller->>Fn: obj
+ *   alt obj instanceof Model
+ *     Fn-->>Caller: return
+ *   else obj chain ends at Object.prototype
+ *     Fn->>Fn: setPrototypeOf(obj, M)
+ *     Fn-->>Caller: return
+ *   else deep prototype chain
+ *     Fn->>Fn: walk prototypes
+ *     Fn->>Fn: setPrototypeOf(last, M)
+ *     Fn-->>Caller: return
+ *   end
+ * @memberOf module:decorator-validation
+ */
+export declare function bindModelPrototype(obj: unknown): void;

package/lib/types/model/construction.d.mts

@@ -0,0 +1,46 @@
+import { Model } from "./Model.js";
+/**
+ * @description Helper function to create an instance by invoking a constructor with dynamic arguments.
+ * @summary Overrides standard construction patterns by wrapping the given constructor to allow spread argument invocation while preserving the prototype chain.
+ * @template M the model instance type
+ * @param {any} constructor The constructor function to invoke.
+ * @param {...any[]} args Optional arguments to pass to the constructor.
+ * @return {M} The newly constructed instance.
+ * @function construct
+ * @memberOf module:decorator-validation
+ */
+export declare function construct<M extends Model>(constructor: any, ...args: any[]): M;
+/**
+ * @description Recursively finds the last prototype in the chain before reaching Object.prototype.
+ * @summary Walks up the prototype chain to locate the most derived prototype that still precedes the base Object prototype.
+ * @param {object} obj The object whose prototype chain will be inspected.
+ * @return {object} The last prototype before Object.prototype, or the input object if its prototype is Object.prototype.
+ * @function findLastProtoBeforeObject
+ * @memberOf module:decorator-validation
+ */
+export declare function findLastProtoBeforeObject(obj: object): object;
+/**
+ * @description Binds the Model class as the root prototype of the provided instance when not already a Model.
+ * @summary Ensures objects created outside of the Model inheritance chain gain Model as their ultimate prototype to access model utilities.
+ * @param {unknown} obj The object to bind to the Model prototype chain.
+ * @return {void}
+ * @function bindModelPrototype
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant Fn as bindModelPrototype
+ *   participant M as Model.prototype
+ *   Caller->>Fn: obj
+ *   alt obj instanceof Model
+ *     Fn-->>Caller: return
+ *   else obj chain ends at Object.prototype
+ *     Fn->>Fn: setPrototypeOf(obj, M)
+ *     Fn-->>Caller: return
+ *   else deep prototype chain
+ *     Fn->>Fn: walk prototypes
+ *     Fn->>Fn: setPrototypeOf(last, M)
+ *     Fn-->>Caller: return
+ *   end
+ * @memberOf module:decorator-validation
+ */
+export declare function bindModelPrototype(obj: unknown): void;

package/lib/types/model/decorators.d.cts

@@ -0,0 +1,47 @@
+/**
+ * @description Base decorator for model classes.
+ * @summary This decorator wraps the original constructor to bind the Model prototype, run a builder function, and register the model.
+ * @param {any} original The original constructor of the class.
+ * @return {any} The new constructor with added model functionality.
+ * @function modelBaseDecorator
+ * @memberOf module:decorator-validation
+ */
+export declare function modelBaseDecorator(original: any): any;
+/**
+ * @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;
+ *
+ * @function model
+ *
+ * @category Class Decorators
+ */
+export declare function model(): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
+/**
+ * @summary Defines the hashing algorithm to use on the model
+ * @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;
+ *
+ * @param {string} algorithm the algorithm to use
+ *
+ * @function hashedBy
+ *
+ * @category Class Decorators
+ */
+export declare function hashedBy(algorithm: string, ...args: any[]): (model: any, prop?: any, descriptor?: PropertyDescriptor | number) => void;
+/**
+ * @summary Defines the serialization algorithm to use on the model
+ *
+ * @param {string} serializer the algorithm to use
+ *
+ * @function serializedBy
+ *
+ * @category Class Decorators
+ */
+export declare function serializedBy(serializer: string, ...args: any[]): (model: any, prop?: any, descriptor?: PropertyDescriptor | number) => void;