@oscarpalmer/atoms 0.193.0 → 0.194.0

package/src/internal/array/index-of.ts

@@ -1,182 +0,0 @@
-import {FIND_VALUE_INDEX, findValue} from './find';
-import type {PlainObject} from '../../models';
-
-// #region Functions
-
-/**
- * Get the index of the first matching item by callback
- *
- * @param array Array to search in
- * @param callback Callback to get an item's value
- * @param value Value to match against
- * @returns Index of the first matching item, or `-1` if no match is found
- *
- * @example
- * ```typescript
- * indexOf(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id,
- *   2,
- * ); // => 1
- * ```
- */
-export function indexOf<
-	Item,
-	Callback extends (item: Item, index: number, array: Item[]) => unknown,
->(array: Item[], callback: Callback, value: ReturnType<Callback>): number;
-
-/**
- * Get the index of the first matching item by key
- *
- * @param array Array to search in
- * @param key Key to match items by
- * @param value Value to match against
- * @returns Index of the first matching item, or `-1` if no match is found
- *
- * @example
- * ```typescript
- * indexOf(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   'id',
- *   2,
- * ); // => 1
- * ```
- */
-export function indexOf<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): number;
-
-/**
- * Get the index of the first item matching the filter
- *
- * @param array Array to search in
- * @param filter Filter callback to match items
- * @returns Index of the first matching item, or `-1` if no match is found
- *
- * @example
- * ```typescript
- * indexOf(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id === 2,
- * ); // => 1
- * ```
- */
-export function indexOf<Item>(
-	array: Item[],
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-): number;
-
-/**
- * Get the index of the first item matching the given item
- *
- * @param array Array to search in
- * @param item Item to match against
- * @returns Index of the first matching item, or `-1` if no match is found
- *
- * @example
- * ```typescript
- * indexOf([1, 2, 3, 4, 5], 3); // => 2
- * ```
- */
-export function indexOf<Item>(array: Item[], item: Item): number;
-
-export function indexOf(array: unknown[], ...parameters: unknown[]): number {
-	return findValue(FIND_VALUE_INDEX, array, parameters, false);
-}
-
-indexOf.last = lastIndexOf;
-
-/**
- * Get the index of the last matching item by callback
- *
- * _Available as `lastIndexOf` and `indexOf.last`_
- *
- * @param array Array to search in
- * @param callback Callback to get an item's value
- * @param value Value to match against
- * @returns Index of the last matching item, or `-1` if no match is found
- *
- * @example
- * ```typescript
- * lastIndexOf(
- *   [{id: 1}, {id: 2}, {id: 3}, {id: 2}],
- *   item => item.id,
- *   2,
- * ); // => 3
- * ```
- */
-export function lastIndexOf<
-	Item,
-	Callback extends (item: Item, index: number, array: Item[]) => unknown,
->(array: Item[], callback: Callback, value: ReturnType<Callback>): number;
-
-/**
- * Get the index of the last matching item by key
- *
- * _Available as `lastIndexOf` and `indexOf.last`_
- *
- * @param array Array to search in
- * @param key Key to match items by
- * @param value Value to match against
- * @returns Index of the last matching item, or `-1` if no match is found
- *
- * @example
- * ```typescript
- * lastIndexOf(
- *   [{id: 1}, {id: 2}, {id: 3}, {id: 2}],
- *   'id',
- *   2,
- * ); // => 3
- * ```
- */
-export function lastIndexOf<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): number;
-
-/**
- * Get the index of the last item matching the filter
- *
- * _Available as `lastIndexOf` and `indexOf.last`_
- *
- * @param array Array to search in
- * @param filter Filter callback to match items
- * @returns Index of the last matching item, or `-1` if no match is found
- *
- * @example
- * ```typescript
- * lastIndexOf(
- *   [{id: 1}, {id: 2}, {id: 3}, {id: 2}],
- *   item => item.id === 2,
- * ); // => 3
- * ```
- */
-export function lastIndexOf<Item>(
-	array: Item[],
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-): number;
-
-/**
- * Get the index of the last item matching the given item
- *
- * _Available as `lastIndexOf` and `indexOf.last`_
- *
- * @param array Array to search in
- * @param item Item to match against
- * @returns Index of the last matching item, or `-1` if no match is found
- *
- * @example
- * ```typescript
- * lastIndexOf([1, 2, 3, 2, 1], 2); // => 3
- * ```
- */
-export function lastIndexOf<Item>(array: Item[], item: Item): number;
-
-export function lastIndexOf(array: unknown[], ...parameters: unknown[]): number {
-	return findValue(FIND_VALUE_INDEX, array, parameters, true);
-}
-
-// #endregion

