barejs 0.1.44 → 0.1.47

package/README.md

@@ -1,57 +1,54 @@
 <div align="center">
-  <br />
-  <h1>Bare<span style="color: #F7DF1E;">JS</span></h1>
-  <p><strong>The "Metal" of Web Frameworks</strong></p>
-  <p><i>An ultra-high-performance web engine built for Bun, architected strictly for Mechanical Sympathy.</i></p>
-
-  <p>
-    <a href="https://www.npmjs.com/package/barejs">
-      <img src="https://img.shields.io/npm/v/barejs?style=for-the-badge&logo=npm&color=CB3837" alt="NPM Version">
-    </a>
-    <a href="https://github.com/xarhang/bareJS/actions/workflows/bench.yml">
-      <img src="https://img.shields.io/github/actions/workflow/status/xarhang/bareJS/bench.yml?branch=main&label=Performance&style=for-the-badge&logo=github" alt="Performance">
-    </a>
-    <a href="https://bun.sh">
-      <img src="https://img.shields.io/badge/Bun-%3E%3D1.0.0-black?style=for-the-badge&logo=bun" alt="Bun Version">
-    </a>
-    <a href="https://github.com/xarhang/bareJS/blob/main/LICENSE">
-      <img src="https://img.shields.io/github/license/xarhang/bareJS?style=for-the-badge&color=blue" alt="License">
-    </a>
-  </p>
-
-  <p align="center">
-    <a href="#-benchmarks">Benchmarks</a> •
-    <a href="#-features">Features</a> •
-    <a href="#-quick-start">Quick Start</a> •
-    <a href="#-architecture">Architecture</a>
-  </p>
-
-  ---
+<br />
+<h1>Bare<span style="color: #F7DF1E;">JS</span></h1>
+<p><strong>The "Metal" of Web Frameworks</strong></p>
+<p><i>An ultra-high-performance web engine built for Bun, architected strictly for Mechanical Sympathy.</i></p>
+
+<p>
+<a href="https://www.npmjs.com/package/barejs">
+<img src="https://img.shields.io/npm/v/barejs?style=for-the-badge&logo=npm&color=CB3837" alt="NPM Version">
+</a>
+<a href="https://github.com/xarhang/barejs/actions/workflows/bench.yml">
+<img src="https://img.shields.io/github/actions/workflow/status/xarhang/barejs/bench.yml?branch=main&label=Performance&style=for-the-badge&logo=github" alt="Performance">
+</a>
+<a href="https://bun.sh">
+<img src="https://img.shields.io/badge/Bun-%3E%3D1.0.0-black?style=for-the-badge&logo=bun" alt="Bun Version">
+</a>
+<a href="https://github.com/xarhang/barejs/blob/main/LICENSE">
+<img src="https://img.shields.io/github/license/xarhang/barejs?style=for-the-badge&color=blue" alt="License">
+</a>
+</p>
+</div>
+
+---
+
 </div>
 
 ## 📊 Benchmarks: Real-World Performance
 
-BareJS leads in complex, real-world scenarios. We measure engine efficiency using a **stress test** involving **10+ middlewares** and **deep radix tree routing** to ensure performance holds under high concurrency, not just in isolated "Hello World" loops.
+BareJS leads in complex, real-world scenarios. We measure engine efficiency using a **stress test** involving **10+ middlewares** and **deep radix tree routing** to ensure performance holds under high concurrency.
 <!-- MARKER: PERFORMANCE_TABLE_START -->
 
 | Framework | Latency | Speed |
 | :--- | :--- | :--- |
-| **BareJS** | **1.57 µs** | **Baseline** |
-| Elysia | 2.43 µs | 1.55x slower |
-| Hono | 10.63 µs | 6.76x slower |
+| **BareJS** | **1.79 µs** | **Baseline** |
+| Elysia | 2.44 µs | 1.36x slower |
+| Hono | 9.86 µs | 5.52x slower |
 
-> Last Updated: 2026-01-12 (github action)
+> Last Updated: 2026-01-14 (github action)
 
 <!-- MARKER: PERFORMANCE_TABLE_END -->
+
 > [!TIP]
