@spfn/core 0.1.0-alpha.7 → 0.1.0-alpha.74

package/dist/types-SlzTr8ZO.d.ts

@@ -1,143 +0,0 @@
-import { Context } from 'hono';
-import { ContentfulStatusCode } from 'hono/utils/http-status';
-import { TSchema, Static } from '@sinclair/typebox';
-
-/**
- * Header record type compatible with Hono's c.json headers parameter
- */
-type HeaderRecord = Record<string, string | string[]>;
-/**
- * File-based Routing System Type Definitions
- *
- * ## Type Flow
- * ```
- * RouteFile (scan)
- *   ↓
- * RouteModule (dynamic import + contracts)
- *   ↓
- * RouteDefinition (transformation + validation)
- *   ↓
- * Hono App (registration)
- * ```
- *
- * ## Core Types
- * 1. **RouteContract**: TypeBox-based contract definition for type safety and validation
- * 2. **RouteContext**: Extended Context for route handlers (params, query, data)
- * 3. **RouteHandler**: Next.js App Router style handler function type
- * 4. **RouteFile**: File system scan result (Scanner output)
- * 5. **RouteModule**: Dynamic import result (Mapper input)
- * 6. **RouteDefinition**: Transformed route definition (Mapper output, Registry storage)
- * 7. **RouteMeta**: Route metadata (auth, tags, description, etc.)
- * 8. **RoutePriority**: Priority enum (STATIC, DYNAMIC, CATCH_ALL)
- * 9. **ScanOptions**: Scanner configuration options
- *
- * ## Applied Improvements
- * ✅ **HTTP Method Types**: Added HttpMethod union type
- * ✅ **Route Grouping**: Added RouteGroup, RouteStats types
- * ✅ **Type Guards**: isRouteFile, isRouteDefinition, isHttpMethod, hasHttpMethodHandlers
- * ✅ **Contract-based Types**: RouteContract, InferContract for end-to-end type safety
- * ✅ **Generic RouteContext**: RouteContext<TContract> for typed params, query, body, response
- */
-/**
- * Route metadata for additional configuration
- */
-type RouteMeta = {
-    /** Public route (skip authentication) - default: false */
-    public?: boolean;
-    /** Skip specific global middlewares by name */
-    skipMiddlewares?: string[];
-    /** OpenAPI tags for grouping */
-    tags?: string[];
-    /** Route description for documentation */
-    description?: string;
-    /** Deprecated flag */
-    deprecated?: boolean;
-};
-/**
- * Route Contract: TypeBox-based type-safe route definition
- *
- * Defines the shape of request/response for a route endpoint
- *
- * Note: params and query are always Record<string, string> from URL,
- * but can be validated and transformed via TypeBox schemas
- */
-type RouteContract = {
-    /** HTTP method (GET, POST, PUT, etc.) */
-    method: HttpMethod;
-    /** Route path (e.g., /users/:id) */
-    path: string;
-    /** Path parameters schema (optional) - input is always Record<string, string> */
-    params?: TSchema;
-    /** Query parameters schema (optional) - input is always Record<string, string | string[]> */
-    query?: TSchema;
-    /** Request body schema (optional) */
-    body?: TSchema;
-    /** Response schema (required) */
-    response: TSchema;
-    /** Route metadata (optional) */
-    meta?: RouteMeta;
-};
-/**
- * Infer types from RouteContract
- *
- * Extracts TypeScript types from TypeBox schemas
- */
-type InferContract<TContract extends RouteContract> = {
-    params: TContract['params'] extends TSchema ? Static<TContract['params']> : Record<string, never>;
-    query: TContract['query'] extends TSchema ? Static<TContract['query']> : Record<string, never>;
-    body: TContract['body'] extends TSchema ? Static<TContract['body']> : Record<string, never>;
-    response: TContract['response'] extends TSchema ? Static<TContract['response']> : unknown;
-};
-/**
- * RouteContext: Route Handler Dedicated Context
- *
- * Generic version with contract-based type inference
- *
- * Convenience methods provided:
- * - params: Path parameters (typed via contract)
- * - query: Query parameters (typed via contract)
- * - data(): Request Body parsing helper (typed via contract)
- * - json(): JSON response helper (typed via contract)
- * - raw: Original Hono Context (advanced features: raw.req, raw.get(), raw.set(), etc.)
- */
-type RouteContext<TContract extends RouteContract = any> = {
-    /**
-     * Path parameters (typed via contract)
-     */
-    params: InferContract<TContract>['params'];
-    /**
-     * Query parameters (typed via contract)
-     */
-    query: InferContract<TContract>['query'];
-    /**
-     * Request Body parsing helper (typed via contract)
-     */
-    data(): Promise<InferContract<TContract>['body']>;
-    /**
-     * JSON response helper (typed via contract)
-     */
-    json(data: InferContract<TContract>['response'], status?: ContentfulStatusCode, headers?: HeaderRecord): Response;
-    /**
-     * Original Hono Context (for advanced features when needed)
-     * - raw.req: Request object (headers, cookies, etc.)
-     * - raw.get(): Read context variables (middleware data)
-     * - raw.set(): Set context variables
-     */
-    raw: Context;
-};
-/**
- * HTTP method type (common REST API methods)
- */
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
-/**
- * Next.js App Router Style Route Handler
- *
- * Function that receives RouteContext and returns Response
- */
-type RouteHandler = (c: RouteContext) => Response | Promise<Response>;
-/**
- * HttpMethod type guard
- */
-declare function isHttpMethod(value: unknown): value is HttpMethod;
-
-export { type HeaderRecord as H, type InferContract as I, type RouteContract as R, type RouteHandler as a, type RouteMeta as b, type RouteContext as c, type HttpMethod as d, isHttpMethod as i };