@oscarpalmer/atoms 0.193.0 → 0.194.0

package/src/color/misc/state.ts

@@ -1,243 +0,0 @@
-import type {Subscriptions} from '../../internal/subscription';
-import {COLOR_DEFAULTS, COLOR_KEYS, COLOR_LENGTHS, COLOR_MAX, COLOR_TYPE} from '../constants';
-import type {
-	Color,
-	ColorState,
-	ColorType,
-	HSLAColor,
-	HSLColor,
-	HWBAColor,
-	HWBColor,
-	RGBAColor,
-	RGBColor,
-} from '../models';
-import {getColorFromHex, getNormalizedHex} from '../space/hex';
-import {getColorFromHsl, getHslValue} from '../space/hsl';
-import {getColorFromHwb, getHwbValue} from '../space/hwb';
-import {getColorFromRgb, getRgbValue} from '../space/rgb';
-import {getAlpha} from './alpha';
-import {getDegrees, getHexValue, getPercentage} from './get';
-import {isColor, isHexColor, isHslLike, isHwbLike, isRgbLike} from './is';
-
-// #region Functions
-
-export function getColorFromState<Type extends ColorType>(
-	state: ColorState,
-	type: Type,
-): NonNullable<ColorState[Type]> {
-	const {origin} = state;
-
-	if (type === origin) {
-		return state[origin] as NonNullable<ColorState[Type]>;
-	}
-
-	return state[type] ?? (getters[origin](state, type) as NonNullable<ColorState[Type]>);
-}
-
-export function getColorState(value: unknown): ColorState {
-	if (typeof value === 'string') {
-		return getColorStateForHex(value);
-	}
-
-	if (isColor(value)) {
-		const {origin} = value;
-
-		return {
-			origin,
-			[origin]: value[origin],
-			alpha: getAlpha(value.alpha, false),
-		};
-	}
-
-	if (typeof value === 'object' && value !== null) {
-		const state: ColorState = {
-			alpha: getAlpha((value as HSLAColor).alpha, false),
-			origin: undefined as never,
-		};
-
-		if (COLOR_KEYS.hsl.every(key => key in value)) {
-			state.hsl = getHslValue(value as Record<keyof HSLColor, unknown>);
-			state.origin = COLOR_TYPE.hsl;
-		} else if (COLOR_KEYS.hwb.every(key => key in value)) {
-			state.hwb = getHwbValue(value as Record<keyof HWBColor, unknown>);
-			state.origin = COLOR_TYPE.hwb;
-		} else if (COLOR_KEYS.rgb.every(key => key in value)) {
-			state.rgb = getRgbValue(value as Record<keyof RGBColor, unknown>);
-			state.origin = COLOR_TYPE.rgb;
-		}
-
-		if (state.origin != null) {
-			return state;
-		}
-	}
-
-	return getDefaultColorState();
-}
-
-function getColorStateForHex(value: string): ColorState {
-	const normalized = getNormalizedHex(value, true);
-	const hex = normalized.slice(0, COLOR_LENGTHS.hexLong);
-
-	return {
-		hex,
-		alpha: getAlpha(normalized.slice(COLOR_LENGTHS.hexLong), true),
-		origin: COLOR_TYPE.hex,
-	};
-}
-
-function getDefaultColorState(): ColorState {
-	return {
-		alpha: getAlpha(COLOR_MAX.percent, false),
-		hex: COLOR_DEFAULTS.hexBlack,
-		hsl: {...COLOR_DEFAULTS.hsl},
-		hwb: {...COLOR_DEFAULTS.hwb},
-		rgb: {...COLOR_DEFAULTS.rgb},
-		origin: COLOR_TYPE.hex,
-	};
-}
-
-function setColorValue<Type extends ColorType>(
-	color: Color,
-	state: ColorState,
-	subscriptions: Subscriptions<Function>,
-	type: Type,
-	value: ColorState[Type],
-	alpha?: number | string,
-): void {
-	state.hex = undefined;
-	state.hsl = undefined;
-	state.hwb = undefined;
-	state.rgb = undefined;
-
-	state.origin = type;
-	state[type] = value;
-
-	if (alpha != null) {
-		state.alpha = getAlpha(alpha, type === COLOR_TYPE.hex);
-	}
-
-	for (const type of COLOR_TYPE.all) {
-		const callbacks = subscriptions.values.to.keyed?.get(type);
-
-		if (callbacks != null) {
-			for (const callback of callbacks.values()) {
-				callback(color[type]);
-			}
-		}
-	}
-
-	for (const callback of subscriptions.values.to.any.values()) {
-		callback(color);
-	}
-}
-
-export function setHexColor(
-	color: Color,
-	state: ColorState,
-	subscriptions: Subscriptions<Function>,
-	value: string,
-	alpha: boolean,
-): void {
-	if (!isHexColor(value) || (!alpha && value === state.hex)) {
-		return;
-	}
-
-	const normalized = getNormalizedHex(value, true);
-
-	setColorValue(
-		color,
-		state,
-		subscriptions,
-		COLOR_TYPE.hex,
-		normalized.slice(0, COLOR_LENGTHS.hexLong),
-		alpha ? normalized.slice(COLOR_LENGTHS.hexLong) : undefined,
-	);
-}
-
-export function setHSLColor(
-	color: Color,
-	state: ColorState,
-	subscriptions: Subscriptions<Function>,
-	value: unknown,
-	alpha: boolean,
-): void {
-	if (!isHslLike(value)) {
-		return;
-	}
-
-	setColorValue(
-		color,
-		state,
-		subscriptions,
-		COLOR_TYPE.hsl,
-		{
-			hue: getDegrees((value as HSLColor).hue),
-			saturation: getPercentage((value as HSLColor).saturation),
-			lightness: getPercentage((value as HSLColor).lightness),
-		},
-		alpha ? (value as HSLAColor).alpha : undefined,
-	);
-}
-
-export function setHWBColor(
-	color: Color,
-	state: ColorState,
-	subscriptions: Subscriptions<Function>,
-	value: unknown,
-	alpha: boolean,
-): void {
-	if (!isHwbLike(value)) {
-		return;
-	}
-
-	setColorValue(
-		color,
-		state,
-		subscriptions,
-		COLOR_TYPE.hwb,
-		{
-			hue: getDegrees((value as HWBColor).hue),
-			whiteness: getPercentage((value as HWBColor).whiteness),
-			blackness: getPercentage((value as HWBColor).blackness),
-		},
-		alpha ? (value as HWBAColor).alpha : undefined,
-	);
-}
-
-export function setRGBColor(
-	color: Color,
-	state: ColorState,
-	subscriptions: Subscriptions<Function>,
-	value: unknown,
-	alpha: boolean,
-): void {
-	if (!isRgbLike(value)) {
-		return;
-	}
-
-	setColorValue(
-		color,
-		state,
-		subscriptions,
-		COLOR_TYPE.rgb,
-		{
-			red: getHexValue((value as RGBColor).red),
-			green: getHexValue((value as RGBColor).green),
-			blue: getHexValue((value as RGBColor).blue),
-		},
-		alpha ? (value as RGBAColor).alpha : undefined,
-	);
-}
-
-// #endregion
-
-// #region Variables
-
-const getters: Record<ColorType, (state: ColorState, type: ColorType) => any> = {
-	hex: getColorFromHex,
-	hsl: getColorFromHsl,
-	hwb: getColorFromHwb,
-	rgb: getColorFromRgb,
-};
-
-// #endregion

