@react-fabric/utilities 1.0.0-beta.0

package/dist/types/_format.d.ts

@@ -0,0 +1,27 @@
+export declare namespace Format {
+    /** ***************** format phone number using `libphonenumber-js` *******************/
+    const phone: (value?: string, country?: string, useCss?: boolean) => string | undefined;
+    /** ***************** format whole number using `numeral` *******************/
+    const number: (number?: string | number, format?: string) => string;
+    /** ***************** format bytes using `numeral` *******************/
+    const bytes: (number?: string | number) => string;
+    /** ***************** format percentage using `numeral` *******************/
+    const percent: (number?: string | number) => string;
+    /** ***************** format date using `date-fns` *******************/
+    const date: (date?: Date | string | number, fmt?: string) => string;
+    /** ***************** format time duration from total seconds/milliseconds *******************/
+    /**
+     * Format time duration with milliseconds
+     * @param number
+     * @param isFraction
+     * @returns
+     */
+    const duration: (number?: string | number, isFraction?: boolean) => string | undefined;
+    /**
+     * Format time duration without milliseconds
+     * @param number
+     * @param isFraction
+     * @returns
+     */
+    const durationSeconds: (number?: string | number, isFraction?: boolean) => string | undefined;
+}

package/dist/types/_getByPath.d.ts

@@ -0,0 +1,10 @@
+/**
+ * get property value by path
+ * @internal
+ */
+export declare const getByPath: <T = any>(obj: KeyValue, path: string, defaultValue?: any) => T;
+/**
+ * get first available value in list
+ * @internal
+ */
+export declare const getValue: (...args: any[]) => any;

package/dist/types/_hash.d.ts

@@ -0,0 +1,16 @@
+/**
+ * calculate hash from string
+ * @param str
+ * @internal
+ */
+export declare const hash: (str: string) => number;
+/**
+ * generate short hash from current time
+ * @internal
+ */
+export declare const shortHash: () => string;
+/**
+ * generate uuid using `crypto.getRandomValues`
+ * @internal
+ */
+export declare const uuid: () => string;

package/dist/types/_interpolate.d.ts

@@ -0,0 +1,6 @@
+/**
+ * interpolate string template using model
+ * @internal
+ */
+export declare const interpolate: (str: string, model: KeyValue) => string;
+export declare const renderTemplate: (str: string, model: KeyValue) => string;

package/dist/types/_isEqual.d.ts

@@ -0,0 +1,15 @@
+/**
+ * check equality of objects
+ * @internal
+ */
+export declare const isEqual: (obj: unknown, test: unknown) => boolean;
+/**
+ * match strings
+ * @internal
+ */
+export declare const matchString: (base: string, match: string, equality?: "start" | boolean) => boolean;
+/**
+ * compare values
+ * @internal
+ */
+export declare const compareValues: (order?: "asc" | "desc", key?: string) => (a: unknown, b: unknown) => 0 | 1 | -1;

package/dist/types/_isType.d.ts

@@ -0,0 +1,14 @@
+export declare const isUndefined: (value: unknown) => value is undefined;
+export declare const isNull: (value: unknown) => value is null;
+export declare const isNil: (val: unknown) => val is undefined;
+export declare const isEmpty: (val: unknown) => val is undefined;
+export declare const isObject: (val: unknown) => val is KeyValue<any>;
+export declare const isArray: <T = unknown>(val: unknown) => val is T[];
+export declare const isString: (value: unknown) => value is string;
+export declare const isNumber: (value: unknown) => value is number;
+export declare const isBoolean: (value: unknown) => value is boolean;
+export declare const isTrue: (value?: unknown) => value is true;
+export declare const isFalse: (value?: unknown) => value is false;
+export declare const isColor: (color: string) => boolean;
+export declare const isSvgPath: (value: unknown) => value is string;
+export declare const isRtl: () => boolean;

package/dist/types/_mergeRefs.d.ts

@@ -0,0 +1 @@
+export declare const mergeRefs: (...refs: AnyObject[]) => (el: AnyObject) => void;

package/dist/types/_tokenize.d.ts

@@ -0,0 +1,8 @@
+/**
+ * split text into array of tokens by word boundaries
+ * @param str
+ * @param keywords
+ * @internal
+ */
+export declare const tokenize: (str: string, keywords?: string | string[]) => string[][];
+export declare const iconToken: (str: string) => string;

package/dist/types/getImageColorset.d.ts

@@ -0,0 +1 @@
+export declare const getImageColorset: (el: HTMLImageElement) => string;

package/dist/types/index.d.ts

@@ -0,0 +1,22 @@
+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";
+export declare const EMPTY_ARRAY: never[];
+export declare const EMPTY_OBJECT: {};

