@mokup/server 1.1.2 → 1.1.4

package/dist/fetch-server.d.cts

@@ -1,53 +1,107 @@
-import { RouteToken } from '@mokup/runtime';
-import { Context, MiddlewareHandler } from '@mokup/shared/hono';
+import { d as RouteTable } from './shared/server.CyVIKPsp.cjs';
 import { MockEntryOptions, PlaygroundOptionsInput } from '@mokup/shared';
+import '@mokup/runtime';
+import '@mokup/shared/hono';
 
+/**
+ * Options for a fetch-based mokup server.
+ *
+ * @example
+ * import type { FetchServerOptions } from '@mokup/server'
+ *
+ * const options: FetchServerOptions = { dir: 'mock', prefix: '/api' }
+ */
 interface FetchServerOptions extends MockEntryOptions {
+    /**
+     * Hostname to bind when used by a CLI or adapter.
+     *
+     * @default undefined
+     */
     host?: string;
+    /**
+     * Port to bind when used by a CLI or adapter.
+     *
+     * @default undefined
+     */
     port?: number;
+    /**
+     * Root directory used to resolve paths.
+     *
+     * @default process.cwd()
+     */
     root?: string;
 }
+/**
+ * Top-level fetch server configuration.
+ *
+ * @example
+ * import type { FetchServerOptionsConfig } from '@mokup/server'
+ *
+ * const config: FetchServerOptionsConfig = {
+ *   entries: { dir: 'mock' },
+ *   playground: true,
+ * }
+ */
 interface FetchServerOptionsConfig {
+    /**
+     * Entry or entries to scan.
+     *
+     * @default [{ }]
+     */
     entries?: FetchServerOptions | FetchServerOptions[];
+    /**
+     * Playground configuration.
+     *
+     * @default { enabled: true, path: "/__mokup" }
+     */
     playground?: PlaygroundOptionsInput;
 }
+/**
+ * Alias for fetch server options input.
+ *
+ * @example
+ * import type { FetchServerOptionsInput } from '@mokup/server'
+ */
 type FetchServerOptionsInput = FetchServerOptionsConfig;
 
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
-type RouteStaticResponse = string | number | boolean | bigint | symbol | null | undefined | object;
-type RouteHandlerResult = RouteStaticResponse | Response;
-type RequestHandler = (context: Context) => RouteHandlerResult | Promise<RouteHandlerResult>;
-type RouteResponse = RouteStaticResponse | RequestHandler;
-interface ResolvedMiddleware {
-    handle: MiddlewareHandler;
-    source: string;
-    index: number;
-}
-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[];
-
+/**
+ * Fetch server instance returned by createFetchServer.
+ *
+ * @example
+ * import type { FetchServer } from '@mokup/server'
+ *
+ * const server: FetchServer = {
+ *   fetch: async () => new Response('ok'),
+ *   refresh: async () => {},
+ *   getRoutes: () => [],
+ * }
+ */
 interface FetchServer {
+    /** Fetch handler for runtime requests. */
     fetch: (request: Request) => Promise<Response>;
+    /** Refresh the route table. */
     refresh: () => Promise<void>;
+    /** Read the current route table. */
     getRoutes: () => RouteTable;
+    /** Inject a WebSocket server for playground metrics. */
     injectWebSocket?: (server: NodeWebSocketServer) => void;
+    /** Close any active watchers. */
     close?: () => Promise<void>;
 }
 interface NodeWebSocketServer {
     on: (event: string, listener: (...args: unknown[]) => void) => void;
 }
+/**
+ * Create a fetch server that scans routes and serves playground metadata.
+ *
+ * @param options - Server options input.
+ * @returns Fetch server instance.
+ *
+ * @example
+ * import { createFetchServer } from '@mokup/server'
+ *
+ * const server = await createFetchServer({ entries: { dir: 'mock' } })
+ */
 declare function createFetchServer(options?: FetchServerOptionsInput): Promise<FetchServer>;
 
 export { createFetchServer };

