@decaf-ts/core 0.5.1 → 0.5.3

package/lib/esm/interfaces/SequenceOptions.d.ts

@@ -1,12 +1,64 @@
+/**
+ * @description Interface for sequence configuration options
+ * @summary Defines the configuration options for creating and managing sequences
+ * @interface SequenceOptions
+ * @memberOf module:core
+ */
 export interface SequenceOptions {
+    /**
+     * @description Optional name for the sequence
+     * @summary A unique identifier for the sequence
+     */
     name?: string;
+    /**
+     * @description The data type of the sequence
+     * @summary Specifies whether the sequence generates Number or BigInt values
+     */
     type: "Number" | "BigInt" | undefined;
+    /**
+     * @description The initial value of the sequence
+     * @summary The value that the sequence starts with
+     */
     startWith: number;
+    /**
+     * @description The increment value for each step in the sequence
+     * @summary The amount by which the sequence increases with each call
+     */
     incrementBy: number;
+    /**
+     * @description Optional minimum value for the sequence
+     * @summary The lowest value that the sequence can generate
+     */
     minValue?: number;
+    /**
+     * @description Optional maximum value for the sequence
+     * @summary The highest value that the sequence can generate
+     */
     maxValue?: number;
+    /**
+     * @description Whether the sequence should cycle when reaching its limits
+     * @summary If true, the sequence will restart from minValue when reaching maxValue
+     */
     cycle: boolean;
 }
+/**
+ * @description Default options for sequences
+ * @summary Provides a standard configuration for number sequences starting at 0 and incrementing by 1
+ * @const DefaultSequenceOptions
+ * @memberOf module:core
+ */
 export declare const DefaultSequenceOptions: SequenceOptions;
+/**
+ * @description Predefined options for numeric sequences
+ * @summary Configuration for standard number sequences starting at 0 and incrementing by 1
+ * @const NumericSequence
+ * @memberOf module:core
+ */
 export declare const NumericSequence: SequenceOptions;
+/**
+ * @description Predefined options for BigInt sequences
+ * @summary Configuration for BigInt sequences starting at 0 and incrementing by 1
+ * @const BigIntSequence
+ * @memberOf module:core
+ */
 export declare const BigIntSequence: SequenceOptions;

package/lib/esm/interfaces/SequenceOptions.js

@@ -1,19 +1,37 @@
+/**
+ * @description Default options for sequences
+ * @summary Provides a standard configuration for number sequences starting at 0 and incrementing by 1
+ * @const DefaultSequenceOptions
+ * @memberOf module:core
+ */
 export const DefaultSequenceOptions = {
     type: "Number",
     startWith: 0,
     incrementBy: 1,
     cycle: false,
 };
+/**
+ * @description Predefined options for numeric sequences
+ * @summary Configuration for standard number sequences starting at 0 and incrementing by 1
+ * @const NumericSequence
+ * @memberOf module:core
+ */
 export const NumericSequence = {
     type: "Number",
     startWith: 0,
     incrementBy: 1,
     cycle: false,
 };
