@oscarpalmer/atoms 0.193.0 → 0.193.1

package/src/array/group-by.ts

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

package/src/array/index.ts

@@ -1,26 +0,0 @@
-export * from '../internal/array/chunk';
-export * from '../internal/array/compact';
-export * from '../internal/array/index-of';
-export * from '../internal/array/shuffle';
-
-export * from './difference';
-export * from './exists';
-export * from './find';
-export * from './flatten';
-export * from './from';
-export * from './get';
-export * from './insert';
-export * from './intersection';
-export * from './partition';
-export * from './match';
-export * from './push';
-export * from './reverse';
-export * from './select';
-export * from './single';
-export * from './slice';
-export * from './splice';
-export * from './to-set';
-export * from './toggle';
-export * from './union';
-export * from './unique';
-export * from './update';

package/src/array/insert.ts

@@ -1,52 +0,0 @@
-import {INSERT_TYPE_INSERT, insertValues} from '../internal/array/insert';
-
-// #region Functions
-
-/**
- * Insert items into an array at a specified index
- *
- * _(Uses chunking to avoid call stack size being exceeded)_
- *
- * @param array Original array
- * @param index Index to insert at
- * @param items Inserted items
- * @returns Updated array
- *
- * @example
- * ```typescript
- * insert([1, 2, 3], 1, [4, 5]); // => [1, 4, 5, 2, 3]
- * ```
- */
-export function insert<Item>(array: Item[], index: number, items: Item[]): Item[];
-
-/**
- * Insert items into an array _(at the end)_
- *
- * _(Uses chunking to avoid call stack size being exceeded)_
- *
- * @param array Original array
- * @param items Inserted items
- * @returns Updated array
- *
- * @example
- * ```typescript
- * insert([1, 2, 3], [4, 5]); // => [1, 2, 3, 4, 5]
- * ```
- */
-export function insert<Item>(array: Item[], items: Item[]): Item[];
-
-export function insert(
-	array: unknown[],
-	indexOrItems: number | unknown[],
-	items?: unknown[],
-): unknown[] {
-	return insertValues(
-		INSERT_TYPE_INSERT,
-		array,
-		items == null ? indexOrItems : items,
-		typeof indexOrItems === 'number' ? indexOrItems : array?.length,
-		0,
-	) as unknown[];
-}
-
-// #endregion

package/src/array/intersection.ts

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

package/src/array/last.ts

@@ -1,194 +0,0 @@
-import {findAbsoluteValueOrDefault} from '../internal/array/find';
-import type {PlainObject} from '../models';
-
-// #region Functions
-
-/**
- * Get the last items matching the given value
- *
- * @param array Array to search in
- * @param callback Callback to get an item's value for matching
- * @param value Value to match against
- * @returns Last item that matches the value, or `undefined` if no match is found
- *
- * @example
- * ```typescript
- * last(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   item => item.value,
- *   10,
- * ); // => {id: 3, value: 10}
- * ```
- */
-export function last<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(
-	array: Item[],
-	callback: Callback,
-	value: ReturnType<Callback>,
-): Item | undefined;
-
-/**
- * Get the first item matching the given value by key
- *
- * @param array Array to search in
- * @param key Key to get an item's value for matching
- * @param value Value to match against
- * @returns Last item that matches the value, or `undefined` if no match is found
- *
- * @example
- * ```typescript
- * last(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   'value',
- *   10,
- * ); // => {id: 3, value: 10}
- * ```
- */
-export function last<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): Item | undefined;
-
-/**
- * Get the last item matching the filter
- *
- * @param array Array to search in
- * @param filter Filter callback to match items
- * @returns Last item that matches the filter, or `undefined` if no match is found
- *
- * @example
- * ```typescript
- * last(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   item => item.value === 10,
- * ); // => {id: 3, value: 10}
- * ```
- */
-export function last<Item>(
-	array: Item[],
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-): Item | undefined;
-
-/**
- * Get the last item from an array
- *
- * @param array Array to get from
- * @returns Last item from the array, or `undefined` if the array is empty
- *
- * @example
- * ```typescript
- * last([1, 2, 3]); // => 3
- * ```
- */
-export function last<Item>(array: Item[]): Item | undefined;
-
-export function last(array: unknown[], ...parameters: unknown[]): unknown {
-	return findAbsoluteValueOrDefault(array, parameters, undefined, false, true);
-}
-
-last.default = lastOrDefault;
-
-/**
- * Get the last item matching the given value
- *
- * _Available as `lastOrDefault` and `last.default`_
- *
- * @param array Array to search in
- * @param defaultValue Default value to return if no match is found
- * @param callback Callback to get an item's value for matching
- * @param value Value to match against
- * @returns Last item that matches the value, or the default value if no match is found
- *
- * @example
- * ```typescript
- * lastOrDefault(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   {id: -1, value: 30},
- *   item => item.value,
- *   30,
- * ); // => {id: -1, value: 30}
- * ```
- */
-export function lastOrDefault<
-	Item,
-	Callback extends (item: Item, index: number, array: Item[]) => unknown,
->(array: Item[], defaultValue: Item, callback: Callback, value: ReturnType<Callback>): Item;
-
-/**
- * Get the last item matching the given value by key
- *
- * _Available as `lastOrDefault` and `last.default`_
- *
- * @param array Array to search in
- * @param defaultValue Default value to return if no match is found
- * @param key Key to get an item's value for matching
- * @param value Value to match against
- * @returns Last item that matches the value, or the default value if no match is found
- *
- * @example
- * ```typescript
- * lastOrDefault(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   {id: -1, value: 30},
- *   'value',
- *   30,
- * ); // => {id: -1, value: 30}
- * ```
- */
-export function lastOrDefault<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	defaultValue: Item,
-	key: ItemKey,
-	value: Item[ItemKey],
-): Item;
-
-/**
- * Get the last item matching the filter
- *
- * _Available as `lastOrDefault` and `last.default`_
- *
- * @param array Array to search in
- * @param defaultValue Default value to return if no match is found
- * @param filter Filter callback to match items
- * @returns Last item that matches the filter, or the default value if no match is found
- *
- * @example
- * ```typescript
- * lastOrDefault(
- *   [{id: 1, value: 10}, {id: 2, value: 20}, {id: 3, value: 10}],
- *   {id: -1, value: 30},
- *   item => item.value === 30,
- * ); // => {id: -1, value: 30}
- * ```
- */
-export function lastOrDefault<Item>(
-	array: Item[],
-	defaultValue: Item,
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-): Item;
-
-/**
- * Get the last item from an array
- *
- * _Available as `lastOrDefault` and `last.default`_
- *
- * @param array Array to get from
- * @param defaultValue Default value to return if the array is empty
- * @returns Last item from the array, or the default value if the array is empty
- *
- * @example
- * ```typescript
- * lastOrDefault([], {id: -1, value: 30}); // => {id: -1, value: 30}
- * ```
- */
-export function lastOrDefault<Item>(array: Item[], defaultValue: Item): Item;
-
-export function lastOrDefault(
-	array: unknown[],
-	defaultValue: unknown,
-	...parameters: unknown[]
-): unknown {
-	return findAbsoluteValueOrDefault(array, parameters, defaultValue, true, true);
-}
-
-// #endregion