@real-router/solid 0.14.1 → 0.14.3

package/src/hooks/useRouteExit.tsx

@@ -1,123 +0,0 @@
-import { onCleanup } from "solid-js";
-
-import { useRouter } from "./useRouter";
-
-import type { State } from "@real-router/core";
-
-export interface RouteExitContext {
-  /** The route being left. */
-  route: State;
-  /** The route being navigated to. */
-  nextRoute: State;
-  /**
-   * AbortSignal that fires when this navigation is superseded by a later
-   * one (rapid clicks). Already filtered: when the handler runs,
-   * `signal.aborted` is guaranteed to be `false`. Use
-   * `signal.addEventListener("abort", cleanup, { once: true })` for
-   * cleanup that must run on cancellation.
-   */
-  signal: AbortSignal;
-}
-
-export interface UseRouteExitOptions {
-  /**
-   * Skip the handler when `route.name === nextRoute.name`
-   * (sort/filter/query-only navigations on the same route). Default:
-   * `true`.
-   */
-  skipSameRoute?: boolean;
-}
-
-export type RouteExitHandler = (
-  context: RouteExitContext,
-) => void | Promise<void>;
-
-/**
- * Subscribe to the router's leave-window with the universal guards baked
- * in. Wraps `router.subscribeLeave` so consumers don't repeat the same
- * boilerplate every time:
- *
- *   - **Reentrant abort pre-check**: if `signal.aborted` is already `true`
- *     when the handler would run (rapid navigation superseded a slower
- *     one), the handler is skipped entirely. `signal.addEventListener(
- *     "abort", ...)` does not fire retroactively, so without this guard
- *     downstream cleanup would never trigger.
- *   - **Same-route skip**: by default, `route.name === nextRoute.name`
- *     short-circuits the handler — query-only navigations (sort, filter,
- *     pagination) skip the work. Opt out with `skipSameRoute: false`.
- *
- * Returns nothing — the subscription's lifecycle is bound to the
- * component via `onCleanup`.
- *
- * If the handler returns a Promise, the router blocks on it. If the
- * Promise resolves, navigation proceeds. If it rejects, the router emits
- * `TRANSITION_CANCELLED`.
- *
- * **Handler reactivity (Solid)**: Solid components run **once** at mount;
- * `handler` is captured in closure at the call site. If you need
- * different behavior across renders, derive it from a signal inside the
- * handler body — do not rely on swapping the handler reference.
- *
- * @example Animation
- * ```tsx
- * let ref: HTMLDivElement | undefined;
- *
- * useRouteExit(async ({ signal }) => {
- *   const el = ref;
- *   if (!el) return;
- *   el.classList.add("fade-out");
- *   const cleanup = () => el.classList.remove("fade-out");
- *   signal.addEventListener("abort", cleanup, { once: true });
- *   try {
- *     el.getBoundingClientRect();   // style flush
- *     await Promise.allSettled(el.getAnimations().map((a) => a.finished));
- *   } finally {
- *     cleanup();
- *   }
- * });
- * ```
- *
- * @example Auto-save form draft
- * ```tsx
- * useRouteExit(async ({ signal }) => {
- *   if (formState.dirty) await api.saveDraft(formState, { signal });
- * });
- * ```
- *
- * @example Reading rich transition metadata via `nextRoute.transition`
- * ```tsx
- * useRouteExit(({ route, nextRoute }) => {
- *   if (nextRoute.transition.segments.deactivated.includes("products")) {
- *     productCache.clear();
- *   }
- *   if (nextRoute.transition.redirected) {
- *     return;
- *   }
- * });
- * ```
- */
-export function useRouteExit(
-  handler: RouteExitHandler,
-  options?: UseRouteExitOptions,
-): void {
-  const router = useRouter();
-  const skipSameRoute = options?.skipSameRoute ?? true;
-
-  const off = router.subscribeLeave(({ route, nextRoute, signal }) => {
-    if (skipSameRoute && route.name === nextRoute.name) {
-      return;
-    }
-
-    // Reentrant abort: signal is already aborted when listener fires
-    // (e.g. a newer navigate superseded this one before subscribeLeave
-    // even ran). addEventListener("abort", ...) does not fire
-    // retroactively, so we skip the handler entirely.
-    if (signal.aborted) {
-      return;
-    }
-
-    return handler({ route, nextRoute, signal });
-  });
-
-  onCleanup(off);
-}

