@react-pakistan/util-functions 2.0.2 → 3.0.1

package/general/upload-image-to-public-supabase.d.mts

@@ -0,0 +1,26 @@
+interface UploadImageToPublicSupabaseArgs {
+    blob: string;
+    cacheControl?: string;
+    contentType: string;
+    fileRef: string;
+    supabase: any;
+    upsert: boolean;
+}
+interface PublicReturn {
+    fullPath: string;
+    id: string;
+    path: string;
+}
+/**
+ * Uploads a base64 image to the public Supabase storage bucket.
+ * @param params.blob - Base64 image string.
+ * @param params.cacheControl - Cache control header value.
+ * @param params.contentType - MIME type of the image.
+ * @param params.fileRef - File reference/path in storage.
+ * @param params.supabase - Supabase client instance.
+ * @param params.upsert - Whether to overwrite existing file.
+ * @returns The upload result data or error.
+ */
+declare const uploadImageToPublicSupabase: ({ blob, cacheControl, contentType, fileRef, supabase, upsert, }: UploadImageToPublicSupabaseArgs) => Promise<PublicReturn>;
+
+export { type PublicReturn, type UploadImageToPublicSupabaseArgs, uploadImageToPublicSupabase };

package/general/upload-image-to-public-supabase.mjs

@@ -0,0 +1 @@
+import{removeDataImagePrefix as g}from"./remove-data-image-prefix";const l=async({blob:r,cacheControl:t,contentType:a,fileRef:o,supabase:s,upsert:n})=>{const i=g(r),u=Buffer.from(i,"base64"),{data:c,error:e}=await s.storage.from(process.env.NEXT_PUBLIC_SUPABASE_PUBLIC_BUCKET).upload(o,u,{cacheControl:t||process.env.NEXT_PUBLIC_SUPABASE_CACHE_CONTROL,contentType:a,upsert:n});return e||c};export{l as uploadImageToPublicSupabase};

package/general/url-to-sentence-case.d.mts

@@ -0,0 +1,12 @@
+/**
+ * A util function to convert url into sentence case
+ *
+ * @param str - string provided to convert url into sentence case - taimoorKhan
+ * @returns string in sentence case - Taimoor Khan
+ * @author Taimoor Khan
+ * @remarks
+ */
+/** End file docs */
+declare const urlToSentenceCase: (url: string) => string;
+
+export { urlToSentenceCase };

package/general/url-to-sentence-case.mjs

@@ -0,0 +1 @@
+const r=n=>{const e=n?.split("/");return e[e.length-1]?.split("-")?.map(t=>t.charAt(0).toUpperCase()+t.slice(1))?.join(" ")};export{r as urlToSentenceCase};

package/general/validate-comment.d.mts

@@ -0,0 +1,14 @@
+/**
+ * A util function to validate the length
+ * of the given comment string
+ * Acceptable range is from 200 - 1500 chars
+ *
+ * @param string - string to validate
+ * @returns boolean - true or false
+ * @author Taimoor Khan
+ * @remarks Taimoor Khan Resume 2 & Taimoor Khan Resume 4
+ */
+/** End file docs */
+declare const validateComment: (comment: string) => boolean;
+
+export { validateComment };

package/general/validate-comment.mjs

@@ -0,0 +1 @@
+const t=e=>e.length>=200&&e.length<1500;export{t as validateComment};

package/general/validate-email.d.mts

@@ -0,0 +1,15 @@
+/**
+ * A util function to validate the length
+ * of the given name email string
+ * It should't be an empty string
+ * Also it passed the emailRegex
+ *
+ * @param string - string to validate
+ * @returns boolean - true or false
+ * @author Taimoor Khan
+ * @remarks Taimoor Khan Resume 2 & Taimoor Khan Resume 4
+ */
+/** End file docs */
+declare const validateEmail: (email: string) => boolean;
+
+export { validateEmail };

package/general/validate-email.mjs

@@ -0,0 +1 @@
+const a=/^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/gi,t=e=>!!e.match(a);export{t as validateEmail};

package/general/validate-form.d.mts

@@ -0,0 +1,18 @@
+import { ZodObject, ZodDiscriminatedUnion } from 'zod';
+
+interface Params {
+    errorCallback: (e: Record<string, string>) => void;
+    params: object;
+    schema: ZodObject | ZodDiscriminatedUnion;
+    successCallback: () => void;
+}
+/**
+ * Validates form data against a Zod schema and calls the appropriate callback.
+ * @param params.schema - The Zod schema to validate against.
+ * @param params.params - The form data object to validate.
+ * @param params.errorCallback - Callback with validation errors map.
+ * @param params.successCallback - Callback on successful validation.
+ */
+declare const validateForm: ({ errorCallback, params, schema, successCallback, }: Params) => void;
+
+export { validateForm };

