mokup 2.0.2 → 2.1.0

package/dist/shared/mokup.CWQ8woZc.d.ts

@@ -0,0 +1,302 @@
+import { MockEntryOptions, PlaygroundOptionsInput } from '@mokup/shared';
+import { MiddlewareHandler, Context } from '@mokup/shared/hono';
+
+/**
+ * Supported HTTP methods for mokup routes.
+ *
+ * @example
+ * import type { HttpMethod } from 'mokup/vite'
+ *
+ * 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/vite'
+ *
+ * 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/vite'
+ *
+ * const result: RouteHandlerResult = 'ok'
+ */
+type RouteHandlerResult = RouteStaticResponse | Response;
+/**
+ * Request handler signature for mokup routes.
+ *
+ * @example
+ * import type { RequestHandler } from 'mokup/vite'
+ *
+ * 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/vite'
+ *
+ * const response: RouteResponse = { ok: true }
+ */
+type RouteResponse = RouteStaticResponse | RequestHandler;
+/**
+ * Rule metadata for a route handler.
+ *
+ * @example
+ * import type { RouteRule } from 'mokup/vite'
+ *
+ * const rule: RouteRule = {
+ *   handler: () => ({ ok: true }),
+ *   status: 200,
+ * }
+ */
+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;
+}
+/**
+ * Runtime mode for Vite integration.
+ *
+ * @example
+ * import type { RuntimeMode } from 'mokup/vite'
+ *
+ * const mode: RuntimeMode = 'sw'
+ */
+type RuntimeMode = 'server' | 'sw';
+/**
+ * Execution runtime for the Vite plugin.
+ *
+ * @example
+ * import type { ViteRuntime } from 'mokup/vite'
+ *
+ * const runtime: ViteRuntime = 'vite'
+ */
+type ViteRuntime = 'vite' | 'worker';
+/**
+ * Service worker behavior options for mokup.
+ *
+ * @example
+ * import type { ServiceWorkerOptions } from 'mokup/vite'
+ *
+ * const sw: ServiceWorkerOptions = {
+ *   path: '/mokup-sw.js',
+ *   scope: '/',
+ * }
+ */
+interface ServiceWorkerOptions {
+    /**
+     * Service worker script path.
+     *
+     * @default "/mokup-sw.js"
+     */
+    path?: string;
+    /**
+     * Service worker scope.
+     *
+     * @default "/"
+     */
+    scope?: string;
+    /**
+     * Auto-register the service worker.
+     *
+     * @default true
+     */
+    register?: boolean;
+    /**
+     * Auto-unregister when no SW entries exist.
+     *
+     * @default false
+     */
+    unregister?: boolean;
+    /**
+     * Allow SW fallback to direct network when not matched.
+     *
+     * @default true
+     */
+    fallback?: boolean;
+    /**
+     * Base paths the service worker should handle.
+     *
+     * @default []
+     */
+    basePath?: string | string[];
+}
+
+/**
+ * Directory-level route configuration loaded from index.config.* files.
+ *
+ * @example
+ * import type { RouteDirectoryConfig } from 'mokup/vite'
+ *
+ * const config: RouteDirectoryConfig = {
+ *   headers: { 'x-mokup': 'dir' },
+ * }
+ */
+interface RouteDirectoryConfig {
+    /**
+     * Headers applied to routes under this directory.
+     *
+     * @default {}
+     */
+    headers?: Record<string, string>;
+    /**
+     * Default status code override.
+     *
+     * @default 200
+     */
+    status?: number;
+    /**
+     * Delay in milliseconds.
+     *
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * Enable or disable routes under this directory.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Ignore prefixes within the directory.
+     *
+     * @default ["."]
+     */
+    ignorePrefix?: string | string[];
+    /**
+     * Include filter for route files.
+     *
+     * @default undefined
+     */
+    include?: RegExp | RegExp[];
+    /**
+     * Exclude filter for route files.
+     *
+     * @default undefined
+     */
+    exclude?: RegExp | RegExp[];
+    /**
+     * Middleware for this directory.
+     *
+     * @default undefined
+     */
+    middleware?: MiddlewareHandler | MiddlewareHandler[];
+}
+/**
+ * Middleware execution position.
+ *
+ * @example
+ * import type { MiddlewarePosition } from 'mokup/vite'
+ *
+ * const position: MiddlewarePosition = 'pre'
+ */
+type MiddlewarePosition = 'pre' | 'normal' | 'post';
+/**
+ * Middleware registry used by defineConfig.
+ *
+ * @example
+ * import type { MiddlewareRegistry } from 'mokup/vite'
+ *
+ * const registry: MiddlewareRegistry = { use: () => {} }
+ */
+interface MiddlewareRegistry {
+    use: (...handlers: MiddlewareHandler[]) => void;
+}
+/**
+ * Options for a single Vite entry.
+ *
+ * @example
+ * import type { VitePluginOptions } from 'mokup/vite'
+ *
+ * const options: VitePluginOptions = {
+ *   dir: 'mock',
+ *   prefix: '/api',
+ * }
+ */
+interface VitePluginOptions extends MockEntryOptions {
+    /**
+     * Runtime mode per entry.
+     *
+     * @default "server"
+     */
+    mode?: RuntimeMode;
+    /**
+     * Service worker options for this entry.
+     *
+     * @default undefined
+     */
+    sw?: ServiceWorkerOptions;
+}
+/**
+ * Top-level plugin options for mokup/vite.
+ *
+ * @example
+ * import type { MokupPluginOptions } from 'mokup/vite'
+ *
+ * const options: MokupPluginOptions = {
+ *   entries: { dir: 'mock' },
+ *   playground: true,
+ * }
+ */
+interface MokupPluginOptions {
+    /**
+     * One or more entries to scan for mocks.
+     *
+     * @default [{ }]
+     */
+    entries?: VitePluginOptions | VitePluginOptions[];
+    /**
+     * Playground configuration.
+     *
+     * @default { enabled: true, path: "/__mokup" }
+     */
+    playground?: PlaygroundOptionsInput;
+    /**
+     * Runtime for the Vite plugin.
+     *
+     * @default "vite"
+     */
+    runtime?: ViteRuntime;
+}
+/**
+ * Alias for Vite plugin options.
+ *
+ * @example
+ * import type { VitePluginOptionsInput } from 'mokup/vite'
+ *
+ * const options: VitePluginOptionsInput = { entries: { dir: 'mock' } }
+ */
+type VitePluginOptionsInput = MokupPluginOptions;
+
+export type { HttpMethod as H, MokupPluginOptions as M, RequestHandler as R, ServiceWorkerOptions as S, VitePluginOptions as V, MiddlewarePosition as a, MiddlewareRegistry as b, RouteDirectoryConfig as c, RouteResponse as d, RouteRule as e, RuntimeMode as f, VitePluginOptionsInput as g, ViteRuntime as h };