matterbridge 3.2.9-dev-20250922-517cae7 → 3.2.9-dev-20250924-9417698

package/CHANGELOG.md

@@ -12,13 +12,15 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Breaking Changes
 
-- [profiles]: Profile management has changed. Now, each profile has its own independent directories under `profiles` with storage, matterstorage, plugin config, and plugin directory. This means that if you are using profiles, Matterbridge will not find the old profile data. This allows to run multiple instances of matterbridge (change the frontend port and the matter port for each profile) or to simply make a test of a new plugin without modifing your production setup.
+- [profiles]: Profile management has changed. Now, each profile has its own independent directories under `profiles` with storage, matterstorage, plugin config, and plugin directory. This means that if you are using profiles, Matterbridge will not find the old profile data. The new profile management allows to run multiple instances of matterbridge (change the frontend port and the matter port for each profile) or to simply make a test of a new plugin without modifing your production setup.
 
 ### Added
 
-- [frontend]: Bumped `frontend` version to 3.1.0. Fully typed with the backend.
+- [frontend]: Bumped `frontend` version to 3.1.0. Now, 100% on typescript and fully typed with the backend.
 - [frontend]: Removed legacy `react-table` and created an autonomous component `MbfTable`. Features: unique UI for all tables with integrated column sorting and column selection.
 - [frontend]: Use MbfTable for Plugins, Devices, Registered devices and Clusters tables.
+- [frontend]: Optimized WebSocker message handlers. Now, the handler targets the component.
+- [frontend]: Removed dangerouslySetInnerHTML from log rendering.
 
 ### Changed
 
@@ -27,7 +29,7 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Fixed
 
-- [frontend]: Fix default values for homePageMode in MatterbridgeSettings
+- [frontend]: Fix default values (devices) for homePageMode (logs/devices) in MatterbridgeSettings.
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="bmc-button.svg" alt="Buy me a coffee" width="80">

package/dist/frontend.js

@@ -938,7 +938,7 @@ export class Frontend extends EventEmitter {
             }
             this.log.debug(`Received message from websocket client: ${debugStringify(data)}`);
             if (data.method === 'ping') {
-                sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true, response: 'pong' });
+                sendResponse({ id: data.id, method: 'pong', src: 'Matterbridge', dst: data.src, success: true, response: 'pong' });
                 return;
             }
             else if (data.method === '/api/login') {
@@ -1281,7 +1281,7 @@ export class Frontend extends EventEmitter {
                 else
                     serverNode = this.matterbridge.getPlugins().find((p) => p.serverNode && p.serverNode.id === localData.params.id)?.serverNode || this.matterbridge.getDevices().find((d) => d.serverNode && d.serverNode.id === localData.params.id)?.serverNode;
                 if (!serverNode) {
-                    sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: 'Unknown server node id in /api/matter' });
+                    sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: `Unknown server node id ${localData.params.id} in /api/matter` });
                     return;
                 }
                 const matter = this.matterbridge.getServerNodeData(serverNode);
