@musecat/functionkit 1.0.2 → 1.2.0

package/.agents/references/utils/buildContext.md

@@ -1,47 +0,0 @@
-# buildContext
-
-## Purpose
-
-Eliminates `createContext` + `Provider` + `useContext` boilerplate. Creates a type-safe context pair in a single call: a typed accessor hook and a Provider component with automatic value memoization.
-
-## Usage Logic
-
-Creates a React context with the generic type `T`. Returns a tuple `[useCtx, Provider]`. The Provider wraps its `value` in `useMemo` to prevent unnecessary re-renders. If `displayName` is provided, it's assigned to the context for DevTools.
-
-## Type Signature
-
-```ts
-function buildContext<T>(
-  displayName?: string
-): [
-  useCtx: () => T,
-  Provider: React.FC<{ value: T; children: ReactNode }>
-];
-```
-
-## Example Code
-
-```tsx
-import { buildContext } from "@musecat/functionkit";
-
-interface Theme {
-  color: string;
-  bg: string;
-}
-
-const [useTheme, ThemeProvider] = buildContext<Theme>("ThemeContext");
-
-// Usage
-function App() {
-  return (
-    <ThemeProvider value={{ color: "#000", bg: "#fff" }}>
-      <ThemedButton />
-    </ThemeProvider>
-  );
-}
-
-function ThemedButton() {
-  const theme = useTheme();
-  return <button style={{ color: theme.color, background: theme.bg }}>Click</button>;
-}
-```

package/.agents/references/utils/clipboardShare.md

@@ -1,59 +0,0 @@
-# NavigatorClipboard / NavigatorShare (clipboardShare)
-
-## Purpose
-
-Provides easy-to-use React components for clipboard copy and native share. Handles error cases with automatic fallback (e.g., if `navigator.share` fails, falls back to clipboard).
-
-## Usage Logic
-
-**NavigatorClipboard**: On click, calls `navigator.clipboard.writeText(text)`. Calls `onComplete` with the result.
-
-**NavigatorShare**: On click, calls `navigator.share({ title, text, url })`. If share fails (or is unavailable), falls back to clipboard copy and calls `onComplete` with fallback info.
-
-## Type Signatures
-
-```ts
-interface NavigatorClipboardProps {
-  text: string;
-  onComplete?: (result: NavigatorClipboardResult) => void;
-  children?: ReactNode;
-}
-
-interface NavigatorShareProps {
-  title?: string;
-  text?: string;
-  url?: string;
-  onComplete?: (result: NavigatorShareResult) => void;
-  children?: ReactNode;
-}
-
-interface NavigatorClipboardResult {
-  copied: boolean;
-  error?: Error;
-}
-
-interface NavigatorShareResult {
-  shared: boolean;
-  copied: boolean;
-  error?: Error;
-}
-```
-
-## Example Code
-
-```tsx
-import { NavigatorClipboard, NavigatorShare } from "@musecat/functionkit";
-
-function ShareButton({ url }: { url: string }) {
-  return (
-    <div>
-      <NavigatorClipboard text={url}>
-        <button>Copy Link</button>
-      </NavigatorClipboard>
-      <NavigatorShare title="Check this out" url={url}>
-        <button>Share</button>
-      </NavigatorShare>
-    </div>
-  );
-}
-```

package/.agents/references/utils/floatingMotion.md

