@pixel-pulse/cache-brain-vue 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @pixel-pulse/cache-brain-vue
+
+## 1.0.0
+
+### Major Changes
+
+- 40a0ec9: # 🚀 Pixel Pulse Cache Brain Update
+
+  ### Core & Adapters
+
+  - **Interface Alignment:** Synchronized `CacheOptions` and `CacheEntry` documentation with the TypeScript source.
+  - **Vue Performance:** Updated `SmartCacheReturn` to use `ShallowRef` for the `data` property, significantly reducing reactivity overhead for large payloads.
+  - **Type Safety:** Improved generic type handling for `useSmartCache` across both React and Vue adapters.
+
+  ### DevTools
+
+  - **Visibility Control:** Added the `enabled` prop to `CacheBrainDevTools`. This allows for cleaner environment-based rendering (e.g., `:enabled="isDev"`).
+  - **Documentation:** Rewrote the README with high-end Markdown tables for better developer onboarding.

package/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2026 Lin Htet Aung (Liam)
+
+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.

package/README.md

@@ -0,0 +1,151 @@
+<div align="center">
+  <img src="https://cache-brain.netlify.app/og-image-nuxt.jpeg" 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 | 2026 Pixel Pulse Tech
+
+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>
+```

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var S=Object.defineProperty;var D=Object.getOwnPropertyDescriptor;var j=Object.getOwnPropertyNames;var z=Object.prototype.hasOwnProperty;var G=(e,a)=>{for(var r in a)S(e,r,{get:a[r],enumerable:!0})},M=(e,a,r,s)=>{if(a&&typeof a=="object"||typeof a=="function")for(let n of j(a))!z.call(e,n)&&n!==r&&S(e,n,{get:()=>a[n],enumerable:!(s=D(a,n))||s.enumerable});return e};var q=e=>M(S({},"__esModule",{value:!0}),e);var L={};G(L,{CacheBrainClient:()=>A.CacheBrainClient,cacheEngine:()=>d.cacheEngine,createCacheBrain:()=>E,normalizeKey:()=>d.normalizeKey,useCacheData:()=>R,useCacheInternal:()=>y,useSmartCache:()=>w});module.exports=q(L);var d=require("@pixel-pulse/cache-brain");var p=require("vue"),T=require("@pixel-pulse/cache-brain"),B=Symbol.for("cache-brain"),E=e=>{let a=(0,p.reactive)({entries:T.cacheEngine.getValues()});return T.cacheEngine.subscribe(r=>{a.entries=[...r]}),{install(r){r.provide(B,{client:e,state:(0,p.readonly)(a)})}}},y=()=>{let e=(0,p.inject)(B);if(!e)throw new Error("CB: useSmartCache must be wrapped in a CacheBrain Provider.");return e};var l=require("vue"),h=require("@pixel-pulse/cache-brain");function R(e){y();let a=(0,l.computed)(()=>Array.isArray(e)?e:[String(e)]),r=(0,l.computed)(()=>(0,h.normalizeKey)(a.value)),s=(0,l.shallowRef)(h.cacheEngine.get(a.value)||null),n=h.cacheEngine.subscribe(f=>{let u=f.find(C=>(0,h.normalizeKey)(C.key)===r.value);u?u.data!==s.value&&(s.value=u.data):s.value=null});return(0,l.onUnmounted)(()=>{n()}),(0,l.watch)(r,()=>{s.value=h.cacheEngine.get(a.value)||null}),s}var t=require("vue"),i=require("@pixel-pulse/cache-brain");function w(e,a,r){let{client:s}=y(),n=(0,t.shallowRef)(null),f=(0,t.ref)(!0),u=(0,t.ref)(!1),C=(0,t.ref)(null),g=(0,t.computed)(()=>{let o=typeof e=="function"?e():(0,t.unref)(e);return Array.isArray(o)?o.map(c=>(0,t.unref)(c)):[String((0,t.unref)(o))]}),b=(0,t.computed)(()=>(0,i.normalizeKey)(g.value)),K=()=>typeof r=="function"?r():r||{},v=async o=>{let c={...K(),...o},m=i.cacheEngine.get(g.value);if(c.strategy==="cache-first"&&m!==void 0){n.value=m,f.value=!1;return}n.value||(f.value=!0),u.value=!0,C.value=null;try{let x=await(0,i.smartCache)(g.value,a,c);n.value=x,(0,t.triggerRef)(n)}catch(x){C.value=x}finally{f.value=!1,u.value=!1}},O=i.cacheEngine.subscribe(o=>{let c=o.find(m=>(0,i.normalizeKey)(m.key)===b.value);if(c){let m=Date.now()>c.expiry;c.data!==n.value&&(n.value=c.data,f.value=!1),m&&!u.value&&v()}}),I=i.cacheEngine.onRevalidate(o=>{let c=!o,m=o?(0,i.normalizeKey)(o):null;(c||m===b.value)&&v({strategy:"network-first"})});return(0,t.watch)(b,(o,c)=>{o!==c&&v()},{immediate:!0}),(0,t.onUnmounted)(()=>{O(),I()}),{data:n,isLoading:f,isFetching:u,error:C,refresh:v}}var A=require("@pixel-pulse/cache-brain");0&&(module.exports={CacheBrainClient,cacheEngine,createCacheBrain,normalizeKey,useCacheData,useCacheInternal,useSmartCache});

package/dist/index.d.cts

@@ -0,0 +1,34 @@
+import { CacheBrainClient } from '@pixel-pulse/cache-brain';
+export { CacheBrainClient, cacheEngine, normalizeKey } from '@pixel-pulse/cache-brain';
+import { App, DeepReadonly, Ref, ShallowRef } from 'vue';
+import { SmartCacheOptions } from '@pixel-pulse/cache-brain/types';
+
+interface CacheBrainContext {
+    client: CacheBrainClient;
+    state: DeepReadonly<{
+        entries: any[];
+    }>;
+}
+declare const createCacheBrain: (client: CacheBrainClient) => {
+    install(app: App): void;
+};
+declare const useCacheInternal: () => CacheBrainContext;
+
+/**
+ * Explicitly defining the return type as Ref<T | null>
+ * prevents the TS2742 "cannot be named" error during the DTS build.
+ */
+declare function useCacheData<T = any>(key: string | any[]): Ref<T | null>;
+
+type MaybeGetter<T> = T | (() => T);
+interface SmartCacheReturn<T> {
+    data: ShallowRef<T | null>;
+    isLoading: Ref<boolean>;
+    isFetching: Ref<boolean>;
+    error: Ref<Error | null>;
+    refresh: (manualOptions?: any) => Promise<void>;
+}
+
+declare function useSmartCache<T = any>(key: string | any[] | (() => any[]), fetcher: () => Promise<T>, options?: MaybeGetter<SmartCacheOptions>): SmartCacheReturn<T>;
+
+export { createCacheBrain, useCacheData, useCacheInternal, useSmartCache };

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import { CacheBrainClient } from '@pixel-pulse/cache-brain';
+export { CacheBrainClient, cacheEngine, normalizeKey } from '@pixel-pulse/cache-brain';
+import { App, DeepReadonly, Ref, ShallowRef } from 'vue';
+import { SmartCacheOptions } from '@pixel-pulse/cache-brain/types';
+
+interface CacheBrainContext {
+    client: CacheBrainClient;
+    state: DeepReadonly<{
+        entries: any[];
+    }>;
+}
+declare const createCacheBrain: (client: CacheBrainClient) => {
+    install(app: App): void;
+};
+declare const useCacheInternal: () => CacheBrainContext;
+
+/**
+ * Explicitly defining the return type as Ref<T | null>
+ * prevents the TS2742 "cannot be named" error during the DTS build.
+ */
+declare function useCacheData<T = any>(key: string | any[]): Ref<T | null>;
+
+type MaybeGetter<T> = T | (() => T);
+interface SmartCacheReturn<T> {
+    data: ShallowRef<T | null>;
+    isLoading: Ref<boolean>;
+    isFetching: Ref<boolean>;
+    error: Ref<Error | null>;
+    refresh: (manualOptions?: any) => Promise<void>;
+}
+
+declare function useSmartCache<T = any>(key: string | any[] | (() => any[]), fetcher: () => Promise<T>, options?: MaybeGetter<SmartCacheOptions>): SmartCacheReturn<T>;
+
+export { createCacheBrain, useCacheData, useCacheInternal, useSmartCache };

package/dist/index.js

@@ -0,0 +1 @@
+import{cacheEngine as ie,normalizeKey as se}from"@pixel-pulse/cache-brain";import{inject as K,reactive as O,readonly as I}from"vue";import{cacheEngine as x}from"@pixel-pulse/cache-brain";var S=Symbol.for("cache-brain"),D=a=>{let o=O({entries:x.getValues()});return x.subscribe(r=>{o.entries=[...r]}),{install(r){r.provide(S,{client:a,state:I(o)})}}},m=()=>{let a=K(S);if(!a)throw new Error("CB: useSmartCache must be wrapped in a CacheBrain Provider.");return a};import{shallowRef as j,computed as T,watch as z,onUnmounted as G}from"vue";import{cacheEngine as C,normalizeKey as B}from"@pixel-pulse/cache-brain";function M(a){m();let o=T(()=>Array.isArray(a)?a:[String(a)]),r=T(()=>B(o.value)),l=j(C.get(o.value)||null),n=C.subscribe(s=>{let c=s.find(u=>B(u.key)===r.value);c?c.data!==l.value&&(l.value=c.data):l.value=null});return G(()=>{n()}),z(r,()=>{l.value=C.get(o.value)||null}),l}import{ref as v,shallowRef as q,computed as E,watch as L,onUnmounted as P,unref as d,triggerRef as U}from"vue";import{cacheEngine as g,normalizeKey as b,smartCache as _}from"@pixel-pulse/cache-brain";function F(a,o,r){let{client:l}=m(),n=q(null),s=v(!0),c=v(!1),u=v(null),h=E(()=>{let e=typeof a=="function"?a():d(a);return Array.isArray(e)?e.map(t=>d(t)):[String(d(e))]}),p=E(()=>b(h.value)),R=()=>typeof r=="function"?r():r||{},f=async e=>{let t={...R(),...e},i=g.get(h.value);if(t.strategy==="cache-first"&&i!==void 0){n.value=i,s.value=!1;return}n.value||(s.value=!0),c.value=!0,u.value=null;try{let y=await _(h.value,o,t);n.value=y,U(n)}catch(y){u.value=y}finally{s.value=!1,c.value=!1}},w=g.subscribe(e=>{let t=e.find(i=>b(i.key)===p.value);if(t){let i=Date.now()>t.expiry;t.data!==n.value&&(n.value=t.data,s.value=!1),i&&!c.value&&f()}}),A=g.onRevalidate(e=>{let t=!e,i=e?b(e):null;(t||i===p.value)&&f({strategy:"network-first"})});return L(p,(e,t)=>{e!==t&&f()},{immediate:!0}),P(()=>{w(),A()}),{data:n,isLoading:s,isFetching:c,error:u,refresh:f}}import{CacheBrainClient as he}from"@pixel-pulse/cache-brain";export{he as CacheBrainClient,ie as cacheEngine,D as createCacheBrain,se as normalizeKey,M as useCacheData,m as useCacheInternal,F as useSmartCache};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@pixel-pulse/cache-brain-vue",
+  "version": "1.0.0",
+  "description": "Vue 3 & Nuxt.js adapter for Cache Brain engine.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "peerDependencies": {
+    "vue": ">=3.0.0"
+  },
+  "devDependencies": {
+    "vue": "^3.4.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "@pixel-pulse/cache-brain": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  }
+}

package/src/composables/useCacheData.ts

@@ -0,0 +1,47 @@
+import { shallowRef, computed, watch, onUnmounted, Ref } from "vue"; // 1. Added Ref import
+import { cacheEngine, normalizeKey } from "@pixel-pulse/cache-brain";
+import { useCacheInternal } from "../plugin";
+import { CacheEntry } from "@pixel-pulse/cache-brain/types";
+
+/**
+ * Explicitly defining the return type as Ref<T | null>
+ * prevents the TS2742 "cannot be named" error during the DTS build.
+ */
+export function useCacheData<T = any>(key: string | any[]): Ref<T | null> {
+  useCacheInternal();
+
+  const queryKey = computed(() => {
+    return Array.isArray(key) ? key : [String(key)];
+  });
+
+  const cacheKey = computed(() => normalizeKey(queryKey.value));
+
+  const data = shallowRef<T | null>(
+    (cacheEngine.get(queryKey.value) as T) || null,
+  );
+
+  // 2. Explicitly type 'allEntries' and 'e' to satisfy strict builds
+  const unsubscribe = cacheEngine.subscribe((allEntries: any[]) => {
+    const match = (allEntries as CacheEntry<T>[]).find(
+      (e: CacheEntry<T>) => normalizeKey(e.key) === cacheKey.value,
+    );
+
+    if (match) {
+      if (match.data !== data.value) {
+        data.value = match.data as T;
+      }
+    } else {
+      data.value = null;
+    }
+  });
+
+  onUnmounted(() => {
+    unsubscribe();
+  });
+
+  watch(cacheKey, () => {
+    data.value = (cacheEngine.get(queryKey.value) as T) || null;
+  });
+
+  return data;
+}

package/src/composables/useSmartCache.ts

@@ -0,0 +1,131 @@
+import {
+  ref,
+  shallowRef,
+  computed,
+  watch,
+  onUnmounted,
+  unref,
+  triggerRef,
+} from "vue";
+import {
+  cacheEngine,
+  normalizeKey,
+  smartCache,
+} from "@pixel-pulse/cache-brain";
+import type { SmartCacheOptions } from "@pixel-pulse/cache-brain/types";
+import { MaybeGetter, SmartCacheReturn } from "@/types";
+import { useCacheInternal } from "@/plugin";
+
+export function useSmartCache<T = any>(
+  key: string | any[] | (() => any[]),
+  fetcher: () => Promise<T>,
+  options?: MaybeGetter<SmartCacheOptions>,
+): SmartCacheReturn<T> {
+  // 0. THE GUARD: This throws the error if plugin is not installed
+  const { client } = useCacheInternal();
+
+  // 1. Reactive State
+  const data = shallowRef<T | null>(null);
+  const isLoading = ref(true);
+  const isFetching = ref(false);
+  const error = ref<Error | null>(null);
+
+  // 2. Compute the queryKey and cacheKey reactively
+  const queryKey = computed(() => {
+    const k = typeof key === "function" ? key() : unref(key);
+    return Array.isArray(k) ? k.map((item) => unref(item)) : [String(unref(k))];
+  });
+
+  const cacheKey = computed(() => normalizeKey(queryKey.value));
+
+  const resolveOptions = (): SmartCacheOptions => {
+    return typeof options === "function" ? options() : options || {};
+  };
+
+  // 3. The Core Refresh Logic
+  const refresh = async (manualOptions?: SmartCacheOptions) => {
+    const mergedOptions: SmartCacheOptions = {
+      ...resolveOptions(),
+      ...manualOptions,
+    };
+
+    const existing = cacheEngine.get(queryKey.value);
+
+    if (mergedOptions.strategy === "cache-first" && existing !== undefined) {
+      data.value = existing as T;
+      isLoading.value = false;
+      return;
+    }
+
+    if (!data.value) isLoading.value = true;
+
+    isFetching.value = true;
+    error.value = null;
+
+    try {
+      const result = await smartCache(queryKey.value, fetcher, mergedOptions);
+      data.value = result as T;
+      triggerRef(data);
+    } catch (err) {
+      error.value = err as Error;
+    } finally {
+      isLoading.value = false;
+      isFetching.value = false;
+    }
+  };
+
+  // 4. Global Subscriptions
+  const unsubscribeSync = cacheEngine.subscribe((allEntries) => {
+    const entry = allEntries.find(
+      (e) => normalizeKey(e.key) === cacheKey.value,
+    );
+
+    if (entry) {
+      const isExpired = Date.now() > entry.expiry;
+
+      if (entry.data !== data.value) {
+        data.value = entry.data;
+        isLoading.value = false;
+      }
+
+      if (isExpired && !isFetching.value) {
+        refresh();
+      }
+    }
+  });
+
+  const unsubscribeRevalidate = cacheEngine.onRevalidate((invalidatedKey) => {
+    const isGlobal = !invalidatedKey;
+    const incomingKeyString = invalidatedKey
+      ? normalizeKey(invalidatedKey)
+      : null;
+
+    if (isGlobal || incomingKeyString === cacheKey.value) {
+      refresh({ strategy: "network-first" });
+    }
+  });
+
+  // 5. Watch for Key Changes
+  watch(
+    cacheKey,
+    (newVal, oldVal) => {
+      if (newVal !== oldVal) {
+        refresh();
+      }
+    },
+    { immediate: true },
+  );
+
+  onUnmounted(() => {
+    unsubscribeSync();
+    unsubscribeRevalidate();
+  });
+
+  return {
+    data,
+    isLoading,
+    isFetching,
+    error,
+    refresh,
+  };
+}

package/src/index.ts

@@ -0,0 +1,12 @@
+export { cacheEngine, normalizeKey } from "@pixel-pulse/cache-brain";
+
+// 1. The Vue Plugin (for app.use(createCacheBrain()))
+export { createCacheBrain, useCacheInternal } from "./plugin";
+
+// 2. Reactive Composables (The "Hooks")
+export { useCacheData } from "./composables/useCacheData";
+
+export { useSmartCache } from "./composables/useSmartCache";
+
+// 3. The Functional Client & Types
+export { CacheBrainClient } from "@pixel-pulse/cache-brain";

package/src/plugin.ts

@@ -0,0 +1,47 @@
+import {
+  inject,
+  InjectionKey,
+  App,
+  reactive,
+  readonly,
+  DeepReadonly,
+} from "vue";
+// Import from your core package
+import { cacheEngine, CacheBrainClient } from "@pixel-pulse/cache-brain";
+
+interface CacheBrainContext {
+  client: CacheBrainClient;
+  state: DeepReadonly<{ entries: any[] }>;
+}
+
+const CACHE_BRAIN_SYMBOL: InjectionKey<CacheBrainContext> =
+  Symbol.for("cache-brain");
+
+export const createCacheBrain = (client: CacheBrainClient) => {
+  const state = reactive({
+    entries: cacheEngine.getValues(),
+  });
+
+  cacheEngine.subscribe((newData) => {
+    state.entries = [...newData];
+  });
+
+  return {
+    install(app: App) {
+      app.provide(CACHE_BRAIN_SYMBOL, {
+        client,
+        state: readonly(state),
+      });
+    },
+  };
+};
+
+export const useCacheInternal = () => {
+  const context = inject(CACHE_BRAIN_SYMBOL);
+  if (!context) {
+    throw new Error(
+      "CB: useSmartCache must be wrapped in a CacheBrain Provider.",
+    );
+  }
+  return context;
+};

package/src/types.ts

@@ -0,0 +1,11 @@
+import type { Ref, ShallowRef } from "vue";
+
+export type MaybeGetter<T> = T | (() => T);
+
+export interface SmartCacheReturn<T> {
+  data: ShallowRef<T | null>;
+  isLoading: Ref<boolean>;
+  isFetching: Ref<boolean>;
+  error: Ref<Error | null>;
+  refresh: (manualOptions?: any) => Promise<void>;
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "lib": ["ESNext", "DOM", "DOM.Iterable"],
+    "strict": true,
+    "skipLibCheck": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src"]
+}

package/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  format: ["esm", "cjs"],
+  dts: true,
+  minify: true,
+  clean: true,
+  external: ["vue", "@pixel-pulse/cache-brain"],
+});