matterbridge 1.3.0 → 1.3.2

package/dist/matterbridge.js

@@ -4,7 +4,7 @@
  * @file matterbridge.ts
  * @author Luca Liguori
  * @date 2023-12-29
- * @version 1.2.0
+ * @version 1.3.2
  *
  * Copyright 2023, 2024 Luca Liguori.
  *
@@ -20,7 +20,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License. *
  */
-import { MatterbridgeDevice } from './matterbridgeDevice.js';
 import { NodeStorageManager } from 'node-persist-manager';
 import { AnsiLogger, BRIGHT, RESET, UNDERLINE, UNDERLINEOFF, YELLOW, db, debugStringify, stringify, er, nf, rs, wr, RED, GREEN, zb } from 'node-ansi-logger';
 import { fileURLToPath, pathToFileURL } from 'url';
@@ -32,7 +31,11 @@ import express from 'express';
 import os from 'os';
 import path from 'path';
 import WebSocket, { WebSocketServer } from 'ws';
+// Matterbridge
+import { MatterbridgeDevice } from './matterbridgeDevice.js';
+import { shelly_config, somfytahoma_config, zigbee2mqtt_config } from './defaultConfigSchema.js';
 import { BridgedDeviceBasicInformation, BridgedDeviceBasicInformationCluster } from './cluster/BridgedDeviceBasicInformationCluster.js';
+// @project-chip/matter-node.js
 import { CommissioningController, CommissioningServer, MatterServer } from '@project-chip/matter-node.js';
 import { BasicInformationCluster, ClusterServer, FixedLabelCluster, GeneralCommissioning, PowerSourceCluster, ThreadNetworkDiagnosticsCluster, getClusterNameById } from '@project-chip/matter-node.js/cluster';
 import { DeviceTypeId, VendorId } from '@project-chip/matter-node.js/datatype';
@@ -42,7 +45,7 @@ import { ManualPairingCodeCodec, QrCodeSchema } from '@project-chip/matter-node.
 import { StorageBackendDisk, StorageBackendJsonFile, StorageManager } from '@project-chip/matter-node.js/storage';
 import { requireMinNodeVersion, getParameter, getIntParameter, hasParameter } from '@project-chip/matter-node.js/util';
 import { CryptoNode } from '@project-chip/matter-node.js/crypto';
-import { shelly_config, shelly_schema, somfytahoma_config, somfytahoma_schema, zigbee2mqtt_config, zigbee2mqtt_schema } from './defaultConfigSchema.js';
+// Default colors
 const plg = '\u001B[38;5;33m';
 const dev = '\u001B[38;5;79m';
 const typ = '\u001B[38;5;207m';
