@catbee/utils 2.0.0-next.0 → 2.0.0-next.1

package/http-status-codes/http-status-codes.d.ts

@@ -1,289 +0,0 @@
-/*
- * The MIT License
- * 
- * Copyright (c) 2025 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
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- * 
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * Complete HTTP status codes enum with descriptions.
- * For use with API responses and error handling.
- */
-export declare enum HttpStatusCodes {
-    /**
-     * The server has received the request headers and the client should proceed to send the request body.
-     */
-    CONTINUE = 100,
-    /**
-     * The server is switching protocols according to the client's request.
-     */
-    SWITCHING_PROTOCOLS = 101,
-    /**
-     * Server has received the request and is still processing it.
-     */
-    PROCESSING = 102,
-    /**
-     * The server is sending preliminary headers while preparing the final response.
-     */
-    EARLY_HINTS = 103,
-    /**
-     * The request succeeded. The result meaning depends on the HTTP method used.
-     */
-    OK = 200,
-    /**
-     * The request succeeded and a new resource was created as a result.
-     */
-    CREATED = 201,
-    /**
-     * The request has been received but not yet acted upon.
-     */
-    ACCEPTED = 202,
-    /**
-     * The returned information is from a third-party source, not the origin server.
-     */
-    NON_AUTHORITATIVE_INFORMATION = 203,
-    /**
-     * The request succeeded but there's no content to send in the response.
-     */
-    NO_CONTENT = 204,
-    /**
-     * The client should reset the document view that caused this request.
-     */
-    RESET_CONTENT = 205,
-    /**
-     * The server is delivering only part of the resource due to a range header sent by the client.
-     */
-    PARTIAL_CONTENT = 206,
-    /**
-     * Conveys information about multiple resources, for complex operations.
-     */
-    MULTI_STATUS = 207,
-    /**
-     * The members of a DAV binding have already been enumerated and are not included in the response.
-     */
-    ALREADY_REPORTED = 208,
-    /**
-     * The server has fulfilled a request for the resource, and the response represents the result of one or more instance-manipulations.
-     */
-    IM_USED = 226,
-    /**
-     * The request has more than one possible response and the client should choose one.
-     */
-    MULTIPLE_CHOICES = 300,
-    /**
-     * The resource has been permanently moved to a new URL.
-     */
-    MOVED_PERMANENTLY = 301,
-    /**
-     * The resource has been temporarily moved to another URL.
-     */
-    MOVED_TEMPORARILY = 302,
-    /**
-     * The response to the request can be found under another URI using the GET method.
-     */
-    SEE_OTHER = 303,
-    /**
-     * The resource hasn't been modified since the last request.
-     */
-    NOT_MODIFIED = 304,
-    /**
-     * @deprecated
-     * Response must be accessed through a proxy.
-     */
-    USE_PROXY = 305,
-    /**
-     * The resource is temporarily available at a different URI, using the same HTTP method.
-     */
-    TEMPORARY_REDIRECT = 307,
-    /**
-     * The resource has been permanently moved to another URL, using the same HTTP method.
-     */
-    PERMANENT_REDIRECT = 308,
-    /**
-     * The server cannot process the request due to a client error (malformed request).
-     */
-    BAD_REQUEST = 400,
-    /**
-     * Authentication is required and has failed or not been provided.
-     */
-    UNAUTHORIZED = 401,
-    /**
-     * Reserved for future use, originally intended for digital payment systems.
-     */
-    PAYMENT_REQUIRED = 402,
-    /**
-     * The client doesn't have permission to access the requested resource.
-     */
-    FORBIDDEN = 403,
-    /**
-     * The requested resource could not be found on the server.
-     */
-    NOT_FOUND = 404,
-    /**
-     * The request method is not supported for the requested resource.
-     */
-    METHOD_NOT_ALLOWED = 405,
-    /**
-     * The server can't provide a response matching the list of acceptable values in the client's headers.
-     */
-    NOT_ACCEPTABLE = 406,
-    /**
-     * Authentication by a proxy is required.
-     */
-    PROXY_AUTHENTICATION_REQUIRED = 407,
-    /**
-     * The server timed out waiting for the request.
-     */
-    REQUEST_TIMEOUT = 408,
-    /**
-     * The request conflicts with the current state of the server.
-     */
-    CONFLICT = 409,
-    /**
-     * The resource has been permanently deleted with no forwarding address.
-     */
-    GONE = 410,
-    /**
-     * The server requires a Content-Length header field.
-     */
-    LENGTH_REQUIRED = 411,
-    /**
-     * Preconditions in the client's headers failed.
-     */
-    PRECONDITION_FAILED = 412,
-    /**
-     * Request entity is larger than limits defined by server.
-     */
-    REQUEST_TOO_LONG = 413,
-    /**
-     * The request payload exceeds server size limits.
-     * Modern equivalent of REQUEST_TOO_LONG.
-     */
-    PAYLOAD_TOO_LARGE = 413,
-    /**
-     * The URI requested is too long for the server to interpret.
-     */
-    REQUEST_URI_TOO_LONG = 414,
-    /**
-     * The server does not support the media type requested by the client.
-     */
-    UNSUPPORTED_MEDIA_TYPE = 415,
-    /**
-     * The range specified by the Range header cannot be fulfilled.
-     */
-    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
-    /**
-     * The server cannot meet the expectations given in the Expect header.
-     */
-    EXPECTATION_FAILED = 417,
-    /**
-     * The server refuses to brew coffee because it is a teapot. (April Fools' joke)
-     */
-    IM_A_TEAPOT = 418,
-    /**
-     * The server cannot store the representation needed to complete the request.
-     */
-    INSUFFICIENT_SPACE_ON_RESOURCE = 419,
-    /**
-     * @deprecated
-     * A method has failed - specific to Spring Framework.
-     */
-    METHOD_FAILURE = 420,
-    /**
-     * The server cannot produce a response for the requested URI scheme and authority.
-     */
-    MISDIRECTED_REQUEST = 421,
-    /**
-     * The request was well-formed but has semantic errors preventing processing.
-     */
-    UNPROCESSABLE_ENTITY = 422,
-    /**
-     * The requested resource is locked against access.
-     */
-    LOCKED = 423,
-    /**
-     * The request failed due to the failure of a previous request.
-     */
-    FAILED_DEPENDENCY = 424,
-    /**
-     * The client should switch to a different protocol.
-     */
-    UPGRADE_REQUIRED = 426,
-    /**
-     * The server requires conditional requests to prevent lost updates.
-     */
-    PRECONDITION_REQUIRED = 428,
-    /**
-     * The client has sent too many requests in a given time period (rate limiting).
-     */
-    TOO_MANY_REQUESTS = 429,
-    /**
-     * Request headers are too large for the server to process.
-     */
-    REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
-    /**
-     * Resource cannot be legally provided (e.g., censored by government).
-     */
-    UNAVAILABLE_FOR_LEGAL_REASONS = 451,
-    /**
-     * The server encountered an unexpected error preventing it from fulfilling the request.
-     */
-    INTERNAL_SERVER_ERROR = 500,
-    /**
-     * The server does not support the functionality required to fulfill the request.
-     */
-    NOT_IMPLEMENTED = 501,
-    /**
-     * The server, acting as a gateway, received an invalid response from an upstream server.
-     */
-    BAD_GATEWAY = 502,
-    /**
-     * The server is currently unable to handle the request due to temporary overload or maintenance.
-     */
-    SERVICE_UNAVAILABLE = 503,
-    /**
-     * The server, acting as a gateway, did not receive a timely response from an upstream server.
-     */
-    GATEWAY_TIMEOUT = 504,
-    /**
-     * The server does not support the HTTP protocol version used in the request.
-     */
-    HTTP_VERSION_NOT_SUPPORTED = 505,
-    /**
-     * Transparent content negotiation for the request resulted in circular reference.
-     */
-    VARIANT_ALSO_NEGOTIATES = 506,
-    /**
-     * The server cannot store the representation needed to complete the request.
-     */
-    INSUFFICIENT_STORAGE = 507,
-    /**
-     * The server detected an infinite loop while processing the request.
-     */
-    LOOP_DETECTED = 508,
-    /**
-     * Further extensions to the request are required for the server to fulfill it.
-     */
-    NOT_EXTENDED = 510,
-    /**
-     * The client needs to authenticate to gain network access.
-     */
-    NETWORK_AUTHENTICATION_REQUIRED = 511
-}

