Merge pull request #8 from WillACosta/feature/improve-ai-flow

[AUTOMATED-PR] - main <- feature/improve-ai-flow

Author: WillACosta

src/common/functions/safe-api-call.function.ts

@@ -8,14 +8,19 @@ export async function safeApiCall<T>(
 ): Promise<AppResponse<T>> {
 	try {
 		const data = await handler()
-		return res.status(200).json({
-			success: true,
-			data,
-		})
+		return res.send({ data })
 	} catch (err: any) {
+		if (err instanceof Error && err.message)
+			return res.status(500).json({
+				error: {
+					message: err.message,
+				},
+			})
+
 		return res.status(500).json({
-			success: false,
-			error: err,
+			error: {
+				message: 'Unexpected error!',
+			},
 		})
 	}
 }

src/common/middlewares/body-validation.middleware.ts

@@ -22,10 +22,14 @@ export const changeUserRoleSchema = z.object({
 })
 
 export const translateTextSchema = z.object({
-	text: z.string().min(1, 'text field is required'),
+	text: z.string().min(1, 'Text field is required'),
 	language: z.string().min(1, 'Language field is required'),
 })
 
+export const searchInDocumentsSchema = z.object({
+	query: z.string().min(1, 'Query field is required'),
+})
+
 export const validateRequestBody = (schema: z.ZodSchema<any>) => {
 	return (req: Request, res: AppResponse, next: NextFunction) => {
 		try {

src/common/types/network.types.ts

@@ -14,7 +14,6 @@ export interface AppRequest<
 }
 
 export type AppResponse<T = any> = Response<{
-	success: boolean
 	data?: T
-	error?: { message: string | string[]; code?: string }
+	error?: { message: string | string[] }
 }>

src/modules/auth/application/routes/index.ts

@@ -43,9 +43,6 @@ const router = express.Router()
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: true
  *                 data:
  *                   type: object
  *                   properties:
@@ -75,9 +72,6 @@ const router = express.Router()
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: false
  *                 error:
  *                   type: object
  *                   properties:

src/modules/core/utils/upload.config.ts

@@ -1,5 +1,6 @@
 import { Request, Response } from 'express'
 
+import { AppResponse } from '@/common/types'
 import crypto from 'crypto'
 import multer, { MulterError } from 'multer'
 import path from 'path'
@@ -20,11 +21,15 @@ const fileFilter = (
 	file: Express.Multer.File,
 	cb: multer.FileFilterCallback,
 ) => {
-	const allowedTypes = ['image/jpeg', 'image/png', 'application/pdf']
+	const allowedTypes = ['application/pdf']
 	if (allowedTypes.includes(file.mimetype)) {
 		cb(null, true)
 	} else {
-		cb(new Error('Invalid file type. Only JPEG, PNG, and PDF are allowed.'))
+		cb(
+			new Error('Invalid file type. Only PDF files are allowed.', {
+				cause: 'FILE_NOT_ALLOWED',
+			}),
+		)
 	}
 }
 
@@ -40,21 +45,50 @@ export const uploadMultipleDocs = multer({
 	limits: { fileSize: 5 * 1024 * 1024 },
 }).array('documents', 10)
 
-export function handleMulterErrorMessages(err: any, res: Response): Response {
+export function handleMulterErrorMessages(
+	err: any,
+	res: AppResponse,
+): Response {
 	if (err instanceof MulterError) {
 		switch (err.code) {
 			case 'LIMIT_FILE_SIZE':
-				return res.status(400).json({ error: 'File size exceeds the limit!' })
+				return res.status(400).json({
+					error: {
+						message: 'File size exceeds the limit!',
+					},
+				})
 			case 'LIMIT_FILE_COUNT':
-				return res.status(400).json({ error: 'Too many files uploaded!' })
+				return res.status(400).json({
+					error: {
+						message: 'Too many files uploaded!',
+					},
+				})
 			case 'LIMIT_UNEXPECTED_FILE':
-				return res.status(400).json({ error: 'Unexpected file uploaded!' })
+				return res.status(400).json({
+					error: {
+						message: 'Unexpected file uploaded!',
+					},
+				})
 			default:
-				return res
-					.status(400)
-					.json({ error: 'Unexpected error was occurred while uploading!' })
+				return res.status(400).json({
+					error: {
+						message: 'Unexpected error was occurred while uploading!',
+					},
+				})
 		}
 	}
 
-	return res.status(500).json({ error: 'An unknown error occurred!' })
+	if (err instanceof Error && err.cause == 'FILE_NOT_ALLOWED') {
+		return res.status(400).json({
+			error: {
+				message: err.message,
+			},
+		})
+	}
+
+	return res.status(500).json({
+		error: {
+			message: 'An unknown error occurred!',
+		},
+	})
 }

src/modules/genai/application/controllers/gen-ai.controller.ts

@@ -1,4 +1,5 @@
-import { AppRequest, AppResponse } from '@/common/types';
+import { safeApiCall } from '@/common/functions'
+import { AppRequest, AppResponse } from '@/common/types'
 import { searchInDocumentsUseCase, translateUseCase } from '@/di'
 import { ChatMemory } from '@/modules/core'
 
@@ -8,30 +9,27 @@ export class GenAIController {
 		res: AppResponse,
 	) {
 		const { text, language } = req.body
-		const result = await translateUseCase.invoke({ text, language })
-		return res.send({ success: true, data: result })
+		return safeApiCall(() => translateUseCase.invoke({ text, language }), res)
 	}
 
 	async searchInDocuments(
 		req: AppRequest<any, any, { query: string }>,
 		res: AppResponse,
 	) {
 		const { query } = req.body
-		const { result } = await searchInDocumentsUseCase.invoke({
-			query: query,
-			userId: req.user!.id,
-		})
 
-		return res.send({ success: true, data: result })
+		return safeApiCall(
+			() =>
+				searchInDocumentsUseCase.invoke({
+					query: query,
+					userId: req.user!.id,
+				}),
+			res,
+		)
 	}
 
 	async getChatHistory(req: AppRequest, res: AppResponse) {
 		const chatMemory = new ChatMemory(req.user!.id)
-		const history = await chatMemory.retrieveMemoryHistory()
-
-		return res.send({
-			success: true,
-			data: history,
-		})
+		return await safeApiCall(() => chatMemory.retrieveMemoryHistory(), res)
 	}
 }

src/modules/genai/application/routes/index.ts

@@ -2,6 +2,7 @@ import express from 'express'
 
 import {
 	isAuthenticated,
+	searchInDocumentsSchema,
 	translateTextSchema,
 	validateRequestBody,
 } from '@/common/middlewares'
@@ -37,9 +38,6 @@ const router = express.Router()
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: true
  *                 data:
  *                   type: string
  *                   example: "Hello!"
@@ -50,9 +48,6 @@ const router = express.Router()
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: false
  *                 error:
  *                   type: array
  *                   items:
@@ -97,9 +92,6 @@ router.post(
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: true
  *                 data:
  *                   type: string
  *                   example: The project aims to develop and validate a web platform (software) for automatically correcting assessments created in Microsoft Word.
@@ -114,6 +106,7 @@ router.post(
 router.post(
 	'/search-in-documents',
 	isAuthenticated,
+	validateRequestBody(searchInDocumentsSchema),
 	genAIController.searchInDocuments,
 )
 
@@ -132,9 +125,6 @@ router.post(
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: true
  *                 data:
  *                   type: array
  *                   items:

src/modules/resources/application/controllers/resources.controller.ts

@@ -1,3 +1,4 @@
+import { safeApiCall } from '@/common/functions'
 import { AppRequest, AppResponse } from '@/common/types'
 import { storeDocumentsUseCase } from '@/di'
 
@@ -17,7 +18,6 @@ export class ResourcesController {
 
 			if (!req.files || (req.files as Express.Multer.File[]).length === 0) {
 				return res.status(400).json({
-					success: false,
 					error: { message: 'Please provide at least one document!' },
 				})
 			}
@@ -33,10 +33,9 @@ export class ResourcesController {
 					} as UploadedDocument),
 			)
 
-			await storeDocumentsUseCase.invoke({ docs })
+			await safeApiCall(() => storeDocumentsUseCase.invoke({ docs }), res)
 
-			return res.status(201).json({
-				success: true,
+			return res.status(200).json({
 				data: { docs },
 			})
 		})

src/modules/resources/application/routes/index.ts

@@ -32,9 +32,6 @@ const router = express.Router()
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: true
  *                 data:
  *                   type: array
  *                   items:
@@ -59,9 +56,6 @@ const router = express.Router()
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: false
  *                 error:
  *                   type: object
  *                   properties:

src/modules/users/application/routes/index.ts

@@ -26,9 +26,6 @@ const router = express.Router()
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: true
  *                 data:
  *                   type: object
  *                   properties:
@@ -95,9 +92,6 @@ router.get('/', isAuthenticated, usersController.getUser)
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: true
  *                 data:
  *                   type: object
  *                   properties:
@@ -121,9 +115,6 @@ router.get('/', isAuthenticated, usersController.getUser)
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: false
  *                 error:
  *                   type: object
  *                   properties:
@@ -176,9 +167,6 @@ router.patch(
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: true
  *                 data:
  *                   type: array
  *                   items:
@@ -207,9 +195,6 @@ router.patch(
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: false
  *                 error:
  *                   type: object
  *                   properties:
@@ -243,9 +228,6 @@ router.patch(
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: true
  *                 data:
  *                   type: array
  *                   items:
@@ -305,9 +287,6 @@ router.get(
  *             schema:
  *               type: object
  *               properties:
- *                 success:
- *                   type: boolean
- *                   example: true
  *                 data:
  *                   type: array
  *                   items: