feat(authentication): add pokemon fields to user

Author: Ismaestro

README.md

@@ -83,13 +83,13 @@ npm run prisma:generate
 Run migrations to create necessary tables in the DB
 
 ```bash
-npm run migrate:dev
+npm run prisma:migrate:dev
 ```
 
 Seed the database with the first user
 
 ```bash
-npm run seed
+npm run prisma:seed
 ```
 
 Start the application

bruno/NestJS Example app/User/Catch Pokemon.bru

@@ -0,0 +1,24 @@
+meta {
+  name: Catch Pokemon
+  type: http
+  seq: 7
+}
+
+post {
+  url: {{host}}/{{version}}/user/pokemon/catch
+  body: json
+  auth: none
+}
+
+body:json {
+  {
+    "pokemonId": 1
+  }
+}
+
+script:pre-request {
+  const accessToken = bru.getEnvVar('accessToken');
+  if (accessToken) {
+    req.headers.cookie = `accessToken=${accessToken}`;
+  }
+}

bruno/NestJS Example app/User/Register.bru

@@ -17,10 +17,10 @@ headers {
 body:json {
   {
     "email": "[email protected]",
-    "firstname": "Ismael",
+    "name": "Ismael",
     "password": "Secret42",
     "favouritePokemonId": 25,
-    "terms": false
+    "terms": true
   }
 }
 

bruno/NestJS Example app/User/Update.bru

@@ -12,7 +12,7 @@ patch {
 
 body:json {
   {
-    "firstname": "Ismael",
+    "name": "Ismael",
     "language": "en-US"
   }
 }

package.json

@@ -16,16 +16,15 @@
   },
   "scripts": {
     "prepare": "husky install || true",
-    "setup": "npm run docker:db && npm run prisma:generate && npm run migrate:dev && npm run seed && npm start",
+    "setup": "npm run docker:db && npm run prisma:generate && npm run prisma:migrate:dev && npm run prisma:seed && npm start",
     "start": "nest start --watch",
     "start:prod": "node dist/main",
     "docker:db": "docker-compose -f docker-compose.db.yml up -d",
-    "seed": "prisma db seed",
-    "migrate:dev": "prisma migrate dev --preview-feature",
-    "migrate:dev:create": "prisma migrate dev --create-only --preview-feature",
-    "migrate:deploy": "npx prisma migrate deploy --preview-feature",
-    "prisma:push": "prisma db push",
+    "prisma:seed": "prisma db seed",
+    "prisma:migrate:dev": "prisma migrate dev --preview-feature",
+    "prisma:migrate:deploy": "npx prisma migrate deploy --preview-feature",
     "prisma:generate": "npx prisma generate",
+    "prisma:push": "prisma db push",
     "lint": "eslint .",
     "test": "jest --coverage",
     "test:watch": "jest --watch",

prisma/migrations/20241216002534_init/migration.sql renamed to prisma/migrations/20241218145504_/migration.sql

@@ -6,12 +6,13 @@ CREATE TABLE "User" (
     "id" TEXT NOT NULL,
     "createdAt" TIMESTAMPTZ(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
     "updatedAt" TIMESTAMPTZ(3) NOT NULL,
+    "name" TEXT NOT NULL,
     "email" TEXT NOT NULL,
     "password" TEXT NOT NULL,
-    "firstname" TEXT NOT NULL,
-    "language" "Language" NOT NULL,
     "favouritePokemonId" INTEGER NOT NULL,
+    "language" "Language" NOT NULL,
     "terms" BOOLEAN NOT NULL DEFAULT false,
+    "caughtPokemonIds" INTEGER[] DEFAULT ARRAY[]::INTEGER[],
 
     CONSTRAINT "User_pkey" PRIMARY KEY ("id")
 );

prisma/schema.prisma

@@ -16,12 +16,13 @@ model User {
   id                 String   @id @default(uuid())
   createdAt          DateTime @default(now()) @db.Timestamptz(3)
   updatedAt          DateTime @updatedAt @db.Timestamptz(3)
+  name               String
   email              String   @unique
   password           String
-  firstname          String
-  language           Language
   favouritePokemonId Int
+  language           Language
   terms              Boolean  @default(false)
+  caughtPokemonIds   Int[]    @default([])
 }
 
 enum Language {

prisma/seed.ts

@@ -11,7 +11,7 @@ async function main() {
   await prisma.user.create({
     data: {
       email: '[email protected]',
-      firstname: 'Pete',
+      name: 'Pete',
       language: Language.EN_US,
       password: '$2b$10$yjh4MYBO/eNJKxcpODqbt.dQ/0u80wV.bR5uFRv7n27bmHI0glw1G', // Secret42
       favouritePokemonId: 25,

src/core/enums/app-error.enum.ts

@@ -14,4 +14,7 @@ export enum AppError {
   REFRESH_TOKEN_NOT_FOUND = 3001,
   ACCESS_TOKEN_EXPIRED = 3002,
   REFRESH_TOKEN_EXPIRED = 3003,
+
+  // Pokemon Errors (4000–4999)
+  POKEMON_ALREADY_CAUGHT = 4000,
 }

src/features/authentication/dto/register.request.ts

@@ -21,7 +21,7 @@ export class RegisterRequest {
   password!: string;
 
   @IsString()
-  firstname!: string;
+  name!: string;
 
   @IsNumber()
   favouritePokemonId!: number;

src/features/user/dto/catch-pokemon.request.ts

@@ -0,0 +1,6 @@
+import { IsNumber } from 'class-validator';
+
+export class CatchPokemonRequest {
+  @IsNumber()
+  pokemonId!: number;
+}

src/features/user/dto/update-user.request.ts

@@ -4,7 +4,7 @@ import { Language as AppLanguage } from '../../../core/enums/language.enum';
 export class UpdateUserRequest {
   @IsOptional()
   @IsString()
-  firstname?: string;
+  name?: string;
 
   @IsOptional()
   @IsEnum(AppLanguage)

src/features/user/user.controller.ts

@@ -4,6 +4,7 @@ import {
   Get,
   Logger,
   Patch,
+  Post,
   Request,
   UseGuards,
   UseInterceptors,
@@ -15,6 +16,7 @@ import { ResponseInterceptor } from '../../core/interceptors/response.intercepto
 import { LanguageTransformInterceptor } from '../../core/interceptors/language.interceptor';
 import { UpdateUserRequest } from './dto/update-user.request';
 import { UpdateUserResponse } from './dto/update-user.response';
+import { CatchPokemonRequest } from './dto/catch-pokemon.request';
 
 @Controller('user')
 @UseInterceptors(ResponseInterceptor)
@@ -42,4 +44,17 @@ export class UserController {
     this.logger.log(`[UpdateUser]: user with id "${userId}" updating itself`);
     return this.userService.updateUser(userId, updateUserRequest);
   }
+
+  @Post('pokemon/catch')
+  @UseGuards(AuthenticationGuard)
+  async catchPokemon(
+    @Request() request: { userId: string },
+    @Body() catchPokemonRequest: CatchPokemonRequest,
+  ): Promise<UpdateUserResponse> {
+    const { userId } = request;
+    this.logger.log(
+      `[CatchPokemon]: user with id "${userId}" catching pokemon ${catchPokemonRequest.pokemonId}`,
+    );
+    return this.userService.catchPokemon(userId, catchPokemonRequest);
+  }
 }

src/features/user/user.repository.ts

@@ -39,15 +39,27 @@ export class UserRepository {
     });
   }
 
-  async updateUserById(userId: string, userData: User): Promise<Omit<User, 'password'>> {
+  async updateUserById(
+    userId: string,
+    userData: Partial<Omit<User, 'password'>>,
+  ): Promise<Omit<User, 'password'>> {
     return this.prisma.user.update({
-      omit: {
-        password: true,
-      },
       data: userData,
       where: {
         id: userId,
       },
+      select: {
+        password: false,
+        id: true,
+        createdAt: true,
+        updatedAt: true,
+        email: true,
+        name: true,
+        language: true,
+        favouritePokemonId: true,
+        terms: true,
+        caughtPokemonIds: true,
+      },
     });
   }
 }

src/features/user/user.service.ts

@@ -1,11 +1,12 @@
-import { BadRequestException, Injectable, Logger } from '@nestjs/common';
+import { BadRequestException, ConflictException, Injectable, Logger } from '@nestjs/common';
 import { AppError } from '../../core/enums/app-error.enum';
 import { LanguageService } from '../../core/services/language.service';
 import { UserRepository } from './user.repository';
 import { GetMeResponse } from './dto/get-me.response';
 import { User } from '@prisma/client';
 import { UpdateUserResponse } from './dto/update-user.response';
 import { UpdateUserRequest } from './dto/update-user.request';
+import { CatchPokemonRequest } from './dto/catch-pokemon.request';
 
 @Injectable()
 export class UserService {
@@ -64,4 +65,56 @@ export class UserService {
       });
     }
   }
+
+  async catchPokemon(
+    userId: string,
+    catchPokemonRequest: CatchPokemonRequest,
+  ): Promise<UpdateUserResponse> {
+    if (!userId) {
+      throw new BadRequestException({
+        code: AppError.USER_NOT_FOUND,
+        message: `User not found`,
+      });
+    }
+
+    const userWithoutPokemon = await this.userRepository.getUserById(userId);
+    if (!userWithoutPokemon) {
+      throw new BadRequestException({
+        code: AppError.USER_NOT_FOUND,
+        message: `User with id ${userId} not found`,
+      });
+    }
+
+    return this.addPokemonToUser({ userId, userWithoutPokemon, catchPokemonRequest });
+  }
+
+  private async addPokemonToUser(data: {
+    userId: string;
+    userWithoutPokemon: Omit<User, 'password'>;
+    catchPokemonRequest: CatchPokemonRequest;
+  }) {
+    const pokemonsCaught = data.userWithoutPokemon.caughtPokemonIds;
+    const { pokemonId } = data.catchPokemonRequest;
+    if (pokemonsCaught.includes(pokemonId)) {
+      throw new ConflictException({
+        code: AppError.POKEMON_ALREADY_CAUGHT,
+        message: `You already have caught pokemon with id: ${pokemonId}`,
+      });
+    }
+    pokemonsCaught.push(pokemonId);
+
+    try {
+      const userUpdated = await this.userRepository.updateUserById(data.userId, {
+        ...data.userWithoutPokemon,
+        caughtPokemonIds: pokemonsCaught,
+      });
+      this.logger.log(`[CatchPokemon]: user updated successfully`);
+      return { user: userUpdated };
+    } catch {
+      throw new BadRequestException({
+        code: AppError.UPDATE_USER_FAILED,
+        message: `Unable to update user`,
+      });
+    }
+  }
 }