agentVersion.js

Go to the documentation of this file.

/**
 * @file agentVersion.js
 * @module routes/agentVersion
 * @description Agent version information endpoint. Returns current agent version from package.json.
 * Used by agents to check for updates and by dashboard to display agent version.
 * @requires express
 * @requires fs
 * @requires path
 * @author RMM-PSA Development Team
 * @copyright 2026 RMM-PSA Platform
 * @license Proprietary
 */
 
/**
 * @apiDefine AgentVersion Agent Version
 * Agent version information for update checks
 */
 
const express = require('express');
const router = express.Router();
const fs = require('fs');
const path = require('path');
 
/**
 * @api {get} /api/agent/version Get agent version
 * @apiName GetAgentVersion
 * @apiGroup AgentVersion
 * @apiDescription Retrieve current agent version from package.json.
 * Returns semantic version string. Fallback to hardcoded version if package.json not found.
 * Used by agents for update availability checks.
 * @apiSuccess {string} version Agent version (semantic versioning, e.g., "1.0.12")
 * @apiExample {curl} Example:
 *   curl -X GET http://localhost:3000/api/agent/version
 * @apiSuccessExample {json} Success-Response:
 *   HTTP/1.1 200 OK
 *   {
 *     "version": "1.0.12"
 *   }
 */
router.get('/version', async (req, res) => {
  try {
    // Read version from agent's package.json
    const agentPackagePath = path.join(__dirname, '../../agent/package.json');
    if (fs.existsSync(agentPackagePath)) {
      const agentPackage = JSON.parse(fs.readFileSync(agentPackagePath, 'utf8'));
      const version = agentPackage.version || '1.0.12';
      res.json({ version });
    } else {
      // Fallback to hardcoded version
      res.json({ version: '1.0.12' });
    }
  } catch (err) {
    console.error('[AgentVersion] Error:', err);
    res.json({ version: '1.0.12' });
  }
});
 
module.exports = router;