package/dist/types/useLogger.d.ts

@@ -0,0 +1,25 @@
+interface LogDetail {
+    module?: string;
+    process?: string;
+    duration?: number;
+    totalTime?: number;
+}
+/**
+ * @internal
+ */
+export declare const useLogger: (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, { module, ...opts }: LogDetail, ...rest: unknown[]): void;
+    debug(msg: string, { module, ...opts }: LogDetail, ...rest: unknown[]): void;
+    info(msg: string, { module, ...opts }: LogDetail, ...rest: unknown[]): void;
+    error(msg: string, { module, ...opts }: LogDetail, ...rest: unknown[]): void;
+    warning(msg: string, { module, ...opts }: LogDetail, ...rest: unknown[]): void;
+};
+export {};

package/dist/types/yup.d.ts

@@ -0,0 +1 @@
+export * as yup from "yup";

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@react-fabric/utilities",
+  "version": "1.0.0-beta.0",
+  "description": "RUF: Utility package",
+  "author": "Adarsh Pastakia <adarshpastakia@outlook.com>",
+  "license": "MIT",
+  "source": "src/index.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "directories": {
+    "src": "src",
+    "test": "tests"
+  },
+  "files": [
+    "src",
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "makelink": "yarn link",
+    "removelink": "yarn unlink",
+    "prebuild": "rm -rf ./dist",
+    "build:dts": "tsc -p ./tsconfig.build.json",
+    "build:rollup": "rollup -c ../../rollup.config.mjs",
+    "build": "npm-run-all -p build:rollup build:dts",
+    "watch:dts": "tsc -w -p ./tsconfig.build.json",
+    "watch:rollup": "rollup -w -c ../../rollup.config.mjs",
+    "watch": "npm-run-all -p watch:rollup watch:dts"
+  },
+  "dependencies": {
+    "date-fns": "^4.0.0",
+    "libphonenumber-js": "^1.11.8",
+    "numeral": "^2.0.6",
+    "yup": "^1.4.0"
+  },
+  "devDependencies": {
+    "@types/numeral": "^2.0.2"
+  },
+  "engines": {
+    "node": ">=18.12.0",
+    "npm": ">=8.19.0"
+  },
+  "gitHead": "83fa79064b1d57e71149005432192d506810bbda"
+}

package/src/_ascii.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 */
+
+import { isEmpty } from "./_isType";
+
+/** ***************** latin-ascii conversions *******************/
+const 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: "ƒ",
+};
+
+/**
+ * latin to ascii converter for convenient searching
+ * @internal
+ */
+export const ascii = (str: string) => {
+  if (isEmpty(str)) return "";
+  Object.entries(conversions).forEach(([a, l]) => {
+    const re = new RegExp(l, "g");
+    str = `${str}`.replace(re, a);
+  });
+  return str;
+};

package/src/_boundingBox.ts

@@ -0,0 +1,72 @@
+/*
+ * 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";
+
+const _getBox = (
+  box: string | [number, number, number, number],
+): [number, number, number, number] => {
+  let boundingBox: any = box;
+  if (isEmpty(box)) return [0, 0, 0, 0];
+  if (typeof box === "string") {
+    boundingBox = box.split(",");
+  }
+  if (Array.isArray(boundingBox)) {
+    boundingBox = boundingBox.map((b) => parseInt(b, 10));
+  }
+  return boundingBox;
+};
+
+/**
+ * box "x,y,w,h" | [x,y,w,h]
+ * returns canvas box [x,y,w,h]
+ */
+export const getBox = (
+  box: string | [number, number, number, number] = "0,0,0,0",
+) => {
+  const boundingBox = _getBox(box);
+
+  let [x, y, w, h] = boundingBox;
+  w = x < 0 ? w + x : w;
+  h = y < 0 ? h + y : h;
+  x = x > 0 ? x : 0;
+  y = y > 0 ? y : 0;
+  return [x, y, w, h] as [number, number, number, number];
+};
+
+/**
+ * box "x1,y1,x2,y2" | [x1,y1,x2,y2]
+ * returns canvas box [x,y,w,h]
+ */
+export const getBoundingBox = (
+  box: string | [number, number, number, number] = "0,0,0,0",
+) => {
+  const boundingBox = _getBox(box);
+
+  let [x1, y1, x2, y2] = boundingBox;
+  const w = x2 - x1;
+  const h = y2 - y1;
+  x1 = x1 > 0 ? x1 : 0;
+  y1 = y1 > 0 ? y1 : 0;
+  return [x1, y1, w, h] as [number, number, number, number];
+};