@usefy/usefy 0.0.13 → 0.0.15

package/README.md

@@ -27,13 +27,12 @@
   <a href="#installation">Installation</a> •
   <a href="#packages">Packages</a> •
   <a href="#quick-start">Quick Start</a> •
-  <a href="#features">Features</a> •
-  <a href="#contributing">Contributing</a>
+  <a href="#features">Features</a>
 </p>
 
 ---
 
-> ⚠️ **Pre-release Notice**: This project is currently in version `0.x.x` (alpha/beta stage). APIs may change between minor versions. While fully functional and tested, please use with caution in production environments. We welcome feedback and contributions to help stabilize the API!
+> ⚠️ **Pre-release Notice**: This project is currently in version `0.x.x` (alpha/beta stage). APIs may change between minor versions. While fully functional and tested, please use with caution in production environments.
 >
 > 🚧 **Actively Developing**: New hooks are being added regularly. Stay tuned for more utilities!
 
@@ -48,7 +47,7 @@
 - **🚀 Zero Dependencies** — Pure React implementation with no external dependencies
 - **📦 Tree Shakeable** — Import only the hooks you need to optimize bundle size
 - **🔷 TypeScript First** — Complete type safety with full autocomplete support
-- **⚡ SSR Compatible** — Works seamlessly with Next.js, Remix, and other SSR frameworks
+- **⚡ SSR Safe** — Works with Next.js, Remix, and other SSR frameworks without crashing
 - **🧪 Well Tested** — High test coverage ensures reliability and stability
 - **📖 Well Documented** — Detailed documentation with practical examples
 
@@ -393,45 +392,20 @@ All packages are comprehensively tested using Vitest to ensure reliability and s
 
 ---
 
-## Contributing
+## SSR Compatibility
 
