@oscarpalmer/atoms 0.193.0 → 0.193.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/atoms",
-	"version": "0.193.0",
+	"version": "0.193.1",
 	"description": "Atomic utilities for making your JavaScript better.",
 	"keywords": [
 		"helper",
@@ -17,8 +17,7 @@
 	},
 	"files": [
 		"dist",
-		"plugin",
-		"src"
+		"plugin"
 	],
 	"type": "module",
 	"module": "./dist/index.mjs",
@@ -269,4 +268,4 @@
 		"vitest": "npm:@voidzero-dev/vite-plus-test@latest"
 	},
 	"packageManager": "npm@11.11.1"
-}
+}

package/src/array/difference.ts

@@ -1,73 +0,0 @@
-import {COMPARE_SETS_DIFFERENCE, compareSets} from '../internal/array/sets';
-import type {PlainObject} from '../models';
-
-// #region Functions
-
-/**
- * Get the items from the first array that are not in the second array
- *
- * @param first First array
- * @param second Second array
- * @param callback Callback to get an item's value for comparison
- * @returns Unique values from the first array
- *
- * @example
- * ```typescript
- * difference(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   [{id: 2}, {id: 4}],
- *   item => item.id,
- * ); // => [{id: 1}, {id: 3}]
- * ```
- */
-export function difference<First, Second>(
-	first: First[],
-	second: Second[],
-	callback: (item: First | Second) => unknown,
-): First[];
-
-/**
- * Get the items from the first array that are not in the second array
- *
- * @param first First array
- * @param second Second array
- * @param key Key to get an item's value for comparison
- * @returns Unique values from the first array
- *
- * @example
- * ```typescript
- * difference(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   [{id: 2}, {id: 4}],
- *   'id',
- * ); // => [{id: 1}, {id: 3}]
- * ```
- */
-export function difference<
-	First extends PlainObject,
-	Second extends PlainObject,
-	SharedKey extends keyof First & keyof Second,
->(first: First[], second: Second[], key: SharedKey): First[];
-
-/**
- * Get the items from the first array that are not in the second array
- *
- * @param first First array
- * @param second Second array
- * @returns Unique values from the first array
- *
- * @example
- * ```typescript
- * difference(
- *   [1, 2, 3],
- *   [2, 4],
- * ); // => [1, 3]
- * ```
- */
-export function difference<First, Second>(first: First[], second: Second[]): First[];
-
-export function difference(first: unknown[], second: unknown[], key?: unknown): unknown[] {
-	return compareSets(COMPARE_SETS_DIFFERENCE, first, second, key);
-}
-
-// #endregion

package/src/array/exists.ts

@@ -1,93 +0,0 @@
-import {FIND_VALUE_INDEX, findValue} from '../internal/array/find';
-import type {PlainObject} from '../models';
-
-// #region Functions
-
-/**
- * Does an item with a specific value exist in the array?
- *
- * @param array Array to search in
- * @param callback Callback to get an item's value for matching
- * @param value Value to match against
- * @returns `true` if the item exists in the array, otherwise `false`
- *
- * @example
- * ```typescript
- * exists(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id,
- *   2,
- * ); // => true
- * ```
- */
-export function exists<
-	Item,
-	Callback extends (item: Item, index: number, array: Item[]) => unknown,
->(array: Item[], callback: Callback, value: ReturnType<Callback>): boolean;
-
-/**
- * Does an item with a specific value exist in the array?
- *
- * @param array Array to search in
- * @param key Key to get an item's value for matching
- * @param value Value to match against
- * @returns `true` if the item exists in the array, otherwise `false`
- *
- * @example
- * ```typescript
- * exists(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   'id',
- *   2,
- * ); // => true
- * ```
- */
-export function exists<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): boolean;
-
-/**
- * Does an item in the array match the filter?
- *
- * @param array Array to search in
- * @param filter Filter callback to match items
- * @returns `true` if a matching item exists, otherwise `false`
- *
- * @example
- * ```typescript
- * exists(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id === 2,
- * ); // => true
- * ```
- */
-export function exists<Item>(
-	array: Item[],
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-): boolean;
-
-/**
- * Does the item exist in the array?
- *
- * @param array Array to search in
- * @param item Item to search for
- * @returns `true` if the item exists in the array, otherwise `false`
- *
- * @example
- * ```typescript
- * exists([1, 2, 3], 2); // => true
- * ```
- */
-export function exists<Item>(array: Item[], item: Item): boolean;
-
-export function exists(array: unknown[], ...parameters: unknown[]): boolean {
-	if (parameters.length === 1 && typeof parameters[0] !== 'function') {
-		return Array.isArray(array) ? array.includes(parameters[0]) : false;
-	}
-
-	return findValue(FIND_VALUE_INDEX, array, parameters, false) > -1;
-}
-
-// #endregion

