@rshono/core 1.0.0-rc.0 → 1.0.0-rc.10

package/dist/router.d.ts

@@ -1,7 +1,7 @@
 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];
 } & {};
@@ -19,6 +19,8 @@ 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>>>>;
 /**
@@ -34,8 +36,8 @@ export type PathParams<P extends string> = ParamKeys<P> extends never ? Record<s
  * the server/client line is a copy-paste.
  *
  * @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,6 +49,8 @@ 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> {
     /**
@@ -55,42 +59,35 @@ export interface PageProps<Path extends string = string, E extends Env = Env> {
      * 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`.
+     * to the page. It is not serializable, so a `'use client'` component has to be
+     * handed `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` with no query string, and that one file 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'`.
      */
     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
+     * The request context — the very 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:
-     *
-     * - 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.
+     * Server-only and never serialized: React puts a server component's *output* on
+     * the wire, not its props. It is also deliberately **non-enumerable**, so
+     * `Object.keys(props)`, `JSON.stringify(props)` and a `{...props}` spread all
+     * skip it. Handing it to a `'use client'` component directly
+     * (`<Counter ctx={ctx} />`) fails the render — it wraps the live request and
+     * response, which do not exist in the browser. Read what you need here and pass
+     * plain values down.
      *
      * 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`).
+     * per-request context at build time. Mark the route `render: 'dynamic'`, or use
+     * the `url` / `params` props — available either way, with the build-time caveat
+     * noted on `url`.
      *
      * @example
      * ```tsx