package/id/id.utils.d.ts

@@ -1,59 +0,0 @@
-/*
- * The MIT License
- * 
- * Copyright (c) 2025 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
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- * 
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * Generates a UUID v4 string (RFC 4122).
- *
- * @returns {string} UUID v4 (e.g., 'c0de1234-5678-9abc-def0-123456789abc')
- */
-export declare function uuid(): string;
-/**
- * Generates a nanoid-style random ID (URL-safe, customizable length).
- *
- * @param {number} length - Length of the ID (default: 21).
- * @returns {string} Nanoid-style random string.
- */
-export declare function nanoId(length?: number): string;
-/**
- * Generates a cryptographically strong random hex string.
- *
- * @param {number} byteLength - Number of random bytes (default: 16 → 32 hex chars).
- * @returns {string} Random hex string.
- */
-export declare function randomHex(byteLength?: number): string;
-/**
- * Generates a random integer between min (inclusive) and max (inclusive).
- *
- * @param {number} min - Minimum value.
- * @param {number} max - Maximum value.
- * @returns {number} Random integer in range.
- */
-export declare function randomInt(min: number, max: number): number;
-/**
- * Generates a cryptographically strong random base64 string.
- *
- * @param {number} byteLength - Number of random bytes (default: 16).
- * @returns {string} Random base64 string (URL-safe, no padding).
- */
-export declare function randomBase64(byteLength?: number): string;

