fast-api-tester 1.0.23 → 1.0.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-api-tester",
-  "version": "1.0.23",
+  "version": "1.0.24",
   "description": "Ultra-fast, connection-pooled API testing library for Node.js",
   "type": "module",
   "main": "./dist/index.js",

package/readme

@@ -259,6 +259,61 @@ await engine.startHeartbeat(async () => {
 
 ---
 
+## ⚡ Key Visualizations & Diagnostic Features
+
+### 🌊 1. 500 Cascade Waterfall Timeline (Floating Execution Window)
+
+- **What it does**: Renders a floating horizontal bar chart displaying the exact timing, duration, and execution sequence of every HTTP request in your test workflow.
+- **Why it matters**: In sequential API chains (e.g., `Auth` → `Cart` → `Checkout`), a single `500 Internal Server Error` can stall downstream services. The waterfall chart visually pinpoints the precise endpoint and millisecond offset where the execution chain collapsed.
+- **Color Coding**:
+  - 🟢 Green: Successful execution (2xx / 3xx).
+  - 🟠 Orange: Client-side failure (4xx).
+  - 🔴 Red Alert: Critical backend server fault (500 / 5xx).
+
+### 🥧 2. Status Code Distribution Matrix
+
+- **What it does**: Categorizes responses into high-level HTTP status families (2xx Success, 4xx Client Errors, 5xx Server Failures).
+- **Why it matters**: Quickly exposes whether test failures are caused by client assertion mismatches (404 / 422) or infrastructure/service outages (500 / 502 / 503).
+
+### 📈 3. Historical Run Trend Analysis
+
+- **What it does**: Tracks pass/fail counts across the last 10 test execution cycles (persisted automatically via local execution history).
+- **Why it matters**: Detects flaky endpoints, intermittent microservice degradation, and build stability trends over time when running continuous heartbeat monitoring.
+
+### 📄 4. One-Click Executive PDF Export
+
+- **What it does**: Embedded browser-side PDF generation via client-side streaming (PDFKit & Blob Stream).
+- **Why it matters**: Instantly creates a clean, C-suite ready PDF summary containing SLA metrics, overall pass rates, and detailed execution logs — no external server-side PDF generator binaries required.
+
+---
+
+## 🚀 Semantic Status Code Helpers
+
+To make test assertions more expressive, readable, and maintainable, a comprehensive suite of semantic status code helpers has been integrated into the `ApiResponse` class.
+
+These new methods seamlessly wrap around the existing `.expectStatus()` mechanism and error-handling flow, keeping the core engine intact while drastically improving test script readability.
+
+### Summary of Available Helpers
+
+| Category | Method | Expected Status Code / Range |
+|---|---|---|
+| 2xx Success | `.expectStatusCreated()` | 201 Created |
+| 2xx Success | `.expectStatusAccepted()` | 202 Accepted |
+| 2xx Success | `.expectStatusNoContent()` | 204 No Content |
+| 2xx Success | `.expectStatus2xx()` | Any 200–299 status code |
+| 4xx Client Errors | `.expectStatusBadRequest()` | 400 Bad Request |
+| 4xx Client Errors | `.expectStatusUnauthorized()` | 401 Unauthorized |
+| 4xx Client Errors | `.expectStatusForbidden()` | 403 Forbidden |
+| 4xx Client Errors | `.expectStatusNotFound()` | 404 Not Found |
+| 4xx Client Errors | `.expectStatusUnprocessableEntity()` | 422 Unprocessable Entity |
+| 4xx Client Errors | `.expectStatus4xx()` | Any 400–499 status code |
+| 5xx Server Errors | `.expectStatusInternalServerError()` | 500 Internal Server Error |
+| 5xx Server Errors | `.expectStatusBadGateway()` | 502 Bad Gateway |
+| 5xx Server Errors | `.expectStatusServiceUnavailable()` | 503 Service Unavailable |
+| 5xx Server Errors | `.expectStatus5xx()` | Any 500–599 status code |
+
+---
+
 ## 📜 License
 
 [MIT](./LICENSE) © Kushan Amarasiri