package/src/hooks/useRouteNode.tsx

@@ -1,13 +0,0 @@
-import { createRouteNodeSource } from "@real-router/sources";
-
-import { createSignalFromSource } from "../createSignalFromSource";
-import { useRouter } from "./useRouter";
-
-import type { RouteState } from "../types";
-import type { Accessor } from "solid-js";
-
-export function useRouteNode(nodeName: string): Accessor<RouteState> {
-  const router = useRouter();
-
-  return createSignalFromSource(createRouteNodeSource(router, nodeName));
-}

package/src/hooks/useRouteNodeStore.tsx

@@ -1,12 +0,0 @@
-import { createRouteNodeSource } from "@real-router/sources";
-
-import { createStoreFromSource } from "../createStoreFromSource";
-import { useRouter } from "./useRouter";
-
-import type { RouteState } from "../types";
-
-export function useRouteNodeStore(nodeName: string): RouteState {
-  const router = useRouter();
-
-  return createStoreFromSource(createRouteNodeSource(router, nodeName));
-}

package/src/hooks/useRouteStore.tsx

@@ -1,12 +0,0 @@
-import { createRouteSource } from "@real-router/sources";
-
-import { createStoreFromSource } from "../createStoreFromSource";
-import { useRouter } from "./useRouter";
-
-import type { RouteState } from "../types";
-
-export function useRouteStore(): RouteState {
-  const router = useRouter();
-
-  return createStoreFromSource(createRouteSource(router));
-}

package/src/hooks/useRouteUtils.tsx

@@ -1,50 +0,0 @@
-import { getPluginApi } from "@real-router/core/api";
-import { getRouteUtils } from "@real-router/route-utils";
-
-import { useRouter } from "./useRouter";
-
-import type { Router } from "@real-router/core";
-import type { RouteUtils } from "@real-router/route-utils";
-
-// §8.1 audit fix (MED) — cache the `RouteUtils` per (router, tree) so N
-// components calling `useRouteUtils()` against the same router share ONE
-// chain through `getPluginApi(router).getTree()` + `getRouteUtils(tree)`.
-//
-// Why two-level (router + tree) and not just router:
-//   `getRouteUtils` is WeakMap-cached by tree root, BUT a RouteUtils
-//   instance is built FROM the tree at construction time — its internal
-//   `getChain`/`getSiblings` caches are pre-computed Object.freeze'd arrays
-//   (see `@real-router/route-utils` CLAUDE.md). If the router replaces its
-//   tree (e.g. `routesApi.replace([...])`), the old RouteUtils is stale.
-//   Caching only by router would serve the stale instance.
-//
-// Storing `{ tree, utils }` per router lets us detect tree replacement and
-// recompute. In the steady state (no tree mutation), this is a cheap
-// reference compare; under tree replacement, the cache self-heals on the
-// next call.
-//
-// WeakMap keys on the router — entries are released automatically when the
-// router is garbage-collected.
-interface CachedEntry {
-  tree: unknown;
-  utils: RouteUtils;
-}
-
-const routeUtilsCache = new WeakMap<Router, CachedEntry>();
-
-export const useRouteUtils = (): RouteUtils => {
-  const router = useRouter();
-  const tree = getPluginApi(router).getTree();
-
-  const cached = routeUtilsCache.get(router);
-
-  if (cached?.tree === tree) {
-    return cached.utils;
-  }
-
-  const utils = getRouteUtils(tree);
-
-  routeUtilsCache.set(router, { tree, utils });
-
-  return utils;
-};

