@decaf-ts/decorator-validation 1.7.1 → 1.7.2

package/lib/constants/validation.cjs

@@ -2,13 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VALIDATION_PARENT_KEY = void 0;
 /**
- * Symbol used to internally track the parent object during nested validation.
+ * @description Symbol key for tracking parent-child relationships in validation
+ * @summary Symbol used to internally track the parent object during nested validation
  *
- * This key is attached to child objects to provide context about their parent
- * in the object hierarchy, enabling validations that depend on parent values.
- *
- * @constant VALIDATION_PARENT_KEY
- * @memberOf module:decorator-validation.Model
+ * @const VALIDATION_PARENT_KEY
+ * @memberOf module:decorator-validation
  */
-exports.VALIDATION_PARENT_KEY = Symbol("_validationParentRef");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb25zdGFudHMvdmFsaWRhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7Ozs7Ozs7R0FRRztBQUNVLFFBQUEscUJBQXFCLEdBQUcsTUFBTSxDQUFDLHNCQUFzQixDQUFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIFN5bWJvbCB1c2VkIHRvIGludGVybmFsbHkgdHJhY2sgdGhlIHBhcmVudCBvYmplY3QgZHVyaW5nIG5lc3RlZCB2YWxpZGF0aW9uLlxuICpcbiAqIFRoaXMga2V5IGlzIGF0dGFjaGVkIHRvIGNoaWxkIG9iamVjdHMgdG8gcHJvdmlkZSBjb250ZXh0IGFib3V0IHRoZWlyIHBhcmVudFxuICogaW4gdGhlIG9iamVjdCBoaWVyYXJjaHksIGVuYWJsaW5nIHZhbGlkYXRpb25zIHRoYXQgZGVwZW5kIG9uIHBhcmVudCB2YWx1ZXMuXG4gKlxuICogQGNvbnN0YW50IFZBTElEQVRJT05fUEFSRU5UX0tFWVxuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0b3ItdmFsaWRhdGlvbi5Nb2RlbFxuICovXG5leHBvcnQgY29uc3QgVkFMSURBVElPTl9QQVJFTlRfS0VZID0gU3ltYm9sKFwiX3ZhbGlkYXRpb25QYXJlbnRSZWZcIik7XG4iXX0=
+exports.VALIDATION_PARENT_KEY = Symbol("_parent");
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb25zdGFudHMvdmFsaWRhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7Ozs7O0dBTUc7QUFDVSxRQUFBLHFCQUFxQixHQUFHLE1BQU0sQ0FBQyxTQUFTLENBQUMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQGRlc2NyaXB0aW9uIFN5bWJvbCBrZXkgZm9yIHRyYWNraW5nIHBhcmVudC1jaGlsZCByZWxhdGlvbnNoaXBzIGluIHZhbGlkYXRpb25cbiAqIEBzdW1tYXJ5IFN5bWJvbCB1c2VkIHRvIGludGVybmFsbHkgdHJhY2sgdGhlIHBhcmVudCBvYmplY3QgZHVyaW5nIG5lc3RlZCB2YWxpZGF0aW9uXG4gKlxuICogQGNvbnN0IFZBTElEQVRJT05fUEFSRU5UX0tFWVxuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0b3ItdmFsaWRhdGlvblxuICovXG5leHBvcnQgY29uc3QgVkFMSURBVElPTl9QQVJFTlRfS0VZID0gU3ltYm9sKFwiX3BhcmVudFwiKTtcbiJdfQ==

package/lib/constants/validation.d.ts

@@ -1,10 +1,8 @@
 /**
- * Symbol used to internally track the parent object during nested validation.
+ * @description Symbol key for tracking parent-child relationships in validation
+ * @summary Symbol used to internally track the parent object during nested validation
  *
- * This key is attached to child objects to provide context about their parent
- * in the object hierarchy, enabling validations that depend on parent values.
- *
- * @constant VALIDATION_PARENT_KEY
- * @memberOf module:decorator-validation.Model
+ * @const VALIDATION_PARENT_KEY
+ * @memberOf module:decorator-validation
  */
 export declare const VALIDATION_PARENT_KEY: unique symbol;

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

@@ -1,10 +1,8 @@
 /**
- * Symbol used to internally track the parent object during nested validation.
+ * @description Symbol key for tracking parent-child relationships in validation
+ * @summary Symbol used to internally track the parent object during nested validation
  *
- * This key is attached to child objects to provide context about their parent
- * in the object hierarchy, enabling validations that depend on parent values.
- *
- * @constant VALIDATION_PARENT_KEY
- * @memberOf module:decorator-validation.Model
+ * @const VALIDATION_PARENT_KEY
+ * @memberOf module:decorator-validation
  */
 export declare const VALIDATION_PARENT_KEY: unique symbol;

