@decaf-ts/core 0.5.1 → 0.5.3

package/lib/esm/ram/handlers.js

@@ -1,8 +1,27 @@
-import { UnsupportedError } from "../persistence";
+import { UnsupportedError } from "./../persistence/index.js";
+/**
+ * @description Sets the created by field on a model during RAM create/update operations
+ * @summary Automatically populates a model field with the UUID from the context during create or update operations.
+ * This function is designed to be used as a handler for RAM operations to track entity creation.
+ * @template M - Type of the model being created/updated
+ * @template R - Type of the repository handling the model
+ * @template V - Type of the relations metadata
+ * @template F - Type of the RAM flags
+ * @template C - Type of the context
+ * @param {R} this - The repository instance
+ * @param {Context<F>} context - The operation context containing user identification
+ * @param {V} data - The relations metadata
+ * @param key - The property key to set with the UUID
+ * @param {M} model - The model instance being created/updated
+ * @return {Promise<void>} A promise that resolves when the field has been set
+ * @function createdByOnRamCreateUpdate
+ * @memberOf module:core
+ * @category Ram
+ */
 export async function createdByOnRamCreateUpdate(context, data, key, model) {
     const uuid = context.get("UUID");
     if (!uuid)
         throw new UnsupportedError("This adapter does not support user identification");
     model[key] = uuid;
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGFuZGxlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcmFtL2hhbmRsZXJzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUtBLE9BQU8sRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBRWxELE1BQU0sQ0FBQyxLQUFLLFVBQVUsMEJBQTBCLENBUTlDLE9BQW1CLEVBQ25CLElBQU8sRUFDUCxHQUFZLEVBQ1osS0FBUTtJQUVSLE1BQU0sSUFBSSxHQUFXLE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDekMsSUFBSSxDQUFDLElBQUk7UUFDUCxNQUFNLElBQUksZ0JBQWdCLENBQ3hCLG1EQUFtRCxDQUNwRCxDQUFDO0lBQ0osS0FBSyxDQUFDLEdBQUcsQ0FBQyxHQUFHLElBQWtCLENBQUM7QUFDbEMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IE1vZGVsIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuaW1wb3J0IHsgUmVwbyB9IGZyb20gXCIuLi9yZXBvc2l0b3J5XCI7XG5pbXBvcnQgeyBSZWxhdGlvbnNNZXRhZGF0YSB9IGZyb20gXCIuLi9tb2RlbFwiO1xuaW1wb3J0IHsgUmFtRmxhZ3MgfSBmcm9tIFwiLi90eXBlc1wiO1xuaW1wb3J0IHsgQ29udGV4dCB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgVW5zdXBwb3J0ZWRFcnJvciB9IGZyb20gXCIuLi9wZXJzaXN0ZW5jZVwiO1xuXG5leHBvcnQgYXN5bmMgZnVuY3Rpb24gY3JlYXRlZEJ5T25SYW1DcmVhdGVVcGRhdGU8XG4gIE0gZXh0ZW5kcyBNb2RlbCxcbiAgUiBleHRlbmRzIFJlcG88TSwgRiwgQz4sXG4gIFYgZXh0ZW5kcyBSZWxhdGlvbnNNZXRhZGF0YSxcbiAgRiBleHRlbmRzIFJhbUZsYWdzLFxuICBDIGV4dGVuZHMgQ29udGV4dDxGPixcbj4oXG4gIHRoaXM6IFIsXG4gIGNvbnRleHQ6IENvbnRleHQ8Rj4sXG4gIGRhdGE6IFYsXG4gIGtleToga2V5b2YgTSxcbiAgbW9kZWw6IE1cbik6IFByb21pc2U8dm9pZD4ge1xuICBjb25zdCB1dWlkOiBzdHJpbmcgPSBjb250ZXh0LmdldChcIlVVSURcIik7XG4gIGlmICghdXVpZClcbiAgICB0aHJvdyBuZXcgVW5zdXBwb3J0ZWRFcnJvcihcbiAgICAgIFwiVGhpcyBhZGFwdGVyIGRvZXMgbm90IHN1cHBvcnQgdXNlciBpZGVudGlmaWNhdGlvblwiXG4gICAgKTtcbiAgbW9kZWxba2V5XSA9IHV1aWQgYXMgTVtrZXlvZiBNXTtcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGFuZGxlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcmFtL2hhbmRsZXJzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUtBLE9BQU8sRUFBRSxnQkFBZ0IsRUFBRSxrQ0FBdUI7QUFFbEQ7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQWtCRztBQUNILE1BQU0sQ0FBQyxLQUFLLFVBQVUsMEJBQTBCLENBUTlDLE9BQW1CLEVBQ25CLElBQU8sRUFDUCxHQUFZLEVBQ1osS0FBUTtJQUVSLE1BQU0sSUFBSSxHQUFXLE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDekMsSUFBSSxDQUFDLElBQUk7UUFDUCxNQUFNLElBQUksZ0JBQWdCLENBQ3hCLG1EQUFtRCxDQUNwRCxDQUFDO0lBQ0osS0FBSyxDQUFDLEdBQUcsQ0FBQyxHQUFHLElBQWtCLENBQUM7QUFDbEMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IE1vZGVsIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuaW1wb3J0IHsgUmVwbyB9IGZyb20gXCIuLi9yZXBvc2l0b3J5XCI7XG5pbXBvcnQgeyBSZWxhdGlvbnNNZXRhZGF0YSB9IGZyb20gXCIuLi9tb2RlbFwiO1xuaW1wb3J0IHsgUmFtRmxhZ3MgfSBmcm9tIFwiLi90eXBlc1wiO1xuaW1wb3J0IHsgQ29udGV4dCB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgVW5zdXBwb3J0ZWRFcnJvciB9IGZyb20gXCIuLi9wZXJzaXN0ZW5jZVwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBTZXRzIHRoZSBjcmVhdGVkIGJ5IGZpZWxkIG9uIGEgbW9kZWwgZHVyaW5nIFJBTSBjcmVhdGUvdXBkYXRlIG9wZXJhdGlvbnNcbiAqIEBzdW1tYXJ5IEF1dG9tYXRpY2FsbHkgcG9wdWxhdGVzIGEgbW9kZWwgZmllbGQgd2l0aCB0aGUgVVVJRCBmcm9tIHRoZSBjb250ZXh0IGR1cmluZyBjcmVhdGUgb3IgdXBkYXRlIG9wZXJhdGlvbnMuXG4gKiBUaGlzIGZ1bmN0aW9uIGlzIGRlc2lnbmVkIHRvIGJlIHVzZWQgYXMgYSBoYW5kbGVyIGZvciBSQU0gb3BlcmF0aW9ucyB0byB0cmFjayBlbnRpdHkgY3JlYXRpb24uXG4gKiBAdGVtcGxhdGUgTSAtIFR5cGUgb2YgdGhlIG1vZGVsIGJlaW5nIGNyZWF0ZWQvdXBkYXRlZFxuICogQHRlbXBsYXRlIFIgLSBUeXBlIG9mIHRoZSByZXBvc2l0b3J5IGhhbmRsaW5nIHRoZSBtb2RlbFxuICogQHRlbXBsYXRlIFYgLSBUeXBlIG9mIHRoZSByZWxhdGlvbnMgbWV0YWRhdGFcbiAqIEB0ZW1wbGF0ZSBGIC0gVHlwZSBvZiB0aGUgUkFNIGZsYWdzXG4gKiBAdGVtcGxhdGUgQyAtIFR5cGUgb2YgdGhlIGNvbnRleHRcbiAqIEBwYXJhbSB7Un0gdGhpcyAtIFRoZSByZXBvc2l0b3J5IGluc3RhbmNlXG4gKiBAcGFyYW0ge0NvbnRleHQ8Rj59IGNvbnRleHQgLSBUaGUgb3BlcmF0aW9uIGNvbnRleHQgY29udGFpbmluZyB1c2VyIGlkZW50aWZpY2F0aW9uXG4gKiBAcGFyYW0ge1Z9IGRhdGEgLSBUaGUgcmVsYXRpb25zIG1ldGFkYXRhXG4gKiBAcGFyYW0ga2V5IC0gVGhlIHByb3BlcnR5IGtleSB0byBzZXQgd2l0aCB0aGUgVVVJRFxuICogQHBhcmFtIHtNfSBtb2RlbCAtIFRoZSBtb2RlbCBpbnN0YW5jZSBiZWluZyBjcmVhdGVkL3VwZGF0ZWRcbiAqIEByZXR1cm4ge1Byb21pc2U8dm9pZD59IEEgcHJvbWlzZSB0aGF0IHJlc29sdmVzIHdoZW4gdGhlIGZpZWxkIGhhcyBiZWVuIHNldFxuICogQGZ1bmN0aW9uIGNyZWF0ZWRCeU9uUmFtQ3JlYXRlVXBkYXRlXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqIEBjYXRlZ29yeSBSYW1cbiAqL1xuZXhwb3J0IGFzeW5jIGZ1bmN0aW9uIGNyZWF0ZWRCeU9uUmFtQ3JlYXRlVXBkYXRlPFxuICBNIGV4dGVuZHMgTW9kZWwsXG4gIFIgZXh0ZW5kcyBSZXBvPE0sIEYsIEM+LFxuICBWIGV4dGVuZHMgUmVsYXRpb25zTWV0YWRhdGEsXG4gIEYgZXh0ZW5kcyBSYW1GbGFncyxcbiAgQyBleHRlbmRzIENvbnRleHQ8Rj4sXG4+KFxuICB0aGlzOiBSLFxuICBjb250ZXh0OiBDb250ZXh0PEY+LFxuICBkYXRhOiBWLFxuICBrZXk6IGtleW9mIE0sXG4gIG1vZGVsOiBNXG4pOiBQcm9taXNlPHZvaWQ+IHtcbiAgY29uc3QgdXVpZDogc3RyaW5nID0gY29udGV4dC5nZXQoXCJVVUlEXCIpO1xuICBpZiAoIXV1aWQpXG4gICAgdGhyb3cgbmV3IFVuc3VwcG9ydGVkRXJyb3IoXG4gICAgICBcIlRoaXMgYWRhcHRlciBkb2VzIG5vdCBzdXBwb3J0IHVzZXIgaWRlbnRpZmljYXRpb25cIlxuICAgICk7XG4gIG1vZGVsW2tleV0gPSB1dWlkIGFzIE1ba2V5b2YgTV07XG59XG4iXX0=

package/lib/esm/ram/index.js

@@ -1,14 +1,14 @@
-import { RamAdapter } from "./RamAdapter";
+import { RamAdapter } from "./RamAdapter.js";
 // Invoked there to ensure decoration override
 RamAdapter.decoration();
-export * from "./model";
-export * from "./constants";
-export * from "./handlers";
-export * from "./RamContext";
-export * from "./RamPaginator";
-export * from "./RamStatement";
-export * from "./RamSequence";
-export * from "./types";
+export * from "./model/index.js";
+export * from "./constants.js";
+export * from "./handlers.js";
+export * from "./RamContext.js";
+export * from "./RamPaginator.js";
+export * from "./RamStatement.js";
+export * from "./RamSequence.js";
+export * from "./types.js";
 // left to last on purpose
-export * from "./RamAdapter";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcmFtL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSxjQUFjLENBQUM7QUFFMUMsOENBQThDO0FBQzlDLFVBQVUsQ0FBQyxVQUFVLEVBQUUsQ0FBQztBQUV4QixjQUFjLFNBQVMsQ0FBQztBQUN4QixjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLFlBQVksQ0FBQztBQUMzQixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLGdCQUFnQixDQUFDO0FBQy9CLGNBQWMsZ0JBQWdCLENBQUM7QUFDL0IsY0FBYyxlQUFlLENBQUM7QUFDOUIsY0FBYyxTQUFTLENBQUM7QUFDeEIsMEJBQTBCO0FBQzFCLGNBQWMsY0FBYyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgUmFtQWRhcHRlciB9IGZyb20gXCIuL1JhbUFkYXB0ZXJcIjtcblxuLy8gSW52b2tlZCB0aGVyZSB0byBlbnN1cmUgZGVjb3JhdGlvbiBvdmVycmlkZVxuUmFtQWRhcHRlci5kZWNvcmF0aW9uKCk7XG5cbmV4cG9ydCAqIGZyb20gXCIuL21vZGVsXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9jb25zdGFudHNcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2hhbmRsZXJzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9SYW1Db250ZXh0XCI7XG5leHBvcnQgKiBmcm9tIFwiLi9SYW1QYWdpbmF0b3JcIjtcbmV4cG9ydCAqIGZyb20gXCIuL1JhbVN0YXRlbWVudFwiO1xuZXhwb3J0ICogZnJvbSBcIi4vUmFtU2VxdWVuY2VcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3R5cGVzXCI7XG4vLyBsZWZ0IHRvIGxhc3Qgb24gcHVycG9zZVxuZXhwb3J0ICogZnJvbSBcIi4vUmFtQWRhcHRlclwiO1xuIl19
+export * from "./RamAdapter.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcmFtL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxVQUFVLEVBQUUsd0JBQXFCO0FBRTFDLDhDQUE4QztBQUM5QyxVQUFVLENBQUMsVUFBVSxFQUFFLENBQUM7QUFFeEIsaUNBQXdCO0FBQ3hCLCtCQUE0QjtBQUM1Qiw4QkFBMkI7QUFDM0IsZ0NBQTZCO0FBQzdCLGtDQUErQjtBQUMvQixrQ0FBK0I7QUFDL0IsaUNBQThCO0FBQzlCLDJCQUF3QjtBQUN4QiwwQkFBMEI7QUFDMUIsZ0NBQTZCIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgUmFtQWRhcHRlciB9IGZyb20gXCIuL1JhbUFkYXB0ZXJcIjtcblxuLy8gSW52b2tlZCB0aGVyZSB0byBlbnN1cmUgZGVjb3JhdGlvbiBvdmVycmlkZVxuUmFtQWRhcHRlci5kZWNvcmF0aW9uKCk7XG5cbmV4cG9ydCAqIGZyb20gXCIuL21vZGVsXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9jb25zdGFudHNcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2hhbmRsZXJzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9SYW1Db250ZXh0XCI7XG5leHBvcnQgKiBmcm9tIFwiLi9SYW1QYWdpbmF0b3JcIjtcbmV4cG9ydCAqIGZyb20gXCIuL1JhbVN0YXRlbWVudFwiO1xuZXhwb3J0ICogZnJvbSBcIi4vUmFtU2VxdWVuY2VcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3R5cGVzXCI7XG4vLyBsZWZ0IHRvIGxhc3Qgb24gcHVycG9zZVxuZXhwb3J0ICogZnJvbSBcIi4vUmFtQWRhcHRlclwiO1xuIl19

package/lib/esm/ram/model/RamSequence.d.ts

@@ -1,7 +1,32 @@
 import type { ModelArg } from "@decaf-ts/decorator-validation";
 import { BaseModel } from "../../model";
+/**
+ * @description RAM sequence model for auto-incrementing values
+ * @summary A model class that represents a sequence in the RAM adapter. It stores the current value
+ * of a sequence that can be used for generating sequential identifiers for entities.
+ * The sequence is identified by its ID and maintains the current value.
+ * @param {ModelArg<Sequence>} seq - Initial sequence data
+ * @class Sequence
+ * @category Ram
+ * @example
+ * ```typescript
+ * // Create a new sequence
+ * const orderSequence = new Sequence({ id: 'order_seq', current: 1 });
+ *
+ * // Use the sequence to get the next value
+ * const nextOrderId = parseInt(orderSequence.current.toString()) + 1;
+ * orderSequence.current = nextOrderId;
+ * ```
+ */
 export declare class Sequence extends BaseModel {
+    /**
+     * @description Primary key identifier for the sequence
+     */
     id: string;
+    /**
+     * @description Current value of the sequence
+     * Used to generate the next sequential value
+     */
     current: string | number;
     constructor(seq?: ModelArg<Sequence>);
 }

package/lib/esm/ram/model/RamSequence.js

@@ -8,8 +8,26 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 import { model, required } from "@decaf-ts/decorator-validation";
-import { BaseModel, index, table } from "../../model";
-import { pk } from "../../identity";
+import { BaseModel, index, table } from "./../../model/index.js";
+import { pk } from "./../../identity/index.js";
+/**
+ * @description RAM sequence model for auto-incrementing values
+ * @summary A model class that represents a sequence in the RAM adapter. It stores the current value
+ * of a sequence that can be used for generating sequential identifiers for entities.
+ * The sequence is identified by its ID and maintains the current value.
+ * @param {ModelArg<Sequence>} seq - Initial sequence data
+ * @class Sequence
+ * @category Ram
+ * @example
+ * ```typescript
+ * // Create a new sequence
+ * const orderSequence = new Sequence({ id: 'order_seq', current: 1 });
+ *
+ * // Use the sequence to get the next value
+ * const nextOrderId = parseInt(orderSequence.current.toString()) + 1;
+ * orderSequence.current = nextOrderId;
+ * ```
+ */
 let Sequence = class Sequence extends BaseModel {
     constructor(seq) {
         super(seq);
@@ -30,4 +48,4 @@ Sequence = __decorate([
     __metadata("design:paramtypes", [Object])
 ], Sequence);
 export { Sequence };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmFtU2VxdWVuY2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvcmFtL21vZGVsL1JhbVNlcXVlbmNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7OztBQUFBLE9BQU8sRUFBRSxLQUFLLEVBQUUsUUFBUSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFFakUsT0FBTyxFQUFFLFNBQVMsRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQ3RELE9BQU8sRUFBRSxFQUFFLEVBQUUsTUFBTSxnQkFBZ0IsQ0FBQztBQUk3QixJQUFNLFFBQVEsR0FBZCxNQUFNLFFBQVMsU0FBUSxTQUFTO0lBUXJDLFlBQVksR0FBd0I7UUFDbEMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ2IsQ0FBQztDQUNGLENBQUE7QUFUQztJQURDLEVBQUUsRUFBRTs7b0NBQ087QUFJWjtJQUZDLFFBQVEsRUFBRTtJQUNWLEtBQUssRUFBRTs7eUNBQ2tCO0FBTmYsUUFBUTtJQUZwQixLQUFLLENBQUMsZUFBZSxDQUFDO0lBQ3RCLEtBQUssRUFBRTs7R0FDSyxRQUFRLENBV3BCIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgbW9kZWwsIHJlcXVpcmVkIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuaW1wb3J0IHR5cGUgeyBNb2RlbEFyZyB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB7IEJhc2VNb2RlbCwgaW5kZXgsIHRhYmxlIH0gZnJvbSBcIi4uLy4uL21vZGVsXCI7XG5pbXBvcnQgeyBwayB9IGZyb20gXCIuLi8uLi9pZGVudGl0eVwiO1xuXG5AdGFibGUoXCJfX1JhbVNlcXVlbmNlXCIpXG5AbW9kZWwoKVxuZXhwb3J0IGNsYXNzIFNlcXVlbmNlIGV4dGVuZHMgQmFzZU1vZGVsIHtcbiAgQHBrKClcbiAgaWQhOiBzdHJpbmc7XG5cbiAgQHJlcXVpcmVkKClcbiAgQGluZGV4KClcbiAgY3VycmVudCE6IHN0cmluZyB8IG51bWJlcjtcblxuICBjb25zdHJ1Y3RvcihzZXE/OiBNb2RlbEFyZzxTZXF1ZW5jZT4pIHtcbiAgICBzdXBlcihzZXEpO1xuICB9XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmFtU2VxdWVuY2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvcmFtL21vZGVsL1JhbVNlcXVlbmNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7OztBQUFBLE9BQU8sRUFBRSxLQUFLLEVBQUUsUUFBUSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFFakUsT0FBTyxFQUFFLFNBQVMsRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLCtCQUFvQjtBQUN0RCxPQUFPLEVBQUUsRUFBRSxFQUFFLGtDQUF1QjtBQUVwQzs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FpQkc7QUFHSSxJQUFNLFFBQVEsR0FBZCxNQUFNLFFBQVMsU0FBUSxTQUFTO0lBZXJDLFlBQVksR0FBd0I7UUFDbEMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ2IsQ0FBQztDQUNGLENBQUE7QUFiQztJQURDLEVBQUUsRUFBRTs7b0NBQ087QUFRWjtJQUZDLFFBQVEsRUFBRTtJQUNWLEtBQUssRUFBRTs7eUNBQ2tCO0FBYmYsUUFBUTtJQUZwQixLQUFLLENBQUMsZUFBZSxDQUFDO0lBQ3RCLEtBQUssRUFBRTs7R0FDSyxRQUFRLENBa0JwQiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IG1vZGVsLCByZXF1aXJlZCB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB0eXBlIHsgTW9kZWxBcmcgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBCYXNlTW9kZWwsIGluZGV4LCB0YWJsZSB9IGZyb20gXCIuLi8uLi9tb2RlbFwiO1xuaW1wb3J0IHsgcGsgfSBmcm9tIFwiLi4vLi4vaWRlbnRpdHlcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gUkFNIHNlcXVlbmNlIG1vZGVsIGZvciBhdXRvLWluY3JlbWVudGluZyB2YWx1ZXNcbiAqIEBzdW1tYXJ5IEEgbW9kZWwgY2xhc3MgdGhhdCByZXByZXNlbnRzIGEgc2VxdWVuY2UgaW4gdGhlIFJBTSBhZGFwdGVyLiBJdCBzdG9yZXMgdGhlIGN1cnJlbnQgdmFsdWVcbiAqIG9mIGEgc2VxdWVuY2UgdGhhdCBjYW4gYmUgdXNlZCBmb3IgZ2VuZXJhdGluZyBzZXF1ZW50aWFsIGlkZW50aWZpZXJzIGZvciBlbnRpdGllcy5cbiAqIFRoZSBzZXF1ZW5jZSBpcyBpZGVudGlmaWVkIGJ5IGl0cyBJRCBhbmQgbWFpbnRhaW5zIHRoZSBjdXJyZW50IHZhbHVlLlxuICogQHBhcmFtIHtNb2RlbEFyZzxTZXF1ZW5jZT59IHNlcSAtIEluaXRpYWwgc2VxdWVuY2UgZGF0YVxuICogQGNsYXNzIFNlcXVlbmNlXG4gKiBAY2F0ZWdvcnkgUmFtXG4gKiBAZXhhbXBsZVxuICogYGBgdHlwZXNjcmlwdFxuICogLy8gQ3JlYXRlIGEgbmV3IHNlcXVlbmNlXG4gKiBjb25zdCBvcmRlclNlcXVlbmNlID0gbmV3IFNlcXVlbmNlKHsgaWQ6ICdvcmRlcl9zZXEnLCBjdXJyZW50OiAxIH0pO1xuICpcbiAqIC8vIFVzZSB0aGUgc2VxdWVuY2UgdG8gZ2V0IHRoZSBuZXh0IHZhbHVlXG4gKiBjb25zdCBuZXh0T3JkZXJJZCA9IHBhcnNlSW50KG9yZGVyU2VxdWVuY2UuY3VycmVudC50b1N0cmluZygpKSArIDE7XG4gKiBvcmRlclNlcXVlbmNlLmN1cnJlbnQgPSBuZXh0T3JkZXJJZDtcbiAqIGBgYFxuICovXG5AdGFibGUoXCJfX1JhbVNlcXVlbmNlXCIpXG5AbW9kZWwoKVxuZXhwb3J0IGNsYXNzIFNlcXVlbmNlIGV4dGVuZHMgQmFzZU1vZGVsIHtcbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBQcmltYXJ5IGtleSBpZGVudGlmaWVyIGZvciB0aGUgc2VxdWVuY2VcbiAgICovXG4gIEBwaygpXG4gIGlkITogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gQ3VycmVudCB2YWx1ZSBvZiB0aGUgc2VxdWVuY2VcbiAgICogVXNlZCB0byBnZW5lcmF0ZSB0aGUgbmV4dCBzZXF1ZW50aWFsIHZhbHVlXG4gICAqL1xuICBAcmVxdWlyZWQoKVxuICBAaW5kZXgoKVxuICBjdXJyZW50ITogc3RyaW5nIHwgbnVtYmVyO1xuXG4gIGNvbnN0cnVjdG9yKHNlcT86IE1vZGVsQXJnPFNlcXVlbmNlPikge1xuICAgIHN1cGVyKHNlcSk7XG4gIH1cbn1cbiJdfQ==

package/lib/esm/ram/model/index.js

@@ -1,2 +1,2 @@
-export * from "./RamSequence";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvcmFtL21vZGVsL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsZUFBZSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSBcIi4vUmFtU2VxdWVuY2VcIjtcbiJdfQ==
+export * from "./RamSequence.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvcmFtL21vZGVsL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGlDQUE4QiIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gXCIuL1JhbVNlcXVlbmNlXCI7XG4iXX0=

package/lib/esm/ram/types.d.ts

@@ -2,7 +2,31 @@ import { Constructor, Model } from "@decaf-ts/decorator-validation";
 import { Repository } from "../repository";
 import { Context, RepositoryFlags } from "@decaf-ts/db-decorators";
 import { RamAdapter } from "./RamAdapter";
+/**
+ * @description In-memory storage structure for the RAM adapter
+ * @summary A nested Map structure that stores all entities by their table name and primary key.
+ * The outer Map uses table names as keys, while the inner Map uses entity IDs as keys and entity instances as values.
+ * @typedef {Map<string, Map<string | number, any>>} RamStorage
+ * @memberOf module:core
+ * @category Ram
+ */
 export type RamStorage = Map<string, Map<string | number, any>>;
+/**
+ * @description Query specification for RAM adapter
+ * @summary Defines the structure of a query for retrieving data from the in-memory storage.
+ * It specifies what fields to select, which model to query, filtering conditions,
+ * sorting criteria, and pagination options.
+ * @template M - The model type being queried
+ * @typedef {Object} RawRamQuery
+ * @property select - Fields to select from the model, or undefined for all fields
+ * @property {Constructor<M>} from - The model constructor to query
+ * @property {function(M): boolean} where - Predicate function for filtering entities
+ * @property {function(M, M): number} [sort] - Optional comparator function for sorting results
+ * @property {number} [limit] - Optional maximum number of results to return
+ * @property {number} [skip] - Optional number of results to skip (for pagination)
+ * @memberOf module:core
+ * @category Ram
+ */
 export type RawRamQuery<M extends Model> = {
     select: undefined | (keyof M)[];
     from: Constructor<M>;
@@ -11,7 +35,25 @@ export type RawRamQuery<M extends Model> = {
     limit?: number;
     skip?: number;
 };
+/**
+ * @description Flags for RAM adapter operations
+ * @summary Interface that extends the base repository flags with RAM-specific flags.
+ * Contains user identification information needed for tracking entity creation and updates.
+ * @interface RamFlags
+ * @property {string} UUID - Unique identifier for the current user
+ * @memberOf module:core
+ * @category Ram
+ */
 export interface RamFlags extends RepositoryFlags {
     UUID: string;
 }
+/**
+ * @description Type definition for RAM-specific repository
+ * @summary A specialized repository type for working with models in the RAM adapter.
+ * It combines the model type with RAM-specific query, adapter, flags, and context types.
+ * @template M - The model type managed by the repository
+ * @typedef {Repository<M, RawRamQuery<any>, RamAdapter, RamFlags, Context<RamFlags>>} RamRepository
+ * @memberOf module:core
+ * @category Ram
+ */
 export type RamRepository<M extends Model> = Repository<M, RawRamQuery<any>, RamAdapter, RamFlags, Context<RamFlags>>;

package/lib/esm/ram/types.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcmFtL3R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25zdHJ1Y3RvciwgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBSZXBvc2l0b3J5IH0gZnJvbSBcIi4uL3JlcG9zaXRvcnlcIjtcbmltcG9ydCB7IENvbnRleHQsIFJlcG9zaXRvcnlGbGFncyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgUmFtQWRhcHRlciB9IGZyb20gXCIuL1JhbUFkYXB0ZXJcIjtcblxuZXhwb3J0IHR5cGUgUmFtU3RvcmFnZSA9IE1hcDxzdHJpbmcsIE1hcDxzdHJpbmcgfCBudW1iZXIsIGFueT4+O1xuXG5leHBvcnQgdHlwZSBSYXdSYW1RdWVyeTxNIGV4dGVuZHMgTW9kZWw+ID0ge1xuICBzZWxlY3Q6IHVuZGVmaW5lZCB8IChrZXlvZiBNKVtdO1xuICBmcm9tOiBDb25zdHJ1Y3RvcjxNPjtcbiAgd2hlcmU6IChlbDogTSkgPT4gYm9vbGVhbjtcbiAgc29ydD86IChlbDogTSwgZWwyOiBNKSA9PiBudW1iZXI7XG4gIGxpbWl0PzogbnVtYmVyO1xuICBza2lwPzogbnVtYmVyO1xufTtcblxuZXhwb3J0IGludGVyZmFjZSBSYW1GbGFncyBleHRlbmRzIFJlcG9zaXRvcnlGbGFncyB7XG4gIFVVSUQ6IHN0cmluZztcbn1cblxuZXhwb3J0IHR5cGUgUmFtUmVwb3NpdG9yeTxNIGV4dGVuZHMgTW9kZWw+ID0gUmVwb3NpdG9yeTxcbiAgTSxcbiAgUmF3UmFtUXVlcnk8YW55PixcbiAgUmFtQWRhcHRlcixcbiAgUmFtRmxhZ3MsXG4gIENvbnRleHQ8UmFtRmxhZ3M+XG4+O1xuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcmFtL3R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25zdHJ1Y3RvciwgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBSZXBvc2l0b3J5IH0gZnJvbSBcIi4uL3JlcG9zaXRvcnlcIjtcbmltcG9ydCB7IENvbnRleHQsIFJlcG9zaXRvcnlGbGFncyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgUmFtQWRhcHRlciB9IGZyb20gXCIuL1JhbUFkYXB0ZXJcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gSW4tbWVtb3J5IHN0b3JhZ2Ugc3RydWN0dXJlIGZvciB0aGUgUkFNIGFkYXB0ZXJcbiAqIEBzdW1tYXJ5IEEgbmVzdGVkIE1hcCBzdHJ1Y3R1cmUgdGhhdCBzdG9yZXMgYWxsIGVudGl0aWVzIGJ5IHRoZWlyIHRhYmxlIG5hbWUgYW5kIHByaW1hcnkga2V5LlxuICogVGhlIG91dGVyIE1hcCB1c2VzIHRhYmxlIG5hbWVzIGFzIGtleXMsIHdoaWxlIHRoZSBpbm5lciBNYXAgdXNlcyBlbnRpdHkgSURzIGFzIGtleXMgYW5kIGVudGl0eSBpbnN0YW5jZXMgYXMgdmFsdWVzLlxuICogQHR5cGVkZWYge01hcDxzdHJpbmcsIE1hcDxzdHJpbmcgfCBudW1iZXIsIGFueT4+fSBSYW1TdG9yYWdlXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqIEBjYXRlZ29yeSBSYW1cbiAqL1xuZXhwb3J0IHR5cGUgUmFtU3RvcmFnZSA9IE1hcDxzdHJpbmcsIE1hcDxzdHJpbmcgfCBudW1iZXIsIGFueT4+O1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBRdWVyeSBzcGVjaWZpY2F0aW9uIGZvciBSQU0gYWRhcHRlclxuICogQHN1bW1hcnkgRGVmaW5lcyB0aGUgc3RydWN0dXJlIG9mIGEgcXVlcnkgZm9yIHJldHJpZXZpbmcgZGF0YSBmcm9tIHRoZSBpbi1tZW1vcnkgc3RvcmFnZS5cbiAqIEl0IHNwZWNpZmllcyB3aGF0IGZpZWxkcyB0byBzZWxlY3QsIHdoaWNoIG1vZGVsIHRvIHF1ZXJ5LCBmaWx0ZXJpbmcgY29uZGl0aW9ucyxcbiAqIHNvcnRpbmcgY3JpdGVyaWEsIGFuZCBwYWdpbmF0aW9uIG9wdGlvbnMuXG4gKiBAdGVtcGxhdGUgTSAtIFRoZSBtb2RlbCB0eXBlIGJlaW5nIHF1ZXJpZWRcbiAqIEB0eXBlZGVmIHtPYmplY3R9IFJhd1JhbVF1ZXJ5XG4gKiBAcHJvcGVydHkgc2VsZWN0IC0gRmllbGRzIHRvIHNlbGVjdCBmcm9tIHRoZSBtb2RlbCwgb3IgdW5kZWZpbmVkIGZvciBhbGwgZmllbGRzXG4gKiBAcHJvcGVydHkge0NvbnN0cnVjdG9yPE0+fSBmcm9tIC0gVGhlIG1vZGVsIGNvbnN0cnVjdG9yIHRvIHF1ZXJ5XG4gKiBAcHJvcGVydHkge2Z1bmN0aW9uKE0pOiBib29sZWFufSB3aGVyZSAtIFByZWRpY2F0ZSBmdW5jdGlvbiBmb3IgZmlsdGVyaW5nIGVudGl0aWVzXG4gKiBAcHJvcGVydHkge2Z1bmN0aW9uKE0sIE0pOiBudW1iZXJ9IFtzb3J0XSAtIE9wdGlvbmFsIGNvbXBhcmF0b3IgZnVuY3Rpb24gZm9yIHNvcnRpbmcgcmVzdWx0c1xuICogQHByb3BlcnR5IHtudW1iZXJ9IFtsaW1pdF0gLSBPcHRpb25hbCBtYXhpbXVtIG51bWJlciBvZiByZXN1bHRzIHRvIHJldHVyblxuICogQHByb3BlcnR5IHtudW1iZXJ9IFtza2lwXSAtIE9wdGlvbmFsIG51bWJlciBvZiByZXN1bHRzIHRvIHNraXAgKGZvciBwYWdpbmF0aW9uKVxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKiBAY2F0ZWdvcnkgUmFtXG4gKi9cbmV4cG9ydCB0eXBlIFJhd1JhbVF1ZXJ5PE0gZXh0ZW5kcyBNb2RlbD4gPSB7XG4gIHNlbGVjdDogdW5kZWZpbmVkIHwgKGtleW9mIE0pW107XG4gIGZyb206IENvbnN0cnVjdG9yPE0+O1xuICB3aGVyZTogKGVsOiBNKSA9PiBib29sZWFuO1xuICBzb3J0PzogKGVsOiBNLCBlbDI6IE0pID0+IG51bWJlcjtcbiAgbGltaXQ/OiBudW1iZXI7XG4gIHNraXA/OiBudW1iZXI7XG59O1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBGbGFncyBmb3IgUkFNIGFkYXB0ZXIgb3BlcmF0aW9uc1xuICogQHN1bW1hcnkgSW50ZXJmYWNlIHRoYXQgZXh0ZW5kcyB0aGUgYmFzZSByZXBvc2l0b3J5IGZsYWdzIHdpdGggUkFNLXNwZWNpZmljIGZsYWdzLlxuICogQ29udGFpbnMgdXNlciBpZGVudGlmaWNhdGlvbiBpbmZvcm1hdGlvbiBuZWVkZWQgZm9yIHRyYWNraW5nIGVudGl0eSBjcmVhdGlvbiBhbmQgdXBkYXRlcy5cbiAqIEBpbnRlcmZhY2UgUmFtRmxhZ3NcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBVVUlEIC0gVW5pcXVlIGlkZW50aWZpZXIgZm9yIHRoZSBjdXJyZW50IHVzZXJcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICogQGNhdGVnb3J5IFJhbVxuICovXG5leHBvcnQgaW50ZXJmYWNlIFJhbUZsYWdzIGV4dGVuZHMgUmVwb3NpdG9yeUZsYWdzIHtcbiAgVVVJRDogc3RyaW5nO1xufVxuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUeXBlIGRlZmluaXRpb24gZm9yIFJBTS1zcGVjaWZpYyByZXBvc2l0b3J5XG4gKiBAc3VtbWFyeSBBIHNwZWNpYWxpemVkIHJlcG9zaXRvcnkgdHlwZSBmb3Igd29ya2luZyB3aXRoIG1vZGVscyBpbiB0aGUgUkFNIGFkYXB0ZXIuXG4gKiBJdCBjb21iaW5lcyB0aGUgbW9kZWwgdHlwZSB3aXRoIFJBTS1zcGVjaWZpYyBxdWVyeSwgYWRhcHRlciwgZmxhZ3MsIGFuZCBjb250ZXh0IHR5cGVzLlxuICogQHRlbXBsYXRlIE0gLSBUaGUgbW9kZWwgdHlwZSBtYW5hZ2VkIGJ5IHRoZSByZXBvc2l0b3J5XG4gKiBAdHlwZWRlZiB7UmVwb3NpdG9yeTxNLCBSYXdSYW1RdWVyeTxhbnk+LCBSYW1BZGFwdGVyLCBSYW1GbGFncywgQ29udGV4dDxSYW1GbGFncz4+fSBSYW1SZXBvc2l0b3J5XG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqIEBjYXRlZ29yeSBSYW1cbiAqL1xuZXhwb3J0IHR5cGUgUmFtUmVwb3NpdG9yeTxNIGV4dGVuZHMgTW9kZWw+ID0gUmVwb3NpdG9yeTxcbiAgTSxcbiAgUmF3UmFtUXVlcnk8YW55PixcbiAgUmFtQWRhcHRlcixcbiAgUmFtRmxhZ3MsXG4gIENvbnRleHQ8UmFtRmxhZ3M+XG4+O1xuIl19

package/lib/esm/repository/Repository.d.ts

@@ -13,7 +13,71 @@ import { SelectSelector } from "../query/selectors";
 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[];
@@ -22,56 +86,347 @@ export declare class Repository<M extends Model, Q, A extends Adapter<any, Q, F,
     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;
+    /**
+     * @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[]);
-    override(flags: Partial<F>): this;
+    /**
+     * @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[]>;
+    /**
+     * @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, 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;
+    /**
+     * @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>;
-    static forModel<M extends Model, R extends Repo<M>>(model: Constructor<M>, defaultFlavour?: string, ...args: any[]): R;
+    /**
+     * @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.
+     */
     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[];
+    /**
+     * @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;
-    static column<M extends Model>(model: M, attribute: string): any;
+    /**
+     * @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;
 }