krsyer-server-monitor-pro 1.0.27 → 1.0.28

package/guestguru-api/API_DOCUMENTATION.md

@@ -1,504 +0,0 @@
-# PG Management System - Backend API
-
-## Overview
-This is a Node.js/Express backend for a SaaS-based PG Management application. It supports Authentication, Role-based access control (Superadmin, Admin, Customer), Room Management, and Payment processing (Stubbed/integrated logic).
-
-## Base URL
-`http://localhost:5000`
-
-## Features
-- **Authentication**: JWT based Login/Signup.
-- **Roles**:
-  - `superadmin`: Full access.
-  - `admin`: Manage rooms, view all payments.
-  - `customer`: View own dashboard, make payments.
-- **Payments**: Simulates payment gateway intent and confirmation.
-- **Database**: SQLite (Development), configurable for Postgres/MySQL.
-
-## Setup
-1. `npm install`
-2. `npm start`
-3. Super Admin default credentials: `admin@pg.com` / `admin123`
-
-## Postman Collection
-Copy the JSON below and import it into Postman.
-
-```json
-{
-	"info": {
-		"_postman_id": "pg-backend-collection",
-		"name": "PG Management API",
-		"description": "Postman collection for PG Management SaaS Backend",
-		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
-	},
-	"item": [
-		{
-			"name": "Auth",
-			"item": [
-				{
-					"name": "Signup (Customer)",
-					"request": {
-						"method": "POST",
-						"header": [],
-						"body": {
-							"mode": "raw",
-							"raw": "{\n    \"name\": \"John Customer\",\n    \"email\": \"customer@example.com\",\n    \"password\": \"password123\",\n    \"phone\": \"9876543210\",\n    \"role\": \"customer\"\n}",
-							"options": {
-								"raw": {
-									"language": "json"
-								}
-							}
-						},
-						"url": {
-							"raw": "{{url}}/api/auth/signup",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"auth",
-								"signup"
-							]
-						}
-					},
-					"response": []
-				},
-				{
-					"name": "Signin (Admin)",
-					"event": [
-						{
-							"listen": "test",
-							"script": {
-								"exec": [
-									"var jsonData = pm.response.json();",
-									"if(jsonData.accessToken) {",
-									"    pm.environment.set(\"token\", jsonData.accessToken);",
-									"    console.log(\"Token set successfully\");",
-									"}"
-								],
-								"type": "text/javascript"
-							}
-						}
-					],
-					"request": {
-						"method": "POST",
-						"header": [],
-						"body": {
-							"mode": "raw",
-							"raw": "{\n    \"email\": \"admin@pg.com\",\n    \"password\": \"admin123\"\n}",
-							"options": {
-								"raw": {
-									"language": "json"
-								}
-							}
-						},
-						"url": {
-							"raw": "{{url}}/api/auth/signin",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"auth",
-								"signin"
-							]
-						}
-					},
-					"response": []
-				},
-				{
-					"name": "Signin (Customer)",
-					"event": [
-						{
-							"listen": "test",
-							"script": {
-								"exec": [
-									"var jsonData = pm.response.json();",
-									"if(jsonData.accessToken) {",
-									"    pm.environment.set(\"token\", jsonData.accessToken);",
-									"}"
-								],
-								"type": "text/javascript"
-							}
-						}
-					],
-					"request": {
-						"method": "POST",
-						"header": [],
-						"body": {
-							"mode": "raw",
-							"raw": "{\n    \"email\": \"customer@example.com\",\n    \"password\": \"password123\"\n}",
-							"options": {
-								"raw": {
-									"language": "json"
-								}
-							}
-						},
-						"url": {
-							"raw": "{{url}}/api/auth/signin",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"auth",
-								"signin"
-							]
-						}
-					},
-					"response": []
-				}
-			]
-		},
-		{
-			"name": "Rooms",
-			"item": [
-				{
-					"name": "Get All Rooms",
-					"request": {
-						"method": "GET",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"url": {
-							"raw": "{{url}}/api/rooms",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"rooms"
-							]
-						}
-					},
-					"response": []
-				},
-				{
-					"name": "Create Room (Admin)",
-					"request": {
-						"method": "POST",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"body": {
-							"mode": "raw",
-							"raw": "{\n    \"roomNumber\": \"101\",\n    \"floor\": 1,\n    \"capacity\": 3,\n    \"pricePerMonth\": 6000,\n    \"amenities\": \"WiFi, TV\"\n}",
-							"options": {
-								"raw": {
-									"language": "json"
-								}
-							}
-						},
-						"url": {
-							"raw": "{{url}}/api/rooms",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"rooms"
-							]
-						}
-					},
-					"response": []
-				},
-				{
-					"name": "Update Room (Admin)",
-					"request": {
-						"method": "PUT",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"body": {
-							"mode": "raw",
-							"raw": "{\n    \"pricePerMonth\": 6500,\n    \"floor\": 2,\n    \"amenities\": \"WiFi, TV, AC\",\n    \"isMaintenance\": true\n}",
-							"options": {
-								"raw": {
-									"language": "json"
-								}
-							}
-						},
-						"url": {
-							"raw": "{{url}}/api/rooms/:id",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"rooms",
-								":id"
-							],
-							"variable": [
-								{
-									"key": "id",
-									"value": "ENTER_ROOM_ID_HERE"
-								}
-							]
-						}
-					},
-					"response": []
-				},
-				{
-					"name": "Delete Room (Admin)",
-					"request": {
-						"method": "DELETE",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"url": {
-							"raw": "{{url}}/api/rooms/:id",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"rooms",
-								":id"
-							],
-							"variable": [
-								{
-									"key": "id",
-									"value": "ENTER_ROOM_ID_HERE"
-								}
-							]
-						}
-					},
-					"response": []
-				}
-			]
-		},
-		{
-			"name": "Payments",
-			"item": [
-				{
-					"name": "Create Payment Intent",
-					"request": {
-						"method": "POST",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"body": {
-							"mode": "raw",
-							"raw": "{\n    \"amount\": 6000,\n    \"type\": \"monthly_rent\"\n}",
-							"options": {
-								"raw": {
-									"language": "json"
-								}
-							}
-						},
-						"url": {
-							"raw": "{{url}}/api/payments/create-intent",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"payments",
-								"create-intent"
-							]
-						}
-					},
-					"response": []
-				},
-				{
-					"name": "Confirm Payment",
-					"request": {
-						"method": "POST",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"body": {
-							"mode": "raw",
-							"raw": "{\n    \"paymentId\": \"PASTE_PAYMENT_ID_HERE\",\n    \"transactionId\": \"TXN_99999\",\n    \"method\": \"upi\"\n}",
-							"options": {
-								"raw": {
-									"language": "json"
-								}
-							}
-						},
-						"url": {
-							"raw": "{{url}}/api/payments/confirm",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"payments",
-								"confirm"
-							]
-						}
-					},
-					"response": []
-				},
-				{
-					"name": "My History (Customer)",
-					"request": {
-						"method": "GET",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"url": {
-							"raw": "{{url}}/api/payments/my-history",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"payments",
-								"my-history"
-							]
-						}
-					},
-					"response": []
-				},
-				{
-					"name": "All Payments (Admin)",
-					"request": {
-						"method": "GET",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"url": {
-							"raw": "{{url}}/api/payments?status=pending",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"payments"
-							],
-							"query": [
-								{
-									"key": "status",
-									"value": "pending",
-									"description": "Optional filter: pending, completed, failed"
-								}
-							]
-						}
-					},
-					"response": []
-				}
-			]
-		},
-		{
-			"name": "Dashboard",
-			"item": [
-				{
-					"name": "Admin Stats",
-					"request": {
-						"method": "GET",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"url": {
-							"raw": "{{url}}/api/dashboard/admin",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"dashboard",
-								"admin"
-							]
-						}
-					},
-					"response": []
-				},
-				{
-					"name": "Customer Dashboard",
-					"request": {
-						"method": "GET",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"url": {
-							"raw": "{{url}}/api/dashboard/customer",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"dashboard",
-								"customer"
-							]
-						}
-					},
-					"response": []
-				},
-				{
-					"name": "Announcements",
-					"request": {
-						"method": "GET",
-						"header": [
-							{
-								"key": "x-access-token",
-								"value": "{{token}}",
-								"type": "text"
-							}
-						],
-						"url": {
-							"raw": "{{url}}/api/dashboard/announcements",
-							"host": [
-								"{{url}}"
-							],
-							"path": [
-								"api",
-								"dashboard",
-								"announcements"
-							]
-						}
-					},
-					"response": []
-				}
-			]
-		}
-	],
-	"variable": [
-		{
-			"key": "url",
-			"value": "http://localhost:5000",
-			"type": "string"
-		}
-	]
-}
-```

