matterbridge 3.2.9 → 3.3.0-dev-20250928-3d2b558

package/dist/utils/network.js

@@ -1,38 +1,8 @@
-/**
- * @description This file contains the network functions.
- * @file network.ts
- * @author Luca Liguori
- * @created 2024-02-17
- * @version 1.0.1
- * @license Apache-2.0
- *
- * 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.
- */
-// Node.js modules
 import os from 'node:os';
-// AnsiLogger module
 import { AnsiLogger, BLUE, CYAN, nf } from 'node-ansi-logger';
-/**
- * Retrieves the IPv4 address of the first non-internal network interface.
- *
- * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
- */
 export function getIpv4InterfaceAddress() {
     let ipv4Address;
     const networkInterfaces = os.networkInterfaces();
-    // console.log('Available Network Interfaces:', networkInterfaces);
     for (const interfaceDetails of Object.values(networkInterfaces)) {
         if (!interfaceDetails) {
             break;
@@ -46,18 +16,11 @@ export function getIpv4InterfaceAddress() {
             break;
         }
     }
-    // console.log('Selected Network Interfaces:', ipv4Address);
     return ipv4Address;
 }
-/**
- * Retrieves the IPv6 address of the first non-internal network interface.
- *
- * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
- */
 export function getIpv6InterfaceAddress() {
     let ipv6Address;
     const networkInterfaces = os.networkInterfaces();
-    // console.log('Available Network Interfaces:', networkInterfaces);
     for (const interfaceDetails of Object.values(networkInterfaces)) {
         if (!interfaceDetails) {
             break;
@@ -71,18 +34,11 @@ export function getIpv6InterfaceAddress() {
             break;
         }
     }
-    // console.log('Selected Network Interfaces:', ipv6Address);
     return ipv6Address;
 }
-/**
- * Retrieves the mac address of the first non-internal network interface.
- *
- * @returns {string | undefined} The mac address, or undefined if not found.
- */
 export function getMacAddress() {
     let macAddress;
     const networkInterfaces = os.networkInterfaces();
-    // console.log('Available Network Interfaces:', networkInterfaces);
     for (const interfaceDetails of Object.values(networkInterfaces)) {
         if (!interfaceDetails) {
             break;
@@ -98,14 +54,9 @@ export function getMacAddress() {
     }
     return macAddress;
 }
-/**
- * Logs the available network interfaces and their details.
- *
- * @returns {void}
- */
 export function logInterfaces() {
-    const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
-    log.logLevel = "info" /* LogLevel.INFO */;
+    const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4, logLevel: "info" });
+    log.logLevel = "info";
     log.logName = 'LogInterfaces';
     log.info('Available Network Interfaces:');
     const availableAddresses = Object.entries(os.networkInterfaces());
@@ -119,36 +70,16 @@ export function logInterfaces() {
         }
     }
 }
-/**
- * Resolves the given hostname to an IP address.
- *
- * @param {string} hostname - The hostname to resolve.
- * @param {0 | 4 | 6} [family] - The address family to use (0 for any, 4 for IPv4, 6 for IPv6). Default is 4.
- * @returns {Promise<string | null>} - A promise that resolves to the IP address or null if not found.
- *
- * @remarks
- * This function uses DNS lookup to resolve the hostname, which can take some time to complete.
- */
 export async function resolveHostname(hostname, family = 4) {
     const dns = await import('node:dns');
     try {
-        const addresses = await dns.promises.lookup(hostname.toLowerCase() /* + '.local'*/, { family });
+        const addresses = await dns.promises.lookup(hostname.toLowerCase(), { family });
         return addresses.address;
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
     }
     catch (error) {
         return null;
     }
 }
-/**
- * Retrieves the version of an npm package from the npm registry.
- *
- * @param {string} packageName - The name of the npm package.
- * @param {string} [tag] - The tag of the package version to retrieve (default is 'latest').
- * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
- * @returns {Promise<string>} A promise that resolves to the version string of the package.
- * @throws {Error} If the request fails or the tag is not found.
- */
 export async function getNpmPackageVersion(packageName, tag = 'latest', timeout = 10000) {
     const https = await import('node:https');
     return new Promise((resolve, reject) => {
@@ -162,7 +93,7 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
             let data = '';
             if (res.statusCode !== 200) {
                 clearTimeout(timeoutId);
-                res.resume(); // Discard response data to close the socket properly
+                res.resume();
                 reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
                 return;
             }
@@ -173,7 +104,6 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
                 clearTimeout(timeoutId);
                 try {
                     const jsonData = JSON.parse(data);
-                    // console.log(`Package ${packageName} tag ${tag}`, jsonData);
                     const version = jsonData['dist-tags']?.[tag];
                     if (version) {
                         resolve(version);
@@ -193,15 +123,6 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
         });
     });
 }
-/**
- * Retrieves a file from the public directory of the Matterbridge GitHub repository.
- *
- * @param {string} branch - The branch from which to fetch the file.
- * @param {string} file - The file path to fetch.
- * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
- * @returns {Promise<Record<string, boolean | string | number>>} A promise that resolves to the parsed JSON object from the file.
- * @throws {Error} If the request fails or the JSON parsing fails.
- */
 export async function getGitHubUpdate(branch, file, timeout = 10000) {
     const https = await import('node:https');
     return new Promise((resolve, reject) => {
@@ -215,7 +136,7 @@ export async function getGitHubUpdate(branch, file, timeout = 10000) {
             let data = '';
             if (res.statusCode !== 200) {
                 clearTimeout(timeoutId);
-                res.resume(); // Discard response data to close the socket properly
+                res.resume();
                 reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
                 return;
             }
@@ -233,18 +154,12 @@ export async function getGitHubUpdate(branch, file, timeout = 10000) {
                 }
             });
         });
-        // istanbul ignore next
         req.on('error', (error) => {
             clearTimeout(timeoutId);
             reject(new Error(`Request failed: ${error instanceof Error ? error.message : error}`));
         });
     });
 }
