@oscarpalmer/atoms 0.193.0 → 0.194.0

package/src/array/to-record.ts

@@ -1,351 +0,0 @@
-import {groupValues} from '../internal/array/group';
-import type {Key, KeyedValue, PlainObject, Simplify} from '../models';
-
-// #region Functions
-
-/**
- * Create a record from an array of items using callbacks
- *
- * If multiple items have the same key, the latest item will be used
- *
- * @param array Array to convert
- * @param key Callback to get an item's grouping key
- * @param value Callback to get an item's value
- * @returns Record of keyed values
- *
- * @example
- * ```typescript
- * toRecord(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   item => item.value,
- *   item => item.id,
- * ); // => { 10: 3, 20: 2 }
- * ```
- */
-export function toRecord<
-	Item,
-	KeyCallback extends (item: Item, index: number, array: Item[]) => Key,
-	ValueCallback extends (item: Item, index: number, array: Item[]) => unknown,
->(
-	array: Item[],
-	key: KeyCallback,
-	value: ValueCallback,
-): Record<ReturnType<KeyCallback>, ReturnType<ValueCallback>>;
-
-/**
- * Create a record from an array of items using a callback and value
- *
- * If multiple items have the same key, the latest item will be used
- *
- * @param array Array to convert
- * @param callback Callback to get an item's grouping key
- * @param value Key to use for value
- * @returns Record with keys
- *
- * @example
- * ```typescript
- * toRecord(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   item => item.value,
- *   'id',
- * ); // => { 10: 3, 20: 2 }
- * ```
- */
-export function toRecord<
-	Item extends PlainObject,
-	Callback extends (item: Item, index: number, array: Item[]) => Key,
-	ItemValue extends keyof Item,
->(
-	array: Item[],
-	callback: Callback,
-	value: ItemValue,
-): Record<ReturnType<Callback>, Item[ItemValue]>;
-
-/**
- * Create a record from an array of items using a key and callback
- *
- * If multiple items have the same key, the latest item will be used
- *
- * @param array Array to convert
- * @param key Key to use for grouping
- * @param callback Callback to get an item's value
- * @returns Record with keys
- *
- * @example
- * ```typescript
- * toRecord(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   'value',
- *   item => item.id,
- * ); // => { 10: 3, 20: 2 }
- * ```
- */
-export function toRecord<
-	Item extends PlainObject,
-	ItemKey extends keyof Item,
-	Callback extends (item: Item, index: number, array: Item[]) => unknown,
->(
-	array: Item[],
-	key: ItemKey,
-	callback: Callback,
-): Simplify<Record<KeyedValue<Item, ItemKey>, ReturnType<Callback>>>;
-
-/**
- * Create a record from an array of items using a key and value
- *
- * If multiple items have the same key, the latest item will be used
- *
- * @param array Array to convert
- * @param key Key to use for grouping
- * @param value Key to use for value
- * @returns Record of keyed values
- *
- * @example
- * ```typescript
- * toRecord(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   'value',
- *   'id',
- * ); // => { 10: 3, 20: 2 }
- * ```
- */
-export function toRecord<
-	Item extends PlainObject,
-	ItemKey extends keyof Item,
-	ItemValue extends keyof Item,
->(
-	array: Item[],
-	key: ItemKey,
-	value: ItemValue,
-): Simplify<Record<KeyedValue<Item, ItemKey>, Item[ItemValue]>>;
-
-/**
- * Create a record from an array of items using a callback
- *
- * If multiple items have the same key, the latest item will be used
- *
- * @param array Array to convert
- * @param callback Callback to get an item's grouping key
- * @returns Record of keyed values
- *
- * @example
- * ```typescript
- * toRecord(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   item => item.value,
- * ); // => { 10: {id: 3, value: 10}, 20: {id: 2, value: 20} }
- * ```
- */
-export function toRecord<Item, Callback extends (item: Item, index: number, array: Item[]) => Key>(
-	array: Item[],
-	callback: Callback,
-): Record<ReturnType<Callback>, Item>;
-
-/**
- * Create a record from an array of items using a key
- *
- * If multiple items have the same key, the latest item will be used
- *
- * @param array Array to convert
- * @param key Key to use for grouping
- * @returns Record of keyed values
- *
- * @example
- * ```typescript
- * toRecord(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   'value',
- * ); // => { 10: {id: 3, value: 10}, 20: {id: 2, value: 20} }
- * ```
- */
-export function toRecord<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-): Simplify<Record<KeyedValue<Item, ItemKey>, Item>>;
-
-/**
- * Create a record from an array of items _(using indices as keys)_
- *
- * @param array Array to convert
- * @returns Record of indiced values
- *
- * @example
- * ```typescript
- * toRecord(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- * ); // => { 0: {id: 1, value: 10}, 1: {id: 2, value: 20}, 2: {id: 3, value: 10} }
- * ```
- */
-export function toRecord<Item>(array: Item[]): Record<number, Item>;
-
-export function toRecord(array: unknown[], first?: unknown, second?: unknown): unknown {
-	return groupValues(array, first, second, false);
-}
-
-toRecord.arrays = toRecordArrays;
-
-/**
- * Create a record from an array of items using callbacks, grouping values into arrays
- *
- * _Available as `toRecordArrays` and `toRecord.arrays`_
- *
- * @param array Array to convert
- * @param key Callback to get an item's grouping key
- * @param value Callback to get an item's value
- * @returns Record of keyed arrays of values
- *
- * @example
- * ```typescript
- * toRecordArrays(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   item => item.value,
- *   item => item.id,
- * ); // => { 10: [1, 3], 20: [2] }
- * ```
- */
-export function toRecordArrays<
-	Item,
-	KeyCallback extends (item: Item, index: number, array: Item[]) => Key,
-	ValueCallback extends (item: Item, index: number, array: Item[]) => unknown,
->(
-	array: Item[],
-	key: KeyCallback,
-	value: ValueCallback,
-): Record<ReturnType<KeyCallback>, ReturnType<ValueCallback>[]>;
-
-/**
- * Create a record from an array of items using a callback and value, grouping values into arrays
- *
- * _Available as `toRecordArrays` and `toRecord.arrays`_
- *
- * @param array Array to convert
- * @param callback Callback to get an item's grouping key
- * @param value Key to use for value
- * @returns Record of keyed arrays of values
- *
- * @example
- * ```typescript
- * toRecordArrays(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   item => item.value,
- *   'id',
- * ); // => { 10: [1, 3], 20: [2] }
- * ```
- */
-export function toRecordArrays<
-	Item extends PlainObject,
-	Callback extends (item: Item, index: number, array: Item[]) => Key,
-	ItemValue extends keyof Item,
->(
-	array: Item[],
-	callback: Callback,
-	value: ItemValue,
-): Record<ReturnType<Callback>, Item[ItemValue][]>;
-
-/**
- * Create a record from an array of items using a key and callback, grouping values into arrays
- *
- * _Available as `toRecordArrays` and `toRecord.arrays`_
- *
- * @param array Array to convert
- * @param key Key to use for grouping
- * @param callback Callback to get an item's value
- * @returns Record of keyed arrays of values
- *
- * @example
- * ```typescript
- * toRecordArrays(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   'value',
- *   item => item.id,
- * ); // => { 10: [1, 3], 20: [2] }
- * ```
- */
-export function toRecordArrays<
-	Item extends PlainObject,
-	ItemKey extends keyof Item,
-	Callback extends (item: Item, index: number, array: Item[]) => unknown,
->(
-	array: Item[],
-	key: ItemKey,
-	callback: Callback,
-): Simplify<Record<KeyedValue<Item, ItemKey>, ReturnType<Callback>[]>>;
-
-/**
- * Create a record from an array of items using a key and value, grouping values into arrays
- *
- * _Available as `toRecordArrays` and `toRecord.arrays`_
- *
- * @param array Array to convert
- * @param key Key to use for grouping
- * @param value Key to use for value
- * @returns Record of keyed arrays of values
- *
- * @example
- * ```typescript
- * toRecordArrays(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   'value',
- *   'id',
- * ); // => { 10: [1, 3], 20: [2] }
- * ```
- */
-export function toRecordArrays<
-	Item extends PlainObject,
-	ItemKey extends keyof Item,
-	ItemValue extends keyof Item,
->(
-	array: Item[],
-	key: ItemKey,
-	value: ItemValue,
-): Simplify<Record<KeyedValue<Item, ItemKey>, Item[ItemValue][]>>;
-
-/**
- * Create a record from an array of items using a callback, grouping items into arrays
- *
- * _Available as `toRecordArrays` and `toRecord.arrays`_
- *
- * @param array Array to convert
- * @param callback Callback to get an item's grouping key
- * @returns Record of keyed arrays of items
- *
- * @example
- * ```typescript
- * toRecordArrays(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   item => item.value,
- * ); // => { 10: [{id: 1, value: 10}, {id: 3, value: 10}], 20: [{id: 2, value: 20}] }
- * ```
- */
-export function toRecordArrays<
-	Item,
-	Callback extends (item: Item, index: number, array: Item[]) => Key,
->(array: Item[], callback: Callback): Record<ReturnType<Callback>, Item[]>;
-
-/**
- * Create a record from an array of items using a key, grouping items into arrays
- *
- * _Available as `toRecordArrays` and `toRecord.arrays`_
- *
- * @param array Array to convert
- * @param key Key to use for grouping
- * @returns Record of keyed arrays of items
- *
- * @example
- * ```typescript
- * toRecordArrays(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   'value',
- * ); // => { 10: [{id: 1, value: 10}, {id: 3, value: 10}], 20: [{id: 2, value: 20}] }
- * ```
- */
-export function toRecordArrays<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-): Simplify<Record<KeyedValue<Item, ItemKey>, Item[]>>;
-
-export function toRecordArrays(array: unknown[], first?: unknown, second?: unknown): unknown {
-	return groupValues(array, first, second, true);
-}
-
-// #endregion

