@react-fabric/utilities 1.0.0-beta.0

package/src/_format.ts

@@ -0,0 +1,141 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 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.
+ */
+
+import { differenceInDays, format, parseISO } from "date-fns";
+import {
+  parsePhoneNumberFromString,
+  type CountryCode,
+} from "libphonenumber-js";
+import numeral from "numeral";
+import Countries from "./_countries";
+import { isEmpty, isNil } from "./_isType";
+
+// eslint-disable-next-line @typescript-eslint/no-namespace
+export namespace Format {
+  /** ***************** get phone number object using `libphonenumber-js` *******************/
+  const getPhone = (value: string, country: string) => {
+    const phone =
+      value.match(/^[0+]/) != null ? value.replace(/^00/, "+") : `+${value}`;
+    const number = parsePhoneNumberFromString(phone, country as CountryCode);
+    /* istanbul ignore next */
+    return (
+      number ?? {
+        country: "",
+        formatInternational: () => value,
+      }
+    );
+  };
+
+  /** ***************** common number format method using `numeral` *******************/
+  const numberFormat = (number?: string | number, format = "0,0[.]00a") => {
+    if (isNil(number)) {
+      return "";
+    }
+    const prefix = `${number}`.startsWith("+") ? "+" : "";
+    return prefix + numeral(number).format(format);
+  };
+
+  const makeDuration = (value: number, fmt = "HH:mm:ss.SSS") => {
+    if (!isNaN(value)) {
+      const days = differenceInDays(value, 0);
+      const prefix = days > 0 ? `${days}d:` : "";
+      let time = format(
+        parseISO(new Date(value).toISOString().replace("Z", "")),
+        fmt,
+      );
+      if (!prefix) time = time.replace(/^00:/, "");
+      return `${prefix}${time}`;
+    }
+  };
+
+  /** ***************** format phone number using `libphonenumber-js` *******************/
+  export const phone = (value?: string, country = "AE", useCss = false) => {
+    if (isEmpty(value) || value.length < 6 || !/^[\d+\s\-()]+$/.test(value))
+      return value;
+    const phone = getPhone(value, country);
+    /* istanbul ignore next */
+    return `${
+      useCss
+        ? `<span class="flag ${phone.country}"></span>`
+        : Countries.emoji(phone.country ?? "")
+    } ${phone.formatInternational()}`;
+  };
+  /** ***************** format whole number using `numeral` *******************/
+  export const number = (number?: string | number, format?: string) => {
+    return numberFormat(number, format);
+  };
+  /** ***************** format bytes using `numeral` *******************/
+  export const bytes = (number?: string | number) => {
+    return numberFormat(number, "0,0[.]00b");
+  };
+  /** ***************** format percentage using `numeral` *******************/
+  export const percent = (number?: string | number) => {
+    return numberFormat(number, "0,0[.]00%");
+  };
+  /** ***************** format date using `date-fns` *******************/
+  export const date = (date?: Date | string | number, fmt = "d-M-y") => {
+    return date ? format(new Date(date), fmt) : "";
+  };
+  /** ***************** format time duration from total seconds/milliseconds *******************/
+  /**
+   * Format time duration with milliseconds
+   * @param number
+   * @param isFraction
+   * @returns
+   */
+  export const duration = (number?: string | number, isFraction?: boolean) => {
+    if (isNil(number)) {
+      return "00:00.000";
+    }
+    if (number === Infinity) {
+      return "∞";
+    }
+    const value = parseFloat(`${number}`) * (isFraction ? 1000 : 1);
+    if (!isNaN(value)) {
+      return makeDuration(value);
+    }
+    return "00:00.000";
+  };
+  /**
+   * Format time duration without milliseconds
+   * @param number
+   * @param isFraction
+   * @returns
+   */
+  export const durationSeconds = (
+    number?: string | number,
+    isFraction?: boolean,
+  ) => {
+    if (isNil(number)) {
+      return "00:00";
+    }
+    if (number === Infinity) {
+      return "∞";
+    }
+    const value = parseFloat(`${number}`) * (isFraction ? 1000 : 1);
+    if (!isNaN(value)) {
+      return makeDuration(value, "HH:mm:ss");
+    }
+    return "00:00";
+  };
+}

package/src/_getByPath.ts