-We welcome contributions! Please see our [Contributing Guide](https://github.com/geon0529/usefy/blob/master/CONTRIBUTING.md) for details.
+All hooks are SSR-safe and will not throw errors on the server.
 
-```bash
-# Clone the repository
-git clone https://github.com/geon0529/usefy.git
-
-# Install dependencies
-pnpm install
-
-# Run tests
-pnpm test
+| Hook                                         | SSR Behavior                                     |
+| -------------------------------------------- | ------------------------------------------------ |
+| `useToggle`, `useCounter`                    | ✅ Fully compatible (pure React state)           |
+| `useDebounce`, `useThrottle`                 | ✅ Fully compatible (uses `setTimeout`)          |
+| `useDebounceCallback`, `useThrottleCallback` | ✅ Fully compatible                              |
+| `useLocalStorage`, `useSessionStorage`       | ✅ Safe — returns `initialValue` on server       |
+| `useClickAnyWhere`                           | ✅ Safe — event listener only attached on client |
+| `useCopyToClipboard`                         | ✅ Safe — copy function only works on client     |
 
-# Build all packages
-pnpm build
-
-# Run tests with coverage
-pnpm test --coverage
-```
-
-### 🗂️ Project Structure
-
-```
-usefy/
-├── packages/
-│   ├── usefy/                 # All-in-one package
-│   ├── use-toggle/            # Boolean state
-│   ├── use-counter/           # Counter state
-│   ├── use-debounce/          # Value debouncing
-│   ├── use-debounce-callback/ # Callback debouncing
-│   ├── use-throttle/          # Value throttling
-│   ├── use-throttle-callback/ # Callback throttling
-│   ├── use-local-storage/     # localStorage
-│   ├── use-session-storage/   # sessionStorage
-│   ├── use-click-any-where/   # Click detection
-│   └── use-copy-to-clipboard/ # Clipboard
-└── ...
-```
+> **Note**: `useLocalStorage` and `useSessionStorage` include proper `typeof window` checks and will gracefully fall back to `initialValue` during server-side rendering.
 
 ---
 

package/dist/index.d.mts

@@ -8,3 +8,4 @@ export { UseThrottleOptions, useThrottle } from '@usefy/use-throttle';
 export { ThrottledFunction, UseThrottleCallbackOptions, useThrottleCallback } from '@usefy/use-throttle-callback';
 export { InitialValue, UseLocalStorageOptions, UseLocalStorageReturn, useLocalStorage } from '@usefy/use-local-storage';
 export { InitialValue as SessionStorageInitialValue, UseSessionStorageOptions, UseSessionStorageReturn, useSessionStorage } from '@usefy/use-session-storage';
+export { ClickOutsideEvent, MouseEventType, OnClickOutsideHandler, RefTarget, TouchEventType, UseOnClickOutsideOptions, useOnClickOutside } from '@usefy/use-on-click-outside';

package/dist/index.d.ts

@@ -8,3 +8,4 @@ export { UseThrottleOptions, useThrottle } from '@usefy/use-throttle';
 export { ThrottledFunction, UseThrottleCallbackOptions, useThrottleCallback } from '@usefy/use-throttle-callback';
 export { InitialValue, UseLocalStorageOptions, UseLocalStorageReturn, useLocalStorage } from '@usefy/use-local-storage';
 export { InitialValue as SessionStorageInitialValue, UseSessionStorageOptions, UseSessionStorageReturn, useSessionStorage } from '@usefy/use-session-storage';
+export { ClickOutsideEvent, MouseEventType, OnClickOutsideHandler, RefTarget, TouchEventType, UseOnClickOutsideOptions, useOnClickOutside } from '@usefy/use-on-click-outside';

package/dist/index.js

@@ -26,6 +26,7 @@ __export(index_exports, {
   useDebounce: () => import_use_debounce.useDebounce,
   useDebounceCallback: () => import_use_debounce_callback.useDebounceCallback,
   useLocalStorage: () => import_use_local_storage.useLocalStorage,
+  useOnClickOutside: () => import_use_on_click_outside.useOnClickOutside,
   useSessionStorage: () => import_use_session_storage.useSessionStorage,
   useThrottle: () => import_use_throttle.useThrottle,
   useThrottleCallback: () => import_use_throttle_callback.useThrottleCallback,
@@ -42,6 +43,7 @@ var import_use_throttle = require("@usefy/use-throttle");
 var import_use_throttle_callback = require("@usefy/use-throttle-callback");
 var import_use_local_storage = require("@usefy/use-local-storage");
 var import_use_session_storage = require("@usefy/use-session-storage");
+var import_use_on_click_outside = require("@usefy/use-on-click-outside");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   useClickAnyWhere,
@@ -50,6 +52,7 @@ var import_use_session_storage = require("@usefy/use-session-storage");
   useDebounce,
   useDebounceCallback,
   useLocalStorage,
+  useOnClickOutside,
   useSessionStorage,
   useThrottle,
   useThrottleCallback,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Re-export all hooks from individual packages\n\n// useClickAnyWhere\nexport {\n  useClickAnyWhere,\n  type UseClickAnyWhereOptions,\n  type ClickAnyWhereHandler,\n} from \"@usefy/use-click-any-where\";\n\n// useCopyToClipboard\nexport {\n  useCopyToClipboard,\n  type UseCopyToClipboardOptions,\n  type UseCopyToClipboardReturn,\n  type CopyFn,\n} from \"@usefy/use-copy-to-clipboard\";\n\n// useCounter\nexport { useCounter } from \"@usefy/use-counter\";\n\n// useToggle\nexport { useToggle, type UseToggleReturn } from \"@usefy/use-toggle\";\n\n// useDebounce\nexport { useDebounce, type UseDebounceOptions } from \"@usefy/use-debounce\";\n\n// useDebounceCallback\nexport {\n  useDebounceCallback,\n  type UseDebounceCallbackOptions,\n  type DebouncedFunction,\n} from \"@usefy/use-debounce-callback\";\n\n// useThrottle\nexport { useThrottle, type UseThrottleOptions } from \"@usefy/use-throttle\";\n\n// useThrottleCallback\nexport {\n  useThrottleCallback,\n  type UseThrottleCallbackOptions,\n  type ThrottledFunction,\n} from \"@usefy/use-throttle-callback\";\n\n// useLocalStorage\nexport {\n  useLocalStorage,\n  type UseLocalStorageOptions,\n  type UseLocalStorageReturn,\n  type InitialValue,\n} from \"@usefy/use-local-storage\";\n\n// useSessionStorage\nexport {\n  useSessionStorage,\n  type UseSessionStorageOptions,\n  type UseSessionStorageReturn,\n  type InitialValue as SessionStorageInitialValue,\n} from \"@usefy/use-session-storage\";\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,iCAIO;AAGP,mCAKO;AAGP,yBAA2B;AAG3B,wBAAgD;AAGhD,0BAAqD;AAGrD,mCAIO;AAGP,0BAAqD;AAGrD,mCAIO;AAGP,+BAKO;AAGP,iCAKO;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Re-export all hooks from individual packages\n\n// useClickAnyWhere\nexport {\n  useClickAnyWhere,\n  type UseClickAnyWhereOptions,\n  type ClickAnyWhereHandler,\n} from \"@usefy/use-click-any-where\";\n\n// useCopyToClipboard\nexport {\n  useCopyToClipboard,\n  type UseCopyToClipboardOptions,\n  type UseCopyToClipboardReturn,\n  type CopyFn,\n} from \"@usefy/use-copy-to-clipboard\";\n\n// useCounter\nexport { useCounter } from \"@usefy/use-counter\";\n\n// useToggle\nexport { useToggle, type UseToggleReturn } from \"@usefy/use-toggle\";\n\n// useDebounce\nexport { useDebounce, type UseDebounceOptions } from \"@usefy/use-debounce\";\n\n// useDebounceCallback\nexport {\n  useDebounceCallback,\n  type UseDebounceCallbackOptions,\n  type DebouncedFunction,\n} from \"@usefy/use-debounce-callback\";\n\n// useThrottle\nexport { useThrottle, type UseThrottleOptions } from \"@usefy/use-throttle\";\n\n// useThrottleCallback\nexport {\n  useThrottleCallback,\n  type UseThrottleCallbackOptions,\n  type ThrottledFunction,\n} from \"@usefy/use-throttle-callback\";\n\n// useLocalStorage\nexport {\n  useLocalStorage,\n  type UseLocalStorageOptions,\n  type UseLocalStorageReturn,\n  type InitialValue,\n} from \"@usefy/use-local-storage\";\n\n// useSessionStorage\nexport {\n  useSessionStorage,\n  type UseSessionStorageOptions,\n  type UseSessionStorageReturn,\n  type InitialValue as SessionStorageInitialValue,\n} from \"@usefy/use-session-storage\";\n\n// useOnClickOutside\nexport {\n  useOnClickOutside,\n  type UseOnClickOutsideOptions,\n  type OnClickOutsideHandler,\n  type ClickOutsideEvent,\n  type RefTarget,\n  type MouseEventType,\n  type TouchEventType,\n} from \"@usefy/use-on-click-outside\";\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,iCAIO;AAGP,mCAKO;AAGP,yBAA2B;AAG3B,wBAAgD;AAGhD,0BAAqD;AAGrD,mCAIO;AAGP,0BAAqD;AAGrD,mCAIO;AAGP,+BAKO;AAGP,iCAKO;AAGP,kCAQO;","names":[]}

package/dist/index.mjs

@@ -21,6 +21,9 @@ import {
 import {
   useSessionStorage
 } from "@usefy/use-session-storage";
+import {
+  useOnClickOutside
+} from "@usefy/use-on-click-outside";
 export {
   useClickAnyWhere,
   useCopyToClipboard,
@@ -28,6 +31,7 @@ export {
   useDebounce,
   useDebounceCallback,
   useLocalStorage,
+  useOnClickOutside,
   useSessionStorage,
   useThrottle,
   useThrottleCallback,

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Re-export all hooks from individual packages\n\n// useClickAnyWhere\nexport {\n  useClickAnyWhere,\n  type UseClickAnyWhereOptions,\n  type ClickAnyWhereHandler,\n} from \"@usefy/use-click-any-where\";\n\n// useCopyToClipboard\nexport {\n  useCopyToClipboard,\n  type UseCopyToClipboardOptions,\n  type UseCopyToClipboardReturn,\n  type CopyFn,\n} from \"@usefy/use-copy-to-clipboard\";\n\n// useCounter\nexport { useCounter } from \"@usefy/use-counter\";\n\n// useToggle\nexport { useToggle, type UseToggleReturn } from \"@usefy/use-toggle\";\n\n// useDebounce\nexport { useDebounce, type UseDebounceOptions } from \"@usefy/use-debounce\";\n\n// useDebounceCallback\nexport {\n  useDebounceCallback,\n  type UseDebounceCallbackOptions,\n  type DebouncedFunction,\n} from \"@usefy/use-debounce-callback\";\n\n// useThrottle\nexport { useThrottle, type UseThrottleOptions } from \"@usefy/use-throttle\";\n\n// useThrottleCallback\nexport {\n  useThrottleCallback,\n  type UseThrottleCallbackOptions,\n  type ThrottledFunction,\n} from \"@usefy/use-throttle-callback\";\n\n// useLocalStorage\nexport {\n  useLocalStorage,\n  type UseLocalStorageOptions,\n  type UseLocalStorageReturn,\n  type InitialValue,\n} from \"@usefy/use-local-storage\";\n\n// useSessionStorage\nexport {\n  useSessionStorage,\n  type UseSessionStorageOptions,\n  type UseSessionStorageReturn,\n  type InitialValue as SessionStorageInitialValue,\n} from \"@usefy/use-session-storage\";\n"],"mappings":";AAGA;AAAA,EACE;AAAA,OAGK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP,SAAS,kBAAkB;AAG3B,SAAS,iBAAuC;AAGhD,SAAS,mBAA4C;AAGrD;AAAA,EACE;AAAA,OAGK;AAGP,SAAS,mBAA4C;AAGrD;AAAA,EACE;AAAA,OAGK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP;AAAA,EACE;AAAA,OAIK;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Re-export all hooks from individual packages\n\n// useClickAnyWhere\nexport {\n  useClickAnyWhere,\n  type UseClickAnyWhereOptions,\n  type ClickAnyWhereHandler,\n} from \"@usefy/use-click-any-where\";\n\n// useCopyToClipboard\nexport {\n  useCopyToClipboard,\n  type UseCopyToClipboardOptions,\n  type UseCopyToClipboardReturn,\n  type CopyFn,\n} from \"@usefy/use-copy-to-clipboard\";\n\n// useCounter\nexport { useCounter } from \"@usefy/use-counter\";\n\n// useToggle\nexport { useToggle, type UseToggleReturn } from \"@usefy/use-toggle\";\n\n// useDebounce\nexport { useDebounce, type UseDebounceOptions } from \"@usefy/use-debounce\";\n\n// useDebounceCallback\nexport {\n  useDebounceCallback,\n  type UseDebounceCallbackOptions,\n  type DebouncedFunction,\n} from \"@usefy/use-debounce-callback\";\n\n// useThrottle\nexport { useThrottle, type UseThrottleOptions } from \"@usefy/use-throttle\";\n\n// useThrottleCallback\nexport {\n  useThrottleCallback,\n  type UseThrottleCallbackOptions,\n  type ThrottledFunction,\n} from \"@usefy/use-throttle-callback\";\n\n// useLocalStorage\nexport {\n  useLocalStorage,\n  type UseLocalStorageOptions,\n  type UseLocalStorageReturn,\n  type InitialValue,\n} from \"@usefy/use-local-storage\";\n\n// useSessionStorage\nexport {\n  useSessionStorage,\n  type UseSessionStorageOptions,\n  type UseSessionStorageReturn,\n  type InitialValue as SessionStorageInitialValue,\n} from \"@usefy/use-session-storage\";\n\n// useOnClickOutside\nexport {\n  useOnClickOutside,\n  type UseOnClickOutsideOptions,\n  type OnClickOutsideHandler,\n  type ClickOutsideEvent,\n  type RefTarget,\n  type MouseEventType,\n  type TouchEventType,\n} from \"@usefy/use-on-click-outside\";\n"],"mappings":";AAGA;AAAA,EACE;AAAA,OAGK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP,SAAS,kBAAkB;AAG3B,SAAS,iBAAuC;AAGhD,SAAS,mBAA4C;AAGrD;AAAA,EACE;AAAA,OAGK;AAGP,SAAS,mBAA4C;AAGrD;AAAA,EACE;AAAA,OAGK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP;AAAA,EACE;AAAA,OAOK;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usefy/usefy",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "A collection of useful React hooks",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -17,16 +17,17 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@usefy/use-click-any-where": "0.0.13",
-    "@usefy/use-copy-to-clipboard": "0.0.13",
-    "@usefy/use-counter": "0.0.13",
-    "@usefy/use-toggle": "0.0.13",
-    "@usefy/use-debounce-callback": "0.0.13",
-    "@usefy/use-debounce": "0.0.13",
-    "@usefy/use-throttle": "0.0.13",
-    "@usefy/use-throttle-callback": "0.0.13",
-    "@usefy/use-session-storage": "0.0.13",
-    "@usefy/use-local-storage": "0.0.13"
+    "@usefy/use-click-any-where": "0.0.15",
+    "@usefy/use-copy-to-clipboard": "0.0.15",
+    "@usefy/use-counter": "0.0.15",
+    "@usefy/use-toggle": "0.0.15",
+    "@usefy/use-throttle": "0.0.15",
+    "@usefy/use-debounce-callback": "0.0.15",
+    "@usefy/use-debounce": "0.0.15",
+    "@usefy/use-throttle-callback": "0.0.15",
+    "@usefy/use-local-storage": "0.0.15",
+    "@usefy/use-session-storage": "0.0.15",
+    "@usefy/use-on-click-outside": "0.0.15"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0"