package/general/validate-form.mjs

@@ -0,0 +1 @@
+const l=({errorCallback:a,params:i,schema:e,successCallback:t})=>{const r=e?.safeParse({...i});if(r?.error){const o={};r?.error.issues.forEach(s=>{o[s.path.join("-")]=s.message}),a(o)}r?.success&&t()};export{l as validateForm};

package/general/validate-name.d.mts

@@ -0,0 +1,14 @@
+/**
+ * A util function to validate the length
+ * of the given name string
+ * Acceptable range is from 3 - 30 chars
+ *
+ * @param string - string to validate
+ * @returns boolean - true or false
+ * @author Taimoor Khan
+ * @remarks Taimoor Khan Resume 2 & Taimoor Khan Resume 4
+ */
+/** End file docs */
+declare const validateName: (str: string) => boolean;
+
+export { validateName };

package/general/validate-name.mjs

@@ -0,0 +1 @@
+const t=e=>e.length>=3&&e.length<30;export{t as validateName};

package/hooks/use-change.d.mts

@@ -0,0 +1,11 @@
+import { EffectCallback, DependencyList } from 'react';
+
+/**
+ * Runs a callback only when dependencies change, skipping the initial mount.
+ *
+ * @param callback - The effect callback to run on dependency changes.
+ * @param deps     - The dependency list that triggers the callback.
+ */
+declare const useChange: (callback: EffectCallback, deps: DependencyList) => void;
+
+export { useChange };

package/hooks/use-change.mjs

@@ -0,0 +1 @@
+import{useEffect as n,useRef as f}from"react";const s=(t,c)=>{const e=f(!1);n(()=>{e.current&&t(),e.current=!0},[e,...c])};export{s as useChange};

package/hooks/use-debounce.d.mts

@@ -0,0 +1,10 @@
+/**
+ * Debounces a string value by the specified delay.
+ *
+ * @param value   - The value to debounce.
+ * @param timeout - The debounce delay in milliseconds (default 500).
+ * @returns The debounced value after the delay has elapsed without change.
+ */
+declare const useDebounce: (value: string, timeout?: number) => string;
+
+export { useDebounce };

package/hooks/use-debounce.mjs

@@ -0,0 +1 @@
+import{useState as o,useEffect as c}from"react";const i=(t,e=500)=>{const[r,s]=o(t);return c(()=>{const n=setTimeout(()=>s(t),e);return()=>clearTimeout(n)},[t,e]),r};export{i as useDebounce};

package/hooks/use-fetch.d.mts

@@ -0,0 +1,42 @@
+interface FetchResult {
+    data: any;
+    error: any;
+    status?: number;
+    ok?: boolean;
+}
+interface FetchConfig extends Omit<RequestInit, 'credentials'> {
+    autoFetch?: boolean;
+    callback?: (result: FetchResult) => void;
+    /**
+     * If `true`, the fetch will be invoked with `credentials: 'include'`.
+     * String values from the standard `RequestCredentials` are also supported
+     * (e.g. 'omit' | 'same-origin' | 'include').
+     */
+    credentials?: boolean | RequestCredentials;
+    /**
+     * Query parameters to append to GET requests.
+     * Supports strings, numbers, booleans, arrays, and objects.
+     * - Primitives (string, number, boolean) are converted to strings
+     * - Arrays are repeated as multiple params with the same key
+     * - Objects are JSON-stringified
+     * - null and undefined values are skipped
+     *
+     * Example: { active: true, page: 1, tags: ['a', 'b'] }
+     * Results in: ?active=true&page=1&tags=a&tags=b
+     */
+    params?: Record<string, any>;
+}
+interface Return {
+    apiResult: API_RESULT | undefined;
+    data: any;
+    error: any;
+    fetchNow: (url?: string, config?: FetchConfig) => void;
+    loading: boolean;
+}
+declare enum API_RESULT {
+    SUCCESS = "SUCCESS",
+    ERROR = "ERROR"
+}
+declare const useFetch: (url: string, config?: FetchConfig, deps?: Array<string> | Array<any>) => Return;
+
+export { API_RESULT, type FetchConfig, type FetchResult, type Return, useFetch };

package/hooks/use-fetch.mjs

