@rangojs/router 0.0.0-experimental.14 → 0.0.0-experimental.140

package/src/browser/lru-cache.ts

@@ -1,69 +0,0 @@
-/**
- * Simple LRU (Least Recently Used) cache implementation
- * Used for caching navigation segments to enable instant back/forward
- */
-export class LRUCache<K, V> {
-  private cache = new Map<K, V>();
-  private maxSize: number;
-
-  constructor(maxSize: number) {
-    this.maxSize = maxSize;
-  }
-
-  get(key: K): V | undefined {
-    if (!this.cache.has(key)) {
-      return undefined;
-    }
-
-    // Move to end (most recently used)
-    const value = this.cache.get(key)!;
-    this.cache.delete(key);
-    this.cache.set(key, value);
-    return value;
-  }
-
-  set(key: K, value: V): void {
-    // If key exists, delete it first to update position
-    if (this.cache.has(key)) {
-      this.cache.delete(key);
-    }
-
-    this.cache.set(key, value);
-
-    // Evict oldest entries if over capacity
-    while (this.cache.size > this.maxSize) {
-      const oldestKey = this.cache.keys().next().value;
-      if (oldestKey !== undefined) {
-        this.cache.delete(oldestKey);
-      }
-    }
-  }
-
-  has(key: K): boolean {
-    if (!this.cache.has(key)) {
-      return false;
-    }
-
-    // Move to end (most recently used) - same as get()
-    const value = this.cache.get(key)!;
-    this.cache.delete(key);
-    this.cache.set(key, value);
-    return true;
-  }
-
-  delete(key: K): boolean {
-    return this.cache.delete(key);
-  }
-
-  clear(): void {
-    this.cache.clear();
-  }
-
-  keys(): IterableIterator<K> {
-    return this.cache.keys();
-  }
-
-  get size(): number {
-    return this.cache.size;
-  }
-}

package/src/browser/react/use-client-cache.ts

@@ -1,56 +0,0 @@
-"use client";
-
-import { useContext, useCallback } from "react";
-import { NavigationStoreContext } from "./context.js";
-
-/**
- * Return type for useClientCache hook
- */
-export interface ClientCacheControls {
-  /**
-   * Clear the client-side navigation cache.
-   * Call this after data changes that happen outside of server actions
-   * (e.g., REST API calls, WebSocket updates, etc.)
-   *
-   * This will also broadcast to other tabs to clear their caches.
-   */
-  clear: () => void;
-}
-
-/**
- * Hook to access client-side cache controls
- *
- * Use this when you need to manually invalidate the navigation cache
- * after data changes that happen outside of server actions.
- *
- * Server actions automatically clear the cache, so you only need this for:
- * - REST API mutations
- * - WebSocket-driven updates
- * - Other non-RSC data changes
- *
- * @example
- * ```tsx
- * function DataEditor() {
- *   const { clear } = useClientCache();
- *
- *   async function handleSave() {
- *     await fetch('/api/data', { method: 'POST', body: JSON.stringify(data) });
- *     // Clear cache so back/forward navigation shows fresh data
- *     clear();
- *   }
- *
- *   return <button onClick={handleSave}>Save</button>;
- * }
- * ```
- */
-export function useClientCache(): ClientCacheControls {
-  const ctx = useContext(NavigationStoreContext);
-
-  const clear = useCallback(() => {
-    if (ctx?.store) {
-      ctx.store.clearHistoryCache();
-    }
-  }, [ctx]);
-
-  return { clear };
-}

package/src/browser/request-controller.ts

