@rangojs/router 0.0.0-experimental.124 → 0.0.0-experimental.125

package/src/host/cookie-handler.ts

@@ -1,9 +1,3 @@
-/**
- * Cookie Override Handler
- *
- * Manages cookie-based host override for development environments.
- */
-
 import type { HostOverrideConfig } from "./types.js";
 import type { RouterRequestInput } from "../router/router-interfaces.js";
 import { matchPattern, parseRequest } from "./pattern-matcher.js";
@@ -13,9 +7,6 @@ import {
   HostValidationError,
 } from "./errors.js";
 
-/**
- * Parse cookies from request
- */
 export function parseCookies(request: Request): Record<string, string> {
   const cookieHeader = request.headers.get("cookie");
   if (!cookieHeader) {
@@ -40,24 +31,15 @@ export function parseCookies(request: Request): Record<string, string> {
   return cookies;
 }
 
-/**
- * Get cookie value from request
- */
 export function getCookie(request: Request, name: string): string | undefined {
   const cookies = parseCookies(request);
   return cookies[name];
 }
 
-/**
- * Create Set-Cookie header to delete a cookie
- */
 export function createDeleteCookieHeader(name: string): string {
   return `${name}=; Max-Age=0; Path=/; Secure; HttpOnly`;
 }
 
-/**
- * Create error response with cookie deletion
- */
 export function createCookieErrorResponse(
   cookieName: string,
   message: string,
@@ -77,9 +59,6 @@ export function createCookieErrorResponse(
   );
 }
 
-/**
- * Check if current host is allowed to use override
- */
 export function isHostAllowed(
   request: Request,
   allowedHosts: string[],
@@ -95,12 +74,6 @@ export function isHostAllowed(
   return false;
 }
 
-/**
- * Handle cookie override logic
- *
- * Returns overridden hostname if valid, original hostname if no override.
- * Throws errors for invalid overrides.
- */
 export function handleCookieOverride(
   request: Request,
   config: HostOverrideConfig | undefined,
@@ -115,46 +88,37 @@ export function handleCookieOverride(
   const cookieValue = getCookie(request, cookieName);
   const { hostname: originalHostname } = parseRequest(request);
 
-  // No cookie - return original hostname
   if (!cookieValue) {
     return originalHostname;
   }
 
-  // Check if current host is allowed
   const allowed = isHostAllowed(request, allowedHosts);
 
-  // If not allowed, throw error
   if (!allowed) {
     throw new HostOverrideNotAllowedError(originalHostname, cookieName, {
       cause: { cookieValue, currentHost: originalHostname },
     });
   }
 
-  // If allowed and has custom validation, run it
   if (validate) {
     try {
       const validatedHostname = validate(request, cookieValue, input);
       return validatedHostname;
     } catch (error) {
-      // Wrap in HostValidationError
       const message = error instanceof Error ? error.message : String(error);
       throw new HostValidationError(message, error);
     }
   }
 
-  // Default validation - verify it's a valid hostname using URL constructor
   try {
-    // Try to construct a URL with the hostname to validate it
     const testUrl = new URL(`https://${cookieValue}`);
 
-    // Ensure the hostname matches what we provided (URL constructor normalizes it)
     if (testUrl.hostname !== cookieValue) {
       throw new InvalidHostnameError(cookieValue, {
         cause: { original: cookieValue, normalized: testUrl.hostname },
       });
     }
   } catch (error) {
-    // If URL constructor failed, throw InvalidHostnameError with cause
     if (error instanceof InvalidHostnameError) {
       throw error;
     }

package/src/host/errors.ts

@@ -4,16 +4,10 @@
  * All host router errors extend HostRouterError for easy instance checking.
  */
 
-/**
- * Error options with cause
- */
 interface ErrorOptions {
   cause?: unknown;
 }
 
-/**
- * Base error class for all host router errors
- */
 export class HostRouterError extends Error {
   cause?: unknown;
 
@@ -27,9 +21,6 @@ export class HostRouterError extends Error {
   }
 }
 
-/**
- * Error thrown when pattern validation fails
- */
 export class InvalidPatternError extends HostRouterError {
   constructor(pattern: string, reason: string, options?: ErrorOptions) {
     super(`Invalid pattern "${pattern}": ${reason}`, options);
@@ -38,9 +29,6 @@ export class InvalidPatternError extends HostRouterError {
   }
 }
 
-/**
- * Error thrown when cookie override is not allowed
- */
 export class HostOverrideNotAllowedError extends HostRouterError {
   constructor(currentHost: string, cookieName: string, options?: ErrorOptions) {
     super(
@@ -52,9 +40,6 @@ export class HostOverrideNotAllowedError extends HostRouterError {
   }
 }
 
-/**
- * Error thrown when cookie hostname is invalid
- */
 export class InvalidHostnameError extends HostRouterError {
   constructor(hostname: string, options?: ErrorOptions) {
     super(`Invalid hostname format: "${hostname}"`, options);
@@ -63,9 +48,6 @@ export class InvalidHostnameError extends HostRouterError {
   }
 }
 
-/**
- * Error thrown when custom validation fails
- */
 export class HostValidationError extends HostRouterError {
   constructor(message: string, cause?: unknown) {
     super(message, { cause });
@@ -74,9 +56,6 @@ export class HostValidationError extends HostRouterError {
   }
 }
 
-/**
- * Error thrown when no route matches
- */
 export class NoRouteMatchError extends HostRouterError {
   constructor(hostname: string, pathname: string, options?: ErrorOptions) {
     super(`No route matched for ${hostname}${pathname}`, options);
@@ -85,9 +64,6 @@ export class NoRouteMatchError extends HostRouterError {
   }
 }
 
-/**
- * Error thrown when handler type is invalid
- */
 export class InvalidHandlerError extends HostRouterError {
   constructor(handler: unknown, options?: ErrorOptions) {
     super(`Invalid handler type: ${typeof handler}`, options);

package/src/host/index.ts

@@ -20,6 +20,12 @@
  *   }
  * };
  * ```
+ *
+ * The host surface (`Handler`, `Middleware`, `match`, `HostOverrideConfig.validate`)
+ * types `input` as `RouterRequestInput<any>` by design: a host router fans out to
+ * heterogeneous sub-apps with differing env/vars shapes, so there is no single
+ * `TEnv`/`TVars` to thread through. `input.env`/`input.vars` are therefore `any`
+ * here; the typed env shape lives on each sub-app's `createRouter<TEnv>()`.
  */
 
 // Core router

package/src/host/pattern-matcher.ts

@@ -12,15 +12,18 @@
  * - `**.example.com` - any depth subdomain
  * - `admin.*` - admin subdomain of any apex
  * - `example.com/admin` - specific domain with path prefix
+ *
+ * Apex vs subdomain is classified purely by dot-part COUNT (apex == exactly 2
+ * parts) — there is no Public Suffix List. A registrable domain under a
+ * multi-label public suffix (example.co.uk, shop.com.au) has 3+ parts and is
+ * therefore treated as a SUBDOMAIN, not an apex: `.`/`*` will NOT match it and
+ * `*.` WILL. If registrable-domain accuracy matters for a host-router consumer,
+ * supply an explicit apex/host hint rather than relying on the part count.
  */
 
 import { InvalidPatternError } from "./errors.js";
 
-/**
- * Normalize a pattern by removing trailing slashes from paths
- */
 export function normalizePattern(pattern: string): string {
-  // If pattern has a path component, remove trailing slash
   const slashIndex = pattern.indexOf("/");
   if (slashIndex !== -1) {
     const domain = pattern.slice(0, slashIndex);
@@ -30,9 +33,6 @@ export function normalizePattern(pattern: string): string {
   return pattern;
 }
 
-/**
- * Parse hostname and path from request URL
- */
 export function parseRequest(request: Request): {
   hostname: string;
   pathname: string;
@@ -46,26 +46,14 @@ export function parseRequest(request: Request): {
   return { hostname, pathname, parts };
 }
 
-/**
- * Count subdomain levels (0 for apex, 1+ for subdomains)
- */
 function getSubdomainLevel(parts: string[]): number {
-  // Apex domain has 2 parts (example.com)
-  // Single subdomain has 3 parts (www.example.com)
-  // Multi-level has 4+ parts (a.b.example.com)
   return Math.max(0, parts.length - 2);
 }
 
-/**
- * Check if hostname is an apex domain (no subdomains)
- */
 function isApexDomain(parts: string[]): boolean {
   return parts.length === 2;
 }
 
-/**
- * Match a single pattern against hostname and path
- */
 export function matchPattern(
   pattern: string,
   hostname: string,
@@ -74,19 +62,16 @@ export function matchPattern(
 ): boolean {
   const normalized = normalizePattern(pattern);
 
-  // Check if pattern has path component
   const slashIndex = normalized.indexOf("/");
   const hasPath = slashIndex !== -1;
   const domainPattern = hasPath ? normalized.slice(0, slashIndex) : normalized;
   const pathPattern = hasPath ? normalized.slice(slashIndex) : null;
 
-  // First match domain
   const domainMatch = matchDomainPattern(domainPattern, hostname, parts);
   if (!domainMatch) {
     return false;
   }
 
-  // Then match path (prefix match)
   if (pathPattern) {
     return pathname === pathPattern || pathname.startsWith(pathPattern + "/");
   }
@@ -94,81 +79,62 @@ export function matchPattern(
   return true;
 }
 
-/**
- * Match domain pattern against hostname
- */
 function matchDomainPattern(
   pattern: string,
   hostname: string,
   parts: string[],
 ): boolean {
-  // Exact match
   if (pattern === hostname) {
     return true;
   }
 
-  // `.` or `*` - any apex domain
   if (pattern === "." || pattern === "*") {
     return isApexDomain(parts);
   }
 
-  // `**` - any domain (apex + all subdomains)
   if (pattern === "**") {
     return true;
   }
 
-  // `*.` - any single-level subdomain
   if (pattern === "*.") {
     return getSubdomainLevel(parts) === 1;
   }
 
-  // `**.` - any multi-level subdomain (2+ levels)
   if (pattern === "**.") {
     return getSubdomainLevel(parts) >= 2;
   }
 
-  // `*.tld` - any apex domain with specific TLD (e.g., *.com)
   if (pattern.startsWith("*.") && !pattern.includes(".", 2)) {
     const tld = pattern.slice(2);
     return isApexDomain(parts) && hostname.endsWith("." + tld);
   }
 
-  // `*.example.com` - single subdomain of specific domain
   if (pattern.startsWith("*.")) {
     const baseDomain = pattern.slice(2);
     if (hostname.endsWith("." + baseDomain)) {
-      // Count parts: if pattern is *.example.com (3 parts),
-      // hostname should have exactly 4 parts (www.example.com)
       const patternParts = baseDomain.split(".");
       return parts.length === patternParts.length + 1;
     }
     return false;
   }
 
-  // `**.example.com` - any depth subdomain of specific domain
   if (pattern.startsWith("**.")) {
     const baseDomain = pattern.slice(3);
     if (hostname.endsWith("." + baseDomain)) {
       const patternParts = baseDomain.split(".");
-      // Must have more parts than the base domain (i.e., has subdomains)
       return parts.length > patternParts.length;
     }
     return false;
   }
 
-  // `subdomain.*` - specific subdomain of any apex domain
-  // e.g., admin.* matches admin.example.com, admin.google.com
   if (pattern.endsWith(".*")) {
     const subdomain = pattern.slice(0, -2);
-    // Must be single-level subdomain (3 parts total)
     if (parts.length === 3 && parts[0] === subdomain) {
       return true;
     }
     return false;
   }
 
-  // `subdomain.**` - specific subdomain of any domain (including multi-level)
-  // e.g., admin.** matches admin.example.com, admin.sub.example.com
   if (pattern.endsWith(".**")) {
     const subdomain = pattern.slice(0, -3);
     if (parts.length >= 3 && parts[0] === subdomain) {
@@ -177,11 +143,8 @@ function matchDomainPattern(
     return false;
   }
 
-  // `subdomain.` - specific subdomain of any apex domain (no wildcard)
-  // e.g., admin. matches admin.example.com, admin.google.com
   if (pattern.endsWith(".") && !pattern.includes("*")) {
     const subdomain = pattern.slice(0, -1);
-    // Must be exactly 3 parts (subdomain.domain.tld)
     if (parts.length === 3 && parts[0] === subdomain) {
       return true;
     }
@@ -191,9 +154,6 @@ function matchDomainPattern(
   return false;
 }
 
-/**
- * Validate pattern format
- */
 export function validatePattern(pattern: string): void {
   if (!pattern || typeof pattern !== "string") {
     throw new InvalidPatternError(
@@ -203,12 +163,9 @@ export function validatePattern(pattern: string): void {
     );
   }
 
-  // Check for invalid characters (spaces, etc.)
   if (/\s/.test(pattern)) {
     throw new InvalidPatternError(pattern, "contains whitespace", {
       cause: { pattern },
     });
   }
-
-  // Additional validation can be added here
 }

package/src/host/router.ts

@@ -32,27 +32,16 @@ import {
   InvalidHandlerError,
 } from "./errors.js";
 
-/**
- * Registry entry for a host router instance.
- * Stores references to the live routes array and fallback, so the discovery
- * plugin can iterate handlers registered after createHostRouter() returns.
- */
 export interface HostRouterRegistryEntry {
   routes: RouteEntry[];
   fallback: RouteEntry | null;
 }
 
-/**
- * Global registry for host routers (parallel to RouterRegistry for RSC routers).
- * Populated by createHostRouter() so the build-time discovery plugin can find
- * host routers and resolve their lazy handlers to trigger sub-app createRouter() calls.
- */
 export const HostRouterRegistry: Map<string, HostRouterRegistryEntry> =
   new Map();
 
 let hostRouterAutoId = 0;
 
-/** Whether a value is thenable (a Promise or Promise-like). */
 function isThenable(value: unknown): value is PromiseLike<unknown> {
   return (
     value !== null &&
@@ -61,12 +50,6 @@ function isThenable(value: unknown): value is PromiseLike<unknown> {
   );
 }
 
-/**
- * Whether a resolved value looks like a module namespace from a lazy import -
- * an object with a `default` export that is a function (a Handler) or a host
- * router (an object with `match`). Used to detect a `.map(() => import(...))`
- * misuse: an inline handler should return a Response, not a module.
- */
 function looksLikeLazyModule(value: unknown): boolean {
   if (value === null || typeof value !== "object" || !("default" in value)) {
     return false;
@@ -80,9 +63,6 @@ function looksLikeLazyModule(value: unknown): boolean {
   );
 }
 
-/**
- * Create a host router
- */
 export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
   const routes: RouteEntry[] = [];
   const globalMiddleware: Middleware[] = [];
@@ -96,9 +76,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
     }
   }
 
-  /**
-   * Create a route builder for chaining
-   */
   function createRouteBuilder(
     patterns: string[],
     isFallback = false,
@@ -147,9 +124,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
     };
   }
 
-  /**
-   * Find matching route for hostname and path
-   */
   function findMatchingRoute(
     hostname: string,
     pathname: string,
@@ -168,9 +142,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
     return null;
   }
 
-  /**
-   * Execute middleware chain
-   */
   async function executeMiddleware(
     middleware: Middleware[],
     request: Request,
@@ -189,8 +160,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
         return finalHandler();
       }
 
-      // Guard against double next() calls — a second call would
-      // re-enter the downstream chain and run handlers/side-effects twice.
       let nextCalled = false;
       const guardedNext = (): Promise<Response> => {
         if (nextCalled) {
@@ -208,15 +177,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
     return next();
   }
 
-  /**
-   * Execute a route entry, branching on its declared kind:
-   *   - "lazy": await the loader, then delegate to the default export
-   *     (a nested HostRouter via `.match`, or a request Handler directly).
-   *   - "handler": call the inline handler with the request. A `.map()` handler
-   *     that resolves to a module namespace (`{ default }`) is almost certainly
-   *     a misused lazy import, so it is rejected with a clear message rather
-   *     than silently returning a module object as the response.
-   */
   async function executeHandler(
     entry: RouteEntry,
     request: Request,
@@ -236,8 +196,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
 
     const result = (handler as Handler)(request, input);
 
-    // Inline handlers may be async; await to obtain the Response and to run the
-    // misuse guard below.
     if (isThenable(result)) {
       const awaited = await result;
       if (looksLikeLazyModule(awaited)) {
@@ -251,10 +209,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
     return result;
   }
 
-  /**
-   * Resolve a `.lazy()` mount: invoke the zero-arg loader, then dispatch to the
-   * module's default export.
-   */
   async function executeLazyMount(
     loader: LazyHandler,
     request: Request,
@@ -266,7 +220,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
       const defaultExport = (module as { default: Handler | HostRouter })
         .default;
 
-      // Default export is a nested host router
       if (
         typeof defaultExport === "object" &&
         defaultExport !== null &&
@@ -275,7 +228,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
         return (defaultExport as HostRouter).match(request, input);
       }
 
-      // Otherwise treat the default export as a request handler
       return (defaultExport as Handler)(request, input);
     }
 
@@ -288,14 +240,10 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
     });
   }
 
-  /**
-   * Router instance
-   */
   const router: HostRouter = {
     host(patterns: HostPattern): HostRouteBuilder {
       const patternsArray = Array.isArray(patterns) ? patterns : [patterns];
 
-      // Validate and normalize patterns
       const normalized = patternsArray.map((p) => {
         validatePattern(p);
         return normalizePattern(p);
@@ -314,9 +262,8 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
       return createRouteBuilder([], true);
     },
 
-    test(hostname: string): HostMatchResult | null {
+    test(hostname: string, pathname = "/"): HostMatchResult | null {
       const parts = hostname.split(".");
-      const pathname = "/";
 
       for (const route of routes) {
         for (const pattern of route.patterns) {
@@ -342,14 +289,11 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
       let effectiveHostname: string;
 
       try {
-        // Handle cookie override (may throw HostRouterError)
         effectiveHostname = handleCookieOverride(request, hostOverride, input);
       } catch (error) {
-        // If it's a HostRouterError from cookie override
         if (error instanceof HostRouterError) {
           log(`Cookie override error: ${error.message}`);
 
-          // If fallback exists, use it
           if (fallbackRoute) {
             const fallbackInput = { ...input, error };
             const allMiddleware = [
@@ -365,7 +309,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
             );
           }
 
-          // Otherwise return error response with cookie deletion
           if (hostOverride) {
             return createCookieErrorResponse(
               hostOverride.cookieName,
@@ -374,7 +317,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
           }
         }
 
-        // Re-throw non-HostRouterErrors
         throw error;
       }
 
@@ -384,7 +326,6 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
         log(`Cookie override: ${effectiveHostname}`);
       }
 
-      // Find matching route
       const matchedRoute = findMatchingRoute(effectiveHostname, pathname);
 
       if (!matchedRoute) {
@@ -397,19 +338,14 @@ export function createHostRouter(options: HostRouterOptions = {}): HostRouter {
         });
       }
 
-      // Combine global and route-specific middleware
       const allMiddleware = [...globalMiddleware, ...matchedRoute.middleware];
 
-      // Execute middleware chain and handler
       return executeMiddleware(allMiddleware, request, input, () =>
         executeHandler(matchedRoute, request, input),
       );
     },
   };
 
-  // Register in the global HostRouterRegistry for build-time discovery.
-  // The routes array and fallbackRoute ref are live - they reflect routes
-  // added via .host().map()/.lazy() after this point.
   const registryId = `host-router-${hostRouterAutoId++}`;
   HostRouterRegistry.set(registryId, {
     get routes() {

package/src/host/testing.ts

@@ -14,18 +14,6 @@ export interface CreateTestRequestOptions {
   headers?: Record<string, string>;
 }
 
-/**
- * Create a test request with specific host and cookies
- *
- * @example
- * ```ts
- * const request = createTestRequest({
- *   host: 'admin.example.com',
- *   path: '/dashboard',
- *   cookies: { 'x-requested-host': 'api.example.com' }
- * });
- * ```
- */
 export function createTestRequest(options: CreateTestRequestOptions): Request {
   const {
     host,
@@ -38,7 +26,6 @@ export function createTestRequest(options: CreateTestRequestOptions): Request {
   const url = `http://${host}${path}`;
   const requestHeaders = new Headers(headers);
 
-  // Add cookies if provided
   if (Object.keys(cookies).length > 0) {
     const cookieString = Object.entries(cookies)
       .map(([key, value]) => `${key}=${encodeURIComponent(value)}`)
@@ -52,9 +39,6 @@ export function createTestRequest(options: CreateTestRequestOptions): Request {
   });
 }
 
-// Try each pattern (a single pattern or any in an array) against the already
-// parsed host + path. Shared by testPattern and matchesHost so the
-// normalize-and-loop lives once.
 function matchPatterns(
   pattern: string | string[],
   hostname: string,

package/src/host/types.ts

@@ -110,9 +110,13 @@ export interface HostRouter {
   fallback(): HostRouteBuilder;
 
   /**
-   * Test which handler would match a hostname
+   * Test which handler would match a hostname (and optional pathname).
+   *
+   * `pathname` defaults to `"/"`. Pass it to probe path-prefixed patterns
+   * such as `host(["example.com/admin"])`, which only match when the request
+   * path is under the prefix.
    */
-  test(hostname: string): HostMatchResult | null;
+  test(hostname: string, pathname?: string): HostMatchResult | null;
 }
 
 /**

package/src/href-client.ts

@@ -298,13 +298,9 @@ declare global {
  */
 export function href<T extends ValidPaths>(path: T, mount?: string): string {
   if (mount && mount !== "/") {
-    // Strip trailing slash from mount to avoid double-slash when joining
     const normalizedMount = mount.endsWith("/") ? mount.slice(0, -1) : mount;
     return normalizedMount + path;
   }
-  // ValidPaths is built from template literals so T does extend string at
-  // runtime, but the inference can fail past a certain route-union complexity
-  // and TypeScript reports T as not assignable to string.
   return path as string;
 }