@oscarpalmer/atoms 0.189.0 → 0.190.0

package/dist/color/instance.mjs

@@ -2,222 +2,63 @@ import { formatHslColor, formatHwbColor, formatRgbColor } from "./misc/index.mjs
 import { getAlpha } from "./misc/alpha.mjs";
 import { getColorState, setHSLColor, setHWBColor, setHexColor, setRGBColor } from "./misc/state.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 === true),
+		toHwbString: (alpha) => formatHwbColor(state, alpha === true),
+		toRgbString: (alpha) => formatRgbColor(state, alpha === true),
+		toString: () => instance.toHexString()
+	};
+	Object.defineProperties(instance, {
+		$color: {
+			enumerable: false,
+			get: () => true
+		},
+		alpha: {
+			enumerable: true,
+			get: () => state.alpha.value,
+			set: (value) => {
+				if (typeof value === "number" && !Number.isNaN(value)) state.alpha = getAlpha(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),
+		rgb: getProperty("rgb", state, false),
+		rgba: getProperty("rgb", state, true)
+	});
+	return Object.freeze(instance);
+}
+function getHex(state, alpha) {
+	return alpha ? `${state.hex}${state.alpha.hex}` : state.hex;
+}
+function getProperty(space, state, alpha) {
+	const setter = setters[space];
+	return {
+		enumerable: true,
+		get: () => {
+			const value = state[space];
+			if (typeof value === "string") return getHex(state, alpha);
+			return alpha ? {
+				...value,
+				alpha: state.alpha.value
+			} : { ...value };
+		},
+		set: (value) => {
+			setter(state, value, alpha);
+		}
+	};
+}
+const setters = {
+	hex: setHexColor,
+	hsl: setHSLColor,
+	hwb: setHWBColor,
+	rgb: setRGBColor
 };
 //#endregion
-export { Color };
+export { color };

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

@@ -2,7 +2,7 @@ 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 { 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;
@@ -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

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

@@ -1,7 +1,7 @@
-import { Color } from "../instance.mjs";
+import { ColorState } from "../models.mjs";
 //#region src/color/misc/index.d.ts
-declare function formatHslColor(color: Color, alpha: boolean): string;
-declare function formatHwbColor(color: Color, alpha: boolean): string;
-declare function formatRgbColor(color: Color, alpha: boolean): string;
+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/index.mjs

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

package/dist/color/misc/is.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/is.d.ts
 /**
  * Is the value a _Color_?

package/dist/color/misc/is.mjs

@@ -1,5 +1,5 @@
 import { between } from "../../internal/number.mjs";
-import { EXPRESSION_HEX_LONG, EXPRESSION_HEX_SHORT, KEYS_HSL, KEYS_HSLA, KEYS_HWB, KEYS_HWBA, KEYS_RGB, KEYS_RGBA } from "../constants.mjs";
+import { EXPRESSION_HEX_LONG, EXPRESSION_HEX_SHORT, EXPRESSION_PREFIX, KEYS_HSL, KEYS_HSLA, KEYS_HWB, KEYS_HWBA, KEYS_RGB, KEYS_RGBA } from "../constants.mjs";
 //#region src/color/misc/is.ts
 function hasKeys(value, keys) {
 	return typeof value === "object" && value !== null && keys.every((key) => key in value);
@@ -52,7 +52,10 @@ function isDegree(value) {
 function isHexColor(value, alpha) {
 	if (typeof value !== "string") return false;
 	if (!(EXPRESSION_HEX_SHORT.test(value) || EXPRESSION_HEX_LONG.test(value))) return false;
-	if (alpha === false) return value.length === 3 || value.length === 6;
+	if (alpha === false) {
+		const unprefixed = value.replace(EXPRESSION_PREFIX, "");
+		return unprefixed.length === 3 || unprefixed.length === 6;
+	}
 	return true;
 }
 /**

package/dist/color/models.d.mts

@@ -3,6 +3,163 @@ type Alpha = {
   hex: string;
   value: number;
 };
+/**
+ * A color that is represented in multiple color formats
+ */
+type 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);
+  /**
+   * 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;
+};
 type ColorWithAlpha = {
   /**
    * Alpha channel _(opacity)_ of the color _(in percentage; 0-100)_
@@ -67,7 +224,6 @@ type RGBColor = {
   red: number;
 };
 type ColorProperty = 'alpha' | keyof HSLColor | keyof HWBColor | keyof RGBColor;
-type ColorSpace = 'hsl' | 'rgb';
 type ColorState = {
   alpha: Alpha;
   hex: string;
@@ -76,4 +232,4 @@ type ColorState = {
   rgb: RGBColor;
 };
 //#endregion
-export { Alpha, ColorProperty, ColorSpace, ColorState, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor };
+export { Alpha, Color, ColorProperty, ColorState, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor };

package/dist/function/memoize.d.mts

@@ -3,8 +3,7 @@ import { GenericCallback } from "../models.mjs";
 /**
  * A _Memoized_ function instance, caching and retrieving results based on the its parameters _(or a custom cache key)_
  */
-declare class Memoized<Callback extends GenericCallback> {
-  #private;
+type Memoized<Callback extends GenericCallback> = {
   /**
    * Maximum cache size
    *
@@ -17,7 +16,6 @@ declare class Memoized<Callback extends GenericCallback> {
    * @returns Current cache size _(or `Number.NaN` if the instance has been destroyed)_
    */
   get size(): number;
-  constructor(callback: Callback, options: Options);
   /**
    * Clear the cache
    */
@@ -56,7 +54,7 @@ declare class Memoized<Callback extends GenericCallback> {
    * @returns Cached or computed _(then cached)_ result
    */
   run(...parameters: Parameters<Callback>): ReturnType<Callback>;
-}
+};
 /**
  * Options for a _Memoized_ function
  */
@@ -70,10 +68,6 @@ type MemoizedOptions<Callback extends GenericCallback> = {
    */
   cacheSize?: number;
 };
-type Options = {
-  cacheKey?: GenericCallback;
-  cacheSize: number;
-};
 /**
  * Memoize a function, caching and retrieving results based on the first parameter
  *
@@ -83,4 +77,4 @@ type Options = {
  */
 declare function memoize<Callback extends GenericCallback>(callback: Callback, options?: MemoizedOptions<Callback>): Memoized<Callback>;
 //#endregion
-export { type Memoized, type MemoizedOptions, memoize };
+export { Memoized, MemoizedOptions, memoize };