360-mock-server 1.0.1 → 1.1.1

package/README.md

@@ -1,183 +1,215 @@
-# 🚀 Mock API Server
+# 🚀 360 Mock Server
 
-Zero-config dynamic mock REST API server. Perfect for frontend development when backend isn't ready.
+**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.
 
-## Installation
 
-```bash
-# Global installation (recommended)
-npm install -g 360-mock-server
+## ✨ Why 360 Mock Server?
 
-# Or use npx directly
-npx 360-mock-server start
-```
+* No backend setup required
+* Works instantly with **any endpoint**
+* Interactive CLI + REST API
+* Persistent JSON-based storage
+* Ideal for React, React Native, Vue, Angular, Redux apps
 
-## Quick Start
 
-```bash
-# Navigate to your project
-cd my-frontend-project
+## 📦 Installation
 
-# Initialize (creates mock-data.json)
-360-mock init
+Install globally using npm:
 
-# Start server
-360-mock start
+```bash
+npm install -g 360-mock-server
 ```
 
-Server runs at `http://localhost:3000`
+Or run directly using `npx` (recommended):
 
----
-
-## CLI Commands
+```bash
+npx 360-mock-server
+```
 
-| Command | Description |
-|---------|-------------|
-| `360-mock start` | Start the server |
-| `360-mock init` | Create mock-data.json |
-| `360-mock list` | Show available resources |
-| `360-mock reset` | Clear all data |
-| `360-mock req` | Make API requests |
 
-### Options
+## ⚡ Quick Start
 
 ```bash
-360-mock start --port 4000       # Custom port
-360-mock start --file db.json    # Custom data file
-360-mock --help                  # Show help
-360-mock --version               # Show version
+npx 360-mock-server
 ```
 
----
+That’s it! 🎉
+The mock server will start at:
 
-## Making API Requests (Easy Way!)
+```
+http://localhost:3000
+```
 
-Use the built-in `req` command instead of curl:
 
-```bash
-# CREATE
-360-mock req POST /users '{"name": "Ali", "email": "ali@test.com"}'
-360-mock req POST /products '{"name": "Laptop", "price": 999}'
-360-mock req POST /orders '{"product": "Laptop", "qty": 2}'
+## 🧠 Interactive CLI Mode
 
-# READ ALL
-360-mock req GET /users
-360-mock req GET /products
+Once the server starts, you can interact with it directly from the terminal:
 
-# READ ONE
-360-mock req GET /users/1234567890
+```text
+360-mock> POST /users {"name": "Ali", "email": "ali@test.com"}
+✅ Status: 201
+{"id": 1737745200000, "name": "Ali", "email": "ali@test.com"}
 
-# UPDATE
-360-mock req PUT /users/1234567890 '{"name": "Ali Khan"}'
-360-mock req PATCH /users/1234567890 '{"email": "ali.khan@test.com"}'
+360-mock> GET /users
+✅ Status: 200
+[{"id": 1737745200000, "name": "Ali", "email": "ali@test.com"}]
 
-# DELETE
-360-mock req DELETE /users/1234567890
+360-mock> DELETE /users/1737745200000
+✅ Status: 200
 ```
 
----
 
-## API Endpoints
+## 📟 CLI Commands (Interactive Mode)
 
-### Any endpoint works automatically!
+| 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        |
 
-Just POST to any endpoint - it creates the resource:
+## 🧪 Using with Postman / REST Clients
+
+**Base URL**
 
-```bash
-# These all work without configuration:
-POST /users
-POST /products  
-POST /orders
-POST /anything-you-want
+```
+http://localhost:3000
 ```
 
-### Full CRUD Operations
+### Example Endpoints
 
-| Method | Endpoint | Description |
-|--------|----------|-------------|
-| GET | `/users` | Get all users |
-| GET | `/users/1` | Get user by ID |
-| POST | `/users` | Create user |
-| PUT | `/users/1` | Replace user |
-| PATCH | `/users/1` | Update user |
-| DELETE | `/users/1` | Delete user |
-| DELETE | `/users` | Delete all users |
+| 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` | —                             |
 
-### Query Parameters
+**Required Headers**
 
-```bash
-GET /users?name=john           # Filter by name
-GET /users?_sort=name          # Sort by field
-GET /users?_order=desc         # Sort order
-GET /users?_limit=10&_page=2   # Pagination
+```
+Content-Type: application/json
 ```
 
----
 
-## Frontend Examples
+## 🔌 Frontend Integration Examples
 
