@rangojs/router 0.0.0-experimental.f2d1a2f1 → 0.0.0-experimental.f4a8e8de

package/dist/types/browser/rango-state.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Rango State
+ *
+ * Manages a session-cookie-based state value for HTTP cache invalidation. The
+ * value is sent as the `X-Rango-State` header on prefetch and navigation
+ * requests; the server responds with `Vary: X-Rango-State`, so the browser HTTP
+ * cache keys responses by (URL, X-Rango-State value).
+ *
+ * Value format: `{buildVersion}:{invalidationTimestamp}`
+ * - Build version changes on deploy, busting all cached prefetches at boot.
+ * - Timestamp rotates on invalidation (server action, invalidateClientCache).
+ *
+ * Storage is a session cookie named by the server-resolved name passed to
+ * initRangoState (`{prefix}_{routerId}`, default prefix `rango-state`). The
+ * cookie jar is shared across tabs, so a per-request read IS the cross-tab
+ * value sync — no `storage` event is needed. An in-memory mirror is a
+ * write-through copy that is authoritative only when the cookie is unreadable
+ * (e.g. a sandboxed frame, or site data blocked wholesale): the failure
+ * direction is always toward freshness.
+ *
+ * Precedence is load-bearing: when `document.cookie` is readable, the
+ * per-request read wins; the mirror is a fallback, never a cache of the read.
+ * Caching the read across requests would reintroduce the staleness this
+ * mechanism removes.
+ */
+/**
+ * Register the observer invoked when a read detects an EXTERNAL rotation (a
+ * sibling tab, a server `Set-Cookie`, or a cookie clear). Self-rotations
+ * (invalidateRangoState) update the mirror synchronously and never fire it.
+ */
+export declare function setRangoStateObserver(observer: ((value: string) => void) | null): void;
+/** Return the resolved cookie name used to namespace cross-tab messages. */
+export declare function getRangoStateCookieName(): string;
+/**
+ * Initialize the Rango state cookie at app startup. `version` is the build
+ * version; `stateCookieName` is the server-resolved cookie name from payload
+ * metadata (falls back to the bare default prefix when a payload arrives
+ * without it). Keeps an existing matching-version cookie (preserves the cache
+ * key across reloads); mints fresh on a version change or a missing cookie.
+ */
+export declare function initRangoState(version: string, stateCookieName?: string): void;
+/**
+ * Get the current Rango state value, used as the `X-Rango-State` header on
+ * prefetch and navigation requests. Reads the cookie every call (the read is
+ * the cross-tab sync channel) and reconciles the mirror.
+ */
+export declare function getRangoState(): string;
+/**
+ * Invalidate the Rango state (self-rotation). Called when the client clears its
+ * prefetch caches (e.g. via the server-action bridge). Rotates the timestamp,
+ * keeps the version, writes the cookie, and updates the mirror synchronously so
+ * the external-rotation observer is NOT triggered by our own write.
+ */
+export declare function invalidateRangoState(): void;
+/** Adopt the state carried by a same-origin cache-invalidation broadcast. */
+export declare function adoptRangoState(value: string): boolean;

package/dist/types/browser/react/Link.d.ts

