@sohanemon/utils 5.0.7 → 5.0.8

package/dist/functions/index.js

@@ -1,419 +1,4 @@
-/**
- * Utility to merge class names with Tailwind CSS and additional custom merging logic.
- *
- * @param {...ClassValue[]} inputs - Class names to merge.
- * @returns {string} - A string of merged class names.
- */
-import { clsx } from 'clsx';
-import { twMerge } from 'tailwind-merge';
 export * from './cookie';
 export * from './object';
-export function cn(...inputs) {
-    return twMerge(clsx(inputs));
-}
-/**
- * @deprecated Use isLinkActive instead.
- *
- * Determines if a navigation link is active based on the current path.
- *
- * @param  href - The target URL.
- * @param  path - The current browser path.
- * @returns - True if the navigation is active, false otherwise.
- */
-export function isNavActive(href, path) {
-    console.warn('isNavActive is deprecated. Use isLinkActive instead.');
-    const regex = new RegExp(`^/?${href}(/|$)`);
-    return regex.test(path);
-}
-/**
- * Checks if a link is active, considering optional localization prefixes.
- *
- * @param {Object} params - Parameters object.
- * @param {string} params.path - The target path of the link.
- * @param {string} params.currentPath - The current browser path.
- * @param {string[]} [params.locales=['en', 'es', 'de', 'zh', 'bn', 'fr', 'it', 'nl']] - Supported locale prefixes.
- * @returns {boolean} - True if the link is active, false otherwise.
- */
-export function isLinkActive({ path, currentPath, locales = ['en', 'es', 'de', 'zh', 'bn', 'fr', 'it', 'nl'], exact = true, }) {
-    const localeRegex = new RegExp(`^/?(${locales.join('|')})/`);
-    const normalizePath = (p) => {
-        return p
-            .replace(localeRegex, '') // Remove localization prefix (e.g., en/, fr/, etc.)
-            .replace(/^\/+|\/+$/g, ''); // Trim leading and trailing slashes
-    };
-    const normalizedPath = normalizePath(path);
-    const normalizedCurrentPath = normalizePath(currentPath);
-    return exact
-        ? normalizedPath === normalizedCurrentPath
-        : normalizedCurrentPath.startsWith(normalizedPath);
-}
-/**
- * Cleans a file path by removing the `/public/` prefix if present.
- *
- * @param  src - The source path to clean.
- * @returns - The cleaned path.
- */
-export function cleanSrc(src) {
-    let cleanedSrc = src;
-    if (src.includes('/public/')) {
-        cleanedSrc = src.replace('/public/', '/');
-    }
-    return cleanedSrc.trim();
-}
-/**
- * Smoothly scrolls to the top or bottom of a specified container.
- *
- * @param  containerSelector - The CSS selector or React ref for the container.
- * @param  to - Specifies whether to scroll to the top or bottom.
- */
-export const scrollTo = (containerSelector, to) => {
-    let container;
-    if (typeof containerSelector === 'string') {
-        container = document.querySelector(containerSelector);
-    }
-    else if (containerSelector.current) {
-        container = containerSelector.current;
-    }
-    else {
-        return;
-    }
-    if (container) {
-        container.scrollTo({
-            top: to === 'top' ? 0 : container.scrollHeight - container.clientHeight,
-            behavior: 'smooth',
-        });
-    }
-};
-/**
- * Copies a given string to the clipboard.
- *
- * @param  value - The value to copy to the clipboard.
- * @param  [onSuccess=() => {}] - Optional callback executed after successful copy.
- */
-export const copyToClipboard = (value, onSuccess = () => { }) => {
-    if (typeof window === 'undefined' || !navigator.clipboard?.writeText) {
-        return;
-    }
-    if (!value) {
-        return;
-    }
-    navigator.clipboard.writeText(value).then(onSuccess);
-};
-/**
- * Converts camelCase, PascalCase, kebab-case, snake_case into normal case.
- *
- * @param  inputString - The string need to be converted into normal case
- * @returns - Normal Case
- */
-export function convertToNormalCase(inputString) {
-    const splittedString = inputString.split('.').pop();
-    const string = splittedString || inputString;
-    const words = string.replace(/([a-z])([A-Z])/g, '$1 $2').split(/[-_|�\s]+/);
-    const capitalizedWords = words.map((word) => word.charAt(0).toUpperCase() + word.slice(1));
-    return capitalizedWords.join(' ');
-}
-const from = 'àáãäâèéëêìíïîòóöôùúüûñç·/_,:;';
-const to = 'aaaaaeeeeiiiioooouuuunc------';
-/**
- * Converts a string to a URL-friendly slug by trimming, converting to lowercase,
- * replacing diacritics, removing invalid characters, and replacing spaces with hyphens.
- * @param {string} [str] - The input string to convert.
- * @returns {string} The generated slug.
- * @example
- * convertToSlug("Hello World!"); // "hello-world"
- * convertToSlug("Déjà Vu"); // "deja-vu"
- */
-export const convertToSlug = (str) => {
-    if (typeof str !== 'string') {
-        throw new TypeError('Input must be a string');
-    }
-    // Trim the string and convert it to lowercase.
-    let slug = str.trim().toLowerCase();
-    // Build a mapping of accented characters to their non-accented equivalents.
-    const charMap = {};
-    for (let i = 0; i < from.length; i++) {
-        charMap[from.charAt(i)] = to.charAt(i);
-    }
-    // Replace all accented characters using the mapping.
-    slug = slug.replace(new RegExp(`[${from}]`, 'g'), (match) => charMap[match] || match);
-    return (slug
-        .replace(/[^a-z0-9 -]/g, '') // Remove invalid characters
-        .replace(/\s+/g, '-') // Replace spaces with hyphens
-        .replace(/-+/g, '-') // Collapse consecutive hyphens
-        .replace(/^-+/, '') // Remove leading hyphens
-        .replace(/-+$/, '') || // Remove trailing hyphens
-        '');
-};
-/**
- * Checks if the code is running in a server-side environment.
- *
- * @returns - True if the code is executed in SSR (Server-Side Rendering) context, false otherwise
- */
-export const isSSR = typeof window === 'undefined';
-/**
- * Converts an SVG string to a Base64-encoded string.
- *
- * @param str - The SVG string to encode
- * @returns - Base64-encoded string representation of the SVG
- */
-export const svgToBase64 = (str) => isSSR ? Buffer.from(str).toString('base64') : window.btoa(str);
-/**
- * Pauses execution for the specified time.
- *
- * @param time - Time in milliseconds to sleep (default is 1000ms)
- * @returns - A Promise that resolves after the specified time
- */
-export const sleep = (time = 1000) => new Promise((resolve) => setTimeout(resolve, time));
-/**
- * Creates a debounced function that delays invoking the provided function until
- * after the specified `wait` time has elapsed since the last invocation.
- *
- * If the `immediate` option is set to `true`, the function will be invoked immediately
- * on the leading edge of the wait interval. Subsequent calls during the wait interval
- * will reset the timer but not invoke the function until the interval elapses again.
- *
- * The returned function includes the `isPending` property to check if the debounce
- * timer is currently active.
- *
- * @typeParam F - The type of the function to debounce.
- *
- * @param function_ - The function to debounce.
- * @param wait - The number of milliseconds to delay (default is 100ms).
- * @param options - An optional object with the following properties:
- *   - `immediate` (boolean): If `true`, invokes the function on the leading edge
- *     of the wait interval instead of the trailing edge.
- *
- * @returns A debounced version of the provided function, enhanced with the `isPending` property.
- *
- * @throws {TypeError} If the first parameter is not a function.
- * @throws {RangeError} If the `wait` parameter is negative.
- *
- * @example
- * const log = debounce((message: string) => console.log(message), 200);
- * log('Hello'); // Logs "Hello" after 200ms if no other call is made.
- * console.log(log.isPending); // true if the timer is active.
- */
-export function debounce(function_, wait = 100, options) {
-    if (typeof function_ !== 'function') {
-        throw new TypeError(`Expected the first parameter to be a function, got \`${typeof function_}\`.`);
-    }
-    if (wait < 0) {
-        throw new RangeError('`wait` must not be negative.');
-    }
-    const immediate = options?.immediate ?? false;
-    let timeoutId;
-    let lastArgs;
-    let lastContext;
-    let result;
-    function run() {
-        result = function_.apply(lastContext, lastArgs);
-        lastArgs = undefined;
-        lastContext = undefined;
-        return result;
-    }
-    const debounced = function (...args) {
-        lastArgs = args;
-        lastContext = this;
-        if (timeoutId === undefined && immediate) {
-            result = run.call(this);
-        }
-        if (timeoutId !== undefined) {
-            clearTimeout(timeoutId);
-        }
-        timeoutId = setTimeout(run.bind(this), wait);
-        return result;
-    };
-    Object.defineProperty(debounced, 'isPending', {
-        get() {
-            return timeoutId !== undefined;
-        },
-    });
-    return debounced;
-}
-/**
- * Creates a throttled function that invokes the provided function at most once
- * every `wait` milliseconds.
- *
- * If the `leading` option is set to `true`, the function will be invoked immediately
- * on the leading edge of the throttle interval. If the `trailing` option is set to `true`,
- * the function will also be invoked at the end of the throttle interval if additional
- * calls were made during the interval.
- *
- * The returned function includes the `isPending` property to check if the throttle
- * timer is currently active.
- *
- * @typeParam F - The type of the function to throttle.
- *
- * @param function_ - The function to throttle.
- * @param wait - The number of milliseconds to wait between invocations (default is 100ms).
- * @param options - An optional object with the following properties:
- *   - `leading` (boolean): If `true`, invokes the function on the leading edge of the interval.
- *   - `trailing` (boolean): If `true`, invokes the function on the trailing edge of the interval.
- *
- * @returns A throttled version of the provided function, enhanced with the `isPending` property.
- *
- * @throws {TypeError} If the first parameter is not a function.
- * @throws {RangeError} If the `wait` parameter is negative.
- *
- * @example
- * const log = throttle((message: string) => console.log(message), 200);
- * log('Hello'); // Logs "Hello" immediately if leading is true.
- * console.log(log.isPending); // true if the timer is active.
- */
-export function throttle(function_, wait = 100, options) {
-    if (typeof function_ !== 'function') {
-        throw new TypeError(`Expected the first parameter to be a function, got \`${typeof function_}\`.`);
-    }
-    if (wait < 0) {
-        throw new RangeError('`wait` must not be negative.');
-    }
-    const leading = options?.leading ?? true;
-    const trailing = options?.trailing ?? true;
-    let timeoutId;
-    let lastArgs;
-    let lastContext;
-    let lastCallTime;
-    let result;
-    function invoke() {
-        lastCallTime = Date.now();
-        result = function_.apply(lastContext, lastArgs);
-        lastArgs = undefined;
-        lastContext = undefined;
-    }
-    function later() {
-        timeoutId = undefined;
-        if (trailing && lastArgs) {
-            invoke();
-        }
-    }
-    const throttled = function (...args) {
-        const now = Date.now();
-        const timeSinceLastCall = lastCallTime
-            ? now - lastCallTime
-            : Number.POSITIVE_INFINITY;
-        lastArgs = args;
-        lastContext = this;
-        if (timeSinceLastCall >= wait) {
-            if (leading) {
-                invoke();
-            }
-            else {
-                timeoutId = setTimeout(later, wait);
-            }
-        }
-        else if (!timeoutId && trailing) {
-            timeoutId = setTimeout(later, wait - timeSinceLastCall);
-        }
-        return result;
-    };
-    Object.defineProperty(throttled, 'isPending', {
-        get() {
-            return timeoutId !== undefined;
-        },
-    });
-    return throttled;
-}
-/**
- * Formats a string by replacing each '%s' placeholder with the corresponding argument.
- * This function mimics the basic behavior of C's printf for %s substitution.
- *
- * It supports both calls like `printf(format, ...args)` and `printf(format, argsArray)`.
- *
- * @param format - The format string containing '%s' placeholders.
- * @param args - The values to substitute into the placeholders, either as separate arguments or as a single array.
- * @returns The formatted string with all '%s' replaced by the provided arguments.
- *
- * @example
- * ```ts
- * const message = printf("%s love %s", "I", "Bangladesh");
- * // message === "I love Bangladesh"
- *
- * const arr = ["I", "Bangladesh"];
- * const message2 = printf("%s love %s", arr);
- * // message2 === "I love Bangladesh"
- *
- * // If there are too few arguments:
- * const incomplete = printf("Bangladesh is %s %s", "beautiful");
- * // incomplete === "Bangladesh is beautiful"
- * ```
- */
-export function printf(format, ...args) {
-    const replacements = args.length === 1 && Array.isArray(args[0]) ? args[0] : args;
-    let idx = 0;
-    return format.replace(/%s/g, () => {
-        const arg = replacements[idx++];
-        return arg === undefined ? '' : String(arg);
-    });
-}
-export const mergeRefs = (...refs) => {
-    return (value) => {
-        for (const ref of refs) {
-            if (!ref)
-                continue;
-            if (typeof ref === 'function') {
-                ref(value);
-            }
-            else {
-                ref.current = value;
-            }
-        }
-    };
-};
-/**
- * Navigates to the specified client-side hash without ssr.
- * use `scroll-margin-top` with css to add margins
- *
- * @param id - The ID of the element without # to navigate to.
- *
- * @example goToClientSideHash('my-element');
- */
-export function goToClientSideHash(id, opts) {
-    const el = document.getElementById(id);
-    if (!el)
-        return;
-    el.scrollIntoView({ behavior: 'smooth', block: 'start', ...opts });
-    window.history.pushState(null, '', `#${id}`);
-}
-/**
- * Escapes a string for use in a regular expression.
- *
- * @param str - The string to escape
- * @returns - The escaped string
- *
- * @example
- * const escapedString = escapeRegExp('Hello, world!');
- * // escapedString === 'Hello\\, world!'
- */
-export function escapeRegExp(str) {
-    return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-}
-/**
- * Normalizes a string by:
- * - Applying Unicode normalization (NFC)
- * - Optionally removing diacritic marks (accents)
- * - Optionally trimming leading/trailing non-alphanumeric characters
- * - Optionally converting to lowercase
- *
- * @param str - The string to normalize
- * @param options - Normalization options
- * @param options.lowercase - Whether to convert the result to lowercase (default: true)
- * @param options.removeAccents - Whether to remove diacritic marks like accents (default: true)
- * @param options.removeNonAlphanumeric - Whether to trim non-alphanumeric characters from the edges (default: true)
- * @returns The normalized string
- */
-export function normalizeText(str, options = {}) {
-    if (!str)
-        return '';
-    const { lowercase = true, removeAccents = true, removeNonAlphanumeric = true, } = options;
-    let result = str.normalize('NFC');
-    if (removeAccents) {
-        result = result.replace(/\p{M}/gu, ''); // remove accents
-    }
-    if (removeNonAlphanumeric) {
-        result = result.replace(/^[^\p{L}\p{N}]*|[^\p{L}\p{N}]*$/gu, ''); // trim edges
-    }
-    if (lowercase) {
-        result = result.toLocaleLowerCase();
-    }
-    return result;
-}
+export * from './shield';
+export * from './utils';