@@ -0,0 +1 @@
+import{useState as h,useRef as C,useCallback as z,useEffect as I}from"react";var B=(c=>(c.SUCCESS="SUCCESS",c.ERROR="ERROR",c))(B||{});const Q=(O,T={},c=[])=>{const{callback:l,autoFetch:x=!1,...A}=T,[L,i]=h(null),[j,u]=h(null),[q,F]=h(!1),[D,y]=h(void 0),P=C(null),o=C(!0),U=C(!1);I(()=>(o.current=!0,()=>{o.current=!1,P.current?.abort()}),[]);const p=z(async(N,_)=>{let a=N||O;const{params:G,...R}=A||{},{params:$,...g}=_||{},S={...G||{},...$||{}},n={...R,...g,headers:{...R.headers||{},...g.headers||{}}},H=(n.method||"GET").toString().toUpperCase(),b=g.credentials,m=R.credentials;if(typeof b=="string"?n.credentials=b:b===!0?n.credentials="include":typeof m=="string"?n.credentials=m:m===!0&&(n.credentials="include"),H==="GET"&&S&&Object.keys(S).length){const e=a.indexOf("#"),t=e>=0?a.slice(e):"",r=e>=0?a.slice(0,e):a,f=r.indexOf("?"),J=f>=0?r.slice(0,f):r,M=f>=0?r.slice(f+1):"",d=new URLSearchParams(M);Object.entries(S).forEach(([E,s])=>{s!=null&&(Array.isArray(s)?s.forEach(v=>d.append(E,String(v))):typeof s=="object"?d.append(E,JSON.stringify(s)):d.append(E,String(s)))});const k=d.toString();a=J+(k?`?${k}`:"")+t}F(!0),u(null),i(null);const w=new AbortController;P.current=w,n.signal=w.signal;try{const e=await fetch(a,n);let t=null;try{t=await e.json()}catch{t=null}if(o.current)if(e.ok)i(t),u(null),y("SUCCESS"),l?.({data:t,error:null,status:e.status,ok:!0});else{const r=new Error(`HTTP error! status: ${e.status}`);u(r),i(t),y("ERROR"),l?.({data:t,error:r,status:e.status,ok:!1})}}catch(e){o.current&&(u(e),i(null),y("ERROR"),l?.({data:null,error:e,status:void 0,ok:!1}))}finally{o.current&&F(!1)}},[O,A,l,...c]);return I(()=>{x&&!U.current&&(U.current=!0,p())},[p,x]),{apiResult:D,data:L,error:j,fetchNow:p,loading:q}};export{B as API_RESULT,Q as useFetch};

package/hooks/use-force-render.d.mts

@@ -0,0 +1,14 @@
+import { DispatchWithoutAction } from 'react';
+
+/**
+ * A util hook to enable force renders.
+ *
+ * @returns dispatch without action
+ * @author Taimoor Khan
+ * @remarks
+ */
+/** End file docs */
+
+declare const useForceRender: () => DispatchWithoutAction;
+
+export { useForceRender };

package/hooks/use-force-render.mjs

@@ -0,0 +1 @@
+import{useReducer as o}from"react";const i=()=>{const[,t]=o(e=>e+1,0);return t};export{i as useForceRender};

package/hooks/use-ip-geo-location.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Fetches the user's country based on their IP address via api.country.is.
+ *
+ * @returns An object with the detected country (or null), any error, and a loading flag.
+ */
+declare const useIPGeoLocation: () => {
+    country: string | null;
+    error: Error | null;
+    isLoading: boolean;
+};
+
+export { useIPGeoLocation };

package/hooks/use-ip-geo-location.mjs

@@ -0,0 +1 @@
+import{useState as r,useEffect as a}from"react";const y=()=>{const[o,i]=r(null),[e,u]=r(null),[s,n]=r(!0),c="https://api.country.is";return a(()=>{if(o)return;async function l(){n(!0),await fetch(c).then(t=>{if(!t.ok)throw Error(t.statusText);return t.json()}).then(t=>{t&&t.country&&i(t.country)}).catch(t=>u(t)).finally(()=>n(!1))}l()},[o]),{country:o,error:e,isLoading:s}};export{y as useIPGeoLocation};

package/hooks/use-is-mobile.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Detects whether the viewport is mobile-sized (width < 767px).
+ *
+ * @returns True if the viewport width is less than 767 pixels.
+ */
+declare const useIsMobile: () => boolean;
+
+export { useIsMobile };

package/hooks/use-is-mobile.mjs

@@ -0,0 +1 @@
+import{useEffect as i,useState as n}from"react";const r=()=>{const[s,o]=n(!1),e=()=>{window.innerWidth<767?o(!0):o(!1)};return i(()=>(window.addEventListener("resize",e),e(),()=>window.removeEventListener("resize",e)),[]),s};export{r as useIsMobile};

package/hooks/use-module-entity-v2.d.mts