@@ -0,0 +1,132 @@
+import React, { type ForwardRefExoticComponent, type RefAttributes } from "react";
+import { type LocationStateEntry } from "./location-state.js";
+/**
+ * State prop type for Link component.
+ * - LocationStateEntry[]: Type-safe state entries via createLocationState()
+ * - StateOrGetter: Plain state object or click-time getter function
+ * - Record<string, unknown>: Plain state object passed to history.pushState
+ */
+export type StateOrGetter<T = unknown> = T | (() => T);
+export type LinkState = LocationStateEntry[] | StateOrGetter<Record<string, unknown>>;
+import type { PrefetchStrategy } from "../../router/prefetch-default.js";
+export type { PrefetchStrategy } from "../../router/prefetch-default.js";
+export { resolveAdaptiveStrategy } from "../prefetch/default-strategy.js";
+/**
+ * Link component props
+ */
+export interface LinkProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "href"> {
+    /**
+     * The URL to navigate to (typically from router.reverse())
+     */
+    to: string;
+    /**
+     * Replace current history entry instead of pushing
+     */
+    replace?: boolean;
+    /**
+     * Scroll to top after navigation (default: true)
+     */
+    scroll?: boolean;
+    /**
+     * Force full document navigation instead of SPA
+     */
+    reloadDocument?: boolean;
+    /**
+     * Whether to revalidate server data on navigation.
+     * Set to `false` to skip the RSC server fetch and only update the URL.
+     *
+     * Only takes effect when the pathname stays the same (search param / hash changes).
+     * If the pathname changes, this option is ignored and a full navigation occurs.
+     *
+     * @default true
+     */
+    revalidate?: boolean;
+    /**
+     * Prefetch strategy for the link destination. When omitted, falls back to
+     * the router-wide default (`createRouter({ defaultPrefetch })`: `"none"` in
+     * development, `"viewport"` in production). An explicit value always wins
+     * over the router default, including `"none"` to opt a single Link out. An
+     * ancestor with `data-prefetch-scope="false"` or `"none"` remains a hard
+     * subtree opt-out.
+     *
+     * @default the router's environment-aware `defaultPrefetch`
+     */
+    prefetch?: PrefetchStrategy;
+    /**
+     * Opt-in override for the prefetch cache scope.
+     *
+     * The default cache is source-agnostic: one shared entry per target,
+     * keyed on Rango state + target URL. This is correct for routes whose
+     * response shape doesn't depend on where the user navigates from.
+     *
+     * Set `":source"` when this Link's response would legitimately differ
+     * based on the source page — typically when the target route (or one
+     * of its layouts) uses a custom `revalidate()` handler that reads
+     * `currentUrl` / `currentParams`, and the wildcard entry would
+     * therefore serve the wrong diff to a navigation from a different
+     * source.
+     *
+     * Intercept responses are auto-scoped to the source via a server-side
+     * tag, so `":source"` is only needed for custom revalidation logic.
+     *
+     * @example
+     * ```tsx
+     * // Route uses a `revalidate()` that branches on currentUrl — opt in
+     * // so prefetches don't bleed across source pages.
+     * <Link to="/dashboard" prefetch="hover" prefetchKey=":source" />
+     * ```
+     */
+    prefetchKey?: ":source";
+    /**
+     * State to pass to history.pushState/replaceState.
+     * Accessible via useLocationState() hook.
+     *
+     * @example
+     * ```tsx
+     * // Type-safe state with createLocationState (recommended)
+     * const ProductState = createLocationState<{ name: string; price: number }>();
+     * <Link to="/product" state={[ProductState({ name: product.name, price: product.price })]}>
+     *   View
+     * </Link>
+     *
+     * // Type-safe just-in-time state (getter called at click time, not render time).
+     * // Must be in a client component -- getter can't cross the RSC boundary.
+     * <Link
+     *   to="/product"
+     *   state={[ProductState(() => ({ name: product.name, price: product.price }))]}
+     * >
+     *   View
+     * </Link>
+     *
+     * // Multiple typed states
+     * <Link to="/checkout" state={[ProductState({ name: p.name, price: p.price }), CartState(c)]}>
+     *   Checkout
+     * </Link>
+     *
+     * // Plain static state
+     * <Link to="/product" state={{ from: "list" }}>View</Link>
+     *
+     * // Plain just-in-time state (called at click time, requires client component)
+     * <Link to="/product" state={() => ({ scrollY: window.scrollY })}>View</Link>
+     * ```
+     */
+    state?: LinkState;
+    children: React.ReactNode;
+}
+/**
+ * Type-safe Link component for SPA navigation
+ *
+ * Works with router.reverse() for type-safe URLs:
+ * ```tsx
+ * <Link to={router.reverse("shop.products.detail", { slug: "my-product" })}>
+ *   View Product
+ * </Link>
+ * ```
+ *
+ * Also supports regular URLs:
+ * ```tsx
+ * <Link to="/about">About</Link>
+ * <Link to="https://example.com">External</Link>
+ * ```
+ */
+export declare const Link: ForwardRefExoticComponent<LinkProps & RefAttributes<HTMLAnchorElement>>;

