@lakuna/color 1.2.0 → 1.2.1

package/src/convert/cmyToCmyk.ts

@@ -8,7 +8,7 @@ import type Cmyk from "../types/Cmyk.js";
  * @public
  */
 export default function cmyToCmyk(
-	color: Cmy
+	color: Readonly<Cmy>
 ): [number, number, number, number] & Cmyk {
 	const c = color[0];
 

package/src/convert/cmyToRgb.ts

@@ -7,6 +7,8 @@ import type Rgb from "../types/Rgb.js";
  * @returns An sRGB color.
  * @public
  */
-export default function cmyToRgb(color: Cmy): [number, number, number] & Rgb {
+export default function cmyToRgb(
+	color: Readonly<Cmy>
+): [number, number, number] & Rgb {
 	return [(1 - color[0]) * 0xff, (1 - color[1]) * 0xff, (1 - color[2]) * 0xff];
 }

package/src/convert/cmykToCmy.ts

@@ -7,7 +7,9 @@ import type Cmyk from "../types/Cmyk.js";
  * @returns A CMY color.
  * @public
  */
-export default function cmykToCmy(color: Cmyk): [number, number, number] & Cmy {
+export default function cmykToCmy(
+	color: Readonly<Cmyk>
+): [number, number, number] & Cmy {
 	const k = color[3];
 
 	return [

package/src/convert/hslToRgb.ts

@@ -33,7 +33,9 @@ const hueToRgb = (v0: number, v1: number, h: number): number => {
  * @returns An sRGB color.
  * @public
  */
-export default function hslToRgb(color: Hsl): [number, number, number] & Rgb {
+export default function hslToRgb(
+	color: Readonly<Hsl>
+): [number, number, number] & Rgb {
 	const h = color[0];
 
 	const s = color[1];

package/src/convert/hsvToRgb.ts

@@ -7,7 +7,9 @@ import type Rgb from "../types/Rgb.js";
  * @returns An sRGB color.
  * @public
  */
-export default function hsvToRgb(color: Hsv): [number, number, number] & Rgb {
+export default function hsvToRgb(
+	color: Readonly<Hsv>
+): [number, number, number] & Rgb {
 	const s = color[1];
 
 	const v = color[2];

package/src/convert/hunterToXyz.ts

@@ -15,8 +15,8 @@ const c1 = 70 / 218.11;
  * @public
  */
 export default function hunterToXyz(
-	color: Hunter,
-	ref: Xyz = getReference(StandardIlluminant.D65_2)
+	color: Readonly<Hunter>,
+	ref: Readonly<Xyz> = getReference(StandardIlluminant.D65_2)
 ): [number, number, number] & Xyz {
 	const rx = ref[0];
 

package/src/convert/labToLch.ts

@@ -11,16 +11,20 @@ const c0 = 180 / Math.PI;
  * @returns A CIELCh color.
  * @public
  */
-export default function labToLch(color: Lab): [number, number, number] & Lchab;
+export default function labToLch(
+	color: Readonly<Lab>
+): [number, number, number] & Lchab;
 /**
  * Convert the given CIELUV color to a CIELCh(uv) color. Based on the EasyRGB pseudo-code.
  * @param color - The CIELUV color.
  * @returns A CIELCh color.
  * @public
  */
-export default function labToLch(color: Luv): [number, number, number] & Lchuv;
 export default function labToLch(
-	color: Lab | Luv
+	color: Readonly<Luv>
+): [number, number, number] & Lchuv;
+export default function labToLch(
+	color: Readonly<Lab | Luv>
 ): [number, number, number] & (Lchab | Lchuv) {
 	const a = color[1];
 

package/src/convert/labToXyz.ts

@@ -16,8 +16,8 @@ const c2 = 7.787;
  * @public
  */
 export default function labToXyz(
-	color: Lab,
-	ref: Xyz = getReference(StandardIlluminant.D65_2)
+	color: Readonly<Lab>,
+	ref: Readonly<Xyz> = getReference(StandardIlluminant.D65_2)
 ): [number, number, number] & Xyz {
 	const i0 = (color[0] + 16) / 116;
 	const i1 = i0 ** 3;

package/src/convert/lchToLab.ts

@@ -11,16 +11,20 @@ const c0 = Math.PI / 180;
  * @returns A CIELAB color.
  * @public
  */
-export default function lchToLab(color: Lchab): [number, number, number] & Lab;
+export default function lchToLab(
+	color: Readonly<Lchab>
+): [number, number, number] & Lab;
 /**
  * Convert the given CIELCh(uv) color to a CIELUV color. Based on the EasyRGB pseudo-code.
  * @param color - The CIELCh color.
  * @returns A CIELUV color.
  * @public
  */
-export default function lchToLab(color: Lchuv): [number, number, number] & Luv;
 export default function lchToLab(
-	color: Lchab
+	color: Readonly<Lchuv>
+): [number, number, number] & Luv;
+export default function lchToLab(
+	color: Readonly<Lchab | Lchuv>
 ): [number, number, number] & (Lab | Luv) {
 	const c = color[1];
 

package/src/convert/luvToXyz.ts

@@ -14,8 +14,8 @@ const c0 = 16 / 116;
  * @public
  */
 export default function luvToXyz(
-	color: Luv,
-	ref: Xyz = getReference(StandardIlluminant.D65_2)
+	color: Readonly<Luv>,
+	ref: Readonly<Xyz> = getReference(StandardIlluminant.D65_2)
 ): [number, number, number] & Xyz {
 	const l = color[0];
 

package/src/convert/rgbToCmy.ts

@@ -7,6 +7,8 @@ import type Rgb from "../types/Rgb.js";
  * @returns A CMY color.
  * @public
  */
-export default function rgbToCmy(color: Rgb): [number, number, number] & Cmy {
+export default function rgbToCmy(
+	color: Readonly<Rgb>
+): [number, number, number] & Cmy {
 	return [1 - color[0] / 0xff, 1 - color[1] / 0xff, 1 - color[2] / 0xff];
 }

package/src/convert/rgbToHex.ts

@@ -6,7 +6,7 @@ import type Rgb from "../types/Rgb.js";
  * @returns The numerical hexadecimal representation of the color.
  * @public
  */
-export default function rgbToHex(rgb: Rgb): number {
+export default function rgbToHex(rgb: Readonly<Rgb>): number {
 	return (
 		Math.round(rgb[0] * 0x10000) +
 		Math.round(rgb[1] * 0x100) +

package/src/convert/rgbToHsi.ts

@@ -10,7 +10,9 @@ const c1 = 2 / 3;
  * @returns An HSI color.
  * @public
  */
-export default function rgbToHsi(color: Rgb): [number, number, number] & Hsi {
+export default function rgbToHsi(
+	color: Readonly<Rgb>
+): [number, number, number] & Hsi {
 	const i0 = color[0] / 0xff;
 	const i1 = color[1] / 0xff;
 	const i2 = color[2] / 0xff;

package/src/convert/rgbToHsl.ts

@@ -10,7 +10,9 @@ const c1 = 2 / 3;
  * @returns An HSL color.
  * @public
  */
-export default function rgbToHsl(color: Rgb): [number, number, number] & Hsl {
+export default function rgbToHsl(
+	color: Readonly<Rgb>
+): [number, number, number] & Hsl {
 	const i0 = color[0] / 0xff;
 	const i1 = color[1] / 0xff;
 	const i2 = color[2] / 0xff;

package/src/convert/rgbToHsv.ts

@@ -10,7 +10,9 @@ const c1 = 2 / 3;
  * @returns An HSV color.
  * @public
  */
-export default function rgbToHsv(color: Rgb): [number, number, number] & Hsv {
+export default function rgbToHsv(
+	color: Readonly<Rgb>
+): [number, number, number] & Hsv {
 	const i0 = color[0] / 0xff;
 	const i1 = color[1] / 0xff;
 	const i2 = color[2] / 0xff;

package/src/convert/rgbToXyz.ts

@@ -14,7 +14,9 @@ const c5 = 100;
  * @returns A CIEXYZ color.
  * @public
  */
-export default function rgbToXyz(color: Rgb): [number, number, number] & Xyz {
+export default function rgbToXyz(
+	color: Readonly<Rgb>
+): [number, number, number] & Xyz {
 	const i0 = color[0] / 0xff;
 	const i1 = color[1] / 0xff;
 	const i2 = color[2] / 0xff;

package/src/convert/xyzToAdobe.ts

@@ -11,7 +11,7 @@ const c0 = 1 / gamma;
  * @public
  */
 export default function xyzToAdobe(
-	color: Xyz
+	color: Readonly<Xyz>
 ): [number, number, number] & Adobe {
 	const i0 = color[0] / 100;
 	const i1 = color[1] / 100;

package/src/convert/xyzToHunter.ts

@@ -15,8 +15,8 @@ const c1 = 70 / 218.11;
  * @public
  */
 export default function xyzToHunter(
-	color: Xyz,
-	ref: Xyz = getReference(StandardIlluminant.D65_2)
+	color: Readonly<Xyz>,
+	ref: Readonly<Xyz> = getReference(StandardIlluminant.D65_2)
 ): [number, number, number] & Hunter {
 	const rx = ref[0];
 

package/src/convert/xyzToLab.ts

@@ -17,8 +17,8 @@ const c3 = 7.787;
  * @public
  */
 export default function xyzToLab(
-	color: Xyz,
-	ref: Xyz = getReference(StandardIlluminant.D65_2)
+	color: Readonly<Xyz>,
+	ref: Readonly<Xyz> = getReference(StandardIlluminant.D65_2)
 ): [number, number, number] & Lab {
 	const i0 = color[0] / ref[0];
 	const i1 = color[1] / ref[1];

package/src/convert/xyzToLuv.ts

@@ -15,8 +15,8 @@ const c1 = 16 / 116;
  * @public
  */
 export default function xyzToLuv(
-	color: Xyz,
-	ref: Xyz = getReference(StandardIlluminant.D65_2)
+	color: Readonly<Xyz>,
+	ref: Readonly<Xyz> = getReference(StandardIlluminant.D65_2)
 ): [number, number, number] & Luv {
 	const x = color[0];
 

package/src/convert/xyzToRgb.ts

@@ -13,7 +13,9 @@ const c4 = 12.92;
  * @returns An sRGB color.
  * @public
  */
-export default function xyzToRgb(color: Xyz): [number, number, number] & Rgb {
+export default function xyzToRgb(
+	color: Readonly<Xyz>
+): [number, number, number] & Rgb {
 	const i0 = color[0] / 100;
 	const i1 = color[1] / 100;
 	const i2 = color[2] / 100;

package/src/convert/xyzToYxy.ts

@@ -7,7 +7,9 @@ import type Yxy from "../types/Yxy.js";
  * @returns The CIEXYZ color in yxy format.
  * @public
  */
-export default function xyzToYxy(color: Xyz): [number, number, number] & Yxy {
+export default function xyzToYxy(
+	color: Readonly<Xyz>
+): [number, number, number] & Yxy {
 	const X = color[0];
 
 	const Y = color[1];

package/src/convert/yxyToXyz.ts

@@ -7,7 +7,9 @@ import type Yxy from "../types/Yxy.js";
  * @returns A CIEXYZ color.
  * @public
  */
-export default function yxyToXyz(color: Yxy): [number, number, number] & Xyz {
+export default function yxyToXyz(
+	color: Readonly<Yxy>
+): [number, number, number] & Xyz {
 	const Y = color[0];
 
 	const x = color[1];

package/src/delta/deltaC.ts

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

package/src/delta/deltaCmc.ts

@@ -14,9 +14,9 @@ const c1 = Math.PI / 180;
  * @public
  */
 export default function deltaCmc(
-	color0: Lab,
-	color1: Lab,
-	weight: Lchab = [1, 1, 1]
+	color0: Readonly<Lab>,
+	color1: Readonly<Lab>,
+	weight: Readonly<Lchab> = [1, 1, 1]
 ): number {
 	const l0 = color0[0];
 

package/src/delta/deltaE00.ts

@@ -38,9 +38,9 @@ const cieLabToHue = (a: number, b: number): number =>
  * @public
  */
 export default function deltaE00(
-	color0: Lab,
-	color1: Lab,
-	weight: Lchab = [1, 1, 1]
+	color0: Readonly<Lab>,
+	color1: Readonly<Lab>,
+	weight: Readonly<Lchab> = [1, 1, 1]
 ): number {
 	const l0 = color0[0];
 

package/src/delta/deltaE76.ts

@@ -9,7 +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.
@@ -18,8 +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/delta/deltaE94.ts

@@ -11,9 +11,9 @@ import type Lchab from "../types/Lchab.js";
  * @public
  */
 export default function deltaE94(
-	color0: Lab,
-	color1: Lab,
-	weight: Lchab = [1, 1, 1]
+	color0: Readonly<Lab>,
+	color1: Readonly<Lab>,
+	weight: Readonly<Lchab> = [1, 1, 1]
 ): number {
 	const l0 = color0[0];
 

package/src/delta/deltaH.ts

@@ -9,7 +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.
@@ -18,8 +21,14 @@ 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 {
+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];
 
 	const b0 = color0[2];

package/src/names/getName.ts

@@ -17,7 +17,7 @@ import ntc from "./ntc.js";
  */
 export default function getName<T extends Color>(
 	color: T,
-	names: Map<string, T>,
+	names: Readonly<Map<string, T>>,
 	diff: (a: T, b: T) => number
 ): string {
 	let [nearestName] = names.entries().next().value ?? [];
@@ -49,8 +49,8 @@ export default function getName<T extends Color>(
  * @public
  */
 export const getNameStandard = (
-	color: Rgb,
-	names: Map<string, Rgb> = ntc
+	color: Readonly<Rgb>,
+	names: Readonly<Map<string, Rgb>> = ntc
 ): string =>
 	getName(color, names, (a, b) =>
 		deltaE00(xyzToLab(rgbToXyz(a)), xyzToLab(rgbToXyz(b)))

package/src/palette/analogous.ts

@@ -13,7 +13,7 @@ const d = 360;
  * @public
  */
 export default function analogous(
-	color: Hsi,
+	color: Readonly<Hsi>,
 	subdivisions?: number
 ): [[number, number, number] & Hsi, [number, number, number] & Hsi];
 /**
@@ -24,7 +24,7 @@ export default function analogous(
  * @public
  */
 export default function analogous(
-	color: Hsl,
+	color: Readonly<Hsl>,
 	subdivisions?: number
 ): [[number, number, number] & Hsl, [number, number, number] & Hsl];
 /**
@@ -35,11 +35,11 @@ export default function analogous(
  * @public
  */
 export default function analogous(
-	color: Hsv,
+	color: Readonly<Hsv>,
 	subdivisions?: number
 ): [[number, number, number] & Hsv, [number, number, number] & Hsv];
 export default function analogous(
-	color: Hsi | Hsl | Hsv,
+	color: Readonly<Hsi | Hsl | Hsv>,
 	subdivisions = 12
 ):
 	| [[number, number, number] & Hsi, [number, number, number] & Hsi]

package/src/palette/analogousLch.ts

@@ -12,7 +12,7 @@ const d = 360;
  * @public
  */
 export default function analogousLch(
-	color: Lchab,
+	color: Readonly<Lchab>,
 	subdivisions?: number
 ): [[number, number, number] & Lchab, [number, number, number] & Lchab];
 /**
@@ -23,11 +23,11 @@ export default function analogousLch(
  * @public
  */
 export default function analogousLch(
-	color: Lchuv,
+	color: Readonly<Lchuv>,
 	subdivisions?: number
 ): [[number, number, number] & Lchuv, [number, number, number] & Lchuv];
 export default function analogousLch(
-	color: Lchab | Lchuv,
+	color: Readonly<Lchab | Lchuv>,
 	subdivisions = 12
 ):
 	| [[number, number, number] & Lchab, [number, number, number] & Lchab]

package/src/palette/complement.ts

@@ -13,7 +13,7 @@ const d = 360;
  * @public
  */
 export default function complement(
-	color: Hsi,
+	color: Readonly<Hsi>,
 	n?: number
 ): ([number, number, number] & Hsi)[];
 /**
@@ -24,7 +24,7 @@ export default function complement(
  * @public
  */
 export default function complement(
-	color: Hsl,
+	color: Readonly<Hsl>,
 	n?: number
 ): ([number, number, number] & Hsl)[];
 /**
@@ -35,11 +35,11 @@ export default function complement(
  * @public
  */
 export default function complement(
-	color: Hsv,
+	color: Readonly<Hsv>,
 	n?: number
 ): ([number, number, number] & Hsv)[];
 export default function complement(
-	color: Hsi | Hsl | Hsv,
+	color: Readonly<Hsi | Hsl | Hsv>,
 	n = 1
 ):
 	| ([number, number, number] & Hsi)[]

package/src/palette/complementLch.ts

@@ -12,7 +12,7 @@ const d = 360;
  * @public
  */
 export default function complementLch(
-	color: Lchab,
+	color: Readonly<Lchab>,
 	n?: number
 ): ([number, number, number] & Lchab)[];
 /**
@@ -23,11 +23,11 @@ export default function complementLch(
  * @public
  */
 export default function complementLch(
-	color: Lchuv,
+	color: Readonly<Lchuv>,
 	n?: number
 ): ([number, number, number] & Lchuv)[];
 export default function complementLch(
-	color: Lchab | Lchuv,
+	color: Readonly<Lchab | Lchuv>,
 	n = 1
 ): ([number, number, number] & Lchab)[] | ([number, number, number] & Lchuv)[] {
 	const l = color[0];

package/src/palette/splitComplement.ts

@@ -13,7 +13,7 @@ const d = 360;
  * @public
  */
 export default function splitComplement(
-	color: Hsi,
+	color: Readonly<Hsi>,
 	subdivisions?: number
 ): [[number, number, number] & Hsi, [number, number, number] & Hsi];
 /**
@@ -24,7 +24,7 @@ export default function splitComplement(
  * @public
  */
 export default function splitComplement(
-	color: Hsl,
+	color: Readonly<Hsl>,
 	subdivisions?: number
 ): [[number, number, number] & Hsl, [number, number, number] & Hsl];
 /**
@@ -35,11 +35,11 @@ export default function splitComplement(
  * @public
  */
 export default function splitComplement(
-	color: Hsv,
+	color: Readonly<Hsv>,
 	subdivisions?: number
 ): [[number, number, number] & Hsv, [number, number, number] & Hsv];
 export default function splitComplement(
-	color: Hsi | Hsl | Hsv,
+	color: Readonly<Hsi | Hsl | Hsv>,
 	subdivisions = 12
 ):
 	| [[number, number, number] & Hsi, [number, number, number] & Hsi]

package/src/palette/splitComplementLch.ts

@@ -12,7 +12,7 @@ const d = 360;
  * @public
  */
 export default function splitComplementLch(
-	color: Lchab,
+	color: Readonly<Lchab>,
 	subdivisions?: number
 ): [[number, number, number] & Lchab, [number, number, number] & Lchab];
 /**
@@ -23,11 +23,11 @@ export default function splitComplementLch(
  * @public
  */
 export default function splitComplementLch(
-	color: Lchuv,
+	color: Readonly<Lchuv>,
 	subdivisions?: number
 ): [[number, number, number] & Lchuv, [number, number, number] & Lchuv];
 export default function splitComplementLch(
-	color: Lchab | Lchuv,
+	color: Readonly<Lchab | Lchuv>,
 	subdivisions = 12
 ):
 	| [[number, number, number] & Lchab, [number, number, number] & Lchab]

package/src/utility/contrast.ts

@@ -11,7 +11,10 @@ import relativeLuminance from "./relativeLuminance.js";
  * @see {@link https://www.w3.org/WAI/standards-guidelines/wcag/ | WCAG 2 Overview}
  * @public
  */
-export default function contrast(color0: Rgb, color1: Rgb): number {
+export default function contrast(
+	color0: Readonly<Rgb>,
+	color1: Readonly<Rgb>
+): number {
 	// Intermediate values.
 	const i0 = relativeLuminance(color0);
 	const i1 = relativeLuminance(color1);

package/src/utility/isWebSafe.ts

@@ -7,7 +7,7 @@ import type Rgb from "../types/Rgb.js";
  * @see {@link https://en.wikipedia.org/wiki/Web_colors | Web colors}
  * @public
  */
-export default function isWebSafe(color: Rgb): boolean {
+export default function isWebSafe(color: Readonly<Rgb>): boolean {
 	return (
 		color[0] % 0x33 === 0 && color[1] % 0x33 === 0 && color[2] % 0x33 === 0
 	);

package/src/utility/relativeLuminance.ts

@@ -16,7 +16,7 @@ const piecewise = (a: number): number =>
  * @see {@link https://www.w3.org/WAI/GL/wiki/Relative_luminance | Relative luminance}
  * @public
  */
-export default function relativeLuminance(color: Rgb): number {
+export default function relativeLuminance(color: Readonly<Rgb>): number {
 	return (
 		0.2126 * piecewise(color[0] / 0xff) +
 		0.7152 * piecewise(color[1] / 0xff) +