nestjs-security-cli 1.3.3 → 1.3.4

package/README.md

@@ -11,75 +11,88 @@ npm install nestjs-security-cli
 ## Quick Start
 
 ```typescript
-import { Module } from '@nestjs/common'; 
-import { MongooseModule } from '@nestjs/mongoose'; 
-import { SecurityModule, BlacklistedIp, BlacklistedIpSchema, SecurityMiddleware } from 'nestjs-security-cli';
-@Module({ imports: [ 
-        // 1. Set up MongoDB connection first MongooseModule.forRoot('mongodb://localhost:27017/myapp'),
-        // 2. Register the schema in your app
-        MongooseModule.forFeature([
-            { name: BlacklistedIp.name, schema: BlacklistedIpSchema }
-        ]),
-        // 3. Then add SecurityModule
-        SecurityModule.forRoot({
-            enableDatabase: true,
-            defaultBlockDurationHours: 24,
-            enableAutoBlocking: true,
-            enableAdminPanel: false,
-        }),
-    ],
-}) 
+import { Module } from '@nestjs/common'
+import { MongooseModule } from '@nestjs/mongoose'
+import { SecurityModule, BlacklistedIp, BlacklistedIpSchema, SecurityMiddleware } from 'nestjs-security-cli'
+
+@Module( {
+	imports: [
+		// 1. Set up MongoDB connection first MongooseModule.forRoot('mongodb://localhost:27017/myapp'),
+		MongooseModule.forRootAsync( {
+			imports: [ ConfigModule ],
+			useFactory: async (configService: ConfigService) => ({
+				uri: configService.get<string>( 'MONGODB_URI' )
+			}),
+			inject: [ ConfigService ]
+		} ),
+		// 2. Register the schema in your app
+		MongooseModule.forFeature( [
+			{ name: BlacklistedIp.name, schema: BlacklistedIpSchema }
+		] ),
+		// 3. Then add SecurityModule
+		SecurityModule.forRoot( {
+			enableDatabase: true,
+			defaultBlockDurationHours: 24,
+			enableAutoBlocking: true,
+			enableAdminPanel: false
+		} )
+	]
+} )
 export class AppModule {
 	configure(consumer: MiddlewareConsumer) {
 		// This protects ALL requests, including non-existent routes
-		consumer.apply(SecurityMiddleware).forRoutes('*');
+		consumer.apply( SecurityMiddleware ).forRoutes( '*' )
 	}
 }
 ```
 
 ## with ConfigService
+
+```typescript
+import { Module } from '@nestjs/common'
+import { ConfigModule, ConfigService } from '@nestjs/config'
+import { MongooseModule } from '@nestjs/mongoose'
+import { SecurityModule, BlacklistedIp, BlacklistedIpSchema } from 'nestjs-security-cli'
+
+@Module( {
+	imports: [
+		ConfigModule.forRoot(),
+		// MongoDB connection
+		MongooseModule.forRootAsync( {
+			imports: [ ConfigModule ],
+			useFactory: async (configService: ConfigService) => ({
+				uri: configService.get<string>( 'MONGODB_URI' )
+			}),
+			inject: [ ConfigService ]
+		} ),
+		// Register schema
+		MongooseModule.forFeature( [
+			{ name: BlacklistedIp.name, schema: BlacklistedIpSchema }
+		] ),
+		// Security module
+		SecurityModule.forRoot( {
+			enableDatabase: true,
+			defaultBlockDurationHours: 24,
+			enableAutoBlocking: true
+		} )
+	]
+} )
+export class AppModule {
+}
 ```
