@catbee/utils 0.0.8-rc.0 → 0.0.8-rc.2

package/build/esm/utils/decorators.utils.d.ts

@@ -1,5 +1,26 @@
 import type { RequestHandler, Router } from 'express';
 import 'reflect-metadata';
+type Constructor<T = any> = new (...args: any[]) => T;
+export declare class DIContainer {
+    private instances;
+    private constructing;
+    register<T>(target: Constructor<T>): void;
+    get<T>(target: Constructor<T>): T;
+    clear(): void;
+}
+/**
+ * Injectable decorator for marking classes as injectable.
+ *
+ * @returns Class decorator that marks a class as injectable and registers it with the DI container.
+ */
+export declare function Injectable(): ClassDecorator;
+/**
+ * Inject decorator for injecting dependencies into class properties.
+ *
+ * @param targetClass - The class to inject
+ * @returns Property decorator that injects the specified class into the property
+ */
+export declare function Inject<T>(targetClass: new (...args: any[]) => T): PropertyDecorator;
 /**
  * Decorator for GET HTTP method routes.
  *
@@ -212,8 +233,8 @@ export declare function HttpCode(status: number): MethodDecorator;
 /**
  * Decorator that adds a custom HTTP header to the response.
  *
- * @param name - Header name
- * @param value - Header value
+ * @param header - Header name-value pairs or a single header name and value
+ * @param value - Header value if a single header name is provided
  * @returns Method decorator
  *
  * @example
@@ -224,9 +245,38 @@ export declare function HttpCode(status: number): MethodDecorator;
  *   // Response will include the Cache-Control header
  *   return { data: '...' };
  * }
+ */
+export declare function Header(name: string, value: string): MethodDecorator & ClassDecorator;
+/**
+ * Decorator that adds a custom HTTP headers to the response.
+ *
+ * @param headers - Header name-value pairs or a single header name and value
+ * @param value - Header value if a single header name is provided
+ * @returns Method decorator
+ *
+ * @example
+ * ```ts
+ * @Get('/data')
+ * @Headers('Cache-Control', 'max-age=60')
+ * getData() {
+ *   // Response will include the Cache-Control header
+ *   return { data: '...' };
+ * }
+ *
+ * @Get('/data/:id')
+ * @Headers({
+ *   'Cache-Control': 'max-age=60',
+ *   'X-Custom-Header': 'custom-value',
+ *   'Content-Security-Policy': "default-src 'self'"
+ * })
+ * getData() {
+ *   // Response will include all specified headers
+ *   return { data: '...' };
+ * }
+ *
  * ```
  */
-export declare function Header(name: string, value: string): MethodDecorator;
+export declare function Headers(headers: Record<string, string> | string, value?: string): MethodDecorator & ClassDecorator;
 /**
  * Decorator that registers a function to run before route handler execution.
  * Useful for pre-processing or logging.
@@ -266,6 +316,8 @@ export declare function After(fn: Function): MethodDecorator;
  * Decorator that requires specific roles for accessing a route.
  * Must be used with authentication middleware.
  *
+ * Check req.user.roles for user roles[].
+ *
  * @param roles - List of roles that can access this route
  * @returns Method decorator
  *
@@ -279,7 +331,7 @@ export declare function After(fn: Function): MethodDecorator;
  * }
  * ```
  */
-export declare function Roles(...roles: string[]): MethodDecorator;
+export declare function Roles(...roles: string[]): MethodDecorator & ClassDecorator;
 /**
  * Decorator that redirects to another URL.
  *
@@ -304,6 +356,150 @@ export declare function Roles(...roles: string[]): MethodDecorator;
  * ```
  */
 export declare function Redirect(url?: string, statusCode?: number): MethodDecorator;
