matterbridge 3.4.7 → 3.5.0-dev-20260113-96c82db

package/dist/dgram/multicast.d.ts

@@ -1,25 +1,3 @@
-/**
- * @description This file contains the class Multicast.
- * @file multicast.ts
- * @author Luca Liguori
- * @created 2025-03-22
- * @version 1.0.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.
- */
 import { AddressInfo } from 'node:net';
 import { Dgram } from './dgram.js';
 export declare const MDNS_MULTICAST_IPV4_ADDRESS = "224.0.0.251";
@@ -28,40 +6,13 @@ export declare const MDNS_MULTICAST_PORT = 5353;
 export declare const COAP_MULTICAST_IPV4_ADDRESS = "224.0.1.187";
 export declare const COAP_MULTICAST_IPV6_ADDRESS = "ff02::fd";
 export declare const COAP_MULTICAST_PORT = 5683;
-/**
- * This class implements a multicast dgram socket.
- */
 export declare class Multicast extends Dgram {
     multicastAddress: string;
     multicastPort: number;
     outgoingInterfaceAddress: string | undefined;
     joinedInterfaces: string[];
-    /**
-     * Creates an instance of Multicast.
-     *
-     * @param {string} name - The name of the socket.
-     * @param {string} multicastAddress - The multicast address to join.
-     * @param {number} multicastPort - The port number to bind to.
-     * @param {'udp4' | 'udp6'} socketType - The type of the socket (IPv4 or IPv6).
-     * @param {boolean | undefined} reuseAddr - Whether to allow address reuse. Defaults to true.
-     * @param {string} [interfaceName] - The name of the network interface to bind to. If provided, the interfaceAddress will be determined based on this name if not explicitly provided.
-     * @param {string} [interfaceAddress] - The address of the network interface to bind to. If not provided, it will be determined based on the interfaceName.
-     * @param {string} [outgoingInterfaceAddress] - The address of the outgoing network interface. If not provided, it will use the interfaceAddress.
-     */
     constructor(name: string, multicastAddress: string, multicastPort: number, socketType: 'udp4' | 'udp6', reuseAddr?: boolean | undefined, interfaceName?: string, interfaceAddress?: string, outgoingInterfaceAddress?: string);
-    /**
-     * Starts the dgram multicast socket.
-     */
     start(): void;
-    /**
-     * Event handler for the 'listening' event. This event is emitted when the socket starts listening for datagram messages.
-     *
-     * @param {AddressInfo} [address] - The address info.
-     */
     onListening(address: AddressInfo): void;
-    /**
-     * Stops the dgram multicast socket.
-     */
     stop(): void;
 }
-//# sourceMappingURL=multicast.d.ts.map

package/dist/dgram/multicast.js

@@ -1,29 +1,5 @@
-/**
- * @description This file contains the class Multicast.
- * @file multicast.ts
- * @author Luca Liguori
- * @created 2025-03-22
- * @version 1.0.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.
- */
 import os from 'node:os';
-// AnsiLogger imports
 import { BLUE, CYAN, db, RED, YELLOW } from 'node-ansi-logger';
-// Dgram imports
 import { Dgram } from './dgram.js';
 export const MDNS_MULTICAST_IPV4_ADDRESS = '224.0.0.251';
 export const MDNS_MULTICAST_IPV6_ADDRESS = 'ff02::fb';
@@ -31,37 +7,18 @@ export const MDNS_MULTICAST_PORT = 5353;
 export const COAP_MULTICAST_IPV4_ADDRESS = '224.0.1.187';
 export const COAP_MULTICAST_IPV6_ADDRESS = 'ff02::fd';
 export const COAP_MULTICAST_PORT = 5683;
