@decaf-ts/decorator-validation 1.14.0 → 1.16.0

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

@@ -0,0 +1,86 @@
+import { Model } from "./Model.js";
+import { ObjectAccumulator } from "typed-object-accumulator";
+import { Constructor } from "@decaf-ts/decoration";
+import { ComparisonValidatorOptions } from "../validation/types.js";
+import { ExtendedMetadata } from "../overrides/types.js";
+type BuildableModel = Model & Record<PropertyKey, any>;
+export interface DecorateOption<M extends Model> {
+    decorate(...decorators: PropertyDecorator[]): ModelBuilder<M>;
+}
+export declare class AttributeBuilder<M extends BuildableModel, N extends keyof M, T> implements DecorateOption<M> {
+    protected parent: ModelBuilder<M>;
+    readonly attr: N;
+    readonly declaredType: T;
+    constructor(parent: ModelBuilder<M>, attr: N, declaredType: T);
+    private decorators;
+    decorate(...decorators: PropertyDecorator[]): ModelBuilder<M>;
+    undecorate(...decorators: PropertyDecorator[]): ModelBuilder<M>;
+    required(messageOrMeta?: string | Record<string, any>): ModelBuilder<M>;
+    min(valueOrMeta: number | Date | string | Record<string, any>, message?: string): ModelBuilder<M>;
+    max(valueOrMeta: number | Date | string | Record<string, any>, message?: string): ModelBuilder<M>;
+    step(valueOrMeta: number | Record<string, any>, message?: string): ModelBuilder<M>;
+    minlength(valueOrMeta: number | Record<string, any>, message?: string): ModelBuilder<M>;
+    maxlength(valueOrMeta: number | Record<string, any>, message?: string): ModelBuilder<M>;
+    pattern(valueOrMeta: RegExp | string | Record<string, any>, message?: string): ModelBuilder<M>;
+    email(messageOrMeta?: string | Record<string, any>): ModelBuilder<M>;
+    url(messageOrMeta?: string | Record<string, any>): ModelBuilder<M>;
+    type(valueOrMeta: Constructor | (() => Constructor) | (Constructor | (() => Constructor))[] | Record<string, any>, message?: string): ModelBuilder<M>;
+    date(formatOrMeta?: string | Record<string, any>, message?: string): ModelBuilder<M>;
+    password(valueOrMeta?: RegExp | string | Record<string, any>, message?: string): ModelBuilder<M>;
+    list(clazzOrMeta: Constructor | (() => Constructor) | (Constructor | (() => Constructor))[] | Record<string, any>, collection?: "Array" | "Set", message?: string): ModelBuilder<M>;
+    set(clazzOrMeta: Constructor | Record<string, any>, message?: string): ModelBuilder<M>;
+    enum(valueOrMeta: any[] | Record<any, any> | Record<string, any>, message?: string): ModelBuilder<M>;
+    option(value: any[] | Record<any, any>, message?: string): ModelBuilder<M>;
+    private static isMetadataPayload;
+    private static asMeta;
+    private static resolveMessage;
+    private static patternFromString;
+    private resolveComparison;
+    equals(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    eq(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    different(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    diff(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    lessThan(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    lt(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    lessThanOrEqual(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    lte(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    greaterThan(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    gt(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    greaterThanOrEqual(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    gte(propertyOrMeta: string | Record<string, any>, options?: Omit<ComparisonValidatorOptions, "async" | "description">): ModelBuilder<M>;
+    description(desc: string): ModelBuilder<M>;
+    /**
+     * Applies the attribute metadata and decorators to the provided constructor.
+     */
+    build(constructor: Constructor<M>): void;
+}
+declare class ListAttributeBuilder<M extends BuildableModel, N extends keyof M> {
+    private readonly parent;
+    private readonly attribute;
+    private readonly collection;
+    constructor(parent: ModelBuilder<M>, attribute: AttributeBuilder<M, N, any>, collection: "Array" | "Set");
+    ofPrimitives(clazz: Constructor | (() => Constructor) | (Constructor | (() => Constructor))[], message?: string): ModelBuilder<M>;
+    ofModel<MM extends BuildableModel>(): ModelBuilder<MM>;
+}
+export declare class ModelBuilder<M extends BuildableModel = BuildableModel> extends ObjectAccumulator<M> {
+    private attributes;
+    private _name?;
+    private _description?;
+    private _classDecorators;
+    private _parent?;
+    setName(name: string): this;
+    description(desc: string): this;
+    decorateClass(decorator: ClassDecorator): this;
+    private attribute;
+    string<N extends keyof M>(attr: N): AttributeBuilder<M, N, StringConstructor>;
+    number<N extends keyof M>(attr: N): AttributeBuilder<M, N, NumberConstructor>;
+    date<N extends keyof M>(attr: N): AttributeBuilder<M, N, DateConstructor>;
+    bigint<N extends keyof M>(attr: N): AttributeBuilder<M, N, BigIntConstructor>;
+    instance<N extends keyof M>(clazz: Constructor<any>, attr: N): AttributeBuilder<M, N, Constructor<any>>;
+    model<MM extends Model, N extends keyof M>(attr: N): ModelBuilder<MM>;
+    listOf<N extends keyof M>(attr: N, collection?: "Array" | "Set"): ListAttributeBuilder<M, N>;
+    build(): Constructor<M>;
+    static builder<M extends BuildableModel = BuildableModel>(): ModelBuilder<M>;
+    static from<N extends Model, M extends ExtendedMetadata<N>>(meta: M, name?: string): Constructor<N>;
+}
+export {};

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

@@ -0,0 +1,286 @@
+import { BuilderRegistry } from "../utils/registry.cjs";
+import { ModelErrorDefinition } from "./ModelErrorDefinition.cjs";
+import { Comparable, Comparison, Hashable, ModelArg, ModelBuilderFunction, ModelConstructor, Serializable, Validatable } from "./types.cjs";
+import { ConditionalAsync } from "../types/index.cjs";
+import { Constructor } from "@decaf-ts/decoration";
+/**
+ * @summary Abstract class representing a Validatable Model object
+ * @description Meant to be used as a base class for all Model classes
+ *
+ * Model objects must:
+ *  - Have all their required properties marked with '!';
+ *  - Have all their optional properties marked as '?':
+ *
+ * @param {ModelArg<Model>} model base object from which to populate properties from
+ *
+ * @class Model
+ * @category Model
+ * @abstract
+ * @implements Validatable
+ * @implements Serializable
+ *
+ * @example
+ *      class ClassName {
+ *          @required()
+ *          requiredPropertyName!: PropertyType;
+ *
+ *          optionalPropertyName?: PropertyType;
+ *      }
+ */
+export declare abstract class Model<Async extends boolean = false> implements Validatable<Async>, Serializable, Hashable, Comparable {
+    protected constructor(arg?: ModelArg<Model> | undefined);
+    isAsync(): boolean;
+    /**
+     * @description Validates the model object against its defined validation rules
+     * @summary Validates the object according to its decorated properties, returning any validation errors
+     *
+     * @param {any[]} [exceptions] - Properties in the object to be ignored for the validation. Marked as 'any' to allow for extension but expects strings
+     * @return {ModelErrorDefinition | undefined} - Returns a ModelErrorDefinition object if validation errors exist, otherwise undefined
+     */
+    hasErrors(...exceptions: any[]): ConditionalAsync<Async, ModelErrorDefinition | undefined>;
+    /**
+     * @description Determines if this model is equal to another object
+     * @summary Compare object equality recursively, checking all properties unless excluded
+     *
+     * @param {any} obj - Object to compare to
+     * @param {string[]} [exceptions] - Property names to be excluded from the comparison
+     * @return {boolean} - True if objects are equal, false otherwise
+     */
+    equals(obj: any, ...exceptions: string[]): boolean;
+    compare<M extends Model>(this: M, other: M, ...exceptions: (keyof M)[]): Comparison<M> | undefined;
+    /**
+     * @description Converts the model to a serialized string representation
+     * @summary Returns the serialized model according to the currently defined {@link Serializer}
+     *
+     * @return {string} - The serialized string representation of the model
+     */
+    serialize(): string;
+    /**
+     * @description Provides a human-readable string representation of the model
+     * @summary Override the implementation for js's 'toString()' to provide a more useful representation
+     *
+     * @return {string} - A string representation of the model including its class name and JSON representation
+     * @override
+     */
+    toString(): string;
+    /**
+     * @description Generates a hash string for the model object
+     * @summary Defines a default implementation for object hash, relying on a basic implementation based on Java's string hash
+     *
+     * @return {string} - A hash string representing the model
+     */
+    hash(): string;
+    /**
+     * @description Converts a serialized string back into a model instance
+     * @summary Deserializes a Model from its string representation
+     *
+     * @param {string} str - The serialized string to convert back to a model
+     * @return {any} - The deserialized model instance
+     * @throws {Error} If it fails to parse the string, or if it fails to build the model
+     */
+    static deserialize(str: string): any;
+    /**
+     * @description Copies properties from a source object to a model instance
+     * @summary Repopulates the Object properties with the ones from the new object
+     *
+     * @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
+     */
+    static fromObject<T extends Model<any>>(self: T, obj?: T | Record<string, any>): T;
+    /**
+     * @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 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 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
+     */
+    private static getRegistry;
+    /**
+     * @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;
+    /**
+     * @description Registers a model constructor with the model registry
+     * @summary Registers new model classes to make them available for serialization and deserialization
+     *
+     * @template T
+     * @param {ModelConstructor<T>} constructor - The model constructor to register
+     * @param {string} [name] - Optional name to register the constructor under, defaults to constructor.name
+     * @return {void}
+     *
+     * @see ModelRegistry
+     */
+    static register<T extends Model>(constructor: ModelConstructor<T>, name?: string): void;
+    /**
+     * @description Retrieves a registered model constructor by name
+     * @summary Gets a registered Model {@link ModelConstructor} from the model registry
+     *
+     * @template T
+     * @param {string} name - The name of the model constructor to retrieve
+     * @return {ModelConstructor<T> | undefined} - The model constructor if found, undefined otherwise
+     *
+     * @see ModelRegistry
+     */
+    static get<T extends Model>(name: string): ModelConstructor<T> | undefined;
+    /**
+     * @description Creates a model instance from a plain object
+     * @summary Builds a model instance using the model registry, optionally specifying the model class
+     *
+     * @template T
+     * @param {Record<string, any>} obj - The source object to build the model from
+     * @param {string} [clazz] - When provided, it will attempt to find the matching constructor by name
+     * @return {T} - The built model instance
+     * @throws {Error} If clazz is not found, or obj is not a {@link Model} meaning it has no {@link ModelKeys.ANCHOR} property
+     *
+     * @see ModelRegistry
+     */
+    static build<T extends Model>(obj?: Record<string, any>, clazz?: string): T;
+    /**
+     * @description Retrieves all attribute names from a model class or instance
+     * @summary Gets all attributes defined in a model, traversing the prototype chain to include inherited attributes
+     *
+     * @template V
+     * @param {Constructor<V> | V} model - The model class or instance to get attributes from
+     * @return {string[]} - Array of attribute names defined in the model
+     */
+    static getAttributes<V extends Model>(model: Constructor<V> | V): string[];
+    /**
+     * @description Compares two model instances for equality
+     * @summary Determines if two model instances are equal by comparing their properties
+     *
+     * @template M
+     * @param {M} obj1 - First model instance to compare
+     * @param {M} obj2 - Second model instance to compare
+     * @param {any[]} [exceptions] - Property names to exclude from comparison
+     * @return {boolean} - True if the models are equal, false otherwise
+     */
+    static equals<M extends Model>(obj1: M, obj2: M, ...exceptions: any[]): boolean;
+    /**
+     * @description Validates a model instance against its validation rules
+     * @summary Checks if a model has validation errors, optionally ignoring specified properties
+     *
+     * @template M
+     * @param {M} model - The model instance to validate
+     * @param {boolean} async - A flag indicating whether validation should be asynchronous.
+     * @param {string[]} [propsToIgnore] - Properties to exclude from validation
+     * @return {ModelErrorDefinition | undefined} - Returns validation errors if any, otherwise undefined
+     */
+    static hasErrors<M extends Model, Async extends boolean = false>(model: M, async: Async, ...propsToIgnore: string[]): ConditionalAsync<Async, ModelErrorDefinition | undefined>;
+    /**
+     * @description Converts a model instance to a serialized string
+     * @summary Serializes a model instance using the configured serializer or the default one
+     *
+     * @template M
+     * @param {M} model - The model instance to serialize
+     * @return {string} - The serialized string representation of the model
+     */
+    static serialize<M extends Model<boolean>>(model: M): any;
+    /**
+     * @description Generates a hash string for a model instance
+     * @summary Creates a hash representation of a model using the configured algorithm or the default one
+     *
+     * @template M
+     * @param {M} model - The model instance to hash
+     * @return {string} - The hash string representing the model
+     */
+    static hash<M extends Model<boolean>>(model: M): any;
+    /**
+     * @description Determines if an object is a model instance or has model metadata
+     * @summary Checks whether a given object is either an instance of the Model class or
+     * has model metadata attached to it. This function is essential for serialization and
+     * deserialization processes, as it helps identify model objects that need special handling.
+     * It safely handles potential errors during metadata retrieval.
+     *
+     * @param {Record<string, any>} target - The object to check
+     * @return {boolean} True if the object is a model instance or has model metadata, false otherwise
+     *
+     * @example
+     * ```typescript
+     * // Check if an object is a model
+     * const user = new User({ name: "John" });
+     * const isUserModel = isModel(user); // true
+     *
+     * // Check a plain object
+     * const plainObject = { name: "John" };
+     * const isPlainObjectModel = isModel(plainObject); // false
+     * ```
+     */
+    static isModel(target: Record<string, any>): boolean;
+    /**
+     * @description Checks if a property of a model is itself a model or has a model type
+     * @summary Determines whether a specific property of a model instance is either a model instance
+     * or has a type that is registered as a model
+     *
+     * @template M
+     * @param {M} target - The model instance to check
+     * @param {string} attribute - The property name to check
+     * @return {boolean | string | undefined} - Returns true if the property is a model instance,
+     * the model name if the property has a model type, or undefined if not a model
+     */
+    static isPropertyModel<M extends Model>(target: M, attribute: string): boolean | string | undefined;
+    static describe<M extends Model>(model: Constructor<M>, key?: keyof M): string | undefined;
+}

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

@@ -0,0 +1,286 @@
+import { BuilderRegistry } from "../utils/registry.js";
+import { ModelErrorDefinition } from "./ModelErrorDefinition.js";
+import { Comparable, Comparison, Hashable, ModelArg, ModelBuilderFunction, ModelConstructor, Serializable, Validatable } from "./types.js";
+import { ConditionalAsync } from "../types/index.js";
+import { Constructor } from "@decaf-ts/decoration";
+/**
+ * @summary Abstract class representing a Validatable Model object
+ * @description Meant to be used as a base class for all Model classes
+ *
+ * Model objects must:
+ *  - Have all their required properties marked with '!';
+ *  - Have all their optional properties marked as '?':
+ *
+ * @param {ModelArg<Model>} model base object from which to populate properties from
+ *
+ * @class Model
+ * @category Model
+ * @abstract
+ * @implements Validatable
+ * @implements Serializable
+ *
+ * @example
+ *      class ClassName {
+ *          @required()
+ *          requiredPropertyName!: PropertyType;
+ *
+ *          optionalPropertyName?: PropertyType;
+ *      }
+ */
+export declare abstract class Model<Async extends boolean = false> implements Validatable<Async>, Serializable, Hashable, Comparable {
+    protected constructor(arg?: ModelArg<Model> | undefined);
+    isAsync(): boolean;
+    /**
+     * @description Validates the model object against its defined validation rules
+     * @summary Validates the object according to its decorated properties, returning any validation errors
+     *
+     * @param {any[]} [exceptions] - Properties in the object to be ignored for the validation. Marked as 'any' to allow for extension but expects strings
+     * @return {ModelErrorDefinition | undefined} - Returns a ModelErrorDefinition object if validation errors exist, otherwise undefined
+     */
+    hasErrors(...exceptions: any[]): ConditionalAsync<Async, ModelErrorDefinition | undefined>;
+    /**
+     * @description Determines if this model is equal to another object
+     * @summary Compare object equality recursively, checking all properties unless excluded
+     *
+     * @param {any} obj - Object to compare to
+     * @param {string[]} [exceptions] - Property names to be excluded from the comparison
+     * @return {boolean} - True if objects are equal, false otherwise
+     */
+    equals(obj: any, ...exceptions: string[]): boolean;
+    compare<M extends Model>(this: M, other: M, ...exceptions: (keyof M)[]): Comparison<M> | undefined;
+    /**
+     * @description Converts the model to a serialized string representation
+     * @summary Returns the serialized model according to the currently defined {@link Serializer}
+     *
+     * @return {string} - The serialized string representation of the model
+     */
+    serialize(): string;
+    /**
+     * @description Provides a human-readable string representation of the model
+     * @summary Override the implementation for js's 'toString()' to provide a more useful representation
+     *
+     * @return {string} - A string representation of the model including its class name and JSON representation
+     * @override
+     */
+    toString(): string;
+    /**
+     * @description Generates a hash string for the model object
+     * @summary Defines a default implementation for object hash, relying on a basic implementation based on Java's string hash
+     *
+     * @return {string} - A hash string representing the model
+     */
+    hash(): string;
+    /**
+     * @description Converts a serialized string back into a model instance
+     * @summary Deserializes a Model from its string representation
+     *
+     * @param {string} str - The serialized string to convert back to a model
+     * @return {any} - The deserialized model instance
+     * @throws {Error} If it fails to parse the string, or if it fails to build the model
+     */
+    static deserialize(str: string): any;
+    /**
+     * @description Copies properties from a source object to a model instance
+     * @summary Repopulates the Object properties with the ones from the new object
+     *
+     * @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
+     */
+    static fromObject<T extends Model<any>>(self: T, obj?: T | Record<string, any>): T;
+    /**
+     * @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 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 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
+     */
+    private static getRegistry;
+    /**
+     * @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;
+    /**
+     * @description Registers a model constructor with the model registry
+     * @summary Registers new model classes to make them available for serialization and deserialization
+     *
+     * @template T
+     * @param {ModelConstructor<T>} constructor - The model constructor to register
+     * @param {string} [name] - Optional name to register the constructor under, defaults to constructor.name
+     * @return {void}
+     *
+     * @see ModelRegistry
+     */
+    static register<T extends Model>(constructor: ModelConstructor<T>, name?: string): void;
+    /**
+     * @description Retrieves a registered model constructor by name
+     * @summary Gets a registered Model {@link ModelConstructor} from the model registry
+     *
+     * @template T
+     * @param {string} name - The name of the model constructor to retrieve
+     * @return {ModelConstructor<T> | undefined} - The model constructor if found, undefined otherwise
+     *
+     * @see ModelRegistry
+     */
+    static get<T extends Model>(name: string): ModelConstructor<T> | undefined;
+    /**
+     * @description Creates a model instance from a plain object
+     * @summary Builds a model instance using the model registry, optionally specifying the model class
+     *
+     * @template T
+     * @param {Record<string, any>} obj - The source object to build the model from
+     * @param {string} [clazz] - When provided, it will attempt to find the matching constructor by name
+     * @return {T} - The built model instance
+     * @throws {Error} If clazz is not found, or obj is not a {@link Model} meaning it has no {@link ModelKeys.ANCHOR} property
+     *
+     * @see ModelRegistry
+     */
+    static build<T extends Model>(obj?: Record<string, any>, clazz?: string): T;
+    /**
+     * @description Retrieves all attribute names from a model class or instance
+     * @summary Gets all attributes defined in a model, traversing the prototype chain to include inherited attributes
+     *
+     * @template V
+     * @param {Constructor<V> | V} model - The model class or instance to get attributes from
+     * @return {string[]} - Array of attribute names defined in the model
+     */
+    static getAttributes<V extends Model>(model: Constructor<V> | V): string[];
+    /**
+     * @description Compares two model instances for equality
+     * @summary Determines if two model instances are equal by comparing their properties
+     *
+     * @template M
+     * @param {M} obj1 - First model instance to compare
+     * @param {M} obj2 - Second model instance to compare
+     * @param {any[]} [exceptions] - Property names to exclude from comparison
+     * @return {boolean} - True if the models are equal, false otherwise
+     */
+    static equals<M extends Model>(obj1: M, obj2: M, ...exceptions: any[]): boolean;
+    /**
+     * @description Validates a model instance against its validation rules
+     * @summary Checks if a model has validation errors, optionally ignoring specified properties
+     *
+     * @template M
+     * @param {M} model - The model instance to validate
+     * @param {boolean} async - A flag indicating whether validation should be asynchronous.
+     * @param {string[]} [propsToIgnore] - Properties to exclude from validation
+     * @return {ModelErrorDefinition | undefined} - Returns validation errors if any, otherwise undefined
+     */
+    static hasErrors<M extends Model, Async extends boolean = false>(model: M, async: Async, ...propsToIgnore: string[]): ConditionalAsync<Async, ModelErrorDefinition | undefined>;
+    /**
+     * @description Converts a model instance to a serialized string
+     * @summary Serializes a model instance using the configured serializer or the default one
+     *
+     * @template M
+     * @param {M} model - The model instance to serialize
+     * @return {string} - The serialized string representation of the model
+     */
+    static serialize<M extends Model<boolean>>(model: M): any;
+    /**
+     * @description Generates a hash string for a model instance
+     * @summary Creates a hash representation of a model using the configured algorithm or the default one
+     *
+     * @template M
+     * @param {M} model - The model instance to hash
+     * @return {string} - The hash string representing the model
+     */
+    static hash<M extends Model<boolean>>(model: M): any;
+    /**
+     * @description Determines if an object is a model instance or has model metadata
+     * @summary Checks whether a given object is either an instance of the Model class or
+     * has model metadata attached to it. This function is essential for serialization and
+     * deserialization processes, as it helps identify model objects that need special handling.
+     * It safely handles potential errors during metadata retrieval.
+     *
+     * @param {Record<string, any>} target - The object to check
+     * @return {boolean} True if the object is a model instance or has model metadata, false otherwise
+     *
+     * @example
+     * ```typescript
+     * // Check if an object is a model
+     * const user = new User({ name: "John" });
+     * const isUserModel = isModel(user); // true
+     *
+     * // Check a plain object
+     * const plainObject = { name: "John" };
+     * const isPlainObjectModel = isModel(plainObject); // false
+     * ```
+     */
+    static isModel(target: Record<string, any>): boolean;
+    /**
+     * @description Checks if a property of a model is itself a model or has a model type
+     * @summary Determines whether a specific property of a model instance is either a model instance
+     * or has a type that is registered as a model
+     *
+     * @template M
+     * @param {M} target - The model instance to check
+     * @param {string} attribute - The property name to check
+     * @return {boolean | string | undefined} - Returns true if the property is a model instance,
+     * the model name if the property has a model type, or undefined if not a model
+     */
+    static isPropertyModel<M extends Model>(target: M, attribute: string): boolean | string | undefined;
+    static describe<M extends Model>(model: Constructor<M>, key?: keyof M): string | undefined;
+}