import React from "react"; import { RequestInfo } from "../requestInfo/types"; import type { DocumentProps, LayoutProps } from "./types.js"; type MaybePromise = T | Promise; type BivariantRouteHandler = { bivarianceHack(requestInfo: T): R; }["bivarianceHack"]; export type RouteMiddleware = BivariantRouteHandler>; export type ExceptHandler = { __rwExcept: true; handler: (error: unknown, requestInfo: T) => MaybePromise; pathPattern?: string; }; type RouteFunction = BivariantRouteHandler>; type RouteComponent = BivariantRouteHandler>; type RouteHandler = RouteFunction | RouteComponent | readonly [...RouteMiddleware[], RouteFunction | RouteComponent]; declare const METHOD_VERBS: readonly ["delete", "get", "head", "patch", "post", "put"]; export type MethodVerb = (typeof METHOD_VERBS)[number]; export type MethodHandlers = { [K in MethodVerb]?: RouteHandler; } & { config?: { disable405?: true; disableOptions?: true; }; custom?: { [method: string]: RouteHandler; }; }; export type Route = RouteMiddleware | RouteDefinition | ExceptHandler | readonly Route[]; type NormalizedRouteDefinition = { path: string; handler: RouteHandler | MethodHandlers; layouts?: React.FC>[]; }; export type RouteDefinition = NormalizedRouteDefinition & { readonly __rwPath?: Path; }; type TrimTrailingSlash = S extends `${infer Head}/` ? TrimTrailingSlash : S; type TrimLeadingSlash = S extends `/${infer Rest}` ? TrimLeadingSlash : S; type NormalizePrefix = TrimTrailingSlash> extends "" ? "" : `/${TrimTrailingSlash>}`; type NormalizePath = TrimTrailingSlash extends "/" ? "/" : `/${TrimTrailingSlash>}`; type JoinPaths = NormalizePrefix extends "" ? NormalizePath : Path extends "/" ? NormalizePrefix : `${NormalizePrefix}${NormalizePath}`; type PrefixedRouteValue = Value extends RouteDefinition ? RouteDefinition, Req> : Value extends ExceptHandler ? Value : Value extends readonly Route[] ? PrefixedRouteArray : Value; type PrefixedRouteArray[]> = Routes extends readonly [] ? [] : Routes extends readonly [infer Head, ...infer Tail] ? readonly [ PrefixedRouteValue, ...PrefixedRouteArray[] ? Tail : []> ] : ReadonlyArray>; export declare function matchPath(routePath: string, requestPath: string): T["params"] | null; export declare function defineRoutes(routes: readonly Route[]): { routes: Route[]; handle: ({ request, renderPage, getRequestInfo, onError, runWithRequestInfoOverrides, rscActionHandler, }: { request: Request; renderPage: (requestInfo: T, Page: React.FC, onError: (error: unknown) => void) => Promise; getRequestInfo: () => T; onError: (error: unknown) => void; runWithRequestInfoOverrides: (overrides: Partial, fn: () => Promise) => Promise; rscActionHandler: (request: Request) => Promise; }) => Response | Promise; }; /** * Defines a route handler for a path pattern. * * Supports three types of path patterns: * - Static: /about, /contact * - Parameters: /users/:id, /posts/:postId/edit * - Wildcards: /files/\*, /api/\*\/download * * @example * // Static route * route("/about", () => ) * * @example * // Route with parameters * route("/users/:id", ({ params }) => { * return * }) * * @example * // Route with wildcards * route("/files/*", ({ params }) => { * const filePath = params.$0 * return * }) * * @example * // Method-based routing * route("/api/users", { * get: () => Response.json(users), * post: ({ request }) => Response.json({ status: "created" }, { status: 201 }), * delete: () => new Response(null, { status: 204 }), * }) * * @example * // Route with middleware array * route("/admin", [isAuthenticated, isAdmin, () => ]) */ export declare function route(path: Path, handler: RouteHandler | MethodHandlers): RouteDefinition, T>; /** * Defines a route handler for the root path "/". * * @example * // Homepage * index(() => ) * * @example * // With middleware * index([logRequest, () => ]) */ export declare function index(handler: RouteHandler): RouteDefinition<"/", T>; /** * Defines an error handler that catches errors from routes, middleware, and RSC actions. * * @example * // Global error handler * except((error, requestInfo) => { * console.error(error); * return new Response("Internal Server Error", { status: 500 }); * }) * * @example * // Error handler that returns a React component * except((error) => { * return ; * }) */ export declare function except(handler: (error: unknown, requestInfo: T) => MaybePromise): ExceptHandler; export declare function prefix[] = readonly Route[]>(prefixPath: Prefix, routes: Routes): PrefixedRouteArray; export declare const wrapHandlerToThrowResponses: (handler: RouteFunction | RouteComponent) => RouteHandler; /** * Wraps routes with a layout component. * * @example * // Define a layout component * function BlogLayout({ children }: { children?: React.ReactNode }) { * return ( *
*
Blog Navigation
*
{children}
*
* ) * } * * // Apply layout to routes * const blogRoutes = layout(BlogLayout, [ * route("/", () => ), * route("/post/:id", ({ params }) => ), * ]) */ export declare function layout[] = readonly Route[]>(LayoutComponent: React.FC>, routes: Routes): Routes; /** * Wraps routes with a Document component and configures rendering options. * * @param options.rscPayload - Toggle the RSC payload that's appended to the Document. Disabling this will mean that interactivity no longer works. * @param options.ssr - Disable sever side rendering for all these routes. This only allow client side rendering, which requires `rscPayload` to be enabled. * * @example * // Basic usage * defineApp([ * render(Document, [ * route("/", () => ), * route("/about", () => ), * ]), * ]) * * @example * // With custom rendering options * render(Document, [ * route("/", () => ), * ], { * rscPayload: true, * ssr: true, * }) */ type RenderedRoutes[]> = readonly [RouteMiddleware, ...Routes]; export declare function render[] = readonly Route[]>(Document: React.FC>, routes: Routes, options?: { rscPayload?: boolean; ssr?: boolean; }): RenderedRoutes; export declare const isClientReference: (value: any) => boolean; export {};