json-server 1.0.0-beta.6 → 1.0.0-beta.7

package/LICENSE

@@ -1,44 +1,21 @@
-Fair Source License, version 0.9
-
-Copyright (C) 2023-present typicode
-
-Licensor: typicode
-
-Software: json-server
-
-Use Limitation: 2 users
-
-License Grant. Licensor hereby grants to each recipient of the
-Software ("you") a non-exclusive, non-transferable, royalty-free and
-fully-paid-up license, under all of the Licensor's copyright and
-patent rights, to use, copy, distribute, prepare derivative works of,
-publicly perform and display the Software, subject to the Use
-Limitation and the conditions set forth below.
-
-Use Limitation. The license granted above allows use by up to the
-number of users per entity set forth above (the "Use Limitation"). For
-determining the number of users, "you" includes all affiliates,
-meaning legal entities controlling, controlled by, or under common
-control with you. If you exceed the Use Limitation, your use is
-subject to payment of Licensor's then-current list price for licenses.
-
-Conditions. Redistribution in source code or other forms must include
-a copy of this license document to be provided in a reasonable
-manner. Any redistribution of the Software is only allowed subject to
-this license.
-
-Trademarks. This license does not grant you any right in the
-trademarks, service marks, brand names or logos of Licensor.
-
-DISCLAIMER. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OR
-CONDITION, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. LICENSORS HEREBY DISCLAIM ALL LIABILITY, WHETHER IN
-AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE.
-
-Termination. If you violate the terms of this license, your rights
-will terminate automatically and will not be reinstated without the
-prior written consent of Licensor. Any such termination will not
-affect the right of others who may have received copies of the
-Software from you.
+MIT License
+
+Copyright (c) 2026 typicode
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -59,16 +59,26 @@ You can read more about JSON5 format [here](https://github.com/json5/json5).
 
 </details>
 
-Pass it to JSON Server CLI
+Start JSON Server
 
-```shell
-$ npx json-server db.json
+```bash
+npx json-server db.json
 ```
 
-Get a REST API
+This starts the server at `http://localhost:3000`. You should see:
+```
+JSON Server started on PORT :3000
+http://localhost:3000
+```
 
-```shell
-$ curl http://localhost:3000/posts/1
+Access your REST API:
+
+```bash
+curl http://localhost:3000/posts/1
+```
+
+**Response:**
+```json
 {
   "id": "1",
   "title": "a title",
@@ -103,28 +113,27 @@ Run `json-server --help` for a list of options
 
 [Become a sponsor and have your company logo here](https://github.com/users/typicode/sponsorship)
 
-## Sponsorware
-
-> [!NOTE]
-> This project uses the [Fair Source License](https://fair.io/). Only organizations with 3+ users are kindly asked to contribute a small amount through sponsorship [sponsor](https://github.com/sponsors/typicode) for usage. **This license helps keep the project sustainable and healthy, benefiting everyone.**
->
-> For more information, FAQs, and the rationale behind this, visit [https://fair.io/](https://fair.io/).
+## Query Capabilities
 
-## Query capabilities overview
+JSON Server supports advanced querying out of the box:
 
 ```http
-GET /posts?views:gt=100
-GET /posts?_sort=-views
-GET /posts?_page=1&_per_page=10
-GET /posts?_embed=comments
-GET /posts?_where={"or":[{"views":{"gt":100}},{"title":{"eq":"Hello"}}]}
+GET /posts?views:gt=100                  # Filter by condition
+GET /posts?_sort=-views                  # Sort by field (descending)
+GET /posts?_page=1&_per_page=10          # Pagination
+GET /posts?_embed=comments               # Include relations
+GET /posts?_where={"or":[...]}           # Complex queries
 ```
 
+See detailed documentation below for each feature.
+
 ## Routes
 
-For array resources (`posts`, `comments`):
+### Array Resources
+
+For array resources like `posts` and `comments`:
 
-```text
+```http
 GET    /posts
 GET    /posts/:id
 POST   /posts
@@ -133,9 +142,11 @@ PATCH  /posts/:id
 DELETE /posts/:id
 ```
 
-For object resources (`profile`):
+### Object Resources
+
+For singular object resources like `profile`:
 
-```text
+```http
 GET   /profile
 PUT   /profile
 PATCH /profile
@@ -153,12 +164,14 @@ Operators:
 - `lt` less than, `lte` less than or equal
 - `gt` greater than, `gte` greater than or equal
 - `eq` equal, `ne` not equal
+- `in` included in comma-separated list
 
 Examples:
 
 ```http
 GET /posts?views:gt=100
 GET /posts?title:eq=Hello
+GET /posts?id:in=1,2,3
 GET /posts?author.name:eq=typicode
 ```
 
@@ -176,8 +189,25 @@ GET /posts?_sort=author.name,-views
 GET /posts?_page=1&_per_page=25
 ```
 
-- `_per_page` default is `10`
-- invalid page/per_page values are normalized
+**Response:**
+```json
+{
+  "first": 1,
+  "prev": null,
+  "next": 2,
+  "last": 4,
+  "pages": 4,
+  "items": 100,
+  "data": [
+    { "id": "1", "title": "...", "views": 100 },
+    { "id": "2", "title": "...", "views": 200 }
+  ]
+}
+```
+
+**Notes:**
+- `_per_page` defaults to `10` if not specified
+- Invalid `_page` or `_per_page` values are automatically normalized to valid ranges
 
 ### Embed
 
@@ -200,20 +230,26 @@ GET /posts?_where={"or":[{"views":{"gt":100}},{"author":{"name":{"lt":"m"}}}]}
 DELETE /posts/1?_dependent=comments
 ```
 
-## Static files
+## Static Files
 
-JSON Server serves `./public` automatically.
+JSON Server automatically serves files from the `./public` directory.
 
-Add more static dirs:
+To serve additional static directories:
 
-```sh
-json-server -s ./static
-json-server -s ./static -s ./node_modules
+```bash
+json-server db.json -s ./static
+json-server db.json -s ./static -s ./node_modules
 ```
 
-## Behavior notes
+Static files are served with standard MIME types and can include HTML, CSS, JavaScript, images, and other assets.
+
+## Migration Notes (v0 → v1)
+
+If you are upgrading from json-server v0.x, note these behavioral changes:
+
+- **ID handling:** `id` is always a string and will be auto-generated if not provided
+- **Pagination:** Use `_per_page` with `_page` instead of the deprecated `_limit` parameter
+- **Relationships:** Use `_embed` instead of `_expand` for including related resources
+- **Request delays:** Use browser DevTools (Network tab > throttling) instead of the removed `--delay` CLI option
 
-- `id` is always a string and will be generated for you if missing
-- use `_per_page` with `_page` instead of `_limit`for pagination
-- use `_embed` instead of `_expand`
-- use Chrome's `Network tab > throtling` to delay requests instead of `--delay` CLI option
+> **New to json-server?** These notes are for users migrating from v0. If this is your first time using json-server, you can ignore this section.

package/lib/matches-where.js

@@ -48,6 +48,11 @@ export function matchesWhere(obj, where) {
                     return false;
                 if (knownOps.includes('ne') && !(field !== op.ne))
                     return false;
+                if (knownOps.includes('in')) {
+                    const inValues = Array.isArray(op.in) ? op.in : [op.in];
+                    if (!inValues.some((v) => field === v))
+                        return false;
+                }
                 continue;
             }
             if (isJSONObject(field)) {

package/lib/parse-where.js

@@ -23,6 +23,10 @@ function splitKey(key) {
 }
 function setPathOp(root, path, op, value) {
     const fullPath = `${path}.${op}`;
+    if (op === 'in') {
+        setProperty(root, fullPath, value.split(',').map((part) => coerceValue(part.trim())));
+        return;
+    }
     setProperty(root, fullPath, coerceValue(value));
 }
 function coerceValue(value) {

package/lib/where-operators.js

@@ -1,4 +1,4 @@
-export const WHERE_OPERATORS = ['lt', 'lte', 'gt', 'gte', 'eq', 'ne'];
+export const WHERE_OPERATORS = ['lt', 'lte', 'gt', 'gte', 'eq', 'ne', 'in'];
 export function isWhereOperator(value) {
     return WHERE_OPERATORS.includes(value);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-server",
-  "version": "1.0.0-beta.6",
+  "version": "1.0.0-beta.7",
   "description": "",
   "keywords": [],
   "license": "SEE LICENSE IN ./LICENSE",