package/dist/functions/shield.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A helper to run sync or async operations safely without try/catch.
+ *
+ * Returns a tuple `[error, data]`:
+ * - `error`: the thrown error (if any), otherwise `null`
+ * - `data`: the resolved value (if successful), otherwise `null`
+ *
+ * @example
+ * ```ts
+ * const [err, value] = shield(() => riskySync());
+ * if (err) console.error(err);
+ *
+ * const [asyncErr, result] = await shield(fetchData());
+ * if (asyncErr) throw asyncErr;
+ * ```
+ */
+export declare function shield<T, E = Error>(operation: Promise<T>): Promise<[E | null, T | null]>;
+export declare function shield<T, E = Error>(operation: () => T): [E | null, T | null];

package/dist/functions/shield.js

@@ -0,0 +1,14 @@
+export function shield(operation) {
+    if (operation instanceof Promise) {
+        return operation
+            .then((value) => [null, value])
+            .catch((error) => [error, null]);
+    }
+    try {
+        const data = operation();
+        return [null, data];
+    }
+    catch (error) {
+        return [error, null];
+    }
+}

package/dist/functions/utils.d.ts

@@ -0,0 +1,240 @@
+import { type ClassValue } from 'clsx';
+import type * as React from 'react';
+/**
+ * Utility to merge class names with Tailwind CSS and additional custom merging logic.
+ *
+ * @param {...ClassValue[]} inputs - Class names to merge.
+ * @returns {string} - A string of merged class names.
+ */
+export declare function cn(...inputs: ClassValue[]): string;
+/**
+ * @deprecated Use isLinkActive instead.
+ *
+ * Determines if a navigation link is active based on the current path.
+ *
+ * @param  href - The target URL.
+ * @param  path - The current browser path.
+ * @returns - True if the navigation is active, false otherwise.
+ */
+export declare function isNavActive(href: string, path: string): boolean;
+/**
+ * Checks if a link is active, considering optional localization prefixes.
+ *
+ * @param {Object} params - Parameters object.
+ * @param {string} params.path - The target path of the link.
+ * @param {string} params.currentPath - The current browser path.
+ * @param {string[]} [params.locales=['en', 'es', 'de', 'zh', 'bn', 'fr', 'it', 'nl']] - Supported locale prefixes.
+ * @returns {boolean} - True if the link is active, false otherwise.
+ */
+export declare function isLinkActive({ path, currentPath, locales, exact, }: {
+    path: string;
+    currentPath: string;
+    locales?: string[];
+    exact?: boolean;
+}): boolean;
+/**
+ * Cleans a file path by removing the `/public/` prefix if present.
+ *
+ * @param  src - The source path to clean.
+ * @returns - The cleaned path.
+ */
+export declare function cleanSrc(src: string): string;
+/**
+ * Smoothly scrolls to the top or bottom of a specified container.
+ *
+ * @param  containerSelector - The CSS selector or React ref for the container.
+ * @param  to - Specifies whether to scroll to the top or bottom.
+ */
+export declare const scrollTo: (containerSelector: string | React.RefObject<HTMLDivElement>, to: "top" | "bottom") => void;
+/**
+ * Copies a given string to the clipboard.
+ *
+ * @param  value - The value to copy to the clipboard.
+ * @param  [onSuccess=() => {}] - Optional callback executed after successful copy.
+ */
+export declare const copyToClipboard: (value: string, onSuccess?: () => void) => void;
+/**
+ * Converts camelCase, PascalCase, kebab-case, snake_case into normal case.
+ *
+ * @param  inputString - The string need to be converted into normal case
+ * @returns - Normal Case
+ */
+export declare function convertToNormalCase(inputString: string): string;
+/**
+ * Converts a string to a URL-friendly slug by trimming, converting to lowercase,
+ * replacing diacritics, removing invalid characters, and replacing spaces with hyphens.
+ * @param {string} [str] - The input string to convert.
+ * @returns {string} The generated slug.
+ * @example
+ * convertToSlug("Hello World!"); // "hello-world"
+ * convertToSlug("Déjà Vu"); // "deja-vu"
+ */
+export declare const convertToSlug: (str: string) => string;
+/**
+ * Checks if the code is running in a server-side environment.
+ *
+ * @returns - True if the code is executed in SSR (Server-Side Rendering) context, false otherwise
+ */
+export declare const isSSR: boolean;
+/**
+ * Converts an SVG string to a Base64-encoded string.
+ *
+ * @param str - The SVG string to encode
+ * @returns - Base64-encoded string representation of the SVG
+ */
+export declare const svgToBase64: (str: string) => string;
+/**
+ * Pauses execution for the specified time.
+ *
+ * @param time - Time in milliseconds to sleep (default is 1000ms)
+ * @returns - A Promise that resolves after the specified time
+ */
+export declare const sleep: (time?: number) => Promise<unknown>;
+type DebouncedFunction<F extends (...args: any[]) => any> = {
+    (...args: Parameters<F>): ReturnType<F> | undefined;
+    readonly isPending: boolean;
+};
+/**
+ * Creates a debounced function that delays invoking the provided function until
+ * after the specified `wait` time has elapsed since the last invocation.
+ *
+ * If the `immediate` option is set to `true`, the function will be invoked immediately
+ * on the leading edge of the wait interval. Subsequent calls during the wait interval
+ * will reset the timer but not invoke the function until the interval elapses again.
+ *
+ * The returned function includes the `isPending` property to check if the debounce
+ * timer is currently active.
+ *
+ * @typeParam F - The type of the function to debounce.
+ *
+ * @param function_ - The function to debounce.
+ * @param wait - The number of milliseconds to delay (default is 100ms).
+ * @param options - An optional object with the following properties:
+ *   - `immediate` (boolean): If `true`, invokes the function on the leading edge
+ *     of the wait interval instead of the trailing edge.
+ *
+ * @returns A debounced version of the provided function, enhanced with the `isPending` property.
+ *
+ * @throws {TypeError} If the first parameter is not a function.
+ * @throws {RangeError} If the `wait` parameter is negative.
+ *
+ * @example
+ * const log = debounce((message: string) => console.log(message), 200);
+ * log('Hello'); // Logs "Hello" after 200ms if no other call is made.
+ * console.log(log.isPending); // true if the timer is active.
+ */
+export declare function debounce<F extends (...args: any[]) => any>(function_: F, wait?: number, options?: {
+    immediate: boolean;
+}): DebouncedFunction<F>;
+type ThrottledFunction<F extends (...args: any[]) => any> = {
+    (...args: Parameters<F>): ReturnType<F> | undefined;
+    readonly isPending: boolean;
+};
+/**
+ * Creates a throttled function that invokes the provided function at most once
+ * every `wait` milliseconds.
+ *
+ * If the `leading` option is set to `true`, the function will be invoked immediately
+ * on the leading edge of the throttle interval. If the `trailing` option is set to `true`,
+ * the function will also be invoked at the end of the throttle interval if additional
+ * calls were made during the interval.
+ *
+ * The returned function includes the `isPending` property to check if the throttle
+ * timer is currently active.
+ *
+ * @typeParam F - The type of the function to throttle.
+ *
+ * @param function_ - The function to throttle.
+ * @param wait - The number of milliseconds to wait between invocations (default is 100ms).
+ * @param options - An optional object with the following properties:
+ *   - `leading` (boolean): If `true`, invokes the function on the leading edge of the interval.
+ *   - `trailing` (boolean): If `true`, invokes the function on the trailing edge of the interval.
+ *
+ * @returns A throttled version of the provided function, enhanced with the `isPending` property.
+ *
+ * @throws {TypeError} If the first parameter is not a function.
+ * @throws {RangeError} If the `wait` parameter is negative.
+ *
+ * @example
+ * const log = throttle((message: string) => console.log(message), 200);
+ * log('Hello'); // Logs "Hello" immediately if leading is true.
+ * console.log(log.isPending); // true if the timer is active.
+ */
+export declare function throttle<F extends (...args: any[]) => any>(function_: F, wait?: number, options?: {
+    leading?: boolean;
+    trailing?: boolean;
+}): ThrottledFunction<F>;
+/**
+ * Formats a string by replacing each '%s' placeholder with the corresponding argument.
+ * This function mimics the basic behavior of C's printf for %s substitution.
+ *
+ * It supports both calls like `printf(format, ...args)` and `printf(format, argsArray)`.
+ *
+ * @param format - The format string containing '%s' placeholders.
+ * @param args - The values to substitute into the placeholders, either as separate arguments or as a single array.
+ * @returns The formatted string with all '%s' replaced by the provided arguments.
+ *
+ * @example
+ * ```ts
+ * const message = printf("%s love %s", "I", "Bangladesh");
+ * // message === "I love Bangladesh"
+ *
+ * const arr = ["I", "Bangladesh"];
+ * const message2 = printf("%s love %s", arr);
+ * // message2 === "I love Bangladesh"
+ *
+ * // If there are too few arguments:
+ * const incomplete = printf("Bangladesh is %s %s", "beautiful");
+ * // incomplete === "Bangladesh is beautiful"
+ * ```
+ */
+export declare function printf(format: string, ...args: unknown[]): string;
+/**
+ * Merges multiple refs into a single ref callback.
+ *
+ * @param refs - An array of refs to merge.
+ *
+ * @returns - A function that updates the merged ref with the provided value.
+ */
+export type MergeRefs = <T>(...refs: Array<React.Ref<T> | undefined>) => React.RefCallback<T>;
+export declare const mergeRefs: MergeRefs;
+/**
+ * Navigates to the specified client-side hash without ssr.
+ * use `scroll-margin-top` with css to add margins
+ *
+ * @param id - The ID of the element without # to navigate to.
+ *
+ * @example goToClientSideHash('my-element');
+ */
+export declare function goToClientSideHash(id: string, opts?: ScrollIntoViewOptions): void;
+/**
+ * Escapes a string for use in a regular expression.
+ *
+ * @param str - The string to escape
+ * @returns - The escaped string
+ *
+ * @example
+ * const escapedString = escapeRegExp('Hello, world!');
+ * // escapedString === 'Hello\\, world!'
+ */
+export declare function escapeRegExp(str: string): string;
+/**
+ * Normalizes a string by:
+ * - Applying Unicode normalization (NFC)
+ * - Optionally removing diacritic marks (accents)
+ * - Optionally trimming leading/trailing non-alphanumeric characters
+ * - Optionally converting to lowercase
+ *
+ * @param str - The string to normalize
+ * @param options - Normalization options
+ * @param options.lowercase - Whether to convert the result to lowercase (default: true)
+ * @param options.removeAccents - Whether to remove diacritic marks like accents (default: true)
+ * @param options.removeNonAlphanumeric - Whether to trim non-alphanumeric characters from the edges (default: true)
+ * @returns The normalized string
+ */
+export declare function normalizeText(str?: string | null, options?: {
+    lowercase?: boolean;
+    removeAccents?: boolean;
+    removeNonAlphanumeric?: boolean;
+}): string;
+export {};