matterbridge 3.3.7-dev-20251109-a306ab9 → 3.3.7

package/dist/utils/network.d.ts

@@ -0,0 +1,101 @@
+/**
+ * @description This file contains the network functions.
+ * @file network.ts
+ * @author Luca Liguori
+ * @created 2024-02-17
+ * @version 1.0.1
+ * @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.
+ */
+export declare function getIpv4InterfaceAddress(): string | undefined;
+/**
+ * Retrieves the IPv6 address of the first non-internal network interface.
+ *
+ * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
+ */
+export declare function getIpv6InterfaceAddress(): string | undefined;
+/**
+ * Retrieves the mac address of the first non-internal network interface.
+ *
+ * @returns {string | undefined} The 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>;
+/**
+ * Retrieves the version of an npm package from the npm registry.
+ *
+ * @param {string} packageName - The name of the npm package.
+ * @param {string} [tag] - The tag of the package version to retrieve (default is 'latest').
+ * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
+ * @returns {Promise<string>} A promise that resolves to the version string of the package.
+ * @throws {Error} If the request fails or the tag is not found.
+ */
+export declare function getNpmPackageVersion(packageName: string, tag?: string, timeout?: number): Promise<string>;
+/**
+ * Retrieves a file from the public directory of the Matterbridge GitHub repository.
+ *
+ * @param {string} branch - The branch from which to fetch the file.
+ * @param {string} file - The file path to fetch.
+ * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
+ * @returns {Promise<Record<string, boolean | string | number>>} A promise that resolves to the parsed JSON object from the file.
+ * @throws {Error} If the request fails or the JSON parsing fails.
+ */
+export declare function getGitHubUpdate(branch: 'main' | 'dev', file: string, timeout?: number): Promise<Record<string, boolean | string | number>>;
+/**
+ * Retrieves the path to the global Node.js modules directory.
+ *
+ * @returns {Promise<string>} A promise that resolves to the path of the global Node.js modules directory.
+ */
+export declare function getGlobalNodeModules(): Promise<string>;
+//# sourceMappingURL=network.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../../src/utils/network.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAUH;;;;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,CAa7K;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAOrD;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAO5D;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAO5D;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,CASrG;AAED;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,GAAE,MAAiB,EAAE,OAAO,GAAE,MAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CA8ChI;AAED;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,MAAc,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,CAyCvJ;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC,CAW5D"}

package/dist/utils/network.js

@@ -1,5 +1,34 @@
+/**
+ * @description This file contains the network functions.
+ * @file network.ts
+ * @author Luca Liguori
+ * @created 2024-02-17
+ * @version 1.0.1
+ * @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.
+ */
+// Node.js modules
 import os from 'node:os';
+// AnsiLogger module
 import { AnsiLogger, BLUE, CYAN, nf } from 'node-ansi-logger';
+/**
+ * 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 function getInterfaceDetails() {
     const result = { interfaceName: '', ipv4Address: undefined, ipv6Address: undefined, macAddress: undefined };
     for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
@@ -21,6 +50,11 @@ export function getInterfaceDetails() {
     if (result.interfaceName)
         return result;
 }
+/**
+ * Retrieves the first non-internal network interface name.
+ *
+ * @returns {string | undefined} The name of the selected network interface, or undefined if not found.
+ */
 export function getInterfaceName() {
     for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
         if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
@@ -31,6 +65,11 @@ export function getInterfaceName() {
         }
     }
 }
+/**
+ * Retrieves the IPv4 address of the first non-internal network interface.
+ *
+ * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
+ */
 export function getIpv4InterfaceAddress() {
     for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
         if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
@@ -41,6 +80,11 @@ export function getIpv4InterfaceAddress() {
         }
     }
 }
+/**
+ * Retrieves the IPv6 address of the first non-internal network interface.
+ *
+ * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
+ */
 export function getIpv6InterfaceAddress() {
     for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
         if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
@@ -51,6 +95,11 @@ export function getIpv6InterfaceAddress() {
         }
     }
 }
