json-server 1.0.0-alpha.10 → 1.0.0-alpha.12

package/README.md

@@ -8,7 +8,7 @@
 ## Install
 
 ```shell
-npm install json-server@alpha
+npm install json-server
 ```
 
 ## Usage
@@ -40,7 +40,7 @@ $ json-server db.json
 Get a REST API
 
 ```shell
-$ curl -H "Accept: application/json" -X GET http://localhost:3000/posts/1
+$ curl http://localhost:3000/posts/1
 {
   "id": "1",
   "title": "a title"
@@ -49,15 +49,20 @@ $ curl -H "Accept: application/json" -X GET http://localhost:3000/posts/1
 
 Run `json-server --help` for a list of options
 
+## Sponsors ✨
+
 |                                                                                    Sponsors                                                                                    |
 | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
 |                         <a href="https://mockend.com/" target="_blank"><img src="https://jsonplaceholder.typicode.com/mockend.svg" height="70px"></a>                          |
 | <a href="https://www.storyblok.com/" target="_blank"><img src="https://github.com/typicode/json-server/assets/5502029/c6b10674-4ada-4616-91b8-59d30046b45a" height="40px"></a> |
+|  <a href="https://betterstack.com/" target="_blank"><img src="https://github.com/typicode/json-server/assets/5502029/44679f8f-9671-470d-b77e-26d90b90cbdc" height="40px"></a>  |
 
 [Become a sponsor and have your company logo here](https://github.com/users/typicode/sponsorship)
 
 ## Routes
 
+Based on the example `db.json`, you'll get the following routes:
+
 ```
 GET    /posts
 GET    /posts/:id
@@ -65,6 +70,8 @@ POST   /posts
 PUT    /posts/:id
 PATCH  /posts/:id
 DELETE /posts/:id
+
+# Same for comments
 ```
 
 ```
@@ -124,7 +131,7 @@ GET /posts?_sort=id,-views
 ```
 GET /posts?author.name=foo
 GET /posts?author.email=foo
-GET /posts?names[0]=foo
+GET /posts?tags[0]=foo
 ```
 
 ### Embed

package/lib/bin.js

@@ -2,6 +2,7 @@
 import { existsSync, readFileSync } from 'node:fs';
 import { extname, join } from 'node:path';
 import { parseArgs } from 'node:util';
+import chalk from 'chalk';
 import { watch } from 'chokidar';
 import JSON5 from 'json5';
 import { Low } from 'lowdb';
@@ -54,7 +55,7 @@ const file = positionals[0] ?? '';
 const port = parseInt(values.port ?? process.env['PORT'] ?? '3000');
 const host = values.host ?? process.env['HOST'] ?? 'localhost';
 if (!existsSync(file)) {
-    console.log(`File ${file} not found`);
+    console.log(chalk.red(`File ${file} not found`));
     process.exit(1);
 }
 // Set up database
@@ -73,37 +74,66 @@ const db = new Low(observer, {});
 await db.read();
 // Create app
 const app = createApp(db, { logger: false, static: values.static });
