@rshono/core 1.0.0-rc.0

package/dist/router.d.ts

@@ -0,0 +1,337 @@
+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';
+type Simplify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+/**
+ * The `params` record implied by a route path pattern — one required `string` key
+ * per `:param` segment, `Record<string, never>` for a path with no params.
+ *
+ * Paths use Hono's syntax, so `:id`, `:id{[0-9]+}` and `*` all work. You rarely
+ * name this type directly; {@link PageProps} applies it for you.
+ *
+ * @typeParam P - The literal route path, e.g. `'/users/:id/posts/:postId'`.
+ *
+ * @example
+ * ```ts
+ * type P = PathParams<'/users/:id/posts/:postId'>; // { id: string; postId: string }
+ * ```
+ */
+export type PathParams<P extends string> = ParamKeys<P> extends never ? Record<string, never> : Simplify<UnionToIntersection<ParamKeyToRecord<ParamKeys<P>>>>;
+/**
+ * Props every page component receives. Pass the route's path as the type
+ * argument to get `params` typed key-by-key; without it `params` falls back to
+ * an open `Record<string, string>`.
+ *
+ * `defineRoutes` checks each page's props against `PageProps<path>` at compile
+ * time, so a mismatched path literal is a type error at the route definition.
+ *
+ * The location props (`url` and `params`) mirror what a `'use client'` component
+ * gets from `useNavigation()` — same names, same types — so moving a read across
+ * the server/client line is a copy-paste.
+ *
+ * @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}.
+ *
+ * @example
+ * ```tsx
+ * import type { PageProps } from '@rshono/core';
+ *
+ * export default async function Profile({ params, url }: PageProps<'/profile/:id'>) {
+ *   const user = await db.getUser(params.id); // params.id is string
+ *   const tab = url.searchParams.get('tab') ?? 'overview';
+ *   return <Layout>{user.name} — {tab}</Layout>;
+ * }
+ * ```
+ */
+export interface PageProps<Path extends string = string, E extends Env = Env> {
+    /**
+     * The absolute browser-facing request {@link URL}, proxy-header aware
+     * (`X-Forwarded-Host` / `-Proto`). Read `url.pathname`, `url.searchParams` and
+     * the rest off it.
+     *
+     * A fresh instance per request that nothing else holds, so mutating it is local
+     * to the page — but note it is *not* serializable, so a `'use client'` component
+     * has to be handed `url.href` rather than `url`.
+     *
+     * 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'`.
+     */
+    url: URL;
+    /** Matched route params for this request, e.g. `{ id: '42' }` for `/profile/:id`. */
+    params: string extends Path ? Record<string, string> : PathParams<Path>;
+    /**
+     * The request context — the very object `getContext()` returns, handed to the
+     * page so cookies, headers, env and middleware variables are reachable without
+     * an import.
+     *
+     * 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.
+     *
+     * 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`).
+     *
+     * @example
+     * ```tsx
+     * export default function Dashboard({ ctx }: PageProps) {
+     *   const session = ctx.cookies.get('session');
+     *   if (!session) redirect('/login');
+     *   return <Layout>Signed in as {session}</Layout>;
+     * }
+     * ```
+     */
+    ctx: Ctx<E>;
+}
+/**
+ * A page: a React **server component** that renders the entire document
+ * (`<html>…</html>`), usually via a shared layout. It may be `async` and await
+ * data directly.
+ *
+ * Each page module must default-export exactly one of these. Interactive parts
+ * belong in `'use client'` components the page imports — only those ship JS.
+ *
+ * @typeParam P - The component's props; for a page these are {@link PageProps}.
+ */
+export type PageComponent<P = any> = (props: P) => ReactNode | Promise<ReactNode>;
+/**
+ * The shape an `{ type: 'endpoint' }` route's server module must have: a single
+ * named `handler` export. The module only ever loads on the server, so it is
+ * safe to import a database client or read secrets from it.
+ *
+ * @example
+ * ```ts
+ * // src/health.ts
+ * import type { Handler } from '@rshono/core';
+ *
+ * export const handler: Handler = (c) => c.json({ ok: true });
+ * ```
+ */
+export interface EndpointServerModule {
+    /** A Hono {@link Handler} handling every request matched by the route. */
+    handler: Handler;
+}
+/**
+ * A page route — a path rendered by a server component. This is the default
+ * route kind, so `type` can be omitted.
+ *
+ * @example
+ * ```ts
+ * { path: '/profile/:id', component: () => import('./components/profile') }
+ * ```
+ */
+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/*`. */
+    path: string;
+    /**
+     * Dynamic import of the page module, whose default export is the
+     * {@link PageComponent}.
+     *
+     * Write it inline as shown — the framework detects that exact
+     * `() => import('…')` form and injects Rspack's `'use server-entry'`
+     * directive into the module for you (that directive is what attaches the
+     * page's client JS/CSS, giving per-page code splitting). If you wire the
+     * component up any other way — a variable, a barrel re-export, a computed
+     * specifier — add `'use server-entry'` as the first line of the page module
+     * yourself; the framework throws a descriptive error when neither happened.
+     */
+    component: () => Promise<{
+        default: PageComponent;
+    }>;
+    /** `'static'` prerenders the route at build time; `'dynamic'` (the default) renders per request. */
+    render?: 'static' | 'dynamic';
+    /**
+     * For a `render: 'static'` route with params: the param sets to prerender, one
+     * HTML file each. Runs at build time only, on the server, so it may hit a
+     * database or read the filesystem.
+     *
+     * A parameterised static route without `staticPaths` falls back to rendering
+     * per request (with a build warning). Wildcard (`*`), optional and regex
+     * params can't be prerendered.
+     *
+     * @example
+     * ```ts
+     * {
+     *   path: '/docs/:slug',
+     *   render: 'static',
+     *   component: () => import('./components/documentation'),
+     *   staticPaths: async () => (await db.docs.all()).map((d) => ({ slug: d.slug })),
+     * }
+     * ```
+     */
+    staticPaths?: () => Array<Record<string, string>> | Promise<Array<Record<string, string>>>;
+}
+/**
+ * An endpoint route — a path served by a raw Hono handler instead of a React
+ * component. Use it for JSON APIs, webhooks, redirects, feeds, or anything that
+ * isn't an HTML page.
+ *
+ * @example
+ * ```ts
+ * { type: 'endpoint', path: '/api/health', server: () => import('./health') }
+ * ```
+ */
+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`. */
+    path: string;
+    /** HTTP method to match. Defaults to `'all'` — every method. */
+    method?: HTTPMethod;
+    /** Dynamic import of the {@link EndpointServerModule} exporting `handler`. */
+    server: () => Promise<EndpointServerModule>;
+}
+/** HTTP methods an {@link EndpointRoute} can match. `'all'` matches every method. */
+export type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options' | 'all';
+/** Any entry in the `routes` array: a {@link PageRoute} or an {@link EndpointRoute}. */
+export type Route = PageRoute | EndpointRoute;
+/**
+ * Type guard narrowing a {@link Route} to a {@link PageRoute}. Because `type` is
+ * optional on page routes, anything not explicitly `'endpoint'` is a page.
+ *
+ * @example
+ * ```ts
+ * for (const route of routes) {
+ *   if (isPageRoute(route)) console.log(route.render ?? 'dynamic');
+ * }
+ * ```
+ */
+export declare function isPageRoute(route: Route): route is PageRoute;
+/**
+ * A page the framework falls back to rather than routes to — `notFound` and
+ * `error` in {@link RouteConfig}. Same contract as a {@link PageRoute}
+ * `component`, without a path of its own.
+ */
+export interface FallbackPage {
+    /** Dynamic import of the page module; its default export is the {@link PageComponent}. */
+    component: () => Promise<{
+        default: PageComponent;
+    }>;
+}
+/**
+ * The error detail handed to the `error` page. Redacted in production: the
+ * message is a generic `'Internal Server Error'` and there is no `stack`. In dev
+ * you get the real message plus the stack.
+ */
+export interface ErrorInfo {
+    /** The thrown error's message in dev; `'Internal Server Error'` in production. */
+    message: string;
+    /** The stack trace. Present in dev only. */
+    stack?: string;
+}
+/**
+ * Props for the `error` page declared in {@link RouteConfig.error} — the usual
+ * {@link PageProps} plus the redaction-aware {@link ErrorInfo}.
+ *
+ * @typeParam E - The app's Hono {@link Env}, forwarded to {@link PageProps.ctx}.
+ *
+ * @example
+ * ```tsx
+ * import type { ErrorPageProps } from '@rshono/core';
+ *
+ * export default function ServerError({ error }: ErrorPageProps) {
+ *   return <html><body><h1>Something went wrong</h1><p>{error.message}</p></body></html>;
+ * }
+ * ```
+ */
+export type ErrorPageProps<E extends Env = Env> = PageProps<string, E> & {
+    error: ErrorInfo;
+};
+/**
+ * The object form accepted by {@link defineRoutes}: the route table plus the two
+ * optional framework-owned pages.
+ *
+ * @typeParam TRoutes - Inferred tuple of route literals, which is what makes the
+ *   per-route `path` → props check possible.
+ */
+export interface RouteConfig<TRoutes extends readonly Route[] = readonly Route[]> {
+    /** Every page and endpoint in the app, matched in order. */
+    routes: TRoutes;
+    /** Page rendered with a 404 status for unmatched paths and for `notFound()` calls. */
+    notFound?: FallbackPage;
+    /** Page rendered with a 500 status when a request throws. Receives {@link ErrorPageProps}. */
+    error?: FallbackPage;
+}
+type ValidateRoute<R> = R extends {
+    path: infer P extends string;
+    component: () => Promise<{
+        default: PageComponent<infer CP>;
+    }>;
+} ? [PageProps<P, any>] extends [CP] ? R : R & {
+    component: `component props are not satisfied by PageProps<'${P}'>`;
+} : R;
+type ValidateRoutes<TRoutes extends readonly Route[]> = {
+    [K in keyof TRoutes]: ValidateRoute<TRoutes[K]>;
+};
+/**
+ * Declares the app's route table. Default-export the result as `routes` from
+ * `src/routes.ts` — the one file rshono requires.
+ *
+ * `routes.ts` only ever runs on the server, so importing server-only modules
+ * from it (e.g. inside `staticPaths`) is safe.
+ *
+ * Beyond typing the config, this cross-checks every page against its own path:
+ * if a component's props aren't satisfied by `PageProps<'<its path>'>`, the
+ * `component` field errors with `component props are not satisfied by
+ * PageProps<'/…'>`. Fix it by matching the page's `PageProps<Path>` type
+ * argument to the path it's mounted at.
+ *
+ * @param config - A {@link RouteConfig}, or a bare {@link Route} array as
+ *   shorthand when there are no `notFound` / `error` pages.
+ * @returns The config, unchanged and fully typed.
+ *
+ * @example
+ * ```ts
+ * // src/routes.ts
+ * import { defineRoutes } from '@rshono/core';
+ *
+ * export const routes = defineRoutes({
+ *   routes: [
+ *     { path: '/', component: () => import('./components/home') },
+ *     { path: '/profile/:id', component: () => import('./components/profile') },
+ *     {
+ *       path: '/docs/:slug',
+ *       render: 'static',
+ *       component: () => import('./components/documentation'),
+ *       staticPaths: async () => [{ slug: 'getting-started' }, { slug: 'deployment' }],
+ *     },
+ *     { type: 'endpoint', path: '/api/health', server: () => import('./health') },
+ *   ],
+ *   notFound: { component: () => import('./components/404') },
+ *   error: { component: () => import('./components/500') },
+ * });
+ * ```
+ *
+ * @example Array shorthand
+ * ```ts
+ * export const routes = defineRoutes([{ path: '/', component: () => import('./components/home') }]);
+ * ```
+ */
+export declare function defineRoutes<const TRoutes extends readonly Route[]>(config: RouteConfig<TRoutes> & {
+    routes: ValidateRoutes<TRoutes>;
+}): RouteConfig<TRoutes>;
+export declare function defineRoutes<const TRoutes extends readonly Route[]>(routes: TRoutes & ValidateRoutes<TRoutes>): RouteConfig<TRoutes>;
+export {};
+//# sourceMappingURL=router.d.ts.map

package/dist/router.d.ts.map

@@ -0,0 +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"}

package/dist/router.js

@@ -0,0 +1,18 @@
+/**
+ * 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');
+ * }
+ * ```
+ */
+export function isPageRoute(route) {
+    return route.type !== 'endpoint';
+}
+export function defineRoutes(input) {
+    return Array.isArray(input) ? { routes: input } : input;
+}
+//# sourceMappingURL=router.js.map

