matterbridge 3.4.7-dev-20260112-bd9e311 → 3.4.7

package/packages/jest-utils/dist/jestHelpers.js

@@ -1,8 +1,32 @@
+/**
+ * @description This file contains the Jest base helpers.
+ * @file src/helpers.test.ts
+ * @author Luca Liguori
+ * @created 2025-09-03
+ * @version 1.0.14
+ * @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 { rmSync } from 'node:fs';
 import path from 'node:path';
+// Imports from node-ansi-logger
 import { AnsiLogger } from 'node-ansi-logger';
 export const originalProcessArgv = Object.freeze([...process.argv]);
 export const originalProcessEnv = Object.freeze({ ...process.env });
+// Spy on logger methods
 export let loggerLogSpy;
 export let loggerDebugSpy;
 export let loggerInfoSpy;
@@ -10,6 +34,7 @@ export let loggerNoticeSpy;
 export let loggerWarnSpy;
 export let loggerErrorSpy;
 export let loggerFatalSpy;
+// Spy on console methods
 export let consoleLogSpy;
 export let consoleDebugSpy;
 export let consoleInfoSpy;
@@ -18,13 +43,31 @@ export let consoleErrorSpy;
 export let NAME;
 export let HOMEDIR;
 export let log;
+/**
+ * Setup the Jest environment:
+ * - it will remove any existing home directory
+ * - setup the spies for logging
+ *
+ * @param {string} name The name of the test suite.
+ * @param {boolean} debug If true, the logging is not mocked.
+ *
+ * @example
+ * ```typescript
+ * import { consoleDebugSpy, consoleErrorSpy, consoleInfoSpy, consoleLogSpy, consoleWarnSpy, loggerLogSpy, setDebug, setupTest } from './jestutils/jestHelpers.js';
+ *
+ * // Setup the test environment
+ * await setupTest(NAME, false);
+ * ```
+ */
 export async function setupTest(name, debug = false) {
     expect(name).toBeDefined();
     expect(typeof name).toBe('string');
     expect(name.length).toBeGreaterThanOrEqual(4);
     NAME = name;
     HOMEDIR = path.join('temp', name);
-    log = new AnsiLogger({ logName: 'Jest', logTimestampFormat: 4, logLevel: "info" });
+    // Create the AnsiLogger instance
+    log = new AnsiLogger({ logName: 'Jest', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
+    // Cleanup any existing home directory
     rmSync(HOMEDIR, { recursive: true, force: true });
     const { jest } = await import('@jest/globals');
     loggerDebugSpy = jest.spyOn(AnsiLogger.prototype, 'debug');
@@ -50,6 +93,23 @@ export async function setupTest(name, debug = false) {
         consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
     }
 }
+/**
+ * Set or unset the debug mode.
+ *
+ * @param {boolean} debug If true, the logging is not mocked.
+ * @returns {Promise<void>} A promise that resolves when the debug mode is set.
+ *
+ * @example
+ * ```typescript
+ * // Set the debug mode in test environment
+ * await setDebug(true);
+ * ```
+ *
+ * ```typescript
+ * // Reset the debug mode in test environment
+ * await setDebug(false);
+ * ```
+ */
 export async function setDebug(debug) {
     const { jest } = await import('@jest/globals');
     if (debug) {
@@ -75,3 +135,4 @@ export async function setDebug(debug) {
         consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
     }
 }
+//# sourceMappingURL=jestHelpers.js.map

package/packages/jest-utils/dist/jestHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jestHelpers.js","sourceRoot":"","sources":["../src/jestHelpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,gCAAgC;AAChC,OAAO,EAAE,UAAU,EAA6B,MAAM,kBAAkB,CAAC;AAEzE,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AACpE,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,EAAwC,CAAC,CAAC;AAE1G,wBAAwB;AACxB,MAAM,CAAC,IAAI,YAAiE,CAAC;AAC7E,MAAM,CAAC,IAAI,cAAqE,CAAC;AACjF,MAAM,CAAC,IAAI,aAAmE,CAAC;AAC/E,MAAM,CAAC,IAAI,eAAuE,CAAC;AACnF,MAAM,CAAC,IAAI,aAAmE,CAAC;AAC/E,MAAM,CAAC,IAAI,cAAqE,CAAC;AACjF,MAAM,CAAC,IAAI,cAAqE,CAAC;AAEjF,yBAAyB;AACzB,MAAM,CAAC,IAAI,aAAqD,CAAC;AACjE,MAAM,CAAC,IAAI,eAAuD,CAAC;AACnE,MAAM,CAAC,IAAI,cAAsD,CAAC;AAClE,MAAM,CAAC,IAAI,cAAsD,CAAC;AAClE,MAAM,CAAC,IAAI,eAAuD,CAAC;AAEnE,MAAM,CAAC,IAAI,IAAY,CAAC;AACxB,MAAM,CAAC,IAAI,OAAe,CAAC;AAC3B,MAAM,CAAC,IAAI,GAAe,CAAC;AAE3B;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,IAAY,EAAE,QAAiB,KAAK;IAClE,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IAC3B,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAC9C,IAAI,GAAG,IAAI,CAAC;IACZ,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAElC,iCAAiC;IACjC,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,4BAAe,EAAE,CAAC,CAAC;IAEpH,sCAAsC;IACtC,MAAM,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAElD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC;IAC/C,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC3D,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IACzD,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC7D,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IACzD,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC3D,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC3D,IAAI,KAAK,EAAE,CAAC;QACV,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACvD,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC3C,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/C,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7C,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7C,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;SAAM,CAAC;QACN,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACpF,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACxE,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC5E,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC1E,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC1E,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,KAAc;IAC3C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC;IAC/C,IAAI,KAAK,EAAE,CAAC;QACV,YAAY,CAAC,WAAW,EAAE,CAAC;QAC3B,aAAa,CAAC,WAAW,EAAE,CAAC;QAC5B,eAAe,CAAC,WAAW,EAAE,CAAC;QAC9B,cAAc,CAAC,WAAW,EAAE,CAAC;QAC7B,cAAc,CAAC,WAAW,EAAE,CAAC;QAC7B,eAAe,CAAC,WAAW,EAAE,CAAC;QAC9B,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACvD,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC3C,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/C,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7C,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7C,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;SAAM,CAAC;QACN,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACpF,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACxE,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC5E,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC1E,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC1E,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;AACH,CAAC"}

package/packages/utils/dist/colorUtils.d.ts

@@ -1,3 +1,26 @@
+/**
+ * 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;
@@ -12,13 +35,67 @@ 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/packages/utils/dist/colorUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorUtils.d.ts","sourceRoot":"","sources":["../src/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/packages/utils/dist/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/packages/utils/dist/colorUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorUtils.js","sourceRoot":"","sources":["../src/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/packages/utils/dist/commandLine.d.ts

@@ -1,6 +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/packages/utils/dist/commandLine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandLine.d.ts","sourceRoot":"","sources":["../src/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"}

package/packages/utils/dist/commandLine.js

@@ -1,4 +1,33 @@
+/**
+ * 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}`);
@@ -6,11 +35,23 @@ 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}`);
@@ -20,6 +61,12 @@ 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)
@@ -29,6 +76,12 @@ 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}`);
@@ -46,6 +99,12 @@ 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}`);
@@ -61,3 +120,4 @@ export function getStringArrayParameter(name) {
         return undefined;
     return values;
 }
+//# sourceMappingURL=commandLine.js.map

package/packages/utils/dist/commandLine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandLine.js","sourceRoot":"","sources":["../src/commandLine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/C,IAAI,cAAc,GAAG,gBAAgB,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAC3D,IAAI,CAAC,cAAc;QAAE,cAAc,GAAG,gBAAgB,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC7E,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,GAAG,MAAgB;IACjD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/C,IAAI,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IACvD,IAAI,WAAW,KAAK,CAAC,CAAC;QAAE,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC5E,IAAI,WAAW,KAAK,CAAC,CAAC,IAAI,WAAW,GAAG,CAAC,KAAK,gBAAgB,CAAC,MAAM,IAAI,gBAAgB,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAC7I,OAAO,gBAAgB,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;QAAE,OAAO,SAAS,CAAC;IAC/C,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/C,IAAI,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IACxD,IAAI,WAAW,GAAG,CAAC;QAAE,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IACxE,IAAI,WAAW,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACtC,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,KAAK,IAAI,CAAC,GAAG,WAAW,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACvG,MAAM,QAAQ,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACnD,IAAI,aAAa,CAAC,QAAQ,CAAC;YAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC7C,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAY;IAClD,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/C,IAAI,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IACxD,IAAI,WAAW,GAAG,CAAC;QAAE,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IACxE,IAAI,WAAW,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACtC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,IAAI,CAAC,GAAG,WAAW,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACvG,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/packages/utils/dist/copyDirectory.d.ts

@@ -1,2 +1,35 @@
+/**
+ * This file contains the copyDirectory function.
+ *
+ * @file copyDirectory.ts
+ * @author Luca Liguori
+ * @created 2025-02-16
+ * @version 1.0.2
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 import { AnsiLogger } from 'node-ansi-logger';
+/**
+ * Copies a directory and all its subdirectories and files to a new location.
+ *
+ * @param {string} srcDir - The path to the source directory.
+ * @param {string} destDir - The path to the destination directory.
+ * @param {AnsiLogger} [log] - Optional AnsiLogger instance for logging.
+ * @returns {Promise<boolean>} - A promise that resolves when the copy operation is complete or fails for error.
+ * @throws {Error} - Throws an error if the copy operation fails.
+ */
 export declare function copyDirectory(srcDir: string, destDir: string, log?: AnsiLogger): Promise<boolean>;
+//# sourceMappingURL=copyDirectory.d.ts.map

package/packages/utils/dist/copyDirectory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copyDirectory.d.ts","sourceRoot":"","sources":["../src/copyDirectory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C;;;;;;;;GAQG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CA6CvG"}