@finos/legend-shared/src/search/FuzzySearch.ts

Legend Studio shared utilities and helpers

/**
 * Copyright (c) 2020-present, Goldman Sachs
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import Fuse, {
  type FuseSortFunctionArg,
  type FuseSortFunctionItem,
} from 'fuse.js';

export const FuzzySearchEngine = Fuse;
// eslint-disable-next-line @typescript-eslint/no-redeclare
export type FuzzySearchEngine<T> = Fuse<T>;
export type FuzzySearchEngineSortFunctionArg = FuseSortFunctionArg & {
  item:
    | FuseSortFunctionItem
    | {
        [key: string | number]: {
          n?: number;
          v?: string;
        };
      };
};