matterbridge 3.0.1-dev-20250506-c77ed36 → 3.0.1

package/dist/frontend.js

@@ -1,28 +1,111 @@
+/**
+ * This file contains the class Frontend.
+ *
+ * @file frontend.ts
+ * @author Luca Liguori
+ * @date 2025-01-13
+ * @version 1.0.2
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
+// @matter
 import { EndpointServer, Logger, LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, Lifecycle } from '@matter/main';
+// Node modules
 import { createServer } from 'node:http';
 import https from 'node:https';
 import os from 'node:os';
 import path from 'node:path';
 import { promises as fs } from 'node:fs';
+// Third-party modules
 import express from 'express';
 import WebSocket, { WebSocketServer } from 'ws';
 import multer from 'multer';
+// AnsiLogger module
 import { AnsiLogger, stringify, debugStringify, CYAN, db, er, nf, rs, UNDERLINE, UNDERLINEOFF, wr, YELLOW, nt } from './logger/export.js';
+// Matterbridge
 import { createZip, deepCopy, isValidArray, isValidNumber, isValidObject, isValidString, isValidBoolean } from './utils/export.js';
 import { plg } from './matterbridgeTypes.js';
 import { hasParameter } from './utils/export.js';
 import { BridgedDeviceBasicInformation, PowerSource } from '@matter/main/clusters';
+/**
+ * Websocket message ID for logging.
+ * @constant {number}
+ */
 export const WS_ID_LOG = 0;
+/**
+ * Websocket message ID indicating a refresh is needed.
+ * @constant {number}
+ */
 export const WS_ID_REFRESH_NEEDED = 1;
+/**
+ * Websocket message ID indicating a restart is needed.
+ * @constant {number}
+ */
 export const WS_ID_RESTART_NEEDED = 2;
+/**
+ * Websocket message ID indicating a cpu update.
+ * @constant {number}
+ */
 export const WS_ID_CPU_UPDATE = 3;
+/**
+ * Websocket message ID indicating a memory update.
+ * @constant {number}
+ */
 export const WS_ID_MEMORY_UPDATE = 4;
+/**
+ * Websocket message ID indicating an uptime update.
+ * @constant {number}
+ */
 export const WS_ID_UPTIME_UPDATE = 5;
+/**
+ * Websocket message ID indicating a snackbar message.
+ * @constant {number}
+ */
 export const WS_ID_SNACKBAR = 6;
+/**
+ * Websocket message ID indicating matterbridge has un update available.
+ * @constant {number}
+ */
 export const WS_ID_UPDATE_NEEDED = 7;
+/**
+ * Websocket message ID indicating a state update.
+ * @constant {number}
+ */
 export const WS_ID_STATEUPDATE = 8;
+/**
+ * Websocket message ID indicating to close a permanent snackbar message.
+ * @constant {number}
+ */
 export const WS_ID_CLOSE_SNACKBAR = 9;
+/**
+ * Websocket message ID indicating a shelly system update.
+ * check:
+ * curl -k http://127.0.0.1:8101/api/updates/sys/check
+ * perform:
+ * curl -k http://127.0.0.1:8101/api/updates/sys/perform
+ * @constant {number}
+ */
 export const WS_ID_SHELLY_SYS_UPDATE = 100;
