@oscarpalmer/atoms 0.177.0 → 0.179.0

package/dist/array/index.d.mts

@@ -13,6 +13,7 @@ import { intersection } from "./intersection.mjs";
 import { partition } from "./partition.mjs";
 import { ArrayPosition, endsWithArray, getArrayPosition, includesArray, indexOfArray, startsWithArray } from "./position.mjs";
 import { push } from "./push.mjs";
+import { reverse } from "./reverse.mjs";
 import { select } from "./select.mjs";
 import { single } from "./single.mjs";
 import { drop, slice, take } from "./slice.mjs";
@@ -22,4 +23,4 @@ import { toggle } from "./toggle.mjs";
 import { union } from "./union.mjs";
 import { unique } from "./unique.mjs";
 import { update } from "./update.mjs";
-export { ArrayPosition, chunk, compact, difference, drop, endsWithArray, exists, find, flatten, getArray, getArrayPosition, includesArray, indexOf, indexOfArray, insert, intersection, partition, push, range, select, shuffle, single, slice, splice, startsWithArray, take, times, toSet, toggle, union, unique, update };
+export { ArrayPosition, chunk, compact, difference, drop, endsWithArray, exists, find, flatten, getArray, getArrayPosition, includesArray, indexOf, indexOfArray, insert, intersection, partition, push, range, reverse, select, shuffle, single, slice, splice, startsWithArray, take, times, toSet, toggle, union, unique, update };

package/dist/array/index.mjs

@@ -13,6 +13,7 @@ import { intersection } from "./intersection.mjs";
 import { partition } from "./partition.mjs";
 import { endsWithArray, getArrayPosition, includesArray, indexOfArray, startsWithArray } from "./position.mjs";
 import { push } from "./push.mjs";
+import { reverse } from "./reverse.mjs";
 import { select } from "./select.mjs";
 import { single } from "./single.mjs";
 import { drop, slice, take } from "./slice.mjs";
@@ -22,4 +23,4 @@ import { toggle } from "./toggle.mjs";
 import { union } from "./union.mjs";
 import { unique } from "./unique.mjs";
 import { update } from "./update.mjs";
-export { chunk, compact, difference, drop, endsWithArray, exists, find, flatten, getArray, getArrayPosition, includesArray, indexOf, indexOfArray, insert, intersection, partition, push, range, select, shuffle, single, slice, splice, startsWithArray, take, times, toSet, toggle, union, unique, update };
+export { chunk, compact, difference, drop, endsWithArray, exists, find, flatten, getArray, getArrayPosition, includesArray, indexOf, indexOfArray, insert, intersection, partition, push, range, reverse, select, shuffle, single, slice, splice, startsWithArray, take, times, toSet, toggle, union, unique, update };

package/dist/array/reverse.d.mts

@@ -0,0 +1,4 @@
+//#region src/array/reverse.d.ts
+declare function reverse<Item>(array: Item[]): Item[];
+//#endregion
+export { reverse };

package/dist/array/reverse.mjs

