@react-pakistan/util-functions 1.25.89 → 2.0.0

package/README.md

@@ -1,348 +1,107 @@
-# 📌 React Pakistan 🔥🔥🔥
+# React Pakistan — Util Functions
 
-<div>
-  <a
-    href="https://react-pakistan.github.io/react-pakistan-docs/"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Pakistan Documentation"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1565548545/GitHub/React_Pakistan_Storybook_Logo.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://react-pakistan.github.io/react-pakistan-docs/"
-    target="_blank"
-  >
-    <img
-      alt="Taimoor Khan - React Commons Collection Author"
-      src="https://avatars1.githubusercontent.com/u/27800340?s=460&v=4"
-      width="20%"
-    />
-  </a>
-</div>
+React Pakistan is an open-source platform creating React software solutions for the global community.
 
-React Pakistan is an OpenSource & Free Software (FOSS) platform, creating React software solutions for the global community. ⭐⭐⭐
+A central library of utility functions, hooks, constants, and factories for the React Pakistan ecosystem.
 
-## 📌 Util Functions ✌
+## Table of Contents
 
-A central place to declare all React Web util functions for ReactPakistan eco-system.
+- [Tech Stack](#tech-stack)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Tests](#tests)
+- [Ecosystem](#ecosystem)
+- [Contributors](#contributors)
+- [Support](#support)
 
-### 📌 Table of Contents 🚀
+## Tech Stack
 
-- [Technology Stack](#-technology-stack-) ✨
-- [Installation](#-installation-) ✨
-- [Tested](#-tested-) ✨
-- [Contributors](#-contributors-) ✨
-- [Other Libraries from ReactPakistan](#-other-libraries-from-reactpakistan-) ✨
-- [Support](#-support-) ✨
-- [Contact](#-contact-) ✨
-- [Buy Me Coffee](#-buy-me-coffee-) ✨
+React · TypeScript · Styled Components · Vitest · ESLint
 
-### 📌 Technology Stack 🚀
+## Installation
 
-- [React](https://reactjs.org/) ✨
-- [TypeScript](https://www.typescriptlang.org/) ✨
-- [JavaScript](https://javascript.info/) ✨
-- [Styled Components](https://styled-components.com/) ✨
-- [Jest](https://jestjs.io/) ✨
-- [Eslint](https://eslint.org/) ✨
-
-### 📌 Installation 🚀
-
-- Clone the repo
-- Cd into the project folder
-- Figure out which package manager you have on your system, then run following commands for their specific use cases.
-
-```console
-  // to install dependencies
-  yarn
-  // to start local dev server
-  yarn start
-  // to run all tests locally
-  yarn test
+```sh
+yarn add @react-pakistan/util-functions
+# or
+npm install @react-pakistan/util-functions
 ```
 
-OR
+### Development
 
-```console
-  // cd to website directory
-  cd website
-  // to install dependencies
-  npm install
-  // to start local dev server
-  npm start
-  // to run all tests locally
-  npm test
+```sh
+git clone <repo-url>
+cd util-functions
+yarn
+yarn test        # run all tests
+yarn test:watch  # watch mode
+yarn build       # build the library
 ```
 
-### 📌 Tested 🚀
-
-We aim to achieve 100% coverage and we shall...
+## Usage
 
-![Util Functions Badge Branches](https://util-functions.surge.sh//badge-branches.svg)
-![Util Functions Badge Functions](https://util-functions.surge.sh//badge-functions.svg)
-![Util Functions Badge Lines](https://util-functions.surge.sh//badge-lines.svg)
-![Util Functions Badge Statements](https://util-functions.surge.sh//badge-statements.svg)
+> This package has **no barrel exports**. Import functions directly from their file paths.
 
-Should you like this project and would like to see more coming in future, please consider giving a ⭐ on Github project repo.
+```ts
+// General utilities
+import { slugify } from '@react-pakistan/util-functions/general/slugify';
+import { validateEmail } from '@react-pakistan/util-functions/general/validate-email';
+import { formatDate } from '@react-pakistan/util-functions/general/format-date';
 
-### 📌 Contributors 🚀
+// Hooks
+import { useDebounce } from '@react-pakistan/util-functions/hooks/use-debounce';
+import { useRTL } from '@react-pakistan/util-functions/hooks/use-rtl';
 
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+// Constants
+import { API_METHODS } from '@react-pakistan/util-functions/constants/api-methods';
+import { COUNTRIES_TIMEZONES } from '@react-pakistan/util-functions/constants/countries-timezones';
 
-| Contributors                                                              |                         GitHub                          |    Emoji     |
-| ------------------------------------------------------------------------- | :-----------------------------------------------------: | :----------: |
-| <img src="https://avatars0.githubusercontent.com/u/27800340?s=150&v=4" /> | <a href="https://github.com/taimoormk">Taimoor Khan</a> | 🎨🤔🚧📆👀⚠️ |
+// Local storage
+import { getStorageValue } from '@react-pakistan/util-functions/local-storage/get-storage-value';
 
-### 📌 Other Libraries from ReactPakistan 🚀
-
-<div>
-  <a
-    href="https://react-commons-collection.surge.sh"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Commons Collection"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1671950783/React%20Pakistan/react-commons-collection.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://www.npmjs.com/package/@react-pakistan/react-commons-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Commons Collection - NPM Package"
-      src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQY1K6JwhYEBfsv52nUT30dAIjoFyp252cH6VVkhXB_Gq1bUSz-"
-      width="20%"
-    />
-  </a>
-</div>
-
-<div>
-  <a
-    href="https://react-ui-collection.surge.sh"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React UI Collection"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1671950784/React%20Pakistan/react-ui-collection.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://www.npmjs.com/package/@react-pakistan/react-ui-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React UI Collection - NPM Package"
-      src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQY1K6JwhYEBfsv52nUT30dAIjoFyp252cH6VVkhXB_Gq1bUSz-"
-      width="20%"
-    />
-  </a>
-</div>
-
-<div>
-  <a
-    href="https://react-pakistan.github.io/react-icon-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Icon Collection"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1671950784/React%20Pakistan/react-icon-collection.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://www.npmjs.com/package/@react-pakistan/react-icon-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Icon Collection - NPM Package"
-      src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQY1K6JwhYEBfsv52nUT30dAIjoFyp252cH6VVkhXB_Gq1bUSz-"
-      width="20%"
-    />
-  </a>
-</div>
+// Factories
+import { genericComponentFactory } from '@react-pakistan/util-functions/factory/generic-component-factory';
+```
 
-<div>
-  <a
-    href="https://react-pakistan.github.io/react-logo-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Logo Collection"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1671950784/React%20Pakistan/react-logo-collection.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://www.npmjs.com/package/@react-pakistan/react-logo-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Logo Collection - NPM Package"
-      src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQY1K6JwhYEBfsv52nUT30dAIjoFyp252cH6VVkhXB_Gq1bUSz-"
-      width="20%"
-    />
-  </a>
-</div>
+## Tests
 
-<div>
-  <a
-    href="https://react-pakistan.github.io/react-emoji-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Emoji Collection"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1671950784/React%20Pakistan/react-emoji-collection.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://www.npmjs.com/package/@react-pakistan/react-emoji-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Emoji Collection - NPM Package"
-      src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQY1K6JwhYEBfsv52nUT30dAIjoFyp252cH6VVkhXB_Gq1bUSz-"
-      width="20%"
-    />
-  </a>
-</div>
+![Test Coverage Branches](https://util-functions.surge.sh/badge-branches.svg)
+![Test Coverage Functions](https://util-functions.surge.sh/badge-functions.svg)
+![Test Coverage Lines](https://util-functions.surge.sh/badge-lines.svg)
+![Test Coverage Statements](https://util-functions.surge.sh/badge-statements.svg)
 
-<div>
-  <a
-    href="https://react-pakistan.github.io/react-native-commons-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Native Commons Collection"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1672213225/React%20Pakistan/react-native-commons-collection.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://www.npmjs.com/package/@react-pakistan/react-native-commons-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Native Commons Collection - NPM Package"
-      src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQY1K6JwhYEBfsv52nUT30dAIjoFyp252cH6VVkhXB_Gq1bUSz-"
-      width="20%"
-    />
-  </a>
-</div>
+**156 test files · 693 tests** — all passing.
 
-<div>
-  <a
-    href="https://react-pakistan.github.io/react-native-ui-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Native Ui Collection"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1672213225/React%20Pakistan/react-native-ui-collection.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://www.npmjs.com/package/@react-pakistan/react-native-ui-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Native Ui Collection - NPM Package"
-      src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQY1K6JwhYEBfsv52nUT30dAIjoFyp252cH6VVkhXB_Gq1bUSz-"
-      width="20%"
-    />
-  </a>
-</div>
+Should you like this project, please consider giving a ⭐ on GitHub.
 
-<div>
-  <a
-    href="https://react-pakistan.github.io/react-native-icon-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Native Icon Collection"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1672213225/React%20Pakistan/react-native-icon-collection.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://www.npmjs.com/package/@react-pakistan/react-native-icon-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Native Icon Collection - NPM Package"
-      src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQY1K6JwhYEBfsv52nUT30dAIjoFyp252cH6VVkhXB_Gq1bUSz-"
-      width="20%"
-    />
-  </a>
-</div>
+## Contributors
 
-<div>
-  <a
-    href="https://react-pakistan.github.io/react-native-logo-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Native Logo Collection"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1672213225/React%20Pakistan/react-native-logo-collection.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://www.npmjs.com/package/@react-pakistan/react-native-logo-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Native Logo Collection - NPM Package"
-      src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQY1K6JwhYEBfsv52nUT30dAIjoFyp252cH6VVkhXB_Gq1bUSz-"
-      width="20%"
-    />
-  </a>
-</div>
+| Contributor | GitHub | Role |
+|------------|--------|------|
+| <img src="https://avatars0.githubusercontent.com/u/27800340?s=40&v=4" width="32" height="32" /> | [Taimoor Khan](https://github.com/taimoormk) | Maintainer |
 
-<div>
-  <a
-    href="https://react-pakistan.github.io/react-native-emoji-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Native Emoji Collection"
-      src="https://res.cloudinary.com/dq6hflqwx/image/upload/v1672213225/React%20Pakistan/react-native-emoji-collection.jpg"
-      width="70%"
-    />
-  </a>
-  <a
-    href="https://www.npmjs.com/package/@react-pakistan/react-native-emoji-collection"
-    target="_blank"
-  >
-    <img
-      alt="React Pakistan - React Native Emoji Collection - NPM Package"
-      src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQY1K6JwhYEBfsv52nUT30dAIjoFyp252cH6VVkhXB_Gq1bUSz-"
-      width="20%"
-    />
-  </a>
-</div>
+## Ecosystem
 
-### 📌 Support 🚀
+| Library | Storybook | npm |
+|---------|-----------|-----|
+| React Commons Collection | [storybook](https://react-commons-collection.surge.sh) | [npm](https://www.npmjs.com/package/@react-pakistan/react-commons-collection) |
+| React UI Collection | [storybook](https://react-ui-collection.surge.sh) | [npm](https://www.npmjs.com/package/@react-pakistan/react-ui-collection) |
+| React Icon Collection | [storybook](https://react-pakistan.github.io/react-icon-collection) | [npm](https://www.npmjs.com/package/@react-pakistan/react-icon-collection) |
+| React Logo Collection | [storybook](https://react-pakistan.github.io/react-logo-collection) | [npm](https://www.npmjs.com/package/@react-pakistan/react-logo-collection) |
+| React Emoji Collection | [storybook](https://react-pakistan.github.io/react-emoji-collection) | [npm](https://www.npmjs.com/package/@react-pakistan/react-emoji-collection) |
+| React Native Commons Collection | [docs](https://react-pakistan.github.io/react-native-commons-collection) | [npm](https://www.npmjs.com/package/@react-pakistan/react-native-commons-collection) |
+| React Native UI Collection | [docs](https://react-pakistan.github.io/react-native-ui-collection) | [npm](https://www.npmjs.com/package/@react-pakistan/react-native-ui-collection) |
+| React Native Icon Collection | [docs](https://react-pakistan.github.io/react-native-icon-collection) | [npm](https://www.npmjs.com/package/@react-pakistan/react-native-icon-collection) |
+| React Native Logo Collection | [docs](https://react-pakistan.github.io/react-native-logo-collection) | [npm](https://www.npmjs.com/package/@react-pakistan/react-native-logo-collection) |
+| React Native Emoji Collection | [docs](https://react-pakistan.github.io/react-native-emoji-collection) | [npm](https://www.npmjs.com/package/@react-pakistan/react-native-emoji-collection) |
 
-If you need any help or have any question, please feel free to join ReactPakistan community at [React Pakistan Slack](reactpakistan.slack.com).
+## Support
 
-### 📌 Contact 🚀
+Join the community on [React Pakistan Slack](https://reactpakistan.slack.com).
 
-I can be reachable via [Taimoor Web](https://taimoor.io) or else should you wish to send over an expression of your interest to contribute towards ReactPakistan, please shoot an [email](mailto:react.pakistan14@gmail.com).
+**Contact** — [Taimoor Khan](https://taimoor.io) · [email](mailto:react.pakistan14@gmail.com)
 
-### 📌 Buy me Coffee 🚀
+---
 
-<a
-  href="https://www.buymeacoffee.com/60whp8FM3"
-  target="_blank">
-<img
-    alt="Buy Me A Coffee"
-    src="https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/yellow_img.png"
-  />
+<a href="https://www.buymeacoffee.com/60whp8FM3">
+  <img src="https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/yellow_img.png" alt="Buy Me A Coffee" width="180" />
 </a>

package/constants/api-methods.d.ts

@@ -1,4 +1,4 @@
-export declare enum API_METHODS {
+declare enum API_METHODS {
     CONNECT = "CONNECT",
     DELETE = "DELETE",
     GET = "GET",
@@ -9,3 +9,5 @@ export declare enum API_METHODS {
     PUT = "PUT",
     TRACE = "TRACE"
 }
+
+export { API_METHODS };

package/constants/api-methods.js

@@ -1,15 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.API_METHODS = void 0;
-var API_METHODS;
-(function (API_METHODS) {
-    API_METHODS["CONNECT"] = "CONNECT";
-    API_METHODS["DELETE"] = "DELETE";
-    API_METHODS["GET"] = "GET";
-    API_METHODS["HEAD"] = "HEAD";
-    API_METHODS["OPTIONS"] = "OPTIONS";
-    API_METHODS["PATCH"] = "PATCH";
-    API_METHODS["POST"] = "POST";
-    API_METHODS["PUT"] = "PUT";
-    API_METHODS["TRACE"] = "TRACE";
-})(API_METHODS || (exports.API_METHODS = API_METHODS = {}));
+var G=Object.defineProperty;var U=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var n=Object.prototype.hasOwnProperty;var o=(N,C)=>{for(var e in C)G(N,e,{get:C[e],enumerable:!0})},p=(N,C,e,L)=>{if(C&&typeof C=="object"||typeof C=="function")for(let E of m(C))!n.call(N,E)&&E!==e&&G(N,E,{get:()=>C[E],enumerable:!(L=U(C,E))||L.enumerable});return N};var r=N=>p(G({},"__esModule",{value:!0}),N);var t={};o(t,{API_METHODS:()=>R});module.exports=r(t);var R=(T=>(T.CONNECT="CONNECT",T.DELETE="DELETE",T.GET="GET",T.HEAD="HEAD",T.OPTIONS="OPTIONS",T.PATCH="PATCH",T.POST="POST",T.PUT="PUT",T.TRACE="TRACE",T))(R||{});0&&(module.exports={API_METHODS});

package/constants/cache-time.d.ts

@@ -1,5 +1,7 @@
-export declare const ONE_DAY_IN_MS: number;
-export declare const ONE_WEEK_IN_MS: number;
-export declare const ONE_MONTH_IN_MS: number;
-export declare const SIX_MONTHS_IN_MS: number;
-export declare const ONE_YEAR_IN_MS: number;
+declare const ONE_DAY_IN_MS: number;
+declare const ONE_WEEK_IN_MS: number;
+declare const ONE_MONTH_IN_MS: number;
+declare const SIX_MONTHS_IN_MS: number;
+declare const ONE_YEAR_IN_MS: number;
+
+export { ONE_DAY_IN_MS, ONE_MONTH_IN_MS, ONE_WEEK_IN_MS, ONE_YEAR_IN_MS, SIX_MONTHS_IN_MS };

package/constants/cache-time.js

@@ -1,8 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ONE_YEAR_IN_MS = exports.SIX_MONTHS_IN_MS = exports.ONE_MONTH_IN_MS = exports.ONE_WEEK_IN_MS = exports.ONE_DAY_IN_MS = void 0;
-exports.ONE_DAY_IN_MS = 1 * 24 * 60 * 60 * 1000; // 1 day in milliseconds
-exports.ONE_WEEK_IN_MS = 7 * 24 * 60 * 60 * 1000; // 1 week in milliseconds
-exports.ONE_MONTH_IN_MS = 30 * 24 * 60 * 60 * 1000; // 1 month in milliseconds
-exports.SIX_MONTHS_IN_MS = 6 * 30 * 24 * 60 * 60 * 1000; // 6 months in milliseconds
-exports.ONE_YEAR_IN_MS = 12 * 30 * 24 * 60 * 60 * 1000; // 1 year in milliseconds
+var E=Object.defineProperty;var S=Object.getOwnPropertyDescriptor;var I=Object.getOwnPropertyNames;var O=Object.prototype.hasOwnProperty;var c=(N,_)=>{for(var t in _)E(N,t,{get:_[t],enumerable:!0})},e=(N,_,t,M)=>{if(_&&typeof _=="object"||typeof _=="function")for(let o of I(_))!O.call(N,o)&&o!==t&&E(N,o,{get:()=>_[o],enumerable:!(M=S(_,o))||M.enumerable});return N};var n=N=>e(E({},"__esModule",{value:!0}),N);var H={};c(H,{ONE_DAY_IN_MS:()=>p,ONE_MONTH_IN_MS:()=>s,ONE_WEEK_IN_MS:()=>r,ONE_YEAR_IN_MS:()=>A,SIX_MONTHS_IN_MS:()=>x});module.exports=n(H);const p=864e5,r=6048e5,s=2592e6,x=15552e6,A=31104e6;0&&(module.exports={ONE_DAY_IN_MS,ONE_MONTH_IN_MS,ONE_WEEK_IN_MS,ONE_YEAR_IN_MS,SIX_MONTHS_IN_MS});

package/constants/countries-timezones.d.ts

@@ -1,6 +1,8 @@
-export type Country = {
+type Country = {
     id: string;
     name: string;
     timezones: Array<string>;
 };
-export declare const countriesTimeZones: Array<Country>;
+declare const countriesTimeZones: Array<Country>;
+
+export { type Country, countriesTimeZones };