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

package/README.md

@@ -8,7 +8,7 @@
 ## Install
 
 ```shell
-npm install json-server@alpha
+npm install json-server
 ```
 
 ## Usage
@@ -49,17 +49,20 @@ $ curl 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> |
-
+|  <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
@@ -67,6 +70,8 @@ POST   /posts
 PUT    /posts/:id
 PATCH  /posts/:id
 DELETE /posts/:id
+
+# Same for comments
 ```
 
 ```
@@ -126,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

@@ -81,14 +81,17 @@ function logRoutes(data) {
     ].join('\n'));
 }
 const kaomojis = ['♡⸜(˶˃ ᵕ ˂˶)⸝♡', '♡( ◡‿◡ )', '( ˶ˆ ᗜ ˆ˵ )', '(˶ᵔ ᵕ ᵔ˶)'];
-// Get system current language
+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(kaomojis[Math.floor(Math.random() * kaomojis.length)]),
+        chalk.magenta(randomItem(kaomojis)),
         '',
         chalk.bold('Index:'),
         chalk.gray(`http://localhost:${port}/`),

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.11",
+  "version": "1.0.0-alpha.12",
   "description": "",
   "type": "module",
   "types": "lib",