@@ -1,164 +0,0 @@
-import type { RequestController, DisposableAbortController } from "./types.js";
-
-// Polyfill Symbol.dispose for Safari and older browsers
-if (typeof Symbol.dispose === "undefined") {
-  (Symbol as any).dispose = Symbol("Symbol.dispose");
-}
-
-/**
- * Create a request controller for managing concurrent abort controllers
- *
- * This utility helps manage concurrent navigation requests by providing
- * a way to abort all pending requests when a new navigation starts.
- *
- * @returns RequestController instance
- *
- * @example
- * ```typescript
- * const controller = createRequestController();
- *
- * // Start a new request
- * const abortController = controller.create();
- * fetch(url, { signal: abortController.signal });
- *
- * // Abort all pending requests (e.g., when starting new navigation)
- * controller.abortAll();
- *
- * // Clean up completed request
- * controller.remove(abortController);
- * ```
- */
-export function createRequestController(): RequestController {
-  // Navigation controllers - aborted on new navigation
-  // Using WeakRef to allow GC if controller is no longer referenced elsewhere
-  const controllers: WeakRef<AbortController>[] = [];
-  // Action controllers - NOT aborted by navigation, only by errors
-  const actionControllers: WeakRef<AbortController>[] = [];
-
-  /**
-   * Remove stale (garbage collected) refs from an array
-   */
-  function pruneStaleRefs(refs: WeakRef<AbortController>[]): void {
-    for (let i = refs.length - 1; i >= 0; i--) {
-      if (!refs[i].deref()) {
-        refs.splice(i, 1);
-      }
-    }
-  }
-
-  return {
-    /**
-     * Create a new abort controller and track it for navigation
-     *
-     * @returns A new AbortController
-     */
-    create(): AbortController {
-      const controller = new AbortController();
-      controllers.push(new WeakRef(controller));
-      console.log(
-        `[Browser] Created abort controller, total: ${controllers.length}`,
-      );
-      return controller;
-    },
-
-    /**
-     * Create a disposable abort controller for navigation use with `using` keyword
-     *
-     * The controller will be automatically removed from tracking when
-     * it goes out of scope, regardless of how the scope is exited.
-     *
-     * @returns A DisposableAbortController
-     *
-     * @example
-     * ```typescript
-     * async function handleNavigation() {
-     *   requestController.abortAll();
-     *   using { controller } = requestController.createDisposable();
-     *   // ... use controller.signal ...
-     *   // controller is automatically removed on scope exit
-     * }
-     * ```
-     */
-    createDisposable(): DisposableAbortController {
-      const controller = this.create();
-      return {
-        controller,
-        [Symbol.dispose]: () => {
-          this.remove(controller);
-        },
-      };
-    },
-
-    /**
-     * Create a disposable abort controller for actions
-     *
-     * Action controllers are NOT aborted by navigation - they complete
-     * independently. Only aborted by abortAllActions() on error.
-     *
-     * @returns A DisposableAbortController
-     */
-    createActionDisposable(): DisposableAbortController {
-      const controller = new AbortController();
-      const ref = new WeakRef(controller);
-      actionControllers.push(ref);
-      console.log(
-        `[Browser] Created action controller, total: ${actionControllers.length}`,
-      );
-      return {
-        controller,
-        [Symbol.dispose]: () => {
-          const index = actionControllers.indexOf(ref);
-          if (index !== -1) {
-            actionControllers.splice(index, 1);
-            console.log(
-              `[Browser] Removed action controller, remaining: ${actionControllers.length}`,
-            );
-          }
-        },
-      };
-    },
-
-    /**
-     * Abort all navigation controllers (NOT actions)
-     *
-     * Called when starting new navigation. Actions continue
-     * to complete in the background.
-     */
-    abortAll(): void {
-      controllers.forEach((ref) => ref.deref()?.abort());
-      controllers.length = 0;
-      console.log(`[Browser] Aborted all navigation controllers`);
-    },
-
-    /**
-     * Abort all action controllers
-     *
-     * Called when an action error occurs - prevents other actions
-     * from completing and overwriting the error UI.
-     */
-    abortAllActions(): void {
-      actionControllers.forEach((ref) => ref.deref()?.abort());
-      actionControllers.length = 0;
-      console.log(`[Browser] Aborted all action controllers`);
-    },
-
-    /**
-     * Remove a specific controller from tracking
-     *
-     * Call this when a request completes successfully.
-     *
-     * @param controller - The controller to remove
-     */
-    remove(controller: AbortController): void {
-      // Prune any stale refs while searching
-      pruneStaleRefs(controllers);
-      const index = controllers.findIndex((ref) => ref.deref() === controller);
-      if (index !== -1) {
-        controllers.splice(index, 1);
-        console.log(
-          `[Browser] Removed abort controller, remaining: ${controllers.length}`,
-        );
-      }
-    },
-  };
-}

package/src/browser/shallow.ts

@@ -1,35 +0,0 @@
-/**
- * Shallow comparison utility for selector optimization
- *
- * Used by useNavigation hook to prevent unnecessary re-renders
- * when the selected value hasn't changed.
- *
- * @param a - First value
- * @param b - Second value
- * @returns true if values are shallowly equal
- */
-export function shallow<T>(a: T, b: T): boolean {
-  // Same reference or primitive equality
-  if (Object.is(a, b)) return true;
-
-  // Different types or non-objects
-  if (typeof a !== "object" || typeof b !== "object") return false;
-
-  // Null checks
-  if (a === null || b === null) return false;
-
-  // Compare object keys
-  const keysA = Object.keys(a);
-  const keysB = Object.keys(b);
-
-  if (keysA.length !== keysB.length) return false;
-
-  // Check each key's value with Object.is
-  for (const key of keysA) {
-    if (!Object.is((a as Record<string, unknown>)[key], (b as Record<string, unknown>)[key])) {
-      return false;
-    }
-  }
-
-  return true;
-}

