@catbee/utils 2.0.3 → 2.0.5

package/server/index.d.ts

@@ -22,7 +22,6 @@
  * SOFTWARE.
  */
 
-import * as prom_client from 'prom-client';
 import express, { Express, Router } from 'express';
 import http from 'node:http';
 import https from 'node:https';
@@ -39,14 +38,13 @@ declare const DependencyErrors: {
     'express-rate-limit': string;
     'cookie-parser': string;
     '@scalar/express-api-reference': string;
-    'prom-client': string;
 };
 /**
  * Production-ready Express server with enterprise features.
  *
  * Core Features:
  * - Security: Helmet, CORS, rate limiting, timeouts
- * - Monitoring: Request logs, metrics, health checks
+ * - Monitoring: Request logs, health checks
  * - Performance: Compression, caching, static files
  * - Reliability: Graceful shutdown, error handling
  * - Developer UX: OpenAPI docs, debugging tools
@@ -56,8 +54,6 @@ declare const DependencyErrors: {
  * Includes K8s readiness probes and zero-downtime support.
  */
 declare class ExpressServer {
-    /** Prometheus client registry for metrics collection */
-    private readonly register;
     /** HTTP server instance (null when not running) */
     protected server: http.Server | https.Server | null;
     /** Merged configuration with defaults applied */
@@ -76,16 +72,13 @@ declare class ExpressServer {
     private readonly connections;
     /** Flag indicating if the server is shutting down */
     private isShuttingDown;
+    /** Flag indicating if graceful shutdown handlers are registered */
+    private gracefulShutdownRegistered;
     /**
      * Collection of registered health check functions.
      * These are executed when the health check endpoint is accessed.
      */
     private readonly healthChecks;
-    /** Prometheus metrics for monitoring */
-    private readonly requestCounter?;
-    private readonly routeTimings?;
-    private readonly requestSizes?;
-    private readonly clientIPs?;
     /** Promise that resolves when initialization (middleware + routes) is complete */
     private readonly initPromise;
     /**
@@ -101,7 +94,6 @@ declare class ExpressServer {
      *
      * Default Monitoring:
      * - Request/Response logging
-     * - Prometheus metrics
      * - Health checks
      * - Request tracing
      */
@@ -186,15 +178,11 @@ declare class ExpressServer {
      * Set up OpenAPI documentation middleware.
      */
     private setupOpenApiMiddleware;
-    /**
-     * Set up metrics tracking middleware.
-     */
-    private setupMetricsMiddleware;
     /**
      * Configure server routes and error handling.
      * Sets up in following order:
      *
-     * 1. Built-in routes (health, metrics)
+     * 1. Built-in routes (health)
      * 2. Application routes
      * 3. 404 handler
      * 4. Error handler
@@ -309,6 +297,11 @@ declare class ExpressServer {
      * @param signals Array of process signals to listen for (default: SIGINT, SIGTERM)
      */
     enableGracefulShutdown(signals?: NodeJS.Signals[]): this;
+    /**
+     * Destroy all active connections (gracefully if possible).
+     * If a connection does not close cleanly, it will be force-destroyed.
+     */
+    private destroyConnections;
     /**
      * Set an externally created base router.
      * This will override the internal rootRouter.
@@ -351,12 +344,6 @@ declare class ExpressServer {
      * @returns This instance for method chaining
      */
     useMiddleware(...middlewares: express.RequestHandler[]): this;
-    /**
-     * Get Prometheus registry (to add custom counters/histograms)
-     *
-     * @return {*}  {client.Registry}
-     */
-    getMetricsRegistry(): typeof prom_client.Registry;
     /**
      * Get server configuration
      *
@@ -445,15 +432,9 @@ declare class ExpressServer {
      */
     private formatHostForUrl;
     private normalizePath;
-    private normalizeRouteForMetrics;
-    /**
-     * Destroy all active connections (gracefully if possible).
-     * If a connection does not close cleanly, it will be force-destroyed.
-     */
-    private destroyConnections;
     private validateHttpsFiles;
     private hasBuildMarker;
-    private throwDependancyError;
+    private throwDependencyError;
 }
 
 /**
@@ -675,35 +656,6 @@ declare class ServerConfigBuilder {
      * @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<CatbeeServerConfig['metrics']>>): this;
-    /**
-     * Enables Prometheus metrics collection and endpoint
-     *
-     * @param opts - Optional metrics configuration
-     * @returns The builder instance for chaining
-     */
-    enableMetrics(opts?: Omit<Partial<NonNullable<CatbeeServerConfig['metrics']>>, 'enable'>): this;
-    /**
-     * Disables Prometheus metrics
-     *
-     * @returns The builder instance for chaining
-     */
-    disableMetrics(): this;
     /**
      * Configures server health check endpoint.
      *
@@ -720,6 +672,17 @@ declare class ServerConfigBuilder {
      * ```
      */
     withHealthCheck(opts: Partial<NonNullable<CatbeeServerConfig['healthCheck']>>): this;
+    /**
+     * Enables health check endpoint with default or custom settings
+     * @param opts - Optional health check configuration
+     * @returns The builder instance for chaining
+     *
+     * @example
+     * ```typescript
+     * builder.disableHealthCheck()
+     * ```
+     */
+    disableHealthCheck(): this;
     /**
      * Configures OpenAPI/Swagger documentation for the API.
      *
@@ -731,7 +694,7 @@ declare class ServerConfigBuilder {
      * ```typescript
      * builder.withOpenApi({
      *   enable: true,
-     *   path: '/api-docs',
+     *   mountPath: '/api-docs',
      *   filePath: './openapi.yaml'
      * })
      * ```