exguard-backend 1.0.16 → 1.0.18

package/README.md

@@ -31,22 +31,33 @@ pnpm add exguard-backend
 
 ```bash
 # Install exguard-backend
-npm install exguard-backend@1.0.10
+npm install exguard-backend@1.0.17
 
-# Run automatic setup
-npx exguard-backend
+# Run automatic setup (overwrites existing files)
+npx exguard-backend@1.0.17
 # OR
 npm run setup-nestjs
 ```
 
-**What the automatic setup creates:**
+**Quick Start - NestJS Integration:**
 
-✅ **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  
+After running the setup script, you can quickly start using ExGuard:
+
+```bash
+# Start development server
+npm run start:dev
+
+# The setup script automatically:
+# ✅ Creates src/exguard/ directory with all guards and decorators
+# ✅ Updates src/app.module.ts with ExGuardModule import
+# ✅ Creates src/events/events.controller.ts with working examples
+# ✅ Adds npm scripts for easy access
+```
+✅ **Improved module detection** - More reliable NestJS project detection  
+✅ **Enhanced file creation** - Better file path handling  
+✅ **TypeScript error fixes** - All generated code is type-safe  
+✅ **Complete imports** - All factory functions properly imported  
+✅ **Working permission checks** - Guards actually enforce permissions
 
 ### 📋 Option 2: Manual Setup
 
@@ -446,6 +457,53 @@ describe('AppController (e2e)', () => {
 });
 ```
 
+## 🚀 Quick Implementation Guide
+
+### **Step 1: Install and Setup**
+```bash
+# Install latest version
+npm install exguard-backend@1.0.16
+
+# Run automatic setup (overwrites existing files)
+npx exguard-backend@1.0.16
+```
+
+### **Step 2: Controller Implementation**
+```typescript
+import { Controller, Get, Post, UseGuards, Request, Body } from '@nestjs/common';
+import { createPermissionGuard, createRoleGuard, createModuleGuard } from '../exguard/exguard.guard';
+
+@Controller('your-controller')
+export class YourController {
+  @Get()
+  @UseGuards(createPermissionGuard(['your-resource:read']))
+  async getAll(@Request() req) {
+    return { success: true, data: [] };
+  }
+
+  @Post()
+  @UseGuards(createPermissionGuard(['your-resource:create']))
+  async create(@Body() createDto: any, @Request() req) {
+    return { success: true, data: createDto };
+  }
+}
+```
+
+### **Step 3: Test Your Implementation**
+```bash
+# Test with valid permissions
+curl http://localhost:3000/your-controller -H "Authorization: Bearer YOUR_TOKEN"
+
+# Test with invalid permissions (should return 403)
+curl http://localhost:3000/your-controller -H "Authorization: Bearer TOKEN_WITHOUT_PERMISSIONS"
+```
+
+### **Important Notes:**
+- ✅ **File Overwriting**: The setup script now overwrites existing files to ensure you get the latest fixes
+- ✅ **Permission Checking**: Guards now actually check and enforce permissions
+- ✅ **TypeScript Safe**: All generated code is TypeScript compliant
+- ✅ **Working Examples**: The generated controller demonstrates all protection patterns
+
 ## 🎯 Controller Implementation Examples
 
 ### **Basic Permission Protection**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "exguard-backend",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "private": false,
   "publishConfig": {
     "access": "public"

package/scripts/setup-nestjs.cjs

@@ -143,8 +143,7 @@ export class ExGuardModule {}
   const modulePath = path.join(process.cwd(), 'src/exguard/exguard.module.ts');
   
   if (fs.existsSync(modulePath)) {
-    logWarning('ExGuardModule already exists. Skipping creation.');
-    return;
+    logWarning('ExGuard module already exists. Overwriting...');
   }
 
   fs.writeFileSync(modulePath, moduleContent);
@@ -227,21 +226,40 @@ export class ExGuardRoleGuard extends ExGuardNestGuard {
 export function createPermissionGuard(permissions: string[], requireAll = false) {
   return class extends ExGuardNestGuard {
     public async checkPermissions(context: GuardContext) {
+      console.log('🔍 DEBUG: Permission guard called');
+      console.log('🔍 DEBUG: Required permissions:', permissions);
+      console.log('🔍 DEBUG: Require all:', requireAll);
+      
       // First authenticate the user
       const authResult = await this.exGuard.authenticate(context);
       
+      console.log('🔍 DEBUG: Auth result:', {
+        allowed: authResult.allowed,
+        hasUser: !!authResult.user,
+        error: authResult.error
+      });
+      
       if (!authResult.allowed) {
+        console.log('🔍 DEBUG: Authentication failed');
         return authResult;
       }
       
       // Then check specific permissions
       // Extract permissions from modules array
-      const userPermissions = authResult.modules?.flatMap(module => module.permissions) || [];
+      if (!authResult.user) {
+        console.log('🔍 DEBUG: No user found in auth result');
+        return { allowed: false, error: 'User not found in authentication result' };
+      }
+      
+      const userPermissions = authResult.user.modules?.flatMap(module => module.permissions) || [];
+      console.log('🔍 DEBUG: User permissions:', userPermissions);
       
       if (requireAll) {
         // User must have ALL permissions
         const hasAllPermissions = permissions.every(perm => userPermissions.includes(perm));
+        console.log('🔍 DEBUG: Has all permissions check:', hasAllPermissions);
         if (!hasAllPermissions) {
+          console.log('🔍 DEBUG: Missing required permissions (ALL)');
           return {
             allowed: false,
             error: 'Insufficient permissions. Required all of: ' + permissions.join(', ')
@@ -250,7 +268,9 @@ export function createPermissionGuard(permissions: string[], requireAll = false)
       } else {
         // User must have ANY permission
         const hasAnyPermission = permissions.some(perm => userPermissions.includes(perm));
+        console.log('🔍 DEBUG: Has any permission check:', hasAnyPermission);
         if (!hasAnyPermission) {
+          console.log('🔍 DEBUG: Missing required permissions (ANY)');
           return {
             allowed: false,
             error: 'Insufficient permissions. Required any of: ' + permissions.join(', ')
@@ -258,15 +278,10 @@ export function createPermissionGuard(permissions: string[], requireAll = false)
         }
       }
       
+      console.log('🔍 DEBUG: Permission check passed');
       return { 
         allowed: true, 
-        user: {
-          ...authResult.user,
-          permissions: authResult.modules?.flatMap(module => module.permissions) || [],
-          roles: authResult.roles || [],
-          modules: authResult.modules || [],
-          fieldOffices: authResult.fieldOffices || []
-        }
+        user: authResult.user
       };
     }
   };
@@ -292,8 +307,7 @@ export function createModuleGuard(modules: string[], requireAll = false) {
   const guardPath = path.join(process.cwd(), 'src/exguard/exguard.guard.ts');
   
   if (fs.existsSync(guardPath)) {
-    logWarning('ExGuard guards already exist. Skipping creation.');
-    return;
+    logWarning('ExGuard guards already exist. Overwriting...');
   }
 
   fs.writeFileSync(guardPath, guardContent);
@@ -376,8 +390,7 @@ export const Require = (requirements: {
   const decoratorPath = path.join(process.cwd(), 'src/exguard/exguard.decorators.ts');
   
   if (fs.existsSync(decoratorPath)) {
-    logWarning('ExGuard decorators already exist. Skipping creation.');
-    return;
+    logWarning('ExGuard decorators already exist. Overwriting...');
   }
 
   fs.writeFileSync(decoratorPath, decoratorContent);
@@ -466,18 +479,17 @@ export class EventsController {
 }
 `;
 
