@mokup/server 1.1.1 → 1.1.3

package/dist/shared/server.CyVIKPsp.d.ts

@@ -0,0 +1,214 @@
+import { RouteToken } from '@mokup/runtime';
+import { MiddlewareHandler, Context } from '@mokup/shared/hono';
+
+/**
+ * Supported HTTP methods for server dev routes.
+ *
+ * @example
+ * import type { HttpMethod } from '@mokup/server'
+ *
+ * const method: HttpMethod = 'GET'
+ */
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+/**
+ * Static response payloads supported by route rules.
+ *
+ * @example
+ * import type { RouteStaticResponse } from '@mokup/server'
+ *
+ * const value: RouteStaticResponse = { ok: true }
+ */
+type RouteStaticResponse = string | number | boolean | bigint | symbol | null | undefined | object;
+/**
+ * Allowed return value from a route handler.
+ *
+ * @example
+ * import type { RouteHandlerResult } from '@mokup/server'
+ *
+ * const result: RouteHandlerResult = 'ok'
+ */
+type RouteHandlerResult = RouteStaticResponse | Response;
+/**
+ * Request handler signature for server dev routes.
+ *
+ * @example
+ * import type { RequestHandler } from '@mokup/server'
+ *
+ * const handler: RequestHandler = (c) => c.json({ ok: true })
+ */
+type RequestHandler = (context: Context) => RouteHandlerResult | Promise<RouteHandlerResult>;
+/**
+ * Route response as a static value or handler.
+ *
+ * @example
+ * import type { RouteResponse } from '@mokup/server'
+ *
+ * const response: RouteResponse = { ok: true }
+ */
+type RouteResponse = RouteStaticResponse | RequestHandler;
+/**
+ * Rule metadata for a route handler.
+ *
+ * @example
+ * import type { RouteRule } from '@mokup/server'
+ *
+ * const rule: RouteRule = {
+ *   handler: () => ({ ok: true }),
+ * }
+ */
+interface RouteRule {
+    /** Handler for the route. */
+    handler: RouteResponse;
+    /**
+     * Enable or disable this rule.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Override response status code.
+     *
+     * @default 200
+     */
+    status?: number;
+    /**
+     * Additional response headers.
+     *
+     * @default {}
+     */
+    headers?: Record<string, string>;
+    /**
+     * Delay in milliseconds before responding.
+     *
+     * @default 0
+     */
+    delay?: number;
+}
+/**
+ * Directory-level config for server dev scanning.
+ *
+ * @example
+ * import type { RouteDirectoryConfig } from '@mokup/server'
+ *
+ * const config: RouteDirectoryConfig = { headers: { 'x-mokup': 'dir' } }
+ */
+interface RouteDirectoryConfig {
+    /**
+     * Headers applied to routes in this directory.
+     *
+     * @default {}
+     */
+    headers?: Record<string, string>;
+    /**
+     * Default status code override.
+     *
+     * @default 200
+     */
+    status?: number;
+    /**
+     * Default delay in milliseconds.
+     *
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * Enable or disable this directory.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Ignore prefixes for files.
+     *
+     * @default ["."]
+     */
+    ignorePrefix?: string | string[];
+    /**
+     * Include filter.
+     *
+     * @default undefined
+     */
+    include?: RegExp | RegExp[];
+    /**
+     * Exclude filter.
+     *
+     * @default undefined
+     */
+    exclude?: RegExp | RegExp[];
+    /**
+     * Middleware for this directory.
+     *
+     * @default undefined
+     */
+    middleware?: MiddlewareHandler | MiddlewareHandler[];
+}
+/**
+ * Middleware execution position.
+ *
+ * @example
+ * import type { MiddlewarePosition } from '@mokup/server'
+ *
+ * const position: MiddlewarePosition = 'pre'
+ */
+type MiddlewarePosition = 'pre' | 'normal' | 'post';
+/**
+ * Middleware registry used by defineConfig.
+ *
+ * @example
+ * import type { MiddlewareRegistry } from '@mokup/server'
+ *
+ * const registry: MiddlewareRegistry = { use: () => {} }
+ */
+interface MiddlewareRegistry {
+    use: (...handlers: MiddlewareHandler[]) => void;
+}
+/**
+ * Normalized middleware metadata.
+ *
+ * @example
+ * import type { ResolvedMiddleware } from '@mokup/server'
+ *
+ * const item: ResolvedMiddleware = { handle: () => {}, source: 'index.config.ts', index: 0 }
+ */
+interface ResolvedMiddleware {
+    handle: MiddlewareHandler;
+    source: string;
+    index: number;
+    /**
+     * Position in the middleware chain.
+     *
+     * @default "normal"
+     */
+    position: MiddlewarePosition;
+}
+/**
+ * Fully resolved route metadata.
+ *
+ * @example
+ * import type { ResolvedRoute } from '@mokup/server'
+ *
+ * const route: ResolvedRoute = {
+ *   file: '/mock/ping.get.ts',
+ *   template: '/ping',
+ *   method: 'GET',
+ *   tokens: [{ type: 'static', value: 'ping' }],
+ *   score: [4],
+ *   handler: () => ({ ok: true }),
+ * }
+ */
+interface ResolvedRoute {
+    file: string;
+    template: string;
+    method: HttpMethod;
+    tokens: RouteToken[];
+    score: number[];
+    handler: RouteResponse;
+    middlewares?: ResolvedMiddleware[];
+    status?: number;
+    headers?: Record<string, string>;
+    delay?: number;
+    ruleIndex?: number;
+}
+type RouteTable = ResolvedRoute[];
+
+export type { MiddlewareRegistry as M, RouteDirectoryConfig as R, MiddlewarePosition as a, ResolvedMiddleware as b, RouteRule as c, RouteTable as d };

