Spaces:
Paused
Paused
File size: 4,344 Bytes
c904036 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | /**
* Standard API Response Utilities
* Provides consistent response format across all API endpoints
*
* Standard Response Format:
* {
* success: boolean,
* data: {} | null,
* error: string | null,
* message: string | null,
* meta?: { page, limit, total, totalPages } // For paginated responses
* }
*/
const { logger } = require('../Middleware/errorHandler');
/**
* Send a successful response
* @param {Object} res - Express response object
* @param {Object|Array} data - Response data
* @param {string} message - Success message
* @param {number} statusCode - HTTP status code (default: 200)
*/
function sendSuccess(res, data = null, message = null, statusCode = 200) {
return res.status(statusCode).json({
success: true,
data,
error: null,
message
});
}
/**
* Send a created response (201)
* @param {Object} res - Express response object
* @param {Object} data - Created resource data
* @param {string} message - Success message
*/
function sendCreated(res, data = null, message = 'Resource created successfully') {
return sendSuccess(res, data, message, 201);
}
/**
* Send an error response
* @param {Object} res - Express response object
* @param {string} error - Error message
* @param {number} statusCode - HTTP status code (default: 400)
* @param {Object} details - Additional error details (optional)
*/
function sendError(res, error, statusCode = 400, details = null) {
const response = {
success: false,
data: null,
error,
message: null
};
if (details && process.env.NODE_ENV !== 'production') {
response.details = details;
}
return res.status(statusCode).json(response);
}
/**
* Send a not found response (404)
* @param {Object} res - Express response object
* @param {string} resource - Name of the resource not found
*/
function sendNotFound(res, resource = 'Resource') {
return sendError(res, `${resource} not found`, 404);
}
/**
* Send an unauthorized response (401)
* @param {Object} res - Express response object
* @param {string} message - Error message
*/
function sendUnauthorized(res, message = 'Unauthorized access') {
return sendError(res, message, 401);
}
/**
* Send a forbidden response (403)
* @param {Object} res - Express response object
* @param {string} message - Error message
*/
function sendForbidden(res, message = 'Access forbidden') {
return sendError(res, message, 403);
}
/**
* Send a server error response (500)
* @param {Object} res - Express response object
* @param {Error} error - Error object (for logging)
* @param {string} message - User-facing error message
*/
function sendServerError(res, error = null, message = 'Internal server error') {
if (error) {
logger.error('Server error:', error);
}
return sendError(res, message, 500);
}
/**
* Send a paginated response
* @param {Object} res - Express response object
* @param {Array} data - Array of items
* @param {Object} pagination - Pagination info { page, limit, total }
* @param {string} message - Optional message
*/
function sendPaginated(res, data, pagination, message = null) {
const { page, limit, total } = pagination;
const totalPages = Math.ceil(total / limit);
return res.status(200).json({
success: true,
data,
error: null,
message,
meta: {
page: parseInt(page, 10),
limit: parseInt(limit, 10),
total,
totalPages,
hasNextPage: page < totalPages,
hasPrevPage: page > 1
}
});
}
/**
* Send a validation error response (422)
* @param {Object} res - Express response object
* @param {Array|string} errors - Validation errors
*/
function sendValidationError(res, errors) {
return res.status(422).json({
success: false,
data: null,
error: 'Validation failed',
message: null,
validationErrors: Array.isArray(errors) ? errors : [errors]
});
}
/**
* Wrap async route handlers to catch errors
* @param {Function} fn - Async route handler
* @returns {Function} Express middleware
*/
function asyncHandler(fn) {
return (req, res, next) => {
Promise.resolve(fn(req, res, next)).catch(next);
};
}
module.exports = {
sendSuccess,
sendCreated,
sendError,
sendNotFound,
sendUnauthorized,
sendForbidden,
sendServerError,
sendPaginated,
sendValidationError,
asyncHandler
};
|