@emmvish/stable-request 1.3.7 → 1.3.9

package/README.md

@@ -1,10 +1,25 @@
 # stable-request
 
-**stable-request** is a TypeScript-first **HTTP workflow execution engine** for real-world distributed systems — where HTTP `200 OK` does **not** guarantee business success.
+**stable-request** is a TypeScript-first **HTTP workflow execution engine** for real-world distributed systems — where HTTP `200 OK` does **not** guarantee business success, and HTTP failures still deserve **structured, actionable responses**.
 
-It enables **content-aware retries**, **hierarchical configuration**, **batch orchestration**, and **multi-phase workflows** with deep observability — all built on top of standard HTTP calls.
+It ensures that **every request attempt**, whether it succeeds or fails, can be:
 
-All in all, it provides you with the **entire ecosystem** to build **API-integrations based workflows**.
+- Observed
+- Analyzed
+- Retried intelligently
+- Suppressed when non-critical
+- Escalated when business-critical
+
+All without crashing your application or hiding context behind opaque errors.
+
+**stable-request treats failures as data.**
+
+> If you’ve ever logged `error.message` and thought  
+> **“This tells me absolutely nothing”** — this library is for you.
+
+In addition, it enables **content-aware retries**, **hierarchical configuration**, **batch orchestration**, and **multi-phase workflows** with deep observability — all built on top of standard HTTP calls.
+
+All in all, it provides you with the **entire ecosystem** to build **API-integrations based workflows** with **complete flexibility**.
 
 ---
 
@@ -181,30 +196,38 @@ npm install @emmvish/stable-request
 ### 1. Basic Request (No Retries)
 
 ```typescript
-import { stableRequest } from '@emmvish/stable-request';
+import { stableRequest, REQUEST_METHODS } from '@emmvish/stable-request';
 
-interface RequestBodyParams {
-  page: number,
-  offset: number
+interface PatchRequestBodyParams {
+  id: number;
+  updates: {
+    name?: string;
+    age?: number;
+  }
 }
 
 interface ResponseParams {
-  id: number,
-  name: string
+  id: number;
+  name: string;
+  age: number;
 }
 
 const getStableResponse = async () => {
-  const data = await stableRequest<RequestBodyParams, ResponseParams>({
+
+  const token = 'my-auth-token';
+
+  const data = await stableRequest<PatchRequestBodyParams, ResponseParams>({
     reqData: {
+      method: REQUEST_METHODS.PATCH,
       hostname: 'api.example.com',
-      path: '/users/123',
+      path: '/users',
       headers: { Authorization: `Bearer ${token}` },
-      query: { page: 10, offset: 5 }
+      body: { id: 123, updates: { age: 27 } }
     },
     resReq: true  // Return the response data
   });
   
-  console.log(data); // { id: 123, name: 'John' }
+  console.log(data); // { id: 123, name: 'MV', age: 27 }
 }
 
 getStableResponse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emmvish/stable-request",
-  "version": "1.3.7",
+  "version": "1.3.9",
   "description": "stable-request is a TypeScript-first HTTP reliability toolkit for workflow-driven API integrations, that goes beyond status-code retries by validating response content, handling eventual consistency, coordinating batch workflows with intelligent grouping, and providing deep observability into every request attempt. It is designed for real-world distributed systems where HTTP success does not guarantee business success. It also provides extensive support for managing multiple requests so as to achieve workflow automation.",
   "type": "module",
   "main": "dist/index.js",