@oscarpalmer/atoms 0.219.0 → 0.221.0

package/dist/index.d.mts

@@ -4417,6 +4417,14 @@ export declare namespace pipe {
   export var async: typeof asyncPipe;
 }
 //#endregion
+//#region src/models/string/string.case.model.d.ts
+type StringCase = "camel" | "capitalize" | "kebab" | "lower" | "pascal" | "snake" | "title" | "upper";
+type StringCaseOptions = {
+  capitalizeAny: boolean;
+  capitalizeFirst: boolean;
+  type: StringCase;
+};
+//#endregion
 //#region src/internal/string/case.d.ts
 /**
  * Convert a string to camel case _(thisIsCamelCase)_
@@ -4522,6 +4530,7 @@ export declare function snakeCase(value: string): string;
  * ```
  */
 export declare function titleCase(value: string): string;
+export declare function toCaseCallback(this: StringCaseOptions, value: string): string;
 /**
  * Convert a string to upper case
  *
@@ -6367,26 +6376,28 @@ type Fuzzy<Item> = {
    *
    * @param value Value to search for
    * @param options Search options
-   * @returns Search results, with exact matches _(ordered)_ and similar matches _(ordered by relevance)_
+   * @returns Search results, with exact, included, and similar matches
    */
   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)_
+   * @param limit Maximum number of combined items to return in `exact`, `included`, and `similar`
+   * @returns Search results, with exact, included, and similar matches
    */
   search(value: string, limit: number): FuzzyResult<Item>;
 };
 type FuzzyConfiguration<Item> = {
+  handler?: (item: Item) => string;
   /**
-   * Handler to stringify items
+   * Function to compare the stringified items for results _(defaults to `Intl.Collator().compare`)_
    *
-   * - 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`
+   * @param first First string to compare
+   * @param second Second string to compare
+   * @returns Comparison result, similar to `Array.prototype.sort` callback
    */
-  handler?: (item: Item) => string;
+  compare?: (first: string, second: string) => number;
 } & (Item extends PlainObject ? {
   /**
    * Key to use to stringify items
@@ -6395,13 +6406,13 @@ type FuzzyConfiguration<Item> = {
    */
   key?: keyof Item;
 } : {}) & FuzzyOptions;
