@oscarpalmer/atoms 0.205.0 → 0.207.0

package/dist/array/reverse.mjs

@@ -1,3 +1,4 @@
+import { floor } from "../internal/math/misc.mjs";
 //#region src/array/reverse.ts
 /**
 * Reverse the order of items in an array
@@ -9,7 +10,7 @@ function reverse(array) {
 	if (!Array.isArray(array)) return [];
 	const { length } = array;
 	if (length < 2) return array;
-	const half = Math.floor(length / 2);
+	const half = floor(length / 2);
 	for (let firstIndex = 0; firstIndex < half; firstIndex += 1) {
 		const temporaryItem = array[firstIndex];
 		const secondIndex = length - 1 - firstIndex;

package/dist/array/single.d.mts

@@ -3,7 +3,7 @@ import { PlainObject } from "../models.mjs";
 /**
  * Get the _only_ item matching the given value
  *
- * Throws an error if multiple items match the value
+ * _Throws an error if multiple items match the value_
  *
  * @param array Array to search in
  * @param callback Callback to get an item's value for matching
@@ -23,7 +23,7 @@ export declare function single<Item, Callback extends (item: Item, index: number
 /**
  * Get the _only_ item matching the given value by key
  *
- * Throws an error if multiple items match the value
+ * _Throws an error if multiple items match the value_
  *
  * @param array Array to search in
  * @param key Key to get an item's value for matching
@@ -43,7 +43,7 @@ export declare function single<Item extends PlainObject, ItemKey extends keyof I
 /**
  * Get the _only_ item matching the filter
  *
- * Throws an error if multiple items match the filter
+ * _Throws an error if multiple items match the filter_
  *
  * @param array Array to search in
  * @param filter Filter callback to match items

package/dist/array/sort.mjs

@@ -1,4 +1,5 @@
 import { isPlainObject } from "../internal/is.mjs";
+import { floor, round } from "../internal/math/misc.mjs";
 import { compare } from "../internal/value/compare.mjs";
 //#region src/array/sort.ts
 function Sorter(sorters) {
@@ -48,7 +49,7 @@ function getSortedArrayIndex(array, item) {
 	let low = 0;
 	let high = length - 1;
 	while (low <= high) {
-		const mid = Math.floor((low + high) / 2);
+		const mid = floor((low + high) / 2);
 		if (getComparisonValue(item, array[mid], sorters, sortersLength) < 0) high = mid - 1;
 		else low = mid + 1;
 	}
@@ -103,7 +104,7 @@ function isSortedArray(array) {
 	const sortersLength = sorters.length;
 	let offset = 0;
 	if (length >= SORT_THRESHOLD) {
-		offset = Math.round(length / SORT_PEEK_PERCENTAGE);
+		offset = round(length / SORT_PEEK_PERCENTAGE);
 		offset = offset > SORT_THRESHOLD ? SORT_THRESHOLD : offset;
 		for (let index = 0; index < offset; index += 1) {
 			const [firstItem, firstOffset] = [array[index], array[index + 1]];

package/dist/color/misc/alpha.mjs

@@ -1,6 +1,6 @@
+import { round } from "../../internal/math/misc.mjs";
 import { clamp } from "../../internal/number.mjs";
 import { COLOR_ALPHA, COLOR_DEFAULTS, COLOR_EXPRESSION, COLOR_MAX, COLOR_SYMBOL } from "../constants.mjs";
-import { round } from "../../internal/math/misc.mjs";
 //#region src/color/misc/alpha.ts
 function getAlpha(value, hex) {
 	if (typeof value === "number") return getAlphaFromValue(value);

package/dist/color/misc/get.mjs

@@ -1,6 +1,6 @@
+import { round } from "../../internal/math/misc.mjs";
 import { clamp } from "../../internal/number.mjs";
 import { COLOR_DEFAULTS, COLOR_MAX, COLOR_SRGB, COLOR_TYPE } from "../constants.mjs";
-import { round } from "../../internal/math/misc.mjs";
 import { getColorFromState, getColorState } from "./state.mjs";
 import { color } from "../instance.mjs";
 //#region src/color/misc/get.ts

package/dist/color/space/hsl.mjs

@@ -1,3 +1,4 @@
+import { max, min } from "../../internal/math/aggregate.mjs";
 import { COLOR_DEFAULTS, COLOR_MAX, COLOR_TYPE } from "../constants.mjs";
 import { getAlphaValue } from "../misc/alpha.mjs";
 import { getDegrees, getHexValue, getPercentage } from "../misc/get.mjs";
@@ -9,7 +10,7 @@ function convertHslToHwba(input) {
 	let { hue, lightness, saturation } = isHslLike(input) ? getHslValues(input) : { ...COLOR_DEFAULTS.hsl };
 	lightness /= COLOR_MAX.percent;
 	saturation /= COLOR_MAX.percent;
-	const value = lightness + saturation * Math.min(lightness, 1 - lightness);
+	const value = lightness + saturation * min([lightness, 1 - lightness]);
 	if (value === 0) saturation = 0;
 	else saturation = 2 * (1 - lightness / value);
 	const blackness = 1 - value;
@@ -46,7 +47,11 @@ function getColorFromHsl(state, type) {
 }
 function getHexyValue(hue, lightness, saturation, value) {
 	const part = (value + hue / 30) % 12;
-	return (lightness - saturation * Math.min(lightness, 1 - lightness) * Math.max(-1, Math.min(part - 3, 9 - part, 1))) * COLOR_MAX.hex;
+	return (lightness - saturation * min([lightness, 1 - lightness]) * max([-1, min([
+		part - 3,
+		9 - part,
+		1
+	])])) * COLOR_MAX.hex;
 }
 function getHslValue() {
 	return getStateValue(this, COLOR_TYPE.hsl, false);

package/dist/color/space/hwb.mjs

@@ -1,3 +1,4 @@
+import { min } from "../../internal/math/aggregate.mjs";
 import { COLOR_DEFAULTS, COLOR_MAX, COLOR_TYPE } from "../constants.mjs";
 import { getAlphaValue } from "../misc/alpha.mjs";
 import { getDegrees, getPercentage } from "../misc/get.mjs";
@@ -38,7 +39,7 @@ function getColorFromHwb(state, type) {
 function getHwbSaturation(blackness, whiteness, lightness) {
 	const hue = 1 - blackness - whiteness;
 	if (hue <= 0) return 0;
-	return hue / Math.min(2 * lightness, 2 - 2 * lightness);
+	return hue / min([2 * lightness, 2 - 2 * lightness]);
 }
 function getHwbValue() {
 	return getStateValue(this, COLOR_TYPE.hwb, false);

package/dist/color/space/rgb.mjs

@@ -1,3 +1,4 @@
+import { max, min } from "../../internal/math/aggregate.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";
@@ -20,12 +21,12 @@ function convertRgbToHex(rgb, alpha) {
 }
 function convertRgbToHsla(value) {
 	const values = getRgbCalculationValues(isRgbLike(value) ? getRgbValues(value) : { ...COLOR_DEFAULTS.rgb });
-	const { delta, max, min } = values;
-	const lightness = (min + max) / 2;
+	const { delta, maximum, minimum } = values;
+	const lightness = (minimum + maximum) / 2;
 	let hue = 0;
 	let saturation = 0;
 	if (delta !== 0) {
-		saturation = (max - lightness) / Math.min(lightness, 1 - lightness);
+		saturation = (maximum - lightness) / min([lightness, 1 - lightness]);
 		hue = getRgbHue(values);
 		hue *= 60;
 	}
@@ -38,7 +39,7 @@ function convertRgbToHsla(value) {
 }
 function convertRgbToHwba(value) {
 	const values = getRgbCalculationValues(isRgbLike(value) ? getRgbValues(value) : { ...COLOR_DEFAULTS.rgb });
-	const { delta, max, min } = values;
+	const { delta, maximum, minimum } = values;
 	let hue = 0;
 	if (delta !== 0) {
 		hue = getRgbHue(values);
@@ -46,8 +47,8 @@ function convertRgbToHwba(value) {
 	}
 	return {
 		hue,
-		whiteness: min * COLOR_MAX.percent,
-		blackness: (1 - max) * COLOR_MAX.percent,
+		whiteness: minimum * COLOR_MAX.percent,
+		blackness: (1 - maximum) * COLOR_MAX.percent,
 		alpha: getAlphaValue(value?.alpha ?? COLOR_MAX.percent)
 	};
 }
@@ -67,14 +68,22 @@ function getRgbCalculationValues(rgb) {
 	const blue = rgb.blue / COLOR_MAX.hex;
 	const green = rgb.green / COLOR_MAX.hex;
 	const red = rgb.red / COLOR_MAX.hex;
-	const max = Math.max(blue, green, red);
-	const min = Math.min(blue, green, red);
+	const maximum = max([
+		blue,
+		green,
+		red
+	]);
+	const minimum = min([
+		blue,
+		green,
+		red
+	]);
 	return {
 		blue,
-		delta: max - min,
+		delta: maximum - minimum,
 		green,
-		max,
-		min,
+		maximum,
+		minimum,
 		red
 	};
 }
@@ -85,8 +94,8 @@ function getRgbaColor() {
 	return getStateValue(this, COLOR_TYPE.rgb, true);
 }
 function getRgbHue(values) {
-	const { blue, delta, green, max, red } = values;
-	switch (max) {
+	const { blue, delta, green, maximum, red } = values;
+	switch (maximum) {
 		case blue: return (red - green) / delta + 4;
 		case green: return (blue - red) / delta + 2;
 		default: return (green - blue) / delta + (green < blue ? 6 : 0);

package/dist/function/retry.mjs

@@ -1,4 +1,5 @@
 import { isPlainObject } from "../internal/is.mjs";
+import { asyncAttempt, attempt } from "../internal/result/attempt.mjs";
 import { getNumberOrDefault } from "../internal/defaults.mjs";
 import { LIMITER_WAIT, getLimiter } from "../internal/function/limit.mjs";
 //#region src/function/retry.ts
@@ -25,15 +26,12 @@ var RetryError = class extends Error {
 async function asyncRetry(callback, options) {
 	if (typeof callback !== "function") throw new TypeError(RETRY_MESSAGE_EXPECTATION);
 	async function handle() {
-		try {
-			const result = await callback();
-			resolver(result);
-		} catch (error) {
-			if (attempts >= times || !when(error)) rejector(new RetryError(RETRY_MESSAGE_FAILED, error));
-			else {
-				attempts += 1;
-				limiter.run();
-			}
+		const result = await asyncAttempt(async () => callback());
+		if (result.ok) resolver(result.value);
+		else if (attempts >= times || !when(result.error)) rejector(new RetryError(RETRY_MESSAGE_FAILED, result.error));
+		else {
+			attempts += 1;
+			limiter.run();
 		}
 	}
 	const { delay, times, when } = createRetryOptions(options);
@@ -66,11 +64,11 @@ function retry(callback, options) {
 	if (typeof callback !== "function") throw new TypeError(RETRY_MESSAGE_EXPECTATION);
 	const { times, when } = createRetryOptions(options);
 	let last;
-	for (let index = 0; index <= times; index += 1) try {
-		return callback();
-	} catch (error) {
-		if (index >= times || !when(error)) {
-			last = error;
+	for (let index = 0; index <= times; index += 1) {
+		const result = attempt(callback);
+		if (result.ok) return result.value;
+		if (index >= times || !when(result.error)) {
+			last = result.error;
 			break;
 		}
 	}

package/dist/index.d.mts

@@ -1482,7 +1482,7 @@ export declare function reverse<Item>(array: Item[]): Item[];
 /**
  * Get the _only_ item matching the given value
  *
- * Throws an error if multiple items match the value
+ * _Throws an error if multiple items match the value_
  *
  * @param array Array to search in
  * @param callback Callback to get an item's value for matching
@@ -1502,7 +1502,7 @@ export declare function single<Item, Callback extends (item: Item, index: number
 /**
  * Get the _only_ item matching the given value by key
  *
- * Throws an error if multiple items match the value
+ * _Throws an error if multiple items match the value_
  *
  * @param array Array to search in
  * @param key Key to get an item's value for matching
@@ -1522,7 +1522,7 @@ export declare function single<Item extends PlainObject, ItemKey extends keyof I
 /**
  * Get the _only_ item matching the filter
  *
- * Throws an error if multiple items match the filter
+ * _Throws an error if multiple items match the filter_
  *
  * @param array Array to search in
  * @param filter Filter callback to match items
@@ -3667,7 +3667,7 @@ export type MemoizedOptions<Callback extends GenericCallback> = {
  */
 export declare function memoize<Callback extends GenericCallback>(callback: Callback, options?: MemoizedOptions<Callback>): Memoized<Callback>;
 //#endregion
