toosoon-utils 1.1.0 → 1.3.0

package/lib/colors.js

@@ -1,18 +1,34 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hclToRgb = exports.rgbToHcl = exports.deltaE = exports.rgbToLab = exports.labToRgb = exports.hclToLab = exports.labToHcl = exports.hsbToRgb = exports.rgbToHsb = exports.hslToRgb = exports.rgbToHsl = exports.normalizeHslString = exports.darken = exports.lighten = exports.hexToRgb = exports.rgbToHexString = exports.rgbToHex = exports.normalizeHexString = void 0;
-var geometry_1 = require("./geometry");
-var maths_1 = require("./maths");
+import { W3CX11 } from './constants';
+import { toDegrees, toRadians } from './geometry';
+import { clamp } from './maths';
+/**
+ * Normalize a color representation into RGB
+ *
+ * @param {ColorRepresentation} color Color representation
+ * @returns {[number,number,number]} Normalized RGB color
+ */
+export function normalizeColor(color) {
+    var _a;
+    if (typeof color === 'string') {
+        return hexToRgb((_a = W3CX11[color]) !== null && _a !== void 0 ? _a : color);
+    }
+    else if (typeof color === 'number') {
+        return hexToRgb(color);
+    }
+    else {
+        return color;
+    }
+}
 // ******************************************
 // RGB & Hexadecimal color spaces
 // ******************************************
 /**
  * Normalize an hexadecimal string
  *
- * @param  {string} hex Hexadecimal string
+ * @param {string} hex Hexadecimal string
  * @returns {string} Normalized hexadecimal string
  */
