Merge pull request #212 from devchant/XP-Level-Tracking

feat: Added XP and level tracking to users

Author: phertyameen

backend/http/endpoint.http

@@ -9,6 +9,8 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjEsImVtYWlsI
     "password": "FatimaAminu@123"
 }
 
+GET http://localhost:3000/users
+
 
 POST http://localhost:3000/auth/signIn
 Content-Type: application/json
@@ -17,6 +19,16 @@ Content-Type: application/json
     "password": "FatimaAminu@123"
 }
 
+### Submit puzzle answer (earns XP)
+POST http://localhost:3000/progress/submit
+Content-Type: application/json
+
+{
+  "userId": "1",
+  "puzzleId": "dcebf04a-542f-464d-92e4-3ad983cde9ba",
+  "answer": "42"
+}
+
 POST http://localhost:3000/auth/signIn
 Content-Type: application/json
 Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjEsImVtYWlsIjoiYW1pbnVmYXRpbWFAZ21haWwuY29tIiwiaWF0IjoxNzY5MzI0Mjk0LCJleHAiOjE3NjkzMjc4OTQsImF1ZCI6ImxvY2FsaG9zdDozMDAwIiwiaXNzIjoibG9jYWxob3N0OjMwMDAifQ.vqjgnN33AMD0j1wxX6e6912PDB2VMW23eVJUQYBZRAA
@@ -47,6 +59,7 @@ GET http://localhost:3000/puzzles?page=1&limit=10
 GET http://localhost:3000/puzzles?categoryId=397b1a88-3a41-4c14-afee-20f57554368b&difficulty=INTERMEDIATE&page=1&limit=10
 
 
+GET http://localhost:3000/users/1/xp-level
 
 
 GET http://localhost:3000/users?limit=10&page=1

backend/package.json

@@ -67,6 +67,7 @@
     "@types/express": "^5.0.0",
     "@types/jest": "^29.5.14",
     "@types/node": "^22.10.7",
+    "@types/nodemailer": "^7.0.9",
     "@types/passport-jwt": "^4.0.1",
     "@types/supertest": "^6.0.2",
     "eslint": "^9.18.0",

backend/src/auth/controllers/auth.controller.ts

