@rangojs/router 0.0.0-experimental.2 → 0.0.0-experimental.204030a9

package/src/__augment-tests__/augment.ts

@@ -0,0 +1,81 @@
+/**
+ * Simulates a consumer augmenting the Rango global namespace, the way a real
+ * app does in router.tsx (Env/Vars) and via the generated router.named-routes.gen.ts
+ * (GeneratedRouteMap).
+ *
+ * This file is compiled ONLY by tsconfig.augment-check.json and is excluded from
+ * the main program, so the global augmentation here does not leak into the rest
+ * of the type tests, which assert the UNAUGMENTED fallbacks
+ * (see src/__tests__/augmentation-fallback-types.test.ts).
+ */
+
+export interface TestBindings {
+  DB: { query: (sql: string) => string };
+  SECRET: string;
+}
+
+export interface TestVars {
+  user?: { id: string; role: "admin" | "user" };
+  requestId?: string;
+}
+
+/**
+ * A userland domain type that controls its own JSON wire shape via `toJSON()`.
+ * This is the augmentation hook: `Rango.JsonSerialize` honors `toJSON()`, so a
+ * consumer adjusts how their type serializes with no registry API.
+ */
+export class Money {
+  constructor(public cents: number) {}
+  toJSON(): number {
+    return this.cents;
+  }
+}
+
+/**
+ * Mirrors `typeof router.routeMap`: the same routes as the generated map, plus a
+ * response route whose payload carries a userland class (`Money`, with
+ * `toJSON()`) and a `Date` — used to assert `Rango.PathResponse` reports the
+ * serialized JSON wire shape.
+ */
+export interface TestRegisteredRoutes {
+  readonly home: "/";
+  readonly "blog.post": "/blog/:slug";
+  readonly search: {
+    readonly path: "/search";
+    readonly search: { readonly q: "string"; readonly page: "number?" };
+  };
+  readonly order: {
+    readonly path: "/orders/:id";
+    readonly response: { id: string; total: Money; placedAt: Date };
+  };
+}
+
+declare global {
+  namespace Rango {
+    interface Env extends TestBindings {}
+    interface Vars extends TestVars {}
+    interface RegisteredRoutes extends TestRegisteredRoutes {}
+    // Mirrors the shape emitted into router.named-routes.gen.ts: plain string
+    // patterns, plus { path, search } objects for routes with a search schema.
+    interface GeneratedRouteMap {
+      readonly home: "/";
+      readonly "blog.post": "/blog/:slug";
+      readonly search: {
+        readonly path: "/search";
+        readonly search: { readonly q: "string"; readonly page: "number?" };
+      };
+    }
+
+    // Userland serialization overrides: full-transform replacement that
+    // special-cases one type and delegates the rest to the built-in. Isolated to
+    // this augment-check program, so the main suite's built-in behavior (e.g.
+    // JsonSerialize<bigint> = never) is unaffected — demonstrating overrides are
+    // per-project augmentation.
+    interface JsonSerializeOverride<T> {
+      app: T extends bigint ? string : Rango.JsonSerializeBuiltin<T>;
+    }
+    interface FlightSerializeOverride<T> {
+      app: T extends Money ? number : Rango.FlightSerializeBuiltin<T>;
+    }
+  }
+}

package/src/__augment-tests__/augmented.check.ts

