crud-api-express 1.0.3 → 1.0.5

package/dist/index.d.ts

@@ -44,8 +44,14 @@ declare class CrudController<T extends Document> {
     private model;
     private endpoint;
     private router;
+    private routes;
     constructor(model: Model<T>, endpoint: string, options?: CrudOptions<T>);
     private configureRoutes;
     getRouter(): Router;
+    getRoutes(): {
+        method: string;
+        path: string;
+        params?: string[];
+    }[];
 }
 export default CrudController;

package/dist/index.js

@@ -5,6 +5,7 @@ class CrudController {
         this.model = model;
         this.endpoint = endpoint;
         this.router = Router();
+        this.routes = [];
         this.configureRoutes(options);
     }
     configureRoutes(options) {
@@ -12,13 +13,17 @@ class CrudController {
         const applyMiddleware = (routeHandler) => {
             return [...middleware, routeHandler];
         };
+        // Helper to register a route
+        const registerRoute = (method, path, params) => {
+            this.routes.push({ method, path, params });
+        };
         // Create
         if (methods.includes('POST')) {
-            this.router.post(`/${this.endpoint}`, applyMiddleware(async (req, res) => {
+            const path = `/${this.endpoint}`;
+            this.router.post(path, applyMiddleware(async (req, res) => {
                 const method = 'POST';
                 try {
-                    const item = new this.model(req.body);
-                    const result = await item.save();
+                    const result = await this.model.create(req.body);
                     if (options.relatedModel && options.relatedMethods?.includes('POST')) {
                         await options.relatedModel.create({ [options.relatedField]: result._id, ...req.body });
                     }
@@ -28,9 +33,12 @@ class CrudController {
                     onError(res, method, error);
                 }
             }));
+            registerRoute('POST', path);
         }
+        // Read all
         if (methods.includes('GET')) {
-            this.router.get(`/${this.endpoint}`, applyMiddleware(async (req, res) => {
+            const path = `/${this.endpoint}`;
+            this.router.get(path, applyMiddleware(async (req, res) => {
                 const method = 'GET';
                 try {
                     const { filter, sort, page, limit } = req.query;
@@ -65,9 +73,12 @@ class CrudController {
                     onError(res, method, error);
                 }
             }));
+            registerRoute('GET', path, ['filter', 'sort', 'page', 'limit']);
         }
+        // Read one
         if (methods.includes('GET')) {
-            this.router.get(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+            const path = `/${this.endpoint}/:id`;
+            this.router.get(path, applyMiddleware(async (req, res) => {
                 const method = 'GET';
                 try {
                     let item;
@@ -97,9 +108,12 @@ class CrudController {
                     onError(res, method, error);
                 }
             }));
+            registerRoute('GET', path, ['id']);
         }
+        // Update
         if (methods.includes('PUT')) {
-            this.router.put(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+            const path = `/${this.endpoint}/:id`;
+            this.router.put(path, applyMiddleware(async (req, res) => {
                 const method = 'PUT';
                 try {
                     const item = await this.model.findByIdAndUpdate(req.params.id, req.body, { new: true, runValidators: true });
@@ -115,9 +129,12 @@ class CrudController {
                     onError(res, method, error);
                 }
             }));
+            registerRoute('PUT', path, ['id']);
         }
+        // Delete multiple
         if (methods.includes('DELETE')) {
-            this.router.delete(`/${this.endpoint}`, applyMiddleware(async (req, res) => {
+            const path = `/${this.endpoint}`;
+            this.router.delete(path, applyMiddleware(async (req, res) => {
                 const method = 'DELETE';
                 try {
                     const query = req.query.filter ? JSON.parse(req.query.filter) : {};
@@ -134,9 +151,12 @@ class CrudController {
                     onError(res, method, error);
                 }
             }));
+            registerRoute('DELETE', path, ['filter']);
         }
+        // Delete one
         if (methods.includes('DELETE')) {
-            this.router.delete(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+            const path = `/${this.endpoint}/:id`;
+            this.router.delete(path, applyMiddleware(async (req, res) => {
                 const method = 'DELETE';
                 try {
                     const item = await this.model.findByIdAndDelete(req.params.id);
@@ -152,9 +172,12 @@ class CrudController {
                     onError(res, method, error);
                 }
             }));
+            registerRoute('DELETE', path, ['id']);
         }
+        // Aggregate
         if (methods.includes('GET') && options.aggregatePipeline) {
-            this.router.get(`/${this.endpoint}/aggregate`, applyMiddleware(async (req, res) => {
+            const path = `/${this.endpoint}/aggregate`;
+            this.router.get(path, applyMiddleware(async (req, res) => {
                 const method = 'GET (Aggregate)';
                 try {
                     const pipeline = options.aggregatePipeline ?? [];
@@ -165,12 +188,15 @@ class CrudController {
                     onError(res, method, error);
                 }
             }));
+            registerRoute('GET', path);
         }
+        // Custom routes
         if (options.customRoutes) {
             options.customRoutes.forEach(route => {
                 const { method, path, handler } = route;
                 if (methods.includes(method.toUpperCase())) {
                     this.router[method](`/${this.endpoint}${path}`, applyMiddleware(handler));
+                    registerRoute(method.toUpperCase(), `/${this.endpoint}${path}`);
                 }
             });
         }
@@ -178,6 +204,9 @@ class CrudController {
     getRouter() {
         return this.router;
     }
+    getRoutes() {
+        return this.routes;
+    }
 }
 
 export { CrudController as default };

package/package.json

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

package/readme.md

@@ -54,7 +54,7 @@ const exampleController = new CrudController(ExampleModel, 'examples', {
 });
 
 
-const mongoURI = 'mongodb+srv://mukesh:Umgtr1NgoQXcRccg@cluster0.zgxjwge.mongodb.net/test';
+const mongoURI = 'mdhd';
 
 
 mongoose.connect(mongoURI, { useNewUrlParser: false, useUnifiedTopology: false })
@@ -66,6 +66,7 @@ mongoose.connect(mongoURI, { useNewUrlParser: false, useUnifiedTopology: false }
     app.use(express.json());
 
     app.use('/api', exampleController.getRouter());
+    console.log(exampleController.getRoutes());
 
     const PORT = process.env.PORT || 3000;
     app.listen(PORT, () => {

package/src/index.ts

@@ -1,4 +1,4 @@
-import  { Request, Response, Router, NextFunction } from 'express';
+import { Request, Response, Router, NextFunction } from 'express';
 import { Document, Model, Aggregate } from 'mongoose';
 
 interface CrudOptions<T extends Document> {
@@ -17,11 +17,13 @@ class CrudController<T extends Document> {
   private model: Model<T>;
   private endpoint: string;
   private router: Router;
+  private routes: { method: string, path: string, params?: string[] }[];
 
   constructor(model: Model<T>, endpoint: string, options: CrudOptions<T> = {}) {
     this.model = model;
     this.endpoint = endpoint;
     this.router = Router();
+    this.routes = [];
     this.configureRoutes(options);
   }
 
@@ -33,18 +35,22 @@ class CrudController<T extends Document> {
       methods = ['POST', 'GET', 'PUT', 'DELETE']
     } = options;
 
-
     const applyMiddleware = (routeHandler: (req: Request, res: Response) => void) => {
       return [...middleware, routeHandler];
     };
 
+    // Helper to register a route
+    const registerRoute = (method: string, path: string, params?: string[]) => {
+      this.routes.push({ method, path, params });
+    };
+
     // Create
     if (methods.includes('POST')) {
-      this.router.post(`/${this.endpoint}`, applyMiddleware(async (req, res) => {
+      const path = `/${this.endpoint}`;
+      this.router.post(path, applyMiddleware(async (req, res) => {
         const method = 'POST';
         try {
-          const item = new this.model(req.body);
-          const result:any = await item.save();
+          const result:any = await this.model.create(req.body);
           if (options.relatedModel && options.relatedMethods?.includes('POST')) {
             await options.relatedModel.create({ [options.relatedField!]: result._id, ...req.body });
           }
@@ -53,11 +59,13 @@ class CrudController<T extends Document> {
           onError(res, method, error);
         }
       }));
+      registerRoute('POST', path);
     }
 
- 
+    // Read all
     if (methods.includes('GET')) {
-      this.router.get(`/${this.endpoint}`, applyMiddleware(async (req, res) => {
+      const path = `/${this.endpoint}`;
+      this.router.get(path, applyMiddleware(async (req, res) => {
         const method = 'GET';
         try {
           const { filter, sort, page, limit } = req.query;
@@ -91,10 +99,13 @@ class CrudController<T extends Document> {
           onError(res, method, error);
         }
       }));
+      registerRoute('GET', path, ['filter', 'sort', 'page', 'limit']);
     }
 
+    // Read one
     if (methods.includes('GET')) {
-      this.router.get(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+      const path = `/${this.endpoint}/:id`;
+      this.router.get(path, applyMiddleware(async (req, res) => {
         const method = 'GET';
         try {
           let item: T | null;
@@ -122,11 +133,13 @@ class CrudController<T extends Document> {
           onError(res, method, error);
         }
       }));
+      registerRoute('GET', path, ['id']);
     }
 
-
+    // Update
     if (methods.includes('PUT')) {
-      this.router.put(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+      const path = `/${this.endpoint}/:id`;
+      this.router.put(path, applyMiddleware(async (req, res) => {
         const method = 'PUT';
         try {
           const item = await this.model.findByIdAndUpdate(req.params.id, req.body, { new: true, runValidators: true });
@@ -141,32 +154,35 @@ class CrudController<T extends Document> {
           onError(res, method, error);
         }
       }));
+      registerRoute('PUT', path, ['id']);
     }
 
-
-if (methods.includes('DELETE')) {
-  this.router.delete(`/${this.endpoint}`, applyMiddleware(async (req, res) => {
-    const method = 'DELETE';
-    try {
-      const query = req.query.filter ? JSON.parse(req.query.filter as string) : {};
-      const deleteResult:any = await this.model.deleteMany(query);
-      if (deleteResult.deletedCount === 0) {
-        return res.status(404).send();
-      }
-      if (options.relatedModel && options.relatedMethods?.includes('DELETE')) {
-        await options.relatedModel.deleteMany({ [options.relatedField!]: { $in: query } });
-      }
-      onSuccess(res, method, deleteResult);
-    } catch (error: any) {
-      onError(res, method, error);
+    // Delete multiple
+    if (methods.includes('DELETE')) {
+      const path = `/${this.endpoint}`;
+      this.router.delete(path, applyMiddleware(async (req, res) => {
+        const method = 'DELETE';
+        try {
+          const query = req.query.filter ? JSON.parse(req.query.filter as string) : {};
+          const deleteResult:any = await this.model.deleteMany(query);
+          if (deleteResult.deletedCount === 0) {
+            return res.status(404).send();
+          }
+          if (options.relatedModel && options.relatedMethods?.includes('DELETE')) {
+            await options.relatedModel.deleteMany({ [options.relatedField!]: { $in: query } });
+          }
+          onSuccess(res, method, deleteResult);
+        } catch (error: any) {
+          onError(res, method, error);
+        }
+      }));
+      registerRoute('DELETE', path, ['filter']);
     }
-  }));
-}
-
-
 
+    // Delete one
     if (methods.includes('DELETE')) {
-      this.router.delete(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+      const path = `/${this.endpoint}/:id`;
+      this.router.delete(path, applyMiddleware(async (req, res) => {
         const method = 'DELETE';
         try {
           const item = await this.model.findByIdAndDelete(req.params.id);
@@ -181,11 +197,13 @@ if (methods.includes('DELETE')) {
           onError(res, method, error);
         }
       }));
+      registerRoute('DELETE', path, ['id']);
     }
 
-
+    // Aggregate
     if (methods.includes('GET') && options.aggregatePipeline) {
-      this.router.get(`/${this.endpoint}/aggregate`, applyMiddleware(async (req, res) => {
+      const path = `/${this.endpoint}/aggregate`;
+      this.router.get(path, applyMiddleware(async (req, res) => {
         const method = 'GET (Aggregate)';
         try {
           const pipeline:any = options.aggregatePipeline ?? [];
@@ -195,14 +213,16 @@ if (methods.includes('DELETE')) {
           onError(res, method, error);
         }
       }));
+      registerRoute('GET', path);
     }
 
-
+    // Custom routes
     if (options.customRoutes) {
       options.customRoutes.forEach(route => {
         const { method, path, handler } = route;
         if (methods.includes(method.toUpperCase() as 'POST' | 'GET' | 'PUT' | 'DELETE')) {
           this.router[method](`/${this.endpoint}${path}`, applyMiddleware(handler));
+          registerRoute(method.toUpperCase(), `/${this.endpoint}${path}`);
         }
       });
     }
@@ -211,6 +231,10 @@ if (methods.includes('DELETE')) {
   public getRouter(): Router {
     return this.router;
   }
+
+  public getRoutes(): { method: string, path: string, params?: string[] }[] {
+    return this.routes;
+  }
 }
 
 export default CrudController;