crud-api-express 1.1.2 → 1.1.3

package/LICENSE

@@ -0,0 +1,9 @@
+ISC License
+
+Copyright (c) 2025 Mukesh Kumar Singh
+
+Permission to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is provided to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "crud-api-express",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "type": "module",
   "description": "",
   "main": "dist/index.js",

package/readme.md

@@ -1,66 +1,71 @@
 # CRUD API Controller using Express and Mongoose
 
-npm install crud-api-express
+![npm](https://img.shields.io/npm/v/crud-api-express)
+![downloads](https://img.shields.io/npm/dm/crud-api-express)
+
+## Installation
 
+Install the package using npm:
+
+```bash
+npm install crud-api-express
+```
 
 This project provides a flexible and reusable CRUD (Create, Read, Update, Delete) API controller for MongoDB using Express.js and Mongoose.
 
+## Support Me!
+
+For Your Support [Visit](https://buymeacoffee.com/mrider007).
+
 ## Table of Contents
 
 - [Introduction](#introduction)
 - [Installation](#installation)
 - [Usage](#usage)
 - [API](#api)
+- [Options](#options)
 - [Examples](#examples)
 - [Contributing](#contributing)
 - [License](#license)
 
 ## Introduction
 
-The `CrudController` class is designed to simplify the creation of RESTful APIs in Node.js applications that use MongoDB as the database backend. It abstracts away common CRUD operations, error handling, middleware integration, and supports custom routes and aggregation pipelines.
-
-## Installation
-
-To use `CrudController` in your Node.js project, follow these steps:
+The `CrudController` class simplifies the creation of RESTful APIs in Node.js applications using MongoDB. It abstracts away common CRUD operations, error handling, middleware integration, and supports custom routes and aggregation pipelines.
 
-1. **Install Node.js**: Make sure you have Node.js installed on your system.
-2. **Install Dependencies**: Navigate to your project directory and run:
-   ```bash
-   npm install express mongoose
+## Usage
 
+Here's a basic example of how to use `CrudController`:
 
-# Usage
-Here's a basic example of how to use CrudController:
-
+```javascript
 import express from 'express';
 import mongoose from 'mongoose';
 import CrudController from 'crud-api-express';
 
 const Schema = mongoose.Schema;
-const ExampleSchema = new Schema({
-  type: { type: String, default: 'Percentage', enum: ['Percentage', 'Flat'] },
-  status: { type: String, default: 'Active', trim: true },
-  expiry_date: { type: Date, index: true, trim: true },
-}, { timestamps: true, versionKey: false });
+const ExampleSchema = new Schema(
+  {
+    type: { type: String, default: 'Percentage', enum: ['Percentage', 'Flat'] },
+    status: { type: String, default: 'Active', trim: true },
+    expiry_date: { type: Date, index: true, trim: true },
+  },
+  { timestamps: true, versionKey: false }
+);
 
 const ExampleModel = mongoose.model('Example', ExampleSchema);
 
 const options = {
   middleware: [
     (req, res, next) => {
-      // Example: Authentication middleware
       const authToken = req.headers.authorization;
       if (!authToken) {
         return res.status(401).json({ message: 'Unauthorized' });
       }
-      // Verify token logic here
       next();
     },
     (req, res, next) => {
-      // Example: Logging middleware
       console.log(`Request received at ${new Date()}`);
       next();
-    }
+    },
   ],
   onSuccess: (res, method, result) => {
     console.log(`Successful ${method} operation:`, result);
@@ -71,11 +76,9 @@ const options = {
     res.status(500).json({ error: error.message });
   },
   methods: ['GET', 'POST', 'PUT', 'DELETE'],
-  relatedModel: RelatedModel,
-  relatedField: 'relatedId',
   aggregatePipeline: [
     { $match: { status: 'Active' } },
-    { $sort: { createdAt: -1 } }
+    { $sort: { createdAt: -1 } },
   ],
   customRoutes: [
     {
@@ -83,30 +86,29 @@ const options = {
       path: '/custom-route',
       handler: (req, res) => {
         res.json({ message: 'Custom route handler executed' });
-      }
+      },
     },
     {
       method: 'post',
       path: '/custom-action',
       handler: (req, res) => {
-        // Custom logic for handling POST request
         res.json({ message: 'Custom action executed' });
-      }
-    }
-  ]
+      },
+    },
+  ],
 };
 
 const exampleController = new CrudController(ExampleModel, 'examples', options);
 
 const mongoURI = 'mongodb://localhost:27017/mydatabase';
 
-mongoose.connect(mongoURI, { useNewUrlParser: true, useUnifiedTopology: true })
+mongoose
+  .connect(mongoURI, { useNewUrlParser: true, useUnifiedTopology: true })
   .then(() => {
     console.log('Connected to MongoDB');
 
     const app = express();
     app.use(express.json());
-
     app.use('/api', exampleController.getRouter());
 
     console.log(exampleController.getRoutes());
@@ -116,31 +118,35 @@ mongoose.connect(mongoURI, { useNewUrlParser: true, useUnifiedTopology: true })
       console.log(`Server is running on port ${PORT}`);
     });
   })
-  .catch(err => {
+  .catch((err) => {
     console.error('Error connecting to MongoDB:', err.message);
     process.exit(1);
   });
+```
+
+## API
+
+### Methods
 
+#### `getRouter(): Router`
+Returns the Express Router instance configured with CRUD routes.
 
+## Options
 
-# API
+### `CrudOptions<T>`
 
-model: Mongoose model for CRUD operations.
-endpoint: API endpoint path.
-options: Optional configuration for CRUD operations.
-Methods
-getRouter(): Router - Returns the Express Router instance configured with CRUD routes.
+| Option           | Type                                                                                       | Description                                           |
+|----------------|--------------------------------------------------------------------------------------------|-------------------------------------------------------|
+| `middleware`   | `((req: Request, res: Response, next: NextFunction) => void)[]`                            | Array of middleware functions                        |
+| `onSuccess`    | `(res: Response, method: string, result: T | T[]) => void`                                 | Success handler function                             |
+| `onError`      | `(res: Response, method: string, error: Error) => void`                                    | Error handler function                               |
+| `methods`      | `('POST' | 'GET' | 'PUT' | 'DELETE')[]`                                                     | Array of HTTP methods to support                    |
+| `relatedModel` | `Model<any>`                                                                                | Related Mongoose model for relational operations     |
+| `relatedField` | `string`                                                                                    | Field name for related models                        |
+| `relatedMethods` | `('POST' | 'GET' | 'PUT' | 'DELETE')[]`                                                   | Methods to apply on related models                   |
+| `aggregatePipeline` | `object[]`                                                                             | MongoDB aggregation pipeline stages                  |
+| `customRoutes` | `{ method: 'post' | 'get' | 'put' | 'delete', path: string, handler: (req, res) => void }[]` | Array of custom route definitions                    |
 
-CrudOptions<T>
-Configuration options for CrudController.
+## License
 
-# options
-middleware?: ((req: Request, res: Response, next: NextFunction) => void)[] - Array of middleware functions.
-onSuccess?: (res: Response, method: string, result: T | T[]) => void - Success handler function.
-onError?: (res: Response, method: string, error: Error) => void - Error handler function.
-methods?: ('POST' | 'GET' | 'PUT' | 'DELETE')[] - Array of HTTP methods to support.
-relatedModel?: Model<any> - Related Mongoose model for relational operations.
-relatedField?: string - Field name for related models.
-relatedMethods?: ('POST' | 'GET' | 'PUT' | 'DELETE')[] - Methods to apply on related models.
-aggregatePipeline?: object[] - MongoDB aggregation pipeline stages.
-customRoutes?: { method: 'post' | 'get' | 'put' | 'delete', path: string, handler: (req: Request, res: Response) => void }[] - Array of custom routes definitions.
+This project is licensed under the ISC License.