jiren 1.5.5 → 1.6.0

package/README.md

@@ -7,16 +7,30 @@
 
 ---
 
+## ⚡ Performance: Fastest in the World
+
+Jiren outperforms top clients in every metric—throughput, latency, and stability.
+
+| Client    | Avg Latency | P99 Latency | Throughput   | Relative Speed |
+| --------- | ----------- | ----------- | ------------ | -------------- |
+| **Jiren** | **21.6 µs** | **46.0 µs** | **46,000/s** | **🚀 Fastest** |
+| Bun Fetch | 30.7 µs     | 58.5 µs     | 32,500/s     | 1.4x Slower    |
+| Undici    | 34.1 µs     | 76.5 µs     | 29,300/s     | 1.6x Slower    |
+| Ky        | 37.2 µs     | 57.0 µs     | 26,900/s     | 1.7x Slower    |
+| Axios     | 59.6 µs     | 122.1 µs    | 16,700/s     | 2.8x Slower    |
+
+---
+
 ## ✨ Why Jiren?
 
-| Feature                  | Benefit                                           |
-| ------------------------ | ------------------------------------------------- |
-| ⚡ **Blazing Fast**      | 2-3x faster than native `fetch`                   |
-| � **HTTP/3 Support**     | Automatic protocol upgrade for faster connections |
-| �💾 **Built-in Caching** | Automatic response caching with zero config       |
-| 📝 **Type-Safe**         | Full TypeScript support with autocomplete         |
-| 🔒 **Anti-Bot Ready**    | Bypass common bot protections easily              |
-| 📊 **Built-in Metrics**  | Track performance out of the box                  |
+| Feature                 | Benefit                                           |
+| ----------------------- | ------------------------------------------------- |
+| ⚡ **Blazing Fast**     | Proven to be the fastest JS HTTP client           |
+| **HTTP/3 Support**      | Automatic protocol upgrade for faster connections |
+| 💾 **Built-in Caching** | Automatic response caching with zero config       |
+| 📝 **Type-Safe**        | Full TypeScript support with autocomplete         |
+| 🔒 **Anti-Bot Ready**   | Bypass common bot protections easily              |
+| 📊 **Built-in Metrics** | Track performance out of the box                  |
 
 ---
 
@@ -36,7 +50,7 @@ bun add jiren
 import { JirenClient } from "jiren";
 
 const client = new JirenClient({
-  warmup: {
+  targets: {
     api: "https://api.example.com",
     github: "https://api.github.com",
   },
@@ -173,7 +187,7 @@ Enable caching for instant responses on repeated requests:
 
 ```typescript
 const client = new JirenClient({
-  warmup: {
+  targets: {
     api: {
       url: "https://api.example.com",
       cache: true, // ← Enable caching (60s default)
@@ -186,7 +200,7 @@ const client = new JirenClient({
 
 ```typescript
 const client = new JirenClient({
-  warmup: {
+  targets: {
     api: {
       url: "https://api.example.com",
       cache: { ttl: 300000 }, // 5 minutes
@@ -206,6 +220,10 @@ const client = new JirenClient({
 | First request  | ~150ms | -                  |
 | Cached request | ~1-2ms | **100x faster** ⚡ |
 
+### 🚀 Performance Benchmark
+
+See the [top of this README](#-performance-fastest-in-the-world) for detailed benchmark results. Jiren consistently wins on throughput and tail latency.
+
 ### Refresh Cache
 
 ```typescript
@@ -223,7 +241,7 @@ Bypass Cloudflare and other bot protections:
 
 ```typescript
 const client = new JirenClient({
-  warmup: {
+  targets: {
     protected: "https://protected-site.com",
   },
   antibot: true,
@@ -242,7 +260,7 @@ Add middleware to modify requests/responses:
 
 ```typescript
 const client = new JirenClient({
-  warmup: { api: "https://api.example.com" },
+  targets: { api: "https://api.example.com" },
   interceptors: {
     request: [
       (ctx) => ({
@@ -261,7 +279,7 @@ const client = new JirenClient({
 
 ```typescript
 const client = new JirenClient({
-  warmup: { api: "https://api.example.com" },
+  targets: { api: "https://api.example.com" },
   interceptors: {
     response: [
       (ctx) => {
@@ -277,7 +295,7 @@ const client = new JirenClient({
 
 ```typescript
 const client = new JirenClient({
-  warmup: { api: "https://api.example.com" },
+  targets: { api: "https://api.example.com" },
   interceptors: {
     error: [
       (error, ctx) => {
@@ -360,7 +378,7 @@ console.log(user.name); // ✅ Autocomplete works!
 
 ```typescript
 const client = new JirenClient({
-  warmup: {
+  targets: {
     api: "https://api.example.com",
     cdn: "https://cdn.example.com",
   },
@@ -379,7 +397,7 @@ client.url.foo.get(); // ❌ TypeScript error!
 
 ```typescript
 new JirenClient({
-  warmup: {
+  targets: {
     // Simple URL
     api: "https://api.example.com",
 
@@ -451,7 +469,7 @@ new JirenClient({
 import { JirenClient } from "jiren";
 
 export const api = new JirenClient({
-  warmup: {
+  targets: {
     backend: {
       url: process.env.API_URL!,
       cache: { ttl: 30000 },
@@ -511,15 +529,53 @@ function UserList() {
 
 ---
 
+## 🏗️ Framework Integration
+
+### Next.js (App Router)
+
+To use Jiren in Next.js, add it to `serverExternalPackages` in `next.config.ts`:
+
+```typescript
+import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+  // Required: Treat Jiren and Koffi as external native packages
+  serverExternalPackages: ["jiren", "koffi"],
+};
+
+export default nextConfig;
+```
+
+**Usage in API Routes:**
+
+```typescript
+// app/api/data/route.ts
+import { JirenClient } from "jiren";
+
+const client = new JirenClient({
+  targets: [{ key: "api", url: "https://api.example.com" }],
+});
+
+export async function GET() {
+  const response = await client.url.api.get({ path: "/users" });
+  return Response.json(await response.body.json());
+}
+```
+
+---
+
 ## 📋 Requirements
 
-- **Bun** v1.0.0+
+- **Runtime**:
+  - **Bun** v1.0.0+
+  - **Node.js** v18.0.0+ (macOS/Linux)
+- **OS**: macOS (ARM64/x64) or Linux (x64)
 
 ---
 
 ## 📄 License
 
-MIT © Vikash Khati
+MIT © VK
 
 ---
 
@@ -538,5 +594,5 @@ Contributions welcome! Please open an issue or submit a pull request.
 ---
 
 <p align="center">
-  <strong>Made with ⚡ by Vikash Khati</strong>
+  <strong>Made with ⚡ by VK</strong>
 </p>

package/components/cache.ts

@@ -10,7 +10,7 @@ import {
 import { gzipSync, gunzipSync } from "zlib";
 import { createHash } from "crypto";
 import { join } from "path";
-import type { JirenResponse, JirenResponseBody } from "./types";
+import type { JirenResponse, JirenResponseBody } from "./types.js";
 
 /**
  * Serializable cache entry - stores raw body data for reconstruction