package/src/array/to-set.ts

@@ -1,80 +0,0 @@
-import {getArrayCallbacks} from '../internal/array/callbacks';
-import type {PlainObject} from '../models';
-
-// #region Functions
-
-/**
- * Create a _Set_ from an array of items using a callback
- *
- * @param array Array to convert
- * @param callback Callback to get an item's value
- * @returns _Set_ of values
- *
- * @example
- * ```typescript
- * toSet(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id,
- * ); // => Set { 1, 2, 3 }
- * ```
- */
-export function toSet<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(
-	array: Item[],
-	callback: Callback,
-): Set<ReturnType<Callback>>;
-
-/**
- * Create a _Set_ from an array of items using a key
- *
- * @param array Array to convert
- * @param key Key to use for value
- * @returns _Set_ of values
- *
- * @example
- * ```typescript
- * toSet(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   'id',
- * ); // => Set { 1, 2, 3 }
- * ```
- */
-export function toSet<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-): Set<Item[ItemKey]>;
-
-/**
- * Create a _Set_ from an array of items
- *
- * @param array Array to convert
- * @returns _Set_ of items
- *
- * @example
- * ```typescript
- * toSet([1, 2, 3]); // => Set { 1, 2, 3 }
- * ```
- */
-export function toSet<Item>(array: Item[]): Set<Item>;
-
-export function toSet(array: unknown[], value?: unknown): Set<unknown> {
-	if (!Array.isArray(array)) {
-		return new Set();
-	}
-
-	const callbacks = getArrayCallbacks(undefined, undefined, value);
-
-	if (callbacks?.value == null) {
-		return new Set(array);
-	}
-
-	const {length} = array;
-	const set = new Set<unknown>();
-
-	for (let index = 0; index < length; index += 1) {
-		set.add(callbacks.value(array[index], index, array));
-	}
-
-	return set;
-}
-
-// #endregion

