@naman_deep_singh/server-utils 1.4.0 → 1.4.1
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.
- package/README.md +1 -1
- package/dist/cjs/core/health.d.ts +2 -2
- package/dist/cjs/core/health.js +4 -4
- package/dist/cjs/core/periodic-health.d.ts +1 -1
- package/dist/cjs/core/periodic-health.js +4 -4
- package/dist/cjs/core/server.d.ts +6 -5
- package/dist/cjs/core/server.js +34 -22
- package/dist/cjs/core/shutdown.d.ts +2 -2
- package/dist/cjs/core/shutdown.js +2 -1
- package/dist/cjs/index.d.ts +11 -11
- package/dist/cjs/index.js +2 -2
- package/dist/cjs/middleware/auth.middleware.d.ts +1 -1
- package/dist/cjs/middleware/auth.middleware.js +5 -5
- package/dist/cjs/middleware/cache.middleware.d.ts +1 -1
- package/dist/cjs/middleware/cache.middleware.js +2 -0
- package/dist/cjs/middleware/errorHandler.middleware.d.ts +1 -1
- package/dist/cjs/middleware/errorHandler.middleware.js +4 -2
- package/dist/cjs/middleware/index.d.ts +4 -4
- package/dist/cjs/middleware/logging.middleware.d.ts +1 -1
- package/dist/cjs/middleware/plugins.middleware.d.ts +5 -5
- package/dist/cjs/middleware/plugins.middleware.js +3 -3
- package/dist/cjs/middleware/rateLimiter.middleware.d.ts +1 -1
- package/dist/cjs/middleware/rateLimiter.middleware.js +5 -5
- package/dist/cjs/middleware/requestId.middleware.d.ts +1 -1
- package/dist/cjs/middleware/session.middleware.d.ts +1 -1
- package/dist/cjs/middleware/session.middleware.js +4 -1
- package/dist/cjs/middleware/validation.middleware.d.ts +1 -1
- package/dist/cjs/middleware/validation.middleware.js +3 -2
- package/dist/cjs/types/index.d.ts +1 -1
- package/dist/cjs/utils/utils.js +2 -2
- package/dist/esm/core/health.d.ts +2 -2
- package/dist/esm/core/health.js +4 -4
- package/dist/esm/core/periodic-health.d.ts +1 -1
- package/dist/esm/core/periodic-health.js +4 -4
- package/dist/esm/core/server.d.ts +6 -5
- package/dist/esm/core/server.js +33 -21
- package/dist/esm/core/shutdown.d.ts +2 -2
- package/dist/esm/core/shutdown.js +2 -1
- package/dist/esm/index.d.ts +11 -11
- package/dist/esm/index.js +9 -9
- package/dist/esm/middleware/auth.middleware.d.ts +1 -1
- package/dist/esm/middleware/auth.middleware.js +6 -6
- package/dist/esm/middleware/cache.middleware.d.ts +1 -1
- package/dist/esm/middleware/cache.middleware.js +2 -0
- package/dist/esm/middleware/errorHandler.middleware.d.ts +1 -1
- package/dist/esm/middleware/errorHandler.middleware.js +4 -2
- package/dist/esm/middleware/index.d.ts +4 -4
- package/dist/esm/middleware/index.js +4 -4
- package/dist/esm/middleware/logging.middleware.d.ts +1 -1
- package/dist/esm/middleware/plugins.middleware.d.ts +5 -5
- package/dist/esm/middleware/plugins.middleware.js +3 -3
- package/dist/esm/middleware/rateLimiter.middleware.d.ts +1 -1
- package/dist/esm/middleware/rateLimiter.middleware.js +5 -5
- package/dist/esm/middleware/requestId.middleware.d.ts +1 -1
- package/dist/esm/middleware/session.middleware.d.ts +1 -1
- package/dist/esm/middleware/session.middleware.js +4 -1
- package/dist/esm/middleware/validation.middleware.d.ts +1 -1
- package/dist/esm/middleware/validation.middleware.js +4 -3
- package/dist/esm/types/index.d.ts +1 -1
- package/dist/esm/utils/utils.js +2 -2
- package/dist/types/core/health.d.ts +2 -2
- package/dist/types/core/periodic-health.d.ts +1 -1
- package/dist/types/core/server.d.ts +6 -5
- package/dist/types/core/shutdown.d.ts +2 -2
- package/dist/types/index.d.ts +11 -11
- package/dist/types/middleware/auth.middleware.d.ts +1 -1
- package/dist/types/middleware/cache.middleware.d.ts +1 -1
- package/dist/types/middleware/errorHandler.middleware.d.ts +1 -1
- package/dist/types/middleware/index.d.ts +4 -4
- package/dist/types/middleware/logging.middleware.d.ts +1 -1
- package/dist/types/middleware/plugins.middleware.d.ts +5 -5
- package/dist/types/middleware/rateLimiter.middleware.d.ts +1 -1
- package/dist/types/middleware/requestId.middleware.d.ts +1 -1
- package/dist/types/middleware/session.middleware.d.ts +1 -1
- package/dist/types/middleware/validation.middleware.d.ts +1 -1
- package/dist/types/types/index.d.ts +1 -1
- package/package.json +4 -4
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { ICache, SessionStore } from '@naman_deep_singh/cache';
|
|
2
|
+
import type { Server } from 'http';
|
|
3
|
+
import type { Application } from 'express';
|
|
4
|
+
import type { ServerConfig, SocketIOConfig } from '../types';
|
|
4
5
|
export interface GrpcService {
|
|
5
6
|
service: Record<string, unknown>;
|
|
6
7
|
implementation: Record<string, (...args: unknown[]) => unknown>;
|
|
@@ -49,8 +50,8 @@ export declare class ExpressServer implements ServerInstance {
|
|
|
49
50
|
app: Application;
|
|
50
51
|
server?: Server;
|
|
51
52
|
config: ServerInstanceConfig;
|
|
52
|
-
cache?:
|
|
53
|
-
sessionStore?:
|
|
53
|
+
cache?: ICache<unknown>;
|
|
54
|
+
sessionStore?: SessionStore | undefined;
|
|
54
55
|
private status;
|
|
55
56
|
private grpcServices;
|
|
56
57
|
private grpcServer?;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { Server } from 'http';
|
|
2
|
-
import { GracefulShutdownConfig, ServerPlugin } from '../types';
|
|
1
|
+
import type { Server } from 'http';
|
|
2
|
+
import type { GracefulShutdownConfig, ServerPlugin } from '../types';
|
|
3
3
|
export declare function createGracefulShutdown(server: Server, config?: GracefulShutdownConfig): void;
|
|
4
4
|
export declare function withGracefulShutdown(config?: GracefulShutdownConfig): ServerPlugin;
|
|
5
5
|
export declare function startServerWithShutdown(app: import('express').Application, port: number, shutdownConfig?: GracefulShutdownConfig, serverName?: string, serverVersion?: string): Server;
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
export { ExpressServer, createServer } from './core/server';
|
|
2
|
-
export type { ServerInstance, ServerInfo, GrpcService, RpcMethod, WebhookConfig } from './core/server';
|
|
2
|
+
export type { ServerInstance, ServerInfo, GrpcService, RpcMethod, WebhookConfig, } from './core/server';
|
|
3
3
|
export { Request, Response, NextFunction, Router, Application } from 'express';
|
|
4
4
|
export type { RequestHandler, ErrorRequestHandler } from 'express';
|
|
5
|
-
export { createHealthCheck, withHealthCheck, addHealthCheck } from './core/health';
|
|
6
|
-
export { createGracefulShutdown, withGracefulShutdown, startServerWithShutdown } from './core/shutdown';
|
|
7
|
-
export { createLoggingMiddleware, createErrorHandler, createRequestIdMiddleware, createValidationMiddleware, createRateLimitMiddleware, createAuthMiddleware, withLogging, withErrorHandler, withRequestId, withValidation, withRateLimit, withAuth, validateFields, rateLimit, requireAuth, cacheResponse, useSession, type ValidationRule, type RateLimitConfig, type AuthConfig } from './middleware';
|
|
8
|
-
export { getEnv, getEnvNumber, getEnvBoolean } from './utils/utils';
|
|
5
|
+
export { createHealthCheck, withHealthCheck, addHealthCheck, } from './core/health';
|
|
6
|
+
export { createGracefulShutdown, withGracefulShutdown, startServerWithShutdown, } from './core/shutdown';
|
|
7
|
+
export { createLoggingMiddleware, createErrorHandler, createRequestIdMiddleware, createValidationMiddleware, createRateLimitMiddleware, createAuthMiddleware, withLogging, withErrorHandler, withRequestId, withValidation, withRateLimit, withAuth, validateFields, rateLimit, requireAuth, cacheResponse, useSession, type ValidationRule, type RateLimitConfig, type AuthConfig, } from './middleware';
|
|
8
|
+
export { getEnv, getEnvNumber, getEnvBoolean, } from './utils/utils';
|
|
9
9
|
export { PeriodicHealthMonitor } from './core/periodic-health';
|
|
10
|
-
export type { ServerConfig, HealthCheckConfig, HealthCheck, GracefulShutdownConfig, ServerPlugin, SocketIOConfig, SocketInstance, PeriodicHealthCheckConfig, HealthCheckService } from './types';
|
|
11
|
-
import {
|
|
12
|
-
import { createHealthCheck, withHealthCheck, addHealthCheck } from './core/health';
|
|
13
|
-
import { createGracefulShutdown, withGracefulShutdown, startServerWithShutdown } from './core/shutdown';
|
|
14
|
-
import { createLoggingMiddleware, createErrorHandler, createRequestIdMiddleware, createValidationMiddleware, createRateLimitMiddleware, createAuthMiddleware, withLogging, withErrorHandler, withRequestId, withValidation, withRateLimit, withAuth, validateFields, rateLimit, requireAuth } from './middleware';
|
|
15
|
-
import { getEnv, getEnvNumber, getEnvBoolean } from './utils/utils';
|
|
10
|
+
export type { ServerConfig, HealthCheckConfig, HealthCheck, GracefulShutdownConfig, ServerPlugin, SocketIOConfig, SocketInstance, PeriodicHealthCheckConfig, HealthCheckService, } from './types';
|
|
11
|
+
import { addHealthCheck, createHealthCheck, withHealthCheck } from './core/health';
|
|
16
12
|
import { PeriodicHealthMonitor } from './core/periodic-health';
|
|
13
|
+
import { ExpressServer, createServer } from './core/server';
|
|
14
|
+
import { createGracefulShutdown, startServerWithShutdown, withGracefulShutdown } from './core/shutdown';
|
|
15
|
+
import { createAuthMiddleware, createErrorHandler, createLoggingMiddleware, createRateLimitMiddleware, createRequestIdMiddleware, createValidationMiddleware, rateLimit, requireAuth, validateFields, withAuth, withErrorHandler, withLogging, withRateLimit, withRequestId, withValidation } from './middleware';
|
|
16
|
+
import { getEnv, getEnvBoolean, getEnvNumber } from './utils/utils';
|
|
17
17
|
declare const ServerUtils: {
|
|
18
18
|
createServer: typeof createServer;
|
|
19
19
|
ExpressServer: typeof ExpressServer;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { RequestHandler } from
|
|
1
|
+
import type { RequestHandler } from 'node_modules/@types/express';
|
|
2
2
|
export declare function cacheResponse(ttl?: number): RequestHandler;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { ErrorRequestHandler } from
|
|
1
|
+
import type { ErrorRequestHandler } from 'node_modules/@types/express';
|
|
2
2
|
export declare function createErrorHandler(): ErrorRequestHandler;
|
|
@@ -2,9 +2,9 @@ export { AuthConfig, createAuthMiddleware } from './auth.middleware';
|
|
|
2
2
|
export { cacheResponse } from './cache.middleware';
|
|
3
3
|
export { createErrorHandler } from './errorHandler.middleware';
|
|
4
4
|
export { createLoggingMiddleware } from './logging.middleware';
|
|
5
|
-
export { RateLimitConfig, createRateLimitMiddleware } from './rateLimiter.middleware';
|
|
5
|
+
export { RateLimitConfig, createRateLimitMiddleware, } from './rateLimiter.middleware';
|
|
6
6
|
export { createRequestIdMiddleware } from './requestId.middleware';
|
|
7
7
|
export { useSession } from './session.middleware';
|
|
8
|
-
export { ValidationRule, createValidationMiddleware } from './validation.middleware';
|
|
9
|
-
export { withLogging, withErrorHandler, withRequestId, withValidation, withRateLimit, withAuth } from './plugins.middleware';
|
|
10
|
-
export { validateFields, rateLimit, requireAuth } from './plugins.middleware';
|
|
8
|
+
export { ValidationRule, createValidationMiddleware, } from './validation.middleware';
|
|
9
|
+
export { withLogging, withErrorHandler, withRequestId, withValidation, withRateLimit, withAuth, } from './plugins.middleware';
|
|
10
|
+
export { validateFields, rateLimit, requireAuth, } from './plugins.middleware';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { RequestHandler } from
|
|
1
|
+
import type { RequestHandler } from 'node_modules/@types/express';
|
|
2
2
|
export declare function createLoggingMiddleware(format?: 'simple' | 'detailed'): RequestHandler;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { RequestHandler } from 'express';
|
|
2
|
-
import { ServerPlugin } from '../types';
|
|
3
|
-
import {
|
|
4
|
-
import { RateLimitConfig } from './rateLimiter.middleware';
|
|
5
|
-
import {
|
|
1
|
+
import type { RequestHandler } from 'express';
|
|
2
|
+
import type { ServerPlugin } from '../types';
|
|
3
|
+
import type { AuthConfig } from './auth.middleware';
|
|
4
|
+
import type { RateLimitConfig } from './rateLimiter.middleware';
|
|
5
|
+
import type { ValidationRule } from './validation.middleware';
|
|
6
6
|
export declare function withLogging(format?: 'simple' | 'detailed'): ServerPlugin;
|
|
7
7
|
export declare function withErrorHandler(): ServerPlugin;
|
|
8
8
|
export declare function withRequestId(): ServerPlugin;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { RequestHandler } from
|
|
1
|
+
import type { RequestHandler } from 'node_modules/@types/express';
|
|
2
2
|
export declare function createRequestIdMiddleware(): RequestHandler;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { RequestHandler } from
|
|
1
|
+
import type { RequestHandler } from 'node_modules/@types/express';
|
|
2
2
|
export declare function useSession(cookieName?: string): RequestHandler;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import express from 'express';
|
|
1
|
+
import type express from 'express';
|
|
2
2
|
export interface CorsOptions {
|
|
3
3
|
origin?: string | string[] | boolean | RegExp | ((origin: string | undefined, callback: (err: Error | null, allow?: boolean) => void) => void);
|
|
4
4
|
methods?: string | string[];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@naman_deep_singh/server-utils",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.1",
|
|
4
4
|
"description": "Extensible server utilities for Express.js microservices with TypeScript",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/cjs/index.js",
|
|
@@ -27,9 +27,9 @@
|
|
|
27
27
|
"author": "Naman Deep Singh",
|
|
28
28
|
"license": "ISC",
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@naman_deep_singh/cache": "^1.
|
|
31
|
-
"@naman_deep_singh/errors-utils": "^1.
|
|
32
|
-
"@naman_deep_singh/security": "^1.
|
|
30
|
+
"@naman_deep_singh/cache": "^1.3.1",
|
|
31
|
+
"@naman_deep_singh/errors-utils": "^1.1.1",
|
|
32
|
+
"@naman_deep_singh/security": "^1.3.1",
|
|
33
33
|
"@types/express": "^5.0.5",
|
|
34
34
|
"cookie-parser": "^1.4.6",
|
|
35
35
|
"cors": "^2.8.5",
|