-//#region src/internal/result/models.d.ts
+//#region src/internal/models/result.model.d.ts
 /**
  * An unknown result
  */
@@ -4587,6 +4587,56 @@ export declare function setValue<Data extends PlainObject, Path extends NestedKe
  */
 export declare function setValue<Data extends PlainObject>(data: Data, path: string, value: unknown, ignoreCase?: boolean): Data;
 //#endregion
+//#region src/internal/models/plan.model.d.ts
+/**
+ * A plan of execution that can yield intermediate results and eventually return a value or an error.
+ */
+type Plan<out Value, out Error = unknown> = {
+  /**
+   * Run the plan to completion
+   *
+   * @returns Final result, or an error
+   */
+  run: () => Error | Value;
+};
+//#endregion
+//#region src/plan/index.d.ts
+/**
+ * Is the value a generator function?
+ *
+ * @param value Value to check
+ * @returns `true` if the value is a generator function, otherwise `false`
+ */
+export declare function isGenerator(value: unknown): value is () => Generator;
+/**
+ * Is the value a plan?
+ *
+ * @param value Value to check
+ * @returns `true` if the value is a plan, otherwise `false`
+ */
+export declare function isPlan<Value = unknown, Error = unknown>(value: unknown): value is Plan<Value, Error>;
+/**
+ * Create a plan for a generator function
+ *
+ * @param generator Generator to plan for
+ * @returns Generator plan
+ */
+export declare function plan<Value = unknown, Error = unknown>(generator: () => Generator<unknown, Value, Error>): Plan<Value, Error>;
+/**
+ * Run a generator to completion
+ *
+ * @param generator Generator to run
+ * @returns Final result, or an error
+ */
+export declare function run<Value = unknown, Error = unknown>(generator: () => Generator<unknown, Value, unknown>): Error | Value;
+/**
+ * Run a plan to completion
+ *
+ * @param plan Plan to run
+ * @returns Final result, or an error
+ */
+export declare function run<Value = unknown, Error = unknown>(plan: Plan<Value, Error>): Error | Value;
+//#endregion
 //#region src/internal/aborter.d.ts
 type Aborter = {
   callback: GenericCallback;
@@ -5001,7 +5051,7 @@ export declare function timed<Value>(promise: Promise<Value>, options: RequiredK
  */
 export declare function timed<Value>(promise: Promise<Value>, time: number): Promise<Value>;
 //#endregion
-//#region src/result/index.d.ts
+//#region src/internal/result/attempt.d.ts
 /**
  * Executes a _Promise_, catching any errors, and returns a result
  *
@@ -7731,8 +7781,57 @@ export declare function max<Item extends PlainObject>(items: Item[], key: keyof
  * @returns Maximum value, or `Number.NaN` if no maximum can be found
  */
 export declare function max(values: number[]): number;
+/**
+ * Get the minimum value from a list of items
+ *
+ * @param items List of items
+ * @param callback Callback to get an item's value
+ * @param first Return only the first item with the minimum value
+ * @returns First item with the minimum value, or `undefined` if no minimum can be found
+ */
+export declare function min<Item>(items: Item[], callback: (item: Item, index: number, array: Item[]) => number, first: true): Item | undefined;
+/**
+ * Get the minimum value from a list of items
+ *
+ * @param items List of items
+ * @param key Key to use for value
+ * @param first Return only the first item with the minimum value
+ * @returns First item with the minimum value, or `undefined` if no minimum can be found
+ */
+export declare function min<Item extends PlainObject>(items: Item[], key: keyof NumericalValues<Item>, first: true): Item | undefined;
+/**
+ * Get the minimum value from a list of items
+ *
+ * @param items List of items
+ * @param callback Callback to get an item's value
+ * @returns Items with the minimum value
+ */
+export declare function min<Item>(items: Item[], callback: (item: Item, index: number, array: Item[]) => number): Item[];
+/**
+ * Get the minimum value from a list of items
+ *
+ * @param items List of items
+ * @param key Key to use for value
+ * @returns Items with the minimum value
+ */
+export declare function min<Item extends PlainObject>(items: Item[], key: keyof NumericalValues<Item>): Item[];
+/**
+ * Get the minimum value from a list of numbers
+ *
+ * @param values List of numbers
+ * @returns Minimum value, or `Number.NaN` if no minimum can be found
+ */
+export declare function min(values: number[]): number;
 //#endregion
 //#region src/internal/math/misc.d.ts
+/**
+ * Round a number down
+ *
+ * @param value Number to round down
+ * @param decimals Number of decimal places to round to _(defaults to `0`)_
+ * @returns Rounded number, or `Number.NaN` if the value if unable to be rounded
+ */
+export declare function floor(value: number, decimals?: number): number;
 /**
  * Round a number
  *
@@ -7799,14 +7898,6 @@ export declare function count<Item extends PlainObject, ItemKey extends keyof It
  * @returns Number of items, or `Number.NaN` if no count can be calculated
  */
 export declare function count(values: unknown[]): number;
-/**
- * Round a number down
- *
- * @param value Number to round down
- * @param decimals Number of decimal places to round to _(defaults to `0`)_
- * @returns Rounded number, or `Number.NaN` if the value if unable to be rounded
- */
-export declare function floor(value: number, decimals?: number): number;
 /**
  * Get the median value from a list of items
  *
@@ -7830,47 +7921,6 @@ export declare function median<Item extends PlainObject>(array: Item[], key: key
  * @returns Median value, or `Number.NaN` if no median can be calculated
  */
 export declare function median(array: number[]): number;
-/**
- * Get the minimum value from a list of items
- *
- * @param items List of items
- * @param callback Callback to get an item's value
- * @param first Return only the first item with the minimum value
- * @returns First item with the minimum value, or `undefined` if no minimum can be found
- */
-export declare function min<Item>(items: Item[], callback: (item: Item, index: number, array: Item[]) => number, first: true): Item | undefined;
-/**
- * Get the minimum value from a list of items
- *
- * @param items List of items
- * @param key Key to use for value
- * @param first Return only the first item with the minimum value
- * @returns First item with the minimum value, or `undefined` if no minimum can be found
- */
-export declare function min<Item extends PlainObject>(items: Item[], key: keyof NumericalValues<Item>, first: true): Item | undefined;
-/**
- * Get the minimum value from a list of items
- *
- * @param items List of items
- * @param callback Callback to get an item's value
- * @returns Items with the minimum value
- */
-export declare function min<Item>(items: Item[], callback: (item: Item, index: number, array: Item[]) => number): Item[];
-/**
- * Get the minimum value from a list of items
- *
- * @param items List of items
- * @param key Key to use for value
- * @returns Items with the minimum value
- */
-export declare function min<Item extends PlainObject>(items: Item[], key: keyof NumericalValues<Item>): Item[];
-/**
- * Get the minimum value from a list of numbers
- *
- * @param values List of numbers
- * @returns Minimum value, or `Number.NaN` if no minimum can be found
- */
-export declare function min(values: number[]): number;
 /**
  * Get the sum of a list of items
  *
@@ -8317,4 +8367,4 @@ export declare class SizedSet<Value = unknown> extends Set<Value> {
   get(value: Value, update?: boolean): Value | undefined;
 }
 //#endregion
-export { type AsyncLimiter, type Color, type ColorType, type ColorTypeExtended, type ColorValue, type ColorValueExtended, type HSLAColor, type HSLColor, type HWBAColor, type HWBColor, Key$1 as Key, type Limiter, Logger, type RGBAColor, type RGBColor, type Shaken, type Smushed, type Subscription, type SubscriptionParameters, type SubscriptionProperty, type Subscriptions, type SubscriptionsParameters, type TimeLogger, type Unsmushed, push as append, filterAndMap as select, toPromise as fromResult, getRandomFloatingNumber as getRandomFloat, isLogger, isTimeLogger, mapAndFilter as reverseSelect };
+export { type AsyncLimiter, type Color, type ColorType, type ColorTypeExtended, type ColorValue, type ColorValueExtended, type HSLAColor, type HSLColor, type HWBAColor, type HWBColor, Key$1 as Key, type Limiter, Logger, type Plan, type RGBAColor, type RGBColor, type Shaken, type Smushed, type Subscription, type SubscriptionParameters, type SubscriptionProperty, type Subscriptions, type SubscriptionsParameters, type TimeLogger, type Unsmushed, push as append, filterAndMap as select, toPromise as fromResult, getRandomFloatingNumber as getRandomFloat, isLogger, isTimeLogger, mapAndFilter as reverseSelect };