-function routes(db) {
-    return Object.keys(db.data).map((key) => `http://${host}:${port}/${key}`);
+function logRoutes(data) {
+    console.log([
+        chalk.bold('Endpoints:'),
+        ...Object.keys(data).map((key) => `${chalk.gray(`http://${host}:${port}/`)}${chalk.blue(key)}`),
+    ].join('\n'));
 }
+const kaomojis = ['♡⸜(˶˃ ᵕ ˂˶)⸝♡', '♡( ◡‿◡ )', '( ˶ˆ ᗜ ˆ˵ )', '(˶ᵔ ᵕ ᵔ˶)'];
+function randomItem(items) {
+    const index = Math.floor(Math.random() * items.length);
+    return items.at(index) ?? '';
+}
+app.listen(port, () => {
+    console.log([
+        chalk.bold(`JSON Server started on PORT :${port}`),
+        chalk.gray('Press CTRL-C to stop'),
+        chalk.gray(`Watching ${file}...`),
+        '',
+        chalk.magenta(randomItem(kaomojis)),
+        '',
+        chalk.bold('Index:'),
+        chalk.gray(`http://localhost:${port}/`),
+        '',
+        chalk.bold('Static files:'),
+        chalk.gray('Serving ./public directory if it exists'),
+        '',
+    ].join('\n'));
+    logRoutes(db.data);
+});
 // Watch file for changes
 if (process.env['NODE_ENV'] !== 'production') {
     let writing = false; // true if the file is being written to by the app
+    let prevEndpoints = '';
     observer.onWriteStart = () => {
         writing = true;
     };
     observer.onWriteEnd = () => {
         writing = false;
     };
-    observer.onReadStart = () => console.log(`Reloading ${file}...`);
-    observer.onReadEnd = () => console.log('Reloaded');
+    observer.onReadStart = () => {
+        prevEndpoints = JSON.stringify(Object.keys(db.data).sort());
+    };
+    observer.onReadEnd = (data) => {
+        if (data === null) {
+            return;
+        }
+        const nextEndpoints = JSON.stringify(Object.keys(data).sort());
+        if (prevEndpoints !== nextEndpoints) {
+            console.log();
+            logRoutes(data);
+        }
+    };
     watch(file).on('change', () => {
         // Do no reload if the file is being written to by the app
         if (!writing) {
-            db.read()
-                .then(() => routes(db))
-                .catch((e) => {
+            db.read().catch((e) => {
                 if (e instanceof SyntaxError) {
-                    return console.log(e.message);
+                    return console.log(chalk.red(['', `Error parsing ${file}`, e.message].join('\n')));
                 }
                 console.log(e);
             });
         }
     });
 }
-app.listen(port, () => {
-    console.log(`Started on :${port}`);
-    console.log(`http://localhost:${port}/`);
-    console.log(routes(db).join('\n'));
-    console.log(`Watching ${file}...`);
-});

package/lib/observer.d.ts

@@ -2,7 +2,7 @@ import { Adapter } from 'lowdb';
 export declare class Observer<T> {
     #private;
     onReadStart: () => void;
-    onReadEnd: () => void;
+    onReadEnd: (data: T | null) => void;
     onWriteStart: () => void;
     onWriteEnd: () => void;
     constructor(adapter: Adapter<T>);

package/lib/observer.js

@@ -19,7 +19,7 @@ export class Observer {
     async read() {
         this.onReadStart();
         const data = await this.#adapter.read();
-        this.onReadEnd();
+        this.onReadEnd(data);
         return data;
     }
     async write(arg) {

package/lib/service.js

@@ -72,9 +72,28 @@ function deleteDependents(db, name, dependents) {
         }
     });
 }
+function randomId() {
+    return randomBytes(2).toString('hex');
+}
+function ensureItemsHaveIds(items) {
+    return items.map((item) => {
+        if (item['id'] === undefined) {
+            return { ...item, id: randomId() };
+        }
+        return item;
+    });
+}
+// Ensure all items have an id
+function ensureAllItemsHaveIds(data) {
+    return Object.entries(data).reduce((acc, [key, value]) => ({
+        ...acc,
+        [key]: Array.isArray(value) ? ensureItemsHaveIds(value) : value,
+    }), {});
+}
 export class Service {
     #db;
     constructor(db) {
+        db.data = ensureAllItemsHaveIds(db.data);
         this.#db = db;
     }
     #get(name) {
@@ -226,7 +245,7 @@ export class Service {
         const items = this.#get(name);
         if (items === undefined || !Array.isArray(items))
             return;
-        const item = { id: randomBytes(2).toString('hex'), ...data };
+        const item = { id: randomId(), ...data };
         items.push(item);
         await this.#db.write();
         return item;

package/lib/service.test.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 import test from 'node:test';
 import { Low, Memory } from 'lowdb';
 import { Service } from './service.js';
-const defaultData = { posts: [] };
+const defaultData = { posts: [], comments: [], object: {} };
 const adapter = new Memory();
 const db = new Low(adapter, defaultData);
 const service = new Service(db);
@@ -44,6 +44,16 @@ function reset() {
         object: obj,
     });
 }
+await test('constructor', () => {
+    const defaultData = { posts: [{ id: '1' }, {}], object: {} };
+    const db = new Low(adapter, defaultData);
+    new Service(db);
+    if (Array.isArray(db.data['posts'])) {
+        const id = db.data['posts']?.at(1)?.['id'];
+        assert.ok(id instanceof String, 'id should be a string');
+        assert.ok(id.length > 0, 'id should not be empty');
+    }
+});
 await test('findById', () => {
     reset();
     if (!Array.isArray(db.data?.[POSTS]))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-server",
-  "version": "1.0.0-alpha.10",
+  "version": "1.0.0-alpha.12",
   "description": "",
   "type": "module",
   "types": "lib",
@@ -39,6 +39,7 @@
   "dependencies": {
     "@tinyhttp/app": "^2.2.1",
     "@tinyhttp/cors": "^2.0.0",
+    "chalk": "^5.3.0",
     "chokidar": "^3.5.3",
     "dot-prop": "^8.0.2",
     "eta": "^3.2.0",