@oscarpalmer/atoms 0.166.3 → 0.168.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/atoms",
-	"version": "0.166.3",
+	"version": "0.168.0",
 	"description": "Atomic utilities for making your JavaScript better.",
 	"keywords": [
 		"helper",
@@ -44,6 +44,10 @@
 			"types": "./dist/array/move.d.mts",
 			"default": "./dist/array/move.mjs"
 		},
+		"./array/sort": {
+			"types": "./dist/array/sort.d.mts",
+			"default": "./dist/array/sort.mjs"
+		},
 		"./array/swap": {
 			"types": "./dist/array/swap.d.mts",
 			"default": "./dist/array/swap.mjs"
@@ -111,10 +115,18 @@
 			"types": "./dist/promise/delay.d.mts",
 			"default": "./dist/promise/delay.mjs"
 		},
+		"./promise/misc": {
+			"types": "./dist/promise/misc.d.mts",
+			"default": "./dist/promise/misc.mjs"
+		},
 		"./promise/models": {
 			"types": "./dist/promise/models.d.mts",
 			"default": "./dist/promise/models.mjs"
 		},
+		"./promise/timed": {
+			"types": "./dist/promise/timed.d.mts",
+			"default": "./dist/promise/timed.mjs"
+		},
 		"./query": {
 			"types": "./dist/query.d.mts",
 			"default": "./dist/query.mjs"
@@ -131,6 +143,26 @@
 			"types": "./dist/result/index.d.mts",
 			"default": "./dist/result/index.mjs"
 		},
+		"./result/flow": {
+			"types": "./dist/result/work/flow.d.mts",
+			"default": "./dist/result/work/flow.mjs"
+		},
+		"./result/match": {
+			"types": "./dist/result/match.d.mts",
+			"default": "./dist/result/match.mjs"
+		},
+		"./result/misc": {
+			"types": "./dist/result/misc.d.mts",
+			"default": "./dist/result/misc.mjs"
+		},
+		"./result/models": {
+			"types": "./dist/result/models.d.mts",
+			"default": "./dist/result/models.mjs"
+		},
+		"./result/pipe": {
+			"types": "./dist/result/work/pipe.d.mts",
+			"default": "./dist/result/work/pipe.mjs"
+		},
 		"./sized/map": {
 			"types": "./dist/sized/map.d.mts",
 			"default": "./dist/sized/map.mjs"
@@ -203,4 +235,4 @@
 		"vitest": "npm:@voidzero-dev/vite-plus-test@latest"
 	},
 	"packageManager": "npm@11.11.1"
-}
+}

package/src/array/index.ts

@@ -16,7 +16,6 @@ export * from './position';
 export * from './push';
 export * from './select';
 export * from './slice';
-export * from './sort';
 export * from './splice';
 export * from './to-set';
 export * from './toggle';

package/src/array/sort.ts

@@ -43,6 +43,18 @@ type ArrayKeySorters<Item extends PlainObject> = {
 	[ItemKey in keyof Item]: ArrayKeySorter<Item, ItemKey>;
 }[keyof Item];
 
+/**
+ * Sorter to use for sorting
+ */
+type ArraySorter<Item> = Item extends PlainObject
+	?
+			| keyof Item
+			| ArrayComparisonSorter<Item>
+			| ArrayKeySorters<Item>
+			| ArrayValueSorter<Item>
+			| ComparisonSorter<Item>
+	: ArrayComparisonSorter<Item> | ArrayValueSorter<Item> | ComparisonSorter<Item>;
+
 /**
  * Sorting information for arrays _(using a value callback and built-in comparison)_
  */
@@ -74,41 +86,25 @@ type CompareCallbackValue<Item> = Item extends Primitive ? Item : unknown;
  */
 type ComparisonSorter<Item> = (first: Item, second: Item) => number;
 
-/**
- * Internal sorter information
- */
 type InternalSorter = {
-	compare?: SorterCompare;
+	compare?: InternalSorterCompare;
 	get: boolean;
 	identifier: string;
 	modifier: number;
-	value?: (item: PlainObject) => unknown;
+	value?: Function;
 };
 
-/**
- * Direction to sort by
- */
-export type SortDirection = 'ascending' | 'descending';
-
-/**
- * Comparison callbacks for sorter
- */
-type SorterCompare = {
+type InternalSorterCompare = {
 	complex?: Function;
 	simple?: Function;
 };
 
 /**
- * Sorter to use for sorting
+ * Direction to sort by
  */
-type Sorter<Item> = Item extends PlainObject
-	?
-			| keyof Item
-			| ArrayComparisonSorter<Item>
-			| ArrayKeySorters<Item>
-			| ArrayValueSorter<Item>
-			| ComparisonSorter<Item>
-	: ArrayComparisonSorter<Item> | ArrayValueSorter<Item> | ComparisonSorter<Item>;
+export type SortDirection = 'ascending' | 'descending';
+
+export type Sorter<Item> = (array: Item[]) => Item[];
 
 // #endregion
 
@@ -125,6 +121,13 @@ function getComparisonSorter(callback: Function, modifier: number): InternalSort
 	};
 }
 
