npm - @rangojs/router - Versions diffs - 0.0.0-experimental.0f44aca1 - Mend

@rangojs/router 0.0.0-experimental.0f44aca1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (305) hide show

package/AGENTS.md +5 -0
package/README.md +899 -0
package/dist/bin/rango.js +1601 -0
package/dist/vite/index.js +5214 -0
package/package.json +176 -0
package/skills/breadcrumbs/SKILL.md +250 -0
package/skills/cache-guide/SKILL.md +262 -0
package/skills/caching/SKILL.md +220 -0
package/skills/composability/SKILL.md +172 -0
package/skills/debug-manifest/SKILL.md +112 -0
package/skills/document-cache/SKILL.md +182 -0
package/skills/fonts/SKILL.md +167 -0
package/skills/hooks/SKILL.md +704 -0
package/skills/host-router/SKILL.md +218 -0
package/skills/intercept/SKILL.md +313 -0
package/skills/layout/SKILL.md +310 -0
package/skills/links/SKILL.md +239 -0
package/skills/loader/SKILL.md +596 -0
package/skills/middleware/SKILL.md +339 -0
package/skills/mime-routes/SKILL.md +128 -0
package/skills/parallel/SKILL.md +305 -0
package/skills/prerender/SKILL.md +643 -0
package/skills/rango/SKILL.md +118 -0
package/skills/response-routes/SKILL.md +411 -0
package/skills/route/SKILL.md +385 -0
package/skills/router-setup/SKILL.md +439 -0
package/skills/tailwind/SKILL.md +129 -0
package/skills/theme/SKILL.md +79 -0
package/skills/typesafety/SKILL.md +623 -0
package/skills/use-cache/SKILL.md +324 -0
package/src/__internal.ts +273 -0
package/src/bin/rango.ts +321 -0
package/src/browser/action-coordinator.ts +97 -0
package/src/browser/action-response-classifier.ts +99 -0
package/src/browser/event-controller.ts +899 -0
package/src/browser/history-state.ts +80 -0
package/src/browser/index.ts +18 -0
package/src/browser/intercept-utils.ts +52 -0
package/src/browser/link-interceptor.ts +141 -0
package/src/browser/logging.ts +55 -0
package/src/browser/merge-segment-loaders.ts +134 -0
package/src/browser/navigation-bridge.ts +645 -0
package/src/browser/navigation-client.ts +215 -0
package/src/browser/navigation-store.ts +806 -0
package/src/browser/navigation-transaction.ts +295 -0
package/src/browser/network-error-handler.ts +61 -0
package/src/browser/partial-update.ts +550 -0
package/src/browser/prefetch/cache.ts +146 -0
package/src/browser/prefetch/fetch.ts +135 -0
package/src/browser/prefetch/observer.ts +65 -0
package/src/browser/prefetch/policy.ts +42 -0
package/src/browser/prefetch/queue.ts +88 -0
package/src/browser/rango-state.ts +112 -0
package/src/browser/react/Link.tsx +360 -0
package/src/browser/react/NavigationProvider.tsx +386 -0
package/src/browser/react/ScrollRestoration.tsx +94 -0
package/src/browser/react/context.ts +59 -0
package/src/browser/react/filter-segment-order.ts +11 -0
package/src/browser/react/index.ts +52 -0
package/src/browser/react/location-state-shared.ts +162 -0
package/src/browser/react/location-state.ts +107 -0
package/src/browser/react/mount-context.ts +37 -0
package/src/browser/react/nonce-context.ts +23 -0
package/src/browser/react/shallow-equal.ts +27 -0
package/src/browser/react/use-action.ts +218 -0
package/src/browser/react/use-client-cache.ts +58 -0
package/src/browser/react/use-handle.ts +162 -0
package/src/browser/react/use-href.tsx +40 -0
package/src/browser/react/use-link-status.ts +135 -0
package/src/browser/react/use-mount.ts +31 -0
package/src/browser/react/use-navigation.ts +99 -0
package/src/browser/react/use-params.ts +65 -0
package/src/browser/react/use-pathname.ts +47 -0
package/src/browser/react/use-router.ts +63 -0
package/src/browser/react/use-search-params.ts +56 -0
package/src/browser/react/use-segments.ts +171 -0
package/src/browser/response-adapter.ts +73 -0
package/src/browser/rsc-router.tsx +431 -0
package/src/browser/scroll-restoration.ts +400 -0
package/src/browser/segment-reconciler.ts +216 -0
package/src/browser/segment-structure-assert.ts +83 -0
package/src/browser/server-action-bridge.ts +667 -0
package/src/browser/shallow.ts +40 -0
package/src/browser/types.ts +538 -0
package/src/browser/validate-redirect-origin.ts +29 -0
package/src/build/generate-manifest.ts +438 -0
package/src/build/generate-route-types.ts +36 -0
package/src/build/index.ts +35 -0
package/src/build/route-trie.ts +265 -0
package/src/build/route-types/ast-helpers.ts +25 -0
package/src/build/route-types/ast-route-extraction.ts +98 -0
package/src/build/route-types/codegen.ts +102 -0
package/src/build/route-types/include-resolution.ts +411 -0
package/src/build/route-types/param-extraction.ts +48 -0
package/src/build/route-types/per-module-writer.ts +128 -0
package/src/build/route-types/router-processing.ts +469 -0
package/src/build/route-types/scan-filter.ts +78 -0
package/src/build/runtime-discovery.ts +231 -0
package/src/cache/background-task.ts +34 -0
package/src/cache/cache-key-utils.ts +44 -0
package/src/cache/cache-policy.ts +125 -0
package/src/cache/cache-runtime.ts +338 -0
package/src/cache/cache-scope.ts +382 -0
package/src/cache/cf/cf-cache-store.ts +540 -0
package/src/cache/cf/index.ts +25 -0
package/src/cache/document-cache.ts +369 -0
package/src/cache/handle-capture.ts +81 -0
package/src/cache/handle-snapshot.ts +41 -0
package/src/cache/index.ts +43 -0
package/src/cache/memory-segment-store.ts +328 -0
package/src/cache/profile-registry.ts +73 -0
package/src/cache/read-through-swr.ts +134 -0
package/src/cache/segment-codec.ts +256 -0
package/src/cache/taint.ts +98 -0
package/src/cache/types.ts +342 -0
package/src/client.rsc.tsx +85 -0
package/src/client.tsx +601 -0
package/src/component-utils.ts +76 -0
package/src/components/DefaultDocument.tsx +27 -0
package/src/context-var.ts +86 -0
package/src/debug.ts +243 -0
package/src/default-error-boundary.tsx +88 -0
package/src/deps/browser.ts +8 -0
package/src/deps/html-stream-client.ts +2 -0
package/src/deps/html-stream-server.ts +2 -0
package/src/deps/rsc.ts +10 -0
package/src/deps/ssr.ts +2 -0
package/src/errors.ts +365 -0
package/src/handle.ts +135 -0
package/src/handles/MetaTags.tsx +246 -0
package/src/handles/breadcrumbs.ts +66 -0
package/src/handles/index.ts +7 -0
package/src/handles/meta.ts +264 -0
package/src/host/cookie-handler.ts +165 -0
package/src/host/errors.ts +97 -0
package/src/host/index.ts +53 -0
package/src/host/pattern-matcher.ts +214 -0
package/src/host/router.ts +352 -0
package/src/host/testing.ts +79 -0
package/src/host/types.ts +146 -0
package/src/host/utils.ts +25 -0
package/src/href-client.ts +222 -0
package/src/index.rsc.ts +233 -0
package/src/index.ts +277 -0
package/src/internal-debug.ts +11 -0
package/src/loader.rsc.ts +89 -0
package/src/loader.ts +64 -0
package/src/network-error-thrower.tsx +23 -0
package/src/outlet-context.ts +15 -0
package/src/outlet-provider.tsx +45 -0
package/src/prerender/param-hash.ts +37 -0
package/src/prerender/store.ts +185 -0
package/src/prerender.ts +463 -0
package/src/reverse.ts +330 -0
package/src/root-error-boundary.tsx +289 -0
package/src/route-content-wrapper.tsx +196 -0
package/src/route-definition/dsl-helpers.ts +934 -0
package/src/route-definition/helper-factories.ts +200 -0
package/src/route-definition/helpers-types.ts +430 -0
package/src/route-definition/index.ts +52 -0
package/src/route-definition/redirect.ts +93 -0
package/src/route-definition.ts +1 -0
package/src/route-map-builder.ts +275 -0
package/src/route-name.ts +53 -0
package/src/route-types.ts +259 -0
package/src/router/content-negotiation.ts +116 -0
package/src/router/debug-manifest.ts +72 -0
package/src/router/error-handling.ts +287 -0
package/src/router/find-match.ts +158 -0
package/src/router/handler-context.ts +451 -0
package/src/router/intercept-resolution.ts +395 -0
package/src/router/lazy-includes.ts +234 -0
package/src/router/loader-resolution.ts +420 -0
package/src/router/logging.ts +248 -0
package/src/router/manifest.ts +267 -0
package/src/router/match-api.ts +620 -0
package/src/router/match-context.ts +266 -0
package/src/router/match-handlers.ts +440 -0
package/src/router/match-middleware/background-revalidation.ts +223 -0
package/src/router/match-middleware/cache-lookup.ts +634 -0
package/src/router/match-middleware/cache-store.ts +295 -0
package/src/router/match-middleware/index.ts +81 -0
package/src/router/match-middleware/intercept-resolution.ts +306 -0
package/src/router/match-middleware/segment-resolution.ts +192 -0
package/src/router/match-pipelines.ts +179 -0
package/src/router/match-result.ts +219 -0
package/src/router/metrics.ts +282 -0
package/src/router/middleware-cookies.ts +55 -0
package/src/router/middleware-types.ts +222 -0
package/src/router/middleware.ts +748 -0
package/src/router/pattern-matching.ts +563 -0
package/src/router/prerender-match.ts +402 -0
package/src/router/preview-match.ts +170 -0
package/src/router/revalidation.ts +289 -0
package/src/router/router-context.ts +316 -0
package/src/router/router-interfaces.ts +452 -0
package/src/router/router-options.ts +592 -0
package/src/router/router-registry.ts +24 -0
package/src/router/segment-resolution/fresh.ts +570 -0
package/src/router/segment-resolution/helpers.ts +263 -0
package/src/router/segment-resolution/loader-cache.ts +198 -0
package/src/router/segment-resolution/revalidation.ts +1239 -0
package/src/router/segment-resolution/static-store.ts +67 -0
package/src/router/segment-resolution.ts +21 -0
package/src/router/segment-wrappers.ts +289 -0
package/src/router/telemetry-otel.ts +299 -0
package/src/router/telemetry.ts +300 -0
package/src/router/timeout.ts +148 -0
package/src/router/trie-matching.ts +239 -0
package/src/router/types.ts +170 -0
package/src/router.ts +1002 -0
package/src/rsc/handler-context.ts +45 -0
package/src/rsc/handler.ts +1089 -0
package/src/rsc/helpers.ts +198 -0
package/src/rsc/index.ts +36 -0
package/src/rsc/loader-fetch.ts +209 -0
package/src/rsc/manifest-init.ts +86 -0
package/src/rsc/nonce.ts +32 -0
package/src/rsc/origin-guard.ts +141 -0
package/src/rsc/progressive-enhancement.ts +379 -0
package/src/rsc/response-error.ts +37 -0
package/src/rsc/response-route-handler.ts +347 -0
package/src/rsc/rsc-rendering.ts +235 -0
package/src/rsc/runtime-warnings.ts +42 -0
package/src/rsc/server-action.ts +348 -0
package/src/rsc/ssr-setup.ts +128 -0
package/src/rsc/types.ts +263 -0
package/src/search-params.ts +230 -0
package/src/segment-system.tsx +454 -0
package/src/server/context.ts +591 -0
package/src/server/cookie-store.ts +190 -0
package/src/server/fetchable-loader-store.ts +37 -0
package/src/server/handle-store.ts +308 -0
package/src/server/loader-registry.ts +133 -0
package/src/server/request-context.ts +914 -0
package/src/server/root-layout.tsx +10 -0
package/src/server/tsconfig.json +14 -0
package/src/server.ts +51 -0
package/src/ssr/index.tsx +365 -0
package/src/static-handler.ts +114 -0
package/src/theme/ThemeProvider.tsx +297 -0
package/src/theme/ThemeScript.tsx +61 -0
package/src/theme/constants.ts +62 -0
package/src/theme/index.ts +48 -0
package/src/theme/theme-context.ts +44 -0
package/src/theme/theme-script.ts +155 -0
package/src/theme/types.ts +182 -0
package/src/theme/use-theme.ts +44 -0
package/src/types/boundaries.ts +158 -0
package/src/types/cache-types.ts +198 -0
package/src/types/error-types.ts +192 -0
package/src/types/global-namespace.ts +100 -0
package/src/types/handler-context.ts +687 -0
package/src/types/index.ts +88 -0
package/src/types/loader-types.ts +183 -0
package/src/types/route-config.ts +170 -0
package/src/types/route-entry.ts +102 -0
package/src/types/segments.ts +148 -0
package/src/types.ts +1 -0
package/src/urls/include-helper.ts +197 -0
package/src/urls/index.ts +53 -0
package/src/urls/path-helper-types.ts +339 -0
package/src/urls/path-helper.ts +329 -0
package/src/urls/pattern-types.ts +95 -0
package/src/urls/response-types.ts +106 -0
package/src/urls/type-extraction.ts +372 -0
package/src/urls/urls-function.ts +98 -0
package/src/urls.ts +1 -0
package/src/use-loader.tsx +354 -0
package/src/vite/discovery/bundle-postprocess.ts +184 -0
package/src/vite/discovery/discover-routers.ts +344 -0
package/src/vite/discovery/prerender-collection.ts +385 -0
package/src/vite/discovery/route-types-writer.ts +258 -0
package/src/vite/discovery/self-gen-tracking.ts +47 -0
package/src/vite/discovery/state.ts +110 -0
package/src/vite/discovery/virtual-module-codegen.ts +203 -0
package/src/vite/index.ts +16 -0
package/src/vite/plugin-types.ts +131 -0
package/src/vite/plugins/cjs-to-esm.ts +93 -0
package/src/vite/plugins/client-ref-dedup.ts +115 -0
package/src/vite/plugins/client-ref-hashing.ts +105 -0
package/src/vite/plugins/expose-action-id.ts +365 -0
package/src/vite/plugins/expose-id-utils.ts +287 -0
package/src/vite/plugins/expose-ids/export-analysis.ts +296 -0
package/src/vite/plugins/expose-ids/handler-transform.ts +179 -0
package/src/vite/plugins/expose-ids/loader-transform.ts +74 -0
package/src/vite/plugins/expose-ids/router-transform.ts +110 -0
package/src/vite/plugins/expose-ids/types.ts +45 -0
package/src/vite/plugins/expose-internal-ids.ts +569 -0
package/src/vite/plugins/refresh-cmd.ts +65 -0
package/src/vite/plugins/use-cache-transform.ts +323 -0
package/src/vite/plugins/version-injector.ts +83 -0
package/src/vite/plugins/version-plugin.ts +254 -0
package/src/vite/plugins/version.d.ts +12 -0
package/src/vite/plugins/virtual-entries.ts +123 -0
package/src/vite/plugins/virtual-stub-plugin.ts +29 -0
package/src/vite/rango.ts +510 -0
package/src/vite/router-discovery.ts +785 -0
package/src/vite/utils/ast-handler-extract.ts +517 -0
package/src/vite/utils/banner.ts +36 -0
package/src/vite/utils/bundle-analysis.ts +137 -0
package/src/vite/utils/manifest-utils.ts +70 -0
package/src/vite/utils/package-resolution.ts +121 -0
package/src/vite/utils/prerender-utils.ts +189 -0
package/src/vite/utils/shared-utils.ts +169 -0

