matterbridge 3.4.3-dev-20251209-e6cb85f → 3.4.3

package/dist/utils/createZip.js

@@ -1,6 +1,44 @@
+/**
+ * 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, logLevel: "info" });
+    const log = new AnsiLogger({ logName: 'Archive', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
     const { default: archiver } = await import('archiver');
     const { glob } = await import('glob');
     const { createWriteStream, statSync } = await import('node:fs');
@@ -9,19 +47,22 @@ export async function createZip(outputPath, ...sourcePaths) {
     return new Promise((resolve, reject) => {
         const output = createWriteStream(outputPath);
         const archive = archiver('zip', {
-            zlib: { level: 9 },
+            zlib: { level: 9 }, // Set compression level
         });
         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}`);
@@ -36,6 +77,7 @@ 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);
@@ -50,6 +92,7 @@ export async function createZip(outputPath, ...sourcePaths) {
                     }
                 }
                 else {
+                    /* istanbul ignore next */
                     log.error(`no files or directory found for pattern ${sourcePath}: ${error}`);
                 }
                 continue;
@@ -63,7 +106,9 @@ 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/createZip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createZip.js","sourceRoot":"","sources":["../../src/utils/createZip.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAKH,oBAAoB;AACpB,OAAO,EAAE,UAAU,EAA6B,MAAM,qBAAqB,CAAC;AAE5E;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,UAAkB,EAAE,GAAG,WAAqB;IAC1E,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,4BAAe,EAAE,CAAC,CAAC;IAE7H,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;IACvD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,EAAE,iBAAiB,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;IAChE,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC;IAEvC,GAAG,CAAC,KAAK,CAAC,oBAAoB,UAAU,SAAS,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAE/E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE;YAC9B,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,wBAAwB;SAC7C,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,GAAG,CAAC,KAAK,CAAC,WAAW,UAAU,gBAAgB,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAChF,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,0BAA0B;QAC1B,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YACpB,GAAG,CAAC,KAAK,CAAC,WAAW,UAAU,0BAA0B,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC;QAEH,0BAA0B;QAC1B,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAoB,EAAE,EAAE;YAC3C,GAAG,CAAC,KAAK,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC7C,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,0BAA0B;QAC1B,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,KAAoB,EAAE,EAAE;YAC7C,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC5B,GAAG,CAAC,IAAI,CAAC,oBAAoB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,KAAK,CAAC,oBAAoB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC/C,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAgB,EAAE,EAAE;YACvC,GAAG,CAAC,KAAK,CAAC,oBAAoB,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAErB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,iDAAiD;YACjD,IAAI,KAAK,CAAC;YACV,IAAI,CAAC;gBACH,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC/B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;oBACxD,GAAG,CAAC,KAAK,CAAC,uCAAuC,UAAU,EAAE,CAAC,CAAC;oBAC/D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;wBACzB,GAAG,CAAC,KAAK,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC;wBAClC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;oBACrC,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,0BAA0B;oBAC1B,GAAG,CAAC,KAAK,CAAC,2CAA2C,UAAU,KAAK,KAAK,EAAE,CAAC,CAAC;gBAC/E,CAAC;gBACD,SAAS;YACX,CAAC;YACD,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;gBACnB,GAAG,CAAC,KAAK,CAAC,gBAAgB,UAAU,EAAE,CAAC,CAAC;gBACxC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAChE,CAAC;iBAAM,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC/B,GAAG,CAAC,KAAK,CAAC,qBAAqB,UAAU,EAAE,CAAC,CAAC;gBAC7C,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QACD,0FAA0F;QAC1F,GAAG,CAAC,KAAK,CAAC,sBAAsB,UAAU,KAAK,CAAC,CAAC;QACjD,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/utils/deepCopy.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 declare function deepCopy<T>(value: T): T;
+//# sourceMappingURL=deepCopy.d.ts.map

package/dist/utils/deepCopy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deepCopy.d.ts","sourceRoot":"","sources":["../../src/utils/deepCopy.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAwCvC"}

package/dist/utils/deepCopy.js

