useFuzzyFilter

1import { matchSorter } from "match-sorter";
2 
3type Ranking = (typeof matchSorter.rankings)[keyof typeof matchSorter.rankings];
4 
5export type FuzzyThreshold =
6  | "case-sensitive-equal"
7  | "equal"
8  | "starts-with"
9  | "word-starts-with"
10  | "contains"
11  | "acronym"
12  | "matches";
13 
14const thresholdMap: Record<FuzzyThreshold, Ranking> = {
15  "case-sensitive-equal": matchSorter.rankings.CASE_SENSITIVE_EQUAL,
16  "equal": matchSorter.rankings.EQUAL,
17  "starts-with": matchSorter.rankings.STARTS_WITH,
18  "word-starts-with": matchSorter.rankings.WORD_STARTS_WITH,
19  "contains": matchSorter.rankings.CONTAINS,
20  "acronym": matchSorter.rankings.ACRONYM,
21  "matches": matchSorter.rankings.MATCHES,
22};
23 
24function resolveThreshold(threshold: FuzzyThreshold | undefined): Ranking | undefined {
25  if (!threshold) return undefined;
26  return thresholdMap[threshold];
27}
28 
29export interface UseFuzzyFilterOptions {
30  keys: Array<string | { key: string; threshold?: FuzzyThreshold }>;
31  threshold?: FuzzyThreshold;
32}
33 
34export function useFuzzyFilter<T>(options: UseFuzzyFilterOptions) {
35  const resolvedThreshold = resolveThreshold(options.threshold);
36  const resolvedKeys = options.keys.map((key) =>
37    typeof key === "string"
38      ? key
39      : { key: key.key, threshold: resolveThreshold(key.threshold) },
40  );
41 
42  const filter = (items: T[], query: string): T[] => {
43    if (!query) {
44      return items;
45    }
46 
47    return matchSorter(items, query, {
48      keys: resolvedKeys,
49      threshold: resolvedThreshold,
50    });
51  };
52 
53  const filterItem = (item: T, query: string): boolean => {
54    if (!query) {
55      return true;
56    }
57 
58    const results = matchSorter([item], query, {
59      keys: resolvedKeys,
60      threshold: resolvedThreshold,
61    });
62 
63    return results.length > 0;
64  };
65 
66  return { filter, filterItem };
67}