matterbridge 3.0.1-dev-20250506-c77ed36 → 3.0.1

package/dist/utils/deepEqual.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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. *
+ */
+/**
+ * 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":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,iBAAiB,GAAE,MAAM,EAAO,GAAG,OAAO,CA6EnF"}

package/dist/utils/deepEqual.js

@@ -1,21 +1,80 @@
+/**
+ * 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})`);
@@ -31,26 +90,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;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,uDAAuD;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,UAAU,SAAS,CAAC,CAAM,EAAE,CAAM,EAAE,oBAA8B,EAAE;IACxE,oCAAoC;IACpC,MAAM,KAAK,GAAG,KAAK,CAAC;IAEpB,0CAA0C;IAE1C,MAAM,QAAQ,GAAG,CAAC,GAAG,QAAe,EAAE,EAAE;QACtC,IAAI,KAAK,EAAE,CAAC;YACV,sCAAsC;YACtC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;QAC3B,CAAC;IACH,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,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/export.d.ts

@@ -0,0 +1,10 @@
+export * from './network.js';
+export * from './parameter.js';
+export * from './isvalid.js';
+export * from './colorUtils.js';
+export * from './deepCopy.js';
+export * from './deepEqual.js';
+export * from './copyDirectory.js';
+export * from './createZip.js';
+export * from './wait.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,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}

package/dist/utils/export.js

@@ -7,3 +7,4 @@ export * from './deepEqual.js';
 export * from './copyDirectory.js';
 export * from './createZip.js';
 export * from './wait.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,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}

package/dist/utils/isvalid.d.ts

@@ -0,0 +1,95 @@
+/**
+ * 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 declare function isValidIpv4Address(ipv4Address: string): boolean;
+/**
+ * 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.
+ */
+export declare function isValidNumber(value: any, min?: number, max?: number): value is number;
+/**
+ * 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.
+ */
+export declare function isValidBoolean(value: any): value is 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.
+ */
+export declare function isValidString(value: any, minLength?: number, maxLength?: number): value is string;
+/**
+ * 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.
+ */
+export declare function isValidObject(value: any, minLength?: number, maxLength?: number): value is object;
+/**
+ * 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.
+ */
+export declare function isValidArray(value: any, minLength?: number, maxLength?: number): value is unknown[];
+/**
+ * Checks if the given value is null.
+ *
+ * @param {any} value - The value to check.
+ * @returns {boolean} `true` if the value is null, `false` otherwise.
+ */
+export declare function isValidNull(value: any): value is null;
+/**
+ * Checks if a value is undefined.
+ *
+ * @param {any} value - The value to check.
+ * @returns {boolean} `true` if the value is undefined, `false` otherwise.
+ */
+export declare function isValidUndefined(value: any): value is undefined;
+/**
+ * Converts a semantic version string like "6.11.0-1011-raspi" to a numeric version code.
+ * Format: major * 10000 + minor * 100 + patch
+ *
+ * @param {string} versionString The version string to parse
+ * @returns {number | undefined} A numeric version code or undefined if parsing fails
+ */
+export declare function parseVersionString(versionString: string): number | undefined;
+//# sourceMappingURL=isvalid.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isvalid.d.ts","sourceRoot":"","sources":["../../src/utils/isvalid.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAG/D;AAED;;;;;;;GAOG;AAEH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAKrF;AAED;;;;;GAKG;AAEH,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,OAAO,CAE3D;AAED;;;;;;;GAOG;AAEH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAKjG;AAED;;;;;;;GAOG;AAEH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAMjG;AAED;;;;;;;GAOG;AAEH,wBAAgB,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,EAAE,CAKnG;AAED;;;;;GAKG;AAEH,wBAAgB,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,IAAI,CAErD;AAED;;;;;GAKG;AAEH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,SAAS,CAE/D;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB5E"}

package/dist/utils/isvalid.js

