Custom Response Builder and Middleware Library

Overview

This project provides a suite of tools for building robust and customizable responses, rate limiting, source detection, and request validation in a Node.js environment using Express. The library is modular and can be used to enhance API response handling with features such as custom error responses, HTTP status code management, and more.

Table of Contents

• Installation
• Usage
  • Response Builder
  • Rate Limiter
  • Source Detector
  • Validators
  • HTTP Status Codes
• API Reference
  • Response Middleware
  • Rate Limit Middleware
  • Source Detector Middleware
• Contributing
• License

Installation

To install the library, use npm or yarn:

npm install @mindbowser_inc/middlewares-combined

or

yarn add @mindbowser_inc/middlewares-combined

Usage

Response Builder

The response builder is a customizable middleware that simplifies building HTTP responses in an Express application.

import { responseMiddleware } from 'your-library-name';

app.use(responseMiddleware);

You can use buildResponse in any route to construct your response:

app.get('/example', (req, res) => { res.buildResponse({ status: 200, data: { example: 'data' }, message: 'Success', }); });

Rate Limiter

The rate limiter middleware helps you manage and control the rate of incoming requests to your API.

import { rateLimiter } from 'your-library-name';

app.use(rateLimiter({ attempts: 5, timeWindow: 60000, // 1 minute coolOffPeriod: 300000, // 5 minutes }));

Source Detector

The source detector middleware restricts or allows access based on the source of the request.

import { sourceDetector } from 'your-library-name';

app.use(sourceDetector({ allowedSources: ['allowed-source'], restrictedSources: ['restricted-source'], }));

Validators

The validators provide a simple and flexible way to validate request parameters, query strings, and more.

import { valid, Schema, validator } from 'your-library-name';

const userSchema = new Schema({ name: valid.string().required(), age: valid.number().min(18), });

app.post('/user', validator(userSchema), (req, res) => { res.buildResponse({ data: req.body }); });

HTTP Status Codes

The library includes an enumeration of HTTP status codes and their corresponding messages.

import { HttpStatus, statusMessages } from 'your-library-name';

res.status(HttpStatus.OK).send(statusMessages[HttpStatus.OK]);

API Reference

Response Middleware

-responseMiddleware: Attaches the buildResponse method to the response object for custom response building.

Rate Limit Middleware

-rateLimitMiddleware: Limits the number of requests from a single IP address to prevent abuse.

Source Detector Middleware

-sourceDetector: Restricts or allows requests based on their source, using HTTP headers.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.