+/**
+ * Decorator that adds caching to a route response.
+ *
+ * @param ttlSeconds - Time to live in seconds for the cache
+ * @returns Method decorator
+ *
+ * @example
+ * ```ts
+ * @Get('/data')
+ * @Cache(300) // Cache for 5 minutes
+ * getData() {
+ *   return { data: 'expensive operation result' };
+ * }
+ * ```
+ */
+export declare function Cache(ttlSeconds: number): MethodDecorator & ClassDecorator;
+/**
+ * Decorator that applies rate limiting to a route.
+ * Note: Requires 'express-rate-limit' package to be installed.
+ *
+ * @param limit - Maximum number of requests allowed in the window
+ * @param windowMs - Time window in milliseconds
+ * @returns Method decorator
+ *
+ * Default Options:
+ *  - standardHeaders: true
+ *  - legacyHeaders: false
+ *
+ * @example
+ * ```ts
+ * @Post('/login')
+ * @RateLimit({ max: 5, windowMs: 60000, standardHeaders: true, legacyHeaders: false }) // 5 requests per minute
+ * login(@Body() credentials: LoginDto) {
+ *   return this.authService.login(credentials);
+ * }
+ * ```
+ */
+export declare function RateLimit(options: {
+    max: number;
+    windowMs: number;
+    standardHeaders?: boolean;
+    legacyHeaders?: boolean;
+}): MethodDecorator & ClassDecorator;
+/**
+ * Decorator that sets the content type for the response.
+ *
+ * @param type - MIME type for the response
+ * @returns Method decorator
+ *
+ * @example
+ * ```ts
+ * @Get('/download')
+ * @ContentType('application/pdf')
+ * downloadPdf() {
+ *   return this.fileService.generatePdf();
+ * }
+ * ```
+ */
+export declare function ContentType(type: string): MethodDecorator;
+/**
+ * Decorator that adds API versioning to a route.
+ *
+ * @param version - Version string for the API endpoint
+ * @param options - Versioning options
+ * @returns Method decorator
+ *
+ * Default Options:
+ *  - addPrefix: true
+ *  - addHeader: true
+ *  - headerName: 'X-API-Version'
+ *
+ * @example
+ * ```ts
+ *
+ * @Get('/users')
+ * @Version('v2')
+ * getUsersV2() {
+ *   return this.userService.findAllV2();
+ * }
+ *
+ * @Get('/users')
+ * @Version('v2', { addPrefix: true, addHeader: true, headerName: 'X-API-Version' })
+ * getUsersV2() {
+ *   // Route becomes /v2/users
+ *   return this.userService.findAllV2();
+ * }
+ * ```
+ */
+export declare function Version(version: string, options?: {
+    addPrefix?: boolean;
+    addHeader?: boolean;
+    headerName?: string;
+}): MethodDecorator & ClassDecorator;
+/**
+ * Decorator that sets a timeout for route execution.
+ *
+ * @param ms - Timeout in milliseconds
+ * @returns Method decorator
+ *
+ * @example
+ * ```ts
+ * @Get('/slow-operation')
+ * @Timeout(30000) // 30 second timeout
+ * slowOperation() {
+ *   return this.heavyService.processData();
+ * }
+ * ```
+ */
+export declare function Timeout(ms: number): MethodDecorator & ClassDecorator;
+/**
+ * Decorator that adds comprehensive logging to a route.
+ *
+ * @param options - Logging configuration options
+ * @returns Method decorator
+ *
+ * Default Options:
+ *  - logEntry: true
+ *  - logExit: true
+ *  - logBody: false
+ *  - logParams: false
+ *  - logResponse: false
+ *
+ * @example
+ * ```ts
+ * @Post('/users')
+ * @Log({
+ *   logEntry: true,
+ *   logExit: true,
+ *   logBody: true,
+ *   logParams: true,
+ *   logResponse: false
+ * })
+ * createUser(@Body() userData: any) {
+ *   return this.userService.create(userData);
+ * }
+ * ```
+ */
+export declare function Log(options?: {
+    logEntry?: boolean;
+    logExit?: boolean;
+    logBody?: boolean;
+    logParams?: boolean;
+    logResponse?: boolean;
+}): MethodDecorator & ClassDecorator;
 /**
  * Registers all controller classes with the provided router.
  * This function processes all decorators and sets up the Express routes.
@@ -312,4 +508,4 @@ export declare function Redirect(url?: string, statusCode?: number): MethodDecor
  * @param controllers - Array of controller classes
  */
 export declare function registerControllers(router: Router, controllers: any[]): void;
-//# sourceMappingURL=decorators.utils.d.ts.map
+export {};