ts-packages 1.0.0 → 2.0.0

package/packages/server-utils/dist/types/middleware/plugins.middleware.d.ts

@@ -0,0 +1,14 @@
+import type { RequestHandler } from 'express';
+import type { ServerPlugin } from '../types';
+import type { AuthConfig } from './auth.middleware';
+import type { RateLimitConfig } from './rateLimiter.middleware';
+import type { ValidationRule } from './validation.middleware';
+export declare function withLogging(format?: 'simple' | 'detailed'): ServerPlugin;
+export declare function withErrorHandler(): ServerPlugin;
+export declare function withRequestId(): ServerPlugin;
+export declare function withValidation(rules: ValidationRule[]): ServerPlugin;
+export declare function withRateLimit(config?: RateLimitConfig): ServerPlugin;
+export declare function withAuth(config: AuthConfig): ServerPlugin;
+export declare function validateFields(rules: ValidationRule[]): RequestHandler;
+export declare function rateLimit(config?: RateLimitConfig): RequestHandler;
+export declare function requireAuth(config: AuthConfig): RequestHandler;

package/packages/server-utils/dist/types/middleware/rateLimiter.middleware.d.ts

@@ -0,0 +1,8 @@
+import type { Request, RequestHandler } from 'node_modules/@types/express';
+export interface RateLimitConfig {
+    windowMs?: number;
+    maxRequests?: number;
+    message?: string;
+    keyGenerator?: (req: Request) => string;
+}
+export declare function createRateLimitMiddleware(config?: RateLimitConfig): RequestHandler;

package/packages/server-utils/dist/types/middleware/requestId.middleware.d.ts

@@ -0,0 +1,2 @@
+import type { RequestHandler } from 'node_modules/@types/express';
+export declare function createRequestIdMiddleware(): RequestHandler;

package/packages/server-utils/dist/types/middleware/session.middleware.d.ts

@@ -0,0 +1,2 @@
+import type { RequestHandler } from 'node_modules/@types/express';
+export declare function useSession(cookieName?: string): RequestHandler;

package/packages/server-utils/dist/types/middleware/validation.middleware.d.ts

@@ -0,0 +1,11 @@
+import type { RequestHandler } from 'node_modules/@types/express';
+export interface ValidationRule {
+    field: string;
+    required?: boolean;
+    type?: 'string' | 'number' | 'email' | 'boolean';
+    minLength?: number;
+    maxLength?: number;
+    pattern?: RegExp;
+    custom?: (value: unknown) => boolean | string;
+}
+export declare function createValidationMiddleware(rules: ValidationRule[]): RequestHandler;

package/packages/server-utils/dist/types/types/index.d.ts

@@ -0,0 +1,87 @@
+import type express from 'express';
+export interface CorsOptions {
+    origin?: string | string[] | boolean | RegExp | ((origin: string | undefined, callback: (err: Error | null, allow?: boolean) => void) => void);
+    methods?: string | string[];
+    allowedHeaders?: string | string[];
+    exposedHeaders?: string | string[];
+    credentials?: boolean;
+    maxAge?: number;
+    preflightContinue?: boolean;
+    optionsSuccessStatus?: number;
+}
+export interface ServerConfig {
+    port?: number;
+    cors?: boolean | CorsOptions;
+    helmet?: boolean;
+    json?: boolean;
+    cookieParser?: boolean;
+    customMiddleware?: express.RequestHandler[];
+    healthCheck?: boolean | string;
+    gracefulShutdown?: boolean;
+    socketIO?: SocketIOConfig;
+    periodicHealthCheck?: PeriodicHealthCheckConfig;
+    name?: string;
+    version?: string;
+    cache?: {
+        enabled?: boolean;
+        adapter?: 'redis' | 'memcache' | 'memory';
+        options?: unknown;
+        defaultTTL?: number;
+    };
+    session?: {
+        enabled?: boolean;
+        cookieName?: string;
+        ttl?: number;
+        cookieOptions?: {
+            path?: string;
+            httpOnly?: boolean;
+            secure?: boolean;
+            sameSite?: 'lax' | 'strict' | 'none';
+        };
+    };
+}
+export interface PeriodicHealthCheckConfig {
+    enabled?: boolean;
+    interval?: number;
+    services?: HealthCheckService[];
+}
+export interface HealthCheckService {
+    name: string;
+    url: string;
+    timeout?: number;
+}
+export interface SocketIOConfig {
+    enabled?: boolean;
+    cors?: boolean | {
+        origin?: string | string[] | boolean;
+        methods?: string[];
+        credentials?: boolean;
+    };
+    onConnection?: (socket: unknown) => void;
+    onDisconnection?: (socket: unknown, reason: string) => void;
+    path?: string;
+}
+export interface HealthCheckConfig {
+    path?: string;
+    customChecks?: HealthCheck[];
+}
+export interface HealthCheck {
+    name: string;
+    check: () => Promise<boolean>;
+}
+export interface GracefulShutdownConfig {
+    timeout?: number;
+    onShutdown?: () => Promise<void>;
+    serverName?: string;
+    serverVersion?: string;
+}
+export interface SocketInstance {
+    id: string;
+    emit: (event: string, data?: unknown) => void;
+    on: (event: string, handler: (...args: unknown[]) => void) => void;
+    broadcast: {
+        emit: (event: string, data?: unknown) => void;
+    };
+    disconnect: () => void;
+}
+export type ServerPlugin = (app: express.Application, config: ServerConfig) => void;