@@ -0,0 +1,105 @@
+import { FetchConfig } from './use-fetch.mjs';
+
+/**
+ * useModuleEntityV2
+ *
+ * Summary
+ * - A convenience hook that manages common module/entity operations: list, get-by-id,
+ *   create/update, and delete. It composes `useFetch` for HTTP calls and `useDebounce`
+ *   for debouncing search queries.
+ *
+ * Main features
+ * - List: performs a GET to `listUrl` with `listParams`. The hook listens to
+ *   `searchQuery` (debounced) and `listDeps` to re-run the list fetch.
+ * - Get by ID: performs a GET to `unitByIdUrl` with `byIdParams` and returns
+ *   `byIdFetchNow`, `byIdLoading`, and `byIdError`.
+ * - Create/Update: performs a PUT to `unitUrl` with a JSON body `updateParams`.
+ *   On successful create/update the hook triggers a coalesced list refresh.
+ * - Delete: performs a DELETE to `unitUrl` with a JSON body `deleteParams` and
+ *   triggers a coalesced list refresh when the operation succeeds.
+ * - Refresh batching: `refreshList(delay)` coalesces multiple rapid updates/deletes
+ *   using a short timeout (default 300ms) to avoid unnecessary list reloads.
+ *
+ * Parameters (object)
+ * - `byIdCallback(data)`, `byIdDeps`, `byIdParams` — params for GET by ID request
+ * - `deleteCallback(data)`, `deleteDeps`, `deleteParams` — body for DELETE request
+ * - `listCallback(data)`, `listDeps`, `listParams`, `listUrl` — params for GET list
+ * - `searchQuery` (string) — debounced before influencing the list fetch
+ * - `unitByIdUrl`, `unitUrl`
+ * - `updateCallback(data)`, `updateDeps`, `updateParams` — body for PUT request
+ *
+ * Parameter types
+ * - `listParams` and `byIdParams` support all primitive types including booleans.
+ *   They are appended as URL query parameters for GET requests.
+ *   Example: { active: true, page: 1 } → ?active=true&page=1
+ * - `updateParams` and `deleteParams` are sent as JSON in request body.
+ *
+ * Return values
+ * - `byIdFetchNow(url?, config?)`, `byIdLoading`, `byIdError`
+ * - `listFetchNow(url?, config?)`, `listLoading`, `listError`
+ * - `updateFetchNow(url?, config?)`, `updateLoading`, `updateError`
+ * - `deleteFetchNow(url?, config?)`, `deleteLoading`, `deleteError`
+ *
+ * Behavior notes
+ * - All callbacks receive an object `{ data, error, status, ok }` from `useFetch`.
+ * - Callbacks are wrapped so that any errors they throw are swallowed; this
+ *   ensures the hook's refresh logic still runs reliably.
+ * - `refreshList()` calls `listFetchNow(undefined, { method: 'POST', params: listParams })`
+ *   to explicitly re-query the list endpoint with the current `listParams`.
+ * - Network calls are delegated to `useFetch`; callers can call the returned
+ *   `*FetchNow` functions directly with an override URL or config.
+ *
+ * Example
+ * const { listFetchNow, updateFetchNow } = useModuleEntityV2({
+ *   listUrl: '/items',
+ *   listParams: { page: 1, active: true },
+ *   listCallback: (res) => console.log(res),
+ *   unitUrl: '/items',
+ *   updateCallback: () => {},
+ *   updateParams: {}
+ * });
+ */
+
+interface CallbackParamsV2 {
+    data: any;
+    error: any;
+    status?: number;
+    ok?: boolean;
+}
+interface Params {
+    byIdCallback: (d: CallbackParamsV2) => void;
+    byIdDeps?: Array<any> | Array<string>;
+    byIdParams: object;
+    deleteCallback?: (d: CallbackParamsV2) => void;
+    deleteDeps?: Array<any> | Array<string>;
+    deleteParams?: object;
+    listCallback: (d: CallbackParamsV2) => void;
+    listDeps?: Array<any> | Array<string>;
+    listParams: object;
+    listUrl: string;
+    /** Optional headers to include on every fetch made by this hook */
+    headers?: Record<string, string>;
+    searchQuery: string;
+    unitByIdUrl: string;
+    unitUrl: string;
+    updateCallback: (d: CallbackParamsV2) => void;
+    updateDeps?: Array<any> | Array<string>;
+    updateParams: object;
+}
+interface Return {
+    byIdError?: Error;
+    byIdFetchNow: (url?: string, config?: FetchConfig) => void;
+    byIdLoading: boolean;
+    deleteError?: Error;
+    deleteFetchNow?: (url?: string, config?: FetchConfig) => void;
+    deleteLoading: boolean;
+    listError?: Error;
+    listFetchNow: (url?: string, config?: FetchConfig) => void;
+    listLoading: boolean;
+    updateError?: Error;
+    updateFetchNow: (url?: string, config?: FetchConfig) => void;
+    updateLoading: boolean;
+}
+declare const useModuleEntityV2: ({ byIdCallback, byIdDeps, byIdParams, deleteCallback, deleteDeps, deleteParams, listCallback, listDeps, listParams, listUrl, headers, searchQuery, unitByIdUrl, unitUrl, updateCallback, updateDeps, updateParams, }: Params) => Return;
+
+export { type CallbackParamsV2, useModuleEntityV2 };

