json-server 0.9.4 → 0.10.1

package/.babelrc

@@ -1,5 +1,10 @@
 {
   "presets": [
-    ["es2015", { "loose": true }]
+    ["env", {
+      "targets": {
+        "node": 4
+      },
+      "exclude": ["transform-regenerator"]
+    }]
   ]
 }

package/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: node_js
 node_js:
   - "stable"
-#  - "0.12"
+  - "4"

package/CHANGELOG.md

@@ -1,9 +1,29 @@
 # Change Log
 
+## [0.10.1][2017-05-16] `GET /posts?_sort=user,views&_order=desc,asc`
+
+* Multiple fields sorting
+
+## [0.10.0][2017-04-26]
+
+* __Drop Node `v0.12` support__
+* Prevent `TypeError` when a filter is applied on a `null` value [#510](https://github.com/typicode/json-server/issues/510)
+
+## [0.9.6][2017-03-08]
+
+* Update index page
+* Improve performances ([lowdb](https://github.com/typicode/lowdb) `v0.15`)
+* Add `Location` header to newly created resources [#473](https://github.com/typicode/json-server/pull/473)
+
+## [0.9.5][2017-02-11]
+
+* Display custom routes on homepage
+* Fix duplicate query params error [#352](https://github.com/typicode/json-server/issues/352)
+
 ## [0.9.4][2016-12-08]
 
 * Improve rewriter [#431](https://github.com/typicode/json-server/issues/431)
-* Improve watch mode [#427](https://github.com/typicode/json-server/pull/427) 
+* Improve watch mode [#427](https://github.com/typicode/json-server/pull/427)
 
 ## [0.9.3][2016-12-07]
 
@@ -30,7 +50,7 @@
   * [#363](https://github.com/typicode/json-server/issues/363) [#365](https://github.com/typicode/json-server/issues/365)
   * [#374](https://github.com/typicode/json-server/issues/374)
   * [#383](https://github.com/typicode/json-server/issues/383)
-* Updated dependencies and codebase to ES6 
+* Updated dependencies and codebase to ES6
 
 ## [0.8.23][2016-11-03]
 

package/README.md

@@ -8,8 +8,9 @@ Created with <3 for front-end developers who need a quick back-end for prototypi
 * [JSONPlaceholder - Live running version](http://jsonplaceholder.typicode.com)
 
 See also:
-* :hotel: [hotel - Start apps from your browser and get local dev domains in seconds](https://github.com/typicode/hotel)
 * :dog: [husky - Git hooks made easy](https://github.com/typicode/husky)
+* :camera: [tlapse - Create a timelapse of your web development](https://github.com/typicode/tlapse)
+* :hotel: [hotel - Process manager for developers with local .dev domain out of the box](https://github.com/typicode/hotel)
 
 ## Table of contents
 
@@ -153,8 +154,14 @@ _10 items are returned by default_
 Add `_sort` and `_order` (ascending order by default)
 
 ```
-GET /posts?_sort=views&_order=DESC
-GET /posts/1/comments?_sort=votes&_order=ASC
+GET /posts?_sort=views&_order=asc
+GET /posts/1/comments?_sort=votes&_order=asc
+```
+
+For multiple fields, use the following format:
+
+```
+GET /posts?_sort=user,views&_order=desc,asc
 ```
 
 ### Slice
@@ -167,6 +174,8 @@ GET /posts/1/comments?_start=20&_end=30
 GET /posts/1/comments?_start=20&_limit=10
 ```
 
+_Works exactly as [Array.slice](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/slice) (i.e. `_start` is inclusive and `_end` exclusive)_
+
 ### Operators
 
 Add `_gte` or `_lte` for getting a range
@@ -276,11 +285,11 @@ Using JS instead of a JSON file, you can create data programmatically.
 
 ```javascript
 // index.js
-module.exports = function() {
-  var data = { users: [] }
+module.exports = () => {
+  const data = { users: [] }
   // Create 1000 users
-  for (var i = 0; i < 1000; i++) {
-    data.users.push({ id: i, name: 'user' + i })
+  for (let i = 0; i < 1000; i++) {
+    data.users.push({ id: i, name: `user${i}` })
   }
   return data
 }
@@ -304,7 +313,7 @@ Create a `routes.json` file. Pay attention to start every route with `/`.
 {
   "/api/": "/",
   "/blog/:resource/:id/show": "/:resource/:id",
-  "/blog/:category": "/posts/:id?category=:category"
+  "/blog/:category": "/posts?category=:category"
 }
 ```
 
@@ -329,7 +338,7 @@ You can add your middlewares from the CLI using `--middlewares` option:
 
 ```js
 // hello.js
-module.exports = function (req, res, next) {
+module.exports = (req, res, next) => {
   res.header('X-Hello', 'World')
   next()
 }
@@ -385,16 +394,20 @@ If you need to add authentication, validation, or __any behavior__, you can use
 
 #### Simple example
 
+```sh
+$ npm install json-server --save-dev
+```
+
 ```js
 // server.js
-var jsonServer = require('json-server')
-var server = jsonServer.create()
-var router = jsonServer.router('db.json')
-var middlewares = jsonServer.defaults()
+const jsonServer = require('json-server')
+const server = jsonServer.create()
+const router = jsonServer.router('db.json')
+const middlewares = jsonServer.defaults()
 
 server.use(middlewares)
 server.use(router)
-server.listen(3000, function () {
+server.listen(3000, () => {
   console.log('JSON Server is running')
 })
 ```
@@ -406,8 +419,8 @@ $ node server.js
 The path you provide to the `jsonServer.router` function  is relative to the directory from where you launch your node process. If you run the above code from another directory, it’s better to use an absolute path:
 
 ```js
-var path = require('path')
-var router = jsonServer.router(path.join(__dirname, 'db.json'))
+const path = require('path')
+const router = jsonServer.router(path.join(__dirname, 'db.json'))
 ```
 
 For an in-memory database, simply pass an object to `jsonServer.router()`.
@@ -419,23 +432,23 @@ Please note also that `jsonServer.router()` can be used in existing Express proj
 Let's say you want a route that echoes query parameters and another one that set a timestamp on every resource created.
 
 ```js
-var jsonServer = require('json-server')
-var server = jsonServer.create()
-var router = jsonServer.router('db.json')
-var middlewares = jsonServer.defaults()
+const jsonServer = require('json-server')
+const server = jsonServer.create()
+const router = jsonServer.router('db.json')
+const middlewares = jsonServer.defaults()
 
 // Set default middlewares (logger, static, cors and no-cache)
 server.use(middlewares)
 
 // Add custom routes before JSON Server router
-server.get('/echo', function (req, res) {
+server.get('/echo', (req, res) => {
   res.jsonp(req.query)
 })
 
 // To handle POST, PUT and PATCH you need to use a body-parser
 // You can use the one used by JSON Server
 server.use(jsonServer.bodyParser)
-server.use(function (req, res, next) {
+server.use((req, res, next) => {
   if (req.method === 'POST') {
     req.body.createdAt = Date.now()
   }
@@ -445,7 +458,7 @@ server.use(function (req, res, next) {
 
 // Use default router
 server.use(router)
-server.listen(3000, function () {
+server.listen(3000, () => {
   console.log('JSON Server is running')
 })
 ```
@@ -453,13 +466,13 @@ server.listen(3000, function () {
 #### Access control example
 
 ```js
-var jsonServer = require('json-server')
-var server = jsonServer.create()
-var router = jsonServer.router('db.json')
-var middlewares = jsonServer.defaults()
+const jsonServer = require('json-server')
+const server = jsonServer.create()
+const router = jsonServer.router('db.json')
+const middlewares = jsonServer.defaults()
 
 server.use(middlewares)
-server.use(function (req, res, next) {
+server.use((req, res, next) => {
  if (isAuthorized(req)) { // add your authorization logic here
    next() // continue to JSON Server router
  } else {
@@ -467,7 +480,7 @@ server.use(function (req, res, next) {
  }
 })
 server.use(router)
-server.listen(3000, function () {
+server.listen(3000, () => {
   console.log('JSON Server is running')
 })
 ```
@@ -478,9 +491,9 @@ To modify responses, overwrite `router.render` method:
 
 ```javascript
 // In this example, returned resources will be wrapped in a body property
-router.render = function (req, res) {
+router.render = (req, res) => {
   res.jsonp({
-   body: res.locals.data
+    body: res.locals.data
   })
 }
 ```

package/db.json

@@ -1,20 +1,9 @@
 {
   "posts": [
-    {
-      "id": 1,
-      "title": "json-server",
-      "author": "typicode"
-    }
+    { "id": 1, "title": "json-server", "author": "typicode" }
   ],
   "comments": [
-    {
-      "id": 1,
-      "body": "some comment",
-      "postId": 1
-    }
+    { "id": 1, "body": "some comment", "postId": 1 }
   ],
-  "profile": {
-    "name": "typicode"
-  },
-  "images": [1]
-}
+  "profile": { "name": "typicode" }
+}

package/lib/cli/index.js

@@ -6,7 +6,7 @@ var run = require('./run');
 var pkg = require('../../package.json');
 
 module.exports = function () {
-  updateNotifier({ pkg: pkg }).notify();
+  updateNotifier({ pkg }).notify();
 
   var argv = yargs.config('config').usage('$0 [options] <source>').options({
     port: {

package/lib/cli/run.js

@@ -15,7 +15,7 @@ var jsonServer = require('../server');
 function prettyPrint(argv, object, rules) {
   var host = argv.host === '0.0.0.0' ? 'localhost' : argv.host;
   var port = argv.port;
-  var root = 'http://' + host + ':' + port;
+  var root = `http://${host}:${port}`;
 
   console.log();
   console.log(chalk.bold('  Resources'));
@@ -90,7 +90,7 @@ module.exports = function (argv) {
   var server = void 0;
 
   if (!fs.existsSync(argv.snapshots)) {
-    console.log('Error: snapshots directory ' + argv.snapshots + ' doesn\'t exist');
+    console.log(`Error: snapshots directory ${argv.snapshots} doesn't exist`);
     process.exit(1);
   }
 
@@ -107,8 +107,8 @@ module.exports = function (argv) {
 
     // Be nice and create a default db.json if it doesn't exist
     if (is.JSON(source) && !fs.existsSync(source)) {
-      console.log(chalk.yellow('  Oops, ' + source + ' doesn\'t seem to exist'));
-      console.log(chalk.yellow('  Creating ' + source + ' with some default data'));
+      console.log(chalk.yellow(`  Oops, ${source} doesn't seem to exist`));
+      console.log(chalk.yellow(`  Creating ${source} with some default data`));
       console.log();
       fs.writeFileSync(source, JSON.stringify(example, null, 2));
     }
@@ -160,8 +160,8 @@ module.exports = function (argv) {
     // Support nohup
     // https://github.com/typicode/json-server/issues/221
     process.stdin.on('error', function () {
-      console.log('  Error, can\'t read from stdin');
-      console.log('  Creating a snapshot from the CLI won\'t be possible');
+      console.log(`  Error, can't read from stdin`);
+      console.log(`  Creating a snapshot from the CLI won't be possible`);
     });
     process.stdin.setEncoding('utf8');
     process.stdin.on('data', function (chunk) {
@@ -170,74 +170,70 @@ module.exports = function (argv) {
         var file = path.join(argv.snapshots, filename);
         var state = app.db.getState();
         fs.writeFileSync(file, JSON.stringify(state, null, 2), 'utf-8');
-        console.log('  Saved snapshot to ' + path.relative(process.cwd(), file) + '\n');
+        console.log(`  Saved snapshot to ${path.relative(process.cwd(), file)}\n`);
       }
     });
 
     // Watch files
     if (argv.watch) {
-      (function () {
-        console.log(chalk.gray('  Watching...'));
-        console.log();
-        var source = argv._[0];
-
-        // Can't watch URL
-        if (is.URL(source)) throw new Error('Can\'t watch URL');
-
-        // Watch .js or .json file
-        // Since lowdb uses atomic writing, directory is watched instead of file
-        var watchedDir = path.dirname(source);
-        var readError = false;
-        fs.watch(watchedDir, function (event, file) {
-          // https://github.com/typicode/json-server/issues/420
-          // file can be null
-          if (file) {
-            var watchedFile = path.resolve(watchedDir, file);
-            if (watchedFile === path.resolve(source)) {
-              if (is.JSON(watchedFile)) {
-                var obj = void 0;
-                try {
-                  obj = jph.parse(fs.readFileSync(watchedFile));
-                  if (readError) {
-                    console.log(chalk.green('  Read error has been fixed :)'));
-                    readError = false;
-                  }
-                } catch (e) {
-                  readError = true;
-                  console.log(chalk.red('  Error reading ' + watchedFile));
-                  console.error(e.message);
-                  return;
+      console.log(chalk.gray('  Watching...'));
+      console.log();
+      var _source = argv._[0];
+
+      // Can't watch URL
+      if (is.URL(_source)) throw new Error('Can\'t watch URL');
+
+      // Watch .js or .json file
+      // Since lowdb uses atomic writing, directory is watched instead of file
+      var watchedDir = path.dirname(_source);
+      var readError = false;
+      fs.watch(watchedDir, function (event, file) {
+        // https://github.com/typicode/json-server/issues/420
+        // file can be null
+        if (file) {
+          var watchedFile = path.resolve(watchedDir, file);
+          if (watchedFile === path.resolve(_source)) {
+            if (is.JSON(watchedFile)) {
+              var obj = void 0;
+              try {
+                obj = jph.parse(fs.readFileSync(watchedFile));
+                if (readError) {
+                  console.log(chalk.green(`  Read error has been fixed :)`));
+                  readError = false;
                 }
+              } catch (e) {
+                readError = true;
+                console.log(chalk.red(`  Error reading ${watchedFile}`));
+                console.error(e.message);
+                return;
+              }
 
-                // Compare .json file content with in memory database
-                var isDatabaseDifferent = !_.isEqual(obj, app.db.getState());
-                if (isDatabaseDifferent) {
-                  console.log(chalk.gray('  ' + source + ' has changed, reloading...'));
-                  server && server.destroy();
-                  start();
-                }
+              // Compare .json file content with in memory database
+              var isDatabaseDifferent = !_.isEqual(obj, app.db.getState());
+              if (isDatabaseDifferent) {
+                console.log(chalk.gray(`  ${_source} has changed, reloading...`));
+                server && server.destroy();
+                start();
               }
             }
           }
-        });
-
-        // Watch routes
-        if (argv.routes) {
-          (function () {
-            var watchedDir = path.dirname(argv.routes);
-            fs.watch(watchedDir, function (event, file) {
-              if (file) {
-                var watchedFile = path.resolve(watchedDir, file);
-                if (watchedFile === path.resolve(argv.routes)) {
-                  console.log(chalk.gray('  ' + argv.routes + ' has changed, reloading...'));
-                  server && server.destroy();
-                  start();
-                }
-              }
-            });
-          })();
         }
-      })();
+      });
+
+      // Watch routes
+      if (argv.routes) {
+        var _watchedDir = path.dirname(argv.routes);
+        fs.watch(_watchedDir, function (event, file) {
+          if (file) {
+            var watchedFile = path.resolve(_watchedDir, file);
+            if (watchedFile === path.resolve(argv.routes)) {
+              console.log(chalk.gray(`  ${argv.routes} has changed, reloading...`));
+              server && server.destroy();
+              start();
+            }
+          }
+        });
+      }
     }
   });
 };

package/lib/cli/utils/is.js

@@ -1,9 +1,9 @@
 "use strict";
 
 module.exports = {
-  JSON: JSON,
-  JS: JS,
-  URL: URL
+  JSON,
+  JS,
+  URL
 };
 
 function JSON(s) {

package/lib/cli/utils/load.js

@@ -3,7 +3,7 @@
 var path = require('path');
 var request = require('request');
 var low = require('lowdb');
-var fileAsync = require('lowdb/lib/file-async');
+var fileAsync = require('lowdb/lib/storages/file-async');
 var is = require('./is');
 
 module.exports = function (source, cb) {

package/lib/server/mixins.js

@@ -4,9 +4,9 @@ var shortid = require('shortid');
 var pluralize = require('pluralize');
 
 module.exports = {
-  getRemovable: getRemovable,
-  createId: createId,
-  deepQuery: deepQuery
+  getRemovable,
+  createId,
+  deepQuery
 };
 
 // Returns document ids that have unsatisfied relations
@@ -36,7 +36,7 @@ function getRemovable(db) {
 }
 
 // Return incremented id or uuid
-// Used to override underscore-db's createId with utils.createId
+// Used to override lodash-id's createId with utils.createId
 function createId(coll) {
   var _ = this;
   var idProperty = _.__id();

package/lib/server/public/index.html

@@ -1,80 +1,54 @@
 <html>
   <head>
     <title>JSON Server</title>
-    <link href="//netdna.bootstrapcdn.com/bootswatch/3.1.1/flatly/bootstrap.min.css" rel="stylesheet">
-    <link rel="stylesheet" href="stylesheets/style.css">
+    <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic">
+    <link rel="stylesheet" href="//cdn.rawgit.com/necolas/normalize.css/master/normalize.css">
+    <link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
+    <link rel="stylesheet" href="style.css">
   </head>
   <body>
-    <div class="container">
-      <p>
-        <a href="https://github.com/typicode/json-server" class="logo">
-          <img src="images/json.png">
+    <header>
+      <div class="container">
+        <a href="https://github.com/typicode/json-server">
+          <h3>JSON Server</h3>
         </a>
-      </p>
-
-      <hr>
-
-      <p>
-        <em>
-          Congrats! You're successfully running JSON Server.
-        </em>
-      </p>
-
-      <hr>
-
-      <h4>Routes</h4>
-      <p>
-        Here are the resources that JSON Server has loaded:
-      </p>
-      <ul id="resources">loading, please wait...</ul>
-      
-      <p>
-        You can view database current state at any time:
-      </p>
-      <ul>
-        <li>
-          <a href="db">db</a>
-        </li>
-      </ul>
-      
-      <p>
-        You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere
-        using CORS and JSONP.
-      </p>
-
-      <h4>Documentation</h4>
-      <p>
-        View
-        <a href="https://github.com/typicode/json-server">README</a>
-        on GitHub.
-      </p>
-
-      <h4>Issues</h4>
-      <p>Please go
-        <a href="https://github.com/typicode/json-server/issues">here</a>.
-      </p>
-
-      <hr>
-
-      <p>
-        <i>To replace this page, create an index.html file in ./public, JSON Server will load it.</i>
-      </p>
-    </div>
-
-
-    <script
-      src="https://code.jquery.com/jquery-3.0.0.min.js"
-      integrity="sha256-JmvOoLtYsmqlsWxa7mDSLMwa6dZ9rrIdtrrVYRnDRH0="   crossorigin="anonymous"></script>
-    <script>
-      $(function() {
-        $.get('db').then(function(data) {
-          $('#resources').empty();
-          $.each(data, function(key, value) {
-            $('#resources')
-              .append('<li><a href="'+ key + '">' + key + '</a></li>');
-          })
-        })
-      })
-    </script>
+      </div>
+    </header>
+    <main>
+      <div class="container">
+        <h4>Congrats!</h4>
+        <p>
+          You're successfully running JSON Server<br>
+          ✧*｡٩(ˊᗜˋ*)و✧*｡
+        </p>
+
+        <div id="resources"></div>
+
+        <p>
+          To access and modify resources, you can use any HTTP method
+          <br>
+          <code>GET</code>
+          <code>POST</code>
+          <code>PUT</code>
+          <code>PATCH</code>
+          <code>DELETE</code>
+          <code>OPTIONS</code>
+        </p>
+
+        <div id="custom-routes"></div>
+      </div>
+    </main>
+
+    <footer>
+      <div class="container">
+        <p>
+          To replace this page, create a <code>./public</code> directory with an
+          <code>index.html</code> file in it.
+        </p>
+      </div>
+    </footer>
+
+    <script src="https://unpkg.com/mithril/mithril.min.js"></script>
+    <script src="main.js"></script>
   </body>
 </html>

package/lib/server/public/main.js

@@ -0,0 +1,39 @@
+'use strict';
+
+/* global m */
+
+// Resource list
+var db = {};
+
+m.request('db').then(function (data) {
+  db = data;
+});
+
+m.mount(document.getElementById('resources'), {
+  view: function view() {
+    var keys = Object.keys(db);
+    var resourceList = m('ul', keys.map(function (key) {
+      return m('li', [m('a', { href: key }, '/' + key), m('sup', Array.isArray(db[key]) ? ' ' + db[key].length + 'x' : ' object')]);
+    }).concat([m('a', { href: 'db' }, '/db'), m('sup', m('em', ' state'))]));
+
+    return [m('h4', 'Resources'), keys.length ? resourceList : m('p', 'No resources found')];
+  }
+});
+
+// Custom routes
+var customRoutes = {};
+
+m.request('__rules').then(function (data) {
+  customRoutes = data;
+});
+
+m.mount(document.getElementById('custom-routes'), {
+  view: function view() {
+    var rules = Object.keys(customRoutes);
+    if (rules.length) {
+      return [m('h4', 'Custom routes'), m('table', rules.map(function (rule) {
+        return m('tr', [m('td', rule), m('td', '⇢ ' + customRoutes[rule])]);
+      }))];
+    }
+  }
+});