package/logger/logger.utils.d.ts

@@ -1,210 +0,0 @@
-/*
- * The MIT License
- * 
- * Copyright (c) 2025 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
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- * 
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import pino from 'pino';
-import type { Logger as PinoLogger } from 'pino';
-/**
- * Logger type for application-wide logging.
- */
-export type Logger = PinoLogger;
-/**
- * Logger levels for application-wide logging.
- */
-export type LoggerLevels = pino.Level;
-export declare const defaultSensitiveFields: string[];
-/**
- * Sets the global redaction censor function used throughout the application for log redaction.
- *
- * Use this function to customize how sensitive data is redacted in logs. The provided function
- * will replace the default censor implementation.
- *
- * @example
- * ```typescript
- * // Custom censor that redacts only specific values
- * setRedactCensor((value, path, sensitiveFields) => {
- *   if (path.includes('password')) return '***';
- *   return value;
- * });
- * ```
- *
- * @param fn - The redaction censor function to use globally. This function receives:
- *   - value: The data value to potentially redact
- *   - path: Array of strings representing the path to the value in the object
- *   - sensitiveFields: Optional array of field names to consider sensitive
- * @returns void
- */
-export declare function setRedactCensor(fn: (value: unknown, path: string[], sensitiveFields?: string[]) => string): void;
-/**
- * Gets the current global redaction censor function used for log redaction.
- *
- * This function is called internally by the logger when determining how to redact
- * sensitive information. It can also be used to access the current censor implementation
- * for composition or extension.
- *
- * @example
- * ```typescript
- * const currentCensor = getRedactCensor();
- * // Create an enhanced censor that extends the current one
- * setRedactCensor((value, path, fields) => {
- *   // Add custom logic before delegating to current censor
- *   if (someCondition) return customHandling();
- *   return currentCensor(value, path, fields);
- * });
- * ```
- *
- * @returns The current redaction censor function
- */
-export declare function getRedactCensor(): (value: unknown, path: string[], sensitiveFields?: string[]) => string;
-/**
- * Convenience function to redact sensitive data using the current global redact censor.
- *
- * This is a direct wrapper around the global censor function that simplifies usage
- * in application code without needing to access the censor function directly.
- *
- * @example
- * ```typescript
- * // Redact a potential sensitive value
- * const safeValue = redact(value, ['user', 'apiKey']);
- * ```
- *
- * @param value - The value to potentially redact
- * @param path - Array of strings representing the path to the value in the object
- * @param sensitiveFields - Optional array of field names to consider sensitive
- * @returns The redacted string value or "***" for redacted content
- */
-export declare function redact(value: unknown, path: string[], sensitiveFields?: string[]): string;
-/**
- * @deprecated Use addSensitiveFields instead.
- *
- * Extends the current redaction function with additional fields to redact.
- *
- * This function wraps the existing censor while adding more fields to be considered
- * sensitive without replacing the entire redaction logic.
- *
- * @example
- * ```typescript
- * // Add custom fields to be redacted in all future redaction operations
- * addRedactFields(['customerId', 'accountNumber']);
- * ```
- *
- * @param fields - Array of additional field names to redact
- */
-export declare function addRedactFields(fields: string[]): void;
-/**
- * Retrieves the expanded list of sensitive fields.
- *
- * This function expands the default sensitive fields into their various naming
- * conventions (e.g., camelCase, snake_case) and caches the result for efficiency.
- *
- * @returns Array of expanded sensitive field names
- */
-export declare function getExpandedSensitiveFields(): string[];
-/**
- * Replaces the default list of sensitive fields with a new list.
- *
- * This is useful when you want complete control over what fields are considered
- * sensitive by default, rather than using the library's built-in list.
- *
- * @example
- * ```typescript
- * // Replace default sensitive fields with a custom list
- * setSensitiveFields(['password', 'ssn', 'creditCard']);
- * ```
- *
- * @param fields - Array of field names to set as the new default sensitive fields
- */
-export declare function setSensitiveFields(fields: string[]): void;
-/**
- * Adds additional field names to the default sensitive fields list.
- *
- * This preserves the existing sensitive fields while adding new ones for
- * application-specific sensitive data.
- *
- * @example
- * ```typescript
- * // Add domain-specific sensitive fields to the default list
- * addSensitiveFields(['socialSecurityNumber', 'medicalRecordNumber']);
- * ```
- *
- * @param fields - Array of additional field names to add to the sensitive fields list
- */
-export declare function addSensitiveFields(fields: string[]): void;
-/**
- * Use an object compatible with either modern or legacy global scopes.
- */
-export declare const _globalThis: typeof globalThis;
-/**
- * Retrieves the current logger instance:
- * - Returns a request-scoped logger from AsyncLocalStorage if available
- * - Falls back to the global (singleton) logger
- * - Initializes the global logger if not created yet
- * - If newInstance is true, returns a fresh logger without any context
- *
- * @param {boolean} newInstance - If true, returns a fresh logger without any context
- * @returns {Logger} The logger instance (request-bound or global root logger or fresh instance)
- */
-export declare function getLogger(newInstance?: boolean): PinoLogger;
-/**
- * Creates a child logger with additional context.
- *
- * @param {Record<string, any>} bindings - Properties to attach to all log records
- * @param {Logger} [parentLogger] - Parent logger (defaults to current context logger or global)
- * @returns {Logger} Child logger with merged context
- */
-export declare function createChildLogger(bindings: Record<string, any>, parentLogger?: PinoLogger): PinoLogger;
-/**
- * Creates a request-scoped logger with request ID and stores it in context
- *
- * @param {string} requestId - Unique request identifier
- * @param {object} [additionalContext] - Additional context to include in logs
- * @returns {Logger} Request-scoped logger instance
- */
-export declare function createRequestLogger(requestId: string, additionalContext?: Record<string, any>): PinoLogger;
-/**
- * Utility to safely log errors with proper stack trace extraction
- *
- * @param {Error|unknown} error - Error object to log
- * @param {string} [message] - Optional message to include
- * @param {Record<string, any>} [context] - Additional context properties
- */
-export declare function logError(error: Error | unknown, message?: string, context?: Record<string, any>): void;
-/**
- * Expands multiple sensitive field names into their variants.
- * Useful to match fields like `api_key`, `apiKey`, `apikey`, `APIKEY`, etc.
- */
-export declare function expandSensitiveFields(fields: string[]): string[];
-/**
- * Generates multiple variants of a sensitive field name.
- * Useful to match fields like `api_key`, `apiKey`, `apikey`, `APIKEY`, etc.
- */
-export declare function expandSensitiveField(field: string): string[];
-/**
- * Generates wildcard paths up to the given depth.
- *
- * depth = 2 →
- *  password
- *  *.password
- *  *.*.password
- */
-export declare function generateDeepPaths(field: string, depth: number): string[];