package/src/theme/types.ts ADDED Viewed

@@ -0,0 +1,182 @@
+/**
+ * Theme type definitions for rsc-router theme system.
+ *
+ * The theme system provides:
+ * - Opt-in via router config
+ * - FOUC prevention via inline script
+ * - Server-side theme access via ctx.theme/ctx.setTheme
+ * - Client-side theme access via useTheme hook
+ */
+/**
+ * Theme value - stored in cookies/localStorage
+ */
+export type Theme = "light" | "dark" | "system";
+/**
+ * Resolved theme - actual visual appearance (system preference resolved)
+ */
+export type ResolvedTheme = "light" | "dark";
+/**
+ * Attribute used to apply theme to HTML element
+ * - "class": Adds theme value as CSS class (e.g., <html class="dark">)
+ * - "data-*": Sets data attribute (e.g., <html data-theme="dark">)
+ */
+export type ThemeAttribute = "class" | `data-${string}`;
+/**
+ * Theme configuration for router
+ *
+ * @example
+ * ```typescript
+ * const router = createRouter<Env>({
+ *   theme: {
+ *     defaultTheme: "system",
+ *     themes: ["light", "dark"],
+ *     attribute: "class",
+ *     storageKey: "theme",
+ *   }
+ * });
+ * ```
+ */
+export interface ThemeConfig {
+  /**
+   * Default theme when no preference is stored
+   * @default "system"
+   */
+  defaultTheme?: Theme;
+  /**
+   * Available theme options
+   * @default ["light", "dark"]
+   */
+  themes?: string[];
+  /**
+   * Attribute to apply to HTML element
+   * @default "class"
+   */
+  attribute?: ThemeAttribute;
+  /**
+   * Key for cookie and localStorage
+   * @default "theme"
+   */
+  storageKey?: string;
+  /**
+   * Enable system preference detection
+   * When true, "system" theme will resolve based on prefers-color-scheme
+   * @default true
+   */
+  enableSystem?: boolean;
+  /**
+   * Set CSS color-scheme property on HTML element
+   * This enables native dark mode for form controls, scrollbars, etc.
+   * @default true
+   */
+  enableColorScheme?: boolean;
+  /**
+   * Custom mapping of theme names to attribute values
+   * Useful when theme names don't match desired attribute values
+   *
+   * @example
+   * ```typescript
+   * value: {
+   *   light: "light-mode",
+   *   dark: "dark-mode",
+   * }
+   * ```
+   */
+  value?: Record<string, string>;
+}
+/**
+ * Resolved theme configuration with defaults applied
+ */
+export interface ResolvedThemeConfig {
+  defaultTheme: Theme;
+  themes: string[];
+  attribute: ThemeAttribute;
+  storageKey: string;
+  enableSystem: boolean;
+  enableColorScheme: boolean;
+  value: Record<string, string>;
+}
+/**
+ * Return type from useTheme hook
+ *
+ * @example
+ * ```tsx
+ * function ThemeToggle() {
+ *   const { theme, setTheme, resolvedTheme, themes } = useTheme();
+ *
+ *   return (
+ *     <select value={theme} onChange={e => setTheme(e.target.value as Theme)}>
+ *       {themes.map(t => <option key={t}>{t}</option>)}
+ *     </select>
+ *   );
+ * }
+ * ```
+ */
+export interface UseThemeReturn {
+  /**
+   * Current theme setting ("light" | "dark" | "system")
+   */
+  theme: Theme;
+  /**
+   * Set the theme
+   */
+  setTheme: (theme: Theme) => void;
+  /**
+   * Resolved theme based on system preference
+   * When theme is "system", this reflects the actual appearance
+   */
+  resolvedTheme: ResolvedTheme;
+  /**
+   * Current system preference ("light" | "dark")
+   */
+  systemTheme: ResolvedTheme;
+  /**
+   * Available theme options (includes "system" if enableSystem is true)
+   */
+  themes: string[];
+}
+/**
+ * Props for ThemeProvider component
+ */
+export interface ThemeProviderProps {
+  /**
+   * Theme configuration
+   */
+  config: ResolvedThemeConfig;
+  /**
+   * Initial theme from server (from cookie)
+   */
+  initialTheme?: Theme;
+  /**
+   * Children to render
+   */
+  children: React.ReactNode;
+}
+/**
+ * Context value for ThemeContext
+ */
+export interface ThemeContextValue extends UseThemeReturn {
+  /**
+   * Full theme configuration
+   */
+  config: ResolvedThemeConfig;
+}

