@rangojs/router 0.0.0-experimental.39 → 0.0.0-experimental.39528925

package/dist/testing/vitest.js

@@ -0,0 +1,82 @@
+// src/testing/vitest.ts
+import { fileURLToPath } from "node:url";
+function here(relativeFromRoot) {
+  return fileURLToPath(new URL(`../../${relativeFromRoot}`, import.meta.url));
+}
+function rangoTestAliases(opts = {}) {
+  const aliases = [
+    // Real impls (index.rsc.ts) for the bare specifier ONLY — exact regex so
+    // subpaths (/testing, /client, /cache, ...) are untouched. React stays the
+    // client build, so createContext and "use client" modules work.
+    { find: /^@rangojs\/router$/, replacement: here("src/index.rsc.ts") },
+    {
+      find: "@rangojs/router:version",
+      replacement: here("src/testing/vitest-stubs/version.ts")
+    },
+    {
+      find: /^@vitejs\/plugin-rsc\/rsc$/,
+      replacement: here("src/testing/vitest-stubs/plugin-rsc.ts")
+    }
+  ];
+  if (opts.preset === "cloudflare") {
+    aliases.push(
+      {
+        find: "cloudflare:workers",
+        replacement: here("src/testing/vitest-stubs/cloudflare-workers.ts")
+      },
+      {
+        find: "cloudflare:email",
+        replacement: here("src/testing/vitest-stubs/cloudflare-email.ts")
+      }
+    );
+  }
+  return aliases;
+}
+var rangoInlineDeps = [/@rangojs[/\\]router/];
+function rangoTestConfig(opts = {}) {
+  return {
+    alias: rangoTestAliases(opts),
+    // fresh copy so the shared rangoInlineDeps const is never aliased into (or
+    // mutated through) a consumer's resolved config
+    server: { deps: { inline: [...rangoInlineDeps] } }
+  };
+}
+function rangoUseClientTransform() {
+  return {
+    name: "rango:testing-use-client",
+    async transform(code, id) {
+      if (id.includes("/node_modules/")) return void 0;
+      if (!code.includes("use client")) return void 0;
+      const { parseAstAsync } = await import("vite");
+      const { hasDirective, transformDirectiveProxyExport } = await import("@vitejs/plugin-rsc/transforms");
+      let ast;
+      try {
+        ast = await parseAstAsync(code);
+      } catch {
+        return void 0;
+      }
+      if (!hasDirective(ast.body, "use client")) return void 0;
+      const result = transformDirectiveProxyExport(ast, {
+        directive: "use client",
+        code,
+        runtime: (name) => `$$RangoRSD.registerClientReference(() => { throw new Error("client reference " + ${JSON.stringify(name)} + " is not callable on the server"); }, ${JSON.stringify(id)}, ${JSON.stringify(name)})`
+      });
+      if (!result) return void 0;
+      const { output } = result;
+      output.prepend(
+        `import * as $$RangoRSD from "@vitejs/plugin-rsc/vendor/react-server-dom/server.edge";
+`
+      );
+      return {
+        code: output.toString(),
+        map: output.generateMap({ hires: true })
+      };
+    }
+  };
+}
+export {
+  rangoInlineDeps,
+  rangoTestAliases,
+  rangoTestConfig,
+  rangoUseClientTransform
+};

package/dist/types/__internal.d.ts

