# All files / searching fuzzy.ts

84% Statements 147/175
100% Branches 1/1
50% Functions 1/2
84% Lines 147/175

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    1761x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    10003x
    10003x
    10003x
    10003x
    10003x
    10003x
    10003x
    10003x
    10003x
    10003x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x

     import { type TextExtractor } from "../types.js";
    import { type BaseSearchOptions } from "./types.js";
    import { defaultExtractor, search } from "./utils.js";

    /**
     * @example
     * ```tsx
     * import { createFuzzyRegExp, toSearchQuery } from "@react-md/core":
     * import { useDeferredValue, useMemo, useState, type ReactElement } from "react";
     *
     * function Example(): ReactElement {
     *   const [value, setValue] = useState("");
     *   const deferredValue = useDeferredValue(value)
     *
     *   const match = useMemo(() => {
     *     const query = toSearchQuery(deferredValue);
     *     if (!query) {
     *       return;
     *     }
     *
     *     const fuzzyRegExp = createFuzzyRegExp(query);
     *     return options.find(option => fuzzyRegExp.test(option.label)):
     *   }, [options])
     *
     *   if (match) {
     *     // do something
     *   }
     * }
     *
     * ```
     *
     * @remarks \@since 6.0.0
     * @see {@link fuzzySearch}
     */
    export function createFuzzyRegExp(query: string): RegExp {
      return new RegExp(
        query
          .split("")
          .join("\\w*")
          .replace(/(\(|\||\)|\\(?!w\*)|\[|\|-|\.|\^|\+|\$|\?|^(?!w)\*)/g, "\\$1")
          // Couldn't get the matching of two '*' working, so replace them here..
          .replace(/\*\*/g, "*\\*"),
        "i"
      );
    }

    /**
     * @remarks \@since 6.0.0
     */
    export type FuzzySearchOptions<T> = BaseSearchOptions<T>;

    /**
     * Filters a list by making sure that all the letters appear in order ignoring
     * case, punctuation, whitespace, and special characters. This is kind of the
     * same filtering that appears in text editors.
     *
     * @example
     * Simple Example
     * ```ts
     * const list = [
     *   "at",
     *   "charAt",
     *   "charCodeAt",
     *   "codePointAt",
     *   "concat",
     *   "constructor",
     *   "endsWith",
     *   "includes",
     *   "indexOf",
     *   "lastIndexOf",
     *   "length",
     *   "localeCompare",
     *   "match",
     *   "matchAll",
     *   "normalize",
     *   "padEnd",
     *   "padStart",
     *   "repeat",
     *   "replace",
     *   "replaceAll",
     *   "search",
     *   "slice",
     *   "split",
     *   "startsWith",
     *   "substring",
     *   "toLocaleLowerCase",
     *   "toLocaleUpperCase",
     *   "toLowerCase",
     *   "toString",
     *   "toUpperCase",
     *   "trim",
     *   "trimEnd",
     *   "trimStart",
     *   "valueOf",
     * ];
     *
     * fuzzySearch({
     *   list,
     *   query: "la",
     * });
     * // [
     * //   "lastIndexOf",
     * //    ^^
     * //   "localeCompare",
     * //    ^  ^
     * //   "replace",
     * //       ^^
     * //   "replaceAll",
     * //       ^^
     * //   "toLocaleLowerCase",
     * //      ^  ^
     * //   "toLocaleUpperCase",
     * //      ^  ^
     * //   "toLowerCase",
     * //      ^     ^
     * // ]
     *
     * fuzzySearch({
     *   list,
     *   query: "ad",
     *   type: "search",
     * });
     * // "charCodeAt"
     *  //    ^   ^
     * ```
     *
     * @remarks \@since 6.0.0
     */
    export function fuzzySearch<T extends string>(
      options: Omit<FuzzySearchOptions<T>, "extractor"> & { type?: "filter" }
    ): readonly T[];
    export function fuzzySearch<T extends string>(
      options: Omit<FuzzySearchOptions<T>, "extractor"> & { type?: "search" }
    ): T | undefined;
    export function fuzzySearch<T>(
      option: FuzzySearchOptions<T> & {
        extractor: TextExtractor<T>;
        type?: "filter";
      }
    ): readonly T[];
    export function fuzzySearch<T>(
      option: FuzzySearchOptions<T> & {
        extractor: TextExtractor<T>;
        type?: "search";
      }
    ): T | undefined;
    export function fuzzySearch<T>(
      options: FuzzySearchOptions<T>
    ): readonly T[] | T | undefined {
      const {
        list,
        type = "filter",
        query,
        extractor = defaultExtractor("fuzzySearch"),
        whitespace,
      } = options;

      // lazy initialize the RegExp since the base `filter` function will modify the
      // query and never call the filter function if:
      // - there is no query
      // - the list is empty
      let regexp: RegExp;
      return search({
        type,
        list,
        query,
        extractor,
        whitespace,
        filter(query, value) {
          return (
            value.length > 0 && (regexp ??= createFuzzyRegExp(query)).test(value)
          );
        },
      });
    }