Merge pull request #54 from Modarb-Ai-Trainer:docs

src/common/serializers/equipment.serialization.ts

@@ -1,12 +1,16 @@
+import { SwaggerResponseProperty } from "@lib/decorators/swagger-response-property.decorator";
 import { Expose } from "class-transformer";
 
 export class MuscleSerialization {
-    @Expose({ name: "_id" })
-    id: string;
+  @Expose({ name: "_id" })
+  @SwaggerResponseProperty({ type: "string" })
+  id: string;
 
-    @Expose()
-    name: string;
+  @Expose()
+  @SwaggerResponseProperty({ type: "string" })
+  name: string;
 
-    @Expose()
-    image: string;
+  @Expose()
+  @SwaggerResponseProperty({ type: "string" })
+  image: string;
 }

src/common/serializers/exercise.serialization.ts

@@ -1,62 +1,75 @@
 import { Expose, Transform } from "class-transformer";
 import { serialize } from "@helpers/serialize";
+import { SwaggerResponseProperty } from "@lib/decorators/swagger-response-property.decorator";
 
 class ExpectedDurationRange {
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   min: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   max: number;
 }
 
 class Media {
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   type: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   url: string;
 }
 
 export class ExerciseSerialization {
   @Expose({ name: "_id" })
+  @SwaggerResponseProperty({ type: "string" })
   id: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   name: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   category: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   duration: number | null;
 
   @Expose({ name: "expectedDurationRange" })
-  @Transform(
-    ({ value }) => serialize(value, ExpectedDurationRange)
-  )
+  @SwaggerResponseProperty({ type: {} })
+  @Transform(({ value }) => serialize(value, ExpectedDurationRange))
   expectedDurationRange: object;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   reps: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   sets: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   instructions: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   benefits: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: ["string"] })
   targetMuscles: any;
 
   @Expose()
+  @SwaggerResponseProperty({ type: ["string"] })
   equipments: any;
 
   @Expose({ name: "media" })
-  @Transform(
-    ({ value }) => serialize(value, Media)
-  )
+  @SwaggerResponseProperty({ type: {} })
+  @Transform(({ value }) => serialize(value, Media))
   media: object;
 }

src/common/serializers/muscle.serialization.ts

@@ -1,12 +1,16 @@
+import { SwaggerResponseProperty } from "@lib/decorators/swagger-response-property.decorator";
 import { Expose } from "class-transformer";
 
 export class EquipmentSerialization {
     @Expose({ name: "_id" })
+    @SwaggerResponseProperty({ type: "string" })
     id: string;
 
     @Expose()
+    @SwaggerResponseProperty({ type: "string" })
     name: string;
 
     @Expose()
+    @SwaggerResponseProperty({ type: "string" })
     image: string;
 }

src/common/serializers/template.serialization.ts

@@ -1,15 +1,20 @@
+import { SwaggerResponseProperty } from "@lib/decorators/swagger-response-property.decorator";
 import { Expose } from "class-transformer";
 
 export class TemplateSerialization {
-    @Expose({ name: "_id" })
-    id: string;
+  @Expose({ name: "_id" })
+  @SwaggerResponseProperty({ type: "string" })
+  id: string;
 
-    @Expose()
-    name: string;
+  @Expose()
+  @SwaggerResponseProperty({ type: "string" })
+  name: string;
 
-    @Expose()
-    user: string;
+  @Expose()
+  @SwaggerResponseProperty({ type: "string" })
+  user: string;
 
-    @Expose()
-    exercises: string[];
+  @Expose()
+  @SwaggerResponseProperty({ type: ["string"] })
+  exercises: string[];
 }

src/common/serializers/user-registered-workout.serialization.ts

@@ -1,61 +1,71 @@
 import { Expose, Transform } from "class-transformer";
 import { serialize } from "@helpers/serialize";
