matterbridge 3.1.7 → 3.1.8-dev-20250725-d6e57e3

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,35 +85,23 @@ 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;
     }
     return { r: Math.round(red), g: Math.round(green), b: Math.round(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;
@@ -175,7 +111,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;
@@ -199,46 +135,19 @@ 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);
 }
-/**
- * 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);
 }
-/**
- * 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;
     }
@@ -247,7 +156,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;
@@ -258,7 +166,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;
     }
@@ -272,171 +179,3 @@ export function kelvinToRGB(kelvin) {
     }
     return { r: Math.round(r), g: Math.round(g), b: Math.round(b) };
 }
-/*
-export function testColors(): void {
-  // this table has been checked with different apps and sites and is correct 100%
-  const colors = [
-    { name: 'Pure Red          0', hsl: { h: 0, s: 100, l: 50 }, rgb: { r: 255, g: 0, b: 0 }, xy: { x: 0.7006, y: 0.2993 } },
-    { name: 'Bright Orange    30', hsl: { h: 30, s: 100, l: 50 }, rgb: { r: 255, g: 128, b: 0 }, xy: { x: 0.6112, y: 0.375 } },
-    { name: 'Pure Yellow      60', hsl: { h: 60, s: 100, l: 50 }, rgb: { r: 255, g: 255, b: 0 }, xy: { x: 0.4442, y: 0.5166 } },
-    { name: 'Lime Green       90', hsl: { h: 90, s: 100, l: 50 }, rgb: { r: 128, g: 255, b: 0 }, xy: { x: 0.2707, y: 0.6635 } },
-    { name: 'Pure Green      120', hsl: { h: 120, s: 100, l: 50 }, rgb: { r: 0, g: 255, b: 0 }, xy: { x: 0.1724, y: 0.7468 } },
-    { name: 'Light Sea Green 150', hsl: { h: 150, s: 100, l: 50 }, rgb: { r: 0, g: 255, b: 128 }, xy: { x: 0.1642, y: 0.5886 } },
-    { name: 'Pure Cyan       180', hsl: { h: 180, s: 100, l: 50 }, rgb: { r: 0, g: 255, b: 255 }, xy: { x: 0.1513, y: 0.3425 } },
-    { name: 'Deep Sky Blue   210', hsl: { h: 210, s: 100, l: 50 }, rgb: { r: 0, g: 128, b: 255 }, xy: { x: 0.1406, y: 0.1382 } },
-    { name: 'Pure Blue       240', hsl: { h: 240, s: 100, l: 50 }, rgb: { r: 0, g: 0, b: 255 }, xy: { x: 0.1355, y: 0.0399 } },
-    { name: 'Blue Violet     270', hsl: { h: 270, s: 100, l: 50 }, rgb: { r: 128, g: 0, b: 255 }, xy: { x: 0.2181, y: 0.0778 } },
-    { name: 'Pure Magenta    300', hsl: { h: 300, s: 100, l: 50 }, rgb: { r: 255, g: 0, b: 255 }, xy: { x: 0.3855, y: 0.1546 } },
-    { name: 'Deep Pink       330', hsl: { h: 330, s: 100, l: 50 }, rgb: { r: 255, g: 0, b: 128 }, xy: { x: 0.5797, y: 0.2438 } },
-
-    { name: 'Pure Red        50%   0', hsl: { h: 0, s: 50, l: 50 }, rgb: { r: 192, g: 64, b: 64 }, xy: { x: 0.6036, y: 0.3069 } },
-    { name: 'Bright Orange   50%  30', hsl: { h: 30, s: 50, l: 50 }, rgb: { r: 192, g: 128, b: 64 }, xy: { x: 0.5194, y: 0.3928 } },
-    { name: 'Pure Yellow     50%  60', hsl: { h: 60, s: 50, l: 50 }, rgb: { r: 192, g: 192, b: 64 }, xy: { x: 0.4258, y: 0.4883 } },
-    { name: 'Lime Green      50%  90', hsl: { h: 90, s: 50, l: 50 }, rgb: { r: 128, g: 192, b: 64 }, xy: { x: 0.3159, y: 0.5639 } },
-    { name: 'Pure Green      50% 120', hsl: { h: 120, s: 50, l: 50 }, rgb: { r: 64, g: 192, b: 64 }, xy: { x: 0.2127, y: 0.6349 } },
-    { name: 'Light Sea Green 50% 150', hsl: { h: 150, s: 50, l: 50 }, rgb: { r: 64, g: 192, b: 128 }, xy: { x: 0.1932, y: 0.4845 } },
-    { name: 'Pure Cyan       50% 180', hsl: { h: 180, s: 50, l: 50 }, rgb: { r: 64, g: 192, b: 192 }, xy: { x: 0.1745, y: 0.3407 } },
-    { name: 'Deep Sky Blue   50% 210', hsl: { h: 210, s: 50, l: 50 }, rgb: { r: 64, g: 128, b: 192 }, xy: { x: 0.1752, y: 0.211 } },
-    { name: 'Pure Blue       50% 240', hsl: { h: 240, s: 50, l: 50 }, rgb: { r: 64, g: 64, b: 192 }, xy: { x: 0.1758, y: 0.102 } },
-    { name: 'Blue Violet     50% 270', hsl: { h: 270, s: 50, l: 50 }, rgb: { r: 128, g: 64, b: 192 }, xy: { x: 0.2688, y: 0.137 } },
-    { name: 'Pure Magenta    50% 300', hsl: { h: 300, s: 50, l: 50 }, rgb: { r: 192, g: 64, b: 192 }, xy: { x: 0.3772, y: 0.1777 } },
-    { name: 'Deep Pink       50% 330', hsl: { h: 330, s: 50, l: 50 }, rgb: { r: 192, g: 64, b: 128 }, xy: { x: 0.489, y: 0.2416 } },
-  ];
-
-  colors.forEach((color) => {
-    // eslint-disable-next-line no-console
-    console.log(
-      `\x1b[48;2;${color.rgb.r};${color.rgb.g};${color.rgb.b}mColor: ${color.name}\x1b[0m, hsl: { h: ${color.hsl.h}, s: ${color.hsl.s}, l: ${color.hsl.l} }, rgb: { r: ${color.rgb.r}, g: ${color.rgb.g}, b: ${color.rgb.b} }, xy: { x: ${color.xy.x}, y: ${color.xy.y} }`,
-    );
-
-    const rgb = hslColorToRgbColor(color.hsl.h, color.hsl.s, color.hsl.l);
-    assert(rgb.r === color.rgb.r && rgb.g === color.rgb.g && rgb.b === color.rgb.b, `\x1b[48;2;${rgb.r};${rgb.g};${rgb.b}mColor: ${color.name}\x1b[0m hslColorToRgbColor { r: ${rgb.r}, g: ${rgb.g}, b: ${rgb.b} } conversion error`);
-
-    const hsl = rgbColorToHslColor({ r: color.rgb.r, g: color.rgb.g, b: color.rgb.b });
-    assert(hsl.h === color.hsl.h && hsl.s === color.hsl.s && hsl.l === color.hsl.l, `Color: ${color.name} rgbColorToHslColor conversion error`);
-
-    const xy = rgbColorToXYColor({ r: color.rgb.r, g: color.rgb.g, b: color.rgb.b });
-    assert(xy.x === color.xy.x && xy.y === color.xy.y, `Color: ${color.name} rgbColorToXYColor conversion error got x ${xy.x} y ${xy.y}`);
-
-    const rgb2 = xyColorToRgbColor(color.xy.x, color.xy.y);
-    assert(
-      rgb2.r === color.rgb.r && rgb2.g === color.rgb.g && rgb2.b === color.rgb.b,
-      `\x1b[48;2;${rgb2.r};${rgb2.g};${rgb2.b}mColor: ${color.name}\x1b[0m xyColorToRgbColor(${color.xy.x}, ${color.xy.y}) conversion error -> r: ${rgb2.r} g: ${rgb2.g} b: ${rgb2.g}`,
-    );
-  });
-}
-*/
-/**
- * Converts CIE color space to RGB color space
- *
- * @param {number} x
- * @param {number} y
- * @param {number} brightness - Ranges from 1 to 254
- * @returns {Array} Array that contains the color values for red, green and blue
- * From: https://github.com/usolved/cie-rgb-converter/blob/master/cie_rgb_converter.js
- */
-/*
-export function cie_to_rgb(x: number, y: number, brightness = 254): RGB {
-  // Set to maximum brightness if no custom value was given (Not the slick ECMAScript 6 way for compatibility reasons)
-
-  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;
-    red = 1.0;
-  } else if (green > blue && green > red && green > 1.0) {
-    red = red / green;
-    blue = blue / green;
-    green = 1.0;
-  } else if (blue > red && blue > green && blue > 1.0) {
-    red = red / blue;
-    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
-  if (isNaN(red) || red < 0) {
-    red = 0;
-  }
-  if (isNaN(green) || green < 0) {
-    green = 0;
-  }
-  if (isNaN(blue) || blue < 0) {
-    blue = 0;
-  }
-
-  return { r: red, g: green, b: blue };
-}
-*/
-/**
- * Converts RGB color space to CIE color space
- *
- * @param {number} red
- * @param {number} green
- * @param {number} blue
- * @returns {Array} Array that contains the CIE color values for x and y
- * From: https://github.com/usolved/cie-rgb-converter/blob/master/cie_rgb_converter.js
- */
-/*
-export function rgb_to_cie(red: number, green: number, blue: number): XY {
-  // Apply a gamma correction to the RGB values, which makes the color more vivid and more the like the color displayed on the screen of your device
-  red = red > 0.04045 ? Math.pow((red + 0.055) / (1.0 + 0.055), 2.4) : red / 12.92;
-  green = green > 0.04045 ? Math.pow((green + 0.055) / (1.0 + 0.055), 2.4) : green / 12.92;
-  blue = blue > 0.04045 ? Math.pow((blue + 0.055) / (1.0 + 0.055), 2.4) : blue / 12.92;
-
-  // RGB values to XYZ using the Wide RGB D65 conversion formula
-  const X = red * 0.664511 + green * 0.154324 + blue * 0.162028;
-  const Y = red * 0.283881 + green * 0.668433 + blue * 0.047685;
-  const Z = red * 0.000088 + green * 0.07231 + blue * 0.986039;
-
-  // Calculate the xy values from the XYZ values
-  let x = (X / (X + Y + Z)).toFixed(4);
-  let y = (Y / (X + Y + Z)).toFixed(4);
-
-  if (isNaN(Number(x))) {
-    x = '0';
-  }
-
-  if (isNaN(Number(y))) {
-    y = '0';
-  }
-
-  return { x: Number(x), y: Number(y) };
-}
-*/
-/*
-testColors();
-console.log('rgb_to_cie(0, 128, 255)', rgb_to_cie(0, 128, 255));
-console.log('cie_to_rgb(0.1401, 0.1284, 254)', cie_to_rgb(0.1401, 0.1284, 254));
-console.log('cie_to_rgb(0.1406, 0.1382, 254)', cie_to_rgb(0.1406, 0.1382, 254));
-for (let h = 0; h < 360; h++) {
-  const rgb = hslColorToRgbColor(h, 100, 50);
-  const xy = rgbColorToXYColor({ r: rgb.r, g: rgb.g, b: rgb.b });
-  const rgb2 = cie_to_rgb(xy.x, xy.y, 254);
-  const hsl = rgbColorToHslColor({ r: rgb2.r, g: rgb2.g, b: rgb2.b });
-  assert(rgb.r === rgb2.r && rgb.g === rgb2.g && rgb.b === rgb2.b, 'Color rgb conversion error');
-  assert(h === hsl.h, 'Color hsl conversion error');
-  console.log(`\x1b[48;2;${rgb.r};${rgb.g};${rgb.b}mColor: r:${rgb.r} g:${rgb.g} b:${rgb.b}\x1b[0m => x:${xy.x} y:${xy.y} => \x1b[48;2;${rgb2.r};${rgb2.g};${rgb2.b}mColor: r:${rgb2.r} g:${rgb2.g} b:${rgb2.b} h:${hsl.h} s:${hsl.s}\x1b[0m\x1b[K`);
-}
-*/
-//# sourceMappingURL=colorUtils.js.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 './export.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,12 +6,6 @@ export function hasParameter(name) {
         markerIncluded = commandArguments.includes(`--${name}`);
     return markerIncluded;
 }
