@hemia/common 0.0.3 → 0.0.5

package/dist/hemia-common.esm.js

@@ -8,7 +8,10 @@ const METADATA_KEYS = {
     REDIRECT: 'redirect',
     GUARDS: 'hemia:guards',
     INTERCEPTORS: 'hemia:interceptors',
-    CUSTOM: 'hemia:custom'
+    CUSTOM: 'hemia:custom',
+    SERIALIZE: 'hemia:serialize',
+    ROLES: 'hemia:roles',
+    PERMISSIONS: 'hemia:permissions'
 };
 
 const Controller = (basePath = '/') => {
@@ -135,6 +138,30 @@ function UseInterceptors(...interceptors) {
     };
 }
 
+/**
+ * Decorador que asigna metadata personalizada a una clase o método.
+ * @param metadataKey La clave para guardar la metadata (string, symbol, etc.)
+ * @param metadataValue El valor a guardar (objeto, array, primitivo, etc.)
+ */
+const SetMetadata = (metadataKey, metadataValue) => {
+    return (target, key, descriptor) => {
+        if (descriptor) {
+            Reflect.defineMetadata(metadataKey, metadataValue, descriptor.value);
+            return descriptor;
+        }
+        Reflect.defineMetadata(metadataKey, metadataValue, target);
+        return target;
+    };
+};
+
+/**
+ * Decorador que transforma la respuesta saliente a una instancia del DTO proporcionado.
+ * @param dto La clase DTO a la que quieres convertir la respuesta.
+ */
+function Serialize(dto) {
+    return SetMetadata(METADATA_KEYS.SERIALIZE, dto);
+}
+
 class ApiResponse {
     static success(data, message = 'OK', status = 200) {
         return {
@@ -223,4 +250,4 @@ class HttpErrorWithDetails extends HttpError {
     }
 }
 
-export { ApiResponse, BadRequestError, Body, ConflictError, Controller, CustomHttpError, Delete, ForbiddenError, GatewayTimeoutError, Get, Head, Header, Headers, Host, HttpError, HttpErrorWithDetails, HttpMethod, InternalServerError, Ip, METADATA_KEYS, Next, NotFoundError, Options, Param, ParamType, Patch, Post, Put, Query, Redirect, Req, Request, Res, Response, ServiceUnavailableError, Session, UnauthorizedError, UnprocessableEntityError, UseGuards, UseInterceptors, isRedirectResponse };
+export { ApiResponse, BadRequestError, Body, ConflictError, Controller, CustomHttpError, Delete, ForbiddenError, GatewayTimeoutError, Get, Head, Header, Headers, Host, HttpError, HttpErrorWithDetails, HttpMethod, InternalServerError, Ip, METADATA_KEYS, Next, NotFoundError, Options, Param, ParamType, Patch, Post, Put, Query, Redirect, Req, Request, Res, Response, Serialize, ServiceUnavailableError, Session, SetMetadata, UnauthorizedError, UnprocessableEntityError, UseGuards, UseInterceptors, isRedirectResponse };

package/dist/hemia-common.js

@@ -10,7 +10,10 @@ const METADATA_KEYS = {
     REDIRECT: 'redirect',
     GUARDS: 'hemia:guards',
     INTERCEPTORS: 'hemia:interceptors',
-    CUSTOM: 'hemia:custom'
+    CUSTOM: 'hemia:custom',
+    SERIALIZE: 'hemia:serialize',
+    ROLES: 'hemia:roles',
+    PERMISSIONS: 'hemia:permissions'
 };
 
 const Controller = (basePath = '/') => {
@@ -137,6 +140,30 @@ function UseInterceptors(...interceptors) {
     };
 }
 
+/**
+ * Decorador que asigna metadata personalizada a una clase o método.
+ * @param metadataKey La clave para guardar la metadata (string, symbol, etc.)
+ * @param metadataValue El valor a guardar (objeto, array, primitivo, etc.)
+ */
+const SetMetadata = (metadataKey, metadataValue) => {
+    return (target, key, descriptor) => {
+        if (descriptor) {
+            Reflect.defineMetadata(metadataKey, metadataValue, descriptor.value);
+            return descriptor;
+        }
+        Reflect.defineMetadata(metadataKey, metadataValue, target);
+        return target;
+    };
+};
+
+/**
+ * Decorador que transforma la respuesta saliente a una instancia del DTO proporcionado.
+ * @param dto La clase DTO a la que quieres convertir la respuesta.
+ */
+function Serialize(dto) {
+    return SetMetadata(METADATA_KEYS.SERIALIZE, dto);
+}
+
 class ApiResponse {
     static success(data, message = 'OK', status = 200) {
         return {
@@ -257,8 +284,10 @@ exports.Req = Req;
 exports.Request = Request;
 exports.Res = Res;
 exports.Response = Response;
+exports.Serialize = Serialize;
 exports.ServiceUnavailableError = ServiceUnavailableError;
 exports.Session = Session;
+exports.SetMetadata = SetMetadata;
 exports.UnauthorizedError = UnauthorizedError;
 exports.UnprocessableEntityError = UnprocessableEntityError;
 exports.UseGuards = UseGuards;

package/dist/types/decorators/auth/index.d.ts

@@ -0,0 +1,2 @@
+export * from './roles.decorator';
+export * from './permissions.decorator';

package/dist/types/decorators/auth/permissions.decorator.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Define los permisos específicos requeridos para acceder a un recurso.
+ * @param permissions Lista de permisos (ej: 'read:users', 'write:posts')
+ */
+export declare const Permissions: (...permissions: string[]) => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

package/dist/types/decorators/auth/roles.decorator.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Define los roles requeridos para acceder a un recurso.
+ * @param roles Lista de roles (ej: 'admin', 'user')
+ */
+export declare const Roles: (...roles: string[]) => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

package/dist/types/decorators/core/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./use-guards.decorator";
 export * from "./use-interceptors.decorator";
+export * from "./set-metadata.decorator";
+export * from "./serialize.decorator";

package/dist/types/decorators/core/serialize.decorator.d.ts

@@ -0,0 +1,9 @@
+import { Type } from "../../interfaces";
+export interface SerializeOptions {
+    excludeExtraneousValues?: boolean;
+}
+/**
+ * Decorador que transforma la respuesta saliente a una instancia del DTO proporcionado.
+ * @param dto La clase DTO a la que quieres convertir la respuesta.
+ */
+export declare function Serialize(dto: Type<any>): (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

package/dist/types/decorators/core/set-metadata.decorator.d.ts

@@ -0,0 +1,7 @@
+import 'reflect-metadata';
+/**
+ * Decorador que asigna metadata personalizada a una clase o método.
+ * @param metadataKey La clave para guardar la metadata (string, symbol, etc.)
+ * @param metadataValue El valor a guardar (objeto, array, primitivo, etc.)
+ */
+export declare const SetMetadata: <K = string | symbol, V = any>(metadataKey: K, metadataValue: V) => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

package/dist/types/decorators/metadata.d.ts

@@ -7,4 +7,7 @@ export declare const METADATA_KEYS: {
     readonly GUARDS: "hemia:guards";
     readonly INTERCEPTORS: "hemia:interceptors";
     readonly CUSTOM: "hemia:custom";
+    readonly SERIALIZE: "hemia:serialize";
+    readonly ROLES: "hemia:roles";
+    readonly PERMISSIONS: "hemia:permissions";
 };

package/dist/types/errors/domain.error.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Errores de lógica de negocio (Business Layer)
+ * No conocen HTTP, son agnósticos a la infraestructura
+ */
+export declare class DomainError extends Error {
+    constructor(message: string);
+}
+export declare class EntityNotFoundError extends DomainError {
+    constructor(entity: string, criteria: string);
+}
+export declare class DuplicateEntityError extends DomainError {
+    constructor(entity: string, criteria: string);
+}
+export declare class ValidationError extends DomainError {
+    constructor(message: string);
+}
+export declare class BusinessRuleViolationError extends DomainError {
+    constructor(message: string);
+}
+export declare class OperationNotAllowedError extends DomainError {
+    constructor(operation: string);
+}
+export declare class DependencyError extends DomainError {
+    constructor(dependency: string, message: string);
+}
+export declare class TimeoutError extends DomainError {
+    constructor(operation: string, timeout: number);
+}
+export declare class ResourceLimitExceededError extends DomainError {
+    constructor(resource: string, limit: number);
+}
+export declare class ConfigurationError extends DomainError {
+    constructor(message: string);
+}

package/dist/types/errors/infrastructure.error.d.ts

@@ -0,0 +1,40 @@
+export declare class InfrastructureError extends Error {
+    readonly originalError?: Error | undefined;
+    constructor(message: string, originalError?: Error | undefined);
+}
+export declare class InfraDatabaseConnectionError extends InfrastructureError {
+    constructor(dbType: string, originalError?: Error);
+}
+export declare class InfraCacheConnectionError extends InfrastructureError {
+    constructor(cacheType: string, originalError?: Error);
+}
+export declare class InfraMessageQueueError extends InfrastructureError {
+    constructor(queueType: string, originalError?: Error);
+}
+export declare class InfraExternalServiceError extends InfrastructureError {
+    constructor(serviceName: string, originalError?: Error);
+}
+export declare class InfraConfigurationError extends InfrastructureError {
+    constructor(configItem: string, originalError?: Error);
+}
+export declare class InfraNetworkError extends InfrastructureError {
+    constructor(message: string, originalError?: Error);
+}
+export declare class InfraTimeoutError extends InfrastructureError {
+    constructor(operation: string, timeout: number, originalError?: Error);
+}
+export declare class InfraAuthenticationError extends InfrastructureError {
+    constructor(message: string, originalError?: Error);
+}
+export declare class InfraAuthorizationError extends InfrastructureError {
+    constructor(message: string, originalError?: Error);
+}
+export declare class InfraServiceUnavailableError extends InfrastructureError {
+    constructor(serviceName: string, originalError?: Error);
+}
+export declare class InfraDataSerializationError extends InfrastructureError {
+    constructor(dataType: string, originalError?: Error);
+}
+export declare class InfraDataDeserializationError extends InfrastructureError {
+    constructor(dataType: string, originalError?: Error);
+}

package/dist/types/errors/persistence.error.d.ts

@@ -0,0 +1,43 @@
+export declare class PersistenceError extends Error {
+    readonly originalError?: Error | undefined;
+    constructor(message: string, originalError?: Error | undefined);
+}
+export declare class DataNotFoundError extends PersistenceError {
+    constructor(entity: string, criteria: string, originalError?: Error);
+}
+export declare class DataConflictError extends PersistenceError {
+    constructor(entity: string, criteria: string, originalError?: Error);
+}
+export declare class DataValidationError extends PersistenceError {
+    constructor(message: string, originalError?: Error);
+}
+export declare class TransactionError extends PersistenceError {
+    constructor(message: string, originalError?: Error);
+}
+export declare class QueryExecutionError extends PersistenceError {
+    constructor(query: string, originalError?: Error);
+}
+export declare class ConnectionError extends PersistenceError {
+    constructor(databaseType: string, originalError?: Error);
+}
+export declare class SchemaMismatchError extends PersistenceError {
+    constructor(expectedSchema: string, actualSchema: string, originalError?: Error);
+}
+export declare class DataIntegrityError extends PersistenceError {
+    constructor(message: string, originalError?: Error);
+}
+export declare class BackupError extends PersistenceError {
+    constructor(message: string, originalError?: Error);
+}
+export declare class RestoreError extends PersistenceError {
+    constructor(message: string, originalError?: Error);
+}
+export declare class IndexingError extends PersistenceError {
+    constructor(indexName: string, originalError?: Error);
+}
+export declare class DataMigrationError extends PersistenceError {
+    constructor(migrationName: string, originalError?: Error);
+}
+export declare class ResourceLimitError extends PersistenceError {
+    constructor(resourceType: string, limit: number, originalError?: Error);
+}

package/dist/types/interfaces/configuration/aws-s3-configuration.interface.d.ts

@@ -0,0 +1,6 @@
+export interface AWSS3Configuration {
+    ACCESS_KEY: string;
+    SECRET_KEY: string;
+    REGION: string;
+    BUCKET_NAME?: string;
+}

package/dist/types/interfaces/configuration/drizzle-db-configuration.interface.d.ts

@@ -0,0 +1,7 @@
+export interface PostgresDBConfiguration {
+    POSTGRES_HOST: string;
+    POSTGRES_PORT: number;
+    POSTGRES_USER: string;
+    POSTGRES_PASSWORD: string;
+    POSTGRES_DB: string;
+}

package/dist/types/interfaces/configuration/mongo-db-configuration.interface.d.ts

@@ -0,0 +1,7 @@
+export interface MongoDBConfiguration {
+    DB: string;
+    HOST: string;
+    PASS: string;
+    SOURCE: string;
+    USER: string;
+}

package/dist/types/interfaces/configuration/olap-db-configuration.interface.d.ts

@@ -0,0 +1,6 @@
+export interface OlapDBConfiguration {
+    OLAPDB_USER: string;
+    OLAPDB_PASSWORD: string;
+    OLAPDB_HOST: string;
+    OLAPDB_DATABASE: string;
+}

package/dist/types/interfaces/configuration/redis-configuration.interface.d.ts

@@ -0,0 +1,8 @@
+export interface RedisConfiguration {
+    REDIS_HOST: string;
+    REDIS_PORT: number;
+    REDIS_PASSWORD: string;
+    REDIS_DB: string;
+    REDIS_TLS: boolean;
+    REDIS_USER?: string;
+}

package/dist/types/interfaces/index.d.ts

@@ -7,3 +7,8 @@ export * from "./features/arguments-host.interface";
 export * from './type.interface';
 export * from './handler.interface';
 export * from './interceptor.interface';
+export * from './configuration/redis-configuration.interface';
+export * from './configuration/mongo-db-configuration.interface';
+export * from './configuration/aws-s3-configuration.interface';
+export * from './configuration/drizzle-db-configuration.interface';
+export * from './configuration/olap-db-configuration.interface';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hemia/common",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Paquete común para proyectos de Hemia",
   "main": "dist/hemia-common.js",
   "module": "dist/hemia-common.esm.js",