json-server 0.17.4 → 1.0.0-alpha.10

package/lib/server/router/nested.js

@@ -1,26 +0,0 @@
-"use strict";
-
-const express = require('express');
-const pluralize = require('pluralize');
-const delay = require('./delay');
-module.exports = opts => {
-  const router = express.Router();
-  router.use(delay);
-
-  // Rewrite URL (/:resource/:id/:nested -> /:nested) and request query
-  function get(req, res, next) {
-    const prop = pluralize.singular(req.params.resource);
-    req.query[`${prop}${opts.foreignKeySuffix}`] = req.params.id;
-    req.url = `/${req.params.nested}`;
-    next();
-  }
-
-  // Rewrite URL (/:resource/:id/:nested -> /:nested) and request body
-  function post(req, res, next) {
-    const prop = pluralize.singular(req.params.resource);
-    req.body[`${prop}${opts.foreignKeySuffix}`] = req.params.id;
-    req.url = `/${req.params.nested}`;
-    next();
-  }
-  return router.get('/:resource/:id/:nested', get).post('/:resource/:id/:nested', post);
-};

package/lib/server/router/plural.js

@@ -1,273 +0,0 @@
-"use strict";
-
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-const express = require('express');
-const _ = require('lodash');
-const pluralize = require('pluralize');
-const write = require('./write');
-const getFullURL = require('./get-full-url');
-const utils = require('../utils');
-const delay = require('./delay');
-module.exports = (db, name, opts) => {
-  // Create router
-  const router = express.Router();
-  router.use(delay);
-
-  // Embed function used in GET /name and GET /name/id
-  function embed(resource, e) {
-    e && [].concat(e).forEach(externalResource => {
-      if (db.get(externalResource).value) {
-        const query = {};
-        const singularResource = pluralize.singular(name);
-        query[`${singularResource}${opts.foreignKeySuffix}`] = resource.id;
-        resource[externalResource] = db.get(externalResource).filter(query).value();
-      }
-    });
-  }
-
-  // Expand function used in GET /name and GET /name/id
-  function expand(resource, e) {
-    e && [].concat(e).forEach(innerResource => {
-      const plural = pluralize(innerResource);
-      if (db.get(plural).value()) {
-        const prop = `${innerResource}${opts.foreignKeySuffix}`;
-        resource[innerResource] = db.get(plural).getById(resource[prop]).value();
-      }
-    });
-  }
-
-  // GET /name
-  // GET /name?q=
-  // GET /name?attr=&attr=
-  // GET /name?_end=&
-  // GET /name?_start=&_end=&
-  // GET /name?_embed=&_expand=
-  function list(req, res, next) {
-    // Resource chain
-    let chain = db.get(name);
-
-    // Remove q, _start, _end, ... from req.query to avoid filtering using those
-    // parameters
-    let q = req.query.q;
-    let _start = req.query._start;
-    let _end = req.query._end;
-    let _page = req.query._page;
-    const _sort = req.query._sort;
-    const _order = req.query._order;
-    let _limit = req.query._limit;
-    const _embed = req.query._embed;
-    const _expand = req.query._expand;
-    delete req.query.q;
-    delete req.query._start;
-    delete req.query._end;
-    delete req.query._sort;
-    delete req.query._order;
-    delete req.query._limit;
-    delete req.query._embed;
-    delete req.query._expand;
-
-    // Automatically delete query parameters that can't be found
-    // in the database
-    Object.keys(req.query).forEach(query => {
-      const arr = db.get(name).value();
-      for (const i in arr) {
-        if (_.has(arr[i], query) || query === 'callback' || query === '_' || /_lte$/.test(query) || /_gte$/.test(query) || /_ne$/.test(query) || /_like$/.test(query)) return;
-      }
-      delete req.query[query];
-    });
-    if (q) {
-      // Full-text search
-      if (Array.isArray(q)) {
-        q = q[0];
-      }
-      q = q.toLowerCase();
-      chain = chain.filter(obj => {
-        for (const key in obj) {
-          const value = obj[key];
-          if (db._.deepQuery(value, q)) {
-            return true;
-          }
-        }
-        return false;
-      });
-    }
-    Object.keys(req.query).forEach(key => {
-      // Don't take into account JSONP query parameters
-      // jQuery adds a '_' query parameter too
-      if (key !== 'callback' && key !== '_') {
-        // Always use an array, in case req.query is an array
-        const arr = [].concat(req.query[key]);
-        const isDifferent = /_ne$/.test(key);
-        const isRange = /_lte$/.test(key) || /_gte$/.test(key);
-        const isLike = /_like$/.test(key);
-        const path = key.replace(/(_lte|_gte|_ne|_like)$/, '');
-        chain = chain.filter(element => {
-          return arr.map(function (value) {
-            // get item value based on path
-            // i.e post.title -> 'foo'
-            const elementValue = _.get(element, path);
-
-            // Prevent toString() failing on undefined or null values
-            if (elementValue === undefined || elementValue === null) {
-              return undefined;
-            }
-            if (isRange) {
-              const 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((a, b) => isDifferent ? a && b : a || b);
-        });
-      }
-    });
-
-    // Sort
-    if (_sort) {
-      const _sortSet = _sort.split(',');
-      const _orderSet = (_order || '').split(',').map(s => s.toLowerCase());
-      chain = chain.orderBy(_sortSet, _orderSet);
-    }
-
-    // Slice result
-    if (_end || _limit || _page) {
-      res.setHeader('X-Total-Count', chain.size());
-      res.setHeader('Access-Control-Expose-Headers', `X-Total-Count${_page ? ', Link' : ''}`);
-    }
-    if (_page) {
-      _page = parseInt(_page, 10);
-      _page = _page >= 1 ? _page : 1;
-      _limit = parseInt(_limit, 10) || 10;
-      const page = utils.getPage(chain.value(), _page, _limit);
-      const links = {};
-      const fullURL = getFullURL(req);
-      if (page.first) {
-        links.first = fullURL.replace(`page=${page.current}`, `page=${page.first}`);
-      }
-      if (page.prev) {
-        links.prev = fullURL.replace(`page=${page.current}`, `page=${page.prev}`);
-      }
-      if (page.next) {
-        links.next = fullURL.replace(`page=${page.current}`, `page=${page.next}`);
-      }
-      if (page.last) {
-        links.last = fullURL.replace(`page=${page.current}`, `page=${page.last}`);
-      }
-      res.links(links);
-      chain = _.chain(page.items);
-    } else if (_end) {
-      _start = parseInt(_start, 10) || 0;
-      _end = parseInt(_end, 10);
-      chain = chain.slice(_start, _end);
-    } else if (_limit) {
-      _start = parseInt(_start, 10) || 0;
-      _limit = parseInt(_limit, 10);
-      chain = chain.slice(_start, _start + _limit);
-    }
-
-    // embed and expand
-    chain = chain.cloneDeep().forEach(function (element) {
-      embed(element, _embed);
-      expand(element, _expand);
-    });
-    res.locals.data = chain.value();
-    next();
-  }
-
-  // GET /name/:id
-  // GET /name/:id?_embed=&_expand
-  function show(req, res, next) {
-    const _embed = req.query._embed;
-    const _expand = req.query._expand;
-    const resource = db.get(name).getById(req.params.id).value();
-    if (resource) {
-      // Clone resource to avoid making changes to the underlying object
-      const clone = _.cloneDeep(resource);
-
-      // Embed other resources based on resource id
-      // /posts/1?_embed=comments
-      embed(clone, _embed);
-
-      // Expand inner resources based on id
-      // /posts/1?_expand=user
-      expand(clone, _expand);
-      res.locals.data = clone;
-    }
-    next();
-  }
-
-  // POST /name
-  function create(req, res, next) {
-    let resource;
-    if (opts._isFake) {
-      const id = db.get(name).createId().value();
-      resource = _objectSpread(_objectSpread({}, req.body), {}, {
-        id
-      });
-    } else {
-      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();
-  }
-
-  // PUT /name/:id
-  // PATCH /name/:id
-  function update(req, res, next) {
-    const id = req.params.id;
-    let resource;
-    if (opts._isFake) {
-      resource = db.get(name).getById(id).value();
-      if (req.method === 'PATCH') {
-        resource = _objectSpread(_objectSpread({}, resource), req.body);
-      } else {
-        resource = _objectSpread(_objectSpread({}, req.body), {}, {
-          id: resource.id
-        });
-      }
-    } else {
-      let chain = db.get(name);
-      chain = req.method === 'PATCH' ? chain.updateById(id, req.body) : chain.replaceById(id, req.body);
-      resource = chain.value();
-    }
-    if (resource) {
-      res.locals.data = resource;
-    }
-    next();
-  }
-
-  // DELETE /name/:id
-  function destroy(req, res, next) {
-    let resource;
-    if (opts._isFake) {
-      resource = db.get(name).value();
-    } else {
-      resource = db.get(name).removeById(req.params.id).value();
-
-      // Remove dependents documents
-      const removable = db._.getRemovable(db.getState(), opts);
-      removable.forEach(item => {
-        db.get(item.name).removeById(item.id).value();
-      });
-    }
-    if (resource) {
-      res.locals.data = {};
-    }
-    next();
-  }
-  const w = write(db);
-  router.route('/').get(list).post(create, w);
-  router.route('/:id').get(show).put(update, w).patch(update, w).delete(destroy, w);
-  return router;
-};

package/lib/server/router/singular.js

@@ -1,52 +0,0 @@
-"use strict";
-
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-const express = require('express');
-const write = require('./write');
-const getFullURL = require('./get-full-url');
-const delay = require('./delay');
-module.exports = (db, name, opts) => {
-  const router = express.Router();
-  router.use(delay);
-  function show(req, res, next) {
-    res.locals.data = db.get(name).value();
-    next();
-  }
-  function create(req, res, next) {
-    if (opts._isFake) {
-      res.locals.data = req.body;
-    } else {
-      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();
-  }
-  function update(req, res, next) {
-    if (opts._isFake) {
-      if (req.method === 'PUT') {
-        res.locals.data = req.body;
-      } else {
-        const resource = db.get(name).value();
-        res.locals.data = _objectSpread(_objectSpread({}, resource), req.body);
-      }
-    } else {
-      if (req.method === 'PUT') {
-        db.set(name, req.body).value();
-      } else {
-        db.get(name).assign(req.body).value();
-      }
-      res.locals.data = db.get(name).value();
-    }
-    next();
-  }
-  const 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,17 +0,0 @@
-"use strict";
-
-const _ = require('lodash');
-function validateKey(key) {
-  if (key.indexOf('/') !== -1) {
-    const 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);
-  }
-}
-module.exports = obj => {
-  if (_.isPlainObject(obj)) {
-    Object.keys(obj).forEach(validateKey);
-  } else {
-    throw new Error(`Data must be an object. Found ${Array.isArray(obj) ? 'array' : typeof obj}.
-      'See https://github.com/typicode/json-server for example.`);
-  }
-};

package/lib/server/router/write.js

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

package/lib/server/utils.js

@@ -1,26 +0,0 @@
-"use strict";
-
-module.exports = {
-  getPage
-};
-function getPage(array, page, perPage) {
-  const obj = {};
-  const start = (page - 1) * perPage;
-  const end = page * perPage;
-  obj.items = array.slice(start, end);
-  if (obj.items.length === 0) {
-    return obj;
-  }
-  if (page > 1) {
-    obj.prev = page - 1;
-  }
-  if (end < array.length) {
-    obj.next = page + 1;
-  }
-  if (obj.items.length !== array.length) {
-    obj.current = page;
-    obj.first = 1;
-    obj.last = Math.ceil(array.length / perPage);
-  }
-  return obj;
-}

package/public/index.html

@@ -1,85 +0,0 @@
-<html>
-  <head>
-    <link
-      rel="stylesheet"
-      href="https://use.fontawesome.com/releases/v5.8.2/css/all.css"
-      integrity="sha384-oS3vJWv+0UjzBfQzYUhtDYW+Pj2yciDJxpsK1OYPAYjqT085Qq/1cq5FLXAZQ7Ay"
-      crossorigin="anonymous"
-    />
-    <link rel="stylesheet" href="style.css" />
-    <title>JSON Server</title>
-  </head>
-
-  <body>
-    <header>
-      <div class="container">
-        <nav>
-          <ul>
-            <li class="title">
-              JSON Server
-            </li>
-            <li>
-              <a href="https://github.com/users/typicode/sponsorship">
-                <i class="fas fa-heart"></i>GitHub Sponsors
-              </a>
-            </li>
-            <li>
-              <a href="https://my-json-server.typicode.com">
-                <i class="fas fa-burn"></i>My JSON Server
-              </a>
-            </li>
-            <li>
-              <a href="https://thanks.typicode.com">
-                <i class="far fa-laugh"></i>Supporters
-              </a>
-            </li>
-          </ul>
-        </nav>
-      </div>
-    </header>
-    <main>
-      <div class="container">
-        <h1>Congrats!</h1>
-        <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:
-        </p>
-        <p>
-          <code>GET</code>
-          <code>POST</code>
-          <code>PUT</code>
-          <code>PATCH</code>
-          <code>DELETE</code>
-          <code>OPTIONS</code>
-        </p>
-
-        <div id="custom-routes"></div>
-
-        <h1>Documentation</h1>
-        <p>
-          <a href="https://github.com/typicode/json-server">
-            README
-          </a>
-        </p>
-      </div>
-    </main>
-
-    <footer>
-      <div class="container">
-        <p>
-          To replace this page, create a
-          <code>./public/index.html</code> file.
-        </p>
-      </div>
-    </footer>
-
-    <script src="script.js"></script>
-  </body>
-</html>

package/public/script.js

@@ -1,76 +0,0 @@
-function ResourceItem({ name, length }) {
-  return `
-    <li>
-      <a href="${name}">/${name}</a>
-      <sup>${length ? `${length}x` : 'object'}</sup>
-    </li>
-  `
-}
-
-function ResourceList({ db }) {
-  return `
-    <ul>
-      ${Object.keys(db)
-        .map((name) =>
-          ResourceItem({
-            name,
-            length: Array.isArray(db[name]) && db[name].length,
-          }),
-        )
-        .join('')}
-    </ul>
-  `
-}
-
-function NoResources() {
-  return `<p>No resources found</p>`
-}
-
-function ResourcesBlock({ db }) {
-  return `
-    <div>
-      <h1>Resources</h1>
-      ${Object.keys(db).length ? ResourceList({ db }) : NoResources()}
-    </div>
-  `
-}
-
-window
-  .fetch('db')
-  .then((response) => response.json())
-  .then(
-    (db) =>
-      (document.getElementById('resources').innerHTML = ResourcesBlock({ db })),
-  )
-
-function CustomRoutesBlock({ customRoutes }) {
-  const rules = Object.keys(customRoutes)
-  if (rules.length) {
-    return `
-      <div>
-        <h1>Custom Routes</h1>
-        <table>
-          ${rules
-            .map(
-              (rule) =>
-                `<tr>
-              <td>${rule}</td>
-              <td><code>⇢</code> ${customRoutes[rule]}</td>
-            </tr>`,
-            )
-            .join('')}
-        </table>
-      </div>
-    `
-  }
-}
-
-window
-  .fetch('__rules')
-  .then((response) => response.json())
-  .then(
-    (customRoutes) =>
-      (document.getElementById('custom-routes').innerHTML = CustomRoutesBlock({
-        customRoutes,
-      })),
-  )

package/public/style.css

@@ -1,113 +0,0 @@
-body {
-  display: flex;
-  min-height: 100vh;
-  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,
-    Oxygen-Sans, Ubuntu, Cantarell, 'Helvetica Neue', sans-serif;
-  flex-direction: column;
-  padding: 0;
-  margin: 0;
-  color: #3b4252;
-  letter-spacing: 0;
-}
-
-.container {
-  max-width: 960px;
-  margin: auto;
-  padding: 1rem;
-}
-
-header {
-  border-bottom: 1px solid #eee;
-}
-
-header a {
-  color: inherit;
-  text-decoration: none;
-}
-
-header a:hover {
-  text-decoration: underline;
-}
-
-nav ul {
-  display: flex;
-  flex-wrap: nowrap;
-  justify-content: space-between;
-}
-
-nav li.title {
-  flex-grow: 5;
-  text-align: left;
-  font-weight: bold;
-  font-size: 1.4rem;
-  color: #3b4252;
-}
-
-nav li {
-  flex-grow: 1;
-  align-self: center;
-  text-align: right;
-  color: #4c566a;
-}
-
-.fa-heart {
-  color: deeppink;
-}
-
-main {
-  flex: 1;
-}
-
-footer {
-  margin-top: 4rem;
-  border-top: 1px solid #eee;
-}
-
-h1 {
-  margin-top: 4rem;
-  font-weight: normal;
-}
-
-i {
-  margin-right: 0.5rem;
-}
-
-a {
-  color: #5e81ac;
-}
-
-a:hover {
-  color: #81a1c1;
-  text-decoration: underline;
-}
-
-table {
-  margin-left: 0;
-}
-
-td {
-  border: 0;
-  padding: 0 1em 0.5em 0;
-}
-
-td:first-child {
-  width: 1%;
-  white-space: nowrap;
-}
-
-ul {
-  list-style-position: inside;
-  padding-left: 0;
-}
-
-li {
-  list-style-type: none;
-  margin-bottom: 0.2rem;
-}
-
-code {
-  padding: 0.2rem;
-  margin: 0rem 0.2rem;
-  border-radius: 0.2rem;
-  background: #e5e9f0;
-}