Release 3.0.6

* Update dependencies

* Add createDirectory and Jest test

* Update Jest test coverage on addBridgedEndpoint and removeBridgedEndpoint

* Fix jsdoc on Evse

* Update CHANGELOG for Jest test coverage and jsdoc fixes

* Add spawnCommand and Jest test

* Jest test on verifyShellyUpdate

* Update base.test.ts

* Add Jest test on default export missed in plugins

* Update copyDirectory

* Bump version to 1.0.1 in copyDirectory.ts

* Bump version to 1.0.1 in wait.ts and optimize interval check with async

* Update Matterbridge to version 1.6.0, add online/offline events, improve backup error handling, and refactor advertising timeout logic

* Jest tests

* Jest tests

* Update Evse

* Bump version to 1.0.2 and update default supply state to ChargingEnabled in Evse class

* Jest tests

* Fix wrong names DeviceEnergyManagement and DeviceEnergyManagementMode

* Bump WaterHeater to 1.1.0

* Bump RoboticVacuumCleaner to 1.1.0

* Bump Evse to 1.1.0

* Bump LaundryWasher to 1.1.0

* Bump Evse to 1.1.0

* Bump MatterbridgeEndpoint to 2.1.0

* Bump MatterbridgeEndpoint to 2.1.0

* Bump Matterbridge Behaviors to 1.1.0

* Bump Matterbridge Behaviors to 1.3.0

* Bump Matterbridge Behaviors to 1.3.0

* Bump Matterbridge Behaviors to 1.3.0

* Add invokeSubscribeHandler to run Jest tests

* Add logic in MatterbridgeValveConfigurationAndControlServer

* Add cluster property to commandHandler data

