@rangojs/router 0.0.0-experimental.9 → 0.0.0-experimental.91

package/src/reverse.ts

@@ -1,4 +1,7 @@
 import type { ExtractParams } from "./types.js";
+import type { SearchSchema, ResolveSearchSchema } from "./search-params.js";
+import { serializeSearchParams } from "./search-params.js";
+import { encodePathSegment } from "./router/url-params.js";
 
 /**
  * Sanitize prefix string by removing leading slash
@@ -8,98 +11,55 @@ export type SanitizePrefix<T extends string> = T extends `/${infer P}` ? P : T;
 
 /**
  * Helper type to merge multiple route definitions into a single accumulated type.
- * Note: When using createRouter, types accumulate automatically through the
- * builder chain, so this type is typically not needed.
  *
  * @example
  * ```typescript
- * // Manual type merging (rarely needed):
- * type AppRoutes = MergeRoutes<[
- *   typeof homeRoutes,
- *   PrefixRoutePatterns<typeof blogRoutes, "/blog">,
- * ]>;
- *
- * // Preferred: Let router accumulate types automatically
- * const router = createRouter<AppEnv>()
- *   .routes(homeRoutes).map(...)
- *   .routes("/blog", blogRoutes).map(...);
- * type AppRoutes = typeof router.routeMap;
+ * type AppRoutes = MergeRoutes<[typeof siteRoutes, typeof apiRoutes]>;
  * ```
  */
 export type MergeRoutes<T extends unknown[]> = T extends [
   infer First,
-  ...infer Rest
+  ...infer Rest,
 ]
   ? First & MergeRoutes<Rest>
   : {};
 
-/**
- * Add key prefix to all entries in a route map
- * { "cart": "/cart" } with prefix "shop" -> { "shop.cart": "/shop/cart" }
- */
-export type PrefixRouteKeys<
-  T,
-  Prefix extends string
-> = Prefix extends ""
-  ? T
-  : { [K in keyof T as `${Prefix}.${K & string}`]: T[K] };
-
-/**
- * Add path prefix to all patterns in a route map
- * { "cart": "/cart" } with prefix "/shop" -> { "cart": "/shop/cart" }
- */
-export type PrefixRoutePatterns<
-  T,
-  PathPrefix extends string
-> = {
-  [K in keyof T]: PathPrefix extends "" | "/"
-    ? T[K]
-    : T[K] extends "/"
-      ? PathPrefix
-      : T[K] extends string
-        ? `${PathPrefix}${T[K]}`
-        : T[K];
-};
-
-/**
- * Combined: prefix both keys and patterns
- * Used for module augmentation registration
- *
- * @example
- * ```typescript
- * // Given shopRoutes = { "index": "/", "cart": "/cart", "products.detail": "/product/:slug" }
- * // PrefixedRoutes<typeof shopRoutes, "shop"> produces:
- * // { "shop.index": "/shop", "shop.cart": "/shop/cart", "shop.products.detail": "/shop/product/:slug" }
- * ```
- */
-export type PrefixedRoutes<
-  T,
-  KeyPrefix extends string,
-  PathPrefix extends string = KeyPrefix extends "" ? "" : `/${KeyPrefix}`
-> = PrefixRouteKeys<PrefixRoutePatterns<T, PathPrefix>, KeyPrefix>;
-
 /**
  * Helper to safely extract route patterns from a routes object
  * Handles string values, { path, response } objects, and interface types (like RegisteredRoutes)
  */
-type RoutePatternFor<TRoutes, TName extends keyof TRoutes> =
-  TRoutes[TName] extends string ? TRoutes[TName]
-  : TRoutes[TName] extends { readonly path: infer P extends string } ? P
-  : string;
+type RoutePatternFor<
+  TRoutes,
+  TName extends keyof TRoutes,
+> = TRoutes[TName] extends string
+  ? TRoutes[TName]
+  : TRoutes[TName] extends { readonly path: infer P extends string }
+    ? P
+    : string;
 
 /**
  * Extract params type for a route
  */
-export type ParamsFor<
-  TRoutes,
-  TName extends keyof TRoutes
-> = ExtractParams<RoutePatternFor<TRoutes, TName>>;
+export type ParamsFor<TRoutes, TName extends keyof TRoutes> = ExtractParams<
+  RoutePatternFor<TRoutes, TName>
+>;
 
 /**
  * Check if an object type has any keys
  */
 type IsEmptyObject<T> = keyof T extends never ? true : false;
 