package/middleware/middleware.utils.d.ts

@@ -1,123 +0,0 @@
-/*
- * The MIT License
- * 
- * Copyright (c) 2025 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
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- * 
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import type { Request, Response, NextFunction } from 'express';
-export type Middleware = (req: Request, res: Response, next: NextFunction) => void | Promise<void>;
-/**
- * Attaches a unique request ID to each request.
- * Useful for request tracing and correlation between logs.
- *
- * @param {object} [options] - Configuration options
- * @param {string} [options.headerName='X-Request-ID'] - Header name for request ID
- * @param {boolean} [options.exposeHeader=true] - Whether to expose the header in response
- * @param {() => string} [options.generator] - Custom ID generator function
- * @returns {Middleware} Express-compatible middleware
- */
-export declare function requestId(options?: {
-    headerName?: string;
-    exposeHeader?: boolean;
-    generator?: () => string;
-}): Middleware;
-/**
- * Measures request processing time and logs or adds it to response headers.
- *
- * @param {object} [options] - Configuration options
- * @param {boolean} [options.addHeader=true] - Whether to add X-Response-Time header
- * @param {boolean} [options.logOnComplete=false] - Whether to log timing info
- * @returns {Middleware} Express-compatible middleware
- */
-export declare function responseTime(options?: {
-    addHeader?: boolean;
-    logOnComplete?: boolean;
-}): (req: Request, res: Response, next: NextFunction) => void;
-/**
- * Request timeout middleware.
- * Aborts requests that take too long to process.
- *
- * @param {number} [timeoutMs=30000] - Timeout in milliseconds
- * @returns {Middleware} Express-compatible middleware
- */
-export declare function timeout(timeoutMs?: number): Middleware;
-/**
- * Creates an Express middleware that initializes a per-request context.
- *
- * @param {object} [options] - Optional configuration
- * @param {string} [options.headerName='x-request-id'] - Header to look for request ID
- * @param {boolean} [options.autoLog=true] - Whether to log automatically when context is initialized
- * @returns {(req: Request, res: Response, next: NextFunction) => void} Express middleware function
- */
-export declare function setupRequestContext(options?: {
-    headerName?: string;
-    autoLog?: boolean;
-}): Middleware;
-export interface ErrorHandlerOptions {
-    /** Whether to log errors (default: true) */
-    logErrors?: boolean;
-    /** Whether to include error details in non-production (default: false) */
-    includeDetails?: boolean;
-}
-/**
- * Global error handling middleware with enhanced features.
- *
- * @param {ErrorHandlerOptions} options - Error handler options
- * @param {boolean} [options.logErrors=true] - Whether to log errors
- * @param {boolean} [options.includeDetails=false] - Whether to include error details in non-production
- * @returns Error middleware
- *
- * @example
- * import express from 'express';
- * import { errorHandler } from '@catbee/utils';
- *
- * const app = express();
- *
- * // Your routes
- * app.get('/ping', (req, res) => {
- *   throw new Error('Something went wrong');
- * });
- *
- * // Error handler (must be last middleware)
- * app.use(errorHandler({ includeDetails: true }));
- *
- * app.listen(3000, () => {
- *   console.log('Server running on port 3000');
- * });
- */
-export declare function errorHandler(options?: ErrorHandlerOptions): (err: any, req: Request, res: Response, _next: NextFunction) => Response<any, Record<string, any>>;
-/**
- * Health check middleware for service status and custom checks.
- *
- * @param {object} [options] - Health check options
- * @param {string} [options.path='/healthz'] - Health check endpoint path
- * @param {Array<{name: string; check: () => Promise<boolean> | boolean}>} [options.checks] - Custom health checks
- * @param {boolean} [options.detailed=true] - Show detailed check results
- * @returns {Middleware} Express-compatible middleware
- */
-export declare function healthCheck(options?: {
-    path?: string;
-    checks?: Array<{
-        name: string;
-        check: () => Promise<boolean> | boolean;
-    }>;
-    detailed?: boolean;
-}): Middleware;