package/dist/types/browser/react/NavigationProvider.d.ts

@@ -0,0 +1,88 @@
+import { type ReactNode } from "react";
+import type { NavigationStore, NavigationUpdate, NavigationBridge } from "../types.js";
+import type { EventController } from "../event-controller.js";
+import type { ResolvedThemeConfig, Theme } from "../../theme/types.js";
+import { type AppShellRef } from "../app-shell.js";
+/**
+ * Props for NavigationProvider
+ */
+export interface NavigationProviderProps {
+    /**
+     * Navigation store instance (for cache/segment management)
+     */
+    store: NavigationStore;
+    /**
+     * Event controller instance (for navigation/action state)
+     */
+    eventController: EventController;
+    /**
+     * Initial rendered tree + metadata from server payload
+     */
+    initialPayload: NavigationUpdate;
+    /**
+     * Navigation bridge for handling navigation
+     */
+    bridge: NavigationBridge;
+    /**
+     * Theme configuration (null if theme not enabled)
+     * When provided, wraps content in ThemeProvider
+     */
+    themeConfig?: ResolvedThemeConfig | null;
+    /**
+     * Initial theme from server (from cookie)
+     * Only used when themeConfig is provided
+     */
+    initialTheme?: Theme;
+    /**
+     * Whether connection warmup is enabled.
+     * When true, keeps TLS alive by sending HEAD requests after idle periods.
+     */
+    warmupEnabled?: boolean;
+    /**
+     * App version from server payload.
+     * Used only as a fallback when `appShellRef` is not supplied.
+     */
+    version?: string;
+    /**
+     * URL prefix for all routes (from createRouter({ basename })).
+     * Used only as a fallback when `appShellRef` is not supplied.
+     */
+    basename?: string;
+    /**
+     * App-shell ref. When provided, the context's `basename` and `version` are
+     * read through it (live getters) so they don't close over a stale snapshot or
+     * invalidate the memoized context value. The shell is set once at init and is
+     * not swapped within a session — a cross-app navigation is a full document
+     * load (X-RSC-Reload), so the target app establishes its own shell on load.
+     */
+    appShellRef?: AppShellRef;
+    /**
+     * CSP nonce to expose via NonceContext. Production leaves this undefined — the
+     * browser has no nonce (it is a server-side HTML concern), and SSR provides the
+     * nonce through its own NonceContext.Provider. Test harnesses (renderRoute) set
+     * it to seed a nonce so components calling useNonce() can be exercised.
+     */
+    nonce?: string;
+}
+/**
+ * Navigation provider component
+ *
+ * Provides navigation context to the component tree and handles:
+ * - Providing stable store and event controller references (never re-renders consumers)
+ * - Subscribing to UI updates to re-render the tree
+ * - Providing navigate/refresh methods (delegated to bridge)
+ *
+ * State subscriptions happen via useNavigation hook (via event controller), not via context.
+ * This means context consumers don't re-render on state changes.
+ *
+ * @example
+ * ```tsx
+ * <NavigationProvider
+ *   store={store}
+ *   eventController={eventController}
+ *   initialPayload={payload}
+ *   bridge={navigationBridge}
+ * />
+ * ```
+ */
+export declare function NavigationProvider({ store, eventController, initialPayload, bridge, themeConfig, initialTheme, warmupEnabled, version, basename, appShellRef, nonce, }: NavigationProviderProps): ReactNode;