-/**
- * This class implements a multicast dgram socket.
- */
 export class Multicast extends Dgram {
     multicastAddress;
     multicastPort;
     outgoingInterfaceAddress;
     joinedInterfaces = [];
-    /**
-     * Creates an instance of Multicast.
-     *
-     * @param {string} name - The name of the socket.
-     * @param {string} multicastAddress - The multicast address to join.
-     * @param {number} multicastPort - The port number to bind to.
-     * @param {'udp4' | 'udp6'} socketType - The type of the socket (IPv4 or IPv6).
-     * @param {boolean | undefined} reuseAddr - Whether to allow address reuse. Defaults to true.
-     * @param {string} [interfaceName] - The name of the network interface to bind to. If provided, the interfaceAddress will be determined based on this name if not explicitly provided.
-     * @param {string} [interfaceAddress] - The address of the network interface to bind to. If not provided, it will be determined based on the interfaceName.
-     * @param {string} [outgoingInterfaceAddress] - The address of the outgoing network interface. If not provided, it will use the interfaceAddress.
-     */
     constructor(name, multicastAddress, multicastPort, socketType, reuseAddr = true, interfaceName, interfaceAddress, outgoingInterfaceAddress) {
         super(name, socketType, reuseAddr, interfaceName, interfaceAddress);
         this.multicastAddress = multicastAddress;
         this.multicastPort = multicastPort;
         this.outgoingInterfaceAddress = outgoingInterfaceAddress;
     }
-    /**
-     * Starts the dgram multicast socket.
-     */
     start() {
-        // Get the local ipv4 or ipv6 address to bind to.
         if (this.socketType === 'udp4') {
             this.log.debug(`Starting ipv4 dgram multicast socket...`);
             this.interfaceAddress = this.interfaceAddress ?? this.getIpv4InterfaceAddress(this.interfaceName);
@@ -77,11 +34,6 @@ export class Multicast extends Dgram {
             this.emit('bound', address);
         });
     }
-    /**
-     * Event handler for the 'listening' event. This event is emitted when the socket starts listening for datagram messages.
-     *
-     * @param {AddressInfo} [address] - The address info.
-     */
     onListening(address) {
         this.log.debug(`Dgram multicast socket listening on ${BLUE}${address.family}${db} ${BLUE}${address.address}${db}:${BLUE}${address.port}${db}`);
         this.socket.setBroadcast(true);
@@ -92,46 +44,39 @@ export class Multicast extends Dgram {
         this.log.debug(`Dgram multicast socket multicast TTL set to 255`);
         this.socket.setMulticastLoopback(true);
         this.log.debug(`Dgram multicast socket multicast loopback enabled`);
-        // Find the correct network interfaces and join the multicast group on each interface. For IPv6, we will use the scope ID if available. If not available, we will use the Unique Local Address.
         Object.entries(os.networkInterfaces()).forEach(([name, interfaces]) => {
             this.log.debug(`Dgram multicast socket processing interface ${CYAN}${name}${db}`);
             if (!interfaces)
                 return;
             if (this.interfaceName && name !== this.interfaceName)
-                return; // Only process the specified interface
+                return;
             let iface;
             let membershipInterface;
-            // Find the first ipv4 interface
             const ifaceIpv4 = interfaces.find((iface) => iface.family === 'IPv4' && this.socketType === 'udp4');
             if (ifaceIpv4) {
                 iface = ifaceIpv4;
                 membershipInterface = ifaceIpv4.address;
             }
-            // Find the first IPv6 Address
             const ifaceIpv6 = interfaces.find((iface) => iface.family === 'IPv6' && this.socketType === 'udp6');
             if (ifaceIpv6) {
                 iface = ifaceIpv6;
                 membershipInterface = ifaceIpv6.address + (ifaceIpv6.scopeid !== undefined ? (process.platform === 'win32' ? '%' + String(ifaceIpv6.scopeid) : '%' + name) : '');
             }
-            // Find the first Unique Local Address (ULA) IPv6
             const ifaceUla = interfaces.find((iface) => iface.family === 'IPv6' && this.socketType === 'udp6' && iface.address.startsWith('fd'));
             if (ifaceUla) {
                 iface = ifaceUla;
                 membershipInterface = ifaceUla.address + (ifaceUla.scopeid !== undefined ? (process.platform === 'win32' ? '%' + String(ifaceUla.scopeid) : '%' + name) : '');
             }
-            // Find the first Unique Local Address (ULA) IPv6 with prefix length /64 (netmask ffff:ffff:ffff:ffff::)
             const ifaceUla64 = interfaces.find((iface) => iface.family === 'IPv6' && this.socketType === 'udp6' && iface.address.startsWith('fd') && iface.netmask === 'ffff:ffff:ffff:ffff::');
             if (ifaceUla64) {
                 iface = ifaceUla64;
                 membershipInterface = ifaceUla64.address + (ifaceUla64.scopeid !== undefined ? (process.platform === 'win32' ? '%' + String(ifaceUla64.scopeid) : '%' + name) : '');
             }
-            // Find the first Link-local IPv6 Address
             const ifaceLinkLocal = interfaces.find((iface) => iface.family === 'IPv6' && this.socketType === 'udp6' && iface.address.startsWith('fe80'));
             if (ifaceLinkLocal) {
                 iface = ifaceLinkLocal;
                 membershipInterface = ifaceLinkLocal.address + (ifaceLinkLocal.scopeid !== undefined ? (process.platform === 'win32' ? '%' + String(ifaceLinkLocal.scopeid) : '%' + name) : '');
             }
-            // Add the interface address to the multicast group
             if (iface && membershipInterface) {
                 try {
                     this.socket.addMembership(this.multicastAddress, membershipInterface);
@@ -144,11 +89,9 @@ export class Multicast extends Dgram {
             }
         });
         let interfaceAddress = this.outgoingInterfaceAddress || this.interfaceAddress;
-        // If the interfaceAddress is 0.0.0.0, we need to set the default outgoing multicast interface to the first found IPv4 address.
         if (!this.outgoingInterfaceAddress && this.socketType === 'udp4' && this.interfaceAddress === '0.0.0.0') {
             interfaceAddress = this.getIpv4InterfaceAddress(this.interfaceName);
         }
-        // If the interfaceAddress is '::', we need to set the default outgoing multicast interface to '::' + the scope ID.
         if (!this.outgoingInterfaceAddress && this.socketType === 'udp6' && this.interfaceAddress === '::') {
             interfaceAddress = '::' + this.getIpv6ScopeId(this.interfaceName);
         }
@@ -157,9 +100,6 @@ export class Multicast extends Dgram {
         this.log.debug(`Dgram multicast socket multicastInterface set to ${BLUE}${interfaceAddress}${db}`);
         this.emit('ready', address);
     }
-    /**
-     * Stops the dgram multicast socket.
-     */
     stop() {
         this.log.debug('Stopping dgram multicast socket...');
         this.joinedInterfaces.forEach((membershipInterface) => {
@@ -176,4 +116,3 @@ export class Multicast extends Dgram {
         this.log.debug('Stopped dgram multicast socket.');
     }
 }
-//# sourceMappingURL=multicast.js.map

package/dist/dgram/unicast.d.ts

@@ -1,64 +1,11 @@
-/**
- * @description This file contains the class Unicast.
- * @file unicast.ts
- * @author Luca Liguori
- * @created 2025-03-22
- * @version 1.0.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.
- */
 import { AddressInfo } from 'node:net';
 import { RemoteInfo } from 'node:dgram';
 import { Dgram } from './dgram.js';
-/**
- * This class implements a unicast dgram socket.
- */
 export declare class Unicast extends Dgram {
     port: number | undefined;
-    /**
-     * Creates an instance of Unicast.
-     *
-     * @param {string} name - The name of the socket.
-     * @param {'udp4' | 'udp6'} socketType - The type of the socket (IPv4 or IPv6).
-     * @param {boolean | undefined} reuseAddr - Whether to allow address reuse. Defaults to true.
-     * @param {string} [interfaceName] - The name of the network interface to bind to. If provided, the interfaceAddress will be determined based on this name if not explicitly provided.
-     * @param {string} [interfaceAddress] - The address of the network interface to bind to. If not provided, it will be determined based on the interfaceName.
-     * @param {number} [port] - The port number to bind to. If not provided, it will bind to any available port.
-     */
     constructor(name: string, socketType: 'udp4' | 'udp6', reuseAddr?: boolean | undefined, interfaceName?: string, interfaceAddress?: string, port?: number);
-    /**
-     * Starts the dgram unicast socket.
-     */
     start(): void;
-    /**
-     * Event handler for the 'listening' event. This event is emitted when the socket starts listening for datagram messages.
-     *
-     * @param {AddressInfo} [address] - The address info.
-     */
     onListening(address: AddressInfo): void;
-    /**
-     * Event handler for the 'message' event. This event is emitted when a datagram message is received.
-     *
-     * @param {Buffer} msg - The message buffer.
-     * @param {RemoteInfo} rinfo - The remote info.
-     */
     onMessage(msg: Buffer, rinfo: RemoteInfo): void;
-    /**
-     * Stops the dgram unicast socket.
-     */
     stop(): void;
 }
-//# sourceMappingURL=unicast.d.ts.map

package/dist/dgram/unicast.js

@@ -1,54 +1,12 @@
-/**
- * @description This file contains the class Unicast.
- * @file unicast.ts
- * @author Luca Liguori
- * @created 2025-03-22
- * @version 1.0.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.
- */
-// AnsiLogger imports
 import { BLUE, db } from 'node-ansi-logger';
-// Net imports
 import { Dgram } from './dgram.js';
-/**
- * This class implements a unicast dgram socket.
- */
 export class Unicast extends Dgram {
     port;
-    /**
-     * Creates an instance of Unicast.
-     *
-     * @param {string} name - The name of the socket.
-     * @param {'udp4' | 'udp6'} socketType - The type of the socket (IPv4 or IPv6).
-     * @param {boolean | undefined} reuseAddr - Whether to allow address reuse. Defaults to true.
-     * @param {string} [interfaceName] - The name of the network interface to bind to. If provided, the interfaceAddress will be determined based on this name if not explicitly provided.
-     * @param {string} [interfaceAddress] - The address of the network interface to bind to. If not provided, it will be determined based on the interfaceName.
-     * @param {number} [port] - The port number to bind to. If not provided, it will bind to any available port.
-     */
     constructor(name, socketType, reuseAddr = true, interfaceName, interfaceAddress, port) {
         super(name, socketType, reuseAddr, interfaceName, interfaceAddress);
         this.port = port;
     }
-    /**
-     * Starts the dgram unicast socket.
-     */
     start() {
-        // Get the local ipv4 or ipv6 interfaceAddress to bind to. If not provided and interfaceName has been provided, use the first one found.
-        // If neither interfaceAddress nor interfaceName is provided, use undefined to bind to any available address. In this case broadcast will not work.
         if (this.socketType === 'udp4') {
             this.log.debug(`Starting ipv4 dgram unicast socket...`);
             this.interfaceAddress = this.interfaceAddress ?? (this.interfaceName ? this.getIpv4InterfaceAddress(this.interfaceName) : undefined);
@@ -58,9 +16,6 @@ export class Unicast extends Dgram {
             this.interfaceAddress = this.interfaceAddress ?? (this.interfaceName ? this.getIpv6InterfaceAddress(this.interfaceName) : undefined);
         }
         this.interfaceNetmask = this.interfaceAddress ? this.getNetmask(this.interfaceAddress) : undefined;
-        // Bind to the local address and port:
-        // port 0 or undefined means "assign any available port"
-        // address 0.0.0.0 or :: means "bind to all available addresses"
         this.log.debug(`Binding dgram unicast socket to ${BLUE}${this.interfaceAddress || 'all available addresses'}${db} on port ${BLUE}${this.port || 'any available port'}${db}...`);
         this.socket.bind(this.port, this.interfaceAddress, () => {
             const address = this.socket.address();
@@ -68,33 +23,18 @@ export class Unicast extends Dgram {
             this.emit('bound', address);
         });
     }
-    /**
-     * Event handler for the 'listening' event. This event is emitted when the socket starts listening for datagram messages.
-     *
-     * @param {AddressInfo} [address] - The address info.
-     */
     onListening(address) {
         this.log.debug(`Dgram unicast socket listening on ${BLUE}${address.family}${db} ${BLUE}${address.address}${db}:${BLUE}${address.port}${db}`);
         this.socket.setBroadcast(true);
         this.log.debug(`Dgram unicast socket broadcast enabled`);
         this.emit('ready', address);
     }
-    /**
-     * Event handler for the 'message' event. This event is emitted when a datagram message is received.
-     *
-     * @param {Buffer} msg - The message buffer.
-     * @param {RemoteInfo} rinfo - The remote info.
-     */
     onMessage(msg, rinfo) {
         this.log.debug(`Socket received a message from ${BLUE}${rinfo.family}${db} ${BLUE}${rinfo.address}${db}:${BLUE}${rinfo.port}${db}`);
     }
-    /**
-     * Stops the dgram unicast socket.
-     */
     stop() {
         this.log.debug('Stopping dgram unicast socket...');
         this.socket.close();
         this.log.debug('Stopped dgram unicast socket.');
     }
 }
-//# sourceMappingURL=unicast.js.map

package/dist/frontend.d.ts

@@ -1,35 +1,9 @@
-/**
- * This file contains the class Frontend.
- *
- * @file frontend.ts
- * @author Luca Liguori
- * @created 2025-01-13
- * @version 1.3.3
- * @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.
- */
 import EventEmitter from 'node:events';
 import { LogLevel } from 'node-ansi-logger';
 import { EndpointNumber } from '@matter/types/datatype';
 import type { ApiMatter } from './matterbridgeTypes.js';
 import type { Matterbridge } from './matterbridge.js';
 import type { RefreshRequiredChanged, WsMessageBroadcast } from './frontendTypes.js';
-/**
- * Represents the Frontend events.
- */
 interface FrontendEvents {
     server_listening: [protocol: string, port: number, address?: string];
     server_error: [error: Error];
@@ -56,190 +30,29 @@ export declare class Frontend extends EventEmitter<FrontendEvents> {
     set logLevel(logLevel: LogLevel);
     start(port?: number): Promise<void>;
     stop(): Promise<void>;
-    /**
-     * Retrieves the api settings data.
-     *
-     * @returns {Promise<{ matterbridgeInformation: MatterbridgeInformation, systemInformation: SystemInformation }>} A promise that resolve in the api settings object.
-     */
     private getApiSettings;
-    /**
-     * Retrieves the reachable attribute.
-     *
-     * @param {MatterbridgeEndpoint} device - The MatterbridgeEndpoint object.
-     * @returns {boolean} The reachable attribute.
-     */
     private getReachability;
-    /**
-     * 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.
-     */
     private getPowerSource;
-    /**
-     * Retrieves the battery level attribute.
-     *
-     * @param {MatterbridgeEndpoint} endpoint - The MatterbridgeDevice to retrieve the power source from.
-     * @returns {number | undefined} The battery level attribute.
-     */
     private getBatteryLevel;
-    /**
-     * 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.
-     */
     private getClusterTextFromDevice;
-    /**
-     * Retrieves the registered plugins sanitized for res.json().
-     *
-     * @returns {ApiPlugin[]} An array of BaseRegisteredPlugin.
-     */
     private getPlugins;
-    /**
-     * 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.
-     */
     private getDevices;
-    /**
-     * 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.
-     */
     private getClusters;
     private generateDiagnostic;
-    /**
-     * 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.
-     */
     private wsMessageHandler;
-    /**
-     * 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: string, time: string, name: string, message: string): void;
-    /**
-     * 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: RefreshRequiredChanged, params?: {
         matter: ApiMatter;
     }): void;
-    /**
-     * 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?: boolean, fixed?: boolean): void;
-    /**
-     * 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?: boolean): void;
-    /**
-     * 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?: boolean): void;
-    /**
-     * 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: number, processCpuUsage: number): void;
-    /**
-     * 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: string, freeMemory: string, rss: string, heapTotal: string, heapUsed: string, external: string, arrayBuffers: string): void;
-    /**
-     * 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: string, processUptime: string): void;
-    /**
-     * 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: string, timeout?: number, severity?: 'info' | 'warning' | 'error' | 'success'): void;
-    /**
-     * 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: string): void;
-    /**
-     * 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: string, serialNumber: string, uniqueId: string, number: EndpointNumber, id: string, cluster: string, attribute: string, value: number | string | boolean | null): void;
-    /**
-     * 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: WsMessageBroadcast): void;
 }
 export {};
-//# sourceMappingURL=frontend.d.ts.map