package/src/cache/memory-store.ts

@@ -1,253 +0,0 @@
-/**
- * In-Memory Cache Store
- *
- * Simple implementation for development and testing.
- * Not suitable for production (no persistence, single-instance only).
- *
- * @internal This is reserved for future extensibility.
- * For segment caching, use MemorySegmentCacheStore instead.
- */
-
-import type {
-  CacheStore,
-  CacheEntry,
-  CacheValue,
-  CachePutOptions,
-  CacheMetadata,
-  CacheValueType,
-} from "./types.js";
-
-// ============================================================================
-// Constants
-// ============================================================================
-
-/** Default TTL when no explicit value is provided */
-const DEFAULT_TTL_SECONDS = 60;
-
-// ============================================================================
-// Types
-// ============================================================================
-
-interface StoredEntry {
-  /** Stored value (streams/responses converted to ArrayBuffer) */
-  value: ArrayBuffer | string | object;
-  metadata: CacheMetadata;
-}
-
-/**
- * In-memory cache store implementation
- */
-export class MemoryCacheStore implements CacheStore {
-  private cache = new Map<string, StoredEntry>();
-
-  async match<T = CacheValue>(key: string): Promise<CacheEntry<T> | undefined> {
-    const entry = this.cache.get(key);
-
-    if (!entry) {
-      return undefined;
-    }
-
-    // Check expiration
-    if (entry.metadata.expiresAt && Date.now() > entry.metadata.expiresAt) {
-      this.cache.delete(key);
-      return undefined;
-    }
-
-    // Reconstruct value based on original type
-    const value = this.reconstructValue(entry);
-
-    return {
-      value: value as T,
-      metadata: entry.metadata,
-    };
-  }
-
-  async put<T extends CacheValue>(
-    key: string,
-    value: T,
-    options?: CachePutOptions
-  ): Promise<void> {
-    const ttl = options?.ttl ?? DEFAULT_TTL_SECONDS;
-    const expiresAt = Date.now() + ttl * 1000;
-
-    // Detect value type and convert for storage
-    const { storedValue, valueType, responseHeaders, responseStatus } =
-      await this.prepareForStorage(value);
-
-    const metadata: CacheMetadata = {
-      ...options?.metadata,
-      expiresAt,
-      valueType,
-      responseHeaders,
-      responseStatus,
-    };
-
-    this.cache.set(key, {
-      value: storedValue,
-      metadata,
-    });
-  }
-
-  async delete(key: string): Promise<boolean> {
-    return this.cache.delete(key);
-  }
-
-  /**
-   * Clear all entries (useful for testing)
-   */
-  clear(): void {
-    this.cache.clear();
-  }
-
-  /**
-   * Get current cache size (useful for testing/debugging)
-   */
-  get size(): number {
-    return this.cache.size;
-  }
-
-  /**
-   * Manually purge expired entries
-   */
-  purgeExpired(): number {
-    const now = Date.now();
-    let purged = 0;
-
-    for (const [key, entry] of this.cache) {
-      if (entry.metadata.expiresAt && now > entry.metadata.expiresAt) {
-        this.cache.delete(key);
-        purged++;
-      }
-    }
-
-    return purged;
-  }
-
-  /**
-   * Prepare a value for storage
-   * Converts streams and responses to ArrayBuffer, detects type
-   */
-  private async prepareForStorage(value: CacheValue): Promise<{
-    storedValue: ArrayBuffer | string | object;
-    valueType: CacheValueType;
-    responseHeaders?: Record<string, string>;
-    responseStatus?: number;
-  }> {
-    // ReadableStream -> ArrayBuffer
-    if (value instanceof ReadableStream) {
-      return {
-        storedValue: await streamToArrayBuffer(value),
-        valueType: "stream",
-      };
-    }
-
-    // Response -> ArrayBuffer + headers/status
-    if (value instanceof Response) {
-      const headers: Record<string, string> = {};
-      value.headers.forEach((v, k) => {
-        headers[k] = v;
-      });
-
-      return {
-        storedValue: await value.clone().arrayBuffer(),
-        valueType: "response",
-        responseHeaders: headers,
-        responseStatus: value.status,
-      };
-    }
-
-    // ArrayBuffer -> store as-is
-    if (value instanceof ArrayBuffer) {
-      return {
-        storedValue: value,
-        valueType: "arraybuffer",
-      };
-    }
-
-    // String -> store as-is
-    if (typeof value === "string") {
-      return {
-        storedValue: value,
-        valueType: "string",
-      };
-    }
-
-    // Object -> store as-is (JSON-serializable)
-    return {
-      storedValue: value,
-      valueType: "object",
-    };
-  }
-
-  /**
-   * Reconstruct original value type from stored entry
-   */
-  private reconstructValue(entry: StoredEntry): CacheValue {
-    const { value, metadata } = entry;
-
-    switch (metadata.valueType) {
-      case "stream":
-        return arrayBufferToStream(value as ArrayBuffer);
-
-      case "response": {
-        const status = metadata.responseStatus ?? 200;
-        // Status codes 204 (No Content) and 304 (Not Modified) cannot have a body
-        const isNullBodyStatus = status === 204 || status === 304;
-        return new Response(isNullBodyStatus ? null : (value as ArrayBuffer), {
-          status,
-          headers: metadata.responseHeaders,
-        });
-      }
-
-      case "arraybuffer":
-      case "string":
-      case "object":
-      default:
-        return value as CacheValue;
-    }
-  }
-}
-
-/**
- * Convert a ReadableStream to ArrayBuffer.
- * @internal
- */
-async function streamToArrayBuffer(
-  stream: ReadableStream<Uint8Array>
-): Promise<ArrayBuffer> {
-  const chunks: Uint8Array[] = [];
-  const reader = stream.getReader();
-
-  while (true) {
-    const { done, value } = await reader.read();
-    if (done) break;
-    chunks.push(value);
-  }
-
-  // Concatenate chunks
-  const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
-  const result = new Uint8Array(totalLength);
-  let offset = 0;
-
-  for (const chunk of chunks) {
-    result.set(chunk, offset);
-    offset += chunk.length;
-  }
-
-  return result.buffer;
-}
-
-/**
- * Convert an ArrayBuffer to a ReadableStream.
- * @internal
- */
-function arrayBufferToStream(buffer: ArrayBuffer): ReadableStream<Uint8Array> {
-  const uint8 = new Uint8Array(buffer);
-
-  return new ReadableStream({
-    start(controller) {
-      controller.enqueue(uint8);
-      controller.close();
-    },
-  });
-}

