color-2-name 1.2.0 → 1.3.1

package/.eslintrc.json

@@ -0,0 +1,12 @@
+{
+  "env": {
+    "browser": true,
+    "node": true,
+    "commonjs": true,
+    "es2021": true
+  },
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "root": true
+}

package/.gitignore

@@ -81,3 +81,4 @@ web_modules/
 .yarn/install-state.gz
 .pnp.*
 
+.npmrc

package/babel.config.json

@@ -0,0 +1,6 @@
+{
+  "presets": [
+  "@babel/preset-env",
+  "@babel/preset-typescript"
+]
+}

package/jest.config.json

@@ -0,0 +1,21 @@
+{
+  "testRegex": "(/tests/.*(test|spec))\\.tsx?$",
+  "globals": {
+    "ts-jest": {}
+  },
+  "transformIgnorePatterns": ["/node_modules/"],
+  "coverageThreshold": {
+    "global": {
+      "branches": 10,
+      "functions": 10,
+      "lines": 10,
+      "statements": 10
+    }
+  },
+  "coverageReporters": ["text", "lcov"],
+  "coverageDirectory": "./tests/coverage",
+  "collectCoverageFrom": [
+    "./src/**/*.{js,jsx,ts,tsx}",
+    "!**/tests/**"
+  ]
+}

package/lib/@types/color-utils.d.ts

@@ -5,9 +5,14 @@ import { RGBCOLORDEF } from "./types";
  * @param {string} searchedColor -the name of the color to search for
  * @param {Array} set - the colorSet to search in
  */
