color-value-tools 1.2.1 → 1.2.2

package/dist/cjs/index.d.ts

@@ -1,397 +1,6 @@
-export type ColorType = 'hex' | 'css-var' | 'rgb' | 'hsl' | 'named' | 'oklch' | 'color' | 'unknown';
-export declare function isCssVariable(value: string): boolean;
-export declare function isHexColor(value: string): boolean;
-export declare function isOklchColor(value: string): boolean;
-export declare function isColorFunction(value: string): boolean;
-export declare function isRgbColor(value: string): boolean;
-export declare function isHslColor(value: string): boolean;
-export declare function getColorType(value: string): ColorType;
-export declare function extractCssVariableName(value: string): string;
-export declare function parseCssVar(value: string): {
-    variableName: string;
-    fallback?: string;
-} | null;
-export declare function parseOklchString(str: string): {
-    L: number;
-    C: number;
-    H: number;
-    alpha: number;
-} | null;
-export declare function parseColorFn(str: string): {
-    space: string;
-    r: number;
-    g: number;
-    b: number;
-    alpha: number;
-} | null;
-export declare function rgbToDisplayP3(rgb: {
-    r: number;
-    g: number;
-    b: number;
-}): {
-    r: number;
-    g: number;
-    b: number;
-};
-export declare function displayP3ToRgb(p3: {
-    r: number;
-    g: number;
-    b: number;
-}): {
-    r: number;
-    g: number;
-    b: number;
-};
-export declare function toDisplayP3Hex(color: string): string;
-export declare function shortHexToRgba(hex: string): {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-} | null;
-export declare function normalizeHex(hex: string): string;
-export declare function hexToRgb(hex: string): [number, number, number];
-export declare function hexToRgba(hex: string, opacity?: number): string;
-export declare function hexToHsl(hex: string): [number, number, number];
-export declare function hslToHex(h: number, s: number, l: number): string;
-export declare function adjustHexBrightness(hex: string, offsetPercent: number): string;
-export declare function rotateHue(hex: string, degrees: number): string;
-export declare function lighten(color: string, amount: number): string;
-export declare function darken(color: string, amount: number): string;
-export declare function saturate(color: string, amount: number): string;
-export declare function desaturate(color: string, amount: number): string;
-export declare function setAlpha(color: string, alpha: number): string;
-export declare function getAlpha(color: string): number;
-export declare function invertColor(color: string): string;
-export declare function grayscale(color: string): string;
-export declare function rgbToHex({ r, g, b }: {
-    r: number;
-    g: number;
-    b: number;
-}): string;
-export declare function rgbaToHex({ r, g, b, a }: {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-}): string;
-export declare function rgbToRgbaString({ r, g, b }: {
-    r: number;
-    g: number;
-    b: number;
-}, a: number): string;
-export declare function rgbaStringToRgba(str: string): {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-} | null;
-export declare function rgbToHsl({ r, g, b }: {
-    r: number;
-    g: number;
-    b: number;
-}): [number, number, number];
-export declare function hslToRgb(h: number, s: number, l: number): {
-    r: number;
-    g: number;
-    b: number;
-};
-export declare function rgbToHsv({ r, g, b }: {
-    r: number;
-    g: number;
-    b: number;
-}): [number, number, number];
-export declare function hsvToRgb(h: number, s: number, v: number): {
-    r: number;
-    g: number;
-    b: number;
-};
-export declare function hexToHsv(hex: string): [number, number, number];
-export declare function hsvToHex(h: number, s: number, v: number): string;
-export declare function hex8ToRgba(hex: string): {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-} | null;
-export declare function rgbaToHex8({ r, g, b, a }: {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-}): string;
-export declare function normalizeColor(input: string | {
-    r: number;
-    g: number;
-    b: number;
-} | {
-    h: number;
-    s: number;
-    l: number;
-}): {
-    type: string;
-    hex: string;
-    r: any;
-    g: any;
-    b: any;
-    a: number;
-    h: number;
-    s: number;
-    l: number;
-    v: number;
-    raw?: undefined;
-} | {
-    type: string;
-    hex: string;
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-    h: any;
-    s: any;
-    l: any;
-    v: number;
-    raw?: undefined;
-} | {
-    type: string;
-    hex?: undefined;
-    r?: undefined;
-    g?: undefined;
-    b?: undefined;
-    a?: undefined;
-    h?: undefined;
-    s?: undefined;
-    l?: undefined;
-    v?: undefined;
-    raw?: undefined;
-} | {
-    type: string;
-    raw: string;
-    hex?: undefined;
-    r?: undefined;
-    g?: undefined;
-    b?: undefined;
-    a?: undefined;
-    h?: undefined;
-    s?: undefined;
-    l?: undefined;
-    v?: undefined;
-} | {
-    type: string;
-    hex: string;
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-    h?: undefined;
-    s?: undefined;
-    l?: undefined;
-    v?: undefined;
-    raw?: undefined;
-};
-export declare function complement(color: string): string;
-export declare function triadic(color: string): [string, string, string];
-export declare function analogous(color: string, angle?: number): [string, string, string];
-export declare function splitComplementary(color: string): [string, string, string];
-export declare function tetradic(color: string): [string, string, string, string];
-export declare function colorShades(color: string, steps?: number): string[];
-export declare function monochromatic(color: string, steps?: number): string[];
-export declare function mixColors(c1: string, c2: string, t: number, opts?: {
-    mode?: 'rgb' | 'hsl' | 'lab' | 'lch' | 'oklab' | 'oklch';
-    format?: 'hex' | 'rgb' | 'rgba' | 'hsl';
-    hueInterpolation?: 'shorter' | 'longer' | 'increasing' | 'decreasing';
-}): string;
-export declare function relativeLuminance(color: string): number;
-export declare function contrastRatio(a: string, b: string): number;
-export declare function isDark(color: string, threshold?: number): boolean;
-export declare function isLight(color: string, threshold?: number): boolean;
-export declare function rgbToCmyk({ r, g, b }: {
-    r: number;
-    g: number;
-    b: number;
-}): {
-    c: number;
-    m: number;
-    y: number;
-    k: number;
-};
-export declare function cmykToRgb({ c, m, y, k }: {
-    c: number;
-    m: number;
-    y: number;
-    k: number;
-}): {
-    r: number;
-    g: number;
-    b: number;
-};
-export declare function rgbToLab({ r, g, b }: {
-    r: number;
-    g: number;
-    b: number;
-}): {
-    L: number;
-    a: number;
-    b: number;
-};
-export declare function labToRgb({ L, a, b }: {
-    L: number;
-    a: number;
-    b: number;
-}): {
-    r: number;
-    g: number;
-    b: number;
-};
-export declare function rgbToLch({ r, g, b }: {
-    r: number;
-    g: number;
-    b: number;
-}): {
-    L: number;
-    C: number;
-    H: number;
-};
-export declare function lchToRgb({ L, C, H }: {
-    L: number;
-    C: number;
-    H: number;
-}): {
-    r: number;
-    g: number;
-    b: number;
-};
-export type WcagLevel = 'AAA' | 'AA' | 'AA-large' | 'fail';
-export declare function wcagLevel(foreground: string, background: string): WcagLevel;
-export declare function bestTextColor(background: string): '#000000' | '#ffffff';
-export declare function bestContrastColor(background: string, candidates: string[]): string;
-export declare function rgbToHwb({ r, g, b }: {
-    r: number;
-    g: number;
-    b: number;
-}): [number, number, number];
-export declare function hwbToRgb(H: number, W: number, B: number): {
-    r: number;
-    g: number;
-    b: number;
-};
-export declare function toHwbString(H: number, W: number, B: number, alpha?: number): string;
-export declare function parseHwbString(str: string): {
-    H: number;
-    W: number;
-    B: number;
-    alpha: number;
-} | null;
-export declare function rgbToOklab({ r, g, b }: {
-    r: number;
-    g: number;
-    b: number;
-}): {
-    L: number;
-    a: number;
-    b: number;
-};
-export declare function oklabToRgb({ L, a, b }: {
-    L: number;
-    a: number;
-    b: number;
-}): {
-    r: number;
-    g: number;
-    b: number;
-};
-export declare function rgbToOklch({ r, g, b }: {
-    r: number;
-    g: number;
-    b: number;
-}): {
-    L: number;
-    C: number;
-    H: number;
-};
-export declare function oklchToRgb({ L, C, H }: {
-    L: number;
-    C: number;
-    H: number;
-}): {
-    r: number;
-    g: number;
-    b: number;
-};
-export declare function toHslString(h: number, s: number, l: number, alpha?: number): string;
-export declare function colorDeltaE(c1: string, c2: string): number;
-export declare function randomColor(options?: {
-    hRange?: [number, number];
-    sRange?: [number, number];
-    lRange?: [number, number];
-}): string;
-export declare function toNearestNamedColor(color: string): string;
-export declare function toOklchString(color: string, alpha?: number): string;
-export declare function toColorP3String(color: string, alpha?: number): string;
-export declare function interpolateColors(color1: string, color2: string, steps: number, options?: {
-    space?: 'rgb' | 'hsl' | 'lab' | 'lch' | 'oklab' | 'oklch';
-    format?: 'hex' | 'rgb' | 'rgba' | 'hsl';
-    hueInterpolation?: 'shorter' | 'longer' | 'increasing' | 'decreasing';
-}): string[];
-export declare function createColorScale(anchors: string[] | Array<{
-    color: string;
-    position?: number;
-}>, steps: number, options?: {
-    space?: 'rgb' | 'hsl' | 'oklab' | 'oklch';
-    format?: 'hex' | 'rgb' | 'hsl';
-}): string[];
-export declare function midpointColor(color1: string, color2: string, options?: {
-    space?: 'lab' | 'lch' | 'oklab' | 'oklch';
-}): string;
-export declare function tints(color: string, steps?: number): string[];
-export declare function shades(color: string, steps?: number): string[];
-export declare function tones(color: string, steps?: number, gray?: string): string[];
-export type ColorBlindnessType = 'protanopia' | 'deuteranopia' | 'tritanopia';
-export declare function simulateProtanopia(color: string): string;
-export declare function simulateDeuteranopia(color: string): string;
-export declare function simulateTritanopia(color: string): string;
-export declare function simulateColorBlindness(color: string, type: ColorBlindnessType): string;
-export type BackgroundSpec = string | {
-    type: 'semi-transparent';
-    color: string;
-    underlay?: string;
-} | {
-    type: 'gradient';
-    stops: string[];
-};
-export declare function isReadableOnBackground(textColor: string, background: BackgroundSpec, options?: {
-    level?: 'AA' | 'AAA';
-    largeText?: boolean;
-}): {
-    readable: boolean;
-    minContrastRatio: number;
-    wcagLevel: WcagLevel;
-};
-export interface PaletteScore {
-    palette: string[];
-    minContrastRatio: number;
-    avgContrastRatio: number;
-}
-export declare function bestContrastPalette(background: string, palettes: string[][], options?: {
-    weights?: number[];
-}): PaletteScore & {
-    paletteIndex: number;
-};
-export declare function clearColorCache(): void;
-export declare function getCacheStats(): {
-    size: number;
-    hits: number;
-};
-export declare function enableCache(): void;
-export declare function disableCache(): void;
-export declare function normalizeColorCached(input: string): ReturnType<typeof normalizeColor>;
-export declare function generateGradientColors(start: string, end: string, steps: number, options?: {
-    mode?: 'rgb' | 'hsl' | 'oklab' | 'oklch';
-    format?: 'hex' | 'rgb' | 'hsl';
-}): Generator<string>;
-export declare function generateTints(color: string, steps: number, options?: {
-    format?: 'hex' | 'rgb' | 'hsl';
-}): Generator<string>;
-export declare function generateShades(color: string, steps: number, options?: {
-    format?: 'hex' | 'rgb' | 'hsl';
-}): Generator<string>;
+export * from './parse.js';
+export * from './convert/index.js';
+export * from './manipulate.js';
+export * from './palette.js';
+export * from './a11y.js';
+export * from './cache.js';