@@ -0,0 +1,108 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 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.
+ */
+
+import { isArray, isEmpty, isNil, isObject } from "./_isType";
+
+const _get = (hit: any, field: string): any => {
+  /** ***************** return if object is empty *******************/
+  /* istanbul ignore next */
+  if (isNil(hit)) {
+    return undefined;
+  }
+  /** ***************** return object if property is empty *******************/
+  /* istanbul ignore next */
+  if (isNil(field)) {
+    return hit;
+  }
+
+  if (isObject(hit)) {
+    /** ***************** return value if object.property is not empty *******************/
+    if (!isNil(hit[field])) {
+      return hit[field];
+    }
+
+    /** ***************** if property name contains `.` separator split to multiple property names *******************/
+    if (field.includes(".")) {
+      let currentValue: any = hit;
+
+      const path = field.split(".");
+      for (let i = path.length - 1; i >= 0; i--) {
+        /** ***************** when property name is `a.b.c` iterate until property found in object. eg. `a`, `a.b` *******************/
+        const outerPath = path.slice(0, i as any).join(".");
+
+        /** ***************** join rest of property list *******************/
+        const innerPath = path.slice(i as any).join(".");
+
+        /** ***************** if current outer path found in object *******************/
+        if (outerPath in currentValue) {
+          currentValue = currentValue[outerPath];
+
+          /** ***************** check for type array *******************/
+          if (isArray(currentValue)) {
+            /** ***************** return value if remaining path found *******************/
+            if (currentValue[innerPath as any]) {
+              return currentValue[innerPath as any];
+            }
+            /** ***************** return array map of inner propeties *******************/
+            return currentValue
+              .map((val) => _get(val, innerPath))
+              .filter((val) => !isEmpty(val));
+          } else {
+            /** ***************** return value of remaining path *******************/
+            return _get(currentValue, innerPath);
+          }
+        }
+      }
+    }
+  }
+
+  return undefined;
+};
+
+/**
+ * get property value by path
+ * @internal
+ */
+export const getByPath = <T = any>(
+  obj: KeyValue,
+  path: string,
+  defaultValue: any = undefined,
+): T => {
+  /** ***************** if empty object/path return defaultValue *******************/
+  if (isEmpty(obj) || isEmpty(path)) {
+    return defaultValue;
+  }
+  const value = _get(obj, path);
+  if (!isNil(value)) {
+    return value;
+  }
+  return defaultValue;
+};
+
+/**
+ * get first available value in list
+ * @internal
+ */
+export const getValue = (...args: any[]) => {
+  return args.find((a) => !isEmpty(a));
+};

package/src/_hash.ts

@@ -0,0 +1,62 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 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.
+ */
+
+import { isEmpty } from "./_isType";
+
+/**
+ * calculate hash from string
+ * @param str
+ * @internal
+ */
+export const hash = (str: string) => {
+  let hash = 0;
+  let i;
+  let chr;
+  if (isEmpty(str)) return hash;
+  for (i = 0; i < str.length; i++) {
+    chr = str.charCodeAt(i);
+    hash = (hash << 5) - hash + chr;
+    hash |= 0; // Convert to 32bit integer
+  }
+  return hash;
+};
+
+/**
+ * generate short hash from current time
+ * @internal
+ */
+export const shortHash = () => {
+  return (new Date().getTime() + Math.trunc(Math.random() * 1000)).toString(36);
+};
+
+/**
+ * generate uuid using `crypto.getRandomValues`
+ * @internal
+ */
+export const uuid = () => {
+  return [1e7, 1e3, 4e3, 8e3, 1e11]
+    .join("-")
+    .replace(/[018]/g, (c: string) =>
+      (+c ^ ((Math.random() * 16) & (15 >> (+c / 4)))).toString(16),
+    );
+};

package/src/_interpolate.ts

@@ -0,0 +1,42 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 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.
+ */
+
+import { getByPath } from "./_getByPath";
+
+/**
+ * interpolate string template using model
+ * @internal
+ */
+export const interpolate = (str: string, model: KeyValue) => {
+  return str.replace(/\${([^{}]*)}/g, (a: string, b: string): string => {
+    const r = getByPath(model, b);
+    return typeof r === "string" || typeof r === "number" ? `${r}` : "";
+  });
+};
+
+export const renderTemplate = (str: string, model: KeyValue) => {
+  return str.replace(/{{([^{}]*)}}/g, (a: string, b: string): string => {
+    const r = getByPath(model, b);
+    return typeof r === "string" || typeof r === "number" ? `${r}` : "";
+  });
+};

package/src/_isEqual.ts

@@ -0,0 +1,102 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 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.
+ */
+
+import { ascii } from "./_ascii";
+import { isBoolean, isNumber, isObject, isString } from "./_isType";
+
+/**
+ * check equality of objects
+ * @internal
+ */
+export const isEqual = (obj: unknown, test: unknown): boolean => {
+  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((o, i) => !isEqual(o, test[i]));
+  } else if (isObject(obj) && isObject(test)) {
+    const okeys = Object.keys(obj);
+    const 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((k) => !tkeys.includes(k))) {
+      return false;
+    }
+    // check if some value is false
+    return !Object.keys(obj).some((k) => !isEqual(obj[k], test[k]));
+  }
+  return false;
+};
+
+/**
+ * match strings
+ * @internal
+ */
+export const matchString = (
+  base: string,
+  match: string,
+  equality: "start" | boolean = false,
+) => {
+  const _base = ascii(base).toLowerCase();
+  const _match = ascii(match).toLowerCase();
+
+  return equality === true
+    ? _base === _match
+    : equality === "start"
+      ? _base.startsWith(_match)
+      : _base.includes(_match);
+};
+
+/**
+ * compare values
+ * @internal
+ */
+export const compareValues =
+  (order: "asc" | "desc" = "asc", key?: string) =>
+  (a: unknown, b: unknown) => {
+    const aValue: string = key && isObject(a) ? a[key] : a;
+    const bValue: string = key && isObject(b) ? b[key] : b;
+
+    const bigger = order === "asc" ? 1 : -1;
+    const 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;
+    }
+    const _a = ascii(aValue).toLowerCase();
+    const _b = ascii(bValue).toLowerCase();
+    return _a.localeCompare(_b) === 1 ? bigger : smaller;
+  };

