Merge branch 'main' of https://github.com/Modarb-Ai-Trainer/modarb-backend

src/common/models/exercise.model.ts

@@ -2,15 +2,52 @@ import mongoose from "mongoose";
 const { Schema } = mongoose;
 
 export interface IExercise {
-    name: string;
+  name: string;
+  category: string;
+  duration?: number | null;
+  expectedDurationRange: {
+    min: number;
+    max: number;
+  };
+  reps: number;
+  sets: number;
+  instructions: string;
+  benefits: string;
+  targetMuscles: string[]; // refs
+  equipments: string[]; // refs
+  media: {
+    type: "image" | "video";
+    url: string;
+  };
 }
 
 const exerciseSchema = new Schema({
-    name: { type: String, required: true, unique: true, dropDups: true },
-
+  name: { type: String, required: true, unique: true, dropDups: true },
+  category: { type: String, required: true },
+  duration: { type: Number, required: false },
+  expectedDurationRange: {
+    min: { type: Number, required: true },
+    max: { type: Number, required: true },
+  },
+  reps: { type: Number, required: true },
+  sets: { type: Number, required: true },
+  instructions: { type: String, required: true },
+  benefits: { type: String, required: true },
+  targetMuscles: [{ type: Schema.Types.ObjectId, ref: "muscles" }],
+  equipments: [{ type: Schema.Types.ObjectId, ref: "equipments" }],
+  media: {
+    type: {
+      type: String,
+      enum: ["image", "video"],
+      required: true,
+    },
+    url: { type: String, required: true },
+  },
 });
 
 export type ExerciseDocument = IExercise & mongoose.Document;
 
-export const Exercise = mongoose.model<ExerciseDocument>("exercises", exerciseSchema);
-
+export const Exercise = mongoose.model<ExerciseDocument>(
+  "exercises",
+  exerciseSchema
+);

src/common/serializers/exercise.serialization.ts

@@ -6,5 +6,4 @@ export class ExerciseSerialization {
 
   @Expose()
   name: string;
-
-}
+}

src/lib/responses/json-response.ts

