@lakuna/color 1.1.2 → 1.2.1

package/src/{utility → delta}/deltaCmc.ts

@@ -1,5 +1,8 @@
 import type Lab from "../types/Lab.js";
-import type Lch from "../types/Lch.js";
+import type Lchab from "../types/Lchab.js";
+
+const c0 = 180 / Math.PI;
+const c1 = Math.PI / 180;
 
 /**
  * Calculates the ΔCMC between two CIELAB values. Based on the EasyRGB pseudocode.
@@ -11,19 +14,18 @@ import type Lch from "../types/Lch.js";
  * @public
  */
 export default function deltaCmc(
-	color0: Lab,
-	color1: Lab,
-	weight: Lch = [1, 1, 1]
+	color0: Readonly<Lab>,
+	color1: Readonly<Lab>,
+	weight: Readonly<Lchab> = [1, 1, 1]
 ): number {
-	// eslint-disable-next-line prefer-destructuring
 	const l0 = color0[0];
-	// eslint-disable-next-line prefer-destructuring
+
 	const a0 = color0[1];
-	// eslint-disable-next-line prefer-destructuring
+
 	const b0 = color0[2];
-	// eslint-disable-next-line prefer-destructuring
+
 	const a1 = color1[1];
-	// eslint-disable-next-line prefer-destructuring
+
 	const b1 = color1[2];
 
 	const i0 = Math.hypot(a0, b0);
@@ -38,7 +40,7 @@ export default function deltaCmc(
 			b0 < 0 ?
 				270
 			:	90
-		:	Math.atan(b0 / a0) * 57.29577951 + // `180 / Math.PI`
+		:	Math.atan(b0 / a0) * c0 +
 			(a0 > 0 ?
 				b0 > 0 ?
 					0
@@ -54,8 +56,8 @@ export default function deltaCmc(
 		Math.sqrt((a1 - a0) ** 2 + (b1 - b0) ** 2 - i5 ** 2) /
 			((i2 *
 				(i3 < 164 || i3 > 345 ?
-					0.36 + Math.abs(0.4 * Math.cos((35 + i3) * 0.01745329)) // `Math.PI / 180`
-				:	0.56 + Math.abs(0.2 * Math.cos((168 + i3) * 0.01745329))) + // `Math.PI / 180`
+					0.36 + Math.abs(0.4 * Math.cos((35 + i3) * c1))
+				:	0.56 + Math.abs(0.2 * Math.cos((168 + i3) * c1))) +
 				1 -
 				i2) *
 				i4)

package/src/{utility → delta}/deltaE00.ts

@@ -1,5 +1,9 @@
 import type Lab from "../types/Lab.js";
-import type Lch from "../types/Lch.js";
+import type Lchab from "../types/Lchab.js";
+
+const c0 = 180 / Math.PI;
+const c1 = 25 ** 7;
+const c2 = Math.PI / 180;
 
 /**
  * Convert CIELAB data to hue data.
@@ -17,12 +21,12 @@ const cieLabToHue = (a: number, b: number): number =>
 		b < 0 ?
 			270
 		:	90
-	:	Math.atan(b / a) * 57.29577951 +
+	:	Math.atan(b / a) * c0 +
 		(a > 0 ?
 			b > 0 ?
 				0
 			:	360
-		:	180); // `180 / Math.PI`
+		:	180);
 
 /**
  * Calculates the ΔE* 2000 (also called the CIEDE2000) between two CIELAB values. Based on the EasyRGB pseudocode.
@@ -34,25 +38,24 @@ const cieLabToHue = (a: number, b: number): number =>
  * @public
  */
 export default function deltaE00(
-	color0: Lab,
-	color1: Lab,
-	weight: Lch = [1, 1, 1]
+	color0: Readonly<Lab>,
+	color1: Readonly<Lab>,
+	weight: Readonly<Lchab> = [1, 1, 1]
 ): number {
-	// eslint-disable-next-line prefer-destructuring
 	const l0 = color0[0];
-	// eslint-disable-next-line prefer-destructuring
+
 	const a0 = color0[1];
-	// eslint-disable-next-line prefer-destructuring
+
 	const b0 = color0[2];
-	// eslint-disable-next-line prefer-destructuring
+
 	const l1 = color1[0];
-	// eslint-disable-next-line prefer-destructuring
+
 	const a1 = color1[1];
-	// eslint-disable-next-line prefer-destructuring
+
 	const b1 = color1[2];
 
 	const i0 = ((Math.hypot(a0, b0) + Math.hypot(a1, b1)) / 2) ** 7;
-	const i1 = 0.5 * (1 - Math.sqrt(i0 / (i0 + 6103515625))); // `25 ** 7
+	const i1 = 0.5 * (1 - Math.sqrt(i0 / (i0 + c1)));
 	const i2 = (1 + i1) * a0;
 	const i3 = Math.hypot(i2, b0);
 	const i4 = cieLabToHue(i2, b0);
@@ -80,17 +83,17 @@ export default function deltaE00(
 				: i13 > 180 ? i13 - 360
 				: i13 + 360) /
 					2) *
-					0.01745329 // `Math.PI / 180`
+					c2
 			)) /
 		(weight[2] *
 			(1 +
 				0.015 *
 					i8 *
 					(1 -
-						0.17 * Math.cos((i11 - 30) * 0.01745329) + // `Math.PI / 180`
-						0.24 * Math.cos(2 * i11 * 0.01745329) + // `Math.PI / 180`
-						0.32 * Math.cos((3 * i11 + 6) * 0.01745329) - // `Math.PI / 180`
-						0.2 * Math.cos((4 * i11 - 63) * 0.01745329)))); // `Math.PI / 180`
+						0.17 * Math.cos((i11 - 30) * c2) +
+						0.24 * Math.cos(2 * i11 * c2) +
+						0.32 * Math.cos((3 * i11 + 6) * c2) -
+						0.2 * Math.cos((4 * i11 - 63) * c2))));
 	const i15 = i8 ** 7;
 	const i16 = ((l0 + l1) / 2 - 50) ** 2;
 