package/src/color/models.ts

@@ -1,389 +0,0 @@
-// #region Types
-
-import type {Subscription} from '../internal/subscription';
-import type {COLOR_ALPHA, COLOR_TYPE} from './constants';
-
-export type Alpha = {
-	hex: string;
-	value: number;
-};
-
-/**
- * A color that is represented in multiple color formats
- */
-export 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);
-
-	/**
-	 * Last color format that was set on the color
-	 *
-	 * @returns Color type
-	 */
-	get origin(): ColorType;
-
-	/**
-	 * 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);
-
-	/**
-	 * Subscribe to alpha channel _(opacity)_ changes of the color
-	 *
-	 * @param key Color property to subscribe to
-	 * @param callback Callback function for changes
-	 */
-	subscribe(key: 'alpha', callback: (value: number) => void): Subscription;
-
-	/**
-	 * Subscribe to hex color changes of the color
-	 *
-	 * @param key Color type to subscribe to
-	 * @param callback Callback function for changes
-	 */
-	subscribe(key: typeof COLOR_TYPE.hex, callback: (value: string) => void): Subscription;
-
-	/**
-	 * Subscribe to hex color changes of the color with alpha channel _(opacity)_
-	 *
-	 * @param key Color type to subscribe to
-	 * @param callback Callback function for changes
-	 */
-	subscribe(key: typeof COLOR_TYPE.hexa, callback: (value: string) => void): Subscription;
-
-	/**
-	 * Subscribe to _HSL_ color changes of the color
-	 *
-	 * @param key Color type to subscribe to
-	 * @param callback Callback function for changes
-	 */
-	subscribe(key: typeof COLOR_TYPE.hsl, callback: (value: HSLColor) => void): Subscription;
-
-	/**
-	 * Subscribe to _HSL(A)_ color changes of the color
-	 *
-	 * @param key Color type to subscribe to
-	 * @param callback Callback function for changes
-	 */
-	subscribe(key: typeof COLOR_TYPE.hsla, callback: (value: HSLAColor) => void): Subscription;
-
-	/**
-	 * Subscribe to _HWB_ color changes of the color
-	 *
-	 * @param key Color type to subscribe to
-	 * @param callback Callback function for changes
-	 */
-	subscribe(key: typeof COLOR_TYPE.hwb, callback: (value: HWBColor) => void): Subscription;
-
-	/**
-	 * Subscribe to _HWB(A)_ color changes of the color
-	 *
-	 * @param key Color type to subscribe to
-	 * @param callback Callback function for changes
-	 */
-	subscribe(key: typeof COLOR_TYPE.hwba, callback: (value: HWBAColor) => void): Subscription;
-
-	/**
-	 * Subscribe to _RGB_ color changes of the color
-	 *
-	 * @param key Color type to subscribe to
-	 * @param callback Callback function for changes
-	 */
-	subscribe(key: typeof COLOR_TYPE.rgb, callback: (value: RGBColor) => void): Subscription;
-
-	/**
-	 * Subscribe to _RGBA_ color changes of the color
-	 *
-	 * @param key Color type to subscribe to
-	 * @param callback Callback function for changes
-	 */
-	subscribe(key: typeof COLOR_TYPE.rgba, callback: (value: RGBAColor) => void): Subscription;
-
-	/**
-	 * Subscribe to any color changes of the color
-	 *
-	 * @param callback Callback function for changes
-	 */
-	subscribe(callback: (value: Color) => void): Subscription;
-
-	/**
-	 * 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;
-
-	/**
-	 * Unsubscribe from all color changes of the color
-	 *
-	 * _(To unsubscribe from a specific color change, use the `unsubscribe()` method on the `Subscription` returned by the individual `subscribe()` method)_
-	 */
-	unsubscribe(): void;
-};
-
-type ColorWithAlpha = {
-	/**
-	 * Alpha channel _(opacity)_ of the color _(in percentage; 0-100)_
-	 */
-	alpha: number;
-};
-
-/**
- * An _HSL_ color with an alpha channel _(opacity)_
- */
-export type HSLAColor = HSLColor & ColorWithAlpha;
-
-/**
- * An _HSL_ color
- */
-export type HSLColor = {
-	/**
-	 * Hue of the color _(in degrees; 0-360)_
-	 */
-	hue: number;
-	/**
-	 * Lightness of the color _(in percentage; 0-100)_
-	 */
-	lightness: number;
-	/**
-	 * Saturation of the color _(in percentage; 0-100)_
-	 */
-	saturation: number;
-};
-
-export type HWBColor = {
-	/**
-	 * Blackness of the color _(in percentage; 0-100)_
-	 */
-	blackness: number;
-	/**
-	 * Hue of the color _(in degrees; 0-360)_
-	 */
-	hue: number;
-	/**
-	 * Whiteness of the color _(in percentage; 0-100)_
-	 */
-	whiteness: number;
-};
-
-export type HWBAColor = HWBColor & ColorWithAlpha;
-
-/**
- * An _RGB_ color with an alpha channel _(opacity)_
- */
-export type RGBAColor = RGBColor & ColorWithAlpha;
-
-/**
- * An _RGB_ color
- */
-export type RGBColor = {
-	/**
-	 * Blue channel of the color _(in hexadecimal; 0-255)_
-	 */
-	blue: number;
-	/**
-	 * Green channel of the color _(in hexadecimal; 0-255)_
-	 */
-	green: number;
-	/**
-	 * Red channel of the color _(in hexadecimal; 0-255)_
-	 */
-	red: number;
-};
-
-export type ColorProperty =
-	| typeof COLOR_ALPHA.name
-	| keyof HSLColor
-	| keyof HWBColor
-	| keyof RGBColor;
-
-export type ColorState = {
-	alpha: Alpha;
-	hex?: string;
-	hsl?: HSLColor;
-	hwb?: HWBColor;
-	origin: ColorType;
-	rgb?: RGBColor;
-};
-
-/**
- * Base color types
- */
-export type ColorType = 'hex' | 'hsl' | 'hwb' | 'rgb';
-
-/**
- * Extended color types
- */
-export type ColorTypeExtended = ColorType | 'hsla' | 'hwba' | 'rgba';
-
-/**
- * Base color values
- */
-export type ColorValue = string | HSLColor | HWBColor | RGBColor;
-
-/**
- * Extended color values
- */
-export type ColorValueExtended = ColorValue | HSLAColor | HWBAColor | RGBAColor;
-
-// #endregion