npm package: @pixel-pulse/cache-brain-react
Description: React & Next.js adapter for Cache Brain engine.
Author: Lin Htet Aung
Latest version: 1.0.2

<div align="center">
  <img src="https://cache-brain.netlify.app/og-image-next.png" width="100%" alt="Cache Brain - Smart Caching Engine"/>
  
  <br/>
  
  [![npm version](https://img.shields.io/npm/v/@pixel-pulse/cache-brain-react.svg)](https://www.npmjs.com/package/@pixel-pulse/cache-brain-react)
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
  
  <h3>Next-Generation Caching Engine for React.js & Next.js</h3>
  <p align="center"><b>The React adapter for Cache Brain.</b> Provides reactive hooks and context providers for seamless state synchronization in React and Next.js applications.</p>

  <p>
    <a href="https://cache-brain.netlify.app/"><b>Cache Brain</b></a> •
    <a href="https://cache-brain.netlify.app/doc"><b>Documentation</b></a> •
    <a href="https://cache-brain.netlify.app/doc/playground/core"><b>Server Lab</b></a> •
    <a href="https://cache-brain.netlify.app/doc/playground/hook"><b>Client Lab</b></a> •
    <a href="https://github.com/LinnHtetAungSE"><b>GitHub</b></a>
  </p>
</div>

## ✨ Features

- **Atomic Pulse Engine:** Unified API supporting `swr`, `cache-first`, `network-first` and `no-cache` strategies with a single function call.
- **Visual Diagnostics:** Real-time DevTools to track **TTL**, **Registry Hits**, and **Deduplication** events as they happen.
- **Event Bridge:** Reactive synchronization ensuring that when data updates in one component, the entire UI stays in sync.
- **App Router Native:** Deeply optimized for Next.js Server Components, Actions, and high-performance client hydration.

---

## ⚠️ Beta Version Notice

This project is currently in **v1.0.0-beta**. We are actively refining the **Registry Pulse** logic and synchronization performance.

- Please report any bugs via GitHub Issues.
- Expect breaking changes until version **1.2.0**.

---

## 📦 Installation

```bash
npm add @pixel-pulse/cache-brain-react
```

---

## 🚀 Setup

#### Wrap your App

In **Next.js (App Router)**, wrap your `layout.tsx`. In Vite, wrap your `App.tsx`.

```TypeScript
"use client";

import { useMemo } from "react";
import { CacheBrainClient } from "@pixel-pulse/cache-brain";
import { CacheBrainProvider } from "@pixel-pulse/cache-brain-react";

// Initialize the client
const client = new CacheBrainClient({ defaultTTL: 300000 });

export default function RootLayout({ children }) {
  return (
    <CacheBrainProvider client={client}>
      {children}
    </CacheBrainProvider>
  );
}
```

## 🎣 Usage

**`useSmartCache`**

The primary hook for data fetching. It automatically tracks loading states and synchronizes with the global cache.

```TypeScript
import { useSmartCache } from "@pixel-pulse/cache-brain-react";

function UserProfile({ id }) {
  const { data, isLoading, error, revalidate } = useSmartCache(
    ['user', id],
    () => fetch(`/api/user/${id}`).then(res => res.json())
  );

  if (isLoading) return <div>Loading...</div>;
  if (error) return <div>Error loading data.</div>;

  return (
    <div>
      <h1>{data.name}</h1>
      <button onClick={() => revalidate()}>Refresh Data</button>
    </div>
  );
}
```

### ⚙️ Hook Options (SmartCacheOptions)

The `useSmartCache` hook accepts a configuration object as its third argument to fine-tune the behavior of individual requests.

| Property   | Type       | Description                                                                                          | Default   |
| :--------- | :--------- | :--------------------------------------------------------------------------------------------------- | :-------- |
| `strategy` | `Strategy` | Defines how the engine handles data (e.g., `swr`, `network-first`).                                  | `default` |
| `ttl`      | `number`   | Time-to-live in milliseconds. Overrides the global client setting for this fetch.                    | `300000`  |
| `dedupe`   | `boolean`  | When `true`, multiple identical calls within the same timeframe are collapsed into a single request. | `true`    |
| `persist`  | `boolean`  | If enabled, the engine will attempt to save this specific result to persistent storage.              | `false`   |

---

## 🔗 Related Packages

- **Visual Debugger:** [@pixel-pulse/cache-brain-react-devtools](https://www.npmjs.com/package/@pixel-pulse/cache-brain-react-devtools)

---

### 🛡 License

<details>
  <summary>Distributed under the <b>MIT License</b>. Click to view full license.</summary>
  <br />
  
  ```text
  MIT License

Copyright (c) Lin Htet Aung (Liam) | 2026 Pixel Pulse Tech MM

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.

```
</details>

---

<p align="center">
<br />
<b>Engineered by Pixel Pulse Tech</b><br />
<sub>Redefining state management for 2026.</sub>
</p>
```