crud-api-express 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import { Request, Response, Router, NextFunction } from 'express';
+import { Document, Model } from 'mongoose';
+interface CrudOptions<T extends Document> {
+    middleware?: ((req: Request, res: Response, next: NextFunction) => void)[];
+    onSuccess?: (res: Response, method: string, result: T | T[]) => void;
+    onError?: (res: Response, method: string, error: Error) => void;
+    methods?: ('POST' | 'GET' | 'PUT' | 'DELETE')[];
+    relatedModel?: Model<any>;
+    relatedField?: string;
+    relatedMethods?: ('POST' | 'GET' | 'PUT' | 'DELETE')[];
+    aggregatePipeline?: object[];
+    customRoutes?: {
+        method: 'post' | 'get' | 'put' | 'delete';
+        path: string;
+        handler: (req: Request, res: Response) => void;
+    }[];
+}
+declare class CrudController<T extends Document> {
+    private model;
+    private endpoint;
+    private router;
+    constructor(model: Model<T>, endpoint: string, options?: CrudOptions<T>);
+    private configureRoutes;
+    getRouter(): Router;
+}
+export default CrudController;

package/dist/index.js

@@ -0,0 +1,183 @@
+import { Router } from 'express';
+
+class CrudController {
+    constructor(model, endpoint, options = {}) {
+        this.model = model;
+        this.endpoint = endpoint;
+        this.router = Router();
+        this.configureRoutes(options);
+    }
+    configureRoutes(options) {
+        const { middleware = [], onSuccess = (res, method, result) => res.status(200).send(result), onError = (res, method, error) => res.status(400).send(error), methods = ['POST', 'GET', 'PUT', 'DELETE'] } = options;
+        const applyMiddleware = (routeHandler) => {
+            return [...middleware, routeHandler];
+        };
+        // Create
+        if (methods.includes('POST')) {
+            this.router.post(`/${this.endpoint}`, applyMiddleware(async (req, res) => {
+                const method = 'POST';
+                try {
+                    const item = new this.model(req.body);
+                    const result = await item.save();
+                    if (options.relatedModel && options.relatedMethods?.includes('POST')) {
+                        await options.relatedModel.create({ [options.relatedField]: result._id, ...req.body });
+                    }
+                    onSuccess(res, method, result);
+                }
+                catch (error) {
+                    onError(res, method, error);
+                }
+            }));
+        }
+        if (methods.includes('GET')) {
+            this.router.get(`/${this.endpoint}`, applyMiddleware(async (req, res) => {
+                const method = 'GET';
+                try {
+                    const { filter, sort, page, limit } = req.query;
+                    const query = filter ? JSON.parse(filter) : {};
+                    const sortOrder = sort ? JSON.parse(sort) : {};
+                    const pageNumber = parseInt(page, 10) || 1;
+                    const pageSize = parseInt(limit, 10) || 10;
+                    const skip = (pageNumber - 1) * pageSize;
+                    let items;
+                    if (options.relatedModel && options.relatedMethods?.includes('GET')) {
+                        items = await this.model.aggregate([
+                            { $match: query },
+                            {
+                                $lookup: {
+                                    from: options.relatedModel.collection.name,
+                                    localField: options.relatedField,
+                                    foreignField: '_id',
+                                    as: 'relatedData'
+                                }
+                            },
+                            { $sort: sortOrder },
+                            { $skip: skip },
+                            { $limit: pageSize }
+                        ]);
+                    }
+                    else {
+                        items = await this.model.find(query).sort(sortOrder).skip(skip).limit(pageSize);
+                    }
+                    onSuccess(res, method, items);
+                }
+                catch (error) {
+                    onError(res, method, error);
+                }
+            }));
+        }
+        if (methods.includes('GET')) {
+            this.router.get(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+                const method = 'GET';
+                try {
+                    let item;
+                    if (options.relatedModel && options.relatedMethods?.includes('GET')) {
+                        const aggregateResult = await this.model.aggregate([
+                            { $match: { _id: req.params.id } },
+                            {
+                                $lookup: {
+                                    from: options.relatedModel.collection.name,
+                                    localField: options.relatedField,
+                                    foreignField: '_id',
+                                    as: 'relatedData'
+                                }
+                            }
+                        ]);
+                        item = aggregateResult[0];
+                    }
+                    else {
+                        item = await this.model.findById(req.params.id);
+                    }
+                    if (!item) {
+                        return res.status(404).send();
+                    }
+                    onSuccess(res, method, item);
+                }
+                catch (error) {
+                    onError(res, method, error);
+                }
+            }));
+        }
+        if (methods.includes('PUT')) {
+            this.router.put(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+                const method = 'PUT';
+                try {
+                    const item = await this.model.findByIdAndUpdate(req.params.id, req.body, { new: true, runValidators: true });
+                    if (!item) {
+                        return res.status(404).send();
+                    }
+                    if (options.relatedModel && options.relatedMethods?.includes('PUT')) {
+                        await options.relatedModel.updateMany({ [options.relatedField]: item._id }, req.body);
+                    }
+                    onSuccess(res, method, item);
+                }
+                catch (error) {
+                    onError(res, method, error);
+                }
+            }));
+        }
+        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) : {};
+                    const deleteResult = 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) {
+                    onError(res, method, error);
+                }
+            }));
+        }
+        if (methods.includes('DELETE')) {
+            this.router.delete(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+                const method = 'DELETE';
+                try {
+                    const item = await this.model.findByIdAndDelete(req.params.id);
+                    if (!item) {
+                        return res.status(404).send();
+                    }
+                    if (options.relatedModel && options.relatedMethods?.includes('DELETE')) {
+                        await options.relatedModel.deleteMany({ [options.relatedField]: item._id });
+                    }
+                    onSuccess(res, method, item);
+                }
+                catch (error) {
+                    onError(res, method, error);
+                }
+            }));
+        }
+        if (methods.includes('GET') && options.aggregatePipeline) {
+            this.router.get(`/${this.endpoint}/aggregate`, applyMiddleware(async (req, res) => {
+                const method = 'GET (Aggregate)';
+                try {
+                    const pipeline = options.aggregatePipeline ?? [];
+                    const results = await this.model.aggregate(pipeline);
+                    onSuccess(res, method, results);
+                }
+                catch (error) {
+                    onError(res, method, error);
+                }
+            }));
+        }
+        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));
+                }
+            });
+        }
+    }
+    getRouter() {
+        return this.router;
+    }
+}
+
+export { CrudController as default };

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAeA,MAAM,cAAc,CAAA;AAKlB,IAAA,WAAA,CAAY,KAAe,EAAE,QAAgB,EAAE,UAA0B,EAAE,EAAA;AACzE,QAAA,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;AACnB,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACzB,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;AACvB,QAAA,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;KAC/B;AAEO,IAAA,eAAe,CAAC,OAAuB,EAAA;AAC7C,QAAA,MAAM,EACJ,UAAU,GAAG,EAAE,EACf,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EACjE,OAAO,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,KAAK,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAC7D,OAAO,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,EAC3C,GAAG,OAAO,CAAC;AAGZ,QAAA,MAAM,eAAe,GAAG,CAAC,YAAmD,KAAI;AAC9E,YAAA,OAAO,CAAC,GAAG,UAAU,EAAE,YAAY,CAAC,CAAC;AACvC,SAAC,CAAC;;AAGF,QAAA,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC5B,YAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA,CAAA,EAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,eAAe,CAAC,OAAO,GAAG,EAAE,GAAG,KAAI;gBACvE,MAAM,MAAM,GAAG,MAAM,CAAC;AACtB,gBAAA,IAAI;oBACF,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACtC,oBAAA,MAAM,MAAM,GAAO,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;AACrC,oBAAA,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE;wBACpE,MAAM,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,YAAa,GAAG,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;qBACzF;AACD,oBAAA,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;iBAChC;gBAAC,OAAO,KAAS,EAAE;AAClB,oBAAA,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;iBAC7B;aACF,CAAC,CAAC,CAAC;SACL;AAGD,QAAA,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;AAC3B,YAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA,CAAA,EAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,eAAe,CAAC,OAAO,GAAG,EAAE,GAAG,KAAI;gBACtE,MAAM,MAAM,GAAG,KAAK,CAAC;AACrB,gBAAA,IAAI;AACF,oBAAA,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC;AAChD,oBAAA,MAAM,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAgB,CAAC,GAAG,EAAE,CAAC;AACzD,oBAAA,MAAM,SAAS,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAc,CAAC,GAAG,EAAE,CAAC;oBACzD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAc,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;oBACrD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAe,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;oBACrD,MAAM,IAAI,GAAG,CAAC,UAAU,GAAG,CAAC,IAAI,QAAQ,CAAC;AAEzC,oBAAA,IAAI,KAA6B,CAAC;AAClC,oBAAA,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE;AACnE,wBAAA,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;4BACjC,EAAE,MAAM,EAAE,KAAK,EAAE;AACjB,4BAAA;AACE,gCAAA,OAAO,EAAE;AACP,oCAAA,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI;oCAC1C,UAAU,EAAE,OAAO,CAAC,YAAa;AACjC,oCAAA,YAAY,EAAE,KAAK;AACnB,oCAAA,EAAE,EAAE,aAAa;AAClB,iCAAA;AACF,6BAAA;4BACD,EAAE,KAAK,EAAE,SAAS,EAAE;4BACpB,EAAE,KAAK,EAAE,IAAI,EAAE;4BACf,EAAE,MAAM,EAAE,QAAQ,EAAE;AACrB,yBAAA,CAAC,CAAC;qBACJ;yBAAM;wBACL,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;qBACjF;AACD,oBAAA,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;iBAC/B;gBAAC,OAAO,KAAS,EAAE;AAClB,oBAAA,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;iBAC7B;aACF,CAAC,CAAC,CAAC;SACL;AAED,QAAA,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;AAC3B,YAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA,CAAA,EAAI,IAAI,CAAC,QAAQ,MAAM,EAAE,eAAe,CAAC,OAAO,GAAG,EAAE,GAAG,KAAI;gBAC1E,MAAM,MAAM,GAAG,KAAK,CAAC;AACrB,gBAAA,IAAI;AACF,oBAAA,IAAI,IAAc,CAAC;AACnB,oBAAA,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE;wBACnE,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;4BACjD,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE;AAClC,4BAAA;AACE,gCAAA,OAAO,EAAE;AACP,oCAAA,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI;oCAC1C,UAAU,EAAE,OAAO,CAAC,YAAa;AACjC,oCAAA,YAAY,EAAE,KAAK;AACnB,oCAAA,EAAE,EAAE,aAAa;AAClB,iCAAA;AACF,6BAAA;AACF,yBAAA,CAAC,CAAC;AACH,wBAAA,IAAI,GAAG,eAAe,CAAC,CAAC,CAAM,CAAC;qBAChC;yBAAM;AACL,wBAAA,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;qBACjD;oBACD,IAAI,CAAC,IAAI,EAAE;wBACT,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;qBAC/B;AACD,oBAAA,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;iBAC9B;gBAAC,OAAO,KAAS,EAAE;AAClB,oBAAA,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;iBAC7B;aACF,CAAC,CAAC,CAAC;SACL;AAGD,QAAA,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;AAC3B,YAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA,CAAA,EAAI,IAAI,CAAC,QAAQ,MAAM,EAAE,eAAe,CAAC,OAAO,GAAG,EAAE,GAAG,KAAI;gBAC1E,MAAM,MAAM,GAAG,KAAK,CAAC;AACrB,gBAAA,IAAI;AACF,oBAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC7G,IAAI,CAAC,IAAI,EAAE;wBACT,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;qBAC/B;AACD,oBAAA,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE;wBACnE,MAAM,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,YAAa,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;qBACxF;AACD,oBAAA,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;iBAC9B;gBAAC,OAAO,KAAS,EAAE;AAClB,oBAAA,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;iBAC7B;aACF,CAAC,CAAC,CAAC;SACL;AAGL,QAAA,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;AAC9B,YAAA,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA,CAAA,EAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,eAAe,CAAC,OAAO,GAAG,EAAE,GAAG,KAAI;gBACzE,MAAM,MAAM,GAAG,QAAQ,CAAC;AACxB,gBAAA,IAAI;oBACF,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,MAAgB,CAAC,GAAG,EAAE,CAAC;oBAC7E,MAAM,YAAY,GAAO,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;AAC5D,oBAAA,IAAI,YAAY,CAAC,YAAY,KAAK,CAAC,EAAE;wBACnC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;qBAC/B;AACD,oBAAA,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE;wBACtE,MAAM,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,YAAa,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;qBACpF;AACD,oBAAA,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;iBACtC;gBAAC,OAAO,KAAU,EAAE;AACnB,oBAAA,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;iBAC7B;aACF,CAAC,CAAC,CAAC;SACL;AAIG,QAAA,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;AAC9B,YAAA,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA,CAAA,EAAI,IAAI,CAAC,QAAQ,MAAM,EAAE,eAAe,CAAC,OAAO,GAAG,EAAE,GAAG,KAAI;gBAC7E,MAAM,MAAM,GAAG,QAAQ,CAAC;AACxB,gBAAA,IAAI;AACF,oBAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBAC/D,IAAI,CAAC,IAAI,EAAE;wBACT,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;qBAC/B;AACD,oBAAA,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE;AACtE,wBAAA,MAAM,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,YAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;qBAC9E;AACD,oBAAA,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;iBAC9B;gBAAC,OAAO,KAAS,EAAE;AAClB,oBAAA,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;iBAC7B;aACF,CAAC,CAAC,CAAC;SACL;QAGD,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,iBAAiB,EAAE;AACxD,YAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA,CAAA,EAAI,IAAI,CAAC,QAAQ,YAAY,EAAE,eAAe,CAAC,OAAO,GAAG,EAAE,GAAG,KAAI;gBAChF,MAAM,MAAM,GAAG,iBAAiB,CAAC;AACjC,gBAAA,IAAI;AACF,oBAAA,MAAM,QAAQ,GAAO,OAAO,CAAC,iBAAiB,IAAI,EAAE,CAAC;oBACrD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AACrD,oBAAA,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;iBACjC;gBAAC,OAAO,KAAS,EAAE;AAClB,oBAAA,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;iBAC7B;aACF,CAAC,CAAC,CAAC;SACL;AAGD,QAAA,IAAI,OAAO,CAAC,YAAY,EAAE;AACxB,YAAA,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,IAAG;gBACnC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;gBACxC,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAuC,CAAC,EAAE;AAC/E,oBAAA,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAG,EAAA,IAAI,EAAE,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;iBAC3E;AACH,aAAC,CAAC,CAAC;SACJ;KACF;IAEM,SAAS,GAAA;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;KACpB;AACF;;;;"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "crud-api-express",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "npx rollup -c"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "express": "^4.19.2",
+    "mongoose": "^8.4.3",
+    "rollup": "^4.12.0",
+    "typescript": "^5.4.5"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/express": "^4.17.21",
+    "@types/mongoose": "^5.11.97",
+    "@types/react": "^18.3.3",
+    "tslib": "^2.6.2"
+  }
+}