package/dist/fetch-server.d.mts

@@ -1,53 +1,107 @@
-import { RouteToken } from '@mokup/runtime';
-import { Context, MiddlewareHandler } from '@mokup/shared/hono';
+import { d as RouteTable } from './shared/server.CyVIKPsp.mjs';
 import { MockEntryOptions, PlaygroundOptionsInput } from '@mokup/shared';
+import '@mokup/runtime';
+import '@mokup/shared/hono';
 
+/**
+ * Options for a fetch-based mokup server.
+ *
+ * @example
+ * import type { FetchServerOptions } from '@mokup/server'
+ *
+ * const options: FetchServerOptions = { dir: 'mock', prefix: '/api' }
+ */
 interface FetchServerOptions extends MockEntryOptions {
+    /**
+     * Hostname to bind when used by a CLI or adapter.
+     *
+     * @default undefined
+     */
     host?: string;
+    /**
+     * Port to bind when used by a CLI or adapter.
+     *
+     * @default undefined
+     */
     port?: number;
+    /**
+     * Root directory used to resolve paths.
+     *
+     * @default process.cwd()
+     */
     root?: string;
 }
+/**
+ * Top-level fetch server configuration.
+ *
+ * @example
+ * import type { FetchServerOptionsConfig } from '@mokup/server'
+ *
+ * const config: FetchServerOptionsConfig = {
+ *   entries: { dir: 'mock' },
+ *   playground: true,
+ * }
+ */
 interface FetchServerOptionsConfig {
+    /**
+     * Entry or entries to scan.
+     *
+     * @default [{ }]
+     */
     entries?: FetchServerOptions | FetchServerOptions[];
+    /**
+     * Playground configuration.
+     *
+     * @default { enabled: true, path: "/__mokup" }
+     */
     playground?: PlaygroundOptionsInput;
 }
+/**
+ * Alias for fetch server options input.
+ *
+ * @example
+ * import type { FetchServerOptionsInput } from '@mokup/server'
+ */
 type FetchServerOptionsInput = FetchServerOptionsConfig;
 
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
-type RouteStaticResponse = string | number | boolean | bigint | symbol | null | undefined | object;
-type RouteHandlerResult = RouteStaticResponse | Response;
-type RequestHandler = (context: Context) => RouteHandlerResult | Promise<RouteHandlerResult>;
-type RouteResponse = RouteStaticResponse | RequestHandler;
-interface ResolvedMiddleware {
-    handle: MiddlewareHandler;
-    source: string;
-    index: number;
-}
-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[];
-
+/**
+ * Fetch server instance returned by createFetchServer.
+ *
+ * @example
+ * import type { FetchServer } from '@mokup/server'
+ *
+ * const server: FetchServer = {
+ *   fetch: async () => new Response('ok'),
+ *   refresh: async () => {},
+ *   getRoutes: () => [],
+ * }
+ */
 interface FetchServer {
+    /** Fetch handler for runtime requests. */
     fetch: (request: Request) => Promise<Response>;
+    /** Refresh the route table. */
     refresh: () => Promise<void>;
+    /** Read the current route table. */
     getRoutes: () => RouteTable;
+    /** Inject a WebSocket server for playground metrics. */
     injectWebSocket?: (server: NodeWebSocketServer) => void;
+    /** Close any active watchers. */
     close?: () => Promise<void>;
 }
 interface NodeWebSocketServer {
     on: (event: string, listener: (...args: unknown[]) => void) => void;
 }
+/**
+ * Create a fetch server that scans routes and serves playground metadata.
+ *
+ * @param options - Server options input.
+ * @returns Fetch server instance.
+ *
+ * @example
+ * import { createFetchServer } from '@mokup/server'
+ *
+ * const server = await createFetchServer({ entries: { dir: 'mock' } })
+ */
 declare function createFetchServer(options?: FetchServerOptionsInput): Promise<FetchServer>;
 
 export { createFetchServer };

