@oscarpalmer/atoms 0.194.0 → 0.195.1

package/dist/array/index.d.mts

@@ -3,15 +3,15 @@ import { exists } from "./exists.mjs";
 import { find, findLast } from "./find.mjs";
 import { flatten } from "./flatten.mjs";
 import { range, times } from "./from.mjs";
-import { getArray } from "./get.mjs";
 import { chunk } from "../internal/array/chunk.mjs";
 import { compact } from "../internal/array/compact.mjs";
+import { getArray } from "../internal/array/get.mjs";
 import { indexOf, lastIndexOf } from "../internal/array/index-of.mjs";
+import { ArrayComparison, endsWithArray, getArrayComparison, includesArray, indexOfArray, startsWithArray } from "../internal/array/match.mjs";
 import { shuffle } from "../internal/array/shuffle.mjs";
 import { insert } from "./insert.mjs";
 import { intersection } from "./intersection.mjs";
 import { partition } from "./partition.mjs";
-import { ArrayComparison, endsWithArray, getArrayComparison, includesArray, indexOfArray, startsWithArray } from "./match.mjs";
 import { push } from "./push.mjs";
 import { reverse } from "./reverse.mjs";
 import { select } from "./select.mjs";

package/dist/array/index.mjs

@@ -1,17 +1,17 @@
 import { chunk } from "../internal/array/chunk.mjs";
 import { compact } from "../internal/array/compact.mjs";
+import { getArray } from "../internal/array/get.mjs";
 import { indexOf, lastIndexOf } from "../internal/array/index-of.mjs";
+import { endsWithArray, getArrayComparison, includesArray, indexOfArray, startsWithArray } from "../internal/array/match.mjs";
 import { shuffle } from "../internal/array/shuffle.mjs";
 import { difference } from "./difference.mjs";
 import { exists } from "./exists.mjs";
 import { find, findLast } from "./find.mjs";
 import { flatten } from "./flatten.mjs";
 import { range, times } from "./from.mjs";
-import { getArray } from "./get.mjs";
 import { insert } from "./insert.mjs";
 import { intersection } from "./intersection.mjs";
 import { partition } from "./partition.mjs";
-import { endsWithArray, getArrayComparison, includesArray, indexOfArray, startsWithArray } from "./match.mjs";
 import { push } from "./push.mjs";
 import { reverse } from "./reverse.mjs";
 import { select } from "./select.mjs";

package/dist/array/move.mjs

