krsyer-server-monitor-pro 1.0.3 → 1.0.5

package/guestguru-api/API_REQUIREMENTS_TENANTS.md

@@ -0,0 +1,110 @@
+# 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.

package/guestguru-api/AVAILABLE_TENANT_ENDPOINTS.md

@@ -0,0 +1,137 @@
+# Available Tenant Endpoints
+
+This document lists all currently implemented endpoints for Tenant Management, excluding the Create Tenant endpoint (which is already documented/fixed).
+
+## Base URL
+`{{url}}/api/tenants`
+
+## Authentication
+All endpoints require the following header:
+- `x-access-token`: `{{admin_token}}`
+
+---
+
+## 1. Get All Tenants
+Fetch a paginated list of tenants with optional search and filter.
+
+- **Method**: `GET`
+- **URL**: `/api/tenants`
+- **Query Parameters**:
+  - `page`: (Optional) Page number (default: 1)
+  - `limit`: (Optional) Items per page (default: 10)
+  - `search`: (Optional) Filter by name or phone
+  - `status`: (Optional) Filter by status: `Active`, `Due Payment`, `Moved Out`, `All`
+- **Response**:
+```json
+{
+  "data": [
+    {
+      "id": "uuid",
+      "name": "John Doe",
+      "email": "john@example.com",
+      "phone": "9876543210",
+      "profileImage": "data:image/jpeg;base64,...",
+      "roomNumber": "101",
+      "status": "Active",
+      "outstandingBalance": 0
+    }
+  ],
+  "meta": {
+    "total": 50,
+    "page": 1,
+    "limit": 10
+  }
+}
+```
+
+---
+
+## 2. Get Tenant Details
+Fetch detailed information for a single tenant, including recent payments involved.
+
+- **Method**: `GET`
+- **URL**: `/api/tenants/:id`
+- **Response**:
+```json
+{
+  "id": "uuid",
+  "name": "John Doe",
+  "email": "john@example.com",
+  "phone": "9876543210",
+  "roomNumber": "101",
+  "profileImage": "data:image/jpeg;base64,...", 
+  "documents": "data:application/pdf;base64,...",
+  "status": "Active",
+  "outstandingBalance": 5000,
+  "payments": [ ...last 5 payments... ]
+}
+```
+
+---
+
+## 3. Update Tenant
+Update tenant details such as phone, name, or swap rooms.
+
+- **Method**: `PUT`
+- **URL**: `/api/tenants/:id`
+- **Body**: (Send specific fields to update)
+```json
+{
+  "name": "John Updated",
+  "phone": "9999999999",
+  "roomNumber": "102",  // Triggers room swap logic
+  "status": "Due Payment"
+}
+```
+
+---
+
+## 4. Delete/Archive Tenant
+Soft deletes the tenant and releases their room assignment.
+
+- **Method**: `DELETE`
+- **URL**: `/api/tenants/:id`
+- **Response**:
+```json
+{
+  "message": "Tenant archived/deleted successfully."
+}
+```
+
+---
+
+## 5. Move Out Tenant
+Mark a tenant as moved out and free up the room.
+
+- **Method**: `POST`
+- **URL**: `/api/tenants/:id/move-out`
+- **Response**:
+```json
+{
+  "message": "Tenant moved out successfully."
+}
+```
+
+---
+
+## 6. Collect Rent (Manual Payment)
+Although technically under payment routes, this is crucial for tenant operations.
+
+- **Method**: `POST`
+- **URL**: `/api/payments`
+- **Body**:
+```json
+{
+  "tenantId": "uuid-of-tenant",
+  "amount": 5000,
+  "type": "monthly_rent", // optional
+  "date": "2023-12-16"    // optional, defaults to now
+}
+```
+- **Response**:
+```json
+{
+  "message": "Rent collected successfully.", 
+  "payment": { ... }
+}
+```

package/guestguru-api/BACKEND_INSTRUCTIONS.md

