matterbridge 3.4.7-dev-20260112-bd9e311 → 3.4.7

package/packages/utils/dist/inspector.d.ts

@@ -1,10 +1,39 @@
+/**
+ * This file contains the Inspector class.
+ *
+ * @file inspector.ts
+ * @author Luca Liguori
+ * @created 2025-10-12
+ * @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 EventEmitter from 'node:events';
 interface InspectorEvents {
+    /** Start the inspector */
     start: [];
+    /** Stop the inspector */
     stop: [];
+    /** Take a heap snapshot */
     snapshot: [];
+    /** Heap snapshot done */
     snapshot_done: [];
+    /** Run garbage collector */
     gc: [type?: 'major' | 'minor', execution?: 'sync' | 'async'];
+    /** Garbage collection done */
     gc_done: [type: 'major' | 'minor', execution: 'sync' | 'async'];
 }
 export declare class Inspector extends EventEmitter<InspectorEvents> {
@@ -16,9 +45,43 @@ export declare class Inspector extends EventEmitter<InspectorEvents> {
     private snapshotInProgress;
     private log;
     constructor(name?: string, debug?: boolean, verbose?: boolean);
+    /**
+     * Starts the inspector for heap sampling.
+     *
+     * This function is called when the -inspect parameter is passed to matterbridge.
+     *
+     * The -snapshotinterval parameter can be used to set the heap snapshot interval. Default is undefined. Minimum is 30000 ms.
+     * The snapshot is saved in the heap_profiles directory that is created in the current working directory.
+     * The snapshot can be analyzed using vscode or Chrome DevTools or other tools that support heap snapshots.
+     */
     start(): Promise<void>;
+    /**
+     * Stops the heap sampling and saves the profile to a file in the heap_profiles directory.
+     * This function is called when the inspector is stopped.
+     */
     stop(): Promise<void>;
+    /**
+     * Takes a heap snapshot and saves it to the file name 'heap_snapshots/<timestamp>.heapsnapshot'.
+     * If triggers a full garbage collection before and after taking the snapshot to reduce noise.
+     *
+     * This function is called periodically based on the -snapshotinterval parameter.
+     * The -snapshotinterval parameter must at least 30000 ms.
+     * The snapshot is saved in the heap_snapshots directory that is created in the current working directory.
+     * The snapshot can be analyzed using vscode or Chrome DevTools or other tools that support heap snapshots.
+     */
     takeHeapSnapshot(): Promise<void>;
+    /**
+     * Manually trigger garbage collection to free memory (if exposed with --expose-gc)
+     *
+     * @param {'major' | 'minor'} type - The type of garbage collection to perform ('major' or 'minor'). Default is 'major'.
+     * @param {'sync' | 'async'} execution - The execution mode of garbage collection ('sync' or 'async'). Default is 'async'.
+     *
+     * @remarks
+     * - major collection refers to old-generation mark-sweep/mark-compact cycles.
+     * - minor collection refers to young-generation collections (scavenges).
+     * - sync execution blocks the main thread until GC is complete, which can cause pauses.
+     */
     runGarbageCollector(type?: 'major' | 'minor', execution?: 'sync' | 'async'): void;
 }
 export {};
+//# sourceMappingURL=inspector.d.ts.map

package/packages/utils/dist/inspector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspector.d.ts","sourceRoot":"","sources":["../src/inspector.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAMH,OAAO,YAAY,MAAM,aAAa,CAAC;AAMvC,UAAU,eAAe;IACvB,0BAA0B;IAC1B,KAAK,EAAE,EAAE,CAAC;IACV,yBAAyB;IACzB,IAAI,EAAE,EAAE,CAAC;IACT,2BAA2B;IAC3B,QAAQ,EAAE,EAAE,CAAC;IACb,yBAAyB;IACzB,aAAa,EAAE,EAAE,CAAC;IAClB,4BAA4B;IAC5B,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC;IAC7D,8BAA8B;IAC9B,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC;CACjE;AAED,qBAAa,SAAU,SAAQ,YAAY,CAAC,eAAe,CAAC;IAQxD,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAT1B,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,gBAAgB,CAAC,CAAiB;IAE1C,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,GAAG,CAAa;gBAGL,IAAI,GAAE,MAAoB,EAC1B,KAAK,GAAE,OAAe,EACtB,OAAO,GAAE,OAAe;IA6B3C;;;;;;;;OAQG;IACG,KAAK;IAmDX;;;OAGG;IACG,IAAI;IAuCV;;;;;;;;OAQG;IACG,gBAAgB;IAsEtB;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,IAAI,GAAE,OAAO,GAAG,OAAiB,EAAE,SAAS,GAAE,MAAM,GAAG,OAAiB;CAe7F"}

package/packages/utils/dist/inspector.js

@@ -1,3 +1,27 @@
+/**
+ * This file contains the Inspector class.
+ *
+ * @file inspector.ts
+ * @author Luca Liguori
+ * @created 2025-10-12
+ * @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 no-console */
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mInspector loaded.\u001B[40;0m');
 import EventEmitter from 'node:events';
@@ -21,7 +45,7 @@ export class Inspector extends EventEmitter {
         if (process.argv.includes('--verbose') || process.argv.includes('-verbose')) {
             this.verbose = true;
         }
-        this.log = new AnsiLogger({ logName: this.name, logTimestampFormat: 4, logLevel: this.debug ? "debug" : "info" });
+        this.log = new AnsiLogger({ logName: this.name, logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: this.debug ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
         this.log.logNameColor = YELLOW;
         this.on('start', () => {
             this.start();
@@ -36,6 +60,15 @@ export class Inspector extends EventEmitter {
             this.runGarbageCollector();
         });
     }
+    /**
+     * Starts the inspector for heap sampling.
+     *
+     * This function is called when the -inspect parameter is passed to matterbridge.
+     *
+     * The -snapshotinterval parameter can be used to set the heap snapshot interval. Default is undefined. Minimum is 30000 ms.
+     * The snapshot is saved in the heap_profiles directory that is created in the current working directory.
+     * The snapshot can be analyzed using vscode or Chrome DevTools or other tools that support heap snapshots.
+     */
     async start() {
         if (this.session) {
             this.log.warn('Inspector session already active.');
@@ -44,7 +77,9 @@ export class Inspector extends EventEmitter {
         const { Session } = await import('node:inspector');
         const { mkdirSync } = await import('node:fs');
         this.log.debug(`Starting heap sampling...`);
+        // Create the heap profiles directory if it doesn't exist
         mkdirSync('heap_profiles', { recursive: true });
+        // Create the heap snapshots directory if it doesn't exist
         mkdirSync('heap_snapshots', { recursive: true });
         try {
             this.session = new Session();
@@ -53,6 +88,7 @@ export class Inspector extends EventEmitter {
                 this.session?.post('HeapProfiler.startSampling', (err) => (err ? reject(err) : resolve()));
             });
             this.log.debug(`Started heap sampling`);
+            // Set an interval to take heap snapshots
             const { getIntParameter } = await import('./commandLine.js');
             const interval = getIntParameter('snapshotinterval');
             if (interval && interval >= 30000) {
@@ -81,6 +117,10 @@ export class Inspector extends EventEmitter {
             return;
         }
     }
+    /**
+     * Stops the heap sampling and saves the profile to a file in the heap_profiles directory.
+     * This function is called when the inspector is stopped.
+     */
     async stop() {
         if (!this.session) {
             this.log.warn('No active inspector session.');
@@ -91,7 +131,9 @@ export class Inspector extends EventEmitter {
         this.log.debug(`Stopping heap sampling...`);
         if (this.snapshotInterval) {
             this.log.debug(`Clearing heap snapshot interval...`);
+            // Clear the snapshot interval if it exists
             clearInterval(this.snapshotInterval);
+            // Take a final heap snapshot before stopping
             await this.takeHeapSnapshot();
         }
         try {
@@ -113,6 +155,15 @@ export class Inspector extends EventEmitter {
             this.log.debug(`Stopped heap sampling`);
         }
     }
+    /**
+     * Takes a heap snapshot and saves it to the file name 'heap_snapshots/<timestamp>.heapsnapshot'.
+     * If triggers a full garbage collection before and after taking the snapshot to reduce noise.
+     *
+     * This function is called periodically based on the -snapshotinterval parameter.
+     * The -snapshotinterval parameter must at least 30000 ms.
+     * The snapshot is saved in the heap_snapshots directory that is created in the current working directory.
+     * The snapshot can be analyzed using vscode or Chrome DevTools or other tools that support heap snapshots.
+     */
     async takeHeapSnapshot() {
         if (!this.session) {
             this.log.warn('No active inspector session.');
@@ -128,6 +179,7 @@ export class Inspector extends EventEmitter {
         const path = await import('node:path');
         const safeTimestamp = new Date().toISOString().replace(/[<>:"/\\|?*]/g, '-');
         const filename = path.join('heap_snapshots', `${safeTimestamp}.heapsnapshot`);
+        // Trigger a garbage collection before taking the snapshot to reduce noise
         this.runGarbageCollector('minor', 'async');
         this.runGarbageCollector('major', 'async');
         if (this.debug)
@@ -140,13 +192,16 @@ export class Inspector extends EventEmitter {
         };
         stream.once('error', onStreamError);
         const chunksListener = (notification) => {
+            // notification.params.chunk is a string; write directly to the stream
             if (!stream.write(notification.params.chunk)) {
+                // If backpressure engages, it's fine; the stream will buffer internally. We don't block the inspector.
             }
         };
         this.session.on('HeapProfiler.addHeapSnapshotChunk', chunksListener);
         try {
             await new Promise((resolve) => {
                 this.session?.post('HeapProfiler.takeHeapSnapshot', (err) => {
+                    // Detach chunk listener and close the stream, then perform post-actions
                     this.session?.off('HeapProfiler.addHeapSnapshotChunk', chunksListener);
                     const finalize = () => {
                         if (!err && !streamErrored) {
@@ -163,6 +218,7 @@ export class Inspector extends EventEmitter {
                         }
                         resolve();
                     };
+                    // End stream and wait for finish or error
                     try {
                         stream.end(() => finalize());
                     }
@@ -177,6 +233,17 @@ export class Inspector extends EventEmitter {
             this.snapshotInProgress = false;
         }
     }
+    /**
+     * Manually trigger garbage collection to free memory (if exposed with --expose-gc)
+     *
+     * @param {'major' | 'minor'} type - The type of garbage collection to perform ('major' or 'minor'). Default is 'major'.
+     * @param {'sync' | 'async'} execution - The execution mode of garbage collection ('sync' or 'async'). Default is 'async'.
+     *
+     * @remarks
+     * - major collection refers to old-generation mark-sweep/mark-compact cycles.
+     * - minor collection refers to young-generation collections (scavenges).
+     * - sync execution blocks the main thread until GC is complete, which can cause pauses.
+     */
     runGarbageCollector(type = 'major', execution = 'async') {
         if (global.gc && typeof global.gc === 'function') {
             try {
@@ -198,3 +265,4 @@ export class Inspector extends EventEmitter {
         }
     }
 }
+//# sourceMappingURL=inspector.js.map

package/packages/utils/dist/inspector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspector.js","sourceRoot":"","sources":["../src/inspector.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,+BAA+B;AAE/B,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IAAE,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;AAElI,OAAO,YAAY,MAAM,aAAa,CAAC;AAGvC,OAAO,EAAE,UAAU,EAA6B,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAkB1G,MAAM,OAAO,SAAU,SAAQ,YAA6B;IAQvC;IACA;IACA;IATX,OAAO,CAAsB;IAC7B,gBAAgB,CAAkB;IAElC,kBAAkB,GAAG,KAAK,CAAC;IAC3B,GAAG,CAAa;IAExB,YACmB,OAAe,WAAW,EAC1B,QAAiB,KAAK,EACtB,UAAmB,KAAK;QAEzC,KAAK,EAAE,CAAC;QAJS,SAAI,GAAJ,IAAI,CAAsB;QAC1B,UAAK,GAAL,KAAK,CAAiB;QACtB,YAAO,GAAP,OAAO,CAAiB;QAGzC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5E,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,8BAAgB,CAAC,2BAAc,EAAE,CAAC,CAAC;QAC1J,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,MAAM,CAAC;QAE/B,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YACnB,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE;YACvB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE;YACjB,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YACnD,OAAO;QACT,CAAC;QACD,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;QAE9C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAE5C,yDAAyD;QACzD,SAAS,CAAC,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEhD,0DAA0D;QAC1D,SAAS,CAAC,gBAAgB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEjD,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACvB,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC1C,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,4BAA4B,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAExC,yCAAyC;YACzC,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;YAC7D,MAAM,QAAQ,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;YACrD,IAAI,QAAQ,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC;gBAClC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qCAAqC,IAAI,GAAG,QAAQ,GAAG,EAAE,KAAK,CAAC,CAAC;gBAC/E,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBACrC,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;oBAC7C,IAAI,CAAC;wBACH,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;4BAC5B,IAAI,IAAI,CAAC,KAAK;gCAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;4BAC1F,OAAO;wBACT,CAAC;wBACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;wBAC7C,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBAChC,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yCAAyC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;oBACtG,CAAC;gBACH,CAAC,EAAE,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;YAC7F,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;YACzB,OAAO;QACT,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC;QAEvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAE5C,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;YACrD,2CAA2C;YAC3C,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACrC,6CAA6C;YAC7C,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAChC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,OAAO,CAAsC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACxF,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,2BAA2B,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC1G,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM,aAAa,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;YAC7E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,aAAa,cAAc,CAAC,CAAC;YAC5E,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAEjC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,IAAI,GAAG,QAAQ,GAAG,EAAE,EAAE,CAAC,CAAC;QAC3E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QAC9F,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;YACzB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gBAAgB;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,KAAK;gBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAC/E,OAAO;QACT,CAAC;QACD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAE/B,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC;QACvC,MAAM,aAAa,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;QAC7E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,aAAa,eAAe,CAAC,CAAC;QAE9E,0EAA0E;QAC1E,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAE3C,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,IAAI,GAAG,QAAQ,GAAG,EAAE,KAAK,CAAC,CAAC;QAErF,MAAM,MAAM,GAAG,iBAAiB,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QAC3D,IAAI,aAAa,GAAG,KAAK,CAAC;QAC1B,MAAM,aAAa,GAAG,CAAC,GAAY,EAAE,EAAE;YACrC,aAAa,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QAC5F,CAAC,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEpC,MAAM,cAAc,GAAG,CAAC,YAAmF,EAAE,EAAE;YAC7G,sEAAsE;YACtE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7C,uGAAuG;YACzG,CAAC;QACH,CAAC,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,mCAAmC,EAAE,cAAc,CAAC,CAAC;QACrE,IAAI,CAAC;YACH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBAClC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,+BAA+B,EAAE,CAAC,GAAG,EAAE,EAAE;oBAC1D,wEAAwE;oBACxE,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,mCAAmC,EAAE,cAAc,CAAC,CAAC;oBACvE,MAAM,QAAQ,GAAG,GAAG,EAAE;wBACpB,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;4BAC3B,IAAI,IAAI,CAAC,KAAK;gCAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,IAAI,GAAG,QAAQ,GAAG,EAAE,EAAE,CAAC,CAAC;4BAC1F,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;4BAC3C,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;4BAC3C,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;wBAC7B,CAAC;6BAAM,IAAI,GAAG,EAAE,CAAC;4BACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;4BAC5F,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;4BAC3C,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;wBAC7C,CAAC;wBACD,OAAO,EAAE,CAAC;oBACZ,CAAC,CAAC;oBACF,0CAA0C;oBAC1C,IAAI,CAAC;wBACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAC/B,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;wBAC/F,QAAQ,EAAE,CAAC;oBACb,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,OAA0B,OAAO,EAAE,YAA8B,OAAO;QAC1F,IAAI,MAAM,CAAC,EAAE,IAAI,OAAO,MAAM,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;YACjD,IAAI,CAAC;gBACH,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC/B,IAAI,IAAI,CAAC,KAAK;oBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,MAAM,uBAAuB,IAAI,IAAI,SAAS,kBAAkB,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC;gBAChK,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;YACxC,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,CAAC,EAAE,EAAE,CAAC;gBACZ,IAAI,IAAI,CAAC,KAAK;oBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,MAAM,iDAAiD,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC;gBACvJ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC,KAAK;gBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,MAAM,sGAAsG,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC;QACrK,CAAC;IACH,CAAC;CACF"}

package/packages/utils/dist/isValid.d.ts

@@ -1,10 +1,103 @@
+/**
+ * This file contains the validation functions.
+ *
+ * @file isValid.ts
+ * @author Luca Liguori
+ * @created 2025-02-16
+ * @version 1.0.1
+ * @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 {unknown} 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: unknown, min?: number, max?: number): value is number;
+/**
+ * Checks if a value is a valid boolean.
+ *
+ * @param {unknown} 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: unknown): value is boolean;
+/**
+ * Checks if a value is a valid string.
+ *
+ * @param {unknown} 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: unknown, minLength?: number, maxLength?: number): value is string;
+/**
+ * Checks if a value is a valid RegExp.
+ *
+ * @param {unknown} 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: unknown): value is RegExp;
+/**
+ * Checks if a value is a valid object.
+ *
+ * @param {unknown} 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: unknown, minLength?: number, maxLength?: number): value is object;
+/**
+ * Checks if a value is a valid array.
+ *
+ * @param {unknown} 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: unknown, minLength?: number, maxLength?: number): value is unknown[];
+/**
+ * Checks if the given value is null.
+ *
+ * @param {unknown} value - The value to check.
+ * @returns {value is null} `true` if the value is null, `false` otherwise.
+ */
 export declare function isValidNull(value: unknown): value is null;
+/**
+ * Checks if a value is undefined.
+ *
+ * @param {unknown} value - The value to check.
+ * @returns {value is undefined} `true` if the value is undefined, `false` otherwise.
+ */
 export declare function isValidUndefined(value: unknown): 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/packages/utils/dist/isValid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValid.d.ts","sourceRoot":"","sources":["../src/isValid.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAI/D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAKzF;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAE/D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAKrG;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE7D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAMrG;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,EAAE,CAKvG;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAEzD;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAEnE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB5E"}

package/packages/utils/dist/isValid.js

@@ -1,7 +1,44 @@
+/**
+ * This file contains the validation functions.
+ *
+ * @file isValid.ts
+ * @author Luca Liguori
+ * @created 2025-02-16
+ * @version 1.0.1
+ * @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 {unknown} 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 function isValidNumber(value, min, max) {
     if (value === undefined || value === null || typeof value !== 'number' || Number.isNaN(value) || !Number.isFinite(value))
         return false;
@@ -11,9 +48,23 @@ export function isValidNumber(value, min, max) {
         return false;
     return true;
 }
+/**
+ * Checks if a value is a valid boolean.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @returns {value is boolean} `true` if the value is a valid boolean, `false` otherwise.
+ */
 export function isValidBoolean(value) {
     return value !== undefined && value !== null && typeof value === 'boolean';
 }
+/**
+ * Checks if a value is a valid string.
+ *
+ * @param {unknown} 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 function isValidString(value, minLength, maxLength) {
     if (value === undefined || value === null || typeof value !== 'string')
         return false;
@@ -23,9 +74,23 @@ export function isValidString(value, minLength, maxLength) {
         return false;
     return true;
 }
+/**
+ * Checks if a value is a valid RegExp.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @returns {value is RegExp} A boolean indicating whether the value is a valid RegExp.
+ */
 export function isValidRegExp(value) {
     return value !== undefined && value !== null && value instanceof RegExp;
 }
+/**
+ * Checks if a value is a valid object.
+ *
+ * @param {unknown} 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 function isValidObject(value, minLength, maxLength) {
     if (value === undefined || value === null || typeof value !== 'object' || Array.isArray(value))
         return false;
@@ -36,6 +101,14 @@ export function isValidObject(value, minLength, maxLength) {
         return false;
     return true;
 }
+/**
+ * Checks if a value is a valid array.
+ *
+ * @param {unknown} 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 function isValidArray(value, minLength, maxLength) {
     if (value === undefined || value === null || !Array.isArray(value))
         return false;
@@ -45,12 +118,31 @@ export function isValidArray(value, minLength, maxLength) {
         return false;
     return true;
 }
+/**
+ * Checks if the given value is null.
+ *
+ * @param {unknown} value - The value to check.
+ * @returns {value is null} `true` if the value is null, `false` otherwise.
+ */
 export function isValidNull(value) {
     return value === null;
 }
+/**
+ * Checks if a value is undefined.
+ *
+ * @param {unknown} value - The value to check.
+ * @returns {value is undefined} `true` if the value is undefined, `false` otherwise.
+ */
 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 +159,4 @@ export function parseVersionString(versionString) {
     }
     return major * 10000 + minor * 100 + patch;
 }
+//# sourceMappingURL=isValid.js.map

package/packages/utils/dist/isValid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValid.js","sourceRoot":"","sources":["../src/isValid.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,WAAmB;IACpD,MAAM,SAAS,GACb,kKAAkK,CAAC;IACrK,OAAO,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,GAAY,EAAE,GAAY;IACtE,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,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,SAAkB,EAAE,SAAkB;IAClF,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;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,YAAY,MAAM,CAAC;AAC1E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,SAAkB,EAAE,SAAkB;IAClF,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,MAAM,UAAU,YAAY,CAAC,KAAc,EAAE,SAAkB,EAAE,SAAkB;IACjF,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,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,OAAO,KAAK,KAAK,IAAI,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,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/packages/utils/dist/network.d.ts

@@ -1,12 +1,105 @@
+/**
+ * @description This file contains the network functions.
+ * @file network.ts
+ * @author Luca Liguori
+ * @created 2024-02-17
+ * @version 1.0.3
+ * @license Apache-2.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 first non-internal network interface details.
+ *
+ * @returns {os.NetworkInterfaceInfo | undefined} The details of the selected network interface, or undefined if not found.
+ */
 export declare function getInterfaceDetails(): {
     interfaceName: string;
     ipv4Address: string | undefined;
     ipv6Address: string | undefined;
     macAddress: string | undefined;
 } | undefined;
+/**
+ * Retrieves the first non-internal network interface name.
+ *
+ * @returns {string | undefined} The name of the selected network interface, or undefined if not found.
+ */
 export declare function getInterfaceName(): string | undefined;
+/**
+ * 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.
+ *
+ * @remarks
+ * Type of ipv4 addresses:
+ * - 192.168.x.x, 10.x.x.x, 172.16–31.x.x: RFC 1918 = Private networks
+ * - 172.16.0.0 → 172.31.255.255: RFC 1918 = Private IP address used inside local networks, VMs, WSL2 and containers
+ * - 169.254.0.0 → 169.254.255.255: APIPA = Automatic Private IP Addressing used when a device fails to obtain an IP address via DHCP
+ * - 100.64.0.0 → 100.127.255.255: CGNAT = Carrier-Grade NAT RFC 6598 = Shared Address Space
+ */
 export declare function getIpv4InterfaceAddress(): string | undefined;
+/**
+ * Retrieves the IPv6 address of the first non-internal network interface.
+ *
+ * If `scope` is true, appends a zone id (scope) for link-local addresses when
+ * available:
+ * - On Windows: uses `%<scopeid>` (e.g. `...%11`)
+ * - On other platforms: uses `%<interfaceName>` (e.g. `...%eth0`)
+ *
+ * @param {boolean} [scope] - Whether to append a zone id when available.
+ * @returns {string | undefined} The IPv6 address of the selected network interface, or undefined if not found.
+ *
+ * @remarks
+ * Type of IPv6 addresses (preferred order for Matter)
+ *
+ * fd00::/8
+ *   - IPv6 ULA (Unique Local Address)
+ *   - Private IPv6 networks (RFC 4193)
+ *   - ✔ PREFERRED
+ *
+ * 2000::/3
+ *   - Global Unicast IPv6
+ *   - Publicly routable IPv6
+ *   - ⚠ OPTIONAL (advanced setups only)
+ *
+ * fe80::/10
+ *   - IPv6 Link-Local
+ *   - Interface-scoped only, non-routable
+ */
 export declare function getIpv6InterfaceAddress(scope?: boolean): string | undefined;
+/**
+ * Retrieves the mac address of the first non-internal network interface.
+ *
+ * @returns {string | undefined} The mac address, or undefined if not found.
+ */
 export declare function getMacAddress(): string | undefined;
+/**
+ * Logs the available network interfaces and their details.
+ *
+ * @returns {void}
+ */
 export declare function logInterfaces(): void;
+/**
+ * Resolves the given hostname to an IP address.
+ *
+ * @param {string} hostname - The hostname to resolve.
+ * @param {0 | 4 | 6} [family] - 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>;
+//# sourceMappingURL=network.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAQH;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,CAkB7K;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAOrD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAO5D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,GAAE,OAAe,GAAG,MAAM,GAAG,SAAS,CAoBlF;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,MAAM,GAAG,SAAS,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAmBpC;AAED;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,CAAC,GAAG,CAAC,GAAG,CAAK,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAQrG"}