@naman_deep_singh/server-utils 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. package/README.md +19 -5
  2. package/dist/cjs/core/health.d.ts +5 -0
  3. package/dist/cjs/{periodic-health.d.ts → core/periodic-health.d.ts} +1 -1
  4. package/dist/{types → cjs/core}/server.d.ts +4 -4
  5. package/dist/cjs/{server.js → core/server.js} +40 -7
  6. package/dist/cjs/{shutdown.d.ts → core/shutdown.d.ts} +1 -1
  7. package/dist/cjs/index.d.ts +11 -11
  8. package/dist/cjs/index.js +10 -10
  9. package/dist/cjs/middleware/auth.middleware.d.ts +7 -0
  10. package/dist/cjs/middleware/auth.middleware.js +41 -0
  11. package/dist/cjs/middleware/cache.middleware.d.ts +2 -0
  12. package/dist/cjs/middleware/cache.middleware.js +56 -0
  13. package/dist/cjs/middleware/errorHandler.middleware.d.ts +2 -0
  14. package/dist/cjs/middleware/errorHandler.middleware.js +28 -0
  15. package/dist/cjs/middleware/index.d.ts +10 -0
  16. package/dist/cjs/middleware/index.js +40 -0
  17. package/dist/cjs/middleware/logging.middleware.d.ts +2 -0
  18. package/dist/cjs/middleware/logging.middleware.js +19 -0
  19. package/dist/cjs/middleware/plugins.middleware.d.ts +14 -0
  20. package/dist/cjs/middleware/plugins.middleware.js +58 -0
  21. package/dist/cjs/middleware/rateLimiter.middleware.d.ts +8 -0
  22. package/dist/cjs/middleware/rateLimiter.middleware.js +35 -0
  23. package/dist/cjs/middleware/requestId.middleware.d.ts +2 -0
  24. package/dist/cjs/middleware/requestId.middleware.js +12 -0
  25. package/dist/cjs/middleware/session.middleware.d.ts +2 -0
  26. package/dist/cjs/middleware/session.middleware.js +50 -0
  27. package/dist/cjs/middleware/validation.middleware.d.ts +11 -0
  28. package/dist/cjs/middleware/validation.middleware.js +66 -0
  29. package/dist/esm/core/health.d.ts +5 -0
  30. package/dist/esm/{periodic-health.d.ts → core/periodic-health.d.ts} +1 -1
  31. package/dist/esm/{server.d.ts → core/server.d.ts} +4 -4
  32. package/dist/esm/{server.js → core/server.js} +7 -7
  33. package/dist/esm/{shutdown.d.ts → core/shutdown.d.ts} +1 -1
  34. package/dist/esm/index.d.ts +11 -11
  35. package/dist/esm/index.js +10 -10
  36. package/dist/esm/middleware/auth.middleware.d.ts +7 -0
  37. package/dist/esm/middleware/auth.middleware.js +38 -0
  38. package/dist/esm/middleware/cache.middleware.d.ts +2 -0
  39. package/dist/esm/middleware/cache.middleware.js +53 -0
  40. package/dist/esm/middleware/errorHandler.middleware.d.ts +2 -0
  41. package/dist/esm/middleware/errorHandler.middleware.js +25 -0
  42. package/dist/esm/middleware/index.d.ts +10 -0
  43. package/dist/esm/middleware/index.js +20 -0
  44. package/dist/esm/middleware/logging.middleware.d.ts +2 -0
  45. package/dist/esm/middleware/logging.middleware.js +16 -0
  46. package/dist/esm/middleware/plugins.middleware.d.ts +14 -0
  47. package/dist/esm/middleware/plugins.middleware.js +47 -0
  48. package/dist/esm/middleware/rateLimiter.middleware.d.ts +8 -0
  49. package/dist/esm/middleware/rateLimiter.middleware.js +32 -0
  50. package/dist/esm/middleware/requestId.middleware.d.ts +2 -0
  51. package/dist/esm/middleware/requestId.middleware.js +9 -0
  52. package/dist/esm/middleware/session.middleware.d.ts +2 -0
  53. package/dist/esm/middleware/session.middleware.js +47 -0
  54. package/dist/esm/middleware/validation.middleware.d.ts +11 -0
  55. package/dist/esm/middleware/validation.middleware.js +63 -0
  56. package/dist/types/core/health.d.ts +5 -0
  57. package/dist/types/{periodic-health.d.ts → core/periodic-health.d.ts} +1 -1
  58. package/dist/{cjs → types/core}/server.d.ts +4 -4
  59. package/dist/types/{shutdown.d.ts → core/shutdown.d.ts} +1 -1
  60. package/dist/types/index.d.ts +11 -11
  61. package/dist/types/middleware/auth.middleware.d.ts +7 -0
  62. package/dist/types/middleware/cache.middleware.d.ts +2 -0
  63. package/dist/types/middleware/errorHandler.middleware.d.ts +2 -0
  64. package/dist/types/middleware/index.d.ts +10 -0
  65. package/dist/types/middleware/logging.middleware.d.ts +2 -0
  66. package/dist/types/middleware/plugins.middleware.d.ts +14 -0
  67. package/dist/types/middleware/rateLimiter.middleware.d.ts +8 -0
  68. package/dist/types/middleware/requestId.middleware.d.ts +2 -0
  69. package/dist/types/middleware/session.middleware.d.ts +2 -0
  70. package/dist/types/middleware/validation.middleware.d.ts +11 -0
  71. package/package.json +3 -1
  72. package/dist/cjs/health.d.ts +0 -5
  73. package/dist/cjs/middleware.d.ts +0 -39
  74. package/dist/cjs/middleware.js +0 -348
  75. package/dist/esm/health.d.ts +0 -5
  76. package/dist/esm/middleware.d.ts +0 -39
  77. package/dist/esm/middleware.js +0 -329
  78. package/dist/types/health.d.ts +0 -5
  79. package/dist/types/middleware.d.ts +0 -39
  80. /package/dist/cjs/{health.js → core/health.js} +0 -0
  81. /package/dist/cjs/{periodic-health.js → core/periodic-health.js} +0 -0
  82. /package/dist/cjs/{shutdown.js → core/shutdown.js} +0 -0
  83. /package/dist/cjs/{types.d.ts → types/index.d.ts} +0 -0
  84. /package/dist/cjs/{types.js → types/index.js} +0 -0
  85. /package/dist/cjs/{utils.d.ts → utils/utils.d.ts} +0 -0
  86. /package/dist/cjs/{utils.js → utils/utils.js} +0 -0
  87. /package/dist/esm/{health.js → core/health.js} +0 -0
  88. /package/dist/esm/{periodic-health.js → core/periodic-health.js} +0 -0
  89. /package/dist/esm/{shutdown.js → core/shutdown.js} +0 -0
  90. /package/dist/esm/{types.d.ts → types/index.d.ts} +0 -0
  91. /package/dist/esm/{types.js → types/index.js} +0 -0
  92. /package/dist/esm/{utils.d.ts → utils/utils.d.ts} +0 -0
  93. /package/dist/esm/{utils.js → utils/utils.js} +0 -0
  94. /package/dist/types/{types.d.ts → types/index.d.ts} +0 -0
  95. /package/dist/types/{utils.d.ts → utils/utils.d.ts} +0 -0