package/dist/types/browser/react/ScrollRestoration.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Props for ScrollRestoration component
+ */
+export interface ScrollRestorationProps {
+    /**
+     * Custom function to determine the scroll restoration key.
+     * By default, uses a unique key per history entry (location.key).
+     *
+     * Return location.pathname to restore scroll based on path
+     * (useful for keeping scroll position on the same page).
+     *
+     * Provide a stable reference: a module-level function or one wrapped in
+     * useCallback. The init effect re-runs when getKey's identity changes, and
+     * teardown clears in-memory scroll positions — a fresh inline arrow on every
+     * parent render would discard unpersisted positions mid-session.
+     *
+     * @example
+     * ```tsx
+     * // Stable module-level getKey (recommended)
+     * const byPathname = (location) => location.pathname;
+     *
+     * // Restore based on pathname (same URL = same scroll)
+     * <ScrollRestoration getKey={byPathname} />
+     *
+     * // Restore based on unique history entry (default)
+     * // <ScrollRestoration /> — omit getKey to use location.key
+     * ```
+     */
+    getKey?: (location: {
+        pathname: string;
+        search: string;
+        hash: string;
+        key: string;
+    }) => string;
+}
+/**
+ * ScrollRestoration component
+ *
+ * Enables scroll position restoration across navigations:
+ * - Saves scroll positions to sessionStorage
+ * - Restores scroll on back/forward navigation
+ * - Scrolls to top on new navigation
+ * - Supports hash link scrolling
+ *
+ * Should be rendered once in your app, typically in the root layout.
+ *
+ * @example
+ * ```tsx
+ * // In your root layout
+ * export default function RootLayout({ children }) {
+ *   return (
+ *     <html>
+ *       <body>
+ *         <ScrollRestoration />
+ *         {children}
+ *       </body>
+ *     </html>
+ *   );
+ * }
+ * ```
+ */
+export declare function ScrollRestoration({ getKey }: ScrollRestorationProps): null;
+/**
+ * Hook to initialize scroll restoration
+ *
+ * Alternative to the ScrollRestoration component for more control.
+ *
+ * @example
+ * ```tsx
+ * function App() {
+ *   useScrollRestoration();
+ *   return <div>...</div>;
+ * }
+ * ```
+ */
+export declare function useScrollRestoration(options?: {
+    getKey?: ScrollRestorationProps["getKey"];
+}): void;

package/dist/types/browser/react/context.d.ts

@@ -0,0 +1,57 @@
+import { type Context } from "react";
+import type { NavigationStore, NavigateOptions } from "../types.js";
+import type { EventController } from "../event-controller.js";
+import type { PrefetchStrategy } from "../../router/prefetch-default.js";
+/**
+ * Navigation context value provided by NavigationProvider
+ *
+ * This context provides a STABLE reference to the store, event controller, and methods.
+ * The store itself never changes, so context consumers don't re-render
+ * when navigation state changes.
+ *
+ * Components subscribe to state changes via eventController.subscribe() in useNavigation.
+ */
+export interface NavigationStoreContextValue {
+    /**
+     * The navigation store instance (stable reference)
+     * Used for cache/segment management
+     */
+    store: NavigationStore;
+    /**
+     * The event controller instance (stable reference)
+     * Used for navigation/action state
+     */
+    eventController: EventController;
+    /**
+     * Navigate to a new URL
+     *
+     * @param url - The URL to navigate to
+     * @param options - Navigation options (replace, scroll)
+     * @returns Promise that resolves when navigation is complete
+     */
+    navigate: (url: string, options?: NavigateOptions) => Promise<void>;
+    /**
+     * Refresh the current route
+     *
+     * @returns Promise that resolves when refresh is complete
+     */
+    refresh: () => Promise<void>;
+    /**
+     * App version from the initial server payload.
+     */
+    version: string | undefined;
+    /**
+     * URL prefix for all routes (from createRouter({ basename })).
+     * Used by Link and useRouter() to auto-prefix app-local paths.
+     */
+    basename: string | undefined;
+    /** Router default from this instance's initial payload. */
+    defaultPrefetch?: PrefetchStrategy;
+}
+/**
+ * React context for navigation store
+ *
+ * Provides stable reference to the store - does NOT re-render on state changes.
+ * Use useNavigation hook for reactive state access.
+ */
+export declare const NavigationStoreContext: Context<NavigationStoreContextValue | null>;