package/src/handles/index.ts

@@ -1,6 +0,0 @@
-/**
- * Built-in handles for rsc-router.
- */
-
-export { Meta } from "./meta.ts";
-export { MetaTags } from "./MetaTags.tsx";

package/src/href-context.ts

@@ -1,33 +0,0 @@
-"use client";
-
-/**
- * Href Context for route name resolution
- *
- * This module is marked "use client" so it can be imported by both:
- * - Server (segment-system): Gets a client reference for createElement
- * - Client (useHref): Uses the actual context for useContext
- *
- * The context stores:
- * - routeMap: Map of route names to URL patterns
- * - routeName: Current matched route name (for local name resolution)
- */
-import { createContext, type Context } from "react";
-
-/**
- * Context value for href resolution
- */
-export interface HrefContextValue {
-  /** Route map: route name -> URL pattern */
-  routeMap: Record<string, string>;
-  /** Current matched route name (includes name prefix from include()) */
-  routeName?: string;
-}
-
-/**
- * Context for href resolution (route map and current route name)
- *
- * On the server: Populated by renderSegments() via HrefContext.Provider
- * On the client: Populated by NavigationProvider from RSC metadata
- */
-export const HrefContext: Context<HrefContextValue | null> =
-  createContext<HrefContextValue | null>(null);

package/src/network-error-thrower.tsx

@@ -1,21 +0,0 @@
-"use client";
-
-import type { ReactNode } from "react";
-import type { NetworkError } from "./errors.js";
-
-interface NetworkErrorThrowerProps {
-  error: NetworkError;
-}
-
-/**
- * Client component that throws a NetworkError during render.
- * Used to trigger the root error boundary when a network error occurs
- * during navigation or server actions.
- *
- * This must be a separate component because:
- * 1. Errors must be thrown during React's render phase to be caught by error boundaries
- * 2. The error occurs in async code (fetch), so we need to propagate it to React's render
- */
-export function NetworkErrorThrower({ error }: NetworkErrorThrowerProps): ReactNode {
-  throw error;
-}

package/src/router.gen.ts

@@ -1,6 +0,0 @@
-// Auto-generated by @rangojs/router - do not edit
-export const routes = {
-  about: "/about",
-  home: "/",
-} as const;
-export type routes = typeof routes;

package/src/static-handler.gen.ts

@@ -1,5 +0,0 @@
-// Auto-generated by @rangojs/router - do not edit
-export const routes = {
-  "doc.gs": "/getting-started",
-} as const;
-export type routes = typeof routes;

package/src/urls.gen.ts

@@ -1,8 +0,0 @@
-// Auto-generated by @rangojs/router - do not edit
-export const routes = {
-  health: "/health",
-  home: "/",
-  index: "/",
-  post: "/:slug",
-} as const;
-export type routes = typeof routes;