@utilix-tech/sdk 0.1.0

package/dist/color-tPwZCr9H.d.cts

@@ -0,0 +1,229 @@
+/**
+ * @module color
+ *
+ * Color utilities for the @utilix/sdk Node.js SDK.
+ *
+ * Tools covered:
+ *   - color-converter  : parseColor, hexToRgb, rgbToHex, rgbToHsl, hslToRgb, rgbToHsv, hsvToRgb
+ *   - color-palette    : generatePalette, hexToHsl (palette variant), hslToHex (palette variant)
+ *   - contrast-ratio   : checkContrast, hexToLinearRgb, relativeLuminance
+ *   - color-picker     : parseColor (picker variant), rgbToCmyk
+ *   - color-shades     : generateShades, generateTints, generateScale, getContrastColor, colorName
+ *   - color-blend      : blendColors, mixColors, complementaryColor, analogousColors, triadicColors
+ */
+interface RGB {
+    r: number;
+    g: number;
+    b: number;
+}
+interface HSL {
+    h: number;
+    s: number;
+    l: number;
+}
+interface HSV {
+    h: number;
+    s: number;
+    v: number;
+}
+interface ColorResult {
+    hex: string;
+    rgb: RGB;
+    hsl: HSL;
+    hsv: HSV;
+    css: {
+        hex: string;
+        rgb: string;
+        hsl: string;
+    };
+    valid: boolean;
+    error?: string;
+}
+declare function hexToRgb(hex: string): RGB;
+declare function rgbToHex(rgb: RGB): string;
+declare function rgbToHsl(rgb: RGB): HSL;
+declare function hslToRgb(hsl: HSL): RGB;
+declare function rgbToHsv(rgb: RGB): HSV;
+declare function hsvToRgb(hsv: HSV): RGB;
+declare function parseColor(input: string): ColorResult;
+type PaletteType = 'complementary' | 'analogous' | 'triadic' | 'tetradic' | 'split-complementary' | 'monochromatic' | 'shades';
+declare const PALETTE_TYPES: PaletteType[];
+interface PaletteColor {
+    hex: string;
+    hsl: HSL;
+    label: string;
+}
+interface Palette {
+    type: PaletteType;
+    baseHex: string;
+    colors: PaletteColor[];
+}
+declare function hexToHsl(hex: string): HSL;
+declare function hslToHex(h: number, s: number, l: number): string;
+declare function generatePalette(hex: string, type: PaletteType): Palette | {
+    error: string;
+};
+interface ContrastResult {
+    ratio: number;
+    ratioString: string;
+    aa: {
+        normal: boolean;
+        large: boolean;
+        ui: boolean;
+    };
+    aaa: {
+        normal: boolean;
+        large: boolean;
+    };
+    level: 'AAA' | 'AA' | 'AA Large' | 'Fail';
+}
+declare function hexToLinearRgb(hex: string): {
+    r: number;
+    g: number;
+    b: number;
+};
+declare function relativeLuminance(r: number, g: number, b: number): number;
+declare function checkContrast(color1: string, color2: string): ContrastResult | {
+    error: string;
+};
+interface RgbColor {
+    r: number;
+    g: number;
+    b: number;
+}
+interface HslColor {
+    h: number;
+    s: number;
+    l: number;
+}
+interface HsvColor {
+    h: number;
+    s: number;
+    v: number;
+}
+interface PickerColorResult {
+    hex: string;
+    rgb: RgbColor;
+    hsl: HslColor;
+    hsv: HsvColor;
+    cmyk: {
+        c: number;
+        m: number;
+        y: number;
+        k: number;
+    };
+    name?: string;
+}
+declare const NAMED_COLORS: Record<string, string>;
+declare function hexToRgbPicker(hex: string): RgbColor | null;
+declare function rgbToHexPicker(rgb: RgbColor): string;
+declare function rgbToHslPicker(rgb: RgbColor): HslColor;
+declare function hslToRgbPicker(hsl: HslColor): RgbColor;
+declare function rgbToHsvPicker(rgb: RgbColor): HsvColor;
+declare function hsvToRgbPicker(hsv: HsvColor): RgbColor;
+declare function rgbToCmyk(rgb: RgbColor): {
+    c: number;
+    m: number;
+    y: number;
+    k: number;
+};
+declare function parseColorPicker(input: string): PickerColorResult | {
+    error: string;
+};
+declare function hexToRgbShades(hex: string): RgbColor;
+declare function rgbToHexShades(r: number, g: number, b: number): string;
+declare function hexToHslShades(hex: string): HslColor;
+declare function hslToHexShades(h: number, s: number, l: number): string;
+declare function generateShades(hex: string, steps?: number): string[];
+declare function generateTints(hex: string, steps?: number): string[];
+declare function generateScale(hex: string, steps?: number): {
+    shades: string[];
+    tints: string[];
+    base: string;
+};
+declare function getContrastColor(hex: string): '#000000' | '#ffffff';
+declare function colorName(hex: string): string;
+type BlendMode = 'rgb' | 'hsl' | 'oklch';
+declare function hexToRgbBlend(hex: string): RgbColor | {
+    error: string;
+};
+declare function rgbToHexBlend(r: number, g: number, b: number): string;
+declare function hexToHslBlend(hex: string): HslColor | {
+    error: string;
+};
+declare function hslToHexBlend(h: number, s: number, l: number): string;
+declare function blendColors(color1: string, color2: string, steps?: number, mode?: BlendMode): string[] | {
+    error: string;
+};
+declare function mixColors(color1: string, color2: string, ratio?: number): string | {
+    error: string;
+};
+declare function complementaryColor(hex: string): string | {
+    error: string;
+};
+declare function analogousColors(hex: string, angle?: number): [string, string] | {
+    error: string;
+};
+declare function triadicColors(hex: string): [string, string] | {
+    error: string;
+};
+
+type color_BlendMode = BlendMode;
+type color_ColorResult = ColorResult;
+type color_ContrastResult = ContrastResult;
+type color_HSL = HSL;
+type color_HSV = HSV;
+type color_HslColor = HslColor;
+type color_HsvColor = HsvColor;
+declare const color_NAMED_COLORS: typeof NAMED_COLORS;
+declare const color_PALETTE_TYPES: typeof PALETTE_TYPES;
+type color_Palette = Palette;
+type color_PaletteColor = PaletteColor;
+type color_PaletteType = PaletteType;
+type color_PickerColorResult = PickerColorResult;
+type color_RGB = RGB;
+type color_RgbColor = RgbColor;
+declare const color_analogousColors: typeof analogousColors;
+declare const color_blendColors: typeof blendColors;
+declare const color_checkContrast: typeof checkContrast;
+declare const color_colorName: typeof colorName;
+declare const color_complementaryColor: typeof complementaryColor;
+declare const color_generatePalette: typeof generatePalette;
+declare const color_generateScale: typeof generateScale;
+declare const color_generateShades: typeof generateShades;
+declare const color_generateTints: typeof generateTints;
+declare const color_getContrastColor: typeof getContrastColor;
+declare const color_hexToHsl: typeof hexToHsl;
+declare const color_hexToHslBlend: typeof hexToHslBlend;
+declare const color_hexToHslShades: typeof hexToHslShades;
+declare const color_hexToLinearRgb: typeof hexToLinearRgb;
+declare const color_hexToRgb: typeof hexToRgb;
+declare const color_hexToRgbBlend: typeof hexToRgbBlend;
+declare const color_hexToRgbPicker: typeof hexToRgbPicker;
+declare const color_hexToRgbShades: typeof hexToRgbShades;
+declare const color_hslToHex: typeof hslToHex;
+declare const color_hslToHexBlend: typeof hslToHexBlend;
+declare const color_hslToHexShades: typeof hslToHexShades;
+declare const color_hslToRgb: typeof hslToRgb;
+declare const color_hslToRgbPicker: typeof hslToRgbPicker;
+declare const color_hsvToRgb: typeof hsvToRgb;
+declare const color_hsvToRgbPicker: typeof hsvToRgbPicker;
+declare const color_mixColors: typeof mixColors;
+declare const color_parseColor: typeof parseColor;
+declare const color_parseColorPicker: typeof parseColorPicker;
+declare const color_relativeLuminance: typeof relativeLuminance;
+declare const color_rgbToCmyk: typeof rgbToCmyk;
+declare const color_rgbToHex: typeof rgbToHex;
+declare const color_rgbToHexBlend: typeof rgbToHexBlend;
+declare const color_rgbToHexPicker: typeof rgbToHexPicker;
+declare const color_rgbToHexShades: typeof rgbToHexShades;
+declare const color_rgbToHsl: typeof rgbToHsl;
+declare const color_rgbToHslPicker: typeof rgbToHslPicker;
+declare const color_rgbToHsv: typeof rgbToHsv;
+declare const color_rgbToHsvPicker: typeof rgbToHsvPicker;
+declare const color_triadicColors: typeof triadicColors;
+declare namespace color {
+  export { type color_BlendMode as BlendMode, type color_ColorResult as ColorResult, type color_ContrastResult as ContrastResult, type color_HSL as HSL, type color_HSV as HSV, type color_HslColor as HslColor, type color_HsvColor as HsvColor, color_NAMED_COLORS as NAMED_COLORS, color_PALETTE_TYPES as PALETTE_TYPES, type color_Palette as Palette, type color_PaletteColor as PaletteColor, type color_PaletteType as PaletteType, type color_PickerColorResult as PickerColorResult, type color_RGB as RGB, type color_RgbColor as RgbColor, color_analogousColors as analogousColors, color_blendColors as blendColors, color_checkContrast as checkContrast, color_colorName as colorName, color_complementaryColor as complementaryColor, color_generatePalette as generatePalette, color_generateScale as generateScale, color_generateShades as generateShades, color_generateTints as generateTints, color_getContrastColor as getContrastColor, color_hexToHsl as hexToHsl, color_hexToHslBlend as hexToHslBlend, color_hexToHslShades as hexToHslShades, color_hexToLinearRgb as hexToLinearRgb, color_hexToRgb as hexToRgb, color_hexToRgbBlend as hexToRgbBlend, color_hexToRgbPicker as hexToRgbPicker, color_hexToRgbShades as hexToRgbShades, color_hslToHex as hslToHex, color_hslToHexBlend as hslToHexBlend, color_hslToHexShades as hslToHexShades, color_hslToRgb as hslToRgb, color_hslToRgbPicker as hslToRgbPicker, color_hsvToRgb as hsvToRgb, color_hsvToRgbPicker as hsvToRgbPicker, color_mixColors as mixColors, color_parseColor as parseColor, color_parseColorPicker as parseColorPicker, color_relativeLuminance as relativeLuminance, color_rgbToCmyk as rgbToCmyk, color_rgbToHex as rgbToHex, color_rgbToHexBlend as rgbToHexBlend, color_rgbToHexPicker as rgbToHexPicker, color_rgbToHexShades as rgbToHexShades, color_rgbToHsl as rgbToHsl, color_rgbToHslPicker as rgbToHslPicker, color_rgbToHsv as rgbToHsv, color_rgbToHsvPicker as rgbToHsvPicker, color_triadicColors as triadicColors };
+}
+
+export { rgbToHsvPicker as $, hexToRgbPicker as A, type BlendMode as B, type ColorResult as C, hexToRgbShades as D, hslToHex as E, hslToHexBlend as F, hslToHexShades as G, type HSL as H, hslToRgb as I, hslToRgbPicker as J, hsvToRgb as K, hsvToRgbPicker as L, mixColors as M, NAMED_COLORS as N, parseColor as O, PALETTE_TYPES as P, parseColorPicker as Q, type RGB as R, relativeLuminance as S, rgbToCmyk as T, rgbToHex as U, rgbToHexBlend as V, rgbToHexPicker as W, rgbToHexShades as X, rgbToHsl as Y, rgbToHslPicker as Z, rgbToHsv as _, type ContrastResult as a, triadicColors as a0, type HSV as b, color as c, type HslColor as d, type HsvColor as e, type Palette as f, type PaletteColor as g, type PaletteType as h, type PickerColorResult as i, type RgbColor as j, analogousColors as k, blendColors as l, checkContrast as m, colorName as n, complementaryColor as o, generatePalette as p, generateScale as q, generateShades as r, generateTints as s, getContrastColor as t, hexToHsl as u, hexToHslBlend as v, hexToHslShades as w, hexToLinearRgb as x, hexToRgb as y, hexToRgbBlend as z };