@@ -0,0 +1,127 @@
+/**
+ * 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.
+ */
+/**
+ * @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";
+/**
+ * @internal
+ * Context for intercept route selection.
+ */
+export type { InterceptSelectorContext, InterceptSegmentsState, InterceptWhenFn, } from "./server/context.js";
+/**
+ * @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";
+/**
+ * @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";
+/**
+ * @internal
+ * Internal cache entry data structure.
+ */
+export type { CachedEntryData, CacheGetResult, SerializedSegmentData, CacheDefaults, } from "./cache/types.js";
+/**
+ * @internal
+ * Router context for AsyncLocalStorage.
+ */
+export type { RouterContext, RevalidationContext, InterceptResult, } from "./router/router-context.js";
+/**
+ * @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";
+/**
+ * @internal
+ * Entry data during route traversal.
+ */
+export type { EntryData, InterceptEntry, MetricsStore, PerformanceMetric, EntryCacheConfig, EntryPropCommon, EntryPropDatas, LoaderEntry, EntryPropSegments, } from "./server/context.js";
+/**
+ * @internal
+ * Internal handler context with additional props for router internals.
+ * Includes `_currentSegmentId` and `_responseType`.
+ */
+export type { InternalHandlerContext } from "./types.js";
+/**
+ * @internal
+ * Builds React element trees from route segments.
+ */
+export { renderSegments } from "./segment-system.js";
+/**
+ * @internal
+ * Error sanitization and network error utilities.
+ */
+export { sanitizeError, NetworkError, isNetworkError } from "./errors.js";
+/**
+ * @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";
+/**
+ * @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";
+/**
+ * @internal
+ * Sentinel used to tag response-type route entries.
+ */
+export { RESPONSE_TYPE } from "./urls.js";
+/**
+ * @internal
+ * Debug utilities for route matching performance analysis.
+ */
+export { enableMatchDebug, getMatchDebugStats, } from "./router/pattern-matching.js";
+/**
+ * @internal
+ * Debug utilities for manifest inspection and comparison.
+ */
+export { serializeManifest, compareManifests, formatManifestDiff, type SerializedEntry, type SerializedManifest, } from "./debug.js";

package/dist/types/bin/rango.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/browser/action-coordinator.d.ts

@@ -0,0 +1,57 @@
+import type { ActionEntry } from "./event-controller.js";
+/**
+ * Post-reconciliation action outcome (discriminated union). Error and
+ * full-update-unsupported cases are handled inline in the bridge before
+ * reconciliation; this only covers successfully-reconciled partial responses.
+ */
+type ActionScenario = {
+    type: "navigated-away";
+    historyKeyChanged: boolean;
+    onInterceptRoute: boolean;
+} | {
+    type: "hmr-missing";
+} | {
+    type: "consolidation-needed";
+    segmentIds: string[];
+} | {
+    type: "concurrent-skip";
+    otherFetchingCount: number;
+} | {
+    type: "normal";
+};
+/**
+ * Plain data inputs for classifying a post-reconciliation action outcome.
+ * No browser objects or controller references — all values are snapshots.
+ */
+export interface ActionOutcomeInput {
+    /** This action's unique instance ID */
+    handleId: string;
+    /** All in-flight action entries (snapshot from event controller) */
+    inflightActions: Map<string, ActionEntry>;
+    /** Whether any concurrent actions occurred (controller-level shared flag) */
+    hadAnyConcurrentActions: boolean;
+    /** Segments revalidated by concurrent actions (from tracking set) */
+    revalidatedSegments: Set<string>;
+    /** window.location.pathname captured at action start */
+    actionStartPathname: string;
+    /** window.location.pathname at classification time */
+    currentPathname: string;
+    /** window.history.state?.key captured at action start */
+    actionStartLocationKey: string | undefined;
+    /** window.history.state?.key at classification time */
+    currentLocationKey: string | undefined;
+    /** Number of segments after reconciliation */
+    reconciledSegmentCount: number;
+    /** Number of matched segment IDs from server */
+    matchedCount: number;
+    /** Current intercept source URL (null when not on intercept route) */
+    currentInterceptSource: string | null;
+}
+/**
+ * Classify a post-reconciliation action outcome. Ordered priority chain: each
+ * case assumes the earlier ones are false (e.g. concurrent-skip only applies on
+ * the still-current route, consolidation only once no action is still fetching).
+ * The bridge calls this to decide whether to render, skip, consolidate, or refetch.
+ */
+export declare function classifyActionOutcome(input: ActionOutcomeInput): ActionScenario;
+export {};