@@ -1,17 +1,53 @@
+/* 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);
@@ -21,6 +57,7 @@ export function deepCopy(value) {
         return mapCopy;
     }
     else if (value instanceof Set) {
+        // Sets
         const setCopy = new Set();
         value.forEach((item) => {
             setCopy.add(deepCopy(item));
@@ -28,6 +65,7 @@ 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) {
@@ -38,3 +76,4 @@ export function deepCopy(value) {
         return copy;
     }
 }
+//# sourceMappingURL=deepCopy.js.map

package/dist/utils/deepCopy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deepCopy.js","sourceRoot":"","sources":["../../src/utils/deepCopy.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAI,KAAQ;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,+EAA+E;QAC/E,OAAO,KAAK,CAAC;IACf,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,uCAAuC;QACvC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAQ,CAAC;IACpD,CAAC;SAAM,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QACjC,eAAe;QACf,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAQ,CAAC;IAC1C,CAAC;SAAM,IAAI,KAAK,YAAY,MAAM,EAAE,CAAC;QACnC,iBAAiB;QACjB,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAQ,CAAC;IACtD,CAAC;SAAM,IAAI,KAAK,YAAY,GAAG,EAAE,CAAC;QAChC,OAAO;QACP,MAAM,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YACjD,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;YACpC,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;YACpC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,OAAc,CAAC;IACxB,CAAC;SAAM,IAAI,KAAK,YAAY,GAAG,EAAE,CAAC;QAChC,OAAO;QACP,MAAM,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,OAAO,OAAc,CAAC;IACxB,CAAC;SAAM,CAAC;QACN,iEAAiE;QACjE,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAClC,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;YACxB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;gBACrD,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QACD,OAAO,IAAS,CAAC;IACnB,CAAC;AACH,CAAC"}

package/dist/utils/deepEqual.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare function deepEqual(a: any, b: any, excludeProperties?: string[]): boolean;
+//# sourceMappingURL=deepEqual.d.ts.map

package/dist/utils/deepEqual.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deepEqual.d.ts","sourceRoot":"","sources":["../../src/utils/deepEqual.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,iBAAiB,GAAE,MAAM,EAAO,GAAG,OAAO,CAsFnF"}

package/dist/utils/deepEqual.js

@@ -1,23 +1,89 @@
+/* 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})`);
@@ -33,26 +99,31 @@ 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}])`);
+                debugLog(`deepEqual false for !deepEqual(a[${prop}], b[${prop}])` /* , 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/deepEqual.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deepEqual.js","sourceRoot":"","sources":["../../src/utils/deepEqual.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,uDAAuD;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,UAAU,SAAS,CAAC,CAAM,EAAE,CAAM,EAAE,oBAA8B,EAAE;IACxE,oCAAoC;IACpC,uBAAuB;IAEvB,0CAA0C;IAE1C,MAAM,QAAQ,GAAG,CAAC,GAAG,QAAe,EAAE,EAAE;QACtC,eAAe;QACf,4BAA4B;QAC5B,IAAI;IACN,CAAC,CAAC;IAEF,6FAA6F;IAC7F,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uCAAuC;IACvC,IAAI,OAAO,CAAC,KAAK,OAAO,CAAC,EAAE,CAAC;QAC1B,QAAQ,CAAC,iCAAiC,OAAO,CAAC,cAAc,OAAO,CAAC,EAAE,CAAC,CAAC;QAC5E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6FAA6F;IAC7F,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAC3B,QAAQ,CAAC,6BAA6B,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,oCAAoC;IACpC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC;QAC3C,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;IACrC,CAAC;IAED,iDAAiD;IACjD,IAAI,CAAC,YAAY,MAAM,IAAI,CAAC,YAAY,MAAM,EAAE,CAAC;QAC/C,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,CAAC;IACtD,CAAC;IAED,gBAAgB;IAChB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;YAC1B,QAAQ,CAAC,sCAAsC,CAAC,CAAC,MAAM,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;YACtF,OAAO,KAAK,CAAC;QACf,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAClC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,QAAQ,CAAC,kDAAkD,CAAC,CAAC;gBAC7D,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5C,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5C,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2DAA2D;IAC3D,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACjG,MAAM,MAAM,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjG,qEAAqE;QACrE,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YACpC,QAAQ,CAAC,qCAAqC,MAAM,CAAC,MAAM,uBAAuB,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YACpG,QAAQ,CAAC,mBAAmB,MAAM,CAAC,MAAM,IAAI,EAAE,MAAM,CAAC,CAAC;YACvD,QAAQ,CAAC,mBAAmB,MAAM,CAAC,MAAM,IAAI,EAAE,MAAM,CAAC,CAAC;YACvD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,kFAAkF;QAClF,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;gBACnD,QAAQ,CAAC,yCAAyC,IAAI,GAAG,CAAC,CAAC;gBAC3D,OAAO,KAAK,CAAC;YACf,CAAC;YACD,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,iBAAiB,CAAC,EAAE,CAAC;gBACpD,QAAQ,CAAC,oCAAoC,IAAI,QAAQ,IAAI,IAAI,CAAC,uBAAuB,CAAC,CAAC;gBAC3F,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kDAAkD;IAClD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/utils/error.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { type AnsiLogger } 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 declare function logError(log: AnsiLogger, message: string, error: unknown): void;
+/**
+ * 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.
+ * @returns {string} - The full logged message.
+ */
+export declare function inspectError(log: AnsiLogger, message: string, error: unknown): string;
+//# sourceMappingURL=error.d.ts.map

