crud-api-express 1.1.6 → 1.1.8

package/package.json

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

package/readme.md

@@ -41,7 +41,7 @@ The `CrudController` class simplifies the creation of RESTful APIs in Node.js ap
 
 ## 🔧 Usage
 
-Here's a basic example of how to use `CrudController`:
+Here's a basic example of how to use in Es module `CrudController`:
 
 ```javascript
 import express from 'express';
@@ -109,6 +109,95 @@ const exampleController = new CrudController(ExampleModel, 'examples', options);
 
 const mongoURI = 'mongodb://localhost:27017/mydatabase';
 
+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());
+
+    const PORT = process.env.PORT || 3000;
+    app.listen(PORT, () => {
+      console.log(`Server is running on port ${PORT}`);
+    });
+  })
+  .catch((err) => {
+    console.error('Error connecting to MongoDB:', err.message);
+    process.exit(1);
+  });
+```
+Here's a basic example of how to use in cjs module `CrudController`:
+```javascript
+
+const express = require('express');
+const mongoose = require('mongoose');
+const CrudController = require('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 ExampleModel = mongoose.model('Example', ExampleSchema);
+
+const options = {
+  middleware: [
+    (req, res, next) => {
+      const authToken = req.headers.authorization;
+      if (!authToken) {
+        return res.status(401).json({ message: 'Unauthorized' });
+      }
+      next();
+    },
+    (req, res, next) => {
+      console.log(`Request received at ${new Date()}`);
+      next();
+    },
+  ],
+  onSuccess: (res, method, result) => {
+    console.log(`Successful ${method} operation:`, result);
+    res.status(200).json({ success: true, data: result });
+  },
+  onError: (res, method, error) => {
+    console.error(`Error in ${method} operation:`, error);
+    res.status(500).json({ error: error.message });
+  },
+  methods: ['GET', 'POST', 'PUT', 'DELETE'],
+  aggregatePipeline: [
+    { $match: { status: 'Active' } },
+    { $sort: { createdAt: -1 } },
+  ],
+  customRoutes: [
+    {
+      method: 'get',
+      path: '/custom-route',
+      handler: (req, res) => {
+        res.json({ message: 'Custom route handler executed' });
+      },
+    },
+    {
+      method: 'post',
+      path: '/custom-action',
+      handler: (req, res) => {
+        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 })
   .then(() => {
@@ -151,6 +240,7 @@ Returns the Express Router instance configured with CRUD routes.
   { "method": "POST", "path": "/examples/custom-action", "params": null }
 ]
 ```
+
 ## ⚙️ Options
 
 
@@ -170,6 +260,18 @@ Returns the Express Router instance configured with CRUD routes.
 
 ---
 
+## 📖 Fetch All Records with Query Params (GET)
+
+**🛠️ URL:**  
+`GET http://localhost:3000/api/examples?filter={"status":"Active"}&sort={"expiry_date":1}&page=1&limit=10`
+
+### 🔍 Query Params Explanation:
+- **`filter`** → Filter results (e.g., `{ "status": "Active" }`).
+- **`sort`** → Sort order (e.g., `{ "expiry_date": 1 }` for ascending).
+- **`page`** → Pagination (e.g., `page=1`).
+- **`limit`** → Number of results per page.
+
+
 ## 📜 License
 
 This project is licensed under the **ISC License**.