matterbridge 3.0.7 → 3.0.8-dev-20250622-9a6255a

package/CHANGELOG.md

@@ -8,6 +8,31 @@ 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.8] - 2025-06-??
+
+### Breaking Changes
+
+### Added
+
+- [DevContainer]: Added support for the **Matterbridge Dev Container** with an optimized named volume for `node_modules`.
+- [GitHub]: Added GitHub issue templates for bug reports and feature requests.
+- [Systemd]: Added a systemd service file for Matterbridge.
+- [ESLint]: Refactored ESLint configuration for TypeScript and improved plugin integration.
+- [ESLint]: Added the plugins `eslint-plugin-promise`, `eslint-plugin-jsdoc`, and `@vitest/eslint-plugin`.
+- [Vitest]: Added Vitest for TypeScript project testing. It will replace Jest, which does not work correctly with ESM module mocks.
+- [JSDoc]: Added missing JSDoc comments, including `@param` and `@returns` tags.
+
+### Changed
+
+- [package]: Updated dependencies and refactored scripts.
+- [storage]: Bumped `node-storage-manager` to 2.0.0.
+
+### Fixed
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [3.0.7] - 2025-06-21
 
 ### Breaking Changes

package/bin/matterbridge

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import('../dist/cli.js');

package/dist/cli.js

@@ -1,46 +1,19 @@
-#!/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.1
- *
- * 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 os from 'node:os';
 import { EventEmitter } from 'node:events';
 import { inspect } from 'node:util';
+import { AnsiLogger, BRIGHT, CYAN, db, YELLOW } from 'node-ansi-logger';
+import { getIntParameter, hasParameter } from './utils/export.js';
+import { Matterbridge } from './matterbridge.js';
 export const cliEmitter = new EventEmitter();
 export let instance;
-// Inspectop
 let session;
 let snapshotInterval;
-// 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`;
@@ -68,16 +41,13 @@ const formatOsUpTime = (seconds) => {
     return `${seconds} second${seconds !== 1 ? 's' : ''}`;
 };
 async function startCpuMemoryCheck() {
-    // const os = await import('node:os');
     log.debug(`Cpu memory check started`);
     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();
@@ -89,12 +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();
-        // log.debug(`Cpus: ${JSON.stringify(currCpus)}`);
         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;
         }
@@ -120,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();
@@ -131,15 +98,10 @@ async function stopCpuMemoryCheck() {
     log.debug(`***Cpu memory check stopped. Peak cpu: ${CYAN}${peakCpu.toFixed(2)} %${db}. Peak rss: ${CYAN}${formatMemoryUsage(peakRss)}${db}.`);
     clearInterval(memoryCheckInterval);
 }
-/**
- * Starts the inspector for heap sampling.
- * This function is called when the -inspect parameter is passed.
- */
 async function startInspector() {
     const { Session } = await import('node:inspector');
     const { mkdirSync } = await import('node:fs');
     log.debug(`***Starting heap sampling...`);
-    // Create the heap snapshots directory if it doesn't exist
     mkdirSync('heap_profile', { recursive: true });
     try {
         session = new Session();
@@ -148,7 +110,6 @@ async function startInspector() {
             session?.post('HeapProfiler.startSampling', (err) => (err ? reject(err) : resolve()));
         });
         log.debug(`***Started heap sampling`);
-        // Set an interval to take heap snapshots
         const interval = getIntParameter('snapshotinterval');
         if (interval && interval >= 30000) {
             log.debug(`***Started heap snapshot interval of ${CYAN}${interval}${db} ms`);
@@ -166,19 +127,13 @@ async function startInspector() {
         return;
     }
 }
-/**
- * Stops the heap sampling and saves the profile to a file.
- * This function is called when the inspector is stopped.
- */
 async function stopInspector() {
     const { writeFileSync } = await import('node:fs');
     const path = await import('node:path');
     log.debug(`***Stopping heap sampling...`);
     if (snapshotInterval) {
         log.debug(`***Clearing heap snapshot interval...`);
-        // Clear the snapshot interval if it exists
         clearInterval(snapshotInterval);
-        // Take a final heap snapshot before stopping
         await takeHeapSnapshot();
     }
     if (!session) {
@@ -186,7 +141,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)));
         });
