@decaf-ts/core 0.5.1 → 0.5.2

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

@@ -3,16 +3,61 @@ import { SequenceOptions } from "../interfaces/SequenceOptions";
 import { RepositoryFlags } from "@decaf-ts/db-decorators";
 import { Repo } from "../repository/Repository";
 import { Context } from "@decaf-ts/db-decorators";
-export declare function pkOnCreate<M extends Model, R extends Repo<M, F, C>, V extends SequenceOptions, F extends RepositoryFlags, C extends Context<F>>(this: R, context: Context<F>, data: V, key: keyof M, model: M): Promise<void>;
 /**
- * @summary Primary Key Decorator
- * @description Marks the property as the {@link Model}s primary key.
- *  Also marks the property as {@link unique} as {@required} and ensures the index is created properly according to the provided {@link Sequence}
+ * @description Callback function for primary key creation
+ * @summary Handles the creation of primary key values for models using sequences
+ * @template M - Type that extends Model
+ * @template R - Type that extends Repo<M, F, C>
+ * @template V - Type that extends SequenceOptions
+ * @template F - Type that extends RepositoryFlags
+ * @template C - Type that extends Context<F>
+ * @param {Context<F>} context - The execution context
+ * @param {V} data - The sequence options
+ * @param key - The property key to set as primary key
+ * @param {M} model - The model instance
+ * @return {Promise<void>} A promise that resolves when the primary key is set
+ * @function pkOnCreate
+ * @category Property Decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant pkOnCreate
+ *   participant Adapter
+ *   participant Sequence
  *
+ *   Model->>pkOnCreate: Call with model instance
+ *   Note over pkOnCreate: Check if key already exists
+ *   alt Key exists or no type specified
+ *     pkOnCreate-->>Model: Return early
+ *   else Key needs to be created
+ *     pkOnCreate->>pkOnCreate: Generate sequence name if not provided
+ *     pkOnCreate->>Adapter: Request Sequence(data)
+ *     Adapter->>Sequence: Create sequence
+ *     Sequence-->>pkOnCreate: Return sequence
+ *     pkOnCreate->>Sequence: Call next()
+ *     Sequence-->>pkOnCreate: Return next value
+ *     pkOnCreate->>Model: Set primary key value
+ *   end
+ */
+export declare function pkOnCreate<M extends Model, R extends Repo<M, F, C>, V extends SequenceOptions, F extends RepositoryFlags, C extends Context<F>>(this: R, context: Context<F>, data: V, key: keyof M, model: M): Promise<void>;
+/**
+ * @description Primary Key Decorator
+ * @summary Marks a property as the model's primary key with automatic sequence generation
+ * This decorator combines multiple behaviors: it marks the property as unique, required,
+ * and ensures the index is created properly according to the provided sequence options.
+ * @param {Omit<SequenceOptions, "cycle" | "startWith" | "incrementBy">} opts - Options for the sequence generation
+ * @return {PropertyDecorator} A property decorator that can be applied to model properties
  * @function pk
+ * @category Property Decorators
+ * @example
+ * ```typescript
+ * class User extends BaseModel {
+ *   @pk()
+ *   id!: string;
  *
- * @see unique
- * @see required
- * @see on
+ *   @required()
+ *   username!: string;
+ * }
+ * ```
  */
 export declare function pk(opts?: Omit<SequenceOptions, "cycle" | "startWith" | "incrementBy">): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;

package/lib/esm/identity/decorators.js

@@ -5,6 +5,42 @@ import { Repository } from "../repository/Repository";
 import { index } from "../model/decorators";
 import { sequenceNameForModel } from "./utils";
 import { OrderDirection } from "../repository";
