npm package: @pixel-pulse/cache-brain-vue
Description: Vue 3 & Nuxt.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-nuxt.png" width="100%" alt="Cache Brain - Smart Caching Engine"/>
  
  <br/>
  
  [![npm version](https://img.shields.io/npm/v/@pixel-pulse/cache-brain-vue.svg)](https://www.npmjs.com/package/@pixel-pulse/cache-brain-vue)
  [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
  
  <h3>Next-Generation Caching Engine for Vue.js & Nuxt.js</h3>
  <p align="center"><b>The Vue adapter for Cache Brain.</b> High-performance data fetching composables with deep reactivity for Vue 3 and Nuxt 3.</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-vue
```

## 🚀 Setup

#### Vue 3 (Vite/Plugin)

Initialize the client and install it as a plugin in your `main.ts`.

```TypeScript
import { createApp } from 'vue';
import { CacheBrainClient } from '@pixel-pulse/cache-brain';
import { createCacheBrain } from '@pixel-pulse/cache-brain-vue';

const app = createApp(App);
const client = new CacheBrainClient({ defaultTTL: 300000 });

app.use(createCacheBrain(client));
app.mount('#app');
```

## 🎣 Usage

**`useSmartCache`**

The primary composable for fetching data. Returns fully reactive `Refs`.

```TypeScript
<script setup lang="ts">
import { useSmartCache } from '@pixel-pulse/cache-brain-vue';

const { data, isLoading, refresh } = useSmartCache(
  ['profile', 'settings'],
  async () => {
    const res = await fetch('/api/settings');
    return res.json();
  }
);
</script>

<template>
  <div v-if="isLoading">Loading...</div>
  <div v-else-if="data">
    <h1>{{ data.userName }}</h1>
    <button @click="refresh()">Sync Settings</button>
  </div>
</template>
```

### ⚙️ Hook Options (SmartCacheOptions)

The `useSmartCache` composable returns a reactive object. Because it uses Vue's Reactivity API, you should access these properties using `.value` in scripts or directly in templates.

| Property     | Type                    | Description                                                                                  |
| :----------- | :---------------------- | :------------------------------------------------------------------------------------------- |
| `data`       | `ShallowRef<T \| null>` | The retrieved data. Uses `shallowRef` to prevent deep reactivity overhead on large datasets. |
| `isLoading`  | `Ref<boolean>`          | `true` only during the initial fetch. Stays `false` during subsequent background refreshes.  |
| `isFetching` | `Ref<boolean>`          | `true` whenever a network request is active, including background revalidations.             |
| `error`      | `Ref<Error \| null>`    | Captured error object if the fetcher function fails.                                         |
| `refresh`    | `Function`              | A manual trigger to force a fresh fetch. Accepts optional overrides for `ttl` or `strategy`. |

---

## 🔗 Related Packages

- **Visual 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>
```