@@ -0,0 +1,117 @@
+/**
+ * Compile-only assertions for the AUGMENTED Rango namespace.
+ *
+ * Pins the type-safety contract a consumer gets after augmenting Env, Vars, and
+ * GeneratedRouteMap. A regression in the fallback chains (global-namespace.ts)
+ * turns these into tsc errors. Run via tsconfig.augment-check.json.
+ */
+import "./augment.js";
+import type { Handler, RouteParams, RouteSearchParams } from "../index.js";
+import type { DefaultRouteName } from "../types/global-namespace.js";
+import { href } from "../href-client.js";
+import type { ResponseEnvelope } from "../urls.js";
+import type { Money, TestBindings } from "./augment.js";
+
+type Expect<T extends true> = T;
+type Equal<A, B> =
+  (<T>() => T extends A ? 1 : 2) extends <T>() => T extends B ? 1 : 2
+    ? true
+    : false;
+
+// Env: ctx.env resolves to the augmented bindings, not `unknown`/`any`.
+const envHandler: Handler<"home"> = (ctx) => {
+  type _envIsBindings = Expect<Equal<typeof ctx.env, TestBindings>>;
+  ctx.env.DB.query("select 1");
+  // @ts-expect-error - unknown binding is rejected once Env is augmented
+  ctx.env.MISSING();
+  return null;
+};
+void envHandler;
+
+// Vars: ctx.get is keyed by the augmented Vars.
+const varsHandler: Handler<"home"> = (ctx) => {
+  const user = ctx.get("user");
+  type _userTyped = Expect<
+    Equal<typeof user, { id: string; role: "admin" | "user" } | undefined>
+  >;
+  // @ts-expect-error - unknown var key is rejected once Vars is augmented
+  ctx.get("nope");
+  return null;
+};
+void varsHandler;
+
+// routeName narrows to the generated route names.
+type _routeName = Expect<
+  Equal<DefaultRouteName, "home" | "blog.post" | "search">
+>;
+
+// RouteParams / RouteSearchParams resolve from the generated map with no
+// explicit route map argument.
+type _params = Expect<Equal<RouteParams<"blog.post">, { slug: string }>>;
+type _search = Expect<
+  Equal<RouteSearchParams<"search">, { q: string | undefined; page?: number }>
+>;
+
+// href / Rango.Path read GeneratedRouteMap even without a manual RegisteredRoutes
+// augmentation — this is the core of the "rango generate alone enables typed
+// href()" guarantee. The paths below come from the generated map in augment.ts.
+href("/");
+href("/blog/anything");
+href("/search");
+// @ts-expect-error - path is not in the generated route map
+href("/not-a-route");
+
+// Rango.Path is the ambient input type for wrapper functions around href().
+// No import needed — it reads the same generated map href() does.
+function wrappedHref(path: Rango.Path): string {
+  return href(path);
+}
+const arrowHref = (path: Rango.Path): string => href(path);
+
+wrappedHref("/blog/anything");
+arrowHref("/search?q=hello");
+// @ts-expect-error - wrapper preserves the same generated-map validation
+wrappedHref("/not-a-route");
+
+// Userland serialization augmentation: a consumer's custom class adjusts its JSON
+// wire shape via toJSON(), and Rango.PathResponse reports the serialized payload
+// (Money -> number, Date -> string) — both by pattern and by concrete path.
+type _orderWireByPattern = Expect<
+  Equal<
+    Rango.PathResponse<"/orders/:id">,
+    ResponseEnvelope<{ id: string; total: number; placedAt: string }>
+  >
+>;
+type _orderWireByPath = Expect<
+  Equal<
+    Rango.PathResponse<"/orders/42">,
+    ResponseEnvelope<{ id: string; total: number; placedAt: string }>
+  >
+>;
+
+// Project serialization overrides: the consumer augments JsonSerializeOverride /
+// FlightSerializeOverride (see augment.ts) with a full transform that delegates to
+// the built-in, and the transforms honor it — winning over the built-in rules.
+// bigint normally JSON-serializes to `never`; Money is a class React Flight would
+// otherwise reject structurally. Delegation keeps every other type (incl. the
+// /orders payload above) on the built-in behavior.
+type _jsonOverride = Expect<Equal<Rango.JsonSerialize<bigint>, string>>;
+type _jsonOverrideNested = Expect<
+  Equal<
+    Rango.JsonSerialize<{ id: bigint; name: string }>,
+    { id: string; name: string }
+  >
+>;
+type _flightOverride = Expect<Equal<Rango.FlightSerialize<Money>, number>>;
+
+// Reference the top-level assertion aliases so they are unambiguously evaluated.
+export type _Assertions = [
+  _routeName,
+  _params,
+  _search,
+  _orderWireByPattern,
+  _orderWireByPath,
+  _jsonOverride,
+  _jsonOverrideNested,
+  _flightOverride,
+];

package/src/__internal.ts

