@ereo/router 0.1.6

package/README.md

@@ -0,0 +1,73 @@
+# @ereo/router
+
+File-based routing for the EreoJS framework. Supports dynamic routes, catch-all routes, layouts, route groups, and middleware chains.
+
+## Installation
+
+```bash
+bun add @ereo/router
+```
+
+## Quick Start
+
+```typescript
+import { createFileRouter, matchRoute } from '@ereo/router';
+
+// Initialize the file router
+const router = createFileRouter({
+  routesDir: './src/routes',
+});
+
+// Match a URL to a route
+const match = matchRoute(router, '/users/123');
+// { params: { id: '123' }, route: { ... } }
+```
+
+## Key Features
+
+- **File-Based Routing** - Automatic route generation from your file structure
+- **Dynamic Routes** - Support for `[param]`, `[...catchAll]`, and `[[optional]]` segments
+- **Route Groups** - Organize routes with `(group)` folders without affecting URLs
+- **Layouts** - Nested layouts with automatic composition
+- **Middleware Chain** - Register and compose middleware with `createMiddleware` and `chainMiddleware`
+- **Route Validation** - Validate params and search params with built-in validators
+- **Built-in Middleware** - Logger, CORS, and rate limiting out of the box
+
+## Middleware Example
+
+```typescript
+import { createMiddleware, chainMiddleware, createLoggerMiddleware } from '@ereo/router';
+
+const authMiddleware = createMiddleware(async (ctx, next) => {
+  if (!ctx.request.headers.get('Authorization')) {
+    return new Response('Unauthorized', { status: 401 });
+  }
+  return next();
+});
+
+const chain = chainMiddleware([
+  createLoggerMiddleware(),
+  authMiddleware,
+]);
+```
+
+## Route Patterns
+
+| Pattern | Example | Matches |
+|---------|---------|---------|
+| `[param]` | `/users/[id].tsx` | `/users/123` |
+| `[...all]` | `/docs/[...slug].tsx` | `/docs/a/b/c` |
+| `[[opt]]` | `/posts/[[page]].tsx` | `/posts`, `/posts/2` |
+| `(group)` | `/(auth)/login.tsx` | `/login` |
+
+## Documentation
+
+For full documentation, visit [https://ereojs.dev/docs/router](https://ereojs.dev/docs/router)
+
+## Part of EreoJS
+
+This package is part of the [EreoJS](https://github.com/ereojs/ereo) monorepo - a modern full-stack framework built for Bun.
+
+## License
+
+MIT

package/dist/file-router.d.ts

@@ -0,0 +1,122 @@
+/**
+ * @ereo/router - File-based Route Discovery
+ *
+ * Discovers routes from the filesystem and builds a route tree.
+ * Supports watching for changes in development mode.
+ */
+import type { Route, RouteConfig } from '@ereo/core';
+import type { RouterOptions, RouterEvents } from './types';
+import { RouteTree } from './route-tree';
+import { RouteMatcher } from './matcher';
+/**
+ * File-based router.
+ */
+export declare class FileRouter {
+    private options;
+    private routesDir;
+    private routes;
+    private tree;
+    private matcher;
+    private watcher;
+    private eventHandlers;
+    constructor(options?: RouterOptions);
+    /**
+     * Initialize the router by discovering routes.
+     */
+    init(): Promise<void>;
+    /**
+     * Discover all routes from the filesystem.
+     */
+    discoverRoutes(): Promise<Route[]>;
+    /**
+     * Scan a directory recursively for route files.
+     */
+    private scanDirectory;
+    /**
+     * Start watching for file changes.
+     */
+    private startWatching;
+    /**
+     * Watch using Node.js file system watcher (works in Bun too).
+     */
+    private watchWithNode;
+    /**
+     * Handle file change event.
+     */
+    private debounceTimer;
+    private handleFileChange;
+    /**
+     * Convert route node to Route type.
+     */
+    private nodeToRoute;
+    /**
+     * Stop watching for changes.
+     */
+    stopWatching(): void;
+    /**
+     * Get all discovered routes.
+     */
+    getRoutes(): Route[];
+    /**
+     * Get the route tree.
+     */
+    getTree(): RouteTree | null;
+    /**
+     * Get the route matcher.
+     */
+    getMatcher(): RouteMatcher | null;
+    /**
+     * Match a URL pathname.
+     */
+    match(pathname: string): import("@ereo/core").RouteMatch | null;
+    /**
+     * Register an event handler.
+     */
+    on<K extends keyof RouterEvents>(event: K, handler: RouterEvents[K]): void;
+    /**
+     * Emit an event.
+     */
+    private emit;
+    /**
+     * Load a route module and parse its configuration.
+     */
+    loadModule(route: Route): Promise<void>;
+    /**
+     * Find parent route for a given route.
+     */
+    private findParentRoute;
+    /**
+     * Get route configuration (loads module if needed).
+     */
+    getRouteConfig(route: Route): Promise<RouteConfig | undefined>;
+    /**
+     * Get all routes with their configurations loaded.
+     * Only loads modules for routes that don't already have configs.
+     */
+    getRoutesWithConfig(): Promise<Route[]>;
+    /**
+     * Find routes by render mode.
+     */
+    findRoutesByRenderMode(mode: 'ssg' | 'ssr' | 'csr' | 'json' | 'xml'): Promise<Route[]>;
+    /**
+     * Find routes that require authentication.
+     */
+    findProtectedRoutes(): Promise<Route[]>;
+    /**
+     * Get all prerender paths from routes with SSG config.
+     */
+    getPrerenderPaths(): Promise<string[]>;
+    /**
+     * Load all route modules.
+     */
+    loadAllModules(): Promise<void>;
+}
+/**
+ * Create a file-based router.
+ */
+export declare function createFileRouter(options?: RouterOptions): FileRouter;
+/**
+ * Initialize a file router and discover routes.
+ */
+export declare function initFileRouter(options?: RouterOptions): Promise<FileRouter>;
+//# sourceMappingURL=file-router.d.ts.map

package/dist/file-router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-router.d.ts","sourceRoot":"","sources":["../src/file-router.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,KAAK,EAAa,aAAa,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACtE,OAAO,EAAkB,SAAS,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAiB,YAAY,EAAE,MAAM,WAAW,CAAC;AAaxD;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,OAAO,CAA0B;IACzC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,IAAI,CAA0B;IACtC,OAAO,CAAC,OAAO,CAA6B;IAC5C,OAAO,CAAC,OAAO,CAA2D;IAC1E,OAAO,CAAC,aAAa,CAA6B;gBAEtC,OAAO,GAAE,aAAkB;IASvC;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3B;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAmBxC;;OAEG;YACW,aAAa;IAqC3B;;OAEG;IACH,OAAO,CAAC,aAAa;IAKrB;;OAEG;IACH,OAAO,CAAC,aAAa;IAqBrB;;OAEG;IACH,OAAO,CAAC,aAAa,CAA8C;IAEnE,OAAO,CAAC,gBAAgB;IAyCxB;;OAEG;IACH,OAAO,CAAC,WAAW;IAYnB;;OAEG;IACH,YAAY,IAAI,IAAI;IAOpB;;OAEG;IACH,SAAS,IAAI,KAAK,EAAE;IAIpB;;OAEG;IACH,OAAO,IAAI,SAAS,GAAG,IAAI;IAI3B;;OAEG;IACH,UAAU,IAAI,YAAY,GAAG,IAAI;IAIjC;;OAEG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM;IAItB;;OAEG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,YAAY,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI;IAI1E;;OAEG;IACH,OAAO,CAAC,IAAI;IAUZ;;OAEG;IACG,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB7C;;OAEG;IACH,OAAO,CAAC,eAAe;IAKvB;;OAEG;IACG,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAOpE;;;OAGG;IACG,mBAAmB,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAW7C;;OAEG;IACG,sBAAsB,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAK5F;;OAEG;IACG,mBAAmB,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAK7C;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAmB5C;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CAYtC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,UAAU,CAEpE;AAED;;GAEG;AACH,wBAAsB,cAAc,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC,CAIjF"}

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @ereo/router
+ *
+ * File-based routing for the EreoJS framework.
+ * Supports dynamic routes, catch-all routes, layouts, and route groups.
+ */
+export { FileRouter, createFileRouter, initFileRouter, } from './file-router';
+export { parseMiddleware, parseRenderConfig, parseIslandsConfig, parseCacheConfig, parseProgressiveConfig, parseAuthConfig, parseDevConfig, parseVariants, parseRouteConfig, mergeRouteConfigs, } from './route-config';
+export { RouteTree, buildRouteTree, createRouteTree, filePathToUrlPath, } from './route-tree';
+export { RouteMatcher, createMatcher, matchRoute, matchWithLayouts, parsePathSegments, calculateRouteScore, patternToRegex, } from './matcher';
+export { registerMiddleware, getMiddleware, hasMiddleware, unregisterMiddleware, clearMiddlewareRegistry, resolveMiddleware, executeMiddlewareChain, createMiddlewareExecutor, composeMiddleware, when, method, path, createLoggerMiddleware, createCorsMiddleware, createRateLimitMiddleware, createMiddleware, chainMiddleware, registerTypedMiddleware, getTypedMiddleware, validateMiddlewareChain, globToRegex, } from './middleware-chain';
+export type { TypedMiddlewareContext, TypedMiddlewareHandler, TypedMiddleware, MiddlewareChainOptions, } from './middleware-chain';
+export type { MiddlewareHandler, NextFunction, Middleware, MiddlewareReference, AppContext, } from '@ereo/core';
+export { ParamValidationError, validators, validateParams, safeValidateParams, validateSearchParams, createRouteValidator, matchParamPattern, extractParamNames, } from './validation';
+export type { FileRoute, RouteSegment, RouteNode, RouterOptions, MatchResult, RouteRegistry, RouterEvents, } from './types';
+export { ROUTE_SCORE, SPECIAL_FILES, ROUTE_GROUP_PATTERN, DYNAMIC_SEGMENT_PATTERN, CATCH_ALL_PATTERN, OPTIONAL_PATTERN, } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EACL,UAAU,EACV,gBAAgB,EAChB,cAAc,GACf,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EACf,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EACL,SAAS,EACT,cAAc,EACd,eAAe,EACf,iBAAiB,GAClB,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,YAAY,EACZ,aAAa,EACb,UAAU,EACV,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,cAAc,GACf,MAAM,WAAW,CAAC;AAGnB,OAAO,EAEL,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,EACxB,iBAAiB,EACjB,IAAI,EACJ,MAAM,EACN,IAAI,EAEJ,sBAAsB,EACtB,oBAAoB,EACpB,yBAAyB,EAEzB,gBAAgB,EAChB,eAAe,EACf,uBAAuB,EACvB,kBAAkB,EAClB,uBAAuB,EAEvB,WAAW,GACZ,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EACV,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,sBAAsB,GACvB,MAAM,oBAAoB,CAAC;AAI5B,YAAY,EACV,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,mBAAmB,EACnB,UAAU,GACX,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,oBAAoB,EACpB,UAAU,EACV,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,cAAc,CAAC;AAGtB,YAAY,EACV,SAAS,EACT,YAAY,EACZ,SAAS,EACT,aAAa,EACb,WAAW,EACX,aAAa,EACb,YAAY,GACb,MAAM,SAAS,CAAC;AAGjB,OAAO,EACL,WAAW,EACX,aAAa,EACb,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,SAAS,CAAC"}