@@ -130,7 +130,6 @@ export class AuthController {
   public checkNonceStatus(@Query('nonce') nonce: string) {
     return this.authservice.checkNonceStatus(nonce);
   }
-
   @Post('/forgot-password')
   @Throttle({ default: { limit: 3, ttl: 60000 } }) // 3 requests per minute
   @HttpCode(HttpStatus.OK)

backend/src/auth/providers/auth.service.ts

@@ -12,13 +12,6 @@ import { ResetPasswordProvider } from './reset-password.provider';
 import { ForgotPasswordDto } from '../dtos/forgot-password.dto';
 import { ResetPasswordDto } from '../dtos/reset-password.dto';
 
-// interface OAuthUser {
-//   email: string;
-//   username: string;
-//   picture: string;
-//   accessToken: string;
-// }
-
 @Injectable()
 export class AuthService {
   private nonces = new Map<
@@ -165,7 +158,6 @@ export class AuthService {
   public refreshToken(refreshTokenDto: RefreshTokenDto) {
     return this.refreshTokensProvider.refreshTokens(refreshTokenDto);
   }
-
   public async forgotPassword(forgotPasswordDto: ForgotPasswordDto) {
     return await this.forgotPasswordProvider.forgotPassword(forgotPasswordDto);
   }

backend/src/auth/providers/generate-tokens.provider.ts

@@ -1,4 +1,3 @@
-/* eslint-disable prettier/prettier */
 import { forwardRef, Inject, Injectable } from '@nestjs/common';
 import { ApiTags, ApiOperation } from '@nestjs/swagger';
 import { JwtService } from '@nestjs/jwt';
@@ -40,7 +39,12 @@ export class GenerateTokensProvider {
    * @returns A signed JWT token
    */
   @ApiOperation({ summary: 'Sign JWT Token' })
-  public async signToken<T>(userId: string, username: string, expiresIn: number, payload?: T) {
+  public async signToken<T>(
+    userId: string,
+    username: string,
+    expiresIn: number,
+    payload?: T,
+  ) {
     return await this.jwtService.signAsync(
       {
         sub: userId,
@@ -62,17 +66,18 @@ export class GenerateTokensProvider {
    * @returns An object containing access and refresh tokens
    */
   @ApiOperation({ summary: 'Generate Access and Refresh Tokens' })
-public async generateTokens(user: User) {
-  if (!user.username) {
-    throw new Error('user not found');
-  }
+  public async generateTokens(user: User) {
+    if (!user.username) {
+      throw new Error('user not found');
+    }
 
-  const [accessToken, refreshToken] = await Promise.all([
-    this.signToken(user.id, user.username, this.jwtConfiguration.ttl, { email: user.email }),
-    this.signToken(user.id, user.username, this.jwtConfiguration.ttl)
-  ]);
+    const [accessToken, refreshToken] = await Promise.all([
+      this.signToken(user.id, user.username, this.jwtConfiguration.ttl, {
+        email: user.email,
+      }),
+      this.signToken(user.id, user.username, this.jwtConfiguration.ttl),
+    ]);
 
-  return { accessToken, refreshToken, user };
+    return { accessToken, refreshToken, user };
+  }
 }
-
-}

backend/src/auth/strategies/jwt.strategy.ts

@@ -3,7 +3,6 @@ import { PassportStrategy } from '@nestjs/passport';
 import { ExtractJwt, Strategy } from 'passport-jwt';
 import { ConfigType } from '@nestjs/config';
 import jwtConfig from '../authConfig/jwt.config';
-
 interface JwtPayload {
   sub: string;
   email: string;

backend/src/main.ts

@@ -37,4 +37,4 @@ async function bootstrap() {
 
   await app.listen(3000);
 }
-bootstrap();
+void bootstrap();

backend/src/progress/controllers/progress.controller.ts

@@ -6,7 +6,12 @@ import {
   UseGuards,
   BadRequestException,
 } from '@nestjs/common';
-import { ApiTags, ApiOperation, ApiResponse, ApiBearerAuth } from '@nestjs/swagger';
+import {
+  ApiTags,
+  ApiOperation,
+  ApiResponse,
+  ApiBearerAuth,
+} from '@nestjs/swagger';
 import { AuthGuard } from '@nestjs/passport';
 import { paginationQueryDto } from '../../common/pagination/paginationQueryDto';
 import { GetProgressHistoryProvider } from '../providers/get-progress-history.provider';

backend/src/progress/progress.controller.ts

@@ -0,0 +1,17 @@
+import { Controller, Post, Body } from '@nestjs/common';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { ProgressService } from './progress.service';
+import { SubmitAnswerDto } from './dtos/submit-answer.dto';
+
+@Controller('progress')
+@ApiTags('progress')
+export class ProgressController {
+  constructor(private readonly progressService: ProgressService) {}
+
+  @Post('submit')
+  @ApiOperation({ summary: 'Submit a puzzle answer' })
+  @ApiResponse({ status: 200, description: 'Answer processed successfully' })
+  async submitAnswer(@Body() submitAnswerDto: SubmitAnswerDto) {
+    return this.progressService.submitAnswer(submitAnswerDto);
+  }
+}

backend/src/progress/progress.module.ts

@@ -11,7 +11,7 @@ import { GetCategoryStatsProvider } from './providers/get-category-stats.provide
 import { GetOverallStatsProvider } from './providers/get-overall-stats.provider';
 import { ProgressCalculationProvider } from './providers/progress-calculation.provider';
 import { Puzzle } from '../puzzles/entities/puzzle.entity';
-
+import { XpLevelService } from '../users/providers/xp-level.service';
 
 @Module({
   imports: [
@@ -24,7 +24,8 @@ import { Puzzle } from '../puzzles/entities/puzzle.entity';
     GetCategoryStatsProvider,
     GetOverallStatsProvider,
     ProgressCalculationProvider,
+    XpLevelService,
   ],
-  exports: [ProgressService, ProgressCalculationProvider, TypeOrmModule],
+  exports: [ProgressService, ProgressCalculationProvider],
 })
-export class ProgressModule {}
+export class ProgressModule {}