Feat: (solo project) Add solo project status, email and discordId query params to GET endpoint

cherylli · web-flow · commit 06e8d63d6128 · 2025-02-07T14:08:05.000+11:00
* remove unused endpoints

* move solo project validation pipes to dto

* (solo project) move API queries in controller to dto

* (solo project) move sort default to dto

* (solo project) add status query param to get endpoint

* (solo project) fix optional param types

* (solo project) fix optional param types

* (solo project) add query params for discordId and email

* update changelog
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,12 +19,14 @@
 
 - Added release please github actions ([#235])(https://github.com/chingu-x/chingu-dashboard-be/pull/235)
 - Added version release link to Swagger docs ([#218](https://github.com/chingu-x/chingu-dashboard-be/pull/231))
+- Added status, email, discordId query to solo project get endpoint ([#237](https://github.com/chingu-x/chingu-dashboard-be/pull/237))
 
 ### Changed
 
 - Updated readme for installation part ([#225])(https://github.com/chingu-x/chingu-dashboard-be/pull/225)
 - Updated nestjs packages to latest version ([#233])(https://github.com/chingu-x/chingu-dashboard-be/pull/233)
 - Refactoring of email service + unit tests ([#232](https://github.com/chingu-x/chingu-dashboard-be/pull/232))
+- Refactored solo project get endpoint input validation ([#237](https://github.com/chingu-x/chingu-dashboard-be/pull/237))
 
 ### Fixed
 - fixed POST voyages/teams/{teamId}/techs bug , verify that categoryId is owned by correct team ([#229](https://github.com/chingu-x/chingu-dashboard-be/pull/229))
diff --git a/prisma/seed/solo-project.ts b/prisma/seed/solo-project.ts
@@ -4,6 +4,7 @@ import { prisma } from "./prisma-client";
 
 export const populateSoloProjects = async () => {
     // solo project status
+    // TODO update this to generate from global/constants/statuses
     await prisma.soloProjectStatus.createMany({
         data: [
             { status: "Waiting Evaluation" },
diff --git a/src/features/features.service.ts b/src/features/features.service.ts
@@ -4,7 +4,7 @@ import {
     Injectable,
     NotFoundException,
 } from "@nestjs/common";
-import { PrismaService } from "../prisma/prisma.service";
+import { PrismaService } from "@/prisma/prisma.service";
 import { CreateFeatureDto } from "./dto/create-feature.dto";
 import { UpdateFeatureDto } from "./dto/update-feature.dto";
 import { UpdateFeatureOrderAndCategoryDto } from "./dto/update-feature-order-and-category.dto";
diff --git a/src/global/constants/roles.ts b/src/global/constants/roles.ts
@@ -0,0 +1,12 @@
+// voyage project roles
+export const soloProjectVoyageRoles = [
+    "Developer",
+    "Product Owner",
+    "Scrum Master",
+    "Data Scientist",
+    "UI/UX Designer",
+];
+
+export const voyageRoles = [...soloProjectVoyageRoles, "Voyage Guide"];
+
+// app roles
diff --git a/src/global/constants/sortMaps.ts b/src/global/constants/sortMaps.ts
@@ -10,3 +10,7 @@ export const soloProjectSortMap: Map<string, string> = new Map(
         updatedAt: "updatedAt",
     }),
 );
+
+export const soloProjectSortMapKeys: string[] = Array.from(
+    soloProjectSortMap.keys(),
+);
diff --git a/src/global/constants/statuses.ts b/src/global/constants/statuses.ts
@@ -0,0 +1,14 @@
+export const soloProjectStatuses = [
+    "Waiting Evaluation",
+    "Requested Changes",
+    "Passed",
+    "No Pass",
+    "No Response",
+    "Not in Discord",
+];
+
+// application statuses
+
+// voyage application & voyage statuses
+
+// user statuses
diff --git a/src/global/global.service.ts b/src/global/global.service.ts
@@ -8,6 +8,7 @@ import { PrismaService } from "@/prisma/prisma.service";
 import { CustomRequest } from "./types/CustomRequest";
 import { FormResponseDto } from "./dtos/FormResponse.dto";
 import { UserWithProfile } from "@/global/types/users.types";
+import { soloProjectSortMapKeys } from "@/global/constants/sortMaps";
 
 @Injectable()
 export class GlobalService {
@@ -243,7 +244,7 @@ export class GlobalService {
                     : field;
             if (!sortFieldMap.get(fieldName))
                 throw new BadRequestException(
-                    `Sort field ${fieldName} is not valid.`,
+                    `Sort field '${fieldName}' is not valid. Valid sort fields: ${soloProjectSortMapKeys.join(", ")}`,
                 );
             return {
                 [sortFieldMap.get(fieldName)!]: direction,
diff --git a/src/pipes/non-negative-int-default-value-pipe.ts b/src/pipes/non-negative-int-default-value-pipe.ts
diff --git a/src/solo-projects/dto/create-solo-project.dto.ts b/src/solo-projects/dto/create-solo-project.dto.ts
diff --git a/src/solo-projects/dto/get-solo-project.dto.ts b/src/solo-projects/dto/get-solo-project.dto.ts
@@ -0,0 +1,84 @@
+import {
+    IsEmail,
+    IsIn,
+    IsNumber,
+    IsOptional,
+    IsPositive,
+    IsString,
+    Min,
+} from "class-validator";
+import { Type } from "class-transformer";
+import { soloProjectStatuses } from "@/global/constants/statuses";
+import { ApiProperty } from "@nestjs/swagger";
+import { soloProjectVoyageRoles } from "@/global/constants/roles";
+
+export class GetSoloProjectDto {
+    @IsOptional()
+    @IsNumber()
+    @Min(0)
+    @Type(() => Number)
+    @ApiProperty({
+        name: "offset",
+        type: Number,
+        description: "Offset for pagination (default: 0)",
+        required: false,
+    })
+    offset: number = 0;
+
+    @IsOptional()
+    @IsPositive()
+    @Type(() => Number)
+    @ApiProperty({
+        name: "pageSize",
+        type: Number,
+        description:
+            "page size (number of results) for pagination (default: 30)",
+        required: false,
+    })
+    pageSize: number = 30;
+
+    @IsOptional()
+    @ApiProperty({
+        name: "sort",
+        type: String,
+        description:
+            "Sort. - for descending, + (or nothing) for ascending (default: -createdAt)" +
+            "<br/> Example: '+status;-createdAt' will sort by status ascending then createdAt descending" +
+            "<br/> Valid sort fields are: 'status', 'createdAt', 'updatedAt'" +
+            "<br/> Default: '-createdAt'",
+        required: false,
+    })
+    sort: string = "-createdAt";
+
+    @ApiProperty({
+        enum: soloProjectStatuses,
+        required: false,
+    })
+    @IsOptional()
+    @IsIn(soloProjectStatuses)
+    status: string;
+
+    @ApiProperty({
+        enum: soloProjectVoyageRoles,
+        required: false,
+    })
+    @IsOptional()
+    @IsIn(soloProjectVoyageRoles)
+    voyageRoles: string;
+
+    @ApiProperty({
+        required: false,
+        description: "User email",
+    })
+    @IsOptional()
+    @IsEmail()
+    email: string;
+
+    @ApiProperty({
+        required: false,
+        description: "Discord ID, not discord nickname",
+    })
+    @IsOptional()
+    @IsString()
+    discordId: string;
+}
diff --git a/src/solo-projects/dto/update-solo-project.dto.ts b/src/solo-projects/dto/update-solo-project.dto.ts
diff --git a/src/solo-projects/solo-projects.controller.ts b/src/solo-projects/solo-projects.controller.ts
@@ -1,36 +1,19 @@
-import {
-    Controller,
-    Get,
-    Post,
-    Body,
-    Patch,
-    Param,
-    Delete,
-    Query,
-    HttpStatus,
-} from "@nestjs/common";
+import { Controller, Get, Query, HttpStatus } from "@nestjs/common";
 import { SoloProjectsService } from "./solo-projects.service";
-import { CreateSoloProjectDto } from "./dto/create-solo-project.dto";
-import { UpdateSoloProjectDto } from "./dto/update-solo-project.dto";
-import { ApiOperation, ApiQuery, ApiResponse, ApiTags } from "@nestjs/swagger";
-import { NonNegativeIntDefaultValuePipe } from "@/pipes/non-negative-int-default-value-pipe";
+import { ApiOperation, ApiResponse, ApiTags } from "@nestjs/swagger";
 import { SoloProjectsResponse } from "@/solo-projects/solo-projects.response";
 import {
     BadRequestErrorResponse,
     ForbiddenErrorResponse,
     UnauthorizedErrorResponse,
 } from "@/global/responses/errors";
+import { GetSoloProjectDto } from "@/solo-projects/dto/get-solo-project.dto";
 
 @Controller("solo-projects")
 @ApiTags("Solo Projects")
 export class SoloProjectsController {
     constructor(private readonly soloProjectsService: SoloProjectsService) {}
 
-    @Post()
-    create(@Body() createSoloProjectDto: CreateSoloProjectDto) {
-        return this.soloProjectsService.create(createSoloProjectDto);
-    }
-
     @ApiOperation({
         summary: "[Permission: admin, evaluator] Get all solo projects",
     })
@@ -56,57 +39,8 @@ export class SoloProjectsController {
         description: "Forbidden - user does not have the required permission",
         type: ForbiddenErrorResponse,
     })
-    @ApiQuery({
-        name: "offset",
-        type: Number,
-        description: "Offset for pagination (default: 0)",
-        required: false,
-    })
-    @ApiQuery({
-        name: "pageSize",
-        type: Number,
-        description:
-            "page size (number of results) for pagination (default: 30)",
-        required: false,
-    })
-    @ApiQuery({
-        name: "sort",
-        type: String,
-        description:
-            "Sort. - for descending, + (or nothing) for ascending (default: -createdAt)" +
-            "<br/> Example: '+status;-createdAt' will sort by status ascending then createdAt descending" +
-            "<br/> Valid sort fields are: 'status', 'createdAt', 'updatedAt'",
-        required: false,
-    })
     @Get()
-    getAllSoloProjects(
-        @Query("offset", new NonNegativeIntDefaultValuePipe(0)) offset: number,
-        @Query("pageSize", new NonNegativeIntDefaultValuePipe(30))
-        pageSize: number,
-        @Query("sort") sort: string,
-    ) {
-        return this.soloProjectsService.getAllSoloProjects(
-            offset,
-            pageSize,
-            sort,
-        );
-    }
-
-    @Get(":id")
-    findOne(@Param("id") id: string) {
-        return this.soloProjectsService.findOne(+id);
-    }
-
-    @Patch(":id")
-    update(
-        @Param("id") id: string,
-        @Body() updateSoloProjectDto: UpdateSoloProjectDto,
-    ) {
-        return this.soloProjectsService.update(+id, updateSoloProjectDto);
-    }
-
-    @Delete(":id")
-    remove(@Param("id") id: string) {
-        return this.soloProjectsService.remove(+id);
+    getAllSoloProjects(@Query() query: GetSoloProjectDto) {
+        return this.soloProjectsService.getAllSoloProjects(query);
     }
 }
diff --git a/src/solo-projects/solo-projects.service.ts b/src/solo-projects/solo-projects.service.ts
@@ -1,11 +1,10 @@
 import { Injectable } from "@nestjs/common";
-import { CreateSoloProjectDto } from "./dto/create-solo-project.dto";
-import { UpdateSoloProjectDto } from "./dto/update-solo-project.dto";
 import { PrismaService } from "@/prisma/prisma.service";
 import { userSelectBasicWithSocial } from "@/global/selects/users.select";
 import { SoloProjectWithPayload } from "@/global/types/solo-project.types";
 import { GlobalService } from "@/global/global.service";
 import { soloProjectSortMap } from "@/global/constants/sortMaps";
+import { soloProjectStatuses } from "@/global/constants/statuses";
 
 @Injectable()
 export class SoloProjectsService {
@@ -33,15 +32,23 @@ export class SoloProjectsService {
         };
     };
 
-    create(_createSoloProjectDto: CreateSoloProjectDto) {
-        return "This action adds a new soloProject";
-    }
-
-    async getAllSoloProjects(
-        offset: number,
-        pageSize: number,
-        sort: string = "-createdAt",
-    ) {
+    async getAllSoloProjects({
+        offset,
+        pageSize,
+        sort,
+        status,
+        // voyageRoles, // TODO: need to add voyageRoles to the table or extract from responses
+        email,
+        discordId,
+    }: {
+        offset: number;
+        pageSize: number;
+        sort: string;
+        status: (typeof soloProjectStatuses)[number] | undefined;
+        // voyageRoles: string | undefined;
+        email: string | undefined;
+        discordId: string | undefined;
+    }) {
         const soloProjects = await this.prisma.soloProject.findMany({
             skip: offset,
             take: pageSize,
@@ -102,6 +109,24 @@ export class SoloProjectsService {
                 createdAt: true,
                 updatedAt: true,
             },
+            where: {
+                status: {
+                    status,
+                },
+                user: {
+                    email,
+                    ...(discordId && {
+                        oAuthProfiles: {
+                            some: {
+                                providerUserId: discordId,
+                                provider: {
+                                    name: "discord",
+                                },
+                            },
+                        },
+                    }),
+                },
+            },
         });
 
         const data = soloProjects.map((sp) =>
@@ -116,16 +141,4 @@ export class SoloProjectsService {
             },
         };
     }
-
-    findOne(id: number) {
-        return `This action returns a #${id} soloProject`;
-    }
-
-    update(id: number, _updateSoloProjectDto: UpdateSoloProjectDto) {
-        return `This action updates a #${id} soloProject`;
-    }
-
-    remove(id: number) {
-        return `This action removes a #${id} soloProject`;
-    }
 }
