@gravito/echo 3.0.0 → 3.1.0

package/dist/core/src/adapters/types.d.ts

@@ -0,0 +1,235 @@
+/**
+ * @fileoverview HTTP Adapter Interface for Gravito Framework
+ *
+ * This module defines the contract that all HTTP adapters must implement.
+ * By programming to this interface, Gravito can swap out the underlying
+ * HTTP engine without changing application code.
+ *
+ * @module @gravito/core/adapters
+ * @since 2.0.0
+ */
+import type { GravitoContext, GravitoErrorHandler, GravitoHandler, GravitoMiddleware, GravitoNotFoundHandler, GravitoVariables, HttpMethod } from '../http/types';
+/**
+ * Configuration options for HTTP adapters
+ */
+export interface AdapterConfig {
+    /**
+     * Base path prefix for all routes
+     * @default ''
+     */
+    basePath?: string;
+    /**
+     * Whether to enable strict routing (trailing slashes matter)
+     * @default false
+     */
+    strictRouting?: boolean;
+    /**
+     * Custom options passed to the underlying HTTP engine
+     */
+    engineOptions?: Record<string, unknown>;
+}
+/**
+ * Route definition structure
+ */
+export interface RouteDefinition {
+    method: HttpMethod;
+    path: string;
+    handlers: (GravitoHandler | GravitoMiddleware)[];
+    name?: string;
+    middleware?: GravitoMiddleware[];
+}
+/**
+ * HttpAdapter - The core interface for HTTP engine abstraction
+ *
+ * Any HTTP engine (Photon, Express, Fastify, custom Bun implementation)
+ * must implement this interface to be usable with Gravito.
+ *
+ * @typeParam V - Context variables type
+ *
+ * @example
+ * ```typescript
+ * // Using the default Photon adapter
+ * import { PhotonAdapter } from '@gravito/core/adapters'
+ *
+ * const core = new PlanetCore({
+ *   adapter: new PhotonAdapter()
+ * })
+ *
+ * // Using a custom adapter
+ * import { BunNativeAdapter } from '@gravito/adapter-bun'
+ *
+ * const core = new PlanetCore({
+ *   adapter: new BunNativeAdapter()
+ * })
+ * ```
+ */
+export interface HttpAdapter<V extends GravitoVariables = GravitoVariables> {
+    /**
+     * Adapter name for identification
+     * @example 'photon', 'bun-native', 'express'
+     */
+    readonly name: string;
+    /**
+     * Adapter version
+     */
+    readonly version: string;
+    /**
+     * Access the underlying native HTTP engine instance.
+     *
+     * ⚠️ WARNING: Using this ties your code to a specific adapter.
+     *
+     * @example
+     * ```typescript
+     * // For Photon adapter
+     * const photonApp = adapter.native as Photon
+     *
+     * // For custom Bun adapter
+     * const bunApp = adapter.native as BunApp
+     * ```
+     */
+    readonly native: unknown;
+    /**
+     * Register a route with the adapter
+     *
+     * @param method - HTTP method
+     * @param path - Route path (may include parameters like ':id')
+     * @param handlers - One or more handlers for this route (handlers or middleware)
+     */
+    route(method: HttpMethod, path: string, ...handlers: (GravitoHandler<V> | GravitoMiddleware<V>)[]): void;
+    /**
+     * Register multiple routes at once
+     *
+     * @param routes - Array of route definitions
+     */
+    routes(routes: RouteDefinition[]): void;
+    /**
+     * Register a middleware for a path
+     *
+     * @param path - Path pattern to match
+     * @param middleware - One or more middleware functions
+     */
+    use(path: string, ...middleware: GravitoMiddleware<V>[]): void;
+    /**
+     * Register a global middleware (applied to all routes)
+     *
+     * @param middleware - Middleware function
+     */
+    useGlobal(...middleware: GravitoMiddleware<V>[]): void;
+    /**
+     * Register a scoped middleware for Orbit-level isolation
+     *
+     * Unlike regular `use()`, this method enforces stricter scoping rules:
+     * - REJECTS '*' wildcard paths (prevents global middleware in Orbits)
+     * - ENFORCES that all middleware paths must include the scope prefix
+     * - Throws error if attempting to register global middleware within an Orbit scope
+     *
+     * This is designed to prevent accidental middleware cross-contamination
+     * when multiple Orbits are mounted to a single PlanetCore instance.
+     *
+     * @param scope - The scope/path prefix (e.g., '/api', '/blog')
+     * @param path - Path pattern to match (cannot be '*')
+     * @param middleware - One or more middleware functions
+     * @throws {Error} If path is '*' when in Orbit scope
+     * @since 2.3.0
+     *
+     * @example
+     * ```typescript
+     * // Correct: Scoped to specific path
+     * adapter.useScoped('/api', '/users/*', authMiddleware)
+     *
+     * // Error: Cannot use wildcard in Orbit scope
+     * adapter.useScoped('/api', '*', loggerMiddleware)
+     * ```
+     */
+    useScoped(scope: string, path: string, ...middleware: GravitoMiddleware<V>[]): void;
+    /**
+     * Mount a sub-adapter at a path
+     *
+     * @param path - Mount path
+     * @param subAdapter - The adapter to mount
+     */
+    mount(path: string, subAdapter: HttpAdapter<V>): void;
+    /**
+     * Set the error handler
+     *
+     * @param handler - Error handler function
+     */
+    onError(handler: GravitoErrorHandler<V>): void;
+    /**
+     * Set the not-found handler
+     *
+     * @param handler - Not-found handler function
+     */
+    onNotFound(handler: GravitoNotFoundHandler<V>): void;
+    /**
+     * The main fetch handler for serving requests.
+     *
+     * This is compatible with `Bun.serve()`, Cloudflare Workers,
+     * and other fetch-based runtimes.
+     *
+     * @param request - Incoming HTTP request
+     * @param server - Optional server context (Bun.Server, etc.)
+     * @returns HTTP response
+     *
+     * @example
+     * ```typescript
+     * // With Bun.serve
+     * Bun.serve({
+     *   port: 3000,
+     *   fetch: adapter.fetch
+     * })
+     * ```
+     */
+    fetch(request: Request, server?: unknown): Response | Promise<Response>;
+    /**
+     * Predictive Route Warming (JIT Optimization)
+     *
+     * Simulates requests to specified routes to trigger JIT compilation (FTL)
+     * before real traffic arrives.
+     *
+     * @param paths List of paths to warm up (e.g. ['/api/users', '/health'])
+     * @since 2.1.0
+     */
+    warmup?(paths: string[]): Promise<void>;
+    /**
+     * WebSocket Handler for Bun.serve
+     *
+     * @since 2.2.0
+     */
+    websocket?: {
+        open?(ws: unknown): void | Promise<void>;
+        message?(ws: unknown, message: string | Buffer | Uint8Array): void | Promise<void>;
+        close?(ws: unknown, code: number, message: string): void | Promise<void>;
+        drain?(ws: unknown): void | Promise<void>;
+        [key: string]: unknown;
+    };
+    /**
+     * Initialize the adapter
+     *
+     * Called during PlanetCore.boot()
+     */
+    init?(): void | Promise<void>;
+    /**
+     * Cleanup resources
+     *
+     * Called during graceful shutdown
+     */
+    shutdown?(): void | Promise<void>;
+    /**
+     * Create a GravitoContext from a raw request.
+     *
+     * This is used internally for testing and advanced scenarios.
+     *
+     * @param request - Raw HTTP request
+     * @returns Gravito context
+     */
+    createContext(request: Request): GravitoContext<V>;
+}
+/**
+ * Factory function type for creating adapters
+ */
+export type AdapterFactory<V extends GravitoVariables = GravitoVariables> = (config?: AdapterConfig) => HttpAdapter<V>;
+/**
+ * Check if a value is an HttpAdapter
+ */
+export declare function isHttpAdapter(value: unknown): value is HttpAdapter;

