@oscarpalmer/atoms 0.193.0 → 0.194.0

package/src/array/move.ts

@@ -1,315 +0,0 @@
-import {arraysOverlap} from '../internal/array/overlap';
-import type {PlainObject} from '../models';
-import {indexOfArray} from './match';
-
-// #region Functions
-
-/**
- * Move an item _(or array of items)_ to the position of another item _(or array of items)_ within an array
- *
- * When moving to the front of the array, the moved items will be placed __before__ the target item. When moving to the back of the array, the moved items will be placed __after__ the target item
- *
- * If either of values are not present in the array, or if they overlap, the array will be returned unchanged
- *
- * @param array Array to move within
- * @param from Item or items to move
- * @param to Item or items to move to
- * @param callback Callback to get an item's value for matching
- * @returns Original array with items moved _(or unchanged if unable to move)_
- *
- * @example
- * ```typescript
- * const array = [{id: 1}, {id: 2}, {id: 3}, {id: 4}];
- *
- * move(array, {id: 1}, {id: 3}, item => item.id);            // => [{id: 2}, {id: 3}, {id: 1}, {id: 4}]
- * move(array, [{id: 2}, {id: 3}], {id: 4}, item => item.id); // => [{id: 1}, {id: 4}, {id: 2}, {id: 3}]
- * move(array, {id: 5}, {id: 1}, item => item.id);            // => [{id: 1}, {id: 2}, {id: 3}, {id: 4}] (unchanged)
- * ```
- */
-export function move<Item>(
-	array: Item[],
-	from: Item | Item[],
-	to: Item | Item[],
-	callback: (item: Item, index: number, array: Item[]) => unknown,
-): Item[];
-
-/**
- * Move an item _(or array of items)_ to the position of another item _(or array of items)_ within an array
- *
- * When moving to the front of the array, the moved items will be placed __before__ the target item. When moving to the back of the array, the moved items will be placed __after__ the target item
- *
- * If either of values are not present in the array, or if they overlap, the array will be returned unchanged
- *
- * @param array Array to move within
- * @param from Item or items to move
- * @param to Item or items to move to
- * @param key Key to get an item's value for matching
- * @returns Original array with items moved _(or unchanged if unable to move)_
- *
- * @example
- * ```typescript
- * const array = [{id: 1}, {id: 2}, {id: 3}, {id: 4}];
- *
- * move(array, {id: 1}, {id: 3}, 'id');            // => [{id: 2}, {id: 3}, {id: 1}, {id: 4}]
- * move(array, [{id: 2}, {id: 3}], {id: 4}, 'id'); // => [{id: 1}, {id: 4}, {id: 2}, {id: 3}]
- * move(array, {id: 5}, {id: 1}, 'id');            // => [{id: 1}, {id: 2}, {id: 3}, {id: 4}] (unchanged)
- * ```
- */
-export function move<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	from: Item | Item[],
-	to: Item | Item[],
-	key: ItemKey,
-): Item[];
-
-/**
- * Move an item _(or array of items)_ to the position of another item _(or array of items)_ within an array
- *
- * When moving to the front of the array, the moved items will be placed __before__ the target item. When moving to the back of the array, the moved items will be placed __after__ the target item
- *
- * If either of values are not present in the array, or if they overlap, the array will be returned unchanged
- *
- * @param array Array to move within
- * @param from Item or items to move
- * @param to Item or items to move to
- * @returns Original array with items moved _(or unchanged if unable to move)_
- *
- * @example
- * ```typescript
- * const array = [1, 2, 3, 4];
- *
- * move(array, 1, 3);      // => [2, 3, 1, 4]
- * move(array, [2, 3], 4); // => [1, 4, 2, 3]
- * move(array, 5, 1);      // => [1, 2, 3, 4] (unchanged)
- * ```
- */
-export function move<Item>(array: Item[], from: Item | Item[], to: Item | Item[]): Item[];
-
-export function move(array: unknown[], from: unknown, to: unknown, key?: unknown): unknown[] {
-	if (!Array.isArray(array)) {
-		return [];
-	}
-
-	const firstArray = Array.isArray(from) ? from : [from];
-	const secondArray = Array.isArray(to) ? to : [to];
-
-	if (firstArray.length === 0 || secondArray.length === 0) {
-		return array;
-	}
-
-	const firstPosition = indexOfArray(array, firstArray, key as never);
-	const secondPosition = indexOfArray(array, secondArray, key as never);
-
-	if (firstPosition === -1 || secondPosition === -1 || firstPosition === secondPosition) {
-		return array;
-	}
-
-	const {overlap} = arraysOverlap(
-		{
-			array: firstArray,
-			index: firstPosition,
-		},
-		{
-			array: secondArray,
-			index: secondPosition,
-		},
-	);
-
-	if (overlap) {
-		// The arrays overlap, so we can't swap them without losing data
-
-		return array;
-	}
-
-	array.splice(firstPosition, firstArray.length);
-
-	const next =
-		secondPosition < firstPosition
-			? secondPosition
-			: secondPosition + secondArray.length - firstArray.length;
-
-	if (next >= array.length) {
-		array.push(...firstArray);
-	} else {
-		array.splice(next, 0, ...firstArray);
-	}
-
-	return array;
-}
-
-move.indices = moveIndices;
-move.toIndex = moveToIndex;
-
-/**
- * Move an item from one index to another within an array
- *
- * If the from index is out of bounds, the array will be returned unchanged
- *
- * _Available as `moveIndices` and `move.indices`_
- *
- * @param array Array to move within
- * @param from Index to move from
- * @param to Index to move to
- * @returns Original array with item moved _(or unchanged if unable to move)_
- *
- * @example
- * ```typescript
- * const array = [1, 2, 3, 4];
- *
- * moveIndices(array, 0, 2);  // => [2, 3, 1, 4]
- * moveIndices(array, -1, 0); // => [4, 2, 3, 1]
- * moveIndices(array, 5, 1);  // => [4, 2, 3, 1] (unchanged)
- * ```
- */
-export function moveIndices<Item>(array: Item[], from: number, to: number): Item[] {
-	if (!Array.isArray(array)) {
-		return [];
-	}
-
-	const {length} = array;
-
-	if (length === 0 || typeof from !== 'number' || typeof to !== 'number') {
-		return array;
-	}
-
-	const fromIndex = from < 0 ? length + from : from;
-	const toIndex = to < 0 ? length + to : to;
-
-	if (fromIndex === toIndex || fromIndex >= length || toIndex >= length) {
-		return array;
-	}
-
-	const spliced = array.splice(fromIndex, 1);
-
-	if (toIndex >= array.length) {
-		array.push(...spliced);
-	} else {
-		array.splice(toIndex, 0, ...spliced);
-	}
-
-	return array;
-}
-
-/**
- * Move an item _(or array of items)_ to an index within an array
- *
- * If the value is not present in the array, or if the index is out of bounds, the array will be returned unchanged
- *
- * _Available as `moveToIndex` and `move.toIndex`_
- *
- * @example
- * ```typescript
- * const array = [{id: 1}, {id: 2}, {id: 3}, {id: 4}];
- *
- * moveToIndex(array, {id: 1}, 2, item => item.id);            // => [{id: 2}, {id: 3}, {id: 1}, {id: 4}]
- * moveToIndex(array, [{id: 2}, {id: 3}], 3, item => item.id); // => [{id: 1}, {id: 4}, {id: 2}, {id: 3}]
- * moveToIndex(array, {id: 5}, 1, item => item.id);            // => [{id: 1}, {id: 2}, {id: 3}, {id: 4}] (unchanged)
- * ```
- *
- * @param array Array to move within
- * @param value Item or items to move
- * @param index Index to move to
- * @param callback Callback to get an item's value for matching
- * @returns Original array with items moved _(or unchanged if unable to move)_
- */
-export function moveToIndex<Item>(
-	array: Item[],
-	value: Item | Item[],
-	index: number,
-	callback: (item: Item, index: number, array: Item[]) => unknown,
-): Item[];
-
-/**
- * Move an item _(or array of items)_ to an index within an array
- *
- * If the value is not present in the array, or if the index is out of bounds, the array will be returned unchanged
- *
- * _Available as `moveToIndex` and `move.toIndex`_
- *
- * @param array Array to move within
- * @param value Item or items to move
- * @param index Index to move to
- * @param key Key to get an item's value for matching
- * @returns Original array with items moved _(or unchanged if unable to move)_
- *
- * @example
- * ```typescript
- * const array = [{id: 1}, {id: 2}, {id: 3}, {id: 4}];
- *
- * moveToIndex(array, {id: 1}, 2, 'id');            // => [{id: 2}, {id: 3}, {id: 1}, {id: 4}]
- * moveToIndex(array, [{id: 2}, {id: 3}], 3, 'id'); // => [{id: 1}, {id: 4}, {id: 2}, {id: 3}]
- * moveToIndex(array, {id: 5}, 1, 'id');            // => [{id: 1}, {id: 2}, {id: 3}, {id: 4}] (unchanged)
- * ```
- */
-export function moveToIndex<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	value: Item | Item[],
-	index: number,
-	key: ItemKey,
-): Item[];
-
-/**
- * Move an item _(or array of items)_ to an index within an array
- *
- * If the value is not present in the array, or if the index is out of bounds, the array will be returned unchanged
- *
- * _Available as `moveToIndex` and `move.toIndex`_
- *
- * @param array Array to move within
- * @param value Item or items to move
- * @param index Index to move to
- * @returns Original array with items moved _(or unchanged if unable to move)_
- *
- * @example
- * ```typescript
- * const array = [1, 2, 3, 4];
- *
- * moveToIndex(array, 1, 2);      // => [2, 3, 1, 4]
- * moveToIndex(array, [2, 3], 3); // => [1, 4, 2, 3]
- * moveToIndex(array, 5, 1);      // => [1, 2, 3, 4] (unchanged)
- * ```
- */
-export function moveToIndex<Item>(array: Item[], value: Item | Item[], index: number): Item[];
-
-export function moveToIndex(
-	array: unknown[],
-	value: unknown,
-	index: number,
-	key?: unknown,
-): unknown[] {
-	if (!Array.isArray(array)) {
-		return [];
-	}
-
-	const {length} = array;
-
-	if (length === 0 || typeof index !== 'number') {
-		return array;
-	}
-
-	const next = index < 0 ? length + index : index;
-
-	if (next >= length) {
-		return array;
-	}
-
-	const values = Array.isArray(value) ? value : [value];
-
-	const position = indexOfArray(array, values, key as never);
-
-	if (position === -1 || position === next) {
-		return array;
-	}
-
-	array.splice(position, values.length);
-
-	if (next >= array.length) {
-		array.push(...values);
-	} else {
-		array.splice(next, 0, ...values);
-	}
-
-	return array;
-}
-
-// #endregion

