@oscarpalmer/atoms 0.188.1 → 0.189.1

package/dist/color/space/hwb.mjs

@@ -0,0 +1,99 @@
+import { DEFAULT_HWB } from "../constants.mjs";
+import { getAlphaValue } from "../misc/alpha.mjs";
+import { getDegrees, getPercentage } from "../misc/get.mjs";
+import { isHwbLike } from "../misc/is.mjs";
+import { rgbToHex } from "./rgb.mjs";
+import { hslToRgb, hslToRgba } from "./hsl.mjs";
+//#region src/color/space/hwb.ts
+function convertHwbToHsl(input) {
+	let { blackness, hue, whiteness } = isHwbLike(input) ? getHwbValue(input) : DEFAULT_HWB;
+	blackness /= 100;
+	whiteness /= 100;
+	if (blackness + whiteness > 1) {
+		const total = blackness + whiteness;
+		blackness /= total;
+		whiteness /= total;
+	}
+	const lightness = (1 - blackness + whiteness) / 2;
+	return {
+		hue,
+		saturation: getHwbSaturation(blackness, whiteness, lightness) * 100,
+		lightness: lightness * 100,
+		alpha: getAlphaValue(input?.alpha ?? 100)
+	};
+}
+function getHwbSaturation(blackness, whiteness, lightness) {
+	const hue = 1 - blackness - whiteness;
+	if (hue <= 0) return 0;
+	return hue / Math.min(2 * lightness, 2 - 2 * lightness);
+}
+function getHwbValue(value) {
+	return {
+		hue: getDegrees(value.hue),
+		whiteness: getPercentage(value.whiteness),
+		blackness: getPercentage(value.blackness)
+	};
+}
+/**
+* Convert an _HWB(A)_ color to a hex color _(with optional alpha channel, i.e., opacity)_
+*
+* _If the value is unable to be converted, a black hex color will be returned_
+*
+* @param hwb _HWB(A)_ color
+* @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
+* @returns Hex color string
+*/
+function hwbToHex(hwb, alpha) {
+	return rgbToHex(hwbToRgb(hwb), alpha);
+}
+/**
+* Convert an _HWB(A)_ color to an _RGB_ color
+*
+* _If the value is unable to be converted, a black _RGB_ color will be returned_
+*
+* @param hwb _HWB(A)_ color
+* @returns _RGB_ color
+*/
+function hwbToHsl(hwb) {
+	const { hue, lightness, saturation } = convertHwbToHsl(hwb);
+	return {
+		hue,
+		lightness,
+		saturation
+	};
+}
+/**
+* Convert an _HWB(A)_ color to an _HSLA_ color
+*
+* _If the value is unable to be converted, a black _HSLA_ color will be returned_
+*
+* @param hwb _HWB(A)_ color
+* @returns _HSLA_ color
+*/
+function hwbToHsla(hwb) {
+	return convertHwbToHsl(hwb);
+}
+/**
+* Convert an _HWB(A)_ color to an _RGB_ color
+*
+* _If the value is unable to be converted, a black _RGB_ color will be returned_
+*
+* @param hwb _HWB(A)_ color
+* @returns _RGB_ color
+*/
+function hwbToRgb(hwb) {
+	return hslToRgb(hwbToHsl(hwb));
+}
+/**
+* Convert an _HWB(A)_ color to an _RGBA_ color
+*
+* _If the value is unable to be converted, a black _RGBA_ color will be returned_
+*
+* @param hwb _HWB(A)_ color
+* @returns _RGBA_ color
+*/
+function hwbToRgba(hwb) {
+	return hslToRgba(hwbToHsla(hwb));
+}
+//#endregion
+export { convertHwbToHsl, getHwbValue, hwbToHex, hwbToHsl, hwbToHsla, hwbToRgb, hwbToRgba };

package/dist/color/space/rgb.d.mts

