shokupan 0.4.5 → 0.6.0

package/README.md

@@ -31,7 +31,7 @@ Shokupan is designed to make building APIs delightful again. With zero-config de
 > Bun and TypeScript are recommended for Shokupan, though it also supports Node.js and standard JavaScript.
 
 ```typescript
-import { Shokupan } from 'shokupan';
+import { Shokupan, ScalarPlugin } from 'shokupan';
 const app = new Shokupan();
 
 app.get('/', (ctx) => ({ message: 'Hello, World!' }));
@@ -75,6 +75,7 @@ That's it! Your server is running at `http://localhost:3000` 🎉
   - [Using Express Middleware](#using-express-middleware)
 - [Testing](#testing)
 - [Deployment](#deployment)
+- [Production Best Practices](https://knackstedt.github.io/shokupan/guides/production/) 📚
 - [CLI Tools](#cli-tools)
 - [API Reference](#api-reference)
 - [Roadmap](#-roadmap)
@@ -929,7 +930,7 @@ This works great when combined with the Debug Dashboard.
 A visual dashboard to inspect your application, view metrics, analyze the middleware graph, and replay failed requests.
 
 ```typescript
-import { DebugDashboard } from 'shokupan/plugins/debugview';
+import { DebugDashboard } from 'shokupan';
 
 // Mount the dashboard
 app.mount('/debug', new DebugDashboard({
@@ -1057,8 +1058,8 @@ router.get('/wines/white', async (ctx) => {
 router.get('/wines/all', async (ctx) => {
     // Make parallel sub-requests
     const [redResponse, whiteResponse] = await Promise.all([
-        router.subRequest('/wines/red'),
-        router.subRequest('/wines/white')
+        router.internalRequest('/wines/red'),
+        router.internalRequest('/wines/white')
     ]);
     
     const red = await redResponse.json();
@@ -1559,7 +1560,7 @@ describe('My App', () => {
         app.get('/', () => ({ message: 'Hello' }));
         
         // Process a request without starting the server
-        const res = await app.processRequest({
+        const res = await app.testRequest({
             method: 'GET',
             path: '/'
         });
@@ -1703,8 +1704,8 @@ const app = new Shokupan(config?: ShokupanConfig);
 - `mount(path, controller)` - Mount controller or router
 - `static(path, options)` - Serve static files
 - `listen(port?)` - Start server
-- `processRequest(options)` - Process request (testing)
-- `subRequest(options)` - Make sub-request
+- `testRequest(options)` - Process request (for testing purposes)
+- `internalRequest(options)` - Make sub-request
 - `computeOpenAPISpec(base)` - Generate OpenAPI spec
 
 ### ShokupanRouter Class
@@ -1737,8 +1738,8 @@ const router = new ShokupanRouter(config?: ShokupanRouteConfig);
 - `head(path, spec?, ...handlers)` - Add HEAD route
 - `mount(path, controller)` - Mount controller or router
 - `static(path, options)` - Serve static files
-- `processRequest(options)` - Process request (testing)
-- `subRequest(options)` - Make sub-request
+- `testRequest(options)` - Process request (for testing purposes)
+- `internalRequest(options)` - Make sub-request
 
 
 ### ShokupanContext

package/dist/analysis/openapi-analyzer.d.ts

@@ -130,10 +130,6 @@ export declare class OpenAPIAnalyzer {
      * Generate OpenAPI specification
      */
     generateOpenAPISpec(): any;
-    /**
-     * Convert a type string to an OpenAPI schema
-     */
-    private typeToSchema;
 }
 /**
  * Analyze a directory and generate OpenAPI spec

package/dist/cli.cjs

@@ -4,7 +4,7 @@ const p = require("@clack/prompts");
 const fs = require("node:fs");
 const path = require("node:path");
 const promises = require("node:timers/promises");
-const openapiAnalyzer = require("./openapi-analyzer-D9YB3IkV.cjs");
+const openapiAnalyzer = require("./openapi-analyzer-Bei1sVWp.cjs");
 function _interopNamespaceDefault(e) {
   const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
   if (e) {

package/dist/cli.js

@@ -3,7 +3,7 @@ import * as p from "@clack/prompts";
 import fs from "node:fs";
 import path from "node:path";
 import { setTimeout } from "node:timers/promises";
-import { analyzeDirectory } from "./openapi-analyzer-BtIaHIfe.js";
+import { analyzeDirectory } from "./openapi-analyzer-Ce_7JxZh.js";
 const templates = {
   controller: (name) => `import { Controller, Get, Ctx } from 'shokupan';
 import { ShokupanContext } from 'shokupan';

package/dist/context.d.ts

@@ -20,10 +20,9 @@ export interface DebugCollector {
 }
 export declare class ShokupanContext<State extends Record<string, any> = Record<string, any>> {
     readonly request: ShokupanRequest<any>;
-    readonly server?: Server<any>;
+    readonly server?: Server;
     readonly app?: Shokupan;
     readonly signal?: AbortSignal;
-    private _url;
     params: Record<string, string>;
     state: State;
     handlerStack: HandlerStackItem[];
@@ -31,7 +30,17 @@ export declare class ShokupanContext<State extends Record<string, any> = Record<
     _debug?: DebugCollector;
     _finalResponse?: Response;
     _rawBody?: string | ArrayBuffer | Uint8Array;
-    constructor(request: ShokupanRequest<any>, server?: Server<any>, state?: State, app?: Shokupan, signal?: AbortSignal, // Optional as it might not be provided in tests or simple creates
+    private _url?;
+    private _cachedBody?;
+    private _bodyType?;
+    private _bodyParsed;
+    _bodyParseError?: Error;
+    private _cachedHostname?;
+    private _cachedProtocol?;
+    private _cachedHost?;
+    private _cachedOrigin?;
+    private _cachedQuery?;
+    constructor(request: ShokupanRequest<any>, server?: Server, state?: State, app?: Shokupan, signal?: AbortSignal, // Optional as it might not be provided in tests or simple creates
     enableMiddlewareTracking?: boolean);
     get url(): URL;
     /**
@@ -53,7 +62,7 @@ export declare class ShokupanContext<State extends Record<string, any> = Record<
     /**
      * Client IP address
      */
-    get ip(): any;
+    get ip(): Bun.SocketAddress;
     /**
      * Request hostname (e.g. "localhost")
      */
@@ -101,6 +110,23 @@ export declare class ShokupanContext<State extends Record<string, any> = Record<
      */
     setCookie(name: string, value: string, options?: CookieOptions): this;
     private mergeHeaders;
+    /**
+     * Read request body with caching to avoid double parsing.
+     * The body is only parsed once and cached for subsequent reads.
+     */
+    body<T = any>(): Promise<T>;
+    /**
+     * Pre-parse the request body before handler execution.
+     * This improves performance and enables Node.js compatibility for large payloads.
+     * Errors are deferred until the body is actually accessed in the handler.
+     */
+    parseBody(): Promise<void>;
+    /**
+     * Read raw body from ReadableStream efficiently.
+     * This is much faster than request.text() for large payloads.
+     * Also handles the case where body is already a string (e.g., in tests).
+     */
+    private readRawBody;
     /**
      * Send a response
      * @param body Response body
@@ -108,10 +134,6 @@ export declare class ShokupanContext<State extends Record<string, any> = Record<
      * @returns Response
      */
     send(body?: BodyInit, options?: ResponseInit): Response;
-    /**
-     * Read request body
-     */
-    body<T = any>(): Promise<T>;
     /**
      * Respond with a JSON object
      */