json-server 0.17.4 → 1.0.0-alpha.1

package/package.json

@@ -1,102 +1,49 @@
 {
   "name": "json-server",
-  "version": "0.17.4",
-  "description": "Get a full fake REST API with zero coding in less than 30 seconds",
-  "main": "./lib/server/index.js",
-  "bin": "./lib/cli/bin.js",
+  "version": "1.0.0-alpha.1",
+  "description": "",
+  "type": "module",
+  "exports": "./lib/index.js",
+  "types": "lib",
   "files": [
-    "lib",
-    "public"
+    "lib"
   ],
   "scripts": {
-    "prepare": "husky install",
-    "test": "npm run build && cross-env NODE_ENV=test jest",
-    "start": "babel-node -- src/cli/bin db.json -r routes.json",
-    "lint": "eslint . --ignore-path .gitignore",
-    "fix": "npm run lint -- --fix",
-    "build": "babel src -d lib",
-    "toc": "markdown-toc -i README.md",
-    "postversion": "git push && git push --tags",
-    "prepublish": "npm test && npm run build"
-  },
-  "dependencies": {
-    "body-parser": "^1.19.0",
-    "chalk": "^4.1.2",
-    "compression": "^1.7.4",
-    "connect-pause": "^0.1.1",
-    "cors": "^2.8.5",
-    "errorhandler": "^1.5.1",
-    "express": "^4.17.1",
-    "express-urlrewrite": "^1.4.0",
-    "json-parse-helpfulerror": "^1.0.3",
-    "lodash": "^4.17.21",
-    "lodash-id": "^0.14.1",
-    "lowdb": "^1.0.0",
-    "method-override": "^3.0.0",
-    "morgan": "^1.10.0",
-    "nanoid": "^3.1.23",
-    "please-upgrade-node": "^3.2.0",
-    "pluralize": "^8.0.0",
-    "server-destroy": "^1.0.1",
-    "yargs": "^17.0.1"
+    "css": "tailwindcss -i ./views/input.css -o ./public/output.css",
+    "watch-ts": "tsx watch src/bin.ts db.json",
+    "watch-css": "npm run css -- --watch",
+    "dev": "concurrently npm:watch-*",
+    "build": "rm -rf lib && tsc && npm run css",
+    "test": "node --import tsx/esm  --test src/**/*.test.ts",
+    "prepare": "husky install"
   },
+  "keywords": [],
+  "author": "",
+  "license": "SEE LICENSE IN ./LICENSE",
   "devDependencies": {
-    "@babel/cli": "^7.12.1",
-    "@babel/core": "^7.12.3",
-    "@babel/node": "^7.12.6",
-    "@babel/preset-env": "^7.12.1",
-    "cross-env": "^7.0.2",
-    "eslint": "^7.13.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-config-standard": "^16.0.1",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.1.4",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^4.1.0",
-    "husky": "^6.0.0",
-    "jest": "^26.6.3",
-    "markdown-toc": "^1.2.0",
-    "mkdirp": "^1.0.4",
-    "npm-run-all": "^4.1.5",
-    "os-tmpdir": "^2.0.0",
-    "prettier": "^2.3.2",
-    "rimraf": "^3.0.2",
-    "server-ready": "^0.3.1",
-    "standard": "^17.1.0",
-    "supertest": "^6.0.1",
-    "temp-write": "^4.0.0"
+    "@sindresorhus/tsconfig": "^5.0.0",
+    "@tailwindcss/typography": "^0.5.10",
+    "@types/node": "^20.10.0",
+    "@typicode/eslint-config": "^1.2.0",
+    "concurrently": "^8.2.2",
+    "get-port": "^7.0.0",
+    "husky": "^8.0.3",
+    "tailwindcss": "^3.3.5",
+    "tempy": "^3.1.0",
+    "tsx": "^4.5.0",
+    "type-fest": "^4.8.2",
+    "typescript": "^5.3.2"
   },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/typicode/json-server.git"
-  },
-  "keywords": [
-    "JSON",
-    "server",
-    "fake",
-    "REST",
-    "API",
-    "prototyping",
-    "mock",
-    "mocking",
-    "test",
-    "testing",
-    "rest",
-    "data",
-    "dummy",
-    "sandbox"
-  ],
-  "author": "Typicode <typicode@gmail.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/typicode/json-server/issues"
-  },
-  "homepage": "https://github.com/typicode/json-server",
-  "engines": {
-    "node": ">=12"
-  },
-  "jest": {
-    "testURL": "http://localhost/"
+  "dependencies": {
+    "@tinyhttp/app": "^2.2.1",
+    "chokidar": "^3.5.3",
+    "dot-prop": "^8.0.2",
+    "eta": "^3.1.1",
+    "inflection": "^3.0.0",
+    "lowdb": "^6.1.1",
+    "milliparsec": "^2.3.0",
+    "sirv": "^2.0.3",
+    "sort-on": "^6.0.0",
+    "zod": "^3.22.4"
   }
 }