-### Fetch API
+<details open>
+<summary><strong>Fetch API</strong></summary>
 
 ```javascript
-// Create
-const user = await fetch('http://localhost:3000/users', {
+const API = 'http://localhost:3000';
+
+// CREATE
+await fetch(`${API}/users`, {
   method: 'POST',
   headers: { 'Content-Type': 'application/json' },
   body: JSON.stringify({ name: 'Ali', email: 'ali@test.com' })
-}).then(r => r.json());
-
-// Read all
-const users = await fetch('http://localhost:3000/users').then(r => r.json());
+});
 
-// Read one
-const user = await fetch('http://localhost:3000/users/1').then(r => r.json());
+// READ
+const users = await fetch(`${API}/users`).then(res => res.json());
 
-// Update
-await fetch('http://localhost:3000/users/1', {
+// UPDATE
+await fetch(`${API}/users/123`, {
   method: 'PATCH',
   headers: { 'Content-Type': 'application/json' },
-  body: JSON.stringify({ name: 'Ali Updated' })
+  body: JSON.stringify({ name: 'Updated' })
 });
 
-// Delete
-await fetch('http://localhost:3000/users/1', { method: 'DELETE' });
+// DELETE
+await fetch(`${API}/users/123`, { method: 'DELETE' });
 ```
 
-### Axios
+</details>
+
+<details>
+<summary><strong>Axios</strong></summary>
 
 ```javascript
 import axios from 'axios';
-const api = axios.create({ baseURL: 'http://localhost:3000' });
 
-// Create
-const { data: user } = await api.post('/users', { name: 'Ali' });
+const API = 'http://localhost:3000';
 
-// Read
-const { data: users } = await api.get('/users');
+// CREATE
+await axios.post(`${API}/users`, {
+  name: 'Ali',
+  email: 'ali@test.com'
+});
+
+// READ
+const { data: users } = await axios.get(`${API}/users`);
+
+// UPDATE
+await axios.patch(`${API}/users/123`, {
+  name: 'Updated'
+});
+
+// DELETE
+await axios.delete(`${API}/users/123`);
+```
 
-// Update
-await api.patch(`/users/${id}`, { name: 'Updated' });
+</details>
 
-// Delete
-await api.delete(`/users/${id}`);
+
+## ⚙️ CLI Options
+
+| Option   | Description    | Default          |
+| -------- | -------------- | ---------------- |
+| `--port` | Server port    | `3000`           |
+| `--file` | Data file name | `mock-data.json` |
+
+### Examples
+
+```bash
+npx 360-mock-server --port 4000
+npx 360-mock-server --file db.json
 ```
 
----
 
-## Features
+## 🛠 Additional Commands
 
-- ✅ **Zero config** - Works out of the box
-- ✅ **Any endpoint** - Auto-creates resources
-- ✅ **Full CRUD** - GET, POST, PUT, PATCH, DELETE
-- ✅ **Filtering** - Query parameter support
-- ✅ **Sorting** - `?_sort=field&_order=desc`
-- ✅ **Pagination** - `?_limit=10&_page=1`
-- ✅ **Auto IDs** - Generated automatically
-- ✅ **Timestamps** - createdAt, updatedAt
-- ✅ **CORS enabled** - Works with any frontend
+| 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                   |
 
----
 
