matterbridge 3.3.8-dev-20251115-ca5ff21 → 3.3.8

package/dist/storage/export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/storage/export.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC"}

package/dist/update.d.ts

@@ -0,0 +1,75 @@
+/**
+ * This file contains the check updates functions.
+ *
+ * @file update.ts
+ * @author Luca Liguori
+ * @created 2025-02-24
+ * @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 { Matterbridge } from './matterbridge.js';
+import { Plugin } from './matterbridgeTypes.js';
+/**
+ * Checks for updates for Matterbridge and its plugins.
+ * If the 'shelly' parameter is present, also checks for Shelly updates.
+ *
+ * @param {Matterbridge} matterbridge - The Matterbridge instance.
+ * @returns {Promise<void>} A promise that resolves when the update checks are complete.
+ */
+export declare function checkUpdates(matterbridge: Matterbridge): Promise<void>;
+/**
+ * Checks for updates and logs from GitHub.
+ * If the update check fails, logs a warning message.
+ *
+ * @param {Matterbridge} matterbridge - The Matterbridge instance.
+ */
+export declare function checkUpdatesAndLog(matterbridge: Matterbridge): Promise<void>;
+/**
+ * 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 {Matterbridge} matterbridge - The Matterbridge instance.
+ * @returns {Promise<string | undefined>} A promise that resolves when the latest version is retrieved.
+ */
+export declare function getMatterbridgeLatestVersion(matterbridge: Matterbridge): Promise<string | undefined>;
+/**
+ * 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 {Matterbridge} matterbridge - The Matterbridge instance.
+ * @returns {Promise<string | undefined>} A promise that resolves when the latest dev version is retrieved.
+ */
+export declare function getMatterbridgeDevVersion(matterbridge: Matterbridge): Promise<string | undefined>;
+/**
+ * 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 {Matterbridge} matterbridge - The Matterbridge instance.
+ * @param {Plugin} 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 declare function getPluginLatestVersion(matterbridge: Matterbridge, plugin: Plugin): Promise<string | undefined>;
+/**
+ * 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 {Matterbridge} matterbridge - The Matterbridge instance.
+ * @param {Plugin} 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 declare function getPluginDevVersion(matterbridge: Matterbridge, plugin: Plugin): Promise<string | undefined>;
+//# sourceMappingURL=update.d.ts.map

package/dist/update.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../src/update.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAMH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAO,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAErD;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAyB5E;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAuBlF;AAED;;;;;;GAMG;AACH,wBAAsB,4BAA4B,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAoB1G;AAED;;;;;;GAMG;AACH,wBAAsB,yBAAyB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAmBvG;AAED;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAgBpH;AAED;;;;;;;GAOG;AACH,wBAAsB,mBAAmB,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAgBjH"}

package/dist/update.js

@@ -1,5 +1,36 @@
+/**
+ * This file contains the check updates functions.
+ *
+ * @file update.ts
+ * @author Luca Liguori
+ * @created 2025-02-24
+ * @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.
+ */
+// AnsiLogger module
 import { db, debugStringify, nt, wr } from 'node-ansi-logger';
 import { plg } from './matterbridgeTypes.js';
+/**
+ * Checks for updates for Matterbridge and its plugins.
+ * If the 'shelly' parameter is present, also checks for Shelly updates.
+ *
+ * @param {Matterbridge} matterbridge - The Matterbridge instance.
+ * @returns {Promise<void>} A promise that resolves when the update checks are complete.
+ */
 export async function checkUpdates(matterbridge) {
     const { hasParameter } = await import('./utils/commandLine.js');
     const update = checkUpdatesAndLog(matterbridge);
@@ -23,6 +54,12 @@ export async function checkUpdates(matterbridge) {
     }
     await Promise.all([update, latestVersion, devVersion, ...pluginsVersions, ...pluginsDevVersions, ...shellyUpdates]);
 }
