360-mock-server 1.2.5 → 1.2.6

package/README.md

@@ -1,225 +1,153 @@
 # 🚀 360 Mock Server
 
-**360 Mock Server** is a zero-configuration mock REST API designed for frontend developers.
-It allows you to instantly create and manage RESTful APIs **without building a backend**, making it ideal for frontend development, testing, demos, and rapid prototyping.
+**360 Mock Server** is a zero-config mock REST API for frontend developers.
+Create, update, delete, paginate, and auto-generate fake data **without building a backend**.
 
-Now with **Faker.js integration** for automatic fake data generation!
+Perfect for **React / React Native / Redux / demos / testing**.
 
 
-## ✨ Why 360 Mock Server?
+## ✨ Features
 
-* No backend setup required
-* Works instantly with **any endpoint**
-* **Auto-generate fake data** with Faker.js
+* Zero configuration
+* Works with **any REST endpoint**
+* Full CRUD (GET, POST, PUT, PATCH, DELETE)
+* **Fake data generation (Faker.js)**
+* **Pagination support**
+* Persistent JSON storage
 * Interactive CLI + REST API
-* Persistent JSON-based storage
-* Ideal for React, React Native, Vue, Angular, Redux apps
+* CORS enabled
 
 
 ## 📦 Installation
 
-Install globally using npm:
-
 ```bash
 npm install -g 360-mock-server
-```
-
-Or run directly using `npx` (recommended):
-
-```bash
+# or
 npx 360-mock-server
 ```
 
 
-## ⚡ Quick Start
+## ⚡ Start Server
 
 ```bash
 npx 360-mock-server
 ```
 
-That’s it! 🎉
-The mock server will start at:
+Server runs at:
 
 ```
 http://localhost:5050
 ```
 
 
-## 🧠 Interactive CLI Mode
-
-Once the server starts, you can interact with it directly from the terminal:
-
-```text
-360-mock> POST /users {"name": "Ali", "email": "ali@test.com"}
-✅ Status: 201
-{"id": 1737745200000, "name": "Ali", "email": "ali@test.com"}
-
-360-mock> GET /users
-✅ Status: 200
-[{"id": 1737745200000, "name": "Ali", "email": "ali@test.com"}]
-
-360-mock> DELETE /users/1737745200000
-✅ Status: 200
-```
-
-
-## 📟 CLI Commands (Interactive Mode)
-
-| Command                                | Description                  |
-| -------------------------------------- | ---------------------------- |
-| `GET /users`                           | Fetch all users              |
-| `GET /users/123`                       | Fetch user by ID             |
-| `POST /users {"name":"Ali"}`           | Create a new user            |
-| `PUT /users/123 {"name":"New"}`        | Replace entire resource      |
-| `PATCH /users/123 {"email":"x@y.com"}` | Update specific fields       |
-| `DELETE /users/123`                    | Delete resource              |
-| `list`                                 | Show all available resources |
-| `clear`                                | Clear terminal screen        |
-| `help`                                 | Show help                    |
-| `exit`                                 | Exit interactive mode        |
-
-## 🧪 Using with Postman / REST Clients
-
-**Base URL**
+## 🧠 Manual + Faker + Pagination (All-in-One)
 
-```
-http://localhost:5050
-```
+### ▶️ Manual CRUD (Normal API)
 
-### Example Endpoints
+```bash
+POST /users
+{ "name": "Ali", "email": "ali@test.com" }
 
-| Method | Endpoint     | Body                          |
-| ------ | ------------ | ----------------------------- |
-| GET    | `/users`     | —                             |
-| GET    | `/users/123` | —                             |
-| POST   | `/users`     | `{ "name": "Ali" }`           |
-| PUT    | `/users/123` | `{ "name": "Updated" }`       |
-| PATCH  | `/users/123` | `{ "email": "new@test.com" }` |
-| DELETE | `/users/123` | —                             |
+GET /users
+GET /users/123
 
-**Required Headers**
+PATCH /users/123
+{ "email": "new@test.com" }
 
-```
-Content-Type: application/json
+DELETE /users/123
 ```
 
+### 🎲 Faker.js – Auto Generate Fake Data
 
-## 🎲 Auto-Generate Fake Data with Faker.js
-
-Generate realistic fake data instantly! Just send a POST request with `fields` array:
-
-### Generate 10 Users (default count)
+Just send `fields` array:
 
 ```bash
 POST /users
 {
-  "fields": ["name", "email", "avatar", "phone"]
+  "fields": ["name", "email", "avatar", "phone"],
+  "count": 10
 }
 ```
 
-### Generate 50 Products with custom count
+Works for **any resource**:
 
 ```bash
 POST /products
 {
-  "fields": ["productName", "price", "category", "description", "image"],
-  "count": 50
+  "fields": ["productName", "price", "category"],
+  "count": 20
 }
 ```
 
-### Available Faker Fields
-
-| Category    | Fields                                                                 |
-| ----------- | ---------------------------------------------------------------------- |
-| **Person**  | `name`, `firstName`, `lastName`, `username`, `email`, `phone`, `avatar`, `bio`, `jobTitle`, `gender` |
-| **Location**| `address`, `city`, `state`, `country`, `zipCode`, `latitude`, `longitude` |
-| **Company** | `company`, `companyName`, `department`                                 |
-| **Internet**| `website`, `url`, `ip`, `password`                                     |
-| **Content** | `title`, `description`, `body`, `text`, `sentence`, `paragraph`, `slug`|
-| **Commerce**| `price`, `product`, `productName`, `productDescription`, `category`    |
-| **Images**  | `image`, `imageUrl`                                                    |
-| **Dates**   | `date`, `pastDate`, `futureDate`, `birthDate`                          |
-| **Numbers** | `number`, `age`, `rating`, `quantity`                                  |
-| **Boolean** | `boolean`, `isActive`, `isVerified`                                    |
-| **Misc**    | `uuid`, `color`, `word`, `words`                                       |
-
-### Get All Available Fields
+Get all supported faker fields:
 
 ```bash
 GET /faker/fields
 ```
 
-> **Note:** If your POST body contains a `fields` array, it generates fake data. Otherwise, it creates a single item with your provided key-value pairs.
+### 📄 Pagination (Built-in)
 
+```bash
+GET /users?_page=1&_limit=5
+```
 
-## 🔌 Frontend Integration Examples
+Response:
 
-<details open>
-<summary><strong>Fetch API</strong></summary>
+```json
+{
+  "data": [...],
+  "pagination": {
+    "page": 1,
+    "limit": 5,
+    "totalItems": 20,
+    "totalPages": 4,
+    "hasNextPage": true,
+    "hasPrevPage": false
+  }
+}
+```
 
-```javascript
-const API = 'http://localhost:5050';
+* Pagination works on **any resource**
+* If `_limit` is missing → returns full array
 
