@decaf-ts/core 0.5.0 → 0.5.2

package/lib/identity/decorators.cjs

@@ -10,22 +10,40 @@ const decorators_1 = require("./../model/decorators.cjs");
 const utils_1 = require("./utils.cjs");
 const repository_1 = require("./../repository/index.cjs");
 /**
- * @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
  *
- *
- *
- * @function pk
- *
- * @memberOf module:wallet-db.Decorators
- *
- * @see unique
- * @see required
- * @see on
- * @param data
- * @param key
- * @param model
+ *   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
  */
 async function pkOnCreate(context, data, key, model) {
     if (!data.type || model[key]) {
@@ -51,6 +69,26 @@ async function pkOnCreate(context, data, key, model) {
     const next = await sequence.next();
     setPrimaryKeyValue(model, key, next);
 }
+/**
+ * @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;
+ *
+ *   @required()
+ *   username!: string;
+ * }
+ * ```
+ */
 function pk(opts = SequenceOptions_1.DefaultSequenceOptions) {
     opts = Object.assign({}, SequenceOptions_1.DefaultSequenceOptions, opts);
     const key = Repository_1.Repository.key(db_decorators_1.DBKeys.ID);
@@ -60,4 +98,4 @@ function pk(opts = SequenceOptions_1.DefaultSequenceOptions) {
     (0, decorator_validation_1.propMetadata)(key, opts), (0, db_decorators_1.onCreate)(pkOnCreate, opts))
         .apply();
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pZGVudGl0eS9kZWNvcmF0b3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBMENBLGdDQXlDQztBQUVELGdCQWtCQztBQXZHRCx5RUFLd0M7QUFDeEMseUVBR3VDO0FBQ3ZDLDJEQU1pQztBQUNqQywrREFBNEQ7QUFDNUQsMERBQTRDO0FBQzVDLHVDQUErQztBQUcvQywwREFBK0M7QUFFL0M7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBaUJHO0FBQ0ksS0FBSyxVQUFVLFVBQVUsQ0FROUIsT0FBbUIsRUFDbkIsSUFBTyxFQUNQLEdBQVksRUFDWixLQUFRO0lBRVIsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLElBQUksS0FBSyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7UUFDN0IsT0FBTztJQUNULENBQUM7SUFFRCxNQUFNLGtCQUFrQixHQUFHLFVBQ3pCLE1BQVMsRUFDVCxXQUFtQixFQUNuQixLQUErQjtRQUUvQixNQUFNLENBQUMsY0FBYyxDQUFDLE1BQU0sRUFBRSxXQUFXLEVBQUU7WUFDekMsVUFBVSxFQUFFLElBQUk7WUFDaEIsUUFBUSxFQUFFLEtBQUs7WUFDZixZQUFZLEVBQUUsSUFBSTtZQUNsQixLQUFLLEVBQUUsS0FBSztTQUNiLENBQUMsQ0FBQztJQUNMLENBQUMsQ0FBQztJQUNGLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSTtRQUFFLElBQUksQ0FBQyxJQUFJLEdBQUcsSUFBQSw0QkFBb0IsRUFBQyxLQUFLLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDOUQsSUFBSSxRQUFrQixDQUFDO0lBQ3ZCLElBQUksQ0FBQztRQUNILFFBQVEsR0FBRyxNQUFNLElBQUksQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQy9DLENBQUM7SUFBQyxPQUFPLENBQU0sRUFBRSxDQUFDO1FBQ2hCLE1BQU0sSUFBSSw2QkFBYSxDQUNyQixrQ0FBa0MsSUFBSSxDQUFDLElBQUksS0FBSyxDQUFDLEVBQUUsQ0FDcEQsQ0FBQztJQUNKLENBQUM7SUFFRCxNQUFNLElBQUksR0FBRyxNQUFNLFFBQVEsQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUNuQyxrQkFBa0IsQ0FBQyxLQUFLLEVBQUUsR0FBYSxFQUFFLElBQUksQ0FBQyxDQUFDO0FBQ2pELENBQUM7QUFFRCxTQUFnQixFQUFFLENBQ2hCLE9BR0ksd0NBQXNCO0lBRTFCLElBQUksR0FBRyxNQUFNLENBQUMsTUFBTSxDQUFDLEVBQUUsRUFBRSx3Q0FBc0IsRUFBRSxJQUFJLENBQW9CLENBQUM7SUFDMUUsTUFBTSxHQUFHLEdBQUcsdUJBQVUsQ0FBQyxHQUFHLENBQUMsc0JBQU0sQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUN0QyxPQUFPLGlDQUFVLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQztTQUN2QixNQUFNLENBQ0wsSUFBQSxrQkFBSyxFQUFDLENBQUMsMkJBQWMsQ0FBQyxHQUFHLEVBQUUsMkJBQWMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxFQUMvQyxJQUFBLCtCQUFRLEdBQUUsRUFDVixJQUFBLHdCQUFRLEdBQUU7SUFDVixpREFBaUQ7SUFDakQsSUFBQSxtQ0FBWSxFQUFDLEdBQUcsRUFBRSxJQUF1QixDQUFDLEVBQzFDLElBQUEsd0JBQVEsRUFBQyxVQUFVLEVBQUUsSUFBdUIsQ0FBQyxDQUM5QztTQUNBLEtBQUssRUFBRSxDQUFDO0FBQ2IsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7XG4gIERlY29yYXRpb24sXG4gIE1vZGVsLFxuICBwcm9wTWV0YWRhdGEsXG4gIHJlcXVpcmVkLFxufSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQge1xuICBEZWZhdWx0U2VxdWVuY2VPcHRpb25zLFxuICBTZXF1ZW5jZU9wdGlvbnMsXG59IGZyb20gXCIuLi9pbnRlcmZhY2VzL1NlcXVlbmNlT3B0aW9uc1wiO1xuaW1wb3J0IHtcbiAgREJLZXlzLFxuICBJbnRlcm5hbEVycm9yLFxuICBvbkNyZWF0ZSxcbiAgcmVhZG9ubHksXG4gIFJlcG9zaXRvcnlGbGFncyxcbn0gZnJvbSBcIkBkZWNhZi10cy9kYi1kZWNvcmF0b3JzXCI7XG5pbXBvcnQgeyBSZXBvLCBSZXBvc2l0b3J5IH0gZnJvbSBcIi4uL3JlcG9zaXRvcnkvUmVwb3NpdG9yeVwiO1xuaW1wb3J0IHsgaW5kZXggfSBmcm9tIFwiLi4vbW9kZWwvZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgc2VxdWVuY2VOYW1lRm9yTW9kZWwgfSBmcm9tIFwiLi91dGlsc1wiO1xuaW1wb3J0IHsgU2VxdWVuY2UgfSBmcm9tIFwiLi4vcGVyc2lzdGVuY2UvU2VxdWVuY2VcIjtcbmltcG9ydCB7IENvbnRleHQgfSBmcm9tIFwiQGRlY2FmLXRzL2RiLWRlY29yYXRvcnNcIjtcbmltcG9ydCB7IE9yZGVyRGlyZWN0aW9uIH0gZnJvbSBcIi4uL3JlcG9zaXRvcnlcIjtcblxuLyoqXG4gKiBAc3VtbWFyeSBQcmltYXJ5IEtleSBEZWNvcmF0b3JcbiAqIEBkZXNjcmlwdGlvbiBNYXJrcyB0aGUgcHJvcGVydHkgYXMgdGhlIHtAbGluayBNb2RlbH1zIHByaW1hcnkga2V5LlxuICogIEFsc28gbWFya3MgdGhlIHByb3BlcnR5IGFzIHtAbGluayB1bmlxdWV9IGFzIHtAcmVxdWlyZWR9IGFuZCBlbnN1cmVzIHRoZSBpbmRleCBpcyBjcmVhdGVkIHByb3Blcmx5IGFjY29yZGluZyB0byB0aGUgcHJvdmlkZWQge0BsaW5rIFNlcXVlbmNlfVxuICpcbiAqXG4gKlxuICogQGZ1bmN0aW9uIHBrXG4gKlxuICogQG1lbWJlck9mIG1vZHVsZTp3YWxsZXQtZGIuRGVjb3JhdG9yc1xuICpcbiAqIEBzZWUgdW5pcXVlXG4gKiBAc2VlIHJlcXVpcmVkXG4gKiBAc2VlIG9uXG4gKiBAcGFyYW0gZGF0YVxuICogQHBhcmFtIGtleVxuICogQHBhcmFtIG1vZGVsXG4gKi9cbmV4cG9ydCBhc3luYyBmdW5jdGlvbiBwa09uQ3JlYXRlPFxuICBNIGV4dGVuZHMgTW9kZWwsXG4gIFIgZXh0ZW5kcyBSZXBvPE0sIEMsIEY+LFxuICBWIGV4dGVuZHMgU2VxdWVuY2VPcHRpb25zLFxuICBGIGV4dGVuZHMgUmVwb3NpdG9yeUZsYWdzLFxuICBDIGV4dGVuZHMgQ29udGV4dDxGPixcbj4oXG4gIHRoaXM6IFIsXG4gIGNvbnRleHQ6IENvbnRleHQ8Rj4sXG4gIGRhdGE6IFYsXG4gIGtleToga2V5b2YgTSxcbiAgbW9kZWw6IE1cbik6IFByb21pc2U8dm9pZD4ge1xuICBpZiAoIWRhdGEudHlwZSB8fCBtb2RlbFtrZXldKSB7XG4gICAgcmV0dXJuO1xuICB9XG5cbiAgY29uc3Qgc2V0UHJpbWFyeUtleVZhbHVlID0gZnVuY3Rpb24gPE0gZXh0ZW5kcyBNb2RlbD4oXG4gICAgdGFyZ2V0OiBNLFxuICAgIHByb3BlcnR5S2V5OiBzdHJpbmcsXG4gICAgdmFsdWU6IHN0cmluZyB8IG51bWJlciB8IGJpZ2ludFxuICApIHtcbiAgICBPYmplY3QuZGVmaW5lUHJvcGVydHkodGFyZ2V0LCBwcm9wZXJ0eUtleSwge1xuICAgICAgZW51bWVyYWJsZTogdHJ1ZSxcbiAgICAgIHdyaXRhYmxlOiBmYWxzZSxcbiAgICAgIGNvbmZpZ3VyYWJsZTogdHJ1ZSxcbiAgICAgIHZhbHVlOiB2YWx1ZSxcbiAgICB9KTtcbiAgfTtcbiAgaWYgKCFkYXRhLm5hbWUpIGRhdGEubmFtZSA9IHNlcXVlbmNlTmFtZUZvck1vZGVsKG1vZGVsLCBcInBrXCIpO1xuICBsZXQgc2VxdWVuY2U6IFNlcXVlbmNlO1xuICB0cnkge1xuICAgIHNlcXVlbmNlID0gYXdhaXQgdGhpcy5hZGFwdGVyLlNlcXVlbmNlKGRhdGEpO1xuICB9IGNhdGNoIChlOiBhbnkpIHtcbiAgICB0aHJvdyBuZXcgSW50ZXJuYWxFcnJvcihcbiAgICAgIGBGYWlsZWQgdG8gaW5zdGFudGlhdGUgU2VxdWVuY2UgJHtkYXRhLm5hbWV9OiAke2V9YFxuICAgICk7XG4gIH1cblxuICBjb25zdCBuZXh0ID0gYXdhaXQgc2VxdWVuY2UubmV4dCgpO1xuICBzZXRQcmltYXJ5S2V5VmFsdWUobW9kZWwsIGtleSBhcyBzdHJpbmcsIG5leHQpO1xufVxuXG5leHBvcnQgZnVuY3Rpb24gcGsoXG4gIG9wdHM6IE9taXQ8XG4gICAgU2VxdWVuY2VPcHRpb25zLFxuICAgIFwiY3ljbGVcIiB8IFwic3RhcnRXaXRoXCIgfCBcImluY3JlbWVudEJ5XCJcbiAgPiA9IERlZmF1bHRTZXF1ZW5jZU9wdGlvbnNcbikge1xuICBvcHRzID0gT2JqZWN0LmFzc2lnbih7fSwgRGVmYXVsdFNlcXVlbmNlT3B0aW9ucywgb3B0cykgYXMgU2VxdWVuY2VPcHRpb25zO1xuICBjb25zdCBrZXkgPSBSZXBvc2l0b3J5LmtleShEQktleXMuSUQpO1xuICByZXR1cm4gRGVjb3JhdGlvbi5mb3Ioa2V5KVxuICAgIC5kZWZpbmUoXG4gICAgICBpbmRleChbT3JkZXJEaXJlY3Rpb24uQVNDLCBPcmRlckRpcmVjdGlvbi5EU0NdKSxcbiAgICAgIHJlcXVpcmVkKCksXG4gICAgICByZWFkb25seSgpLFxuICAgICAgLy8gdHlwZShbU3RyaW5nLm5hbWUsIE51bWJlci5uYW1lLCBCaWdJbnQubmFtZV0pLFxuICAgICAgcHJvcE1ldGFkYXRhKGtleSwgb3B0cyBhcyBTZXF1ZW5jZU9wdGlvbnMpLFxuICAgICAgb25DcmVhdGUocGtPbkNyZWF0ZSwgb3B0cyBhcyBTZXF1ZW5jZU9wdGlvbnMpXG4gICAgKVxuICAgIC5hcHBseSgpO1xufVxuIl19
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/identity/decorators.ts"],"names":[],"mappings":";;AA4DA,gCAyCC;AAsBD,gBAkBC;AA7ID,yEAKwC;AACxC,yEAGuC;AACvC,2DAMiC;AACjC,+DAA4D;AAC5D,0DAA4C;AAC5C,uCAA+C;AAG/C,0DAA+C;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACI,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,IAAA,4BAAoB,EAAC,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,6BAAa,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,SAAgB,EAAE,CAChB,OAGI,wCAAsB;IAE1B,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,wCAAsB,EAAE,IAAI,CAAoB,CAAC;IAC1E,MAAM,GAAG,GAAG,uBAAU,CAAC,GAAG,CAAC,sBAAM,CAAC,EAAE,CAAC,CAAC;IACtC,OAAO,iCAAU,CAAC,GAAG,CAAC,GAAG,CAAC;SACvB,MAAM,CACL,IAAA,kBAAK,EAAC,CAAC,2BAAc,CAAC,GAAG,EAAE,2BAAc,CAAC,GAAG,CAAC,CAAC,EAC/C,IAAA,+BAAQ,GAAE,EACV,IAAA,wBAAQ,GAAE;IACV,iDAAiD;IACjD,IAAA,mCAAY,EAAC,GAAG,EAAE,IAAuB,CAAC,EAC1C,IAAA,wBAAQ,EAAC,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/identity/decorators.d.ts

@@ -4,22 +4,60 @@ import { RepositoryFlags } from "@decaf-ts/db-decorators";
 import { Repo } from "../repository/Repository";
 import { Context } from "@decaf-ts/db-decorators";
 /**
- * @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;
  *
- * @memberOf module:wallet-db.Decorators
- *
- * @see unique
- * @see required
- * @see on
- * @param data
- * @param key
- * @param model
+ *   @required()
+ *   username!: string;
+ * }
+ * ```
  */
-export declare function pkOnCreate<M extends Model, R extends Repo<M, C, F>, V extends SequenceOptions, F extends RepositoryFlags, C extends Context<F>>(this: R, context: Context<F>, data: V, key: keyof M, model: M): Promise<void>;
 export declare function pk(opts?: Omit<SequenceOptions, "cycle" | "startWith" | "incrementBy">): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;

package/lib/identity/utils.cjs

@@ -5,8 +5,18 @@ exports.sequenceNameForModel = sequenceNameForModel;
 const decorator_validation_1 = require("@decaf-ts/decorator-validation");
 const Adapter_1 = require("./../persistence/Adapter.cjs");
 const constants_1 = require("./../persistence/constants.cjs");
+/**
+ * @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
+ */
 function getTableName(model) {
-    const metadata = Reflect.getMetadata(Adapter_1.Adapter.key(constants_1.PersistenceKeys.TABLE), model instanceof decorator_validation_1.Model ? model.constructor : model);
+    const obj = model instanceof decorator_validation_1.Model ? model.constructor : model;
+    const metadata = Reflect.getOwnMetadata(Adapter_1.Adapter.key(constants_1.PersistenceKeys.TABLE), obj);
     if (metadata) {
         return metadata;
     }
@@ -15,7 +25,17 @@ 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
+ */
 function sequenceNameForModel(model, ...args) {
     return [getTableName(model), ...args].join("_");
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaWRlbnRpdHkvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFJQSxvQ0FZQztBQUVELG9EQUtDO0FBdkJELHlFQUFvRTtBQUNwRSwwREFBaUQ7QUFDakQsOERBQTJEO0FBRTNELFNBQWdCLFlBQVksQ0FBa0IsS0FBeUI7SUFDckUsTUFBTSxRQUFRLEdBQUcsT0FBTyxDQUFDLFdBQVcsQ0FDbEMsaUJBQU8sQ0FBQyxHQUFHLENBQUMsMkJBQWUsQ0FBQyxLQUFLLENBQUMsRUFDbEMsS0FBSyxZQUFZLDRCQUFLLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FDbkQsQ0FBQztJQUNGLElBQUksUUFBUSxFQUFFLENBQUM7UUFDYixPQUFPLFFBQVEsQ0FBQztJQUNsQixDQUFDO0lBQ0QsSUFBSSxLQUFLLFlBQVksNEJBQUssRUFBRSxDQUFDO1FBQzNCLE9BQU8sS0FBSyxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUM7SUFDaEMsQ0FBQztJQUNELE9BQU8sS0FBSyxDQUFDLElBQUksQ0FBQztBQUNwQixDQUFDO0FBRUQsU0FBZ0Isb0JBQW9CLENBQ2xDLEtBQXlCLEVBQ3pCLEdBQUcsSUFBYztJQUVqQixPQUFPLENBQUMsWUFBWSxDQUFDLEtBQUssQ0FBQyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0FBQ2xELENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25zdHJ1Y3RvciwgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBBZGFwdGVyIH0gZnJvbSBcIi4uL3BlcnNpc3RlbmNlL0FkYXB0ZXJcIjtcbmltcG9ydCB7IFBlcnNpc3RlbmNlS2V5cyB9IGZyb20gXCIuLi9wZXJzaXN0ZW5jZS9jb25zdGFudHNcIjtcblxuZXhwb3J0IGZ1bmN0aW9uIGdldFRhYmxlTmFtZTxNIGV4dGVuZHMgTW9kZWw+KG1vZGVsOiBNIHwgQ29uc3RydWN0b3I8TT4pIHtcbiAgY29uc3QgbWV0YWRhdGEgPSBSZWZsZWN0LmdldE1ldGFkYXRhKFxuICAgIEFkYXB0ZXIua2V5KFBlcnNpc3RlbmNlS2V5cy5UQUJMRSksXG4gICAgbW9kZWwgaW5zdGFuY2VvZiBNb2RlbCA/IG1vZGVsLmNvbnN0cnVjdG9yIDogbW9kZWxcbiAgKTtcbiAgaWYgKG1ldGFkYXRhKSB7XG4gICAgcmV0dXJuIG1ldGFkYXRhO1xuICB9XG4gIGlmIChtb2RlbCBpbnN0YW5jZW9mIE1vZGVsKSB7XG4gICAgcmV0dXJuIG1vZGVsLmNvbnN0cnVjdG9yLm5hbWU7XG4gIH1cbiAgcmV0dXJuIG1vZGVsLm5hbWU7XG59XG5cbmV4cG9ydCBmdW5jdGlvbiBzZXF1ZW5jZU5hbWVGb3JNb2RlbDxNIGV4dGVuZHMgTW9kZWw+KFxuICBtb2RlbDogTSB8IENvbnN0cnVjdG9yPE0+LFxuICAuLi5hcmdzOiBzdHJpbmdbXVxuKSB7XG4gIHJldHVybiBbZ2V0VGFibGVOYW1lKG1vZGVsKSwgLi4uYXJnc10uam9pbihcIl9cIik7XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaWRlbnRpdHkvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFhQSxvQ0FnQkM7QUFZRCxvREFLQztBQTlDRCx5RUFBb0U7QUFDcEUsMERBQWlEO0FBQ2pELDhEQUEyRDtBQUUzRDs7Ozs7Ozs7R0FRRztBQUNILFNBQWdCLFlBQVksQ0FDMUIsS0FBeUI7SUFFekIsTUFBTSxHQUFHLEdBQUcsS0FBSyxZQUFZLDRCQUFLLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQztJQUUvRCxNQUFNLFFBQVEsR0FBRyxPQUFPLENBQUMsY0FBYyxDQUNyQyxpQkFBTyxDQUFDLEdBQUcsQ0FBQywyQkFBZSxDQUFDLEtBQUssQ0FBQyxFQUNsQyxHQUFHLENBQ0osQ0FBQztJQUNGLElBQUksUUFBUSxFQUFFLENBQUM7UUFDYixPQUFPLFFBQVEsQ0FBQztJQUNsQixDQUFDO0lBQ0QsSUFBSSxLQUFLLFlBQVksNEJBQUssRUFBRSxDQUFDO1FBQzNCLE9BQU8sS0FBSyxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUM7SUFDaEMsQ0FBQztJQUNELE9BQU8sS0FBSyxDQUFDLElBQUksQ0FBQztBQUNwQixDQUFDO0FBRUQ7Ozs7Ozs7OztHQVNHO0FBQ0gsU0FBZ0Isb0JBQW9CLENBQ2xDLEtBQXlCLEVBQ3pCLEdBQUcsSUFBYztJQUVqQixPQUFPLENBQUMsWUFBWSxDQUFDLEtBQUssQ0FBQyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0FBQ2xELENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25zdHJ1Y3RvciwgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBBZGFwdGVyIH0gZnJvbSBcIi4uL3BlcnNpc3RlbmNlL0FkYXB0ZXJcIjtcbmltcG9ydCB7IFBlcnNpc3RlbmNlS2V5cyB9IGZyb20gXCIuLi9wZXJzaXN0ZW5jZS9jb25zdGFudHNcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gR2V0cyB0aGUgdGFibGUgbmFtZSBmb3IgYSBtb2RlbFxuICogQHN1bW1hcnkgUmV0cmlldmVzIHRoZSB0YWJsZSBuYW1lIGFzc29jaWF0ZWQgd2l0aCBhIG1vZGVsIGJ5IGNoZWNraW5nIG1ldGFkYXRhIG9yIGZhbGxpbmcgYmFjayB0byB0aGUgY29uc3RydWN0b3IgbmFtZVxuICogQHRlbXBsYXRlIE0gLSBUeXBlIHRoYXQgZXh0ZW5kcyBNb2RlbFxuICogQHBhcmFtIHtNIHwgQ29uc3RydWN0b3I8TT59IG1vZGVsIC0gVGhlIG1vZGVsIGluc3RhbmNlIG9yIGNvbnN0cnVjdG9yIHRvIGdldCB0aGUgdGFibGUgbmFtZSBmb3JcbiAqIEByZXR1cm4ge3N0cmluZ30gVGhlIHRhYmxlIG5hbWUgZm9yIHRoZSBtb2RlbFxuICogQGZ1bmN0aW9uIGdldFRhYmxlTmFtZVxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBnZXRUYWJsZU5hbWU8TSBleHRlbmRzIE1vZGVsPihcbiAgbW9kZWw6IE0gfCBDb25zdHJ1Y3RvcjxNPlxuKTogc3RyaW5nIHtcbiAgY29uc3Qgb2JqID0gbW9kZWwgaW5zdGFuY2VvZiBNb2RlbCA/IG1vZGVsLmNvbnN0cnVjdG9yIDogbW9kZWw7XG5cbiAgY29uc3QgbWV0YWRhdGEgPSBSZWZsZWN0LmdldE93bk1ldGFkYXRhKFxuICAgIEFkYXB0ZXIua2V5KFBlcnNpc3RlbmNlS2V5cy5UQUJMRSksXG4gICAgb2JqXG4gICk7XG4gIGlmIChtZXRhZGF0YSkge1xuICAgIHJldHVybiBtZXRhZGF0YTtcbiAgfVxuICBpZiAobW9kZWwgaW5zdGFuY2VvZiBNb2RlbCkge1xuICAgIHJldHVybiBtb2RlbC5jb25zdHJ1Y3Rvci5uYW1lO1xuICB9XG4gIHJldHVybiBtb2RlbC5uYW1lO1xufVxuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBHZW5lcmF0ZXMgYSBzZXF1ZW5jZSBuYW1lIGZvciBhIG1vZGVsXG4gKiBAc3VtbWFyeSBDcmVhdGVzIGEgc3RhbmRhcmRpemVkIHNlcXVlbmNlIG5hbWUgYnkgY29tYmluaW5nIHRoZSB0YWJsZSBuYW1lIHdpdGggYWRkaXRpb25hbCBhcmd1bWVudHNcbiAqIEB0ZW1wbGF0ZSBNIC0gVHlwZSB0aGF0IGV4dGVuZHMgTW9kZWxcbiAqIEBwYXJhbSB7TSB8IENvbnN0cnVjdG9yPE0+fSBtb2RlbCAtIFRoZSBtb2RlbCBpbnN0YW5jZSBvciBjb25zdHJ1Y3RvciB0byBnZW5lcmF0ZSB0aGUgc2VxdWVuY2UgbmFtZSBmb3JcbiAqIEBwYXJhbSB7Li4uc3RyaW5nfSBhcmdzIC0gQWRkaXRpb25hbCBzdHJpbmcgYXJndW1lbnRzIHRvIGFwcGVuZCB0byB0aGUgc2VxdWVuY2UgbmFtZVxuICogQHJldHVybiB7c3RyaW5nfSBUaGUgZ2VuZXJhdGVkIHNlcXVlbmNlIG5hbWVcbiAqIEBmdW5jdGlvbiBzZXF1ZW5jZU5hbWVGb3JNb2RlbFxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBzZXF1ZW5jZU5hbWVGb3JNb2RlbDxNIGV4dGVuZHMgTW9kZWw+KFxuICBtb2RlbDogTSB8IENvbnN0cnVjdG9yPE0+LFxuICAuLi5hcmdzOiBzdHJpbmdbXVxuKSB7XG4gIHJldHVybiBbZ2V0VGFibGVOYW1lKG1vZGVsKSwgLi4uYXJnc10uam9pbihcIl9cIik7XG59XG4iXX0=

package/lib/identity/utils.d.ts

@@ -1,3 +1,22 @@
 import { Constructor, Model } from "@decaf-ts/decorator-validation";
-export declare function getTableName<M extends Model>(model: M | Constructor<M>): any;
+/**
+ * @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/index.cjs

@@ -1,4 +1,11 @@
 "use strict";
+/**
+ * @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.
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -17,30 +24,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 const repository_1 = require("./repository/index.cjs");
 const injectable_decorators_1 = require("@decaf-ts/injectable-decorators");
-/**
- * @summary Module summary
- * @description Module description
- * @module ts-workspace
- */
-/**
- * @summary Namespace summary
- * @description Namespace description
- * @namespace Namespace
- * @memberOf module:ts-workspace
- */
+// overrides the previous Injectables registry to enable the @repository decorator
+injectable_decorators_1.Injectables.setRegistry(new repository_1.InjectablesRegistry());
 __exportStar(require("./identity/index.cjs"), exports);
 __exportStar(require("./interfaces/index.cjs"), exports);
 __exportStar(require("./model/index.cjs"), exports);
-__exportStar(require("./persistence/index.cjs"), exports);
 __exportStar(require("./query/index.cjs"), exports);
 __exportStar(require("./repository/index.cjs"), exports);
-__exportStar(require("./validators/index.cjs"), exports);
-injectable_decorators_1.Injectables.setRegistry(new repository_1.InjectablesRegistry());
+__exportStar(require("./utils/index.cjs"), exports);
+//left to last on purpose
+__exportStar(require("./persistence/index.cjs"), exports);
 /**
- * @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:ts-workspace
+ * @memberOf module:core
  */
-exports.VERSION = "0.5.0";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSx1REFBbUQ7QUFDbkQsMkVBQThEO0FBRTlEOzs7O0dBSUc7QUFFSDs7Ozs7R0FLRztBQUVILHVEQUEyQjtBQUMzQix5REFBNkI7QUFDN0Isb0RBQXdCO0FBQ3hCLDBEQUE4QjtBQUM5QixvREFBd0I7QUFDeEIseURBQTZCO0FBQzdCLHlEQUE2QjtBQUU3QixtQ0FBVyxDQUFDLFdBQVcsQ0FBQyxJQUFJLGdDQUFtQixFQUFFLENBQUMsQ0FBQztBQUVuRDs7Ozs7R0FLRztBQUNVLFFBQUEsT0FBTyxHQUFHLGFBQWEsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEluamVjdGFibGVzUmVnaXN0cnkgfSBmcm9tIFwiLi9yZXBvc2l0b3J5XCI7XG5pbXBvcnQgeyBJbmplY3RhYmxlcyB9IGZyb20gXCJAZGVjYWYtdHMvaW5qZWN0YWJsZS1kZWNvcmF0b3JzXCI7XG5cbi8qKlxuICogQHN1bW1hcnkgTW9kdWxlIHN1bW1hcnlcbiAqIEBkZXNjcmlwdGlvbiBNb2R1bGUgZGVzY3JpcHRpb25cbiAqIEBtb2R1bGUgdHMtd29ya3NwYWNlXG4gKi9cblxuLyoqXG4gKiBAc3VtbWFyeSBOYW1lc3BhY2Ugc3VtbWFyeVxuICogQGRlc2NyaXB0aW9uIE5hbWVzcGFjZSBkZXNjcmlwdGlvblxuICogQG5hbWVzcGFjZSBOYW1lc3BhY2VcbiAqIEBtZW1iZXJPZiBtb2R1bGU6dHMtd29ya3NwYWNlXG4gKi9cblxuZXhwb3J0ICogZnJvbSBcIi4vaWRlbnRpdHlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2ludGVyZmFjZXNcIjtcbmV4cG9ydCAqIGZyb20gXCIuL21vZGVsXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9wZXJzaXN0ZW5jZVwiO1xuZXhwb3J0ICogZnJvbSBcIi4vcXVlcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3JlcG9zaXRvcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3ZhbGlkYXRvcnNcIjtcblxuSW5qZWN0YWJsZXMuc2V0UmVnaXN0cnkobmV3IEluamVjdGFibGVzUmVnaXN0cnkoKSk7XG5cbi8qKlxuICogQHN1bW1hcnkgc3RvcmVzIHRoZSBjdXJyZW50IHBhY2thZ2UgdmVyc2lvblxuICogQGRlc2NyaXB0aW9uIHRoaXMgaXMgaG93IHlvdSBzaG91bGQgZG9jdW1lbnQgYSBjb25zdGFudFxuICogQGNvbnN0IFZFUlNJT05cbiAqIEBtZW1iZXJPZiBtb2R1bGU6dHMtd29ya3NwYWNlXG4gKi9cbmV4cG9ydCBjb25zdCBWRVJTSU9OID0gXCIjI1ZFUlNJT04jI1wiO1xuIl19
+exports.VERSION = "0.5.1";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOzs7Ozs7R0FNRzs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFFSCx1REFBbUQ7QUFDbkQsMkVBQThEO0FBRTlELGtGQUFrRjtBQUNsRixtQ0FBVyxDQUFDLFdBQVcsQ0FBQyxJQUFJLGdDQUFtQixFQUFFLENBQUMsQ0FBQztBQUVuRCx1REFBMkI7QUFDM0IseURBQTZCO0FBQzdCLG9EQUF3QjtBQUN4QixvREFBd0I7QUFDeEIseURBQTZCO0FBQzdCLG9EQUF3QjtBQUN4Qix5QkFBeUI7QUFDekIsMERBQThCO0FBRTlCOzs7OztHQUtHO0FBQ1UsUUFBQSxPQUFPLEdBQUcsYUFBYSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAbW9kdWxlIGNvcmVcbiAqIEBkZXNjcmlwdGlvbiBDb3JlIG1vZHVsZSBmb3IgdGhlIERlY2FmIFR5cGVTY3JpcHQgZnJhbWV3b3JrXG4gKiBAc3VtbWFyeSBUaGlzIG1vZHVsZSBwcm92aWRlcyB0aGUgZm91bmRhdGlvbmFsIGNvbXBvbmVudHMgb2YgdGhlIERlY2FmIGZyYW1ld29yaywgaW5jbHVkaW5nIGlkZW50aXR5IG1hbmFnZW1lbnQsIFxuICogbW9kZWwgZGVmaW5pdGlvbnMsIHJlcG9zaXRvcnkgcGF0dGVybnMsIHBlcnNpc3RlbmNlIGxheWVyLCBxdWVyeSBidWlsZGluZywgYW5kIHV0aWxpdHkgZnVuY3Rpb25zLlxuICogSXQgZXhwb3J0cyBmdW5jdGlvbmFsaXR5IGZyb20gdmFyaW91cyBzdWJtb2R1bGVzIGFuZCBzZXRzIHVwIHRoZSBpbmplY3RhYmxlIHJlZ2lzdHJ5IGZvciByZXBvc2l0b3J5IGRlY29yYXRvcnMuXG4gKi9cblxuaW1wb3J0IHsgSW5qZWN0YWJsZXNSZWdpc3RyeSB9IGZyb20gXCIuL3JlcG9zaXRvcnlcIjtcbmltcG9ydCB7IEluamVjdGFibGVzIH0gZnJvbSBcIkBkZWNhZi10cy9pbmplY3RhYmxlLWRlY29yYXRvcnNcIjtcblxuLy8gb3ZlcnJpZGVzIHRoZSBwcmV2aW91cyBJbmplY3RhYmxlcyByZWdpc3RyeSB0byBlbmFibGUgdGhlIEByZXBvc2l0b3J5IGRlY29yYXRvclxuSW5qZWN0YWJsZXMuc2V0UmVnaXN0cnkobmV3IEluamVjdGFibGVzUmVnaXN0cnkoKSk7XG5cbmV4cG9ydCAqIGZyb20gXCIuL2lkZW50aXR5XCI7XG5leHBvcnQgKiBmcm9tIFwiLi9pbnRlcmZhY2VzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9tb2RlbFwiO1xuZXhwb3J0ICogZnJvbSBcIi4vcXVlcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3JlcG9zaXRvcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3V0aWxzXCI7XG4vL2xlZnQgdG8gbGFzdCBvbiBwdXJwb3NlXG5leHBvcnQgKiBmcm9tIFwiLi9wZXJzaXN0ZW5jZVwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBTdG9yZXMgdGhlIGN1cnJlbnQgcGFja2FnZSB2ZXJzaW9uXG4gKiBAc3VtbWFyeSBBIGNvbnN0YW50IHJlcHJlc2VudGluZyB0aGUgdmVyc2lvbiBvZiB0aGUgY29yZSBwYWNrYWdlXG4gKiBAY29uc3QgVkVSU0lPTlxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKi9cbmV4cG9ydCBjb25zdCBWRVJTSU9OID0gXCIjI1ZFUlNJT04jI1wiO1xuIl19

package/lib/index.d.ts

@@ -1,25 +1,21 @@
 /**
- * @summary Module summary
- * @description Module description
- * @module ts-workspace
- */
-/**
- * @summary Namespace summary
- * @description Namespace description
- * @namespace Namespace
- * @memberOf module:ts-workspace
+ * @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";
-export * from "./persistence";
 export * from "./query";
 export * from "./repository";
-export * from "./validators";
+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:ts-workspace
+ * @memberOf module:core
  */
-export declare const VERSION = "0.5.0";
+export declare const VERSION = "0.5.1";

package/lib/interfaces/ErrorParser.cjs

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXJyb3JQYXJzZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9FcnJvclBhcnNlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQmFzZUVycm9yIH0gZnJvbSBcIkBkZWNhZi10cy9kYi1kZWNvcmF0b3JzXCI7XG5cbmV4cG9ydCBpbnRlcmZhY2UgRXJyb3JQYXJzZXIge1xuICBwYXJzZUVycm9yKGVycm9yOiBFcnJvcik6IEJhc2VFcnJvcjtcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXJyb3JQYXJzZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9FcnJvclBhcnNlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQmFzZUVycm9yIH0gZnJvbSBcIkBkZWNhZi10cy9kYi1kZWNvcmF0b3JzXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEludGVyZmFjZSBmb3IgcGFyc2luZyBlcnJvcnNcbiAqIEBzdW1tYXJ5IERlZmluZXMgYSBjb250cmFjdCBmb3Igb2JqZWN0cyB0aGF0IGNhbiBwYXJzZSBnZW5lcmljIEVycm9yIG9iamVjdHMgaW50byBCYXNlRXJyb3IgaW5zdGFuY2VzXG4gKiBAaW50ZXJmYWNlIEVycm9yUGFyc2VyXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBFcnJvclBhcnNlciB7XG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gUGFyc2VzIGEgZ2VuZXJpYyBFcnJvciBpbnRvIGEgQmFzZUVycm9yXG4gICAqIEBzdW1tYXJ5IENvbnZlcnRzIGEgc3RhbmRhcmQgRXJyb3Igb2JqZWN0IGludG8gYSBtb3JlIHNwZWNpZmljIEJhc2VFcnJvciB0eXBlXG4gICAqIEBwYXJhbSB7RXJyb3J9IGVycm9yIC0gVGhlIGVycm9yIHRvIGJlIHBhcnNlZFxuICAgKiBAcmV0dXJuIHtCYXNlRXJyb3J9IFRoZSBwYXJzZWQgZXJyb3IgYXMgYSBCYXNlRXJyb3IgaW5zdGFuY2VcbiAgICovXG4gIHBhcnNlRXJyb3IoZXJyb3I6IEVycm9yKTogQmFzZUVycm9yO1xufVxuIl19

package/lib/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/interfaces/Executor.cjs

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXhlY3V0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9FeGVjdXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAc3VtbWFyeSBwcm9jZXNzZXMgcXVlcnkgb2JqZWN0c1xuICpcbiAqIEB0eXBlZGVmIFYgdGhlIG91dHB1dFxuICpcbiAqIEBpbnRlcmZhY2UgRXhlY3V0b3JcbiAqXG4gKiBAY2F0ZWdvcnkgUXVlcnlcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBFeGVjdXRvciB7XG4gIC8qKlxuICAgKiBAc3VtbWFyeSBQcm9jZXNzZXMgaXRzZWxmXG4gICAqXG4gICAqIEBwYXJhbSB7YW55W119IGFyZ3NcbiAgICpcbiAgICogQG1ldGhvZFxuICAgKi9cbiAgZXhlY3V0ZTxWPiguLi5hcmdzOiBhbnkpOiBQcm9taXNlPFY+O1xufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXhlY3V0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9FeGVjdXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gSW50ZXJmYWNlIGZvciBleGVjdXRhYmxlIG9wZXJhdGlvbnNcbiAqIEBzdW1tYXJ5IERlZmluZXMgYSBjb250cmFjdCBmb3Igb2JqZWN0cyB0aGF0IGNhbiBleGVjdXRlIGFuIG9wZXJhdGlvbiBhbmQgcmV0dXJuIGEgcmVzdWx0XG4gKiBAdGVtcGxhdGUgUiAtIFRoZSB0eXBlIG9mIHJlc3VsdCByZXR1cm5lZCBieSB0aGUgZXhlY3V0ZSBtZXRob2RcbiAqIEBpbnRlcmZhY2UgRXhlY3V0b3JcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgaW50ZXJmYWNlIEV4ZWN1dG9yPFI+IHtcbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBFeGVjdXRlcyB0aGUgb3BlcmF0aW9uXG4gICAqIEBzdW1tYXJ5IFBlcmZvcm1zIHRoZSBvcGVyYXRpb24gYW5kIHJldHVybnMgYSBwcm9taXNlIHRoYXQgcmVzb2x2ZXMgdG8gdGhlIHJlc3VsdFxuICAgKiBAdGVtcGxhdGUgUiAtIFRoZSB0eXBlIG9mIHJlc3VsdCByZXR1cm5lZCBieSB0aGUgZXhlY3V0ZSBtZXRob2RcbiAgICogQHJldHVybiB7UHJvbWlzZTxSPn0gQSBwcm9taXNlIHRoYXQgcmVzb2x2ZXMgdG8gdGhlIHJlc3VsdCBvZiB0eXBlIFJcbiAgICovXG4gIGV4ZWN1dGUoKTogUHJvbWlzZTxSPjtcbn1cbiJdfQ==

package/lib/interfaces/Executor.d.ts

@@ -1,19 +1,16 @@
 /**
- * @summary processes query objects
- *
- * @typedef V the output
- *
+ * @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
- *
- * @category Query
+ * @memberOf module:core
  */
-export interface Executor {
+export interface Executor<R> {
     /**
-     * @summary Processes itself
-     *
-     * @param {any[]} args
-     *
-     * @method
+     * @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<V>(...args: any): Promise<V>;
+    execute(): Promise<R>;
 }

package/lib/interfaces/Observable.cjs

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT2JzZXJ2YWJsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pbnRlcmZhY2VzL09ic2VydmFibGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IE9ic2VydmVyIH0gZnJvbSBcIi4vT2JzZXJ2ZXJcIjtcblxuLyoqXG4gKiBAc3VtbWFyeSBPYnNlcnZhYmxlIEFwaVxuICogQGRlc2NyaXB0aW9uIG1hbmFnZSBhbmQgdXBkYXRlIHtAbGluayBPYnNlcnZlcn1zXG4gKlxuICogQGludGVyZmFjZSBPYnNlcnZhYmxlXG4gKlxuICogQGNhdGVnb3J5IE9ic2VydmFibGVzXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgT2JzZXJ2YWJsZSB7XG4gIC8qKlxuICAgKiBAc3VtbWFyeSBSZWdpc3RlciBuZXcge0BsaW5rIE9ic2VydmVyfXNcbiAgICogQHBhcmFtIHtPYnNlcnZlcn0gb2JzZXJ2ZXJcbiAgICpcbiAgICogQG1ldGhvZFxuICAgKi9cbiAgb2JzZXJ2ZShvYnNlcnZlcjogT2JzZXJ2ZXIpOiB2b2lkO1xuICAvKipcbiAgICogQHN1bW1hcnkgVW5yZWdpc3RlciBuZXcge0BsaW5rIE9ic2VydmVyfXNcbiAgICogQHBhcmFtIHtPYnNlcnZlcn0gb2JzZXJ2ZXJcbiAgICpcbiAgICogQG1ldGhvZFxuICAgKi9cbiAgdW5PYnNlcnZlKG9ic2VydmVyOiBPYnNlcnZlcik6IHZvaWQ7XG4gIC8qKlxuICAgKiBAc3VtbWFyeSBoYXZlIHJlZ2lzdGVyZWQge0BsaW5rIE9ic2VydmVyfXMgdXBkYXRlIHRoZW1zZWx2ZXNcbiAgICogQHBhcmFtIHthbnlbXX0gYXJnc1xuICAgKiBAbWV0aG9kXG4gICAqL1xuICB1cGRhdGVPYnNlcnZlcnMoLi4uYXJnczogYW55W10pOiBQcm9taXNlPHZvaWQ+O1xufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT2JzZXJ2YWJsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pbnRlcmZhY2VzL09ic2VydmFibGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IE9ic2VydmVyIH0gZnJvbSBcIi4vT2JzZXJ2ZXJcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gSW50ZXJmYWNlIGZvciBvYmplY3RzIHRoYXQgY2FuIGJlIG9ic2VydmVkXG4gKiBAc3VtbWFyeSBEZWZpbmVzIGEgY29udHJhY3QgZm9yIG9iamVjdHMgdGhhdCBpbXBsZW1lbnQgdGhlIE9ic2VydmVyIHBhdHRlcm4sIGFsbG93aW5nIHRoZW0gdG8gcmVnaXN0ZXIgb2JzZXJ2ZXJzLFxuICogcmVtb3ZlIG9ic2VydmVycywgYW5kIG5vdGlmeSBhbGwgcmVnaXN0ZXJlZCBvYnNlcnZlcnMgb2Ygc3RhdGUgY2hhbmdlc1xuICogQGludGVyZmFjZSBPYnNlcnZhYmxlXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBPYnNlcnZhYmxlIHtcbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBSZWdpc3RlcnMgYW4gb2JzZXJ2ZXIgdG8gcmVjZWl2ZSBub3RpZmljYXRpb25zXG4gICAqIEBzdW1tYXJ5IEFkZHMgYW4gb2JzZXJ2ZXIgdG8gdGhlIGxpc3Qgb2Ygb2JzZXJ2ZXJzIHRoYXQgd2lsbCBiZSBub3RpZmllZCBvZiBzdGF0ZSBjaGFuZ2VzXG4gICAqIEBwYXJhbSB7T2JzZXJ2ZXJ9IG9ic2VydmVyIC0gVGhlIG9ic2VydmVyIHRvIHJlZ2lzdGVyXG4gICAqIEBwYXJhbSB7Li4uYW55W119IGFyZ3MgLSBBZGRpdGlvbmFsIGFyZ3VtZW50cyB0byBwYXNzIHRvIHRoZSBvYnNlcnZlclxuICAgKiBAcmV0dXJuIHt2b2lkfVxuICAgKi9cbiAgb2JzZXJ2ZShvYnNlcnZlcjogT2JzZXJ2ZXIsIC4uLmFyZ3M6IGFueVtdKTogdm9pZDtcblxuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIFVucmVnaXN0ZXJzIGFuIG9ic2VydmVyIGZyb20gcmVjZWl2aW5nIG5vdGlmaWNhdGlvbnNcbiAgICogQHN1bW1hcnkgUmVtb3ZlcyBhbiBvYnNlcnZlciBmcm9tIHRoZSBsaXN0IG9mIG9ic2VydmVycyB0aGF0IHdpbGwgYmUgbm90aWZpZWQgb2Ygc3RhdGUgY2hhbmdlc1xuICAgKiBAcGFyYW0ge09ic2VydmVyfSBvYnNlcnZlciAtIFRoZSBvYnNlcnZlciB0byB1bnJlZ2lzdGVyXG4gICAqIEBwYXJhbSB7Li4uYW55W119IGFyZ3MgLSBBZGRpdGlvbmFsIGFyZ3VtZW50cyB0byBoZWxwIGlkZW50aWZ5IHRoZSBvYnNlcnZlclxuICAgKiBAcmV0dXJuIHt2b2lkfVxuICAgKi9cbiAgdW5PYnNlcnZlKG9ic2VydmVyOiBPYnNlcnZlciwgLi4uYXJnczogYW55W10pOiB2b2lkO1xuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gTm90aWZpZXMgYWxsIHJlZ2lzdGVyZWQgb2JzZXJ2ZXJzIG9mIGEgc3RhdGUgY2hhbmdlXG4gICAqIEBzdW1tYXJ5IENhbGxzIHRoZSB1cGRhdGUgbWV0aG9kIG9uIGFsbCByZWdpc3RlcmVkIG9ic2VydmVycywgcGFzc2luZyBhbnkgcHJvdmlkZWQgYXJndW1lbnRzXG4gICAqIEBwYXJhbSB7Li4uYW55W119IGFyZ3MgLSBBcmd1bWVudHMgdG8gcGFzcyB0byB0aGUgb2JzZXJ2ZXJzJyB1cGRhdGUgbWV0aG9kc1xuICAgKiBAcmV0dXJuIHtQcm9taXNlPHZvaWQ+fSBBIHByb21pc2UgdGhhdCByZXNvbHZlcyB3aGVuIGFsbCBvYnNlcnZlcnMgaGF2ZSBiZWVuIHVwZGF0ZWRcbiAgICovXG4gIHVwZGF0ZU9ic2VydmVycyguLi5hcmdzOiBhbnlbXSk6IFByb21pc2U8dm9pZD47XG59XG4iXX0=

package/lib/interfaces/Observable.d.ts

@@ -1,31 +1,33 @@
 import { Observer } from "./Observer";
 /**
- * @summary Observable Api
- * @description manage and update {@link Observer}s
- *
+ * @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
- *
- * @category Observables
+ * @memberOf module:core
  */
 export interface Observable {
     /**
-     * @summary Register new {@link Observer}s
-     * @param {Observer} observer
-     *
-     * @method
+     * @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): void;
+    observe(observer: Observer, ...args: any[]): void;
     /**
-     * @summary Unregister new {@link Observer}s
-     * @param {Observer} observer
-     *
-     * @method
+     * @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): void;
+    unObserve(observer: Observer, ...args: any[]): void;
     /**
-     * @summary have registered {@link Observer}s update themselves
-     * @param {any[]} args
-     * @method
+     * @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/interfaces/Observer.cjs

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT2JzZXJ2ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9PYnNlcnZlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAc3VtbWFyeSBPYnNlcnZlciBBcGlcbiAqIEBkZXNjcmlwdGlvbiB3aWxsIGJlIGNhbGxlZCBieSB0aGUge0BsaW5rIE9ic2VydmFibGV9XG4gKlxuICogQGludGVyZmFjZSBPYnNlcnZlclxuICpcbiAqIEBjYXRlZ29yeSBPYnNlcnZhYmxlc1xuICovXG5leHBvcnQgaW50ZXJmYWNlIE9ic2VydmVyIHtcbiAgLyoqXG4gICAqIEBzdW1tYXJ5IFJlZnJlc2hlcyB0aGUgT2JzZXJ2ZXJcbiAgICogQHBhcmFtIHthbnlbXX0gYXJnc1xuICAgKiBAbWV0aG9kXG4gICAqL1xuICByZWZyZXNoKC4uLmFyZ3M6IGFueVtdKTogUHJvbWlzZTx2b2lkPjtcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT2JzZXJ2ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9PYnNlcnZlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gSW50ZXJmYWNlIGZvciBvYmplY3RzIHRoYXQgb2JzZXJ2ZSBzdGF0ZSBjaGFuZ2VzXG4gKiBAc3VtbWFyeSBEZWZpbmVzIGEgY29udHJhY3QgZm9yIG9iamVjdHMgdGhhdCBpbXBsZW1lbnQgdGhlIE9ic2VydmVyIHBhdHRlcm4sIGFsbG93aW5nIHRoZW0gdG8gYmUgbm90aWZpZWQgb2YgY2hhbmdlcyBpbiBPYnNlcnZhYmxlIG9iamVjdHNcbiAqIEBpbnRlcmZhY2UgT2JzZXJ2ZXJcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgaW50ZXJmYWNlIE9ic2VydmVyIHtcbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBVcGRhdGVzIHRoZSBvYnNlcnZlciB3aXRoIG5ldyBzdGF0ZSBpbmZvcm1hdGlvblxuICAgKiBAc3VtbWFyeSBDYWxsZWQgYnkgYW4gT2JzZXJ2YWJsZSB3aGVuIGl0cyBzdGF0ZSBjaGFuZ2VzLCBhbGxvd2luZyB0aGUgT2JzZXJ2ZXIgdG8gcmVhY3QgdG8gdGhvc2UgY2hhbmdlc1xuICAgKiBAcGFyYW0gey4uLmFueVtdfSBhcmdzIC0gQXJndW1lbnRzIGNvbnRhaW5pbmcgc3RhdGUgaW5mb3JtYXRpb24gZnJvbSB0aGUgT2JzZXJ2YWJsZVxuICAgKiBAcmV0dXJuIHtQcm9taXNlPHZvaWQ+fSBBIHByb21pc2UgdGhhdCByZXNvbHZlcyB3aGVuIHRoZSBvYnNlcnZlciBoYXMgcHJvY2Vzc2VkIHRoZSB1cGRhdGVcbiAgICovXG4gIHJlZnJlc2goLi4uYXJnczogYW55W10pOiBQcm9taXNlPHZvaWQ+O1xufVxuIl19

package/lib/interfaces/Observer.d.ts

@@ -1,16 +1,15 @@
 /**
- * @summary Observer Api
- * @description will be called by the {@link Observable}
- *
+ * @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
- *
- * @category Observables
+ * @memberOf module:core
  */
 export interface Observer {
     /**
-     * @summary Refreshes the Observer
-     * @param {any[]} args
-     * @method
+     * @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/interfaces/Paginatable.cjs

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUGFnaW5hdGFibGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9QYWdpbmF0YWJsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgUGFnaW5hdG9yIH0gZnJvbSBcIi4uL3F1ZXJ5L1BhZ2luYXRvclwiO1xuXG5leHBvcnQgaW50ZXJmYWNlIFBhZ2luYXRhYmxlIHtcbiAgcGFnaW5hdGU8Vj4oLi4uYXJnczogYW55W10pOiBQcm9taXNlPFBhZ2luYXRvcjxWLCBhbnk+Pjtcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUGFnaW5hdGFibGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9QYWdpbmF0YWJsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgUGFnaW5hdG9yIH0gZnJvbSBcIi4uL3F1ZXJ5L1BhZ2luYXRvclwiO1xuaW1wb3J0IHsgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEludGVyZmFjZSBmb3Igb2JqZWN0cyB0aGF0IHN1cHBvcnQgcGFnaW5hdGlvblxuICogQHN1bW1hcnkgRGVmaW5lcyBhIGNvbnRyYWN0IGZvciBvYmplY3RzIHRoYXQgY2FuIHBhZ2luYXRlIHRoZWlyIHJlc3VsdHMsIGFsbG93aW5nIGZvciBlZmZpY2llbnQgZGF0YSByZXRyaWV2YWwgaW4gY2h1bmtzXG4gKiBAdGVtcGxhdGUgTSAtIFRoZSBtb2RlbCB0eXBlLCBtdXN0IGV4dGVuZCBNb2RlbFxuICogQHRlbXBsYXRlIFIgLSBUaGUgcmVzdWx0IHR5cGUgcmV0dXJuZWQgYnkgdGhlIHBhZ2luYXRvclxuICogQHRlbXBsYXRlIFEgLSBUaGUgcXVlcnkgdHlwZSB1c2VkIGZvciBwYWdpbmF0aW9uXG4gKiBAaW50ZXJmYWNlIFBhZ2luYXRhYmxlXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBQYWdpbmF0YWJsZTxNIGV4dGVuZHMgTW9kZWwsIFIsIFE+IHtcbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBDcmVhdGVzIGEgcGFnaW5hdG9yIHdpdGggdGhlIHNwZWNpZmllZCBwYWdlIHNpemVcbiAgICogQHN1bW1hcnkgSW5pdGlhbGl6ZXMgYSBwYWdpbmF0b3IgdGhhdCBjYW4gYmUgdXNlZCB0byByZXRyaWV2ZSBkYXRhIGluIHBhZ2VzIG9mIHRoZSBzcGVjaWZpZWQgc2l6ZVxuICAgKiBAcGFyYW0ge251bWJlcn0gc2l6ZSAtIFRoZSBudW1iZXIgb2YgaXRlbXMgcGVyIHBhZ2VcbiAgICogQHJldHVybiB7UHJvbWlzZTxQYWdpbmF0b3I+fSBBIHByb21pc2UgdGhhdCByZXNvbHZlcyB0byBhIHBhZ2luYXRvciBmb3IgdGhlIHNwZWNpZmllZCBtb2RlbCwgcmVzdWx0LCBhbmQgcXVlcnkgdHlwZXNcbiAgICovXG4gIHBhZ2luYXRlKHNpemU6IG51bWJlcik6IFByb21pc2U8UGFnaW5hdG9yPE0sIFIsIFE+Pjtcbn1cbiJdfQ==

package/lib/interfaces/Paginatable.d.ts

@@ -1,4 +1,20 @@
 import { Paginator } from "../query/Paginator";
-export interface Paginatable {
-    paginate<V>(...args: any[]): Promise<Paginator<V, any>>;
+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/interfaces/Queriable.cjs

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUXVlcmlhYmxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2ludGVyZmFjZXMvUXVlcmlhYmxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25kaXRpb24sIFNlbGVjdFNlbGVjdG9yLCBXaGVyZU9wdGlvbiB9IGZyb20gXCIuLi9xdWVyeVwiO1xuaW1wb3J0IHsgT3JkZXJEaXJlY3Rpb24gfSBmcm9tIFwiLi4vcmVwb3NpdG9yeVwiO1xuXG5leHBvcnQgaW50ZXJmYWNlIFF1ZXJpYWJsZSB7XG4gIHNlbGVjdChzZWxlY3Rvcj86IFNlbGVjdFNlbGVjdG9yKTogV2hlcmVPcHRpb247XG5cbiAgcXVlcnk8Vj4oXG4gICAgY29uZGl0aW9uOiBDb25kaXRpb24sXG4gICAgb3JkZXJCeTogc3RyaW5nLFxuICAgIG9yZGVyOiBPcmRlckRpcmVjdGlvbixcbiAgICBsaW1pdD86IG51bWJlcixcbiAgICBza2lwPzogbnVtYmVyLFxuICApOiBQcm9taXNlPFY+O1xufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUXVlcmlhYmxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2ludGVyZmFjZXMvUXVlcmlhYmxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25kaXRpb24sIFNlbGVjdFNlbGVjdG9yLCBXaGVyZU9wdGlvbiB9IGZyb20gXCIuLi9xdWVyeVwiO1xuaW1wb3J0IHsgT3JkZXJEaXJlY3Rpb24gfSBmcm9tIFwiLi4vcmVwb3NpdG9yeVwiO1xuaW1wb3J0IHsgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEludGVyZmFjZSBmb3Igb2JqZWN0cyB0aGF0IHN1cHBvcnQgcXVlcnlpbmdcbiAqIEBzdW1tYXJ5IERlZmluZXMgYSBjb250cmFjdCBmb3Igb2JqZWN0cyB0aGF0IGNhbiBiZSBxdWVyaWVkIHdpdGggdmFyaW91cyBjb25kaXRpb25zLCBzZWxlY3Rpb25zLCBhbmQgb3JkZXJpbmdcbiAqIEB0ZW1wbGF0ZSBNIC0gVGhlIG1vZGVsIHR5cGUsIG11c3QgZXh0ZW5kIE1vZGVsXG4gKiBAaW50ZXJmYWNlIFF1ZXJpYWJsZVxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgUXVlcmlhYmxlPE0gZXh0ZW5kcyBNb2RlbD4ge1xuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIFNlbGVjdHMgYWxsIHByb3BlcnRpZXMgZnJvbSB0aGUgbW9kZWxcbiAgICogQHN1bW1hcnkgQ3JlYXRlcyBhIHF1ZXJ5IHRoYXQgd2lsbCByZXR1cm4gYWxsIHByb3BlcnRpZXMgb2YgdGhlIG1vZGVsXG4gICAqIEB0ZW1wbGF0ZSBTIC0gVGhlIHNlbGVjdG9yIHR5cGUgZXh0ZW5kaW5nIGFuIGFycmF5IG9mIFNlbGVjdFNlbGVjdG9yPE0+XG4gICAqIEByZXR1cm4ge1doZXJlT3B0aW9ufSBBIFdoZXJlT3B0aW9uIG9iamVjdCBmb3IgZnVydGhlciBxdWVyeSBjb25maWd1cmF0aW9uXG4gICAqL1xuICBzZWxlY3Q8XG4gICAgLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uby11bnVzZWQtdmFyc1xuICAgIFMgZXh0ZW5kcyByZWFkb25seSBTZWxlY3RTZWxlY3RvcjxNPltdLFxuICA+KCk6IFdoZXJlT3B0aW9uPE0sIE1bXT47XG5cbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBTZWxlY3RzIHNwZWNpZmljIHByb3BlcnRpZXMgZnJvbSB0aGUgbW9kZWxcbiAgICogQHN1bW1hcnkgQ3JlYXRlcyBhIHF1ZXJ5IHRoYXQgd2lsbCByZXR1cm4gb25seSB0aGUgc3BlY2lmaWVkIHByb3BlcnRpZXMgb2YgdGhlIG1vZGVsXG4gICAqIEB0ZW1wbGF0ZSBTIC0gVGhlIHNlbGVjdG9yIHR5cGUgZXh0ZW5kaW5nIGFuIGFycmF5IG9mIFNlbGVjdFNlbGVjdG9yPE0+XG4gICAqIEBwYXJhbSBzZWxlY3RvciAtIEFycmF5IG9mIHByb3BlcnR5IG5hbWVzIHRvIHNlbGVjdFxuICAgKiBAcmV0dXJuIEEgV2hlcmVPcHRpb24gb2JqZWN0IGZvciBmdXJ0aGVyIHF1ZXJ5IGNvbmZpZ3VyYXRpb25cbiAgICovXG4gIHNlbGVjdDxTIGV4dGVuZHMgcmVhZG9ubHkgU2VsZWN0U2VsZWN0b3I8TT5bXT4oXG4gICAgc2VsZWN0b3I6IHJlYWRvbmx5IFsuLi5TXVxuICApOiBXaGVyZU9wdGlvbjxNLCBQaWNrPE0sIFNbbnVtYmVyXT5bXT47XG5cbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBTZWxlY3RzIHByb3BlcnRpZXMgZnJvbSB0aGUgbW9kZWxcbiAgICogQHN1bW1hcnkgQ3JlYXRlcyBhIHF1ZXJ5IHRoYXQgd2lsbCByZXR1cm4gZWl0aGVyIGFsbCBwcm9wZXJ0aWVzIG9yIG9ubHkgdGhlIHNwZWNpZmllZCBwcm9wZXJ0aWVzIG9mIHRoZSBtb2RlbFxuICAgKiBAdGVtcGxhdGUgUyAtIFRoZSBzZWxlY3RvciB0eXBlIGV4dGVuZGluZyBhbiBhcnJheSBvZiBTZWxlY3RTZWxlY3RvcjxNPlxuICAgKiBAcGFyYW0gW3NlbGVjdG9yXSAtIE9wdGlvbmFsIGFycmF5IG9mIHByb3BlcnR5IG5hbWVzIHRvIHNlbGVjdFxuICAgKiBAcmV0dXJuIEEgV2hlcmVPcHRpb24gb2JqZWN0IGZvciBmdXJ0aGVyIHF1ZXJ5IGNvbmZpZ3VyYXRpb25cbiAgICovXG4gIHNlbGVjdDxTIGV4dGVuZHMgcmVhZG9ubHkgU2VsZWN0U2VsZWN0b3I8TT5bXT4oXG4gICAgc2VsZWN0b3I/OiByZWFkb25seSBbLi4uU11cbiAgKTogV2hlcmVPcHRpb248TSwgTVtdPiB8IFdoZXJlT3B0aW9uPE0sIFBpY2s8TSwgU1tudW1iZXJdPltdPjtcblxuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIEV4ZWN1dGVzIGEgcXVlcnkgd2l0aCB0aGUgc3BlY2lmaWVkIGNvbmRpdGlvbnMgYW5kIG9wdGlvbnNcbiAgICogQHN1bW1hcnkgUmV0cmlldmVzIG1vZGVsIGluc3RhbmNlcyB0aGF0IG1hdGNoIHRoZSBnaXZlbiBjb25kaXRpb24sIG9yZGVyZWQgYW5kIGxpbWl0ZWQgYXMgc3BlY2lmaWVkXG4gICAqIEB0ZW1wbGF0ZSBNIC0gVGhlIG1vZGVsIHR5cGUsIG11c3QgZXh0ZW5kIE1vZGVsXG4gICAqIEBwYXJhbSB7Q29uZGl0aW9uPE0+fSBjb25kaXRpb24gLSBUaGUgY29uZGl0aW9uIHRvIGZpbHRlciByZXN1bHRzXG4gICAqIEBwYXJhbSB7c3RyaW5nfSBvcmRlckJ5IC0gVGhlIHByb3BlcnR5IHRvIG9yZGVyIHJlc3VsdHMgYnlcbiAgICogQHBhcmFtIHtPcmRlckRpcmVjdGlvbn0gb3JkZXIgLSBUaGUgZGlyZWN0aW9uIHRvIG9yZGVyIHJlc3VsdHMgKGFzY2VuZGluZyBvciBkZXNjZW5kaW5nKVxuICAgKiBAcGFyYW0ge251bWJlcn0gW2xpbWl0XSAtIE9wdGlvbmFsIG1heGltdW0gbnVtYmVyIG9mIHJlc3VsdHMgdG8gcmV0dXJuXG4gICAqIEBwYXJhbSB7bnVtYmVyfSBbc2tpcF0gLSBPcHRpb25hbCBudW1iZXIgb2YgcmVzdWx0cyB0byBza2lwXG4gICAqIEByZXR1cm4ge1Byb21pc2U8TVtdPn0gQSBwcm9taXNlIHRoYXQgcmVzb2x2ZXMgdG8gYW4gYXJyYXkgb2YgbW9kZWwgaW5zdGFuY2VzXG4gICAqL1xuICBxdWVyeShcbiAgICBjb25kaXRpb246IENvbmRpdGlvbjxNPixcbiAgICBvcmRlckJ5OiBrZXlvZiBNLFxuICAgIG9yZGVyOiBPcmRlckRpcmVjdGlvbixcbiAgICBsaW1pdD86IG51bWJlcixcbiAgICBza2lwPzogbnVtYmVyXG4gICk6IFByb21pc2U8TVtdPjtcbn1cbiJdfQ==