-type FuzzyItem<Item> = {
-  item: Item;
-  haystack: string;
+type FuzzyItem<Data> = {
+  data: Data;
+  string: FuzzyString;
 };
 type FuzzyOptions = {
   /**
-   * Maximum number of combined items to return in `exact` and `similar` _(defaults to all matches)_
+   * Maximum number of combined items to return in `exact`, `included`, and `similar` _(defaults to all matches)_
    */
   limit?: number;
   /**
@@ -6412,29 +6423,56 @@ type FuzzyOptions = {
    */
   tolerance?: number;
 };
+type FuzzyRanked<Data> = {
+  position: number;
+  /**
+   * `0` for starting with the value, `1` for the value starting a word, `2` for anything else
+   */
+  rank: number;
+} & FuzzyItem<Data>;
 /**
- * Search results from a fuzzy search, with exact and similar matches
+ * Search results from a fuzzy search, with exact, included, and similar matches
  */
 type FuzzyResult<Item> = {
   /**
-   * Ordered items that exactly match the search value
+   * Items whose strings exactly match the search value, ordered alphabetically
    */
   exact: Item[];
   /**
-   * Ordered items that are similar to the search value, ranked by relevance
+   * Items whose strings contain the search value, ordered alphabetically
+   */
+  included: Item[];
+  /**
+   * Items whose strings are similar to the search value, ranked by relevance, sorted by score, and ordered alphabetically within the same score
    */
   similar: Item[];
 };
 type FuzzyState<Item> = {
+  compare: FuzzyStateCompare<Item>;
   handler(item: Item): string;
-  items: Item[];
-  limit?: number;
-  strings: string[];
+  items: FuzzyStateItems<Item>;
+  limit: number;
   tolerance: number;
 };
+type FuzzyStateCompare<Item = unknown> = {
+  item: (first: FuzzyItem<Item>, second: FuzzyItem<Item>) => number;
+  ranked: (first: FuzzyRanked<Item>, second: FuzzyRanked<Item>) => number;
+};
+type FuzzyStateItems<Item> = {
+  original: Array<FuzzyItem<Item>>;
+  sorted?: Array<FuzzyItem<Item>>;
+};
+type FuzzyString = {
+  lowercase: string;
+  original: string;
+};
+type InternalFuzzy<Item = unknown> = {
+  [FUZZY_SYMBOL]: FuzzyState<Item>;
+} & Fuzzy<Item>;
+declare const FUZZY_SYMBOL: unique symbol;
 //#endregion
 //#region src/string/fuzzy.d.ts
-declare function Fuzzy(this: any, state: FuzzyState<unknown>): void;
+declare function Fuzzy(this: InternalFuzzy, state: FuzzyState<unknown>): void;
 /**
  * Create a fuzzy searcher for an array of items
  *
@@ -9453,4 +9491,4 @@ export declare class SizedSet<Value = unknown> extends Set<Value> {
   get(value: Value, update?: boolean): Value | undefined;
 }
 //#endregion
-export { type ArrayComparisonSorter, type ArrayKeySorter, type ArrayKeySorters, type ArraySorter, type ArraySorters, type ArrayValueSorter, type Asserter, type AssignOptions, type Assigner, type AsyncFailure, type AsyncFlow, type AsyncLimiter, type AsyncOnce, type AsyncPlan, type AsyncPlanned, type AsyncStep, type AsyncSuccess, type Beacon, type BeaconOptions, type CloneOptions, type Cloner, type Color, type ColorType, type ColorTypeExtended, type ColorValue, type ColorValueExtended, type CompareCallback, type ComparisonSorter, type DiffOptions, type DiffResult, type EqualOptions, type Equalizer, type Failure, type Flow, type FulfilledPromise, type Fuzzy, type FuzzyItem, type FuzzyOptions, type FuzzyResult, type HSLAColor, type HSLColor, type HWBAColor, type HWBColor, type Herald, type HeraldEvents, type HeraldOptions, Key$1 as Key, type KeyedQueue, type Limiter, Logger, type Memoized, type MemoizedOptions, type MergeOptions, type Merger, type NormalizeOptions, type Normalizer, type Observable, type Observer, type Once, type Plan, type PlanError, type PlanOk, type PlanReturned, type Planned, type PromiseOptions, type PromiseStrategy, type PromisesOptions, type Queue, type QueueOptions, type Queued, type RGBAColor, type RGBColor, type RejectedPromise, type Renderer, type Shaken, type Smushed, type SortDirection, type Sorter, type Step, type Subscription, type SubscriptionParameters, type SubscriptionProperty, type Subscriptions, type SubscriptionsParameters, type Success, type TemplateOptions, type Templater, type TemplaterOptions, type TemplaterRenderer, type TimeLogger, type TransformCallback, type TransformCallbacks, type Transformer, type Unsmushed, push as append, filterAndMap as select, toPromise as fromResult, getRandomFloatingNumber as getRandomFloat, isLogger, isTimeLogger, mapAndFilter as reverseSelect };
+export { type ArrayComparisonSorter, type ArrayKeySorter, type ArrayKeySorters, type ArraySorter, type ArraySorters, type ArrayValueSorter, type Asserter, type AssignOptions, type Assigner, type AsyncFailure, type AsyncFlow, type AsyncLimiter, type AsyncOnce, type AsyncPlan, type AsyncPlanned, type AsyncStep, type AsyncSuccess, type Beacon, type BeaconOptions, type CloneOptions, type Cloner, type Color, type ColorType, type ColorTypeExtended, type ColorValue, type ColorValueExtended, type CompareCallback, type ComparisonSorter, type DiffOptions, type DiffResult, type EqualOptions, type Equalizer, type Failure, type Flow, type FulfilledPromise, type Fuzzy, type FuzzyOptions, type FuzzyResult, type HSLAColor, type HSLColor, type HWBAColor, type HWBColor, type Herald, type HeraldEvents, type HeraldOptions, Key$1 as Key, type KeyedQueue, type Limiter, Logger, type Memoized, type MemoizedOptions, type MergeOptions, type Merger, type NormalizeOptions, type Normalizer, type Observable, type Observer, type Once, type Plan, type PlanError, type PlanOk, type PlanReturned, type Planned, type PromiseOptions, type PromiseStrategy, type PromisesOptions, type Queue, type QueueOptions, type Queued, type RGBAColor, type RGBColor, type RejectedPromise, type Renderer, type Shaken, type Smushed, type SortDirection, type Sorter, type Step, type Subscription, type SubscriptionParameters, type SubscriptionProperty, type Subscriptions, type SubscriptionsParameters, type Success, type TemplateOptions, type Templater, type TemplaterOptions, type TemplaterRenderer, type TimeLogger, type TransformCallback, type TransformCallbacks, type Transformer, type Unsmushed, push as append, filterAndMap as select, toPromise as fromResult, getRandomFloatingNumber as getRandomFloat, isLogger, isTimeLogger, mapAndFilter as reverseSelect };