Merge pull request #10 from nemtsov/feature/pr_8

Fixes from qm3ster & NialBunting

.gitignore

@@ -1 +1,2 @@
 node_modules
+package-lock.json

README.md

@@ -1,17 +1,17 @@
 # Express Partial Response Middleware [![NPM version](https://badge.fury.io/js/express-partial-response.png)](http://badge.fury.io/js/express-partial-response)
 
 This Express Middleware will allow you to send a subset of a JSON object
-instead of an entire object from your HTTP services. To do so, your services
+instead of the entire object from your HTTP services. To do so, your services
 will begin accepting the `?fields=` query-string that, using a simple language,
-will specify which fields and sub-feelds to keep and which to ignore.
+will specify which fields and sub-fields to keep and which to ignore.
 
 If you've used the Google APIs, provided a `?fields=` query-string to get a
 [Partial Response](https://developers.google.com/+/api/#partial-responses),
 and wanted to do the same for your own server, now you can do so with this
 middleware.
 
-*Underneath, this middleware uses [json-mask](https://github.com/nemtsov/json-mask).
-Use it directly without this middleware if you need more flexibility.*
+_Underneath, this middleware uses [json-mask](https://github.com/nemtsov/json-mask).
+Use it directly without this middleware if you need more flexibility._
 
 # Installation
 
@@ -22,26 +22,29 @@ npm install express-partial-response
 # Usage
 
 ```js
-var express = require('express')
-  , partialResponse = require('express-partial-response')
-  , app = express()
+const express = require('express');
+const partialResponse = require('express-partial-response');
+const app = express();
 
-app.use(partialResponse())
+app.use(partialResponse());
 
-app.get('/', function (res, res, next) {
+app.get('/', (req, res) => {
   res.json({
-      firstName: 'Mohandas'
-    , lastName: 'Gandhi'
-    , aliases: [{
-          firstName: 'Mahatma'
-        , lastName: 'Gandhi'
-      }, {
-          firstName: 'Bapu'
-      }]
-  })
-})
-
-app.listen(4000)
+    firstName: 'Mohandas',
+    lastName: 'Gandhi',
+    aliases: [
+      {
+        firstName: 'Mahatma',
+        lastName: 'Gandhi'
+      },
+      {
+        firstName: 'Bapu'
+      }
+    ]
+  });
+});
+
+app.listen(4000);
 ```
 
 Let's test it:
@@ -70,9 +73,11 @@ Look at [json-mask](https://github.com/nemtsov/json-mask) for the available synt
 `query` specifies the query-string to use. Defaults to `fields`
 
 ```js
-app.use(partialResponse({
-  query: 'filter'
-}))
+app.use(
+  partialResponse({
+    query: 'filter'
+  })
+);
 ```
 
 # License

example/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "example",
+  "version": "1.0.0",
+  "main": "server.js",
+  "scripts": {
+    "start": "node server.js"
+  },
+  "dependencies": {
+    "express": "^4.17.1"
+  }
+}

example/server.js

@@ -1,26 +1,29 @@
-var express = require('express')
-  , partialResponse = require('../')
-  , app = express()
+const express = require('express');
+const partialResponse = require('../');
+const app = express();
 
-app.use(partialResponse())
+app.use(partialResponse());
 
-app.get('/', function (res, res, next) {
+app.get('/', (req, res) => {
   res.json({
-      firstName: 'Mohandas'
-    , lastName: 'Gandhi'
-    , aliases: [{
-          firstName: 'Mahatma'
-        , lastName: 'Gandhi'
-      }, {
-          firstName: 'Bapu'
-      }]
-  })
-})
+    firstName: 'Mohandas',
+    lastName: 'Gandhi',
+    aliases: [
+      {
+        firstName: 'Mahatma',
+        lastName: 'Gandhi'
+      },
+      {
+        firstName: 'Bapu'
+      }
+    ]
+  });
+});
 
-app.listen(4000, function () {
-  var prefix = 'curl \'http://localhost:4000?fields=%s\''
-  console.log('Server runnong on :4000, try the following:');
-  console.log(prefix, '*')
-  console.log(prefix, 'lastName')
-  console.log(prefix, 'firstName,aliases(firstName)')
-})
+app.listen(4000, () => {
+  const prefix = "curl 'http://localhost:4000?fields=%s'";
+  console.log('Server running on :4000, try the following:');
+  console.log(prefix, '*');
+  console.log(prefix, 'lastName');
+  console.log(prefix, 'firstName,aliases(firstName)');
+});

index.js

@@ -1,31 +1,38 @@
-var jsonMask = require('json-mask'),
-  compile = jsonMask.compile,
-  filter = jsonMask.filter;
+const jsonMask = require('json-mask');
 
-module.exports = function (opt) {
-  opt = opt || {};
+function isBadCode(statusCode) {
+  return statusCode < 200 || statusCode >= 300;
+}
 
-  function partialResponse(obj, fields) {
-    if (!fields) return obj;
-    return filter(obj, compile(fields));
-  }
+module.exports = function(options = {}) {
+  options = { query: 'fields', ...options };
+
+  function wrap(resJson) {
+    return function(obj) {
+      const fields = this.req.query[options.query];
+
+      // deprecated API that are still supported in v4
+      if (arguments.length > 1) {
+        // res.json(obj, status)
+        if ('number' === typeof arguments[1] && !isBadCode(arguments[1])) {
+          return resJson(jsonMask(obj, fields), arguments[1]);
+        }
 
-  function wrap(orig) {
-    return function (obj) {
-      var param = this.req.query[opt.query || 'fields'];
-      if (1 === arguments.length) {
-        orig(partialResponse(obj, param));
-      } else if (2 === arguments.length) {
-        if ('number' === typeof arguments[1]) {
-          orig(arguments[1], partialResponse(obj, param));
-        } else {
-          orig(obj, partialResponse(arguments[1], param));
+        // res.json(status, obj)
+        if ('number' === typeof obj && !isBadCode(obj)) {
+          return resJson(obj, jsonMask(arguments[1], fields));
         }
+
+        return resJson(...arguments);
       }
+
+      return isBadCode(this.statusCode)
+        ? resJson(...arguments)
+        : resJson(jsonMask(obj, fields));
     };
   }
 
-  return function (req, res, next) {
+  return function(req, res, next) {
     if (!res.__isJSONMaskWrapped) {
       res.json = wrap(res.json.bind(res));
       if (req.jsonp) res.jsonp = wrap(res.jsonp.bind(res));

package.json

@@ -2,8 +2,12 @@
   "name": "express-partial-response",
   "version": "0.3.4",
   "description": "Express middleware for filtering-out parts of JSON responses based on the `fields` query-string.",
+  "dependencies": {
+    "json-mask": "^0.3.9"
+  },
   "main": "index.js",
   "keywords": [
+    "express",
     "partial-response",
     "filter",
     "mask",
@@ -13,13 +17,26 @@
     "query",
     "json"
   ],
-  "dependencies": {
-    "json-mask": "0.3.8"
+  "engines": {
+    "node": ">=10"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "pretty-quick --staged"
+    }
+  },
+  "prettier": {
+    "singleQuote": true
   },
   "author": "nemtsov@gmail.com",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git://github.com/nemtsov/express-partial-response.git"
+  },
+  "devDependencies": {
+    "husky": "^3.1.0",
+    "prettier": "1.19.1",
+    "pretty-quick": "^2.0.1"
   }
 }