package/readme.md

@@ -0,0 +1,91 @@
+# CRUD API Controller using Express and Mongoose
+
+npm install crud-api
+
+
+This project provides a flexible and reusable CRUD (Create, Read, Update, Delete) API controller for MongoDB using Express.js and Mongoose.
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage)
+- [API](#api)
+- [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:
+
+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:
+
+
+import express, { Request, Response } from 'express';
+import mongoose, { Document, Model } from 'mongoose';
+import CrudController, { CrudOptions } from 'crud-api';
+
+// Define your Mongoose schema and model
+interface ExampleModel extends Document {
+  name: string;
+  age: number;
+}
+
+const ExampleSchema = new mongoose.Schema<ExampleModel>({
+  name: { type: String, required: true },
+  age: { type: Number, required: true },
+});
+
+const ExampleModel = mongoose.model<ExampleModel>('Example', ExampleSchema);
+
+// Create an instance of CrudController
+const exampleController = new CrudController<ExampleModel>(ExampleModel, 'examples', {
+  // Optional configuration
+});
+
+// Create Express application
+const app = express();
+
+// Mount the CrudController router
+app.use('/api/examples', exampleController.getRouter());
+
+// Start the server
+const PORT = process.env.PORT || 3000;
+app.listen(PORT, () => {
+  console.log(`Server is running on port ${PORT}`);
+});
+
+
+# API
+
+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.
+
+CrudOptions<T>
+Configuration options for CrudController.
+
+# 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.

package/rollup.config.js

@@ -0,0 +1,16 @@
+import { defineConfig } from "rollup";
+import typescript from "@rollup/plugin-typescript";
+
+
+
+
+export default defineConfig({
+    input: 'src/index.ts',
+    output:{
+        dir:'dist',
+        format:'es',
+        name:"crud-api-express"
+    },
+    external:['express', 'mongoose'],
+    plugins:[typescript({tsconfig:'tsconfig.json'})]
+})

package/src/index.ts

@@ -0,0 +1,216 @@
+import  { Request, Response, Router, NextFunction } from 'express';
+import { Document, Model, Aggregate } from 'mongoose';
+
+interface CrudOptions<T extends Document> {
+  middleware?: ((req: Request, res: Response, next: NextFunction) => void)[];
+  onSuccess?: (res: Response, method: string, result: T | T[]) => void;
+  onError?: (res: Response, method: string, error: Error) => void;
+  methods?: ('POST' | 'GET' | 'PUT' | 'DELETE')[];
+  relatedModel?: Model<any>; 
+  relatedField?: string;
+  relatedMethods?: ('POST' | 'GET' | 'PUT' | 'DELETE')[];
+  aggregatePipeline?: object[]; 
+  customRoutes?: { method: 'post' | 'get' | 'put' | 'delete', path: string, handler: (req: Request, res: Response) => void }[];
+}
+
+class CrudController<T extends Document> {
+  private model: Model<T>;
+  private endpoint: string;
+  private router: Router;
+
+  constructor(model: Model<T>, endpoint: string, options: CrudOptions<T> = {}) {
+    this.model = model;
+    this.endpoint = endpoint;
+    this.router = Router();
+    this.configureRoutes(options);
+  }
+
+  private configureRoutes(options: CrudOptions<T>) {
+    const {
+      middleware = [],
+      onSuccess = (res, method, result) => res.status(200).send(result),
+      onError = (res, method, error) => res.status(400).send(error),
+      methods = ['POST', 'GET', 'PUT', 'DELETE']
+    } = options;
+
+
+    const applyMiddleware = (routeHandler: (req: Request, res: Response) => void) => {
+      return [...middleware, routeHandler];
+    };
+
+    // Create
+    if (methods.includes('POST')) {
+      this.router.post(`/${this.endpoint}`, applyMiddleware(async (req, res) => {
+        const method = 'POST';
+        try {
+          const item = new this.model(req.body);
+          const result:any = await item.save();
+          if (options.relatedModel && options.relatedMethods?.includes('POST')) {
+            await options.relatedModel.create({ [options.relatedField!]: result._id, ...req.body });
+          }
+          onSuccess(res, method, result);
+        } catch (error:any) {
+          onError(res, method, error);
+        }
+      }));
+    }
+
+ 
+    if (methods.includes('GET')) {
+      this.router.get(`/${this.endpoint}`, applyMiddleware(async (req, res) => {
+        const method = 'GET';
+        try {
+          const { filter, sort, page, limit } = req.query;
+          const query = filter ? JSON.parse(filter as string) : {};
+          const sortOrder = sort ? JSON.parse(sort as string) : {};
+          const pageNumber = parseInt(page as string, 10) || 1;
+          const pageSize = parseInt(limit as string, 10) || 10;
+          const skip = (pageNumber - 1) * pageSize;
+
+          let items: T[] | Aggregate<any[]>;
+          if (options.relatedModel && options.relatedMethods?.includes('GET')) {
+            items = await this.model.aggregate([
+              { $match: query },
+              {
+                $lookup: {
+                  from: options.relatedModel.collection.name,
+                  localField: options.relatedField!,
+                  foreignField: '_id',
+                  as: 'relatedData'
+                }
+              },
+              { $sort: sortOrder },
+              { $skip: skip },
+              { $limit: pageSize }
+            ]);
+          } else {
+            items = await this.model.find(query).sort(sortOrder).skip(skip).limit(pageSize);
+          }
+          onSuccess(res, method, items);
+        } catch (error:any) {
+          onError(res, method, error);
+        }
+      }));
+    }
+
+    if (methods.includes('GET')) {
+      this.router.get(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+        const method = 'GET';
+        try {
+          let item: T | null;
+          if (options.relatedModel && options.relatedMethods?.includes('GET')) {
+            const aggregateResult = await this.model.aggregate([
+              { $match: { _id: req.params.id } },
+              {
+                $lookup: {
+                  from: options.relatedModel.collection.name,
+                  localField: options.relatedField!,
+                  foreignField: '_id',
+                  as: 'relatedData'
+                }
+              }
+            ]);
+            item = aggregateResult[0] as T;
+          } else {
+            item = await this.model.findById(req.params.id);
+          }
+          if (!item) {
+            return res.status(404).send();
+          }
+          onSuccess(res, method, item);
+        } catch (error:any) {
+          onError(res, method, error);
+        }
+      }));
+    }
+
+
+    if (methods.includes('PUT')) {
+      this.router.put(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+        const method = 'PUT';
+        try {
+          const item = await this.model.findByIdAndUpdate(req.params.id, req.body, { new: true, runValidators: true });
+          if (!item) {
+            return res.status(404).send();
+          }
+          if (options.relatedModel && options.relatedMethods?.includes('PUT')) {
+            await options.relatedModel.updateMany({ [options.relatedField!]: item._id }, req.body);
+          }
+          onSuccess(res, method, item);
+        } catch (error:any) {
+          onError(res, method, error);
+        }
+      }));
+    }
+
+
+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);
+    }
+  }));
+}
+
+
+
+    if (methods.includes('DELETE')) {
+      this.router.delete(`/${this.endpoint}/:id`, applyMiddleware(async (req, res) => {
+        const method = 'DELETE';
+        try {
+          const item = await this.model.findByIdAndDelete(req.params.id);
+          if (!item) {
+            return res.status(404).send();
+          }
+          if (options.relatedModel && options.relatedMethods?.includes('DELETE')) {
+            await options.relatedModel.deleteMany({ [options.relatedField!]: item._id });
+          }
+          onSuccess(res, method, item);
+        } catch (error:any) {
+          onError(res, method, error);
+        }
+      }));
+    }
+
+
+    if (methods.includes('GET') && options.aggregatePipeline) {
+      this.router.get(`/${this.endpoint}/aggregate`, applyMiddleware(async (req, res) => {
+        const method = 'GET (Aggregate)';
+        try {
+          const pipeline:any = options.aggregatePipeline ?? [];
+          const results = await this.model.aggregate(pipeline);
+          onSuccess(res, method, results);
+        } catch (error:any) {
+          onError(res, method, error);
+        }
+      }));
+    }
+
+
+    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));
+        }
+      });
+    }
+  }
+
+  public getRouter(): Router {
+    return this.router;
+  }
+}
+
+export default CrudController;

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "module": "ESNext",
+        "moduleResolution": "node",
+        "outDir": "./dist",
+        "rootDir": "./src",
+        "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+        "declaration": true,
+        "sourceMap": true
+    },
+    "include": ["src/**/*"],
+    "exclude": ["node_modules", "dist"]
+}