package/lib/cli/bin.js

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-
-require('please-upgrade-node')(require('../../package.json'));
-require('./')();

package/lib/cli/index.js

@@ -1,77 +0,0 @@
-"use strict";
-
-const yargs = require('yargs');
-const run = require('./run');
-const pkg = require('../../package.json');
-module.exports = function () {
-  const argv = yargs.config('config').usage('$0 [options] <source>').options({
-    port: {
-      alias: 'p',
-      description: 'Set port',
-      default: 3000
-    },
-    host: {
-      alias: 'H',
-      description: 'Set host',
-      default: 'localhost'
-    },
-    watch: {
-      alias: 'w',
-      description: 'Watch file(s)'
-    },
-    routes: {
-      alias: 'r',
-      description: 'Path to routes file'
-    },
-    middlewares: {
-      alias: 'm',
-      array: true,
-      description: 'Paths to middleware files'
-    },
-    static: {
-      alias: 's',
-      description: 'Set static files directory'
-    },
-    'read-only': {
-      alias: 'ro',
-      description: 'Allow only GET requests'
-    },
-    'no-cors': {
-      alias: 'nc',
-      description: 'Disable Cross-Origin Resource Sharing'
-    },
-    'no-gzip': {
-      alias: 'ng',
-      description: 'Disable GZIP Content-Encoding'
-    },
-    snapshots: {
-      alias: 'S',
-      description: 'Set snapshots directory',
-      default: '.'
-    },
-    delay: {
-      alias: 'd',
-      description: 'Add delay to responses (ms)'
-    },
-    id: {
-      alias: 'i',
-      description: 'Set database id property (e.g. _id)',
-      default: 'id'
-    },
-    foreignKeySuffix: {
-      alias: 'fks',
-      description: 'Set foreign key suffix (e.g. _id as in post_id)',
-      default: 'Id'
-    },
-    quiet: {
-      alias: 'q',
-      description: 'Suppress log messages from output'
-    },
-    config: {
-      alias: 'c',
-      description: 'Path to config file',
-      default: 'json-server.json'
-    }
-  }).boolean('watch').boolean('read-only').boolean('quiet').boolean('no-cors').boolean('no-gzip').help('help').alias('help', 'h').version(pkg.version).alias('version', 'v').example('$0 db.json', '').example('$0 file.js', '').example('$0 http://example.com/db.json', '').epilog('https://github.com/typicode/json-server').require(1, 'Missing <source> argument').argv;
-  run(argv);
-};

package/lib/cli/run.js

