networkDevice.js

Go to the documentation of this file.

/**
 * @file networkDevice.js
 * @module routes/networkDevice
 * @description Network device inventory management endpoint.
 * Provides paginated list of network devices (switches, routers, firewalls) with filtering and tenant isolation.
 * @requires express
 * @requires services/db
 * @requires middleware/auth
 * @requires middleware/tenant
 * @author RMM-PSA Development Team
 * @copyright 2026 RMM-PSA Platform
 * @license Proprietary
 */
 
/**
 * @apiDefine NetworkDevice Network Devices
 * Network infrastructure device inventory management
 */
 
const express = require('express');
const router = express.Router();
const pool = require('../services/db');
const authenticateToken = require('../middleware/auth');
const { getTenantFilter } = require('../middleware/tenant');
 
/**
 * @api {get} /api/network-device/list List network devices
 * @apiName ListNetworkDevices
 * @apiGroup NetworkDevice
 * @apiDescription Retrieve paginated list of network devices with filtering and search.
 * Supports filtering by customer, OS, and full-text search. Enforces tenant isolation.
 * Returns inventory of switches, routers, firewalls, and other network infrastructure.
 * @apiParam {number} [page=1] Page number (query parameter)
 * @apiParam {number} [limit=20] Results per page (query parameter)
 * @apiParam {number} [customer_id] Filter by customer ID (query parameter)
 * @apiParam {string} [os] Filter by operating system/firmware (query parameter)
 * @apiParam {string} [search] Search device name, hostname, customer, or OS (query parameter)
 * @apiSuccess {object[]} devices Array of network devices
 * @apiSuccess {string} devices.device_uuid Device UUID
 * @apiSuccess {number} devices.device_id Device ID
 * @apiSuccess {number} devices.tenant_id Tenant ID
 * @apiSuccess {number} devices.customer_id Customer ID
 * @apiSuccess {string} devices.hostname Device hostname
 * @apiSuccess {string} devices.os Operating system/firmware (e.g., "Cisco IOS", "pfSense")
 * @apiSuccess {string} devices.os_version Firmware version
 * @apiSuccess {string} devices.version Management app version
 * @apiSuccess {DateTime} devices.last_seen Last contact timestamp
 * @apiSuccess {string} devices.name Device friendly name
 * @apiSuccess {string} devices.ip_address Device IP address
 * @apiSuccess {string} devices.user_list Associated users (comma-separated)
 * @apiSuccess {string} devices.customer_name Customer name
 * @apiSuccess {String} devices.contract_title Associated contract title
 * @apiSuccess {Number} total Total device count (for pagination)
 * 
 * @apiError (500) {String} error="Failed to list devices" Database query failed
 * 
 * @apiExample {curl} Example:
 *   curl -X GET "http://localhost:3000/api/network-device/list?page=1&limit=20&search=switch&customer_id=5" \\\\
 *     -H "Authorization: Bearer YOUR_TOKEN"
 * 
 * @apiSuccessExample {json} Success-Response:
 *   HTTP/1.1 200 OK
 *   {
 *     "devices": [
 *       {
 *         "device_uuid": "net-abc-123",
 *         "device_id": 42,
 *         "tenant_id": 2,
 *         "customer_id": 5,
 *         "hostname": "CORE-SWITCH-01",
 *         "os": "Cisco IOS",
 *         "os_version": "15.2(4)E",
 *         "version": null,
 *         "last_seen": "2026-03-12T10:30:00.000Z",
 *         "name": "Core Switch - Building A",
 *         "ip_address": "192.168.1.1",
 *         "user_list": null,
 *         "customer_name": "Acme Corp",
 *         "contract_title": "Network Monitoring"
 *       }
 *     ],
 *     "total": 15
 *   }
 */
router.get('/list', authenticateToken, async (req, res) => {
  try {
    const { clause: tenantClause, params: tenantParams } = getTenantFilter(req, 'n');
    const conditions = [];
    const params = [...tenantParams];
    let paramIdx = tenantParams.length + 1;
    if (tenantClause) conditions.push(tenantClause);
    if (req.query.customer_id) {
      params.push(req.query.customer_id);
      conditions.push(`n.customer_id = $${paramIdx++}`);
    }
    if (req.query.search) {
      const search = `%${req.query.search}%`;
      params.push(search);
      conditions.push(`(n.name ILIKE $${paramIdx} OR n.hostname ILIKE $${paramIdx} OR c.name ILIKE $${paramIdx} OR n.os ILIKE $${paramIdx})`);
      paramIdx++;
    }
    if (req.query.os) {
      params.push(req.query.os);
      conditions.push(`n.os = $${paramIdx++}`);
    }
    const whereClause = conditions.length > 0 ? 'WHERE ' + conditions.join(' AND ') : '';
    const page = parseInt(req.query.page, 10) || 1;
    const limit = parseInt(req.query.limit, 10) || 20;
    const offset = (page - 1) * limit;
    const totalResult = await pool.query(`
      SELECT COUNT(*) AS total
      FROM network_devices n
      LEFT JOIN customers c ON c.customer_id = n.customer_id
      ${whereClause}
    `, params);
    const total = parseInt(totalResult.rows[0]?.total || '0', 10);
    const result = await pool.query(`
      SELECT 
        n.device_uuid,
        n.device_id,
        n.tenant_id,
        n.customer_id,
        n.hostname,
        n.os,
        n.os_version,
        n.version,
        n.last_seen,
        n.name,
        n.ip_address,
        n.user_list,
        c.name AS customer_name,
        ct.title AS contract_title
      FROM network_devices n
      LEFT JOIN customers c ON c.customer_id = n.customer_id
      LEFT JOIN contracts ct ON ct.contract_id = n.contract_id
      ${whereClause}
      ORDER BY n.hostname
      LIMIT $${paramIdx} OFFSET $${paramIdx + 1}
    `, [...params, limit, offset]);
    res.json({ devices: result.rows, total });
  } catch (err) {
    console.error('[NetworkDevice] Failed to list devices:', err);
    res.status(500).json({ error: 'Failed to list devices' });
  }
});
 
module.exports = router;