@decaf-ts/db-decorators 0.11.0 → 0.13.0

package/lib/cjs/validation/validation.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["validation.js"],"names":[],"mappings":";;AAAA,yEAA6D;AAC7D,iDAAsD;AACtD;;;;;;;GAOG;AACH,iCAAU,CAAC,SAAS,GAAG,UAAU,GAAG;IAChC,OAAO,mCAAoB,CAAC,OAAO,GAAG,GAAG,CAAC;AAC9C,CAAC,CAAC;AACF,sCAAsC"}

package/lib/cjs/validation/validators/ReadOnlyValidator.cjs

@@ -1,17 +1,22 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReadOnlyValidator = void 0;
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
+        r = Reflect.decorate(decorators, target, key, desc);
+    else
+        for (var i = decorators.length - 1; i >= 0; i--)
+            if (d = decorators[i])
+                r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function")
+        return Reflect.metadata(k, v);
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReadOnlyValidator = void 0;
 const decorator_validation_1 = require("@decaf-ts/decorator-validation");
-const constants_1 = require("./../constants.cjs");
+const constants_js_1 = require("./../constants.cjs");
 const decorator_validation_2 = require("@decaf-ts/decorator-validation");
 /**
  * @description A validator that ensures properties marked as readonly cannot be modified during updates.
@@ -41,7 +46,7 @@ const decorator_validation_2 = require("@decaf-ts/decorator-validation");
  */
 let ReadOnlyValidator = class ReadOnlyValidator extends decorator_validation_1.Validator {
     constructor() {
-        super(constants_1.DEFAULT_ERROR_MESSAGES.READONLY.INVALID);
+        super(constants_js_1.DEFAULT_ERROR_MESSAGES.READONLY.INVALID);
     }
     /**
      * @description Implementation of the base validator's hasErrors method.
@@ -72,7 +77,8 @@ let ReadOnlyValidator = class ReadOnlyValidator extends decorator_validation_1.V
 };
 exports.ReadOnlyValidator = ReadOnlyValidator;
 exports.ReadOnlyValidator = ReadOnlyValidator = __decorate([
-    (0, decorator_validation_1.validator)(constants_1.UpdateValidationKeys.READONLY),
+    (0, decorator_validation_1.validator)(constants_js_1.UpdateValidationKeys.READONLY),
     __metadata("design:paramtypes", [])
 ], ReadOnlyValidator);
+//# sourceMappingURL=ReadOnlyValidator.js.map
 //# sourceMappingURL=ReadOnlyValidator.js.map

package/lib/cjs/validation/validators/ReadOnlyValidator.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadOnlyValidator.js","sourceRoot":"","sources":["ReadOnlyValidator.js"],"names":[],"mappings":";;;AAAA,IAAI,UAAU,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,UAAU,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI;IACjF,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7H,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,UAAU;QAAE,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;;QAC1H,KAAK,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YAAE,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;gBAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;IAClJ,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAClE,CAAC,CAAC;AACF,IAAI,UAAU,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC;IACxD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,UAAU;QAAE,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC7G,CAAC,CAAC;AACF,yEAAsE;AACtE,oDAAiF;AACjF,yEAAyD;AACzD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,IAAI,iBAAiB,GAAG,MAAM,iBAAkB,SAAQ,gCAAS;IAC7D;QACI,KAAK,CAAC,qCAAsB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACnD,CAAC;IACD;;;;;;OAMG;IACH,6DAA6D;IAC7D,SAAS,CAAC,KAAK,EAAE,GAAG,IAAI;QACpB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD;;;;;;;OAOG;IACH,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO;QACpC,IAAI,KAAK,KAAK,SAAS;YACnB,OAAO;QACX,OAAO,IAAA,8BAAO,EAAC,KAAK,EAAE,QAAQ,CAAC;YAC3B,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;IACnD,CAAC;CACJ,CAAC;AAKO,8CAAiB;AAJ1B,4BAAA,iBAAiB,GAAG,UAAU,CAAC;IAC3B,IAAA,gCAAS,EAAC,mCAAoB,CAAC,QAAQ,CAAC;IACxC,UAAU,CAAC,mBAAmB,EAAE,EAAE,CAAC;CACtC,EAAE,iBAAiB,CAAC,CAAC;AAEtB,6CAA6C"}

package/lib/cjs/validation/validators/TimestampValidator.cjs

@@ -1,17 +1,22 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimestampValidator = void 0;
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
+        r = Reflect.decorate(decorators, target, key, desc);
+    else
+        for (var i = decorators.length - 1; i >= 0; i--)
+            if (d = decorators[i])
+                r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function")
+        return Reflect.metadata(k, v);
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TimestampValidator = void 0;
 const decorator_validation_1 = require("@decaf-ts/decorator-validation");
-const constants_1 = require("./../constants.cjs");
+const constants_js_1 = require("./../constants.cjs");
 /**
  * @description A validator that ensures timestamp values are only updated with newer timestamps.
  * @summary Validates the update of a timestamp by comparing the new timestamp with the old one, ensuring the new timestamp is more recent.
@@ -41,7 +46,7 @@ const constants_1 = require("./../constants.cjs");
  */
 let TimestampValidator = class TimestampValidator extends decorator_validation_1.Validator {
     constructor() {
-        super(constants_1.DEFAULT_ERROR_MESSAGES.TIMESTAMP.INVALID);
+        super(constants_js_1.DEFAULT_ERROR_MESSAGES.TIMESTAMP.INVALID);
     }
     /**
      * @description Implementation of the base validator's hasErrors method.
@@ -79,7 +84,8 @@ let TimestampValidator = class TimestampValidator extends decorator_validation_1
 };
 exports.TimestampValidator = TimestampValidator;
 exports.TimestampValidator = TimestampValidator = __decorate([
-    (0, decorator_validation_1.validator)(constants_1.UpdateValidationKeys.TIMESTAMP),
+    (0, decorator_validation_1.validator)(constants_js_1.UpdateValidationKeys.TIMESTAMP),
     __metadata("design:paramtypes", [])
 ], TimestampValidator);
+//# sourceMappingURL=TimestampValidator.js.map
 //# sourceMappingURL=TimestampValidator.js.map

package/lib/cjs/validation/validators/TimestampValidator.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimestampValidator.js","sourceRoot":"","sources":["TimestampValidator.js"],"names":[],"mappings":";;;AAAA,IAAI,UAAU,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,UAAU,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI;IACjF,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7H,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,UAAU;QAAE,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;;QAC1H,KAAK,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YAAE,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;gBAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;IAClJ,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAClE,CAAC,CAAC;AACF,IAAI,UAAU,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC;IACxD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,UAAU;QAAE,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC7G,CAAC,CAAC;AACF,yEAAsE;AACtE,oDAAiF;AACjF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,IAAI,kBAAkB,GAAG,MAAM,kBAAmB,SAAQ,gCAAS;IAC/D;QACI,KAAK,CAAC,qCAAsB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IACD;;;;;;OAMG;IACH,6DAA6D;IAC7D,SAAS,CAAC,KAAK,EAAE,GAAG,IAAI;QACpB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD;;;;;;;OAOG;IACH,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO;QACpC,IAAI,KAAK,KAAK,SAAS;YACnB,OAAO;QACX,OAAO,GAAG,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC;YACD,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;YACxB,QAAQ,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC9B,6DAA6D;QACjE,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACP,OAAO,OAAO,CAAC;QACnB,CAAC;QACD,OAAO,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACnD,CAAC;CACJ,CAAC;AAKO,gDAAkB;AAJ3B,6BAAA,kBAAkB,GAAG,UAAU,CAAC;IAC5B,IAAA,gCAAS,EAAC,mCAAoB,CAAC,SAAS,CAAC;IACzC,UAAU,CAAC,mBAAmB,EAAE,EAAE,CAAC;CACtC,EAAE,kBAAkB,CAAC,CAAC;AAEvB,8CAA8C"}

package/lib/cjs/validation/validators/UpdateValidator.cjs

@@ -35,4 +35,5 @@ class UpdateValidator extends decorator_validation_1.Validator {
     }
 }
 exports.UpdateValidator = UpdateValidator;
+//# sourceMappingURL=UpdateValidator.js.map
 //# sourceMappingURL=UpdateValidator.js.map

package/lib/cjs/validation/validators/UpdateValidator.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"UpdateValidator.js","sourceRoot":"","sources":["UpdateValidator.js"],"names":[],"mappings":";;;AAAA,yEAAyG;AACzG;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,eAAgB,SAAQ,gCAAS;IAC1C,YAAY,OAAO,GAAG,6CAAiB,CAAC,OAAO,EAAE,GAAG,aAAa;QAC7D,KAAK,CAAC,OAAO,EAAE,GAAG,aAAa,CAAC,CAAC;IACrC,CAAC;CACJ;AAJD,0CAIC;AACD,2CAA2C"}

package/lib/cjs/validation/validators/index.cjs

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ReadOnlyValidator.cjs"), exports);
 __exportStar(require("./TimestampValidator.cjs"), exports);
 __exportStar(require("./UpdateValidator.cjs"), exports);
+//# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/lib/cjs/validation/validators/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,0DAAwC;AACxC,uDAAqC;AACrC,iCAAiC"}

package/lib/esm/index.js

@@ -17,7 +17,7 @@ export * from "./validation/index.js";
  * @const VERSION
  * @memberOf module:db-decorators
  */
-export const VERSION = "0.10.0";
+export const VERSION = "0.12.0";
 export const PACKAGE_NAME = "@decaf-ts/db-decorators";
 Metadata.registerLibrary(PACKAGE_NAME, VERSION);
 //# sourceMappingURL=index.js.map

package/lib/types/identity/decorators.d.cts

@@ -0,0 +1,8 @@
+/**
+ * @description Decorator that marks a property as an ID field
+ * @summary Creates a composite decorator that marks a property as required, readonly, and as the ID field for database operations
+ * @return {PropertyDecorator} A decorator that can be applied to class properties
+ * @function id
+ * @category Property Decorators
+ */
+export declare function id(): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor | number) => void;

package/lib/types/identity/decorators.d.mts

@@ -0,0 +1,8 @@
+/**
+ * @description Decorator that marks a property as an ID field
+ * @summary Creates a composite decorator that marks a property as required, readonly, and as the ID field for database operations
+ * @return {PropertyDecorator} A decorator that can be applied to class properties
+ * @function id
+ * @category Property Decorators
+ */
+export declare function id(): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor | number) => void;

