express-toolkit 0.7.1 → 0.8.2

package/README.md

@@ -19,6 +19,7 @@ Tiny little utilities for reducing expressjs boilerplate code when building simp
   - [Default endpoints](#default-endpoints)
   - [Disable endpoints](#disable-endpoints)
   - [Sorting](#sorting)
+  - [Pagination](#pagination) 
   - [Projection](#projection)
   - [Custom primary key](#custom-primary-key)
   - [Hooks](#hooks)
@@ -237,6 +238,12 @@ For example, the following request would sort dinosaurs by age, oldest to younge
 ```http
 GET /dinosaurs?sortby=age&sortorder=DESC
 ```
+## Pagination
+GET endpoints support result pagination through `skip` and `limit` parameters:
+- `skip <Number>` tells the endpoint how many results to skip
+- `limit <Number` tells the endpoint how many results to include in the response
+
+To implement a pagination scheme, you can leverage these two parameters in the following way: Suppose you want to return `R` results per page and you want to return page number `P`, you just need to set limit to `R` and skip to `(P-1)*R`
 
 ## Projection
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-toolkit",
-  "version": "0.7.1",
+  "version": "0.8.2",
   "files": [
     "index.js",
     "src/"
@@ -16,7 +16,8 @@
     "test": "nyc --reporter=text ava test/*.spec.js --verbose",
     "test-ci": "npx nyc --reporter=lcov ava test/*.spec.js --verbose",
     "commit": "npx git-cz",
-    "pre-commit": "npm run lint && depcheck && npm run test",
+    "documentation": "docsify init ./docs",
+    "pre-commit": "npm run lint && npm run test",
     "changelog": "npx easy-changelog --out=./CHANGELOG.md",
     "release": "sh scripts/release.sh"
   },
@@ -34,24 +35,25 @@
     "express"
   ],
   "dependencies": {
-    "express": "^4.17.1",
+    "express": "^4.17.3",
     "json8-patch": "^1.0.4",
     "mongoose": "^5.12.3",
     "throwable-http-errors": "^2.1.0"
   },
   "devDependencies": {
-    "ava": "^3.8.1",
+    "ava": "^4.3.1",
     "body-parser": "^1.19.0",
-    "eslint": "^5.16.0",
-    "eslint-config-standard": "^12.0.0",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-node": "^8.0.1",
-    "eslint-plugin-promise": "^4.2.1",
+    "eslint": "^7.32.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.2.0",
     "eslint-plugin-standard": "^4.0.1",
     "husky": "^1.3.1",
-    "mongodb-memory-server": "^5.2.11",
-    "nyc": "^14.1.1",
+    "mongodb-memory-server": "^8.4.0",
+    "nyc": "^15.1.0",
     "sinon": "^7.5.0",
-    "supertest": "^4.0.2"
+    "supertest": "^4.0.2",
+    "uuid": "^8.3.2"
   }
 }

package/src/controller.js

@@ -20,11 +20,13 @@ class Controller {
    * @param {String} [config.id] The attribute to use as primary key for findById, updateById and deleteById. Defaults to _id.
    * @param {Number} [config.defaultSkipValue] The default skip value to be used in find() queries
    * @param {Number} [config.defaultLimitValue] The default skip value to be used in find() queries
+   * @param {Number} [config.useUpdateOne] If set to true, updateById method will use mongoose's Model.updateOne() instead of Document.save()
    */
   constructor (config) {
     this.Model = config.model
     this.id = config.id || '_id'
     this.name = config.name
+    this.useUpdateOne = Boolean(config.useUpdateOne) || false
     this.defaultSkipValue = config.defaultSkipValue || DEFAULT_SKIP_VALUE
     this.defaultLimitValue = config.defaultLimitValue || DEFAULT_LIMIT_VALUE
     this.__hooks = {}
@@ -37,10 +39,10 @@ class Controller {
   async find (query) {
     let skip = this.defaultSkipValue
     let limit = this.defaultLimitValue
-    if (query.hasOwnProperty('limit')) {
+    if (Object.prototype.hasOwnProperty.call(query, 'limit')) {
       limit = Number(query.limit)
     }
-    if (query.hasOwnProperty('skip')) {
+    if (Object.prototype.hasOwnProperty.call(query, 'skip')) {
       skip = Number(query.skip)
     }
 
@@ -180,7 +182,7 @@ class Controller {
     const instances = await this.Model.find(query)
 
     for (const instance of instances) {
-      for (var k in update) {
+      for (const k in update) {
         instance.set(k, update[k])
       }
 
@@ -207,7 +209,7 @@ class Controller {
       throw new Errors.NotFound()
     }
 
-    for (var k in update) {
+    for (const k in update) {
       instance.set(k, update[k])
     }
 
@@ -216,7 +218,13 @@ class Controller {
       throw new Errors.BadRequest(validationError.message)
     }
 
-    return instance.save()
+    if (this.useUpdateOne) {
+      await this.Model.updateOne({ [this.id]: id }, update)
+
+      return instance.toJSON()
+    } else {
+      return instance.save()
+    }
   }
 
   /**
@@ -233,7 +241,7 @@ class Controller {
       throw new Errors.NotFound()
     }
     // Primary identifiers cannot be replaced
-    replacement['_id'] = instance._id
+    replacement._id = instance._id
     replacement[this.id] = instance[this.id]
     instance.overwrite(replacement)
 

package/src/router.js

@@ -48,10 +48,12 @@ const defaultEndpoints = {
  * @param {Object} config
  * @param {Object} config.controller
  * @param {Object} [config.endpoints] Map<String,Boolean>
+ * @param {String} [config.id] The named route parameter to use as id. Defaults to "id"
  * @param {Object} [config.options] Express router options. As described in https://expressjs.com/en/api.html#express.router
  */
 function buildRouter (config) {
   config.options = config.options || {}
+  config.id = config.id || 'id'
   const router = express.Router(config.options)
   if (!(config.controller instanceof Controller)) {
     throw new Error('config.controller must be an instance of Controller')
@@ -64,7 +66,7 @@ function buildRouter (config) {
   const endpointsMap = Object.assign({}, defaultEndpoints, config.endpoints)
 
   const findByIdMiddleware = asyncMiddleware(async (req, res, next) => {
-    const resource = await config.controller.findById(req.params.id, req.query)
+    const resource = await config.controller.findById(req.params[config.id], req.query)
     req.toSend = resource
     return next()
   })
@@ -76,7 +78,7 @@ function buildRouter (config) {
   })
 
   const updateByIdMiddleware = asyncMiddleware(async (req, res, next) => {
-    const resource = await config.controller.updateById(req.params.id, req.body, req.query)
+    const resource = await config.controller.updateById(req.params[config.id], req.body, req.query)
     req.toSend = resource
     return next()
   })
@@ -88,7 +90,7 @@ function buildRouter (config) {
   })
 
   const deleteByIdMiddleware = asyncMiddleware(async (req, res, next) => {
-    await config.controller.deleteById(req.params.id)
+    await config.controller.deleteById(req.params[config.id])
     req.toSend = null
     return next()
   })
@@ -114,13 +116,13 @@ function buildRouter (config) {
   })
 
   const patchByIdMiddleware = asyncMiddleware(async (req, res, next) => {
-    const resource = await config.controller.patchById(req.params.id, req.body)
+    const resource = await config.controller.patchById(req.params[config.id], req.body)
     req.toSend = resource
     return next()
   })
 
   const replaceByIdMiddleware = asyncMiddleware(async (req, res, next) => {
-    const resource = await config.controller.replaceById(req.params.id, req.body)
+    const resource = await config.controller.replaceById(req.params[config.id], req.body)
     req.toSend = resource
     return next()
   })
@@ -138,7 +140,7 @@ function buildRouter (config) {
     },
     findById: {
       method: 'get',
-      path: '/:id',
+      path: `/:${config.id}`,
       middleware: findByIdMiddleware
     },
     create: {
@@ -148,7 +150,7 @@ function buildRouter (config) {
     },
     updateById: {
       method: 'put',
-      path: '/:id',
+      path: `/:${config.id}`,
       middleware: updateByIdMiddleware
     },
     updateByQuery: {
@@ -158,7 +160,7 @@ function buildRouter (config) {
     },
     deleteById: {
       method: 'delete',
-      path: '/:id',
+      path: `/:${config.id}`,
       middleware: deleteByIdMiddleware
     },
     deleteByQuery: {
@@ -168,12 +170,12 @@ function buildRouter (config) {
     },
     patchById: {
       method: 'patch',
-      path: '/:id',
+      path: `/:${config.id}`,
       middleware: patchByIdMiddleware
     },
     replaceById: {
       method: 'put',
-      path: '/:id/replace',
+      path: `/:${config.id}/replace`,
       middleware: replaceByIdMiddleware
     }