tenantIcon.js

Go to the documentation of this file.

/**
 * @file tenantIcon.js
 * @module routes/tenantIcon
 * @description Tenant branding icon upload and retrieval endpoints.
 * Allows tenants to upload custom .ico favicon files for white-label branding.
 * @requires express
 * @requires multer
 * @requires path
 * @requires fs
 * @author RMM-PSA Development Team
 * @copyright 2026 RMM-PSA Platform
 * @license Proprietary
 */
 
/**
 * @apiDefine TenantIcon Tenant Branding
 * Custom tenant icon/favicon management
 */
 
const express = require('express');
const multer = require('multer');
const path = require('path');
const fs = require('fs');
const router = express.Router();
 
// Use /tmp for DO App Platform (read-only filesystem)
const ICONS_DIR = process.env.NODE_ENV === 'production' 
  ? '/tmp/tenant_icons' 
  : path.join(__dirname, '../../tenant_icons');
if (!fs.existsSync(ICONS_DIR)) fs.mkdirSync(ICONS_DIR, { recursive: true });
 
const upload = multer({
  storage: multer.diskStorage({
    destination: (req, file, cb) => cb(null, ICONS_DIR),
    filename: (req, file, cb) => cb(null, `${req.params.tenantId}.ico`)
  }),
  fileFilter: (req, file, cb) => {
    if (file.mimetype === 'image/png' || file.mimetype === 'image/x-icon') cb(null, true);
    else cb(new Error('Invalid file type'));
  }
});
 
/**
 * @api {post} /api/tenant/:tenantId/icon Upload tenant icon
 * @apiName UploadTenantIcon
 * @apiGroup TenantIcon
 * @apiDescription Upload custom favicon/icon for tenant branding (white-label).
 * Accepts PNG or ICO format. File stored as {tenantId}.ico. Replaces existing icon.
 * @apiParam {number} tenantId Tenant ID (path parameter)
 * @apiParam {File} icon Icon file (multipart/form-data, PNG or ICO, field name: "icon")
 * @apiSuccess {boolean} ok=true Upload successful
 * @apiError (400) {String} error="Invalid file type" File not PNG or ICO
 * @apiExample {curl} Example:
 *   curl -X POST http://localhost:3000/api/tenant/2/icon \\
 *     -F "icon=@/path/to/favicon.ico"
 * @apiSuccessExample {json} Success-Response:
 *   HTTP/1.1 200 OK
 *   {
 *     "ok": true
 *   }
 */
router.post('/:tenantId/icon', upload.single('icon'), (req, res) => {
  res.json({ ok: true });
});
 
/**
 * @api {get} /api/tenant/:tenantId/icon Get tenant icon
 * @apiName GetTenantIcon
 * @apiGroup TenantIcon
 * @apiDescription Retrieve custom tenant icon/favicon file. Returns binary ICO/PNG file.
 * Used for displaying custom branding in dashboard and agent applications.
 * @apiParam {number} tenantId Tenant ID (path parameter)
 * @apiSuccess {File} icon Binary icon file (PNG or ICO format)
 * @apiError (404) Status=404 Icon not found for tenant
 * @apiExample {curl} Example:
 *   curl -X GET http://localhost:3000/api/tenant/2/icon \\
 *     -o tenant-icon.ico
 * @apiSuccessExample {binary} Success-Response:
 *   HTTP/1.1 200 OK
 *   Content-Type: image/x-icon
 *   
 *   [binary icon file content]
 */
router.get('/:tenantId/icon', (req, res) => {
  const iconPath = path.join(ICONS_DIR, `${req.params.tenantId}.ico`);
  if (fs.existsSync(iconPath)) {
    res.sendFile(iconPath);
  } else {
    res.status(404).end();
  }
});
 
module.exports = router;