hookery 1.0.0 → 1.0.1

package/README.md

@@ -1,17 +1,18 @@
 # Hookery 🪝
 
-The ultimate collection of **100+ high-quality React hooks**. Built for modern web applications with a focus on **performance**, **type safety**, and **developer experience**.
+The ultimate collection of **100+ high-quality React hooks**. Built for modern web applications with a focus on **performance**, **type safety**, and **minimal bundle size**.
 
 [![npm version](https://img.shields.io/npm/v/hookery.svg?style=flat-square)](https://www.npmjs.com/package/hookery)
-[![npm downloads](https://img.shields.io/npm/dm/hookery.svg?style=flat-square)](https://www.npmjs.com/package/hookery)
+[![Bundle Size](https://img.shields.io/badge/Unpacked_Size-215_KB-blue?style=flat-square)](#)
+[![Files](https://img.shields.io/badge/Total_Files-6-success?style=flat-square)](#)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue.svg?style=flat-square)](https://www.typescriptlang.org/)
 
 ## 🚀 Why Hookery?
 
+- **📦 Ultra-Lightweight**: Only **215 KB unpacked** (~55 KB bundled). One of the smallest libraries for its scale.
 - **🛡️ 100% Type Safe**: Written in TypeScript with strict type inference and zero "any".
-- **⚡ Performance First**: Zero unnecessary re-renders with optimized memoization.
-- **📦 Tree-shakeable**: Support for ESM and CJS; import only what you use.
+- **⚡ Performance First**: Zero unnecessary re-renders with optimized memoization and stable callbacks.
 - **🔌 SSR Ready**: First-class support for Next.js, Remix, and Astro.
 - **🤖 Modern Workflows**: Pre-built hooks for AI streaming, Media recording, and Hardware APIs.
 
@@ -47,38 +48,39 @@ function App() {
 }
 ```
 
-## 📚 Categories
+## 📚 Available Hooks (100+)
 
-| Category | Hooks |
-| :--- | :--- |
-| **State** | `useToggle`, `useCounter`, `useHistory`, `useLocalStorage`, `useSet`, `useMap` |
-| **DOM** | `useClickOutside`, `useHover`, `useIntersection`, `useResizeObserver`, `useScroll` |
-| **Async** | `useFetch`, `useAsync`, `useLLMStream`, `useWebSocket`, `useWorker` |
-| **Media** | `useMediaDevices`, `useMediaRecorder`, `useVideoRef`, `useAudioRef` |
-| **Advanced** | `useForm`, `useTable`, `useVirtualList`, `useInfiniteScroll`, `useShortcuts` |
+### 🛠️ Core Essentials
+`useIsomorphicLayoutEffect` • `useToggle` • `useCounter` • `usePrevious` • `useMount` • `useUnmount` • `useDebounce` • `useThrottle` • `useLocalStorage` • `useSessionStorage` • `useTimeout` • `useInterval` • `useUpdateEffect` • `useIsMounted` • `useStableCallback`
 
-## 🛠️ Browser & Hardware APIs
+### 🖱️ UI & Interaction
+`useMediaQuery` • `useWindowSize` • `useClickOutside` • `useHover` • `useKeyPress` • `useScroll` • `useIntersection` • `useCopyToClipboard` • `useDocumentTitle` • `useLockBodyScroll` • `useTheme` • `useEvent` • `useLongPress` • `useWindowFocus` • `useResizeObserver` • `useMutationObserver` • `usePageLeave` • `useEyeDropper` • `useScreen` • `useClickAnywhere`
 
-Hookery provides clean abstractions for many modern browser APIs:
-- **`useSTT` & `useTTS`**: Voice recognition and synthesis.
-- **`useFileSystem`**: Local File System Access.
-- **`useBluetooth` & `useWebRTC`**: Hardware and P2P communication.
-- **`useEyeDropper`**: System color picker.
+### 🌐 Browser & Hardware APIs
+`useOnline` • `useNetworkState` • `useFullscreen` • `useShare` • `usePermissions` • `useWakeLock` • `useMediaDevices` • `useMediaRecorder` • `useBattery` • `useBluetooth` • `useGamepad` • `useFileSystem` • `useStorageEstimate` • `useBroadcastChannel` • `useWebSocket` • `useWebRTC`
 
-## 🤝 Contributing
+### ⚡ Async, Data & Logic
+`useAsync` • `useFetch` • `useScript` • `useWorker` • `useIndexedDB` • `useHistory` • `useStep` • `usePagination` • `useMachine` • `useVirtualList` • `useInfiniteScroll` • `useForm` • `useTable` • `useSpreadsheet` • `useMarkdown` • `usePDF` • `useFileProcessing` • `useSortable` • `useDragAndDrop` • `useList` • `useMap` • `useSet` • `useQueue` • `useCountdown` • `useDebounceCallback` • `useIsClient`
 
-Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+### 🧠 AI & Search
+`useLLMStream` • `useSTT` • `useTTS` • `useOpenAI` • `useAnthropic` • `useGemini` • `useRAG` • `useEmbeddings` • `useSemanticSearch` • `useSearchHighlight`
 
-1. Fork the Project
-2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
-3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push to the Branch (`git push origin feature/AmazingFeature`)
-5. Open a Pull Request
+### 🎨 Animation & Graphics
+`useAnimate` • `useCanvas` • `useSpringCore` • `useParallax` • `useSVGAnimation` • `useThreeJS` • `useLottie` • `useFrameRate` • `useVideoRef` • `useAudioRef`
+
+## 🔌 Ecosystem Bridges
+Hookery includes built-in hooks to bridge with your favorite tools:
+- `useZodValidation`, `useYupValidation`
+- `useZustand`, `useRedux`, `useJotai`
+- `useFirebaseAuth`, `useSupabaseUser`
+- `useTanStackQuery`, `useAxios`
+- `useFramerMotion` (via `useAnimate`)
+- `useNextRouter`, `useRemixFetcher`
+- `useStripe`, `useAuth0`, `useClerk`
 
 ## 📄 License
 
 Distributed under the MIT License. See `LICENSE` for more information.
 
 ---
-
 Built with ❤️ by [Mohamed Shaban](https://github.com/Moshaban09)

package/dist/index.d.ts

@@ -2,6 +2,25 @@ import * as react from 'react';
 import { useEffect, EffectCallback, DependencyList, RefObject, UIEvent, MutableRefObject, FormEvent } from 'react';
 import { AnimationConfig, AnimationItem } from 'lottie-web';
 import * as THREE from 'three';
+import * as _auth0_auth0_spa_js from '@auth0/auth0-spa-js';
+import { AxiosError, AxiosResponse, AxiosRequestConfig } from 'axios';
+export { useAuth, useClerk, useUser } from '@clerk/clerk-react';
+import { Auth, User } from 'firebase/auth';
+import { WritableAtom, Atom } from 'jotai';
+export { useAtom, useAtomValue, useSetAtom } from 'jotai';
+import * as motion_dom from 'motion-dom';
+import { TypedUseSelectorHook } from 'react-redux';
+import { Dispatch } from 'redux';
+export { useActionData, useFetcher, useLoaderData, useNavigation, useSubmit } from '@remix-run/react';
+import * as _stripe_stripe_js from '@stripe/stripe-js';
+import { SupabaseClient, User as User$1 } from '@supabase/supabase-js';
+export { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
+import * as yup from 'yup';
+import { z } from 'zod';
+export { useAnimation, useMotionValue, useSpring, useTransform } from 'framer-motion';
+export { useAuth0 } from '@auth0/auth0-react';
+export { useElements, useStripe } from '@stripe/react-stripe-js';
+export { usePathname, useRouter, useSearchParams } from 'next/navigation';
 
 /**
  * useIsomorphicLayoutEffect
@@ -3127,4 +3146,131 @@ declare const isBrowser: boolean;
  */
 declare const noop: () => void;
 
-export { type AnimationCallback, type AnthropicMessage, type AnyEvent, type AsyncStatus, type BatteryState, type CellValue, type CollabEvent, type Column, type EyeDropperOpenOptions, type FetchStatus, type GeminiContent, type GeminiPart, type GridData, type HighlightPart, type MachineConfig, type MachineState, type Message, type NetworkState, type PermissionName, type PermissionState, type RAGDocument, type RecorderStatus, type ScriptStatus, type ScrollPosition, type SemanticResult, type ShareData, type ShortcutHandler, type ShortcutMap, type SortDirection, type SpringConfig, type StorageEstimateState, type Theme, type UseAnthropicOptions, type UseAsyncOptions, type UseAsyncReturn, type UseBluetoothReturn, type UseCalendarOptions, type UseCanvasOptions, type UseClickOutsideOptions, type UseCopyToClipboardReturn, type UseCountdownOptions, type UseCountdownReturn, type UseCounterOptions, type UseCounterReturn, type UseDebounceOptions, type UseDebounceReturn, type UseDocumentTitleOptions, type UseDragAndDropOptions, type UseEmbeddingsReturn, type UseEventOptions, type UseEyeDropperReturn, type UseFetchOptions, type UseFetchReturn, type UseFileProcessingOptions, type UseFileSystemReturn, type UseFormOptions, type UseFormReturn, type UseFullscreenReturn, type UseGamepadOptions, type UseGeminiOptions, type UseHistoryOptions, type UseHistoryReturn, type UseHoverReturn, type UseIndexedDBReturn, type UseInfiniteScrollOptions, type UseIntersectionOptions, type UseIntersectionReturn, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressOptions, type UseLLMStreamOptions, type UseLLMStreamReturn, type UseListActions, type UseListReturn, type UseLocalStorageOptions, type UseLocalStorageReturn, type UseLongPressOptions, type UseLongPressReturn, type UseLottieOptions, type UseMapActions, type UseMapReturn, type UseMediaQueryOptions, type UseMediaRecorderReturn, type UseMediaRefReturn, type UseMutationObserverOptions, type UseOnlineReturn, type UseOpenAIOptions, type UsePaginationOptions, type UsePaginationReturn, type UseParallaxOptions, type UseQueueActions, type UseQueueReturn, type UseRAGOptions, type UseResizeObserverOptions, type UseSTTOptions, type UseSTTReturn, type UseSVGAnimationOptions, type UseScriptOptions, type UseScriptReturn, type UseScrollOptions, type UseScrollReturn, type UseSearchHighlightOptions, type UseSessionStorageOptions, type UseSetActions, type UseSetReturn, type UseShareReturn, type UseSortableOptions, type UseSpreadsheetOptions, type UseSpringCoreOptions, type UseStepOptions, type UseStepReturn, type UseTTSOptions, type UseTableOptions, type UseTableReturn, type UseThemeOptions, type UseThemeReturn, type UseThreeJSOptions, type UseThrottleOptions, type UseThrottleReturn, type UseTimeoutOptions, type UseTimeoutReturn, type UseToggleOptions, type UseToggleReturn, type UseVirtualListOptions, type UseVirtualListReturn, type UseWakeLockReturn, type UseWebRTCOptions, type UseWebSocketOptions, type UseWindowSizeOptions, type UseWorkerReturn, type Vector, type VirtualItem, type WindowSize, type WorkerStatus, isBrowser, isServer, noop, useAnimate, useAnthropic, useAsync, useAudioRef, useBattery, useBluetooth, useBroadcastChannel, useCalendar, useCanvas, useClickAnywhere, useClickOutside, useCopyToClipboard, useCountdown, useCounter, useDebounce, useDebounceCallback, useDocumentTitle, useDragAndDrop, useEmbeddings, useEvent, useEyeDropper, useFetch, useFileProcessing, useFileSystem, useForm, useFrameRate, useFullscreen, useGamepad, useGemini, useHistory, useHover, useIndexedDB, useInfiniteScroll, useIntersection, useInterval, useIsClient, useIsMounted, useIsomorphicLayoutEffect, useKeyPress, useLLMStream, useList, useLocalStorage, useLockBodyScroll, useLongPress, useLottie, useMachine, useMap, useMarkdown, useMediaDevices, useMediaQuery, useMediaRecorder, useMount, useMutationObserver, useNetworkState, useOnline, useOpenAI, usePDF, usePageLeave, usePagination, useParallax, usePermissions, usePresence, usePrevious, useQueue, useRAG, useRealtimeCollab, useResizeObserver, useSTT, useSVGAnimation, useScreen, useScript, useScroll, useSearchHighlight, useSemanticSearch, useSessionStorage, useSet, useShare, useShortcuts, useSortable, useSpreadsheet, useSpringCore, useStableCallback, useStep, useStorageEstimate, useTTS, useTable, useTheme, useThreeJS, useThrottle, useTimeout, useToggle, useUnmount, useUpdateEffect, useVideoRef, useVirtualList, useWakeLock, useWebRTC, useWebSocket, useWindowFocus, useWindowSize, useWorker };
+/**
+ * useAuth0User
+ *
+ * Simplified access to user and loading state.
+ */
+declare function useAuth0User(): {
+    user: _auth0_auth0_spa_js.User | undefined;
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    error: Error | undefined;
+};
+
+interface UseAxiosReturn<T> {
+    data: T | null;
+    loading: boolean;
+    error: AxiosError | null;
+    response: AxiosResponse<T> | null;
+    execute: (config?: AxiosRequestConfig) => Promise<void>;
+}
+/**
+ * useAxios
+ *
+ * A hook for Axios requests with state management.
+ */
+declare function useAxios<T = any>(url: string, initialConfig?: AxiosRequestConfig, manual?: boolean): UseAxiosReturn<T>;
+
+/**
+ * useFirebaseAuth
+ *
+ * Tracks Firebase Auth state.
+ */
+declare function useFirebaseAuth(auth: Auth): {
+    user: User | null;
+    loading: boolean;
+    error: Error | null;
+};
+
+/**
+ * useJotai
+ *
+ * A bridge for Jotai providing unified access.
+ */
+declare function useJotai<Value, Args extends unknown[], Result>(atom: WritableAtom<Value, Args, Result> | Atom<Value>): readonly [unknown, (...args: unknown[]) => unknown];
+
+declare function useScrollProgress(): motion_dom.MotionValue<number>;
+
+/**
+ * useMounted
+ *
+ * Ensures component is mounted before rendering (avoids hydration mismatch).
+ */
+declare function useMounted(): boolean;
+
+/**
+ * useRedux
+ *
+ * A combined hook for Redux accessing state and dispatch.
+ */
+declare function useRedux<RootState = any, AppDispatch extends Dispatch<any> = Dispatch<any>>(): {
+    dispatch: AppDispatch;
+    useSelector: TypedUseSelectorHook<RootState>;
+    select: TypedUseSelectorHook<RootState>;
+};
+
+/**
+ * useStripePayment
+ *
+ * Helper to consolidate Stripe objects.
+ */
+declare function useStripePayment(): {
+    stripe: _stripe_stripe_js.Stripe | null;
+    elements: _stripe_stripe_js.StripeElements | null;
+    ready: boolean;
+};
+
+/**
+ * useSupabaseUser
+ *
+ * Tracks Supabase Auth user.
+ */
+declare function useSupabaseUser(client: SupabaseClient): {
+    user: User$1 | null;
+    loading: boolean;
+};
+
+interface UseYupValidationReturn<T> {
+    isValid: boolean;
+    errors: Record<string, string> | null;
+    error: yup.ValidationError | null;
+    validate: (value: unknown) => Promise<boolean>;
+}
+/**
+ * useYupValidation
+ *
+ * A hook to validate data using Yup schema.
+ */
+declare function useYupValidation<T extends yup.AnySchema>(schema: T): UseYupValidationReturn<yup.InferType<T>>;
+
+interface UseZodValidationReturn<T> {
+    isValid: boolean;
+    errors: Record<string, string> | null;
+    error: z.ZodError | null;
+    validate: (value: unknown) => boolean;
+}
+/**
+ * useZodValidation
+ *
+ * A hook to validate data using Zod schema.
+ *
+ * @param schema - Zod schema
+ * @returns Validation utilities
+ */
+declare function useZodValidation<T extends z.ZodTypeAny>(schema: T): UseZodValidationReturn<z.infer<T>>;
+
+/**
+ * useZustand
+ *
+ * A bridge hook for Zustand.
+ * Mainly a simplified re-export to align with Hookery patterns,
+ * but allows for future extensibility (e.g. automatic persistence).
+ */
+declare function useZustand<T, U>(store: {
+    getState: () => T;
+    subscribe: (listener: (state: T, prevState: T) => void) => () => void;
+    getInitialState: () => T;
+}, selector: (state: T) => U): U;
+
+export { type AnimationCallback, type AnthropicMessage, type AnyEvent, type AsyncStatus, type BatteryState, type CellValue, type CollabEvent, type Column, type EyeDropperOpenOptions, type FetchStatus, type GeminiContent, type GeminiPart, type GridData, type HighlightPart, type MachineConfig, type MachineState, type Message, type NetworkState, type PermissionName, type PermissionState, type RAGDocument, type RecorderStatus, type ScriptStatus, type ScrollPosition, type SemanticResult, type ShareData, type ShortcutHandler, type ShortcutMap, type SortDirection, type SpringConfig, type StorageEstimateState, type Theme, type UseAnthropicOptions, type UseAsyncOptions, type UseAsyncReturn, type UseAxiosReturn, type UseBluetoothReturn, type UseCalendarOptions, type UseCanvasOptions, type UseClickOutsideOptions, type UseCopyToClipboardReturn, type UseCountdownOptions, type UseCountdownReturn, type UseCounterOptions, type UseCounterReturn, type UseDebounceOptions, type UseDebounceReturn, type UseDocumentTitleOptions, type UseDragAndDropOptions, type UseEmbeddingsReturn, type UseEventOptions, type UseEyeDropperReturn, type UseFetchOptions, type UseFetchReturn, type UseFileProcessingOptions, type UseFileSystemReturn, type UseFormOptions, type UseFormReturn, type UseFullscreenReturn, type UseGamepadOptions, type UseGeminiOptions, type UseHistoryOptions, type UseHistoryReturn, type UseHoverReturn, type UseIndexedDBReturn, type UseInfiniteScrollOptions, type UseIntersectionOptions, type UseIntersectionReturn, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressOptions, type UseLLMStreamOptions, type UseLLMStreamReturn, type UseListActions, type UseListReturn, type UseLocalStorageOptions, type UseLocalStorageReturn, type UseLongPressOptions, type UseLongPressReturn, type UseLottieOptions, type UseMapActions, type UseMapReturn, type UseMediaQueryOptions, type UseMediaRecorderReturn, type UseMediaRefReturn, type UseMutationObserverOptions, type UseOnlineReturn, type UseOpenAIOptions, type UsePaginationOptions, type UsePaginationReturn, type UseParallaxOptions, type UseQueueActions, type UseQueueReturn, type UseRAGOptions, type UseResizeObserverOptions, type UseSTTOptions, type UseSTTReturn, type UseSVGAnimationOptions, type UseScriptOptions, type UseScriptReturn, type UseScrollOptions, type UseScrollReturn, type UseSearchHighlightOptions, type UseSessionStorageOptions, type UseSetActions, type UseSetReturn, type UseShareReturn, type UseSortableOptions, type UseSpreadsheetOptions, type UseSpringCoreOptions, type UseStepOptions, type UseStepReturn, type UseTTSOptions, type UseTableOptions, type UseTableReturn, type UseThemeOptions, type UseThemeReturn, type UseThreeJSOptions, type UseThrottleOptions, type UseThrottleReturn, type UseTimeoutOptions, type UseTimeoutReturn, type UseToggleOptions, type UseToggleReturn, type UseVirtualListOptions, type UseVirtualListReturn, type UseWakeLockReturn, type UseWebRTCOptions, type UseWebSocketOptions, type UseWindowSizeOptions, type UseWorkerReturn, type UseYupValidationReturn, type UseZodValidationReturn, type Vector, type VirtualItem, type WindowSize, type WorkerStatus, isBrowser, isServer, noop, useAnimate, useAnthropic, useAsync, useAudioRef, useAuth0User, useAxios, useBattery, useBluetooth, useBroadcastChannel, useCalendar, useCanvas, useClickAnywhere, useClickOutside, useCopyToClipboard, useCountdown, useCounter, useDebounce, useDebounceCallback, useDocumentTitle, useDragAndDrop, useEmbeddings, useEvent, useEyeDropper, useFetch, useFileProcessing, useFileSystem, useFirebaseAuth, useForm, useFrameRate, useFullscreen, useGamepad, useGemini, useHistory, useHover, useIndexedDB, useInfiniteScroll, useIntersection, useInterval, useIsClient, useIsMounted, useIsomorphicLayoutEffect, useJotai, useKeyPress, useLLMStream, useList, useLocalStorage, useLockBodyScroll, useLongPress, useLottie, useMachine, useMap, useMarkdown, useMediaDevices, useMediaQuery, useMediaRecorder, useMount, useMounted, useMutationObserver, useNetworkState, useOnline, useOpenAI, usePDF, usePageLeave, usePagination, useParallax, usePermissions, usePresence, usePrevious, useQueue, useRAG, useRealtimeCollab, useRedux, useResizeObserver, useSTT, useSVGAnimation, useScreen, useScript, useScroll, useScrollProgress, useSearchHighlight, useSemanticSearch, useSessionStorage, useSet, useShare, useShortcuts, useSortable, useSpreadsheet, useSpringCore, useStableCallback, useStep, useStorageEstimate, useStripePayment, useSupabaseUser, useTTS, useTable, useTheme, useThreeJS, useThrottle, useTimeout, useToggle, useUnmount, useUpdateEffect, useVideoRef, useVirtualList, useWakeLock, useWebRTC, useWebSocket, useWindowFocus, useWindowSize, useWorker, useYupValidation, useZodValidation, useZustand };