@pixel-pulse/cache-brain-react 1.0.0

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,156 @@
+<div align="center">
+  <img src="https://cache-brain.netlify.app/og-image-next.jpeg" 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 | 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.d.mts

@@ -0,0 +1,27 @@
+import { SmartCacheOptions } from '@pixel-pulse/cache-brain/types';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import { CacheBrainClient } from '@pixel-pulse/cache-brain';
+export * from '@pixel-pulse/cache-brain';
+
+declare function useSmartCache<T = any>(key: string | any[], fetcher: () => Promise<T>, options?: SmartCacheOptions): {
+    data: T | null;
+    isLoading: boolean;
+    isFetching: boolean;
+    error: Error | null;
+    refresh: (manualOptions?: SmartCacheOptions) => Promise<void>;
+};
+
+declare function useCacheData<T = any>(key: string | any[]): T | null;
+
+interface CacheContextValue {
+    client: CacheBrainClient;
+    entries: any[];
+}
+declare const CacheBrainProvider: ({ children, client, }: {
+    children: React.ReactNode;
+    client: CacheBrainClient;
+}) => react_jsx_runtime.JSX.Element;
+declare const useCacheClient: () => CacheContextValue;
+
+export { CacheBrainProvider, useCacheClient, useCacheData, useSmartCache };

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { SmartCacheOptions } from '@pixel-pulse/cache-brain/types';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import { CacheBrainClient } from '@pixel-pulse/cache-brain';
+export * from '@pixel-pulse/cache-brain';
+
+declare function useSmartCache<T = any>(key: string | any[], fetcher: () => Promise<T>, options?: SmartCacheOptions): {
+    data: T | null;
+    isLoading: boolean;
+    isFetching: boolean;
+    error: Error | null;
+    refresh: (manualOptions?: SmartCacheOptions) => Promise<void>;
+};
+
+declare function useCacheData<T = any>(key: string | any[]): T | null;
+
+interface CacheContextValue {
+    client: CacheBrainClient;
+    entries: any[];
+}
+declare const CacheBrainProvider: ({ children, client, }: {
+    children: React.ReactNode;
+    client: CacheBrainClient;
+}) => react_jsx_runtime.JSX.Element;
+declare const useCacheClient: () => CacheContextValue;
+
+export { CacheBrainProvider, useCacheClient, useCacheData, useSmartCache };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var T=Object.defineProperty;var I=Object.getOwnPropertyDescriptor;var J=Object.getOwnPropertyNames;var L=Object.prototype.hasOwnProperty;var G=(e,t)=>{for(var r in t)T(e,r,{get:t[r],enumerable:!0})},P=(e,t,r,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of J(t))!L.call(e,a)&&a!==r&&T(e,a,{get:()=>t[a],enumerable:!(s=I(t,a))||s.enumerable});return e},C=(e,t,r)=>(P(e,t,"default"),r&&P(r,t,"default"));var H=e=>P(T({},"__esModule",{value:!0}),e);var u={};G(u,{CacheBrainProvider:()=>V,useCacheClient:()=>q,useCacheData:()=>M,useSmartCache:()=>D});module.exports=H(u);var n=require("react"),o=require("@pixel-pulse/cache-brain");function D(e,t,r){let[s,a]=(0,n.useState)(null),[m,l]=(0,n.useState)(!0),[d,b]=(0,n.useState)(!1),[F,w]=(0,n.useState)(null),S=(0,n.useRef)(null),K=(0,n.useRef)(t),A=(0,n.useRef)(r);(0,n.useEffect)(()=>{K.current=t,A.current=r},[t,r]);let R=(0,n.useMemo)(()=>Array.isArray(e)?e:[String(e)],[JSON.stringify(e)]),x=(0,n.useMemo)(()=>(0,o.normalizeKey)(R),[R]),E=(0,n.useCallback)(async p=>{S.current||l(!0),b(!0),w(null);try{let y={...A.current,...p},v=await(0,o.smartCache)(R,K.current,y);a(v),S.current=v}catch(y){w(y)}finally{l(!1),b(!1)}},[x]);return(0,n.useEffect)(()=>{let p=!0;E();let y=o.cacheEngine.onRevalidate(g=>{if(!p)return;let f=!g,B=g?(0,o.normalizeKey)(g):null;(f||B===x)&&E({strategy:"network-first"})}),v=o.cacheEngine.subscribe(g=>{if(!p)return;let f=g.find(B=>(0,o.normalizeKey)(B.key)===x);f&&f.data!==S.current&&(a(f.data),S.current=f.data)});return()=>{p=!1,y(),v()}},[x,E]),{data:s,isLoading:m,isFetching:d,error:F,refresh:E}}var i=require("react"),h=require("@pixel-pulse/cache-brain");function M(e){let t=(0,i.useMemo)(()=>Array.isArray(e)?e:[String(e)],[JSON.stringify(e)]),r=(0,i.useMemo)(()=>(0,h.normalizeKey)(t),[t]),[s,a]=(0,i.useState)(()=>h.cacheEngine.get(t)||null);return(0,i.useEffect)(()=>{let m=h.cacheEngine.subscribe(l=>{let d=l.find(b=>(0,h.normalizeKey)(b.key)===r);d?d.data!==s&&a(d.data):a(null)});return()=>{m()}},[r,s]),s}var c=require("react"),O=require("@pixel-pulse/cache-brain"),z=require("react/jsx-runtime"),N=(0,c.createContext)(null),V=({children:e,client:t})=>{let[r,s]=(0,c.useState)(()=>O.cacheEngine.getValues());(0,c.useEffect)(()=>{let m=O.cacheEngine.subscribe(l=>s([...l]));return()=>{m()}},[]);let a=(0,c.useMemo)(()=>({client:t,entries:r}),[t,r]);return(0,z.jsx)(N.Provider,{value:a,children:e})},q=()=>{let e=(0,c.useContext)(N);if(!e)throw new Error("CB: useSmartCache must be wrapped in a <CacheBrainProvider />. Please provide a CacheBrainClient instance to the provider.");return e};C(u,require("@pixel-pulse/cache-brain"),module.exports);0&&(module.exports={CacheBrainProvider,useCacheClient,useCacheData,useSmartCache,...require("@pixel-pulse/cache-brain")});