package/dist/shared/server.D0gAciOr.d.cts

@@ -0,0 +1,46 @@
+/**
+ * Minimal readable stream shape used by adapters.
+ *
+ * @example
+ * import type { ReadableStreamLike } from '@mokup/server'
+ *
+ * const stream: ReadableStreamLike = {
+ *   on: () => {},
+ * }
+ */
+interface ReadableStreamLike {
+    on: (event: string, listener: (...args: unknown[]) => void) => void;
+}
+/**
+ * Minimal Node request shape used by adapters.
+ *
+ * @example
+ * import type { NodeRequestLike } from '@mokup/server'
+ *
+ * const req: NodeRequestLike = { method: 'GET', url: '/api/ping' }
+ */
+interface NodeRequestLike extends ReadableStreamLike {
+    method?: string;
+    url?: string;
+    originalUrl?: string;
+    headers?: Record<string, string | string[] | undefined>;
+    body?: unknown;
+}
+/**
+ * Minimal Node response shape used by adapters.
+ *
+ * @example
+ * import type { NodeResponseLike } from '@mokup/server'
+ *
+ * const res: NodeResponseLike = {
+ *   setHeader: () => {},
+ *   end: () => {},
+ * }
+ */
+interface NodeResponseLike {
+    statusCode?: number;
+    setHeader: (name: string, value: string) => void;
+    end: (data?: string | Uint8Array | ArrayBuffer | null) => void;
+}
+
+export type { NodeRequestLike as N, NodeResponseLike as a };

package/dist/shared/server.D0gAciOr.d.mts

@@ -0,0 +1,46 @@
+/**
+ * Minimal readable stream shape used by adapters.
+ *
+ * @example
+ * import type { ReadableStreamLike } from '@mokup/server'
+ *
+ * const stream: ReadableStreamLike = {
+ *   on: () => {},
+ * }
+ */
+interface ReadableStreamLike {
+    on: (event: string, listener: (...args: unknown[]) => void) => void;
+}
+/**
+ * Minimal Node request shape used by adapters.
+ *
+ * @example
+ * import type { NodeRequestLike } from '@mokup/server'
+ *
+ * const req: NodeRequestLike = { method: 'GET', url: '/api/ping' }
+ */
+interface NodeRequestLike extends ReadableStreamLike {
+    method?: string;
+    url?: string;
+    originalUrl?: string;
+    headers?: Record<string, string | string[] | undefined>;
+    body?: unknown;
+}
+/**
+ * Minimal Node response shape used by adapters.
+ *
+ * @example
+ * import type { NodeResponseLike } from '@mokup/server'
+ *
+ * const res: NodeResponseLike = {
+ *   setHeader: () => {},
+ *   end: () => {},
+ * }
+ */
+interface NodeResponseLike {
+    statusCode?: number;
+    setHeader: (name: string, value: string) => void;
+    end: (data?: string | Uint8Array | ArrayBuffer | null) => void;
+}
+
+export type { NodeRequestLike as N, NodeResponseLike as a };

