How felipeoj/api_auth works
Project Type and Purpose
• This is a backend API built with NestJS and TypeScript, focused on secure authentication (JWT & 2FA), user management, and email notifications. It follows Clean Architecture principles, separating concerns into modules, controllers, services, use-cases, domain entities, and infrastructure.
Key Layers & Components
a. Presentation/API Layer
• Controllers (src/auth/auth.controller.ts, src/users/users.controller.ts, src/auth/controllers/two-factor.controller.ts)
• Validation Pipes (ZodValidationPipe in src/common/pipes)
• Guards & Strategies (JWT guards and passport strategies in src/auth/infra)
b. Application Layer
• DTOs (src/application/dto/*.dto.ts)
• Use-Cases (login, register, refresh, handle-refresh, 2FA enable/verify in src/auth/use-cases)
c. Domain Layer
• Entities (User, Auth in src/core/domain/entities)
• Domain Services (e.g., user-validation.service.ts)
• Repository Interfaces (user-repository.interface.ts)
d. Infrastructure Layer
• Database (Prisma client in src/database/prisma.service.ts, prisma-user.repository.ts)
• Email (email.client.ts, email.service.ts in src/infra/email)
• Providers (dependency injection tokens in src/infra/providers)
e. Cross-Cutting
• AppModule wiring all modules
• Configuration (.env, @nestjs/config)
• Logging, Testing (Jest)
External Dependencies & Services
• PostgreSQL (via Prisma ORM)
• Email Provider (SMTP or external API via email.client.ts)
• Passport.js strategies (JWT access & refresh)
• qrcode for 2FA QR generation
Interactions & Data Flows
1. Client → HTTP Request → NestJS Controller
2. Controller → Validate DTO via Zod Pipe → Invoke Use-Case
3. Use-Case → Domain Service + Repository Interface → Prisma Repository → Database
4. On 2FA enable: Use-Case generates secret, QR code → returns to Controller → Client
5. Authentication: JWT Strategy Guard intercepts protected routes → validates token → attaches user to request
6. Refresh flow: Controller reads HTTP-only cookie → Use-Case refreshes tokens → sets new cookie + returns access token
7. Email notifications (e.g., verification) via EmailService → EmailClient → external SMTP/API
Architectural Patterns & Principles
• Clean Architecture (clear separation: Controllers, DTOs, Use-Cases, Domain, Infrastructure)
• Dependency Inversion (use repository interfaces injected into services)
• Single Responsibility (each module focuses on one concern: auth, users, email)
• Modularization (NestJS modules encapsulate related providers, controllers, exports)
• Critical flows (e.g., token issuance, 2FA verification)