-## License
+## 🌟 Features
+
+* ✅ Zero-config setup
+* ✅ Supports **any REST endpoint**
+* ✅ Full CRUD operations
+* ✅ 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:
+
+```
+mock-data.json
+```
+
+This file is automatically created and updated in your project directory.
+
+## 📄 License
 
 MIT © [zahidrahimoon](https://github.com/zahidrahimoon)
+

package/bin/cli.js

@@ -4,22 +4,204 @@ const { program } = require("commander");
 const path = require("path");
 const fs = require("fs");
 const http = require("http");
+const readline = require("readline");
 
 const packageJson = require("../package.json");
 
+// Helper function for making HTTP requests
+function makeRequest(method, endpoint, data, port = "3000") {
+  return new Promise((resolve) => {
+    const upperMethod = method.toUpperCase();
+    const urlPath = endpoint.startsWith("/") ? endpoint : "/" + endpoint;
+    
+    let jsonData = null;
+    if (data) {
+      try {
+        jsonData = typeof data === "string" ? JSON.parse(data) : data;
+      } catch (e) {
+        console.log(`❌ Invalid JSON: ${data}`);
+        return resolve();
+      }
+    }
+
+    const reqOptions = {
+      hostname: "localhost",
+      port: port,
+      path: urlPath,
+      method: upperMethod,
+      headers: { "Content-Type": "application/json" },
+    };
+
+    console.log(`\n📤 ${upperMethod} ${urlPath}`);
+    if (jsonData) {
+      console.log(`   Body: ${JSON.stringify(jsonData)}`);
+    }
+
+    const req = http.request(reqOptions, (res) => {
+      let body = "";
+      res.on("data", (chunk) => { body += chunk; });
+      res.on("end", () => {
+        const emoji = res.statusCode >= 200 && res.statusCode < 300 ? "✅" : "❌";
+        console.log(`${emoji} Status: ${res.statusCode}`);
+        try {
+          const json = JSON.parse(body);
+          console.log(JSON.stringify(json, null, 2));
+        } catch {
+          console.log(body);
+        }
+        console.log("");
+        resolve();
+      });
+    });
+
+    req.on("error", (error) => {
+      console.error(`❌ Error: ${error.message}`);
+      console.log("💡 Make sure server is running in another terminal: 360-mock start\n");
+      resolve();
+    });
+
+    if (jsonData) req.write(JSON.stringify(jsonData));
+    req.end();
+  });
+}
+
+// Interactive REPL mode
+function startInteractiveMode(port) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  console.log(`
+╔═══════════════════════════════════════════════════════════╗
+║           🚀 360 Mock Server - Interactive Mode           ║
+╠═══════════════════════════════════════════════════════════╣
+║  Server: http://localhost:${port}                            ║
+╚═══════════════════════════════════════════════════════════╝
+
+📌 Commands:
+   GET /users                         - Get all users
+   GET /users/123                     - Get user by ID
+   POST /users {"name":"Ali"}         - Create user
+   PUT /users/123 {"name":"Updated"}  - Replace user
+   PATCH /users/123 {"name":"New"}    - Update user
+   DELETE /users/123                  - Delete user
+   
+   list                               - Show resources
+   clear                              - Clear screen
+   help                               - Show this help
+   exit                               - Exit
+
+`);
+
+  const prompt = () => {
+    rl.question("360-mock> ", async (input) => {
+      const trimmed = input.trim();
+      
+      if (!trimmed) {
+        prompt();
+        return;
+      }
+
+      // Handle special commands
+      if (trimmed === "exit" || trimmed === "quit") {
+        console.log("� Goodbye!");
+        rl.close();
+        process.exit(0);
+      }
+
+      if (trimmed === "help") {
+        console.log(`
+📌 Commands:
+   GET /users                         - Get all users
+   GET /users/123                     - Get user by ID  
+   POST /users {"name":"Ali"}         - Create user
+   PUT /users/123 {"name":"Updated"}  - Replace user
+   PATCH /users/123 {"name":"New"}    - Update user
+   DELETE /users/123                  - Delete user
+   
+   list                               - Show resources
+   clear                              - Clear screen
+   exit                               - Exit
+`);
+        prompt();
+        return;
+      }
+
+      if (trimmed === "clear" || trimmed === "cls") {
+        console.clear();
+        prompt();
+        return;
+      }
+
+      if (trimmed === "list") {
+        await makeRequest("GET", "/", null, port);
+        prompt();
+        return;
+      }
+
+      // Parse API request: METHOD /endpoint {json}
+      const match = trimmed.match(/^(GET|POST|PUT|PATCH|DELETE)\s+(\/\S*)\s*(.*)$/i);
+      
+      if (match) {
+        const [, method, endpoint, jsonStr] = match;
+        await makeRequest(method, endpoint, jsonStr || null, port);
+      } else {
+        console.log(`❌ Invalid command. Type 'help' for usage.\n`);
+      }
+
+      prompt();
+    });
+  };
+
+  prompt();
+}
+
 program
   .name("360-mock")
-  .description("🚀 Dynamic Mock REST API Server - Zero Config")
+  .description("�🚀 Dynamic Mock REST API Server - Zero Config")
   .version(packageJson.version);
 
+// Default command - start interactive mode
+program
+  .command("run", { isDefault: true })
+  .description("Start server + interactive mode (recommended)")
+  .option("-p, --port <port>", "Port number", "3000")
+  .option("-f, --file <filename>", "Data file name", "mock-data.json")
+  .action((options) => {
+    const dataFile = path.join(process.cwd(), options.file);
+    
+    // Create data file if not exists
+    if (!fs.existsSync(dataFile)) {
+      fs.writeFileSync(dataFile, JSON.stringify({}, null, 2));
+      console.log(`✅ Created ${options.file}`);
+    }
+
+    process.env.PORT = options.port;
+    process.env.DATA_FILE = dataFile;
+    
+    // Start server
+    require("../lib/server");
+    
+    // Start interactive mode after a short delay
+    setTimeout(() => {
+      startInteractiveMode(options.port);
+    }, 500);
+  });
+
 program
   .command("start")