package/dist/core/src/engine/AOTRouter.d.ts

@@ -0,0 +1,124 @@
+/**
+ * @fileoverview AOT (Ahead-of-Time) Router
+ *
+ * Hybrid routing strategy:
+ * - Static routes: O(1) Map lookup
+ * - Dynamic routes: Optimized Radix Tree
+ *
+ * The key optimization is separating static from dynamic routes at registration time,
+ * not at match time. This eliminates unnecessary tree traversal for static paths.
+ *
+ * @module @gravito/core/engine
+ */
+import type { HttpMethod } from '../http/types';
+import type { Handler, Middleware, RouteMatch, RouteMetadata } from './types';
+/**
+ * Route definition for re-playing routes (mounting)
+ */
+interface RouteDefinition {
+    method: HttpMethod;
+    path: string;
+    handler: Handler;
+    middleware: Middleware[];
+}
+/**
+ * AOT Router - Optimized for Bun
+ */
+export declare class AOTRouter {
+    /** @internal */
+    readonly staticRoutes: Map<string, RouteMetadata>;
+    private dynamicRouter;
+    /** @internal */
+    readonly routeDefinitions: RouteDefinition[];
+    /** @internal */
+    readonly globalMiddleware: Middleware[];
+    /** @internal */
+    readonly pathMiddleware: Map<string, Middleware[]>;
+    private dynamicRoutePatterns;
+    private middlewareCache;
+    private cacheMaxSize;
+    private version;
+    /**
+     * Register a route
+     *
+     * Automatically determines if route is static or dynamic.
+     * Static routes are stored in a Map for O(1) lookup.
+     * Dynamic routes use the Radix Tree.
+     *
+     * @param method - HTTP method
+     * @param path - Route path
+     * @param handler - Route handler
+     * @param middleware - Route-specific middleware
+     */
+    add(method: HttpMethod, path: string, handler: Handler, middleware?: Middleware[]): void;
+    /**
+     * Mount another router at a prefix
+     */
+    mount(prefix: string, other: AOTRouter): void;
+    /**
+     * Add global middleware
+     *
+     * These run for every request, before route-specific middleware.
+     *
+     * @param middleware - Middleware functions
+     */
+    use(...middleware: Middleware[]): void;
+    /**
+     * Add path-based middleware
+     *
+     * Supports wildcard patterns like '/api/*'
+     *
+     * @param pattern - Path pattern
+     * @param middleware - Middleware functions
+     */
+    usePattern(pattern: string, ...middleware: Middleware[]): void;
+    /**
+     * Match a request to a route
+     *
+     * Returns the handler, params, and all applicable middleware.
+     *
+     * @param method - HTTP method
+     * @param path - Request path
+     * @returns Route match or null if not found
+     */
+    match(method: string, path: string): RouteMatch;
+    /**
+     * Public wrapper for collectMiddleware (used by Gravito for optimization)
+     */
+    collectMiddlewarePublic(path: string, routeMiddleware: Middleware[]): Middleware[];
+    /**
+     * Collect all applicable middleware for a path
+     *
+     * Order: global -> pattern-based -> route-specific
+     *
+     * @param path - Request path
+     * @param routeMiddleware - Route-specific middleware
+     * @returns Combined middleware array
+     */
+    private collectMiddleware;
+    /**
+     * Check if a path is static (no parameters or wildcards)
+     */
+    private isStaticPath;
+    /**
+     * Match a pattern against a path
+     *
+     * Supports:
+     * - Exact match: '/api/users'
+     * - Wildcard suffix: '/api/*'
+     *
+     * @param pattern - Pattern to match
+     * @param path - Path to test
+     * @returns True if pattern matches
+     */
+    private matchPattern;
+    /**
+     * Get all registered routes (for debugging)
+     */
+    getRoutes(): Array<{
+        method: string;
+        path: string;
+        type: 'static' | 'dynamic';
+    }>;
+}
+export {};