package/lib/types/identity/index.d.cts

@@ -0,0 +1,6 @@
+/**
+ * @description Exports for the identity module.
+ * @summary This file exports all the necessary components for the identity functionality, including decorators.
+ * @module db-decorators/identity
+ */
+export * from "./decorators.cjs";

package/lib/types/identity/index.d.mts

@@ -0,0 +1,6 @@
+/**
+ * @description Exports for the identity module.
+ * @summary This file exports all the necessary components for the identity functionality, including decorators.
+ * @module db-decorators/identity
+ */
+export * from "./decorators.js";

package/lib/types/index.d.cts

@@ -0,0 +1,15 @@
+export * from "./identity/index.cjs";
+export * from "./interfaces/index.cjs";
+export * from "./model/index.cjs";
+export * from "./operations/index.cjs";
+export * from "./overrides/index.cjs";
+export * from "./repository/index.cjs";
+export * from "./validation/index.cjs";
+/**
+ * @description Current version of the reflection package
+ * @summary Stores the semantic version number of the package
+ * @const VERSION
+ * @memberOf module:db-decorators
+ */
+export declare const VERSION = "0.12.0";
+export declare const PACKAGE_NAME = "@decaf-ts/db-decorators";

package/lib/types/index.d.mts

@@ -0,0 +1,15 @@
+export * from "./identity/index.js";
+export * from "./interfaces/index.js";
+export * from "./model/index.js";
+export * from "./operations/index.js";
+export * from "./overrides/index.js";
+export * from "./repository/index.js";
+export * from "./validation/index.js";
+/**
+ * @description Current version of the reflection package
+ * @summary Stores the semantic version number of the package
+ * @const VERSION
+ * @memberOf module:db-decorators
+ */
+export declare const VERSION = "0.12.0";
+export declare const PACKAGE_NAME = "@decaf-ts/db-decorators";