package/src/array/filter.ts

@@ -1,182 +0,0 @@
-import {FIND_VALUES_ALL, findValues} from '../internal/array/find';
-import type {PlainObject} from '../models';
-
-// #region Functions
-
-/**
- * Get a filtered array of items that do not match the value
- *
- * _Available as `exclude` and `filter.remove`_
- *
- * @param array Array to search in
- * @param callback Callback to get an item's value for matching
- * @param value Value to match against
- * @returns Filtered array of items that do not match the filter
- *
- * @example
- * ```typescript
- * exclude(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id,
- *   2,
- * ); // => [{id: 1}, {id: 3}]
- * ```
- */
-export function exclude<
-	Item,
-	Callback extends (item: Item, index: number, array: Item[]) => unknown,
->(array: Item[], callback: Callback, value: ReturnType<Callback>): unknown[];
-
-/**
- * Get a filtered array of items that do not match the value
- *
- * _Available as `exclude` and `filter.remove`_
- *
- * @param array Array to search in
- * @param key Key to get an item's value for matching
- * @param value Value to match against
- * @returns Filtered array of items that do not match the filter
- *
- * @example
- * ```typescript
- * exclude(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   'id',
- *   2,
- * ); // => [{id: 1}, {id: 3}]
- * ```
- */
-export function exclude<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): unknown[];
-
-/**
- * Get a filtered array of items that do not match the filter
- *
- * _Available as `exclude` and `filter.remove`_
- *
- * @param array Array to search in
- * @param filter Filter callback to match items
- * @returns Filtered array of items that do not match the filter
- *
- * @example
- * ```typescript
- * exclude(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id === 2,
- * ); // => [{id: 1}, {id: 3}]
- * ```
- */
-export function exclude<Item>(
-	array: Item[],
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-): unknown[];
-
-/**
- * Get a filtered array of items that do not match the given item
- *
- * _Available as `exclude` and `filter.remove`_
- *
- * @param array Array to search in
- * @param item Item to match against
- * @returns Filtered array of items that do not match the given item
- *
- * @example
- * ```typescript
- * exclude([1, 2, 3], 2); // => [1, 3]
- * ```
- */
-export function exclude<Item>(array: Item[], item: Item): unknown[];
-
-export function exclude(array: unknown[], ...parameters: unknown[]): unknown[] {
-	return findValues(FIND_VALUES_ALL, array, parameters).notMatched;
-}
-
-/**
- * Get a filtered 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 Filtered array of items
- *
- * @example
- * ```typescript
- * filter(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id,
- *   2,
- * ); // => [{id: 2}]
- * ```
- */
-export function filter<
-	Item,
-	Callback extends (item: Item, index: number, array: Item[]) => unknown,
->(array: Item[], callback: Callback, value: ReturnType<Callback>): Item[];
-
-/**
- * Get a filtered 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 Filtered array of items
- *
- * @example
- * ```typescript
- * filter(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   'id',
- *   2,
- * ); // => [{id: 2}]
- * ```
- */
-export function filter<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): Item[];
-
-/**
- * Get a filtered array of items matching the filter
- *
- * @param array Array to search in
- * @param filter Filter callback to match items
- * @returns Filtered array of items
- *
- * @example
- * ```typescript
- * filter(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id === 2,
- * ); // => [{id: 2}]
- * ```
- */
-export function filter<Item>(
-	array: Item[],
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-): Item[];
-
-/**
- * Get a filtered array of items matching the given item
- *
- * @param array Array to search in
- * @param item Item to match against
- * @returns Filtered array of items
- *
- * @example
- * ```typescript
- * filter([1, 2, 3], 2); // => [2]
- * ```
- */
-export function filter<Item>(array: Item[], item: Item): Item[];
-
-export function filter(array: unknown[], ...parameters: unknown[]): unknown[] {
-	return findValues(FIND_VALUES_ALL, array, parameters).matched;
-}
-
-filter.remove = exclude;
-
-// #endregion

package/src/array/find.ts

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