matterbridge 3.4.7 → 3.5.0-dev-20260113-96c82db

package/dist/utils/inspector.js

@@ -1,27 +1,3 @@
-/**
- * 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';
@@ -45,7 +21,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 /* TimestampFormat.TIME_MILLIS */, logLevel: this.debug ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
+        this.log = new AnsiLogger({ logName: this.name, logTimestampFormat: 4, logLevel: this.debug ? "debug" : "info" });
         this.log.logNameColor = YELLOW;
         this.on('start', () => {
             this.start();
@@ -60,15 +36,6 @@ 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.');
@@ -77,9 +44,7 @@ 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();
@@ -88,7 +53,6 @@ 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) {
@@ -117,10 +81,6 @@ 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.');
@@ -131,9 +91,7 @@ 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 {
@@ -155,15 +113,6 @@ 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.');
@@ -179,7 +128,6 @@ 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)
@@ -192,16 +140,13 @@ 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) {
@@ -218,7 +163,6 @@ export class Inspector extends EventEmitter {
                         }
                         resolve();
                     };
-                    // End stream and wait for finish or error
                     try {
                         stream.end(() => finalize());
                     }
@@ -233,17 +177,6 @@ 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 {
@@ -265,4 +198,3 @@ export class Inspector extends EventEmitter {
         }
     }
 }
-//# sourceMappingURL=inspector.js.map

package/dist/utils/isValid.d.ts

@@ -1,103 +1,10 @@
-/**
- * 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/dist/utils/isValid.js

@@ -1,44 +1,7 @@
-/**
- * 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;
@@ -48,23 +11,9 @@ 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;
@@ -74,23 +23,9 @@ 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;
@@ -101,14 +36,6 @@ 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;
@@ -118,31 +45,12 @@ 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;
@@ -159,4 +67,3 @@ export function parseVersionString(versionString) {
     }
     return major * 10000 + minor * 100 + patch;
 }
-//# sourceMappingURL=isValid.js.map

package/dist/utils/network.d.ts

@@ -1,116 +1,15 @@
-/**
- * @description This file contains the network functions.
- * @file network.ts
- * @author Luca Liguori
- * @created 2024-02-17
- * @version 1.0.2
- * @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>;
-/**
- * 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>;
 export type UpdateJson = {
     latest: string;
@@ -122,20 +21,5 @@ export type UpdateJson = {
     devMessage: string;
     devMessageSeverity: 'info' | 'warning' | 'error' | 'success';
 };
-/**
- * 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<UpdateJson>;
-/**
- * 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