package/src/theme/use-theme.ts ADDED Viewed

@@ -0,0 +1,44 @@
+"use client";
+/**
+ * useTheme - Hook for accessing theme state in client components.
+ *
+ * @example
+ * ```tsx
+ * import { useTheme } from "@rangojs/router/theme";
+ *
+ * function ThemeToggle() {
+ *   const { theme, setTheme, resolvedTheme, themes } = useTheme();
+ *
+ *   return (
+ *     <select value={theme} onChange={e => setTheme(e.target.value)}>
+ *       {themes.map(t => <option key={t}>{t}</option>)}
+ *     </select>
+ *   );
+ * }
+ * ```
+ */
+import { requireThemeContext } from "./theme-context.js";
+import type { UseThemeReturn } from "./types.js";
+/**
+ * Hook to access theme state and methods.
+ *
+ * Must be used within a ThemeProvider (which is automatically included
+ * in NavigationProvider when theme is enabled in router config).
+ *
+ * @returns Theme state and methods
+ * @throws Error if used outside ThemeProvider
+ */
+export function useTheme(): UseThemeReturn {
+  const ctx = requireThemeContext();
+  return {
+    theme: ctx.theme,
+    setTheme: ctx.setTheme,
+    resolvedTheme: ctx.resolvedTheme,
+    systemTheme: ctx.systemTheme,
+    themes: ctx.themes,
+  };
+}

