matterbridge 3.4.7 → 3.5.0-dev-20260113-29ad318

package/dist/update.js

@@ -1,43 +1,10 @@
-/**
- * This file contains the check updates functions.
- *
- * @file update.ts
- * @author Luca Liguori
- * @created 2025-02-24
- * @version 2.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.
- */
-// AnsiLogger module
 import { AnsiLogger, db, debugStringify, nt, wr } from 'node-ansi-logger';
-// Matterbridge module
 import { plg } from './matterbridgeTypes.js';
 import { BroadcastServer } from './broadcastServer.js';
 import { hasParameter } from './utils/commandLine.js';
 import { isValidString } from './utils/isValid.js';
-/**
- * Checks for updates for Matterbridge and its plugins.
- * If the 'shelly' parameter is present, also checks for Shelly updates.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the update checks are complete.
- */
 export async function checkUpdates(matterbridge) {
-    /** Broadcast server */
-    const log = new AnsiLogger({ logName: 'MatterbridgeUpdates', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: matterbridge.logLevel });
+    const log = new AnsiLogger({ logName: 'MatterbridgeUpdates', logTimestampFormat: 4, logLevel: matterbridge.logLevel });
     const server = new BroadcastServer('updates', log);
     const checkUpdatePromise = checkUpdatesAndLog(matterbridge, log, server);
     const latestVersionPromise = getMatterbridgeLatestVersion(matterbridge, log, server);
@@ -58,14 +25,6 @@ export async function checkUpdates(matterbridge) {
     await Promise.all([checkUpdatePromise, latestVersionPromise, devVersionPromise, ...pluginsVersionPromises, ...pluginsDevVersionPromises, ...shellyUpdatesPromises]);
     server.close();
 }
-/**
- * Checks for updates and logs from https://matterbridge.io/.
- * If the update check fails, logs a warning message.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- */
 export async function checkUpdatesAndLog(matterbridge, log, server) {
     const { getGitHubUpdate } = await import('./utils/network.js');
     const branch = matterbridge.matterbridgeVersion.includes('-dev-') ? 'dev' : 'main';
@@ -82,29 +41,17 @@ export async function checkUpdatesAndLog(matterbridge, log, server) {
                 dst: 'frontend',
                 params: { message: branch === 'main' ? updateJson.latestMessage : updateJson.devMessage, timeout: 0, severity: branch === 'main' ? updateJson.latestMessageSeverity : updateJson.devMessageSeverity },
             });
-            // matterbridge.frontend.wssSendSnackbarMessage(branch === 'main' ? updateJson.latestMessage : updateJson.devMessage, 0, branch === 'main' ? updateJson.latestMessageSeverity : updateJson.devMessageSeverity);
         }
     }
     catch (error) {
         log.debug(`Error checking GitHub ${branch} updates: ${error instanceof Error ? error.message : error}`);
     }
 }
-/**
- * Retrieves the latest version of Matterbridge and updates the matterbridgeLatestVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest version is retrieved.
- */
 export async function getMatterbridgeLatestVersion(matterbridge, log, server) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
         const version = await getNpmPackageVersion('matterbridge');
         server.request({ type: 'matterbridge_latest_version', src: server.name, dst: 'matterbridge', params: { version } });