+/**
+ * Retrieves the mac address of the first non-internal network interface.
+ *
+ * @returns {string | undefined} The mac address, or undefined if not found.
+ */
 export function getMacAddress() {
     for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
         if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
@@ -61,9 +110,14 @@ export function getMacAddress() {
         }
     }
 }
+/**
+ * Logs the available network interfaces and their details.
+ *
+ * @returns {void}
+ */
 export function logInterfaces() {
-    const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4, logLevel: "info" });
-    log.logLevel = "info";
+    const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
+    log.logLevel = "info" /* LogLevel.INFO */;
     log.logName = 'LogInterfaces';
     log.info('Available Network Interfaces:');
     const availableAddresses = Object.entries(os.networkInterfaces());
@@ -77,16 +131,36 @@ export function logInterfaces() {
         }
     }
 }
+/**
+ * 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 async function resolveHostname(hostname, family = 4) {
     const dns = await import('node:dns');
     try {
-        const addresses = await dns.promises.lookup(hostname.toLowerCase(), { family });
+        const addresses = await dns.promises.lookup(hostname.toLowerCase() /* + '.local'*/, { family });
         return addresses.address;
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
     }
     catch (error) {
         return null;
     }
 }
+/**
+ * Retrieves the version of an npm package from the npm registry.
+ *
+ * @param {string} packageName - The name of the npm package.
+ * @param {string} [tag] - The tag of the package version to retrieve (default is 'latest').
+ * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
+ * @returns {Promise<string>} A promise that resolves to the version string of the package.
+ * @throws {Error} If the request fails or the tag is not found.
+ */
 export async function getNpmPackageVersion(packageName, tag = 'latest', timeout = 10000) {
     const https = await import('node:https');
     return new Promise((resolve, reject) => {
@@ -100,7 +174,7 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
             let data = '';
             if (res.statusCode !== 200) {
                 clearTimeout(timeoutId);
-                res.resume();
+                res.resume(); // Discard response data to close the socket properly
                 reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
                 return;
             }
@@ -111,6 +185,7 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
                 clearTimeout(timeoutId);
                 try {
                     const jsonData = JSON.parse(data);
+                    // console.log(`Package ${packageName} tag ${tag}`, jsonData);
                     const version = jsonData['dist-tags']?.[tag];
                     if (version) {
                         resolve(version);
@@ -130,6 +205,15 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
         });
     });
 }
+/**
+ * Retrieves a file from the public directory of the Matterbridge GitHub repository.
+ *
+ * @param {string} branch - The branch from which to fetch the file.
+ * @param {string} file - The file path to fetch.
+ * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
+ * @returns {Promise<Record<string, boolean | string | number>>} A promise that resolves to the parsed JSON object from the file.
+ * @throws {Error} If the request fails or the JSON parsing fails.
+ */
 export async function getGitHubUpdate(branch, file, timeout = 10000) {
     const https = await import('node:https');
     return new Promise((resolve, reject) => {
@@ -143,7 +227,7 @@ export async function getGitHubUpdate(branch, file, timeout = 10000) {
             let data = '';
             if (res.statusCode !== 200) {
                 clearTimeout(timeoutId);
-                res.resume();
+                res.resume(); // Discard response data to close the socket properly
                 reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
                 return;
             }
@@ -161,12 +245,18 @@ export async function getGitHubUpdate(branch, file, timeout = 10000) {
                 }
             });
         });
+        // istanbul ignore next
         req.on('error', (error) => {
             clearTimeout(timeoutId);
             reject(new Error(`Request failed: ${error instanceof Error ? error.message : error}`));
         });
     });
 }
+/**
+ * Retrieves the path to the global Node.js modules directory.
+ *
+ * @returns {Promise<string>} A promise that resolves to the path of the global Node.js modules directory.
+ */
 export async function getGlobalNodeModules() {
     const { exec } = await import('node:child_process');
     return new Promise((resolve, reject) => {
@@ -180,3 +270,4 @@ export async function getGlobalNodeModules() {
         });
     });
 }