package/guestguru-api/API_REQUIREMENTS_TENANTS.md

@@ -1,110 +0,0 @@
-# API Requirements: Tenant Management Module
-
-To make the `TenantsList` component dynamic and support full CRUD functionality along with current UI operations (filtering, searching, status updates), the following API endpoints and data structures are required.
-
-## 1. Data Models
-
-### **Tenant Object**
-The core entity representing a tenant.
-
-```json
-{
-  "id": "uuid",
-  "name": "string",
-  "email": "string",
-  "phone": "string",
-  "profileImage": "string (url)",
-  "roomNumber": "string",
-  "bedId": "string (optional)",
-  "joinDate": "ISO8601 Date String",
-  "status": "enum('Active', 'Due Payment', 'Moved Out')",
-  "outstandingBalance": "number",
-  "lastPaymentDate": "ISO8601 Date String"
-}
-```
-
-## 2. API Endpoints
-
-### **A. Tenant Management (CRUD)**
-
-#### 1. **Fetch Tenants List**
-   - **Endpoint**: `GET /api/tenants`
-   - **Description**: Retrieves a paginated list of tenants with support for filtering and searching.
-   - **Query Parameters**:
-     - `page`: Page number (default: 1)
-     - `limit`: Items per page (default: 10)
-     - `search`: Search term (matches name, roomNumber, or phone)
-     - `status`: Filter by status (`Active`, `Due Payment`, `Moved Out`, or `All`)
-   - **Response**:
-     ```json
-     {
-       "data": [ ...TenantObjects ],
-       "meta": {
-         "total": 50,
-         "page": 1,
-         "limit": 10
-       }
-     }
-     ```
-
-#### 2. **Get Single Tenant Details**
-   - **Endpoint**: `GET /api/tenants/:id`
-   - **Description**: Fetches detailed information for a specific tenant (useful for a future detail view).
-
-#### 3. **Add New Tenant**
-   - **Endpoint**: `POST /api/tenants`
-   - **Description**: Onboards a new tenant.
-   - **Body**:
-     ```json
-     {
-       "name": "John Doe",
-       "phone": "9876543210",
-       "roomNumber": "101",
-       "joinDate": "2023-01-01",
-       "initialPayment": 5000
-     }
-     ```
-
-#### 4. **Update Tenant Details**
-   - **Endpoint**: `PUT /api/tenants/:id`
-   - **Description**: Updates tenant information (e.g., room change, phone number update).
-   - **Body**: (Partial Tenant Object)
-
-#### 5. **Delete/Archive Tenant**
-   - **Endpoint**: `DELETE /api/tenants/:id`
-   - **Description**: Soft deletes a tenant or marks them as 'Archived'.
-
-### **B. Operational Actions**
-
-#### 6. **Record Rent Payment (Collect Rent)**
-   - **Endpoint**: `POST /api/payments`
-   - **Description**: Triggered when the "Collect Rent" button is clicked. Records a payment and potentially updates the tenant's status from 'Due Payment' to 'Active'.
-   - **Body**:
-     ```json
-     {
-       "tenantId": "uuid",
-       "amount": 5000,
-       "type": "Rent",
-       "date": "2023-10-01"
-     }
-     ```
-
-#### 7. **Move Out Tenant**
-   - **Endpoint**: `POST /api/tenants/:id/move-out`
-   - **Description**: Special action to mark a tenant as 'Moved Out' and free up the room/bed.
-   - **Body**:
-     ```json
-     {
-       "moveOutDate": "2023-10-15"
-     }
-     ```
-
-## 3. UI Integration Logic
-
-- **Search Bar**: Debounce input and call `GET /api/tenants?search={query}`.
-- **Filter Chips**: On click, call `GET /api/tenants?status={selectedStatus}`.
-- **Infinite Scroll**: On reaching list end, increment `page` param and append results.
-- **"Collect Rent" Button**:
-  1. Opens a modal to confirm amount.
-  2. Calls `POST /api/payments`.
-  3. On success, local state update: remove "Due Payment" status and "Make Payment" button from that card.