@@ -1,329 +0,0 @@
1
- // Logging middleware
2
- export function createLoggingMiddleware(format = 'simple') {
3
- return (req, res, next) => {
4
- const start = Date.now();
5
- res.on('finish', () => {
6
- const duration = Date.now() - start;
7
- if (format === 'detailed') {
8
- console.log(`${req.method} ${req.url} - ${res.statusCode} - ${duration}ms - ${req.ip}`);
9
- }
10
- else {
11
- console.log(`${req.method} ${req.url} - ${res.statusCode}`);
12
- }
13
- });
14
- next();
15
- };
16
- }
17
- // Error handling middleware
18
- export function createErrorHandler() {
19
- return (err, req, res, next) => {
20
- console.error('Error:', err);
21
- if (res.headersSent) {
22
- return next(err);
23
- }
24
- // Type guard for error objects
25
- const errorObj = err;
26
- const status = errorObj.status || errorObj.statusCode || 500;
27
- const message = process.env.NODE_ENV === 'production'
28
- ? 'Internal Server Error'
29
- : errorObj.message || 'Unknown error';
30
- res.status(status).json({
31
- success: false,
32
- message,
33
- data: undefined,
34
- error: {
35
- message,
36
- ...(process.env.NODE_ENV !== 'production' && { details: { stack: errorObj.stack } })
37
- },
38
- meta: null
39
- });
40
- };
41
- }
42
- // Request ID middleware
43
- export function createRequestIdMiddleware() {
44
- return (req, res, next) => {
45
- const requestId = Math.random().toString(36).substring(2, 15);
46
- req.requestId = requestId;
47
- res.setHeader('X-Request-ID', requestId);
48
- next();
49
- };
50
- }
51
- export function createValidationMiddleware(rules) {
52
- return (req, res, next) => {
53
- const errors = [];
54
- for (const rule of rules) {
55
- const value = req.body[rule.field];
56
- if (rule.required && (value === undefined || value === null || value === '')) {
57
- errors.push(`${rule.field} is required`);
58
- continue;
59
- }
60
- if (value === undefined || value === null)
61
- continue;
62
- if (rule.type) {
63
- switch (rule.type) {
64
- case 'email':
65
- const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
66
- if (!emailRegex.test(value)) {
67
- errors.push(`${rule.field} must be a valid email`);
68
- }
69
- break;
70
- case 'string':
71
- if (typeof value !== 'string') {
72
- errors.push(`${rule.field} must be a string`);
73
- }
74
- break;
75
- case 'number':
76
- if (typeof value !== 'number' && isNaN(Number(value))) {
77
- errors.push(`${rule.field} must be a number`);
78
- }
79
- break;
80
- case 'boolean':
81
- if (typeof value !== 'boolean') {
82
- errors.push(`${rule.field} must be a boolean`);
83
- }
84
- break;
85
- }
86
- }
87
- if (rule.minLength && value.length < rule.minLength) {
88
- errors.push(`${rule.field} must be at least ${rule.minLength} characters`);
89
- }
90
- if (rule.maxLength && value.length > rule.maxLength) {
91
- errors.push(`${rule.field} must be no more than ${rule.maxLength} characters`);
92
- }
93
- if (rule.pattern && !rule.pattern.test(value)) {
94
- errors.push(`${rule.field} format is invalid`);
95
- }
96
- if (rule.custom) {
97
- const result = rule.custom(value);
98
- if (result !== true) {
99
- errors.push(typeof result === 'string' ? result : `${rule.field} is invalid`);
100
- }
101
- }
102
- }
103
- if (errors.length > 0) {
104
- return res.status(400).json({
105
- success: false,
106
- message: 'Validation failed',
107
- data: undefined,
108
- error: {
109
- message: 'Validation failed',
110
- details: errors
111
- },
112
- meta: null
113
- });
114
- }
115
- next();
116
- };
117
- }
118
- const rateLimitStore = new Map();
119
- export function createRateLimitMiddleware(config = {}) {
120
- const { windowMs = 15 * 60 * 1000, maxRequests = 100, message = 'Too many requests, please try again later', keyGenerator = (req) => req.ip || 'unknown' } = config;
121
- return (req, res, next) => {
122
- const key = keyGenerator(req);
123
- const now = Date.now();
124
- const record = rateLimitStore.get(key);
125
- if (!record || now > record.resetTime) {
126
- rateLimitStore.set(key, {
127
- count: 1,
128
- resetTime: now + windowMs
129
- });
130
- return next();
131
- }
132
- if (record.count >= maxRequests) {
133
- return res.status(429).json({
134
- success: false,
135
- message,
136
- data: undefined,
137
- error: {
138
- message,
139
- details: {
140
- retryAfter: Math.ceil((record.resetTime - now) / 1000)
141
- }
142
- },
143
- meta: null
144
- });
145
- }
146
- record.count++;
147
- next();
148
- };
149
- }
150
- export function createAuthMiddleware(config) {
151
- const { tokenExtractor = (req) => {
152
- const authHeader = req.headers.authorization;
153
- if (authHeader && authHeader.startsWith('Bearer ')) {
154
- return authHeader.substring(7);
155
- }
156
- return req.cookies?.token || null;
157
- }, tokenValidator = () => { throw new Error('Token validator not implemented'); }, unauthorizedMessage = 'Unauthorized access' } = config;
158
- return async (req, res, next) => {
159
- try {
160
- const token = tokenExtractor(req);
161
- if (!token) {
162
- return res.status(401).json({
163
- success: false,
164
- message: unauthorizedMessage,
165
- data: undefined,
166
- error: {
167
- message: unauthorizedMessage
168
- },
169
- meta: null
170
- });
171
- }
172
- const user = await tokenValidator(token);
173
- req.user = user;
174
- next();
175
- }
176
- catch (error) {
177
- return res.status(401).json({
178
- success: false,
179
- message: unauthorizedMessage,
180
- data: undefined,
181
- error: {
182
- message: unauthorizedMessage
183
- },
184
- meta: null
185
- });
186
- }
187
- };
188
- }
189
- // Plugin versions
190
- export function withLogging(format = 'simple') {
191
- return (app) => {
192
- app.use(createLoggingMiddleware(format));
193
- };
194
- }
195
- export function withErrorHandler() {
196
- return (app) => {
197
- app.use(createErrorHandler());
198
- };
199
- }
200
- export function withRequestId() {
201
- return (app) => {
202
- app.use(createRequestIdMiddleware());
203
- };
204
- }
205
- export function withValidation(rules) {
206
- return (app) => {
207
- app.use(createValidationMiddleware(rules));
208
- };
209
- }
210
- export function withRateLimit(config = {}) {
211
- return (app) => {
212
- app.use(createRateLimitMiddleware(config));
213
- };
214
- }
215
- export function withAuth(config) {
216
- return (app) => {
217
- app.use(createAuthMiddleware(config));
218
- };
219
- }
220
- // Convenience functions for route-specific middleware
221
- export function validateFields(rules) {
222
- return createValidationMiddleware(rules);
223
- }
224
- export function rateLimit(config = {}) {
225
- return createRateLimitMiddleware(config);
226
- }
227
- export function requireAuth(config) {
228
- return createAuthMiddleware(config);
229
- }
230
- // Cache response middleware (per-route opt-in)
231
- export function cacheResponse(ttl) {
232
- return async (req, res, next) => {
233
- try {
234
- if (req.method !== 'GET')
235
- return next();
236
- const cache = (req.cache ?? req.app.locals.cache);
237
- const defaultTTL = req.app.locals.cacheDefaultTTL;
238
- if (!cache || typeof cache.get !== 'function')
239
- return next();
240
- const key = `${req.originalUrl}`;
241
- try {
242
- const cached = await cache.get(key);
243
- if (cached !== null && cached !== undefined) {
244
- res.setHeader('X-Cache', 'HIT');
245
- return res.json(cached);
246
- }
247
- }
248
- catch (cacheErr) {
249
- console.error(`[Cache] Failed to retrieve key "${key}":`, cacheErr);
250
- // Continue without cache hit
251
- }
252
- const originalJson = res.json.bind(res);
253
- res.json = (body) => {
254
- try {
255
- const expiry = ttl ?? defaultTTL;
256
- if (expiry && cache && typeof cache.set === 'function') {
257
- cache.set(key, body, expiry).catch((err) => {
258
- console.error(`[Cache] Failed to set key "${key}" with TTL ${expiry}:`, err);
259
- });
260
- }
261
- else if (cache) {
262
- if (typeof cache.set === 'function') {
263
- cache.set(key, body).catch((err) => {
264
- console.error(`[Cache] Failed to set key "${key}":`, err);
265
- });
266
- }
267
- }
268
- }
269
- catch (e) {
270
- console.error(`[Cache] Error during cache.set operation:`, e);
271
- }
272
- res.setHeader('X-Cache', 'MISS');
273
- return originalJson(body);
274
- };
275
- next();
276
- }
277
- catch (err) {
278
- console.error('[Cache] Unexpected error in cacheResponse middleware:', err);
279
- next();
280
- }
281
- };
282
- }
283
- // Session middleware helper (attaches sessionStore and helpers to req)
284
- export function useSession(cookieName) {
285
- return async (req, res, next) => {
286
- try {
287
- const store = req.app.locals.sessionStore;
288
- if (!store)
289
- return next();
290
- const name = cookieName || req.app.locals.sessionCookieName || 'sid';
291
- let sid = req.cookies?.[name];
292
- if (!sid) {
293
- const cookieHeader = req.headers.cookie;
294
- if (cookieHeader) {
295
- const match = cookieHeader.split(';').map(s => s.trim()).find(s => s.startsWith(name + '='));
296
- if (match)
297
- sid = match.split('=')[1];
298
- }
299
- }
300
- req.sessionId = sid;
301
- req.sessionStore = store;
302
- req.getSession = async () => {
303
- if (!sid)
304
- return null;
305
- try {
306
- return await store.get(sid);
307
- }
308
- catch (err) {
309
- console.error(`[Session] Failed to get session "${sid}":`, err);
310
- throw err;
311
- }
312
- };
313
- req.createSession = async (id, data, ttl) => {
314
- try {
315
- return await store.create(id, data, ttl);
316
- }
317
- catch (err) {
318
- console.error(`[Session] Failed to create session "${id}":`, err);
319
- throw err;
320
- }
321
- };
322
- next();
323
- }
324
- catch (err) {
325
- console.error('[Session] Unexpected error in useSession middleware:', err);
326
- next();
327
- }
328
- };
329
- }
@@ -1,5 +0,0 @@
1
- import express from 'express';
2
- import { HealthCheckConfig, ServerPlugin } from './types';
3
- export declare function createHealthCheck(config?: HealthCheckConfig): express.RequestHandler;
4
- export declare function withHealthCheck(path?: string, config?: HealthCheckConfig): ServerPlugin;
5
- export declare function addHealthCheck(app: express.Application, path?: string, config?: HealthCheckConfig): void;
@@ -1,39 +0,0 @@
1
- import express from 'express';
2
- import { ServerPlugin } from './types';
3
- export declare function createLoggingMiddleware(format?: 'simple' | 'detailed'): express.RequestHandler;
4
- export declare function createErrorHandler(): express.ErrorRequestHandler;
5
- export declare function createRequestIdMiddleware(): express.RequestHandler;
6
- export interface ValidationRule {
7
- field: string;
8
- required?: boolean;
9
- type?: 'string' | 'number' | 'email' | 'boolean';
10
- minLength?: number;
11
- maxLength?: number;
12
- pattern?: RegExp;
13
- custom?: (value: unknown) => boolean | string;
14
- }
15
- export declare function createValidationMiddleware(rules: ValidationRule[]): express.RequestHandler;
16
- export interface RateLimitConfig {
17
- windowMs?: number;
18
- maxRequests?: number;
19
- message?: string;
20
- keyGenerator?: (req: express.Request) => string;
21
- }
22
- export declare function createRateLimitMiddleware(config?: RateLimitConfig): express.RequestHandler;
23
- export interface AuthConfig {
24
- tokenExtractor?: (req: express.Request) => string | null;
25
- tokenValidator?: (token: string) => Promise<unknown> | unknown;
26
- unauthorizedMessage?: string;
27
- }
28
- export declare function createAuthMiddleware(config: AuthConfig): express.RequestHandler;
29
- export declare function withLogging(format?: 'simple' | 'detailed'): ServerPlugin;
30
- export declare function withErrorHandler(): ServerPlugin;
31
- export declare function withRequestId(): ServerPlugin;
32
- export declare function withValidation(rules: ValidationRule[]): ServerPlugin;
33
- export declare function withRateLimit(config?: RateLimitConfig): ServerPlugin;
34
- export declare function withAuth(config: AuthConfig): ServerPlugin;
35
- export declare function validateFields(rules: ValidationRule[]): express.RequestHandler;
36
- export declare function rateLimit(config?: RateLimitConfig): express.RequestHandler;
37
- export declare function requireAuth(config: AuthConfig): express.RequestHandler;
38
- export declare function cacheResponse(ttl?: number): express.RequestHandler;
39
- export declare function useSession(cookieName?: string): express.RequestHandler;
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes