nhb-express/templates/prisma/src/app/utilities/sendResponse.ts

Minimal Express + TypeScript scaffolder with modular structure and flexible stack choices.

import type { TCollection, TMethod, TResponseDetails } from '@/types';
import type { Response } from 'express';
import { pluralizer } from 'nhb-toolbox';

/**
 * * Sends a formatted JSON response.
 *
 * @param res Response from Express.js from the specific controller.
 * @param collection The name of the collection (e.g., 'Student').
 * @param method The method type (e.g., 'POST', 'GET', 'PUT', 'PATCH', 'DELETE' etc.).
 * @param data Optional data to include in the response.
 * @param customMessage Optional custom message if needed.
 */
const sendResponse = <T>(
	res: Response,
	collection: TCollection,
	method: TMethod,
	data?: T,
	customMessage?: string
): void => {
	const { message, statusCode } = generateResponse(collection, method, data);

	const response = {
		success: true,
		message: customMessage ? customMessage : message,
		status: statusCode,
		...(data && { data }),
	};

	res.status(statusCode).json(response);
};

/**
 * * Generates message and status code based on the collection and method type.
 *
 * @param collection The name of the collection (e.g., 'Student').
 * @param method The method type (e.g., 'POST', 'GET', 'PUT', 'PATCH', 'DELETE' etc.).
 * @param data The data being operated upon.
 * @returns An object containing the formatted message and HTTP status code.
 */
const generateResponse = <T>(
	collection: TCollection,
	method: TMethod,
	data?: T
): TResponseDetails => {
	const isArray = Array.isArray(data);

	let message = 'Operation Successful!',
		statusCode = 200;

	switch (method) {
		case 'OK':
			statusCode = 200;
			break;
		case 'POST':
			statusCode = 201;
			message = `${collection} created successfully!`;
			break;
		case 'GET':
			message =
				isArray ?
					`${pluralizer.toPlural(collection)} fetched successfully!`
				:	`${collection} fetched successfully!`;
			break;
		case 'PUT':
		case 'PATCH':
			message = `${collection} updated successfully!`;
			break;
		case 'DELETE':
			message = `${collection} deleted successfully!`;
			break;
		default:
			break;
	}

	return { message, statusCode };
};

export default sendResponse;