package/lib/esm/constants/validation.js

@@ -1,11 +1,9 @@
 /**
- * Symbol used to internally track the parent object during nested validation.
+ * @description Symbol key for tracking parent-child relationships in validation
+ * @summary Symbol used to internally track the parent object during nested validation
  *
- * This key is attached to child objects to provide context about their parent
- * in the object hierarchy, enabling validations that depend on parent values.
- *
- * @constant VALIDATION_PARENT_KEY
- * @memberOf module:decorator-validation.Model
+ * @const VALIDATION_PARENT_KEY
+ * @memberOf module:decorator-validation
  */
-export const VALIDATION_PARENT_KEY = Symbol("_validationParentRef");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb25zdGFudHMvdmFsaWRhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sQ0FBQyxNQUFNLHFCQUFxQixHQUFHLE1BQU0sQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBTeW1ib2wgdXNlZCB0byBpbnRlcm5hbGx5IHRyYWNrIHRoZSBwYXJlbnQgb2JqZWN0IGR1cmluZyBuZXN0ZWQgdmFsaWRhdGlvbi5cbiAqXG4gKiBUaGlzIGtleSBpcyBhdHRhY2hlZCB0byBjaGlsZCBvYmplY3RzIHRvIHByb3ZpZGUgY29udGV4dCBhYm91dCB0aGVpciBwYXJlbnRcbiAqIGluIHRoZSBvYmplY3QgaGllcmFyY2h5LCBlbmFibGluZyB2YWxpZGF0aW9ucyB0aGF0IGRlcGVuZCBvbiBwYXJlbnQgdmFsdWVzLlxuICpcbiAqIEBjb25zdGFudCBWQUxJREFUSU9OX1BBUkVOVF9LRVlcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdG9yLXZhbGlkYXRpb24uTW9kZWxcbiAqL1xuZXhwb3J0IGNvbnN0IFZBTElEQVRJT05fUEFSRU5UX0tFWSA9IFN5bWJvbChcIl92YWxpZGF0aW9uUGFyZW50UmVmXCIpO1xuIl19
+export const VALIDATION_PARENT_KEY = Symbol("_parent");
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb25zdGFudHMvdmFsaWRhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7O0dBTUc7QUFDSCxNQUFNLENBQUMsTUFBTSxxQkFBcUIsR0FBRyxNQUFNLENBQUMsU0FBUyxDQUFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBkZXNjcmlwdGlvbiBTeW1ib2wga2V5IGZvciB0cmFja2luZyBwYXJlbnQtY2hpbGQgcmVsYXRpb25zaGlwcyBpbiB2YWxpZGF0aW9uXG4gKiBAc3VtbWFyeSBTeW1ib2wgdXNlZCB0byBpbnRlcm5hbGx5IHRyYWNrIHRoZSBwYXJlbnQgb2JqZWN0IGR1cmluZyBuZXN0ZWQgdmFsaWRhdGlvblxuICpcbiAqIEBjb25zdCBWQUxJREFUSU9OX1BBUkVOVF9LRVlcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdG9yLXZhbGlkYXRpb25cbiAqL1xuZXhwb3J0IGNvbnN0IFZBTElEQVRJT05fUEFSRU5UX0tFWSA9IFN5bWJvbChcIl9wYXJlbnRcIik7XG4iXX0=

package/lib/esm/index.d.ts

@@ -5,7 +5,14 @@
  * It exposes utility functions, validation decorators, and model-related functionality for
  * implementing type-safe, declarative validation in TypeScript applications.
  */
+export * from "./constants";
 export * from "./utils";
 export * from "./validation";
 export * from "./model";
-export declare const VERSION = "1.7.1";
+/**
+ * @description Current version of the reflection package
+ * @summary Stores the semantic version number of the package
+ * @const VERSION
+ * @memberOf module:decorator-validation
+ */
+export declare const VERSION = "1.7.2";

package/lib/esm/index.js

@@ -5,8 +5,15 @@
  * It exposes utility functions, validation decorators, and model-related functionality for
  * implementing type-safe, declarative validation in TypeScript applications.
  */
+export * from "./constants";
 export * from "./utils";
 export * from "./validation";
 export * from "./model";
