exguard-backend 1.0.3 → 1.0.4

package/README.md

@@ -25,13 +25,40 @@ pnpm add exguard-backend
 
 ## 🚀 Quick Start - NestJS Integration
 
-### Step 1: Install Dependencies
+### 🎯 Option 1: Automatic Setup (Recommended)
+
+**One-command setup for NestJS projects:**
+
+```bash
+# Install exguard-backend
+npm install exguard-backend
+
+# Run automatic setup
+npx exguard-backend setup-nestjs
+# OR
+npm run setup-nestjs
+```
+
+**What the automatic setup creates:**
+
+✅ **ExGuard Module** - Global module with Guard provider  
+✅ **Custom Guards** - ExGuardNestGuard, PermissionGuard, RoleGuard  
+✅ **Decorators** - @RequirePermissions, @RequireRoles, @RequireModules  
+✅ **Example Controller** - Complete usage examples  
+✅ **Environment Variables** - .env configuration  
+✅ **Package Scripts** - Helper scripts for development  
+
+### 📋 Option 2: Manual Setup
+
+If you prefer manual setup, follow these steps:
+
+#### Step 1: Install Dependencies
 
 ```bash
 npm install exguard-backend @nestjs/core @nestjs/common @nestjs/platform-express
 ```
 
-### Step 2: Create ExGuard Module
+#### Step 2: Create ExGuard Module
 
 ```typescript
 // src/exguard/exguard.module.ts
@@ -54,7 +81,7 @@ import { Guard } from 'exguard-backend';
 export class ExGuardModule {}
 ```
 
-### Step 3: Create Custom Guards
+#### Step 3: Create Custom Guards
 
 ```typescript
 // src/exguard/exguard.guard.ts
@@ -104,7 +131,7 @@ export function createPermissionGuard(permissions: string[], requireAll = false)
 }
 ```
 
-### Step 4: Protect Your Controllers
+#### Step 4: Protect Your Controllers
 
 ```typescript
 // src/events/events.controller.ts
@@ -134,7 +161,7 @@ export class EventsController {
 }
 ```
 
-### Step 5: Update App Module
+#### Step 5: Update App Module
 
 ```typescript
 // src/app.module.ts
@@ -149,6 +176,41 @@ import { EventsController } from './events/events.controller';
 export class AppModule {}
 ```
 
+### 🎯 Automatic Setup Features
+
+The automatic setup creates a complete NestJS integration:
+
+#### **Generated Files:**
+```
+src/
+├── exguard/
+│   ├── exguard.module.ts      # Global ExGuard module
+│   ├── exguard.guard.ts       # Custom guards
+│   ├── exguard.decorators.ts  # Permission decorators
+│   └── guards/              # Additional guard files
+├── events/
+│   └── events.controller.ts  # Example controller
+└── .env                    # Environment configuration
+```
+
+#### **Generated Decorators:**
+```typescript
+@RequirePermissions(['events:read'])
+@RequireRoles(['Admin'])
+@RequireModules(['reporting'])
+@RequireFieldOffices(['FO-MANILA'])
+```
+
+#### **Generated Package Scripts:**
+```json
+{
+  "scripts": {
+    "exguard:setup": "node node_modules/exguard-backend/scripts/setup-nestjs.js",
+    "exguard:example": "node node_modules/exguard-backend/scripts/create-example.js"
+  }
+}
+```
+
 ## 🎯 Advanced NestJS Examples
 
 ### Role-Based Protection

package/dist/index.d.cts

@@ -51,17 +51,17 @@ interface ExGuardEnhancedConfig$1 extends ExGuardConfig {
     cache?: ExGuardCacheConfig;
     realtime?: ExGuardRealtimeConfig;
 }