@@ -1,213 +0,0 @@
-"use strict";
-
-const fs = require('fs');
-const path = require('path');
-const jph = require('json-parse-helpfulerror');
-const _ = require('lodash');
-const chalk = require('chalk');
-const enableDestroy = require('server-destroy');
-const pause = require('connect-pause');
-const is = require('./utils/is');
-const load = require('./utils/load');
-const jsonServer = require('../server');
-function prettyPrint(argv, object, rules) {
-  const root = `http://${argv.host}:${argv.port}`;
-  console.log();
-  console.log(chalk.bold('  Resources'));
-  for (const prop in object) {
-    // skip printing $schema nodes
-    if (prop === '$schema') continue;
-    console.log(`  ${root}/${prop}`);
-  }
-  if (rules) {
-    console.log();
-    console.log(chalk.bold('  Other routes'));
-    for (const rule in rules) {
-      console.log(`  ${rule} -> ${rules[rule]}`);
-    }
-  }
-  console.log();
-  console.log(chalk.bold('  Home'));
-  console.log(`  ${root}`);
-  console.log();
-}
-function createApp(db, routes, middlewares, argv) {
-  const app = jsonServer.create();
-  const {
-    foreignKeySuffix
-  } = argv;
-  const router = jsonServer.router(db, foreignKeySuffix ? {
-    foreignKeySuffix
-  } : undefined);
-  const defaultsOpts = {
-    logger: !argv.quiet,
-    readOnly: argv.readOnly,
-    noCors: argv.noCors,
-    noGzip: argv.noGzip,
-    bodyParser: true
-  };
-  if (argv.static) {
-    defaultsOpts.static = path.join(process.cwd(), argv.static);
-  }
-  const defaults = jsonServer.defaults(defaultsOpts);
-  app.use(defaults);
-  if (routes) {
-    const rewriter = jsonServer.rewriter(routes);
-    app.use(rewriter);
-  }
-  if (middlewares) {
-    app.use(middlewares);
-  }
-  if (argv.delay) {
-    app.use(pause(argv.delay));
-  }
-  router.db._.id = argv.id;
-  app.db = router.db;
-  app.use(router);
-  return app;
-}
-module.exports = function (argv) {
-  const source = argv._[0];
-  let app;
-  let server;
-  if (!fs.existsSync(argv.snapshots)) {
-    console.log(`Error: snapshots directory ${argv.snapshots} doesn't exist`);
-    process.exit(1);
-  }
-
-  // noop log fn
-  if (argv.quiet) {
-    console.log = () => {};
-  }
-  console.log();
-  console.log(chalk.cyan('  \\{^_^}/ hi!'));
-  function start(cb) {
-    console.log();
-    console.log(chalk.gray('  Loading', source));
-    server = undefined;
-
-    // create db and load object, JSON file, JS or HTTP database
-    return load(source).then(db => {
-      // Load additional routes
-      let routes;
-      if (argv.routes) {
-        console.log(chalk.gray('  Loading', argv.routes));
-        routes = JSON.parse(fs.readFileSync(argv.routes));
-      }
-
-      // Load middlewares
-      let middlewares;
-      if (argv.middlewares) {
-        middlewares = argv.middlewares.map(function (m) {
-          console.log(chalk.gray('  Loading', m));
-          return require(path.resolve(m));
-        });
-      }
-
-      // Done
-      console.log(chalk.gray('  Done'));
-
-      // Create app and server
-      app = createApp(db, routes, middlewares, argv);
-      server = app.listen(argv.port, argv.host);
-
-      // Enhance with a destroy function
-      enableDestroy(server);
-
-      // Display server informations
-      prettyPrint(argv, db.getState(), routes);
-
-      // Catch and handle any error occurring in the server process
-      process.on('uncaughtException', error => {
-        if (error.errno === 'EADDRINUSE') console.log(chalk.red(`Cannot bind to the port ${error.port}. Please specify another port number either through --port argument or through the json-server.json configuration file`));else console.log('Some error occurred', error);
-        process.exit(1);
-      });
-    });
-  }
-
-  // Start server
-  start().then(() => {
-    // Snapshot
-    console.log(chalk.gray('  Type s + enter at any time to create a snapshot of the database'));
-
-    // Support nohup
-    // https://github.com/typicode/json-server/issues/221
-    process.stdin.on('error', () => {
-      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', chunk => {
-      if (chunk.trim().toLowerCase() === 's') {
-        const filename = `db-${Date.now()}.json`;
-        const file = path.join(argv.snapshots, filename);
-        const 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`);
-      }
-    });
-
-    // Watch files
-    if (argv.watch) {
-      console.log(chalk.gray('  Watching...'));
-      console.log();
-      const 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
-      const watchedDir = path.dirname(source);
-      let readError = false;
-      fs.watch(watchedDir, (event, file) => {
-        // https://github.com/typicode/json-server/issues/420
-        // file can be null
-        if (file) {
-          const watchedFile = path.resolve(watchedDir, file);
-          if (watchedFile === path.resolve(source)) {
-            if (is.FILE(watchedFile)) {
-              let obj;
-              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
-              const 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) {
-        const watchedDir = path.dirname(argv.routes);
-        fs.watch(watchedDir, (event, file) => {
-          if (file) {
-            const watchedFile = path.resolve(watchedDir, file);
-            if (watchedFile === path.resolve(argv.routes)) {
-              console.log(chalk.gray(`  ${argv.routes} has changed, reloading...`));
-              server && server.destroy(() => start());
-            }
-          }
-        });
-      }
-    }
-  }).catch(err => {
-    console.log(err);
-    process.exit(1);
-  });
-};

package/lib/cli/utils/is.js

@@ -1,16 +0,0 @@
-"use strict";
-
-module.exports = {
-  FILE,
-  JS,
-  URL
-};
-function FILE(s) {
-  return !URL(s) && /\.json$/.test(s);
-}
-function JS(s) {
-  return !URL(s) && /\.c?js$/.test(s);
-}
-function URL(s) {
-  return /^(http|https):/.test(s);
-}

package/lib/cli/utils/load.js

@@ -1,69 +0,0 @@
-"use strict";
-
-const fs = require('fs');
-const path = require('path');
-const http = require('http');
-const https = require('https');
-const low = require('lowdb');
-const FileAsync = require('lowdb/adapters/FileAsync');
-const Memory = require('lowdb/adapters/Memory');
-const is = require('./is');
-const chalk = require('chalk');
-const example = {
-  posts: [{
-    id: 1,
-    title: 'json-server',
-    author: 'typicode'
-  }],
-  comments: [{
-    id: 1,
-    body: 'some comment',
-    postId: 1
-  }],
-  profile: {
-    name: 'typicode'
-  }
-};
-module.exports = function (source) {
-  return new Promise((resolve, reject) => {
-    if (is.FILE(source)) {
-      if (!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();
-        fs.writeFileSync(source, JSON.stringify(example, null, 2));
-      }
-      resolve(low(new FileAsync(source)));
-    } else if (is.URL(source)) {
-      // Normalize the source into a URL object.
-      const sourceUrl = new URL(source);
-      // Pick the client based on the protocol scheme
-      const client = sourceUrl.protocol === 'https:' ? https : http;
-      client.get(sourceUrl, res => {
-        let dbData = '';
-        res.on('data', data => {
-          dbData += data;
-        });
-        res.on('end', () => {
-          resolve(low(new Memory()).setState(JSON.parse(dbData)));
-        });
-      }).on('error', error => {
-        return reject(error);
-      });
-    } else if (is.JS(source)) {
-      // Clear cache
-      const filename = path.resolve(source);
-      delete require.cache[filename];
-      const dataFn = require(filename);
-      if (typeof dataFn !== 'function') {
-        throw new Error('The database is a JavaScript file but the export is not a function.');
-      }
-
-      // Run dataFn to generate data
-      const data = dataFn();
-      resolve(low(new Memory()).setState(data));
-    } else {
-      throw new Error(`Unsupported source ${source}`);
-    }
-  });
-};

package/lib/server/body-parser.js

@@ -1,9 +0,0 @@
-"use strict";
-
-const bodyParser = require('body-parser');
-module.exports = [bodyParser.json({
-  limit: '10mb',
-  extended: false
-}), bodyParser.urlencoded({
-  extended: false
-})];

package/lib/server/defaults.js

@@ -1,73 +0,0 @@
-"use strict";
-
-const fs = require('fs');
-const path = require('path');
-const express = require('express');
-const logger = require('morgan');
-const cors = require('cors');
-const compression = require('compression');
-const errorhandler = require('errorhandler');
-const bodyParser = require('./body-parser');
-module.exports = function (opts) {
-  const userDir = path.join(process.cwd(), 'public');
-  const defaultDir = path.join(__dirname, '../../public');
-  const staticDir = fs.existsSync(userDir) ? userDir : defaultDir;
-  opts = Object.assign({
-    logger: true,
-    static: staticDir
-  }, opts);
-  const arr = [];
-
-  // Compress all requests
-  if (!opts.noGzip) {
-    arr.push(compression());
-  }
-
-  // Enable CORS for all the requests, including static files
-  if (!opts.noCors) {
-    arr.push(cors({
-      origin: true,
-      credentials: true
-    }));
-  }
-  if (process.env.NODE_ENV === 'development') {
-    // only use in development
-    arr.push(errorhandler());
-  }
-
-  // Serve static files
-  arr.push(express.static(opts.static));
-
-  // Logger
-  if (opts.logger) {
-    arr.push(logger('dev', {
-      skip: req => process.env.NODE_ENV === 'test' || req.path === '/favicon.ico'
-    }));
-  }
-
-  // No cache for IE
-  // https://support.microsoft.com/en-us/kb/234067
-  arr.push((req, res, next) => {
-    res.header('Cache-Control', 'no-cache');
-    res.header('Pragma', 'no-cache');
-    res.header('Expires', '-1');
-    next();
-  });
-
-  // Read-only
-  if (opts.readOnly) {
-    arr.push((req, res, next) => {
-      if (req.method === 'GET') {
-        next(); // Continue
-      } else {
-        res.sendStatus(403); // Forbidden
-      }
-    });
-  }
-
-  // Add middlewares
-  if (opts.bodyParser) {
-    arr.push(bodyParser);
-  }
-  return arr;
-};

package/lib/server/index.js

@@ -1,10 +0,0 @@
-"use strict";
-
-const express = require('express');
-module.exports = {
-  create: () => express().set('json spaces', 2),
-  defaults: require('./defaults'),
-  router: require('./router'),
-  rewriter: require('./rewriter'),
-  bodyParser: require('./body-parser')
-};