@@ -1,7 +1,44 @@
+/**
+ * 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) || !Number.isFinite(value))
         return false;
@@ -11,9 +48,25 @@ 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;
@@ -23,6 +76,15 @@ 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;
@@ -33,6 +95,15 @@ 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;
@@ -42,12 +113,33 @@ 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;
 }
+/**
+ * Converts a semantic version string like "6.11.0-1011-raspi" to a numeric version code.
+ * Format: major * 10000 + minor * 100 + patch
+ *
+ * @param {string} versionString The version string to parse
+ * @returns {number | undefined} A numeric version code or undefined if parsing fails
+ */
 export function parseVersionString(versionString) {
     if (!isValidString(versionString))
         return undefined;
@@ -64,3 +156,4 @@ export function parseVersionString(versionString) {
     }
     return major * 10000 + minor * 100 + patch;
 }
+//# sourceMappingURL=isvalid.js.map

package/dist/utils/isvalid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isvalid.js","sourceRoot":"","sources":["../../src/utils/isvalid.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,WAAmB;IACpD,MAAM,SAAS,GAAG,kKAAkK,CAAC;IACrL,OAAO,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,8DAA8D;AAC9D,MAAM,UAAU,aAAa,CAAC,KAAU,EAAE,GAAY,EAAE,GAAY;IAClE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACvI,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,GAAG,GAAG;QAAE,OAAO,KAAK,CAAC;IACnD,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,GAAG,GAAG;QAAE,OAAO,KAAK,CAAC;IACnD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,8DAA8D;AAC9D,MAAM,UAAU,cAAc,CAAC,KAAU;IACvC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACH,8DAA8D;AAC9D,MAAM,UAAU,aAAa,CAAC,KAAU,EAAE,SAAkB,EAAE,SAAkB;IAC9E,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACrF,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,8DAA8D;AAC9D,MAAM,UAAU,aAAa,CAAC,KAAU,EAAE,SAAkB,EAAE,SAAkB;IAC9E,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7G,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACrE,IAAI,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACrE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,8DAA8D;AAC9D,MAAM,UAAU,YAAY,CAAC,KAAU,EAAE,SAAkB,EAAE,SAAkB;IAC7E,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACjF,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,8DAA8D;AAC9D,MAAM,UAAU,WAAW,CAAC,KAAU;IACpC,OAAO,KAAK,KAAK,IAAI,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,8DAA8D;AAC9D,MAAM,UAAU,gBAAgB,CAAC,KAAU;IACzC,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,aAAqB;IACtD,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;QAAE,OAAO,SAAS,CAAC;IACpD,aAAa,GAAG,aAAa,CAAC,IAAI,EAAE,CAAC;IACrC,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1D,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAE7B,MAAM,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAErC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;QACrG,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,GAAG,GAAG,KAAK,CAAC;AAC7C,CAAC"}

package/dist/utils/network.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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. *
+ */
+/**
+ * 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 declare function getIpv4InterfaceAddress(): string | undefined;
+/**
+ * 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 declare function getIpv6InterfaceAddress(): string | undefined;
+/**
+ * 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 declare function getMacAddress(): string | undefined;
+/**
+ * Logs the available network interfaces and their details.
+ * @param {boolean} log - Whether to enable logging of network interface details.
+ */
+export declare function logInterfaces(debug?: boolean): void;
+/**
+ * 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 declare function resolveHostname(hostname: string, family?: 0 | 4 | 6): Promise<string | 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 declare function getNpmPackageVersion(packageName: string, tag?: string, timeout?: number): Promise<string>;
+/**
+ * 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 declare function getGlobalNodeModules(): Promise<string>;
+//# sourceMappingURL=network.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../../src/utils/network.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAWH;;;GAGG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAmB5D;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAmB5D;AAED;;;GAGG;AACH,wBAAgB,aAAa,IAAI,MAAM,GAAG,SAAS,CAkBlD;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,KAAK,UAAO,GAAG,IAAI,CAehD;AAED;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,CAAC,GAAG,CAAC,GAAG,CAAK,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CASrG;AAED;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,SAAW,EAAE,OAAO,SAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CA+ChH;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC,CAW5D"}