Improve the entities and the HTTP status codes

test/integration/db.test.ts → src/configs/db.test.ts

@@ -1,4 +1,4 @@
-import { dataSource } from '../../src/configs/dbConfig'
+import { dataSource } from './dbConfig'
 
 export const initConnection = async (): Promise<void> => {
   await dataSource

src/controllers/auth.controller.ts

@@ -11,8 +11,9 @@ export const register = async (req: Request, res: Response): Promise<void> => {
       res.status(400).json({ error: 'Email and password are required fields' })
     }
 
-    const newUser = await registerUser(email, password)
-    res.status(201).json(newUser)
+    const { statusCode, message, profile } = await registerUser(email, password)
+
+    res.status(statusCode).json({ message, profile })
   } catch (err) {
     if (err instanceof Error) {
       console.error('Error executing query', err)
@@ -31,8 +32,9 @@ export const login = async (req: Request, res: Response): Promise<void> => {
       res.status(400).json({ error: 'Email and password are required fields' })
     }
 
-    const tokenData = await loginUser(email, password)
-    res.json(tokenData)
+    const { statusCode, message, token } = await loginUser(email, password)
+
+    res.status(statusCode).json({ message, token })
   } catch (err) {
     if (err instanceof Error) {
       console.error('Error executing query', err)

src/controllers/profile.controller.ts

@@ -1,12 +1,13 @@
 import type { Request, Response } from 'express'
-import { getProfile, updateProfile } from '../services/profile.service'
+import { updateProfile } from '../services/profile.service'
+import type Profile from '../entities/profile.entity'
 
 export const getProfileHandler = async (
   req: Request,
   res: Response
 ): Promise<void> => {
   try {
-    const user = await getProfile(req)
+    const { user } = req
     if (!user) {
       res.status(404).json({ message: 'Profile not found' })
     }
@@ -27,18 +28,15 @@ export const updateProfileHandler = async (
   res: Response
 ): Promise<void> => {
   try {
-    const user = await getProfile(req)
+    const user = req.user as Profile
     if (!user) {
       res.status(404).json({ message: 'Profile not found' })
     }
 
-    const updatedProfile = user && (await updateProfile(user, req.body))
+    const { statusCode, message, profile } =
+      user && (await updateProfile(user, req.body))
 
-    if (!updatedProfile) {
-      res.status(404).json({ message: 'Profile not found' })
-    }
-
-    res.status(200).json(updatedProfile)
+    res.status(statusCode).json({ message, profile })
   } catch (err) {
     if (err instanceof Error) {
       console.error('Error executing query', err)

src/entities/baseEntity.ts

@@ -0,0 +1,36 @@
+import {
+  BeforeInsert,
+  BeforeUpdate,
+  Column,
+  PrimaryGeneratedColumn
+} from 'typeorm'
+import { v4 as uuidv4 } from 'uuid'
+
+class BaseEntity {
+  @PrimaryGeneratedColumn('uuid')
+  uuid!: string
+
+  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
+  created_at: Date | undefined
+
+  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
+  updated_at: Date | undefined
+
+  @BeforeInsert()
+  @BeforeUpdate()
+  updateTimestamps(): void {
+    this.updated_at = new Date()
+    if (!this.uuid) {
+      this.created_at = new Date()
+    }
+  }
+
+  @BeforeInsert()
+  async generateUuid(): Promise<void> {
+    if (!this.uuid) {
+      this.uuid = uuidv4()
+    }
+  }
+}
+
+export default BaseEntity

src/entities/category.entity.ts

@@ -1,45 +1,15 @@
-import {
-  BeforeInsert,
-  BeforeUpdate,
-  Column,
-  Entity,
-  PrimaryGeneratedColumn
-} from 'typeorm'
-import { v4 as uuidv4 } from 'uuid'
+import { Column, Entity } from 'typeorm'
+import BaseEntity from './baseEntity'
 
 @Entity('category')
-class Category {
-  @PrimaryGeneratedColumn('uuid')
-  uuid!: string
-
-  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-  created_at: Date | undefined
-
-  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-  updated_at: Date | undefined
-
+class Category extends BaseEntity {
   @Column({ type: 'varchar', length: 255 })
   category: string
 
   constructor(category: string) {
+    super()
     this.category = category
   }
-
-  @BeforeInsert()
-  @BeforeUpdate()
-  updateTimestamps(): void {
-    this.updated_at = new Date()
-    if (!this.uuid) {
-      this.created_at = new Date()
-    }
-  }
-
-  @BeforeInsert()
-  async generateUuid(): Promise<void> {
-    if (!this.uuid) {
-      this.uuid = uuidv4()
-    }
-  }
 }
 
 export default Category

src/entities/email.entity.ts

@@ -1,18 +1,9 @@
-import {
-  BeforeInsert,
-  BeforeUpdate,
-  Column,
-  Entity,
-  PrimaryGeneratedColumn
-} from 'typeorm'
+import { Column, Entity } from 'typeorm'
 import { EmailStatusTypes } from '../enums'
-import { v4 as uuidv4 } from 'uuid'
+import BaseEntity from './baseEntity'
 
 @Entity('email')
-class Email {
-  @PrimaryGeneratedColumn('uuid')
-  uuid!: string
-
+class Email extends BaseEntity {
   @Column({ type: 'varchar', length: 255 })
   recipient: string
 
@@ -25,39 +16,18 @@ class Email {
   @Column({ type: 'enum', enum: EmailStatusTypes })
   state: EmailStatusTypes
 
-  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-  created_at: Date | undefined
-
-  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-  updated_at: Date | undefined
-
   constructor(
     recipient: string,
     subject: string,
     content: string,
     state: EmailStatusTypes
   ) {
+    super()
     this.recipient = recipient
     this.subject = subject
     this.content = content
     this.state = state
   }
-
-  @BeforeInsert()
-  @BeforeUpdate()
-  updateTimestamps(): void {
-    this.updated_at = new Date()
-    if (!this.uuid) {
-      this.created_at = new Date()
-    }
-  }
-
-  @BeforeInsert()
-  async generateUuid(): Promise<void> {
-    if (!this.uuid) {
-      this.uuid = uuidv4()
-    }
-  }
 }
 
 export default Email

src/entities/mentee.entity.ts

@@ -1,24 +1,12 @@
-import {
-  BeforeInsert,
-  BeforeUpdate,
-  Column,
-  Entity,
-  JoinColumn,
-  ManyToOne,
-  OneToOne,
-  PrimaryGeneratedColumn
-} from 'typeorm'
+import { Column, Entity, JoinColumn, ManyToOne, OneToOne } from 'typeorm'
 import { MenteeApplication } from '../types'
 import Mentor from './mentor.entity'
 import profileEntity from './profile.entity'
 import { ApplicationStatus } from '../enums'
-import { v4 as uuidv4 } from 'uuid'
+import BaseEntity from './baseEntity'
 
 @Entity('mentee')
-class Mentee {
-  @PrimaryGeneratedColumn()
-  uuid!: string
-
+class Mentee extends BaseEntity {
   @Column({
     type: 'enum',
     enum: ApplicationStatus,
@@ -42,12 +30,6 @@ class Mentee {
   @ManyToOne(() => Mentor, (mentor) => mentor.mentees)
   mentor: Mentor
 
-  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-  created_at: Date | undefined
-
-  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-  updated_at: Date | undefined
-
   constructor(
     state: ApplicationStatus,
     answers: MenteeApplication,
@@ -56,29 +38,14 @@ class Mentee {
     profile: profileEntity,
     mentor: Mentor
   ) {
+    super()
     this.state = state
     this.answers = answers
     this.certificate_id = certificate_id
     this.journal = journal
     this.profile = profile
     this.mentor = mentor
   }
-
-  @BeforeInsert()
-  @BeforeUpdate()
-  updateTimestamps(): void {
-    this.updated_at = new Date()
-    if (!this.uuid) {
-      this.created_at = new Date()
-    }
-  }
-
-  @BeforeInsert()
-  async generateUuid(): Promise<void> {
-    if (!this.uuid) {
-      this.uuid = uuidv4()
-    }
-  }
 }
 
 export default Mentee

src/entities/mentor.entity.ts

@@ -1,24 +1,12 @@
-import {
-  BeforeInsert,
-  BeforeUpdate,
-  Column,
-  Entity,
-  JoinColumn,
-  OneToMany,
-  OneToOne,
-  PrimaryGeneratedColumn
-} from 'typeorm'
+import { Column, Entity, JoinColumn, OneToMany, OneToOne } from 'typeorm'
 import profileEntity from './profile.entity'
 import Mentee from './mentee.entity'
 import Category from './category.entity'
-import { v4 as uuidv4 } from 'uuid'
 import { ApplicationStatus } from '../enums'
+import BaseEntity from './baseEntity'
 
 @Entity('mentor')
-class Mentor {
-  @PrimaryGeneratedColumn('uuid')
-  uuid!: string
-
+class Mentor extends BaseEntity {
   @Column({
     type: 'enum',
     enum: ApplicationStatus,
@@ -29,7 +17,7 @@ class Mentor {
   @OneToMany(() => Category, (category) => category.category)
   category: Category
 
-  @Column({ type: 'json' })
+  @Column({ type: 'json', select: false })
   application: JSON
 
   @Column({ type: 'boolean' })
@@ -42,12 +30,6 @@ class Mentor {
   @OneToMany(() => Mentee, (mentee) => mentee.mentor)
   mentees: Mentee[]
 
-  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-  created_at: Date | undefined
-
-  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
-  updated_at: Date | undefined
-
   constructor(
     state: ApplicationStatus,
     category: Category,
@@ -56,29 +38,14 @@ class Mentor {
     profile: profileEntity,
     mentees: Mentee[]
   ) {
+    super()
     this.state = state
     this.category = category
     this.application = application
     this.availability = availability
     this.profile = profile
     this.mentees = mentees
   }
-
-  @BeforeInsert()
-  @BeforeUpdate()
-  updateTimestamps(): void {
-    this.updated_at = new Date()
-    if (!this.uuid) {
-      this.created_at = new Date()
-    }
-  }
-
-  @BeforeInsert()
-  async generateUuid(): Promise<void> {
-    if (!this.uuid) {
-      this.uuid = uuidv4()
-    }
-  }
 }
 
 export default Mentor