+function getModifier(first: unknown, second: unknown): number {
+	const direction =
+		first === true || second === true ? SORT_DIRECTION_DESCENDING : SORT_DIRECTION_ASCENDING;
+
+	return modifiers[direction];
+}
+
 function getObjectSorter(obj: PlainObject, modifier: number): InternalSorter | undefined {
 	let sorter: InternalSorter | undefined;
 
@@ -165,18 +168,70 @@ function getSorter(value: unknown, modifier: number): InternalSorter | undefined
 	}
 }
 
+function getSorters(value: unknown, modifier: number): InternalSorter[] {
+	const array = Array.isArray(value) ? value : [value];
+	const {length} = array;
+
+	const sorters: InternalSorter[] = [];
+
+	for (let index = 0; index < length; index += 1) {
+		const item = array[index];
+
+		const sorter = getSorter(item, modifier);
+
+		if (sorter != null) {
+			sorters.push(sorter);
+		}
+	}
+
+	return sorters.filter(
+		(value, index, array) =>
+			array.findIndex(next => next.identifier === value.identifier) === index,
+	);
+}
+
 function getValueSorter(value: string | Function, modifier: number): InternalSorter {
 	return {
 		modifier,
 		get: true,
 		identifier: String(value),
-		value:
-			typeof value === 'function'
-				? (value as (item: PlainObject) => unknown)
-				: item => (item as PlainObject)[value],
+		value: typeof value === 'function' ? value : (item: unknown) => (item as PlainObject)[value],
 	};
 }
 
+/**
+ * Initialize a sort handler with sorters _(and an optional default direction)_
+ * @param sorters Sorters to use for sorting
+ * @param descending Sort in descending order? _(defaults to `false`; overridden by individual sorters)_
+ * @returns Sort handler
+ */
+function initializeSort<Item>(
+	sorters: Array<ArraySorter<Item>>,
+	descending?: boolean,
+): Sorter<Item>;
+
+/**
+ * Initialize a sort handler with a sorter _(and an optional default direction)_
+ * @param sorter Sorter to use for sorting
+ * @param descending Sort in descending order? _(defaults to `false`; overridden by individual sorters)_
+ * @returns Sort handler
+ */
+function initializeSort<Item>(sorter: ArraySorter<Item>, descending?: boolean): Sorter<Item>;
+
+/**
+ * Initialize a sort handler _(with an optional default direction)_
+ * @param descending Sort in descending order? _(defaults to `false`)_
+ * @returns Sort handler
+ */
+function initializeSort<Item>(descending?: boolean): Sorter<Item>;
+
+function initializeSort(first?: unknown, second?: unknown): Sorter<unknown> {
+	const modifier = getModifier(first, second);
+	const sorters = getSorters(first, modifier);
+
+	return array => work(array, sorters, modifier);
+}
+
 /**
  * Sort an array of items, using multiple sorters to sort by specific values
  * @param array Array to sort
@@ -186,7 +241,7 @@ function getValueSorter(value: string | Function, modifier: number): InternalSor
  */
 export function sort<Item>(
 	array: Item[],
-	sorters: Array<Sorter<Item>>,
+	sorters: Array<ArraySorter<Item>>,
 	descending?: boolean,
 ): Item[];
 