@@ -1,8 +1,8 @@
-import { HSLAColor, HSLColor, RGBAColor, RGBColor } from "../models.mjs";
-
+import { HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "../models.mjs";
 //#region src/color/space/rgb.d.ts
 declare function convertRgbToHex(rgb: RGBAColor | RGBColor, alpha: boolean): string;
 declare function convertRgbToHsla(value: unknown): HSLAColor;
+declare function convertRgbToHwba(value: unknown): HWBAColor;
 declare function getRgbValue(value: Record<keyof RGBColor, unknown>): RGBColor;
 /**
  * Convert an _RGB(A)_ color to a hex color _(with optional alpha channel, i.e., opacity)_
@@ -17,7 +17,7 @@ declare function rgbToHex(rgb: RGBAColor | RGBColor, alpha?: boolean): string;
 /**
  * Convert an _RGB(A)_ color to an _HSL_ color
  *
- * _If the value is unable to be converted, a black HSL color will be returned_
+ * _If the value is unable to be converted, a black _HSL_ color will be returned_
  *
  * _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
  *
@@ -28,7 +28,7 @@ declare function rgbToHsl(rgb: RGBAColor | RGBColor): HSLColor;
 /**
  * Convert an _RGB(A)_ color to an _HSLA_ color
  *
- * _If the value is unable to be converted, a black _HSLA_ color with an alpha channel (opacity) of `0` will be returned_
+ * _If the value is unable to be converted, a black _HSLA_ color will be returned_
  *
  * _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
  *
@@ -36,5 +36,26 @@ declare function rgbToHsl(rgb: RGBAColor | RGBColor): HSLColor;
  * @returns _HSLA_ color
  */
 declare function rgbToHsla(rgb: RGBAColor | RGBColor): HSLAColor;
+/**
+ * Convert an _RGB(A)_ color to an _HWB_ color
+ *
+ * _If the value is unable to be converted, a black _HWB_ color will be returned_
+ *
+ * _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
+ *
+ * @param rgb _RGB(A)_ color
+ * @returns _HWB_ color
+ */
+declare function rgbToHwb(rgb: RGBAColor | RGBColor): HWBColor;
+/**
+ * Convert an _RGB(A)_ color to an _HWBA_ color
+ * _If the value is unable to be converted, a black _HWBA_ color will be returned_
+ *
+ * _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
+ *
+ * @param rgb _RGB(A)_ color
+ * @returns _HWBA_ color
+ */
+declare function rgbToHwba(rgb: RGBAColor | RGBColor): HWBAColor;
 //#endregion
-export { convertRgbToHex, convertRgbToHsla, getRgbValue, rgbToHex, rgbToHsl, rgbToHsla };
+export { convertRgbToHex, convertRgbToHsla, convertRgbToHwba, getRgbValue, rgbToHex, rgbToHsl, rgbToHsla, rgbToHwb, rgbToHwba };

package/dist/color/space/rgb.mjs

@@ -1,8 +1,8 @@
 import { join } from "../../internal/string.mjs";
 import { DEFAULT_RGB } from "../constants.mjs";
 import { getAlpha, getAlphaValue } from "../misc/alpha.mjs";
-import { isRgbLike } from "../misc/is.mjs";
 import { getHexValue } from "../misc/get.mjs";
+import { isRgbLike } from "../misc/is.mjs";
 //#region src/color/space/rgb.ts
 function convertRgbToHex(rgb, alpha) {
 	const hex = `${join([
@@ -18,38 +18,46 @@ function convertRgbToHex(rgb, alpha) {
 	return `${hex}${a}`;
 }
 function convertRgbToHsla(value) {
-	const rgb = isRgbLike(value) ? getRgbValue(value) : { ...DEFAULT_RGB };
-	const blue = rgb.blue / 255;
-	const green = rgb.green / 255;
-	const red = rgb.red / 255;
-	const maxHex = Math.max(blue, green, red);
-	const minHex = Math.min(blue, green, red);
-	const delta = maxHex - minHex;
-	const lightness = (minHex + maxHex) / 2;
+	const values = getRgbValues(isRgbLike(value) ? getRgbValue(value) : { ...DEFAULT_RGB });
+	const { delta, max, min } = values;
+	const lightness = (min + max) / 2;
 	let hue = 0;
 	let saturation = 0;
 	if (delta !== 0) {
-		saturation = (maxHex - lightness) / Math.min(lightness, 1 - lightness);
-		switch (maxHex) {
-			case blue:
-				hue = (red - green) / delta + 4;
-				break;
-			case green:
-				hue = (blue - red) / delta + 2;
-				break;
-			case red:
-				hue = (green - blue) / delta + (green < blue ? 6 : 0);
-				break;
-		}
+		saturation = (max - lightness) / Math.min(lightness, 1 - lightness);
+		hue = getRgbHue(values);
+		hue *= 60;
+	}
+	return {
+		hue,
+		saturation: saturation * 100,
+		lightness: lightness * 100,
+		alpha: getAlphaValue(value?.alpha ?? 100)
+	};
+}
+function convertRgbToHwba(value) {
+	const values = getRgbValues(isRgbLike(value) ? getRgbValue(value) : { ...DEFAULT_RGB });
+	const { delta, max, min } = values;
+	let hue = 0;
+	if (delta !== 0) {
+		hue = getRgbHue(values);
 		hue *= 60;
 	}
 	return {
-		alpha: getAlphaValue(value.alpha ?? 1),
-		hue: +hue.toFixed(2),
-		lightness: +(lightness * 100).toFixed(2),
-		saturation: +(saturation * 100).toFixed(2)
+		hue,
+		whiteness: min * 100,
+		blackness: (1 - max) * 100,
+		alpha: getAlphaValue(value?.alpha ?? 100)
 	};
 }
+function getRgbHue(values) {
+	const { blue, delta, green, max, red } = values;
+	switch (max) {
+		case blue: return (red - green) / delta + 4;
+		case green: return (blue - red) / delta + 2;
+		default: return (green - blue) / delta + (green < blue ? 6 : 0);
+	}
+}
 function getRgbValue(value) {
 	return {
 		blue: getHexValue(value.blue),
@@ -57,6 +65,21 @@ function getRgbValue(value) {
 		red: getHexValue(value.red)
 	};
 }
+function getRgbValues(rgb) {
+	const blue = rgb.blue / 255;
+	const green = rgb.green / 255;
+	const red = rgb.red / 255;
+	const max = Math.max(blue, green, red);
+	const min = Math.min(blue, green, red);
+	return {
+		blue,
+		delta: max - min,
+		green,
+		max,
+		min,
+		red
+	};
+}
 /**
 * Convert an _RGB(A)_ color to a hex color _(with optional alpha channel, i.e., opacity)_
 *
@@ -72,7 +95,7 @@ function rgbToHex(rgb, alpha) {
 /**
 * Convert an _RGB(A)_ color to an _HSL_ color
 *
-* _If the value is unable to be converted, a black HSL color will be returned_
+* _If the value is unable to be converted, a black _HSL_ color will be returned_
 *
 * _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
 *
@@ -90,7 +113,7 @@ function rgbToHsl(rgb) {
 /**
 * Convert an _RGB(A)_ color to an _HSLA_ color
 *
-* _If the value is unable to be converted, a black _HSLA_ color with an alpha channel (opacity) of `0` will be returned_
+* _If the value is unable to be converted, a black _HSLA_ color will be returned_
 *
 * _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
 *
@@ -100,5 +123,36 @@ function rgbToHsl(rgb) {
 function rgbToHsla(rgb) {
 	return convertRgbToHsla(rgb);
 }
+/**
+* Convert an _RGB(A)_ color to an _HWB_ color
+*
+* _If the value is unable to be converted, a black _HWB_ color will be returned_
+*
+* _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
+*
+* @param rgb _RGB(A)_ color
+* @returns _HWB_ color
+*/
+function rgbToHwb(rgb) {
+	const { blackness, hue, whiteness } = convertRgbToHwba(rgb);
+	return {
+		hue,
+		whiteness,
+		blackness
+	};
+}
+/**
+* Convert an _RGB(A)_ color to an _HWBA_ color
+
+* _If the value is unable to be converted, a black _HWBA_ color will be returned_
+*
+* _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
+*
+* @param rgb _RGB(A)_ color
+* @returns _HWBA_ color
+*/
+function rgbToHwba(rgb) {
+	return convertRgbToHwba(rgb);
+}
 //#endregion
-export { convertRgbToHex, convertRgbToHsla, getRgbValue, rgbToHex, rgbToHsl, rgbToHsla };
+export { convertRgbToHex, convertRgbToHsla, convertRgbToHwba, getRgbValue, rgbToHex, rgbToHsl, rgbToHsla, rgbToHwb, rgbToHwba };

package/dist/function/assert.d.mts

@@ -1,5 +1,4 @@
 import { Constructor, NestedKeys, NestedValue, PlainObject } from "../models.mjs";
-
 //#region src/function/assert.d.ts
 /**
  * Asserter for a property of a value
@@ -9,7 +8,7 @@ type AssertProperty<Value extends PlainObject, Path extends NestedKeys<Value>, A
  * A function that asserts a value is of a specific type, throwing an error if it is not
  */
 type Asserter<Value> = (value: unknown) => asserts value is Value;
-type NestedPick<Value, Path extends string> = Value extends PlainObject ? Path extends `${infer Head}.${infer Rest}` ? Head extends keyof Value ? { [Key in Head]: NestedPick<Value[Key], Rest> } : never : Path extends keyof Value ? { [Key in Path]: Value[Key] } : never : never;
+type NestedPick<Value, Path extends string> = Value extends PlainObject ? Path extends `${infer Head}.${infer Rest}` ? Head extends keyof Value ? { [Key in Head]: NestedPick<Value[Key], Rest>; } : never : Path extends keyof Value ? { [Key in Path]: Value[Key]; } : never : never;
 /**
  * Asserts that a condition is true, throwing an error if it is not
  *

package/dist/function/limit.d.mts

@@ -1,5 +1,4 @@
 import { AsyncCancelableCallback, CancelableCallback, GenericAsyncCallback, GenericCallback } from "../models.mjs";
-
 //#region src/function/limit.d.ts
 /**
  * Debounce a function, ensuring it is only called after `time` milliseconds have passed

package/dist/function/memoize.d.mts

@@ -1,5 +1,4 @@
 import { GenericCallback } from "../models.mjs";
-
 //#region src/function/memoize.d.ts
 /**
  * A _Memoized_ function instance, caching and retrieving results based on the its parameters _(or a custom cache key)_

package/dist/function/once.d.mts

@@ -1,5 +1,4 @@
 import { GenericAsyncCallback, GenericCallback, OnceAsyncCallback, OnceCallback } from "../models.mjs";
-
 //#region src/function/once.d.ts
 /**
  * Create an asynchronous function that can only be called once, rejecting or resolving the same result on subsequent calls

package/dist/function/retry.d.mts

@@ -1,5 +1,4 @@
 import { GenericAsyncCallback, GenericCallback } from "../models.mjs";
-
 //#region src/function/retry.d.ts
 /**
  * An error thrown when a retry fails

package/dist/function/work.d.mts

@@ -1,6 +1,5 @@
 import { GenericCallback } from "../models.mjs";
 import { UnwrapValue } from "../result/models.mjs";
-
 //#region src/function/work.d.ts
 /**
  * A synchronous _Flow_, a function that pipe a value through a series of functions

package/dist/herald.d.mts

@@ -1,5 +1,4 @@
 import { GenericCallback } from "./models.mjs";
-
 //#region src/herald.d.ts
 declare class Events<Map extends Record<string, GenericCallback>> {
   #private;