-/**
- * 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}`);
@@ -50,12 +15,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)
@@ -65,12 +24,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}`);
@@ -88,12 +41,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}`);
@@ -109,4 +56,3 @@ export function getStringArrayParameter(name) {
         return undefined;
     return values;
 }
-//# sourceMappingURL=commandLine.js.map

package/dist/utils/copyDirectory.js

@@ -1,36 +1,4 @@
-/**
- * This file contains the copyDirectory function.
- *
- * @file copyDirectory.ts
- * @author Luca Liguori
- * @created 2025-02-16
- * @version 1.0.1
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-// AnsiLogger module
 import { AnsiLogger } from '../logger/export.js';
-/**
- * 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.
- * @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 async function copyDirectory(srcDir, destDir) {
     if (srcDir === '') {
         throw new Error('Source directory must be specified.');
@@ -47,24 +15,20 @@ export async function copyDirectory(srcDir, destDir) {
     if (srcDir === destDir) {
         throw new Error('Source and destination directories must be different.');
     }
-    const log = new AnsiLogger({ logName: 'Archive', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
+    const log = new AnsiLogger({ logName: 'Archive', logTimestampFormat: 4, logLevel: "info" });
     const fs = await import('node:fs').then((mod) => mod.promises);
     const path = await import('node:path');
     log.debug(`copyDirectory: copying directory from ${srcDir} to ${destDir}`);
     try {
-        // Create destination directory if it doesn't exist
         await fs.mkdir(destDir, { recursive: true });
-        // Read contents of the source directory
         const entries = await fs.readdir(srcDir, { withFileTypes: true });
         for (const entry of entries) {
             const srcPath = path.join(srcDir, entry.name);
             const destPath = path.join(destDir, entry.name);
             if (entry.isDirectory()) {
-                // Recursive call if entry is a directory
                 await copyDirectory(srcPath, destPath);
             }
             else if (entry.isFile()) {
-                // Copy file if entry is a file
                 await fs.copyFile(srcPath, destPath);
             }
         }
@@ -75,4 +39,3 @@ export async function copyDirectory(srcDir, destDir) {
         return false;
     }
 }
-//# sourceMappingURL=copyDirectory.js.map

package/dist/utils/createDirectory.js

@@ -1,36 +1,4 @@
-/**
- * This file contains the createDirectory function.
- *
- * @file createDirectory.ts
- * @author Luca Liguori
- * @created 2025-06-08
- * @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.
- */
-// Node.js modules
 import { promises as fs } from 'node:fs';
