vanta-api 1.0.2 → 1.0.4

package/README.md

@@ -10,7 +10,7 @@ This repository provides a robust, feature-rich, and secure solution for buildin
 
 1. [Installation & Setup](#installation--setup)
 2. [Overview](#overview)
-3. [VantaApi Class Methods](#VantaApi-class-methods)
+3. [ApiFeatures Class Methods](#ApiFeatures-class-methods)
    - [filter()](#filter)
    - [sort()](#sort)
    - [limitFields()](#limitfields)
@@ -54,7 +54,7 @@ npm install --save-dev jest
 
 ## Overview
 
-The **VantaApi** class processes incoming query parameters and progressively builds an aggregation pipeline. The package supports:
+The **ApiFeatures** class processes incoming query parameters and progressively builds an aggregation pipeline. The package supports:
 
 - **Advanced filtering, sorting, and field selection.**
 - **Pagination with defaults** (defaults to page 1 and limit 10 if not provided), with the maximum limit based on the user's role.
@@ -67,7 +67,7 @@ The **VantaApi** class processes incoming query parameters and progressively bui
 
 ---
 
-## VantaApi Class Methods
+## ApiFeatures Class Methods
 
 ### filter()
 - **Description:**  
@@ -76,7 +76,7 @@ The **VantaApi** class processes incoming query parameters and progressively bui
 
   ```javascript
   // URL: /api/products?status=active&price[gte]=100
-  const features = new VantaApi(Product, req.query);
+  const features = new ApiFeatures(Product, req.query);
   features.filter();
   // Pipeline adds: { $match: { status: "active", price: { $gte: 100 }, isActive: true } }
   ```
@@ -88,7 +88,7 @@ The **VantaApi** class processes incoming query parameters and progressively bui
 
   ```javascript
   // URL: /api/products?sort=-price,createdAt
-  const features = new VantaApi(Product, req.query);
+  const features = new ApiFeatures(Product, req.query);
   features.sort();
   // Pipeline adds: { $sort: { price: -1, createdAt: 1 } }
   ```
@@ -100,7 +100,7 @@ The **VantaApi** class processes incoming query parameters and progressively bui
 
   ```javascript
   // URL: /api/products?fields=name,price,category,password
-  const features = new VantaApi(Product, req.query);
+  const features = new ApiFeatures(Product, req.query);
   features.limitFields();
   // Pipeline adds: { $project: { name: 1, price: 1, category: 1 } }
   ```
@@ -112,7 +112,7 @@ The **VantaApi** class processes incoming query parameters and progressively bui
 
   ```javascript
   // URL: /api/products?page=2&limit=20
-  const features = new VantaApi(Product, req.query, "user");
+  const features = new ApiFeatures(Product, req.query, "user");
   features.paginate();
   // Pipeline adds: { $skip: 20 } and { $limit: 20 }
   ```
@@ -128,7 +128,7 @@ The **VantaApi** class processes incoming query parameters and progressively bui
 
     ```javascript
     // URL: /api/products?populate=category,brand
-    const features = new VantaApi(Product, req.query);
+    const features = new ApiFeatures(Product, req.query);
     features.populate();
     ```
 
@@ -136,7 +136,7 @@ The **VantaApi** class processes incoming query parameters and progressively bui
 
     ```javascript
     const populateOptions = { path: "category", select: "name description" };
-    const features = new VantaApi(Product, req.query);
+    const features = new ApiFeatures(Product, req.query);
     features.populate(populateOptions);
     ```
 
@@ -148,7 +148,7 @@ The **VantaApi** class processes incoming query parameters and progressively bui
       { path: "category", select: "name description" },
       { path: "category", select: "name", populate: { path: "subCategory", select: "title" } }
     ];
-    const features = new VantaApi(Product, req.query, "admin");
+    const features = new ApiFeatures(Product, req.query, "admin");
     features.populate(populateArray);
     ```
 
@@ -159,7 +159,7 @@ The **VantaApi** class processes incoming query parameters and progressively bui
 
   ```javascript
   const manualFilter = { category: "electronics" };
-  const features = new VantaApi(Product, { status: "active" });
+  const features = new ApiFeatures(Product, { status: "active" });
   features.addManualFilters(manualFilter).filter();
   ```
 
@@ -169,7 +169,7 @@ The **VantaApi** class processes incoming query parameters and progressively bui
 - **Usage Example:**
 
   ```javascript
-  const features = new VantaApi(Product, req.query);
+  const features = new ApiFeatures(Product, req.query);
   const result = await features
     .filter()
     .sort()
@@ -258,29 +258,77 @@ These configurations are applied automatically in methods such as `filter()`, `p
 
 ## Error Handling Middleware
 
-A dedicated error-handling middleware is available to centralize error responses:
+Vanta-API provides a centralized error handling system featuring three components:
+
+### 1. handleError
+
+**Purpose:**  
+A custom error class that extends the native JavaScript `Error`.  
+It adds:
+- **`statusCode`:** HTTP status code.
+- **`status`:** Determines if the error is a `"fail"` (client error) or `"error"` (server error).
+- **`isOperational`:** Flags if the error is an expected operational error.
+- **Stack Trace:** Captures the call stack for easier debugging.
+
+**Usage Example in an Async Function:**
+
+Inside an asynchronous function wrapped by **catchAsync**, you can use:
+
+```javascript
+// Inside your async route handler
+if (someConditionFails) {
+  return next(new handleError("Custom error message", 400));
+}
+```
+
+### 2. catchAsync
+
+**Purpose:**  
+A helper function that wraps asynchronous route handlers.  
+It automatically catches any thrown errors and forwards them via `next()`, avoiding repetitive try/catch blocks.
+
+**Usage Example:**
 
 ```javascript
-import catchError from "./errorHandler.js";
+app.get("/example", catchAsync(async (req, res, next) => {
+  // Your async logic here
+  // If an error occurs, use handleError as shown above
+  res.status(200).json({ data: "Success" });
+}));
+```
+
+### 3. catchError
+
+**Purpose:**  
+An Express middleware that catches any error passed along (either from synchronous or asynchronous routes).  
+It sets the appropriate HTTP status and returns a JSON response containing the error’s status and message.
+
+**Usage Example:**
 
-// In your Express app:
-// app.use(catchError);
+```javascript
+// At the end of your middleware stack:
+app.use(catchError);
 ```
 
-This middleware sets the appropriate HTTP status code and JSON error message when an error occurs.
+---
+
 
 ---
 
 ## Full Examples
 
 ### Example 1: Basic Query
+To import the package along with the error handling components, use:
+
+```javascript
+import ApiFeatures, { handleError, catchAsync, catchError } from "vanta-api";
+```
 
 ```javascript
-import VantaApi from "./api-features.js";
 import Product from "./models/product.js";
 
 // URL: /api/products?status=active&price[gte]=100&sort=-price,createdAt&fields=name,price,category&page=1&limit=10&populate=category,brand
-const features = new VantaApi(Product, req.query, "user");
+const features = new ApiFeatures(Product, req.query, "user");
 const result = await features
   .filter()
   .sort()
@@ -298,7 +346,7 @@ console.log(result);
 ```javascript
 const query = { status: "active" };
 const manualFilter = { category: "electronics" };
-const features = new VantaApi(Product, query, "user");
+const features = new ApiFeatures(Product, query, "user");
 features.addManualFilters(manualFilter).filter();
 const result = await features.execute();
 console.log(result);
@@ -312,7 +360,7 @@ const populateArray = [
   { path: "category", select: "name description" },
   { path: "category", select: "name", populate: { path: "subCategory", select: "title" } }
 ];
-const features = new VantaApi(Product, req.query, "admin");
+const features = new ApiFeatures(Product, req.query, "admin");
 const result = await features.populate(populateArray).execute();
 console.log(result);
 ```
@@ -335,7 +383,7 @@ GET /api/products?
 
 ```javascript
 // URL: /api/products?status=active
-const features = new VantaApi(Product, req.query);
+const features = new ApiFeatures(Product, req.query);
 const result = await features
   .filter() // Defaults to page 1 and limit 10
   .execute();
@@ -362,9 +410,30 @@ console.log(result);
   Integrated advanced logging using winston and centralized error handling with a custom error class and middleware.
 - **Performance Optimizations:**  
   Supports aggregation cursor for large datasets and optimizes aggregation pipelines for efficient resource usage.
+  
+- **ApiFeatures:**  
+  Provides advanced query capabilities such as filtering, sorting, pagination, and document population for your MongoDB data.
+
+- **Error Handling Components:**
+  - **handleError:**  
+    Throw consistent, structured errors with custom messages and status codes.
+  - **catchAsync:**  
+    Wrap asynchronous route handlers to automatically propagate errors.
+  - **catchError:**  
+    Centralized middleware to catch and respond to errors uniformly.
+
+- **Importing:**  
+  Use the following statement to access all features:
+
+  ```javascript
+  import ApiFeatures, { handleError, catchAsync, catchError } from "vanta-api";
+  ```
+
+By following these guidelines, you can integrate and use Vanta-API for advanced, secure query handling and robust error management in your Node.js/Express projects.
 
 ---
 
 VantaApi provides a complete solution for integrating powerful, secure, and customizable query capabilities into any Node.js/MongoDB project.
 
----
+---
+

package/index.js

@@ -0,0 +1,6 @@
+import ApiFeatures from "./src/api-features.js";
+import catchError from "./src/errorHandler.js";
+import HandleERROR from "./src/handleError.js";
+import catchAsync from "./src/catchAsync.js";
+export {catchError,HandleERROR,catchAsync}
+export default ApiFeatures

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "vanta-api",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Advanced API features and security configuration for Node.js/MongoDB.",
-  "main": "src/api-features.js",
+  "main": "index.js",
   "scripts": {
     "postinstall": "node bin/create-security-config.js",
     "test": "jest",
-    "start": "node src/api-features.js"
+    "start": "node index.js"
   },
   "keywords": [
     "api",

package/src/api-features.js

@@ -303,4 +303,4 @@ export class ApiFeatures {
   }
 }
 
-export default ApiFeatures;
+export default ApiFeatures;

package/src/catchAsync.js

@@ -0,0 +1,6 @@
+ export const catchAsync=fn=>{
+    return (req,res,next)=>{
+        fn(req,res,next).catch(next)
+    }
+}
+export default catchAsync