@decaf-ts/core 0.5.1 → 0.5.3

package/lib/esm/persistence/Sequence.d.ts

@@ -1,14 +1,103 @@
 import { Constructor, Model } from "@decaf-ts/decorator-validation";
 import { SequenceOptions } from "../interfaces/SequenceOptions";
 import { Logger } from "@decaf-ts/logging";
+/**
+ * @description Abstract base class for sequence generation
+ * @summary Provides a framework for generating sequential values (like primary keys) in the persistence layer.
+ * Implementations of this class handle the specifics of how sequences are stored and incremented in different
+ * database systems.
+ * @param {SequenceOptions} options - Configuration options for the sequence generator
+ * @class Sequence
+ * @example
+ * ```typescript
+ * // Example implementation for a specific database
+ * class PostgresSequence extends Sequence {
+ *   constructor(options: SequenceOptions) {
+ *     super(options);
+ *   }
+ *
+ *   async next(): Promise<number> {
+ *     // Implementation to get next value from PostgreSQL sequence
+ *     const result = await this.options.executor.raw(`SELECT nextval('${this.options.name}')`);
+ *     return parseInt(result.rows[0].nextval);
+ *   }
+ *
+ *   async current(): Promise<number> {
+ *     // Implementation to get current value from PostgreSQL sequence
+ *     const result = await this.options.executor.raw(`SELECT currval('${this.options.name}')`);
+ *     return parseInt(result.rows[0].currval);
+ *   }
+ *
+ *   async range(count: number): Promise<number[]> {
+ *     // Implementation to get a range of values
+ *     const values: number[] = [];
+ *     for (let i = 0; i < count; i++) {
+ *       values.push(await this.next());
+ *     }
+ *     return values;
+ *   }
+ * }
+ *
+ * // Usage
+ * const sequence = new PostgresSequence({
+ *   name: 'user_id_seq',
+ *   executor: dbExecutor
+ * });
+ *
+ * const nextId = await sequence.next();
+ * ```
+ */
 export declare abstract class Sequence {
     protected readonly options: SequenceOptions;
+    /**
+     * @description Logger instance for this sequence
+     * @summary Lazily initialized logger for the sequence instance
+     */
     private logger;
+    /**
+     * @description Accessor for the logger instance
+     * @summary Gets or initializes the logger for this sequence
+     * @return {Logger} The logger instance
+     */
     protected get log(): Logger;
+    /**
+     * @description Creates a new sequence instance
+     * @summary Protected constructor that initializes the sequence with the provided options
+     */
     protected constructor(options: SequenceOptions);
+    /**
+     * @description Gets the next value in the sequence
+     * @summary Retrieves the next value from the sequence, incrementing it in the process
+     * @return A promise that resolves to the next value in the sequence
+     */
     abstract next(): Promise<string | number | bigint>;
+    /**
+     * @description Gets the current value of the sequence
+     * @summary Retrieves the current value of the sequence without incrementing it
+     * @return A promise that resolves to the current value in the sequence
+     */
     abstract current(): Promise<string | number | bigint>;
+    /**
+     * @description Gets a range of sequential values
+     * @summary Retrieves multiple sequential values at once, which can be more efficient than calling next() multiple times
+     * @param {number} count - The number of sequential values to retrieve
+     * @return A promise that resolves to an array of sequential values
+     */
     abstract range(count: number): Promise<(number | string | bigint)[]>;
+    /**
+     * @description Gets the primary key sequence name for a model
+     * @summary Utility method that returns the standardized sequence name for a model's primary key
+     * @template M - The model type
+     * @param {M|Constructor<M>} model - The model instance or constructor
+     * @return {string} The sequence name for the model's primary key
+     */
     static pk<M extends Model>(model: M | Constructor<M>): string;
+    /**
+     * @description Parses a sequence value to the appropriate type
+     * @summary Converts a sequence value to the specified type (Number or BigInt)
+     * @param {"Number"|"BigInt"|undefined} type - The target type to convert to
+     * @param {string|number|bigint} value - The value to convert
+     * @return {string|number|bigint} The converted value
+     */
     static parseValue(type: "Number" | "BigInt" | undefined, value: string | number | bigint): string | number | bigint;
 }

package/lib/esm/persistence/Sequence.js

@@ -1,18 +1,87 @@
-import { sequenceNameForModel } from "../identity/utils";
+import { sequenceNameForModel } from "./../identity/utils.js";
 import { InternalError } from "@decaf-ts/db-decorators";
 import { Logging } from "@decaf-ts/logging";