package/dist/fetch-server.d.ts

@@ -1,53 +1,107 @@
-import { RouteToken } from '@mokup/runtime';
-import { Context, MiddlewareHandler } from '@mokup/shared/hono';
+import { d as RouteTable } from './shared/server.CyVIKPsp.js';
 import { MockEntryOptions, PlaygroundOptionsInput } from '@mokup/shared';
+import '@mokup/runtime';
+import '@mokup/shared/hono';
 
+/**
+ * Options for a fetch-based mokup server.
+ *
+ * @example
+ * import type { FetchServerOptions } from '@mokup/server'
+ *
+ * const options: FetchServerOptions = { dir: 'mock', prefix: '/api' }
+ */
 interface FetchServerOptions extends MockEntryOptions {
+    /**
+     * Hostname to bind when used by a CLI or adapter.
+     *
+     * @default undefined
+     */
     host?: string;
+    /**
+     * Port to bind when used by a CLI or adapter.
+     *
+     * @default undefined
+     */
     port?: number;
+    /**
+     * Root directory used to resolve paths.
+     *
+     * @default process.cwd()
+     */
     root?: string;
 }
+/**
+ * Top-level fetch server configuration.
+ *
+ * @example
+ * import type { FetchServerOptionsConfig } from '@mokup/server'
+ *
+ * const config: FetchServerOptionsConfig = {
+ *   entries: { dir: 'mock' },
+ *   playground: true,
+ * }
+ */
 interface FetchServerOptionsConfig {
+    /**
+     * Entry or entries to scan.
+     *
+     * @default [{ }]
+     */
     entries?: FetchServerOptions | FetchServerOptions[];
+    /**
+     * Playground configuration.
+     *
+     * @default { enabled: true, path: "/__mokup" }
+     */
     playground?: PlaygroundOptionsInput;
 }
+/**
+ * Alias for fetch server options input.
+ *
+ * @example
+ * import type { FetchServerOptionsInput } from '@mokup/server'
+ */
 type FetchServerOptionsInput = FetchServerOptionsConfig;
 
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
-type RouteStaticResponse = string | number | boolean | bigint | symbol | null | undefined | object;
-type RouteHandlerResult = RouteStaticResponse | Response;
-type RequestHandler = (context: Context) => RouteHandlerResult | Promise<RouteHandlerResult>;
-type RouteResponse = RouteStaticResponse | RequestHandler;
-interface ResolvedMiddleware {
-    handle: MiddlewareHandler;
-    source: string;
-    index: number;
-}
-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[];
-
+/**
+ * Fetch server instance returned by createFetchServer.
+ *
+ * @example
+ * import type { FetchServer } from '@mokup/server'
+ *
+ * const server: FetchServer = {
+ *   fetch: async () => new Response('ok'),
+ *   refresh: async () => {},
+ *   getRoutes: () => [],
+ * }
+ */
 interface FetchServer {
+    /** Fetch handler for runtime requests. */
     fetch: (request: Request) => Promise<Response>;
+    /** Refresh the route table. */
     refresh: () => Promise<void>;
+    /** Read the current route table. */
     getRoutes: () => RouteTable;
+    /** Inject a WebSocket server for playground metrics. */
     injectWebSocket?: (server: NodeWebSocketServer) => void;
+    /** Close any active watchers. */
     close?: () => Promise<void>;
 }
 interface NodeWebSocketServer {
     on: (event: string, listener: (...args: unknown[]) => void) => void;
 }
+/**
+ * Create a fetch server that scans routes and serves playground metadata.
+ *
+ * @param options - Server options input.
+ * @returns Fetch server instance.
+ *
+ * @example
+ * import { createFetchServer } from '@mokup/server'
+ *
+ * const server = await createFetchServer({ entries: { dir: 'mock' } })
+ */
 declare function createFetchServer(options?: FetchServerOptionsInput): Promise<FetchServer>;
 
 export { createFetchServer };