@braine/quantum-query 1.2.4 → 1.2.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Piyas Talukder
+
+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

@@ -46,7 +46,36 @@ function UserProfile({ id }) {
 
 ---
 
-## 🧠 The "Smart Model" Pattern (Advanced)
+## 🧠 Mental Model: When to use what?
+
+We separate state into two distinct categories.
+
+### 1. Server State (`useQuery`)
+Data that belongs to the server. It is asynchronous, can be stale, and needs caching.
+*   **Examples:** User Profile, List of Todos, Search Results.
+*   **Tool:** `useQuery`, `useMutation`.
+
+### 2. App State (`createState`)
+Data that belongs to the Interface. It is synchronous and temporary.
+*   **Examples:** Is Modal Open?, Current Filter, Form Inputs.
+*   **Tool:** `createState`, `useStore`.
+
+### 🌉 The Bridge
+Connect them seamlessly.
+*   **Store → Query**: Drive a query with a store signal.
+    ```ts
+    const { filter } = useStore(uiStore);
+    const { data } = useQuery(['items', filter], fetchItems);
+    ```
+*   **Query → Store**: Sync server data into a store for computed logic.
+    ```ts
+    const bridge = fromSignal(query.signal);
+    // Now you can use 'bridge' inside your Proxy store logic!
+    ```
+
+---
+
+## 🏗 The "Smart Model" Pattern (Advanced)
 
 Stop splitting your logic between Redux (Client State) and React Query (Server State). **Smart Models** combine state, computed properties, and actions into one reactive entity.
 
@@ -212,6 +241,71 @@ persistQueryClient({
 
 ---
 
+## 🚀 Server-Side Rendering (SSR) 🆕
+
+Full support for Next.js, Remix, and other SSR frameworks. We provide a simple hydration API to transfer state from server to client.
+
+### Server (Next.js App Router)
+```tsx
+import { dehydrate, QueryCache, HydrationBoundary } from '@braine/quantum-query';
+
+export default async function Page() {
+  const client = new QueryCache();
+  
+  // Prefetch data on the server
+  await client.prefetch(['user', '1'], fetchUser);
+  
+  // Serialize the cache
+  const dehydratedState = dehydrate(client);
+  
+  return (
+    <HydrationBoundary state={dehydratedState}>
+      <ClientComponent />
+    </HydrationBoundary>
+  );
+}
+```
+
+---
+
+## ⚡️ Fine-Grained Selectors (Optimization) 🆕
+
+Stop re-rendering your large components. Subscribe **only** to the data you need.
+
+```tsx
+const { data: userName } = useQuery({
+    queryKey: ['user', '1'],
+    queryFn: fetchUser,
+    // Only re-render if 'name' changes!
+    // Even if 'age' or 'email' updates in the background.
+    select: (user) => user.name 
+});
+```
+
+**Why is this better?**
+In other libraries, selectors often run on every render or require manual memoization. In **Quantum-Query**, our Signal-based architecture ensures the component **never even attempts to re-render** unless the specific selected value changes.
+
+---
+
+## 🛠️ DevTools (Debug Like a Pro)
+
+Inspect your cache, force refetches, and view active listeners.
+
+```tsx
+import { QuantumDevTools } from '@braine/quantum-query/devtools';
+
+function App() {
+  return (
+      <QueryClientProvider client={client}>
+         <YourApp />
+         <QuantumDevTools openByDefault={false} />
+      </QueryClientProvider>
+  );
+}
+```
+
+---
+
 ## 📚 Documentation
 
 *   **[API Reference](docs/api.md)**: Full method signatures and options.