@catbee/utils 2.0.0-next.0 → 2.0.0

package/{decorators/decorators.utils.d.ts → decorator/index.d.ts}

@@ -1,7 +1,7 @@
 /*
  * The MIT License
  * 
- * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
+ * Copyright (c) 2026 Catbee Technologies. https://catbee.in/license
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -22,16 +22,17 @@
  * SOFTWARE.
  */
 
-import 'reflect-metadata';
-import type { RequestHandler, Router } from 'express';
+import * as express_rate_limit from 'express-rate-limit';
+import { RequestHandler, Router } from 'express';
+
 /**
  * Supported HTTP methods for route decorators
  */
-export type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'head' | 'trace' | 'connect';
+type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'head' | 'trace' | 'connect';
 /**
  * Represents a route definition for controller methods
  */
-export interface RouteDefinition {
+interface RouteDefinition {
     /** The URL path for this route */
     path: string;
     /** HTTP method for this route */
@@ -42,7 +43,7 @@ export interface RouteDefinition {
 /**
  * Parameter decoration definition for method parameters
  */
-export interface ParamDefinition {
+interface ParamDefinition {
     /** Parameter position in method signature */
     index: number;
     /** Type of parameter (query, body, etc.) */
@@ -52,15 +53,15 @@ export interface ParamDefinition {
     /** Optional ParamOptions for advanced extraction */
     options?: ParamOptions;
 }
-export type CachedRateLimiter = {
-    limiter: ReturnType<typeof import('express-rate-limit').rateLimit>;
+type CachedRateLimiter = {
+    limiter: ReturnType<typeof express_rate_limit.rateLimit>;
     config: string;
 };
 type Constructor<T = any> = new (...args: any[]) => T;
-export declare class DIContainer {
-    private instances;
-    private constructing;
-    private propertyInjections;
+declare class DIContainer {
+    private readonly instances;
+    private readonly constructing;
+    private readonly propertyInjections;
     register<T>(target: Constructor<T>): void;
     /**
      * Register a property injection to be resolved when the target class is instantiated
@@ -75,14 +76,14 @@ export declare class DIContainer {
  *
  * @returns Class decorator that marks a class as injectable and registers it with the DI container.
  */
-export declare function Injectable(): ClassDecorator;
+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;
+declare function Inject<T>(targetClass: new (...args: any[]) => T): PropertyDecorator;
 /**
  * Inject function for retrieving instances from the DI container.
  * @param targetClass - The class to inject
@@ -92,7 +93,7 @@ export declare function Inject<T>(targetClass: new (...args: any[]) => T): Prope
  * @example
  * const a = inject(TestClass);
  */
-export declare function inject<T>(targetClass: new (...args: any[]) => T): T;
+declare function inject<T>(targetClass: new (...args: any[]) => T): T;
 /**
  * Decorator for GET HTTP method routes.
  *
@@ -107,7 +108,7 @@ export declare function inject<T>(targetClass: new (...args: any[]) => T): T;
  * }
  * ```
  */
-export declare const Get: (path: string) => MethodDecorator;
+declare const Get: (path: string) => MethodDecorator;
 /**
  * Decorator for POST HTTP method routes.
  *
@@ -122,56 +123,56 @@ export declare const Get: (path: string) => MethodDecorator;
  * }
  * ```
  */
-export declare const Post: (path: string) => MethodDecorator;
+declare const Post: (path: string) => MethodDecorator;
 /**
  * Decorator for PUT HTTP method routes.
  *
  * @param path - URL path for the route
  * @returns Method decorator
  */
-export declare const Put: (path: string) => MethodDecorator;
+declare const Put: (path: string) => MethodDecorator;
 /**
  * Decorator for PATCH HTTP method routes.
  *
  * @param path - URL path for the route
  * @returns Method decorator
  */
-export declare const Patch: (path: string) => MethodDecorator;
+declare const Patch: (path: string) => MethodDecorator;
 /**
  * Decorator for DELETE HTTP method routes.
  *
  * @param path - URL path for the route
  * @returns Method decorator
  */
-export declare const Delete: (path: string) => MethodDecorator;
+declare const Delete: (path: string) => MethodDecorator;
 /**
  * Decorator for OPTIONS HTTP method routes.
  *
  * @param path - URL path for the route
  * @returns Method decorator
  */
-export declare const Options: (path: string) => MethodDecorator;
+declare const Options: (path: string) => MethodDecorator;
 /**
  * Decorator for HEAD HTTP method routes.
  *
  * @param path - URL path for the route
  * @returns Method decorator
  */
-export declare const Head: (path: string) => MethodDecorator;
+declare const Head: (path: string) => MethodDecorator;
 /**
  * Decorator for TRACE HTTP method routes.
  *
  * @param path - URL path for the route
  * @returns Method decorator
  */
-export declare const Trace: (path: string) => MethodDecorator;
+declare const Trace: (path: string) => MethodDecorator;
 /**
  * Decorator for CONNECT HTTP method routes.
  *
  * @param path - URL path for the route
  * @returns Method decorator
  */
-export declare const Connect: (path: string) => MethodDecorator;
+declare const Connect: (path: string) => MethodDecorator;
 /**
  * Decorator that marks a class as a controller with a base path.
  * Used as the entry point for routing configuration.
@@ -187,7 +188,7 @@ export declare const Connect: (path: string) => MethodDecorator;
  * }
  * ```
  */
-export declare function Controller(basePath: string): ClassDecorator;
+declare function Controller(basePath: string): ClassDecorator;
 /**
  * Decorator that applies middleware to a controller method or an entire controller.
  * Multiple middlewares can be applied and will execute in order.
@@ -210,7 +211,8 @@ export declare function Controller(basePath: string): ClassDecorator;
  * }
  * ```
  */
-export declare function Use(...middlewares: RequestHandler[]): MethodDecorator & ClassDecorator;
+declare function Use(...middlewares: RequestHandler[]): MethodDecorator & ClassDecorator;
+type StrNumBool = 'string' | 'number' | 'boolean';
 /**
  * Options for parameter decorators
  * @template T - Type of the parameter value after transformation
@@ -224,9 +226,9 @@ export declare function Use(...middlewares: RequestHandler[]): MethodDecorator &
  * @property validate - Custom validation function
  * @property transform - Custom transformation function
  */
-export interface ParamOptions<T = any> {
+interface ParamOptions<T = any> {
     /** Base type of the parameter (default: 'string') */
-    type?: 'string' | 'number' | 'boolean';
+    type?: StrNumBool;
     /** Data structure type (default: 'single') */
     dataType?: 'single' | 'array' | 'object';
     /** Delimiter for array types (default: ',') */
@@ -250,8 +252,8 @@ export interface ParamOptions<T = any> {
     /** Custom transformation function */
     transform?: (value: any) => any;
 }
-export declare function createParamDecorator(type: ParamDefinition['type'], key?: string): (paramKey?: string) => ParameterDecorator;
-export declare function createParamDecoratorWithoutParam(type: ParamDefinition['type']): () => ParameterDecorator;
+declare function createParamDecorator(type: ParamDefinition['type'], key?: string): (paramKey?: string) => ParameterDecorator;
+declare function createParamDecoratorWithoutParam(type: ParamDefinition['type']): () => ParameterDecorator;
 /**
  * Decorator that extracts query parameters from request.
  *
@@ -268,7 +270,7 @@ export declare function createParamDecoratorWithoutParam(type: ParamDefinition['
  * }
  * ```
  */
-export declare const Query: (paramKey?: string, options?: ParamOptions) => ParameterDecorator;
+declare const Query: (paramKey?: string, options?: ParamOptions) => ParameterDecorator;
 /**
  * Decorator that extracts route parameters from request.
  *
@@ -284,7 +286,7 @@ export declare const Query: (paramKey?: string, options?: ParamOptions) => Param
  * }
  * ```
  */
-export declare const Param: (paramKey?: string, options?: ParamOptions) => ParameterDecorator;
+declare const Param: (paramKey?: string, options?: ParamOptions) => ParameterDecorator;
 /**
  * Decorator that extracts body or body property from request.
  *
@@ -304,7 +306,7 @@ export declare const Param: (paramKey?: string, options?: ParamOptions) => Param
  * }
  * ```
  */
-export declare const Body: (paramKey?: string) => ParameterDecorator;
+declare const Body: (paramKey?: string) => ParameterDecorator;
 /**
  * Decorator that injects a logger instance.
  * @returns Parameter decorator
@@ -317,7 +319,7 @@ export declare const Body: (paramKey?: string) => ParameterDecorator;
  * }
  * ```
  */
-export declare const ReqLogger: () => ParameterDecorator;
+declare const ReqLogger: () => ParameterDecorator;
 /**
  * Decorator that extracts request ID from headers.
  * @returns Parameter decorator
@@ -330,7 +332,7 @@ export declare const ReqLogger: () => ParameterDecorator;
  * }
  * ```
  */
-export declare const ReqId: () => ParameterDecorator;
+declare const ReqId: () => ParameterDecorator;
 /**
  * Decorator that extracts request headers.
  * @param key - Optional key to extract specific header
@@ -344,7 +346,7 @@ export declare const ReqId: () => ParameterDecorator;
  * }
  * ```
  */
-export declare const ReqHeader: (paramKey?: string) => ParameterDecorator;
+declare const ReqHeader: (paramKey?: string) => ParameterDecorator;
 /**
  * Decorator that extracts cookies from request.
  * @param key - Optional key to extract specific cookie
@@ -358,7 +360,7 @@ export declare const ReqHeader: (paramKey?: string) => ParameterDecorator;
  * }
  * ```
  */
-export declare const ReqCookie: (paramKey?: string) => ParameterDecorator;
+declare const ReqCookie: (paramKey?: string) => ParameterDecorator;
 /**
  * Decorator that injects the entire request object.
  *
@@ -373,7 +375,7 @@ export declare const ReqCookie: (paramKey?: string) => ParameterDecorator;
  * }
  * ```
  */
-export declare const Req: () => ParameterDecorator;
+declare const Req: () => ParameterDecorator;
 /**
  * Decorator that injects the response object.
  *
@@ -388,7 +390,7 @@ export declare const Req: () => ParameterDecorator;
  * }
  * ```
  */
-export declare const Res: () => ParameterDecorator;
+declare const Res: () => ParameterDecorator;
 /**
  * Decorator that sets a custom HTTP status code for a response.
  *
@@ -405,7 +407,7 @@ export declare const Res: () => ParameterDecorator;
  * }
  * ```
  */
-export declare function HttpCode(status: number): MethodDecorator;
+declare function HttpCode(status: number): MethodDecorator;
 /**
  * Decorator that adds a custom HTTP header to the response.
  *
@@ -422,7 +424,7 @@ export declare function HttpCode(status: number): MethodDecorator;
  *   return { data: '...' };
  * }
  */
-export declare function Header(name: string, value: string): MethodDecorator & ClassDecorator;
+declare function Header(name: string, value: string): MethodDecorator & ClassDecorator;
 /**
  * Decorator that adds a custom HTTP headers to the response.
  *
@@ -452,7 +454,7 @@ export declare function Header(name: string, value: string): MethodDecorator & C
  *
  * ```
  */
-export declare function Headers(headers: Record<string, string> | string, value?: string): MethodDecorator & ClassDecorator;
+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.
@@ -475,7 +477,7 @@ export declare function Headers(headers: Record<string, string> | string, value?
  * }
  * ```
  */
-export declare function Before(fn: Function): MethodDecorator & ClassDecorator;
+declare function Before(fn: Function): MethodDecorator & ClassDecorator;
 /**
  * Decorator that registers a function to run after route handler execution.
  * Can access the handler's result.
@@ -499,7 +501,7 @@ export declare function Before(fn: Function): MethodDecorator & ClassDecorator;
  * }
  * ```
  */
-export declare function After(fn: Function): MethodDecorator & ClassDecorator;
+declare function After(fn: Function): MethodDecorator & ClassDecorator;
 /**
  * Decorator that requires specific roles for accessing a route.
  * Must be used with authentication middleware.
@@ -519,7 +521,7 @@ export declare function After(fn: Function): MethodDecorator & ClassDecorator;
  * }
  * ```
  */
-export declare function Roles(...roles: string[]): MethodDecorator & ClassDecorator;
+declare function Roles(...roles: string[]): MethodDecorator & ClassDecorator;
 /**
  * Decorator that redirects to another URL.
  *
@@ -543,7 +545,7 @@ export declare function Roles(...roles: string[]): MethodDecorator & ClassDecora
  * }
  * ```
  */
-export declare function Redirect(url?: string, statusCode?: number): MethodDecorator;
+declare function Redirect(url?: string, statusCode?: number): MethodDecorator;
 /**
  * Decorator that adds caching to a route response.
  *
@@ -559,7 +561,7 @@ export declare function Redirect(url?: string, statusCode?: number): MethodDecor
  * }
  * ```
  */
-export declare function Cache(ttlSeconds: number): MethodDecorator & ClassDecorator;
+declare function Cache(ttlSeconds: number): MethodDecorator & ClassDecorator;
 /**
  * Decorator that applies rate limiting to a route.
  * Note: Requires 'express-rate-limit' package to be installed.
@@ -581,7 +583,7 @@ export declare function Cache(ttlSeconds: number): MethodDecorator & ClassDecora
  * }
  * ```
  */
-export declare function RateLimit(options: {
+declare function RateLimit(options: {
     max: number;
     windowMs: number;
     standardHeaders?: boolean;
@@ -608,7 +610,7 @@ export declare function RateLimit(options: {
  * }
  * ```
  */
-export declare function ContentType(type: string): MethodDecorator & ClassDecorator;
+declare function ContentType(type: string): MethodDecorator & ClassDecorator;
 /**
  * Decorator that adds API versioning to a route.
  *
@@ -638,7 +640,7 @@ export declare function ContentType(type: string): MethodDecorator & ClassDecora
  * }
  * ```
  */
-export declare function Version(version: string, options?: {
+declare function Version(version: string, options?: {
     addPrefix?: boolean;
     addHeader?: boolean;
     headerName?: string;
@@ -658,7 +660,7 @@ export declare function Version(version: string, options?: {
  * }
  * ```
  */
-export declare function Timeout(ms: number): MethodDecorator & ClassDecorator;
+declare function Timeout(ms: number): MethodDecorator & ClassDecorator;
 /**
  * Decorator that adds comprehensive logging to a route.
  *
@@ -687,7 +689,7 @@ export declare function Timeout(ms: number): MethodDecorator & ClassDecorator;
  * }
  * ```
  */
-export declare function Log(options?: {
+declare function Log(options?: {
     logEntry?: boolean;
     logExit?: boolean;
     logBody?: boolean;
@@ -701,5 +703,7 @@ export declare function Log(options?: {
  * @param router - Express router instance
  * @param controllers - Array of controller classes
  */
-export declare function registerControllers(router: Router, controllers: any[]): void;
-export {};
+declare function registerControllers(router: Router, controllers: any[]): void;
+
+export { After, Before, Body, Cache, Connect, ContentType, Controller, DIContainer, Delete, Get, Head, Header, Headers, HttpCode, Inject, Injectable, Log, Options, Param, Patch, Post, Put, Query, RateLimit, Redirect, Req, ReqCookie, ReqHeader, ReqId, ReqLogger, Res, Roles, Timeout, Trace, Use, Version, createParamDecorator, createParamDecoratorWithoutParam, inject, registerControllers };
+export type { CachedRateLimiter, HttpMethod, ParamDefinition, ParamOptions, RouteDefinition };