matterbridge 3.1.7-dev-20250723-8e073ce → 3.1.7

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,44 @@
+/**
+ * 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.
+ */
+export declare function inspectError(log: AnsiLogger, message: string, error: unknown): void;
+//# 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,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAE/E;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAInF"}

package/dist/utils/error.js

@@ -1,9 +1,50 @@
+/**
+ * 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';
+/**
+ * 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.
+ */
 export function inspectError(log, message, error) {
     const errorMessage = error instanceof Error ? `${error.message}\n` : '';
     const inspectedError = inspect(error, { depth: 10, colors: true, showHidden: false });
     log.error(`${message}: ${errorMessage}${inspectedError}`);
 }
+//# 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;AAIpC;;;;;;;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,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;AAC1G,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,GAAe,EAAE,OAAe,EAAE,KAAc;IAC3E,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;IACtF,GAAG,CAAC,KAAK,CAAC,GAAG,OAAO,KAAK,YAAY,GAAG,cAAc,EAAE,CAAC,CAAC;AAC5D,CAAC"}

package/dist/utils/export.d.ts

@@ -0,0 +1,12 @@
+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';
+//# 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"}

package/dist/utils/export.js

@@ -9,3 +9,4 @@ export * from './createDirectory.js';
 export * from './createZip.js';
 export * from './wait.js';
 export * from './hex.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"}

package/dist/utils/hex.d.ts

@@ -0,0 +1,49 @@
+/**
+ * This file contains the hex functions.
+ *
+ * @file hex.ts
+ * @author Luca Liguori
+ * @created 2025-05-06
+ * @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.
+ */
+/**
+ * Converts an ArrayBuffer or Uint8Array to a hexadecimal string.
+ *
+ * Accepts any {ArrayBufferLike} input: a raw ArrayBuffer (binary data storage) or
+ * a Uint8Array (TypedArray view over an ArrayBuffer). While an ArrayBuffer holds
+ * the raw memory, a Uint8Array is a typed view into that memory, letting you access
+ * its bytes directly. This function normalizes both by creating a Uint8Array view
+ * before conversion.
+ *
+ * @param {ArrayBufferLike} buffer - The buffer or typed-array view to convert.
+ * @returns {string} A lowercase hex string representation of the buffer's bytes.
+ *
+ * @throws {TypeError} If the input is not an ArrayBuffer or ArrayBufferView.
+ */
+export declare function bufferToHex(buffer: ArrayBufferLike): string;
+/**
+ * Converts a hexadecimal string to a Uint8Array.
+ *
+ * @param {string} hex - The hex string to convert. Can include uppercase or lowercase characters.
+ * @returns {Uint8Array} A Uint8Array representing the corresponding binary data.
+ *
+ * @throws {TypeError} If the input is not a string.
+ * @throws {Error} If the input length is odd or contains non-hex characters.
+ */
+export declare function hexToBuffer(hex: string): Uint8Array;
+//# sourceMappingURL=hex.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hex.d.ts","sourceRoot":"","sources":["../../src/utils/hex.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,eAAe,GAAG,MAAM,CAa3D;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAgCnD"}

package/dist/utils/hex.js

@@ -1,27 +1,85 @@
+/**
+ * This file contains the hex functions.
+ *
+ * @file hex.ts
+ * @author Luca Liguori
+ * @created 2025-05-06
+ * @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.
+ */
+/**
+ * Converts an ArrayBuffer or Uint8Array to a hexadecimal string.
+ *
+ * Accepts any {ArrayBufferLike} input: a raw ArrayBuffer (binary data storage) or
+ * a Uint8Array (TypedArray view over an ArrayBuffer). While an ArrayBuffer holds
+ * the raw memory, a Uint8Array is a typed view into that memory, letting you access
+ * its bytes directly. This function normalizes both by creating a Uint8Array view
+ * before conversion.
+ *
+ * @param {ArrayBufferLike} buffer - The buffer or typed-array view to convert.
+ * @returns {string} A lowercase hex string representation of the buffer's bytes.
+ *
+ * @throws {TypeError} If the input is not an ArrayBuffer or ArrayBufferView.
+ */
 export function bufferToHex(buffer) {
+    // Check if the input is an ArrayBuffer or ArrayBufferView
     if (!(buffer instanceof ArrayBuffer || ArrayBuffer.isView(buffer))) {
         throw new TypeError('Expected input to be an ArrayBuffer or ArrayBufferView');
     }
+    // Create a Uint8Array view over the buffer
     const bytes = buffer instanceof Uint8Array ? buffer : new Uint8Array(buffer);
+    // Convert each byte to 2-digit hex
     return Array.from(bytes)
         .map((byte) => byte.toString(16).padStart(2, '0'))
         .join('');
 }
