matterbridge 3.0.0 → 3.0.1-dev-20250501-4f463f9

package/dist/utils/copyDirectory.js

@@ -1,54 +1,19 @@
-/**
- * This file contains the copyDirectory function.
- *
- * @file copyDirectory.ts
- * @author Luca Liguori
- * @date 2025-02-16
- * @version 1.0.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 '../logger/export.js';
-/**
- * Copies a directory and all its subdirectories and files to a new location.
- *
- * @param {string} srcDir - The path to the source directory.
- * @param {string} destDir - The path to the destination directory.
- * @returns {Promise<boolean>} - A promise that resolves when the copy operation is complete or fails for error.
- * @throws {Error} - Throws an error if the copy operation fails.
- */
 export async function copyDirectory(srcDir, destDir) {
-    const log = new AnsiLogger({ logName: 'Archive', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
+    const log = new AnsiLogger({ logName: 'Archive', logTimestampFormat: 4, logLevel: "info" });
     const fs = await import('node:fs').then((mod) => mod.promises);
     const path = await import('node:path');
     log.debug(`copyDirectory: copying directory from ${srcDir} to ${destDir}`);
     try {
-        // Create destination directory if it doesn't exist
         await fs.mkdir(destDir, { recursive: true });
-        // Read contents of the source directory
         const entries = await fs.readdir(srcDir, { withFileTypes: true });
         for (const entry of entries) {
             const srcPath = path.join(srcDir, entry.name);
             const destPath = path.join(destDir, entry.name);
             if (entry.isDirectory()) {
-                // Recursive call if entry is a directory
                 await copyDirectory(srcPath, destPath);
             }
             else if (entry.isFile()) {
-                // Copy file if entry is a file
                 await fs.copyFile(srcPath, destPath);
             }
         }
@@ -59,4 +24,3 @@ export async function copyDirectory(srcDir, destDir) {
         return false;
     }
 }
-//# sourceMappingURL=copyDirectory.js.map

package/dist/utils/createZip.js

@@ -1,43 +1,6 @@
-/**
- * This file contains the createZip function.
- *
- * @file createZip.ts
- * @author Luca Liguori
- * @date 2025-02-16
- * @version 1.0.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 '../logger/export.js';
-/**
- * Creates a ZIP archive from the specified source pattern or directory and writes it to the specified output path.
- *
- * @param {string} outputPath - The path where the output ZIP file will be written.
- * @param {string[]} sourcePaths - The source pattern or directory to be zipped (use path.join for sourcePath).
- * @returns {Promise<number>} - A promise that resolves to the total number of bytes written to the ZIP file.
- *
- * @remarks
- * This function uses the `archiver` library to create a ZIP archive. It sets the compression level to 9 (maximum compression).
- * The function ensures that the output file is properly closed after the archiving process is complete.
- * It logs the progress and the total number of bytes written to the console.
- *
- * This function uses the `glob` library to match files based on the source pattern (internally converted in posix).
- */
 export async function createZip(outputPath, ...sourcePaths) {
-    const log = new AnsiLogger({ logName: 'Archive', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
+    const log = new AnsiLogger({ logName: 'Archive', logTimestampFormat: 4, logLevel: "info" });
     const { default: archiver } = await import('archiver');
     const { glob } = await import('glob');
     const { createWriteStream, statSync } = await import('node:fs');
@@ -46,7 +9,7 @@ export async function createZip(outputPath, ...sourcePaths) {
     return new Promise((resolve, reject) => {
         const output = createWriteStream(outputPath);
         const archive = archiver('zip', {
-            zlib: { level: 9 }, // Set compression level
+            zlib: { level: 9 },
         });
         output.on('close', () => {
             log.debug(`archive ${outputPath} closed with ${archive.pointer()} total bytes`);
@@ -73,7 +36,6 @@ export async function createZip(outputPath, ...sourcePaths) {
         });
         archive.pipe(output);
         for (const sourcePath of sourcePaths) {
-            // Check if the sourcePath is a file or directory
             let stats;
             try {
                 stats = statSync(sourcePath);
@@ -101,9 +63,7 @@ export async function createZip(outputPath, ...sourcePaths) {
                 archive.directory(sourcePath, path.basename(sourcePath));
             }
         }
-        // Finalize the archive (i.e., we are done appending files but streams have to finish yet)
         log.debug(`finalizing archive ${outputPath}...`);
         archive.finalize().catch(reject);
     });
 }
-//# sourceMappingURL=createZip.js.map

package/dist/utils/deepCopy.js

@@ -1,67 +1,28 @@
-/**
- * This file contains the deepCopy function.
- *
- * @file deepCopy.ts
- * @author Luca Liguori
- * @date 2025-02-16
- * @version 1.0.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. *
- */
-/**
- * Creates a deep copy of the given value.
- *
- * @template T - The type of the value being copied.
- * @param {T} value - The value to be copied.
- * @returns {T} - The deep copy of the value.
- */
 export function deepCopy(value) {
     if (typeof value !== 'object' || value === null) {
-        // Primitive value (string, number, boolean, bigint, undefined, symbol) or null
         return value;
     }
     else if (Array.isArray(value)) {
-        // Array: Recursively copy each element
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         return value.map((item) => deepCopy(item));
     }
     else if (value instanceof Date) {
-        // Date objects
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         return new Date(value.getTime());
     }
     else if (value instanceof Map) {
-        // Maps
         const mapCopy = new Map();
         value.forEach((val, key) => {
             mapCopy.set(key, deepCopy(val));
         });
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         return mapCopy;
     }
     else if (value instanceof Set) {
-        // Sets
         const setCopy = new Set();
         value.forEach((item) => {
             setCopy.add(deepCopy(item));
         });
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         return setCopy;
     }
     else {
-        // Objects: Create a copy with the same prototype as the original
         const proto = Object.getPrototypeOf(value);
         const copy = Object.create(proto);
         for (const key in value) {
@@ -72,4 +33,3 @@ export function deepCopy(value) {
         return copy;
     }
 }
-//# sourceMappingURL=deepCopy.js.map

package/dist/utils/deepEqual.js

@@ -1,80 +1,21 @@
-/**
- * This file contains the deepEqual function.
- *
- * @file deepEqual.ts
- * @author Luca Liguori
- * @date 2025-02-16
- * @version 1.0.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. *
- */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/**
- * Performs a deep comparison between two values to determine if they are equivalent.
- * This comparison includes primitive types, arrays, and objects, allowing for optional
- * exclusion of specific properties from the comparison in objects.
- *
- * @param {any} a The first value to compare.
- * @param {any} b The second value to compare.
- * @param {string[]} [excludeProperties=[]] An array of property names to exclude from the comparison in objects.
- * @returns {boolean} True if the values are deeply equal, excluding any specified properties; otherwise, false.
- *
- * Note: This function utilizes recursion for deep comparison of nested structures and includes a debugging
- * mechanism that can be toggled on or off for detailed comparison logging. It is important to ensure that
- * objects do not contain circular references when enabling debug logging to avoid infinite loops.
- *
- * Example usage:
- * ```
- * const obj1 = { a: 1, b: { c: 2 } };
- * const obj2 = { a: 1, b: { c: 2 } };
- * console.log(deepEqual(obj1, obj2)); // true
- *
- * const arr1 = [1, 2, [3, 4]];
- * const arr2 = [1, 2, [3, 4]];
- * console.log(deepEqual(arr1, arr2)); // true
- *
- * const obj3 = { a: 1, b: { c: 2, d: 3 } };
- * const obj4 = { a: 1, b: { c: 2 } };
- * console.log(deepEqual(obj3, obj4, ['d'])); // true, excluding property 'd' from comparison
- * ```
- */
 export function deepEqual(a, b, excludeProperties = []) {
-    // Toggle debugging on or off easily
     const debug = false;
-    // Helper function for conditional logging
     const debugLog = (...messages) => {
         if (debug) {
-            // eslint-disable-next-line no-console
             console.log(...messages);
         }
     };
-    // If both are the same instance, return true (handles primitives and same object references)
     if (a === b) {
         return true;
     }
-    // If types are different, return false
     if (typeof a !== typeof b) {
         debugLog(`deepEqual false for typeof a: ${typeof a} typeof b: ${typeof b}`);
         return false;
     }
-    // If one of them is null (and we know they are not equal from the first check), return false
     if (a == null || b == null) {
         debugLog('deepEqual false for == null');
         return false;
     }
-    // Handle Arrays
     if (Array.isArray(a) && Array.isArray(b)) {
         if (a.length !== b.length) {
             debugLog(`deepEqual false for array a.length(${a.length}) !== b.length(${b.length})`);
@@ -90,31 +31,26 @@ export function deepEqual(a, b, excludeProperties = []) {
         }
         return true;
     }
-    // Handle Objects (and exclude null, functions, and arrays)
     if (typeof a === 'object' && typeof b === 'object') {
         const aProps = Object.getOwnPropertyNames(a).filter((prop) => !excludeProperties.includes(prop));
         const bProps = Object.getOwnPropertyNames(b).filter((prop) => !excludeProperties.includes(prop));
-        // If their property lengths are different, they're different objects
         if (aProps.length !== bProps.length) {
             debugLog(`deepEqual false for aProps.length(${aProps.length}) !== bProps.length(${bProps.length})`);
             debugLog(`- aProps.length(${aProps.length}):`, aProps);
             debugLog(`- bProps.length(${bProps.length}):`, bProps);
             return false;
         }
-        // Check each property in 'a' to see if it's in 'b' and if it's equal (deep check)
         for (const prop of aProps) {
             if (!Object.prototype.hasOwnProperty.call(b, prop)) {
                 debugLog(`deepEqual false for !b.hasOwnProperty(${prop})`);
                 return false;
             }
             if (!deepEqual(a[prop], b[prop], excludeProperties)) {
-                debugLog(`deepEqual false for !deepEqual(a[${prop}], b[${prop}])` /* , a[prop], b[prop]*/);
+                debugLog(`deepEqual false for !deepEqual(a[${prop}], b[${prop}])`);
                 return false;
             }
         }
         return true;
     }
-    // If none of the above, the objects are not equal
     return false;
 }
-//# sourceMappingURL=deepEqual.js.map

package/dist/utils/export.js

@@ -7,4 +7,3 @@ export * from './deepEqual.js';
 export * from './copyDirectory.js';
 export * from './createZip.js';
 export * from './wait.js';
-//# sourceMappingURL=export.js.map

package/dist/utils/isvalid.js

@@ -1,44 +1,7 @@
-/**
- * This file contains the deepEqual function.
- *
- * @file isvalid.ts
- * @author Luca Liguori
- * @date 2025-02-16
- * @version 1.0.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. *
- */
-/**
- * Checks if a given string is a valid IPv4 address.
- *
- * @param {string} ipv4Address - The string to be checked.
- * @returns {boolean} - Returns true if the string is a valid IPv4 address, otherwise returns false.
- */
 export function isValidIpv4Address(ipv4Address) {
     const ipv4Regex = /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;
     return ipv4Regex.test(ipv4Address);
 }
-/**
- * Checks if a value is a valid number within the specified range.
- *
- * @param {any} value - The value to be checked.
- * @param {number} min - The minimum value allowed (optional).
- * @param {number} max - The maximum value allowed (optional).
- * @returns {boolean} Returns true if the value is a valid number within the specified range, otherwise false.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isValidNumber(value, min, max) {
     if (value === undefined || value === null || typeof value !== 'number' || Number.isNaN(value))
         return false;
@@ -48,25 +11,9 @@ export function isValidNumber(value, min, max) {
         return false;
     return true;
 }
-/**
- * Checks if a value is a valid boolean.
- *
- * @param {any} value - The value to be checked.
- * @returns {boolean} `true` if the value is a valid boolean, `false` otherwise.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isValidBoolean(value) {
     return value !== undefined && value !== null && typeof value === 'boolean';
 }
-/**
- * Checks if a value is a valid string.
- *
- * @param {any} value - The value to be checked.
- * @param {number} minLength - The min string length (optional).
- * @param {number} maxLength - The max string length (optional).
- * @returns {boolean} A boolean indicating whether the value is a valid string.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isValidString(value, minLength, maxLength) {
     if (value === undefined || value === null || typeof value !== 'string')
         return false;
@@ -76,15 +23,6 @@ export function isValidString(value, minLength, maxLength) {
         return false;
     return true;
 }
-/**
- * Checks if a value is a valid object.
- *
- * @param {any} value - The value to be checked.
- * @param {number} minLength - The min number of keys (optional).
- * @param {number} maxLength - The max number of keys (optional).
- * @returns {boolean} A boolean indicating whether the value is a valid object.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isValidObject(value, minLength, maxLength) {
     if (value === undefined || value === null || typeof value !== 'object' || Array.isArray(value))
         return false;
@@ -95,15 +33,6 @@ export function isValidObject(value, minLength, maxLength) {
         return false;
     return true;
 }
-/**
- * Checks if a value is a valid array.
- *
- * @param {any} value - The value to be checked.
- * @param {number} minLength - The min number of elements (optional).
- * @param {number} maxLength - The max number of elements (optional).
- * @returns {boolean} A boolean indicating whether the value is a valid array.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isValidArray(value, minLength, maxLength) {
     if (value === undefined || value === null || !Array.isArray(value))
         return false;
@@ -113,24 +42,9 @@ export function isValidArray(value, minLength, maxLength) {
         return false;
     return true;
 }
-/**
- * Checks if the given value is null.
- *
- * @param {any} value - The value to check.
- * @returns {boolean} `true` if the value is null, `false` otherwise.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isValidNull(value) {
     return value === null;
 }
-/**
- * Checks if a value is undefined.
- *
- * @param {any} value - The value to check.
- * @returns {boolean} `true` if the value is undefined, `false` otherwise.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isValidUndefined(value) {
     return value === undefined;
 }
-//# sourceMappingURL=isvalid.js.map

package/dist/utils/network.js

@@ -1,37 +1,8 @@
-/**
- * This file contains the network function.
- *
- * @file network.ts
- * @author Luca Liguori
- * @date 2024-02-17
- * @version 1.0.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, idn, rs } from '../logger/export.js';
-/**
- * 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;
@@ -45,17 +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;
@@ -69,17 +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 IPv4 address of the selected network interface, 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;
@@ -95,13 +54,9 @@ export function getMacAddress() {
     }
     return macAddress;
 }
-/**
- * Logs the available network interfaces and their details.
- * @param {boolean} log - Whether to enable logging of network interface details.
- */
 export function logInterfaces(debug = true) {
-    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';
     const networkInterfaces = os.networkInterfaces();
     if (debug)
@@ -117,36 +72,16 @@ export function logInterfaces(debug = true) {
         }
     }
 }
-/**
- * Resolves the given hostname to an IP address.
- *
- * @param {string} hostname - The hostname to resolve.
- * @param {0 | 4 | 6} [family=4] - 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='latest'] - The tag of the package version to retrieve (default is 'latest').
- * @param {number} [timeout=5000] - The timeout duration in milliseconds (default is 5000ms).
- * @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('https');
     return new Promise((resolve, reject) => {
@@ -160,8 +95,8 @@ 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
-                req.destroy(); // Forcefully close the request
+                res.resume();
+                req.destroy();
                 reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
                 return;
             }
@@ -172,7 +107,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);
@@ -192,10 +126,6 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
         });
     });
 }
-/**
- * Retrieves the path to the global Node.js modules directory.
- * @returns 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) => {
@@ -209,4 +139,3 @@ export async function getGlobalNodeModules() {
         });
     });
 }
-//# sourceMappingURL=network.js.map