@useavalon/avalon 0.1.11 → 0.1.13

package/src/middleware/index.ts

@@ -1,76 +1,76 @@
-/**
- * Avalon Middleware Module
- *
- * This module provides a Nitro-aligned middleware system for Avalon that supports
- * both global middleware (via Nitro's middleware/ directory) and route-scoped
- * middleware (via _middleware.ts files in page/API directories).
- *
- * Key features:
- * - Nitro-compatible handler signature: return void to continue, return Response to terminate
- * - Route-scoped middleware discovery in src/pages/ and src/api/
- * - Priority-based execution order (parent before child)
- * - Type-safe context augmentation for H3 events
- *
- * @example
- * ```ts
- * // Define middleware with proper typing
- * import { defineMiddleware } from 'avalon/middleware';
- * import { getHeader, createError } from 'h3';
- *
- * export default defineMiddleware(async (event) => {
- *   const token = getHeader(event, 'Authorization');
- *   if (!token) {
- *     throw createError({ statusCode: 401, message: 'Unauthorized' });
- *   }
- *   event.context.user = await validateToken(token);
- * });
- * ```
- *
- * @example
- * ```ts
- * // Discover and execute middleware in your server
- * import { discoverScopedMiddleware, executeScopedMiddleware } from 'avalon/middleware';
- *
- * const routes = await discoverScopedMiddleware({ baseDir: 'src', devMode: true });
- * const response = await executeScopedMiddleware(event, routes);
- * if (response) return response;
- * ```
- *
- * Requirements: 4.3
- */
-
-// =============================================================================
-// Type Exports
-// =============================================================================
-
-export type {
-	MiddlewareHandler,
-	MiddlewareFileExport,
-	MiddlewareRoute,
-	MiddlewareDiscoveryOptions,
-	MiddlewareExecutorOptions,
-} from './types.ts';
-
-// =============================================================================
-// Helper Functions (defineMiddleware removed — use defineHandler from 'nitro/h3')
-// =============================================================================
-
-// =============================================================================
-// Discovery Functions
-// =============================================================================
-
-export { discoverScopedMiddleware, getMatchingMiddleware, clearDiscoveryCache } from './discovery.ts';
-
-// =============================================================================
-// Executor Functions
-// =============================================================================
-
-export {
-	executeScopedMiddleware,
-	clearMiddlewareCache,
-	invalidateMiddleware,
-	getMiddlewareCacheSize,
-	hasContextValue,
-	getContextValue,
-	setContextValue,
-} from './executor.ts';
+/**
+ * Avalon Middleware Module
+ *
+ * This module provides a Nitro-aligned middleware system for Avalon that supports
+ * both global middleware (via Nitro's middleware/ directory) and route-scoped
+ * middleware (via _middleware.ts files in page/API directories).
+ *
+ * Key features:
+ * - Nitro-compatible handler signature: return void to continue, return Response to terminate
+ * - Route-scoped middleware discovery in src/pages/ and src/api/
+ * - Priority-based execution order (parent before child)
+ * - Type-safe context augmentation for H3 events
+ *
+ * @example
+ * ```ts
+ * // Define middleware with proper typing
+ * import { defineMiddleware } from 'avalon/middleware';
+ * import { getHeader, createError } from 'h3';
+ *
+ * export default defineMiddleware(async (event) => {
+ *   const token = getHeader(event, 'Authorization');
+ *   if (!token) {
+ *     throw createError({ statusCode: 401, message: 'Unauthorized' });
+ *   }
+ *   event.context.user = await validateToken(token);
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Discover and execute middleware in your server
+ * import { discoverScopedMiddleware, executeScopedMiddleware } from 'avalon/middleware';
+ *
+ * const routes = await discoverScopedMiddleware({ baseDir: 'src', devMode: true });
+ * const response = await executeScopedMiddleware(event, routes);
+ * if (response) return response;
+ * ```
+ *
+ * Requirements: 4.3
+ */
+
+// =============================================================================
+// Type Exports
+// =============================================================================
+
+export type {
+	MiddlewareHandler,
+	MiddlewareFileExport,
+	MiddlewareRoute,
+	MiddlewareDiscoveryOptions,
+	MiddlewareExecutorOptions,
+} from './types.ts';
+
+// =============================================================================
+// Helper Functions (defineMiddleware removed — use defineHandler from 'nitro/h3')
+// =============================================================================
+
+// =============================================================================
+// Discovery Functions
+// =============================================================================
+
+export { discoverScopedMiddleware, getMatchingMiddleware, clearDiscoveryCache } from './discovery.ts';
+
+// =============================================================================
+// Executor Functions
+// =============================================================================
+
+export {
+	executeScopedMiddleware,
+	clearMiddlewareCache,
+	invalidateMiddleware,
+	getMiddlewareCacheSize,
+	hasContextValue,
+	getContextValue,
+	setContextValue,
+} from './executor.ts';

package/src/middleware/types.ts

