npm package: @pixel-pulse/cache-brain
Description: Universal caching engine for Next.js with React 18 hook and Nuxt.js with Vue 3 support.
Author: Lin Htet Aung
Latest version: 1.0.2

<div align="center">
  <img src="https://cache-brain.netlify.app/og-image.png" width="100%" alt="Cache Brain - Smart Caching Engine"/>
  
  <br/>
  
  [![npm version](https://img.shields.io/npm/v/@pixel-pulse/cache-brain.svg)](https://www.npmjs.com/package/@pixel-pulse/cache-brain)
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
  
  <h3>Next-Generation Caching Engine for Vanilla.js</h3>

  <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>

---

**The high-performance caching engine for modern web apps.** Zero-config server caching with real-time client synchronization.

---

## ✨ 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**.

---

## ⚡️ Overview

Cache Brain is designed to be the "connective tissue" between your data source and your UI. It provides a lightweight, framework-agnostic core that handles deduplication, expiration, and revalidation logic, ensuring your app stays fast and your data stays fresh.

- **🚀 Performance-First:** Optimized lookup speeds for high-frequency data access.
- **🛡 Deduplication:** Prevents "cache stampede" by collapsing multiple identical requests.
- **🛠 Framework Agnostic:** Pure TypeScript logic that runs in Browser, Node.js, or Edge.
- **🔄 Smart Invalidation:** Time-based (TTL) and manual cache purging.

---

## 📦 Installation

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

## 🍦 Vanilla JS Usage

Cache Brain is framework-agnostic at its core. You can use it in any JavaScript environment.

1. **Initialize the Client**

Configure your global caching strategy once at the entry point of your application.

```JavaScript
import { CacheBrainClient } from "@pixel-pulse/cache-brain";

new CacheBrainClient({
  defaultTTL: 1000 * 60 * 5, // 5 minutes
  revalidateOnFocus: true,   // Refresh data when window gains focus
  debug: false
});
```

2. **Fetch with smartCache**

Wrap your data fetching logic with `smartCache`. It automatically handles the cache lookup, fetching, and storage.

```JavaScript
import { smartCache } from "@pixel-pulse/cache-brain";

async function getPosts() {
  return await smartCache(['posts', 'latest'], async () => {
    const response = await fetch('[https://api.example.com/posts](https://api.example.com/posts)');
    return response.json();
  });
}

// Subsequent calls return cached data instantly!
const posts = await getPosts();
```

### ⚙️ Configuration & Schema

The core engine uses `CacheOptions` to determine how specific data is handled and stores them as a `CacheEntry`.

#### Cache Options

| Property  | Type      | Description                                                                  | Default  |
| :-------- | :-------- | :--------------------------------------------------------------------------- | :------- |
| `ttl`     | `number`  | Time-to-live in milliseconds. Defines how long the data remains "Fresh".     | `300000` |
| `label`   | `string`  | A human-readable identifier for easier debugging in **DevTools**.            | `Key`    |
| `persist` | `boolean` | If true, the entry survives page refreshes (via `localStorage`/`IndexedDB`). | `false`  |

#### Internal Entry Schema

| Key            | Description                                                                   |
| :------------- | :---------------------------------------------------------------------------- |
| `key`          | A unique array of strings identifying the resource (e.g., `['user', '123']`). |
| `data`         | The actual payload returned by your fetcher function.                         |
| `expiry`       | The absolute timestamp (ms) when the data becomes stale.                      |
| `lastAccessed` | Timestamp used by the engine for LRU (Least Recently Used) cleanup logic.     |

---

## 🧩 Framework Extensions

Need reactivity? Install the specific package for your stack:

- **React / Next.js:** [@pixel-pulse/cache-brain-react](https://www.npmjs.com/package/@pixel-pulse/cache-brain-react)
- **Vue / Nuxt 3:** [@pixel-pulse/cache-brain-vue](https://www.npmjs.com/package/@pixel-pulse/cache-brain-vue)
- **React / Next.js Debugger:** [@pixel-pulse/cache-brain-react-devtools](https://www.npmjs.com/package/@pixel-pulse/cache-brain-react-devtools)
- **Vue / Nuxt.js Debugger:** [@pixel-pulse/cache-brain-vue-devtools](https://www.npmjs.com/package/@pixel-pulse/cache-brain-vue-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>
```