package/lib/types/index.d.ts

@@ -11,5 +11,5 @@ export * from "./validation";
  * @const VERSION
  * @memberOf module:db-decorators
  */
-export declare const VERSION = "0.10.0";
+export declare const VERSION = "0.12.0";
 export declare const PACKAGE_NAME = "@decaf-ts/db-decorators";

package/lib/types/interfaces/BulkCrudOperator.d.cts

@@ -0,0 +1,47 @@
+import { CrudOperator } from "./CrudOperator.cjs";
+import { PrimaryKeyType } from "../repository/index.cjs";
+/**
+ * @description Interface for bulk CRUD operations
+ * @summary Extends the basic CRUD operations to support bulk operations on multiple models at once
+ * @template M - The model type
+ * @interface BulkCrudOperator
+ * @memberOf module:db-decorators
+ */
+export interface BulkCrudOperator<M> extends CrudOperator<M> {
+    /**
+     * @description Creates multiple model instances in the database
+     * @summary Bulk operation to create multiple models at once
+     * @template M - The model type
+     * @param {M[]} models - Array of model instances to create
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M[]>} Promise resolving to the created model instances
+     */
+    createAll(models: M[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Retrieves multiple model instances from the database by their keys
+     * @summary Bulk operation to read multiple models at once
+     * @template M - The model type
+     * @param {(PrimaryKeyType[])} keys - Array of primary keys to retrieve
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M[]>} Promise resolving to the retrieved model instances
+     */
+    readAll(keys: PrimaryKeyType[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Updates multiple model instances in the database
+     * @summary Bulk operation to update multiple models at once
+     * @template M - The model type
+     * @param {M[]} models - Array of model instances to update
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M[]>} Promise resolving to the updated model instances
+     */
+    updateAll(models: M[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Deletes multiple model instances from the database by their keys
+     * @summary Bulk operation to delete multiple models at once
+     * @template M - The model type
+     * @param {(PrimaryKeyType[])} keys - Array of primary keys to delete
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M[]>} Promise resolving to the deleted model instances
+     */
+    deleteAll(keys: PrimaryKeyType[], ...args: any[]): Promise<M[]>;
+}

package/lib/types/interfaces/BulkCrudOperator.d.mts

@@ -0,0 +1,47 @@
+import { CrudOperator } from "./CrudOperator.js";
+import { PrimaryKeyType } from "../repository/index.js";
+/**
+ * @description Interface for bulk CRUD operations
+ * @summary Extends the basic CRUD operations to support bulk operations on multiple models at once
+ * @template M - The model type
+ * @interface BulkCrudOperator
+ * @memberOf module:db-decorators
+ */
+export interface BulkCrudOperator<M> extends CrudOperator<M> {
+    /**
+     * @description Creates multiple model instances in the database
+     * @summary Bulk operation to create multiple models at once
+     * @template M - The model type
+     * @param {M[]} models - Array of model instances to create
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M[]>} Promise resolving to the created model instances
+     */
+    createAll(models: M[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Retrieves multiple model instances from the database by their keys
+     * @summary Bulk operation to read multiple models at once
+     * @template M - The model type
+     * @param {(PrimaryKeyType[])} keys - Array of primary keys to retrieve
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M[]>} Promise resolving to the retrieved model instances
+     */
+    readAll(keys: PrimaryKeyType[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Updates multiple model instances in the database
+     * @summary Bulk operation to update multiple models at once
+     * @template M - The model type
+     * @param {M[]} models - Array of model instances to update
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M[]>} Promise resolving to the updated model instances
+     */
+    updateAll(models: M[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Deletes multiple model instances from the database by their keys
+     * @summary Bulk operation to delete multiple models at once
+     * @template M - The model type
+     * @param {(PrimaryKeyType[])} keys - Array of primary keys to delete
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M[]>} Promise resolving to the deleted model instances
+     */
+    deleteAll(keys: PrimaryKeyType[], ...args: any[]): Promise<M[]>;
+}

package/lib/types/interfaces/Contextual.d.cts

@@ -0,0 +1,23 @@
+import { OperationKeys } from "../operations/index.cjs";
+import { Context } from "../repository/index.cjs";
+export type FlagsOf<C extends Context<any>> = C extends Context<infer T> ? T : never;
+/**
+ * @description Interface for context-aware operations
+ * @summary Provides context management for database operations
+ * @template F - Type extending RepositoryFlags, defaults to RepositoryFlags
+ * @template C - Type extending Context<F>, defaults to Context<F>
+ * @interface Contextual
+ * @memberOf module:db-decorators
+ */
+export interface Contextual<C extends Context<any> = Context<any>> {
+    /**
+     * @description Creates a context for a specific operation
+     * @summary Generates an operation-specific context with custom flags
+     * @param {(OperationKeys.CREATE|OperationKeys.READ|OperationKeys.UPDATE|OperationKeys.DELETE)} operation - The operation type
+     * @template F - Type extending RepositoryFlags, defaults to RepositoryFlags
+     * @param {Partial<F>} overrides - Custom flag overrides for this context
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<C>} Promise resolving to the created context
+     */
+    context(operation: ((...args: any[]) => any) | OperationKeys.CREATE | OperationKeys.READ | OperationKeys.UPDATE | OperationKeys.DELETE | string, overrides: Partial<FlagsOf<C>>, ...args: any[]): Promise<C>;
+}

package/lib/types/interfaces/Contextual.d.mts

@@ -0,0 +1,23 @@
+import { OperationKeys } from "../operations/index.js";
+import { Context } from "../repository/index.js";
+export type FlagsOf<C extends Context<any>> = C extends Context<infer T> ? T : never;
+/**
+ * @description Interface for context-aware operations
+ * @summary Provides context management for database operations
+ * @template F - Type extending RepositoryFlags, defaults to RepositoryFlags
+ * @template C - Type extending Context<F>, defaults to Context<F>
+ * @interface Contextual
+ * @memberOf module:db-decorators
+ */
+export interface Contextual<C extends Context<any> = Context<any>> {
+    /**
+     * @description Creates a context for a specific operation
+     * @summary Generates an operation-specific context with custom flags
+     * @param {(OperationKeys.CREATE|OperationKeys.READ|OperationKeys.UPDATE|OperationKeys.DELETE)} operation - The operation type
+     * @template F - Type extending RepositoryFlags, defaults to RepositoryFlags
+     * @param {Partial<F>} overrides - Custom flag overrides for this context
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<C>} Promise resolving to the created context
+     */
+    context(operation: ((...args: any[]) => any) | OperationKeys.CREATE | OperationKeys.READ | OperationKeys.UPDATE | OperationKeys.DELETE | string, overrides: Partial<FlagsOf<C>>, ...args: any[]): Promise<C>;
+}

package/lib/types/interfaces/CrudOperator.d.cts

@@ -0,0 +1,46 @@
+import { PrimaryKeyType } from "../repository/index.cjs";
+/**
+ * @description Basic CRUD operations interface
+ * @summary Exposes a standard Create, Read, Update, Delete API for database operations
+ * @template M - The model type
+ * @interface CrudOperator
+ * @memberOf module:db-decorators
+ */
+export interface CrudOperator<M> {
+    /**
+     * @description Creates a new model instance in the database
+     * @summary Create a new model
+     * @template M - The model type
+     * @param {M} model - The model instance to create
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M>} Promise resolving to the created model instance
+     */
+    create(model: M, ...args: any[]): Promise<M>;
+    /**
+     * @description Retrieves a model instance from the database by its key
+     * @summary Read a model
+     * @template M - The model type
+     * @param {PrimaryKeyType} key - The primary key of the model to retrieve
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M>} Promise resolving to the retrieved model instance
+     */
+    read(key: PrimaryKeyType, ...args: any[]): Promise<M>;
+    /**
+     * @description Updates a model instance in the database
+     * @summary Update a model
+     * @template M - The model type
+     * @param {M} model - The model instance to update
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M>} Promise resolving to the updated model instance
+     */
+    update(model: M, ...args: any[]): Promise<M>;
+    /**
+     * @description Deletes a model instance from the database by its key
+     * @summary Delete a model
+     * @template M - The model type
+     * @param {PrimaryKeyType} key - The primary key of the model to delete
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M>} Promise resolving to the deleted model instance
+     */
+    delete(key: PrimaryKeyType, ...args: any[]): Promise<M>;
+}

package/lib/types/interfaces/CrudOperator.d.mts

@@ -0,0 +1,46 @@
+import { PrimaryKeyType } from "../repository/index.js";
+/**
+ * @description Basic CRUD operations interface
+ * @summary Exposes a standard Create, Read, Update, Delete API for database operations
+ * @template M - The model type
+ * @interface CrudOperator
+ * @memberOf module:db-decorators
+ */
+export interface CrudOperator<M> {
+    /**
+     * @description Creates a new model instance in the database
+     * @summary Create a new model
+     * @template M - The model type
+     * @param {M} model - The model instance to create
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M>} Promise resolving to the created model instance
+     */
+    create(model: M, ...args: any[]): Promise<M>;
+    /**
+     * @description Retrieves a model instance from the database by its key
+     * @summary Read a model
+     * @template M - The model type
+     * @param {PrimaryKeyType} key - The primary key of the model to retrieve
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M>} Promise resolving to the retrieved model instance
+     */
+    read(key: PrimaryKeyType, ...args: any[]): Promise<M>;
+    /**
+     * @description Updates a model instance in the database
+     * @summary Update a model
+     * @template M - The model type
+     * @param {M} model - The model instance to update
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M>} Promise resolving to the updated model instance
+     */
+    update(model: M, ...args: any[]): Promise<M>;
+    /**
+     * @description Deletes a model instance from the database by its key
+     * @summary Delete a model
+     * @template M - The model type
+     * @param {PrimaryKeyType} key - The primary key of the model to delete
+     * @param {...any[]} args - Additional arguments
+     * @return {Promise<M>} Promise resolving to the deleted model instance
+     */
+    delete(key: PrimaryKeyType, ...args: any[]): Promise<M>;
+}

package/lib/types/interfaces/IRepository.d.cts

@@ -0,0 +1,19 @@
+import { Model, ModelConstructor } from "@decaf-ts/decorator-validation";
+import { BulkCrudOperator } from "./BulkCrudOperator.cjs";
+import { Context, RepositoryFlags } from "../repository/index.cjs";
+/**
+ * @description Repository interface for database operations
+ * @summary Interface holding basic CRUD APIs for database models, providing standard operations and metadata
+ * @template M - Type extending Model
+ * @template F - Type extending RepositoryFlags, defaults to RepositoryFlags
+ * @template C - Type extending Context<F>, defaults to Context<F>
+ * @interface IRepository
+ * @memberOf module:db-decorators
+ */
+export interface IRepository<M extends Model<boolean>, C extends Context<any> = Context<RepositoryFlags>> extends BulkCrudOperator<M> {
+    /**
+     * @description The constructor of the model class
+     * @summary Reference to the model class constructor used to create new instances
+     */
+    readonly class: ModelConstructor<M>;
+}

package/lib/types/interfaces/IRepository.d.mts

@@ -0,0 +1,19 @@
+import { Model, ModelConstructor } from "@decaf-ts/decorator-validation";
+import { BulkCrudOperator } from "./BulkCrudOperator.js";
+import { Context, RepositoryFlags } from "../repository/index.js";
+/**
+ * @description Repository interface for database operations
+ * @summary Interface holding basic CRUD APIs for database models, providing standard operations and metadata
+ * @template M - Type extending Model
+ * @template F - Type extending RepositoryFlags, defaults to RepositoryFlags
+ * @template C - Type extending Context<F>, defaults to Context<F>
+ * @interface IRepository
+ * @memberOf module:db-decorators
+ */
+export interface IRepository<M extends Model<boolean>, C extends Context<any> = Context<RepositoryFlags>> extends BulkCrudOperator<M> {
+    /**
+     * @description The constructor of the model class
+     * @summary Reference to the model class constructor used to create new instances
+     */
+    readonly class: ModelConstructor<M>;
+}

package/lib/types/interfaces/index.d.cts

@@ -0,0 +1,9 @@
+/**
+ * @description Exports for the interfaces module.
+ * @summary This file exports all the necessary components for the interfaces functionality, including BulkCrudOperator, Contextual, CrudOperator, and IRepository.
+ * @module db-decorators/interfaces
+ */
+export * from "./BulkCrudOperator.cjs";
+export * from "./Contextual.cjs";
+export * from "./CrudOperator.cjs";
+export * from "./IRepository.cjs";

package/lib/types/interfaces/index.d.mts

@@ -0,0 +1,9 @@
+/**
+ * @description Exports for the interfaces module.
+ * @summary This file exports all the necessary components for the interfaces functionality, including BulkCrudOperator, Contextual, CrudOperator, and IRepository.
+ * @module db-decorators/interfaces
+ */
+export * from "./BulkCrudOperator.js";
+export * from "./Contextual.js";
+export * from "./CrudOperator.js";
+export * from "./IRepository.js";

package/lib/types/model/constants.d.cts

@@ -0,0 +1,37 @@
+/**
+ * @description Database reflection keys
+ * @summary Collection of keys used for reflection metadata in database operations
+ * @const DBKeys
+ * @memberOf module:db-decorators
+ */
+export declare const DBKeys: {
+    REFLECT: string;
+    REPOSITORY: string;
+    CLASS: string;
+    ID: string;
+    INDEX: string;
+    UNIQUE: string;
+    SERIALIZE: string;
+    READONLY: string;
+    TIMESTAMP: string;
+    TRANSIENT: string;
+    HASH: string;
+    COMPOSED: string;
+    GENERATED: string;
+    VERSION: string;
+    ORIGINAL: string;
+};
+/**
+ * @description Default separator character for composite indexes
+ * @summary The default separator character used when concatenating multiple fields into a single index
+ * @const DefaultSeparator
+ * @memberOf module:db-decorators
+ */
+export declare const DefaultSeparator = "_";
+/**
+ * @description Default format for timestamp fields
+ * @summary Standard date format string used for timestamp fields in database models
+ * @const DEFAULT_TIMESTAMP_FORMAT
+ * @memberOf module:db-decorators
+ */
+export declare const DEFAULT_TIMESTAMP_FORMAT = "dd/MM/yyyy HH:mm:ss:S";

package/lib/types/model/constants.d.mts

@@ -0,0 +1,37 @@
+/**
+ * @description Database reflection keys
+ * @summary Collection of keys used for reflection metadata in database operations
+ * @const DBKeys
+ * @memberOf module:db-decorators
+ */
+export declare const DBKeys: {
+    REFLECT: string;
+    REPOSITORY: string;
+    CLASS: string;
+    ID: string;
+    INDEX: string;
+    UNIQUE: string;
+    SERIALIZE: string;
+    READONLY: string;
+    TIMESTAMP: string;
+    TRANSIENT: string;
+    HASH: string;
+    COMPOSED: string;
+    GENERATED: string;
+    VERSION: string;
+    ORIGINAL: string;
+};
+/**
+ * @description Default separator character for composite indexes
+ * @summary The default separator character used when concatenating multiple fields into a single index
+ * @const DefaultSeparator
+ * @memberOf module:db-decorators
+ */
+export declare const DefaultSeparator = "_";
+/**
+ * @description Default format for timestamp fields
+ * @summary Standard date format string used for timestamp fields in database models
+ * @const DEFAULT_TIMESTAMP_FORMAT
+ * @memberOf module:db-decorators
+ */
+export declare const DEFAULT_TIMESTAMP_FORMAT = "dd/MM/yyyy HH:mm:ss:S";