@fluixi/utils 1.0.0-alpha.100

package/dist/lib/color/color.d.ts

@@ -0,0 +1,366 @@
+import type { ColorAdjustmentOptions, ColorSpace, ContrastOptions, PaletteOptions, ColorFormat, RGBColor, HSLColor, HSVColor, HWBColor, CMYKColor, LABColor, LCHColor, OKLABColor, OKLCHColor, XYZColor, ColorConversionOptions, ColorHarmonyOptions } from './types.js';
+import { RGB_PATTERNS } from './utils.js';
+/**
+ * Represents a color in various formats
+ */
+export type ColorRepresentation = string | number[] | RGBColor | HSLColor | HSVColor | HWBColor | CMYKColor | LABColor | LCHColor | OKLABColor | OKLCHColor | XYZColor | Color;
+/**
+ * Color class for object-oriented color manipulation
+ */
+export declare class Color {
+    private _r;
+    private _g;
+    private _b;
+    private _a;
+    /**
+     * Parse any RGB/RGBA format
+     */
+    static parseRgbString(colorString: string): [number, number, number, number] | null;
+    /**
+     * Check if string matches any RGB pattern
+     */
+    static isRgbFormat(colorString: string): boolean;
+    /**
+     * Get the specific RGB pattern that matches
+     */
+    static getRgbPatternMatch(colorString: string): keyof typeof RGB_PATTERNS | null;
+    /**
+     * Convert RGB values to modern CSS syntax
+     */
+    static toModernRgbSyntax(r: number | string, g: number | string, b: number | string, a?: number | string): string;
+    /**
+     * Convert RGB values to legacy syntax
+     */
+    static toLegacyRgbSyntax(r: number | string, g: number | string, b: number | string, a?: number | string): string;
+    /**
+     * Normalize RGB string to a consistent format
+     */
+    static normalizeRgbString(colorString: string, format?: 'modern' | 'legacy'): string | null;
+    /**
+     * Creates a new Color instance
+     * @param color - Color representation (string, array, object, or another Color)
+     */
+    constructor(color?: ColorRepresentation);
+    /**
+     * Sets the color from any representation
+     * @param color - Color representation
+     * @returns This Color instance for chaining
+     */
+    set(color: ColorRepresentation): this;
+    /**
+     * Clamps color values to valid ranges
+     * @private
+     */
+    private _clamp;
+    /**
+     * Gets the red component
+     */
+    get r(): number;
+    /**
+     * Sets the red component
+     */
+    set r(value: number);
+    /**
+     * Gets the green component
+     */
+    get g(): number;
+    /**
+     * Sets the green component
+     */
+    set g(value: number);
+    /**
+     * Gets the blue component
+     */
+    get b(): number;
+    /**
+     * Sets the blue component
+     */
+    set b(value: number);
+    /**
+     * Gets the alpha component
+     */
+    get a(): number;
+    /**
+     * Sets the alpha component
+     */
+    set a(value: number);
+    /**
+     * Gets the RGB array
+     */
+    get rgb(): [number, number, number];
+    /**
+     * Gets the RGBA array
+     */
+    get rgba(): [number, number, number, number];
+    /**
+     * Converts to hex string
+     * @returns Hex color string
+     */
+    toHex(): string;
+    /**
+     * Converts to RGB string
+     * @returns RGB color string
+     */
+    toRgb(): string;
+    /**
+     * Converts to RGBA string
+     * @returns RGBA color string
+     */
+    toRgba(): string;
+    /**
+     * Gets RGB object
+     * @returns RGB color object
+     */
+    getRgbObject(): RGBColor;
+    /**
+     * Converts to HSL string
+     * @returns HSL/HSLA color string
+     */
+    toHsl(): string;
+    /**
+     * Gets HSL object
+     * @returns HSL color object
+     */
+    getHslObject(): HSLColor;
+    /**
+     * Converts to HSV string
+     * @returns HSV/HSVA color string
+     */
+    toHsv(): string;
+    /**
+     * Gets HSV object
+     * @returns HSV color object
+     */
+    getHsvObject(): HSVColor;
+    /**
+     * Converts to HWB string
+     * @returns HWB color string
+     */
+    toHwb(): string;
+    /**
+     * Gets HWB object
+     * @returns HWB color object
+     */
+    getHwbObject(): HWBColor;
+    /**
+     * Converts to CMYK string
+     * @returns CMYK color string
+     */
+    toCmyk(): string;
+    /**
+     * Gets CMYK object
+     * @returns CMYK color object
+     */
+    getCmykObject(): CMYKColor;
+    /**
+     * Converts to XYZ string
+     * @returns XYZ color string
+     */
+    toXyz(): string;
+    /**
+     * Gets XYZ object
+     * @returns XYZ color object
+     */
+    getXyzObject(): XYZColor;
+    /**
+     * Converts to LAB string
+     * @returns LAB color string
+     */
+    toLab(): string;
+    /**
+     * Gets LAB object
+     * @returns LAB color object
+     */
+    getLabObject(): LABColor;
+    /**
+     * Converts to LCH string
+     * @returns LCH color string
+     */
+    toLch(): string;
+    /**
+     * Gets LCH object
+     * @returns LCH color object
+     */
+    getLchObject(): LCHColor;
+    /**
+     * Converts to OKLAB string
+     * @returns OKLAB color string
+     */
+    toOklab(): string;
+    /**
+     * Gets OKLAB object
+     * @returns OKLAB color object
+     */
+    getOklabObject(): OKLABColor;
+    /**
+     * Converts to OKLCH string
+     * @returns OKLCH color string
+     */
+    toOklch(): string;
+    /**
+     * Gets OKLCH object
+     * @returns OKLCH color object
+     */
+    getOklchObject(): OKLCHColor;
+    /**
+     * Adjusts the color
+     * @param options - Adjustment options
+     * @returns This Color instance for chaining
+     */
+    adjust(options: ColorAdjustmentOptions): this;
+    /**
+     * Lightens the color
+     * @param amount - Lighten amount (0-100)
+     * @returns This Color instance for chaining
+     */
+    lighten(amount: number): this;
+    /**
+     * Darkens the color
+     * @param amount - Darken amount (0-100)
+     * @returns This Color instance for chaining
+     */
+    darken(amount: number): this;
+    /**
+     * Saturates the color
+     * @param amount - Saturate amount (0-100)
+     * @returns This Color instance for chaining
+     */
+    saturate(amount: number): this;
+    /**
+     * Desaturates the color
+     * @param amount - Desaturate amount (0-100)
+     * @returns This Color instance for chaining
+     */
+    desaturate(amount: number): this;
+    /**
+     * Rotates the hue
+     * @param degrees - Hue rotation in degrees
+     * @returns This Color instance for chaining
+     */
+    rotate(degrees: number): this;
+    /**
+     * Sets the alpha value
+     * @param alpha - Alpha value (0-1)
+     * @returns This Color instance for chaining
+     */
+    alpha(alpha: number): this;
+    /**
+     * Mixes with another color
+     * @param color - Color to mix with
+     * @param percentage - Mix percentage (0-100)
+     * @param colorSpace - Color space for mixing
+     * @returns This Color instance for chaining
+     */
+    mix(color: string, percentage?: number, colorSpace?: ColorSpace): this;
+    /**
+     * Gets the contrasting color
+     * @param options - Contrast options
+     * @returns Contrasting Color instance
+     */
+    getContrastColor(options?: ContrastOptions): Color;
+    /**
+     * Gets the relative luminance
+     * @returns Relative luminance (0-1)
+     */
+    getLuminance(): number;
+    /**
+     * Calculates contrast ratio with another color
+     * @param color - Color to compare with
+     * @returns Contrast ratio (1-21)
+     */
+    getContrastRatio(color: string | Color): number;
+    /**
+     * Generates a palette from this color
+     * @param options - Palette options
+     * @returns Object with color shades
+     */
+    getPalette(options?: PaletteOptions): Record<string, string>;
+    /**
+     * Clones the color
+     * @returns New Color instance with same values
+     */
+    clone(): Color;
+    /**
+     * Converts to string in specified format
+     * @param format - Output format
+     * @returns Color string
+     */
+    toString(format?: ColorFormat): string;
+    /**
+     * Convert to any format with options
+     * @param format - Target format
+     * @param options - Conversion options
+     * @returns Converted color object
+     */
+    convertTo(format: ColorFormat, options?: ColorConversionOptions): any;
+    /**
+     * Set color from any color space object
+     * @param color - Color object in any supported format
+     * @returns This Color instance for chaining
+     */
+    setFromObject(color: RGBColor | HSLColor | HSVColor | HWBColor | CMYKColor | LABColor | LCHColor | OKLABColor | OKLCHColor | XYZColor): this;
+    /**
+     * Get color harmony colors
+     * @param options - Harmony options
+     * @returns Array of Color instances
+     */
+    getHarmony(options?: ColorHarmonyOptions): Color[];
+    /**
+     * Get supported color formats
+     * @returns Array of supported format names
+     */
+    static getSupportedFormats(): string[];
+    /**
+     * Check if format is valid
+     * @param format - Format to check
+     * @returns True if format is supported
+     */
+    static isValidFormat(format: string): boolean;
+    /**
+     * Get conversion path between formats
+     * @param from - Source format
+     * @param to - Target format
+     * @returns Array of formats in conversion path
+     */
+    static getConversionPath(from: string, to: string): string[] | null;
+    /**
+     * Checks if the color is valid
+     * @returns True if color is valid
+     */
+    isValid(): boolean;
+    /**
+     * Creates a Color instance from string
+     * @param color - Color string
+     * @returns Color instance or null if invalid
+     */
+    static fromString(color: string): Color | null;
+    /**
+     * Creates a random Color
+     * @returns Random Color instance
+     */
+    static random(): Color;
+    /**
+     * Predefined colors
+     */
+    static get transparent(): Color;
+    static get white(): Color;
+    static get black(): Color;
+    static get red(): Color;
+    static get green(): Color;
+    static get blue(): Color;
+    static get yellow(): Color;
+    static get cyan(): Color;
+    static get magenta(): Color;
+    static get gray(): Color;
+    static get lightGray(): Color;
+    static get darkGray(): Color;
+    static get orange(): Color;
+    static get purple(): Color;
+    static get pink(): Color;
+    static get brown(): Color;
+    static get teal(): Color;
+    static get lime(): Color;
+    static get indigo(): Color;
+    static get violet(): Color;
+}
+//# sourceMappingURL=color.d.ts.map