-
+import { SwaggerResponseProperty } from "@lib/decorators/swagger-response-property.decorator";
 
 class Days {
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   day_number: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   total_number_exercises: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   day_type: string;
 
   @Expose({ name: "exercises" })
+  @SwaggerResponseProperty({ type: {} })
   exercises: any;
 
   @Expose()
-  is_done: Boolean
+  @SwaggerResponseProperty({ type: "boolean" })
+  is_done: Boolean;
 }
 
 class Weeks {
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   week_number: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   week_name: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   week_description: string;
 
   @Expose({ name: "days" })
-  @Transform(
-    ({ value }) => serialize(value, Days)
-  )
+  @SwaggerResponseProperty({ type: [Days] })
+  @Transform(({ value }) => serialize(value, Days))
   days: any;
 
   @Expose()
-  is_done: Boolean
+  @SwaggerResponseProperty({ type: "boolean" })
+  is_done: Boolean;
 }
 
 export class UserRegisteredWorkoutsSerialization {
   @Expose({ name: "_id" })
+  @SwaggerResponseProperty({ type: "string" })
   id: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   user: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   workout: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "boolean" })
   is_active: Boolean;
 
   @Expose({ name: "weeks" })
-  @Transform(
-    ({ value }) => serialize(value, Weeks)
-  )
+  @SwaggerResponseProperty({ type: [Weeks] })
+  @Transform(({ value }) => serialize(value, Weeks))
   weeks: any;
-
-}
+}

src/common/serializers/user.serialization.ts

@@ -1,68 +1,83 @@
 import { Expose, Transform } from "class-transformer";
 import { serialize } from "@helpers/serialize";
+import { SwaggerResponseProperty } from "@lib/decorators/swagger-response-property.decorator";
 
 class Preferences {
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   fitness_goal: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   target_weight: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   workout_frequency: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: {} })
   preferred_days: any;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   workout_place: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: {} })
   preferred_equipment: any;
 }
 
-
 export class UserSerialization {
   @Expose({ name: "_id" })
+  @SwaggerResponseProperty({ type: "string" })
   id: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   name: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   email: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   image: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   role: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   gender: string;
 
   @Expose({ name: "dob" })
+  @SwaggerResponseProperty({ type: "number" })
   @Transform(
-    ({ value }) => new Date().getFullYear() - (new Date(value).getFullYear())
+    ({ value }) => new Date().getFullYear() - new Date(value).getFullYear()
   )
   age: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   height: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   weight: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   fitness_level: string;
 
   @Expose({ name: "preferences" })
-  @Transform(
-    ({ value }) => serialize(value, Preferences)
-  )
+  @SwaggerResponseProperty({ type: Preferences })
+  @Transform(({ value }) => serialize(value, Preferences))
   preferences: object;
 
   @Expose()
+  @SwaggerResponseProperty({ type: {} })
   injuries: any;
-
-}
+}

src/common/serializers/workout.serialization.ts

@@ -1,33 +1,42 @@
 import { Expose, Transform } from "class-transformer";
 import { serialize } from "@helpers/serialize";