+/**
+ * Checks for updates and logs from GitHub.
+ * If the update check fails, logs a warning message.
+ *
+ * @param {Matterbridge} matterbridge - The Matterbridge instance.
+ */
 export async function checkUpdatesAndLog(matterbridge) {
     const { getGitHubUpdate } = await import('./utils/network.js');
     const { isValidString } = await import('./utils/isvalid.js');
@@ -41,6 +78,13 @@ export async function checkUpdatesAndLog(matterbridge) {
         matterbridge.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 {Matterbridge} matterbridge - The Matterbridge instance.
+ * @returns {Promise<string | undefined>} A promise that resolves when the latest version is retrieved.
+ */
 export async function getMatterbridgeLatestVersion(matterbridge) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
@@ -59,9 +103,17 @@ export async function getMatterbridgeLatestVersion(matterbridge) {
         return version;
     }
     catch (error) {
+        // logError(matterbridge.log, `Error getting Matterbridge latest version`, error);
         matterbridge.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 {Matterbridge} matterbridge - The Matterbridge instance.
+ * @returns {Promise<string | undefined>} A promise that resolves when the latest dev version is retrieved.
+ */
 export async function getMatterbridgeDevVersion(matterbridge) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
@@ -83,6 +135,14 @@ export async function getMatterbridgeDevVersion(matterbridge) {
         matterbridge.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 {Matterbridge} matterbridge - The Matterbridge instance.
+ * @param {Plugin} 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(matterbridge, plugin) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
@@ -101,6 +161,14 @@ export async function getPluginLatestVersion(matterbridge, plugin) {
         matterbridge.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 {Matterbridge} matterbridge - The Matterbridge instance.
+ * @param {Plugin} 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(matterbridge, plugin) {
     const { getNpmPackageVersion } = await import('./utils/network.js');
     try {
@@ -119,3 +187,4 @@ export async function getPluginDevVersion(matterbridge, plugin) {
         matterbridge.log.debug(`Error getting plugin ${plg}${plugin.name}${db} latest dev version: ${error instanceof Error ? error.message : error}`);
     }
 }
+//# sourceMappingURL=update.js.map

package/dist/update.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update.js","sourceRoot":"","sources":["../src/update.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,oBAAoB;AACpB,OAAO,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAI9D,OAAO,EAAE,GAAG,EAAU,MAAM,wBAAwB,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,YAA0B;IAC3D,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;IAChD,MAAM,aAAa,GAAG,4BAA4B,CAAC,YAAY,CAAC,CAAC;IACjE,MAAM,UAAU,GAAG,yBAAyB,CAAC,YAAY,CAAC,CAAC;IAC3D,MAAM,eAAe,GAAG,EAAE,CAAC;IAC3B,MAAM,kBAAkB,GAAG,EAAE,CAAC;IAC9B,MAAM,aAAa,GAAG,EAAE,CAAC;IACzB,KAAK,MAAM,MAAM,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC;QAC1C,MAAM,aAAa,GAAG,sBAAsB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QACnE,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QACnE,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,MAAM,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;QAEhF,MAAM,YAAY,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACtD,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACjC,MAAM,UAAU,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACrD,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,eAAe,EAAE,GAAG,kBAAkB,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC;AACtH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,YAA0B;IACjE,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAC/D,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAE7D,MAAM,MAAM,GAAG,YAAY,CAAC,mBAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IACnF,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;QACvE,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,MAAM,mBAAmB,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACzF,IACE,aAAa,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;YACtF,aAAa,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC,CAAC;YACtG,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAE,UAAU,CAAC,qBAAgC,CAAC,CAAC,CAAE,UAAU,CAAC,kBAA6B,CAAC,EAC9J,CAAC;YACD,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,MAAM,oBAAoB,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;YACpI,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAC1C,MAAM,KAAK,MAAM,CAAC,CAAC,CAAE,UAAU,CAAC,aAAwB,CAAC,CAAC,CAAE,UAAU,CAAC,UAAqB,EAC5F,CAAC,EACD,MAAM,KAAK,MAAM,CAAC,CAAC,CAAE,UAAU,CAAC,qBAAkE,CAAC,CAAC,CAAE,UAAU,CAAC,kBAA+D,CACjL,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,yBAAyB,MAAM,aAAa,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IACvH,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,YAA0B;IAC3E,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAEpE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,cAAc,CAAC,CAAC;QAC3D,YAAY,CAAC,yBAAyB,GAAG,OAAO,CAAC;QACjD,MAAM,YAAY,CAAC,WAAW,EAAE,GAAG,CAAS,2BAA2B,EAAE,YAAY,CAAC,yBAAyB,CAAC,CAAC;QACjH,IAAI,YAAY,CAAC,mBAAmB,KAAK,YAAY,CAAC,yBAAyB,EAAE,CAAC;YAChF,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,iDAAiD,YAAY,CAAC,mBAAmB,qBAAqB,YAAY,CAAC,yBAAyB,GAAG,CAAC,CAAC;YACzK,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,sCAAsC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;YAChG,YAAY,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC;YAC9C,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,gDAAgD,YAAY,CAAC,mBAAmB,qBAAqB,YAAY,CAAC,yBAAyB,GAAG,CAAC,CAAC;QACzK,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kFAAkF;QAClF,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,8CAA8C,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IACxH,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAAC,YAA0B;IACxE,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAEpE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QAClE,YAAY,CAAC,sBAAsB,GAAG,OAAO,CAAC;QAC9C,MAAM,YAAY,CAAC,WAAW,EAAE,GAAG,CAAS,wBAAwB,EAAE,OAAO,CAAC,CAAC;QAC/E,IAAI,YAAY,CAAC,mBAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,mBAAmB,KAAK,OAAO,EAAE,CAAC;YACvG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,qDAAqD,YAAY,CAAC,mBAAmB,yBAAyB,YAAY,CAAC,sBAAsB,GAAG,CAAC,CAAC;YAC9K,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,mCAAmC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;YAC7F,YAAY,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;YAClD,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,YAAY,CAAC,mBAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,mBAAmB,KAAK,OAAO,EAAE,CAAC;YAC9G,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,oDAAoD,YAAY,CAAC,mBAAmB,yBAAyB,YAAY,CAAC,sBAAsB,GAAG,CAAC,CAAC;QAC9K,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,kDAAkD,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IAC5H,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,YAA0B,EAAE,MAAc;IACrF,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAEpE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxD,MAAM,CAAC,aAAa,GAAG,OAAO,CAAC;QAC/B,IAAI,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,aAAa,EAAE,CAAC;YAC5C,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,IAAI,GAAG,EAAE,qCAAqC,MAAM,CAAC,OAAO,qBAAqB,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC;YAC7J,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,IAAI,GAAG,EAAE,oCAAoC,MAAM,CAAC,OAAO,qBAAqB,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC;QAC7J,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,wBAAwB,GAAG,GAAG,MAAM,CAAC,IAAI,GAAG,EAAE,oBAAoB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IAC5I,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,YAA0B,EAAE,MAAc;IAClF,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAEpE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC/D,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC;QAC5B,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,UAAU,EAAE,CAAC;YAC7E,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,IAAI,GAAG,EAAE,qCAAqC,MAAM,CAAC,OAAO,yBAAyB,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC;YAC9J,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAC1D,CAAC;aAAM,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,UAAU,EAAE,CAAC;YACpF,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,IAAI,GAAG,EAAE,oCAAoC,MAAM,CAAC,OAAO,yBAAyB,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC;QAC9J,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,wBAAwB,GAAG,GAAG,MAAM,CAAC,IAAI,GAAG,EAAE,wBAAwB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IACjJ,CAAC;AACH,CAAC"}

package/dist/utils/colorUtils.d.ts

@@ -0,0 +1,101 @@
+/**
+ * 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;
+    b: number;
+}
+export interface XY {
+    x: number;
+    y: number;
+}
+export interface HSL {
+    h: number;
+    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.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorUtils.d.ts","sourceRoot":"","sources":["../../src/utils/colorUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAIH,MAAM,WAAW,GAAG;IAClB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,EAAE;IACjB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,GAAG;IAClB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,GAAG,CA+C1F;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CA6B9C;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,UAAU,GAAE,MAAY,GAAG,GAAG,CAwDrF;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAmChD;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,GAAG,CAGjD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEnD;AACD,eAAO,MAAM,cAAc,sBAAgB,CAAC;AAE5C;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEpD;AACD,eAAO,MAAM,cAAc,sBAAgB,CAAC;AAE5C;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAsC/C"}

package/dist/utils/colorUtils.js

@@ -1,4 +1,35 @@
+/**
+ * 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;
@@ -10,7 +41,7 @@ export function hslColorToRgbColor(hue, saturation, luminance) {
     luminance /= 100;
     let r, g, b;
     if (saturation === 0) {
-        r = g = b = luminance;
+        r = g = b = luminance; // achromatic
     }
     else {
         const hue2rgb = (p, q, t) => {
@@ -43,33 +74,54 @@ 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;
@@ -85,27 +137,40 @@ 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;
@@ -115,7 +180,7 @@ export function rgbColorToHslColor(rgb) {
     let h = 0, s = 0;
     const l = (max + min) / 2;
     if (max === min) {
-        h = s = 0;
+        h = s = 0; // achromatic
     }
     else {
         const d = max - min;
@@ -139,21 +204,48 @@ 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;
     }
@@ -162,6 +254,7 @@ 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;
@@ -172,6 +265,7 @@ 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;
     }
@@ -185,3 +279,4 @@ export function kelvinToRGB(kelvin) {
     }
     return { r: Math.round(r), g: Math.round(g), b: Math.round(b) };
 }
+//# sourceMappingURL=colorUtils.js.map

package/dist/utils/colorUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorUtils.js","sourceRoot":"","sources":["../../src/utils/colorUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAmBtC;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAW,EAAE,UAAkB,EAAE,SAAiB;IACnF,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;QAChB,GAAG,GAAG,CAAC,CAAC;IACV,CAAC;IACD,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,8BAA8B,CAAC,CAAC;IAC/D,MAAM,CAAC,UAAU,IAAI,CAAC,IAAI,UAAU,IAAI,GAAG,EAAE,qCAAqC,CAAC,CAAC;IACpF,MAAM,CAAC,SAAS,KAAK,EAAE,EAAE,oCAAoC,CAAC,CAAC;IAE/D,UAAU,IAAI,GAAG,CAAC;IAClB,SAAS,IAAI,GAAG,CAAC;IACjB,IAAI,CAAS,EAAE,CAAS,EAAE,CAAS,CAAC;IAEpC,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QACrB,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC,aAAa;IACtC,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS,EAAU,EAAE;YAC1D,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACV,CAAC,IAAI,CAAC,CAAC;YACT,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACV,CAAC,IAAI,CAAC,CAAC;YACT,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACd,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACd,OAAO,CAAC,CAAC;YACX,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACd,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACvC,CAAC;YACD,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;QAEF,MAAM,CAAC,GAAG,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,CAAC;QAC3G,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,GAAG,CAAC,CAAC;QAE5B,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACrC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,CAAC;QAC7B,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,OAAO;QACL,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;QACrB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;QACrB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;KACtB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAQ;IACxC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;IACpB,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;IACpB,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;IAEpB,yBAAyB;IACzB,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;IACjE,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;IACjE,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;IAEjE,yCAAyC;IACzC,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACZ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACZ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IAEZ,qBAAqB;IACrB,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,GAAG,CAAC,GAAG,QAAQ,GAAG,CAAC,GAAG,QAAQ,CAAC;IACrD,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,GAAG,CAAC,GAAG,QAAQ,GAAG,CAAC,GAAG,QAAQ,CAAC;IACrD,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,GAAG,CAAC,GAAG,OAAO,GAAG,CAAC,GAAG,QAAQ,CAAC;IAEpD,gBAAgB;IAChB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAExB,oBAAoB;IACpB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;IAClC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;IAElC,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAClB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,CAAS,EAAE,CAAS,EAAE,aAAqB,GAAG;IAC9E,MAAM,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;IACtB,MAAM,CAAC,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACxC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAE9B,+CAA+C;IAC/C,IAAI,GAAG,GAAG,CAAC,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC,GAAG,QAAQ,CAAC;IAC7D,IAAI,KAAK,GAAG,CAAC,CAAC,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC,GAAG,QAAQ,CAAC;IAChE,IAAI,IAAI,GAAG,CAAC,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC,GAAG,OAAO,CAAC;IAE7D,6EAA6E;IAC7E,IAAI,GAAG,GAAG,IAAI,IAAI,GAAG,GAAG,KAAK,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;QAC3C,KAAK,GAAG,KAAK,GAAG,GAAG,CAAC;QACpB,IAAI,GAAG,IAAI,GAAG,GAAG,CAAC;QAClB,GAAG,GAAG,GAAG,CAAC;IACZ,CAAC;SAAM,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,GAAG,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;QACtD,GAAG,GAAG,GAAG,GAAG,KAAK,CAAC;QAClB,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;QACpB,KAAK,GAAG,GAAG,CAAC;IACd,CAAC;SAAM,IAAI,IAAI,GAAG,GAAG,IAAI,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,GAAG,EAAE,CAAC;QACpD,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC;QACjB,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC;QACrB,IAAI,GAAG,GAAG,CAAC;IACb,CAAC;IAED,2BAA2B;IAC3B,GAAG,GAAG,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC;IACxF,KAAK,GAAG,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC;IAChG,IAAI,GAAG,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC;IAE5F,wCAAwC;IACxC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;IAC5B,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;IAChC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;IAE9B,yDAAyD;IACzD,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QAC1B,0BAA0B;QAC1B,GAAG,GAAG,CAAC,CAAC;IACV,CAAC;IACD,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QAC9B,0BAA0B;QAC1B,KAAK,GAAG,CAAC,CAAC;IACZ,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QAC5B,0BAA0B;QAC1B,IAAI,GAAG,CAAC,CAAC;IACX,CAAC;IAED,8DAA8D;IAC9D,OAAO;QACL,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;QACtB,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;QAC1B,CAAC,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;KACzB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAQ;IACzC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;IACtB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;IACtB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;IAEtB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,IAAI,CAAC,GAAG,CAAC,EACP,CAAC,GAAG,CAAC,CAAC;IACR,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;IAE1B,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;QAChB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa;IAC1B,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;QACpB,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;QACpD,QAAQ,GAAG,EAAE,CAAC;YACZ,KAAK,CAAC;gBACJ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAClC,MAAM;YACR,KAAK,CAAC;gBACJ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACpB,MAAM;YACR,KAAK,CAAC;gBACJ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACpB,MAAM;QACV,CAAC;QACD,CAAC,IAAI,CAAC,CAAC;IACT,CAAC;IAED,OAAO;QACL,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC;QACtB,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC;QACtB,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC;KACvB,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,CAAS,EAAE,CAAS;IAC1C,MAAM,GAAG,GAAG,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpC,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC;AACrC,CAAC;AACD,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC;AACtC,CAAC;AACD,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,qDAAqD;IACrD,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC;IAEvD,IAAI,CAAS,EAAE,CAAS,EAAE,CAAS,CAAC;IAEpC,gBAAgB;IAChB,IAAI,MAAM,IAAI,EAAE,EAAE,CAAC;QACjB,CAAC,GAAG,GAAG,CAAC;IACV,CAAC;SAAM,CAAC;QACN,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC;QAChB,CAAC,GAAG,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC;QAC/C,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,kBAAkB;IAClB,IAAI,MAAM,IAAI,EAAE,EAAE,CAAC;QACjB,CAAC,GAAG,MAAM,CAAC;QACX,CAAC,GAAG,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC;QACjD,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;SAAM,CAAC;QACN,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC;QAChB,CAAC,GAAG,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC;QAChD,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,iBAAiB;IACjB,IAAI,MAAM,IAAI,EAAE,EAAE,CAAC;QACjB,CAAC,GAAG,GAAG,CAAC;IACV,CAAC;SAAM,IAAI,MAAM,IAAI,EAAE,EAAE,CAAC;QACxB,CAAC,GAAG,CAAC,CAAC;IACR,CAAC;SAAM,CAAC;QACN,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC;QAChB,CAAC,GAAG,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC;QAClD,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAClE,CAAC"}

package/dist/utils/commandLine.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandLine.d.ts","sourceRoot":"","sources":["../../src/utils/commandLine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAIH;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAKlD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAI5D;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAM7D;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMhE;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAYvE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAW1E"}