package/packages/server-utils/dist/types/utils/utils.d.ts

@@ -0,0 +1,3 @@
+export declare function getEnv(key: string, defaultValue?: string): string;
+export declare function getEnvNumber(key: string, defaultValue?: number): number;
+export declare function getEnvBoolean(key: string, defaultValue?: boolean): boolean;

package/packages/server-utils/node_modules/.bin/rimraf

@@ -0,0 +1,21 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*|*MINGW*|*MSYS*)
+        if command -v cygpath > /dev/null 2>&1; then
+            basedir=`cygpath -w "$basedir"`
+        fi
+    ;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/namandev2704/projects/ts-packages/node_modules/.pnpm/rimraf@5.0.10/node_modules/rimraf/dist/esm/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/rimraf@5.0.10/node_modules/rimraf/dist/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/rimraf@5.0.10/node_modules/rimraf/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/rimraf@5.0.10/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/namandev2704/projects/ts-packages/node_modules/.pnpm/rimraf@5.0.10/node_modules/rimraf/dist/esm/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/rimraf@5.0.10/node_modules/rimraf/dist/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/rimraf@5.0.10/node_modules/rimraf/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/rimraf@5.0.10/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/node_modules:$NODE_PATH"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../rimraf/dist/esm/bin.mjs" "$@"
+else
+  exec node  "$basedir/../rimraf/dist/esm/bin.mjs" "$@"
+fi

package/packages/server-utils/node_modules/.bin/tsc

@@ -0,0 +1,21 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*|*MINGW*|*MSYS*)
+        if command -v cygpath > /dev/null 2>&1; then
+            basedir=`cygpath -w "$basedir"`
+        fi
+    ;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/bin/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/bin/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/node_modules:$NODE_PATH"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../typescript/bin/tsc" "$@"
+else
+  exec node  "$basedir/../typescript/bin/tsc" "$@"
+fi

package/packages/server-utils/node_modules/.bin/tsserver

@@ -0,0 +1,21 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*|*MINGW*|*MSYS*)
+        if command -v cygpath > /dev/null 2>&1; then
+            basedir=`cygpath -w "$basedir"`
+        fi
+    ;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/bin/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/bin/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/namandev2704/projects/ts-packages/node_modules/.pnpm/node_modules:$NODE_PATH"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../typescript/bin/tsserver" "$@"
+else
+  exec node  "$basedir/../typescript/bin/tsserver" "$@"
+fi

package/packages/server-utils/package.json