package/dist/types/browser/react/filter-segment-order.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Build the handle-collection segment order from a raw `matched` list.
+ *
+ * Two responsibilities:
+ *
+ * 1. Drop loader sub-ids ("D" followed by a digit, e.g. "M0L0D1.user") —
+ *    loaders never push handles.
+ *
+ * 2. Place each parallel slot id (contains ".@") immediately after its
+ *    parent layout/route id. Raw segment-resolution emission order does NOT
+ *    guarantee this: route-mounted parallels are resolved/pushed BEFORE the
+ *    route handler's segment is appended (see fresh.ts:resolveSegment for
+ *    routes, and revalidation.ts ~915-919), so matched can read
+ *    `[..., R0.@panel, R0]`. collectHandleData consumes segmentOrder verbatim
+ *    with later-wins semantics, so without normalization the route handler's
+ *    Meta would override the slot's more-specific Meta — backwards.
+ *
+ * Slot-id format is `<parentShortCode>.@<slotName>`; `parentShortCode` never
+ * contains ".@", so splitting at the first ".@" reliably yields the parent.
+ */
+export declare function filterSegmentOrder(matched: string[]): string[];
+/**
+ * Build the "layouts and routes only" id list for useSegments().segmentIds.
+ *
+ * Strips parallel slot ids (contain ".@") and loader sub-ids ("D" followed by
+ * a digit, e.g. "M0L0D1.user") without reordering. Distinct from
+ * filterSegmentOrder, which also reorders slots after their parent for handle
+ * collection.
+ *
+ * Shared by SSR (ssr/index.tsx) and the client event controller
+ * (event-controller.ts) so both produce identical output; if they diverge,
+ * useSegments().segmentIds rendered during SSR and after hydration disagree
+ * and React reports a hydration mismatch.
+ */
+export declare function filterRouteSegmentIds(matched: string[]): string[];

package/dist/types/browser/react/index.d.ts

@@ -0,0 +1 @@
+export { NavigationProvider, type NavigationProviderProps, } from "./NavigationProvider.js";

package/dist/types/browser/react/location-state-shared.d.ts

