nestjs-security-cli 1.5.3 → 1.5.4

package/README.md

@@ -18,17 +18,16 @@ import { SecurityModule, BlacklistedIp, BlacklistedIpSchema, SecurityMiddleware
 @Module( {
 	imports: [
 		SecurityModule.forRootAsync( {
-			enableAdminPanel: true,
+			enableAdminPanel: true, // enables the admin panel for the `/security endpoints`
 			useFactory: () => ({
 				enableDatabase: true,
 				defaultBlockDurationHours: 24,
 				enableAutoBlocking: true
 			}),
 			inject: [],
-			// Required if enableDatabase is true
-			// This should be your mongoose connection
-			imports: [ MongoDbModule ],
-			providers: [ ...IpBlockerProvider ] // Required if enableDatabase is true
+			// Below required if enableDatabase is true
+			imports: [ MongoDbModule ], // This should be your mongoose connection
+			providers: [ ...IpBlockerProvider ]
 		} )
 	]
 } )
@@ -102,8 +101,8 @@ export class AppModule {
 
 ## SecurityService
 
-Since this has switched to using to `@Inject('IP_BLOCKER')` model to be registered in your app. So by passing the
-IpBlockerProvider, it will automatically register the model.
+Since this has switched to using the `@Inject('IP_BLOCKER')` model to be registered in your app. So by passing the
+IpBlockerProvider, it will automatically register the model. More on this down below.
 
 ## Clean up cron
 
@@ -193,12 +192,14 @@ And then in your controllers simply use the `@UseGuards(IpBlacklistGuard)` decor
   field called "Roles" which is an array of strings.
 
 To use the `AdminGuard` just add the decorator to your controller method.
+
 ```typescript
-@UseGuards(AdminGuard)
-@Controller('my-contoller')
+@UseGuards( AdminGuard )
+@Controller( 'my-contoller' )
 ```
 
 To use the `RoleGuard` just add the decorator to your controller method.
+
 ```typescript
 @Roles( 'Admin', 'User' )
 @UseGuards( RoleGuard )
@@ -216,9 +217,10 @@ const user = await this.jwtService.verifyAsync( token, {
 } )
 ```
 
-## The "security" controller:
+## The "admin panel" (e.g. security controller/endpoints):
 
-To use the built in admin panel, you can simply just add the controller to your AppModule.
+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:
 
@@ -229,32 +231,7 @@ Available endpoints:
 - GET `/security/blacklist`. This will return a list of all blacklisted IPs
 - GET `/security/blacklist/:ip`. This will return the details of a specific IP address
 - DELETE `/security/blacklist/:ip`. This will delete a specific IP address
-- POST `/security/analytics`. This will return analytics for the last 24 hours
-
-Example of importing the controller and adding it to your AppModule:
-
-```typescript
-import { MiddlewareConsumer, Module, RequestMethod } from '@nestjs/common'
-/* other imports */
-import {
-	/* other imports */
-	SecurityController
-} from 'nestjs-security-cli'
-
-@Module( {
-	imports: [ /* other imports */ ],
-	controllers: [ /* other controllers */ SecurityController ], // Add this
-	providers: [ /* other providers */ ]
-} )
-export class AppModule {
-	configure(consumer: MiddlewareConsumer): void {
-		consumer
-			.apply( SecurityMiddleware )
-			.forRoutes( { path: '*', method: RequestMethod.ALL } )
-	}
-}
-
-```
+- GET `/security/analytics`. This will return analytics for the last 24 hours
 
 ## Features
 

package/package.json

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