package/src/hooks/useRouter.tsx

@@ -1,6 +0,0 @@
-import { useRequiredRouterContext } from "../context";
-
-import type { Router } from "@real-router/core";
-
-export const useRouter = (): Router =>
-  useRequiredRouterContext("useRouter").router;

package/src/hooks/useRouterTransition.tsx

@@ -1,14 +0,0 @@
-import { getTransitionSource } from "@real-router/sources";
-
-import { createSignalFromSource } from "../createSignalFromSource";
-import { useRouter } from "./useRouter";
-
-import type { RouterTransitionSnapshot } from "@real-router/sources";
-import type { Accessor } from "solid-js";
-
-export function useRouterTransition(): Accessor<RouterTransitionSnapshot> {
-  const router = useRouter();
-  const source = getTransitionSource(router);
-
-  return createSignalFromSource(source);
-}

package/src/index.tsx

@@ -1,66 +0,0 @@
-export { RouteView } from "./components/RouteView";
-
-export { Link } from "./components/Link";
-
-export { RouterErrorBoundary } from "./components/RouterErrorBoundary";
-
-export { link } from "./directives/link";
-
-export { useRouter } from "./hooks/useRouter";
-
-export { useNavigator } from "./hooks/useNavigator";
-
-export { useRouteUtils } from "./hooks/useRouteUtils";
-
-export { useRoute } from "./hooks/useRoute";
-
-export { useRouteNode } from "./hooks/useRouteNode";
-
-export { useRouteStore } from "./hooks/useRouteStore";
-
-export { useRouteNodeStore } from "./hooks/useRouteNodeStore";
-
-export { useRouterTransition } from "./hooks/useRouterTransition";
-
-export { useRouteExit } from "./hooks/useRouteExit";
-
-export { useRouteEnter } from "./hooks/useRouteEnter";
-
-export { RouterProvider } from "./RouterProvider";
-
-export { RouterContext, RouteContext } from "./context";
-
-export type { RouterContextValue } from "./context";
-
-export { createSignalFromSource } from "./createSignalFromSource";
-
-export { createStoreFromSource } from "./createStoreFromSource";
-
-export type { LinkProps, RouteState } from "./types";
-
-export type { RouterErrorBoundaryProps } from "./components/RouterErrorBoundary";
-
-export type { LinkDirectiveOptions } from "./directives/link";
-
-export type {
-  RouteViewProps,
-  RouteViewMatchProps,
-  RouteViewSelfProps,
-  RouteViewNotFoundProps,
-} from "./components/RouteView";
-
-export type {
-  RouteExitContext,
-  RouteExitHandler,
-  UseRouteExitOptions,
-} from "./hooks/useRouteExit";
-
-export type {
-  RouteEnterContext,
-  RouteEnterHandler,
-  UseRouteEnterOptions,
-} from "./hooks/useRouteEnter";
-
-export type { Navigator } from "@real-router/core";
-
-export type { RouterTransitionSnapshot } from "@real-router/sources";

package/src/ssr.tsx

@@ -1,39 +0,0 @@
-// SSR-feature entry — Solid 1.7+
-//
-// Server-side and SSR-aware components/hooks. Mirror of `@real-router/react/ssr`
-// — same exports, Solid-native idioms (Accessor returns, createResource-backed
-// Await, native Suspense for Streamed).
-
-// Components
-export { ClientOnly } from "./components/ClientOnly";
-
-export { ServerOnly } from "./components/ServerOnly";
-
-export { Await } from "./components/Await";
-
-export { Streamed } from "./components/Streamed";
-
-export { HttpStatusCode } from "./components/HttpStatusCode";
-
-export { HttpStatusProvider } from "./components/HttpStatusProvider";
-
-// Hooks
-export { useDeferred } from "./hooks/useDeferred";
-
-// Utilities
-export { createHttpStatusSink } from "./utils/createHttpStatusSink";
-
-// Types
-export type { ClientOnlyProps } from "./components/ClientOnly";
-
-export type { ServerOnlyProps } from "./components/ServerOnly";
-
-export type { AwaitProps } from "./components/Await";
-
-export type { StreamedProps } from "./components/Streamed";
-
-export type { HttpStatusCodeProps } from "./components/HttpStatusCode";
-
-export type { HttpStatusProviderProps } from "./components/HttpStatusProvider";
-
-export type { HttpStatusSink } from "./utils/createHttpStatusSink";