+/**
+ * Converts a hexadecimal string to a Uint8Array.
+ *
+ * @param {string} hex - The hex string to convert. Can include uppercase or lowercase characters.
+ * @returns {Uint8Array} A Uint8Array representing the corresponding binary data.
+ *
+ * @throws {TypeError} If the input is not a string.
+ * @throws {Error} If the input length is odd or contains non-hex characters.
+ */
 export function hexToBuffer(hex) {
+    // Ensure the input is a string
     if (typeof hex !== 'string') {
         throw new TypeError('Expected a string for hex input');
     }
+    // Trim any whitespace from the input string
     const cleaned = hex.trim();
+    // Check if the length of the hex string is even
     if (cleaned.length % 2 !== 0) {
         throw new Error('Invalid hex string length, must be even');
     }
+    // Validate that the string contains only valid hex characters
     if (!/^[0-9a-fA-F]*$/.test(cleaned)) {
         throw new Error('Invalid hex string, contains non-hex characters');
     }
+    // Calculate the length of the resulting Uint8Array
     const length = cleaned.length / 2;
+    // Create a Uint8Array to hold the binary data
     const result = new Uint8Array(length);
+    // Convert each pair of hex characters into a byte
     for (let i = 0; i < length; i++) {
         result[i] = parseInt(cleaned.substr(i * 2, 2), 16);
     }
+    // Return the resulting Uint8Array
     return result;
 }
+//# sourceMappingURL=hex.js.map

package/dist/utils/hex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hex.js","sourceRoot":"","sources":["../../src/utils/hex.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,WAAW,CAAC,MAAuB;IACjD,0DAA0D;IAC1D,IAAI,CAAC,CAAC,MAAM,YAAY,WAAW,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,SAAS,CAAC,wDAAwD,CAAC,CAAC;IAChF,CAAC;IAED,2CAA2C;IAC3C,MAAM,KAAK,GAAG,MAAM,YAAY,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAE7E,mCAAmC;IACnC,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;SACrB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;SACjD,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,+BAA+B;IAC/B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC;IACzD,CAAC;IAED,4CAA4C;IAC5C,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAE3B,gDAAgD;IAChD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,8DAA8D;IAC9D,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IAED,mDAAmD;IACnD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAElC,8CAA8C;IAC9C,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAEtC,kDAAkD;IAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,kCAAkC;IAClC,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/utils/isvalid.d.ts

@@ -0,0 +1,103 @@
+/**
+ * This file contains the validation functions.
+ *
+ * @file isvalid.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.
+ */
+/**
+ * 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 {value is number} 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 {value is 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 {value is string} 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 RegExp.
+ *
+ * @param {any} value - The value to be checked.
+ * @returns {value is RegExp} A boolean indicating whether the value is a valid RegExp.
+ */
+export declare function isValidRegExp(value: any): value is RegExp;
+/**
+ * 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 {value is object} 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 {value is unknown[]} 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 {value is null} `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 {value is undefined} `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 like 61100.
+ * 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;;;;;;;;;;;;;;;;;;;;;;GAsBG;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;;;;;GAKG;AAEH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,MAAM,CAEzD;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,45 @@
+/**
+ * This file contains the validation functions.
+ *
+ * @file isvalid.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.
+ */
+/**
+ * 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 {value is number} 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 +49,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 {value is 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 {value is string} 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,9 +77,25 @@ export function isValidString(value, minLength, maxLength) {
         return false;
     return true;
 }
+/**
+ * Checks if a value is a valid RegExp.
+ *
+ * @param {any} value - The value to be checked.
+ * @returns {value is RegExp} A boolean indicating whether the value is a valid RegExp.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isValidRegExp(value) {
     return value !== undefined && value !== null && value instanceof RegExp;
 }
+/**
+ * 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 {value is object} 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;
@@ -36,6 +106,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 {value is unknown[]} 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;
@@ -45,12 +124,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 {value is null} `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 {value is undefined} `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 like 61100.
+ * 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;
@@ -67,3 +167,4 @@ export function parseVersionString(versionString) {
     }
     return major * 10000 + minor * 100 + patch;
 }
+//# sourceMappingURL=isvalid.js.map