-/**
- * Retrieves the path to the global Node.js modules directory.
- *
- * @returns {Promise<string>} A promise that resolves to the path of the global Node.js modules directory.
- */
 export async function getGlobalNodeModules() {
     const { exec } = await import('node:child_process');
     return new Promise((resolve, reject) => {
@@ -258,4 +173,3 @@ export async function getGlobalNodeModules() {
         });
     });
 }
-//# sourceMappingURL=network.js.map

package/dist/utils/spawn.js

@@ -1,52 +1,12 @@
-/**
- * @description This file contains the spawn functions.
- * @file spawn.ts
- * @author Luca Liguori
- * @created 2025-02-16
- * @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 { hasParameter } from './commandLine.js';
-/**
- * Spawns a child process with the given command and arguments.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance to use for logging and sending messages.
- * @param {string} command - The command to execute.
- * @param {string[]} args - The arguments to pass to the command (default: []).
- * @param {string} [packageName] - The name of the package being installed (optional).
- * @returns {Promise<boolean>} A promise that resolves when the child process exits successfully, or rejects if there is an error.
- */
 export async function spawnCommand(matterbridge, command, args, packageName) {
     const { spawn } = await import('node:child_process');
-    /*
-      npm > npm.cmd on windows
-      cmd.exe ['dir'] on windows
-      await this.spawnCommand('npm', ['install', '-g', 'matterbridge']);
-      */
     const cmdLine = command + ' ' + args.join(' ');
     if (process.platform === 'win32' && command === 'npm') {
-        // Must be spawn('cmd.exe', ['/c', 'npm -g install <package>']);
         const argstring = 'npm ' + args.join(' ');
         args.splice(0, args.length, '/c', argstring);
         command = 'cmd.exe';
     }
-    // Decide when using sudo on linux and macOS
-    // When you need sudo: Spawn stderr: npm error Error: EACCES: permission denied
-    // When you don't need sudo: Failed to start child process "npm install -g matterbridge-eve-door": spawn sudo ENOENT
     if (hasParameter('sudo') || (process.platform !== 'win32' && command === 'npm' && !hasParameter('docker') && !hasParameter('nosudo'))) {
         args.unshift(command);
         command = 'sudo';
@@ -103,20 +63,6 @@ export async function spawnCommand(matterbridge, command, args, packageName) {
                     matterbridge.frontend.wssSendLogMessage('spawn', matterbridge.log.now(), 'Matterbridge:spawn', line);
                 }
             });
-            /*
-            childProcess.stdout.on('close', () => {
-              matterbridge.log.debug(`Spawn output (stdout): closed`);
-              resolve(true);
-            });
-            childProcess.stdout.on('end', () => {
-              matterbridge.log.debug(`Spawn output (stdout): ended`);
-              resolve(true);
-            });
-            childProcess.stdout.on('error', () => {
-              matterbridge.log.debug(`Spawn output (stdout): error`);
-              resolve(true);
-            });
-            */
         }
         if (childProcess.stderr) {
             childProcess.stderr.on('data', (data) => {
@@ -127,21 +73,6 @@ export async function spawnCommand(matterbridge, command, args, packageName) {
                     matterbridge.frontend.wssSendLogMessage('spawn', matterbridge.log.now(), 'Matterbridge:spawn', line);
                 }
             });
-            /*
-            childProcess.stderr.on('close', () => {
-              matterbridge.log.debug(`Spawn verbose (stderr): closed`);
-              resolve(true);
-            });
-            childProcess.stderr.on('end', () => {
-              matterbridge.log.debug(`Spawn verbose (stderr): ended`);
-              resolve(true);
-            });
-            childProcess.stderr.on('error', () => {
-              matterbridge.log.debug(`Spawn verbose (stderr): error`);
-              resolve(true);
-            });
-            */
         }
     });
 }