@@ -0,0 +1,77 @@
+# Backend API Instructions for Admin Dashboard
+
+To fully populate the Admin Dashboard in the GuestGuru application, the `GET /api/dashboard/admin` endpoint needs to return the following structure.
+
+## Endpoint: `GET /api/dashboard/admin`
+
+**Current (Stubbed/Expected) Response:**
+```json
+{
+    "totalRooms": 12,
+    "totalBeds": 45,
+    "availableBeds": 5,
+    "activeTenants": 40
+}
+```
+
+**Required Update:**
+Please extend the response object to include `financials` and `recentActivity`.
+
+### 1. Financials Object
+Provides data for the "Financial Overview" card.
+- `financials.totalRevenue` (String/Number): Total revenue for the current month (e.g., "20,000").
+- `financials.collected` (Number): Amount already collected (e.g., 15000).
+- `financials.pending` (Number): Amount still pending (e.g., 5000).
+- `financials.trend` (String): Trends string (e.g., "+12%").
+
+### 2. Recent Activity Array
+Provides a list of recent events for the "Recent Activity" section.
+- `recentActivity` (Array of Objects):
+    - `id` (String/Number): Unique identifier.
+    - `type` (String): One of `'payment'`, `'assignment'`, or `'maintenance'`.
+        - Determines the icon and color:
+        - `payment`: Green icon (money).
+        - `assignment`: Blue icon (key).
+        - `maintenance`: Orange icon (tools).
+    - `title` (String): Title of the activity (e.g., "Rent Received", "New Assignment").
+    - `time` (String): Relative time string (e.g., "2h ago").
+    - `description` (String): Brief description (e.g., "John Doe paid $500 for Room 203").
+
+### Example Full Response
+```json
+{
+    "totalRooms": 12,
+    "totalBeds": 45,
+    "availableBeds": 5,
+    "activeTenants": 40,
+    "financials": {
+        "totalRevenue": "20,000",
+        "collected": 15000,
+        "pending": 5000,
+        "trend": "+12%"
+    },
+    "recentActivity": [
+        {
+            "id": 1,
+            "type": "payment",
+            "title": "Rent Received",
+            "time": "2h ago",
+            "description": "John Doe paid $500 for Room 203"
+        },
+        {
+            "id": 2,
+            "type": "assignment",
+            "title": "New Assignment",
+            "time": "5h ago",
+            "description": "Sarah Smith → Room 104"
+        },
+        {
+            "id": 3,
+            "type": "maintenance",
+            "title": "Maintenance",
+            "time": "1d ago",
+            "description": "Room 301: AC issue reported"
+        }
+    ]
+}
+```

package/guestguru-api/DINING_MODULE_INTEGRATION.md

