matterbridge 3.3.0-dev-20251003-626ea2f → 3.3.0

package/dist/utils/network.d.ts

@@ -0,0 +1,84 @@
+/**
+ * @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 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,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAmB5D;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAmB5D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,MAAM,GAAG,SAAS,CAkBlD;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,8 +1,38 @@
+/**
+ * @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 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() {
     let ipv4Address;
     const networkInterfaces = os.networkInterfaces();
+    // console.log('Available Network Interfaces:', networkInterfaces);
     for (const interfaceDetails of Object.values(networkInterfaces)) {
         if (!interfaceDetails) {
             break;
@@ -16,11 +46,18 @@ export function getIpv4InterfaceAddress() {
             break;
         }
     }
+    // console.log('Selected Network Interfaces:', ipv4Address);
     return ipv4Address;
 }
+/**
+ * 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() {
     let ipv6Address;
     const networkInterfaces = os.networkInterfaces();
+    // console.log('Available Network Interfaces:', networkInterfaces);
     for (const interfaceDetails of Object.values(networkInterfaces)) {
         if (!interfaceDetails) {
             break;
@@ -34,11 +71,18 @@ export function getIpv6InterfaceAddress() {
             break;
         }
     }
+    // console.log('Selected Network Interfaces:', ipv6Address);
     return ipv6Address;
 }
+/**
+ * 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() {
     let macAddress;
     const networkInterfaces = os.networkInterfaces();
+    // console.log('Available Network Interfaces:', networkInterfaces);
     for (const interfaceDetails of Object.values(networkInterfaces)) {
         if (!interfaceDetails) {
             break;
@@ -54,9 +98,14 @@ export function getMacAddress() {
     }
     return macAddress;
 }
+/**
+ * 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());
@@ -70,16 +119,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) => {
@@ -93,7 +162,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;
             }
@@ -104,6 +173,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);
@@ -123,6 +193,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) => {
@@ -136,7 +215,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;
             }
@@ -154,12 +233,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) => {
@@ -173,3 +258,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,uBAAuB;IACrC,IAAI,WAA+B,CAAC;IACpC,MAAM,iBAAiB,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;IACjD,mEAAmE;IACnE,KAAK,MAAM,gBAAgB,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM;QACR,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9E,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM;QACR,CAAC;IACH,CAAC;IACD,4DAA4D;IAC5D,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB;IACrC,IAAI,WAA+B,CAAC;IACpC,MAAM,iBAAiB,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;IACjD,mEAAmE;IACnE,KAAK,MAAM,gBAAgB,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM;QACR,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9E,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM;QACR,CAAC;IACH,CAAC;IACD,4DAA4D;IAC5D,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,IAAI,UAA8B,CAAC;IACnC,MAAM,iBAAiB,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;IACjD,mEAAmE;IACnE,KAAK,MAAM,gBAAgB,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM;QACR,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBACjD,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC;YAC1B,CAAC;QACH,CAAC;QACD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM;QACR,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,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,34 @@
+/**
+ * @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 {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[], 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;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAsHtI"}

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 {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, packageName) {
     const { spawn } = await import('node:child_process');
+    /*
+      npm > npm.cmd on windows
+      cmd.exe ['dir'] on windows
+      await this.spawnCommand('npm', ['install', '-g', 'matterbridge']);
+      */
     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';