package/dist/types/browser/action-fence.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Action fence: a refcounted flag that is raised while a server action is in
+ * flight and lowered when it resolves.
+ *
+ * It replaces the eager cache clear the action bridge used to do at action
+ * start. While the fence is up, the decision of whether the action invalidated
+ * anything is deferred to the response:
+ *
+ * - prefetch consumption is suspended (a queued prefetch result is not served),
+ * - a genuine navigation during the flight fetches with `cache: "no-store"` so
+ *   it cannot be served stale bytes from the browser's Vary-keyed HTTP cache,
+ * - popstate reads are treated as stale-while-revalidate.
+ *
+ * Nothing is wiped, rotated, or broadcast while the fence is up — that is what
+ * keeps a sibling tab from seeing a pre-commit signal. Refcounted so concurrent
+ * actions compose: each action raises and lowers its own reference, and the
+ * fence is down only when the count reaches zero.
+ *
+ * The refcount is a single module-level counter, not keyed by routerId.
+ * Consumers (navigation-client.ts, prefetch/fetch.ts, navigation-bridge.ts)
+ * read it unscoped, so an action in one router would suppress another router's
+ * navigation/prefetch caches. This is correct only because two routers cannot
+ * coexist in one live document: an SPA navigation crossing a host-router
+ * boundary forces a full document reload (src/router/request-classification.ts
+ * app-switch terminal), so there is always exactly one live router per
+ * document. A future multi-router-in-one-document feature must not silently
+ * inherit this global, cross-router cache suppression.
+ */
+export declare function enterActionFence(): void;
+export declare function exitActionFence(): void;
+export declare function isActionFenceActive(): boolean;
+/** Test-only: reset the refcount between cases. */
+export declare function __resetActionFence(): void;

package/dist/types/browser/app-shell.d.ts

@@ -0,0 +1,34 @@
+import type { ComponentType, ReactNode } from "react";
+/**
+ * App-shell metadata: the per-router fields describing the "envelope" around
+ * the current app's segment tree — the rootLayout (Document), basename,
+ * version, and router identity. Set once from the initial RSC payload and read
+ * through the AppShellRef when rendering segments.
+ *
+ * This is a per-document value. A navigation that crosses a host-router app
+ * boundary is a full document load (the server returns X-RSC-Reload for it;
+ * see request-classification.ts, mode "app-switch"), so the target app's shell
+ * — along with everything else document-level (theme, warmup, prefetch-TTL) —
+ * is established fresh by the target app's own load. The shell is never swapped
+ * in place within a session.
+ */
+export interface AppShell {
+    /** Router identity. Used to namespace per-app client state (e.g. the
+     *  rango-state localStorage key) so sibling apps on the same origin
+     *  cannot observe each other's cache invalidations. */
+    routerId?: string;
+    rootLayout?: ComponentType<{
+        children: ReactNode;
+    }>;
+    basename?: string;
+    version?: string;
+}
+/**
+ * Container for the active app shell. Read-through via `get()` so closures
+ * (e.g. the segment renderer) capture the ref and read the shell at call time
+ * rather than closing over a stale snapshot.
+ */
+export interface AppShellRef {
+    get(): AppShell;
+}
+export declare function createAppShellRef(initial: AppShell): AppShellRef;

package/dist/types/browser/app-version.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Mutable app version — updated after HMR revalidation.
+ * Read by prefetch, navigation, and context code.
+ */
+export declare function getAppVersion(): string | undefined;
+export declare function setAppVersion(version: string | undefined): void;

package/dist/types/browser/connection-warmup.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Connection warmup: keep TLS alive after idle periods.
+ *
+ * After IDLE_TIMEOUT of no user interaction the connection is marked "cold".
+ * On the next pointer/touch interaction or a visibility change, a HEAD request
+ * warms the TLS connection before the user actually clicks a link.
+ *
+ * Extracted from NavigationProvider so the idle/cold/warmup state machine is
+ * unit-testable with an injected environment (document, fetch, timers).
+ *
+ * Ordering bug this guards against: the warmup listeners (mousemove/touchstart)
+ * share events with the idle-reset listeners, and the idle-reset listener is
+ * registered first, so it clears the live "cold" flag before the warmup
+ * listener reads it on the same event. A separate coldLatch — set when the
+ * connection goes cold and cleared only when warmup fires or listeners detach,
+ * never by the idle reset — lets the warmup decision see the pre-reset cold
+ * state regardless of listener ordering.
+ */
+type TimerHandle = ReturnType<typeof setTimeout>;
+export interface WarmupEnv {
+    doc: Pick<Document, "addEventListener" | "removeEventListener" | "visibilityState">;
+    fetch: typeof fetch;
+    setTimeout: (fn: () => void, ms: number) => TimerHandle;
+    clearTimeout: (handle: TimerHandle | undefined) => void;
+}
+/**
+ * Start the connection-warmup state machine. Returns a cleanup function that
+ * cancels timers and removes all listeners.
+ */
+export declare function startConnectionWarmup(env?: WarmupEnv): () => void;
+export {};