package/hooks/use-module-entity-v2.mjs

@@ -0,0 +1 @@
+import{useRef as G,useEffect as O}from"react";import{API_METHODS as o}from"../constants/api-methods";import{useFetch as a}from"./use-fetch";import{useDebounce as S}from"./use-debounce";const B=({byIdCallback:u,byIdDeps:g=[],byIdParams:b,deleteCallback:n,deleteDeps:y=[],deleteParams:f,listCallback:m,listDeps:h=[],listParams:i,listUrl:p,headers:t,searchQuery:E,unitByIdUrl:k,unitUrl:c,updateCallback:l,updateDeps:T=[],updateParams:C})=>{const F=S(E,800),e=G(null);O(()=>()=>{e.current&&(globalThis.clearTimeout(e.current),e.current=null)},[]);const{error:N,fetchNow:s,loading:P}=a(p,{method:o.GET,params:i,headers:t,callback:m,credentials:!0},[F,i,...h]),d=(r=300)=>{e.current&&globalThis.clearTimeout(e.current),e.current=globalThis.setTimeout(()=>{try{s(void 0,{method:o.GET,params:i,headers:t})}catch{}e.current=null},r)},{error:w,loading:I,fetchNow:L}=a(c,{method:o.PUT,body:JSON.stringify(C),headers:t,callback:r=>{if(l)try{l(r)}catch{}try{r&&r.ok&&d()}catch{}}},[...T]),{error:v,loading:A,fetchNow:V}=a(k,{method:o.GET,params:b,headers:t,callback:u},[...g]),{error:D,loading:R,fetchNow:j}=a(c,{method:o.DELETE,body:JSON.stringify(f),headers:t,callback:r=>{if(n)try{n(r)}catch{}try{r&&r.ok&&d()}catch{}}},[...y]);return{byIdError:v,byIdFetchNow:V,byIdLoading:A,deleteError:D,deleteFetchNow:j,deleteLoading:R,listError:N,listFetchNow:s,listLoading:P,updateError:w,updateFetchNow:L,updateLoading:I}};export{B as useModuleEntityV2};

package/hooks/use-module-entity.d.mts

@@ -0,0 +1,98 @@
+import { FetchConfig } from './use-fetch.mjs';
+
+/**
+ * useModuleEntity
+ *
+ * Summary
+ * - A convenience hook that manages common module/entity operations: list, get-by-id,
+ *   create/update, and delete. It composes `useFetch` for HTTP calls and `useDebounce`
+ *   for debouncing search queries.
+ *
+ * Main features
+ * - List: performs a POST to `listUrl` with a JSON body `listParams` and re-runs
+ *   when `searchQuery` (debounced) or `listDeps` change.
+ * - Get by ID: performs a POST to `unitByIdUrl` with `byIdParams` in the JSON body
+ *   and exposes `byIdFetchNow`, `byIdLoading`, and `byIdError`.
+ * - Create/Update: performs a POST to `unitUrl` with a JSON body `updateParams`.
+ *   On successful create/update the hook triggers a coalesced list refresh.
+ * - Delete: performs a DELETE to `unitUrl` with a JSON body `deleteParams` and
+ *   triggers a coalesced list refresh when the operation succeeds.
+ * - Refresh batching: `refreshList(delay)` coalesces multiple rapid updates/deletes
+ *   using a short timeout (default 300ms) to avoid unnecessary list reloads.
+ *
+ * Parameters (object)
+ * - `byIdCallback(data)`, `byIdDeps`, `byIdParams`
+ * - `deleteCallback(data)`, `deleteDeps`, `deleteParams`
+ * - `listCallback(data)`, `listDeps`, `listParams`, `listUrl`
+ * - `searchQuery` (string) — debounced before influencing the list fetch
+ * - `unitByIdUrl`, `unitUrl`
+ * - `updateCallback(data)`, `updateDeps`, `updateParams`
+ *
+ * Return values
+ * - `byIdFetchNow(url?, config?)`, `byIdLoading`, `byIdError`
+ * - `listFetchNow(url?, config?)`, `listLoading`, `listError`
+ * - `updateFetchNow(url?, config?)`, `updateLoading`, `updateError`
+ * - `deleteFetchNow(url?, config?)`, `deleteLoading`, `deleteError`
+ *
+ * Behavior notes
+ * - All requests that accept parameters send them in the JSON request body (stringified).
+ * - All callbacks receive an object `{ data, error, status, ok }` from `useFetch`.
+ * - Callbacks are wrapped so thrown errors are swallowed to ensure refresh logic
+ *   still runs reliably.
+ * - `refreshList()` calls `listFetchNow(undefined, { method: 'POST', body: JSON.stringify(listParams) })`
+ *   to explicitly re-query the list endpoint with the current `listParams`.
+ * - Network calls are delegated to `useFetch`; callers can invoke the returned
+ *   `*FetchNow` functions directly with an override URL or config.
+ *
+ * Example
+ * const { listFetchNow, updateFetchNow } = useModuleEntity({
+ *   listUrl: '/items',
+ *   listParams: { page: 1 },
+ *   listCallback: (res) => console.log(res),
+ *   unitUrl: '/items',
+ *   updateCallback: () => {},
+ *   updateParams: {}
+ * });
+ */
+
+interface CallbackParams {
+    data: any;
+    error: any;
+    status?: number;
+    ok?: boolean;
+}
+interface Params {
+    byIdCallback: (d: CallbackParams) => void;
+    byIdDeps?: Array<any> | Array<string>;
+    byIdParams: object;
+    deleteCallback?: (d: CallbackParams) => void;
+    deleteDeps?: Array<any> | Array<string>;
+    deleteParams?: object;
+    listCallback: (d: CallbackParams) => void;
+    listDeps?: Array<any> | Array<string>;
+    listParams: object;
+    listUrl: string;
+    searchQuery: string;
+    unitByIdUrl: string;
+    unitUrl: string;
+    updateCallback: (d: CallbackParams) => void;
+    updateDeps?: Array<any> | Array<string>;
+    updateParams: object;
+}
+interface Return {
+    byIdError?: Error;
+    byIdFetchNow: (url?: string, config?: FetchConfig) => void;
+    byIdLoading: boolean;
+    deleteError?: Error;
+    deleteFetchNow?: (url?: string, config?: FetchConfig) => void;
+    deleteLoading: boolean;
+    listError?: Error;
+    listFetchNow: (url?: string, config?: FetchConfig) => void;
+    listLoading: boolean;
+    updateError?: Error;
+    updateFetchNow: (url?: string, config?: FetchConfig) => void;
+    updateLoading: boolean;
+}
+declare const useModuleEntity: ({ byIdCallback, byIdDeps, byIdParams, deleteCallback, deleteDeps, deleteParams, listCallback, listDeps, listParams, listUrl, searchQuery, unitByIdUrl, unitUrl, updateCallback, updateDeps, updateParams, }: Params) => Return;
+
+export { type CallbackParams, useModuleEntity };

