All files index.ts

100% Statements 61/61
93.33% Branches 42/45
100% Functions 8/8
100% Lines 49/49

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152  1x   1x   53x                                               68x 68x 57x 57x 53x                                                                                         27x 27x 26x 26x 26x 26x   26x 1x 25x 2x 23x 1x     26x 22x   26x 26x 26x 26x   26x 26x 26x 26x   26x 26x   26x 26x 156x 26x 78x     78x                     26x 22x 22x   4x         6x   6x 6x 1x     6x 6x         2x    
const MATCHER =
  /hsla?\(\s*(\+?-?\d*\.?\d*(?:e\+)?(?:\d*)?(?:deg|rad|grad|turn)?)\s*,\s*(\+?\-?\d*\.?\d*(?:e\+)?(?:\d*)?%)\s*,\s*(\+?\-?\d*\.?\d*(?:e\+)?(?:\d*)?%)\s*(,\s*\+?\-?\s*(?:\d*\.?\d*(?:E-\d*)?%?)?)?\s*\)/i;
const MATCHER_SPACE =
  /hsla?\(\s*(\+?-?\d*\.?\d*(?:e\+)?(?:\d*)?(?:deg|rad|grad|turn)?)\s*(\+?\-?\d*\.?\d*(?:e\+)?(?:\d*)?%)\s*(\+?\-?\d*\.?\d*(?:e\+)?(?:\d*)?%)\s*(\/\s*\+?\-?\s*(?:\d*\.?\d*(?:E-\d*)?%?)?)?\s*\)/i;
 
const aStr = (a?: string) => (a ? a.replace(/^(,|\/)\s*/, '').trim() : a);
 
export interface RGBColor {
  r: number;
  g: number;
  b: number;
}
 
export interface RGBAColor extends RGBColor {
  a: number;
}
 
export interface HSLObjectStringColor {
  h: string;
  s: string;
  l: string;
}
 
export interface HSLAObjectStringColor extends HSLObjectStringColor {
  a?: string;
}
 
/** Convert HLS string to HLS object or verify whether hls is valid */
export default function hslMatcher(hsl: string = ''): HSLAObjectStringColor | undefined {
  const match = MATCHER.exec(hsl) || MATCHER_SPACE.exec(hsl);
  if (!!match) {
    const [_, h, s, l, a] = match;
    if (a && /^(:?(\/|,)\s*-?\+?)$/.test(a.trim())) return;
    return {
      h,
      s,
      l,
      a: aStr(a),
    };
  }
}
 
/**
 * Convert HSL String to RGB
 *
 * ```js
 * hsl(240, 100%, 50%)                         // ✅ comma separated
 * hsl(240, 100%, 50%, 0.1)                    // ✅ comma separated with opacity
 * hsl(240, 100%, 50%, 10%)                    // ✅ comma separated with % opacity
 * hsl(240, 100%, 50%, 10x)                    // ❌
 * hsl(240,100%,50%,0.1)                       // ✅ comma separated without spaces
 * hsl(180deg, 100%, 50%, 0.1)                 // ✅ hue with 'deg'
 * hsl(3.14rad, 100%, 50%, 0.1)                // ✅ hue with 'rad'
 * hsl(200grad, 100%, 50%, 0.1)                // ✅ hue with 'grad'
 * hsl(0.5turn, 100%, 50%, 0.1)                // ✅ hue with 'turn'
 * hsl(-240, -100%, -50%, -0.1)                // ✅ negative values
 * hsl(+240, +100%, +50%, +0.1)                // ✅ explicit positive sign
 * hsl(240.5, 99.99%, 49.999%, 0.9999)         // ✅ non-integer values
 * hsl(.9, .99%, .999%, .9999)                 // ✅ fraction w/o leading zero
 * hsl(.9, .99%, .999%, )                      // ❌
 * hsl(0240, 0100%, 0050%, 01)                 // ✅ leading zeros
 * hsl(240.0, 100.00%, 50.000%, 1.0000)        // ✅ trailing decimal zeros
 * hsl(2400, 1000%, 1000%, 10)                 // ✅ out of range values
 * hsl(-2400.01deg, -1000.5%, -1000.05%, -100) // ✅ combination of above
 * hsl(2.40e+2, 1.00e+2%, 5.00e+1%, 1E-3)      // ✅ scientific notation
 * hsl(240 100% 50%)                           // ✅ space separated (CSS Color Level 4)
 * hsl(240 100% 50% / 0.1)                     // ✅ space separated with opacity
 * hsla(240, 100%, 50%)                        // ✅ hsla() alias
 * hsla(240, 100%, 50%, 0.1)                   // ✅ hsla() with opacity
 * HSL(240Deg, 100%, 50%)                      // ✅ case insensitive
 * ```
 *
 * @param string
 * @returns <RGBColor | RGBAColor | undefined>
 *
 * https://www.30secondsofcode.org/js/s/hsl-to-rgb
 */