-function normalizeHexString(hex) {
+export function normalizeHexString(hex) {
     var match;
     var result = '000000';
     hex = hex.toLocaleLowerCase();
@@ -30,7 +46,6 @@ function normalizeHexString(hex) {
     }
     return "#".concat(result);
 }
-exports.normalizeHexString = normalizeHexString;
 /**
  * Convert RGB to hexadecimal
  * Note: rgb values are contained in the interval [0, 1]
@@ -38,11 +53,10 @@ exports.normalizeHexString = normalizeHexString;
  * @param  {[number, number, number]} rgb RGB color
  * @returns {number} Hexadecimal color
  */
-function rgbToHex(_a) {
+export function rgbToHex(_a) {
     var r = _a[0], g = _a[1], b = _a[2];
     return ((r * 255) << 16) ^ ((g * 255) << 8) ^ ((b * 255) << 0);
 }
-exports.rgbToHex = rgbToHex;
 /**
  * Convert RGB to hexadecimal string
  * Note: rgb values are contained in the interval [0, 1]
@@ -50,15 +64,14 @@ exports.rgbToHex = rgbToHex;
  * @param  {[number, number, number]} rgb RGB color
  * @returns {string} Hexadecimal string
  */
-function rgbToHexString(_a) {
+export function rgbToHexString(_a) {
     var r = _a[0], g = _a[1], b = _a[2];
-    var red = (0, maths_1.clamp)(Math.round(r * 255), 0, 255);
-    var green = (0, maths_1.clamp)(Math.round(g * 255), 0, 255);
-    var blue = (0, maths_1.clamp)(Math.round(b * 255), 0, 255);
-    var result = (blue | (green << 8) | (red << 16) | (1 << 24)).toString(16).slice(1);
+    r = clamp(Math.round(r * 255), 0, 255);
+    g = clamp(Math.round(g * 255), 0, 255);
+    b = clamp(Math.round(b * 255), 0, 255);
+    var result = (b | (g << 8) | (r << 16) | (1 << 24)).toString(16).slice(1);
     return "#".concat(result);
 }
-exports.rgbToHexString = rgbToHexString;
 /**
  * Convert hexadecimal to RGB
  * Note: rgb values are contained in the interval [0, 1]
@@ -66,7 +79,7 @@ exports.rgbToHexString = rgbToHexString;
  * @param  {(number|string)} hex Hexadecimal color
  * @returns {[number, number, number]} RGB color
  */
-function hexToRgb(hex) {
+export function hexToRgb(hex) {
     if (typeof hex === 'number') {
         hex = Math.floor(hex);
     }
@@ -74,12 +87,11 @@ function hexToRgb(hex) {
         hex = normalizeHexString(hex).replace(/^#/, '');
         hex = parseInt(hex, 16);
     }
-    var red = ((hex >> 16) & 255) / 255;
-    var green = ((hex >> 8) & 255) / 255;
-    var blue = (hex & 255) / 255;
-    return [red, green, blue];
+    var r = ((hex >> 16) & 255) / 255;
+    var g = ((hex >> 8) & 255) / 255;
+    var b = (hex & 255) / 255;
+    return [r, g, b];
 }
-exports.hexToRgb = hexToRgb;
 /**
  * Lighten a color
  *
@@ -87,7 +99,7 @@ exports.hexToRgb = hexToRgb;
  * @param {number} [amount=0] Amount of the color offset
  * @returns {string} Computed hexadecimal
  */
-function lighten(hex, amount) {
+export function lighten(hex, amount) {
     if (amount === void 0) { amount = 0; }
     var prefix = '';
     if (hex[0] === '#') {
@@ -95,19 +107,15 @@ function lighten(hex, amount) {
         prefix = '#';
     }
     var value = parseInt(hex, 16);
-    var r = (value >> 16) + amount;
-    r = (0, maths_1.clamp)(r, 0, 255);
-    var b = ((value >> 8) & 0x00ff) + amount;
-    b = (0, maths_1.clamp)(b, 0, 255);
-    var g = (value & 0x0000ff) + amount;
-    g = (0, maths_1.clamp)(g, 0, 255);
+    var r = clamp((value >> 16) + amount, 0, 255);
+    var b = clamp(((value >> 8) & 0x00ff) + amount, 0, 255);
+    var g = clamp((value & 0x0000ff) + amount, 0, 255);
     var result = g | (b << 8) | (r << 16);
     if (r === 0 && g === 0 && b === 0 && amount !== 0) {
         result = '000000';
     }
     return prefix + result.toString(16);
 }
-exports.lighten = lighten;
 /**
  * Darken a color
  *
@@ -115,11 +123,10 @@ exports.lighten = lighten;
  * @param {number} [amount=0] Amount of the color offset
  * @returns {string} Computed hexadecimal
  */
-function darken(hex, amount) {
+export function darken(hex, amount) {
     if (amount === void 0) { amount = 0; }
     return lighten(hex, -amount);
 }
-exports.darken = darken;
 // ***************************************************
 // RGB & Hue-Saturation-Lightness (HSL) color spaces
 // ***************************************************
@@ -130,12 +137,11 @@ exports.darken = darken;
  * @param  {string} hsl HSL string (format: 'hsl(360, 100%, 100%)')
  * @returns {[number, number, number]} Normalized HSL color
  */
-function normalizeHslString(hsl) {
+export function normalizeHslString(hsl) {
     var _a, _b;
-    var _c = (_b = (_a = hsl.match(/\d+/g)) === null || _a === void 0 ? void 0 : _a.map(Number)) !== null && _b !== void 0 ? _b : [0, 0, 0], hue = _c[0], saturation = _c[1], lightness = _c[2];
-    return [hue, saturation / 100, lightness / 100];
+    var _c = (_b = (_a = hsl.match(/\d+/g)) === null || _a === void 0 ? void 0 : _a.map(Number)) !== null && _b !== void 0 ? _b : [0, 0, 0], h = _c[0], s = _c[1], l = _c[2];
+    return [h, s / 100, l / 100];
 }
-exports.normalizeHslString = normalizeHslString;
 /**
  * Convert RGB to HSL
  * Notes:
@@ -145,7 +151,7 @@ exports.normalizeHslString = normalizeHslString;
  * @param  {[number, number, number]} rgb RGB color
  * @returns {[number, number, number]} HSL color
  */
-function rgbToHsl(_a) {
+export function rgbToHsl(_a) {
     var r = _a[0], g = _a[1], b = _a[2];
     var l = Math.max(r, g, b);
     var s = l - Math.min(r, g, b);
@@ -156,7 +162,6 @@ function rgbToHsl(_a) {
         (2 * l - s) / 2
     ];
 }
-exports.rgbToHsl = rgbToHsl;
 /**
  * Convert HSL to RGB
  * Notes:
@@ -166,14 +171,13 @@ exports.rgbToHsl = rgbToHsl;
  * @param  {[number, number, number]} hsl HSL color
  * @returns {[number, number, number]} RGB color
  */
-function hslToRgb(_a) {
+export function hslToRgb(_a) {
     var h = _a[0], s = _a[1], l = _a[2];
     var a = s * Math.min(l, 1 - l);
     var k = function (v) { return (v + h / 30) % 12; };
     var f = function (v) { return l - a * Math.max(-1, Math.min(k(v) - 3, Math.min(9 - k(v), 1))); };
     return [f(0), f(8), f(4)];
 }
-exports.hslToRgb = hslToRgb;
 // ***************************************************
 // RGB & Hue-Saturation-Brightness (HSB) color spaces
 // ***************************************************
@@ -186,7 +190,7 @@ exports.hslToRgb = hslToRgb;
  * @param  {[number, number, number]} rgb RGB color
  * @returns {[number, number, number]} HSB color
  */
-function rgbToHsb(_a) {
+export function rgbToHsb(_a) {
     var r = _a[0], g = _a[1], b = _a[2];
     var max = Math.max(r, g, b);
     var min = Math.min(r, g, b);
@@ -194,7 +198,6 @@ function rgbToHsb(_a) {
     var h = delta === 0 ? 0 : delta && max === r ? (g - b) / delta : max === g ? 2 + (b - r) / delta : 4 + (r - g) / delta;
     return [60 * (h < 0 ? h + 6 : h), max && delta / max, max];
 }
-exports.rgbToHsb = rgbToHsb;
 /**
  * Convert HSB to RGB
  * Notes:
@@ -204,13 +207,12 @@ exports.rgbToHsb = rgbToHsb;
  * @param  {[number, number, number]} hsb HSB color
  * @returns {[number, number, number]} RGB color
  */
-function hsbToRgb(_a) {
+export function hsbToRgb(_a) {
     var h = _a[0], s = _a[1], b = _a[2];
     var k = function (v) { return (v + h / 60) % 6; };
     var f = function (v) { return b * (1 - s * Math.max(0, Math.min(k(v), 4 - k(v), 1))); };
     return [f(5), f(3), f(1)];
 }
-exports.hsbToRgb = hsbToRgb;
 // *********************************************
 // LAB & Hue-Chroma-Luminance (HCL) color spaces
 // *********************************************
@@ -221,13 +223,12 @@ exports.hsbToRgb = hsbToRgb;
  * @param {[number, number, number]} lab LAB color
  * @returns {[number, number, number]} HCL color
  */
-function labToHcl(_a) {
+export function labToHcl(_a) {
     var l = _a[0], a = _a[1], b = _a[2];
     var c = Math.sqrt(a * a + b * b);
     var h = abToHue(a, b);
     return [h, c, l];
 }
-exports.labToHcl = labToHcl;
 /**
  * Convert HCL to LAB
  * -> http://www.brucelindbloom.com/index.html?Eqn_LCH_to_Lab.html
@@ -235,13 +236,12 @@ exports.labToHcl = labToHcl;
  * @param {[number, number, number]} hcl HCL color
  * @returns {[number, number, number]} LAB color space
  */
-function hclToLab(_a) {
+export function hclToLab(_a) {
     var h = _a[0], c = _a[1], l = _a[2];
-    var a = c * Math.cos((0, geometry_1.toRadians)(h));
-    var b = c * Math.sin((0, geometry_1.toRadians)(h));
+    var a = c * Math.cos(toRadians(h));
+    var b = c * Math.sin(toRadians(h));
     return [l, a, b];
 }
-exports.hclToLab = hclToLab;
 /**
  * Convert A and B of LAB to Hue of LCH
  * -> https://stackoverflow.com/questions/53733379/conversion-of-cielab-to-cielchab-not-yielding-correct-result
@@ -273,7 +273,7 @@ function abToHue(a, b) {
     else if (a > 0 && b < 0) {
         xBias = 360;
     }
-    return (0, geometry_1.toDegrees)(Math.atan(b / a)) + xBias;
+    return toDegrees(Math.atan(b / a)) + xBias;
 }
 // ******************************************
 // LAB & RGB color spaces
@@ -288,7 +288,7 @@ var f4 = function (v) { return (v > 0.008856 ? Math.pow(v, 1 / 3) : 7.787 * v +
  * @param {[number, number, number]} lab LAB color
  * @returns {[number, number, number]} RGB color
  */
-function labToRgb(_a) {
+export function labToRgb(_a) {
     var l = _a[0], a = _a[1], b = _a[2];
     var y = (l + 16) / 116;
     var x = a / 500 + y;
@@ -297,19 +297,18 @@ function labToRgb(_a) {
     y = 1.0 * f1(y);
     z = 1.08883 * f1(z);
     return [
-        (0, maths_1.clamp)(f2(x * 3.2406 + y * -1.5372 + z * -0.4986)),
-        (0, maths_1.clamp)(f2(x * -0.9689 + y * 1.8758 + z * 0.0415)),
-        (0, maths_1.clamp)(f2(x * 0.0557 + y * -0.204 + z * 1.057))
+        clamp(f2(x * 3.2406 + y * -1.5372 + z * -0.4986)),
+        clamp(f2(x * -0.9689 + y * 1.8758 + z * 0.0415)),
+        clamp(f2(x * 0.0557 + y * -0.204 + z * 1.057))
     ];
 }
-exports.labToRgb = labToRgb;
 /**
  * Converts RGB to LAB
  *
  * @param {[number, number, number]} rgb RGB color
  * @returns {[number, number, number]} LAB color
  */
-function rgbToLab(_a) {
+export function rgbToLab(_a) {
     var r = _a[0], g = _a[1], b = _a[2];
     r = f3(r);
     g = f3(g);
@@ -319,7 +318,6 @@ function rgbToLab(_a) {
     var z = f4((r * 0.0193 + g * 0.1192 + b * 0.9505) / 1.08883);
     return [116 * y - 16, 500 * (x - y), 200 * (y - z)];
 }
-exports.rgbToLab = rgbToLab;
 /**
  * Get the delta from two LAB colors
  *
@@ -327,7 +325,7 @@ exports.rgbToLab = rgbToLab;
  * @param {[number, number, number]} labB Second LAB color
  * @returns {number} Delta
  */
-function deltaE(labA, labB) {
+export function deltaE(labA, labB) {
     var deltaL = labA[0] - labB[0];
     var deltaA = labA[1] - labB[1];
     var deltaB = labA[2] - labB[2];
@@ -344,7 +342,6 @@ function deltaE(labA, labB) {
     var i = deltaLKlsl * deltaLKlsl + deltaCkcsc * deltaCkcsc + deltaHkhsh * deltaHkhsh;
     return i < 0 ? 0 : Math.sqrt(i);
 }
-exports.deltaE = deltaE;
 // *********************************************
 // RGB & Hue-Chroma-Luminance (HCL) color spaces
 // *********************************************
@@ -354,19 +351,17 @@ exports.deltaE = deltaE;
  * @param {[number, number, number]} rgb RGB color
  * @returns {[number, number, number]} HCL color
  */
-function rgbToHcl(_a) {
+export function rgbToHcl(_a) {
     var r = _a[0], g = _a[1], b = _a[2];
     return labToHcl(rgbToLab([r, g, b]));
 }
-exports.rgbToHcl = rgbToHcl;
 /**
  * Converts HCL to RGB
  *
  * @param {[number, number, number]} hcl RGB color
  * @returns {[number, number, number]} RGB color
  */
-function hclToRgb(_a) {
+export function hclToRgb(_a) {
     var h = _a[0], c = _a[1], l = _a[2];
     return labToRgb(hclToLab([h, c, l]));
 }
-exports.hclToRgb = hclToRgb;

package/lib/constants.d.ts

@@ -4,159 +4,159 @@ export declare const TWO_PI: number;
 export declare const HALF_PI: number;
 export declare const QUARTER_PI: number;
 export declare const W3CX11: {
-    aliceblue: string;
-    antiquewhite: string;
-    aqua: string;
-    aquamarine: string;
-    azure: string;
-    beige: string;
-    bisque: string;
-    black: string;
-    blanchedalmond: string;
-    blue: string;
-    blueviolet: string;
-    brown: string;
-    burlywood: string;
-    cadetblue: string;
-    chartreuse: string;
-    chocolate: string;
-    coral: string;
-    cornflower: string;
-    cornflowerblue: string;
-    cornsilk: string;
-    crimson: string;
-    cyan: string;
-    darkblue: string;
-    darkcyan: string;
-    darkgoldenrod: string;
-    darkgray: string;
-    darkgreen: string;
-    darkgrey: string;
-    darkkhaki: string;
-    darkmagenta: string;
-    darkolivegreen: string;
-    darkorange: string;
-    darkorchid: string;
-    darkred: string;
-    darksalmon: string;
-    darkseagreen: string;
-    darkslateblue: string;
-    darkslategray: string;
-    darkslategrey: string;
-    darkturquoise: string;
-    darkviolet: string;
-    deeppink: string;
-    deepskyblue: string;
-    dimgray: string;
-    dimgrey: string;
-    dodgerblue: string;
-    firebrick: string;
-    floralwhite: string;
-    forestgreen: string;
-    fuchsia: string;
-    gainsboro: string;
-    ghostwhite: string;
-    gold: string;
-    goldenrod: string;
-    gray: string;
-    green: string;
-    greenyellow: string;
-    grey: string;
-    honeydew: string;
-    hotpink: string;
-    indianred: string;
-    indigo: string;
-    ivory: string;
-    khaki: string;
-    laserlemon: string;
-    lavender: string;
-    lavenderblush: string;
-    lawngreen: string;
-    lemonchiffon: string;
-    lightblue: string;
-    lightcoral: string;
-    lightcyan: string;
-    lightgoldenrod: string;
-    lightgoldenrodyellow: string;
-    lightgray: string;
-    lightgreen: string;
-    lightgrey: string;
-    lightpink: string;
-    lightsalmon: string;
-    lightseagreen: string;
-    lightskyblue: string;
-    lightslategray: string;
-    lightslategrey: string;
-    lightsteelblue: string;
-    lightyellow: string;
-    lime: string;
-    limegreen: string;
-    linen: string;
-    magenta: string;
-    maroon: string;
-    maroon2: string;
-    maroon3: string;
-    mediumaquamarine: string;
-    mediumblue: string;
-    mediumorchid: string;
-    mediumpurple: string;
-    mediumseagreen: string;
-    mediumslateblue: string;
-    mediumspringgreen: string;
-    mediumturquoise: string;
-    mediumvioletred: string;
-    midnightblue: string;
-    mintcream: string;
-    mistyrose: string;
-    moccasin: string;
-    navajowhite: string;
-    navy: string;
-    oldlace: string;
-    olive: string;
-    olivedrab: string;
-    orange: string;
-    orangered: string;
-    orchid: string;
-    palegoldenrod: string;
-    palegreen: string;
-    paleturquoise: string;
-    palevioletred: string;
-    papayawhip: string;
-    peachpuff: string;
-    peru: string;
-    pink: string;
-    plum: string;
-    powderblue: string;
-    purple: string;
-    purple2: string;
-    purple3: string;
-    rebeccapurple: string;
-    red: string;
-    rosybrown: string;
-    royalblue: string;
-    saddlebrown: string;
-    salmon: string;
-    sandybrown: string;
-    seagreen: string;
-    seashell: string;
-    sienna: string;
-    silver: string;
-    skyblue: string;
-    slateblue: string;
-    slategray: string;
-    slategrey: string;
-    snow: string;
-    springgreen: string;
-    steelblue: string;
-    tan: string;
-    teal: string;
-    thistle: string;
-    tomato: string;
-    turquoise: string;
-    violet: string;
-    wheat: string;
-    white: string;
-    whitesmoke: string;
-    yellow: string;
-    yellowgreen: string;
+    aliceblue: number;
+    antiquewhite: number;
+    aqua: number;
+    aquamarine: number;
+    azure: number;
+    beige: number;
+    bisque: number;
+    black: number;
+    blanchedalmond: number;
+    blue: number;
+    blueviolet: number;
+    brown: number;
+    burlywood: number;
+    cadetblue: number;
+    chartreuse: number;
+    chocolate: number;
+    coral: number;
+    cornflower: number;
+    cornflowerblue: number;
+    cornsilk: number;
+    crimson: number;
+    cyan: number;
+    darkblue: number;
+    darkcyan: number;
+    darkgoldenrod: number;
+    darkgray: number;
+    darkgreen: number;
+    darkgrey: number;
+    darkkhaki: number;
+    darkmagenta: number;
+    darkolivegreen: number;
+    darkorange: number;
+    darkorchid: number;
+    darkred: number;
+    darksalmon: number;
+    darkseagreen: number;
+    darkslateblue: number;
+    darkslategray: number;
+    darkslategrey: number;
+    darkturquoise: number;
+    darkviolet: number;
+    deeppink: number;
+    deepskyblue: number;
+    dimgray: number;
+    dimgrey: number;
+    dodgerblue: number;
+    firebrick: number;
+    floralwhite: number;
+    forestgreen: number;
+    fuchsia: number;
+    gainsboro: number;
+    ghostwhite: number;
+    gold: number;
+    goldenrod: number;
+    gray: number;
+    green: number;
+    greenyellow: number;
+    grey: number;
+    honeydew: number;
+    hotpink: number;
+    indianred: number;
+    indigo: number;
+    ivory: number;
+    khaki: number;
+    laserlemon: number;
+    lavender: number;
+    lavenderblush: number;
+    lawngreen: number;
+    lemonchiffon: number;
+    lightblue: number;
+    lightcoral: number;
+    lightcyan: number;
+    lightgoldenrod: number;
+    lightgoldenrodyellow: number;
+    lightgray: number;
+    lightgreen: number;
+    lightgrey: number;
+    lightpink: number;
+    lightsalmon: number;
+    lightseagreen: number;
+    lightskyblue: number;
+    lightslategray: number;
+    lightslategrey: number;
+    lightsteelblue: number;
+    lightyellow: number;
+    lime: number;
+    limegreen: number;
+    linen: number;
+    magenta: number;
+    maroon: number;
+    maroon2: number;
+    maroon3: number;
+    mediumaquamarine: number;
+    mediumblue: number;
+    mediumorchid: number;
+    mediumpurple: number;
+    mediumseagreen: number;
+    mediumslateblue: number;
+    mediumspringgreen: number;
+    mediumturquoise: number;
+    mediumvioletred: number;
+    midnightblue: number;
+    mintcream: number;
+    mistyrose: number;
+    moccasin: number;
+    navajowhite: number;
+    navy: number;
+    oldlace: number;
+    olive: number;
+    olivedrab: number;
+    orange: number;
+    orangered: number;
+    orchid: number;
+    palegoldenrod: number;
+    palegreen: number;
+    paleturquoise: number;
+    palevioletred: number;
+    papayawhip: number;
+    peachpuff: number;
+    peru: number;
+    pink: number;
+    plum: number;
+    powderblue: number;
+    purple: number;
+    purple2: number;
+    purple3: number;
+    rebeccapurple: number;
+    red: number;
+    rosybrown: number;
+    royalblue: number;
+    saddlebrown: number;
+    salmon: number;
+    sandybrown: number;
+    seagreen: number;
+    seashell: number;
+    sienna: number;
+    silver: number;
+    skyblue: number;
+    slateblue: number;
+    slategray: number;
+    slategrey: number;
+    snow: number;
+    springgreen: number;
+    steelblue: number;
+    tan: number;
+    teal: number;
+    thistle: number;
+    tomato: number;
+    turquoise: number;
+    violet: number;
+    wheat: number;
+    white: number;
+    whitesmoke: number;
+    yellow: number;
+    yellowgreen: number;
 };