matterbridge 3.2.10-dev-20250928-30c21de → 3.3.0-dev-20250928-3d2b558

package/CHANGELOG.md

@@ -8,9 +8,74 @@ 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.2.10] - Not released
+## Project evolution
 
-### Breaking Changes
+The project will evolve to multi thread (the cli will become the threads manager) with these initial threads:
+
+- matterbridge;
+- frontend;
+- all plugins in bridge mode;
+- each plugin in childbridge mode;
+
+Advantages:
+
+- real concurrency outside the Node.js main loop;
+- isolation between threads;
+- single plugin isolation in childbridge mode;
+
+## [3.3.0] - Not released
+
+### Development Breaking Changes
+
+- [platform]: Now, internal use only properties are private readonly and internal use only methods are private. This prepares the road to plugin isolation.
+- [platform]: The signature of the matterbridge param in the platform constructor has changed from Matterbridge to `PlatformMatterbridge` that has only the approriate readonly properties from matterbridge. This prepares the road to plugin isolation.
+
+This change will require to adapt all plugins in two steps.
+
+1. `After` matterbridge `3.3.0` will be published as latest:
+
+- update the plugin platform constructor with the new signature:
+
+```typescript
+  constructor(matterbridge: PlatformMatterbridge, log: AnsiLogger, config: PlatformConfig)
+```
+
+- require matterbridge 3.3.0:
+
+```typescript
+    if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.3.0')) {
+      throw new Error(
+        `This plugin requires Matterbridge version >= "3.3.0". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version."`,
+      );
+    }
+```
+
+- check that you didn't used any matterbridge calls.
+
+In this phase (matterbridge 3.3.x) all plugins will continue to build and run even without updates.
+
+2. `After` matterbridge `3.4.0` will be published as latest, the new signature `PlatformMatterbridge` with the plugin isolation will be effective.
+
+```typescript
+export type PlatformMatterbridge = {
+  readonly homeDirectory: string;
+  readonly rootDirectory: string;
+  readonly matterbridgeDirectory: string;
+  readonly matterbridgePluginDirectory: string;
+  readonly globalModulesDirectory: string;
+  readonly matterbridgeVersion: string;
+  readonly matterbridgeLatestVersion: string;
+  readonly matterbridgeDevVersion: string;
+  readonly bridgeMode: 'bridge' | 'childbridge' | 'controller' | '';
+  readonly restartMode: 'service' | 'docker' | '';
+  readonly aggregatorVendorId: VendorId;
+  readonly aggregatorVendorName: string;
+  readonly aggregatorProductId: number;
+  readonly aggregatorProductName: string;
+};
+```
+
+In this phase (matterbridge 3.4.x) all plugins will not build and will not run without updates.
 
 ### Added
 

package/dist/frontend.js

@@ -643,7 +643,7 @@ export class Frontend extends EventEmitter {
         this.matterbridge.matterbridgeInformation.restartMode = this.matterbridge.restartMode;
         this.matterbridge.matterbridgeInformation.profile = this.matterbridge.profile;
         this.matterbridge.matterbridgeInformation.loggerLevel = this.matterbridge.log.logLevel;
-        this.matterbridge.matterbridgeInformation.matterLoggerLevel = Logger.defaultLogLevel;
+        this.matterbridge.matterbridgeInformation.matterLoggerLevel = Logger.level;
         this.matterbridge.matterbridgeInformation.matterMdnsInterface = this.matterbridge.mdnsInterface;
         this.matterbridge.matterbridgeInformation.matterIpv4Address = this.matterbridge.ipv4address;
         this.matterbridge.matterbridgeInformation.matterIpv6Address = this.matterbridge.ipv6address;
@@ -997,6 +997,7 @@ export class Frontend extends EventEmitter {
                                     .then(() => {
                                     this.wssSendSnackbarMessage(`Started plugin ${packageName}`, 5, 'success');
                                     this.wssSendRefreshRequired('plugins');
+                                    this.wssSendRefreshRequired('devices');
                                     return;
                                 })
                                     .catch((_error) => {

package/dist/index.js

@@ -1,6 +1,6 @@
 import { AnsiLogger } from 'node-ansi-logger';
 import { Matterbridge } from './matterbridge.js';
-import { hasParameter } from './utils/export.js';
+import { hasParameter } from './utils/commandLine.js';
 export * from './matterbridge.js';
 export * from './matterbridgeTypes.js';
 export * from './matterbridgeEndpoint.js';

package/dist/matterbridgePlatform.js

@@ -5,7 +5,7 @@ import { CYAN, db, er, nf, wr } from 'node-ansi-logger';
 import { NodeStorageManager } from 'node-persist-manager';
 import { checkNotLatinCharacters } from './matterbridgeEndpointHelpers.js';
 import { bridgedNode } from './matterbridgeDeviceTypes.js';
-import { isValidArray, isValidObject, isValidString } from './utils/export.js';
+import { isValidArray, isValidObject, isValidString } from './utils/isvalid.js';
 export class MatterbridgePlatform {
     matterbridge;
     log;
@@ -17,12 +17,12 @@ export class MatterbridgePlatform {
     context;
     selectDevice = new Map();
     selectEntity = new Map();
-    _contextReady;
-    _selectDeviceContextReady;
-    _selectEntityContextReady;
+    contextReady;
+    selectDeviceContextReady;
+    selectEntityContextReady;
     ready;
-    _registeredEndpoints = new Map();
-    _registeredEndpointsByName = new Map();
+    registeredEndpointsByUniqueId = new Map();
+    registeredEndpointsByName = new Map();
     constructor(matterbridge, log, config) {
         this.matterbridge = matterbridge;
         this.log = log;
@@ -38,13 +38,13 @@ export class MatterbridgePlatform {
             forgiveParseErrors: true,
         });
         this.log.debug(`Creating context for plugin ${this.config.name}`);
-        this._contextReady = this.storage.createStorage('context').then((context) => {
+        this.contextReady = this.storage.createStorage('context').then((context) => {
             this.context = context;
             this.log.debug(`Created context for plugin ${this.config.name}`);
             return;
         });
         this.log.debug(`Loading selectDevice for plugin ${this.config.name}`);
-        this._selectDeviceContextReady = this.storage.createStorage('selectDevice').then(async (context) => {
+        this.selectDeviceContextReady = this.storage.createStorage('selectDevice').then(async (context) => {
             const selectDevice = await context.get('selectDevice', []);
             for (const device of selectDevice)
                 this.selectDevice.set(device.serial, device);
@@ -52,14 +52,14 @@ export class MatterbridgePlatform {
             return;
         });
         this.log.debug(`Loading selectEntity for plugin ${this.config.name}`);
-        this._selectEntityContextReady = this.storage.createStorage('selectEntity').then(async (context) => {
+        this.selectEntityContextReady = this.storage.createStorage('selectEntity').then(async (context) => {
             const selectEntity = await context.get('selectEntity', []);
             for (const entity of selectEntity)
                 this.selectEntity.set(entity.name, entity);
             this.log.debug(`Loaded ${this.selectEntity.size} selectEntity for plugin ${this.config.name}`);
             return;
         });
-        this.ready = Promise.all([this._contextReady, this._selectDeviceContextReady, this._selectEntityContextReady]).then(() => {
+        this.ready = Promise.all([this.contextReady, this.selectDeviceContextReady, this.selectEntityContextReady]).then(() => {
             this.log.debug(`MatterbridgePlatform for plugin ${this.config.name} is fully initialized`);
             return;
         });
@@ -79,8 +79,8 @@ export class MatterbridgePlatform {
         await this.checkEndpointNumbers();
         this.selectDevice.clear();
         this.selectEntity.clear();
-        this._registeredEndpoints.clear();
-        this._registeredEndpointsByName.clear();
+        this.registeredEndpointsByUniqueId.clear();
+        this.registeredEndpointsByName.clear();
         await this.context?.close();
         this.context = undefined;
         await this.storage?.close();
@@ -94,11 +94,21 @@ export class MatterbridgePlatform {
     async onConfigChanged(config) {
         this.log.debug(`The plugin ${CYAN}${config.name}${db} doesn't override onConfigChanged. Received new config.`);
     }