@@ -101,7 +98,7 @@ 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
@@ -112,6 +109,9 @@ export interface PageProps<Path extends string = string, E extends Env = Env> {
  * 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>;
 /**
@@ -122,13 +122,21 @@ export type PageComponent<P = any> = (props: P) => ReactNode | Promise<ReactNode
  * @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} handling every request matched by the route. It is passed Hono's
+     * `Context`, so the request, 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,7 +151,12 @@ 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
@@ -156,6 +169,8 @@ export interface PageRoute {
      * 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.
+     *
+     * @see {@link https://www.rshono.com/docs/pages#the-use-server-entry-directive | Docs — the `'use server-entry'` directive}
      */
     component: () => Promise<{
         default: PageComponent;
@@ -180,6 +195,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,11 +209,17 @@ 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;
@@ -211,12 +234,10 @@ 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.
  *
- * @example
- * ```ts
- * for (const route of routes) {
- *   if (isPageRoute(route)) console.log(route.render ?? 'dynamic');
- * }
- * ```
+ * Framework internal — not re-exported from `index.ts`. The request renderer and
+ * the SSG pass use it to split the route table.
+ *
+ * @internal
  */
 export declare function isPageRoute(route: Route): route is PageRoute;
 /**
@@ -235,7 +256,7 @@ export interface FallbackPage {
  * message is a generic `'Internal Server Error'` and there is no `stack`. In dev
  * you get the real message plus the 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. */
@@ -243,7 +264,7 @@ export interface ErrorInfo {
 }
 /**
  * Props for the `error` page declared in {@link RouteConfig.error} — the usual
- * {@link PageProps} plus the redaction-aware {@link ErrorInfo}.
+ * {@link PageProps} plus the redaction-aware {@link ErrorPageInfo}.
  *
  * @typeParam E - The app's Hono {@link Env}, forwarded to {@link PageProps.ctx}.
  *
@@ -257,7 +278,8 @@ export interface ErrorInfo {
  * ```
  */
 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,6 +287,8 @@ 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. */
@@ -298,8 +322,10 @@ type ValidateRoutes<TRoutes extends readonly Route[]> = {
  * PageProps<'/…'>`. Fix it by matching the page's `PageProps<Path>` type
  * argument to the path it's mounted at.
  *
- * @param config - A {@link RouteConfig}, or a bare {@link Route} array as
- *   shorthand when there are no `notFound` / `error` pages.
+ * A bare {@link Route} array is accepted as shorthand — see the second overload.
+ *
+ * @param config - A {@link RouteConfig}: the `routes` array plus the optional
+ *   `notFound` and `error` pages.
  * @returns The config, unchanged and fully typed.
  *
  * @example
@@ -324,14 +350,25 @@ type ValidateRoutes<TRoutes extends readonly Route[]> = {
  * });
  * ```
  *
- * @example Array shorthand
- * ```ts
- * 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>;
+/**
+ * Array shorthand for {@link defineRoutes} — equivalent to `defineRoutes({ routes })`, for an app
+ * with no `notFound` or `error` page.
+ *
+ * @param routes - The {@link Route} array; each page is checked against its own `path`.
+ * @returns A {@link RouteConfig} wrapping them.
+ *
+ * @example
+ * ```ts
+ * 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[]>(routes: TRoutes & ValidateRoutes<TRoutes>): RouteConfig<TRoutes>;
 export {};
 //# sourceMappingURL=router.d.ts.map

package/dist/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACzC,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGvC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,sBAAsB,CAAC;AAEhD,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AACjD,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC;AAEpH;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,IACrC,SAAS,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,QAAQ,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAErH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,SAAS,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,SAAS,GAAG,GAAG,GAAG;IAC1E;;;;;;;;;;;;;;OAcG;IACH,GAAG,EAAE,GAAG,CAAC;IACT,qFAAqF;IACrF,MAAM,EAAE,MAAM,SAAS,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IACxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;CACb;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AAElF;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,oBAAoB;IACnC,0EAA0E;IAC1E,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,SAAS;IACxB,uFAAuF;IACvF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;OAWG;IACH,SAAS,EAAE,MAAM,OAAO,CAAC;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,CAAC,CAAC;IACrD,oGAAoG;IACpG,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC9B;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,EAAE,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;CAC5F;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC5B,oEAAoE;IACpE,IAAI,EAAE,UAAU,CAAC;IACjB,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,8EAA8E;IAC9E,MAAM,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAC7C;AAED,qFAAqF;AACrF,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,KAAK,CAAC;AAElG,wFAAwF;AACxF,MAAM,MAAM,KAAK,GAAG,SAAS,GAAG,aAAa,CAAC;AAE9C;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,IAAI,SAAS,CAE5D;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,0FAA0F;IAC1F,SAAS,EAAE,MAAM,OAAO,CAAC;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG;IAAE,KAAK,EAAE,SAAS,CAAA;CAAE,CAAC;AAE9F;;;;;;GAMG;AACH,MAAM,WAAW,WAAW,CAAC,OAAO,SAAS,SAAS,KAAK,EAAE,GAAG,SAAS,KAAK,EAAE;IAC9E,4DAA4D;IAC5D,MAAM,EAAE,OAAO,CAAC;IAChB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,8FAA8F;IAC9F,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAMD,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS;IAChC,IAAI,EAAE,MAAM,CAAC,SAAS,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,OAAO,CAAC;QAAE,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC;CAChE,GACG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,GAC9B,CAAC,GACD,CAAC,GAAG;IAAE,SAAS,EAAE,mDAAmD,CAAC,IAAI,CAAA;CAAE,GAC7E,CAAC,CAAC;AAEN,KAAK,cAAc,CAAC,OAAO,SAAS,SAAS,KAAK,EAAE,IAAI;KAAG,CAAC,IAAI,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAE5G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAgB,YAAY,CAAC,KAAK,CAAC,OAAO,SAAS,SAAS,KAAK,EAAE,EACjE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG;IAAE,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,CAAA;CAAE,GACjE,WAAW,CAAC,OAAO,CAAC,CAAC;AACxB,wBAAgB,YAAY,CAAC,KAAK,CAAC,OAAO,SAAS,SAAS,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACzC,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AACjD,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC;AAEpH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,IACrC,SAAS,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,QAAQ,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAErH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,SAAS,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,SAAS,GAAG,GAAG,GAAG;IAC1E;;;;;;;;;;;;;;OAcG;IACH,GAAG,EAAE,GAAG,CAAC;IACT,qFAAqF;IACrF,MAAM,EAAE,MAAM,SAAS,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IACxE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;CACxB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AAElF;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,SAAS;IACxB,uFAAuF;IACvF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;OAaG;IACH,SAAS,EAAE,MAAM,OAAO,CAAC;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,CAAC,CAAC;IACrD,oGAAoG;IACpG,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,WAAW,CAAC,EAAE,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;CAC5F;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa;IAC5B,oEAAoE;IACpE,IAAI,EAAE,UAAU,CAAC;IACjB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,8EAA8E;IAC9E,MAAM,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAC7C;AAED,qFAAqF;AACrF,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,KAAK,CAAC;AAElG,wFAAwF;AACxF,MAAM,MAAM,KAAK,GAAG,SAAS,GAAG,aAAa,CAAC;AAE9C;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,IAAI,SAAS,CAE5D;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,0FAA0F;IAC1F,SAAS,EAAE,MAAM,OAAO,CAAC;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG;IACvE,6FAA6F;IAC7F,KAAK,EAAE,aAAa,CAAC;CACtB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW,CAAC,OAAO,SAAS,SAAS,KAAK,EAAE,GAAG,SAAS,KAAK,EAAE;IAC9E,4DAA4D;IAC5D,MAAM,EAAE,OAAO,CAAC;IAChB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,8FAA8F;IAC9F,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAMD,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS;IAChC,IAAI,EAAE,MAAM,CAAC,SAAS,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,OAAO,CAAC;QAAE,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC;CAChE,GACG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,GAC9B,CAAC,GACD,CAAC,GAAG;IAAE,SAAS,EAAE,mDAAmD,CAAC,IAAI,CAAA;CAAE,GAC7E,CAAC,CAAC;AAEN,KAAK,cAAc,CAAC,OAAO,SAAS,SAAS,KAAK,EAAE,IAAI;KAAG,CAAC,IAAI,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAE5G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,YAAY,CAAC,KAAK,CAAC,OAAO,SAAS,SAAS,KAAK,EAAE,EACjE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG;IAAE,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,CAAA;CAAE,GACjE,WAAW,CAAC,OAAO,CAAC,CAAC;AACxB;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,KAAK,CAAC,OAAO,SAAS,SAAS,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC"}

package/dist/router.js

@@ -2,12 +2,10 @@
  * Type guard narrowing a {@link Route} to a {@link PageRoute}. Because `type` is
  * optional on page routes, anything not explicitly `'endpoint'` is a page.
  *
- * @example
- * ```ts
- * for (const route of routes) {
- *   if (isPageRoute(route)) console.log(route.render ?? 'dynamic');
- * }
- * ```
+ * Framework internal — not re-exported from `index.ts`. The request renderer and
+ * the SSG pass use it to split the route table.
+ *
+ * @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":"AAiPA;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,KAAY;IACtC,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC;AACnC,CAAC;AA0ID,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 { 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\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 *\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\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 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\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. It is not serializable, so a `'use client'` component has to be\n   * handed `url.href` rather than `url`.\n   *\n   * On a `render: 'static'` route this is the build-time URL — rendered once\n   * against `siteUrl` with no query string, and that one file answers every\n   * request whatever its own query. So `url.searchParams` is always empty there:\n   * read the query from `useNavigation().url` in a `'use client'` component\n   * 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 `getRequestContext()` 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 puts a server component's *output* on\n   * the wire, not its props. It is also deliberately **non-enumerable**, so\n   * `Object.keys(props)`, `JSON.stringify(props)` and a `{...props}` spread all\n   * skip it. Handing it to a `'use client'` component directly\n   * (`<Counter ctx={ctx} />`) fails the render — it wraps the live request and\n   * response, which do not exist in the browser. Read what you need here and pass\n   * plain values down.\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 — available either way, with the build-time caveat\n   * 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: RequestContext<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 *\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 */\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 '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} handling every request matched by the route. It is passed Hono's\n   * `Context`, so the request, response builders (`c.json`, `c.text`, `c.body`) and middleware\n   * variables are all 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\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   * @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\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   * @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  /** 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 * Framework internal — not re-exported from `index.ts`. The request renderer and\n * the SSG pass use it to split the route table.\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\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 ErrorPageInfo {\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 ErrorPageInfo}.\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> & {\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  /** 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 checks the *path* against the page's `params`, and\n// pinning the Env to the default would additionally demand that a page declaring its own\n// (`PageProps<'/x', MyEnv>`, to type `ctx.var`) accept a `RequestContext<Env>` — which it doesn't, so\n// every 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 * A bare {@link Route} array is accepted as shorthand — see the second overload.\n *\n * @param config - A {@link RouteConfig}: the `routes` array plus the optional\n *   `notFound` and `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 * @see {@link https://www.rshono.com/docs/routing | Docs — routing}\n */\nexport function defineRoutes<const TRoutes extends readonly Route[]>(\n  config: RouteConfig<TRoutes> & { routes: ValidateRoutes<TRoutes> },\n): RouteConfig<TRoutes>;\n/**\n * Array shorthand for {@link defineRoutes} — equivalent to `defineRoutes({ routes })`, for an app\n * with no `notFound` or `error` page.\n *\n * @param routes - The {@link Route} array; each page is checked against its own `path`.\n * @returns A {@link RouteConfig} wrapping them.\n *\n * @example\n * ```ts\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 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"]}

package/dist/runtime/boundaries.d.ts

@@ -1,6 +1,6 @@
 import { Component, type ReactNode } from 'react';
 /**
- * What an {@link ErrorBoundary} / {@link Boundary} renders once a child throws.
+ * What a {@link CatchBoundary} / {@link AsyncBoundary} renders once a child throws.
  * Either a static node, or a render function that also gets a `reset` callback
  * to clear the error and re-render the children (e.g. a "Try again" button).
  *
@@ -9,7 +9,8 @@ import { Component, type ReactNode } from 'react';
  * server component, pass a `ReactNode`.
  */
 export type ErrorFallback = ReactNode | ((error: Error, reset: () => void) => ReactNode);
-export interface ErrorBoundaryProps {
+/** Props for {@link CatchBoundary}. */
+export interface CatchBoundaryProps {
     /**
      * Rendered in place of the children after one of them throws. Omit it to
      * report the error via `onError` and re-throw to the next boundary out (or
@@ -24,9 +25,10 @@ export interface ErrorBoundaryProps {
      * recover when the user navigates away: `resetKeys={[useNavigation().url.pathname]}`.
      */
     resetKeys?: readonly unknown[];
+    /** The subtree this boundary protects. */
     children: ReactNode;
 }
-interface ErrorBoundaryState {
+interface CatchBoundaryState {
     error: Error | null;
 }
 /**
@@ -36,40 +38,50 @@ interface ErrorBoundaryState {
  * tearing down the whole page.
  *
  * It's a `'use client'` component (React error boundaries must be), so drop it
- * anywhere in the tree from a server or client component. Use {@link Boundary}
+ * anywhere in the tree from a server or client component. Use {@link AsyncBoundary}
  * when you also want a Suspense loading fallback in the same wrapper.
  *
  * @example
  * ```tsx
- * import { ErrorBoundary } from '@rshono/core/client';
+ * import { CatchBoundary } from '@rshono/core/client';
  *
- * <ErrorBoundary fallback={(error, reset) => (
+ * <CatchBoundary fallback={(error, reset) => (
  *   <div role="alert">
  *     <p>{error.message}</p>
  *     <button onClick={reset}>Try again</button>
  *   </div>
  * )}>
  *   <RiskyWidget />
- * </ErrorBoundary>
+ * </CatchBoundary>
  * ```
+ *
+ * @see {@link https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary | React — error boundaries}
+ * @see {@link https://www.rshono.com/docs/api#rshonocoreclient | Docs — `@rshono/core/client`}
  */
-export declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
-    state: ErrorBoundaryState;
-    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
+export declare class CatchBoundary extends Component<CatchBoundaryProps, CatchBoundaryState> {
+    state: CatchBoundaryState;
+    static getDerivedStateFromError(error: Error): CatchBoundaryState;
     componentDidCatch(error: Error): void;
-    componentDidUpdate(prev: ErrorBoundaryProps): void;
+    componentDidUpdate(prev: CatchBoundaryProps): void;
     reset: () => void;
     render(): ReactNode;
 }
-export interface BoundaryProps {
-    /** Suspense fallback, shown while the children (or their data) are still loading. */
-    loading?: ReactNode;
+/** Props for {@link AsyncBoundary}. */
+export interface AsyncBoundaryProps {
+    /**
+     * Suspense fallback, shown while the children (or their data) are still
+     * loading. Required — a loading state is the reason to reach for this over
+     * {@link CatchBoundary}, so showing nothing is an explicit `loading={null}`
+     * rather than something you get by leaving the prop off.
+     */
+    loading: ReactNode;
     /** Error fallback, shown if a child throws. See {@link ErrorFallback}. */
     error?: ErrorFallback;
     /** Called with the caught error. */
     onError?: (error: Error) => void;
-    /** Clears the error fallback when any value changes — see {@link ErrorBoundaryProps.resetKeys}. */
+    /** Clears the error fallback when any value changes — see {@link CatchBoundaryProps.resetKeys}. */
     resetKeys?: readonly unknown[];
+    /** The subtree this boundary suspends on and protects. */
     children: ReactNode;
 }
 /**
@@ -77,26 +89,28 @@ export interface BoundaryProps {
  * section of a page. It always renders the same shape:
  *
  * ```tsx
- * <ErrorBoundary fallback={error}>
+ * <CatchBoundary fallback={error}>
  *   <Suspense fallback={loading}>{children}</Suspense>
- * </ErrorBoundary>
+ * </CatchBoundary>
  * ```
  *
  * so `error` catches anything the children throw (including while suspended) and
- * `loading` shows until they resolve. Both fallbacks are optional: omit
- * `loading` and nothing shows while loading; omit `error` and thrown errors
- * propagate to the next boundary out (or the global error page) rather than
- * being caught here.
+ * `loading` shows until they resolve. `error` is optional: omit it and thrown
+ * errors propagate to the next boundary out (or the global error page) rather
+ * than being caught here.
  *
  * @example
  * ```tsx
- * import { Boundary } from '@rshono/core/client';
+ * import { AsyncBoundary } from '@rshono/core/client';
  *
- * <Boundary loading={<Spinner />} error={(e, reset) => <Retry onClick={reset} />}>
+ * <AsyncBoundary loading={<Spinner />} error={(e, reset) => <Retry onClick={reset} />}>
  *   <SlowServerComponent />
- * </Boundary>
+ * </AsyncBoundary>
  * ```
+ *
+ * @see {@link https://react.dev/reference/react/Suspense | React — `<Suspense>`}
+ * @see {@link https://www.rshono.com/docs/api#rshonocoreclient | Docs — `@rshono/core/client`}
  */
-export declare function Boundary({ loading, error, onError, resetKeys, children }: BoundaryProps): ReactNode;
+export declare function AsyncBoundary({ loading, error, onError, resetKeys, children }: AsyncBoundaryProps): ReactNode;
 export {};
 //# sourceMappingURL=boundaries.d.ts.map

package/dist/runtime/boundaries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"boundaries.d.ts","sourceRoot":"","sources":["../../src/runtime/boundaries.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAY,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAa5D;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,IAAI,KAAK,SAAS,CAAC,CAAC;AAEzF,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAC/B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,UAAU,kBAAkB;IAC1B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;CACrB;AAMD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,aAAc,SAAQ,SAAS,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAClF,KAAK,EAAE,kBAAkB,CAAmB;IAE5C,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,KAAK,GAAG,kBAAkB,CAEhE;IAED,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAGpC;IAED,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI,CAKjD;IAED,KAAK,QAAO,IAAI,CAEd;IAEF,MAAM,IAAI,SAAS,CASlB;CACF;AAED,MAAM,WAAW,aAAa;IAC5B,qFAAqF;IACrF,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,0EAA0E;IAC1E,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,oCAAoC;IACpC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC,mGAAmG;IACnG,SAAS,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAC/B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,QAAQ,CAAC,EAAE,OAAc,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,aAAa,GAAG,SAAS,CAM1G"}
+{"version":3,"file":"boundaries.d.ts","sourceRoot":"","sources":["../../src/runtime/boundaries.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAY,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAa5D;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,IAAI,KAAK,SAAS,CAAC,CAAC;AAEzF,uCAAuC;AACvC,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAC/B,0CAA0C;IAC1C,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,UAAU,kBAAkB;IAC1B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;CACrB;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,aAAc,SAAQ,SAAS,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAClF,KAAK,EAAE,kBAAkB,CAAmB;IAE5C,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,KAAK,GAAG,kBAAkB,CAEhE;IAED,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAGpC;IAED,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI,CAKjD;IAED,KAAK,QAAO,IAAI,CAEd;IAEF,MAAM,IAAI,SAAS,CASlB;CACF;AAED,uCAAuC;AACvC,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,OAAO,EAAE,SAAS,CAAC;IACnB,0EAA0E;IAC1E,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,oCAAoC;IACpC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC,mGAAmG;IACnG,SAAS,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAC/B,0DAA0D;IAC1D,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,aAAa,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,kBAAkB,GAAG,SAAS,CAM7G"}

package/dist/runtime/boundaries.js

@@ -5,7 +5,7 @@ import { isControlDigest } from './control.js';
 /**
  * `redirect()` and `notFound()` reach the browser as a thrown error carrying a control digest.
  * They are navigation, not failure, so no boundary may absorb one — otherwise a `redirect()` from
- * a component inside a `<Boundary>` would render "something went wrong" instead of navigating.
+ * a component inside a `<CatchBoundary>` would render "something went wrong" instead of navigating.
  * They're re-thrown to the root, where the runtime turns the digest into a real navigation.
  */
 function isControlError(error) {
@@ -21,24 +21,27 @@ function keysChanged(a, b) {
  * tearing down the whole page.
  *
  * It's a `'use client'` component (React error boundaries must be), so drop it
- * anywhere in the tree from a server or client component. Use {@link Boundary}
+ * anywhere in the tree from a server or client component. Use {@link AsyncBoundary}
  * when you also want a Suspense loading fallback in the same wrapper.
  *
  * @example
  * ```tsx
- * import { ErrorBoundary } from '@rshono/core/client';
+ * import { CatchBoundary } from '@rshono/core/client';
  *
- * <ErrorBoundary fallback={(error, reset) => (
+ * <CatchBoundary fallback={(error, reset) => (
  *   <div role="alert">
  *     <p>{error.message}</p>
  *     <button onClick={reset}>Try again</button>
  *   </div>
  * )}>
  *   <RiskyWidget />
- * </ErrorBoundary>
+ * </CatchBoundary>
  * ```
+ *
+ * @see {@link https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary | React — error boundaries}
+ * @see {@link https://www.rshono.com/docs/api#rshonocoreclient | Docs — `@rshono/core/client`}
  */
-export class ErrorBoundary extends Component {
+export class CatchBoundary extends Component {
     state = { error: null };
     static getDerivedStateFromError(error) {
         return { error };
@@ -75,27 +78,29 @@ export class ErrorBoundary extends Component {
  * section of a page. It always renders the same shape:
  *
  * ```tsx
- * <ErrorBoundary fallback={error}>
+ * <CatchBoundary fallback={error}>
  *   <Suspense fallback={loading}>{children}</Suspense>
- * </ErrorBoundary>
+ * </CatchBoundary>
  * ```
  *
  * so `error` catches anything the children throw (including while suspended) and
- * `loading` shows until they resolve. Both fallbacks are optional: omit
- * `loading` and nothing shows while loading; omit `error` and thrown errors
- * propagate to the next boundary out (or the global error page) rather than
- * being caught here.
+ * `loading` shows until they resolve. `error` is optional: omit it and thrown
+ * errors propagate to the next boundary out (or the global error page) rather
+ * than being caught here.
  *
  * @example
  * ```tsx
- * import { Boundary } from '@rshono/core/client';
+ * import { AsyncBoundary } from '@rshono/core/client';
  *
- * <Boundary loading={<Spinner />} error={(e, reset) => <Retry onClick={reset} />}>
+ * <AsyncBoundary loading={<Spinner />} error={(e, reset) => <Retry onClick={reset} />}>
  *   <SlowServerComponent />
- * </Boundary>
+ * </AsyncBoundary>
  * ```
+ *
+ * @see {@link https://react.dev/reference/react/Suspense | React — `<Suspense>`}
+ * @see {@link https://www.rshono.com/docs/api#rshonocoreclient | Docs — `@rshono/core/client`}
  */
-export function Boundary({ loading = null, error, onError, resetKeys, children }) {
-    return (_jsx(ErrorBoundary, { fallback: error, onError: onError, resetKeys: resetKeys, children: _jsx(Suspense, { fallback: loading, children: children }) }));
+export function AsyncBoundary({ loading, error, onError, resetKeys, children }) {
+    return (_jsx(CatchBoundary, { fallback: error, onError: onError, resetKeys: resetKeys, children: _jsx(Suspense, { fallback: loading, children: children }) }));
 }
 //# sourceMappingURL=boundaries.js.map