package/src/array/partition.ts

@@ -1,91 +0,0 @@
-import {FIND_VALUES_ALL, findValues} from '../internal/array/find';
-import type {PlainObject} from '../models';
-
-// #region Functions
-
-/**
- * Get a partitioned array of items
- *
- * @param array Array to search in
- * @param callback Callback to get an item's value for matching
- * @param value Value to match against
- * @returns Partitioned array of items
- *
- * @example
- * ```typescript
- * partition(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id,
- *   2,
- * ); // => [[{id: 2}], [{id: 1}, {id: 3}]]
- * ```
- */
-export function partition<
-	Item,
-	Callback extends (item: Item, index: number, array: Item[]) => unknown,
->(array: Item[], callback: Callback, value: ReturnType<Callback>): Item[][];
-
-/**
- * Get a partitioned array of items
- *
- * @param array Array to search in
- * @param key Key to get an item's value for matching
- * @param value Value to match against
- * @returns Partitioned array of items
- *
- * @example
- * ```typescript
- * partition(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   'id',
- *   2,
- * ); // => [[{id: 2}], [{id: 1}, {id: 3}]]
- * ```
- */
-export function partition<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): Item[][];
-
-/**
- * Get a partitioned array of items
- *
- * @param array Array to search in
- * @param filter Filter callback to match items
- * @returns Partitioned array of items
- *
- * @example
- * ```typescript
- * partition(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id === 2,
- * ); // => [[{id: 2}], [{id: 1}, {id: 3}]]
- * ```
- */
-export function partition<Item>(
-	array: Item[],
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-): Item[][];
-
-/**
- * Get a partitioned array of items matching the given item
- *
- * @param array Array to search in
- * @param item Item to match against
- * @returns Partitioned array of items
- *
- * @example
- * ```typescript
- * partition([1, 2, 3, 4, 5], 3); // => [[3], [1, 2, 4, 5]]
- * ```
- */
-export function partition<Item>(array: Item[], item: Item): Item[][];
-
-export function partition(array: unknown[], ...parameters: unknown[]): unknown[][] {
-	const {matched, notMatched} = findValues(FIND_VALUES_ALL, array, parameters);
-
-	return [matched, notMatched];
-}
-
-// #endregion

