matterbridge 3.3.7-dev-20251109-a306ab9 → 3.3.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,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;;;;;;;;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,10 +1,51 @@
+/**
+ * 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.
+ */
 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}${RESET}${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;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,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,KAAK,GAAG,cAAc,EAAE,CAAC,CAAC;AACpE,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"}

package/dist/utils/format.js

@@ -1,9 +1,51 @@
+/**
+ * @description This file contains the format functions.
+ * @file format.ts
+ * @author Luca Liguori
+ * @created 2025-10-20
+ * @version 1.0.0
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Format a timestamp into a human-readable string.
+ *
+ * @param {number} timestamp - The timestamp in milliseconds since the Unix epoch.
+ * @returns {string} - The formatted timestamp.
+ */
 export function formatTimeStamp(timestamp) {
     return `${new Date(timestamp).toLocaleString()}`;
 }
+/**
+ * Format a percentage into a human-readable string.
+ *
+ * @param {number} percent - The percentage value.
+ * @param {number} digits - The number of decimal places.
+ * @returns {string} - The formatted percentage.
+ */
 export function formatPercent(percent, digits = 2) {
     return `${percent.toFixed(digits)} %`;
 }
+/**
+ * Format bytes into a human-readable string.
+ *
+ * @param {number} bytes - The number of bytes.
+ * @param {number} digits - The number of decimal places.
+ * @returns {string} - The formatted byte string.
+ */
 export function formatBytes(bytes, digits = 2) {
     if (bytes === 0)
         return `${bytes.toFixed(digits)} B`;
@@ -12,6 +54,12 @@ export function formatBytes(bytes, digits = 2) {
     const value = bytes / Math.pow(1024, idx);
     return `${value.toFixed(digits)} ${units[idx]}`;
 }
+/**
+ * Function to format system uptime with only the most significant unit
+ *
+ * @param {number} seconds - The number of seconds to format
+ * @returns {string} The formatted uptime string
+ */
 export function formatUptime(seconds) {
     if (seconds >= 86400) {
         const days = Math.floor(seconds / 86400);
@@ -27,3 +75,4 @@ export function formatUptime(seconds) {
     }
     return `${seconds} second${seconds !== 1 ? 's' : ''}`;
 }
+//# sourceMappingURL=format.js.map

package/dist/utils/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../src/utils/format.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,SAAiB;IAC/C,OAAO,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC;AACnD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,OAAe,EAAE,SAAiB,CAAC;IAC/D,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;AACxC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,SAAiB,CAAC;IAC3D,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;IACrD,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACrF,MAAM,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC1C,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;AAClD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe;IAC1C,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;QACrB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC;QACzC,OAAO,GAAG,IAAI,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAC/C,CAAC;IACD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;QACzC,OAAO,GAAG,KAAK,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAClD,CAAC;IACD,IAAI,OAAO,IAAI,EAAE,EAAE,CAAC;QAClB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC;QACzC,OAAO,GAAG,OAAO,UAAU,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACxD,CAAC;IACD,OAAO,GAAG,OAAO,UAAU,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AACxD,CAAC"}

package/dist/utils/hex.d.ts

@@ -0,0 +1,89 @@
+/**
+ * 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;
+/**
+ * Converts a PEM (Privacy-Enhanced Mail) formatted string to a Uint8Array.
+ *
+ * PEM format is a base64-encoded format commonly used for cryptographic keys and certificates,
+ * wrapped with header and footer lines like "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----".
+ * This function extracts the base64 content and converts it to binary data using Node.js Buffer API.
+ *
+ * @param {string} pem - The PEM formatted string to convert.
+ * @param {boolean} validate - Whether to validate the PEM content using Node.js crypto module. Default is false.
+ * @returns {Uint8Array} A Uint8Array representing the decoded binary data.
+ *
+ * @throws {TypeError} If the input is not a string.
+ * @throws {Error} If the PEM format is invalid, contains invalid base64 characters, or validation fails.
+ */
+export declare function pemToBuffer(pem: string, validate?: boolean): Uint8Array;
+/**
+ * Extracts the raw 32-byte private key scalar from an EC private key PEM.
+ *
+ * This function parses an EC private key in PEM format and extracts the raw
+ * 32-byte private scalar (the "d" value) used in elliptic curve cryptography.
+ * This is the actual secret key material.
+ *
+ * @param {string} pemPrivateKey - The EC private key in PEM format
+ * @returns {Uint8Array} The raw 32-byte private key scalar
+ * @throws {Error} If the input is not a valid EC private key PEM
+ *
+ * @example
+ * ```typescript
+ * const pemKey = `-----BEGIN EC PRIVATE KEY-----
+ * MHcCAQEEIFBxqFkUxMoN2JkUXLFeiZnLNUpftjLi0sKMbZ6uajHXoAoGCCqGSM49
+ * AwEHoUQDQgAEcJ3eH/rG3zf9WmqMjh5eBSkeXz3Cb4Fig1rTosfHmgyjx/WnLPEe
+ * BF4SHvLo0G2COJEHa/VDE5EiKWO9ZR6AOQ==
+ * -----END EC PRIVATE KEY-----`;
+ *
+ * const rawKey = extractPrivateKeyRaw(pemKey);
+ * console.log(rawKey.length); // 32
+ * console.log(bufferToHex(rawKey)); // hex representation of the private scalar
+ * ```
+ */
+export declare function extractPrivateKeyRaw(pemPrivateKey: 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;AAIH;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,eAAe,GAAG,MAAM,CAa3D;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAgCnD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAe,GAAG,UAAU,CAoG9E;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,UAAU,CAgCtE"}