+/**
+ * @description Abstract base class for sequence generation
+ * @summary Provides a framework for generating sequential values (like primary keys) in the persistence layer.
+ * Implementations of this class handle the specifics of how sequences are stored and incremented in different
+ * database systems.
+ * @param {SequenceOptions} options - Configuration options for the sequence generator
+ * @class Sequence
+ * @example
+ * ```typescript
+ * // Example implementation for a specific database
+ * class PostgresSequence extends Sequence {
+ *   constructor(options: SequenceOptions) {
+ *     super(options);
+ *   }
+ *
+ *   async next(): Promise<number> {
+ *     // Implementation to get next value from PostgreSQL sequence
+ *     const result = await this.options.executor.raw(`SELECT nextval('${this.options.name}')`);
+ *     return parseInt(result.rows[0].nextval);
+ *   }
+ *
+ *   async current(): Promise<number> {
+ *     // Implementation to get current value from PostgreSQL sequence
+ *     const result = await this.options.executor.raw(`SELECT currval('${this.options.name}')`);
+ *     return parseInt(result.rows[0].currval);
+ *   }
+ *
+ *   async range(count: number): Promise<number[]> {
+ *     // Implementation to get a range of values
+ *     const values: number[] = [];
+ *     for (let i = 0; i < count; i++) {
+ *       values.push(await this.next());
+ *     }
+ *     return values;
+ *   }
+ * }
+ *
+ * // Usage
+ * const sequence = new PostgresSequence({
+ *   name: 'user_id_seq',
+ *   executor: dbExecutor
+ * });
+ *
+ * const nextId = await sequence.next();
+ * ```
+ */
 export class Sequence {
+    /**
+     * @description Accessor for the logger instance
+     * @summary Gets or initializes the logger for this sequence
+     * @return {Logger} The logger instance
+     */
     get log() {
         if (!this.logger)
             this.logger = Logging.for(this);
         return this.logger;
     }
+    /**
+     * @description Creates a new sequence instance
+     * @summary Protected constructor that initializes the sequence with the provided options
+     */
     constructor(options) {
         this.options = options;
     }
+    /**
+     * @description Gets the primary key sequence name for a model
+     * @summary Utility method that returns the standardized sequence name for a model's primary key
+     * @template M - The model type
+     * @param {M|Constructor<M>} model - The model instance or constructor
+     * @return {string} The sequence name for the model's primary key
+     */
     static pk(model) {
         return sequenceNameForModel(model, "pk");
     }
+    /**
+     * @description Parses a sequence value to the appropriate type
+     * @summary Converts a sequence value to the specified type (Number or BigInt)
+     * @param {"Number"|"BigInt"|undefined} type - The target type to convert to
+     * @param {string|number|bigint} value - The value to convert
+     * @return {string|number|bigint} The converted value
+     */
     static parseValue(type, value) {
         switch (type) {
             case "Number":
@@ -28,4 +97,4 @@ export class Sequence {
         }
     }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2VxdWVuY2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcGVyc2lzdGVuY2UvU2VxdWVuY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLG9CQUFvQixFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFFekQsT0FBTyxFQUFFLGFBQWEsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBQ3hELE9BQU8sRUFBVSxPQUFPLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUVwRCxNQUFNLE9BQWdCLFFBQVE7SUFHNUIsSUFBYyxHQUFHO1FBQ2YsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNO1lBQUUsSUFBSSxDQUFDLE1BQU0sR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQVcsQ0FBQyxDQUFDO1FBQ3pELE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBQztJQUNyQixDQUFDO0lBRUQsWUFBeUMsT0FBd0I7UUFBeEIsWUFBTyxHQUFQLE9BQU8sQ0FBaUI7SUFBRyxDQUFDO0lBTXJFLE1BQU0sQ0FBQyxFQUFFLENBQWtCLEtBQXlCO1FBQ2xELE9BQU8sb0JBQW9CLENBQUMsS0FBSyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQzNDLENBQUM7SUFFRCxNQUFNLENBQUMsVUFBVSxDQUNmLElBQXFDLEVBQ3JDLEtBQStCO1FBRS9CLFFBQVEsSUFBSSxFQUFFLENBQUM7WUFDYixLQUFLLFFBQVE7Z0JBQ1gsT0FBTyxPQUFPLEtBQUssS0FBSyxRQUFRO29CQUM5QixDQUFDLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQztvQkFDakIsQ0FBQyxDQUFDLE9BQU8sS0FBSyxLQUFLLFFBQVE7d0JBQ3pCLENBQUMsQ0FBQyxLQUFLO3dCQUNQLENBQUMsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDdEIsS0FBSyxRQUFRO2dCQUNYLE9BQU8sTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO1lBQ3ZCO2dCQUNFLE1BQU0sSUFBSSxhQUFhLENBQUMscUJBQXFCLENBQUMsQ0FBQztRQUNuRCxDQUFDO0lBQ0gsQ0FBQztDQUNGIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQ29uc3RydWN0b3IsIE1vZGVsIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuaW1wb3J0IHsgc2VxdWVuY2VOYW1lRm9yTW9kZWwgfSBmcm9tIFwiLi4vaWRlbnRpdHkvdXRpbHNcIjtcbmltcG9ydCB7IFNlcXVlbmNlT3B0aW9ucyB9IGZyb20gXCIuLi9pbnRlcmZhY2VzL1NlcXVlbmNlT3B0aW9uc1wiO1xuaW1wb3J0IHsgSW50ZXJuYWxFcnJvciB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgTG9nZ2VyLCBMb2dnaW5nIH0gZnJvbSBcIkBkZWNhZi10cy9sb2dnaW5nXCI7XG5cbmV4cG9ydCBhYnN0cmFjdCBjbGFzcyBTZXF1ZW5jZSB7XG4gIHByaXZhdGUgbG9nZ2VyITogTG9nZ2VyO1xuXG4gIHByb3RlY3RlZCBnZXQgbG9nKCkge1xuICAgIGlmICghdGhpcy5sb2dnZXIpIHRoaXMubG9nZ2VyID0gTG9nZ2luZy5mb3IodGhpcyBhcyBhbnkpO1xuICAgIHJldHVybiB0aGlzLmxvZ2dlcjtcbiAgfVxuXG4gIHByb3RlY3RlZCBjb25zdHJ1Y3Rvcihwcm90ZWN0ZWQgcmVhZG9ubHkgb3B0aW9uczogU2VxdWVuY2VPcHRpb25zKSB7fVxuXG4gIGFic3RyYWN0IG5leHQoKTogUHJvbWlzZTxzdHJpbmcgfCBudW1iZXIgfCBiaWdpbnQ+O1xuICBhYnN0cmFjdCBjdXJyZW50KCk6IFByb21pc2U8c3RyaW5nIHwgbnVtYmVyIHwgYmlnaW50PjtcbiAgYWJzdHJhY3QgcmFuZ2UoY291bnQ6IG51bWJlcik6IFByb21pc2U8KG51bWJlciB8IHN0cmluZyB8IGJpZ2ludClbXT47XG5cbiAgc3RhdGljIHBrPE0gZXh0ZW5kcyBNb2RlbD4obW9kZWw6IE0gfCBDb25zdHJ1Y3RvcjxNPikge1xuICAgIHJldHVybiBzZXF1ZW5jZU5hbWVGb3JNb2RlbChtb2RlbCwgXCJwa1wiKTtcbiAgfVxuXG4gIHN0YXRpYyBwYXJzZVZhbHVlKFxuICAgIHR5cGU6IFwiTnVtYmVyXCIgfCBcIkJpZ0ludFwiIHwgdW5kZWZpbmVkLFxuICAgIHZhbHVlOiBzdHJpbmcgfCBudW1iZXIgfCBiaWdpbnRcbiAgKTogc3RyaW5nIHwgbnVtYmVyIHwgYmlnaW50IHtcbiAgICBzd2l0Y2ggKHR5cGUpIHtcbiAgICAgIGNhc2UgXCJOdW1iZXJcIjpcbiAgICAgICAgcmV0dXJuIHR5cGVvZiB2YWx1ZSA9PT0gXCJzdHJpbmdcIlxuICAgICAgICAgID8gcGFyc2VJbnQodmFsdWUpXG4gICAgICAgICAgOiB0eXBlb2YgdmFsdWUgPT09IFwibnVtYmVyXCJcbiAgICAgICAgICAgID8gdmFsdWVcbiAgICAgICAgICAgIDogQmlnSW50KHZhbHVlKTtcbiAgICAgIGNhc2UgXCJCaWdJbnRcIjpcbiAgICAgICAgcmV0dXJuIEJpZ0ludCh2YWx1ZSk7XG4gICAgICBkZWZhdWx0OlxuICAgICAgICB0aHJvdyBuZXcgSW50ZXJuYWxFcnJvcihcIlNob3VsZCBuZXZlciBoYXBwZW5cIik7XG4gICAgfVxuICB9XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"Sequence.js","sourceRoot":"","sources":["../../../src/persistence/Sequence.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,+BAA0B;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAU,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,OAAgB,QAAQ;IAO5B;;;;OAIG;IACH,IAAc,GAAG;QACf,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAW,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,YAAyC,OAAwB;QAAxB,YAAO,GAAP,OAAO,CAAiB;IAAG,CAAC;IAwBrE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,CAAkB,KAAyB;QAClD,OAAO,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CACf,IAAqC,EACrC,KAA+B;QAE/B,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,QAAQ;gBACX,OAAO,OAAO,KAAK,KAAK,QAAQ;oBAC9B,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;oBACjB,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ;wBACzB,CAAC,CAAC,KAAK;wBACP,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,KAAK,QAAQ;gBACX,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;YACvB;gBACE,MAAM,IAAI,aAAa,CAAC,qBAAqB,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;CACF","sourcesContent":["import { Constructor, Model } from \"@decaf-ts/decorator-validation\";\nimport { sequenceNameForModel } from \"../identity/utils\";\nimport { SequenceOptions } from \"../interfaces/SequenceOptions\";\nimport { InternalError } from \"@decaf-ts/db-decorators\";\nimport { Logger, Logging } from \"@decaf-ts/logging\";\n\n/**\n * @description Abstract base class for sequence generation\n * @summary Provides a framework for generating sequential values (like primary keys) in the persistence layer.\n * Implementations of this class handle the specifics of how sequences are stored and incremented in different\n * database systems.\n * @param {SequenceOptions} options - Configuration options for the sequence generator\n * @class Sequence\n * @example\n * ```typescript\n * // Example implementation for a specific database\n * class PostgresSequence extends Sequence {\n *   constructor(options: SequenceOptions) {\n *     super(options);\n *   }\n *\n *   async next(): Promise<number> {\n *     // Implementation to get next value from PostgreSQL sequence\n *     const result = await this.options.executor.raw(`SELECT nextval('${this.options.name}')`);\n *     return parseInt(result.rows[0].nextval);\n *   }\n *\n *   async current(): Promise<number> {\n *     // Implementation to get current value from PostgreSQL sequence\n *     const result = await this.options.executor.raw(`SELECT currval('${this.options.name}')`);\n *     return parseInt(result.rows[0].currval);\n *   }\n *\n *   async range(count: number): Promise<number[]> {\n *     // Implementation to get a range of values\n *     const values: number[] = [];\n *     for (let i = 0; i < count; i++) {\n *       values.push(await this.next());\n *     }\n *     return values;\n *   }\n * }\n *\n * // Usage\n * const sequence = new PostgresSequence({\n *   name: 'user_id_seq',\n *   executor: dbExecutor\n * });\n *\n * const nextId = await sequence.next();\n * ```\n */\nexport abstract class Sequence {\n  /**\n   * @description Logger instance for this sequence\n   * @summary Lazily initialized logger for the sequence instance\n   */\n  private logger!: Logger;\n\n  /**\n   * @description Accessor for the logger instance\n   * @summary Gets or initializes the logger for this sequence\n   * @return {Logger} The logger instance\n   */\n  protected get log() {\n    if (!this.logger) this.logger = Logging.for(this as any);\n    return this.logger;\n  }\n\n  /**\n   * @description Creates a new sequence instance\n   * @summary Protected constructor that initializes the sequence with the provided options\n   */\n  protected constructor(protected readonly options: SequenceOptions) {}\n\n  /**\n   * @description Gets the next value in the sequence\n   * @summary Retrieves the next value from the sequence, incrementing it in the process\n   * @return A promise that resolves to the next value in the sequence\n   */\n  abstract next(): Promise<string | number | bigint>;\n\n  /**\n   * @description Gets the current value of the sequence\n   * @summary Retrieves the current value of the sequence without incrementing it\n   * @return A promise that resolves to the current value in the sequence\n   */\n  abstract current(): Promise<string | number | bigint>;\n\n  /**\n   * @description Gets a range of sequential values\n   * @summary Retrieves multiple sequential values at once, which can be more efficient than calling next() multiple times\n   * @param {number} count - The number of sequential values to retrieve\n   * @return A promise that resolves to an array of sequential values\n   */\n  abstract range(count: number): Promise<(number | string | bigint)[]>;\n\n  /**\n   * @description Gets the primary key sequence name for a model\n   * @summary Utility method that returns the standardized sequence name for a model's primary key\n   * @template M - The model type\n   * @param {M|Constructor<M>} model - The model instance or constructor\n   * @return {string} The sequence name for the model's primary key\n   */\n  static pk<M extends Model>(model: M | Constructor<M>) {\n    return sequenceNameForModel(model, \"pk\");\n  }\n\n  /**\n   * @description Parses a sequence value to the appropriate type\n   * @summary Converts a sequence value to the specified type (Number or BigInt)\n   * @param {\"Number\"|\"BigInt\"|undefined} type - The target type to convert to\n   * @param {string|number|bigint} value - The value to convert\n   * @return {string|number|bigint} The converted value\n   */\n  static parseValue(\n    type: \"Number\" | \"BigInt\" | undefined,\n    value: string | number | bigint\n  ): string | number | bigint {\n    switch (type) {\n      case \"Number\":\n        return typeof value === \"string\"\n          ? parseInt(value)\n          : typeof value === \"number\"\n            ? value\n            : BigInt(value);\n      case \"BigInt\":\n        return BigInt(value);\n      default:\n        throw new InternalError(\"Should never happen\");\n    }\n  }\n}\n"]}

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

@@ -1,17 +1,39 @@
+/**
+ * @description Persistence-related constant keys
+ * @summary Enum containing string constants used throughout the persistence layer for metadata, relations, and other persistence-related operations
+ * @enum {string}
+ * @readonly
+ * @memberOf module:core
+ */
 export declare enum PersistenceKeys {
+    /** @description Key for index metadata */
     INDEX = "index",
+    /** @description Key for unique constraint metadata */
     UNIQUE = "unique",
+    /** @description Key for adapter metadata */
     ADAPTER = "adapter",
+    /** @description Template for injectable adapter names */
     INJECTABLE = "decaf_{0}_adapter_for_{1}",
+    /** @description Key for table name metadata */
     TABLE = "table",
+    /** @description Key for column name metadata */
     COLUMN = "column",
+    /** @description Key for general metadata storage */
     METADATA = "__metadata",
+    /** @description Key for relations metadata storage */
     RELATIONS = "__relations",
+    /** @description Key for clause sequence metadata */
     CLAUSE_SEQUENCE = "clause-sequence",
+    /** @description Key for created-by ownership metadata */
     CREATED_BY = "ownership.created-by",
+    /** @description Key for updated-by ownership metadata */
     UPDATED_BY = "ownership.updated-by",
+    /** @description Key for one-to-one relation metadata */
     ONE_TO_ONE = "relations.one-to-one",
+    /** @description Key for one-to-many relation metadata */
     ONE_TO_MANY = "relations.one-to-many",
+    /** @description Key for many-to-one relation metadata */
     MANY_TO_ONE = "relations.many-to-one",
+    /** @description Key for populate metadata */
     POPULATE = "populate"
 }

package/lib/esm/persistence/constants.js

@@ -1,21 +1,43 @@
+/**
+ * @description Persistence-related constant keys
+ * @summary Enum containing string constants used throughout the persistence layer for metadata, relations, and other persistence-related operations
+ * @enum {string}
+ * @readonly
+ * @memberOf module:core
+ */
 export var PersistenceKeys;
 (function (PersistenceKeys) {
+    /** @description Key for index metadata */
     PersistenceKeys["INDEX"] = "index";
+    /** @description Key for unique constraint metadata */
     PersistenceKeys["UNIQUE"] = "unique";
+    /** @description Key for adapter metadata */
     PersistenceKeys["ADAPTER"] = "adapter";
+    /** @description Template for injectable adapter names */
     PersistenceKeys["INJECTABLE"] = "decaf_{0}_adapter_for_{1}";
+    /** @description Key for table name metadata */
     PersistenceKeys["TABLE"] = "table";
+    /** @description Key for column name metadata */
     PersistenceKeys["COLUMN"] = "column";
+    /** @description Key for general metadata storage */
     PersistenceKeys["METADATA"] = "__metadata";
+    /** @description Key for relations metadata storage */
     PersistenceKeys["RELATIONS"] = "__relations";
+    /** @description Key for clause sequence metadata */
     PersistenceKeys["CLAUSE_SEQUENCE"] = "clause-sequence";
     // Ownership
+    /** @description Key for created-by ownership metadata */
     PersistenceKeys["CREATED_BY"] = "ownership.created-by";
+    /** @description Key for updated-by ownership metadata */
     PersistenceKeys["UPDATED_BY"] = "ownership.updated-by";
     // Relations
+    /** @description Key for one-to-one relation metadata */
     PersistenceKeys["ONE_TO_ONE"] = "relations.one-to-one";
+    /** @description Key for one-to-many relation metadata */
     PersistenceKeys["ONE_TO_MANY"] = "relations.one-to-many";
+    /** @description Key for many-to-one relation metadata */
     PersistenceKeys["MANY_TO_ONE"] = "relations.many-to-one";
+    /** @description Key for populate metadata */
     PersistenceKeys["POPULATE"] = "populate";
 })(PersistenceKeys || (PersistenceKeys = {}));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3BlcnNpc3RlbmNlL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLENBQU4sSUFBWSxlQWtCWDtBQWxCRCxXQUFZLGVBQWU7SUFDekIsa0NBQWUsQ0FBQTtJQUNmLG9DQUFpQixDQUFBO0lBQ2pCLHNDQUFtQixDQUFBO0lBQ25CLDJEQUF3QyxDQUFBO0lBQ3hDLGtDQUFlLENBQUE7SUFDZixvQ0FBaUIsQ0FBQTtJQUNqQiwwQ0FBdUIsQ0FBQTtJQUN2Qiw0Q0FBeUIsQ0FBQTtJQUN6QixzREFBbUMsQ0FBQTtJQUNuQyxZQUFZO0lBQ1osc0RBQW1DLENBQUE7SUFDbkMsc0RBQW1DLENBQUE7SUFDbkMsWUFBWTtJQUNaLHNEQUFtQyxDQUFBO0lBQ25DLHdEQUFxQyxDQUFBO0lBQ3JDLHdEQUFxQyxDQUFBO0lBQ3JDLHdDQUFxQixDQUFBO0FBQ3ZCLENBQUMsRUFsQlcsZUFBZSxLQUFmLGVBQWUsUUFrQjFCIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGVudW0gUGVyc2lzdGVuY2VLZXlzIHtcbiAgSU5ERVggPSBcImluZGV4XCIsXG4gIFVOSVFVRSA9IFwidW5pcXVlXCIsXG4gIEFEQVBURVIgPSBcImFkYXB0ZXJcIixcbiAgSU5KRUNUQUJMRSA9IFwiZGVjYWZfezB9X2FkYXB0ZXJfZm9yX3sxfVwiLFxuICBUQUJMRSA9IFwidGFibGVcIixcbiAgQ09MVU1OID0gXCJjb2x1bW5cIixcbiAgTUVUQURBVEEgPSBcIl9fbWV0YWRhdGFcIixcbiAgUkVMQVRJT05TID0gXCJfX3JlbGF0aW9uc1wiLFxuICBDTEFVU0VfU0VRVUVOQ0UgPSBcImNsYXVzZS1zZXF1ZW5jZVwiLFxuICAvLyBPd25lcnNoaXBcbiAgQ1JFQVRFRF9CWSA9IFwib3duZXJzaGlwLmNyZWF0ZWQtYnlcIixcbiAgVVBEQVRFRF9CWSA9IFwib3duZXJzaGlwLnVwZGF0ZWQtYnlcIixcbiAgLy8gUmVsYXRpb25zXG4gIE9ORV9UT19PTkUgPSBcInJlbGF0aW9ucy5vbmUtdG8tb25lXCIsXG4gIE9ORV9UT19NQU5ZID0gXCJyZWxhdGlvbnMub25lLXRvLW1hbnlcIixcbiAgTUFOWV9UT19PTkUgPSBcInJlbGF0aW9ucy5tYW55LXRvLW9uZVwiLFxuICBQT1BVTEFURSA9IFwicG9wdWxhdGVcIixcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3BlcnNpc3RlbmNlL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7O0dBTUc7QUFDSCxNQUFNLENBQU4sSUFBWSxlQStDWDtBQS9DRCxXQUFZLGVBQWU7SUFDekIsMENBQTBDO0lBQzFDLGtDQUFlLENBQUE7SUFFZixzREFBc0Q7SUFDdEQsb0NBQWlCLENBQUE7SUFFakIsNENBQTRDO0lBQzVDLHNDQUFtQixDQUFBO0lBRW5CLHlEQUF5RDtJQUN6RCwyREFBd0MsQ0FBQTtJQUV4QywrQ0FBK0M7SUFDL0Msa0NBQWUsQ0FBQTtJQUVmLGdEQUFnRDtJQUNoRCxvQ0FBaUIsQ0FBQTtJQUVqQixvREFBb0Q7SUFDcEQsMENBQXVCLENBQUE7SUFFdkIsc0RBQXNEO0lBQ3RELDRDQUF5QixDQUFBO0lBRXpCLG9EQUFvRDtJQUNwRCxzREFBbUMsQ0FBQTtJQUVuQyxZQUFZO0lBQ1oseURBQXlEO0lBQ3pELHNEQUFtQyxDQUFBO0lBRW5DLHlEQUF5RDtJQUN6RCxzREFBbUMsQ0FBQTtJQUVuQyxZQUFZO0lBQ1osd0RBQXdEO0lBQ3hELHNEQUFtQyxDQUFBO0lBRW5DLHlEQUF5RDtJQUN6RCx3REFBcUMsQ0FBQTtJQUVyQyx5REFBeUQ7SUFDekQsd0RBQXFDLENBQUE7SUFFckMsNkNBQTZDO0lBQzdDLHdDQUFxQixDQUFBO0FBQ3ZCLENBQUMsRUEvQ1csZUFBZSxLQUFmLGVBQWUsUUErQzFCIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gUGVyc2lzdGVuY2UtcmVsYXRlZCBjb25zdGFudCBrZXlzXG4gKiBAc3VtbWFyeSBFbnVtIGNvbnRhaW5pbmcgc3RyaW5nIGNvbnN0YW50cyB1c2VkIHRocm91Z2hvdXQgdGhlIHBlcnNpc3RlbmNlIGxheWVyIGZvciBtZXRhZGF0YSwgcmVsYXRpb25zLCBhbmQgb3RoZXIgcGVyc2lzdGVuY2UtcmVsYXRlZCBvcGVyYXRpb25zXG4gKiBAZW51bSB7c3RyaW5nfVxuICogQHJlYWRvbmx5XG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGVudW0gUGVyc2lzdGVuY2VLZXlzIHtcbiAgLyoqIEBkZXNjcmlwdGlvbiBLZXkgZm9yIGluZGV4IG1ldGFkYXRhICovXG4gIElOREVYID0gXCJpbmRleFwiLFxuXG4gIC8qKiBAZGVzY3JpcHRpb24gS2V5IGZvciB1bmlxdWUgY29uc3RyYWludCBtZXRhZGF0YSAqL1xuICBVTklRVUUgPSBcInVuaXF1ZVwiLFxuXG4gIC8qKiBAZGVzY3JpcHRpb24gS2V5IGZvciBhZGFwdGVyIG1ldGFkYXRhICovXG4gIEFEQVBURVIgPSBcImFkYXB0ZXJcIixcblxuICAvKiogQGRlc2NyaXB0aW9uIFRlbXBsYXRlIGZvciBpbmplY3RhYmxlIGFkYXB0ZXIgbmFtZXMgKi9cbiAgSU5KRUNUQUJMRSA9IFwiZGVjYWZfezB9X2FkYXB0ZXJfZm9yX3sxfVwiLFxuXG4gIC8qKiBAZGVzY3JpcHRpb24gS2V5IGZvciB0YWJsZSBuYW1lIG1ldGFkYXRhICovXG4gIFRBQkxFID0gXCJ0YWJsZVwiLFxuXG4gIC8qKiBAZGVzY3JpcHRpb24gS2V5IGZvciBjb2x1bW4gbmFtZSBtZXRhZGF0YSAqL1xuICBDT0xVTU4gPSBcImNvbHVtblwiLFxuXG4gIC8qKiBAZGVzY3JpcHRpb24gS2V5IGZvciBnZW5lcmFsIG1ldGFkYXRhIHN0b3JhZ2UgKi9cbiAgTUVUQURBVEEgPSBcIl9fbWV0YWRhdGFcIixcblxuICAvKiogQGRlc2NyaXB0aW9uIEtleSBmb3IgcmVsYXRpb25zIG1ldGFkYXRhIHN0b3JhZ2UgKi9cbiAgUkVMQVRJT05TID0gXCJfX3JlbGF0aW9uc1wiLFxuXG4gIC8qKiBAZGVzY3JpcHRpb24gS2V5IGZvciBjbGF1c2Ugc2VxdWVuY2UgbWV0YWRhdGEgKi9cbiAgQ0xBVVNFX1NFUVVFTkNFID0gXCJjbGF1c2Utc2VxdWVuY2VcIixcblxuICAvLyBPd25lcnNoaXBcbiAgLyoqIEBkZXNjcmlwdGlvbiBLZXkgZm9yIGNyZWF0ZWQtYnkgb3duZXJzaGlwIG1ldGFkYXRhICovXG4gIENSRUFURURfQlkgPSBcIm93bmVyc2hpcC5jcmVhdGVkLWJ5XCIsXG5cbiAgLyoqIEBkZXNjcmlwdGlvbiBLZXkgZm9yIHVwZGF0ZWQtYnkgb3duZXJzaGlwIG1ldGFkYXRhICovXG4gIFVQREFURURfQlkgPSBcIm93bmVyc2hpcC51cGRhdGVkLWJ5XCIsXG5cbiAgLy8gUmVsYXRpb25zXG4gIC8qKiBAZGVzY3JpcHRpb24gS2V5IGZvciBvbmUtdG8tb25lIHJlbGF0aW9uIG1ldGFkYXRhICovXG4gIE9ORV9UT19PTkUgPSBcInJlbGF0aW9ucy5vbmUtdG8tb25lXCIsXG5cbiAgLyoqIEBkZXNjcmlwdGlvbiBLZXkgZm9yIG9uZS10by1tYW55IHJlbGF0aW9uIG1ldGFkYXRhICovXG4gIE9ORV9UT19NQU5ZID0gXCJyZWxhdGlvbnMub25lLXRvLW1hbnlcIixcblxuICAvKiogQGRlc2NyaXB0aW9uIEtleSBmb3IgbWFueS10by1vbmUgcmVsYXRpb24gbWV0YWRhdGEgKi9cbiAgTUFOWV9UT19PTkUgPSBcInJlbGF0aW9ucy5tYW55LXRvLW9uZVwiLFxuXG4gIC8qKiBAZGVzY3JpcHRpb24gS2V5IGZvciBwb3B1bGF0ZSBtZXRhZGF0YSAqL1xuICBQT1BVTEFURSA9IFwicG9wdWxhdGVcIixcbn1cbiJdfQ==

package/lib/esm/persistence/decorators.d.ts

@@ -1 +1,11 @@
+/**
+ * @description Specifies which persistence adapter flavor a model should use
+ * @summary This decorator applies metadata to a model class to indicate which persistence adapter flavor
+ * should be used when performing database operations on instances of the model. The flavor is a string
+ * identifier that corresponds to a registered adapter configuration.
+ * @param {string} flavour - The identifier of the adapter flavor to use
+ * @return {Function} A decorator function that can be applied to a model class
+ * @function uses
+ * @category Class Decorators
+ */
 export declare function uses(flavour: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;

package/lib/esm/persistence/decorators.js

@@ -1,7 +1,17 @@
 import { apply, metadata } from "@decaf-ts/reflection";
-import { PersistenceKeys } from "./constants";
-import { Adapter } from "./Adapter";
+import { PersistenceKeys } from "./constants.js";
+import { Adapter } from "./Adapter.js";
+/**
+ * @description Specifies which persistence adapter flavor a model should use
+ * @summary This decorator applies metadata to a model class to indicate which persistence adapter flavor
+ * should be used when performing database operations on instances of the model. The flavor is a string
+ * identifier that corresponds to a registered adapter configuration.
+ * @param {string} flavour - The identifier of the adapter flavor to use
+ * @return {Function} A decorator function that can be applied to a model class
+ * @function uses
+ * @category Class Decorators
+ */
 export function uses(flavour) {
     return apply(metadata(Adapter.key(PersistenceKeys.ADAPTER), flavour));
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9wZXJzaXN0ZW5jZS9kZWNvcmF0b3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxLQUFLLEVBQUUsUUFBUSxFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFDdkQsT0FBTyxFQUFFLGVBQWUsRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUM5QyxPQUFPLEVBQUUsT0FBTyxFQUFFLE1BQU0sV0FBVyxDQUFDO0FBRXBDLE1BQU0sVUFBVSxJQUFJLENBQUMsT0FBZTtJQUNsQyxPQUFPLEtBQUssQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxlQUFlLENBQUMsT0FBTyxDQUFDLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQztBQUN4RSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgYXBwbHksIG1ldGFkYXRhIH0gZnJvbSBcIkBkZWNhZi10cy9yZWZsZWN0aW9uXCI7XG5pbXBvcnQgeyBQZXJzaXN0ZW5jZUtleXMgfSBmcm9tIFwiLi9jb25zdGFudHNcIjtcbmltcG9ydCB7IEFkYXB0ZXIgfSBmcm9tIFwiLi9BZGFwdGVyXCI7XG5cbmV4cG9ydCBmdW5jdGlvbiB1c2VzKGZsYXZvdXI6IHN0cmluZykge1xuICByZXR1cm4gYXBwbHkobWV0YWRhdGEoQWRhcHRlci5rZXkoUGVyc2lzdGVuY2VLZXlzLkFEQVBURVIpLCBmbGF2b3VyKSk7XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9wZXJzaXN0ZW5jZS9kZWNvcmF0b3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxLQUFLLEVBQUUsUUFBUSxFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFDdkQsT0FBTyxFQUFFLGVBQWUsRUFBRSx1QkFBb0I7QUFDOUMsT0FBTyxFQUFFLE9BQU8sRUFBRSxxQkFBa0I7QUFFcEM7Ozs7Ozs7OztHQVNHO0FBQ0gsTUFBTSxVQUFVLElBQUksQ0FBQyxPQUFlO0lBQ2xDLE9BQU8sS0FBSyxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLGVBQWUsQ0FBQyxPQUFPLENBQUMsRUFBRSxPQUFPLENBQUMsQ0FBQyxDQUFDO0FBQ3hFLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBhcHBseSwgbWV0YWRhdGEgfSBmcm9tIFwiQGRlY2FmLXRzL3JlZmxlY3Rpb25cIjtcbmltcG9ydCB7IFBlcnNpc3RlbmNlS2V5cyB9IGZyb20gXCIuL2NvbnN0YW50c1wiO1xuaW1wb3J0IHsgQWRhcHRlciB9IGZyb20gXCIuL0FkYXB0ZXJcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gU3BlY2lmaWVzIHdoaWNoIHBlcnNpc3RlbmNlIGFkYXB0ZXIgZmxhdm9yIGEgbW9kZWwgc2hvdWxkIHVzZVxuICogQHN1bW1hcnkgVGhpcyBkZWNvcmF0b3IgYXBwbGllcyBtZXRhZGF0YSB0byBhIG1vZGVsIGNsYXNzIHRvIGluZGljYXRlIHdoaWNoIHBlcnNpc3RlbmNlIGFkYXB0ZXIgZmxhdm9yXG4gKiBzaG91bGQgYmUgdXNlZCB3aGVuIHBlcmZvcm1pbmcgZGF0YWJhc2Ugb3BlcmF0aW9ucyBvbiBpbnN0YW5jZXMgb2YgdGhlIG1vZGVsLiBUaGUgZmxhdm9yIGlzIGEgc3RyaW5nXG4gKiBpZGVudGlmaWVyIHRoYXQgY29ycmVzcG9uZHMgdG8gYSByZWdpc3RlcmVkIGFkYXB0ZXIgY29uZmlndXJhdGlvbi5cbiAqIEBwYXJhbSB7c3RyaW5nfSBmbGF2b3VyIC0gVGhlIGlkZW50aWZpZXIgb2YgdGhlIGFkYXB0ZXIgZmxhdm9yIHRvIHVzZVxuICogQHJldHVybiB7RnVuY3Rpb259IEEgZGVjb3JhdG9yIGZ1bmN0aW9uIHRoYXQgY2FuIGJlIGFwcGxpZWQgdG8gYSBtb2RlbCBjbGFzc1xuICogQGZ1bmN0aW9uIHVzZXNcbiAqIEBjYXRlZ29yeSBDbGFzcyBEZWNvcmF0b3JzXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiB1c2VzKGZsYXZvdXI6IHN0cmluZykge1xuICByZXR1cm4gYXBwbHkobWV0YWRhdGEoQWRhcHRlci5rZXkoUGVyc2lzdGVuY2VLZXlzLkFEQVBURVIpLCBmbGF2b3VyKSk7XG59XG4iXX0=

package/lib/esm/persistence/errors.d.ts

@@ -1,4 +1,27 @@
 import { BaseError } from "@decaf-ts/db-decorators";
+/**
+ * @description Error thrown when an unsupported operation is attempted
+ * @summary This error is thrown when an operation is requested that is not supported by the current
+ * persistence adapter or configuration. It extends the BaseError class and sets a 500 status code.
+ * @param {string|Error} msg - The error message or an Error object to wrap
+ * @class UnsupportedError
+ * @example
+ * ```typescript
+ * // Throwing an UnsupportedError
+ * if (!adapter.supportsTransactions()) {
+ *   throw new UnsupportedError('Transactions are not supported by this adapter');
+ * }
+ *
+ * // Catching an UnsupportedError
+ * try {
+ *   await adapter.beginTransaction();
+ * } catch (error) {
+ *   if (error instanceof UnsupportedError) {
+ *     console.error('Operation not supported:', error.message);
+ *   }
+ * }
+ * ```
+ */
 export declare class UnsupportedError extends BaseError {
     constructor(msg: string | Error);
 }

package/lib/esm/persistence/errors.js

@@ -1,7 +1,30 @@
 import { BaseError } from "@decaf-ts/db-decorators";
+/**
+ * @description Error thrown when an unsupported operation is attempted
+ * @summary This error is thrown when an operation is requested that is not supported by the current
+ * persistence adapter or configuration. It extends the BaseError class and sets a 500 status code.
+ * @param {string|Error} msg - The error message or an Error object to wrap
+ * @class UnsupportedError
+ * @example
+ * ```typescript
+ * // Throwing an UnsupportedError
+ * if (!adapter.supportsTransactions()) {
+ *   throw new UnsupportedError('Transactions are not supported by this adapter');
+ * }
+ *
+ * // Catching an UnsupportedError
+ * try {
+ *   await adapter.beginTransaction();
+ * } catch (error) {
+ *   if (error instanceof UnsupportedError) {
+ *     console.error('Operation not supported:', error.message);
+ *   }
+ * }
+ * ```
+ */
 export class UnsupportedError extends BaseError {
     constructor(msg) {
         super(UnsupportedError.name, msg, 500);
     }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3BlcnNpc3RlbmNlL2Vycm9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0seUJBQXlCLENBQUM7QUFFcEQsTUFBTSxPQUFPLGdCQUFpQixTQUFRLFNBQVM7SUFDN0MsWUFBWSxHQUFtQjtRQUM3QixLQUFLLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxFQUFFLEdBQUcsRUFBRSxHQUFHLENBQUMsQ0FBQztJQUN6QyxDQUFDO0NBQ0YiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBCYXNlRXJyb3IgfSBmcm9tIFwiQGRlY2FmLXRzL2RiLWRlY29yYXRvcnNcIjtcblxuZXhwb3J0IGNsYXNzIFVuc3VwcG9ydGVkRXJyb3IgZXh0ZW5kcyBCYXNlRXJyb3Ige1xuICBjb25zdHJ1Y3Rvcihtc2c6IHN0cmluZyB8IEVycm9yKSB7XG4gICAgc3VwZXIoVW5zdXBwb3J0ZWRFcnJvci5uYW1lLCBtc2csIDUwMCk7XG4gIH1cbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3BlcnNpc3RlbmNlL2Vycm9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0seUJBQXlCLENBQUM7QUFFcEQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FzQkc7QUFDSCxNQUFNLE9BQU8sZ0JBQWlCLFNBQVEsU0FBUztJQUM3QyxZQUFZLEdBQW1CO1FBQzdCLEtBQUssQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLEVBQUUsR0FBRyxFQUFFLEdBQUcsQ0FBQyxDQUFDO0lBQ3pDLENBQUM7Q0FDRiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEJhc2VFcnJvciB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBFcnJvciB0aHJvd24gd2hlbiBhbiB1bnN1cHBvcnRlZCBvcGVyYXRpb24gaXMgYXR0ZW1wdGVkXG4gKiBAc3VtbWFyeSBUaGlzIGVycm9yIGlzIHRocm93biB3aGVuIGFuIG9wZXJhdGlvbiBpcyByZXF1ZXN0ZWQgdGhhdCBpcyBub3Qgc3VwcG9ydGVkIGJ5IHRoZSBjdXJyZW50XG4gKiBwZXJzaXN0ZW5jZSBhZGFwdGVyIG9yIGNvbmZpZ3VyYXRpb24uIEl0IGV4dGVuZHMgdGhlIEJhc2VFcnJvciBjbGFzcyBhbmQgc2V0cyBhIDUwMCBzdGF0dXMgY29kZS5cbiAqIEBwYXJhbSB7c3RyaW5nfEVycm9yfSBtc2cgLSBUaGUgZXJyb3IgbWVzc2FnZSBvciBhbiBFcnJvciBvYmplY3QgdG8gd3JhcFxuICogQGNsYXNzIFVuc3VwcG9ydGVkRXJyb3JcbiAqIEBleGFtcGxlXG4gKiBgYGB0eXBlc2NyaXB0XG4gKiAvLyBUaHJvd2luZyBhbiBVbnN1cHBvcnRlZEVycm9yXG4gKiBpZiAoIWFkYXB0ZXIuc3VwcG9ydHNUcmFuc2FjdGlvbnMoKSkge1xuICogICB0aHJvdyBuZXcgVW5zdXBwb3J0ZWRFcnJvcignVHJhbnNhY3Rpb25zIGFyZSBub3Qgc3VwcG9ydGVkIGJ5IHRoaXMgYWRhcHRlcicpO1xuICogfVxuICogXG4gKiAvLyBDYXRjaGluZyBhbiBVbnN1cHBvcnRlZEVycm9yXG4gKiB0cnkge1xuICogICBhd2FpdCBhZGFwdGVyLmJlZ2luVHJhbnNhY3Rpb24oKTtcbiAqIH0gY2F0Y2ggKGVycm9yKSB7XG4gKiAgIGlmIChlcnJvciBpbnN0YW5jZW9mIFVuc3VwcG9ydGVkRXJyb3IpIHtcbiAqICAgICBjb25zb2xlLmVycm9yKCdPcGVyYXRpb24gbm90IHN1cHBvcnRlZDonLCBlcnJvci5tZXNzYWdlKTtcbiAqICAgfVxuICogfVxuICogYGBgXG4gKi9cbmV4cG9ydCBjbGFzcyBVbnN1cHBvcnRlZEVycm9yIGV4dGVuZHMgQmFzZUVycm9yIHtcbiAgY29uc3RydWN0b3IobXNnOiBzdHJpbmcgfCBFcnJvcikge1xuICAgIHN1cGVyKFVuc3VwcG9ydGVkRXJyb3IubmFtZSwgbXNnLCA1MDApO1xuICB9XG59XG4iXX0=

package/lib/esm/persistence/index.js

@@ -1,9 +1,9 @@
-export * from "./Adapter";
-export * from "./constants";
-export * from "./decorators";
-export * from "./Dispatch";
-export * from "./errors";
-export * from "./ObserverHandler";
-export * from "./Sequence";
-export * from "./types";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcGVyc2lzdGVuY2UvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxXQUFXLENBQUM7QUFDMUIsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxZQUFZLENBQUM7QUFDM0IsY0FBYyxVQUFVLENBQUM7QUFDekIsY0FBYyxtQkFBbUIsQ0FBQztBQUNsQyxjQUFjLFlBQVksQ0FBQztBQUMzQixjQUFjLFNBQVMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gXCIuL0FkYXB0ZXJcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2NvbnN0YW50c1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vZGVjb3JhdG9yc1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vRGlzcGF0Y2hcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2Vycm9yc1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vT2JzZXJ2ZXJIYW5kbGVyXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9TZXF1ZW5jZVwiO1xuZXhwb3J0ICogZnJvbSBcIi4vdHlwZXNcIjtcbiJdfQ==
+export * from "./Adapter.js";
+export * from "./constants.js";
+export * from "./decorators.js";
+export * from "./Dispatch.js";
+export * from "./errors.js";
+export * from "./ObserverHandler.js";
+export * from "./Sequence.js";
+export * from "./types.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcGVyc2lzdGVuY2UvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsNkJBQTBCO0FBQzFCLCtCQUE0QjtBQUM1QixnQ0FBNkI7QUFDN0IsOEJBQTJCO0FBQzNCLDRCQUF5QjtBQUN6QixxQ0FBa0M7QUFDbEMsOEJBQTJCO0FBQzNCLDJCQUF3QiIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gXCIuL0FkYXB0ZXJcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2NvbnN0YW50c1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vZGVjb3JhdG9yc1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vRGlzcGF0Y2hcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2Vycm9yc1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vT2JzZXJ2ZXJIYW5kbGVyXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9TZXF1ZW5jZVwiO1xuZXhwb3J0ICogZnJvbSBcIi4vdHlwZXNcIjtcbiJdfQ==

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

@@ -1,3 +1,21 @@
 import { BulkCrudOperationKeys, OperationKeys } from "@decaf-ts/db-decorators";
+/**
+ * @description Type representing possible ID formats for database events
+ * @summary A union type that defines the possible formats for event identifiers in the persistence layer.
+ * These can be single values (string, number, bigint) or arrays of these types.
+ * @typedef {(string|number|bigint|string[]|number[]|bigint[])} EventIds
+ * @memberOf module:core
+ */
 export type EventIds = string | number | bigint | string[] | number[] | bigint[];
+/**
+ * @description Function type for filtering observer notifications
+ * @summary A function type that defines a predicate used to determine whether an observer should be notified
+ * about a specific database event. The filter examines the table name, event type, and affected IDs.
+ * @param {string} table - The name of the database table where the event occurred
+ * @param {(OperationKeys|BulkCrudOperationKeys|string)} event - The type of operation that triggered the event
+ * @param {EventIds} id - The identifier(s) of the affected record(s)
+ * @return {boolean} True if the observer should be notified, false otherwise
+ * @typedef {Function} ObserverFilter
+ * @memberOf module:core
+ */
 export type ObserverFilter = (table: string, event: OperationKeys | BulkCrudOperationKeys | string, id: EventIds) => boolean;

package/lib/esm/persistence/types.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcGVyc2lzdGVuY2UvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEJ1bGtDcnVkT3BlcmF0aW9uS2V5cywgT3BlcmF0aW9uS2V5cyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG5leHBvcnQgdHlwZSBFdmVudElkcyA9XG4gIHwgc3RyaW5nXG4gIHwgbnVtYmVyXG4gIHwgYmlnaW50XG4gIHwgc3RyaW5nW11cbiAgfCBudW1iZXJbXVxuICB8IGJpZ2ludFtdO1xuXG5leHBvcnQgdHlwZSBPYnNlcnZlckZpbHRlciA9IChcbiAgdGFibGU6IHN0cmluZyxcbiAgZXZlbnQ6IE9wZXJhdGlvbktleXMgfCBCdWxrQ3J1ZE9wZXJhdGlvbktleXMgfCBzdHJpbmcsXG4gIGlkOiBFdmVudElkc1xuKSA9PiBib29sZWFuO1xuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcGVyc2lzdGVuY2UvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEJ1bGtDcnVkT3BlcmF0aW9uS2V5cywgT3BlcmF0aW9uS2V5cyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUeXBlIHJlcHJlc2VudGluZyBwb3NzaWJsZSBJRCBmb3JtYXRzIGZvciBkYXRhYmFzZSBldmVudHNcbiAqIEBzdW1tYXJ5IEEgdW5pb24gdHlwZSB0aGF0IGRlZmluZXMgdGhlIHBvc3NpYmxlIGZvcm1hdHMgZm9yIGV2ZW50IGlkZW50aWZpZXJzIGluIHRoZSBwZXJzaXN0ZW5jZSBsYXllci5cbiAqIFRoZXNlIGNhbiBiZSBzaW5nbGUgdmFsdWVzIChzdHJpbmcsIG51bWJlciwgYmlnaW50KSBvciBhcnJheXMgb2YgdGhlc2UgdHlwZXMuXG4gKiBAdHlwZWRlZiB7KHN0cmluZ3xudW1iZXJ8YmlnaW50fHN0cmluZ1tdfG51bWJlcltdfGJpZ2ludFtdKX0gRXZlbnRJZHNcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgdHlwZSBFdmVudElkcyA9XG4gIHwgc3RyaW5nXG4gIHwgbnVtYmVyXG4gIHwgYmlnaW50XG4gIHwgc3RyaW5nW11cbiAgfCBudW1iZXJbXVxuICB8IGJpZ2ludFtdO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBGdW5jdGlvbiB0eXBlIGZvciBmaWx0ZXJpbmcgb2JzZXJ2ZXIgbm90aWZpY2F0aW9uc1xuICogQHN1bW1hcnkgQSBmdW5jdGlvbiB0eXBlIHRoYXQgZGVmaW5lcyBhIHByZWRpY2F0ZSB1c2VkIHRvIGRldGVybWluZSB3aGV0aGVyIGFuIG9ic2VydmVyIHNob3VsZCBiZSBub3RpZmllZFxuICogYWJvdXQgYSBzcGVjaWZpYyBkYXRhYmFzZSBldmVudC4gVGhlIGZpbHRlciBleGFtaW5lcyB0aGUgdGFibGUgbmFtZSwgZXZlbnQgdHlwZSwgYW5kIGFmZmVjdGVkIElEcy5cbiAqIEBwYXJhbSB7c3RyaW5nfSB0YWJsZSAtIFRoZSBuYW1lIG9mIHRoZSBkYXRhYmFzZSB0YWJsZSB3aGVyZSB0aGUgZXZlbnQgb2NjdXJyZWRcbiAqIEBwYXJhbSB7KE9wZXJhdGlvbktleXN8QnVsa0NydWRPcGVyYXRpb25LZXlzfHN0cmluZyl9IGV2ZW50IC0gVGhlIHR5cGUgb2Ygb3BlcmF0aW9uIHRoYXQgdHJpZ2dlcmVkIHRoZSBldmVudFxuICogQHBhcmFtIHtFdmVudElkc30gaWQgLSBUaGUgaWRlbnRpZmllcihzKSBvZiB0aGUgYWZmZWN0ZWQgcmVjb3JkKHMpXG4gKiBAcmV0dXJuIHtib29sZWFufSBUcnVlIGlmIHRoZSBvYnNlcnZlciBzaG91bGQgYmUgbm90aWZpZWQsIGZhbHNlIG90aGVyd2lzZVxuICogQHR5cGVkZWYge0Z1bmN0aW9ufSBPYnNlcnZlckZpbHRlclxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKi9cbmV4cG9ydCB0eXBlIE9ic2VydmVyRmlsdGVyID0gKFxuICB0YWJsZTogc3RyaW5nLFxuICBldmVudDogT3BlcmF0aW9uS2V5cyB8IEJ1bGtDcnVkT3BlcmF0aW9uS2V5cyB8IHN0cmluZyxcbiAgaWQ6IEV2ZW50SWRzXG4pID0+IGJvb2xlYW47XG4iXX0=

package/lib/esm/query/Condition.d.ts

@@ -2,14 +2,27 @@ import { AttributeOption, ConditionBuilderOption } from "./options";
 import { Model, ModelErrorDefinition } from "@decaf-ts/decorator-validation";
 import { GroupOperator, Operator } from "./constants";
 /**
- * @summary Condition Class
- * @description Represents a logical condition
+ * @description Represents a logical condition for database queries
+ * @summary A class that encapsulates query conditions with support for complex logical operations.
+ * This class allows for building and combining query conditions using logical operators (AND, OR, NOT)
+ * and comparison operators (equals, not equals, greater than, etc.).
+ * @template M - The model type this condition operates on
+ * @param {string | Condition<M>} attr1 - The attribute name or a nested condition
+ * @param {Operator | GroupOperator} operator - The operator to use for the condition
+ * @param {any} comparison - The value to compare against or another condition
+ * @class Condition
+ * @example
+ * // Create a simple condition
+ * const nameCondition = Condition.attribute("name").eq("John");
  *
- * @param {string | Condition} attr1
- * @param {Operator | GroupOperator} operator
- * @param {string | Condition} comparison
+ * // Create a complex condition
+ * const complexCondition = Condition.attribute("age").gt(18)
+ *   .and(Condition.attribute("status").eq("active"));
  *
- * @class Condition
+ * // Use the builder pattern
+ * const userQuery = Condition.builder()
+ *   .attribute("email").regexp(".*@example.com")
+ *   .and(Condition.attribute("lastLogin").gt(new Date("2023-01-01")));
  */
 export declare class Condition<M extends Model> extends Model {
     protected attr1?: string | Condition<M>;
@@ -17,56 +30,90 @@ export declare class Condition<M extends Model> extends Model {
     protected comparison?: any;
     private constructor();
     /**
-     * @summary Joins 2 {@link Condition}s on an {@link Operator#AND} operation
-     * @param {Condition} condition
+     * @description Combines this condition with another using logical AND
+     * @summary Joins two conditions with an AND operator, requiring both to be true
+     * @param {Condition<M>} condition - The condition to combine with this one
+     * @return {Condition<M>} A new condition representing the AND operation
      */
     and(condition: Condition<M>): Condition<M>;
     /**
-     * @summary Joins 2 {@link Condition}s on an {@link Operator#OR} operation
-     * @param {Condition} condition
+     * @description Combines this condition with another using logical OR
+     * @summary Joins two conditions with an OR operator, requiring at least one to be true
+     * @param {Condition<M>} condition - The condition to combine with this one
+     * @return {Condition<M>} A new condition representing the OR operation
      */
     or(condition: Condition<M>): Condition<M>;
     /**
-     * @summary excludes a valut from the result
-     * @param val
+     * @description Creates a negation condition
+     * @summary Excludes a value from the result by applying a NOT operator
+     * @param {any} val - The value to negate
+     * @return {Condition<M>} A new condition representing the NOT operation
      */
     not(val: any): Condition<M>;
     /**
-     * @inheritDoc
+     * @description Validates the condition and checks for errors
+     * @summary Extends the base validation to ensure the condition is properly formed
+     * @param {...string[]} exceptions - Fields to exclude from validation
+     * @return {ModelErrorDefinition | undefined} Error definition if validation fails, undefined otherwise
      */
     hasErrors(...exceptions: string[]): ModelErrorDefinition | undefined;
     /**
-     * @summary Joins 2 {@link Condition}s on an {@link Operator#AND} operation
-     * @param {Condition} condition1
-     * @param {Condition} condition2
+     * @description Creates a new condition that combines two conditions with logical AND
+     * @summary Static method that joins two conditions with an AND operator, requiring both to be true
+     * @template M - The model type this condition operates on
+     * @param {Condition<M>} condition1 - The first condition
+     * @param {Condition<M>} condition2 - The second condition
+     * @return {Condition<M>} A new condition representing the AND operation
      */
     static and<M extends Model>(condition1: Condition<M>, condition2: Condition<M>): Condition<M>;
     /**
-     * @summary Joins 2 {@link Condition}s on an {@link Operator#OR} operation
-     * @param {Condition} condition1
-     * @param {Condition} condition2
+     * @description Creates a new condition that combines two conditions with logical OR
+     * @summary Static method that joins two conditions with an OR operator, requiring at least one to be true
+     * @template M - The model type this condition operates on
+     * @param {Condition<M>} condition1 - The first condition
+     * @param {Condition<M>} condition2 - The second condition
+     * @return {Condition<M>} A new condition representing the OR operation
      */
     static or<M extends Model>(condition1: Condition<M>, condition2: Condition<M>): Condition<M>;
     /**
-     * @summary Groups 2 {@link Condition}s by the specified {@link GroupOperator}
-     * @param {Condition} condition1
-     * @param {GroupOperator} operator
-     * @param {Condition} condition2
+     * @description Creates a new condition that groups two conditions with a specified operator
+     * @summary Private static method that combines two conditions using the specified group operator
+     * @template M - The model type this condition operates on
+     * @param {Condition<M>} condition1 - The first condition
+     * @param {GroupOperator} operator - The group operator to use (AND, OR)
+     * @param {Condition<M>} condition2 - The second condition
+     * @return {Condition<M>} A new condition representing the grouped operation
      */
     private static group;
+    /**
+     * @description Creates a condition builder for a specific model attribute
+     * @summary Static method that initializes a condition builder with the specified attribute
+     * @template M - The model type this condition operates on
+     * @param attr - The model attribute to build a condition for
+     * @return {AttributeOption<M>} A condition builder initialized with the attribute
+     */
     static attribute<M extends Model>(attr: keyof M): AttributeOption<M>;
+    /**
+     * @description Alias for the attribute method
+     * @summary Shorthand method that initializes a condition builder with the specified attribute
+     * @template M - The model type this condition operates on
+     * @param attr - The model attribute to build a condition for
+     * @return {AttributeOption<M>} A condition builder initialized with the attribute
+     */
     static attr<M extends Model>(attr: keyof M): AttributeOption<M>;
     /**
-     * @summary Condition Builder Class
-     * @description provides a simple API to build {@link Condition}s
-     *
+     * @description Provides a fluent API to build query conditions
+     * @summary A builder class that simplifies the creation of database query conditions
+     * with a chainable interface for setting attributes and operators
+     * @template M - The model type this condition builder operates on
      * @class ConditionBuilder
-     * @implements Builder
-     * @implements AttributeOption
-     *
-     * @category Query
-     * @subcategory Conditions
      */
     private static Builder;
+    /**
+     * @description Creates a new condition builder
+     * @summary Factory method that returns a new instance of the condition builder
+     * @template M - The model type this condition builder will operate on
+     * @return {ConditionBuilderOption<M>} A new condition builder instance
+     */
     static builder<M extends Model>(): ConditionBuilderOption<M>;
 }