@react-fabric/utilities 1.0.0-beta.8 → 1.0.1

package/dist/types/data/format.d.ts

@@ -0,0 +1,122 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Format utility functions for various data types.
+ * This namespace provides methods to format phone numbers, numbers, bytes, percentages, dates, and durations.
+ */
+export declare namespace Format {
+    /**
+     * Format phone number with country flag or emoji.
+     * It takes a phone number string, a country code, and a boolean to indicate whether to use CSS classes for flags.
+     * If the phone number is empty, less than 6 characters, or does not match the regex for valid phone numbers,
+     * it returns the original value.
+     * If the phone number is valid, it formats the phone number using `libphonenumber-js` and returns it with the country flag or emoji.
+     * The country flag is represented as a CSS class, and the emoji is obtained from the `Countries` module.
+     *
+     * @param {string} value - The phone number to format.
+     * @param {string} country - The country code to use for formatting.
+     * @param {boolean} useCss - Whether to use CSS classes for flags.
+     * @returns {string} The formatted phone number with country flag or emoji.
+     */
+    function phone(value?: string, country?: string, useCss?: boolean): string | undefined;
+    /**
+     * Format number using `numeral`.
+     * It takes a number or string and a format string, and returns the formatted number.
+     * If the number is undefined or null, it returns an empty string.
+     * If the number starts with a '+', it retains the '+' sign in the formatted output.
+     * This function is useful for displaying numbers in a human-readable format,
+     * such as for financial data, statistics, or any numerical representation.
+     *
+     * @param {string | number} number - number or string to format
+     * @param {string} [format] - optional format string, defaults to "0,0[.]00a"
+     * @returns {string} formatted number
+     */
+    function number(number?: string | number, format?: string): string;
+    /**
+     * Format bytes using `numeral`.
+     * It takes a number or string and returns the formatted bytes.
+     * If the number is undefined or null, it returns an empty string.
+     * If the number starts with a '+', it retains the '+' sign in the formatted output.
+     * This function is useful for displaying file sizes or data transfer amounts in a human-readable format.
+     *
+     * @param {string | number} number - number or string to format
+     * @returns {string} formatted bytes
+     */
+    function bytes(number?: string | number): string;
+    /**
+     * Format percentage using `numeral`.
+     * It takes a number or string and returns the formatted percentage.
+     * If the number is undefined or null, it returns an empty string.
+     * If the number starts with a '+', it retains the '+' sign in the formatted output.
+     *
+     * @param {string | number} number - number or string to format
+     * @returns {string} formatted percentage
+     */
+    function percent(number?: string | number): string;
+    /**
+     * Format date using `date-fns`.
+     * It takes a date (as a Date object, string, or number) and a format string.
+     * If the date is undefined or null, it returns an empty string.
+     * If the date is a valid date, it formats it using the provided format string.
+     * Format defaults to "d-M-y" if not provided.
+     *
+     * @param {date | string | number} date - Date object, string, or number to format
+     * @typedef {string} format - Optional format string, defaults to "d-M-y"
+     * @returns {string} - Formatted date string
+     */
+    function date(date?: Date | string | number, format?: string): string;
+    /** ***************** format time duration from total seconds/milliseconds *******************/
+    /**
+     * Format time duration with milliseconds
+     * This function takes a number or string representing a duration in seconds or milliseconds,
+     * and returns a formatted string in the format "HH:mm:ss.SSS".
+     * If the input is undefined or null, it returns "00:00.000".
+     * If the input is Infinity, it returns "∞".
+     * The function also accepts an optional boolean parameter `isFraction` to indicate whether the input is in seconds (true) or milliseconds (false).
+     * If `isFraction` is true, the input is multiplied by 1000 to convert seconds to milliseconds.
+     * The function uses the `makeDuration` helper function to format the duration.
+     *
+     * @param {string | number} number - The duration to format, can be a string or number.
+     * @param {boolean} isFraction - Optional parameter to indicate if the input is in seconds (true) or milliseconds (false).
+     * @returns {string} - The formatted duration string.
+     */
+    function duration(number?: string | number, isFraction?: boolean): string;
+    /**
+     * Format time duration in seconds
+     * This function takes a number or string representing a duration in seconds,
+     * and returns a formatted string in the format "HH:mm:ss".
+     * If the input is undefined or null, it returns "00:00".
+     * If the input is Infinity, it returns "∞".
+     * The function also accepts an optional boolean parameter `isFraction` to indicate whether the input is in seconds (true) or milliseconds (false).
+     * If `isFraction` is true, the input is multiplied by 1000 to convert seconds to milliseconds.
+     * The function uses the `makeDuration` helper function to format the duration.
+     * This function is useful for displaying durations in a human-readable format, such as for timers or elapsed time.
+     *
+     * @param {string | number} number - The duration to format, can be a string or number.
+     * @param {boolean} isFraction - Optional parameter to indicate if the input is in seconds (true) or milliseconds (false).
+     * @returns {string} - The formatted duration string.
+     */
+    function durationSeconds(number?: string | number, isFraction?: boolean): string;
+}