@@ -1,99 +1,99 @@
-/**
- * Nitro-Aligned Middleware Types
- *
- * This module defines types for Avalon's middleware system that align with
- * Nitro's conventions while preserving route-scoped middleware features.
- *
- * Key differences from old middleware system:
- * - Handler signature: (event: H3Event) => void | Response | Promise<void | Response>
- * - Return void to continue, return Response to terminate
- * - Uses event.context for data passing instead of custom state/locals
- *
- * Requirements: 1.1
- */
-
-import type { H3Event } from 'h3';
-
-/**
- * Nitro-aligned middleware handler signature
- *
- * This signature matches Nitro's middleware conventions:
- * - Return nothing (void/undefined) to continue to next middleware
- * - Return a Response to terminate the chain and send that response
- * - Throw an error to trigger Nitro's error handling
- *
- * @example
- * ```ts
- * const handler: MiddlewareHandler = async (event) => {
- *   // Check auth
- *   if (!event.context.user) {
- *     return new Response('Unauthorized', { status: 401 });
- *   }
- *   // Continue to next middleware
- * };
- * ```
- */
-export type MiddlewareHandler = (
-  event: H3Event
-) => void | Response | Promise<void | Response>;
-
-/**
- * Route-scoped middleware file export interface
- *
- * Middleware files should export a default function matching the MiddlewareHandler signature.
- *
- * @example
- * ```ts
- * // src/pages/admin/_middleware.ts
- * export default async (event) => {
- *   // middleware logic
- * };
- * ```
- */
-export interface MiddlewareFileExport {
-  /** Default export must be a MiddlewareHandler function */
-  default: MiddlewareHandler;
-}
-
-/**
- * Discovered middleware route configuration
- *
- * Represents a middleware file discovered during scanning, with its
- * URL pattern, file path, execution priority, and type.
- */
-export interface MiddlewareRoute {
-  /** URL pattern for matching requests */
-  pattern: URLPattern;
-  /** Absolute path to the middleware file */
-  filePath: string;
-  /** Execution priority (lower numbers execute first) */
-  priority: number;
-  /** Middleware type - determines which routes it applies to */
-  type: 'global' | 'pages';
-}
-
-/**
- * Middleware discovery options
- */
-export interface MiddlewareDiscoveryOptions {
-  /** Base directory to scan (e.g., 'src') */
-  baseDir: string;
-  /** File pattern to match (default: '_middleware.ts') */
-  filePattern?: string;
-  /** Directories to exclude from scanning */
-  excludeDirs?: string[];
-  /** Enable development mode logging */
-  devMode?: boolean;
-}
-
-/**
- * Middleware execution options
- */
-export interface MiddlewareExecutorOptions {
-  /** Enable development mode logging */
-  devMode?: boolean;
-  /** Timeout for middleware execution in milliseconds */
-  timeout?: number;
-}
-
-
+/**
+ * Nitro-Aligned Middleware Types
+ *
+ * This module defines types for Avalon's middleware system that align with
+ * Nitro's conventions while preserving route-scoped middleware features.
+ *
+ * Key differences from old middleware system:
+ * - Handler signature: (event: H3Event) => void | Response | Promise<void | Response>
+ * - Return void to continue, return Response to terminate
+ * - Uses event.context for data passing instead of custom state/locals
+ *
+ * Requirements: 1.1
+ */
+
+import type { H3Event } from 'h3';
+
+/**
+ * Nitro-aligned middleware handler signature
+ *
+ * This signature matches Nitro's middleware conventions:
+ * - Return nothing (void/undefined) to continue to next middleware
+ * - Return a Response to terminate the chain and send that response
+ * - Throw an error to trigger Nitro's error handling
+ *
+ * @example
+ * ```ts
+ * const handler: MiddlewareHandler = async (event) => {
+ *   // Check auth
+ *   if (!event.context.user) {
+ *     return new Response('Unauthorized', { status: 401 });
+ *   }
+ *   // Continue to next middleware
+ * };
+ * ```
+ */
+export type MiddlewareHandler = (
+  event: H3Event
+) => void | Response | Promise<void | Response>;
+
+/**
+ * Route-scoped middleware file export interface
+ *
+ * Middleware files should export a default function matching the MiddlewareHandler signature.
+ *
+ * @example
+ * ```ts
+ * // src/pages/admin/_middleware.ts
+ * export default async (event) => {
+ *   // middleware logic
+ * };
+ * ```
+ */
+export interface MiddlewareFileExport {
+  /** Default export must be a MiddlewareHandler function */
+  default: MiddlewareHandler;
+}
+
+/**
+ * Discovered middleware route configuration
+ *
+ * Represents a middleware file discovered during scanning, with its
+ * URL pattern, file path, execution priority, and type.
+ */
+export interface MiddlewareRoute {
+  /** URL pattern for matching requests */
+  pattern: URLPattern;
+  /** Absolute path to the middleware file */
+  filePath: string;
+  /** Execution priority (lower numbers execute first) */
+  priority: number;
+  /** Middleware type - determines which routes it applies to */
+  type: 'global' | 'pages';
+}
+
+/**
+ * Middleware discovery options
+ */
+export interface MiddlewareDiscoveryOptions {
+  /** Base directory to scan (e.g., 'src') */
+  baseDir: string;
+  /** File pattern to match (default: '_middleware.ts') */
+  filePattern?: string;
+  /** Directories to exclude from scanning */
+  excludeDirs?: string[];
+  /** Enable development mode logging */
+  devMode?: boolean;
+}
+
+/**
+ * Middleware execution options
+ */
+export interface MiddlewareExecutorOptions {
+  /** Enable development mode logging */
+  devMode?: boolean;
+  /** Timeout for middleware execution in milliseconds */
+  timeout?: number;
+}
+
+