@@ -63,6 +103,20 @@ export async function spawnCommand(matterbridge, command, args, packageName) {
                     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) => {
@@ -73,6 +127,21 @@ export async function spawnCommand(matterbridge, command, args, packageName) {
                     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;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,YAA0B,EAAE,OAAe,EAAE,IAAc,EAAE,WAAoB;IAClH,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAErD;;;;QAII;IACJ,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,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,yBAAyB,EAAE,WAAW,IAAI,iBAAiB,CAAC,CAAC;QAEtI,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,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,oBAAoB,EAAE,kCAAkC,IAAI,eAAe,MAAM,EAAE,CAAC,CAAC;YAC9J,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,IAAI,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;oBAAE,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,sBAAsB,CAAC,CAAC;gBAC9L,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,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,oBAAoB,EAAE,kCAAkC,IAAI,eAAe,MAAM,EAAE,CAAC,CAAC;YAC9J,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/wait.d.ts

@@ -0,0 +1,54 @@
+/**
+ * This file contains the wait, waiter and withTimeout functions.
+ *
+ * @file wait.ts
+ * @author Luca Liguori
+ * @created 2025-02-16
+ * @version 1.0.2
+ * @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.
+ */
+/**
+ * Asynchronous waiter function that resolves when the provided condition is met or rejects on timeout.
+ *
+ * @param {string} name - The name of the waiter.
+ * @param {() => boolean} check - A function that checks the condition. Should return a boolean.
+ * @param {boolean} [exitWithReject] - Optional. If true, the promise will be rejected on timeout. Default is false.
+ * @param {number} [resolveTimeout] - Optional. The timeout duration in milliseconds. Default is 5000ms.
+ * @param {number} [resolveInterval] - Optional. The interval duration in milliseconds between condition checks. Default is 500ms.
+ * @param {boolean} [debug] - Optional. If true, debug messages will be logged to the console. Default is false.
+ * @returns {Promise<boolean>} A promise that resolves to true when the condition is met, or false if the timeout occurs.
+ */
+export declare function waiter(name: string, check: () => boolean, exitWithReject?: boolean, resolveTimeout?: number, resolveInterval?: number, debug?: boolean): Promise<boolean>;
+/**
+ * Asynchronously waits for a specified amount of time.
+ *
+ * @param {number} timeout - The duration to wait in milliseconds. Default is 1000ms.
+ * @param {string} name - The name of the wait operation. Default is undefined.
+ * @param {boolean} debug - Whether to enable debug logging. Default is false.
+ * @returns {Promise<void>} A Promise that resolves after the specified timeout.
+ */
+export declare function wait(timeout?: number, name?: string, debug?: boolean): Promise<void>;
+/**
+ * Wraps a promise with a timeout. If the promise does not resolve or reject within the specified time, it will be rejected.
+ *
+ * @param {Promise<T>} promise - The promise to wrap.
+ * @param {number} [timeoutMillisecs] - The timeout duration in milliseconds. Default is 10000ms.
+ * @param {boolean} [reThrow] - Optional. If true, the promise will rethrow the original promise and will reject on timeout. Default is true.
+ * @returns {Promise<T>} A new promise that resolves or rejects based on the original promise and the timeout.
+ */
+export declare function withTimeout<T>(promise: Promise<T>, timeoutMillisecs?: number, reThrow?: boolean): Promise<T>;
+//# sourceMappingURL=wait.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wait.d.ts","sourceRoot":"","sources":["../../src/utils/wait.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAKH;;;;;;;;;;GAUG;AACH,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,OAAO,EAAE,cAAc,GAAE,OAAe,EAAE,cAAc,GAAE,MAAa,EAAE,eAAe,GAAE,MAAY,EAAE,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CA0BxM;AAED;;;;;;;GAOG;AACH,wBAAsB,IAAI,CAAC,OAAO,GAAE,MAAa,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAWvG;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,gBAAgB,GAAE,MAAc,EAAE,OAAO,GAAE,OAAc,GAAG,OAAO,CAAC,CAAC,CAAC,CAwBzH"}

package/dist/utils/wait.js

@@ -1,6 +1,41 @@
+/**
+ * This file contains the wait, waiter and withTimeout functions.
+ *
+ * @file wait.ts
+ * @author Luca Liguori
+ * @created 2025-02-16
+ * @version 1.0.2
+ * @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.
+ */
+// AnsiLogger module
 import { AnsiLogger } from 'node-ansi-logger';
+/**
+ * Asynchronous waiter function that resolves when the provided condition is met or rejects on timeout.
+ *
+ * @param {string} name - The name of the waiter.
+ * @param {() => boolean} check - A function that checks the condition. Should return a boolean.
+ * @param {boolean} [exitWithReject] - Optional. If true, the promise will be rejected on timeout. Default is false.
+ * @param {number} [resolveTimeout] - Optional. The timeout duration in milliseconds. Default is 5000ms.
+ * @param {number} [resolveInterval] - Optional. The interval duration in milliseconds between condition checks. Default is 500ms.
+ * @param {boolean} [debug] - Optional. If true, debug messages will be logged to the console. Default is false.
+ * @returns {Promise<boolean>} A promise that resolves to true when the condition is met, or false if the timeout occurs.
+ */
 export async function waiter(name, check, exitWithReject = false, resolveTimeout = 5000, resolveInterval = 500, debug = false) {
-    const log = new AnsiLogger({ logName: 'Waiter', logTimestampFormat: 4, logLevel: "debug" });
+    const log = new AnsiLogger({ logName: 'Waiter', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "debug" /* LogLevel.DEBUG */ });
     if (check()) {
         if (debug)
             log.debug(`Waiter "${name}" already true`);
@@ -31,8 +66,16 @@ export async function waiter(name, check, exitWithReject = false, resolveTimeout
         }, resolveInterval).unref();
     });
 }
+/**
+ * Asynchronously waits for a specified amount of time.
+ *
+ * @param {number} timeout - The duration to wait in milliseconds. Default is 1000ms.
+ * @param {string} name - The name of the wait operation. Default is undefined.
+ * @param {boolean} debug - Whether to enable debug logging. Default is false.
+ * @returns {Promise<void>} A Promise that resolves after the specified timeout.
+ */
 export async function wait(timeout = 1000, name, debug = false) {
-    const log = new AnsiLogger({ logName: 'Wait', logTimestampFormat: 4, logLevel: "debug" });
+    const log = new AnsiLogger({ logName: 'Wait', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "debug" /* LogLevel.DEBUG */ });
     if (debug)
         log.debug(`Wait "${name}" started...`);
     return new Promise((resolve) => {
@@ -44,6 +87,14 @@ export async function wait(timeout = 1000, name, debug = false) {
         }, timeout).unref();
     });
 }