@@ -1,67 +0,0 @@
-# floatingMotion
-
-## Purpose
-
-Provides animation presets and transform utilities for floating UI elements: tooltips, popovers, modals, and mobile sheets. Calculates `initial`, `animate`, and `exit` states for Framer Motion.
-
-## Usage Logic
-
-**`getFloatingMotionPreset(mode, placement?)`**: Returns a complete Framer Motion preset object based on the mode and optional placement.
-
-**`getFloatingTransformOrigin(placement)`**: Returns the correct `transformOrigin` string for a given placement.
-**`getFloatingHiddenTransform(placement)`**: Returns the hidden-state transform offset for a given placement.
-
-### Modes
-| Mode | Description | Animation |
-|------|-------------|-----------|
-| `anchored` | Tooltips, popovers | Scale + fade from placement origin |
-| `center-selected` | Center-positioned selection | Scale in place |
-| `modal-center` | Modal windows | Scale + fade in center |
-| `mobile-sheet` | Bottom sheets | Slide up from bottom |
-
-## Type Signatures
-
-```ts
-type FloatingMotionMode = "anchored" | "center-selected" | "modal-center" | "mobile-sheet";
-type FloatingPlacement = "top" | "bottom" | "left" | "right" | "top-start" | "top-end" | ...;
-type FloatingMotionPreset = {
-  initial: Variants;
-  animate: Variants;
-  exit: Variants;
-  transition: Transition;
-};
-
-function getFloatingMotionPreset(
-  mode: FloatingMotionMode,
-  placement?: FloatingPlacement
-): FloatingMotionPreset;
-
-function getFloatingTransformOrigin(placement: FloatingPlacement): string;
-function getFloatingHiddenTransform(placement: FloatingPlacement): { x?: number; y?: number };
-```
-
-## Example Code
-
-```tsx
-import { getFloatingMotionPreset } from "@musecat/functionkit";
-import { motion, AnimatePresence } from "framer-motion";
-
-function Tooltip({ open, children }: { open: boolean; children: ReactNode }) {
-  const preset = getFloatingMotionPreset("anchored", "top");
-
-  return (
-    <AnimatePresence>
-      {open && (
-        <motion.div
-          variants={preset}
-          initial="initial"
-          animate="animate"
-          exit="exit"
-        >
-          {children}
-        </motion.div>
-      )}
-    </AnimatePresence>
-  );
-}
-```

package/.agents/references/utils/getDeviceInfo.md

@@ -1,43 +0,0 @@
-# getDeviceInfo (checkDevice)
-
-## Purpose
-
-Parses the User-Agent string to detect the user's device type, operating system, and browser. Callable at module scope — no `window` required.
-
-## Usage Logic
-
-Analyzes `navigator.userAgent` with a series of regex checks. Returns a `DeviceInfo` object with boolean flags. SSR-safe — can be called in Server Components, RSC, or module initialization.
-
-## Type Signatures
-
-```ts
-interface DeviceInfo {
-  isMobile: boolean;
-  isIOS: boolean;
-  isAndroid: boolean;
-  isSafari: boolean;
-  isIOSSafari: boolean;
-  isMacSafari: boolean;
-  isSamsungBrowser: boolean;
-  isTouchDevice: boolean;
-  browser: string | null;
-}
-
-function getDeviceInfo(): DeviceInfo;
-```
-
-## Example Code
-
-```tsx
-import { getDeviceInfo } from "@musecat/functionkit";
-
-const { isMobile, isIOS, isIOSSafari } = getDeviceInfo();
-
-// Call at module scope
-const platform = isIOS ? "ios" : isAndroid ? "android" : "web";
-
-export function detectBrowser() {
-  const { isSafari, browser } = getDeviceInfo();
-  return { isSafari, browser };
-}
-```

package/.agents/references/utils/isEditableKeyboardTarget.md

@@ -1,35 +0,0 @@
-# isEditableKeyboardTarget (keyboardTarget)
-
-## Purpose
-
-Checks if a keyboard event target is an editable element (`input`, `textarea`, `select`, or `contentEditable`). Used to prevent keyboard navigation hooks from interfering with native input editing.
-
-## Usage Logic
-
-Examines the target element's tag name and `isContentEditable` property. Excludes buttons, checkboxes, and radio inputs from the editable set.
-
-## Type Signature
-
-```ts
-function isEditableKeyboardTarget(target: EventTarget | null): boolean;
-```
-
-## Example Code
-
-```tsx
-import { isEditableKeyboardTarget, useKeyboardListNavigation } from "@musecat/functionkit";
-
-function SearchableList({ items }: { items: string[] }) {
-  const { handleListKeyDown } = useKeyboardListNavigation({
-    itemCount: items.length,
-    onSelect: (i) => console.log(items[i]),
-  });
-
-  const onKeyDown = (e: React.KeyboardEvent) => {
-    if (isEditableKeyboardTarget(e.target)) return; // Don't steal from inputs
-    handleListKeyDown(e);
-  };
-
-  return <ul onKeyDown={onKeyDown}>...</ul>;
-}
-```

package/.agents/references/utils/mergeRefs.md