+//# sourceMappingURL=network.js.map

package/dist/utils/network.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.js","sourceRoot":"","sources":["../../src/utils/network.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,kBAAkB;AAClB,OAAO,EAAE,MAAM,SAAS,CAAC;AAIzB,oBAAoB;AACpB,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAY,EAAE,EAAmB,MAAM,kBAAkB,CAAC;AAEzF;;;;GAIG;AACH,MAAM,UAAU,mBAAmB;IACjC,MAAM,MAAM,GAAgI,EAAE,aAAa,EAAE,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IACzO,KAAK,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC;QACvF,IAAI,CAAC,aAAa,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACnF,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,MAAM,CAAC,QAAQ;gBAAE,SAAS;YAC9B,IAAI,CAAC,MAAM,CAAC,aAAa;gBAAE,MAAM,CAAC,aAAa,GAAG,aAAa,CAAC;YAChE,IAAI,aAAa,KAAK,MAAM,CAAC,aAAa,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM;gBAAE,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC;YACnI,IAAI,aAAa,KAAK,MAAM,CAAC,aAAa,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM;gBAAE,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC;YACnI,IAAI,aAAa,KAAK,MAAM,CAAC,aAAa,IAAI,CAAC,MAAM,CAAC,UAAU;gBAAE,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC;QACnG,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,aAAa;QAAE,OAAO,MAAM,CAAC;AAC1C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB;IAC9B,KAAK,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC;QACvF,IAAI,CAAC,aAAa,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACnF,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAAE,OAAO,aAAa,CAAC;QAC7C,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB;IACrC,KAAK,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC;QACvF,IAAI,CAAC,aAAa,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACnF,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,OAAO,CAAC;QAC1E,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB;IACrC,KAAK,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC;QACvF,IAAI,CAAC,aAAa,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACnF,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,OAAO,CAAC;QAC1E,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,KAAK,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC;QACvF,IAAI,CAAC,aAAa,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACnF,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,GAAG,CAAC;QAC1C,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,4BAAe,EAAE,CAAC,CAAC;IAEvI,GAAG,CAAC,QAAQ,6BAAgB,CAAC;IAC7B,GAAG,CAAC,OAAO,GAAG,eAAe,CAAC;IAE9B,GAAG,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC1C,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAClE,KAAK,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,kBAAkB,EAAE,CAAC;QACrD,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,GAAG,CAAC,IAAI,CAAC,qBAAqB,IAAI,GAAG,SAAS,GAAG,EAAE,GAAG,CAAC,CAAC;YACxD,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACvB,GAAG,CAAC,IAAI,CACN,KAAK,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,EAAE,YAAY,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,EAAE,YAAY,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,EAAE,QAAQ,IAAI,GAAG,KAAK,CAAC,GAAG,GAAG,EAAE,EAAE;oBACpI,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,EAAE,EAAE,CAClL,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,QAAgB,EAAE,SAAoB,CAAC;IAC3E,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;IACrC,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAChG,OAAO,SAAS,CAAC,OAAO,CAAC;QACzB,6DAA6D;IAC/D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,WAAmB,EAAE,MAAc,QAAQ,EAAE,UAAkB,KAAK;IAC7G,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;IACzC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,GAAG,GAAG,8BAA8B,WAAW,EAAE,CAAC;QACxD,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,UAAU,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,OAAO,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC;QACzE,CAAC,EAAE,OAAO,CAAC,CAAC;QAEZ,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE;YAChE,IAAI,IAAI,GAAG,EAAE,CAAC;YAEd,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC3B,YAAY,CAAC,SAAS,CAAC,CAAC;gBACxB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,qDAAqD;gBACnE,MAAM,CAAC,IAAI,KAAK,CAAC,sCAAsC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBAC1E,OAAO;YACT,CAAC;YAED,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBACvB,IAAI,IAAI,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACjB,YAAY,CAAC,SAAS,CAAC,CAAC;gBACxB,IAAI,CAAC;oBACH,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAClC,8DAA8D;oBAC9D,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;oBAC7C,IAAI,OAAO,EAAE,CAAC;wBACZ,OAAO,CAAC,OAAO,CAAC,CAAC;oBACnB,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,GAAG,4BAA4B,WAAW,GAAG,CAAC,CAAC,CAAC;oBAC3E,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,IAAI,KAAK,CAAC,kCAAkC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBACxG,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACxB,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,MAAM,CAAC,IAAI,KAAK,CAAC,mBAAmB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,MAAsB,EAAE,IAAY,EAAE,UAAkB,KAAK;IACjG,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;IACzC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,GAAG,GAAG,2BAA2B,MAAM,IAAI,IAAI,EAAE,CAAC;QACxD,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,UAAU,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,OAAO,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC;QACzE,CAAC,EAAE,OAAO,CAAC,CAAC;QAEZ,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE;YAChE,IAAI,IAAI,GAAG,EAAE,CAAC;YAEd,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC3B,YAAY,CAAC,SAAS,CAAC,CAAC;gBACxB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,qDAAqD;gBACnE,MAAM,CAAC,IAAI,KAAK,CAAC,sCAAsC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBAC1E,OAAO;YACT,CAAC;YAED,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBACvB,IAAI,IAAI,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACjB,YAAY,CAAC,SAAS,CAAC,CAAC;gBACxB,IAAI,CAAC;oBACH,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACpB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,IAAI,KAAK,CAAC,kCAAkC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBACxG,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,uBAAuB;QACvB,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACxB,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,MAAM,CAAC,IAAI,KAAK,CAAC,mBAAmB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IACxC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACpD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,CAAC,aAAa,EAAE,CAAC,KAA2B,EAAE,MAAc,EAAE,EAAE;YAClE,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACzB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/utils/spawn.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @description This file contains the spawn functions.
+ * @file spawn.ts
+ * @author Luca Liguori
+ * @created 2025-02-16
+ * @version 1.1.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 { Matterbridge } from '../matterbridge.js';
+/**
+ * Spawns a child process with the given command and arguments.
+ *
+ * @param {Matterbridge} matterbridge - The Matterbridge instance to use for logging and sending messages.
+ * @param {string} command - The command to execute.
+ * @param {string[]} args - The arguments to pass to the command (default: []).
+ * @param {'install' | 'uninstall'} packageCommand - The package command being executed (e.g., 'install', 'uninstall').
+ * @param {string} [packageName] - The name of the package being installed (optional).
+ * @returns {Promise<boolean>} A promise that resolves when the child process exits successfully, or rejects if there is an error.
+ */
+export declare function spawnCommand(matterbridge: Matterbridge, command: string, args: string[], packageCommand: 'install' | 'uninstall', packageName: string): Promise<boolean>;
+//# sourceMappingURL=spawn.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"spawn.d.ts","sourceRoot":"","sources":["../../src/utils/spawn.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAIvD;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,cAAc,EAAE,SAAS,GAAG,WAAW,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAqH9K"}

