@decaf-ts/db-decorators 0.6.1 → 0.6.2

package/lib/operations/Operations.d.ts

@@ -5,18 +5,80 @@ import { IRepository } from "../interfaces";
 import { Context } from "../repository";
 import { RepositoryFlags } from "../repository/types";
 /**
- * @summary Static class holding common Operation Functionality
- *
+ * @description Static utility class for database operation management
+ * @summary Provides functionality for registering, retrieving, and managing database operation handlers
  * @class Operations
+ * @template M - Model type
+ * @template R - Repository type
+ * @template V - Metadata type
+ * @template F - Repository flags
+ * @template C - Context type
+ * @example
+ * // Register a handler for a create operation
+ * Operations.register(myHandler, OperationKeys.CREATE, targetModel, 'propertyName');
+ *
+ * // Get handlers for a specific operation
+ * const handlers = Operations.get(targetModel.constructor.name, 'propertyName', 'onCreate');
  *
- * @category Operations
+ * @mermaid
+ * classDiagram
+ *   class Operations {
+ *     -registry: OperationsRegistry
+ *     +getHandlerName(handler)
+ *     +key(str)
+ *     +get(targetName, propKey, operation)
+ *     -getOpRegistry()
+ *     +register(handler, operation, target, propKey)
+ *   }
+ *   Operations --> OperationsRegistry : uses
  */
 export declare class Operations {
     private static registry;
     private constructor();
+    /**
+     * @description Gets a unique name for an operation handler
+     * @summary Returns the name of the handler function or generates a hash if name is not available
+     * @param {OperationHandler<any, any, any, any, any>} handler - The handler function to get the name for
+     * @return {string} The name of the handler or a generated hash
+     */
     static getHandlerName(handler: OperationHandler<any, any, any, any, any>): any;
+    /**
+     * @description Generates a reflection metadata key
+     * @summary Creates a fully qualified metadata key by prefixing with the reflection namespace
+     * @param {string} str - The operation key string to prefix
+     * @return {string} The fully qualified metadata key
+     */
     static key(str: string): string;
+    /**
+     * @description Retrieves operation handlers for a specific target and operation
+     * @summary Gets registered handlers from the operations registry for a given target, property, and operation
+     * @template M - Model type extending Model
+     * @template R - Repository type extending IRepository
+     * @template V - Metadata type, defaults to object
+     * @template F - Repository flags extending RepositoryFlags
+     * @template C - Context type extending Context<F>
+     * @param {string | Record<string, any>} targetName - The target class name or object
+     * @param {string} propKey - The property key to get handlers for
+     * @param {string} operation - The operation key to get handlers for
+     * @return {any} The registered handlers for the specified target, property, and operation
+     */
     static get<M extends Model, R extends IRepository<M, F, C>, V = object, F extends RepositoryFlags = RepositoryFlags, C extends Context<F> = Context<F>>(targetName: string | Record<string, any>, propKey: string, operation: string): OperationHandler<M, R, V, F, C>[] | undefined;
+    /**
+     * @description Gets or initializes the operations registry
+     * @summary Returns the existing registry or creates a new one if it doesn't exist
+     * @return {OperationsRegistry} The operations registry instance
+     * @private
+     */
     private static getOpRegistry;
+    /**
+     * @description Registers an operation handler for a specific target and operation
+     * @summary Adds a handler to the operations registry for a given target, property, and operation
+     * @template V - Model type extending Model
+     * @param {OperationHandler<V, any, any>} handler - The handler function to register
+     * @param {OperationKeys} operation - The operation key to register the handler for
+     * @param {V} target - The target model instance
+     * @param {string | symbol} propKey - The property key to register the handler for
+     * @return {void}
+     */
     static register<V extends Model>(handler: OperationHandler<V, any, any>, operation: OperationKeys, target: V, propKey: string | symbol): void;
 }

package/lib/operations/OperationsRegistry.cjs