package/src/internal/array/insert.ts

@@ -1,80 +0,0 @@
-import {chunk} from './chunk';
-
-// #region Types
-
-type InsertType = 'insert' | 'push' | 'splice';
-
-// #endregion
-
-// #region Functions
-
-function insertChunkedValues(
-	type: InsertType,
-	array: unknown[],
-	items: unknown[],
-	start: number,
-	deleteCount: number,
-): unknown {
-	const actualDeleteCount = deleteCount < 0 ? 0 : deleteCount;
-	const actualStart = Math.min(Math.max(0, start), array.length);
-	const chunked = chunk(items);
-	const lastIndex = chunked.length - 1;
-
-	let index = chunked.length;
-	let returned: unknown[] | undefined;
-
-	while (index > 0) {
-		index -= 1;
-
-		const spliced = array.splice(
-			actualStart,
-			index === lastIndex ? actualDeleteCount : 0,
-			...chunked[index],
-		);
-
-		if (returned == null) {
-			returned = spliced;
-		} else {
-			returned.push(...spliced);
-		}
-	}
-
-	if (type === INSERT_TYPE_INSERT) {
-		return array;
-	}
-
-	return type === INSERT_TYPE_SPLICE ? returned : array.length;
-}
-
-export function insertValues(
-	type: InsertType,
-	array: unknown,
-	items: unknown,
-	start: unknown,
-	deleteCount: number,
-): unknown {
-	const spliceArray = type === INSERT_TYPE_INSERT || type === INSERT_TYPE_SPLICE;
-
-	if (
-		!Array.isArray(array) ||
-		typeof start !== 'number' ||
-		!Array.isArray(items) ||
-		items.length === 0
-	) {
-		return spliceArray ? [] : 0;
-	}
-
-	return insertChunkedValues(type, array, items, start, spliceArray ? deleteCount : 0);
-}
-
-// #endregion
-
-// #region Variables
-
-export const INSERT_TYPE_INSERT: InsertType = 'insert';
-
-export const INSERT_TYPE_PUSH: InsertType = 'push';
-
-export const INSERT_TYPE_SPLICE: InsertType = 'splice';
-
-// #endregion

package/src/internal/array/overlap.ts

@@ -1,35 +0,0 @@
-type OverlapItem = {
-	array: unknown[];
-	index: number;
-};
-
-type OverlapResult = {
-	first: OverlapItem;
-	second: OverlapItem;
-	overlap: boolean;
-};
-
-export function arraysOverlap(first: OverlapItem, second: OverlapItem): OverlapResult {
-	const firstArray = first.index < second.index ? first.array : second.array;
-	const secondArray = first.index < second.index ? second.array : first.array;
-
-	const firstIndex = firstArray === first.array ? first.index : second.index;
-	const secondIndex = firstArray === first.array ? second.index : first.index;
-
-	const firstEnd = firstIndex + firstArray.length - 1;
-	const secondEnd = secondIndex + secondArray.length - 1;
-
-	const overlap = firstIndex <= secondEnd && firstEnd >= secondIndex;
-
-	return {
-		overlap,
-		first: {
-			array: firstArray,
-			index: firstIndex,
-		},
-		second: {
-			array: secondArray,
-			index: secondIndex,
-		},
-	};
-}

package/src/internal/array/sets.ts