@@ -0,0 +1,162 @@
+import type { ReactElement } from "react";
+/**
+ * Internal entry representing a state value with its unique key.
+ * When __rsc_ls_lazy is true, __rsc_ls_value holds a getter function
+ * that is called at navigation time (not at entry creation time).
+ */
+export interface LocationStateEntry {
+    readonly __rsc_ls_key: string;
+    readonly __rsc_ls_value: unknown;
+    readonly __rsc_ls_lazy?: boolean;
+}
+/**
+ * Options for createLocationState
+ */
+export interface LocationStateOptions {
+    /** When true, the state is cleared from history after first read (flash message pattern) */
+    flash?: boolean;
+}
+type LocationStateUnsafeFn = (...args: never[]) => unknown;
+type LocationStateUnsafeCtor = abstract new (...args: never[]) => unknown;
+type IsAny<T> = 0 extends 1 & T ? true : false;
+type IsUnknown<T> = IsAny<T> extends true ? false : unknown extends T ? true : false;
+/**
+ * Branded error surfaced when a value that cannot live in location state is
+ * used. Location state is written into `history.state`, which uses the
+ * structured clone algorithm; React elements, functions, and symbols throw a
+ * `DataCloneError` at runtime. Carries a human-readable reason so the compile
+ * error explains the fix.
+ */
+export type LocationStateUnsafe<Reason extends string> = {
+    readonly __rango_location_state_unsafe: Reason;
+};
+/**
+ * Maps `T` to itself when it is safe to store in location state, or to a branded
+ * {@link LocationStateUnsafe} error for the disallowed parts: `unknown`, React
+ * elements (RSC/JSX content), functions, class constructors, and symbols.
+ * Recurses through arrays, `Map`, `Set`, and plain objects; structured-clone
+ * built-ins (`Date`, `RegExp`, typed arrays, `Blob`, `File`, `FormData`) pass
+ * through. Consumed by {@link ValidateLocationState}, which is intersected into a
+ * definition's value parameter so posting RSC content is a COMPILE error, not a
+ * runtime `DataCloneError`. (`any` is unguardable and remains an escape hatch.)
+ */
+export type LocationStateSafe<T> = IsUnknown<T> extends true ? LocationStateUnsafe<"location state needs an explicit, concrete type; `unknown` cannot be verified as serializable"> : T extends LocationStateUnsafeFn ? LocationStateUnsafe<"functions cannot be stored in location state"> : T extends LocationStateUnsafeCtor ? LocationStateUnsafe<"class constructors cannot be stored in location state"> : T extends symbol ? LocationStateUnsafe<"symbols cannot be stored in location state"> : T extends ReactElement ? LocationStateUnsafe<"React/RSC content cannot be stored in location state; store plain data and render it on arrival"> : T extends string | number | boolean | bigint | null | undefined ? T : T extends Date | RegExp | ArrayBuffer | ArrayBufferView | Blob | File | FormData ? T : T extends ReadonlyMap<infer K, infer V> ? ReadonlyMap<LocationStateSafe<K>, LocationStateSafe<V>> : T extends ReadonlySet<infer V> ? ReadonlySet<LocationStateSafe<V>> : T extends readonly unknown[] ? {
+    [K in keyof T]: LocationStateSafe<T[K]>;
+} : T extends object ? {
+    [K in keyof T]: LocationStateSafe<T[K]>;
+} : T;
+/**
+ * `unknown` (a no-op) when `T` is safe to store in location state, otherwise a
+ * branded {@link LocationStateUnsafe} object. Intersected into the value
+ * parameter of a definition's call and `write()` so POSTING RSC content (or any
+ * non-serializable value) is a compile error whose text carries the reason —
+ * without a `TState extends ...` self-constraint, which TypeScript rejects as
+ * circular (TS2313). For safe `T`, `value & unknown` collapses back to `value`,
+ * so valid usage is unchanged.
+ */
+export type ValidateLocationState<T> = [T] extends [LocationStateSafe<T>] ? unknown : LocationStateUnsafe<"location state must be serializable: React/RSC content, functions, and symbols cannot be stored — pass plain data and render it on arrival">;
+/**
+ * Type-safe location state definition
+ *
+ * Created via createLocationState(), used with Link's state prop
+ * and useLocationState() hook.
+ */
+export interface LocationStateDefinition<TArgs extends unknown[], TState> {
+    (...args: TArgs): LocationStateEntry;
+    /** Injected by Vite plugin - do not set manually */
+    __rsc_ls_key: string;
+    /** Whether this state auto-clears after first read */
+    readonly __rsc_ls_flash: boolean;
+    /**
+     * Read the current value from history.state.
+     *
+     * Returns undefined during SSR (no `window`). To stay hydration-safe, do
+     * NOT call read() inline during the initial render — the server returns
+     * undefined while the client may have a value preserved in history.state
+     * (e.g. after a hard reload of an entry that earlier called write()),
+     * which causes a hydration mismatch. Call read() inside an event handler
+     * or a useEffect post-mount instead, or use useLocationState() if you
+     * want React to manage subscription/hydration for you.
+     */
+    read(): TState | undefined;
+    /**
+     * Statically write the value into the current history entry under this
+     * definition's key, preserving any other keys already on history.state
+     * (e.g. router bookkeeping, other LocationState slots).
+     *
+     * This is the non-reactive counterpart to read(): it does not dispatch any
+     * event, so components reading via useLocationState() will NOT re-render
+     * until the next navigation/popstate. Use it when you only need the value
+     * to be there on the next read() or on the next mount (including after
+     * back/forward and hard refresh of the same entry).
+     *
+     * Client-only: throws when called on the server (no history available).
+     */
+    write(value: TState & ValidateLocationState<TState>): void;
+    /**
+     * Statically remove this definition's slot from the current history entry,
+     * leaving any other keys on history.state untouched. Idempotent: removing
+     * a slot that isn't present is a no-op.
+     *
+     * Same non-reactive semantics as write(): no event is dispatched, so
+     * useLocationState() readers will NOT re-render until the next navigation.
+     *
+     * Client-only: throws when called on the server (no history available).
+     */
+    delete(): void;
+}
+/**
+ * Create a type-safe location state definition
+ *
+ * The key is auto-injected by the Vite exposeInternalIds plugin as a property
+ * based on file path and export name. No manual key required.
+ *
+ * @param options Optional configuration
+ * @returns A typed state definition for use with Link and useLocationState
+ *
+ * @example
+ * ```typescript
+ * // Persistent state (survives back/forward)
+ * export const ProductState = createLocationState<{ name: string; price: number }>();
+ *
+ * // Flash state (cleared after first read)
+ * export const FlashMessage = createLocationState<{ text: string }>({ flash: true });
+ *
+ * // Use in Link
+ * <Link to="/product/123" state={[ProductState({ name: "Widget", price: 9.99 })]}>
+ *
+ * // Just-in-time typed state (getter called at click time, not render time).
+ * // Must be in a client component — the getter function can't cross the RSC boundary.
+ * <Link
+ *   to="/product/123"
+ *   state={[ProductState(() => ({ name: product.name, price: product.price }))]}
+ * >
+ *
+ * // Read with hook (reactive)
+ * const product = useLocationState(ProductState);
+ *
+ * // Read without hook (snapshot, client-side only)
+ * const snap = ProductState.read();
+ *
+ * // Static write to current history entry (non-reactive, client-side only).
+ * // Survives back/forward and hard refresh; useLocationState() readers will
+ * // NOT see the new value until the next navigation. Pair with .read() or a
+ * // fresh mount.
+ * ProductState.write({ name: "Widget", price: 9.99 });
+ *
+ * // Manually clear the slot (non-reactive, client-side only).
+ * ProductState.delete();
+ * ```
+ */
+export declare function createLocationState<TState>(options?: LocationStateOptions): LocationStateDefinition<[
+    (TState | (() => TState)) & ValidateLocationState<TState>
+], TState>;
+/**
+ * Check if a value is a LocationStateEntry
+ */
+export declare function isLocationStateEntry(value: unknown): value is LocationStateEntry;
+/**
+ * Resolve state entries into a flat object for history.state
+ */
+export declare function resolveLocationStateEntries(entries: LocationStateEntry[]): Record<string, unknown>;
+export {};