package/src/types/boundaries.ts ADDED Viewed

@@ -0,0 +1,158 @@
+import type { ReactNode } from "react";
+/**
+ * Error information passed to error boundary fallback components
+ */
+export interface ErrorInfo {
+  /** Error message (always available) */
+  message: string;
+  /** Error name/type (e.g., "RouteNotFoundError", "MiddlewareError") */
+  name: string;
+  /** Optional error code for programmatic handling */
+  code?: string;
+  /** Stack trace (only in development) */
+  stack?: string;
+  /** Original error cause if available */
+  cause?: unknown;
+  /** Segment ID where the error occurred */
+  segmentId: string;
+  /** Segment type where the error occurred */
+  segmentType:
+    | "layout"
+    | "route"
+    | "parallel"
+    | "loader"
+    | "middleware"
+    | "cache";
+}
+/**
+ * Props passed to server-side error boundary fallback components
+ *
+ * Server error boundaries don't have a reset function since the error
+ * occurred during server rendering. Users can navigate away or refresh.
+ *
+ * @example
+ * ```typescript
+ * function ProductErrorFallback({ error }: ErrorBoundaryFallbackProps) {
+ *   return (
+ *     <div>
+ *       <h2>Something went wrong loading the product</h2>
+ *       <p>{error.message}</p>
+ *       <a href="/">Go home</a>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export interface ErrorBoundaryFallbackProps {
+  /** Error information */
+  error: ErrorInfo;
+}
+/**
+ * Error boundary handler - receives error info and returns fallback UI
+ */
+export type ErrorBoundaryHandler = (
+  props: ErrorBoundaryFallbackProps,
+) => ReactNode;
+/**
+ * Props passed to client-side error boundary fallback components
+ *
+ * Client error boundaries have a reset function that clears the error state
+ * and re-renders the children.
+ *
+ * @example
+ * ```typescript
+ * function ClientErrorFallback({ error, reset }: ClientErrorBoundaryFallbackProps) {
+ *   return (
+ *     <div>
+ *       <h2>Something went wrong</h2>
+ *       <p>{error.message}</p>
+ *       <button onClick={reset}>Try again</button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export interface ClientErrorBoundaryFallbackProps {
+  /** Error information */
+  error: ErrorInfo;
+  /** Function to reset error state and retry rendering */
+  reset: () => void;
+}
+/**
+ * Wrapped loader data result for deferred resolution with error handling.
+ * When loaders are deferred to client-side resolution, errors need to be
+ * wrapped so the client can handle them appropriately.
+ */
+export type LoaderDataResult<T = unknown> =
+  | { __loaderResult: true; ok: true; data: T }
+  | {
+      __loaderResult: true;
+      ok: false;
+      error: ErrorInfo;
+      fallback: ReactNode | null;
+    };
+/**
+ * Type guard to check if a value is a wrapped loader result
+ */
+export function isLoaderDataResult(value: unknown): value is LoaderDataResult {
+  return (
+    typeof value === "object" &&
+    value !== null &&
+    "__loaderResult" in value &&
+    (value as any).__loaderResult === true
+  );
+}
+/**
+ * Not found information passed to notFound boundary fallback components
+ */
+export interface NotFoundInfo {
+  /** Not found message */
+  message: string;
+  /** Segment ID where notFound was thrown */
+  segmentId: string;
+  /** Segment type where notFound was thrown */
+  segmentType:
+    | "layout"
+    | "route"
+    | "parallel"
+    | "loader"
+    | "middleware"
+    | "cache";
+  /** The pathname that triggered the not found */
+  pathname?: string;
+}
+/**
+ * Props passed to notFound boundary fallback components
+ *
+ * @example
+ * ```typescript
+ * function ProductNotFound({ notFound }: NotFoundBoundaryFallbackProps) {
+ *   return (
+ *     <div>
+ *       <h2>Product Not Found</h2>
+ *       <p>{notFound.message}</p>
+ *       <a href="/products">Browse all products</a>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export interface NotFoundBoundaryFallbackProps {
+  /** Not found information */
+  notFound: NotFoundInfo;
+}
+/**
+ * NotFound boundary handler - receives not found info and returns fallback UI
+ */
+export type NotFoundBoundaryHandler = (
+  props: NotFoundBoundaryFallbackProps,
+) => ReactNode;