-declare function getColor(searchedColor: string, set?: RGBCOLORDEF[] | undefined): {
-    hex: `#${string}`;
+export declare function getColor(searchedColor: string, set?: RGBCOLORDEF[] | undefined): {
+    hex: string;
     rgb: string;
     hsl: string;
 };
-export default getColor;
+export declare function getColors(): {
+    hex: string;
+    rgb: string;
+    hsl: string;
+    name: string | number;
+}[];

package/lib/@types/common.d.ts

@@ -1,4 +1,4 @@
-import { RGBCOLORDEF, RGBVALUE } from "./types";
+import { RGBCOLORDEF } from "./types";
 /** The maximum distance possible between colors */
 export declare const MAXDISTANCE = 441.6729559300637;
 /** A regex to match hex colors */
@@ -7,16 +7,18 @@ export declare const hexRegex: RegExp;
 export declare const rgbRegex: RegExp;
 /** A regex to match hsl colors */
 export declare const hslRegex: RegExp;
-/** A regex to match strings that are only int numbers */
+/** A regex to match strings that are only valid numbers with and without decimals and the number can be negative and without the 0 in the beginning  */
 export declare const isNumeric: RegExp;
+/** Remove comments from string */
+export declare const stripComments: RegExp;
 /**
- * This set is used in order to detect if the color is bright or dark
+ * This set is used to detect if the color is bright or dark
  *
  * @note the set has been corrected to get pure RGB values (eg. pure red, pure green) in the "bright" area
  */
 export declare const BLACKANDWHITE: RGBCOLORDEF[];
 /**
- * This set is used in order to detect the nearest rgb color
+ * This set is used to detect the nearest rgb color
  */
 export declare const RGBSET: RGBCOLORDEF[];
 /**
@@ -26,36 +28,66 @@ export declare const RGBSET: RGBCOLORDEF[];
  *
  * @param {string} rawValues - the value inside the rgb(.*) css color definition
  *
- * @return {Array} the array of rgb values finded inside the passed string
+ * @return {Array} the array of rgb values found inside the passed string
  */
 export declare function splitValues(rawValues: string): string[];
 /**
  * If the value is an angle in degrees, convert it to the 0-360 range
  *
- * @param {string} value - the degrees to convert into a number
- * @param {number} multiplier - the number that represent the maximum - default is 100
+ * @param {string} angle - the degrees to convert into a number
  *
  * @return {number} the converted value
  */
-export declare function normalizeDegree(value: string, multiplier?: number): number;
+export declare function normalizeDegrees(angle: string): number;
 /**
- * Takes a string with a css value that could be a number or percentage or an angle in degrees and returns the corresponding 8bit value
+ * Returns a value that is limited between a minimum and maximum value.
  *
- * @param {string} value - a valid value for the css color definition (like 255, "100%", "324deg", etc)
- * @param {string} value - a valid value for the css color definition (like 255, "100%", "324deg", etc)
+ * @param {number} value - The value to be limited.
+ * @param {number} min - The minimum allowed value (default is 0).
+ * @param {number} max - The maximum allowed value (default is 0).
+ * @return {number} The limited value.
+ */
+export declare function limitValue(value: number, min?: number, max?: number): number;
+/**
+ * Calculates the value based on a given string and multiplier.
  *
- * @example convertToInt8('100%'); // 255
+ * @param {string} valueString - The string representing the value to be calculated.
+ * @param {number} multiplier - The multiplier to be applied to the calculated value.
+ * @return {number} The calculated value.
+ */
+export declare function calculateValue(valueString: string, multiplier: number): number;
+/**
+ * Removes comments from the input string and extracts the content between the first opening parenthesis
+ * and the last closing parenthesis.
  *
- * @return {string} the corresponding value in 8 bit format
+ * @param {string} string - The input string.
+ * @return {string} The content between the first opening parenthesis and the last closing parenthesis.
  */
-export declare function convertToInt8(value: string, multiplier?: number): number;
+export declare function cleanDefinition(string: string): string;
 /**
- * This function takes a string representing a color (color) and uses regular expressions to check if it matches any of the following formats: hex, hex+alpha, RGB, RGBA, HSL, or HSLA.
- * If the color string matches one of these formats, the function returns an object with the type of color and the value of the color.
- * If the color string does not match any of the formats, the function throws an error.
+ * Normalizes a percentage value by dividing it by 100 and multiplying it by a given multiplier.
  *
- * @param {string} colorString - the color string to test and convert to rgb values
+ * @param {string} value - The percentage value to be normalized.
+ * @param {number} multiplier - The number to multiply the normalized percentage by.
+ * @return {number} The normalized percentage value.
+ */
+export declare function normalizePercentage(value: string, multiplier: number): number;
+/**
+ * Calculates the color value fallbacks for a given value.
  *
- * @return {Object|Error} the object with rgb values of that color
+ * @param {string} value - The color value to calculate fallbacks for.
+ * @param {string} [err] - An optional error message to display.
+ * @return {number} - The calculated color value fallbacks.
  */
-export declare function parseColor(colorString: string): RGBVALUE;
+export declare function colorValueFallbacks(value: string, err?: string): number;
+/**
+ * Takes a string with a css value that could be a number or percentage or an angle in degrees and returns the corresponding 8bit value
+ *
+ * @param {string} value - a valid value for the css color definition (like 255, "100%", "324deg", etc.) *
+ * @param multiplier - the number that represent the maximum - default is 255 decimal - 100 hex
+ *
+ * @example convertToInt8('100%'); // 255
+ *
+ * @return {string} the corresponding value in 8-bit format
+ */
+export declare function convertToInt8(value: string, multiplier?: number): number;

package/lib/@types/hex-utils.d.ts

@@ -6,6 +6,13 @@ import { COLORSTRING, HEX, RGBVALUE } from "./types";
  * @return {string[]} 6 digit hex
  */
 export declare function shortHexToLongHex(value: string): string[];
+/**
+ * Checks if a given string represents a hexadecimal number.
+ *
+ * @param {string} num - The string to be checked.
+ * @return {boolean} Returns true if the string is a valid hexadecimal number, false otherwise.
+ */
+export declare function isHex(num: string): boolean;
 /**
  * Get the hex value of the color and convert it to an Object of R G And B values (still in hex format)
  *
@@ -17,7 +24,7 @@ export declare function parseHex(value: COLORSTRING): string[];
 /**
  * Converts a Hex color to rgb
  *
- * @param {string} hex without the "#"
+ * @param {string} hex a tuple of hex values
  *
  * @return {string} the rgb color values for the given hex color
  */

package/lib/@types/hsl-utils.d.ts

@@ -1,4 +1,5 @@
 import { HSLVALUE, RGBVALUE } from "./types";
+export declare function fallbackHSL(hsl: string[], err?: string): string[];
 /**
  * Get the values of the hsl string
  *
@@ -30,3 +31,17 @@ export declare function hslToRgb(hslColor: string[]): RGBVALUE;
  * @return {Object} hsl value
  */
 export declare function valuesToHsl({ r, g, b }: RGBVALUE): string;
+/**
+ * Converts an HSL color object to a string representation.
+ *
+ * @param {Object} hsl - Object containing the HSL color values.
+ * @param {number} hsl.h - The hue value of the color.
+ * @param {number} hsl.s - The saturation value of the color.
+ * @param {number} hsl.l - The lightness value of the color.
+ * @return {string} The HSL color as a string.
+ */
+export declare function HSL(hsl: {
+    h: number;
+    s: number;
+    l: number;
+}): string;

package/lib/@types/index.d.ts

@@ -1,6 +1,7 @@
-import { COLORDEF, COLORSTRING, HEX, RGBCOLORDEF } from "./types";
+import type { COLORDEF, COLORSTRING, HEX, RGBCOLORDEF, RGBVALUE } from "./types";
+import { getColor, getColors } from "./color-utils";
 /**
- * Given a color string it returns the closest corresponding name of the color.
+ * Given a color string, it returns the closest corresponding name of the color.
  * Uses the Euclidean distance formula to calculate the distance between colors in the RGB color space.
  *
  * @param {string} color - the color string you want to find the closest color name
@@ -38,16 +39,6 @@ declare function isLight(color: string): boolean;
  * @example isDark('#333'); // true
  */
 declare function isDark(color: string): boolean;
-/**
- * Given a color returns if the color is light or dark (by dark is meant more mathematically closer to black)
- *
- * @param {string} color - The color to check
- *
- * @returns {string} light when the color is close to white, dark otherwise
- *
- * @example isLightOrDark('#fff'); // 'light'
- */
-declare function isLightOrDark(color: string): string;
 /**
  * Given a color returns if the color is closer to "red", "green" or "blue".
  *
@@ -83,4 +74,14 @@ declare function distance(rgb1: [number, number, number], rgb2: [number, number,
  * @example rgbToHex("rgba(100% 0 0 / .5)"); // #FF0000
  */
 declare function rgbToHex(rgbString: string): HEX | Error;
-export { closest, rgbToHex, distance, isLight, isDark, isLightOrDark, closestRGB };
+/**
+ * This function takes a string representing a color (color) and uses regular expressions to check if it matches any of the following formats: hex, hex+alpha, RGB, RGBA, HSL, or HSLA.
+ * If the color string matches one of these formats, the function returns an object with the type of color and the value of the color.
+ * If the color string does not match any of the formats, the function throws an error.
+ *
+ * @param {string} colorString - the color string to test and convert to rgb values
+ *
+ * @return {Object|Error} the object with rgb values of that color
+ */
+export declare function parseColor(colorString: string): RGBVALUE;
+export { closest, rgbToHex, distance, isLight, isDark, closestRGB, getColor, getColors };

package/lib/@types/rgb-utils.d.ts

@@ -1,4 +1,5 @@
 import { RGBVALUE } from "./types";
+export declare function fallbackRGB(rgb: string[], err?: string): string[];
 /**
  * Get the values of the rgb string
  *
@@ -22,4 +23,4 @@ export declare function getRgbValues(rgb: string[]): RGBVALUE;
  *
  * @return {string} a string representation of the rgb values
  */
-export declare function valuesToRgb(rgb: RGBVALUE): string;
+export declare function RGB(rgb: RGBVALUE): string;

package/lib/@types/types.d.ts

@@ -4,7 +4,7 @@
  */
 export type RGB = `rgb(${string},${string},${string})`;
 export type HSL = `hsl(${string},${string},${string})`;
-export type HEX = `#${string}`;
+export type HEX = `#${string}` | string;
 export type WithAlpha<O> = O & {
     a: number;
 };