+/**
+ * @description Predefined options for BigInt sequences
+ * @summary Configuration for BigInt sequences starting at 0 and incrementing by 1
+ * @const BigIntSequence
+ * @memberOf module:core
+ */
 export const BigIntSequence = {
     type: "BigInt",
     startWith: 0,
     incrementBy: 1,
     cycle: false,
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2VxdWVuY2VPcHRpb25zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2ludGVyZmFjZXMvU2VxdWVuY2VPcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQVVBLE1BQU0sQ0FBQyxNQUFNLHNCQUFzQixHQUFvQjtJQUNyRCxJQUFJLEVBQUUsUUFBUTtJQUNkLFNBQVMsRUFBRSxDQUFDO0lBQ1osV0FBVyxFQUFFLENBQUM7SUFDZCxLQUFLLEVBQUUsS0FBSztDQUNiLENBQUM7QUFFRixNQUFNLENBQUMsTUFBTSxlQUFlLEdBQW9CO0lBQzlDLElBQUksRUFBRSxRQUFRO0lBQ2QsU0FBUyxFQUFFLENBQUM7SUFDWixXQUFXLEVBQUUsQ0FBQztJQUNkLEtBQUssRUFBRSxLQUFLO0NBQ2IsQ0FBQztBQUVGLE1BQU0sQ0FBQyxNQUFNLGNBQWMsR0FBb0I7SUFDN0MsSUFBSSxFQUFFLFFBQVE7SUFDZCxTQUFTLEVBQUUsQ0FBQztJQUNaLFdBQVcsRUFBRSxDQUFDO0lBQ2QsS0FBSyxFQUFFLEtBQUs7Q0FDYixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBTZXF1ZW5jZU9wdGlvbnMge1xuICBuYW1lPzogc3RyaW5nO1xuICB0eXBlOiBcIk51bWJlclwiIHwgXCJCaWdJbnRcIiB8IHVuZGVmaW5lZDtcbiAgc3RhcnRXaXRoOiBudW1iZXI7XG4gIGluY3JlbWVudEJ5OiBudW1iZXI7XG4gIG1pblZhbHVlPzogbnVtYmVyO1xuICBtYXhWYWx1ZT86IG51bWJlcjtcbiAgY3ljbGU6IGJvb2xlYW47XG59XG5cbmV4cG9ydCBjb25zdCBEZWZhdWx0U2VxdWVuY2VPcHRpb25zOiBTZXF1ZW5jZU9wdGlvbnMgPSB7XG4gIHR5cGU6IFwiTnVtYmVyXCIsXG4gIHN0YXJ0V2l0aDogMCxcbiAgaW5jcmVtZW50Qnk6IDEsXG4gIGN5Y2xlOiBmYWxzZSxcbn07XG5cbmV4cG9ydCBjb25zdCBOdW1lcmljU2VxdWVuY2U6IFNlcXVlbmNlT3B0aW9ucyA9IHtcbiAgdHlwZTogXCJOdW1iZXJcIixcbiAgc3RhcnRXaXRoOiAwLFxuICBpbmNyZW1lbnRCeTogMSxcbiAgY3ljbGU6IGZhbHNlLFxufTtcblxuZXhwb3J0IGNvbnN0IEJpZ0ludFNlcXVlbmNlOiBTZXF1ZW5jZU9wdGlvbnMgPSB7XG4gIHR5cGU6IFwiQmlnSW50XCIsXG4gIHN0YXJ0V2l0aDogMCxcbiAgaW5jcmVtZW50Qnk6IDEsXG4gIGN5Y2xlOiBmYWxzZSxcbn07XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2VxdWVuY2VPcHRpb25zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2ludGVyZmFjZXMvU2VxdWVuY2VPcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQWtEQTs7Ozs7R0FLRztBQUNILE1BQU0sQ0FBQyxNQUFNLHNCQUFzQixHQUFvQjtJQUNyRCxJQUFJLEVBQUUsUUFBUTtJQUNkLFNBQVMsRUFBRSxDQUFDO0lBQ1osV0FBVyxFQUFFLENBQUM7SUFDZCxLQUFLLEVBQUUsS0FBSztDQUNiLENBQUM7QUFFRjs7Ozs7R0FLRztBQUNILE1BQU0sQ0FBQyxNQUFNLGVBQWUsR0FBb0I7SUFDOUMsSUFBSSxFQUFFLFFBQVE7SUFDZCxTQUFTLEVBQUUsQ0FBQztJQUNaLFdBQVcsRUFBRSxDQUFDO0lBQ2QsS0FBSyxFQUFFLEtBQUs7Q0FDYixDQUFDO0FBRUY7Ozs7O0dBS0c7QUFDSCxNQUFNLENBQUMsTUFBTSxjQUFjLEdBQW9CO0lBQzdDLElBQUksRUFBRSxRQUFRO0lBQ2QsU0FBUyxFQUFFLENBQUM7SUFDWixXQUFXLEVBQUUsQ0FBQztJQUNkLEtBQUssRUFBRSxLQUFLO0NBQ2IsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQGRlc2NyaXB0aW9uIEludGVyZmFjZSBmb3Igc2VxdWVuY2UgY29uZmlndXJhdGlvbiBvcHRpb25zXG4gKiBAc3VtbWFyeSBEZWZpbmVzIHRoZSBjb25maWd1cmF0aW9uIG9wdGlvbnMgZm9yIGNyZWF0aW5nIGFuZCBtYW5hZ2luZyBzZXF1ZW5jZXNcbiAqIEBpbnRlcmZhY2UgU2VxdWVuY2VPcHRpb25zXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBTZXF1ZW5jZU9wdGlvbnMge1xuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIE9wdGlvbmFsIG5hbWUgZm9yIHRoZSBzZXF1ZW5jZVxuICAgKiBAc3VtbWFyeSBBIHVuaXF1ZSBpZGVudGlmaWVyIGZvciB0aGUgc2VxdWVuY2VcbiAgICovXG4gIG5hbWU/OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBUaGUgZGF0YSB0eXBlIG9mIHRoZSBzZXF1ZW5jZVxuICAgKiBAc3VtbWFyeSBTcGVjaWZpZXMgd2hldGhlciB0aGUgc2VxdWVuY2UgZ2VuZXJhdGVzIE51bWJlciBvciBCaWdJbnQgdmFsdWVzXG4gICAqL1xuICB0eXBlOiBcIk51bWJlclwiIHwgXCJCaWdJbnRcIiB8IHVuZGVmaW5lZDtcblxuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIFRoZSBpbml0aWFsIHZhbHVlIG9mIHRoZSBzZXF1ZW5jZVxuICAgKiBAc3VtbWFyeSBUaGUgdmFsdWUgdGhhdCB0aGUgc2VxdWVuY2Ugc3RhcnRzIHdpdGhcbiAgICovXG4gIHN0YXJ0V2l0aDogbnVtYmVyO1xuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gVGhlIGluY3JlbWVudCB2YWx1ZSBmb3IgZWFjaCBzdGVwIGluIHRoZSBzZXF1ZW5jZVxuICAgKiBAc3VtbWFyeSBUaGUgYW1vdW50IGJ5IHdoaWNoIHRoZSBzZXF1ZW5jZSBpbmNyZWFzZXMgd2l0aCBlYWNoIGNhbGxcbiAgICovXG4gIGluY3JlbWVudEJ5OiBudW1iZXI7XG5cbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBPcHRpb25hbCBtaW5pbXVtIHZhbHVlIGZvciB0aGUgc2VxdWVuY2VcbiAgICogQHN1bW1hcnkgVGhlIGxvd2VzdCB2YWx1ZSB0aGF0IHRoZSBzZXF1ZW5jZSBjYW4gZ2VuZXJhdGVcbiAgICovXG4gIG1pblZhbHVlPzogbnVtYmVyO1xuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gT3B0aW9uYWwgbWF4aW11bSB2YWx1ZSBmb3IgdGhlIHNlcXVlbmNlXG4gICAqIEBzdW1tYXJ5IFRoZSBoaWdoZXN0IHZhbHVlIHRoYXQgdGhlIHNlcXVlbmNlIGNhbiBnZW5lcmF0ZVxuICAgKi9cbiAgbWF4VmFsdWU/OiBudW1iZXI7XG5cbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBXaGV0aGVyIHRoZSBzZXF1ZW5jZSBzaG91bGQgY3ljbGUgd2hlbiByZWFjaGluZyBpdHMgbGltaXRzXG4gICAqIEBzdW1tYXJ5IElmIHRydWUsIHRoZSBzZXF1ZW5jZSB3aWxsIHJlc3RhcnQgZnJvbSBtaW5WYWx1ZSB3aGVuIHJlYWNoaW5nIG1heFZhbHVlXG4gICAqL1xuICBjeWNsZTogYm9vbGVhbjtcbn1cblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gRGVmYXVsdCBvcHRpb25zIGZvciBzZXF1ZW5jZXNcbiAqIEBzdW1tYXJ5IFByb3ZpZGVzIGEgc3RhbmRhcmQgY29uZmlndXJhdGlvbiBmb3IgbnVtYmVyIHNlcXVlbmNlcyBzdGFydGluZyBhdCAwIGFuZCBpbmNyZW1lbnRpbmcgYnkgMVxuICogQGNvbnN0IERlZmF1bHRTZXF1ZW5jZU9wdGlvbnNcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgY29uc3QgRGVmYXVsdFNlcXVlbmNlT3B0aW9uczogU2VxdWVuY2VPcHRpb25zID0ge1xuICB0eXBlOiBcIk51bWJlclwiLFxuICBzdGFydFdpdGg6IDAsXG4gIGluY3JlbWVudEJ5OiAxLFxuICBjeWNsZTogZmFsc2UsXG59O1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBQcmVkZWZpbmVkIG9wdGlvbnMgZm9yIG51bWVyaWMgc2VxdWVuY2VzXG4gKiBAc3VtbWFyeSBDb25maWd1cmF0aW9uIGZvciBzdGFuZGFyZCBudW1iZXIgc2VxdWVuY2VzIHN0YXJ0aW5nIGF0IDAgYW5kIGluY3JlbWVudGluZyBieSAxXG4gKiBAY29uc3QgTnVtZXJpY1NlcXVlbmNlXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGNvbnN0IE51bWVyaWNTZXF1ZW5jZTogU2VxdWVuY2VPcHRpb25zID0ge1xuICB0eXBlOiBcIk51bWJlclwiLFxuICBzdGFydFdpdGg6IDAsXG4gIGluY3JlbWVudEJ5OiAxLFxuICBjeWNsZTogZmFsc2UsXG59O1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBQcmVkZWZpbmVkIG9wdGlvbnMgZm9yIEJpZ0ludCBzZXF1ZW5jZXNcbiAqIEBzdW1tYXJ5IENvbmZpZ3VyYXRpb24gZm9yIEJpZ0ludCBzZXF1ZW5jZXMgc3RhcnRpbmcgYXQgMCBhbmQgaW5jcmVtZW50aW5nIGJ5IDFcbiAqIEBjb25zdCBCaWdJbnRTZXF1ZW5jZVxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKi9cbmV4cG9ydCBjb25zdCBCaWdJbnRTZXF1ZW5jZTogU2VxdWVuY2VPcHRpb25zID0ge1xuICB0eXBlOiBcIkJpZ0ludFwiLFxuICBzdGFydFdpdGg6IDAsXG4gIGluY3JlbWVudEJ5OiAxLFxuICBjeWNsZTogZmFsc2UsXG59O1xuIl19

package/lib/esm/interfaces/index.js

@@ -1,8 +1,8 @@
-export * from "./ErrorParser";
-export * from "./Executor";
-export * from "./Observable";
-export * from "./Observer";
-export * from "./Queriable";
-export * from "./RawExecutor";
-export * from "./SequenceOptions";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLGVBQWUsQ0FBQztBQUM5QixjQUFjLFlBQVksQ0FBQztBQUMzQixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLFlBQVksQ0FBQztBQUMzQixjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLGVBQWUsQ0FBQztBQUM5QixjQUFjLG1CQUFtQixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSBcIi4vRXJyb3JQYXJzZXJcIjtcbmV4cG9ydCAqIGZyb20gXCIuL0V4ZWN1dG9yXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9PYnNlcnZhYmxlXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9PYnNlcnZlclwiO1xuZXhwb3J0ICogZnJvbSBcIi4vUXVlcmlhYmxlXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9SYXdFeGVjdXRvclwiO1xuZXhwb3J0ICogZnJvbSBcIi4vU2VxdWVuY2VPcHRpb25zXCI7XG4iXX0=
+export * from "./ErrorParser.js";
+export * from "./Executor.js";
+export * from "./Observable.js";
+export * from "./Observer.js";
+export * from "./Queriable.js";
+export * from "./RawExecutor.js";
+export * from "./SequenceOptions.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxpQ0FBOEI7QUFDOUIsOEJBQTJCO0FBQzNCLGdDQUE2QjtBQUM3Qiw4QkFBMkI7QUFDM0IsK0JBQTRCO0FBQzVCLGlDQUE4QjtBQUM5QixxQ0FBa0MiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tIFwiLi9FcnJvclBhcnNlclwiO1xuZXhwb3J0ICogZnJvbSBcIi4vRXhlY3V0b3JcIjtcbmV4cG9ydCAqIGZyb20gXCIuL09ic2VydmFibGVcIjtcbmV4cG9ydCAqIGZyb20gXCIuL09ic2VydmVyXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9RdWVyaWFibGVcIjtcbmV4cG9ydCAqIGZyb20gXCIuL1Jhd0V4ZWN1dG9yXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9TZXF1ZW5jZU9wdGlvbnNcIjtcbiJdfQ==

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

@@ -1,6 +1,37 @@
 import { ModelArg, Model } from "@decaf-ts/decorator-validation";
+/**
+ * @description Base model class for all domain models
+ * @summary An abstract base class that extends the Model class from decorator-validation and adds timestamp functionality.
+ * All domain models in the application should extend this class to inherit common properties and behaviors.
+ * @param {ModelArg<BaseModel>} arg - Optional initialization data for the model
+ * @class BaseModel
+ * @example
+ * ```typescript
+ * class User extends BaseModel {
+ *   @required()
+ *   username!: string;
+ *
+ *   @email()
+ *   email!: string;
+ *
+ *   constructor(data?: ModelArg<User>) {
+ *     super(data);
+ *   }
+ * }
+ *
+ * const user = new User({ username: 'john', email: 'john@example.com' });
+ * ```
+ */
 export declare abstract class BaseModel extends Model {
+    /**
+     * @description Creation timestamp for the model
+     * @summary Automatically set to the current date and time when the model is created
+     */
     createdOn: Date;
+    /**
+     * @description Last update timestamp for the model
+     * @summary Automatically updated to the current date and time whenever the model is modified
+     */
     updatedOn: Date;
     protected constructor(arg?: ModelArg<BaseModel>);
 }

package/lib/esm/model/BaseModel.js

@@ -9,6 +9,29 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 import { DBOperations, timestamp } from "@decaf-ts/db-decorators";
 import { Model } from "@decaf-ts/decorator-validation";
+/**
+ * @description Base model class for all domain models
+ * @summary An abstract base class that extends the Model class from decorator-validation and adds timestamp functionality.
+ * All domain models in the application should extend this class to inherit common properties and behaviors.
+ * @param {ModelArg<BaseModel>} arg - Optional initialization data for the model
+ * @class BaseModel
+ * @example
+ * ```typescript
+ * class User extends BaseModel {
+ *   @required()
+ *   username!: string;
+ *
+ *   @email()
+ *   email!: string;
+ *
+ *   constructor(data?: ModelArg<User>) {
+ *     super(data);
+ *   }
+ * }
+ *
+ * const user = new User({ username: 'john', email: 'john@example.com' });
+ * ```
+ */
 export class BaseModel extends Model {
     constructor(arg) {
         super(arg);
@@ -22,4 +45,4 @@ __decorate([
     timestamp(),
     __metadata("design:type", Date)
 ], BaseModel.prototype, "updatedOn", void 0);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQmFzZU1vZGVsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL21vZGVsL0Jhc2VNb2RlbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFBQSxPQUFPLEVBQUUsWUFBWSxFQUFFLFNBQVMsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBQ2xFLE9BQU8sRUFBWSxLQUFLLEVBQUUsTUFBTSxnQ0FBZ0MsQ0FBQztBQUVqRSxNQUFNLE9BQWdCLFNBQVUsU0FBUSxLQUFLO0lBTTNDLFlBQXNCLEdBQXlCO1FBQzdDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUNiLENBQUM7Q0FDRjtBQVBDO0lBREMsU0FBUyxDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUM7OEJBQ25CLElBQUk7NENBQUM7QUFFakI7SUFEQyxTQUFTLEVBQUU7OEJBQ0EsSUFBSTs0Q0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IERCT3BlcmF0aW9ucywgdGltZXN0YW1wIH0gZnJvbSBcIkBkZWNhZi10cy9kYi1kZWNvcmF0b3JzXCI7XG5pbXBvcnQgeyBNb2RlbEFyZywgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5cbmV4cG9ydCBhYnN0cmFjdCBjbGFzcyBCYXNlTW9kZWwgZXh0ZW5kcyBNb2RlbCB7XG4gIEB0aW1lc3RhbXAoREJPcGVyYXRpb25zLkNSRUFURSlcbiAgY3JlYXRlZE9uITogRGF0ZTtcbiAgQHRpbWVzdGFtcCgpXG4gIHVwZGF0ZWRPbiE6IERhdGU7XG5cbiAgcHJvdGVjdGVkIGNvbnN0cnVjdG9yKGFyZz86IE1vZGVsQXJnPEJhc2VNb2RlbD4pIHtcbiAgICBzdXBlcihhcmcpO1xuICB9XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQmFzZU1vZGVsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL21vZGVsL0Jhc2VNb2RlbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFBQSxPQUFPLEVBQUUsWUFBWSxFQUFFLFNBQVMsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBQ2xFLE9BQU8sRUFBWSxLQUFLLEVBQUUsTUFBTSxnQ0FBZ0MsQ0FBQztBQUVqRTs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXNCRztBQUNILE1BQU0sT0FBZ0IsU0FBVSxTQUFRLEtBQUs7SUFlM0MsWUFBc0IsR0FBeUI7UUFDN0MsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ2IsQ0FBQztDQUNGO0FBWkM7SUFEQyxTQUFTLENBQUMsWUFBWSxDQUFDLE1BQU0sQ0FBQzs4QkFDbkIsSUFBSTs0Q0FBQztBQU9qQjtJQURDLFNBQVMsRUFBRTs4QkFDQSxJQUFJOzRDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgREJPcGVyYXRpb25zLCB0aW1lc3RhbXAgfSBmcm9tIFwiQGRlY2FmLXRzL2RiLWRlY29yYXRvcnNcIjtcbmltcG9ydCB7IE1vZGVsQXJnLCBNb2RlbCB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gQmFzZSBtb2RlbCBjbGFzcyBmb3IgYWxsIGRvbWFpbiBtb2RlbHNcbiAqIEBzdW1tYXJ5IEFuIGFic3RyYWN0IGJhc2UgY2xhc3MgdGhhdCBleHRlbmRzIHRoZSBNb2RlbCBjbGFzcyBmcm9tIGRlY29yYXRvci12YWxpZGF0aW9uIGFuZCBhZGRzIHRpbWVzdGFtcCBmdW5jdGlvbmFsaXR5LlxuICogQWxsIGRvbWFpbiBtb2RlbHMgaW4gdGhlIGFwcGxpY2F0aW9uIHNob3VsZCBleHRlbmQgdGhpcyBjbGFzcyB0byBpbmhlcml0IGNvbW1vbiBwcm9wZXJ0aWVzIGFuZCBiZWhhdmlvcnMuXG4gKiBAcGFyYW0ge01vZGVsQXJnPEJhc2VNb2RlbD59IGFyZyAtIE9wdGlvbmFsIGluaXRpYWxpemF0aW9uIGRhdGEgZm9yIHRoZSBtb2RlbFxuICogQGNsYXNzIEJhc2VNb2RlbFxuICogQGV4YW1wbGVcbiAqIGBgYHR5cGVzY3JpcHRcbiAqIGNsYXNzIFVzZXIgZXh0ZW5kcyBCYXNlTW9kZWwge1xuICogICBAcmVxdWlyZWQoKVxuICogICB1c2VybmFtZSE6IHN0cmluZztcbiAqICAgXG4gKiAgIEBlbWFpbCgpXG4gKiAgIGVtYWlsITogc3RyaW5nO1xuICogICBcbiAqICAgY29uc3RydWN0b3IoZGF0YT86IE1vZGVsQXJnPFVzZXI+KSB7XG4gKiAgICAgc3VwZXIoZGF0YSk7XG4gKiAgIH1cbiAqIH1cbiAqIFxuICogY29uc3QgdXNlciA9IG5ldyBVc2VyKHsgdXNlcm5hbWU6ICdqb2huJywgZW1haWw6ICdqb2huQGV4YW1wbGUuY29tJyB9KTtcbiAqIGBgYFxuICovXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgQmFzZU1vZGVsIGV4dGVuZHMgTW9kZWwge1xuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIENyZWF0aW9uIHRpbWVzdGFtcCBmb3IgdGhlIG1vZGVsXG4gICAqIEBzdW1tYXJ5IEF1dG9tYXRpY2FsbHkgc2V0IHRvIHRoZSBjdXJyZW50IGRhdGUgYW5kIHRpbWUgd2hlbiB0aGUgbW9kZWwgaXMgY3JlYXRlZFxuICAgKi9cbiAgQHRpbWVzdGFtcChEQk9wZXJhdGlvbnMuQ1JFQVRFKVxuICBjcmVhdGVkT24hOiBEYXRlO1xuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gTGFzdCB1cGRhdGUgdGltZXN0YW1wIGZvciB0aGUgbW9kZWxcbiAgICogQHN1bW1hcnkgQXV0b21hdGljYWxseSB1cGRhdGVkIHRvIHRoZSBjdXJyZW50IGRhdGUgYW5kIHRpbWUgd2hlbmV2ZXIgdGhlIG1vZGVsIGlzIG1vZGlmaWVkXG4gICAqL1xuICBAdGltZXN0YW1wKClcbiAgdXBkYXRlZE9uITogRGF0ZTtcblxuICBwcm90ZWN0ZWQgY29uc3RydWN0b3IoYXJnPzogTW9kZWxBcmc8QmFzZU1vZGVsPikge1xuICAgIHN1cGVyKGFyZyk7XG4gIH1cbn1cbiJdfQ==

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

@@ -3,16 +3,449 @@ import { Repo } from "../repository/Repository";
 import { RelationsMetadata } from "./types";
 import { RepositoryFlags } from "@decaf-ts/db-decorators";
 import { Context } from "@decaf-ts/db-decorators";
+/**
+ * @description Creates or updates a model instance
+ * @summary Determines whether to create a new model or update an existing one based on the presence of a primary key
+ * @template M - The model type extending Model
+ * @template F - The repository flags type
+ * @param {M} model - The model instance to create or update
+ * @param {Context<F>} context - The context for the operation
+ * @param {Repo<M, F, Context<F>>} [repository] - Optional repository to use for the operation
+ * @return {Promise<M>} A promise that resolves to the created or updated model
+ * @function createOrUpdate
+ * @memberOf module:core
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant createOrUpdate
+ *   participant Repository
+ *   participant Model
+ *
+ *   Caller->>createOrUpdate: model, context, repository?
+ *   alt repository not provided
+ *     createOrUpdate->>Model: get(model.constructor.name)
+ *     Model-->>createOrUpdate: constructor
+ *     createOrUpdate->>Repository: forModel(constructor)
+ *     Repository-->>createOrUpdate: repository
+ *   end
+ *
+ *   alt primary key undefined
+ *     createOrUpdate->>Repository: create(model, context)
+ *     Repository-->>createOrUpdate: created model
+ *   else primary key defined
+ *     createOrUpdate->>Repository: update(model, context)
+ *     alt update successful
+ *       Repository-->>createOrUpdate: updated model
+ *     else NotFoundError
+ *       createOrUpdate->>Repository: create(model, context)
+ *       Repository-->>createOrUpdate: created model
+ *     end
+ *   end
+ *
+ *   createOrUpdate-->>Caller: model
+ */
 export declare function createOrUpdate<M extends Model, F extends RepositoryFlags>(model: M, context: Context<F>, repository?: Repo<M, F, Context<F>>): Promise<M>;
+/**
+ * @description Handles one-to-one relationship creation
+ * @summary Processes a one-to-one relationship when creating a model, either by referencing an existing model or creating a new one
+ * @template M - The model type extending Model
+ * @template R - The repository type extending Repo<M, F, C>
+ * @template V - The relations metadata type extending RelationsMetadata
+ * @template F - The repository flags type
+ * @template C - The context type extending Context<F>
+ * @param {R} this - The repository instance
+ * @param {Context<F>} context - The context for the operation
+ * @param {V} data - The relations metadata
+ * @param {string} key - The property key of the relationship
+ * @param {M} model - The model instance
+ * @return {Promise<void>} A promise that resolves when the operation is complete
+ * @function oneToOneOnCreate
+ * @memberOf module:core
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant oneToOneOnCreate
+ *   participant repositoryFromTypeMetadata
+ *   participant Model
+ *   participant Repository
+ *   participant cacheModelForPopulate
+ *
+ *   Caller->>oneToOneOnCreate: this, context, data, key, model
+ *   oneToOneOnCreate->>oneToOneOnCreate: check if propertyValue exists
+ *
+ *   alt propertyValue is not an object
+ *     oneToOneOnCreate->>repositoryFromTypeMetadata: model, key
+ *     repositoryFromTypeMetadata-->>oneToOneOnCreate: innerRepo
+ *     oneToOneOnCreate->>innerRepo: read(propertyValue)
+ *     innerRepo-->>oneToOneOnCreate: read
+ *     oneToOneOnCreate->>cacheModelForPopulate: context, model, key, propertyValue, read
+ *     oneToOneOnCreate->>oneToOneOnCreate: set model[key] = propertyValue
+ *   else propertyValue is an object
+ *     oneToOneOnCreate->>Model: get(data.class)
+ *     Model-->>oneToOneOnCreate: constructor
+ *     oneToOneOnCreate->>Repository: forModel(constructor)
+ *     Repository-->>oneToOneOnCreate: repo
+ *     oneToOneOnCreate->>repo: create(propertyValue)
+ *     repo-->>oneToOneOnCreate: created
+ *     oneToOneOnCreate->>findPrimaryKey: created
+ *     findPrimaryKey-->>oneToOneOnCreate: pk
+ *     oneToOneOnCreate->>cacheModelForPopulate: context, model, key, created[pk], created
+ *     oneToOneOnCreate->>oneToOneOnCreate: set model[key] = created[pk]
+ *   end
+ *
+ *   oneToOneOnCreate-->>Caller: void
+ */
 export declare function oneToOneOnCreate<M extends Model, R extends Repo<M, F, C>, V extends RelationsMetadata, F extends RepositoryFlags, C extends Context<F>>(this: R, context: Context<F>, data: V, key: keyof M, model: M): Promise<void>;
+/**
+ * @description Handles one-to-one relationship updates
+ * @summary Processes a one-to-one relationship when updating a model, either by referencing an existing model or updating the related model
+ * @template M - The model type extending Model
+ * @template R - The repository type extending Repo<M, F, C>
+ * @template V - The relations metadata type extending RelationsMetadata
+ * @template F - The repository flags type
+ * @template C - The context type extending Context<F>
+ * @param {R} this - The repository instance
+ * @param {Context<F>} context - The context for the operation
+ * @param {V} data - The relations metadata
+ * @param key - The property key of the relationship
+ * @param {M} model - The model instance
+ * @return {Promise<void>} A promise that resolves when the operation is complete
+ * @function oneToOneOnUpdate
+ * @memberOf module:core
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant oneToOneOnUpdate
+ *   participant repositoryFromTypeMetadata
+ *   participant createOrUpdate
+ *   participant findPrimaryKey
+ *   participant cacheModelForPopulate
+ *
+ *   Caller->>oneToOneOnUpdate: this, context, data, key, model
+ *   oneToOneOnUpdate->>oneToOneOnUpdate: check if propertyValue exists
+ *   oneToOneOnUpdate->>oneToOneOnUpdate: check if cascade.update is CASCADE
+ *
+ *   alt propertyValue is not an object
+ *     oneToOneOnUpdate->>repositoryFromTypeMetadata: model, key
+ *     repositoryFromTypeMetadata-->>oneToOneOnUpdate: innerRepo
+ *     oneToOneOnUpdate->>innerRepo: read(propertyValue)
+ *     innerRepo-->>oneToOneOnUpdate: read
+ *     oneToOneOnUpdate->>cacheModelForPopulate: context, model, key, propertyValue, read
+ *     oneToOneOnUpdate->>oneToOneOnUpdate: set model[key] = propertyValue
+ *   else propertyValue is an object
+ *     oneToOneOnUpdate->>createOrUpdate: model[key], context
+ *     createOrUpdate-->>oneToOneOnUpdate: updated
+ *     oneToOneOnUpdate->>findPrimaryKey: updated
+ *     findPrimaryKey-->>oneToOneOnUpdate: pk
+ *     oneToOneOnUpdate->>cacheModelForPopulate: context, model, key, updated[pk], updated
+ *     oneToOneOnUpdate->>oneToOneOnUpdate: set model[key] = updated[pk]
+ *   end
+ *
+ *   oneToOneOnUpdate-->>Caller: void
+ */
 export declare function oneToOneOnUpdate<M extends Model, R extends Repo<M, F, C>, V extends RelationsMetadata, F extends RepositoryFlags, C extends Context<F>>(this: R, context: Context<F>, data: V, key: keyof M, model: M): Promise<void>;
+/**
+ * @description Handles one-to-one relationship deletion
+ * @summary Processes a one-to-one relationship when deleting a model, deleting the related model if cascade is enabled
+ * @template M - The model type extending Model
+ * @template R - The repository type extending Repo<M, F, C>
+ * @template V - The relations metadata type extending RelationsMetadata
+ * @template F - The repository flags type
+ * @template C - The context type extending Context<F>
+ * @param {R} this - The repository instance
+ * @param {Context<F>} context - The context for the operation
+ * @param {V} data - The relations metadata
+ * @param key - The property key of the relationship
+ * @param {M} model - The model instance
+ * @return {Promise<void>} A promise that resolves when the operation is complete
+ * @function oneToOneOnDelete
+ * @memberOf module:core
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant oneToOneOnDelete
+ *   participant repositoryFromTypeMetadata
+ *   participant cacheModelForPopulate
+ *
+ *   Caller->>oneToOneOnDelete: this, context, data, key, model
+ *   oneToOneOnDelete->>oneToOneOnDelete: check if propertyValue exists
+ *   oneToOneOnDelete->>oneToOneOnDelete: check if cascade.update is CASCADE
+ *
+ *   oneToOneOnDelete->>repositoryFromTypeMetadata: model, key
+ *   repositoryFromTypeMetadata-->>oneToOneOnDelete: innerRepo
+ *
+ *   alt propertyValue is not a Model instance
+ *     oneToOneOnDelete->>innerRepo: delete(model[key], context)
+ *     innerRepo-->>oneToOneOnDelete: deleted
+ *   else propertyValue is a Model instance
+ *     oneToOneOnDelete->>innerRepo: delete(model[key][innerRepo.pk], context)
+ *     innerRepo-->>oneToOneOnDelete: deleted
+ *   end
+ *
+ *   oneToOneOnDelete->>cacheModelForPopulate: context, model, key, deleted[innerRepo.pk], deleted
+ *   oneToOneOnDelete-->>Caller: void
+ */
 export declare function oneToOneOnDelete<M extends Model, R extends Repo<M, F, C>, V extends RelationsMetadata, F extends RepositoryFlags, C extends Context<F>>(this: R, context: Context<F>, data: V, key: keyof M, model: M): Promise<void>;
+/**
+ * @description Handles one-to-many relationship creation
+ * @summary Processes a one-to-many relationship when creating a model, either by referencing existing models or creating new ones
+ * @template M - The model type extending Model
+ * @template R - The repository type extending Repo<M, F, C>
+ * @template V - The relations metadata type extending RelationsMetadata
+ * @template F - The repository flags type
+ * @template C - The context type extending Context<F>
+ * @param {R} this - The repository instance
+ * @param {Context<F>} context - The context for the operation
+ * @param {V} data - The relations metadata
+ * @param key - The property key of the relationship
+ * @param {M} model - The model instance
+ * @return {Promise<void>} A promise that resolves when the operation is complete
+ * @function oneToManyOnCreate
+ * @memberOf module:core
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant oneToManyOnCreate
+ *   participant repositoryFromTypeMetadata
+ *   participant createOrUpdate
+ *   participant findPrimaryKey
+ *   participant cacheModelForPopulate
+ *
+ *   Caller->>oneToManyOnCreate: this, context, data, key, model
+ *   oneToManyOnCreate->>oneToManyOnCreate: check if propertyValues exists and has length
+ *   oneToManyOnCreate->>oneToManyOnCreate: check if all elements have same type
+ *   oneToManyOnCreate->>oneToManyOnCreate: create uniqueValues set
+ *
+ *   alt arrayType is not "object"
+ *     oneToManyOnCreate->>repositoryFromTypeMetadata: model, key
+ *     repositoryFromTypeMetadata-->>oneToManyOnCreate: repo
+ *     loop for each id in uniqueValues
+ *       oneToManyOnCreate->>repo: read(id)
+ *       repo-->>oneToManyOnCreate: read
+ *       oneToManyOnCreate->>cacheModelForPopulate: context, model, key, id, read
+ *     end
+ *     oneToManyOnCreate->>oneToManyOnCreate: set model[key] = [...uniqueValues]
+ *   else arrayType is "object"
+ *     oneToManyOnCreate->>findPrimaryKey: propertyValues[0]
+ *     findPrimaryKey-->>oneToManyOnCreate: pkName
+ *     oneToManyOnCreate->>oneToManyOnCreate: create result set
+ *     loop for each m in propertyValues
+ *       oneToManyOnCreate->>createOrUpdate: m, context
+ *       createOrUpdate-->>oneToManyOnCreate: record
+ *       oneToManyOnCreate->>cacheModelForPopulate: context, model, key, record[pkName], record
+ *       oneToManyOnCreate->>oneToManyOnCreate: add record[pkName] to result
+ *     end
+ *     oneToManyOnCreate->>oneToManyOnCreate: set model[key] = [...result]
+ *   end
+ *
+ *   oneToManyOnCreate-->>Caller: void
+ */
 export declare function oneToManyOnCreate<M extends Model, R extends Repo<M, F, C>, V extends RelationsMetadata, F extends RepositoryFlags, C extends Context<F>>(this: R, context: Context<F>, data: V, key: keyof M, model: M): Promise<void>;
+/**
+ * @description Handles one-to-many relationship updates
+ * @summary Processes a one-to-many relationship when updating a model, delegating to oneToManyOnCreate if cascade update is enabled
+ * @template M - The model type extending Model
+ * @template R - The repository type extending Repo<M, F, C>
+ * @template V - The relations metadata type extending RelationsMetadata
+ * @template F - The repository flags type
+ * @template C - The context type extending Context<F>
+ * @param {R} this - The repository instance
+ * @param {Context<F>} context - The context for the operation
+ * @param {V} data - The relations metadata
+ * @param key - The property key of the relationship
+ * @param {M} model - The model instance
+ * @return {Promise<void>} A promise that resolves when the operation is complete
+ * @function oneToManyOnUpdate
+ * @memberOf module:core
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant oneToManyOnUpdate
+ *   participant oneToManyOnCreate
+ *
+ *   Caller->>oneToManyOnUpdate: this, context, data, key, model
+ *   oneToManyOnUpdate->>oneToManyOnUpdate: check if cascade.update is CASCADE
+ *
+ *   alt cascade.update is CASCADE
+ *     oneToManyOnUpdate->>oneToManyOnCreate: apply(this, [context, data, key, model])
+ *     oneToManyOnCreate-->>oneToManyOnUpdate: void
+ *   end
+ *
+ *   oneToManyOnUpdate-->>Caller: void
+ */
 export declare function oneToManyOnUpdate<M extends Model, R extends Repo<M, F, C>, V extends RelationsMetadata, F extends RepositoryFlags, C extends Context<F>>(this: R, context: Context<F>, data: V, key: keyof M, model: M): Promise<void>;
+/**
+ * @description Handles one-to-many relationship deletion
+ * @summary Processes a one-to-many relationship when deleting a model, deleting all related models if cascade delete is enabled
+ * @template M - The model type extending Model
+ * @template R - The repository type extending Repo<M, F, C>
+ * @template V - The relations metadata type extending RelationsMetadata
+ * @template F - The repository flags type
+ * @template C - The context type extending Context<F>
+ * @param {R} this - The repository instance
+ * @param {Context<F>} context - The context for the operation
+ * @param {V} data - The relations metadata
+ * @param key - The property key of the relationship
+ * @param {M} model - The model instance
+ * @return {Promise<void>} A promise that resolves when the operation is complete
+ * @function oneToManyOnDelete
+ * @memberOf module:core
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant oneToManyOnDelete
+ *   participant Repository
+ *   participant repositoryFromTypeMetadata
+ *   participant cacheModelForPopulate
+ *
+ *   Caller->>oneToManyOnDelete: this, context, data, key, model
+ *   oneToManyOnDelete->>oneToManyOnDelete: check if cascade.delete is CASCADE
+ *   oneToManyOnDelete->>oneToManyOnDelete: check if values exists and has length
+ *   oneToManyOnDelete->>oneToManyOnDelete: check if all elements have same type
+ *
+ *   alt isInstantiated (arrayType is "object")
+ *     oneToManyOnDelete->>Repository: forModel(values[0])
+ *     Repository-->>oneToManyOnDelete: repo
+ *   else not instantiated
+ *     oneToManyOnDelete->>repositoryFromTypeMetadata: model, key
+ *     repositoryFromTypeMetadata-->>oneToManyOnDelete: repo
+ *   end
+ *
+ *   oneToManyOnDelete->>oneToManyOnDelete: create uniqueValues set
+ *
+ *   loop for each id in uniqueValues
+ *     oneToManyOnDelete->>repo: delete(id, context)
+ *     repo-->>oneToManyOnDelete: deleted
+ *     oneToManyOnDelete->>cacheModelForPopulate: context, model, key, id, deleted
+ *   end
+ *
+ *   oneToManyOnDelete->>oneToManyOnDelete: set model[key] = [...uniqueValues]
+ *   oneToManyOnDelete-->>Caller: void
+ */
 export declare function oneToManyOnDelete<M extends Model, R extends Repo<M, F, C>, V extends RelationsMetadata, F extends RepositoryFlags, C extends Context<F>>(this: R, context: Context<F>, data: V, key: keyof M, model: M): Promise<void>;
+/**
+ * @description Generates a key for caching populated model relationships
+ * @summary Creates a unique key for storing and retrieving populated model relationships in the cache
+ * @param {string} tableName - The name of the table or model
+ * @param {string} fieldName - The name of the field or property
+ * @param {string|number} id - The identifier of the related model
+ * @return {string} A dot-separated string that uniquely identifies the relationship
+ * @function getPopulateKey
+ * @memberOf module:core
+ */
 export declare function getPopulateKey(tableName: string, fieldName: string, id: string | number): string;
+/**
+ * @description Caches a model for later population
+ * @summary Stores a model in the context cache for efficient retrieval during relationship population
+ * @template M - The model type extending Model
+ * @template F - The repository flags type
+ * @param {Context<F>} context - The context for the operation
+ * @param {M} parentModel - The parent model that contains the relationship
+ * @param propertyKey - The property key of the relationship
+ * @param {string | number} pkValue - The primary key value of the related model
+ * @param {any} cacheValue - The model instance to cache
+ * @return {Promise<any>} A promise that resolves with the result of the cache operation
+ * @function cacheModelForPopulate
+ * @memberOf module:core
+ */
 export declare function cacheModelForPopulate<M extends Model, F extends RepositoryFlags>(context: Context<F>, parentModel: M, propertyKey: keyof M | string, pkValue: string | number, cacheValue: any): Promise<Context<F & {
     [x: string]: any;
 }>>;
+/**
+ * @description Populates a model's relationship
+ * @summary Retrieves and attaches related models to a model's relationship property
+ * @template M - The model type extending Model
+ * @template R - The repository type extending Repo<M, F, C>
+ * @template V - The relations metadata type extending RelationsMetadata
+ * @template F - The repository flags type
+ * @template C - The context type extending Context<F>
+ * @param {R} this - The repository instance
+ * @param {Context<F>} context - The context for the operation
+ * @param {V} data - The relations metadata
+ * @param key - The property key of the relationship
+ * @param {M} model - The model instance
+ * @return {Promise<void>} A promise that resolves when the operation is complete
+ * @function populate
+ * @memberOf module:core
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant populate
+ *   participant fetchPopulateValues
+ *   participant getPopulateKey
+ *   participant Context
+ *   participant repositoryFromTypeMetadata
+ *
+ *   Caller->>populate: this, context, data, key, model
+ *   populate->>populate: check if data.populate is true
+ *   populate->>populate: get nested value and check if it exists
+ *
+ *   populate->>fetchPopulateValues: context, model, key, isArr ? nested : [nested]
+ *
+ *   fetchPopulateValues->>fetchPopulateValues: initialize variables
+ *
+ *   loop for each proKeyValue in propKeyValues
+ *     fetchPopulateValues->>getPopulateKey: model.constructor.name, propName, proKeyValue
+ *     getPopulateKey-->>fetchPopulateValues: cacheKey
+ *
+ *     alt try to get from cache
+ *       fetchPopulateValues->>Context: get(cacheKey)
+ *       Context-->>fetchPopulateValues: val
+ *     else catch error
+ *       fetchPopulateValues->>repositoryFromTypeMetadata: model, propName
+ *       repositoryFromTypeMetadata-->>fetchPopulateValues: repo
+ *       fetchPopulateValues->>repo: read(proKeyValue)
+ *       repo-->>fetchPopulateValues: val
+ *     end
+ *
+ *     fetchPopulateValues->>fetchPopulateValues: add val to results
+ *   end
+ *
+ *   fetchPopulateValues-->>populate: results
+ *   populate->>populate: set model[key] = isArr ? res : res[0]
+ *   populate-->>Caller: void
+ */
 export declare function populate<M extends Model, R extends Repo<M, F, C>, V extends RelationsMetadata, F extends RepositoryFlags, C extends Context<F>>(this: R, context: Context<F>, data: V, key: keyof M, model: M): Promise<void>;
+/**
+ * @description Retrieves a repository for a model property based on its type metadata
+ * @summary Examines a model property's type metadata to determine the appropriate repository for related models
+ * @template M - The model type extending Model
+ * @param {any} model - The model instance containing the property
+ * @param propertyKey - The property key to examine
+ * @return {Repo<M>} A repository for the model type associated with the property
+ * @function repositoryFromTypeMetadata
+ * @memberOf module:core
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant repositoryFromTypeMetadata
+ *   participant Reflect
+ *   participant Validation
+ *   participant Model
+ *   participant Repository
+ *
+ *   Caller->>repositoryFromTypeMetadata: model, propertyKey
+ *
+ *   repositoryFromTypeMetadata->>Validation: key(Array.isArray(model[propertyKey]) ? ValidationKeys.LIST : ValidationKeys.TYPE)
+ *   Validation-->>repositoryFromTypeMetadata: validationKey
+ *
+ *   repositoryFromTypeMetadata->>Reflect: getMetadata(validationKey, model, propertyKey)
+ *   Reflect-->>repositoryFromTypeMetadata: types
+ *
+ *   repositoryFromTypeMetadata->>repositoryFromTypeMetadata: determine customTypes based on property type
+ *   repositoryFromTypeMetadata->>repositoryFromTypeMetadata: check if types and customTypes exist
+ *
+ *   repositoryFromTypeMetadata->>repositoryFromTypeMetadata: create allowedTypes array
+ *   repositoryFromTypeMetadata->>repositoryFromTypeMetadata: find constructorName not in commomTypes
+ *   repositoryFromTypeMetadata->>repositoryFromTypeMetadata: check if constructorName exists
+ *
+ *   repositoryFromTypeMetadata->>Model: get(constructorName)
+ *   Model-->>repositoryFromTypeMetadata: constructor
+ *   repositoryFromTypeMetadata->>repositoryFromTypeMetadata: check if constructor exists
+ *
+ *   repositoryFromTypeMetadata->>Repository: forModel(constructor)
+ *   Repository-->>repositoryFromTypeMetadata: repo
+ *
+ *   repositoryFromTypeMetadata-->>Caller: repo
+ */
 export declare function repositoryFromTypeMetadata<M extends Model>(model: any, propertyKey: string | keyof M): Repo<M>;