+/**
+ * Websocket message ID indicating a shelly main update.
+ * check:
+ * curl -k http://127.0.0.1:8101/api/updates/main/check
+ * perform:
+ * curl -k http://127.0.0.1:8101/api/updates/main/perform
+ * @constant {number}
+ */
 export const WS_ID_SHELLY_MAIN_UPDATE = 101;
 export class Frontend {
     matterbridge;
@@ -40,7 +123,7 @@ export class Frontend {
     memoryTimeout;
     constructor(matterbridge) {
         this.matterbridge = matterbridge;
-        this.log = new AnsiLogger({ logName: 'Frontend', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
+        this.log = new AnsiLogger({ logName: 'Frontend', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
     }
     set logLevel(logLevel) {
         this.log.logLevel = logLevel;
@@ -48,13 +131,43 @@ export class Frontend {
     async start(port = 8283) {
         this.port = port;
         this.log.debug(`Initializing the frontend ${hasParameter('ssl') ? 'https' : 'http'} server on port ${YELLOW}${this.port}${db}`);
+        // Initialize multer with the upload directory
         const uploadDir = path.join(this.matterbridge.matterbridgeDirectory, 'uploads');
         await fs.mkdir(uploadDir, { recursive: true });
         const upload = multer({ dest: uploadDir });
+        // Create the express app that serves the frontend
         this.expressApp = express();
+        // Inject logging/debug wrapper for route/middleware registration
+        /*
+        const methods = ['get', 'post', 'put', 'delete', 'use'];
+        for (const method of methods) {
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          const original = (this.expressApp as any)[method].bind(this.expressApp);
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          (this.expressApp as any)[method] = (path: any, ...rest: any) => {
+            try {
+              console.log(`[DEBUG] Registering ${method.toUpperCase()} route:`, path);
+              return original(path, ...rest);
+            } catch (err) {
+              console.error(`[ERROR] Failed to register route: ${path}`);
+              throw err;
+            }
+          };
+        }
+        */
+        // Log all requests to the server for debugging
+        /*
+        this.expressApp.use((req, res, next) => {
+          this.log.debug(`***Received request on expressApp: ${req.method} ${req.url}`);
+          next();
+        });
+        */
+        // Serve static files from '/static' endpoint
         this.expressApp.use(express.static(path.join(this.matterbridge.rootDirectory, 'frontend/build')));
         if (!hasParameter('ssl')) {
+            // Create an HTTP server and attach the express app
             this.httpServer = createServer(this.expressApp);
+            // Listen on the specified port
             if (hasParameter('ingress')) {
                 this.httpServer.listen(this.port, '0.0.0.0', () => {
                     this.log.info(`The frontend http server is listening on ${UNDERLINE}http://0.0.0.0:${this.port}${UNDERLINEOFF}${rs}`);
@@ -68,6 +181,7 @@ export class Frontend {
                         this.log.info(`The frontend http server is listening on ${UNDERLINE}http://[${this.matterbridge.systemInformation.ipv6Address}]:${this.port}${UNDERLINEOFF}${rs}`);
                 });
             }
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             this.httpServer.on('error', (error) => {
                 this.log.error(`Frontend http server error listening on ${this.port}`);
                 switch (error.code) {
@@ -83,6 +197,7 @@ export class Frontend {
             });
         }
         else {
+            // Load the SSL certificate, the private key and optionally the CA certificate
             let cert;
             try {
                 cert = await fs.readFile(path.join(this.matterbridge.matterbridgeDirectory, 'certs/cert.pem'), 'utf8');
@@ -110,7 +225,9 @@ export class Frontend {
                 this.log.info(`CA certificate file ${path.join(this.matterbridge.matterbridgeDirectory, 'certs/ca.pem')} not loaded: ${error}`);
             }
             const serverOptions = { cert, key, ca };
+            // Create an HTTPS server with the SSL certificate and private key (ca is optional) and attach the express app
             this.httpsServer = https.createServer(serverOptions, this.expressApp);
+            // Listen on the specified port
             if (hasParameter('ingress')) {
                 this.httpsServer.listen(this.port, '0.0.0.0', () => {
                     this.log.info(`The frontend https server is listening on ${UNDERLINE}https://0.0.0.0:${this.port}${UNDERLINEOFF}${rs}`);
@@ -124,6 +241,7 @@ export class Frontend {
                         this.log.info(`The frontend https server is listening on ${UNDERLINE}https://[${this.matterbridge.systemInformation.ipv6Address}]:${this.port}${UNDERLINEOFF}${rs}`);
                 });
             }
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             this.httpsServer.on('error', (error) => {
                 this.log.error(`Frontend https server error listening on ${this.port}`);
                 switch (error.code) {
@@ -140,16 +258,18 @@ export class Frontend {
         }
         if (this.initializeError)
             return;
+        // Create a WebSocket server and attach it to the http or https server
         const wssPort = this.port;
         const wssHost = hasParameter('ssl') ? `wss://${this.matterbridge.systemInformation.ipv4Address}:${wssPort}` : `ws://${this.matterbridge.systemInformation.ipv4Address}:${wssPort}`;
         this.webSocketServer = new WebSocketServer(hasParameter('ssl') ? { server: this.httpsServer } : { server: this.httpServer });
         this.webSocketServer.on('connection', (ws, request) => {
             const clientIp = request.socket.remoteAddress;
-            let callbackLogLevel = "notice";
-            if (this.matterbridge.matterbridgeInformation.loggerLevel === "info" || this.matterbridge.matterbridgeInformation.matterLoggerLevel === MatterLogLevel.INFO)
-                callbackLogLevel = "info";
-            if (this.matterbridge.matterbridgeInformation.loggerLevel === "debug" || this.matterbridge.matterbridgeInformation.matterLoggerLevel === MatterLogLevel.DEBUG)
-                callbackLogLevel = "debug";
+            // Set the global logger callback for the WebSocketServer
+            let callbackLogLevel = "notice" /* LogLevel.NOTICE */;
+            if (this.matterbridge.matterbridgeInformation.loggerLevel === "info" /* LogLevel.INFO */ || this.matterbridge.matterbridgeInformation.matterLoggerLevel === MatterLogLevel.INFO)
+                callbackLogLevel = "info" /* LogLevel.INFO */;
+            if (this.matterbridge.matterbridgeInformation.loggerLevel === "debug" /* LogLevel.DEBUG */ || this.matterbridge.matterbridgeInformation.matterLoggerLevel === MatterLogLevel.DEBUG)
+                callbackLogLevel = "debug" /* LogLevel.DEBUG */;
             AnsiLogger.setGlobalCallback(this.wssSendMessage.bind(this), callbackLogLevel);
             this.log.debug(`WebSocketServer logger global callback set to ${callbackLogLevel}`);
             this.log.info(`WebSocketServer client "${clientIp}" connected to Matterbridge`);
@@ -183,6 +303,7 @@ export class Frontend {
         this.webSocketServer.on('error', (ws, error) => {
             this.log.error(`WebSocketServer error: ${error}`);
         });
+        // Subscribe to cli events
         const { cliEmitter } = await import('./cli.js');
         cliEmitter.removeAllListeners();
         cliEmitter.on('uptime', (systemUptime, processUptime) => {
@@ -194,6 +315,7 @@ export class Frontend {
         cliEmitter.on('cpu', (cpuUsage) => {
             this.wssSendCpuUpdate(cpuUsage);
         });
+        // Endpoint to validate login code
         this.expressApp.post('/api/login', express.json(), async (req, res) => {
             const { password } = req.body;
             this.log.debug('The frontend sent /api/login', password);
@@ -212,23 +334,27 @@ export class Frontend {
                     this.log.warn('/api/login error wrong password');
                     res.json({ valid: false });
                 }
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
             }
             catch (error) {
                 this.log.error('/api/login error getting password');
                 res.json({ valid: false });
             }
         });
+        // Endpoint to provide health check for docker
         this.expressApp.get('/health', (req, res) => {
             this.log.debug('Express received /health');
             const healthStatus = {
-                status: 'ok',
-                uptime: process.uptime(),
-                timestamp: new Date().toISOString(),
+                status: 'ok', // Indicate service is healthy
+                uptime: process.uptime(), // Server uptime in seconds
+                timestamp: new Date().toISOString(), // Current timestamp
             };
             res.status(200).json(healthStatus);
         });
+        // Endpoint to provide memory usage details
         this.expressApp.get('/memory', async (req, res) => {
             this.log.debug('Express received /memory');
+            // Memory usage from process
             const memoryUsageRaw = process.memoryUsage();
             const memoryUsage = {
                 rss: this.formatMemoryUsage(memoryUsageRaw.rss),
@@ -237,10 +363,13 @@ export class Frontend {
                 external: this.formatMemoryUsage(memoryUsageRaw.external),
                 arrayBuffers: this.formatMemoryUsage(memoryUsageRaw.arrayBuffers),
             };
+            // V8 heap statistics
             const { default: v8 } = await import('node:v8');
             const heapStatsRaw = v8.getHeapStatistics();
             const heapSpacesRaw = v8.getHeapSpaceStatistics();
+            // Format heapStats
             const heapStats = Object.fromEntries(Object.entries(heapStatsRaw).map(([key, value]) => [key, this.formatMemoryUsage(value)]));
+            // Format heapSpaces
             const heapSpaces = heapSpacesRaw.map((space) => ({
                 ...space,
                 space_size: this.formatMemoryUsage(space.space_size),
@@ -258,19 +387,23 @@ export class Frontend {
             };
             res.status(200).json(memoryReport);
         });
+        // Endpoint to provide settings
         this.expressApp.get('/api/settings', express.json(), async (req, res) => {
             this.log.debug('The frontend sent /api/settings');
             res.json(await this.getApiSettings());
         });
+        // Endpoint to provide plugins
         this.expressApp.get('/api/plugins', async (req, res) => {
             this.log.debug('The frontend sent /api/plugins');
             res.json(this.getBaseRegisteredPlugins());
         });
+        // Endpoint to provide devices
         this.expressApp.get('/api/devices', async (req, res) => {
             this.log.debug('The frontend sent /api/devices');
             const devices = await this.getDevices();
             res.json(devices);
         });
+        // Endpoint to view the matterbridge log
         this.expressApp.get('/api/view-mblog', async (req, res) => {
             this.log.debug('The frontend sent /api/view-mblog');
             try {
@@ -283,6 +416,7 @@ export class Frontend {
                 res.status(500).send('Error reading matterbridge log file. Please enable the matterbridge log on file in the settings.');
             }
         });
+        // Endpoint to view the matter.js log
         this.expressApp.get('/api/view-mjlog', async (req, res) => {
             this.log.debug('The frontend sent /api/view-mjlog');
             try {
@@ -295,6 +429,7 @@ export class Frontend {
                 res.status(500).send('Error reading matter log file. Please enable the matter log on file in the settings.');
             }
         });
+        // Endpoint to view the shelly log
         this.expressApp.get('/api/shellyviewsystemlog', async (req, res) => {
             this.log.debug('The frontend sent /api/shellyviewsystemlog');
             try {
@@ -307,6 +442,7 @@ export class Frontend {
                 res.status(500).send('Error reading shelly log file. Please create the shelly system log before loading it.');
             }
         });
+        // Endpoint to download the matterbridge log
         this.expressApp.get('/api/download-mblog', async (req, res) => {
             this.log.debug(`The frontend sent /api/download-mblog ${path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile)}`);
             try {
@@ -319,6 +455,7 @@ export class Frontend {
                 this.log.debug(`Error in /api/download-mblog: ${error instanceof Error ? error.message : error}`);
             }
             res.type('text/plain');
+            // res.download(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile), 'matterbridge.log', (error) => {
             res.download(path.join(os.tmpdir(), this.matterbridge.matterbrideLoggerFile), 'matterbridge.log', (error) => {
                 if (error) {
                     this.log.error(`Error downloading log file ${this.matterbridge.matterbrideLoggerFile}: ${error instanceof Error ? error.message : error}`);
@@ -326,6 +463,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matter log
         this.expressApp.get('/api/download-mjlog', async (req, res) => {
             this.log.debug(`The frontend sent /api/download-mjlog ${path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile)}`);
             try {
@@ -345,6 +483,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the shelly log
         this.expressApp.get('/api/shellydownloadsystemlog', async (req, res) => {
             this.log.debug('The frontend sent /api/shellydownloadsystemlog');
             try {
@@ -364,6 +503,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matterbridge storage directory
         this.expressApp.get('/api/download-mbstorage', async (req, res) => {
             this.log.debug('The frontend sent /api/download-mbstorage');
             await createZip(path.join(os.tmpdir(), `matterbridge.${this.matterbridge.nodeStorageName}.zip`), path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.nodeStorageName));
@@ -374,6 +514,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matter storage file
         this.expressApp.get('/api/download-mjstorage', async (req, res) => {
             this.log.debug('The frontend sent /api/download-mjstorage');
             await createZip(path.join(os.tmpdir(), `matterbridge.${this.matterbridge.matterStorageName}.zip`), path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterStorageName));
@@ -384,6 +525,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matterbridge plugin directory
         this.expressApp.get('/api/download-pluginstorage', async (req, res) => {
             this.log.debug('The frontend sent /api/download-pluginstorage');
             await createZip(path.join(os.tmpdir(), `matterbridge.pluginstorage.zip`), this.matterbridge.matterbridgePluginDirectory);
@@ -394,9 +536,11 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matterbridge plugin config files
         this.expressApp.get('/api/download-pluginconfig', async (req, res) => {
             this.log.debug('The frontend sent /api/download-pluginconfig');
             await createZip(path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), path.relative(process.cwd(), path.join(this.matterbridge.matterbridgeDirectory, '*.config.json')));
+            // await createZip(path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), path.relative(process.cwd(), path.join(this.matterbridge.matterbridgeDirectory, 'certs', '*.*')), path.relative(process.cwd(), path.join(this.matterbridge.matterbridgeDirectory, '*.config.json')));
             res.download(path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), `matterbridge.pluginconfig.zip`, (error) => {
                 if (error) {
                     this.log.error(`Error downloading file matterbridge.pluginstorage.zip: ${error instanceof Error ? error.message : error}`);
@@ -404,6 +548,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matterbridge plugin config files
         this.expressApp.get('/api/download-backup', async (req, res) => {
             this.log.debug('The frontend sent /api/download-backup');
             res.download(path.join(os.tmpdir(), `matterbridge.backup.zip`), `matterbridge.backup.zip`, (error) => {
@@ -413,6 +558,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to upload a package
         this.expressApp.post('/api/uploadpackage', upload.single('file'), async (req, res) => {
             const { filename } = req.body;
             const file = req.file;
@@ -422,10 +568,13 @@ export class Frontend {
                 return;
             }
             this.wssSendSnackbarMessage(`Installing package ${filename}. Please wait...`, 0);
+            // Define the path where the plugin file will be saved
             const filePath = path.join(this.matterbridge.matterbridgeDirectory, 'uploads', filename);
             try {
+                // Move the uploaded file to the specified path
                 await fs.rename(file.path, filePath);
                 this.log.info(`File ${plg}${filename}${nf} uploaded successfully`);
+                // Install the plugin package
                 if (filename.endsWith('.tgz')) {
                     await this.matterbridge.spawnCommand('npm', ['install', '-g', filePath, '--omit=dev', '--verbose']);
                     this.log.info(`Plugin package ${plg}${filename}${nf} installed successfully. Full restart required.`);
@@ -444,6 +593,7 @@ export class Frontend {
                 res.status(500).send(`Error uploading or installing plugin package ${filename}`);
             }
         });
+        // Fallback for routing (must be the last route)
         this.expressApp.use((req, res) => {
             this.log.debug('The frontend sent:', req.url);
             res.sendFile(path.join(this.matterbridge.rootDirectory, 'frontend/build/index.html'));
@@ -451,24 +601,29 @@ export class Frontend {
         this.log.debug(`Frontend initialized on port ${YELLOW}${this.port}${db} static ${UNDERLINE}${path.join(this.matterbridge.rootDirectory, 'frontend/build')}${UNDERLINEOFF}${rs}`);
     }
     async stop() {
+        // Close the http server
         if (this.httpServer) {
             this.httpServer.close();
             this.httpServer.removeAllListeners();
             this.httpServer = undefined;
             this.log.debug('Frontend http server closed successfully');
         }
+        // Close the https server
         if (this.httpsServer) {
             this.httpsServer.close();
             this.httpsServer.removeAllListeners();
             this.httpsServer = undefined;
             this.log.debug('Frontend https server closed successfully');
         }
+        // Remove listeners from the express app
         if (this.expressApp) {
             this.expressApp.removeAllListeners();
             this.expressApp = undefined;
             this.log.debug('Frontend app closed successfully');
         }
+        // Close the WebSocket server
         if (this.webSocketServer) {
+            // Close all active connections
             this.webSocketServer.clients.forEach((client) => {
                 if (client.readyState === WebSocket.OPEN) {
                     client.close();
@@ -485,6 +640,7 @@ export class Frontend {
             this.webSocketServer = undefined;
         }
     }
+    // Function to format bytes to KB, MB, or GB
     formatMemoryUsage = (bytes) => {
         if (bytes >= 1024 ** 3) {
             return `${(bytes / 1024 ** 3).toFixed(2)} GB`;
@@ -496,6 +652,7 @@ export class Frontend {
             return `${(bytes / 1024).toFixed(2)} KB`;
         }
     };
+    // Function to format system uptime with only the most significant unit
     formatOsUpTime = (seconds) => {
         if (seconds >= 86400) {
             const days = Math.floor(seconds / 86400);
@@ -511,8 +668,13 @@ export class Frontend {
         }
         return `${seconds} second${seconds !== 1 ? 's' : ''}`;
     };
+    /**
+     * Retrieves the api settings data.
+     * @returns {Promise<object>} A promise that resolve in the api settings object.
+     */
     async getApiSettings() {
         const { lastCpuUsage } = await import('./cli.js');
+        // Update the system information
         this.matterbridge.systemInformation.totalMemory = this.formatMemoryUsage(os.totalmem());
         this.matterbridge.systemInformation.freeMemory = this.formatMemoryUsage(os.freemem());
         this.matterbridge.systemInformation.systemUptime = this.formatOsUpTime(os.uptime());
@@ -521,6 +683,7 @@ export class Frontend {
         this.matterbridge.systemInformation.rss = this.formatMemoryUsage(process.memoryUsage().rss);
         this.matterbridge.systemInformation.heapTotal = this.formatMemoryUsage(process.memoryUsage().heapTotal);
         this.matterbridge.systemInformation.heapUsed = this.formatMemoryUsage(process.memoryUsage().heapUsed);
+        // Update the matterbridge information
         this.matterbridge.matterbridgeInformation.bridgeMode = this.matterbridge.bridgeMode;
         this.matterbridge.matterbridgeInformation.restartMode = this.matterbridge.restartMode;
         this.matterbridge.matterbridgeInformation.loggerLevel = this.matterbridge.log.logLevel;
@@ -539,6 +702,11 @@ export class Frontend {
         this.matterbridge.matterbridgeInformation.profile = this.matterbridge.profile;
         return { systemInformation: this.matterbridge.systemInformation, matterbridgeInformation: this.matterbridge.matterbridgeInformation };
     }
+    /**
+     * Retrieves the reachable attribute.
+     * @param {MatterbridgeDevice} device - The MatterbridgeDevice object.
+     * @returns {boolean} The reachable attribute.
+     */
     getReachability(device) {
         if (!device.lifecycle.isReady || device.construction.status !== Lifecycle.Status.Active)
             return false;
@@ -563,13 +731,20 @@ export class Frontend {
             }
             return;
         };
+        // Root endpoint
         if (device.hasClusterServer(PowerSource.Cluster.id))
             return powerSource(device);
+        // Child endpoints
         for (const child of device.getChildEndpoints()) {
             if (child.hasClusterServer(PowerSource.Cluster.id))
                 return powerSource(child);
         }
     }
+    /**
+     * Retrieves the cluster text description from a given device.
+     * @param {MatterbridgeDevice} device - The MatterbridgeDevice object.
+     * @returns {string} The attributes description of the cluster servers in the device.
+     */
     getClusterTextFromDevice(device) {
         if (!device.lifecycle.isReady || device.construction.status !== Lifecycle.Status.Active)
             return '';
@@ -611,6 +786,7 @@ export class Frontend {
         let attributes = '';
         let supportedModes = [];
         device.forEachAttribute((clusterName, clusterId, attributeName, attributeId, attributeValue) => {
+            // console.log(`${device.deviceName} => Cluster: ${clusterName}-${clusterId} Attribute: ${attributeName}-${attributeId} Value(${typeof attributeValue}): ${attributeValue}`);
             if (typeof attributeValue === 'undefined')
                 return;
             if (clusterName === 'onOff' && attributeName === 'onOff')
@@ -702,8 +878,13 @@ export class Frontend {
             if (clusterName === 'userLabel' && attributeName === 'labelList')
                 attributes += `${getUserLabel(device)} `;
         });
+        // console.log(`${device.deviceName}.forEachAttribute: ${attributes}`);
         return attributes.trimStart().trimEnd();
     }
+    /**
+     * Retrieves the base registered plugins sanitized for res.json().
+     * @returns {BaseRegisteredPlugin[]} An array of BaseRegisteredPlugin.
+     */
     getBaseRegisteredPlugins() {
         const baseRegisteredPlugins = [];
         for (const plugin of this.matterbridge.plugins) {
@@ -742,11 +923,18 @@ export class Frontend {
         }
         return baseRegisteredPlugins;
     }
+    /**
+     * Retrieves the devices from Matterbridge.
+     * @param {string} [pluginName] - The name of the plugin to filter devices by.
+     * @returns {Promise<ApiDevices[]>} A promise that resolves to an array of ApiDevices.
+     */
     async getDevices(pluginName) {
         const devices = [];
         this.matterbridge.devices.forEach(async (device) => {
+            // Filter by pluginName if provided
             if (pluginName && pluginName !== device.plugin)
                 return;
+            // Check if the device has the required properties
             if (!device.plugin || !device.name || !device.deviceName || !device.serialNumber || !device.uniqueId || !device.lifecycle.isReady)
                 return;
             const cluster = this.getClusterTextFromDevice(device);
@@ -766,6 +954,13 @@ export class Frontend {
         });
         return devices;
     }
+    /**
+     * Handles incoming websocket messages for the Matterbridge frontend.
+     *
+     * @param {WebSocket} client - The websocket client that sent the message.
+     * @param {WebSocket.RawData} message - The raw data of the message received from the client.
+     * @returns {Promise<void>} A promise that resolves when the message has been handled.
+     */
     async wsMessageHandler(client, message) {
         let data;
         try {
@@ -812,8 +1007,10 @@ export class Frontend {
                     this.wssSendSnackbarMessage(`Installed package ${data.params.packageName}`, 5, 'success');
                     const packageName = data.params.packageName.replace(/@.*$/, '');
                     if (data.params.restart === false && packageName !== 'matterbridge') {
+                        // The install comes from InstallPlugins
                         this.matterbridge.plugins.add(packageName).then((plugin) => {
                             if (plugin) {
+                                // The plugin is not registered
                                 this.wssSendSnackbarMessage(`Added plugin ${packageName}`, 5, 'success');
                                 this.matterbridge.plugins.load(plugin, true, 'The plugin has been added', true).then(() => {
                                     this.wssSendSnackbarMessage(`Started plugin ${packageName}`, 5, 'success');
@@ -821,6 +1018,7 @@ export class Frontend {
                                 });
                             }
                             else {
+                                // The plugin is already registered
                                 this.wssSendSnackbarMessage(`Restart required`, 0);
                                 this.wssSendRefreshRequired('plugins');
                                 this.wssSendRestartRequired();
@@ -828,6 +1026,7 @@ export class Frontend {
                         });
                     }
                     else {
+                        // The package is matterbridge
                         if (this.matterbridge.restartMode !== '') {
                             this.wssSendSnackbarMessage(`Restarting matterbridge...`, 0);
                             this.matterbridge.shutdownProcess();
@@ -849,6 +1048,7 @@ export class Frontend {
                     client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: 'Wrong parameter packageName in /api/uninstall' }));
                     return;
                 }
+                // The package is a plugin
                 const plugin = this.matterbridge.plugins.get(data.params.packageName);
                 if (plugin) {
                     await this.matterbridge.plugins.shutdown(plugin, 'The plugin has been removed.', true);
@@ -857,6 +1057,7 @@ export class Frontend {
                     this.wssSendRefreshRequired('plugins');
                     this.wssSendRefreshRequired('devices');
                 }
+                // Uninstall the package
                 this.wssSendSnackbarMessage(`Uninstalling package ${data.params.packageName}...`, 0);
                 this.matterbridge
                     .spawnCommand('npm', ['uninstall', '-g', data.params.packageName, '--verbose'])
@@ -1133,6 +1334,7 @@ export class Frontend {
                     });
                     endpointServer.getChildEndpoints().forEach((childEndpoint) => {
                         deviceTypes = [];
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
                         const name = childEndpoint.endpoint?.id;
                         const clusterServers = childEndpoint.getAllClusterServers();
                         clusterServers.forEach((clusterServer) => {
@@ -1246,22 +1448,22 @@ export class Frontend {
                         if (isValidString(data.params.value, 4)) {
                             this.log.debug('Matterbridge logger level:', data.params.value);
                             if (data.params.value === 'Debug') {
-                                await this.matterbridge.setLogLevel("debug");
+                                await this.matterbridge.setLogLevel("debug" /* LogLevel.DEBUG */);
                             }
                             else if (data.params.value === 'Info') {
-                                await this.matterbridge.setLogLevel("info");
+                                await this.matterbridge.setLogLevel("info" /* LogLevel.INFO */);
                             }
                             else if (data.params.value === 'Notice') {
-                                await this.matterbridge.setLogLevel("notice");
+                                await this.matterbridge.setLogLevel("notice" /* LogLevel.NOTICE */);
                             }
                             else if (data.params.value === 'Warn') {
-                                await this.matterbridge.setLogLevel("warn");
+                                await this.matterbridge.setLogLevel("warn" /* LogLevel.WARN */);
                             }
                             else if (data.params.value === 'Error') {
-                                await this.matterbridge.setLogLevel("error");
+                                await this.matterbridge.setLogLevel("error" /* LogLevel.ERROR */);
                             }
                             else if (data.params.value === 'Fatal') {
-                                await this.matterbridge.setLogLevel("fatal");
+                                await this.matterbridge.setLogLevel("fatal" /* LogLevel.FATAL */);
                             }
                             await this.matterbridge.nodeContext?.set('matterbridgeLogLevel', this.log.logLevel);
                             client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true }));
@@ -1272,6 +1474,7 @@ export class Frontend {
                             this.log.debug('Matterbridge file log:', data.params.value);
                             this.matterbridge.matterbridgeInformation.fileLogger = data.params.value;
                             await this.matterbridge.nodeContext?.set('matterbridgeFileLog', data.params.value);
+                            // Create the file logger for matterbridge
                             if (data.params.value)
                                 AnsiLogger.setGlobalLogfile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile), this.matterbridge.matterbridgeInformation.loggerLevel, true);
                             else
@@ -1427,15 +1630,19 @@ export class Frontend {
                         return;
                     }
                     const config = plugin.configJson;
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                     const select = plugin.schemaJson?.properties?.blackList?.selectFrom;
+                    // this.log.debug(`SelectDevice(selectMode ${select}) data ${debugStringify(data)}`);
                     if (select === 'serial')
                         this.log.info(`Selected device serial ${data.params.serial}`);
                     if (select === 'name')
                         this.log.info(`Selected device name ${data.params.name}`);
                     if (config && select && (select === 'serial' || select === 'name')) {
+                        // Remove postfix from the serial if it exists
                         if (config.postfix) {
                             data.params.serial = data.params.serial.replace('-' + config.postfix, '');
                         }
+                        // Add the serial to the whiteList if the whiteList exists and the serial or name is not already in it
                         if (isValidArray(config.whiteList, 1)) {
                             if (select === 'serial' && !config.whiteList.includes(data.params.serial)) {
                                 config.whiteList.push(data.params.serial);
@@ -1444,6 +1651,7 @@ export class Frontend {
                                 config.whiteList.push(data.params.name);
                             }
                         }
+                        // Remove the serial from the blackList if the blackList exists and the serial or name is in it
                         if (isValidArray(config.blackList, 1)) {
                             if (select === 'serial' && config.blackList.includes(data.params.serial)) {
                                 config.blackList = config.blackList.filter((serial) => serial !== data.params.serial);
@@ -1473,7 +1681,9 @@ export class Frontend {
                         return;
                     }
                     const config = plugin.configJson;
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                     const select = plugin.schemaJson?.properties?.blackList?.selectFrom;
+                    // this.log.debug(`UnselectDevice(selectMode ${select}) data ${debugStringify(data)}`);
                     if (select === 'serial')
                         this.log.info(`Unselected device serial ${data.params.serial}`);
                     if (select === 'name')
@@ -1482,6 +1692,7 @@ export class Frontend {
                         if (config.postfix) {
                             data.params.serial = data.params.serial.replace('-' + config.postfix, '');
                         }
+                        // Remove the serial from the whiteList if the whiteList exists and the serial is in it
                         if (isValidArray(config.whiteList, 1)) {
                             if (select === 'serial' && config.whiteList.includes(data.params.serial)) {
                                 config.whiteList = config.whiteList.filter((serial) => serial !== data.params.serial);
@@ -1490,6 +1701,7 @@ export class Frontend {
                                 config.whiteList = config.whiteList.filter((name) => name !== data.params.name);
                             }
                         }
+                        // Add the serial to the blackList
                         if (isValidArray(config.blackList)) {
                             if (select === 'serial' && !config.blackList.includes(data.params.serial)) {
                                 config.blackList.push(data.params.serial);
@@ -1522,114 +1734,214 @@ export class Frontend {
             this.log.error(`Error parsing message "${message}" from websocket client:`, error instanceof Error ? error.message : error);
         }
     }
+    /**
+     * Sends a WebSocket message to all connected clients. The function is called by AnsiLogger.setGlobalCallback.
+     *
+     * @param {string} level - The logger level of the message: debug info notice warn error fatal...
+     * @param {string} time - The time string of the message
+     * @param {string} name - The logger name of the message
+     * @param {string} message - The content of the message.
+     */
     wssSendMessage(level, time, name, message) {
         if (!level || !time || !name || !message)
             return;
+        // Remove ANSI escape codes from the message
+        // eslint-disable-next-line no-control-regex
         message = message.replace(/\x1B\[[0-9;]*[m|s|u|K]/g, '');
+        // Remove leading asterisks from the message
         message = message.replace(/^\*+/, '');
+        // Replace all occurrences of \t and \n
         message = message.replace(/[\t\n]/g, '');
+        // Remove non-printable characters
+        // eslint-disable-next-line no-control-regex
         message = message.replace(/[\x00-\x1F\x7F]/g, '');
+        // Replace all occurrences of \" with "
         message = message.replace(/\\"/g, '"');
+        // Replace all occurrences of angle-brackets with &lt; and &gt;"
         message = message.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
+        // Define the maximum allowed length for continuous characters without a space
         const maxContinuousLength = 100;
         const keepStartLength = 20;
         const keepEndLength = 20;
+        // Split the message into words
         message = message
             .split(' ')
             .map((word) => {
+            // If the word length exceeds the max continuous length, insert spaces and truncate
             if (word.length > maxContinuousLength) {
                 return word.slice(0, keepStartLength) + ' ... ' + word.slice(-keepEndLength);
             }
             return word;
         })
             .join(' ');
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_LOG, src: 'Matterbridge', level, time, name, message }));
             }
         });
     }
+    /**
+     * Sends a need to refresh WebSocket message to all connected clients.
+     *
+     * @param {string} changed - The changed value. If null, the whole page will be refreshed.
+     * possible values:
+     * - 'matterbridgeLatestVersion'
+     * - 'matterbridgeAdvertise'
+     * - 'online'
+     * - 'offline'
+     * - 'reachability'
+     * - 'settings'
+     * - 'plugins'
+     * - 'pluginsRestart'
+     * - 'devices'
+     * - 'fabrics'
+     * - 'sessions'
+     */
     wssSendRefreshRequired(changed = null) {
         this.log.debug('Sending a refresh required message to all connected clients');
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_REFRESH_NEEDED, src: 'Matterbridge', dst: 'Frontend', method: 'refresh_required', params: { changed: changed } }));
             }
         });
     }
+    /**
+     * Sends a need to restart WebSocket message to all connected clients.
+     *
+     */
     wssSendRestartRequired(snackbar = true) {
         this.log.debug('Sending a restart required message to all connected clients');
         this.matterbridge.matterbridgeInformation.restartRequired = true;
         if (snackbar === true)
             this.wssSendSnackbarMessage(`Restart required`, 0);
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_RESTART_NEEDED, src: 'Matterbridge', dst: 'Frontend', method: 'restart_required', params: {} }));
             }
         });
     }
+    /**
+     * Sends a need to update WebSocket message to all connected clients.
+     *
+     */
     wssSendUpdateRequired() {
         this.log.debug('Sending an update required message to all connected clients');
         this.matterbridge.matterbridgeInformation.updateRequired = true;
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_UPDATE_NEEDED, src: 'Matterbridge', dst: 'Frontend', method: 'update_required', params: {} }));
             }
         });
     }
+    /**
+     * Sends a cpu update message to all connected clients.
+     *
+     */
     wssSendCpuUpdate(cpuUsage) {
         if (hasParameter('debug'))
             this.log.debug('Sending a cpu update message to all connected clients');
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_CPU_UPDATE, src: 'Matterbridge', dst: 'Frontend', method: 'cpu_update', params: { cpuUsage } }));
             }
         });
     }
+    /**
+     * Sends a memory update message to all connected clients.
+     *
+     */
     wssSendMemoryUpdate(totalMemory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers) {
         if (hasParameter('debug'))
             this.log.debug('Sending a memory update message to all connected clients');
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_MEMORY_UPDATE, src: 'Matterbridge', dst: 'Frontend', method: 'memory_update', params: { totalMemory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers } }));
             }
         });
     }
+    /**
+     * Sends an uptime update message to all connected clients.
+     *
+     */
     wssSendUptimeUpdate(systemUptime, processUptime) {
         if (hasParameter('debug'))
             this.log.debug('Sending a uptime update message to all connected clients');
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_UPTIME_UPDATE, src: 'Matterbridge', dst: 'Frontend', method: 'uptime_update', params: { systemUptime, processUptime } }));
             }
         });
     }
+    /**
+     * Sends an open snackbar message to all connected clients.
+     * @param {string} message - The message to send.
+     * @param {number} timeout - The timeout in seconds for the snackbar message.
+     * @param {'info' | 'warning' | 'error' | 'success'} severity - The severity of the snackbar message (default info).
+     *
+     */
     wssSendSnackbarMessage(message, timeout = 5, severity = 'info') {
         this.log.debug('Sending a snackbar message to all connected clients');
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_SNACKBAR, src: 'Matterbridge', dst: 'Frontend', params: { message, timeout, severity } }));
             }
         });
     }
+    /**
+     * Sends a close snackbar message to all connected clients.
+     * @param {string} message - The message to send.
+     *
+     */
     wssSendCloseSnackbarMessage(message) {
         this.log.debug('Sending a close snackbar message to all connected clients');
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_CLOSE_SNACKBAR, src: 'Matterbridge', dst: 'Frontend', params: { message } }));
             }
         });
     }
+    /**
+     * Sends an attribute update message to all connected WebSocket clients.
+     *
+     * @param {string | undefined} plugin - The name of the plugin.
+     * @param {string | undefined} serialNumber - The serial number of the device.
+     * @param {string | undefined} uniqueId - The unique identifier of the device.
+     * @param {string} cluster - The cluster name where the attribute belongs.
+     * @param {string} attribute - The name of the attribute that changed.
+     * @param {number | string | boolean} value - The new value of the attribute.
+     *
+     * @remarks
+     * This method logs a debug message and sends a JSON-formatted message to all connected WebSocket clients
+     * with the updated attribute information.
+     */
     wssSendAttributeChangedMessage(plugin, serialNumber, uniqueId, cluster, attribute, value) {
         this.log.debug('Sending an attribute update message to all connected clients');
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_STATEUPDATE, src: 'Matterbridge', dst: 'Frontend', method: 'state_update', params: { plugin, serialNumber, uniqueId, cluster, attribute, value } }));
             }
         });
     }
+    /**
+     * Sends a message to all connected clients.
+     * @param {number} id - The message id.
+     * @param {string} method - The message method.
+     * @param {Record<string, string | number | boolean>} params - The message parameters.
+     *
+     */
     wssBroadcastMessage(id, method, params) {
         this.log.debug(`Sending a broadcast message id ${id} method ${method} params ${debugStringify(params ?? {})} to all connected clients`);
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id, src: 'Matterbridge', dst: 'Frontend', method, params }));
@@ -1637,3 +1949,4 @@ export class Frontend {
         });
     }
 }
+//# sourceMappingURL=frontend.js.map