@@ -1,74 +0,0 @@
-import {getArrayCallback} from './callbacks';
-
-// #region Types
-
-type CompareSetsType = 'difference' | 'intersection' | 'union';
-
-// #endregion
-
-// #region Functions
-
-export function compareSets(
-	type: CompareSetsType,
-	first: unknown[],
-	second: unknown[],
-	key?: unknown,
-): unknown[] {
-	if (!Array.isArray(first)) {
-		return [];
-	}
-
-	const isDifference = type === COMPARE_SETS_DIFFERENCE;
-	const isIntersection = type === COMPARE_SETS_INTERSECTION;
-	const isUnion = type === COMPARE_SETS_UNION;
-
-	if (first.length === 0) {
-		return isDifference ? first.slice() : isIntersection ? [] : second.slice();
-	}
-
-	if (!Array.isArray(second) || second.length === 0) {
-		return isIntersection ? [] : first.slice();
-	}
-
-	const callback = getArrayCallback(key);
-
-	const values = isUnion ? first : second;
-	let {length} = values;
-
-	const set = new Set<unknown>([]);
-
-	for (let index = 0; index < length; index += 1) {
-		const item = values[index];
-
-		set.add(callback?.(item, index, values) ?? item);
-	}
-
-	const source = isUnion ? second : first;
-
-	length = source.length;
-
-	const result: unknown[] = isUnion ? first.slice() : [];
-
-	for (let index = 0; index < length; index += 1) {
-		const item = source[index];
-		const value = callback?.(item, index, source) ?? item;
-
-		if (isIntersection ? set.has(value) : !set.has(value)) {
-			result.push(item);
-		}
-	}
-
-	return result;
-}
-
-// #endregion
-
-// #region Variables
-
-export const COMPARE_SETS_DIFFERENCE: CompareSetsType = 'difference';
-
-export const COMPARE_SETS_INTERSECTION: CompareSetsType = 'intersection';
-
-export const COMPARE_SETS_UNION: CompareSetsType = 'union';
-
-// #endregion

package/src/internal/array/shuffle.ts

@@ -1,33 +0,0 @@
-import {getRandomInteger} from '../random';
-
-// #region Functions
-
-/**
- * Shuffle items in array
- *
- * @param array Original array
- * @returns Shuffled array
- */
-export function shuffle<Item>(array: Item[]): Item[] {
-	if (!Array.isArray(array)) {
-		return [];
-	}
-
-	const shuffled = array.slice();
-
-	if (shuffled.length < 2) {
-		return shuffled;
-	}
-
-	let index = shuffled.length;
-
-	while (--index >= 0) {
-		const random = getRandomInteger(0, index);
-
-		[shuffled[index], shuffled[random]] = [shuffled[random], shuffled[index]];
-	}
-
-	return shuffled;
-}
-
-// #endregion

package/src/internal/array/update.ts

@@ -1,52 +0,0 @@
-import {getArrayCallback} from './callbacks';
-
-export function updateInArray(
-	array: unknown[],
-	items: unknown[],
-	key: unknown,
-	replace: boolean,
-): unknown[] {
-	if (!Array.isArray(array)) {
-		return [];
-	}
-
-	const itemsIsArray = Array.isArray(items);
-
-	if (array.length === 0 || !itemsIsArray) {
-		if (itemsIsArray) {
-			array.push(...items);
-		}
-
-		return array;
-	}
-
-	const {length} = items;
-
-	if (length === 0) {
-		return array;
-	}
-
-	const callback = getArrayCallback(key);
-
-	for (let valuesIndex = 0; valuesIndex < length; valuesIndex += 1) {
-		const item = items[valuesIndex];
-		const value = callback?.(item) ?? item;
-
-		const arrayIndex =
-			callback == null
-				? array.indexOf(value)
-				: array.findIndex(
-						(arrayItem, arrayIndex) => callback(arrayItem, arrayIndex, array) === value,
-					);
-
-		if (arrayIndex === -1) {
-			array.push(item);
-		} else if (replace) {
-			array[arrayIndex] = item;
-		} else {
-			array.splice(arrayIndex, 1);
-		}
-	}
-
-	return array;
-}

package/src/internal/function/misc.ts

@@ -1,8 +0,0 @@
-// #region Functions
-
-/**
- * A function that does nothing, which can be useful, I guess…
- */
-export function noop(): void {}
-
-// #endregion

