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

package/dist/esm/{_getByPath.js → lists/getByPath.js}

@@ -1,31 +1,41 @@
 'use client';
 
-import { isEmpty, isNil, isObject, isArray } from './_isType.js';
+import { isEmpty } from '../matchers/isEmpty.js';
+import { isNil } from '../matchers/nullChecks.js';
+import { isObject, isArray } from '../matchers/typeChecks.js';
 
-/*
+/**
  * React Fabric
- * @version: 1.0.0
- *
- *
- * The MIT License (MIT)
- * Copyright (c) 2024 Adarsh Pastakia
+ * @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:
+ * 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 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.
+ * 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.
  */
 
-var _get = function _get(hit, field) {
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+
+function _get(hit, field) {
   /** ***************** return if object is empty *******************/
   /* istanbul ignore next */
   if (isNil(hit)) {
@@ -36,7 +46,7 @@ var _get = function _get(hit, field) {
   if (isNil(field)) {
     return hit;
   }
-  if (isObject(hit)) {
+  if (isObject(hit) || isArray(hit)) {
     /** ***************** return value if object.property is not empty *******************/
     if (!isNil(hit[field])) {
       return hit[field];
@@ -89,13 +99,19 @@ var _get = function _get(hit, field) {
     }
   }
   return undefined;
-};
+}
 
 /**
- * get property value by path
- * @internal
+ * 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.
  */
-var getByPath = function getByPath(obj, path) {
+function getByPath(obj, path) {
   var defaultValue = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
   /** ***************** if empty object/path return defaultValue *******************/
   if (isEmpty(obj) || isEmpty(path)) {
@@ -106,19 +122,24 @@ var getByPath = function getByPath(obj, path) {
     return value;
   }
   return defaultValue;
-};
+}
 
 /**
- * get first available value in list
- * @internal
+ * 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.
  */
-var getValue = function getValue() {
+function getValue() {
   for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
     args[_key] = arguments[_key];
   }
   return args.find(function (a) {
     return !isEmpty(a);
   });
-};
+}
 
 export { getByPath, getValue };

package/dist/esm/lists/groupBy.js

@@ -0,0 +1,49 @@
+'use client';
+
+/**
+ * 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.
+ */
+function groupBy(list, prop, missingKey) {
+  return list.reduce(function (r, i) {
+    var _ref;
+    var key = (_ref = i[prop]) !== null && _ref !== void 0 ? _ref : missingKey;
+    if (!r[key]) r[key] = [];
+    r[key].push(i);
+    return r;
+  }, {});
+}
+
+export { groupBy };

package/dist/esm/matchers/compare.js

@@ -0,0 +1,70 @@
+'use client';
+
+import { getByPath } from '../lists/getByPath.js';
+import { ascii } from '../strings/ascii.js';
+import { isObject, isNumber, isBoolean } from './typeChecks.js';
+
+/**
+ * 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.
+ */
+function compareValues() {
+  var order = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "asc";
+  var key = arguments.length > 1 ? arguments[1] : undefined;
+  return function (a, b) {
+    var aValue = key && isObject(a) ? getByPath(a, key, "") : a;
+    var bValue = key && isObject(b) ? getByPath(b, key, "") : b;
+    var bigger = order === "asc" ? 1 : -1;
+    var smaller = order === "desc" ? 1 : -1;
+    // return 0 when equal, allowing for multiple sorting properties
+    if (aValue === bValue) return 0;
+    // if numbers check greater
+    if (isNumber(aValue) && isNumber(bValue)) {
+      return aValue > bValue ? bigger : smaller;
+    }
+    // if boolean sort true first
+    if (isBoolean(aValue) && isBoolean(bValue)) {
+      return aValue ? smaller : bigger;
+    }
+    var _a = ascii(aValue).toLowerCase();
+    var _b = ascii(bValue).toLowerCase();
+    return _a.localeCompare(_b) === 1 ? bigger : smaller;
+  };
+}
+
+export { compareValues };

package/dist/esm/matchers/isEmpty.js

@@ -0,0 +1,34 @@
+'use client';
+
+import _typeof from '@babel/runtime/helpers/typeof';
+import { isNil, isDefined } from './nullChecks.js';
+
+/**
+ * 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.
+ */
+function isEmpty(val) {
+  if (val instanceof Date) return false;
+  if (isNil(val) || val === "") {
+    return true;
+  }
+  if (Array.isArray(val) && val.filter(isDefined).length === 0) {
+    return true;
+  }
+  if (val instanceof Map || val instanceof Set) return val.size === 0;
+  if (["boolean", "number", "bigint", "function"].includes(_typeof(val))) {
+    return false;
+  }
+  return !!val && _typeof(val) === "object" && Object.entries(val).length === 0;
+}
+
+export { isEmpty };

package/dist/esm/matchers/isEqual.js

@@ -0,0 +1,82 @@
+'use client';
+
+import { isNil } from './nullChecks.js';
+import { isString, isNumber, isBoolean, isObject } from './typeChecks.js';
+
+/**
+ * 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.
+ */
+function isEqual(obj, test) {
+  if (isNil(obj) && isNil(test)) {
+    return true;
+  }
+  if (isString(obj) || isNumber(obj) || isBoolean(obj)) {
+    return obj === test;
+  } else if (Array.isArray(obj) && Array.isArray(test)) {
+    // if length dont match return false
+    if (obj.length !== test.length) {
+      return false;
+    }
+    // check if some value is false
+    return !obj.some(function (o, i) {
+      return !isEqual(o, test[i]);
+    });
+  } else if (isObject(obj) && isObject(test)) {
+    var okeys = Object.keys(obj);
+    var tkeys = Object.keys(test);
+    // if keys length dont match return false
+    if (okeys.length !== tkeys.length) {
+      return false;
+    }
+    // if keys dont match return false
+    if (okeys.some(function (k) {
+      return !tkeys.includes(k);
+    })) {
+      return false;
+    }
+    // check if some value is false
+    return !Object.keys(obj).some(function (k) {
+      return !isEqual(obj[k], test[k]);
+    });
+  }
+  return false;
+}
+
+export { isEqual };

package/dist/esm/matchers/nullChecks.js

@@ -0,0 +1,58 @@
+'use client';
+
+/**
+ * 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 undefined.
+ * @param value - The value to check.
+ * @returns true if the value is undefined, false otherwise.
+ */
+function isUndefined(value) {
+  return value === undefined;
+}
+
+/**
+ * Check if a value is null.
+ * @param value - The value to check.
+ * @returns true if the value is null, false otherwise.
+ */
+function isNull(value) {
+  return value === null;
+}
+
+/**
+ * Check if a value is either null or undefined.
+ * @param val - The value to check.
+ * @returns true if the value is null or undefined, false otherwise.
+ */
+function isNil(val) {
+  return val === undefined || val === null;
+}
+function isDefined(val) {
+  return !isNil(val) && val !== "";
+}
+
+export { isDefined, isNil, isNull, isUndefined };

package/dist/esm/matchers/typeChecks.js

@@ -0,0 +1,119 @@
+'use client';
+
+import _typeof from '@babel/runtime/helpers/typeof';
+import { isNil } from './nullChecks.js';
+
+/**
+ * Check if a value is an object.
+ * An object is considered valid if it is:
+ * - not null or undefined
+ * - not a Date instance
+ * - of type 'object'
+ * - not an array
+ * @param val - The value to check.
+ * @returns true if the value is an object, false otherwise.
+ */
+function isObject(val) {
+  return !isNil(val) && !(val instanceof Date) && _typeof(val) === "object" && !Array.isArray(val);
+}
+
+/**
+ * Check if a value is an array.
+ * An array is considered valid if it is:
+ * - not null or undefined
+ * - an instance of Array
+ * @param val - The value to check.
+ * @returns true if the value is an array, false otherwise.
+ */
+function isArray(val) {
+  return Array.isArray(val);
+}
+
+/**
+ * Check if a value is a string.
+ * A string is considered valid if it is:
+ * - not null or undefined
+ * - of type 'string'
+ * @param value - The value to check.
+ * @returns true if the value is a string, false otherwise.
+ */
+function isString(value) {
+  return typeof value === "string";
+}
+
+/**
+ * Check if a value is a number.
+ * A number is considered valid if it is:
+ * - not null or undefined
+ * - of type 'number'
+ * @param value - The value to check.
+ * @returns true if the value is a number, false otherwise.
+ */
+function isNumber(value) {
+  return typeof value === "number";
+}
+
+/**
+ * Check if a value is a boolean.
+ * A boolean is considered valid if it is:
+ * - not null or undefined
+ * - of type 'boolean'
+ */
+function isBoolean(value) {
+  return typeof value === "boolean";
+}
+
+/**
+ * Check if a value is a true.
+ * A value is considered true if it is:
+ * - strictly equal to true
+ * - equal to 1
+ * - a string that is "yes" or "true" (case insensitive)
+ */
+function isTrue() {
+  var value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "";
+  return value === true || value === 1 || (value === null || value === void 0 ? void 0 : value.toString().toLowerCase()) === "yes" || (value === null || value === void 0 ? void 0 : value.toString().toLowerCase()) === "true";
+}
+
+/**
+ * Check if a value is false.
+ * A value is considered false if it is:
+ * - strictly equal to false
+ * - equal to 0
+ * - a string that is "no" or "false" (case insensitive)
+ */
+function isFalse() {
+  var value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "";
+  return value === false || value === 0 || (value === null || value === void 0 ? void 0 : value.toString().toLowerCase()) === "no" || (value === null || value === void 0 ? void 0 : value.toString().toLowerCase()) === "false";
+}
+
+/**
+ * Check if a value is a valid color.
+ * A color is considered valid if it:
+ * - starts with a '#' (hex color)
+ * - starts with 'rgb' (RGB color)
+ * - starts with 'hsl' (HSL color)
+ * - starts with 'lab' (Lab color)
+ * - is equal to 'transparent'
+ * @param color - The value to check.
+ * @returns true if the value is a valid color, false otherwise.
+ */
+function isColor(color) {
+  var _color$startsWith, _color$startsWith2, _color$startsWith3, _color$startsWith4;
+  return ((_color$startsWith = color.startsWith) === null || _color$startsWith === void 0 ? void 0 : _color$startsWith.call(color, "#")) || ((_color$startsWith2 = color.startsWith) === null || _color$startsWith2 === void 0 ? void 0 : _color$startsWith2.call(color, "rgb")) || ((_color$startsWith3 = color.startsWith) === null || _color$startsWith3 === void 0 ? void 0 : _color$startsWith3.call(color, "hsl")) || ((_color$startsWith4 = color.startsWith) === null || _color$startsWith4 === void 0 ? void 0 : _color$startsWith4.call(color, "lab")) || color === "transparent";
+}
+
+/**
+ * Check if a value is a valid SVG path.
+ * A valid SVG path is a string that:
+ * - starts with 'M' or 'm' (move to command)
+ * - contains at least one digit or decimal point
+ * - ends with 'Z' or 'z' (close path command)
+ * @param value - The value to check.
+ * @returns true if the value is a valid SVG path, false otherwise.
+ */
+function isSvgPath(value) {
+  return typeof value === "string" && value.match(/^[Mm][\d.].*[\dzZ]$/) !== null;
+}
+
+export { isArray, isBoolean, isColor, isFalse, isNumber, isObject, isString, isSvgPath, isTrue };

package/dist/esm/strings/ascii.js

@@ -0,0 +1,105 @@
+'use client';
+
+import { isEmpty } from '../matchers/isEmpty.js';
+
+/**
+ * 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.
+ */
+
+
+/* istanbul ignore file */
+
+/** ***************** latin-ascii conversions *******************/
+var conversions = {
+  AE: "Æ|Ǽ",
+  Ae: "Ä",
+  ae: "ä|æ|ǽ",
+  OE: "Œ",
+  Oe: "Ö",
+  oe: "ö|œ",
+  Ue: "Ü",
+  ue: "ü",
+  IJ: "IJ",
+  ij: "ij",
+  ss: "ß",
+  A: "À|Á|Â|Ã|Ä|Å|Ǻ|Ā|Ă|Ą|Ǎ",
+  a: "à|á|â|ã|å|ǻ|ā|ă|ą|ǎ|ª",
+  C: "Ç|Ć|Ĉ|Ċ|Č",
+  c: "ç|ć|ĉ|ċ|č",
+  D: "Ð|Ď|Đ",
+  d: "ð|ď|đ",
+  E: "È|É|Ê|Ë|Ē|Ĕ|Ė|Ę|Ě",
+  e: "è|é|ê|ë|ē|ĕ|ė|ę|ě",
+  G: "Ĝ|Ğ|Ġ|Ģ",
+  g: "ĝ|ğ|ġ|ģ",
+  H: "Ĥ|Ħ",
+  h: "ĥ|ħ",
+  I: "Ì|Í|Î|Ï|Ĩ|Ī|Ĭ|Ǐ|Į|İ",
+  i: "ì|í|î|ï|ĩ|ī|ĭ|ǐ|į|ı",
+  J: "Ĵ",
+  j: "ĵ",
+  K: "Ķ",
+  k: "ķ",
+  L: "Ĺ|Ļ|Ľ|Ŀ|Ł",
+  l: "ĺ|ļ|ľ|ŀ|ł",
+  N: "Ñ|Ń|Ņ|Ň",
+  n: "ñ|ń|ņ|ň|ʼn",
+  O: "Ò|Ó|Ô|Õ|Ō|Ŏ|Ǒ|Ő|Ơ|Ø|Ǿ",
+  o: "ò|ó|ô|õ|ō|ŏ|ǒ|ő|ơ|ø|ǿ|º",
+  R: "Ŕ|Ŗ|Ř",
+  r: "ŕ|ŗ|ř",
+  S: "Ś|Ŝ|Ş|Š",
+  s: "ś|ŝ|ş|š|ſ",
+  T: "Ţ|Ť|Ŧ",
+  t: "ţ|ť|ŧ",
+  U: "Ù|Ú|Û|Ũ|Ū|Ŭ|Ů|Ű|Ų|Ư|Ǔ|Ǖ|Ǘ|Ǚ|Ǜ",
+  u: "ù|ú|û|ũ|ū|ŭ|ů|ű|ų|ư|ǔ|ǖ|ǘ|ǚ|ǜ",
+  Y: "Ý|Ÿ|Ŷ",
+  y: "ý|ÿ|ŷ",
+  W: "Ŵ",
+  w: "ŵ",
+  Z: "Ź|Ż|Ž",
+  z: "ź|ż|ž",
+  f: "ƒ"
+};
+
+/**
+ * Converts a string to its ASCII representation by replacing
+ * special characters with their ASCII equivalents.
+ * This function is useful for normalizing strings for search or display purposes.
+ * It replaces characters like "Ä" with "Ae", "ß" with "ss", etc.
+ *
+ * @param {string} str - The input string to be converted.
+ * @returns {string} - The ASCII representation of the input string.
+ */
+function ascii(str) {
+  if (isEmpty(str)) return "";
+  Object.entries(conversions).forEach(function (entry) {
+    var re = new RegExp(entry[1], "g");
+    str = "".concat(str).replace(re, entry[0]);
+  });
+  return str;
+}
+
+export { ascii };