-//# sourceMappingURL=spawn.js.map

package/dist/utils/wait.js

@@ -1,41 +1,6 @@
-/**
- * This file contains the wait, waiter and withTimeout functions.
- *
- * @file wait.ts
- * @author Luca Liguori
- * @created 2025-02-16
- * @version 1.0.2
- * @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 { AnsiLogger } from 'node-ansi-logger';
-/**
- * Asynchronous waiter function that resolves when the provided condition is met or rejects on timeout.
- *
- * @param {string} name - The name of the waiter.
- * @param {() => boolean} check - A function that checks the condition. Should return a boolean.
- * @param {boolean} [exitWithReject] - Optional. If true, the promise will be rejected on timeout. Default is false.
- * @param {number} [resolveTimeout] - Optional. The timeout duration in milliseconds. Default is 5000ms.
- * @param {number} [resolveInterval] - Optional. The interval duration in milliseconds between condition checks. Default is 500ms.
- * @param {boolean} [debug] - Optional. If true, debug messages will be logged to the console. Default is false.
- * @returns {Promise<boolean>} A promise that resolves to true when the condition is met, or false if the timeout occurs.
- */
 export async function waiter(name, check, exitWithReject = false, resolveTimeout = 5000, resolveInterval = 500, debug = false) {
-    const log = new AnsiLogger({ logName: 'Waiter', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "debug" /* LogLevel.DEBUG */ });
+    const log = new AnsiLogger({ logName: 'Waiter', logTimestampFormat: 4, logLevel: "debug" });
     if (check()) {
         if (debug)
             log.debug(`Waiter "${name}" already true`);
@@ -66,16 +31,8 @@ export async function waiter(name, check, exitWithReject = false, resolveTimeout
         }, resolveInterval).unref();
     });
 }
-/**
- * Asynchronously waits for a specified amount of time.
- *
- * @param {number} timeout - The duration to wait in milliseconds. Default is 1000ms.
- * @param {string} name - The name of the wait operation. Default is undefined.
- * @param {boolean} debug - Whether to enable debug logging. Default is false.
- * @returns {Promise<void>} A Promise that resolves after the specified timeout.
- */
 export async function wait(timeout = 1000, name, debug = false) {
-    const log = new AnsiLogger({ logName: 'Wait', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "debug" /* LogLevel.DEBUG */ });
+    const log = new AnsiLogger({ logName: 'Wait', logTimestampFormat: 4, logLevel: "debug" });
     if (debug)
         log.debug(`Wait "${name}" started...`);
     return new Promise((resolve) => {
@@ -87,14 +44,6 @@ export async function wait(timeout = 1000, name, debug = false) {
         }, timeout).unref();
     });
 }
-/**
- * Wraps a promise with a timeout. If the promise does not resolve or reject within the specified time, it will be rejected.
- *
- * @param {Promise<T>} promise - The promise to wrap.
- * @param {number} [timeoutMillisecs] - The timeout duration in milliseconds. Default is 10000ms.
- * @param {boolean} [reThrow] - Optional. If true, the promise will rethrow the original promise and will reject on timeout. Default is true.
- * @returns {Promise<T>} A new promise that resolves or rejects based on the original promise and the timeout.
- */
 export function withTimeout(promise, timeoutMillisecs = 10000, reThrow = true) {
     return new Promise((resolve, reject) => {
         const timer = setTimeout(() => {
@@ -102,24 +51,23 @@ export function withTimeout(promise, timeoutMillisecs = 10000, reThrow = true) {
                 reject(new Error('Operation timed out'));
             }
             else {
-                resolve(undefined); // Resolve with undefined if reThrow is false
+                resolve(undefined);
             }
-        }, timeoutMillisecs).unref(); // Unref the timer to prevent it from keeping the event loop alive
+        }, timeoutMillisecs).unref();
         promise
             .then((result) => {
-            clearTimeout(timer); // Ensure timeout does not fire if promise resolves first
+            clearTimeout(timer);
             resolve(result);
             return result;
         })
             .catch((error) => {
-            clearTimeout(timer); // Ensure timeout does not fire if promise rejects first
+            clearTimeout(timer);
             if (reThrow) {
-                reject(error); // Reject with the original error
+                reject(error);
             }
             else {
-                resolve(undefined); // Resolve with undefined if reThrow is false
+                resolve(undefined);
             }
         });
     });
 }
-//# sourceMappingURL=wait.js.map