@naman_deep_singh/server-utils 1.0.1 → 1.0.3

package/dist/server.d.ts

@@ -55,6 +55,7 @@ export declare class ExpressServer implements ServerInstance {
     private rpcMethods;
     private socketIO?;
     constructor(name?: string, version?: string, config?: ServerConfig);
+    private setupMiddleware;
     start(): Promise<ServerInstance>;
     stop(): Promise<void>;
     getInfo(): ServerInfo;

package/dist/server.js

@@ -27,6 +27,54 @@ class ExpressServer {
             gracefulShutdown: config.gracefulShutdown ?? true,
             socketIO: config.socketIO
         };
+        // Apply middleware based on configuration
+        this.setupMiddleware();
+    }
+    setupMiddleware() {
+        // Apply CORS if enabled
+        if (this.config.cors) {
+            try {
+                const cors = require('cors');
+                const corsOptions = typeof this.config.cors === 'object' ? this.config.cors : undefined;
+                this.app.use(cors(corsOptions));
+            }
+            catch (error) {
+                console.warn(`${this.config.name}: CORS middleware not available. Install cors package.`);
+            }
+        }
+        // Apply Helmet if enabled
+        if (this.config.helmet) {
+            try {
+                const helmet = require('helmet');
+                this.app.use(helmet());
+            }
+            catch (error) {
+                console.warn(`${this.config.name}: Helmet middleware not available. Install helmet package.`);
+            }
+        }
+        // Apply JSON parser if enabled
+        if (this.config.json) {
+            this.app.use(express_1.default.json());
+        }
+        // Apply custom middleware
+        if (this.config.customMiddleware && this.config.customMiddleware.length > 0) {
+            this.config.customMiddleware.forEach(middleware => {
+                this.app.use(middleware);
+            });
+        }
+        // Add health check if enabled
+        if (this.config.healthCheck) {
+            const healthPath = typeof this.config.healthCheck === 'string' ? this.config.healthCheck : '/health';
+            this.app.get(healthPath, (req, res) => {
+                res.status(200).json({
+                    status: 'healthy',
+                    service: this.config.name,
+                    version: this.config.version,
+                    uptime: Date.now() - this.config.startTime.getTime(),
+                    timestamp: new Date().toISOString()
+                });
+            });
+        }
     }
     async start() {
         this.status = 'starting';
@@ -98,11 +146,11 @@ class ExpressServer {
                 });
                 this.grpcServer.bindAsync(`0.0.0.0:${port}`, grpc.ServerCredentials.createInsecure(), () => {
                     this.grpcServer.start();
-                    console.log(`🔗 gRPC server running on port ${port}`);
+                    console.log(`🔗 ${this.config.name} gRPC server running on port ${port}`);
                 });
             }
             catch (error) {
-                console.warn('gRPC not available. Install @grpc/grpc-js to use gRPC features.');
+                console.warn(`${this.config.name}: gRPC not available. Install @grpc/grpc-js to use gRPC features.`);
             }
         }
     }
@@ -113,10 +161,10 @@ class ExpressServer {
             const jayson = require('jayson');
             const rpcServer = jayson.server(this.rpcMethods);
             this.app.use(path, rpcServer.middleware());
-            console.log(`📡 JSON-RPC server mounted on ${path}`);
+            console.log(`📡 ${this.config.name} JSON-RPC server mounted on ${path}`);
         }
         catch (error) {
-            console.warn('JSON-RPC not available. Install jayson to use RPC features.');
+            console.warn(`${this.config.name}: JSON-RPC not available. Install jayson to use RPC features.`);
         }
     }
     addWebhook(config) {
@@ -147,11 +195,11 @@ class ExpressServer {
                 res.status(500).json({ error: 'Webhook processing failed' });
             }
         });
