sync.js

Go to the documentation of this file.

/**
 * @file sync.js
 * @module routes/sync
 * @description Manual synchronization endpoints for MeshCentral device and group sync operations.
 * Provides on-demand sync triggers and status monitoring for background sync workers.
 * @requires express
 * @requires middleware/auth
 * @requires workers/meshcentral-device-sync
 * @author RMM-PSA Development Team
 * @copyright 2026 RMM-PSA Platform
 * @license Proprietary
 */
 
/**
 * @apiDefine Sync Synchronization
 * Manual sync operations for external integrations
 */
 
const express = require('express');
const router = express.Router();
const authenticateToken = require('../middleware/auth');
 
/**
 * @api {post} /api/sync/meshcentral Manual MeshCentral sync
 * @apiName ManualMeshCentralSync
 * @apiGroup Sync
 * @apiDescription Trigger manual synchronization of MeshCentral devices and mesh groups.
 * Calls sync worker to import devices and groups from MeshCentral into RMM database.
 * Returns sync statistics and timestamps. Requires authentication.
 * @apiSuccess {boolean} success=true Sync completed successfully
 * @apiSuccess {string} message="MeshCentral sync completed"
 * @apiSuccess {object} stats Sync statistics
 * @apiSuccess {number} stats.devicesUpdated Number of devices synced
 * @apiSuccess {number} stats.groupsUpdated Number of mesh groups synced
 * @apiSuccess {DateTime} lastSync Last device sync timestamp
 * @apiSuccess {DateTime} lastGroupSync Last group sync timestamp
 * @apiError {boolean} success=false Sync failed
 * @apiError {string} message="Sync failed"
 * @apiError {string} error Error message details
 * @apiExample {curl} Example:
 *   curl -X POST http://localhost:3000/api/sync/meshcentral \\
 *     -H "Authorization: Bearer YOUR_TOKEN"
 * @apiSuccessExample {json} Success-Response:
 *   HTTP/1.1 200 OK
 *   {
 *     "success": true,
 *     "message": "MeshCentral sync completed",
 *     "stats": {
 *       "devicesUpdated": 145,
 *       "groupsUpdated": 8
 *     },
 *     "lastSync": "2026-03-12T10:30:00.000Z",
 *     "lastGroupSync": "2026-03-12T10:30:15.000Z"
 *   }
 */
router.post('/meshcentral', authenticateToken, async (req, res) => {
  try {
    console.log('[API] Manual MeshCentral sync triggered by user:', req.user.email);
    
    // Get the sync worker
    const syncWorker = require('../workers/meshcentral-device-sync');
    
    // Trigger manual sync
    await syncWorker.sync();
    await syncWorker.syncMeshGroups();
    
    const status = syncWorker.getStatus();
    
    res.json({
      success: true,
      message: 'MeshCentral sync completed',
      stats: status.stats,
      lastSync: status.lastDeviceSync,
      lastGroupSync: status.lastGroupSync
    });
  } catch (error) {
    console.error('[API] Manual sync error:', error);
    res.status(500).json({
      success: false,
      message: 'Sync failed',
      error: error.message
    });
  }
});
 
/**
 * @api {get} /api/sync/meshcentral/status Get sync status
 * @apiName GetMeshCentralSyncStatus
 * @apiGroup Sync
 * @apiDescription Get current status of MeshCentral sync worker including statistics,
 * last sync timestamps, and sync interval configuration. Does not trigger sync.
 * @apiSuccess {boolean} success=true Status retrieved successfully
 * @apiSuccess {object} status Sync worker status
 * @apiSuccess {object} status.stats Sync statistics
 * @apiSuccess {number} status.stats.devicesUpdated Devices synced in last run
 * @apiSuccess {number} status.stats.groupsUpdated Groups synced in last run
 * @apiSuccess {DateTime} status.lastDeviceSync Last device sync timestamp
 * @apiSuccess {DateTime} status.lastGroupSync Last group sync timestamp
 * @apiSuccess {number} status.syncInterval Sync interval in milliseconds
 * @apiError {boolean} success=false Status check failed
 * @apiError {string} error Error message details
 * @apiExample {curl} Example:
 *   curl -X GET http://localhost:3000/api/sync/meshcentral/status \\
 *     -H "Authorization: Bearer YOUR_TOKEN"
 * @apiSuccessExample {json} Success-Response:
 *   HTTP/1.1 200 OK
 *   {
 *     "success": true,
 *     "status": {
 *       "stats": {
 *         "devicesUpdated": 145,
 *         "groupsUpdated": 8
 *       },
 *       "lastDeviceSync": "2026-03-12T10:30:00.000Z",
 *       "lastGroupSync": "2026-03-12T10:30:15.000Z",
 *       "syncInterval": 300000
 *     }
 *   }
 */
router.get('/meshcentral/status', authenticateToken, async (req, res) => {
  try {
    const syncWorker = require('../workers/meshcentral-device-sync');
    const status = syncWorker.getStatus();
    
    res.json({
      success: true,
      status: status
    });
  } catch (error) {
    console.error('[API] Status check error:', error);
    res.status(500).json({
      success: false,
      error: error.message
    });
  }
});
 
module.exports = router;