@oscarpalmer/atoms 0.189.1 → 0.190.0

package/dist/beacon.d.mts

@@ -2,12 +2,15 @@
 /**
  * A beacon is a lighthouse, holding an observable value that can be subscribed to and emitted from
  */
-declare class Beacon<Value> {
-  #private;
+type Beacon<Value> = {
   /**
    * Is the beacon active?
    */
   get active(): boolean;
+  /**
+   * Is the beacon closed?
+   */
+  get closed(): boolean;
   /**
    * The observable that can be subscribed to
    */
@@ -16,11 +19,10 @@ declare class Beacon<Value> {
    * The current value
    */
   get value(): Value;
-  constructor(value: Value, options?: BeaconOptions<Value>);
   /**
-   * Destroy the beacon
+   * Close the beacon
    */
-  destroy(): void;
+  close(): void;
   /**
    * Emit a new value
    *
@@ -39,7 +41,7 @@ declare class Beacon<Value> {
    * Finish the beacon
    */
   finish(): void;
-}
+};
 /**
  * Options for Beacon
  */
@@ -54,16 +56,19 @@ type BeaconOptions<Value> = {
    */
   equal?: (first: Value, second: Value) => boolean;
 };
-/**
- * An observable holds a value and allows observers to subscribe to changes in that value
- */
-declare class Observable<Value> {
-  #private;
-  constructor(instance: Beacon<Value>, observers: Map<Subscription<Value>, Observer<Value>>);
+type Observable<Value> = {
+  /**
+   * Is the observable active?
+   */
+  get active(): boolean;
   /**
-   * Destroy the observable
+   * Is the observable closed?
    */
-  destroy(): void;
+  get closed(): boolean;
+  /**
+   * Close the observable
+   */
+  close(): void;
   /**
    * Subscribe to value changes
    *
@@ -72,19 +77,14 @@ declare class Observable<Value> {
    * @param onComplete Callback for when the observable is completed
    * @returns Subscription to the observable
    */
-  subscribe(onNext: (value: Value) => void, onError?: (error: Error) => void, onComplete?: () => void): Subscription<Value>;
+  subscribe(onNext: (value: Value) => void, onError?: (error: Error) => void, onComplete?: () => void): Subscription;
   /**
    * Subscribe to value changes
    *
    * @param observer Observer for changes
    * @returns Subscription to the observable
    */
-  subscribe(observer: Observer<Value>): Subscription<Value>;
-}
-type ObservableState<Value> = {
-  beacon: Beacon<Value>;
-  closed: boolean;
-  observers: Map<Subscription<Value>, Observer<Value>>;
+  subscribe(observer: Observer<Value>): Subscription;
 };
 /**
  * An observer receives notifications from an observable
@@ -103,25 +103,24 @@ type Observer<Value> = {
    */
   next?: (value: Value) => void;
 };
-/**
- * A subscription represents an active subscription to an observable, holding its state and allowing it to be destroyed or unsubscribed from
- */
-declare class Subscription<Value> {
-  #private;
-  constructor(state: ObservableState<Value>);
+type Subscription = {
+  /**
+   * Is the subscription active?
+   */
+  get active(): boolean;
   /**
    * Is the subscription closed?
    */
   get closed(): boolean;
   /**
-   * Destroy the subscription
+   * Close the subscription
    */
-  destroy(): void;
+  close(): void;
   /**
    * Unsubscribe from its observable
    */
   unsubscribe(): void;
-}
+};
 /**
  * Create a new beacon
  *
@@ -130,5 +129,26 @@ declare class Subscription<Value> {
  * @returns Beacon instance
  */
 declare function beacon<Value>(value: Value, options?: BeaconOptions<Value>): Beacon<Value>;
+/**
+ * Is the value a beacon?
+ *
+ * @param value Value to check
+ * @returns `true` if the value is a beacon, otherwise `false`
+ */
+declare function isBeacon<Value = unknown>(value: unknown): value is Beacon<Value>;
+/**
+ * Is the value an observable?
+ *
+ * @param value Value to check
+ * @returns `true` if the value is an observable, otherwise `false`
+ */
+declare function isObservable<Value = unknown>(value: unknown): value is Observable<Value>;
+/**
+ * Is the value a subscription?
+ *
+ * @param value Value to check
+ * @returns `true` if the value is a subscription, otherwise `false`
+ */
+declare function isSubscription(value: unknown): value is Subscription;
 //#endregion
-export { type Beacon, type BeaconOptions, type Observable, type Observer, type Subscription, beacon };
+export { Beacon, BeaconOptions, Observable, Subscription, beacon, isBeacon, isObservable, isSubscription };

package/dist/beacon.mjs

@@ -2,141 +2,6 @@ import { noop } from "./internal/function/misc.mjs";
 import { isPlainObject } from "./internal/is.mjs";
 //#region src/beacon.ts
 /**
-* A beacon is a lighthouse, holding an observable value that can be subscribed to and emitted from
-*/
-var Beacon = class {
-	#options;
-	#state;
-	/**
-	* Is the beacon active?
-	*/
-	get active() {
-		return this.#state.active;
-	}
-	/**
-	* The observable that can be subscribed to
-	*/
-	get observable() {
-		if (!this.#state.active) throw new Error(MESSAGE_BEACON);
-		return this.#state.observable;
-	}
-	/**
-	* The current value
-	*/
-	get value() {
-		return this.#state.value;
-	}
-	constructor(value, options) {
-		const observers = /* @__PURE__ */ new Map();
-		this.#options = getBeaconOptions(options);
-		this.#state = {
-			observers,
-			value,
-			active: true,
-			observable: new Observable(this, observers)
-		};
-	}
-	/**
-	* Destroy the beacon
-	*/
-	destroy() {
-		finishBeacon(this.#state, false);
-	}
-	/**
-	* Emit a new value
-	*
-	* @param value Value to set and emit
-	* @param finish Finish the beacon after emitting? _(defaults to `false`)_
-	*/
-	emit(value, finish) {
-		this.#on(TYPE_NEXT, value, finish);
-	}
-	/**
-	* Emit an error
-	*
-	* @param value Error to emit
-	* @param finish Finish the beacon after emitting? _(defaults to `false`)_
-	*/
-	error(value, finish) {
-		this.#on(TYPE_ERROR, value, finish);
-	}
-	/**
-	* Finish the beacon
-	*/
-	finish() {
-		finishBeacon(this.#state, true);
-	}
-	#on(type, value, finish) {
-		if (!this.#state.active) return;
-		if (type === TYPE_NEXT) {
-			if (this.#options.equal(this.#state.value, value)) return;
-			this.#state.value = value;
-		}
-		for (const [, observer] of this.#state.observers) observer[type]?.(value);
-		if (finish === true) finishBeacon(this.#state, true);
-	}
-};
-/**
-* An observable holds a value and allows observers to subscribe to changes in that value
-*/
-var Observable = class {
-	#state;
-	constructor(instance, observers) {
-		this.#state = {
-			observers,
-			beacon: instance,
-			closed: false
-		};
-	}
-	/**
-	* Destroy the observable
-	*/
-	destroy() {
-		this.#state.closed = true;
-	}
-	subscribe(first, second, third) {
-		if (this.#state.closed) throw new Error(MESSAGE_OBSERVABLE);
-		const observer = getObserver(first, second, third);
-		const instance = new Subscription(this.#state);
-		this.#state.observers.set(instance, observer);
-		observer.next?.(this.#state.beacon.value);
-		return instance;
-	}
-};
-/**
-* A subscription represents an active subscription to an observable, holding its state and allowing it to be destroyed or unsubscribed from
-*/
-var Subscription = class {
-	#state;
-	constructor(state) {
-		this.#state = {
-			...state,
-			closed: false
-		};
-	}
-	/**
-	* Is the subscription closed?
-	*/
-	get closed() {
-		return this.#state.closed || !this.#state.beacon.active;
-	}
-	/**
-	* Destroy the subscription
-	*/
-	destroy() {
-		if (!this.#state.closed) this.unsubscribe();
-	}
-	/**
-	* Unsubscribe from its observable
-	*/
-	unsubscribe() {
-		if (!this.#state.closed) {
-			this.#state.closed = true;
-			this.#state.observers.delete(this);
-		}
-	}
-};
-/**
 * Create a new beacon
 *
 * @param value Initial value
@@ -144,7 +9,54 @@ var Subscription = class {
 * @returns Beacon instance
 */
 function beacon(value, options) {
-	return new Beacon(value, options);
+	const state = {
+		value,
+		active: true,
+		observable: void 0,
+		observers: /* @__PURE__ */ new Map(),
+		options: getBeaconOptions(options)
+	};
+	const instance = {
+		close: () => {
+			finishBeacon(state, false);
+		},
+		emit: (value, finish) => {
+			update(TYPE_NEXT, state, value, finish);
+		},
+		error: (value, finish) => {
+			update(TYPE_ERROR, state, value, finish);
+		},
+		finish: () => {
+			finishBeacon(state, true);
+		}
+	};
+	Object.defineProperties(instance, {
+		[KEY_BEACON]: {
+			enumerable: false,
+			value: NAME_BEACON
+		},
+		active: {
+			enumerable: true,
+			get: () => state.active
+		},
+		closed: {
+			enumerable: true,
+			get: () => !state.active
+		},
+		observable: {
+			enumerable: true,
+			get: () => {
+				if (!state.active) throw new Error(MESSAGE_BEACON);
+				state.observable ??= observe(state);
+				return state.observable;
+			}
+		},
+		value: {
+			enumerable: true,
+			get: () => state.value
+		}
+	});
+	return Object.freeze(instance);
 }
 function finishBeacon(state, emit) {
 	if (!state.active) return;
@@ -154,10 +66,11 @@ function finishBeacon(state, emit) {
 	for (let index = 0; index < length; index += 1) {
 		const [subscription, observer] = entries[index];
 		if (emit) observer.complete?.();
-		subscription.destroy();
+		subscription.close();
 	}
-	state.observable?.destroy();
+	state.observable?.close();
 	state.observers.clear();
+	state.observable = void 0;
 }
 function getBeaconOptions(input) {
 	const options = isPlainObject(input) ? input : {};
@@ -181,9 +94,118 @@ function getObserver(first, second, third) {
 	}
 	return observer;
 }
-const MESSAGE_BEACON = "Cannot retrieve observable from a destroyed beacon";
-const MESSAGE_OBSERVABLE = "Cannot subscribe to a destroyed observable";
+/**
+* Is the value a beacon?
+*
+* @param value Value to check
+* @returns `true` if the value is a beacon, otherwise `false`
+*/
+function isBeacon(value) {
+	return isBeaconInstance(NAME_BEACON, value);
+}
+function isBeaconInstance(name, value) {
+	return isPlainObject(value) && value[KEY_BEACON] === name;
+}
+/**
+* Is the value an observable?
+*
+* @param value Value to check
+* @returns `true` if the value is an observable, otherwise `false`
+*/
+function isObservable(value) {
+	return isBeaconInstance(NAME_OBSERVABLE, value);
+}
+/**
+* Is the value a subscription?
+*
+* @param value Value to check
+* @returns `true` if the value is a subscription, otherwise `false`
+*/
+function isSubscription(value) {
+	return isBeaconInstance(NAME_SUBSCRIPTION, value);
+}
+function observe(beacon) {
+	const state = {
+		beacon,
+		active: beacon.active
+	};
+	const instance = {
+		close: () => {
+			state.active = false;
+		},
+		subscribe(first, second, third) {
+			if (!beacon.active || !state.active) throw new Error(MESSAGE_OBSERVABLE);
+			const observer = getObserver(first, second, third);
+			const subscription = subscribe(state);
+			beacon.observers.set(subscription, observer);
+			observer.next?.(beacon.value);
+			return subscription;
+		}
+	};
+	Object.defineProperties(instance, {
+		[KEY_BEACON]: {
+			enumerable: false,
+			value: NAME_OBSERVABLE
+		},
+		active: {
+			enumerable: true,
+			get: () => beacon.active && state.active
+		},
+		closed: {
+			enumerable: true,
+			get: () => !beacon.active || !state.active
+		}
+	});
+	return Object.freeze(instance);
+}
+function subscribe(observable) {
+	function unsubscribe() {
+		if (active) {
+			active = false;
+			observable.beacon.observers.delete(instance);
+		}
+	}
+	let active = true;
+	const instance = {
+		close: () => {
+			unsubscribe();
+		},
+		unsubscribe: () => {
+			unsubscribe();
+		}
+	};
+	Object.defineProperties(instance, {
+		[KEY_BEACON]: {
+			enumerable: false,
+			value: NAME_SUBSCRIPTION
+		},
+		active: {
+			enumerable: true,
+			get: () => observable.beacon.active && observable.active && active
+		},
+		closed: {
+			enumerable: true,
+			get: () => !observable.beacon.active || !observable.active || !active
+		}
+	});
+	return Object.freeze(instance);
+}
+function update(type, state, value, finish) {
+	if (!state.active) return;
+	if (type === TYPE_NEXT) {
+		if (state.options.equal(state.value, value)) return;
+		state.value = value;
+	}
+	for (const [, observer] of state.observers) observer[type]?.(value);
+	if (finish === true) finishBeacon(state, true);
+}
+const KEY_BEACON = "$beacon";
+const MESSAGE_BEACON = "Cannot retrieve observable from a closed beacon";
+const MESSAGE_OBSERVABLE = "Cannot subscribe to a closed observable";
+const NAME_BEACON = "beacon";
+const NAME_OBSERVABLE = "observable";
+const NAME_SUBSCRIPTION = "subscription";
 const TYPE_ERROR = "error";
 const TYPE_NEXT = "next";
 //#endregion
-export { beacon };
+export { beacon, isBeacon, isObservable, isSubscription };

package/dist/color/index.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";
 import { getForegroundColor, getHexColor, getHexaColor, getHslColor, getHslaColor, getHwbColor, getHwbaColor, getRgbColor, getRgbaColor } from "./misc/get.mjs";
 import { isColor, isHexColor, isHslColor, isHslLike, isHslaColor, isHwbColor, isHwbLike, isHwbaColor, isHwbaLike, isRgbColor, isRgbLike, isRgbaColor } from "./misc/is.mjs";
 import { getNormalizedHex, hexToHsl, hexToHsla, hexToHwb, hexToHwba, hexToRgb, hexToRgba } from "./space/hex.mjs";

package/dist/color/index.mjs

@@ -4,7 +4,7 @@ import { rgbToHex, rgbToHsl, rgbToHsla, rgbToHwb, rgbToHwba } from "./space/rgb.
 import { getNormalizedHex, hexToHsl, hexToHsla, hexToHwb, hexToHwba, hexToRgb, hexToRgba } from "./space/hex.mjs";
 import { hslToHex, hslToHwb, hslToHwba, hslToRgb, hslToRgba } from "./space/hsl.mjs";
 import { hwbToHex, hwbToHsl, hwbToHsla, hwbToRgb, hwbToRgba } from "./space/hwb.mjs";
-import { Color } from "./instance.mjs";
+import { color } from "./instance.mjs";
 //#region src/color/index.ts
 /**
 * Get a _Color_ from any kind of value
@@ -16,7 +16,7 @@ import { Color } from "./instance.mjs";
 * @returns _Color_ instance
 */
 function getColor(value) {
-	return isColor(value) ? value : new Color(value);
+	return isColor(value) ? value : color(value);
 }
 //#endregion
 export { getColor, getForegroundColor, getHexColor, getHexaColor, getHslColor, getHslaColor, getHwbColor, getHwbaColor, getNormalizedHex, getRgbColor, getRgbaColor, hexToHsl, hexToHsla, hexToHwb, hexToHwba, hexToRgb, hexToRgba, hslToHex, hslToHwb, hslToHwba, hslToRgb, hslToRgba, hwbToHex, hwbToHsl, hwbToHsla, hwbToRgb, hwbToRgba, isColor, isHexColor, isHslColor, isHslLike, isHslaColor, isHwbColor, isHwbLike, isHwbaColor, isHwbaLike, isRgbColor, isRgbLike, isRgbaColor, rgbToHex, rgbToHsl, rgbToHsla, rgbToHwb, rgbToHwba };

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 };