@@ -0,0 +1,16 @@
+//#region src/array/reverse.ts
+function reverse(array) {
+	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
+export { reverse };

package/dist/index.d.mts

@@ -829,6 +829,9 @@ declare function startsWithArray<Item>(haystack: Item[], needle: Item[]): boolea
  */
 declare function push<Item>(array: Item[], pushed: Item[]): number;
 //#endregion
+//#region src/array/reverse.d.ts
+declare function reverse<Item>(array: Item[]): Item[];
+//#endregion
 //#region src/array/select.d.ts
 /**
  * Get a filtered and mapped array of items
@@ -2666,7 +2669,116 @@ declare function titleCase(value: string): string;
  */
 declare function upperCase(value: string): string;
 //#endregion
+//#region src/string/fuzzy.d.ts
+/**
+ * Fuzzy searcher for an array of items
+ */
+declare class Fuzzy<Item> {
+  #private;
+  /**
+   * Get items currently being searched through
+   */
+  get items(): Item[];
+  /**
+   * Set new items to search through
+   */
+  set items(items: Item[]);
+  /**
+   * Get strings currently being searched through _(the stringified version of `items`)_
+   */
+  get strings(): string[];
+  constructor(state: FuzzyState<Item>);
+  /**
+   * Search for items matching the given value
+   * @param value Value to search for
+   * @param options Search options
+   * @returns Search results, with exact matches _(ordered)_ and similar matches _(ordered by relevance)_
+   */
+  search(value: string, options?: FuzzyOptions): FuzzyResult<Item>;
+  /**
+   * Search for items matching the given value
+   * @param value Value to search for
+   * @param limit Maximum number of combined items to return in `exact` and `similar`
+   * @returns Search results, with exact matches _(ordered)_ and similar matches _(ordered by relevance)_
+   */
+  search(value: string, limit: number): FuzzyResult<Item>;
+}
+type FuzzyConfiguration<Item> = {
+  /**
+   * Handler to stringify items
+   *
+   * May be a function that takes an item and returns a string, or if items are plain objects, a key of the item to use to grab a string value from
+   *
+   * Defaults to `getString`
+   */
+  handler?: (item: Item) => string;
+} & (Item extends PlainObject ? {
+  /**
+   * Key to use to stringify items
+   *
+   * Prioritized over `handler`
+   */
+  key?: keyof Item;
+} : {}) & FuzzyOptions;
+type FuzzyOptions = {
+  /**
+   * Maximum number of combined items to return in `exact` and `similar` _(defaults to all matches)_
+   */
+  limit?: number;
+  /**
+   * Maximum score difference between the best and worst similar matches included in results; higher values cast a wider net _(defaults to 5)_
+   */
+  tolerance?: number;
+};
+/**
+ * Search results from a fuzzy search, with exact and similar matches
+ */
+type FuzzyResult<Item> = {
+  /**
+   * Ordered items that exactly match the search value
+   */
+  exact: Item[];
+  /**
+   * Ordered items that are similar to the search value, ranked by relevance
+   */
+  similar: Item[];
+};
+/**
+ * Options for fuzzy searching
+ */
+type FuzzySearchOptions = FuzzyOptions;
+type FuzzyState<Item> = {
+  handler: (item: Item) => string;
+  items: Item[];
+  limit?: number;
+  strings: string[];
+  tolerance: number;
+};
+/**
+ * Create a fuzzy searcher for an array of items
+ * @param items Items to search through
+ * @param key Key to use to stringify items
+ * @returns Fuzzy searcher
+ */
+declare function fuzzy<Item extends PlainObject, ItemKey extends keyof Item>(items: Item[], key?: ItemKey): Fuzzy<Item>;
+/**
+ * Create a fuzzy searcher for an array of items
+ * @param items Items to search through
+ * @param handler Handler to stringify items
+ * @returns Fuzzy searcher
+ */
+declare function fuzzy<Item>(items: Item[], handler?: (item: Item) => string): Fuzzy<Item>;
+/**
+ * Create a fuzzy searcher for an array of items
+ * @param items Items to search through
+ * @param configuration Fuzzy configuration
+ * @returns Fuzzy searcher
+ */
+declare function fuzzy<Item>(items: Item[], configuration?: FuzzyConfiguration<Item>): Fuzzy<Item>;
+//#endregion
 //#region src/string/index.d.ts
+declare function dedent(strings: TemplateStringsArray, ...values: unknown[]): string;
+declare function dedent(value: string): string;
 /**
  * Get a new UUID-string _(version 4)_
  * @returns UUID string
@@ -3343,13 +3455,54 @@ declare function isInstanceOf<Instance>(constructor: Constructor<Instance>, valu
  * @returns `true` if the value is a `Key` _(`number` or `string`)_, otherwise `false`
  */
 declare function isKey(value: unknown): value is Key;
+/**
+ * Is the value not an array or a plain object?
+ * @param value Value to check
+ * @returns `true` if the value is not an array or a plain object, otherwise `false`
+ */
 declare function isNonArrayOrPlainObject<Value>(value: Value): value is Exclude<Value, ArrayOrPlainObject>;
+/**
+ * Is the value not a constructor function?
+ * @param value Value to check
+ * @returns `true` if the value is not a constructor function, otherwise `false`
+ */
 declare function isNonConstructor<Value>(value: Value): value is Exclude<Value, Constructor>;
+/**
+ * Is the value not an instance of the constructor?
+ * @param constructor Class constructor
+ * @param value Value to check
+ * @returns `true` if the value is not an instance of the constructor, otherwise `false`
+ */
 declare function isNonInstanceOf<Instance, Value>(constructor: Constructor<Instance>, value: Value): value is Exclude<Value, Instance>;
+/**
+ * Is the value not a key?
+ * @param value Value to check
+ * @returns `true` if the value is not a `Key` _(`number` or `string`)_, otherwise `false`
+ */
 declare function isNonKey<Value>(value: Value): value is Exclude<Value, Key>;
+/**
+ * Is the value not a number?
+ * @param value Value to check
+ * @returns `true` if the value is not a `number`, otherwise `false`
+ */
 declare function isNonNumber<Value>(value: Value): value is Exclude<Value, number>;
+/**
+ * Is the value not a plain object?
+ * @param value Value to check
+ * @returns `true` if the value is not a plain object, otherwise `false`
+ */
 declare function isNonPlainObject<Value>(value: Value): value is Exclude<Value, PlainObject>;
+/**
+ * Is the value not a primitive value?
+ * @param value Value to check
+ * @returns `true` if the value is not a primitive value, otherwise `false`
+ */
 declare function isNonPrimitive<Value>(value: Value): value is Exclude<Value, Primitive>;
+/**
+ * Is the value not a typed array?
+ * @param value Value to check
+ * @returns `true` if the value is not a typed array, otherwise `false`
+ */
 declare function isNonTypedArray<Value>(value: Value): value is Exclude<Value, TypedArray>;
 /**
  * Is the value a number?
@@ -4780,4 +4933,4 @@ declare class SizedSet<Value = unknown> extends Set<Value> {
   get(value: Value, update?: boolean): Value | undefined;
 }
 //#endregion
-export { AnyResult, ArrayComparisonSorter, ArrayKeySorter, ArrayOrPlainObject, ArrayPosition, ArrayValueSorter, Asserter, AsyncCancelableCallback, AttemptFlow, AttemptFlowPromise, type Beacon, type BeaconOptions, BuiltIns, CancelableCallback, CancelablePromise, type Color, Constructor, DiffOptions, DiffResult, DiffValue, EqualOptions, Err, EventPosition, ExtendedErr, ExtendedResult, Flow, FlowPromise, FulfilledPromise, GenericAsyncCallback, GenericCallback, type HSLAColor, type HSLColor, HasValue, Key, KeyedValue, type Logger, type Memoized, type MemoizedOptions, MergeOptions, Merger, NestedArray, NestedKeys, NestedPartial, NestedValue, NestedValues, NumericalKeys, NumericalValues, type Observable, type Observer, Ok, OnceAsyncCallback, OnceCallback, PROMISE_ABORT_EVENT, PROMISE_ABORT_OPTIONS, PROMISE_ERROR_NAME, PROMISE_MESSAGE_EXPECTATION_ATTEMPT, PROMISE_MESSAGE_EXPECTATION_RESULT, PROMISE_MESSAGE_EXPECTATION_TIMED, PROMISE_MESSAGE_TIMEOUT, PROMISE_STRATEGY_ALL, PROMISE_STRATEGY_DEFAULT, PROMISE_TYPE_FULFILLED, PROMISE_TYPE_REJECTED, PlainObject, Primitive, PromiseData, PromiseHandlers, PromiseOptions, PromiseParameters, PromiseStrategy, PromiseTimeoutError, PromisesItems, PromisesOptions, PromisesResult, PromisesUnwrapped, PromisesValue, PromisesValues, type Queue, QueueError, type QueueOptions, type Queued, type QueuedResult, type RGBAColor, type RGBColor, RejectedPromise, RequiredKeys, Result, ResultMatch, RetryError, RetryOptions, SORT_DIRECTION_ASCENDING, SORT_DIRECTION_DESCENDING, Simplify, SizedMap, SizedSet, Smushed, SortDirection, Sorter, type Subscription, TemplateOptions, type Time, ToString, TypedArray, Unsmushed, UnwrapValue, assert, attempt, attemptFlow, attemptPipe, attemptPromise, average, beacon, between, camelCase, cancelable, capitalize, ceil, chunk, clamp, clone, compact, compare, count, debounce, delay, diff, difference, drop, endsWith, endsWithArray, equal, error, exists, filter, find, first, flatten, floor, flow, fromQuery, toPromise as fromResult, toPromise, getArray, getArrayPosition, getColor, getError, getForegroundColor, getHexColor, getHexaColor, getHslColor, getHslaColor, getNormalizedHex, getNumber, getRandomBoolean, getRandomCharacters, getRandomColor, getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems, getRgbColor, getRgbaColor, getString, getTimedPromise, getUuid, getValue, groupBy, handleResult, hasValue, hexToHsl, hexToHsla, hexToRgb, hexToRgba, hslToHex, hslToRgb, hslToRgba, ignoreKey, inMap, inSet, includes, includesArray, indexOf, indexOfArray, insert, intersection, isArrayOrPlainObject, isColor, isConstructor, isEmpty, isError, isFulfilled, isHexColor, isHslColor, isHslLike, isHslaColor, isInstanceOf, isKey, isNonArrayOrPlainObject, isNonConstructor, isNonEmpty, isNonInstanceOf, isNonKey, isNonNullable, isNonNullableOrEmpty, isNonNullableOrWhitespace, isNonNumber, isNonNumerical, isNonObject, isNonPlainObject, isNonPrimitive, isNonTypedArray, isNullable, isNullableOrEmpty, isNullableOrWhitespace, isNumber, isNumerical, isObject, isOk, isPlainObject, isPrimitive, isRejected, isResult, isRgbColor, isRgbLike, isRgbaColor, isTypedArray, join, kebabCase, last, logger, lowerCase, matchResult, max, median, memoize, merge, min, move, noop, ok, omit, once, parse, partition, pascalCase, pick, pipe, promises, push, queue, range, retry, rgbToHex, rgbToHsl, rgbToHsla, round, select, setValue, settlePromise, shuffle, single, slice, smush, snakeCase, sort, splice, startsWith, startsWithArray, sum, swap, take, template, throttle, timed, times, titleCase, toMap, toQuery, toRecord, toResult, toSet, toggle, trim, truncate, tryDecode, tryEncode, union, unique, unsmush, unwrap, update, upperCase, words };
+export { AnyResult, ArrayComparisonSorter, ArrayKeySorter, ArrayOrPlainObject, ArrayPosition, ArrayValueSorter, Asserter, AsyncCancelableCallback, AttemptFlow, AttemptFlowPromise, type Beacon, type BeaconOptions, BuiltIns, CancelableCallback, CancelablePromise, type Color, Constructor, DiffOptions, DiffResult, DiffValue, EqualOptions, Err, EventPosition, ExtendedErr, ExtendedResult, Flow, FlowPromise, FulfilledPromise, FuzzyConfiguration, FuzzyOptions, FuzzyResult, FuzzySearchOptions, GenericAsyncCallback, GenericCallback, type HSLAColor, type HSLColor, HasValue, Key, KeyedValue, type Logger, type Memoized, type MemoizedOptions, MergeOptions, Merger, NestedArray, NestedKeys, NestedPartial, NestedValue, NestedValues, NumericalKeys, NumericalValues, type Observable, type Observer, Ok, OnceAsyncCallback, OnceCallback, PROMISE_ABORT_EVENT, PROMISE_ABORT_OPTIONS, PROMISE_ERROR_NAME, PROMISE_MESSAGE_EXPECTATION_ATTEMPT, PROMISE_MESSAGE_EXPECTATION_RESULT, PROMISE_MESSAGE_EXPECTATION_TIMED, PROMISE_MESSAGE_TIMEOUT, PROMISE_STRATEGY_ALL, PROMISE_STRATEGY_DEFAULT, PROMISE_TYPE_FULFILLED, PROMISE_TYPE_REJECTED, PlainObject, Primitive, PromiseData, PromiseHandlers, PromiseOptions, PromiseParameters, PromiseStrategy, PromiseTimeoutError, PromisesItems, PromisesOptions, PromisesResult, PromisesUnwrapped, PromisesValue, PromisesValues, type Queue, QueueError, type QueueOptions, type Queued, type QueuedResult, type RGBAColor, type RGBColor, RejectedPromise, RequiredKeys, Result, ResultMatch, RetryError, RetryOptions, SORT_DIRECTION_ASCENDING, SORT_DIRECTION_DESCENDING, Simplify, SizedMap, SizedSet, Smushed, SortDirection, Sorter, type Subscription, TemplateOptions, type Time, ToString, TypedArray, Unsmushed, UnwrapValue, assert, attempt, attemptFlow, attemptPipe, attemptPromise, average, beacon, between, camelCase, cancelable, capitalize, ceil, chunk, clamp, clone, compact, compare, count, debounce, dedent, delay, diff, difference, drop, endsWith, endsWithArray, equal, error, exists, filter, find, first, flatten, floor, flow, fromQuery, toPromise as fromResult, toPromise, fuzzy, getArray, getArrayPosition, getColor, getError, getForegroundColor, getHexColor, getHexaColor, getHslColor, getHslaColor, getNormalizedHex, getNumber, getRandomBoolean, getRandomCharacters, getRandomColor, getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems, getRgbColor, getRgbaColor, getString, getTimedPromise, getUuid, getValue, groupBy, handleResult, hasValue, hexToHsl, hexToHsla, hexToRgb, hexToRgba, hslToHex, hslToRgb, hslToRgba, ignoreKey, inMap, inSet, includes, includesArray, indexOf, indexOfArray, insert, intersection, isArrayOrPlainObject, isColor, isConstructor, isEmpty, isError, isFulfilled, isHexColor, isHslColor, isHslLike, isHslaColor, isInstanceOf, isKey, isNonArrayOrPlainObject, isNonConstructor, isNonEmpty, isNonInstanceOf, isNonKey, isNonNullable, isNonNullableOrEmpty, isNonNullableOrWhitespace, isNonNumber, isNonNumerical, isNonObject, isNonPlainObject, isNonPrimitive, isNonTypedArray, isNullable, isNullableOrEmpty, isNullableOrWhitespace, isNumber, isNumerical, isObject, isOk, isPlainObject, isPrimitive, isRejected, isResult, isRgbColor, isRgbLike, isRgbaColor, isTypedArray, join, kebabCase, last, logger, lowerCase, matchResult, max, median, memoize, merge, min, move, noop, ok, omit, once, parse, partition, pascalCase, pick, pipe, promises, push, queue, range, retry, reverse, rgbToHex, rgbToHsl, rgbToHsla, round, select, setValue, settlePromise, shuffle, single, slice, smush, snakeCase, sort, splice, startsWith, startsWithArray, sum, swap, take, template, throttle, timed, times, titleCase, toMap, toQuery, toRecord, toResult, toSet, toggle, trim, truncate, tryDecode, tryEncode, union, unique, unsmush, unwrap, update, upperCase, words };