@mtes-mct/monitor-ui 6.2.1 → 6.3.0

package/libs/CustomSearch.d.ts

@@ -0,0 +1,72 @@
+import Fuse from 'fuse.js';
+export type CustomSearchOptions = Partial<{
+    /** Cache search index to avoid Must be unique in the entire application. */
+    cacheKey: string | undefined;
+    /**
+     * Indicates whether comparisons should be case sensitive.
+     *
+     * @default false
+     * @see https://fusejs.io/api/options.html#iscasesensitive
+     */
+    isCaseSensitive: boolean;
+    /** Indicates whether comparisons should be diacritic (= accent) sensitive. */
+    isDiacriticSensitive: boolean;
+    /**
+     * Use strict keywords matching, disabling fuzziness.
+     *
+     * @default false
+     * @description
+     * Looking for "emoi" in ["mÉMOIre", "mÉMOrIsable"] will return only the first one if `isStrict` is `true`,
+     * instead of returning both by default (`false`).
+     */
+    isStrict: boolean;
+    /**
+     * At what point does the match algorithm give up.
+     *
+     * @default 0.6
+     * @description
+     * A threshold of `0.0` requires a perfect match (of both letters and location),
+     * a threshold of `1.0` would match anything.
+     *
+     * @see https://fusejs.io/api/options.html#threshold
+     */
+    threshold: number;
+}>;
+export type CustomSearchKey<T> = string | Fuse.FuseOptionKeyObject<T>;
+export declare class CustomSearch<T extends Record<string, any> = Record<string, any>> {
+    #private;
+    constructor(collection: T[], keys: Array<CustomSearchKey<T>>, { cacheKey, isCaseSensitive, isDiacriticSensitive, isStrict, threshold }?: CustomSearchOptions);
+    /**
+     * Searches the entire collection, and returns a list of items matching this query.
+     *
+     * @param query The keywords to look for
+     * @param limit Denotes the max number of returned search results
+     * @returns     A list of matching items
+     */
+    find(query: string, limit?: number): T[];
+    /**
+     * Replace all the diacritics with unaccented letters in a collection, targetting the provided keys.
+     *
+     * @param collection  An array of objects
+     * @param keys        List of item prop path to clean, either a using strings
+     *                    or [Fuse.js weighted objects](https://fusejs.io/api/options.html#keys)
+     * @returns           The same collection with its specified keys normalized without diacritics
+     *
+     * @example
+     * ```ts
+     * const collection = [
+     *   { name: 'aérosol', description: 'Un aérosol.', author: { name: 'Camille Hervé' } },
+     *   { name: 'martèlement', description: 'Un martèlement.', author: { name: 'Athénée Perreault' } }
+     * ]
+     *
+     * const normalizedCollection = CustomSearch.cleanCollectionDiacritics(collection, ['name', 'author.name'])
+     * console.log(normalizedCollection[0])
+     * // => `{ "name": "aerosol", "description": "Un aérosol.", author: { name: 'Camille Herve' } }`
+     *
+     * const normalizedCollection = CustomSearch.cleanCollectionDiacritics(collection, [{ name: 'name', weight: 1 }])
+     * console.log(normalizedCollection[0])
+     * // => `{ "name": "aerosol", "description": "Un aérosol.", author: { name: 'Camille Hervé' }`
+     * ```
+     */
+    static cleanCollectionDiacritics<T extends Record<string, any> = Record<string, any>>(collection: T[], keys: Array<CustomSearchKey<T>>): T[];
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mtes-mct/monitor-ui",
   "description": "Common React UI components and styles for Monitorfish and Monitorenv.",
-  "version": "6.2.1",
+  "version": "6.3.0",
   "license": "AGPL-3.0",
   "engines": {
     "node": ">=18"