-  const controllerPath = path.join(process.cwd(), 'src/events/events.controller.ts');
-  
-  // Check if events directory exists
+  // Ensure directory exists
   const eventsDir = path.join(process.cwd(), 'src/events');
   if (!fs.existsSync(eventsDir)) {
     fs.mkdirSync(eventsDir, { recursive: true });
     logSuccess('Created events directory');
   }
 
+  const controllerPath = path.join(process.cwd(), 'src/events/events.controller.ts');
+  
   if (fs.existsSync(controllerPath)) {
-    logWarning('Example controller already exists. Skipping creation.');
-    return;
+    logWarning('Example controller already exists. Overwriting...');
   }
 
   fs.writeFileSync(controllerPath, controllerContent);
@@ -491,7 +503,23 @@ function updateAppModule() {
   const appModulePath = path.join(process.cwd(), 'src/app.module.ts');
   
   if (!fs.existsSync(appModulePath)) {
-    logWarning('app.module.ts not found. Please manually import ExGuardModule.');
+    logWarning('app.module.ts not found. Creating basic app.module.ts...');
+    
+    // Create basic app.module.ts
+    const basicAppModule = `import { Module } from '@nestjs/common';
+import { ExGuardModule } from './exguard/exguard.module';
+
+@Module({
+  imports: [
+    ExGuardModule
+  ],
+  controllers: [],
+})
+export class AppModule {}
+`;
+    
+    fs.writeFileSync(appModulePath, basicAppModule);
+    logSuccess('Created basic app.module.ts with ExGuardModule');
     return;
   }
 
@@ -594,7 +622,8 @@ function updatePackageScripts() {
   const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
 
   const scriptsToAdd = {
-    'exguard:setup': 'node node_modules/exguard-backend/scripts/setup-nestjs-fixed.cjs',
+    'setup-nestjs': 'node node_modules/exguard-backend/scripts/setup-nestjs.cjs',
+    'exguard:setup': 'node node_modules/exguard-backend/scripts/setup-nestjs.cjs',
     'exguard:example': 'node node_modules/exguard-backend/scripts/create-example.cjs'
   };