json-server 0.9.4 → 0.10.1

package/lib/server/public/style.css

@@ -0,0 +1,73 @@
+html {
+  font-size: 70%;
+}
+
+body {
+  display: flex;
+  min-height: 100vh;
+  flex-direction: column;
+  padding:0;
+  margin: 0;
+  color: #333;
+  letter-spacing: 0;
+}
+
+header {
+  padding-top: 2.0rem;
+  border-bottom: 1px solid #EEE;
+}
+
+header a, header a:hover {
+  text-decoration: none;
+}
+
+main {
+  flex: 1;
+}
+
+footer {
+  padding-top: 2.5rem;
+  border-top: 1px solid #EEE;
+}
+
+h4 {
+  margin-top: 4rem;
+}
+
+a {
+  color: #0275d8;
+}
+
+a:hover {
+  color: #014c8c;
+  text-decoration: underline;
+}
+
+table {
+  margin-left: 0;
+}
+
+td {
+  border: 0;
+  padding: 0 1em .5em 0;
+  color: #014c8c;
+}
+
+td:first-child {
+  width: 1%;
+  white-space: nowrap;
+}
+
+ul {
+  list-style-position: inside;
+  padding-left: 0;
+}
+
+li {
+  list-style-type: none;
+  margin-bottom: .2rem;
+}
+
+code {
+  border-radius: 0;
+}

package/lib/server/rewriter.js