@@ -98,8 +101,8 @@ export default function deltaE00(
 		((l1 - l0) / (weight[0] * (1 + (0.015 * i16) / Math.sqrt(20 + i16)))) ** 2 +
 			i12 ** 2 +
 			i14 ** 2 +
-			-Math.sin(2 * (30 * Math.exp(-(((i11 - 275) / 25) ** 2))) * 0.01745329) * // `Math.PI / 180`
-				(2 * Math.sqrt(i15 / (i15 + 6103515625))) * // `25 ** 7
+			-Math.sin(2 * (30 * Math.exp(-(((i11 - 275) / 25) ** 2))) * c2) *
+				(2 * Math.sqrt(i15 / (i15 + c1))) *
 				i12 *
 				i14
 	);

package/src/{utility → delta}/deltaE76.ts

@@ -9,8 +9,10 @@ import type Luv from "../types/Luv.js";
  * @see {@link https://en.wikipedia.org/wiki/Color_difference | Color difference}
  * @public
  */
-export default function deltaE76(color0: Lab, color1: Lab): number;
-
+export default function deltaE76(
+	color0: Readonly<Lab>,
+	color1: Readonly<Lab>
+): number;
 /**
  * Calculates the ΔE* CIE (CIE 1976) between two CIELUV values. Based on the EasyRGB pseudocode.
  * @param color0 - The first color.
@@ -19,9 +21,14 @@ export default function deltaE76(color0: Lab, color1: Lab): number;
  * @see {@link https://en.wikipedia.org/wiki/Color_difference | Color difference}
  * @public
  */
-export default function deltaE76(color0: Luv, color1: Luv): number;
-
-export default function deltaE76(color0: Lab | Luv, color1: Lab | Luv): number {
+export default function deltaE76(
+	color0: Readonly<Luv>,
+	color1: Readonly<Luv>
+): number;
+export default function deltaE76(
+	color0: Readonly<Lab | Luv>,
+	color1: Readonly<Lab | Luv>
+): number {
 	return Math.hypot(
 		color0[0] - color1[0],
 		color0[1] - color1[1],

package/src/{utility → delta}/deltaE94.ts

@@ -1,5 +1,5 @@
 import type Lab from "../types/Lab.js";
-import type Lch from "../types/Lch.js";
+import type Lchab from "../types/Lchab.js";
 
 /**
  * Calculates the ΔE* 1994 between two CIELAB values. Based on the EasyRGB pseudocode.
@@ -11,21 +11,20 @@ import type Lch from "../types/Lch.js";
  * @public
  */
 export default function deltaE94(
-	color0: Lab,
-	color1: Lab,
-	weight: Lch = [1, 1, 1]
+	color0: Readonly<Lab>,
+	color1: Readonly<Lab>,
+	weight: Readonly<Lchab> = [1, 1, 1]
 ): number {
-	// eslint-disable-next-line prefer-destructuring
 	const l0 = color0[0];
-	// eslint-disable-next-line prefer-destructuring
+
 	const a0 = color0[1];
-	// eslint-disable-next-line prefer-destructuring
+
 	const b0 = color0[2];
-	// eslint-disable-next-line prefer-destructuring
+
 	const l1 = color1[0];
-	// eslint-disable-next-line prefer-destructuring
+
 	const a1 = color1[1];
-	// eslint-disable-next-line prefer-destructuring
+
 	const b1 = color1[2];
 
 	const i0 = Math.hypot(a0, b0);

package/src/{utility → delta}/deltaH.ts

@@ -9,8 +9,10 @@ import type Luv from "../types/Luv.js";
  * @see {@link https://en.wikipedia.org/wiki/Color_difference | Color difference}
  * @public
  */
-export default function deltaH(color0: Lab, color1: Lab): number;
-
+export default function deltaH(
+	color0: Readonly<Lab>,
+	color1: Readonly<Lab>
+): number;
 /**
  * Calculates the ΔH* between two CIELUV values. Based on the EasyRGB pseudocode.
  * @param color0 - The first color.
@@ -19,16 +21,20 @@ export default function deltaH(color0: Lab, color1: Lab): number;
  * @see {@link https://en.wikipedia.org/wiki/Color_difference | Color difference}
  * @public
  */
-export default function deltaH(color0: Luv, color1: Luv): number;
-
-export default function deltaH(color0: Lab | Luv, color1: Lab | Luv): number {
-	// eslint-disable-next-line prefer-destructuring
+export default function deltaH(
+	color0: Readonly<Luv>,
+	color1: Readonly<Luv>
+): number;
+export default function deltaH(
+	color0: Readonly<Lab | Luv>,
+	color1: Readonly<Lab | Luv>
+): number {
 	const a0 = color0[1];
-	// eslint-disable-next-line prefer-destructuring
+
 	const b0 = color0[2];
-	// eslint-disable-next-line prefer-destructuring
+
 	const a1 = color1[1];
-	// eslint-disable-next-line prefer-destructuring
+
 	const b1 = color1[2];
 
 	return Math.sqrt(

package/src/index.ts

@@ -1,3 +1,38 @@
+// Convert
+export { default as adobeToXyz } from "./convert/adobeToXyz.js";
+export { default as cmykToCmy } from "./convert/cmykToCmy.js";
+export { default as cmyToCmyk } from "./convert/cmyToCmyk.js";
+export { default as cmyToRgb } from "./convert/cmyToRgb.js";
+export { default as hexToRgb } from "./convert/hexToRgb.js";
+export { default as hslToRgb } from "./convert/hslToRgb.js";
+export { default as hsvToRgb } from "./convert/hsvToRgb.js";
+export { default as hunterToXyz } from "./convert/hunterToXyz.js";
+export { default as labToLch } from "./convert/labToLch.js";
+export { default as labToXyz } from "./convert/labToXyz.js";
+export { default as lchToLab } from "./convert/lchToLab.js";
+export { default as luvToXyz } from "./convert/luvToXyz.js";
+export { default as rgbToCmy } from "./convert/rgbToCmy.js";
+export { default as rgbToHex } from "./convert/rgbToHex.js";
+export { default as rgbToHsi } from "./convert/rgbToHsi.js";
+export { default as rgbToHsl } from "./convert/rgbToHsl.js";
+export { default as rgbToHsv } from "./convert/rgbToHsv.js";
+export { default as rgbToXyz } from "./convert/rgbToXyz.js";
+export { default as xyzToAdobe } from "./convert/xyzToAdobe.js";
+export { default as xyzToHunter } from "./convert/xyzToHunter.js";
+export { default as xyzToLab } from "./convert/xyzToLab.js";
+export { default as xyzToLuv } from "./convert/xyzToLuv.js";
+export { default as xyzToRgb } from "./convert/xyzToRgb.js";
+export { default as xyzToYxy } from "./convert/xyzToYxy.js";
+export { default as yxyToXyz } from "./convert/yxyToXyz.js";
+
+// Delta
+export { default as deltaC } from "./delta/deltaC.js";
+export { default as deltaCmc } from "./delta/deltaCmc.js";
+export { default as deltaE00 } from "./delta/deltaE00.js";
+export { default as deltaE76 } from "./delta/deltaE76.js";
+export { default as deltaE94 } from "./delta/deltaE94.js";
+export { default as deltaH } from "./delta/deltaH.js";
+
 // Names
 export { default as bang } from "./names/bang.js";
 export { default as cne } from "./names/cne.js";
@@ -11,53 +46,34 @@ export { default as tcapi } from "./names/tcapi.js";
 export { default as x11 } from "./names/x11.js";
 export { default as xkcd } from "./names/xkcd.js";
 
+// Palette
+export { default as analogous } from "./palette/analogous.js";
+export { default as analogousLch } from "./palette/analogousLch.js";
+export { default as complement } from "./palette/complement.js";
+export { default as complementLch } from "./palette/complementLch.js";
+export { default as splitComplement } from "./palette/splitComplement.js";
+export { default as splitComplementLch } from "./palette/splitComplementLch.js";
+
 // Types
 export type { default as Adobe } from "./types/Adobe.js";
 export type { default as Cmy } from "./types/Cmy.js";
 export type { default as Cmyk } from "./types/Cmyk.js";
 export type { Color } from "./types/Color.js";
+export type { default as Hsi } from "./types/Hsi.js";
 export type { default as Hsl } from "./types/Hsl.js";
 export type { default as Hsv } from "./types/Hsv.js";
 export type { default as Hunter } from "./types/Hunter.js";
 export type { default as Lab } from "./types/Lab.js";
-export type { default as Lch } from "./types/Lch.js";
+export type { default as Lchab } from "./types/Lchab.js";
+export type { default as Lchuv } from "./types/Lchuv.js";
 export type { default as Luv } from "./types/Luv.js";
 export type { default as Rgb } from "./types/Rgb.js";
 export type { default as Xyz } from "./types/Xyz.js";
 export type { default as Yxy } from "./types/Yxy.js";
 
 // Utility
-export { default as adobeToXyz } from "./utility/adobeToXyz.js";
-export { default as cmykToCmy } from "./utility/cmykToCmy.js";
-export { default as cmyToCmyk } from "./utility/cmyToCmyk.js";
-export { default as cmyToRgb } from "./utility/cmyToRgb.js";
 export { default as contrast } from "./utility/contrast.js";
-export { default as deltaC } from "./utility/deltaC.js";
-export { default as deltaCmc } from "./utility/deltaCmc.js";
-export { default as deltaE00 } from "./utility/deltaE00.js";
-export { default as deltaE76 } from "./utility/deltaE76.js";
-export { default as deltaE94 } from "./utility/deltaE94.js";
-export { default as deltaH } from "./utility/deltaH.js";
 export { default as getReference } from "./utility/getReference.js";
-export { default as hexToRgb } from "./utility/hexToRgb.js";
-export { default as hslToRgb } from "./utility/hslToRgb.js";
-export { default as hsvToRgb } from "./utility/hsvToRgb.js";
-export { default as hunterToXyz } from "./utility/hunterToXyz.js";
-export { default as labToLch } from "./utility/labToLch.js";
-export { default as labToXyz } from "./utility/labToXyz.js";
-export { default as lchToLab } from "./utility/lchToLab.js";
-export { default as luvToXyz } from "./utility/luvToXyz.js";
+export { default as isWebSafe } from "./utility/isWebSafe.js";
 export { default as relativeLuminance } from "./utility/relativeLuminance.js";
-export { default as rgbToCmy } from "./utility/rgbToCmy.js";
-export { default as rgbToHex } from "./utility/rgbToHex.js";
-export { default as rgbToHsl } from "./utility/rgbToHsl.js";
-export { default as rgbToHsv } from "./utility/rgbToHsv.js";
-export { default as rgbToXyz } from "./utility/rgbToXyz.js";
 export { default as StandardIlluminant } from "./utility/StandardIlluminant.js";
-export { default as xyzToAdobe } from "./utility/xyzToAdobe.js";
-export { default as xyzToHunter } from "./utility/xyzToHunter.js";
-export { default as xyzToLab } from "./utility/xyzToLab.js";
-export { default as xyzToLuv } from "./utility/xyzToLuv.js";
-export { default as xyzToRgb } from "./utility/xyzToRgb.js";
-export { default as xyzToYxy } from "./utility/xyzToYxy.js";
-export { default as yxyToXyz } from "./utility/yxyToXyz.js";