package/hooks/use-module-entity.mjs

@@ -0,0 +1 @@
+import{useRef as J,useEffect as R}from"react";import{API_METHODS as t}from"../constants/api-methods";import{useFetch as o}from"./use-fetch";import{useDebounce as j}from"./use-debounce";const H=({byIdCallback:d,byIdDeps:u=[],byIdParams:y,deleteCallback:i,deleteDeps:b=[],deleteParams:g,listCallback:f,listDeps:h=[],listParams:a,listUrl:m,searchQuery:p,unitByIdUrl:E,unitUrl:n,updateCallback:c,updateDeps:N=[],updateParams:k})=>{const P=j(p,800),e=J(null);R(()=>()=>{e.current&&(globalThis.clearTimeout(e.current),e.current=null)},[]);const{error:T,fetchNow:l,loading:C}=o(m,{method:t.POST,body:JSON.stringify(a),callback:f},[P,JSON.stringify(a),...h]),s=(r=300)=>{e.current&&globalThis.clearTimeout(e.current),e.current=globalThis.setTimeout(()=>{try{l(void 0,{method:t.POST,body:JSON.stringify(a)})}catch{}e.current=null},r)},{error:F,loading:w,fetchNow:I}=o(n,{method:t.POST,body:JSON.stringify(k),callback:r=>{if(c)try{c(r)}catch{}try{r&&r.ok&&s()}catch{}}},[...N]),{error:O,loading:S,fetchNow:L}=o(E,{method:t.POST,body:JSON.stringify(y),callback:d},[...u]),{error:v,loading:A,fetchNow:D}=o(n,{method:t.DELETE,body:JSON.stringify(g),callback:r=>{if(i)try{i(r)}catch{}try{r&&r.ok&&s()}catch{}}},[...b]);return{byIdError:O,byIdFetchNow:L,byIdLoading:S,deleteError:v,deleteFetchNow:D,deleteLoading:A,listError:T,listFetchNow:l,listLoading:C,updateError:F,updateFetchNow:I,updateLoading:w}};export{H as useModuleEntity};

package/hooks/use-phone-formatter.d.mts

@@ -0,0 +1,17 @@
+interface FormattedPhoneNumber {
+    e164: string;
+    international: string;
+}
+interface Return {
+    formatted: FormattedPhoneNumber | null;
+    formatNumber: (v: string) => void;
+}
+/**
+ * Parses and formats phone numbers into E.164 and international formats.
+ *
+ * @param defaultCountry - The default country code to use when parsing (default 'US').
+ * @returns An object containing the formatted phone number (or null) and a setter function.
+ */
+declare const usePhoneFormatter: (defaultCountry?: string) => Return;
+
+export { usePhoneFormatter };