package/dist/router.js.map

@@ -0,0 +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"]}

package/dist/runtime/boundaries.d.ts

@@ -0,0 +1,102 @@
+import { Component, type ReactNode } from 'react';
+/**
+ * What an {@link ErrorBoundary} / {@link Boundary} 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).
+ *
+ * The render-function form only works when the boundary is used from a `'use
+ * client'` component — functions can't cross the server→client boundary. From a
+ * server component, pass a `ReactNode`.
+ */
+export type ErrorFallback = ReactNode | ((error: Error, reset: () => void) => ReactNode);
+export interface ErrorBoundaryProps {
+    /**
+     * 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
+     * the global error page) instead of handling it here.
+     */
+    fallback?: ErrorFallback;
+    /** Called with the caught error (for logging / reporting). */
+    onError?: (error: Error) => void;
+    /**
+     * When any value in this array changes while the boundary is showing its
+     * fallback, the error is cleared automatically. Pass the current pathname to
+     * recover when the user navigates away: `resetKeys={[useNavigation().url.pathname]}`.
+     */
+    resetKeys?: readonly unknown[];
+    children: ReactNode;
+}
+interface ErrorBoundaryState {
+    error: Error | null;
+}
+/**
+ * A general-purpose error boundary. Catches errors thrown while rendering its
+ * children — a client island that blew up, or a server component that rejected
+ * on a soft navigation — and renders `fallback` in their place instead of
+ * 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}
+ * when you also want a Suspense loading fallback in the same wrapper.
+ *
+ * @example
+ * ```tsx
+ * import { ErrorBoundary } from '@rshono/core/client';
+ *
+ * <ErrorBoundary fallback={(error, reset) => (
+ *   <div role="alert">
+ *     <p>{error.message}</p>
+ *     <button onClick={reset}>Try again</button>
+ *   </div>
+ * )}>
+ *   <RiskyWidget />
+ * </ErrorBoundary>
+ * ```
+ */
+export declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    state: ErrorBoundaryState;
+    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
+    componentDidCatch(error: Error): void;
+    componentDidUpdate(prev: ErrorBoundaryProps): void;
+    reset: () => void;
+    render(): ReactNode;
+}
+export interface BoundaryProps {
+    /** Suspense fallback, shown while the children (or their data) are still loading. */
+    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}. */
+    resetKeys?: readonly unknown[];
+    children: ReactNode;
+}
+/**
+ * A loading + error boundary in one wrapper — the common case for an async
+ * section of a page. It always renders the same shape:
+ *
+ * ```tsx
+ * <ErrorBoundary fallback={error}>
+ *   <Suspense fallback={loading}>{children}</Suspense>
+ * </ErrorBoundary>
+ * ```
+ *
+ * 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.
+ *
+ * @example
+ * ```tsx
+ * import { Boundary } from '@rshono/core/client';
+ *
+ * <Boundary loading={<Spinner />} error={(e, reset) => <Retry onClick={reset} />}>
+ *   <SlowServerComponent />
+ * </Boundary>
+ * ```
+ */
+export declare function Boundary({ loading, error, onError, resetKeys, children }: BoundaryProps): ReactNode;
+export {};
+//# sourceMappingURL=boundaries.d.ts.map

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