-export const VERSION = "1.7.1";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7OztHQU1HO0FBQ0gsY0FBYyxTQUFTLENBQUM7QUFDeEIsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxTQUFTLENBQUM7QUFFeEIsTUFBTSxDQUFDLE1BQU0sT0FBTyxHQUFHLGFBQWEsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQG1vZHVsZSBkZWNvcmF0b3ItdmFsaWRhdGlvblxuICogQGRlc2NyaXB0aW9uIFR5cGVTY3JpcHQgZGVjb3JhdG9yLWJhc2VkIHZhbGlkYXRpb24gbGlicmFyeVxuICogQHN1bW1hcnkgVGhpcyBtb2R1bGUgcHJvdmlkZXMgYSBjb21wcmVoZW5zaXZlIHZhbGlkYXRpb24gZnJhbWV3b3JrIHVzaW5nIFR5cGVTY3JpcHQgZGVjb3JhdG9ycy5cbiAqIEl0IGV4cG9zZXMgdXRpbGl0eSBmdW5jdGlvbnMsIHZhbGlkYXRpb24gZGVjb3JhdG9ycywgYW5kIG1vZGVsLXJlbGF0ZWQgZnVuY3Rpb25hbGl0eSBmb3JcbiAqIGltcGxlbWVudGluZyB0eXBlLXNhZmUsIGRlY2xhcmF0aXZlIHZhbGlkYXRpb24gaW4gVHlwZVNjcmlwdCBhcHBsaWNhdGlvbnMuXG4gKi9cbmV4cG9ydCAqIGZyb20gXCIuL3V0aWxzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi92YWxpZGF0aW9uXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9tb2RlbFwiO1xuXG5leHBvcnQgY29uc3QgVkVSU0lPTiA9IFwiIyNWRVJTSU9OIyNcIjtcbiJdfQ==
+/**
+ * @description Current version of the reflection package
+ * @summary Stores the semantic version number of the package
+ * @const VERSION
+ * @memberOf module:decorator-validation
+ */
+export const VERSION = "1.7.2";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7OztHQU1HO0FBQ0gsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxTQUFTLENBQUM7QUFDeEIsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxTQUFTLENBQUM7QUFFeEI7Ozs7O0dBS0c7QUFDSCxNQUFNLENBQUMsTUFBTSxPQUFPLEdBQUcsYUFBYSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAbW9kdWxlIGRlY29yYXRvci12YWxpZGF0aW9uXG4gKiBAZGVzY3JpcHRpb24gVHlwZVNjcmlwdCBkZWNvcmF0b3ItYmFzZWQgdmFsaWRhdGlvbiBsaWJyYXJ5XG4gKiBAc3VtbWFyeSBUaGlzIG1vZHVsZSBwcm92aWRlcyBhIGNvbXByZWhlbnNpdmUgdmFsaWRhdGlvbiBmcmFtZXdvcmsgdXNpbmcgVHlwZVNjcmlwdCBkZWNvcmF0b3JzLlxuICogSXQgZXhwb3NlcyB1dGlsaXR5IGZ1bmN0aW9ucywgdmFsaWRhdGlvbiBkZWNvcmF0b3JzLCBhbmQgbW9kZWwtcmVsYXRlZCBmdW5jdGlvbmFsaXR5IGZvclxuICogaW1wbGVtZW50aW5nIHR5cGUtc2FmZSwgZGVjbGFyYXRpdmUgdmFsaWRhdGlvbiBpbiBUeXBlU2NyaXB0IGFwcGxpY2F0aW9ucy5cbiAqL1xuZXhwb3J0ICogZnJvbSBcIi4vY29uc3RhbnRzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi91dGlsc1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vdmFsaWRhdGlvblwiO1xuZXhwb3J0ICogZnJvbSBcIi4vbW9kZWxcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gQ3VycmVudCB2ZXJzaW9uIG9mIHRoZSByZWZsZWN0aW9uIHBhY2thZ2VcbiAqIEBzdW1tYXJ5IFN0b3JlcyB0aGUgc2VtYW50aWMgdmVyc2lvbiBudW1iZXIgb2YgdGhlIHBhY2thZ2VcbiAqIEBjb25zdCBWRVJTSU9OXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmRlY29yYXRvci12YWxpZGF0aW9uXG4gKi9cbmV4cG9ydCBjb25zdCBWRVJTSU9OID0gXCIjI1ZFUlNJT04jI1wiO1xuIl19

package/lib/esm/model/Model.d.ts

