json-server 1.0.0-alpha.21 → 1.0.0-alpha.23

package/README.md

@@ -18,8 +18,8 @@ Create a `db.json` or `db.json5` file
 ```json
 {
   "posts": [
-    { "id": "1", "title": "a title" },
-    { "id": "2", "title": "another title" }
+    { "id": "1", "title": "a title", "views": 100 },
+    { "id": "2", "title": "another title", "views": 200 }
   ],
   "comments": [
     { "id": "1", "text": "a comment about post 1", "postId": "1" },
@@ -38,8 +38,8 @@ Create a `db.json` or `db.json5` file
 ```json5
 {
   posts: [
-    { id: '1', title: 'a title' },
-    { id: '2', title: 'another title' },
+    { id: '1', title: 'a title', views: 100 },
+    { id: '2', title: 'another title', views: 200 },
   ],
   comments: [
     { id: '1', text: 'a comment about post 1', postId: '1' },
@@ -153,9 +153,9 @@ GET /posts?_sort=id,-views
 - `x.y.z[i]...`
 
 ```
-GET /posts?author.name=foo
-GET /posts?author.email=foo
-GET /posts?tags[0]=foo
+GET /foo?a.b=bar
+GET /foo?x.y_lt=100
+GET /foo?arr[0]=bar
 ```
 
 ### Embed
@@ -169,7 +169,7 @@ GET /comments?_embed=post
 
 ```
 DELETE /posts/1
-DELETE /posts/1?_embed=comments
+DELETE /posts/1?_dependent=comments
 ```
 
 ## Serving static files

package/lib/app.js

@@ -18,7 +18,7 @@ export function createApp(db, options = {}) {
     // Create app
     const app = new App();
     // Static files
-    app.use(sirv(join(__dirname, '../public'), { dev: !isProduction }));
+    app.use(sirv('public', { dev: !isProduction }));
     options.static
         ?.map((path) => (isAbsolute(path) ? path : join(process.cwd(), path)))
         .forEach((dir) => app.use(sirv(dir, { dev: !isProduction })));
@@ -29,7 +29,17 @@ export function createApp(db, options = {}) {
     app.get('/', (_req, res) => res.send(eta.render('index.html', { data: db.data })));
     app.get('/:name', (req, res, next) => {
         const { name = '' } = req.params;
-        res.locals['data'] = service.find(name, req.query);
+        const query = Object.fromEntries(Object.entries(req.query)
+            .map(([key, value]) => {
+            if (['_start', '_end', '_limit', '_page', '_per_page'].includes(key) && typeof value === 'string') {
+                return [key, parseInt(value)];
+            }
+            else {
+                return [key, value];
+            }
+        })
+            .filter(([_, value]) => !Number.isNaN(value)));
+        res.locals['data'] = service.find(name, query);
         next();
     });
     app.get('/:name/:id', (req, res, next) => {
@@ -74,7 +84,7 @@ export function createApp(db, options = {}) {
     });
     app.delete('/:name/:id', async (req, res, next) => {
         const { name = '', id = '' } = req.params;
-        res.locals['data'] = await service.destroyById(name, id);
+        res.locals['data'] = await service.destroyById(name, id, req.query['dependent']);
         next();
     });
     app.use('/:name', (req, res) => {

package/lib/service.d.ts

@@ -21,8 +21,7 @@ export declare class Service {
     }): Item | undefined;
     find(name: string, query?: {
         [key: string]: unknown;
-    } & {
-        _embed?: string[];
+        _embed?: string | string[];
         _sort?: string;
         _start?: number;
         _end?: number;
@@ -35,5 +34,5 @@ export declare class Service {
     patch(name: string, body?: Item): Promise<Item | undefined>;
     updateById(name: string, id: string, body?: Item): Promise<Item | undefined>;
     patchById(name: string, id: string, body?: Item): Promise<Item | undefined>;
-    destroyById(name: string, id: string, dependents?: string[]): Promise<Item | undefined>;
+    destroyById(name: string, id: string, dependent?: string | string[]): Promise<Item | undefined>;
 }

package/lib/service.js

@@ -224,11 +224,14 @@ export class Service {
         const start = query._start;
         const end = query._end;
         const limit = query._limit;
-        if (start === undefined && limit) {
-            return sorted.slice(0, limit);
+        if (start !== undefined) {
+            if (end !== undefined) {
+                return sorted.slice(start, end);
+            }
+            return sorted.slice(start, start + (limit || 0));
         }
-        if (start && limit) {
-            return sorted.slice(start, start + limit);
+        if (limit !== undefined) {
+            return sorted.slice(0, limit);
         }
         // Paginate
         let page = query._page;
@@ -299,7 +302,7 @@ export class Service {
     async patchById(name, id, body = {}) {
         return this.#updateOrPatchById(name, id, body, true);
     }
-    async destroyById(name, id, dependents = []) {
+    async destroyById(name, id, dependent) {
         const items = this.#get(name);
         if (items === undefined || !Array.isArray(items))
             return;
@@ -309,6 +312,7 @@ export class Service {
         const index = items.indexOf(item);
         items.splice(index, 1)[0];
         nullifyForeignKey(this.#db, name, id);
+        const dependents = ensureArray(dependent);
         deleteDependents(this.#db, name, dependents);
         await this.#db.write();
         return item;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-server",
-  "version": "1.0.0-alpha.21",
+  "version": "1.0.0-alpha.23",
   "description": "",
   "type": "module",
   "bin": {
@@ -9,21 +9,17 @@
   "types": "lib",
   "files": [
     "lib",
-    "public",
     "views"
   ],
   "engines": {
     "node": ">=18.3"
   },
   "scripts": {
-    "css": "tailwindcss -i ./views/input.css -o ./public/output.css",
-    "watch-ts": "tsx watch src/bin.ts fixtures/db.json",
-    "watch-css": "npm run css -- --watch",
-    "dev": "concurrently npm:watch-*",
-    "build": "rm -rf lib && tsc && npm run css",
-    "test": "npm run css && node --import tsx/esm --test src/*.test.ts",
+    "dev": "tsx watch src/bin.ts fixtures/db.json",
+    "build": "rm -rf lib && tsc",
+    "test": "node --import tsx/esm --test src/*.test.ts",
     "lint": "eslint src --ext .ts --ignore-path .gitignore",
-    "prepare": "husky install",
+    "prepare": "husky",
     "prepublishOnly": "npm run build"
   },
   "keywords": [],
@@ -32,15 +28,14 @@
   "devDependencies": {
     "@sindresorhus/tsconfig": "^5.0.0",
     "@tailwindcss/typography": "^0.5.10",
-    "@types/node": "^20.11.0",
+    "@types/node": "^20.11.7",
     "@typicode/eslint-config": "^1.2.0",
     "concurrently": "^8.2.2",
     "get-port": "^7.0.0",
-    "husky": "^8.0.3",
-    "tailwindcss": "^3.4.1",
+    "husky": "^9.0.6",
     "tempy": "^3.1.0",
     "tsx": "^4.7.0",
-    "type-fest": "^4.9.0",
+    "type-fest": "^4.10.1",
     "typescript": "^5.3.3"
   },
   "dependencies": {

package/views/index.html

@@ -4,38 +4,94 @@
 <head>
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <link href="/output.css" rel="stylesheet" />
+  <style>
+    html {
+      font-size: 16px;
+      line-height: 1.5;
+      background-color: #fff;
+      color: #000;
+    }
+
+    body {
+      margin: 0 auto;
+      max-width: 720px;
+      padding: 0 16px;
+      font-family: sans-serif;
+    }
+
+    a {
+      color: #db2777;
+      text-decoration: none;
+    }
+
+    header {
+      margin-bottom: 32px;
+      padding: 16px 0;
+    }
+
+    nav {
+      display: flex;
+      justify-content: space-between;
+    }
+
+    nav div a {
+      margin-left: 16px;
+    }
+
+    ul {
+      margin: 0;
+      padding: 0;
+      list-style: none;
+    }
+
+    li {
+      margin-bottom: 8px;
+    }
+
+    /* Dark mode styles */
+    @media (prefers-color-scheme: dark) {
+      html {
+        background-color: #1e293b;
+        color: #fff;
+      }
+
+      a {
+
+      }
+    }
+
+  </style>
 </head>
 
-<body class="container mx-auto prose dark:prose-invert dark:bg-slate-900 pt-6 bg-white text-slate-900">
+<body>
   <header>
-    <nav class="mx-auto flex items-center justify-between">
+    <nav>
       <strong>JSON Server</strong>
-      <div class="flex gap-x-6">
-        <a href="https://github.com/typicode/json-server">
-          <span class="ml-2">Docs</span>
-        </a>
-        <a href="https://github.com/sponsors/typicode" class="text-red-500 font-semibold">
-          <span class="ml-2">♡ Sponsor</span>
-        </a>
+      <div>
+        <a href="https://github.com/typicode/json-server">Docs</a>
+        <a href="https://github.com/sponsors/typicode">♡ Sponsor</a>
       </div>
     </nav>
   </header>
   <main class="my-12">
     <p class="bg-gradient-to-r from-purple-500 via-pink-500 to-red-500 text-transparent bg-clip-text">✧*｡٩(ˊᗜˋ*)و✧*｡</p>
-    <% if (Object.keys(it.data).length === 0) { %>
+    <% if (Object.keys(it.data).length===0) { %>
       <p>No resources found in JSON file</p>
     <% } %>
     <% Object.entries(it.data).forEach(function([name]) { %>
-      <div class="py-1">
-        <a href="<%= name %>">/<%= name %></a>
-        <span class="text-gray-500">
-          <% if (Array.isArray(it.data[name])) { %>
-           - <%= it.data[name].length %> items</span>
+      <ul>
+        <li>
+          <a href="<%= name %>">/<%= name %></a>
+          <span>
+            <% if (Array.isArray(it.data[name])) { %>
+              - <%= it.data[name].length %>
+                <%= it.data[name].length> 1 ? 'items' : 'item' %>
+          </span>
           <% } %>
-      </div>
+        </li>
+      </ul>
     <% }) %>
   </main>
 </body>
 
-</html>
+</html>