@rshono/core 1.0.0-rc.2 → 1.0.0-rc.21

package/dist/router.d.ts

@@ -1,17 +1,17 @@
 import type { Env, Handler } from 'hono';
 import type { ParamKeys, ParamKeyToRecord } from 'hono/types';
 import type { ReactNode } from 'react';
-import type { Ctx } from './runtime/context.js';
+import type { RequestContext } from './runtime/context.js';
 type Simplify<T> = {
     [K in keyof T]: T[K];
 } & {};
 type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
 /**
- * The `params` record implied by a route path pattern — one required `string` key
- * per `:param` segment, `Record<string, never>` for a path with no params.
+ * The `params` record implied by a route path pattern — one required `string` key per `:param`
+ * segment, `Record<string, never>` for a path with none. Paths use Hono's syntax, so `:id`,
+ * `:id{[0-9]+}` and `*` all work.
  *
- * Paths use Hono's syntax, so `:id`, `:id{[0-9]+}` and `*` all work. You rarely
- * name this type directly; {@link PageProps} applies it for you.
+ * You rarely name this directly; {@link PageProps} applies it for you.
  *
  * @typeParam P - The literal route path, e.g. `'/users/:id/posts/:postId'`.
  *
@@ -19,23 +19,21 @@ type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) exten
  * ```ts
  * type P = PathParams<'/users/:id/posts/:postId'>; // { id: string; postId: string }
  * ```
+ *
+ * @see {@link https://hono.dev/docs/api/routing#path-parameter | Hono — path parameters}
  */
 export type PathParams<P extends string> = ParamKeys<P> extends never ? Record<string, never> : Simplify<UnionToIntersection<ParamKeyToRecord<ParamKeys<P>>>>;
 /**
- * Props every page component receives. Pass the route's path as the type
- * argument to get `params` typed key-by-key; without it `params` falls back to
- * an open `Record<string, string>`.
- *
- * `defineRoutes` checks each page's props against `PageProps<path>` at compile
- * time, so a mismatched path literal is a type error at the route definition.
+ * Props every page component receives. Pass the route's path as the type argument to get `params`
+ * typed key-by-key; without it `params` falls back to an open `Record<string, string>`.
  *
- * The location props (`url` and `params`) mirror what a `'use client'` component
- * gets from `useNavigation()` — same names, same types — so moving a read across
- * the server/client line is a copy-paste.
+ * `defineRoutes` checks each page's props against `PageProps<path>`, so a mismatched path literal is
+ * a type error at the route definition. `url` and `params` mirror what `useNavigation()` gives a
+ * `'use client'` component, so a read moves across the server/client line unchanged.
  *
  * @typeParam Path - The literal path this page is mounted at, e.g. `'/profile/:id'`.
- * @typeParam E - The app's Hono {@link Env}, to type {@link Ctx.var} and
- *   {@link Ctx.env} on {@link PageProps.ctx}.
+ * @typeParam E - The app's Hono {@link Env}, to type {@link RequestContext.var} and
+ *   {@link RequestContext.env} on {@link PageProps.ctx}.
  *
  * @example
  * ```tsx
@@ -47,50 +45,42 @@ export type PathParams<P extends string> = ParamKeys<P> extends never ? Record<s
  *   return <Layout>{user.name} — {tab}</Layout>;
  * }
  * ```
+ *
+ * @see {@link https://www.rshono.com/docs/pages#page-props | Docs — page props}
  */
 export interface PageProps<Path extends string = string, E extends Env = Env> {
     /**
-     * The absolute browser-facing request {@link URL}, proxy-header aware
-     * (`X-Forwarded-Host` / `-Proto`). Read `url.pathname`, `url.searchParams` and
-     * the rest off it.
-     *
-     * A fresh instance per request that nothing else holds, so mutating it is local
-     * to the page — but note it is *not* serializable, so a `'use client'` component
-     * has to be handed `url.href` rather than `url`.
+     * The absolute browser-facing request {@link URL}, proxy-header aware (`X-Forwarded-Host` /
+     * `-Proto`). A fresh instance per request, so mutating it is local to the page; it is not
+     * serializable, so hand a `'use client'` component `url.href` rather than `url`.
      *
-     * On a prerendered page it is the build-time URL: a `render: 'static'` route is
-     * rendered once, against `siteUrl` and with no query string, and that one file
-     * then answers every request whatever its own query. So `url.searchParams` is
-     * always empty there — read the query from `useNavigation().url` in a
-     * `'use client'` component instead, or mark the route `render: 'dynamic'`.
+     * On a `render: 'static'` route this is the build-time URL — rendered once against `siteUrl`, so the
+     * origin is `siteUrl`'s and `url.searchParams` is always empty, on first paint and after a soft
+     * navigation alike. **`useNavigation().url` is the same frozen URL, not a way around it**: the payload
+     * carries one `href` and both readings come from it. Mark the route `render: 'dynamic'` if the page
+     * depends on the query; a `'use client'` component that only wants it after hydration can read
+     * `location.search` in an effect.
      */
     url: URL;
     /** Matched route params for this request, e.g. `{ id: '42' }` for `/profile/:id`. */
     params: string extends Path ? Record<string, string> : PathParams<Path>;
     /**
-     * The request context — the very object `getContext()` returns, handed to the
-     * page so cookies, headers, env and middleware variables are reachable without
-     * an import.
+     * The request context — the object `getRequestContext()` returns, handed to the page so cookies,
+     * headers, env and middleware variables are reachable without an import.
      *
-     * Server-only, and never serialized: React renders a server component and puts
-     * its *output* on the wire, not its props. It is also deliberately a
-     * non-enumerable property, which has three consequences worth knowing:
+     * Server-only, non-enumerable (a `{...props}` spread and `JSON.stringify` both skip it) and never
+     * serialized. Passing it to a `'use client'` component fails the render, because it wraps the live
+     * request — read what you need here and pass plain values down.
      *
-     * - It **cannot be handed to a `'use client'` component** — it wraps the live
-     *   request and response, which do not exist in the browser. Passing it
-     *   explicitly (`<Counter ctx={ctx} />`) fails the render with React's *"Only
-     *   plain objects … can be passed to Client Components"*. Read what you need on
-     *   the server and pass plain values down.
-     * - Spreading the page's props instead (`<Counter {...props} />`) drops `ctx`
-     *   silently rather than failing, since the spread copies enumerables only.
-     *   (That spread still fails, mind — on `url`, which is enumerable and just as
-     *   unserializable. Pass the values you need.)
-     * - `Object.keys(props)`, `JSON.stringify(props)` and friends don't see it.
+     * Non-enumerable is the one place this API breaks a JavaScript expectation, and it is unavoidable: an
+     * enumerable `ctx` would put `ctx.hono.env` — every binding and secret — into React's dev-only
+     * serialization of a server component's props, which walks own enumerable properties. So `<Child
+     * {...props} />` hands a **server** child `ctx: undefined` with no error, while the type says otherwise.
+     * Nested server components are meant to call `getRequestContext()` for the same object rather than
+     * receive it, which is also the fix if a spread has already cost you an afternoon.
      *
-     * Reading it on a `render: 'static'` route throws: a prerendered page has no
-     * per-request context at build time. Mark the route `render: 'dynamic'` (or use
-     * the `url` / `params` props, which are available either way — with the
-     * build-time caveats noted on `url`).
+     * Reading it on a `render: 'static'` route throws: a prerendered page has no per-request context.
+     * Mark the route `render: 'dynamic'`, or use the `url` / `params` props.
      *
      * @example
      * ```tsx
@@ -101,34 +91,44 @@ export interface PageProps<Path extends string = string, E extends Env = Env> {
      * }
      * ```
      */
-    ctx: Ctx<E>;
+    ctx: RequestContext<E>;
 }
 /**
- * A page: a React **server component** that renders the entire document
- * (`<html>…</html>`), usually via a shared layout. It may be `async` and await
- * data directly.
+ * A page: a React **server component** rendering the entire document (`<html>…</html>`), usually via
+ * a shared layout. It may be `async` and await data directly.
  *
- * Each page module must default-export exactly one of these. Interactive parts
- * belong in `'use client'` components the page imports — only those ship JS.
+ * Each page module default-exports exactly one. Interactive parts belong in `'use client'` components
+ * the page imports — only those ship JS.
  *
  * @typeParam P - The component's props; for a page these are {@link PageProps}.
+ *
+ * @see {@link https://react.dev/reference/rsc/server-components | React — Server Components}
+ * @see {@link https://www.rshono.com/docs/pages | Docs — pages}
  */
 export type PageComponent<P = any> = (props: P) => ReactNode | Promise<ReactNode>;
 /**
- * The shape an `{ type: 'endpoint' }` route's server module must have: a single
- * named `handler` export. The module only ever loads on the server, so it is
- * safe to import a database client or read secrets from it.
+ * The shape an `{ type: 'endpoint' }` route's server module must have: a single named `handler`
+ * export. It only ever loads on the server, so importing a database client or reading secrets from it
+ * is safe.
  *
  * @example
  * ```ts
  * // src/health.ts
- * import type { Handler } from '@rshono/core';
+ * import type { Handler } from 'hono';
  *
  * export const handler: Handler = (c) => c.json({ ok: true });
  * ```
+ *
+ * @see {@link https://www.rshono.com/docs/routing#endpoint-routes | Docs — endpoint routes}
  */
 export interface EndpointServerModule {
-    /** A Hono {@link Handler} handling every request matched by the route. */
+    /**
+     * A Hono {@link Handler} for every request the route matches. It is passed Hono's `Context`, so the
+     * request, the response builders (`c.json`, `c.text`, `c.body`) and middleware variables are all
+     * reached through it.
+     *
+     * @see {@link https://hono.dev/docs/api/context | Hono — Context}
+     */
     handler: Handler;
 }
 /**
@@ -143,19 +143,27 @@ export interface EndpointServerModule {
 export interface PageRoute {
     /** Discriminates a page from an endpoint; optional because `'page'` is the default. */
     type?: 'page';