package/dist/core/src/engine/FastContext.d.ts

@@ -0,0 +1,100 @@
+/**
+ * @fileoverview FastContext - Pooled Request Context
+ *
+ * Minimal, high-performance context implementation designed for object pooling.
+ * Lazy parsing strategy: only parse what's actually accessed.
+ *
+ * @module @gravito/core/engine
+ */
+import type { FastRequest, FastContext as IFastContext } from './types';
+/**
+ * Lazy-parsed request wrapper
+ *
+ * Delays parsing of query params, headers, and body until accessed.
+ * This is a key optimization for requests that don't need all data.
+ */
+declare class FastRequestImpl implements FastRequest {
+    private _request;
+    private _params;
+    private _path;
+    private _routePattern?;
+    private _url;
+    private _query;
+    private _headers;
+    private _cachedJson;
+    private _jsonParsed;
+    private _ctx;
+    constructor(ctx: FastContext);
+    /**
+     * Initialize for new request
+     */
+    init(request: Request, params?: Record<string, string>, path?: string, routePattern?: string): this;
+    /**
+     * Reset for pooling
+     */
+    reset(): void;
+    private checkReleased;
+    get url(): string;
+    get method(): string;
+    get path(): string;
+    get routePattern(): string | undefined;
+    param(name: string): string | undefined;
+    params(): Record<string, string>;
+    private getUrl;
+    query(name: string): string | undefined;
+    queries(): Record<string, string | string[]>;
+    header(name: string): string | undefined;
+    headers(): Record<string, string>;
+    json<T = unknown>(): Promise<T>;
+    text(): Promise<string>;
+    formData(): Promise<FormData>;
+    get raw(): Request;
+}
+/**
+ * FastContext - Pooled request context
+ *
+ * Designed for minimal memory allocation and maximum reuse.
+ * All response helpers create Response objects directly without intermediate wrappers.
+ */
+export declare class FastContext implements IFastContext {
+    readonly req: FastRequestImpl;
+    private _headers;
+    _isReleased: boolean;
+    /**
+     * Initialize context for a new request
+     *
+     * This is called when acquiring from the pool.
+     */
+    init(request: Request, params?: Record<string, string>, path?: string, routePattern?: string): this;
+    /**
+     * Reset context for pooling (Cleanup)
+     *
+     * This is called when releasing back to the pool.
+     * Implements "Deep-Reset Protocol" and "Release Guard".
+     */
+    reset(): void;
+    /**
+     * Check if context is released
+     */
+    private checkReleased;
+    json<T>(data: T, status?: number): Response;
+    text(text: string, status?: number): Response;
+    html(html: string, status?: number): Response;
+    redirect(url: string, status?: 301 | 302 | 303 | 307 | 308): Response;
+    body(data: BodyInit | null, status?: number): Response;
+    stream(stream: ReadableStream, status?: number): Response;
+    notFound(message?: string): Response;
+    forbidden(message?: string): Response;
+    unauthorized(message?: string): Response;
+    badRequest(message?: string): Response;
+    forward(target: string, _options?: any): Promise<Response>;
+    header(name: string): string | undefined;
+    header(name: string, value: string): void;
+    status(_code: number): void;
+    private _store;
+    get<T>(key: string): T;
+    set(key: string, value: any): void;
+    route: (name: string, params?: any, query?: any) => string;
+    get native(): this;
+}
+export {};

