matterbridge 3.0.3 → 3.0.4-dev-20250525-b1cbfb7

package/CHANGELOG.md

@@ -8,6 +8,27 @@ If you like this project and find it useful, please consider giving it a star on
   <img src="bmc-button.svg" alt="Buy me a coffee" width="120">
 </a>
 
+## [3.0.4] - 2025-05-??
+
+### Added
+
+- [jsdoc]: Improved jsdoc for cluster helpers.
+- [cover]: Added createDefaultTiltWindowCoveringClusterServer().
+
+### Changed
+
+- [legacy]: Removed legacy matter.js EndpointServer and logEndpoint that will be removed in matter.js 0.14.0. For developers: if you need to log the endpoint the call is Logger.get('LogEndpoint').info(endpoint).
+- [package]: Updated dependencies.
+- [package]: Updated multer package to 2.0.0.
+
+### Fixed
+
+- [virtualDevice]: Fixed possible vulnerability in the length of the nodeLabel.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [3.0.3] - 2025-05-19
 
 ### New plugins
@@ -23,10 +44,10 @@ AEG RX 9 / Electrolux Pure i9 robot vacuum plugin for Matterbridge.
 
 ### Added
 
-- [virtual] Added virtual devices configuration mode in the Matterbridge Settings: 'Disabled', 'Light', 'Outlet', 'Switch', 'Mounted_switch'. Switch is not supported by Alexa. Mounted Switch is not supported by Apple.
-- [deviceTypes] Added evse, waterHeater, solarPower, batteryStorage and heatPump device type.
-- [waterHeater] Added WaterHeater class to create a Water Heater Device Type in one line of code (thanks https://github.com/lboue).
-- [subscribe] Added a third parameter context (provisional implementation: when "context.offline === true" then this is a change coming from the device).
+- [virtual]: Added virtual devices configuration mode in the Matterbridge Settings: 'Disabled', 'Light', 'Outlet', 'Switch', 'Mounted_switch'. Switch is not supported by Alexa. Mounted Switch is not supported by Apple.
+- [deviceTypes]: Added evse, waterHeater, solarPower, batteryStorage and heatPump device type.
+- [waterHeater]: Added WaterHeater class to create a Water Heater Device Type in one line of code (thanks https://github.com/lboue).
+- [subscribe]: Added a third parameter context (provisional implementation: when "context.offline === true" then this is a change coming from the device).
 
 ### Changed
 

package/README.md

@@ -5,7 +5,7 @@
 [![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge?label=docker%20version&sort=semver)](https://hub.docker.com/r/luligu/matterbridge)
 [![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge.svg)](https://hub.docker.com/r/luligu/matterbridge)
 ![Node.js CI](https://github.com/Luligu/matterbridge/actions/workflows/build.yml/badge.svg)
-![Coverage](https://img.shields.io/badge/Jest%20coverage-85%25-brightgreen)
+![Coverage](https://img.shields.io/badge/Jest%20coverage-86%25-brightgreen)
 
 [![power by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
 [![power by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
@@ -86,7 +86,7 @@ Follow these steps to install Matterbridge:
 npm install -g matterbridge --omit=dev
 ```
 
-on Linux you may need the necessary permissions:
+on Linux or macOS you may need the necessary permissions:
 
 ```
 sudo npm install -g matterbridge --omit=dev
@@ -142,7 +142,7 @@ Here's how to specify a different port number:
 matterbridge -frontend [port number]
 ```
 
-To use the frontend with ssl place the certificates in the .matterbridge/certs directory: cert.pem, key.pem and ca.pem (optional).
+To use the frontend with ssl see below.
 
 From the frontend you can do all operations in an easy way.
 
@@ -196,7 +196,7 @@ The other Home Assistant Community Add-ons and plugins are not verified to work
   <img src="screenshot/Shelly.svg" alt="Shelly plugin logo" width="100" />
 </a>
 
-Matterbridge shelly plugin allows you to expose all Shelly Gen 1, Gen 2, Gen 3 and BLU devices to Matter.
+Matterbridge shelly plugin allows you to expose all Shelly Gen 1, Gen 2, Gen 3 and Gen 4 and BLU devices to Matter.
 
 Features:
 
@@ -253,7 +253,7 @@ It is the ideal companion of the official [Matterbridge Home Assistant Add-on](h
   <img src="frontend/public/matterbridge.svg" alt="Matterbridge logo" width="100" />
 </a>
 
-Matterbridge Webhooks plugin allows you to expose any webhooks to Matter..
+Matterbridge Webhooks plugin allows you to expose any webhooks to Matter.
 
 ### BTHome
 
@@ -506,12 +506,6 @@ As of version 18.4.x, the Robot is supported by the Home app only as a single, n
 
 If a Robot is present alongside other devices in the bridge, the entire bridge becomes unstable in the Home app.
 
-### Concentration measurements clusters
-
-As of version 18.4.x, all cluster derived from the concentration measurement cluster hang the Home app while pairing and the entire bridge becomes unstable in the Home app.
-
-For example: air quality sensors with TVOC measurement or co sensors with CarbonMonoxide measurement.
-
 ## Home Assistant
 
 So far is the only controller supporting some Matter 1.2, 1.3 and 1.4 device type:
@@ -559,7 +553,7 @@ There is no support for these Matter device types:
 
 In the zigbee2mqtt and shelly plugins select the option to expose
 the switch devices like light or outlet cause they don't show up like switch
-(Matterbridge uses a modified switch device type without client cluster).
+(Matterbridge uses a switch device type without client cluster).
 
 ## SmartThings
 

package/dist/cli.js

@@ -1,44 +1,18 @@
 #!/usr/bin/env node
-/**
- * This file contains the CLI entry point of Matterbridge.
- *
- * @file cli.ts
- * @author Luca Liguori
- * @date 2023-12-29
- * @version 2.0.0
- *
- * Copyright 2023, 2024, 2025 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. *
- */
-// Matterbridge
 import { Matterbridge } from './matterbridge.js';
 import { getIntParameter, hasParameter } from './utils/export.js';
-// AnsiLogger module
 import { AnsiLogger, BRIGHT, CYAN, db, YELLOW } from './logger/export.js';
 import { EventEmitter } from 'node:events';
 import { inspect } from 'node:util';
 export const cliEmitter = new EventEmitter();
 export let instance;
-// Inspectop
 let session;
-// Cpu and memory check
 let memoryCheckInterval;
 let prevCpus;
 export let lastCpuUsage = 0;
 let peakCpu = 0;
 let peakRss = 0;
-const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
+const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
 const formatMemoryUsage = (bytes) => {
     if (bytes >= 1024 ** 3) {
         return `${(bytes / 1024 ** 3).toFixed(2)} GB`;
@@ -71,11 +45,9 @@ async function startCpuMemoryCheck() {
     prevCpus = os.cpus();
     clearInterval(memoryCheckInterval);
     const interval = () => {
-        // Get the os uptime
         const systemUptime = formatOsUpTime(Math.floor(os.uptime()));
         const processUptime = formatOsUpTime(Math.floor(process.uptime()));
         cliEmitter.emit('uptime', systemUptime, processUptime);
-        // Get the memory usage
         const totalMememory = formatMemoryUsage(os.totalmem());
         const freeMemory = formatMemoryUsage(os.freemem());
         const memoryUsageRaw = process.memoryUsage();
@@ -87,11 +59,10 @@ async function startCpuMemoryCheck() {
         if (memoryUsageRaw.rss > peakRss)
             peakRss = memoryUsageRaw.rss;
         cliEmitter.emit('memory', totalMememory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers);
-        // Get the cpu usage
         const currCpus = os.cpus();
         let cpuUsageLog;
         if (currCpus.length !== prevCpus.length) {
-            prevCpus = currCpus; // Reset the previous cpus
+            prevCpus = currCpus;
             log.debug(`Cpu check length failed, resetting previous cpus`);
             return;
         }
@@ -117,7 +88,6 @@ async function startCpuMemoryCheck() {
             cliEmitter.emit('cpu', lastCpuUsage);
         }
         prevCpus = currCpus;
-        // Show the cpu and memory usage
         log.debug(`***${YELLOW}${BRIGHT}Cpu usage:${db} ${CYAN}${cpuUsageLog.padStart(6, ' ')} %${db} ${YELLOW}${BRIGHT}Memory usage:${db} rss ${CYAN}${rss}${db} heapTotal ${CYAN}${heapTotal}${db} heapUsed ${CYAN}${heapUsed}${db} external ${external} arrayBuffers ${arrayBuffers}`);
     };
     interval();
@@ -145,7 +115,6 @@ async function stopInspector() {
         return;
     }
     try {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const result = await new Promise((resolve, reject) => {
             session?.post('HeapProfiler.stopSampling', (err, result) => (err ? reject(err) : resolve(result)));
         });
@@ -190,7 +159,6 @@ async function restart() {
 }
 async function update() {
     log.debug('Received update event, updating...');
-    // TODO: Implement update logic outside of matterbridge
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
@@ -210,7 +178,6 @@ async function main() {
     log.debug(`***Matterbridge.loadInstance(true) called`);
     instance = await Matterbridge.loadInstance(true);
     log.debug(`***Matterbridge.loadInstance(true) exited`);
-    // Check if the instance needs to shut down from parseCommandLine()
     if (!instance || instance.shutdown) {
         shutdown();
     }
@@ -218,11 +185,9 @@ async function main() {
         registerHandlers();
     }
 }
-// Run the main function
 process.title = 'matterbridge';
 main().catch((error) => {
     const errorMessage = error instanceof Error ? error.message : error;
     const errorInspect = inspect(error, { depth: 10 });
     log.error(`Matterbridge.loadInstance() failed with error: ${errorMessage}\nstack: ${errorInspect}`);
 });
-//# sourceMappingURL=cli.js.map

package/dist/cluster/export.js

@@ -1,3 +1 @@
 export {};
-// Nothing to export right now, but this file is here to make it easier to add exports in the future
-//# sourceMappingURL=export.js.map

package/dist/defaultConfigSchema.js

@@ -1,25 +1,3 @@
-/**
- * This file contains the default config for the plugins.
- *
- * @file defaultConfigSchema.ts
- * @author Luca Liguori
- * @date 2024-05-07
- * @version 1.0.1
- *
- * Copyright 2024, 2025, 2026 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. *
- */
 export const zigbee2mqtt_config = {
     name: 'matterbridge-zigbee2mqtt',
     type: 'DynamicPlatform',
@@ -78,4 +56,3 @@ export const shelly_config = {
     debugWs: false,
     unregisterOnShutdown: false,
 };
-//# sourceMappingURL=defaultConfigSchema.js.map

package/dist/deviceManager.js

@@ -1,89 +1,28 @@
-/**
- * This file contains the DeviceManager class.
- *
- * @file devices.ts
- * @author Luca Liguori
- * @date 2024-07-26
- * @version 1.0.10
- *
- * Copyright 2024, 2025, 2026 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 module
 import { AnsiLogger, BLUE, er } from './logger/export.js';
 import { dev } from './matterbridgeTypes.js';
-/**
- * Manages Matterbridge devices.
- */
 export class DeviceManager {
     _devices = new Map();
     matterbridge;
     nodeContext;
     log;
-    /**
-     * Creates an instance of DeviceManager.
-     *
-     * @param {Matterbridge} matterbridge - The Matterbridge instance.
-     * @param {NodeStorage} nodeContext - The node storage context.
-     */
     constructor(matterbridge, nodeContext) {
         this.matterbridge = matterbridge;
         this.nodeContext = nodeContext;
-        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: matterbridge.log.logLevel });
+        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4, logLevel: matterbridge.log.logLevel });
         this.log.debug('Matterbridge device manager starting...');
     }
-    /**
-     * Gets the number of devices.
-     *
-     * @returns {number} The number of devices.
-     */
     get length() {
         return this._devices.size;
     }
-    /**
-     * Gets the number of devices.
-     *
-     * @returns {number} The number of devices.
-     */
     get size() {
         return this._devices.size;
     }
-    /**
-     * Checks if a device with the specified unique ID exists.
-     *
-     * @param {string} uniqueId - The unique ID of the device.
-     * @returns {boolean} True if the device exists, false otherwise.
-     */
     has(uniqueId) {
         return this._devices.has(uniqueId);
     }
-    /**
-     * Gets a device by its unique ID.
-     *
-     * @param {string} uniqueId - The unique ID of the device.
-     * @returns {MatterbridgeEndpoint | undefined} The device, or undefined if not found.
-     */
     get(uniqueId) {
         return this._devices.get(uniqueId);
     }
-    /**
-     * Adds a device to the manager.
-     *
-     * @param {MatterbridgeEndpoint} device - The device to add.
-     * @returns {MatterbridgeEndpoint} The added device.
-     * @throws {Error} If the device does not have a unique ID.
-     */
     set(device) {
         if (!device.uniqueId)
             throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -92,13 +31,6 @@ export class DeviceManager {
         this._devices.set(device.uniqueId, device);
         return device;
     }
-    /**
-     * Removes a device from the manager.
-     *
-     * @param {MatterbridgeEndpoint} device - The device to remove.
-     * @returns {boolean} True if the device was removed, false otherwise.
-     * @throws {Error} If the device does not have a unique ID.
-     */
     remove(device) {
         if (!device.uniqueId)
             throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -106,34 +38,15 @@ export class DeviceManager {
             this.log.error(`The device ${dev}${device.deviceName}${er} with uniqueId ${BLUE}${device.uniqueId}${er} serialNumber ${BLUE}${device.serialNumber}${er} is not registered in the device manager`);
         return this._devices.delete(device.uniqueId);
     }
-    /**
-     * Clears all devices from the manager.
-     */
     clear() {
         this._devices.clear();
     }
-    /**
-     * Gets an array of all devices.
-     *
-     * @returns {MatterbridgeEndpoint[]} An array of all devices.
-     */
     array() {
         return Array.from(this._devices.values());
     }
-    /**
-     * Iterates over all devices.
-     *
-     * @returns {IterableIterator<MatterbridgeEndpoint>} An iterator for the devices.
-     */
     [Symbol.iterator]() {
         return this._devices.values();
     }
-    /**
-     * Asynchronously iterates over each device and calls the provided callback function.
-     *
-     * @param {(device: MatterbridgeEndpoint) => Promise<void>} callback - The callback function to call with each device.
-     * @returns {Promise<void>} A promise that resolves when all callbacks have been called.
-     */
     async forEach(callback) {
         if (this.size === 0)
             return;
@@ -147,13 +60,7 @@ export class DeviceManager {
         });
         await Promise.all(tasks);
     }
-    /**
-     * Sets the log level.
-     *
-     * @param {LogLevel} logLevel - The log level to set.
-     */
     set logLevel(logLevel) {
         this.log.logLevel = logLevel;
     }
 }
-//# sourceMappingURL=deviceManager.js.map