react-hook-toolkit 1.1.9 → 1.2.1

package/dist/type.d.ts

@@ -0,0 +1,286 @@
+import { AxiosRequestConfig } from 'axios';
+import { ReactNode } from 'react';
+export interface DrawerContextValue {
+    drawerOpen: boolean;
+    openDrawer: () => void;
+    closeDrawer: () => void;
+    openDrawerInButton: () => void;
+    closeDrawerInButton: () => void;
+    currentMainMenu?: string;
+    setCurrentMainMenu?: (value: string) => void;
+}
+export interface DrawerProviderProps {
+    children: ReactNode;
+}
+export interface FileComponentProps {
+    primaryKey: string | number;
+    filename: string;
+    size: string | number;
+    onDownload?: any;
+    width?: number;
+    borderColor?: string;
+    fileColor?: 'inherit' | 'primary' | 'secondary' | 'error' | 'disabled' | 'action';
+    isDownloading: boolean;
+}
+export interface AlertPropsType {
+    type: string;
+    msg: string;
+    duration?: number;
+}
+export interface DetailsCardProps {
+    isLoading?: boolean;
+    title: string;
+    details: any[];
+    spacing?: number;
+    boxShadow?: string;
+    background?: string;
+    loaderType?: 'skeleton' | 'circular';
+    displayType?: 'flex' | 'block';
+}
+export interface UploadButtonProps {
+    isUpload?: boolean;
+    color?: 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
+    state?: {
+        isUploaded?: boolean;
+        isUploadError?: boolean;
+        isLoadingUpload?: boolean;
+    };
+    onFileSelect: (file: File) => void;
+}
+export interface DownloadButtonState {
+    isDownloaded?: boolean;
+    isDownloadError?: boolean;
+    isLoadingDownload?: boolean;
+}
+export interface DownloadFileProps {
+    isDownload?: boolean;
+    color?: 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
+    state?: DownloadButtonState;
+    onDownload: () => void;
+}
+type MenuPosition = 'auto' | 'fixed';
+type ThemeMode = 'light' | 'dark';
+export interface ContextMenuProps {
+    options: any;
+    children: React.ReactNode;
+    disabled?: boolean;
+    className?: string;
+    menuClassName?: string;
+    position?: MenuPosition;
+    onShow?: () => void;
+    onHide?: () => void;
+    currentInstance?: any;
+    theme?: ThemeMode;
+}
+export interface UndoableHistoryState<T> {
+    past: T[];
+    present: T;
+    future: T[];
+}
+export type HistoryAction<T> = {
+    type: 'UNDO';
+} | {
+    type: 'REDO';
+} | {
+    type: 'CLEAR';
+} | {
+    type: 'SET';
+    newPresent: T;
+} | {
+    type: 'RESET';
+    newPresent: T;
+};
+export type UseRecentSearchOptions = {
+    key?: string;
+    limit?: number;
+    uniqueKey?: string;
+    excludeEmpty?: boolean;
+};
+export interface UseAxiosResponse<T> {
+    data: T | null;
+    loading: boolean;
+    error: string | null;
+    makeRequest: (url: string, method?: string, requestData?: any) => void;
+    cancelRequest: () => void;
+}
+export interface UseAxiosConfig extends AxiosRequestConfig {
+    baseURL?: string;
+    headers?: {
+        [key: string]: string;
+    };
+}
+export interface FetchState<T> {
+    data: T | null;
+    loading: boolean;
+    error: string | null;
+}
+export interface WindowSize {
+    width: number;
+    height: number;
+}
+export interface ScrollPosition {
+    x: number;
+    y: number;
+}
+export interface MousePosition {
+    x: number;
+    y: number;
+}
+export type IdleStatus = 'idle' | 'pending' | 'success' | 'error';
+export type AsyncFunction<T> = () => Promise<T>;
+export interface UseAsyncReturn<T> {
+    execute: () => void;
+    status: IdleStatus;
+    value: T | null;
+    error: Error | null;
+}
+export interface BatteryManager {
+    level: number;
+    charging: boolean;
+    chargingTime: number;
+    dischargingTime: number;
+    addEventListener(type: string, listener: EventListener | EventListenerObject | null, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener(type: string, listener: EventListener | EventListenerObject | null, options?: boolean | EventListenerOptions): void;
+}
+export interface BatteryState {
+    supported: boolean;
+    loading: boolean;
+    level: number | null;
+    charging: boolean | null;
+    chargingTime: number | null;
+    dischargingTime: number | null;
+}
+export interface NavigatorWithBattery extends Navigator {
+    getBattery: () => Promise<BatteryManager>;
+}
+export interface HistoryState {
+    [key: string]: any;
+}
+export interface UseHistory {
+    history: History;
+    state: HistoryState | null;
+    push: (path: string, state?: HistoryState) => void;
+    replace: (path: string, state?: HistoryState) => void;
+    goBack: () => void;
+    goForward: () => void;
+}
+export interface UseSessionStorage<T> {
+    (key: string, initialValue: T): [T, (value: T) => void];
+}
+export interface UseSound {
+    play: () => void;
+    pause: () => void;
+    stop: () => void;
+    setVolume: (volume: number) => void;
+    isPlaying: boolean;
+    error: Error | null;
+}
+export interface TouchPosition {
+    x: number | null;
+    y: number | null;
+}
+export interface UseTouch {
+    (elementRef: React.RefObject<HTMLElement>): {
+        touchStart: TouchPosition;
+        touchMove: TouchPosition;
+        touchEnd: TouchPosition;
+    };
+}
+export interface MotionSensorState {
+    acceleration: {
+        x: number | null;
+        y: number | null;
+        z: number | null;
+    };
+    accelerationIncludingGravity: {
+        x: number | null;
+        y: number | null;
+        z: number | null;
+    };
+    rotationRate: {
+        alpha: number | null;
+        beta: number | null;
+        gamma: number | null;
+    };
+    interval: number | null;
+}
+export type SpeechOptions = {
+    lang: string;
+    voice?: SpeechSynthesisVoice;
+    rate: number;
+    pitch: number;
+    volume: number;
+};
+export type IState = PermissionState | '';
+export type IPermissionDescriptor = PermissionDescriptor | (PermissionDescriptor & {
+    deviceId?: string;
+}) | (PermissionDescriptor & {
+    sysex?: boolean;
+}) | (PermissionDescriptor & {
+    userVisibleOnly?: boolean;
+});
+export type ISpeechOptions = Partial<SpeechOptions>;
+export type VoiceInfo = Pick<SpeechSynthesisVoice, 'lang' | 'name'>;
+export type ISpeechState = SpeechOptions & {
+    isPlaying: boolean;
+    status: string;
+    voiceInfo: VoiceInfo;
+};
+export declare enum VoiceStatus {
+    init = 0,
+    play = 1,
+    pause = 2,
+    end = 3
+}
+export interface BrowserHistoryState {
+    canGoBack: boolean;
+    canGoForward: boolean;
+    historyLength: number;
+}
+export interface BrowserSettings {
+    clearCache: boolean;
+    clearCookies: boolean;
+    clearLocalStorage: boolean;
+    clearSessionStorage: boolean;
+}
+export interface UseBrowserControlsReturn {
+    currentUrl: URL;
+    currentPath: string;
+    currentHash: string;
+    currentSearchParams: URLSearchParams;
+    goBack: () => void;
+    goForward: () => void;
+    reload: (hardReload?: boolean, scrollToTop?: boolean) => void;
+    navigateTo: (url: string | URL, replace?: boolean) => void;
+    clearBrowserData: (settings: Partial<BrowserSettings>) => Promise<void>;
+    historyState: BrowserHistoryState;
+    isOnline: boolean;
+    copyCurrentUrl: () => Promise<void>;
+    openNewTab: (url?: string) => void;
+    getFaviconUrl: (size?: number) => string;
+    getPageTitle: () => string;
+    setPageTitle: (title: string) => void;
+    isSecureContext: boolean;
+    viewportSize: {
+        width: number;
+        height: number;
+    };
+    screenSize: {
+        width: number;
+        height: number;
+    };
+    enableFullscreen: () => Promise<void>;
+    disableFullscreen: () => Promise<void>;
+    isFullscreen: boolean;
+    printPage: () => void;
+    getUserAgent: () => string;
+    shareContent: (data: ShareData) => Promise<void>;
+    isShareSupported: boolean;
+    closeCurrentTab: () => void;
+}
+export interface AnimatedWrapperProps {
+    animationClass?: string;
+    delay?: any;
+    children: React.ReactNode;
+}
+export {};

package/dist/utils.d.ts

@@ -0,0 +1,21 @@
+export declare const promise: (time: number) => Promise<unknown>;
+export declare function throttle<T extends (...args: any[]) => void>(func: T, limit: number): T;
+export declare const debounceUtils: <T extends (...args: any[]) => void>(func: T, delay: number) => (...args: Parameters<T>) => void;
+export declare const isBrowser: boolean;
+export declare const isDev: boolean;
+export declare const isObject: (value: unknown) => value is Record<any, any>;
+export declare const isFunction: (value: unknown) => value is (...args: any) => any;
+export declare const isString: (value: unknown) => value is string;
+export declare const isBoolean: (value: unknown) => value is boolean;
+export declare const isNumber: (value: unknown) => value is number;
+export declare const isUndef: (value: unknown) => value is undefined;
+export declare const isAppleDevice: boolean;
+export declare const isNavigator: boolean;
+export declare const getScrollTop: (el: Document | Element) => number;
+export declare const getScrollHeight: (el: Document | Element) => number;
+export declare const getClientHeight: (el: Document | Element) => number;
+export declare function sleep(time: number): Promise<void>;
+export declare function request(req: any): Promise<unknown>;
+export declare const noop: () => void;
+export declare function on<T extends Window | Document | HTMLElement | EventTarget>(obj: T | null, ...args: Parameters<T['addEventListener']> | [string, Function | null, ...any]): void;
+export declare function off<T extends Window | Document | HTMLElement | EventTarget>(obj: T | null, ...args: Parameters<T['removeEventListener']> | [string, Function | null, ...any]): void;

package/package.json

@@ -1,61 +1,60 @@
-{
-  "name": "react-hook-toolkit",
-  "version": "1.1.9",
-  "description": "A collection of reusable React hooks for modern applications.",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "rollup -c --bundleConfigAsCjs",
-    "prepare": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "license": "MIT",
-  "engines": {
-    "node": ">=16.0.0"
-  },
-  "peerDependencies": {
-    "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^26.0.1",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.6",
-    "@types/crypto-js": "^4.2.2",
-    "@types/node": "^22.15.19",
-    "@types/react": "^18.2.0",
-    "@types/react-dom": "^18.2.0",
-    "postcss": "^8.5.3",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "rollup": "^4.18.1",
-    "rollup-plugin-dts": "^6.1.1",
-    "rollup-plugin-peer-deps-external": "^2.2.4",
-    "rollup-plugin-postcss": "^4.0.2",
-    "tslib": "^2.6.3",
-    "typescript": "^5.5.3"
-  },
-  "dependencies": {
-    "@emotion/react": "^11.14.0",
-    "@emotion/styled": "^11.14.0",
-    "@mui/icons-material": "^5.17.1",
-    "@mui/material": "^5.17.1",
-    "animate.css": "^4.1.1",
-    "axios": "^1.7.8",
-    "nprogress": "^0.2.0",
-    "react-error-boundary": "^4.0.13"
-  },
-  "keywords": [
-    "react",
-    "react-hooks",
-    "custom-hooks",
-    "hooks",
-    "utilities"
-  ],
-  "files": [
-    "dist"
-  ]
-}
+{
+  "name": "react-hook-toolkit",
+  "version": "1.2.1",
+  "description": "A collection of reusable React hooks for modern applications.",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "rollup -c --bundleConfigAsCjs",
+    "prepare": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Shivaji & Shyamal",
+  "license": "MIT",
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/crypto-js": "^4.2.2",
+    "postcss": "^8.5.3",
+    "@types/react": "18.2.20",
+    "@types/react-dom": "18.2.7",
+    "rollup": "^4.18.1",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-postcss": "^4.0.2",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "@types/node": "^22.13.10",
+    "@types/nprogress": "^0.2.3",
+    "tslib": "^2.6.3",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@emotion/react": "^11.14.0",
+    "@emotion/styled": "^11.14.0",
+    "@mui/icons-material": "5.14.0",
+    "@mui/material": "^5.14.0",
+    "animate.css": "^4.1.1",
+    "axios": "^1.7.8",
+    "nprogress": "^0.2.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-error-boundary": "^4.0.13"
+  },
+  "keywords": [
+    "react",
+    "react-hooks",
+    "custom-hooks",
+    "hooks",
+    "utilities"
+  ],
+  "files": [
+    "dist"
+  ]
+}