@@ -3,26 +3,47 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OperationsRegistry = void 0;
 const Operations_1 = require("./Operations.cjs");
 /**
- * @summary Holds the registered operation handlers
- *
+ * @description Registry for database operation handlers
+ * @summary Manages and stores operation handlers for different model properties and operations
  * @class OperationsRegistry
- * @implements IRegistry<OperationHandler<any>>
+ * @template M - Model type
+ * @template R - Repository type
+ * @template V - Metadata type
+ * @template F - Repository flags
+ * @template C - Context type
+ * @example
+ * // Create a registry and register a handler
+ * const registry = new OperationsRegistry();
+ * registry.register(myHandler, OperationKeys.CREATE, targetModel, 'propertyName');
  *
- * @see OperationHandler
+ * // Get handlers for a specific operation
+ * const handlers = registry.get(targetModel.constructor.name, 'propertyName', 'onCreate');
  *
- * @category Operations
+ * @mermaid
+ * classDiagram
+ *   class OperationsRegistry {
+ *     -cache: Record~string, Record~string|symbol, Record~string, Record~string, OperationHandler~~~~
+ *     +get(target, propKey, operation, accum)
+ *     +register(handler, operation, target, propKey)
+ *   }
  */
 class OperationsRegistry {
     constructor() {
         this.cache = {};
     }
     /**
-     * @summary retrieves an {@link OperationHandler} if it exists
-     * @param {string} target
-     * @param {string} propKey
-     * @param {string} operation
-     * @param accum
-     * @return {OperationHandler | undefined}
+     * @description Retrieves operation handlers for a specific target and operation
+     * @summary Finds all registered handlers for a given target, property, and operation, including from parent classes
+     * @template M - Model type extending Model
+     * @template R - Repository type extending IRepository
+     * @template V - Metadata type
+     * @template F - Repository flags extending RepositoryFlags
+     * @template C - Context type extending Context<F>
+     * @param {string | Record<string, any>} target - The target class name or object
+     * @param {string} propKey - The property key to get handlers for
+     * @param {string} operation - The operation key to get handlers for
+     * @param {OperationHandler[]} [accum] - Accumulator for recursive calls
+     * @return {OperationHandler[] | undefined} Array of handlers or undefined if none found
      */
     get(target, propKey, operation, accum) {
         accum = accum || [];
@@ -44,11 +65,18 @@ class OperationsRegistry {
         return this.get(proto, propKey, operation, accum);
     }
     /**
-     * @summary Registers an {@link OperationHandler}
-     * @param {OperationHandler} handler
-     * @param {string} operation
-     * @param {{}} target
-     * @param {string | symbol} propKey
+     * @description Registers an operation handler for a specific target and operation
+     * @summary Stores a handler in the registry for a given target, property, and operation
+     * @template M - Model type extending Model
+     * @template R - Repository type extending IRepository
+     * @template V - Metadata type
+     * @template F - Repository flags extending RepositoryFlags
+     * @template C - Context type extending Context<F>
+     * @param {OperationHandler} handler - The handler function to register
+     * @param {OperationKeys} operation - The operation key to register the handler for
+     * @param {M} target - The target model instance
+     * @param {string | symbol} propKey - The property key to register the handler for
+     * @return {void}
      */
     register(handler, operation, target, propKey) {
         const name = target.constructor.name;
@@ -65,4 +93,4 @@ class OperationsRegistry {
     }
 }
 exports.OperationsRegistry = OperationsRegistry;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT3BlcmF0aW9uc1JlZ2lzdHJ5LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL29wZXJhdGlvbnMvT3BlcmF0aW9uc1JlZ2lzdHJ5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUdBLGlEQUEwQztBQUsxQzs7Ozs7Ozs7O0dBU0c7QUFDSCxNQUFhLGtCQUFrQjtJQUEvQjtRQUNtQixVQUFLLEdBTWxCLEVBQUUsQ0FBQztJQTBFVCxDQUFDO0lBeEVDOzs7Ozs7O09BT0c7SUFDSCxHQUFHLENBT0QsTUFBb0MsRUFDcEMsT0FBZSxFQUNmLFNBQWlCLEVBQ2pCLEtBQXlDO1FBRXpDLEtBQUssR0FBRyxLQUFLLElBQUksRUFBRSxDQUFDO1FBQ3BCLElBQUksSUFBSSxDQUFDO1FBQ1QsSUFBSSxDQUFDO1lBQ0gsSUFBSSxHQUFHLE9BQU8sTUFBTSxLQUFLLFFBQVEsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsV0FBVyxDQUFDLElBQUksQ0FBQztZQUNyRSxLQUFLLENBQUMsT0FBTyxDQUNYLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLFNBQVMsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUM3RCxDQUFDO1lBQ0YsNkRBQTZEO1FBQy9ELENBQUM7UUFBQyxPQUFPLENBQVUsRUFBRSxDQUFDO1lBQ3BCLElBQ0UsT0FBTyxNQUFNLEtBQUssUUFBUTtnQkFDMUIsTUFBTSxLQUFLLE1BQU0sQ0FBQyxTQUFTO2dCQUMzQixNQUFNLENBQUMsY0FBYyxDQUFDLE1BQU0sQ0FBQyxLQUFLLE1BQU0sQ0FBQyxTQUFTO2dCQUVsRCxPQUFPLEtBQUssQ0FBQztRQUNqQixDQUFDO1FBRUQsSUFBSSxLQUFLLEdBQUcsTUFBTSxDQUFDLGNBQWMsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUMxQyxJQUFJLEtBQUssQ0FBQyxXQUFXLENBQUMsSUFBSSxLQUFLLElBQUk7WUFBRSxLQUFLLEdBQUcsTUFBTSxDQUFDLGNBQWMsQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUUxRSxPQUFPLElBQUksQ0FBQyxHQUFHLENBQWdCLEtBQUssRUFBRSxPQUFPLEVBQUUsU0FBUyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQ25FLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSCxRQUFRLENBT04sT0FBd0MsRUFDeEMsU0FBd0IsRUFDeEIsTUFBUyxFQUNULE9BQXdCO1FBRXhCLE1BQU0sSUFBSSxHQUFHLE1BQU0sQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDO1FBQ3JDLE1BQU0sV0FBVyxHQUFHLHVCQUFVLENBQUMsY0FBYyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBRXZELElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQztZQUFFLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQzdDLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLE9BQU8sQ0FBQztZQUFFLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQy9ELElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLFNBQVMsQ0FBQztZQUN2QyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLFNBQVMsQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUM1QyxJQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsU0FBUyxDQUFDLENBQUMsV0FBVyxDQUFDO1lBQUUsT0FBTztRQUM5RCxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLFNBQVMsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxHQUFHLE9BQU8sQ0FBQztJQUM5RCxDQUFDO0NBQ0Y7QUFqRkQsZ0RBaUZDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgT3BlcmF0aW9uSGFuZGxlciB9IGZyb20gXCIuL3R5cGVzXCI7XG5pbXBvcnQgeyBPcGVyYXRpb25LZXlzIH0gZnJvbSBcIi4vY29uc3RhbnRzXCI7XG5pbXBvcnQgeyBJUmVwb3NpdG9yeSB9IGZyb20gXCIuLi9pbnRlcmZhY2VzL0lSZXBvc2l0b3J5XCI7XG5pbXBvcnQgeyBPcGVyYXRpb25zIH0gZnJvbSBcIi4vT3BlcmF0aW9uc1wiO1xuaW1wb3J0IHsgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBDb250ZXh0IH0gZnJvbSBcIi4uL3JlcG9zaXRvcnlcIjtcbmltcG9ydCB7IFJlcG9zaXRvcnlGbGFncyB9IGZyb20gXCIuLi9yZXBvc2l0b3J5L3R5cGVzXCI7XG5cbi8qKlxuICogQHN1bW1hcnkgSG9sZHMgdGhlIHJlZ2lzdGVyZWQgb3BlcmF0aW9uIGhhbmRsZXJzXG4gKlxuICogQGNsYXNzIE9wZXJhdGlvbnNSZWdpc3RyeVxuICogQGltcGxlbWVudHMgSVJlZ2lzdHJ5PE9wZXJhdGlvbkhhbmRsZXI8YW55Pj5cbiAqXG4gKiBAc2VlIE9wZXJhdGlvbkhhbmRsZXJcbiAqXG4gKiBAY2F0ZWdvcnkgT3BlcmF0aW9uc1xuICovXG5leHBvcnQgY2xhc3MgT3BlcmF0aW9uc1JlZ2lzdHJ5IHtcbiAgcHJpdmF0ZSByZWFkb25seSBjYWNoZTogUmVjb3JkPFxuICAgIHN0cmluZyxcbiAgICBSZWNvcmQ8XG4gICAgICBzdHJpbmcgfCBzeW1ib2wsXG4gICAgICBSZWNvcmQ8c3RyaW5nLCBSZWNvcmQ8c3RyaW5nLCBPcGVyYXRpb25IYW5kbGVyPGFueSwgYW55LCBhbnksIGFueSwgYW55Pj4+XG4gICAgPlxuICA+ID0ge307XG5cbiAgLyoqXG4gICAqIEBzdW1tYXJ5IHJldHJpZXZlcyBhbiB7QGxpbmsgT3BlcmF0aW9uSGFuZGxlcn0gaWYgaXQgZXhpc3RzXG4gICAqIEBwYXJhbSB7c3RyaW5nfSB0YXJnZXRcbiAgICogQHBhcmFtIHtzdHJpbmd9IHByb3BLZXlcbiAgICogQHBhcmFtIHtzdHJpbmd9IG9wZXJhdGlvblxuICAgKiBAcGFyYW0gYWNjdW1cbiAgICogQHJldHVybiB7T3BlcmF0aW9uSGFuZGxlciB8IHVuZGVmaW5lZH1cbiAgICovXG4gIGdldDxcbiAgICBNIGV4dGVuZHMgTW9kZWwsXG4gICAgUiBleHRlbmRzIElSZXBvc2l0b3J5PE0sIEYsIEM+LFxuICAgIFYsXG4gICAgRiBleHRlbmRzIFJlcG9zaXRvcnlGbGFncyxcbiAgICBDIGV4dGVuZHMgQ29udGV4dDxGPixcbiAgPihcbiAgICB0YXJnZXQ6IHN0cmluZyB8IFJlY29yZDxzdHJpbmcsIGFueT4sXG4gICAgcHJvcEtleTogc3RyaW5nLFxuICAgIG9wZXJhdGlvbjogc3RyaW5nLFxuICAgIGFjY3VtPzogT3BlcmF0aW9uSGFuZGxlcjxNLCBSLCBWLCBGLCBDPltdXG4gICk6IE9wZXJhdGlvbkhhbmRsZXI8TSwgUiwgViwgRiwgQz5bXSB8IHVuZGVmaW5lZCB7XG4gICAgYWNjdW0gPSBhY2N1bSB8fCBbXTtcbiAgICBsZXQgbmFtZTtcbiAgICB0cnkge1xuICAgICAgbmFtZSA9IHR5cGVvZiB0YXJnZXQgPT09IFwic3RyaW5nXCIgPyB0YXJnZXQgOiB0YXJnZXQuY29uc3RydWN0b3IubmFtZTtcbiAgICAgIGFjY3VtLnVuc2hpZnQoXG4gICAgICAgIC4uLk9iamVjdC52YWx1ZXModGhpcy5jYWNoZVtuYW1lXVtwcm9wS2V5XVtvcGVyYXRpb25dIHx8IFtdKVxuICAgICAgKTtcbiAgICAgIC8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdW51c2VkLXZhcnNcbiAgICB9IGNhdGNoIChlOiB1bmtub3duKSB7XG4gICAgICBpZiAoXG4gICAgICAgIHR5cGVvZiB0YXJnZXQgPT09IFwic3RyaW5nXCIgfHxcbiAgICAgICAgdGFyZ2V0ID09PSBPYmplY3QucHJvdG90eXBlIHx8XG4gICAgICAgIE9iamVjdC5nZXRQcm90b3R5cGVPZih0YXJnZXQpID09PSBPYmplY3QucHJvdG90eXBlXG4gICAgICApXG4gICAgICAgIHJldHVybiBhY2N1bTtcbiAgICB9XG5cbiAgICBsZXQgcHJvdG8gPSBPYmplY3QuZ2V0UHJvdG90eXBlT2YodGFyZ2V0KTtcbiAgICBpZiAocHJvdG8uY29uc3RydWN0b3IubmFtZSA9PT0gbmFtZSkgcHJvdG8gPSBPYmplY3QuZ2V0UHJvdG90eXBlT2YocHJvdG8pO1xuXG4gICAgcmV0dXJuIHRoaXMuZ2V0PE0sIFIsIFYsIEYsIEM+KHByb3RvLCBwcm9wS2V5LCBvcGVyYXRpb24sIGFjY3VtKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBAc3VtbWFyeSBSZWdpc3RlcnMgYW4ge0BsaW5rIE9wZXJhdGlvbkhhbmRsZXJ9XG4gICAqIEBwYXJhbSB7T3BlcmF0aW9uSGFuZGxlcn0gaGFuZGxlclxuICAgKiBAcGFyYW0ge3N0cmluZ30gb3BlcmF0aW9uXG4gICAqIEBwYXJhbSB7e319IHRhcmdldFxuICAgKiBAcGFyYW0ge3N0cmluZyB8IHN5bWJvbH0gcHJvcEtleVxuICAgKi9cbiAgcmVnaXN0ZXI8XG4gICAgTSBleHRlbmRzIE1vZGVsLFxuICAgIFIgZXh0ZW5kcyBJUmVwb3NpdG9yeTxNLCBGLCBDPixcbiAgICBWLFxuICAgIEYgZXh0ZW5kcyBSZXBvc2l0b3J5RmxhZ3MsXG4gICAgQyBleHRlbmRzIENvbnRleHQ8Rj4sXG4gID4oXG4gICAgaGFuZGxlcjogT3BlcmF0aW9uSGFuZGxlcjxNLCBSLCBWLCBGLCBDPixcbiAgICBvcGVyYXRpb246IE9wZXJhdGlvbktleXMsXG4gICAgdGFyZ2V0OiBNLFxuICAgIHByb3BLZXk6IHN0cmluZyB8IHN5bWJvbFxuICApOiB2b2lkIHtcbiAgICBjb25zdCBuYW1lID0gdGFyZ2V0LmNvbnN0cnVjdG9yLm5hbWU7XG4gICAgY29uc3QgaGFuZGxlck5hbWUgPSBPcGVyYXRpb25zLmdldEhhbmRsZXJOYW1lKGhhbmRsZXIpO1xuXG4gICAgaWYgKCF0aGlzLmNhY2hlW25hbWVdKSB0aGlzLmNhY2hlW25hbWVdID0ge307XG4gICAgaWYgKCF0aGlzLmNhY2hlW25hbWVdW3Byb3BLZXldKSB0aGlzLmNhY2hlW25hbWVdW3Byb3BLZXldID0ge307XG4gICAgaWYgKCF0aGlzLmNhY2hlW25hbWVdW3Byb3BLZXldW29wZXJhdGlvbl0pXG4gICAgICB0aGlzLmNhY2hlW25hbWVdW3Byb3BLZXldW29wZXJhdGlvbl0gPSB7fTtcbiAgICBpZiAodGhpcy5jYWNoZVtuYW1lXVtwcm9wS2V5XVtvcGVyYXRpb25dW2hhbmRsZXJOYW1lXSkgcmV0dXJuO1xuICAgIHRoaXMuY2FjaGVbbmFtZV1bcHJvcEtleV1bb3BlcmF0aW9uXVtoYW5kbGVyTmFtZV0gPSBoYW5kbGVyO1xuICB9XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"OperationsRegistry.js","sourceRoot":"","sources":["../../src/operations/OperationsRegistry.ts"],"names":[],"mappings":";;;AAGA,iDAA0C;AAK1C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,kBAAkB;IAA/B;QACmB,UAAK,GAMlB,EAAE,CAAC;IAuFT,CAAC;IArFC;;;;;;;;;;;;;OAaG;IACH,GAAG,CAOD,MAAoC,EACpC,OAAe,EACf,SAAiB,EACjB,KAAyC;QAEzC,KAAK,GAAG,KAAK,IAAI,EAAE,CAAC;QACpB,IAAI,IAAI,CAAC;QACT,IAAI,CAAC;YACH,IAAI,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;YACrE,KAAK,CAAC,OAAO,CACX,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAC7D,CAAC;YACF,6DAA6D;QAC/D,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,IACE,OAAO,MAAM,KAAK,QAAQ;gBAC1B,MAAM,KAAK,MAAM,CAAC,SAAS;gBAC3B,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,SAAS;gBAElD,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI;YAAE,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE1E,OAAO,IAAI,CAAC,GAAG,CAAgB,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAON,OAAwC,EACxC,SAAwB,EACxB,MAAS,EACT,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;QACrC,MAAM,WAAW,GAAG,uBAAU,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEvD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QAC/D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;QAC5C,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC;YAAE,OAAO;QAC9D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC;IAC9D,CAAC;CACF;AA9FD,gDA8FC","sourcesContent":["import { OperationHandler } from \"./types\";\nimport { OperationKeys } from \"./constants\";\nimport { IRepository } from \"../interfaces/IRepository\";\nimport { Operations } from \"./Operations\";\nimport { Model } from \"@decaf-ts/decorator-validation\";\nimport { Context } from \"../repository\";\nimport { RepositoryFlags } from \"../repository/types\";\n\n/**\n * @description Registry for database operation handlers\n * @summary Manages and stores operation handlers for different model properties and operations\n * @class OperationsRegistry\n * @template M - Model type\n * @template R - Repository type\n * @template V - Metadata type\n * @template F - Repository flags\n * @template C - Context type\n * @example\n * // Create a registry and register a handler\n * const registry = new OperationsRegistry();\n * registry.register(myHandler, OperationKeys.CREATE, targetModel, 'propertyName');\n *\n * // Get handlers for a specific operation\n * const handlers = registry.get(targetModel.constructor.name, 'propertyName', 'onCreate');\n *\n * @mermaid\n * classDiagram\n *   class OperationsRegistry {\n *     -cache: Record~string, Record~string|symbol, Record~string, Record~string, OperationHandler~~~~\n *     +get(target, propKey, operation, accum)\n *     +register(handler, operation, target, propKey)\n *   }\n */\nexport class OperationsRegistry {\n  private readonly cache: Record<\n    string,\n    Record<\n      string | symbol,\n      Record<string, Record<string, OperationHandler<any, any, any, any, any>>>\n    >\n  > = {};\n\n  /**\n   * @description Retrieves operation handlers for a specific target and operation\n   * @summary Finds all registered handlers for a given target, property, and operation, including from parent classes\n   * @template M - Model type extending Model\n   * @template R - Repository type extending IRepository\n   * @template V - Metadata type\n   * @template F - Repository flags extending RepositoryFlags\n   * @template C - Context type extending Context<F>\n   * @param {string | Record<string, any>} target - The target class name or object\n   * @param {string} propKey - The property key to get handlers for\n   * @param {string} operation - The operation key to get handlers for\n   * @param {OperationHandler[]} [accum] - Accumulator for recursive calls\n   * @return {OperationHandler[] | undefined} Array of handlers or undefined if none found\n   */\n  get<\n    M extends Model,\n    R extends IRepository<M, F, C>,\n    V,\n    F extends RepositoryFlags,\n    C extends Context<F>,\n  >(\n    target: string | Record<string, any>,\n    propKey: string,\n    operation: string,\n    accum?: OperationHandler<M, R, V, F, C>[]\n  ): OperationHandler<M, R, V, F, C>[] | undefined {\n    accum = accum || [];\n    let name;\n    try {\n      name = typeof target === \"string\" ? target : target.constructor.name;\n      accum.unshift(\n        ...Object.values(this.cache[name][propKey][operation] || [])\n      );\n      // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    } catch (e: unknown) {\n      if (\n        typeof target === \"string\" ||\n        target === Object.prototype ||\n        Object.getPrototypeOf(target) === Object.prototype\n      )\n        return accum;\n    }\n\n    let proto = Object.getPrototypeOf(target);\n    if (proto.constructor.name === name) proto = Object.getPrototypeOf(proto);\n\n    return this.get<M, R, V, F, C>(proto, propKey, operation, accum);\n  }\n\n  /**\n   * @description Registers an operation handler for a specific target and operation\n   * @summary Stores a handler in the registry for a given target, property, and operation\n   * @template M - Model type extending Model\n   * @template R - Repository type extending IRepository\n   * @template V - Metadata type\n   * @template F - Repository flags extending RepositoryFlags\n   * @template C - Context type extending Context<F>\n   * @param {OperationHandler} handler - The handler function to register\n   * @param {OperationKeys} operation - The operation key to register the handler for\n   * @param {M} target - The target model instance\n   * @param {string | symbol} propKey - The property key to register the handler for\n   * @return {void}\n   */\n  register<\n    M extends Model,\n    R extends IRepository<M, F, C>,\n    V,\n    F extends RepositoryFlags,\n    C extends Context<F>,\n  >(\n    handler: OperationHandler<M, R, V, F, C>,\n    operation: OperationKeys,\n    target: M,\n    propKey: string | symbol\n  ): void {\n    const name = target.constructor.name;\n    const handlerName = Operations.getHandlerName(handler);\n\n    if (!this.cache[name]) this.cache[name] = {};\n    if (!this.cache[name][propKey]) this.cache[name][propKey] = {};\n    if (!this.cache[name][propKey][operation])\n      this.cache[name][propKey][operation] = {};\n    if (this.cache[name][propKey][operation][handlerName]) return;\n    this.cache[name][propKey][operation][handlerName] = handler;\n  }\n}\n"]}

package/lib/operations/OperationsRegistry.d.ts

@@ -5,32 +5,60 @@ import { Model } from "@decaf-ts/decorator-validation";
 import { Context } from "../repository";
 import { RepositoryFlags } from "../repository/types";
 /**
- * @summary Holds the registered operation handlers
- *
+ * @description Registry for database operation handlers
+ * @summary Manages and stores operation handlers for different model properties and operations
  * @class OperationsRegistry
- * @implements IRegistry<OperationHandler<any>>
+ * @template M - Model type
+ * @template R - Repository type
+ * @template V - Metadata type
+ * @template F - Repository flags
+ * @template C - Context type
+ * @example
+ * // Create a registry and register a handler
+ * const registry = new OperationsRegistry();
+ * registry.register(myHandler, OperationKeys.CREATE, targetModel, 'propertyName');
  *
- * @see OperationHandler
+ * // Get handlers for a specific operation
+ * const handlers = registry.get(targetModel.constructor.name, 'propertyName', 'onCreate');
  *
- * @category Operations
+ * @mermaid
+ * classDiagram
+ *   class OperationsRegistry {
+ *     -cache: Record~string, Record~string|symbol, Record~string, Record~string, OperationHandler~~~~
+ *     +get(target, propKey, operation, accum)
+ *     +register(handler, operation, target, propKey)
+ *   }
  */
 export declare class OperationsRegistry {
     private readonly cache;
     /**
-     * @summary retrieves an {@link OperationHandler} if it exists
-     * @param {string} target
-     * @param {string} propKey
-     * @param {string} operation
-     * @param accum
-     * @return {OperationHandler | undefined}
+     * @description Retrieves operation handlers for a specific target and operation
+     * @summary Finds all registered handlers for a given target, property, and operation, including from parent classes
+     * @template M - Model type extending Model
+     * @template R - Repository type extending IRepository
+     * @template V - Metadata type
+     * @template F - Repository flags extending RepositoryFlags
+     * @template C - Context type extending Context<F>
+     * @param {string | Record<string, any>} target - The target class name or object
+     * @param {string} propKey - The property key to get handlers for
+     * @param {string} operation - The operation key to get handlers for
+     * @param {OperationHandler[]} [accum] - Accumulator for recursive calls
+     * @return {OperationHandler[] | undefined} Array of handlers or undefined if none found
      */
     get<M extends Model, R extends IRepository<M, F, C>, V, F extends RepositoryFlags, C extends Context<F>>(target: string | Record<string, any>, propKey: string, operation: string, accum?: OperationHandler<M, R, V, F, C>[]): OperationHandler<M, R, V, F, C>[] | undefined;
     /**
-     * @summary Registers an {@link OperationHandler}
-     * @param {OperationHandler} handler
-     * @param {string} operation
-     * @param {{}} target
-     * @param {string | symbol} propKey
+     * @description Registers an operation handler for a specific target and operation
+     * @summary Stores a handler in the registry for a given target, property, and operation
+     * @template M - Model type extending Model
+     * @template R - Repository type extending IRepository
+     * @template V - Metadata type
+     * @template F - Repository flags extending RepositoryFlags
+     * @template C - Context type extending Context<F>
+     * @param {OperationHandler} handler - The handler function to register
+     * @param {OperationKeys} operation - The operation key to register the handler for
+     * @param {M} target - The target model instance
+     * @param {string | symbol} propKey - The property key to register the handler for
+     * @return {void}
      */
     register<M extends Model, R extends IRepository<M, F, C>, V, F extends RepositoryFlags, C extends Context<F>>(handler: OperationHandler<M, R, V, F, C>, operation: OperationKeys, target: M, propKey: string | symbol): void;
 }

package/lib/operations/constants.cjs

@@ -2,10 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DBOperations = exports.BulkCrudOperationKeys = exports.OperationKeys = void 0;
 /**
- * @summary Set of constants to define db CRUD operations and their equivalent 'on' and 'after' phases
- * @const OperationKeys
- *
- * @memberOf module:db-decorators.Operations
+ * @description Database operation key constants
+ * @summary Enum defining CRUD operations and their lifecycle phases
+ * @enum {string}
+ * @readonly
+ * @memberOf module:db-decorators
  */
 var OperationKeys;
 (function (OperationKeys) {
@@ -17,6 +18,13 @@ var OperationKeys;
     OperationKeys["ON"] = "on.";
     OperationKeys["AFTER"] = "after.";
 })(OperationKeys || (exports.OperationKeys = OperationKeys = {}));
+/**
+ * @description Bulk database operation key constants
+ * @summary Enum defining bulk CRUD operations for handling multiple records at once
+ * @enum {string}
+ * @readonly
+ * @memberOf module:db-decorators
+ */
 var BulkCrudOperationKeys;
 (function (BulkCrudOperationKeys) {
     BulkCrudOperationKeys["CREATE_ALL"] = "createAll";
@@ -25,11 +33,10 @@ var BulkCrudOperationKeys;
     BulkCrudOperationKeys["DELETE_ALL"] = "deleteAll";
 })(BulkCrudOperationKeys || (exports.BulkCrudOperationKeys = BulkCrudOperationKeys = {}));
 /**
+ * @description Grouped CRUD operations for decorator mapping
  * @summary Maps out groups of CRUD operations for easier mapping of decorators
- *
- * @constant DBOperations
- *
- * @memberOf module:db-decorators.Operations
+ * @const DBOperations
+ * @memberOf module:db-decorators
  */
 exports.DBOperations = {
     CREATE: [OperationKeys.CREATE],
@@ -45,4 +52,4 @@ exports.DBOperations = {
         OperationKeys.DELETE,
     ],
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL29wZXJhdGlvbnMvY29uc3RhbnRzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBOzs7OztHQUtHO0FBQ0gsSUFBWSxhQVFYO0FBUkQsV0FBWSxhQUFhO0lBQ3ZCLHVEQUFzQyxDQUFBO0lBQ3RDLGtDQUFpQixDQUFBO0lBQ2pCLDhCQUFhLENBQUE7SUFDYixrQ0FBaUIsQ0FBQTtJQUNqQixrQ0FBaUIsQ0FBQTtJQUNqQiwyQkFBVSxDQUFBO0lBQ1YsaUNBQWdCLENBQUE7QUFDbEIsQ0FBQyxFQVJXLGFBQWEsNkJBQWIsYUFBYSxRQVF4QjtBQVFELElBQVkscUJBS1g7QUFMRCxXQUFZLHFCQUFxQjtJQUMvQixpREFBd0IsQ0FBQTtJQUN4Qiw2Q0FBb0IsQ0FBQTtJQUNwQixpREFBd0IsQ0FBQTtJQUN4QixpREFBd0IsQ0FBQTtBQUMxQixDQUFDLEVBTFcscUJBQXFCLHFDQUFyQixxQkFBcUIsUUFLaEM7QUFRRDs7Ozs7O0dBTUc7QUFDVSxRQUFBLFlBQVksR0FBcUM7SUFDNUQsTUFBTSxFQUFFLENBQUMsYUFBYSxDQUFDLE1BQU0sQ0FBQztJQUM5QixJQUFJLEVBQUUsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDO0lBQzFCLE1BQU0sRUFBRSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQUM7SUFDOUIsTUFBTSxFQUFFLENBQUMsYUFBYSxDQUFDLE1BQU0sQ0FBQztJQUM5QixhQUFhLEVBQUUsQ0FBQyxhQUFhLENBQUMsTUFBTSxFQUFFLGFBQWEsQ0FBQyxNQUFNLENBQUM7SUFDM0QsV0FBVyxFQUFFLENBQUMsYUFBYSxDQUFDLElBQUksRUFBRSxhQUFhLENBQUMsTUFBTSxDQUFDO0lBQ3ZELEdBQUcsRUFBRTtRQUNILGFBQWEsQ0FBQyxNQUFNO1FBQ3BCLGFBQWEsQ0FBQyxJQUFJO1FBQ2xCLGFBQWEsQ0FBQyxNQUFNO1FBQ3BCLGFBQWEsQ0FBQyxNQUFNO0tBQ3JCO0NBQ0YsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQHN1bW1hcnkgU2V0IG9mIGNvbnN0YW50cyB0byBkZWZpbmUgZGIgQ1JVRCBvcGVyYXRpb25zIGFuZCB0aGVpciBlcXVpdmFsZW50ICdvbicgYW5kICdhZnRlcicgcGhhc2VzXG4gKiBAY29uc3QgT3BlcmF0aW9uS2V5c1xuICpcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGItZGVjb3JhdG9ycy5PcGVyYXRpb25zXG4gKi9cbmV4cG9ydCBlbnVtIE9wZXJhdGlvbktleXMge1xuICBSRUZMRUNUID0gXCJkZWNhZi5tb2RlbC5kYi5vcGVyYXRpb25zLlwiLFxuICBDUkVBVEUgPSBcImNyZWF0ZVwiLFxuICBSRUFEID0gXCJyZWFkXCIsXG4gIFVQREFURSA9IFwidXBkYXRlXCIsXG4gIERFTEVURSA9IFwiZGVsZXRlXCIsXG4gIE9OID0gXCJvbi5cIixcbiAgQUZURVIgPSBcImFmdGVyLlwiLFxufVxuXG5leHBvcnQgdHlwZSBDcnVkT3BlcmF0aW9ucyA9XG4gIHwgT3BlcmF0aW9uS2V5cy5DUkVBVEVcbiAgfCBPcGVyYXRpb25LZXlzLlJFQURcbiAgfCBPcGVyYXRpb25LZXlzLlVQREFURVxuICB8IE9wZXJhdGlvbktleXMuREVMRVRFO1xuXG5leHBvcnQgZW51bSBCdWxrQ3J1ZE9wZXJhdGlvbktleXMge1xuICBDUkVBVEVfQUxMID0gXCJjcmVhdGVBbGxcIixcbiAgUkVBRF9BTEwgPSBcInJlYWRBbGxcIixcbiAgVVBEQVRFX0FMTCA9IFwidXBkYXRlQWxsXCIsXG4gIERFTEVURV9BTEwgPSBcImRlbGV0ZUFsbFwiLFxufVxuXG5leHBvcnQgdHlwZSBCdWxrQ3J1ZE9wZXJhdGlvbnMgPVxuICB8IEJ1bGtDcnVkT3BlcmF0aW9uS2V5cy5DUkVBVEVfQUxMXG4gIHwgQnVsa0NydWRPcGVyYXRpb25LZXlzLlJFQURfQUxMXG4gIHwgQnVsa0NydWRPcGVyYXRpb25LZXlzLlVQREFURV9BTExcbiAgfCBCdWxrQ3J1ZE9wZXJhdGlvbktleXMuREVMRVRFX0FMTDtcblxuLyoqXG4gKiBAc3VtbWFyeSBNYXBzIG91dCBncm91cHMgb2YgQ1JVRCBvcGVyYXRpb25zIGZvciBlYXNpZXIgbWFwcGluZyBvZiBkZWNvcmF0b3JzXG4gKlxuICogQGNvbnN0YW50IERCT3BlcmF0aW9uc1xuICpcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGItZGVjb3JhdG9ycy5PcGVyYXRpb25zXG4gKi9cbmV4cG9ydCBjb25zdCBEQk9wZXJhdGlvbnM6IFJlY29yZDxzdHJpbmcsIENydWRPcGVyYXRpb25zW10+ID0ge1xuICBDUkVBVEU6IFtPcGVyYXRpb25LZXlzLkNSRUFURV0sXG4gIFJFQUQ6IFtPcGVyYXRpb25LZXlzLlJFQURdLFxuICBVUERBVEU6IFtPcGVyYXRpb25LZXlzLlVQREFURV0sXG4gIERFTEVURTogW09wZXJhdGlvbktleXMuREVMRVRFXSxcbiAgQ1JFQVRFX1VQREFURTogW09wZXJhdGlvbktleXMuQ1JFQVRFLCBPcGVyYXRpb25LZXlzLlVQREFURV0sXG4gIFJFQURfQ1JFQVRFOiBbT3BlcmF0aW9uS2V5cy5SRUFELCBPcGVyYXRpb25LZXlzLkNSRUFURV0sXG4gIEFMTDogW1xuICAgIE9wZXJhdGlvbktleXMuQ1JFQVRFLFxuICAgIE9wZXJhdGlvbktleXMuUkVBRCxcbiAgICBPcGVyYXRpb25LZXlzLlVQREFURSxcbiAgICBPcGVyYXRpb25LZXlzLkRFTEVURSxcbiAgXSxcbn07XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL29wZXJhdGlvbnMvY29uc3RhbnRzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBOzs7Ozs7R0FNRztBQUNILElBQVksYUFRWDtBQVJELFdBQVksYUFBYTtJQUN2Qix1REFBc0MsQ0FBQTtJQUN0QyxrQ0FBaUIsQ0FBQTtJQUNqQiw4QkFBYSxDQUFBO0lBQ2Isa0NBQWlCLENBQUE7SUFDakIsa0NBQWlCLENBQUE7SUFDakIsMkJBQVUsQ0FBQTtJQUNWLGlDQUFnQixDQUFBO0FBQ2xCLENBQUMsRUFSVyxhQUFhLDZCQUFiLGFBQWEsUUFReEI7QUFjRDs7Ozs7O0dBTUc7QUFDSCxJQUFZLHFCQUtYO0FBTEQsV0FBWSxxQkFBcUI7SUFDL0IsaURBQXdCLENBQUE7SUFDeEIsNkNBQW9CLENBQUE7SUFDcEIsaURBQXdCLENBQUE7SUFDeEIsaURBQXdCLENBQUE7QUFDMUIsQ0FBQyxFQUxXLHFCQUFxQixxQ0FBckIscUJBQXFCLFFBS2hDO0FBY0Q7Ozs7O0dBS0c7QUFDVSxRQUFBLFlBQVksR0FBcUM7SUFDNUQsTUFBTSxFQUFFLENBQUMsYUFBYSxDQUFDLE1BQU0sQ0FBQztJQUM5QixJQUFJLEVBQUUsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDO0lBQzFCLE1BQU0sRUFBRSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQUM7SUFDOUIsTUFBTSxFQUFFLENBQUMsYUFBYSxDQUFDLE1BQU0sQ0FBQztJQUM5QixhQUFhLEVBQUUsQ0FBQyxhQUFhLENBQUMsTUFBTSxFQUFFLGFBQWEsQ0FBQyxNQUFNLENBQUM7SUFDM0QsV0FBVyxFQUFFLENBQUMsYUFBYSxDQUFDLElBQUksRUFBRSxhQUFhLENBQUMsTUFBTSxDQUFDO0lBQ3ZELEdBQUcsRUFBRTtRQUNILGFBQWEsQ0FBQyxNQUFNO1FBQ3BCLGFBQWEsQ0FBQyxJQUFJO1FBQ2xCLGFBQWEsQ0FBQyxNQUFNO1FBQ3BCLGFBQWEsQ0FBQyxNQUFNO0tBQ3JCO0NBQ0YsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQGRlc2NyaXB0aW9uIERhdGFiYXNlIG9wZXJhdGlvbiBrZXkgY29uc3RhbnRzXG4gKiBAc3VtbWFyeSBFbnVtIGRlZmluaW5nIENSVUQgb3BlcmF0aW9ucyBhbmQgdGhlaXIgbGlmZWN5Y2xlIHBoYXNlc1xuICogQGVudW0ge3N0cmluZ31cbiAqIEByZWFkb25seVxuICogQG1lbWJlck9mIG1vZHVsZTpkYi1kZWNvcmF0b3JzXG4gKi9cbmV4cG9ydCBlbnVtIE9wZXJhdGlvbktleXMge1xuICBSRUZMRUNUID0gXCJkZWNhZi5tb2RlbC5kYi5vcGVyYXRpb25zLlwiLFxuICBDUkVBVEUgPSBcImNyZWF0ZVwiLFxuICBSRUFEID0gXCJyZWFkXCIsXG4gIFVQREFURSA9IFwidXBkYXRlXCIsXG4gIERFTEVURSA9IFwiZGVsZXRlXCIsXG4gIE9OID0gXCJvbi5cIixcbiAgQUZURVIgPSBcImFmdGVyLlwiLFxufVxuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUeXBlIGZvciBiYXNpYyBDUlVEIG9wZXJhdGlvbnNcbiAqIEBzdW1tYXJ5IFVuaW9uIHR5cGUgb2YgdGhlIGZvdXIgYmFzaWMgZGF0YWJhc2Ugb3BlcmF0aW9uczogY3JlYXRlLCByZWFkLCB1cGRhdGUsIGRlbGV0ZVxuICogQHR5cGVkZWYge3N0cmluZ30gQ3J1ZE9wZXJhdGlvbnNcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGItZGVjb3JhdG9yc1xuICovXG5leHBvcnQgdHlwZSBDcnVkT3BlcmF0aW9ucyA9XG4gIHwgT3BlcmF0aW9uS2V5cy5DUkVBVEVcbiAgfCBPcGVyYXRpb25LZXlzLlJFQURcbiAgfCBPcGVyYXRpb25LZXlzLlVQREFURVxuICB8IE9wZXJhdGlvbktleXMuREVMRVRFO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBCdWxrIGRhdGFiYXNlIG9wZXJhdGlvbiBrZXkgY29uc3RhbnRzXG4gKiBAc3VtbWFyeSBFbnVtIGRlZmluaW5nIGJ1bGsgQ1JVRCBvcGVyYXRpb25zIGZvciBoYW5kbGluZyBtdWx0aXBsZSByZWNvcmRzIGF0IG9uY2VcbiAqIEBlbnVtIHtzdHJpbmd9XG4gKiBAcmVhZG9ubHlcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGItZGVjb3JhdG9yc1xuICovXG5leHBvcnQgZW51bSBCdWxrQ3J1ZE9wZXJhdGlvbktleXMge1xuICBDUkVBVEVfQUxMID0gXCJjcmVhdGVBbGxcIixcbiAgUkVBRF9BTEwgPSBcInJlYWRBbGxcIixcbiAgVVBEQVRFX0FMTCA9IFwidXBkYXRlQWxsXCIsXG4gIERFTEVURV9BTEwgPSBcImRlbGV0ZUFsbFwiLFxufVxuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUeXBlIGZvciBidWxrIENSVUQgb3BlcmF0aW9uc1xuICogQHN1bW1hcnkgVW5pb24gdHlwZSBvZiB0aGUgZm91ciBidWxrIGRhdGFiYXNlIG9wZXJhdGlvbnMgZm9yIGhhbmRsaW5nIG11bHRpcGxlIHJlY29yZHMgYXQgb25jZVxuICogQHR5cGVkZWYge3N0cmluZ30gQnVsa0NydWRPcGVyYXRpb25zXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmRiLWRlY29yYXRvcnNcbiAqL1xuZXhwb3J0IHR5cGUgQnVsa0NydWRPcGVyYXRpb25zID1cbiAgfCBCdWxrQ3J1ZE9wZXJhdGlvbktleXMuQ1JFQVRFX0FMTFxuICB8IEJ1bGtDcnVkT3BlcmF0aW9uS2V5cy5SRUFEX0FMTFxuICB8IEJ1bGtDcnVkT3BlcmF0aW9uS2V5cy5VUERBVEVfQUxMXG4gIHwgQnVsa0NydWRPcGVyYXRpb25LZXlzLkRFTEVURV9BTEw7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEdyb3VwZWQgQ1JVRCBvcGVyYXRpb25zIGZvciBkZWNvcmF0b3IgbWFwcGluZ1xuICogQHN1bW1hcnkgTWFwcyBvdXQgZ3JvdXBzIG9mIENSVUQgb3BlcmF0aW9ucyBmb3IgZWFzaWVyIG1hcHBpbmcgb2YgZGVjb3JhdG9yc1xuICogQGNvbnN0IERCT3BlcmF0aW9uc1xuICogQG1lbWJlck9mIG1vZHVsZTpkYi1kZWNvcmF0b3JzXG4gKi9cbmV4cG9ydCBjb25zdCBEQk9wZXJhdGlvbnM6IFJlY29yZDxzdHJpbmcsIENydWRPcGVyYXRpb25zW10+ID0ge1xuICBDUkVBVEU6IFtPcGVyYXRpb25LZXlzLkNSRUFURV0sXG4gIFJFQUQ6IFtPcGVyYXRpb25LZXlzLlJFQURdLFxuICBVUERBVEU6IFtPcGVyYXRpb25LZXlzLlVQREFURV0sXG4gIERFTEVURTogW09wZXJhdGlvbktleXMuREVMRVRFXSxcbiAgQ1JFQVRFX1VQREFURTogW09wZXJhdGlvbktleXMuQ1JFQVRFLCBPcGVyYXRpb25LZXlzLlVQREFURV0sXG4gIFJFQURfQ1JFQVRFOiBbT3BlcmF0aW9uS2V5cy5SRUFELCBPcGVyYXRpb25LZXlzLkNSRUFURV0sXG4gIEFMTDogW1xuICAgIE9wZXJhdGlvbktleXMuQ1JFQVRFLFxuICAgIE9wZXJhdGlvbktleXMuUkVBRCxcbiAgICBPcGVyYXRpb25LZXlzLlVQREFURSxcbiAgICBPcGVyYXRpb25LZXlzLkRFTEVURSxcbiAgXSxcbn07XG4iXX0=

package/lib/operations/constants.d.ts

@@ -1,8 +1,9 @@
 /**
- * @summary Set of constants to define db CRUD operations and their equivalent 'on' and 'after' phases
- * @const OperationKeys
- *
- * @memberOf module:db-decorators.Operations
+ * @description Database operation key constants
+ * @summary Enum defining CRUD operations and their lifecycle phases
+ * @enum {string}
+ * @readonly
+ * @memberOf module:db-decorators
  */
 export declare enum OperationKeys {
     REFLECT = "decaf.model.db.operations.",
@@ -13,19 +14,37 @@ export declare enum OperationKeys {
     ON = "on.",
     AFTER = "after."
 }
+/**
+ * @description Type for basic CRUD operations
+ * @summary Union type of the four basic database operations: create, read, update, delete
+ * @typedef {string} CrudOperations
+ * @memberOf module:db-decorators
+ */
 export type CrudOperations = OperationKeys.CREATE | OperationKeys.READ | OperationKeys.UPDATE | OperationKeys.DELETE;
+/**
+ * @description Bulk database operation key constants
+ * @summary Enum defining bulk CRUD operations for handling multiple records at once
+ * @enum {string}
+ * @readonly
+ * @memberOf module:db-decorators
+ */
 export declare enum BulkCrudOperationKeys {
     CREATE_ALL = "createAll",
     READ_ALL = "readAll",
     UPDATE_ALL = "updateAll",
     DELETE_ALL = "deleteAll"
 }
+/**
+ * @description Type for bulk CRUD operations
+ * @summary Union type of the four bulk database operations for handling multiple records at once
+ * @typedef {string} BulkCrudOperations
+ * @memberOf module:db-decorators
+ */
 export type BulkCrudOperations = BulkCrudOperationKeys.CREATE_ALL | BulkCrudOperationKeys.READ_ALL | BulkCrudOperationKeys.UPDATE_ALL | BulkCrudOperationKeys.DELETE_ALL;
 /**
+ * @description Grouped CRUD operations for decorator mapping
  * @summary Maps out groups of CRUD operations for easier mapping of decorators
- *
- * @constant DBOperations
- *
- * @memberOf module:db-decorators.Operations
+ * @const DBOperations
+ * @memberOf module:db-decorators
  */
 export declare const DBOperations: Record<string, CrudOperations[]>;