@@ -0,0 +1,175 @@
+# Advanced Weekly Dining Timetable Module - Integration Guide
+
+## Overview
+The Dining Module allows PG Owners to configure and display a weekly food menu (Monday to Sunday) for their tenants. It supports three main meals per day (Breakfast, Lunch, Dinner) with customizable timings, menu items, and optional special notes.
+
+---
+
+## 1. API Reference
+
+### Base URL: `/api/dining`
+
+### A. Get Weekly Menu
+Fetches the full menu for the week. The backend guarantees a response of exactly 7 objects (Monday-Sunday), even if the owner hasn't configured some days yet (they will be returned with default empty values).
+
+- **Endpoint**: `GET /api/dining`
+- **Method**: `GET`
+- **Headers**: `Authorization: Bearer <TOKEN>`
+- **Access**: Owner, Admin, Tenant
+- **Response**: `Array<DailyMenuObject>`
+
+#### Response Example
+```json
+[
+  {
+    "day": "Monday",
+    "breakfast": {
+      "items": ["Idli", "Sambar", "Chutney"],
+      "time": "07:30 - 09:30",
+      "enabled": true
+    },
+    "lunch": {
+      "items": ["Rice", "Dal", "Potato Fry"],
+      "time": "12:30 - 14:30",
+      "enabled": true
+    },
+    "dinner": {
+      "items": ["Chapati", "Paneer Butter Masala"],
+      "time": "19:30 - 21:30",
+      "enabled": true
+    },
+    "specialNote": "No Onion/Garlic"
+  },
+  {
+    "day": "Tuesday",
+    "breakfast": { "items": [], "time": "08:00 - 10:00", "enabled": true }, 
+    ... // Returns default structure if not set
+  },
+  ...
+]
+```
+
+### B. Update Menu (Bulk)
+Allows the Owner to update the menu for one or multiple days at once.
+
+- **Endpoint**: `POST /api/dining`
+- **Method**: `POST`
+- **Headers**: `Authorization: Bearer <TOKEN>`
+- **Access**: Owner, Admin
+- **Payload**: `Array<DailyMenuObject>`
+
+#### Request Payload Example
+```json
+[
+  {
+    "day": "Wednesday",
+    "breakfast": {
+      "items": ["Puri", "Bhaji"],
+      "time": "08:00 - 10:00",
+      "enabled": true
+    },
+    "lunch": {
+      "items": ["Veg Biryani", "Raita"],
+      "time": "13:00 - 14:30",
+      "enabled": true
+    },
+    "dinner": {
+      "items": ["Roti", "Dal Tadka"],
+      "time": "20:00 - 22:00",
+      "enabled": true
+    },
+    "specialNote": "Sweet included"
+  }
+]
+```
+*Note: You only need to send the objects for the days you want to update. The backend uses the `day` field to identify the record.*
+
+---
+
+## 2. Frontend Implementation Guide (React)
+
+### A. Design Approach
+We recommend two views:
+1.  **Tabbed View (Mobile Friendly)**: Tabs for "Mon", "Tue", "Wed"... displaying that specific day's meals card.
+2.  **Weekly Grid View (Desktop)**: A 7-column grid showing the entire week at a glance.
+
+### B. Data State
+Store the menu in a Redux slice or local state.
+```javascript
+const [weeklyMenu, setWeeklyMenu] = useState([]); // Array of 7 objects
+const [activeDay, setActiveDay] = useState('Monday'); // For tab view
+```
+
+### C. Component Structure
+
+#### `DiningDashboard.jsx` (Main Container)
+-   Fetches data on mount (`useEffect`).
+-   Renders `DayTabs` or `WeekGrid` based on screen size.
+-   Contains an "Edit Menu" button (Visible only to Owners).
+
+#### `MealCard.jsx` (Dumb Component)
+Displays a single meal section.
+```jsx
+const MealCard = ({ title, data }) => (
+  <div className={`meal-card ${!data.enabled ? 'opacity-50' : ''}`}>
+    <div className="flex justify-between">
+      <h3 className="font-bold">{title}</h3>
+      <span className="text-sm text-gray-500">{data.time}</span>
+    </div>
+    <ul className="mt-2 list-disc pl-4">
+      {data.items.length > 0 ? (
+        data.items.map((item, idx) => <li key={idx}>{item}</li>)
+      ) : (
+        <li className="text-gray-400 italic">Not set</li>
+      )}
+    </ul>
+  </div>
+);
+```
+
+#### `EditMenuModal.jsx` (Form)
+-   **Fields needed per meal (Breakfast/Lunch/Dinner)**:
+    -   **Items**: Tag Input (User types "Idli" + Enter -> adds to array).
+    -   **Time**: Text Input (e.g., "08:00 - 09:00").
+    -   **Enabled**: Toggle Switch (If off, grey out the section).
+-   **Special Note**: Text Area.
+-   **Structure**: Allow editing one day at a time to avoid a massive form.
+
+### D. Redux Slice (`diningSlice.js`)
+```javascript
+import { createSlice, createAsyncThunk } from '@reduxjs/toolkit';
+import axios from 'axios';
+
+// Thunk to fetch
+export const fetchWeeklyMenu = createAsyncThunk('dining/fetch', async () => {
+    const response = await axios.get('/api/dining');
+    return response.data;
+});
+
+// Thunk to update
+export const updateDailyMenu = createAsyncThunk('dining/update', async (payload) => {
+    // Payload should be an array: [{ day: 'Monday', ... }]
+    const response = await axios.post('/api/dining', payload);
+    return response.data;
+});
+
+const diningSlice = createSlice({
+    name: 'dining',
+    initialState: { menu: [], loading: false },
+    extraReducers: (builder) => {
+        builder.addCase(fetchWeeklyMenu.fulfilled, (state, action) => {
+            state.menu = action.payload;
+        });
+        // Handle loading/error states...
+    }
+});
+
+export default diningSlice.reducer;
+```
+
+---
+
+## 3. Best Practices
+1.  **Tag Input**: For entering food items (`["Idli", "Vada"]`), use a library like `react-tag-input` or simply listen for the `Enter` key in a text input to push to an array.
+2.  **Validation**: Ensure time strings are reasonably formatted, though strict validation isn't enforced by backend.
+3.  **Empty States**: The backend ensures a full week is returned, but visually handle `items: []` gracefully (e.g., show "No items listed").

package/guestguru-api/FRONTEND_FINANCE_MODULE.md