@@ -0,0 +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"}

package/dist/runtime/boundaries.js

@@ -0,0 +1,101 @@
+'use client';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Component, Suspense } from 'react';
+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.
+ * They're re-thrown to the root, where the runtime turns the digest into a real navigation.
+ */
+function isControlError(error) {
+    return isControlDigest(error?.digest);
+}
+function keysChanged(a, b) {
+    return a.length !== b.length || a.some((value, i) => !Object.is(value, b[i]));
+}
+/**
+ * A general-purpose error boundary. Catches errors thrown while rendering its
+ * children — a client island that blew up, or a server component that rejected
+ * on a soft navigation — and renders `fallback` in their place instead of
+ * 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}
+ * when you also want a Suspense loading fallback in the same wrapper.
+ *
+ * @example
+ * ```tsx
+ * import { ErrorBoundary } from '@rshono/core/client';
+ *
+ * <ErrorBoundary fallback={(error, reset) => (
+ *   <div role="alert">
+ *     <p>{error.message}</p>
+ *     <button onClick={reset}>Try again</button>
+ *   </div>
+ * )}>
+ *   <RiskyWidget />
+ * </ErrorBoundary>
+ * ```
+ */
+export class ErrorBoundary extends Component {
+    state = { error: null };
+    static getDerivedStateFromError(error) {
+        return { error };
+    }
+    componentDidCatch(error) {
+        if (isControlError(error))
+            return; // a redirect isn't an error to report
+        this.props.onError?.(error);
+    }
+    componentDidUpdate(prev) {
+        const { resetKeys } = this.props;
+        if (this.state.error && prev.resetKeys && resetKeys && keysChanged(prev.resetKeys, resetKeys)) {
+            this.reset();
+        }
+    }
+    reset = () => {
+        this.setState({ error: null });
+    };
+    render() {
+        const { error } = this.state;
+        if (error !== null) {
+            if (isControlError(error))
+                throw error; // navigation in flight — never show a fallback for it
+            const { fallback } = this.props;
+            if (fallback === undefined)
+                throw error; // no local fallback → propagate to an outer boundary
+            return typeof fallback === 'function' ? fallback(error, this.reset) : fallback;
+        }
+        return this.props.children;
+    }
+}
+/**
+ * A loading + error boundary in one wrapper — the common case for an async
+ * section of a page. It always renders the same shape:
+ *
+ * ```tsx
+ * <ErrorBoundary fallback={error}>
+ *   <Suspense fallback={loading}>{children}</Suspense>
+ * </ErrorBoundary>
+ * ```
+ *
+ * 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.
+ *
+ * @example
+ * ```tsx
+ * import { Boundary } from '@rshono/core/client';
+ *
+ * <Boundary loading={<Spinner />} error={(e, reset) => <Retry onClick={reset} />}>
+ *   <SlowServerComponent />
+ * </Boundary>
+ * ```
+ */
+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 }) }));
+}
+//# sourceMappingURL=boundaries.js.map

