axiomate 1.0.1 → 1.0.3

package/README.md

@@ -16,12 +16,12 @@ npm install axiomate axios
 
 ## Quick Start
 
-### 1. Setup (sirf ek baar — `index.js` ya `App.js` mein)
+### 1. Setup (once — in `index.js` or `App.js`)
 
 ```js
 import { setTokenGetter, addErrorInterceptor } from "axiomate";
 
-// Token kahan se lena hai batao
+// Tell axiomate where to get the auth token
 setTokenGetter(() => localStorage.getItem("token"));
 
 // Global error handling
@@ -32,7 +32,7 @@ addErrorInterceptor((error) => {
 });
 ```
 
-### 2. API define karo (ek file — `api.config.js`)
+### 2. Define your API (one file — `api.config.js`)
 
 ```js
 import { createApi } from "axiomate";
@@ -48,7 +48,7 @@ export const api = createApi({
 });
 ```
 
-### 3. Anywhere use karo
+### 3. Use anywhere
 
 ```js
 import { api } from "./api.config";
@@ -84,20 +84,20 @@ function ProfilePage() {
 
 | Option | Type | Required | Default | Description |
 |--------|------|----------|---------|-------------|
-| `baseUrl` | string | ✅ | — | Backend ka base URL |
-| `endpoints` | object | ✅ | — | Endpoints ka map |
+| `baseUrl` | string | ✅ | — | Your backend base URL |
+| `endpoints` | object | ✅ | — | Map of all endpoints |
 | `headers` | object | ❌ | `{}` | Extra default headers |
-| `timeout` | number | ❌ | `10000` | Timeout in ms |
-| `autoToken` | boolean | ❌ | `true` | Auto Bearer token attach |
+| `timeout` | number | ❌ | `10000` | Request timeout in ms |
+| `autoToken` | boolean | ❌ | `true` | Auto-attach Bearer token |
 
 ### `setTokenGetter(fn)`
-Token kahan se lena hai define karo.
+Define how axiomate should retrieve the auth token.
 ```js
 setTokenGetter(() => store.getState().auth.token);
 ```
 
 ### `addRequestInterceptor(fn)`
-Har request se pehle kuch karo.
+Run a function before every outgoing request.
 ```js
 addRequestInterceptor((config) => {
   config.headers["X-App-Version"] = "2.0";
@@ -106,7 +106,7 @@ addRequestInterceptor((config) => {
 ```
 
 ### `addResponseInterceptor(fn)`
-Har response aane ke baad kuch karo.
+Run a function after every successful response.
 ```js
 addResponseInterceptor((response) => {
   console.log("Response:", response.config.url);
@@ -115,7 +115,7 @@ addResponseInterceptor((response) => {
 ```
 
 ### `addErrorInterceptor(fn)`
-Koi request fail ho toh handle karo.
+Handle failed requests globally.
 ```js
 addErrorInterceptor((error) => {
   if (error.status === 403) alert("Access denied!");
@@ -126,17 +126,17 @@ addErrorInterceptor((error) => {
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `params` | object | `{}` | Default params |
-| `immediate` | boolean | `true` | Mount pe call karo |
-| `initialData` | any | `null` | Initial data value |
+| `params` | object | `{}` | Default params passed to the function |
+| `immediate` | boolean | `true` | Call automatically on mount |
+| `initialData` | any | `null` | Initial value for `data` |
 
 **Returns:** `{ data, loading, error, execute, reset }`
 
 ```jsx
-// Auto call
+// Auto call on mount
 const { data, loading, error } = useApi(api.getUser);
 
-// Manual call
+// Manual call (e.g. on form submit)
 const { execute, loading } = useApi(api.login, { immediate: false });
 await execute({ username, password });
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axiomate",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Zero-boilerplate API client — define once, use everywhere.",
   "main": "src/index.js",
   "module": "src/index.js",

package/src/_store.js

@@ -1,9 +1,3 @@
-/**
- * _store.js
- * Internal shared state — library ke andar use hota hai
- * Developer directly use na kare
- */
-
 const _store = {
   instance: null,
   interceptors: {

package/src/createApi.js

@@ -1,14 +1,11 @@
 const axios = require("axios");
 const { _store } = require("./_store");
 
-/**
- * Token getter — developer set karta hai apna logic
- */
 let _getToken = () => localStorage.getItem("token");
 
 /**
- * setTokenGetter — developer apna token logic provide kare
- * @param {Function} fn - function jo token return kare
+ * setTokenGetter — Developer provider there function to get token
+ * @param {Function} fn - function who return the token string
  *
  * @example
  * setTokenGetter(() => store.getState().auth.token);
@@ -21,13 +18,13 @@ const setTokenGetter = (fn) => {
  * createApi — library ka core function
  *
  * @param {Object} config
- * @param {string} config.baseUrl       - Backend ka base URL
- * @param {Object} config.endpoints     - Sare endpoints ka map
+ * @param {string} config.baseUrl       - Backend base URL
+ * @param {Object} config.endpoints     - All endpoints map
  * @param {Object} [config.headers]     - Extra default headers
  * @param {number} [config.timeout]     - Request timeout ms (default: 10000)
- * @param {boolean} [config.autoToken]  - Auto Bearer token lagao (default: true)
+ * @param {boolean} [config.autoToken]  - Auto Bearer token (default: true)
  *
- * @returns {Object} - Har endpoint ke liye ek callable function
+ * @returns {Object}
  *
  * @example
  * const api = createApi({
@@ -54,7 +51,7 @@ const createApi = (config) => {
     console.warn("[axiomate] No endpoints defined.");
   }
 
-  // Axios instance banao
+  // Create Axios instance
   _store.instance = axios.create({
     baseURL: baseUrl,
     timeout,
@@ -75,7 +72,7 @@ const createApi = (config) => {
         }
       }
 
-      // Developer ke custom request interceptors chalao
+
       let finalConfig = axiosConfig;
       for (const fn of _store.interceptors.request) {
         finalConfig = fn(finalConfig) || finalConfig;
@@ -96,12 +93,11 @@ const createApi = (config) => {
       return finalResponse;
     },
     (error) => {
-      // Developer ke custom error interceptors chalao
+
       for (const fn of _store.interceptors.error) {
         fn(error);
       }
 
-      // Meaningful error message banao
       const status = error?.response?.status;
       const message =
         error?.response?.data?.message ||
@@ -118,7 +114,7 @@ const createApi = (config) => {
     }
   );
 
-  // ─── Endpoints ko functions mein convert karo ─────────────────────────────
+  // ─── Convert endpoints map to functions ─────────────────────────────────
   const api = {};
 
   for (const [name, endpoint] of Object.entries(endpoints)) {
@@ -132,9 +128,9 @@ const createApi = (config) => {
     /**
      * Generated endpoint function
      *
-     * @param {Object} [data]          - POST/PUT ke liye request body
-     * @param {Object} [params]        - GET ke liye query params
-     * @param {Object} [extraConfig]   - Axios extra config override
+     * @param {Object} [data]
+     * @param {Object} [params]
+     * @param {Object} [extraConfig]
      */
     api[name] = (data = {}, params = {}, extraConfig = {}) => {
       const upperMethod = method.toUpperCase();

package/src/interceptors.js

@@ -1,13 +1,13 @@
 /**
  * interceptors.js
- * Developer apne custom interceptors register kare
+ * Developers can register their custom interceptors here
  */
 
 const { _store } = require("./_store");
 
 /**
  * addRequestInterceptor
- * Har request jaane se pehle ye function chalega
+ * This function runs before every request is sent
  *
  * @param {Function} fn - (axiosConfig) => axiosConfig
  *
@@ -23,7 +23,7 @@ const addRequestInterceptor = (fn) => {
 
 /**
  * addResponseInterceptor
- * Har successful response aane ke baad ye function chalega
+ * This function runs after every successful response is received
  *
  * @param {Function} fn - (response) => response
  *
@@ -39,7 +39,7 @@ const addResponseInterceptor = (fn) => {
 
 /**
  * addErrorInterceptor
- * Koi bhi request fail ho toh ye function chalega
+ * This function runs when any request fails
  *
  * @param {Function} fn - (error) => void
  *

package/src/useApi.js

@@ -2,13 +2,13 @@ const { useState, useEffect, useCallback, useRef } = require("react");
 
 /**
  * useApi — React hook for API calls
- * Loading, error, data sab automatic!
+ * Loading, error, data states are all automatic!
  *
- * @param {Function} apiFn        - api.getUser jaise function
+ * @param {Function} apiFn        - api.getUser like function
  * @param {Object}   [options]
- * @param {any}      [options.params]      - Function ko pass karne wale params
- * @param {boolean}  [options.immediate]   - Mount hote hi call karo (default: true)
- * @param {any}      [options.initialData] - Data ka initial value
+ * @param {any}      [options.params]      - Parameters to pass to the function
+ * @param {boolean}  [options.immediate]   - Call immediately on mount (default: true)
+ * @param {any}      [options.initialData] - Initial value for data
  *
  * @returns {{ data, loading, error, execute, reset }}
  *
@@ -34,7 +34,7 @@ const useApi = (apiFn, options = {}) => {
   const [loading, setLoading] = useState(immediate);
   const [error, setError] = useState(null);
 
-  // Latest params ref — stale closure se bachne ke liye
+  // Latest params ref — to avoid stale closure
   const paramsRef = useRef(params);
   paramsRef.current = params;