@@ -197,7 +252,7 @@ export function sort<Item>(
  * @param descending Sort in descending order? _(defaults to `false`; overridden by individual sorters)_
  * @returns Sorted array
  */
-export function sort<Item>(array: Item[], sorter: Sorter<Item>, descending?: boolean): Item[];
+export function sort<Item>(array: Item[], sorter: ArraySorter<Item>, descending?: boolean): Item[];
 
 /**
  * Sort an array of items
@@ -208,6 +263,12 @@ export function sort<Item>(array: Item[], sorter: Sorter<Item>, descending?: boo
 export function sort<Item>(array: Item[], descending?: boolean): Item[];
 
 export function sort(array: unknown[], first?: unknown, second?: unknown): unknown[] {
+	const modifier = getModifier(first, second);
+
+	return work(array, getSorters(first, modifier), modifier);
+}
+
+function work(array: unknown[], sorters: InternalSorter[], modifier: number): unknown[] {
 	if (!Array.isArray(array)) {
 		return [];
 	}
@@ -216,51 +277,25 @@ export function sort(array: unknown[], first?: unknown, second?: unknown): unkno
 		return array;
 	}
 
-	const direction =
-		first === true || second === true ? SORT_DIRECTION_DESCENDING : SORT_DIRECTION_ASCENDING;
-
-	const modifier = modifiers[direction];
-
-	const sorters = (Array.isArray(first) ? first : [first])
-		.map(item => getSorter(item, modifier))
-		.filter(sorter => sorter != null)
-		.filter(
-			(current, index, filtered) =>
-				filtered.findIndex(next => next.identifier === current.identifier) === index,
-		);
-
 	const {length} = sorters;
 
 	if (length === 0) {
 		return array.sort((first, second) => compare(first, second) * modifier);
 	}
 
-	if (length === 1) {
-		const sorter = sorters[0];
-
-		return array.sort((firstItem, secondItem) => {
-			const firstValue = sorter.get ? sorter.value!(firstItem as PlainObject) : firstItem;
-			const secondValue = sorter.get ? sorter.value!(secondItem as PlainObject) : secondItem;
-
-			return (
-				(sorter.compare?.complex?.(firstItem, firstValue, secondItem, secondValue) ??
-					sorter.compare?.simple?.(firstItem, secondItem) ??
-					compare(firstValue, secondValue)) * sorter.modifier
-			);
-		});
-	}
-
-	return array.sort((firstItem, secondItem) => {
+	return array.sort((first, second) => {
 		for (let index = 0; index < length; index += 1) {
 			const sorter = sorters[index];
 
-			const firstValue = sorter.value?.(firstItem as PlainObject) ?? firstItem;
-			const secondValue = sorter.value?.(secondItem as PlainObject) ?? secondItem;
+			const values = [
+				sorter.get ? sorter.value!(first as PlainObject) : first,
+				sorter.get ? sorter.value!(second as PlainObject) : second,
+			];
 
 			const comparison =
-				(sorter.compare?.complex?.(firstItem, firstValue, secondItem, secondValue) ??
-					sorter.compare?.simple?.(firstItem, secondItem) ??
-					compare(firstValue, secondValue)) * sorter.modifier;
+				(sorter.compare?.complex?.(first, values[0], second, values[1]) ??
+					sorter.compare?.simple?.(values[0], values[1]) ??
+					compare(values[0], values[1])) * sorter.modifier;
 
 			if (comparison !== 0) {
 				return comparison;
@@ -271,6 +306,8 @@ export function sort(array: unknown[], first?: unknown, second?: unknown): unkno
 	});
 }
 
+sort.initialize = initializeSort;
+
 // #endregion
 
 // #region Variables

package/src/index.ts

@@ -2,6 +2,7 @@ export * from './array/filter';
 export * from './array/group-by';
 export * from './array/index';
 export * from './array/move';
+export * from './array/sort';
 export * from './array/swap';
 export * from './array/to-map';
 export * from './array/to-record';
@@ -38,10 +39,19 @@ export * from './logger';
 export * from './math';
 export * from './models';
 export * from './number';
+export * from './promise/delay';
 export * from './promise/index';
+export * from './promise/misc';
+export * from './promise/models';
+export * from './promise/timed';
 export * from './query';
 export * from './queue';
 export * from './random';
 export * from './result/index';
+export * from './result/match';
+export * from './result/misc';
+export * from './result/models';
+export * from './result/work/flow';
+export * from './result/work/pipe';
 export * from './sized/map';
 export * from './sized/set';

package/src/promise/index.ts

@@ -283,25 +283,3 @@ async function resultPromises(
 }
 
 // #endregion
-
-// #region Exports
-
-export {toPromise as fromResult} from '../result/misc';
-export {delay} from './delay';
-export {isFulfilled, isRejected} from './helpers';
-export {cancelable, toResult} from './misc';
-export {
-	CancelablePromise,
-	PromiseTimeoutError,
-	type FulfilledPromise,
-	type PromiseOptions,
-	type PromisesOptions,
-	type PromisesResult,
-	type PromiseStrategy,
-	type PromisesValues as PromisesValue,
-	type PromisesValue as PromisesValueItem,
-	type RejectedPromise,
-} from './models';
-export {timed} from './timed';
-
-// #endregion

package/src/promise/misc.ts

@@ -84,3 +84,10 @@ export async function toResult<Value>(
 }
 
 // #endregion
+
+// #region Exports
+
+export {toPromise as fromResult} from '../result/misc';
+export {isFulfilled, isRejected} from './helpers';
+
+// #endregion

package/src/result/index.ts

@@ -95,12 +95,3 @@ attempt.pipe = attemptPipe;
 attempt.promise = attemptPromise;
 
 // #endregion
-
-// #region Exports
-
-export {isError, isOk, isResult} from '../internal/result';
-export {toResult as fromPromise} from '../promise/misc';
-export {error, ok, toPromise, unwrap} from './misc';
-export type {Err, ExtendedErr, ExtendedResult, Ok, Result} from './models';
-
-// #endregion

package/src/result/misc.ts

@@ -113,3 +113,9 @@ export function unwrap(value: unknown, defaultValue: unknown): unknown {
 const MESSAGE_PROMISE_RESULT = 'toPromise expected to receive a Result';
 
 // #endregion
+
+// #region Exports
+
+export {isError, isOk, isResult} from '../internal/result';
+
+// #endregion