@@ -35,7 +35,7 @@ export abstract class JsonResponse {
     const data = {
       status: props.status || 200,
       message: props.message || "Success",
-      data: props.data,
+      data: props.data || null,
       meta: props.meta,
     } satisfies IJSONSuccessResponse;
 

src/lib/responses/json-responses-params.d.ts

@@ -1,7 +1,7 @@
 export interface IJSONSuccessResponseProps {
   status?: number;
   message?: string;
-  data: Record<string, any> | Record<string, any>[];
+  data?: Record<string, any> | Record<string, any>[] | null;
   meta?: {
     total: number;
     page: number;

src/modules/console/modules/exercises/controllers/exercises.controller.ts

@@ -0,0 +1,97 @@
+import { ExerciseSerialization } from "@common/serializers/exercise.serialization";
+import { asyncHandler } from "@helpers/async-handler";
+import { parsePaginationQuery } from "@helpers/pagination";
+import { paramsValidator, bodyValidator } from "@helpers/validation.helper";
+import { BaseController } from "@lib/controllers/controller.base";
+import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
+import { Prefix } from "@lib/decorators/prefix.decorator";
+import { JsonResponse } from "@lib/responses/json-response";
+import { AdminGuardMiddleware } from "modules/console/common/guards/admins.guard";
+import { ExercisesService } from "../services/exercises.service";
+import { Request, Response } from "express";
+import { serialize } from "@helpers/serialize";
+import { createExerciseSchema } from "../validations/create-excercise.validation";
+import { updateExerciseSchema } from "../validations/update-excercise.validation";
+
+@Prefix("/console/exercises")
+@ControllerMiddleware(AdminGuardMiddleware({}))
+export class ExercisesController extends BaseController {
+  private exercisesService = new ExercisesService();
+
+  setRoutes() {
+    this.router.get("/", asyncHandler(this.list));
+    this.router.get("/:id", paramsValidator("id"), asyncHandler(this.get));
+    this.router.post(
+      "/",
+      bodyValidator(createExerciseSchema),
+      asyncHandler(this.create)
+    );
+    this.router.patch(
+      "/:id",
+      paramsValidator("id"),
+      bodyValidator(updateExerciseSchema),
+      asyncHandler(this.update)
+    );
+    this.router.delete(
+      "/:id",
+      paramsValidator("id"),
+      asyncHandler(this.delete)
+    );
+  }
+
+  list = async (req: Request, res: Response) => {
+    const paginationQuery = parsePaginationQuery(req.query);
+    const { docs, paginationData } = await this.exercisesService.list(
+      {},
+      paginationQuery
+    );
+
+    return JsonResponse.success(
+      {
+        data: serialize(docs, ExerciseSerialization),
+        meta: paginationData,
+      },
+      res
+    );
+  };
+
+  get = async (req: Request, res: Response) => {
+    const data = await this.exercisesService.findOneOrFail({
+      _id: req.params.id,
+    });
+    return JsonResponse.success(
+      {
+        data: serialize(data.toJSON(), ExerciseSerialization),
+      },
+      res
+    );
+  };
+
+  create = async (req: Request, res: Response) => {
+    const data = await this.exercisesService.create(req.body);
+    return JsonResponse.success(
+      {
+        data: serialize(data.toJSON(), ExerciseSerialization),
+      },
+      res
+    );
+  };
+
+  update = async (req: Request, res: Response) => {
+    const data = await this.exercisesService.updateOne(
+      { _id: req.params.id },
+      req.body
+    );
+    return JsonResponse.success(
+      {
+        data: serialize(data.toJSON(), ExerciseSerialization),
+      },
+      res
+    );
+  };
+
+  delete = async (req: Request, res: Response) => {
+    await this.exercisesService.deleteOne({ _id: req.params.id });
+    return JsonResponse.success({}, res);
+  };
+}

src/modules/console/modules/exercises/services/exercises.service.ts

@@ -0,0 +1,4 @@
+import { Exercise } from "@common/models/exercise.model";
+import { CrudService } from "@lib/services/crud.service";
+
+export class ExercisesService extends CrudService(Exercise) {}

src/modules/console/modules/exercises/validations/create-excercise.validation.ts

@@ -0,0 +1,85 @@
+import * as joi from "joi";
+import { createSchema } from "@helpers/create-schema";
+
+export interface ICreateExercise {
+  name: string;
+  category: string;
+  duration?: number | null;
+  expectedDurationRange: {
+    min: number;
+    max: number;
+  };
+  reps: number;
+  sets: number;
+  instructions: string;
+  benefits: string;
+  targetMuscles: string[]; // refs
+  equipments: string[]; // refs
+  media: {
+    type: "image" | "video";
+    url: string;
+  };
+}
+
+export const createExerciseSchema = createSchema<ICreateExercise>({
+  name: joi.string().empty().required().messages({
+    "string.base": "please enter a valid name",
+    "any.required": "name is required",
+    "string.empty": "name can not be empty",
+  }),
+  category: joi.string().empty().required().messages({
+    "string.base": "please enter a valid category",
+    "any.required": "category is required",
+    "string.empty": "category can not be empty",
+  }),
+  duration: joi.number().empty().optional().messages({
+    "number.base": "please enter a valid duration",
+  }),
+  expectedDurationRange: joi.object().keys({
+    min: joi.number().required().messages({
+      "number.base": "please enter a valid min duration",
+      "any.required": "min duration is required",
+    }),
+    max: joi.number().required().messages({
+      "number.base": "please enter a valid max duration",
+      "any.required": "max duration is required",
+    }),
+  }),
+  reps: joi.number().empty().required().messages({
+    "number.base": "please enter a valid reps",
+    "any.required": "reps is required",
+  }),
+  sets: joi.number().empty().required().messages({
+    "number.base": "please enter a valid sets",
+    "any.required": "sets is required",
+  }),
+  instructions: joi.string().empty().required().messages({
+    "string.base": "please enter a valid instructions",
+    "any.required": "instructions is required",
+    "string.empty": "instructions can not be empty",
+  }),
+  benefits: joi.string().empty().required().messages({
+    "string.base": "please enter a valid benefits",
+    "any.required": "benefits is required",
+    "string.empty": "benefits can not be empty",
+  }),
+  targetMuscles: joi.array().items(joi.string()).empty().required().messages({
+    "array.base": "please enter a valid target muscles",
+    "any.required": "target muscles is required",
+  }),
+  equipments: joi.array().items(joi.string()).empty().required().messages({
+    "array.base": "please enter a valid equipments",
+    "any.required": "equipments is required",
+  }),
+  media: joi.object().keys({
+    type: joi.string().valid("image", "video").required().messages({
+      "string.base": "please enter a valid media type",
+      "any.required": "media type is required",
+    }),
+    url: joi.string().empty().required().messages({
+      "string.base": "please enter a valid media url",
+      "any.required": "media url is required",
+      "string.empty": "media url can not be empty",
+    }),
+  }),
+});

src/modules/console/modules/exercises/validations/update-excercise.validation.ts

@@ -0,0 +1,85 @@
+import * as joi from "joi";
+import { createSchema } from "@helpers/create-schema";
+
+export interface IUpdateExercise {
+  name?: string;
+  category?: string;
+  duration?: number | null;
+  expectedDurationRange?: {
+    min: number;
+    max: number;
+  };
+  reps: number;
+  sets?: number;
+  instructions?: string;
+  benefits?: string;
+  targetMuscles?: string[]; // refs
+  equipments?: string[]; // refs
+  media?: {
+    type: "image" | "video";
+    url: string;
+  };
+}
+
+export const updateExerciseSchema = createSchema<IUpdateExercise>({
+  name: joi.string().empty().optional().messages({
+    "string.base": "please enter a valid name",
+    "any.required": "name is required",
+    "string.empty": "name can not be empty",
+  }),
+  category: joi.string().empty().optional().messages({
+    "string.base": "please enter a valid category",
+    "any.required": "category is required",
+    "string.empty": "category can not be empty",
+  }),
+  duration: joi.number().empty().optional().messages({
+    "number.base": "please enter a valid duration",
+  }),
+  expectedDurationRange: joi.object().keys({
+    min: joi.number().optional().messages({
+      "number.base": "please enter a valid min duration",
+      "any.required": "min duration is required",
+    }),
+    max: joi.number().optional().messages({
+      "number.base": "please enter a valid max duration",
+      "any.required": "max duration is required",
+    }),
+  }),
+  reps: joi.number().empty().optional().messages({
+    "number.base": "please enter a valid reps",
+    "any.required": "reps is required",
+  }),
+  sets: joi.number().empty().optional().messages({
+    "number.base": "please enter a valid sets",
+    "any.required": "sets is required",
+  }),
+  instructions: joi.string().empty().optional().messages({
+    "string.base": "please enter a valid instructions",
+    "any.required": "instructions is required",
+    "string.empty": "instructions can not be empty",
+  }),
+  benefits: joi.string().empty().optional().messages({
+    "string.base": "please enter a valid benefits",
+    "any.required": "benefits is required",
+    "string.empty": "benefits can not be empty",
+  }),
+  targetMuscles: joi.array().items(joi.string()).empty().optional().messages({
+    "array.base": "please enter a valid target muscles",
+    "any.required": "target muscles is required",
+  }),
+  equipments: joi.array().items(joi.string()).empty().optional().messages({
+    "array.base": "please enter a valid equipments",
+    "any.required": "equipments is required",
+  }),
+  media: joi.object().keys({
+    type: joi.string().valid("image", "video").optional().messages({
+      "string.base": "please enter a valid media type",
+      "any.required": "media type is required",
+    }),
+    url: joi.string().empty().optional().messages({
+      "string.base": "please enter a valid media url",
+      "any.required": "media url is required",
+      "string.empty": "media url can not be empty",
+    }),
+  }),
+});