{"id":24300025,"url":"https://github.com/obaa10/mongoose-crud-helper","last_synced_at":"2026-04-07T08:01:52.779Z","repository":{"id":229420419,"uuid":"776699338","full_name":"Obaa10/mongoose-crud-helper","owner":"Obaa10","description":"Simplify CRUD operations for Mongoose models in Node.js Express with advanced features.","archived":false,"fork":false,"pushed_at":"2024-04-20T18:07:39.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-06T11:44:24.655Z","etag":null,"topics":["crud","express","javascript","mongoose","nodejs","nodejs-library","npm-package"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/express-mongoose-crud-helper","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Obaa10.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-24T08:27:01.000Z","updated_at":"2024-04-20T18:07:42.000Z","dependencies_parsed_at":"2024-04-03T13:31:11.492Z","dependency_job_id":"1c13b0bb-6c6f-4de4-bcbb-3a9b3a19daba","html_url":"https://github.com/Obaa10/mongoose-crud-helper","commit_stats":null,"previous_names":["obaa10/mongoose-crud-helper"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Obaa10%2Fmongoose-crud-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Obaa10%2Fmongoose-crud-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Obaa10%2Fmongoose-crud-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Obaa10%2Fmongoose-crud-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Obaa10","download_url":"https://codeload.github.com/Obaa10/mongoose-crud-helper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242206000,"owners_count":20089251,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crud","express","javascript","mongoose","nodejs","nodejs-library","npm-package"],"created_at":"2025-01-16T22:20:13.691Z","updated_at":"2026-04-07T08:01:52.773Z","avatar_url":"https://github.com/Obaa10.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Express Mongoose CRUD Helper\n\nThis package provides a convenient way to create CRUD (Create, Read, Update, Delete) routes for Mongoose models in Express.js applications.\n\n## Installation\n\n```bash\nnpm install em-crud\n```\n\n\n## Parameters\n\n- `className`: Mongoose model class.\n- `setMiddlewares`: Array of middleware functions to be executed before handling requests that modify data (POST, PUT, DELETE).\n- `getMiddlewares`: Array of middleware functions to be executed before handling GET requests.\n\n\n## Get All Features\n| Feature       | Description                                                                                                          |\n|---------------|----------------------------------------------------------------------------------------------------------------------|\n| Count         | Retrieve the total count of documents based on specified query criteria.                                             |\n| Sorting       | Sort the retrieved documents based on specified fields and order.                                                    |\n| Limit Fields  | Select specific fields to be included or excluded from the retrieved documents.                                      |\n| Pagination    | Enable paginated retrieval of documents, controlling the number of documents per page and navigating through pages. \u003cbr\u003e Use `page` and `limit` query parameters to control pagination. |\n| Population    | Populate referenced fields in the retrieved documents, enabling retrieval of associated data from other collections. |\n\n\n\n## Usage\n\n```javascript\nimport express from \"express\";\nimport CrudRouter from \"em-crud\";\nimport User from \"./models/User.js\"; // Import the Mongoose User model\n\nconst app = express();\n\n// Create middleware functions\nconst setMiddlewares = [];\nconst getMiddlewares = [];\n\n// Create a route to handle GET requests for users\napp.get(\"/api/users\", CrudRouter({ \n  className: User, \n  setMiddlewares, \n  getMiddlewares \n}));\n\napp.listen(3000, () =\u003e {\n  console.log(\"Server is running on port 3000\");\n});\n```\nin the recent example any one can add and delete users because we did't set and setMiddlewares.\nNow lets add some role for adding and deleting users.\n\n```javascript\n....\nimport AuthToken from \"./middleware/authentication.js\"; //Import our AuthToken middleware\nimport {admin} from \"./middleware/authorization.js\"; //Import admin authorization middleware\n\nconst setMiddlewares = [AuthToken,admin];\nconst getMiddlewares = [AuthToken];\n\n// Create a route to handle GET requests for users\napp.get(\"/api/users\", CrudRouter({ \n  className: User, \n  setMiddlewares, \n  getMiddlewares \n}));\n....\n```\nIn this case only admin can add and delete users.\nAnd all authorized users can use get by id and get all.\n\n### The new auto generated APIs\n#### Get One By Id\n```\nGET /api/users/:id\n```\n#### Create One\n```\nPOST /api/users/\nbody:{\n  full_name: \"admin\",\n  email: \"admin@gmail.com\n}\n```\n#### Update One\n```\nPUT /api/users/:id\nbody:{\n  full_name: \"admin\",\n  email: \"admin@gmail.com\n}\n```\n#### Delete One\n```\nDELETE /api/users/:id\n```\n#### Get All With Filters\n```\nGET /api/users\nquery: {\n  sort=-createdAt\n  page=1\n  limit=10\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobaa10%2Fmongoose-crud-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fobaa10%2Fmongoose-crud-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobaa10%2Fmongoose-crud-helper/lists"}