package/dist/shared/server.D0gAciOr.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Minimal readable stream shape used by adapters.
+ *
+ * @example
+ * import type { ReadableStreamLike } from '@mokup/server'
+ *
+ * const stream: ReadableStreamLike = {
+ *   on: () => {},
+ * }
+ */
+interface ReadableStreamLike {
+    on: (event: string, listener: (...args: unknown[]) => void) => void;
+}
+/**
+ * Minimal Node request shape used by adapters.
+ *
+ * @example
+ * import type { NodeRequestLike } from '@mokup/server'
+ *
+ * const req: NodeRequestLike = { method: 'GET', url: '/api/ping' }
+ */
+interface NodeRequestLike extends ReadableStreamLike {
+    method?: string;
+    url?: string;
+    originalUrl?: string;
+    headers?: Record<string, string | string[] | undefined>;
+    body?: unknown;
+}
+/**
+ * Minimal Node response shape used by adapters.
+ *
+ * @example
+ * import type { NodeResponseLike } from '@mokup/server'
+ *
+ * const res: NodeResponseLike = {
+ *   setHeader: () => {},
+ *   end: () => {},
+ * }
+ */
+interface NodeResponseLike {
+    statusCode?: number;
+    setHeader: (name: string, value: string) => void;
+    end: (data?: string | Uint8Array | ArrayBuffer | null) => void;
+}
+
+export type { NodeRequestLike as N, NodeResponseLike as a };

package/dist/shared/server.DkerfsA-.d.cts

@@ -0,0 +1,73 @@
+import { RuntimeOptions, Manifest, ModuleMap } from '@mokup/runtime';
+
+/**
+ * Options for server adapters built on top of the runtime.
+ *
+ * @example
+ * import type { ServerOptions } from '@mokup/server'
+ *
+ * const options: ServerOptions = {
+ *   manifest: { version: 1, routes: [] },
+ *   onNotFound: 'next',
+ * }
+ */
+interface ServerOptions extends RuntimeOptions {
+    /**
+     * Behavior when no route matches.
+     *
+     * @default "next"
+     */
+    onNotFound?: 'next' | 'response';
+}
+/**
+ * Fetch handler signature used by server adapters.
+ *
+ * @example
+ * import type { FetchHandler } from '@mokup/server'
+ *
+ * const handler: FetchHandler = async (request) => new Response('ok')
+ */
+type FetchHandler = (request: Request) => Promise<Response | null>;
+/**
+ * Bundle input for Worker helpers.
+ *
+ * @example
+ * import type { WorkerBundle } from '@mokup/server'
+ *
+ * const bundle: WorkerBundle = {
+ *   manifest: { version: 1, routes: [] },
+ * }
+ */
+interface WorkerBundle {
+    /** Manifest for runtime execution. */
+    manifest: Manifest;
+    /**
+     * In-memory module map for handler execution.
+     *
+     * @default undefined
+     */
+    moduleMap?: ModuleMap;
+    /**
+     * Base directory for module resolution.
+     *
+     * @default undefined
+     */
+    moduleBase?: string | URL;
+    /**
+     * Behavior when no route matches.
+     *
+     * @default "response"
+     */
+    onNotFound?: 'next' | 'response';
+}
+/**
+ * Worker input accepted by createMokupWorker.
+ *
+ * @example
+ * import type { WorkerInput } from '@mokup/server'
+ *
+ * const input: WorkerInput = { version: 1, routes: [] }
+ */
+type WorkerInput = Manifest | WorkerBundle;
+
+export type { FetchHandler as F, ServerOptions as S, WorkerBundle as W, WorkerInput as a };

package/dist/shared/server.DkerfsA-.d.mts