@@ -1,29 +0,0 @@
-# mergeRefs
-
-## Purpose
-
-Combines multiple React refs (callback refs and/or object refs) into a single callback ref. Useful when forwarding refs from parent components while keeping internal refs.
-
-## Usage Logic
-
-Returns a callback ref that, when called with a DOM node, sets `ref.current` on all object refs and invokes all callback refs with the node. Filters out `undefined` refs.
-
-## Type Signature
-
-```ts
-function mergeRefs<T>(
-  ...refs: (React.Ref<T> | undefined)[]
-): (node: T) => void;
-```
-
-## Example Code
-
-```tsx
-import { mergeRefs } from "@musecat/functionkit";
-import { forwardRef, useRef } from "react";
-
-const Input = forwardRef<HTMLInputElement, Props>((props, ref) => {
-  const internalRef = useRef<HTMLInputElement>(null);
-  return <input ref={mergeRefs(ref, internalRef)} {...props} />;
-});
-```

package/.agents/references/utils/seen.md

@@ -1,37 +0,0 @@
-# seen
-
-## Purpose
-
-Manages a "user has already seen this" state as a JSON string. Useful for marking items as read, dismissing onboarding prompts, or tracking feature discovery without server state.
-
-## Usage Logic
-
-Stores an array of string keys serialized as JSON. `parseSeen` deserializes, `hasSeenKey` checks a specific key, and `buildSeenValue` appends a new key and returns the updated JSON string. SSR-safe — pure functions with no side effects.
-
-## Type Signatures
-
-```ts
-const SEEN_STORAGE_KEY = "seen";
-
-function parseSeen(seen: string | null): string[];
-function hasSeenKey(seen: string | null, key: string): boolean;
-function buildSeenValue(prev: string | null, key: string): string;
-```
-
-## Example Code
-
-```tsx
-import { hasSeenKey, buildSeenValue, SEEN_STORAGE_KEY } from "@musecat/functionkit";
-import { getLocalStorage, updateLocalStorage } from "@musecat/functionkit";
-
-function useOnboarding() {
-  const stored = getLocalStorage(SEEN_STORAGE_KEY);
-  const hasSeenWalkthrough = hasSeenKey(stored, "walkthrough-v1");
-
-  const dismissWalkthrough = () => {
-    updateLocalStorage(SEEN_STORAGE_KEY, buildSeenValue(stored, "walkthrough-v1"));
-  };
-
-  return { hasSeenWalkthrough, dismissWalkthrough };
-}
-```

package/.agents/references/utils/subscribeKeyboardHeight.md

@@ -1,35 +0,0 @@
-# subscribeKeyboardHeight
-
-## Purpose
-
-A low-level utility that subscribes to `visualViewport` resize/scroll events and reports the estimated keyboard height. Used internally by `useKeyboardHeight`.
-
-## Usage Logic
-
-Attaches `resize` and `scroll` event listeners to `window.visualViewport`. Computes keyboard height as `window.innerHeight - visualViewport.height`. Throttles callbacks at the specified interval (default 16ms). Returns an unsubscribe function.
-
-## Type Signature
-
-```ts
-function subscribeKeyboardHeight(
-  handler: (height: number) => void,
-  throttleMs?: number
-): { unsubscribe: () => void };
-```
-
-## Example Code
-
-```tsx
-import { subscribeKeyboardHeight } from "@musecat/functionkit";
-import { useEffect } from "react";
-
-function useCustomKeyboardHandler() {
-  useEffect(() => {
-    const { unsubscribe } = subscribeKeyboardHeight(
-      (height) => console.log("Keyboard height:", height),
-      100
-    );
-    return unsubscribe;
-  }, []);
-}
-```

package/.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

package/AGENTS.md

