nhb-toolbox 3.9.39 → 3.9.60

package/dist/colors/Color.d.ts

@@ -4,24 +4,47 @@ import type { AlphaColors, ColorType, Hex6, Hex8, HSL, HSLA, OpacityValue, RGB,
  * * It has 1 instance method `applyOpacity()` to apply opacity to `Hex`, `Hex8` `RGB`, `RGBA`, `HSL` or `HSLA` color.
  * * It has 6 static methods that can be used to check if a color is in `Hex`, `Hex8` `RGB`, `RGBA`, `HSL` or `HSLA` format.
  *
- * @property {Hex} hex - The color in `Hex` format.
- * @property {Hex8} hex8 - The color in `Hex8` format.
- * @property {RGB} rgb - The color in `RGB` format.
- * @property {RGBA} rgba - The color in `RGBA` format.
- * @property {HSL} hsl - The color in `HSL` format.
- * @property {HSLA} hsla - The color in `HSLA` format.
+ * @property hex - The color in `Hex` format.
+ * @property hex8 - The color in `Hex8` format.
+ * @property rgb - The color in `RGB` format.
+ * @property rgba - The color in `RGBA` format.
+ * @property hsl - The color in `HSL` format.
+ * @property hsla - The color in `HSLA` format.
  */
 export declare class Color {
+    #private;
     hex: Hex6;
     hex8: Hex8;
     rgb: RGB;
     rgba: RGBA;
     hsl: HSL;
     hsla: HSLA;
-    /** - Iterates over the color representations (Hex, RGB, HSL). */
-    [Symbol.iterator](): Generator<Hex6 | RGB | HSL | Hex8 | RGBA | HSLA, void, unknown>;
     /**
-     * * Creates a new `Color` instance and automatically converts the input color to all other supported formats: `Hex`, `Hex8`, `RGB`, `RGBA`, `HSL`, and `HSLA`.
+     * * Creates a new `Color` instance with a random color and automatically converts the generated color to all other supported formats: `Hex`, `Hex8`, `RGB`, `RGBA`, `HSL`, and `HSLA`.
+     *
+     * @description
+     * The `Color` class generates a random color in six common color representations:
+     * - `Hex` (e.g., `#ff5733`)
+     * - `Hex8` (Hex with opacity, e.g., `#ff573380`)
+     * - `RGB` (e.g., `rgb(255, 87, 51)`)
+     * - `RGBA` (e.g., `rgba(255, 87, 51, 1)`)
+     * - `HSL` (e.g., `hsl(14, 100%, 60%)`)
+     * - `HSLA` (e.g., `hsla(14, 100%, 60%, 1)`)
+     *
+     * Additionally:
+     * - Use `.applyOpacity(opacity)` to modify or add opacity to the color.
+     * - Use static methods like `Color.isHex6(color)` to validate color strings.
+     *
+     * @example
+     * // Generate a random color
+     * const randomColor = new Color();
+     * console.log(randomColor.hex, randomColor.rgb, randomColor.hsl);
+     *
+     * @returns Instance of `Color`.
+     */
+    constructor();
+    /**
+     * * Creates a new `Color` instance with the input color and automatically converts it to all other supported formats: `Hex`, `Hex8`, `RGB`, `RGBA`, `HSL`, and `HSLA`.
      *
      * @description
      * The `Color` class allows seamless transformation between six common color representations:
@@ -33,13 +56,12 @@ export declare class Color {
      * - `HSLA` (e.g., `hsla(14, 100%, 60%, 1)`)
      *
      * You can create a color from any of these formats, and the class will populate the rest.
-     * If no color is passed, a random color will be generated.
      *
      * Additionally:
      * - Use `.applyOpacity(opacity)` to modify or add opacity to the color.
-     * - Use static methods like `Color.isHex6(color)` to validate color strings.
+     * - Use available 6 static methods like `Color.isHex6(color)` to validate color strings.
      *
-     * @param toConvert - An optional input color string in any supported format (`Hex`, `Hex8`, `RGB`, `RGBA`, `HSL`, or `HSLA`) to convert in all other (includes the current format) formats.
+     * @param toConvert - A color string in any supported format (`Hex`, `Hex8`, `RGB`, `RGBA`, `HSL`, or `HSLA`) to convert in all other formats (includes the current format).
      *
      * @example
      * // Convert an existing Hex color to all other formats
@@ -56,12 +78,11 @@ export declare class Color {
      * console.log(alphaColor.hex8); // '#FF000080'
      * console.log(alphaColor.hsla); // 'hsla(0, 100%, 50%, 0.5)'
      *
-     * @example
-     * // Generate a random color
-     * const randomColor = new Color();
-     * console.log(randomColor.hex, randomColor.rgb, randomColor.hsl);
+     * @returns Instance of `Color`.
      */
-    constructor(toConvert?: ColorType);
+    constructor(toConvert: ColorType);
+    /** - Iterates over the color representations (Hex, RGB, HSL). */
+    [Symbol.iterator](): Generator<Hex6 | RGB | HSL | Hex8 | RGBA | HSLA, void, unknown>;
     /**
      * * Applies or modifies the opacity of a color.
      * - For solid colors (Hex6/RGB/HSL): Adds an alpha channel with the specified opacity
@@ -123,12 +144,5 @@ export declare class Color {
      * @returns Boolean: `true` if it's an `HSLA` color, `false` if not.
      */
     static isHSLA(color: string): color is HSLA;
-    /**
-     * @private Converts the given color to all other formats while preserving the original.
-     *
-     * @param color - The color to convert.
-     * @returns An object containing Hex, RGB, and HSL representations.
-     */
-    private _convertColorToOthers;
 }
 //# sourceMappingURL=Color.d.ts.map

package/dist/colors/Color.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Color.d.ts","sourceRoot":"","sources":["../../src/colors/Color.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACX,WAAW,EACX,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,YAAY,EACZ,GAAG,EACH,IAAI,EACJ,WAAW,EACX,MAAM,SAAS,CAAC;AAKjB;;;;;;;;;;;GAWG;AACH,qBAAa,KAAK;IACV,GAAG,EAAE,IAAI,CAAC;IACV,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,GAAG,CAAC;IACT,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,GAAG,CAAC;IACT,IAAI,EAAE,IAAI,CAAC;IAElB,iEAAiE;IAChE,CAAC,MAAM,CAAC,QAAQ,CAAC;IASlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;gBAES,SAAS,CAAC,EAAE,SAAS;IA2CjC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW;IAkB9D;;;;;OAKG;WACW,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI;IAIlD;;;;;OAKG;WACW,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI;IAIlD;;;;;OAKG;WACW,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,GAAG;IAIhD;;;;;OAKG;WACW,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI;IAMlD;;;;;OAKG;WACW,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,GAAG;IAIhD;;;;;OAKG;WACW,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI;IAMlD;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;CAuB7B"}
+{"version":3,"file":"Color.d.ts","sourceRoot":"","sources":["../../src/colors/Color.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACX,WAAW,EACX,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,YAAY,EACZ,GAAG,EACH,IAAI,EACJ,WAAW,EACX,MAAM,SAAS,CAAC;AAKjB;;;;;;;;;;;GAWG;AACH,qBAAa,KAAK;;IACV,GAAG,EAAE,IAAI,CAAC;IACV,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,GAAG,CAAC;IACT,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,GAAG,CAAC;IACT,IAAI,EAAE,IAAI,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;gBACS,SAAS,EAAE,SAAS;IAwFhC,iEAAiE;IAChE,CAAC,MAAM,CAAC,QAAQ,CAAC;IASlB;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW;IAkB9D;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI;IAI3C;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI;IAI3C;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,GAAG;IAIzC;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI;IAM3C;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,GAAG;IAIzC;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI;CAmC3C"}

package/dist/colors/Color.js

@@ -8,12 +8,12 @@ const { hex, rgb } = convertColorCode(hsl);
  * * It has 1 instance method `applyOpacity()` to apply opacity to `Hex`, `Hex8` `RGB`, `RGBA`, `HSL` or `HSLA` color.
  * * It has 6 static methods that can be used to check if a color is in `Hex`, `Hex8` `RGB`, `RGBA`, `HSL` or `HSLA` format.
  *
- * @property {Hex} hex - The color in `Hex` format.
- * @property {Hex8} hex8 - The color in `Hex8` format.
- * @property {RGB} rgb - The color in `RGB` format.
- * @property {RGBA} rgba - The color in `RGBA` format.
- * @property {HSL} hsl - The color in `HSL` format.
- * @property {HSLA} hsla - The color in `HSLA` format.
+ * @property hex - The color in `Hex` format.
+ * @property hex8 - The color in `Hex8` format.
+ * @property rgb - The color in `RGB` format.
+ * @property rgba - The color in `RGBA` format.
+ * @property hsl - The color in `HSL` format.
+ * @property hsla - The color in `HSLA` format.
  */
 export class Color {
     hex;
@@ -22,15 +22,6 @@ export class Color {
     rgba;
     hsl;
     hsla;
-    /** - Iterates over the color representations (Hex, RGB, HSL). */
-    *[Symbol.iterator]() {
-        yield this.hex;
-        yield this.hex8;
-        yield this.rgb;
-        yield this.rgba;
-        yield this.hsl;
-        yield this.hsla;
-    }
     /**
      * * Creates a new `Color` instance and automatically converts the input color to all other supported formats: `Hex`, `Hex8`, `RGB`, `RGBA`, `HSL`, and `HSLA`.
      *
@@ -71,10 +62,12 @@ export class Color {
      * // Generate a random color
      * const randomColor = new Color();
      * console.log(randomColor.hex, randomColor.rgb, randomColor.hsl);
+     *
+     * @returns Instance of `Color`.
      */
     constructor(toConvert) {
         if (toConvert) {
-            const colors = this._convertColorToOthers(toConvert);
+            const colors = this.#convertColorToOthers(toConvert);
             if ('hex8' in colors) {
                 // Extract alpha color values (Hex8, RGBA, HSLA)
                 const rgbaValues = _extractAlphaColorValues(colors.rgba);
@@ -112,6 +105,15 @@ export class Color {
             this.hsla = `hsla(${hslValues[0]}, ${hslValues[1]}%, ${hslValues[2]}%, 1)`;
         }
     }
+    /** - Iterates over the color representations (Hex, RGB, HSL). */
+    *[Symbol.iterator]() {
+        yield this.hex;
+        yield this.hex8;
+        yield this.rgb;
+        yield this.rgba;
+        yield this.hsl;
+        yield this.hsla;
+    }
     /**
      * * Applies or modifies the opacity of a color.
      * - For solid colors (Hex6/RGB/HSL): Adds an alpha channel with the specified opacity
@@ -205,7 +207,7 @@ export class Color {
      * @param color - The color to convert.
      * @returns An object containing Hex, RGB, and HSL representations.
      */
-    _convertColorToOthers(color) {
+    #convertColorToOthers(color) {
         if (Color.isHex6(color)) {
             const { rgb, hsl } = convertColorCode(color);
             return { hex: color, rgb, hsl };