@rshono/core 1.0.0-rc.22 → 1.0.0-rc.24

package/README.md

@@ -103,7 +103,9 @@ export default async function Profile({ params, ctx }: PageProps<'/profile/:id'>
 
 - Pages receive `{ url, params, ctx }` — `PageProps<'/profile/:id'>` types `params.id`, and `url` is a real
   `URL`. The same pair reaches a `'use client'` component from `useNavigation()`, so a read moves across the
-  boundary unchanged.
+  boundary unchanged — except the fragment, which a browser never sends to the server: `PageProps.url` never
+  has one, while `useNavigation().url.hash` is read from the address bar after hydration and follows in-page
+  links and Back/Forward.
 - **`ctx` is the request context** — `ctx.req`, cookies, env, middleware variables, the proxy-aware URL. It is
   the same object `getRequestContext()` returns from `@rshono/core/server`, handed over so a page needs no
   import. Reading it on a `render: 'static'` page throws: a page rendered once at build time has no request.

package/dist/router.d.ts

@@ -57,9 +57,11 @@ export interface PageProps<Path extends string = string, E extends Env = Env> {
      * 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.
+     * carries one `href` and both readings come from it. The fragment is the one part no payload can carry
+     * — a browser never sends `#…` with the request — so this prop never has one, while
+     * `useNavigation().url.hash` is read from the browser after hydration. 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`. */

package/dist/router.js.map

@@ -1 +1 @@
-{"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"]}
+{"version":3,"file":"router.js","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AAoQA;;;;;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. The fragment is the one part no payload can carry\n   * — a browser never sends `#…` with the request — so this prop never has one, while\n   * `useNavigation().url.hash` is read from the browser after hydration. Mark the route\n   * `render: 'dynamic'` if the page depends on the query; a `'use client'` component that only wants it\n   * after hydration can read `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"]}

package/dist/runtime/entry.rsc.js

@@ -15,10 +15,10 @@ import { routes as userRoutes } from '@rshono/routes';
 import * as serverAppModule from '@rshono/server-app';
 import { isPageRoute } from '../router.js';
 import { appendVary, etagMatches, varyWith } from '../server/headers.js';
-import { PRERENDER_NONCE_HEADER } from '../server/prerendered.js';
+import { PRERENDER_NONCE_HEADER, setPrerenderFlight } from '../server/prerendered.js';
 import { beginPageRender, getRequestContext, publicUrl, readParams, reportServerError, runWithContext } from './context.js';
 import { cameFromPayload, isControlSignal, RedirectSignal } from './control.js';
-import { renderHTML } from './entry.ssr.js';
+import { renderHTML, renderPrerenderHTML } from './entry.ssr.js';
 import { failureDocument } from './failure-document.js';
 import { RouterProvider } from './navigation.js';
 import { asksForRsc, isActionRequest, isBrowserFormPost, parseRenderRequest, requestWantsRsc, RSC_VARY_HEADER, wantsRsc } from './request.js';
@@ -335,8 +335,9 @@ async function renderComponent(c, Page, opts) {
         });
     }
     let ssrResult;
+    let prerenderFlight;
     try {
-        ssrResult = await renderHTML(rscStream, {
+        const renderOptions = {
             bootstrapScripts: Page.entryJsFiles,
             formState: opts.formState,
             signal,
@@ -344,7 +345,15 @@ async function renderComponent(c, Page, opts) {
             onDone: release,
             onShellError: (error) => reportServerError(error, { source: 'ssr', hono: c, message: '[rshono] SSR shell error:' }),
             onError: (error) => reportServerError(error, { source: 'ssr', hono: c, message: '[rshono] SSR error:' }),
-        });
+        };
+        if (prerendering) {
+            const result = await renderPrerenderHTML(rscStream, renderOptions);
+            ssrResult = result;
+            prerenderFlight = result.flight;
+        }
+        else {
+            ssrResult = await renderHTML(rscStream, renderOptions);
+        }
     }
     catch (error) {
         // The render is abandoned, so stop it: a boundary still resolving is work for a response that will never
@@ -376,10 +385,13 @@ async function renderComponent(c, Page, opts) {
         release();
         throw controlSignal;
     }
-    return c.body(ssrResult.stream, (opts.status ?? 200), {
+    const response = c.body(ssrResult.stream, (opts.status ?? 200), {
         'content-type': 'text/html;charset=utf-8',
         ...prerenderNonceHeader(c),
     });
+    if (prerenderFlight)
+        setPrerenderFlight(response, prerenderFlight);
+    return response;
 }
 /**
  * The answer to an action request whose body could not be read or decoded — a malformed request, the same