-        console.log(`🪝 Webhook registered at ${config.path}`);
+        console.log(`🪝 ${this.config.name} webhook registered at ${config.path}${config.secret ? ' (with signature verification)' : ''}`);
     }
     addSocketIO(config = {}) {
         if (!this.server) {
-            throw new Error('Server must be started before adding Socket.IO');
+            throw new Error(`${this.config.name}: Server must be started before adding Socket.IO`);
         }
         try {
             // eslint-disable-next-line @typescript-eslint/no-var-requires
@@ -170,25 +218,25 @@ class ExpressServer {
             // Handle connections
             io.on('connection', (socket) => {
                 const typedSocket = socket;
-                console.log(`🔌 Socket connected: ${typedSocket.id}`);
+                console.log(`🔌 ${this.config.name}: Socket connected [${typedSocket.id}]`);
                 // Call user-defined connection handler
                 if (config.onConnection) {
                     config.onConnection(socket);
                 }
                 // Handle disconnection
                 typedSocket.on('disconnect', (reason) => {
-                    console.log(`🔌 Socket disconnected: ${typedSocket.id} - ${reason}`);
+                    console.log(`🔌 ${this.config.name}: Socket disconnected [${typedSocket.id}] - ${reason}`);
                     // Call user-defined disconnection handler
                     if (config.onDisconnection) {
                         config.onDisconnection(socket, reason);
                     }
                 });
             });
-            console.log(`🔌 Socket.IO server attached${config.path ? ` at ${config.path}` : ''}`);
+            console.log(`🔌 ${this.config.name} Socket.IO server attached${config.path ? ` at ${config.path}` : ''}${config.cors ? ' (CORS enabled)' : ''}`);
             return io;
         }
         catch (error) {
-            console.warn('Socket.IO not available. Install socket.io to use WebSocket features.');
+            console.warn(`${this.config.name}: Socket.IO not available. Install socket.io to use WebSocket features.`);
             return null;
         }
     }

package/dist/shutdown.d.ts

@@ -2,4 +2,4 @@ import { Server } from 'http';
 import { GracefulShutdownConfig, ServerPlugin } from './types';
 export declare function createGracefulShutdown(server: Server, config?: GracefulShutdownConfig): void;
 export declare function withGracefulShutdown(config?: GracefulShutdownConfig): ServerPlugin;
-export declare function startServerWithShutdown(app: any, port: number, shutdownConfig?: GracefulShutdownConfig): Server;
+export declare function startServerWithShutdown(app: any, port: number, shutdownConfig?: GracefulShutdownConfig, serverName?: string, serverVersion?: string): Server;

package/dist/shutdown.js

@@ -4,11 +4,12 @@ exports.createGracefulShutdown = createGracefulShutdown;
 exports.withGracefulShutdown = withGracefulShutdown;
 exports.startServerWithShutdown = startServerWithShutdown;
 function createGracefulShutdown(server, config = {}) {
-    const { timeout = 10000, onShutdown } = config;
+    const { timeout = 10000, onShutdown, serverName, serverVersion } = config;
+    const nameVersion = serverName && serverVersion ? `${serverName} v${serverVersion}` : 'Server';
     const shutdown = async (signal) => {
-        console.log(`🛑 Received ${signal}, shutting down gracefully...`);
+        console.log(`🛑 ${nameVersion} received ${signal}, shutting down gracefully...`);
         const shutdownTimer = setTimeout(() => {
-            console.log('⏰ Shutdown timeout reached, forcing exit');
+            console.log(`⏰ ${nameVersion} shutdown timeout reached, forcing exit`);
             process.exit(1);
         }, timeout);
         try {
@@ -19,13 +20,13 @@ function createGracefulShutdown(server, config = {}) {
             // Close server
             server.close(() => {
                 clearTimeout(shutdownTimer);
-                console.log('👋 Server closed. Exiting now.');
+                console.log(`👋 ${nameVersion} closed. Exiting now.`);
                 process.exit(0);
             });
         }
         catch (error) {
             clearTimeout(shutdownTimer);
-            console.error('❌ Error during shutdown:', error);
+            console.error(`❌ ${nameVersion} error during shutdown:`, error);
             process.exit(1);
         }
     };
@@ -39,12 +40,18 @@ function withGracefulShutdown(config = {}) {
         app.__gracefulShutdownConfig = config;
     };
 }
-function startServerWithShutdown(app, port, shutdownConfig = {}) {
+function startServerWithShutdown(app, port, shutdownConfig = {}, serverName, serverVersion) {
     const server = app.listen(port, () => {
-        console.log(`🚀 Server running on http://localhost:${port}`);
+        const nameVersion = serverName && serverVersion ? `${serverName} v${serverVersion}` : 'Server';
+        console.log(`🚀 ${nameVersion} running on http://localhost:${port}`);
     });
     // Apply graceful shutdown from stored config or provided config
     const config = app.__gracefulShutdownConfig || shutdownConfig;
-    createGracefulShutdown(server, config);
+    const enhancedConfig = {
+        ...config,
+        serverName,
+        serverVersion
+    };
+    createGracefulShutdown(server, enhancedConfig);
     return server;
 }

package/dist/types.d.ts

@@ -43,6 +43,8 @@ export interface HealthCheck {
 export interface GracefulShutdownConfig {
     timeout?: number;
     onShutdown?: () => Promise<void>;
+    serverName?: string;
+    serverVersion?: string;
 }
 export interface SocketInstance {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naman_deep_singh/server-utils",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Extensible server utilities for Express.js microservices with TypeScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/server.ts

@@ -88,6 +88,58 @@ export class ExpressServer implements ServerInstance {
       gracefulShutdown: config.gracefulShutdown ?? true,
       socketIO: config.socketIO
     };
+
+    // Apply middleware based on configuration
+    this.setupMiddleware();
+  }
+
+  private setupMiddleware(): void {
+    // Apply CORS if enabled
+    if (this.config.cors) {
+      try {
+        const cors = require('cors');
+        const corsOptions = typeof this.config.cors === 'object' ? this.config.cors : undefined;
+        this.app.use(cors(corsOptions));
+      } catch (error) {
+        console.warn(`${this.config.name}: CORS middleware not available. Install cors package.`);
+      }
+    }
+
+    // Apply Helmet if enabled
+    if (this.config.helmet) {
+      try {
+        const helmet = require('helmet');
+        this.app.use(helmet());
+      } catch (error) {
+        console.warn(`${this.config.name}: Helmet middleware not available. Install helmet package.`);
+      }
+    }
+
+    // Apply JSON parser if enabled
+    if (this.config.json) {
+      this.app.use(express.json());
+    }
+
+    // Apply custom middleware
+    if (this.config.customMiddleware && this.config.customMiddleware.length > 0) {
+      this.config.customMiddleware.forEach(middleware => {
+        this.app.use(middleware);
+      });
+    }
+
+    // Add health check if enabled
+    if (this.config.healthCheck) {
+      const healthPath = typeof this.config.healthCheck === 'string' ? this.config.healthCheck : '/health';
+      this.app.get(healthPath, (req, res) => {
+        res.status(200).json({
+          status: 'healthy',
+          service: this.config.name,
+          version: this.config.version,
+          uptime: Date.now() - this.config.startTime.getTime(),
+          timestamp: new Date().toISOString()
+        });
+      });
+    }
   }
 
   async start(): Promise<ServerInstance> {
@@ -184,11 +236,11 @@ export class ExpressServer implements ServerInstance {
           grpc.ServerCredentials.createInsecure(),
           () => {
             this.grpcServer!.start();
-            console.log(`🔗 gRPC server running on port ${port}`);
+            console.log(`🔗 ${this.config.name} gRPC server running on port ${port}`);
           }
         );
       } catch (error: unknown) {
-        console.warn('gRPC not available. Install @grpc/grpc-js to use gRPC features.');
+        console.warn(`${this.config.name}: gRPC not available. Install @grpc/grpc-js to use gRPC features.`);
       }
     }
   }
@@ -205,9 +257,9 @@ export class ExpressServer implements ServerInstance {
       };
       const rpcServer = jayson.server(this.rpcMethods);
       this.app.use(path, rpcServer.middleware());
-      console.log(`📡 JSON-RPC server mounted on ${path}`);
+      console.log(`📡 ${this.config.name} JSON-RPC server mounted on ${path}`);
     } catch (error: unknown) {
-      console.warn('JSON-RPC not available. Install jayson to use RPC features.');
+      console.warn(`${this.config.name}: JSON-RPC not available. Install jayson to use RPC features.`);
     }
   }
 