@@ -1,105 +0,0 @@
-# FunctionKit (@musecat/functionkit)
-
-React 19 frontend utility library. Single package, ESM.
-
-## Import Convention Enforcement (Mandatory)
-
-- **Barrel imports are the rule:** `import { useDebounce } from "@musecat/functionkit"`.
-- **Subpath imports are only allowed when:** the export is not in the barrel (`useCheckInvisible`, `SwitchCase`, `ScrolltoTop`) or tree-shaking is absolutely required.
-- **Type imports also go through the barrel:** `import type { AppLocale, DateInput } from "@musecat/functionkit"`.
-- **No reimplementation:** If FunctionKit already provides a feature, reuse it. Never write a duplicate.
-
-## SSR Safety Classification
-
-| Category | Condition | Examples |
-|---|---|---|
-| **SSR-safe** | No `"use client"`, pure function | `formatLongDate`, `mergeRefs`, `SwitchCase`, `getDeviceInfo`, `floatingMotion`, `seen`, `parseClientCookieNames`, `debounce` |
-| **Client-only** | `"use client"` or `window` access | All hooks, `ViewportPortal`, `ScrolltoTop`, `browserStorage`, `cookie` (except `parseClientCookieNames`), `clipboardShare`, `isEditableKeyboardTarget` |
-
-SSR-safe functions can be used freely in Server Components, RSC, and Client Components. Client-only items must only be used in `"use client"` components.
-
-## Barrel Export Mapping
-
-The barrel (`index.ts`) exports 63 named exports. **Items NOT in the barrel (require subpath imports):**
-- `SwitchCase` — component subpath
-- `ScrolltoTop` — component subpath
-- `useCheckInvisible` — `@musecat/functionkit/hooks/useCheckInvisible`
-- `useCheckScroll` — `@musecat/functionkit/hooks/useCheckScroll`
-
-When adding new features, register them in the barrel.
-
-## Hook Selection Guidelines
-
-| Scenario | Hook to Use |
-|---|---|
-| Debounce rapid state changes | `useDebounce` or `useDebouncedCallback` |
-| Polling / repeated execution | `useInterval` |
-| Delayed single execution | `useTimeout` |
-| Keyboard list navigation | `useKeyboardListNavigation` |
-| Long press gesture | `useLongPress` |
-| Single/double click distinction | `useDoubleClick` |
-| Geolocation tracking | `useGeolocation` |
-| Client date formatting | `useClientDateTime` |
-| Relative time ("3 minutes ago") | `useRelativeDateTime` |
-| IntersectionObserver | `useIntersectionObserver` |
-| Keyboard avoidance (mobile) | `useAvoidKeyboard` |
-| Viewport height | `useViewportHeight` |
-| Media query matching | `useViewportMatch` |
-| Scroll position detection | `useCheckScroll` (subpath) |
-| Element visibility detection | `useCheckInvisible` (subpath) |
-| Toggle state | `useToggleState` |
-| Hydration guard | `useHasMounted` |
-| Stable callback reference | `usePreservedCallback` |
-| Deep equality reference | `usePreservedReference` |
-| Ref lifecycle | `useRefEffect` |
-
-## Component Selection Guidelines
-
-- **SwitchCase** — Prefer over inline &&/ternary for multi-branch rendering. SSR-safe.
-- **ViewportPortal** — Fixed-position overlays, modals, toasts. Client-only.
-- **ScrolltoTop** — Scroll reset on page navigation. Client-only.
-
-Never write raw `createContext` + `Provider` + `useContext` boilerplate. Use `buildContext` instead.
-
-## DateTime Formatting Guidelines
-
-| Context | Use | SSR-safe |
-|---|---|---|
-| Server static date | `formatServerDate` / `formatServerDateTime` | Yes |
-| Client date | `formatClientDate` / `formatClientDateTime` | No |
-| Relative time ("3분 전") | `formatServerRelative` (server) / `formatClientRelative` (client) | Mixed |
-| Remaining time ("2일 3시간 남음") | `formatRemainingText` | Yes |
-| UTC key ("YYYY-MM-DD") | `formatUtcDateKey` / `parseUtcDateInput` | Yes |
-| Raw formatters | `formatLongDate`, `formatDotDate`, `formatKoreanTime` etc. | Yes |
-
-**Locale handling:** `DateInput` accepts `string | number | Date`. Use `normalizeAppLocale("ko")` → `"kr"`, `toIntlLocale("kr")` → `"ko-KR"`.
-
-## Cookie & Storage API Guidelines
-
-| Operation | API | SSR-safe |
-|---|---|---|
-| Read cookie | `getClientCookie(name)` | No |
-| Write cookie | `setClientCookie(name, value, days?)` | No |
-| Delete cookie | `clearClientCookie(name)` / `clearAllClientCookies()` | No |
-| Parse cookie names | `parseClientCookieNames(cookieString)` | **Yes** |
-| localStorage | `getLocalStorage` / `updateLocalStorage` / `removeLocalStorage` | No |
-| sessionStorage | `getSessionStorage` / `updateSessionStorage` / `removeSessionStorage` | No |
-
-`clearAllClientCookies` tries all domain/path combinations — use with caution.
-
-## Context & Utility Patterns
-
-- **`buildContext`:** Creates `createContext` + Provider + `useContext` in one call. `const [useMyCtx, MyProvider] = buildContext<MyType>()`.
-- **`mergeRefs`:** Merges multiple refs into a single callback ref. Use when forwarding refs.
-- **`getDeviceInfo`:** UA-based device detection. Callable at module scope. Returns `isMobile`, `isIOS`, `isAndroid`, etc.
-- **`isEditableKeyboardTarget`:** Checks if a key event target is an editable element. Use before keyboard navigation.
-- **`NavigatorClipboard` / `NavigatorShare`:** Clipboard copy/share with automatic fallback on failure.
-- **`floatingMotion`:** `getFloatingMotionPreset` for tooltip/popover/modal animation configs. 4 modes (anchored, center-selected, modal-center, mobile-sheet).
-- **`seen`:** `hasSeenKey` / `buildSeenValue` for "user has already seen" state management. SSR-safe.
-- **`subscribeKeyboardHeight`:** Low-level keyboard height change detection. Used internally by `useKeyboardHeight`.
-
-## Documentation Maintenance
-
-- When hooks, components, or utils are added, modified, or removed, update the corresponding `.agents/references/` documentation.
-- When the barrel (`index.ts`) export list changes, update the Barrel Export Mapping section above.
-- Before using any feature, read the corresponding `.agents/references/` doc first.

