react-simplikit 0.0.46 → 0.0.48

package/README.md

@@ -1,42 +1,133 @@
-![react-simplikit](./src/public/images/og.png)
+# react-simplikit
 
-# react-simplikit · [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toss/slash/blob/main/LICENSE) [![codecov](https://codecov.io/gh/toss/react-simplikit/graph/badge.svg?token=RHVOZ3J3TU)](https://codecov.io/gh/toss/react-simplikit) [![Discord Badge](https://discord.com/api/guilds/1281071127052943361/widget.png?style=shield)](https://discord.gg/vGXbVjP2nY)
+[![npm version](https://img.shields.io/npm/v/react-simplikit.svg)](https://www.npmjs.com/package/react-simplikit)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toss/react-simplikit/blob/main/LICENSE)
+[![codecov](https://codecov.io/gh/toss/react-simplikit/graph/badge.svg?token=RHVOZ3J3TU)](https://codecov.io/gh/toss/react-simplikit)
 
-English | [Korean](./README-ko_kr.md)
+English | [한국어](./README-ko_kr.md)
 
-`react-simplikit` is a lightweight yet powerful library that provides various utilities for use in React environments.
+A lightweight, zero-dependency React utilities library providing hooks, components, and utilities.
 
-- `react-simplikit` is dependency-free, making it extremely lightweight.
-- `react-simplikit` guarantees reliability with 100% test coverage.
-- `react-simplikit` offers JSDoc comments, detailed documentation, and examples to ensure any developer can easily use it.
+## Features
 
-## Example
+- **Zero dependencies** - Extremely lightweight
+- **100% TypeScript** - Full type safety
+- **100% Test coverage** - Reliable and stable
+- **SSR-safe** - Works with Next.js and other SSR frameworks
+- **Tree-shakeable** - Only bundle what you use
+
+## Library Direction
+
+**react-simplikit is now maintained as a Universal Hook Library providing only pure state/logic hooks.**
+
+We are repositioning react-simplikit to focus exclusively on **platform-independent hooks** that work seamlessly across web and mobile (React Native, etc.).
+
+### What's Maintained: Pure State/Logic Hooks
+
+Hooks that don't depend on specific platform APIs will continue to be actively maintained:
+
+- State management hooks like `useToggle`, `useBooleanState`, `useCounter`
+- Lifecycle hooks like `usePrevious`, `useMount`
+- Utility hooks like `useDebounce`, `useThrottle`
+- **Backward compatibility (BC) is preserved** for these existing pure logic hooks
+
+### What's Deprecated: Browser/Platform-Dependent Hooks
+
+The following hooks that strongly depend on browser-specific APIs are now deprecated:
+
+- `useGeolocation` - depends on `navigator.geolocation`
+- `useStorageState` - depends on `localStorage`/`sessionStorage`
+- `useIntersectionObserver` - depends on `IntersectionObserver` API
+- `useImpressionRef` - depends on `IntersectionObserver` + Visibility API
+- `useDoubleClick`, `useLongPress` - depend on DOM events + `window.setTimeout`
+- `useOutsideClickEffect` - depends on DOM events + `document`
+- `useVisibilityEvent` - depends on `document.visibilityState`
+
+These hooks:
+
+- Will not receive new features or major enhancements
+- Are marked as `@deprecated` in documentation
+- May be removed in future major versions
+
+### Package Status
+
+- react-simplikit will **not be archived**
+- Pure state/logic hooks will continue to be maintained
+- Critical bug fixes and minimal maintenance will continue
+- No new browser/platform-dependent hooks will be added
+
+## Installation
+
+```bash
+npm install react-simplikit
+# or
+yarn add react-simplikit
+# or
+pnpm add react-simplikit
+```
+
+## Quick Start
 
 ```tsx
-import { useBooleanState } from 'react-simplikit';
-
-function Component() {
-  // using the `useBooleanState` hook to manage state.
-  const [open, openBottomSheet, closeBottomSheet, toggleBottomSheet] =
-    useBooleanState(false);
-
-  return (
-    <div>
-      <p>Bottom Sheet State: {open ? 'Open' : 'Closed'}</p>
-      <button onClick={openBottomSheet}>Open</button>
-      <button onClick={closeBottomSheet}>Close</button>
-      <button onClick={toggleBottomSheet}>Toggle</button>
-    </div>
-  );
+import { useState, useEffect } from 'react';
+import { useDebounce } from 'react-simplikit';
+
+function SearchInput() {
+  const [query, setQuery] = useState('');
+  const debouncedQuery = useDebounce(query, 300);
+
+  useEffect(() => {
+    if (debouncedQuery) {
+      searchAPI(debouncedQuery);
+    }
+  }, [debouncedQuery]);
+
+  return <input value={query} onChange={e => setQuery(e.target.value)} />;
 }
 ```
 
-## Contributing
+## What's Included
+
+### Hooks
+
+| Hook                      | Description                                         |
+| ------------------------- | --------------------------------------------------- |
+| `useBooleanState`         | Manage boolean state with handlers                  |
+| `useDebounce`             | Debounce a value                                    |
+| `useDebouncedCallback`    | Debounce a callback function                        |
+| `useInterval`             | Set up intervals declaratively                      |
+| `useIntersectionObserver` | Observe element visibility                          |
+| `usePreservedCallback`    | Stable callback reference                           |
+| `usePreservedReference`   | Stable object reference                             |
+| ...                       | [See all hooks](https://react-simplikit.slash.page) |
+
+### Components
 
-Contributions are welcome from everyone in the community. Please check the contribution guide linked below.
+| Component        | Description                       |
+| ---------------- | --------------------------------- |
+| `SwitchCase`     | Declarative switch-case rendering |
+| `Separated`      | Render items with separators      |
+| `ImpressionArea` | Track element impressions         |
+
+### Utilities
+
+| Utility  | Description       |
+| -------- | ----------------- |
+| `assert` | Runtime assertion |
+| `noop`   | Empty function    |
+
+## Documentation
+
+Visit [react-simplikit.slash.page](https://react-simplikit.slash.page) for full documentation.
+
+## Related Packages
+
+- [@react-simplikit/mobile](https://www.npmjs.com/package/@react-simplikit/mobile) - Mobile web utilities
+
+## Contributing
 
-[CONTRIBUTING](./src/docs/en/contributing.md)
+We welcome contributions! Please see our [Contributing Guide](https://github.com/toss/react-simplikit/blob/main/CONTRIBUTING.md).
 
 ## License
 
-MIT © Viva Republica, Inc. For more details, see [LICENSE](./LICENSE)
+MIT © Viva Republica, Inc. See [LICENSE](https://github.com/toss/react-simplikit/blob/main/LICENSE) for details.

package/dist/hooks/useDoubleClick/index.d.cts

@@ -6,6 +6,10 @@ type UseDoubleClickProps<E extends HTMLElement> = {
     doubleClick: (event: MouseEvent<E>) => void;
 };
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, window.setTimeout).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useDoubleClick` is a React hook that differentiates between single and double click events.
  * It delays the single click callback execution for a specified time, and cancels it if a second click (i.e. a double click) occurs within that time.

package/dist/hooks/useGeolocation/index.d.cts

@@ -24,6 +24,10 @@ type GeolocationOptions = {
     mountBehavior?: GeolocationMountBehaviorType;
 } & PositionOptions;
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (navigator.geolocation).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useGeolocation` is a React hook that retrieves and tracks the user's geographical location.
  * It uses the browser's `Geolocation API` to support both one-time position retrieval and continuous location tracking.

package/dist/hooks/useImpressionRef/index.d.cts

@@ -6,6 +6,10 @@ type UseImpressionRefOptions = Partial<{
     timeThreshold: number;
 }>;
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (IntersectionObserver, Visibility API).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useImpressionRef` is a React hook that measures the time a specific DOM element is visible on the screen and executes callbacks when the element enters or exits the viewport.
  * It uses `IntersectionObserver` and the `Visibility API` to track the element's visibility.

package/dist/hooks/useIntersectionObserver/index.d.cts

@@ -1,4 +1,8 @@
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (IntersectionObserver).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useIntersectionObserver` is a React hook that detects whether a specific DOM element is visible on the screen.
  * It uses the `IntersectionObserver` API to execute a callback when the element enters or exits the viewport.

package/dist/hooks/useLongPress/index.d.cts

@@ -11,6 +11,10 @@ type UseLongPressOptions<E extends HTMLElement> = {
     onLongPressEnd?: Handler<E>;
 };
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, window.setTimeout).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useLongPress` is a React hook that detects when an element is pressed and held for a specified duration.
  * It handles both mouse and touch events, making it work consistently across desktop and mobile devices.

package/dist/hooks/useOutsideClickEffect/index.d.cts

@@ -1,5 +1,9 @@
 type OneOrMore<T> = T | T[];
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, document).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useOutsideClickEffect` is a React hook that triggers a callback when a click event occurs outside the specified container(s).
  * It is useful for closing modals, dropdowns, tooltips, and other UI components when clicking outside.

package/dist/hooks/useStorageState/index.d.cts

@@ -22,6 +22,10 @@ type StorageStateOptionsWithSerializer<T> = StorageStateOptions<T> & {
 };
 type SerializableGuard<T extends readonly any[]> = T[0] extends any ? T : T[0] extends never ? 'Received a non-serializable value' : T;
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (localStorage/sessionStorage).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useStorageState` is a React that functions like `useState` but persists the state value in browser storage.
  * The value is retained across page reloads and can be shared between tabs when using `localStorage`.

package/dist/hooks/useVisibilityEvent/index.d.cts

@@ -2,6 +2,10 @@ type Options = {
     immediate?: boolean;
 };
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (document.visibilityState).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useVisibilityEvent` is a React hook that listens to changes in the document's visibility state and triggers a callback.
  *

package/esm/hooks/useDoubleClick/index.d.ts

@@ -6,6 +6,10 @@ type UseDoubleClickProps<E extends HTMLElement> = {
     doubleClick: (event: MouseEvent<E>) => void;
 };
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, window.setTimeout).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useDoubleClick` is a React hook that differentiates between single and double click events.
  * It delays the single click callback execution for a specified time, and cancels it if a second click (i.e. a double click) occurs within that time.

package/esm/hooks/useGeolocation/index.d.ts

@@ -24,6 +24,10 @@ type GeolocationOptions = {
     mountBehavior?: GeolocationMountBehaviorType;
 } & PositionOptions;
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (navigator.geolocation).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useGeolocation` is a React hook that retrieves and tracks the user's geographical location.
  * It uses the browser's `Geolocation API` to support both one-time position retrieval and continuous location tracking.

package/esm/hooks/useImpressionRef/index.d.ts

@@ -6,6 +6,10 @@ type UseImpressionRefOptions = Partial<{
     timeThreshold: number;
 }>;
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (IntersectionObserver, Visibility API).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useImpressionRef` is a React hook that measures the time a specific DOM element is visible on the screen and executes callbacks when the element enters or exits the viewport.
  * It uses `IntersectionObserver` and the `Visibility API` to track the element's visibility.

package/esm/hooks/useIntersectionObserver/index.d.ts

@@ -1,4 +1,8 @@
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (IntersectionObserver).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useIntersectionObserver` is a React hook that detects whether a specific DOM element is visible on the screen.
  * It uses the `IntersectionObserver` API to execute a callback when the element enters or exits the viewport.

package/esm/hooks/useLongPress/index.d.ts

@@ -11,6 +11,10 @@ type UseLongPressOptions<E extends HTMLElement> = {
     onLongPressEnd?: Handler<E>;
 };
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, window.setTimeout).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useLongPress` is a React hook that detects when an element is pressed and held for a specified duration.
  * It handles both mouse and touch events, making it work consistently across desktop and mobile devices.

package/esm/hooks/useOutsideClickEffect/index.d.ts

@@ -1,5 +1,9 @@
 type OneOrMore<T> = T | T[];
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, document).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useOutsideClickEffect` is a React hook that triggers a callback when a click event occurs outside the specified container(s).
  * It is useful for closing modals, dropdowns, tooltips, and other UI components when clicking outside.

package/esm/hooks/useStorageState/index.d.ts

@@ -22,6 +22,10 @@ type StorageStateOptionsWithSerializer<T> = StorageStateOptions<T> & {
 };
 type SerializableGuard<T extends readonly any[]> = T[0] extends any ? T : T[0] extends never ? 'Received a non-serializable value' : T;
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (localStorage/sessionStorage).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useStorageState` is a React that functions like `useState` but persists the state value in browser storage.
  * The value is retained across page reloads and can be shared between tabs when using `localStorage`.

package/esm/hooks/useVisibilityEvent/index.d.ts

@@ -2,6 +2,10 @@ type Options = {
     immediate?: boolean;
 };
 /**
+ * @deprecated This hook is deprecated as it depends on browser-specific APIs (document.visibilityState).
+ * react-simplikit is now focused on platform-independent, pure state/logic hooks.
+ * This hook will be removed in a future major version.
+ *
  * @description
  * `useVisibilityEvent` is a React hook that listens to changes in the document's visibility state and triggers a callback.
  *

package/package.json

@@ -1,7 +1,22 @@
 {
   "name": "react-simplikit",
-  "version": "0.0.46",
+  "version": "0.0.48",
   "main": "./dist/index.cjs",
+  "module": "./esm/index.js",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./esm/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
   "type": "module",
   "sideEffects": false,
   "keywords": [
@@ -11,7 +26,8 @@
   "bugs": "https://github.com/toss/react-simplikit/issues",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/toss/react-simplikit.git"
+    "url": "git+https://github.com/toss/react-simplikit.git",
+    "directory": "packages/core"
   },
   "license": "MIT",
   "files": [
@@ -19,43 +35,20 @@
     "esm/**/*"
   ],
   "scripts": {
-    "clean": "rimraf ./dist ./esm ./coverage ./node_modules",
-    "scaffold": "tsx .scripts/index.ts scaffold",
-    "docs:gen": "tsx .scripts/index.ts generate-docs",
-    "docs:dev": "vitepress dev",
-    "docs:build": "vitepress build",
-    "docs:preview": "vitepress preview",
-    "fix": "yarn run fix:lint && yarn run fix:format",
-    "fix:format": "prettier . --write",
-    "fix:lint": "eslint src --fix",
-    "test": "yarn run test:lint && yarn run test:format && yarn run test:type && yarn run test:spec && yarn run test:coverage",
-    "test:format": "prettier . --list-different",
-    "test:lint": "eslint src",
-    "test:type": "tsc --noEmit",
-    "test:spec": "vitest run",
-    "test:coverage": "vitest run --coverage",
-    "prepack": "tsup"
+    "build": "tsup",
+    "clean": "rimraf ./dist ./esm",
+    "lint": "eslint src",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
   },
   "publishConfig": {
-    "access": "public",
-    "main": "./dist/index.cjs",
-    "types": "./dist/index.d.cts",
-    "module": "./esm/index.js",
-    "exports": {
-      ".": {
-        "import": {
-          "types": "./esm/index.d.ts",
-          "default": "./esm/index.js"
-        },
-        "require": {
-          "types": "./dist/index.d.cts",
-          "default": "./dist/index.cjs"
-        }
-      },
-      "./package.json": "./package.json"
-    }
+    "access": "public"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^0.5.1",
+    "@changesets/cli": "^2.29.7",
     "@eslint/js": "^9.16.0",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/jest-dom": "^6.6.3",
@@ -100,21 +93,5 @@
   },
   "peerDependencies": {
     "react": "*"
-  },
-  "packageManager": "yarn@4.10.2",
-  "module": "./esm/index.js",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./esm/index.d.ts",
-        "default": "./esm/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    },
-    "./package.json": "./package.json"
-  },
-  "types": "./dist/index.d.cts"
-}
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Viva Republica, Inc
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.