@@ -243,12 +295,12 @@ export class ExpressServer implements ServerInstance {
       }
     });
 
-    console.log(`🪝 Webhook registered at ${config.path}`);
+    console.log(`🪝 ${this.config.name} webhook registered at ${config.path}${config.secret ? ' (with signature verification)' : ''}`);
   }
 
   addSocketIO(config: SocketIOConfig = {}): unknown {
     if (!this.server) {
-      throw new Error('Server must be started before adding Socket.IO');
+      throw new Error(`${this.config.name}: Server must be started before adding Socket.IO`);
     }
 
     try {
@@ -284,7 +336,7 @@ export class ExpressServer implements ServerInstance {
       // Handle connections
       io.on('connection', (socket: unknown) => {
         const typedSocket = socket as SocketInstance;
-        console.log(`🔌 Socket connected: ${typedSocket.id}`);
+        console.log(`🔌 ${this.config.name}: Socket connected [${typedSocket.id}]`);
 
         // Call user-defined connection handler
         if (config.onConnection) {
@@ -293,7 +345,7 @@ export class ExpressServer implements ServerInstance {
 
         // Handle disconnection
         typedSocket.on('disconnect', (reason) => {
-          console.log(`🔌 Socket disconnected: ${typedSocket.id} - ${reason}`);
+          console.log(`🔌 ${this.config.name}: Socket disconnected [${typedSocket.id}] - ${reason}`);
 
           // Call user-defined disconnection handler
           if (config.onDisconnection) {
@@ -302,10 +354,10 @@ export class ExpressServer implements ServerInstance {
         });
       });
 
-      console.log(`🔌 Socket.IO server attached${config.path ? ` at ${config.path}` : ''}`);
+      console.log(`🔌 ${this.config.name} Socket.IO server attached${config.path ? ` at ${config.path}` : ''}${config.cors ? ' (CORS enabled)' : ''}`);
       return io;
     } catch (error: unknown) {
-      console.warn('Socket.IO not available. Install socket.io to use WebSocket features.');
+      console.warn(`${this.config.name}: Socket.IO not available. Install socket.io to use WebSocket features.`);
       return null;
     }
   }

package/src/shutdown.ts

@@ -2,13 +2,14 @@ import { Server } from 'http';
 import { GracefulShutdownConfig, ServerPlugin } from './types';
 
 export function createGracefulShutdown(server: Server, config: GracefulShutdownConfig = {}): void {
-  const { timeout = 10000, onShutdown } = config;
+  const { timeout = 10000, onShutdown, serverName, serverVersion } = config;
+  const nameVersion = serverName && serverVersion ? `${serverName} v${serverVersion}` : 'Server';
 
   const shutdown = async (signal: string) => {
-    console.log(`🛑 Received ${signal}, shutting down gracefully...`);
+    console.log(`🛑 ${nameVersion} received ${signal}, shutting down gracefully...`);
     
     const shutdownTimer = setTimeout(() => {
-      console.log('⏰ Shutdown timeout reached, forcing exit');
+      console.log(`⏰ ${nameVersion} shutdown timeout reached, forcing exit`);
       process.exit(1);
     }, timeout);
 
@@ -21,12 +22,12 @@ export function createGracefulShutdown(server: Server, config: GracefulShutdownC
       // Close server
       server.close(() => {
         clearTimeout(shutdownTimer);
-        console.log('👋 Server closed. Exiting now.');
+        console.log(`👋 ${nameVersion} closed. Exiting now.`);
         process.exit(0);
       });
     } catch (error) {
       clearTimeout(shutdownTimer);
-      console.error('❌ Error during shutdown:', error);
+      console.error(`❌ ${nameVersion} error during shutdown:`, error);
       process.exit(1);
     }
   };
@@ -46,15 +47,23 @@ export function withGracefulShutdown(config: GracefulShutdownConfig = {}): Serve
 export function startServerWithShutdown(
   app: any, 
   port: number, 
-  shutdownConfig: GracefulShutdownConfig = {}
+  shutdownConfig: GracefulShutdownConfig = {},
+  serverName?: string,
+  serverVersion?: string
 ): Server {
   const server = app.listen(port, () => {
-    console.log(`🚀 Server running on http://localhost:${port}`);
+    const nameVersion = serverName && serverVersion ? `${serverName} v${serverVersion}` : 'Server';
+    console.log(`🚀 ${nameVersion} running on http://localhost:${port}`);
   });
 
   // Apply graceful shutdown from stored config or provided config
   const config = app.__gracefulShutdownConfig || shutdownConfig;
-  createGracefulShutdown(server, config);
+  const enhancedConfig = {
+    ...config,
+    serverName,
+    serverVersion
+  };
+  createGracefulShutdown(server, enhancedConfig);
 
   return server;
 }

package/src/types.ts

@@ -49,6 +49,8 @@ export interface HealthCheck {
 export interface GracefulShutdownConfig {
   timeout?: number;
   onShutdown?: () => Promise<void>;
+  serverName?: string;
+  serverVersion?: string;
 }
 
 export interface SocketInstance {