@@ -1704,7 +1704,6 @@ export class Frontend extends EventEmitter {
         message = message.replace(/[\t\n]/g, '');
         message = message.replace(/[\x00-\x1F\x7F]/g, '');
         message = message.replace(/\\"/g, '"');
-        message = message.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
         const maxContinuousLength = 100;
         const keepStartLength = 20;
         const keepEndLength = 20;
@@ -1717,11 +1716,11 @@ export class Frontend extends EventEmitter {
             return word;
         })
             .join(' ');
-        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'log', params: { level, time, name, message } });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'log', success: true, response: { level, time, name, message } });
     }
     wssSendRefreshRequired(changed, params) {
         this.log.debug('Sending a refresh required message to all connected clients');
-        this.wssBroadcastMessage({ id: 1, src: 'Matterbridge', dst: 'Frontend', method: 'refresh_required', params: { changed, ...params } });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'refresh_required', success: true, response: { changed, ...params } });
     }
     wssSendRestartRequired(snackbar = true, fixed = false) {
         this.log.debug('Sending a restart required message to all connected clients');
@@ -1729,50 +1728,50 @@ export class Frontend extends EventEmitter {
         this.matterbridge.matterbridgeInformation.fixedRestartRequired = fixed;
         if (snackbar === true)
             this.wssSendSnackbarMessage(`Restart required`, 0);
-        this.wssBroadcastMessage({ id: 2, src: 'Matterbridge', dst: 'Frontend', method: 'restart_required', params: { fixed } });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'restart_required', success: true, response: { fixed } });
     }
     wssSendRestartNotRequired(snackbar = true) {
         this.log.debug('Sending a restart not required message to all connected clients');
         this.matterbridge.matterbridgeInformation.restartRequired = false;
         if (snackbar === true)
             this.wssSendCloseSnackbarMessage(`Restart required`);
-        this.wssBroadcastMessage({ id: 3, src: 'Matterbridge', dst: 'Frontend', method: 'restart_not_required' });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'restart_not_required', success: true });
     }
     wssSendUpdateRequired(devVersion = false) {
         this.log.debug('Sending an update required message to all connected clients');
         this.matterbridge.matterbridgeInformation.updateRequired = true;
-        this.wssBroadcastMessage({ id: 8, src: 'Matterbridge', dst: 'Frontend', method: devVersion ? 'update_required_dev' : 'update_required' });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'update_required', success: true, response: { devVersion } });
     }
     wssSendCpuUpdate(cpuUsage) {
         if (hasParameter('debug'))
             this.log.debug('Sending a cpu update message to all connected clients');
-        this.wssBroadcastMessage({ id: 4, src: 'Matterbridge', dst: 'Frontend', method: 'cpu_update', params: { cpuUsage: Math.round(cpuUsage * 100) / 100 } });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'cpu_update', success: true, response: { cpuUsage: Math.round(cpuUsage * 100) / 100 } });
     }
     wssSendMemoryUpdate(totalMemory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers) {
         if (hasParameter('debug'))
             this.log.debug('Sending a memory update message to all connected clients');
-        this.wssBroadcastMessage({ id: 5, src: 'Matterbridge', dst: 'Frontend', method: 'memory_update', params: { totalMemory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers } });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'memory_update', success: true, response: { totalMemory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers } });
     }
     wssSendUptimeUpdate(systemUptime, processUptime) {
         if (hasParameter('debug'))
             this.log.debug('Sending a uptime update message to all connected clients');
-        this.wssBroadcastMessage({ id: 6, src: 'Matterbridge', dst: 'Frontend', method: 'uptime_update', params: { systemUptime, processUptime } });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'uptime_update', success: true, response: { systemUptime, processUptime } });
     }
     wssSendSnackbarMessage(message, timeout = 5, severity = 'info') {
         this.log.debug('Sending a snackbar message to all connected clients');
-        this.wssBroadcastMessage({ id: 7, src: 'Matterbridge', dst: 'Frontend', method: 'snackbar', params: { message, timeout, severity } });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'snackbar', success: true, response: { message, timeout, severity } });
     }
     wssSendCloseSnackbarMessage(message) {
         this.log.debug('Sending a close snackbar message to all connected clients');
-        this.wssBroadcastMessage({ id: 10, src: 'Matterbridge', dst: 'Frontend', method: 'close_snackbar', params: { message } });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'close_snackbar', success: true, response: { message } });
     }
     wssSendAttributeChangedMessage(plugin, serialNumber, uniqueId, cluster, attribute, value) {
         this.log.debug('Sending an attribute update message to all connected clients');
-        this.wssBroadcastMessage({ id: 9, src: 'Matterbridge', dst: 'Frontend', method: 'state_update', params: { plugin, serialNumber, uniqueId, cluster, attribute, value } });
+        this.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'state_update', success: true, response: { plugin, serialNumber, uniqueId, cluster, attribute, value } });
     }
     wssBroadcastMessage(msg) {
         const stringifiedMsg = JSON.stringify(msg);
-        if (msg.id !== 0)
+        if (msg.method !== 'log')
             this.log.debug(`Sending a broadcast message: ${debugStringify(msg)}`);
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {

package/dist/frontendTypes.js

@@ -1,25 +1,9 @@
-export var WsBroadcastMessageId;
-(function (WsBroadcastMessageId) {
-    WsBroadcastMessageId[WsBroadcastMessageId["Log"] = 0] = "Log";
-    WsBroadcastMessageId[WsBroadcastMessageId["RefreshRequired"] = 1] = "RefreshRequired";
-    WsBroadcastMessageId[WsBroadcastMessageId["RestartRequired"] = 2] = "RestartRequired";
-    WsBroadcastMessageId[WsBroadcastMessageId["RestartNotRequired"] = 3] = "RestartNotRequired";
-    WsBroadcastMessageId[WsBroadcastMessageId["CpuUpdate"] = 4] = "CpuUpdate";
-    WsBroadcastMessageId[WsBroadcastMessageId["MemoryUpdate"] = 5] = "MemoryUpdate";
-    WsBroadcastMessageId[WsBroadcastMessageId["UptimeUpdate"] = 6] = "UptimeUpdate";
-    WsBroadcastMessageId[WsBroadcastMessageId["Snackbar"] = 7] = "Snackbar";
-    WsBroadcastMessageId[WsBroadcastMessageId["UpdateRequired"] = 8] = "UpdateRequired";
-    WsBroadcastMessageId[WsBroadcastMessageId["StateUpdate"] = 9] = "StateUpdate";
-    WsBroadcastMessageId[WsBroadcastMessageId["CloseSnackbar"] = 10] = "CloseSnackbar";
-    WsBroadcastMessageId[WsBroadcastMessageId["ShellySysUpdate"] = 100] = "ShellySysUpdate";
-    WsBroadcastMessageId[WsBroadcastMessageId["ShellyMainUpdate"] = 101] = "ShellyMainUpdate";
-})(WsBroadcastMessageId || (WsBroadcastMessageId = {}));
-export function isBroadcast(msg) {
-    return msg.id >= 0 && msg.id <= 101;
-}
 export function isApiRequest(msg) {
-    return msg.id > 101 && msg.src === 'Frontend' && msg.dst === 'Matterbridge' && !('success' in msg) && !('error' in msg);
+    return msg.id !== 0 && msg.src === 'Frontend' && msg.dst === 'Matterbridge';
 }
 export function isApiResponse(msg) {
-    return msg.id > 101 && msg.src === 'Matterbridge' && msg.dst === 'Frontend' && ('success' in msg || 'error' in msg);
+    return msg.id !== 0 && msg.src === 'Matterbridge' && msg.dst === 'Frontend';
+}
+export function isBroadcast(msg) {
+    return msg.id === 0 && msg.src === 'Matterbridge' && msg.dst === 'Frontend';
 }

package/dist/shelly.js

@@ -13,7 +13,7 @@ export async function getShellySysUpdate(matterbridge) {
         if (updates.length === 0)
             return;
         matterbridge.matterbridgeInformation.shellySysUpdate = true;
-        matterbridge.frontend.wssBroadcastMessage({ id: 100, src: 'Matterbridge', dst: 'Frontend', method: 'shelly_sys_update', params: { available: true } });
+        matterbridge.frontend.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'shelly_sys_update', success: true, response: { available: true } });
         for (const { name } of updates) {
             if (!name)
                 continue;
@@ -31,7 +31,7 @@ export async function triggerShellySysUpdate(matterbridge) {
         matterbridge.log.notice('Installing Shelly system update...');
         matterbridge.matterbridgeInformation.shellySysUpdate = false;
         matterbridge.frontend.wssSendSnackbarMessage('Installing Shelly system update...', 15);
-        matterbridge.frontend.wssBroadcastMessage({ id: 100, src: 'Matterbridge', dst: 'Frontend', method: 'shelly_sys_update', params: { available: false } });
+        matterbridge.frontend.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'shelly_sys_update', success: true, response: { available: false } });
         await verifyShellyUpdate(matterbridge, '/api/updates/sys/status', 'Shelly system update');
     }
     catch (err) {
@@ -44,7 +44,7 @@ export async function getShellyMainUpdate(matterbridge) {
         if (updates.length === 0)
             return;
         matterbridge.matterbridgeInformation.shellyMainUpdate = true;
-        matterbridge.frontend.wssBroadcastMessage({ id: 101, src: 'Matterbridge', dst: 'Frontend', method: 'shelly_main_update', params: { available: true } });
+        matterbridge.frontend.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'shelly_main_update', success: true, response: { available: true } });
         for (const { name } of updates) {
             if (!name)
                 continue;
@@ -62,7 +62,7 @@ export async function triggerShellyMainUpdate(matterbridge) {
         matterbridge.log.notice('Installing Shelly software update...');
         matterbridge.matterbridgeInformation.shellyMainUpdate = false;
         matterbridge.frontend.wssSendSnackbarMessage('Installing Shelly software update...', 15);
-        matterbridge.frontend.wssBroadcastMessage({ id: 101, src: 'Matterbridge', dst: 'Frontend', method: 'shelly_main_update', params: { available: false } });
+        matterbridge.frontend.wssBroadcastMessage({ id: 0, src: 'Matterbridge', dst: 'Frontend', method: 'shelly_main_update', success: true, response: { available: false } });
         await verifyShellyUpdate(matterbridge, '/api/updates/main/status', 'Shelly software update');
     }
     catch (err) {