matterbridge 3.3.1-dev-20251012-b3546f8 → 3.3.1

package/dist/frontend.js

@@ -1,9 +1,35 @@
+/**
+ * This file contains the class Frontend.
+ *
+ * @file frontend.ts
+ * @author Luca Liguori
+ * @created 2025-01-13
+ * @version 1.3.0
+ * @license Apache-2.0
+ *
+ * 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.
+ */
+// eslint-disable-next-line no-console
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mFrontend loaded.\u001B[40;0m');
 import os from 'node:os';
 import path from 'node:path';
 import EventEmitter from 'node:events';
+// AnsiLogger module
 import { AnsiLogger, stringify, debugStringify, CYAN, db, er, nf, rs, UNDERLINE, UNDERLINEOFF, YELLOW, nt, wr } from 'node-ansi-logger';
+// @matter
 import { Logger, LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, Lifecycle, LogDestination, Diagnostic, Time, FabricIndex } from '@matter/main';
 import { BridgedDeviceBasicInformation } from '@matter/main/clusters/bridged-device-basic-information';
 import { PowerSource } from '@matter/main/clusters/power-source';
@@ -33,7 +59,7 @@ export class Frontend extends EventEmitter {
     constructor(matterbridge) {
         super();
         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 */ });
         this.log.logNameColor = '\x1b[38;5;97m';
         this.server = new BroadcastServer('plugins', this.log);
         this.server.on('broadcast_message', this.msgHandler.bind(this));
@@ -95,13 +121,42 @@ export class Frontend extends EventEmitter {
     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 multer = await import('multer');
-        const uploadDir = path.join(this.matterbridge.matterbridgeDirectory, 'uploads');
+        const uploadDir = path.join(this.matterbridge.matterbridgeDirectory, 'uploads'); // Is created by matterbridge initialize
         const upload = multer.default({ dest: uploadDir });
+        // Create the express app that serves the frontend
         const express = await import('express');
         this.expressApp = express.default();
+        // 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 'frontend/build' directory
         this.expressApp.use(express.static(path.join(this.matterbridge.rootDirectory, 'frontend/build')));
         if (!hasParameter('ssl')) {
+            // Create an HTTP server and attach the express app
             const http = await import('node:http');
             try {
                 this.log.debug(`Creating HTTP server...`);
@@ -112,6 +167,7 @@ export class Frontend extends EventEmitter {
                 this.emit('server_error', error);
                 return;
             }
+            // 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}`);
@@ -144,6 +200,7 @@ export class Frontend extends EventEmitter {
             });
         }
         else {
+            // SSL is enabled, load the certificate and the private key
             let cert;
             let key;
             let ca;
@@ -153,6 +210,7 @@ export class Frontend extends EventEmitter {
             let httpsServerOptions = {};
             const fs = await import('node:fs');
             if (fs.existsSync(path.join(this.matterbridge.matterbridgeDirectory, 'certs/cert.p12'))) {
+                // Load the p12 certificate and the passphrase
                 try {
                     pfx = await fs.promises.readFile(path.join(this.matterbridge.matterbridgeDirectory, 'certs/cert.p12'));
                     this.log.info(`Loaded p12 certificate file ${path.join(this.matterbridge.matterbridgeDirectory, 'certs/cert.p12')}`);
@@ -164,7 +222,7 @@ export class Frontend extends EventEmitter {
                 }
                 try {
                     passphrase = await fs.promises.readFile(path.join(this.matterbridge.matterbridgeDirectory, 'certs/cert.pass'), 'utf8');
-                    passphrase = passphrase.trim();
+                    passphrase = passphrase.trim(); // Ensure no extra characters
                     this.log.info(`Loaded p12 passphrase file ${path.join(this.matterbridge.matterbridgeDirectory, 'certs/cert.pass')}`);
                 }
                 catch (error) {
@@ -175,6 +233,7 @@ export class Frontend extends EventEmitter {
                 httpsServerOptions = { pfx, passphrase };
             }
             else {
+                // Load the SSL certificate, the private key and optionally the CA certificate. If the CA certificate is present, it will be used to create a full chain certificate.
                 try {
                     cert = await fs.promises.readFile(path.join(this.matterbridge.matterbridgeDirectory, 'certs/cert.pem'), 'utf8');
                     this.log.info(`Loaded certificate file ${path.join(this.matterbridge.matterbridgeDirectory, 'certs/cert.pem')}`);
@@ -204,9 +263,10 @@ export class Frontend extends EventEmitter {
                 httpsServerOptions = { cert: fullChain ?? cert, key, ca };
             }
             if (hasParameter('mtls')) {
-                httpsServerOptions.requestCert = true;
-                httpsServerOptions.rejectUnauthorized = true;
+                httpsServerOptions.requestCert = true; // Request client certificate
+                httpsServerOptions.rejectUnauthorized = true; // Require client certificate validation
             }
+            // Create an HTTPS server with the SSL certificate and private key (ca is optional) and attach the express app
             const https = await import('node:https');
             try {
                 this.log.debug(`Creating HTTPS server...`);
@@ -217,6 +277,7 @@ export class Frontend extends EventEmitter {
                 this.emit('server_error', error);
                 return;
             }
+            // 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}`);
@@ -248,16 +309,18 @@ export class Frontend extends EventEmitter {
                 return;
             });
         }
+        // Create a WebSocket server and attach it to the http or https server
         const ws = await import('ws');
         this.log.debug(`Creating WebSocketServer...`);
         this.webSocketServer = new ws.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.getLogLevel() === "info" || Logger.level === MatterLogLevel.INFO)
-                callbackLogLevel = "info";
-            if (this.matterbridge.getLogLevel() === "debug" || Logger.level === MatterLogLevel.DEBUG)
-                callbackLogLevel = "debug";
+            // Set the global logger callback for the WebSocketServer
+            let callbackLogLevel = "notice" /* LogLevel.NOTICE */;
+            if (this.matterbridge.getLogLevel() === "info" /* LogLevel.INFO */ || Logger.level === MatterLogLevel.INFO)
+                callbackLogLevel = "info" /* LogLevel.INFO */;
+            if (this.matterbridge.getLogLevel() === "debug" /* LogLevel.DEBUG */ || Logger.level === MatterLogLevel.DEBUG)
+                callbackLogLevel = "debug" /* LogLevel.DEBUG */;
             AnsiLogger.setGlobalCallback(this.wssSendLogMessage.bind(this), callbackLogLevel);
             this.log.debug(`WebSocketServer logger global callback set to ${callbackLogLevel}`);
             this.log.info(`WebSocketServer client "${clientIp}" connected to Matterbridge`);
@@ -279,6 +342,7 @@ export class Frontend extends EventEmitter {
                 }
             });
             ws.on('error', (error) => {
+                // istanbul ignore next
                 this.log.error(`WebSocket client error: ${error}`);
             });
         });
@@ -292,6 +356,7 @@ export class Frontend extends EventEmitter {
         this.webSocketServer.on('error', (ws, error) => {
             this.log.error(`WebSocketServer error: ${error}`);
         });
+        // Subscribe to cli events
         cliEmitter.removeAllListeners();
         cliEmitter.on('uptime', (systemUptime, processUptime) => {
             this.wssSendUptimeUpdate(systemUptime, processUptime);
@@ -302,6 +367,8 @@ export class Frontend extends EventEmitter {
         cliEmitter.on('cpu', (cpuUsage, processCpuUsage) => {
             this.wssSendCpuUpdate(cpuUsage, processCpuUsage);
         });
+        // Endpoint to validate login code
+        // curl -X POST "http://localhost:8283/api/login" -H "Content-Type: application/json" -d "{\"password\":\"Here\"}"
         this.expressApp.post('/api/login', express.json(), async (req, res) => {
             const { password } = req.body;
             this.log.debug('The frontend sent /api/login', password);
@@ -320,23 +387,27 @@ export class Frontend extends EventEmitter {
                     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: formatMemoryUsage(memoryUsageRaw.rss),
@@ -345,10 +416,13 @@ export class Frontend extends EventEmitter {
                 external: formatMemoryUsage(memoryUsageRaw.external),
                 arrayBuffers: 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, formatMemoryUsage(value)]));
+            // Format heapSpaces
             const heapSpaces = heapSpacesRaw.map((space) => ({
                 ...space,
                 space_size: formatMemoryUsage(space.space_size),
@@ -367,18 +441,22 @@ export class Frontend extends EventEmitter {
             };
             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.matterbridge.hasCleanupStarted ? [] : this.getPlugins());
         });
+        // Endpoint to provide devices
         this.expressApp.get('/api/devices', async (req, res) => {
             this.log.debug('The frontend sent /api/devices');
             res.json(this.matterbridge.hasCleanupStarted ? [] : this.getDevices());
         });
+        // 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 {
@@ -392,6 +470,7 @@ export class Frontend extends EventEmitter {
                 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 {
@@ -405,9 +484,11 @@ export class Frontend extends EventEmitter {
                 res.status(500).send('Error reading matter log file. Please enable the matter log on file in the settings.');
             }
         });
+        // Endpoint to view the diagnostic.log
         this.expressApp.get('/api/view-diagnostic', async (req, res) => {
             this.log.debug('The frontend sent /api/view-diagnostic');
             const serverNodes = [];
+            // istanbul ignore else
             if (this.matterbridge.bridgeMode === 'bridge') {
                 if (this.matterbridge.serverNode)
                     serverNodes.push(this.matterbridge.serverNode);
@@ -418,6 +499,7 @@ export class Frontend extends EventEmitter {
                         serverNodes.push(plugin.serverNode);
                 }
             }
+            // istanbul ignore next
             for (const device of this.matterbridge.devices.array()) {
                 if (device.serverNode)
                     serverNodes.push(device.serverNode);
@@ -441,7 +523,7 @@ export class Frontend extends EventEmitter {
                 values: [...serverNodes],
             })));
             delete Logger.destinations.diagnostic;
-            await wait(500);
+            await wait(500); // Wait for the log to be written
             try {
                 const fs = await import('node:fs');
                 const data = await fs.promises.readFile(path.join(this.matterbridge.matterbridgeDirectory, MATTERBRIDGE_DIAGNOSTIC_FILE), 'utf8');
@@ -449,10 +531,13 @@ export class Frontend extends EventEmitter {
                 res.send(data.slice(29));
             }
             catch (error) {
+                // istanbul ignore next
                 this.log.error(`Error reading diagnostic log file ${MATTERBRIDGE_DIAGNOSTIC_FILE}: ${error instanceof Error ? error.message : error}`);
+                // istanbul ignore next
                 res.status(500).send('Error reading diagnostic log file.');
             }
         });
+        // Endpoint to view the history.html
         this.expressApp.get('/api/viewhistory', async (req, res) => {
             this.log.debug('The frontend sent /api/viewhistory');
             try {
@@ -466,6 +551,7 @@ export class Frontend extends EventEmitter {
                 res.status(500).send('Error reading history log file. Please create the history log before loading it.');
             }
         });
+        // Endpoint to view the shelly log
         this.expressApp.get('/api/shellyviewsystemlog', async (req, res) => {
             this.log.debug('The frontend sent /api/shellyviewsystemlog');
             try {
@@ -479,6 +565,7 @@ export class Frontend extends EventEmitter {
                 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, MATTERBRIDGE_LOGGER_FILE)}`);
             const fs = await import('node:fs');
@@ -493,12 +580,14 @@ export class Frontend extends EventEmitter {
             }
             res.type('text/plain');
             res.download(path.join(os.tmpdir(), MATTERBRIDGE_LOGGER_FILE), 'matterbridge.log', (error) => {
+                /* istanbul ignore if */
                 if (error) {
                     this.log.error(`Error downloading log file ${MATTERBRIDGE_LOGGER_FILE}: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matterbridge log file');
                 }
             });
         });
+        // 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, MATTERBRIDGE_LOGGER_FILE)}`);
             const fs = await import('node:fs');
@@ -513,12 +602,14 @@ export class Frontend extends EventEmitter {
             }
             res.type('text/plain');
             res.download(path.join(os.tmpdir(), MATTER_LOGGER_FILE), 'matter.log', (error) => {
+                /* istanbul ignore if */
                 if (error) {
                     this.log.error(`Error downloading log file ${MATTER_LOGGER_FILE}: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matter log file');
                 }
             });
         });
+        // Endpoint to download the shelly log
         this.expressApp.get('/api/shellydownloadsystemlog', async (req, res) => {
             this.log.debug('The frontend sent /api/shellydownloadsystemlog');
             const fs = await import('node:fs');
@@ -533,75 +624,91 @@ export class Frontend extends EventEmitter {
             }
             res.type('text/plain');
             res.download(path.join(os.tmpdir(), 'shelly.log'), 'shelly.log', (error) => {
+                /* istanbul ignore if */
                 if (error) {
                     this.log.error(`Error downloading Shelly system log file: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading Shelly system log file');
                 }
             });
         });
+        // 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.${NODE_STORAGE_DIR}.zip`), path.join(this.matterbridge.matterbridgeDirectory, NODE_STORAGE_DIR));
             res.download(path.join(os.tmpdir(), `matterbridge.${NODE_STORAGE_DIR}.zip`), `matterbridge.${NODE_STORAGE_DIR}.zip`, (error) => {
+                /* istanbul ignore if */
                 if (error) {
                     this.log.error(`Error downloading file ${`matterbridge.${NODE_STORAGE_DIR}.zip`}: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matterbridge storage file');
                 }
             });
         });
+        // 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.${MATTER_STORAGE_NAME}.zip`), path.join(this.matterbridge.matterbridgeDirectory, MATTER_STORAGE_NAME));
             res.download(path.join(os.tmpdir(), `matterbridge.${MATTER_STORAGE_NAME}.zip`), `matterbridge.${MATTER_STORAGE_NAME}.zip`, (error) => {
+                /* istanbul ignore if */
                 if (error) {
                     this.log.error(`Error downloading the matter storage matterbridge.${MATTER_STORAGE_NAME}.zip: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matter storage zip file');
                 }
             });
         });
+        // 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);
             res.download(path.join(os.tmpdir(), `matterbridge.pluginstorage.zip`), `matterbridge.pluginstorage.zip`, (error) => {
+                /* istanbul ignore if */
                 if (error) {
                     this.log.error(`Error downloading file matterbridge.pluginstorage.zip: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matterbridge plugin storage file');
                 }
             });
         });
+        // 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')));
             res.download(path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), `matterbridge.pluginconfig.zip`, (error) => {
+                /* istanbul ignore if */
                 if (error) {
                     this.log.error(`Error downloading file matterbridge.pluginconfig.zip: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matterbridge plugin config file');
                 }
             });
         });
+        // Endpoint to download the matterbridge backup (created with the backup command)
         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) => {
+                /* istanbul ignore if */
                 if (error) {
                     this.log.error(`Error downloading file matterbridge.backup.zip: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send(`Error downloading file matterbridge.backup.zip: ${error instanceof Error ? error.message : error}`);
                 }
             });
         });
+        // Endpoint to upload a package
         this.expressApp.post('/api/uploadpackage', upload.single('file'), async (req, res) => {
             const { filename } = req.body;
             const file = req.file;
+            /* istanbul ignore if */
             if (!file || !filename) {
                 this.log.error(`uploadpackage: invalid request: file and filename are required`);
                 res.status(400).send('Invalid request: file and filename are required');
                 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
                 const fs = await import('node:fs');
                 await fs.promises.rename(file.path, filePath);
                 this.log.info(`File ${plg}${filename}${nf} uploaded successfully`);
+                // Install the plugin package
                 if (filename.endsWith('.tgz')) {
                     const { spawnCommand } = await import('./utils/spawn.js');
                     await spawnCommand(this.matterbridge, 'npm', ['install', '-g', filePath, '--omit=dev', '--verbose'], 'install', filename);
@@ -621,6 +728,7 @@ export class Frontend extends EventEmitter {
                 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} method ${req.method}: sending index.html as fallback`);
             res.sendFile(path.join(this.matterbridge.rootDirectory, 'frontend/build/index.html'));
@@ -630,13 +738,16 @@ export class Frontend extends EventEmitter {
     async stop() {
         this.log.debug('Stopping the frontend...');
         const ws = await import('ws');
+        // 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) {
             this.log.debug('Closing WebSocket server...');
+            // Close all active connections
             this.webSocketServer.clients.forEach((client) => {
                 if (client.readyState === ws.WebSocket.OPEN) {
                     client.close();
@@ -645,6 +756,7 @@ export class Frontend extends EventEmitter {
             await withTimeout(new Promise((resolve) => {
                 this.webSocketServer?.close((error) => {
                     if (error) {
+                        // istanbul ignore next
                         this.log.error(`Error closing WebSocket server: ${error}`);
                     }
                     else {
@@ -657,8 +769,27 @@ export class Frontend extends EventEmitter {
             this.webSocketServer.removeAllListeners();
             this.webSocketServer = undefined;
         }
+        // Close the http server
         if (this.httpServer) {
             this.log.debug('Closing http server...');
+            /*
+            await withTimeout(
+              new Promise<void>((resolve) => {
+                this.httpServer?.close((error) => {
+                  if (error) {
+                    // istanbul ignore next
+                    this.log.error(`Error closing http server: ${error}`);
+                  } else {
+                    this.log.debug('Http server closed successfully');
+                    this.emit('server_stopped');
+                  }
+                  resolve();
+                });
+              }),
+              5000,
+              false,
+            );
+            */
             this.httpServer.close();
             this.log.debug('Http server closed successfully');
             this.listening = false;
@@ -667,8 +798,27 @@ export class Frontend extends EventEmitter {
             this.httpServer = undefined;
             this.log.debug('Frontend http server closed successfully');
         }
+        // Close the https server
         if (this.httpsServer) {
             this.log.debug('Closing https server...');
+            /*
+            await withTimeout(
+              new Promise<void>((resolve) => {
+                this.httpsServer?.close((error) => {
+                  if (error) {
+                    // istanbul ignore next
+                    this.log.error(`Error closing https server: ${error}`);
+                  } else {
+                    this.log.debug('Https server closed successfully');
+                    this.emit('server_stopped');
+                  }
+                  resolve();
+                });
+              }),
+              5000,
+              false,
+            );
+            */
             this.httpsServer.close();
             this.log.debug('Https server closed successfully');
             this.listening = false;
@@ -679,7 +829,13 @@ export class Frontend extends EventEmitter {
         }
         this.log.debug('Frontend stopped successfully');
     }
+    /**
+     * Retrieves the api settings data.
+     *
+     * @returns {Promise<{ matterbridgeInformation: MatterbridgeInformation, systemInformation: SystemInformation }>} A promise that resolve in the api settings object.
+     */
     async getApiSettings() {
+        // Update the variable system information properties
         this.matterbridge.systemInformation.totalMemory = formatMemoryUsage(os.totalmem());
         this.matterbridge.systemInformation.freeMemory = formatMemoryUsage(os.freemem());
         this.matterbridge.systemInformation.systemUptime = formatOsUpTime(os.uptime());
@@ -689,6 +845,7 @@ export class Frontend extends EventEmitter {
         this.matterbridge.systemInformation.rss = formatMemoryUsage(process.memoryUsage().rss);
         this.matterbridge.systemInformation.heapTotal = formatMemoryUsage(process.memoryUsage().heapTotal);
         this.matterbridge.systemInformation.heapUsed = formatMemoryUsage(process.memoryUsage().heapUsed);
+        // Create the matterbridge information
         const info = {
             homeDirectory: this.matterbridge.homeDirectory,
             rootDirectory: this.matterbridge.rootDirectory,
@@ -724,9 +881,15 @@ export class Frontend extends EventEmitter {
         };
         return { systemInformation: this.matterbridge.systemInformation, matterbridgeInformation: info };
     }
+    /**
+     * Retrieves the reachable attribute.
+     *
+     * @param {MatterbridgeEndpoint} device - The MatterbridgeEndpoint object.
+     * @returns {boolean} The reachable attribute.
+     */
     getReachability(device) {
         if (this.matterbridge.hasCleanupStarted)
-            return false;
+            return false; // Skip if cleanup has started
         if (!device.lifecycle.isReady || device.construction.status !== Lifecycle.Status.Active)
             return false;
         if (device.hasClusterServer(BridgedDeviceBasicInformation.Cluster.id))
@@ -737,9 +900,15 @@ export class Frontend extends EventEmitter {
             return true;
         return false;
     }
+    /**
+     * Retrieves the power source attribute.
+     *
+     * @param {MatterbridgeEndpoint} endpoint - The MatterbridgeDevice to retrieve the power source from.
+     * @returns {'ac' | 'dc' | 'ok' | 'warning' | 'critical' | undefined} The power source attribute.
+     */
     getPowerSource(endpoint) {
         if (this.matterbridge.hasCleanupStarted)
-            return;
+            return; // Skip if cleanup has started
         if (!endpoint.lifecycle.isReady || endpoint.construction.status !== Lifecycle.Status.Active)
             return undefined;
         const powerSource = (device) => {
@@ -754,16 +923,25 @@ export class Frontend extends EventEmitter {
             }
             return;
         };
+        // Root endpoint
         if (endpoint.hasClusterServer(PowerSource.Cluster.id))
             return powerSource(endpoint);
+        // Child endpoints
         for (const child of endpoint.getChildEndpoints()) {
             if (child.hasClusterServer(PowerSource.Cluster.id))
                 return powerSource(child);
         }
     }
+    /**
+     * Retrieves the cluster text description from a given device.
+     * The output is a string with the attributes description of the cluster servers in the device to show in the frontend.
+     *
+     * @param {MatterbridgeEndpoint} device - The MatterbridgeEndpoint to retrieve the cluster text from.
+     * @returns {string} The attributes description of the cluster servers in the device.
+     */
     getClusterTextFromDevice(device) {
         if (this.matterbridge.hasCleanupStarted)
-            return '';
+            return ''; // Skip if cleanup has started
         if (!device.lifecycle.isReady || device.construction.status !== Lifecycle.Status.Active)
             return '';
         const getUserLabel = (device) => {
@@ -773,6 +951,7 @@ export class Frontend extends EventEmitter {
                 if (composed)
                     return 'Composed: ' + composed.value;
             }
+            // istanbul ignore next cause is not reachable
             return '';
         };
         const getFixedLabel = (device) => {
@@ -782,11 +961,13 @@ export class Frontend extends EventEmitter {
                 if (composed)
                     return 'Composed: ' + composed.value;
             }
+            // istanbul ignore next cause is not reacheable
             return '';
         };
         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' || attributeValue === undefined)
                 return;
             if (clusterName === 'onOff' && attributeName === 'onOff')
@@ -876,11 +1057,17 @@ export class Frontend extends EventEmitter {
             if (clusterName === 'userLabel' && attributeName === 'labelList')
                 attributes += `${getUserLabel(device)} `;
         });
+        // console.log(`${device.deviceName}.forEachAttribute: ${attributes}`);
         return attributes.trimStart().trimEnd();
     }
+    /**
+     * Retrieves the registered plugins sanitized for res.json().
+     *
+     * @returns {ApiPlugin[]} An array of BaseRegisteredPlugin.
+     */
     getPlugins() {
         if (this.matterbridge.hasCleanupStarted)
-            return [];
+            return []; // Skip if cleanup has started
         const plugins = [];
         for (const plugin of this.matterbridge.plugins.array()) {
             plugins.push({
@@ -908,18 +1095,27 @@ export class Frontend extends EventEmitter {
                 schemaJson: plugin.schemaJson,
                 hasWhiteList: plugin.configJson?.whiteList !== undefined,
                 hasBlackList: plugin.configJson?.blackList !== undefined,
+                // Childbridge mode specific data
                 matter: plugin.serverNode ? this.matterbridge.getServerNodeData(plugin.serverNode) : undefined,
             });
         }
         return plugins;
     }
+    /**
+     * Retrieves the devices from Matterbridge.
+     *
+     * @param {string} [pluginName] - The name of the plugin to filter devices by.
+     * @returns {ApiDevice[]} An array of ApiDevices for the frontend.
+     */
     getDevices(pluginName) {
         if (this.matterbridge.hasCleanupStarted)
-            return [];
+            return []; // Skip if cleanup has started
         const devices = [];
         for (const device of this.matterbridge.devices.array()) {
+            // Filter by pluginName if provided
             if (pluginName && pluginName !== device.plugin)
                 continue;
+            // Check if the device has the required properties
             if (!device.plugin || !device.deviceType || !device.name || !device.deviceName || !device.serialNumber || !device.uniqueId || !device.lifecycle.isReady)
                 continue;
             devices.push({
@@ -939,24 +1135,39 @@ export class Frontend extends EventEmitter {
         }
         return devices;
     }
+    /**
+     * Retrieves the clusters from a given plugin and endpoint number.
+     *
+     * Response for /api/clusters
+     *
+     * @param {string} pluginName - The name of the plugin.
+     * @param {number} endpointNumber - The endpoint number.
+     * @returns {ApiClusters | undefined} A promise that resolves to the clusters or undefined if not found.
+     */
     getClusters(pluginName, endpointNumber) {
         if (this.matterbridge.hasCleanupStarted)
-            return;
+            return; // Skip if cleanup has started
         const endpoint = this.matterbridge.devices.array().find((d) => d.plugin === pluginName && d.maybeNumber === endpointNumber);
         if (!endpoint || !endpoint.plugin || !endpoint.maybeNumber || !endpoint.maybeId || !endpoint.deviceName || !endpoint.serialNumber) {
             this.log.error(`getClusters: no device found for plugin ${pluginName} and endpoint number ${endpointNumber}`);
             return;
         }
+        // this.log.debug(`***getClusters: getting clusters for device ${endpoint.deviceName} plugin ${pluginName} endpoint number ${endpointNumber}`);
+        // Get the device types from the main endpoint
         const deviceTypes = [];
         const clusters = [];
         endpoint.state.descriptor.deviceTypeList.forEach((d) => {
             deviceTypes.push(d.deviceType);
         });
+        // Get the clusters from the main endpoint
         endpoint.forEachAttribute((clusterName, clusterId, attributeName, attributeId, attributeValue) => {
             if (typeof attributeValue === 'undefined' || attributeValue === undefined)
                 return;
             if (clusterName === 'EveHistory' && ['configDataGet', 'configDataSet', 'historyStatus', 'historyEntries', 'historyRequest', 'historySetTime', 'rLoc'].includes(attributeName))
                 return;
+            // console.log(
+            //   `${idn}${endpoint.deviceName}${rs}${nf} => Cluster: ${CYAN}${clusterName} (0x${clusterId.toString(16).padStart(2, '0')})${nf} Attribute: ${CYAN}${attributeName} (0x${attributeId.toString(16).padStart(2, '0')})${nf} Value: ${YELLOW}${typeof attributeValue === 'object' ? stringify(attributeValue as object) : attributeValue}${nf}`,
+            // );
             clusters.push({
                 endpoint: endpoint.number.toString(),
                 number: endpoint.number,
@@ -970,12 +1181,19 @@ export class Frontend extends EventEmitter {
                 attributeLocalValue: attributeValue,
             });
         });
+        // Get the child endpoints
         const childEndpoints = endpoint.getChildEndpoints();
+        // if (childEndpoints.length === 0) {
+        // this.log.debug(`***getClusters: found ${childEndpoints.length} child endpoints for device ${endpoint.deviceName} plugin ${pluginName} and endpoint number ${endpointNumber}`);
+        // }
         childEndpoints.forEach((childEndpoint) => {
+            // istanbul ignore if cause is not reachable: should never happen but ...
             if (!childEndpoint.maybeId || !childEndpoint.maybeNumber) {
                 this.log.error(`getClusters: no child endpoint found for plugin ${pluginName} and endpoint number ${endpointNumber}`);
                 return;
             }
+            // this.log.debug(`***getClusters: getting clusters for child endpoint ${childEndpoint.id} of device ${endpoint.deviceName} plugin ${pluginName} endpoint number ${childEndpoint.number}`);
+            // Get the device types of the child endpoint
             const deviceTypes = [];
             childEndpoint.state.descriptor.deviceTypeList.forEach((d) => {
                 deviceTypes.push(d.deviceType);
@@ -985,6 +1203,9 @@ export class Frontend extends EventEmitter {
                     return;
                 if (clusterName === 'EveHistory' && ['configDataGet', 'configDataSet', 'historyStatus', 'historyEntries', 'historyRequest', 'historySetTime', 'rLoc'].includes(attributeName))
                     return;
+                // console.log(
+                //   `${idn}${childEndpoint.deviceName}${rs}${nf} => Cluster: ${CYAN}${clusterName} (0x${clusterId.toString(16).padStart(2, '0')})${nf} Attribute: ${CYAN}${attributeName} (0x${attributeId.toString(16).padStart(2, '0')})${nf} Value: ${YELLOW}${typeof attributeValue === 'object' ? stringify(attributeValue as object) : attributeValue}${nf}`,
+                // );
                 clusters.push({
                     endpoint: childEndpoint.number.toString(),
                     number: childEndpoint.number,
@@ -1001,6 +1222,13 @@ export class Frontend extends EventEmitter {
         });
         return { plugin: endpoint.plugin, deviceName: endpoint.deviceName, serialNumber: endpoint.serialNumber, number: endpoint.number, id: endpoint.id, deviceTypes, clusters };
     }
+    /**
+     * Handles incoming websocket api request messages from 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;
         const sendResponse = (data) => {
@@ -1020,7 +1248,7 @@ export class Frontend extends EventEmitter {
         };
         try {
             data = JSON.parse(message.toString());
-            if (!isValidNumber(data.id) || !isValidString(data.dst) || !isValidString(data.src) || !isValidString(data.method) || data.dst !== 'Matterbridge') {
+            if (!isValidNumber(data.id) || !isValidString(data.dst) || !isValidString(data.src) || !isValidString(data.method) /* || !isValidObject(data.params)*/ || data.dst !== 'Matterbridge') {
                 this.log.error(`Invalid message from websocket client: ${debugStringify(data)}`);
                 sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: 'Invalid message' });
                 return;
@@ -1094,6 +1322,7 @@ export class Frontend extends EventEmitter {
                         return;
                     })
                         .catch((_error) => {
+                        //
                     });
                 }
                 else {
@@ -1141,6 +1370,7 @@ export class Frontend extends EventEmitter {
                         return;
                     })
                         .catch((_error) => {
+                        //
                     });
                 }
                 sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
@@ -1166,6 +1396,7 @@ export class Frontend extends EventEmitter {
                 const plugin = this.matterbridge.plugins.get(data.params.pluginName);
                 await this.matterbridge.plugins.shutdown(plugin, 'The plugin is restarting.', false, true);
                 if (plugin.serverNode) {
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                     await this.matterbridge.stopServerNode(plugin.serverNode);
                     plugin.serverNode = undefined;
                 }
@@ -1175,18 +1406,20 @@ export class Frontend extends EventEmitter {
                         this.matterbridge.devices.remove(device);
                     }
                 }
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 if (plugin.type === 'DynamicPlatform' && !plugin.locked)
                     await this.matterbridge.createDynamicPlugin(plugin);
                 await this.matterbridge.plugins.load(plugin, true, 'The plugin has been restarted', true);
-                plugin.restartRequired = false;
+                plugin.restartRequired = false; // Reset plugin restartRequired
                 let needRestart = 0;
                 for (const plugin of this.matterbridge.plugins) {
                     if (plugin.restartRequired)
                         needRestart++;
                 }
                 if (needRestart === 0) {
-                    this.wssSendRestartNotRequired(true);
+                    this.wssSendRestartNotRequired(true); // Reset global restart required message
                 }
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 if (plugin.serverNode)
                     await this.matterbridge.startServerNode(plugin.serverNode);
                 this.wssSendSnackbarMessage(`Restarted plugin ${data.params.pluginName}`, 5, 'success');
@@ -1447,22 +1680,22 @@ export class Frontend extends EventEmitter {
                         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);
                             sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
@@ -1473,6 +1706,7 @@ export class Frontend extends EventEmitter {
                             this.log.debug('Matterbridge file log:', data.params.value);
                             this.matterbridge.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, MATTERBRIDGE_LOGGER_FILE), await this.matterbridge.getLogLevel(), true);
                             else
@@ -1550,6 +1784,7 @@ export class Frontend extends EventEmitter {
                         }
                         break;
                     case 'setmatterport':
+                        // eslint-disable-next-line no-case-declarations
                         const port = isValidString(data.params.value) ? parseInt(data.params.value) : 0;
                         if (isValidNumber(port, 5540, 5600)) {
                             this.log.debug(`Set matter commissioning port to ${CYAN}${port}${db}`);
@@ -1569,6 +1804,7 @@ export class Frontend extends EventEmitter {
                         }
                         break;
                     case 'setmatterdiscriminator':
+                        // eslint-disable-next-line no-case-declarations
                         const discriminator = isValidString(data.params.value) ? parseInt(data.params.value) : 0;
                         if (isValidNumber(discriminator, 0, 4095)) {
                             this.log.debug(`Set matter commissioning discriminator to ${CYAN}${discriminator}${db}`);
@@ -1588,6 +1824,7 @@ export class Frontend extends EventEmitter {
                         }
                         break;
                     case 'setmatterpasscode':
+                        // eslint-disable-next-line no-case-declarations
                         const passcode = isValidString(data.params.value) ? parseInt(data.params.value) : 0;
                         if (isValidNumber(passcode, 1, 99999998) && CommissioningOptions.FORBIDDEN_PASSCODES.includes(passcode) === false) {
                             this.matterbridge.passcode = passcode;
@@ -1633,15 +1870,19 @@ export class Frontend extends EventEmitter {
                         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);
@@ -1650,6 +1891,7 @@ export class Frontend extends EventEmitter {
                                 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((item) => item !== localData.params.serial);
@@ -1677,7 +1919,9 @@ export class Frontend extends EventEmitter {
                         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')
@@ -1686,6 +1930,7 @@ export class Frontend extends EventEmitter {
                         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((item) => item !== localData.params.serial);
@@ -1694,6 +1939,7 @@ export class Frontend extends EventEmitter {
                                 config.whiteList = config.whiteList.filter((item) => item !== localData.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);
@@ -1716,6 +1962,7 @@ export class Frontend extends EventEmitter {
                 }
             }
             else {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 const localData = data;
                 this.log.error(`Invalid method from websocket client: ${debugStringify(localData)}`);
                 sendResponse({ id: localData.id, method: localData.method, src: 'Matterbridge', dst: localData.src, error: 'Invalid method' });
@@ -1725,23 +1972,46 @@ export class Frontend extends EventEmitter {
             inspectError(this.log, `Error processing message "${message}" from websocket client`, error);
         }
     }
+    /**
+     * Sends a WebSocket log 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.
+     *
+     * @remarks
+     * The function removes ANSI escape codes, leading asterisks, non-printable characters, and replaces all occurrences of \t and \n.
+     * It also replaces all occurrences of \" with " and angle-brackets with &lt; and &gt;.
+     * The function sends the message to all connected clients.
+     */
     wssSendLogMessage(level, time, name, message) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
         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, '"');
+        // 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
         if (level !== 'spawn') {
             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);
                 }
@@ -1749,14 +2019,34 @@ export class Frontend extends EventEmitter {
             })
                 .join(' ');
         }
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'log', success: true, response: { level, time, name, message } });
     }
+    /**
+     * Sends a need to refresh WebSocket message to all connected clients.
+     *
+     * @param {string} changed - The changed value.
+     * @param {Record<string, unknown>} params - Additional parameters to send with the message.
+     * possible values for changed:
+     * - 'settings' (when the bridge has started in bridge mode or childbridge mode and when update finds a new version)
+     * - 'plugins'
+     * - 'devices'
+     * - 'matter' with param 'matter' (QRDiv component)
+     * @param {ApiMatter} params.matter - The matter device that has changed. Required if changed is 'matter'.
+     */
     wssSendRefreshRequired(changed, params) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
         this.log.debug('Sending a refresh required message to all connected clients');
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'refresh_required', success: true, response: { changed, ...params } });
     }
+    /**
+     * Sends a need to restart WebSocket message to all connected clients.
+     *
+     * @param {boolean} snackbar - If true, a snackbar message will be sent to all connected clients. Default is true.
+     * @param {boolean} fixed - If true, the restart is fixed and will not be reset by plugin restarts. Default is false.
+     */
     wssSendRestartRequired(snackbar = true, fixed = false) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
@@ -1765,8 +2055,14 @@ export class Frontend extends EventEmitter {
         this.matterbridge.fixedRestartRequired = fixed;
         if (snackbar === true)
             this.wssSendSnackbarMessage(`Restart required`, 0);
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'restart_required', success: true, response: { fixed } });
     }
+    /**
+     * Sends a no need to restart WebSocket message to all connected clients.
+     *
+     * @param {boolean} snackbar - If true, the snackbar message will be cleared from all connected clients. Default is true.
+     */
     wssSendRestartNotRequired(snackbar = true) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
@@ -1774,57 +2070,133 @@ export class Frontend extends EventEmitter {
         this.matterbridge.restartRequired = false;
         if (snackbar === true)
             this.wssSendCloseSnackbarMessage(`Restart required`);
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'restart_not_required', success: true });
     }
+    /**
+     * Sends a need to update WebSocket message to all connected clients.
+     *
+     * @param {boolean} devVersion - If true, the update is for a development version. Default is false.
+     */
     wssSendUpdateRequired(devVersion = false) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
         this.log.debug('Sending an update required message to all connected clients');
         this.matterbridge.updateRequired = true;
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'update_required', success: true, response: { devVersion } });
     }
+    /**
+     * Sends a cpu update message to all connected clients.
+     *
+     * @param {number} cpuUsage - The CPU usage percentage to send.
+     * @param {number} processCpuUsage - The CPU usage percentage of the process to send.
+     */
     wssSendCpuUpdate(cpuUsage, processCpuUsage) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
         if (hasParameter('debug'))
             this.log.debug('Sending a cpu update message to all connected clients');
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'cpu_update', success: true, response: { cpuUsage: Math.round(cpuUsage * 100) / 100, processCpuUsage: Math.round(processCpuUsage * 100) / 100 } });
     }
+    /**
+     * Sends a memory update message to all connected clients.
+     *
+     * @param {string} totalMemory - The total memory in bytes.
+     * @param {string} freeMemory - The free memory in bytes.
+     * @param {string} rss - The resident set size in bytes.
+     * @param {string} heapTotal - The total heap memory in bytes.
+     * @param {string} heapUsed - The used heap memory in bytes.
+     * @param {string} external - The external memory in bytes.
+     * @param {string} arrayBuffers - The array buffers memory in bytes.
+     */
     wssSendMemoryUpdate(totalMemory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
         if (hasParameter('debug'))
             this.log.debug('Sending a memory update message to all connected clients');
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'memory_update', success: true, response: { totalMemory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers } });
     }
+    /**
+     * Sends an uptime update message to all connected clients.
+     *
+     * @param {string} systemUptime - The system uptime in a human-readable format.
+     * @param {string} processUptime - The process uptime in a human-readable format.
+     */
     wssSendUptimeUpdate(systemUptime, processUptime) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
         if (hasParameter('debug'))
             this.log.debug('Sending a uptime update message to all connected clients');
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'uptime_update', success: true, response: { 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. Default is 5 seconds.
+     * @param {'info' | 'warning' | 'error' | 'success'} severity - The severity of the message.
+     * possible values are: 'info', 'warning', 'error', 'success'. Default is 'info'.
+     *
+     * @remarks
+     * If timeout is 0, the snackbar message will be displayed until closed by the user.
+     */
     wssSendSnackbarMessage(message, timeout = 5, severity = 'info') {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
         this.log.debug('Sending a snackbar message to all connected clients');
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'snackbar', success: true, response: { message, timeout, severity } });
     }
+    /**
+     * Sends a close snackbar message to all connected clients.
+     * It will close the snackbar message with the same message and timeout = 0.
+     *
+     * @param {string} message - The message to send.
+     */
     wssSendCloseSnackbarMessage(message) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
         this.log.debug('Sending a close snackbar message to all connected clients');
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'close_snackbar', success: true, response: { 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 {EndpointNumber} number - The endpoint number where the attribute belongs.
+     * @param {string} id - The endpoint id where the attribute belongs.
+     * @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, number, id, cluster, attribute, value) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
         this.log.debug('Sending an attribute update message to all connected clients');
+        // Send the message to all connected clients
         this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'state_update', success: true, response: { plugin, serialNumber, uniqueId, number, id, cluster, attribute, value } });
     }
+    /**
+     * Sends a message to all connected clients.
+     * This is an helper function to send a broadcast message to all connected clients.
+     *
+     * @param {WsMessageBroadcast} msg - The message to send.
+     */
     wssBroadcastMessage(msg) {
         if (!this.listening || this.webSocketServer?.clients.size === 0)
             return;
+        // Send the message to all connected clients
         const stringifiedMsg = JSON.stringify(msg);
         if (msg.method !== 'log')
             this.log.debug(`Sending a broadcast message: ${debugStringify(msg)}`);
@@ -1835,3 +2207,4 @@ export class Frontend extends EventEmitter {
         });
     }
 }
+//# sourceMappingURL=frontend.js.map