package/dist/utils/spawn.js

@@ -1,12 +1,52 @@
+/**
+ * @description This file contains the spawn functions.
+ * @file spawn.ts
+ * @author Luca Liguori
+ * @created 2025-02-16
+ * @version 1.1.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 { hasParameter } from './commandLine.js';
+/**
+ * Spawns a child process with the given command and arguments.
+ *
+ * @param {Matterbridge} matterbridge - The Matterbridge instance to use for logging and sending messages.
+ * @param {string} command - The command to execute.
+ * @param {string[]} args - The arguments to pass to the command (default: []).
+ * @param {'install' | 'uninstall'} packageCommand - The package command being executed (e.g., 'install', 'uninstall').
+ * @param {string} [packageName] - The name of the package being installed (optional).
+ * @returns {Promise<boolean>} A promise that resolves when the child process exits successfully, or rejects if there is an error.
+ */
 export async function spawnCommand(matterbridge, command, args, packageCommand, packageName) {
     const { spawn } = await import('node:child_process');
+    /*
+     *  npm > npm.cmd on windows
+     *  cmd.exe ['dir'] on windows
+     */
     const cmdLine = command + ' ' + args.join(' ');
     if (process.platform === 'win32' && command === 'npm') {
+        // Must be spawn('cmd.exe', ['/c', 'npm -g install <package>']);
         const argstring = 'npm ' + args.join(' ');
         args.splice(0, args.length, '/c', argstring);
         command = 'cmd.exe';
     }
+    // Decide when using sudo on linux and macOS
+    // When you need sudo: Spawn stderr: npm error Error: EACCES: permission denied
+    // When you don't need sudo: Failed to start child process "npm install -g matterbridge-eve-door": spawn sudo ENOENT
     if (hasParameter('sudo') || (process.platform !== 'win32' && command === 'npm' && !hasParameter('docker') && !hasParameter('nosudo'))) {
         args.unshift(command);
         command = 'sudo';
@@ -26,6 +66,7 @@ export async function spawnCommand(matterbridge, command, args, packageCommand,
             reject(err);
         });
         childProcess.on('close', (code, signal) => {
+            // matterbridge.frontend.wssSendLogMessage('spawn', matterbridge.log.now(), 'Matterbridge:spawn', `child process closed with code ${code} and signal ${signal}`);
             if (code === 0) {
                 matterbridge.log.debug(`Child process "${cmdLine}" closed with code ${code} and signal ${signal}`);
                 matterbridge.frontend.wssSendLogMessage('spawn', matterbridge.log.now(), 'Matterbridge:spawn-exit-success', 'Child process closed');
@@ -38,6 +79,7 @@ export async function spawnCommand(matterbridge, command, args, packageCommand,
             }
         });
         childProcess.on('exit', (code, signal) => {
+            // matterbridge.frontend.wssSendLogMessage('spawn', matterbridge.log.now(), 'Matterbridge:spawn', `child process exited with code ${code} and signal ${signal}`);
             if (code === 0) {
                 matterbridge.log.debug(`Child process "${cmdLine}" exited with code ${code} and signal ${signal}`);
                 matterbridge.frontend.wssSendLogMessage('spawn', matterbridge.log.now(), 'Matterbridge:spawn-exit-success', 'Child process exited');
@@ -62,6 +104,20 @@ export async function spawnCommand(matterbridge, command, args, packageCommand,
                     matterbridge.frontend.wssSendLogMessage('spawn', matterbridge.log.now(), 'Matterbridge:spawn', line);
                 }
             });
+            /*
+            childProcess.stdout.on('close', () => {
+              matterbridge.log.debug(`Spawn output (stdout): closed`);
+              resolve(true);
+            });
+            childProcess.stdout.on('end', () => {
+              matterbridge.log.debug(`Spawn output (stdout): ended`);
+              resolve(true);
+            });
+            childProcess.stdout.on('error', () => {
+              matterbridge.log.debug(`Spawn output (stdout): error`);
+              resolve(true);
+            });
+            */
         }
         if (childProcess.stderr) {
             childProcess.stderr.on('data', (data) => {
@@ -72,6 +128,21 @@ export async function spawnCommand(matterbridge, command, args, packageCommand,
                     matterbridge.frontend.wssSendLogMessage('spawn', matterbridge.log.now(), 'Matterbridge:spawn', line);
                 }
             });
+            /*
+            childProcess.stderr.on('close', () => {
+              matterbridge.log.debug(`Spawn verbose (stderr): closed`);
+              resolve(true);
+            });
+            childProcess.stderr.on('end', () => {
+              matterbridge.log.debug(`Spawn verbose (stderr): ended`);
+              resolve(true);
+            });
+            childProcess.stderr.on('error', () => {
+              matterbridge.log.debug(`Spawn verbose (stderr): error`);
+              resolve(true);
+            });
+            */
         }
     });
 }
