@decaf-ts/core 0.5.0 → 0.5.2

package/lib/repository/Repository.d.ts

@@ -1,6 +1,6 @@
-import { Context, IRepository, Repository as Rep, RepositoryFlags } from "@decaf-ts/db-decorators";
+import { BulkCrudOperationKeys, Context, IRepository, OperationKeys, Repository as Rep, RepositoryFlags } from "@decaf-ts/db-decorators";
 import { Observable } from "../interfaces/Observable";
-import { Observer } from "../interfaces/Observer";
+import { type Observer } from "../interfaces/Observer";
 import { Adapter } from "../persistence/Adapter";
 import { Constructor, Model } from "@decaf-ts/decorator-validation";
 import { OrderDirection } from "./constants";
@@ -10,64 +10,423 @@ import { IndexMetadata } from "./types";
 import { Condition } from "../query/Condition";
 import { WhereOption } from "../query/options";
 import { SelectSelector } from "../query/selectors";
-export type Repo<M extends Model, Q = any, F extends RepositoryFlags = RepositoryFlags, C extends Context<F> = Context<F>, A extends Adapter<any, Q, F, C> = Adapter<any, Q, F, C>> = Repository<M, Q, A, F, C>;
-export declare class Repository<M extends Model, Q, A extends Adapter<any, Q, F, C>, F extends RepositoryFlags = RepositoryFlags, C extends Context<F> = Context<F>> extends Rep<M, F, C> implements Observable, Queriable, IRepository<M, F, C> {
+import { Logger } from "@decaf-ts/logging";
+import { ObserverHandler } from "../persistence/ObserverHandler";
+import type { EventIds, ObserverFilter } from "../persistence";
+/**
+ * @description Type alias for Repository class with simplified generic parameters.
+ * @summary Provides a more concise way to reference the Repository class with its generic parameters.
+ * @template M - The model type that extends Model.
+ * @template F - The repository flags type.
+ * @template C - The context type.
+ * @template Q - The query type.
+ * @template A - The adapter type.
+ * @typedef Repo
+ * @memberOf module:core
+ */
+export type Repo<M extends Model, F extends RepositoryFlags = any, C extends Context<F> = any, Q = any, A extends Adapter<any, Q, F, C> = any> = Repository<M, Q, A, F, C>;
+/**
+ * @description Core repository implementation for database operations on models on a table by table way.
+ * @summary Provides CRUD operations, querying capabilities, and observer pattern implementation for model persistence.
+ * @template M - The model type that extends Model.
+ * @template Q - The query type used by the adapter.
+ * @template A - The adapter type for database operations.
+ * @template F - The repository flags type.
+ * @template C - The context type for operations.
+ * @param {A} [adapter] - Optional adapter instance for database operations.
+ * @param {Constructor<M>} [clazz] - Optional constructor for the model class.
+ * @param {...any[]} [args] - Additional arguments for repository initialization.
+ * @class Repository
+ * @example
+ * // Creating a repository for User model
+ * const userRepo = Repository.forModel(User);
+ *
+ * // Using the repository for CRUD operations
+ * const user = await userRepo.create(new User({ name: 'John' }));
+ * const retrievedUser = await userRepo.read(user.id);
+ * user.name = 'Jane';
+ * await userRepo.update(user);
+ * await userRepo.delete(user.id);
+ *
+ * // Querying with conditions
+ * const users = await userRepo
+ *   .select()
+ *   .where({ name: 'Jane' })
+ *   .orderBy('createdAt', OrderDirection.DSC)
+ *   .limit(10)
+ *   .execute();
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Client Code
+ *   participant R as Repository
+ *   participant A as Adapter
+ *   participant DB as Database
+ *   participant O as Observers
+ *
+ *   C->>+R: create(model)
+ *   R->>R: createPrefix(model)
+ *   R->>+A: prepare(model)
+ *   A-->>-R: prepared data
+ *   R->>+A: create(table, id, record)
+ *   A->>+DB: Insert Operation
+ *   DB-->>-A: Result
+ *   A-->>-R: record
+ *   R->>+A: revert(record)
+ *   A-->>-R: model instance
+ *   R->>R: createSuffix(model)
+ *   R->>+O: updateObservers(table, CREATE, id)
+ *   O-->>-R: Notification complete
+ *   R-->>-C: created model
+ */
+export declare class Repository<M extends Model, Q, A extends Adapter<any, Q, F, C>, F extends RepositoryFlags = RepositoryFlags, C extends Context<F> = Context<F>> extends Rep<M, F, C> implements Observable, Observer, Queriable<M>, IRepository<M, F, C> {
     private static _cache;
     protected observers: Observer[];
+    protected observerHandler?: ObserverHandler;
     private readonly _adapter;
     private _tableName;
     private _overrides?;
+    private logger;
+    /**
+     * @description Logger instance for this repository.
+     * @summary Provides access to the logger for this repository instance.
+     * @return {Logger} The logger instance.
+     */
+    get log(): Logger;
+    /**
+     * @description Adapter for database operations.
+     * @summary Provides access to the adapter instance for this repository.
+     * @template A - The adapter type.
+     * @return {A} The adapter instance.
+     * @throws {InternalError} If no adapter is found.
+     */
     protected get adapter(): A;
+    /**
+     * @description Table name for this repository's model.
+     * @summary Gets the database table name associated with this repository's model.
+     * @return {string} The table name.
+     */
     protected get tableName(): string;
-    constructor(adapter?: A, clazz?: Constructor<M>);
-    override(flags: Partial<F>): this;
+    /**
+     * @description Primary key properties for this repository's model.
+     * @summary Gets the sequence options containing primary key information.
+     * @return {SequenceOptions} The primary key properties.
+     */
+    protected get pkProps(): SequenceOptions;
+    constructor(adapter?: A, clazz?: Constructor<M>, ...args: any[]);
+    /**
+     * @description Creates a proxy with overridden repository flags.
+     * @summary Returns a proxy of this repository with the specified flags overridden.
+     * @param {Partial<F>} flags - The flags to override.
+     * @return {Repository} A proxy of this repository with overridden flags.
+     */
+    override(flags: Partial<F>): Repository<M, Q, A, F, C>;
+    /**
+     * @description Creates a new observer handler.
+     * @summary Factory method for creating an observer handler instance.
+     * @return {ObserverHandler} A new observer handler instance.
+     */
+    protected ObserverHandler(): ObserverHandler;
+    /**
+     * @description Prepares a model for creation.
+     * @summary Validates the model and prepares it for creation in the database.
+     * @template M - The model type.
+     * @param {M} model - The model to create.
+     * @param {...any[]} args - Additional arguments.
+     * @return The prepared model and context arguments.
+     * @throws {ValidationError} If the model fails validation.
+     */
     protected createPrefix(model: M, ...args: any[]): Promise<[M, ...any[]]>;
+    /**
+     * @description Creates a model in the database.
+     * @summary Persists a model instance to the database.
+     * @param {M} model - The model to create.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<M>} The created model with updated properties.
+     */
     create(model: M, ...args: any[]): Promise<M>;
+    /**
+     * @description Post-creation hook.
+     * @summary Executes after a model is created to perform additional operations.
+     * @param {M} model - The created model.
+     * @param {C} context - The operation context.
+     * @return {Promise<M>} The processed model.
+     */
     createSuffix(model: M, context: C): Promise<M>;
+    /**
+     * @description Creates multiple models in the database.
+     * @summary Persists multiple model instances to the database in a batch operation.
+     * @param {M[]} models - The models to create.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<M[]>} The created models with updated properties.
+     */
     createAll(models: M[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Prepares multiple models for creation.
+     * @summary Validates multiple models and prepares them for creation in the database.
+     * @param {M[]} models - The models to create.
+     * @param {...any[]} args - Additional arguments.
+     * @return The prepared models and context arguments.
+     * @throws {ValidationError} If any model fails validation.
+     */
     protected createAllPrefix(models: M[], ...args: any[]): Promise<any[]>;
+    /**
+     * @description Prepares for reading a model by ID.
+     * @summary Prepares the context and enforces decorators before reading a model.
+     * @param {string} key - The primary key of the model to read.
+     * @param {...any[]} args - Additional arguments.
+     * @return The key and context arguments.
+     */
     protected readPrefix(key: string, ...args: any[]): Promise<any[]>;
+    /**
+     * @description Reads a model from the database by ID.
+     * @summary Retrieves a model instance from the database using its primary key.
+     * @param {string|number|bigint} id - The primary key of the model to read.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<M>} The retrieved model instance.
+     */
     read(id: string | number | bigint, ...args: any[]): Promise<M>;
+    /**
+     * @description Prepares for reading multiple models by IDs.
+     * @summary Prepares the context and enforces decorators before reading multiple models.
+     * @param {string[]|number[]} keys - The primary keys of the models to read.
+     * @param {...any[]} args - Additional arguments.
+     * @return The keys and context arguments.
+     */
     protected readAllPrefix(keys: string[] | number[], ...args: any[]): Promise<any[]>;
+    /**
+     * @description Reads multiple models from the database by IDs.
+     * @summary Retrieves multiple model instances from the database using their primary keys.
+     * @param {string[]|number[]} keys - The primary keys of the models to read.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<M[]>} The retrieved model instances.
+     */
     readAll(keys: string[] | number[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Updates a model in the database.
+     * @summary Persists changes to an existing model instance in the database.
+     * @param {M} model - The model to update.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<M>} The updated model with refreshed properties.
+     */
     update(model: M, ...args: any[]): Promise<M>;
+    /**
+     * @description Prepares a model for update.
+     * @summary Validates the model and prepares it for update in the database.
+     * @param {M} model - The model to update.
+     * @param {...any[]} args - Additional arguments.
+     * @return The prepared model and context arguments.
+     * @throws {InternalError} If the model has no primary key value.
+     * @throws {ValidationError} If the model fails validation.
+     */
     protected updatePrefix(model: M, ...args: any[]): Promise<[M, ...args: any[]]>;
+    /**
+     * @description Updates multiple models in the database.
+     * @summary Persists changes to multiple existing model instances in the database in a batch operation.
+     * @param {M[]} models - The models to update.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<M[]>} The updated models with refreshed properties.
+     */
     updateAll(models: M[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Prepares multiple models for update.
+     * @summary Validates multiple models and prepares them for update in the database.
+     * @param {M[]} models - The models to update.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<any[]>} The prepared models and context arguments.
+     * @throws {InternalError} If any model has no primary key value.
+     * @throws {ValidationError} If any model fails validation.
+     */
     protected updateAllPrefix(models: M[], ...args: any[]): Promise<any[]>;
+    /**
+     * @description Prepares for deleting a model by ID.
+     * @summary Prepares the context and enforces decorators before deleting a model.
+     * @param {any} key - The primary key of the model to delete.
+     * @param {...any[]} args - Additional arguments.
+     * @return The key and context arguments.
+     */
     protected deletePrefix(key: any, ...args: any[]): Promise<any[]>;
+    /**
+     * @description Deletes a model from the database by ID.
+     * @summary Removes a model instance from the database using its primary key.
+     * @param {string|number|bigint} id - The primary key of the model to delete.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<M>} The deleted model instance.
+     */
     delete(id: string | number | bigint, ...args: any[]): Promise<M>;
+    /**
+     * @description Prepares for deleting multiple models by IDs.
+     * @summary Prepares the context and enforces decorators before deleting multiple models.
+     * @param {string[]|number[]} keys - The primary keys of the models to delete.
+     * @param {...any[]} args - Additional arguments.
+     * @return The keys and context arguments.
+     */
     protected deleteAllPrefix(keys: string[] | number[], ...args: any[]): Promise<any[]>;
+    /**
+     * @description Deletes multiple models from the database by IDs.
+     * @summary Removes multiple model instances from the database using their primary keys.
+     * @param {string[]|number[]} keys - The primary keys of the models to delete.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<M[]>} The deleted model instances.
+     */
     deleteAll(keys: string[] | number[], ...args: any[]): Promise<M[]>;
-    select(selector?: SelectSelector): WhereOption;
-    query<V>(condition: Condition, orderBy: string, order?: OrderDirection, limit?: number, skip?: number): Promise<V>;
     /**
-     * @summary Registers an {@link Observer}
-     * @param {Observer} observer
-     *
+     * @description Creates a select query without specifying fields.
+     * @summary Starts building a query that will return all fields of the model.
+     * @template S - The array type of select selectors.
+     * @return A query builder for the model.
+     */
+    select<S extends readonly SelectSelector<M>[]>(): WhereOption<M, M[]>;
+    /**
+     * @description Creates a select query with specific fields.
+     * @summary Starts building a query that will return only the specified fields of the model.
+     * @template S - The array type of select selectors.
+     * @param selector - The fields to select.
+     * @return A query builder for the selected fields.
+     */
+    select<S extends readonly SelectSelector<M>[]>(selector: readonly [...S]): WhereOption<M, Pick<M, S[number]>[]>;
+    /**
+     * @description Executes a query with the specified conditions and options.
+     * @summary Provides a simplified way to query the database with common query parameters.
+     * @param {Condition<M>} condition - The condition to filter records.
+     * @param orderBy - The field to order results by.
+     * @param {OrderDirection} [order=OrderDirection.ASC] - The sort direction.
+     * @param {number} [limit] - Optional maximum number of results to return.
+     * @param {number} [skip] - Optional number of results to skip.
+     * @return {Promise<M[]>} The query results as model instances.
+     */
+    query(condition: Condition<M>, orderBy: keyof M, order?: OrderDirection, limit?: number, skip?: number): Promise<M[]>;
+    /**
+     * @description Registers an observer for this repository.
+     * @summary Adds an observer that will be notified of changes to models in this repository.
+     * @param {Observer} observer - The observer to register.
+     * @param {ObserverFilter} [filter] - Optional filter to limit which events the observer receives.
+     * @return {void}
      * @see {Observable#observe}
      */
-    observe(observer: Observer): void;
+    observe(observer: Observer, filter?: ObserverFilter): void;
     /**
-     * @summary Unregisters an {@link Observer}
-     * @param {Observer} observer
-     *
+     * @description Unregisters an observer from this repository.
+     * @summary Removes an observer so it will no longer receive notifications of changes.
+     * @param {Observer} observer - The observer to unregister.
+     * @return {void}
+     * @throws {InternalError} If the observer handler is not initialized.
      * @see {Observable#unObserve}
      */
     unObserve(observer: Observer): void;
     /**
-     * @summary calls all registered {@link Observer}s to update themselves
-     * @param {any[]} [args] optional arguments to be passed to the {@link Observer#refresh} method
+     * @description Notifies all observers of an event.
+     * @summary Updates all registered observers with information about a database event.
+     * @param {string} table - The table name where the event occurred.
+     * @param {OperationKeys|BulkCrudOperationKeys|string} event - The type of event that occurred.
+     * @param {EventIds} id - The ID or IDs of the affected records.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<void>} A promise that resolves when all observers have been notified.
+     * @throws {InternalError} If the observer handler is not initialized.
+     */
+    updateObservers(table: string, event: OperationKeys | BulkCrudOperationKeys | string, id: EventIds, ...args: any[]): Promise<void>;
+    /**
+     * @description Alias for updateObservers.
+     * @summary Notifies all observers of an event (alias for updateObservers).
+     * @param {string} table - The table name where the event occurred.
+     * @param {OperationKeys|BulkCrudOperationKeys|string} event - The type of event that occurred.
+     * @param {EventIds} id - The ID or IDs of the affected records.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<void>} A promise that resolves when all observers have been notified.
+     */
+    refresh(table: string, event: OperationKeys | BulkCrudOperationKeys | string, id: EventIds, ...args: any[]): Promise<void>;
+    /**
+     * @description Creates or retrieves a repository for a model.
+     * @summary Factory method that returns a repository instance for the specified model.
+     * @template M - The model type that extends Model.
+     * @template R - The repository type that extends Repo<M>.
+     * @param {Constructor<M>} model - The model constructor.
+     * @param {string} [defaultFlavour] - Optional default adapter flavour if not specified on the model.
+     * @param {...any[]} [args] - Additional arguments to pass to the repository constructor.
+     * @return {R} A repository instance for the model.
+     * @throws {InternalError} If no adapter is registered for the flavour.
+     */
+    static forModel<M extends Model, R extends Repo<M>>(model: Constructor<M>, alias?: string, ...args: any[]): R;
+    /**
+     * @description Retrieves a repository for a model from the cache.
+     * @summary Gets a repository constructor or instance for the specified model from the internal cache.
+     * @template M - The model type that extends Model.
+     * @param {Constructor<M>} model - The model constructor.
+     * @return {Constructor<Repo<M>> | Repo<M>} The repository constructor or instance.
+     * @throws {InternalError} If no repository is registered for the model.
      */
-    updateObservers(...args: any[]): Promise<void>;
-    static forModel<M extends Model, R extends Repo<M>>(model: Constructor<M>, defaultFlavour?: string): R;
     private static get;
-    static register<M extends Model>(model: Constructor<M>, repo: Constructor<Repo<M>> | Repo<M>): void;
+    /**
+     * @description Registers a repository for a model.
+     * @summary Associates a repository constructor or instance with a model in the internal cache.
+     * @template M - The model type that extends Model.
+     * @param {Constructor<M>} model - The model constructor.
+     * @param {Constructor<Repo<M>> | Repo<M>} repo - The repository constructor or instance.
+     * @throws {InternalError} If a repository is already registered for the model.
+     */
+    static register<M extends Model>(model: Constructor<M>, repo: Constructor<Repo<M>> | Repo<M>, alias?: string): void;
+    /**
+     * @description Sets metadata on a model instance.
+     * @summary Attaches metadata to a model instance using a non-enumerable property.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     * @param {any} metadata - The metadata to attach to the model.
+     */
     static setMetadata<M extends Model>(model: M, metadata: any): void;
+    /**
+     * @description Gets metadata from a model instance.
+     * @summary Retrieves previously attached metadata from a model instance.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     * @return {any} The metadata or undefined if not found.
+     */
     static getMetadata<M extends Model>(model: M): any;
+    /**
+     * @description Removes metadata from a model instance.
+     * @summary Deletes the metadata property from a model instance.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     */
     static removeMetadata<M extends Model>(model: M): void;
+    /**
+     * @description Gets sequence options for a model's primary key.
+     * @summary Retrieves the sequence configuration for a model's primary key from metadata.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     * @return {SequenceOptions} The sequence options for the model's primary key.
+     * @throws {InternalError} If no sequence options are defined for the model.
+     */
     static getSequenceOptions<M extends Model>(model: M): SequenceOptions;
+    /**
+     * @description Gets all indexes defined on a model.
+     * @summary Retrieves all index metadata from a model's property decorators.
+     * @template M - The model type that extends Model.
+     * @param {M | Constructor<M>} model - The model instance or constructor.
+     * @return {Record<string, Record<string, IndexMetadata>>} A nested record of property names to index metadata.
+     */
     static indexes<M extends Model>(model: M | Constructor<M>): Record<string, Record<string, IndexMetadata>>;
+    /**
+     * @description Gets all relation properties defined on a model.
+     * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+     * @template M - The model type that extends Model.
+     * @param {M | Constructor<M>} model - The model instance or constructor.
+     * @return {string[]} An array of property names that are relations.
+     */
     static relations<M extends Model>(model: M | Constructor<M>): string[];
-    static table<M extends Model>(model: M | Constructor<M>): any;
-    static column<M extends Model>(model: M, attribute: string): any;
+    /**
+     * @description Gets the table name for a model.
+     * @summary Retrieves the database table name associated with a model.
+     * @template M - The model type that extends Model.
+     * @param {M | Constructor<M>} model - The model instance or constructor.
+     * @return {string} The table name for the model.
+     */
+    static table<M extends Model>(model: M | Constructor<M>): string;
+    /**
+     * @description Gets the column name for a model attribute.
+     * @summary Retrieves the database column name for a model property.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     * @param {string} attribute - The attribute/property name.
+     * @return {string} The column name for the attribute.
+     */
+    static column<M extends Model>(model: M, attribute: string): string;
 }

package/lib/repository/constants.cjs

@@ -2,32 +2,42 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultCascade = exports.Cascade = exports.OrderDirection = void 0;
 /**
- * @summary defines order directions when sorting
- *
- * @constant OrderDirection
- *
- * @category Query
+ * @description Enumeration of possible sort directions.
+ * @summary Defines the available sort directions for ordering query results.
+ * @enum {string}
+ * @readonly
+ * @memberOf module:core
  */
 var OrderDirection;
 (function (OrderDirection) {
-    /**
-     * @summary Defines the sort order as ascending
-     * @prop ASC
-     */
+    /** Ascending order (A to Z, 0 to 9) */
     OrderDirection["ASC"] = "asc";
-    /**
-     * @summary Defines the sort order as descending
-     * @property {string} DSC
-     */
+    /** Descending order (Z to A, 9 to 0) */
     OrderDirection["DSC"] = "desc";
 })(OrderDirection || (exports.OrderDirection = OrderDirection = {}));
+/**
+ * @description Enumeration of cascade operation types.
+ * @summary Defines the available cascade behaviors for entity relationships.
+ * @enum {string}
+ * @readonly
+ * @memberOf module:core
+ */
 var Cascade;
 (function (Cascade) {
+    /** Perform cascade operation on related entities */
     Cascade["CASCADE"] = "cascade";
+    /** Do not perform cascade operation on related entities */
     Cascade["NONE"] = "none";
 })(Cascade || (exports.Cascade = Cascade = {}));
+/**
+ * @description Default cascade configuration for entity relationships.
+ * @summary Provides the default cascade behavior where updates cascade but deletes do not.
+ * @type {CascadeMetadata}
+ * @const DefaultCascade
+ * @memberOf module:core
+ */
 exports.DefaultCascade = {
     update: Cascade.CASCADE,
     delete: Cascade.NONE,
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3JlcG9zaXRvcnkvY29uc3RhbnRzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUVBOzs7Ozs7R0FNRztBQUNILElBQVksY0FXWDtBQVhELFdBQVksY0FBYztJQUN4Qjs7O09BR0c7SUFDSCw2QkFBVyxDQUFBO0lBQ1g7OztPQUdHO0lBQ0gsOEJBQVksQ0FBQTtBQUNkLENBQUMsRUFYVyxjQUFjLDhCQUFkLGNBQWMsUUFXekI7QUFFRCxJQUFZLE9BR1g7QUFIRCxXQUFZLE9BQU87SUFDakIsOEJBQW1CLENBQUE7SUFDbkIsd0JBQWEsQ0FBQTtBQUNmLENBQUMsRUFIVyxPQUFPLHVCQUFQLE9BQU8sUUFHbEI7QUFFWSxRQUFBLGNBQWMsR0FBb0I7SUFDN0MsTUFBTSxFQUFFLE9BQU8sQ0FBQyxPQUFPO0lBQ3ZCLE1BQU0sRUFBRSxPQUFPLENBQUMsSUFBSTtDQUNyQixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQ2FzY2FkZU1ldGFkYXRhIH0gZnJvbSBcIi4vdHlwZXNcIjtcblxuLyoqXG4gKiBAc3VtbWFyeSBkZWZpbmVzIG9yZGVyIGRpcmVjdGlvbnMgd2hlbiBzb3J0aW5nXG4gKlxuICogQGNvbnN0YW50IE9yZGVyRGlyZWN0aW9uXG4gKlxuICogQGNhdGVnb3J5IFF1ZXJ5XG4gKi9cbmV4cG9ydCBlbnVtIE9yZGVyRGlyZWN0aW9uIHtcbiAgLyoqXG4gICAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIHNvcnQgb3JkZXIgYXMgYXNjZW5kaW5nXG4gICAqIEBwcm9wIEFTQ1xuICAgKi9cbiAgQVNDID0gXCJhc2NcIixcbiAgLyoqXG4gICAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIHNvcnQgb3JkZXIgYXMgZGVzY2VuZGluZ1xuICAgKiBAcHJvcGVydHkge3N0cmluZ30gRFNDXG4gICAqL1xuICBEU0MgPSBcImRlc2NcIixcbn1cblxuZXhwb3J0IGVudW0gQ2FzY2FkZSB7XG4gIENBU0NBREUgPSBcImNhc2NhZGVcIixcbiAgTk9ORSA9IFwibm9uZVwiLFxufVxuXG5leHBvcnQgY29uc3QgRGVmYXVsdENhc2NhZGU6IENhc2NhZGVNZXRhZGF0YSA9IHtcbiAgdXBkYXRlOiBDYXNjYWRlLkNBU0NBREUsXG4gIGRlbGV0ZTogQ2FzY2FkZS5OT05FLFxufTtcbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3JlcG9zaXRvcnkvY29uc3RhbnRzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUVBOzs7Ozs7R0FNRztBQUNILElBQVksY0FNWDtBQU5ELFdBQVksY0FBYztJQUN4Qix1Q0FBdUM7SUFDdkMsNkJBQVcsQ0FBQTtJQUVYLHdDQUF3QztJQUN4Qyw4QkFBWSxDQUFBO0FBQ2QsQ0FBQyxFQU5XLGNBQWMsOEJBQWQsY0FBYyxRQU16QjtBQUVEOzs7Ozs7R0FNRztBQUNILElBQVksT0FLWDtBQUxELFdBQVksT0FBTztJQUNqQixvREFBb0Q7SUFDcEQsOEJBQW1CLENBQUE7SUFDbkIsMkRBQTJEO0lBQzNELHdCQUFhLENBQUE7QUFDZixDQUFDLEVBTFcsT0FBTyx1QkFBUCxPQUFPLFFBS2xCO0FBRUQ7Ozs7OztHQU1HO0FBQ1UsUUFBQSxjQUFjLEdBQW9CO0lBQzdDLE1BQU0sRUFBRSxPQUFPLENBQUMsT0FBTztJQUN2QixNQUFNLEVBQUUsT0FBTyxDQUFDLElBQUk7Q0FDckIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENhc2NhZGVNZXRhZGF0YSB9IGZyb20gXCIuL3R5cGVzXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEVudW1lcmF0aW9uIG9mIHBvc3NpYmxlIHNvcnQgZGlyZWN0aW9ucy5cbiAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIGF2YWlsYWJsZSBzb3J0IGRpcmVjdGlvbnMgZm9yIG9yZGVyaW5nIHF1ZXJ5IHJlc3VsdHMuXG4gKiBAZW51bSB7c3RyaW5nfVxuICogQHJlYWRvbmx5XG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGVudW0gT3JkZXJEaXJlY3Rpb24ge1xuICAvKiogQXNjZW5kaW5nIG9yZGVyIChBIHRvIFosIDAgdG8gOSkgKi9cbiAgQVNDID0gXCJhc2NcIixcblxuICAvKiogRGVzY2VuZGluZyBvcmRlciAoWiB0byBBLCA5IHRvIDApICovXG4gIERTQyA9IFwiZGVzY1wiLFxufVxuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBFbnVtZXJhdGlvbiBvZiBjYXNjYWRlIG9wZXJhdGlvbiB0eXBlcy5cbiAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIGF2YWlsYWJsZSBjYXNjYWRlIGJlaGF2aW9ycyBmb3IgZW50aXR5IHJlbGF0aW9uc2hpcHMuXG4gKiBAZW51bSB7c3RyaW5nfVxuICogQHJlYWRvbmx5XG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGVudW0gQ2FzY2FkZSB7XG4gIC8qKiBQZXJmb3JtIGNhc2NhZGUgb3BlcmF0aW9uIG9uIHJlbGF0ZWQgZW50aXRpZXMgKi9cbiAgQ0FTQ0FERSA9IFwiY2FzY2FkZVwiLFxuICAvKiogRG8gbm90IHBlcmZvcm0gY2FzY2FkZSBvcGVyYXRpb24gb24gcmVsYXRlZCBlbnRpdGllcyAqL1xuICBOT05FID0gXCJub25lXCIsXG59XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIERlZmF1bHQgY2FzY2FkZSBjb25maWd1cmF0aW9uIGZvciBlbnRpdHkgcmVsYXRpb25zaGlwcy5cbiAqIEBzdW1tYXJ5IFByb3ZpZGVzIHRoZSBkZWZhdWx0IGNhc2NhZGUgYmVoYXZpb3Igd2hlcmUgdXBkYXRlcyBjYXNjYWRlIGJ1dCBkZWxldGVzIGRvIG5vdC5cbiAqIEB0eXBlIHtDYXNjYWRlTWV0YWRhdGF9XG4gKiBAY29uc3QgRGVmYXVsdENhc2NhZGVcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgY29uc3QgRGVmYXVsdENhc2NhZGU6IENhc2NhZGVNZXRhZGF0YSA9IHtcbiAgdXBkYXRlOiBDYXNjYWRlLkNBU0NBREUsXG4gIGRlbGV0ZTogQ2FzY2FkZS5OT05FLFxufTtcbiJdfQ==

package/lib/repository/constants.d.ts

@@ -1,25 +1,35 @@
 import { CascadeMetadata } from "./types";
 /**
- * @summary defines order directions when sorting
- *
- * @constant OrderDirection
- *
- * @category Query
+ * @description Enumeration of possible sort directions.
+ * @summary Defines the available sort directions for ordering query results.
+ * @enum {string}
+ * @readonly
+ * @memberOf module:core
  */
 export declare enum OrderDirection {
-    /**
-     * @summary Defines the sort order as ascending
-     * @prop ASC
-     */
+    /** Ascending order (A to Z, 0 to 9) */
     ASC = "asc",
-    /**
-     * @summary Defines the sort order as descending
-     * @property {string} DSC
-     */
+    /** Descending order (Z to A, 9 to 0) */
     DSC = "desc"
 }
+/**
+ * @description Enumeration of cascade operation types.
+ * @summary Defines the available cascade behaviors for entity relationships.
+ * @enum {string}
+ * @readonly
+ * @memberOf module:core
+ */
 export declare enum Cascade {
+    /** Perform cascade operation on related entities */
     CASCADE = "cascade",
+    /** Do not perform cascade operation on related entities */
     NONE = "none"
 }
+/**
+ * @description Default cascade configuration for entity relationships.
+ * @summary Provides the default cascade behavior where updates cascade but deletes do not.
+ * @type {CascadeMetadata}
+ * @const DefaultCascade
+ * @memberOf module:core
+ */
 export declare const DefaultCascade: CascadeMetadata;

package/lib/repository/decorators.cjs

@@ -5,6 +5,33 @@ const injectable_decorators_1 = require("@decaf-ts/injectable-decorators");
 const db_decorators_1 = require("@decaf-ts/db-decorators");
 const reflection_1 = require("@decaf-ts/reflection");
 const Repository_1 = require("./Repository.cjs");
+/**
+ * @description Repository decorator for model classes.
+ * @summary Creates and registers a repository for a model class. Can be used as both a property decorator and a class decorator.
+ * @template T - The model type that extends Model.
+ * @param {Constructor<T>} model - The constructor of the model class.
+ * @param {string} [nameOverride] - Optional name override for the repository.
+ * @return {any} - The decorator function.
+ * @function repository
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Client Code
+ *   participant D as Decorator
+ *   participant R as Repository
+ *   participant M as Metadata
+ *
+ *   C->>D: Apply @repository(Model)
+ *   alt Property Decorator
+ *     D->>D: Check if propertyKey exists
+ *     D->>+C: Return inject(name) decorator
+ *   else Class Decorator
+ *     D->>M: Set repository metadata on model
+ *     D->>R: Register model with Repository
+ *     D->>+C: Return injectable decorator with config
+ *     C->>C: Define DBKeys.CLASS property
+ *   end
+ * @category Decorators
+ */
 function repository(model, nameOverride) {
     return ((original, propertyKey) => {
         if (propertyKey) {
@@ -22,4 +49,4 @@ function repository(model, nameOverride) {
         })(original);
     });
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9yZXBvc2l0b3J5L2RlY29yYXRvcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFNQSxnQ0EyQkM7QUFqQ0QsMkVBQXFFO0FBQ3JFLDJEQUE4RDtBQUM5RCxxREFBZ0Q7QUFFaEQsaURBQTBDO0FBRTFDLFNBQWdCLFVBQVUsQ0FDeEIsS0FBcUIsRUFDckIsWUFBcUI7SUFFckIsT0FBTyxDQUFDLENBQUMsUUFBYSxFQUFFLFdBQWlCLEVBQUUsRUFBRTtRQUMzQyxJQUFJLFdBQVcsRUFBRSxDQUFDO1lBQ2hCLE9BQU8sSUFBQSw4QkFBTSxFQUFDLFlBQVksSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsUUFBUSxFQUFFLFdBQVcsQ0FBQyxDQUFDO1FBQ25FLENBQUM7UUFFRCxJQUFBLHFCQUFRLEVBQ04sdUJBQVUsQ0FBQyxHQUFHLENBQUMsc0JBQU0sQ0FBQyxVQUFVLENBQUMsRUFDakMsWUFBWSxJQUFJLFFBQVEsQ0FBQyxJQUFJLENBQzlCLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDVCx1QkFBVSxDQUFDLFFBQVEsQ0FBQyxLQUFLLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFDckMsT0FBTyxJQUFBLGtDQUFVLEVBQ2YsWUFBWSxJQUFJLFFBQVEsQ0FBQyxJQUFJLEVBQzdCLElBQUksRUFDSixDQUFDLFFBQXdCLEVBQUUsRUFBRTtZQUMzQixNQUFNLENBQUMsY0FBYyxDQUFDLFFBQVEsRUFBRSxzQkFBTSxDQUFDLEtBQUssRUFBRTtnQkFDNUMsVUFBVSxFQUFFLEtBQUs7Z0JBQ2pCLFlBQVksRUFBRSxLQUFLO2dCQUNuQixRQUFRLEVBQUUsS0FBSztnQkFDZixLQUFLLEVBQUUsS0FBSzthQUNiLENBQUMsQ0FBQztRQUNMLENBQUMsQ0FDRixDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ2QsQ0FBQyxDQUFRLENBQUM7QUFDWixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgaW5qZWN0LCBpbmplY3RhYmxlIH0gZnJvbSBcIkBkZWNhZi10cy9pbmplY3RhYmxlLWRlY29yYXRvcnNcIjtcbmltcG9ydCB7IERCS2V5cywgSVJlcG9zaXRvcnkgfSBmcm9tIFwiQGRlY2FmLXRzL2RiLWRlY29yYXRvcnNcIjtcbmltcG9ydCB7IG1ldGFkYXRhIH0gZnJvbSBcIkBkZWNhZi10cy9yZWZsZWN0aW9uXCI7XG5pbXBvcnQgeyBDb25zdHJ1Y3RvciwgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBSZXBvc2l0b3J5IH0gZnJvbSBcIi4vUmVwb3NpdG9yeVwiO1xuXG5leHBvcnQgZnVuY3Rpb24gcmVwb3NpdG9yeTxUIGV4dGVuZHMgTW9kZWw+KFxuICBtb2RlbDogQ29uc3RydWN0b3I8VD4sXG4gIG5hbWVPdmVycmlkZT86IHN0cmluZ1xuKTogYW55IHtcbiAgcmV0dXJuICgob3JpZ2luYWw6IGFueSwgcHJvcGVydHlLZXk/OiBhbnkpID0+IHtcbiAgICBpZiAocHJvcGVydHlLZXkpIHtcbiAgICAgIHJldHVybiBpbmplY3QobmFtZU92ZXJyaWRlIHx8IG1vZGVsLm5hbWUpKG9yaWdpbmFsLCBwcm9wZXJ0eUtleSk7XG4gICAgfVxuXG4gICAgbWV0YWRhdGEoXG4gICAgICBSZXBvc2l0b3J5LmtleShEQktleXMuUkVQT1NJVE9SWSksXG4gICAgICBuYW1lT3ZlcnJpZGUgfHwgb3JpZ2luYWwubmFtZVxuICAgICkobW9kZWwpO1xuICAgIFJlcG9zaXRvcnkucmVnaXN0ZXIobW9kZWwsIG9yaWdpbmFsKTtcbiAgICByZXR1cm4gaW5qZWN0YWJsZShcbiAgICAgIG5hbWVPdmVycmlkZSB8fCBvcmlnaW5hbC5uYW1lLFxuICAgICAgdHJ1ZSxcbiAgICAgIChpbnN0YW5jZTogSVJlcG9zaXRvcnk8VD4pID0+IHtcbiAgICAgICAgT2JqZWN0LmRlZmluZVByb3BlcnR5KGluc3RhbmNlLCBEQktleXMuQ0xBU1MsIHtcbiAgICAgICAgICBlbnVtZXJhYmxlOiBmYWxzZSxcbiAgICAgICAgICBjb25maWd1cmFibGU6IGZhbHNlLFxuICAgICAgICAgIHdyaXRhYmxlOiBmYWxzZSxcbiAgICAgICAgICB2YWx1ZTogbW9kZWwsXG4gICAgICAgIH0pO1xuICAgICAgfVxuICAgICkob3JpZ2luYWwpO1xuICB9KSBhcyBhbnk7XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9yZXBvc2l0b3J5L2RlY29yYXRvcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFpQ0EsZ0NBMkJDO0FBNURELDJFQUFxRTtBQUNyRSwyREFBOEQ7QUFDOUQscURBQWdEO0FBRWhELGlEQUEwQztBQUUxQzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0EwQkc7QUFDSCxTQUFnQixVQUFVLENBQ3hCLEtBQXFCLEVBQ3JCLFlBQXFCO0lBRXJCLE9BQU8sQ0FBQyxDQUFDLFFBQWEsRUFBRSxXQUFpQixFQUFFLEVBQUU7UUFDM0MsSUFBSSxXQUFXLEVBQUUsQ0FBQztZQUNoQixPQUFPLElBQUEsOEJBQU0sRUFBQyxZQUFZLElBQUksS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLFFBQVEsRUFBRSxXQUFXLENBQUMsQ0FBQztRQUNuRSxDQUFDO1FBRUQsSUFBQSxxQkFBUSxFQUNOLHVCQUFVLENBQUMsR0FBRyxDQUFDLHNCQUFNLENBQUMsVUFBVSxDQUFDLEVBQ2pDLFlBQVksSUFBSSxRQUFRLENBQUMsSUFBSSxDQUM5QixDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQ1QsdUJBQVUsQ0FBQyxRQUFRLENBQUMsS0FBSyxFQUFFLFFBQVEsQ0FBQyxDQUFDO1FBQ3JDLE9BQU8sSUFBQSxrQ0FBVSxFQUNmLFlBQVksSUFBSSxRQUFRLENBQUMsSUFBSSxFQUM3QixJQUFJLEVBQ0osQ0FBQyxRQUF3QixFQUFFLEVBQUU7WUFDM0IsTUFBTSxDQUFDLGNBQWMsQ0FBQyxRQUFRLEVBQUUsc0JBQU0sQ0FBQyxLQUFLLEVBQUU7Z0JBQzVDLFVBQVUsRUFBRSxLQUFLO2dCQUNqQixZQUFZLEVBQUUsS0FBSztnQkFDbkIsUUFBUSxFQUFFLEtBQUs7Z0JBQ2YsS0FBSyxFQUFFLEtBQUs7YUFDYixDQUFDLENBQUM7UUFDTCxDQUFDLENBQ0YsQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUNkLENBQUMsQ0FBUSxDQUFDO0FBQ1osQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IGluamVjdCwgaW5qZWN0YWJsZSB9IGZyb20gXCJAZGVjYWYtdHMvaW5qZWN0YWJsZS1kZWNvcmF0b3JzXCI7XG5pbXBvcnQgeyBEQktleXMsIElSZXBvc2l0b3J5IH0gZnJvbSBcIkBkZWNhZi10cy9kYi1kZWNvcmF0b3JzXCI7XG5pbXBvcnQgeyBtZXRhZGF0YSB9IGZyb20gXCJAZGVjYWYtdHMvcmVmbGVjdGlvblwiO1xuaW1wb3J0IHsgQ29uc3RydWN0b3IsIE1vZGVsIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuaW1wb3J0IHsgUmVwb3NpdG9yeSB9IGZyb20gXCIuL1JlcG9zaXRvcnlcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gUmVwb3NpdG9yeSBkZWNvcmF0b3IgZm9yIG1vZGVsIGNsYXNzZXMuXG4gKiBAc3VtbWFyeSBDcmVhdGVzIGFuZCByZWdpc3RlcnMgYSByZXBvc2l0b3J5IGZvciBhIG1vZGVsIGNsYXNzLiBDYW4gYmUgdXNlZCBhcyBib3RoIGEgcHJvcGVydHkgZGVjb3JhdG9yIGFuZCBhIGNsYXNzIGRlY29yYXRvci5cbiAqIEB0ZW1wbGF0ZSBUIC0gVGhlIG1vZGVsIHR5cGUgdGhhdCBleHRlbmRzIE1vZGVsLlxuICogQHBhcmFtIHtDb25zdHJ1Y3RvcjxUPn0gbW9kZWwgLSBUaGUgY29uc3RydWN0b3Igb2YgdGhlIG1vZGVsIGNsYXNzLlxuICogQHBhcmFtIHtzdHJpbmd9IFtuYW1lT3ZlcnJpZGVdIC0gT3B0aW9uYWwgbmFtZSBvdmVycmlkZSBmb3IgdGhlIHJlcG9zaXRvcnkuXG4gKiBAcmV0dXJuIHthbnl9IC0gVGhlIGRlY29yYXRvciBmdW5jdGlvbi5cbiAqIEBmdW5jdGlvbiByZXBvc2l0b3J5XG4gKiBAbWVybWFpZFxuICogc2VxdWVuY2VEaWFncmFtXG4gKiAgIHBhcnRpY2lwYW50IEMgYXMgQ2xpZW50IENvZGVcbiAqICAgcGFydGljaXBhbnQgRCBhcyBEZWNvcmF0b3JcbiAqICAgcGFydGljaXBhbnQgUiBhcyBSZXBvc2l0b3J5XG4gKiAgIHBhcnRpY2lwYW50IE0gYXMgTWV0YWRhdGFcbiAqXG4gKiAgIEMtPj5EOiBBcHBseSBAcmVwb3NpdG9yeShNb2RlbClcbiAqICAgYWx0IFByb3BlcnR5IERlY29yYXRvclxuICogICAgIEQtPj5EOiBDaGVjayBpZiBwcm9wZXJ0eUtleSBleGlzdHNcbiAqICAgICBELT4+K0M6IFJldHVybiBpbmplY3QobmFtZSkgZGVjb3JhdG9yXG4gKiAgIGVsc2UgQ2xhc3MgRGVjb3JhdG9yXG4gKiAgICAgRC0+Pk06IFNldCByZXBvc2l0b3J5IG1ldGFkYXRhIG9uIG1vZGVsXG4gKiAgICAgRC0+PlI6IFJlZ2lzdGVyIG1vZGVsIHdpdGggUmVwb3NpdG9yeVxuICogICAgIEQtPj4rQzogUmV0dXJuIGluamVjdGFibGUgZGVjb3JhdG9yIHdpdGggY29uZmlnXG4gKiAgICAgQy0+PkM6IERlZmluZSBEQktleXMuQ0xBU1MgcHJvcGVydHlcbiAqICAgZW5kXG4gKiBAY2F0ZWdvcnkgRGVjb3JhdG9yc1xuICovXG5leHBvcnQgZnVuY3Rpb24gcmVwb3NpdG9yeTxUIGV4dGVuZHMgTW9kZWw+KFxuICBtb2RlbDogQ29uc3RydWN0b3I8VD4sXG4gIG5hbWVPdmVycmlkZT86IHN0cmluZ1xuKTogYW55IHtcbiAgcmV0dXJuICgob3JpZ2luYWw6IGFueSwgcHJvcGVydHlLZXk/OiBhbnkpID0+IHtcbiAgICBpZiAocHJvcGVydHlLZXkpIHtcbiAgICAgIHJldHVybiBpbmplY3QobmFtZU92ZXJyaWRlIHx8IG1vZGVsLm5hbWUpKG9yaWdpbmFsLCBwcm9wZXJ0eUtleSk7XG4gICAgfVxuXG4gICAgbWV0YWRhdGEoXG4gICAgICBSZXBvc2l0b3J5LmtleShEQktleXMuUkVQT1NJVE9SWSksXG4gICAgICBuYW1lT3ZlcnJpZGUgfHwgb3JpZ2luYWwubmFtZVxuICAgICkobW9kZWwpO1xuICAgIFJlcG9zaXRvcnkucmVnaXN0ZXIobW9kZWwsIG9yaWdpbmFsKTtcbiAgICByZXR1cm4gaW5qZWN0YWJsZShcbiAgICAgIG5hbWVPdmVycmlkZSB8fCBvcmlnaW5hbC5uYW1lLFxuICAgICAgdHJ1ZSxcbiAgICAgIChpbnN0YW5jZTogSVJlcG9zaXRvcnk8VD4pID0+IHtcbiAgICAgICAgT2JqZWN0LmRlZmluZVByb3BlcnR5KGluc3RhbmNlLCBEQktleXMuQ0xBU1MsIHtcbiAgICAgICAgICBlbnVtZXJhYmxlOiBmYWxzZSxcbiAgICAgICAgICBjb25maWd1cmFibGU6IGZhbHNlLFxuICAgICAgICAgIHdyaXRhYmxlOiBmYWxzZSxcbiAgICAgICAgICB2YWx1ZTogbW9kZWwsXG4gICAgICAgIH0pO1xuICAgICAgfVxuICAgICkob3JpZ2luYWwpO1xuICB9KSBhcyBhbnk7XG59XG4iXX0=

package/lib/repository/decorators.d.ts

@@ -1,2 +1,29 @@
 import { Constructor, Model } from "@decaf-ts/decorator-validation";
+/**
+ * @description Repository decorator for model classes.
+ * @summary Creates and registers a repository for a model class. Can be used as both a property decorator and a class decorator.
+ * @template T - The model type that extends Model.
+ * @param {Constructor<T>} model - The constructor of the model class.
+ * @param {string} [nameOverride] - Optional name override for the repository.
+ * @return {any} - The decorator function.
+ * @function repository
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Client Code
+ *   participant D as Decorator
+ *   participant R as Repository
+ *   participant M as Metadata
+ *
+ *   C->>D: Apply @repository(Model)
+ *   alt Property Decorator
+ *     D->>D: Check if propertyKey exists
+ *     D->>+C: Return inject(name) decorator
+ *   else Class Decorator
+ *     D->>M: Set repository metadata on model
+ *     D->>R: Register model with Repository
+ *     D->>+C: Return injectable decorator with config
+ *     C->>C: Define DBKeys.CLASS property
+ *   end
+ * @category Decorators
+ */
 export declare function repository<T extends Model>(model: Constructor<T>, nameOverride?: string): any;