@@ -112,9 +115,9 @@ export class Matterbridge extends EventEmitter {
     commissioningServer;
     commissioningController;
     static instance;
+    // We load asyncronously so is private
     constructor() {
         super();
-        // We load asyncronously
     }
     /**
      * Loads an instance of the Matterbridge class.
@@ -252,7 +255,7 @@ export class Matterbridge extends EventEmitter {
       - help:                  show the help
       - bridge:                start Matterbridge in bridge mode
       - childbridge:           start Matterbridge in childbridge mode
-      - frontend [port]:       start the frontend on the given port (default 3000)
+      - frontend [port]:       start the frontend on the given port (default 8283)
       - debug:                 enable debug mode (default false)
       - reset:                 remove the commissioning for Matterbridge (bridge mode). Shutdown Matterbridge before using it!
       - factoryreset:          remove all commissioning information and reset all internal storages. Shutdown Matterbridge before using it!
@@ -288,7 +291,7 @@ export class Matterbridge extends EventEmitter {
         this.nodeStorage = new NodeStorageManager({ dir: path.join(this.matterbridgeDirectory, 'storage'), logging: false });
         this.log.debug('Creating node storage context for matterbridge');
         this.nodeContext = await this.nodeStorage.createStorage('matterbridge');
-        // Get the plugins from node storage
+        // Get the plugins from node storage and create the plugin node storage contexts
         this.registeredPlugins = await this.nodeContext.get('plugins', []);
         for (const plugin of this.registeredPlugins) {
             this.log.debug(`Creating node storage context for plugin ${plugin.name}`);
@@ -350,7 +353,7 @@ export class Matterbridge extends EventEmitter {
      */
     async parseCommandLine() {
         if (hasParameter('list')) {
-            this.log.info('│ Registered plugins');
+            this.log.info(`│ Registered plugins (${this.registeredPlugins?.length})`);
             this.registeredPlugins.forEach((plugin, index) => {
                 if (index !== this.registeredPlugins.length - 1) {
                     this.log.info(`├─┬─ plugin ${plg}${plugin.name}${nf}: "${plg}${BRIGHT}${plugin.description}${RESET}${nf}" type: ${typ}${plugin.type}${nf} ${plugin.enabled ? GREEN : RED}enabled ${plugin.paired ? GREEN : RED}paired${nf}`);
@@ -362,7 +365,7 @@ export class Matterbridge extends EventEmitter {
                 }
             });
             const serializedRegisteredDevices = await this.nodeContext?.get('devices', []);
-            this.log.info('│ Registered devices');
+            this.log.info(`│ Registered devices (${serializedRegisteredDevices?.length})`);
             serializedRegisteredDevices?.forEach((device, index) => {
                 if (index !== serializedRegisteredDevices.length - 1) {
                     this.log.info(`├─┬─ plugin ${plg}${device.pluginName}${nf} device: ${dev}${device.deviceName}${nf} uniqueId: ${YELLOW}${device.uniqueId}${nf}`);
@@ -496,6 +499,9 @@ export class Matterbridge extends EventEmitter {
             this.log.debug('Adding matterbridge commissioning server to matter server');
             await this.matterServer.addCommissioningServer(this.commissioningServer, { uniqueStorageKey: 'Matterbridge' });
             for (const plugin of this.registeredPlugins) {
+                plugin.configJson = await this.loadPluginConfig(plugin);
+                plugin.schemaJson = await this.loadPluginSchema(plugin);
+                this.getPluginLatestVersion(plugin);
                 if (!plugin.enabled) {
                     this.log.info(`Plugin ${plg}${plugin.name}${nf} not enabled`);
                     continue;
@@ -523,6 +529,9 @@ export class Matterbridge extends EventEmitter {
             this.log.debug('Starting matterbridge in mode', this.bridgeMode);
             this.matterServer = this.createMatterServer(this.storageManager);
             for (const plugin of this.registeredPlugins) {
+                plugin.configJson = await this.loadPluginConfig(plugin);
+                plugin.schemaJson = await this.loadPluginSchema(plugin);
+                this.getPluginLatestVersion(plugin);
                 if (!plugin.enabled) {
                     this.log.info(`Plugin ${plg}${plugin.name}${nf} not enabled`);
                     continue;
@@ -550,7 +559,7 @@ export class Matterbridge extends EventEmitter {
             pluginPath = path.join(pluginPath, 'package.json');
         // Resolve the package.json of the plugin
         let packageJsonPath = path.resolve(pluginPath);
-        this.log.debug(`Loading plugin from ${plg}${packageJsonPath}${db}`);
+        this.log.debug(`Resolving plugin from ${plg}${packageJsonPath}${db}`);
         // Check if the package.json file exists
         let packageJsonExists = false;
         try {
@@ -851,7 +860,7 @@ export class Matterbridge extends EventEmitter {
                             serializedRegisteredDevices.push(serializedMatterbridgeDevice);
                     });
                     await this.nodeContext.set('devices', serializedRegisteredDevices);
-                    this.log.info('Saved registered devices');
+                    this.log.info(`Saved registered devices (${serializedRegisteredDevices?.length})`);
                     // Clear nodeContext and nodeStorage (they just need 1000ms to write the data to disk)
                     this.log.debug('Closing node storage context...');
                     this.nodeContext.close();
@@ -899,7 +908,7 @@ export class Matterbridge extends EventEmitter {
                         Matterbridge.instance = undefined;
                         this.emit('shutdown');
                     }
-                }, 2 * 1000); // From 2 to 5 seconds
+                }, 2 * 1000);
             }, 3 * 1000);
         }
     }
@@ -907,7 +916,7 @@ export class Matterbridge extends EventEmitter {
      * Adds a bridged device to the Matterbridge.
      * @param pluginName - The name of the plugin.
      * @param device - The bridged device to add.
-     * @returns {Promise<void>} - A promise that resolves when the storage process is started.
+     * @returns {Promise<void>} - A promise that resolves when the device is added.
      */
     async addBridgedDevice(pluginName, device) {
         if (this.bridgeMode === 'bridge' && !this.matterAggregator) {
@@ -1132,15 +1141,14 @@ export class Matterbridge extends EventEmitter {
     }
     /**
      * Loads the schema for a plugin.
-     * If the schema file exists, it reads the file and returns the parsed JSON data.
-     * If the schema file does not exist, it creates a new file with default configuration and returns it.
-     * If any error occurs during file access or creation, it logs an error and return an empty schema.
+     * If the schema file exists in the plugin directory, it reads the file and returns the parsed JSON data and delete the schema form .matterbridge.
+     * If the schema file does not exist, it creates a new schema with the default configuration and returns it.
      *
      * @param plugin - The plugin for which to load the schema.
      * @returns A promise that resolves to the loaded or created schema.
      */
     async loadPluginSchema(plugin) {
-        const schemaFile = path.join(this.matterbridgeDirectory, `${plugin.name}.schema.json`);
+        let schemaFile = plugin.path.replace('package.json', `${plugin.name}.schema.json`);
         try {
             await fs.access(schemaFile);
             const data = await fs.readFile(schemaFile, 'utf8');
@@ -1149,76 +1157,64 @@ export class Matterbridge extends EventEmitter {
             schema.description = plugin.name + ' v. ' + plugin.version + ' by ' + plugin.author;
             this.log.debug(`Schema file found: ${schemaFile}.`);
             // this.log.debug(`Schema file found: ${schemaFile}.\nSchema:${rs}\n`, schema);
+            schemaFile = path.join(this.matterbridgeDirectory, `${plugin.name}.schema.json`);
+            try {
+                await fs.unlink(schemaFile);
+                this.log.debug(`Schema file ${schemaFile} deleted.`);
+            }
+            catch (err) {
+                this.log.debug(`Schema file ${schemaFile} to delete not found.`);
+            }
             return schema;
         }
         catch (err) {
-            if (err instanceof Error) {
-                const nodeErr = err;
-                if (nodeErr.code === 'ENOENT') {
-                    let schema;
-                    if (plugin.name === 'matterbridge-zigbee2mqtt')
-                        schema = zigbee2mqtt_schema;
-                    else if (plugin.name === 'matterbridge-somfy-tahoma')
-                        schema = somfytahoma_schema;
-                    else if (plugin.name === 'matterbridge-shelly')
-                        schema = shelly_schema;
-                    else
-                        schema = {
-                            title: plugin.description,
-                            description: plugin.name + ' v. ' + plugin.version + ' by ' + plugin.author,
-                            type: 'object',
-                            properties: {
-                                name: {
-                                    description: 'Plugin name',
-                                    type: 'string',
-                                    readOnly: true,
-                                },
-                                type: {
-                                    description: 'Plugin type',
-                                    type: 'string',
-                                    readOnly: true,
-                                },
-                                unregisterOnShutdown: {
-                                    description: 'Unregister all devices on shutdown (development only)',
-                                    type: 'boolean',
-                                },
-                            },
-                        };
-                    try {
-                        await this.writeFile(schemaFile, JSON.stringify(schema, null, 2));
-                        this.log.debug(`Created schema file: ${schemaFile}.`);
-                        // this.log.debug(`Created schema file: ${schemaFile}.\nSchema:${rs}\n`, schema);
-                        return schema;
-                    }
-                    catch (err) {
-                        this.log.error(`Error creating schema file ${schemaFile}: ${err}`);
-                        return schema;
-                    }
-                }
-                else {
-                    this.log.error(`Error accessing schema file ${schemaFile}: ${err}`);
-                    return {};
-                }
-            }
-            this.log.error(`Error loading schema file ${schemaFile}: ${err}`);
-            return {};
+            this.log.debug(`Schema file ${schemaFile} not found. Loading default schema.`);
+            const schema = {
+                title: plugin.description,
+                description: plugin.name + ' v. ' + plugin.version + ' by ' + plugin.author,
+                type: 'object',
+                properties: {
+                    name: {
+                        description: 'Plugin name',
+                        type: 'string',
+                        readOnly: true,
+                    },
+                    type: {
+                        description: 'Plugin type',
+                        type: 'string',
+                        readOnly: true,
+                    },
+                    debug: {
+                        description: 'Enable the debug for the plugin (development only)',
+                        type: 'boolean',
+                        default: false,
+                    },
+                    unregisterOnShutdown: {
+                        description: 'Unregister all devices on shutdown (development only)',
+                        type: 'boolean',
+                        default: false,
+                    },
+                },
+            };
+            return schema;
         }
     }
     /**
      * Saves the plugin configuration to a JSON file.
      * @param plugin - The registered plugin.
      * @param config - The platform configuration.
-     * @returns A promise that resolves when the configuration is saved successfully, or rejects with an error.
+     * @returns A promise that resolves when the configuration is saved successfully, or with an error logged.
      */
     async savePluginConfigFromJson(plugin, config) {
         if (!config.name || !config.type || config.name !== plugin.name) {
-            this.log.error(`Error saving plugin ${plg}${plugin.name}${er} config`);
+            this.log.error(`Error saving plugin ${plg}${plugin.name}${er} config. Wrong config data content.`);
             return;
         }
         const configFile = path.join(this.matterbridgeDirectory, `${plugin.name}.config.json`);
         try {
             await this.writeFile(configFile, JSON.stringify(config, null, 2));
-            this.log.debug(`Saved config file: ${configFile}.\nConfig:${rs}\n`, config);
+            plugin.configJson = config;
+            this.log.debug(`Saved config file ${configFile} for plugin ${plg}${plugin.name}${db}.\nConfig:${rs}\n`, config);
         }
         catch (err) {
             this.log.error(`Error saving plugin ${plg}${plugin.name}${er} config: ${err}`);
@@ -1229,7 +1225,7 @@ export class Matterbridge extends EventEmitter {
      * Loads the configuration for a plugin.
      * If the configuration file exists, it reads the file and returns the parsed JSON data.
      * If the configuration file does not exist, it creates a new file with default configuration and returns it.
-     * If any error occurs during file access or creation, it logs an error and rejects the promise with the error.
+     * If any error occurs during file access or creation, it logs an error and return un empty config.
      *
      * @param plugin - The plugin for which to load the configuration.
      * @returns A promise that resolves to the loaded or created configuration.
@@ -1259,7 +1255,7 @@ export class Matterbridge extends EventEmitter {
                     else if (plugin.name === 'matterbridge-shelly')
                         config = shelly_config;
                     else
-                        config = { name: plugin.name, type: plugin.type, unregisterOnShutdown: false };
+                        config = { name: plugin.name, type: plugin.type, debug: false, unregisterOnShutdown: false };
                     try {
                         await this.writeFile(configFile, JSON.stringify(config, null, 2));
                         this.log.debug(`Created config file: ${configFile}.`);
@@ -1440,9 +1436,11 @@ export class Matterbridge extends EventEmitter {
                 plugin.loaded = true;
                 plugin.registeredDevices = 0;
                 plugin.addedDevices = 0;
+                plugin.configJson = config;
+                plugin.schemaJson = await this.loadPluginSchema(plugin);
                 // Save the updated plugin data in the node storage
                 await this.nodeContext?.set('plugins', await this.getBaseRegisteredPlugins());
-                this.getPluginLatestVersion(plugin);
+                // this.getPluginLatestVersion(plugin); moved to parseCommandLine
                 this.log.info(`Loaded plugin ${plg}${plugin.name}${nf} type ${typ}${platform.type} ${db}(entrypoint ${UNDERLINE}${pluginEntry}${UNDERLINEOFF})`);
                 if (start)
                     this.startPlugin(plugin, message); // No await do it asyncronously
@@ -2529,8 +2527,10 @@ export class Matterbridge extends EventEmitter {
                 registeredDevices: plugin.registeredDevices,
                 qrPairingCode: plugin.qrPairingCode,
                 manualPairingCode: plugin.manualPairingCode,
-                configJson: includeConfigSchema ? await this.loadPluginConfig(plugin) : {},
-                schemaJson: includeConfigSchema ? await this.loadPluginSchema(plugin) : {},
+                // configJson: includeConfigSchema ? await this.loadPluginConfig(plugin) : {},
+                // schemaJson: includeConfigSchema ? await this.loadPluginSchema(plugin) : {},
+                configJson: includeConfigSchema ? plugin.configJson : {},
+                schemaJson: includeConfigSchema ? plugin.schemaJson : {},
             });
         }
         return baseRegisteredPlugins;