@@ -131,112 +131,236 @@ export declare function bulkModelRegister<M extends Model>(...models: (Construct
 export declare abstract class Model implements Validatable, Serializable, Hashable, Comparable<Model> {
     protected constructor(arg?: ModelArg<Model>);
     /**
-     * @summary Validates the object according to its decorated properties
+     * @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
+     * @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[]): ModelErrorDefinition | undefined;
     /**
-     * @summary Compare object equality recursively
-     * @param {any} obj object to compare to
-     * @param {string} [exceptions] property names to be excluded from the comparison
+     * @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;
     /**
+     * @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;
     /**
-     * @summary Override the implementation for js's 'toString()' which sucks...
+     * @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;
     /**
-     * @summary Defines a default implementation for object hash. Relies on a very basic implementation based on Java's string hash;
+     * @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;
     /**
-     * @summary Deserializes a Model
-     * @param {string} str
+     * @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
-     * @description Iterates all common properties of obj (if existing) and self, and copies them onto self
-     *
-     * @param {T} self
-     * @param {T | Record<string, any>} [obj]
      *
+     * @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>(self: T, obj?: T | Record<string, any>): T;
     /**
-     * @summary Repopulates the instance with the ones from the new Model Object
-     * @description Iterates all common properties of obj (if existing) and self, and copies them onto self.
-     * Is aware of nested Model Objects and rebuilds them also.
-     * When List properties are decorated with {@link list}, they list items will also be rebuilt
+     * @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
      *
-     * @param {T} self
-     * @param {T | Record<string, any>} [obj]
+     * @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;
     /**
-     * @summary Sets the Global {@link ModelBuilderFunction}
-     * @param {ModelBuilderFunction} [builder]
+     * @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;
     /**
-     * @summary Retrieves the current global {@link ModelBuilderFunction}
+     * @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;
     /**
-     * Returns the current {@link ModelRegistryManager}
+     * @description Provides access to the current model registry
+     * @summary Returns the current {@link ModelRegistryManager} instance, creating one if it doesn't exist
      *
-     * @return ModelRegistry, defaults to {@link ModelRegistryManager}
+     * @return {ModelRegistry<any>} - The current model registry, defaults to a new {@link ModelRegistryManager} if not set
+     * @private
      */
     private static getRegistry;
     /**
-     * Returns the current actingModelRegistry
+     * @description Configures the model registry to be used by the Model system
+     * @summary Sets the current model registry to a custom implementation
      *
-     * @param {BuilderRegistry} modelRegistry the new implementation of Registry
+     * @param {BuilderRegistry<any>} modelRegistry - The new implementation of Registry to use
+     * @return {void}
      */
     static setRegistry(modelRegistry: BuilderRegistry<any>): void;
     /**
-     * @summary register new Models
-     * @param {any} constructor
-     * @param {string} [name] when not defined, the name of the constructor will be used
+     * @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;
     /**
-     * @summary Gets a registered Model {@link ModelConstructor}
-     * @param {string} name
+     * @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;
     /**
-     * @param {Record<string, any>} obj
-     * @param {string} [clazz] when provided, it will attempt to find the matching constructor
+     * @description Creates a model instance from a plain object
+     * @summary Builds a model instance using the model registry, optionally specifying the model class
      *
-     * @throws Error If clazz is not found, or obj is not a {@link Model} meaning it has no {@link ModelKeys.ANCHOR} property
+     * @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 the model metadata from a model instance
+     * @summary Gets the metadata associated with a model instance, typically the model class name
+     *
+     * @template M
+     * @param {M} model - The model instance to get metadata from
+     * @return {string} - The model metadata (typically the class name)
+     */
     static getMetadata<M extends Model>(model: M): any;
+    /**
+     * @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 {string[]} [propsToIgnore] - Properties to exclude from validation
+     * @return {ModelErrorDefinition | undefined} - Returns validation errors if any, otherwise undefined
+     */
     static hasErrors<M extends Model>(model: M, ...propsToIgnore: string[]): 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>(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>(model: M): any;
     /**
+     * @description Creates a metadata key for use with the Reflection API
      * @summary Builds the key to store as Metadata under Reflections
-     * @description concatenates {@link ModelKeys#REFLECT} with the provided key
-     * @param {string} str
+     *
+     * @param {string} str - The base key to concatenate with the model reflection prefix
+     * @return {string} - The complete metadata key
      */
     static key(str: string): string;
     /**
@@ -264,12 +388,12 @@ export declare abstract class Model implements Validatable, Serializable, Hashab
     /**
      * @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. This function is used for model serialization
-     * and deserialization to properly handle nested models.
-     * @template M extends {@link Model}
+     * 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,
+     * @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;