-    /** Hono-style path pattern, e.g. `/`, `/profile/:id`, `/files/*`. */
+    /**
+     * Hono-style path pattern, e.g. `/`, `/profile/:id`, `/files/*`. Routes are matched in
+     * declaration order.
+     *
+     * @see {@link https://hono.dev/docs/api/routing | Hono — routing}
+     */
     path: string;
     /**
-     * Dynamic import of the page module, whose default export is the
-     * {@link PageComponent}.
+     * Dynamic import of the page module, whose default export is the {@link PageComponent}.
+     *
+     * Write it inline as `() => import('…')`: the framework detects that exact form and injects the
+     * `'use server-entry'` directive that attaches the page's client JS and CSS. Wire the component up
+     * any other way — a variable, a barrel re-export, a computed specifier — and you have to put
+     * `'use server-entry'` on the page module's first line yourself.
      *
-     * Write it inline as shown — the framework detects that exact
-     * `() => import('…')` form and injects Rspack's `'use server-entry'`
-     * directive into the module for you (that directive is what attaches the
-     * page's client JS/CSS, giving per-page code splitting). If you wire the
-     * component up any other way — a variable, a barrel re-export, a computed
-     * specifier — add `'use server-entry'` as the first line of the page module
-     * yourself; the framework throws a descriptive error when neither happened.
+     * @example
+     * ```ts
+     * component: () => import('./components/profile')
+     * ```
+     *
+     * @see {@link https://www.rshono.com/docs/pages#the-use-server-entry-directive | Docs — the `'use server-entry'` directive}
      */
     component: () => Promise<{
         default: PageComponent;
@@ -163,13 +171,17 @@ export interface PageRoute {
     /** `'static'` prerenders the route at build time; `'dynamic'` (the default) renders per request. */
     render?: 'static' | 'dynamic';
     /**
-     * For a `render: 'static'` route with params: the param sets to prerender, one
-     * HTML file each. Runs at build time only, on the server, so it may hit a
-     * database or read the filesystem.
+     * For a `render: 'static'` route with params: the param sets to prerender, one page each. Runs at
+     * build time on the server, so it may hit a database or read the filesystem.
+     *
+     * A parameterised static route without this falls back to rendering per request, with a build
+     * warning. Wildcard (`*`), optional and regex params cannot be prerendered.
      *
-     * A parameterised static route without `staticPaths` falls back to rendering
-     * per request (with a build warning). Wildcard (`*`), optional and regex
-     * params can't be prerendered.
+     * **Every value has to be one portable file name**, since that is what a prerendered page is stored as,
+     * and the build fails naming the value rather than writing a page nothing will serve. So: no
+     * `\ / : * ? " < > |` or control characters, no trailing `.` or space, and not a reserved Windows device
+     * name (`CON`, `NUL`, `COM1`, …) — the last two enforced everywhere, so a build that works on macOS is
+     * not one that fails in CI on Windows.
      *
      * @example
      * ```ts
@@ -180,6 +192,8 @@ export interface PageRoute {
      *   staticPaths: async () => (await db.docs.all()).map((d) => ({ slug: d.slug })),
      * }
      * ```
+     *
+     * @see {@link https://www.rshono.com/docs/routing#static-rendering | Docs — static rendering}
      */
     staticPaths?: () => Array<Record<string, string>> | Promise<Array<Record<string, string>>>;
 }
@@ -192,37 +206,55 @@ export interface PageRoute {
  * ```ts
  * { type: 'endpoint', path: '/api/health', server: () => import('./health') }
  * ```
+ *
+ * @see {@link https://www.rshono.com/docs/routing#endpoint-routes | Docs — endpoint routes}
  */
 export interface EndpointRoute {
     /** Marks this route as an endpoint rather than a page. Required. */
     type: 'endpoint';
-    /** Hono-style path pattern, e.g. `/api/health`, `/api/users/:id`. */
+    /**
+     * Hono-style path pattern, e.g. `/api/health`, `/api/users/:id`.
+     *
+     * @see {@link https://hono.dev/docs/api/routing | Hono — routing}
+     */
     path: string;
-    /** HTTP method to match. Defaults to `'all'` — every method. */
-    method?: HTTPMethod;
+    /**
+     * HTTP method to match, or a list of them. Defaults to `'all'` — every method.
+     *
+     * There is no `'head'`: Hono dispatches a `HEAD` as a `GET` and strips the body off the response, so a
+     * `HEAD` is already answered by the `'get'` handler (and by `'all'`), and a route registered for `HEAD`
+     * alone would never be reached.
+     *
+     * A list is how a two-method endpoint says so; `'all'` inside one is refused, since it is either the
+     * whole thing or a mistake. A method the route does not name gets Hono's 404 rather than the handler.
+     *
+     * @example
+     * ```ts
+     * { type: 'endpoint', path: '/api/session', method: ['get', 'delete'], server: () => import('./session') }
+     * ```
+     */
+    method?: HTTPMethod | readonly HTTPMethod[];
     /** Dynamic import of the {@link EndpointServerModule} exporting `handler`. */
     server: () => Promise<EndpointServerModule>;
 }
-/** HTTP methods an {@link EndpointRoute} can match. `'all'` matches every method. */
-export type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options' | 'all';
+/**
+ * HTTP methods an {@link EndpointRoute} can match. `'all'` matches every method.
+ *
+ * No `'head'`, deliberately — see {@link EndpointRoute.method}. A `HEAD` reaches the `'get'` handler.
+ */
+export type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'all';
 /** Any entry in the `routes` array: a {@link PageRoute} or an {@link EndpointRoute}. */
 export type Route = PageRoute | EndpointRoute;
 /**
- * Type guard narrowing a {@link Route} to a {@link PageRoute}. Because `type` is
- * optional on page routes, anything not explicitly `'endpoint'` is a page.
+ * Narrows a {@link Route} to a {@link PageRoute} — `type` is optional on page routes, so anything not
+ * explicitly `'endpoint'` is one.
  *
- * @example
- * ```ts
- * for (const route of routes) {
- *   if (isPageRoute(route)) console.log(route.render ?? 'dynamic');
- * }
- * ```
+ * @internal
  */
 export declare function isPageRoute(route: Route): route is PageRoute;
 /**
- * A page the framework falls back to rather than routes to — `notFound` and
- * `error` in {@link RouteConfig}. Same contract as a {@link PageRoute}
- * `component`, without a path of its own.
+ * A page the framework falls back to rather than routes to — `notFound` and `error` in
+ * {@link RouteConfig}. Same contract as a {@link PageRoute} `component`, without a path of its own.
  */
 export interface FallbackPage {
     /** Dynamic import of the page module; its default export is the {@link PageComponent}. */
@@ -231,19 +263,24 @@ export interface FallbackPage {
     }>;
 }
 /**
- * The error detail handed to the `error` page. Redacted in production: the
- * message is a generic `'Internal Server Error'` and there is no `stack`. In dev
- * you get the real message plus the stack.
+ * The error detail handed to the `error` page. Redacted in production — a generic
+ * `'Internal Server Error'` and no `stack`; in dev, the real message and stack.
  */
-export interface ErrorInfo {
+export interface ErrorPageInfo {
     /** The thrown error's message in dev; `'Internal Server Error'` in production. */
     message: string;
-    /** The stack trace. Present in dev only. */
+    /**
+     * The stack trace — **dev only**, and `undefined` in every build. Optional for that reason rather than
+     * because some errors lack one, so a page that renders it should guard on it, not on a mode flag.
+     */
     stack?: string;
 }
 /**
- * Props for the `error` page declared in {@link RouteConfig.error} — the usual
- * {@link PageProps} plus the redaction-aware {@link ErrorInfo}.
+ * Props for the `error` page declared in {@link RouteConfig.error} — the usual {@link PageProps} plus
+ * the redaction-aware {@link ErrorPageInfo}.
+ *
+ * In a build `error.message` is the generic `'Internal Server Error'` and `error.stack` is `undefined`, so
+ * the page below guards on the stack rather than on a mode flag — there is no mode flag to guard on.
  *
  * @typeParam E - The app's Hono {@link Env}, forwarded to {@link PageProps.ctx}.
  *
@@ -252,12 +289,21 @@ export interface ErrorInfo {
  * import type { ErrorPageProps } from '@rshono/core';
  *
  * export default function ServerError({ error }: ErrorPageProps) {
- *   return <html><body><h1>Something went wrong</h1><p>{error.message}</p></body></html>;
+ *   return (
+ *     <html>
+ *       <body>
+ *         <h1>Something went wrong</h1>
+ *         <p>{error.message}</p>
+ *         {error.stack && <pre>{error.stack}</pre>}
+ *       </body>
+ *     </html>
+ *   );
  * }
  * ```
  */
 export type ErrorPageProps<E extends Env = Env> = PageProps<string, E> & {
-    error: ErrorInfo;
+    /** The error that failed the request, redacted in production — see {@link ErrorPageInfo}. */
+    error: ErrorPageInfo;
 };
 /**
  * The object form accepted by {@link defineRoutes}: the route table plus the two
@@ -265,42 +311,89 @@ export type ErrorPageProps<E extends Env = Env> = PageProps<string, E> & {
  *
  * @typeParam TRoutes - Inferred tuple of route literals, which is what makes the
  *   per-route `path` → props check possible.
+ *
+ * @see {@link https://www.rshono.com/docs/routing#notfound-and-error | Docs — notFound and error pages}
  */
 export interface RouteConfig<TRoutes extends readonly Route[] = readonly Route[]> {
     /** Every page and endpoint in the app, matched in order. */
     routes: TRoutes;
     /** Page rendered with a 404 status for unmatched paths and for `notFound()` calls. */
     notFound?: FallbackPage;
-    /** Page rendered with a 500 status when a request throws. Receives {@link ErrorPageProps}. */
+    /**
+     * Page rendered with a 500 status when a request throws — a page component, a page module that will not
+     * load, an endpoint, a server action, or middleware. Receives {@link ErrorPageProps}.
+     *
+     * It is a *fresh* render, with its own flight payload, so it hydrates and behaves like any other page.
+     * An app that declares none gets the framework's plain 500 document instead. If the `error` page itself
+     * throws, that is reported too and the framework's document answers.
+     */
     error?: FallbackPage;
 }
+/**
+ * The same check for `staticPaths`, whose param sets have to fill the route's own path: a key that does not
+ * is otherwise a build-time throw from `interpolatePath` rather than a type error.
+ *
+ * Keys only, not full assignability, because the declared field type is `Record<string, string>` and a
+ * `staticPaths` annotated as returning exactly that has to stay accepted — an index signature carries no
+ * key to check, so it passes. Skipped where the path has no params, because `staticPaths` is not called for
+ * such a route at all and an error there would be about the wrong thing.
+ */
+type ValidateStaticPaths<R, P extends string> = ParamKeys<P> extends never ? R : R extends {
+    staticPaths: () => infer Sets;
+} ? Awaited<Sets> extends ReadonlyArray<infer Set> ? [keyof PathParams<P>] extends [keyof Set] ? R : R & {
+    staticPaths: `every param set staticPaths returns needs the params of '${P}'`;
+} : R : R;
 type ValidateRoute<R> = R extends {
     path: infer P extends string;
     component: () => Promise<{
         default: PageComponent<infer CP>;
     }>;
-} ? [PageProps<P, any>] extends [CP] ? R : R & {
+} ? [
+    PageProps<P, any>
+] extends [CP] ? ValidateStaticPaths<R, P> : R & {
     component: `component props are not satisfied by PageProps<'${P}'>`;
 } : R;
 type ValidateRoutes<TRoutes extends readonly Route[]> = {
     [K in keyof TRoutes]: ValidateRoute<TRoutes[K]>;
 };
 /**
- * Declares the app's route table. Default-export the result as `routes` from
- * `src/routes.ts` — the one file rshono requires.
+ * Refuses a key that is not a {@link RouteConfig} field — a typo'd `notfound` is otherwise a fallback page
+ * that never renders, and nothing at runtime looks for one.
  *
- * `routes.ts` only ever runs on the server, so importing server-only modules
- * from it (e.g. inside `staticPaths`) is safe.
+ * Excess-property checking did this while the object form was an overload of its own with a concrete
+ * parameter type. It cannot once the parameter is generic and inferred from the argument, because the
+ * inferred type *has* the extra key. The message here is the better one anyway: it lands on the field.
+ */
+type ValidateConfigKeys<T> = Exclude<keyof T, keyof RouteConfig> extends never ? T : T & Record<Exclude<keyof T, keyof RouteConfig>, 'not a defineRoutes field — the fields are routes, notFound and error'>;
+/** The check for whichever of the two accepted shapes was passed. */
+type ValidateInput<T> = T extends readonly Route[] ? ValidateRoutes<T> : T extends {
+    routes: infer R extends readonly Route[];
+} ? ValidateConfigKeys<T> & {
+    routes: ValidateRoutes<R>;
+} : T;
+/** The route tuple inside either shape, so the return type carries the literals through both. */
+type RoutesOf<T> = T extends readonly Route[] ? T : T extends {
+    routes: infer R extends readonly Route[];
+} ? R : readonly Route[];
+/**
+ * Declares the app's route table. Export the result as `routes` from `src/routes.ts` — the one file
+ * rshono requires. It only ever runs on the server, so importing server-only modules from it (inside
+ * `staticPaths`, say) is safe.
+ *
+ * Takes a {@link RouteConfig} — the `routes` array plus the optional `notFound` and `error` pages — or a
+ * bare {@link Route} array as shorthand for an app with neither.
  *
- * Beyond typing the config, this cross-checks every page against its own path:
- * if a component's props aren't satisfied by `PageProps<'<its path>'>`, the
- * `component` field errors with `component props are not satisfied by
- * PageProps<'/…'>`. Fix it by matching the page's `PageProps<Path>` type
- * argument to the path it's mounted at.
+ * Beyond typing the config, every page is cross-checked against its own path: props not satisfied by
+ * `PageProps<'<its path>'>` make the `component` field a type error, and a `staticPaths` whose param sets do
+ * not fill the path makes that field one.
  *
- * @param config - A {@link RouteConfig}, or a bare {@link Route} array as
- *   shorthand when there are no `notFound` / `error` pages.
- * @returns The config, unchanged and fully typed.
+ * **One signature over both shapes, deliberately.** The array form used to be a second overload, which meant
+ * a mistake inside a bare array was reported as an overload-resolution failure whose *first* line was the
+ * object form's complaint — "Property 'routes' is missing" — pointing at a change the author should not make.
+ * The real message was on line 8. A single signature reports the argument once, at the field that is wrong.
+ *
+ * @param input - A {@link RouteConfig}, or the bare `routes` array.
+ * @returns The config, unchanged and fully typed; an array is wrapped as `{ routes }`.
  *
  * @example
  * ```ts
@@ -324,14 +417,13 @@ type ValidateRoutes<TRoutes extends readonly Route[]> = {
  * });
  * ```
  *
- * @example Array shorthand
+ * @example
  * ```ts
+ * // The shorthand, for an app with no notFound or error page.
  * export const routes = defineRoutes([{ path: '/', component: () => import('./components/home') }]);
  * ```
+ *
+ * @see {@link https://www.rshono.com/docs/routing | Docs — routing}
  */
-export declare function defineRoutes<const TRoutes extends readonly Route[]>(config: RouteConfig<TRoutes> & {
-    routes: ValidateRoutes<TRoutes>;
-}): RouteConfig<TRoutes>;
-export declare function defineRoutes<const TRoutes extends readonly Route[]>(routes: TRoutes & ValidateRoutes<TRoutes>): RouteConfig<TRoutes>;
+export declare function defineRoutes<const T extends readonly Route[] | RouteConfig<readonly Route[]>>(input: T & ValidateInput<T>): RouteConfig<RoutesOf<T>>;
 export {};
-//# sourceMappingURL=router.d.ts.map

package/dist/router.js

@@ -1,13 +1,8 @@
 /**
- * Type guard narrowing a {@link Route} to a {@link PageRoute}. Because `type` is
- * optional on page routes, anything not explicitly `'endpoint'` is a page.
+ * Narrows a {@link Route} to a {@link PageRoute} — `type` is optional on page routes, so anything not
+ * explicitly `'endpoint'` is one.
  *
- * @example
- * ```ts
- * for (const route of routes) {
- *   if (isPageRoute(route)) console.log(route.render ?? 'dynamic');
- * }
- * ```
+ * @internal
  */
 export function isPageRoute(route) {
     return route.type !== 'endpoint';

package/dist/router.js.map

@@ -1 +1 @@
-{"version":3,"file":"router.js","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AA0NA;;;;;;;;;;GAUG;AACH,MAAM,UAAU,WAAW,CAAC,KAAY;IACtC,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC;AACnC,CAAC;AAwHD,MAAM,UAAU,YAAY,CAAC,KAAqC;IAChE,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAE,KAAqB,CAAC;AAC3E,CAAC","sourcesContent":["import type { Env, Handler } from 'hono';\nimport type { ParamKeys, ParamKeyToRecord } from 'hono/types';\nimport type { ReactNode } from 'react';\n// Type-only, so this stays a build-time module: the import is erased and none of `context.ts`'s\n// runtime machinery (AsyncLocalStorage, hono/cookie) is pulled in by importing `@rshono/core`.\nimport type { Ctx } from './runtime/context.js';\n\ntype Simplify<T> = { [K in keyof T]: T[K] } & {};\ntype UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;\n\n/**\n * The `params` record implied by a route path pattern — one required `string` key\n * per `:param` segment, `Record<string, never>` for a path with no params.\n *\n * Paths use Hono's syntax, so `:id`, `:id{[0-9]+}` and `*` all work. You rarely\n * name this type directly; {@link PageProps} applies it for you.\n *\n * @typeParam P - The literal route path, e.g. `'/users/:id/posts/:postId'`.\n *\n * @example\n * ```ts\n * type P = PathParams<'/users/:id/posts/:postId'>; // { id: string; postId: string }\n * ```\n */\nexport type PathParams<P extends string> =\n  ParamKeys<P> extends never ? Record<string, never> : Simplify<UnionToIntersection<ParamKeyToRecord<ParamKeys<P>>>>;\n\n/**\n * Props every page component receives. Pass the route's path as the type\n * argument to get `params` typed key-by-key; without it `params` falls back to\n * an open `Record<string, string>`.\n *\n * `defineRoutes` checks each page's props against `PageProps<path>` at compile\n * time, so a mismatched path literal is a type error at the route definition.\n *\n * The location props (`url` and `params`) mirror what a `'use client'` component\n * gets from `useNavigation()` — same names, same types — so moving a read across\n * the server/client line is a copy-paste.\n *\n * @typeParam Path - The literal path this page is mounted at, e.g. `'/profile/:id'`.\n * @typeParam E - The app's Hono {@link Env}, to type {@link Ctx.var} and\n *   {@link Ctx.env} on {@link PageProps.ctx}.\n *\n * @example\n * ```tsx\n * import type { PageProps } from '@rshono/core';\n *\n * export default async function Profile({ params, url }: PageProps<'/profile/:id'>) {\n *   const user = await db.getUser(params.id); // params.id is string\n *   const tab = url.searchParams.get('tab') ?? 'overview';\n *   return <Layout>{user.name} — {tab}</Layout>;\n * }\n * ```\n */\nexport interface PageProps<Path extends string = string, E extends Env = Env> {\n  /**\n   * The absolute browser-facing request {@link URL}, proxy-header aware\n   * (`X-Forwarded-Host` / `-Proto`). Read `url.pathname`, `url.searchParams` and\n   * the rest off it.\n   *\n   * A fresh instance per request that nothing else holds, so mutating it is local\n   * to the page — but note it is *not* serializable, so a `'use client'` component\n   * has to be handed `url.href` rather than `url`.\n   *\n   * On a prerendered page it is the build-time URL: a `render: 'static'` route is\n   * rendered once, against `siteUrl` and with no query string, and that one file\n   * then answers every request whatever its own query. So `url.searchParams` is\n   * always empty there — read the query from `useNavigation().url` in a\n   * `'use client'` component instead, or mark the route `render: 'dynamic'`.\n   */\n  url: URL;\n  /** Matched route params for this request, e.g. `{ id: '42' }` for `/profile/:id`. */\n  params: string extends Path ? Record<string, string> : PathParams<Path>;\n  /**\n   * The request context — the very object `getContext()` returns, handed to the\n   * page so cookies, headers, env and middleware variables are reachable without\n   * an import.\n   *\n   * Server-only, and never serialized: React renders a server component and puts\n   * its *output* on the wire, not its props. It is also deliberately a\n   * non-enumerable property, which has three consequences worth knowing:\n   *\n   * - It **cannot be handed to a `'use client'` component** — it wraps the live\n   *   request and response, which do not exist in the browser. Passing it\n   *   explicitly (`<Counter ctx={ctx} />`) fails the render with React's *\"Only\n   *   plain objects … can be passed to Client Components\"*. Read what you need on\n   *   the server and pass plain values down.\n   * - Spreading the page's props instead (`<Counter {...props} />`) drops `ctx`\n   *   silently rather than failing, since the spread copies enumerables only.\n   *   (That spread still fails, mind — on `url`, which is enumerable and just as\n   *   unserializable. Pass the values you need.)\n   * - `Object.keys(props)`, `JSON.stringify(props)` and friends don't see it.\n   *\n   * Reading it on a `render: 'static'` route throws: a prerendered page has no\n   * per-request context at build time. Mark the route `render: 'dynamic'` (or use\n   * the `url` / `params` props, which are available either way — with the\n   * build-time caveats noted on `url`).\n   *\n   * @example\n   * ```tsx\n   * export default function Dashboard({ ctx }: PageProps) {\n   *   const session = ctx.cookies.get('session');\n   *   if (!session) redirect('/login');\n   *   return <Layout>Signed in as {session}</Layout>;\n   * }\n   * ```\n   */\n  ctx: Ctx<E>;\n}\n\n/**\n * A page: a React **server component** that renders the entire document\n * (`<html>…</html>`), usually via a shared layout. It may be `async` and await\n * data directly.\n *\n * Each page module must default-export exactly one of these. Interactive parts\n * belong in `'use client'` components the page imports — only those ship JS.\n *\n * @typeParam P - The component's props; for a page these are {@link PageProps}.\n */\nexport type PageComponent<P = any> = (props: P) => ReactNode | Promise<ReactNode>;\n\n/**\n * The shape an `{ type: 'endpoint' }` route's server module must have: a single\n * named `handler` export. The module only ever loads on the server, so it is\n * safe to import a database client or read secrets from it.\n *\n * @example\n * ```ts\n * // src/health.ts\n * import type { Handler } from '@rshono/core';\n *\n * export const handler: Handler = (c) => c.json({ ok: true });\n * ```\n */\nexport interface EndpointServerModule {\n  /** A Hono {@link Handler} handling every request matched by the route. */\n  handler: Handler;\n}\n\n/**\n * A page route — a path rendered by a server component. This is the default\n * route kind, so `type` can be omitted.\n *\n * @example\n * ```ts\n * { path: '/profile/:id', component: () => import('./components/profile') }\n * ```\n */\nexport interface PageRoute {\n  /** Discriminates a page from an endpoint; optional because `'page'` is the default. */\n  type?: 'page';\n  /** Hono-style path pattern, e.g. `/`, `/profile/:id`, `/files/*`. */\n  path: string;\n  /**\n   * Dynamic import of the page module, whose default export is the\n   * {@link PageComponent}.\n   *\n   * Write it inline as shown — the framework detects that exact\n   * `() => import('…')` form and injects Rspack's `'use server-entry'`\n   * directive into the module for you (that directive is what attaches the\n   * page's client JS/CSS, giving per-page code splitting). If you wire the\n   * component up any other way — a variable, a barrel re-export, a computed\n   * specifier — add `'use server-entry'` as the first line of the page module\n   * yourself; the framework throws a descriptive error when neither happened.\n   */\n  component: () => Promise<{ default: PageComponent }>;\n  /** `'static'` prerenders the route at build time; `'dynamic'` (the default) renders per request. */\n  render?: 'static' | 'dynamic';\n  /**\n   * For a `render: 'static'` route with params: the param sets to prerender, one\n   * HTML file each. Runs at build time only, on the server, so it may hit a\n   * database or read the filesystem.\n   *\n   * A parameterised static route without `staticPaths` falls back to rendering\n   * per request (with a build warning). Wildcard (`*`), optional and regex\n   * params can't be prerendered.\n   *\n   * @example\n   * ```ts\n   * {\n   *   path: '/docs/:slug',\n   *   render: 'static',\n   *   component: () => import('./components/documentation'),\n   *   staticPaths: async () => (await db.docs.all()).map((d) => ({ slug: d.slug })),\n   * }\n   * ```\n   */\n  staticPaths?: () => Array<Record<string, string>> | Promise<Array<Record<string, string>>>;\n}\n\n/**\n * An endpoint route — a path served by a raw Hono handler instead of a React\n * component. Use it for JSON APIs, webhooks, redirects, feeds, or anything that\n * isn't an HTML page.\n *\n * @example\n * ```ts\n * { type: 'endpoint', path: '/api/health', server: () => import('./health') }\n * ```\n */\nexport interface EndpointRoute {\n  /** Marks this route as an endpoint rather than a page. Required. */\n  type: 'endpoint';\n  /** Hono-style path pattern, e.g. `/api/health`, `/api/users/:id`. */\n  path: string;\n  /** HTTP method to match. Defaults to `'all'` — every method. */\n  method?: HTTPMethod;\n  /** Dynamic import of the {@link EndpointServerModule} exporting `handler`. */\n  server: () => Promise<EndpointServerModule>;\n}\n\n/** HTTP methods an {@link EndpointRoute} can match. `'all'` matches every method. */\nexport type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options' | 'all';\n\n/** Any entry in the `routes` array: a {@link PageRoute} or an {@link EndpointRoute}. */\nexport type Route = PageRoute | EndpointRoute;\n\n/**\n * Type guard narrowing a {@link Route} to a {@link PageRoute}. Because `type` is\n * optional on page routes, anything not explicitly `'endpoint'` is a page.\n *\n * @example\n * ```ts\n * for (const route of routes) {\n *   if (isPageRoute(route)) console.log(route.render ?? 'dynamic');\n * }\n * ```\n */\nexport function isPageRoute(route: Route): route is PageRoute {\n  return route.type !== 'endpoint';\n}\n\n/**\n * A page the framework falls back to rather than routes to — `notFound` and\n * `error` in {@link RouteConfig}. Same contract as a {@link PageRoute}\n * `component`, without a path of its own.\n */\nexport interface FallbackPage {\n  /** Dynamic import of the page module; its default export is the {@link PageComponent}. */\n  component: () => Promise<{ default: PageComponent }>;\n}\n\n/**\n * The error detail handed to the `error` page. Redacted in production: the\n * message is a generic `'Internal Server Error'` and there is no `stack`. In dev\n * you get the real message plus the stack.\n */\nexport interface ErrorInfo {\n  /** The thrown error's message in dev; `'Internal Server Error'` in production. */\n  message: string;\n  /** The stack trace. Present in dev only. */\n  stack?: string;\n}\n\n/**\n * Props for the `error` page declared in {@link RouteConfig.error} — the usual\n * {@link PageProps} plus the redaction-aware {@link ErrorInfo}.\n *\n * @typeParam E - The app's Hono {@link Env}, forwarded to {@link PageProps.ctx}.\n *\n * @example\n * ```tsx\n * import type { ErrorPageProps } from '@rshono/core';\n *\n * export default function ServerError({ error }: ErrorPageProps) {\n *   return <html><body><h1>Something went wrong</h1><p>{error.message}</p></body></html>;\n * }\n * ```\n */\nexport type ErrorPageProps<E extends Env = Env> = PageProps<string, E> & { error: ErrorInfo };\n\n/**\n * The object form accepted by {@link defineRoutes}: the route table plus the two\n * optional framework-owned pages.\n *\n * @typeParam TRoutes - Inferred tuple of route literals, which is what makes the\n *   per-route `path` → props check possible.\n */\nexport interface RouteConfig<TRoutes extends readonly Route[] = readonly Route[]> {\n  /** Every page and endpoint in the app, matched in order. */\n  routes: TRoutes;\n  /** Page rendered with a 404 status for unmatched paths and for `notFound()` calls. */\n  notFound?: FallbackPage;\n  /** Page rendered with a 500 status when a request throws. Receives {@link ErrorPageProps}. */\n  error?: FallbackPage;\n}\n\n// `PageProps<P, any>`, not `PageProps<P>`: this check is about the *path* matching the page's\n// `params`, and pinning the Env to the default would additionally demand that a page declaring its\n// own (`PageProps<'/x', MyEnv>`, to type `ctx.var`) accept a `Ctx<Env>` — which it doesn't, so every\n// such page would fail its own route check. `any` makes `ctx` compatible either way.\ntype ValidateRoute<R> = R extends {\n  path: infer P extends string;\n  component: () => Promise<{ default: PageComponent<infer CP> }>;\n}\n  ? [PageProps<P, any>] extends [CP]\n    ? R\n    : R & { component: `component props are not satisfied by PageProps<'${P}'>` }\n  : R;\n\ntype ValidateRoutes<TRoutes extends readonly Route[]> = { [K in keyof TRoutes]: ValidateRoute<TRoutes[K]> };\n\n/**\n * Declares the app's route table. Default-export the result as `routes` from\n * `src/routes.ts` — the one file rshono requires.\n *\n * `routes.ts` only ever runs on the server, so importing server-only modules\n * from it (e.g. inside `staticPaths`) is safe.\n *\n * Beyond typing the config, this cross-checks every page against its own path:\n * if a component's props aren't satisfied by `PageProps<'<its path>'>`, the\n * `component` field errors with `component props are not satisfied by\n * PageProps<'/…'>`. Fix it by matching the page's `PageProps<Path>` type\n * argument to the path it's mounted at.\n *\n * @param config - A {@link RouteConfig}, or a bare {@link Route} array as\n *   shorthand when there are no `notFound` / `error` pages.\n * @returns The config, unchanged and fully typed.\n *\n * @example\n * ```ts\n * // src/routes.ts\n * import { defineRoutes } from '@rshono/core';\n *\n * export const routes = defineRoutes({\n *   routes: [\n *     { path: '/', component: () => import('./components/home') },\n *     { path: '/profile/:id', component: () => import('./components/profile') },\n *     {\n *       path: '/docs/:slug',\n *       render: 'static',\n *       component: () => import('./components/documentation'),\n *       staticPaths: async () => [{ slug: 'getting-started' }, { slug: 'deployment' }],\n *     },\n *     { type: 'endpoint', path: '/api/health', server: () => import('./health') },\n *   ],\n *   notFound: { component: () => import('./components/404') },\n *   error: { component: () => import('./components/500') },\n * });\n * ```\n *\n * @example Array shorthand\n * ```ts\n * export const routes = defineRoutes([{ path: '/', component: () => import('./components/home') }]);\n * ```\n */\nexport function defineRoutes<const TRoutes extends readonly Route[]>(\n  config: RouteConfig<TRoutes> & { routes: ValidateRoutes<TRoutes> },\n): RouteConfig<TRoutes>;\nexport function defineRoutes<const TRoutes extends readonly Route[]>(routes: TRoutes & ValidateRoutes<TRoutes>): RouteConfig<TRoutes>;\nexport function defineRoutes(input: readonly Route[] | RouteConfig): RouteConfig {\n  return Array.isArray(input) ? { routes: input } : (input as RouteConfig);\n}\n"]}
+{"version":3,"file":"router.js","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AAkQA;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,KAAY;IACtC,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC;AACnC,CAAC;AA6LD,MAAM,UAAU,YAAY,CAAC,KAAqC;IAChE,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAE,KAAqB,CAAC;AAC3E,CAAC","sourcesContent":["import type { Env, Handler } from 'hono';\nimport type { ParamKeys, ParamKeyToRecord } from 'hono/types';\nimport type { ReactNode } from 'react';\n// Type-only, so importing `@rshono/core` pulls in none of `context.ts`'s runtime machinery.\nimport type { RequestContext } from './runtime/context.js';\n\ntype Simplify<T> = { [K in keyof T]: T[K] } & {};\ntype UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;\n\n/**\n * The `params` record implied by a route path pattern — one required `string` key per `:param`\n * segment, `Record<string, never>` for a path with none. Paths use Hono's syntax, so `:id`,\n * `:id{[0-9]+}` and `*` all work.\n *\n * You rarely name this directly; {@link PageProps} applies it for you.\n *\n * @typeParam P - The literal route path, e.g. `'/users/:id/posts/:postId'`.\n *\n * @example\n * ```ts\n * type P = PathParams<'/users/:id/posts/:postId'>; // { id: string; postId: string }\n * ```\n *\n * @see {@link https://hono.dev/docs/api/routing#path-parameter | Hono — path parameters}\n */\nexport type PathParams<P extends string> =\n  ParamKeys<P> extends never ? Record<string, never> : Simplify<UnionToIntersection<ParamKeyToRecord<ParamKeys<P>>>>;\n\n/**\n * Props every page component receives. Pass the route's path as the type argument to get `params`\n * typed key-by-key; without it `params` falls back to an open `Record<string, string>`.\n *\n * `defineRoutes` checks each page's props against `PageProps<path>`, so a mismatched path literal is\n * a type error at the route definition. `url` and `params` mirror what `useNavigation()` gives a\n * `'use client'` component, so a read moves across the server/client line unchanged.\n *\n * @typeParam Path - The literal path this page is mounted at, e.g. `'/profile/:id'`.\n * @typeParam E - The app's Hono {@link Env}, to type {@link RequestContext.var} and\n *   {@link RequestContext.env} on {@link PageProps.ctx}.\n *\n * @example\n * ```tsx\n * import type { PageProps } from '@rshono/core';\n *\n * export default async function Profile({ params, url }: PageProps<'/profile/:id'>) {\n *   const user = await db.getUser(params.id); // params.id is string\n *   const tab = url.searchParams.get('tab') ?? 'overview';\n *   return <Layout>{user.name} — {tab}</Layout>;\n * }\n * ```\n *\n * @see {@link https://www.rshono.com/docs/pages#page-props | Docs — page props}\n */\nexport interface PageProps<Path extends string = string, E extends Env = Env> {\n  /**\n   * The absolute browser-facing request {@link URL}, proxy-header aware (`X-Forwarded-Host` /\n   * `-Proto`). A fresh instance per request, so mutating it is local to the page; it is not\n   * serializable, so hand a `'use client'` component `url.href` rather than `url`.\n   *\n   * On a `render: 'static'` route this is the build-time URL — rendered once against `siteUrl`, so the\n   * origin is `siteUrl`'s and `url.searchParams` is always empty, on first paint and after a soft\n   * navigation alike. **`useNavigation().url` is the same frozen URL, not a way around it**: the payload\n   * carries one `href` and both readings come from it. Mark the route `render: 'dynamic'` if the page\n   * depends on the query; a `'use client'` component that only wants it after hydration can read\n   * `location.search` in an effect.\n   */\n  url: URL;\n  /** Matched route params for this request, e.g. `{ id: '42' }` for `/profile/:id`. */\n  params: string extends Path ? Record<string, string> : PathParams<Path>;\n  /**\n   * The request context — the object `getRequestContext()` returns, handed to the page so cookies,\n   * headers, env and middleware variables are reachable without an import.\n   *\n   * Server-only, non-enumerable (a `{...props}` spread and `JSON.stringify` both skip it) and never\n   * serialized. Passing it to a `'use client'` component fails the render, because it wraps the live\n   * request — read what you need here and pass plain values down.\n   *\n   * Non-enumerable is the one place this API breaks a JavaScript expectation, and it is unavoidable: an\n   * enumerable `ctx` would put `ctx.hono.env` — every binding and secret — into React's dev-only\n   * serialization of a server component's props, which walks own enumerable properties. So `<Child\n   * {...props} />` hands a **server** child `ctx: undefined` with no error, while the type says otherwise.\n   * Nested server components are meant to call `getRequestContext()` for the same object rather than\n   * receive it, which is also the fix if a spread has already cost you an afternoon.\n   *\n   * Reading it on a `render: 'static'` route throws: a prerendered page has no per-request context.\n   * Mark the route `render: 'dynamic'`, or use the `url` / `params` props.\n   *\n   * @example\n   * ```tsx\n   * export default function Dashboard({ ctx }: PageProps) {\n   *   const session = ctx.cookies.get('session');\n   *   if (!session) redirect('/login');\n   *   return <Layout>Signed in as {session}</Layout>;\n   * }\n   * ```\n   */\n  ctx: RequestContext<E>;\n}\n\n/**\n * A page: a React **server component** rendering the entire document (`<html>…</html>`), usually via\n * a shared layout. It may be `async` and await data directly.\n *\n * Each page module default-exports exactly one. Interactive parts belong in `'use client'` components\n * the page imports — only those ship JS.\n *\n * @typeParam P - The component's props; for a page these are {@link PageProps}.\n *\n * @see {@link https://react.dev/reference/rsc/server-components | React — Server Components}\n * @see {@link https://www.rshono.com/docs/pages | Docs — pages}\n */\n// `any`, not `unknown`: this default is what an unparameterised `PageComponent` means in a user's own\n// annotation, and `unknown` props would reject every component that declares the props it actually takes.\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type PageComponent<P = any> = (props: P) => ReactNode | Promise<ReactNode>;\n\n/**\n * The shape an `{ type: 'endpoint' }` route's server module must have: a single named `handler`\n * export. It only ever loads on the server, so importing a database client or reading secrets from it\n * is safe.\n *\n * @example\n * ```ts\n * // src/health.ts\n * import type { Handler } from 'hono';\n *\n * export const handler: Handler = (c) => c.json({ ok: true });\n * ```\n *\n * @see {@link https://www.rshono.com/docs/routing#endpoint-routes | Docs — endpoint routes}\n */\nexport interface EndpointServerModule {\n  /**\n   * A Hono {@link Handler} for every request the route matches. It is passed Hono's `Context`, so the\n   * request, the response builders (`c.json`, `c.text`, `c.body`) and middleware variables are all\n   * reached through it.\n   *\n   * @see {@link https://hono.dev/docs/api/context | Hono — Context}\n   */\n  handler: Handler;\n}\n\n/**\n * A page route — a path rendered by a server component. This is the default\n * route kind, so `type` can be omitted.\n *\n * @example\n * ```ts\n * { path: '/profile/:id', component: () => import('./components/profile') }\n * ```\n */\nexport interface PageRoute {\n  /** Discriminates a page from an endpoint; optional because `'page'` is the default. */\n  type?: 'page';\n  /**\n   * Hono-style path pattern, e.g. `/`, `/profile/:id`, `/files/*`. Routes are matched in\n   * declaration order.\n   *\n   * @see {@link https://hono.dev/docs/api/routing | Hono — routing}\n   */\n  path: string;\n  /**\n   * Dynamic import of the page module, whose default export is the {@link PageComponent}.\n   *\n   * Write it inline as `() => import('…')`: the framework detects that exact form and injects the\n   * `'use server-entry'` directive that attaches the page's client JS and CSS. Wire the component up\n   * any other way — a variable, a barrel re-export, a computed specifier — and you have to put\n   * `'use server-entry'` on the page module's first line yourself.\n   *\n   * @example\n   * ```ts\n   * component: () => import('./components/profile')\n   * ```\n   *\n   * @see {@link https://www.rshono.com/docs/pages#the-use-server-entry-directive | Docs — the `'use server-entry'` directive}\n   */\n  component: () => Promise<{ default: PageComponent }>;\n  /** `'static'` prerenders the route at build time; `'dynamic'` (the default) renders per request. */\n  render?: 'static' | 'dynamic';\n  /**\n   * For a `render: 'static'` route with params: the param sets to prerender, one page each. Runs at\n   * build time on the server, so it may hit a database or read the filesystem.\n   *\n   * A parameterised static route without this falls back to rendering per request, with a build\n   * warning. Wildcard (`*`), optional and regex params cannot be prerendered.\n   *\n   * **Every value has to be one portable file name**, since that is what a prerendered page is stored as,\n   * and the build fails naming the value rather than writing a page nothing will serve. So: no\n   * `\\ / : * ? \" < > |` or control characters, no trailing `.` or space, and not a reserved Windows device\n   * name (`CON`, `NUL`, `COM1`, …) — the last two enforced everywhere, so a build that works on macOS is\n   * not one that fails in CI on Windows.\n   *\n   * @example\n   * ```ts\n   * {\n   *   path: '/docs/:slug',\n   *   render: 'static',\n   *   component: () => import('./components/documentation'),\n   *   staticPaths: async () => (await db.docs.all()).map((d) => ({ slug: d.slug })),\n   * }\n   * ```\n   *\n   * @see {@link https://www.rshono.com/docs/routing#static-rendering | Docs — static rendering}\n   */\n  staticPaths?: () => Array<Record<string, string>> | Promise<Array<Record<string, string>>>;\n}\n\n/**\n * An endpoint route — a path served by a raw Hono handler instead of a React\n * component. Use it for JSON APIs, webhooks, redirects, feeds, or anything that\n * isn't an HTML page.\n *\n * @example\n * ```ts\n * { type: 'endpoint', path: '/api/health', server: () => import('./health') }\n * ```\n *\n * @see {@link https://www.rshono.com/docs/routing#endpoint-routes | Docs — endpoint routes}\n */\nexport interface EndpointRoute {\n  /** Marks this route as an endpoint rather than a page. Required. */\n  type: 'endpoint';\n  /**\n   * Hono-style path pattern, e.g. `/api/health`, `/api/users/:id`.\n   *\n   * @see {@link https://hono.dev/docs/api/routing | Hono — routing}\n   */\n  path: string;\n  /**\n   * HTTP method to match, or a list of them. Defaults to `'all'` — every method.\n   *\n   * There is no `'head'`: Hono dispatches a `HEAD` as a `GET` and strips the body off the response, so a\n   * `HEAD` is already answered by the `'get'` handler (and by `'all'`), and a route registered for `HEAD`\n   * alone would never be reached.\n   *\n   * A list is how a two-method endpoint says so; `'all'` inside one is refused, since it is either the\n   * whole thing or a mistake. A method the route does not name gets Hono's 404 rather than the handler.\n   *\n   * @example\n   * ```ts\n   * { type: 'endpoint', path: '/api/session', method: ['get', 'delete'], server: () => import('./session') }\n   * ```\n   */\n  method?: HTTPMethod | readonly HTTPMethod[];\n  /** Dynamic import of the {@link EndpointServerModule} exporting `handler`. */\n  server: () => Promise<EndpointServerModule>;\n}\n\n/**\n * HTTP methods an {@link EndpointRoute} can match. `'all'` matches every method.\n *\n * No `'head'`, deliberately — see {@link EndpointRoute.method}. A `HEAD` reaches the `'get'` handler.\n */\nexport type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'all';\n\n/** Any entry in the `routes` array: a {@link PageRoute} or an {@link EndpointRoute}. */\nexport type Route = PageRoute | EndpointRoute;\n\n/**\n * Narrows a {@link Route} to a {@link PageRoute} — `type` is optional on page routes, so anything not\n * explicitly `'endpoint'` is one.\n *\n * @internal\n */\nexport function isPageRoute(route: Route): route is PageRoute {\n  return route.type !== 'endpoint';\n}\n\n/**\n * A page the framework falls back to rather than routes to — `notFound` and `error` in\n * {@link RouteConfig}. Same contract as a {@link PageRoute} `component`, without a path of its own.\n */\nexport interface FallbackPage {\n  /** Dynamic import of the page module; its default export is the {@link PageComponent}. */\n  component: () => Promise<{ default: PageComponent }>;\n}\n\n/**\n * The error detail handed to the `error` page. Redacted in production — a generic\n * `'Internal Server Error'` and no `stack`; in dev, the real message and stack.\n */\nexport interface ErrorPageInfo {\n  /** The thrown error's message in dev; `'Internal Server Error'` in production. */\n  message: string;\n  /**\n   * The stack trace — **dev only**, and `undefined` in every build. Optional for that reason rather than\n   * because some errors lack one, so a page that renders it should guard on it, not on a mode flag.\n   */\n  stack?: string;\n}\n\n/**\n * Props for the `error` page declared in {@link RouteConfig.error} — the usual {@link PageProps} plus\n * the redaction-aware {@link ErrorPageInfo}.\n *\n * In a build `error.message` is the generic `'Internal Server Error'` and `error.stack` is `undefined`, so\n * the page below guards on the stack rather than on a mode flag — there is no mode flag to guard on.\n *\n * @typeParam E - The app's Hono {@link Env}, forwarded to {@link PageProps.ctx}.\n *\n * @example\n * ```tsx\n * import type { ErrorPageProps } from '@rshono/core';\n *\n * export default function ServerError({ error }: ErrorPageProps) {\n *   return (\n *     <html>\n *       <body>\n *         <h1>Something went wrong</h1>\n *         <p>{error.message}</p>\n *         {error.stack && <pre>{error.stack}</pre>}\n *       </body>\n *     </html>\n *   );\n * }\n * ```\n */\nexport type ErrorPageProps<E extends Env = Env> = PageProps<string, E> & {\n  /** The error that failed the request, redacted in production — see {@link ErrorPageInfo}. */\n  error: ErrorPageInfo;\n};\n\n/**\n * The object form accepted by {@link defineRoutes}: the route table plus the two\n * optional framework-owned pages.\n *\n * @typeParam TRoutes - Inferred tuple of route literals, which is what makes the\n *   per-route `path` → props check possible.\n *\n * @see {@link https://www.rshono.com/docs/routing#notfound-and-error | Docs — notFound and error pages}\n */\nexport interface RouteConfig<TRoutes extends readonly Route[] = readonly Route[]> {\n  /** Every page and endpoint in the app, matched in order. */\n  routes: TRoutes;\n  /** Page rendered with a 404 status for unmatched paths and for `notFound()` calls. */\n  notFound?: FallbackPage;\n  /**\n   * Page rendered with a 500 status when a request throws — a page component, a page module that will not\n   * load, an endpoint, a server action, or middleware. Receives {@link ErrorPageProps}.\n   *\n   * It is a *fresh* render, with its own flight payload, so it hydrates and behaves like any other page.\n   * An app that declares none gets the framework's plain 500 document instead. If the `error` page itself\n   * throws, that is reported too and the framework's document answers.\n   */\n  error?: FallbackPage;\n}\n\n/**\n * The same check for `staticPaths`, whose param sets have to fill the route's own path: a key that does not\n * is otherwise a build-time throw from `interpolatePath` rather than a type error.\n *\n * Keys only, not full assignability, because the declared field type is `Record<string, string>` and a\n * `staticPaths` annotated as returning exactly that has to stay accepted — an index signature carries no\n * key to check, so it passes. Skipped where the path has no params, because `staticPaths` is not called for\n * such a route at all and an error there would be about the wrong thing.\n */\ntype ValidateStaticPaths<R, P extends string> =\n  ParamKeys<P> extends never\n    ? R\n    : R extends { staticPaths: () => infer Sets }\n      ? Awaited<Sets> extends ReadonlyArray<infer Set>\n        ? [keyof PathParams<P>] extends [keyof Set]\n          ? R\n          : R & { staticPaths: `every param set staticPaths returns needs the params of '${P}'` }\n        : R\n      : R;\n\n// `PageProps<P, any>`, not `PageProps<P>`: only the *path* is being checked, and pinning the Env would\n// fail every page that declares its own (`PageProps<'/x', MyEnv>`, to type `ctx.var`).\ntype ValidateRoute<R> = R extends {\n  path: infer P extends string;\n  component: () => Promise<{ default: PageComponent<infer CP> }>;\n}\n  ? // eslint-disable-next-line @typescript-eslint/no-explicit-any -- the Env is deliberately unpinned; see above.\n    [PageProps<P, any>] extends [CP]\n    ? ValidateStaticPaths<R, P>\n    : R & { component: `component props are not satisfied by PageProps<'${P}'>` }\n  : R;\n\ntype ValidateRoutes<TRoutes extends readonly Route[]> = { [K in keyof TRoutes]: ValidateRoute<TRoutes[K]> };\n\n/**\n * Refuses a key that is not a {@link RouteConfig} field — a typo'd `notfound` is otherwise a fallback page\n * that never renders, and nothing at runtime looks for one.\n *\n * Excess-property checking did this while the object form was an overload of its own with a concrete\n * parameter type. It cannot once the parameter is generic and inferred from the argument, because the\n * inferred type *has* the extra key. The message here is the better one anyway: it lands on the field.\n */\ntype ValidateConfigKeys<T> =\n  Exclude<keyof T, keyof RouteConfig> extends never\n    ? T\n    : T & Record<Exclude<keyof T, keyof RouteConfig>, 'not a defineRoutes field — the fields are routes, notFound and error'>;\n\n/** The check for whichever of the two accepted shapes was passed. */\ntype ValidateInput<T> = T extends readonly Route[]\n  ? ValidateRoutes<T>\n  : T extends { routes: infer R extends readonly Route[] }\n    ? ValidateConfigKeys<T> & { routes: ValidateRoutes<R> }\n    : T;\n\n/** The route tuple inside either shape, so the return type carries the literals through both. */\ntype RoutesOf<T> = T extends readonly Route[] ? T : T extends { routes: infer R extends readonly Route[] } ? R : readonly Route[];\n\n/**\n * Declares the app's route table. Export the result as `routes` from `src/routes.ts` — the one file\n * rshono requires. It only ever runs on the server, so importing server-only modules from it (inside\n * `staticPaths`, say) is safe.\n *\n * Takes a {@link RouteConfig} — the `routes` array plus the optional `notFound` and `error` pages — or a\n * bare {@link Route} array as shorthand for an app with neither.\n *\n * Beyond typing the config, every page is cross-checked against its own path: props not satisfied by\n * `PageProps<'<its path>'>` make the `component` field a type error, and a `staticPaths` whose param sets do\n * not fill the path makes that field one.\n *\n * **One signature over both shapes, deliberately.** The array form used to be a second overload, which meant\n * a mistake inside a bare array was reported as an overload-resolution failure whose *first* line was the\n * object form's complaint — \"Property 'routes' is missing\" — pointing at a change the author should not make.\n * The real message was on line 8. A single signature reports the argument once, at the field that is wrong.\n *\n * @param input - A {@link RouteConfig}, or the bare `routes` array.\n * @returns The config, unchanged and fully typed; an array is wrapped as `{ routes }`.\n *\n * @example\n * ```ts\n * // src/routes.ts\n * import { defineRoutes } from '@rshono/core';\n *\n * export const routes = defineRoutes({\n *   routes: [\n *     { path: '/', component: () => import('./components/home') },\n *     { path: '/profile/:id', component: () => import('./components/profile') },\n *     {\n *       path: '/docs/:slug',\n *       render: 'static',\n *       component: () => import('./components/documentation'),\n *       staticPaths: async () => [{ slug: 'getting-started' }, { slug: 'deployment' }],\n *     },\n *     { type: 'endpoint', path: '/api/health', server: () => import('./health') },\n *   ],\n *   notFound: { component: () => import('./components/404') },\n *   error: { component: () => import('./components/500') },\n * });\n * ```\n *\n * @example\n * ```ts\n * // The shorthand, for an app with no notFound or error page.\n * export const routes = defineRoutes([{ path: '/', component: () => import('./components/home') }]);\n * ```\n *\n * @see {@link https://www.rshono.com/docs/routing | Docs — routing}\n */\nexport function defineRoutes<const T extends readonly Route[] | RouteConfig<readonly Route[]>>(input: T & ValidateInput<T>): RouteConfig<RoutesOf<T>>;\nexport function defineRoutes(input: readonly Route[] | RouteConfig): RouteConfig {\n  return Array.isArray(input) ? { routes: input } : (input as RouteConfig);\n}\n"]}