@@ -1,11 +1,27 @@
 {
   "name": "@naman_deep_singh/server-utils",
-  "version": "1.0.1",
+  "version": "1.4.3",
   "description": "Extensible server utilities for Express.js microservices with TypeScript",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "scripts": {
-    "build": "tsc"
+    "build": "pnpm run build:types && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json",
+    "build:types": "tsc -p tsconfig.base.json --emitDeclarationOnly --outDir dist/types",
+    "clean": "rimraf dist",
+    "prepublishOnly": "npm run clean && npm run build"
   },
   "keywords": [
     "server",
@@ -18,10 +34,18 @@
   "license": "ISC",
   "packageManager": "pnpm@10.20.0",
   "dependencies": {
-    "express": "^4.21.1"
+    "@naman_deep_singh/cache": "^1.3.1",
+    "@naman_deep_singh/errors-utils": "^1.1.1",
+    "@naman_deep_singh/security": "^1.3.2",
+    "@types/express": "^5.0.5",
+    "cookie-parser": "^1.4.6",
+    "cors": "^2.8.5",
+    "express": "^5.1.0",
+    "helmet": "^8.1.0"
   },
   "devDependencies": {
-    "@types/express": "^4.17.21",
+    "@types/cors": "^2.8.19",
+    "rimraf": "^5.0.5",
     "typescript": "^5.9.3"
   }
 }

package/packages/server-utils/src/core/health.ts

@@ -0,0 +1,58 @@
+import type { Application, Request, RequestHandler, Response } from 'express'
+import type { HealthCheckConfig, ServerPlugin } from '../types'
+
+export function createHealthCheck(
+	config: HealthCheckConfig = {},
+): RequestHandler {
+	const { customChecks = [] } = config
+
+	return async (_req: Request, res: Response) => {
+		try {
+			const checks: Record<string, boolean> = {
+				server: true,
+				timestamp: Date.now() as any,
+			}
+
+			// Run custom health checks
+			for (const check of customChecks) {
+				try {
+					checks[check.name] = await check.check()
+				} catch (_error) {
+					checks[check.name] = false
+				}
+			}
+
+			const isHealthy = Object.values(checks).every(
+				(status) => status === true || typeof status === 'number',
+			)
+
+			res.status(isHealthy ? 200 : 503).json({
+				status: isHealthy ? 'healthy' : 'unhealthy',
+				checks,
+			})
+		} catch (_error) {
+			res.status(503).json({
+				status: 'unhealthy',
+				error: 'Health check failed',
+			})
+		}
+	}
+}
+
+export function withHealthCheck(
+	path = '/health',
+	config: HealthCheckConfig = {},
+): ServerPlugin {
+	return (app: Application) => {
+		app.get(path, createHealthCheck(config))
+	}
+}
+
+// Convenience function for direct use
+export function addHealthCheck(
+	app: Application,
+	path = '/health',
+	config: HealthCheckConfig = {},
+): void {
+	app.get(path, createHealthCheck(config))
+}

package/packages/server-utils/src/core/periodic-health.ts

@@ -0,0 +1,88 @@
+import type { HealthCheckService, PeriodicHealthCheckConfig } from '../types'
+
+export class PeriodicHealthMonitor {
+	private intervals: NodeJS.Timeout[] = []
+	private config: PeriodicHealthCheckConfig
+	private serviceName: string
+
+	constructor(config: PeriodicHealthCheckConfig, serviceName: string) {
+		this.config = config
+		this.serviceName = serviceName
+	}
+
+	start(): void {
+		if (!this.config.enabled || !this.config.services?.length) {
+			return
+		}
+
+		const interval = this.config.interval || 30000
+
+		this.config.services.forEach((service) => {
+			const intervalId = setInterval(async () => {
+				await this.checkServiceHealth(service)
+			}, interval)
+
+			this.intervals.push(intervalId)
+		})
+
+		console.log(
+			`📊 ${this.serviceName}: Periodic health monitoring enabled (${interval}ms interval) for ${this.config.services.length} service(s)`,
+		)
+	}
+
+	stop(): void {
+		this.intervals.forEach((interval) => clearInterval(interval))
+		this.intervals = []
+		console.log(`🛑 ${this.serviceName}: Periodic health monitoring stopped`)
+	}
+
+	private async checkServiceHealth(
+		service: HealthCheckService,
+	): Promise<boolean> {
+		try {
+			const controller = new AbortController()
+			const timeout = service.timeout || 5000
+			const timeoutId = setTimeout(() => controller.abort(), timeout)
+
+			const response = await fetch(service.url, {
+				method: 'GET',
+				signal: controller.signal,
+				headers: {
+					'User-Agent': `${this.serviceName}-health-monitor`,
+				},
+			})
+
+			clearTimeout(timeoutId)
+
+			if (response.ok) {
+				console.log(`🟢 ${service.name} is healthy`)
+				return true
+			} else {
+				console.log(`🔴 ${service.name} returned ${response.status}`)
+				return false
+			}
+		} catch (error) {
+			const errorMessage =
+				error instanceof Error ? error.message : 'Unknown error'
+			console.log(`🔴 ${service.name} health check failed: ${errorMessage}`)
+			return false
+		}
+	}
+
+	// Get current health status of all services
+	async getHealthStatus(): Promise<Record<string, boolean>> {
+		if (!this.config.services?.length) {
+			return {}
+		}
+
+		const results: Record<string, boolean> = {}
+
+		await Promise.all(
+			this.config.services.map(async (service) => {
+				results[service.name] = await this.checkServiceHealth(service)
+			}),
+		)
+
+		return results
+	}
+}