@storve/core 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,1034 @@
+# ⚡ Storve
+
+> **State that thinks for itself.**
+
+A fast, minimal-boilerplate React state management library with first-class async support, auto-tracking, and built-in caching. Replaces both Zustand and TanStack Query with a single cohesive API.
+
+[![npm (scoped)](https://img.shields.io/npm/v/@storve/core.svg)](https://www.npmjs.com/package/@storve/core)
+[![npm (scoped)](https://img.shields.io/npm/v/@storve/react.svg)](https://www.npmjs.com/package/@storve/react)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)](https://www.typescriptlang.org/)
+[![React](https://img.shields.io/badge/React-18%2B-61dafb)](https://react.dev/)
+[![Coverage](https://img.shields.io/badge/coverage-99%25-brightgreen)]()
+[![Core size](https://img.shields.io/badge/core-1.4KB-success)]()
+[![Tests](https://img.shields.io/badge/tests-998%20passing-success)]()
+
+---
+
+## Why Storve?
+
+| Problem with existing tools | How Storve solves it |
+|---|---|
+| Redux requires actions, reducers, selectors in separate files | One `createStore` call, zero boilerplate |
+| Zustand has no built-in async — you need TanStack Query too | `createAsync` is first-class — loading, error, caching built in |
+| Manual selector writing to prevent re-renders | Auto-tracking Proxy — only re-renders what actually changed |
+| No built-in caching or stale-while-revalidate | TTL + SWR built into every async key |
+| Optimistic updates require complex middleware | One option: `{ optimistic: { data } }` |
+
+---
+
+## Installation
+
+**Storve has two packages — install both for React apps:**
+
+```bash
+# npm
+npm install @storve/core @storve/react
+
+# pnpm
+pnpm add @storve/core @storve/react
+
+# yarn
+yarn add @storve/core @storve/react
+```
+
+**Peer dependencies:** React 18+
+
+---
+
+## Get started in 5 minutes
+
+**1. Install**
+```bash
+npm install @storve/core @storve/react
+```
+
+**2. Create a store**
+```ts
+import { createStore } from '@storve/core'
+
+const counterStore = createStore({ count: 0 })
+```
+
+**3. Use it in a component**
+```tsx
+import { useStore } from '@storve/react'
+
+function Counter() {
+  const count = useStore(counterStore, s => s.count)
+  return (
+    <button onClick={() => counterStore.setState(s => ({ count: s.count + 1 }))}>
+      Count: {count}
+    </button>
+  )
+}
+```
+
+**4. Add async data**
+```ts
+import { createAsync } from '@storve/core/async'
+
+const userStore = createStore({
+  user: createAsync(async (id: string) => {
+    const res = await fetch(`/api/users/${id}`)
+    return res.json()
+  })
+})
+
+await userStore.fetch('user', 'user-123')
+userStore.getState().user.data   // { id: 'user-123', name: 'Alice' }
+userStore.getState().user.status // 'success'
+```
+
+That's it. No actions, reducers, or providers needed.
+
+➡️ *StackBlitz demo coming soon*
+
+---
+
+## Quick Start
+
+```tsx
+import { createStore } from '@storve/core'
+import { useStore } from '@storve/react'
+
+// 1. Create a store
+const counterStore = createStore({ count: 0 })
+
+// 2. Use it in a component
+function Counter() {
+  const count = useStore(counterStore, s => s.count)
+  return (
+    <button onClick={() => counterStore.setState(s => ({ count: s.count + 1 }))}>
+      Count: {count}
+    </button>
+  )
+}
+```
+
+---
+
+## Import Patterns (Tree-Shaking)
+
+Storve uses subpath imports so you only bundle what you use:
+
+| Import | Size (gzipped) | Use when |
+|--------|----------------|----------|
+| `import { createStore, batch } from '@storve/core'` | ~1.4 KB | Core store only |
+| `import { createAsync } from '@storve/core/async'` | +1.1 KB | Async state, fetching, caching |
+| `import { computed } from '@storve/core/computed'` | +0.8 KB | Derived state |
+| `import { withPersist } from '@storve/core/persist'` | +1.2 KB | Persistence, adapters |
+| `import { signal } from '@storve/core/signals'` | +0.4 KB | Fine-grained reactivity |
+| `import { withDevtools } from '@storve/core/devtools'` | +0.8 KB | Time-travel, Undo/Redo |
+| `import { withSync } from '@storve/core/sync'` | +0.6 KB | Cross-tab synchronization |
+
+```ts
+// Core only
+import { createStore } from '@storve/core'
+
+// With async
+import { createStore } from '@storve/core'
+import { createAsync } from '@storve/core/async'
+
+// With computed
+import { createStore } from '@storve/core'
+import { computed } from '@storve/core/computed'
+```
+
+---
+
+## Core Concepts
+
+Storve has two packages:
+
+- **`@storve/core`** — the framework-agnostic core store. Works anywhere: React, Node, tests, vanilla JS.
+- **`@storve/react`** — the React adapter. Provides `useStore` hook built on `useSyncExternalStore`.
+
+---
+
+## API Reference
+
+### `createStore(definition, options?)`
+
+Creates a reactive store. Returns a store instance.
+
+```ts
+import { createStore } from '@storve/core'
+
+const store = createStore({
+  count: 0,
+  name: 'Alice',
+  theme: 'light' as 'light' | 'dark',
+})
+```
+
+#### Options
+
+```ts
+createStore(definition, {
+  immer: true,  // enable Immer mutation-style updates (default: false)
+})
+```
+
+---
+
+### `store.getState()`
+
+Returns a shallow copy of the current state. Each call is an independent snapshot — mutations to the returned object do not affect the store.
+
+```ts
+const state = store.getState()
+state.count        // 0
+state.name         // 'Alice'
+
+// Safe — `before` is a snapshot, not a live reference
+const before = store.getState()
+store.setState({ count: 99 })
+before.count       // still 0
+store.getState().count  // 99
+```
+
+---
+
+### `store.setState(updater)`
+
+Updates state and notifies all subscribers. Accepts a partial object, an updater function, or an Immer draft mutator (when `immer: true`).
+
+```ts
+// 1. Partial object — merged into existing state
+store.setState({ count: 1 })
+
+// 2. Updater function — receives current state, returns partial
+store.setState(s => ({ count: s.count + 1 }))
+
+// 3. Immer draft mutator (requires immer: true option)
+store.setState(draft => {
+  draft.count++
+  draft.name = 'Bob'
+})
+```
+
+**Immer example with nested state:**
+
+```ts
+const store = createStore({
+  user: { address: { city: 'New York' } }
+}, { immer: true })
+
+// Without Immer — verbose
+store.setState(s => ({
+  user: { ...s.user, address: { ...s.user.address, city: 'LA' } }
+}))
+
+// With Immer — clean
+store.setState(draft => { draft.user.address.city = 'LA' })
+```
+
+---
+
+### `store.subscribe(listener)`
+
+Subscribes to state changes. Returns an unsubscribe function.
+
+```ts
+const unsubscribe = store.subscribe(newState => {
+  console.log('state changed:', newState)
+})
+
+// Stop listening
+unsubscribe()
+```
+
+Useful outside React — in Node scripts, tests, or to sync with external systems like `localStorage`.
+
+---
+
+### `store.batch(fn)`
+
+Runs multiple `setState` calls and fires subscribers **exactly once** at the end, regardless of how many updates happen inside.
+
+```ts
+store.batch(() => {
+  store.setState({ count: 1 })
+  store.setState({ name: 'Bob' })
+  store.setState({ theme: 'dark' })
+})
+// Subscribers notified once — not three times
+```
+
+Use `batch` whenever you need to make several state changes atomically. Prevents intermediate renders.
+
+---
+
+### `actions` — Named operations
+
+Define named operations directly inside the store definition. Actions are automatically bound and available directly on the store instance.
+
+```ts
+const counterStore = createStore({
+  count: 0,
+  actions: {
+    increment() { counterStore.setState(s => ({ count: s.count + 1 })) },
+    decrement() { counterStore.setState(s => ({ count: s.count - 1 })) },
+    reset()     { counterStore.setState({ count: 0 }) },
+    incrementBy(amount: number) {
+      counterStore.setState(s => ({ count: s.count + amount }))
+    }
+  }
+})
+
+// Call actions directly on the store
+counterStore.increment()
+counterStore.incrementBy(5)
+counterStore.reset()
+
+// Actions are also grouped under .actions
+counterStore.actions.increment()
+```
+
+Actions keep business logic in one place instead of scattered across components.
+
+---
+
+### `useStore(store, selector?)` *(@storve/react)*
+
+React hook to consume a store inside a component. Built on `useSyncExternalStore` — safe in React 18 Concurrent Mode with no tearing.
+
+```tsx
+import { useStore } from '@storve/react'
+
+function MyComponent() {
+  // Subscribe to the entire store
+  const state = useStore(counterStore)
+
+  // Subscribe to a single value — only re-renders when count changes
+  const count = useStore(counterStore, s => s.count)
+
+  // Subscribe to a derived value — only re-renders when result changes
+  const isEven = useStore(counterStore, s => s.count % 2 === 0)
+
+  return <div>{count} — {isEven ? 'even' : 'odd'}</div>
+}
+```
+
+**The selector is optional.** If your store is small and focused, subscribing to everything is fine. Use a selector when you want to prevent re-renders from unrelated state changes.
+
+---
+
+## Computed values (v0.5)
+
+Synchronous derived state with automatic dependency tracking. Use `computed(fn)` in your store definition; the store will run the function against the current state, track which keys were read, and recompute when those dependencies change. Supports chaining (computed can depend on other computeds). Circular dependencies are detected at store creation and throw a clear error.
+
+```ts
+import { createStore } from '@storve/core'
+import { computed } from '@storve/core/computed'
+
+const store = createStore({
+  a: 1,
+  b: 2,
+  sum: computed((s) => s.a + s.b),
+})
+
+store.getState().sum // 3
+store.setState({ a: 10 })
+store.getState().sum // 12
+```
+
+Computed keys are read-only: you cannot set them via `setState` (TypeScript will flag it; at runtime such keys are ignored).
+
+---
+
+## Async State
+
+Async data is a first-class citizen in Storve. No separate library needed.
+
+### `createAsync(fn, options?)`
+
+Defines an async value inside a store. Automatically manages `loading`, `error`, `data`, and `status`.
+
+```ts
+import { createStore } from '@storve/core'
+import { createAsync } from '@storve/core/async'
+
+const userStore = createStore({
+  user: createAsync(async (id: string) => {
+    const res = await fetch(`/api/users/${id}`)
+    return res.json()
+  })
+})
+```
+
+Every async key automatically has this shape:
+
+```ts
+store.getState().user === {
+  data: null,           // T | null — the result
+  loading: false,       // boolean — is a fetch in progress?
+  error: null,          // string | null — error message if failed
+  status: 'idle',       // 'idle' | 'loading' | 'success' | 'error'
+  refetch: () => void   // convenience method to re-run the fetch
+}
+```
+
+#### Async Options
+
+```ts
+createAsync(fn, {
+  ttl: 60_000,               // cache result for 60 seconds (default: 0 = no cache)
+  staleWhileRevalidate: true // show stale data while fetching fresh (default: false)
+})
+```
+
+---
+
+### `store.fetch(key, ...args)`
+
+Triggers the async function. Sets `loading: true` synchronously before the first await — safe to check immediately after calling.
+
+```ts
+// Basic fetch
+await store.fetch('user', 'user-123')
+
+// Check loading synchronously
+const fetchPromise = store.fetch('user', 'user-123')
+store.getState().user.loading  // true — set synchronously
+
+await fetchPromise
+store.getState().user.loading  // false
+store.getState().user.data     // { id: 'user-123', name: 'Alice' }
+store.getState().user.status   // 'success'
+```
+
+**Race condition protection built in** — if you call `fetch` multiple times rapidly, only the last response wins. Previous responses are silently discarded.
+
+```ts
+store.fetch('user', 'user-1')  // starts
+store.fetch('user', 'user-2')  // starts — user-1 response will be ignored
+store.fetch('user', 'user-3')  // starts — user-1 and user-2 will be ignored
+// Only user-3's response updates state
+```
+
+---
+
+### `store.refetch(key)`
+
+Re-runs the async function with the last used arguments. Bypasses TTL cache.
+
+```ts
+await store.fetch('user', 'user-123')  // fetches user-123
+await store.refetch('user')             // re-fetches user-123 automatically
+```
+
+You can also call `refetch` from the state shape itself:
+
+```ts
+await store.getState().user.refetch()  // same as store.refetch('user')
+```
+
+---
+
+### TTL Caching
+
+Cache results for a duration. Within the TTL window, `fetch` returns cached data without hitting the network.
+
+```ts
+const store = createStore({
+  user: createAsync(fetchUser, { ttl: 60_000 })  // cache for 60 seconds
+})
+
+await store.fetch('user', 'user-123')  // hits network
+await store.fetch('user', 'user-123')  // returns cache — no network call
+// 60 seconds later...
+await store.fetch('user', 'user-123')  // hits network again
+```
+
+Different arguments produce independent cache entries:
+
+```ts
+await store.fetch('user', 'user-1')   // cached under 'user-1'
+await store.fetch('user', 'user-2')   // cached under 'user-2' independently
+await store.fetch('user', 'user-1')   // cache hit — no network
+```
+
+---
+
+### Stale-While-Revalidate (SWR)
+
+When the cache expires, instead of showing a loading spinner, Storve immediately returns the stale data and fetches fresh data in the background.
+
+```ts
+const store = createStore({
+  user: createAsync(fetchUser, {
+    ttl: 60_000,
+    staleWhileRevalidate: true
+  })
+})
+
+await store.fetch('user', 'user-123')  // initial fetch
+// 60 seconds later...
+
+store.fetch('user', 'user-123')
+// status is still 'success' — not 'loading'
+// data is the old (stale) value — shown immediately
+// fresh data fetches in background, updates quietly when done
+```
+
+Without SWR, an expired cache shows `status: 'loading'` and a blank/spinner state. With SWR, users always see something — the app feels instant.
+
+---
+
+### `store.invalidate(key)`
+
+Clears the TTL cache for a specific key. The next `fetch` will go to the network regardless of TTL.
+
+```ts
+store.invalidate('user')
+await store.fetch('user', 'user-123')  // hits network even if TTL hasn't expired
+```
+
+---
+
+### `store.invalidateAll()`
+
+Clears cache for every async key in the store.
+
+```ts
+store.invalidateAll()
+```
+
+---
+
+### Optimistic Updates
+
+Apply an immediate state change before the async operation completes. If the operation fails, state automatically rolls back.
+
+```ts
+// Show the new name immediately — roll back if save fails
+await store.fetch('user', { optimistic: { data: { name: 'New Name' }, status: 'success' } })
+```
+
+The UI updates instantly. If the server rejects the change, the previous data is restored automatically.
+
+---
+
+### Error Handling
+
+Errors are captured in state — `fetch` never throws to the caller.
+
+```ts
+// fetch does not throw
+await store.fetch('user', 'user-123')
+
+// Check error in state
+const { data, error, status } = store.getState().user
+if (status === 'error') {
+  console.log(error)  // 'Network error' — the error message
+}
+```
+
+---
+
+### Full Async Example
+
+```tsx
+import { createStore } from '@storve/core'
+import { createAsync } from '@storve/core/async'
+import { useStore } from '@storve/react'
+
+const userStore = createStore({
+  user: createAsync(
+    async (id: string) => {
+      const res = await fetch(`/api/users/${id}`)
+      if (!res.ok) throw new Error('Failed to fetch user')
+      return res.json()
+    },
+    { ttl: 60_000, staleWhileRevalidate: true }
+  )
+})
+
+function UserProfile({ id }: { id: string }) {
+  const { data, loading, error, status } = useStore(userStore, s => s.user)
+
+  useEffect(() => {
+    userStore.fetch('user', id)
+  }, [id])
+
+  if (status === 'idle' || loading) return <Spinner />
+  if (status === 'error') return <ErrorMessage message={error} />
+
+  return (
+    <div>
+      <h1>{data.name}</h1>
+      <button onClick={() => userStore.refetch('user')}>Refresh</button>
+    </div>
+  )
+}
+```
+---
+
+## Persistence Layer (v0.4)
+
+Storve includes a powerful, tree-shakable persistence layer that automatically syncs your store state to external storage.
+
+### `withPersist(store, options)`
+
+Enhances a store with persistence capabilities. It handles hydration (loading state on startup) and automatic debounced writes on state changes.
+
+```ts
+import { createStore } from '@storve/core'
+import { withPersist } from '@storve/core/persist'
+import { localStorageAdapter } from '@storve/core/persist/adapters/localStorage'
+
+const store = withPersist(
+  createStore({ count: 0 }),
+  {
+    key: 'my-app-store',
+    adapter: localStorageAdapter(),
+    pick: ['count'], // optional: only persist these keys
+    version: 1,      // optional: for schema migrations
+    debounce: 100,   // optional: ms to wait before saving (default: 100)
+  }
+)
+
+// Wait for hydration if you need to know when data is loaded
+await store.hydrated
+```
+
+### Adapters
+
+Storve comes with several built-in adapters, all SSR-safe:
+
+- **`localStorageAdapter()`**: Persist to `window.localStorage`.
+- **`sessionStorageAdapter()`**: Persist to `window.sessionStorage`.
+- **`indexedDBAdapter()`**: Async persistence to IndexedDB for larger datasets.
+- **`memoryAdapter()`**: In-memory storage, useful for testing or SSR environments.
+
+### Composing Enhancers
+
+Use `withPersist` as a higher-order function for clean composition:
+
+```ts
+import { createStore } from '@storve/core'
+import { withPersist } from '@storve/core/persist'
+import { localStorageAdapter } from '@storve/core/persist/adapters/localStorage'
+
+const store = withPersist({ 
+  key: 'app', 
+  adapter: localStorageAdapter() 
+})(createStore({ count: 0 }))
+```
+
+---
+
+## Signals (v0.5)
+
+Signals provide fine-grained reactivity by allowing you to subscribe to a single key in the store. Unlike `useStore` which re-renders if a selector result changes, Signals are lower-level objects that can be passed around and subscribed to directly.
+
+### `signal(store, key, transform?)`
+
+Creates a Signal for a specific store key. Optionally transforms the value.
+
+```ts
+import { createStore } from '@storve/core'
+import { signal } from '@storve/core/signals'
+
+const store = createStore({ count: 0, user: { name: 'Alice' } })
+
+// 1. Standard Signal
+const countSignal = signal(store, 'count')
+
+// 2. Derived Signal (Read-only)
+const doubleSignal = signal(store, 'count', v => v * 2)
+```
+
+### Signal API
+
+- `signal.get()`: Returns current value.
+- `signal.set(value | fn)`: Updates the store (throws if derived).
+- `signal.subscribe(listener)`: Notifies when *this* signal's value changes. Returns unsubscribe.
+- `signal._derived`: Boolean flag.
+
+### React Integration: `useSignal(signal)`
+
+The `useSignal` hook (from `@storve/react`) subscribes to a signal and returns its value. The component re-renders **ONLY** when that specific signal changes.
+
+```tsx
+import { signal } from '@storve/core/signals'
+import { useSignal } from '@storve/react'
+
+const countSignal = signal(counterStore, 'count')
+
+function CounterDisplay() {
+  const count = useSignal(countSignal)
+  return <div>Count: {count}</div>
+}
+```
+
+Signals are perfect for high-frequency updates or deep component trees where you want to avoid overhead from larger selectors.
+
+
+---
+
+## DevTools & Time Travel (v0.6)
+
+Storve features a built-in time-travel engine that integrates seamlessly with the Redux DevTools extension. It uses a ring-buffer history to keep memory usage constant while providing powerful undo/redo and snapshot capabilities.
+
+### `withDevtools(store, options)`
+
+Enhances a store with history tracking and Redux DevTools integration.
+
+```ts
+import { createStore } from '@storve/core'
+import { withDevtools } from '@storve/core/devtools'
+
+const store = withDevtools(
+  createStore({ count: 0 }),
+  { 
+    name: 'My Store',   // Label in DevTools panel
+    maxHistory: 50      // Max entries in ring buffer (default: 50)
+  }
+)
+```
+
+### History API
+
+Once enhanced, the store instance provides methods to navigate history:
+
+- `store.undo()`: Move back one step in history.
+- `store.redo()`: Move forward one step in history.
+- `store.canUndo`: Boolean flag indicating if undo is possible.
+- `store.canRedo`: Boolean flag indicating if redo is possible.
+- `store.clearHistory()`: Wipes the history buffer.
+
+### Named Snapshots
+
+Save and restore specific state checkpoints by name.
+
+```ts
+store.snapshot('before-expensive-op')
+// ... make changes ...
+store.restore('before-expensive-op') // Jumps back instantly
+```
+
+### React Integration: `useDevtools(store)`
+
+The `useDevtools` hook (from `@storve/react`) provides a reactive way to access history state, useful for building your own Undo/Redo UI.
+
+```tsx
+import { useDevtools } from '@storve/react'
+
+function Controls() {
+  const { canUndo, canRedo, undo, redo } = useDevtools(counterStore)
+  
+  return (
+    <div>
+      <button onClick={undo} disabled={!canUndo}>Undo</button>
+      <button onClick={redo} disabled={!canRedo}>Redo</button>
+    </div>
+  )
+}
+```
+
+---
+
+## Cross-Tab Synchronization (v0.7)
+
+Storve provides an easy way to synchronize state across multiple browser tabs using the `BroadcastChannel` API. This is useful for keeping user preferences, authentication state, or shared data consistent without manual event handling.
+
+### `withSync(store, options)`
+
+Enhances a store with cross-tab synchronization.
+
+```ts
+import { createStore } from '@storve/core'
+import { withSync } from '@storve/core/sync'
+
+const store = withSync(
+  createStore({ theme: 'light', user: { name: 'Alice' } }),
+  { 
+    channel: 'my-app-sync', // Unique channel name
+    keys: ['theme']        // Optional: only sync specific keys
+  }
+)
+```
+
+### Features
+
+- **Automatic Rehydration**: New tabs automatically request the current state from existing tabs on startup.
+- **Selective Sync**: Use the `keys` option to only broadcast specific parts of your state, reducing overhead.
+- **Conflict-Free**: Built on a simple last-write-wins protocol via `BroadcastChannel`.
+- **Zero Configuration**: Works out of the box with no complex setup required.
+
+---
+
+Stores are plain JavaScript objects. Import and use them freely across stores.
+
+### Read from another store in an action
+
+```ts
+import { userStore } from './userStore'
+
+const cartStore = createStore({
+  items: [] as CartItem[],
+  actions: {
+    addItem(item: CartItem) {
+      const user = userStore.getState().user.data
+      if (!user) throw new Error('Must be logged in')
+      cartStore.setState(s => ({ items: [...s.items, item] }))
+    }
+  }
+})
+```
+
+### React to another store's changes
+
+```ts
+// Auto-clear cart when user logs out
+userStore.subscribe(state => {
+  if (!state.user.data) {
+    cartStore.setState({ items: [] })
+  }
+})
+```
+
+### Use multiple stores in one component
+
+```tsx
+function Header() {
+  const user = useStore(userStore, s => s.user.data)
+  const cartCount = useStore(cartStore, s => s.items.length)
+  const theme = useStore(themeStore, s => s.theme)
+
+  return (
+    <header data-theme={theme}>
+      <span>Hello, {user?.name}</span>
+      <span>Cart ({cartCount})</span>
+    </header>
+  )
+}
+```
+
+---
+
+## Performance
+
+All benchmarks run on Apple MacBook Air, 100,000 iterations with 1,000 warmup iterations.
+
+### Core Store
+
+| Operation | Average Time | Threshold |
+|---|---|---|
+| `createStore()` | 0.00640ms | < 1ms |
+| `getState()` read | 0.00001ms | < 0.1ms |
+| `setState()` + notify (100 subs) | 0.00090ms | < 1ms |
+| Nested read (3 levels deep) | 0.00001ms | < 0.1ms |
+| Subscribe + Unsubscribe cycle | 0.00008ms | < 0.1ms |
+
+### React Adapter
+
+| Operation | Average Time | Threshold |
+|---|---|---|
+| `useStore()` subscription setup | 0.00006ms | < 0.5ms |
+| `useStore()` subscription cleanup | 0.00007ms | < 0.5ms |
+| Selector execution (primitive) | 0.00001ms | < 0.1ms |
+| Selector execution (derived) | 0.00000ms | < 0.1ms |
+| `setState()` + notify (10 subs) | 0.00037ms | < 1ms |
+
+### Immer & Batch
+
+| Operation | Average Time |
+|---|---|
+| `setState()` Immer primitive | 0.00080ms |
+| `setState()` Immer nested object | 0.00252ms |
+| `setState()` Immer array push | 0.00831ms |
+| `batch()` 3× setState, 1 notify | 0.00120ms |
+| `batch()` 10× setState, 1 notify | 0.00536ms |
+
+### Async & Computed (Week 5)
+
+| Operation | Average Time | Threshold |
+|---|---|---|
+| `createAsync()` initialization | 0.00025ms | < 0.1ms |
+| `fetch()` - cache hit (TTL) | 0.00065ms | < 0.1ms |
+| `fetch()` - cache miss (resolved) | 0.00657ms | < 1.0ms |
+| `refetch()` overhead | 0.00655ms | < 0.1ms |
+| `optimistic` - immediate change | 0.00452ms | < 0.2ms |
+| `computed` read | 0.00001ms | < 0.1ms |
+| `computed` recompute (1 dep) | 0.00212ms | < 0.1ms |
+| `computed` 3-level chain | 0.00337ms | < 0.5ms |
+
+---
+
+## TypeScript
+
+Storve is written in TypeScript with full inference. No type casting required.
+
+```ts
+// State type is fully inferred
+const store = createStore({
+  count: 0,
+  name: 'Alice',
+  active: true,
+})
+
+store.getState().count   // inferred as number
+store.getState().name    // inferred as string
+store.getState().active  // inferred as boolean
+
+// setState is type-safe — wrong keys or types are caught at compile time
+store.setState({ count: 'wrong' })  // TS error
+store.setState({ unknown: true })   // TS error
+
+// Async state is fully typed
+const userStore = createStore({
+  user: createAsync(async () => ({ name: 'Alice', age: 30 }))
+})
+
+userStore.getState().user.data?.name  // inferred as string | undefined
+userStore.getState().user.status      // inferred as 'idle' | 'loading' | 'success' | 'error'
+```
+
+---
+
+## Test Coverage
+
+| File | Statements | Branches | Functions | Lines |
+|---|---|---|---|---|
+| `async.ts` | 98.44% | 95.83% | 100% | 98.44% |
+| `proxy.ts` | 100% | 100% | 100% | 100% |
+| `store.ts` | 98.3% | 95%+ | 100% | 98.3% |
+| `signals/` | 100% | 100% | 100% | 100% |
+| `persist/` | 99.6% | 92%+ | 100% | 99.6% |
+| `sync/` | 100% | 100% | 100% | 100% |
+| **Total** | **99.1%** | **96%+** | **98%+** | **99.1%** |
+
+998 tests across 36 test files. Zero known bugs.
+
+---
+
+## Migrating from pre-1.0 (storve / storve-react)
+
+If you used the old unscoped packages before v1.0, update your imports:
+
+| Old | New |
+|-----|-----|
+| `storve` | `@storve/core` |
+| `storve-react` | `@storve/react` |
+| `storve/async` | `@storve/core/async` |
+| `storve/computed` | `@storve/core/computed` |
+| `storve/persist` | `@storve/core/persist` |
+| `storve/signals` | `@storve/core/signals` |
+| `storve/devtools` | `@storve/core/devtools` |
+| `storve/sync` | `@storve/core/sync` |
+
+```bash
+pnpm remove storve storve-react
+pnpm add @storve/core @storve/react
+```
+
+---
+
+## Migrating from Redux
+
+**Before (Redux)**
+```ts
+// actions.ts
+const INCREMENT = 'INCREMENT'
+const increment = () => ({ type: INCREMENT })
+
+// reducer.ts
+function counterReducer(state = { count: 0 }, action) {
+  switch (action.type) {
+    case INCREMENT: return { ...state, count: state.count + 1 }
+    default: return state
+  }
+}
+
+// store.ts
+const store = createStore(counterReducer)
+
+// component.tsx
+const count = useSelector(s => s.count)
+const dispatch = useDispatch()
+dispatch(increment())
+```
+
+**After (Storve)**
+```ts
+// store.ts
+const counterStore = createStore({
+  count: 0,
+  actions: {
+    increment() { counterStore.setState(s => ({ count: s.count + 1 })) }
+  }
+})
+
+// component.tsx
+const count = useStore(counterStore, s => s.count)
+counterStore.increment()
+```
+
+## Migrating from Zustand
+
+**Before (Zustand)**
+```ts
+const useStore = create((set) => ({
+  count: 0,
+  increment: () => set(s => ({ count: s.count + 1 })),
+}))
+
+// component
+const count = useStore(s => s.count)
+const increment = useStore(s => s.increment)
+```
+
+**After (Storve)**
+```ts
+const counterStore = createStore({
+  count: 0,
+  actions: {
+    increment() { counterStore.setState(s => ({ count: s.count + 1 })) }
+  }
+})
+
+// component
+const count = useStore(counterStore, s => s.count)
+counterStore.increment()
+```
+
+**Key differences:**
+- No provider needed — stores are module-level singletons
+- Actions defined inside the store, not as part of state
+- Built-in async support — no need for a separate server state library
+
+---
+
+## Roadmap
+
+| Version | Theme | Status |
+|---|---|---|
+| v0.1–v0.3 | Core store, React adapter, Immer, Actions | ✅ Shipped |
+| v0.4 | Async state — createAsync, TTL, SWR, optimistic | ✅ Shipped |
+| v0.5 | Computed values + Signals | ✅ Shipped |
+| v0.6 | DevTools — Time-travel, Undo/Redo, Snapshots | ✅ Shipped |
+| v0.7 | Cross-tab sync via BroadcastChannel | ✅ Shipped |
+| v1.0 | Stable API, polished README, StackBlitz demo | ✅ Shipped |
+| v1.1 | Purpose-built DevTools browser extension | 📋 Planned |
+| v1.2 | Full docs site (Docusaurus) | 📋 Planned |
+| v1.3 | Middleware system | 📋 Planned |
+
+---
+
+## License
+
+MIT © 2026 Storve

package/package.json

@@ -1,6 +1,10 @@
 {
     "name": "@storve/core",
-    "version": "1.0.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Nam1001/React-Flux.git"
+    },
+    "version": "1.0.2",
     "main": "dist/index.cjs",
     "module": "dist/index.mjs",
     "types": "dist/index.d.ts",