@@ -0,0 +1,273 @@
+/**
+ * Internal Types - Implementation Details
+ *
+ * @internal
+ * These types are for internal use only and should not be relied upon by consumers.
+ * They may change without notice between versions.
+ *
+ * If you find yourself needing these types, please open an issue to discuss
+ * adding them to the public API.
+ */
+
+// ============================================================================
+// Segment Resolution (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Internal representation of a resolved route segment.
+ * Used during route matching and rendering pipeline.
+ */
+export type { ResolvedSegment, SegmentMetadata } from "./types.js";
+
+/**
+ * @internal
+ * Internal match result from route resolution.
+ */
+export type { MatchResult, SlotState } from "./types.js";
+
+// ============================================================================
+// Intercept System (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Context for intercept route selection.
+ */
+export type {
+  InterceptSelectorContext,
+  InterceptSegmentsState,
+  InterceptWhenFn,
+} from "./server/context.js";
+
+// ============================================================================
+// Browser State (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * RSC protocol payload structure.
+ */
+export type { RscPayload, ReactFormState } from "./rsc/types.js";
+
+/**
+ * @internal
+ * Internal navigation store interface.
+ */
+export type {
+  NavigationStore,
+  NavigationBridge,
+  RscMetadata,
+  ActionResult,
+  InflightAction,
+  NavigationState,
+  TrackedActionState,
+  ActionStateListener,
+  SegmentCache,
+  SegmentState,
+  NavigationUpdate,
+} from "./browser/types.js";
+
+// ============================================================================
+// Handle System (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Internal handle storage mechanism.
+ */
+export type { HandleStore, HandleData } from "./server/handle-store.js";
+
+/**
+ * @internal
+ * Segment handle data in cache.
+ */
+export type { SegmentHandleData } from "./cache/types.js";
+
+// ============================================================================
+// Cache Internals
+// ============================================================================
+
+/**
+ * @internal
+ * Internal cache entry data structure.
+ */
+export type {
+  CachedEntryData,
+  CachedEntryResult,
+  CacheGetResult,
+  SerializedSegmentData,
+  CacheDefaults,
+} from "./cache/types.js";
+
+// ============================================================================
+// Router Context (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Router context for AsyncLocalStorage.
+ */
+export type {
+  RouterContext,
+  RevalidationContext,
+  InterceptResult,
+} from "./router/router-context.js";
+
+// ============================================================================
+// Match Pipeline (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Route match context during pipeline processing.
+ */
+export type {
+  MatchContext,
+  MatchPipelineState,
+} from "./router/match-context.js";
+
+/**
+ * @internal
+ * Pattern matching result.
+ */
+export type { RouteMatchResult } from "./router/pattern-matching.js";
+
+// ============================================================================
+// Server Context (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Entry data during route traversal.
+ */
+export type {
+  EntryData,
+  InterceptEntry,
+  MetricsStore,
+  PerformanceMetric,
+  EntryCacheConfig,
+  EntryPropCommon,
+  EntryPropDatas,
+  LoaderEntry,
+  EntryPropSegments,
+} from "./server/context.js";
+
+// ============================================================================
+// Handler Context (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Internal handler context with additional props for router internals.
+ * Includes `_currentSegmentId` and `_responseType`.
+ */
+export type { InternalHandlerContext } from "./types.js";
+
+// ============================================================================
+// Rendering (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Builds React element trees from route segments.
+ */
+export { renderSegments } from "./segment-system.js";
+
+// ============================================================================
+// Error Utilities (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Error sanitization and network error utilities.
+ */
+export { sanitizeError, NetworkError, isNetworkError } from "./errors.js";
+
+// ============================================================================
+// Type Utilities (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Scoped view of GeneratedRouteMap for Handler<"localName", ScopedRouteMap<"prefix">>.
+ */
+export type { ScopedRouteMap } from "./types.js";
+
+/**
+ * @internal
+ * Type-level utilities for reverse URL generation.
+ */
+export type { MergeRoutes, SanitizePrefix } from "./reverse.js";
+
+/**
+ * @internal
+ * Individual telemetry event types.
+ */
+export type {
+  RequestStartEvent,
+  RequestEndEvent,
+  RequestErrorEvent,
+  RequestTimeoutEvent,
+  LoaderStartEvent,
+  LoaderEndEvent,
+  LoaderErrorEvent,
+  HandlerErrorEvent,
+  CacheDecisionEvent,
+  RevalidationDecisionEvent,
+} from "./router/telemetry.js";
+
+// ============================================================================
+// Pre-render / Static Handler Guards (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Type guard for prerender handler definitions.
+ */
+export { isPrerenderHandler, isPassthroughHandler } from "./prerender.js";
+
+/**
+ * @internal
+ * Type guard for static handler definitions.
+ */
+export { isStaticHandler } from "./static-handler.js";
+
+// ============================================================================
+// URL Pattern Internals
+// ============================================================================
+
+/**
+ * @internal
+ * Sentinel used to tag response-type route entries.
+ */
+export { RESPONSE_TYPE } from "./urls.js";
+
+// ============================================================================
+// Route Match Debug (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Debug utilities for route matching performance analysis.
+ */
+export {
+  enableMatchDebug,
+  getMatchDebugStats,
+} from "./router/pattern-matching.js";
+
+// ============================================================================
+// Debug Utilities (Internal)
+// ============================================================================
+
+/**
+ * @internal
+ * Debug utilities for manifest inspection and comparison.
+ */
+export {
+  serializeManifest,
+  compareManifests,
+  formatManifestDiff,
+  type SerializedEntry,
+  type SerializedManifest,
+} from "./debug.js";