package/src/internal/function/timer.ts

@@ -1,168 +0,0 @@
-import type {
-	AsyncCancelableCallback,
-	CancelableCallback,
-	GenericAsyncCallback,
-	GenericCallback,
-} from '../../models';
-
-// #region Types
-
-type AsyncItem = {
-	parameters: unknown[];
-	promise: Promise<unknown>;
-	reject: (reason?: unknown) => void;
-	resolve: (value?: unknown) => void;
-	running: boolean;
-};
-
-type TimerType = 'debounce' | 'throttle' | 'wait';
-
-// #endregion
-
-// #region Functions
-
-export function getAsyncTimer<Callback extends GenericAsyncCallback | GenericCallback>(
-	type: TimerType,
-	callback: Callback,
-	time?: number,
-): AsyncCancelableCallback<Callback> {
-	async function run(item: AsyncItem): Promise<void> {
-		const now = performance.now();
-
-		start ??= now;
-
-		if (interval === 0 || now - start >= interval - OFFSET) {
-			start = throttle ? now : undefined;
-
-			item.running = true;
-
-			try {
-				let result = callback(...item.parameters);
-
-				if (result instanceof Promise) {
-					result = await result;
-				}
-
-				item.resolve(result);
-			} catch (error) {
-				item.reject(error);
-			} finally {
-				item.running = false;
-			}
-		} else {
-			id = startTimer(() => run(item));
-		}
-	}
-
-	const interval = getInterval(time);
-	const throttle = type === TIMER_THROTTLE;
-
-	let id: number;
-	let last: AsyncItem;
-	let start: number | undefined;
-
-	const timer = (...parameters: Parameters<Callback>): Promise<unknown> => {
-		timer.cancel();
-
-		const next: AsyncItem = {
-			parameters,
-			running: false,
-		} as never;
-
-		next.promise = new Promise<unknown>((resolve, reject) => {
-			next.reject = reject;
-			next.resolve = resolve;
-		});
-
-		last = next;
-
-		if (throttle) {
-			void run(next);
-		} else {
-			id = startTimer(() => {
-				void run(next);
-			});
-		}
-
-		return next.promise;
-	};
-
-	timer.cancel = (): void => {
-		clearTimer(id);
-
-		if (last != null && !last.running) {
-			last.reject();
-		}
-	};
-
-	return timer as AsyncCancelableCallback<Callback>;
-}
-
-function getInterval(value: unknown): number {
-	return typeof value === 'number' && value > 0 ? value : 0;
-}
-
-export function getTimer<Callback extends GenericCallback>(
-	type: TimerType,
-	callback: Callback,
-	time?: number,
-): CancelableCallback<Callback> {
-	function run(): void {
-		const now = performance.now();
-
-		start ??= now;
-
-		if (interval === 0 || now - start >= interval - OFFSET) {
-			start = throttle ? now : undefined;
-
-			callback(...args);
-		} else {
-			id = startTimer(run);
-		}
-	}
-
-	const interval = getInterval(time);
-	const throttle = type === TIMER_THROTTLE;
-
-	let args: Parameters<Callback>;
-	let id: number;
-	let start: number | undefined;
-
-	const timer = (...parameters: Parameters<Callback>): void => {
-		timer.cancel();
-
-		args = parameters;
-
-		if (throttle) {
-			run();
-		} else {
-			id = startTimer(run);
-		}
-	};
-
-	timer.cancel = (): void => {
-		clearTimer(id);
-	};
-
-	return timer as CancelableCallback<Callback>;
-}
-
-// #endregion
-
-// #region Variables
-
-const OFFSET = 5;
-
-export const TIMER_DEBOUNCE: TimerType = 'debounce';
-
-export const TIMER_THROTTLE: TimerType = 'throttle';
-
-export const TIMER_WAIT: TimerType = 'wait';
-
-// istanbul ignore next
-const clearTimer = typeof cancelAnimationFrame === 'function' ? cancelAnimationFrame : clearTimeout;
-
-// istanbul ignore next
-const startTimer = typeof requestAnimationFrame === 'function' ? requestAnimationFrame : setTimeout;
-
-// #endregion