-interface GuardContext$1 {
+interface GuardContext {
     token: string;
     request?: any;
 }
-interface GuardResult$1 {
+interface GuardResult {
     allowed: boolean;
     user?: UserAccessResponse;
     error?: string;
     statusCode?: number;
 }
-interface GuardOptions$1 {
+interface GuardOptions {
     permissions?: string[];
     roles?: string[];
     modules?: string[];
@@ -292,23 +292,6 @@ declare const realtime: ExGuardRealtime;
  * Framework-agnostic guards for protecting backend endpoints
  */
 
-interface GuardContext {
-    token: string;
-    request?: any;
-}
-interface GuardResult {
-    allowed: boolean;
-    user?: UserAccessResponse;
-    error?: string;
-    statusCode?: number;
-}
-interface GuardOptions {
-    permissions?: string[];
-    roles?: string[];
-    modules?: string[];
-    fieldOffices?: string[];
-    requireAll?: boolean;
-}
 /**
  * Framework-agnostic guard class for endpoint protection
  */
@@ -480,4 +463,4 @@ declare function createExGuardFastify(config: any): {
     getGuard(): ExGuardBackend;
 };
 
-export { type ApiResponse, ExGuardBackend$1 as ExGuardBackend, ExGuardBackendEnhanced, ExGuardCache, type ExGuardCacheConfig, type ExGuardConfig, type ExGuardEnhancedConfig$1 as ExGuardEnhancedConfig, ExGuardRealtime, type ExGuardRealtimeConfig, ExGuardBackend as Guard, type GuardContext$1 as GuardContext, type GuardOptions$1 as GuardOptions, type GuardResult$1 as GuardResult, type UserAccessResponse, cache, createExGuardExpress, createExGuardFastify, realtime };
+export { type ApiResponse, ExGuardBackend$1 as ExGuardBackend, ExGuardBackendEnhanced, ExGuardCache, type ExGuardCacheConfig, type ExGuardConfig, type ExGuardEnhancedConfig$1 as ExGuardEnhancedConfig, ExGuardRealtime, type ExGuardRealtimeConfig, ExGuardBackend as Guard, type GuardContext, type GuardOptions, type GuardResult, type UserAccessResponse, cache, createExGuardExpress, createExGuardFastify, realtime };

package/dist/index.d.ts

@@ -51,17 +51,17 @@ interface ExGuardEnhancedConfig$1 extends ExGuardConfig {
     cache?: ExGuardCacheConfig;
     realtime?: ExGuardRealtimeConfig;
 }
-interface GuardContext$1 {
+interface GuardContext {
     token: string;
     request?: any;
 }
-interface GuardResult$1 {
+interface GuardResult {
     allowed: boolean;
     user?: UserAccessResponse;
     error?: string;
     statusCode?: number;
 }
-interface GuardOptions$1 {
+interface GuardOptions {
     permissions?: string[];
     roles?: string[];
     modules?: string[];
@@ -292,23 +292,6 @@ declare const realtime: ExGuardRealtime;
  * Framework-agnostic guards for protecting backend endpoints
  */
 
-interface GuardContext {
-    token: string;
-    request?: any;
-}
-interface GuardResult {
-    allowed: boolean;
-    user?: UserAccessResponse;
-    error?: string;
-    statusCode?: number;
-}
-interface GuardOptions {
-    permissions?: string[];
-    roles?: string[];
-    modules?: string[];
-    fieldOffices?: string[];
-    requireAll?: boolean;
-}
 /**
  * Framework-agnostic guard class for endpoint protection
  */
@@ -480,4 +463,4 @@ declare function createExGuardFastify(config: any): {
     getGuard(): ExGuardBackend;
 };
 
-export { type ApiResponse, ExGuardBackend$1 as ExGuardBackend, ExGuardBackendEnhanced, ExGuardCache, type ExGuardCacheConfig, type ExGuardConfig, type ExGuardEnhancedConfig$1 as ExGuardEnhancedConfig, ExGuardRealtime, type ExGuardRealtimeConfig, ExGuardBackend as Guard, type GuardContext$1 as GuardContext, type GuardOptions$1 as GuardOptions, type GuardResult$1 as GuardResult, type UserAccessResponse, cache, createExGuardExpress, createExGuardFastify, realtime };
+export { type ApiResponse, ExGuardBackend$1 as ExGuardBackend, ExGuardBackendEnhanced, ExGuardCache, type ExGuardCacheConfig, type ExGuardConfig, type ExGuardEnhancedConfig$1 as ExGuardEnhancedConfig, ExGuardRealtime, type ExGuardRealtimeConfig, ExGuardBackend as Guard, type GuardContext, type GuardOptions, type GuardResult, type UserAccessResponse, cache, createExGuardExpress, createExGuardFastify, realtime };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "exguard-backend",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -46,6 +46,8 @@
     "test": "node --test",
     "test:watch": "node --test --watch",
     "clean": "node -e \"fs.rmSync('dist', { recursive: true, force: true })\"",
-    "prebuild": "npm run clean"
+    "prebuild": "npm run clean",
+    "setup-nestjs": "node scripts/setup-nestjs.js",
+    "create-example": "node scripts/create-example.js"
   }
 }