package/tests/components/ScrolltoTop.test.tsx

@@ -1,15 +0,0 @@
-import { describe, test, expect, vi } from "vitest";
-import { render } from "@testing-library/react";
-import { ScrolltoTop } from "@/packages/components/ScrolltoTop";
-
-describe("ScrolltoTop", () => {
-	test("calls window.scrollTo(0, 0) on mount", () => {
-		const originalScrollTo = window.scrollTo;
-		window.scrollTo = vi.fn();
-
-		render(<ScrolltoTop />);
-		expect(window.scrollTo).toHaveBeenCalledWith(0, 0);
-
-		window.scrollTo = originalScrollTo;
-	});
-});

package/tests/components/SwitchCase.test.tsx

@@ -1,34 +0,0 @@
-import { describe, test, expect } from "vitest";
-import { render } from "@testing-library/react";
-import { SwitchCase } from "@/packages/components/SwitchCase";
-import React from "react";
-
-describe("SwitchCase", () => {
-	const cases = {
-		1: <div>Case 1</div>,
-		2: <div>Case 2</div>,
-		three: <div>Case Three</div>,
-	};
-
-	test("renders correctly matching case", () => {
-		const { container } = render(<SwitchCase value={1} cases={cases} />);
-		expect(container.textContent).toBe("Case 1");
-	});
-
-	test("renders another case", () => {
-		const { container } = render(<SwitchCase value="three" cases={cases} />);
-		expect(container.textContent).toBe("Case Three");
-	});
-
-	test("renders otherwise when case does not exist", () => {
-		const { container } = render(
-			<SwitchCase value={99} cases={cases} otherwise={<div>Fallback</div>} />,
-		);
-		expect(container.textContent).toBe("Fallback");
-	});
-
-	test("renders null when case does not exist and otherwise is not provided", () => {
-		const { container } = render(<SwitchCase value={99} cases={cases} />);
-		expect(container.innerHTML).toBe("");
-	});
-});

package/tests/components/ViewportPortal.test.tsx

@@ -1,42 +0,0 @@
-import { describe, test, expect, beforeEach } from "vitest";
-import { render, screen } from "@testing-library/react";
-import {
-	ViewportPortal,
-	getViewportPortalRoot,
-} from "@/packages/components/ViewportPortal";
-import React from "react";
-
-describe("ViewportPortal", () => {
-	beforeEach(() => {
-		document.body.innerHTML = "";
-	});
-
-	test("getViewportPortalRoot creates a root element if it doesn't exist", () => {
-		const root = getViewportPortalRoot();
-		expect(root).not.toBeNull();
-		expect(root?.id).toBe("viewport-portal-root");
-		expect(document.getElementById("viewport-portal-root")).toBe(root);
-	});
-
-	test("getViewportPortalRoot returns existing root element if it exists", () => {
-		const root1 = getViewportPortalRoot();
-		const root2 = getViewportPortalRoot();
-		expect(root1).toBe(root2);
-		expect(document.querySelectorAll("#viewport-portal-root").length).toBe(1);
-	});
-
-	test("ViewportPortal renders children into the portal root", () => {
-		render(
-			<ViewportPortal>
-				<div data-testid="portal-content">Portal Content</div>
-			</ViewportPortal>,
-		);
-
-		const root = document.getElementById("viewport-portal-root");
-		expect(root).not.toBeNull();
-
-		const content = screen.getByTestId("portal-content");
-		expect(content.textContent).toBe("Portal Content");
-		expect(root?.contains(content)).toBe(true);
-	});
-});