package/src/array/push.ts

@@ -1,23 +0,0 @@
-import {INSERT_TYPE_PUSH, insertValues} from '../internal/array/insert';
-
-// #region Functions
-
-/**
- * Push items into an array _(at the end)_
- *
- * _(Uses chunking to avoid call stack size being exceeded)_
- *
- * @param array Original array
- * @param pushed Pushed items
- * @returns New length of the array
- *
- * @example
- * ```typescript
- * push([1, 2, 3], [4, 5]); // => 5 (new length); array becomes [1, 2, 3, 4, 5]
- * ```
- */
-export function push<Item>(array: Item[], pushed: Item[]): number {
-	return insertValues(INSERT_TYPE_PUSH, array, pushed, array.length, 0) as number;
-}
-
-// #endregion

package/src/array/reverse.ts

@@ -1,33 +0,0 @@
-// #region Functions
-
-/**
- * Reverse the order of items in an array
- *
- * @param array Array to reverse
- * @returns Reversed array
- */
-export function reverse<Item>(array: Item[]): Item[] {
-	if (!Array.isArray(array)) {
-		return [];
-	}
-
-	const {length} = array;
-
-	if (length < 2) {
-		return array;
-	}
-
-	const half = Math.floor(length / 2);
-
-	for (let firstIndex = 0; firstIndex < half; firstIndex += 1) {
-		const temporaryItem = array[firstIndex];
-		const secondIndex = length - 1 - firstIndex;
-
-		array[firstIndex] = array[secondIndex];
-		array[secondIndex] = temporaryItem;
-	}
-
-	return array;
-}
-
-// #endregion Functions