[Tech debt] : helper/responses Added

src/constants/common.js

@@ -1,61 +1,16 @@
-const { elevateLog, correlationId } = require('elevate-logger')
-const logger = elevateLog.init()
 /**
  * name : constants/common.js
  * author : Aman Kumar Gupta
  * Date : 29-Sep-2021
  * Description : All commonly used constants through out the service
  */
 
-/**
- * Success response
- * @method
- * @name successResponse
- * @param  {String} statusCode status code of the response.
- * @param  {String} responseCode response code.
- * @param  {String} message response message.
- * @param {String} result - result
- * @returns {JSON} Returns response format
- */
-const successResponse = ({ statusCode = 200, responseCode = 'OK', message, result = [], meta = {} }) => {
-	let response = {
-		statusCode,
-		responseCode,
-		message,
-		result,
-		meta: { ...meta, correlation: correlationId.getId() },
-	}
-
-	logger.info('Request Response', { response: response })
-
-	return response
-}
-
-/**
- * failure response
- * @method
- * @name failureResponse
- * @param  {String} statusCode status code of the failure response.
- * @param  {String} responseCode response code.
- * @param  {String} message response message.
- * @param {String} result - result
- * @returns {JSON} Returns response error
- */
-const failureResponse = ({ message = 'Oops! Something Went Wrong.', statusCode = 500, responseCode }) => {
-	const error = new Error(message)
-	error.statusCode = statusCode
-	error.responseCode = responseCode
-	return error
-}
-
 module.exports = {
 	pagination: {
 		DEFAULT_PAGE_NO: 1,
 		DEFAULT_PAGE_SIZE: 100,
 	},
 	accessTokenSecret: 'hsghasghjab1273JHajnbabsjdj1273981273jhajksdh8y3123yhjkah812398yhjqwe7617237yuhdhhdqwu271',
 	refreshTokenSecret: '371hkjkjady2y3ihdkajshdkiq23iuekw71yekhaskdvkvegavy23t78veqwexqvxveit6ttxyeeytt62tx236vv',
-	successResponse,
-	failureResponse,
 	guestUrls: [],
 }

src/helpers/responses.js

@@ -0,0 +1,55 @@
+/**
+ * name : helpers/responses.js
+ * author : Vishnu
+ * Date : 31-Jan-2024
+ * Description : API response used in the service
+ */
+
+const { elevateLog, correlationId } = require('elevate-logger')
+const logger = elevateLog.init()
+
+/**
+ * Success response
+ * @method
+ * @name successResponse
+ * @param  {String} statusCode status code of the response.
+ * @param  {String} responseCode response code.
+ * @param  {String} message response message.
+ * @param {String} result - result
+ * @returns {JSON} Returns response format
+ */
+const successResponse = ({ statusCode = 200, responseCode = 'OK', message, result = [], meta = {} }) => {
+	let response = {
+		statusCode,
+		responseCode,
+		message,
+		result,
+		meta: { ...meta, correlation: correlationId.getId() },
+	}
+
+	logger.info('Request Response', { response: response })
+
+	return response
+}
+
+/**
+ * failure response
+ * @method
+ * @name failureResponse
+ * @param  {String} statusCode status code of the failure response.
+ * @param  {String} responseCode response code.
+ * @param  {String} message response message.
+ * @param {String} result - result
+ * @returns {JSON} Returns response error
+ */
+const failureResponse = ({ message = 'Oops! Something Went Wrong.', statusCode = 500, responseCode }) => {
+	const error = new Error(message)
+	error.statusCode = statusCode
+	error.responseCode = responseCode
+	return error
+}
+
+module.exports = {
+	successResponse,
+	failureResponse,
+}

src/middlewares/authenticator.js

@@ -6,7 +6,7 @@
  */
 const httpStatusCode = require('@generics/http-status')
 const apiResponses = require('@constants/api-responses')
-const common = require('@constants/common')
+const responses = require('@helpers/responses')
 
 module.exports = async function (req, res, next) {
 	try {
@@ -21,7 +21,7 @@ module.exports = async function (req, res, next) {
 			next()
 			return
 		} else {
-			throw common.failureResponse({
+			throw responses.failureResponse({
 				message: apiResponses.UNAUTHORIZED_REQUEST,
 				statusCode: httpStatusCode.unauthorized,
 				responseCode: 'UNAUTHORIZED',

src/package.json

@@ -65,6 +65,7 @@
 		"@middlewares": "middlewares",
 		"@public": "public",
 		"@routes": "routes",
-		"@services": "services"
+		"@services": "services",
+		"@helpers": "helpers"
 	}
 }

src/services/email.js

@@ -1,7 +1,7 @@
 const emailNotifications = require('@generics/helpers/email-notifications')
-const common = require('@constants/common')
 const httpStatusCode = require('@generics/http-status')
 const apiResponses = require('@constants/api-responses')
+const responses = require('@helpers/responses')
 
 module.exports = class EmailHelper {
 	/**
@@ -20,13 +20,13 @@ module.exports = class EmailHelper {
 		if (bodyData.type == 'email' && bodyData.email) {
 			let result = await emailNotifications.sendEmail(bodyData.email)
 			if (result && result.status == 'success') {
-				return common.successResponse({
+				return responses.successResponse({
 					statusCode: httpStatusCode.ok,
 					message: apiResponses.EMAIL_SENT_SUCCESSFULLY,
 					result,
 				})
 			} else {
-				return common.failureResponse({
+				return responses.failureResponse({
 					message: apiResponses.MAIL_SENT_FAILED,
 					statusCode: httpStatusCode.bad_request,
 					responseCode: 'CLIENT_ERROR',