@@ -1,4 +1,4 @@
-import { indexOfArray } from "./match.mjs";
+import { indexOfArray } from "../internal/array/match.mjs";
 import { arraysOverlap } from "../internal/array/overlap.mjs";
 //#region src/array/move.ts
 function move(array, from, to, key) {

package/dist/array/swap.mjs

@@ -1,6 +1,6 @@
 import { getArrayCallback } from "../internal/array/callbacks.mjs";
 import { indexOf } from "../internal/array/index-of.mjs";
-import { indexOfArray } from "./match.mjs";
+import { indexOfArray } from "../internal/array/match.mjs";
 import { arraysOverlap } from "../internal/array/overlap.mjs";
 //#region src/array/swap.ts
 function swap(array, first, second, third) {

package/dist/color/instance.mjs

@@ -1,4 +1,4 @@
-import { herald } from "../herald.mjs";
+import { herald } from "../internal/herald.mjs";
 import { COLOR_PROPERTY, COLOR_TYPE } from "./constants.mjs";
 import { getAlpha } from "./misc/alpha.mjs";
 import { getColorFromState, getColorState, setHSLColor, setHWBColor, setHexColor, setRGBColor } from "./misc/state.mjs";

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

@@ -1,4 +1,4 @@
-import { Herald } from "../../herald.mjs";
+import { Herald } from "../../internal/herald.mjs";
 import { Color, ColorChanges, ColorState, ColorType } from "../models.mjs";
 //#region src/color/misc/state.d.ts
 declare function getColorFromState<Type extends ColorType>(state: ColorState, type: Type): NonNullable<ColorState[Type]>;

package/dist/color/models.d.mts

@@ -1,5 +1,5 @@
 import { Subscription } from "../internal/subscription.mjs";
-import { HeraldEvents } from "../herald.mjs";
+import { HeraldEvents } from "../internal/herald.mjs";
 import { COLOR_ALPHA } from "./constants.mjs";
 //#region src/color/models.d.ts
 type Alpha = {

package/dist/color/space/hex.mjs

@@ -1,4 +1,4 @@
-import { join } from "../../internal/string.mjs";
+import { join } from "../../internal/string/misc.mjs";
 import { COLOR_ALPHA, COLOR_DEFAULTS, COLOR_EXPRESSION, COLOR_LENGTHS, COLOR_MAX, COLOR_TYPE } from "../constants.mjs";
 import { getHexValue, getPercentage } from "../misc/get.mjs";
 import { isHexColor } from "../misc/is.mjs";

package/dist/color/space/rgb.mjs

@@ -1,4 +1,4 @@
-import { join } from "../../internal/string.mjs";
+import { join } from "../../internal/string/misc.mjs";
 import { COLOR_DEFAULTS, COLOR_MAX, COLOR_TYPE } from "../constants.mjs";
 import { getAlpha, getAlphaValue } from "../misc/alpha.mjs";
 import { getHexValue } from "../misc/get.mjs";

package/dist/function/index.d.mts

@@ -1,3 +1,2 @@
 import { noop } from "../internal/function/misc.mjs";
-import { Memoized, MemoizedOptions, memoize } from "./memoize.mjs";
-export { type Memoized, type MemoizedOptions, memoize, noop };
+export { noop };

package/dist/function/index.mjs

@@ -1,3 +1,2 @@
 import { noop } from "../internal/function/misc.mjs";
-import { memoize } from "./memoize.mjs";
-export { memoize, noop };
+export { noop };

package/dist/function/limit.d.mts

@@ -36,6 +36,9 @@ declare function asyncThrottle<Callback extends GenericAsyncCallback | GenericCa
  * @returns Debounced callback handler with a `cancel` method
  */
 declare function debounce<Callback extends GenericCallback>(callback: Callback, time?: number): CancelableCallback<Callback>;
+declare namespace debounce {
+  var async: typeof asyncDebounce;
+}
 /**
  * Throttle a function, ensuring it is only called once every `time` milliseconds
  *
@@ -44,5 +47,8 @@ declare function debounce<Callback extends GenericCallback>(callback: Callback,
  * @returns Throttled callback handler with a `cancel` method
  */
 declare function throttle<Callback extends GenericCallback>(callback: Callback, time?: number): CancelableCallback<Callback>;
+declare namespace throttle {
+  var async: typeof asyncThrottle;
+}
 //#endregion
 export { asyncDebounce, asyncThrottle, debounce, throttle };

package/dist/function/limit.mjs

@@ -52,6 +52,8 @@ function debounce(callback, time) {
 function throttle(callback, time) {
 	return getTimer(TIMER_THROTTLE, callback, time);
 }
+debounce.async = asyncDebounce;
+throttle.async = asyncThrottle;
 Object.defineProperty(debounce, "async", { value: asyncDebounce });
 Object.defineProperty(throttle, "async", { value: asyncThrottle });
 //#endregion

package/dist/function/once.d.mts

@@ -16,5 +16,8 @@ declare function asyncOnce<Callback extends GenericAsyncCallback>(callback: Call
  * @returns _Once_ callback
  */
 declare function once<Callback extends GenericCallback>(callback: Callback): OnceCallback<Callback>;
+declare namespace once {
+  var async: typeof asyncOnce;
+}
 //#endregion
 export { asyncOnce, once };

package/dist/function/once.mjs

@@ -1,4 +1,4 @@
-import { assert } from "./assert.mjs";
+import { assert } from "../internal/function/assert.mjs";
 //#region src/function/once.ts
 /**
 * Create an asynchronous function that can only be called once, rejecting or resolving the same result on subsequent calls
@@ -113,6 +113,7 @@ function once(callback) {
 }
 const ONCE_MESSAGE_CLEARED = "Once has been cleared";
 const ONCE_MESSAGE_EXPECTATION = "Once expected a function";
+once.async = asyncOnce;
 Object.defineProperty(once, "async", { value: asyncOnce });
 //#endregion
 export { asyncOnce, once };

package/dist/function/retry.d.mts

@@ -1,4 +1,4 @@
-import { GenericCallback } from "../models.mjs";
+import { GenericAsyncCallback, GenericCallback } from "../models.mjs";
 //#region src/function/retry.d.ts
 /**
  * An error thrown when a retry fails
@@ -12,6 +12,26 @@ type RetryOptions = {
   times?: number;
   when?: (error: unknown) => boolean;
 };
+/**
+ * Retry a callback a specified number of times, with a delay between attempts
+ *
+ * _Available as `asyncRetry` and `retry.async`_
+ *
+ * @param callback Callback to retry
+ * @param options Retry options
+ * @returns Callback result
+ */
+declare function asyncRetry<Callback extends GenericAsyncCallback>(callback: Callback, options?: RetryOptions): Promise<Awaited<ReturnType<Callback>>>;
+/**
+ * Retry a callback a specified number of times, with a delay between attempts
+ *
+ * _Available as `asyncRetry` and `retry.async`_
+ *
+ * @param callback Callback to retry
+ * @param options Retry options
+ * @returns Callback result
+ */
+declare function asyncRetry<Callback extends GenericCallback>(callback: Callback, options?: RetryOptions): Promise<ReturnType<Callback>>;
 /**
  * Retry a callback a specified number of times
  *
@@ -20,5 +40,8 @@ type RetryOptions = {
  * @returns Callback result
  */
 declare function retry<Callback extends GenericCallback>(callback: Callback, options?: Omit<RetryOptions, 'delay'>): ReturnType<Callback>;
+declare namespace retry {
+  var async: typeof asyncRetry;
+}
 //#endregion
 export { RetryError, RetryOptions, retry };

package/dist/function/retry.mjs

@@ -84,6 +84,7 @@ function shouldRetry() {
 const RETRY_ERROR_NAME = "RetryError";
 const RETRY_MESSAGE_EXPECTATION = "Retry expected a function";
 const RETRY_MESSAGE_FAILED = "Retry failed";
+retry.async = asyncRetry;
 Object.defineProperty(retry, "async", { value: asyncRetry });
 //#endregion
 export { RetryError, retry };

package/dist/herald.d.mts

@@ -1,71 +1,2 @@
-import { GenericCallback } from "./models.mjs";
-import { Subscription, SubscriptionProperty } from "./internal/subscription.mjs";
-//#region src/herald.d.ts
-type Herald<Events extends Record<string, GenericCallback>> = {
-  readonly events: HeraldEvents<Events>;
-  /**
-   * Remove all event subscribers
-   */
-  clear(): void;
-  /**
-   * Emit an event with parameters
-   *
-   * @param event Event name
-   * @param parameters Event parameters
-   */
-  emit<Event extends keyof Events>(event: Event, ...parameters: Parameters<Events[Event]>): void;
-  /**
-   * Is the event observed by any subscribers?
-   *
-   * @param event Event name
-   * @returns `true` if the event is observed, otherwise `false`
-   */
-  observed<Event extends keyof Events>(event: Event): boolean;
-  /**
-   * Subscribe to an event with a callback
-   *
-   * @param event Event name
-   * @param callback Callback function
-   * @param signal Optional abort signal to cancel the subscription
-   * @returns Subscription instance
-   */
-  subscribe<Event extends keyof Events>(event: Event, callback: Events[Event], signal?: AbortSignal): Subscription;
-};
-type HeraldEvents<Events extends Record<string, GenericCallback>> = { [Key in keyof Events]: Key extends '*' ? never : (callback: Events[Key], signal?: AbortSignal) => void; };
-type HeraldOnCreate<Events extends Record<string, GenericCallback>> = <Event extends keyof Events>(event: Event, callback: Events[Event], subscription: Subscription) => void;
-type HeraldOptions<Events extends Record<string, GenericCallback>> = {
-  names: Array<keyof Events>;
-  property?: SubscriptionProperty;
-  onCreate?: HeraldOnCreate<Events>;
-};
-/**
- * Create a _Herald_ for announcing named events
- *
- * @param names Event names
- * @param property Optional property for subscription identification _(defaults to `$herald`)_
- * @returns _Herald_ instance
- */
-declare function herald<Events extends Record<string, GenericCallback>>(options: HeraldOptions<Events>): Herald<Events>;
-/**
- * Is the value events for a herald?
- *
- * @param value Value to check
- * @returns `true` if the value is events for a herald, otherwise `false`
- */
-declare function isHeraldEvents<Events extends Record<string, GenericCallback> = Record<string, GenericCallback>>(value: unknown): value is HeraldEvents<Events>;
-/**
- * Is the value a herald?
- *
- * @param value Value to check
- * @returns `true` if the value is a herald, otherwise `false`
- */
-declare function isHerald<Events extends Record<string, GenericCallback> = Record<string, GenericCallback>>(value: unknown): value is Herald<Events>;
-/**
- * Is the value a herald subscription?
- *
- * @param value Value to check
- * @returns `true` if the value is a herald subscription, otherwise `false`
- */
-declare function isHeraldSubscription(value: unknown): value is Subscription;
-//#endregion
-export { Herald, HeraldEvents, HeraldOptions, herald, isHerald, isHeraldEvents, isHeraldSubscription };
+import { herald, isHerald, isHeraldEvents, isHeraldSubscription } from "./internal/herald.mjs";
+export { herald, isHerald, isHeraldEvents, isHeraldSubscription };

package/dist/herald.mjs

@@ -1,110 +1,2 @@
-import { isPlainObject } from "./internal/is.mjs";
-import { createSubscriptions, isSubscription } from "./internal/subscription.mjs";
-//#region src/herald.ts
-function createEvents(herald, state) {
-	const events = {};
-	Object.defineProperty(events, HERALD_PROPERTY, { value: HERALD_NAME_EVENTS });
-	for (const key of state.keys) events[key] = (callback, signal) => herald.subscribe(key, callback, signal);
-	return Object.freeze(events);
-}
-function emitForHerald(state, event, ...parameters) {
-	const items = state.subscriptions.state.values.from.keyed?.get(event);
-	if (items == null || items.size === 0) return;
-	for (const [callback] of items) callback(...parameters);
-}
-function getHeraldSubscriptionProperty(input) {
-	if (input == null) return heraldSubscription;
-	const property = isPlainObject(input) ? input : {};
-	if (typeof property.key !== "string" || property.value != null && typeof property.value !== "string") throw new Error(HERALD_MESSAGE_PROPERTY);
-	return {
-		key: property.key,
-		value: property.value
-	};
-}
-function getHeraldState(input) {
-	const options = isPlainObject(input) ? input : {};
-	if (!Array.isArray(options.names) || options.names.length === 0 || !options.names.every((name) => typeof name === "string")) throw new Error(HERALD_MESSAGE_ARRAY);
-	if (options.onCreate != null && typeof options.onCreate !== "function") throw new Error(HERALD_MESSAGE_ONCREATE);
-	const keys = new Set(options.names);
-	const property = getHeraldSubscriptionProperty(options.property);
-	return {
-		keys,
-		subscriptions: createSubscriptions({
-			keys,
-			property
-		}),
-		onCreate: options.onCreate
-	};
-}
-/**
-* Create a _Herald_ for announcing named events
-*
-* @param names Event names
-* @param property Optional property for subscription identification _(defaults to `$herald`)_
-* @returns _Herald_ instance
-*/
-function herald(options) {
-	const state = getHeraldState(options);
-	const instance = {
-		clear: () => state.subscriptions.clear(),
-		emit: (event, ...parameters) => emitForHerald(state, event, ...parameters),
-		observed: (event) => (state.subscriptions.state.items.keyed?.get(event)?.size ?? 0) > 0,
-		subscribe: (key, callback, signal) => subscribeToHerald(state, key, callback, signal)
-	};
-	Object.defineProperties(instance, {
-		[HERALD_PROPERTY]: { value: HERALD_NAME_HERALD },
-		events: {
-			enumerable: true,
-			value: createEvents(instance, state)
-		}
-	});
-	return Object.freeze(instance);
-}
-/**
-* Is the value events for a herald?
-*
-* @param value Value to check
-* @returns `true` if the value is events for a herald, otherwise `false`
-*/
-function isHeraldEvents(value) {
-	return isHeraldInstance(HERALD_NAME_EVENTS, value);
-}
-/**
-* Is the value a herald?
-*
-* @param value Value to check
-* @returns `true` if the value is a herald, otherwise `false`
-*/
-function isHerald(value) {
-	return isHeraldInstance(HERALD_NAME_HERALD, value);
-}
-function isHeraldInstance(name, value) {
-	return isPlainObject(value) && HERALD_PROPERTY in value && value[HERALD_PROPERTY] === name;
-}
-/**
-* Is the value a herald subscription?
-*
-* @param value Value to check
-* @returns `true` if the value is a herald subscription, otherwise `false`
-*/
-function isHeraldSubscription(value) {
-	return isSubscription(value) && value[HERALD_PROPERTY] === "subscription";
-}
-function subscribeToHerald(state, key, callback, signal) {
-	const [subscription, existing] = state.subscriptions.create({
-		key,
-		signal,
-		value: callback
-	});
-	if (!existing) state.onCreate?.(key, callback, subscription);
-	return subscription;
-}
-const HERALD_PROPERTY = "$herald";
-const HERALD_MESSAGE_ARRAY = "Herald requires an array of event names.";
-const HERALD_MESSAGE_ONCREATE = `Herald requires a valid onCreate callback for subscription creation`;
-const HERALD_MESSAGE_PROPERTY = `Herald requires valid property information for subscription identification`;
-const HERALD_NAME_EVENTS = "events";
-const HERALD_NAME_HERALD = "herald";
-const heraldSubscription = { key: HERALD_PROPERTY };
-//#endregion
+import { herald, isHerald, isHeraldEvents, isHeraldSubscription } from "./internal/herald.mjs";
 export { herald, isHerald, isHeraldEvents, isHeraldSubscription };