@@ -204,13 +158,6 @@ async function stopInspector() {
         log.debug(`***Stopped heap sampling`);
     }
 }
-/**
- * Takes a heap snapshot and saves it to the file name Heap-snapshot-<timestamp>.heapsnapshot.
- * This function is called periodically based on the -snapshotinterval parameter.
- * The -snapshotinterval parameter must at least 30000 ms.
- * The snapshot is saved in the heap_profile directory that is created in the current working directory.
- * The snapshot can be analyzed using vscode or Chrome DevTools or other tools that support heap snapshots.
- */
 async function takeHeapSnapshot() {
     const { writeFileSync } = await import('node:fs');
     const path = await import('node:path');
@@ -242,10 +189,6 @@ async function takeHeapSnapshot() {
         });
     });
 }
-/**
- * Triggers a manual garbage collection.
- * This function is working only if the process is started with --expose-gc.
- */
 function triggerGarbageCollection() {
     if (typeof global.gc === 'function') {
         global.gc();
@@ -292,7 +235,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();
 }
@@ -312,7 +254,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();
     }
@@ -321,11 +262,9 @@ async function main() {
         cliEmitter.emit('ready');
     }
 }
-// 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/clusters/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 { AnsiLogger, BLUE, er } from 'node-ansi-logger';
 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

package/dist/devices/export.js

@@ -1,6 +1,4 @@
-// Single class device types
 export * from '../roboticVacuumCleaner.js';
 export * from '../laundryWasher.js';
 export * from '../waterHeater.js';
 export * from '../evse.js';
-//# sourceMappingURL=export.js.map

package/dist/evse.js

