matterbridge 3.3.7 → 3.3.8-dev-20251115-920acfc

package/dist/utils/commandLine.js

@@ -1,33 +1,4 @@
-/**
- * This file contains the parameters functions.
- *
- * @file parameter.ts
- * @author Luca Liguori
- * @created 2025-02-16
- * @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.
- */
 import { isValidNumber } from './isvalid.js';
-/**
- * Checks if a command-line parameter is present.
- *
- * @param {string} name - The name of the parameter to check.
- * @returns {boolean} True if the parameter is present, otherwise false.
- */
 export function hasParameter(name) {
     const commandArguments = process.argv.slice(2);
     let markerIncluded = commandArguments.includes(`-${name}`);
@@ -35,23 +6,11 @@ export function hasParameter(name) {
         markerIncluded = commandArguments.includes(`--${name}`);
     return markerIncluded;
 }
-/**
- * Checks if any of the provided command-line parameters are present.
- *
- * @param {string[]} params - The names of the parameters to check.
- * @returns {boolean} True if any of the parameters are present, otherwise false.
- */
 export function hasAnyParameter(...params) {
     return params.some((param) => {
         return hasParameter(param);
     });
 }
-/**
- * Retrieves the value of a command-line parameter as a string.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {string | undefined} The value of the parameter, or undefined if not found.
- */
 export function getParameter(name) {
     const commandArguments = process.argv.slice(2);
     let markerIndex = commandArguments.indexOf(`-${name}`);
@@ -61,12 +20,6 @@ export function getParameter(name) {
         return undefined;
     return commandArguments[markerIndex + 1];
 }
-/**
- * Retrieves the value of a command-line parameter as an integer.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {number | undefined} The integer value of the parameter, or undefined if not found or invalid.
- */
 export function getIntParameter(name) {
     const value = getParameter(name);
     if (value === undefined)
@@ -76,12 +29,6 @@ export function getIntParameter(name) {
         return undefined;
     return intValue;
 }
-/**
- * Retrieves the value of a command-line parameter as a number array.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {number[] | undefined} An array of string values for the parameter, or undefined if not found.
- */
 export function getIntArrayParameter(name) {
     const commandArguments = process.argv.slice(2);
     let markerIndex = commandArguments.indexOf(`--${name}`);
@@ -99,12 +46,6 @@ export function getIntArrayParameter(name) {
         return undefined;
     return intValues;
 }
-/**
- * Retrieves the value of a command-line parameter as a string array.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {string[] | undefined} An array of string values for the parameter, or undefined if not found.
- */
 export function getStringArrayParameter(name) {
     const commandArguments = process.argv.slice(2);
     let markerIndex = commandArguments.indexOf(`--${name}`);
@@ -120,4 +61,3 @@ export function getStringArrayParameter(name) {
         return undefined;
     return values;
 }
-//# sourceMappingURL=commandLine.js.map

package/dist/utils/copyDirectory.js

@@ -1,36 +1,4 @@
-/**
- * This file contains the copyDirectory function.
- *
- * @file copyDirectory.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 '../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) {
     if (srcDir === '') {
         throw new Error('Source directory must be specified.');
@@ -47,24 +15,20 @@ export async function copyDirectory(srcDir, destDir) {
     if (srcDir === destDir) {
         throw new Error('Source and destination directories must be different.');
     }
-    const log = new AnsiLogger({ logName: 'CopyDirectory', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
+    const log = new AnsiLogger({ logName: 'CopyDirectory', 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);
             }
         }
@@ -75,4 +39,3 @@ export async function copyDirectory(srcDir, destDir) {
         return false;
     }
 }
-//# sourceMappingURL=copyDirectory.js.map

package/dist/utils/createDirectory.js

@@ -1,36 +1,4 @@
-/**
- * This file contains the createDirectory function.
- *
- * @file createDirectory.ts
- * @author Luca Liguori
- * @created 2025-06-08
- * @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.
- */
-// Node.js modules
 import { promises as fs } from 'node:fs';
-/**
- * Creates a directory at the specified path if it doesn't already exist.
- *
- * @param {string} path - The path to the directory to create.
- * @param {string} name - The name of the directory.
- * @param {Logger} log - The logger instance to use for logging messages.
- * @returns {Promise<void>} A promise that resolves when the directory has been created or already exists.
- */
 export async function createDirectory(path, name, log) {
     try {
         await fs.access(path);
@@ -51,4 +19,3 @@ export async function createDirectory(path, name, log) {
         }
     }
 }
-//# sourceMappingURL=createDirectory.js.map

package/dist/utils/createZip.js

@@ -1,44 +1,6 @@
-/**
- * This file contains the createZip function.
- *
- * @file createZip.ts
- * @author Luca Liguori
- * @created 2025-02-16
- * @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 { 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');
@@ -47,22 +9,19 @@ 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`);
             resolve(archive.pointer());
         });
-        /* istanbul ignore next */
         output.on('end', () => {
             log.debug(`archive ${outputPath} data has been drained ${archive.pointer()} total bytes`);
         });
-        /* istanbul ignore next */
         archive.on('error', (error) => {
             log.error(`archive error: ${error.message}`);
             reject(error);
         });
-        /* istanbul ignore next */
         archive.on('warning', (error) => {
             if (error.code === 'ENOENT') {
                 log.warn(`archive warning: ${error.message}`);
@@ -77,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);
@@ -92,7 +50,6 @@ export async function createZip(outputPath, ...sourcePaths) {
                     }
                 }
                 else {
-                    /* istanbul ignore next */
                     log.error(`no files or directory found for pattern ${sourcePath}: ${error}`);
                 }
                 continue;
@@ -106,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,53 +1,17 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/**
- * This file contains the deepCopy function.
- *
- * @file deepCopy.ts
- * @author Luca Liguori
- * @created 2025-02-16
- * @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.
- */
-/**
- * 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
         return value.map((item) => deepCopy(item));
     }
     else if (value instanceof Date) {
-        // Date objects
         return new Date(value.getTime());
     }
     else if (value instanceof RegExp) {
-        // RegExp objects
         return new RegExp(value.source, value.flags);
     }
     else if (value instanceof Map) {
-        // Maps
         const mapCopy = new Map();
         for (const [origKey, origVal] of value.entries()) {
             const clonedKey = deepCopy(origKey);
@@ -57,7 +21,6 @@ export function deepCopy(value) {
         return mapCopy;
     }
     else if (value instanceof Set) {
-        // Sets
         const setCopy = new Set();
         value.forEach((item) => {
             setCopy.add(deepCopy(item));
@@ -65,7 +28,6 @@ export function deepCopy(value) {
         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) {
@@ -76,4 +38,3 @@ export function deepCopy(value) {
         return copy;
     }
 }
-//# sourceMappingURL=deepCopy.js.map

package/dist/utils/deepEqual.js

@@ -1,89 +1,23 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/**
- * This file contains the deepEqual function.
- *
- * @file deepEqual.ts
- * @author Luca Liguori
- * @created 2025-02-16
- * @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.
- */
-/* 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) {
-        // 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 Dates compare by timestamp
     if (a instanceof Date && b instanceof Date) {
         return a.getTime() === b.getTime();
     }
-    // Handle Regexps compare by their source & flags
     if (a instanceof RegExp && b instanceof RegExp) {
         return a.source === b.source && a.flags === b.flags;
     }
-    // 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})`);
@@ -99,31 +33,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/error.js

@@ -1,51 +1,10 @@
-/**
- * This file contains the error functions.
- *
- * @file error.ts
- * @author Luca Liguori
- * @created 2025-07-17
- * @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.
- */
 import { inspect } from 'node:util';
 import { RESET } from 'node-ansi-logger';
-/**
- * Logs an error message using the provided AnsiLogger instance.
- *
- * @param {AnsiLogger} log - The AnsiLogger instance to use for logging.
- * @param {string} message - The error message to log.
- * @param {unknown} error - The error object or value to log. If it's an Error instance,
- *                          its message and stack trace will be included in the log.
- */
 export function logError(log, message, error) {
-    log.error(`${message}: ${error instanceof Error ? error.message + '\nStack:\n' + error.stack : error}`);
+    log.error(`${message}: ${error instanceof Error ? error.message + ' \nStack: \n' + error.stack : error}`);
 }
-/**
- * Logs an error message using the provided AnsiLogger instance with detailed inspection.
- * Uses util.inspect to get a detailed view of the error with a stack depth of 10 levels.
- * If the error is an Error instance, it also includes the error message.
- *
- * @param {AnsiLogger} log - The AnsiLogger instance to use for logging.
- * @param {string} message - The error message to log.
- * @param {unknown} error - The error object or value to log. Will be inspected with depth 10.
- */
 export function inspectError(log, message, error) {
-    const errorMessage = error instanceof Error ? `${error.message}\n` : '';
+    const errorMessage = error instanceof Error ? `${error.message} \n` : '';
     const inspectedError = inspect(error, { depth: 10, colors: true, showHidden: false });
     log.error(`${message}: ${errorMessage}${RESET}${inspectedError}`);
 }
-//# sourceMappingURL=error.js.map

package/dist/utils/export.js

@@ -10,4 +10,3 @@ export * from './createZip.js';
 export * from './wait.js';
 export * from './hex.js';
 export * from './error.js';
-//# sourceMappingURL=export.js.map

package/dist/utils/format.js

@@ -1,51 +1,9 @@
-/**
- * @description This file contains the format functions.
- * @file format.ts
- * @author Luca Liguori
- * @created 2025-10-20
- * @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.
- */
-/**
- * Format a timestamp into a human-readable string.
- *
- * @param {number} timestamp - The timestamp in milliseconds since the Unix epoch.
- * @returns {string} - The formatted timestamp.
- */
 export function formatTimeStamp(timestamp) {
     return `${new Date(timestamp).toLocaleString()}`;
 }
-/**
- * Format a percentage into a human-readable string.
- *
- * @param {number} percent - The percentage value.
- * @param {number} digits - The number of decimal places.
- * @returns {string} - The formatted percentage.
- */
 export function formatPercent(percent, digits = 2) {
     return `${percent.toFixed(digits)} %`;
 }
-/**
- * Format bytes into a human-readable string.
- *
- * @param {number} bytes - The number of bytes.
- * @param {number} digits - The number of decimal places.
- * @returns {string} - The formatted byte string.
- */
 export function formatBytes(bytes, digits = 2) {
     if (bytes === 0)
         return `${bytes.toFixed(digits)} B`;
@@ -54,12 +12,6 @@ export function formatBytes(bytes, digits = 2) {
     const value = bytes / Math.pow(1024, idx);
     return `${value.toFixed(digits)} ${units[idx]}`;
 }
-/**
- * Function to format system uptime with only the most significant unit
- *
- * @param {number} seconds - The number of seconds to format
- * @returns {string} The formatted uptime string
- */
 export function formatUptime(seconds) {
     if (seconds >= 86400) {
         const days = Math.floor(seconds / 86400);
@@ -75,4 +27,3 @@ export function formatUptime(seconds) {
     }
     return `${seconds} second${seconds !== 1 ? 's' : ''}`;
 }
-//# sourceMappingURL=format.js.map