-> **View our [Continuous Benchmark Dashboard](https://xarhang.github.io/bareJS/dev/benchmarks/)** for historical data and detailed performance trends across different hardware.
+> **View our [Continuous Benchmark Dashboard**](https://xarhang.github.io/bareJS/dev/benchmarks/) for historical data and detailed performance trends.
 
 ## 🚀 Key Features
 
-* **JIT Pipeline Compilation**: Routes and middleware chains are compiled into a single, flattened JavaScript function at runtime to eliminate recursive call overhead.
-* **Object Pooling**: Recycles `Context` objects via a circular buffer, significantly reducing Garbage Collection (GC) pressure.
-* **Lazy Body Parsing**: Requests are processed instantly. Payloads are only parsed on-demand via `ctx.jsonBody()`, maintaining peak speed for GET requests.
-* **Mechanical Sympathy**: Intentionally designed to align with V8's optimization heuristics and Bun's internal I/O architecture.
+* **JIT Pipeline Compilation**: Routes and middleware chains are flattened into a single function at runtime.
+* **Object Pooling**: Recycles `Context` objects via a circular buffer, drastically reducing GC pressure.
+* **Internal High-Performance Logger**: Zero-overhead logging integrated directly into the JIT engine.
+* **Precise Radix Router**: v0.1.46 introduces optimized segment matching for deep-nested paths.
+* **Mechanical Sympathy**: Intentionally designed to align with V8's optimization and Bun's I/O.
 
 ## 🛠️ Installation
 
@@ -67,6 +64,9 @@ import { BareJS, type Context } from 'barejs';
 
 const app = new BareJS();
 
+// Enable Internal Logger
+app.useLog(true);
+
 app.get('/', (ctx: Context) => ctx.json({ hello: "world" }));
 
 app.listen(3000);
@@ -77,116 +77,79 @@ app.listen(3000);
 
 ## 📘 Comprehensive Guide
 
-### 1. 🔀 Advanced Routing
+### 1. ⚡ Standardized Response & Chaining
 
-Modularize your application and maintain clean codebases using `BareRouter`.
+BareJS v0.1.46 provides a fluent API for building responses.
 
 ```typescript
-import { BareJS, BareRouter, type Context } from 'barejs';
-
-const app = new BareJS();
-const api = new BareRouter("/api/v1");
-
-api.get("/status", (ctx: Context) => ({ status: "ok" }));
+app.get('/api/v1/health', (ctx: Context) => {
+  // Chainable status and standardized send helper
+  return ctx.status(200).send("System is healthy", { 
+    uptime: process.uptime() 
+  });
+});
 
-app.use(api); // Accessible at /api/v1/status
+// Output: { "status": "success", "msg": "System is healthy", "uptime": ... }
 
 ```
 
-### 2. 🛡️ Security & Authentication
-
-Built-in utilities for secure password hashing (Argon2/Bcrypt via Bun) and RFC-compliant JWT handling.
+### 2. 🛡️ Security & Authentication (Dual-API)
 
 ```typescript
-import { bareAuth, createToken, Password,Hash, type Context } from 'barejs';
+import { bareAuth, createToken, Password, Hash, type Context } from 'barejs';
 
-const SECRET = "your-ultra-secure-secret";
+const SECRET = process.env.JWT_SECRET || "your-secret";
 
-app.post('/login', async (ctx: Context) => {
+app.post('/register', async (ctx: Context) => {
   const body = await ctx.jsonBody();
-  //const hash = await Password.hash(body.password); //you can replace with Hash
-  const hash = await Hash.hash(body.password);
-  // const isValid = await Password.verify(body.password, hash); //you can replace with Hash
+  
+  // High-performance Argon2id Hashing (64MB default)
+  const hash = await Password.make(body.password); 
+  
+  // Verify with ease
   const isValid = await Hash.verify(body.password, hash);
+  
   if (isValid) {
     const token = await createToken({ id: 1 }, SECRET);
     return { token };
   }
 });
 
-// Protect routes with bareAuth middleware
+// Protect routes with built-in JWT middleware
 app.get('/me', bareAuth(SECRET), (ctx: Context) => {
-  const user = ctx.get('user'); // Identity injected by bareAuth
-  return { user };
+  return ctx.send("Authenticated", { user: ctx.get('user') });
 });
 
 ```
 
 ### 3. ✅ Data Validation (3 Styles)
 
-BareJS integrates deeply with TypeBox for JIT-level speeds but remains compatible with the broader ecosystem.
+BareJS is the only engine that offers JIT-optimized validation paths.
 
 ```typescript
 import { typebox, zod, native, t, type Context } from 'barejs';
 import { z } from 'zod';
 
-// Style A: TypeBox (Highest Performance - Recommended)
-const TypeBoxSchema = t.Object({ name: t.String() });
-app.post('/typebox', typebox(TypeBoxSchema), async (ctx: Context) => {
-  const body = await ctx.jsonBody();
-  return body;
-});
+// Style A: TypeBox (JIT Optimized - Recommended)
+// Pre-compiled validation to outperform competitors by 55%
+const Schema = t.Object({ name: t.String() });
+app.post('/user', typebox(Schema), (ctx) => ctx.json(ctx.body));
 
 // Style B: Zod (Industry Standard)
 const ZodSchema = z.object({ age: z.number() });
-app.post('/zod', zod(ZodSchema), async (ctx: Context) => {
-  const body = await ctx.jsonBody();
-  return body;
-});
-
-// Style C: Native (Zero Dependency / JSON Schema)
-const NativeSchema = { 
-  type: "object",
-  properties: { id: { type: 'number' } },
-  required: ["id"]
-};
-app.post('/native', native(NativeSchema), async (ctx: Context) => {
-  const body = await ctx.jsonBody();
-  return body;
-});
-
-```
-
-### 4. 🔌 Essential Plugins
-
-Standard utilities optimized for the BareJS engine's execution model.
-
-#### **Logger**
-
-High-precision terminal logging with color-coded status codes and microsecond timing.
+app.post('/age', zod(ZodSchema), (ctx) => ctx.json(ctx.body));
 
-```typescript
-import { logger } from 'barejs';
-app.use(logger);
+// Style C: Native (Zero Dependency - Simple Checks)
+app.post('/native', native({ properties: { id: { type: 'number' } } }), (ctx) => ctx.json(ctx.body));
 
 ```
 
-#### **CORS**
-
-Highly optimized Cross-Origin Resource Sharing middleware.
+### 4. 🔌 Essential Middleware
 
 ```typescript
-import { cors } from 'barejs';
-app.use(cors({ origin: "*", methods: ["GET", "POST"] }));
-
-```
+import { cors, staticFile } from 'barejs';
 
-#### **Static Files**
-
-Serves static assets with zero-overhead using Bun's native file system implementation.
-
-```typescript
-import { staticFile } from 'barejs';
+app.use(cors());
 app.use(staticFile("public"));
 
 ```
@@ -195,27 +158,27 @@ app.use(staticFile("public"));
 
 ## 🧠 Context API
 
-The `Context` object is pre-allocated in a circular pool to eliminate memory fragmentation.
-
 | Method / Property | Description |
 | --- | --- |
 | `ctx.req` | Raw incoming Bun `Request` object. |
-| `ctx.params` | Object containing route parameters (e.g., `:id`). |
-| **`ctx.jsonBody()`** | **[Async]** Parses the JSON body on-demand and caches it for the lifecycle. |
-| `ctx.status(code)` | Sets the HTTP status code (Chainable). |
-| `ctx.json(data)` | Finalizes and returns an optimized JSON response. |
-| `ctx.set(k, v)` | Stores metadata in the request-scoped store. |
-| `ctx.get(k)` | Retrieves stored data from the lifecycle store. |
+| `ctx.params` | Route parameters (e.g., `:id`). |
+| `ctx.jsonBody()` | **[Async]** Parses and caches JSON body for performance. |
+| `ctx.status(code)` | Sets the HTTP status code (**Chainable**). |
+| `ctx.send(msg, ext)` | Returns a standardized JSON response. |
+| `ctx.json(data)` | Returns an optimized raw JSON response. |
+| `ctx.setHeader(k, v)` | Sets a response header. |
+| `ctx.set / ctx.get` | Manual storage within the request lifecycle. |
 
 ---
 
 ## ⚙️ Performance Tuning
 
-| OS Variable | Default | Description |
+| OS Variable / File | Default | Description |
 | --- | --- | --- |
-| `BARE_POOL_SIZE` | `1024` | Pre-allocated context pool size. Must be a **Power of 2**. |
-| `NODE_ENV` | `development` | Use `production` to hide stack traces and enable V8's hot-path optimizations. |
+| `bare.config.ts` | - | Centralized config for Port and Hash algorithms. |
+| `BARE_POOL_SIZE` | `1024` | Context pool size (**Must be Power of 2**). |
+| `NODE_ENV` | `development` | Set to `production` to enable peak JIT optimizations. |
 
 ---
 
-**Maintained by [xarhang](https://github.com/xarhang) | **License: MIT**
+**Maintained by [xarhang](https://github.com/xarhang) | License: MIT**