@@ -0,0 +1,73 @@
+import { RuntimeOptions, Manifest, ModuleMap } from '@mokup/runtime';
+
+/**
+ * Options for server adapters built on top of the runtime.
+ *
+ * @example
+ * import type { ServerOptions } from '@mokup/server'
+ *
+ * const options: ServerOptions = {
+ *   manifest: { version: 1, routes: [] },
+ *   onNotFound: 'next',
+ * }
+ */
+interface ServerOptions extends RuntimeOptions {
+    /**
+     * Behavior when no route matches.
+     *
+     * @default "next"
+     */
+    onNotFound?: 'next' | 'response';
+}
+/**
+ * Fetch handler signature used by server adapters.
+ *
+ * @example
+ * import type { FetchHandler } from '@mokup/server'
+ *
+ * const handler: FetchHandler = async (request) => new Response('ok')
+ */
+type FetchHandler = (request: Request) => Promise<Response | null>;
+/**
+ * Bundle input for Worker helpers.
+ *
+ * @example
+ * import type { WorkerBundle } from '@mokup/server'
+ *
+ * const bundle: WorkerBundle = {
+ *   manifest: { version: 1, routes: [] },
+ * }
+ */
+interface WorkerBundle {
+    /** Manifest for runtime execution. */
+    manifest: Manifest;
+    /**
+     * In-memory module map for handler execution.
+     *
+     * @default undefined
+     */
+    moduleMap?: ModuleMap;
+    /**
+     * Base directory for module resolution.
+     *
+     * @default undefined
+     */
+    moduleBase?: string | URL;
+    /**
+     * Behavior when no route matches.
+     *
+     * @default "response"
+     */
+    onNotFound?: 'next' | 'response';
+}
+/**
+ * Worker input accepted by createMokupWorker.
+ *
+ * @example
+ * import type { WorkerInput } from '@mokup/server'
+ *
+ * const input: WorkerInput = { version: 1, routes: [] }
+ */
+type WorkerInput = Manifest | WorkerBundle;
+
+export type { FetchHandler as F, ServerOptions as S, WorkerBundle as W, WorkerInput as a };

package/dist/shared/server.DkerfsA-.d.ts

@@ -0,0 +1,73 @@
+import { RuntimeOptions, Manifest, ModuleMap } from '@mokup/runtime';
+
+/**
+ * Options for server adapters built on top of the runtime.
+ *
+ * @example
+ * import type { ServerOptions } from '@mokup/server'
+ *
+ * const options: ServerOptions = {
+ *   manifest: { version: 1, routes: [] },
+ *   onNotFound: 'next',
+ * }
+ */
+interface ServerOptions extends RuntimeOptions {
+    /**
+     * Behavior when no route matches.
+     *
+     * @default "next"
+     */
+    onNotFound?: 'next' | 'response';
+}
+/**
+ * Fetch handler signature used by server adapters.
+ *
+ * @example
+ * import type { FetchHandler } from '@mokup/server'
+ *
+ * const handler: FetchHandler = async (request) => new Response('ok')
+ */
+type FetchHandler = (request: Request) => Promise<Response | null>;
+/**
+ * Bundle input for Worker helpers.
+ *
+ * @example
+ * import type { WorkerBundle } from '@mokup/server'
+ *
+ * const bundle: WorkerBundle = {
+ *   manifest: { version: 1, routes: [] },
+ * }
+ */
+interface WorkerBundle {
+    /** Manifest for runtime execution. */
+    manifest: Manifest;
+    /**
+     * In-memory module map for handler execution.
+     *
+     * @default undefined
+     */
+    moduleMap?: ModuleMap;
+    /**
+     * Base directory for module resolution.
+     *
+     * @default undefined
+     */
+    moduleBase?: string | URL;
+    /**
+     * Behavior when no route matches.
+     *
+     * @default "response"
+     */
+    onNotFound?: 'next' | 'response';
+}
+/**
+ * Worker input accepted by createMokupWorker.
+ *
+ * @example
+ * import type { WorkerInput } from '@mokup/server'
+ *
+ * const input: WorkerInput = { version: 1, routes: [] }
+ */
+type WorkerInput = Manifest | WorkerBundle;
+
+export type { FetchHandler as F, ServerOptions as S, WorkerBundle as W, WorkerInput as a };