+//# sourceMappingURL=spawn.js.map

package/dist/utils/spawn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spawn.js","sourceRoot":"","sources":["../../src/utils/spawn.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,YAA0B,EAAE,OAAe,EAAE,IAAc,EAAE,cAAuC,EAAE,WAAmB;IAC1J,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAErD;;;OAGG;IACH,MAAM,OAAO,GAAG,OAAO,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;QACtD,gEAAgE;QAChE,MAAM,SAAS,GAAG,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;QAC7C,OAAO,GAAG,SAAS,CAAC;IACtB,CAAC;IACD,4CAA4C;IAC5C,+EAA+E;IAC/E,oHAAoH;IACpH,IAAI,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,OAAO,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QACtI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,GAAG,MAAM,CAAC;IACnB,CAAC;IACD,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,OAAO,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC1E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,cAAc,KAAK,SAAS;YAAE,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,yBAAyB,EAAE,cAAc,WAAW,EAAE,CAAC,CAAC;aAC9J,IAAI,cAAc,KAAK,WAAW;YAAE,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,yBAAyB,EAAE,gBAAgB,WAAW,EAAE,CAAC,CAAC;QAE5K,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE;YACxC,KAAK,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC;SACnC,CAAC,CAAC;QAEH,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC/B,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,OAAO,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YACrF,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,+BAA+B,EAAE,qBAAqB,CAAC,CAAC;YACjI,MAAM,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YACxC,iKAAiK;YACjK,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,OAAO,sBAAsB,IAAI,eAAe,MAAM,EAAE,CAAC,CAAC;gBACnG,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,iCAAiC,EAAE,sBAAsB,CAAC,CAAC;gBACpI,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,OAAO,sBAAsB,IAAI,eAAe,MAAM,EAAE,CAAC,CAAC;gBACnG,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,+BAA+B,EAAE,sBAAsB,CAAC,CAAC;gBAClI,MAAM,CAAC,IAAI,KAAK,CAAC,kBAAkB,OAAO,sBAAsB,IAAI,eAAe,MAAM,EAAE,CAAC,CAAC,CAAC;YAChG,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YACvC,iKAAiK;YACjK,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,OAAO,sBAAsB,IAAI,eAAe,MAAM,EAAE,CAAC,CAAC;gBACnG,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,iCAAiC,EAAE,sBAAsB,CAAC,CAAC;gBACpI,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,OAAO,sBAAsB,IAAI,eAAe,MAAM,EAAE,CAAC,CAAC;gBACnG,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,+BAA+B,EAAE,sBAAsB,CAAC,CAAC;gBAClI,MAAM,CAAC,IAAI,KAAK,CAAC,kBAAkB,OAAO,sBAAsB,IAAI,eAAe,MAAM,EAAE,CAAC,CAAC,CAAC;YAChG,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;YACjC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,OAAO,yCAAyC,CAAC,CAAC;YAC3F,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;YACxB,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;gBAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;gBACvC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,IAAI,EAAE,CAAC,CAAC;oBACzD,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,oBAAoB,EAAE,IAAI,CAAC,CAAC;gBACvG,CAAC;YACH,CAAC,CAAC,CAAC;YACH;;;;;;;;;;;;;cAaE;QACJ,CAAC;QAED,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;YACxB,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;gBAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;gBACvC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,IAAI,EAAE,CAAC,CAAC;oBAC1D,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,oBAAoB,EAAE,IAAI,CAAC,CAAC;gBACvG,CAAC;YACH,CAAC,CAAC,CAAC;YACH;;;;;;;;;;;;;cAaE;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/utils/tracker.d.ts