+/**
+ * @description Callback function for primary key creation
+ * @summary Handles the creation of primary key values for models using sequences
+ * @template M - Type that extends Model
+ * @template R - Type that extends Repo<M, F, C>
+ * @template V - Type that extends SequenceOptions
+ * @template F - Type that extends RepositoryFlags
+ * @template C - Type that extends Context<F>
+ * @param {Context<F>} context - The execution context
+ * @param {V} data - The sequence options
+ * @param key - The property key to set as primary key
+ * @param {M} model - The model instance
+ * @return {Promise<void>} A promise that resolves when the primary key is set
+ * @function pkOnCreate
+ * @category Property Decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant pkOnCreate
+ *   participant Adapter
+ *   participant Sequence
+ *
+ *   Model->>pkOnCreate: Call with model instance
+ *   Note over pkOnCreate: Check if key already exists
+ *   alt Key exists or no type specified
+ *     pkOnCreate-->>Model: Return early
+ *   else Key needs to be created
+ *     pkOnCreate->>pkOnCreate: Generate sequence name if not provided
+ *     pkOnCreate->>Adapter: Request Sequence(data)
+ *     Adapter->>Sequence: Create sequence
+ *     Sequence-->>pkOnCreate: Return sequence
+ *     pkOnCreate->>Sequence: Call next()
+ *     Sequence-->>pkOnCreate: Return next value
+ *     pkOnCreate->>Model: Set primary key value
+ *   end
+ */
 export async function pkOnCreate(context, data, key, model) {
     if (!data.type || model[key]) {
         return;
@@ -30,15 +66,24 @@ export async function pkOnCreate(context, data, key, model) {
     setPrimaryKeyValue(model, key, next);
 }
 /**
- * @summary Primary Key Decorator
- * @description Marks the property as the {@link Model}s primary key.
- *  Also marks the property as {@link unique} as {@required} and ensures the index is created properly according to the provided {@link Sequence}
- *
+ * @description Primary Key Decorator
+ * @summary Marks a property as the model's primary key with automatic sequence generation
+ * This decorator combines multiple behaviors: it marks the property as unique, required,
+ * and ensures the index is created properly according to the provided sequence options.
+ * @param {Omit<SequenceOptions, "cycle" | "startWith" | "incrementBy">} opts - Options for the sequence generation
+ * @return {PropertyDecorator} A property decorator that can be applied to model properties
  * @function pk
+ * @category Property Decorators
+ * @example
+ * ```typescript
+ * class User extends BaseModel {
+ *   @pk()
+ *   id!: string;
  *
- * @see unique
- * @see required
- * @see on
+ *   @required()
+ *   username!: string;
+ * }
+ * ```
  */
 export function pk(opts = DefaultSequenceOptions) {
     opts = Object.assign({}, DefaultSequenceOptions, opts);
@@ -49,4 +94,4 @@ export function pk(opts = DefaultSequenceOptions) {
     propMetadata(key, opts), onCreate(pkOnCreate, opts))
         .apply();
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9pZGVudGl0eS9kZWNvcmF0b3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFDTCxVQUFVLEVBRVYsWUFBWSxFQUNaLFFBQVEsR0FDVCxNQUFNLGdDQUFnQyxDQUFDO0FBQ3hDLE9BQU8sRUFDTCxzQkFBc0IsR0FFdkIsTUFBTSwrQkFBK0IsQ0FBQztBQUN2QyxPQUFPLEVBQ0wsTUFBTSxFQUNOLGFBQWEsRUFDYixRQUFRLEVBQ1IsUUFBUSxHQUVULE1BQU0seUJBQXlCLENBQUM7QUFDakMsT0FBTyxFQUFRLFVBQVUsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBQzVELE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUM1QyxPQUFPLEVBQUUsb0JBQW9CLEVBQUUsTUFBTSxTQUFTLENBQUM7QUFHL0MsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLGVBQWUsQ0FBQztBQUUvQyxNQUFNLENBQUMsS0FBSyxVQUFVLFVBQVUsQ0FROUIsT0FBbUIsRUFDbkIsSUFBTyxFQUNQLEdBQVksRUFDWixLQUFRO0lBRVIsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLElBQUksS0FBSyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7UUFDN0IsT0FBTztJQUNULENBQUM7SUFFRCxNQUFNLGtCQUFrQixHQUFHLFVBQ3pCLE1BQVMsRUFDVCxXQUFtQixFQUNuQixLQUErQjtRQUUvQixNQUFNLENBQUMsY0FBYyxDQUFDLE1BQU0sRUFBRSxXQUFXLEVBQUU7WUFDekMsVUFBVSxFQUFFLElBQUk7WUFDaEIsUUFBUSxFQUFFLEtBQUs7WUFDZixZQUFZLEVBQUUsSUFBSTtZQUNsQixLQUFLLEVBQUUsS0FBSztTQUNiLENBQUMsQ0FBQztJQUNMLENBQUMsQ0FBQztJQUNGLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSTtRQUFFLElBQUksQ0FBQyxJQUFJLEdBQUcsb0JBQW9CLENBQUMsS0FBSyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQzlELElBQUksUUFBa0IsQ0FBQztJQUN2QixJQUFJLENBQUM7UUFDSCxRQUFRLEdBQUcsTUFBTSxJQUFJLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUMvQyxDQUFDO0lBQUMsT0FBTyxDQUFNLEVBQUUsQ0FBQztRQUNoQixNQUFNLElBQUksYUFBYSxDQUNyQixrQ0FBa0MsSUFBSSxDQUFDLElBQUksS0FBSyxDQUFDLEVBQUUsQ0FDcEQsQ0FBQztJQUNKLENBQUM7SUFFRCxNQUFNLElBQUksR0FBRyxNQUFNLFFBQVEsQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUNuQyxrQkFBa0IsQ0FBQyxLQUFLLEVBQUUsR0FBYSxFQUFFLElBQUksQ0FBQyxDQUFDO0FBQ2pELENBQUM7QUFFRDs7Ozs7Ozs7OztHQVVHO0FBQ0gsTUFBTSxVQUFVLEVBQUUsQ0FDaEIsT0FHSSxzQkFBc0I7SUFFMUIsSUFBSSxHQUFHLE1BQU0sQ0FBQyxNQUFNLENBQUMsRUFBRSxFQUFFLHNCQUFzQixFQUFFLElBQUksQ0FBb0IsQ0FBQztJQUMxRSxNQUFNLEdBQUcsR0FBRyxVQUFVLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUN0QyxPQUFPLFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDO1NBQ3ZCLE1BQU0sQ0FDTCxLQUFLLENBQUMsQ0FBQyxjQUFjLENBQUMsR0FBRyxFQUFFLGNBQWMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxFQUMvQyxRQUFRLEVBQUUsRUFDVixRQUFRLEVBQUU7SUFDVixpREFBaUQ7SUFDakQsWUFBWSxDQUFDLEdBQUcsRUFBRSxJQUF1QixDQUFDLEVBQzFDLFFBQVEsQ0FBQyxVQUFVLEVBQUUsSUFBdUIsQ0FBQyxDQUM5QztTQUNBLEtBQUssRUFBRSxDQUFDO0FBQ2IsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7XG4gIERlY29yYXRpb24sXG4gIE1vZGVsLFxuICBwcm9wTWV0YWRhdGEsXG4gIHJlcXVpcmVkLFxufSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQge1xuICBEZWZhdWx0U2VxdWVuY2VPcHRpb25zLFxuICBTZXF1ZW5jZU9wdGlvbnMsXG59IGZyb20gXCIuLi9pbnRlcmZhY2VzL1NlcXVlbmNlT3B0aW9uc1wiO1xuaW1wb3J0IHtcbiAgREJLZXlzLFxuICBJbnRlcm5hbEVycm9yLFxuICBvbkNyZWF0ZSxcbiAgcmVhZG9ubHksXG4gIFJlcG9zaXRvcnlGbGFncyxcbn0gZnJvbSBcIkBkZWNhZi10cy9kYi1kZWNvcmF0b3JzXCI7XG5pbXBvcnQgeyBSZXBvLCBSZXBvc2l0b3J5IH0gZnJvbSBcIi4uL3JlcG9zaXRvcnkvUmVwb3NpdG9yeVwiO1xuaW1wb3J0IHsgaW5kZXggfSBmcm9tIFwiLi4vbW9kZWwvZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgc2VxdWVuY2VOYW1lRm9yTW9kZWwgfSBmcm9tIFwiLi91dGlsc1wiO1xuaW1wb3J0IHsgU2VxdWVuY2UgfSBmcm9tIFwiLi4vcGVyc2lzdGVuY2UvU2VxdWVuY2VcIjtcbmltcG9ydCB7IENvbnRleHQgfSBmcm9tIFwiQGRlY2FmLXRzL2RiLWRlY29yYXRvcnNcIjtcbmltcG9ydCB7IE9yZGVyRGlyZWN0aW9uIH0gZnJvbSBcIi4uL3JlcG9zaXRvcnlcIjtcblxuZXhwb3J0IGFzeW5jIGZ1bmN0aW9uIHBrT25DcmVhdGU8XG4gIE0gZXh0ZW5kcyBNb2RlbCxcbiAgUiBleHRlbmRzIFJlcG88TSwgRiwgQz4sXG4gIFYgZXh0ZW5kcyBTZXF1ZW5jZU9wdGlvbnMsXG4gIEYgZXh0ZW5kcyBSZXBvc2l0b3J5RmxhZ3MsXG4gIEMgZXh0ZW5kcyBDb250ZXh0PEY+LFxuPihcbiAgdGhpczogUixcbiAgY29udGV4dDogQ29udGV4dDxGPixcbiAgZGF0YTogVixcbiAga2V5OiBrZXlvZiBNLFxuICBtb2RlbDogTVxuKTogUHJvbWlzZTx2b2lkPiB7XG4gIGlmICghZGF0YS50eXBlIHx8IG1vZGVsW2tleV0pIHtcbiAgICByZXR1cm47XG4gIH1cblxuICBjb25zdCBzZXRQcmltYXJ5S2V5VmFsdWUgPSBmdW5jdGlvbiA8TSBleHRlbmRzIE1vZGVsPihcbiAgICB0YXJnZXQ6IE0sXG4gICAgcHJvcGVydHlLZXk6IHN0cmluZyxcbiAgICB2YWx1ZTogc3RyaW5nIHwgbnVtYmVyIHwgYmlnaW50XG4gICkge1xuICAgIE9iamVjdC5kZWZpbmVQcm9wZXJ0eSh0YXJnZXQsIHByb3BlcnR5S2V5LCB7XG4gICAgICBlbnVtZXJhYmxlOiB0cnVlLFxuICAgICAgd3JpdGFibGU6IGZhbHNlLFxuICAgICAgY29uZmlndXJhYmxlOiB0cnVlLFxuICAgICAgdmFsdWU6IHZhbHVlLFxuICAgIH0pO1xuICB9O1xuICBpZiAoIWRhdGEubmFtZSkgZGF0YS5uYW1lID0gc2VxdWVuY2VOYW1lRm9yTW9kZWwobW9kZWwsIFwicGtcIik7XG4gIGxldCBzZXF1ZW5jZTogU2VxdWVuY2U7XG4gIHRyeSB7XG4gICAgc2VxdWVuY2UgPSBhd2FpdCB0aGlzLmFkYXB0ZXIuU2VxdWVuY2UoZGF0YSk7XG4gIH0gY2F0Y2ggKGU6IGFueSkge1xuICAgIHRocm93IG5ldyBJbnRlcm5hbEVycm9yKFxuICAgICAgYEZhaWxlZCB0byBpbnN0YW50aWF0ZSBTZXF1ZW5jZSAke2RhdGEubmFtZX06ICR7ZX1gXG4gICAgKTtcbiAgfVxuXG4gIGNvbnN0IG5leHQgPSBhd2FpdCBzZXF1ZW5jZS5uZXh0KCk7XG4gIHNldFByaW1hcnlLZXlWYWx1ZShtb2RlbCwga2V5IGFzIHN0cmluZywgbmV4dCk7XG59XG5cbi8qKlxuICogQHN1bW1hcnkgUHJpbWFyeSBLZXkgRGVjb3JhdG9yXG4gKiBAZGVzY3JpcHRpb24gTWFya3MgdGhlIHByb3BlcnR5IGFzIHRoZSB7QGxpbmsgTW9kZWx9cyBwcmltYXJ5IGtleS5cbiAqICBBbHNvIG1hcmtzIHRoZSBwcm9wZXJ0eSBhcyB7QGxpbmsgdW5pcXVlfSBhcyB7QHJlcXVpcmVkfSBhbmQgZW5zdXJlcyB0aGUgaW5kZXggaXMgY3JlYXRlZCBwcm9wZXJseSBhY2NvcmRpbmcgdG8gdGhlIHByb3ZpZGVkIHtAbGluayBTZXF1ZW5jZX1cbiAqXG4gKiBAZnVuY3Rpb24gcGtcbiAqXG4gKiBAc2VlIHVuaXF1ZVxuICogQHNlZSByZXF1aXJlZFxuICogQHNlZSBvblxuICovXG5leHBvcnQgZnVuY3Rpb24gcGsoXG4gIG9wdHM6IE9taXQ8XG4gICAgU2VxdWVuY2VPcHRpb25zLFxuICAgIFwiY3ljbGVcIiB8IFwic3RhcnRXaXRoXCIgfCBcImluY3JlbWVudEJ5XCJcbiAgPiA9IERlZmF1bHRTZXF1ZW5jZU9wdGlvbnNcbikge1xuICBvcHRzID0gT2JqZWN0LmFzc2lnbih7fSwgRGVmYXVsdFNlcXVlbmNlT3B0aW9ucywgb3B0cykgYXMgU2VxdWVuY2VPcHRpb25zO1xuICBjb25zdCBrZXkgPSBSZXBvc2l0b3J5LmtleShEQktleXMuSUQpO1xuICByZXR1cm4gRGVjb3JhdGlvbi5mb3Ioa2V5KVxuICAgIC5kZWZpbmUoXG4gICAgICBpbmRleChbT3JkZXJEaXJlY3Rpb24uQVNDLCBPcmRlckRpcmVjdGlvbi5EU0NdKSxcbiAgICAgIHJlcXVpcmVkKCksXG4gICAgICByZWFkb25seSgpLFxuICAgICAgLy8gdHlwZShbU3RyaW5nLm5hbWUsIE51bWJlci5uYW1lLCBCaWdJbnQubmFtZV0pLFxuICAgICAgcHJvcE1ldGFkYXRhKGtleSwgb3B0cyBhcyBTZXF1ZW5jZU9wdGlvbnMpLFxuICAgICAgb25DcmVhdGUocGtPbkNyZWF0ZSwgb3B0cyBhcyBTZXF1ZW5jZU9wdGlvbnMpXG4gICAgKVxuICAgIC5hcHBseSgpO1xufVxuIl19
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../../src/identity/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAEV,YAAY,EACZ,QAAQ,GACT,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,sBAAsB,GAEvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,MAAM,EACN,aAAa,EACb,QAAQ,EACR,QAAQ,GAET,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAQ,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAG/C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAQ9B,OAAmB,EACnB,IAAO,EACP,GAAY,EACZ,KAAQ;IAER,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IAED,MAAM,kBAAkB,GAAG,UACzB,MAAS,EACT,WAAmB,EACnB,KAA+B;QAE/B,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE;YACzC,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,IAAI;YAClB,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC,CAAC;IACF,IAAI,CAAC,IAAI,CAAC,IAAI;QAAE,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC9D,IAAI,QAAkB,CAAC;IACvB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,IAAI,aAAa,CACrB,kCAAkC,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CACpD,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnC,kBAAkB,CAAC,KAAK,EAAE,GAAa,EAAE,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,EAAE,CAChB,OAGI,sBAAsB;IAE1B,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,sBAAsB,EAAE,IAAI,CAAoB,CAAC;IAC1E,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACtC,OAAO,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC;SACvB,MAAM,CACL,KAAK,CAAC,CAAC,cAAc,CAAC,GAAG,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC,EAC/C,QAAQ,EAAE,EACV,QAAQ,EAAE;IACV,iDAAiD;IACjD,YAAY,CAAC,GAAG,EAAE,IAAuB,CAAC,EAC1C,QAAQ,CAAC,UAAU,EAAE,IAAuB,CAAC,CAC9C;SACA,KAAK,EAAE,CAAC;AACb,CAAC","sourcesContent":["import {\n  Decoration,\n  Model,\n  propMetadata,\n  required,\n} from \"@decaf-ts/decorator-validation\";\nimport {\n  DefaultSequenceOptions,\n  SequenceOptions,\n} from \"../interfaces/SequenceOptions\";\nimport {\n  DBKeys,\n  InternalError,\n  onCreate,\n  readonly,\n  RepositoryFlags,\n} from \"@decaf-ts/db-decorators\";\nimport { Repo, Repository } from \"../repository/Repository\";\nimport { index } from \"../model/decorators\";\nimport { sequenceNameForModel } from \"./utils\";\nimport { Sequence } from \"../persistence/Sequence\";\nimport { Context } from \"@decaf-ts/db-decorators\";\nimport { OrderDirection } from \"../repository\";\n\n/**\n * @description Callback function for primary key creation\n * @summary Handles the creation of primary key values for models using sequences\n * @template M - Type that extends Model\n * @template R - Type that extends Repo<M, F, C>\n * @template V - Type that extends SequenceOptions\n * @template F - Type that extends RepositoryFlags\n * @template C - Type that extends Context<F>\n * @param {Context<F>} context - The execution context\n * @param {V} data - The sequence options\n * @param key - The property key to set as primary key\n * @param {M} model - The model instance\n * @return {Promise<void>} A promise that resolves when the primary key is set\n * @function pkOnCreate\n * @category Property Decorators\n * @mermaid\n * sequenceDiagram\n *   participant Model\n *   participant pkOnCreate\n *   participant Adapter\n *   participant Sequence\n *\n *   Model->>pkOnCreate: Call with model instance\n *   Note over pkOnCreate: Check if key already exists\n *   alt Key exists or no type specified\n *     pkOnCreate-->>Model: Return early\n *   else Key needs to be created\n *     pkOnCreate->>pkOnCreate: Generate sequence name if not provided\n *     pkOnCreate->>Adapter: Request Sequence(data)\n *     Adapter->>Sequence: Create sequence\n *     Sequence-->>pkOnCreate: Return sequence\n *     pkOnCreate->>Sequence: Call next()\n *     Sequence-->>pkOnCreate: Return next value\n *     pkOnCreate->>Model: Set primary key value\n *   end\n */\nexport async function pkOnCreate<\n  M extends Model,\n  R extends Repo<M, F, C>,\n  V extends SequenceOptions,\n  F extends RepositoryFlags,\n  C extends Context<F>,\n>(\n  this: R,\n  context: Context<F>,\n  data: V,\n  key: keyof M,\n  model: M\n): Promise<void> {\n  if (!data.type || model[key]) {\n    return;\n  }\n\n  const setPrimaryKeyValue = function <M extends Model>(\n    target: M,\n    propertyKey: string,\n    value: string | number | bigint\n  ) {\n    Object.defineProperty(target, propertyKey, {\n      enumerable: true,\n      writable: false,\n      configurable: true,\n      value: value,\n    });\n  };\n  if (!data.name) data.name = sequenceNameForModel(model, \"pk\");\n  let sequence: Sequence;\n  try {\n    sequence = await this.adapter.Sequence(data);\n  } catch (e: any) {\n    throw new InternalError(\n      `Failed to instantiate Sequence ${data.name}: ${e}`\n    );\n  }\n\n  const next = await sequence.next();\n  setPrimaryKeyValue(model, key as string, next);\n}\n\n/**\n * @description Primary Key Decorator\n * @summary Marks a property as the model's primary key with automatic sequence generation\n * This decorator combines multiple behaviors: it marks the property as unique, required,\n * and ensures the index is created properly according to the provided sequence options.\n * @param {Omit<SequenceOptions, \"cycle\" | \"startWith\" | \"incrementBy\">} opts - Options for the sequence generation\n * @return {PropertyDecorator} A property decorator that can be applied to model properties\n * @function pk\n * @category Property Decorators\n * @example\n * ```typescript\n * class User extends BaseModel {\n *   @pk()\n *   id!: string;\n *\n *   @required()\n *   username!: string;\n * }\n * ```\n */\nexport function pk(\n  opts: Omit<\n    SequenceOptions,\n    \"cycle\" | \"startWith\" | \"incrementBy\"\n  > = DefaultSequenceOptions\n) {\n  opts = Object.assign({}, DefaultSequenceOptions, opts) as SequenceOptions;\n  const key = Repository.key(DBKeys.ID);\n  return Decoration.for(key)\n    .define(\n      index([OrderDirection.ASC, OrderDirection.DSC]),\n      required(),\n      readonly(),\n      // type([String.name, Number.name, BigInt.name]),\n      propMetadata(key, opts as SequenceOptions),\n      onCreate(pkOnCreate, opts as SequenceOptions)\n    )\n    .apply();\n}\n"]}

package/lib/esm/identity/utils.d.ts

@@ -1,3 +1,22 @@
 import { Constructor, Model } from "@decaf-ts/decorator-validation";
+/**
+ * @description Gets the table name for a model
+ * @summary Retrieves the table name associated with a model by checking metadata or falling back to the constructor name
+ * @template M - Type that extends Model
+ * @param {M | Constructor<M>} model - The model instance or constructor to get the table name for
+ * @return {string} The table name for the model
+ * @function getTableName
+ * @memberOf module:core
+ */
 export declare function getTableName<M extends Model>(model: M | Constructor<M>): string;
+/**
+ * @description Generates a sequence name for a model
+ * @summary Creates a standardized sequence name by combining the table name with additional arguments
+ * @template M - Type that extends Model
+ * @param {M | Constructor<M>} model - The model instance or constructor to generate the sequence name for
+ * @param {...string} args - Additional string arguments to append to the sequence name
+ * @return {string} The generated sequence name
+ * @function sequenceNameForModel
+ * @memberOf module:core
+ */
 export declare function sequenceNameForModel<M extends Model>(model: M | Constructor<M>, ...args: string[]): string;

package/lib/esm/identity/utils.js

@@ -1,6 +1,15 @@
 import { Model } from "@decaf-ts/decorator-validation";
 import { Adapter } from "../persistence/Adapter";
 import { PersistenceKeys } from "../persistence/constants";
+/**
+ * @description Gets the table name for a model
+ * @summary Retrieves the table name associated with a model by checking metadata or falling back to the constructor name
+ * @template M - Type that extends Model
+ * @param {M | Constructor<M>} model - The model instance or constructor to get the table name for
+ * @return {string} The table name for the model
+ * @function getTableName
+ * @memberOf module:core
+ */
 export function getTableName(model) {
     const obj = model instanceof Model ? model.constructor : model;
     const metadata = Reflect.getOwnMetadata(Adapter.key(PersistenceKeys.TABLE), obj);
@@ -12,7 +21,17 @@ export function getTableName(model) {
     }
     return model.name;
 }
+/**
+ * @description Generates a sequence name for a model
+ * @summary Creates a standardized sequence name by combining the table name with additional arguments
+ * @template M - Type that extends Model
+ * @param {M | Constructor<M>} model - The model instance or constructor to generate the sequence name for
+ * @param {...string} args - Additional string arguments to append to the sequence name
+ * @return {string} The generated sequence name
+ * @function sequenceNameForModel
+ * @memberOf module:core
+ */
 export function sequenceNameForModel(model, ...args) {
     return [getTableName(model), ...args].join("_");
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaWRlbnRpdHkvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFlLEtBQUssRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBQ3BFLE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQztBQUNqRCxPQUFPLEVBQUUsZUFBZSxFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFFM0QsTUFBTSxVQUFVLFlBQVksQ0FDMUIsS0FBeUI7SUFFekIsTUFBTSxHQUFHLEdBQUcsS0FBSyxZQUFZLEtBQUssQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDO0lBRS9ELE1BQU0sUUFBUSxHQUFHLE9BQU8sQ0FBQyxjQUFjLENBQ3JDLE9BQU8sQ0FBQyxHQUFHLENBQUMsZUFBZSxDQUFDLEtBQUssQ0FBQyxFQUNsQyxHQUFHLENBQ0osQ0FBQztJQUNGLElBQUksUUFBUSxFQUFFLENBQUM7UUFDYixPQUFPLFFBQVEsQ0FBQztJQUNsQixDQUFDO0lBQ0QsSUFBSSxLQUFLLFlBQVksS0FBSyxFQUFFLENBQUM7UUFDM0IsT0FBTyxLQUFLLENBQUMsV0FBVyxDQUFDLElBQUksQ0FBQztJQUNoQyxDQUFDO0lBQ0QsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDO0FBQ3BCLENBQUM7QUFFRCxNQUFNLFVBQVUsb0JBQW9CLENBQ2xDLEtBQXlCLEVBQ3pCLEdBQUcsSUFBYztJQUVqQixPQUFPLENBQUMsWUFBWSxDQUFDLEtBQUssQ0FBQyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0FBQ2xELENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25zdHJ1Y3RvciwgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBBZGFwdGVyIH0gZnJvbSBcIi4uL3BlcnNpc3RlbmNlL0FkYXB0ZXJcIjtcbmltcG9ydCB7IFBlcnNpc3RlbmNlS2V5cyB9IGZyb20gXCIuLi9wZXJzaXN0ZW5jZS9jb25zdGFudHNcIjtcblxuZXhwb3J0IGZ1bmN0aW9uIGdldFRhYmxlTmFtZTxNIGV4dGVuZHMgTW9kZWw+KFxuICBtb2RlbDogTSB8IENvbnN0cnVjdG9yPE0+XG4pOiBzdHJpbmcge1xuICBjb25zdCBvYmogPSBtb2RlbCBpbnN0YW5jZW9mIE1vZGVsID8gbW9kZWwuY29uc3RydWN0b3IgOiBtb2RlbDtcblxuICBjb25zdCBtZXRhZGF0YSA9IFJlZmxlY3QuZ2V0T3duTWV0YWRhdGEoXG4gICAgQWRhcHRlci5rZXkoUGVyc2lzdGVuY2VLZXlzLlRBQkxFKSxcbiAgICBvYmpcbiAgKTtcbiAgaWYgKG1ldGFkYXRhKSB7XG4gICAgcmV0dXJuIG1ldGFkYXRhO1xuICB9XG4gIGlmIChtb2RlbCBpbnN0YW5jZW9mIE1vZGVsKSB7XG4gICAgcmV0dXJuIG1vZGVsLmNvbnN0cnVjdG9yLm5hbWU7XG4gIH1cbiAgcmV0dXJuIG1vZGVsLm5hbWU7XG59XG5cbmV4cG9ydCBmdW5jdGlvbiBzZXF1ZW5jZU5hbWVGb3JNb2RlbDxNIGV4dGVuZHMgTW9kZWw+KFxuICBtb2RlbDogTSB8IENvbnN0cnVjdG9yPE0+LFxuICAuLi5hcmdzOiBzdHJpbmdbXVxuKSB7XG4gIHJldHVybiBbZ2V0VGFibGVOYW1lKG1vZGVsKSwgLi4uYXJnc10uam9pbihcIl9cIik7XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaWRlbnRpdHkvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFlLEtBQUssRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBQ3BFLE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQztBQUNqRCxPQUFPLEVBQUUsZUFBZSxFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFFM0Q7Ozs7Ozs7O0dBUUc7QUFDSCxNQUFNLFVBQVUsWUFBWSxDQUMxQixLQUF5QjtJQUV6QixNQUFNLEdBQUcsR0FBRyxLQUFLLFlBQVksS0FBSyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUM7SUFFL0QsTUFBTSxRQUFRLEdBQUcsT0FBTyxDQUFDLGNBQWMsQ0FDckMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxlQUFlLENBQUMsS0FBSyxDQUFDLEVBQ2xDLEdBQUcsQ0FDSixDQUFDO0lBQ0YsSUFBSSxRQUFRLEVBQUUsQ0FBQztRQUNiLE9BQU8sUUFBUSxDQUFDO0lBQ2xCLENBQUM7SUFDRCxJQUFJLEtBQUssWUFBWSxLQUFLLEVBQUUsQ0FBQztRQUMzQixPQUFPLEtBQUssQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDO0lBQ2hDLENBQUM7SUFDRCxPQUFPLEtBQUssQ0FBQyxJQUFJLENBQUM7QUFDcEIsQ0FBQztBQUVEOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sVUFBVSxvQkFBb0IsQ0FDbEMsS0FBeUIsRUFDekIsR0FBRyxJQUFjO0lBRWpCLE9BQU8sQ0FBQyxZQUFZLENBQUMsS0FBSyxDQUFDLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7QUFDbEQsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbnN0cnVjdG9yLCBNb2RlbCB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB7IEFkYXB0ZXIgfSBmcm9tIFwiLi4vcGVyc2lzdGVuY2UvQWRhcHRlclwiO1xuaW1wb3J0IHsgUGVyc2lzdGVuY2VLZXlzIH0gZnJvbSBcIi4uL3BlcnNpc3RlbmNlL2NvbnN0YW50c1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBHZXRzIHRoZSB0YWJsZSBuYW1lIGZvciBhIG1vZGVsXG4gKiBAc3VtbWFyeSBSZXRyaWV2ZXMgdGhlIHRhYmxlIG5hbWUgYXNzb2NpYXRlZCB3aXRoIGEgbW9kZWwgYnkgY2hlY2tpbmcgbWV0YWRhdGEgb3IgZmFsbGluZyBiYWNrIHRvIHRoZSBjb25zdHJ1Y3RvciBuYW1lXG4gKiBAdGVtcGxhdGUgTSAtIFR5cGUgdGhhdCBleHRlbmRzIE1vZGVsXG4gKiBAcGFyYW0ge00gfCBDb25zdHJ1Y3RvcjxNPn0gbW9kZWwgLSBUaGUgbW9kZWwgaW5zdGFuY2Ugb3IgY29uc3RydWN0b3IgdG8gZ2V0IHRoZSB0YWJsZSBuYW1lIGZvclxuICogQHJldHVybiB7c3RyaW5nfSBUaGUgdGFibGUgbmFtZSBmb3IgdGhlIG1vZGVsXG4gKiBAZnVuY3Rpb24gZ2V0VGFibGVOYW1lXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGdldFRhYmxlTmFtZTxNIGV4dGVuZHMgTW9kZWw+KFxuICBtb2RlbDogTSB8IENvbnN0cnVjdG9yPE0+XG4pOiBzdHJpbmcge1xuICBjb25zdCBvYmogPSBtb2RlbCBpbnN0YW5jZW9mIE1vZGVsID8gbW9kZWwuY29uc3RydWN0b3IgOiBtb2RlbDtcblxuICBjb25zdCBtZXRhZGF0YSA9IFJlZmxlY3QuZ2V0T3duTWV0YWRhdGEoXG4gICAgQWRhcHRlci5rZXkoUGVyc2lzdGVuY2VLZXlzLlRBQkxFKSxcbiAgICBvYmpcbiAgKTtcbiAgaWYgKG1ldGFkYXRhKSB7XG4gICAgcmV0dXJuIG1ldGFkYXRhO1xuICB9XG4gIGlmIChtb2RlbCBpbnN0YW5jZW9mIE1vZGVsKSB7XG4gICAgcmV0dXJuIG1vZGVsLmNvbnN0cnVjdG9yLm5hbWU7XG4gIH1cbiAgcmV0dXJuIG1vZGVsLm5hbWU7XG59XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEdlbmVyYXRlcyBhIHNlcXVlbmNlIG5hbWUgZm9yIGEgbW9kZWxcbiAqIEBzdW1tYXJ5IENyZWF0ZXMgYSBzdGFuZGFyZGl6ZWQgc2VxdWVuY2UgbmFtZSBieSBjb21iaW5pbmcgdGhlIHRhYmxlIG5hbWUgd2l0aCBhZGRpdGlvbmFsIGFyZ3VtZW50c1xuICogQHRlbXBsYXRlIE0gLSBUeXBlIHRoYXQgZXh0ZW5kcyBNb2RlbFxuICogQHBhcmFtIHtNIHwgQ29uc3RydWN0b3I8TT59IG1vZGVsIC0gVGhlIG1vZGVsIGluc3RhbmNlIG9yIGNvbnN0cnVjdG9yIHRvIGdlbmVyYXRlIHRoZSBzZXF1ZW5jZSBuYW1lIGZvclxuICogQHBhcmFtIHsuLi5zdHJpbmd9IGFyZ3MgLSBBZGRpdGlvbmFsIHN0cmluZyBhcmd1bWVudHMgdG8gYXBwZW5kIHRvIHRoZSBzZXF1ZW5jZSBuYW1lXG4gKiBAcmV0dXJuIHtzdHJpbmd9IFRoZSBnZW5lcmF0ZWQgc2VxdWVuY2UgbmFtZVxuICogQGZ1bmN0aW9uIHNlcXVlbmNlTmFtZUZvck1vZGVsXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIHNlcXVlbmNlTmFtZUZvck1vZGVsPE0gZXh0ZW5kcyBNb2RlbD4oXG4gIG1vZGVsOiBNIHwgQ29uc3RydWN0b3I8TT4sXG4gIC4uLmFyZ3M6IHN0cmluZ1tdXG4pIHtcbiAgcmV0dXJuIFtnZXRUYWJsZU5hbWUobW9kZWwpLCAuLi5hcmdzXS5qb2luKFwiX1wiKTtcbn1cbiJdfQ==

package/lib/esm/index.d.ts

@@ -1,3 +1,10 @@
+/**
+ * @module core
+ * @description Core module for the Decaf TypeScript framework
+ * @summary This module provides the foundational components of the Decaf framework, including identity management,
+ * model definitions, repository patterns, persistence layer, query building, and utility functions.
+ * It exports functionality from various submodules and sets up the injectable registry for repository decorators.
+ */
 export * from "./identity";
 export * from "./interfaces";
 export * from "./model";
@@ -6,8 +13,8 @@ export * from "./repository";
 export * from "./utils";
 export * from "./persistence";
 /**
- * @summary stores the current package version
- * @description this is how you should document a constant
+ * @description Stores the current package version
+ * @summary A constant representing the version of the core package
  * @const VERSION
  * @memberOf module:core
  */

package/lib/esm/index.js

@@ -1,3 +1,10 @@
+/**
+ * @module core
+ * @description Core module for the Decaf TypeScript framework
+ * @summary This module provides the foundational components of the Decaf framework, including identity management,
+ * model definitions, repository patterns, persistence layer, query building, and utility functions.
+ * It exports functionality from various submodules and sets up the injectable registry for repository decorators.
+ */
 import { InjectablesRegistry } from "./repository";
 import { Injectables } from "@decaf-ts/injectable-decorators";
 // overrides the previous Injectables registry to enable the @repository decorator
@@ -11,10 +18,10 @@ export * from "./utils";
 //left to last on purpose
 export * from "./persistence";
 /**
- * @summary stores the current package version
- * @description this is how you should document a constant
+ * @description Stores the current package version
+ * @summary A constant representing the version of the core package
  * @const VERSION
  * @memberOf module:core
  */
 export const VERSION = "0.5.1";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sY0FBYyxDQUFDO0FBQ25ELE9BQU8sRUFBRSxXQUFXLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUU5RCxrRkFBa0Y7QUFDbEYsV0FBVyxDQUFDLFdBQVcsQ0FBQyxJQUFJLG1CQUFtQixFQUFFLENBQUMsQ0FBQztBQUVuRCxjQUFjLFlBQVksQ0FBQztBQUMzQixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLFNBQVMsQ0FBQztBQUN4QixjQUFjLFNBQVMsQ0FBQztBQUN4QixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLFNBQVMsQ0FBQztBQUN4Qix5QkFBeUI7QUFDekIsY0FBYyxlQUFlLENBQUM7QUFFOUI7Ozs7O0dBS0c7QUFDSCxNQUFNLENBQUMsTUFBTSxPQUFPLEdBQUcsYUFBYSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgSW5qZWN0YWJsZXNSZWdpc3RyeSB9IGZyb20gXCIuL3JlcG9zaXRvcnlcIjtcbmltcG9ydCB7IEluamVjdGFibGVzIH0gZnJvbSBcIkBkZWNhZi10cy9pbmplY3RhYmxlLWRlY29yYXRvcnNcIjtcblxuLy8gb3ZlcnJpZGVzIHRoZSBwcmV2aW91cyBJbmplY3RhYmxlcyByZWdpc3RyeSB0byBlbmFibGUgdGhlIEByZXBvc2l0b3J5IGRlY29yYXRvclxuSW5qZWN0YWJsZXMuc2V0UmVnaXN0cnkobmV3IEluamVjdGFibGVzUmVnaXN0cnkoKSk7XG5cbmV4cG9ydCAqIGZyb20gXCIuL2lkZW50aXR5XCI7XG5leHBvcnQgKiBmcm9tIFwiLi9pbnRlcmZhY2VzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9tb2RlbFwiO1xuZXhwb3J0ICogZnJvbSBcIi4vcXVlcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3JlcG9zaXRvcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3V0aWxzXCI7XG4vL2xlZnQgdG8gbGFzdCBvbiBwdXJwb3NlXG5leHBvcnQgKiBmcm9tIFwiLi9wZXJzaXN0ZW5jZVwiO1xuXG4vKipcbiAqIEBzdW1tYXJ5IHN0b3JlcyB0aGUgY3VycmVudCBwYWNrYWdlIHZlcnNpb25cbiAqIEBkZXNjcmlwdGlvbiB0aGlzIGlzIGhvdyB5b3Ugc2hvdWxkIGRvY3VtZW50IGEgY29uc3RhbnRcbiAqIEBjb25zdCBWRVJTSU9OXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGNvbnN0IFZFUlNJT04gPSBcIiMjVkVSU0lPTiMjXCI7XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7OztHQU1HO0FBRUgsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sY0FBYyxDQUFDO0FBQ25ELE9BQU8sRUFBRSxXQUFXLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUU5RCxrRkFBa0Y7QUFDbEYsV0FBVyxDQUFDLFdBQVcsQ0FBQyxJQUFJLG1CQUFtQixFQUFFLENBQUMsQ0FBQztBQUVuRCxjQUFjLFlBQVksQ0FBQztBQUMzQixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLFNBQVMsQ0FBQztBQUN4QixjQUFjLFNBQVMsQ0FBQztBQUN4QixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLFNBQVMsQ0FBQztBQUN4Qix5QkFBeUI7QUFDekIsY0FBYyxlQUFlLENBQUM7QUFFOUI7Ozs7O0dBS0c7QUFDSCxNQUFNLENBQUMsTUFBTSxPQUFPLEdBQUcsYUFBYSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAbW9kdWxlIGNvcmVcbiAqIEBkZXNjcmlwdGlvbiBDb3JlIG1vZHVsZSBmb3IgdGhlIERlY2FmIFR5cGVTY3JpcHQgZnJhbWV3b3JrXG4gKiBAc3VtbWFyeSBUaGlzIG1vZHVsZSBwcm92aWRlcyB0aGUgZm91bmRhdGlvbmFsIGNvbXBvbmVudHMgb2YgdGhlIERlY2FmIGZyYW1ld29yaywgaW5jbHVkaW5nIGlkZW50aXR5IG1hbmFnZW1lbnQsIFxuICogbW9kZWwgZGVmaW5pdGlvbnMsIHJlcG9zaXRvcnkgcGF0dGVybnMsIHBlcnNpc3RlbmNlIGxheWVyLCBxdWVyeSBidWlsZGluZywgYW5kIHV0aWxpdHkgZnVuY3Rpb25zLlxuICogSXQgZXhwb3J0cyBmdW5jdGlvbmFsaXR5IGZyb20gdmFyaW91cyBzdWJtb2R1bGVzIGFuZCBzZXRzIHVwIHRoZSBpbmplY3RhYmxlIHJlZ2lzdHJ5IGZvciByZXBvc2l0b3J5IGRlY29yYXRvcnMuXG4gKi9cblxuaW1wb3J0IHsgSW5qZWN0YWJsZXNSZWdpc3RyeSB9IGZyb20gXCIuL3JlcG9zaXRvcnlcIjtcbmltcG9ydCB7IEluamVjdGFibGVzIH0gZnJvbSBcIkBkZWNhZi10cy9pbmplY3RhYmxlLWRlY29yYXRvcnNcIjtcblxuLy8gb3ZlcnJpZGVzIHRoZSBwcmV2aW91cyBJbmplY3RhYmxlcyByZWdpc3RyeSB0byBlbmFibGUgdGhlIEByZXBvc2l0b3J5IGRlY29yYXRvclxuSW5qZWN0YWJsZXMuc2V0UmVnaXN0cnkobmV3IEluamVjdGFibGVzUmVnaXN0cnkoKSk7XG5cbmV4cG9ydCAqIGZyb20gXCIuL2lkZW50aXR5XCI7XG5leHBvcnQgKiBmcm9tIFwiLi9pbnRlcmZhY2VzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9tb2RlbFwiO1xuZXhwb3J0ICogZnJvbSBcIi4vcXVlcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3JlcG9zaXRvcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3V0aWxzXCI7XG4vL2xlZnQgdG8gbGFzdCBvbiBwdXJwb3NlXG5leHBvcnQgKiBmcm9tIFwiLi9wZXJzaXN0ZW5jZVwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBTdG9yZXMgdGhlIGN1cnJlbnQgcGFja2FnZSB2ZXJzaW9uXG4gKiBAc3VtbWFyeSBBIGNvbnN0YW50IHJlcHJlc2VudGluZyB0aGUgdmVyc2lvbiBvZiB0aGUgY29yZSBwYWNrYWdlXG4gKiBAY29uc3QgVkVSU0lPTlxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKi9cbmV4cG9ydCBjb25zdCBWRVJTSU9OID0gXCIjI1ZFUlNJT04jI1wiO1xuIl19

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

@@ -1,4 +1,16 @@
 import { BaseError } from "@decaf-ts/db-decorators";
+/**
+ * @description Interface for parsing errors
+ * @summary Defines a contract for objects that can parse generic Error objects into BaseError instances
+ * @interface ErrorParser
+ * @memberOf module:core
+ */
 export interface ErrorParser {
+    /**
+     * @description Parses a generic Error into a BaseError
+     * @summary Converts a standard Error object into a more specific BaseError type
+     * @param {Error} error - The error to be parsed
+     * @return {BaseError} The parsed error as a BaseError instance
+     */
     parseError(error: Error): BaseError;
 }

package/lib/esm/interfaces/ErrorParser.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXJyb3JQYXJzZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9FcnJvclBhcnNlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQmFzZUVycm9yIH0gZnJvbSBcIkBkZWNhZi10cy9kYi1kZWNvcmF0b3JzXCI7XG5cbmV4cG9ydCBpbnRlcmZhY2UgRXJyb3JQYXJzZXIge1xuICBwYXJzZUVycm9yKGVycm9yOiBFcnJvcik6IEJhc2VFcnJvcjtcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXJyb3JQYXJzZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9FcnJvclBhcnNlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQmFzZUVycm9yIH0gZnJvbSBcIkBkZWNhZi10cy9kYi1kZWNvcmF0b3JzXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEludGVyZmFjZSBmb3IgcGFyc2luZyBlcnJvcnNcbiAqIEBzdW1tYXJ5IERlZmluZXMgYSBjb250cmFjdCBmb3Igb2JqZWN0cyB0aGF0IGNhbiBwYXJzZSBnZW5lcmljIEVycm9yIG9iamVjdHMgaW50byBCYXNlRXJyb3IgaW5zdGFuY2VzXG4gKiBAaW50ZXJmYWNlIEVycm9yUGFyc2VyXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBFcnJvclBhcnNlciB7XG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gUGFyc2VzIGEgZ2VuZXJpYyBFcnJvciBpbnRvIGEgQmFzZUVycm9yXG4gICAqIEBzdW1tYXJ5IENvbnZlcnRzIGEgc3RhbmRhcmQgRXJyb3Igb2JqZWN0IGludG8gYSBtb3JlIHNwZWNpZmljIEJhc2VFcnJvciB0eXBlXG4gICAqIEBwYXJhbSB7RXJyb3J9IGVycm9yIC0gVGhlIGVycm9yIHRvIGJlIHBhcnNlZFxuICAgKiBAcmV0dXJuIHtCYXNlRXJyb3J9IFRoZSBwYXJzZWQgZXJyb3IgYXMgYSBCYXNlRXJyb3IgaW5zdGFuY2VcbiAgICovXG4gIHBhcnNlRXJyb3IoZXJyb3I6IEVycm9yKTogQmFzZUVycm9yO1xufVxuIl19

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

@@ -1,3 +1,16 @@
+/**
+ * @description Interface for executable operations
+ * @summary Defines a contract for objects that can execute an operation and return a result
+ * @template R - The type of result returned by the execute method
+ * @interface Executor
+ * @memberOf module:core
+ */
 export interface Executor<R> {
+    /**
+     * @description Executes the operation
+     * @summary Performs the operation and returns a promise that resolves to the result
+     * @template R - The type of result returned by the execute method
+     * @return {Promise<R>} A promise that resolves to the result of type R
+     */
     execute(): Promise<R>;
 }

package/lib/esm/interfaces/Executor.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXhlY3V0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9FeGVjdXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBFeGVjdXRvcjxSPiB7XG4gIGV4ZWN1dGUoKTogUHJvbWlzZTxSPjtcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXhlY3V0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9FeGVjdXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gSW50ZXJmYWNlIGZvciBleGVjdXRhYmxlIG9wZXJhdGlvbnNcbiAqIEBzdW1tYXJ5IERlZmluZXMgYSBjb250cmFjdCBmb3Igb2JqZWN0cyB0aGF0IGNhbiBleGVjdXRlIGFuIG9wZXJhdGlvbiBhbmQgcmV0dXJuIGEgcmVzdWx0XG4gKiBAdGVtcGxhdGUgUiAtIFRoZSB0eXBlIG9mIHJlc3VsdCByZXR1cm5lZCBieSB0aGUgZXhlY3V0ZSBtZXRob2RcbiAqIEBpbnRlcmZhY2UgRXhlY3V0b3JcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgaW50ZXJmYWNlIEV4ZWN1dG9yPFI+IHtcbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBFeGVjdXRlcyB0aGUgb3BlcmF0aW9uXG4gICAqIEBzdW1tYXJ5IFBlcmZvcm1zIHRoZSBvcGVyYXRpb24gYW5kIHJldHVybnMgYSBwcm9taXNlIHRoYXQgcmVzb2x2ZXMgdG8gdGhlIHJlc3VsdFxuICAgKiBAdGVtcGxhdGUgUiAtIFRoZSB0eXBlIG9mIHJlc3VsdCByZXR1cm5lZCBieSB0aGUgZXhlY3V0ZSBtZXRob2RcbiAgICogQHJldHVybiB7UHJvbWlzZTxSPn0gQSBwcm9taXNlIHRoYXQgcmVzb2x2ZXMgdG8gdGhlIHJlc3VsdCBvZiB0eXBlIFJcbiAgICovXG4gIGV4ZWN1dGUoKTogUHJvbWlzZTxSPjtcbn1cbiJdfQ==

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

@@ -1,6 +1,33 @@
 import { Observer } from "./Observer";
+/**
+ * @description Interface for objects that can be observed
+ * @summary Defines a contract for objects that implement the Observer pattern, allowing them to register observers,
+ * remove observers, and notify all registered observers of state changes
+ * @interface Observable
+ * @memberOf module:core
+ */
 export interface Observable {
+    /**
+     * @description Registers an observer to receive notifications
+     * @summary Adds an observer to the list of observers that will be notified of state changes
+     * @param {Observer} observer - The observer to register
+     * @param {...any[]} args - Additional arguments to pass to the observer
+     * @return {void}
+     */
     observe(observer: Observer, ...args: any[]): void;
+    /**
+     * @description Unregisters an observer from receiving notifications
+     * @summary Removes an observer from the list of observers that will be notified of state changes
+     * @param {Observer} observer - The observer to unregister
+     * @param {...any[]} args - Additional arguments to help identify the observer
+     * @return {void}
+     */
     unObserve(observer: Observer, ...args: any[]): void;
+    /**
+     * @description Notifies all registered observers of a state change
+     * @summary Calls the update method on all registered observers, passing any provided arguments
+     * @param {...any[]} args - Arguments to pass to the observers' update methods
+     * @return {Promise<void>} A promise that resolves when all observers have been updated
+     */
     updateObservers(...args: any[]): Promise<void>;
 }

package/lib/esm/interfaces/Observable.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT2JzZXJ2YWJsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9pbnRlcmZhY2VzL09ic2VydmFibGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IE9ic2VydmVyIH0gZnJvbSBcIi4vT2JzZXJ2ZXJcIjtcblxuZXhwb3J0IGludGVyZmFjZSBPYnNlcnZhYmxlIHtcbiAgb2JzZXJ2ZShvYnNlcnZlcjogT2JzZXJ2ZXIsIC4uLmFyZ3M6IGFueVtdKTogdm9pZDtcblxuICB1bk9ic2VydmUob2JzZXJ2ZXI6IE9ic2VydmVyLCAuLi5hcmdzOiBhbnlbXSk6IHZvaWQ7XG5cbiAgdXBkYXRlT2JzZXJ2ZXJzKC4uLmFyZ3M6IGFueVtdKTogUHJvbWlzZTx2b2lkPjtcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT2JzZXJ2YWJsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9pbnRlcmZhY2VzL09ic2VydmFibGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IE9ic2VydmVyIH0gZnJvbSBcIi4vT2JzZXJ2ZXJcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gSW50ZXJmYWNlIGZvciBvYmplY3RzIHRoYXQgY2FuIGJlIG9ic2VydmVkXG4gKiBAc3VtbWFyeSBEZWZpbmVzIGEgY29udHJhY3QgZm9yIG9iamVjdHMgdGhhdCBpbXBsZW1lbnQgdGhlIE9ic2VydmVyIHBhdHRlcm4sIGFsbG93aW5nIHRoZW0gdG8gcmVnaXN0ZXIgb2JzZXJ2ZXJzLFxuICogcmVtb3ZlIG9ic2VydmVycywgYW5kIG5vdGlmeSBhbGwgcmVnaXN0ZXJlZCBvYnNlcnZlcnMgb2Ygc3RhdGUgY2hhbmdlc1xuICogQGludGVyZmFjZSBPYnNlcnZhYmxlXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBPYnNlcnZhYmxlIHtcbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBSZWdpc3RlcnMgYW4gb2JzZXJ2ZXIgdG8gcmVjZWl2ZSBub3RpZmljYXRpb25zXG4gICAqIEBzdW1tYXJ5IEFkZHMgYW4gb2JzZXJ2ZXIgdG8gdGhlIGxpc3Qgb2Ygb2JzZXJ2ZXJzIHRoYXQgd2lsbCBiZSBub3RpZmllZCBvZiBzdGF0ZSBjaGFuZ2VzXG4gICAqIEBwYXJhbSB7T2JzZXJ2ZXJ9IG9ic2VydmVyIC0gVGhlIG9ic2VydmVyIHRvIHJlZ2lzdGVyXG4gICAqIEBwYXJhbSB7Li4uYW55W119IGFyZ3MgLSBBZGRpdGlvbmFsIGFyZ3VtZW50cyB0byBwYXNzIHRvIHRoZSBvYnNlcnZlclxuICAgKiBAcmV0dXJuIHt2b2lkfVxuICAgKi9cbiAgb2JzZXJ2ZShvYnNlcnZlcjogT2JzZXJ2ZXIsIC4uLmFyZ3M6IGFueVtdKTogdm9pZDtcblxuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIFVucmVnaXN0ZXJzIGFuIG9ic2VydmVyIGZyb20gcmVjZWl2aW5nIG5vdGlmaWNhdGlvbnNcbiAgICogQHN1bW1hcnkgUmVtb3ZlcyBhbiBvYnNlcnZlciBmcm9tIHRoZSBsaXN0IG9mIG9ic2VydmVycyB0aGF0IHdpbGwgYmUgbm90aWZpZWQgb2Ygc3RhdGUgY2hhbmdlc1xuICAgKiBAcGFyYW0ge09ic2VydmVyfSBvYnNlcnZlciAtIFRoZSBvYnNlcnZlciB0byB1bnJlZ2lzdGVyXG4gICAqIEBwYXJhbSB7Li4uYW55W119IGFyZ3MgLSBBZGRpdGlvbmFsIGFyZ3VtZW50cyB0byBoZWxwIGlkZW50aWZ5IHRoZSBvYnNlcnZlclxuICAgKiBAcmV0dXJuIHt2b2lkfVxuICAgKi9cbiAgdW5PYnNlcnZlKG9ic2VydmVyOiBPYnNlcnZlciwgLi4uYXJnczogYW55W10pOiB2b2lkO1xuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gTm90aWZpZXMgYWxsIHJlZ2lzdGVyZWQgb2JzZXJ2ZXJzIG9mIGEgc3RhdGUgY2hhbmdlXG4gICAqIEBzdW1tYXJ5IENhbGxzIHRoZSB1cGRhdGUgbWV0aG9kIG9uIGFsbCByZWdpc3RlcmVkIG9ic2VydmVycywgcGFzc2luZyBhbnkgcHJvdmlkZWQgYXJndW1lbnRzXG4gICAqIEBwYXJhbSB7Li4uYW55W119IGFyZ3MgLSBBcmd1bWVudHMgdG8gcGFzcyB0byB0aGUgb2JzZXJ2ZXJzJyB1cGRhdGUgbWV0aG9kc1xuICAgKiBAcmV0dXJuIHtQcm9taXNlPHZvaWQ+fSBBIHByb21pc2UgdGhhdCByZXNvbHZlcyB3aGVuIGFsbCBvYnNlcnZlcnMgaGF2ZSBiZWVuIHVwZGF0ZWRcbiAgICovXG4gIHVwZGF0ZU9ic2VydmVycyguLi5hcmdzOiBhbnlbXSk6IFByb21pc2U8dm9pZD47XG59XG4iXX0=

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

@@ -1,3 +1,15 @@
+/**
+ * @description Interface for objects that observe state changes
+ * @summary Defines a contract for objects that implement the Observer pattern, allowing them to be notified of changes in Observable objects
+ * @interface Observer
+ * @memberOf module:core
+ */
 export interface Observer {
+    /**
+     * @description Updates the observer with new state information
+     * @summary Called by an Observable when its state changes, allowing the Observer to react to those changes
+     * @param {...any[]} args - Arguments containing state information from the Observable
+     * @return {Promise<void>} A promise that resolves when the observer has processed the update
+     */
     refresh(...args: any[]): Promise<void>;
 }

package/lib/esm/interfaces/Observer.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT2JzZXJ2ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9PYnNlcnZlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBPYnNlcnZlciB7XG4gIHJlZnJlc2goLi4uYXJnczogYW55W10pOiBQcm9taXNlPHZvaWQ+O1xufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT2JzZXJ2ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9PYnNlcnZlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gSW50ZXJmYWNlIGZvciBvYmplY3RzIHRoYXQgb2JzZXJ2ZSBzdGF0ZSBjaGFuZ2VzXG4gKiBAc3VtbWFyeSBEZWZpbmVzIGEgY29udHJhY3QgZm9yIG9iamVjdHMgdGhhdCBpbXBsZW1lbnQgdGhlIE9ic2VydmVyIHBhdHRlcm4sIGFsbG93aW5nIHRoZW0gdG8gYmUgbm90aWZpZWQgb2YgY2hhbmdlcyBpbiBPYnNlcnZhYmxlIG9iamVjdHNcbiAqIEBpbnRlcmZhY2UgT2JzZXJ2ZXJcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgaW50ZXJmYWNlIE9ic2VydmVyIHtcbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBVcGRhdGVzIHRoZSBvYnNlcnZlciB3aXRoIG5ldyBzdGF0ZSBpbmZvcm1hdGlvblxuICAgKiBAc3VtbWFyeSBDYWxsZWQgYnkgYW4gT2JzZXJ2YWJsZSB3aGVuIGl0cyBzdGF0ZSBjaGFuZ2VzLCBhbGxvd2luZyB0aGUgT2JzZXJ2ZXIgdG8gcmVhY3QgdG8gdGhvc2UgY2hhbmdlc1xuICAgKiBAcGFyYW0gey4uLmFueVtdfSBhcmdzIC0gQXJndW1lbnRzIGNvbnRhaW5pbmcgc3RhdGUgaW5mb3JtYXRpb24gZnJvbSB0aGUgT2JzZXJ2YWJsZVxuICAgKiBAcmV0dXJuIHtQcm9taXNlPHZvaWQ+fSBBIHByb21pc2UgdGhhdCByZXNvbHZlcyB3aGVuIHRoZSBvYnNlcnZlciBoYXMgcHJvY2Vzc2VkIHRoZSB1cGRhdGVcbiAgICovXG4gIHJlZnJlc2goLi4uYXJnczogYW55W10pOiBQcm9taXNlPHZvaWQ+O1xufVxuIl19

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

@@ -1,5 +1,20 @@
 import { Paginator } from "../query/Paginator";
 import { Model } from "@decaf-ts/decorator-validation";
+/**
+ * @description Interface for objects that support pagination
+ * @summary Defines a contract for objects that can paginate their results, allowing for efficient data retrieval in chunks
+ * @template M - The model type, must extend Model
+ * @template R - The result type returned by the paginator
+ * @template Q - The query type used for pagination
+ * @interface Paginatable
+ * @memberOf module:core
+ */
 export interface Paginatable<M extends Model, R, Q> {
+    /**
+     * @description Creates a paginator with the specified page size
+     * @summary Initializes a paginator that can be used to retrieve data in pages of the specified size
+     * @param {number} size - The number of items per page
+     * @return {Promise<Paginator>} A promise that resolves to a paginator for the specified model, result, and query types
+     */
     paginate(size: number): Promise<Paginator<M, R, Q>>;
 }

package/lib/esm/interfaces/Paginatable.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUGFnaW5hdGFibGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9QYWdpbmF0YWJsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgUGFnaW5hdG9yIH0gZnJvbSBcIi4uL3F1ZXJ5L1BhZ2luYXRvclwiO1xuaW1wb3J0IHsgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5cbmV4cG9ydCBpbnRlcmZhY2UgUGFnaW5hdGFibGU8TSBleHRlbmRzIE1vZGVsLCBSLCBRPiB7XG4gIHBhZ2luYXRlKHNpemU6IG51bWJlcik6IFByb21pc2U8UGFnaW5hdG9yPE0sIFIsIFE+Pjtcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUGFnaW5hdGFibGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9QYWdpbmF0YWJsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgUGFnaW5hdG9yIH0gZnJvbSBcIi4uL3F1ZXJ5L1BhZ2luYXRvclwiO1xuaW1wb3J0IHsgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEludGVyZmFjZSBmb3Igb2JqZWN0cyB0aGF0IHN1cHBvcnQgcGFnaW5hdGlvblxuICogQHN1bW1hcnkgRGVmaW5lcyBhIGNvbnRyYWN0IGZvciBvYmplY3RzIHRoYXQgY2FuIHBhZ2luYXRlIHRoZWlyIHJlc3VsdHMsIGFsbG93aW5nIGZvciBlZmZpY2llbnQgZGF0YSByZXRyaWV2YWwgaW4gY2h1bmtzXG4gKiBAdGVtcGxhdGUgTSAtIFRoZSBtb2RlbCB0eXBlLCBtdXN0IGV4dGVuZCBNb2RlbFxuICogQHRlbXBsYXRlIFIgLSBUaGUgcmVzdWx0IHR5cGUgcmV0dXJuZWQgYnkgdGhlIHBhZ2luYXRvclxuICogQHRlbXBsYXRlIFEgLSBUaGUgcXVlcnkgdHlwZSB1c2VkIGZvciBwYWdpbmF0aW9uXG4gKiBAaW50ZXJmYWNlIFBhZ2luYXRhYmxlXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBQYWdpbmF0YWJsZTxNIGV4dGVuZHMgTW9kZWwsIFIsIFE+IHtcbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBDcmVhdGVzIGEgcGFnaW5hdG9yIHdpdGggdGhlIHNwZWNpZmllZCBwYWdlIHNpemVcbiAgICogQHN1bW1hcnkgSW5pdGlhbGl6ZXMgYSBwYWdpbmF0b3IgdGhhdCBjYW4gYmUgdXNlZCB0byByZXRyaWV2ZSBkYXRhIGluIHBhZ2VzIG9mIHRoZSBzcGVjaWZpZWQgc2l6ZVxuICAgKiBAcGFyYW0ge251bWJlcn0gc2l6ZSAtIFRoZSBudW1iZXIgb2YgaXRlbXMgcGVyIHBhZ2VcbiAgICogQHJldHVybiB7UHJvbWlzZTxQYWdpbmF0b3I+fSBBIHByb21pc2UgdGhhdCByZXNvbHZlcyB0byBhIHBhZ2luYXRvciBmb3IgdGhlIHNwZWNpZmllZCBtb2RlbCwgcmVzdWx0LCBhbmQgcXVlcnkgdHlwZXNcbiAgICovXG4gIHBhZ2luYXRlKHNpemU6IG51bWJlcik6IFByb21pc2U8UGFnaW5hdG9yPE0sIFIsIFE+Pjtcbn1cbiJdfQ==

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

@@ -1,22 +1,47 @@
 import { Condition, SelectSelector, WhereOption } from "../query";
 import { OrderDirection } from "../repository";
 import { Model } from "@decaf-ts/decorator-validation";
+/**
+ * @description Interface for objects that support querying
+ * @summary Defines a contract for objects that can be queried with various conditions, selections, and ordering
+ * @template M - The model type, must extend Model
+ * @interface Queriable
+ * @memberOf module:core
+ */
 export interface Queriable<M extends Model> {
+    /**
+     * @description Selects all properties from the model
+     * @summary Creates a query that will return all properties of the model
+     * @template S - The selector type extending an array of SelectSelector<M>
+     * @return {WhereOption} A WhereOption object for further query configuration
+     */
     select<S extends readonly SelectSelector<M>[]>(): WhereOption<M, M[]>;
+    /**
+     * @description Selects specific properties from the model
+     * @summary Creates a query that will return only the specified properties of the model
+     * @template S - The selector type extending an array of SelectSelector<M>
+     * @param selector - Array of property names to select
+     * @return A WhereOption object for further query configuration
+     */
     select<S extends readonly SelectSelector<M>[]>(selector: readonly [...S]): WhereOption<M, Pick<M, S[number]>[]>;
     /**
-     *
-     * @template S the selector to be used
-     * @param {string[]} [selector] keys to be selected
+     * @description Selects properties from the model
+     * @summary Creates a query that will return either all properties or only the specified properties of the model
+     * @template S - The selector type extending an array of SelectSelector<M>
+     * @param [selector] - Optional array of property names to select
+     * @return A WhereOption object for further query configuration
      */
     select<S extends readonly SelectSelector<M>[]>(selector?: readonly [...S]): WhereOption<M, M[]> | WhereOption<M, Pick<M, S[number]>[]>;
     /**
-     *
-     * @param condition
-     * @param orderBy
-     * @param order
-     * @param limit
-     * @param skip
+     * @description Executes a query with the specified conditions and options
+     * @summary Retrieves model instances that match the given condition, ordered and limited as specified
+     * @template M - The model type, must extend Model
+     * @param {Condition<M>} condition - The condition to filter results
+     * @param {string} orderBy - The property to order results by
+     * @param {OrderDirection} order - The direction to order results (ascending or descending)
+     * @param {number} [limit] - Optional maximum number of results to return
+     * @param {number} [skip] - Optional number of results to skip
+     * @return {Promise<M[]>} A promise that resolves to an array of model instances
      */
     query(condition: Condition<M>, orderBy: keyof M, order: OrderDirection, limit?: number, skip?: number): Promise<M[]>;
 }

package/lib/esm/interfaces/Queriable.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUXVlcmlhYmxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2ludGVyZmFjZXMvUXVlcmlhYmxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25kaXRpb24sIFNlbGVjdFNlbGVjdG9yLCBXaGVyZU9wdGlvbiB9IGZyb20gXCIuLi9xdWVyeVwiO1xuaW1wb3J0IHsgT3JkZXJEaXJlY3Rpb24gfSBmcm9tIFwiLi4vcmVwb3NpdG9yeVwiO1xuaW1wb3J0IHsgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5cbmV4cG9ydCBpbnRlcmZhY2UgUXVlcmlhYmxlPE0gZXh0ZW5kcyBNb2RlbD4ge1xuICBzZWxlY3Q8XG4gICAgLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uby11bnVzZWQtdmFyc1xuICAgIFMgZXh0ZW5kcyByZWFkb25seSBTZWxlY3RTZWxlY3RvcjxNPltdLFxuICA+KCk6IFdoZXJlT3B0aW9uPE0sIE1bXT47XG4gIHNlbGVjdDxTIGV4dGVuZHMgcmVhZG9ubHkgU2VsZWN0U2VsZWN0b3I8TT5bXT4oXG4gICAgc2VsZWN0b3I6IHJlYWRvbmx5IFsuLi5TXVxuICApOiBXaGVyZU9wdGlvbjxNLCBQaWNrPE0sIFNbbnVtYmVyXT5bXT47XG5cbiAgLyoqXG4gICAqXG4gICAqIEB0ZW1wbGF0ZSBTIHRoZSBzZWxlY3RvciB0byBiZSB1c2VkXG4gICAqIEBwYXJhbSB7c3RyaW5nW119IFtzZWxlY3Rvcl0ga2V5cyB0byBiZSBzZWxlY3RlZFxuICAgKi9cbiAgc2VsZWN0PFMgZXh0ZW5kcyByZWFkb25seSBTZWxlY3RTZWxlY3RvcjxNPltdPihcbiAgICBzZWxlY3Rvcj86IHJlYWRvbmx5IFsuLi5TXVxuICApOiBXaGVyZU9wdGlvbjxNLCBNW10+IHwgV2hlcmVPcHRpb248TSwgUGljazxNLCBTW251bWJlcl0+W10+O1xuXG4gIC8qKlxuICAgKlxuICAgKiBAcGFyYW0gY29uZGl0aW9uXG4gICAqIEBwYXJhbSBvcmRlckJ5XG4gICAqIEBwYXJhbSBvcmRlclxuICAgKiBAcGFyYW0gbGltaXRcbiAgICogQHBhcmFtIHNraXBcbiAgICovXG4gIHF1ZXJ5KFxuICAgIGNvbmRpdGlvbjogQ29uZGl0aW9uPE0+LFxuICAgIG9yZGVyQnk6IGtleW9mIE0sXG4gICAgb3JkZXI6IE9yZGVyRGlyZWN0aW9uLFxuICAgIGxpbWl0PzogbnVtYmVyLFxuICAgIHNraXA/OiBudW1iZXJcbiAgKTogUHJvbWlzZTxNW10+O1xufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUXVlcmlhYmxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2ludGVyZmFjZXMvUXVlcmlhYmxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25kaXRpb24sIFNlbGVjdFNlbGVjdG9yLCBXaGVyZU9wdGlvbiB9IGZyb20gXCIuLi9xdWVyeVwiO1xuaW1wb3J0IHsgT3JkZXJEaXJlY3Rpb24gfSBmcm9tIFwiLi4vcmVwb3NpdG9yeVwiO1xuaW1wb3J0IHsgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEludGVyZmFjZSBmb3Igb2JqZWN0cyB0aGF0IHN1cHBvcnQgcXVlcnlpbmdcbiAqIEBzdW1tYXJ5IERlZmluZXMgYSBjb250cmFjdCBmb3Igb2JqZWN0cyB0aGF0IGNhbiBiZSBxdWVyaWVkIHdpdGggdmFyaW91cyBjb25kaXRpb25zLCBzZWxlY3Rpb25zLCBhbmQgb3JkZXJpbmdcbiAqIEB0ZW1wbGF0ZSBNIC0gVGhlIG1vZGVsIHR5cGUsIG11c3QgZXh0ZW5kIE1vZGVsXG4gKiBAaW50ZXJmYWNlIFF1ZXJpYWJsZVxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgUXVlcmlhYmxlPE0gZXh0ZW5kcyBNb2RlbD4ge1xuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIFNlbGVjdHMgYWxsIHByb3BlcnRpZXMgZnJvbSB0aGUgbW9kZWxcbiAgICogQHN1bW1hcnkgQ3JlYXRlcyBhIHF1ZXJ5IHRoYXQgd2lsbCByZXR1cm4gYWxsIHByb3BlcnRpZXMgb2YgdGhlIG1vZGVsXG4gICAqIEB0ZW1wbGF0ZSBTIC0gVGhlIHNlbGVjdG9yIHR5cGUgZXh0ZW5kaW5nIGFuIGFycmF5IG9mIFNlbGVjdFNlbGVjdG9yPE0+XG4gICAqIEByZXR1cm4ge1doZXJlT3B0aW9ufSBBIFdoZXJlT3B0aW9uIG9iamVjdCBmb3IgZnVydGhlciBxdWVyeSBjb25maWd1cmF0aW9uXG4gICAqL1xuICBzZWxlY3Q8XG4gICAgLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uby11bnVzZWQtdmFyc1xuICAgIFMgZXh0ZW5kcyByZWFkb25seSBTZWxlY3RTZWxlY3RvcjxNPltdLFxuICA+KCk6IFdoZXJlT3B0aW9uPE0sIE1bXT47XG5cbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBTZWxlY3RzIHNwZWNpZmljIHByb3BlcnRpZXMgZnJvbSB0aGUgbW9kZWxcbiAgICogQHN1bW1hcnkgQ3JlYXRlcyBhIHF1ZXJ5IHRoYXQgd2lsbCByZXR1cm4gb25seSB0aGUgc3BlY2lmaWVkIHByb3BlcnRpZXMgb2YgdGhlIG1vZGVsXG4gICAqIEB0ZW1wbGF0ZSBTIC0gVGhlIHNlbGVjdG9yIHR5cGUgZXh0ZW5kaW5nIGFuIGFycmF5IG9mIFNlbGVjdFNlbGVjdG9yPE0+XG4gICAqIEBwYXJhbSBzZWxlY3RvciAtIEFycmF5IG9mIHByb3BlcnR5IG5hbWVzIHRvIHNlbGVjdFxuICAgKiBAcmV0dXJuIEEgV2hlcmVPcHRpb24gb2JqZWN0IGZvciBmdXJ0aGVyIHF1ZXJ5IGNvbmZpZ3VyYXRpb25cbiAgICovXG4gIHNlbGVjdDxTIGV4dGVuZHMgcmVhZG9ubHkgU2VsZWN0U2VsZWN0b3I8TT5bXT4oXG4gICAgc2VsZWN0b3I6IHJlYWRvbmx5IFsuLi5TXVxuICApOiBXaGVyZU9wdGlvbjxNLCBQaWNrPE0sIFNbbnVtYmVyXT5bXT47XG5cbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBTZWxlY3RzIHByb3BlcnRpZXMgZnJvbSB0aGUgbW9kZWxcbiAgICogQHN1bW1hcnkgQ3JlYXRlcyBhIHF1ZXJ5IHRoYXQgd2lsbCByZXR1cm4gZWl0aGVyIGFsbCBwcm9wZXJ0aWVzIG9yIG9ubHkgdGhlIHNwZWNpZmllZCBwcm9wZXJ0aWVzIG9mIHRoZSBtb2RlbFxuICAgKiBAdGVtcGxhdGUgUyAtIFRoZSBzZWxlY3RvciB0eXBlIGV4dGVuZGluZyBhbiBhcnJheSBvZiBTZWxlY3RTZWxlY3RvcjxNPlxuICAgKiBAcGFyYW0gW3NlbGVjdG9yXSAtIE9wdGlvbmFsIGFycmF5IG9mIHByb3BlcnR5IG5hbWVzIHRvIHNlbGVjdFxuICAgKiBAcmV0dXJuIEEgV2hlcmVPcHRpb24gb2JqZWN0IGZvciBmdXJ0aGVyIHF1ZXJ5IGNvbmZpZ3VyYXRpb25cbiAgICovXG4gIHNlbGVjdDxTIGV4dGVuZHMgcmVhZG9ubHkgU2VsZWN0U2VsZWN0b3I8TT5bXT4oXG4gICAgc2VsZWN0b3I/OiByZWFkb25seSBbLi4uU11cbiAgKTogV2hlcmVPcHRpb248TSwgTVtdPiB8IFdoZXJlT3B0aW9uPE0sIFBpY2s8TSwgU1tudW1iZXJdPltdPjtcblxuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIEV4ZWN1dGVzIGEgcXVlcnkgd2l0aCB0aGUgc3BlY2lmaWVkIGNvbmRpdGlvbnMgYW5kIG9wdGlvbnNcbiAgICogQHN1bW1hcnkgUmV0cmlldmVzIG1vZGVsIGluc3RhbmNlcyB0aGF0IG1hdGNoIHRoZSBnaXZlbiBjb25kaXRpb24sIG9yZGVyZWQgYW5kIGxpbWl0ZWQgYXMgc3BlY2lmaWVkXG4gICAqIEB0ZW1wbGF0ZSBNIC0gVGhlIG1vZGVsIHR5cGUsIG11c3QgZXh0ZW5kIE1vZGVsXG4gICAqIEBwYXJhbSB7Q29uZGl0aW9uPE0+fSBjb25kaXRpb24gLSBUaGUgY29uZGl0aW9uIHRvIGZpbHRlciByZXN1bHRzXG4gICAqIEBwYXJhbSB7c3RyaW5nfSBvcmRlckJ5IC0gVGhlIHByb3BlcnR5IHRvIG9yZGVyIHJlc3VsdHMgYnlcbiAgICogQHBhcmFtIHtPcmRlckRpcmVjdGlvbn0gb3JkZXIgLSBUaGUgZGlyZWN0aW9uIHRvIG9yZGVyIHJlc3VsdHMgKGFzY2VuZGluZyBvciBkZXNjZW5kaW5nKVxuICAgKiBAcGFyYW0ge251bWJlcn0gW2xpbWl0XSAtIE9wdGlvbmFsIG1heGltdW0gbnVtYmVyIG9mIHJlc3VsdHMgdG8gcmV0dXJuXG4gICAqIEBwYXJhbSB7bnVtYmVyfSBbc2tpcF0gLSBPcHRpb25hbCBudW1iZXIgb2YgcmVzdWx0cyB0byBza2lwXG4gICAqIEByZXR1cm4ge1Byb21pc2U8TVtdPn0gQSBwcm9taXNlIHRoYXQgcmVzb2x2ZXMgdG8gYW4gYXJyYXkgb2YgbW9kZWwgaW5zdGFuY2VzXG4gICAqL1xuICBxdWVyeShcbiAgICBjb25kaXRpb246IENvbmRpdGlvbjxNPixcbiAgICBvcmRlckJ5OiBrZXlvZiBNLFxuICAgIG9yZGVyOiBPcmRlckRpcmVjdGlvbixcbiAgICBsaW1pdD86IG51bWJlcixcbiAgICBza2lwPzogbnVtYmVyXG4gICk6IFByb21pc2U8TVtdPjtcbn1cbiJdfQ==

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

@@ -1,3 +1,17 @@
+/**
+ * @description Interface for executing raw queries
+ * @summary Defines a contract for objects that can execute raw queries of a specific type and return results
+ * @template Q - The query type that this executor can process
+ * @interface RawExecutor
+ * @memberOf module:core
+ */
 export interface RawExecutor<Q> {
+    /**
+     * @description Executes a raw query
+     * @summary Processes a raw query input and returns a promise that resolves to the result
+     * @template R - The result type that will be returned
+     * @param {Q} rawInput - The raw query to execute
+     * @return {Promise<R>} A promise that resolves to the result of type R
+     */
     raw<R>(rawInput: Q): Promise<R>;
 }

package/lib/esm/interfaces/RawExecutor.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmF3RXhlY3V0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9SYXdFeGVjdXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBSYXdFeGVjdXRvcjxRPiB7XG4gIHJhdzxSPihyYXdJbnB1dDogUSk6IFByb21pc2U8Uj47XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmF3RXhlY3V0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW50ZXJmYWNlcy9SYXdFeGVjdXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gSW50ZXJmYWNlIGZvciBleGVjdXRpbmcgcmF3IHF1ZXJpZXNcbiAqIEBzdW1tYXJ5IERlZmluZXMgYSBjb250cmFjdCBmb3Igb2JqZWN0cyB0aGF0IGNhbiBleGVjdXRlIHJhdyBxdWVyaWVzIG9mIGEgc3BlY2lmaWMgdHlwZSBhbmQgcmV0dXJuIHJlc3VsdHNcbiAqIEB0ZW1wbGF0ZSBRIC0gVGhlIHF1ZXJ5IHR5cGUgdGhhdCB0aGlzIGV4ZWN1dG9yIGNhbiBwcm9jZXNzXG4gKiBAaW50ZXJmYWNlIFJhd0V4ZWN1dG9yXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBSYXdFeGVjdXRvcjxRPiB7XG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gRXhlY3V0ZXMgYSByYXcgcXVlcnlcbiAgICogQHN1bW1hcnkgUHJvY2Vzc2VzIGEgcmF3IHF1ZXJ5IGlucHV0IGFuZCByZXR1cm5zIGEgcHJvbWlzZSB0aGF0IHJlc29sdmVzIHRvIHRoZSByZXN1bHRcbiAgICogQHRlbXBsYXRlIFIgLSBUaGUgcmVzdWx0IHR5cGUgdGhhdCB3aWxsIGJlIHJldHVybmVkXG4gICAqIEBwYXJhbSB7UX0gcmF3SW5wdXQgLSBUaGUgcmF3IHF1ZXJ5IHRvIGV4ZWN1dGVcbiAgICogQHJldHVybiB7UHJvbWlzZTxSPn0gQSBwcm9taXNlIHRoYXQgcmVzb2x2ZXMgdG8gdGhlIHJlc3VsdCBvZiB0eXBlIFJcbiAgICovXG4gIHJhdzxSPihyYXdJbnB1dDogUSk6IFByb21pc2U8Uj47XG59XG4iXX0=

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

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