@oscarpalmer/atoms 0.191.0 → 0.192.0

package/src/color/instance.ts

@@ -1,4 +1,12 @@
-import {PROPERTY_COLOR, TYPE_HEX, TYPE_HSL, TYPE_HWB, TYPE_RGB} from './constants';
+import {
+	clearSubscriptions,
+	getSubscription,
+	getSubscriptions,
+	type Subscription,
+	type SubscriptionProperty,
+	type Subscriptions,
+} from '../internal/subscription';
+import {COLOR_PROPERTY, COLOR_TYPE} from './constants';
 import {getAlpha} from './misc/alpha';
 import {formatHslColor, formatHwbColor, formatRgbColor} from './misc/format';
 import {
@@ -13,7 +21,13 @@ import type {Color, ColorState, ColorType} from './models';
 
 // #region Types
 
-type SetValue = (state: ColorState, value: any, alpha: boolean) => void;
+type SetValue = (
+	color: Color,
+	state: ColorState,
+	subscriptions: Subscriptions<Function>,
+	value: any,
+	alpha: boolean,
+) => void;
 
 type SetValues = Record<ColorType, SetValue>;
 
@@ -24,17 +38,22 @@ type SetValues = Record<ColorType, SetValue>;
 export function color(value: unknown): Color {
 	const state = getColorState(value);
 
+	const subscriptions = getSubscriptions<Function>(COLOR_TYPE.all);
+
 	const instance = {
+		subscribe: (first?: unknown, second?: unknown) =>
+			subscribeToColor(subscriptions, first, second),
 		toHexString: (alpha?: boolean) =>
 			`#${alpha === true ? (instance as Color).hexa : (instance as Color).hex}`,
 		toHslString: (alpha?: boolean) => formatHslColor(state, alpha),
 		toHwbString: (alpha?: boolean) => formatHwbColor(state, alpha),
 		toRgbString: (alpha?: boolean) => formatRgbColor(state, alpha),
 		toString: () => (instance as Color).toHexString(),
+		unsubscribe: () => clearSubscriptions(subscriptions),
 	};
 
 	Object.defineProperties(instance, {
-		[PROPERTY_COLOR]: {
+		[COLOR_PROPERTY.name]: {
 			enumerable: false,
 			value: true,
 		},
@@ -43,18 +62,18 @@ export function color(value: unknown): Color {
 			get: () => state.alpha.value,
 			set: (value: unknown) => setAlphaValue(state, value),
 		},
-		hex: getProperty(TYPE_HEX, state, false),
-		hexa: getProperty(TYPE_HEX, state, true),
-		hsl: getProperty(TYPE_HSL, state, false),
-		hsla: getProperty(TYPE_HSL, state, true),
-		hwb: getProperty(TYPE_HWB, state, false),
-		hwba: getProperty(TYPE_HWB, state, true),
+		hex: getProperty(COLOR_TYPE.hex, instance as Color, state, subscriptions, false),
+		hexa: getProperty(COLOR_TYPE.hex, instance as Color, state, subscriptions, true),
+		hsl: getProperty(COLOR_TYPE.hsl, instance as Color, state, subscriptions, false),
+		hsla: getProperty(COLOR_TYPE.hsl, instance as Color, state, subscriptions, true),
+		hwb: getProperty(COLOR_TYPE.hwb, instance as Color, state, subscriptions, false),
+		hwba: getProperty(COLOR_TYPE.hwb, instance as Color, state, subscriptions, true),
 		origin: {
 			enumerable: true,
 			get: () => state.origin,
 		},
-		rgb: getProperty(TYPE_RGB, state, false),
-		rgba: getProperty(TYPE_RGB, state, true),
+		rgb: getProperty(COLOR_TYPE.rgb, instance as Color, state, subscriptions, false),
+		rgba: getProperty(COLOR_TYPE.rgb, instance as Color, state, subscriptions, true),
 	});
 
 	return Object.freeze(instance) as Color;
@@ -62,7 +81,9 @@ export function color(value: unknown): Color {
 
 function getProperty(
 	space: keyof typeof setters,
+	color: Color,
 	state: ColorState,
+	subscriptions: Subscriptions<Function>,
 	alpha: boolean,
 ): PropertyDescriptor {
 	const setValue = setters[space];
@@ -70,7 +91,7 @@ function getProperty(
 	return {
 		enumerable: true,
 		get: () => getValue(space, state, alpha),
-		set: (value: unknown) => setValue(state, value, alpha),
+		set: (value: unknown) => setValue(color, state, subscriptions, value, alpha),
 	};
 }
 
@@ -95,10 +116,42 @@ function setAlphaValue(state: ColorState, value: unknown): void {
 	}
 }
 
+function subscribeToColor(
+	subscriptions: Subscriptions,
+	first: unknown,
+	second?: unknown,
+): Subscription {
+	let key: string | undefined;
+	let value: Function | undefined;
+
+	if (typeof first === 'string') {
+		key = first;
+		value = second as Function;
+	} else if (typeof first === 'function') {
+		value = first;
+	}
+
+	if (typeof value !== 'function') {
+		throw new Error();
+	}
+
+	return getSubscription({
+		key,
+		subscriptions,
+		value,
+		property: colorSubscription,
+	});
+}
+
 // #endregion
 
 // #region Variables
 
+const colorSubscription: SubscriptionProperty = {
+	key: COLOR_PROPERTY.name,
+	value: COLOR_PROPERTY.subscription,
+};
+
 const setters: SetValues = {
 	hex: setHexColor,
 	hsl: setHSLColor,

package/src/color/misc/alpha.ts

@@ -1,14 +1,6 @@
-import {clamp} from '../..';
 import {round} from '../../internal/math/misc';
-import {
-	ALPHA_FULL_HEX_LONG,
-	ALPHA_NONE_HEX,
-	ALPHA_NONE_VALUE,
-	DEFAULT_ALPHA,
-	EXPRESSION_ALPHA_HEX,
-	MAX_HEX,
-	MAX_PERCENT,
-} from '../constants';
+import {clamp} from '../../internal/number';
+import {COLOR_ALPHA, COLOR_DEFAULTS, COLOR_EXPRESSION, COLOR_MAX} from '../constants';
 import type {Alpha} from '../models';
 
 // #region Functions
@@ -18,14 +10,14 @@ export function getAlpha(value: unknown, hex: boolean): Alpha {
 		return getAlphaFromValue(value);
 	}
 
-	if (typeof value !== 'string' || value.toLowerCase() === ALPHA_FULL_HEX_LONG) {
-		return {...DEFAULT_ALPHA};
+	if (typeof value !== 'string' || value.toLowerCase() === COLOR_ALPHA.fullHexLong) {
+		return {...COLOR_DEFAULTS.alpha};
 	}
 
-	if (hex && EXPRESSION_ALPHA_HEX.test(value)) {
+	if (hex && COLOR_EXPRESSION.alphaHex.test(value)) {
 		return {
 			hex: value,
-			value: Number.parseInt(value, 16) / MAX_HEX,
+			value: Number.parseInt(value, 16) / COLOR_MAX.hex,
 		};
 	}
 
@@ -33,15 +25,15 @@ export function getAlpha(value: unknown, hex: boolean): Alpha {
 }
 
 export function getAlphaHexadecimal(value: number): string {
-	if (value === ALPHA_NONE_VALUE) {
-		return ALPHA_NONE_HEX;
+	if (value === COLOR_ALPHA.noneValue) {
+		return COLOR_ALPHA.noneHex;
 	}
 
-	if (value === MAX_PERCENT) {
-		return ALPHA_FULL_HEX_LONG;
+	if (value === COLOR_MAX.percent) {
+		return COLOR_ALPHA.fullHexLong;
 	}
 
-	return round((value / MAX_PERCENT) * MAX_HEX).toString(16);
+	return round((value / COLOR_MAX.percent) * COLOR_MAX.hex).toString(16);
 }
 
 function getAlphaFromValue(value: number): Alpha {
@@ -55,10 +47,10 @@ function getAlphaFromValue(value: number): Alpha {
 
 export function getAlphaValue(original: number): number {
 	if (Number.isNaN(original)) {
-		return MAX_PERCENT;
+		return COLOR_MAX.percent;
 	}
 
-	return clamp(original, ALPHA_NONE_VALUE, MAX_PERCENT);
+	return clamp(original, COLOR_ALPHA.noneValue, COLOR_MAX.percent);
 }
 
 // #endregion

package/src/color/misc/format.ts

@@ -1,23 +1,23 @@
-import {TYPE_HSL, TYPE_HWB, TYPE_RGB} from '../constants';
+import {COLOR_TYPE} from '../constants';
 import type {ColorState} from '../models';
 import {getColorFromState} from './state';
 
 // #region Functions
 
 export function formatHslColor(state: ColorState, alpha?: boolean): string {
-	const {hue, lightness, saturation} = getColorFromState(state, TYPE_HSL);
+	const {hue, lightness, saturation} = getColorFromState(state, COLOR_TYPE.hsl);
 
 	return `hsl(${hue}deg ${saturation}% ${lightness}%${getSuffix(state, alpha)})`;
 }
 
 export function formatHwbColor(state: ColorState, alpha?: boolean): string {
-	const {blackness, hue, whiteness} = getColorFromState(state, TYPE_HWB);
+	const {blackness, hue, whiteness} = getColorFromState(state, COLOR_TYPE.hwb);
 
 	return `hwb(${hue}deg ${whiteness}% ${blackness}%${getSuffix(state, alpha)})`;
 }
 
 export function formatRgbColor(state: ColorState, alpha?: boolean): string {
-	const {blue, green, red} = getColorFromState(state, TYPE_RGB);
+	const {blue, green, red} = getColorFromState(state, COLOR_TYPE.rgb);
 
 	return `rgb(${red} ${green} ${blue}${getSuffix(state, alpha)})`;
 }

package/src/color/misc/get.ts

@@ -1,25 +1,6 @@
 import {round} from '../../internal/math/misc';
-import {clamp} from '../../number';
-import {
-	HEX_BLACK,
-	HEX_WHITE,
-	MAX_DEGREE,
-	MAX_HEX,
-	MAX_PERCENT,
-	SRGB_LUMINANCE_BLUE,
-	SRGB_LUMINANCE_EXPONENT,
-	SRGB_LUMINANCE_GREEN,
-	SRGB_LUMINANCE_MINIMUM,
-	SRGB_LUMINANCE_MODIFIER,
-	SRGB_LUMINANCE_MULTIPLIER,
-	SRGB_LUMINANCE_OFFSET,
-	SRGB_LUMINANCE_RED,
-	SRGB_LUMINANCE_THRESHOLD,
-	TYPE_HEX,
-	TYPE_HSL,
-	TYPE_HWB,
-	TYPE_RGB,
-} from '../constants';
+import {clamp} from '../../internal/number';
+import {COLOR_DEFAULTS, COLOR_MAX, COLOR_SRGB, COLOR_TYPE} from '../constants';
 import {color} from '../instance';
 import type {Color, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor} from '../models';
 import {getColorFromState, getColorState} from './state';
@@ -60,30 +41,32 @@ export function getForegroundColor(value: unknown, hex: true): string;
 export function getForegroundColor(value: unknown): Color;
 
 export function getForegroundColor(value: unknown, hex?: unknown): string | Color {
-	const rgb = getColorFromState(getColorState(value), TYPE_RGB);
+	const rgb = getColorFromState(getColorState(value), COLOR_TYPE.rgb);
 	const {blue, green, red} = rgb;
 
-	const values = [blue / MAX_HEX, green / MAX_HEX, red / MAX_HEX];
+	const values = [blue / COLOR_MAX.hex, green / COLOR_MAX.hex, red / COLOR_MAX.hex];
 	const {length} = values;
 
 	for (let index = 0; index < length; index += 1) {
 		const color = values[index];
 
-		if (color <= SRGB_LUMINANCE_MINIMUM) {
-			values[index] /= SRGB_LUMINANCE_MULTIPLIER;
+		if (color <= COLOR_SRGB.luminanceMinimum) {
+			values[index] /= COLOR_SRGB.luminanceMultiplier;
 		} else {
 			values[index] =
-				((color + SRGB_LUMINANCE_OFFSET) / SRGB_LUMINANCE_MODIFIER) ** SRGB_LUMINANCE_EXPONENT;
+				((color + COLOR_SRGB.luminanceOffset) / COLOR_SRGB.luminanceModifier) **
+				COLOR_SRGB.luminanceExponent;
 		}
 	}
 
 	const luminance =
-		SRGB_LUMINANCE_RED * values[2] +
-		SRGB_LUMINANCE_GREEN * values[1] +
-		SRGB_LUMINANCE_BLUE * values[0];
+		COLOR_SRGB.luminanceRed * values[2] +
+		COLOR_SRGB.luminanceGreen * values[1] +
+		COLOR_SRGB.luminanceBlue * values[0];
 
 	// Rudimentary and ureliable?; implement APCA for more reliable results?
-	const foreground = luminance > SRGB_LUMINANCE_THRESHOLD ? HEX_BLACK : HEX_WHITE;
+	const foreground =
+		luminance > COLOR_SRGB.luminanceThreshold ? COLOR_DEFAULTS.hexBlack : COLOR_DEFAULTS.hexWhite;
 
 	return hex === true ? foreground : color(foreground);
 }
@@ -113,15 +96,15 @@ export function getHexaColor(value: unknown): string {
  * @returns Hex color string
  */
 export function getHexColor(value: unknown): string {
-	return getColorFromState(getColorState(value), TYPE_HEX);
+	return getColorFromState(getColorState(value), COLOR_TYPE.hex);
 }
 
 export function getHexValue(value: unknown): number {
-	return getClampedValue(value, 0, MAX_HEX, true);
+	return getClampedValue(value, 0, COLOR_MAX.hex, true);
 }
 
 export function getDegrees(value: unknown): number {
-	return getClampedValue(value, 0, MAX_DEGREE);
+	return getClampedValue(value, 0, COLOR_MAX.degree);
 }
 
 /**
@@ -135,7 +118,7 @@ export function getDegrees(value: unknown): number {
  */
 export function getHslaColor(value: unknown): HSLAColor {
 	const state = getColorState(value);
-	const hsl = getColorFromState(state, TYPE_HSL);
+	const hsl = getColorFromState(state, COLOR_TYPE.hsl);
 
 	return {
 		...hsl,
@@ -153,7 +136,7 @@ export function getHslaColor(value: unknown): HSLAColor {
  * @returns _HWB_ color
  */
 export function getHwbColor(value: unknown): HWBColor {
-	return getColorFromState(getColorState(value), TYPE_HWB);
+	return getColorFromState(getColorState(value), COLOR_TYPE.hwb);
 }
 
 /**
@@ -167,7 +150,7 @@ export function getHwbColor(value: unknown): HWBColor {
  */
 export function getHwbaColor(value: unknown): HWBAColor {
 	const state = getColorState(value);
-	const hwb = getColorFromState(state, TYPE_HWB);
+	const hwb = getColorFromState(state, COLOR_TYPE.hwb);
 
 	return {
 		...hwb,
@@ -185,11 +168,11 @@ export function getHwbaColor(value: unknown): HWBAColor {
  * @returns _HSL_ color
  */
 export function getHslColor(value: unknown): HSLColor {
-	return getColorFromState(getColorState(value), TYPE_HSL);
+	return getColorFromState(getColorState(value), COLOR_TYPE.hsl);
 }
 
 export function getPercentage(value: unknown): number {
-	return getClampedValue(value, 0, MAX_PERCENT);
+	return getClampedValue(value, 0, COLOR_MAX.percent);
 }
 
 /**
@@ -203,7 +186,7 @@ export function getPercentage(value: unknown): number {
  */
 export function getRgbaColor(value: unknown): RGBAColor {
 	const state = getColorState(value);
-	const rgb = getColorFromState(state, TYPE_RGB);
+	const rgb = getColorFromState(state, COLOR_TYPE.rgb);
 
 	return {
 		...rgb,
@@ -221,7 +204,7 @@ export function getRgbaColor(value: unknown): RGBAColor {
  * @returns _RGB_ color
  */
 export function getRgbColor(value: unknown): RGBColor {
-	return getColorFromState(getColorState(value), TYPE_RGB);
+	return getColorFromState(getColorState(value), COLOR_TYPE.rgb);
 }
 
 // #endregion

package/src/color/misc/is.ts

@@ -1,22 +1,13 @@
+import {isPlainObject} from '../../internal/is';
 import {between} from '../../internal/number';
 import type {PlainObject} from '../../models';
 import {
-	ALPHA_NONE_VALUE,
-	EXPRESSION_HEX_LONG,
-	EXPRESSION_HEX_SHORT,
-	EXPRESSION_PREFIX,
-	KEYS_HSL,
-	KEYS_HSLA,
-	KEYS_HWB,
-	KEYS_HWBA,
-	KEYS_RGB,
-	KEYS_RGBA,
-	LENGTH_LONG,
-	LENGTH_SHORT,
-	MAX_DEGREE,
-	MAX_HEX,
-	MAX_PERCENT,
-	PROPERTY_COLOR,
+	COLOR_ALPHA,
+	COLOR_EXPRESSION,
+	COLOR_KEYS,
+	COLOR_LENGTHS,
+	COLOR_MAX,
+	COLOR_PROPERTY,
 } from '../constants';
 import type {Color} from '../index';
 import type {
@@ -36,11 +27,11 @@ function hasKeys(value: unknown, keys: ColorProperty[]): boolean {
 }
 
 function isAlpha(value: unknown): value is number {
-	return typeof value === 'number' && between(value, ALPHA_NONE_VALUE, MAX_PERCENT);
+	return typeof value === 'number' && between(value, COLOR_ALPHA.noneValue, COLOR_MAX.percent);
 }
 
 function isBytey(value: unknown): value is number {
-	return typeof value === 'number' && between(value, 0, MAX_HEX);
+	return typeof value === 'number' && between(value, 0, COLOR_MAX.hex);
 }
 
 /**
@@ -51,10 +42,7 @@ function isBytey(value: unknown): value is number {
  */
 export function isColor(value: unknown): value is Color {
 	return (
-		typeof value === 'object' &&
-		value !== null &&
-		PROPERTY_COLOR in value &&
-		value[PROPERTY_COLOR] === true
+		isPlainObject(value) && COLOR_PROPERTY.name in value && value[COLOR_PROPERTY.name] === true
 	);
 }
 
@@ -87,7 +75,7 @@ function isColorValue(obj: unknown, properties: ColorProperty[]): boolean {
 }
 
 function isDegree(value: unknown): value is number {
-	return typeof value === 'number' && between(value, 0, MAX_DEGREE);
+	return typeof value === 'number' && between(value, 0, COLOR_MAX.degree);
 }
 
 /**
@@ -111,14 +99,16 @@ export function isHexColor(value: unknown, alpha?: boolean): value is string {
 		return false;
 	}
 
-	if (!(EXPRESSION_HEX_SHORT.test(value) || EXPRESSION_HEX_LONG.test(value))) {
+	if (!(COLOR_EXPRESSION.hexShort.test(value) || COLOR_EXPRESSION.hexLong.test(value))) {
 		return false;
 	}
 
 	if (alpha === false) {
-		const unprefixed = value.replace(EXPRESSION_PREFIX, '');
+		const unprefixed = value.replace(COLOR_EXPRESSION.prefix, '');
 
-		return unprefixed.length === LENGTH_SHORT || unprefixed.length === LENGTH_LONG;
+		return (
+			unprefixed.length === COLOR_LENGTHS.hexShort || unprefixed.length === COLOR_LENGTHS.hexLong
+		);
 	}
 
 	return true;
@@ -131,11 +121,11 @@ export function isHexColor(value: unknown, alpha?: boolean): value is string {
  * @returns `true` if the value is an _HSLA_ color, otherwise `false`
  */
 export function isHslaColor(value: unknown): value is HSLAColor {
-	return isColorValue(value, KEYS_HSLA);
+	return isColorValue(value, COLOR_KEYS.hsla);
 }
 
 export function isHslaLike(value: unknown): value is Record<keyof HSLAColor, unknown> {
-	return hasKeys(value, KEYS_HSLA);
+	return hasKeys(value, COLOR_KEYS.hsla);
 }
 
 /**
@@ -145,11 +135,11 @@ export function isHslaLike(value: unknown): value is Record<keyof HSLAColor, unk
  * @returns `true` if the value is an _HSL_ color, otherwise `false`
  */
 export function isHslColor(value: unknown): value is HSLColor {
-	return isColorValue(value, KEYS_HSLA) || isColorValue(value, KEYS_HSL);
+	return isColorValue(value, COLOR_KEYS.hsla) || isColorValue(value, COLOR_KEYS.hsl);
 }
 
 export function isHslLike(value: unknown): value is Record<keyof HSLColor, unknown> {
-	return hasKeys(value, KEYS_HSL);
+	return hasKeys(value, COLOR_KEYS.hsl);
 }
 
 /**
@@ -159,11 +149,11 @@ export function isHslLike(value: unknown): value is Record<keyof HSLColor, unkno
  * @returns `true` if the value is an _HWBA_ color, otherwise `false`
  */
 export function isHwbaColor(value: unknown): value is HWBAColor {
-	return isColorValue(value, KEYS_HWBA);
+	return isColorValue(value, COLOR_KEYS.hwba);
 }
 
 export function isHwbaLike(value: unknown): value is Record<keyof HWBAColor, unknown> {
-	return hasKeys(value, KEYS_HWBA);
+	return hasKeys(value, COLOR_KEYS.hwba);
 }
 
 /**
@@ -173,11 +163,11 @@ export function isHwbaLike(value: unknown): value is Record<keyof HWBAColor, unk
  * @returns `true` if the value is an _HWB_ color, otherwise `false`
  */
 export function isHwbColor(value: unknown): value is HWBColor {
-	return isColorValue(value, KEYS_HWB) || isColorValue(value, KEYS_HWBA);
+	return isColorValue(value, COLOR_KEYS.hwb) || isColorValue(value, COLOR_KEYS.hwba);
 }
 
 export function isHwbLike(value: unknown): value is Record<keyof HWBColor, unknown> {
-	return hasKeys(value, KEYS_HWB);
+	return hasKeys(value, COLOR_KEYS.hwb);
 }
 
 /**
@@ -187,11 +177,11 @@ export function isHwbLike(value: unknown): value is Record<keyof HWBColor, unkno
  * @returns `true` if the value is an _RGBA_ color, otherwise `false`
  */
 export function isRgbaColor(value: unknown): value is RGBAColor {
-	return isColorValue(value, KEYS_RGBA);
+	return isColorValue(value, COLOR_KEYS.rgba);
 }
 
 export function isRgbaLike(value: unknown): value is Record<keyof RGBAColor, unknown> {
-	return hasKeys(value, KEYS_RGBA);
+	return hasKeys(value, COLOR_KEYS.rgba);
 }
 
 /**
@@ -201,15 +191,15 @@ export function isRgbaLike(value: unknown): value is Record<keyof RGBAColor, unk
  * @returns `true` if the value is an _RGB_ color, otherwise `false`
  */
 export function isRgbColor(value: unknown): value is RGBColor {
-	return isColorValue(value, KEYS_RGBA) || isColorValue(value, KEYS_RGB);
+	return isColorValue(value, COLOR_KEYS.rgba) || isColorValue(value, COLOR_KEYS.rgb);
 }
 
 export function isRgbLike(value: unknown): value is Record<keyof RGBColor, unknown> {
-	return hasKeys(value, KEYS_RGB);
+	return hasKeys(value, COLOR_KEYS.rgb);
 }
 
 function isPercentage(value: unknown): value is number {
-	return typeof value === 'number' && between(value, 0, MAX_PERCENT);
+	return typeof value === 'number' && between(value, 0, COLOR_MAX.percent);
 }
 
 // #endregion