+/**
+ * Extract search schema from a route entry.
+ * Returns {} if no search schema is defined.
+ */
+type ExtractSearchSchema<
+  TRoutes,
+  TName extends keyof TRoutes,
+> = TRoutes[TName] extends { readonly search: infer S extends SearchSchema }
+  ? S
+  : {};
+
 /**
  * Type-safe reverse function signature (Django-style URL reversal)
  *
@@ -117,7 +77,11 @@ export type ReverseFunction<TRoutes> = {
    * Route without params - validates route name exists
    */
   <TName extends keyof TRoutes & string>(
-    name: IsEmptyObject<ExtractParams<RoutePatternFor<TRoutes, TName>>> extends true ? TName : never
+    name: IsEmptyObject<
+      ExtractParams<RoutePatternFor<TRoutes, TName>>
+    > extends true
+      ? TName
+      : never,
   ): string;
 
   /**
@@ -125,69 +89,135 @@ export type ReverseFunction<TRoutes> = {
    */
   <TName extends keyof TRoutes & string>(
     name: TName,
-    params: ExtractParams<RoutePatternFor<TRoutes, TName>>
+    params: ExtractParams<RoutePatternFor<TRoutes, TName>>,
+  ): string;
+
+  /**
+   * Route with params and search - validates route name, params, and search
+   */
+  <TName extends keyof TRoutes & string>(
+    name: TName,
+    params: ExtractParams<RoutePatternFor<TRoutes, TName>>,
+    search: ResolveSearchSchema<ExtractSearchSchema<TRoutes, TName>>,
+  ): string;
+
+  /**
+   * Dot-prefixed route without params - strictly local resolution
+   */
+  <TName extends keyof TRoutes & string>(
+    name: IsEmptyObject<
+      ExtractParams<RoutePatternFor<TRoutes, TName>>
+    > extends true
+      ? `.${TName}`
+      : never,
+  ): string;
+
+  /**
+   * Dot-prefixed route with params - strictly local resolution
+   */
+  <TName extends keyof TRoutes & string>(
+    name: `.${TName}`,
+    params: ExtractParams<RoutePatternFor<TRoutes, TName>>,
+  ): string;
+
+  /**
+   * Dot-prefixed route with params and search - strictly local resolution
+   */
+  <TName extends keyof TRoutes & string>(
+    name: `.${TName}`,
+    params: ExtractParams<RoutePatternFor<TRoutes, TName>>,
+    search: ResolveSearchSchema<ExtractSearchSchema<TRoutes, TName>>,
   ): string;
 };
 
 /**
- * Type-safe scoped reverse function signature for use with scopedReverse<typeof patterns>()
+ * Type-safe scoped reverse function with separate local and global namespaces.
  *
- * **Recommended: Use route names for type safety.**
- * Route names validate both the route exists and params are correct.
- * Path-based URLs (`/...`) are an escape hatch with no validation.
+ * - `.name` — local resolution within the current include() scope
+ * - `name` — global resolution against the named-routes definition
  *
  * @example
  * ```typescript
- * // RECOMMENDED: Use route names for type safety
- * reverse("blog.post", { slug: "hello" })  // ✓ Validates route + params
- * reverse("shop.cart")                      // ✓ Validates route exists
- *
- * // ESCAPE HATCH: Path-based URLs (no validation)
- * reverse("/about")                         // ⚠ No type checking
- * reverse("/typo/in/path")                  // ⚠ Won't catch errors
+ * reverse(".article", { slug: "hello" })     // ✓ Local route (resolves with mount prefix)
+ * reverse(".index")                           // ✓ Local route (no params)
+ * reverse("magazine.index")                   // ✓ Global route (fully qualified)
+ * reverse("blog.post", { slug: "hello" })     // ✓ Global route + params
+ * reverse(".typo")                            // ✗ Compile error (not in local routes)
+ * reverse("typo")                             // ✗ Compile error (not in global routes)
  * ```
  */