-// CREATE
-await fetch(`${API}/users`, {
-  method: 'POST',
-  headers: { 'Content-Type': 'application/json' },
-  body: JSON.stringify({ name: 'Ali', email: 'ali@test.com' })
-});
 
-// READ
-const users = await fetch(`${API}/users`).then(res => res.json());
+## 💻 Frontend Usage
 
-// UPDATE
-await fetch(`${API}/users/123`, {
-  method: 'PATCH',
-  headers: { 'Content-Type': 'application/json' },
-  body: JSON.stringify({ name: 'Updated' })
-});
+### Fetch
 
-// DELETE
-await fetch(`${API}/users/123`, { method: 'DELETE' });
+```js
+fetch('http://localhost:5050/users')
+  .then(res => res.json())
+  .then(console.log);
 ```
 
-</details>
-
-<details>
-<summary><strong>Axios</strong></summary>
-
-```javascript
-import axios from 'axios';
+### Axios
 
-const API = 'http://localhost:5050';
-
-// CREATE
-await axios.post(`${API}/users`, {
-  name: 'Ali',
-  email: 'ali@test.com'
+```js
+axios.get('http://localhost:5050/users', {
+  params: { _page: 1, _limit: 10 }
 });
+```
 
-// READ
-const { data: users } = await axios.get(`${API}/users`);
 
-// UPDATE
-await axios.patch(`${API}/users/123`, {
-  name: 'Updated'
-});
+## 🖥 Interactive CLI
 
-// DELETE
-await axios.delete(`${API}/users/123`);
-```
+After starting server:
 
-</details>
+```text
+360-mock> POST /users {"name":"Ali"}
+360-mock> GET /users
+360-mock> DELETE /users/123
+```
 
+Commands:
 
-## ⚙️ CLI Options
+* `list` – list resources
+* `clear` – clear terminal
+* `exit` – quit
 
-| Option   | Description    | Default          |
-| -------- | -------------- | ---------------- |
-| `--port` | Server port    | `5050`           |
-| `--file` | Data file name | `mock-data.json` |
 
-### Examples
+## ⚙️ Options
 
 ```bash
 npx 360-mock-server --port 4000
@@ -227,43 +155,16 @@ npx 360-mock-server --file db.json
 ```
 
 
-## 🛠 Additional Commands
-
-| Command          | Description                             |
-| ---------------- | --------------------------------------- |
-| `360-mock start` | Start server only (no interactive mode) |
-| `360-mock init`  | Create an empty data file               |
-| `360-mock list`  | List all resources                      |
-| `360-mock reset` | Clear all stored data                   |
-
+## 💾 Storage
 
-## 🌟 Features
-
-* ✅ Zero-config setup
-* ✅ Supports **any REST endpoint**
-* ✅ Full CRUD operations
-* ✅ **Auto-generate fake data** with Faker.js
-* ✅ Auto-generated unique IDs
-* ✅ Automatic timestamps (`createdAt`, `updatedAt`)
-* ✅ Persistent JSON storage
-* ✅ CORS enabled
-* ✅ Works with Postman & frontend apps
-* ✅ Perfect for mock APIs & demos
-
-
-## 💾 Data Storage
-
-All data is stored locally in:
+Data is stored locally in:
 
 ```
 mock-data.json
 ```
 
-This file is automatically created and updated in your project directory.
-
-## 📄 License
-
-This package is under the premises of **360XpertSolution** and built by **zahidrahimoon**.
+## 🪪 License
 
-MIT © [zahidrahimoon](https://github.com/zahidrahimoon/)
+MIT © **360XpertSolution**
+Built by **zahidrahimoon**
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "360-mock-server",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "🚀 Zero-config dynamic mock REST API server with Faker.js auto-generation for frontend developers",
   "main": "lib/server.js",
   "bin": {