@hemia/common 0.0.14 → 0.0.15

package/dist/hemia-common.esm.js

@@ -21,6 +21,16 @@ const METADATA_KEYS = {
     MODULE: "hemia:module",
     INJECTION_ID: "hemia:injection_id",
     MANUAL_REGISTER: 'hemia:controller:manual_register',
+    IS_PUBLIC: 'isPublic',
+    ALLOW_ANY: 'allowAny',
+    OWNER_PARAM: 'ownerParam',
+    RATE_LIMIT: 'rateLimit',
+    SCOPES: 'scopes',
+    THROTTLE: 'hemia:throttle',
+    API_KEY: 'hemia:apiKey',
+    IP_WHITELIST: 'hemia:ipWhitelist',
+    POLICIES: 'hemia:policies',
+    FEATURE_FLAGS: 'hemia:featureFlags'
 };
 
 var HttpMethod;
@@ -919,6 +929,105 @@ class ParseDatePipe {
     }
 }
 
+/**
+ * Define los roles requeridos para acceder a un recurso.
+ * @param roles Lista de roles (ej: 'admin', 'user')
+ */
+const Roles = (...roles) => {
+    return SetMetadata(METADATA_KEYS.ROLES, roles);
+};
+
+/**
+ * Define los permisos específicos requeridos para acceder a un recurso.
+ * @param permissions Lista de permisos (ej: 'read:users', 'write:posts')
+ */
+const Permissions = (...permissions) => {
+    return SetMetadata(METADATA_KEYS.PERMISSIONS, permissions);
+};
+
+/**
+ * Marca una ruta como pública, sin requerir autenticación.
+ */
+const Public = () => {
+    return SetMetadata(METADATA_KEYS.IS_PUBLIC, true);
+};
+
+/**
+ * Permite el acceso sin restricciones de roles o permisos.
+ * El usuario debe estar autenticado pero no se validan roles/permisos.
+ */
+const AllowAny = () => {
+    return SetMetadata(METADATA_KEYS.ALLOW_ANY, true);
+};
+
+/**
+ * Valida que el usuario autenticado sea el propietario del recurso.
+ * @param paramName Nombre del parámetro que contiene el ID del propietario (default: 'id')
+ */
+const Owner = (paramName = 'id') => {
+    return SetMetadata(METADATA_KEYS.OWNER_PARAM, paramName);
+};
+
+/**
+ * Limita el número de peticiones por ventana de tiempo.
+ * @param options Configuración de rate limiting
+ */
+const RateLimit = (options) => {
+    return SetMetadata(METADATA_KEYS.RATE_LIMIT, options);
+};
+
+/**
+ * Define los scopes OAuth requeridos para acceder a un recurso.
+ * @param scopes Lista de scopes (ej: 'email', 'profile', 'openid')
+ */
+const Scopes = (...scopes) => {
+    return SetMetadata(METADATA_KEYS.SCOPES, scopes);
+};
+
+/**
+ * Requiere una API Key válida para acceder al recurso.
+ * @param options Configuración de la API Key
+ */
+const ApiKey = (options = {}) => {
+    return SetMetadata(METADATA_KEYS.API_KEY, {
+        headerName: options.headerName || 'X-API-Key',
+        queryParam: options.queryParam || 'apiKey',
+        required: options.required !== false,
+    });
+};
+
+/**
+ * Restringe el acceso solo a las IPs especificadas.
+ * @param ips Lista de direcciones IP permitidas
+ */
+const IpWhitelist = (...ips) => {
+    return SetMetadata(METADATA_KEYS.IP_WHITELIST, ips);
+};
+
+/**
+ * Define políticas de autorización complejas.
+ * @param policies Lista de nombres de políticas a evaluar
+ */
+const PolicyBased = (...policies) => {
+    return SetMetadata(METADATA_KEYS.POLICIES, policies);
+};
+
+/**
+ * Requiere que ciertas feature flags estén habilitadas.
+ * @param flags Lista de feature flags requeridas
+ */
+const FeatureFlag = (...flags) => {
+    return SetMetadata(METADATA_KEYS.FEATURE_FLAGS, flags);
+};
+
+/**
+ * Limita el número de peticiones por usuario en un periodo de tiempo.
+ * @param options Configuración de throttling
+ */
+const Throttle = (options) => {
+    return SetMetadata(METADATA_KEYS.THROTTLE, options);
+};
+
 class ApiResponse {
     static success(data, message = 'OK', status = 200) {
         return {
@@ -938,4 +1047,4 @@ class ApiResponse {
     }
 }
 
-export { ApiResponse, BackupError, BadRequestError, Body, BusinessRuleViolationError, ConfigurationError, ConflictError, ConnectionError, Controller, ControllerRegistry, Cookies, Custom, CustomHttpError, DataConflictError, DataIntegrityError, DataMigrationError, DataNotFoundError, DataValidationError, DefaultValuePipe, Delete, DependencyError, DomainError, DuplicateEntityError, EntityNotFoundError, File, Files, ForbiddenError, GatewayTimeoutError, Get, Head, Header, Headers, Host, HttpError, HttpErrorWithDetails, HttpMethod, IndexingError, InfraAuthenticationError, InfraAuthorizationError, InfraCacheConnectionError, InfraConfigurationError, InfraDataDeserializationError, InfraDataSerializationError, InfraDatabaseConnectionError, InfraExternalServiceError, InfraMessageQueueError, InfraNetworkError, InfraServiceUnavailableError, InfraTimeoutError, InfrastructureError, InternalServerError, Ip, Locale, METADATA_KEYS, ManualRegister, Module, Next, NotFoundError, OperationNotAllowedError, Options, Param, ParamType, ParseArrayPipe, ParseBoolPipe, ParseDatePipe, ParseEnumPipe, ParseFilePipe, ParseFloatPipe, ParseIntPipe, ParseUUIDPipe, Patch, PersistenceError, Post, Put, Query, QueryExecutionError, Redirect, Repository, Req, ReqAuth, ReqContext, ReqPermissions, ReqUser, Request, Res, ResourceLimitError, ResourceLimitExceededError, Response, RestoreError, SchemaMismatchError, Serialize, Service, ServiceUnavailableError, Session, SetMetadata, TimeoutError, TransactionError, Transform, UnauthorizedError, UnprocessableEntityError, UseGuards, UseInterceptors, UsePipes, Validate, ValidationError, ValidationPipe, isRedirectResponse };
+export { AllowAny, ApiKey, ApiResponse, BackupError, BadRequestError, Body, BusinessRuleViolationError, ConfigurationError, ConflictError, ConnectionError, Controller, ControllerRegistry, Cookies, Custom, CustomHttpError, DataConflictError, DataIntegrityError, DataMigrationError, DataNotFoundError, DataValidationError, DefaultValuePipe, Delete, DependencyError, DomainError, DuplicateEntityError, EntityNotFoundError, FeatureFlag, File, Files, ForbiddenError, GatewayTimeoutError, Get, Head, Header, Headers, Host, HttpError, HttpErrorWithDetails, HttpMethod, IndexingError, InfraAuthenticationError, InfraAuthorizationError, InfraCacheConnectionError, InfraConfigurationError, InfraDataDeserializationError, InfraDataSerializationError, InfraDatabaseConnectionError, InfraExternalServiceError, InfraMessageQueueError, InfraNetworkError, InfraServiceUnavailableError, InfraTimeoutError, InfrastructureError, InternalServerError, Ip, IpWhitelist, Locale, METADATA_KEYS, ManualRegister, Module, Next, NotFoundError, OperationNotAllowedError, Options, Owner, Param, ParamType, ParseArrayPipe, ParseBoolPipe, ParseDatePipe, ParseEnumPipe, ParseFilePipe, ParseFloatPipe, ParseIntPipe, ParseUUIDPipe, Patch, Permissions, PersistenceError, PolicyBased, Post, Public, Put, Query, QueryExecutionError, RateLimit, Redirect, Repository, Req, ReqAuth, ReqContext, ReqPermissions, ReqUser, Request, Res, ResourceLimitError, ResourceLimitExceededError, Response, RestoreError, Roles, SchemaMismatchError, Scopes, Serialize, Service, ServiceUnavailableError, Session, SetMetadata, Throttle, TimeoutError, TransactionError, Transform, UnauthorizedError, UnprocessableEntityError, UseGuards, UseInterceptors, UsePipes, Validate, ValidationError, ValidationPipe, isRedirectResponse };

package/dist/hemia-common.js

@@ -23,6 +23,16 @@ const METADATA_KEYS = {
     MODULE: "hemia:module",
     INJECTION_ID: "hemia:injection_id",
     MANUAL_REGISTER: 'hemia:controller:manual_register',
+    IS_PUBLIC: 'isPublic',
+    ALLOW_ANY: 'allowAny',
+    OWNER_PARAM: 'ownerParam',
+    RATE_LIMIT: 'rateLimit',
+    SCOPES: 'scopes',
+    THROTTLE: 'hemia:throttle',
+    API_KEY: 'hemia:apiKey',
+    IP_WHITELIST: 'hemia:ipWhitelist',
+    POLICIES: 'hemia:policies',
+    FEATURE_FLAGS: 'hemia:featureFlags'
 };
 
 exports.HttpMethod = void 0;
@@ -921,6 +931,105 @@ class ParseDatePipe {
     }
 }
 
+/**
+ * Define los roles requeridos para acceder a un recurso.
+ * @param roles Lista de roles (ej: 'admin', 'user')
+ */
+const Roles = (...roles) => {
+    return SetMetadata(METADATA_KEYS.ROLES, roles);
+};
+
+/**
+ * Define los permisos específicos requeridos para acceder a un recurso.
+ * @param permissions Lista de permisos (ej: 'read:users', 'write:posts')
+ */
+const Permissions = (...permissions) => {
+    return SetMetadata(METADATA_KEYS.PERMISSIONS, permissions);
+};
+
+/**
+ * Marca una ruta como pública, sin requerir autenticación.
+ */
+const Public = () => {
+    return SetMetadata(METADATA_KEYS.IS_PUBLIC, true);
+};
+
+/**
+ * Permite el acceso sin restricciones de roles o permisos.
+ * El usuario debe estar autenticado pero no se validan roles/permisos.
+ */
+const AllowAny = () => {
+    return SetMetadata(METADATA_KEYS.ALLOW_ANY, true);
+};
+
+/**
+ * Valida que el usuario autenticado sea el propietario del recurso.
+ * @param paramName Nombre del parámetro que contiene el ID del propietario (default: 'id')
+ */
+const Owner = (paramName = 'id') => {
+    return SetMetadata(METADATA_KEYS.OWNER_PARAM, paramName);
+};
+
+/**
+ * Limita el número de peticiones por ventana de tiempo.
+ * @param options Configuración de rate limiting
+ */
+const RateLimit = (options) => {
+    return SetMetadata(METADATA_KEYS.RATE_LIMIT, options);
+};
+
+/**
+ * Define los scopes OAuth requeridos para acceder a un recurso.
+ * @param scopes Lista de scopes (ej: 'email', 'profile', 'openid')
+ */
+const Scopes = (...scopes) => {
+    return SetMetadata(METADATA_KEYS.SCOPES, scopes);
+};
+
+/**
+ * Requiere una API Key válida para acceder al recurso.
+ * @param options Configuración de la API Key
+ */
+const ApiKey = (options = {}) => {
+    return SetMetadata(METADATA_KEYS.API_KEY, {
+        headerName: options.headerName || 'X-API-Key',
+        queryParam: options.queryParam || 'apiKey',
+        required: options.required !== false,
+    });
+};
+
+/**
+ * Restringe el acceso solo a las IPs especificadas.
+ * @param ips Lista de direcciones IP permitidas
+ */
+const IpWhitelist = (...ips) => {
+    return SetMetadata(METADATA_KEYS.IP_WHITELIST, ips);
+};
+
+/**
+ * Define políticas de autorización complejas.
+ * @param policies Lista de nombres de políticas a evaluar
+ */
+const PolicyBased = (...policies) => {
+    return SetMetadata(METADATA_KEYS.POLICIES, policies);
+};
+
+/**
+ * Requiere que ciertas feature flags estén habilitadas.
+ * @param flags Lista de feature flags requeridas
+ */
+const FeatureFlag = (...flags) => {
+    return SetMetadata(METADATA_KEYS.FEATURE_FLAGS, flags);
+};
+
+/**
+ * Limita el número de peticiones por usuario en un periodo de tiempo.
+ * @param options Configuración de throttling
+ */
+const Throttle = (options) => {
+    return SetMetadata(METADATA_KEYS.THROTTLE, options);
+};
+
 class ApiResponse {
     static success(data, message = 'OK', status = 200) {
         return {
@@ -940,6 +1049,8 @@ class ApiResponse {
     }
 }
 
+exports.AllowAny = AllowAny;
+exports.ApiKey = ApiKey;
 exports.ApiResponse = ApiResponse;
 exports.BackupError = BackupError;
 exports.BadRequestError = BadRequestError;
@@ -964,6 +1075,7 @@ exports.DependencyError = DependencyError;
 exports.DomainError = DomainError;
 exports.DuplicateEntityError = DuplicateEntityError;
 exports.EntityNotFoundError = EntityNotFoundError;
+exports.FeatureFlag = FeatureFlag;
 exports.File = File;
 exports.Files = Files;
 exports.ForbiddenError = ForbiddenError;
@@ -991,6 +1103,7 @@ exports.InfraTimeoutError = InfraTimeoutError;
 exports.InfrastructureError = InfrastructureError;
 exports.InternalServerError = InternalServerError;
 exports.Ip = Ip;
+exports.IpWhitelist = IpWhitelist;
 exports.Locale = Locale;
 exports.METADATA_KEYS = METADATA_KEYS;
 exports.ManualRegister = ManualRegister;
@@ -999,6 +1112,7 @@ exports.Next = Next;
 exports.NotFoundError = NotFoundError;
 exports.OperationNotAllowedError = OperationNotAllowedError;
 exports.Options = Options;
+exports.Owner = Owner;
 exports.Param = Param;
 exports.ParseArrayPipe = ParseArrayPipe;
 exports.ParseBoolPipe = ParseBoolPipe;
@@ -1009,11 +1123,15 @@ exports.ParseFloatPipe = ParseFloatPipe;
 exports.ParseIntPipe = ParseIntPipe;
 exports.ParseUUIDPipe = ParseUUIDPipe;
 exports.Patch = Patch;
+exports.Permissions = Permissions;
 exports.PersistenceError = PersistenceError;
+exports.PolicyBased = PolicyBased;
 exports.Post = Post;
+exports.Public = Public;
 exports.Put = Put;
 exports.Query = Query;
 exports.QueryExecutionError = QueryExecutionError;
+exports.RateLimit = RateLimit;
 exports.Redirect = Redirect;
 exports.Repository = Repository;
 exports.Req = Req;
@@ -1027,12 +1145,15 @@ exports.ResourceLimitError = ResourceLimitError;
 exports.ResourceLimitExceededError = ResourceLimitExceededError;
 exports.Response = Response;
 exports.RestoreError = RestoreError;
+exports.Roles = Roles;
 exports.SchemaMismatchError = SchemaMismatchError;
+exports.Scopes = Scopes;
 exports.Serialize = Serialize;
 exports.Service = Service;
 exports.ServiceUnavailableError = ServiceUnavailableError;
 exports.Session = Session;
 exports.SetMetadata = SetMetadata;
+exports.Throttle = Throttle;
 exports.TimeoutError = TimeoutError;
 exports.TransactionError = TransactionError;
 exports.Transform = Transform;

package/dist/types/decorators/auth/allow-any.decorator.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Permite el acceso sin restricciones de roles o permisos.
+ * El usuario debe estar autenticado pero no se validan roles/permisos.
+ */
+export declare const AllowAny: () => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

package/dist/types/decorators/auth/api-key.decorator.d.ts

@@ -0,0 +1,10 @@
+export interface ApiKeyOptions {
+    headerName?: string;
+    queryParam?: string;
+    required?: boolean;
+}
+/**
+ * Requiere una API Key válida para acceder al recurso.
+ * @param options Configuración de la API Key
+ */
+export declare const ApiKey: (options?: ApiKeyOptions) => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

package/dist/types/decorators/auth/feature-flag.decorator.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Requiere que ciertas feature flags estén habilitadas.
+ * @param flags Lista de feature flags requeridas
+ */
+export declare const FeatureFlag: (...flags: string[]) => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

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

@@ -1,2 +1,12 @@
 export * from './roles.decorator';
 export * from './permissions.decorator';
+export * from './public.decorator';
+export * from './allow-any.decorator';
+export * from './owner.decorator';
+export * from './rate-limit.decorator';
+export * from './scopes.decorator';
+export * from './api-key.decorator';
+export * from './ip-whitelist.decorator';
+export * from './policy-based.decorator';
+export * from './feature-flag.decorator';
+export * from './throttle.decorator';

package/dist/types/decorators/auth/ip-whitelist.decorator.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Restringe el acceso solo a las IPs especificadas.
+ * @param ips Lista de direcciones IP permitidas
+ */
+export declare const IpWhitelist: (...ips: string[]) => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

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

@@ -0,0 +1,5 @@
+/**
+ * Valida que el usuario autenticado sea el propietario del recurso.
+ * @param paramName Nombre del parámetro que contiene el ID del propietario (default: 'id')
+ */
+export declare const Owner: (paramName?: string) => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

package/dist/types/decorators/auth/policy-based.decorator.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Define políticas de autorización complejas.
+ * @param policies Lista de nombres de políticas a evaluar
+ */
+export declare const PolicyBased: (...policies: string[]) => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

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

@@ -0,0 +1,4 @@
+/**
+ * Marca una ruta como pública, sin requerir autenticación.
+ */
+export declare const Public: () => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

package/dist/types/decorators/auth/rate-limit.decorator.d.ts

@@ -0,0 +1,10 @@
+export interface RateLimitOptions {
+    maxRequests: number;
+    windowMs: number;
+    message?: string;
+}
+/**
+ * Limita el número de peticiones por ventana de tiempo.
+ * @param options Configuración de rate limiting
+ */
+export declare const RateLimit: (options: RateLimitOptions) => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

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

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

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

@@ -0,0 +1,10 @@
+export interface ThrottleOptions {
+    limit: number;
+    ttl: number;
+    skipIf?: (context: any) => boolean;
+}
+/**
+ * Limita el número de peticiones por usuario en un periodo de tiempo.
+ * @param options Configuración de throttling
+ */
+export declare const Throttle: (options: ThrottleOptions) => (target: object | Function, key?: string | symbol, descriptor?: PropertyDescriptor) => object;

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

@@ -5,3 +5,4 @@ export * from "./custom";
 export * from "./validation";
 export * from "./transform";
 export * from "./pipes";
+export * from "./auth";

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

@@ -18,4 +18,14 @@ export declare const METADATA_KEYS: {
     readonly MODULE: "hemia:module";
     readonly INJECTION_ID: "hemia:injection_id";
     readonly MANUAL_REGISTER: "hemia:controller:manual_register";
+    readonly IS_PUBLIC: "isPublic";
+    readonly ALLOW_ANY: "allowAny";
+    readonly OWNER_PARAM: "ownerParam";
+    readonly RATE_LIMIT: "rateLimit";
+    readonly SCOPES: "scopes";
+    readonly THROTTLE: "hemia:throttle";
+    readonly API_KEY: "hemia:apiKey";
+    readonly IP_WHITELIST: "hemia:ipWhitelist";
+    readonly POLICIES: "hemia:policies";
+    readonly FEATURE_FLAGS: "hemia:featureFlags";
 };

package/package.json

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