@decaf-ts/db-decorators
Version:
Agnostic database decorators and repository
96 lines • 12.6 kB
JavaScript
import { Hashing } from "@decaf-ts/decorator-validation";
import { OperationsRegistry } from "./OperationsRegistry.js";
import { OperationKeys } from "./constants.js";
/**
* @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');
*
* @mermaid
* classDiagram
* class Operations {
* -registry: OperationsRegistry
* +getHandlerName(handler)
* +key(str)
* +get(targetName, propKey, operation)
* -getOpRegistry()
* +register(handler, operation, target, propKey)
* }
* Operations --> OperationsRegistry : uses
*/
export class Operations {
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) {
if (handler.name)
return handler.name;
console.warn("Handler name not defined. A name will be generated, but this is not desirable. please avoid using anonymous functions");
return Hashing.hash(handler.toString());
}
/**
* @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) {
return OperationKeys.REFLECT + str;
}
/**
* @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(targetName, propKey, operation) {
return Operations.registry.get(targetName, propKey, operation);
}
/**
* @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
*/
static getOpRegistry() {
if (!Operations.registry)
Operations.registry = new OperationsRegistry();
return Operations.registry;
}
/**
* @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(handler, operation, target, propKey) {
Operations.getOpRegistry().register(handler, operation, target, propKey);
}
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"Operations.js","sourceRoot":"","sources":["../../../src/operations/Operations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAS,MAAM,gCAAgC,CAAC;AAEhE,OAAO,EAAE,kBAAkB,EAAE,gCAA6B;AAC1D,OAAO,EAAE,aAAa,EAAE,uBAAoB;AAK5C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,UAAU;IAGrB,gBAAuB,CAAC;IAExB;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,OAAkD;QACtE,IAAI,OAAO,CAAC,IAAI;YAAE,OAAO,OAAO,CAAC,IAAI,CAAC;QAEtC,OAAO,CAAC,IAAI,CACV,uHAAuH,CACxH,CAAC;QACF,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,GAAW;QACpB,OAAO,aAAa,CAAC,OAAO,GAAG,GAAG,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,CAOR,UAAwC,EACxC,OAAe,EACf,SAAiB;QAEjB,OAAO,UAAU,CAAC,QAAQ,CAAC,GAAG,CAC5B,UAAU,EACV,OAAO,EACP,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,aAAa;QAC1B,IAAI,CAAC,UAAU,CAAC,QAAQ;YAAE,UAAU,CAAC,QAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACzE,OAAO,UAAU,CAAC,QAAQ,CAAC;IAC7B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAQ,CACb,OAAsC,EACtC,SAAwB,EACxB,MAAS,EACT,OAAwB;QAExB,UAAU,CAAC,aAAa,EAAE,CAAC,QAAQ,CACjC,OAAc,EACd,SAAS,EACT,MAAM,EACN,OAAO,CACR,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { Hashing, Model } from \"@decaf-ts/decorator-validation\";\nimport { OperationHandler } from \"./types\";\nimport { OperationsRegistry } from \"./OperationsRegistry\";\nimport { OperationKeys } from \"./constants\";\nimport { IRepository } from \"../interfaces\";\nimport { Context } from \"../repository\";\nimport { RepositoryFlags } from \"../repository/types\";\n\n/**\n * @description Static utility class for database operation management\n * @summary Provides functionality for registering, retrieving, and managing database operation handlers\n * @class Operations\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 * // Register a handler for a create operation\n * Operations.register(myHandler, OperationKeys.CREATE, targetModel, 'propertyName');\n * \n * // Get handlers for a specific operation\n * const handlers = Operations.get(targetModel.constructor.name, 'propertyName', 'onCreate');\n * \n * @mermaid\n * classDiagram\n *   class Operations {\n *     -registry: OperationsRegistry\n *     +getHandlerName(handler)\n *     +key(str)\n *     +get(targetName, propKey, operation)\n *     -getOpRegistry()\n *     +register(handler, operation, target, propKey)\n *   }\n *   Operations --> OperationsRegistry : uses\n */\nexport class Operations {\n  private static registry: OperationsRegistry;\n\n  private constructor() {}\n\n  /**\n   * @description Gets a unique name for an operation handler\n   * @summary Returns the name of the handler function or generates a hash if name is not available\n   * @param {OperationHandler<any, any, any, any, any>} handler - The handler function to get the name for\n   * @return {string} The name of the handler or a generated hash\n   */\n  static getHandlerName(handler: OperationHandler<any, any, any, any, any>) {\n    if (handler.name) return handler.name;\n\n    console.warn(\n      \"Handler name not defined. A name will be generated, but this is not desirable. please avoid using anonymous functions\"\n    );\n    return Hashing.hash(handler.toString());\n  }\n\n  /**\n   * @description Generates a reflection metadata key\n   * @summary Creates a fully qualified metadata key by prefixing with the reflection namespace\n   * @param {string} str - The operation key string to prefix\n   * @return {string} The fully qualified metadata key\n   */\n  static key(str: string) {\n    return OperationKeys.REFLECT + str;\n  }\n\n  /**\n   * @description Retrieves operation handlers for a specific target and operation\n   * @summary Gets registered handlers from the operations 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, defaults to object\n   * @template F - Repository flags extending RepositoryFlags\n   * @template C - Context type extending Context<F>\n   * @param {string | Record<string, any>} targetName - 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   * @return {any} The registered handlers for the specified target, property, and operation\n   */\n  static get<\n    M extends Model,\n    R extends IRepository<M, F, C>,\n    V = object,\n    F extends RepositoryFlags = RepositoryFlags,\n    C extends Context<F> = Context<F>,\n  >(\n    targetName: string | Record<string, any>,\n    propKey: string,\n    operation: string\n  ) {\n    return Operations.registry.get<M, R, V, F, C>(\n      targetName,\n      propKey,\n      operation\n    );\n  }\n\n  /**\n   * @description Gets or initializes the operations registry\n   * @summary Returns the existing registry or creates a new one if it doesn't exist\n   * @return {OperationsRegistry} The operations registry instance\n   * @private\n   */\n  private static getOpRegistry() {\n    if (!Operations.registry) Operations.registry = new OperationsRegistry();\n    return Operations.registry;\n  }\n\n  /**\n   * @description Registers an operation handler for a specific target and operation\n   * @summary Adds a handler to the operations registry for a given target, property, and operation\n   * @template V - Model type extending Model\n   * @param {OperationHandler<V, any, any>} handler - The handler function to register\n   * @param {OperationKeys} operation - The operation key to register the handler for\n   * @param {V} target - The target model instance\n   * @param {string | symbol} propKey - The property key to register the handler for\n   * @return {void}\n   */\n  static register<V extends Model>(\n    handler: OperationHandler<V, any, any>,\n    operation: OperationKeys,\n    target: V,\n    propKey: string | symbol\n  ) {\n    Operations.getOpRegistry().register(\n      handler as any,\n      operation,\n      target,\n      propKey\n    );\n  }\n}\n"]}