package/dist/utils/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/utils/error.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAIH,OAAO,EAAS,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE1D;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAE/E;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,CAMrF"}

package/dist/utils/error.js

@@ -1,8 +1,49 @@
+/**
+ * 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}`);
 }
+/**
+ * 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.
+ * @returns {string} - The full logged message.
+ */
 export function inspectError(log, message, error) {
     const errorMessage = error instanceof Error ? `${error.message} \n` : '';
     const inspectedError = inspect(error, { depth: 10, colors: true, showHidden: false });
@@ -10,3 +51,4 @@ export function inspectError(log, message, error) {
     log.error(fullMessage);
     return fullMessage;
 }
+//# sourceMappingURL=error.js.map

package/dist/utils/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/utils/error.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAmB,MAAM,kBAAkB,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAe,EAAE,OAAe,EAAE,KAAc;IACvE,GAAG,CAAC,KAAK,CAAC,GAAG,OAAO,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;AAC5G,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY,CAAC,GAAe,EAAE,OAAe,EAAE,KAAc;IAC3E,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;IACtF,MAAM,WAAW,GAAG,GAAG,OAAO,KAAK,YAAY,GAAG,KAAK,GAAG,cAAc,EAAE,CAAC;IAC3E,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACvB,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/utils/export.d.ts

@@ -0,0 +1,13 @@
+export * from './network.js';
+export * from './commandLine.js';
+export * from './isvalid.js';
+export * from './colorUtils.js';
+export * from './deepCopy.js';
+export * from './deepEqual.js';
+export * from './copyDirectory.js';
+export * from './createDirectory.js';
+export * from './createZip.js';
+export * from './wait.js';
+export * from './hex.js';
+export * from './error.js';
+//# sourceMappingURL=export.d.ts.map

package/dist/utils/export.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../src/utils/export.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC"}

package/dist/utils/export.js

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

package/dist/utils/export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/utils/export.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC"}

package/dist/utils/format.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @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 declare function formatTimeStamp(timestamp: number): string;
+/**
+ * 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 declare function formatPercent(percent: number, digits?: number): string;
+/**
+ * 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 declare function formatBytes(bytes: number, digits?: number): string;
+/**
+ * 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 declare function formatUptime(seconds: number): string;
+//# sourceMappingURL=format.d.ts.map

package/dist/utils/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../src/utils/format.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,GAAE,MAAU,GAAG,MAAM,CAEzE;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,MAAU,GAAG,MAAM,CAMrE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAcpD"}