package/dist/runtime/boundaries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boundaries.js","sourceRoot":"","sources":["../../src/runtime/boundaries.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAEb,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAkB,MAAM,OAAO,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C;;;;;GAKG;AACH,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,eAAe,CAAE,KAAqC,EAAE,MAAM,CAAC,CAAC;AACzE,CAAC;AAmCD,SAAS,WAAW,CAAC,CAAqB,EAAE,CAAqB;IAC/D,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAChF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAiD;IAClF,KAAK,GAAuB,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAE5C,MAAM,CAAC,wBAAwB,CAAC,KAAY;QAC1C,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC;IAED,iBAAiB,CAAC,KAAY;QAC5B,IAAI,cAAc,CAAC,KAAK,CAAC;YAAE,OAAO,CAAC,sCAAsC;QACzE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,kBAAkB,CAAC,IAAwB;QACzC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACjC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,IAAI,SAAS,IAAI,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;YAC9F,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;IACH,CAAC;IAED,KAAK,GAAG,GAAS,EAAE;QACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC;IAEF,MAAM;QACJ,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC7B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,IAAI,cAAc,CAAC,KAAK,CAAC;gBAAE,MAAM,KAAK,CAAC,CAAC,sDAAsD;YAC9F,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;YAChC,IAAI,QAAQ,KAAK,SAAS;gBAAE,MAAM,KAAK,CAAC,CAAC,qDAAqD;YAC9F,OAAO,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACjF,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7B,CAAC;CACF;AAcD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAiB;IAC7F,OAAO,CACL,KAAC,aAAa,IAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,YACpE,KAAC,QAAQ,IAAC,QAAQ,EAAE,OAAO,YAAG,QAAQ,GAAY,GACpC,CACjB,CAAC;AACJ,CAAC","sourcesContent":["'use client';\n\nimport { Component, Suspense, type ReactNode } from 'react';\nimport { isControlDigest } from './control.js';\n\n/**\n * `redirect()` and `notFound()` reach the browser as a thrown error carrying a control digest.\n * They are navigation, not failure, so no boundary may absorb one — otherwise a `redirect()` from\n * a component inside a `<Boundary>` would render \"something went wrong\" instead of navigating.\n * They're re-thrown to the root, where the runtime turns the digest into a real navigation.\n */\nfunction isControlError(error: unknown): boolean {\n  return isControlDigest((error as { digest?: unknown } | null)?.digest);\n}\n\n/**\n * What an {@link ErrorBoundary} / {@link Boundary} renders once a child throws.\n * Either a static node, or a render function that also gets a `reset` callback\n * to clear the error and re-render the children (e.g. a \"Try again\" button).\n *\n * The render-function form only works when the boundary is used from a `'use\n * client'` component — functions can't cross the server→client boundary. From a\n * server component, pass a `ReactNode`.\n */\nexport type ErrorFallback = ReactNode | ((error: Error, reset: () => void) => ReactNode);\n\nexport interface ErrorBoundaryProps {\n  /**\n   * Rendered in place of the children after one of them throws. Omit it to\n   * report the error via `onError` and re-throw to the next boundary out (or\n   * the global error page) instead of handling it here.\n   */\n  fallback?: ErrorFallback;\n  /** Called with the caught error (for logging / reporting). */\n  onError?: (error: Error) => void;\n  /**\n   * When any value in this array changes while the boundary is showing its\n   * fallback, the error is cleared automatically. Pass the current pathname to\n   * recover when the user navigates away: `resetKeys={[useNavigation().url.pathname]}`.\n   */\n  resetKeys?: readonly unknown[];\n  children: ReactNode;\n}\n\ninterface ErrorBoundaryState {\n  error: Error | null;\n}\n\nfunction keysChanged(a: readonly unknown[], b: readonly unknown[]): boolean {\n  return a.length !== b.length || a.some((value, i) => !Object.is(value, b[i]));\n}\n\n/**\n * A general-purpose error boundary. Catches errors thrown while rendering its\n * children — a client island that blew up, or a server component that rejected\n * on a soft navigation — and renders `fallback` in their place instead of\n * tearing down the whole page.\n *\n * It's a `'use client'` component (React error boundaries must be), so drop it\n * anywhere in the tree from a server or client component. Use {@link Boundary}\n * when you also want a Suspense loading fallback in the same wrapper.\n *\n * @example\n * ```tsx\n * import { ErrorBoundary } from '@rshono/core/client';\n *\n * <ErrorBoundary fallback={(error, reset) => (\n *   <div role=\"alert\">\n *     <p>{error.message}</p>\n *     <button onClick={reset}>Try again</button>\n *   </div>\n * )}>\n *   <RiskyWidget />\n * </ErrorBoundary>\n * ```\n */\nexport class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {\n  state: ErrorBoundaryState = { error: null };\n\n  static getDerivedStateFromError(error: Error): ErrorBoundaryState {\n    return { error };\n  }\n\n  componentDidCatch(error: Error): void {\n    if (isControlError(error)) return; // a redirect isn't an error to report\n    this.props.onError?.(error);\n  }\n\n  componentDidUpdate(prev: ErrorBoundaryProps): void {\n    const { resetKeys } = this.props;\n    if (this.state.error && prev.resetKeys && resetKeys && keysChanged(prev.resetKeys, resetKeys)) {\n      this.reset();\n    }\n  }\n\n  reset = (): void => {\n    this.setState({ error: null });\n  };\n\n  render(): ReactNode {\n    const { error } = this.state;\n    if (error !== null) {\n      if (isControlError(error)) throw error; // navigation in flight — never show a fallback for it\n      const { fallback } = this.props;\n      if (fallback === undefined) throw error; // no local fallback → propagate to an outer boundary\n      return typeof fallback === 'function' ? fallback(error, this.reset) : fallback;\n    }\n    return this.props.children;\n  }\n}\n\nexport interface BoundaryProps {\n  /** Suspense fallback, shown while the children (or their data) are still loading. */\n  loading?: ReactNode;\n  /** Error fallback, shown if a child throws. See {@link ErrorFallback}. */\n  error?: ErrorFallback;\n  /** Called with the caught error. */\n  onError?: (error: Error) => void;\n  /** Clears the error fallback when any value changes — see {@link ErrorBoundaryProps.resetKeys}. */\n  resetKeys?: readonly unknown[];\n  children: ReactNode;\n}\n\n/**\n * A loading + error boundary in one wrapper — the common case for an async\n * section of a page. It always renders the same shape:\n *\n * ```tsx\n * <ErrorBoundary fallback={error}>\n *   <Suspense fallback={loading}>{children}</Suspense>\n * </ErrorBoundary>\n * ```\n *\n * so `error` catches anything the children throw (including while suspended) and\n * `loading` shows until they resolve. Both fallbacks are optional: omit\n * `loading` and nothing shows while loading; omit `error` and thrown errors\n * propagate to the next boundary out (or the global error page) rather than\n * being caught here.\n *\n * @example\n * ```tsx\n * import { Boundary } from '@rshono/core/client';\n *\n * <Boundary loading={<Spinner />} error={(e, reset) => <Retry onClick={reset} />}>\n *   <SlowServerComponent />\n * </Boundary>\n * ```\n */\nexport function Boundary({ loading = null, error, onError, resetKeys, children }: BoundaryProps): ReactNode {\n  return (\n    <ErrorBoundary fallback={error} onError={onError} resetKeys={resetKeys}>\n      <Suspense fallback={loading}>{children}</Suspense>\n    </ErrorBoundary>\n  );\n}\n"]}

package/dist/runtime/client.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `@rshono/core/client` — the browser-side surface, for use from `'use client'`
+ * modules: {@link useNavigation} for the current URL and soft navigation, and
+ * {@link Boundary} / {@link ErrorBoundary} / {@link NavigationProgress} as
+ * components.
+ *
+ * Every export is itself a `'use client'` module, so a server component can
+ * render {@link Boundary} or {@link NavigationProgress} directly — but the hook
+ * needs a client component. In a server component, read the same request data
+ * from `getContext()` in `@rshono/core/server`.
+ *
+ * @packageDocumentation
+ */
+export { NavigationProgress, useNavigation, type Navigation, type NavigationProgressProps, type Router } from './navigation.js';
+export { Boundary, ErrorBoundary, type BoundaryProps, type ErrorBoundaryProps, type ErrorFallback } from './boundaries.js';
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/runtime/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,KAAK,UAAU,EAAE,KAAK,uBAAuB,EAAE,KAAK,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAChI,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,aAAa,EAAE,KAAK,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,iBAAiB,CAAC"}