package/src/types.ts

@@ -1,28 +0,0 @@
-import type { NavigationOptions, Params, State } from "@real-router/core";
-import type { JSX } from "solid-js";
-
-export interface RouteState<P extends Params = Params> {
-  route: State<P> | undefined;
-  previousRoute?: State | undefined;
-}
-
-export interface LinkProps<P extends Params = Params> extends Omit<
-  JSX.HTMLAttributes<HTMLAnchorElement>,
-  "onClick"
-> {
-  routeName: string;
-  routeParams?: P;
-  routeOptions?: NavigationOptions;
-  activeClassName?: string;
-  activeStrict?: boolean;
-  ignoreQueryParams?: boolean;
-  /**
-   * URL fragment (decoded form, no leading "#") (#532).
-   * - omitted/`undefined` → preserve current fragment on same-route navigation
-   * - `""` → clear fragment
-   * - non-empty → set fragment
-   */
-  hash?: string;
-  target?: string;
-  onClick?: (evt: MouseEvent) => void;
-}

package/src/utils/createHttpStatusSink.ts

@@ -1,31 +0,0 @@
-/**
- * Render-scoped HTTP status sink. Created per request on the server, passed to
- * `<HttpStatusProvider sink={...}>`, and read after `renderToString` /
- * `renderToStream` to apply the value to the HTTP response.
- *
- * Last write wins: if the rendered tree mounts more than one
- * `<HttpStatusCode />`, the value reflects the last component that ran during
- * the render pass.
- *
- * No-op on the client — `<HttpStatusCode />` reads the optional context and
- * skips the write when no provider is mounted, so the same component tree can
- * be hydrated without changing behaviour.
- *
- * Constraints:
- * - **Per-request only.** Don't share a sink across requests; the rendered
- *   tree mutates `code` in place. Module-level singletons leak status
- *   between concurrent requests.
- * - **Don't `Object.freeze` the sink.** The component writes to `.code`;
- *   freezing makes the assignment throw under ESM strict mode.
- * - **Hydration symmetry:** mount `<HttpStatusProvider>` on both server and
- *   client (with a throwaway client sink). Solid emits `data-hk` markers
- *   per component boundary; an extra provider on one side desyncs the
- *   counter and breaks the hydration walker.
- */
-export interface HttpStatusSink {
-  code: number | undefined;
-}
-
-export function createHttpStatusSink(): HttpStatusSink {
-  return { code: undefined };
-}

package/src/utils/createMountedSignal.ts

@@ -1,26 +0,0 @@
-import { createSignal, onMount } from "solid-js";
-
-import type { Accessor } from "solid-js";
-
-/**
- * Returns a boolean accessor that is `false` during initial render (SSR
- * and the first client paint) and flips to `true` once the component
- * has mounted in the browser.
- *
- * Solid guarantees that `onMount` does NOT fire during `renderToString` /
- * `renderToStream`, so the accessor stays `false` server-side — this is
- * the building block for SSR boundary components (`<ClientOnly>` /
- * `<ServerOnly>`).
- *
- * Consolidates the identical `createSignal(false) + onMount(setMounted)`
- * pattern across the two boundary components (§8a Q15).
- */
-export function createMountedSignal(): Accessor<boolean> {
-  const [mounted, setMounted] = createSignal(false);
-
-  onMount(() => {
-    setMounted(true);
-  });
-
-  return mounted;
-}