export function hlsStringToRGB(hls: string): RGBColor | RGBAColor | undefined {
  const obj = hslMatcher(hls);
  if (!obj) return;
  const { h: hueStr, s: sStr, l: lStr, a: alphaStr } = obj;
  let h = 0,
    s = 0,
    l = 0;
 
  if (/\s*\d*turn\s*$/.test(hueStr)) {
    h = Number(hueStr.replace(/turn\s*$/i, '')) * 360;
  } else if (/\s*\d*grad\s*$/.test(hueStr)) {
    h = gradsToDegrees(hueStr.replace(/grad\s*$/i, ''));
  } else if (/\s*\d*rad\s*$/.test(hueStr)) {
    h = radiansToDegrees(Number(hueStr.replace(/rad\s*$/i, '')));
  }
 
  if (/^((-|\+)?\d*|(-|\+)?\d*?.\d*(e\+)?\d*?)$/.test(hueStr.replace(/deg$/i, ''))) {
    h = Number(hueStr.replace(/deg$/i, ''));
  }
  if (h > 360) h = 360;
  if (h < 0) h = 0;
  Eif (/^((-|\+)?\d*|(-|\+)?\d*?.\d*(e\+)?\d*?)%$/.test(sStr)) {
    s = Number(sStr.replace(/%$/, ''));
  }
  if (s > 100) s = 100;
  if (s < 0) s = 0;
  Eif (/^((-|\+)?\d*|(-|\+)?\d*?.\d*(e\+)?\d*?)%$/.test(lStr)) {
    l = Number(lStr.replace(/%$/, ''));
  }
  if (l > 100) l = 100;
  if (l < 0) l = 0;
 
  s /= 100;
  l /= 100;
  const k = (n: number) => (n + h / 30) % 12;
  const a = s * Math.min(l, 1 - l);
  const f = (n: number) => l - a * Math.max(-1, Math.min(k(n) - 3, Math.min(9 - k(n), 1)));
 
  // rounding
  const toFixed = (n: number) => Number(n.toFixed());
 
  /**
   * https://drafts.csswg.org/css-color/#typedef-alpha-value
   * Opacity in CSS is typically represented using the <alpha-value> syntax,
   * for example in the opacity property or as the alpha component in a color function.
   * Represented as a <number>, the useful range of the value is 0 (representing full transparency) to 1 (representing full opacity).
   * It can also be written as a <percentage>, which computes to the equivalent <number> (0% to 0, 100% to 1).
   * Unless otherwise specified, an <alpha-value> component defaults to 100% when omitted.
   * Values outside the range [0,1] are not invalid, but are clamped to that range when computed.
   */
  if (alphaStr && /^\+?-?\d*(E-\d*|.\d*%?)?$/.test(alphaStr)) {
    const alpha = /%/g.test(alphaStr) ? Number(alphaStr.replace(/%/g, '')) / 100 : Number(alphaStr);
    return { r: toFixed(255 * f(0)), g: toFixed(255 * f(8)), b: toFixed(255 * f(4)), a: alpha };
  }
  return { r: toFixed(255 * f(0)), g: toFixed(255 * f(8)), b: toFixed(255 * f(4)) };
}
 
/** Convert `grad` to `deg` */
export function gradsToDegrees(input: string | number) {
  let grads = Number(input);
 
  grads = grads % 400;
  if (grads < 0) {
    grads += 400;
  }
  // or grads = grads < 0 ? 400 + grads : grads;
  let degrees = (grads / 400) * 360; // or let degrees = grads*0.9
  return degrees;
}
 
/** Convert `rad` to `deg` */
export function radiansToDegrees(radians: number) {
  return Number((radians * (180 / Math.PI)).toFixed());
}