-        // matterbridge.matterbridgeLatestVersion = version;
-        // await matterbridge.nodeContext?.set<string>('matterbridgeLatestVersion', matterbridge.matterbridgeLatestVersion);
         if (matterbridge.matterbridgeVersion !== version) {
             log.notice(`Matterbridge is out of date. Current version: ${matterbridge.matterbridgeVersion}. Latest version: ${version}.`);
             server.request({
@@ -113,11 +60,8 @@ export async function getMatterbridgeLatestVersion(matterbridge, log, server) {
                 dst: 'frontend',
                 params: { message: 'Matterbridge latest update available', timeout: 0, severity: 'info' },
             });
-            // matterbridge.frontend.wssSendSnackbarMessage('Matterbridge latest update available', 0, 'info');
             server.request({ type: 'frontend_updaterequired', src: server.name, dst: 'frontend', params: { devVersion: false } });
-            // matterbridge.frontend.wssSendUpdateRequired();
             server.request({ type: 'frontend_refreshrequired', src: server.name, dst: 'frontend', params: { changed: 'settings' } });
-            // matterbridge.frontend.wssSendRefreshRequired('settings');
         }
         else {
             log.debug(`Matterbridge is up to date. Current version: ${matterbridge.matterbridgeVersion}. Latest version: ${version}.`);
@@ -125,26 +69,14 @@ export async function getMatterbridgeLatestVersion(matterbridge, log, server) {
         return version;
     }
     catch (error) {
-        // logError(matterbridge.log, `Error getting Matterbridge latest version`, error);
         log.warn(`Error getting Matterbridge latest version: ${error instanceof Error ? error.message : error}`);
     }
 }
-/**
- * Retrieves the latest dev version of Matterbridge and updates the matterbridgeDevVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest dev version is retrieved.
- */
 export async function getMatterbridgeDevVersion(matterbridge, log, server) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
         const version = await getNpmPackageVersion('matterbridge', 'dev');
         server.request({ type: 'matterbridge_dev_version', src: server.name, dst: 'matterbridge', params: { version } });
-        // matterbridge.matterbridgeDevVersion = version;
-        // await matterbridge.nodeContext?.set<string>('matterbridgeDevVersion', version);
         if (matterbridge.matterbridgeVersion.includes('-dev-') && matterbridge.matterbridgeVersion !== version) {
             log.notice(`Matterbridge@dev is out of date. Current version: ${matterbridge.matterbridgeVersion}. Latest dev version: ${version}.`);
             server.request({
@@ -153,11 +85,8 @@ export async function getMatterbridgeDevVersion(matterbridge, log, server) {
                 dst: 'frontend',
                 params: { message: 'Matterbridge dev update available', timeout: 0, severity: 'info' },
             });
-            // matterbridge.frontend.wssSendSnackbarMessage('Matterbridge dev update available', 0, 'info');
             server.request({ type: 'frontend_updaterequired', src: server.name, dst: 'frontend', params: { devVersion: true } });
-            // matterbridge.frontend.wssSendUpdateRequired(true);
             server.request({ type: 'frontend_refreshrequired', src: server.name, dst: 'frontend', params: { changed: 'settings' } });
-            // matterbridge.frontend.wssSendRefreshRequired('settings');
         }
         else if (matterbridge.matterbridgeVersion.includes('-dev-') && matterbridge.matterbridgeVersion === version) {
             log.debug(`Matterbridge@dev is up to date. Current version: ${matterbridge.matterbridgeVersion}. Latest dev version: ${version}.`);
@@ -168,15 +97,6 @@ export async function getMatterbridgeDevVersion(matterbridge, log, server) {
         log.warn(`Error getting Matterbridge latest dev version: ${error instanceof Error ? error.message : error}`);
     }
 }
-/**
- * Retrieves the latest version of a plugin and updates the plugin's latestVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @param {ApiPlugin} plugin - The plugin for which to retrieve the latest version.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest version is retrieved.
- */
 export async function getPluginLatestVersion(log, server, plugin) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
@@ -186,7 +106,6 @@ export async function getPluginLatestVersion(log, server, plugin) {
         if (plugin.version !== plugin.latestVersion) {
             log.notice(`The plugin ${plg}${plugin.name}${nt} is out of date. Current version: ${plugin.version}. Latest version: ${plugin.latestVersion}.`);
             server.request({ type: 'frontend_refreshrequired', src: server.name, dst: 'frontend', params: { changed: 'plugins' } });
-            // matterbridge.frontend.wssSendRefreshRequired('plugins');
         }
         else {
             log.debug(`The plugin ${plg}${plugin.name}${db} is up to date. Current version: ${plugin.version}. Latest version: ${plugin.latestVersion}.`);
@@ -197,15 +116,6 @@ export async function getPluginLatestVersion(log, server, plugin) {
         log.warn(`Error getting plugin ${plg}${plugin.name}${wr} latest version: ${error instanceof Error ? error.message : error}`);
     }
 }
-/**
- * Retrieves the latest dev version of a plugin and updates the plugin's devVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @param {ApiPlugin} plugin - The plugin for which to retrieve the latest version.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest dev version is retrieved.
- */
 export async function getPluginDevVersion(log, server, plugin) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
@@ -215,7 +125,6 @@ export async function getPluginDevVersion(log, server, plugin) {
         if (plugin.version.includes('-dev-') && plugin.version !== plugin.devVersion) {
             log.notice(`The plugin ${plg}${plugin.name}${nt} is out of date. Current version: ${plugin.version}. Latest dev version: ${plugin.devVersion}.`);
             server.request({ type: 'frontend_refreshrequired', src: server.name, dst: 'frontend', params: { changed: 'plugins' } });
-            // matterbridge.frontend.wssSendRefreshRequired('plugins');
         }
         else if (plugin.version.includes('-dev-') && plugin.version === plugin.devVersion) {
             log.debug(`The plugin ${plg}${plugin.name}${db} is up to date. Current version: ${plugin.version}. Latest dev version: ${plugin.devVersion}.`);
@@ -226,4 +135,3 @@ export async function getPluginDevVersion(log, server, plugin) {
         log.debug(`Error getting plugin ${plg}${plugin.name}${db} latest dev version: ${error instanceof Error ? error.message : error}`);
     }
 }
-//# sourceMappingURL=update.js.map

package/dist/utils/colorUtils.d.ts

@@ -1,26 +1,3 @@
-/**
- * This file contains the color utilities.
- *
- * @file colorUtils.ts
- * @author Luca Liguori
- * @created 2023-10-05
- * @version 1.3.0
- * @license Apache-2.0
- *
- * Copyright 2023, 2024, 2025 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.
- */
 export interface RGB {
     r: number;
     g: number;
@@ -35,67 +12,13 @@ export interface HSL {
     s: number;
     l: number;
 }
-/**
- * Converts from HSL to RGB color space
- *
- * @param {number} hue - The hue value (0-360).
- * @param {number} saturation - The saturation value (0-100).
- * @param {number} luminance - The luminance value (0-100).
- * @returns {RGB} An object containing the RGB values.
- */
 export declare function hslColorToRgbColor(hue: number, saturation: number, luminance: number): RGB;
-/**
- * Converts RGB color space to CIE 1931 XY color space
- *
- * @param {RGB} rgb - The RGB color object.
- * @returns {XY} An object containing the x and y values in CIE 1931 XY color space.
- */
 export declare function rgbColorToXYColor(rgb: RGB): XY;
-/**
- * Converts CIE 1931 XY color space to RGB color space
- *
- * @param {number} x - The x value in CIE 1931 XY color space.
- * @param {number} y - The y value in CIE 1931 XY color space.
- * @param {number} [brightness] - The brightness value (1-254). Defaults to 254.
- * @returns {RGB} An object containing the RGB values.
- */
 export declare function xyColorToRgbColor(x: number, y: number, brightness?: number): RGB;
-/**
- *  Converts RGB color space to HSL color space
- *
- * @param {RGB} rgb - The RGB color object.
- * @returns {HSL} An object containing the HSL values.
- */
 export declare function rgbColorToHslColor(rgb: RGB): HSL;
-/**
- * Converts CIE 1931 XY color space to HSL color space
- *
- * @param {number} x - The x value in CIE 1931 XY color space.
- * @param {number} y - The y value in CIE 1931 XY color space.
- * @returns {HSL} An object containing the HSL values.
- */
 export declare function xyToHsl(x: number, y: number): HSL;
-/**
- * Converts mireds to kelvin.
- *
- * @param {number} mired - The mired value to convert.
- * @returns {number} The converted kelvin value.
- */
 export declare function miredToKelvin(mired: number): number;
 export declare const miredsToKelvin: typeof miredToKelvin;
-/**
- * Converts kelvin to mireds.
- *
- * @param {number} kelvin - The kelvin value to convert.
- * @returns {number} The converted mired value.
- */
 export declare function kelvinToMired(kelvin: number): number;
 export declare const kelvinToMireds: typeof kelvinToMired;
-/**
- * Converts kelvin to RGB color space.
- *
- * @param {number} kelvin - The kelvin value to convert (1000K to 40000K).
- * @returns {RGB} An object containing the RGB values.
- */
 export declare function kelvinToRGB(kelvin: number): RGB;
-//# sourceMappingURL=colorUtils.d.ts.map

package/dist/utils/colorUtils.js

@@ -1,35 +1,4 @@
-/**
- * This file contains the color utilities.
- *
- * @file colorUtils.ts
- * @author Luca Liguori
- * @created 2023-10-05
- * @version 1.3.0
- * @license Apache-2.0
- *
- * Copyright 2023, 2024, 2025 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 { assert } from 'node:console';
-/**
- * Converts from HSL to RGB color space
- *
- * @param {number} hue - The hue value (0-360).
- * @param {number} saturation - The saturation value (0-100).
- * @param {number} luminance - The luminance value (0-100).
- * @returns {RGB} An object containing the RGB values.
- */
 export function hslColorToRgbColor(hue, saturation, luminance) {
     if (hue === 360) {
         hue = 0;
@@ -41,7 +10,7 @@ export function hslColorToRgbColor(hue, saturation, luminance) {
     luminance /= 100;
     let r, g, b;
     if (saturation === 0) {
-        r = g = b = luminance; // achromatic
+        r = g = b = luminance;
     }
     else {
         const hue2rgb = (p, q, t) => {
@@ -74,54 +43,33 @@ export function hslColorToRgbColor(hue, saturation, luminance) {
         b: Math.ceil(b * 255),
     };
 }
-/**
- * Converts RGB color space to CIE 1931 XY color space
- *
- * @param {RGB} rgb - The RGB color object.
- * @returns {XY} An object containing the x and y values in CIE 1931 XY color space.
- */
 export function rgbColorToXYColor(rgb) {
     let r = rgb.r / 255;
     let g = rgb.g / 255;
     let b = rgb.b / 255;
-    // Apply gamma correction
     r = r > 0.04045 ? Math.pow((r + 0.055) / 1.055, 2.4) : r / 12.92;
     g = g > 0.04045 ? Math.pow((g + 0.055) / 1.055, 2.4) : g / 12.92;
     b = b > 0.04045 ? Math.pow((b + 0.055) / 1.055, 2.4) : b / 12.92;
-    // Scale the values to the D65 illuminant
     r = r * 100;
     g = g * 100;
     b = b * 100;
-    // Convert RGB to XYZ
     const X = r * 0.664511 + g * 0.154324 + b * 0.162028;
     const Y = r * 0.283881 + g * 0.668433 + b * 0.047685;
     const Z = r * 0.000088 + g * 0.07231 + b * 0.986039;
-    // Normalization
     let x = X / (X + Y + Z);
     let y = Y / (X + Y + Z);
-    // Round to 4 digits
     x = Math.round(x * 10000) / 10000;
     y = Math.round(y * 10000) / 10000;
     return { x, y };
 }
-/**
- * Converts CIE 1931 XY color space to RGB color space
- *
- * @param {number} x - The x value in CIE 1931 XY color space.
- * @param {number} y - The y value in CIE 1931 XY color space.
- * @param {number} [brightness] - The brightness value (1-254). Defaults to 254.
- * @returns {RGB} An object containing the RGB values.
- */
 export function xyColorToRgbColor(x, y, brightness = 254) {
     const z = 1.0 - x - y;
     const Y = (brightness / 254).toFixed(2);
     const X = (Number(Y) / y) * x;
     const Z = (Number(Y) / y) * z;
-    // Convert to RGB using Wide RGB D65 conversion
     let red = X * 1.656492 - Number(Y) * 0.354851 - Z * 0.255038;
     let green = -X * 0.707196 + Number(Y) * 1.655397 + Z * 0.036152;
     let blue = X * 0.051713 - Number(Y) * 0.121364 + Z * 1.01153;
-    // If red, green or blue is larger than 1.0 set it back to the maximum of 1.0
     if (red > blue && red > green && red > 1.0) {
         green = green / red;
         blue = blue / red;
@@ -137,40 +85,27 @@ export function xyColorToRgbColor(x, y, brightness = 254) {
         green = green / blue;
         blue = 1.0;
     }
-    // Reverse gamma correction
     red = red <= 0.0031308 ? 12.92 * red : (1.0 + 0.055) * Math.pow(red, 1.0 / 2.4) - 0.055;
     green = green <= 0.0031308 ? 12.92 * green : (1.0 + 0.055) * Math.pow(green, 1.0 / 2.4) - 0.055;
     blue = blue <= 0.0031308 ? 12.92 * blue : (1.0 + 0.055) * Math.pow(blue, 1.0 / 2.4) - 0.055;
-    // Convert normalized decimal to decimal
     red = Math.round(red * 255);
     green = Math.round(green * 255);
     blue = Math.round(blue * 255);
-    // Normalize even if this code should never be reached...
     if (isNaN(red) || red < 0) {
-        /* istanbul ignore next */
         red = 0;
     }
     if (isNaN(green) || green < 0) {
-        /* istanbul ignore next */
         green = 0;
     }
     if (isNaN(blue) || blue < 0) {
-        /* istanbul ignore next */
         blue = 0;
     }
-    // Fix negative zero issue by ensuring we return positive zero
     return {
         r: red === 0 ? 0 : red,
         g: green === 0 ? 0 : green,
         b: blue === 0 ? 0 : blue,
     };
 }
-/**
- *  Converts RGB color space to HSL color space
- *
- * @param {RGB} rgb - The RGB color object.
- * @returns {HSL} An object containing the HSL values.
- */
 export function rgbColorToHslColor(rgb) {
     const r = rgb.r / 255;
     const g = rgb.g / 255;
@@ -180,7 +115,7 @@ export function rgbColorToHslColor(rgb) {
     let h = 0, s = 0;
     const l = (max + min) / 2;
     if (max === min) {
-        h = s = 0; // achromatic
+        h = s = 0;
     }
     else {
         const d = max - min;
@@ -204,48 +139,21 @@ export function rgbColorToHslColor(rgb) {
         l: Math.round(l * 100),
     };
 }
-/**
- * Converts CIE 1931 XY color space to HSL color space
- *
- * @param {number} x - The x value in CIE 1931 XY color space.
- * @param {number} y - The y value in CIE 1931 XY color space.
- * @returns {HSL} An object containing the HSL values.
- */
 export function xyToHsl(x, y) {
     const rgb = xyColorToRgbColor(x, y);
     return rgbColorToHslColor(rgb);
 }
-/**
- * Converts mireds to kelvin.
- *
- * @param {number} mired - The mired value to convert.
- * @returns {number} The converted kelvin value.
- */
 export function miredToKelvin(mired) {
     return Math.round(1000000 / mired);
 }
 export const miredsToKelvin = miredToKelvin;
-/**
- * Converts kelvin to mireds.
- *
- * @param {number} kelvin - The kelvin value to convert.
- * @returns {number} The converted mired value.
- */
 export function kelvinToMired(kelvin) {
     return Math.round(1000000 / kelvin);
 }
 export const kelvinToMireds = kelvinToMired;
-/**
- * Converts kelvin to RGB color space.
- *
- * @param {number} kelvin - The kelvin value to convert (1000K to 40000K).
- * @returns {RGB} An object containing the RGB values.
- */
 export function kelvinToRGB(kelvin) {
-    // Clamp the temperature to the range 1000K to 40000K
     kelvin = Math.max(1000, Math.min(40000, kelvin)) / 100;
     let r, g, b;
-    // Calculate red
     if (kelvin <= 66) {
         r = 255;
     }
@@ -254,7 +162,6 @@ export function kelvinToRGB(kelvin) {
         r = 329.698727446 * Math.pow(r, -0.1332047592);
         r = Math.max(0, Math.min(255, r));
     }
-    // Calculate green
     if (kelvin <= 66) {
         g = kelvin;
         g = 99.4708025861 * Math.log(g) - 161.1195681661;
@@ -265,7 +172,6 @@ export function kelvinToRGB(kelvin) {
         g = 288.1221695283 * Math.pow(g, -0.0755148492);
         g = Math.max(0, Math.min(255, g));
     }
-    // Calculate blue
     if (kelvin >= 66) {
         b = 255;
     }
@@ -279,4 +185,3 @@ export function kelvinToRGB(kelvin) {
     }
     return { r: Math.round(r), g: Math.round(g), b: Math.round(b) };
 }
-//# sourceMappingURL=colorUtils.js.map

package/dist/utils/commandLine.d.ts

@@ -1,66 +1,6 @@
-/**
- * This file contains the parameters functions.
- *
- * @file parameter.ts
- * @author Luca Liguori
- * @created 2025-02-16
- * @version 1.0.0
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Checks if a command-line parameter is present.
- *
- * @param {string} name - The name of the parameter to check.
- * @returns {boolean} True if the parameter is present, otherwise false.
- */
 export declare function hasParameter(name: string): boolean;
-/**
- * Checks if any of the provided command-line parameters are present.
- *
- * @param {string[]} params - The names of the parameters to check.
- * @returns {boolean} True if any of the parameters are present, otherwise false.
- */
 export declare function hasAnyParameter(...params: string[]): boolean;
-/**
- * Retrieves the value of a command-line parameter as a string.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {string | undefined} The value of the parameter, or undefined if not found.
- */
 export declare function getParameter(name: string): string | undefined;
-/**
- * Retrieves the value of a command-line parameter as an integer.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {number | undefined} The integer value of the parameter, or undefined if not found or invalid.
- */
 export declare function getIntParameter(name: string): number | undefined;
-/**
- * Retrieves the value of a command-line parameter as a number array.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {number[] | undefined} An array of string values for the parameter, or undefined if not found.
- */
 export declare function getIntArrayParameter(name: string): number[] | undefined;
-/**
- * Retrieves the value of a command-line parameter as a string array.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {string[] | undefined} An array of string values for the parameter, or undefined if not found.
- */
 export declare function getStringArrayParameter(name: string): string[] | undefined;
-//# sourceMappingURL=commandLine.d.ts.map

package/dist/utils/commandLine.js

@@ -1,33 +1,4 @@
-/**
- * This file contains the parameters functions.
- *
- * @file parameter.ts
- * @author Luca Liguori
- * @created 2025-02-16
- * @version 1.0.0
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 import { isValidNumber } from './isValid.js';
-/**
- * Checks if a command-line parameter is present.
- *
- * @param {string} name - The name of the parameter to check.
- * @returns {boolean} True if the parameter is present, otherwise false.
- */
 export function hasParameter(name) {
     const commandArguments = process.argv.slice(2);
     let markerIncluded = commandArguments.includes(`-${name}`);
@@ -35,23 +6,11 @@ export function hasParameter(name) {
         markerIncluded = commandArguments.includes(`--${name}`);
     return markerIncluded;
 }
-/**
- * Checks if any of the provided command-line parameters are present.
- *
- * @param {string[]} params - The names of the parameters to check.
- * @returns {boolean} True if any of the parameters are present, otherwise false.
- */
 export function hasAnyParameter(...params) {
     return params.some((param) => {
         return hasParameter(param);
     });
 }
-/**
- * Retrieves the value of a command-line parameter as a string.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {string | undefined} The value of the parameter, or undefined if not found.
- */
 export function getParameter(name) {
     const commandArguments = process.argv.slice(2);
     let markerIndex = commandArguments.indexOf(`-${name}`);
@@ -61,12 +20,6 @@ export function getParameter(name) {
         return undefined;
     return commandArguments[markerIndex + 1];
 }
-/**
- * Retrieves the value of a command-line parameter as an integer.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {number | undefined} The integer value of the parameter, or undefined if not found or invalid.
- */
 export function getIntParameter(name) {
     const value = getParameter(name);
     if (value === undefined)
@@ -76,12 +29,6 @@ export function getIntParameter(name) {
         return undefined;
     return intValue;
 }
-/**
- * Retrieves the value of a command-line parameter as a number array.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {number[] | undefined} An array of string values for the parameter, or undefined if not found.
- */
 export function getIntArrayParameter(name) {
     const commandArguments = process.argv.slice(2);
     let markerIndex = commandArguments.indexOf(`--${name}`);
@@ -99,12 +46,6 @@ export function getIntArrayParameter(name) {
         return undefined;
     return intValues;
 }
-/**
- * Retrieves the value of a command-line parameter as a string array.
- *
- * @param {string} name - The name of the parameter to retrieve.
- * @returns {string[] | undefined} An array of string values for the parameter, or undefined if not found.
- */
 export function getStringArrayParameter(name) {
     const commandArguments = process.argv.slice(2);
     let markerIndex = commandArguments.indexOf(`--${name}`);
@@ -120,4 +61,3 @@ export function getStringArrayParameter(name) {
         return undefined;
     return values;
 }
-//# sourceMappingURL=commandLine.js.map