matterbridge 3.1.4 → 3.1.5-dev-20250720-5a0b41e

package/dist/shelly.js

@@ -1,54 +1,13 @@
-/**
- * This file contains the shelly api functions.
- *
- * @file shelly.ts
- * @author Luca Liguori
- * @created 2025-02-19
- * @version 1.1.0
- * @license Apache-2.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 { debugStringify } from 'node-ansi-logger';
 import { WS_ID_SHELLY_MAIN_UPDATE, WS_ID_SHELLY_SYS_UPDATE } from './frontend.js';
 let verifyIntervalSecs = 15;
 let verifyTimeoutSecs = 600;
-/**
- * Sets the interval for verification in seconds.
- *
- * @param {number} seconds - The interval in seconds.
- * @returns {void}
- */
 export function setVerifyIntervalSecs(seconds) {
     verifyIntervalSecs = seconds;
 }
-/**
- * Sets the timeout for verification in seconds.
- *
- * @param {number} seconds - The timeout in seconds.
- * @returns {void}
- */
 export function setVerifyTimeoutSecs(seconds) {
     verifyTimeoutSecs = seconds;
 }
-/**
- * Fetches Shelly system updates. If available: logs the result, sends a snackbar message, and broadcasts the message.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
- */
 export async function getShellySysUpdate(matterbridge) {
     try {
         const updates = (await getShelly('/api/updates/sys/check'));
@@ -67,33 +26,19 @@ export async function getShellySysUpdate(matterbridge) {
         matterbridge.log.error(`Error getting Shelly system updates: ${err instanceof Error ? err.message : String(err)}`);
     }
 }
-/**
- * Triggers Shelly system updates.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
- */
 export async function triggerShellySysUpdate(matterbridge) {
     try {
-        // Trigger the update request
         await getShelly('/api/updates/sys/perform');
         matterbridge.log.notice('Installing Shelly system update...');
         matterbridge.matterbridgeInformation.shellySysUpdate = false;
         matterbridge.frontend.wssSendSnackbarMessage('Installing Shelly system update...', 15);
         matterbridge.frontend.wssBroadcastMessage(WS_ID_SHELLY_SYS_UPDATE, 'shelly-sys-update', { available: false });
-        // Begin polling update status
         await verifyShellyUpdate(matterbridge, '/api/updates/sys/status', 'Shelly system update');
     }
     catch (err) {
         matterbridge.log.error(`Error triggering Shelly system update: ${err instanceof Error ? err.message : String(err)}`);
     }
 }
-/**
- * Fetches Shelly main updates. If available: logs the result, sends a snackbar message, and broadcasts the message.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
- */
 export async function getShellyMainUpdate(matterbridge) {
     try {
         const updates = (await getShelly('/api/updates/main/check'));
@@ -112,35 +57,19 @@ export async function getShellyMainUpdate(matterbridge) {
         matterbridge.log.error(`Error getting Shelly main updates: ${err instanceof Error ? err.message : String(err)}`);
     }
 }
-/**
- * Triggers Shelly main updates.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
- */
 export async function triggerShellyMainUpdate(matterbridge) {
     try {
-        // Trigger the perform-update request
         await getShelly('/api/updates/main/perform');
         matterbridge.log.notice('Installing Shelly software update...');
         matterbridge.matterbridgeInformation.shellyMainUpdate = false;
         matterbridge.frontend.wssSendSnackbarMessage('Installing Shelly software update...', 15);
         matterbridge.frontend.wssBroadcastMessage(WS_ID_SHELLY_MAIN_UPDATE, 'shelly-main-update', { available: false });
-        // Begin polling the update status
         await verifyShellyUpdate(matterbridge, '/api/updates/main/status', 'Shelly software update');
     }
     catch (err) {
         matterbridge.log.error(`Error triggering Shelly main update: ${err instanceof Error ? err.message : String(err)}`);
     }
 }
-/**
- * Verifies Shelly update.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @param {string} api - The api to call: /api/updates/sys/status or /api/updates/main/status
- * @param {string} name - The name of the update.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
- */
 export async function verifyShellyUpdate(matterbridge, api, name) {
     return new Promise((resolve) => {
         const timeout = setTimeout(() => {
@@ -148,9 +77,9 @@ export async function verifyShellyUpdate(matterbridge, api, name) {
             matterbridge.frontend.wssSendCloseSnackbarMessage(`${name} in progress...`);
             clearInterval(interval);
             resolve();
-        }, verifyTimeoutSecs * 1000); // 10 minutes
+        }, verifyTimeoutSecs * 1000);
         const interval = setInterval(() => {
-            getShelly(api, 10 * 1000) // 10 seconds
+            getShelly(api, 10 * 1000)
                 .then(async (data) => {
                 if (data.updatingInProgress) {
                     matterbridge.log.debug(`${name} in progress...`);
@@ -173,21 +102,9 @@ export async function verifyShellyUpdate(matterbridge, api, name) {
                 clearTimeout(timeout);
                 resolve();
             });
-        }, verifyIntervalSecs * 1000); // 15 seconds
+        }, verifyIntervalSecs * 1000);
     });
 }
-/**
- * Triggers Shelly change network configuration.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @param {object} config - The network configuration.
- * @param {string} config.type - The type of network configuration, either 'static' or 'dhcp'.
- * @param {string} config.ip - The IP address to set (required for static configuration).
- * @param {string} config.subnet - The subnet mask to set (required for static configuration).
- * @param {string} config.gateway - The gateway to set (required for static configuration).
- * @param {string} config.dns - The DNS server to set (required for static configuration).
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
- */
 export async function triggerShellyChangeIp(matterbridge, config) {
     const api = config.type === 'static' ? '/api/network/connection/static' : '/api/network/connection/dynamic';
     const data = { interface: 'end0' };
@@ -210,12 +127,6 @@ export async function triggerShellyChangeIp(matterbridge, config) {
         matterbridge.frontend.wssSendSnackbarMessage('Error changing Shelly network configuration', 10, 'error');
     }
 }
-/**
- * Triggers Shelly system reboot.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
- */
 export async function triggerShellyReboot(matterbridge) {
     matterbridge.log.debug(`Triggering Shelly system reboot`);
     try {
@@ -233,13 +144,6 @@ export async function triggerShellyReboot(matterbridge) {
         matterbridge.frontend.wssSendSnackbarMessage('Error rebooting Shelly board', 10, 'error');
     }
 }
-/**
- * Triggers Shelly soft reset.
- * It will replaces network config with the default one (edn0 on dhcp).
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
- */
 export async function triggerShellySoftReset(matterbridge) {
     matterbridge.log.debug(`Triggering Shelly soft reset`);
     try {
@@ -257,13 +161,6 @@ export async function triggerShellySoftReset(matterbridge) {
         matterbridge.frontend.wssSendSnackbarMessage('Error resetting the network parameters on Shelly board', 10, 'error');
     }
 }
-/**
- * Triggers Shelly hard reset.
- * It will do a hard reset and will remove both directories .matterbridge Matterbridge.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
- */
 export async function triggerShellyHardReset(matterbridge) {
     matterbridge.log.debug(`Triggering Shelly hard reset`);
     try {
@@ -281,12 +178,6 @@ export async function triggerShellyHardReset(matterbridge) {
         matterbridge.frontend.wssSendSnackbarMessage('Error while factory resetting the Shelly board', 10, 'error');
     }
 }
-/**
- * Fetches Shelly system log and write it to shelly.log.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<boolean>}  A promise that resolves to true if the log was successfully downloaded, false otherwise.
- */
 export async function createShellySystemLog(matterbridge) {
     const { promises: fs } = await import('node:fs');
     const path = await import('node:path');
@@ -303,28 +194,6 @@ export async function createShellySystemLog(matterbridge) {
         return false;
     }
 }
-/**
- * Perform a GET to Shelly board apis.
- *
- * @param {string} api - The api to call:
- *
- *      /api/updates/sys/check => [{name:string; ...}]
- *      /api/updates/sys/perform => {"updatingInProgress":true} or {"updatingInProgress":false}
- *      /api/updates/sys/status => {"updatingInProgress":true} or {"updatingInProgress":false}
- *      /api/updates/main/check => [{name:string; ...}]
- *      /api/updates/main/perform => {"updatingInProgress":true} or {"updatingInProgress":false}
- *      /api/updates/main/status  => {"updatingInProgress":true} or {"updatingInProgress":false}
- *
- *      /api/logs/system => text
- *
- *      /api/reset/soft => "ok"                 Replaces network config with default one (edn0 on dhcp)
- *      /api/reset/hard => reboot on success    Hard reset makes soft reset + removing both directories .matterbridge Matterbridge + reboot
- *
- *
- * @param {number} [timeout] - The timeout duration in milliseconds (default is 60000ms).
- * @returns {Promise<any>} A promise that resolves to the response.
- * @throws {Error} If the request fails.
- */
 export async function getShelly(api, timeout = 60000) {
     const http = await import('node:http');
     return new Promise((resolve, reject) => {
@@ -338,13 +207,12 @@ export async function getShelly(api, timeout = 60000) {
             let data = '';
             if (res.statusCode !== 200) {
                 clearTimeout(timeoutId);
-                res.resume(); // Discard response data to close the socket properly
-                req.destroy(); // Forcefully close the request
+                res.resume();
+                req.destroy();
                 reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
                 return;
             }
             res.on('data', (chunk) => {
-                // console.log(chunk);
                 data += chunk;
             });
             res.on('end', () => {
@@ -359,7 +227,6 @@ export async function getShelly(api, timeout = 60000) {
                     }
                 }
                 else {
-                    // console.log(data);
                     resolve(data);
                 }
             });
@@ -370,31 +237,6 @@ export async function getShelly(api, timeout = 60000) {
         });
     });
 }
-/**
- * Perform a POST request to Shelly board apis.
- *
- * @param {string} api - The api to call:
- *
- *     Set static ip
- *     /api/network/connection/static -d '{"interface": "end0", "addr": "10.11.12.101", "mask": "255.255.255.0", "gw": "10.11.12.1", "dns": "1.1.1.1"}' => {}
- *
- *     Set dhcp
- *     /api/network/connection/dynamic -d '{"interface": "end0"}' => {}
- *
- *     Reboot
- *     /api/system/reboot => {"success":true}
- *
- *     curl -H "Content-Type: application/json" -X POST http://127.0.0.1:8101/api/network/connection/dynamic
- *        -d '{"interface": "end0"}'
- *
- *     curl -H "Content-Type: application/json" -X POST http://127.0.0.1:8101/api/network/connection/static
- *        -d '{"interface": "end0", "addr": "192.168.1.64", "mask": "255.255.255.0", "gw": "192.168.1.1", "dns": "192.168.1.1"}'
- *
- * @param {any} data - The data to send in the POST request, typically a JSON object.
- * @param {number} [timeout] - The timeout duration in milliseconds (default is 60000ms).
- * @returns {Promise<any>} A promise that resolves to the response.
- * @throws {Error} If the request fails.
- */
 export async function postShelly(api, data, timeout = 60000) {
     const http = await import('node:http');
     return new Promise((resolve, reject) => {
@@ -415,11 +257,10 @@ export async function postShelly(api, data, timeout = 60000) {
         };
         const req = http.request(url, options, (res) => {
             let responseData = '';
-            // Check for non-success status codes (e.g., 300+)
             if (res.statusCode && res.statusCode >= 300) {
                 clearTimeout(timeoutId);
-                res.resume(); // Discard response data to free up memory
-                req.destroy(); // Close the request
+                res.resume();
+                req.destroy();
                 return reject(new Error(`Failed to post data. Status code: ${res.statusCode}`));
             }
             res.on('data', (chunk) => {
@@ -440,9 +281,7 @@ export async function postShelly(api, data, timeout = 60000) {
             clearTimeout(timeoutId);
             reject(new Error(`Request failed: ${error instanceof Error ? error.message : error}`));
         });
-        // Send the JSON data
         req.write(jsonData);
         req.end();
     });
 }
-//# sourceMappingURL=shelly.js.map

package/dist/storage/export.js

@@ -1,2 +1 @@
 export * from 'node-persist-manager';
-//# sourceMappingURL=export.js.map

package/dist/update.js

@@ -1,36 +1,5 @@
-/**
- * This file contains the check updates functions.
- *
- * @file update.ts
- * @author Luca Liguori
- * @created 2025-02-24
- * @version 1.0.0
- * @license Apache-2.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.
- */
-// AnsiLogger module
 import { db, nt, wr } from 'node-ansi-logger';
 import { plg } from './matterbridgeTypes.js';
-/**
- * Checks for updates for Matterbridge and its plugins.
- * If the 'shelly' parameter is present, also checks for Shelly updates.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the update checks are complete.
- */
 export async function checkUpdates(matterbridge) {
     const { hasParameter } = await import('./utils/commandLine.js');
     const latestVersion = getMatterbridgeLatestVersion(matterbridge);
@@ -50,13 +19,6 @@ export async function checkUpdates(matterbridge) {
     }
     await Promise.all([latestVersion, devVersion, ...pluginsVersions, ...shellyUpdates]);
 }
-/**
- * Retrieves the latest version of Matterbridge and updates the matterbridgeLatestVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest version is retrieved.
- */
 export async function getMatterbridgeLatestVersion(matterbridge) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
@@ -78,13 +40,6 @@ export async function getMatterbridgeLatestVersion(matterbridge) {
         matterbridge.log.warn(`Error getting Matterbridge latest version: ${error instanceof Error ? error.message : error}`);
     }
 }
-/**
- * Retrieves the latest dev version of Matterbridge and updates the matterbridgeDevVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest dev version is retrieved.
- */
 export async function getMatterbridgeDevVersion(matterbridge) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
@@ -106,14 +61,6 @@ export async function getMatterbridgeDevVersion(matterbridge) {
         matterbridge.log.warn(`Error getting Matterbridge latest dev version: ${error instanceof Error ? error.message : error}`);
     }
 }
-/**
- * Retrieves the latest version of a plugin and updates the plugin's latestVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @param {RegisteredPlugin} plugin - The plugin for which to retrieve the latest version.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest version is retrieved.
- */
 export async function getPluginLatestVersion(matterbridge, plugin) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
@@ -132,4 +79,3 @@ export async function getPluginLatestVersion(matterbridge, plugin) {
         matterbridge.log.warn(`Error getting plugin ${plg}${plugin.name}${wr} latest version: ${error instanceof Error ? error.message : error}`);
     }
 }
-//# sourceMappingURL=update.js.map