package/dist/types/helpers/debounce.d.ts

@@ -0,0 +1,38 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Debounce function to limit the rate at which a function can fire.
+ * It will delay the execution of the function until after a specified timeout
+ * has elapsed since the last time the function was invoked.
+ *
+ * @param fn - The function to debounce.
+ * @param timeout - The number of milliseconds to wait before invoking the function.
+ * @returns A debounced version of the function that can be called with any arguments.
+ *          The debounced function also has a `cancel` method to clear the timeout.
+ */
+export declare function debounce(fn: (...rest: AnyObject[]) => unknown, timeout?: number): {
+    (...args: AnyObject[]): void;
+    cancel(): void;
+};

package/dist/types/helpers/getLogger.d.ts

@@ -0,0 +1,49 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+interface LogDetail {
+    module?: string;
+    process?: string;
+    duration?: number;
+    totalTime?: number;
+}
+/**
+ * Returns a logger object with log/debug/info/error/warning methods, adapted for Node or browser. Optionally takes a module name.
+ */
+export declare const getLogger: (mod?: string) => {
+    timer(process: string): {
+        log: (msg: string, ...rest: unknown[]) => void;
+        debug: (msg: string, ...rest: unknown[]) => void;
+        info: (msg: string, ...rest: unknown[]) => void;
+        error: (msg: string, ...rest: unknown[]) => void;
+        warning: (msg: string, ...rest: unknown[]) => void;
+        end: (msg?: string, ...rest: unknown[]) => void;
+    };
+    log(msg: string, opts: LogDetail, ...rest: unknown[]): void;
+    debug(msg: string, opts: LogDetail, ...rest: unknown[]): void;
+    info(msg: string, opts: LogDetail, ...rest: unknown[]): void;
+    error(msg: string, opts: LogDetail, ...rest: unknown[]): void;
+    warning(msg: string, opts: LogDetail, ...rest: unknown[]): void;
+};
+export {};

package/dist/types/helpers/lonlat.d.ts

@@ -0,0 +1,48 @@
+export type LngLatLike = {
+    lng: number;
+    lat: number;
+} | {
+    lon: number;
+    lat: number;
+} | {
+    longitude: number;
+    latitude: number;
+} | [lon: number | string, lat: number | string] | [lon: number | string, lat: number | string, z: number | string] | string;
+/**
+ * Convert various formats of longitude and latitude to a tuple of [lon, lat].
+ * This function supports:
+ * - Arrays with two or three elements (e.g., [lon, lat] or [lon, lat, alt])
+ * - Objects with properties `lng`, `lat`, `lon`, or `longitude` and `latitude`
+ * - Strings in the format "lat,lon"
+ * The function will return a tuple of numbers [lon, lat].
+ *
+ * @param {LngLatLike} lonLat - The input longitude and latitude in various formats.
+ * @returns { [lon: number, lat: number] } A tuple of [lon, lat] where lon and lat are numbers.
+ * @throws Error if the input is not a valid format.
+ */
+export declare function convertToLonLat(lonLat: LngLatLike): [lon: number, lat: number];
+export declare function getLatitudeLongitude(lonLat: LngLatLike): {
+    latitude: number;
+    longitude: number;
+};
+/**
+ * Convert a latitude and longitude to a human-readable text format.
+ * This function takes a latitude and longitude in various formats and
+ * returns a string in the format "degrees˚minutes'seconds" with direction (N/S, E/W).
+ *
+ * This function supports:
+ *
+ * - Objects with properties `lng`, `lat`, `lon`, or `longitude` and `latitude`
+ * - Arrays with two or three elements (e.g., [lon, lat] or [lon, lat, alt])
+ * - Strings in the format "lat,lon"
+ *
+ * @param {LngLatLike} latlon - The latitude and longitude in various formats.
+ * @returns {string} A string representation of the location in DMS format.
+ *
+ * @example
+ * ```jsx
+ * const location = getLocationAsText({ lat: 40.7128, lng: -74.0060 });
+ * console.log(location); // "40˚42'51.36"N, 74˚0'21.60"W"
+ * ```
+ */
+export declare function getLocationAsText(latlon: LngLatLike): string;

