@oscarpalmer/atoms 0.189.1 → 0.191.0

package/dist/color/instance.d.mts

@@ -1,169 +1,5 @@
-import { HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "./models.mjs";
+import { Color } from "./models.mjs";
 //#region src/color/instance.d.ts
-/**
- * A color that is represented in multiple color formats
- */
-declare class Color {
-  #private;
-  /**
-   * A property to identify this as a Color instance, used for type checking
-   *
-   * @internal
-   */
-  private readonly $color;
-  /**
-   * Get the alpha channel _(opacity)_ of the color as a percentage between `0` and `100`
-   *
-   * @returns Current alpha channel value
-   */
-  get alpha(): number;
-  /**
-   * Set the alpha channel _(opacity)_ of the color as a percentage between `0` and `100`
-   *
-   * @param value New alpha channel value
-   */
-  set alpha(value: number);
-  /**
-   * Get the color as a hex color string
-   *
-   * _Hex color string is returned with no `#`-prefix or alpha channel (opacity)_
-   *
-   * @returns Current color as a hex color string
-   */
-  get hex(): string;
-  /**
-   * Set the color from a hex color string
-   *
-   * - `#`-prefix is optional
-   * - Alpha channel _(opacity)_ will be ignored
-   *
-   * @param value New hex color string
-   */
-  set hex(value: string);
-  /**
-   * Get the color as a hex color with an alpha channel _(opacity)_
-   *
-   * _Hex color string is returned with alpha channel (opacity), but without `#`-prefix_
-   *
-   * @returns Current color as a hex color string
-   */
-  get hexa(): string;
-  /**
-   * Set the color from a hex color string with an alpha channel _(opacity)_
-   *
-   * - `#`-prefix is optional
-   * - Alpha channel _(opacity)_ will be respected
-   *
-   * @param value New hex color string
-   */
-  set hexa(value: string);
-  /**
-   * Get the color as an _HSL_ color
-   *
-   * @returns Current color as an _HSL_ color
-   */
-  get hsl(): HSLColor;
-  /**
-   * Set colors from an _HSL_ color
-   *
-   * @param value New _HSL_ color
-   */
-  set hsl(value: HSLColor);
-  /**
-   * Get the color as an _HSLA_ color
-   *
-   * @returns Current color as an _HSLA_ color
-   */
-  get hsla(): HSLAColor;
-  /**
-   * Set colors and alpha from an _HSLA_ color
-   *
-   * @param value New _HSLA_ color
-   */
-  set hsla(value: HSLAColor);
-  /**
-   * Get the color as an _HWB_ color
-   *
-   * @returns Current color as an _HWB_ color
-   */
-  get hwb(): HWBColor;
-  /**
-   * Set colors from an _HWB_ color
-   *
-   * @param value New _HWB_ color
-   */
-  set hwb(value: HWBColor);
-  /**
-   * Get the color as an _HWBA_ color
-   *
-   * @returns Current color as an _HWBA_ color
-   */
-  get hwba(): HWBAColor;
-  /**
-   * Set colors and alpha from an _HWBA_ color
-   *
-   * @param value New _HWBA_ color
-   */
-  set hwba(value: HWBAColor);
-  /**
-   * Get the color as an _RGB_ color
-   *
-   * @returns Current color as an _RGB_ color
-   */
-  get rgb(): RGBColor;
-  /**
-   * Set colors from an _RGB_ color
-   *
-   * @param value New _RGB_ color
-   */
-  set rgb(value: RGBColor);
-  /**
-   * Get the color as an _RGBA_ color
-   *
-   * @returns Current color as an _RGBA_ color
-   */
-  get rgba(): RGBAColor;
-  /**
-   * Set colors and alpha from an _RGBA_ color
-   *
-   * @param value New _RGBA_ color
-   */
-  set rgba(value: RGBAColor);
-  constructor(value: unknown);
-  /**
-   * Get the color as a hex string
-   *
-   * @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
-   * @returns Hex color string
-   */
-  toHexString(alpha?: boolean): string;
-  /**
-   * Get the color as an _HSL(A)_ string
-   *
-   * @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
-   * @returns _HSL(A)_ color string
-   */
-  toHslString(alpha?: boolean): string;
-  /**
-   * Get the color as an _HWB(A)_ string
-   *
-   * @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
-   * @returns _HWB(A)_ color string
-   */
-  toHwbString(alpha?: boolean): string;
-  /**
-   * Get the color as an _RGB(A)_ string
-   *
-   * @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
-   * @returns _RGB(A)_ color string
-   */
-  toRgbString(alpha?: boolean): string;
-  /**
-   * Get the color as a hex color string
-   *
-   * @returns Hex color string
-   */
-  toString(): string;
-}
+declare function color(value: unknown): Color;
 //#endregion
-export { Color };
+export { color };

package/dist/color/instance.mjs

@@ -1,223 +1,66 @@
-import { formatHslColor, formatHwbColor, formatRgbColor } from "./misc/index.mjs";
+import { PROPERTY_COLOR } from "./constants.mjs";
 import { getAlpha } from "./misc/alpha.mjs";
-import { getColorState, setHSLColor, setHWBColor, setHexColor, setRGBColor } from "./misc/state.mjs";
+import { getColorFromState, getColorState, setHSLColor, setHWBColor, setHexColor, setRGBColor } from "./misc/state.mjs";
+import { formatHslColor, formatHwbColor, formatRgbColor } from "./misc/format.mjs";
 //#region src/color/instance.ts
-/**
-* A color that is represented in multiple color formats
-*/
-var Color = class {
-	#state;
-	/**
-	* Get the alpha channel _(opacity)_ of the color as a percentage between `0` and `100`
-	*
-	* @returns Current alpha channel value
-	*/
-	get alpha() {
-		return this.#state.alpha.value;
-	}
-	/**
-	* Set the alpha channel _(opacity)_ of the color as a percentage between `0` and `100`
-	*
-	* @param value New alpha channel value
-	*/
-	set alpha(value) {
-		if (typeof value === "number" && !Number.isNaN(value)) this.#state.alpha = getAlpha(value);
-	}
-	/**
-	* Get the color as a hex color string
-	*
-	* _Hex color string is returned with no `#`-prefix or alpha channel (opacity)_
-	*
-	* @returns Current color as a hex color string
-	*/
-	get hex() {
-		return this.#state.hex;
-	}
-	/**
-	* Set the color from a hex color string
-	*
-	* - `#`-prefix is optional
-	* - Alpha channel _(opacity)_ will be ignored
-	*
-	* @param value New hex color string
-	*/
-	set hex(value) {
-		setHexColor(this.#state, value, false);
-	}
-	/**
-	* Get the color as a hex color with an alpha channel _(opacity)_
-	*
-	* _Hex color string is returned with alpha channel (opacity), but without `#`-prefix_
-	*
-	* @returns Current color as a hex color string
-	*/
-	get hexa() {
-		return `${this.#state.hex}${this.#state.alpha.hex}`;
-	}
-	/**
-	* Set the color from a hex color string with an alpha channel _(opacity)_
-	*
-	* - `#`-prefix is optional
-	* - Alpha channel _(opacity)_ will be respected
-	*
-	* @param value New hex color string
-	*/
-	set hexa(value) {
-		setHexColor(this.#state, value, true);
-	}
-	/**
-	* Get the color as an _HSL_ color
-	*
-	* @returns Current color as an _HSL_ color
-	*/
-	get hsl() {
-		return { ...this.#state.hsl };
-	}
-	/**
-	* Set colors from an _HSL_ color
-	*
-	* @param value New _HSL_ color
-	*/
-	set hsl(value) {
-		setHSLColor(this.#state, value, false);
-	}
-	/**
-	* Get the color as an _HSLA_ color
-	*
-	* @returns Current color as an _HSLA_ color
-	*/
-	get hsla() {
-		return {
-			...this.#state.hsl,
-			alpha: this.#state.alpha.value
-		};
-	}
-	/**
-	* Set colors and alpha from an _HSLA_ color
-	*
-	* @param value New _HSLA_ color
-	*/
-	set hsla(value) {
-		setHSLColor(this.#state, value, true);
-	}
-	/**
-	* Get the color as an _HWB_ color
-	*
-	* @returns Current color as an _HWB_ color
-	*/
-	get hwb() {
-		return { ...this.#state.hwb };
-	}
-	/**
-	* Set colors from an _HWB_ color
-	*
-	* @param value New _HWB_ color
-	*/
-	set hwb(value) {
-		setHWBColor(this.#state, value, false);
-	}
-	/**
-	* Get the color as an _HWBA_ color
-	*
-	* @returns Current color as an _HWBA_ color
-	*/
-	get hwba() {
-		return {
-			...this.#state.hwb,
-			alpha: this.#state.alpha.value
-		};
-	}
-	/**
-	* Set colors and alpha from an _HWBA_ color
-	*
-	* @param value New _HWBA_ color
-	*/
-	set hwba(value) {
-		setHWBColor(this.#state, value, true);
-	}
-	/**
-	* Get the color as an _RGB_ color
-	*
-	* @returns Current color as an _RGB_ color
-	*/
-	get rgb() {
-		return { ...this.#state.rgb };
-	}
-	/**
-	* Set colors from an _RGB_ color
-	*
-	* @param value New _RGB_ color
-	*/
-	set rgb(value) {
-		setRGBColor(this.#state, value, false);
-	}
-	/**
-	* Get the color as an _RGBA_ color
-	*
-	* @returns Current color as an _RGBA_ color
-	*/
-	get rgba() {
-		return {
-			...this.#state.rgb,
-			alpha: this.#state.alpha.value
-		};
-	}
-	/**
-	* Set colors and alpha from an _RGBA_ color
-	*
-	* @param value New _RGBA_ color
-	*/
-	set rgba(value) {
-		setRGBColor(this.#state, value, true);
-	}
-	constructor(value) {
-		this.#state = getColorState(value);
-		Object.defineProperty(this, "$color", { value: true });
-	}
-	/**
-	* Get the color as a hex string
-	*
-	* @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
-	* @returns Hex color string
-	*/
-	toHexString(alpha) {
-		return `#${alpha === true ? this.hexa : this.hex}`;
-	}
-	/**
-	* Get the color as an _HSL(A)_ string
-	*
-	* @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
-	* @returns _HSL(A)_ color string
-	*/
-	toHslString(alpha) {
-		return formatHslColor(this, alpha === true);
-	}
-	/**
-	* Get the color as an _HWB(A)_ string
-	*
-	* @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
-	* @returns _HWB(A)_ color string
-	*/
-	toHwbString(alpha) {
-		return formatHwbColor(this, alpha === true);
-	}
-	/**
-	* Get the color as an _RGB(A)_ string
-	*
-	* @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
-	* @returns _RGB(A)_ color string
-	*/
-	toRgbString(alpha) {
-		return formatRgbColor(this, alpha === true);
-	}
-	/**
-	* Get the color as a hex color string
-	*
-	* @returns Hex color string
-	*/
-	toString() {
-		return this.toHexString();
-	}
+function color(value) {
+	const state = getColorState(value);
+	const instance = {
+		toHexString: (alpha) => `#${alpha === true ? instance.hexa : instance.hex}`,
+		toHslString: (alpha) => formatHslColor(state, alpha),
+		toHwbString: (alpha) => formatHwbColor(state, alpha),
+		toRgbString: (alpha) => formatRgbColor(state, alpha),
+		toString: () => instance.toHexString()
+	};
+	Object.defineProperties(instance, {
+		[PROPERTY_COLOR]: {
+			enumerable: false,
+			value: true
+		},
+		alpha: {
+			enumerable: true,
+			get: () => state.alpha.value,
+			set: (value) => setAlphaValue(state, value)
+		},
+		hex: getProperty("hex", state, false),
+		hexa: getProperty("hex", state, true),
+		hsl: getProperty("hsl", state, false),
+		hsla: getProperty("hsl", state, true),
+		hwb: getProperty("hwb", state, false),
+		hwba: getProperty("hwb", state, true),
+		origin: {
+			enumerable: true,
+			get: () => state.origin
+		},
+		rgb: getProperty("rgb", state, false),
+		rgba: getProperty("rgb", state, true)
+	});
+	return Object.freeze(instance);
+}
+function getProperty(space, state, alpha) {
+	const setValue = setters[space];
+	return {
+		enumerable: true,
+		get: () => getValue(space, state, alpha),
+		set: (value) => setValue(state, value, alpha)
+	};
+}
+function getValue(space, state, alpha) {
+	const value = getColorFromState(state, space);
+	if (typeof value === "string") return alpha ? `${value}${state.alpha.hex}` : value;
+	return alpha ? {
+		...value,
+		alpha: state.alpha.value
+	} : { ...value };
+}
+function setAlphaValue(state, value) {
+	if (typeof value === "number" && !Number.isNaN(value)) state.alpha = getAlpha(value, false);
+}
+const setters = {
+	hex: setHexColor,
+	hsl: setHSLColor,
+	hwb: setHWBColor,
+	rgb: setRGBColor
 };
 //#endregion
-export { Color };
+export { color };

package/dist/color/misc/alpha.d.mts

@@ -1,6 +1,6 @@
 import { Alpha } from "../models.mjs";
 //#region src/color/misc/alpha.d.ts
-declare function getAlpha(value: unknown): Alpha;
+declare function getAlpha(value: unknown, hex: boolean): Alpha;
 declare function getAlphaHexadecimal(value: number): string;
 declare function getAlphaValue(original: number): number;
 //#endregion

package/dist/color/misc/alpha.mjs

@@ -1,18 +1,21 @@
+import { clamp } from "../../internal/number.mjs";
+import { ALPHA_FULL_HEX_LONG, DEFAULT_ALPHA, EXPRESSION_ALPHA_HEX } from "../constants.mjs";
 import { round } from "../../internal/math/misc.mjs";
-import { ALPHA_FULL_HEX_LONG, DEFAULT_ALPHA } from "../constants.mjs";
+import "../../index.mjs";
 //#region src/color/misc/alpha.ts
-function getAlpha(value) {
+function getAlpha(value, hex) {
 	if (typeof value === "number") return getAlphaFromValue(value);
-	if (typeof value === "string" && value !== ALPHA_FULL_HEX_LONG) return {
+	if (typeof value !== "string" || value.toLowerCase() === ALPHA_FULL_HEX_LONG) return { ...DEFAULT_ALPHA };
+	if (hex && EXPRESSION_ALPHA_HEX.test(value)) return {
 		hex: value,
 		value: Number.parseInt(value, 16) / 255
 	};
-	return { ...DEFAULT_ALPHA };
+	return getAlphaFromValue(Number.parseFloat(value));
 }
 function getAlphaHexadecimal(value) {
 	if (value === 0) return "00";
 	if (value === 100) return ALPHA_FULL_HEX_LONG;
-	return round(value * 255).toString(16);
+	return round(value / 100 * 255).toString(16);
 }
 function getAlphaFromValue(value) {
 	const alpha = getAlphaValue(value);
@@ -22,8 +25,8 @@ function getAlphaFromValue(value) {
 	};
 }
 function getAlphaValue(original) {
-	if (Number.isNaN(original) || original >= 100) return 100;
-	return original <= 0 ? 0 : original;
+	if (Number.isNaN(original)) return 100;
+	return clamp(original, 0, 100);
 }
 //#endregion
 export { getAlpha, getAlphaHexadecimal, getAlphaValue };

package/dist/color/misc/format.d.mts

@@ -0,0 +1,7 @@
+import { ColorState } from "../models.mjs";
+//#region src/color/misc/format.d.ts
+declare function formatHslColor(state: ColorState, alpha?: boolean): string;
+declare function formatHwbColor(state: ColorState, alpha?: boolean): string;
+declare function formatRgbColor(state: ColorState, alpha?: boolean): string;
+//#endregion
+export { formatHslColor, formatHwbColor, formatRgbColor };

package/dist/color/misc/format.mjs

@@ -0,0 +1,20 @@
+import "../constants.mjs";
+import { getColorFromState } from "./state.mjs";
+//#region src/color/misc/format.ts
+function formatHslColor(state, alpha) {
+	const { hue, lightness, saturation } = getColorFromState(state, "hsl");
+	return `hsl(${hue}deg ${saturation}% ${lightness}%${getSuffix(state, alpha)})`;
+}
+function formatHwbColor(state, alpha) {
+	const { blackness, hue, whiteness } = getColorFromState(state, "hwb");
+	return `hwb(${hue}deg ${whiteness}% ${blackness}%${getSuffix(state, alpha)})`;
+}
+function formatRgbColor(state, alpha) {
+	const { blue, green, red } = getColorFromState(state, "rgb");
+	return `rgb(${red} ${green} ${blue}${getSuffix(state, alpha)})`;
+}
+function getSuffix(state, alpha) {
+	return alpha === true ? ` / ${state.alpha.value}%` : "";
+}
+//#endregion
+export { formatHslColor, formatHwbColor, formatRgbColor };

package/dist/color/misc/get.d.mts

@@ -1,5 +1,4 @@
-import { HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "../models.mjs";
-import { Color } from "../instance.mjs";
+import { Color, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "../models.mjs";
 //#region src/color/misc/get.d.ts
 /**
  * Get a foreground color _(usually text)_ based on a background color's luminance as an unprefixed hex color string

package/dist/color/misc/get.mjs

@@ -1,14 +1,14 @@
 import { clamp } from "../../internal/number.mjs";
-import { round } from "../../internal/math/misc.mjs";
 import { HEX_BLACK, HEX_WHITE, SRGB_LUMINANCE_EXPONENT, SRGB_LUMINANCE_MODIFIER, SRGB_LUMINANCE_MULTIPLIER, SRGB_LUMINANCE_OFFSET } from "../constants.mjs";
-import { getColorState } from "./state.mjs";
-import { Color } from "../instance.mjs";
+import { round } from "../../internal/math/misc.mjs";
+import { getColorFromState, getColorState } from "./state.mjs";
+import { color } from "../instance.mjs";
 //#region src/color/misc/get.ts
 function getClampedValue(value, minimum, maximum, rounding) {
 	return typeof value === "number" && !Number.isNaN(value) ? clamp(rounding ?? false ? round(value) : value, minimum, maximum) : minimum;
 }
 function getForegroundColor(value, hex) {
-	const { blue, green, red } = getColorState(value).rgb;
+	const { blue, green, red } = getColorFromState(getColorState(value), "rgb");
 	const values = [
 		blue / 255,
 		green / 255,
@@ -20,8 +20,8 @@ function getForegroundColor(value, hex) {
 		if (color <= .03928) values[index] /= SRGB_LUMINANCE_MULTIPLIER;
 		else values[index] = ((color + SRGB_LUMINANCE_OFFSET) / SRGB_LUMINANCE_MODIFIER) ** SRGB_LUMINANCE_EXPONENT;
 	}
-	const color = .2126 * values[2] + .7152 * values[1] + .0722 * values[0] > .625 ? HEX_BLACK : HEX_WHITE;
-	return hex === true ? color : new Color(color);
+	const foreground = .2126 * values[2] + .7152 * values[1] + .0722 * values[0] > .625 ? HEX_BLACK : HEX_WHITE;
+	return hex === true ? foreground : color(foreground);
 }
 /**
 * Get the hex color _(with alpha channel, i.e., opacity)_ from any kind of value
@@ -46,7 +46,7 @@ function getHexaColor(value) {
 * @returns Hex color string
 */
 function getHexColor(value) {
-	return getColorState(value).hex;
+	return getColorFromState(getColorState(value), "hex");
 }
 function getHexValue(value) {
 	return getClampedValue(value, 0, 255, true);
@@ -64,10 +64,10 @@ function getDegrees(value) {
 * @returns _HSLA_ color
 */
 function getHslaColor(value) {
-	const { alpha, hsl } = getColorState(value);
+	const state = getColorState(value);
 	return {
-		...hsl,
-		alpha: alpha.value
+		...getColorFromState(state, "hsl"),
+		alpha: state.alpha.value
 	};
 }
 /**
@@ -80,7 +80,7 @@ function getHslaColor(value) {
 * @returns _HWB_ color
 */
 function getHwbColor(value) {
-	return getColorState(value).hwb;
+	return getColorFromState(getColorState(value), "hwb");
 }
 /**
 * Get the _HWBA_ color from any kind of value
@@ -92,10 +92,10 @@ function getHwbColor(value) {
 * @returns _HWBA_ color
 */
 function getHwbaColor(value) {
-	const { alpha, hwb } = getColorState(value);
+	const state = getColorState(value);
 	return {
-		...hwb,
-		alpha: alpha.value
+		...getColorFromState(state, "hwb"),
+		alpha: state.alpha.value
 	};
 }
 /**
@@ -108,7 +108,7 @@ function getHwbaColor(value) {
 * @returns _HSL_ color
 */
 function getHslColor(value) {
-	return getColorState(value).hsl;
+	return getColorFromState(getColorState(value), "hsl");
 }
 function getPercentage(value) {
 	return getClampedValue(value, 0, 100);
@@ -123,10 +123,10 @@ function getPercentage(value) {
 * @returns _RGBA_ color
 */
 function getRgbaColor(value) {
-	const { alpha, rgb } = getColorState(value);
+	const state = getColorState(value);
 	return {
-		...rgb,
-		alpha: alpha.value
+		...getColorFromState(state, "rgb"),
+		alpha: state.alpha.value
 	};
 }
 /**
@@ -139,7 +139,7 @@ function getRgbaColor(value) {
 * @returns _RGB_ color
 */
 function getRgbColor(value) {
-	return getColorState(value).rgb;
+	return getColorFromState(getColorState(value), "rgb");
 }
 //#endregion
 export { getDegrees, getForegroundColor, getHexColor, getHexValue, getHexaColor, getHslColor, getHslaColor, getHwbColor, getHwbaColor, getPercentage, getRgbColor, getRgbaColor };