@real-router/sources 0.8.4 → 0.8.6

package/src/normalizeActiveOptions.ts

@@ -1,41 +0,0 @@
-import type { ActiveRouteSourceOptions } from "./types.js";
-
-/**
- * Normalized options shape — booleans are required (filled with defaults),
- * `hash` stays `string | undefined` because `undefined` is the meaningful
- * "ignore hash" sentinel that callers pass intentionally.
- */
-export interface NormalizedActiveOptions {
-  strict: boolean;
-  ignoreQueryParams: boolean;
-  hash: string | undefined;
-}
-
-/**
- * Default options for `createActiveRouteSource` and adapter-level helpers.
- *
- * Frozen to prevent accidental mutation by consumers.
- */
-export const DEFAULT_ACTIVE_OPTIONS: Readonly<NormalizedActiveOptions> =
-  Object.freeze({
-    strict: false,
-    ignoreQueryParams: true,
-    hash: undefined,
-  });
-
-/**
- * Normalizes partial `ActiveRouteSourceOptions` into a fully-defaulted object.
- *
- * Use this to produce a stable options record for comparison, caching, or
- * downstream consumers that require all fields present.
- */
-export function normalizeActiveOptions(
-  options?: ActiveRouteSourceOptions,
-): NormalizedActiveOptions {
-  return {
-    strict: options?.strict ?? DEFAULT_ACTIVE_OPTIONS.strict,
-    ignoreQueryParams:
-      options?.ignoreQueryParams ?? DEFAULT_ACTIVE_OPTIONS.ignoreQueryParams,
-    hash: options?.hash,
-  };
-}

package/src/stabilizeState.ts

@@ -1,75 +0,0 @@
-import { readContextHash } from "./internal/readContextHash.js";
-
-import type { State } from "@real-router/core";
-
-/**
- * State-aware stabilization for route snapshots.
- *
- * Compares `path` (canonical name+params), `state.context.url.hash`
- * (URL fragment, #532), and `state.transition.reload` (#605). When all
- * three match (idempotent navigation), returns `prev` (preserving
- * reference) so frameworks can skip re-renders. When any of them flips,
- * returns `next` so consumers subscribing through `useRoute()` see the
- * new state.
- *
- * `transition.reload === true` is the user's explicit signal for a
- * non-idempotent navigation — `router.navigate(name, params, { reload:
- * true })` is the canonical pairing for `invalidate(router, namespace)`
- * and any cache-bust pattern. Bypassing stabilization for reloads makes
- * `useRoute()` consumers see fresh `state.context.<namespace>` values
- * written by the SSR loader plugin's `subscribeLeave` handler.
- *
- * Ignores `meta` (internal: auto-increment id), other `transition` fields
- * (`from`, `segments`, `redirected`), and `state.context.navigation` /
- * `state.context.browser` (transient transition metadata) — they don't
- * affect render identity for idempotent navigations.
- *
- * Accepts `null` for compatibility with `RouterTransitionSnapshot`
- * (toRoute/fromRoute are `State | null`).
- *
- * @internal Not exported from package public API.
- */
-export function stabilizeState<T extends State | null | undefined>(
-  prev: T,
-  next: T,
-): T {
-  if (prev === next) {
-    return prev;
-  }
-  if (prev?.path !== next?.path) {
-    return next;
-  }
-
-  // After the path check, both must be the same non-null State (paths
-  // matched, prev !== next reference). Read context.url.hash to detect
-  // same-path-different-hash navigation (#532) — render-relevant for
-  // tab-style UIs that subscribe via useRoute(). Optional chaining keeps
-  // the access null-safe without forbidden non-null assertions.
-  if (readContextHash(prev) !== readContextHash(next)) {
-    return next;
-  }
-
-  // Explicit reload navigation (#605) — caller asked to bypass dedupe so
-  // observers see fresh `state.context` written by `invalidate()`-driven
-  // loader re-runs. The path equality above guarantees both prev and next
-  // are either non-null with matching paths or both nullish; only the
-  // non-null branch can carry a meaningful `transition.reload`.
-  if (readReloadFlag(next)) {
-    return next;
-  }
-
-  return prev;
-}
-
-function readReloadFlag(state: State | null | undefined): boolean {
-  // Defensive read: `transition` is mandatory in the public State type, but a
-  // plugin returning a malformed state (or a future fork) shouldn't crash the
-  // stabilizer with a TypeError. We cast to a structurally-loose shape so the
-  // optional chain is permitted; the runtime guard preserves dedup (false =
-  // not-a-reload) for malformed inputs.
-  const transition = (
-    state as { transition?: { reload?: boolean } } | null | undefined
-  )?.transition;
-
-  return transition?.reload === true;
-}

package/src/types.ts

@@ -1,63 +0,0 @@
-import type { Params, RouterError, State } from "@real-router/core";
-
-export interface RouteSnapshot<P extends Params = Params> {
-  route: State<P> | undefined;
-  previousRoute: State | undefined;
-}
-
-export interface RouteNodeSnapshot<P extends Params = Params> {
-  route: State<P> | undefined;
-  previousRoute: State | undefined;
-}
-
-export interface RouterSource<T> {
-  subscribe: (listener: () => void) => () => void;
-  getSnapshot: () => T;
-  destroy: () => void;
-}
-
-export interface ActiveRouteSourceOptions {
-  strict?: boolean;
-  ignoreQueryParams?: boolean;
-  /**
-   * URL fragment match (#532). When defined, the source is active iff the
-   * route matches AND `state.context.url.hash` (decoded, populated by
-   * browser/navigation URL plugins) equals this value:
-   *
-   * - `undefined` (default): hash is ignored — legacy route-only matching.
-   * - `""`: active only when the current URL has no fragment (or empty).
-   * - `"value"`: active only when the current fragment equals `"value"`.
-   *
-   * Hash-plugin runtimes leave `state.context.url` undefined, so any non-
-   * undefined `hash` option will produce `false` there — consistent with the
-   * documented limitation that hash-plugin doesn't support URL fragments.
-   */
-  hash?: string;
-}
-
-export interface RouterTransitionSnapshot {
-  isTransitioning: boolean;
-  isLeaveApproved: boolean;
-  toRoute: State | null;
-  fromRoute: State | null;
-}
-
-export interface RouterErrorSnapshot {
-  error: RouterError | null;
-  toRoute: State | null;
-  fromRoute: State | null;
-  version: number;
-}
-
-export interface DismissableErrorSnapshot {
-  /** Currently visible error, or `null` if none (never seen or dismissed). */
-  error: RouterError | null;
-  /** Target route of the failed navigation. */
-  toRoute: State | null;
-  /** Source route at the time of failure. */
-  fromRoute: State | null;
-  /** Monotonic version counter from the underlying error source. */
-  version: number;
-  /** Dismisses the current error. Next error (new version) becomes visible again. */
-  resetError: () => void;
-}