@oscarpalmer/atoms 0.213.0 → 0.214.0

package/dist/beacon.d.mts

@@ -1,95 +1,8 @@
-import { Subscription } from "./internal/subscription.mjs";
+import { Subscription } from "./models/subscription.model.mjs";
+import { Beacon, BeaconOptions, BeaconState, Observable, Observer } from "./models/beacon.model.mjs";
 //#region src/beacon.d.ts
-/**
- * A beacon is a lighthouse, holding an observable value that can be subscribed to and emitted from
- */
-export type Beacon<Value> = {
-  /**
-   * Is the beacon active?
-   */
-  get active(): boolean;
-  /**
-   * The observable that can be subscribed to
-   */
-  get observable(): Observable<Value>;
-  /**
-   * The current value
-   */
-  get value(): Value;
-  /**
-   * Deactivate the beacon
-   */
-  deactivate(): void;
-  /**
-   * Emit a new value
-   *
-   * @param value Value to set and emit
-   * @param finish Finish the beacon after emitting? _(defaults to `false`)_
-   */
-  emit(value: Value, finish?: boolean): void;
-  /**
-   * Emit an error
-   *
-   * @param value Error to emit
-   * @param finish Finish the beacon after emitting? _(defaults to `false`)_
-   */
-  error(value: Error, finish?: boolean): void;
-  /**
-   * Finish the beacon
-   */
-  finish(): void;
-};
-export type BeaconOptions<Value> = {
-  /**
-   * Method for comparing values for equality
-   *
-   * @param first First value
-   * @param second Second value
-   * @returns `true` if the values are equal, otherwise `false`
-   * @default Object.is
-   */
-  equal?: (first: Value, second: Value) => boolean;
-};
-export type Observable<Value> = {
-  /**
-   * Is the observable active?
-   */
-  get active(): boolean;
-  /**
-   * Deactivate the observable
-   */
-  deactivate(): void;
-  /**
-   * Subscribe to value changes
-   *
-   * @param onNext Callback for when the observable receives a new value
-   * @param onError Callback for when the observable receives an error
-   * @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;
-  /**
-   * Subscribe to value changes
-   *
-   * @param observer Observer for changes
-   * @returns Subscription to the observable
-   */
-  subscribe(observer: Observer<Value>): Subscription;
-};
-type Observer<Value> = {
-  /**
-   * Callback for when the observable is completed
-   */
-  complete?: () => void;
-  /**
-   * Callback for when the observable receives an error
-   */
-  error?: (error: Error) => void;
-  /**
-   * Callback for when the observable receives a new value
-   */
-  next?: (value: Value) => void;
-};
+declare function Beacon(this: any, value: unknown, options?: BeaconOptions<unknown>): void;
+declare function Observable(this: any, beacon: BeaconState<unknown>): void;
 /**
  * Create a new beacon
  *
@@ -119,4 +32,5 @@ export declare function isBeaconSubscription(value: unknown): value is Subscript
  * @returns `true` if the value is an observable, otherwise `false`
  */
 export declare function isObservable<Value = unknown>(value: unknown): value is Observable<Value>;
-//#endregion
+//#endregion
+export type { Beacon, BeaconOptions, Observable, Observer };

package/dist/beacon.mjs

@@ -1,10 +1,9 @@
 import { noop } from "./internal/function/misc.mjs";
 import { isPlainObject } from "./internal/is.mjs";
-import { SUBSCRIPTION_NAME, isSubscription, subscriptions } from "./internal/subscription.mjs";
+import "./models/subscription.model.mjs";
+import { isSubscription, subscriptions } from "./internal/subscription.mjs";
+import { BEACON_MESSAGE_RETRIEVE, BEACON_MESSAGE_SUBSCRIBE, BEACON_NAME, BEACON_OBSERVABLE, BEACON_PROPERTY, BEACON_SYMBOL, BEACON_TYPE_ERROR, BEACON_TYPE_NEXT, beaconSubscription } from "./models/beacon.model.mjs";
 //#region src/beacon.ts