-import { Module } from '@nestjs/common'; 
-import { ConfigModule, ConfigService } from '@nestjs/config'; 
-import { MongooseModule } from '@nestjs/mongoose'; 
-import { SecurityModule, BlacklistedIp, BlacklistedIpSchema } from 'nestjs-security-cli';
-@Module({ imports: [ ConfigModule.forRoot(),
-	// MongoDB connection
-	MongooseModule.forRootAsync({
-		imports: [ConfigModule],
-		useFactory: async (configService: ConfigService) => ({
-			uri: configService.get<string>('MONGODB_URI'),
-		}),
-		inject: [ConfigService],
-	}),
-	
-	// Register schema
-	MongooseModule.forFeature([
-		{ name: BlacklistedIp.name, schema: BlacklistedIpSchema }
-	]),
-	
-	// Security module
-	SecurityModule.forRoot({
+
+## With forRootAsync
+
+```typescript
+SecurityModule.forRootAsync( {
+	enableAdminPanel: true,
+	useFactory: (configService: ConfigService) => ({
 		enableDatabase: true,
 		defaultBlockDurationHours: 24,
-		enableAutoBlocking: true,
+		enableAutoBlocking: true
 	}),
-],
-}) 
-export class AppModule {}
-```
-
-## With forRootAsync
-```
-SecurityModule.forRootAsync({
-    enableAdminPanel: true,
-    useFactory: (configService: ConfigService) => ({
-        enableDatabase: true,
-        defaultBlockDurationHours: 24,
-        enableAutoBlocking: true,
-    }),
-    inject: [ConfigService]
-})
+	inject: [ ConfigService ]
+} )
 ```
 
 ## Cache-Only Mode (No Database)
@@ -87,22 +100,22 @@ SecurityModule.forRootAsync({
 If you don't want to use MongoDB, you can skip the schema registration:
 
 ```typescript
-import { Module } from '@nestjs/common';
-import { SecurityModule } from 'nestjs-security-cli';
+import { Module } from '@nestjs/common'
+import { SecurityModule } from 'nestjs-security-cli'
 
-@Module({
+@Module( {
 	imports: [
-		SecurityModule.forRoot({
+		SecurityModule.forRoot( {
 			enableDatabase: false, // This will use only cache
 			defaultBlockDurationHours: 24,
-			enableAutoBlocking: true,
-		}),
-	],
-})
-export class AppModule {}
+			enableAutoBlocking: true
+		} )
+	]
+} )
+export class AppModule {
+}
 ````
 
-
 ## Clean up cron
 
 There's a cron that runs to clean up old blocks. By default, it runs every 10 minutes. You can change this by setting
@@ -122,11 +135,43 @@ the
 ```
 
 ## Roles (More on this coming soon)
+
 The roles that can be defined in your app.
+
 ```
 export type Role = 'admin' | 'user' | 'moderator'
 ```
 
+## Config Options
+
+```typescript
+export interface SecurityConfigInterface {
+	enableDatabase?: boolean
+	mongooseConnection?: string
+	cache?: {
+		ttl?: number
+		max?: number
+		store?: any
+	}
+	enableAdminPanel?: boolean
+	adminPath?: string
+	enableAutoBlocking?: boolean
+	suspiciousPatterns?: Array<{
+		pattern: string
+		name: string
+		blockDurationHours?: number
+	}>
+	defaultBlockDurationHours?: number
+	enableRateLimit?: boolean
+	rateLimitOptions?: {
+		windowMs?: number
+		max?: number
+	}
+	enableLogging?: boolean
+	logLevel?: 'error' | 'warn' | 'info' | 'debug'
+}
+```
+
 ## Features
 
 - 🛡️ IP Blacklisting with MongoDB persistence
@@ -141,17 +186,18 @@ export type Role = 'admin' | 'user' | 'moderator'
 [need to add api docs]
 
 ## Configuration Options
-```aiignore
+
+```typescript
 interface SecurityConfigInterface {
-  enableDatabase?: boolean; // Default: true
-  enableAutoBlocking?: boolean; // Default: true
-  enableAdminPanel?: boolean; // Default: false
-  defaultBlockDurationHours?: number; // Default: 24
-  enableLogging?: boolean; // Default: true
-  cache?: {
-    ttl?: number;
-    max?: number;
-  };
+	enableDatabase?: boolean; // Default: true
+	enableAutoBlocking?: boolean; // Default: true
+	enableAdminPanel?: boolean; // Default: false
+	defaultBlockDurationHours?: number; // Default: 24
+	enableLogging?: boolean; // Default: true
+	cache?: {
+		ttl?: number;
+		max?: number;
+	};
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nestjs-security-cli",
-	"version": "1.3.3",
+	"version": "1.3.4",
 	"description": "Advanced IP blocking, role-based security, and attack detection for NestJS applications",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",