nestjs-security-cli 1.5.8 → 1.5.10

package/README.md

@@ -18,15 +18,13 @@ import { SecurityModule, BlacklistedIp, BlacklistedIpSchema, SecurityMiddleware
 @Module( {
 	imports: [
 		SecurityModule.forRootAsync( {
-			enableAdminPanel: true, // enables the admin panel for the `/security endpoints`
+			enableAdminPanel: true,
 			useFactory: () => ({
 				enableDatabase: true,
 				defaultBlockDurationHours: 24,
 				enableAutoBlocking: true
 			}),
-			inject: [],
-			// Below required if enableDatabase is true
-			imports: [ MongoDbModule ], // This should be your mongoose connection
+			imports: [ MongoDbModule ],
 			providers: [ ...IpBlockerProvider ]
 		} )
 	]
@@ -45,7 +43,7 @@ export class AppModule {
 if you're needing to use the database connection, and the import options isn't working, you can try to pass it directly
 into the providers array.
 
-```
+```text
     {
         provide: 'DATABASE_CONNECTION',
         inject: [ConfigService],
@@ -126,7 +124,7 @@ There's a cron that runs to clean up old blocks. By default, it runs every 10 mi
 the
 `CLEANUP_CRON` environment variable.
 
-```
+```text
 	// Cleanup expired entries (runs daily)
 	@Cron(CronExpression.EVERY_DAY_AT_MIDNIGHT)
 	async cleanupExpiredBlocks(): Promise<void> {
@@ -138,44 +136,14 @@ the
 	}
 ```
 
-## Roles type
+## Role type
 
 The roles that can be defined in your app. Persist the roles in your user model as an array of strings.
 
-```
+```text
 export type Role = 'Admin' | 'User' | 'Moderator' | 'Guest'
 ```
 
-## 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'
-}
-```
-
 ## Register the IpBlacklistGuard globally
 
 ```typescript
@@ -203,9 +171,9 @@ And then in your controllers simply use the `@UseGuards(IpBlacklistGuard)` decor
 ## Admin & Roles guards
 
 * The Admin guard accepts ONLY users with the role `Admin`.
-* The Role guard accepts users with ane of (or all) the type "Roles" [as mentioned above](#roles-type).
+* The Role guard accepts users with ane of (or all) the type "Roles" [as mentioned above](#role-type).
 * To leverage the admin panel, you'll need to create a role called `Admin`. The user model in your app should have a
-  field called "Roles" which is an array of strings.
+  field called "Roles", which is an array of strings.
 
 To use the `AdminGuard` just add the decorator to your controller method.
 
@@ -233,10 +201,10 @@ const user = await this.jwtService.verifyAsync( token, {
 } )
 ```
 
-## The "admin panel" (e.g. security controller/endpoints):
+## The admin panel
 
-To use the built in admin panel, you can set the `enableAdminPanel: true` in the
-configs [as shown in the](#quick-start), to set the available endpoints.
+To use the built-in admin panel, you can set the `enableAdminPanel: true` in the
+configs [as shown in the](#quick-start) to set the available endpoints.
 
 Available endpoints:
 
@@ -300,9 +268,4 @@ export interface SecurityConfigInterface {
 
 ## License
 
-MIT
-
-## Donate
-
-If you like this project, please
-consider [donating to help me keep it up to date](https://buy.stripe.com/eVq00l2Dc4k05Bz9pY4Rq00)
+MIT

package/package.json

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