package/dist/types/browser/cookie-name.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Rango state cookie: value codec and attribute serialization.
+ *
+ * Shared by the client (the document.cookie writer in rango-state.ts) and the
+ * server (the Set-Cookie writer in invalidateClientCache). Environment-agnostic:
+ * no window/document access and no name composition.
+ *
+ * Name RESOLUTION deliberately lives elsewhere (router init, see
+ * router/state-cookie-name.ts). Keeping composition out of this shared module
+ * is what lets the client read the server-resolved name verbatim and compose
+ * nothing.
+ */
+/** Default prefix when `stateCookiePrefix` is unset or empty after sanitization. */
+export declare const DEFAULT_STATE_COOKIE_PREFIX = "rango-state";
+/** Internal response header carrying the keepClientCache() directive. */
+export declare const KEEP_CACHE_HEADER = "x-rango-keep-cache";
+/** True for a per-client signal header. */
+export declare function isPerClientSignalHeader(name: string): boolean;
+/** True if `headers` carries any per-client signal. */
+export declare function hasPerClientSignal(headers: Headers): boolean;
+/** Remove every per-client signal header from `headers` in place. */
+export declare function stripPerClientSignals(headers: Headers): void;
+/**
+ * Read the raw, UNDECODED value of a single cookie from a cookie string (a
+ * `document.cookie` jar or a request `Cookie` header). Shared by both seats so
+ * the client mirror and the server monotonic-guard read the SAME jar entry —
+ * their agreement is the guard's contract. First match wins (the entry the
+ * client's mirror holds); exact name boundary via the `=`; an empty value
+ * (`name=`) returns null (treated as absent, not a usable prior value).
+ */
+export declare function getRawCookieValue(cookieString: string | null, name: string): string | null;
+/**
+ * Encode a state value for the wire: `encodeURIComponent(version):timestamp`.
+ * Only the build-derived version is encoded (it is arbitrary); the `:`
+ * separator and numeric timestamp stay raw, so the `{version}:{timestamp}`
+ * shape survives and `:` is a legal cookie-value octet.
+ */
+export declare function encodeStateValue(version: string, timestamp: number): string;
+/** Parsed state value. `version` is decoded; `timestamp` is the raw integer. */
+export interface StateValue {
+    version: string;
+    timestamp: number;
+}
+/**
+ * Decode a wire value back into `{version, timestamp}`. Returns null for a
+ * malformed value (no `:`, empty version, or non-numeric timestamp) so callers
+ * mint fresh instead of trusting garbage.
+ */
+export declare function decodeStateValue(raw: string): StateValue | null;
+/**
+ * Mint a fresh state value whose timestamp is strictly greater than the previous
+ * one, so a re-mint inside the same millisecond (or a backward clock step) still
+ * differs from the current value. `prevRaw` is the current wire value (the
+ * client's in-memory mirror, or the server's inbound header/cookie) or null; its
+ * timestamp is the floor. Shared by both seats so the monotonic guard lives once.
+ */
+export declare function mintStateValue(version: string, prevRaw: string | null): string;
+/**
+ * Attribute string for the state cookie. Session cookie (no Max-Age/Expires),
+ * Path=/ (whole app), SameSite=Lax (sent on top-level navigations), and Secure
+ * only on https so the document.cookie write does not silently fail on plain
+ * http dev. Never HttpOnly (the client reads and writes it).
+ */
+export declare function stateCookieAttributes(secure: boolean): string;
+/** Serialize a full `name=value` cookie string with the state attributes. */
+export declare function serializeStateCookie(name: string, value: string, secure: boolean): string;

package/dist/types/browser/dev-discovery.d.ts

@@ -0,0 +1,11 @@
+import { DEV_DISCOVERY_QUERY_EVENT, DEV_DISCOVERY_READY_EVENT } from "../dev-discovery-protocol.js";
+export interface DevDiscoveryHot {
+    on(event: typeof DEV_DISCOVERY_READY_EVENT | "vite:ws:connect", listener: (payload: unknown) => void): void;
+    send(event: typeof DEV_DISCOVERY_QUERY_EVENT, payload: {
+        epoch: number;
+    }): void;
+}
+export interface DevDiscoveryHandshakeOptions {
+    reload?: () => void;
+}
+export declare function startDevDiscoveryHandshake(documentEpoch: unknown, hot: DevDiscoveryHot, options?: DevDiscoveryHandshakeOptions): void;