-const BEACON_PROPERTY = "$beacon";
-const BEACON_NAME = "beacon";
-const BEACON_OBSERVABLE = "observable";
 function Beacon(value, options) {
 	this[BEACON_SYMBOL] = {
 		value,
@@ -128,7 +127,7 @@ function isBeacon(value) {
 	return isBeaconInstance(BEACON_NAME, value);
 }
 function isBeaconInstance(name, value) {
-	return typeof value === "object" && value !== null && BEACON_PROPERTY in value && value[BEACON_PROPERTY] === name;
+	return typeof value === "object" && value !== null && "$beacon" in value && value["$beacon"] === name;
 }
 /**
 * Is the value a beacon subscription?
@@ -137,7 +136,7 @@ function isBeaconInstance(name, value) {
 * @returns `true` if the value is a beacon subscription, otherwise `false`
 */
 function isBeaconSubscription(value) {
-	return isSubscription(value) && value[BEACON_PROPERTY] === "subscription";
+	return isSubscription(value) && value["$beacon"] === "subscription";
 }
 /**
 * Is the value an observable?
@@ -163,7 +162,7 @@ function subscribeToObservable(first, second, third) {
 function updateBeacon(instance, type, value, finish) {
 	const state = instance[BEACON_SYMBOL];
 	if (!state.active) return;
-	if (type === BEACON_TYPE_NEXT) {
+	if (type === "next") {
 		if (state.options.equal(state.value, value)) return;
 		state.value = value;
 	}
@@ -171,14 +170,5 @@ function updateBeacon(instance, type, value, finish) {
 	if (subscriptions != null && subscriptions.size > 0) for (const [, observer] of subscriptions) observer[type]?.(value);
 	if (finish === true) closeBeacon(state, true);
 }
-const BEACON_MESSAGE_RETRIEVE = "Cannot retrieve observable from a closed beacon";
-const BEACON_MESSAGE_SUBSCRIBE = "Cannot subscribe to a closed observable";
-const BEACON_SYMBOL = Symbol(BEACON_PROPERTY);
-const BEACON_TYPE_ERROR = "error";
-const BEACON_TYPE_NEXT = "next";
-const beaconSubscription = {
-	key: BEACON_PROPERTY,
-	value: SUBSCRIPTION_NAME
-};
 //#endregion
 export { beacon, isBeacon, isBeaconSubscription, isObservable };

package/dist/color/constants.d.mts

@@ -1,5 +1,5 @@
-import { SubscriptionProperty } from "../internal/subscription.mjs";
-import { ColorDefaults, ColorExpressions, ColorTypeExtended, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "./models.mjs";
+import { SubscriptionProperty } from "../models/subscription.model.mjs";
+import { ColorDefaults, ColorExpressions, ColorTypeExtended, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "../models/color.model.mjs";
 //#region src/color/constants.d.ts
 type ColorTypes = {
   all: Set<"alpha" | ColorTypeExtended>;

package/dist/color/constants.mjs

@@ -1,4 +1,4 @@
-import { SUBSCRIPTION_NAME } from "../internal/subscription.mjs";
+import { SUBSCRIPTION_NAME } from "../models/subscription.model.mjs";
 //#region src/color/constants.ts
 const COLOR_ALPHA = {
 	fullHexShort: "f",

package/dist/color/index.d.mts

@@ -1,4 +1,4 @@
-import { Color, ColorType, ColorTypeExtended, ColorValue, ColorValueExtended, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "./models.mjs";
+import { Color, ColorType, ColorTypeExtended, ColorValue, ColorValueExtended, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "../models/color.model.mjs";
 import { getForegroundColor, getHexColor, getHexaColor, getHslColor, getHslaColor, getHwbColor, getHwbaColor, getRgbColor, getRgbaColor } from "./misc/get.mjs";
 import { isColor, isHexColor, isHslColor, isHslaColor, isHwbColor, isHwbaColor, isRgbColor, isRgbaColor } from "./misc/is.mjs";
 import { getNormalizedHex, hexToHsl, hexToHsla, hexToHwb, hexToHwba, hexToRgb, hexToRgba } from "./space/hex.mjs";

package/dist/color/instance.d.mts

@@ -1,4 +1,4 @@
-import { Color } from "./models.mjs";
+import { Color } from "../models/color.model.mjs";
 //#region src/color/instance.d.ts
 export declare function color(value: unknown): Color;
 //#endregion

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

@@ -1,4 +1,4 @@
-import { Alpha, InternalColor } from "../models.mjs";
+import { Alpha, InternalColor } from "../../models/color.model.mjs";
 //#region src/color/misc/alpha.d.ts
 export declare function getAlpha(value: unknown, hex: boolean): Alpha;
 export declare function getColorAlpha(this: InternalColor): number;

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

@@ -1,4 +1,4 @@
-import { InternalColor } from "../models.mjs";
+import { InternalColor } from "../../models/color.model.mjs";
 //#region src/color/misc/format.d.ts
 export declare function formatHexColor(this: InternalColor, alpha?: boolean): string;
 export declare function formatHslColor(this: InternalColor, alpha?: boolean): string;

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

@@ -1,4 +1,4 @@
-import { Color, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "../models.mjs";
+import { Color, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "../../models/color.model.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/is.d.mts

@@ -1,5 +1,5 @@
-import { Subscription } from "../../internal/subscription.mjs";
-import { Color, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "../models.mjs";
+import { Subscription } from "../../models/subscription.model.mjs";
+import { Color, HSLAColor, HSLColor, HWBAColor, HWBColor, RGBAColor, RGBColor } from "../../models/color.model.mjs";
 //#region src/color/misc/is.d.ts
 /**
  * Is the value a _Color_?

package/dist/color/misc/is.mjs

@@ -1,3 +1,4 @@
+import "../../models/subscription.model.mjs";
 import { isSubscription } from "../../internal/subscription.mjs";
 import { between } from "../../internal/number.mjs";
 import { COLOR_ALPHA, COLOR_EXPRESSION, COLOR_KEYS, COLOR_LENGTHS, COLOR_MAX } from "../constants.mjs";

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

@@ -1,4 +1,4 @@
-import { ColorState, ColorType, HSLAColor, HSLColor, HWBAColor, HWBColor, InternalColor, RGBAColor, RGBColor } from "../models.mjs";
+import { ColorState, ColorType, HSLAColor, HSLColor, HWBAColor, HWBColor, InternalColor, RGBAColor, RGBColor } from "../../models/color.model.mjs";
 //#region src/color/misc/state.d.ts
 export declare function getColorFromState<Type extends ColorType>(state: ColorState, type: Type): NonNullable<ColorState[Type]>;
 export declare function getColorState(value: unknown): ColorState;

package/dist/color/space/hex.d.mts

@@ -1,4 +1,4 @@
-import { ColorState, ColorType, HSLAColor, HSLColor, HWBAColor, HWBColor, InternalColor, RGBAColor, RGBColor } from "../models.mjs";
+import { ColorState, ColorType, HSLAColor, HSLColor, HWBAColor, HWBColor, InternalColor, RGBAColor, RGBColor } from "../../models/color.model.mjs";
 //#region src/color/space/hex.d.ts
 export declare function getColorFromHex<Type extends ColorType>(state: ColorState, type: Type): NonNullable<ColorState[Type]>;
 export declare function getHexColor(this: InternalColor): string;

package/dist/color/space/hsl.d.mts

@@ -1,4 +1,4 @@
-import { ColorState, ColorType, HSLAColor, HSLColor, HWBAColor, HWBColor, InternalColor, RGBAColor, RGBColor } from "../models.mjs";
+import { ColorState, ColorType, HSLAColor, HSLColor, HWBAColor, HWBColor, InternalColor, RGBAColor, RGBColor } from "../../models/color.model.mjs";
 //#region src/color/space/hsl.d.ts
 export declare function getColorFromHsl<Type extends ColorType>(state: ColorState, type: Type): NonNullable<ColorState[Type]>;
 export declare function getHslValue(this: InternalColor): HSLColor;

package/dist/color/space/hwb.d.mts

@@ -1,4 +1,4 @@
-import { ColorState, ColorType, HSLAColor, HSLColor, HWBAColor, HWBColor, InternalColor, RGBAColor, RGBColor } from "../models.mjs";
+import { ColorState, ColorType, HSLAColor, HSLColor, HWBAColor, HWBColor, InternalColor, RGBAColor, RGBColor } from "../../models/color.model.mjs";
 //#region src/color/space/hwb.d.ts
 export declare function convertHwbToHsl(input: HWBAColor | HWBColor): HSLAColor;
 export declare function getColorFromHwb<Type extends ColorType>(state: ColorState, type: Type): NonNullable<ColorState[Type]>;

package/dist/color/space/rgb.d.mts

@@ -1,4 +1,4 @@
-import { ColorState, ColorType, HSLAColor, HSLColor, HWBAColor, HWBColor, InternalColor, RGBAColor, RGBColor } from "../models.mjs";
+import { ColorState, ColorType, HSLAColor, HSLColor, HWBAColor, HWBColor, InternalColor, RGBAColor, RGBColor } from "../../models/color.model.mjs";
 //#region src/color/space/rgb.d.ts
 export declare function convertRgbToHex(rgb: RGBAColor | RGBColor, alpha: boolean): string;
 export declare function convertRgbToHsla(value: unknown): HSLAColor;

package/dist/function/limit.d.mts

@@ -1,5 +1,5 @@
-import { GenericAsyncCallback, GenericCallback } from "../models.mjs";
-import { AsyncLimiter, Limiter } from "../internal/function/limit.mjs";
+import { GenericAsyncCallback, GenericCallback } from "../models/index.mjs";
+import { AsyncLimiter, Limiter } from "../models/function/limiter.model.mjs";
 //#region src/function/limit.d.ts
 /**
  * Debounce a function, ensuring it is only called after `time` milliseconds have passed

package/dist/function/limit.mjs

@@ -1,4 +1,5 @@
-import { LIMITER_DEBOUNCE, LIMITER_THROTTLE, getAsyncLimiter, getLimiter } from "../internal/function/limit.mjs";
+import { LIMITER_DEBOUNCE, LIMITER_THROTTLE } from "../models/function/limiter.model.mjs";
+import { getAsyncLimiter, getLimiter } from "../internal/function/limit.mjs";
 //#region src/function/limit.ts
 /**
 * Debounce a function, ensuring it is only called after `time` milliseconds have passed

package/dist/function/once.d.mts

@@ -1,5 +1,8 @@
-import { GenericAsyncCallback, GenericCallback, Once, OnceAsync } from "../models.mjs";
+import { GenericAsyncCallback, GenericCallback } from "../models/index.mjs";
+import { AsyncOnce, Once } from "../models/function/once.model.mjs";
 //#region src/function/once.d.ts
+declare function AsyncOnce(this: any, callback: GenericAsyncCallback): void;
+declare function Once(this: any, callback: GenericCallback): void;
 /**
  * Create an asynchronous function that can only be called once, rejecting or resolving the same result on subsequent calls
  *
@@ -8,7 +11,7 @@ import { GenericAsyncCallback, GenericCallback, Once, OnceAsync } from "../model
  * @param callback Callback to use once
  * @returns _Once_ callback
  */
-export declare function asyncOnce<Callback extends GenericAsyncCallback>(callback: Callback): OnceAsync<Callback>;
+export declare function asyncOnce<Callback extends GenericAsyncCallback>(callback: Callback): AsyncOnce<Callback>;
 /**
  * Is the value an asynchronous once callback?
  *
@@ -38,4 +41,5 @@ export declare namespace once {
   export var is: typeof isOnce;
   export var isAsync: typeof isAsyncOnce;
 }
-//#endregion
+//#endregion
+export type { AsyncOnce, Once };

package/dist/function/once.mjs

@@ -1,8 +1,6 @@
 import { assert } from "../internal/function/assert.mjs";
+import { ONCE_MESSAGE_CLEARED, ONCE_MESSAGE_EXPECTATION, ONCE_NAME_ASYNC, ONCE_NAME_SYNC, ONCE_PROPERTY, ONCE_SYMBOL } from "../models/function/once.model.mjs";
 //#region src/function/once.ts
-const ONCE_NAME_ASYNC = "asyncOnce";
-const ONCE_NAME_SYNC = "once";
-const ONCE_PROPERTY = "$once";
 function AsyncOnce(callback) {
 	this[ONCE_SYMBOL] = {
 		callback,
@@ -94,9 +92,9 @@ function handleOnceResult(state, value, error) {
 	const items = state.items.splice(0);
 	const { length } = items;
 	for (let index = 0; index < length; index += 1) {
-		const { reject, resolve } = items[index];
-		if (error) reject(value);
-		else resolve(value);
+		const item = items[index];
+		if (error) item.reject(value);
+		else item.resolve(value);
 	}
 }
 /**
@@ -118,7 +116,7 @@ function isOnce(value) {
 	return isOnceInstance(value, ONCE_NAME_SYNC);
 }
 function isOnceInstance(value, name) {
-	return typeof value === "object" && value !== null && ONCE_PROPERTY in value && value[ONCE_PROPERTY] === name;
+	return typeof value === "object" && value !== null && "$once" in value && value["$once"] === name;
 }
 /**
 * Create a function that can only be called once, returning the same value on subsequent calls
@@ -161,9 +159,6 @@ function runOnceAsync(...parameters) {
 		});
 	});
 }
-const ONCE_MESSAGE_CLEARED = "Once has been cleared";
-const ONCE_MESSAGE_EXPECTATION = "Once expected a function";
-const ONCE_SYMBOL = Symbol(ONCE_PROPERTY);
 asyncOnce.is = isAsyncOnce;
 once.async = asyncOnce;
 once.is = isOnce;

package/dist/function/retry.d.mts

@@ -1,17 +1,6 @@
-import { GenericAsyncCallback, GenericCallback } from "../models.mjs";
+import { GenericAsyncCallback, GenericCallback } from "../models/index.mjs";
+import { RetryError, RetryOptions } from "../models/function/retry.model.mjs";
 //#region src/function/retry.d.ts
-/**
- * An error thrown when a retry fails
- */
-export declare class RetryError extends Error {
-  readonly original: unknown;
-  constructor(message: string, original: unknown);
-}
-export type RetryOptions = {
-  delay?: number;
-  times?: number;
-  when?: (error: unknown) => boolean;
-};
 /**
  * Retry a callback a specified number of times, with a delay between attempts
  *
@@ -43,4 +32,5 @@ export declare function retry<Callback extends GenericCallback>(callback: Callba
 export declare namespace retry {
   export var async: typeof asyncRetry;
 }
-//#endregion
+//#endregion
+export { RetryError };

package/dist/function/retry.mjs

@@ -1,20 +1,11 @@
 import { isPlainObject } from "../internal/is.mjs";
 import { asyncAttempt, attempt } from "../internal/result/attempt.mjs";
+import { LIMITER_WAIT } from "../models/function/limiter.model.mjs";
 import { getNumberOrDefault } from "../internal/defaults.mjs";
-import { LIMITER_WAIT, getLimiter } from "../internal/function/limit.mjs";
+import { getLimiter } from "../internal/function/limit.mjs";
+import { RETRY_MESSAGE_EXPECTATION, RETRY_MESSAGE_FAILED, RetryError } from "../models/function/retry.model.mjs";
 //#region src/function/retry.ts
 /**
-* An error thrown when a retry fails
-*/
-var RetryError = class extends Error {
-	original;
-	constructor(message, original) {
-		super(message);
-		this.original = original;
-		this.name = RETRY_ERROR_NAME;
-	}
-};
-/**
 * Retry a callback a specified number of times, with a delay between attempts
 *
 * _Available as `asyncRetry` and `retry.async`_
@@ -77,9 +68,6 @@ function retry(callback, options) {
 function shouldRetry() {
 	return true;
 }
-const RETRY_ERROR_NAME = "RetryError";
-const RETRY_MESSAGE_EXPECTATION = "Retry expected a function";
-const RETRY_MESSAGE_FAILED = "Retry failed";
 retry.async = asyncRetry;
 //#endregion
 export { RetryError, retry };

package/dist/herald.d.mts

@@ -1,3 +1,3 @@
-import { Herald, HeraldEvents } from "./internal/models/herald.model.mjs";
+import { Herald, HeraldEvents, HeraldOptions } from "./models/herald.model.mjs";
 import { herald, isHerald, isHeraldEvents, isHeraldSubscription } from "./internal/herald.mjs";
-export { type Herald, type HeraldEvents, herald, isHerald, isHeraldEvents, isHeraldSubscription };
+export { type Herald, type HeraldEvents, type HeraldOptions, herald, isHerald, isHeraldEvents, isHeraldSubscription };