universe-code 0.0.64 → 0.0.66

package/README.md

@@ -3,7 +3,7 @@ An opinionated npm package that enforces coding discipline by standardizing stru
 ## Documentation
 
 📦 IndexedDB Angular
-👉 [View Docs](https://github.com/connectwithfalco/universe-code/tree/main/doc/angular/indexdb)
+👉 [View Docs](https://github.com/connectwithfalco/universe-code/tree/main/dist/guide/angular/indexdb)
 
 📦 IndexedDB React
-👉 [View Docs](https://github.com/connectwithfalco/universe-code/tree/main/doc/react/indexdb)
+👉 [View Docs](https://github.com/connectwithfalco/universe-code/tree/main/dist/guide/react/indexdb)

package/dist/guide/angular/indexdb/README.md

@@ -0,0 +1,190 @@
+# 🌌 universe-code (Angular)
+
+A lightweight and powerful **IndexedDB utility for Angular** that helps you cache API responses, manage offline storage, and reduce unnecessary network calls — with a **clean, service-based API**.
+
+Designed for **modern Angular (standalone + DI)** and production-ready applications.
+
+---
+
+## ✨ Features
+
+* ⚡ Easy IndexedDB configuration
+* 🧠 Built-in API caching with expiry
+* 📦 Simple CRUD helpers
+* 🔁 Auto refresh when cache expires
+* 🧩 Angular Dependency Injection support
+* 🛠 Clean & professional service-based API
+
+---
+
+## 📦 Installation
+
+Install the latest version using npm:
+
+```bash
+npm install universe-code@latest
+```
+
+---
+
+## ⚙️ IndexedDB Setup (One Time Only)
+
+IndexedDB should be initialized **once at application bootstrap level**.
+
+---
+
+## 1️⃣ Import Angular Compiler (Required)
+
+`universe-code` internally uses Angular decorators and DI.
+For JIT environments, Angular Compiler **must be available**.
+
+📁 `main.ts`
+
+```ts
+import '@angular/compiler';
+import { bootstrapApplication } from '@angular/platform-browser';
+import { appConfig } from './app/app.config';
+import { App } from './app/app';
+
+bootstrapApplication(App, appConfig)
+  .catch(console.error);
+```
+
+> ⚠️ **Note:**
+> This avoids `JIT compilation failed for injectable class` errors.
+
+---
+
+## 2️⃣ Import the IndexedDB Service
+
+`IdbService` is provided via Angular DI and requires **no manual provider setup**.
+
+```ts
+import { IdbService } from 'universe-code/angular';
+```
+
+---
+
+## 🚀 Using IndexedDB in Angular Components
+
+Inject the service inside any component or service.
+
+📁 `app.ts`
+
+```ts
+import { Component, OnInit } from '@angular/core';
+import { IdbService } from 'universe-code/angular';
+
+@Component({
+  selector: 'app-root',
+  template: `<h1>Angular App</h1>`,
+})
+export class App implements OnInit {
+
+  constructor(private idb: IdbService) {}
+
+  async ngOnInit() {
+    const data = await this.idb.fetchWithCache(
+      'example-key',
+      60_000, // cache expiry in ms
+      async () => {
+        const res = await fetch('https://example.com/api/data');
+        return res.json();
+      }
+    );
+
+    console.log(data);
+  }
+}
+```
+
+---
+
+## 🔁 Fetch API Data with Cache + Expiry
+
+```ts
+const result = await idb.fetchWithCache(
+  'users',
+  5 * 60 * 1000,
+  async () => {
+    const res = await fetch('/api/users');
+    return res.json();
+  }
+);
+```
+
+### 🧠 How it Works
+
+* Checks IndexedDB for cached data
+* Validates expiry timestamp
+* Calls API only if cache is missing or expired
+* Stores fresh data automatically
+* Returns cached data instantly on next call
+
+---
+
+## 📥 Get Cached Data Only
+
+```ts
+const data = await idb.get('users');
+```
+
+---
+
+## ✏️ Insert / Update Data Manually
+
+```ts
+await idb.put({
+  id: 'profile',
+  data: {
+    name: 'John',
+    role: 'Admin',
+  },
+  timestamp: Date.now(),
+});
+```
+
+---
+
+## 🗑️ Remove a Specific Record
+
+```ts
+await idb.remove('profile');
+```
+
+---
+
+## 🧹 Clear Entire IndexedDB Store
+
+```ts
+await idb.clear();
+```
+
+---
+
+## 📚 API Reference
+
+| Method                                 | Description                  |
+| -------------------------------------- | ---------------------------- |
+| `get(id)`                              | Retrieve data from IndexedDB |
+| `put(payload)`                         | Insert or update data        |
+| `remove(id)`                           | Delete a specific record     |
+| `clear()`                              | Clear entire IndexedDB       |
+| `fetchWithCache(id, expiry, callback)` | Fetch + cache with expiry    |
+
+---
+
+## ✅ Ideal Use Cases
+
+* API response caching
+* Offline-first Angular apps
+* Performance optimization
+* Reducing repeated network calls
+* Storing session-level data
+
+---
+
+## 🛡 License
+
+MIT License © universe-code
+

package/dist/guide/react/indexdb/README.md

@@ -0,0 +1,198 @@
+# 🌌 universe-code (React)
+
+A lightweight and powerful **IndexedDB utility for React** that helps you cache API data, manage offline storage, and reduce unnecessary network calls — all with a clean and simple API.
+
+---
+
+## ✨ Features
+
+- ⚡ Easy IndexedDB setup
+- 🧠 Built-in API caching with expiry
+- 📦 Simple CRUD operations
+- 🔁 Auto re-fetch when cache expires
+- 💻 Works perfectly with React / Next.js
+- 🛠 Clean and developer-friendly API
+
+---
+
+## 📦 Installation
+
+Install the latest version using npm:
+
+```bash
+npm install universe-code@latest
+```
+---
+
+## ⚙️ IndexedDB Setup (One Time Only)
+
+You must configure IndexedDB once at the root level of your app.
+
+---
+
+## 1️⃣ Create IndexedDB Provider
+
+Create the following file:
+
+📁 lib/provider/idb-provider.tsx
+
+```bash
+"use client";
+
+import { configureIdb } from "universe-code/react";
+
+export function IdbProvider() {
+  configureIdb({
+    dbName: "db",
+    dbVersion: 1,
+    storeName: "store",
+  });
+
+  return null;
+}
+```
+
+---
+
+### 2️⃣ Register Provider in Root Layout
+
+Call the provider once so IndexedDB initializes globally.
+
+```bash
+import { IdbProvider } from "@/lib/provider/idb-provider";
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html lang="en">
+      <body>
+        <IdbProvider />
+        {children}
+      </body>
+    </html>
+  );
+}
+```
+
+---
+
+## ✅ IndexedDB is now created and ready to use.
+
+🚀 Using IndexedDB in Components
+Import the Hook
+
+```bash
+import { useIdbStore } from "universe-code/react";
+```
+
+Initialize Store
+
+```bash
+const idbStore = useIdbStore();
+```
+
+All IndexedDB helper functions are now available inside idbStore.
+
+---
+
+## 🔁 API Fetch + Cache with Expiry
+
+Fetch API data and automatically store it in IndexedDB with expiry control.
+
+```bash
+idbStore
+  .getWithExpiry("users", minutesToMs(1), async () => {
+    const res = await fetch("https://example.com/api/user", {
+      method: "GET",
+      headers: {
+        "Content-Type": "application/json",
+      },
+    });
+
+    const data = await res.json();
+    return data.data;
+  })
+  .then(console.log);
+```
+### Note:
+
+import minutesToMs() from universe-code/core
+
+```bash
+import { minutesToMs } from "universe-code/core";
+```
+
+### 🧠 How it works
+
+- Calls API only if data is missing or expired
+- Saves response in IndexedDB
+- Returns cached data instantly on next call
+
+---
+
+## 📥 Get Data from IndexedDB
+```bash
+const data = await idbStore.get("users");
+console.log(data);
+```
+
+---
+
+## ✏️ Insert / Update Data
+```bash
+idbStore.put({
+  id: "users",
+  data: {
+    name: "Mark",
+    country: "USA",
+  },
+  timestamp: Date.now(),
+});
+```
+
+---
+
+### 🗑️ Delete a Specific Record
+
+```bash
+idbStore.remove("users");
+```
+
+---
+
+## 🧹 Clear Entire IndexedDB Store
+
+```bash
+idbStore.clear();
+```
+
+---
+
+### 📚 API Reference
+
+| Function | Description |
+|---------|------------|
+| `get(id)` | Retrieve data from IndexedDB |
+| `put(payload)` | Insert or update data |
+| `remove(id)` | Delete a record |
+| `clear()` | Clear all IndexedDB data |
+| `getWithExpiry(id, expiry, callback)` | Fetch and cache data with expiry |
+
+---
+
+## ✅ Ideal Use Cases
+
+- API response caching
+- Offline-first applications
+- Performance optimization
+- Reducing repeated API calls
+- Storing session or user data
+
+---
+
+## 🛡 License
+
+MIT License © universe-code

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "universe-code",
-  "version": "0.0.64",
+  "version": "0.0.66",
   "description": "Universal utility functions for all JS frameworks",
   "license": "ISC",
   "type": "module",