package/dist/types/index.d.ts

@@ -1,22 +1,56 @@
-export * from "./_ascii";
-export * from "./_boundingBox";
-export { getBoundingBox, getBox } from "./_boundingBox";
-export { default as Countries } from "./_countries";
-export type { Country } from "./_countries";
-export * from "./_debounce";
-export * from "./_dedupe";
-export { _fetch as fetch } from "./_fetch";
-export { default as FileUtil } from "./_fileType";
-export * from "./_format";
-export * from "./_getByPath";
-export * from "./_hash";
-export * from "./_interpolate";
-export * from "./_isEqual";
-export * from "./_isType";
-export * from "./_mergeRefs";
-export * from "./_tokenize";
-export { getImageColorset } from "./getImageColorset";
-export { useLogger } from "./useLogger";
-export * from "./yup";
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+export declare const UTILITIES_PACKAGE = "@react-fabric/utilities";
+export declare const UTILITIES_VERSION = "1.0.0";
+export { getBoundingBox, getBox } from "./css/boundingBox";
+export { cn } from "./css/cn";
+export { getImageColorset } from "./css/imageColorset";
+export { dedupe } from "./lists/dedupe";
+export { flatten, flattenAndDedupe } from "./lists/flatten";
+export { getByPath, getValue } from "./lists/getByPath";
+export { groupBy } from "./lists/groupBy";
+export { default as Countries } from "./data/countries";
+export type { Country } from "./data/countries";
+export { default as FileUtil } from "./data/fileType";
+export { Format } from "./data/format";
+export { debounce } from "./helpers/debounce";
+export { getLogger } from "./helpers/getLogger";
+export { convertToLonLat, getLatitudeLongitude, getLocationAsText } from "./helpers/lonlat";
+export type { LngLatLike } from "./helpers/lonlat";
+export { compareValues } from "./matchers/compare";
+export { isEmpty } from "./matchers/isEmpty";
+export { isEqual } from "./matchers/isEqual";
+export { isDefined, isNil, isNull, isUndefined } from "./matchers/nullChecks";
+export { isArray, isBoolean, isColor, isFalse, isNumber, isObject, isString, isSvgPath, isTrue } from "./matchers/typeChecks";
+export { hash, shortHash, uuid } from "./strings/hash";
+export { interpolate } from "./strings/interpolate";
+export { matchString } from "./strings/matchString";
+export { renderTemplate } from "./strings/template";
+export { iconToken, tokenize } from "./strings/tokenize";
+export { mergeRefs } from "./utils/mergeRefs";
+export { yup } from "./utils/yup";
 export declare const EMPTY_ARRAY: never[];
 export declare const EMPTY_OBJECT: {};
+export declare const EMPTY_FC: () => () => null;

package/dist/types/lists/dedupe.d.ts

@@ -0,0 +1,36 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Remove duplicates from a list of objects based on a key or the entire object.
+ * If a key is provided, it will deduplicate based on the value of that key.
+ * If no key is provided, it will deduplicate based on the entire object.
+ * This is useful for normalizing data structures that may have nested arrays or objects.
+ *
+ * @param list
+ * @param key
+ * @typedef {T} AnyObject - A generic type representing list items.
+ * @returns {T[]} - A new array with duplicates removed.
+ */
+export declare function dedupe<T extends AnyObject>(list: T[], key?: keyof T): T[];

package/dist/types/lists/flatten.d.ts

@@ -0,0 +1,47 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Flatten a list of objects, removing any empty objects.
+ * It will flatten up to 5 levels deep and filter out any empty objects.
+ * This is useful for normalizing data structures that may have nested arrays or objects.
+ *
+ * @param list
+ * @typedef {T} AnyObject - A generic type representing list items.
+ * @returns {T[]} - A flattened array of objects.
+ */
+export declare function flatten<T extends AnyObject>(list: T[]): (T extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : T)[];
+/**
+ * Flatten a list of objects and remove duplicates based on a key or the entire object.
+ * If a key is provided, it will deduplicate based on the value of that key.
+ * If no key is provided, it will deduplicate based on the entire object.
+ * This is useful for normalizing data structures that may have nested arrays or objects.
+ * Flattening is done first, followed by deduplication.
+ *
+ * @param list
+ * @param key
+ * @typedef {T} AnyObject - A generic type representing list items.
+ * @returns {T[]} - A new array with duplicates removed.
+ */
+export declare function flattenAndDedupe<T extends AnyObject>(list?: T[][], key?: keyof T): T[];