package/dist/lib/color/color.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../../src/lib/color/color.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,sBAAsB,EACtB,UAAU,EACV,eAAe,EACf,cAAc,EACd,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,UAAU,EACV,QAAQ,EACR,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EAWL,YAAY,EAKb,MAAM,YAAY,CAAC;AA0BpB;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,MAAM,GACN,MAAM,EAAE,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,UAAU,GACV,QAAQ,GACR,KAAK,CAAC;AAEV;;GAEG;AACH,qBAAa,KAAK;IAChB,OAAO,CAAC,EAAE,CAAa;IACvB,OAAO,CAAC,EAAE,CAAa;IACvB,OAAO,CAAC,EAAE,CAAa;IACvB,OAAO,CAAC,EAAE,CAAa;IACvB;;OAEG;IACH,MAAM,CAAC,cAAc,CACnB,WAAW,EAAE,MAAM,GAClB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAI1C;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAMhD;;OAEG;IACH,MAAM,CAAC,kBAAkB,CACvB,WAAW,EAAE,MAAM,GAClB,MAAM,OAAO,YAAY,GAAG,IAAI;IAUnC;;OAEG;IACH,MAAM,CAAC,iBAAiB,CACtB,CAAC,EAAE,MAAM,GAAG,MAAM,EAClB,CAAC,EAAE,MAAM,GAAG,MAAM,EAClB,CAAC,EAAE,MAAM,GAAG,MAAM,EAClB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAClB,MAAM;IAQT;;OAEG;IACH,MAAM,CAAC,iBAAiB,CACtB,CAAC,EAAE,MAAM,GAAG,MAAM,EAClB,CAAC,EAAE,MAAM,GAAG,MAAM,EAClB,CAAC,EAAE,MAAM,GAAG,MAAM,EAClB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAClB,MAAM;IAQT;;OAEG;IACH,MAAM,CAAC,kBAAkB,CACvB,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,QAAQ,GAAG,QAAmB,GACrC,MAAM,GAAG,IAAI;IAYhB;;;OAGG;gBACS,KAAK,GAAE,mBAA+B;IAIlD;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAwBrC;;;OAGG;IACH,OAAO,CAAC,MAAM;IAOd;;OAEG;IACH,IAAI,CAAC,IAAI,MAAM,CAEd;IAED;;OAEG;IACH,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAGlB;IAED;;OAEG;IACH,IAAI,CAAC,IAAI,MAAM,CAEd;IAED;;OAEG;IACH,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAGlB;IAED;;OAEG;IACH,IAAI,CAAC,IAAI,MAAM,CAEd;IAED;;OAEG;IACH,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAGlB;IAED;;OAEG;IACH,IAAI,CAAC,IAAI,MAAM,CAEd;IAED;;OAEG;IACH,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAGlB;IAED;;OAEG;IACH,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAElC;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAE3C;IAED;;;OAGG;IACH,KAAK,IAAI,MAAM;IAIf;;;OAGG;IACH,KAAK,IAAI,MAAM;IAIf;;;OAGG;IACH,MAAM,IAAI,MAAM;IAIhB;;;OAGG;IACH,YAAY,IAAI,QAAQ;IAIxB;;;OAGG;IACH,KAAK,IAAI,MAAM;IAIf;;;OAGG;IACH,YAAY,IAAI,QAAQ;IAIxB;;;OAGG;IACH,KAAK,IAAI,MAAM;IAIf;;;OAGG;IACH,YAAY,IAAI,QAAQ;IAIxB;;;OAGG;IACH,KAAK,IAAI,MAAM;IAQf;;;OAGG;IACH,YAAY,IAAI,QAAQ;IAIxB;;;OAGG;IACH,MAAM,IAAI,MAAM;IAIhB;;;OAGG;IACH,aAAa,IAAI,SAAS;IAI1B;;;OAGG;IACH,KAAK,IAAI,MAAM;IAQf;;;OAGG;IACH,YAAY,IAAI,QAAQ;IAIxB;;;OAGG;IACH,KAAK,IAAI,MAAM;IAQf;;;OAGG;IACH,YAAY,IAAI,QAAQ;IAIxB;;;OAGG;IACH,KAAK,IAAI,MAAM;IAQf;;;OAGG;IACH,YAAY,IAAI,QAAQ;IAIxB;;;OAGG;IACH,OAAO,IAAI,MAAM;IAQjB;;;OAGG;IACH,cAAc,IAAI,UAAU;IAI5B;;;OAGG;IACH,OAAO,IAAI,MAAM;IAQjB;;;OAGG;IACH,cAAc,IAAI,UAAU;IAI5B;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI;IAM7C;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI7B;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI5B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI9B;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIhC;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI7B;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK1B;;;;;;OAMG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,UAAU,GAAE,MAAW,EACvB,UAAU,GAAE,UAAmB,GAC9B,IAAI;IAWP;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,GAAE,eAAoB,GAAG,KAAK;IAKtD;;;OAGG;IACH,YAAY,IAAI,MAAM;IAItB;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM;IAK/C;;;;OAIG;IACH,UAAU,CAAC,OAAO,GAAE,cAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAIhE;;;OAGG;IACH,KAAK,IAAI,KAAK;IAId;;;;OAIG;IACH,QAAQ,CAAC,MAAM,GAAE,WAAmB,GAAG,MAAM;IAmC7C;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,GAAE,sBAA2B,GAAG,GAAG;IAIzE;;;;OAIG;IACH,aAAa,CACX,KAAK,EACD,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,UAAU,GACV,QAAQ,GACX,IAAI;IAmCP;;;;OAIG;IACH,UAAU,CAAC,OAAO,GAAE,mBAAwB,GAAG,KAAK,EAAE;IA6EtD;;;OAGG;IACH,MAAM,CAAC,mBAAmB,IAAI,MAAM,EAAE;IAItC;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAI7C;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAInE;;;OAGG;IACH,OAAO,IAAI,OAAO;IAIlB;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI;IAO9C;;;OAGG;IACH,MAAM,CAAC,MAAM,IAAI,KAAK;IAOtB;;OAEG;IACH,MAAM,KAAK,WAAW,IAAI,KAAK,CAE9B;IAED,MAAM,KAAK,KAAK,IAAI,KAAK,CAExB;IAED,MAAM,KAAK,KAAK,IAAI,KAAK,CAExB;IAED,MAAM,KAAK,GAAG,IAAI,KAAK,CAEtB;IAED,MAAM,KAAK,KAAK,IAAI,KAAK,CAExB;IAED,MAAM,KAAK,IAAI,IAAI,KAAK,CAEvB;IAED,MAAM,KAAK,MAAM,IAAI,KAAK,CAEzB;IAED,MAAM,KAAK,IAAI,IAAI,KAAK,CAEvB;IAED,MAAM,KAAK,OAAO,IAAI,KAAK,CAE1B;IAED,MAAM,KAAK,IAAI,IAAI,KAAK,CAEvB;IAED,MAAM,KAAK,SAAS,IAAI,KAAK,CAE5B;IAED,MAAM,KAAK,QAAQ,IAAI,KAAK,CAE3B;IAED,MAAM,KAAK,MAAM,IAAI,KAAK,CAEzB;IAED,MAAM,KAAK,MAAM,IAAI,KAAK,CAEzB;IAED,MAAM,KAAK,IAAI,IAAI,KAAK,CAEvB;IAED,MAAM,KAAK,KAAK,IAAI,KAAK,CAExB;IAED,MAAM,KAAK,IAAI,IAAI,KAAK,CAEvB;IAED,MAAM,KAAK,IAAI,IAAI,KAAK,CAEvB;IAED,MAAM,KAAK,MAAM,IAAI,KAAK,CAEzB;IAED,MAAM,KAAK,MAAM,IAAI,KAAK,CAEzB;CACF"}