@catbee/utils 0.0.8-rc.3 → 1.0.1

package/build/esm/servers/server.builder.d.ts

@@ -1,507 +0,0 @@
-import { ServerConfig } from '../types/server';
-/**
- * Builder class for creating and configuring an Express server configuration.
- *
- * This class provides a fluent interface to configure all aspects of the Express server
- * including security settings, middleware, routing, and more.
- *
- * @example
- * ```typescript
- * const serverConfig = new ServerConfigBuilder()
- *   .withPort(3000)
- *   .withHost('localhost')
- *   .enableCors()
- *   .enableHelmet()
- *   .build();
- * ```
- */
-export declare const BUILD_MARKER: unique symbol;
-export declare class ServerConfigBuilder {
-    private config;
-    /**
-     * Validates that a port number is valid and usable.
-     *
-     * @private
-     * @param port - The port number to validate
-     * @throws {Error} If port is not an integer or is outside the valid range (1-65535)
-     */
-    private validatePort;
-    /**
-     * Sets the port the server will listen on.
-     *
-     * @param port - The port number (1-65535)
-     * @returns The builder instance for chaining
-     * @throws {Error} If port is invalid
-     * @default 3000 (can be overridden via PORT env variable)
-     *
-     * @example
-     * ```typescript
-     * builder.withPort(3000)
-     * ```
-     */
-    withPort(port: number): this;
-    /**
-     * Sets the hostname the server will bind to.
-     *
-     * @param host - The hostname (e.g., 'localhost', '0.0.0.0', '127.0.0.1')
-     * @returns The builder instance for chaining
-     * @default '0.0.0.0' (can be overridden via HOST env variable)
-     *
-     * @example
-     * ```typescript
-     * builder.withHost('0.0.0.0') // Listen on all interfaces
-     * ```
-     */
-    withHost(host: string): this;
-    /**
-     * Configures Cross-Origin Resource Sharing (CORS) for the server.
-     *
-     * @param opts - CORS options object or boolean (true to enable with defaults, false to disable)
-     * @returns The builder instance for chaining
-     * @default false (CORS is disabled by default)
-     *
-     * @example
-     * ```typescript
-     * // Enable CORS with default options
-     * builder.withCors(true)
-     *
-     * // Configure CORS with specific options
-     * builder.withCors({
-     *   origin: ['https://example.com'],
-     *   methods: ['GET', 'POST']
-     * })
-     * ```
-     */
-    withCors(opts: ServerConfig['cors']): this;
-    /**
-     * Enables CORS with default settings
-     *
-     * @returns The builder instance for chaining
-     */
-    enableCors(): this;
-    /**
-     * Disables CORS
-     *
-     * @returns The builder instance for chaining
-     */
-    disableCors(): this;
-    /**
-     * Configures the Helmet middleware for setting HTTP security headers.
-     *
-     * @param opts - Helmet options object or boolean (true to enable with defaults, false to disable)
-     * @returns The builder instance for chaining
-     * @default false (Helmet is disabled by default)
-     *
-     * @example
-     * ```typescript
-     * // Enable Helmet with default settings
-     * builder.withHelmet(true)
-     *
-     * // Configure Helmet with specific options
-     * builder.withHelmet({
-     *   contentSecurityPolicy: false,
-     *   xssFilter: true
-     * })
-     * ```
-     */
-    withHelmet(opts: ServerConfig['helmet']): this;
-    /**
-     * Enables Helmet with default settings
-     *
-     * @returns The builder instance for chaining
-     */
-    enableHelmet(): this;
-    /**
-     * Disables Helmet
-     *
-     * @returns The builder instance for chaining
-     */
-    disableHelmet(): this;
-    /**
-     * Configures response compression middleware.
-     *
-     * @param opts - Compression options object or boolean (true to enable with defaults, false to disable)
-     * @returns The builder instance for chaining
-     * @default false (Compression is disabled by default)
-     *
-     * @example
-     * ```typescript
-     * // Enable compression with default settings
-     * builder.withCompression(true)
-     *
-     * // Configure compression with specific options
-     * builder.withCompression({
-     *   level: 6,
-     *   threshold: 1024
-     * })
-     * ```
-     */
-    withCompression(opts: ServerConfig['compression']): this;
-    /**
-     * Enables compression with default settings
-     *
-     * @returns The builder instance for chaining
-     */
-    enableCompression(): this;
-    /**
-     * Disables compression
-     *
-     * @returns The builder instance for chaining
-     */
-    disableCompression(): this;
-    /**
-     * Configures rate limiting to protect against brute-force attacks.
-     *
-     * @param opts - Rate limit configuration options
-     * @returns The builder instance for chaining
-     * @default { enable: false, windowMs: 15 * 60 * 1000, max: 100, message: 'Too many requests', standardHeaders: true, legacyHeaders: false }
-     *
-     * @example
-     * ```typescript
-     * builder.withRateLimit({
-     *   enable: true,
-     *   windowMs: 15 * 60 * 1000, // 15 minutes
-     *   max: 100 // limit each IP to 100 requests per windowMs
-     * })
-     * ```
-     */
-    withRateLimit(opts: Partial<ServerConfig['rateLimit']>): this;
-    /**
-     * Enables rate limiting with default or custom settings
-     *
-     * @param opts - Optional rate limit configuration (max requests, window, etc.)
-     * @returns The builder instance for chaining
-     */
-    enableRateLimit(opts?: Omit<Partial<NonNullable<ServerConfig['rateLimit']>>, 'enable'>): this;
-    /**
-     * Disables rate limiting
-     *
-     * @returns The builder instance for chaining
-     */
-    disableRateLimit(): this;
-    /**
-     * Configures HTTP request logging middleware.
-     *
-     * @param opts - Request logging configuration options
-     * @returns The builder instance for chaining
-     * @default { enable: true in dev/false in prod, ignorePaths: ['/healthz', '/favicon.ico', '/metrics', '/docs', '/.well-known'], skipNotFoundRoutes: false }
-     *
-     * @example
-     * ```typescript
-     * builder.withRequestLogging({
-     *   enable: true,
-     *   ignorePaths: ['/health', '/metrics'],
-     *   skipNotFoundRoutes: true
-     * })
-     * ```
-     */
-    withRequestLogging(opts: Partial<NonNullable<ServerConfig['requestLogging']>>): this;
-    /**
-     * Enables request logging with default or custom settings
-     *
-     * @param opts - Optional request logging configuration
-     * @returns The builder instance for chaining
-     */
-    enableRequestLogging(opts?: Omit<Partial<NonNullable<ServerConfig['requestLogging']>>, 'enable'>): this;
-    /**
-     * Disables request logging
-     *
-     * @returns The builder instance for chaining
-     */
-    disableRequestLogging(): this;
-    /**
-     * Configures server metrics collection and endpoints.
-     *
-     * @param opts - Metrics configuration options
-     * @returns The builder instance for chaining
-     * @default { enable: false, path: '/metrics', withGlobalPrefix: false }
-     *
-     * @example
-     * ```typescript
-     * builder.withMetrics({
-     *   enable: true,
-     *   path: '/metrics'
-     * })
-     * ```
-     */
-    withMetrics(opts: Partial<NonNullable<ServerConfig['metrics']>>): this;
-    /**
-     * Enables Prometheus metrics collection and endpoint
-     *
-     * @param opts - Optional metrics configuration
-     * @returns The builder instance for chaining
-     */
-    enableMetrics(opts?: Omit<Partial<NonNullable<ServerConfig['metrics']>>, 'enable'>): this;
-    /**
-     * Disables Prometheus metrics
-     *
-     * @returns The builder instance for chaining
-     */
-    disableMetrics(): this;
-    /**
-     * Configures server health check endpoint.
-     *
-     * @param opts - Health check configuration options
-     * @returns The builder instance for chaining
-     * @default { path: '/healthz', detailed: true, withGlobalPrefix: false }
-     *
-     * @example
-     * ```typescript
-     * builder.withHealthCheck({
-     *   path: '/health',
-     *   detailed: true
-     * })
-     * ```
-     */
-    withHealthCheck(opts: Partial<NonNullable<ServerConfig['healthCheck']>>): this;
-    /**
-     * Configures OpenAPI/Swagger documentation for the API.
-     *
-     * @param opts - OpenAPI configuration options
-     * @returns The builder instance for chaining
-     * @default { enable: false, mountPath: '/docs', verbose: false, withGlobalPrefix: false }
-     *
-     * @example
-     * ```typescript
-     * builder.withOpenApi({
-     *   enable: true,
-     *   path: '/api-docs',
-     *   filePath: './openapi.yaml'
-     * })
-     * ```
-     */
-    withOpenApi(opts: Partial<NonNullable<ServerConfig['openApi']>>): this;
-    /**
-     * Enables OpenAPI documentation with required file path
-     *
-     * @param filePath - Path to OpenAPI specification file (required)
-     * @param opts - Optional OpenAPI configuration
-     * @returns The builder instance for chaining
-     */
-    enableOpenApi(filePath: string, opts?: Omit<Partial<NonNullable<ServerConfig['openApi']>>, 'enable' | 'filePath'>): this;
-    /**
-     * Disables OpenAPI documentation
-     *
-     * @returns The builder instance for chaining
-     */
-    disableOpenApi(): this;
-    /**
-     * Configures the server as a microservice with versioning.
-     *
-     * @param opts - Microservice configuration options including app name and service version
-     * @returns The builder instance for chaining
-     * @default { isMicroservice: false, appName: 'express_app' }
-     *
-     * @example
-     * ```typescript
-     * builder.withMicroService({
-     *   appName: 'user-service',
-     *   serviceVersion: {
-     *     enable: true,
-     *     version: '1.2.3'
-     *   }
-     * })
-     * ```
-     */
-    withMicroService(opts: {
-        appName: NonNullable<ServerConfig['appName']>;
-        serviceVersion: Partial<NonNullable<ServerConfig['serviceVersion']>>;
-    }): this;
-    /**
-     * Configures the trust proxy settings to determine if X-Forwarded-* headers should be trusted.
-     *
-     * @param opts - Trust proxy configuration options
-     * @returns The builder instance for chaining
-     * @default false
-     *
-     * @example
-     * ```typescript
-     * // Trust proxy headers (useful when behind a load balancer)
-     * builder.withTrustProxy(true)
-     * ```
-     */
-    withTrustProxy(opts: NonNullable<ServerConfig['trustProxy']>): this;
-    /**
-     * Configures the request ID middleware for tracing requests across services.
-     *
-     * @param opts - Request ID configuration options
-     * @returns The builder instance for chaining
-     * @default { headerName: 'x-request-id', exposeHeader: true }
-     *
-     * @example
-     * ```typescript
-     * builder.withRequestId({
-     *   headerName: 'X-Request-Id',
-     *   generator: () => crypto.randomUUID()
-     * })
-     * ```
-     */
-    withRequestId(opts: Partial<NonNullable<ServerConfig['requestId']>>): this;
-    /**
-     * Configures the response time middleware for measuring request processing times.
-     *
-     * @param opts - Response time configuration options
-     * @returns The builder instance for chaining
-     * @default { enable: false, addHeader: true, logOnComplete: false }
-     *
-     * @example
-     * ```typescript
-     * builder.withResponseTime({
-     *   enable: true,
-     *   addHeader: true,
-     *   logOnComplete: true
-     * })
-     * ```
-     */
-    withResponseTime(opts: Partial<NonNullable<ServerConfig['responseTime']>>): this;
-    /**
-     * Enables response time tracking with default or custom settings
-     *
-     * @param opts - Optional response time configuration
-     * @returns The builder instance for chaining
-     */
-    enableResponseTime(opts?: Omit<Partial<NonNullable<ServerConfig['responseTime']>>, 'enable'>): this;
-    /**
-     * Disables response time tracking
-     *
-     * @returns The builder instance for chaining
-     */
-    disableResponseTime(): this;
-    /**
-     * Configures the body parser middleware options for parsing request bodies.
-     *
-     * @param opts - Body parser configuration options
-     * @returns The builder instance for chaining
-     * @default { json: { limit: '1mb' }, urlencoded: { extended: true, limit: '1mb' } }
-     *
-     * @example
-     * ```typescript
-     * builder.withBodyParser({
-     *   json: {
-     *     limit: '1mb'
-     *   },
-     *   urlencoded: {
-     *     extended: true,
-     *     limit: '1mb'
-     *   }
-     * })
-     * ```
-     */
-    withBodyParser(opts: NonNullable<ServerConfig['bodyParser']>): this;
-    /**
-     * Configures cookie parsing middleware.
-     *
-     * @param opts - Cookie parser options or boolean (true to enable with defaults, false to disable)
-     * @returns The builder instance for chaining
-     * @default false
-     *
-     * @example
-     * ```typescript
-     * // Enable cookie parsing with default options
-     * builder.withCookies(true)
-     *
-     * // Enable cookie parsing with specific options
-     * builder.withCookies({
-     *   secret: 'your-secret-key',
-     *   secure: true
-     * })
-     * ```
-     */
-    withCookies(opts: ServerConfig['cookieParser']): this;
-    /**
-     * Adds a static folder to serve files from.
-     *
-     * @param folder - Static folder configuration
-     * @returns The builder instance for chaining
-     *
-     * @example
-     * ```typescript
-     * builder.withStaticFolder({
-     *   path: '/assets',
-     *   directory: './public',
-     *   options: { maxAge: '1d' }
-     * })
-     * ```
-     */
-    withStaticFolder(folder: NonNullable<ServerConfig['staticFolders']>[number]): this;
-    /**
-     * Sets global headers to be included in all responses.
-     *
-     * @param headers - Object containing header name/value pairs or functions that return values
-     * @returns The builder instance for chaining
-     * @default {}
-     *
-     * @example
-     * ```typescript
-     * builder.withGlobalHeaders({
-     *   'X-Powered-By': 'Catbee',
-     *   'Server-Time': () => new Date().toISOString()
-     * })
-     * ```
-     */
-    withGlobalHeaders(headers: NonNullable<ServerConfig['globalHeaders']>): this;
-    /**
-     * Sets a global prefix for all routes.
-     *
-     * @param prefix - The prefix to prepend to all routes (e.g., '/api/v1')
-     * @returns The builder instance for chaining
-     * @default '/'
-     *
-     * @example
-     * ```typescript
-     * builder.withGlobalPrefix('/api/v1')
-     * ```
-     */
-    withGlobalPrefix(prefix: string): this;
-    /**
-     * Applies custom configuration overrides directly.
-     *
-     * @param overrides - Custom configuration options to merge
-     * @returns The builder instance for chaining
-     *
-     * @example
-     * ```typescript
-     * builder.withCustom({
-     *   port: 8080,
-     *   customMiddleware: myMiddlewareFunction
-     * })
-     * ```
-     */
-    withCustom(overrides: Partial<ServerConfig>): this;
-    /**
-     * Configures HTTPS server options.
-     *
-     * @param opts - HTTPS configuration (key, cert, ca, passphrase, etc.)
-     * @returns The builder instance for chaining
-     *
-     * @example
-     * ```typescript
-     * builder.withHttps({
-     *   key: './localhost-key.pem',
-     *   cert: './localhost-cert.pem'
-     * })
-     * ```
-     */
-    withHttps(opts: NonNullable<ServerConfig['https']>): this;
-    /**
-     * Builds and returns the final server configuration.
-     *
-     * This method merges the user-specified configuration with default values,
-     * ensures all sections with 'enable' flags are properly structured, and
-     * produces the final configuration to be used by the server.
-     *
-     * @returns The complete ServerConfig object
-     *
-     * @example
-     * ```typescript
-     * const config = new ServerConfigBuilder()
-     *   .withPort(3000)
-     *   .withHost('localhost')
-     *   .withCors(true)
-     *   .build();
-     * ```
-     */
-    build(): Readonly<ServerConfig>;
-    private mergeConfig;
-    private setEnabled;
-}