@@ -0,0 +1,151 @@
+# Frontend Finance Module Design & Implementation Guide
+
+## Overview
+The Finance Module enables PG Owners to track their **Income** (from Rent Payments) and **Expenses** (Maintenance, Bills, etc.) to visualize **Profit & Loss** (P&L) on a monthly and yearly basis.
+
+## 1. API Integration
+
+### Base URL: `/api/finance`
+
+#### A. Add Expense
+- **Endpoint**: `POST /expenses`
+- **Payload**:
+  ```json
+  {
+      "title": "Plumbing Repair",
+      "amount": 1500,
+      "category": "maintenance", // Options: maintenance, utility_bills, salary, groceries, marketing, other
+      "description": "Fixed leaking pipe in Room 101",
+      "date": "2024-12-18"
+  }
+  ```
+
+#### B. Get Expenses List
+- **Endpoint**: `GET /expenses`
+- **Query Params**:
+  - `month`: 1-12 (Optional)
+  - `year`: 2024 (Optional)
+  - `search`: "plumbing" (Optional)
+
+#### C. Get Financial Report (P&L)
+- **Endpoint**: `GET /report`
+- **Query Params**:
+  - `year`: YYYY (Required) - e.g., `2024`
+  - `month`: 1-12 (Optional) - If omitted, returns yearly breakdown.
+- **Response (Monthly)**:
+  ```json
+  {
+      "period": "12/2024",
+      "stats": {
+          "income": 50000,
+          "expense": 12000,
+          "profit": 38000
+      },
+      "expenseBreakdown": [
+          { "category": "maintenance", "total": 2000 },
+          { "category": "utility_bills", "total": 10000 }
+      ]
+  }
+  ```
+- **Response (Yearly)**:
+  ```json
+  {
+      "period": "Year 2024",
+      "overall": { "income": 600000, "expense": 120000, "profit": 480000 },
+      "monthlyBreakdown": [
+          { "month": 1, "monthName": "Jan", "income": 50000, "expense": 10000, "profit": 40000 },
+          ...
+      ]
+  }
+  ```
+
+---
+
+## 2. UI Components & Design
+
+### A. Dashboard Cards (Summary)
+Place these at the top of the **Finance/Reports** page.
+- **Total Income**: Green Trend Icon + Value.
+- **Total Expenses**: Red Trend Icon + Value.
+- **Net Profit**: Blue/Purple Chart Icon + Value (highlighted).
+
+### B. Charts (Visual Analytics)
+Use a library like `recharts` or `chart.js`.
+1.  **Profit vs Loss (Yearly View)**:
+    -   **Type**: Bar Chart (Sidebar or Stacked).
+    -   **X-Axis**: Months (Jan, Feb...).
+    -   **Bars**: Income (Green), Expense (Red).
+2.  **Expense Breakdown (Monthly View)**:
+    -   **Type**: Doughnut/Pie Chart.
+    -   **Data**: Categories (Maintenance, Bills, etc.).
+
+### C. Expense Management Table
+A searchable, paginated table to view history.
+-   **Columns**: Date, Title, Category (Badge), Amount, Actions (Delete).
+-   **Header Action**: "Add Expense" Button -> Opens Modal.
+
+### D. Add Expense Modal
+-   **Fields**:
+    -   **Title**: Text Input.
+    -   **Amount**: Number Input.
+    -   **Category**: Dropdown (Maintenance, Bills, Salary, Groceries, Marketing, Other).
+    -   **Date**: Date Picker (Default to Today).
+    -   **Description**: Text Area.
+
+---
+
+## 3. Implementation Steps (React/Redux)
+
+### Step 1: Update Redux Slice (`financeSlice.js`)
+Create a new slice to handle state.
+```javascript
+const financeSlice = createSlice({
+    name: 'finance',
+    initialState: {
+        expenses: [],
+        report: null, // Stores P&L data
+        loading: false,
+    },
+    reducers: {},
+    extraReducers: (builder) => {
+        // Handle fetchExpenses, addExpense, fetchReport thunks
+    }
+});
+```
+
+### Step 2: Create Components
+1.  `FinanceDashboard.jsx`: Main container. Select Year/Month controls.
+2.  `ExpenseForm.jsx`: Modal form.
+3.  `PLLogic.js`: Utility to format data for charts.
+
+### Step 3: Aesthetic Guidelines
+-   **Colors**:
+    -   Income: `#10B981` (Emerald-500)
+    -   Expense: `#EF4444` (Red-500)
+    -   Profit: `#6366F1` (Indigo-500)
+-   **Cards**: Glassmorphism effect or clean white cards with soft shadows (`shadow-lg`).
+-   **Typography**: Use `Inter` or `Outfit` fonts. Money values should be bold (`font-bold`).
+
+---
+
+## 4. Example Page Layout
+```
++-------------------------------------------------------+
+|  [Dashboard] [Rooms] [Tenants] [Finance (Active)]     |
++-------------------------------------------------------+
+|  Year: [ 2024 v ]   Month: [ December v ]             |
++-------------------------------------------------------+
+|  [ Total Income ]  [ Total Expenses ]  [ Net Profit ] |
+|  [   $50,000    ]  [    $12,000     ]  [  $38,000   ] |
++-------------------------------------------------------+
+|                                                       |
+|  [          Big Bar Chart: Income vs Expense        ] |
+|  [          (Jan - Dec 2024 or Daily)               ] |
+|                                                       |
++-------------------------------------------------------+
+|  Recent Expenses               [+ Add Expense Button] |
+|  ---------------------------------------------------  |
+|  Date       | Title           | Category    | Amount  |
+|  2024-12-18 | Pipe Repair     | Maintenance | $1500   |
++-------------------------------------------------------+
+```