@musecat/functionkit 1.0.1 → 1.1.0

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

@@ -0,0 +1,67 @@
+# 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

@@ -0,0 +1,43 @@
+# 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

@@ -0,0 +1,35 @@
+# 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

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,37 @@
+# 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

@@ -0,0 +1,35 @@
+# 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/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Report a bug to help us improve
+title: "[BUG] "
+labels: bug
+---
+
+## Describe the Bug
+
+A clear and concise description of what the bug is.
+
+## To Reproduce
+
+Steps to reproduce the behavior:
+1. Import '...'
+2. Call '...'
+3. See error
+
+## Expected Behavior
+
+A clear and concise description of what you expected to happen.
+
+## Environment
+
+- React version:
+- @musecat/functionkit version:
+- Browser / Node version:
+
+## Additional Context
+
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE] "
+labels: enhancement
+---
+
+## Problem Statement
+
+Is your feature request related to a problem? Please describe clearly.
+
+## Proposed Solution
+
+A clear and concise description of what you want to happen.
+
+## Alternative Solutions
+
+A description of any alternative solutions or features you've considered.
+
+## Additional Context
+
+Add any other context or examples about the feature request here.

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+## Description
+
+Please include a summary of the change and which issue is fixed.
+
+## Type of Change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change
+- [ ] Documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes.
+
+## Checklist
+
+- [ ] My code follows the project's code style
+- [ ] I have added tests that prove my fix/feature works
+- [ ] `npm run lint` passes
+- [ ] `npm test` passes
+- [ ] Barrel exports (`index.ts`) are updated if needed

package/.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - run: npm ci
+      - run: npm run lint
+      - run: npm test

package/.local/state/gh/device-id

@@ -0,0 +1 @@
+f1f55548-1baa-4638-bd0f-f3da5e3262f0

package/.prettierrc

@@ -0,0 +1,8 @@
+{
+	"useTabs": true,
+	"tabWidth": 2,
+	"printWidth": 100,
+	"singleQuote": false,
+	"semi": true,
+	"trailingComma": "all"
+}