package/src/array/toggle.ts

@@ -1,79 +0,0 @@
-import {updateInArray} from '../internal/array/update';
-import type {PlainObject} from '../models';
-
-// #region Functions
-
-/**
- * Toggle an item in an array
- *
- * If the item exists, it will be removed; if it doesn't, it will be added
- *
- * @param destination Array to toggle within
- * @param toggled Toggled items
- * @param callback Callback to find existing item
- * @returns Original array
- *
- * @example
- * ```typescript
- * toggle(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   [{id: 2}, {id: 4}],
- *   item => item.id,
- * ); // => [{id: 1}, {id: 3}, {id: 4}]
- * ```
- */
-export function toggle<Item>(
-	destination: Item[],
-	toggled: Item[],
-	callback: (item: Item, index: number, array: Item[]) => unknown,
-): Item[];
-
-/**
- * Toggle an item in an array
- *
- * If the item exists, it will be removed; if it doesn't, it will be added
- *
- * @param destination Array to toggle within
- * @param toggled Toggled items
- * @param key Key to find existing item
- * @returns Original array
- *
- * @example
- * ```typescript
- * toggle(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   [{id: 2}, {id: 4}],
- *   'id',
- * ); // => [{id: 1}, {id: 3}, {id: 4}]
- * ```
- */
-export function toggle<Item extends PlainObject, ItemKey extends keyof Item>(
-	destination: Item[],
-	toggled: Item[],
-	key: ItemKey,
-): Item[];
-
-/**
- * Toggle an item in an array
- *
- * If the item exists, it will be removed; if it doesn't, it will be added
- *
- * @param destination Array to toggle within
- * @param toggled Toggled items
- * @returns Original array
- *
- * @example
- * ```typescript
- * toggle(
- *   [1, 2, 3],
- *   [2, 4],
- * ); // => [1, 3, 4]
- * ```
- */
-export function toggle<Item>(destination: Item[], toggled: Item[]): Item[];
-
-export function toggle(array: unknown[], values: unknown[], key?: unknown): unknown[] {
-	return updateInArray(array, values, key, false);
-}
-
-// #endregion