@@ -9,6 +9,10 @@ function updateQueryString(target, sourceUrl) {
 module.exports = function (routes) {
   var router = express.Router();
 
+  router.get('/__rules', function (req, res) {
+    res.json(routes);
+  });
+
   Object.keys(routes).forEach(function (route) {
     if (route.indexOf(':') !== -1) {
       router.all(route, function (req, res, next) {

package/lib/server/router/get-full-url.js

@@ -0,0 +1,12 @@
+'use strict';
+
+var url = require('url');
+
+module.exports = function getFullURL(req) {
+  var root = url.format({
+    protocol: req.protocol,
+    host: req.get('host')
+  });
+
+  return `${root}${req.originalUrl}`;
+};

package/lib/server/router/index.js

@@ -1,13 +1,11 @@
 'use strict';
 
-var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
-
 var express = require('express');
 var methodOverride = require('method-override');
 var _ = require('lodash');
-var _db = require('underscore-db');
+var lodashId = require('lodash-id');
 var low = require('lowdb');
-var fileAsync = require('lowdb/lib/file-async');
+var fileAsync = require('lowdb/lib/storages/file-async');
 var bodyParser = require('../body-parser');
 var validateData = require('./validate-data');
 var plural = require('./plural');
@@ -34,8 +32,8 @@ module.exports = function (source) {
 
   validateData(db.getState());
 
-  // Add underscore-db methods to db
-  db._.mixin(_db);
+  // Add lodash-id methods to db
+  db._.mixin(lodashId);
 
   // Add specific mixins
   db._.mixin(mixins);
@@ -59,16 +57,16 @@ module.exports = function (source) {
   // Create routes
   db.forEach(function (value, key) {
     if (_.isPlainObject(value)) {
-      router.use('/' + key, singular(db, key));
+      router.use(`/${key}`, singular(db, key));
       return;
     }
 
     if (_.isArray(value)) {
-      router.use('/' + key, plural(db, key));
+      router.use(`/${key}`, plural(db, key));
       return;
     }
 
-    var msg = 'Type of "' + key + '" (' + (typeof value === 'undefined' ? 'undefined' : _typeof(value)) + ') ' + (_.isObject(source) ? '' : 'in ' + source) + ' is not supported. ' + 'Use objects or arrays of objects.';
+    var msg = `Type of "${key}" (${typeof value}) ` + (_.isObject(source) ? '' : `in ${source}`) + ' is not supported. ' + 'Use objects or arrays of objects.';
 
     throw new Error(msg);
   }).value();

package/lib/server/router/nested.js

@@ -9,16 +9,16 @@ module.exports = function () {
   // Rewrite URL (/:resource/:id/:nested -> /:nested) and request query
   function get(req, res, next) {
     var prop = pluralize.singular(req.params.resource);
-    req.query[prop + 'Id'] = req.params.id;
-    req.url = '/' + req.params.nested;
+    req.query[`${prop}Id`] = req.params.id;
+    req.url = `/${req.params.nested}`;
     next();
   }
 
   // Rewrite URL (/:resource/:id/:nested -> /:nested) and request body
   function post(req, res, next) {
     var prop = pluralize.singular(req.params.resource);
-    req.body[prop + 'Id'] = req.params.id;
-    req.url = '/' + req.params.nested;
+    req.body[`${prop}Id`] = req.params.id;
+    req.url = `/${req.params.nested}`;
     next();
   }
 

package/lib/server/router/plural.js

@@ -1,9 +1,10 @@
 'use strict';
 
-var url = require('url');
 var express = require('express');
 var _ = require('lodash');
 var pluralize = require('pluralize');
+var write = require('./write');
+var getFullURL = require('./get-full-url');
 var utils = require('../utils');
 
 module.exports = function (db, name) {
@@ -16,7 +17,7 @@ module.exports = function (db, name) {
       if (db.get(externalResource).value) {
         var query = {};
         var singularResource = pluralize.singular(name);
-        query[singularResource + 'Id'] = resource.id;
+        query[`${singularResource}Id`] = resource.id;
         resource[externalResource] = db.get(externalResource).filter(query).value();
       }
     });
@@ -27,21 +28,12 @@ module.exports = function (db, name) {
     e && [].concat(e).forEach(function (innerResource) {
       var plural = pluralize(innerResource);
       if (db.get(plural).value()) {
-        var prop = innerResource + 'Id';
+        var prop = `${innerResource}Id`;
         resource[innerResource] = db.get(plural).getById(resource[prop]).value();
       }
     });
   }
 
-  function getFullURL(req) {
-    var root = url.format({
-      protocol: req.protocol,
-      host: req.get('host')
-    });
-
-    return '' + root + req.originalUrl;
-  }
-
   // GET /name
   // GET /name?q=
   // GET /name?attr=&attr=
@@ -84,6 +76,10 @@ module.exports = function (db, name) {
 
     if (q) {
       // Full-text search
+      if (Array.isArray(q)) {
+        q = q[0];
+      }
+
       q = q.toLowerCase();
 
       chain = chain.filter(function (obj) {
@@ -100,52 +96,49 @@ module.exports = function (db, name) {
       // Don't take into account JSONP query parameters
       // jQuery adds a '_' query parameter too
       if (key !== 'callback' && key !== '_') {
-        (function () {
-          // Always use an array, in case req.query is an array
-          var arr = [].concat(req.query[key]);
-
-          chain = chain.filter(function (element) {
-            return arr.map(function (value) {
-              var isDifferent = /_ne$/.test(key);
-              var isRange = /_lte$/.test(key) || /_gte$/.test(key);
-              var isLike = /_like$/.test(key);
-              var path = key.replace(/(_lte|_gte|_ne|_like)$/, '');
-              var elementValue = _.get(element, path);
-
-              if (elementValue === undefined) {
-                return;
-              }
-
-              if (isRange) {
-                var isLowerThan = /_gte$/.test(key);
-
-                return isLowerThan ? value <= elementValue : value >= elementValue;
-              } else if (isDifferent) {
-                return value !== elementValue.toString();
-              } else if (isLike) {
-                return new RegExp(value, 'i').test(elementValue.toString());
-              } else {
-                return value === elementValue.toString();
-              }
-            }).reduce(function (a, b) {
-              return a || b;
-            });
+        // Always use an array, in case req.query is an array
+        var arr = [].concat(req.query[key]);
+
+        chain = chain.filter(function (element) {
+          return arr.map(function (value) {
+            var isDifferent = /_ne$/.test(key);
+            var isRange = /_lte$/.test(key) || /_gte$/.test(key);
+            var isLike = /_like$/.test(key);
+            var path = key.replace(/(_lte|_gte|_ne|_like)$/, '');
+            // get item value based on path
+            // i.e post.title -> 'foo'
+            var elementValue = _.get(element, path);
+
+            // Prevent toString() failing on undefined or null values
+            if (elementValue === undefined || elementValue === null) {
+              return;
+            }
+
+            if (isRange) {
+              var isLowerThan = /_gte$/.test(key);
+
+              return isLowerThan ? value <= elementValue : value >= elementValue;
+            } else if (isDifferent) {
+              return value !== elementValue.toString();
+            } else if (isLike) {
+              return new RegExp(value, 'i').test(elementValue.toString());
+            } else {
+              return value === elementValue.toString();
+            }
+          }).reduce(function (a, b) {
+            return a || b;
           });
-        })();
+        });
       }
     });
 
     // Sort
     if (_sort) {
-      _order = _order || 'ASC';
-
-      chain = chain.sortBy(function (element) {
-        return _.get(element, _sort);
+      var _sortSet = _sort.split(',');
+      var _orderSet = (_order || '').split(',').map(function (s) {
+        return s.toLowerCase();
       });
-
-      if (_order === 'DESC') {
-        chain = chain.reverse();
-      }
+      chain = chain.orderBy(_sortSet, _orderSet);
     }
 
     // Slice result
@@ -229,8 +222,12 @@ module.exports = function (db, name) {
   function create(req, res, next) {
     var resource = db.get(name).insert(req.body).value();
 
+    res.setHeader('Access-Control-Expose-Headers', 'Location');
+    res.location(`${getFullURL(req)}/${resource.id}`);
+
     res.status(201);
     res.locals.data = resource;
+
     next();
   }
 
@@ -269,9 +266,11 @@ module.exports = function (db, name) {
     next();
   }
 
-  router.route('/').get(list).post(create);
+  var w = write(db);
+
+  router.route('/').get(list).post(create, w);
 
-  router.route('/:id').get(show).put(update).patch(update).delete(destroy);
+  router.route('/:id').get(show).put(update, w).patch(update, w).delete(destroy, w);
 
   return router;
 };

package/lib/server/router/singular.js

@@ -1,6 +1,8 @@
 'use strict';
 
 var express = require('express');
+var write = require('./write');
+var getFullURL = require('./get-full-url');
 
 module.exports = function (db, name) {
   var router = express.Router();
@@ -13,6 +15,10 @@ module.exports = function (db, name) {
   function create(req, res, next) {
     db.set(name, req.body).value();
     res.locals.data = db.get(name).value();
+
+    res.setHeader('Access-Control-Expose-Headers', 'Location');
+    res.location(`${getFullURL(req)}`);
+
     res.status(201);
     next();
   }
@@ -28,7 +34,9 @@ module.exports = function (db, name) {
     next();
   }
 
-  router.route('/').get(show).post(create).put(update).patch(update);
+  var w = write(db);
+
+  router.route('/').get(show).post(create, w).put(update, w).patch(update, w);
 
   return router;
 };

package/lib/server/router/validate-data.js

@@ -1,12 +1,10 @@
 'use strict';
 
-var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
-
 var _ = require('lodash');
 
 function validateKey(key) {
   if (key.indexOf('/') !== -1) {
-    var msg = ['Oops, found / character in database property \'' + key + '\'.', '', '/ aren\'t supported, if you want to tweak default routes, see', 'https://github.com/typicode/json-server/tree/next#add-custom-routes'].join('\n');
+    var msg = [`Oops, found / character in database property '${key}'.`, '', '/ aren\'t supported, if you want to tweak default routes, see', 'https://github.com/typicode/json-server/#add-custom-routes'].join('\n');
     throw new Error(msg);
   }
 }
@@ -15,6 +13,6 @@ module.exports = function (obj) {
   if (_.isPlainObject(obj)) {
     Object.keys(obj).forEach(validateKey);
   } else {
-    throw new Error('Data must be an object. Found ' + (typeof obj === 'undefined' ? 'undefined' : _typeof(obj)) + '.' + 'See https://github.com/typicode/json-server for example.');
+    throw new Error(`Data must be an object. Found ${typeof obj}.` + 'See https://github.com/typicode/json-server for example.');
   }
 };

package/lib/server/router/write.js

@@ -0,0 +1,8 @@
+"use strict";
+
+module.exports = function write(db) {
+  return function (req, res, next) {
+    db.write();
+    next();
+  };
+};

package/lib/server/utils.js

@@ -1,7 +1,7 @@
 "use strict";
 
 module.exports = {
-  getPage: getPage
+  getPage
 };
 
 function getPage(array, page, perPage) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-server",
-  "version": "0.9.4",
+  "version": "0.10.1",
   "description": "Serves JSON files through REST routes.",
   "main": "./lib/server/index.js",
   "bin": "./bin/index.js",
@@ -17,7 +17,8 @@
     "express": "^4.9.5",
     "json-parse-helpfulerror": "^1.0.3",
     "lodash": "^4.11.2",
-    "lowdb": "^0.14.0",
+    "lodash-id": "^0.13.0",
+    "lowdb": "^0.15.0",
     "method-override": "^2.1.2",
     "morgan": "^1.3.1",
     "object-assign": "^4.0.1",
@@ -25,35 +26,35 @@
     "request": "^2.72.0",
     "server-destroy": "^1.0.1",
     "shortid": "^2.2.6",
-    "underscore-db": "^0.12.2",
     "update-notifier": "^1.0.2",
     "yargs": "^6.0.0"
   },
   "devDependencies": {
-    "babel-cli": "^6.10.1",
-    "babel-preset-es2015": "^6.16.0",
+    "babel-cli": "^6.24.0",
+    "babel-preset-env": "^1.3.2",
     "babel-register": "^6.16.3",
     "cross-env": "^2.0.1",
-    "husky": "^0.11.4",
+    "husky": "^0.13.0",
     "markdown-toc": "^0.13.0",
     "mkdirp": "^0.5.1",
-    "mocha": "^3.1.2",
+    "mocha": "^3.2.0",
     "os-tmpdir": "^1.0.1",
+    "pkg-ok": "^1.0.1",
     "rimraf": "^2.5.2",
     "server-ready": "^0.3.1",
     "standard": "^8.3.0",
-    "supertest": "^2.0.0",
+    "supertest": "^3.0.0",
     "temp-write": "^2.1.0"
   },
   "scripts": {
-    "test": "npm run test:cli && npm run test:server && standard --fix",
+    "test": "npm run test:cli && npm run test:server && standard",
     "test:cli": "npm run build && cross-env NODE_ENV=test mocha test/cli/*.js",
     "test:server": "cross-env NODE_ENV=test mocha test/server/*.js",
-    "start": "node bin",
-    "prepush": "npm t",
+    "start": "babel-node src/cli/bin",
+    "precommit": "npm test",
     "build": "babel src -d lib --copy-files",
     "toc": "markdown-toc -i README.md",
-    "prepublish": "npm run build"
+    "prepublish": "npm run build && pkg-ok"
   },
   "repository": {
     "type": "git",
@@ -88,6 +89,6 @@
     }
   },
   "engines": {
-    "node": ">= 0.12"
+    "node": ">= 4"
   }
 }

package/routes.json

@@ -0,0 +1,5 @@
+{
+  "/api/": "/",
+  "/blog/:resource/:id/show": "/:resource/:id",
+  "/blog/:category": "/posts?category=:category"
+}

package/test/mocha.opts

@@ -1,3 +1,3 @@
---compilers js:babel-register
+--require babel-register
 --reporter spec
---timeout 5000
+--timeout 5000

package/test/server/mixins.js

@@ -1,13 +1,13 @@
 const assert = require('assert')
 const _ = require('lodash')
-const _db = require('underscore-db')
+const lodashId = require('lodash-id')
 const mixins = require('../../src/server/mixins')
 
 describe('mixins', () => {
   let db
 
   before(() => {
-    _.mixin(_db)
+    _.mixin(lodashId)
     _.mixin(mixins)
   })