+/**
+ * Wraps a promise with a timeout. If the promise does not resolve or reject within the specified time, it will be rejected.
+ *
+ * @param {Promise<T>} promise - The promise to wrap.
+ * @param {number} [timeoutMillisecs] - The timeout duration in milliseconds. Default is 10000ms.
+ * @param {boolean} [reThrow] - Optional. If true, the promise will rethrow the original promise and will reject on timeout. Default is true.
+ * @returns {Promise<T>} A new promise that resolves or rejects based on the original promise and the timeout.
+ */
 export function withTimeout(promise, timeoutMillisecs = 10000, reThrow = true) {
     return new Promise((resolve, reject) => {
         const timer = setTimeout(() => {
@@ -51,23 +102,24 @@ export function withTimeout(promise, timeoutMillisecs = 10000, reThrow = true) {
                 reject(new Error('Operation timed out'));
             }
             else {
-                resolve(undefined);
+                resolve(undefined); // Resolve with undefined if reThrow is false
             }
-        }, timeoutMillisecs).unref();
+        }, timeoutMillisecs).unref(); // Unref the timer to prevent it from keeping the event loop alive
         promise
             .then((result) => {
-            clearTimeout(timer);
+            clearTimeout(timer); // Ensure timeout does not fire if promise resolves first
             resolve(result);
             return result;
         })
             .catch((error) => {
-            clearTimeout(timer);
+            clearTimeout(timer); // Ensure timeout does not fire if promise rejects first
             if (reThrow) {
-                reject(error);
+                reject(error); // Reject with the original error
             }
             else {
-                resolve(undefined);
+                resolve(undefined); // Resolve with undefined if reThrow is false
             }
         });
     });
 }
+//# sourceMappingURL=wait.js.map

package/dist/utils/wait.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait.js","sourceRoot":"","sources":["../../src/utils/wait.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,oBAAoB;AACpB,OAAO,EAAE,UAAU,EAA6B,MAAM,kBAAkB,CAAC;AAEzE;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,IAAY,EAAE,KAAoB,EAAE,iBAA0B,KAAK,EAAE,iBAAyB,IAAI,EAAE,kBAA0B,GAAG,EAAE,QAAiB,KAAK;IACpL,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,8BAAgB,EAAE,CAAC,CAAC;IAC7H,IAAI,KAAK,EAAE,EAAE,CAAC;QACZ,IAAI,KAAK;YAAE,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,gBAAgB,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,KAAK;QAAE,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,cAAc,CAAC,CAAC;IACpD,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC9C,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,IAAI,KAAK;gBAAE,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,2BAA2B,CAAC,CAAC;YACjE,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,aAAa,CAAC,UAAU,CAAC,CAAC;YAC1B,IAAI,cAAc;gBAAE,MAAM,CAAC,IAAI,KAAK,CAAC,WAAW,IAAI,2BAA2B,CAAC,CAAC,CAAC;;gBAC7E,OAAO,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC,EAAE,cAAc,CAAC,CAAC,KAAK,EAAE,CAAC;QAE3B,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;YACxC,IAAI,KAAK,EAAE,EAAE,CAAC;gBACZ,IAAI,KAAK;oBAAE,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,kCAAkC,CAAC,CAAC;gBACxE,YAAY,CAAC,SAAS,CAAC,CAAC;gBACxB,aAAa,CAAC,UAAU,CAAC,CAAC;gBAC1B,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;YACD,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,EAAE,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,UAAkB,IAAI,EAAE,IAAa,EAAE,QAAiB,KAAK;IACtF,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,8BAAgB,EAAE,CAAC,CAAC;IAC3H,IAAI,KAAK;QAAE,GAAG,CAAC,KAAK,CAAC,SAAS,IAAI,cAAc,CAAC,CAAC;IAElD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QACnC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,IAAI,KAAK;gBAAE,GAAG,CAAC,KAAK,CAAC,SAAS,IAAI,eAAe,CAAC,CAAC;YACnD,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,OAAO,EAAE,CAAC;QACZ,CAAC,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAI,OAAmB,EAAE,mBAA2B,KAAK,EAAE,UAAmB,IAAI;IAC3G,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,SAAyB,CAAC,CAAC,CAAC,6CAA6C;YACnF,CAAC;QACH,CAAC,EAAE,gBAAgB,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,kEAAkE;QAChG,OAAO;aACJ,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,yDAAyD;YAC9E,OAAO,CAAC,MAAM,CAAC,CAAC;YAChB,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,wDAAwD;YAC7E,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,iCAAiC;YAClD,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,SAAyB,CAAC,CAAC,CAAC,6CAA6C;YACnF,CAAC;QACH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC"}

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "3.3.0-dev-20251003-626ea2f",
+  "version": "3.3.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "3.3.0-dev-20251003-626ea2f",
+      "version": "3.3.0",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.15.4",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.3.0-dev-20251003-626ea2f",
+  "version": "3.3.0",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",
@@ -40,6 +40,7 @@
   ],
   "type": "module",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "bin": {
     "matterbridge": "bin/matterbridge.js",
     "mb_mdns": "bin/mb_mdns.js",