package/src/array/union.ts

@@ -1,72 +0,0 @@
-import {COMPARE_SETS_UNION, compareSets} from '../internal/array/sets';
-
-// #region Functions
-
-/**
- * Get the combined, unique values from two arrays
- *
- * @param first First array
- * @param second Second array
- * @param callback Callback to get an item's value for comparison
- * @returns Combined, unique values from both arrays
- *
- * @example
- * ```typescript
- * union(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   [{id: 2}, {id: 4}],
- *   item => item.id,
- * ); // => [{id: 1}, {id: 2}, {id: 3}, {id: 4}]
- * ```
- */
-export function union<First, Second>(
-	first: First[],
-	second: Second[],
-	callback: (item: First | Second) => unknown,
-): (First | Second)[];
-
-/**
- * Get the combined, unique values from two arrays
- *
- * @param first First array
- * @param second Second array
- * @param key Key to get an item's value for comparison
- * @returns Combined, unique values from both arrays
- *
- * @example
- * ```typescript
- * union(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   [{id: 2}, {id: 4}],
- *   'id',
- * ); // => [{id: 1}, {id: 2}, {id: 3}, {id: 4}]
- * ```
- */
-export function union<
-	First extends Record<string, unknown>,
-	Second extends Record<string, unknown>,
-	SharedKey extends keyof First & keyof Second,
->(first: First[], second: Second[], key: SharedKey): (First | Second)[];
-
-/**
- * Get the combined, unique values from two arrays
- *
- * @param first First array
- * @param second Second array
- * @returns Combined, unique values from both arrays
- *
- * @example
- * ```typescript
- * union(
- *   [1, 2, 3],
- *   [2, 4],
- * ); // => [1, 2, 3, 4]
- * ```
- */
-export function union<First, Second>(first: First[], second: Second[]): (First | Second)[];
-
-export function union(first: unknown[], second: unknown[], key?: unknown): unknown[] {
-	return compareSets(COMPARE_SETS_UNION, first, second, key);
-}
-
-// #endregion

package/src/array/unique.ts

@@ -1,67 +0,0 @@
-import {FIND_VALUES_UNIQUE, findValues} from '../internal/array/find';
-import type {PlainObject} from '../models';
-
-// #region Functions
-
-/**
- * Get an array of unique items
- *
- * @param array Original array
- * @param callback Callback to get an item's value
- * @returns Array of unique items
- *
- * @example
- * ```typescript
- * unique(
- *   [{id: 1}, {id: 2}, {id: 3}, {id: 2}],
- *   item => item.id,
- * ); // => [{id: 1}, {id: 2}, {id: 3}]
- * ```
- */
-export function unique<Item>(
-	array: Item[],
-	callback: (item: Item, index: number, array: Item[]) => unknown,
-): Item[];
-
-/**
- * Get an array of unique items
- *
- * @param array Original array
- * @param key Key to use for unique value
- * @returns Array of unique items
- *
- * @example
- * ```typescript
- * unique(
- *   [{id: 1}, {id: 2}, {id: 3}, {id: 2}],
- *   'id',
- * ); // => [{id: 1}, {id: 2}, {id: 3}]
- * ```
- */
-export function unique<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-): Item[];
-
-/**
- * Get an array of unique items
- *
- * @param array Original array
- * @returns Array of unique items
- *
- * @example
- * ```typescript
- * unique([1, 2, 3, 2]); // => [1, 2, 3]
- * ```
- */
-export function unique<Item>(array: Item[]): Item[];
-
-export function unique(array: unknown[], key?: unknown): unknown[] {
-	if (!Array.isArray(array)) {
-		return [];
-	}
-
-	return array.length > 1 ? findValues(FIND_VALUES_UNIQUE, array, [key, undefined]).matched : array;
-}
-
-// #endregion