* Update README.md (#326)

* Update fan cluster helpers

* Update CHANGELOG.md with recent additions and changes

* Bump version of MatterbridgeEndpoint to 2.1.1 and update MatterbridgeEndpoint with serverNode and bridgeMode documentation

* Add globalMatterbridge module with instance management functions and tests

* Add error handling tests for Matterbridge CLI

* Release 3.0.6

* Fix typo in cluster helper description in CHANGELOG.md

* Add documentation for mb-service integration by Michael Ahern

* Update mb-service link in CHANGELOG.md to include service functionality details

Author: Luligu

.vscode/tasks.json

@@ -49,7 +49,17 @@
       "label": "Test: Matterbridge",
       "type": "shell",
       "command": "node",
-      "args": ["--no-warnings", "--experimental-vm-modules", "node_modules/jest/bin/jest.js", "--coverage", "--maxWorkers=100%", "matterbridge.test.ts", "matterbridge.bridge.test.ts", "matterbridge.childbridge.test.ts"],
+      "args": [
+        "--no-warnings",
+        "--experimental-vm-modules",
+        "node_modules/jest/bin/jest.js",
+        "--coverage",
+        "--maxWorkers=100%",
+        "matterbridge.test.ts",
+        "matterbridge.matterjs.test.ts",
+        "matterbridge.bridge.test.ts",
+        "matterbridge.childbridge.test.ts"
+      ],
       "group": {
         "kind": "test",
         "isDefault": false

CHANGELOG.md

@@ -8,6 +8,35 @@ 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.6] - 2025-06-13
+
+### Added
+
+- [tests] Update Jest test coverage on addBridgedEndpoint and removeBridgedEndpoint.
+- [fan]: Added createMultiSpeedFanControlClusterServer cluster helper with MultiSpeed feature.
+- [fan]: Added all parameters to the fan cluster helpers.
+- [valve]: Added logic in MatterbridgeValveConfigurationAndControlServer.
+- [command]: Added cluster property to commandHandler data object.
+- [mb-service]: Added a link to [mb-service](https://github.com/michaelahern/mb-service) package by [Michael Ahern](https://github.com/michaelahern). It runs matterbridge as a service in macOS.
+
+### Changed
+
+- [package]: Updated dependencies.
+- [fan]: The default fan has no more the MultiSpeed feature.
+- [behaviors]: Bump Matterbridge Behaviors to 1.3.0
+- [evse]: Updated class and behavior to 1.1.0.
+- [waterHeater]: Updated class and behavior to 1.1.0.
+- [rvc]: Updated class and behavior to 1.1.0.
+- [laundryWasher]: Updated class and behavior to 1.1.0.
+
+### Fixed
+
+- [evse]: Fixed jsdoc on Evse.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [3.0.5] - 2025-06-07
 
 ### Added

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-86%25-brightgreen)
+![Coverage](https://img.shields.io/badge/Jest%20coverage-88%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)
@@ -172,6 +172,10 @@ Config editor:
 
 [Podman configurations](README-PODMAN.md)
 
+### Run matterbridge as a service on macOS with mb-service (by [Michael Ahern](https://github.com/michaelahern))
+
+[Matterbridge Service Command for macOS](https://github.com/michaelahern/mb-service)
+
 ### Run matterbridge with nginx
 
 [Nginx configurations](README-NGINX.md)
@@ -324,6 +328,8 @@ It exposes 38 devices:
 - a microwave Oven device (supported by SmartThings, Alexa and Home Assistant)
 - an extractor Hood device (supported by SmartThings, Alexa and Home Assistant)
 - a cooktop device (supported by SmartThings, Alexa and Home Assistant)
+- a water heater device (supported by SmartThings and Home Assistant)
+- a car charger device (supported by Home Assistant)
 
 All these virtual devices continuously change state and position. The plugin also shows how to use all the command handlers (you can control all the devices).
 

jest.config.js

@@ -28,6 +28,6 @@ export default {
     ],
   },
   transformIgnorePatterns: ['/node_modules/'],
-  testPathIgnorePatterns: ['/node_modules/', '/dist/', '/frontend/'],
+  testPathIgnorePatterns: ['/node_modules/', '/dist/', '/frontend/', '/src/crypto/'],
   coveragePathIgnorePatterns: ['/node_modules/', '/dist/', '/frontend/', '/src/mock/'],
 };

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.0.5",
+  "version": "3.0.6",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",
@@ -153,13 +153,13 @@
   "devDependencies": {
     "@eslint/js": "9.28.0",
     "@types/archiver": "6.0.3",
-    "@types/express": "5.0.2",
+    "@types/express": "5.0.3",
     "@types/jest": "29.5.14",
-    "@types/multer": "1.4.12",
-    "@types/node": "22.15.29",
+    "@types/multer": "1.4.13",
+    "@types/node": "22.15.30",
     "@types/ws": "8.18.1",
     "eslint-config-prettier": "10.1.5",
-    "eslint-plugin-jest": "28.12.0",
+    "eslint-plugin-jest": "28.13.0",
     "eslint-plugin-n": "17.19.0",
     "eslint-plugin-prettier": "5.4.1",
     "eslint-plugin-react": "7.37.5",

package.json

@@ -84,11 +84,11 @@ describe('Matterbridge ' + NAME, () => {
 
   beforeAll(async () => {
     // Cleanup the matter environment
-    rmSync(path.join('jest', NAME), { recursive: true, force: true });
+    rmSync(path.join('test', NAME), { recursive: true, force: true });
     // Setup the matter environment
     environment.vars.set('log.level', MatterLogLevel.DEBUG);
     environment.vars.set('log.format', MatterLogFormat.ANSI);
-    environment.vars.set('path.root', path.join('jest', NAME));
+    environment.vars.set('path.root', path.join('test', NAME));
     environment.vars.set('runtime.signals', false);
     environment.vars.set('runtime.exitcode', false);
   }, 30000);

src/base.test.ts

@@ -0,0 +1,68 @@
+// src\cli.error.test.ts
+
+/* eslint-disable @typescript-eslint/no-empty-function */
+/* eslint-disable no-console */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+process.argv = ['node', './cli.js', '-memorycheck', '-frontend', '0', '-profile', 'JestCli', '-debug', '-logger', 'debug', '-matterlogger', 'debug'];
+
+import { jest } from '@jest/globals';
+import { AnsiLogger, LogLevel } from 'node-ansi-logger';
+
+import { Matterbridge } from './matterbridge.js';
+
+let loggerLogSpy: jest.SpiedFunction<typeof AnsiLogger.prototype.log>;
+let consoleLogSpy: jest.SpiedFunction<typeof console.log>;
+let consoleDebugSpy: jest.SpiedFunction<typeof console.log>;
+let consoleInfoSpy: jest.SpiedFunction<typeof console.log>;
+let consoleWarnSpy: jest.SpiedFunction<typeof console.log>;
+let consoleErrorSpy: jest.SpiedFunction<typeof console.log>;
+const debug = false; // Set to true to enable debug logging
+
+if (!debug) {
+  loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log').mockImplementation((level: string, message: string, ...parameters: any[]) => {});
+  consoleLogSpy = jest.spyOn(console, 'log').mockImplementation((...args: any[]) => {});
+  consoleDebugSpy = jest.spyOn(console, 'debug').mockImplementation((...args: any[]) => {});
+  consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation((...args: any[]) => {});
+  consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation((...args: any[]) => {});
+  consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation((...args: any[]) => {});
+} else {
+  loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log');
+  consoleLogSpy = jest.spyOn(console, 'log');
+  consoleDebugSpy = jest.spyOn(console, 'debug');
+  consoleInfoSpy = jest.spyOn(console, 'info');
+  consoleWarnSpy = jest.spyOn(console, 'warn');
+  consoleErrorSpy = jest.spyOn(console, 'error');
+}
+
+const loadInstance = jest.spyOn(Matterbridge, 'loadInstance').mockImplementation(async (_initialize?: boolean) => {
+  console.log('mockImplementation of Matterbridge.loadInstance() called');
+  throw new Error('Mock implementation of loadInstance called.'); // Simulate an error by throwing an exception
+});
+
+const exit = jest.spyOn(process, 'exit').mockImplementation((code?: string | number | null | undefined) => {
+  console.log('mockImplementation of process.exit() called');
+  return undefined as never; // Prevent actual exit during tests
+});
+
+describe('Matterbridge', () => {
+  beforeEach(async () => {
+    // Clear all mocks before each test
+    jest.clearAllMocks();
+  });
+
+  afterAll(async () => {
+    // Restore all mocks
+    jest.restoreAllMocks();
+  });
+
+  it('should start matterbridge and fail', async () => {
+    // Dynamically import the cli module
+    const cli = await import('./cli.js');
+    await new Promise((resolve) => setTimeout(resolve, 100));
+    expect(cli.instance).toBeUndefined();
+    expect(loadInstance).toHaveBeenCalledTimes(1);
+    expect(exit).toHaveBeenCalledTimes(0);
+    expect(loggerLogSpy).toHaveBeenCalledWith(LogLevel.ERROR, expect.stringContaining(`Matterbridge.loadInstance() failed with error:`));
+  });
+});

src/cli.error.test.ts

@@ -0,0 +1,68 @@
+// src\cli.error2.test.ts
+
+/* eslint-disable @typescript-eslint/no-empty-function */
+/* eslint-disable no-console */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+process.argv = ['node', './cli.js', '-memorycheck', '-frontend', '0', '-profile', 'JestCli', '-debug', '-logger', 'debug', '-matterlogger', 'debug'];
+
+import { jest } from '@jest/globals';
+import { AnsiLogger, LogLevel } from 'node-ansi-logger';
+
+import { Matterbridge } from './matterbridge.js';
+
+let loggerLogSpy: jest.SpiedFunction<typeof AnsiLogger.prototype.log>;
+let consoleLogSpy: jest.SpiedFunction<typeof console.log>;
+let consoleDebugSpy: jest.SpiedFunction<typeof console.log>;
+let consoleInfoSpy: jest.SpiedFunction<typeof console.log>;
+let consoleWarnSpy: jest.SpiedFunction<typeof console.log>;
+let consoleErrorSpy: jest.SpiedFunction<typeof console.log>;
+const debug = false; // Set to true to enable debug logging
+
+if (!debug) {
+  loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log').mockImplementation((level: string, message: string, ...parameters: any[]) => {});
+  consoleLogSpy = jest.spyOn(console, 'log').mockImplementation((...args: any[]) => {});
+  consoleDebugSpy = jest.spyOn(console, 'debug').mockImplementation((...args: any[]) => {});
+  consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation((...args: any[]) => {});
+  consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation((...args: any[]) => {});
+  consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation((...args: any[]) => {});
+} else {
+  loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log');
+  consoleLogSpy = jest.spyOn(console, 'log');
+  consoleDebugSpy = jest.spyOn(console, 'debug');
+  consoleInfoSpy = jest.spyOn(console, 'info');
+  consoleWarnSpy = jest.spyOn(console, 'warn');
+  consoleErrorSpy = jest.spyOn(console, 'error');
+}
+
+const loadInstance = jest.spyOn(Matterbridge, 'loadInstance').mockImplementation(async (_initialize?: boolean) => {
+  console.log('mockImplementation of Matterbridge.loadInstance() called');
+  return undefined as never; // Simulate an error by returning undefined
+});
+
+const exit = jest.spyOn(process, 'exit').mockImplementation((code?: string | number | null | undefined) => {
+  console.log('mockImplementation of process.exit() called');
+  return undefined as never; // Prevent actual exit during tests
+});
+
+describe('Matterbridge', () => {
+  beforeEach(async () => {
+    // Clear all mocks before each test
+    jest.clearAllMocks();
+  });
+
+  afterAll(async () => {
+    // Restore all mocks
+    jest.restoreAllMocks();
+  });
+
+  it('should start matterbridge and return undefined', async () => {
+    // Dynamically import the cli module
+    const cli = await import('./cli.js');
+    await new Promise((resolve) => setTimeout(resolve, 100));
+    expect(cli.instance).toBeUndefined();
+    expect(loadInstance).toHaveBeenCalledTimes(1);
+    expect(exit).toHaveBeenCalledTimes(1);
+    expect(loggerLogSpy).toHaveBeenCalledWith(LogLevel.DEBUG, expect.stringContaining('Received shutdown event, exiting...'));
+  });
+});