auravia-connect 1.0.2 → 1.0.3

package/Readme.md

@@ -1,28 +1,283 @@
 # auravia-connect
 
-🚀 Smart frontend–backend connector with built-in mocking, fallback, and debug timeline.
+🚀 Smart frontend–backend connector with built-in mocking, fallback, and auto-mocking.
 
-Auravia Connect is a lightweight HTTP client designed to simplify communication between frontend and backend while providing powerful developer tools like smart mocking and automatic fallback.
+Auravia Connect is a lightweight HTTP client that keeps your frontend moving — even when your backend isn’t ready.
 
 ---
 
-## ✨ Features
+## ✨ Why auravia-connect?
 
-- 🔗 Simple HTTP client (GET, POST, PUT, PATCH, DELETE)
-- 🧠 Smart mock generator
-- 🧪 Wildcard route mocking (`/users/:id`)
-- ⏱ Mock delay simulation
-- 🚨 Error simulation
-- 🔄 Smart fallback when network fails
-- 🧩 Request & response interceptors
-- 🧭 Debug timeline
-- ⚙️ Strategy control (prefer mock or network)
-- 📦 Zero dependencies
-- ⚡ Lightweight
+Most tools only send requests.
+Auravia goes further:
+
+* 🔗 Simple HTTP client
+* 🧪 Built-in mocking
+* 🔄 Smart fallback when network fails
+* ⚡ Auto mock when backend is unavailable
+* 🧩 Request & response interceptors
+* 🧭 Debug timeline
+* 📦 Zero dependencies
+* ⚡ Lightweight
+
+👉 **Your UI keeps working — even when your backend doesn’t.**
 
 ---
 
 ## 📦 Installation
 
 ```bash
-npm install auravia-connect
+npm install auravia-connect
+```
+
+---
+
+## 🚀 Quick Start
+
+```js
+const { createClient } = require("auravia-connect");
+
+const api = createClient({
+  baseURL: "https://api.example.com"
+});
+
+async function run() {
+  const res = await api.get("/users");
+  console.log(res.data);
+}
+
+run();
+```
+
+---
+
+## 🧪 Manual Mocking
+
+Use manual mocks when you want full control over fake data.
+
+```js
+const api = createClient({
+  mock: true,
+  debug: true
+});
+
+api.mock("/users", {
+  id: "number",
+  name: "text"
+}, { count: 3 });
+
+const res = await api.get("/users");
+console.log(res.data);
+```
+
+✅ Works without a backend.
+
+---
+
+## 🎯 Wildcard Routes
+
+Auravia supports dynamic routes.
+
+```js
+api.mock("/users/:id", {
+  id: "number",
+  name: "text"
+});
+
+await api.get("/users/42");
+```
+
+---
+
+## 🔄 Smart Fallback
+
+Automatically return mock when network fails.
+
+```js
+const api = createClient({
+  baseURL: "http://localhost:5000",
+  mock: true,
+  mockFallback: true,
+  debug: true
+});
+```
+
+**Flow**
+
+```
+network fails → fallback mock used
+```
+
+---
+
+## ⚡ Auto Mock Mode (⭐ Standout Feature)
+
+Auravia can generate smart fake data automatically — no manual mocks needed.
+
+```js
+const api = createClient({
+  autoMock: true,
+  debug: true
+});
+
+const res = await api.get("/users");
+console.log(res.data);
+```
+
+**Example output**
+
+```js
+{
+  id: 123,
+  name: "Sample text",
+  active: true
+}
+```
+
+### When AutoMock runs
+
+AutoMock triggers when:
+
+* ❌ no manual mock exists
+* ❌ network request fails
+* ✅ `autoMock: true` is enabled
+
+---
+
+## ⚙️ Mock Strategy
+
+Control whether to prefer mock or network.
+
+### Prefer mock (default)
+
+```js
+createClient({
+  mock: true,
+  mockStrategy: "prefer-mock"
+});
+```
+
+**Flow**
+
+```
+mock exists → return immediately
+```
+
+---
+
+### Prefer network first
+
+```js
+createClient({
+  mock: true,
+  mockFallback: true,
+  mockStrategy: "prefer-network"
+});
+```
+
+**Flow**
+
+```
+try network → if fails → fallback mock
+```
+
+---
+
+## 🧩 Interceptors
+
+### Request interceptor
+
+```js
+api.onRequest((config) => {
+  config.headers.Authorization = "Bearer token";
+  return config;
+});
+```
+
+### Response interceptor
+
+```js
+api.onResponse((response) => {
+  if (!response.ok) {
+    console.error("API Error:", response.error);
+  }
+  return response;
+});
+```
+
+---
+
+## 🧭 Debug Timeline
+
+Enable detailed request logs.
+
+```js
+const api = createClient({
+  debug: true
+});
+```
+
+**Example output**
+
+```
+[auravia] → GET /users
+[auravia] … trying network
+[auravia] ⚡ auto mock generated
+[auravia] ⏱ 42ms
+```
+
+---
+
+## 📚 API Reference
+
+### createClient(config)
+
+Creates a new client instance.
+
+| Option       | Type    | Description                           |
+| ------------ | ------- | ------------------------------------- |
+| baseURL      | string  | Base API URL                          |
+| headers      | object  | Default headers                       |
+| timeout      | number  | Request timeout (ms)                  |
+| mock         | boolean | Enable manual mocks                   |
+| mockFallback | boolean | Enable fallback to mock               |
+| autoMock     | boolean | Enable automatic mock generation      |
+| debug        | boolean | Enable debug logs                     |
+| mockStrategy | string  | `"prefer-mock"` or `"prefer-network"` |
+
+---
+
+### api.mock(url, response, options)
+
+Register a manual mock.
+
+**Built-in generators**
+
+* `"text"`
+* `"number"`
+* `"boolean"`
+* `"uuid"`
+* `"image"`
+* `"video"`
+* `"mp3"`
+
+**Example**
+
+```js
+api.mock("/profile", {
+  id: "number",
+  avatar: "image"
+});
+```
+
+-
+
+## 🤝 Contributing
+
+Issues and PRs are welcome.
+
+---
+
+## 📄 License
+
+MIT © Dinesh R

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auravia-connect",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Smart frontend-backend connector with built-in mocking and fallback",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",