-  .description("Start the mock server")
+  .description("Start the mock server only (no interactive mode)")
   .option("-p, --port <port>", "Port number", "3000")
   .option("-f, --file <filename>", "Data file name", "mock-data.json")
   .action((options) => {
+    const dataFile = path.join(process.cwd(), options.file);
+    if (!fs.existsSync(dataFile)) {
+      fs.writeFileSync(dataFile, JSON.stringify({}, null, 2));
+      console.log(`✅ Created ${options.file}`);
+    }
     process.env.PORT = options.port;
-    process.env.DATA_FILE = path.join(process.cwd(), options.file);
+    process.env.DATA_FILE = dataFile;
     require("../lib/server");
   });
 
@@ -33,15 +215,9 @@ program
       console.log(`⚠️  ${options.file} already exists!`);
       return;
     }
-    const initialData = {
-      _info: "Add your mock data here. Each key becomes an API endpoint.",
-      users: [],
-      products: []
-    };
-    fs.writeFileSync(filePath, JSON.stringify(initialData, null, 2));
+    fs.writeFileSync(filePath, JSON.stringify({}, null, 2));
     console.log(`✅ Created ${options.file}`);
-    console.log(`\n📁 File location: ${filePath}`);
-    console.log(`\n🚀 Run '360-mock start' to start the server`);
+    console.log(`\n Run '360-mock' to start the server`);
   });
 
 program
@@ -65,13 +241,13 @@ program
   .action((options) => {
     const filePath = path.join(process.cwd(), options.file);
     if (!fs.existsSync(filePath)) {
-      console.log(`⚠️  ${options.file} not found! Run '360-mock init' first.`);
+      console.log(`⚠️  ${options.file} not found!`);
       return;
     }
     try {
       const data = JSON.parse(fs.readFileSync(filePath, "utf-8"));
       const resources = Object.keys(data).filter(k => !k.startsWith("_"));
-      console.log(`\n📦 Available Resources in ${options.file}:\n`);
+      console.log(`\n📦 Available Resources:\n`);
       if (resources.length === 0) {
         console.log("   No resources yet. POST to any endpoint to create one!");
       } else {
@@ -86,68 +262,13 @@ program
     }
   });
 
-// API Request command
+// API Request command (for non-interactive use)
 program
   .command("req <method> <endpoint> [data]")
-  .alias("request")
-  .description("Make API request (GET, POST, PUT, PATCH, DELETE)")
+  .description("Make single API request")
   .option("-p, --port <port>", "Server port", "3000")
-  .action((method, endpoint, data, options) => {
-    const upperMethod = method.toUpperCase();
-    const path = endpoint.startsWith("/") ? endpoint : "/" + endpoint;
-    
-    let jsonData = null;
-    if (data) {
-      try {
-        jsonData = JSON.parse(data);
-      } catch (e) {
-        console.log(`❌ Invalid JSON: ${data}`);
-        process.exit(1);
-      }
-    }
-
-    const reqOptions = {
-      hostname: "localhost",
-      port: options.port,
-      path: path,
-      method: upperMethod,
-      headers: {
-        "Content-Type": "application/json",
-      },
-    };
-
-    console.log(`\n📤 ${upperMethod} ${path}`);
-    if (jsonData) {
-      console.log(`   Body: ${JSON.stringify(jsonData, null, 2)}`);
-    }
-    console.log("");
-
-    const req = http.request(reqOptions, (res) => {
-      let body = "";
-      res.on("data", (chunk) => { body += chunk; });
-      res.on("end", () => {
-        const statusEmoji = res.statusCode >= 200 && res.statusCode < 300 ? "✅" : "❌";
-        console.log(`${statusEmoji} Status: ${res.statusCode}`);
-        console.log(`📥 Response:`);
-        try {
-          const json = JSON.parse(body);
-          console.log(JSON.stringify(json, null, 2));
-        } catch {
-          console.log(body);
-        }
-        console.log("");
-      });
-    });
-
-    req.on("error", (error) => {
-      console.error(`❌ Error: ${error.message}`);
-      console.log("\n💡 Make sure the server is running: 360-mock start\n");
-    });
-
-    if (jsonData) {
-      req.write(JSON.stringify(jsonData));
-    }
-    req.end();
+  .action(async (method, endpoint, data, options) => {
+    await makeRequest(method, endpoint, data, options.port);
   });
 
 program.parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "360-mock-server",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "🚀 Zero-config dynamic mock REST API server for frontend developers",
   "main": "lib/server.js",
   "bin": {