package/dist/color-tPwZCr9H.d.ts

@@ -0,0 +1,229 @@
+/**
+ * @module color
+ *
+ * Color utilities for the @utilix/sdk Node.js SDK.
+ *
+ * Tools covered:
+ *   - color-converter  : parseColor, hexToRgb, rgbToHex, rgbToHsl, hslToRgb, rgbToHsv, hsvToRgb
+ *   - color-palette    : generatePalette, hexToHsl (palette variant), hslToHex (palette variant)
+ *   - contrast-ratio   : checkContrast, hexToLinearRgb, relativeLuminance
+ *   - color-picker     : parseColor (picker variant), rgbToCmyk
+ *   - color-shades     : generateShades, generateTints, generateScale, getContrastColor, colorName
+ *   - color-blend      : blendColors, mixColors, complementaryColor, analogousColors, triadicColors
+ */
+interface RGB {
+    r: number;
+    g: number;
+    b: number;
+}
+interface HSL {
+    h: number;
+    s: number;
+    l: number;
+}
+interface HSV {
+    h: number;
+    s: number;
+    v: number;
+}
+interface ColorResult {
+    hex: string;
+    rgb: RGB;
+    hsl: HSL;
+    hsv: HSV;
+    css: {
+        hex: string;
+        rgb: string;
+        hsl: string;
+    };
+    valid: boolean;
+    error?: string;
+}
+declare function hexToRgb(hex: string): RGB;
+declare function rgbToHex(rgb: RGB): string;
+declare function rgbToHsl(rgb: RGB): HSL;
+declare function hslToRgb(hsl: HSL): RGB;
+declare function rgbToHsv(rgb: RGB): HSV;
+declare function hsvToRgb(hsv: HSV): RGB;
+declare function parseColor(input: string): ColorResult;
+type PaletteType = 'complementary' | 'analogous' | 'triadic' | 'tetradic' | 'split-complementary' | 'monochromatic' | 'shades';
+declare const PALETTE_TYPES: PaletteType[];
+interface PaletteColor {
+    hex: string;
+    hsl: HSL;
+    label: string;
+}
+interface Palette {
+    type: PaletteType;
+    baseHex: string;
+    colors: PaletteColor[];
+}
+declare function hexToHsl(hex: string): HSL;
+declare function hslToHex(h: number, s: number, l: number): string;
+declare function generatePalette(hex: string, type: PaletteType): Palette | {
+    error: string;
+};
+interface ContrastResult {
+    ratio: number;
+    ratioString: string;
+    aa: {
+        normal: boolean;
+        large: boolean;
+        ui: boolean;
+    };
+    aaa: {
+        normal: boolean;
+        large: boolean;
+    };
+    level: 'AAA' | 'AA' | 'AA Large' | 'Fail';
+}
+declare function hexToLinearRgb(hex: string): {
+    r: number;
+    g: number;
+    b: number;
+};
+declare function relativeLuminance(r: number, g: number, b: number): number;
+declare function checkContrast(color1: string, color2: string): ContrastResult | {
+    error: string;
+};
+interface RgbColor {
+    r: number;
+    g: number;
+    b: number;
+}
+interface HslColor {
+    h: number;
+    s: number;
+    l: number;
+}
+interface HsvColor {
+    h: number;
+    s: number;
+    v: number;
+}
+interface PickerColorResult {
+    hex: string;
+    rgb: RgbColor;
+    hsl: HslColor;
+    hsv: HsvColor;
+    cmyk: {
+        c: number;
+        m: number;
+        y: number;
+        k: number;
+    };
+    name?: string;
+}
+declare const NAMED_COLORS: Record<string, string>;
+declare function hexToRgbPicker(hex: string): RgbColor | null;
+declare function rgbToHexPicker(rgb: RgbColor): string;
+declare function rgbToHslPicker(rgb: RgbColor): HslColor;
+declare function hslToRgbPicker(hsl: HslColor): RgbColor;
+declare function rgbToHsvPicker(rgb: RgbColor): HsvColor;
+declare function hsvToRgbPicker(hsv: HsvColor): RgbColor;
+declare function rgbToCmyk(rgb: RgbColor): {
+    c: number;
+    m: number;
+    y: number;
+    k: number;
+};
+declare function parseColorPicker(input: string): PickerColorResult | {
+    error: string;
+};
+declare function hexToRgbShades(hex: string): RgbColor;
+declare function rgbToHexShades(r: number, g: number, b: number): string;
+declare function hexToHslShades(hex: string): HslColor;
+declare function hslToHexShades(h: number, s: number, l: number): string;
+declare function generateShades(hex: string, steps?: number): string[];
+declare function generateTints(hex: string, steps?: number): string[];
+declare function generateScale(hex: string, steps?: number): {
+    shades: string[];
+    tints: string[];
+    base: string;
+};
+declare function getContrastColor(hex: string): '#000000' | '#ffffff';
+declare function colorName(hex: string): string;
+type BlendMode = 'rgb' | 'hsl' | 'oklch';
+declare function hexToRgbBlend(hex: string): RgbColor | {
+    error: string;
+};
+declare function rgbToHexBlend(r: number, g: number, b: number): string;
+declare function hexToHslBlend(hex: string): HslColor | {
+    error: string;
+};
+declare function hslToHexBlend(h: number, s: number, l: number): string;
+declare function blendColors(color1: string, color2: string, steps?: number, mode?: BlendMode): string[] | {
+    error: string;
+};
+declare function mixColors(color1: string, color2: string, ratio?: number): string | {
+    error: string;
+};
+declare function complementaryColor(hex: string): string | {
+    error: string;
+};
+declare function analogousColors(hex: string, angle?: number): [string, string] | {
+    error: string;
+};
+declare function triadicColors(hex: string): [string, string] | {
+    error: string;
+};
+
+type color_BlendMode = BlendMode;
+type color_ColorResult = ColorResult;
+type color_ContrastResult = ContrastResult;
+type color_HSL = HSL;
+type color_HSV = HSV;
+type color_HslColor = HslColor;
+type color_HsvColor = HsvColor;
+declare const color_NAMED_COLORS: typeof NAMED_COLORS;
+declare const color_PALETTE_TYPES: typeof PALETTE_TYPES;
+type color_Palette = Palette;
+type color_PaletteColor = PaletteColor;
+type color_PaletteType = PaletteType;
+type color_PickerColorResult = PickerColorResult;
+type color_RGB = RGB;
+type color_RgbColor = RgbColor;
+declare const color_analogousColors: typeof analogousColors;
+declare const color_blendColors: typeof blendColors;
+declare const color_checkContrast: typeof checkContrast;
+declare const color_colorName: typeof colorName;
+declare const color_complementaryColor: typeof complementaryColor;
+declare const color_generatePalette: typeof generatePalette;
+declare const color_generateScale: typeof generateScale;
+declare const color_generateShades: typeof generateShades;
+declare const color_generateTints: typeof generateTints;
+declare const color_getContrastColor: typeof getContrastColor;
+declare const color_hexToHsl: typeof hexToHsl;
+declare const color_hexToHslBlend: typeof hexToHslBlend;
+declare const color_hexToHslShades: typeof hexToHslShades;
+declare const color_hexToLinearRgb: typeof hexToLinearRgb;
+declare const color_hexToRgb: typeof hexToRgb;
+declare const color_hexToRgbBlend: typeof hexToRgbBlend;
+declare const color_hexToRgbPicker: typeof hexToRgbPicker;
+declare const color_hexToRgbShades: typeof hexToRgbShades;
+declare const color_hslToHex: typeof hslToHex;
+declare const color_hslToHexBlend: typeof hslToHexBlend;
+declare const color_hslToHexShades: typeof hslToHexShades;
+declare const color_hslToRgb: typeof hslToRgb;
+declare const color_hslToRgbPicker: typeof hslToRgbPicker;
+declare const color_hsvToRgb: typeof hsvToRgb;
+declare const color_hsvToRgbPicker: typeof hsvToRgbPicker;
+declare const color_mixColors: typeof mixColors;
+declare const color_parseColor: typeof parseColor;
+declare const color_parseColorPicker: typeof parseColorPicker;
+declare const color_relativeLuminance: typeof relativeLuminance;
+declare const color_rgbToCmyk: typeof rgbToCmyk;
+declare const color_rgbToHex: typeof rgbToHex;
+declare const color_rgbToHexBlend: typeof rgbToHexBlend;
+declare const color_rgbToHexPicker: typeof rgbToHexPicker;
+declare const color_rgbToHexShades: typeof rgbToHexShades;
+declare const color_rgbToHsl: typeof rgbToHsl;
+declare const color_rgbToHslPicker: typeof rgbToHslPicker;
+declare const color_rgbToHsv: typeof rgbToHsv;
+declare const color_rgbToHsvPicker: typeof rgbToHsvPicker;
+declare const color_triadicColors: typeof triadicColors;
+declare namespace color {
+  export { type color_BlendMode as BlendMode, type color_ColorResult as ColorResult, type color_ContrastResult as ContrastResult, type color_HSL as HSL, type color_HSV as HSV, type color_HslColor as HslColor, type color_HsvColor as HsvColor, color_NAMED_COLORS as NAMED_COLORS, color_PALETTE_TYPES as PALETTE_TYPES, type color_Palette as Palette, type color_PaletteColor as PaletteColor, type color_PaletteType as PaletteType, type color_PickerColorResult as PickerColorResult, type color_RGB as RGB, type color_RgbColor as RgbColor, color_analogousColors as analogousColors, color_blendColors as blendColors, color_checkContrast as checkContrast, color_colorName as colorName, color_complementaryColor as complementaryColor, color_generatePalette as generatePalette, color_generateScale as generateScale, color_generateShades as generateShades, color_generateTints as generateTints, color_getContrastColor as getContrastColor, color_hexToHsl as hexToHsl, color_hexToHslBlend as hexToHslBlend, color_hexToHslShades as hexToHslShades, color_hexToLinearRgb as hexToLinearRgb, color_hexToRgb as hexToRgb, color_hexToRgbBlend as hexToRgbBlend, color_hexToRgbPicker as hexToRgbPicker, color_hexToRgbShades as hexToRgbShades, color_hslToHex as hslToHex, color_hslToHexBlend as hslToHexBlend, color_hslToHexShades as hslToHexShades, color_hslToRgb as hslToRgb, color_hslToRgbPicker as hslToRgbPicker, color_hsvToRgb as hsvToRgb, color_hsvToRgbPicker as hsvToRgbPicker, color_mixColors as mixColors, color_parseColor as parseColor, color_parseColorPicker as parseColorPicker, color_relativeLuminance as relativeLuminance, color_rgbToCmyk as rgbToCmyk, color_rgbToHex as rgbToHex, color_rgbToHexBlend as rgbToHexBlend, color_rgbToHexPicker as rgbToHexPicker, color_rgbToHexShades as rgbToHexShades, color_rgbToHsl as rgbToHsl, color_rgbToHslPicker as rgbToHslPicker, color_rgbToHsv as rgbToHsv, color_rgbToHsvPicker as rgbToHsvPicker, color_triadicColors as triadicColors };
+}
+
+export { rgbToHsvPicker as $, hexToRgbPicker as A, type BlendMode as B, type ColorResult as C, hexToRgbShades as D, hslToHex as E, hslToHexBlend as F, hslToHexShades as G, type HSL as H, hslToRgb as I, hslToRgbPicker as J, hsvToRgb as K, hsvToRgbPicker as L, mixColors as M, NAMED_COLORS as N, parseColor as O, PALETTE_TYPES as P, parseColorPicker as Q, type RGB as R, relativeLuminance as S, rgbToCmyk as T, rgbToHex as U, rgbToHexBlend as V, rgbToHexPicker as W, rgbToHexShades as X, rgbToHsl as Y, rgbToHslPicker as Z, rgbToHsv as _, type ContrastResult as a, triadicColors as a0, type HSV as b, color as c, type HslColor as d, type HsvColor as e, type Palette as f, type PaletteColor as g, type PaletteType as h, type PickerColorResult as i, type RgbColor as j, analogousColors as k, blendColors as l, checkContrast as m, colorName as n, complementaryColor as o, generatePalette as p, generateScale as q, generateShades as r, generateTints as s, getContrastColor as t, hexToHsl as u, hexToHslBlend as v, hexToHslShades as w, hexToLinearRgb as x, hexToRgb as y, hexToRgbBlend as z };