@@ -0,0 +1,108 @@
+/**
+ * This file contains the Tracker class.
+ *
+ * @file tracker.ts
+ * @author Luca Liguori
+ * @created 2025-10-10
+ * @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';
+export type TrackerSnapshot = {
+    timestamp: number;
+    freeMemory: number;
+    peakFreeMemory: number;
+    totalMemory: number;
+    peakTotalMemory: number;
+    osCpu: number;
+    peakOsCpu: number;
+    processCpu: number;
+    peakProcessCpu: number;
+    rss: number;
+    peakRss: number;
+    heapUsed: number;
+    peakHeapUsed: number;
+    heapTotal: number;
+    peakHeapTotal: number;
+    external: number;
+    peakExternal: number;
+    arrayBuffers: number;
+    peakArrayBuffers: number;
+};
+interface TrackerEvents {
+    /** Start tracking */
+    start: [];
+    /** Stop tracking */
+    stop: [];
+    /** Uptime event */
+    uptime: [os: number, process: number];
+    /** CPU event */
+    cpu: [os: number, process: number];
+    /** Memory event */
+    memory: [free: number, total: number, rss: number, heapUsed: number, heapTotal: number, external: number, arrayBuffers: number];
+    /** Snapshot event */
+    snapshot: [snapshot: TrackerSnapshot];
+    /** Reset peaks */
+    reset_peaks: [];
+    /** Reset peaks done event */
+    reset_peaks_done: [];
+    /** Run garbage collection */
+    gc: [];
+    /** Garbage collection done event */
+    gc_done: [type: 'major' | 'minor', execution: 'sync' | 'async'];
+}
+export declare class Tracker extends EventEmitter<TrackerEvents> {
+    private readonly name;
+    private readonly debug;
+    private readonly verbose;
+    private trackerInterval?;
+    static historyIndex: number;
+    static readonly historySize = 2880;
+    static readonly history: TrackerSnapshot[];
+    private prevCpus;
+    private prevCpuUsage;
+    private log;
+    constructor(name?: string, debug?: boolean, verbose?: boolean);
+    /**
+     * Start tracking cpu and memory usage with a given interval in ms
+     *
+     * @param {number} sampleIntervalMs Sample interval in milliseconds. Default is 10000 (10 seconds).
+     */
+    start(sampleIntervalMs?: number): void;
+    /**
+     * Reset peak values to the currently stored values
+     */
+    resetPeaks(): 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;
+    /**
+     * Stop tracking, clear interval, log history
+     */
+    stop(): void;
+}
+export {};
+//# sourceMappingURL=tracker.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tracker.d.ts","sourceRoot":"","sources":["../../src/utils/tracker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAOH,OAAO,YAAY,MAAM,aAAa,CAAC;AAOvC,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAGF,UAAU,aAAa;IACrB,qBAAqB;IACrB,KAAK,EAAE,EAAE,CAAC;IACV,oBAAoB;IACpB,IAAI,EAAE,EAAE,CAAC;IACT,mBAAmB;IACnB,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACtC,gBAAgB;IAChB,GAAG,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACnC,mBAAmB;IACnB,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IAChI,qBAAqB;IACrB,QAAQ,EAAE,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IACtC,kBAAkB;IAClB,WAAW,EAAE,EAAE,CAAC;IAChB,6BAA6B;IAC7B,gBAAgB,EAAE,EAAE,CAAC;IACrB,6BAA6B;IAC7B,EAAE,EAAE,EAAE,CAAC;IACP,oCAAoC;IACpC,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC;CACjE;AAED,qBAAa,OAAQ,SAAQ,YAAY,CAAC,aAAa,CAAC;IAmCpD,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO;IApC1B,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,MAAM,CAAC,YAAY,SAAK;IAExB,MAAM,CAAC,QAAQ,CAAC,WAAW,QAAQ;IACnC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,EAAE,CAwBxC;IACF,OAAO,CAAC,QAAQ,CAAa;IAC7B,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,GAAG,CAAa;gBAGL,IAAI,GAAE,MAAkB,EACxB,KAAK,GAAE,OAAe,EACtB,OAAO,GAAE,OAAe;IAkC3C;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,GAAE,MAAc;IAiGtC;;OAEG;IACH,UAAU;IAaV;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,IAAI,GAAE,OAAO,GAAG,OAAiB,EAAE,SAAS,GAAE,MAAM,GAAG,OAAiB;IAgB5F;;OAEG;IACH,IAAI;CA8BL"}