+import { SwaggerResponseProperty } from "@lib/decorators/swagger-response-property.decorator";
 
 
 
 class Days {
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   day_number: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   total_number_exercises: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   day_type: string;
 
   @Expose({ name: "exercises" })
+  @SwaggerResponseProperty({ type: {} })
   exercises: any;
 }
 
 class TemplateWeeks {
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   week_number: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   week_name: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   week_description: string;
 
   @Expose({ name: "days" })
+  @SwaggerResponseProperty({ type: [Days] })
   @Transform(
     ({ value }) => serialize(value, Days)
   )
@@ -36,39 +45,51 @@ class TemplateWeeks {
 
 export class WorkoutSerialization {
   @Expose({ name: "_id" })
+  @SwaggerResponseProperty({ type: "string" })
   id: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   name: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   description: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   type: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   image: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   created_by: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   fitness_level: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   fitness_goal: string;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "string" })
   place: any;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   min_per_day: number;
 
   @Expose()
+  @SwaggerResponseProperty({ type: "number" })
   total_number_days: number;
 
   @Expose({ name: "template_weeks" })
+  @SwaggerResponseProperty({ type: [TemplateWeeks] })
   @Transform(
     ({ value }) => serialize(value, TemplateWeeks)
   )

src/lib/decorators/swagger-response-property.decorator.ts

@@ -0,0 +1,29 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
+
+export const SwaggerResponseProperty = (
+  props?:
+    | {
+        name?: string;
+        type?: any;
+      }
+    | string
+) => {
+  if (typeof props === "string") {
+    return (target: any, propertyKey: string) => {
+      swaggerRegistry.updateSchemaProperty({
+        schema: target.constructor.name,
+        property: propertyKey,
+        type: props,
+      });
+    };
+  }
+
+  return (target: any, propertyKey: string) => {
+    swaggerRegistry.updateSchemaProperty({
+      schema: target.constructor.name,
+      property: propertyKey,
+      newName: props?.name,
+      type: props?.type,
+    });
+  };
+};

src/lib/decorators/swagger-response.decorator.ts

@@ -1,41 +1,86 @@
 import { swaggerRegistry } from "@lib/swagger/swagger";
 import { instanceToPlain } from "class-transformer";
 
-export const SwaggerResponse = (responseClass: any) => {
-  return (target: any, propertyKey: string) => {
-    const isArray = Array.isArray(responseClass);
-    responseClass = isArray ? responseClass[0] : responseClass;
+const responseToSwaggerSchema = (response: any) => {
+  const isClass = typeof response === "function";
+  const responseName =
+    (isClass && response.prototype.constructor.name) || undefined;
+  const responseData = swaggerRegistry.schemasRegistry.get(responseName);
 
-    // turn class to swagger schema
-    const schema: any = {
-      type: "object",
-      properties: {},
-    };
+  // turn class to swagger schema
+  const schema: any = {
+    type: "object",
+    properties: (isClass && responseData?.properties) || {},
+  };
 
-    // get class properties
-    let properties = [];
-    let instance;
-    try {
-      instance = new responseClass();
-      properties = Object.getOwnPropertyNames(instanceToPlain(instance));
-    } catch (e) {
-      instance = responseClass;
-      properties = Object.getOwnPropertyNames(instance);
-    }
-    properties.forEach((property) => {
+  // get class properties
+  let properties = [];
+  let instance;
+  try {
+    instance = new response();
+    properties = Object.getOwnPropertyNames(instanceToPlain(instance));
+  } catch (e) {
+    instance = response;
+    properties = Object.getOwnPropertyNames(instance);
+  }
+
+  if (responseData?.propertiesToExclude) {
+    properties = properties.filter(
+      (property) => !responseData.propertiesToExclude.includes(property)
+    );
+  }
+
+  properties.forEach((property) => {
+    if (!schema.properties[property] && !responseData?.properties) {
       schema.properties[property] = {
         type: (instance[property] && typeof instance[property]) || "string",
       };
-    });
+    }
 
-    if (isArray) {
-      schema.type = "array";
-      schema.items = {
-        type: "object",
-        properties: schema.properties,
-      };
+    if (schema.properties[property] && !schema.properties[property].type) {
+      schema.properties[property].type =
+        (instance[property] && typeof instance[property]) || "string";
+    }
+
+    if (Array.isArray(schema.properties[property]?.type)) {
+      const isTypeObjectOrClass =
+        typeof schema.properties[property].type[0] === "function" ||
+        typeof schema.properties[property].type[0] === "object";
+
+      if (isTypeObjectOrClass) {
+        schema.properties[property].items = responseToSwaggerSchema(
+          schema.properties[property].type[0]
+        );
+        schema.properties[property].type = "array";
+      } else {
+        schema.properties[property].items = {
+          type: schema.properties[property].type[0],
+        };
+        schema.properties[property].type = "array";
+      }
     }
 
+    if (
+      typeof schema.properties[property]?.type === "function" ||
+      typeof schema.properties[property]?.type === "object"
+    ) {
+      schema.properties[property] = responseToSwaggerSchema(
+        schema.properties[property].type
+      );
+    }
+  });
+
+  return schema;
+};
+
+export const SwaggerResponse = (responseClass: any) => {
+  return (target: any, propertyKey: string) => {
+    const isArray = Array.isArray(responseClass);
+    responseClass = isArray ? responseClass[0] : responseClass;
+    // turn class to swagger schema
+    const schema = responseToSwaggerSchema(responseClass);
+
+    // add standard response schema
     const standardResponseSchema: any = {
       type: "object",
       properties: {
@@ -44,11 +89,20 @@ export const SwaggerResponse = (responseClass: any) => {
           type: "string",
         },
         status: {
-          type: "string",
+          type: "number",
         },
       },
     };
 
+    // set schema type to array if response is array
+    if (isArray) {
+      schema.type = "array";
+      schema.items = {
+        type: "object",
+        properties: schema.properties,
+      };
+    }
+    // add meta for array response
     if (isArray) {
       standardResponseSchema.properties.meta = {
         type: "object",

src/lib/swagger/swagger.ts

@@ -2,7 +2,7 @@
  * Swagger registry class.
  */
 class SwaggerRegistry {
-  public static registry = new Map<
+  public controllersRegistry = new Map<
     any,
     {
       routes: {
@@ -17,9 +17,43 @@ class SwaggerRegistry {
     }
   >();
 
+  public schemasRegistry = new Map<
+    any,
+    {
+      properties: {
+        [key: string]: any;
+      };
+      propertiesToExclude: string[];
+    }
+  >();
+
+  public initSchemaIfNotExists(schema: any) {
+    if (!this.schemasRegistry.has(schema)) {
+      this.schemasRegistry.set(schema, {
+        properties: {},
+        propertiesToExclude: [],
+      });
+    }
+  }
+
+  public updateSchemaProperty(props: {
+    schema: any;
+    property: string;
+    newName?: string;
+    type: any;
+  }) {
+    this.initSchemaIfNotExists(props.schema);
+    const data = this.schemasRegistry.get(props.schema);
+    data.properties[props.newName || props.property] = { type: props.type };
+    if (props.newName) {
+      data.propertiesToExclude.push(props.property);
+    }
+    this.schemasRegistry.set(props.schema, data);
+  }
+
   public initControllerIfNotExists(controller: any, prefix: string = "") {
-    if (!SwaggerRegistry.registry.has(controller)) {
-      SwaggerRegistry.registry.set(controller, {
+    if (!this.controllersRegistry.has(controller)) {
+      this.controllersRegistry.set(controller, {
         routes: [],
         prefix,
       });
@@ -28,9 +62,9 @@ class SwaggerRegistry {
 
   public setControllerPrefix(controller: any, prefix: string) {
     this.initControllerIfNotExists(controller);
-    const data = SwaggerRegistry.registry.get(controller);
+    const data = this.controllersRegistry.get(controller);
     data.prefix = prefix;
-    SwaggerRegistry.registry.set(controller, data);
+    this.controllersRegistry.set(controller, data);
   }
 
   public updateRoute(
@@ -44,7 +78,7 @@ class SwaggerRegistry {
     }
   ) {
     this.initControllerIfNotExists(controller);
-    const data = SwaggerRegistry.registry.get(controller);
+    const data = this.controllersRegistry.get(controller);
 
     // delete undefined keys
     Object.keys(params).forEach(
@@ -60,19 +94,19 @@ class SwaggerRegistry {
       data.routes.push(params);
     }
 
-    SwaggerRegistry.registry.set(controller, data);
+    this.controllersRegistry.set(controller, data);
   }
 
   public setControllerTags(controller: any, tags: string[]) {
     this.initControllerIfNotExists(controller);
-    const data = SwaggerRegistry.registry.get(controller);
+    const data = this.controllersRegistry.get(controller);
     data.tags = tags;
-    SwaggerRegistry.registry.set(controller, data);
+    this.controllersRegistry.set(controller, data);
   }
 
   public generateSwaggerDocument() {
     const paths: any = {};
-    SwaggerRegistry.registry.forEach((value) => {
+    this.controllersRegistry.forEach((value) => {
       const controllerData = value;
 
       controllerData.routes.forEach((route) => {

src/modules/console/common/serializers/admin.serialization.ts

@@ -1,27 +1,37 @@
+import { SwaggerResponseProperty } from "@lib/decorators/swagger-response-property.decorator";
 import { Expose, Transform } from "class-transformer";
 
 export class AdminSerialization {
   @Expose({ name: "_id" })
+  @SwaggerResponseProperty("string")
   id: string;
 
   @Expose()
+  @SwaggerResponseProperty("string")
   name: string;
 
   @Expose()
+  @SwaggerResponseProperty("string")
   email: string;
 
   @Expose()
+  @SwaggerResponseProperty({
+    type: {},
+  })
   image: object;
 
   @Expose()
+  @SwaggerResponseProperty("string")
   role: string;
 
   @Expose()
+  @SwaggerResponseProperty("string")
   gender: string;
 
   @Expose({ name: "dob" })
+  @SwaggerResponseProperty("number")
   @Transform(
     ({ value }) => new Date().getFullYear() - new Date(value).getFullYear()
   )
   age: number;
-}
+}