package/hooks/use-phone-formatter.d.ts

@@ -1,5 +1,3 @@
-import { CountryCode } from 'libphonenumber-js';
-
 interface FormattedPhoneNumber {
     e164: string;
     international: string;
@@ -14,6 +12,6 @@ interface Return {
  * @param defaultCountry - The default country code to use when parsing (default 'US').
  * @returns An object containing the formatted phone number (or null) and a setter function.
  */
-declare const usePhoneFormatter: (defaultCountry?: CountryCode) => Return;
+declare const usePhoneFormatter: (defaultCountry?: string) => Return;
 
 export { usePhoneFormatter };

package/hooks/use-phone-formatter.js

@@ -1 +1 @@
-var a=Object.defineProperty;var s=Object.getOwnPropertyDescriptor;var l=Object.getOwnPropertyNames;var f=Object.prototype.hasOwnProperty;var d=(r,t)=>{for(var e in t)a(r,e,{get:t[e],enumerable:!0})},b=(r,t,e,m)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of l(t))!f.call(r,o)&&o!==e&&a(r,o,{get:()=>t[o],enumerable:!(m=s(t,o))||m.enumerable});return r};var N=r=>b(a({},"__esModule",{value:!0}),r);var h={};d(h,{usePhoneFormatter:()=>c});module.exports=N(h);var i=require("react"),u=require("libphonenumber-js");const c=(r="US")=>{const[t,e]=(0,i.useState)(null);return{formatted:t,formatNumber:o=>{const n=(0,u.parsePhoneNumberFromString)(o,r);e(n?{e164:n.isValid()?n.format("E.164"):"",international:n.formatInternational()}:null)}}};0&&(module.exports={usePhoneFormatter});
+var m=Object.defineProperty;var s=Object.getOwnPropertyDescriptor;var l=Object.getOwnPropertyNames;var f=Object.prototype.hasOwnProperty;var d=(e,t)=>{for(var r in t)m(e,r,{get:t[r],enumerable:!0})},b=(e,t,r,a)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of l(t))!f.call(e,n)&&n!==r&&m(e,n,{get:()=>t[n],enumerable:!(a=s(t,n))||a.enumerable});return e};var N=e=>b(m({},"__esModule",{value:!0}),e);var g={};d(g,{usePhoneFormatter:()=>c});module.exports=N(g);var i=require("react");const c=(e="US")=>{const[t,r]=(0,i.useState)(null);return{formatted:t,formatNumber:n=>{const{parsePhoneNumberFromString:u}=require("libphonenumber-js"),o=u(n,e);r(o?{e164:o.isValid()?o.format("E.164"):"",international:o.formatInternational()}:null)}}};0&&(module.exports={usePhoneFormatter});

package/hooks/use-phone-formatter.mjs

@@ -0,0 +1 @@
+import{useState as m}from"react";const s=(r="US")=>{const[n,e]=m(null);return{formatted:n,formatNumber:o=>{const{parsePhoneNumberFromString:a}=require("libphonenumber-js"),t=a(o,r);e(t?{e164:t.isValid()?t.format("E.164"):"",international:t.formatInternational()}:null)}}};export{s as usePhoneFormatter};

package/hooks/use-position.d.mts

@@ -0,0 +1,29 @@
+import { RefObject } from 'react';
+
+/**
+ * A util hook to get element positioning.
+ *
+ * @param elementRef as an element ref for it's position
+ * @returns [x, y]
+ * @author Taimoor Khan
+ * @remarks
+ */
+/** End file docs */
+
+type PositionRef = {
+    offsetLeft: 0 | null;
+    offsetRight: 0 | null;
+    offsetTop: 0 | null;
+    offsetBottom: 0 | null;
+};
+type StateX = {
+    xLeft: 0 | null;
+    xRight: 0 | null;
+};
+type StateY = {
+    yTop: 0 | null;
+    yBottom: 0 | null;
+};
+declare const usePosition: (elementRef: RefObject<PositionRef>) => [StateX, StateY];
+
+export { usePosition };

package/hooks/use-position.mjs

@@ -0,0 +1 @@
+import{useCallback as p,useEffect as y,useState as n}from"react";const S=t=>{const[f,o]=n({xLeft:0,xRight:0}),[l,e]=n({yTop:0,yBottom:0}),s=p(()=>{const u=t?.current?.offsetLeft||null,c=t?.current?.offsetRight||null,i=t?.current?.offsetTop||null,r=t?.current?.offsetBottom||null;o({xLeft:u,xRight:c}),e({yTop:i,yBottom:r})},[t,o,e]);return y(()=>{s()},[s]),[f,l]};export{S as usePosition};