package/dist/core/src/engine/Gravito.d.ts

@@ -0,0 +1,137 @@
+/**
+ * @fileoverview Gravito - High-Performance Web Engine for Bun
+ *
+ * The standalone engine optimized exclusively for Bun runtime.
+ * 99% API-compatible with Hono, but faster through Bun-specific optimizations.
+ *
+ * Key optimizations:
+ * 1. Object pooling for zero-allocation request handling
+ * 2. AOT router with O(1) static route lookup
+ * 3. Lazy parsing - only parse what's accessed
+ * 4. Direct Bun.serve integration without wrapper layers
+ *
+ * @module @gravito/core/engine
+ */
+import type { EngineOptions, ErrorHandler, Handler, Middleware, NotFoundHandler, RouteMetadata } from './types';
+/**
+ * Gravito - The High-Performance Web Engine
+ */
+export declare class Gravito {
+    private router;
+    private contextPool;
+    private errorHandler?;
+    private notFoundHandler?;
+    /** @internal */
+    staticRoutes: Map<string, RouteMetadata>;
+    private isPureStaticApp;
+    private compiledDynamicRoutes;
+    private middlewareVersion;
+    /**
+     * Create a new Gravito instance
+     *
+     * @param options - Engine configuration options
+     */
+    constructor(options?: EngineOptions);
+    /**
+     * Register a GET route
+     *
+     * @param path - Route path (e.g., '/users/:id')
+     * @param handlers - Handler and optional middleware
+     * @returns This instance for chaining
+     */
+    get(path: string, ...handlers: Handler[]): this;
+    /**
+     * Register a POST route
+     */
+    post(path: string, ...handlers: Handler[]): this;
+    /**
+     * Register a PUT route
+     */
+    put(path: string, ...handlers: Handler[]): this;
+    /**
+     * Register a DELETE route
+     */
+    delete(path: string, ...handlers: Handler[]): this;
+    /**
+     * Register a PDF route
+     */
+    patch(path: string, ...handlers: Handler[]): this;
+    /**
+     * Register an OPTIONS route
+     */
+    options(path: string, ...handlers: Handler[]): this;
+    /**
+     * Register a HEAD route
+     */
+    head(path: string, ...handlers: Handler[]): this;
+    /**
+     * Register a route for all HTTP methods
+     */
+    all(path: string, ...handlers: Handler[]): this;
+    /**
+     * Register global or path-based middleware
+     */
+    use(path: string, ...middleware: Middleware[]): this;
+    use(...middleware: Middleware[]): this;
+    /**
+     * Mount a sub-application at a path prefix
+     */
+    route(path: string, app: Gravito): this;
+    /**
+     * Set custom error handler
+     */
+    onError(handler: ErrorHandler): this;
+    /**
+     * Set custom 404 handler
+     */
+    notFound(handler: NotFoundHandler): this;
+    /**
+     * Predictive Route Warming (JIT Optimization)
+     *
+     * Simulates requests to specified routes to trigger JIT compilation (FTL)
+     * before real traffic arrives.
+     *
+     * @param paths List of paths to warm up (e.g. ['/api/users', '/health'])
+     */
+    warmup(paths: string[]): Promise<void>;
+    /**
+     * Handle an incoming request
+     */
+    fetch: (request: Request) => Promise<Response>;
+    /**
+     * Handle routes with middleware (async path)
+     */
+    private handleWithMiddleware;
+    /**
+     * Handle dynamic routes (Radix Tree lookup)
+     */
+    private handleDynamicRoute;
+    /**
+     * Sync error handler (for ultra-fast path)
+     */
+    private handleErrorSync;
+    /**
+     * Sync 404 handler (for ultra-fast path)
+     */
+    private handleNotFoundSync;
+    /**
+     * Collect middleware for a specific path
+     */
+    private collectMiddlewareForPath;
+    /**
+     * Compile routes for optimization
+     */
+    private compileRoutes;
+    /**
+     * Add a route to the router
+     */
+    private addRoute;
+    /**
+     * Execute middleware chain followed by handler
+     */
+    private executeMiddleware;
+    /**
+     * Handle errors (Async version for dynamic/middleware paths)
+     */
+    private handleError;
+}

