shokupan 0.1.0 → 0.3.0

package/README.md

@@ -1632,6 +1632,7 @@ Container.clear();
 - ✅ **Deep Introspection** - Type analysis for enhanced OpenAPI generation
 - ✅ **Controller Mode** - Option for controller-only mode
 - ✅ **Supports Node/Deno** - Shokupan can run on Node.js or Deno
+- ✅ **OpenAPI Validation** - Built-in [OpenAPI](https://www.openapis.org/) validation
 
 ### Future Features
 

package/dist/benchmarking/advanced-cases/elysia.d.ts

@@ -0,0 +1 @@
+export declare function startAdvanced(port: number, scenario: string): Promise<() => Promise<void>>;

package/dist/benchmarking/advanced-cases/express.d.ts

@@ -0,0 +1 @@
+export declare function startAdvanced(port: number, scenario: string): Promise<() => Promise<void>>;

package/dist/benchmarking/advanced-cases/fastify.d.ts

@@ -0,0 +1 @@
+export declare function startAdvanced(port: number, scenario: string): Promise<() => Promise<void>>;

package/dist/benchmarking/advanced-cases/hapi.d.ts

@@ -0,0 +1 @@
+export declare function startAdvanced(port: number, scenario: string): Promise<() => Promise<void>>;

package/dist/benchmarking/advanced-cases/hono.d.ts

@@ -0,0 +1 @@
+export declare function startAdvanced(port: number, scenario: string): Promise<() => Promise<void>>;

package/dist/benchmarking/advanced-cases/koa.d.ts

@@ -0,0 +1 @@
+export declare function startAdvanced(port: number, scenario: string): Promise<() => Promise<void>>;

package/dist/benchmarking/advanced-cases/nest.d.ts

@@ -0,0 +1 @@
+export declare function startAdvanced(port: number, scenario: string): Promise<() => Promise<void>>;

package/dist/benchmarking/advanced-cases/shokupan.d.ts

@@ -0,0 +1 @@
+export declare function startAdvanced(port: number, scenario: string): Promise<() => Promise<void>>;

package/dist/benchmarking/advanced-data.d.ts

@@ -0,0 +1,33 @@
+export declare const LARGE_JSON: {
+    total: number;
+    items: any[];
+    metadata: {
+        generated: string;
+        size: string;
+        purpose: string;
+    };
+};
+export declare const LARGE_REQUEST_BODY: string;
+export declare const LARGE_HEADERS: Record<string, string>;
+/**
+ * Calculate MD5 hash of a string
+ */
+export declare function md5(input: string): string;
+/**
+ * Serialize request data for hashing
+ */
+export declare function serializeRequest(url: string, headers: Record<string, string>, body: string): string;
+/**
+ * Get the actual byte size of the LARGE_JSON
+ */
+export declare function getLargeJSONSize(): number;
+/**
+ * Smaller compressible response (100KB) for compression testing
+ */
+export declare const COMPRESSIBLE_JSON: {
+    data: {
+        id: number;
+        text: string;
+        timestamp: string;
+    }[];
+};

package/dist/benchmarking/advanced-runner.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/benchmarking/cases/elysia.d.ts

@@ -0,0 +1 @@
+export declare function start(port: number): Promise<() => Promise<void>>;

package/dist/benchmarking/cases/express.d.ts

@@ -0,0 +1 @@
+export declare function start(port: number): Promise<() => Promise<void>>;

package/dist/benchmarking/cases/fastify.d.ts

@@ -0,0 +1 @@
+export declare function start(port: number): Promise<() => Promise<void>>;

package/dist/benchmarking/cases/hapi.d.ts

@@ -0,0 +1 @@
+export declare function start(port: number): Promise<() => Promise<void>>;

package/dist/benchmarking/cases/hono.d.ts

@@ -0,0 +1 @@
+export declare function start(port: number): Promise<() => Promise<void>>;

package/dist/benchmarking/cases/koa.d.ts

@@ -0,0 +1 @@
+export declare function start(port: number): Promise<() => Promise<void>>;

package/dist/benchmarking/cases/nest.d.ts

@@ -0,0 +1 @@
+export declare function start(port: number): Promise<() => Promise<void>>;

package/dist/benchmarking/cases/shokupan.d.ts

@@ -0,0 +1 @@
+export declare function start(port: number): Promise<() => Promise<void>>;

package/dist/benchmarking/data.d.ts

@@ -0,0 +1,15 @@
+export declare const MEDIUM_JSON: {
+    id: number;
+    name: string;
+    timestamp: string;
+    tags: string[];
+    nested: {
+        layer1: {
+            layer2: {
+                value: string;
+                numbers: number[];
+            };
+        };
+    };
+    description: string;
+};

package/dist/benchmarking/quick_bench.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/benchmarking/runner.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/buntest.d.ts

@@ -0,0 +1 @@
+export {};

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-CFqgSLNK.cjs");
+const openapiAnalyzer = require("./openapi-analyzer-D9YB3IkV.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-cjdGeQ5a.js";
+import { analyzeDirectory } from "./openapi-analyzer-BtIaHIfe.js";
 const templates = {
   controller: (name) => `import { Controller, Get, Ctx } from 'shokupan';
 import { ShokupanContext } from 'shokupan';

package/dist/context.d.ts

@@ -4,15 +4,34 @@ import { ShokupanResponse } from './response';
 import { Shokupan } from './shokupan';
 import { CookieOptions, JSXRenderer } from './types';
 type HeadersInit = Headers | Record<string, string> | [string, string][];
+export interface HandlerStackItem {
+    name: string;
+    file: string;
+    line: number;
+    stateChanges?: Record<string, any>;
+}
+export interface DebugCollector {
+    trackStep(id: string | undefined, type: string, duration: number, status: 'success' | 'error', error?: any): void;
+    trackEdge(fromId: string | undefined, toId: string | undefined): void;
+    setNode(id: string): void;
+    getCurrentNode(): string | undefined;
+}
 export declare class ShokupanContext<State extends Record<string, any> = Record<string, any>> {
     readonly request: ShokupanRequest<any>;
-    readonly server?: Server;
+    readonly server?: Server<any>;
     readonly app?: Shokupan;
-    readonly url: URL;
+    readonly signal?: AbortSignal;
+    private _url;
     params: Record<string, string>;
     state: State;
+    handlerStack: HandlerStackItem[];
     readonly response: ShokupanResponse;
-    constructor(request: ShokupanRequest<any>, server?: Server, state?: State, app?: Shokupan);
+    _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
+    enableMiddlewareTracking?: boolean);
+    get url(): URL;
     /**
      * Base request
      */
@@ -24,13 +43,11 @@ export declare class ShokupanContext<State extends Record<string, any> = Record<
     /**
      * Request path
      */
-    get path(): string;
+    get path(): any;
     /**
      * Request query params
      */
-    get query(): {
-        [k: string]: string;
-    };
+    get query(): Record<string, any>;
     /**
      * Client IP address
      */
@@ -117,7 +134,7 @@ export declare class ShokupanContext<State extends Record<string, any> = Record<
     /**
      * Respond with a file
      */
-    file(path: string, fileOptions?: BlobPropertyBag, responseOptions?: ResponseInit): Response;
+    file(path: string, fileOptions?: BlobPropertyBag, responseOptions?: ResponseInit): Promise<Response>;
     /**
      * JSX Rendering Function
      */

package/dist/decorators.d.ts

@@ -1,3 +1,4 @@
+import { RateLimitOptions } from './plugins/rate-limit';
 import { GuardAPISpec, MethodAPISpec, Middleware } from './types';
 /**
  * Class Decorator: Defines the base path for a controller.
@@ -7,21 +8,67 @@ export declare function Controller(path?: string): (target: any) => void;
  * Decorator: Applies middleware to a class or method.
  */
 export declare function Use(...middleware: Middleware[]): (target: any, propertyKey?: string, descriptor?: PropertyDescriptor) => void;
+/**
+ * Decorator: Binds a parameter to the request body.
+ */
 export declare const Body: (name?: string) => (target: any, propertyKey: string, parameterIndex: number) => void;
+/**
+ * Decorator: Binds a parameter to the request parameters.
+ */
 export declare const Param: (name?: string) => (target: any, propertyKey: string, parameterIndex: number) => void;
+/**
+ * Decorator: Binds a parameter to the request query string.
+ */
 export declare const Query: (name?: string) => (target: any, propertyKey: string, parameterIndex: number) => void;
+/**
+ * Decorator: Binds a parameter to the request headers.
+ */
 export declare const Headers: (name?: string) => (target: any, propertyKey: string, parameterIndex: number) => void;
+/**
+ * Decorator: Binds a parameter to the request object.
+ */
 export declare const Req: (name?: string) => (target: any, propertyKey: string, parameterIndex: number) => void;
+/**
+ * Decorator: Binds a parameter to the request context.
+ */
 export declare const Ctx: (name?: string) => (target: any, propertyKey: string, parameterIndex: number) => void;
 /**
  * Decorator: Overrides the OpenAPI specification for a route.
  */
 export declare function Spec(spec: MethodAPISpec | GuardAPISpec): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Decorator: Binds a method to the GET HTTP verb.
+ */
 export declare const Get: (path?: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Decorator: Binds a method to the POST HTTP verb.
+ */
 export declare const Post: (path?: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Decorator: Binds a method to the PUT HTTP verb.
+ */
 export declare const Put: (path?: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Decorator: Binds a method to the DELETE HTTP verb.
+ */
 export declare const Delete: (path?: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Decorator: Binds a method to the PATCH HTTP verb.
+ */
 export declare const Patch: (path?: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Decorator: Binds a method to the OPTIONS HTTP verb.
+ */
 export declare const Options: (path?: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Decorator: Binds a method to the HEAD HTTP verb.
+ */
 export declare const Head: (path?: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Decorator: Binds a method to ANY HTTP verb.
+ */
 export declare const All: (path?: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * Decorator: Applies a rate limit to a class or method.
+ */
+export declare function RateLimit(options: RateLimitOptions): (target: any, propertyKey?: string, descriptor?: PropertyDescriptor) => void;