package/dist/types/lists/getByPath.d.ts

@@ -0,0 +1,45 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Get a value from an object by a given path.
+ * This function allows you to retrieve a value from a nested object structure using a dot-separated path.
+ * If the path does not exist or the object is empty, it returns a default value.
+ * @param {KeyValue} obj - The object from which to retrieve the value.
+ * @param {string} path - The dot-separated path to the value within the object.
+ * @param {any} defaultValue - The value to return if the path does not exist or the object is empty.
+ * @typedef {T} AnyObject - The type of the value to be returned.
+ * @returns {T} The value at the specified path, or the default value if the path does not exist.
+ */
+export declare function getByPath<T = unknown>(obj: KeyValue, path: string, defaultValue?: any): T;
+/**
+ * Get the first non-empty value from the provided arguments.
+ * This function is useful for finding a default value or fallback when multiple values are provided.
+ * It checks each argument in order and returns the first one that is not empty.
+ * If all arguments are empty, it returns `undefined`.
+ *
+ * @param {...any} args - The values to check for non-emptiness.
+ * @returns {any} The first non-empty value, or `undefined` if all are empty.
+ */
+export declare function getValue<T = string>(...args: T[]): T | undefined;

package/dist/types/lists/groupBy.d.ts

@@ -0,0 +1,36 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Group a list of objects by a specific property.
+ * If the property is not present in an object, it will use the `missingKey` value as the key.
+ * This is useful for organizing data into categories based on a specific property.
+ *
+ * @param list
+ * @param prop
+ * @param missingKey
+ * @typedef {T} KeyValue - A generic type representing list items with key-value pairs.
+ * @returns {KeyValue<T[]>} - An object mapping keys to arrays of items.
+ */
+export declare function groupBy<T extends KeyValue>(list: T[], prop: keyof T, missingKey?: string): KeyValue<T[]>;

package/dist/types/matchers/compare.d.ts

@@ -0,0 +1,38 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Compare two values for sorting.
+ * This function compares two values based on the specified order (ascending or descending).
+ * If a key is provided, it compares the values of that key in the objects.
+ * It handles various data types such as strings, numbers, booleans, and objects.
+ * It returns a comparison function that can be used with array sorting methods.
+ * * The comparison is done in a case-insensitive manner for strings,
+ *  treating special characters as their ASCII equivalents.
+ *
+ * @param {("asc" | "desc")} order - The order of comparison, either "asc" for ascending or "desc" for descending.
+ * @param {string} key - An optional key to compare values within objects.
+ * @returns {Function} A comparison function that can be used with array sorting methods.
+ */
+export declare function compareValues(order?: "asc" | "desc", key?: string): (a: unknown, b: unknown) => 0 | 1 | -1;

package/dist/types/matchers/isEmpty.d.ts

@@ -0,0 +1,38 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Check if a value is empty.
+ * A value is considered empty if it is:
+ * - undefined
+ * - null
+ * - an empty string
+ * - an empty array
+ * - an empty object
+ * - an empty Map or Set
+ * - a boolean, number, or bigint (not empty)
+ * @param val - The value to check.
+ * @returns true if the value is empty, false otherwise.
+ */
+export declare function isEmpty(val: AnyObject): val is undefined;

package/dist/types/matchers/isEqual.d.ts

@@ -0,0 +1,39 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Compare two objects or values for equality.
+ * This function checks if two values are equal, including nested objects and arrays.
+ * It handles various data types such as strings, numbers, booleans, arrays, and objects.
+ * If both values are `null` or `undefined`, they are considered equal.
+ * If both values are primitive types (string, number, boolean), they are compared directly.
+ * If both values are arrays, they are compared element by element.
+ * If both values are objects, they are compared by their keys and values.
+ * If the values are of different types or structures, they are considered not equal.
+ *
+ * @param {unknown} obj - The first value to compare.
+ * @param {unknown} test - The second value to compare against the first.
+ * @returns {boolean} - Returns true if the values are equal, false otherwise.
+ */
+export declare function isEqual(obj: unknown, test: unknown): boolean;