-/**
- * Creates a directory at the specified path if it doesn't already exist.
- *
- * @param {string} path - The path to the directory to create.
- * @param {string} name - The name of the directory.
- * @param {Logger} log - The logger instance to use for logging messages.
- * @returns {Promise<void>} A promise that resolves when the directory has been created or already exists.
- */
 export async function createDirectory(path, name, log) {
     try {
         await fs.access(path);
@@ -51,4 +19,3 @@ export async function createDirectory(path, name, log) {
         }
     }
 }
-//# sourceMappingURL=createDirectory.js.map

package/dist/utils/createZip.js

@@ -1,44 +1,6 @@
-/**
- * This file contains the createZip function.
- *
- * @file createZip.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.
- */
-// AnsiLogger module
 import { AnsiLogger } from '../logger/export.js';
-/**
- * Creates a ZIP archive from the specified source pattern or directory and writes it to the specified output path.
- *
- * @param {string} outputPath - The path where the output ZIP file will be written.
- * @param {string[]} sourcePaths - The source pattern or directory to be zipped (use path.join for sourcePath).
- * @returns {Promise<number>} - A promise that resolves to the total number of bytes written to the ZIP file.
- *
- * @remarks
- * This function uses the `archiver` library to create a ZIP archive. It sets the compression level to 9 (maximum compression).
- * The function ensures that the output file is properly closed after the archiving process is complete.
- * It logs the progress and the total number of bytes written to the console.
- *
- * This function uses the `glob` library to match files based on the source pattern (internally converted in posix).
- */
 export async function createZip(outputPath, ...sourcePaths) {
-    const log = new AnsiLogger({ logName: 'Archive', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
+    const log = new AnsiLogger({ logName: 'Archive', logTimestampFormat: 4, logLevel: "info" });
     const { default: archiver } = await import('archiver');
     const { glob } = await import('glob');
     const { createWriteStream, statSync } = await import('node:fs');
@@ -47,22 +9,19 @@ export async function createZip(outputPath, ...sourcePaths) {
     return new Promise((resolve, reject) => {
         const output = createWriteStream(outputPath);
         const archive = archiver('zip', {
-            zlib: { level: 9 }, // Set compression level
+            zlib: { level: 9 },
         });
         output.on('close', () => {
             log.debug(`archive ${outputPath} closed with ${archive.pointer()} total bytes`);
             resolve(archive.pointer());
         });
-        /* istanbul ignore next */
         output.on('end', () => {
             log.debug(`archive ${outputPath} data has been drained ${archive.pointer()} total bytes`);
         });
-        /* istanbul ignore next */
         archive.on('error', (error) => {
             log.error(`archive error: ${error.message}`);
             reject(error);
         });
-        /* istanbul ignore next */
         archive.on('warning', (error) => {
             if (error.code === 'ENOENT') {
                 log.warn(`archive warning: ${error.message}`);
@@ -77,7 +36,6 @@ export async function createZip(outputPath, ...sourcePaths) {
         });
         archive.pipe(output);
         for (const sourcePath of sourcePaths) {
-            // Check if the sourcePath is a file or directory
             let stats;
             try {
                 stats = statSync(sourcePath);
@@ -92,7 +50,6 @@ export async function createZip(outputPath, ...sourcePaths) {
                     }
                 }
                 else {
-                    /* istanbul ignore next */
                     log.error(`no files or directory found for pattern ${sourcePath}: ${error}`);
                 }
                 continue;
@@ -106,9 +63,7 @@ export async function createZip(outputPath, ...sourcePaths) {
                 archive.directory(sourcePath, path.basename(sourcePath));
             }
         }
-        // Finalize the archive (i.e., we are done appending files but streams have to finish yet)
         log.debug(`finalizing archive ${outputPath}...`);
         archive.finalize().catch(reject);
     });
 }
-//# sourceMappingURL=createZip.js.map