-export type ScopedReverseFunction<TLocalRoutes> = {
+export type ScopedReverseFunction<
+  TLocalRoutes,
+  TGlobalRoutes = TLocalRoutes,
+> = {
   /**
-   * Route without params - validates route name exists
-   * @recommended Use this for type-safe URL generation
+   * Global route without params
    */
-  <TName extends keyof TLocalRoutes & string>(
-    name: IsEmptyObject<ExtractParams<RoutePatternFor<TLocalRoutes, TName>>> extends true ? TName : never
+  <TName extends keyof TGlobalRoutes & string>(
+    name: IsEmptyObject<
+      ExtractParams<RoutePatternFor<TGlobalRoutes, TName>>
+    > extends true
+      ? TName
+      : never,
   ): string;
 
   /**
-   * Route with params - validates both route name and params
-   * @recommended Use this for type-safe URL generation with parameters
+   * Global route with params
    */
-  <TName extends keyof TLocalRoutes & string>(
+  <TName extends keyof TGlobalRoutes & string>(
+    name: TName,
+    params: ExtractParams<RoutePatternFor<TGlobalRoutes, TName>>,
+  ): string;
+
+  /**
+   * Global route with params and search
+   */
+  <TName extends keyof TGlobalRoutes & string>(
     name: TName,
-    params: ExtractParams<RoutePatternFor<TLocalRoutes, TName>>
+    params: ExtractParams<RoutePatternFor<TGlobalRoutes, TName>>,
+    search: ResolveSearchSchema<ExtractSearchSchema<TGlobalRoutes, TName>>,
   ): string;
 
   /**
-   * Absolute route name (contains dot) - global lookup
-   * Use for cross-module navigation: "shop.cart", "blog.post"
+   * Dot-prefixed local route without params
    */
-  (name: `${string}.${string}`, params?: Record<string, string>): string;
+  <TName extends keyof TLocalRoutes & string>(
+    name: IsEmptyObject<
+      ExtractParams<RoutePatternFor<TLocalRoutes, TName>>
+    > extends true
+      ? `.${TName}`
+      : never,
+  ): string;
 
   /**
-   * Path-based URL - ESCAPE HATCH, no type validation
-   * Prefer route names for type safety. Only use paths when necessary.
+   * Dot-prefixed local route with params
    */
-  (name: `/${string}`, params?: Record<string, string>): string;
+  <TName extends keyof TLocalRoutes & string>(
+    name: `.${TName}`,
+    params: ExtractParams<RoutePatternFor<TLocalRoutes, TName>>,
+  ): string;
+
+  /**
+   * Dot-prefixed local route with params and search
+   */
+  <TName extends keyof TLocalRoutes & string>(
+    name: `.${TName}`,
+    params: ExtractParams<RoutePatternFor<TLocalRoutes, TName>>,
+    search: ResolveSearchSchema<ExtractSearchSchema<TLocalRoutes, TName>>,
+  ): string;
 };
 
 /**
  * Extract local routes type from UrlPatterns
  * Used with scopedReverse() to get the routes type from patterns
  */
-export type ExtractLocalRoutes<TPatterns> =
-  TPatterns extends { readonly _routes?: infer TRoutes }
-    ? TRoutes
-    : TPatterns extends Record<string, string>
-      ? TPatterns
-      : Record<string, string>;
+export type ExtractLocalRoutes<TPatterns> = TPatterns extends {
+  readonly _routes?: infer TRoutes;
+}
+  ? TRoutes
+  : TPatterns extends Record<string, string>
+    ? TPatterns
+    : Record<string, string>;
 
 /**
  * Extract the response data type for a named route from a UrlPatterns instance.
@@ -198,24 +228,23 @@ export type { RouteResponse } from "./urls.js";
 /**
  * Get a locally-typed reverse function from ctx.reverse for composable modules.
  *
- * This is a type-only cast - ctx.reverse already resolves local names at runtime
- * based on the current route prefix. This helper just provides type safety
- * for local route names within a url module.
+ * This is a type-only cast - ctx.reverse already resolves names at runtime.
+ * Provides type safety: `.name` validates against local routes,
+ * `name` validates against global named-routes.
  *
  * @param reverse - The ctx.reverse function from HandlerContext
- * @returns The same reverse function, but typed for local routes
+ * @returns The same reverse function, typed with local + global routes
  *
  * @example
  * ```typescript
  * // urls/blog.tsx
  * export const blogPatterns = urls(({ path }) => [
  *   path("/", (ctx) => {
- *     // Get locally-typed reverse for this module's routes
  *     const reverse = scopedReverse<typeof blogPatterns>(ctx.reverse);
  *
- *     reverse("index");              // ✓ Type-safe local route
- *     reverse("post", { slug: "x" }); // ✓ Type-safe with params
- *     reverse("shop.cart");          // ✓ Cross-module (absolute name)
+ *     reverse(".index");              // ✓ Local route
+ *     reverse(".post", { slug: "x" }); // ✓ Local with params
+ *     reverse("shop.cart");           // ✓ Global route
  *
  *     return <BlogIndex />;
  *   }, { name: "index" }),
@@ -225,7 +254,7 @@ export type { RouteResponse } from "./urls.js";
  * ```
  */
 export function scopedReverse<TPatterns>(
-  reverse: ((...args: any[]) => string)
+  reverse: (...args: any[]) => string,
 ): ScopedReverseFunction<ExtractLocalRoutes<TPatterns>> {
   return reverse as ScopedReverseFunction<ExtractLocalRoutes<TPatterns>>;
 }
@@ -244,24 +273,83 @@ export function scopedReverse<TPatterns>(
  * reverse("detail", { slug: "my-product" }); // "/shop/product/my-product"
  * ```
  */
+type RouteMapEntry = string | { path: string; search?: Record<string, string> };
+
+function resolveRoutePattern(
+  entry: RouteMapEntry | undefined,
+): string | undefined {
+  if (!entry) return undefined;
+  return typeof entry === "string" ? entry : entry.path;
+}
+
 export function createReverse<TRoutes extends Record<string, string>>(
-  routeMap: TRoutes
+  routeMap: TRoutes,
 ): ReverseFunction<TRoutes & Record<string, string>> {
-  return ((name: string, params?: Record<string, string>) => {
-    const pattern = routeMap[name];
+  return ((
+    name: string,
+    params?: Record<string, string>,
+    search?: Record<string, unknown>,
+  ) => {
+    const pattern = resolveRoutePattern(
+      routeMap[name] as unknown as RouteMapEntry,
+    );
     if (!pattern) {
+      // During build-time discovery, lazy includes haven't resolved yet.
+      // Return a placeholder instead of crashing the build.
+      if ((globalThis as any).__rscRouterDiscoveryActive) {
+        return `/__unresolved_reverse/${name}`;
+      }
       throw new Error(`Unknown route: ${name}`);
     }
 
-    if (!params) return pattern;
+    let result = pattern;
+    if (params) {
+      // Replace :param placeholders with actual values
+      // Strip constraint syntax: :param(a|b) -> use "param" as key
+      // Optional params (:param?) are omitted when not provided
+      let hadOmittedOptional = false;
+      result = result.replace(
+        /:([a-zA-Z_][a-zA-Z0-9_]*)(\([^)]*\))?(\?)/g,
+        (_, key, _constraint, optional) => {
+          const value = params[key];
+          // Empty string is treated as omitted — the trie matcher fills
+          // unmatched optional params with "" (not undefined), so reverse
+          // must collapse those segments instead of leaving empty slots.
+          if (value === undefined || value === "") {
+            hadOmittedOptional = true;
+            return "";
+          }
+          return encodePathSegment(value);
+        },
+      );
+      // Second pass: required params (no trailing ?)
+      result = result.replace(
+        /:([a-zA-Z_][a-zA-Z0-9_]*)(\([^)]*\))?(?!\?)/g,
+        (_, key) => {
+          const value = params[key];
+          if (value === undefined) {
+            throw new Error(`Missing param "${key}" for route "${name}"`);
+          }
+          return encodePathSegment(value);
+        },
+      );
+      // Clean up slashes only when an optional param was actually omitted,
+      // so intentional trailing-slash patterns like "/blog/" are preserved.
+      if (hadOmittedOptional) {
+        const hadTrailingSlash = pattern.length > 1 && pattern.endsWith("/");
+        result = result.replace(/\/\/+/g, "/").replace(/\/+$/, "") || "/";
+        if (hadTrailingSlash && !result.endsWith("/")) result += "/";
+      }
+    }
 
-    // Replace :param placeholders with actual values
-    return pattern.replace(/:([^/]+)/g, (_, key) => {
-      const value = params[key];
-      if (value === undefined) {
-        throw new Error(`Missing param "${key}" for route "${name}"`);
+    // Append search params as query string
+    if (search) {
+      const qs = serializeSearchParams(search);
+      if (qs) {
+        result += `?${qs}`;
       }
-      return encodeURIComponent(value);
-    });
+    }
+
+    return result;
   }) as ReverseFunction<TRoutes>;
 }

package/src/root-error-boundary.tsx

@@ -60,7 +60,8 @@ function NetworkErrorFallback({
           marginBottom: "1.5rem",
         }}
       >
-        {error.message || "Unable to connect to the server. Please check your internet connection."}
+        {error.message ||
+          "Unable to connect to the server. Please check your internet connection."}
       </p>
       <div style={{ display: "flex", gap: "1rem", justifyContent: "center" }}>
         <button
@@ -104,7 +105,12 @@ function NetworkErrorFallback({
  * Default fallback UI for root error boundary
  * This is shown when an unhandled error bubbles up to the root
  */
-function RootErrorFallback({ error, reset }: ClientErrorBoundaryFallbackProps): ReactNode {
+function RootErrorFallback({
+  error,
+  reset,
+}: ClientErrorBoundaryFallbackProps): ReactNode {
+  const isDev = process.env.NODE_ENV !== "production";
+
   return (
     <div
       style={{
@@ -131,38 +137,40 @@ function RootErrorFallback({ error, reset }: ClientErrorBoundaryFallbackProps):
       >
         An unexpected error occurred while processing your request.
       </p>
-      <div
-        style={{
-          background: "#fef2f2",
-          border: "1px solid #fecaca",
-          borderRadius: "0.5rem",
-          padding: "1rem",
-          marginBottom: "1rem",
-        }}
-      >
-        <p
+      {isDev && (
+        <div
           style={{
-            fontWeight: 600,
-            color: "#991b1b",
-            marginBottom: "0.5rem",
+            background: "#fef2f2",
+            border: "1px solid #fecaca",
+            borderRadius: "0.5rem",
+            padding: "1rem",
+            marginBottom: "1rem",
           }}
         >
-          {error.name}: {error.message}
-        </p>
-        {error.stack && (
-          <pre
+          <p
             style={{
-              fontSize: "0.75rem",
-              color: "#6b7280",
-              overflow: "auto",
-              whiteSpace: "pre-wrap",
-              wordBreak: "break-word",
+              fontWeight: 600,
+              color: "#991b1b",
+              marginBottom: "0.5rem",
             }}
           >
-            {error.stack}
-          </pre>
-        )}
-      </div>
+            {error.name}: {error.message}
+          </p>
+          {error.stack && (
+            <pre
+              style={{
+                fontSize: "0.75rem",
+                color: "#6b7280",
+                overflow: "auto",
+                whiteSpace: "pre-wrap",
+                wordBreak: "break-word",
+              }}
+            >
+              {error.stack}
+            </pre>
+          )}
+        </div>
+      )}
       <div style={{ display: "flex", gap: "1rem" }}>
         <button
           type="button"
@@ -231,7 +239,11 @@ export class RootErrorBoundary extends Component<
   }
 
   componentDidCatch(error: Error, errorInfo: React.ErrorInfo): void {
-    console.error("[RootErrorBoundary] Unhandled error caught:", error, errorInfo);
+    console.error(
+      "[RootErrorBoundary] Unhandled error caught:",
+      error,
+      errorInfo,
+    );
   }
 
   componentDidUpdate(prevProps: { children: ReactNode }): void {

package/src/route-content-wrapper.tsx

@@ -2,7 +2,7 @@
 import type { ReactNode } from "react";
 import { Suspense, use, useId } from "react";
 import { invariant } from "./errors";
-import { OutletProvider } from "./client.js";
+import { OutletProvider } from "./outlet-provider.js";
 import type { ResolvedSegment } from "./types.js";
 import { isLoaderDataResult } from "./types.js";
 
@@ -31,7 +31,10 @@ export function RouteContentWrapper({
     return content as ReactNode;
   }
   return (
-    <Suspense fallback={fallback ?? null} key={segmentId ? "route-content-suspense-" + segmentId : undefined}>
+    <Suspense
+      fallback={fallback ?? null}
+      key={segmentId ? "route-content-suspense-" + segmentId : undefined}
+    >
       <Suspender content={content} key={segmentId} />
     </Suspense>
   );
@@ -50,11 +53,11 @@ export function RouteContentWrapperCallback<T>({
   invariant(children, "RouteContentWrapperCallback requires children");
   invariant(
     typeof children === "function",
-    "RouteContentWrapperCallback requires children to be a function"
+    "RouteContentWrapperCallback requires children to be a function",
   );
   invariant(
     resolve !== undefined,
-    "RouteContentWrapperCallback requires resolve"
+    "RouteContentWrapperCallback requires resolve",
   );
   return (
     <Suspense