package/dist/types/browser/react/location-state.d.ts

@@ -0,0 +1,29 @@
+import type { LocationStateDefinition } from "./location-state-shared.js";
+export { createLocationState, isLocationStateEntry, resolveLocationStateEntries, type LocationStateEntry, type LocationStateDefinition, type LocationStateOptions, } from "./location-state-shared.js";
+/**
+ * Hook to read location state from history.state
+ *
+ * Behavior depends on the definition:
+ * - Normal state: persists across navigations, reactive to popstate
+ * - Flash state (created with { flash: true }): read once, cleared after paint
+ *
+ * Overloaded:
+ * - With definition: Returns typed state from the specific key
+ * - With type param only: Returns plain state from history.state.state
+ *
+ * @example
+ * ```typescript
+ * // Persistent state
+ * const ProductState = createLocationState<{ name: string }>();
+ * const state = useLocationState(ProductState);
+ *
+ * // Flash state (auto-clears after paint)
+ * const FlashMsg = createLocationState<{ text: string }>({ flash: true });
+ * const flash = useLocationState(FlashMsg);
+ *
+ * // Plain state access (reads from history.state.state)
+ * const state = useLocationState<{ from?: string }>();
+ * ```
+ */
+export declare function useLocationState<TArgs extends unknown[], TState>(definition: LocationStateDefinition<TArgs, TState>): TState | undefined;
+export declare function useLocationState<T = unknown>(): T | undefined;

package/dist/types/browser/react/mount-context.d.ts

@@ -0,0 +1,23 @@
+import { type Context, type ReactNode } from "react";
+/**
+ * Context for the current include() mount path.
+ *
+ * Each include() wraps its subtree with a MountContext.Provider
+ * carrying the URL prefix. Nested includes override the context,
+ * so useMount() returns the nearest mount path.
+ *
+ * Default value "/" means root-level (no include wrapping).
+ */
+export declare const MountContext: Context<string>;
+/**
+ * Provider wrapper for MountContext.
+ *
+ * RSC server components cannot use MountContext.Provider directly because
+ * .Provider is a property on the context object, not a named export.
+ * Client reference proxies on the RSC server return undefined for property
+ * access. This wrapper is a proper "use client" export that RSC can reference.
+ */
+export declare function MountContextProvider({ value, children, }: {
+    value: string;
+    children: ReactNode;
+}): ReactNode;