package/dist/core/src/engine/MinimalContext.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @fileoverview MinimalContext - Ultra-lightweight Request Context
+ *
+ * Designed for zero-middleware static routes where pool overhead
+ * exceeds the cost of creating a new object.
+ *
+ * Key difference from FastContext:
+ * - No object pooling (direct instantiation is faster for simple cases)
+ * - No Headers object reuse (creates inline)
+ * - Minimal memory footprint
+ *
+ * @module @gravito/core/engine
+ */
+import type { FastRequest, FastContext as IFastContext } from './types';
+/**
+ * Minimal request wrapper
+ */
+declare class MinimalRequest implements FastRequest {
+    private readonly _request;
+    private readonly _params;
+    private readonly _path;
+    private readonly _routePattern?;
+    private _searchParams;
+    constructor(_request: Request, _params: Record<string, string>, _path: string, _routePattern?: string | undefined);
+    get url(): string;
+    get method(): string;
+    get path(): string;
+    get routePattern(): string | undefined;
+    param(name: string): string | undefined;
+    params(): Record<string, string>;
+    /**
+     * Lazy-initialize searchParams, only parse once
+     */
+    private getSearchParams;
+    query(name: string): string | undefined;
+    queries(): Record<string, string | string[]>;
+    header(name: string): string | undefined;
+    headers(): Record<string, string>;
+    json<T = unknown>(): Promise<T>;
+    text(): Promise<string>;
+    formData(): Promise<FormData>;
+    get raw(): Request;
+}
+/**
+ * MinimalContext - Optimized for simple, fast responses
+ *
+ * Use when:
+ * - No middleware
+ * - Static routes
+ * - Simple JSON/text responses
+ * - No custom headers needed
+ */
+export declare class MinimalContext implements IFastContext {
+    readonly req: MinimalRequest;
+    private _resHeaders;
+    constructor(request: Request, params: Record<string, string>, path: string, routePattern?: string);
+    private getHeaders;
+    json<T>(data: T, status?: number): Response;
+    text(text: string, status?: number): Response;
+    html(html: string, status?: number): Response;
+    redirect(url: string, status?: 301 | 302 | 303 | 307 | 308): Response;
+    body(data: BodyInit | null, status?: number): Response;
+    header(name: string): string | undefined;
+    header(name: string, value: string): void;
+    status(_code: number): void;
+    stream(stream: ReadableStream, status?: number): Response;
+    notFound(message?: string): Response;
+    forbidden(message?: string): Response;
+    unauthorized(message?: string): Response;
+    badRequest(message?: string): Response;
+    forward(target: string, _options?: any): Promise<Response>;
+    get<T>(_key: string): T;
+    set(_key: string, _value: any): void;
+    route: (name: string, params?: any, query?: any) => string;
+    get native(): this;
+    init(_request: Request, _params?: Record<string, string>, _path?: string): this;
+    reset(): void;
+}
+export {};

package/dist/core/src/engine/analyzer.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Handler Static Analyzer (Elysia-inspired)
+ *
+ * Analyzes handler functions to determine what request properties
+ * they access, allowing for optimized code paths.
+ */
+/**
+ * Represents the results of a static analysis performed on a handler function.
+ *
+ * @public
+ * @since 3.0.0
+ */
+export interface HandlerAnalysis {
+    usesHeaders: boolean;
+    usesQuery: boolean;
+    usesBody: boolean;
+    usesParams: boolean;
+    isAsync: boolean;
+}
+/**
+ * Analyze a handler function to detect what it accesses
+ */
+export declare function analyzeHandler(handler: Function): HandlerAnalysis;
+/**
+ * Determine optimal context type based on analysis
+ */
+export declare function getOptimalContextType(analysis: HandlerAnalysis): 'minimal' | 'fast' | 'full';