matterbridge 2.2.3 → 2.2.4-dev.2

package/dist/pluginManager.js

@@ -1,26 +1,3 @@
-/**
- * This file contains the Plugins class.
- *
- * @file plugins.ts
- * @author Luca Liguori
- * @date 2024-07-14
- * @version 1.1.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. *
- */
-// AnsiLogger module
 import { AnsiLogger, UNDERLINE, UNDERLINEOFF, BLUE, db, er, nf, nt, rs, wr } from './logger/export.js';
 import { plg, typ } from './matterbridgeTypes.js';
 export class PluginManager {
@@ -30,9 +7,8 @@ export class PluginManager {
     log;
     constructor(matterbridge) {
         this.matterbridge = matterbridge;
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         this.nodeContext = matterbridge.nodeContext;
-        this.log = new AnsiLogger({ logName: 'PluginManager', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: matterbridge.log.logLevel });
+        this.log = new AnsiLogger({ logName: 'PluginManager', logTimestampFormat: 4, logLevel: matterbridge.log.logLevel });
         this.log.debug('Matterbridge plugin manager starting...');
     }
     get length() {
@@ -69,7 +45,6 @@ export class PluginManager {
             }
             catch (error) {
                 this.log.error(`Error processing forEach plugin ${plg}${plugin.name}${er}:`, error);
-                // throw error;
             }
         });
         await Promise.all(tasks);
@@ -77,31 +52,13 @@ export class PluginManager {
     set logLevel(logLevel) {
         this.log.logLevel = logLevel;
     }
-    /**
-     * Loads registered plugins from storage.
-     *
-     * This method retrieves an array of registered plugins from the storage and converts it
-     * into a map where the plugin names are the keys and the plugin objects are the values.
-     *
-     * @returns {Promise<RegisteredPlugin[]>} A promise that resolves to an array of registered plugins.
-     */
     async loadFromStorage() {
-        // Load the array from storage and convert it to a map
         const pluginsArray = await this.nodeContext.get('plugins', []);
         for (const plugin of pluginsArray)
             this._plugins.set(plugin.name, plugin);
         return pluginsArray;
     }
-    /**
-     * Loads registered plugins from storage.
-     *
-     * This method retrieves an array of registered plugins from the storage and converts it
-     * into a map where the plugin names are the keys and the plugin objects are the values.
-     *
-     * @returns {Promise<RegisteredPlugin[]>} A promise that resolves to an array of registered plugins.
-     */
     async saveToStorage() {
-        // Convert the map to an array
         const plugins = [];
         const pluginArrayFromMap = Array.from(this._plugins.values());
         for (const plugin of pluginArrayFromMap) {
@@ -121,20 +78,13 @@ export class PluginManager {
         this.log.debug(`Saved ${BLUE}${plugins.length}${db} plugins to storage`);
         return plugins.length;
     }
-    /**
-     * Resolves the name of a plugin by loading and parsing its package.json file.
-     * @param pluginPath - The path to the plugin or the path to the plugin's package.json file.
-     * @returns The path to the resolved package.json file, or null if the package.json file is not found or does not contain a name.
-     */
     async resolve(pluginPath) {
         const { default: path } = await import('node:path');
         const { promises } = await import('node:fs');
         if (!pluginPath.endsWith('package.json'))
             pluginPath = path.join(pluginPath, 'package.json');
-        // Resolve the package.json of the plugin
         let packageJsonPath = path.resolve(pluginPath);
         this.log.debug(`Resolving plugin path ${plg}${packageJsonPath}${db}`);
-        // Check if the package.json file exists
         try {
             await promises.access(packageJsonPath);
         }
@@ -144,13 +94,11 @@ export class PluginManager {
             this.log.debug(`Trying at ${plg}${packageJsonPath}${db}`);
         }
         try {
-            // Load the package.json of the plugin
             const packageJson = JSON.parse(await promises.readFile(packageJsonPath, 'utf8'));
             if (!packageJson.name) {
                 this.log.error(`Package.json name not found at ${packageJsonPath}`);
                 return null;
             }
-            // Check for main issues
             if (!packageJson.type || packageJson.type !== 'module') {
                 this.log.error(`Plugin at ${packageJsonPath} is not a module`);
                 return null;
@@ -159,7 +107,6 @@ export class PluginManager {
                 this.log.error(`Plugin at ${packageJsonPath} has no main entrypoint in package.json`);
                 return null;
             }
-            // Check for @project-chip and @matter packages in dependencies and devDependencies
             const checkForProjectChipPackages = (dependencies) => {
                 return Object.keys(dependencies).filter((pkg) => pkg.startsWith('@project-chip') || pkg.startsWith('@matter'));
             };
@@ -181,7 +128,6 @@ export class PluginManager {
                 this.log.error(`Please open an issue on the plugin repository to remove them.`);
                 return null;
             }
-            // Check for matterbridge package in dependencies and devDependencies
             const checkForMatterbridgePackage = (dependencies) => {
                 return Object.keys(dependencies).filter((pkg) => pkg === 'matterbridge');
             };
@@ -211,11 +157,6 @@ export class PluginManager {
             return null;
         }
     }
-    /**
-     * Loads and parse the plugin package.json and returns it.
-     * @param plugin - The plugin to load the package from.
-     * @returns A Promise that resolves to the package.json object or undefined if the package.json could not be loaded.
-     */
     async parse(plugin) {
         const { promises } = await import('node:fs');
         try {
@@ -241,7 +182,6 @@ export class PluginManager {
                 this.log.warn(`Plugin ${plg}${plugin.name}${wr} has no path`);
             if (!plugin.type)
                 this.log.warn(`Plugin ${plg}${plugin.name}${wr} has no type`);
-            // Check for @project-chip and @matter packages in dependencies and devDependencies
             const checkForProjectChipPackages = (dependencies) => {
                 return Object.keys(dependencies).filter((pkg) => pkg.startsWith('@project-chip') || pkg.startsWith('@matter'));
             };
@@ -263,7 +203,6 @@ export class PluginManager {
                 this.log.error(`Please open an issue on the plugin repository to remove them.`);
                 return null;
             }
-            // Check for matterbridge package in dependencies and devDependencies
             const checkForMatterbridgePackage = (dependencies) => {
                 return Object.keys(dependencies).filter((pkg) => pkg === 'matterbridge');
             };
@@ -285,7 +224,6 @@ export class PluginManager {
                 this.log.error(`Please open an issue on the plugin repository to remove them.`);
                 return null;
             }
-            // await this.saveToStorage(); // No need to save the plugin to storage
             return packageJson;
         }
         catch (err) {
@@ -294,16 +232,6 @@ export class PluginManager {
             return null;
         }
     }
-    /**
-     * Enables a plugin by its name or path.
-     *
-     * This method enables a plugin by setting its `enabled` property to `true` and saving the updated
-     * plugin information to storage. It first checks if the plugin is already registered in the `_plugins` map.
-     * If not, it attempts to resolve the plugin's `package.json` file to retrieve its name and enable it.
-     *
-     * @param {string} nameOrPath - The name or path of the plugin to enable.
-     * @returns {Promise<RegisteredPlugin | null>} A promise that resolves to the enabled plugin object, or null if the plugin could not be enabled.
-     */
     async enable(nameOrPath) {
         const { promises } = await import('node:fs');
         if (!nameOrPath || nameOrPath === '')
@@ -337,16 +265,6 @@ export class PluginManager {
             return null;
         }
     }
-    /**
-     * Enables a plugin by its name or path.
-     *
-     * This method enables a plugin by setting its `enabled` property to `true` and saving the updated
-     * plugin information to storage. It first checks if the plugin is already registered in the `_plugins` map.
-     * If not, it attempts to resolve the plugin's `package.json` file to retrieve its name and enable it.
-     *
-     * @param {string} nameOrPath - The name or path of the plugin to enable.
-     * @returns {Promise<RegisteredPlugin | null>} A promise that resolves to the enabled plugin object, or null if the plugin could not be enabled.
-     */
     async disable(nameOrPath) {
         const { promises } = await import('node:fs');
         if (!nameOrPath || nameOrPath === '')
@@ -380,16 +298,6 @@ export class PluginManager {
             return null;
         }
     }
-    /**
-     * Removes a plugin by its name or path.
-     *
-     * This method removes a plugin from the `_plugins` map and saves the updated plugin information to storage.
-     * It first checks if the plugin is already registered in the `_plugins` map. If not, it attempts to resolve
-     * the plugin's `package.json` file to retrieve its name and remove it.
-     *
-     * @param {string} nameOrPath - The name or path of the plugin to remove.
-     * @returns {Promise<RegisteredPlugin | null>} A promise that resolves to the removed plugin object, or null if the plugin could not be removed.
-     */
     async remove(nameOrPath) {
         const { promises } = await import('node:fs');
         if (!nameOrPath || nameOrPath === '')
@@ -423,17 +331,6 @@ export class PluginManager {
             return null;
         }
     }
-    /**
-     * Adds a plugin by its name or path.
-     *
-     * This method adds a plugin to the `_plugins` map and saves the updated plugin information to storage.
-     * It first resolves the plugin's `package.json` file to retrieve its details. If the plugin is already
-     * registered, it logs an info message and returns null. Otherwise, it registers the plugin, enables it,
-     * and saves the updated plugin information to storage.
-     *
-     * @param {string} nameOrPath - The name or path of the plugin to add.
-     * @returns {Promise<RegisteredPlugin | null>} A promise that resolves to the added plugin object, or null if the plugin could not be added.
-     */
     async add(nameOrPath) {
         const { promises } = await import('node:fs');
         if (!nameOrPath || nameOrPath === '')
@@ -460,15 +357,6 @@ export class PluginManager {
             return null;
         }
     }
-    /**
-     * Installs a plugin by its name.
-     *
-     * This method first uninstalls any existing version of the plugin, then installs the plugin globally using npm.
-     * It logs the installation process and retrieves the installed version of the plugin.
-     *
-     * @param {string} name - The name of the plugin to install.
-     * @returns {Promise<string | undefined>} A promise that resolves to the installed version of the plugin, or undefined if the installation failed.
-     */
     async install(name) {
         const { exec } = await import('node:child_process');
         await this.uninstall(name);
@@ -483,14 +371,11 @@ export class PluginManager {
                 else {
                     this.log.info(`Installed plugin ${plg}${name}${nf}`);
                     this.log.debug(`Installed plugin ${plg}${name}${db}: ${stdout}`);
-                    // Get the installed version
-                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
                     exec(`npm list -g ${name} --depth=0`, (listError, listStdout, listStderr) => {
                         if (listError) {
                             this.log.error(`List error: ${listError}`);
                             resolve(undefined);
                         }
-                        // Clean the output to get only the package name and version
                         const lines = listStdout.split('\n');
                         const versionLine = lines.find((line) => line.includes(`${name}@`));
                         if (versionLine) {
@@ -506,15 +391,6 @@ export class PluginManager {
             });
         });
     }
-    /**
-     * Uninstalls a plugin by its name.
-     *
-     * This method uninstalls a globally installed plugin using npm. It logs the uninstallation process
-     * and returns the name of the uninstalled plugin if successful, or undefined if the uninstallation failed.
-     *
-     * @param {string} name - The name of the plugin to uninstall.
-     * @returns {Promise<string | undefined>} A promise that resolves to the name of the uninstalled plugin, or undefined if the uninstallation failed.
-     */
     async uninstall(name) {
         const { exec } = await import('node:child_process');
         this.log.info(`Uninstalling plugin ${plg}${name}${nf}`);
@@ -533,14 +409,6 @@ export class PluginManager {
             });
         });
     }
-    /**
-     * Loads a plugin and returns the corresponding MatterbridgePlatform instance.
-     * @param plugin - The plugin to load.
-     * @param start - Optional flag indicating whether to start the plugin after loading. Default is false.
-     * @param message - Optional message to pass to the plugin when starting.
-     * @returns A Promise that resolves to the loaded MatterbridgePlatform instance.
-     * @throws An error if the plugin is not enabled, already loaded, or fails to load.
-     */
     async load(plugin, start = false, message = '', configure = false) {
         const { promises } = await import('node:fs');
         const { default: path } = await import('node:path');
@@ -554,20 +422,15 @@ export class PluginManager {
         }
         this.log.info(`Loading plugin ${plg}${plugin.name}${nf} type ${typ}${plugin.type}${nf}`);
         try {
-            // Load the package.json of the plugin
             const packageJson = JSON.parse(await promises.readFile(plugin.path, 'utf8'));
-            // Resolve the main module path relative to package.json
             const pluginEntry = path.resolve(path.dirname(plugin.path), packageJson.main);
-            // Dynamically import the plugin
             const { pathToFileURL } = await import('node:url');
             const pluginUrl = pathToFileURL(pluginEntry);
             this.log.debug(`Importing plugin ${plg}${plugin.name}${db} from ${pluginUrl.href}`);
             const pluginInstance = await import(pluginUrl.href);
             this.log.debug(`Imported plugin ${plg}${plugin.name}${db} from ${pluginUrl.href}`);
-            // Call the default export function of the plugin, passing this MatterBridge instance, the log and the config
             if (pluginInstance.default) {
                 const config = await this.loadConfig(plugin);
-                // Preset the plugin properties here in case the plugin throws an error during loading. In this case the user can change the config and restart the plugin.
                 plugin.name = packageJson.name;
                 plugin.description = packageJson.description ?? 'No description';
                 plugin.version = packageJson.version;
@@ -576,7 +439,7 @@ export class PluginManager {
                 plugin.schemaJson = await this.loadSchema(plugin);
                 config.name = plugin.name;
                 config.version = packageJson.version;
-                const log = new AnsiLogger({ logName: plugin.description ?? 'No description', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: config.debug ? "debug" /* LogLevel.DEBUG */ : this.matterbridge.log.logLevel });
+                const log = new AnsiLogger({ logName: plugin.description ?? 'No description', logTimestampFormat: 4, logLevel: config.debug ? "debug" : this.matterbridge.log.logLevel });
                 const platform = pluginInstance.default(this.matterbridge, log, config);
                 config.type = platform.type;
                 platform.name = packageJson.name;
@@ -591,9 +454,7 @@ export class PluginManager {
                 plugin.loaded = true;
                 plugin.registeredDevices = 0;
                 plugin.addedDevices = 0;
-                // plugin.configJson = config;
-                // plugin.schemaJson = await this.loadSchema(plugin);
-                await this.saveToStorage(); // Save the plugin to storage
+                await this.saveToStorage();
                 this.log.notice(`Loaded plugin ${plg}${plugin.name}${nt} type ${typ}${platform.type}${nt} (entrypoint ${UNDERLINE}${pluginEntry}${UNDERLINEOFF})`);
                 if (start)
                     await this.start(plugin, message, false);
@@ -612,14 +473,6 @@ export class PluginManager {
         }
         return undefined;
     }
-    /**
-     * Starts a plugin.
-     *
-     * @param {RegisteredPlugin} plugin - The plugin to start.
-     * @param {string} [message] - Optional message to pass to the plugin's onStart method.
-     * @param {boolean} [configure] - Indicates whether to configure the plugin after starting (default false).
-     * @returns {Promise<RegisteredPlugin | undefined>} A promise that resolves when the plugin is started successfully, or rejects with an error if starting the plugin fails.
-     */
     async start(plugin, message, configure = false) {
         if (!plugin.loaded) {
             this.log.error(`Plugin ${plg}${plugin.name}${er} not loaded`);
@@ -649,12 +502,6 @@ export class PluginManager {
         }
         return undefined;
     }
-    /**
-     * Configures a plugin.
-     *
-     * @param {RegisteredPlugin} plugin - The plugin to configure.
-     * @returns {Promise<void>} A promise that resolves when the plugin is configured successfully, or rejects with an error if configuration fails.
-     */
     async configure(plugin) {
         if (!plugin.loaded) {
             this.log.error(`Plugin ${plg}${plugin.name}${er} not loaded`);
@@ -685,18 +532,6 @@ export class PluginManager {
         }
         return undefined;
     }
-    /**
-     * Shuts down a plugin.
-     *
-     * This method shuts down a plugin by calling its `onShutdown` method and resetting its state.
-     * It logs the shutdown process and optionally removes all devices associated with the plugin.
-     *
-     * @param {RegisteredPlugin} plugin - The plugin to shut down.
-     * @param {string} [reason] - The reason for shutting down the plugin.
-     * @param {boolean} [removeAllDevices=false] - Whether to remove all devices associated with the plugin.
-     * @param {boolean} [force=false] - Whether to force the shutdown even if the plugin is not loaded or started.
-     * @returns {Promise<RegisteredPlugin | undefined>} A promise that resolves to the shut down plugin object, or undefined if the shutdown failed.
-     */
     async shutdown(plugin, reason, removeAllDevices = false, force = false) {
         this.log.debug(`Shutting down plugin ${plg}${plugin.name}${db}`);
         if (!plugin.loaded) {
@@ -739,15 +574,6 @@ export class PluginManager {
         }
         return undefined;
     }
-    /**
-     * 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 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.
-     */
     async loadConfig(plugin) {
         const { default: path } = await import('node:path');
         const { promises } = await import('node:fs');
@@ -758,8 +584,6 @@ export class PluginManager {
             const data = await promises.readFile(configFile, 'utf8');
             const config = JSON.parse(data);
             this.log.debug(`Loaded config file ${configFile} for plugin ${plg}${plugin.name}${db}.`);
-            // this.log.debug(`Loaded config file ${configFile} for plugin ${plg}${plugin.name}${db}.\nConfig:${rs}\n`, config);
-            // The first time a plugin is added to the system, the config file is created with the plugin name and type "AnyPlatform".
             config.name = plugin.name;
             config.type = plugin.type;
             if (config.debug === undefined)
@@ -783,7 +607,6 @@ export class PluginManager {
                 try {
                     await promises.writeFile(configFile, JSON.stringify(config, null, 2), 'utf8');
                     this.log.debug(`Created config file ${configFile} for plugin ${plg}${plugin.name}${db}.`);
-                    // this.log.debug(`Created config file ${configFile} for plugin ${plg}${plugin.name}${db}.\nConfig:${rs}\n`, config);
                     return config;
                 }
                 catch (err) {
@@ -797,18 +620,6 @@ export class PluginManager {
             }
         }
     }
-    /**
-     * Saves the configuration of a plugin to a file.
-     *
-     * This method saves the configuration of the specified plugin to a JSON file in the matterbridge directory.
-     * If the plugin's configuration is not found, it logs an error and rejects the promise. If the configuration
-     * is successfully saved, it logs a debug message. If an error occurs during the file write operation, it logs
-     * the error and rejects the promise.
-     *
-     * @param {RegisteredPlugin} plugin - The plugin whose configuration is to be saved.
-     * @returns {Promise<void>} A promise that resolves when the configuration is successfully saved, or rejects if an error occurs.
-     * @throws {Error} If the plugin's configuration is not found.
-     */
     async saveConfigFromPlugin(plugin) {
         const { default: path } = await import('node:path');
         const { promises } = await import('node:fs');
@@ -821,7 +632,6 @@ export class PluginManager {
             await promises.writeFile(configFile, JSON.stringify(plugin.platform.config, null, 2), 'utf8');
             plugin.configJson = plugin.platform.config;
             this.log.debug(`Saved config file ${configFile} for plugin ${plg}${plugin.name}${db}`);
-            // this.log.debug(`Saved config file ${configFile} for plugin ${plg}${plugin.name}${db}.\nConfig:${rs}\n`, plugin.platform.config);
             return Promise.resolve();
         }
         catch (err) {
@@ -829,19 +639,6 @@ export class PluginManager {
             return Promise.reject(err);
         }
     }
-    /**
-     * Saves the configuration of a plugin from a JSON object to a file.
-     *
-     * This method saves the provided configuration of the specified plugin to a JSON file in the matterbridge directory.
-     * It first checks if the configuration data is valid by ensuring it contains the correct name and type, and matches
-     * the plugin's name. If the configuration data is invalid, it logs an error and returns. If the configuration is
-     * successfully saved, it updates the plugin's `configJson` property and logs a debug message. If an error occurs
-     * during the file write operation, it logs the error and returns.
-     *
-     * @param {RegisteredPlugin} plugin - The plugin whose configuration is to be saved.
-     * @param {PlatformConfig} config - The configuration data to be saved.
-     * @returns {Promise<void>} A promise that resolves when the configuration is successfully saved, or returns if an error occurs.
-     */
     async saveConfigFromJson(plugin, config) {
         const { default: path } = await import('node:path');
         const { promises } = await import('node:fs');
@@ -856,23 +653,12 @@ export class PluginManager {
             if (plugin.platform)
                 plugin.platform.config = config;
             this.log.debug(`Saved config file ${configFile} for plugin ${plg}${plugin.name}${db}`);
-            // this.log.debug(`Saved config file ${configFile} for plugin ${plg}${plugin.name}${db}.\nConfig:${rs}\n`, config);
         }
         catch (err) {
             this.log.error(`Error saving config file ${configFile} for plugin ${plg}${plugin.name}${er}: ${err}`);
             return;
         }
     }
-    /**
-     * Loads the schema for a plugin.
-     *
-     * This method attempts to load the schema file for the specified plugin. If the schema file is found,
-     * it reads and parses the file, updates the schema's title and description, and logs the process.
-     * If the schema file is not found, it logs the event and loads a default schema for the plugin.
-     *
-     * @param {RegisteredPlugin} plugin - The plugin whose schema is to be loaded.
-     * @returns {Promise<PlatformSchema>} A promise that resolves to the loaded schema object, or the default schema if the schema file is not found.
-     */
     async loadSchema(plugin) {
         const { promises } = await import('node:fs');
         const schemaFile = plugin.path.replace('package.json', `${plugin.name}.schema.json`);
@@ -883,7 +669,6 @@ export class PluginManager {
             schema.title = plugin.description;
             schema.description = plugin.name + ' v. ' + plugin.version + ' by ' + plugin.author;
             this.log.debug(`Loaded schema file ${schemaFile} for plugin ${plg}${plugin.name}${db}.`);
-            // this.log.debug(`Loaded schema file ${schemaFile} for plugin ${plg}${plugin.name}${db}.\nSchema:${rs}\n`, schema);
             return schema;
         }
         catch (error) {
@@ -891,16 +676,6 @@ export class PluginManager {
             return this.getDefaultSchema(plugin);
         }
     }
-    /**
-     * Returns the default schema for a plugin.
-     *
-     * This method generates a default schema object for the specified plugin. The schema includes
-     * metadata such as the plugin's title, description, version, and author. It also defines the
-     * properties of the schema, including the plugin's name, type, debug flag, and unregisterOnShutdown flag.
-     *
-     * @param {RegisteredPlugin} plugin - The plugin for which the default schema is to be generated.
-     * @returns {PlatformSchema} The default schema object for the plugin.
-     */
     getDefaultSchema(plugin) {
         return {
             title: plugin.description,
@@ -931,4 +706,3 @@ export class PluginManager {
         };
     }
 }
-//# sourceMappingURL=pluginManager.js.map