+    saveConfig(config) {
+        const plugin = this.matterbridge.plugins.get(this.name);
+        if (!plugin) {
+            throw new Error(`Plugin ${this.name} not found`);
+        }
+        this.matterbridge.plugins.saveConfigFromJson(plugin, config);
+    }
+    wssSendRestartRequired(snackbar = true, fixed = false) {
+        this.matterbridge.frontend.wssSendRestartRequired(snackbar, fixed);
+    }
     getDevices() {
-        return Array.from(this._registeredEndpoints.values());
+        return Array.from(this.registeredEndpointsByUniqueId.values());
     }
     hasDeviceName(deviceName) {
-        return this._registeredEndpointsByName.has(deviceName);
+        return this.registeredEndpointsByName.has(deviceName);
     }
     async registerDevice(device) {
         device.plugin = this.name;
@@ -114,7 +124,7 @@ export class MatterbridgePlatform {
             this.log.error(`Device with uniqueId ${CYAN}${device.uniqueId}${er} has no serialNumber. The device will not be added.`);
             return;
         }
-        if (this._registeredEndpointsByName.has(device.deviceName)) {
+        if (this.registeredEndpointsByName.has(device.deviceName)) {
             this.log.error(`Device with name ${CYAN}${device.deviceName}${er} is already registered. The device will not be added. Please change the device name.`);
             return;
         }
@@ -139,20 +149,20 @@ export class MatterbridgePlatform {
             }
         }
         await this.matterbridge.addBridgedEndpoint(this.name, device);
-        this._registeredEndpoints.set(device.uniqueId, device);
-        this._registeredEndpointsByName.set(device.deviceName, device);
+        this.registeredEndpointsByUniqueId.set(device.uniqueId, device);
+        this.registeredEndpointsByName.set(device.deviceName, device);
     }
     async unregisterDevice(device) {
         await this.matterbridge.removeBridgedEndpoint(this.name, device);
         if (device.uniqueId)
-            this._registeredEndpoints.delete(device.uniqueId);
+            this.registeredEndpointsByUniqueId.delete(device.uniqueId);
         if (device.deviceName)
-            this._registeredEndpointsByName.delete(device.deviceName);
+            this.registeredEndpointsByName.delete(device.deviceName);
     }
     async unregisterAllDevices(delay = 0) {
         await this.matterbridge.removeAllBridgedEndpoints(this.name, delay);
-        this._registeredEndpoints.clear();
-        this._registeredEndpointsByName.clear();
+        this.registeredEndpointsByUniqueId.clear();
+        this.registeredEndpointsByName.clear();
     }
     async saveSelects() {
         if (this.storage) {
@@ -299,7 +309,7 @@ export class MatterbridgePlatform {
         const context = await this.storage.createStorage('endpointNumbers');
         const separator = '|.|';
         const endpointMap = new Map(await context.get('endpointMap', []));
-        for (const device of this.matterbridge.getDevices().filter((d) => d.plugin === this.name)) {
+        for (const device of this.getDevices()) {
             if (device.uniqueId === undefined || device.maybeNumber === undefined) {
                 this.log.debug(`Not checking device ${device.deviceName} without uniqueId or maybeNumber`);
                 continue;