package/hooks/use-rtl.d.mts

@@ -0,0 +1,46 @@
+/**
+ * Hook to detect RTL (Right-to-Left) layout based on current locale
+ * @returns {boolean} true if current locale requires RTL layout (Urdu), false otherwise
+ */
+declare const useRTL: (forcedLocale?: string) => boolean;
+/**
+ * Hook to get RTL-aware CSS classes
+ *
+ * @returns Object containing common RTL-aware class combinations
+ *
+ * @example
+ * ```tsx
+ * const rtlClasses = useRTLClasses();
+ *
+ * // For icon buttons (ensures proper centering in RTL)
+ * <Button size="icon" className={`h-8 w-8 ${rtlClasses.iconButton}`}>
+ *   <Icon />
+ * </Button>
+ *
+ * // For buttons with icon and text
+ * <Button className={rtlClasses.iconWithText("left")}>
+ *   <Icon />
+ *   <span>Button Text</span>
+ * </Button>
+ * ```
+ */
+declare const useRTLClasses: (forcedLocale?: string) => {
+    isRTL: boolean;
+    container: string;
+    direction: string;
+    flexRow: string;
+    flexRowReverse: string;
+    textAlign: string;
+    textAlignReverse: string;
+    marginLeft: string;
+    marginRight: string;
+    paddingLeft: (size: string) => string;
+    paddingRight: (size: string) => string;
+    gap: (size: string) => string;
+    roundedLeft: string;
+    roundedRight: string;
+    iconButton: string;
+    iconWithText: (iconPosition?: "left" | "right") => "flex items-center flex-row-reverse gap-2" | "flex items-center gap-2";
+};
+
+export { useRTL, useRTLClasses };

package/hooks/use-rtl.mjs

@@ -0,0 +1 @@
+const n=r=>{if(r)return r==="ur";try{const{useLocale:e}=require("next-intl");return e()==="ur"}catch{return!1}},l=r=>{const e=n(r);return{isRTL:e,container:e?"rtl":"ltr",direction:e?"rtl":"ltr",flexRow:e?"flex-row-reverse":"flex-row",flexRowReverse:e?"flex-row":"flex-row-reverse",textAlign:e?"text-right":"text-left",textAlignReverse:e?"text-left":"text-right",marginLeft:e?"mr-auto":"ml-auto",marginRight:e?"ml-auto":"mr-auto",paddingLeft:t=>e?`pr-${t}`:`pl-${t}`,paddingRight:t=>e?`pl-${t}`:`pr-${t}`,gap:t=>`gap-${t}`,roundedLeft:e?"rounded-r":"rounded-l",roundedRight:e?"rounded-l":"rounded-r",iconButton:"flex items-center justify-center border",iconWithText:(t="left")=>t==="left"?e?"flex items-center flex-row-reverse gap-2":"flex items-center gap-2":e?"flex items-center gap-2":"flex items-center flex-row-reverse gap-2"}};export{n as useRTL,l as useRTLClasses};

package/hooks/use-sticky.d.mts

@@ -0,0 +1,13 @@
+/**
+ * A util hook to stickyness in the app.
+ *
+ * @param offset - number of pixel which is offset
+ * @default offset = 0
+ * @returns isSticky as boolean
+ * @author Taimoor Khan
+ * @remarks
+ */
+/** End file docs */
+declare const useSticky: (offset?: number) => boolean;
+
+export { useSticky };

package/hooks/use-sticky.mjs

@@ -0,0 +1 @@
+import{useLayoutEffect as r}from"react";import{useToggleState as s}from"./use-toggle-state";const w=(e=0)=>{const[n,o,t]=s();return r(()=>{const i=()=>{window.requestAnimationFrame(()=>{window.pageYOffset>e?o():t()})};if(window)return window.addEventListener("scroll",i),()=>{window.removeEventListener("scroll",i)}},[o,e,t]),n};export{w as useSticky};

package/hooks/use-toggle-state.d.mts

@@ -0,0 +1,14 @@
+/**
+ * A util hook to enable toggle state.
+ *
+ * @param defaultValue as an initial state toggle value
+ * @default defaultValue as false
+ * @returns [state, toggleOn, toggleOff]
+ * @author Taimoor Khan
+ * @remarks
+ */
+/** End file docs */
+type ReturnType = [boolean, () => void, () => void];
+declare const useToggleState: (defaultValue?: boolean) => ReturnType;
+
+export { useToggleState };

package/hooks/use-toggle-state.mjs

@@ -0,0 +1 @@
+import{useCallback as t,useState as l}from"react";const u=(o=!1)=>{const[s,e]=l(o),a=t(()=>{e(!0)},[e]),n=t(()=>{e(!1)},[e]);return[s,a,n]};export{u as useToggleState};