shokupan 0.0.1 → 0.2.0

package/dist/types.d.ts

@@ -1,7 +1,8 @@
 import { OpenAPI } from '@scalar/openapi-types';
+import { Server } from 'bun';
 import { ShokupanContext } from './context';
 import { $isRouter } from './symbol';
-export type DeepPartial<T> = T extends object ? {
+export type DeepPartial<T> = T extends Function ? T : T extends object ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;
 export type MethodAPISpec = OpenAPI.Operation;
@@ -18,6 +19,18 @@ export interface OpenAPIOptions {
     defaultTagGroup?: string;
     defaultTag?: string;
 }
+export interface ShokupanHooks<T = any> {
+    onError?: (error: unknown, ctx: ShokupanContext<T>) => void | Promise<void>;
+    onRequestStart?: (ctx: ShokupanContext<T>) => void | Promise<void>;
+    onRequestEnd?: (ctx: ShokupanContext<T>) => void | Promise<void>;
+    onResponseStart?: (ctx: ShokupanContext<T>, response: Response) => void | Promise<void>;
+    onResponseEnd?: (ctx: ShokupanContext<T>, response: Response) => void | Promise<void>;
+    beforeValidate?: (ctx: ShokupanContext<T>, data: any) => void | Promise<void>;
+    afterValidate?: (ctx: ShokupanContext<T>, data: any) => void | Promise<void>;
+    onReadTimeout?: (ctx: ShokupanContext<T>) => void | Promise<void>;
+    onWriteTimeout?: (ctx: ShokupanContext<T>) => void | Promise<void>;
+    onRequestTimeout?: (ctx: ShokupanContext<T>) => void | Promise<void>;
+}
 export interface CookieOptions {
     maxAge?: number;
     expires?: Date;
@@ -39,12 +52,32 @@ export declare enum RouteParamType {
     REQUEST = "REQUEST",
     CONTEXT = "CONTEXT"
 }
+export interface ServerFactory {
+    (options: any): Server | Promise<Server>;
+}
 export type NextFn = () => Promise<any>;
 export type Middleware = (ctx: ShokupanContext<unknown>, next: NextFn) => Promise<any> | any;
+export type JSXRenderer = (element: any, args?: unknown) => string | Promise<string>;
 export type ShokupanRouteConfig = DeepPartial<{
     name: string;
     group: string;
+    /**
+     * Timeout for this specific route (milliseconds).
+     */
+    requestTimeout: number;
     openapi: DeepPartial<OpenAPI.Operation>;
+    /**
+     * Custom renderer for this route.
+     */
+    renderer: JSXRenderer;
+    /**
+     * Hooks for this route/router.
+     */
+    hooks: ShokupanHooks;
+    /**
+     * Whether to enforce that only controller classes (constructors) are accepted by the router.
+     */
+    controllersOnly: boolean;
 }>;
 export type ShokupanRoute = {
     method: Method;
@@ -58,13 +91,69 @@ export type ShokupanRoute = {
         handler: ShokupanHandler;
         spec?: GuardAPISpec;
     }[];
+    requestTimeout?: number;
+    renderer?: JSXRenderer;
+    /**
+     * Hooks from the router/route definition
+     */
+    hooks?: ShokupanHooks;
 };
 export type ShokupanConfig<T extends Record<string, any> = Record<string, any>> = DeepPartial<{
+    /**
+     * The port to be used for the server.
+     * @default 3000
+     */
     port: number;
+    /**
+     * The hostname to be used for the server.
+     * @default "localhost"
+     */
     hostname: string;
+    /**
+     * Whether to run in development mode.
+     * @default process.env.NODE_ENV !== "production"
+     */
     development: boolean;
+    /**
+     * Whether to enable AsyncLocalStorage.
+     * (Request local storage)
+     * @default false
+     */
     enableAsyncLocalStorage: boolean;
+    /**
+     * Whether to enable OpenAPI generation.
+     * @default true
+     */
+    enableOpenApiGen: boolean;
+    /**
+     * Whether to reuse the port.
+     * @default false
+     */
+    reusePort: boolean;
+    /**
+     * Whether to enforce that only controller classes (constructors) are accepted by the router.
+     * @default false
+     */
+    controllersOnly: boolean;
+    /**
+     * Whether to enable OpenTelemetry tracing.
+     * @default false
+     */
+    enableTracing?: boolean;
+    /**
+     * Whether to enable middleware and handler tracking.
+     * When enabled, `ctx.handlerStack` will be populated with the handlers the request has passed through.
+     * Also, `ctx.state` will be a Proxy that tracks changes made by each handler.
+     * @default false
+     */
+    enableMiddlewareTracking: boolean;
+    /**
+     * HTTP logger function.
+     */
     httpLogger: (ctx: ShokupanContext<T>) => void;
+    /**
+     * Logger object.
+     */
     logger: {
         verbose: boolean;
         info: (msg: string, props: Record<string, any>) => void;
@@ -76,6 +165,36 @@ export type ShokupanConfig<T extends Record<string, any> = Record<string, any>>
          */
         fatal: (msg: string, props: Record<string, any>) => void;
     };
+    /**
+     * Timeout for reading the request body (milliseconds).
+     * Maps to Bun's `idleTimeout`.
+     * @default 30000
+     */
+    readTimeout: number;
+    /**
+     * Timeout for processing the request (milliseconds).
+     * Maps to `server.timeout(req, seconds)`.
+     * @default 0 (disabled)
+     */
+    requestTimeout: number;
+    /**
+     * Timeout for writing the response (milliseconds).
+     * Not currently supported by Bun.serve natively.
+     */
+    writeTimeout: number;
+    /**
+     * JSX Rendering function.
+     */
+    renderer: JSXRenderer;
+    /**
+     * Factory function to create the server instance.
+     * Defaults to Bun.serve.
+     */
+    serverFactory: ServerFactory;
+    /**
+     * Lifecycle hooks.
+     */
+    hooks: ShokupanHooks<T>;
     [key: string]: any;
 }>;
 export interface RequestOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "shokupan",
-    "version": "0.0.1",
+    "version": "0.2.0",
     "description": "Shokupan is a low-lift modern web framework for Bun.",
     "author": "Andrew G. Knackstedt",
     "repository": {
@@ -58,9 +58,16 @@
         "@opentelemetry/semantic-conventions": "^1.38.0",
         "@scalar/api-reference": "^1.40.9",
         "@scalar/openapi-types": "^0.5.3",
+        "@surrealdb/node": "^2.4.0",
+        "ajv": "^8.17.1",
+        "ajv-formats": "^3.0.1",
         "arctic": "^3.7.0",
+        "class-transformer": "^0.5.1",
+        "class-validator": "^0.14.3",
         "eta": "^4.5.0",
         "jose": "^6.1.3",
+        "reflect-metadata": "^0.2.2",
+        "surrealdb": "^2.0.0-alpha.14",
         "tslib": "^2.8.1"
     },
     "devDependencies": {
@@ -69,7 +76,6 @@
         "@types/axios": "^0.9.36",
         "@types/bun": "^1.2.23",
         "@types/supertest": "^6.0.3",
-        "ajv": "^8.17.1",
         "axios": "^1.13.2",
         "get-port": "^7.1.0",
         "supertest": "^7.1.4",
@@ -79,4 +85,4 @@
         "vite-plugin-dts": "^4.5.4",
         "zod": "^4.2.1"
     }
-}
+}