Dev

api/src/config/dev.config.ts

@@ -12,4 +12,4 @@ export const devConfig = {
   },
   LOG_FILE_PATH:
     process.platform === "win32" ? ".\\combine.log" : "./combine.log", // Replace with the actual path to your log file
-};
+};

api/src/config/index.ts

@@ -3,10 +3,16 @@ import path from "path";
 import { prodConfig } from "./prod.config.js";
 import { devConfig } from "./dev.config.js";
 
+/**
+ * Loads the environment variables from the .env file.
+ */
 dotenv.config({
   path: path.resolve(process.cwd(), `${process.env.NODE_ENV}.env`),
 });
 
+/**
+ * Configuration type for the application.
+ */
 export type ConfigType = {
   APP_TOKEN_EXP: string;
   APP_TOKEN_KEY: string;
@@ -28,6 +34,9 @@ export type ConfigType = {
   };
 };
 
+/**
+ * Configuration object for the application.
+ */
 export const config: ConfigType = {
   APP_TOKEN_EXP: "1d",
   PORT: process.env.PORT!,

api/src/controllers/auth.controller.ts

@@ -1,11 +1,23 @@
 import { Request, Response } from "express";
 import { authService } from "../services/auth.service.js";
 
+/**
+ * Handles the login request.
+ *
+ * @param req - The request object.
+ * @param res - The response object.
+ */
 const login = async (req: Request, res: Response) => {
   const resp = await authService.login(req);
   res.status(resp?.status).json(resp?.data);
 };
 
+/**
+ * Handles the request for sending an SMS.
+ *
+ * @param req - The request object.
+ * @param res - The response object.
+ */
 const RequestSms = async (req: Request, res: Response) => {
   const resp = await authService.requestSms(req);
   res.status(resp.status).json(resp.data);

api/src/controllers/migration.controller.ts

@@ -1,11 +1,25 @@
 import { Request, Response } from "express";
 import { migrationService } from "../services/migration.service.js";
 
+/**
+ * Creates a test stack.
+ *
+ * @param req - The request object.
+ * @param res - The response object.
+ * @returns A promise that resolves to void.
+ */
 const createTestStack = async (req: Request, res: Response): Promise<void> => {
   const resp = await migrationService.createTestStack(req);
   res.status(200).json(resp);
 };
 
+/**
+ * Deletes the test stack.
+ *
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @returns {Promise<void>} - A Promise that resolves when the stack is deleted.
+ */
 const deleteTestStack = async (req: Request, res: Response): Promise<void> => {
   const resp = await migrationService.deleteTestStack(req);
   res.status(200).json(resp);

api/src/controllers/org.controller.ts

@@ -1,21 +1,49 @@
 import { Request, Response } from "express";
 import { orgService } from "../services/org.service.js";
 
+/**
+ * Retrieves all stacks.
+ *
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @returns {Promise<void>} - A promise that resolves when the operation is complete.
+ */
 const getAllStacks = async (req: Request, res: Response) => {
   const resp = await orgService.getAllStacks(req);
   res.status(resp?.status).json(resp?.data);
 };
 
+/**
+ * Creates a stack.
+ *
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @returns {Promise<void>} - A promise that resolves when the stack is created.
+ */
 const createStack = async (req: Request, res: Response) => {
   const resp = await orgService.createStack(req);
   res.status(resp.status).json(resp.data);
 };
 
+/**
+ * Retrieves the locales for an organization.
+ *
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @returns {Promise<void>} - A promise that resolves when the locales are retrieved.
+ */
 const getLocales = async (req: Request, res: Response) => {
   const resp = await orgService.getLocales(req);
   res.status(resp.status).json(resp.data);
 };
 
+/**
+ * Retrieves the stack status.
+ *
+ * @param req - The request object.
+ * @param res - The response object.
+ * @returns A Promise that resolves to the stack status response.
+ */
 const getStackStatus = async (req: Request, res: Response) => {
   const resp = await orgService.getStackStatus(req);
   res.status(resp.status).json(resp.data);

api/src/controllers/projects.contentMapper.controller.ts

@@ -1,32 +1,74 @@
 import { Request, Response } from "express";
 import { contentMapperService } from "../services/contentMapper.service.js";
+/**
+ * Handles the PUT request to update test data.
+ *
+ * @param req - The request object.
+ * @param res - The response object.
+ * @returns A Promise that resolves to void.
+ */
 const putTestData = async (req: Request, res: Response): Promise<void> => {
   const resp = await contentMapperService.putTestData(req);
   res.status(200).json(resp);
 };
 
+/**
+ * Retrieves the content types from the content mapper service and sends the response as JSON.
+ *
+ * @param req - The Express request object.
+ * @param res - The Express response object.
+ * @returns A Promise that resolves to void.
+ */
 const getContentTypes = async (req: Request, res: Response): Promise<void> => {
   const resp = await contentMapperService.getContentTypes(req);
   res.status(200).json(resp);
 };
+/**
+ * Retrieves the field mapping for a given request and sends the response as JSON.
+ *
+ * @param req - The request object.
+ * @param res - The response object.
+ * @returns A Promise that resolves to void.
+ */
 const getFieldMapping = async (req: Request, res: Response): Promise<void> => {
   const resp = await contentMapperService.getFieldMapping(req);
   res.status(200).json(resp);
 };
+/**
+ * Retrieves the existing content types.
+ *
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @returns {Promise<void>} - A promise that resolves when the operation is complete.
+ */
 const getExistingContentTypes = async (
   req: Request,
   res: Response
 ): Promise<void> => {
   const resp = await contentMapperService.getExistingContentTypes(req);
   res.status(201).json(resp);
 };
+/**
+ * Updates the content type fields.
+ *
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @returns {Promise<void>} A promise that resolves when the content type fields are updated.
+ */
 const putContentTypeFields = async (
   req: Request,
   res: Response
 ): Promise<void> => {
   const resp = await contentMapperService.updateContentType(req);
   res.status(200).json(resp);
 };
+/**
+ * Resets the content type to its initial mapping.
+ *
+ * @param req - The request object.
+ * @param res - The response object.
+ * @returns A Promise that resolves to void.
+ */
 const resetContentType = async (req: Request, res: Response): Promise<void> => {
   const resp = await contentMapperService.resetToInitialMapping(req);
   res.status(200).json(resp);
@@ -37,11 +79,28 @@ const resetContentType = async (req: Request, res: Response): Promise<void> => {
 //   res.status(200).json(resp);
 // };
 
-const removeContentMapper = async (req: Request, res: Response): Promise<void> => {
+/**
+ * Removes a content mapper.
+ *
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @returns {Promise<void>} - A promise that resolves when the content mapper is removed.
+ */
+const removeContentMapper = async (
+  req: Request,
+  res: Response
+): Promise<void> => {
   const resp = await contentMapperService.removeContentMapper(req);
   res.status(200).json(resp);
-}
+};
 
+/**
+ * Retrieves single content types.
+ *
+ * @param req - The request object.
+ * @param res - The response object.
+ * @returns A Promise that resolves to void.
+ */
 const getSingleContentTypes = async (
   req: Request,
   res: Response
@@ -59,5 +118,5 @@ export const contentMapperController = {
   resetContentType,
   // removeMapping,
   getSingleContentTypes,
-  removeContentMapper
+  removeContentMapper,
 };