package/dist/index.mjs

@@ -0,0 +1 @@
+import{useState as y,useEffect as B,useCallback as N,useRef as S,useMemo as P}from"react";import{cacheEngine as T,normalizeKey as x,smartCache as V}from"@pixel-pulse/cache-brain";function q(e,t,r){let[n,a]=y(null),[o,s]=y(!0),[i,C]=y(!1),[M,E]=y(null),h=S(null),v=S(t),R=S(r);B(()=>{v.current=t,R.current=r},[t,r]);let g=P(()=>Array.isArray(e)?e:[String(e)],[JSON.stringify(e)]),m=P(()=>x(g),[g]),d=N(async u=>{h.current||s(!0),C(!0),E(null);try{let l={...R.current,...u},p=await V(g,v.current,l);a(p),h.current=p}catch(l){E(l)}finally{s(!1),C(!1)}},[m]);return B(()=>{let u=!0;d();let l=T.onRevalidate(f=>{if(!u)return;let c=!f,b=f?x(f):null;(c||b===m)&&d({strategy:"network-first"})}),p=T.subscribe(f=>{if(!u)return;let c=f.find(b=>x(b.key)===m);c&&c.data!==h.current&&(a(c.data),h.current=c.data)});return()=>{u=!1,l(),p()}},[m,d]),{data:n,isLoading:o,isFetching:i,error:M,refresh:d}}import{useState as z,useEffect as F,useMemo as O}from"react";import{cacheEngine as w,normalizeKey as K}from"@pixel-pulse/cache-brain";function I(e){let t=O(()=>Array.isArray(e)?e:[String(e)],[JSON.stringify(e)]),r=O(()=>K(t),[t]),[n,a]=z(()=>w.get(t)||null);return F(()=>{let o=w.subscribe(s=>{let i=s.find(C=>K(C.key)===r);i?i.data!==n&&a(i.data):a(null)});return()=>{o()}},[r,n]),n}import{createContext as J,useContext as L,useEffect as G,useState as H,useMemo as Q}from"react";import{cacheEngine as A}from"@pixel-pulse/cache-brain";import{jsx as X}from"react/jsx-runtime";var D=J(null),U=({children:e,client:t})=>{let[r,n]=H(()=>A.getValues());G(()=>{let o=A.subscribe(s=>n([...s]));return()=>{o()}},[]);let a=Q(()=>({client:t,entries:r}),[t,r]);return X(D.Provider,{value:a,children:e})},W=()=>{let e=L(D);if(!e)throw new Error("CB: useSmartCache must be wrapped in a <CacheBrainProvider />. Please provide a CacheBrainClient instance to the provider.");return e};export*from"@pixel-pulse/cache-brain";export{U as CacheBrainProvider,W as useCacheClient,I as useCacheData,q as useSmartCache};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@pixel-pulse/cache-brain-react",
+  "version": "1.0.0",
+  "description": "React & Next.js adapter for Cache Brain engine.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@pixel-pulse/cache-brain": "1.0.0"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.19.39",
+    "@types/react": "^18.3.1",
+    "@types/react-dom": "^18.3.1",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "tsup": "^8.0.0",
+    "typescript": "^6.0.2"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  }
+}