feat: streaks endpoint

:w

@@ -0,0 +1,20 @@
+import { serialize } from "@helpers/serialize";
+import { SwaggerResponseProperty } from "@lib/decorators/swagger-response-property.decorator";
+import { Expose, Transform } from "class-transformer";
+
+class HSDaysSerialization {
+  @Expose()
+  @SwaggerResponseProperty('string')
+  day: string;
+
+  @Expose()
+  @SwaggerResponseProperty('number')
+  points: number;
+}
+
+export class HomeStreakSerialization {
+  @Expose()
+  @Transform((value) => (value as any).map((day) => serialize(day, HSDaysSerialization)))
+  @SwaggerResponseProperty({ type: [HSDaysSerialization]})
+  days: HSDaysSerialization[];
+}

package-lock.json

@@ -30,6 +30,7 @@
         "tsc-alias": "^1.8.8"
       },
       "devDependencies": {
+        "@faker-js/faker": "^8.4.1",
         "@types/express": "^4.17.21",
         "@types/swagger-ui-express": "^4.1.6",
         "nodemon": "^3.0.2",
@@ -51,6 +52,22 @@
         "node": ">=12"
       }
     },
+    "node_modules/@faker-js/faker": {
+      "version": "8.4.1",
+      "resolved": "https://registry.npmjs.org/@faker-js/faker/-/faker-8.4.1.tgz",
+      "integrity": "sha512-XQ3cU+Q8Uqmrbf2e0cIC/QN43sTBSC8KF12u29Mb47tWrt2hAgBXSgpZMj4Ao8Uk0iJcU99QsOCaIL8934obCg==",
+      "dev": true,
+      "funding": [
+        {
+          "type": "opencollective",
+          "url": "https://opencollective.com/fakerjs"
+        }
+      ],
+      "engines": {
+        "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
+        "npm": ">=6.14.13"
+      }
+    },
     "node_modules/@hapi/address": {
       "version": "4.1.0",
       "resolved": "https://registry.npmjs.org/@hapi/address/-/address-4.1.0.tgz",

package.json

@@ -14,6 +14,7 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@faker-js/faker": "^8.4.1",
     "@types/express": "^4.17.21",
     "@types/swagger-ui-express": "^4.1.6",
     "nodemon": "^3.0.2",

src/common/interfaces/user-request.interface.ts

@@ -0,0 +1,6 @@
+import { Request } from "express";
+import { IJwtLoginPayload } from "./jwt-payload.interface";
+
+export interface IUserRequest extends Request {
+  jwtPayload?: IJwtLoginPayload;
+}

src/modules/users/modules/home/controllers/home.controller.ts

@@ -1,7 +1,6 @@
 import { UserRegisteredWorkoutsService } from "../../user-registered-workouts/services/user-registered-workouts.service";
-import { UserRegisteredMealPlansService } from "../../user-registered-meal-plans/services/user-registered-meal-plans.service";
 import { UserService } from "../../users/services/users.service";
-import { Request, Response } from "express";
+import { Response } from "express";
 import { JsonResponse } from "@lib/responses/json-response";
 import { asyncHandler } from "@helpers/async-handler";
 import { BaseController } from "@lib/controllers/controller.base";
@@ -13,30 +12,63 @@ import { SwaggerGet } from "@lib/decorators/swagger-routes.decorator";
 import { SwaggerSummary } from "@lib/decorators/swagger-summary.decorator";
 import { SwaggerDescription } from "@lib/decorators/swagger-description.decorator";
 import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
-import { HomeSerialization } from "common/serializers/home.serialization";
+import { HomeSerialization } from "../responses/home.serialization";
+import { HomeStreakSerialization } from "../responses/home-streak.serialization";
+import { SwaggerQuery } from "@lib/decorators/swagger-query.decorator";
+import { queryValidator } from "@helpers/validation.helper";
+import { homeStreakQueryValidation } from "../validations/home-streak.query.validation";
+import { UserHomeService } from "../services/user-home.service";
+import { IUserRequest } from "@common/interfaces/user-request.interface";
 
 
-interface userRequest extends Request {
-  jwtPayload?: any;
-}
-
 @Controller("/user/homePage")
 @ControllerMiddleware(UsersGuardMiddleware())
 export class homePageController extends BaseController {
   private userRegisteredWorkoutsService = new UserRegisteredWorkoutsService();
-  private userRegisteredMealPlansService = new UserRegisteredMealPlansService();
   private userService = new UserService();
+  private userHomeService = new UserHomeService();
 
   setRoutes(): void {
     this.router.get("/", asyncHandler(this.getHomePage));
+    this.router.get("/streak", queryValidator(homeStreakQueryValidation), asyncHandler(this.getHomePageStreak));
   }
 
+  @SwaggerGet('/streak')
+  @SwaggerResponse(HomeStreakSerialization)
+  @SwaggerQuery({
+    startDate: {
+      type: "string",
+      required: true,
+    },
+    endDate: {
+      type: "string",
+      required: true,
+    },
+  })
+  @SwaggerSummary("Home Streak Weeks")
+  @SwaggerDescription("Get home page streak weeks")
+  getHomePageStreak = async (req: IUserRequest, res: Response) => {
+    // getting the query params
+    const startDate = new Date(req.query.startDate as string);
+    const endDate = new Date(req.query.endDate as string);
+
+    // getting the streak weeks
+    const streak = await this.userHomeService.getHomePageStreak(req.jwtPayload.id, startDate, endDate);
+
+    // return response
+    return JsonResponse.success(
+      {
+        data: serialize(streak, HomeStreakSerialization)
+      },
+      res
+    );
+  };
 
   @SwaggerGet()
   @SwaggerResponse(HomeSerialization)
   @SwaggerSummary("Home")
   @SwaggerDescription("Get home page")
-  getHomePage = async (req: userRequest, res: Response) => {
+  getHomePage = async (req: IUserRequest, res: Response) => {
 
     const user = await this.userService.findOneOrFail(
       { _id: req.jwtPayload.id },

src/modules/users/modules/home/responses/home-streak.serialization.ts

@@ -0,0 +1,18 @@
+import { SwaggerResponseProperty } from "@lib/decorators/swagger-response-property.decorator";
+import { Expose } from "class-transformer";
+
+class HSDaysSerialization {
+  @Expose()
+  @SwaggerResponseProperty('string')
+  day: string;
+
+  @Expose()
+  @SwaggerResponseProperty('number')
+  points: number;
+}
+
+export class HomeStreakSerialization {
+  @Expose()
+  @SwaggerResponseProperty({ type: [HSDaysSerialization]})
+  days: HSDaysSerialization[];
+}

src/{common/serializers → modules/users/modules/home/responses}/home.serialization.ts

@@ -118,7 +118,6 @@ class UserHome {
 }
 
 export class HomeSerialization {
-
   @Expose()
   @SwaggerResponseProperty({ type: UserHome })
   @Transform(({ value }) => serialize(value, UserHome))
@@ -132,4 +131,4 @@ export class HomeSerialization {
   @Expose({ name: "myMealPlan" })
   @SwaggerResponseProperty({ type: {} })
   myMealPlan: any;
-}
+}

src/modules/users/modules/home/services/user-home.service.ts

@@ -0,0 +1,24 @@
+import { HomeStreakSerialization } from "../responses/home-streak.serialization";
+import { faker } from '@faker-js/faker';
+
+export class UserHomeService {
+  private getDaysArray(startDate: Date, endDate: Date): string[] {
+    const days = [];
+    for (let day = startDate; day <= endDate; day.setDate(day.getDate() + 1)) {
+      days.push(day.toLocaleString('en-US', { weekday: 'long' }).toLowerCase());
+    }
+    return days;
+  }
+
+  async getHomePageStreak(_userId: string, startDate: Date, endDate: Date): Promise<HomeStreakSerialization> {
+    // list day names in between the start and end date
+    const days = this.getDaysArray(startDate, endDate);
+
+    return {
+      days: days.map(day => ({
+        day: day,
+        points: faker.number.int({ min: 0, max: 100 }),
+      })),
+    }
+  }
+}

src/modules/users/modules/home/validations/home-streak.query.validation.ts

@@ -0,0 +1,22 @@
+import * as joi from "joi";
+import { createSchema } from "@helpers/create-schema";
+
+export interface IHomeStreakQuery {
+  startDate: string;
+  endDate: string;
+}
+
+export const homeStreakQueryKeys = {
+  startDate: joi.string().pattern(new RegExp("^[0-9]{4}-[0-9]{2}-[0-9]{2}$")).required().messages({
+    "string.base": "startDate must be a string",
+    "string.pattern.base": "startDate must be a valid date",
+    "any.required": "startDate is required",
+  }),
+  endDate: joi.string().pattern(new RegExp("^[0-9]{4}-[0-9]{2}-[0-9]{2}$")).required().messages({
+    "string.base": "endDate must be a string",
+    "string.pattern.base": "endDate must be a valid date",
+    "any.required": "endDate is required",
+  })
+};
+
+export const homeStreakQueryValidation = createSchema<IHomeStreakQuery>(homeStreakQueryKeys);