package/src/_isType.ts

@@ -0,0 +1,105 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 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 const isUndefined = (value: unknown): value is undefined => {
+  return value === undefined;
+};
+
+export const isNull = (value: unknown): value is null => {
+  return value === null;
+};
+
+export const isNil = (val: unknown): val is undefined => {
+  return val === undefined || val === null;
+};
+export const isEmpty = (val: unknown): val is undefined => {
+  if (val instanceof Date) return false;
+  if (isNil(val) || val === "") {
+    return true;
+  }
+  if (Array.isArray(val) && val.filter(Boolean).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 const isObject = (val: unknown): val is KeyValue => {
+  return (
+    !isNil(val) &&
+    !(val instanceof Date) &&
+    typeof val === "object" &&
+    !Array.isArray(val)
+  );
+};
+export const isArray = <T = unknown>(val: unknown): val is T[] => {
+  return Array.isArray(val);
+};
+
+export const isString = (value: unknown): value is string => {
+  return typeof value === "string";
+};
+
+export const isNumber = (value: unknown): value is number => {
+  return typeof value === "number";
+};
+
+export const isBoolean = (value: unknown): value is boolean => {
+  return typeof value === "boolean";
+};
+export const isTrue = (value: unknown = ""): value is true => {
+  return (
+    value === true ||
+    value === 1 ||
+    value?.toString().toLowerCase() === "yes" ||
+    value?.toString().toLowerCase() === "true"
+  );
+};
+export const isFalse = (value: unknown = ""): value is false => {
+  return (
+    value === false ||
+    value === 0 ||
+    value?.toString().toLowerCase() === "no" ||
+    value?.toString().toLowerCase() === "false"
+  );
+};
+
+export const isColor = (color: string) =>
+  color.startsWith?.("#") ||
+  color.startsWith?.("rgb") ||
+  color.startsWith?.("hsl") ||
+  color.startsWith?.("lab") ||
+  color === "transparent";
+
+export const isSvgPath = (value: unknown): value is string => {
+  return (
+    typeof value === "string" && value.match(/^[Mm][\d.].*[\dzZ]$/) !== null
+  );
+};
+
+export const isRtl = () => {
+  return getComputedStyle(document.documentElement).direction === "rtl";
+};

package/src/_mergeRefs.ts

@@ -0,0 +1,33 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 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 */
+
+export const mergeRefs =
+  (...refs: AnyObject[]) =>
+  (el: AnyObject) => {
+    refs.forEach((ref) => {
+      if (typeof ref === "function") ref(el);
+      if (ref && "current" in ref) ref.current = el;
+    });
+  };

package/src/_tokenize.ts

@@ -0,0 +1,69 @@
+/*
+ * React Fabric
+ * @version: 1.0.0
+ *
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 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.
+ */
+
+import { isArray, isEmpty } from "./_isType";
+
+/**
+ * split text into array of tokens by word boundaries
+ * @param str
+ * @param keywords
+ * @internal
+ */
+export const tokenize = (str: string, keywords?: string | string[]) => {
+  if (isEmpty(keywords)) {
+    return [[str, ""]];
+  }
+  const keys = isArray(keywords) ? keywords : [keywords];
+  const keyMap = keys.map((key) => {
+    // escape regex control characters
+    let escapedKey = key.replace(/([+*.?^$()[\]\\!&|\-=])/gm, "\\$1");
+    // place token within word boundaries if start/end with alpha-numeric
+    if (key.match(/^[a-z0-9]/i) != null) escapedKey = `\\b${escapedKey}`;
+    if (key.match(/[a-z0-9]$/i) != null) escapedKey = `${escapedKey}\\b`;
+    return escapedKey;
+  });
+  const regx = new RegExp(`(${keyMap.join("|")})`, "img");
+  let match;
+  let lastIndex = 0;
+  const tokens = [];
+  while ((match = regx.exec(str)) !== null) {
+    tokens.push([
+      str.substring(lastIndex, match.index),
+      str.substring(match.index, regx.lastIndex),
+    ]);
+    lastIndex = regx.lastIndex;
+  }
+  tokens.push([str.substring(lastIndex), ""]);
+  return tokens;
+};
+
+export const iconToken = (str: string) => {
+  const split = str.trim().split(" ");
+  const first = split[0];
+  const last = split.length > 1 && split.pop();
+  return (
+    first && last
+      ? `${first.charAt(0)}${last.charAt(0)}`
+      : `${first.substring(0, 2)}`
+  ).toUpperCase();
+};