@@ -1,49 +1,12 @@
-/**
- * This file contains the Evse class.
- *
- * @file energy-evse.ts
- * @author Luca Liguori
- * @contributor Ludovic BOUÉ
- * @date 2025-05-27
- * @version 1.1.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 { EnergyEvseServer } from '@matter/main/behaviors/energy-evse';
 import { EnergyEvseModeServer } from '@matter/main/behaviors/energy-evse-mode';
 import { EnergyEvse, EnergyEvseMode } from '@matter/main/clusters';
 import { DeviceEnergyManagement } from '@matter/main/clusters/device-energy-management';
 import { ModeBase } from '@matter/main/clusters/mode-base';
-// Matterbridge
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 import { MatterbridgeServer } from './matterbridgeBehaviors.js';
 import { deviceEnergyManagement, electricalSensor, evse, powerSource } from './matterbridgeDeviceTypes.js';
 export class Evse extends MatterbridgeEndpoint {
-    /**
-     * Creates an instance of the EVSE class.
-     *
-     * @param {string} name - The name of the EVSE.
-     * @param {string} serial - The serial number of the EVSE.
-     * @param {number} [currentMode] - The current mode of the EnergyEvseMode cluster. Defaults to mode 1 (EnergyEvseMode.ModeTag.Manual).
-     * @param {EnergyEvseMode.ModeOption[]} [supportedModes] - The supported modes for the EnergyEvseMode cluster. This is a fixed attribute that defaults to a predefined set of EnergyEvseMode cluster modes.
-     * @param {EnergyEvse.State} [state] - The current state of the EVSE. Defaults to NotPluggedIn.
-     * @param {EnergyEvse.SupplyState} [supplyState] - The supply state of the EVSE. Defaults to Disabled.
-     * @param {EnergyEvse.FaultState} [faultState] - The fault state of the EVSE. Defaults to NoError.
-     * @param {number} [absMinPower=0] - Indicate the minimum electrical power that the ESA can consume when switched on. Defaults to `0` if not provided.
-     * @param {number} [absMaxPower=0] - Indicate the maximum electrical power that the ESA can consume when switched on. Defaults to `0` if not provided.
-     */
     constructor(name, serial, currentMode, supportedModes, state, supplyState, faultState, absMinPower, absMaxPower) {
         super([evse, powerSource, electricalSensor, deviceEnergyManagement], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer()
@@ -57,42 +20,29 @@ export class Evse extends MatterbridgeEndpoint {
             .createDefaultEnergyEvseModeClusterServer(currentMode, supportedModes)
             .addRequiredClusterServers();
     }
-    /**
-     * Creates a default EnergyEvseServer Cluster Server.
-     *
-     */
     createDefaultEnergyEvseClusterServer(state, supplyState, faultState) {
         this.behaviors.require(MatterbridgeEnergyEvseServer, {
             state: state ?? EnergyEvse.State.NotPluggedIn,
             supplyState: supplyState ?? EnergyEvse.SupplyState.ChargingEnabled,
             faultState: faultState ?? EnergyEvse.FaultState.NoError,
-            chargingEnabledUntil: 0, // Persistent attribute
-            circuitCapacity: 0, // Persistent attribute in mA
-            minimumChargeCurrent: 6000, // Persistent attribute in mA
-            maximumChargeCurrent: 0, // Persistent attribute in mA
-            sessionId: null, // Persistent attribute
-            sessionDuration: 0, // Persistent attribute
-            sessionEnergyCharged: 0, // Persistent attribute
+            chargingEnabledUntil: 0,
+            circuitCapacity: 0,
+            minimumChargeCurrent: 6000,
+            maximumChargeCurrent: 0,
+            sessionId: null,
+            sessionDuration: 0,
+            sessionEnergyCharged: 0,
         });
         return this;
     }
-    /**
-     * Creates a default EnergyEvseMode Cluster Server.
-     *
-     * @param {number} [currentMode] - The current mode of the EnergyEvseMode cluster. Defaults to mode 1 (EnergyEvseMode.ModeTag.Manual).
-     * @param {EnergyEvseMode.ModeOption[]} [supportedModes] - The supported modes for the EnergyEvseMode cluster. Defaults all EnergyEvseMode cluster modes.
-     *
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     */
     createDefaultEnergyEvseModeClusterServer(currentMode, supportedModes) {
         this.behaviors.require(MatterbridgeEnergyEvseModeServer, {
             supportedModes: supportedModes ?? [
                 { label: 'On demand', mode: 1, modeTags: [{ value: EnergyEvseMode.ModeTag.Manual }] },
                 { label: 'Scheduled', mode: 2, modeTags: [{ value: EnergyEvseMode.ModeTag.TimeOfUse }] },
                 { label: 'Solar charging', mode: 3, modeTags: [{ value: EnergyEvseMode.ModeTag.SolarCharging }] },
-                // { label: 'Home to vehicle and Vehicle to home', mode: 4, modeTags: [{ value: EnergyEvseMode.ModeTag.V2X }] }, // This mode is not valid in charging only EVSEs
-            ], // FixedAttribute
-            currentMode: currentMode ?? 1, // Persistent attribute
+            ],
+            currentMode: currentMode ?? 1,
         });
         return this;
     }
@@ -108,8 +58,6 @@ export class MatterbridgeEnergyEvseServer extends EnergyEvseServer {
             this.state.state = EnergyEvse.State.PluggedInDemand;
         }
         this.state.chargingEnabledUntil = 0;
-        // super.disable();
-        // disable is not implemented in matter.js
     }
     enableCharging(request) {
         const device = this.endpoint.stateOf(MatterbridgeServer);
@@ -123,9 +71,6 @@ export class MatterbridgeEnergyEvseServer extends EnergyEvseServer {
         this.state.chargingEnabledUntil = request.chargingEnabledUntil;
         this.state.minimumChargeCurrent = request.minimumChargeCurrent;
         this.state.maximumChargeCurrent = request.maximumChargeCurrent;
-        // The implementation should also stop the charging session at the required time and update the sessionId, sessionDuration, and sessionEnergyCharged attributes if needed.
-        // super.enableCharging();
-        // enableCharging is not implemented in matter.js
     }
 }
 export class MatterbridgeEnergyEvseModeServer extends EnergyEvseModeServer {
@@ -143,4 +88,3 @@ export class MatterbridgeEnergyEvseModeServer extends EnergyEvseModeServer {
         return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
     }
 }
-//# sourceMappingURL=evse.js.map