package/src/types/cache-types.ts ADDED Viewed

@@ -0,0 +1,198 @@
+/**
+ * Context passed to cache condition/key/tags functions.
+ *
+ * This is a subset of RequestContext that's guaranteed to be available
+ * during cache key generation (before middleware runs).
+ *
+ * Note: While the full RequestContext is passed, middleware-set variables
+ * (ctx.var, ctx.get()) may not be populated yet since cache lookup
+ * happens before middleware execution.
+ */
+export type { RequestContext as CacheContext } from "../server/request-context.js";
+/**
+ * Cache configuration options for cache() DSL
+ *
+ * Controls how segments, layouts, and loaders are cached.
+ * Cache configuration inherits down the route tree unless overridden.
+ *
+ * @example
+ * ```typescript
+ * // Basic caching with TTL
+ * cache({ ttl: 60 }, () => [
+ *   layout(<BlogLayout />),
+ *   route("post/:slug"),
+ * ])
+ *
+ * // With stale-while-revalidate
+ * cache({ ttl: 60, swr: 300 }, () => [
+ *   route("product/:id"),
+ * ])
+ *
+ * // Conditional caching
+ * cache({
+ *   ttl: 300,
+ *   condition: (ctx) => !ctx.request.headers.get('x-preview'),
+ * }, () => [...])
+ *
+ * // Custom cache key
+ * cache({
+ *   ttl: 300,
+ *   key: (ctx) => `product-${ctx.params.id}-${ctx.searchParams.get('variant')}`,
+ * }, () => [...])
+ *
+ * // With tags for invalidation
+ * cache({
+ *   ttl: 300,
+ *   tags: (ctx) => [`product:${ctx.params.id}`, 'products'],
+ * }, () => [...])
+ * ```
+ */
+export interface CacheOptions<TEnv = unknown> {
+  /**
+   * Time-to-live in seconds.
+   * After this period, cached content is considered stale.
+   */
+  ttl: number;
+  /**
+   * Stale-while-revalidate window in seconds (after TTL).
+   * During this window, stale content is served immediately while
+   * fresh content is fetched in the background via waitUntil.
+   *
+   * @example
+   * // TTL: 60s, SWR: 300s
+   * // 0-60s: FRESH (serve from cache)
+   * // 60-360s: STALE (serve from cache, revalidate in background)
+   * // 360s+: EXPIRED (cache miss, fetch fresh)
+   */
+  swr?: number;
+  /**
+   * Override the cache store for this boundary.
+   * When specified, this boundary and its children use this store
+   * instead of the app-level store from handler config.
+   *
+   * Useful for:
+   * - Different backends per route section (memory vs KV vs Redis)
+   * - Loader-specific caching strategies
+   * - Hot data in fast cache, cold data in larger/slower cache
+   *
+   * @example
+   * ```typescript
+   * const kvStore = new CloudflareKVStore(env.CACHE_KV);
+   * const memoryStore = new MemorySegmentCacheStore({ defaults: { ttl: 10 } });
+   *
+   * // Fast memory cache for hot data
+   * cache({ store: memoryStore }, () => [
+   *   route("dashboard"),
+   * ])
+   *
+   * // KV for larger, less frequently accessed data
+   * cache({ store: kvStore, ttl: 3600 }, () => [
+   *   route("archive/:year"),
+   * ])
+   * ```
+   */
+  store?: import("../cache/types.js").SegmentCacheStore;
+  /**
+   * Conditional cache read function.
+   * Return false to skip cache for this request (always fetch fresh).
+   *
+   * Has access to full RequestContext including env, request, params, cookies, etc.
+   * Note: Middleware-set variables (ctx.var) may not be populated yet.
+   *
+   * @example
+   * ```typescript
+   * condition: (ctx) => {
+   *   // Skip cache for preview mode
+   *   if (ctx.request.headers.get('x-preview')) return false;
+   *   // Skip cache for authenticated users
+   *   if (ctx.request.headers.has('authorization')) return false;
+   *   return true;
+   * }
+   * ```
+   */
+  condition?: (
+    ctx: import("../server/request-context.js").RequestContext<TEnv>,
+  ) => boolean;
+  /**
+   * Custom cache key function - FULL OVERRIDE.
+   * Bypasses default key generation AND store's keyGenerator.
+   *
+   * Has access to full RequestContext including env, request, params, cookies, etc.
+   * Note: Middleware-set variables (ctx.var) may not be populated yet.
+   *
+   * @example
+   * ```typescript
+   * // Include query params in cache key
+   * key: (ctx) => `product-${ctx.params.id}-${ctx.searchParams.get('variant')}`
+   *
+   * // Include env bindings
+   * key: (ctx) => `${ctx.env.REGION}:product:${ctx.params.id}`
+   *
+   * // Include cookies
+   * key: (ctx) => `${cookies().get('locale')?.value ?? 'en'}:${ctx.pathname}`
+   * ```
+   */
+  key?: (
+    ctx: import("../server/request-context.js").RequestContext<TEnv>,
+  ) => string | Promise<string>;
+  /**
+   * Tags for cache invalidation.
+   * Can be a static array or a function that returns tags.
+   *
+   * Note: Tags are passed through to the store but built-in stores
+   * (MemorySegmentCacheStore, CFCacheStore) do not yet index or
+   * invalidate by tag. Effective tag-based invalidation requires a
+   * custom store implementation with secondary indices.
+   *
+   * @example
+   * ```typescript
+   * // Static tags
+   * tags: ['products', 'catalog']
+   *
+   * // Dynamic tags
+   * tags: (ctx) => [`product:${ctx.params.id}`, 'products']
+   * ```
+   */
+  tags?:
+    | string[]
+    | ((
+        ctx: import("../server/request-context.js").RequestContext<TEnv>,
+      ) => string[]);
+}
+/**
+ * Partial cache options for cache() DSL.
+ *
+ * When `ttl` is not specified, it will use the default from cache config.
+ * This allows cache() calls to inherit app-level defaults:
+ *
+ * @example
+ * ```typescript
+ * // App-level default (in handler config)
+ * cache: { store: myStore, defaults: { ttl: 60 } }
+ *
+ * // Route-level (inherits ttl from defaults)
+ * cache(() => [
+ *   route("products"),
+ * ])
+ *
+ * // Override with explicit ttl
+ * cache({ ttl: 300 }, () => [...])
+ * ```
+ */
+export type PartialCacheOptions<TEnv = unknown> = Partial<CacheOptions<TEnv>>;
+/**
+ * Cache entry configuration stored in EntryData.
+ * Represents the resolved cache config for a segment.
+ */
+export interface EntryCacheConfig {
+  /** Cache options (false means caching disabled for this entry) - ttl is optional, uses defaults */
+  options: PartialCacheOptions | false;
+}